1 #LyX 2.4 created this file. For more info see https://www.lyx.org/
5 \save_transient_properties true
6 \origin /systemlyxdir/doc/
9 % DO NOT ALTER THIS PREAMBLE!!!
11 % This preamble is designed to ensure that this document prints
12 % out as advertised. If you mess with this preamble,
13 % parts of this document may not print out as expected. If you
14 % have problems LaTeXing this file, please contact
15 % the documentation team
16 % email: lyx-docs@lists.lyx.org
18 % the pages of the TOC is numbered roman
19 % and a pdf-bookmark for the TOC is added
20 \let\myTOC\tableofcontents
21 \renewcommand\tableofcontents{%
23 \pdfbookmark[1]{\contentsname}{}
27 % increase link area for cross-references and autoname them,
28 \AtBeginDocument{\renewcommand{\ref}[1]{\mbox{\autoref{#1}}}}
29 \@ifundefined{extrasenglish}{\usepackage[english]{babel}}{}
30 \@ifpackageloaded{babel}{
31 \addto\extrasenglish{%
32 \renewcommand*{\equationautorefname}[1]{}%
33 \renewcommand{\sectionautorefname}{sec.\negthinspace}%
34 \renewcommand{\subsectionautorefname}{sec.\negthinspace}%
35 \renewcommand{\subsubsectionautorefname}{sec.\negthinspace}%
39 \options bibliography=totoc,index=totoc,BCOR7.5mm,titlepage,captions=tableheading
40 \use_default_options false
44 \maintain_unincluded_children no
46 \language_package default
49 \font_roman "lmodern" "default"
50 \font_sans "lmss" "default"
51 \font_typewriter "lmtt" "default"
52 \font_math "auto" "auto"
53 \font_default_family default
54 \use_non_tex_fonts false
58 \font_typewriter_osf false
59 \font_sf_scale 100 100
60 \font_tt_scale 100 100
62 \use_dash_ligatures true
64 \default_output_format pdf2
66 \bibtex_command default
67 \index_command default
71 \pdf_title "LyX Configuration Manual"
72 \pdf_author "LyX Team"
73 \pdf_subject "LyX-documentation Customization"
74 \pdf_keywords "LyX, documentation, customization"
76 \pdf_bookmarksnumbered true
77 \pdf_bookmarksopen true
78 \pdf_bookmarksopenlevel 1
83 \pdf_pdfusetitle false
84 \pdf_quoted_options "linkcolor=black, citecolor=black, urlcolor=blue, filecolor=blue,pdfpagelayout=OneColumn, pdfnewwindow=true, pdfstartview=XYZ, plainpages=false"
87 \use_package amsmath 1
88 \use_package amssymb 1
91 \use_package mathdots 1
92 \use_package mathtools 1
94 \use_package stackrel 1
95 \use_package stmaryrd 1
96 \use_package undertilde 1
98 \cite_engine_type default
102 \paperorientation portrait
108 \notefontcolor #0000ff
112 \color #f5fae7 #0a0518
120 \paragraph_separation indent
121 \paragraph_indentation default
123 \math_indentation default
124 \math_numbering_side default
125 \quotes_style english
129 \paperpagestyle headings
131 \tracking_changes true
132 \output_changes false
134 \postpone_fragile_content false
138 \docbook_table_output 0
139 \docbook_mathml_prefix 1
140 \author -970929547 "Thibaut Cuvelier"
141 \author -712698321 "Jürgen Spitzmüller"
142 \author -584632292 "Richard Kimberly Heck"
143 \author -495245474 "Jean-Marc Lasgouttes"
146 \author 34634807 "Jean-Pierre"
147 \author 232239728 "Owner"
148 \author 731793113 "Richard Kimberly Heck" rikiheck@lyx.org
149 \author 1075283030 "Thibaut"
155 Customizing \SpecialChar LyX
157 Features for the Advanced User
161 by the \SpecialChar LyX
166 \begin_layout Plain Layout
167 If you have comments or error corrections,
168 please send them to the \SpecialChar LyX
169 Documentation mailing list,
171 \begin_inset CommandInset href
173 target "lyx-docs@lists.lyx.org"
181 \begin_inset Quotes eld
185 \begin_inset Quotes erd
188 in the subject header,
189 and please cc the current maintainer of this file,
191 \change_inserted 5863208 1604930692
195 \change_inserted 5863208 1604930729
197 \change_deleted 5863208 1604930668
206 \begin_inset Newline newline
210 \begin_inset Newline newline
216 \begin_layout Standard
217 \begin_inset CommandInset toc
218 LatexCommand tableofcontents
225 \begin_layout Standard
226 \begin_inset Note Note
229 \begin_layout Plain Layout
230 Please use change tracking when modifying this document.
231 This makes it easier for our translators to recognize things that have been changed,
232 and it helps the maintainer keep up-to-date with what's been done.
240 \begin_layout Chapter
244 \begin_layout Standard
245 This manual covers the customization features present in \SpecialChar LyX
248 we discuss issues like keyboard shortcuts,
249 screen previewing options,
251 sending commands to \SpecialChar LyX
252 via the \SpecialChar LyX
254 internationalization,
255 installing new \SpecialChar LaTeX
256 classes and \SpecialChar LyX
259 We can't possibly hope to touch on everything you can change—
260 our developers add new features faster than we can document them—
261 but we will explain the most common customizations and hopefully point you in the right direction for some of the more obscure ones.
264 \begin_layout Standard
265 \begin_inset Branch OutDated
269 \begin_layout Standard
270 Information from previous versions of this document that now seems to be outdated is contained in the OutDated branch of this document.
272 this information will not appear in the \SpecialChar LaTeX
281 \begin_layout Chapter
286 \begin_layout Standard
287 This chapter aims to help you to find your way through the \SpecialChar LyX
289 Before continuing to read this chapter,
290 you should find out where your \SpecialChar LyX
291 library and user directories are by using
292 \begin_inset Flex Noun
295 \begin_layout Plain Layout
296 Help\SpecialChar menuseparator
307 The library directory is the place where \SpecialChar LyX
308 places its system-wide configuration files;
309 the user directory is where you can place your modified versions.
310 We will call the former
311 \begin_inset Flex Code
314 \begin_layout Plain Layout
321 \begin_inset Flex Noun
324 \begin_layout Plain Layout
330 in the remainder of this document.
334 \begin_layout Section
336 \begin_inset Flex Code
339 \begin_layout Plain Layout
348 \begin_layout Standard
349 \begin_inset Flex Code
352 \begin_layout Plain Layout
358 and its sub-directories contain a number of files
359 \change_deleted 232239728 1604787780
362 that can be used to customize \SpecialChar LyX
364 You can change many of these files from within \SpecialChar LyX
366 \begin_inset Flex Noun
369 \begin_layout Plain Layout
370 Tools\SpecialChar menuseparator
377 Most customization that you will want to do in \SpecialChar LyX
378 is possible through this dialog.
380 many other inner aspects of \SpecialChar LyX
381 can be customized by modifying the files in
382 \begin_inset Flex Code
385 \begin_layout Plain Layout
392 These files fall in different categories,
393 described in the following subsections.
396 \begin_layout Subsection
397 Automatically generated files
400 \begin_layout Standard
402 \begin_inset Flex Noun
405 \begin_layout Plain Layout
411 are generated when you configure \SpecialChar LyX
413 They contain various default values that are
414 \change_inserted 5863208 1604919565
415 automatically detected during reconfiguration.
416 \change_deleted 232239728 1604788241
417 guessed by inspection
420 it is not a good idea to modify them,
421 since they might be overwritten at any time.
424 \begin_layout Labeling
425 \labelwidthstring 00.00.0000
426 \begin_inset Flex Code
429 \begin_layout Plain Layout
436 \change_deleted 5863208 1604919950
438 \begin_inset Note Note
441 \begin_layout Plain Layout
443 \change_inserted 232239728 1604853928
444 I capitalized the first word in all of these lists.
445 To me it looks better but it really is a stylistic thing,
447 However if you are not going to capitalize them,
448 the english in some needs to be modified to make it read correctly as a sentence.
456 \change_deleted 232239728 1604853510
458 \change_inserted 232239728 1604853510
461 ontains defaults for various commands.
464 \begin_layout Labeling
465 \labelwidthstring 00.00.0000
466 \begin_inset Flex Code
469 \begin_layout Plain Layout
476 \change_deleted 232239728 1604853512
478 \change_inserted 232239728 1604853512
481 ontains the list of packages that have been recognized by \SpecialChar LyX
483 It is currently unused by the \SpecialChar LyX
485 but the information extracted,
487 is made available with
488 \begin_inset Flex Noun
491 \begin_layout Plain Layout
492 Help\SpecialChar menuseparator
506 \begin_layout Labeling
507 \labelwidthstring 00.00.0000
508 \begin_inset Flex Code
511 \begin_layout Plain Layout
518 \change_deleted 232239728 1604853515
520 \change_inserted 232239728 1604853515
523 he list of text classes that have been found in your
524 \begin_inset Flex Code
527 \begin_layout Plain Layout
534 along with the associated \SpecialChar LaTeX
535 document class and their description.
538 \begin_layout Labeling
539 \labelwidthstring 00.00.0000
540 \begin_inset Flex Code
543 \begin_layout Plain Layout
550 \change_deleted 232239728 1604853518
552 \change_inserted 232239728 1604853518
555 he list of layout modules found in your
556 \begin_inset Flex Code
559 \begin_layout Plain Layout
568 \begin_layout Labeling
569 \labelwidthstring 00.00.0000
570 \begin_inset Flex Code
573 \begin_layout Plain Layout
580 \change_deleted 232239728 1604853523
582 \change_inserted 232239728 1604853523
585 ists of various sorts of \SpecialChar LaTeX
586 -related files found on your system
589 \begin_layout Labeling
590 \labelwidthstring 00.00.0000
591 \begin_inset Flex Code
594 \begin_layout Plain Layout
595 doc/\SpecialChar LaTeX
601 is automatically generated during configuration from the file
602 \begin_inset Flex Code
605 \begin_layout Plain Layout
613 It contains information on your \SpecialChar LaTeX
617 \begin_layout Subsection
621 \begin_layout Standard
623 \change_deleted 5863208 1604928729
627 \change_inserted 5863208 1604928636
631 \change_inserted 5863208 1604928661
635 \begin_inset Flex Code
638 \begin_layout Plain Layout
645 \change_inserted 5863208 1604928662
647 \change_deleted 5863208 1604928642
651 \change_deleted 5863208 1604928669
653 \begin_inset Flex Code
656 \begin_layout Plain Layout
663 \change_inserted 5863208 1604928680
667 \begin_inset Flex Code
670 \begin_layout Plain Layout
678 \change_deleted 232239728 1604794430
681 exists in both places,
683 \begin_inset Flex Code
686 \begin_layout Plain Layout
695 \begin_layout Labeling
696 \labelwidthstring 00.00.0000
697 \begin_inset Flex Code
700 \begin_layout Plain Layout
707 \change_deleted 232239728 1604794460
709 \change_inserted 232239728 1604794460
712 his directory contains files with the extension
713 \begin_inset Flex Code
716 \begin_layout Plain Layout
722 that define the keybindings used in \SpecialChar LyX
724 If there exists an internationalized version of the bind file
725 \change_inserted -712698321 1669371749
727 \change_deleted -712698321 1669371727
729 \begin_inset Flex Code
732 \begin_layout Plain Layout
739 \change_inserted -712698321 1669371728
741 \begin_inset Flex Code
744 \begin_layout Plain Layout
746 \change_inserted -712698321 1669371732
755 \begin_inset Quotes eld
759 \begin_inset Quotes erd
762 is the ISO language code
765 that will be used first.
768 \begin_layout Labeling
769 \labelwidthstring 00.00.0000
770 \begin_inset Flex Code
773 \begin_layout Plain Layout
780 \change_deleted 232239728 1604794478
782 \change_inserted 232239728 1604794478
785 ontains files with the extension
786 \begin_inset Flex Code
789 \begin_layout Plain Layout
795 which define the diverse citation possibilities (natbib,
798 \begin_inset CommandInset ref
800 reference "subsec:Cite-Engine-Files"
810 \begin_layout Labeling
811 \labelwidthstring 00.00.0000
812 \begin_inset Flex Code
815 \begin_layout Plain Layout
822 \change_deleted 232239728 1604794483
824 \change_inserted 232239728 1604794486
827 ontains graphics files that can be included in documents.
831 \begin_layout Labeling
832 \labelwidthstring 00.00.0000
833 \begin_inset Flex Code
836 \begin_layout Plain Layout
843 \change_deleted 232239728 1604794492
845 \change_inserted 232239728 1604794492
848 ontains \SpecialChar LyX
849 documentation files (including the one you are currently reading).
851 \begin_inset Flex Code
854 \begin_layout Plain Layout
856 \change_deleted 232239728 1604794660
859 \change_inserted 232239728 1604794661
867 deserves special attention,
869 The internationalized help docs are in subdirectories
870 \begin_inset Flex Code
873 \begin_layout Plain Layout
880 \begin_inset Quotes eld
884 \begin_inset Quotes erd
887 is the ISO language code.
889 \begin_inset CommandInset ref
891 reference "cha:Internationalizing-LyX"
898 \begin_layout Labeling
899 \labelwidthstring 00.00.0000
900 \begin_inset Flex Code
903 \begin_layout Plain Layout
910 \change_deleted 232239728 1604794497
912 \change_inserted 232239728 1604794497
915 ontains example files that explain how to use some features.
918 \begin_inset Flex Noun
921 \begin_layout Plain Layout
930 \begin_layout Labeling
931 \labelwidthstring 00.00.0000
932 \begin_inset Flex Code
935 \begin_layout Plain Layout
942 \change_deleted 232239728 1604794500
944 \change_inserted 232239728 1604794500
947 ontains image files that are used by the
948 \begin_inset Flex Noun
951 \begin_layout Plain Layout
959 it also contains the individual icons used in the toolbar and the banners that can be shown when \SpecialChar LyX
963 \begin_layout Labeling
964 \labelwidthstring 00.00.0000
965 \begin_inset Flex Code
968 \begin_layout Plain Layout
975 \change_deleted 232239728 1604794505
977 \change_inserted 232239728 1604794505
980 ontains keyboard keymapping files.
982 \begin_inset CommandInset ref
984 reference "sec:International-Keymap-Stuff"
991 \begin_layout Labeling
992 \labelwidthstring 00.00.0000
993 \begin_inset Flex Code
996 \begin_layout Plain Layout
1003 \change_deleted 232239728 1604794508
1005 \change_inserted 232239728 1604794508
1008 ontains the text class and module files described in
1009 \begin_inset CommandInset ref
1011 reference "cha:Installing-New-Document"
1018 \begin_layout Labeling
1019 \labelwidthstring 00.00.0000
1020 \begin_inset Flex Code
1023 \begin_layout Plain Layout
1030 \change_deleted 232239728 1604794513
1032 \change_inserted 232239728 1604794513
1036 \begin_inset Flex Code
1039 \begin_layout Plain Layout
1045 Python scripts used to convert between \SpecialChar LyX
1047 These can be run from the command line if
1048 \change_deleted 232239728 1604794749
1053 you want to batch-convert files.
1056 \begin_layout Labeling
1057 \labelwidthstring 00.00.0000
1058 \begin_inset Flex Code
1061 \begin_layout Plain Layout
1068 \change_deleted 232239728 1604794516
1070 \change_inserted 232239728 1604794516
1073 ontains some files that demonstrate the capabilities of the
1074 \begin_inset Flex Noun
1077 \begin_layout Plain Layout
1079 \begin_inset space ~
1088 Also contains some scripts used by \SpecialChar LyX
1092 \begin_layout Labeling
1093 \labelwidthstring 00.00.0000
1094 \begin_inset Flex Code
1097 \begin_layout Plain Layout
1104 \change_deleted 232239728 1604794520
1106 \change_inserted 232239728 1604794520
1109 ontains the standard \SpecialChar LyX
1110 template files described in
1111 \begin_inset CommandInset ref
1113 reference "subsec:Creating-Templates"
1120 \begin_layout Labeling
1121 \labelwidthstring 00.00.0000
1122 \begin_inset Flex Code
1125 \begin_layout Plain Layout
1132 \change_deleted 232239728 1604794524
1134 \change_inserted 232239728 1604794524
1137 ontains files with the extension
1138 \begin_inset Flex Code
1141 \begin_layout Plain Layout
1147 that define the user interface to \SpecialChar LyX
1150 the files define which items appear in which menus and the items appearing on the toolbar.
1153 \begin_layout Labeling
1154 \labelwidthstring 00.00.0000
1155 \begin_inset Flex Code
1158 \begin_layout Plain Layout
1165 \change_deleted 232239728 1604794528
1167 \change_inserted 232239728 1604794528
1170 ontains files with the extension
1171 \begin_inset Flex Code
1174 \begin_layout Plain Layout
1180 which define the templates for the insertion of external material to a \SpecialChar LyX
1183 \begin_inset CommandInset ref
1185 reference "chap:Including-External-Material"
1192 \begin_layout Subsection
1193 Files you don't want to modify
1196 \begin_layout Standard
1197 These files are used internally by \SpecialChar LyX
1198 and you generally do not need to modify them unless you are a developer.
1201 \begin_layout Labeling
1202 \labelwidthstring 00.00.0000
1203 \begin_inset Flex Code
1206 \begin_layout Plain Layout
1213 \change_deleted 232239728 1604797616
1215 \change_inserted 232239728 1604797616
1218 his file contains the list of \SpecialChar LyX
1220 The contents are displayed with the menu entry
1221 \begin_inset Flex Noun
1224 \begin_layout Plain Layout
1225 Help\SpecialChar menuseparator
1227 \begin_inset space ~
1238 \begin_layout Labeling
1239 \labelwidthstring 00.00.0000
1240 \begin_inset Flex Code
1243 \begin_layout Plain Layout
1250 \change_deleted 232239728 1604797620
1252 \change_inserted 232239728 1604797620
1255 his is a \SpecialChar LaTeX
1256 script used during the configuration process.
1257 Do not run directly.
1260 \begin_layout Labeling
1261 \labelwidthstring 00.00.0000
1262 \begin_inset Flex Code
1265 \begin_layout Plain Layout
1272 \change_deleted 232239728 1604797624
1274 \change_inserted 232239728 1604797624
1277 his is a Python script that is used to re-configure \SpecialChar LyX
1279 It creates configuration files in the directory it was run from.
1282 \begin_layout Subsection
1283 Other files needing a line or two
1286 \begin_layout Labeling
1287 \labelwidthstring 00.00.0000
1288 \begin_inset Flex Code
1291 \begin_layout Plain Layout
1298 \change_deleted 232239728 1604797580
1300 \change_inserted 232239728 1604797580
1303 his contains tables describing how different character encodings can be mapped to Unicode
1306 \begin_layout Labeling
1307 \labelwidthstring 00.00.0000
1308 \begin_inset Flex Code
1311 \begin_layout Plain Layout
1318 \change_deleted 232239728 1604797584
1320 \change_inserted 232239728 1604797584
1323 his file contains a list of all the languages currently supported by \SpecialChar LyX
1327 \begin_layout Labeling
1328 \labelwidthstring 00.00.0000
1329 \begin_inset Flex Code
1332 \begin_layout Plain Layout
1339 \change_deleted 232239728 1604797587
1341 \change_inserted 232239728 1604797587
1344 ontains information about the supported fonts.
1347 \begin_layout Labeling
1348 \labelwidthstring 00.00.0000
1349 \begin_inset Flex Code
1352 \begin_layout Plain Layout
1359 \change_deleted 232239728 1604797591
1361 \change_inserted 232239728 1604797591
1364 his file contains translations for internationalized paragraph styles (see
1365 \begin_inset CommandInset ref
1367 reference "subsec:I18n"
1374 \begin_layout Labeling
1375 \labelwidthstring 00.00.0000
1376 \begin_inset Flex Code
1379 \begin_layout Plain Layout
1386 \change_deleted 232239728 1604797594
1388 \change_inserted 232239728 1604797594
1391 his file contains information about Unicode-encoded glyphs and the way they are supported by \SpecialChar LyX
1392 via \SpecialChar LaTeX
1396 \begin_layout Section
1397 Your local configuration directory
1400 \begin_layout Standard
1401 Even if you are using \SpecialChar LyX
1402 as an unprivileged user,
1403 you might want to change \SpecialChar LyX
1404 configuration for your own use.
1406 \begin_inset Flex Code
1409 \begin_layout Plain Layout
1415 directory contains all your personal configuration files.
1416 This is the directory described as
1417 \begin_inset Quotes eld
1421 \begin_inset Quotes erd
1425 \begin_inset Flex Noun
1428 \begin_layout Plain Layout
1429 Help\SpecialChar menuseparator
1431 \begin_inset space ~
1440 This directory is used as a mirror of
1441 \begin_inset Flex Code
1444 \begin_layout Plain Layout
1451 which means that every file in
1452 \begin_inset Flex Code
1455 \begin_layout Plain Layout
1461 is a replacement for the corresponding file in
1462 \begin_inset Flex Code
1465 \begin_layout Plain Layout
1472 Any configuration file described in the above sections can be placed either in the system-wide directory,
1473 in which case it will affect all users,
1474 or in your local directory for your own use.
1477 \begin_layout Standard
1478 To make things clearer,
1479 let's provide a few examples:
1482 \begin_layout Itemize
1483 The preferences set in the
1484 \begin_inset Flex Noun
1487 \begin_layout Plain Layout
1488 Tools\SpecialChar menuseparator
1494 dialog are saved to a file
1495 \begin_inset Flex Code
1498 \begin_layout Plain Layout
1505 \begin_inset Flex Code
1508 \begin_layout Plain Layout
1517 \begin_layout Itemize
1518 When you reconfigure using
1519 \begin_inset Flex Noun
1522 \begin_layout Plain Layout
1523 Tools\SpecialChar menuseparator
1532 \begin_inset Flex Code
1535 \begin_layout Plain Layout
1542 and the resulting files are written in your local configuration directory.
1543 This means that any additional text class file that you might have added in
1544 \begin_inset Flex Code
1547 \begin_layout Plain Layout
1553 will be added to the list of classes in the
1554 \begin_inset Flex Noun
1557 \begin_layout Plain Layout
1558 Document\SpecialChar menuseparator
1567 \begin_layout Itemize
1568 If you get some updated documentation from
1569 \change_inserted 232239728 1604798171
1573 ftp site and cannot install it because you do not have sysadmin rights on your system,
1574 you can just copy the files
1575 \change_deleted 232239728 1604798193
1577 \change_inserted 232239728 1604798193
1581 \begin_inset Flex Code
1584 \begin_layout Plain Layout
1590 and the items in the
1591 \begin_inset Flex Noun
1594 \begin_layout Plain Layout
1600 menu will open them!
1603 \begin_layout Section
1604 Running \SpecialChar LyX
1605 with multiple configurations
1608 \begin_layout Standard
1609 The configuration freedom of the local configuration directory may not suffice if you want to have more than one configuration at your disposal.
1612 \change_deleted 232239728 1604798238
1615 use different key bindings or printer settings at different times.
1616 You can achieve this by having several such directories.
1617 You then specify which directory to use at run-time.
1620 \begin_layout Standard
1621 Invoking \SpecialChar LyX
1622 with the command line switch
1623 \begin_inset Flex Code
1626 \begin_layout Plain Layout
1636 instructs the program to read the configuration from that directory,
1637 and not from the default directory.
1638 (You can determine the default directory by running \SpecialChar LyX
1640 \begin_inset Flex Code
1643 \begin_layout Plain Layout
1649 switch.) If the specified directory does not exist,
1651 offers to create it for you,
1652 just like it does for the default directory
1653 \change_deleted 232239728 1604798318
1656 the first time you run the program.
1657 You can modify the configuration options in this additional user directory exactly as you would for the default directory.
1658 These directories are completely independent (but read on).
1659 Note that setting the environment variable
1660 \begin_inset Flex Code
1663 \begin_layout Plain Layout
1669 to some value has exactly the same effect.
1672 \begin_layout Standard
1673 Having several configurations also requires more maintenance:
1674 if you want to add a new layout to
1675 \begin_inset Flex Code
1678 \begin_layout Plain Layout
1684 which you want available from all your configurations,
1685 you must add it to each directory separately.
1686 You can avoid this with the following trick:
1687 after \SpecialChar LyX
1688 creates the additional directory,
1689 most of the subdirectories (see above) are empty.
1690 If you want the new configuration to mirror an existing one,
1691 replace the empty subdirectory with a symbolic link to the matching subdirectory in the existing configuration.
1693 \begin_inset Flex Code
1696 \begin_layout Plain Layout
1704 since it contains a file written by the configuration script (also accessible through
1705 \begin_inset Flex Noun
1708 \begin_layout Plain Layout
1709 Tools\SpecialChar menuseparator
1715 ) which is configuration
1716 \change_deleted 232239728 1604798083
1718 \change_inserted 232239728 1604798100
1724 \begin_layout Chapter
1725 The Preferences dialog
1728 \begin_layout Standard
1729 All options of the preferences dialog are described in the Appendix
1731 The Preferences Dialog
1738 For some options you might find here more details.
1741 \begin_layout Section
1743 \begin_inset CommandInset label
1752 \begin_layout Standard
1753 The first step is to define your file formats if they are not already defined.
1756 \begin_inset Flex Noun
1759 \begin_layout Plain Layout
1760 Tools\SpecialChar menuseparator
1768 \begin_inset Flex Noun
1771 \begin_layout Plain Layout
1772 File Handling\SpecialChar menuseparator
1779 \begin_inset Flex Noun
1782 \begin_layout Plain Layout
1788 button to define your new format.
1790 \begin_inset Flex Noun
1793 \begin_layout Plain Layout
1799 field contains the name used to identify the format in the GUI.
1801 \begin_inset Flex Noun
1804 \begin_layout Plain Layout
1810 is used to identify the format internally.
1811 You will also need to enter a file extension.
1812 These are all required.
1814 \begin_inset Flex Noun
1817 \begin_layout Plain Layout
1823 field is used to provide a keyboard shortcut on the menus.
1826 \begin_inset Flex Noun
1829 \begin_layout Plain Layout
1836 \begin_inset Flex Noun
1839 \begin_layout Plain Layout
1840 Document\SpecialChar menuseparator
1841 View (Other Formats)\SpecialChar menuseparator
1850 \begin_layout Standard
1852 \begin_inset Flex Noun
1855 \begin_layout Plain Layout
1862 \begin_inset Flex Noun
1865 \begin_layout Plain Layout
1873 you might want to use
1874 \begin_inset Flex Noun
1877 \begin_layout Plain Layout
1883 to view PostScript files.
1884 You can enter the command needed to start the program in the corresponding fields.
1885 In defining this command,
1886 you can use the four variables listed in the next section.
1887 The viewer is launched when you view an image in \SpecialChar LyX
1889 \begin_inset Flex Noun
1892 \begin_layout Plain Layout
1893 Document\SpecialChar menuseparator
1900 The editor is for example launched when you right-click on an image and choose
1901 \begin_inset Flex Noun
1904 \begin_layout Plain Layout
1910 in the appearing context menu.
1913 \begin_layout Standard
1915 \begin_inset Flex Noun
1918 \begin_layout Plain Layout
1924 type of a format is optional,
1925 but if it is specified,
1926 it must be unique across all formats.
1927 It is used to detect files of this format from the file contents.
1928 For some important file formats there is no MIME type officially registered with the
1929 \begin_inset CommandInset href
1932 target "http://www.iana.org/assignments/media-types/"
1938 Therefore \SpecialChar LyX
1939 uses the extended list of MIME types as specified by
1940 \begin_inset CommandInset href
1942 name "freedesktop.org"
1943 target "http://www.freedesktop.org/wiki/Specifications/shared-mime-info-spec"
1951 \begin_layout Standard
1953 \begin_inset Flex Noun
1956 \begin_layout Plain Layout
1962 option tells \SpecialChar LyX
1963 that a format is suitable for document export.
1964 If this is set and if a suitable conversion route exists (see
1965 \begin_inset CommandInset ref
1967 reference "sec:Converters"
1972 the format will appear in the
1973 \begin_inset Flex Noun
1976 \begin_layout Plain Layout
1977 File\SpecialChar menuseparator
1984 The format will also appear in the
1985 \begin_inset Flex Noun
1988 \begin_layout Plain Layout
1989 Document\SpecialChar menuseparator
1995 menu if a viewer is specified for the format.
1998 \begin_inset Flex Code
2001 \begin_layout Plain Layout
2008 should not use this option.
2009 Formats that can both represent vector graphics and documents like
2010 \begin_inset Flex Code
2013 \begin_layout Plain Layout
2022 \begin_layout Standard
2024 \begin_inset Flex Noun
2027 \begin_layout Plain Layout
2028 Vector graphics format
2033 tells \SpecialChar LyX
2034 that a format can contain vector graphics.
2035 This information is used to determine the target format of included graphics for
2036 \begin_inset Flex Noun
2039 \begin_layout Plain Layout
2046 Included graphics may need to be converted to either
2047 \begin_inset Flex Noun
2050 \begin_layout Plain Layout
2058 \begin_inset Flex Noun
2061 \begin_layout Plain Layout
2069 \begin_inset Flex Noun
2072 \begin_layout Plain Layout
2080 \begin_inset Flex Noun
2083 \begin_layout Plain Layout
2089 cannot handle other image formats.
2090 If an included graphic is not already in
2091 \begin_inset Flex Noun
2094 \begin_layout Plain Layout
2102 \begin_inset Flex Noun
2105 \begin_layout Plain Layout
2113 \begin_inset Flex Noun
2116 \begin_layout Plain Layout
2124 \begin_inset Flex Noun
2127 \begin_layout Plain Layout
2133 if the vector format option is set,
2135 \begin_inset Flex Noun
2138 \begin_layout Plain Layout
2147 \begin_layout Section
2151 \begin_layout Standard
2152 Since all conversions from one format to another take place in \SpecialChar LyX
2153 's temporary directory,
2154 it is sometimes necessary to modify a file before copying it to the temporary directory in order that the conversion may be performed.
2158 \begin_layout Plain Layout
2160 the file may refer to other files—
2163 using relative file names,
2164 and these may become invalid when the file is copied to the temporary directory.
2169 This is done by a Copier:
2170 It copies a file to (or from) the temporary directory and may modify it in the process.
2173 \begin_layout Standard
2174 The definitions of the copiers may use eight variables:
2177 \begin_layout Labeling
2178 \labelwidthstring 00.00.0000
2179 \begin_inset Flex Code
2182 \begin_layout Plain Layout
2188 The \SpecialChar LyX
2189 system directory (e.
2190 \begin_inset space \thinspace{}
2194 \begin_inset space \space{}
2198 \begin_inset Flex Noun
2201 \begin_layout Plain Layout
2210 \begin_layout Labeling
2211 \labelwidthstring 00.00.0000
2212 \begin_inset Flex Code
2215 \begin_layout Plain Layout
2224 \begin_layout Labeling
2225 \labelwidthstring 00.00.0000
2226 \begin_inset Flex Code
2229 \begin_layout Plain Layout
2238 \begin_layout Labeling
2239 \labelwidthstring 00.00.0000
2240 \begin_inset Flex Code
2243 \begin_layout Plain Layout
2249 The base name (without filename extension) in the \SpecialChar LyX
2253 \begin_layout Labeling
2254 \labelwidthstring 00.00.0000
2255 \begin_inset Flex Code
2258 \begin_layout Plain Layout
2264 The full directory path of the \SpecialChar LyX
2268 \begin_layout Labeling
2269 \labelwidthstring 00.00.0000
2270 \begin_inset Flex Code
2273 \begin_layout Plain Layout
2279 The full pathname to the original \SpecialChar LyX
2280 file being processed
2283 \begin_layout Labeling
2284 \labelwidthstring 00.00.0000
2285 \begin_inset Flex Code
2288 \begin_layout Plain Layout
2294 The filename (without any directory path) of the \SpecialChar LyX
2298 \begin_layout Labeling
2299 \labelwidthstring 00.00.0000
2300 \begin_inset Flex Code
2303 \begin_layout Plain Layout
2309 The `\SpecialChar LaTeX
2313 \begin_layout Standard
2314 The latter should be the filename as it would be used in a \SpecialChar LaTeX
2322 It is relevant only when exporting files suitable for such inclusion.
2325 \begin_layout Standard
2326 Copiers can be used to do almost anything with output files.
2328 suppose you want generated pdf files to be copied to a special directory,
2330 \begin_inset Flex Code
2333 \begin_layout Plain Layout
2340 Then you could write a shell script such as this one:
2343 \begin_layout Standard
2344 \begin_inset listings
2348 \begin_layout Plain Layout
2353 \begin_layout Plain Layout
2358 \begin_layout Plain Layout
2360 TOFILE=`basename $2`
2363 \begin_layout Plain Layout
2365 cp $FROMFILE /home/you/pdf/$TOFILE
2370 Save it in your local \SpecialChar LyX
2374 \begin_inset Flex Code
2377 \begin_layout Plain Layout
2378 /home/you/.lyx/scripts/pdfcopier.sh
2384 and make it executable,
2385 if you need to do so on your platform.
2388 \begin_inset Flex Noun
2391 \begin_layout Plain Layout
2392 Tools\SpecialChar menuseparator
2400 \begin_inset Flex Noun
2403 \begin_layout Plain Layout
2404 File Handling\SpecialChar menuseparator
2411 \begin_inset Flex Noun
2414 \begin_layout Plain Layout
2421 or one of the other pdf formats—
2423 \begin_inset Flex Code
2426 \begin_layout Plain Layout
2427 pdfcopier.sh $$i $$o
2433 \begin_inset Flex Noun
2436 \begin_layout Plain Layout
2446 \begin_layout Standard
2447 Copiers are used by \SpecialChar LyX
2448 in various of its own conversions.
2450 if appropriate programs are found,
2452 will automatically install copiers for the
2453 \begin_inset Flex Noun
2456 \begin_layout Plain Layout
2463 \begin_inset Flex Noun
2466 \begin_layout Plain Layout
2468 \begin_inset space ~
2477 When these formats are exported,
2478 the copier sees that not just the main HTML file but various associated files (style files,
2480 etc.) are also copied.
2481 All these files are written to a subdirectory of the directory in which the original \SpecialChar LyX
2486 \begin_layout Plain Layout
2487 This copier can be customized.
2489 \begin_inset Quotes eld
2493 \begin_inset Quotes erd
2496 argument takes a comma-separated list of extensions to be copied;
2498 all files will be copied.
2500 \begin_inset Quotes eld
2504 \begin_inset Quotes erd
2507 argument determines the extension added to the generated directory.
2510 \begin_inset Quotes eld
2514 \begin_inset Flex Noun
2517 \begin_layout Plain Layout
2524 \begin_inset Quotes erd
2528 so HTML generated from
2529 \begin_inset Flex Noun
2532 \begin_layout Plain Layout
2533 /path/to/filename.lyx
2539 \begin_inset Flex Noun
2542 \begin_layout Plain Layout
2543 /path/to/filename.html.LyXconv
2557 \begin_layout Section
2559 \begin_inset CommandInset label
2561 name "sec:Converters"
2568 \begin_layout Standard
2569 You can define your own Converters to convert files between different formats.
2571 \begin_inset Flex Noun
2574 \begin_layout Plain Layout
2575 Tools\SpecialChar menuseparator
2576 Preferences\SpecialChar menuseparator
2577 File Handling\SpecialChar menuseparator
2586 \begin_layout Standard
2587 To define a new converter,
2589 \begin_inset Flex Noun
2592 \begin_layout Plain Layout
2594 \begin_inset space ~
2603 \begin_inset Flex Noun
2606 \begin_layout Plain Layout
2608 \begin_inset space ~
2616 from the drop-down lists,
2617 enter the command needed for the conversion,
2619 \begin_inset Flex Noun
2622 \begin_layout Plain Layout
2629 Several variables can be used in the definition of converters:
2632 \begin_layout Labeling
2633 \labelwidthstring 00.00.0000
2634 \begin_inset Flex Code
2637 \begin_layout Plain Layout
2643 The \SpecialChar LyX
2647 \begin_layout Labeling
2648 \labelwidthstring 00.00.0000
2649 \begin_inset Flex Code
2652 \begin_layout Plain Layout
2661 \begin_layout Labeling
2662 \labelwidthstring 00.00.0000
2663 \begin_inset Flex Code
2666 \begin_layout Plain Layout
2675 \begin_layout Labeling
2676 \labelwidthstring 00.00.0000
2677 \begin_inset Flex Code
2680 \begin_layout Plain Layout
2686 The base filename of the input file (i.
2687 \begin_inset space \thinspace{}
2691 without the extension)
2694 \begin_layout Labeling
2695 \labelwidthstring 00.00.0000
2696 \begin_inset Flex Code
2699 \begin_layout Plain Layout
2705 The path to the input file
2708 \begin_layout Labeling
2709 \labelwidthstring 00.00.0000
2710 \begin_inset Flex Code
2713 \begin_layout Plain Layout
2719 The path to the original input file (this is different from $$p when a chain of converters is called)
2722 \begin_layout Labeling
2723 \labelwidthstring 00.00.0000
2724 \begin_inset Flex Code
2727 \begin_layout Plain Layout
2733 The iconv name for the encoding of the document.
2736 \begin_layout Standard
2738 \begin_inset Flex Noun
2741 \begin_layout Plain Layout
2743 \begin_inset space ~
2751 field you can enter the following flags,
2752 separated by commas:
2755 \begin_layout Labeling
2756 \labelwidthstring 00.00.0000
2757 \begin_inset Flex Code
2760 \begin_layout Plain Layout
2762 \change_inserted -712698321 1524656940
2770 This converter runs some form of \SpecialChar LaTeX
2772 This will make \SpecialChar LyX
2773 's \SpecialChar LaTeX
2774 error logs available.
2776 \change_inserted -712698321 1524657018
2778 \begin_inset Flex Code
2781 \begin_layout Plain Layout
2783 \change_inserted -712698321 1524657012
2791 value specifies the form of \SpecialChar LaTeX
2793 \begin_inset Flex Code
2796 \begin_layout Plain Layout
2798 \change_inserted -712698321 1524657005
2811 If no value is specified,
2813 \begin_inset Flex Code
2816 \begin_layout Plain Layout
2818 \change_inserted -712698321 1524657018
2831 \begin_layout Labeling
2832 \labelwidthstring 00.00.0000
2833 \begin_inset Flex Code
2836 \begin_layout Plain Layout
2838 \change_inserted -712698321 1524656935
2846 Needs the \SpecialChar LaTeX
2848 \begin_inset Flex Noun
2851 \begin_layout Plain Layout
2857 file for the conversion.
2859 \change_inserted -712698321 1524657047
2861 \begin_inset Flex Code
2864 \begin_layout Plain Layout
2866 \change_inserted -712698321 1524657030
2874 value specifies the form of \SpecialChar LaTeX
2875 that is run in order to generate the
2876 \begin_inset Flex Noun
2879 \begin_layout Plain Layout
2881 \change_inserted -712698321 1524657047
2890 \begin_inset Flex Code
2893 \begin_layout Plain Layout
2895 \change_inserted -712698321 1524657030
2908 If no value is specified,
2910 \begin_inset Flex Code
2913 \begin_layout Plain Layout
2915 \change_inserted -712698321 1524657030
2928 \begin_layout Labeling
2929 \labelwidthstring 00.00.0000
2930 \begin_inset Flex Code
2933 \begin_layout Plain Layout
2940 \begin_inset Quotes eld
2944 \begin_inset Quotes erd
2947 file from the backend,
2948 which in practice means a \SpecialChar LaTeX
2949 file like the one we would export,
2951 \begin_inset Flex Code
2954 \begin_layout Plain Layout
2963 \begin_layout Labeling
2964 \labelwidthstring 00.00.0000
2965 \begin_inset Flex Code
2968 \begin_layout Plain Layout
2977 \begin_layout Standard
2978 The following three flags are not really flags at all because they take an argument in the
2979 \begin_inset Flex Noun
2982 \begin_layout Plain Layout
2984 \begin_inset space ~
2988 \begin_inset space ~
2999 \begin_layout Labeling
3000 \labelwidthstring 00.00.0000
3002 \change_inserted -712698321 1523206314
3003 \begin_inset Flex Code
3006 \begin_layout Plain Layout
3008 \change_inserted -712698321 1523206193
3016 The name of the driver that needs to be loaded with the
3020 package for this converter.
3021 The loading of the correct driver is necessary to get some PDF-specific features.
3029 \begin_layout Labeling
3030 \labelwidthstring 00.00.0000
3031 \begin_inset Flex Code
3034 \begin_layout Plain Layout
3041 the converter's standard error will be redirected to a file
3042 \begin_inset Flex Code
3045 \begin_layout Plain Layout
3052 and the script given as argument will be run as:
3054 \begin_inset Flex Code
3057 \begin_layout Plain Layout
3058 script < infile.out > infile.log
3064 The argument may contain
3065 \begin_inset Flex Code
3068 \begin_layout Plain Layout
3077 \begin_layout Labeling
3078 \labelwidthstring 00.00.0000
3079 \begin_inset Flex Code
3082 \begin_layout Plain Layout
3088 The name of the directory in which the converter will dump the generated files.
3090 will not create this directory,
3091 and it does not copy anything into it,
3092 though it will copy this directory to the destination.
3093 The argument may contain
3094 \begin_inset Flex Code
3097 \begin_layout Plain Layout
3104 which will be replaced by the base name of the input and output files,
3106 when the directory is copied.
3107 \begin_inset Newline newline
3110 Note that resultdir and usetempdir make no sense together.
3111 The latter will be ignored if the former is given.
3114 \begin_layout Labeling
3115 \labelwidthstring 00.00.0000
3116 \begin_inset Flex Code
3119 \begin_layout Plain Layout
3125 Determines the output file name and may,
3127 \begin_inset Flex Code
3130 \begin_layout Plain Layout
3137 Sensible only with resultdir and optional even then;
3139 it defaults to `index'.
3142 \begin_layout Standard
3144 \change_inserted -712698321 1523206384
3145 A suitable hyperref-driver is set for some converters that are installed with \SpecialChar LyX
3148 \change_deleted -712698321 1523206388
3150 \change_inserted -712698321 1523206389
3154 \change_inserted -712698321 1523206400
3160 \change_inserted -712698321 1523206407
3164 \change_inserted -712698321 1523206437
3168 \change_deleted -712698321 1523206442
3169 that are installed with \SpecialChar LyX
3176 \begin_layout Standard
3177 You do not have to define converters for all formats between which you want to convert.
3179 you will note that there is no `\SpecialChar LyX
3180 to PostScript' converter,
3181 but \SpecialChar LyX
3182 will export PostScript.
3183 It does so by first creating a \SpecialChar LaTeX
3184 file (no converter needs to be defined for this) which is then converted to DVI using the `\SpecialChar LaTeX
3186 and finally converting the resulting DVI file to PostScript.
3188 finds such `chains' of converters automatically,
3189 and it will always choose the shortest possible chain.
3192 still define multiple conversion methods between file formats.
3194 the standard \SpecialChar LyX
3195 configuration provides five ways to convert \SpecialChar LaTeX
3199 \begin_layout Enumerate
3202 \begin_inset Flex Noun
3205 \begin_layout Plain Layout
3214 \begin_layout Enumerate
3215 via (DVI and) PostScript,
3217 \begin_inset Flex Noun
3220 \begin_layout Plain Layout
3229 \begin_layout Enumerate
3232 \begin_inset Flex Noun
3235 \begin_layout Plain Layout
3244 \begin_layout Enumerate
3246 \begin_inset Flex Noun
3249 \begin_layout Plain Layout
3259 \begin_layout Enumerate
3261 \begin_inset Flex Noun
3264 \begin_layout Plain Layout
3274 \begin_layout Standard
3275 To define such alternate chains,
3276 you must define multiple target `file formats',
3278 \begin_inset CommandInset ref
3280 reference "sec:Formats"
3286 in the standard configuration,
3288 \begin_inset Flex Noun
3291 \begin_layout Plain Layout
3298 \begin_inset Flex Noun
3301 \begin_layout Plain Layout
3309 \begin_inset Flex Noun
3312 \begin_layout Plain Layout
3319 \begin_inset Flex Noun
3322 \begin_layout Plain Layout
3330 \begin_inset Flex Noun
3333 \begin_layout Plain Layout
3340 \begin_inset Flex Noun
3343 \begin_layout Plain Layout
3351 \begin_inset Flex Noun
3354 \begin_layout Plain Layout
3361 \begin_inset Flex Noun
3364 \begin_layout Plain Layout
3373 \begin_inset Flex Noun
3376 \begin_layout Plain Layout
3383 \begin_inset Flex Noun
3386 \begin_layout Plain Layout
3394 all of which share the extension
3395 \begin_inset Flex Noun
3398 \begin_layout Plain Layout
3405 and which correspond to the conversion methods just mentioned.
3408 \begin_layout Chapter
3409 Internationalizing \SpecialChar LyX
3411 \begin_inset CommandInset label
3413 name "cha:Internationalizing-LyX"
3420 \begin_layout Standard
3422 supports using a translated interface.
3423 Last time we checked,
3425 provided text in thirty languages.
3426 The language of choice is called your
3431 (For further reading on locale settings,
3432 see also the documentation for locale that comes with your operating system.
3435 \begin_inset Flex Code
3438 \begin_layout Plain Layout
3444 could be a good place to start).
3447 \begin_layout Standard
3448 Notice that these translations will work,
3449 but do contain a few flaws.
3451 all dialogs have been designed with the English text in mind,
3452 which means that some of the translated text will be too large to fit within the space allocated.
3453 This is only a display problem and will not cause any harm.
3455 you will find that some of the translations do not define shortcut keys for everything.
3457 there are simply not enough free letters to do it.
3459 the translator just hasn't got around to doing it yet.
3460 Our localization team,
3461 which you may wish to join,
3465 \begin_layout Plain Layout
3466 If you are a fluent speaker of a language other than English,
3467 joining these teams is a great way to give back to the \SpecialChar LyX
3473 will of course try to fix these shortcomings in future versions of \SpecialChar LyX
3477 \begin_layout Section
3478 Translating \SpecialChar LyX
3482 \begin_layout Subsection
3483 Translating the graphical user interface (text messages).
3486 \begin_layout Standard
3489 \begin_inset Flex Code
3492 \begin_layout Plain Layout
3498 library to handle the internationalization of the interface.
3499 To have \SpecialChar LyX
3500 speak your favorite language in all menus and dialogs,
3502 \begin_inset Flex Code
3505 \begin_layout Plain Layout
3511 -file for that language.
3512 When this is available,
3513 you'll have to generate a
3514 \begin_inset Flex Code
3517 \begin_layout Plain Layout
3523 -file from it and install the
3524 \begin_inset Flex Code
3527 \begin_layout Plain Layout
3534 The process of doing all of this is explained in the documentation for GNU
3535 \begin_inset Flex Code
3538 \begin_layout Plain Layout
3545 It is possible to do this just for yourself,
3546 but if you're going to do it,
3547 you might as well share the results of your labors with the rest of the \SpecialChar LyX
3549 Send a message to the \SpecialChar LyX
3550 developers' list for more information about how to proceed.
3553 \begin_layout Standard
3555 this is what you should do (xx denotes the language code):
3558 \begin_layout Itemize
3559 Check out the \SpecialChar LyX
3562 \begin_inset CommandInset href
3564 name "information on the web"
3565 target "https://www.lyx.org/HowToUseGIT"
3573 \begin_layout Itemize
3575 \begin_inset Flex Code
3578 \begin_layout Plain Layout
3584 to the folder of the
3585 \begin_inset Flex Code
3588 \begin_layout Plain Layout
3596 \begin_inset Flex Code
3599 \begin_layout Plain Layout
3607 \begin_inset Flex Code
3610 \begin_layout Plain Layout
3616 doesn't exist anywhere,
3617 it can be remade with the console command
3618 \begin_inset Flex Code
3621 \begin_layout Plain Layout
3628 or you can use an existing po-file for some other language as a template).
3631 \begin_layout Itemize
3633 \begin_inset Flex Code
3636 \begin_layout Plain Layout
3646 \begin_layout Plain Layout
3647 This is just a text file,
3648 so it can be edited in any text editor.
3649 But there are also specialized programs that support such editing,
3654 (for all platforms) or
3663 contains a `mode' for editing
3664 \begin_inset Flex Code
3667 \begin_layout Plain Layout
3676 \begin_inset Flex URL
3679 \begin_layout Plain Layout
3681 https://www.gnu.org/software/gettext/manual/html_node/PO-Mode.html#PO-Mode
3691 For some menu- and widget-labels,
3692 there are also shortcut keys that should be translated.
3693 Those keys are marked after a `|',
3694 and should be translated according to the words and phrases of the language.
3695 You should also fill also out the information at the beginning of the new
3696 \begin_inset Flex Code
3699 \begin_layout Plain Layout
3705 -file with your email-address,
3707 so people know where to reach you with suggestions and entertaining flames.
3710 \begin_layout Standard
3711 If you are just doing this on your own,
3715 \begin_layout Itemize
3717 \begin_inset Flex Code
3720 \begin_layout Plain Layout
3727 This can be done with
3728 \begin_inset Flex Code
3731 \begin_layout Plain Layout
3732 msgfmt -o xx.mo < xx.po
3740 \begin_layout Itemize
3742 \begin_inset Flex Code
3745 \begin_layout Plain Layout
3751 -file to your locale-tree,
3752 at the correct directory for application messages for the language
3758 \begin_inset Flex Code
3761 \begin_layout Plain Layout
3768 \begin_inset space \thinspace{}
3772 \begin_inset space \space{}
3776 \begin_inset Flex Code
3779 \begin_layout Plain Layout
3780 /usr/local/share/locale/xx/LC_MESSAGES/lyx.mo
3790 \begin_layout Standard
3793 it would be best if the new
3794 \begin_inset Flex Code
3797 \begin_layout Plain Layout
3803 file could be added to the \SpecialChar LyX
3805 so others can use it.
3806 Adding it involves making additional changes to \SpecialChar LyX
3808 So send an email to the developers' mailing list if you're interested in doing that.
3811 \begin_layout Subsubsection
3815 \begin_layout Standard
3816 Sometimes it turns out that one English message needs to be translated into different messages in the target language.
3817 One example is the message
3818 \begin_inset Flex Code
3821 \begin_layout Plain Layout
3827 which has the German translation
3836 depending upon exactly what the English
3837 \begin_inset Quotes eld
3841 \begin_inset Quotes erd
3846 \begin_inset Flex Code
3849 \begin_layout Plain Layout
3855 does not handle such ambiguous translations.
3856 Therefore you have to add some context information to the message:
3858 \begin_inset Flex Code
3861 \begin_layout Plain Layout
3868 \begin_inset Flex Code
3871 \begin_layout Plain Layout
3872 To[[as in 'From format x to format y']]
3878 \begin_inset Flex Code
3881 \begin_layout Plain Layout
3882 To[[as in 'From page x to page y']].
3887 Now the two occurrences of
3888 \begin_inset Flex Code
3891 \begin_layout Plain Layout
3898 \begin_inset Flex Code
3901 \begin_layout Plain Layout
3907 and can be translated correctly to
3919 \begin_layout Standard
3920 Of course the context information needs to be stripped off the original message when no translation is used.
3921 Therefore you have to put it in double square brackets at the end of the message (see the example above).
3922 The translation mechanism of \SpecialChar LyX
3923 ensures that everything in double square brackets at the end of messages is removed before displaying the message.
3926 \begin_layout Subsection
3927 Translating the documentation.
3930 \begin_layout Standard
3931 The online documentation (in the
3932 \begin_inset Flex Noun
3935 \begin_layout Plain Layout
3941 -menu) can (and should!) be translated.
3942 If there are translated versions of the documentation available
3946 \begin_layout Plain Layout
3948 at least some of the documents have been translated into fourteen languages,
3949 with the Tutorial available in a few more.
3954 and the locale is set accordingly,
3955 these will be used automagically by \SpecialChar LyX
3958 looks for translated versions as
3959 \begin_inset Flex Code
3962 \begin_layout Plain Layout
3963 LyXDir/doc/xx/DocName.lyx
3970 \begin_inset Flex Code
3973 \begin_layout Plain Layout
3979 is the code for the language currently in use.
3980 If there are no translated documents,
3981 the default English versions will be displayed.
3982 Note that the translated versions must have the same filenames (
3983 \begin_inset Flex Code
3986 \begin_layout Plain Layout
3992 above) as the original.
3993 If you feel up to translating the documentation (an excellent way to proof-read the original documentation by the way!),
3994 there are a few things you should do right away:
3997 \begin_layout Itemize
3998 Check out the documentation translation web page at
3999 \begin_inset CommandInset href
4001 name "https://www.lyx.org/Translation"
4002 target "https://www.lyx.org/Translation"
4009 you can find out which (if any) documents have already been translated into your language.
4010 You can also find out who (if anyone) is organizing the effort to translate the documentation into your language.
4011 If no one is organizing the effort,
4012 please let us know that you're interested.
4015 \begin_layout Standard
4016 Once you get to actually translating,
4017 here's a few hints for you that may save you trouble:
4020 \begin_layout Itemize
4021 Join the documentation team!
4022 There is information on how to do that in
4023 \begin_inset Flex Code
4026 \begin_layout Plain Layout
4033 \begin_inset Flex Noun
4036 \begin_layout Plain Layout
4037 Help\SpecialChar menuseparator
4044 which by the way is the first document you should translate.
4047 \begin_layout Itemize
4048 Learn the typographic conventions for the language you are translating to.
4049 Typography is an ancient art and over the centuries,
4050 a great variety of conventions have developed throughout different parts of the world.
4051 Also study the professional terminology amongst typographers in your country.
4052 Inventing your own terminology will only confuse the users.
4056 Typography is addictive!)
4059 \begin_layout Itemize
4060 Make a copy of the document.
4061 This will be your working copy.
4062 You can use this as your personal translated help-file by placing it in your
4063 \begin_inset Flex Code
4066 \begin_layout Plain Layout
4073 \begin_inset Note Greyedout
4076 \begin_layout Plain Layout
4082 For a complex document with external material (images,
4084 if you make a copy e.
4085 \begin_inset space \thinspace{}
4089 \begin_inset space \space{}
4093 beware that the links to external material may be broken when the document is moved to a different place.
4094 The best way is to retrieve the \SpecialChar LyX
4096 \begin_inset Flex URL
4099 \begin_layout Plain Layout
4101 https://www.lyx.org/HowToUseGIT
4106 ) and to edit the doc file in place.
4114 \begin_layout Itemize
4115 Sometimes the original document (from the \SpecialChar LyX
4116 team) will be updated.
4117 Use the source viewer at
4118 \begin_inset CommandInset href
4120 name "https://www.lyx.org/trac/timeline"
4121 target "https://www.lyx.org/trac/timeline"
4126 to see what has been changed.
4127 That way you can easily see which parts of the translated document need to be updated.
4130 \begin_layout Standard
4131 If you ever find an error in the original document,
4132 fix it and notify the rest of the documentation team of the changes!
4133 (You didn't forget to join the documentation team,
4137 \begin_layout Standard
4138 \begin_inset Branch OutDated
4142 \begin_layout Section
4143 International Keyboard Support
4146 \begin_layout Standard
4150 The following section is by
4158 It needs to be fixed to conform to the new Documentation Style sheet and to make use of the new v1.0 features.
4159 The whole thing also needs to be merged with the section following it.-jw It may also be badly out of date.-rh (2008)]
4162 \begin_layout Subsection
4163 Defining Own Keymaps:
4167 \begin_layout Standard
4168 Let's look at a keyboard definition file a little closer.
4169 It is a plain text file defining
4172 \begin_layout Itemize
4173 key-to-key or key-to-string translations
4176 \begin_layout Itemize
4180 \begin_layout Itemize
4181 dead keys exceptions
4184 \begin_layout Standard
4185 To define key-to-key or key-to-string translation,
4189 \begin_layout Quotation
4190 \begin_inset Flex Code
4193 \begin_layout Plain Layout
4202 \begin_inset Flex Code
4205 \begin_layout Plain Layout
4214 \begin_layout Standard
4216 \begin_inset Flex Code
4219 \begin_layout Plain Layout
4225 is the key to be translated and
4226 \begin_inset Flex Code
4229 \begin_layout Plain Layout
4235 is the string to be inserted into the document.
4236 To define dead keys,
4240 \begin_layout Quotation
4241 \begin_inset Flex Code
4244 \begin_layout Plain Layout
4253 \begin_inset Flex Code
4256 \begin_layout Plain Layout
4265 \begin_layout Standard
4267 \begin_inset Flex Code
4270 \begin_layout Plain Layout
4276 is a keyboard key and
4277 \begin_inset Flex Code
4280 \begin_layout Plain Layout
4287 The following dead keys are supported (shortcut name is in parentheses):
4290 \begin_layout Quotation
4294 \begin_inset space \hfill{}
4300 \begin_layout Quotation
4302 \begin_inset space \hfill{}
4308 \begin_layout Quotation
4310 \begin_inset space \hfill{}
4316 \begin_layout Quotation
4318 \begin_inset space \hfill{}
4324 \begin_layout Quotation
4326 \begin_inset space \hfill{}
4332 \begin_layout Quotation
4334 \begin_inset space \hfill{}
4341 \begin_layout Plain Layout
4353 \begin_layout Quotation
4355 \begin_inset space \hfill{}
4361 \begin_layout Quotation
4363 \begin_inset space \hfill{}
4370 \begin_layout Plain Layout
4382 \begin_layout Quotation
4384 \begin_inset space \hfill{}
4390 \begin_layout Quotation
4392 \begin_inset space \hfill{}
4398 \begin_layout Quotation
4400 \begin_inset space \hfill{}
4407 \begin_layout Plain Layout
4419 \begin_layout Quotation
4421 \begin_inset space \hfill{}
4428 \begin_layout Plain Layout
4440 \begin_layout Quotation
4442 \begin_inset space \hfill{}
4448 \begin_layout Quotation
4449 hungarian umlaut (hug)
4450 \begin_inset space \hfill{}
4456 \begin_layout Quotation
4458 \begin_inset space \hfill{}
4464 \begin_layout Quotation
4466 \begin_inset space \hfill{}
4473 \begin_layout Plain Layout
4485 \begin_layout Standard
4486 Since in many international keyboards there are exceptions to what some dead keys should do,
4487 you can define them using
4490 \begin_layout Quotation
4491 \begin_inset Flex Code
4494 \begin_layout Plain Layout
4502 deadkey key outstring
4505 \begin_layout Standard
4508 if you enter caron-o,
4509 it generates circumflex-o,
4513 \begin_layout Quotation
4514 \begin_inset Flex Code
4517 \begin_layout Plain Layout
4530 \begin_layout Standard
4531 to make it work correctly.
4533 you have to define as exceptions dead keys over i and j,
4534 to remove the dot from them before inserting an accent mark.
4535 I will change this when the time comes,
4536 but so far I haven't had time.
4539 \begin_layout Standard
4541 and about characters:
4542 backslash is escaped,
4544 you'll need double backslash.
4547 \begin_inset Flex Code
4550 \begin_layout Plain Layout
4556 have different meaning.
4558 \begin_inset Flex Code
4561 \begin_layout Plain Layout
4568 quotes start and end \SpecialChar LaTeX
4572 \begin_inset Flex Code
4575 \begin_layout Plain Layout
4585 \begin_inset Flex Code
4588 \begin_layout Plain Layout
4596 \begin_inset Flex Code
4599 \begin_layout Plain Layout
4610 \begin_layout Standard
4611 If you make a keyboard description file that works for your language,
4612 please mail it to me,
4613 so I can include it in the next keymap distribution.
4616 \begin_layout Standard
4617 More keywords will be supported in keymap configuration file in future,
4621 \begin_layout Itemize
4622 \begin_inset Flex Code
4625 \begin_layout Plain Layout
4636 \begin_inset space \hfill{}
4640 \begin_inset Flex Code
4643 \begin_layout Plain Layout
4652 \begin_layout Itemize
4653 \begin_inset Flex Code
4656 \begin_layout Plain Layout
4667 \begin_inset space \hfill{}
4671 \begin_inset Flex Code
4674 \begin_layout Plain Layout
4680 an external keymap translation program
4683 \begin_layout Standard
4686 \begin_inset Flex Code
4689 \begin_layout Plain Layout
4698 \begin_inset Flex Code
4701 \begin_layout Plain Layout
4709 option to include default keyboard).
4717 \begin_layout Section
4718 International Keymap Stuff
4719 \begin_inset CommandInset label
4721 name "sec:International-Keymap-Stuff"
4728 \begin_layout Standard
4729 \begin_inset Note Note
4732 \begin_layout Plain Layout
4733 In doing the revisions on this document in March 2008,
4734 I did not look over this stuff,
4735 as I do not understand it.
4736 It would be good if someone else could do so.
4745 \begin_layout Standard
4746 The next two sections describe the
4747 \begin_inset Flex Code
4750 \begin_layout Plain Layout
4759 \begin_inset Flex Code
4762 \begin_layout Plain Layout
4770 file syntax in detail.
4771 These sections should help you design your own key map if the ones provided do not meet your needs.
4774 \begin_layout Subsection
4778 \begin_layout Standard
4782 \begin_inset Flex Code
4785 \begin_layout Plain Layout
4791 file maps keystrokes to characters or strings.
4792 As the name suggests,
4793 it sets a keyboard mapping.
4795 \begin_inset Flex Code
4798 \begin_layout Plain Layout
4809 \begin_inset Flex Code
4812 \begin_layout Plain Layout
4828 \begin_inset Flex Code
4831 \begin_layout Plain Layout
4845 \begin_inset Flex Code
4848 \begin_layout Plain Layout
4858 \begin_inset Flex Code
4861 \begin_layout Plain Layout
4869 are described in this section.
4872 \begin_layout Labeling
4873 \labelwidthstring 00.00.0000
4874 \begin_inset Flex Code
4877 \begin_layout Plain Layout
4885 Map a character to a string
4888 \begin_layout LyX-Code
4903 \begin_layout Standard
4937 the double-quote (")
4954 must be escaped with a preceding backslash (
4965 \begin_layout Standard
4967 \begin_inset Flex Noun
4970 \begin_layout Plain Layout
4978 statement to cause the symbol
4979 \begin_inset Flex Noun
4982 \begin_layout Plain Layout
4990 to be output for the keystroke
4991 \begin_inset Flex Noun
4994 \begin_layout Plain Layout
5005 \begin_layout LyX-Code
5011 \begin_layout Labeling
5012 \labelwidthstring 00.00.0000
5013 \begin_inset Flex Code
5016 \begin_layout Plain Layout
5024 Specify an accent character
5027 \begin_layout LyX-Code
5036 \begin_layout Standard
5037 This will make the cha
5075 This is the dead key
5079 \begin_layout Plain Layout
5086 refers to a key that does not produce a character by itself,
5087 but when followed with another key,
5088 produces the desired accent character.
5092 r with an umlaut like
5102 can be produced in this manner.
5111 \begin_layout Standard
5124 and then another key not in
5142 followed by the other,
5148 \begin_inset Flex Noun
5151 \begin_layout Plain Layout
5171 \begin_inset Flex Noun
5174 \begin_layout Plain Layout
5184 the cursor will not go one position backwards but will instead cancel the effect t
5199 might have had on the next keystroke.
5203 \begin_layout Standard
5204 The following example specifies that the character ' is to be an acute accent,
5205 allowed on the characters a,
5217 \begin_layout LyX-Code
5220 kmod ' acute aeiouAEIOU
5223 \begin_layout Labeling
5224 \labelwidthstring 00.00.0000
5225 \begin_inset Flex Code
5228 \begin_layout Plain Layout
5234 Specify an exception to the accent character
5237 \begin_layout LyX-Code
5246 \begin_layout Standard
5247 This defines an exce
5288 have been assigned a keystroke with a previous
5291 \begin_inset Flex Code
5294 \begin_layout Plain Layout
5318 must not belong in the
5366 If such a declaration does not exist in
5374 \begin_inset Flex Code
5377 \begin_layout Plain Layout
5412 \begin_inset Flex Code
5415 \begin_layout Plain Layout
5429 \begin_layout Standard
5430 The following command produces causes äi to be produced when you enter acute-i ('i):
5433 \begin_layout LyX-Code
5447 \begin_layout Labeling
5448 \labelwidthstring 00.00.0000
5449 \begin_inset Flex Code
5452 \begin_layout Plain Layout
5458 Combine two accent characters
5461 \begin_layout LyX-Code
5467 accent1 accent2 allowed
5470 \begin_layout Standard
5471 This one is getting pretty esoteric.
5472 It allows you to combine the effect
5528 \begin_inset Flex Code
5531 \begin_layout Plain Layout
5559 \begin_layout Standard
5560 Consider this example from the
5561 \begin_inset Flex Code
5564 \begin_layout Plain Layout
5575 \begin_layout LyX-Code
5579 acute aeioyvhAEIOYVH
5584 kcomb acute umlaut iyIY
5587 \begin_layout Standard
5588 This allows you to press
5589 \begin_inset Flex Noun
5592 \begin_layout Plain Layout
5600 and get the effect of
5601 \begin_inset Flex Code
5604 \begin_layout Plain Layout
5623 in this case cancels the last dead key,
5625 \begin_inset Flex Noun
5628 \begin_layout Plain Layout
5638 \begin_inset Flex Code
5641 \begin_layout Plain Layout
5654 \begin_layout Subsection
5658 \begin_layout Standard
5660 \begin_inset Flex Code
5663 \begin_layout Plain Layout
5671 mapping is performed,
5673 \begin_inset Flex Code
5676 \begin_layout Plain Layout
5686 file maps the strings that the symbols generate to characters in the current font.
5687 The \SpecialChar LyX
5688 distribution currently includes at least the
5689 \begin_inset Flex Code
5692 \begin_layout Plain Layout
5701 \begin_inset Flex Code
5704 \begin_layout Plain Layout
5715 \begin_layout Standard
5717 \begin_inset Flex Code
5720 \begin_layout Plain Layout
5728 file is a sequence of declarations of the form
5731 \begin_layout LyX-Code
5744 \begin_layout Standard
5747 \begin_inset Flex Noun
5750 \begin_layout Plain Layout
5760 to the corresponding character in the iso-8859-1 set (233),
5761 the following declaration is used
5764 \begin_layout LyX-Code
5772 \begin_layout Standard
5774 \begin_inset Flex Code
5777 \begin_layout Plain Layout
5786 \begin_inset Flex Code
5789 \begin_layout Plain Layout
5807 the same character can apply to more than one string.
5809 \begin_inset Flex Code
5812 \begin_layout Plain Layout
5823 \begin_layout LyX-Code
5835 \begin_inset Newline newline
5851 \begin_layout Standard
5853 cannot find a mapping for the string produced by the keystroke or a deadkey sequence,
5854 it will check if it looks like an accented char and try to draw an accent over the character on screen.
5857 \begin_layout Subsection
5861 \begin_layout Standard
5862 There is a second way to add support for international characters through so-called dead-keys.
5863 A dead-key works in combination with a letter to produce an accented character.
5865 we'll explain how to create a really simple dead-key to illustrate how they work.
5868 \begin_layout Standard
5869 Suppose you happen to need the circumflex character,
5871 \begin_inset Quotes eld
5875 \begin_inset Quotes erd
5880 \begin_inset Flex Noun
5883 \begin_layout Plain Layout
5890 \begin_inset space ~
5894 \begin_inset Flex Noun
5897 \begin_layout Plain Layout
5903 ] to the \SpecialChar LyX
5905 \begin_inset Flex Code
5908 \begin_layout Plain Layout
5915 \begin_inset Flex Code
5918 \begin_layout Plain Layout
5926 whenever you type the
5927 \begin_inset Flex Noun
5930 \begin_layout Plain Layout
5936 -key followed by a letter,
5937 that letter will have a circumflex accent on it.
5940 \begin_inset Quotes eld
5944 \begin_inset Flex Noun
5947 \begin_layout Plain Layout
5954 \begin_inset Quotes erd
5957 produces the letter:
5959 \begin_inset Quotes eld
5963 \begin_inset Quotes erd
5967 If you tried to type
5968 \begin_inset Quotes eld
5972 \begin_inset Flex Noun
5975 \begin_layout Plain Layout
5982 \begin_inset Quotes erd
5988 will complain with a beep,
5990 \begin_inset Quotes eld
5994 \begin_inset Flex Noun
5997 \begin_layout Plain Layout
6004 \begin_inset Quotes erd
6007 never takes a circumflex accent.
6009 \begin_inset Flex Noun
6012 \begin_layout Plain Layout
6018 after a dead-key produces the bare-accent.
6019 Please note this last point!
6020 If you bind a key to a dead-key,
6021 you'll need to rebind the character on that key to yet another key.
6023 \begin_inset Flex Noun
6026 \begin_layout Plain Layout
6032 to a cedilla is a bad idea,
6033 since you'll only get cedillas instead of commas.
6036 \begin_layout Standard
6037 One common way to bind dead-keys is to use
6038 \begin_inset Flex Noun
6041 \begin_layout Plain Layout
6049 \begin_inset Flex Noun
6052 \begin_layout Plain Layout
6060 \begin_inset Flex Noun
6063 \begin_layout Plain Layout
6069 in combination with an accent,
6071 \begin_inset Quotes eld
6075 \begin_inset Flex Noun
6078 \begin_layout Plain Layout
6085 \begin_inset Quotes erd
6089 \begin_inset Quotes eld
6093 \begin_inset Flex Noun
6096 \begin_layout Plain Layout
6103 \begin_inset Quotes erd
6107 \begin_inset Quotes eld
6111 \begin_inset Flex Noun
6114 \begin_layout Plain Layout
6121 \begin_inset Quotes erd
6125 Another way involves using
6126 \begin_inset Flex Code
6129 \begin_layout Plain Layout
6136 \begin_inset Flex Code
6139 \begin_layout Plain Layout
6145 to set up the special
6146 \begin_inset Flex Code
6149 \begin_layout Plain Layout
6157 \begin_inset Flex Code
6160 \begin_layout Plain Layout
6166 acts in some ways just like
6167 \begin_inset Flex Noun
6170 \begin_layout Plain Layout
6176 and permits you to bind keys to accented characters.
6177 You can also turn keys into dead-keys by binding them to something like
6178 \begin_inset Flex Code
6181 \begin_layout Plain Layout
6187 and then binding this symbolic key to the corresponding \SpecialChar LyX
6192 \begin_layout Plain Layout
6198 This is exactly what I do in my
6199 \begin_inset Flex Code
6202 \begin_layout Plain Layout
6209 \begin_inset Flex Code
6212 \begin_layout Plain Layout
6220 \begin_inset Flex Noun
6223 \begin_layout Plain Layout
6225 \begin_inset space ~
6234 \begin_inset Flex Code
6237 \begin_layout Plain Layout
6243 and a bunch of these
6244 \begin_inset Quotes eld
6248 \begin_inset Flex Code
6251 \begin_layout Plain Layout
6258 \begin_inset Quotes erd
6261 symbolic keys bound such things as
6262 \begin_inset Flex Noun
6265 \begin_layout Plain Layout
6267 \begin_inset space ~
6276 \begin_inset Flex Noun
6279 \begin_layout Plain Layout
6281 \begin_inset space ~
6290 This is how I produce my accented characters.
6295 You can make just about anything into the
6296 \begin_inset Flex Code
6299 \begin_layout Plain Layout
6307 \begin_inset Flex Noun
6310 \begin_layout Plain Layout
6317 a spare function key,
6319 As for the \SpecialChar LyX
6320 commands that produce accents,
6322 \begin_inset Flex Code
6325 \begin_layout Plain Layout
6336 You'll find the complete list there.
6339 \begin_layout Subsection
6340 Saving your Language Configuration
6343 \begin_layout Standard
6344 You can edit your preferences so that your desired language environment is automatically configured when \SpecialChar LyX
6347 \begin_inset Flex Noun
6350 \begin_layout Plain Layout
6351 Edit\SpecialChar menuseparator
6360 \begin_layout Chapter
6362 \change_inserted -584632292 1610232084
6365 Installing New Document Classes,
6368 \begin_inset CommandInset label
6370 name "cha:Installing-New-Document"
6375 \begin_inset Argument 1
6378 \begin_layout Plain Layout
6379 Installing New Document Classes
6387 \begin_layout Standard
6389 we describe the procedures for creating and installing new \SpecialChar LyX
6390 layout and template files,
6391 as well as offer a refresher on correctly installing new \SpecialChar LaTeX
6396 \begin_layout Standard
6398 let us a say a few words about how one ought to think about the relation between \SpecialChar LyX
6399 and \SpecialChar LaTeX
6401 The thing to understand is that,
6404 doesn't know anything about \SpecialChar LaTeX
6407 from \SpecialChar LyX
6410 is just one of several
6411 \begin_inset Quotes eld
6415 \begin_inset Quotes erd
6418 in which it is capable of producing output.
6419 Other such formats are DocBook,
6425 a particularly important format,
6426 but very little of the information \SpecialChar LyX
6427 has about \SpecialChar LaTeX
6428 is actually contained in the program itself.
6432 \begin_layout Plain Layout
6433 Some commands are sufficiently complex that they are
6434 \begin_inset Quotes eld
6438 \begin_inset Quotes erd
6441 into \SpecialChar LyX
6443 But the developers generally regard this as a Bad Thing.
6450 even for the standard classes like
6451 \begin_inset Flex Code
6454 \begin_layout Plain Layout
6461 is contained in `layout files'.
6464 itself does not know much about DocBook or XHTML.
6465 What it knows is contained in layout files.
6468 \begin_layout Standard
6469 You can think of the layout file for a given document class as a translation manual between \SpecialChar LyX
6471 paragraphs with their corresponding styles,
6472 certain sorts of insets,
6474 and the corresponding \SpecialChar LaTeX
6477 or XHTML constructs.
6478 Almost everything \SpecialChar LyX
6480 \begin_inset Flex Code
6483 \begin_layout Plain Layout
6491 is contained in the file
6492 \begin_inset Flex Code
6495 \begin_layout Plain Layout
6501 and in various other files it includes.
6503 anyone intending to write layout files should plan to study the existing files.
6504 A good place to start is with
6505 \begin_inset Flex Code
6508 \begin_layout Plain Layout
6515 which is included in
6516 \begin_inset Flex Code
6519 \begin_layout Plain Layout
6527 \begin_inset Flex Code
6530 \begin_layout Plain Layout
6537 and many of the other layout files for document classes.
6538 This file is where sections and the like are defined:
6540 \begin_inset Flex Code
6543 \begin_layout Plain Layout
6549 tells \SpecialChar LyX
6550 how paragraphs that are marked with the Section,
6553 styles can be translated into corresponding \SpecialChar LaTeX
6556 and XHTML commands and tags.
6558 \begin_inset Flex Code
6561 \begin_layout Plain Layout
6567 file basically just includes several of these
6568 \begin_inset Flex Code
6571 \begin_layout Plain Layout
6580 \begin_layout Standard
6581 Defining the \SpecialChar LyX
6583 correspondence is not the only thing layout files do,
6585 Their other job is to define how the \SpecialChar LyX
6586 constructs themselves will appear on-screen.
6587 The fact that layout files have these two jobs is often a source of confusion,
6588 because they are completely separate.
6589 Telling \SpecialChar LyX
6590 how to translate a certain paragraph style into \SpecialChar LaTeX
6591 does not tell \SpecialChar LyX
6594 telling \SpecialChar LyX
6595 how to display a certain paragraph style does not tell \SpecialChar LyX
6596 how to translate it into \SpecialChar LaTeX
6597 (let alone tell \SpecialChar LaTeX
6601 when you define a new \SpecialChar LyX
6603 you must always do two quite separate things:
6605 \begin_inset space ~
6608 tell \SpecialChar LyX
6609 how to translate it into \SpecialChar LaTeX
6611 \begin_inset space ~
6614 tell \SpecialChar LyX
6618 \begin_layout Standard
6619 Much the same is true,
6621 as regards \SpecialChar LyX
6622 's other backend formats,
6623 though XHTML is in some ways different,
6624 because in that case \SpecialChar LyX
6631 to use information about how it should display a paragraph on the screen to output information (in the form of CSS) about how the paragraph should be displayed in a browser.
6634 the distinction between what \SpecialChar LyX
6635 does internally and how things are rendered externally remains in force,
6636 and the two can be controlled separately.
6638 \begin_inset CommandInset ref
6640 reference "sec:Tags-for-XHTML"
6647 \begin_layout Section
6648 Installing new \SpecialChar LaTeX
6652 \begin_layout Standard
6653 Some installations may not include a \SpecialChar LaTeX
6654 package or class file that you would like to use within \SpecialChar LyX
6657 you might need Foil\SpecialChar TeX
6659 a package for preparing slides for overhead projectors.
6660 Modern \SpecialChar LaTeX
6661 distributions like \SpecialChar TeX
6662 Live (2008 or newer) or MiK\SpecialChar TeX
6663 provide a user interface for installing such packages.
6665 with MiK\SpecialChar TeX
6667 you start the program
6668 \begin_inset Quotes eld
6672 \begin_inset space ~
6676 \begin_inset Quotes erd
6679 to get a list of available packages.
6680 To install one of them,
6681 right click on it or use the corresponding toolbar button.
6684 \begin_layout Standard
6685 If your \SpecialChar LaTeX
6686 distribution does not provide such a `package manager',
6687 or if the package is not available from your distribution,
6688 then follow these steps to install it manually:
6691 \begin_layout Enumerate
6692 Get the package from
6693 \begin_inset CommandInset href
6696 target "http://www.ctan.org/"
6704 \begin_layout Enumerate
6705 If the package contains a file with the ending
6706 \begin_inset Quotes eld
6710 \begin_inset Flex Code
6713 \begin_layout Plain Layout
6720 \begin_inset Quotes erd
6723 (is the case for Foil\SpecialChar TeX
6724 ) then open a console,
6725 change to the folder of this file and execute the command
6726 \begin_inset Flex Code
6729 \begin_layout Plain Layout
6736 You have now unpacked the package and have all files to install it.
6737 Most \SpecialChar LaTeX
6738 -packages are not packed and you can skip this step.
6741 \begin_layout Enumerate
6742 Now you need to decide if the package should be available for all users or only for you.
6746 \begin_layout Enumerate
6747 On *nix systems (Linux,
6750 if you want the new package to be available for all users on your system,
6751 then install it in your `local' \SpecialChar TeX
6753 otherwise install it in your own `user' \SpecialChar TeX
6755 Where these trees should be created,
6756 if they do not already exist,
6757 depends on your system.
6760 \begin_inset Flex Code
6763 \begin_layout Plain Layout
6773 \begin_layout Plain Layout
6774 This is usually in the directory
6775 \begin_inset Flex Code
6778 \begin_layout Plain Layout
6785 though you can execute the command
6786 \begin_inset Flex Code
6789 \begin_layout Plain Layout
6800 The location of the `local' \SpecialChar TeX
6801 tree is defined by the
6802 \begin_inset Flex Code
6805 \begin_layout Plain Layout
6812 this is usually somewhere like
6813 \begin_inset Flex Code
6816 \begin_layout Plain Layout
6817 /usr/local/share/texmf
6822 or /usr/local/texlive/XXXX where XXXX is the year of the installed \SpecialChar TeX
6824 The location of the `user' \SpecialChar TeX
6826 \begin_inset Flex Code
6829 \begin_layout Plain Layout
6836 \begin_inset Flex Code
6839 \begin_layout Plain Layout
6846 \begin_inset Flex Code
6849 \begin_layout Plain Layout
6858 (If these variables are not predefined,
6859 you have to define them.) You'll probably need root permissions to create or modify the `local' tree,
6860 but not for your `user' tree.
6861 \begin_inset Newline newline
6865 it is recommended to install in the user tree because your user will not be modified or even overwritten when you upgrade your system.
6866 It will typically also be backed up together with everything else when you backup your home directory (which,
6868 you do on a regular basis).
6871 \begin_layout Enumerate
6873 if you want the new package to be available for all users on your system,
6874 change to the folder where \SpecialChar LaTeX
6875 is installed and then change to the subfolder
6876 \begin_inset Flex Code
6879 \begin_layout Plain Layout
6890 (For MiK\SpecialChar TeX
6892 this would be by default the folder
6893 \begin_inset Flex Code
6896 \begin_layout Plain Layout
6914 \begin_layout Plain Layout
6915 Note that this will be the correct path only on English installations.
6918 \begin_inset Flex Code
6921 \begin_layout Plain Layout
6936 and similarly for other languages.
6941 Create there a new folder
6942 \begin_inset Flex Code
6945 \begin_layout Plain Layout
6951 and copy all files of the package into it.
6953 \begin_inset Newline newline
6956 If the package should only available for you or you don't have admin permissions,
6958 but in the local \SpecialChar LaTeX
6961 \begin_inset space \thinspace{}
6965 for MiK\SpecialChar TeX
6967 \begin_inset space ~
6970 2.8 under Windows XP,
6971 this would be the folder:
6972 \begin_inset Newline newline
6978 \begin_inset Flex Code
6981 \begin_layout Plain Layout
6984 Documents and Settings
6996 \begin_inset Newline newline
7002 \begin_inset Phantom HPhantom
7005 \begin_layout Plain Layout
7016 \begin_inset Flex Code
7019 \begin_layout Plain Layout
7032 \begin_inset Newline newline
7037 \begin_inset Newline newline
7041 \begin_inset Flex Code
7044 \begin_layout Plain Layout
7070 \begin_layout Enumerate
7071 Now one only need to tell \SpecialChar LaTeX
7072 that there are new files.
7073 This depends on the used \SpecialChar LaTeX
7078 \begin_layout Enumerate
7079 For \SpecialChar TeX
7080 Live execute the command
7081 \begin_inset Flex Code
7084 \begin_layout Plain Layout
7091 If you installed the package for all users,
7092 then you will probably need to have root permissions for that.
7095 \begin_layout Enumerate
7096 For MiK\SpecialChar TeX
7098 if you have installed the package for all users,
7100 \begin_inset Quotes eld
7104 \begin_inset space ~
7108 \begin_inset Quotes erd
7111 and press the button marked
7112 \begin_inset Quotes eld
7116 \begin_inset Quotes erd
7120 Otherwise start the program
7121 \begin_inset Quotes eld
7125 \begin_inset Quotes erd
7132 \begin_layout Enumerate
7134 you need to tell \SpecialChar LyX
7135 that there are new packages available.
7140 \begin_inset Flex Noun
7143 \begin_layout Plain Layout
7146 \SpecialChar menuseparator
7152 and then restart \SpecialChar LyX
7156 \begin_layout Standard
7157 Now the package is installed.
7160 \begin_inset Flex Code
7163 \begin_layout Plain Layout
7169 will now be available under
7170 \begin_inset Flex Noun
7173 \begin_layout Plain Layout
7174 Document\SpecialChar menuseparator
7175 Settings\SpecialChar menuseparator
7182 \begin_inset Quotes eld
7186 \begin_inset Quotes erd
7193 \begin_layout Standard
7194 If you would like to use a \SpecialChar LaTeX
7195 document class that is not even listed in the menu
7196 \begin_inset Flex Noun
7199 \begin_layout Plain Layout
7200 Document\SpecialChar menuseparator
7201 Settings\SpecialChar menuseparator
7208 then you need to create a `layout' file for it.
7209 That is the topic of the next section.
7212 \begin_layout Section
7213 Types of layout files
7216 \begin_layout Standard
7217 This section describes the various sorts of \SpecialChar LyX
7218 files that contain layout information.
7219 These files describe various paragraph and character styles,
7220 determining how \SpecialChar LyX
7221 should display them and how they should be translated into \SpecialChar LaTeX
7225 or whatever output format is being used.
7229 \begin_layout Standard
7230 We shall try to provide a thorough description of the process of writing layout files here.
7232 there are so many different types of documents supported even by just \SpecialChar LaTeX
7233 that we can't hope to cover every different possibility or problem you might encounter.
7234 The \SpecialChar LyX
7235 users' list is frequented by people with lots of experience with layout design who are willing to share what they've learned,
7236 so please feel free to ask questions there.
7239 \begin_layout Standard
7240 As you prepare to write a new layout,
7241 it is extremely helpful to look at the layouts distributed with \SpecialChar LyX
7243 If you write a \SpecialChar LyX
7244 layout for a \SpecialChar LaTeX
7245 document class that might also be used by others,
7246 or write a module that might be useful to others,
7247 then you should consider posting your layout to the
7248 \begin_inset CommandInset href
7250 name "layout section on the LyX wiki"
7251 target "https://wiki.lyx.org/Layouts/Layouts"
7256 or even to the \SpecialChar LyX
7258 so that it might be included in \SpecialChar LyX
7263 \begin_layout Plain Layout
7264 Note that \SpecialChar LyX
7265 is licensed under the General Public License,
7266 so any material that is contributed to \SpecialChar LyX
7267 must be similarly licensed.
7275 \begin_layout Subsection
7277 \begin_inset CommandInset label
7279 name "subsec:Layout-modules"
7286 \begin_layout Standard
7287 We have spoken to this point about `layout files'.
7288 But there are different sorts of files that contain layout information.
7292 \begin_inset Flex Code
7295 \begin_layout Plain Layout
7301 extension and provide \SpecialChar LyX
7302 with information about document classes.
7303 Since \SpecialChar LyX
7304 1.6 layout information can also be contained in layout
7310 \begin_inset Flex Code
7313 \begin_layout Plain Layout
7320 Modules are to \SpecialChar LaTeX
7321 packages much as layouts are to \SpecialChar LaTeX
7325 \begin_inset Flex Code
7328 \begin_layout Plain Layout
7335 specifically provide support for one package.
7337 layout modules are similar to included
7341 \begin_layout Plain Layout
7342 These can have any extension,
7343 but by convention have the
7344 \begin_inset Flex Code
7347 \begin_layout Plain Layout
7360 \begin_inset Flex Code
7363 \begin_layout Plain Layout
7370 in that modules are not specific to a given document class but may be used with many different classes.
7371 The difference is that using an included file with
7372 \begin_inset Flex Code
7375 \begin_layout Plain Layout
7381 requires editing that file.
7385 \begin_inset Flex Noun
7388 \begin_layout Plain Layout
7389 Document\SpecialChar menuseparator
7398 \begin_layout Standard
7399 Building modules is the easiest way to get started with layout editing,
7400 since it can be as simple as adding a single new paragraph style or flex inset.
7403 contain anything a layout file can contain.
7406 \begin_layout Standard
7407 After creating a new module and copying it to the
7408 \begin_inset Flex Code
7411 \begin_layout Plain Layout
7418 you will need to reconfigure and then restart \SpecialChar LyX
7419 for the module to appear in the menu.
7421 changes you make to the module will be seen immediately,
7423 \begin_inset Flex Noun
7426 \begin_layout Plain Layout
7427 Document\SpecialChar menuseparator
7434 highlight something,
7436 \begin_inset Quotes eld
7440 \begin_inset Quotes erd
7446 It is strongly recommended that you save your work before doing this
7452 it is strongly recommended that you not attempt to edit modules while simultaneously working on actual documents
7455 Though of course the developers strive to keep \SpecialChar LyX
7456 stable in such situations,
7457 syntax errors and the like in your module file could cause strange behavior.
7460 \begin_layout Subsubsection
7464 \begin_layout Standard
7465 Modules are to \SpecialChar LyX
7466 as packages are to \SpecialChar LaTeX
7470 you find yourself wanting a specific inset or character style just for one document and writing a module that will also be available to other documents makes little sense.
7471 What you need is \SpecialChar LyX
7473 \begin_inset Quotes eld
7477 \begin_inset Quotes erd
7483 \begin_layout Standard
7484 You will find it under
7486 Document\SpecialChar menuseparator
7487 Settings\SpecialChar menuseparator
7491 The large text box allows you to enter anything that you might enter in a layout file or module.
7492 You can think of a document's local layout,
7494 as a module that belongs just to it.
7498 \begin_inset Flex Code
7501 \begin_layout Plain Layout
7508 Any format is acceptable,
7509 but one would normally use the format current at the time.
7510 (In \SpecialChar LyX
7518 the current layout format is
7527 \begin_layout Standard
7528 When you have entered something in the
7529 \begin_inset Flex Code
7532 \begin_layout Plain Layout
7541 \begin_inset Quotes eld
7545 \begin_inset Quotes erd
7548 button at the bottom.
7549 Clicking this button will cause \SpecialChar LyX
7550 to determine whether what you have entered is valid layout information for the chosen format.
7552 will report the result but,
7554 will not tell you what errors there might have been.
7555 These will be written to the terminal,
7558 is started from a terminal.
7559 You will not be permitted to save your local layout until you have entered something valid.
7562 \begin_layout Standard
7563 The warnings at the end of the previous section apply here,
7565 Do not play with local layout while you are actually working,
7566 especially if you have not saved your document.
7568 using local layout with a test document can be a very convenient way to try out layout ideas,
7569 or even to start developing a module.
7572 \begin_layout Subsection
7574 \begin_inset Flex Noun
7577 \begin_layout Plain Layout
7586 \begin_layout Standard
7587 There are two situations you are likely to encounter when wanting to support a new \SpecialChar LaTeX
7590 \begin_inset Flex Code
7593 \begin_layout Plain Layout
7599 ) files and \SpecialChar LaTeX2e
7601 \begin_inset Flex Code
7604 \begin_layout Plain Layout
7611 Supporting a style file is usually fairly easy.
7612 Supporting a new class file is a bit harder.
7613 We'll discuss the former in this section and the latter in the next.
7615 \change_deleted 5863208 1594239023
7616 Similar remarks apply,
7618 if you want to support a new DocBook DTD.
7623 \begin_layout Standard
7624 The easier case is the one in which your new document class is provided as a style file that is to be used in conjunction with an already supported document class.
7625 For the sake of the example,
7626 we'll assume that the style file is called
7627 \begin_inset Flex Noun
7630 \begin_layout Plain Layout
7636 and that it is meant to be used with
7637 \begin_inset Flex Noun
7640 \begin_layout Plain Layout
7647 which is a standard class.
7651 \begin_layout Standard
7652 Start by copying the existing class's layout file into your local directory:
7656 \begin_layout Plain Layout
7658 which directory is your local directory will vary by platform,
7659 and \SpecialChar LyX
7660 allows you to specify your local directory on startup,
7663 \begin_inset Flex Code
7666 \begin_layout Plain Layout
7680 \begin_layout LyX-Code
7681 cp report.layout ~/.lyx/layouts/myclass.layout
7684 \begin_layout Standard
7686 \begin_inset Flex Code
7689 \begin_layout Plain Layout
7695 and change the line:
7699 \begin_layout LyX-Code
7702 DeclareLaTeXClass{Report (Standard Class)}
7705 \begin_layout Standard
7709 \begin_layout LyX-Code
7712 DeclareLaTeXClass[report,
7713 myclass.sty]{Report (My Class)}
7716 \begin_layout Standard
7720 \begin_layout LyX-Code
7722 \begin_inset Newline newline
7728 \begin_inset Newline newline
7734 \begin_layout Standard
7735 near the top of the file.
7738 \begin_layout Standard
7739 Start \SpecialChar LyX
7741 \begin_inset Flex Noun
7744 \begin_layout Plain Layout
7745 Tools\SpecialChar menuseparator
7752 Then restart \SpecialChar LyX
7753 and try creating a new document.
7755 \begin_inset Flex Noun
7758 \begin_layout Plain Layout
7764 " as a document class option in the
7765 \begin_inset Flex Noun
7768 \begin_layout Plain Layout
7769 Document\SpecialChar menuseparator
7776 It is likely that some of the sectioning commands and such in your new class will work differently from how they worked in the base class—
7778 \begin_inset Flex Code
7781 \begin_layout Plain Layout
7788 so you can fiddle around with the settings for the different sections if you wish.
7789 The layout information for sections is contained in
7790 \begin_inset Flex Code
7793 \begin_layout Plain Layout
7800 but you do not need to copy and change this file.
7802 you can simply add your changes to your layout file,
7804 \begin_inset Flex Code
7807 \begin_layout Plain Layout
7814 which itself includes
7815 \begin_inset Flex Code
7818 \begin_layout Plain Layout
7826 you might add these lines:
7829 \begin_layout LyX-Code
7833 \begin_layout LyX-Code
7837 \begin_layout LyX-Code
7841 \begin_layout LyX-Code
7845 \begin_layout LyX-Code
7849 \begin_layout Standard
7850 to change the font for chapter headings to sans-serif.
7851 This will override (or,
7853 add to) the existing declaration for the Chapter style.
7857 \begin_layout Standard
7858 Your new package may also provide commands or environments not present in the base class.
7860 you will want to add these to the layout file.
7862 \begin_inset CommandInset ref
7864 reference "sec:TextClass"
7868 for information on how to do so.
7871 \begin_layout Standard
7873 \begin_inset Flex Noun
7876 \begin_layout Plain Layout
7882 can be used with several different document classes,
7883 and even if it cannot,
7884 you might find it easiest just to write a module that you can load with the base class.
7885 The simplest possible such module would be:
7888 \begin_layout LyX-Code
7891 DeclareLyXModule{My Class}
7894 \begin_layout LyX-Code
7898 \begin_layout LyX-Code
7899 #Support for myclass.sty.
7902 \begin_layout LyX-Code
7904 \begin_inset Newline newline
7910 \begin_layout LyX-Code
7918 \begin_inset Newline newline
7924 \begin_layout LyX-Code
7926 \begin_inset Newline newline
7932 \begin_inset Newline newline
7938 \begin_layout Standard
7939 A more complex module might modify the behavior of some existing constructs or define some new ones.
7942 \begin_inset CommandInset ref
7944 reference "sec:TextClass"
7951 \begin_layout Subsection
7953 \begin_inset Flex Noun
7956 \begin_layout Plain Layout
7965 \begin_layout Standard
7966 There are two possibilities here.
7967 One is that the class file is itself based upon an existing document class.
7969 many thesis classes are based upon
7970 \begin_inset Flex Noun
7973 \begin_layout Plain Layout
7980 To see whether yours is,
7981 look for a line like
7984 \begin_layout LyX-Code
7990 \begin_layout Standard
7993 then you may proceed largely as in the previous section,
7995 \begin_inset Flex Code
7998 \begin_layout Plain Layout
7999 Declare\SpecialChar LaTeX
8005 line will be different.
8006 If your new class is
8007 \begin_inset Flex Code
8010 \begin_layout Plain Layout
8016 and it is based upon
8017 \begin_inset Flex Code
8020 \begin_layout Plain Layout
8027 then the line should read:
8031 \begin_layout Plain Layout
8032 And it will be easiest if you save the file to
8033 \begin_inset Flex Code
8036 \begin_layout Plain Layout
8044 assumes that the document class has the same name as the layout file.
8053 \begin_layout LyX-Code
8056 DeclareLaTeXClass[thesis,book]{thesis}
8059 \begin_layout Standard
8062 the new class is not based upon an existing class,
8063 you will probably have to
8064 \begin_inset Quotes eld
8068 \begin_inset Quotes erd
8072 We strongly suggest copying an existing layout file which uses a similar \SpecialChar LaTeX
8073 class and then modifying it,
8075 At least use an existing file as a starting point so you can find out what items you need to worry about.
8077 the specifics are covered below.
8080 \begin_layout Subsection
8082 \begin_inset CommandInset label
8084 name "subsec:Creating-Templates"
8091 \begin_layout Standard
8092 Once you have written a layout file for a new document class,
8093 you might want to consider writing a
8099 A template acts as a kind of tutorial for your layout,
8100 showing how it might be used,
8101 though containing dummy content.
8102 You can of course look at the various templates included with \SpecialChar LyX
8106 \begin_layout Standard
8107 Templates are created just like usual documents:
8108 using \SpecialChar LyX
8110 The only difference is that usual documents contain all possible settings,
8111 including the font scheme and the paper size.
8112 Usually a user doesn't want a template to overwrite his preferred settings for such parameters.
8114 the designer of a template should remove the corresponding commands like
8115 \begin_inset Flex Code
8118 \begin_layout Plain Layout
8127 \begin_inset Flex Code
8130 \begin_layout Plain Layout
8138 from the template \SpecialChar LyX
8140 This can be done with any simple text-editor,
8142 \begin_inset Flex Code
8145 \begin_layout Plain Layout
8152 \begin_inset Flex Code
8155 \begin_layout Plain Layout
8164 \begin_layout Standard
8165 Put the edited template files you create in
8166 \begin_inset Flex Code
8169 \begin_layout Plain Layout
8176 copy the ones you use from the global template directory in
8177 \begin_inset Flex Code
8180 \begin_layout Plain Layout
8187 and redefine the template path in the
8188 \begin_inset Flex Noun
8191 \begin_layout Plain Layout
8192 Tools\SpecialChar menuseparator
8193 Preferences\SpecialChar menuseparator
8202 \begin_layout Standard
8205 that there is a template which has a particular meaning:
8206 \begin_inset Newline linebreak
8210 \begin_inset Flex Code
8213 \begin_layout Plain Layout
8220 This template is loaded every time you create a new document with
8221 \begin_inset Flex Noun
8224 \begin_layout Plain Layout
8225 File\SpecialChar menuseparator
8231 in order to provide useful defaults.
8232 To create this template from inside \SpecialChar LyX
8234 all you have to do is to open a document with the correct settings,
8236 \begin_inset Flex Noun
8239 \begin_layout Plain Layout
8240 Save as Document Defaults
8248 \begin_layout Subsection
8249 Upgrading old layout files
8252 \begin_layout Standard
8253 The format of layout files changes with each \SpecialChar LyX
8255 so old layout files need to be converted to the new format.
8257 reads a layout file in an older format,
8258 it automatically calls the script
8259 \begin_inset Flex Code
8262 \begin_layout Plain Layout
8268 to convert it to a temporary file in current format.
8269 The original file is left untouched.
8270 If you use the layout file often,
8272 you may want to convert it permanently,
8273 so that \SpecialChar LyX
8274 does not have to do so itself every time.
8276 you can call the converter manually:
8279 \begin_layout Enumerate
8281 \begin_inset Flex Code
8284 \begin_layout Plain Layout
8291 \begin_inset Flex Code
8294 \begin_layout Plain Layout
8303 \begin_layout Enumerate
8305 \begin_inset Newline newline
8309 \begin_inset Flex Code
8312 \begin_layout Plain Layout
8313 python LyXDir/scripts/layout2layout.py myclass.old myclass.layout
8319 \begin_inset Newline newline
8323 \begin_inset Flex Code
8326 \begin_layout Plain Layout
8332 is the name of your \SpecialChar LyX
8336 \begin_layout Standard
8337 Note that manual conversion does not affect included files,
8338 so these will have to be converted separately.
8341 \begin_layout Subsection
8342 \begin_inset CommandInset label
8344 name "subsec:Cite-Engine-Files"
8351 \begin_layout Standard
8352 A specific form of layout files are the so-called
8353 \begin_inset Flex Code
8356 \begin_layout Plain Layout
8362 files that are located in the
8363 \begin_inset Flex Code
8366 \begin_layout Plain Layout
8373 Their purpose is to define the specifics of \SpecialChar LaTeX
8374 packages aimed at bibliography generation,
8389 but also the way how normal Bib\SpecialChar TeX
8390 citations (without additional packages) are handled in \SpecialChar LyX
8391 is defined in such a file.
8395 \begin_layout Standard
8397 it is defined which packages \SpecialChar LyX
8399 which citation commands are available,
8400 how these are to be displayed in \SpecialChar LyX
8403 the context menus) as well as in the XHTML and plain text output.
8405 the files specify available style variants (author-year,
8407 etc.) and their specifics.
8408 The cite engine files are also used to generate the options that are available in
8410 Document\SpecialChar menuseparator
8411 Settings\SpecialChar menuseparator
8412 Bibliography\SpecialChar menuseparator
8418 \begin_layout Standard
8419 Even though a cite engine file is essentially a normal layout file that could theoretically include any layout information,
8420 it usually primarily includes some specific parameters such as
8421 \begin_inset Flex Code
8424 \begin_layout Plain Layout
8432 \begin_inset Flex Code
8435 \begin_layout Plain Layout
8443 \begin_inset Flex Code
8446 \begin_layout Plain Layout
8453 \begin_inset Flex Code
8456 \begin_layout Plain Layout
8463 The syntax of the latter two is described in
8464 \begin_inset CommandInset ref
8466 reference "subsec:Citation-engine-description"
8474 \begin_inset CommandInset ref
8476 reference "subsec:Citation-format-description"
8481 as well as in the files themselves.
8484 \begin_layout Section
8485 \begin_inset CommandInset label
8487 name "sec:TextClass"
8491 The layout file format
8494 \begin_layout Standard
8495 The following sections describe how layout files are structured and written.
8496 Our advice is to go slowly,
8497 save and test often.
8498 It is really not that hard,
8499 except that the multitude of options can become overwhelming,
8500 especially if you try to check out too many at once.
8501 It becomes easier if you use existing layouts of \SpecialChar LyX
8502 as examples/reference or if you modify an existing layout to your needs.
8505 \begin_layout Standard
8506 Note that all the tags used in layout files are case-insensitive.
8508 \begin_inset Flex Code
8511 \begin_layout Plain Layout
8519 \begin_inset Flex Code
8522 \begin_layout Plain Layout
8529 \begin_inset Flex Code
8532 \begin_layout Plain Layout
8538 are really the same tag.
8539 The possible arguments are printed in brackets after the tag's name.
8540 The default argument is typeset
8541 \begin_inset Flex Code
8544 \begin_layout Plain Layout
8553 If the argument has a data type like
8554 \begin_inset Quotes eld
8558 \begin_inset Quotes erd
8562 \begin_inset Quotes eld
8566 \begin_inset Quotes erd
8570 the default is shown like this:
8572 \begin_inset Flex Code
8575 \begin_layout Plain Layout
8586 \begin_layout Subsection
8587 The document class declaration and classification
8590 \begin_layout Standard
8591 Lines in a layout file which begin with
8592 \begin_inset Flex Code
8595 \begin_layout Plain Layout
8602 There is one exception to this rule.
8604 \begin_inset Flex Code
8607 \begin_layout Plain Layout
8613 files should begin with lines like:
8616 \begin_layout LyX-Code
8619 #% Do not delete the line below;
8620 configure depends on this
8623 \begin_layout LyX-Code
8628 DeclareLaTeXClass{Article (Standard Class)}
8631 \begin_layout LyX-Code
8636 DeclareCategory{Articles}
8639 \begin_layout Standard
8640 The second and third lines are used when you (re)configure \SpecialChar LyX
8642 The layout file is read by the \SpecialChar LaTeX
8644 \begin_inset Flex Code
8647 \begin_layout Plain Layout
8654 in a special mode where
8655 \begin_inset Flex Code
8658 \begin_layout Plain Layout
8665 The first line is just a \SpecialChar LaTeX
8667 the second one contains the mandatory declaration of the text class and the third line contains the optional classification of the class.
8668 If these lines appear in a file named
8669 \begin_inset Flex Code
8672 \begin_layout Plain Layout
8679 then they define a text class of name
8680 \begin_inset Flex Code
8683 \begin_layout Plain Layout
8689 (the name of the layout file) which uses the \SpecialChar LaTeX
8691 \begin_inset Flex Code
8694 \begin_layout Plain Layout
8700 (the default is to use the same name as the layout).
8702 \begin_inset Quotes eld
8705 Article (Standard Class)
8706 \begin_inset Quotes erd
8709 that appears above is used as a description of the text class in the
8710 \begin_inset Flex Noun
8713 \begin_layout Plain Layout
8714 Document\SpecialChar menuseparator
8722 \begin_inset Quotes eld
8726 \begin_inset Quotes erd
8729 in the example) is also used in the
8730 \begin_inset Flex Noun
8733 \begin_layout Plain Layout
8734 Document\SpecialChar menuseparator
8741 the text classes are grouped by these categories (which are usually genres,
8742 so typical categories are
8743 \begin_inset Quotes eld
8747 \begin_inset Quotes erd
8752 \begin_inset Quotes eld
8756 \begin_inset Quotes erd
8761 \begin_inset Quotes eld
8765 \begin_inset Quotes erd
8770 \begin_inset Quotes eld
8774 \begin_inset Quotes erd
8779 \begin_inset Quotes eld
8783 \begin_inset Quotes erd
8788 \begin_inset Quotes eld
8792 \begin_inset Quotes erd
8796 If no category has been declared,
8797 the class will be put in the
8798 \begin_inset Quotes eld
8802 \begin_inset Quotes erd
8808 \begin_layout Standard
8809 Let's assume that you wrote your own text class that uses the
8810 \begin_inset Flex Code
8813 \begin_layout Plain Layout
8820 but where you changed the appearance of the section headings.
8821 If you put it in a file
8822 \begin_inset Flex Code
8825 \begin_layout Plain Layout
8832 the header of this file should be:
8835 \begin_layout LyX-Code
8838 #% Do not delete the line below;
8839 configure depends on this
8842 \begin_layout LyX-Code
8847 DeclareLaTeXClass[article]{Article (with My Own Headings)}
8850 \begin_layout LyX-Code
8855 DeclareCategory{Articles}
8858 \begin_layout Standard
8859 This declares a text class
8860 \begin_inset Flex Code
8863 \begin_layout Plain Layout
8870 associated with the \SpecialChar LaTeX
8872 \begin_inset Flex Code
8875 \begin_layout Plain Layout
8882 \begin_inset Quotes eld
8885 Article (with My Own Headings)
8886 \begin_inset Quotes erd
8890 If your text class depends on several packages,
8891 you can declare it as:
8894 \begin_layout LyX-Code
8897 #% Do not delete the line below;
8898 configure depends on this
8901 \begin_layout LyX-Code
8906 DeclareLaTeXClass[article,foo.sty]{Article (with My Own Headings)}
8909 \begin_layout LyX-Code
8914 DeclareCategory{Articles}
8917 \begin_layout Standard
8918 This indicates that your text class uses the
8919 \begin_inset Flex Code
8922 \begin_layout Plain Layout
8930 \change_deleted 5863208 1594239179
8932 it is also possible to declare classes for DocBook code.
8933 Typical declarations will look like:
8936 \begin_layout LyX-Code
8938 \change_deleted 5863208 1594239179
8941 #% Do not delete the line below;
8942 configure depends on this
8945 \begin_layout LyX-Code
8947 \change_deleted 5863208 1594239179
8952 DeclareDocBookClass[article]{SGML (DocBook Article)}
8955 \begin_layout LyX-Code
8957 \change_deleted 5863208 1594239179
8962 DeclareCategory{Articles (DocBook)}
8967 \begin_layout Standard
8968 Note that these declarations can also be given an optional parameter declaring the name of the document class (but not a list).
8971 \begin_layout Standard
8973 to be as explicit as possible,
8974 the form of the layout declaration is:
8977 \begin_layout LyX-Code
8982 DeclareLaTeXClass[class,package.sty]{layout description}
8985 \begin_layout LyX-Code
8990 DeclareCategory{category}
8993 \begin_layout Standard
8994 The class need only be specified if the name of the \SpecialChar LaTeX
8995 class file and the name of the layout file are different or if there are packages to load.
8996 If the name of the class file is not specified,
8997 then \SpecialChar LyX
8998 will simply assume that it is the same as the name of the layout file.
9001 \begin_layout Standard
9002 When the text class has been modified to your taste,
9003 all you have to do is to copy it either to
9004 \begin_inset Flex Code
9007 \begin_layout Plain Layout
9014 \begin_inset Flex Code
9017 \begin_layout Plain Layout
9025 \begin_inset Flex Noun
9028 \begin_layout Plain Layout
9029 Tools\SpecialChar menuseparator
9036 exit \SpecialChar LyX
9038 Then your new text class should be available along with the others.
9041 \begin_layout Standard
9042 Once the layout file is installed,
9043 you can edit it and see your changes without having to reconfigure or to restart \SpecialChar LyX
9048 \begin_layout Plain Layout
9049 In versions of \SpecialChar LyX
9053 editing layout files was very time consuming,
9054 since you had constantly to restart \SpecialChar LyX
9060 You can force a reload of the current layout by using the \SpecialChar LyX
9062 \begin_inset Flex Noun
9065 \begin_layout Plain Layout
9072 There is no default binding for this function—
9075 you can bind it to a key yourself.
9076 But you will normally use this function simply by entering it in the mini-buffer.
9080 \begin_layout Standard
9087 \begin_inset Flex Noun
9090 \begin_layout Plain Layout
9096 is very much an `advanced feature'.
9101 recommended that you save your work before using this function.
9107 recommended that you not attempt to edit layout information while simultaneously working on a document that you care about.
9108 Use a test document.
9109 Syntax errors and the like in your layout file could cause peculiar behavior.
9111 such errors could cause \SpecialChar LyX
9112 to regard the current layout as invalid and to attempt to switch to some other layout.
9116 \begin_layout Plain Layout
9117 Really bad syntax errors may even caused \SpecialChar LyX
9119 This is because certain sorts of errors may make \SpecialChar LyX
9130 The \SpecialChar LyX
9131 team strives to keep \SpecialChar LyX
9132 stable in such situations,
9133 but safe is better than sorry.
9137 \begin_layout Plain Layout
9138 While we're giving advice:
9139 make regular backups.
9140 And be nice to your mother.
9148 \begin_layout Subsection
9149 The Module declaration
9152 \begin_layout Standard
9153 A module must begin with a line like the following:
9156 \begin_layout LyX-Code
9159 DeclareLyXModule[endnotes.sty]{Endnotes}
9160 \change_inserted -712698321 1554395911
9164 \begin_layout LyX-Code
9166 \change_inserted -712698321 1554395924
9171 DeclareCategory{Foot- and Endnotes}
9172 \change_deleted -712698321 1554395911
9180 \begin_layout Standard
9181 The mandatory argument
9182 \change_inserted -712698321 1554395956
9193 is the name of the module,
9194 as it should appear in
9195 \begin_inset Flex Noun
9198 \begin_layout Plain Layout
9199 Document\SpecialChar menuseparator
9200 Settings\SpecialChar menuseparator
9207 The argument in square brackets is optional:
9208 It declares any \SpecialChar LaTeX
9209 packages on which the module depends.
9210 It is also possible to use the form
9211 \begin_inset Flex Noun
9214 \begin_layout Plain Layout
9220 as an optional argument,
9221 which declares that the module can only be used when there exists a conversion chain between the formats `
9222 \begin_inset Flex Code
9225 \begin_layout Plain Layout
9232 \begin_inset Flex Code
9235 \begin_layout Plain Layout
9243 \change_inserted -712698321 1554396133
9250 declaration is not strictly mandatory,
9251 but you should add it,
9252 since it is helpful to find the module.
9253 Please have a look at the existing module categories and if appropriate,
9259 \begin_layout Standard
9261 \change_inserted -712698321 1554395988
9264 declaration should then be followed by lines like the following:
9268 \begin_layout Plain Layout
9269 Preferably in English if the module should be published with \SpecialChar LyX
9271 This description will appear in the list of messages to be translated and will be thus translated with the next interface update.
9279 \begin_layout LyX-Code
9283 \begin_layout LyX-Code
9284 #Adds an endnote command,
9285 in addition to footnotes.
9289 \begin_layout LyX-Code
9290 #You will need to add
9292 theendnotes in TeX code where you
9295 \begin_layout LyX-Code
9296 #want the endnotes to appear.
9300 \begin_layout LyX-Code
9304 \begin_layout LyX-Code
9306 somemodule | othermodule
9309 \begin_layout LyX-Code
9314 \begin_layout Standard
9315 The description is used in
9316 \begin_inset Flex Noun
9319 \begin_layout Plain Layout
9320 Document\SpecialChar menuseparator
9321 Settings\SpecialChar menuseparator
9327 to provide the user with information about what the module does.
9329 \begin_inset Flex Code
9332 \begin_layout Plain Layout
9338 line is used to identify other modules with which this one must be used;
9340 \begin_inset Flex Code
9343 \begin_layout Plain Layout
9349 line is used to identify modules with which this one may not be used.
9353 multiple modules should be separated with the pipe symbol:
9355 Note that the required modules are treated disjunctively:
9360 of the required modules must be used.
9366 excluded module may be used.
9367 Note that modules are identified here by their filenames without the
9368 \begin_inset Flex Code
9371 \begin_layout Plain Layout
9379 \begin_inset Flex Code
9382 \begin_layout Plain Layout
9389 \begin_inset Flex Code
9392 \begin_layout Plain Layout
9401 \begin_layout Subsection
9402 The CiteEngine file declaration
9405 \begin_layout Standard
9406 A cite engine file must begin with a line like the following:
9409 \begin_layout LyX-Code
9412 DeclareLyXCiteEngineModule[biblatex.sty]{Biblatex}
9415 \begin_layout Standard
9416 The mandatory argument,
9418 is the name of the cite style,
9419 as it should appear in
9420 \begin_inset Flex Noun
9423 \begin_layout Plain Layout
9424 Document\SpecialChar menuseparator
9425 Settings\SpecialChar menuseparator
9432 The argument in square brackets is optional:
9433 It declares any \SpecialChar LaTeX
9434 packages on which the cite engine depends.
9437 \begin_layout Standard
9438 The cite engine declaration should then be followed by lines like the following:
9442 \begin_layout Plain Layout
9443 Preferably in English if the module should be published with \SpecialChar LyX
9445 This description will appear in the list of messages to be translated and will be thus translated with the next interface update.
9453 \begin_layout LyX-Code
9457 \begin_layout LyX-Code
9458 # Biblatex supports many author-year and numerical styles.
9461 \begin_layout LyX-Code
9462 # It is mainly aimed at the Humanities.
9466 \begin_layout LyX-Code
9468 fully localized and provides many features
9471 \begin_layout LyX-Code
9472 # that are not possible with BibTeX.
9473 The use of 'biber' as
9476 \begin_layout LyX-Code
9477 # bibliography processor is advised.
9480 \begin_layout LyX-Code
9484 \begin_layout Standard
9485 The description is used in
9486 \begin_inset Flex Noun
9489 \begin_layout Plain Layout
9490 Document\SpecialChar menuseparator
9491 Settings\SpecialChar menuseparator
9497 to provide the user with information about the cite engine.
9500 \begin_layout Subsection
9504 \begin_layout Standard
9505 The first non-comment line of any layout file,
9511 contain the file format number:
9514 \begin_layout Description
9515 \begin_inset Flex Code
9518 \begin_layout Plain Layout
9525 \begin_inset Flex Code
9528 \begin_layout Plain Layout
9534 ] The format number of the layout file.
9537 \begin_layout Standard
9538 This tag was introduced with \SpecialChar LyX
9540 \begin_inset space ~
9544 Layout files from older \SpecialChar LyX
9545 versions do not have an explicit file format and are considered to have
9546 \begin_inset Flex Code
9549 \begin_layout Plain Layout
9551 \begin_inset space ~
9560 The format for the present version of \SpecialChar LyX
9562 But each version of \SpecialChar LyX
9563 is capable of reading earlier versions' layout files,
9564 just as they are capable of reading files produced by earlier versions of \SpecialChar LyX
9568 no provision for converting to earlier formats.
9571 \begin_layout Subsection
9572 \begin_inset CommandInset label
9574 name "subsec:General-text-class"
9578 General text class parameters
9581 \begin_layout Standard
9582 These are general parameters that govern the behavior of an entire document class.
9587 mean that they must appear in
9588 \begin_inset Flex Code
9591 \begin_layout Plain Layout
9597 files rather than in modules.
9598 A module can contain any layout tag.)
9601 \begin_layout Description
9603 \change_inserted -712698321 1526899478
9604 \begin_inset Flex Code
9607 \begin_layout Plain Layout
9609 \change_inserted -712698321 1526898610
9610 AddToCiteEngine <engine>
9617 Extends the possibilities for displaying citation references.
9619 \begin_inset CommandInset ref
9621 reference "subsec:Citation-engine-description"
9630 \begin_inset Flex Code
9633 \begin_layout Plain Layout
9635 \change_inserted -712698321 1526898823
9646 \begin_layout Description
9647 \begin_inset Flex Code
9650 \begin_layout Plain Layout
9656 Adds information that will be output in the
9657 \begin_inset Flex Code
9660 \begin_layout Plain Layout
9666 block when the document is output to XHTML.
9668 this would be used to output CSS style information,
9669 but it can be used for anything that can appear in
9670 \begin_inset Flex Code
9673 \begin_layout Plain Layout
9681 \begin_inset Quotes eld
9685 \begin_inset Flex Code
9688 \begin_layout Plain Layout
9695 \begin_inset Quotes erd
9701 \begin_layout Description
9702 \begin_inset Flex Code
9705 \begin_layout Plain Layout
9711 Adds information to the document preamble.
9713 \begin_inset Newline newline
9717 \begin_inset Quotes eld
9721 \begin_inset Flex Code
9724 \begin_layout Plain Layout
9731 \begin_inset Quotes erd
9735 \change_inserted -712698321 1562592950
9739 \begin_layout Description
9741 \change_inserted -712698321 1562593040
9742 \begin_inset Flex Code
9745 \begin_layout Plain Layout
9747 \change_inserted -712698321 1562592954
9756 \begin_inset Flex Code
9759 \begin_layout Plain Layout
9761 \change_inserted -712698321 1562592950
9772 \begin_inset space \thinspace{}
9776 \begin_inset Flex Code
9779 \begin_layout Plain Layout
9781 \change_inserted -712698321 1562592950
9789 ] If the document class adds the bibliography to the table of contents,
9790 add this option with value
9791 \begin_inset Flex Code
9794 \begin_layout Plain Layout
9796 \change_inserted -712698321 1562592996
9805 \begin_inset Flex Code
9808 \begin_layout Plain Layout
9810 \change_inserted -712698321 1562593006
9819 This prevents the bibliography from being added twice.
9824 \begin_layout Description
9825 \begin_inset Flex Code
9828 \begin_layout Plain Layout
9834 Defines the possibilities for displaying citation references.
9836 \begin_inset CommandInset ref
9838 reference "subsec:Citation-engine-description"
9847 \begin_inset Quotes eld
9851 \begin_inset Flex Code
9854 \begin_layout Plain Layout
9861 \begin_inset Quotes erd
9865 Primarily used in cite engine files (see
9866 \begin_inset CommandInset ref
9868 reference "subsec:Cite-Engine-Files"
9877 \change_inserted -712698321 1526898530
9878 Note that if you specify this in a layout file or module,
9879 any cite engine definition will be overridden.
9881 \begin_inset Flex Code
9884 \begin_layout Plain Layout
9886 \change_inserted -712698321 1526898530
9899 \begin_layout Description
9900 \begin_inset Flex Code
9903 \begin_layout Plain Layout
9909 Defines formats for use in the display of bibliographic information.
9911 \begin_inset CommandInset ref
9913 reference "subsec:Citation-format-description"
9919 \begin_inset Quotes eld
9923 \begin_inset Flex Code
9926 \begin_layout Plain Layout
9933 \begin_inset Quotes erd
9937 Primarily used in cite engine files (see
9938 \begin_inset CommandInset ref
9940 reference "subsec:Cite-Engine-Files"
9949 \change_inserted -712698321 1526898585
9950 A cite format defined in a layout or module will override the cite engine definition.
9955 \begin_layout Description
9956 \begin_inset Flex Code
9959 \begin_layout Plain Layout
9966 \begin_inset Flex Code
9969 \begin_layout Plain Layout
9978 \begin_inset Flex Code
9981 \begin_layout Plain Layout
9987 ] Determines whether
9991 or Bib\SpecialChar TeX
9992 is used to generate a Bibliography.
9993 Primarily used in cite engine files (see
9994 \begin_inset CommandInset ref
9996 reference "subsec:Cite-Engine-Files"
10006 \begin_layout Description
10007 \begin_inset Flex Code
10010 \begin_layout Plain Layout
10016 Describes various global options supported by the document class.
10018 \begin_inset CommandInset ref
10020 reference "subsec:ClassOptions"
10026 \begin_inset Quotes eld
10030 \begin_inset Flex Code
10033 \begin_layout Plain Layout
10040 \begin_inset Quotes erd
10046 \begin_layout Description
10047 \begin_inset Flex Code
10050 \begin_layout Plain Layout
10057 \begin_inset Flex Code
10060 \begin_layout Plain Layout
10069 \begin_inset space \thinspace{}
10073 \begin_inset Flex Code
10076 \begin_layout Plain Layout
10082 ] Whether the class should
10086 to having one or two columns.
10087 Can be changed in the
10088 \begin_inset Flex Noun
10091 \begin_layout Plain Layout
10092 Document\SpecialChar menuseparator
10101 \begin_layout Description
10102 \begin_inset Flex Code
10105 \begin_layout Plain Layout
10112 \begin_inset Flex Code
10115 \begin_layout Plain Layout
10121 ] This sequence defines the properties for a counter.
10122 If the counter does not yet exist,
10127 \begin_inset Quotes eld
10131 \begin_inset Flex Code
10134 \begin_layout Plain Layout
10141 \begin_inset Quotes erd
10145 \begin_inset Newline newline
10149 \begin_inset CommandInset ref
10151 reference "subsec:Counters"
10155 for details on counters.
10158 \begin_layout Description
10159 \begin_inset Flex Code
10162 \begin_layout Plain Layout
10168 Sets the default font used to display the document.
10170 \begin_inset CommandInset ref
10172 reference "subsec:Font-description"
10176 for how to declare fonts.
10178 \begin_inset Quotes eld
10182 \begin_inset Flex Code
10185 \begin_layout Plain Layout
10192 \begin_inset Quotes erd
10198 \begin_layout Description
10199 \begin_inset Flex Code
10202 \begin_layout Plain Layout
10209 \begin_inset Flex Code
10212 \begin_layout Plain Layout
10218 ] Specifies a module to be included by default with this document class.
10219 The module is specified as filename without the
10220 \begin_inset Flex Code
10223 \begin_layout Plain Layout
10230 The user can still remove the module,
10231 but it will be active at the outset.
10232 (This applies only when new files are created,
10233 or when this class is chosen for an existing document.)
10236 \begin_layout Description
10237 \begin_inset Flex Code
10240 \begin_layout Plain Layout
10247 \begin_inset Flex Code
10250 \begin_layout Plain Layout
10256 ] This is the style that will be assigned to new paragraphs,
10258 \begin_inset Flex Noun
10261 \begin_layout Plain Layout
10268 This will default to the first defined style if not given,
10269 but you are encouraged to use this directive.
10272 \begin_layout Description
10274 \change_inserted -970929547 1515112870
10275 \begin_inset Flex Code
10278 \begin_layout Plain Layout
10280 \change_inserted -970929547 1515112782
10289 \begin_inset Flex Code
10292 \begin_layout Plain Layout
10294 \change_inserted -970929547 1515112766
10302 ] The root element (at the top of the document) to use when outputting documents with this class in DocBook.
10303 The default value is
10304 \begin_inset Quotes eld
10308 \begin_inset Flex Code
10311 \begin_layout Plain Layout
10313 \change_inserted -970929547 1515112845
10322 \begin_inset Quotes erd
10327 \change_deleted 1075283030 1594226862
10329 \change_inserted 1075283030 1594226777
10333 \begin_layout Description
10335 \change_inserted 1075283030 1594226859
10336 \begin_inset Flex Code
10339 \begin_layout Plain Layout
10341 \change_inserted 1075283030 1594226785
10342 DocBookForceAbstract
10350 \begin_inset Flex Code
10353 \begin_layout Plain Layout
10355 \change_inserted 1075283030 1594226804
10364 \begin_inset Quotes eld
10372 \begin_inset Quotes erd
10376 the root element will always have an
10381 The default value is
10382 \begin_inset Quotes eld
10390 \begin_inset Quotes erd
10398 \begin_layout Description
10399 \begin_inset Flex Code
10402 \begin_layout Plain Layout
10409 \begin_inset Flex Code
10412 \begin_layout Plain Layout
10418 ] This tag indicates that the module (which is specified by filename without the
10419 \begin_inset Flex Code
10422 \begin_layout Plain Layout
10428 extension) cannot be used with this document class.
10429 This might be used in a journal-specific layout file to prevent,
10432 \begin_inset Flex Code
10435 \begin_layout Plain Layout
10441 module that numbers theorems by section.
10446 be used in a module.
10447 Modules have their own way of excluding other modules (see
10448 \begin_inset CommandInset ref
10450 reference "subsec:Layout-modules"
10457 \begin_layout Description
10458 \begin_inset Flex Code
10461 \begin_layout Plain Layout
10467 Defines a new float.
10469 \begin_inset CommandInset ref
10471 reference "subsec:Floats"
10477 \begin_inset Quotes eld
10481 \begin_inset Flex Code
10484 \begin_layout Plain Layout
10491 \begin_inset Quotes erd
10497 \begin_layout Description
10498 \begin_inset Flex Code
10501 \begin_layout Plain Layout
10507 Sets the information that will be output in the
10508 \begin_inset Flex Code
10511 \begin_layout Plain Layout
10517 block when this document class is output to XHTML.
10518 Note that this will completely override any prior
10519 \begin_inset Flex Code
10522 \begin_layout Plain Layout
10529 \begin_inset Flex Code
10532 \begin_layout Plain Layout
10540 \begin_inset Newline newline
10544 \begin_inset Flex Code
10547 \begin_layout Plain Layout
10553 if you just want to add material to the preamble.) Must end with
10554 \begin_inset Quotes eld
10558 \begin_inset Flex Code
10561 \begin_layout Plain Layout
10568 \begin_inset Quotes erd
10574 \begin_layout Description
10575 \begin_inset Flex Code
10578 \begin_layout Plain Layout
10585 \begin_inset Flex Code
10588 \begin_layout Plain Layout
10594 ] The style to use for the table of contents,
10597 when the document is output to HTML.
10599 this should normally be
10600 \begin_inset Flex Code
10603 \begin_layout Plain Layout
10611 \begin_inset Flex Code
10614 \begin_layout Plain Layout
10621 If it is not given,
10622 then \SpecialChar LyX
10623 will attempt to figure out which layout to use.
10626 \begin_layout Description
10627 \begin_inset Flex Code
10630 \begin_layout Plain Layout
10637 \begin_inset Flex Code
10640 \begin_layout Plain Layout
10646 ] Modifies the properties of the given counter.
10647 If the counter does not exist,
10648 the statement is ignored.
10650 \begin_inset Quotes eld
10654 \begin_inset Flex Code
10657 \begin_layout Plain Layout
10664 \begin_inset Quotes erd
10668 \begin_inset Newline newline
10672 \begin_inset CommandInset ref
10674 reference "subsec:Counters"
10678 for details on counters.
10681 \begin_layout Description
10682 \begin_inset Flex Code
10685 \begin_layout Plain Layout
10692 \begin_inset Flex Code
10695 \begin_layout Plain Layout
10701 ] This allows you to include another layout definition file within yours to avoid duplicating commands.
10702 Common examples are the standard layout files,
10705 \begin_inset Flex Code
10708 \begin_layout Plain Layout
10715 which contains most of the basic layouts.
10716 \change_inserted -712698321 1611646803
10720 \begin_layout Description
10722 \change_inserted -712698321 1611646804
10723 \begin_inset Flex Code
10726 \begin_layout Plain Layout
10728 \change_inserted -712698321 1611646837
10737 \begin_inset Flex Code
10740 \begin_layout Plain Layout
10742 \change_inserted -712698321 1611646804
10750 ] is a variant of the
10751 \begin_inset Flex Code
10754 \begin_layout Plain Layout
10756 \change_inserted -712698321 1611646804
10764 command which does not look for files in the user directory.
10765 This allows to create a file
10766 \begin_inset Flex Code
10769 \begin_layout Plain Layout
10771 \change_inserted -712698321 1611646804
10780 \begin_inset Flex Code
10783 \begin_layout Plain Layout
10785 \change_inserted -712698321 1611646804
10793 in the user directory which includes a global file with the same name via
10794 \begin_inset Flex Code
10797 \begin_layout Plain Layout
10799 \change_inserted -712698321 1611646853
10808 \begin_inset Flex Code
10811 \begin_layout Plain Layout
10813 \change_inserted -712698321 1611646855
10814 InputGlobal name.inc
10823 \begin_inset Flex Code
10826 \begin_layout Plain Layout
10828 \change_inserted -712698321 1611646804
10837 the file would recursively include itself).
10839 you can modify global files without having to completely copy them.
10844 \begin_layout Description
10845 \begin_inset Flex Code
10848 \begin_layout Plain Layout
10855 \begin_inset Flex Code
10858 \begin_layout Plain Layout
10864 ] This section (re-)defines the layout of an inset.
10865 It can be applied to an existing inset or to a new,
10866 user-defined inset,
10868 a new character style.
10870 \begin_inset Quotes eld
10874 \begin_inset Flex Code
10877 \begin_layout Plain Layout
10884 \begin_inset Quotes erd
10888 \begin_inset Newline newline
10892 \begin_inset CommandInset ref
10894 reference "subsec:Flex-insets-and"
10898 for more information.
10902 \begin_layout Description
10903 \begin_inset Flex Code
10906 \begin_layout Plain Layout
10913 \begin_inset Flex Code
10916 \begin_layout Plain Layout
10922 ] A string that indicates the width of the left margin on the screen,
10925 \begin_inset Quotes eld
10929 \begin_inset Flex Code
10932 \begin_layout Plain Layout
10939 \begin_inset Quotes erd
10943 (Note that this is not a `length',
10945 \begin_inset Quotes eld
10949 \begin_inset Quotes erd
10955 \begin_layout Description
10956 \begin_inset Flex Code
10959 \begin_layout Plain Layout
10966 \begin_inset Flex Code
10969 \begin_layout Plain Layout
10975 ] An integer that determines the maximal number of names displayed in an author-year citation before the citation switches to
10976 \begin_inset Quotes eld
10980 \begin_inset Quotes erd
10984 Primarily used in cite engine files (see
10985 \begin_inset CommandInset ref
10987 reference "subsec:Cite-Engine-Files"
10997 \begin_layout Description
10999 \change_inserted -712698321 1612018485
11000 \begin_inset Flex Code
11003 \begin_layout Plain Layout
11005 \change_inserted -712698321 1612018457
11014 \begin_inset Flex Code
11017 \begin_layout Plain Layout
11019 \change_inserted -712698321 1612018466
11027 ] Modifies the layout of an inset.
11028 If the layout does not exist,
11029 this section is ignored.
11031 \begin_inset Quotes eld
11035 \begin_inset Flex Code
11038 \begin_layout Plain Layout
11040 \change_inserted -712698321 1612018452
11049 \begin_inset Quotes erd
11055 \begin_layout Description
11056 \begin_inset Flex Code
11059 \begin_layout Plain Layout
11066 \begin_inset Flex Code
11069 \begin_layout Plain Layout
11075 ] Modifies the properties of the given paragraph style.
11076 If the style does not exist,
11077 this section is ignored.
11079 \begin_inset Quotes eld
11083 \begin_inset Flex Code
11086 \begin_layout Plain Layout
11093 \begin_inset Quotes erd
11099 \begin_layout Description
11100 \begin_inset Flex Code
11103 \begin_layout Plain Layout
11110 \begin_inset Flex Code
11113 \begin_layout Plain Layout
11119 ] Deletes an existing counter,
11120 usually one defined in an included file.
11123 \begin_layout Description
11124 \begin_inset Flex Code
11127 \begin_layout Plain Layout
11134 \begin_inset Flex Code
11137 \begin_layout Plain Layout
11143 ] Deletes an existing float.
11144 This is particularly useful when you want to suppress a float that has been defined in an input file.
11147 \begin_layout Description
11148 \begin_inset Flex Code
11151 \begin_layout Plain Layout
11158 \begin_inset Flex Code
11161 \begin_layout Plain Layout
11167 ] Deletes an existing style.
11170 \begin_layout Description
11171 \begin_inset Flex Code
11174 \begin_layout Plain Layout
11181 \begin_inset Flex Code
11184 \begin_layout Plain Layout
11191 \begin_inset Flex Code
11194 \begin_layout Plain Layout
11200 ] Define a new table of contents with type
11201 \begin_inset Flex Code
11204 \begin_layout Plain Layout
11211 \begin_inset Flex Code
11214 \begin_layout Plain Layout
11221 See also the AddToToc commands.
11224 \begin_layout Description
11225 \begin_inset Flex Code
11228 \begin_layout Plain Layout
11235 \begin_inset Flex Code
11238 \begin_layout Plain Layout
11244 ] The file format (as defined in the \SpecialChar LyX
11245 preferences) produced by this document class.
11246 It is mainly useful when
11247 \begin_inset Flex Code
11250 \begin_layout Plain Layout
11257 \begin_inset Flex Code
11260 \begin_layout Plain Layout
11266 and one wants to define a new type of literate document.
11267 The format is reset to
11268 \change_deleted 5863208 1594239413
11270 \begin_inset Quotes eld
11274 \begin_inset Flex Code
11277 \begin_layout Plain Layout
11284 \begin_inset Quotes erd
11290 \begin_inset Quotes eld
11294 \begin_inset Flex Code
11297 \begin_layout Plain Layout
11304 \begin_inset Quotes erd
11307 when the corresponding
11308 \begin_inset Flex Code
11311 \begin_layout Plain Layout
11317 parameter is encountered.
11320 \begin_layout Description
11321 \begin_inset Flex Code
11324 \begin_layout Plain Layout
11331 \begin_inset Flex Code
11334 \begin_layout Plain Layout
11346 \change_deleted 5863208 1594239430
11348 \begin_inset Flex Code
11351 \begin_layout Plain Layout
11361 \begin_inset Flex Code
11364 \begin_layout Plain Layout
11370 ] Specifies what sort of output documents using this class will produce.
11373 \begin_layout Description
11374 \begin_inset Flex Code
11377 \begin_layout Plain Layout
11384 \begin_inset Flex Code
11387 \begin_layout Plain Layout
11394 \begin_inset Flex Code
11397 \begin_layout Plain Layout
11403 ] Specifies options,
11404 given in the second string,
11405 for the package named by the first string.
11408 \begin_inset Quotes eld
11412 \begin_inset Flex Code
11415 \begin_layout Plain Layout
11416 PackageOptions natbib square
11422 \begin_inset Quotes erd
11426 \begin_inset Flex Code
11429 \begin_layout Plain Layout
11435 to be loaded with the
11436 \begin_inset Flex Code
11439 \begin_layout Plain Layout
11446 (For \SpecialChar TeX
11448 this causes \SpecialChar LyX
11451 \begin_inset Flex Code
11454 \begin_layout Plain Layout
11457 PassOptionsToPackage{natbib}{square}
11463 \begin_inset Flex Code
11466 \begin_layout Plain Layout
11473 \change_inserted -712698321 1565102364
11477 \begin_layout Description
11479 \change_inserted -712698321 1565102470
11480 \begin_inset Flex Code
11483 \begin_layout Plain Layout
11485 \change_inserted -712698321 1565102365
11494 \begin_inset Flex Code
11497 \begin_layout Plain Layout
11499 \change_inserted -712698321 1565105222
11542 ] The default page size.
11543 This is used by some converters.
11548 \begin_layout Description
11549 \begin_inset Flex Code
11552 \begin_layout Plain Layout
11559 \begin_inset Flex Code
11562 \begin_layout Plain Layout
11572 \begin_inset Flex Code
11575 \begin_layout Plain Layout
11583 \begin_inset Flex Code
11586 \begin_layout Plain Layout
11592 ] The default pagestyle.
11593 Can be changed in the
11594 \begin_inset Flex Noun
11597 \begin_layout Plain Layout
11598 Document\SpecialChar menuseparator
11607 \begin_layout Description
11608 \begin_inset Flex Code
11611 \begin_layout Plain Layout
11617 Sets the preamble for the \SpecialChar LaTeX
11619 Note that this will completely override any prior
11620 \begin_inset Flex Code
11623 \begin_layout Plain Layout
11630 \begin_inset Flex Code
11633 \begin_layout Plain Layout
11641 \begin_inset Flex Code
11644 \begin_layout Plain Layout
11650 if you just want to add material to the preamble.) Must end with
11651 \begin_inset Quotes eld
11655 \begin_inset Flex Code
11658 \begin_layout Plain Layout
11665 \begin_inset Quotes erd
11669 \change_inserted -712698321 1612018500
11673 \begin_layout Description
11675 \change_inserted -712698321 1612018547
11676 \begin_inset Flex Code
11679 \begin_layout Plain Layout
11681 \change_inserted -712698321 1612018506
11690 \begin_inset Flex Code
11693 \begin_layout Plain Layout
11695 \change_inserted -712698321 1612018509
11703 ] Defines the layout of an inset if it does not already exist.
11704 If the layout does exist,
11705 this section is ignored.
11707 \begin_inset Quotes eld
11711 \begin_inset Flex Code
11714 \begin_layout Plain Layout
11716 \change_inserted -712698321 1612018500
11725 \begin_inset Quotes erd
11733 \begin_layout Description
11734 \begin_inset Flex Code
11737 \begin_layout Plain Layout
11744 \begin_inset Flex Code
11747 \begin_layout Plain Layout
11754 \begin_inset Flex Code
11757 \begin_layout Plain Layout
11766 \begin_inset space \thinspace{}
11770 \begin_inset Flex Code
11773 \begin_layout Plain Layout
11779 ] Whether the class already provides the feature
11780 \begin_inset Flex Code
11783 \begin_layout Plain Layout
11790 A feature is in general the name of a package (e.
11791 \begin_inset space \thinspace{}
11795 \begin_inset space \space{}
11799 \begin_inset Flex Code
11802 \begin_layout Plain Layout
11809 \begin_inset Flex Code
11812 \begin_layout Plain Layout
11819 \begin_inset space \thinspace{}
11823 \begin_inset space \space{}
11827 \begin_inset Flex Code
11830 \begin_layout Plain Layout
11837 \begin_inset Flex Code
11840 \begin_layout Plain Layout
11848 \begin_inset CommandInset ref
11850 reference "chap:List-of-functions"
11854 for the list of features.
11857 \begin_layout Description
11858 \begin_inset Flex Code
11861 \begin_layout Plain Layout
11868 \begin_inset Flex Code
11871 \begin_layout Plain Layout
11877 ] Indicates that this layout provides the functionality of the module mentioned,
11878 which should be specified by the filename without the
11879 \begin_inset Flex Code
11882 \begin_layout Plain Layout
11889 This will typically be used if the layout includes the module directly,
11890 rather than using the
11891 \begin_inset Flex Code
11894 \begin_layout Plain Layout
11900 tag to indicate that it ought to be used.
11901 It could also be used in a module that provided an alternate implementation of the same functionality.
11904 \begin_layout Description
11905 \begin_inset Flex Code
11908 \begin_layout Plain Layout
11915 \begin_inset Flex Code
11918 \begin_layout Plain Layout
11924 ] Creates a new paragraph style if it does not already exist.
11925 If the style does exist,
11926 this section is ignored.
11928 \begin_inset Quotes eld
11932 \begin_inset Flex Code
11935 \begin_layout Plain Layout
11942 \begin_inset Quotes erd
11948 \begin_layout Description
11949 \begin_inset Flex Code
11952 \begin_layout Plain Layout
11959 \begin_inset Flex Code
11962 \begin_layout Plain Layout
11968 ] Whether the class requires the feature
11969 \begin_inset Flex Code
11972 \begin_layout Plain Layout
11979 Multiple features must be separated by commas.
11980 Note that you can only request supported features.
11982 \begin_inset CommandInset ref
11984 reference "chap:List-of-functions"
11988 for the list of features.).
11989 If you require a package with specific options,
11990 you can additionally use
11991 \begin_inset Flex Code
11994 \begin_layout Plain Layout
12003 \begin_layout Description
12004 \begin_inset Flex Code
12007 \begin_layout Plain Layout
12014 \begin_inset Flex Code
12017 \begin_layout Plain Layout
12023 ] A string that indicates the width of the right margin on the screen,
12026 \begin_inset Quotes eld
12030 \begin_inset Flex Code
12033 \begin_layout Plain Layout
12040 \begin_inset Quotes erd
12046 \begin_layout Description
12047 \begin_inset Flex Code
12050 \begin_layout Plain Layout
12057 \begin_inset Flex Code
12060 \begin_layout Plain Layout
12066 ] Sets which divisions get numbered.
12068 \begin_inset Newline newline
12072 \begin_inset Flex Code
12075 \begin_layout Plain Layout
12081 counter in \SpecialChar LaTeX
12085 \begin_layout Description
12086 \begin_inset Flex Code
12089 \begin_layout Plain Layout
12096 \begin_inset Flex Code
12099 \begin_layout Plain Layout
12108 \begin_inset space \thinspace{}
12112 \begin_inset Flex Code
12115 \begin_layout Plain Layout
12121 ] Whether the class-default should be printing on one or both sides of the paper.
12122 Can be changed in the
12123 \begin_inset Flex Noun
12126 \begin_layout Plain Layout
12127 Document\SpecialChar menuseparator
12136 \begin_layout Description
12137 \begin_inset Flex Code
12140 \begin_layout Plain Layout
12147 \begin_inset Flex Code
12150 \begin_layout Plain Layout
12156 ] This sequence defines a paragraph style.
12157 If the style does not yet exist,
12160 its parameters are modified.
12162 \begin_inset Quotes eld
12166 \begin_inset Flex Code
12169 \begin_layout Plain Layout
12176 \begin_inset Quotes erd
12180 \begin_inset Newline newline
12184 \begin_inset CommandInset ref
12186 reference "subsec:Paragraph-Styles"
12190 for details on paragraph styles.
12191 \change_inserted -712698321 1553617804
12195 \begin_layout Description
12197 \change_inserted -712698321 1553617862
12198 \begin_inset Flex Code
12201 \begin_layout Plain Layout
12203 \change_inserted -712698321 1553617809
12212 \begin_inset Flex Code
12215 \begin_layout Plain Layout
12217 \change_inserted -712698321 1553617805
12225 ] defines the default table style that is used when inserting a table.
12226 The following styles are available:
12230 \begin_layout Itemize
12232 \change_inserted -712698321 1554308039
12233 \begin_inset Flex Code
12236 \begin_layout Plain Layout
12238 \change_inserted -712698321 1554307928
12239 Formal_with_Footline
12248 \begin_inset Quotes eld
12252 \begin_inset Quotes erd
12255 ) style with horizontal lines only,
12256 using a bold top and bottom line,
12257 the first and last row are additionally separated from the table body with a thin middle line.
12260 \begin_layout Itemize
12262 \change_inserted -712698321 1554308087
12263 \begin_inset Flex Code
12266 \begin_layout Plain Layout
12268 \change_inserted -712698321 1554308042
12269 Formal_without_Footline
12278 but the last row is not separated with a middle line from the body.
12281 \begin_layout Itemize
12283 \change_inserted -712698321 1553618031
12284 \begin_inset Flex Code
12287 \begin_layout Plain Layout
12289 \change_inserted -712698321 1553618006
12298 Simple table lines.
12301 \begin_layout Itemize
12303 \change_inserted -712698321 1553618309
12304 \begin_inset Flex Code
12307 \begin_layout Plain Layout
12309 \change_inserted -712698321 1553618031
12319 \begin_inset Flex Code
12322 \begin_layout Plain Layout
12324 \change_inserted -712698321 1553618043
12333 but with the header
12334 \change_deleted 34634807 1619712593
12336 \change_inserted 34634807 1619712594
12338 \change_inserted -712698321 1553618309
12339 offset with a second horizontal line.
12340 This is also the default style of \SpecialChar LyX
12344 \begin_layout Itemize
12346 \change_inserted -712698321 1553618280
12347 \begin_inset Flex Code
12350 \begin_layout Plain Layout
12352 \change_inserted -712698321 1553618261
12361 Table without lines.
12367 \begin_layout Description
12368 \begin_inset Flex Code
12371 \begin_layout Plain Layout
12378 \begin_inset Flex Code
12381 \begin_layout Plain Layout
12387 ] The name of the command or environment to be used with
12388 \begin_inset Flex Code
12391 \begin_layout Plain Layout
12400 \begin_layout Description
12401 \begin_inset Flex Code
12404 \begin_layout Plain Layout
12411 \begin_inset Flex Code
12414 \begin_layout Plain Layout
12424 \begin_inset Flex Code
12427 \begin_layout Plain Layout
12433 ] Indicates what kind of markup is used to define the title of a document.
12435 \begin_inset Flex Code
12438 \begin_layout Plain Layout
12444 means that the macro with name
12445 \begin_inset Flex Code
12448 \begin_layout Plain Layout
12454 will be inserted after the last layout which has
12455 \begin_inset Quotes eld
12459 \begin_inset Flex Code
12462 \begin_layout Plain Layout
12464 \begin_inset space ~
12473 \begin_inset Quotes erd
12478 \begin_inset Flex Code
12481 \begin_layout Plain Layout
12487 corresponds to the case where all layouts which have
12488 \begin_inset Quotes eld
12492 \begin_inset Flex Code
12495 \begin_layout Plain Layout
12497 \begin_inset space ~
12506 \begin_inset Quotes erd
12509 should be enclosed into the
12510 \begin_inset Flex Code
12513 \begin_layout Plain Layout
12522 \begin_layout Description
12523 \begin_inset Flex Code
12526 \begin_layout Plain Layout
12533 \begin_inset Flex Code
12536 \begin_layout Plain Layout
12542 ] Sets which divisions are included in the table of contents.
12544 \begin_inset Flex Code
12547 \begin_layout Plain Layout
12553 counter in \SpecialChar LaTeX
12557 \begin_layout Subsection
12558 \begin_inset Flex Code
12561 \begin_layout Plain Layout
12568 \begin_inset CommandInset label
12570 name "subsec:ClassOptions"
12577 \begin_layout Standard
12579 \begin_inset Flex Code
12582 \begin_layout Plain Layout
12588 section can contain the following entries:
12591 \begin_layout Description
12592 \begin_inset Flex Code
12595 \begin_layout Plain Layout
12602 \begin_inset Flex Code
12605 \begin_layout Plain Layout
12611 ] The list of available font sizes for the document's main font,
12613 \begin_inset Quotes eld
12617 \begin_inset Flex Code
12620 \begin_layout Plain Layout
12627 \begin_inset Quotes erd
12632 \change_inserted -712698321 1565110196
12633 Any number is possible.
12636 \begin_layout Description
12638 \change_inserted -712698321 1565110259
12639 \begin_inset Flex Code
12642 \begin_layout Plain Layout
12644 \change_inserted -712698321 1565110199
12653 \begin_inset Flex Code
12656 \begin_layout Plain Layout
12658 \change_inserted -712698321 1565110196
12666 ] The format for the font size option.
12669 \begin_inset Flex Code
12672 \begin_layout Plain Layout
12674 \change_inserted -712698321 1565110238
12684 \begin_inset Flex Code
12687 \begin_layout Plain Layout
12689 \change_inserted -712698321 1565110248
12697 is a placeholder for the font size.
12702 \begin_layout Description
12704 \change_deleted 5863208 1594239483
12705 \begin_inset Flex Code
12708 \begin_layout Plain Layout
12714 Used to set the DTD line with XML-based output classes.
12716 \begin_inset space \thinspace{}
12721 \begin_inset Quotes eld
12724 -//OASIS//DTD DocBook V4.2//EN
12725 \begin_inset Quotes erd
12729 \change_inserted -712698321 1565101761
12733 \begin_layout Description
12735 \change_inserted -712698321 1565180598
12736 \begin_inset Flex Code
12739 \begin_layout Plain Layout
12741 \change_inserted -712698321 1565101918
12750 \begin_inset Flex Code
12753 \begin_layout Plain Layout
12755 \change_inserted -712698321 1565105399
12756 string="letter|\SpecialChar allowbreak
12757 legal|\SpecialChar allowbreak
12758 executive|\SpecialChar allowbreak
12759 a0|\SpecialChar allowbreak
12760 a1|\SpecialChar allowbreak
12761 a2|\SpecialChar allowbreak
12762 a3|\SpecialChar allowbreak
12763 a4|\SpecialChar allowbreak
12764 a5|\SpecialChar allowbreak
12765 a6|\SpecialChar allowbreak
12766 b0|\SpecialChar allowbreak
12767 b1|\SpecialChar allowbreak
12768 b2|\SpecialChar allowbreak
12769 b3|\SpecialChar allowbreak
12770 b4|\SpecialChar allowbreak
12771 b5|\SpecialChar allowbreak
12772 b6|\SpecialChar allowbreak
12773 c0|\SpecialChar allowbreak
12774 c1|\SpecialChar allowbreak
12775 c2|\SpecialChar allowbreak
12776 c3|\SpecialChar allowbreak
12777 c4|\SpecialChar allowbreak
12778 c5|\SpecialChar allowbreak
12779 c6|\SpecialChar allowbreak
12780 b0j|\SpecialChar allowbreak
12781 b1j|\SpecialChar allowbreak
12782 b2j|\SpecialChar allowbreak
12783 b3j|\SpecialChar allowbreak
12784 b4j|\SpecialChar allowbreak
12785 b5j|\SpecialChar allowbreak
12793 ] The list of available page sizes,
12795 \begin_inset Quotes eld
12799 \begin_inset Flex Code
12802 \begin_layout Plain Layout
12804 \change_inserted -712698321 1565101779
12813 \begin_inset Quotes erd
12818 only the listed sizes are supported.
12819 Other sizes might be entered as custom class option.
12822 \begin_layout Description
12824 \change_inserted -712698321 1565180623
12825 \begin_inset Flex Code
12828 \begin_layout Plain Layout
12830 \change_inserted -712698321 1565180605
12839 \begin_inset Flex Code
12842 \begin_layout Plain Layout
12844 \change_inserted -712698321 1565180601
12852 ] The format for the page size option.
12855 \begin_inset Flex Code
12858 \begin_layout Plain Layout
12860 \change_inserted -712698321 1565180618
12870 \begin_inset Flex Code
12873 \begin_layout Plain Layout
12875 \change_inserted -712698321 1565180601
12883 is a placeholder for the paper size.
12888 \begin_layout Description
12889 \begin_inset Flex Code
12892 \begin_layout Plain Layout
12899 \begin_inset Flex Code
12902 \begin_layout Plain Layout
12903 string="empty|plain|headings|fancy"
12908 ] The list of available page sty\SpecialChar softhyphen
12911 \begin_inset Quotes eld
12915 \begin_inset Flex Code
12918 \begin_layout Plain Layout
12925 \begin_inset Quotes erd
12931 \begin_layout Description
12932 \begin_inset Flex Code
12935 \begin_layout Plain Layout
12942 \begin_inset Flex Code
12945 \begin_layout Plain Layout
12951 ] Some document class options,
12952 separated by a comma,
12953 that will be added to the optional part of the
12954 \begin_inset Flex Code
12957 \begin_layout Plain Layout
12968 \begin_layout Standard
12970 \begin_inset Flex Code
12973 \begin_layout Plain Layout
12979 section must end with
12980 \begin_inset Quotes eld
12984 \begin_inset Flex Code
12987 \begin_layout Plain Layout
12994 \begin_inset Quotes erd
13000 \begin_layout Subsection
13002 \begin_inset CommandInset label
13004 name "subsec:Paragraph-Styles"
13011 \begin_layout Standard
13012 A paragraph style description looks like this:
13016 \begin_layout Plain Layout
13017 Note that this will either define a new style or modify an existing one.
13025 \begin_layout LyX-Code
13032 \begin_layout LyX-Code
13036 \begin_layout LyX-Code
13040 \begin_layout Standard
13041 where the following commands are allowed:
13044 \begin_layout Description
13045 \begin_inset Flex Code
13048 \begin_layout Plain Layout
13055 \begin_inset Flex Code
13058 \begin_layout Plain Layout
13064 =""] This paragraph will appear in the table of contents of the given type.
13065 An empty string disables.
13066 See also the OutlinerName and the IsTocCaption commands.
13071 \begin_layout Description
13072 \begin_inset Flex Code
13075 \begin_layout Plain Layout
13082 \begin_inset Flex Code
13085 \begin_layout Plain Layout
13098 ] Paragraph alignment.
13101 \begin_layout Description
13102 \begin_inset Flex Code
13105 \begin_layout Plain Layout
13112 \begin_inset Flex Code
13115 \begin_layout Plain Layout
13128 ] A comma separated list of permitted alignments.
13129 (Some \SpecialChar LaTeX
13130 styles prohibit certain alignments,
13131 since those wouldn't make sense.
13132 For example a right-aligned or centered enumeration isn't possible.)
13135 \begin_layout Description
13136 \begin_inset Flex Code
13139 \begin_layout Plain Layout
13146 \begin_inset Flex Code
13149 \begin_layout Plain Layout
13155 ] Defines argument number <int> of a command\SpecialChar breakableslash
13156 environment associated with the current style.
13158 \change_inserted -584632292 1615846868
13159 The definition must end with
13160 \begin_inset Flex Code
13163 \begin_layout Plain Layout
13165 \change_inserted -584632292 1615846867
13177 \change_inserted -584632292 1615846880
13179 \begin_inset CommandInset ref
13181 reference "subsec:Arguments"
13188 for more information.
13190 \change_deleted -584632292 1615846694
13191 This is useful for things like section headings,
13192 and only makes sense with \SpecialChar LaTeX
13194 Every (optional or required) argument of a command or environment – except for the required argument that is associated with the content of the paragraph itself – has a separate definition,
13195 where the number specifies the order of the arguments.
13196 The definition must end with
13197 \begin_inset Flex Code
13200 \begin_layout Plain Layout
13207 So a command with two optional arguments has:
13211 \begin_layout Quote
13213 \change_deleted -584632292 1615846694
13219 \begin_layout Quote
13221 \change_deleted -584632292 1615846694
13227 \begin_layout Quote
13229 \change_deleted -584632292 1615846694
13235 \begin_layout Quote
13237 \change_deleted -584632292 1615846694
13243 \begin_layout Quote
13245 \change_deleted -584632292 1615846694
13251 \begin_layout Quote
13253 \change_deleted -584632292 1615846694
13259 \begin_layout Standard
13261 \change_deleted -584632292 1615846694
13263 \begin_inset Flex Code
13266 \begin_layout Plain Layout
13273 the following specifications are possible:
13276 \begin_layout Itemize
13278 \change_deleted -584632292 1615846694
13279 \begin_inset Flex Code
13282 \begin_layout Plain Layout
13289 \begin_inset Flex Code
13292 \begin_layout Plain Layout
13298 The string that will appear both in the menu (to insert this argument) and on the argument inset button (unless you also specify a separate
13299 \begin_inset Flex Code
13302 \begin_layout Plain Layout
13310 you can define an accelerator by appending the respective character to the string,
13312 \begin_inset Quotes eld
13316 \begin_inset Quotes erd
13320 \begin_inset space \thinspace{}
13324 \begin_inset space \space{}
13328 \begin_inset Quotes eld
13332 \begin_inset Flex Code
13335 \begin_layout Plain Layout
13342 \begin_inset Quotes erd
13348 \begin_layout Itemize
13350 \change_deleted -584632292 1615846694
13351 \begin_inset Flex Code
13354 \begin_layout Plain Layout
13361 \begin_inset Flex Code
13364 \begin_layout Plain Layout
13370 A separate string for the menu.
13371 You can define an accelerator by appending the respective character to the string,
13373 \begin_inset Quotes eld
13377 \begin_inset Quotes erd
13381 \begin_inset space \thinspace{}
13385 \begin_inset space \space{}
13389 \begin_inset Quotes eld
13393 \begin_inset Flex Code
13396 \begin_layout Plain Layout
13403 \begin_inset Quotes erd
13407 This specification is optional.
13408 If it is not given the
13409 \begin_inset Flex Code
13412 \begin_layout Plain Layout
13418 will be used instead for the menu.
13421 \begin_layout Itemize
13423 \change_deleted -584632292 1615846694
13424 \begin_inset Flex Code
13427 \begin_layout Plain Layout
13434 \begin_inset Flex Code
13437 \begin_layout Plain Layout
13443 A longer explanatory text that appears in the tooltip when hovering over the argument inset.
13446 \begin_layout Itemize
13448 \change_deleted -584632292 1615846694
13449 \begin_inset Flex Code
13452 \begin_layout Plain Layout
13459 \begin_inset Flex Code
13462 \begin_layout Plain Layout
13471 \begin_inset space \thinspace{}
13475 \begin_inset Flex Code
13478 \begin_layout Plain Layout
13484 ] Declare if this is a mandatory (1) or an optional (0) argument.
13485 Mandatory arguments will be output empty if not given,
13486 while optional arguments will not be output at all.
13488 mandatory arguments are delimited by
13489 \begin_inset Flex Code
13492 \begin_layout Plain Layout
13499 while optional arguments are delimited by
13500 \begin_inset Flex Code
13503 \begin_layout Plain Layout
13512 \begin_layout Itemize
13514 \change_deleted -584632292 1615846694
13515 \begin_inset Flex Code
13518 \begin_layout Plain Layout
13520 \change_inserted -712698321 1555579780
13529 \begin_inset Flex Code
13532 \begin_layout Plain Layout
13534 \change_inserted -712698321 1555579780
13542 Option to define a different command (from the default
13543 \begin_inset Flex Code
13546 \begin_layout Plain Layout
13548 \change_inserted -712698321 1555579780
13560 ) to be used for line breaks.
13561 The initial backslash must not be specified.
13564 \begin_layout Itemize
13566 \change_deleted -584632292 1615846694
13567 \begin_inset Flex Code
13570 \begin_layout Plain Layout
13577 \begin_inset Flex Code
13580 \begin_layout Plain Layout
13586 defines another argument (by its number) which this argument requires to be output if it is itself output.
13588 \begin_inset space \thinspace{}
13592 in \SpecialChar LaTeX
13594 optional arguments often require previous optional arguments to be output (at least empty),
13596 \begin_inset Flex Code
13599 \begin_layout Plain Layout
13602 command[][argument]{text}
13608 This can be achieved by the statement
13609 \begin_inset Flex Code
13612 \begin_layout Plain Layout
13619 \begin_inset Flex Code
13622 \begin_layout Plain Layout
13631 \begin_layout Itemize
13633 \change_deleted -584632292 1615846694
13634 \begin_inset Flex Code
13637 \begin_layout Plain Layout
13644 \begin_inset Flex Code
13647 \begin_layout Plain Layout
13653 defines a custom left delimiter (instead of
13654 \begin_inset Flex Code
13657 \begin_layout Plain Layout
13664 \begin_inset Flex Code
13667 \begin_layout Plain Layout
13674 A line break in the output can be indicated by
13675 \begin_inset Flex Code
13678 \begin_layout Plain Layout
13687 \begin_layout Itemize
13689 \change_deleted -584632292 1615846694
13690 \begin_inset Flex Code
13693 \begin_layout Plain Layout
13700 \begin_inset Flex Code
13703 \begin_layout Plain Layout
13709 defines a custom right delimiter (instead of
13710 \begin_inset Flex Code
13713 \begin_layout Plain Layout
13720 \begin_inset Flex Code
13723 \begin_layout Plain Layout
13730 A line break in the output can be indicated by
13731 \begin_inset Flex Code
13734 \begin_layout Plain Layout
13743 \begin_layout Itemize
13745 \change_deleted -584632292 1615846694
13746 \begin_inset Flex Code
13749 \begin_layout Plain Layout
13756 \begin_inset Flex Code
13759 \begin_layout Plain Layout
13765 defines an argument that is inserted if and only if no user-specified arguments were given,
13767 \begin_inset space \thinspace{}
13771 \begin_inset space \space{}
13774 if no argument inset has been inserted (note that also an empty argument inset omits the DefaultArg).
13775 Multiple arguments need to be separated by comma.
13778 \begin_layout Itemize
13780 \change_deleted -584632292 1615846694
13781 \begin_inset Flex Code
13784 \begin_layout Plain Layout
13791 \begin_inset Flex Code
13794 \begin_layout Plain Layout
13800 defines an argument that is inserted in any case (alone or in addition to user-specified arguments).
13801 Multiple arguments need to be separated by comma.
13804 \begin_layout Itemize
13806 \change_deleted -584632292 1615846694
13807 \begin_inset Flex Code
13810 \begin_layout Plain Layout
13816 The font used for the argument content,
13818 \begin_inset CommandInset ref
13820 reference "subsec:Font-description"
13827 \begin_layout Itemize
13829 \change_deleted -584632292 1615846694
13830 \begin_inset Flex Code
13833 \begin_layout Plain Layout
13835 \change_inserted -712698321 1559484228
13844 \begin_inset Flex Code
13847 \begin_layout Plain Layout
13849 \change_inserted -712698321 1559484228
13860 \begin_inset space \thinspace{}
13864 \begin_inset Flex Code
13867 \begin_layout Plain Layout
13869 \change_inserted -712698321 1559484228
13877 ] As with paragraph styles,
13879 \begin_inset CommandInset ref
13881 reference "subsec:Paragraph-Styles"
13888 \begin_layout Itemize
13890 \change_deleted -584632292 1615846694
13891 \begin_inset Flex Code
13894 \begin_layout Plain Layout
13900 The font used for the label;
13902 \begin_inset CommandInset ref
13904 reference "subsec:Font-description"
13911 \begin_layout Itemize
13913 \change_deleted -584632292 1615846694
13914 \begin_inset Flex Code
13917 \begin_layout Plain Layout
13924 \begin_inset Flex Code
13927 \begin_layout Plain Layout
13939 ] describes the rendering style used for the inset's frame and buttons.
13942 \begin_layout Itemize
13944 \change_deleted -584632292 1615846694
13945 \begin_inset Flex Code
13948 \begin_layout Plain Layout
13955 \begin_inset Flex Code
13958 \begin_layout Plain Layout
13965 \begin_inset Flex Code
13968 \begin_layout Plain Layout
13975 this argument is automatically inserted when the respective style is selected.
13977 \change_deleted -712698321 1559484200
13979 only one argument per style\SpecialChar breakableslash
13980 layout can be automatically inserted.
13981 \change_deleted -584632292 1615846694
13985 \begin_layout Itemize
13987 \change_deleted -584632292 1615846694
13988 \begin_inset Flex Code
13991 \begin_layout Plain Layout
13993 \change_inserted -712698321 1559490711
14002 \begin_inset Flex Code
14005 \begin_layout Plain Layout
14007 \change_inserted -712698321 1559490703
14016 \begin_inset Flex Code
14019 \begin_layout Plain Layout
14021 \change_inserted -712698321 1559490703
14030 this argument will be inserted on a new line with
14031 \begin_inset Flex Code
14034 \begin_layout Plain Layout
14036 \change_inserted -712698321 1559491402
14044 (only available within Flex insets).
14047 \begin_layout Itemize
14049 \change_deleted -584632292 1615846694
14050 \begin_inset Flex Code
14053 \begin_layout Plain Layout
14060 \begin_inset Flex Code
14063 \begin_layout Plain Layout
14070 \begin_inset Flex Code
14073 \begin_layout Plain Layout
14080 this argument will be inserted with a copy of the co-text (either selected text or the whole paragraph) as content.
14083 \begin_layout Itemize
14085 \change_deleted -584632292 1615846694
14086 \begin_inset Flex Code
14089 \begin_layout Plain Layout
14096 \begin_inset Flex Code
14099 \begin_layout Plain Layout
14111 ] Whether the contents of this argument should be output in raw form,
14112 meaning without special translations that \SpecialChar LaTeX
14116 \begin_inset Flex Code
14119 \begin_layout Plain Layout
14125 status is inherited by the inset or paragraph layout the argument belongs to,
14126 true and false change the status for the given argument only.
14129 \begin_layout Itemize
14131 \change_deleted -584632292 1615846694
14132 \begin_inset Flex Code
14135 \begin_layout Plain Layout
14142 \begin_inset Flex Code
14145 \begin_layout Plain Layout
14146 string of characters
14155 Defines individual characters
14156 \begin_inset Newline linebreak
14159 that should be output in raw form,
14160 meaning without special translations that \SpecialChar LaTeX
14163 contrary to PassThru,
14164 this needs to be explicitly defined for arguments.
14166 arguments do not inherit PassThruChars from their parent inset or layout.
14169 \begin_layout Itemize
14171 \change_deleted -584632292 1615846694
14172 \begin_inset Flex Code
14175 \begin_layout Plain Layout
14182 \begin_inset Flex Code
14185 \begin_layout Plain Layout
14194 \begin_inset space \thinspace{}
14198 \begin_inset Flex Code
14201 \begin_layout Plain Layout
14207 ] If this is set to 1,
14208 the argument will output its content in the corresponding item in the table of contents.
14212 \begin_layout Standard
14214 \change_deleted -584632292 1615846694
14216 the text entered in the \SpecialChar LyX
14217 workarea in the respective layout is the last (mandatory) argument of a command if the
14218 \begin_inset Flex Code
14221 \begin_layout Plain Layout
14228 \begin_inset Flex Code
14231 \begin_layout Plain Layout
14239 arguments with the prefix
14240 \begin_inset Flex Code
14243 \begin_layout Plain Layout
14249 are output after this workarea argument.
14250 Note that post-argument numbering restarts at 1,
14251 so the first argument following the workarea argument is
14252 \begin_inset Flex Code
14255 \begin_layout Plain Layout
14262 Post-arguments are ignored in any other
14263 \begin_inset Flex Code
14266 \begin_layout Plain Layout
14273 \begin_inset Flex Code
14276 \begin_layout Plain Layout
14285 \begin_layout Standard
14287 \change_deleted -584632292 1615846694
14289 \begin_inset Flex Code
14292 \begin_layout Plain Layout
14301 \begin_inset Flex Code
14304 \begin_layout Plain Layout
14313 \begin_inset Flex Code
14316 \begin_layout Plain Layout
14322 followed by the number (e.
14323 \begin_inset space \thinspace{}
14327 \begin_inset space \space{}
14331 \begin_inset Flex Code
14334 \begin_layout Plain Layout
14343 \begin_layout Standard
14345 \change_deleted -584632292 1615846694
14347 there is a special argument type with the prefix
14348 \begin_inset Flex Code
14351 \begin_layout Plain Layout
14353 \change_inserted -712698321 1534487844
14362 It is not really an argument,
14363 but uses the argument interface (thus,
14364 the prefix is also followed by a number,
14366 \begin_inset space \thinspace{}
14371 \begin_inset Flex Code
14374 \begin_layout Plain Layout
14376 \change_inserted -712698321 1534488412
14377 Argument listpreamble:1
14385 As the name implies,
14386 it is targeted at lists such as
14406 Its content will be output at the list start,
14408 \begin_inset Flex Code
14411 \begin_layout Plain Layout
14413 \change_inserted -712698321 1534488058
14424 on an own line (a place that is otherwise not accessible in \SpecialChar LyX
14427 users can insert redefinitions (of lengths etc.) to individual lists.
14429 these arguments do not have a delimiter.
14435 \begin_layout Description
14436 \begin_inset Flex Code
14439 \begin_layout Plain Layout
14445 Includes a comma-separated list of layouts that should be nested in and after the current layout.
14446 Only makes sense for nestable layouts (such as environments).
14448 \begin_inset Quotes eld
14452 \begin_inset Flex Code
14455 \begin_layout Plain Layout
14462 \begin_inset Quotes erd
14467 \begin_inset Flex Code
14470 \begin_layout Plain Layout
14479 \begin_layout Description
14480 \begin_inset Flex Code
14483 \begin_layout Plain Layout
14489 Note that this will completely override any prior
14490 \begin_inset Flex Code
14493 \begin_layout Plain Layout
14499 declaration for this style.
14501 \begin_inset Quotes eld
14505 \begin_inset Flex Code
14508 \begin_layout Plain Layout
14515 \begin_inset Quotes erd
14520 \begin_inset CommandInset ref
14522 reference "subsec:I18n"
14526 for details on its use.
14529 \begin_layout Description
14530 \begin_inset Flex Code
14533 \begin_layout Plain Layout
14540 \begin_inset Flex Code
14543 \begin_layout Plain Layout
14553 \begin_layout Plain Layout
14554 Note that a `float' here is a real number,
14561 The vertical space with which the last of a chain of paragraphs with this style is separated from the following paragraph.
14562 If the next paragraph has another style,
14563 the separations are not simply added,
14564 but the maximum is taken.
14567 \begin_layout Description
14568 \begin_inset Flex Code
14571 \begin_layout Plain Layout
14578 \begin_inset Flex Code
14581 \begin_layout Plain Layout
14587 ] The category for this style.
14588 This is used to group related styles in the style combobox on the toolbar.
14589 Any string can be used,
14590 but you may want to use existing categories with your own styles.
14594 \begin_layout Description
14595 \begin_inset Flex Code
14598 \begin_layout Plain Layout
14604 Depth of XML command.
14605 Used only with XML-type formats.
14608 \begin_layout Description
14609 \begin_inset Flex Code
14612 \begin_layout Plain Layout
14619 \begin_inset Flex Code
14622 \begin_layout Plain Layout
14628 ] Copies all the features of an existing style into the current one.
14632 \begin_layout Description
14633 \begin_inset Flex Code
14636 \begin_layout Plain Layout
14643 \begin_inset Flex Code
14646 \begin_layout Plain Layout
14652 ] The name of a style whose preamble should be output
14657 This allows to ensure some ordering of the preamble snippets when macros definitions depend on one another.
14661 \begin_layout Plain Layout
14663 besides that functionality,
14664 there is no way to ensure any ordering of preambles.
14665 The ordering that you see in a given version of \SpecialChar LyX
14666 may change without warning in later versions.
14674 \begin_layout Description
14675 \begin_inset Flex Code
14678 \begin_layout Plain Layout
14685 \begin_inset Flex Code
14688 \begin_layout Plain Layout
14701 ] The type of label that stands at the end of the paragraph (or sequence of paragraphs if
14702 \begin_inset Flex Code
14705 \begin_layout Plain Layout
14712 \begin_inset Newline newline
14716 \begin_inset Flex Code
14719 \begin_layout Plain Layout
14727 \begin_inset Flex Code
14730 \begin_layout Plain Layout
14737 \begin_inset Flex Code
14740 \begin_layout Plain Layout
14748 \begin_inset Flex Code
14751 \begin_layout Plain Layout
14758 \begin_inset Quotes eld
14762 \begin_inset Quotes erd
14767 \begin_inset Flex Code
14770 \begin_layout Plain Layout
14777 \begin_inset space \space{}
14781 \begin_inset Flex Code
14784 \begin_layout Plain Layout
14790 ) is a white (resp.
14791 \begin_inset space ~
14794 black) square suitable for end of proof markers,
14796 \begin_inset Flex Code
14799 \begin_layout Plain Layout
14805 is an explicit text string.
14808 \begin_layout Description
14809 \begin_inset Flex Code
14812 \begin_layout Plain Layout
14819 \begin_inset Flex Code
14822 \begin_layout Plain Layout
14828 ] The string used for a label with a
14829 \begin_inset Flex Code
14832 \begin_layout Plain Layout
14839 \begin_inset Newline newline
14843 \begin_inset Flex Code
14846 \begin_layout Plain Layout
14856 \begin_layout Description
14857 \begin_inset Flex Code
14860 \begin_layout Plain Layout
14866 The font used for both the text body
14872 \begin_inset CommandInset ref
14874 reference "subsec:Font-description"
14879 Note that defining this font automatically defines the
14880 \begin_inset Flex Code
14883 \begin_layout Plain Layout
14890 So you should define this one first if you also want to define
14891 \begin_inset Flex Code
14894 \begin_layout Plain Layout
14903 \begin_layout Description
14904 \begin_inset Flex Code
14907 \begin_layout Plain Layout
14914 \begin_inset Flex Code
14917 \begin_layout Plain Layout
14923 ] Used for backporting new styles to stable \SpecialChar LyX
14925 The first stable version that supports this tag is \SpecialChar LyX
14927 The argument is a number which may either be 0,
14928 -1 or any value greater than zero.
14930 \begin_inset Flex Code
14933 \begin_layout Plain Layout
14939 flag of a style is greater than zero,
14940 it will always be written to the document header.
14941 If a .lyx file is read,
14942 the style definitions from the document header are added to the document class.
14943 Therefore even older \SpecialChar LyX
14944 versions can handle the style.
14946 \begin_inset Flex Code
14949 \begin_layout Plain Layout
14955 is a version number:
14956 if the style is read,
14957 and the version number is less than the version number of the already existing style in the document class,
14958 the new style is ignored.
14959 If the version number is greater,
14960 the new style replaces the existing style.
14961 A value of -1 means an infinite version number,
14963 \begin_inset space \thinspace{}
14967 \begin_inset space \space{}
14970 the style is always used.
14973 \begin_layout Description
14974 \begin_inset Flex Code
14977 \begin_layout Plain Layout
14984 \begin_inset Flex Code
14987 \begin_layout Plain Layout
14996 \begin_inset space \thinspace{}
15000 \begin_inset Flex Code
15003 \begin_layout Plain Layout
15009 ] Usually \SpecialChar LyX
15010 does not allow you to insert more than one space between words,
15011 since a space is considered as the separation between two words,
15012 not a character or symbol of its own.
15013 This is a very fine thing but sometimes annoying,
15015 when typing program code or plain \SpecialChar LaTeX
15019 \begin_inset Flex Code
15022 \begin_layout Plain Layout
15030 \change_deleted -495245474 1550490105
15035 \change_deleted 177693 1654669077
15037 \change_inserted 177693 1654669079
15041 \change_deleted 177693 1654669082
15043 \change_inserted 177693 1654669082
15046 for the additional blanks when
15047 \change_deleted 34634807 1619626461
15051 \change_inserted -495245474 1550490096
15053 \begin_inset Flex Code
15056 \begin_layout Plain Layout
15058 \change_inserted -495245474 1550490089
15067 \change_deleted -495245474 1550490116
15068 another mode than \SpecialChar LaTeX
15071 \change_inserted -495245474 1550247760
15073 \begin_inset Flex Code
15076 \begin_layout Plain Layout
15078 \change_inserted -495245474 1550247736
15087 \begin_inset Flex Code
15090 \begin_layout Plain Layout
15092 \change_inserted -495245474 1550247755
15105 \begin_layout Description
15106 \begin_inset Flex Code
15109 \begin_layout Plain Layout
15115 These tags are used with XHTML output.
15117 \begin_inset CommandInset ref
15119 reference "subsec:Paragraph-Style-XHTML"
15126 \begin_layout Description
15127 \begin_inset Flex Code
15130 \begin_layout Plain Layout
15136 [FIXME] (Used only with XML-type formats.)
15139 \begin_layout Description
15140 \begin_inset Flex Code
15143 \begin_layout Plain Layout
15150 \begin_inset Flex Code
15153 \begin_layout Plain Layout
15162 \begin_inset space \thinspace{}
15166 \begin_inset Flex Code
15169 \begin_layout Plain Layout
15176 \begin_inset Flex Code
15179 \begin_layout Plain Layout
15186 marks the style as to be included in the document preamble and not in the document body.
15187 This is useful for document classes that want such information as the title and author to appear in the preamble.
15188 Note that this works only for styles for which the
15189 \begin_inset Flex Code
15192 \begin_layout Plain Layout
15199 \begin_inset Flex Code
15202 \begin_layout Plain Layout
15209 \begin_inset Flex Code
15212 \begin_layout Plain Layout
15221 \begin_layout Description
15222 \begin_inset Flex Code
15225 \begin_layout Plain Layout
15232 \begin_inset Flex Code
15235 \begin_layout Plain Layout
15244 \begin_inset space \thinspace{}
15248 \begin_inset Flex Code
15251 \begin_layout Plain Layout
15258 \begin_inset Flex Code
15261 \begin_layout Plain Layout
15268 marks the style as being part of a title block (see also the
15269 \begin_inset Flex Code
15272 \begin_layout Plain Layout
15279 \begin_inset Flex Code
15282 \begin_layout Plain Layout
15291 \begin_layout Description
15292 \begin_inset Flex Code
15295 \begin_layout Plain Layout
15301 Includes a comma-separated list of layouts after which this one should be nested.
15302 Only makes sense with regard to nestable layouts (such as environments).
15304 \begin_inset Quotes eld
15308 \begin_inset Flex Code
15311 \begin_layout Plain Layout
15318 \begin_inset Quotes erd
15323 \begin_inset Flex Code
15326 \begin_layout Plain Layout
15335 \begin_layout Description
15336 \begin_inset Flex Code
15339 \begin_layout Plain Layout
15346 \begin_inset Flex Code
15349 \begin_layout Plain Layout
15358 \begin_inset space \thinspace{}
15362 \begin_inset Flex Code
15365 \begin_layout Plain Layout
15371 ] If this is set to 1 and AddToToc is enabled,
15372 the paragraph adds a summary of its contents in its item in the table of contents.
15379 \begin_layout Description
15380 \begin_inset Flex Code
15383 \begin_layout Plain Layout
15390 \begin_inset Flex Code
15393 \begin_layout Plain Layout
15399 ] The \SpecialChar LaTeX
15400 command sequence declaring an item in a list.
15401 The command is to be defined without the preceding backslash (the default is
15402 \begin_inset Quotes eld
15406 \begin_inset Quotes erd
15411 \begin_inset Flex Code
15414 \begin_layout Plain Layout
15422 in the \SpecialChar LaTeX
15426 \begin_layout Description
15427 \begin_inset Flex Code
15430 \begin_layout Plain Layout
15437 \begin_inset Flex Code
15440 \begin_layout Plain Layout
15446 ] This provides extra space between paragraphs that have the same style.
15447 If you put other styles into an environment,
15448 each is separated with the environment's
15449 \begin_inset Flex Code
15452 \begin_layout Plain Layout
15459 But the whole items of the environment are additionally separated with this
15460 \begin_inset Flex Code
15463 \begin_layout Plain Layout
15470 Note that this is a
15475 \begin_layout Description
15476 \begin_inset Flex Code
15479 \begin_layout Plain Layout
15485 [FIXME] (Used only with XML-type formats.)
15488 \begin_layout Description
15489 \begin_inset Flex Code
15492 \begin_layout Plain Layout
15499 \begin_inset Flex Code
15502 \begin_layout Plain Layout
15511 \begin_inset space \thinspace{}
15515 \begin_inset Flex Code
15518 \begin_layout Plain Layout
15524 ] Usually \SpecialChar LyX
15525 does not allow you to leave a paragraph empty,
15526 since it would lead to empty \SpecialChar LaTeX
15528 There are some cases where this could be desirable however:
15529 in a letter template,
15530 the required fields can be provided as empty fields,
15531 so that people do not forget them;
15532 in some special classes,
15533 a style can be used as some kind of break,
15534 which does not contain actual text.
15537 \begin_layout Description
15538 \begin_inset Flex Code
15541 \begin_layout Plain Layout
15548 \begin_inset Flex Code
15551 \begin_layout Plain Layout
15557 ] The vertical space between the label and the text body.
15558 Only used for labels that are above the text body (
15559 \begin_inset Flex Code
15562 \begin_layout Plain Layout
15569 \begin_inset Newline newline
15573 \begin_inset Flex Code
15576 \begin_layout Plain Layout
15577 Centered_Top_Environment
15585 \begin_layout Description
15586 \begin_inset Flex Code
15589 \begin_layout Plain Layout
15596 \begin_inset Flex Code
15599 \begin_layout Plain Layout
15605 ] The name of the counter for automatic numbering.
15606 In order to have the counter appear with your label,
15607 you will need to reference it in the
15608 \begin_inset Flex Code
15611 \begin_layout Plain Layout
15620 This will work with
15621 \begin_inset Flex Code
15624 \begin_layout Plain Layout
15632 \begin_inset Flex Code
15635 \begin_layout Plain Layout
15643 \begin_inset Flex Code
15646 \begin_layout Plain Layout
15653 \begin_inset Flex Code
15656 \begin_layout Plain Layout
15664 \begin_inset Newline newline
15672 \begin_inset Flex Code
15675 \begin_layout Plain Layout
15682 \begin_inset Flex Code
15685 \begin_layout Plain Layout
15692 though this case is a bit complicated.
15693 Suppose you declare
15694 \begin_inset Quotes eld
15698 \begin_inset Flex Code
15701 \begin_layout Plain Layout
15702 LabelCounter myenum
15708 \begin_inset Quotes erd
15712 Then the actual counters used are
15713 \begin_inset Flex Code
15716 \begin_layout Plain Layout
15724 \begin_inset Flex Code
15727 \begin_layout Plain Layout
15735 \begin_inset Flex Code
15738 \begin_layout Plain Layout
15745 \begin_inset Flex Code
15748 \begin_layout Plain Layout
15755 much as in \SpecialChar LaTeX
15757 These counters must all be declared separately.
15758 \begin_inset Newline newline
15762 \begin_inset CommandInset ref
15764 reference "subsec:Counters"
15768 for details on counters.
15771 \begin_layout Description
15772 \begin_inset Flex Code
15775 \begin_layout Plain Layout
15781 The font used for the label.
15783 \begin_inset CommandInset ref
15785 reference "subsec:Font-description"
15792 \begin_layout Description
15793 \begin_inset Flex Code
15796 \begin_layout Plain Layout
15803 \begin_inset Flex Code
15806 \begin_layout Plain Layout
15812 ] Text that indicates how far a label should be indented.
15815 \begin_layout Description
15816 \begin_inset Flex Code
15819 \begin_layout Plain Layout
15826 \begin_inset Flex Code
15829 \begin_layout Plain Layout
15835 ] Text that indicates the amount of horizontal space between the label and the text body.
15836 Only used for labels that are not above the text body.
15839 \begin_layout Description
15840 \begin_inset Flex Code
15843 \begin_layout Plain Layout
15850 \begin_inset Flex Code
15853 \begin_layout Plain Layout
15859 ] The string used for the label.
15861 \begin_inset Flex Code
15864 \begin_layout Plain Layout
15871 this string can be contain the special formatting commands described in
15872 \begin_inset CommandInset ref
15874 reference "subsec:Counters"
15881 \begin_layout Description
15882 \begin_inset Flex Code
15885 \begin_layout Plain Layout
15886 LabelStringAppendix
15892 \begin_inset Flex Code
15895 \begin_layout Plain Layout
15901 ] This is used inside the appendix instead of
15902 \begin_inset Newline newline
15906 \begin_inset Flex Code
15909 \begin_layout Plain Layout
15917 \begin_inset Flex Code
15920 \begin_layout Plain Layout
15927 \begin_inset Newline newline
15931 \begin_inset Flex Code
15934 \begin_layout Plain Layout
15935 LabelStringAppendix
15943 \begin_layout Description
15944 \begin_inset Flex Code
15947 \begin_layout Plain Layout
15953 [FIXME] (Used only with XML-type formats.)
15956 \begin_layout Description
15957 \begin_inset Flex Code
15960 \begin_layout Plain Layout
15967 \begin_inset Flex Code
15970 \begin_layout Plain Layout
15980 \begin_inset Newline newline
15986 \begin_inset Newline newline
15999 \begin_layout Description
16000 \begin_inset Flex Code
16003 \begin_layout Plain Layout
16009 means the label is the very first word (up to the first real blank).
16011 \change_deleted 177693 1654669087
16013 \change_inserted 177693 1654669089
16016 spaces if you want more than one word as the label.
16020 \begin_layout Description
16021 \begin_inset Flex Code
16024 \begin_layout Plain Layout
16030 means the label is simply what is declared as
16031 \begin_inset Flex Code
16034 \begin_layout Plain Layout
16041 This will be displayed
16042 \begin_inset Quotes eld
16046 \begin_inset Quotes erd
16050 at the beginning of the paragraph.
16052 \begin_inset Flex Code
16055 \begin_layout Plain Layout
16062 \begin_inset Flex Code
16065 \begin_layout Plain Layout
16072 then it will be displayed only in the first paragraph of any sequence of paragraphs with the same
16073 \begin_inset Flex Code
16076 \begin_layout Plain Layout
16085 \begin_layout Description
16086 \begin_inset Flex Code
16089 \begin_layout Plain Layout
16096 \begin_inset space ~
16100 \begin_inset space ~
16104 \begin_inset Flex Code
16107 \begin_layout Plain Layout
16113 are special cases of
16114 \begin_inset Flex Code
16117 \begin_layout Plain Layout
16124 The label will be printed above the paragraph either at the beginning of the line or centered.
16127 \begin_layout Description
16128 \begin_inset Flex Code
16131 \begin_layout Plain Layout
16137 is a special case for the caption-labels
16138 \begin_inset Quotes eld
16142 \begin_inset Quotes erd
16146 \begin_inset Quotes eld
16150 \begin_inset Quotes erd
16154 \begin_inset Newline newline
16158 \begin_inset Flex Code
16161 \begin_layout Plain Layout
16167 means the (hardcoded) label string depends on the kind of float:
16168 It is hardcoded to be `FloatType N',
16169 where N is the value of the counter associated with the float.
16170 For the case that a caption is inserted outside of a float the
16171 \begin_inset Flex Code
16174 \begin_layout Plain Layout
16181 \begin_inset Quotes eld
16185 \begin_inset Quotes erd
16191 \begin_layout Description
16192 \begin_inset Flex Code
16195 \begin_layout Plain Layout
16201 produces the usual sort of enumeration labels.
16202 The number type needs to be set in the
16208 \begin_inset CommandInset ref
16210 reference "subsec:Counters"
16217 \begin_layout Description
16218 \begin_inset Flex Code
16221 \begin_layout Plain Layout
16227 produces various bullets at the different levels.
16228 The bullet types displayed can be set via
16229 \begin_inset Flex Noun
16232 \begin_layout Plain Layout
16233 Document\SpecialChar menuseparator
16234 Settings\SpecialChar menuseparator
16243 \begin_layout Description
16244 \begin_inset Flex Code
16247 \begin_layout Plain Layout
16253 should be used only with
16254 \begin_inset Flex Code
16257 \begin_layout Plain Layout
16258 LatexType BibEnvironment
16267 \begin_layout Description
16268 \begin_inset Flex Code
16271 \begin_layout Plain Layout
16277 Note that this will completely override any prior
16278 \begin_inset Flex Code
16281 \begin_layout Plain Layout
16287 declaration for this style.
16289 \begin_inset Quotes eld
16293 \begin_inset Flex Code
16296 \begin_layout Plain Layout
16303 \begin_inset Quotes erd
16308 \begin_inset CommandInset ref
16310 reference "subsec:I18n"
16314 for details on its use.
16317 \begin_layout Description
16318 \begin_inset Flex Code
16321 \begin_layout Plain Layout
16328 \begin_inset Flex Code
16331 \begin_layout Plain Layout
16337 ] The name of the corresponding \SpecialChar LaTeX
16339 Either the environment or command name.
16342 \begin_layout Description
16343 \begin_inset Flex Code
16346 \begin_layout Plain Layout
16353 \begin_inset Flex Code
16356 \begin_layout Plain Layout
16362 ] An optional parameter for the corresponding
16363 \begin_inset Flex Code
16366 \begin_layout Plain Layout
16373 This parameter cannot be changed from within \SpecialChar LyX
16375 \begin_inset Flex Code
16378 \begin_layout Plain Layout
16384 for customizable parameters).
16385 This will be output as is after all \SpecialChar LaTeX
16387 \begin_inset Flex Code
16390 \begin_layout Plain Layout
16399 \begin_layout Description
16400 \begin_inset Flex Code
16403 \begin_layout Plain Layout
16410 \begin_inset Flex Code
16413 \begin_layout Plain Layout
16422 \begin_inset Newline newline
16431 ] How the style should be translated into \SpecialChar LaTeX
16436 \begin_layout Plain Layout
16437 \begin_inset Flex Code
16440 \begin_layout Plain Layout
16446 is perhaps a bit misleading,
16447 since these rules apply to SGML classes,
16449 Visit the SGML class files for specific examples.
16458 \begin_layout Description
16459 \begin_inset Flex Code
16462 \begin_layout Plain Layout
16468 means nothing special.
16471 \begin_layout Description
16472 \begin_inset Flex Code
16475 \begin_layout Plain Layout
16482 \begin_inset Flex Code
16485 \begin_layout Plain Layout
16492 {\SpecialChar ldots
16501 \begin_layout Description
16502 \begin_inset Flex Code
16505 \begin_layout Plain Layout
16512 \begin_inset Flex Code
16515 \begin_layout Plain Layout
16522 }\SpecialChar ldots
16538 \begin_layout Description
16539 \begin_inset Flex Code
16542 \begin_layout Plain Layout
16549 \begin_inset Flex Code
16552 \begin_layout Plain Layout
16560 \begin_inset Flex Code
16563 \begin_layout Plain Layout
16571 is generated for each paragraph of this environment.
16575 \begin_layout Description
16576 \begin_inset Flex Code
16579 \begin_layout Plain Layout
16586 \begin_inset Flex Code
16589 \begin_layout Plain Layout
16597 \begin_inset Newline newline
16601 \begin_inset Flex Code
16604 \begin_layout Plain Layout
16610 is passed as an argument to the environment.
16611 \begin_inset Newline newline
16615 \begin_inset Flex Code
16618 \begin_layout Plain Layout
16624 can be defined in the
16625 \begin_inset Flex Noun
16628 \begin_layout Plain Layout
16629 Edit\SpecialChar menuseparator
16631 \begin_inset space ~
16642 \begin_layout Description
16643 \begin_inset Flex Code
16646 \begin_layout Plain Layout
16653 \begin_inset Flex Code
16656 \begin_layout Plain Layout
16662 but adds the necessary mandatory argument (the longest label) to the begin statement of the bibliography environment:
16663 \begin_inset Newline newline
16667 \begin_inset Flex Code
16670 \begin_layout Plain Layout
16673 begin{thebibliography}{99}
16679 It is therefore only useful for bibliography environments.
16680 The default longest label
16681 \begin_inset Quotes eld
16685 \begin_inset Quotes erd
16688 can be changed by the user in the paragraph settings of a bibliography item.
16691 \begin_layout Standard
16692 Putting the last few things together,
16693 the \SpecialChar LaTeX
16694 output will be either:
16698 \begin_layout LyX-Code
16701 LatexName[LatexParam]{\SpecialChar ldots
16705 \begin_layout Standard
16710 \begin_layout LyX-Code
16713 begin{LatexName}[LatexParam] \SpecialChar ldots
16719 \begin_layout Standard
16720 depending upon the \SpecialChar LaTeX
16725 \begin_layout Description
16726 \begin_inset Flex Code
16729 \begin_layout Plain Layout
16736 \begin_inset Flex Code
16739 \begin_layout Plain Layout
16745 ] A string that is put at the beginning of the style content.
16746 A line break in the output can be indicated by
16747 \begin_inset Flex Code
16750 \begin_layout Plain Layout
16759 \begin_layout Description
16760 \begin_inset Flex Code
16763 \begin_layout Plain Layout
16770 \begin_inset Flex Code
16773 \begin_layout Plain Layout
16779 ] If you put styles into environments,
16781 \begin_inset Flex Code
16784 \begin_layout Plain Layout
16790 are not simply added,
16791 but added with a factor
16792 \begin_inset Formula $\frac{4}{\mathrm{depth}+4}$
16796 Note that this parameter is also used when
16797 \begin_inset Flex Code
16800 \begin_layout Plain Layout
16807 \begin_inset Flex Code
16810 \begin_layout Plain Layout
16817 \begin_inset Flex Code
16820 \begin_layout Plain Layout
16827 Then it is added to the manual or dynamic margin.
16828 \begin_inset Newline newline
16832 \begin_inset Quotes eld
16836 \begin_inset Flex Code
16839 \begin_layout Plain Layout
16846 \begin_inset Quotes erd
16849 means that the paragraph is indented with the width of
16850 \begin_inset Quotes eld
16854 \begin_inset Flex Code
16857 \begin_layout Plain Layout
16864 \begin_inset Quotes erd
16867 in the normal font.
16868 You can get a negative width by prefixing the string with
16869 \begin_inset Quotes eld
16873 \begin_inset Flex Code
16876 \begin_layout Plain Layout
16883 \begin_inset Quotes erd
16887 This way was chosen so that the look is the same with each used screen font.
16890 \begin_layout Description
16891 \begin_inset Flex Code
16894 \begin_layout Plain Layout
16901 \begin_inset Flex Code
16904 \begin_layout Plain Layout
16919 \begin_inset Newline newline
16922 The kind of margin that the style has on the left side.
16926 \begin_layout Description
16927 \begin_inset Flex Code
16930 \begin_layout Plain Layout
16936 just means a fixed margin.
16939 \begin_layout Description
16940 \begin_inset Flex Code
16943 \begin_layout Plain Layout
16949 means that the left margin depends on the string entered in the
16950 \begin_inset Flex Noun
16953 \begin_layout Plain Layout
16954 Edit\SpecialChar menuseparator
16956 \begin_inset space ~
16965 This is used to typeset nice lists without tabulators.
16968 \begin_layout Description
16969 \begin_inset Flex Code
16972 \begin_layout Plain Layout
16978 means that the margin depends on the size of the label.
16979 This is used for automatic enumerated headlines.
16980 It is obvious that the headline
16981 \begin_inset Quotes eld
16984 5.4.3.2.1 Very long headline
16985 \begin_inset Quotes erd
16988 must have a wider left margin (as wide as
16989 \begin_inset Quotes eld
16993 \begin_inset Quotes erd
16996 plus the space) than
16997 \begin_inset Quotes eld
17000 3.2 Very long headline
17001 \begin_inset Quotes erd
17006 \begin_inset Quotes eld
17010 \begin_inset Quotes erd
17013 are not able to do this.
17016 \begin_layout Description
17017 \begin_inset Flex Code
17020 \begin_layout Plain Layout
17027 but only the very first row of the paragraph is dynamic,
17028 while the others are static;
17034 \begin_layout Description
17035 \begin_inset Flex Code
17038 \begin_layout Plain Layout
17044 means the margin is chosen in a way that the longest row of this paragraph fits to the right margin.
17045 This is used to typeset an address on the right edge of the page.
17049 \begin_layout Description
17050 \begin_inset Flex Code
17053 \begin_layout Plain Layout
17060 \begin_inset Flex Code
17063 \begin_layout Plain Layout
17072 \begin_inset space \thinspace{}
17076 \begin_inset Flex Code
17079 \begin_layout Plain Layout
17085 ] Whether fragile commands in this style should be
17086 \begin_inset Flex Code
17089 \begin_layout Plain Layout
17103 whether this command should itself be protected.)
17104 \change_inserted -712698321 1523696949
17108 \begin_layout Description
17110 \change_inserted -712698321 1552395557
17111 \begin_inset Flex Code
17114 \begin_layout Plain Layout
17116 \change_inserted -712698321 1523696950
17125 \begin_inset Flex Code
17128 \begin_layout Plain Layout
17130 \change_inserted -712698321 1523696950
17141 \begin_inset space \thinspace{}
17145 \begin_inset Flex Code
17148 \begin_layout Plain Layout
17150 \change_inserted -712698321 1523696950
17158 ] This causes macros that contain this layout to be protected with
17159 \begin_inset Flex Code
17162 \begin_layout Plain Layout
17164 \change_inserted -712698321 1523696950
17179 ) if necessary and thus allows (some) verbatim stuff in macros.
17182 \begin_layout Description
17184 \change_inserted -712698321 1552395844
17185 \begin_inset Flex Code
17188 \begin_layout Plain Layout
17190 \change_inserted -712698321 1552395561
17199 \begin_inset Flex Code
17202 \begin_layout Plain Layout
17204 \change_inserted -712698321 1552395557
17215 \begin_inset space \thinspace{}
17219 \begin_inset Flex Code
17222 \begin_layout Plain Layout
17224 \change_inserted -712698321 1552395557
17232 ] Whether specific commands in this style (such as
17233 \begin_inset Flex Code
17236 \begin_layout Plain Layout
17238 \change_inserted -712698321 1552395655
17249 \begin_inset Flex Code
17252 \begin_layout Plain Layout
17254 \change_inserted -712698321 1552395661
17264 ) should be protected in an
17265 \begin_inset Flex Code
17268 \begin_layout Plain Layout
17270 \change_inserted -712698321 1552395631
17281 This is particularly needed for styles that draw on
17289 commands which parse their content in complex ways.
17294 \begin_layout Description
17295 \begin_inset Flex Code
17298 \begin_layout Plain Layout
17305 \begin_inset Flex Code
17308 \begin_layout Plain Layout
17315 \begin_inset space \thinspace{}
17319 \begin_inset Flex Code
17322 \begin_layout Plain Layout
17330 ] Whether newlines are translated into \SpecialChar LaTeX
17332 \begin_inset Flex Code
17335 \begin_layout Plain Layout
17346 The translation can be switched off to allow more comfortable \SpecialChar LaTeX
17347 editing inside \SpecialChar LyX
17351 \begin_layout Description
17352 \begin_inset Flex Code
17355 \begin_layout Plain Layout
17362 \begin_inset Flex Code
17365 \begin_layout Plain Layout
17374 \begin_inset space \thinspace{}
17378 \begin_inset Flex Code
17381 \begin_layout Plain Layout
17389 \begin_inset Flex Code
17392 \begin_layout Plain Layout
17399 \begin_inset Flex Code
17402 \begin_layout Plain Layout
17408 ) paragraphs are being indented,
17409 then the indentation of such a paragraph following one of this type will be suppressed.
17410 (So this will not affect the display of non-default paragraphs.)
17413 \begin_layout Description
17414 \begin_inset Flex Code
17417 \begin_layout Plain Layout
17424 \begin_inset Flex Code
17427 \begin_layout Plain Layout
17433 ] Name of a style that has replaced this style.
17434 This is used to rename a style,
17435 while keeping backward compatibility.
17438 \begin_layout Description
17439 \begin_inset Flex Code
17442 \begin_layout Plain Layout
17449 \begin_inset Flex Code
17452 \begin_layout Plain Layout
17459 \begin_inset space \thinspace{}
17463 \begin_inset Flex Code
17466 \begin_layout Plain Layout
17472 ] Determines whether consecutive paragraphs of the same type are treated as belonging together.
17473 This has the effect that the
17474 \begin_inset Flex Code
17477 \begin_layout Plain Layout
17483 is only printed once before such a group.
17486 \begin_inset Flex Code
17489 \begin_layout Plain Layout
17496 \begin_inset Flex Code
17499 \begin_layout Plain Layout
17506 \begin_inset Flex Code
17509 \begin_layout Plain Layout
17515 and false for all other types.
17518 \begin_layout Description
17519 \begin_inset Flex Code
17522 \begin_layout Plain Layout
17529 \begin_inset Flex Code
17532 \begin_layout Plain Layout
17541 \begin_inset space \thinspace{}
17545 \begin_inset Flex Code
17548 \begin_layout Plain Layout
17554 ] Indicates that paragraphs will not be separated by an empty line in \SpecialChar LaTeX
17556 but only by a line break;
17558 \begin_inset Flex Code
17561 \begin_layout Plain Layout
17568 this allows to emulate a plain text editor (like the ERT inset).
17571 \begin_layout Description
17572 \begin_inset Flex Code
17575 \begin_layout Plain Layout
17582 \begin_inset Flex Code
17585 \begin_layout Plain Layout
17591 ] The indent of the very first line of a paragraph.
17593 \begin_inset Newline newline
17597 \begin_inset Flex Code
17600 \begin_layout Plain Layout
17606 will be fixed for a certain style.
17607 The exception is the default style,
17608 since the indentation for these paragraphs can be prohibited with
17609 \begin_inset Flex Code
17612 \begin_layout Plain Layout
17621 \begin_inset Flex Code
17624 \begin_layout Plain Layout
17630 style paragraphs inside environments use the
17631 \begin_inset Flex Code
17634 \begin_layout Plain Layout
17640 of the environment,
17641 not their native one.
17644 \begin_inset Flex Code
17647 \begin_layout Plain Layout
17653 paragraphs inside an enumeration are not indented.
17656 \begin_layout Description
17657 \begin_inset Flex Code
17660 \begin_layout Plain Layout
17667 \begin_inset Flex Code
17670 \begin_layout Plain Layout
17676 ] The vertical space between two paragraphs of this style.
17679 \begin_layout Description
17680 \begin_inset Flex Code
17683 \begin_layout Plain Layout
17690 \begin_inset Flex Code
17693 \begin_layout Plain Layout
17700 allows the user to choose either
17701 \begin_inset Quotes eld
17705 \begin_inset Quotes erd
17709 \begin_inset Quotes eld
17713 \begin_inset Quotes erd
17716 to separate paragraphs.
17718 \begin_inset Quotes eld
17722 \begin_inset Quotes erd
17727 \begin_inset Flex Code
17730 \begin_layout Plain Layout
17738 \begin_inset Quotes eld
17742 \begin_inset Quotes erd
17747 \begin_inset Flex Code
17750 \begin_layout Plain Layout
17756 is ignored and all paragraphs are separated by the
17757 \begin_inset Flex Code
17760 \begin_layout Plain Layout
17767 The vertical space is calculated with
17768 \begin_inset Flex Code
17771 \begin_layout Plain Layout
17773 \begin_inset space ~
17782 \begin_inset Flex Code
17785 \begin_layout Plain Layout
17791 is the height of a row with the normal font.
17793 the look stays the same with different screen fonts.
17796 \begin_layout Description
17797 \begin_inset Flex Code
17800 \begin_layout Plain Layout
17807 \begin_inset Flex Code
17810 \begin_layout Plain Layout
17819 \begin_inset space \thinspace{}
17823 \begin_inset Flex Code
17826 \begin_layout Plain Layout
17832 ] Whether the contents of this paragraph should be output in raw form,
17833 meaning without special translations that \SpecialChar LaTeX
17837 \begin_layout Description
17838 \begin_inset Flex Code
17841 \begin_layout Plain Layout
17848 \begin_inset Flex Code
17851 \begin_layout Plain Layout
17861 Defines individual characters that should be output in raw form,
17862 meaning without special translations that \SpecialChar LaTeX
17866 \begin_layout Description
17867 \begin_inset Flex Code
17870 \begin_layout Plain Layout
17876 Information to be included in the \SpecialChar LaTeX
17877 preamble when this style is used.
17878 Used to define macros,
17881 required by this particular style.
17883 \begin_inset Quotes eld
17887 \begin_inset Flex Code
17890 \begin_layout Plain Layout
17897 \begin_inset Quotes erd
17903 \begin_layout Description
17904 \begin_inset Flex Code
17907 \begin_layout Plain Layout
17914 \begin_inset Flex Code
17917 \begin_layout Plain Layout
17923 ] The prefix to use when creating labels referring to paragraphs of this type.
17924 This allows the use of formatted references.
17927 \begin_layout Description
17928 \begin_inset Flex Code
17931 \begin_layout Plain Layout
17938 \begin_inset Flex Code
17941 \begin_layout Plain Layout
17947 ] Whether the style requires the feature
17948 \begin_inset Flex Code
17951 \begin_layout Plain Layout
17958 \begin_inset CommandInset ref
17960 reference "chap:List-of-functions"
17964 for the list of features).
17965 If you require a package with specific options,
17966 you can additionally use
17967 \begin_inset Flex Code
17970 \begin_layout Plain Layout
17976 as a general text class parameter (see
17977 \begin_inset CommandInset ref
17979 reference "subsec:General-text-class"
17986 \begin_layout Description
17987 \begin_inset Flex Code
17990 \begin_layout Plain Layout
17997 \begin_inset Flex Code
18000 \begin_layout Plain Layout
18009 \begin_inset Flex Code
18012 \begin_layout Plain Layout
18018 ] Resets the \SpecialChar LaTeX
18019 arguments of this style (as defined via the
18020 \begin_inset Flex Code
18023 \begin_layout Plain Layout
18030 This is useful if you have copied a style via
18031 \begin_inset Flex Code
18034 \begin_layout Plain Layout
18041 but you do not want to inherit its (required and optional) arguments.
18044 \begin_layout Description
18045 \begin_inset Flex Code
18048 \begin_layout Plain Layout
18055 \begin_inset Flex Code
18058 \begin_layout Plain Layout
18067 \begin_inset Flex Code
18070 \begin_layout Plain Layout
18076 ] Resumes a counter that is usually reset at each new sequence of layouts.
18077 This is currently only useful when
18078 \begin_inset Flex Code
18081 \begin_layout Plain Layout
18088 \begin_inset Flex Code
18091 \begin_layout Plain Layout
18100 \begin_layout Description
18101 \begin_inset Flex Code
18104 \begin_layout Plain Layout
18111 \begin_inset Flex Code
18114 \begin_layout Plain Layout
18120 ] A string that is put at the end of the layout content.
18121 A line break in the output can be indicated by
18122 \begin_inset Flex Code
18125 \begin_layout Plain Layout
18134 \begin_layout Description
18135 \begin_inset Flex Code
18138 \begin_layout Plain Layout
18145 \begin_inset Flex Code
18148 \begin_layout Plain Layout
18155 \begin_inset Flex Code
18158 \begin_layout Plain Layout
18167 \begin_layout Description
18168 \begin_inset Flex Code
18171 \begin_layout Plain Layout
18178 \begin_inset Flex Code
18181 \begin_layout Plain Layout
18191 \begin_inset Flex Code
18194 \begin_layout Plain Layout
18202 \begin_inset Flex Code
18205 \begin_layout Plain Layout
18213 \begin_inset Flex Code
18216 \begin_layout Plain Layout
18218 \begin_inset space ~
18226 ] This defines what the default spacing should be in the style.
18228 \begin_inset Flex Code
18231 \begin_layout Plain Layout
18239 \begin_inset Flex Code
18242 \begin_layout Plain Layout
18249 \begin_inset Flex Code
18252 \begin_layout Plain Layout
18258 correspond respectively to a multiplier value of 1,
18260 If you specify the argument
18261 \begin_inset Flex Code
18264 \begin_layout Plain Layout
18271 then you must also provide a value argument which will be the actual multiplier value.
18273 contrary to other parameters,
18275 \begin_inset Flex Code
18278 \begin_layout Plain Layout
18284 implies the generation of specific \SpecialChar LaTeX
18286 using the \SpecialChar LaTeX
18290 \begin_inset Flex Code
18293 \begin_layout Plain Layout
18302 \begin_layout Description
18303 \begin_inset Flex Code
18306 \begin_layout Plain Layout
18313 \begin_inset Flex Code
18316 \begin_layout Plain Layout
18323 \begin_inset space \thinspace{}
18327 \begin_inset Flex Code
18330 \begin_layout Plain Layout
18338 ] Allow spell-checking paragraphs of this style.
18342 \begin_layout Description
18343 \begin_inset Flex Code
18346 \begin_layout Plain Layout
18348 \change_deleted 731793113 1604355211
18350 \change_inserted 731793113 1604355212
18359 \begin_inset Flex Code
18362 \begin_layout Plain Layout
18371 \begin_inset Flex Code
18374 \begin_layout Plain Layout
18381 \change_deleted 731793113 1604355214
18383 \change_inserted 731793113 1604355216
18386 counter of a given counter at the beginning of a new sequence of layouts.
18387 This is currently only useful when
18388 \begin_inset Flex Code
18391 \begin_layout Plain Layout
18398 \begin_inset Flex Code
18401 \begin_layout Plain Layout
18410 \begin_layout Description
18411 \begin_inset Flex Code
18414 \begin_layout Plain Layout
18420 The font used for the text body .
18422 \begin_inset CommandInset ref
18424 reference "subsec:Font-description"
18431 \begin_layout Description
18432 \begin_inset Flex Code
18435 \begin_layout Plain Layout
18444 \begin_inset Flex Code
18447 \begin_layout Plain Layout
18457 The level of the style in the table of contents.
18458 This is used for automatic numbering of section headings.
18461 \begin_layout Description
18462 \begin_inset Flex Code
18465 \begin_layout Plain Layout
18474 \begin_inset Flex Code
18477 \begin_layout Plain Layout
18489 \begin_inset Flex Code
18492 \begin_layout Plain Layout
18500 \begin_inset Flex Code
18503 \begin_layout Plain Layout
18509 ] This tag determines whether the first line indentation of this paragraph can be toggled via the Paragraph settings dialog.
18513 \begin_inset Flex Code
18516 \begin_layout Plain Layout
18527 indentation can be toggled if the document settings use
18528 \begin_inset Quotes eld
18532 \begin_inset Quotes erd
18537 \begin_inset Flex Code
18540 \begin_layout Plain Layout
18547 indentation can always be toggled,
18548 notwithstanding the document settings,
18550 \begin_inset Flex Code
18553 \begin_layout Plain Layout
18560 indentation can never be toggled.
18563 \begin_layout Description
18564 \begin_inset Flex Code
18567 \begin_layout Plain Layout
18574 \begin_inset Flex Code
18577 \begin_layout Plain Layout
18583 ] The vertical space with which the very first of a chain of paragraphs with this style is separated from the previous paragraph.
18584 If the previous paragraph has another style,
18585 the separations are not simply added,
18586 but the maximum is taken.
18589 \begin_layout Subsection
18590 \begin_inset CommandInset label
18596 Internationalization of Paragraph Styles
18599 \begin_layout Standard
18601 has long supported internationalization of layout information,
18604 this applied only to the user interface and not to,
18608 French authors were forced to resort to ugly hacks if they wanted `
18612 1' instead of `Theorem 1'.
18613 Thanks to Georg Baum,
18614 that is no longer the case.
18617 \begin_layout Standard
18619 \begin_inset Flex Code
18622 \begin_layout Plain Layout
18628 defines text that is to appear in the typeset document,
18630 \begin_inset Flex Code
18633 \begin_layout Plain Layout
18640 \begin_inset Flex Code
18643 \begin_layout Plain Layout
18649 to support non-English and even multi-language documents correctly.
18650 The following excerpt (from the
18651 \begin_inset Flex Code
18654 \begin_layout Plain Layout
18660 file) shows how this works:
18663 \begin_layout LyX-Code
18668 \begin_layout LyX-Code
18671 theoremstyle{remark}
18674 \begin_layout LyX-Code
18677 newtheorem{claim}[thm]{
18684 \begin_layout LyX-Code
18688 \begin_layout LyX-Code
18692 \begin_layout LyX-Code
18697 claimname}{_(Claim)}
18700 \begin_layout LyX-Code
18704 \begin_layout LyX-Code
18708 \begin_layout LyX-Code
18717 claimname}{_(Claim)}}
18720 \begin_layout LyX-Code
18725 \begin_layout Standard
18727 any legal \SpecialChar LaTeX
18729 \begin_inset Flex Code
18732 \begin_layout Plain Layout
18739 \begin_inset Flex Code
18742 \begin_layout Plain Layout
18749 but in practice they will typically look as they do here.
18750 The key to correct translation of the typeset text is the definition of the \SpecialChar LaTeX
18752 \begin_inset Flex Code
18755 \begin_layout Plain Layout
18764 \begin_inset Flex Code
18767 \begin_layout Plain Layout
18779 \begin_layout Standard
18781 \begin_inset Flex Code
18784 \begin_layout Plain Layout
18790 tag provides for internationalization based upon the overall language of the document.
18791 The contents of the tag will be included in the preamble,
18793 \begin_inset Flex Code
18796 \begin_layout Plain Layout
18803 What makes it special is the use of the
18804 \begin_inset Quotes eld
18808 \begin_inset Quotes erd
18812 \begin_inset Flex Code
18815 \begin_layout Plain Layout
18822 which will be replaced,
18823 when \SpecialChar LyX
18824 produces \SpecialChar LaTeX
18826 with the translation of its argument into the document language.
18829 \begin_layout Standard
18831 \begin_inset Flex Code
18834 \begin_layout Plain Layout
18840 tag is more complex,
18841 since it is meant to provide support for multi-language documents and so offers an interface to the
18842 \begin_inset Flex Code
18845 \begin_layout Plain Layout
18852 Its contents will be added to the preamble once for each language that appears in the document.
18855 \begin_inset Flex Code
18858 \begin_layout Plain Layout
18864 will be replaced with its translation into the language in question;
18866 \begin_inset Flex Code
18869 \begin_layout Plain Layout
18875 is replaced by the language name (as used by the babel package).
18878 \begin_layout Standard
18879 A German document that also included a French section would thus have the following in the preamble:
18882 \begin_layout LyX-Code
18891 claimname}{Affirmation}}
18892 \begin_inset Newline newline
18903 claimname}{Behauptung}}
18904 \begin_inset Newline newline
18911 claimname}{Behauptung}
18914 \begin_layout Standard
18917 \begin_inset Flex Code
18920 \begin_layout Plain Layout
18926 will then conspire to produce the correct text in the output.
18929 \begin_layout Standard
18930 One important point to note here is that the translations are provided by \SpecialChar LyX
18933 \begin_inset Flex Code
18936 \begin_layout Plain Layout
18946 \begin_inset Flex Code
18949 \begin_layout Plain Layout
18956 \begin_inset Flex Code
18959 \begin_layout Plain Layout
18965 are really only of use in layout files that are provided with \SpecialChar LyX
18967 since text entered in user-created layout files will not be seen by \SpecialChar LyX
18968 's internationalization routines unless the
18969 \begin_inset Flex Code
18972 \begin_layout Plain Layout
18978 file is modified accordingly.
18981 any layout created with the intention that it will be included with \SpecialChar LyX
18982 should use these tags where appropriate.
18983 Please note that the paragraph style translations provided by \SpecialChar LyX
18984 will never change with a minor update (e.
18985 \begin_inset space \thinspace{}
18989 \begin_inset space \space{}
18992 from version 2.1.x to 2.1.y).
18993 It is however quite likely that a major update (e.
18994 \begin_inset space \thinspace{}
18998 \begin_inset space \space{}
19001 from 2.0.x to 2.1.0) will introduce new translations or corrections.
19004 \begin_layout Subsection
19006 \begin_inset CommandInset label
19008 name "subsec:Floats"
19015 \begin_layout Standard
19016 It is necessary to define the floats (
19017 \begin_inset Flex Noun
19020 \begin_layout Plain Layout
19028 \begin_inset Flex Noun
19031 \begin_layout Plain Layout
19039 ) in the text class itself.
19040 Standard floats are included in the file
19041 \begin_inset Flex Code
19044 \begin_layout Plain Layout
19051 so you may have to do no more than add
19054 \begin_layout LyX-Code
19055 Input stdfloats.inc
19058 \begin_layout Standard
19059 to your layout file.
19060 If you want to implement a text class that proposes some other float types (like the AGU class bundled with \SpecialChar LyX
19062 the information below will hopefully help you:
19065 \begin_layout Description
19066 \begin_inset Flex Code
19069 \begin_layout Plain Layout
19076 \begin_inset Flex Code
19079 \begin_layout Plain Layout
19085 =!htbpH] Allowed placement options for this float type.
19086 The value is a string of placement characters.
19087 Possible characters include:
19093 \begin_inset Quotes eld
19097 \begin_inset Quotes erd
19106 \begin_inset Quotes eld
19110 \begin_inset Quotes erd
19119 \begin_inset Quotes eld
19123 \begin_inset Quotes erd
19132 \begin_inset Quotes eld
19136 \begin_inset Quotes erd
19145 \begin_inset Quotes eld
19149 \begin_inset Quotes erd
19158 \begin_inset Quotes eld
19162 \begin_inset Quotes erd
19166 The order of the characters in the string does not matter.
19167 If no placement options are allowed,
19175 \begin_layout Description
19176 \begin_inset Flex Code
19179 \begin_layout Plain Layout
19186 \begin_inset Flex Code
19189 \begin_layout Plain Layout
19198 \begin_inset space \thinspace{}
19204 \begin_inset Flex Code
19207 \begin_layout Plain Layout
19217 ] Defines whether the float allows to be rotated via the \SpecialChar LaTeX
19224 \begin_inset Flex Code
19227 \begin_layout Plain Layout
19233 if the float does not support this feature.
19236 \begin_layout Description
19237 \begin_inset Flex Code
19240 \begin_layout Plain Layout
19247 \begin_inset Flex Code
19250 \begin_layout Plain Layout
19259 \begin_inset space \thinspace{}
19265 \begin_inset Flex Code
19268 \begin_layout Plain Layout
19278 ] Defines whether the float has a starred variant that spans columns in a two column paragraph.
19280 \begin_inset Flex Code
19283 \begin_layout Plain Layout
19289 if the float does not support this feature.
19292 \begin_layout Description
19293 \begin_inset Flex Code
19296 \begin_layout Plain Layout
19303 \begin_inset Flex Code
19306 \begin_layout Plain Layout
19313 \begin_inset Quotes erd
19317 \begin_inset Quotes erd
19320 ] The file name extension of an auxiliary file for the list of figures (or whatever).
19322 writes the captions to this file.
19325 \begin_layout Description
19326 \begin_inset Flex Code
19329 \begin_layout Plain Layout
19336 \begin_inset Flex Code
19339 \begin_layout Plain Layout
19346 \begin_inset Quotes erd
19350 \begin_inset Quotes erd
19353 ] The string that will be used in the menus and also for the caption.
19354 This is translated to the current language if babel is used.
19357 \begin_layout Description
19358 \begin_inset Flex Code
19361 \begin_layout Plain Layout
19367 These tags control the XHTML output.
19369 \begin_inset CommandInset ref
19371 reference "sec:Tags-for-XHTML"
19378 \begin_layout Description
19379 \begin_inset Flex Code
19382 \begin_layout Plain Layout
19391 \begin_inset Flex Code
19394 \begin_layout Plain Layout
19403 \begin_inset space \thinspace{}
19407 \begin_inset Flex Code
19410 \begin_layout Plain Layout
19416 ] Indicates whether the float is already defined in the document class or if instead the \SpecialChar LaTeX
19418 \begin_inset Flex Code
19421 \begin_layout Plain Layout
19427 needs to be loaded to define it on-the-fly.
19429 \begin_inset Flex Code
19432 \begin_layout Plain Layout
19441 \begin_inset Flex Code
19444 \begin_layout Plain Layout
19451 It should be set to
19452 \begin_inset Flex Code
19455 \begin_layout Plain Layout
19461 if the float is already defined by the \SpecialChar LaTeX
19465 \begin_layout Description
19466 \begin_inset Flex Code
19469 \begin_layout Plain Layout
19476 \begin_inset Flex Code
19479 \begin_layout Plain Layout
19486 \begin_inset Quotes erd
19490 \begin_inset Quotes erd
19493 ] The command used to generate a list of floats of this type;
19502 \begin_inset Flex Code
19505 \begin_layout Plain Layout
19512 since there is no standard way to generate this command.
19514 \begin_inset Flex Code
19517 \begin_layout Plain Layout
19524 since in that case there is a standard way to define the command.
19527 \begin_layout Description
19528 \begin_inset Flex Code
19531 \begin_layout Plain Layout
19538 \begin_inset Flex Code
19541 \begin_layout Plain Layout
19548 \begin_inset Quotes erd
19552 \begin_inset Quotes erd
19555 ] A title for a list of floats of this kind (list of figures,
19558 It is used for the screen label within \SpecialChar LyX
19560 it is used by \SpecialChar LaTeX
19561 for the title and it is used as the title in the XHTML output.
19562 It will be translated to the document language.
19565 \begin_layout Description
19566 \begin_inset Flex Code
19569 \begin_layout Plain Layout
19576 \begin_inset Flex Code
19579 \begin_layout Plain Layout
19586 \begin_inset Quotes erd
19590 \begin_inset Quotes erd
19593 ] This (optional) argument determines whether floats of this class will be numbered within some sectional unit of the document.
19596 \begin_inset Flex Code
19599 \begin_layout Plain Layout
19606 \begin_inset Quotes eld
19610 \begin_inset Flex Code
19613 \begin_layout Plain Layout
19620 \begin_inset Quotes erd
19624 the floats will be numbered within chapters.
19628 \begin_layout Description
19629 \begin_inset Flex Code
19632 \begin_layout Plain Layout
19639 \begin_inset Flex Code
19642 \begin_layout Plain Layout
19649 \begin_inset Quotes erd
19653 \begin_inset Quotes erd
19656 ] The default placement for the given class of floats.
19657 The string should be as in standard \SpecialChar LaTeX
19660 \begin_inset Flex Code
19663 \begin_layout Plain Layout
19671 \begin_inset Flex Code
19674 \begin_layout Plain Layout
19682 \begin_inset Flex Code
19685 \begin_layout Plain Layout
19692 \begin_inset Flex Code
19695 \begin_layout Plain Layout
19709 \begin_layout Plain Layout
19710 Note that the order of these letters in the string is irrelevant,
19711 like in \SpecialChar LaTeX
19717 On top of that there is a new type,
19719 \begin_inset Flex Code
19722 \begin_layout Plain Layout
19729 which does not really correspond to a float,
19732 \begin_inset Quotes eld
19736 \begin_inset Quotes erd
19740 Note however that the
19741 \begin_inset Flex Code
19744 \begin_layout Plain Layout
19750 specifier is special and,
19751 because of implementation details,
19752 cannot be used in non-built in float types.
19753 If you do not understand what this means,
19755 \begin_inset Quotes eld
19759 \begin_inset Flex Code
19762 \begin_layout Plain Layout
19769 \begin_inset Quotes erd
19775 \begin_layout Description
19776 \begin_inset Flex Code
19779 \begin_layout Plain Layout
19786 \begin_inset Flex Code
19789 \begin_layout Plain Layout
19795 ] The prefix to use when creating labels referring to floats of this type.
19796 This allows the use of formatted references.
19797 Note that you can remove any
19798 \begin_inset Flex Code
19801 \begin_layout Plain Layout
19807 set by a copied style by using the special value
19808 \begin_inset Quotes eld
19812 \begin_inset Quotes erd
19816 which must be all caps.
19817 \change_inserted -712698321 1565605014
19821 \begin_layout Description
19823 \change_inserted -712698321 1565605014
19824 \begin_inset Flex Code
19827 \begin_layout Plain Layout
19829 \change_inserted -712698321 1565605014
19838 \begin_inset Flex Code
19841 \begin_layout Plain Layout
19843 \change_inserted -712698321 1565605014
19851 ] As with paragraph styles,
19853 \begin_inset CommandInset ref
19855 reference "subsec:Paragraph-Styles"
19864 \begin_layout Description
19865 \begin_inset Flex Code
19868 \begin_layout Plain Layout
19875 \begin_inset Flex Code
19878 \begin_layout Plain Layout
19885 \begin_inset Quotes erd
19889 \begin_inset Quotes erd
19892 ] The style used when defining the float using
19893 \begin_inset Flex Code
19896 \begin_layout Plain Layout
19907 \begin_layout Description
19908 \begin_inset Flex Code
19911 \begin_layout Plain Layout
19918 \begin_inset Flex Code
19921 \begin_layout Plain Layout
19928 \begin_inset Quotes erd
19932 \begin_inset Quotes erd
19936 \begin_inset Quotes eld
19940 \begin_inset Quotes erd
19943 of the new class of floats,
19944 like program or algorithm.
19945 After the appropriate
19946 \begin_inset Flex Code
19949 \begin_layout Plain Layout
19959 \begin_inset Flex Code
19962 \begin_layout Plain Layout
19971 \begin_inset Flex Code
19974 \begin_layout Plain Layout
19985 \begin_layout Description
19986 \begin_inset Flex Code
19989 \begin_layout Plain Layout
19996 \begin_inset Flex Code
19999 \begin_layout Plain Layout
20006 \begin_inset space \thinspace{}
20010 \begin_inset Flex Code
20013 \begin_layout Plain Layout
20021 ] Specifies whether this float is defined using the \SpecialChar LaTeX
20023 \begin_inset Flex Code
20026 \begin_layout Plain Layout
20033 either by the class file,
20034 another package or on-the-fly by \SpecialChar LyX
20038 \begin_layout Standard
20039 Note that defining a float with type
20040 \begin_inset Flex Code
20043 \begin_layout Plain Layout
20051 automatically defines the corresponding counter with name
20052 \begin_inset Flex Code
20055 \begin_layout Plain Layout
20066 \begin_layout Subsection
20067 Flex insets and InsetLayout
20068 \begin_inset CommandInset label
20070 name "subsec:Flex-insets-and"
20077 \begin_layout Standard
20078 Flex insets come in
20079 \change_deleted 5863208 1594239511
20081 \change_inserted 5863208 1594239512
20088 \begin_layout Itemize
20090 \begin_inset Flex Code
20093 \begin_layout Plain Layout
20100 These define semantic markup corresponding to such \SpecialChar LaTeX
20102 \begin_inset Flex Code
20105 \begin_layout Plain Layout
20114 \begin_inset Flex Code
20117 \begin_layout Plain Layout
20128 \begin_layout Itemize
20130 \begin_inset Flex Code
20133 \begin_layout Plain Layout
20140 These can be used to define custom collapsible insets,
20141 similar to \SpecialChar TeX
20145 An obvious example is an endnote inset,
20146 which is defined in the
20147 \begin_inset Flex Code
20150 \begin_layout Plain Layout
20159 \begin_layout Itemize
20161 \change_deleted 5863208 1594239528
20163 \begin_inset Flex Code
20166 \begin_layout Plain Layout
20173 For use with DocBook classes.
20178 \begin_layout Standard
20179 Flex insets are defined using the
20180 \begin_inset Flex Code
20183 \begin_layout Plain Layout
20190 which shall be explained in a moment.
20193 \begin_layout Standard
20195 \begin_inset Flex Code
20198 \begin_layout Plain Layout
20204 tag also serves another function:
20205 It can be used to customize the general layout of many different types of insets.
20208 \begin_inset Flex Code
20211 \begin_layout Plain Layout
20217 can be used to customize the layout parameters for footnotes,
20230 as well as to define Flex insets.
20233 \begin_layout Standard
20235 \begin_inset Flex Code
20238 \begin_layout Plain Layout
20244 definition must begin with a line of the form:
20247 \begin_layout LyX-Code
20251 \begin_layout Standard
20253 \begin_inset Flex Code
20256 \begin_layout Plain Layout
20262 indicates the inset whose layout is being defined,
20263 and here there are four cases.
20266 \begin_layout Enumerate
20267 The layout for a pre-existing inset is being modified.
20270 \begin_inset Flex Code
20273 \begin_layout Plain Layout
20279 any one of the following:
20281 \begin_inset Flex Code
20284 \begin_layout Plain Layout
20292 \begin_inset Flex Code
20295 \begin_layout Plain Layout
20303 \begin_inset Flex Code
20306 \begin_layout Plain Layout
20314 \begin_inset Flex Code
20317 \begin_layout Plain Layout
20325 \begin_inset Flex Code
20328 \begin_layout Plain Layout
20336 \begin_inset Flex Code
20339 \begin_layout Plain Layout
20347 \begin_inset Flex Code
20350 \begin_layout Plain Layout
20358 \begin_inset Flex Code
20361 \begin_layout Plain Layout
20369 \begin_inset Flex Code
20372 \begin_layout Plain Layout
20380 \begin_inset Flex Code
20383 \begin_layout Plain Layout
20391 \begin_inset Flex Code
20394 \begin_layout Plain Layout
20402 \begin_inset Flex Code
20405 \begin_layout Plain Layout
20413 \begin_inset Flex Code
20416 \begin_layout Plain Layout
20424 \begin_inset Flex Code
20427 \begin_layout Plain Layout
20435 \begin_inset Flex Code
20438 \begin_layout Plain Layout
20446 \begin_inset Flex Code
20449 \begin_layout Plain Layout
20457 \begin_inset Flex Code
20460 \begin_layout Plain Layout
20468 \begin_inset Flex Code
20471 \begin_layout Plain Layout
20479 \begin_inset Flex Code
20482 \begin_layout Plain Layout
20490 \begin_inset Flex Code
20493 \begin_layout Plain Layout
20502 \begin_layout Enumerate
20503 The layout for a Flex inset is being defined.
20506 \begin_inset Flex Code
20509 \begin_layout Plain Layout
20515 must be of the form
20516 \begin_inset Quotes eld
20520 \begin_inset Flex Code
20523 \begin_layout Plain Layout
20530 \begin_inset Quotes erd
20535 \begin_inset Flex Code
20538 \begin_layout Plain Layout
20544 may be any valid identifier not used by a pre-existing Flex inset.
20545 The identifier may include spaces,
20546 but in that case the whole thing must be wrapped in quotes.
20547 Note that the definition of a flex inset
20552 \begin_inset Flex Code
20555 \begin_layout Plain Layout
20562 declaring which type of inset it defines.
20565 \begin_layout Enumerate
20566 The layout for user specific branch is being defined.
20569 \begin_inset Flex Code
20572 \begin_layout Plain Layout
20578 must be of the form
20579 \begin_inset Quotes eld
20583 \begin_inset Flex Code
20586 \begin_layout Plain Layout
20593 \begin_inset Quotes erd
20598 \begin_inset Flex Code
20601 \begin_layout Plain Layout
20607 may be any valid identifier of branch defined in user's document.
20608 The identifier may include spaces,
20609 but in that case the whole thing must be wrapped in quotes.
20610 The main purpose of this feature is to allow \SpecialChar LaTeX
20611 wrapping around specific branches as user needs.
20614 \begin_layout Enumerate
20615 The layout of a user (or class) specific caption is being defined.
20618 \begin_inset Flex Code
20621 \begin_layout Plain Layout
20627 must be of the form
20628 \begin_inset Quotes eld
20632 \begin_inset Flex Code
20635 \begin_layout Plain Layout
20642 \begin_inset Quotes erd
20647 \begin_inset Flex Code
20650 \begin_layout Plain Layout
20656 specifies the name of the caption as it appears in the menu.
20657 Have a look at the standard caption (
20658 \begin_inset Flex Code
20661 \begin_layout Plain Layout
20668 the specific captions of the KOMA-Script classes (
20669 \begin_inset Flex Code
20672 \begin_layout Plain Layout
20680 \begin_inset Flex Code
20683 \begin_layout Plain Layout
20692 \begin_inset space ~
20696 \begin_inset Newline linebreak
20702 \begin_inset Flex Code
20705 \begin_layout Plain Layout
20711 ) for applications.
20714 \begin_layout Standard
20716 \begin_inset Flex Code
20719 \begin_layout Plain Layout
20725 definition can contain the following entries:
20728 \begin_layout Description
20729 \begin_inset Flex Code
20732 \begin_layout Plain Layout
20739 \begin_inset Flex Code
20742 \begin_layout Plain Layout
20748 =""] This inset will appear in the table of contents of the given type.
20749 An empty string disables.
20750 See also the OutlinerName and the IsTocCaption commands.
20751 This is only implemented for Flex insets.
20756 \begin_layout Description
20757 \begin_inset Flex Code
20760 \begin_layout Plain Layout
20767 \begin_inset Flex Code
20770 \begin_layout Plain Layout
20776 ] Defines argument number of a command\SpecialChar breakableslash
20777 environment associated with the current layout.
20778 The definition must end with
20779 \begin_inset Flex Code
20782 \begin_layout Plain Layout
20790 \change_inserted -584632292 1615846847
20792 \begin_inset CommandInset ref
20794 reference "subsec:Arguments"
20802 \change_deleted -584632292 1615846847
20804 \begin_inset CommandInset ref
20806 reference "subsec:Paragraph-Styles"
20813 \change_deleted -584632292 1615846902
20815 \change_inserted -584632292 1615846906
20821 \begin_layout Description
20822 \begin_inset Flex Code
20825 \begin_layout Plain Layout
20831 Preamble for changing language commands;
20833 \begin_inset CommandInset ref
20835 reference "subsec:I18n"
20842 \begin_layout Description
20843 \begin_inset Flex Code
20846 \begin_layout Plain Layout
20853 \begin_inset Flex Code
20856 \begin_layout Plain Layout
20862 ] The color for the inset's background.
20864 \begin_inset CommandInset ref
20866 reference "chap:Names-of-colors"
20870 for a list of the available color names.
20873 \begin_layout Description
20874 \begin_inset Flex Code
20877 \begin_layout Plain Layout
20884 \begin_inset Flex Code
20887 \begin_layout Plain Layout
20896 \begin_inset space \thinspace{}
20900 \begin_inset Flex Code
20903 \begin_layout Plain Layout
20909 ] Whether to use the content of the inset as the label,
20910 when the inset is closed.
20914 \begin_layout Description
20915 \begin_inset Flex Code
20918 \begin_layout Plain Layout
20925 \begin_inset Flex Code
20928 \begin_layout Plain Layout
20934 ] As with paragraph styles,
20936 \begin_inset CommandInset ref
20938 reference "subsec:Paragraph-Styles"
20943 Note that you need to specify the complete type,
20945 \begin_inset space \thinspace{}
20949 \begin_inset space ~
20953 \begin_inset Flex Code
20956 \begin_layout Plain Layout
20957 CopyStyle Flex:<name>
20965 \begin_layout Description
20966 \begin_inset Flex Code
20969 \begin_layout Plain Layout
20976 \begin_inset Flex Code
20979 \begin_layout Plain Layout
20988 \begin_inset space \thinspace{}
20992 \begin_inset Flex Code
20995 \begin_layout Plain Layout
21001 ] Indicates whether the user may employ the Paragraph Settings dialog to customize the paragraph.
21004 \begin_layout Description
21005 \begin_inset Flex Code
21008 \begin_layout Plain Layout
21015 \begin_inset Flex Code
21018 \begin_layout Plain Layout
21026 \begin_inset Flex Code
21029 \begin_layout Plain Layout
21037 \begin_inset Flex Code
21040 \begin_layout Plain Layout
21047 describing the rendering style used for the inset's frame and buttons.
21048 Footnotes generally use
21049 \begin_inset Flex Code
21052 \begin_layout Plain Layout
21059 ERT insets generally
21060 \begin_inset Flex Code
21063 \begin_layout Plain Layout
21070 and character styles
21071 \begin_inset Flex Code
21074 \begin_layout Plain Layout
21083 \begin_layout Description
21084 \begin_inset Flex Code
21087 \begin_layout Plain Layout
21094 \begin_inset Flex Code
21097 \begin_layout Plain Layout
21106 \begin_inset space \thinspace{}
21112 \begin_inset Flex Code
21115 \begin_layout Plain Layout
21124 \begin_inset Flex Code
21127 \begin_layout Plain Layout
21134 \begin_inset Flex Code
21137 \begin_layout Plain Layout
21144 Indicates whether the environment will stand on its own in the output or will appear inline with the surrounding text.
21146 it is supposed that the \SpecialChar LaTeX
21147 environment ignores white space (including one newline character) after the
21148 \begin_inset Flex Code
21151 \begin_layout Plain Layout
21164 \begin_inset Flex Code
21167 \begin_layout Plain Layout
21181 \change_inserted 731793113 1538674858
21185 \begin_layout Description
21187 \change_inserted 731793113 1538674891
21188 \begin_inset Flex Code
21191 \begin_layout Plain Layout
21193 \change_inserted 731793113 1538674863
21205 ,1] Allow the contents of the inset to be edited externally (using whatever editor is defined for the document's output format).
21210 \begin_layout Description
21211 \begin_inset Flex Code
21214 \begin_layout Plain Layout
21220 Required at the end of the
21221 \begin_inset Flex Code
21224 \begin_layout Plain Layout
21233 \begin_layout Description
21234 \begin_inset Flex Code
21237 \begin_layout Plain Layout
21243 The font used for both the text body
21249 \begin_inset CommandInset ref
21251 reference "subsec:Font-description"
21256 Note that defining this font automatically defines the
21257 \begin_inset Flex Code
21260 \begin_layout Plain Layout
21267 so define this first and define
21268 \begin_inset Flex Code
21271 \begin_layout Plain Layout
21277 later if you want them to be different.
21280 \begin_layout Description
21281 \begin_inset Flex Code
21284 \begin_layout Plain Layout
21285 FixedWidthPreambleEncoding
21291 \begin_inset Flex Code
21294 \begin_layout Plain Layout
21303 \begin_inset space \thinspace{}
21307 \begin_inset Flex Code
21310 \begin_layout Plain Layout
21316 ] Force a fixed width encoding for the translated contents of
21317 \begin_inset Flex Code
21320 \begin_layout Plain Layout
21327 \begin_inset Flex Code
21330 \begin_layout Plain Layout
21336 code generated by this layout.
21337 This is needed for special \SpecialChar LaTeX
21342 that do not work with variable width encodings such as
21347 This setting is ignored if fully Unicode aware \SpecialChar LaTeX
21348 backends such as Xe\SpecialChar TeX
21349 or Lua\SpecialChar TeX
21353 \begin_layout Description
21354 \begin_inset Flex Code
21357 \begin_layout Plain Layout
21358 ForceLocalFontSwitch
21364 \begin_inset Flex Code
21367 \begin_layout Plain Layout
21376 \begin_inset space \thinspace{}
21380 \begin_inset Flex Code
21383 \begin_layout Plain Layout
21389 ] When using babel,
21390 always use a local font switch (
21391 \begin_inset Flex Code
21394 \begin_layout Plain Layout
21403 never a global one (such as
21404 \begin_inset Flex Code
21407 \begin_layout Plain Layout
21418 \begin_layout Description
21419 \begin_inset Flex Code
21422 \begin_layout Plain Layout
21429 \begin_inset Flex Code
21432 \begin_layout Plain Layout
21441 \begin_inset space \thinspace{}
21445 \begin_inset Flex Code
21448 \begin_layout Plain Layout
21455 \begin_inset Quotes eld
21459 \begin_inset Quotes erd
21463 leading to Left-to-Right (Latin) output,
21465 \begin_inset space \thinspace{}
21469 \begin_inset space \space{}
21472 in \SpecialChar TeX
21477 \begin_layout Description
21478 \begin_inset Flex Code
21481 \begin_layout Plain Layout
21488 \begin_inset Flex Code
21491 \begin_layout Plain Layout
21500 \begin_inset space \thinspace{}
21504 \begin_inset Flex Code
21507 \begin_layout Plain Layout
21513 ] Force a line break in the \SpecialChar LaTeX
21514 output before the inset starts and after the inset ends.
21515 This assures the inset itself is output on its own lines,
21516 for parsing purposes.
21519 \begin_layout Description
21520 \begin_inset Flex Code
21523 \begin_layout Plain Layout
21530 \begin_inset Flex Code
21533 \begin_layout Plain Layout
21542 \begin_inset space \thinspace{}
21546 \begin_inset Flex Code
21549 \begin_layout Plain Layout
21555 ] Indicates whether the
21556 \begin_inset Flex Code
21559 \begin_layout Plain Layout
21567 the user can change the paragraph style used in the inset.
21571 \begin_layout Description
21572 \begin_inset Flex Code
21575 \begin_layout Plain Layout
21582 \begin_inset Flex Code
21585 \begin_layout Plain Layout
21594 \begin_inset space \thinspace{}
21598 \begin_inset Flex Code
21601 \begin_layout Plain Layout
21607 ] As with paragraph styles,
21609 \begin_inset CommandInset ref
21611 reference "subsec:Paragraph-Styles"
21618 \begin_layout Description
21619 \begin_inset Flex Code
21622 \begin_layout Plain Layout
21628 These tags control the XHTML output.
21630 \begin_inset CommandInset ref
21632 reference "sec:Tags-for-XHTML"
21639 \begin_layout Description
21640 \begin_inset Flex Code
21643 \begin_layout Plain Layout
21650 \begin_inset Flex Code
21653 \begin_layout Plain Layout
21662 \begin_inset space \thinspace{}
21666 \begin_inset Flex Code
21669 \begin_layout Plain Layout
21675 ] Whether to include the contents of this inset in the strings generated for the `Outline' pane for all table of contents,
21676 regardless of the AddToToc setting.
21679 want the content of a footnote in a section header to be included in the TOC displayed in the outline,
21680 but one would normally want the content of a character style displayed.
21685 \begin_layout Description
21686 \begin_inset Flex Code
21689 \begin_layout Plain Layout
21696 \begin_inset Flex Code
21699 \begin_layout Plain Layout
21708 \begin_inset space \thinspace{}
21712 \begin_inset Flex Code
21715 \begin_layout Plain Layout
21721 ] If this is set to 1 and AddToToc is enabled,
21722 the inset adds a summary of its contents in its item in the table of contents.
21724 only the label appears.
21727 \begin_layout Description
21728 \begin_inset Flex Code
21731 \begin_layout Plain Layout
21740 \begin_inset Flex Code
21743 \begin_layout Plain Layout
21752 \begin_inset space \thinspace{}
21756 \begin_inset Flex Code
21759 \begin_layout Plain Layout
21765 ] As with paragraph styles,
21767 \begin_inset CommandInset ref
21769 reference "subsec:Paragraph-Styles"
21776 \begin_layout Description
21777 \begin_inset Flex Code
21780 \begin_layout Plain Layout
21786 The font used for the label.
21788 \begin_inset CommandInset ref
21790 reference "subsec:Font-description"
21795 Note that this definition can never appear before
21796 \begin_inset Flex Code
21799 \begin_layout Plain Layout
21806 lest it be ineffective.
21809 \begin_layout Description
21810 \begin_inset Flex Code
21813 \begin_layout Plain Layout
21820 \begin_inset Flex Code
21823 \begin_layout Plain Layout
21830 \begin_inset Quotes erd
21834 \begin_inset Quotes erd
21837 ] What will be displayed on the button or elsewhere as the inset label.
21839 \begin_inset Flex Code
21842 \begin_layout Plain Layout
21850 \begin_inset Flex Code
21853 \begin_layout Plain Layout
21859 ) modify this label on the fly.
21862 \begin_layout Description
21863 \begin_inset Flex Code
21866 \begin_layout Plain Layout
21872 Language dependent preamble;
21874 \begin_inset CommandInset ref
21876 reference "subsec:I18n"
21883 \begin_layout Description
21884 \begin_inset Flex Code
21887 \begin_layout Plain Layout
21894 \begin_inset Flex Code
21897 \begin_layout Plain Layout
21903 ] The name of the corresponding \SpecialChar LaTeX
21905 Either the environment or command name.
21908 \begin_layout Description
21909 \begin_inset Flex Code
21912 \begin_layout Plain Layout
21919 \begin_inset Flex Code
21922 \begin_layout Plain Layout
21928 ] The optional parameter for the corresponding
21929 \begin_inset Flex Code
21932 \begin_layout Plain Layout
21939 including possible bracket pairs like
21940 \begin_inset Flex Code
21943 \begin_layout Plain Layout
21950 This parameter cannot be changed from within \SpecialChar LyX
21952 \begin_inset Flex Code
21955 \begin_layout Plain Layout
21961 for customizable parameters).
21962 It will be output as is after all \SpecialChar LaTeX
21964 \begin_inset Flex Code
21967 \begin_layout Plain Layout
21976 \begin_layout Description
21977 \begin_inset Flex Code
21980 \begin_layout Plain Layout
21987 \begin_inset Flex Code
21990 \begin_layout Plain Layout
21998 ] How the style should be translated into \SpecialChar LaTeX
22003 \begin_layout Plain Layout
22004 \begin_inset Flex Code
22007 \begin_layout Plain Layout
22013 is perhaps a bit misleading,
22014 since these rules apply to SGML classes too.
22015 Visit the SGML class files for specific examples.
22024 \begin_layout Description
22025 \begin_inset Flex Code
22028 \begin_layout Plain Layout
22034 means nothing special
22037 \begin_layout Description
22038 \begin_inset Flex Code
22041 \begin_layout Plain Layout
22048 \begin_inset Flex Code
22051 \begin_layout Plain Layout
22058 {\SpecialChar ldots
22067 \begin_layout Description
22068 \begin_inset Flex Code
22071 \begin_layout Plain Layout
22078 \begin_inset Flex Code
22081 \begin_layout Plain Layout
22088 }\SpecialChar ldots
22103 \begin_layout Standard
22104 Putting the last few things together,
22105 the \SpecialChar LaTeX
22106 output will be either:
22110 \begin_layout LyX-Code
22113 LatexName[LatexParam]{\SpecialChar ldots
22117 \begin_layout Standard
22122 \begin_layout LyX-Code
22125 begin{LatexName}[LatexParam] \SpecialChar ldots
22131 \begin_layout Standard
22132 depending upon the \SpecialChar LaTeX
22137 \begin_layout Description
22138 \begin_inset Flex Code
22141 \begin_layout Plain Layout
22148 \begin_inset Flex Code
22151 \begin_layout Plain Layout
22157 ] A string that is put at the beginning of the layout content.
22158 A line break in the output can be indicated by
22159 \begin_inset Flex Code
22162 \begin_layout Plain Layout
22171 \begin_layout Description
22172 \begin_inset Flex Code
22175 \begin_layout Plain Layout
22182 \begin_inset Flex Code
22185 \begin_layout Plain Layout
22193 \begin_inset Flex Code
22196 \begin_layout Plain Layout
22204 \change_deleted -584632292 1615846609
22206 \begin_inset Flex Code
22209 \begin_layout Plain Layout
22218 \begin_inset Flex Code
22221 \begin_layout Plain Layout
22227 (indicating a dummy definition ending definitions of charstyles,
22229 This entry is required in and is only meaningful for Flex insets.
22230 Among other things,
22231 it determines on which menu this inset will appear.
22233 \begin_inset Flex Code
22236 \begin_layout Plain Layout
22243 \begin_inset Flex Code
22246 \begin_layout Plain Layout
22252 will automatically set
22253 \begin_inset Flex Code
22256 \begin_layout Plain Layout
22263 \begin_inset Flex Code
22266 \begin_layout Plain Layout
22274 \begin_inset Flex Code
22277 \begin_layout Plain Layout
22283 can be set to true,
22285 \begin_inset Flex Code
22288 \begin_layout Plain Layout
22296 \begin_inset Flex Code
22299 \begin_layout Plain Layout
22305 insets by setting it
22310 \begin_inset Flex Code
22313 \begin_layout Plain Layout
22320 \change_inserted -712698321 1555575738
22324 \begin_layout Description
22326 \change_inserted -712698321 1555575844
22327 \begin_inset Flex Code
22330 \begin_layout Plain Layout
22332 \change_inserted -712698321 1555575740
22341 \begin_inset Flex Code
22344 \begin_layout Plain Layout
22346 \change_inserted -712698321 1555575740
22354 A dedicated string for the menu.
22355 You can define an accelerator by appending the respective character to the string,
22357 \begin_inset Quotes eld
22361 \begin_inset Quotes erd
22365 \begin_inset space \thinspace{}
22369 \begin_inset space \space{}
22373 \begin_inset Quotes eld
22377 \begin_inset Flex Code
22380 \begin_layout Plain Layout
22382 \change_inserted -712698321 1555575781
22391 \begin_inset Quotes erd
22395 This specification is optional.
22396 If it is not given the inset name as specified in the type declaration will be used instead for the menu.
22401 \begin_layout Description
22402 \begin_inset Flex Code
22405 \begin_layout Plain Layout
22412 \begin_inset Flex Code
22415 \begin_layout Plain Layout
22424 \begin_inset space \thinspace{}
22428 \begin_inset Flex Code
22431 \begin_layout Plain Layout
22437 ] Whether multiple paragraphs are permitted in this inset.
22439 \begin_inset Flex Code
22442 \begin_layout Plain Layout
22448 to the same value and
22449 \begin_inset Flex Code
22452 \begin_layout Plain Layout
22458 to the opposite value.
22459 These can be reset to other values,
22465 \begin_inset Flex Code
22468 \begin_layout Plain Layout
22478 \begin_layout Description
22479 \begin_inset Flex Code
22482 \begin_layout Plain Layout
22489 \begin_inset Flex Code
22492 \begin_layout Plain Layout
22501 \begin_inset space \thinspace{}
22505 \begin_inset Flex Code
22508 \begin_layout Plain Layout
22514 ] Whether fragile commands in this inset should be
22515 \begin_inset Flex Code
22518 \begin_layout Plain Layout
22532 whether the command should itself be protected.) Default is false.
22533 \change_inserted -712698321 1523633958
22537 \begin_layout Description
22539 \change_inserted -712698321 1552395786
22540 \begin_inset Flex Code
22543 \begin_layout Plain Layout
22545 \change_inserted -712698321 1523633961
22554 \begin_inset Flex Code
22557 \begin_layout Plain Layout
22559 \change_inserted -712698321 1523633958
22570 \begin_inset space \thinspace{}
22574 \begin_inset Flex Code
22577 \begin_layout Plain Layout
22579 \change_inserted -712698321 1523633958
22587 ] This causes macros that contain this inset to be protected with
22588 \begin_inset Flex Code
22591 \begin_layout Plain Layout
22593 \change_inserted -712698321 1523634038
22608 ) if necessary and thus allows (some) verbatim stuff in macros.
22612 \begin_layout Description
22614 \change_inserted -712698321 1555579651
22615 \begin_inset Flex Code
22618 \begin_layout Plain Layout
22620 \change_inserted -712698321 1552395787
22629 \begin_inset Flex Code
22632 \begin_layout Plain Layout
22634 \change_inserted -712698321 1552395787
22645 \begin_inset space \thinspace{}
22649 \begin_inset Flex Code
22652 \begin_layout Plain Layout
22654 \change_inserted -712698321 1552395787
22662 ] Whether specific commands in this inset (such as
22663 \begin_inset Flex Code
22666 \begin_layout Plain Layout
22668 \change_inserted -712698321 1552395787
22679 \begin_inset Flex Code
22682 \begin_layout Plain Layout
22684 \change_inserted -712698321 1552395787
22694 ) should be protected in an
22695 \begin_inset Flex Code
22698 \begin_layout Plain Layout
22700 \change_inserted -712698321 1552395787
22711 This is particularly needed for insets that draw on
22719 commands which parse their content in complex ways.
22723 \begin_layout Description
22725 \change_inserted -712698321 1555579742
22726 \begin_inset Flex Code
22729 \begin_layout Plain Layout
22731 \change_inserted -712698321 1555579658
22740 \begin_inset Flex Code
22743 \begin_layout Plain Layout
22745 \change_inserted -712698321 1555579651
22753 Option to define a different command (from the default
22754 \begin_inset Flex Code
22757 \begin_layout Plain Layout
22759 \change_inserted -712698321 1555579742
22771 ) to be used for line breaks.
22772 The initial backslash must not be specified.
22777 \begin_layout Description
22778 \begin_inset Flex Code
22781 \begin_layout Plain Layout
22788 \begin_inset Flex Code
22791 \begin_layout Plain Layout
22797 ] Deletes an existing
22798 \begin_inset Flex Code
22801 \begin_layout Plain Layout
22810 \begin_layout Description
22811 \begin_inset Flex Code
22814 \begin_layout Plain Layout
22821 \begin_inset Flex Code
22824 \begin_layout Plain Layout
22831 \begin_inset Flex Code
22834 \begin_layout Plain Layout
22840 that has replaced this
22841 \begin_inset Flex Code
22844 \begin_layout Plain Layout
22851 This is used to rename an
22852 \begin_inset Flex Code
22855 \begin_layout Plain Layout
22862 while keeping backward compatibility.
22863 \change_inserted -712698321 1559491850
22867 \begin_layout Description
22869 \change_inserted -712698321 1559492002
22870 \begin_inset Flex Code
22873 \begin_layout Plain Layout
22875 \change_inserted -712698321 1559491854
22884 \begin_inset Flex Code
22887 \begin_layout Plain Layout
22889 \change_inserted -712698321 1559491850
22900 \begin_inset space \thinspace{}
22904 \begin_inset Flex Code
22907 \begin_layout Plain Layout
22909 \change_inserted -712698321 1559491850
22917 ] If this is set to
22918 \begin_inset Flex Code
22921 \begin_layout Plain Layout
22923 \change_inserted -712698321 1559491881
22932 paragraph breaks will be ignored in the output.
22933 This might be useful for insets where the content should be alignable on different lines only in the \SpecialChar LyX
22935 without any effect in the output.
22940 \begin_layout Description
22941 \begin_inset Flex Code
22944 \begin_layout Plain Layout
22951 \begin_inset Flex Code
22954 \begin_layout Plain Layout
22963 \begin_inset space \thinspace{}
22967 \begin_inset Flex Code
22970 \begin_layout Plain Layout
22976 ] As with paragraph styles,
22978 \begin_inset CommandInset ref
22980 reference "subsec:Paragraph-Styles"
22988 \begin_layout Description
22989 \begin_inset Flex Code
22992 \begin_layout Plain Layout
22999 \begin_inset Flex Code
23002 \begin_layout Plain Layout
23011 \begin_inset space \thinspace{}
23015 \begin_inset Flex Code
23018 \begin_layout Plain Layout
23024 ] As with paragraph styles,
23026 \begin_inset CommandInset ref
23028 reference "subsec:Paragraph-Styles"
23036 \begin_layout Description
23037 \begin_inset Flex Code
23040 \begin_layout Plain Layout
23046 As with paragraph styles,
23048 \begin_inset CommandInset ref
23050 reference "subsec:Paragraph-Styles"
23057 \begin_layout Description
23058 \begin_inset Flex Code
23061 \begin_layout Plain Layout
23068 \begin_inset Flex Code
23071 \begin_layout Plain Layout
23077 ] The prefix to use when creating labels referring to insets of this type.
23078 This allows the use of formatted references.
23081 \begin_layout Description
23082 \begin_inset Flex Code
23085 \begin_layout Plain Layout
23092 \begin_inset Flex Code
23095 \begin_layout Plain Layout
23101 ] As with paragraph styles,
23103 \begin_inset CommandInset ref
23105 reference "subsec:Paragraph-Styles"
23112 \begin_layout Description
23113 \begin_inset Flex Code
23116 \begin_layout Plain Layout
23123 \begin_inset Flex Code
23126 \begin_layout Plain Layout
23135 \begin_inset space \thinspace{}
23139 \begin_inset Flex Code
23142 \begin_layout Plain Layout
23148 ] Resets the \SpecialChar LaTeX
23149 arguments of this layout (as defined via the
23150 \begin_inset Flex Code
23153 \begin_layout Plain Layout
23160 This is useful if you have copied a style via
23161 \begin_inset Flex Code
23164 \begin_layout Plain Layout
23171 but you do not want to inherit its (required and optional) arguments.
23174 \begin_layout Description
23175 \begin_inset Flex Code
23178 \begin_layout Plain Layout
23185 \begin_inset Flex Code
23188 \begin_layout Plain Layout
23197 \begin_inset space \thinspace{}
23201 \begin_inset Flex Code
23204 \begin_layout Plain Layout
23211 \change_inserted -712698321 1597733473
23213 \begin_inset Flex Code
23216 \begin_layout Plain Layout
23218 \change_inserted -712698321 1597732178
23227 font changes are redone inside the respective inset (in the output) even if the inset itself is in the context of this font changes (e.
23228 \begin_inset space \thinspace{}
23233 \begin_inset Flex Code
23236 \begin_layout Plain Layout
23238 \change_inserted -712698321 1597733683
23241 textbf{Sourrounding text
23245 textbf{content}}\SpecialChar ldots
23254 \begin_inset Flex Code
23257 \begin_layout Plain Layout
23259 \change_inserted -712698321 1597733686
23262 textbf{Sourrounding text
23264 myinset{content}\SpecialChar ldots
23273 Setting this makes sense for commands that internally reset font settings (e.
23274 \begin_inset space \thinspace{}
23279 Note that wrongly setting this might lead to unwanted result (e.
23280 \begin_inset space \thinspace{}
23285 \begin_inset Flex Code
23288 \begin_layout Plain Layout
23290 \change_inserted -712698321 1597733688
23293 emph{Sourrounding text
23297 emph{content}}\SpecialChar ldots
23306 content is upright,
23308 \begin_inset Flex Code
23311 \begin_layout Plain Layout
23313 \change_inserted -712698321 1597733278
23325 \change_deleted -712698321 1597733283
23326 Whether this inset should use the font of its surrounding environment or uses its own.
23330 \change_deleted -712698321 1597733290
23332 \change_inserted -712698321 1597733290
23334 \begin_inset Flex Code
23337 \begin_layout Plain Layout
23339 \change_inserted -712698321 1597733292
23351 \change_deleted -712698321 1597733327
23352 use the font of the surrounding environment
23353 \change_inserted -712698321 1597733343
23354 font changes are not redone inside the inset
23359 \begin_layout Description
23360 \begin_inset Flex Code
23363 \begin_layout Plain Layout
23370 \begin_inset Flex Code
23373 \begin_layout Plain Layout
23379 ] A string that is put at the end of the layout content.
23380 A line break in the output can be indicated by
23381 \begin_inset Flex Code
23384 \begin_layout Plain Layout
23393 \begin_layout Description
23394 \begin_inset Flex Code
23397 \begin_layout Plain Layout
23404 \begin_inset Flex Code
23407 \begin_layout Plain Layout
23414 \begin_inset space \thinspace{}
23418 \begin_inset Flex Code
23421 \begin_layout Plain Layout
23429 ] Allow spell-checking the contents of this inset.
23431 \change_inserted -584632292 1615846659
23435 \begin_layout Subsection
23437 \change_inserted -584632292 1615846729
23439 \begin_inset CommandInset label
23441 name "subsec:Arguments"
23448 \begin_layout Standard
23450 \change_inserted -584632292 1615846807
23451 Both paragraph styles and inset layouts allow for
23455 as well as the main content.
23456 This is especially useful for things like section headings and only makes sense with \SpecialChar LaTeX
23458 Each (optional or required) argument of a command or environment—
23459 except for the required argument that is associated with the content—
23460 has a separate definition,
23461 where the number specifies the order of the arguments.
23462 The definition must end with
23463 \begin_inset Flex Code
23466 \begin_layout Plain Layout
23468 \change_inserted -584632292 1615846730
23477 So a command with two optional arguments looks like:
23480 \begin_layout Quote
23482 \change_inserted -584632292 1615846730
23488 \begin_layout Quote
23490 \change_inserted -584632292 1615846730
23496 \begin_layout Quote
23498 \change_inserted -584632292 1615846730
23504 \begin_layout Quote
23506 \change_inserted -584632292 1615846730
23512 \begin_layout Quote
23514 \change_inserted -584632292 1615846730
23520 \begin_layout Quote
23522 \change_inserted -584632292 1615846730
23528 \begin_layout Standard
23530 \change_inserted -584632292 1615846730
23532 \begin_inset Flex Code
23535 \begin_layout Plain Layout
23537 \change_inserted -584632292 1615846730
23546 the following specifications are possible:
23549 \begin_layout Itemize
23551 \change_inserted -584632292 1615846730
23552 \begin_inset Flex Code
23555 \begin_layout Plain Layout
23557 \change_inserted -584632292 1615846730
23566 \begin_inset Flex Code
23569 \begin_layout Plain Layout
23571 \change_inserted -584632292 1615846730
23579 The string that will appear both in the menu (to insert this argument) and on the argument inset button (unless you also specify a separate
23580 \begin_inset Flex Code
23583 \begin_layout Plain Layout
23585 \change_inserted -584632292 1615846730
23595 you can define an accelerator by appending the respective character to the string,
23597 \begin_inset Quotes eld
23601 \begin_inset Quotes erd
23605 \begin_inset space \thinspace{}
23609 \begin_inset space \space{}
23613 \begin_inset Quotes eld
23617 \begin_inset Flex Code
23620 \begin_layout Plain Layout
23622 \change_inserted -584632292 1615846730
23631 \begin_inset Quotes erd
23637 \begin_layout Itemize
23639 \change_inserted -584632292 1615846730
23640 \begin_inset Flex Code
23643 \begin_layout Plain Layout
23645 \change_inserted -584632292 1615846730
23654 \begin_inset Flex Code
23657 \begin_layout Plain Layout
23659 \change_inserted -584632292 1615846730
23667 A separate string for the menu.
23668 You can define an accelerator by appending the respective character to the string,
23670 \begin_inset Quotes eld
23674 \begin_inset Quotes erd
23678 \begin_inset space \thinspace{}
23682 \begin_inset space \space{}
23686 \begin_inset Quotes eld
23690 \begin_inset Flex Code
23693 \begin_layout Plain Layout
23695 \change_inserted -584632292 1615846730
23704 \begin_inset Quotes erd
23708 This specification is optional.
23709 If it is not given the
23710 \begin_inset Flex Code
23713 \begin_layout Plain Layout
23715 \change_inserted -584632292 1615846730
23723 will be used instead for the menu.
23726 \begin_layout Itemize
23728 \change_inserted -584632292 1615846730
23729 \begin_inset Flex Code
23732 \begin_layout Plain Layout
23734 \change_inserted -584632292 1615846730
23743 \begin_inset Flex Code
23746 \begin_layout Plain Layout
23748 \change_inserted -584632292 1615846730
23756 A longer explanatory text that appears in the tooltip when hovering over the argument inset.
23759 \begin_layout Itemize
23761 \change_inserted -584632292 1615846730
23762 \begin_inset Flex Code
23765 \begin_layout Plain Layout
23767 \change_inserted -584632292 1615846730
23776 \begin_inset Flex Code
23779 \begin_layout Plain Layout
23781 \change_inserted -584632292 1615846730
23792 \begin_inset space \thinspace{}
23796 \begin_inset Flex Code
23799 \begin_layout Plain Layout
23801 \change_inserted -584632292 1615846730
23809 ] Declare if this is a mandatory (1) or an optional (0) argument.
23810 Mandatory arguments will be output empty if not given,
23811 while optional arguments will not be output at all.
23813 mandatory arguments are delimited by
23814 \begin_inset Flex Code
23817 \begin_layout Plain Layout
23819 \change_inserted -584632292 1615846730
23828 while optional arguments are delimited by
23829 \begin_inset Flex Code
23832 \begin_layout Plain Layout
23834 \change_inserted -584632292 1615846730
23845 \begin_layout Itemize
23847 \change_inserted -584632292 1615846730
23848 \begin_inset Flex Code
23851 \begin_layout Plain Layout
23853 \change_inserted -584632292 1615846730
23862 \begin_inset Flex Code
23865 \begin_layout Plain Layout
23867 \change_inserted -584632292 1615846730
23875 Option to define a different command (from the default
23876 \begin_inset Flex Code
23879 \begin_layout Plain Layout
23881 \change_inserted -584632292 1615846730
23893 ) to be used for line breaks.
23894 The initial backslash must not be specified.
23897 \begin_layout Itemize
23899 \change_inserted -584632292 1615846730
23900 \begin_inset Flex Code
23903 \begin_layout Plain Layout
23905 \change_inserted -584632292 1615846730
23914 \begin_inset Flex Code
23917 \begin_layout Plain Layout
23919 \change_inserted -584632292 1615846730
23927 defines another argument (by its number) which this argument requires to be output if it is itself output.
23929 \begin_inset space \thinspace{}
23933 in \SpecialChar LaTeX
23935 optional arguments often require previous optional arguments to be output (at least empty),
23937 \begin_inset Flex Code
23940 \begin_layout Plain Layout
23942 \change_inserted -584632292 1615846730
23945 command[][argument]{text}
23953 This can be achieved by the statement
23954 \begin_inset Flex Code
23957 \begin_layout Plain Layout
23959 \change_inserted -584632292 1615846730
23968 \begin_inset Flex Code
23971 \begin_layout Plain Layout
23973 \change_inserted -584632292 1615846730
23984 \begin_layout Itemize
23986 \change_inserted -584632292 1615846730
23987 \begin_inset Flex Code
23990 \begin_layout Plain Layout
23992 \change_inserted -584632292 1615846730
24001 \begin_inset Flex Code
24004 \begin_layout Plain Layout
24006 \change_inserted -584632292 1615846730
24014 defines a custom left delimiter (instead of
24015 \begin_inset Flex Code
24018 \begin_layout Plain Layout
24020 \change_inserted -584632292 1615846730
24029 \begin_inset Flex Code
24032 \begin_layout Plain Layout
24034 \change_inserted -584632292 1615846730
24043 A line break in the output can be indicated by
24044 \begin_inset Flex Code
24047 \begin_layout Plain Layout
24049 \change_inserted -584632292 1615846730
24060 \begin_layout Itemize
24062 \change_inserted -584632292 1615846730
24063 \begin_inset Flex Code
24066 \begin_layout Plain Layout
24068 \change_inserted -584632292 1615846730
24077 \begin_inset Flex Code
24080 \begin_layout Plain Layout
24082 \change_inserted -584632292 1615846730
24090 defines a custom right delimiter (instead of
24091 \begin_inset Flex Code
24094 \begin_layout Plain Layout
24096 \change_inserted -584632292 1615846730
24105 \begin_inset Flex Code
24108 \begin_layout Plain Layout
24110 \change_inserted -584632292 1615846730
24119 A line break in the output can be indicated by
24120 \begin_inset Flex Code
24123 \begin_layout Plain Layout
24125 \change_inserted -584632292 1615846730
24136 \begin_layout Itemize
24138 \change_inserted -584632292 1615846730
24139 \begin_inset Flex Code
24142 \begin_layout Plain Layout
24144 \change_inserted -584632292 1615846730
24153 \begin_inset Flex Code
24156 \begin_layout Plain Layout
24158 \change_inserted -584632292 1615846730
24166 defines an argument that is inserted if and only if no user-specified arguments were given,
24168 \begin_inset space \thinspace{}
24172 \begin_inset space \space{}
24175 if no argument inset has been inserted (note that also an empty argument inset omits the DefaultArg).
24176 Multiple arguments need to be separated by comma.
24179 \begin_layout Itemize
24181 \change_inserted -584632292 1615846730
24182 \begin_inset Flex Code
24185 \begin_layout Plain Layout
24187 \change_inserted -584632292 1615846730
24196 \begin_inset Flex Code
24199 \begin_layout Plain Layout
24201 \change_inserted -584632292 1615846730
24209 defines an argument that is inserted in any case (alone or in addition to user-specified arguments).
24210 Multiple arguments need to be separated by comma.
24213 \begin_layout Itemize
24215 \change_inserted -584632292 1615846730
24216 \begin_inset Flex Code
24219 \begin_layout Plain Layout
24221 \change_inserted -584632292 1615846730
24229 The font used for the argument content,
24231 \begin_inset CommandInset ref
24233 reference "subsec:Font-description"
24240 \begin_layout Itemize
24242 \change_inserted -584632292 1615846730
24243 \begin_inset Flex Code
24246 \begin_layout Plain Layout
24248 \change_inserted -584632292 1615846730
24257 \begin_inset Flex Code
24260 \begin_layout Plain Layout
24262 \change_inserted -584632292 1615846730
24273 \begin_inset space \thinspace{}
24277 \begin_inset Flex Code
24280 \begin_layout Plain Layout
24282 \change_inserted -584632292 1615846730
24290 ] As with paragraph styles,
24292 \begin_inset CommandInset ref
24294 reference "subsec:Paragraph-Styles"
24301 \begin_layout Itemize
24303 \change_inserted -584632292 1615846730
24304 \begin_inset Flex Code
24307 \begin_layout Plain Layout
24309 \change_inserted -584632292 1615846730
24317 The font used for the label;
24319 \begin_inset CommandInset ref
24321 reference "subsec:Font-description"
24328 \begin_layout Itemize
24330 \change_inserted -584632292 1615846730
24331 \begin_inset Flex Code
24334 \begin_layout Plain Layout
24336 \change_inserted -584632292 1615846730
24345 \begin_inset Flex Code
24348 \begin_layout Plain Layout
24350 \change_inserted -584632292 1615846730
24364 ] describes the rendering style used for the inset's frame and buttons.
24367 \begin_layout Itemize
24369 \change_inserted -584632292 1615846730
24370 \begin_inset Flex Code
24373 \begin_layout Plain Layout
24375 \change_inserted -584632292 1615846730
24384 \begin_inset Flex Code
24387 \begin_layout Plain Layout
24389 \change_inserted -584632292 1615846730
24398 \begin_inset Flex Code
24401 \begin_layout Plain Layout
24403 \change_inserted -584632292 1615846730
24412 this argument is automatically inserted when the respective style is selected.
24415 \begin_layout Itemize
24417 \change_inserted -584632292 1615846730
24418 \begin_inset Flex Code
24421 \begin_layout Plain Layout
24423 \change_inserted -584632292 1615846730
24432 \begin_inset Flex Code
24435 \begin_layout Plain Layout
24437 \change_inserted -584632292 1615846730
24446 \begin_inset Flex Code
24449 \begin_layout Plain Layout
24451 \change_inserted -584632292 1615846730
24460 this argument will be inserted on a new line with
24461 \begin_inset Flex Code
24464 \begin_layout Plain Layout
24466 \change_inserted -584632292 1615846730
24474 (only available within Flex insets).
24477 \begin_layout Itemize
24479 \change_inserted -584632292 1615846730
24480 \begin_inset Flex Code
24483 \begin_layout Plain Layout
24485 \change_inserted -584632292 1615846730
24494 \begin_inset Flex Code
24497 \begin_layout Plain Layout
24499 \change_inserted -584632292 1615846730
24508 \begin_inset Flex Code
24511 \begin_layout Plain Layout
24513 \change_inserted -584632292 1615846730
24522 this argument will be inserted with a copy of the co-text (either selected text or the whole paragraph) as content.
24525 \begin_layout Itemize
24527 \change_inserted -584632292 1615846730
24528 \begin_inset Flex Code
24531 \begin_layout Plain Layout
24533 \change_inserted -584632292 1615846730
24542 \begin_inset Flex Code
24545 \begin_layout Plain Layout
24547 \change_inserted -584632292 1615846730
24561 ] Whether the contents of this argument should be output in raw form,
24562 meaning without special translations that \SpecialChar LaTeX
24566 \begin_inset Flex Code
24569 \begin_layout Plain Layout
24571 \change_inserted -584632292 1615846730
24579 status is inherited by the inset or paragraph layout the argument belongs to,
24580 true and false change the status for the given argument only.
24583 \begin_layout Itemize
24585 \change_inserted -584632292 1615846730
24586 \begin_inset Flex Code
24589 \begin_layout Plain Layout
24591 \change_inserted -584632292 1615846730
24600 \begin_inset Flex Code
24603 \begin_layout Plain Layout
24605 \change_inserted -584632292 1615846730
24606 string of characters
24617 Defines individual characters
24618 \begin_inset Newline linebreak
24621 that should be output in raw form,
24622 meaning without special translations that \SpecialChar LaTeX
24625 contrary to PassThru,
24626 this needs to be explicitly defined for arguments.
24628 arguments do not inherit PassThruChars from their parent inset or layout.
24631 \begin_layout Itemize
24633 \change_inserted -584632292 1615846730
24634 \begin_inset Flex Code
24637 \begin_layout Plain Layout
24639 \change_inserted -584632292 1615846730
24648 \begin_inset Flex Code
24651 \begin_layout Plain Layout
24653 \change_inserted -584632292 1615846730
24664 \begin_inset space \thinspace{}
24668 \begin_inset Flex Code
24671 \begin_layout Plain Layout
24673 \change_inserted -584632292 1615846730
24681 ] If this is set to 1,
24682 the argument will output its content in the corresponding item in the table of contents.
24686 \begin_layout Standard
24688 \change_inserted -584632292 1615846730
24690 the text entered in the \SpecialChar LyX
24691 workarea in the respective layout is the last (mandatory) argument of a command if the
24692 \begin_inset Flex Code
24695 \begin_layout Plain Layout
24697 \change_inserted -584632292 1615846730
24706 \begin_inset Flex Code
24709 \begin_layout Plain Layout
24711 \change_inserted -584632292 1615846730
24721 arguments with the prefix
24722 \begin_inset Flex Code
24725 \begin_layout Plain Layout
24727 \change_inserted -584632292 1615846730
24735 are output after this workarea argument.
24736 Note that post-argument numbering restarts at 1,
24737 so the first argument following the workarea argument is
24738 \begin_inset Flex Code
24741 \begin_layout Plain Layout
24743 \change_inserted -584632292 1615846730
24752 Post-arguments are ignored in any other
24753 \begin_inset Flex Code
24756 \begin_layout Plain Layout
24758 \change_inserted -584632292 1615846730
24767 \begin_inset Flex Code
24770 \begin_layout Plain Layout
24772 \change_inserted -584632292 1615846730
24783 \begin_layout Standard
24785 \change_inserted -584632292 1615846730
24787 \begin_inset Flex Code
24790 \begin_layout Plain Layout
24792 \change_inserted -584632292 1615846730
24803 \begin_inset Flex Code
24806 \begin_layout Plain Layout
24808 \change_inserted -584632292 1615846730
24819 \begin_inset Flex Code
24822 \begin_layout Plain Layout
24824 \change_inserted -584632292 1615846730
24832 followed by the number (e.
24833 \begin_inset space \thinspace{}
24837 \begin_inset space \space{}
24841 \begin_inset Flex Code
24844 \begin_layout Plain Layout
24846 \change_inserted -584632292 1615846730
24857 \begin_layout Standard
24859 \change_inserted -584632292 1615846730
24861 there is a special argument type with the prefix
24862 \begin_inset Flex Code
24865 \begin_layout Plain Layout
24867 \change_inserted -584632292 1615846730
24876 It is not really an argument,
24877 but uses the argument interface (thus,
24878 the prefix is also followed by a number,
24880 \begin_inset space \thinspace{}
24885 \begin_inset Flex Code
24888 \begin_layout Plain Layout
24890 \change_inserted -584632292 1615846730
24891 Argument listpreamble:1
24899 As the name implies,
24900 it is targeted at lists such as
24920 Its content will be output at the list start,
24922 \begin_inset Flex Code
24925 \begin_layout Plain Layout
24927 \change_inserted -584632292 1615846730
24938 on an own line (a place that is otherwise not accessible in \SpecialChar LyX
24941 users can insert redefinitions (of lengths etc.) to individual lists.
24943 these arguments do not have a delimiter.
24948 \begin_layout Subsection
24950 \begin_inset CommandInset label
24952 name "subsec:Counters"
24959 \begin_layout Standard
24960 It is necessary to define the counters (
24961 \begin_inset Flex Noun
24964 \begin_layout Plain Layout
24972 \begin_inset Flex Noun
24975 \begin_layout Plain Layout
24983 ) in the text class itself.
24984 The standard counters are defined in the file
24985 \begin_inset Flex Code
24988 \begin_layout Plain Layout
24995 so you may have to do no more than add
24998 \begin_layout LyX-Code
24999 Input stdcounters.inc
25002 \begin_layout Standard
25003 to your layout file to get them to work.
25004 But if you want to define custom counters,
25005 then you can do so.
25006 The counter declaration must begin with:
25009 \begin_layout LyX-Code
25010 Counter CounterName
25013 \begin_layout Standard
25015 \begin_inset Flex Code
25018 \begin_layout Plain Layout
25024 ' is replaced by the name of the counter.
25025 And it must end with
25026 \begin_inset Quotes eld
25030 \begin_inset Flex Code
25033 \begin_layout Plain Layout
25040 \begin_inset Quotes erd
25044 The following parameters can also be used:
25047 \begin_layout Description
25048 \begin_inset Flex Code
25051 \begin_layout Plain Layout
25058 \begin_inset Flex Code
25061 \begin_layout Plain Layout
25067 ] Sets the initial value for the counter,
25068 to which it will be reset whenever that happens.
25070 one will want the default,
25074 \begin_layout Description
25075 \begin_inset Flex Code
25078 \begin_layout Plain Layout
25085 \begin_inset Flex Code
25088 \begin_layout Plain Layout
25095 \begin_inset Quotes erd
25099 \begin_inset Quotes erd
25103 this string defines how the counter is displayed.
25104 Setting this value sets
25105 \begin_inset Flex Code
25108 \begin_layout Plain Layout
25109 LabelStringAppendix
25115 The following special constructs can be used in the string:
25119 \begin_layout Itemize
25120 \begin_inset Flex Code
25123 \begin_layout Plain Layout
25131 will be replaced by the expansion of the
25132 \begin_inset Flex Code
25135 \begin_layout Plain Layout
25142 \begin_inset Flex Code
25145 \begin_layout Plain Layout
25146 LabelStringAppendix
25152 \begin_inset Flex Code
25155 \begin_layout Plain Layout
25165 \begin_layout Itemize
25166 counter values can be expressed using \SpecialChar LaTeX
25168 \begin_inset Newline newline
25172 \begin_inset Flex Code
25175 \begin_layout Plain Layout
25193 \begin_inset Flex Code
25196 \begin_layout Plain Layout
25208 \begin_layout Plain Layout
25219 the situation is a bit more complicated:
25239 other than those described below will produce arabic numerals.
25240 It would not be surprising to see this change in the future.
25246 \begin_inset Flex Code
25249 \begin_layout Plain Layout
25258 3,\SpecialChar ldots
25261 \begin_inset Flex Code
25264 \begin_layout Plain Layout
25270 for lower-case letters:
25277 \begin_inset Flex Code
25280 \begin_layout Plain Layout
25286 for upper-case letters:
25293 \begin_inset Flex Code
25296 \begin_layout Plain Layout
25302 for lower-case roman numerals:
25309 \begin_inset Flex Code
25312 \begin_layout Plain Layout
25318 for upper-case roman numerals:
25321 III\SpecialChar ldots
25324 \begin_inset Flex Code
25327 \begin_layout Plain Layout
25333 for hebrew numerals.
25337 \begin_layout Standard
25338 If LabelString is not defined,
25339 a default value is constructed as follows:
25340 if the counter has a
25341 \change_deleted 731793113 1604355218
25343 \change_inserted 731793113 1604355221
25347 \begin_inset Flex Code
25350 \begin_layout Plain Layout
25352 \change_deleted 731793113 1604355223
25354 \change_inserted 731793113 1604355226
25363 \begin_inset Flex Code
25366 \begin_layout Plain Layout
25374 \begin_inset Newline newline
25378 \begin_inset Flex Code
25381 \begin_layout Plain Layout
25385 \change_inserted 731793113 1604355228
25387 \change_deleted 731793113 1604355230
25398 otherwise the string
25399 \begin_inset Flex Code
25402 \begin_layout Plain Layout
25413 \begin_layout Description
25414 \begin_inset Flex Code
25417 \begin_layout Plain Layout
25418 LabelStringAppendix
25424 \begin_inset Flex Code
25427 \begin_layout Plain Layout
25434 \begin_inset Quotes eld
25438 \begin_inset Quotes erd
25442 \begin_inset Flex Code
25445 \begin_layout Plain Layout
25452 but for use in the Appendix.
25453 \change_inserted -584632292 1607202551
25457 \begin_layout Description
25459 \change_inserted -584632292 1607202682
25460 \begin_inset Flex Code
25463 \begin_layout Plain Layout
25470 \begin_inset Flex Code
25473 \begin_layout Plain Layout
25475 \change_inserted -584632292 1607202576
25484 \begin_inset Quotes eld
25488 \begin_inset Quotes erd
25491 ] The counter name as used in \SpecialChar LaTeX
25494 \change_inserted 34634807 1619711355
25496 \change_deleted 34634807 1619711355
25498 \change_inserted -584632292 1607202682
25500 in \SpecialChar LyX
25502 there is a counter named `theorem',
25503 but it is output to \SpecialChar LaTeX
25509 \begin_layout Description
25510 \begin_inset Flex Code
25513 \begin_layout Plain Layout
25520 \begin_inset Flex Code
25523 \begin_layout Plain Layout
25530 \begin_inset Quotes erd
25534 \begin_inset Quotes erd
25537 ] A format for use with formatted references to this counter.
25539 one might want to have references to section numbers appear as
25540 \begin_inset Quotes eld
25544 \begin_inset Quotes erd
25548 The string should contain
25549 \begin_inset Quotes eld
25553 \begin_inset Quotes erd
25557 This will be replaced by the counter number itself.
25564 \begin_layout Description
25565 \begin_inset Flex Code
25568 \begin_layout Plain Layout
25575 \begin_inset Flex Code
25578 \begin_layout Plain Layout
25585 \begin_inset Quotes erd
25589 \begin_inset Quotes erd
25592 ] If this is set to the name of another counter,
25593 the present counter will be reset every time the other one is increased.
25596 \begin_inset Flex Code
25599 \begin_layout Plain Layout
25606 \begin_inset Flex Code
25609 \begin_layout Plain Layout
25618 \begin_layout Subsection
25620 \begin_inset CommandInset label
25622 name "subsec:Font-description"
25629 \begin_layout Standard
25630 A font description looks like this:
25633 \begin_layout LyX-Code
25650 \begin_layout LyX-Code
25654 \begin_layout LyX-Code
25658 \begin_layout Standard
25659 The following commands are available:
25662 \begin_layout Description
25663 \begin_inset Flex Code
25666 \begin_layout Plain Layout
25673 \change_deleted -712698321 1607682984
25675 \begin_inset Flex Code
25678 \begin_layout Plain Layout
25688 \begin_inset Flex Code
25691 \begin_layout Plain Layout
25699 \begin_inset Flex Code
25702 \begin_layout Plain Layout
25710 \begin_inset Flex Code
25713 \begin_layout Plain Layout
25721 \begin_inset Flex Code
25724 \begin_layout Plain Layout
25732 \begin_inset Flex Code
25735 \begin_layout Plain Layout
25743 \begin_inset Flex Code
25746 \begin_layout Plain Layout
25754 \begin_inset Flex Code
25757 \begin_layout Plain Layout
25765 \begin_inset Flex Code
25768 \begin_layout Plain Layout
25776 \begin_inset Flex Code
25779 \begin_layout Plain Layout
25787 \begin_inset Flex Code
25790 \begin_layout Plain Layout
25798 \begin_inset Flex Code
25801 \begin_layout Plain Layout
25809 \begin_inset Flex Code
25812 \begin_layout Plain Layout
25820 \begin_inset Flex Code
25823 \begin_layout Plain Layout
25831 \begin_inset Flex Code
25834 \begin_layout Plain Layout
25842 \begin_inset Flex Code
25845 \begin_layout Plain Layout
25853 \begin_inset Flex Code
25856 \begin_layout Plain Layout
25864 \begin_inset Flex Code
25867 \begin_layout Plain Layout
25875 \begin_inset Flex Code
25878 \begin_layout Plain Layout
25886 \begin_inset Flex Code
25889 \begin_layout Plain Layout
25896 \change_inserted -712698321 1607683139
25898 \begin_inset Flex Code
25901 \begin_layout Plain Layout
25903 \change_inserted -712698321 1607683135
25912 \begin_inset space ~
25916 \begin_inset CommandInset ref
25918 reference "chap:Names-of-colors"
25926 \change_deleted -712698321 1607683144
25928 \change_inserted -712698321 1607683146
25934 \begin_layout Description
25935 \begin_inset Flex Code
25938 \begin_layout Plain Layout
25945 \begin_inset Flex Code
25948 \begin_layout Plain Layout
25958 \begin_inset Flex Code
25961 \begin_layout Plain Layout
25969 \begin_inset Flex Code
25972 \begin_layout Plain Layout
25981 \begin_layout Description
25982 \begin_inset Flex Code
25985 \begin_layout Plain Layout
25992 \begin_inset Flex Code
25995 \begin_layout Plain Layout
26001 ] Valid arguments are:
26003 \begin_inset Flex Code
26006 \begin_layout Plain Layout
26014 \begin_inset Flex Code
26017 \begin_layout Plain Layout
26025 \begin_inset Flex Code
26028 \begin_layout Plain Layout
26036 \begin_inset Flex Code
26039 \begin_layout Plain Layout
26047 \begin_inset Flex Code
26050 \begin_layout Plain Layout
26058 \begin_inset Flex Code
26061 \begin_layout Plain Layout
26069 \begin_inset Flex Code
26072 \begin_layout Plain Layout
26080 \begin_inset Flex Code
26083 \begin_layout Plain Layout
26091 \begin_inset Flex Code
26094 \begin_layout Plain Layout
26102 \begin_inset Flex Code
26105 \begin_layout Plain Layout
26113 \begin_inset Flex Code
26116 \begin_layout Plain Layout
26123 \begin_inset Flex Code
26126 \begin_layout Plain Layout
26133 Each of these turns on or off the corresponding attribute.
26136 \begin_inset Flex Code
26139 \begin_layout Plain Layout
26147 \begin_inset Flex Code
26150 \begin_layout Plain Layout
26158 \begin_inset Newline newline
26161 If the latter seems puzzling,
26162 remember that the font settings for the present context are generally inherited from the surrounding context.
26164 \begin_inset Flex Code
26167 \begin_layout Plain Layout
26173 would turn off the emphasis that was anyway in effect,
26175 in a theorem environment.
26178 \begin_layout Description
26179 \begin_inset Flex Code
26182 \begin_layout Plain Layout
26189 \begin_inset Flex Code
26192 \begin_layout Plain Layout
26202 \begin_inset Flex Code
26205 \begin_layout Plain Layout
26214 \begin_layout Description
26215 \begin_inset Flex Code
26218 \begin_layout Plain Layout
26225 \begin_inset Flex Code
26228 \begin_layout Plain Layout
26238 \begin_inset Flex Code
26241 \begin_layout Plain Layout
26249 \begin_inset Flex Code
26252 \begin_layout Plain Layout
26260 \begin_inset Flex Code
26263 \begin_layout Plain Layout
26272 \begin_layout Description
26273 \begin_inset Flex Code
26276 \begin_layout Plain Layout
26283 \begin_inset Flex Code
26286 \begin_layout Plain Layout
26294 \begin_inset Flex Code
26297 \begin_layout Plain Layout
26305 \begin_inset Flex Code
26308 \begin_layout Plain Layout
26318 \begin_inset Flex Code
26321 \begin_layout Plain Layout
26329 \begin_inset Flex Code
26332 \begin_layout Plain Layout
26340 \begin_inset Flex Code
26343 \begin_layout Plain Layout
26351 \begin_inset Flex Code
26354 \begin_layout Plain Layout
26362 \begin_inset Flex Code
26365 \begin_layout Plain Layout
26374 \begin_layout Subsection
26375 \begin_inset CommandInset label
26377 name "subsec:Citation-engine-description"
26381 Cite engine description
26384 \begin_layout Standard
26386 \begin_inset Flex Code
26389 \begin_layout Plain Layout
26396 as used mainly in cite engine files (see
26397 \begin_inset CommandInset ref
26399 reference "subsec:Cite-Engine-Files"
26407 define the citation commands provided by a specific
26408 \begin_inset Quotes eld
26412 \begin_inset Quotes erd
26417 in \SpecialChar LyX
26419 is way specific way to format citations,
26421 author names and/or years.
26424 supports three such engine types,
26428 \begin_layout Enumerate
26429 \begin_inset Flex Code
26432 \begin_layout Plain Layout
26439 the default Bib\SpecialChar TeX
26440 way to format citations,
26441 a simple numeric style (e.
26442 \begin_inset space \thinspace{}
26447 \begin_inset Quotes eld
26451 \begin_inset Quotes erd
26457 \begin_layout Enumerate
26458 \begin_inset Flex Code
26461 \begin_layout Plain Layout
26468 Harvard-styled citations using author names and publication year (e.
26469 \begin_inset space \thinspace{}
26474 \begin_inset Quotes eld
26477 Smith and Miller (2017b)
26478 \begin_inset Quotes erd
26484 \begin_layout Enumerate
26485 \begin_inset Flex Code
26488 \begin_layout Plain Layout
26495 extended numerical citations that also allow for author or title next to the number (e.
26496 \begin_inset space \thinspace{}
26501 \begin_inset Quotes eld
26504 Smith and Miller [1]
26505 \begin_inset Quotes erd
26511 \begin_layout Standard
26512 \begin_inset Flex Code
26515 \begin_layout Plain Layout
26521 blocks look like this:
26524 \begin_layout LyX-Code
26528 \begin_layout LyX-Code
26532 \begin_layout LyX-Code
26536 \begin_layout LyX-Code
26537 citeyearpar[][]=parencite*
26540 \begin_layout LyX-Code
26544 \begin_layout LyX-Code
26548 \begin_layout Standard
26550 \begin_inset Flex Code
26553 \begin_layout Plain Layout
26559 denotes the engine.
26560 The individual lines respectively define a cite command or cite command paradigm supported by this engine.
26561 The line can be as simple as a cite command that is used both to name the respective \SpecialChar LyX
26562 command and the \SpecialChar LaTeX
26563 output or more complex in order to differentiate things.
26564 The full syntax is:
26567 \begin_layout LyX-Code
26568 LyXName|alias$*<!_stardesc!_stardesctooltip>[][]=latexcmd
26571 \begin_layout Itemize
26572 \begin_inset Flex Code
26575 \begin_layout Plain Layout
26582 The name as used in the
26583 \begin_inset Flex Code
26586 \begin_layout Plain Layout
26596 \begin_layout Standard
26597 For portability reasons,
26598 we try to use the same name for same-formatted commands in different cite packages (thus many names stem from natbib,
26599 and thus we need to differentiate a
26600 \begin_inset Flex Code
26603 \begin_layout Plain Layout
26610 if the \SpecialChar LaTeX
26611 command names differ).
26615 \begin_layout Itemize
26616 \begin_inset Flex Code
26619 \begin_layout Plain Layout
26626 a (comma-separated) list of commands that fall back to the given
26627 \begin_inset Flex Code
26630 \begin_layout Plain Layout
26636 in the current engine.
26637 This eases the switch of citation packages and engines.
26639 \begin_inset Flex Code
26642 \begin_layout Plain Layout
26649 \begin_inset Flex Code
26652 \begin_layout Plain Layout
26658 in layout definitions.
26661 \begin_layout Itemize
26662 \begin_inset Flex Code
26665 \begin_layout Plain Layout
26672 The actual \SpecialChar LaTeX
26673 command that is output.
26677 \begin_layout Standard
26678 \begin_inset Flex Code
26681 \begin_layout Plain Layout
26688 \begin_inset Flex Code
26691 \begin_layout Plain Layout
26699 \begin_inset Flex Code
26702 \begin_layout Plain Layout
26710 \begin_inset Flex Code
26713 \begin_layout Plain Layout
26719 will be output to \SpecialChar LaTeX
26723 \begin_layout Standard
26727 \begin_layout Itemize
26728 Capitalization indicates that the command also has a capitalized form (
26729 \begin_inset Flex Code
26732 \begin_layout Plain Layout
26742 \begin_inset Flex Code
26745 \begin_layout Plain Layout
26754 These usually enforce up-casing of name prefixes (
26759 \begin_inset Formula $\Rightarrow$
26769 \begin_layout Itemize
26771 \begin_inset Flex Code
26774 \begin_layout Plain Layout
26780 indicate the number of optional arguments (there can be 0–2).
26783 \begin_layout Itemize
26785 \begin_inset Flex Code
26788 \begin_layout Plain Layout
26794 indicates there is a starred version of the command (
26795 \begin_inset Flex Code
26798 \begin_layout Plain Layout
26808 \begin_inset Flex Code
26811 \begin_layout Plain Layout
26824 \begin_layout Standard
26826 the starred version means:
26827 Output all authors even if it should be shortened with
26828 \begin_inset Quotes eld
26832 \begin_inset Quotes erd
26836 \begin_inset Flex Code
26839 \begin_layout Plain Layout
26848 \begin_layout Standard
26849 If the star has a different meaning for a given command,
26850 it can be specified in angle brackets:
26852 \begin_inset Flex Code
26855 \begin_layout Plain Layout
26856 <!_stardesc!_stardesctooltip>
26862 Maximal two translatable macro keywords,
26863 marked by the prefix
26864 \begin_inset Flex Code
26867 \begin_layout Plain Layout
26875 The first points to the string that replaces the
26876 \begin_inset Quotes eld
26880 \begin_inset Quotes erd
26883 checkbox label in the citation dialog,
26884 the second one to an optional tool tip for this checkbox.
26888 \begin_layout Standard
26889 Note that these two macros have to be defined in a
26890 \begin_inset Flex Code
26893 \begin_layout Plain Layout
26899 (see next section),
26901 \begin_inset Flex Code
26904 \begin_layout Plain Layout
26915 \begin_layout LyX-Code
26916 _stardesc Sta&rred command label
26919 \begin_layout LyX-Code
26920 _stardesctooltip Tooltip for the starred command checkbox.
26924 \begin_layout Itemize
26926 \begin_inset Flex Code
26929 \begin_layout Plain Layout
26935 indicates that this command features
26936 \begin_inset Quotes eld
26939 qualified citation lists
26940 \begin_inset Quotes erd
26948 -specific feature for multi-reference citations where an individual pre- and postnote can be given to each reference in the list.
26949 Please refer to the
26953 manual for details.
26954 \change_inserted -712698321 1526898670
26958 \begin_layout Standard
26960 \change_inserted -712698321 1526899524
26961 If you want to add a cite command to a cite engine (e.
26962 \begin_inset space \thinspace{}
26966 add a specific command provided by a class),
26968 \begin_inset Flex Code
26971 \begin_layout Plain Layout
26973 \change_inserted -712698321 1526898768
26974 AddToCiteEngine <engine type> \SpecialChar ldots
26983 Note that only cite commands that do not exist yet are added.
26988 \begin_layout Subsection
26989 \begin_inset CommandInset label
26991 name "subsec:Citation-format-description"
26995 Cite format description
26998 \begin_layout Standard
27000 \begin_inset Flex Code
27003 \begin_layout Plain Layout
27009 blocks are used to describe how bibliographic information should be displayed,
27010 both within \SpecialChar LyX
27011 itself (in the citation dialog and in tooltips,
27012 for example) and in XHTML output.
27013 Such a block might look like this:
27016 \begin_layout LyX-Code
27020 \begin_layout LyX-Code
27024 \begin_layout LyX-Code
27028 \begin_layout LyX-Code
27032 \begin_layout Standard
27036 \begin_layout LyX-Code
27040 \begin_layout LyX-Code
27044 \begin_layout LyX-Code
27048 \begin_layout LyX-Code
27052 \begin_layout Standard
27054 the individual lines define how the bibliographic information associated with an article or book,
27056 is to be displayed,
27057 and such a definition can be given for any
27058 \begin_inset Quotes els
27062 \begin_inset Quotes ers
27065 that might be present in a Bib\SpecialChar TeX
27068 defines a default format in the source code that will be used if no specific definition has been given.
27070 predefines several formats in the file
27071 \begin_inset Flex Code
27074 \begin_layout Plain Layout
27081 which is included in most of \SpecialChar LyX
27082 's document classes.
27085 \begin_layout Standard
27086 In the second case,
27087 the lines define how a specific citation command (in the example
27088 \begin_inset Flex Code
27091 \begin_layout Plain Layout
27101 \begin_inset Flex Code
27104 \begin_layout Plain Layout
27112 ) is to be displayed on the citation inset label,
27113 in the citation dialog,
27114 menu or XHTML output.
27116 defines such formats for the citation style variants it supports via
27118 Document\SpecialChar menuseparator
27119 Setting\SpecialChar menuseparator
27120 Bibliography\SpecialChar ldots
27124 \begin_inset Flex Code
27127 \begin_layout Plain Layout
27133 files that are shipped with \SpecialChar LyX
27135 \begin_inset CommandInset ref
27137 reference "subsec:Cite-Engine-Files"
27147 \begin_layout Standard
27148 The definitions use a simple language that allows Bib\SpecialChar TeX
27149 keys to be replaced with their values.
27150 Keys should be enclosed in
27151 \begin_inset Flex Code
27154 \begin_layout Plain Layout
27163 \begin_inset Flex Code
27166 \begin_layout Plain Layout
27173 So a simple definition might look like this:
27176 \begin_layout LyX-Code
27179 \begin_inset Quotes eld
27183 \begin_inset Quotes erd
27189 \begin_layout Standard
27190 This would print the author,
27191 followed by a comma,
27192 followed by the title,
27194 followed by a period.
27197 \begin_layout Standard
27199 sometimes you may want to print a key only if it exists.
27200 This can be done by using a conditional construction,
27203 \begin_inset Flex Code
27206 \begin_layout Plain Layout
27208 \begin_inset space ~
27219 \begin_inset Flex Code
27222 \begin_layout Plain Layout
27230 \begin_inset Quotes eld
27234 \begin_inset space ~
27238 \begin_inset Quotes erd
27241 followed by the volume key.
27242 It is also possible to have an else clause in the conditional,
27244 \begin_inset Newline newline
27248 \begin_inset Flex Code
27251 \begin_layout Plain Layout
27252 {%author%[[%author%]][[%editor%,
27259 \begin_inset Newline newline
27264 \begin_inset Flex Code
27267 \begin_layout Plain Layout
27273 key is printed if it exists;
27275 the editor key is printed,
27277 \begin_inset Quotes eld
27281 \begin_inset space ~
27285 \begin_inset Quotes erd
27288 Note that the key is again enclosed in
27289 \begin_inset Flex Code
27292 \begin_layout Plain Layout
27299 the entire conditional is enclosed in braces;
27300 and the if and else clauses are enclosed in double brackets,
27302 \begin_inset Quotes eld
27306 \begin_inset Flex Code
27309 \begin_layout Plain Layout
27316 \begin_inset Quotes eld
27320 \begin_inset Quotes eld
27324 \begin_inset Flex Code
27327 \begin_layout Plain Layout
27334 \begin_inset Quotes erd
27338 There must be no space between any of these.
27341 \begin_layout Standard
27342 Next to the entry keys,
27343 there are some special keys that can be used for these conditionals:
27346 \begin_layout Itemize
27347 \begin_inset Flex Code
27350 \begin_layout Plain Layout
27351 {%dialog%[[true]][[false]]}
27358 \begin_inset Quotes eld
27362 \begin_inset Quotes erd
27365 part for dialogs and menus,
27367 \begin_inset Quotes eld
27371 \begin_inset Quotes erd
27374 part for other contexts (workarea,
27378 \begin_layout Itemize
27379 \begin_inset Flex Code
27382 \begin_layout Plain Layout
27383 {%export%[[true]][[false]]}
27390 \begin_inset Quotes eld
27394 \begin_inset Quotes erd
27397 part for export and menus,
27399 \begin_inset Quotes eld
27403 \begin_inset Quotes erd
27406 part for other contexts (workarea,
27410 \begin_layout Itemize
27411 \begin_inset Flex Code
27414 \begin_layout Plain Layout
27422 \begin_inset Quotes eld
27426 \begin_inset Quotes erd
27429 part if another item follows (e.
27430 \begin_inset space \thinspace{}
27434 in a citation with multiple keys)
27437 \begin_layout Itemize
27438 \begin_inset Flex Code
27441 \begin_layout Plain Layout
27442 {%second%[[true]][[false]]}
27449 \begin_inset Quotes eld
27453 \begin_inset Quotes erd
27456 if this is the second of multiple items,
27458 \begin_inset Quotes eld
27462 \begin_inset Quotes erd
27468 \begin_layout Itemize
27469 \begin_inset Flex Code
27472 \begin_layout Plain Layout
27473 {%ifstar%[[true]][[false]]}
27480 \begin_inset Quotes eld
27484 \begin_inset Quotes erd
27487 part for starred citation commands (such as
27488 \begin_inset Flex Code
27491 \begin_layout Plain Layout
27500 the false part for unstarred
27503 \begin_layout Itemize
27504 \begin_inset Flex Code
27507 \begin_layout Plain Layout
27508 {%ifentrytype:<type>%[[true]][[false]]}
27515 \begin_inset Quotes eld
27519 \begin_inset Quotes erd
27522 if the current entry type matches
27523 \begin_inset Flex Code
27526 \begin_layout Plain Layout
27533 else the false part (e.g.,
27534 in a citation definition:
27536 \begin_inset Flex Code
27539 \begin_layout Plain Layout
27540 {%ifentrytype:book%[[this is a book]][[this is no book]]}
27548 \begin_layout Itemize
27549 \begin_inset Flex Code
27552 \begin_layout Plain Layout
27553 {%ifmultiple:<authortype>%[[true]][[false]]}
27560 \begin_inset Quotes eld
27564 \begin_inset Quotes erd
27567 if the current author type (author,
27568 editor etc.) has multiple authors,
27569 else the false part (e.g.,
27570 in a bibliography definition:
27572 \begin_inset Flex Code
27575 \begin_layout Plain Layout
27576 {%ifmultiple:editor%[[eds.]][[ed.]]}
27584 \begin_layout Itemize
27585 \begin_inset Flex Code
27588 \begin_layout Plain Layout
27589 {%ifqualified%[[true]][[false]]}
27596 \begin_inset Quotes eld
27600 \begin_inset Quotes erd
27603 part if the current citation is a qualified citation list (a specific
27607 format for multi-reference citations),
27608 the false part if this is not the case.
27611 \begin_layout Standard
27613 \begin_inset Flex Code
27616 \begin_layout Plain Layout
27622 prints the author key as it is recorded in the bibliography file.
27623 This might not be what you want,
27624 since it will result in a string such as
27625 \begin_inset Quotes eld
27632 \begin_inset Quotes erd
27636 \begin_inset Quotes eld
27640 \begin_inset Quotes erd
27643 is used by Bib\SpecialChar TeX
27644 to delimit authors).
27646 therefore provides some methods to get properly formatted name lists (which will also get translated).
27647 The following keys are provided:
27650 \begin_layout Enumerate
27651 For name lists with pre- and surname,
27652 suitable for the main authors/editors of a bibliography item.
27654 \begin_inset Flex Code
27657 \begin_layout Plain Layout
27663 part denotes the kind of list that is requested (e.g.
27665 \begin_inset Flex Code
27668 \begin_layout Plain Layout
27678 \begin_layout Itemize
27679 \begin_inset Flex Code
27682 \begin_layout Plain Layout
27683 %abbrvnames:<nametype>%
27689 Provides a name list which is abbreviated (with
27690 \begin_inset Quotes eld
27694 \begin_inset Quotes erd
27698 \begin_inset Flex Code
27701 \begin_layout Plain Layout
27710 \begin_layout Itemize
27711 \begin_inset Flex Code
27714 \begin_layout Plain Layout
27715 %fullnames:<nametype>%
27721 Provides a full name list (never abbreviated with
27722 \begin_inset Quotes eld
27726 \begin_inset Quotes erd
27732 \begin_layout Itemize
27733 \begin_inset Flex Code
27736 \begin_layout Plain Layout
27737 %forceabbrvnames:<nametype>%
27743 Provides a name list which is always abbreviated (with
27744 \begin_inset Quotes eld
27748 \begin_inset Quotes erd
27752 \begin_inset Flex Code
27755 \begin_layout Plain Layout
27765 \begin_layout Enumerate
27766 Alternative name lists with pre- and surname,
27767 if the order of pre- and surname inside the bibliography item differs (as in:
27769 \begin_inset Quotes eld
27779 \begin_inset Quotes erd
27786 \begin_layout Itemize
27787 \begin_inset Flex Code
27790 \begin_layout Plain Layout
27791 %abbrvbynames:<nametype>%
27797 Provides a name list which is abbreviated (with
27798 \begin_inset Quotes eld
27802 \begin_inset Quotes erd
27806 \begin_inset Flex Code
27809 \begin_layout Plain Layout
27818 \begin_layout Itemize
27819 \begin_inset Flex Code
27822 \begin_layout Plain Layout
27823 %fullbynames:<nametype>%
27829 Provides a full name list (never abbreviated with
27830 \begin_inset Quotes eld
27834 \begin_inset Quotes erd
27840 \begin_layout Itemize
27841 \begin_inset Flex Code
27844 \begin_layout Plain Layout
27845 %forceabbrvbynames:<nametype>%
27851 Provides a name list which is always abbreviated (with
27852 \begin_inset Quotes eld
27856 \begin_inset Quotes erd
27860 \begin_inset Flex Code
27863 \begin_layout Plain Layout
27873 \begin_layout Enumerate
27874 And finally name lists which consist of family names only,
27875 as used in author-year citation labels.
27876 These do not take a
27877 \begin_inset Flex Code
27880 \begin_layout Plain Layout
27887 but always return either an author list or,
27888 if this does not exist,
27889 an editor list (as common in author-year labels):
27893 \begin_layout Itemize
27894 \begin_inset Flex Code
27897 \begin_layout Plain Layout
27904 Provides a name list which is abbreviated (with
27905 \begin_inset Quotes eld
27909 \begin_inset Quotes erd
27913 \begin_inset Flex Code
27916 \begin_layout Plain Layout
27925 \begin_layout Itemize
27926 \begin_inset Flex Code
27929 \begin_layout Plain Layout
27936 Provides a full name list (never abbreviated with
27937 \begin_inset Quotes eld
27941 \begin_inset Quotes erd
27947 \begin_layout Itemize
27948 \begin_inset Flex Code
27951 \begin_layout Plain Layout
27952 %forceabbrvciteauthor%
27958 Provides a name list which is always abbreviated (with
27959 \begin_inset Quotes eld
27963 \begin_inset Quotes erd
27967 \begin_inset Flex Code
27970 \begin_layout Plain Layout
27980 \begin_layout Standard
27981 The order of pre- and surname in the former two lists can be adjusted by these macros:
27984 \begin_layout Itemize
27985 \begin_inset Flex Code
27988 \begin_layout Plain Layout
27989 !firstnameform %surname%,
27995 (first author in lists of type 1)
27998 \begin_layout Itemize
27999 \begin_inset Flex Code
28002 \begin_layout Plain Layout
28003 !othernameform %surname%,
28009 (other authors in lists of type 1)
28012 \begin_layout Itemize
28013 \begin_inset Flex Code
28016 \begin_layout Plain Layout
28017 !firstbynameform %prename% %surname%
28022 (first author in lists of type 2)
28025 \begin_layout Itemize
28026 \begin_inset Flex Code
28029 \begin_layout Plain Layout
28030 !otherbynameform %prename% %surname%
28035 (other authors in lists of type 2)
28038 \begin_layout Standard
28039 This allows you to configure namings like
28040 \begin_inset Quotes eld
28044 Peter and Mary Smith:
28048 John Doe and Pat Green,
28049 eds.:\SpecialChar ldots
28051 \begin_inset Quotes erd
28057 \begin_layout Standard
28058 There is one other piece of syntax available in definitions,
28059 which looks like this:
28061 \begin_inset Flex Code
28064 \begin_layout Plain Layout
28071 This defines a piece of formatting information that is to be used when creating
28072 \begin_inset Quotes eld
28076 \begin_inset Quotes erd
28081 we do not want to output HTML tags when writing plain text,
28082 so they should be wrapped in
28083 \begin_inset Quotes eld
28087 \begin_inset Quotes erd
28091 \begin_inset Quotes eld
28095 \begin_inset Quotes erd
28101 \begin_layout Standard
28102 Two special sorts of definitions are also possible in a
28103 \begin_inset Flex Code
28106 \begin_layout Plain Layout
28113 An example of the first would be:
28116 \begin_layout LyX-Code
28118 \begin_inset Quotes eld
28122 \begin_inset Quotes erd
28128 \begin_layout Standard
28129 This is an abbreviation,
28131 and it can be used by treating it as if it were a key:
28133 \begin_inset Flex Code
28136 \begin_layout Plain Layout
28145 \begin_inset Flex Code
28148 \begin_layout Plain Layout
28154 exactly as it would treat its definition.
28156 let us issue the obvious
28164 \begin_layout LyX-Code
28168 \begin_layout Standard
28169 or anything like it.
28171 shouldn't go into an infinite loop,
28172 but it may go into a long one before it gives up.
28175 \begin_layout Standard
28176 The second sort of special definition might look like this:
28179 \begin_layout LyX-Code
28183 \begin_layout Standard
28184 This defines a translatable piece of text,
28185 which allows relevant parts of the bibliography or citation to be translated.
28186 It can be included in a definition by treating it as a key:
28188 \begin_inset Flex Code
28191 \begin_layout Plain Layout
28198 Note that there are two different translation paths:
28199 All definitions starting with
28200 \begin_inset Flex Code
28203 \begin_layout Plain Layout
28210 such as in the example above,
28211 will be translated to the currently active buffer language (so the translation will match the generated document).
28212 All definitions starting with underscore only will be translated to the GUI language.
28213 This is the proper translation for strings that only occur in the dialogs or on buttons,
28217 \begin_layout LyX-Code
28218 _addtobib Add to bibliography only.
28221 \begin_layout Standard
28222 Several of these translatable strings are predefined in
28223 \begin_inset Flex Code
28226 \begin_layout Plain Layout
28233 \begin_inset Flex Code
28236 \begin_layout Plain Layout
28243 Note that these are not macros,
28244 in the sense just defined.
28245 They will not be expanded.
28248 \begin_layout Standard
28249 So here then is an example that uses several of these features:
28250 \begin_inset VSpace defskip
28256 \begin_layout Standard
28260 !authoredit {%author%[[%author%,
28261 ]][[{%editor%[[%editor%,
28266 \begin_layout Standard
28267 \begin_inset VSpace defskip
28270 This defines a macro that prints the author,
28271 followed by a comma,
28273 \begin_inset Flex Code
28276 \begin_layout Plain Layout
28283 or else prints the name of the editor,
28285 \begin_inset Flex Code
28288 \begin_layout Plain Layout
28294 or its translation (it is by default
28295 \begin_inset Quotes eld
28299 \begin_inset Quotes erd
28304 \begin_inset Flex Code
28307 \begin_layout Plain Layout
28314 Note that this is in fact defined in
28315 \begin_inset Flex Code
28318 \begin_layout Plain Layout
28325 so you can use it in your own definitions,
28327 if you load that file first.
28330 \begin_layout Section
28331 \begin_inset CommandInset label
28333 name "sec:Tags-for-XHTML"
28337 Tags for XHTML output
28340 \begin_layout Standard
28341 As with \SpecialChar LaTeX
28343 the format of \SpecialChar LyX
28344 's XHTML output is also controlled by layout information.
28347 provides sensible defaults and,
28348 as mentioned earlier,
28349 it will even construct default CSS style rules from the other layout tags.
28352 will attempt to use the information provided in the
28353 \begin_inset Flex Code
28356 \begin_layout Plain Layout
28362 declaration for the Chapter style to write CSS that will appropriately format chapter headings.
28365 \begin_layout Standard
28368 you may not have to do anything at all to get acceptable XHTML output for your own environments,
28371 But in some cases you will,
28372 and so \SpecialChar LyX
28373 provides a number of layout tags that can be used to customize the XHTML and CSS that are generated.
28376 \begin_layout Standard
28377 Note that there are two tags,
28379 \begin_inset Flex Code
28382 \begin_layout Plain Layout
28389 \begin_inset Flex Code
28392 \begin_layout Plain Layout
28398 that may appear outside style and inset declarations.
28400 \begin_inset CommandInset ref
28402 reference "subsec:General-text-class"
28406 for details on these.
28409 \begin_layout Subsection
28410 \begin_inset CommandInset label
28412 name "subsec:Paragraph-Style-XHTML"
28419 \begin_layout Standard
28420 The sort of XHTML \SpecialChar LyX
28421 outputs for a paragraph depends upon whether we are dealing with a normal paragraph,
28424 where this is itself determined by the contents of the corresponding
28425 \begin_inset Flex Code
28428 \begin_layout Plain Layout
28439 \begin_layout Standard
28440 For a command or normal paragraph,
28441 the output XHTML has the following form:
28444 \begin_layout LyX-Code
28448 \begin_inset Quotes erd
28452 \begin_inset Quotes erd
28458 \begin_layout LyX-Code
28462 \begin_inset Quotes erd
28466 \begin_inset Quotes erd
28472 \begin_layout LyX-Code
28475 Contents of the paragraph.
28478 \begin_layout LyX-Code
28484 \begin_layout Standard
28485 The label tags are of course omitted if the paragraph does not have a label.
28488 \begin_layout Standard
28489 For an environment that is not some sort of list,
28490 the XHTML takes this form:
28493 \begin_layout LyX-Code
28497 \begin_inset Quotes erd
28501 \begin_inset Quotes erd
28507 \begin_layout LyX-Code
28511 \begin_inset Quotes erd
28515 \begin_inset Quotes erd
28519 \begin_inset Quotes erd
28523 \begin_inset Quotes erd
28526 >Environment Label</labeltag>First paragraph.</itemtag>
28529 \begin_layout LyX-Code
28532 <itemtag>Second paragraph.</itemtag>
28535 \begin_layout LyX-Code
28541 \begin_layout Standard
28542 Note that the label is output only for the first paragraph,
28543 as it should be for a theorem,
28548 \begin_layout Standard
28550 we have one of these forms:
28553 \begin_layout LyX-Code
28557 \begin_inset Quotes erd
28561 \begin_inset Quotes erd
28567 \begin_layout LyX-Code
28571 \begin_inset Quotes erd
28575 \begin_inset Quotes erd
28579 \begin_inset Quotes erd
28583 \begin_inset Quotes erd
28586 >List Label</labeltag>First item.</itemtag>
28589 \begin_layout LyX-Code
28593 \begin_inset Quotes erd
28597 \begin_inset Quotes erd
28601 \begin_inset Quotes erd
28605 \begin_inset Quotes erd
28608 >List Label</labeltag>Second item.</itemtag>
28611 \begin_layout LyX-Code
28617 \begin_layout LyX-Code
28621 \begin_layout LyX-Code
28625 \begin_inset Quotes erd
28629 \begin_inset Quotes erd
28635 \begin_layout LyX-Code
28639 \begin_inset Quotes erd
28643 \begin_inset Quotes erd
28646 >List Label</labeltag><itemtag attr=
28647 \begin_inset Quotes erd
28651 \begin_inset Quotes erd
28654 >First item.</itemtag>
28657 \begin_layout LyX-Code
28661 \begin_inset Quotes erd
28665 \begin_inset Quotes erd
28668 >List Label</labeltag><itemtag attr=
28669 \begin_inset Quotes erd
28673 \begin_inset Quotes erd
28676 >Second item.</itemtag>
28679 \begin_layout LyX-Code
28685 \begin_layout Standard
28686 Note the different orders of
28687 \begin_inset Flex Code
28690 \begin_layout Plain Layout
28697 \begin_inset Flex Code
28700 \begin_layout Plain Layout
28707 Which order we get depends upon the setting of
28708 \begin_inset Flex Code
28711 \begin_layout Plain Layout
28719 \begin_inset Flex Code
28722 \begin_layout Plain Layout
28728 is false (the default),
28729 you get the first of these,
28730 with the label within the item;
28732 you get the second,
28733 with the label outside the item.
28736 \begin_layout Standard
28737 The specific tags and attributes output for each paragraph type can be controlled by means of the layout tags we are about to describe.
28738 As mentioned earlier,
28741 uses sensible defaults for many of these,
28742 so you often may not need to do very much to get good XHTML output.
28743 Think of the available tags as there so you can tweak things to your liking.
28746 \begin_layout Description
28747 \begin_inset Flex Code
28750 \begin_layout Plain Layout
28757 \begin_inset Flex Code
28760 \begin_layout Plain Layout
28766 ] Specifies attribute information to be output with the main tag.
28769 \begin_inset Quotes eld
28773 \begin_inset Flex Code
28776 \begin_layout Plain Layout
28783 \begin_inset Quotes erd
28790 \begin_inset Quotes eld
28794 \begin_inset Flex Code
28797 \begin_layout Plain Layout
28804 \begin_inset Quotes erd
28809 \begin_inset Flex Code
28812 \begin_layout Plain Layout
28818 is the \SpecialChar LyX
28819 name of the layout,
28827 contain any style information.
28829 \begin_inset Flex Code
28832 \begin_layout Plain Layout
28839 \change_inserted -584632292 1670182206
28843 \begin_layout Description
28845 \change_inserted -584632292 1670182369
28846 \begin_inset Flex Code
28849 \begin_layout Plain Layout
28851 \change_inserted -584632292 1670182222
28858 \begin_inset Flex Code
28861 \begin_layout Plain Layout
28863 \change_inserted -584632292 1670182217
28869 ] The CSS class to use for this paragraph.
28871 if the paragarph is of enumerate or itemize type,
28872 then the default will be
28873 \begin_inset Quotes eld
28877 \begin_inset Quotes erd
28881 \begin_inset Quotes eld
28885 \begin_inset Quotes erd
28890 \begin_inset Quotes eld
28894 \begin_inset Quotes erd
28899 \begin_inset Quotes eld
28903 \begin_inset Quotes erd
28908 \begin_inset Quotes eld
28912 \begin_inset Quotes erd
28917 \begin_inset Quotes eld
28921 \begin_inset Quotes erd
28925 depending upon the depth.
28926 That can be over-ridden here.
28928 the suffix will not be added in that case.
28930 the CSS class will always be exactly what it is declared to be here.
28935 \begin_layout Description
28936 \begin_inset Flex Code
28939 \begin_layout Plain Layout
28946 \begin_inset Flex Code
28949 \begin_layout Plain Layout
28959 ] Whether to output the default CSS information \SpecialChar LyX
28960 generates for this layout,
28961 even if additional information is explicitly provided via
28962 \begin_inset Flex Code
28965 \begin_layout Plain Layout
28973 \begin_inset Flex Code
28976 \begin_layout Plain Layout
28982 allows you to alter or augment the generated CSS,
28983 rather than to override it completely.
28985 \begin_inset Flex Code
28988 \begin_layout Plain Layout
28995 \change_inserted -584632292 1670132213
28999 \begin_layout Description
29001 \change_inserted -584632292 1670132277
29002 \begin_inset Flex Code
29005 \begin_layout Plain Layout
29007 \change_inserted -584632292 1670132221
29016 \begin_inset Flex Code
29019 \begin_layout Plain Layout
29021 \change_inserted -584632292 1670132214
29031 ] Whether to include this paragraph (usually,
29032 a section or something of the sort) in the TOC.
29035 so it should be set to false e.g.
29036 \begin_inset space ~
29039 for starred sections.
29044 \begin_layout Description
29045 \begin_inset Flex Code
29048 \begin_layout Plain Layout
29055 \begin_inset Flex Code
29058 \begin_layout Plain Layout
29064 ] The tag to be used for individual paragraphs of environments,
29066 \begin_inset Flex Code
29069 \begin_layout Plain Layout
29075 in the examples above.
29077 \begin_inset Flex Code
29080 \begin_layout Plain Layout
29089 \begin_layout Description
29090 \begin_inset Flex Code
29093 \begin_layout Plain Layout
29100 \begin_inset Flex Code
29103 \begin_layout Plain Layout
29109 ] Attributes for the item tag.
29111 \begin_inset Newline newline
29115 \begin_inset Quotes eld
29119 \begin_inset Flex Code
29122 \begin_layout Plain Layout
29123 class=`layoutname_item'
29129 \begin_inset Quotes erd
29137 contain any style information.
29139 \begin_inset Flex Code
29142 \begin_layout Plain Layout
29151 \begin_layout Description
29152 \begin_inset Flex Code
29155 \begin_layout Plain Layout
29162 \begin_inset Flex Code
29165 \begin_layout Plain Layout
29171 ] The tag to be used for paragraph and item labels,
29173 \begin_inset Flex Code
29176 \begin_layout Plain Layout
29182 in the examples above.
29184 \begin_inset Flex Code
29187 \begin_layout Plain Layout
29195 \begin_inset Flex Code
29198 \begin_layout Plain Layout
29205 \begin_inset Flex Code
29208 \begin_layout Plain Layout
29215 \begin_inset Flex Code
29218 \begin_layout Plain Layout
29219 Centered_Top_Environment
29225 in which case it defaults to
29226 \begin_inset Flex Code
29229 \begin_layout Plain Layout
29238 \begin_layout Description
29239 \begin_inset Flex Code
29242 \begin_layout Plain Layout
29249 \begin_inset Flex Code
29252 \begin_layout Plain Layout
29258 ] Attributes for the label tag.
29260 \begin_inset Newline newline
29264 \begin_inset Quotes eld
29268 \begin_inset Flex Code
29271 \begin_layout Plain Layout
29272 class=`layoutname_label'
29278 \begin_inset Quotes erd
29286 contain any style information.
29288 \begin_inset Flex Code
29291 \begin_layout Plain Layout
29300 \begin_layout Description
29301 \begin_inset Flex Code
29304 \begin_layout Plain Layout
29311 \begin_inset Flex Code
29314 \begin_layout Plain Layout
29324 ] Meaningful only for list-like environments,
29325 this tag controls whether the label tag is output before or inside the item tag.
29328 in the description environment,
29330 \begin_inset Flex Code
29333 \begin_layout Plain Layout
29334 <dt>\SpecialChar ldots
29335 </dt><dd>\SpecialChar ldots
29343 \begin_inset Flex Code
29346 \begin_layout Plain Layout
29353 The label tag is output inside the item tag.
29356 \begin_layout Description
29357 \begin_inset Flex Code
29360 \begin_layout Plain Layout
29366 Information to be output in the
29367 \begin_inset Flex Code
29370 \begin_layout Plain Layout
29376 section when this style is used.
29379 be used to include a
29380 \begin_inset Flex Code
29383 \begin_layout Plain Layout
29390 \begin_inset Flex Code
29393 \begin_layout Plain Layout
29402 \begin_layout Description
29403 \begin_inset Flex Code
29406 \begin_layout Plain Layout
29412 CSS style information to be included when this style is used.
29413 Note that this will automatically be wrapped in a layout-generated
29414 \begin_inset Flex Code
29417 \begin_layout Plain Layout
29424 so only the CSS itself need be included.
29426 \begin_inset Flex Code
29429 \begin_layout Plain Layout
29438 \begin_layout Description
29439 \begin_inset Flex Code
29442 \begin_layout Plain Layout
29449 \begin_inset Flex Code
29452 \begin_layout Plain Layout
29458 ] The tag to be used for the main label,
29460 \begin_inset Flex Code
29463 \begin_layout Plain Layout
29469 in the examples above.
29471 \begin_inset Flex Code
29474 \begin_layout Plain Layout
29483 \begin_layout Description
29484 \begin_inset Flex Code
29487 \begin_layout Plain Layout
29494 \begin_inset Flex Code
29497 \begin_layout Plain Layout
29507 ] Marks this style as the one to be used to generate the
29508 \begin_inset Flex Code
29511 \begin_layout Plain Layout
29517 tag for the XHTML file.
29521 \begin_inset Flex Code
29524 \begin_layout Plain Layout
29530 file sets it to true for the
29531 \begin_inset Flex Code
29534 \begin_layout Plain Layout
29544 \begin_layout Subsection
29548 \begin_layout Standard
29549 The XHTML output of insets can also be controlled by information in layout files.
29553 \begin_layout Plain Layout
29555 this is true only for
29556 \begin_inset Quotes eld
29560 \begin_inset Quotes erd
29563 insets (insets you can type into) and is not true for
29564 \begin_inset Quotes eld
29568 \begin_inset Quotes erd
29571 insets (insets that are associated with dialog boxes).
29579 tries to provide sensible defaults,
29580 and it constructs default CSS style rules.
29581 But everything can be customized.
29584 \begin_layout Standard
29585 The XHTML \SpecialChar LyX
29586 outputs for an inset has the following form:
29589 \begin_layout LyX-Code
29591 \begin_inset Quotes erd
29595 \begin_inset Quotes erd
29601 \begin_layout LyX-Code
29602 <labeltag>Label</labeltag>
29605 \begin_layout LyX-Code
29607 \begin_inset Quotes erd
29611 \begin_inset Quotes erd
29614 >Contents of the inset.</innertag>
29617 \begin_layout LyX-Code
29621 \begin_layout Standard
29622 If the inset permits multiple paragraphs—
29625 \begin_inset Flex Code
29628 \begin_layout Plain Layout
29635 then the contents of the inset will itself be output as paragraphs formatted according to the styles used for those paragraphs (standard,
29638 The label tag is of course omitted if the paragraph does not have a label and,
29641 \begin_inset Flex Code
29644 \begin_layout Plain Layout
29651 The inner tag is optional and,
29656 \begin_layout Standard
29657 The specific tags and attributes output for each inset can be controlled by means of the following layout tags.
29660 \begin_layout Description
29661 \begin_inset Flex Code
29664 \begin_layout Plain Layout
29671 \begin_inset Flex Code
29674 \begin_layout Plain Layout
29680 ] Specifies attribute information to be output with the main tag.
29683 \begin_inset Quotes eld
29687 \begin_inset Flex Code
29690 \begin_layout Plain Layout
29691 class=`myinset' onclick=`\SpecialChar ldots
29698 \begin_inset Quotes erd
29705 \begin_inset Quotes eld
29709 \begin_inset Flex Code
29712 \begin_layout Plain Layout
29719 \begin_inset Quotes erd
29724 \begin_inset Flex Code
29727 \begin_layout Plain Layout
29733 is the \SpecialChar LyX
29735 made lowercase and with non-alphanumeric characters converted to underscores,
29740 \begin_layout Description
29741 \begin_inset Flex Code
29744 \begin_layout Plain Layout
29751 \begin_inset Flex Code
29754 \begin_layout Plain Layout
29764 ] Whether to output the default CSS information \SpecialChar LyX
29765 generates for this layout,
29766 even if additional information is explicitly provided via
29767 \begin_inset Flex Code
29770 \begin_layout Plain Layout
29778 \begin_inset Flex Code
29781 \begin_layout Plain Layout
29787 allows you to alter or augment the generated CSS,
29788 rather than to override it completely.
29792 \begin_layout Description
29793 \begin_inset Flex Code
29796 \begin_layout Plain Layout
29803 \begin_inset Flex Code
29806 \begin_layout Plain Layout
29812 ] Attributes for the inner tag.
29814 \begin_inset Newline newline
29818 \begin_inset Quotes eld
29822 \begin_inset Flex Code
29825 \begin_layout Plain Layout
29826 class=`insetname_inner'
29832 \begin_inset Quotes erd
29838 \begin_layout Description
29839 \begin_inset Flex Code
29842 \begin_layout Plain Layout
29849 \begin_inset Flex Code
29852 \begin_layout Plain Layout
29860 \begin_inset Flex Code
29863 \begin_layout Plain Layout
29869 in the examples above.
29874 \begin_layout Description
29875 \begin_inset Flex Code
29878 \begin_layout Plain Layout
29885 \begin_inset Flex Code
29888 \begin_layout Plain Layout
29896 ] Whether this inset represents a standalone block of text (such as a footnote) or instead represents material that is included in the surrounding text (such as a branch).
29900 \begin_layout Description
29901 \begin_inset Flex Code
29904 \begin_layout Plain Layout
29911 \begin_inset Flex Code
29914 \begin_layout Plain Layout
29920 ] A label for this inset,
29921 possibly including a reference to a counter.
29926 \begin_inset Flex Code
29929 \begin_layout Plain Layout
29939 and there is no default.
29942 \begin_layout Description
29943 \begin_inset Flex Code
29946 \begin_layout Plain Layout
29952 Information to be output in the
29953 \begin_inset Flex Code
29956 \begin_layout Plain Layout
29962 section when this style is used.
29965 be used to include a
29966 \begin_inset Flex Code
29969 \begin_layout Plain Layout
29976 \begin_inset Flex Code
29979 \begin_layout Plain Layout
29988 \begin_layout Description
29989 \begin_inset Flex Code
29992 \begin_layout Plain Layout
29998 CSS style information to be included when this style is used.
29999 Note that this will automatically be wrapped in a layout-generated
30000 \begin_inset Flex Code
30003 \begin_layout Plain Layout
30010 so only the CSS itself need be included.
30013 \begin_layout Description
30014 \begin_inset Flex Code
30017 \begin_layout Plain Layout
30024 \begin_inset Flex Code
30027 \begin_layout Plain Layout
30033 ] The tag to be used for the main label,
30035 \begin_inset Flex Code
30038 \begin_layout Plain Layout
30044 in the examples above.
30045 The default depends upon the setting of
30046 \begin_inset Flex Code
30049 \begin_layout Plain Layout
30057 \begin_inset Flex Code
30060 \begin_layout Plain Layout
30068 \begin_inset Flex Code
30071 \begin_layout Plain Layout
30080 \begin_inset Flex Code
30083 \begin_layout Plain Layout
30092 \begin_layout Subsection
30096 \begin_layout Standard
30097 The XHTML output for floats too can be controlled by layout information.
30098 The output has the following form:
30101 \begin_layout LyX-Code
30103 \begin_inset Quotes erd
30107 \begin_inset Quotes erd
30113 \begin_layout LyX-Code
30114 Contents of the float.
30117 \begin_layout LyX-Code
30121 \begin_layout Standard
30124 is a separate inset and will be output as such.
30125 Its appearance can be controlled via the InsetLayout for caption insets.
30129 \begin_layout Description
30130 \begin_inset Flex Code
30133 \begin_layout Plain Layout
30140 \begin_inset Flex Code
30143 \begin_layout Plain Layout
30149 ] Specifies attribute information to be output with the main tag.
30152 \begin_inset Quotes eld
30156 \begin_inset Flex Code
30159 \begin_layout Plain Layout
30160 class=`myfloat' onclick=`\SpecialChar ldots
30167 \begin_inset Quotes erd
30174 \begin_inset Quotes eld
30178 \begin_inset Flex Code
30181 \begin_layout Plain Layout
30182 class=`float float-floattype'
30188 \begin_inset Quotes erd
30193 \begin_inset Flex Code
30196 \begin_layout Plain Layout
30202 is \SpecialChar LyX
30203 's name for this type of float,
30204 as determined by the float declaration (see
30205 \begin_inset CommandInset ref
30207 reference "subsec:Floats"
30212 though made lowercase and with non-alphanumeric characters converted to underscores,
30217 \begin_layout Description
30218 \begin_inset Flex Code
30221 \begin_layout Plain Layout
30227 CSS style information to be included when this float is used.
30228 Note that this will automatically be wrapped in a layout-generated
30229 \begin_inset Flex Code
30232 \begin_layout Plain Layout
30239 so only the CSS itself need be included.
30242 \begin_layout Description
30243 \begin_inset Flex Code
30246 \begin_layout Plain Layout
30253 \begin_inset Flex Code
30256 \begin_layout Plain Layout
30262 ] The tag to be used for this float,
30264 \begin_inset Quotes eld
30268 \begin_inset Flex Code
30271 \begin_layout Plain Layout
30278 \begin_inset Quotes erd
30281 in the example above.
30283 \begin_inset Flex Code
30286 \begin_layout Plain Layout
30292 and will rarely need changing.
30295 \begin_layout Subsection
30296 Bibliography formatting
30299 \begin_layout Standard
30300 The bibliography can be formatted using
30301 \begin_inset Flex Code
30304 \begin_layout Plain Layout
30312 \begin_inset CommandInset ref
30314 reference "subsec:Citation-format-description"
30321 \begin_layout Subsection
30326 \begin_layout Standard
30327 We have several times mentioned that \SpecialChar LyX
30328 will generate default CSS style rules for both insets and paragraph styles,
30329 based upon the other layout information that is provided.
30331 we shall say a word about which layout information \SpecialChar LyX
30335 \begin_layout Standard
30338 auto-generates CSS only for font information,
30340 \begin_inset Flex Code
30343 \begin_layout Plain Layout
30351 \begin_inset Flex Code
30354 \begin_layout Plain Layout
30362 \begin_inset Flex Code
30365 \begin_layout Plain Layout
30373 \begin_inset Flex Code
30376 \begin_layout Plain Layout
30383 \begin_inset Flex Code
30386 \begin_layout Plain Layout
30393 \begin_inset CommandInset ref
30395 reference "subsec:Font-description"
30400 The translation is mostly straightforward and obvious.
30403 \begin_inset Quotes eld
30407 \begin_inset Flex Code
30410 \begin_layout Plain Layout
30417 \begin_inset Quotes erd
30421 \begin_inset Quotes eld
30425 \begin_inset Flex Code
30428 \begin_layout Plain Layout
30436 \begin_inset Quotes erd
30440 The correspondence of \SpecialChar LyX
30441 sizes and CSS sizes is a little less obvious but nonetheless intuitive.
30443 \begin_inset Flex Code
30446 \begin_layout Plain Layout
30453 \begin_inset Flex URL
30456 \begin_layout Plain Layout
30464 \change_inserted -970929547 1496610908
30468 \begin_layout Section
30470 \change_inserted -970929547 1496610966
30471 \begin_inset CommandInset label
30473 name "sec:Tags-for-DocBook"
30477 Tags for DocBook output
30480 \begin_layout Standard
30482 \change_inserted -970929547 1496611615
30483 As with \SpecialChar LaTeX
30485 the format of \SpecialChar LyX
30486 's DocBook output is also controlled by layout information.
30489 provides sensible defaults;
30491 much of the styling is lost during the conversion,
30492 as DocBook is strictly semantic and does not allow formatting.
30494 information from \SpecialChar LyX
30495 will be rendered in
30503 \begin_layout Standard
30505 \change_inserted -970929547 1496612080
30508 you may not have to do anything at all to get acceptable DocBook output for your own environments,
30511 But in some cases you will,
30512 and so \SpecialChar LyX
30513 provides a number of layout tags that can be used to customize the DocBook that is generated.
30516 \begin_layout Standard
30518 \change_inserted -970929547 1515109912
30519 Labels are rarely output,
30520 as they are redundant in DocBook:
30521 this information is carried by the tags themselves,
30522 and whether labels appear in the final documents (after processing of DocBook files) is controlled by the stylesheets.
30525 labels are not redundant content,
30526 such as definition lists:
30528 the term being defined will be the label.
30532 \begin_layout Subsection
30534 \change_inserted 1075283030 1597699417
30535 \begin_inset CommandInset label
30537 name "subsec:Paragraph-Style-DocBook"
30542 \change_deleted 1075283030 1597699417
30544 \begin_inset CommandInset label
30546 name "subsec:Paragraph-Style-XHTML-1"
30551 \change_inserted -970929547 1496610966
30555 \begin_layout Standard
30557 \change_inserted -970929547 1496612059
30558 The sort of DocBook \SpecialChar LyX
30559 outputs for a paragraph depends upon whether we are dealing with a normal paragraph,
30562 where this is itself determined by the contents of the corresponding
30563 \begin_inset Flex Code
30566 \begin_layout Plain Layout
30568 \change_inserted -970929547 1496610966
30581 \begin_layout Standard
30583 \change_inserted -970929547 1496612107
30584 For a command or normal paragraph,
30585 the output DocBook has the following form:
30588 \begin_layout LyX-Code
30590 \change_inserted -970929547 1515109666
30594 \begin_layout LyX-Code
30596 \change_inserted -970929547 1496610966
30597 Contents of the paragraph.
30600 \begin_layout LyX-Code
30602 \change_inserted -970929547 1496610966
30606 \begin_layout Standard
30608 \change_inserted -970929547 1515109821
30609 For an environment that is not some sort of list,
30610 the generated DocBook takes this form:
30613 \begin_layout LyX-Code
30615 \change_inserted -970929547 1515109671
30619 \begin_layout LyX-Code
30621 \change_inserted -970929547 1496612114
30622 <itemtag>First paragraph.</itemtag>
30625 \begin_layout LyX-Code
30627 \change_inserted -970929547 1496610966
30628 <itemtag>Second paragraph.</itemtag>
30631 \begin_layout LyX-Code
30633 \change_inserted -970929547 1496610966
30637 \begin_layout Standard
30639 \change_inserted -970929547 1515109825
30641 the resulting DocBook takes this form:
30644 \begin_layout LyX-Code
30646 \change_inserted -970929547 1515109672
30650 \begin_layout LyX-Code
30652 \change_inserted -970929547 1515109676
30653 <itemtag attr>First item.</itemtag>
30656 \begin_layout LyX-Code
30658 \change_inserted -970929547 1515109678
30659 <itemtag attr>Second item.</itemtag>
30662 \begin_layout LyX-Code
30664 \change_inserted -970929547 1496610966
30668 \begin_layout Standard
30670 \change_inserted -970929547 1496612243
30671 The specific tags and roles output for each paragraph type can be controlled by means of the layout tags we are about to describe.
30673 due to the very nature of DocBook,
30674 no sensible defaults really exist,
30675 and the values must always be carefully chosen.
30679 \begin_layout Description
30681 \change_inserted -970929547 1515110057
30682 \begin_inset Flex Code
30685 \begin_layout Plain Layout
30687 \change_inserted -970929547 1515109656
30696 \begin_inset Flex Code
30699 \begin_layout Plain Layout
30701 \change_inserted -970929547 1496610966
30709 ] Specifies attribute information to be output with the main tag,
30711 \begin_inset Quotes eld
30715 \begin_inset Flex Code
30718 \begin_layout Plain Layout
30720 \change_inserted -970929547 1515110057
30729 \begin_inset Quotes erd
30732 in the example above.
30733 This information can be used in further processing of the DocBook files.
30739 \begin_layout Description
30741 \change_inserted -970929547 1496612296
30742 \begin_inset Flex Code
30745 \begin_layout Plain Layout
30747 \change_inserted -970929547 1496612269
30756 \begin_inset Flex Code
30759 \begin_layout Plain Layout
30761 \change_inserted -970929547 1496610966
30769 ] The tag to be used for this inset,
30771 \begin_inset Quotes eld
30775 \begin_inset Flex Code
30778 \begin_layout Plain Layout
30780 \change_inserted -970929547 1496612296
30789 \begin_inset Quotes erd
30792 in the example above.
30793 The default is the name of the float and always needs to be changed,
30794 as DocBook provides no generic tag.
30795 \change_inserted 1075283030 1597698868
30799 \begin_layout Description
30801 \change_inserted 1075283030 1597699399
30802 \begin_inset Flex Code
30805 \begin_layout Plain Layout
30807 \change_inserted 1075283030 1597698872
30816 \begin_inset Flex Code
30819 \begin_layout Plain Layout
30821 \change_inserted 1075283030 1597700585
30831 ] The new-line policy for this tag,
30833 \begin_inset space ~
30837 \begin_inset CommandInset ref
30839 reference "subsec:DocBook-New-line-policy"
30852 \begin_layout Subsection
30854 \change_inserted 1075283030 1597699385
30856 \begin_inset CommandInset label
30858 name "subsec:DocBook-New-line-policy"
30865 \begin_layout Standard
30867 \change_inserted 1075283030 1597698993
30869 there are three possible policies for outputting new lines (given in the
30870 \begin_inset Flex Code
30873 \begin_layout Plain Layout
30875 \change_inserted 1075283030 1597698987
30887 \begin_layout Itemize
30889 \change_inserted 1075283030 1597699279
30890 \begin_inset Quotes eld
30894 \begin_inset Flex Code
30897 \begin_layout Plain Layout
30899 \change_inserted 1075283030 1597699012
30908 \begin_inset Quotes erd
30912 the opening and closing tags are on their own lines (i.e.
30913 a line feed after and before the opening and the closing tags).
30914 Typical elements are floats.
30919 \begin_layout LyX-Code
30921 \change_inserted 1075283030 1597699194
30925 \begin_layout LyX-Code
30927 \change_inserted 1075283030 1597699194
30931 \begin_layout LyX-Code
30933 \change_inserted 1075283030 1597699098
30934 Contents of the block.
30937 \begin_layout LyX-Code
30939 \change_inserted 1075283030 1597699196
30943 \begin_layout LyX-Code
30945 \change_inserted 1075283030 1597699198
30949 \begin_layout Itemize
30951 \change_inserted 1075283030 1597699289
30952 \begin_inset Quotes eld
30956 \begin_inset Flex Code
30959 \begin_layout Plain Layout
30961 \change_inserted 1075283030 1597699113
30970 \begin_inset Quotes erd
30974 the opening and closing tags are on the same,
30976 a line feed is output before the opening tag and after the closing tag.
30977 Typical elements are paragraphs and list items.
30982 \begin_layout LyX-Code
30984 \change_inserted 1075283030 1597699186
30988 \begin_layout LyX-Code
30990 \change_inserted 1075283030 1597699357
30991 <paratag>Contents of the paragraph.</paratag>
30994 \begin_layout LyX-Code
30996 \change_inserted 1075283030 1597699231
31000 \begin_layout Itemize
31002 \change_inserted 1075283030 1597699343
31003 \begin_inset Quotes eld
31007 \begin_inset Flex Code
31010 \begin_layout Plain Layout
31012 \change_inserted 1075283030 1597699307
31021 \begin_inset Quotes erd
31025 the opening and closing tags are on the same line as the rest of the content.
31026 No line feeds are output.
31027 Typical elements are fonts.
31032 \begin_layout LyX-Code
31034 \change_inserted 1075283030 1597699585
31035 Content before<inlinetag>Contents of the paragraph.</inlinetag>Content after
31038 \begin_layout Standard
31040 \change_inserted 1075283030 1597699585
31041 The default value is always
31042 \begin_inset Quotes eld
31046 \begin_inset Flex Code
31049 \begin_layout Plain Layout
31051 \change_inserted 1075283030 1597699585
31060 \begin_inset Quotes erd
31068 \begin_layout Subsection
31070 \change_inserted -970929547 1515111533
31071 InsetLayout DocBook
31076 \begin_layout Standard
31078 \change_inserted -970929547 1496611894
31079 The DocBook output of insets can also be controlled by information in layout files.
31082 \begin_layout Standard
31084 \change_inserted -970929547 1496612045
31085 The DocBook \SpecialChar LyX
31086 outputs for an inset has the following form:
31089 \begin_layout LyX-Code
31091 \change_inserted -970929547 1515110861
31092 <wrappertag wrapperattr>
31095 \begin_layout LyX-Code
31097 \change_inserted -970929547 1515110868
31101 \begin_layout LyX-Code
31103 \change_inserted -970929547 1515110869
31104 <innertag innerattr>
31107 \begin_layout LyX-Code
31109 \change_inserted -970929547 1515110869
31110 Contents of the inset.
31113 \begin_layout LyX-Code
31115 \change_inserted -970929547 1515110870
31119 \begin_layout LyX-Code
31121 \change_inserted -970929547 1515110871
31125 \begin_layout LyX-Code
31127 \change_inserted -970929547 1515111172
31131 \begin_layout Standard
31133 \change_inserted -970929547 1515111186
31134 For an itemising inset,
31135 it rather looks like this:
31139 \begin_layout LyX-Code
31141 \change_inserted -970929547 1515111186
31142 <wrappertag wrapperattr>
31145 \begin_layout LyX-Code
31147 \change_inserted -970929547 1515111186
31151 \begin_layout LyX-Code
31153 \change_inserted -970929547 1515111186
31154 <innertag innerattr>
31157 \begin_layout LyX-Code
31159 \change_inserted -970929547 1515111362
31160 <itemwrappertag itemwrapperattr>
31163 \begin_layout LyX-Code
31165 \change_inserted -970929547 1515111364
31166 <itemlabeltag itemattr>
31169 \begin_layout LyX-Code
31171 \change_inserted -970929547 1515111367
31172 Label of the first item.
31175 \begin_layout LyX-Code
31177 \change_inserted -970929547 1515111362
31183 \begin_layout LyX-Code
31185 \change_inserted -970929547 1515111517
31189 \begin_layout LyX-Code
31191 \change_inserted -970929547 1515111517
31197 \begin_layout LyX-Code
31199 \change_inserted -970929547 1515111516
31200 Contents of the first item.
31203 \begin_layout LyX-Code
31205 \change_inserted -970929547 1515111514
31211 \begin_layout LyX-Code
31213 \change_inserted -970929547 1515111247
31219 \begin_layout LyX-Code
31221 \change_inserted -970929547 1515111221
31225 \begin_layout LyX-Code
31227 \change_inserted -970929547 1515111370
31228 <itemwrappertag itemwrapperattr>
31231 \begin_layout LyX-Code
31233 \change_inserted -970929547 1515111370
31234 <itemlabeltag itemattr>
31237 \begin_layout LyX-Code
31239 \change_inserted -970929547 1515111372
31240 Label of the second item.
31243 \begin_layout LyX-Code
31245 \change_inserted -970929547 1515111370
31251 \begin_layout LyX-Code
31253 \change_inserted -970929547 1515111504
31257 \begin_layout LyX-Code
31259 \change_inserted -970929547 1515111505
31265 \begin_layout LyX-Code
31267 \change_inserted -970929547 1515111507
31268 Contents of the second item.
31271 \begin_layout LyX-Code
31273 \change_inserted -970929547 1515111509
31279 \begin_layout LyX-Code
31281 \change_inserted -970929547 1515111251
31287 \begin_layout LyX-Code
31289 \change_inserted -970929547 1515111221
31295 \begin_layout LyX-Code
31297 \change_inserted -970929547 1515111219
31303 \begin_layout LyX-Code
31305 \change_inserted -970929547 1515111186
31309 \begin_layout LyX-Code
31311 \change_inserted -970929547 1515111186
31315 \begin_layout LyX-Code
31317 \change_inserted -970929547 1515111186
31321 \begin_layout Standard
31323 \change_inserted -970929547 1515111183
31324 If the inset permits multiple paragraphs—
31327 \begin_inset Flex Code
31330 \begin_layout Plain Layout
31332 \change_inserted -970929547 1496610966
31341 then the contents of the inset will
31342 \change_deleted 34634807 1620029217
31344 \change_inserted 34634807 1620029219
31346 \change_inserted -970929547 1515111183
31347 be output as paragraphs formatted according to the styles used for those paragraphs (standard,
31350 The inner tag is optional and,
31355 \begin_layout Standard
31357 \change_inserted -970929547 1496610966
31358 The specific tags and attributes output for each inset can be controlled by means of the following layout tags.
31361 \begin_layout Description
31363 \change_inserted -970929547 1515110317
31364 \begin_inset Flex Code
31367 \begin_layout Plain Layout
31369 \change_inserted -970929547 1515109695
31378 \begin_inset Flex Code
31381 \begin_layout Plain Layout
31383 \change_inserted -970929547 1496611854
31391 ] Specifies attribute information to be output with the main tag,
31393 \begin_inset Quotes eld
31397 \begin_inset Flex Code
31400 \begin_layout Plain Layout
31402 \change_inserted -970929547 1515110044
31411 \begin_inset Quotes erd
31414 in the example above.
31415 This information can be used in further processing of the DocBook files.
31419 \begin_layout Description
31421 \change_inserted -970929547 1515110973
31422 \begin_inset Flex Code
31425 \begin_layout Plain Layout
31427 \change_inserted -970929547 1515110319
31436 \begin_inset Flex Code
31439 \begin_layout Plain Layout
31441 \change_inserted -970929547 1515110384
31451 ] Specifies whether this tag goes into the
31452 \begin_inset Flex Code
31455 \begin_layout Plain Layout
31457 \change_inserted -970929547 1515110412
31465 tag at the beginning of the parent layout.
31467 \begin_inset Flex Code
31470 \begin_layout Plain Layout
31472 \change_inserted -970929547 1515110437
31480 indicates that the tag never goes into
31481 \begin_inset Flex Code
31484 \begin_layout Plain Layout
31486 \change_inserted -970929547 1515110497
31494 (this is default value,
31495 and corresponds to usual content).
31497 \begin_inset Flex Code
31500 \begin_layout Plain Layout
31502 \change_inserted -970929547 1515110517
31510 indicates that the tag always goes into
31511 \begin_inset Flex Code
31514 \begin_layout Plain Layout
31516 \change_inserted -970929547 1515110514
31524 (this corresponds to usual metadata):
31526 \begin_inset Flex Code
31529 \begin_layout Plain Layout
31531 \change_inserted -970929547 1515110550
31539 tag for the parent,
31546 \begin_inset Flex Code
31549 \begin_layout Plain Layout
31551 \change_inserted -970929547 1515110540
31559 indicates that the tag may go into
31560 \begin_inset Flex Code
31563 \begin_layout Plain Layout
31565 \change_inserted -970929547 1515110538
31573 (this is only the case for titles):
31575 \begin_inset Flex Code
31578 \begin_layout Plain Layout
31580 \change_inserted -970929547 1515110585
31588 tag for the parent,
31594 the corresponding tag will be output directly as content.
31598 \begin_layout Description
31600 \change_inserted -970929547 1515111461
31601 \begin_inset Flex Code
31604 \begin_layout Plain Layout
31606 \change_inserted -970929547 1515110974
31615 \begin_inset Flex Code
31618 \begin_layout Plain Layout
31620 \change_inserted -970929547 1515110973
31628 ] Specifies attribute information to be output with the item tag,
31630 \begin_inset Quotes eld
31634 \begin_inset Flex Code
31637 \begin_layout Plain Layout
31639 \change_inserted -970929547 1515110984
31648 \begin_inset Quotes erd
31651 in the example above.
31652 This information can be used in further processing of the DocBook files.
31656 \begin_layout Description
31658 \change_inserted -970929547 1515111471
31659 \begin_inset Flex Code
31662 \begin_layout Plain Layout
31664 \change_inserted -970929547 1515111465
31665 DocBookItemInnerAttr
31673 \begin_inset Flex Code
31676 \begin_layout Plain Layout
31678 \change_inserted -970929547 1515111461
31686 ] Specifies attribute information to be output with the item inner tag,
31688 \begin_inset Quotes eld
31692 \begin_inset Flex Code
31695 \begin_layout Plain Layout
31697 \change_inserted -970929547 1515111476
31706 \begin_inset Quotes erd
31709 in the example above.
31710 This information can be used in further processing of the DocBook files.
31714 \begin_layout Description
31716 \change_inserted -970929547 1515111494
31717 \begin_inset Flex Code
31720 \begin_layout Plain Layout
31722 \change_inserted -970929547 1515111467
31723 DocBookItemInnerTag
31731 \begin_inset Flex Code
31734 \begin_layout Plain Layout
31736 \change_inserted -970929547 1515111461
31744 ] The tag to be used for the item inner tag within the inset,
31746 \begin_inset Quotes eld
31750 \begin_inset Flex Code
31753 \begin_layout Plain Layout
31755 \change_inserted -970929547 1515111486
31764 \begin_inset Quotes erd
31767 in the example above.
31769 \begin_inset Flex Code
31772 \begin_layout Plain Layout
31774 \change_inserted -970929547 1515111461
31783 indicating that there is no item inner tag:
31784 content is directly output without it for each itemised element.
31785 This parameter only makes sense when itemising layouts are used,
31788 \change_inserted 1075283030 1598469472
31789 The most likely value is
31790 \begin_inset Quotes eld
31794 \begin_inset Flex Code
31797 \begin_layout Plain Layout
31799 \change_inserted 1075283030 1598469476
31808 \begin_inset Quotes erd
31812 \begin_inset Newline newline
31815 When a list item is split using a new line,
31816 the item inner tag will be repeated for each part of the paragraph,
31817 parts being separated by new lines.
31821 \begin_layout Description
31823 \change_inserted 1075283030 1597699866
31824 \begin_inset Flex Code
31827 \begin_layout Plain Layout
31829 \change_inserted 1075283030 1597699853
31830 DocBookItemInnerTagType
31838 \begin_inset Flex Code
31841 \begin_layout Plain Layout
31843 \change_inserted 1075283030 1597699866
31853 ] The new-line policy for this tag,
31855 \begin_inset space ~
31859 \begin_inset CommandInset ref
31861 reference "subsec:DocBook-New-line-policy"
31874 \begin_layout Description
31876 \change_inserted -970929547 1515111290
31877 \begin_inset Flex Code
31880 \begin_layout Plain Layout
31882 \change_inserted -970929547 1515111283
31883 DocBookItemLabelAttr
31891 \begin_inset Flex Code
31894 \begin_layout Plain Layout
31896 \change_inserted -970929547 1515111279
31904 ] Specifies attribute information to be output with the item label tag,
31906 \begin_inset Quotes eld
31910 \begin_inset Flex Code
31913 \begin_layout Plain Layout
31915 \change_inserted -970929547 1515111304
31924 \begin_inset Quotes erd
31927 in the example above.
31928 This information can be used in further processing of the DocBook files.
31932 \begin_layout Description
31934 \change_inserted -970929547 1515111337
31935 \begin_inset Flex Code
31938 \begin_layout Plain Layout
31940 \change_inserted -970929547 1515111285
31941 DocBookItemLabelTag
31949 \begin_inset Flex Code
31952 \begin_layout Plain Layout
31954 \change_inserted -970929547 1515111279
31962 ] The tag to be used for the item label tag within the inset,
31964 \begin_inset Quotes eld
31968 \begin_inset Flex Code
31971 \begin_layout Plain Layout
31973 \change_inserted -970929547 1515111311
31982 \begin_inset Quotes erd
31985 in the example above.
31986 This parameter only makes sense when itemising layouts are used with a notion of labels,
31987 such as definition lists.
31989 \change_inserted 1075283030 1597699874
31993 \begin_layout Description
31995 \change_inserted 1075283030 1597699874
31996 \begin_inset Flex Code
31999 \begin_layout Plain Layout
32001 \change_inserted 1075283030 1597699880
32002 DocBookItemLabelTagType
32010 \begin_inset Flex Code
32013 \begin_layout Plain Layout
32015 \change_inserted 1075283030 1597699874
32025 ] The new-line policy for this tag,
32027 \begin_inset space ~
32031 \begin_inset CommandInset ref
32033 reference "subsec:DocBook-New-line-policy"
32046 \begin_layout Description
32048 \change_inserted -970929547 1515111124
32049 \begin_inset Flex Code
32052 \begin_layout Plain Layout
32054 \change_inserted -970929547 1515111060
32063 \begin_inset Flex Code
32066 \begin_layout Plain Layout
32068 \change_inserted -970929547 1515111060
32076 ] The tag to be used for the item tag within the inset,
32078 \begin_inset Quotes eld
32082 \begin_inset Flex Code
32085 \begin_layout Plain Layout
32087 \change_inserted -970929547 1515111060
32096 \begin_inset Quotes erd
32099 in the example above.
32101 \begin_inset Flex Code
32104 \begin_layout Plain Layout
32106 \change_inserted -970929547 1515111060
32115 indicating that there is no item tag.
32116 This parameter only makes sense when itemising layouts are used,
32119 \change_inserted 1075283030 1597699890
32123 \begin_layout Description
32125 \change_inserted 1075283030 1597699890
32126 \begin_inset Flex Code
32129 \begin_layout Plain Layout
32131 \change_inserted 1075283030 1597699890
32140 \begin_inset Flex Code
32143 \begin_layout Plain Layout
32145 \change_inserted 1075283030 1597699890
32155 ] The new-line policy for this tag,
32157 \begin_inset space ~
32161 \begin_inset CommandInset ref
32163 reference "subsec:DocBook-New-line-policy"
32176 \begin_layout Description
32178 \change_inserted -970929547 1515111298
32179 \begin_inset Flex Code
32182 \begin_layout Plain Layout
32184 \change_inserted -970929547 1515111124
32185 DocBookItemWrapperAttr
32193 \begin_inset Flex Code
32196 \begin_layout Plain Layout
32198 \change_inserted -970929547 1515111124
32206 ] Specifies attribute information to be output with the item wrapper tag,
32208 \begin_inset Quotes eld
32212 \begin_inset Flex Code
32215 \begin_layout Plain Layout
32217 \change_inserted -970929547 1515111150
32226 \begin_inset Quotes erd
32229 in the example above.
32230 This information can be used in further processing of the DocBook files.
32236 \begin_layout Description
32238 \change_inserted -970929547 1515111113
32239 \begin_inset Flex Code
32242 \begin_layout Plain Layout
32244 \change_inserted -970929547 1515111073
32245 DocBookItemWrapperTag
32253 \begin_inset Flex Code
32256 \begin_layout Plain Layout
32258 \change_inserted -970929547 1515111073
32266 ] The tag to be used for the item wrapper tag within the inset,
32268 \begin_inset Quotes eld
32272 \begin_inset Flex Code
32275 \begin_layout Plain Layout
32277 \change_inserted -970929547 1515111083
32286 \begin_inset Quotes erd
32289 in the example above.
32291 \begin_inset Flex Code
32294 \begin_layout Plain Layout
32296 \change_inserted -970929547 1515111073
32305 indicating that there is no item wrapper tag:
32306 tag and content are directly output without it for each itemised element.
32307 This parameter only makes sense when itemising layouts are used,
32310 \change_inserted 1075283030 1597699897
32314 \begin_layout Description
32316 \change_inserted 1075283030 1597699897
32317 \begin_inset Flex Code
32320 \begin_layout Plain Layout
32322 \change_inserted 1075283030 1597699900
32323 DocBookItemWrapperTagType
32331 \begin_inset Flex Code
32334 \begin_layout Plain Layout
32336 \change_inserted 1075283030 1597699897
32346 ] The new-line policy for this tag,
32348 \begin_inset space ~
32352 \begin_inset CommandInset ref
32354 reference "subsec:DocBook-New-line-policy"
32367 \begin_layout Description
32369 \change_inserted -970929547 1515110104
32370 \begin_inset Flex Code
32373 \begin_layout Plain Layout
32375 \change_inserted -970929547 1515110104
32384 \begin_inset Flex Code
32387 \begin_layout Plain Layout
32389 \change_inserted -970929547 1515110104
32397 ] Specifies attribute information to be output with the inner tag,
32399 \begin_inset Quotes eld
32403 \begin_inset Flex Code
32406 \begin_layout Plain Layout
32408 \change_inserted -970929547 1515110104
32417 \begin_inset Quotes erd
32420 in the example above.
32421 This information can be used in further processing of the DocBook files.
32425 \begin_layout Description
32427 \change_inserted -970929547 1515110906
32428 \begin_inset Flex Code
32431 \begin_layout Plain Layout
32433 \change_inserted -970929547 1515110104
32442 \begin_inset Flex Code
32445 \begin_layout Plain Layout
32447 \change_inserted -970929547 1515110104
32455 ] The tag to be used for the inner tag within the inset,
32457 \begin_inset Quotes eld
32461 \begin_inset Flex Code
32464 \begin_layout Plain Layout
32466 \change_inserted -970929547 1515110104
32475 \begin_inset Quotes erd
32478 in the example above.
32480 \begin_inset Flex Code
32483 \begin_layout Plain Layout
32485 \change_inserted -970929547 1515110791
32494 indicating that there is no inner tag:
32495 content is directly output without it.
32496 \change_inserted 1075283030 1597699904
32500 \begin_layout Description
32502 \change_inserted 1075283030 1597699904
32503 \begin_inset Flex Code
32506 \begin_layout Plain Layout
32508 \change_inserted 1075283030 1597699904
32509 DocBookInnerTagType
32517 \begin_inset Flex Code
32520 \begin_layout Plain Layout
32522 \change_inserted 1075283030 1597699904
32532 ] The new-line policy for this tag,
32534 \begin_inset space ~
32538 \begin_inset CommandInset ref
32540 reference "subsec:DocBook-New-line-policy"
32553 \begin_layout Description
32555 \change_inserted -970929547 1515110753
32556 \begin_inset Flex Code
32559 \begin_layout Plain Layout
32561 \change_inserted -970929547 1515110665
32570 \begin_inset Flex Code
32573 \begin_layout Plain Layout
32575 \change_inserted -970929547 1515110661
32583 ] Specifies the tag that corresponds to this kind of section.
32584 This parameter only makes sense for sectioning elements (part,
32588 The default value is
32589 \begin_inset Flex Code
32592 \begin_layout Plain Layout
32594 \change_inserted -970929547 1515110721
32603 and is only overridden when DocBook uses something else for sectioning (
32604 \change_inserted 1075283030 1597699921
32607 \change_inserted -970929547 1515110753
32608 parts and chapters of a book).
32614 \begin_layout Description
32616 \change_inserted -970929547 1515110811
32617 \begin_inset Flex Code
32620 \begin_layout Plain Layout
32622 \change_inserted -970929547 1496612023
32631 \begin_inset Flex Code
32634 \begin_layout Plain Layout
32636 \change_inserted -970929547 1496610966
32644 ] The tag to be used for this inset,
32646 \begin_inset Quotes eld
32650 \begin_inset Flex Code
32653 \begin_layout Plain Layout
32655 \change_inserted -970929547 1496612033
32664 \begin_inset Quotes erd
32667 in the example above.
32668 The default is the name of the float and always needs to be changed,
32669 as DocBook provides no generic inset tag.
32670 \change_inserted 1075283030 1597699924
32674 \begin_layout Description
32676 \change_inserted 1075283030 1597699924
32677 \begin_inset Flex Code
32680 \begin_layout Plain Layout
32682 \change_inserted 1075283030 1597699924
32691 \begin_inset Flex Code
32694 \begin_layout Plain Layout
32696 \change_inserted 1075283030 1597699924
32706 ] The new-line policy for this tag,
32708 \begin_inset space ~
32712 \begin_inset CommandInset ref
32714 reference "subsec:DocBook-New-line-policy"
32727 \begin_layout Description
32729 \change_inserted -970929547 1515110832
32730 \begin_inset Flex Code
32733 \begin_layout Plain Layout
32735 \change_inserted -970929547 1515110822
32744 \begin_inset Flex Code
32747 \begin_layout Plain Layout
32749 \change_inserted -970929547 1515110811
32757 ] Specifies attribute information to be output with the outer
32758 \change_inserted 34634807 1620057958
32760 \change_inserted -970929547 1515110832
32763 \begin_inset Quotes eld
32767 \begin_inset Flex Code
32770 \begin_layout Plain Layout
32772 \change_inserted -970929547 1515110845
32781 \begin_inset Quotes erd
32784 in the example above.
32785 This information can be used in further processing of the DocBook files.
32789 \begin_layout Description
32791 \change_inserted -970929547 1515110917
32792 \begin_inset Flex Code
32795 \begin_layout Plain Layout
32797 \change_inserted -970929547 1515110826
32806 \begin_inset Flex Code
32809 \begin_layout Plain Layout
32811 \change_inserted -970929547 1515110811
32819 ] The tag to be used for the wrapper tag around the inset,
32821 \begin_inset Quotes eld
32825 \begin_inset Flex Code
32828 \begin_layout Plain Layout
32830 \change_inserted -970929547 1515110842
32839 \begin_inset Quotes erd
32842 in the example above.
32844 \begin_inset Flex Code
32847 \begin_layout Plain Layout
32849 \change_inserted -970929547 1515110811
32858 indicating that there is no wrapper tag:
32859 tag and content are directly output without it.
32860 \change_inserted 1075283030 1597699929
32864 \begin_layout Description
32866 \change_inserted 1075283030 1597699929
32867 \begin_inset Flex Code
32870 \begin_layout Plain Layout
32872 \change_inserted 1075283030 1597699932
32873 DocBookWrapperTagType
32881 \begin_inset Flex Code
32884 \begin_layout Plain Layout
32886 \change_inserted 1075283030 1597699929
32896 ] The new-line policy for this tag,
32898 \begin_inset space ~
32902 \begin_inset CommandInset ref
32904 reference "subsec:DocBook-New-line-policy"
32917 \begin_layout Subsection
32919 \change_inserted -970929547 1515110040
32923 \begin_layout Standard
32925 \change_inserted -970929547 1496611700
32926 The DocBook output for floats too can be controlled by layout information.
32927 The output has the following form:
32930 \begin_layout LyX-Code
32932 \change_inserted -970929547 1515109700
32936 \begin_layout LyX-Code
32938 \change_inserted -970929547 1515110138
32939 Contents of the float as DocBook.
32942 \begin_layout LyX-Code
32944 \change_inserted -970929547 1496610966
32948 \begin_layout Standard
32950 \change_inserted -970929547 1496611715
32953 is a separate inset and will be output as a title.
32957 \begin_layout Description
32959 \change_inserted -970929547 1515110033
32960 \begin_inset Flex Code
32963 \begin_layout Plain Layout
32965 \change_inserted -970929547 1515109702
32974 \begin_inset Flex Code
32977 \begin_layout Plain Layout
32979 \change_inserted -970929547 1496610966
32987 ] Specifies attribute information to be output with the main tag,
32989 \begin_inset Quotes eld
32993 \begin_inset Flex Code
32996 \begin_layout Plain Layout
32998 \change_inserted -970929547 1515110035
33007 \begin_inset Quotes erd
33010 in the example above.
33011 This information can be used in further processing of the DocBook files.
33015 \begin_layout Description
33017 \change_inserted -970929547 1515110157
33018 \begin_inset Flex Code
33021 \begin_layout Plain Layout
33023 \change_inserted -970929547 1496611782
33032 \begin_inset Flex Code
33035 \begin_layout Plain Layout
33037 \change_inserted -970929547 1496610966
33045 ] The tag to be used for this float,
33047 \begin_inset Quotes eld
33051 \begin_inset Flex Code
33054 \begin_layout Plain Layout
33056 \change_inserted -970929547 1496610966
33065 \begin_inset Quotes erd
33068 in the example above.
33069 The default is the name of the float and always needs to be changed,
33070 as DocBook provides no generic float tag.
33073 \begin_layout Subsection
33075 \change_inserted -970929547 1515110157
33076 Bibliography formatting
33079 \begin_layout Standard
33081 \change_deleted 1075283030 1597699984
33083 \change_inserted 1075283030 1597699985
33085 \change_inserted -970929547 1515110187
33087 \change_deleted 1075283030 1597699987
33089 \change_inserted 1075283030 1597699987
33091 \change_inserted -970929547 1515110187
33092 cannot be formatted:
33093 all fields are always output in the database-like DocBook format (equivalent to a BibTeX file)
33094 \change_inserted 1075283030 1597700117
33097 \begin_inset Flex Code
33100 \begin_layout Plain Layout
33102 \change_inserted 1075283030 1597700120
33111 \change_inserted -970929547 1515110187
33113 \change_inserted 1075283030 1597700092
33117 \begin_layout Standard
33119 \change_inserted 1075283030 1597700112
33120 When the bibliographic entries are manually inserted into the
33121 \change_deleted 34634807 1620057319
33123 \change_inserted 34634807 1620057319
33126 \change_inserted 1075283030 1597700112
33127 document as Bibliography Items,
33128 the user deals with formatting
33131 \change_inserted 1075283030 1597700112
33133 there is no attempt of parsing what the user wrote,
33134 the string is directly used (with the
33135 \begin_inset Flex Code
33138 \begin_layout Plain Layout
33140 \change_inserted 1075283030 1597700076
33154 \begin_layout Chapter
33155 Including External Material
33156 \begin_inset CommandInset label
33158 name "chap:Including-External-Material"
33165 \begin_layout Standard
33166 \begin_inset Box Shadowbox
33176 height_special "totalheight"
33181 backgroundcolor "none"
33184 \begin_layout Plain Layout
33186 This portion of the documentation has not been updated for some time.
33187 We certainly hope that it is still accurate,
33188 but there are no guarantees.
33196 \begin_layout Standard
33197 The use of material from sources external to \SpecialChar LyX
33198 is covered in detail in the
33203 This part of the manual covers what needs to happen behind the scenes for new sorts of material to be included.
33206 \begin_layout Section
33210 \begin_layout Standard
33211 The external material feature is based on the concept of a
33216 A template is a specification of how \SpecialChar LyX
33217 should interface with a certain kind of material.
33220 comes with predefined templates for Xfig figures,
33221 various raster format images,
33223 and LilyPond music notation.
33224 You can check the actual list by using the menu
33225 \begin_inset Flex Noun
33228 \begin_layout Plain Layout
33229 Insert\SpecialChar menuseparator
33230 File\SpecialChar menuseparator
33238 it is possible to roll your own template to support a specific kind of material.
33239 Later we'll describe in more detail what is involved,
33240 and hopefully you will submit all the templates you create so we can include them in a later \SpecialChar LyX
33244 \begin_layout Standard
33245 Another basic idea of the external material feature is to distinguish between the original file that serves as a base for final material and the produced file that is included in your exported or printed document.
33247 consider the case of a figure produced with
33248 \begin_inset Flex Code
33251 \begin_layout Plain Layout
33258 The Xfig application itself works on an original file with the
33259 \begin_inset Flex Code
33262 \begin_layout Plain Layout
33270 you create and change your figure,
33271 and when you are done,
33273 \begin_inset Flex Code
33276 \begin_layout Plain Layout
33283 When you want to include the figure in your document,
33285 \begin_inset Flex Code
33288 \begin_layout Plain Layout
33294 in order to create a PostScript file that can readily be included in your \SpecialChar LaTeX
33298 \begin_inset Flex Code
33301 \begin_layout Plain Layout
33307 file is the original file,
33308 and the PostScript file is the produced file.
33311 \begin_layout Standard
33312 This distinction is important in order to allow updating of the material while you are in the process of writing the document.
33314 it provides us with the flexibility that is needed to support multiple export formats.
33316 in the case of a plain text file,
33317 it is not exactly an award-winning idea to include the figure as raw PostScript.
33319 you would either prefer to just include a reference to the figure or try to invoke some graphics to ASCII converter to make the final result look similar to the real graphics.
33320 The external material management allows you to do this,
33321 because it is parametrized on the different export formats that \SpecialChar LyX
33325 \begin_layout Standard
33326 Besides supporting the production of different products according to the exported format,
33327 it supports tight integration with editing and viewing applications.
33328 In the case of an Xfig figure,
33329 you are able to invoke Xfig on the original file with a single click from within the external material dialog in \SpecialChar LyX
33331 and also preview the produced PostScript file with Ghostview with another click.
33332 No more fiddling around with the command line and/or file browsers to locate and manipulate the original or produced files.
33334 you are finally able to take full advantage of the many different applications that are relevant to use when you write your documents,
33335 and ultimately be more productive.
33338 \begin_layout Section
33339 The external template configuration files
33342 \begin_layout Standard
33343 It is relatively easy to add custom external template definitions to \SpecialChar LyX
33346 be aware that doing this in an careless manner most probably
33350 introduce an easily exploitable security hole.
33351 So before you do this,
33352 please read the discussion about security in
33353 \begin_inset CommandInset ref
33355 reference "sec:Security-discussion"
33362 \begin_layout Standard
33364 we encourage you to submit any interesting templates that you create.
33368 \begin_layout Standard
33369 The external templates are defined in the
33370 \begin_inset Flex Code
33373 \begin_layout Plain Layout
33379 files that are stored in the
33380 \begin_inset Flex Code
33383 \begin_layout Plain Layout
33384 LyXDir/lib/xtemplates/
33390 Each template is defined in a file of its own.
33391 You can place your own templates in
33392 \begin_inset Flex Code
33395 \begin_layout Plain Layout
33396 UserDir/xtemplates/
33401 or copy existing templates to that directory in order to modify them.
33404 \begin_layout Standard
33405 A typical template looks like this:
33408 \begin_layout LyX-Code
33412 \begin_layout LyX-Code
33414 $$AbsOrRelPathParent$$Basename"
33417 \begin_layout LyX-Code
33421 \begin_layout LyX-Code
33425 \begin_layout LyX-Code
33429 \begin_layout LyX-Code
33433 \begin_layout LyX-Code
33437 \begin_layout LyX-Code
33438 AutomaticProduction true
33441 \begin_layout LyX-Code
33445 \begin_layout LyX-Code
33449 \begin_layout LyX-Code
33453 \begin_layout LyX-Code
33454 TransformCommand Rotate RotationLatexCommand
33457 \begin_layout LyX-Code
33458 TransformCommand Resize ResizeLatexCommand
33461 \begin_layout LyX-Code
33462 Product "$$RotateFront$$ResizeFront
33465 \begin_layout LyX-Code
33470 input{$$AbsOrRelPathMaster$$Basename.pstex_t}
33473 \begin_layout LyX-Code
33474 $$ResizeBack$$RotateBack"
33477 \begin_layout LyX-Code
33481 \begin_layout LyX-Code
33482 UpdateResult "$$AbsPath$$Basename.pstex_t"
33485 \begin_layout LyX-Code
33486 Requirement "graphicx"
33489 \begin_layout LyX-Code
33490 ReferencedFile latex "$$AbsOrRelPathMaster$$Basename.pstex_t"
33493 \begin_layout LyX-Code
33494 ReferencedFile latex "$$AbsPath$$Basename.eps"
33497 \begin_layout LyX-Code
33498 ReferencedFile dvi "$$AbsPath$$Basename.eps"
33501 \begin_layout LyX-Code
33505 \begin_layout LyX-Code
33509 \begin_layout LyX-Code
33510 TransformCommand Rotate RotationLatexCommand
33513 \begin_layout LyX-Code
33514 TransformCommand Resize ResizeLatexCommand
33517 \begin_layout LyX-Code
33518 Product "$$RotateFront$$ResizeFront
33521 \begin_layout LyX-Code
33526 input{$$AbsOrRelPathMaster$$Basename.pdftex_t}
33529 \begin_layout LyX-Code
33530 $$ResizeBack$$RotateBack"
33533 \begin_layout LyX-Code
33534 UpdateFormat pdftex
33537 \begin_layout LyX-Code
33538 UpdateResult "$$AbsPath$$Basename.pdftex_t"
33541 \begin_layout LyX-Code
33542 Requirement "graphicx"
33545 \begin_layout LyX-Code
33546 ReferencedFile latex "$$AbsOrRelPathMaster$$Basename.pdftex_t"
33549 \begin_layout LyX-Code
33550 ReferencedFile latex "$$AbsPath$$Basename.pdf"
33553 \begin_layout LyX-Code
33557 \begin_layout LyX-Code
33561 \begin_layout LyX-Code
33566 \begin_layout LyX-Code
33570 \begin_layout LyX-Code
33574 \begin_layout LyX-Code
33575 Product "<graphic fileref=
33577 "$$AbsOrRelPathMaster$$Basename.eps
33582 \begin_layout LyX-Code
33586 \begin_layout LyX-Code
33590 \begin_layout LyX-Code
33591 UpdateResult "$$AbsPath$$Basename.eps"
33594 \begin_layout LyX-Code
33595 ReferencedFile docbook "$$AbsPath$$Basename.eps"
33598 \begin_layout LyX-Code
33599 ReferencedFile docbook-xml "$$AbsPath$$Basename.eps"
33602 \begin_layout LyX-Code
33606 \begin_layout LyX-Code
33610 \begin_layout Standard
33612 the template is enclosed in
33613 \begin_inset Flex Code
33616 \begin_layout Plain Layout
33624 \begin_inset Flex Code
33627 \begin_layout Plain Layout
33634 It contains a header specifying some general settings and,
33635 for each supported primary document file format,
33637 \begin_inset Flex Code
33640 \begin_layout Plain Layout
33648 \begin_inset Flex Code
33651 \begin_layout Plain Layout
33660 \begin_layout Subsection
33661 The template header
33664 \begin_layout Description
33665 \begin_inset Flex Code
33668 \begin_layout Plain Layout
33669 AutomaticProduction
33670 \begin_inset space ~
33678 Whether the file represented by the template must be generated by \SpecialChar LyX
33680 This command must occur exactly once.
33683 \begin_layout Description
33684 \begin_inset Flex Code
33687 \begin_layout Plain Layout
33689 \begin_inset space ~
33697 A glob pattern that is used in the file dialog to filter out the desired files.
33698 If there is more than one possible file extension (e.
33699 \begin_inset space \thinspace{}
33703 \begin_inset space \space{}
33707 \begin_inset Flex Code
33710 \begin_layout Plain Layout
33717 \begin_inset Flex Code
33720 \begin_layout Plain Layout
33728 \begin_inset Flex Code
33731 \begin_layout Plain Layout
33738 This command must occur exactly once.
33741 \begin_layout Description
33742 \begin_inset Flex Code
33745 \begin_layout Plain Layout
33747 \begin_inset space ~
33755 The text that is displayed on the button.
33756 This command must occur exactly once.
33759 \begin_layout Description
33760 \begin_inset Flex Code
33763 \begin_layout Plain Layout
33765 \begin_inset space ~
33769 \begin_inset space ~
33777 The help text that is used in the External dialog.
33778 Provide enough information to explain to the user just what the template can provide him with.
33779 This command must occur exactly once.
33782 \begin_layout Description
33783 \begin_inset Flex Code
33786 \begin_layout Plain Layout
33788 \begin_inset space ~
33796 The file format of the original file.
33797 This must be the name of a format that is known to \SpecialChar LyX
33799 \begin_inset CommandInset ref
33801 reference "sec:Formats"
33807 \begin_inset Quotes eld
33811 \begin_inset Flex Code
33814 \begin_layout Plain Layout
33821 \begin_inset Quotes erd
33824 if the template can handle original files of more than one format.
33826 will attempt to interrogate the file itself in order to deduce its format in this case.
33827 This command must occur exactly once.
33830 \begin_layout Description
33831 \begin_inset Flex Code
33834 \begin_layout Plain Layout
33836 \begin_inset space ~
33844 A unique name for the template.
33845 It must not contain substitution macros (see below).
33848 \begin_layout Description
33849 \begin_inset Flex Code
33852 \begin_layout Plain Layout
33854 \begin_inset space ~
33857 Rotate|Resize|Clip|Extra
33862 This command specifies which transformations are supported by this template.
33863 It may occur zero or more times.
33864 This command enables the corresponding tabs in the external dialog.
33866 \begin_inset Flex Code
33869 \begin_layout Plain Layout
33875 command must have either a corresponding
33876 \begin_inset Flex Code
33879 \begin_layout Plain Layout
33886 \begin_inset Flex Code
33889 \begin_layout Plain Layout
33896 \begin_inset Flex Code
33899 \begin_layout Plain Layout
33906 Otherwise the transformation will not be supported by that format.
33909 \begin_layout Subsection
33913 \begin_layout Description
33914 \begin_inset Flex Code
33917 \begin_layout Plain Layout
33919 \begin_inset space ~
33922 LaTeX|PDFLaTeX|PlainText|DocBook|XHTML
33927 The primary document file format that this format definition is for.
33928 Not every template has a sensible representation in all document file formats.
33929 Please define nevertheless a
33930 \begin_inset Flex Code
33933 \begin_layout Plain Layout
33939 section for all templates.
33940 Use a dummy text when no representation is available.
33941 Then you can at least see a reference to the external material in the exported document.
33944 \begin_layout Description
33945 \begin_inset Flex Code
33948 \begin_layout Plain Layout
33950 \begin_inset space ~
33954 \begin_inset space ~
33962 This command defines an additional macro
33963 \begin_inset Flex Code
33966 \begin_layout Plain Layout
33972 for substitution in
33973 \begin_inset Flex Code
33976 \begin_layout Plain Layout
33984 \begin_inset Flex Code
33987 \begin_layout Plain Layout
33993 itself may contain substitution macros.
33994 The advantage over using
33995 \begin_inset Flex Code
33998 \begin_layout Plain Layout
34005 \begin_inset Flex Code
34008 \begin_layout Plain Layout
34014 is that the substituted value of
34015 \begin_inset Flex Code
34018 \begin_layout Plain Layout
34024 is sanitized so that it is a valid optional argument in the document format.
34025 This command may occur zero or more times.
34028 \begin_layout Description
34029 \begin_inset Flex Code
34032 \begin_layout Plain Layout
34034 \begin_inset space ~
34042 The text that is inserted in the exported document.
34043 This is actually the most important command and can be quite complex.
34044 This command must occur exactly once.
34047 \begin_layout Description
34048 \begin_inset Flex Code
34051 \begin_layout Plain Layout
34053 \begin_inset space ~
34061 This command specifies a preamble snippet that will be included in the \SpecialChar LaTeX
34063 It has to be defined using
34064 \begin_inset Flex Code
34067 \begin_layout Plain Layout
34075 \begin_inset Flex Code
34078 \begin_layout Plain Layout
34085 This command may occur zero or more times.
34088 \begin_layout Description
34089 \begin_inset Flex Code
34092 \begin_layout Plain Layout
34094 \begin_inset space ~
34098 \begin_inset space ~
34106 This command denotes files that are created by the conversion process and are needed for a particular export format.
34107 If the filename is relative,
34108 it is interpreted relative to the master document.
34109 This command may be given zero or more times.
34112 \begin_layout Description
34113 \begin_inset Flex Code
34116 \begin_layout Plain Layout
34118 \begin_inset space ~
34126 The name of a required \SpecialChar LaTeX
34128 The package is included via
34129 \begin_inset Flex Code
34132 \begin_layout Plain Layout
34140 in the \SpecialChar LaTeX
34142 This command may occur zero or more times.
34145 \begin_layout Description
34146 \begin_inset Flex Code
34149 \begin_layout Plain Layout
34151 \begin_inset space ~
34155 \begin_inset space ~
34158 RotationLatexCommand
34163 This command specifies that the built in \SpecialChar LaTeX
34164 command should be used for rotation.
34165 This command may occur once or not at all.
34168 \begin_layout Description
34169 \begin_inset Flex Code
34172 \begin_layout Plain Layout
34174 \begin_inset space ~
34178 \begin_inset space ~
34186 This command specifies that the built in \SpecialChar LaTeX
34187 command should be used for resizing.
34188 This command may occur once or not at all.
34191 \begin_layout Description
34192 \begin_inset Flex Code
34195 \begin_layout Plain Layout
34197 \begin_inset space ~
34201 \begin_inset space ~
34204 RotationLatexOption
34209 This command specifies that rotation is done via an optional argument.
34210 This command may occur once or not at all.
34213 \begin_layout Description
34214 \begin_inset Flex Code
34217 \begin_layout Plain Layout
34219 \begin_inset space ~
34223 \begin_inset space ~
34231 This command specifies that resizing is done via an optional argument.
34232 This command may occur once or not at all.
34235 \begin_layout Description
34236 \begin_inset Flex Code
34239 \begin_layout Plain Layout
34241 \begin_inset space ~
34245 \begin_inset space ~
34253 This command specifies that clipping is done via an optional argument.
34254 This command may occur once or not at all.
34257 \begin_layout Description
34258 \begin_inset Flex Code
34261 \begin_layout Plain Layout
34263 \begin_inset space ~
34267 \begin_inset space ~
34275 This command specifies that an extra optional argument is used.
34276 This command may occur once or not at all.
34279 \begin_layout Description
34280 \begin_inset Flex Code
34283 \begin_layout Plain Layout
34285 \begin_inset space ~
34293 The file format of the converted file.
34294 This must be the name of a format that is known to \SpecialChar LyX
34296 \begin_inset Flex Noun
34299 \begin_layout Plain Layout
34300 Tools\SpecialChar menuseparator
34301 Preferences\SpecialChar menuseparator
34302 File Handling\SpecialChar menuseparator
34309 This command must occur exactly once.
34310 If the resulting file format is PDF,
34311 you need to specify the format
34312 \begin_inset Flex Code
34315 \begin_layout Plain Layout
34322 This is the PDF format used for including graphics.
34323 The other defined PDF formats are for document export.
34326 \begin_layout Description
34327 \begin_inset Flex Code
34330 \begin_layout Plain Layout
34332 \begin_inset space ~
34340 The file name of the converted file.
34341 The file name must be absolute.
34342 This command must occur exactly once.
34345 \begin_layout Subsection
34346 Preamble definitions
34349 \begin_layout Standard
34350 The external template configuration file may contain additional preamble definitions enclosed by
34351 \begin_inset Flex Code
34354 \begin_layout Plain Layout
34362 \begin_inset Flex Code
34365 \begin_layout Plain Layout
34372 They can be used by the templates in the
34373 \begin_inset Flex Code
34376 \begin_layout Plain Layout
34385 \begin_layout Section
34386 The substitution mechanism
34389 \begin_layout Standard
34390 When the external material facility invokes an external program,
34391 it is done on the basis of a command defined in the template configuration file.
34392 These commands can contain various macros that are expanded before execution.
34393 Execution always take place in the directory of the containing document.
34396 \begin_layout Standard
34398 whenever external material is to be displayed,
34399 the name will be produced by the substitution mechanism,
34400 and most other commands in the template definition support substitution as well.
34403 \begin_layout Standard
34404 The available macros are the following:
34407 \begin_layout Description
34408 \begin_inset Flex Code
34411 \begin_layout Plain Layout
34412 $$AbsOrRelPathMaster
34418 absolute or relative to the master \SpecialChar LyX
34422 \begin_layout Description
34423 \begin_inset Flex Code
34426 \begin_layout Plain Layout
34427 $$AbsOrRelPathParent
34433 absolute or relative to the \SpecialChar LyX
34437 \begin_layout Description
34438 \begin_inset Flex Code
34441 \begin_layout Plain Layout
34447 The absolute file path.
34450 \begin_layout Description
34451 \begin_inset Flex Code
34454 \begin_layout Plain Layout
34460 The filename without path and without the extension.
34463 \begin_layout Description
34464 \begin_inset Flex Code
34467 \begin_layout Plain Layout
34469 \begin_inset Quotes eld
34473 \begin_inset Quotes erd
34481 This macro will expand to the contents of the file with the name
34482 \begin_inset Flex Code
34485 \begin_layout Plain Layout
34494 \begin_layout Description
34495 \begin_inset Flex Code
34498 \begin_layout Plain Layout
34504 The file extension (including the dot).
34507 \begin_layout Description
34508 \begin_inset Flex Code
34511 \begin_layout Plain Layout
34517 This will be the string
34518 \begin_inset Quotes eld
34522 \begin_inset Quotes erd
34525 if the file is in JPEG format,
34526 otherwise it will be the string
34527 \begin_inset Quotes eld
34531 \begin_inset Quotes erd
34535 This is useful to avoid uneeded conversions for output formats that support both PNG and JPEG fomats.
34536 The predefined RasterImage template uses this macro for the pdf\SpecialChar TeX
34540 \begin_layout Description
34541 \begin_inset Flex Code
34544 \begin_layout Plain Layout
34550 The filename of the file specified in the external material dialog.
34551 This is either an absolute name,
34552 or it is relative to the \SpecialChar LyX
34556 \begin_layout Description
34557 \begin_inset Flex Code
34560 \begin_layout Plain Layout
34567 \begin_inset Flex Code
34570 \begin_layout Plain Layout
34576 (absolute name or relative to the \SpecialChar LyX
34580 \begin_layout Description
34581 \begin_inset Flex Code
34584 \begin_layout Plain Layout
34591 relative to the master \SpecialChar LyX
34595 \begin_layout Description
34596 \begin_inset Flex Code
34599 \begin_layout Plain Layout
34606 relative to the \SpecialChar LyX
34610 \begin_layout Description
34611 \begin_inset Flex Code
34614 \begin_layout Plain Layout
34620 This macro will expand to the absolute path of the system directory.
34621 This is typically used to point to the various helper scripts that are bundled with \SpecialChar LyX
34625 \begin_layout Description
34626 \begin_inset Flex Code
34629 \begin_layout Plain Layout
34635 A name and full path to a temporary file which will be automatically deleted whenever the containing document is closed,
34636 or the external material insertion deleted.
34639 \begin_layout Standard
34640 All path macros contain a trailing directory separator,
34641 so you can construct e.
34642 \begin_inset space \thinspace{}
34646 \begin_inset space \space{}
34649 the absolute filename with
34650 \begin_inset Flex Code
34653 \begin_layout Plain Layout
34654 $$AbsPath$$Basename$$Extension
34662 \begin_layout Standard
34663 The macros above are substituted in all commands unless otherwise noted.
34665 \begin_inset Flex Code
34668 \begin_layout Plain Layout
34674 supports additionally the following substitutions if they are enabled by the
34675 \begin_inset Flex Code
34678 \begin_layout Plain Layout
34685 \begin_inset Flex Code
34688 \begin_layout Plain Layout
34697 \begin_layout Description
34698 \begin_inset Flex Code
34701 \begin_layout Plain Layout
34707 The front part of the resize command.
34710 \begin_layout Description
34711 \begin_inset Flex Code
34714 \begin_layout Plain Layout
34720 The back part of the resize command.
34723 \begin_layout Description
34724 \begin_inset Flex Code
34727 \begin_layout Plain Layout
34733 The front part of the rotation command.
34736 \begin_layout Description
34737 \begin_inset Flex Code
34740 \begin_layout Plain Layout
34746 The back part of the rotation command.
34749 \begin_layout Standard
34750 The value string of the
34751 \begin_inset Flex Code
34754 \begin_layout Plain Layout
34760 command supports additionally the following substitutions if they are enabled by the
34761 \begin_inset Flex Code
34764 \begin_layout Plain Layout
34771 \begin_inset Flex Code
34774 \begin_layout Plain Layout
34783 \begin_layout Description
34784 \begin_inset Flex Code
34787 \begin_layout Plain Layout
34796 \begin_layout Description
34797 \begin_inset Flex Code
34800 \begin_layout Plain Layout
34809 \begin_layout Description
34810 \begin_inset Flex Code
34813 \begin_layout Plain Layout
34822 \begin_layout Description
34823 \begin_inset Flex Code
34826 \begin_layout Plain Layout
34832 The rotation option.
34835 \begin_layout Standard
34836 You may ask why there are so many path macros.
34837 There are mainly two reasons:
34840 \begin_layout Enumerate
34841 Relative and absolute file names should remain relative or absolute,
34843 Users may have reasons to prefer either form.
34844 Relative names are useful for portable documents that should work on different machines,
34846 Absolute names may be required by some programs.
34849 \begin_layout Enumerate
34851 treats relative file names differently than \SpecialChar LyX
34852 and other programs in nested included files.
34853 For \SpecialChar LyX
34855 a relative file name is always relative to the document that contains the file name.
34856 For \SpecialChar LaTeX
34858 it is always relative to the master document.
34859 These two definitions are identical if you have only one document,
34860 but differ if you have a master document that includes part documents.
34861 That means that relative filenames must be transformed when presented to \SpecialChar LaTeX
34863 Fortunately \SpecialChar LyX
34864 does this automatically for you if you choose the right macros.
34867 \begin_layout Standard
34868 So which path macro should be used in new template definitions?
34869 The rule is not difficult:
34872 \begin_layout Itemize
34874 \begin_inset Flex Code
34877 \begin_layout Plain Layout
34883 if an absolute path is required.
34886 \begin_layout Itemize
34888 \begin_inset Flex Code
34891 \begin_layout Plain Layout
34892 $$AbsOrRelPathMaster
34897 if the substituted string is some kind of \SpecialChar LaTeX
34901 \begin_layout Itemize
34903 \begin_inset Flex Code
34906 \begin_layout Plain Layout
34907 $$AbsOrRelPathParent
34912 in order to preserve the user's choice.
34915 \begin_layout Standard
34916 There are special cases where this rule does not work and e.
34917 \begin_inset space \thinspace{}
34921 \begin_inset space \space{}
34924 relative names are needed,
34925 but normally it will work just fine.
34926 One example for such a case is the command
34927 \begin_inset Flex Code
34930 \begin_layout Plain Layout
34931 ReferencedFile latex "$$AbsOrRelPathMaster$$Basename.pstex_t"
34936 in the XFig template above:
34937 We can't use the absolute name because the copier for
34938 \begin_inset Flex Code
34941 \begin_layout Plain Layout
34947 files needs the relative name in order to rewrite the file content.
34950 \begin_layout Section
34951 Security discussion
34952 \begin_inset CommandInset label
34954 name "sec:Security-discussion"
34961 \begin_layout Standard
34962 The external material feature interfaces with a lot of external programs and does so automatically,
34963 so we have to consider the security implications of this.
34965 since you have the option of including your own filenames and/or parameter strings and those are expanded into a command,
34966 it seems that it would be possible to create a malicious document which executes arbitrary commands when a user views or prints the document.
34967 This is something we definitely want to avoid.
34970 \begin_layout Standard
34972 since the external program commands are specified in the template configuration file only,
34973 there are no security issues if \SpecialChar LyX
34974 is properly configured with safe templates only.
34975 This is so because the external programs are invoked with the
34976 \begin_inset Flex Code
34979 \begin_layout Plain Layout
34985 -system call rather than the
34986 \begin_inset Flex Code
34989 \begin_layout Plain Layout
34996 so it's not possible to execute arbitrary commands from the filename or parameter section via the shell.
34999 \begin_layout Standard
35000 This also implies that you are restricted in what command strings you can use in the external material templates.
35002 pipes and redirection are not readily available.
35003 This has to be so if \SpecialChar LyX
35004 should remain safe.
35005 If you want to use some of the shell features,
35006 you should write a safe script to do this in a controlled manner,
35007 and then invoke the script from the command string.
35011 \begin_layout Standard
35012 It is possible to design a template that interacts directly with the shell,
35013 but since this would allow a malicious user to execute arbitrary commands by writing clever filenames and/or parameters,
35014 we generally recommend that you only use safe scripts that work with the
35015 \begin_inset Flex Code
35018 \begin_layout Plain Layout
35024 system call in a controlled manner.
35026 for use in a controlled environment,
35027 it can be tempting to just fall back to use ordinary shell scripts.
35033 provide an easily exploitable security hole in your system.
35034 Of course it stands to reason that such unsafe templates will never be included in the standard \SpecialChar LyX
35036 although we do encourage people to submit new templates in the open source tradition.
35037 But \SpecialChar LyX
35038 as shipped from the official distribution channels will never have unsafe templates.
35041 \begin_layout Standard
35042 Including external material provides a lot of power,
35043 and you have to be careful not to introduce security hazards with this power.
35044 A subtle error in a single line in an innocent looking script can open the door to huge security problems.
35045 So if you do not fully understand the issues,
35046 we recommend that you consult a knowledgeable security professional or the \SpecialChar LyX
35047 development team if you have any questions about whether a given template is safe or not.
35048 And do this before you use it in an uncontrolled environment.
35051 \begin_layout Chapter
35053 List of supported \SpecialChar LyX
35054 functions to be used in layouts
35055 \begin_inset CommandInset label
35057 name "chap:List-of-functions"
35064 \begin_layout Standard
35066 \begin_inset Tabular
35067 <lyxtabular version="3" rows="11" columns="8">
35068 <features tabularvalignment="middle">
35069 <column alignment="left" valignment="top">
35070 <column alignment="left" valignment="top">
35071 <column alignment="left" valignment="top">
35072 <column alignment="left" valignment="top">
35073 <column alignment="left" valignment="top">
35074 <column alignment="left" valignment="top">
35075 <column alignment="left" valignment="top">
35076 <column alignment="left" valignment="top">
35078 <cell alignment="left" valignment="top" usebox="none">
35081 \begin_layout Plain Layout
35087 <cell alignment="left" valignment="top" usebox="none">
35090 \begin_layout Plain Layout
35096 <cell alignment="left" valignment="top" usebox="none">
35099 \begin_layout Plain Layout
35105 <cell alignment="left" valignment="top" usebox="none">
35108 \begin_layout Plain Layout
35114 <cell alignment="center" valignment="top" usebox="none">
35117 \begin_layout Plain Layout
35123 <cell alignment="center" valignment="top" usebox="none">
35126 \begin_layout Plain Layout
35132 <cell alignment="center" valignment="top" usebox="none">
35135 \begin_layout Plain Layout
35141 <cell alignment="center" valignment="top" usebox="none">
35144 \begin_layout Plain Layout
35152 <cell alignment="left" valignment="top" usebox="none">
35155 \begin_layout Plain Layout
35161 <cell alignment="left" valignment="top" usebox="none">
35164 \begin_layout Plain Layout
35170 <cell alignment="left" valignment="top" usebox="none">
35173 \begin_layout Plain Layout
35179 <cell alignment="left" valignment="top" usebox="none">
35182 \begin_layout Plain Layout
35188 <cell alignment="center" valignment="top" usebox="none">
35191 \begin_layout Plain Layout
35197 <cell alignment="center" valignment="top" usebox="none">
35200 \begin_layout Plain Layout
35206 <cell alignment="center" valignment="top" usebox="none">
35209 \begin_layout Plain Layout
35215 <cell alignment="center" valignment="top" usebox="none">
35218 \begin_layout Plain Layout
35226 <cell alignment="left" valignment="top" usebox="none">
35229 \begin_layout Plain Layout
35235 <cell alignment="left" valignment="top" usebox="none">
35238 \begin_layout Plain Layout
35244 <cell alignment="left" valignment="top" usebox="none">
35247 \begin_layout Plain Layout
35253 <cell alignment="left" valignment="top" usebox="none">
35256 \begin_layout Plain Layout
35262 <cell alignment="center" valignment="top" usebox="none">
35265 \begin_layout Plain Layout
35271 <cell alignment="center" valignment="top" usebox="none">
35274 \begin_layout Plain Layout
35280 <cell alignment="center" valignment="top" usebox="none">
35283 \begin_layout Plain Layout
35289 <cell alignment="center" valignment="top" usebox="none">
35292 \begin_layout Plain Layout
35300 <cell alignment="left" valignment="top" usebox="none">
35303 \begin_layout Plain Layout
35309 <cell alignment="left" valignment="top" usebox="none">
35312 \begin_layout Plain Layout
35318 <cell alignment="left" valignment="top" usebox="none">
35321 \begin_layout Plain Layout
35327 <cell alignment="left" valignment="top" usebox="none">
35330 \begin_layout Plain Layout
35336 <cell alignment="center" valignment="top" usebox="none">
35339 \begin_layout Plain Layout
35345 <cell alignment="center" valignment="top" usebox="none">
35348 \begin_layout Plain Layout
35354 <cell alignment="center" valignment="top" usebox="none">
35357 \begin_layout Plain Layout
35363 <cell alignment="center" valignment="top" usebox="none">
35366 \begin_layout Plain Layout
35374 <cell alignment="left" valignment="top" usebox="none">
35377 \begin_layout Plain Layout
35383 <cell alignment="left" valignment="top" usebox="none">
35386 \begin_layout Plain Layout
35392 <cell alignment="left" valignment="top" usebox="none">
35395 \begin_layout Plain Layout
35401 <cell alignment="left" valignment="top" usebox="none">
35404 \begin_layout Plain Layout
35410 <cell alignment="center" valignment="top" usebox="none">
35413 \begin_layout Plain Layout
35419 <cell alignment="center" valignment="top" usebox="none">
35422 \begin_layout Plain Layout
35428 <cell alignment="center" valignment="top" usebox="none">
35431 \begin_layout Plain Layout
35437 <cell alignment="center" valignment="top" usebox="none">
35440 \begin_layout Plain Layout
35448 <cell alignment="left" valignment="top" usebox="none">
35451 \begin_layout Plain Layout
35457 <cell alignment="left" valignment="top" usebox="none">
35460 \begin_layout Plain Layout
35466 <cell alignment="left" valignment="top" usebox="none">
35469 \begin_layout Plain Layout
35475 <cell alignment="left" valignment="top" usebox="none">
35478 \begin_layout Plain Layout
35484 <cell alignment="center" valignment="top" usebox="none">
35487 \begin_layout Plain Layout
35493 <cell alignment="center" valignment="top" usebox="none">
35496 \begin_layout Plain Layout
35502 <cell alignment="center" valignment="top" usebox="none">
35505 \begin_layout Plain Layout
35511 <cell alignment="center" valignment="top" usebox="none">
35514 \begin_layout Plain Layout
35522 <cell alignment="left" valignment="top" usebox="none">
35525 \begin_layout Plain Layout
35531 <cell alignment="left" valignment="top" usebox="none">
35534 \begin_layout Plain Layout
35540 <cell alignment="left" valignment="top" usebox="none">
35543 \begin_layout Plain Layout
35549 <cell alignment="left" valignment="top" usebox="none">
35552 \begin_layout Plain Layout
35558 <cell alignment="center" valignment="top" usebox="none">
35561 \begin_layout Plain Layout
35567 <cell alignment="center" valignment="top" usebox="none">
35570 \begin_layout Plain Layout
35576 <cell alignment="center" valignment="top" usebox="none">
35579 \begin_layout Plain Layout
35585 <cell alignment="center" valignment="top" usebox="none">
35588 \begin_layout Plain Layout
35596 <cell alignment="left" valignment="top" usebox="none">
35599 \begin_layout Plain Layout
35605 <cell alignment="left" valignment="top" usebox="none">
35608 \begin_layout Plain Layout
35614 <cell alignment="left" valignment="top" usebox="none">
35617 \begin_layout Plain Layout
35623 <cell alignment="left" valignment="top" usebox="none">
35626 \begin_layout Plain Layout
35632 <cell alignment="center" valignment="top" usebox="none">
35635 \begin_layout Plain Layout
35641 <cell alignment="center" valignment="top" usebox="none">
35644 \begin_layout Plain Layout
35650 <cell alignment="center" valignment="top" usebox="none">
35653 \begin_layout Plain Layout
35659 <cell alignment="center" valignment="top" usebox="none">
35662 \begin_layout Plain Layout
35670 <cell alignment="left" valignment="top" usebox="none">
35673 \begin_layout Plain Layout
35679 <cell alignment="left" valignment="top" usebox="none">
35682 \begin_layout Plain Layout
35688 <cell alignment="left" valignment="top" usebox="none">
35691 \begin_layout Plain Layout
35697 <cell alignment="left" valignment="top" usebox="none">
35700 \begin_layout Plain Layout
35706 <cell alignment="center" valignment="top" usebox="none">
35709 \begin_layout Plain Layout
35715 <cell alignment="center" valignment="top" usebox="none">
35718 \begin_layout Plain Layout
35724 <cell alignment="center" valignment="top" usebox="none">
35727 \begin_layout Plain Layout
35733 <cell alignment="center" valignment="top" usebox="none">
35736 \begin_layout Plain Layout
35744 <cell alignment="left" valignment="top" usebox="none">
35747 \begin_layout Plain Layout
35753 <cell alignment="left" valignment="top" usebox="none">
35756 \begin_layout Plain Layout
35762 <cell alignment="left" valignment="top" usebox="none">
35765 \begin_layout Plain Layout
35771 <cell alignment="left" valignment="top" usebox="none">
35774 \begin_layout Plain Layout
35780 <cell alignment="center" valignment="top" usebox="none">
35783 \begin_layout Plain Layout
35789 <cell alignment="center" valignment="top" usebox="none">
35792 \begin_layout Plain Layout
35798 <cell alignment="center" valignment="top" usebox="none">
35801 \begin_layout Plain Layout
35807 <cell alignment="center" valignment="top" usebox="none">
35810 \begin_layout Plain Layout
35818 <cell alignment="center" valignment="top" usebox="none">
35821 \begin_layout Plain Layout
35827 <cell alignment="center" valignment="top" usebox="none">
35830 \begin_layout Plain Layout
35836 <cell alignment="center" valignment="top" usebox="none">
35839 \begin_layout Plain Layout
35845 <cell alignment="center" valignment="top" usebox="none">
35848 \begin_layout Plain Layout
35854 <cell alignment="center" valignment="top" usebox="none">
35857 \begin_layout Plain Layout
35863 <cell alignment="center" valignment="top" usebox="none">
35866 \begin_layout Plain Layout
35872 <cell alignment="center" valignment="top" usebox="none">
35875 \begin_layout Plain Layout
35881 <cell alignment="center" valignment="top" usebox="none">
35884 \begin_layout Plain Layout
35898 \begin_layout Chapter
35899 Names of available colors to be used in layouts
35900 \begin_inset CommandInset label
35902 name "chap:Names-of-colors"
35909 \begin_layout Standard
35910 The colors listed below are the standard colors and those that you can adjust in the \SpecialChar LyX
35914 \begin_layout Section
35918 \begin_layout Standard
35919 The following are no real colors,
35920 but rather act on color definitions:
35923 \begin_layout Description
35924 ignore The color is ignored
35927 \begin_layout Description
35928 inherit The color is inherited
35931 \begin_layout Description
35944 No particular color – clear or default
35947 \begin_layout Section
35951 \begin_layout Standard
35952 These are fixed colors that cannot be customized
35953 \change_inserted -712698321 1607683177
35959 use these colors in layout definitions,
35960 since they will not work well with some color themes (such as dark themes)
35965 \begin_layout Description
35969 \begin_layout Description
35973 \begin_layout Description
35977 \begin_layout Description
35981 \begin_layout Description
35985 \begin_layout Description
35989 \begin_layout Description
35993 \begin_layout Description
35997 \begin_layout Description
36001 \begin_layout Description
36005 \begin_layout Description
36009 \begin_layout Description
36013 \begin_layout Description
36017 \begin_layout Description
36021 \begin_layout Description
36025 \begin_layout Description
36029 \begin_layout Description
36033 \begin_layout Description
36037 \begin_layout Description
36041 \begin_layout Section
36045 \begin_layout Standard
36046 These are the colors allocated to specific elements in
36049 arg "dialog-show prefs"
36055 \begin_layout Description
36056 added_space Added space color
36059 \begin_layout Description
36060 addedtext Added text color
36063 \begin_layout Description
36064 appendix Appendix marker color
36067 \begin_layout Description
36068 background Background color
36071 \begin_layout Description
36072 bottomarea Bottom area color
36075 \begin_layout Description
36076 branchlabel Label color for branches
36079 \begin_layout Description
36080 buttonbg Color used for button background
36083 \begin_layout Description
36084 buttonframe Color for inset button frames
36087 \begin_layout Description
36088 buttonhoverbg Color used for button background under focus
36091 \begin_layout Description
36092 changebar Changebar color
36095 \begin_layout Description
36096 changedtextauthor1 Changed text color author 1
36099 \begin_layout Description
36100 changedtextauthor2 Changed text color author 2
36103 \begin_layout Description
36104 changedtextauthor3 Changed text color author 3
36107 \begin_layout Description
36108 changedtextauthor4 Changed text color author 4
36111 \begin_layout Description
36112 changedtextauthor5 Changed text color author 5
36115 \begin_layout Description
36116 collapsible Collapsible insets text color
36119 \begin_layout Description
36120 collapsibleframe Collapsible insets framecolor
36123 \begin_layout Description
36124 command Text color for command insets
36127 \begin_layout Description
36128 commandbg Background color for command insets
36131 \begin_layout Description
36132 commandframe Frame color for command insets
36135 \begin_layout Description
36136 comment Label color for comments
36139 \begin_layout Description
36140 commentbg Background color of comments
36143 \begin_layout Description
36144 cursor Cursor color
36147 \begin_layout Description
36148 deletedtext Deleted text color
36151 \begin_layout Description
36152 deletedtextmodifier Deleted text modifying color
36155 \begin_layout Description
36156 depthbar Color for the depth bars in the margin
36159 \begin_layout Description
36160 eolmarker End of line marker color
36163 \begin_layout Description
36164 error Color of the \SpecialChar LaTeX
36168 \begin_layout Description
36169 footlabel Label color for footnotes
36172 \begin_layout Description
36173 foreground Foreground color
36176 \begin_layout Description
36177 graphicsbg Graphics inset background color
36180 \begin_layout Description
36181 greyedoutbg Background color of greyedout inset
36184 \begin_layout Description
36185 greyedoutlabel Label color for greyedout insets
36188 \begin_layout Description
36189 greyedouttext Color for greyedout inset text
36192 \begin_layout Description
36193 indexlabel Label color for index insets
36196 \begin_layout Description
36197 inlinecompletion Inline completion color
36200 \begin_layout Description
36201 insetbg Inset marker background color
36204 \begin_layout Description
36205 insetframe Inset marker frame color
36208 \begin_layout Description
36209 language Color for marking foreign language words
36212 \begin_layout Description
36213 latex Text color in \SpecialChar LaTeX
36217 \begin_layout Description
36218 listingsbg Background color of listings inset
36221 \begin_layout Description
36222 marginlabel Label color for margin notes
36225 \begin_layout Description
36226 math Math inset text color
36229 \begin_layout Description
36230 mathbg Math inset background color
36233 \begin_layout Description
36234 mathcorners Math inset frame color not under focus
36237 \begin_layout Description
36238 mathframe Math inset frame color under focus
36241 \begin_layout Description
36242 mathline Math line color
36245 \begin_layout Description
36246 mathmacrobg Macro math inset background color
36249 \begin_layout Description
36250 mathmacroblend Macro math blended color
36253 \begin_layout Description
36254 mathmacroframe Macro math frame color
36257 \begin_layout Description
36258 mathmacrohoverbg Macro math inset background color hovered
36261 \begin_layout Description
36262 mathmacrolabel Macro math label color
36265 \begin_layout Description
36266 mathmacronewarg Macro template color for new parameters
36269 \begin_layout Description
36270 mathmacrooldarg Macro template color for old parameters
36273 \begin_layout Description
36274 newpage New page color
36277 \begin_layout Description
36278 nonunique_inlinecompletion Inline completion color for the non-unique part
36281 \begin_layout Description
36282 note Label color for notes
36285 \begin_layout Description
36286 notebg Background color of notes
36289 \begin_layout Description
36290 pagebreak Page break/line break color
36293 \begin_layout Description
36294 paragraphmarker Color used for the pilcrow sign to mark the end of a paragraph
36297 \begin_layout Description
36298 phantomtext Text color for phantom insets
36301 \begin_layout Description
36302 preview The color used for previews
36305 \begin_layout Description
36306 previewframe Preview frame color
36309 \begin_layout Description
36310 regexpframe Color for regexp frame
36313 \begin_layout Description
36314 scroll Color that indicates when a row can be scrolled
36317 \begin_layout Description
36318 selection Background color of selected text
36321 \begin_layout Description
36322 selectiontext Foreground color of selected text
36325 \begin_layout Description
36326 shadedbg Background color of shaded box
36329 \begin_layout Description
36330 special Special chars text color
36333 \begin_layout Description
36334 tabularline Table line color
36337 \begin_layout Description
36338 tabularonoffline Table line color
36339 \change_inserted -712698321 1607682522
36343 \begin_layout Description
36345 \change_inserted -712698321 1607682563
36346 textlabel1 Color 1 of layout and custom inset labels
36349 \begin_layout Description
36351 \change_inserted -712698321 1607682565
36352 textlabel2 Color 2 of layout and custom inset labels
36355 \begin_layout Description
36357 \change_inserted -712698321 1607682568
36358 textlabel3 Color 3 of layout and custom inset labels
36363 \begin_layout Description
36364 urllabel Label color for URL insets
36367 \begin_layout Description
36368 urltext Color for URL inset text