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
109 \notefontcolor #0000ff
113 \color #f5fae7 #0a0518
121 \paragraph_separation indent
122 \paragraph_indentation default
124 \math_indentation default
125 \math_numbering_side default
126 \quotes_style english
130 \paperpagestyle headings
132 \tracking_changes true
133 \output_changes false
135 \postpone_fragile_content false
139 \docbook_table_output 0
140 \docbook_mathml_prefix 1
141 \author -970929547 "Thibaut Cuvelier"
142 \author -712698321 "Jürgen Spitzmüller"
143 \author -584632292 "Richard Kimberly Heck"
144 \author -495245474 "Jean-Marc Lasgouttes"
147 \author 34634807 "Jean-Pierre"
148 \author 47243155 "Jean-Marc"
149 \author 232239728 "Owner"
150 \author 731793113 "Richard Kimberly Heck" rikiheck@lyx.org
151 \author 1075283030 "Thibaut"
157 Customizing \SpecialChar LyX
159 Features for the Advanced User
163 by the \SpecialChar LyX
168 \begin_layout Plain Layout
169 If you have comments or error corrections,
170 please send them to the \SpecialChar LyX
171 Documentation mailing list,
173 \begin_inset CommandInset href
175 target "lyx-docs@lists.lyx.org"
183 \begin_inset Quotes eld
187 \begin_inset Quotes erd
190 in the subject header,
191 and please cc the current maintainer of this file,
193 \change_inserted 5863208 1604930692
197 \change_inserted 5863208 1604930729
199 \change_deleted 5863208 1604930668
208 \begin_inset Newline newline
212 \begin_inset Newline newline
218 \begin_layout Standard
219 \begin_inset CommandInset toc
220 LatexCommand tableofcontents
227 \begin_layout Standard
228 \begin_inset Note Note
231 \begin_layout Plain Layout
232 Please use change tracking when modifying this document.
233 This makes it easier for our translators to recognize things that have been changed,
234 and it helps the maintainer keep up-to-date with what's been done.
242 \begin_layout Chapter
246 \begin_layout Standard
247 This manual covers the customization features present in \SpecialChar LyX
250 we discuss issues like keyboard shortcuts,
251 screen previewing options,
253 sending commands to \SpecialChar LyX
254 via the \SpecialChar LyX
256 internationalization,
257 installing new \SpecialChar LaTeX
258 classes and \SpecialChar LyX
261 We can't possibly hope to touch on everything you can change—
262 our developers add new features faster than we can document them—
263 but we will explain the most common customizations and hopefully point you in the right direction for some of the more obscure ones.
266 \begin_layout Standard
267 \begin_inset Branch OutDated
271 \begin_layout Standard
272 Information from previous versions of this document that now seems to be outdated is contained in the OutDated branch of this document.
274 this information will not appear in the \SpecialChar LaTeX
283 \begin_layout Chapter
288 \begin_layout Standard
289 This chapter aims to help you to find your way through the \SpecialChar LyX
291 Before continuing to read this chapter,
292 you should find out where your \SpecialChar LyX
294 \change_deleted -712698321 1693046672
296 \change_inserted -712698321 1693046674
299 and user directories are by using
300 \begin_inset Flex Noun
303 \begin_layout Plain Layout
304 Help\SpecialChar menuseparator
316 \change_deleted -712698321 1693046679
318 \change_inserted -712698321 1693046679
321 directory is the place where \SpecialChar LyX
322 places its system-wide configuration files;
323 the user directory is where you can place your modified versions.
324 We will call the former
325 \begin_inset Flex Code
328 \begin_layout Plain Layout
335 \begin_inset Flex Noun
338 \begin_layout Plain Layout
344 in the remainder of this document.
348 \begin_layout Section
350 \begin_inset Flex Code
353 \begin_layout Plain Layout
362 \begin_layout Standard
363 \begin_inset Flex Code
366 \begin_layout Plain Layout
372 and its sub-directories contain a number of files
373 \change_deleted 232239728 1604787780
376 that can be used to customize \SpecialChar LyX
378 You can change many of these files from within \SpecialChar LyX
380 \begin_inset Flex Noun
383 \begin_layout Plain Layout
384 Tools\SpecialChar menuseparator
391 Most customization that you will want to do in \SpecialChar LyX
392 is possible through this dialog.
394 many other inner aspects of \SpecialChar LyX
395 can be customized by modifying the files in
396 \begin_inset Flex Code
399 \begin_layout Plain Layout
406 These files fall in different categories,
407 described in the following subsections.
410 \begin_layout Subsection
411 Automatically generated files
414 \begin_layout Standard
416 \begin_inset Flex Noun
419 \begin_layout Plain Layout
425 are generated when you configure \SpecialChar LyX
427 They contain various default values that are
428 \change_inserted 5863208 1604919565
429 automatically detected during reconfiguration.
430 \change_deleted 232239728 1604788241
431 guessed by inspection
434 it is not a good idea to modify them,
435 since they might be overwritten at any time.
438 \begin_layout Labeling
439 \labelwidthstring 00.00.0000
440 \begin_inset Flex Code
443 \begin_layout Plain Layout
450 \change_deleted 5863208 1604919950
452 \begin_inset Note Note
455 \begin_layout Plain Layout
457 \change_inserted 232239728 1604853928
458 I capitalized the first word in all of these lists.
459 To me it looks better but it really is a stylistic thing,
461 However if you are not going to capitalize them,
462 the english in some needs to be modified to make it read correctly as a sentence.
470 \change_deleted 232239728 1604853510
472 \change_inserted 232239728 1604853510
475 ontains defaults for various commands.
478 \begin_layout Labeling
479 \labelwidthstring 00.00.0000
480 \begin_inset Flex Code
483 \begin_layout Plain Layout
490 \change_deleted 232239728 1604853512
492 \change_inserted 232239728 1604853512
495 ontains the list of packages that have been recognized by \SpecialChar LyX
497 It is currently unused by the \SpecialChar LyX
499 but the information extracted,
501 is made available with
502 \begin_inset Flex Noun
505 \begin_layout Plain Layout
506 Help\SpecialChar menuseparator
520 \begin_layout Labeling
521 \labelwidthstring 00.00.0000
522 \begin_inset Flex Code
525 \begin_layout Plain Layout
532 \change_deleted 232239728 1604853515
534 \change_inserted 232239728 1604853515
537 he list of text classes that have been found in your
538 \begin_inset Flex Code
541 \begin_layout Plain Layout
548 along with the associated \SpecialChar LaTeX
549 document class and their description.
552 \begin_layout Labeling
553 \labelwidthstring 00.00.0000
554 \begin_inset Flex Code
557 \begin_layout Plain Layout
564 \change_deleted 232239728 1604853518
566 \change_inserted 232239728 1604853518
569 he list of layout modules found in your
570 \begin_inset Flex Code
573 \begin_layout Plain Layout
582 \begin_layout Labeling
583 \labelwidthstring 00.00.0000
584 \begin_inset Flex Code
587 \begin_layout Plain Layout
594 \change_deleted 232239728 1604853523
596 \change_inserted 232239728 1604853523
599 ists of various sorts of \SpecialChar LaTeX
600 -related files found on your system
603 \begin_layout Labeling
604 \labelwidthstring 00.00.0000
605 \begin_inset Flex Code
608 \begin_layout Plain Layout
609 doc/\SpecialChar LaTeX
615 is automatically generated during configuration from the file
616 \begin_inset Flex Code
619 \begin_layout Plain Layout
627 It contains information on your \SpecialChar LaTeX
631 \begin_layout Subsection
635 \begin_layout Standard
637 \change_deleted 5863208 1604928729
641 \change_inserted 5863208 1604928636
645 \change_inserted 5863208 1604928661
649 \begin_inset Flex Code
652 \begin_layout Plain Layout
659 \change_inserted 5863208 1604928662
661 \change_deleted 5863208 1604928642
665 \change_deleted 5863208 1604928669
667 \begin_inset Flex Code
670 \begin_layout Plain Layout
677 \change_inserted 5863208 1604928680
681 \begin_inset Flex Code
684 \begin_layout Plain Layout
692 \change_deleted 232239728 1604794430
695 exists in both places,
697 \begin_inset Flex Code
700 \begin_layout Plain Layout
709 \begin_layout Labeling
710 \labelwidthstring 00.00.0000
711 \begin_inset Flex Code
714 \begin_layout Plain Layout
721 \change_deleted 232239728 1604794460
723 \change_inserted 232239728 1604794460
726 his directory contains files with the extension
727 \begin_inset Flex Code
730 \begin_layout Plain Layout
736 that define the keybindings used in \SpecialChar LyX
738 If there exists an internationalized version of the bind file
739 \change_inserted -712698321 1669371749
741 \change_deleted -712698321 1669371727
743 \begin_inset Flex Code
746 \begin_layout Plain Layout
753 \change_inserted -712698321 1669371728
755 \begin_inset Flex Code
758 \begin_layout Plain Layout
760 \change_inserted -712698321 1669371732
769 \begin_inset Quotes eld
773 \begin_inset Quotes erd
776 is the ISO language code
779 that will be used first.
782 \begin_layout Labeling
783 \labelwidthstring 00.00.0000
784 \begin_inset Flex Code
787 \begin_layout Plain Layout
794 \change_deleted 232239728 1604794478
796 \change_inserted 232239728 1604794478
799 ontains files with the extension
800 \begin_inset Flex Code
803 \begin_layout Plain Layout
809 which define the diverse citation possibilities (natbib,
812 \begin_inset CommandInset ref
814 reference "subsec:Cite-Engine-Files"
825 \begin_layout Labeling
826 \labelwidthstring 00.00.0000
827 \begin_inset Flex Code
830 \begin_layout Plain Layout
837 \change_deleted 232239728 1604794483
839 \change_inserted 232239728 1604794486
842 ontains graphics files that can be included in documents.
846 \begin_layout Labeling
847 \labelwidthstring 00.00.0000
848 \begin_inset Flex Code
851 \begin_layout Plain Layout
858 \change_deleted 232239728 1604794492
860 \change_inserted 232239728 1604794492
863 ontains \SpecialChar LyX
864 documentation files (including the one you are currently reading).
866 \begin_inset Flex Code
869 \begin_layout Plain Layout
871 \change_deleted 232239728 1604794660
874 \change_inserted 232239728 1604794661
882 deserves special attention,
884 The internationalized help docs are in subdirectories
885 \begin_inset Flex Code
888 \begin_layout Plain Layout
895 \begin_inset Quotes eld
899 \begin_inset Quotes erd
902 is the ISO language code.
904 \begin_inset CommandInset ref
906 reference "cha:Internationalizing-LyX"
914 \begin_layout Labeling
915 \labelwidthstring 00.00.0000
916 \begin_inset Flex Code
919 \begin_layout Plain Layout
926 \change_deleted 232239728 1604794497
928 \change_inserted 232239728 1604794497
931 ontains example files that explain how to use some features.
934 \begin_inset Flex Noun
937 \begin_layout Plain Layout
946 \begin_layout Labeling
947 \labelwidthstring 00.00.0000
948 \begin_inset Flex Code
951 \begin_layout Plain Layout
958 \change_deleted 232239728 1604794500
960 \change_inserted 232239728 1604794500
963 ontains image files that are used by the
964 \begin_inset Flex Noun
967 \begin_layout Plain Layout
975 it also contains the individual icons used in the toolbar and the banners that can be shown when \SpecialChar LyX
979 \begin_layout Labeling
980 \labelwidthstring 00.00.0000
981 \begin_inset Flex Code
984 \begin_layout Plain Layout
991 \change_deleted 232239728 1604794505
993 \change_inserted 232239728 1604794505
996 ontains keyboard keymapping files.
998 \begin_inset CommandInset ref
1000 reference "sec:International-Keymap-Stuff"
1008 \begin_layout Labeling
1009 \labelwidthstring 00.00.0000
1010 \begin_inset Flex Code
1013 \begin_layout Plain Layout
1020 \change_deleted 232239728 1604794508
1022 \change_inserted 232239728 1604794508
1025 ontains the text class and module files described in
1026 \begin_inset CommandInset ref
1028 reference "cha:Installing-New-Document"
1036 \begin_layout Labeling
1037 \labelwidthstring 00.00.0000
1038 \begin_inset Flex Code
1041 \begin_layout Plain Layout
1048 \change_deleted 232239728 1604794513
1050 \change_inserted 232239728 1604794513
1054 \begin_inset Flex Code
1057 \begin_layout Plain Layout
1063 Python scripts used to convert between \SpecialChar LyX
1065 These can be run from the command line if
1066 \change_deleted 232239728 1604794749
1071 you want to batch-convert files.
1074 \begin_layout Labeling
1075 \labelwidthstring 00.00.0000
1076 \begin_inset Flex Code
1079 \begin_layout Plain Layout
1086 \change_deleted 232239728 1604794516
1088 \change_inserted 232239728 1604794516
1091 ontains some files that demonstrate the capabilities of the
1092 \begin_inset Flex Noun
1095 \begin_layout Plain Layout
1097 \begin_inset space ~
1106 Also contains some scripts used by \SpecialChar LyX
1110 \begin_layout Labeling
1111 \labelwidthstring 00.00.0000
1112 \begin_inset Flex Code
1115 \begin_layout Plain Layout
1122 \change_deleted 232239728 1604794520
1124 \change_inserted 232239728 1604794520
1127 ontains the standard \SpecialChar LyX
1128 template files described in
1129 \begin_inset CommandInset ref
1131 reference "subsec:Creating-Templates"
1139 \begin_layout Labeling
1140 \labelwidthstring 00.00.0000
1141 \begin_inset Flex Code
1144 \begin_layout Plain Layout
1151 \change_deleted 232239728 1604794524
1153 \change_inserted 232239728 1604794524
1156 ontains files with the extension
1157 \begin_inset Flex Code
1160 \begin_layout Plain Layout
1166 that define the user interface to \SpecialChar LyX
1169 the files define which items appear in which menus and the items appearing on the toolbar.
1172 \begin_layout Labeling
1173 \labelwidthstring 00.00.0000
1174 \begin_inset Flex Code
1177 \begin_layout Plain Layout
1184 \change_deleted 232239728 1604794528
1186 \change_inserted 232239728 1604794528
1189 ontains files with the extension
1190 \begin_inset Flex Code
1193 \begin_layout Plain Layout
1199 which define the templates for the insertion of external material to a \SpecialChar LyX
1202 \begin_inset CommandInset ref
1204 reference "chap:Including-External-Material"
1212 \begin_layout Subsection
1213 Files you don't want to modify
1216 \begin_layout Standard
1217 These files are used internally by \SpecialChar LyX
1218 and you generally do not need to modify them unless you are a developer.
1221 \begin_layout Labeling
1222 \labelwidthstring 00.00.0000
1223 \begin_inset Flex Code
1226 \begin_layout Plain Layout
1233 \change_deleted 232239728 1604797616
1235 \change_inserted 232239728 1604797616
1238 his file contains the list of \SpecialChar LyX
1240 The contents are displayed with the menu entry
1241 \begin_inset Flex Noun
1244 \begin_layout Plain Layout
1245 Help\SpecialChar menuseparator
1247 \begin_inset space ~
1258 \begin_layout Labeling
1259 \labelwidthstring 00.00.0000
1260 \begin_inset Flex Code
1263 \begin_layout Plain Layout
1270 \change_deleted 232239728 1604797620
1272 \change_inserted 232239728 1604797620
1275 his is a \SpecialChar LaTeX
1276 script used during the configuration process.
1277 Do not run directly.
1280 \begin_layout Labeling
1281 \labelwidthstring 00.00.0000
1282 \begin_inset Flex Code
1285 \begin_layout Plain Layout
1292 \change_deleted 232239728 1604797624
1294 \change_inserted 232239728 1604797624
1297 his is a Python script that is used to re-configure \SpecialChar LyX
1299 It creates configuration files in the directory it was run from.
1302 \begin_layout Subsection
1303 Other files needing a line or two
1306 \begin_layout Labeling
1307 \labelwidthstring 00.00.0000
1308 \begin_inset Flex Code
1311 \begin_layout Plain Layout
1318 \change_deleted 232239728 1604797580
1320 \change_inserted 232239728 1604797580
1323 his contains tables describing how different character encodings can be mapped to Unicode
1326 \begin_layout Labeling
1327 \labelwidthstring 00.00.0000
1328 \begin_inset Flex Code
1331 \begin_layout Plain Layout
1338 \change_deleted 232239728 1604797584
1340 \change_inserted 232239728 1604797584
1343 his file contains a list of all the languages currently supported by \SpecialChar LyX
1347 \begin_layout Labeling
1348 \labelwidthstring 00.00.0000
1349 \begin_inset Flex Code
1352 \begin_layout Plain Layout
1359 \change_deleted 232239728 1604797587
1361 \change_inserted 232239728 1604797587
1364 ontains information about the supported fonts.
1367 \begin_layout Labeling
1368 \labelwidthstring 00.00.0000
1369 \begin_inset Flex Code
1372 \begin_layout Plain Layout
1379 \change_deleted 232239728 1604797591
1381 \change_inserted 232239728 1604797591
1384 his file contains translations for internationalized paragraph styles (see
1385 \begin_inset CommandInset ref
1387 reference "subsec:I18n"
1395 \begin_layout Labeling
1396 \labelwidthstring 00.00.0000
1397 \begin_inset Flex Code
1400 \begin_layout Plain Layout
1407 \change_deleted 232239728 1604797594
1409 \change_inserted 232239728 1604797594
1412 his file contains information about Unicode-encoded glyphs and the way they are supported by \SpecialChar LyX
1413 via \SpecialChar LaTeX
1417 \begin_layout Section
1418 Your local configuration directory
1421 \begin_layout Standard
1422 Even if you are using \SpecialChar LyX
1423 as an unprivileged user,
1424 you might want to change \SpecialChar LyX
1425 configuration for your own use.
1427 \begin_inset Flex Code
1430 \begin_layout Plain Layout
1436 directory contains all your personal configuration files.
1437 This is the directory described as
1438 \begin_inset Quotes eld
1442 \begin_inset Quotes erd
1446 \begin_inset Flex Noun
1449 \begin_layout Plain Layout
1450 Help\SpecialChar menuseparator
1452 \begin_inset space ~
1461 This directory is used as a mirror of
1462 \begin_inset Flex Code
1465 \begin_layout Plain Layout
1472 which means that every file in
1473 \begin_inset Flex Code
1476 \begin_layout Plain Layout
1482 is a replacement for the corresponding file in
1483 \begin_inset Flex Code
1486 \begin_layout Plain Layout
1493 Any configuration file described in the above sections can be placed either in the system-wide directory,
1494 in which case it will affect all users,
1495 or in your local directory for your own use.
1498 \begin_layout Standard
1499 To make things clearer,
1500 let's provide a few examples:
1503 \begin_layout Itemize
1504 The preferences set in the
1505 \begin_inset Flex Noun
1508 \begin_layout Plain Layout
1509 Tools\SpecialChar menuseparator
1515 dialog are saved to a file
1516 \begin_inset Flex Code
1519 \begin_layout Plain Layout
1526 \begin_inset Flex Code
1529 \begin_layout Plain Layout
1538 \begin_layout Itemize
1539 When you reconfigure using
1540 \begin_inset Flex Noun
1543 \begin_layout Plain Layout
1544 Tools\SpecialChar menuseparator
1553 \begin_inset Flex Code
1556 \begin_layout Plain Layout
1563 and the resulting files are written in your local configuration directory.
1564 This means that any additional text class file that you might have added in
1565 \begin_inset Flex Code
1568 \begin_layout Plain Layout
1574 will be added to the list of classes in the
1575 \begin_inset Flex Noun
1578 \begin_layout Plain Layout
1579 Document\SpecialChar menuseparator
1588 \begin_layout Itemize
1589 If you get some updated documentation from
1590 \change_inserted 232239728 1604798171
1594 ftp site and cannot install it because you do not have sysadmin rights on your system,
1595 you can just copy the files
1596 \change_deleted 232239728 1604798193
1598 \change_inserted 232239728 1604798193
1602 \begin_inset Flex Code
1605 \begin_layout Plain Layout
1611 and the items in the
1612 \begin_inset Flex Noun
1615 \begin_layout Plain Layout
1621 menu will open them!
1624 \begin_layout Section
1625 Running \SpecialChar LyX
1626 with multiple configurations
1629 \begin_layout Standard
1630 The configuration freedom of the local configuration directory may not suffice if you want to have more than one configuration at your disposal.
1633 \change_deleted 232239728 1604798238
1636 use different key bindings or printer settings at different times.
1637 You can achieve this by having several such directories.
1638 You then specify which directory to use at run-time.
1641 \begin_layout Standard
1642 Invoking \SpecialChar LyX
1643 with the command line switch
1644 \begin_inset Flex Code
1647 \begin_layout Plain Layout
1657 instructs the program to read the configuration from that directory,
1658 and not from the default directory.
1659 (You can determine the default directory by running \SpecialChar LyX
1661 \begin_inset Flex Code
1664 \begin_layout Plain Layout
1670 switch.) If the specified directory does not exist,
1672 offers to create it for you,
1673 just like it does for the default directory
1674 \change_deleted 232239728 1604798318
1677 the first time you run the program.
1678 You can modify the configuration options in this additional user directory exactly as you would for the default directory.
1679 These directories are completely independent (but read on).
1680 Note that setting the environment variable
1681 \begin_inset Flex Code
1684 \begin_layout Plain Layout
1690 to some value has exactly the same effect.
1693 \begin_layout Standard
1694 Having several configurations also requires more maintenance:
1695 if you want to add a new layout to
1696 \begin_inset Flex Code
1699 \begin_layout Plain Layout
1705 which you want available from all your configurations,
1706 you must add it to each directory separately.
1707 You can avoid this with the following trick:
1708 after \SpecialChar LyX
1709 creates the additional directory,
1710 most of the subdirectories (see above) are empty.
1711 If you want the new configuration to mirror an existing one,
1712 replace the empty subdirectory with a symbolic link to the matching subdirectory in the existing configuration.
1714 \begin_inset Flex Code
1717 \begin_layout Plain Layout
1725 since it contains a file written by the configuration script (also accessible through
1726 \begin_inset Flex Noun
1729 \begin_layout Plain Layout
1730 Tools\SpecialChar menuseparator
1736 ) which is configuration
1737 \change_deleted 232239728 1604798083
1739 \change_inserted 232239728 1604798100
1745 \begin_layout Chapter
1746 The Preferences dialog
1749 \begin_layout Standard
1750 All options of the preferences dialog are described in the Appendix
1752 The Preferences Dialog
1759 For some options you might find here more details.
1762 \begin_layout Section
1764 \begin_inset CommandInset label
1773 \begin_layout Standard
1774 The first step is to define your file formats if they are not already defined.
1777 \begin_inset Flex Noun
1780 \begin_layout Plain Layout
1781 Tools\SpecialChar menuseparator
1789 \begin_inset Flex Noun
1792 \begin_layout Plain Layout
1793 File Handling\SpecialChar menuseparator
1800 \begin_inset Flex Noun
1803 \begin_layout Plain Layout
1809 button to define your new format.
1811 \begin_inset Flex Noun
1814 \begin_layout Plain Layout
1820 field contains the name used to identify the format in the GUI.
1822 \begin_inset Flex Noun
1825 \begin_layout Plain Layout
1831 is used to identify the format internally.
1832 You will also need to enter a file extension.
1833 These are all required.
1835 \begin_inset Flex Noun
1838 \begin_layout Plain Layout
1844 field is used to provide a keyboard shortcut on the menus.
1847 \begin_inset Flex Noun
1850 \begin_layout Plain Layout
1857 \begin_inset Flex Noun
1860 \begin_layout Plain Layout
1861 Document\SpecialChar menuseparator
1862 View (Other Formats)\SpecialChar menuseparator
1871 \begin_layout Standard
1873 \begin_inset Flex Noun
1876 \begin_layout Plain Layout
1883 \begin_inset Flex Noun
1886 \begin_layout Plain Layout
1894 you might want to use
1895 \begin_inset Flex Noun
1898 \begin_layout Plain Layout
1904 to view PostScript files.
1905 You can enter the command needed to start the program in the corresponding fields.
1906 In defining this command,
1907 you can use the four variables listed in the next section.
1908 The viewer is launched when you view an image in \SpecialChar LyX
1910 \begin_inset Flex Noun
1913 \begin_layout Plain Layout
1914 Document\SpecialChar menuseparator
1921 The editor is for example launched when you right-click on an image and choose
1922 \begin_inset Flex Noun
1925 \begin_layout Plain Layout
1931 in the appearing context menu.
1934 \begin_layout Standard
1936 \begin_inset Flex Noun
1939 \begin_layout Plain Layout
1945 type of a format is optional,
1946 but if it is specified,
1947 it must be unique across all formats.
1948 It is used to detect files of this format from the file contents.
1949 For some important file formats there is no MIME type officially registered with the
1950 \begin_inset CommandInset href
1953 target "http://www.iana.org/assignments/media-types/"
1959 Therefore \SpecialChar LyX
1960 uses the extended list of MIME types as specified by
1961 \begin_inset CommandInset href
1963 name "freedesktop.org"
1964 target "http://www.freedesktop.org/wiki/Specifications/shared-mime-info-spec"
1972 \begin_layout Standard
1974 \begin_inset Flex Noun
1977 \begin_layout Plain Layout
1983 option tells \SpecialChar LyX
1984 that a format is suitable for document export.
1985 If this is set and if a suitable conversion route exists (see
1986 \begin_inset CommandInset ref
1988 reference "sec:Converters"
1994 the format will appear in the
1995 \begin_inset Flex Noun
1998 \begin_layout Plain Layout
1999 File\SpecialChar menuseparator
2006 The format will also appear in the
2007 \begin_inset Flex Noun
2010 \begin_layout Plain Layout
2011 Document\SpecialChar menuseparator
2017 menu if a viewer is specified for the format.
2020 \begin_inset Flex Code
2023 \begin_layout Plain Layout
2030 should not use this option.
2031 Formats that can both represent vector graphics and documents like
2032 \begin_inset Flex Code
2035 \begin_layout Plain Layout
2044 \begin_layout Standard
2046 \begin_inset Flex Noun
2049 \begin_layout Plain Layout
2050 Vector graphics format
2055 tells \SpecialChar LyX
2056 that a format can contain vector graphics.
2057 This information is used to determine the target format of included graphics for
2058 \begin_inset Flex Noun
2061 \begin_layout Plain Layout
2068 Included graphics may need to be converted to either
2069 \begin_inset Flex Noun
2072 \begin_layout Plain Layout
2080 \begin_inset Flex Noun
2083 \begin_layout Plain Layout
2091 \begin_inset Flex Noun
2094 \begin_layout Plain Layout
2102 \begin_inset Flex Noun
2105 \begin_layout Plain Layout
2111 cannot handle other image formats.
2112 If an included graphic is not already in
2113 \begin_inset Flex Noun
2116 \begin_layout Plain Layout
2124 \begin_inset Flex Noun
2127 \begin_layout Plain Layout
2135 \begin_inset Flex Noun
2138 \begin_layout Plain Layout
2146 \begin_inset Flex Noun
2149 \begin_layout Plain Layout
2155 if the vector format option is set,
2157 \begin_inset Flex Noun
2160 \begin_layout Plain Layout
2169 \begin_layout Section
2173 \begin_layout Standard
2174 Since all conversions from one format to another take place in \SpecialChar LyX
2175 's temporary directory,
2176 it is sometimes necessary to modify a file before copying it to the temporary directory in order that the conversion may be performed.
2180 \begin_layout Plain Layout
2182 the file may refer to other files—
2185 using relative file names,
2186 and these may become invalid when the file is copied to the temporary directory.
2191 This is done by a Copier:
2192 It copies a file to (or from) the temporary directory and may modify it in the process.
2195 \begin_layout Standard
2196 The definitions of the copiers may use eight variables:
2199 \begin_layout Labeling
2200 \labelwidthstring 00.00.0000
2201 \begin_inset Flex Code
2204 \begin_layout Plain Layout
2210 The \SpecialChar LyX
2211 system directory (e.
2212 \begin_inset space \thinspace{}
2216 \begin_inset space \space{}
2220 \begin_inset Flex Noun
2223 \begin_layout Plain Layout
2232 \begin_layout Labeling
2233 \labelwidthstring 00.00.0000
2234 \begin_inset Flex Code
2237 \begin_layout Plain Layout
2246 \begin_layout Labeling
2247 \labelwidthstring 00.00.0000
2248 \begin_inset Flex Code
2251 \begin_layout Plain Layout
2260 \begin_layout Labeling
2261 \labelwidthstring 00.00.0000
2262 \begin_inset Flex Code
2265 \begin_layout Plain Layout
2271 The base name (without filename extension) in the \SpecialChar LyX
2275 \begin_layout Labeling
2276 \labelwidthstring 00.00.0000
2277 \begin_inset Flex Code
2280 \begin_layout Plain Layout
2286 The full directory path of the \SpecialChar LyX
2290 \begin_layout Labeling
2291 \labelwidthstring 00.00.0000
2292 \begin_inset Flex Code
2295 \begin_layout Plain Layout
2301 The full pathname to the original \SpecialChar LyX
2302 file being processed
2305 \begin_layout Labeling
2306 \labelwidthstring 00.00.0000
2307 \begin_inset Flex Code
2310 \begin_layout Plain Layout
2316 The filename (without any directory path) of the \SpecialChar LyX
2320 \begin_layout Labeling
2321 \labelwidthstring 00.00.0000
2322 \begin_inset Flex Code
2325 \begin_layout Plain Layout
2331 The `\SpecialChar LaTeX
2335 \begin_layout Standard
2336 The latter should be the filename as it would be used in a \SpecialChar LaTeX
2344 It is relevant only when exporting files suitable for such inclusion.
2347 \begin_layout Standard
2348 Copiers can be used to do almost anything with output files.
2350 suppose you want generated pdf files to be copied to a special directory,
2352 \begin_inset Flex Code
2355 \begin_layout Plain Layout
2362 Then you could write a shell script such as this one:
2365 \begin_layout Standard
2366 \begin_inset listings
2370 \begin_layout Plain Layout
2375 \begin_layout Plain Layout
2380 \begin_layout Plain Layout
2382 TOFILE=`basename $2`
2385 \begin_layout Plain Layout
2387 cp $FROMFILE /home/you/pdf/$TOFILE
2392 Save it in your local \SpecialChar LyX
2396 \begin_inset Flex Code
2399 \begin_layout Plain Layout
2400 /home/you/.lyx/scripts/pdfcopier.sh
2406 and make it executable,
2407 if you need to do so on your platform.
2410 \begin_inset Flex Noun
2413 \begin_layout Plain Layout
2414 Tools\SpecialChar menuseparator
2422 \begin_inset Flex Noun
2425 \begin_layout Plain Layout
2426 File Handling\SpecialChar menuseparator
2433 \begin_inset Flex Noun
2436 \begin_layout Plain Layout
2443 or one of the other pdf formats—
2445 \begin_inset Flex Code
2448 \begin_layout Plain Layout
2449 pdfcopier.sh $$i $$o
2455 \begin_inset Flex Noun
2458 \begin_layout Plain Layout
2468 \begin_layout Standard
2469 Copiers are used by \SpecialChar LyX
2470 in various of its own conversions.
2472 if appropriate programs are found,
2474 will automatically install copiers for the
2475 \begin_inset Flex Noun
2478 \begin_layout Plain Layout
2485 \begin_inset Flex Noun
2488 \begin_layout Plain Layout
2490 \begin_inset space ~
2499 When these formats are exported,
2500 the copier sees that not just the main HTML file but various associated files (style files,
2502 etc.) are also copied.
2503 All these files are written to a subdirectory of the directory in which the original \SpecialChar LyX
2508 \begin_layout Plain Layout
2509 This copier can be customized.
2511 \begin_inset Quotes eld
2515 \begin_inset Quotes erd
2518 argument takes a comma-separated list of extensions to be copied;
2520 all files will be copied.
2522 \begin_inset Quotes eld
2526 \begin_inset Quotes erd
2529 argument determines the extension added to the generated directory.
2532 \begin_inset Quotes eld
2536 \begin_inset Flex Noun
2539 \begin_layout Plain Layout
2546 \begin_inset Quotes erd
2550 so HTML generated from
2551 \begin_inset Flex Noun
2554 \begin_layout Plain Layout
2555 /path/to/filename.lyx
2561 \begin_inset Flex Noun
2564 \begin_layout Plain Layout
2565 /path/to/filename.html.LyXconv
2579 \begin_layout Section
2581 \begin_inset CommandInset label
2583 name "sec:Converters"
2590 \begin_layout Standard
2591 You can define your own Converters to convert files between different formats.
2593 \begin_inset Flex Noun
2596 \begin_layout Plain Layout
2597 Tools\SpecialChar menuseparator
2598 Preferences\SpecialChar menuseparator
2599 File Handling\SpecialChar menuseparator
2608 \begin_layout Standard
2609 To define a new converter,
2611 \begin_inset Flex Noun
2614 \begin_layout Plain Layout
2616 \begin_inset space ~
2625 \begin_inset Flex Noun
2628 \begin_layout Plain Layout
2630 \begin_inset space ~
2638 from the drop-down lists,
2639 enter the command needed for the conversion,
2641 \begin_inset Flex Noun
2644 \begin_layout Plain Layout
2651 Several variables can be used in the definition of converters:
2654 \begin_layout Labeling
2655 \labelwidthstring 00.00.0000
2656 \begin_inset Flex Code
2659 \begin_layout Plain Layout
2665 The \SpecialChar LyX
2669 \begin_layout Labeling
2670 \labelwidthstring 00.00.0000
2671 \begin_inset Flex Code
2674 \begin_layout Plain Layout
2683 \begin_layout Labeling
2684 \labelwidthstring 00.00.0000
2685 \begin_inset Flex Code
2688 \begin_layout Plain Layout
2697 \begin_layout Labeling
2698 \labelwidthstring 00.00.0000
2699 \begin_inset Flex Code
2702 \begin_layout Plain Layout
2708 The base filename of the input file (i.
2709 \begin_inset space \thinspace{}
2713 without the extension)
2716 \begin_layout Labeling
2717 \labelwidthstring 00.00.0000
2718 \begin_inset Flex Code
2721 \begin_layout Plain Layout
2727 The path to the input file
2730 \begin_layout Labeling
2731 \labelwidthstring 00.00.0000
2732 \begin_inset Flex Code
2735 \begin_layout Plain Layout
2741 The path to the original input file (this is different from $$p when a chain of converters is called)
2744 \begin_layout Labeling
2745 \labelwidthstring 00.00.0000
2746 \begin_inset Flex Code
2749 \begin_layout Plain Layout
2755 The iconv name for the encoding of the document.
2758 \begin_layout Standard
2760 \begin_inset Flex Noun
2763 \begin_layout Plain Layout
2765 \begin_inset space ~
2773 field you can enter the following flags,
2774 separated by commas:
2777 \begin_layout Labeling
2778 \labelwidthstring 00.00.0000
2779 \begin_inset Flex Code
2782 \begin_layout Plain Layout
2784 \change_inserted -712698321 1524656940
2792 This converter runs some form of \SpecialChar LaTeX
2794 This will make \SpecialChar LyX
2795 's \SpecialChar LaTeX
2796 error logs available.
2798 \change_inserted -712698321 1524657018
2800 \begin_inset Flex Code
2803 \begin_layout Plain Layout
2805 \change_inserted -712698321 1524657012
2813 value specifies the form of \SpecialChar LaTeX
2815 \begin_inset Flex Code
2818 \begin_layout Plain Layout
2820 \change_inserted -712698321 1524657005
2833 If no value is specified,
2835 \begin_inset Flex Code
2838 \begin_layout Plain Layout
2840 \change_inserted -712698321 1524657018
2853 \begin_layout Labeling
2854 \labelwidthstring 00.00.0000
2856 \change_inserted -712698321 1676553236
2857 \begin_inset Flex Code
2860 \begin_layout Plain Layout
2862 \change_inserted -712698321 1676552303
2870 This converter is considered non-safe and needs authorization by the user.
2871 Depending on the settings in
2873 Tools\SpecialChar menuseparator
2874 Preferences\SpecialChar menuseparator
2875 File Handling\SpecialChar menuseparator
2879 users will (a.) be asked whether they trust the current document temporarily,
2882 (b.) be informed that conversion is not possible due to security concerns,
2883 or (c.) not be informed as they gave permanent consent.
2884 Set this flag for converters that might execute arbitrary programs.
2887 \begin_layout Labeling
2888 \labelwidthstring 00.00.0000
2889 \begin_inset Flex Code
2892 \begin_layout Plain Layout
2894 \change_inserted -712698321 1524656935
2902 Needs the \SpecialChar LaTeX
2904 \begin_inset Flex Noun
2907 \begin_layout Plain Layout
2913 file for the conversion.
2915 \change_inserted -712698321 1524657047
2917 \begin_inset Flex Code
2920 \begin_layout Plain Layout
2922 \change_inserted -712698321 1524657030
2930 value specifies the form of \SpecialChar LaTeX
2931 that is run in order to generate the
2932 \begin_inset Flex Noun
2935 \begin_layout Plain Layout
2937 \change_inserted -712698321 1524657047
2946 \begin_inset Flex Code
2949 \begin_layout Plain Layout
2951 \change_inserted -712698321 1524657030
2964 If no value is specified,
2966 \begin_inset Flex Code
2969 \begin_layout Plain Layout
2971 \change_inserted -712698321 1524657030
2984 \begin_layout Labeling
2985 \labelwidthstring 00.00.0000
2986 \begin_inset Flex Code
2989 \begin_layout Plain Layout
2996 \begin_inset Quotes eld
3000 \begin_inset Quotes erd
3003 file from the backend,
3004 which in practice means a \SpecialChar LaTeX
3005 file like the one we would export,
3007 \begin_inset Flex Code
3010 \begin_layout Plain Layout
3019 \begin_layout Labeling
3020 \labelwidthstring 00.00.0000
3021 \begin_inset Flex Code
3024 \begin_layout Plain Layout
3033 \begin_layout Standard
3034 The following three flags are not really flags at all because they take an argument in the
3035 \begin_inset Flex Noun
3038 \begin_layout Plain Layout
3040 \begin_inset space ~
3044 \begin_inset space ~
3055 \begin_layout Labeling
3056 \labelwidthstring 00.00.0000
3058 \change_inserted -712698321 1523206314
3059 \begin_inset Flex Code
3062 \begin_layout Plain Layout
3064 \change_inserted -712698321 1523206193
3072 The name of the driver that needs to be loaded with the
3076 package for this converter.
3077 The loading of the correct driver is necessary to get some PDF-specific features.
3085 \begin_layout Labeling
3086 \labelwidthstring 00.00.0000
3087 \begin_inset Flex Code
3090 \begin_layout Plain Layout
3097 the converter's standard error will be redirected to a file
3098 \begin_inset Flex Code
3101 \begin_layout Plain Layout
3108 and the script given as argument will be run as:
3110 \begin_inset Flex Code
3113 \begin_layout Plain Layout
3114 script < infile.out > infile.log
3120 The argument may contain
3121 \begin_inset Flex Code
3124 \begin_layout Plain Layout
3133 \begin_layout Labeling
3134 \labelwidthstring 00.00.0000
3135 \begin_inset Flex Code
3138 \begin_layout Plain Layout
3144 The name of the directory in which the converter will dump the generated files.
3146 will not create this directory,
3147 and it does not copy anything into it,
3148 though it will copy this directory to the destination.
3149 The argument may contain
3150 \begin_inset Flex Code
3153 \begin_layout Plain Layout
3160 which will be replaced by the base name of the input and output files,
3162 when the directory is copied.
3163 \begin_inset Newline newline
3166 Note that resultdir and usetempdir make no sense together.
3167 The latter will be ignored if the former is given.
3170 \begin_layout Labeling
3171 \labelwidthstring 00.00.0000
3172 \begin_inset Flex Code
3175 \begin_layout Plain Layout
3181 Determines the output file name and may,
3183 \begin_inset Flex Code
3186 \begin_layout Plain Layout
3193 Sensible only with resultdir and optional even then;
3195 it defaults to `index'.
3198 \begin_layout Standard
3200 \change_inserted -712698321 1523206384
3201 A suitable hyperref-driver is set for some converters that are installed with \SpecialChar LyX
3204 \change_deleted -712698321 1523206388
3206 \change_inserted -712698321 1523206389
3210 \change_inserted -712698321 1523206400
3216 \change_inserted -712698321 1523206407
3220 \change_inserted -712698321 1523206437
3224 \change_deleted -712698321 1523206442
3225 that are installed with \SpecialChar LyX
3232 \begin_layout Standard
3233 You do not have to define converters for all formats between which you want to convert.
3235 you will note that there is no `\SpecialChar LyX
3236 to PostScript' converter,
3237 but \SpecialChar LyX
3238 will export PostScript.
3239 It does so by first creating a \SpecialChar LaTeX
3240 file (no converter needs to be defined for this) which is then converted to DVI using the `\SpecialChar LaTeX
3242 and finally converting the resulting DVI file to PostScript.
3244 finds such `chains' of converters automatically,
3245 and it will always choose the shortest possible chain.
3248 still define multiple conversion methods between file formats.
3250 the standard \SpecialChar LyX
3251 configuration provides five ways to convert \SpecialChar LaTeX
3255 \begin_layout Enumerate
3258 \begin_inset Flex Noun
3261 \begin_layout Plain Layout
3270 \begin_layout Enumerate
3271 via (DVI and) PostScript,
3273 \begin_inset Flex Noun
3276 \begin_layout Plain Layout
3285 \begin_layout Enumerate
3288 \begin_inset Flex Noun
3291 \begin_layout Plain Layout
3300 \begin_layout Enumerate
3302 \begin_inset Flex Noun
3305 \begin_layout Plain Layout
3315 \begin_layout Enumerate
3317 \begin_inset Flex Noun
3320 \begin_layout Plain Layout
3330 \begin_layout Standard
3331 To define such alternate chains,
3332 you must define multiple target `file formats',
3334 \begin_inset CommandInset ref
3336 reference "sec:Formats"
3343 in the standard configuration,
3345 \begin_inset Flex Noun
3348 \begin_layout Plain Layout
3355 \begin_inset Flex Noun
3358 \begin_layout Plain Layout
3366 \begin_inset Flex Noun
3369 \begin_layout Plain Layout
3376 \begin_inset Flex Noun
3379 \begin_layout Plain Layout
3387 \begin_inset Flex Noun
3390 \begin_layout Plain Layout
3397 \begin_inset Flex Noun
3400 \begin_layout Plain Layout
3408 \begin_inset Flex Noun
3411 \begin_layout Plain Layout
3418 \begin_inset Flex Noun
3421 \begin_layout Plain Layout
3430 \begin_inset Flex Noun
3433 \begin_layout Plain Layout
3440 \begin_inset Flex Noun
3443 \begin_layout Plain Layout
3451 all of which share the extension
3452 \begin_inset Flex Noun
3455 \begin_layout Plain Layout
3462 and which correspond to the conversion methods just mentioned.
3465 \begin_layout Chapter
3466 Internationalizing \SpecialChar LyX
3468 \begin_inset CommandInset label
3470 name "cha:Internationalizing-LyX"
3477 \begin_layout Standard
3479 supports using a translated interface.
3480 Last time we checked,
3482 provided text in thirty languages.
3483 The language of choice is called your
3488 (For further reading on locale settings,
3489 see also the documentation for locale that comes with your operating system.
3492 \begin_inset Flex Code
3495 \begin_layout Plain Layout
3501 could be a good place to start).
3504 \begin_layout Standard
3505 Notice that these translations will work,
3506 but do contain a few flaws.
3508 all dialogs have been designed with the English text in mind,
3509 which means that some of the translated text will be too large to fit within the space allocated.
3510 This is only a display problem and will not cause any harm.
3512 you will find that some of the translations do not define shortcut keys for everything.
3514 there are simply not enough free letters to do it.
3516 the translator just hasn't got around to doing it yet.
3517 Our localization team,
3518 which you may wish to join,
3522 \begin_layout Plain Layout
3523 If you are a fluent speaker of a language other than English,
3524 joining these teams is a great way to give back to the \SpecialChar LyX
3530 will of course try to fix these shortcomings in future versions of \SpecialChar LyX
3534 \begin_layout Section
3535 Translating \SpecialChar LyX
3539 \begin_layout Subsection
3540 Translating the graphical user interface (text messages).
3543 \begin_layout Standard
3546 \begin_inset Flex Code
3549 \begin_layout Plain Layout
3555 library to handle the internationalization of the interface.
3556 To have \SpecialChar LyX
3557 speak your favorite language in all menus and dialogs,
3559 \begin_inset Flex Code
3562 \begin_layout Plain Layout
3568 -file for that language.
3569 When this is available,
3570 you'll have to generate a
3571 \begin_inset Flex Code
3574 \begin_layout Plain Layout
3580 -file from it and install the
3581 \begin_inset Flex Code
3584 \begin_layout Plain Layout
3591 The process of doing all of this is explained in the documentation for GNU
3592 \begin_inset Flex Code
3595 \begin_layout Plain Layout
3602 It is possible to do this just for yourself,
3603 but if you're going to do it,
3604 you might as well share the results of your labors with the rest of the \SpecialChar LyX
3606 Send a message to the \SpecialChar LyX
3607 developers' list for more information about how to proceed.
3610 \begin_layout Standard
3612 this is what you should do (xx denotes the language code):
3615 \begin_layout Itemize
3616 Check out the \SpecialChar LyX
3619 \begin_inset CommandInset href
3621 name "information on the web"
3622 target "https://www.lyx.org/HowToUseGIT"
3630 \begin_layout Itemize
3632 \begin_inset Flex Code
3635 \begin_layout Plain Layout
3641 to the folder of the
3642 \begin_inset Flex Code
3645 \begin_layout Plain Layout
3653 \begin_inset Flex Code
3656 \begin_layout Plain Layout
3664 \begin_inset Flex Code
3667 \begin_layout Plain Layout
3673 doesn't exist anywhere,
3674 it can be remade with the console command
3675 \begin_inset Flex Code
3678 \begin_layout Plain Layout
3685 or you can use an existing po-file for some other language as a template).
3688 \begin_layout Itemize
3690 \begin_inset Flex Code
3693 \begin_layout Plain Layout
3703 \begin_layout Plain Layout
3704 This is just a text file,
3705 so it can be edited in any text editor.
3706 But there are also specialized programs that support such editing,
3711 (for all platforms) or
3720 contains a `mode' for editing
3721 \begin_inset Flex Code
3724 \begin_layout Plain Layout
3733 \begin_inset Flex URL
3736 \begin_layout Plain Layout
3738 https://www.gnu.org/software/gettext/manual/html_node/PO-Mode.html#PO-Mode
3748 For some menu- and widget-labels,
3749 there are also shortcut keys that should be translated.
3750 Those keys are marked after a `|',
3751 and should be translated according to the words and phrases of the language.
3752 You should also fill also out the information at the beginning of the new
3753 \begin_inset Flex Code
3756 \begin_layout Plain Layout
3762 -file with your email-address,
3764 so people know where to reach you with suggestions and entertaining flames.
3767 \begin_layout Standard
3768 If you are just doing this on your own,
3772 \begin_layout Itemize
3774 \begin_inset Flex Code
3777 \begin_layout Plain Layout
3784 This can be done with
3785 \begin_inset Flex Code
3788 \begin_layout Plain Layout
3789 msgfmt -o xx.mo < xx.po
3797 \begin_layout Itemize
3799 \begin_inset Flex Code
3802 \begin_layout Plain Layout
3808 -file to your locale-tree,
3809 at the correct directory for application messages for the language
3815 \begin_inset Flex Code
3818 \begin_layout Plain Layout
3825 \begin_inset space \thinspace{}
3829 \begin_inset space \space{}
3833 \begin_inset Flex Code
3836 \begin_layout Plain Layout
3837 /usr/local/share/locale/xx/LC_MESSAGES/lyx.mo
3847 \begin_layout Standard
3850 it would be best if the new
3851 \begin_inset Flex Code
3854 \begin_layout Plain Layout
3860 file could be added to the \SpecialChar LyX
3862 so others can use it.
3863 Adding it involves making additional changes to \SpecialChar LyX
3865 So send an email to the developers' mailing list if you're interested in doing that.
3868 \begin_layout Subsubsection
3872 \begin_layout Standard
3873 Sometimes it turns out that one English message needs to be translated into different messages in the target language.
3874 One example is the message
3875 \begin_inset Flex Code
3878 \begin_layout Plain Layout
3884 which has the German translation
3893 depending upon exactly what the English
3894 \begin_inset Quotes eld
3898 \begin_inset Quotes erd
3903 \begin_inset Flex Code
3906 \begin_layout Plain Layout
3912 does not handle such ambiguous translations.
3913 Therefore you have to add some context information to the message:
3915 \begin_inset Flex Code
3918 \begin_layout Plain Layout
3925 \begin_inset Flex Code
3928 \begin_layout Plain Layout
3929 To[[as in 'From format x to format y']]
3935 \begin_inset Flex Code
3938 \begin_layout Plain Layout
3939 To[[as in 'From page x to page y']].
3944 Now the two occurrences of
3945 \begin_inset Flex Code
3948 \begin_layout Plain Layout
3955 \begin_inset Flex Code
3958 \begin_layout Plain Layout
3964 and can be translated correctly to
3976 \begin_layout Standard
3977 Of course the context information needs to be stripped off the original message when no translation is used.
3978 Therefore you have to put it in double square brackets at the end of the message (see the example above).
3979 The translation mechanism of \SpecialChar LyX
3980 ensures that everything in double square brackets at the end of messages is removed before displaying the message.
3983 \begin_layout Subsection
3984 Translating the documentation.
3987 \begin_layout Standard
3988 The online documentation (in the
3989 \begin_inset Flex Noun
3992 \begin_layout Plain Layout
3998 -menu) can (and should!) be translated.
3999 If there are translated versions of the documentation available
4003 \begin_layout Plain Layout
4005 at least some of the documents have been translated into fourteen languages,
4006 with the Tutorial available in a few more.
4011 and the locale is set accordingly,
4012 these will be used automagically by \SpecialChar LyX
4015 looks for translated versions as
4016 \begin_inset Flex Code
4019 \begin_layout Plain Layout
4020 LyXDir/doc/xx/DocName.lyx
4027 \begin_inset Flex Code
4030 \begin_layout Plain Layout
4036 is the code for the language currently in use.
4037 If there are no translated documents,
4038 the default English versions will be displayed.
4039 Note that the translated versions must have the same filenames (
4040 \begin_inset Flex Code
4043 \begin_layout Plain Layout
4049 above) as the original.
4050 If you feel up to translating the documentation (an excellent way to proof-read the original documentation by the way!),
4051 there are a few things you should do right away:
4054 \begin_layout Itemize
4055 Check out the documentation translation web page at
4056 \begin_inset CommandInset href
4058 name "https://www.lyx.org/Translation"
4059 target "https://www.lyx.org/Translation"
4066 you can find out which (if any) documents have already been translated into your language.
4067 You can also find out who (if anyone) is organizing the effort to translate the documentation into your language.
4068 If no one is organizing the effort,
4069 please let us know that you're interested.
4072 \begin_layout Standard
4073 Once you get to actually translating,
4074 here's a few hints for you that may save you trouble:
4077 \begin_layout Itemize
4078 Join the documentation team!
4079 There is information on how to do that in
4080 \begin_inset Flex Code
4083 \begin_layout Plain Layout
4090 \begin_inset Flex Noun
4093 \begin_layout Plain Layout
4094 Help\SpecialChar menuseparator
4101 which by the way is the first document you should translate.
4104 \begin_layout Itemize
4105 Learn the typographic conventions for the language you are translating to.
4106 Typography is an ancient art and over the centuries,
4107 a great variety of conventions have developed throughout different parts of the world.
4108 Also study the professional terminology amongst typographers in your country.
4109 Inventing your own terminology will only confuse the users.
4113 Typography is addictive!)
4116 \begin_layout Itemize
4117 Make a copy of the document.
4118 This will be your working copy.
4119 You can use this as your personal translated help-file by placing it in your
4120 \begin_inset Flex Code
4123 \begin_layout Plain Layout
4130 \begin_inset Note Greyedout
4133 \begin_layout Plain Layout
4139 For a complex document with external material (images,
4141 if you make a copy e.
4142 \begin_inset space \thinspace{}
4146 \begin_inset space \space{}
4150 beware that the links to external material may be broken when the document is moved to a different place.
4151 The best way is to retrieve the \SpecialChar LyX
4153 \begin_inset Flex URL
4156 \begin_layout Plain Layout
4158 https://www.lyx.org/HowToUseGIT
4163 ) and to edit the doc file in place.
4171 \begin_layout Itemize
4172 Sometimes the original document (from the \SpecialChar LyX
4173 team) will be updated.
4174 Use the source viewer at
4175 \begin_inset CommandInset href
4177 name "https://www.lyx.org/trac/timeline"
4178 target "https://www.lyx.org/trac/timeline"
4183 to see what has been changed.
4184 That way you can easily see which parts of the translated document need to be updated.
4187 \begin_layout Standard
4188 If you ever find an error in the original document,
4189 fix it and notify the rest of the documentation team of the changes!
4190 (You didn't forget to join the documentation team,
4194 \begin_layout Standard
4195 \begin_inset Branch OutDated
4199 \begin_layout Section
4200 International Keyboard Support
4203 \begin_layout Standard
4207 The following section is by
4215 It needs to be fixed to conform to the new Documentation Style sheet and to make use of the new v1.0 features.
4216 The whole thing also needs to be merged with the section following it.-jw It may also be badly out of date.-rh (2008)]
4219 \begin_layout Subsection
4220 Defining Own Keymaps:
4224 \begin_layout Standard
4225 Let's look at a keyboard definition file a little closer.
4226 It is a plain text file defining
4229 \begin_layout Itemize
4230 key-to-key or key-to-string translations
4233 \begin_layout Itemize
4237 \begin_layout Itemize
4238 dead keys exceptions
4241 \begin_layout Standard
4242 To define key-to-key or key-to-string translation,
4246 \begin_layout Quotation
4247 \begin_inset Flex Code
4250 \begin_layout Plain Layout
4259 \begin_inset Flex Code
4262 \begin_layout Plain Layout
4271 \begin_layout Standard
4273 \begin_inset Flex Code
4276 \begin_layout Plain Layout
4282 is the key to be translated and
4283 \begin_inset Flex Code
4286 \begin_layout Plain Layout
4292 is the string to be inserted into the document.
4293 To define dead keys,
4297 \begin_layout Quotation
4298 \begin_inset Flex Code
4301 \begin_layout Plain Layout
4310 \begin_inset Flex Code
4313 \begin_layout Plain Layout
4322 \begin_layout Standard
4324 \begin_inset Flex Code
4327 \begin_layout Plain Layout
4333 is a keyboard key and
4334 \begin_inset Flex Code
4337 \begin_layout Plain Layout
4344 The following dead keys are supported (shortcut name is in parentheses):
4347 \begin_layout Quotation
4351 \begin_inset space \hfill{}
4357 \begin_layout Quotation
4359 \begin_inset space \hfill{}
4365 \begin_layout Quotation
4367 \begin_inset space \hfill{}
4373 \begin_layout Quotation
4375 \begin_inset space \hfill{}
4381 \begin_layout Quotation
4383 \begin_inset space \hfill{}
4389 \begin_layout Quotation
4391 \begin_inset space \hfill{}
4398 \begin_layout Plain Layout
4410 \begin_layout Quotation
4412 \begin_inset space \hfill{}
4418 \begin_layout Quotation
4420 \begin_inset space \hfill{}
4427 \begin_layout Plain Layout
4439 \begin_layout Quotation
4441 \begin_inset space \hfill{}
4447 \begin_layout Quotation
4449 \begin_inset space \hfill{}
4455 \begin_layout Quotation
4457 \begin_inset space \hfill{}
4464 \begin_layout Plain Layout
4476 \begin_layout Quotation
4478 \begin_inset space \hfill{}
4485 \begin_layout Plain Layout
4497 \begin_layout Quotation
4499 \begin_inset space \hfill{}
4505 \begin_layout Quotation
4506 hungarian umlaut (hug)
4507 \begin_inset space \hfill{}
4513 \begin_layout Quotation
4515 \begin_inset space \hfill{}
4521 \begin_layout Quotation
4523 \begin_inset space \hfill{}
4530 \begin_layout Plain Layout
4542 \begin_layout Standard
4543 Since in many international keyboards there are exceptions to what some dead keys should do,
4544 you can define them using
4547 \begin_layout Quotation
4548 \begin_inset Flex Code
4551 \begin_layout Plain Layout
4559 deadkey key outstring
4562 \begin_layout Standard
4565 if you enter caron-o,
4566 it generates circumflex-o,
4570 \begin_layout Quotation
4571 \begin_inset Flex Code
4574 \begin_layout Plain Layout
4587 \begin_layout Standard
4588 to make it work correctly.
4590 you have to define as exceptions dead keys over i and j,
4591 to remove the dot from them before inserting an accent mark.
4592 I will change this when the time comes,
4593 but so far I haven't had time.
4596 \begin_layout Standard
4598 and about characters:
4599 backslash is escaped,
4601 you'll need double backslash.
4604 \begin_inset Flex Code
4607 \begin_layout Plain Layout
4613 have different meaning.
4615 \begin_inset Flex Code
4618 \begin_layout Plain Layout
4625 quotes start and end \SpecialChar LaTeX
4629 \begin_inset Flex Code
4632 \begin_layout Plain Layout
4642 \begin_inset Flex Code
4645 \begin_layout Plain Layout
4653 \begin_inset Flex Code
4656 \begin_layout Plain Layout
4667 \begin_layout Standard
4668 If you make a keyboard description file that works for your language,
4669 please mail it to me,
4670 so I can include it in the next keymap distribution.
4673 \begin_layout Standard
4674 More keywords will be supported in keymap configuration file in future,
4678 \begin_layout Itemize
4679 \begin_inset Flex Code
4682 \begin_layout Plain Layout
4693 \begin_inset space \hfill{}
4697 \begin_inset Flex Code
4700 \begin_layout Plain Layout
4709 \begin_layout Itemize
4710 \begin_inset Flex Code
4713 \begin_layout Plain Layout
4724 \begin_inset space \hfill{}
4728 \begin_inset Flex Code
4731 \begin_layout Plain Layout
4737 an external keymap translation program
4740 \begin_layout Standard
4743 \begin_inset Flex Code
4746 \begin_layout Plain Layout
4755 \begin_inset Flex Code
4758 \begin_layout Plain Layout
4766 option to include default keyboard).
4774 \begin_layout Section
4775 International Keymap Stuff
4776 \begin_inset CommandInset label
4778 name "sec:International-Keymap-Stuff"
4785 \begin_layout Standard
4786 \begin_inset Note Note
4789 \begin_layout Plain Layout
4790 In doing the revisions on this document in March 2008,
4791 I did not look over this stuff,
4792 as I do not understand it.
4793 It would be good if someone else could do so.
4802 \begin_layout Standard
4803 The next two sections describe the
4804 \begin_inset Flex Code
4807 \begin_layout Plain Layout
4816 \begin_inset Flex Code
4819 \begin_layout Plain Layout
4827 file syntax in detail.
4828 These sections should help you design your own key map if the ones provided do not meet your needs.
4831 \begin_layout Subsection
4835 \begin_layout Standard
4839 \begin_inset Flex Code
4842 \begin_layout Plain Layout
4848 file maps keystrokes to characters or strings.
4849 As the name suggests,
4850 it sets a keyboard mapping.
4852 \begin_inset Flex Code
4855 \begin_layout Plain Layout
4866 \begin_inset Flex Code
4869 \begin_layout Plain Layout
4885 \begin_inset Flex Code
4888 \begin_layout Plain Layout
4902 \begin_inset Flex Code
4905 \begin_layout Plain Layout
4915 \begin_inset Flex Code
4918 \begin_layout Plain Layout
4926 are described in this section.
4929 \begin_layout Labeling
4930 \labelwidthstring 00.00.0000
4931 \begin_inset Flex Code
4934 \begin_layout Plain Layout
4942 Map a character to a string
4945 \begin_layout LyX-Code
4960 \begin_layout Standard
4994 the double-quote (")
5011 must be escaped with a preceding backslash (
5022 \begin_layout Standard
5024 \begin_inset Flex Noun
5027 \begin_layout Plain Layout
5035 statement to cause the symbol
5036 \begin_inset Flex Noun
5039 \begin_layout Plain Layout
5047 to be output for the keystroke
5048 \begin_inset Flex Noun
5051 \begin_layout Plain Layout
5062 \begin_layout LyX-Code
5068 \begin_layout Labeling
5069 \labelwidthstring 00.00.0000
5070 \begin_inset Flex Code
5073 \begin_layout Plain Layout
5081 Specify an accent character
5084 \begin_layout LyX-Code
5093 \begin_layout Standard
5094 This will make the cha
5132 This is the dead key
5136 \begin_layout Plain Layout
5143 refers to a key that does not produce a character by itself,
5144 but when followed with another key,
5145 produces the desired accent character.
5149 r with an umlaut like
5159 can be produced in this manner.
5168 \begin_layout Standard
5181 and then another key not in
5199 followed by the other,
5205 \begin_inset Flex Noun
5208 \begin_layout Plain Layout
5228 \begin_inset Flex Noun
5231 \begin_layout Plain Layout
5241 the cursor will not go one position backwards but will instead cancel the effect t
5256 might have had on the next keystroke.
5260 \begin_layout Standard
5261 The following example specifies that the character ' is to be an acute accent,
5262 allowed on the characters a,
5274 \begin_layout LyX-Code
5277 kmod ' acute aeiouAEIOU
5280 \begin_layout Labeling
5281 \labelwidthstring 00.00.0000
5282 \begin_inset Flex Code
5285 \begin_layout Plain Layout
5291 Specify an exception to the accent character
5294 \begin_layout LyX-Code
5303 \begin_layout Standard
5304 This defines an exce
5345 have been assigned a keystroke with a previous
5348 \begin_inset Flex Code
5351 \begin_layout Plain Layout
5375 must not belong in the
5423 If such a declaration does not exist in
5431 \begin_inset Flex Code
5434 \begin_layout Plain Layout
5469 \begin_inset Flex Code
5472 \begin_layout Plain Layout
5486 \begin_layout Standard
5487 The following command produces causes äi to be produced when you enter acute-i ('i):
5490 \begin_layout LyX-Code
5504 \begin_layout Labeling
5505 \labelwidthstring 00.00.0000
5506 \begin_inset Flex Code
5509 \begin_layout Plain Layout
5515 Combine two accent characters
5518 \begin_layout LyX-Code
5524 accent1 accent2 allowed
5527 \begin_layout Standard
5528 This one is getting pretty esoteric.
5529 It allows you to combine the effect
5585 \begin_inset Flex Code
5588 \begin_layout Plain Layout
5616 \begin_layout Standard
5617 Consider this example from the
5618 \begin_inset Flex Code
5621 \begin_layout Plain Layout
5632 \begin_layout LyX-Code
5636 acute aeioyvhAEIOYVH
5641 kcomb acute umlaut iyIY
5644 \begin_layout Standard
5645 This allows you to press
5646 \begin_inset Flex Noun
5649 \begin_layout Plain Layout
5657 and get the effect of
5658 \begin_inset Flex Code
5661 \begin_layout Plain Layout
5680 in this case cancels the last dead key,
5682 \begin_inset Flex Noun
5685 \begin_layout Plain Layout
5695 \begin_inset Flex Code
5698 \begin_layout Plain Layout
5711 \begin_layout Subsection
5715 \begin_layout Standard
5717 \begin_inset Flex Code
5720 \begin_layout Plain Layout
5728 mapping is performed,
5730 \begin_inset Flex Code
5733 \begin_layout Plain Layout
5743 file maps the strings that the symbols generate to characters in the current font.
5744 The \SpecialChar LyX
5745 distribution currently includes at least the
5746 \begin_inset Flex Code
5749 \begin_layout Plain Layout
5758 \begin_inset Flex Code
5761 \begin_layout Plain Layout
5772 \begin_layout Standard
5774 \begin_inset Flex Code
5777 \begin_layout Plain Layout
5785 file is a sequence of declarations of the form
5788 \begin_layout LyX-Code
5801 \begin_layout Standard
5804 \begin_inset Flex Noun
5807 \begin_layout Plain Layout
5817 to the corresponding character in the iso-8859-1 set (233),
5818 the following declaration is used
5821 \begin_layout LyX-Code
5829 \begin_layout Standard
5831 \begin_inset Flex Code
5834 \begin_layout Plain Layout
5843 \begin_inset Flex Code
5846 \begin_layout Plain Layout
5864 the same character can apply to more than one string.
5866 \begin_inset Flex Code
5869 \begin_layout Plain Layout
5880 \begin_layout LyX-Code
5892 \begin_inset Newline newline
5908 \begin_layout Standard
5910 cannot find a mapping for the string produced by the keystroke or a deadkey sequence,
5911 it will check if it looks like an accented char and try to draw an accent over the character on screen.
5914 \begin_layout Subsection
5918 \begin_layout Standard
5919 There is a second way to add support for international characters through so-called dead-keys.
5920 A dead-key works in combination with a letter to produce an accented character.
5922 we'll explain how to create a really simple dead-key to illustrate how they work.
5925 \begin_layout Standard
5926 Suppose you happen to need the circumflex character,
5928 \begin_inset Quotes eld
5932 \begin_inset Quotes erd
5937 \begin_inset Flex Noun
5940 \begin_layout Plain Layout
5947 \begin_inset space ~
5951 \begin_inset Flex Noun
5954 \begin_layout Plain Layout
5960 ] to the \SpecialChar LyX
5962 \begin_inset Flex Code
5965 \begin_layout Plain Layout
5972 \begin_inset Flex Code
5975 \begin_layout Plain Layout
5983 whenever you type the
5984 \begin_inset Flex Noun
5987 \begin_layout Plain Layout
5993 -key followed by a letter,
5994 that letter will have a circumflex accent on it.
5997 \begin_inset Quotes eld
6001 \begin_inset Flex Noun
6004 \begin_layout Plain Layout
6011 \begin_inset Quotes erd
6014 produces the letter:
6016 \begin_inset Quotes eld
6020 \begin_inset Quotes erd
6024 If you tried to type
6025 \begin_inset Quotes eld
6029 \begin_inset Flex Noun
6032 \begin_layout Plain Layout
6039 \begin_inset Quotes erd
6045 will complain with a beep,
6047 \begin_inset Quotes eld
6051 \begin_inset Flex Noun
6054 \begin_layout Plain Layout
6061 \begin_inset Quotes erd
6064 never takes a circumflex accent.
6066 \begin_inset Flex Noun
6069 \begin_layout Plain Layout
6075 after a dead-key produces the bare-accent.
6076 Please note this last point!
6077 If you bind a key to a dead-key,
6078 you'll need to rebind the character on that key to yet another key.
6080 \begin_inset Flex Noun
6083 \begin_layout Plain Layout
6089 to a cedilla is a bad idea,
6090 since you'll only get cedillas instead of commas.
6093 \begin_layout Standard
6094 One common way to bind dead-keys is to use
6095 \begin_inset Flex Noun
6098 \begin_layout Plain Layout
6106 \begin_inset Flex Noun
6109 \begin_layout Plain Layout
6117 \begin_inset Flex Noun
6120 \begin_layout Plain Layout
6126 in combination with an accent,
6128 \begin_inset Quotes eld
6132 \begin_inset Flex Noun
6135 \begin_layout Plain Layout
6142 \begin_inset Quotes erd
6146 \begin_inset Quotes eld
6150 \begin_inset Flex Noun
6153 \begin_layout Plain Layout
6160 \begin_inset Quotes erd
6164 \begin_inset Quotes eld
6168 \begin_inset Flex Noun
6171 \begin_layout Plain Layout
6178 \begin_inset Quotes erd
6182 Another way involves using
6183 \begin_inset Flex Code
6186 \begin_layout Plain Layout
6193 \begin_inset Flex Code
6196 \begin_layout Plain Layout
6202 to set up the special
6203 \begin_inset Flex Code
6206 \begin_layout Plain Layout
6214 \begin_inset Flex Code
6217 \begin_layout Plain Layout
6223 acts in some ways just like
6224 \begin_inset Flex Noun
6227 \begin_layout Plain Layout
6233 and permits you to bind keys to accented characters.
6234 You can also turn keys into dead-keys by binding them to something like
6235 \begin_inset Flex Code
6238 \begin_layout Plain Layout
6244 and then binding this symbolic key to the corresponding \SpecialChar LyX
6249 \begin_layout Plain Layout
6255 This is exactly what I do in my
6256 \begin_inset Flex Code
6259 \begin_layout Plain Layout
6266 \begin_inset Flex Code
6269 \begin_layout Plain Layout
6277 \begin_inset Flex Noun
6280 \begin_layout Plain Layout
6282 \begin_inset space ~
6291 \begin_inset Flex Code
6294 \begin_layout Plain Layout
6300 and a bunch of these
6301 \begin_inset Quotes eld
6305 \begin_inset Flex Code
6308 \begin_layout Plain Layout
6315 \begin_inset Quotes erd
6318 symbolic keys bound such things as
6319 \begin_inset Flex Noun
6322 \begin_layout Plain Layout
6324 \begin_inset space ~
6333 \begin_inset Flex Noun
6336 \begin_layout Plain Layout
6338 \begin_inset space ~
6347 This is how I produce my accented characters.
6352 You can make just about anything into the
6353 \begin_inset Flex Code
6356 \begin_layout Plain Layout
6364 \begin_inset Flex Noun
6367 \begin_layout Plain Layout
6374 a spare function key,
6376 As for the \SpecialChar LyX
6377 commands that produce accents,
6379 \begin_inset Flex Code
6382 \begin_layout Plain Layout
6393 You'll find the complete list there.
6396 \begin_layout Subsection
6397 Saving your Language Configuration
6400 \begin_layout Standard
6401 You can edit your preferences so that your desired language environment is automatically configured when \SpecialChar LyX
6404 \begin_inset Flex Noun
6407 \begin_layout Plain Layout
6408 Edit\SpecialChar menuseparator
6417 \begin_layout Chapter
6419 \change_inserted -584632292 1610232084
6422 Installing New Document Classes,
6425 \begin_inset CommandInset label
6427 name "cha:Installing-New-Document"
6432 \begin_inset Argument 1
6435 \begin_layout Plain Layout
6436 Installing New Document Classes
6444 \begin_layout Standard
6446 we describe the procedures for creating and installing new \SpecialChar LyX
6447 layout and template files,
6448 as well as offer a refresher on correctly installing new \SpecialChar LaTeX
6453 \begin_layout Standard
6455 let us a say a few words about how one ought to think about the relation between \SpecialChar LyX
6456 and \SpecialChar LaTeX
6458 The thing to understand is that,
6461 doesn't know anything about \SpecialChar LaTeX
6464 from \SpecialChar LyX
6467 is just one of several
6468 \begin_inset Quotes eld
6472 \begin_inset Quotes erd
6475 in which it is capable of producing output.
6476 Other such formats are DocBook,
6482 a particularly important format,
6483 but very little of the information \SpecialChar LyX
6484 has about \SpecialChar LaTeX
6485 is actually contained in the program itself.
6489 \begin_layout Plain Layout
6490 Some commands are sufficiently complex that they are
6491 \begin_inset Quotes eld
6495 \begin_inset Quotes erd
6498 into \SpecialChar LyX
6500 But the developers generally regard this as a Bad Thing.
6507 even for the standard classes like
6508 \begin_inset Flex Code
6511 \begin_layout Plain Layout
6518 is contained in `layout files'.
6521 itself does not know much about DocBook or XHTML.
6522 What it knows is contained in layout files.
6525 \begin_layout Standard
6526 You can think of the layout file for a given document class as a translation manual between \SpecialChar LyX
6528 paragraphs with their corresponding styles,
6529 certain sorts of insets,
6531 and the corresponding \SpecialChar LaTeX
6534 or XHTML constructs.
6535 Almost everything \SpecialChar LyX
6537 \begin_inset Flex Code
6540 \begin_layout Plain Layout
6548 is contained in the file
6549 \begin_inset Flex Code
6552 \begin_layout Plain Layout
6558 and in various other files it includes.
6560 anyone intending to write layout files should plan to study the existing files.
6561 A good place to start is with
6562 \begin_inset Flex Code
6565 \begin_layout Plain Layout
6572 which is included in
6573 \begin_inset Flex Code
6576 \begin_layout Plain Layout
6584 \begin_inset Flex Code
6587 \begin_layout Plain Layout
6594 and many of the other layout files for document classes.
6595 This file is where sections and the like are defined:
6597 \begin_inset Flex Code
6600 \begin_layout Plain Layout
6606 tells \SpecialChar LyX
6607 how paragraphs that are marked with the Section,
6610 styles can be translated into corresponding \SpecialChar LaTeX
6613 and XHTML commands and tags.
6615 \begin_inset Flex Code
6618 \begin_layout Plain Layout
6624 file basically just includes several of these
6625 \begin_inset Flex Code
6628 \begin_layout Plain Layout
6637 \begin_layout Standard
6638 Defining the \SpecialChar LyX
6640 correspondence is not the only thing layout files do,
6642 Their other job is to define how the \SpecialChar LyX
6643 constructs themselves will appear on-screen.
6644 The fact that layout files have these two jobs is often a source of confusion,
6645 because they are completely separate.
6646 Telling \SpecialChar LyX
6647 how to translate a certain paragraph style into \SpecialChar LaTeX
6648 does not tell \SpecialChar LyX
6651 telling \SpecialChar LyX
6652 how to display a certain paragraph style does not tell \SpecialChar LyX
6653 how to translate it into \SpecialChar LaTeX
6654 (let alone tell \SpecialChar LaTeX
6658 when you define a new \SpecialChar LyX
6660 you must always do two quite separate things:
6662 \begin_inset space ~
6665 tell \SpecialChar LyX
6666 how to translate it into \SpecialChar LaTeX
6668 \begin_inset space ~
6671 tell \SpecialChar LyX
6675 \begin_layout Standard
6676 Much the same is true,
6678 as regards \SpecialChar LyX
6679 's other backend formats,
6680 though XHTML is in some ways different,
6681 because in that case \SpecialChar LyX
6688 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.
6691 the distinction between what \SpecialChar LyX
6692 does internally and how things are rendered externally remains in force,
6693 and the two can be controlled separately.
6695 \begin_inset CommandInset ref
6697 reference "sec:Tags-for-XHTML"
6705 \begin_layout Section
6706 Installing new \SpecialChar LaTeX
6710 \begin_layout Standard
6711 Some installations may not include a \SpecialChar LaTeX
6712 package or class file that you would like to use within \SpecialChar LyX
6715 you might need Foil\SpecialChar TeX
6717 a package for preparing slides for overhead projectors.
6718 Modern \SpecialChar LaTeX
6719 distributions like \SpecialChar TeX
6720 Live (2008 or newer) or MiK\SpecialChar TeX
6721 provide a user interface for installing such packages.
6723 with MiK\SpecialChar TeX
6725 you start the program
6726 \begin_inset Quotes eld
6730 \begin_inset space ~
6734 \begin_inset Quotes erd
6737 to get a list of available packages.
6738 To install one of them,
6739 right click on it or use the corresponding toolbar button.
6742 \begin_layout Standard
6743 If your \SpecialChar LaTeX
6744 distribution does not provide such a `package manager',
6745 or if the package is not available from your distribution,
6746 then follow these steps to install it manually:
6749 \begin_layout Enumerate
6750 Get the package from
6751 \begin_inset CommandInset href
6754 target "http://www.ctan.org/"
6762 \begin_layout Enumerate
6763 If the package contains a file with the ending
6764 \begin_inset Quotes eld
6768 \begin_inset Flex Code
6771 \begin_layout Plain Layout
6778 \begin_inset Quotes erd
6781 (is the case for Foil\SpecialChar TeX
6782 ) then open a console,
6783 change to the folder of this file and execute the command
6784 \begin_inset Flex Code
6787 \begin_layout Plain Layout
6794 You have now unpacked the package and have all files to install it.
6795 Most \SpecialChar LaTeX
6796 -packages are not packed and you can skip this step.
6799 \begin_layout Enumerate
6800 Now you need to decide if the package should be available for all users or only for you.
6804 \begin_layout Enumerate
6805 On *nix systems (Linux,
6808 if you want the new package to be available for all users on your system,
6809 then install it in your `local' \SpecialChar TeX
6811 otherwise install it in your own `user' \SpecialChar TeX
6813 Where these trees should be created,
6814 if they do not already exist,
6815 depends on your system.
6818 \begin_inset Flex Code
6821 \begin_layout Plain Layout
6831 \begin_layout Plain Layout
6832 This is usually in the directory
6833 \begin_inset Flex Code
6836 \begin_layout Plain Layout
6843 though you can execute the command
6844 \begin_inset Flex Code
6847 \begin_layout Plain Layout
6858 The location of the `local' \SpecialChar TeX
6859 tree is defined by the
6860 \begin_inset Flex Code
6863 \begin_layout Plain Layout
6870 this is usually somewhere like
6871 \begin_inset Flex Code
6874 \begin_layout Plain Layout
6875 /usr/local/share/texmf
6880 or /usr/local/texlive/XXXX where XXXX is the year of the installed \SpecialChar TeX
6882 The location of the `user' \SpecialChar TeX
6884 \begin_inset Flex Code
6887 \begin_layout Plain Layout
6894 \begin_inset Flex Code
6897 \begin_layout Plain Layout
6904 \begin_inset Flex Code
6907 \begin_layout Plain Layout
6916 (If these variables are not predefined,
6917 you have to define them.) You'll probably need root permissions to create or modify the `local' tree,
6918 but not for your `user' tree.
6919 \begin_inset Newline newline
6923 it is recommended to install in the user tree because your user will not be modified or even overwritten when you upgrade your system.
6924 It will typically also be backed up together with everything else when you backup your home directory (which,
6926 you do on a regular basis).
6929 \begin_layout Enumerate
6931 if you want the new package to be available for all users on your system,
6932 change to the folder where \SpecialChar LaTeX
6933 is installed and then change to the subfolder
6934 \begin_inset Flex Code
6937 \begin_layout Plain Layout
6948 (For MiK\SpecialChar TeX
6950 this would be by default the folder
6951 \begin_inset Flex Code
6954 \begin_layout Plain Layout
6972 \begin_layout Plain Layout
6973 Note that this will be the correct path only on English installations.
6976 \begin_inset Flex Code
6979 \begin_layout Plain Layout
6994 and similarly for other languages.
6999 Create there a new folder
7000 \begin_inset Flex Code
7003 \begin_layout Plain Layout
7009 and copy all files of the package into it.
7011 \begin_inset Newline newline
7014 If the package should only available for you or you don't have admin permissions,
7016 but in the local \SpecialChar LaTeX
7019 \begin_inset space \thinspace{}
7023 for MiK\SpecialChar TeX
7025 \begin_inset space ~
7028 2.8 under Windows XP,
7029 this would be the folder:
7030 \begin_inset Newline newline
7036 \begin_inset Flex Code
7039 \begin_layout Plain Layout
7042 Documents and Settings
7054 \begin_inset Newline newline
7060 \begin_inset Phantom HPhantom
7063 \begin_layout Plain Layout
7074 \begin_inset Flex Code
7077 \begin_layout Plain Layout
7090 \begin_inset Newline newline
7095 \begin_inset Newline newline
7099 \begin_inset Flex Code
7102 \begin_layout Plain Layout
7128 \begin_layout Enumerate
7129 Now one only need to tell \SpecialChar LaTeX
7130 that there are new files.
7131 This depends on the used \SpecialChar LaTeX
7136 \begin_layout Enumerate
7137 For \SpecialChar TeX
7138 Live execute the command
7139 \begin_inset Flex Code
7142 \begin_layout Plain Layout
7149 If you installed the package for all users,
7150 then you will probably need to have root permissions for that.
7153 \begin_layout Enumerate
7154 For MiK\SpecialChar TeX
7156 if you have installed the package for all users,
7158 \begin_inset Quotes eld
7162 \begin_inset space ~
7166 \begin_inset Quotes erd
7169 and press the button marked
7170 \begin_inset Quotes eld
7174 \begin_inset Quotes erd
7178 Otherwise start the program
7179 \begin_inset Quotes eld
7183 \begin_inset Quotes erd
7190 \begin_layout Enumerate
7192 you need to tell \SpecialChar LyX
7193 that there are new packages available.
7198 \begin_inset Flex Noun
7201 \begin_layout Plain Layout
7204 \SpecialChar menuseparator
7210 and then restart \SpecialChar LyX
7214 \begin_layout Standard
7215 Now the package is installed.
7218 \begin_inset Flex Code
7221 \begin_layout Plain Layout
7227 will now be available under
7228 \begin_inset Flex Noun
7231 \begin_layout Plain Layout
7232 Document\SpecialChar menuseparator
7233 Settings\SpecialChar menuseparator
7240 \begin_inset Quotes eld
7244 \begin_inset Quotes erd
7251 \begin_layout Standard
7252 If you would like to use a \SpecialChar LaTeX
7253 document class that is not even listed in the menu
7254 \begin_inset Flex Noun
7257 \begin_layout Plain Layout
7258 Document\SpecialChar menuseparator
7259 Settings\SpecialChar menuseparator
7266 then you need to create a `layout' file for it.
7267 That is the topic of the next section.
7270 \begin_layout Section
7271 Types of layout files
7274 \begin_layout Standard
7275 This section describes the various sorts of \SpecialChar LyX
7276 files that contain layout information.
7277 These files describe various paragraph and character styles,
7278 determining how \SpecialChar LyX
7279 should display them and how they should be translated into \SpecialChar LaTeX
7283 or whatever output format is being used.
7287 \begin_layout Standard
7288 We shall try to provide a thorough description of the process of writing layout files here.
7290 there are so many different types of documents supported even by just \SpecialChar LaTeX
7291 that we can't hope to cover every different possibility or problem you might encounter.
7292 The \SpecialChar LyX
7293 users' list is frequented by people with lots of experience with layout design who are willing to share what they've learned,
7294 so please feel free to ask questions there.
7297 \begin_layout Standard
7298 As you prepare to write a new layout,
7299 it is extremely helpful to look at the layouts distributed with \SpecialChar LyX
7301 If you write a \SpecialChar LyX
7302 layout for a \SpecialChar LaTeX
7303 document class that might also be used by others,
7304 or write a module that might be useful to others,
7305 then you should consider posting your layout to the
7306 \begin_inset CommandInset href
7308 name "layout section on the LyX wiki"
7309 target "https://wiki.lyx.org/Layouts/Layouts"
7314 or even to the \SpecialChar LyX
7316 so that it might be included in \SpecialChar LyX
7321 \begin_layout Plain Layout
7322 Note that \SpecialChar LyX
7323 is licensed under the General Public License,
7324 so any material that is contributed to \SpecialChar LyX
7325 must be similarly licensed.
7333 \begin_layout Subsection
7335 \begin_inset CommandInset label
7337 name "subsec:Layout-modules"
7344 \begin_layout Standard
7345 We have spoken to this point about `layout files'.
7346 But there are different sorts of files that contain layout information.
7350 \begin_inset Flex Code
7353 \begin_layout Plain Layout
7359 extension and provide \SpecialChar LyX
7360 with information about document classes.
7361 Since \SpecialChar LyX
7362 1.6 layout information can also be contained in layout
7368 \begin_inset Flex Code
7371 \begin_layout Plain Layout
7378 Modules are to \SpecialChar LaTeX
7379 packages much as layouts are to \SpecialChar LaTeX
7383 \begin_inset Flex Code
7386 \begin_layout Plain Layout
7393 specifically provide support for one package.
7395 layout modules are similar to included
7399 \begin_layout Plain Layout
7400 These can have any extension,
7401 but by convention have the
7402 \begin_inset Flex Code
7405 \begin_layout Plain Layout
7418 \begin_inset Flex Code
7421 \begin_layout Plain Layout
7428 in that modules are not specific to a given document class but may be used with many different classes.
7429 The difference is that using an included file with
7430 \begin_inset Flex Code
7433 \begin_layout Plain Layout
7439 requires editing that file.
7443 \begin_inset Flex Noun
7446 \begin_layout Plain Layout
7447 Document\SpecialChar menuseparator
7456 \begin_layout Standard
7457 Building modules is the easiest way to get started with layout editing,
7458 since it can be as simple as adding a single new paragraph style or flex inset.
7461 contain anything a layout file can contain.
7464 \begin_layout Standard
7465 After creating a new module and copying it to the
7466 \begin_inset Flex Code
7469 \begin_layout Plain Layout
7476 you will need to reconfigure and then restart \SpecialChar LyX
7477 for the module to appear in the menu.
7479 changes you make to the module will be seen immediately,
7481 \begin_inset Flex Noun
7484 \begin_layout Plain Layout
7485 Document\SpecialChar menuseparator
7492 highlight something,
7494 \begin_inset Quotes eld
7498 \begin_inset Quotes erd
7504 It is strongly recommended that you save your work before doing this
7510 it is strongly recommended that you not attempt to edit modules while simultaneously working on actual documents
7513 Though of course the developers strive to keep \SpecialChar LyX
7514 stable in such situations,
7515 syntax errors and the like in your module file could cause strange behavior.
7518 \begin_layout Subsubsection
7522 \begin_layout Standard
7523 Modules are to \SpecialChar LyX
7524 as packages are to \SpecialChar LaTeX
7528 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.
7529 What you need is \SpecialChar LyX
7531 \begin_inset Quotes eld
7535 \begin_inset Quotes erd
7541 \begin_layout Standard
7542 You will find it under
7544 Document\SpecialChar menuseparator
7545 Settings\SpecialChar menuseparator
7549 The large text box allows you to enter anything that you might enter in a layout file or module.
7550 You can think of a document's local layout,
7552 as a module that belongs just to it.
7556 \begin_inset Flex Code
7559 \begin_layout Plain Layout
7566 Any format is acceptable,
7567 but one would normally use the format current at the time.
7568 (In \SpecialChar LyX
7576 the current layout format is
7585 \begin_layout Standard
7586 When you have entered something in the
7587 \begin_inset Flex Code
7590 \begin_layout Plain Layout
7599 \begin_inset Quotes eld
7603 \begin_inset Quotes erd
7606 button at the bottom.
7607 Clicking this button will cause \SpecialChar LyX
7608 to determine whether what you have entered is valid layout information for the chosen format.
7610 will report the result but,
7612 will not tell you what errors there might have been.
7613 These will be written to the terminal,
7616 is started from a terminal.
7617 You will not be permitted to save your local layout until you have entered something valid.
7620 \begin_layout Standard
7621 The warnings at the end of the previous section apply here,
7623 Do not play with local layout while you are actually working,
7624 especially if you have not saved your document.
7626 using local layout with a test document can be a very convenient way to try out layout ideas,
7627 or even to start developing a module.
7630 \begin_layout Subsection
7632 \begin_inset Flex Noun
7635 \begin_layout Plain Layout
7644 \begin_layout Standard
7645 There are two situations you are likely to encounter when wanting to support a new \SpecialChar LaTeX
7648 \begin_inset Flex Code
7651 \begin_layout Plain Layout
7657 ) files and \SpecialChar LaTeX2e
7659 \begin_inset Flex Code
7662 \begin_layout Plain Layout
7669 Supporting a style file is usually fairly easy.
7670 Supporting a new class file is a bit harder.
7671 We'll discuss the former in this section and the latter in the next.
7673 \change_deleted 5863208 1594239023
7674 Similar remarks apply,
7676 if you want to support a new DocBook DTD.
7681 \begin_layout Standard
7682 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.
7683 For the sake of the example,
7684 we'll assume that the style file is called
7685 \begin_inset Flex Noun
7688 \begin_layout Plain Layout
7694 and that it is meant to be used with
7695 \begin_inset Flex Noun
7698 \begin_layout Plain Layout
7705 which is a standard class.
7709 \begin_layout Standard
7710 Start by copying the existing class's layout file into your local directory:
7714 \begin_layout Plain Layout
7716 which directory is your local directory will vary by platform,
7717 and \SpecialChar LyX
7718 allows you to specify your local directory on startup,
7721 \begin_inset Flex Code
7724 \begin_layout Plain Layout
7738 \begin_layout LyX-Code
7739 cp report.layout ~/.lyx/layouts/myclass.layout
7742 \begin_layout Standard
7744 \begin_inset Flex Code
7747 \begin_layout Plain Layout
7753 and change the line:
7757 \begin_layout LyX-Code
7760 DeclareLaTeXClass{Report (Standard Class)}
7763 \begin_layout Standard
7767 \begin_layout LyX-Code
7770 DeclareLaTeXClass[report,
7771 myclass.sty]{Report (My Class)}
7774 \begin_layout Standard
7778 \begin_layout LyX-Code
7780 \begin_inset Newline newline
7786 \begin_inset Newline newline
7792 \begin_layout Standard
7793 near the top of the file.
7796 \begin_layout Standard
7797 Start \SpecialChar LyX
7799 \begin_inset Flex Noun
7802 \begin_layout Plain Layout
7803 Tools\SpecialChar menuseparator
7810 Then restart \SpecialChar LyX
7811 and try creating a new document.
7813 \begin_inset Flex Noun
7816 \begin_layout Plain Layout
7822 " as a document class option in the
7823 \begin_inset Flex Noun
7826 \begin_layout Plain Layout
7827 Document\SpecialChar menuseparator
7834 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—
7836 \begin_inset Flex Code
7839 \begin_layout Plain Layout
7846 so you can fiddle around with the settings for the different sections if you wish.
7847 The layout information for sections is contained in
7848 \begin_inset Flex Code
7851 \begin_layout Plain Layout
7858 but you do not need to copy and change this file.
7860 you can simply add your changes to your layout file,
7862 \begin_inset Flex Code
7865 \begin_layout Plain Layout
7872 which itself includes
7873 \begin_inset Flex Code
7876 \begin_layout Plain Layout
7884 you might add these lines:
7887 \begin_layout LyX-Code
7891 \begin_layout LyX-Code
7895 \begin_layout LyX-Code
7899 \begin_layout LyX-Code
7903 \begin_layout LyX-Code
7907 \begin_layout Standard
7908 to change the font for chapter headings to sans-serif.
7909 This will override (or,
7911 add to) the existing declaration for the Chapter style.
7915 \begin_layout Standard
7916 Your new package may also provide commands or environments not present in the base class.
7918 you will want to add these to the layout file.
7920 \begin_inset CommandInset ref
7922 reference "sec:TextClass"
7927 for information on how to do so.
7930 \begin_layout Standard
7932 \begin_inset Flex Noun
7935 \begin_layout Plain Layout
7941 can be used with several different document classes,
7942 and even if it cannot,
7943 you might find it easiest just to write a module that you can load with the base class.
7944 The simplest possible such module would be:
7947 \begin_layout LyX-Code
7950 DeclareLyXModule{My Class}
7953 \begin_layout LyX-Code
7957 \begin_layout LyX-Code
7958 #Support for myclass.sty.
7961 \begin_layout LyX-Code
7963 \begin_inset Newline newline
7969 \begin_layout LyX-Code
7977 \begin_inset Newline newline
7983 \begin_layout LyX-Code
7985 \begin_inset Newline newline
7991 \begin_inset Newline newline
7997 \begin_layout Standard
7998 A more complex module might modify the behavior of some existing constructs or define some new ones.
8001 \begin_inset CommandInset ref
8003 reference "sec:TextClass"
8011 \begin_layout Subsection
8013 \begin_inset Flex Noun
8016 \begin_layout Plain Layout
8025 \begin_layout Standard
8026 There are two possibilities here.
8027 One is that the class file is itself based upon an existing document class.
8029 many thesis classes are based upon
8030 \begin_inset Flex Noun
8033 \begin_layout Plain Layout
8040 To see whether yours is,
8041 look for a line like
8044 \begin_layout LyX-Code
8050 \begin_layout Standard
8053 then you may proceed largely as in the previous section,
8055 \begin_inset Flex Code
8058 \begin_layout Plain Layout
8059 Declare\SpecialChar LaTeX
8065 line will be different.
8066 If your new class is
8067 \begin_inset Flex Code
8070 \begin_layout Plain Layout
8076 and it is based upon
8077 \begin_inset Flex Code
8080 \begin_layout Plain Layout
8087 then the line should read:
8091 \begin_layout Plain Layout
8092 And it will be easiest if you save the file to
8093 \begin_inset Flex Code
8096 \begin_layout Plain Layout
8104 assumes that the document class has the same name as the layout file.
8113 \begin_layout LyX-Code
8116 DeclareLaTeXClass[thesis,book]{thesis}
8119 \begin_layout Standard
8122 the new class is not based upon an existing class,
8123 you will probably have to
8124 \begin_inset Quotes eld
8128 \begin_inset Quotes erd
8132 We strongly suggest copying an existing layout file which uses a similar \SpecialChar LaTeX
8133 class and then modifying it,
8135 At least use an existing file as a starting point so you can find out what items you need to worry about.
8137 the specifics are covered below.
8140 \begin_layout Subsection
8142 \begin_inset CommandInset label
8144 name "subsec:Creating-Templates"
8151 \begin_layout Standard
8152 Once you have written a layout file for a new document class,
8153 you might want to consider writing a
8159 A template acts as a kind of tutorial for your layout,
8160 showing how it might be used,
8161 though containing dummy content.
8162 You can of course look at the various templates included with \SpecialChar LyX
8166 \begin_layout Standard
8167 Templates are created just like usual documents:
8168 using \SpecialChar LyX
8170 The only difference is that usual documents contain all possible settings,
8171 including the font scheme and the paper size.
8172 Usually a user doesn't want a template to overwrite his preferred settings for such parameters.
8174 the designer of a template should remove the corresponding commands like
8175 \begin_inset Flex Code
8178 \begin_layout Plain Layout
8187 \begin_inset Flex Code
8190 \begin_layout Plain Layout
8198 from the template \SpecialChar LyX
8200 This can be done with any simple text-editor,
8202 \begin_inset Flex Code
8205 \begin_layout Plain Layout
8212 \begin_inset Flex Code
8215 \begin_layout Plain Layout
8224 \begin_layout Standard
8225 Put the edited template files you create in
8226 \begin_inset Flex Code
8229 \begin_layout Plain Layout
8236 copy the ones you use from the global template directory in
8237 \begin_inset Flex Code
8240 \begin_layout Plain Layout
8247 and redefine the template path in the
8248 \begin_inset Flex Noun
8251 \begin_layout Plain Layout
8252 Tools\SpecialChar menuseparator
8253 Preferences\SpecialChar menuseparator
8262 \begin_layout Standard
8265 that there is a template which has a particular meaning:
8266 \begin_inset Newline linebreak
8270 \begin_inset Flex Code
8273 \begin_layout Plain Layout
8280 This template is loaded every time you create a new document with
8281 \begin_inset Flex Noun
8284 \begin_layout Plain Layout
8285 File\SpecialChar menuseparator
8291 in order to provide useful defaults.
8292 To create this template from inside \SpecialChar LyX
8294 all you have to do is to open a document with the correct settings,
8296 \begin_inset Flex Noun
8299 \begin_layout Plain Layout
8300 Save as Document Defaults
8308 \begin_layout Subsection
8309 Upgrading old layout files
8312 \begin_layout Standard
8313 The format of layout files changes with each \SpecialChar LyX
8315 so old layout files need to be converted to the new format.
8317 reads a layout file in an older format,
8318 it automatically calls the script
8319 \begin_inset Flex Code
8322 \begin_layout Plain Layout
8328 to convert it to a temporary file in current format.
8329 The original file is left untouched.
8330 If you use the layout file often,
8332 you may want to convert it permanently,
8333 so that \SpecialChar LyX
8334 does not have to do so itself every time.
8336 you can call the converter manually:
8339 \begin_layout Enumerate
8341 \begin_inset Flex Code
8344 \begin_layout Plain Layout
8351 \begin_inset Flex Code
8354 \begin_layout Plain Layout
8363 \begin_layout Enumerate
8365 \begin_inset Newline newline
8369 \begin_inset Flex Code
8372 \begin_layout Plain Layout
8373 python LyXDir/scripts/layout2layout.py myclass.old myclass.layout
8379 \begin_inset Newline newline
8383 \begin_inset Flex Code
8386 \begin_layout Plain Layout
8392 is the name of your \SpecialChar LyX
8396 \begin_layout Standard
8397 Note that manual conversion does not affect included files,
8398 so these will have to be converted separately.
8401 \begin_layout Subsection
8402 \begin_inset CommandInset label
8404 name "subsec:Cite-Engine-Files"
8411 \begin_layout Standard
8412 A specific form of layout files are the so-called
8413 \begin_inset Flex Code
8416 \begin_layout Plain Layout
8422 files that are located in the
8423 \begin_inset Flex Code
8426 \begin_layout Plain Layout
8433 Their purpose is to define the specifics of \SpecialChar LaTeX
8434 packages aimed at bibliography generation,
8449 but also the way how normal Bib\SpecialChar TeX
8450 citations (without additional packages) are handled in \SpecialChar LyX
8451 is defined in such a file.
8455 \begin_layout Standard
8457 it is defined which packages \SpecialChar LyX
8459 which citation commands are available,
8460 how these are to be displayed in \SpecialChar LyX
8463 the context menus) as well as in the XHTML and plain text output.
8465 the files specify available style variants (author-year,
8467 etc.) and their specifics.
8468 The cite engine files are also used to generate the options that are available in
8470 Document\SpecialChar menuseparator
8471 Settings\SpecialChar menuseparator
8472 Bibliography\SpecialChar menuseparator
8478 \begin_layout Standard
8479 Even though a cite engine file is essentially a normal layout file that could theoretically include any layout information,
8480 it usually primarily includes some specific parameters such as
8481 \begin_inset Flex Code
8484 \begin_layout Plain Layout
8492 \begin_inset Flex Code
8495 \begin_layout Plain Layout
8503 \begin_inset Flex Code
8506 \begin_layout Plain Layout
8513 \begin_inset Flex Code
8516 \begin_layout Plain Layout
8523 The syntax of the latter two is described in
8524 \begin_inset CommandInset ref
8526 reference "subsec:Citation-engine-description"
8535 \begin_inset CommandInset ref
8537 reference "subsec:Citation-format-description"
8543 as well as in the files themselves.
8546 \begin_layout Section
8547 \begin_inset CommandInset label
8549 name "sec:TextClass"
8553 The layout file format
8556 \begin_layout Standard
8557 The following sections describe how layout files are structured and written.
8558 Our advice is to go slowly,
8559 save and test often.
8560 It is really not that hard,
8561 except that the multitude of options can become overwhelming,
8562 especially if you try to check out too many at once.
8563 It becomes easier if you use existing layouts of \SpecialChar LyX
8564 as examples/reference or if you modify an existing layout to your needs.
8567 \begin_layout Standard
8568 Note that all the tags used in layout files are case-insensitive.
8570 \begin_inset Flex Code
8573 \begin_layout Plain Layout
8581 \begin_inset Flex Code
8584 \begin_layout Plain Layout
8591 \begin_inset Flex Code
8594 \begin_layout Plain Layout
8600 are really the same tag.
8601 The possible arguments are printed in brackets after the tag's name.
8602 The default argument is typeset
8603 \begin_inset Flex Code
8606 \begin_layout Plain Layout
8615 If the argument has a data type like
8616 \begin_inset Quotes eld
8620 \begin_inset Quotes erd
8624 \begin_inset Quotes eld
8628 \begin_inset Quotes erd
8632 the default is shown like this:
8634 \begin_inset Flex Code
8637 \begin_layout Plain Layout
8648 \begin_layout Subsection
8649 The document class declaration and classification
8652 \begin_layout Standard
8653 Lines in a layout file which begin with
8654 \begin_inset Flex Code
8657 \begin_layout Plain Layout
8664 There is one exception to this rule.
8666 \begin_inset Flex Code
8669 \begin_layout Plain Layout
8675 files should begin with lines like:
8678 \begin_layout LyX-Code
8681 #% Do not delete the line below;
8682 configure depends on this
8685 \begin_layout LyX-Code
8690 DeclareLaTeXClass{Article (Standard Class)}
8693 \begin_layout LyX-Code
8698 DeclareCategory{Articles}
8701 \begin_layout Standard
8702 The second and third lines are used when you (re)configure \SpecialChar LyX
8704 The layout file is read by the \SpecialChar LaTeX
8706 \begin_inset Flex Code
8709 \begin_layout Plain Layout
8716 in a special mode where
8717 \begin_inset Flex Code
8720 \begin_layout Plain Layout
8727 The first line is just a \SpecialChar LaTeX
8729 the second one contains the mandatory declaration of the text class and the third line contains the optional classification of the class.
8730 If these lines appear in a file named
8731 \begin_inset Flex Code
8734 \begin_layout Plain Layout
8741 then they define a text class of name
8742 \begin_inset Flex Code
8745 \begin_layout Plain Layout
8751 (the name of the layout file) which uses the \SpecialChar LaTeX
8753 \begin_inset Flex Code
8756 \begin_layout Plain Layout
8762 (the default is to use the same name as the layout).
8764 \begin_inset Quotes eld
8767 Article (Standard Class)
8768 \begin_inset Quotes erd
8771 that appears above is used as a description of the text class in the
8772 \begin_inset Flex Noun
8775 \begin_layout Plain Layout
8776 Document\SpecialChar menuseparator
8784 \begin_inset Quotes eld
8788 \begin_inset Quotes erd
8791 in the example) is also used in the
8792 \begin_inset Flex Noun
8795 \begin_layout Plain Layout
8796 Document\SpecialChar menuseparator
8803 the text classes are grouped by these categories (which are usually genres,
8804 so typical categories are
8805 \begin_inset Quotes eld
8809 \begin_inset Quotes erd
8814 \begin_inset Quotes eld
8818 \begin_inset Quotes erd
8823 \begin_inset Quotes eld
8827 \begin_inset Quotes erd
8832 \begin_inset Quotes eld
8836 \begin_inset Quotes erd
8841 \begin_inset Quotes eld
8845 \begin_inset Quotes erd
8850 \begin_inset Quotes eld
8854 \begin_inset Quotes erd
8858 If no category has been declared,
8859 the class will be put in the
8860 \begin_inset Quotes eld
8864 \begin_inset Quotes erd
8870 \begin_layout Standard
8871 Let's assume that you wrote your own text class that uses the
8872 \begin_inset Flex Code
8875 \begin_layout Plain Layout
8882 but where you changed the appearance of the section headings.
8883 If you put it in a file
8884 \begin_inset Flex Code
8887 \begin_layout Plain Layout
8894 the header of this file should be:
8897 \begin_layout LyX-Code
8900 #% Do not delete the line below;
8901 configure depends on this
8904 \begin_layout LyX-Code
8909 DeclareLaTeXClass[article]{Article (with My Own Headings)}
8912 \begin_layout LyX-Code
8917 DeclareCategory{Articles}
8920 \begin_layout Standard
8921 This declares a text class
8922 \begin_inset Flex Code
8925 \begin_layout Plain Layout
8932 associated with the \SpecialChar LaTeX
8934 \begin_inset Flex Code
8937 \begin_layout Plain Layout
8944 \begin_inset Quotes eld
8947 Article (with My Own Headings)
8948 \begin_inset Quotes erd
8952 If your text class depends on several packages,
8953 you can declare it as:
8956 \begin_layout LyX-Code
8959 #% Do not delete the line below;
8960 configure depends on this
8963 \begin_layout LyX-Code
8968 DeclareLaTeXClass[article,foo.sty]{Article (with My Own Headings)}
8971 \begin_layout LyX-Code
8976 DeclareCategory{Articles}
8979 \begin_layout Standard
8980 This indicates that your text class uses the
8981 \begin_inset Flex Code
8984 \begin_layout Plain Layout
8992 \change_deleted 5863208 1594239179
8994 it is also possible to declare classes for DocBook code.
8995 Typical declarations will look like:
8998 \begin_layout LyX-Code
9000 \change_deleted 5863208 1594239179
9003 #% Do not delete the line below;
9004 configure depends on this
9007 \begin_layout LyX-Code
9009 \change_deleted 5863208 1594239179
9014 DeclareDocBookClass[article]{SGML (DocBook Article)}
9017 \begin_layout LyX-Code
9019 \change_deleted 5863208 1594239179
9024 DeclareCategory{Articles (DocBook)}
9029 \begin_layout Standard
9030 Note that these declarations can also be given an optional parameter declaring the name of the document class (but not a list).
9033 \begin_layout Standard
9035 to be as explicit as possible,
9036 the form of the layout declaration is:
9039 \begin_layout LyX-Code
9044 DeclareLaTeXClass[class,package.sty]{layout description}
9047 \begin_layout LyX-Code
9052 DeclareCategory{category}
9055 \begin_layout Standard
9056 The class need only be specified if the name of the \SpecialChar LaTeX
9057 class file and the name of the layout file are different or if there are packages to load.
9058 If the name of the class file is not specified,
9059 then \SpecialChar LyX
9060 will simply assume that it is the same as the name of the layout file.
9063 \begin_layout Standard
9064 When the text class has been modified to your taste,
9065 all you have to do is to copy it either to
9066 \begin_inset Flex Code
9069 \begin_layout Plain Layout
9076 \begin_inset Flex Code
9079 \begin_layout Plain Layout
9087 \begin_inset Flex Noun
9090 \begin_layout Plain Layout
9091 Tools\SpecialChar menuseparator
9098 exit \SpecialChar LyX
9100 Then your new text class should be available along with the others.
9103 \begin_layout Standard
9104 Once the layout file is installed,
9105 you can edit it and see your changes without having to reconfigure or to restart \SpecialChar LyX
9110 \begin_layout Plain Layout
9111 In versions of \SpecialChar LyX
9115 editing layout files was very time consuming,
9116 since you had constantly to restart \SpecialChar LyX
9122 You can force a reload of the current layout by using the \SpecialChar LyX
9124 \begin_inset Flex Noun
9127 \begin_layout Plain Layout
9134 There is no default binding for this function—
9137 you can bind it to a key yourself.
9138 But you will normally use this function simply by entering it in the mini-buffer.
9142 \begin_layout Standard
9149 \begin_inset Flex Noun
9152 \begin_layout Plain Layout
9158 is very much an `advanced feature'.
9163 recommended that you save your work before using this function.
9169 recommended that you not attempt to edit layout information while simultaneously working on a document that you care about.
9170 Use a test document.
9171 Syntax errors and the like in your layout file could cause peculiar behavior.
9173 such errors could cause \SpecialChar LyX
9174 to regard the current layout as invalid and to attempt to switch to some other layout.
9178 \begin_layout Plain Layout
9179 Really bad syntax errors may even caused \SpecialChar LyX
9181 This is because certain sorts of errors may make \SpecialChar LyX
9192 The \SpecialChar LyX
9193 team strives to keep \SpecialChar LyX
9194 stable in such situations,
9195 but safe is better than sorry.
9199 \begin_layout Plain Layout
9200 While we're giving advice:
9201 make regular backups.
9202 And be nice to your mother.
9210 \begin_layout Subsection
9211 The Module declaration
9214 \begin_layout Standard
9215 A module must begin with a line like the following:
9218 \begin_layout LyX-Code
9221 DeclareLyXModule[endnotes.sty]{Endnotes}
9222 \change_inserted -712698321 1554395911
9226 \begin_layout LyX-Code
9228 \change_inserted -712698321 1554395924
9233 DeclareCategory{Foot- and Endnotes}
9234 \change_deleted -712698321 1554395911
9242 \begin_layout Standard
9243 The mandatory argument
9244 \change_inserted -712698321 1554395956
9255 is the name of the module,
9256 as it should appear in
9257 \begin_inset Flex Noun
9260 \begin_layout Plain Layout
9261 Document\SpecialChar menuseparator
9262 Settings\SpecialChar menuseparator
9269 The argument in square brackets is optional:
9270 It declares any \SpecialChar LaTeX
9271 packages on which the module depends.
9272 It is also possible to use the form
9273 \begin_inset Flex Noun
9276 \begin_layout Plain Layout
9282 as an optional argument,
9283 which declares that the module can only be used when there exists a conversion chain between the formats `
9284 \begin_inset Flex Code
9287 \begin_layout Plain Layout
9294 \begin_inset Flex Code
9297 \begin_layout Plain Layout
9305 \change_inserted -712698321 1554396133
9312 declaration is not strictly mandatory,
9313 but you should add it,
9314 since it is helpful to find the module.
9315 Please have a look at the existing module categories and if appropriate,
9321 \begin_layout Standard
9323 \change_inserted -712698321 1554395988
9326 declaration should then be followed by lines like the following:
9330 \begin_layout Plain Layout
9331 Preferably in English if the module should be published with \SpecialChar LyX
9333 This description will appear in the list of messages to be translated and will be thus translated with the next interface update.
9341 \begin_layout LyX-Code
9345 \begin_layout LyX-Code
9346 #Adds an endnote command,
9347 in addition to footnotes.
9351 \begin_layout LyX-Code
9352 #You will need to add
9354 theendnotes in TeX code where you
9357 \begin_layout LyX-Code
9358 #want the endnotes to appear.
9362 \begin_layout LyX-Code
9366 \begin_layout LyX-Code
9368 somemodule | othermodule
9371 \begin_layout LyX-Code
9376 \begin_layout Standard
9377 The description is used in
9378 \begin_inset Flex Noun
9381 \begin_layout Plain Layout
9382 Document\SpecialChar menuseparator
9383 Settings\SpecialChar menuseparator
9389 to provide the user with information about what the module does.
9391 \begin_inset Flex Code
9394 \begin_layout Plain Layout
9400 line is used to identify other modules with which this one must be used;
9402 \begin_inset Flex Code
9405 \begin_layout Plain Layout
9411 line is used to identify modules with which this one may not be used.
9415 multiple modules should be separated with the pipe symbol:
9417 Note that the required modules are treated disjunctively:
9422 of the required modules must be used.
9428 excluded module may be used.
9429 Note that modules are identified here by their filenames without the
9430 \begin_inset Flex Code
9433 \begin_layout Plain Layout
9441 \begin_inset Flex Code
9444 \begin_layout Plain Layout
9451 \begin_inset Flex Code
9454 \begin_layout Plain Layout
9463 \begin_layout Subsection
9464 The CiteEngine file declaration
9467 \begin_layout Standard
9468 A cite engine file must begin with a line like the following:
9471 \begin_layout LyX-Code
9474 DeclareLyXCiteEngineModule[biblatex.sty]{Biblatex}
9477 \begin_layout Standard
9478 The mandatory argument,
9480 is the name of the cite style,
9481 as it should appear in
9482 \begin_inset Flex Noun
9485 \begin_layout Plain Layout
9486 Document\SpecialChar menuseparator
9487 Settings\SpecialChar menuseparator
9494 The argument in square brackets is optional:
9495 It declares any \SpecialChar LaTeX
9496 packages on which the cite engine depends.
9499 \begin_layout Standard
9500 The cite engine declaration should then be followed by lines like the following:
9504 \begin_layout Plain Layout
9505 Preferably in English if the module should be published with \SpecialChar LyX
9507 This description will appear in the list of messages to be translated and will be thus translated with the next interface update.
9515 \begin_layout LyX-Code
9519 \begin_layout LyX-Code
9520 # Biblatex supports many author-year and numerical styles.
9523 \begin_layout LyX-Code
9524 # It is mainly aimed at the Humanities.
9528 \begin_layout LyX-Code
9530 fully localized and provides many features
9533 \begin_layout LyX-Code
9534 # that are not possible with BibTeX.
9535 The use of 'biber' as
9538 \begin_layout LyX-Code
9539 # bibliography processor is advised.
9542 \begin_layout LyX-Code
9546 \begin_layout Standard
9547 The description is used in
9548 \begin_inset Flex Noun
9551 \begin_layout Plain Layout
9552 Document\SpecialChar menuseparator
9553 Settings\SpecialChar menuseparator
9559 to provide the user with information about the cite engine.
9562 \begin_layout Subsection
9566 \begin_layout Standard
9567 The first non-comment line of any layout file,
9573 contain the file format number:
9576 \begin_layout Description
9577 \begin_inset Flex Code
9580 \begin_layout Plain Layout
9587 \begin_inset Flex Code
9590 \begin_layout Plain Layout
9596 ] The format number of the layout file.
9599 \begin_layout Standard
9600 This tag was introduced with \SpecialChar LyX
9602 \begin_inset space ~
9606 Layout files from older \SpecialChar LyX
9607 versions do not have an explicit file format and are considered to have
9608 \begin_inset Flex Code
9611 \begin_layout Plain Layout
9613 \begin_inset space ~
9622 The format for the present version of \SpecialChar LyX
9624 But each version of \SpecialChar LyX
9625 is capable of reading earlier versions' layout files,
9626 just as they are capable of reading files produced by earlier versions of \SpecialChar LyX
9630 no provision for converting to earlier formats.
9633 \begin_layout Subsection
9634 \begin_inset CommandInset label
9636 name "subsec:General-text-class"
9640 General text class parameters
9643 \begin_layout Standard
9644 These are general parameters that govern the behavior of an entire document class.
9649 mean that they must appear in
9650 \begin_inset Flex Code
9653 \begin_layout Plain Layout
9659 files rather than in modules.
9660 A module can contain any layout tag.)
9663 \begin_layout Description
9665 \change_inserted -712698321 1526899478
9666 \begin_inset Flex Code
9669 \begin_layout Plain Layout
9671 \change_inserted -712698321 1526898610
9672 AddToCiteEngine <engine>
9679 Extends the possibilities for displaying citation references.
9681 \begin_inset CommandInset ref
9683 reference "subsec:Citation-engine-description"
9693 \begin_inset Flex Code
9696 \begin_layout Plain Layout
9698 \change_inserted -712698321 1526898823
9709 \begin_layout Description
9710 \begin_inset Flex Code
9713 \begin_layout Plain Layout
9719 Adds information that will be output in the
9720 \begin_inset Flex Code
9723 \begin_layout Plain Layout
9729 block when the document is output to XHTML.
9731 this would be used to output CSS style information,
9732 but it can be used for anything that can appear in
9733 \begin_inset Flex Code
9736 \begin_layout Plain Layout
9744 \begin_inset Quotes eld
9748 \begin_inset Flex Code
9751 \begin_layout Plain Layout
9758 \begin_inset Quotes erd
9764 \begin_layout Description
9765 \begin_inset Flex Code
9768 \begin_layout Plain Layout
9774 Adds information to the document preamble.
9776 \begin_inset Newline newline
9780 \begin_inset Quotes eld
9784 \begin_inset Flex Code
9787 \begin_layout Plain Layout
9794 \begin_inset Quotes erd
9798 \change_inserted -712698321 1562592950
9802 \begin_layout Description
9804 \change_inserted -712698321 1562593040
9805 \begin_inset Flex Code
9808 \begin_layout Plain Layout
9810 \change_inserted -712698321 1562592954
9819 \begin_inset Flex Code
9822 \begin_layout Plain Layout
9824 \change_inserted -712698321 1562592950
9835 \begin_inset space \thinspace{}
9839 \begin_inset Flex Code
9842 \begin_layout Plain Layout
9844 \change_inserted -712698321 1562592950
9852 ] If the document class adds the bibliography to the table of contents,
9853 add this option with value
9854 \begin_inset Flex Code
9857 \begin_layout Plain Layout
9859 \change_inserted -712698321 1562592996
9868 \begin_inset Flex Code
9871 \begin_layout Plain Layout
9873 \change_inserted -712698321 1562593006
9882 This prevents the bibliography from being added twice.
9887 \begin_layout Description
9888 \begin_inset Flex Code
9891 \begin_layout Plain Layout
9897 Defines the possibilities for displaying citation references.
9899 \begin_inset CommandInset ref
9901 reference "subsec:Citation-engine-description"
9911 \begin_inset Quotes eld
9915 \begin_inset Flex Code
9918 \begin_layout Plain Layout
9925 \begin_inset Quotes erd
9929 Primarily used in cite engine files (see
9930 \begin_inset CommandInset ref
9932 reference "subsec:Cite-Engine-Files"
9942 \change_inserted -712698321 1526898530
9943 Note that if you specify this in a layout file or module,
9944 any cite engine definition will be overridden.
9946 \begin_inset Flex Code
9949 \begin_layout Plain Layout
9951 \change_inserted -712698321 1526898530
9964 \begin_layout Description
9965 \begin_inset Flex Code
9968 \begin_layout Plain Layout
9974 Defines formats for use in the display of bibliographic information.
9976 \begin_inset CommandInset ref
9978 reference "subsec:Citation-format-description"
9985 \begin_inset Quotes eld
9989 \begin_inset Flex Code
9992 \begin_layout Plain Layout
9999 \begin_inset Quotes erd
10003 Primarily used in cite engine files (see
10004 \begin_inset CommandInset ref
10006 reference "subsec:Cite-Engine-Files"
10016 \change_inserted -712698321 1526898585
10017 A cite format defined in a layout or module will override the cite engine definition.
10022 \begin_layout Description
10023 \begin_inset Flex Code
10026 \begin_layout Plain Layout
10033 \begin_inset Flex Code
10036 \begin_layout Plain Layout
10045 \begin_inset Flex Code
10048 \begin_layout Plain Layout
10054 ] Determines whether
10058 or Bib\SpecialChar TeX
10059 is used to generate a Bibliography.
10060 Primarily used in cite engine files (see
10061 \begin_inset CommandInset ref
10063 reference "subsec:Cite-Engine-Files"
10074 \begin_layout Description
10075 \begin_inset Flex Code
10078 \begin_layout Plain Layout
10084 Describes various global options supported by the document class.
10086 \begin_inset CommandInset ref
10088 reference "subsec:ClassOptions"
10095 \begin_inset Quotes eld
10099 \begin_inset Flex Code
10102 \begin_layout Plain Layout
10109 \begin_inset Quotes erd
10115 \begin_layout Description
10116 \begin_inset Flex Code
10119 \begin_layout Plain Layout
10126 \begin_inset Flex Code
10129 \begin_layout Plain Layout
10138 \begin_inset space \thinspace{}
10142 \begin_inset Flex Code
10145 \begin_layout Plain Layout
10151 ] Whether the class should
10155 to having one or two columns.
10156 Can be changed in the
10157 \begin_inset Flex Noun
10160 \begin_layout Plain Layout
10161 Document\SpecialChar menuseparator
10170 \begin_layout Description
10171 \begin_inset Flex Code
10174 \begin_layout Plain Layout
10181 \begin_inset Flex Code
10184 \begin_layout Plain Layout
10190 ] This sequence defines the properties for a counter.
10191 If the counter does not yet exist,
10196 \begin_inset Quotes eld
10200 \begin_inset Flex Code
10203 \begin_layout Plain Layout
10210 \begin_inset Quotes erd
10214 \begin_inset Newline newline
10218 \begin_inset CommandInset ref
10220 reference "subsec:Counters"
10225 for details on counters.
10228 \begin_layout Description
10229 \begin_inset Flex Code
10232 \begin_layout Plain Layout
10238 Sets the default font used to display the document.
10240 \begin_inset CommandInset ref
10242 reference "subsec:Font-description"
10247 for how to declare fonts.
10249 \begin_inset Quotes eld
10253 \begin_inset Flex Code
10256 \begin_layout Plain Layout
10263 \begin_inset Quotes erd
10269 \begin_layout Description
10270 \begin_inset Flex Code
10273 \begin_layout Plain Layout
10280 \begin_inset Flex Code
10283 \begin_layout Plain Layout
10289 ] Specifies a module to be included by default with this document class.
10290 The module is specified as filename without the
10291 \begin_inset Flex Code
10294 \begin_layout Plain Layout
10301 The user can still remove the module,
10302 but it will be active at the outset.
10303 (This applies only when new files are created,
10304 or when this class is chosen for an existing document.)
10307 \begin_layout Description
10308 \begin_inset Flex Code
10311 \begin_layout Plain Layout
10318 \begin_inset Flex Code
10321 \begin_layout Plain Layout
10327 ] This is the style that will be assigned to new paragraphs,
10329 \begin_inset Flex Noun
10332 \begin_layout Plain Layout
10339 This will default to the first defined style if not given,
10340 but you are encouraged to use this directive.
10343 \begin_layout Description
10345 \change_inserted -970929547 1515112870
10346 \begin_inset Flex Code
10349 \begin_layout Plain Layout
10351 \change_inserted -970929547 1515112782
10360 \begin_inset Flex Code
10363 \begin_layout Plain Layout
10365 \change_inserted -970929547 1515112766
10373 ] The root element (at the top of the document) to use when outputting documents with this class in DocBook.
10374 The default value is
10375 \begin_inset Quotes eld
10379 \begin_inset Flex Code
10382 \begin_layout Plain Layout
10384 \change_inserted -970929547 1515112845
10393 \begin_inset Quotes erd
10398 \change_deleted 1075283030 1594226862
10400 \change_inserted 1075283030 1594226777
10404 \begin_layout Description
10406 \change_inserted 1075283030 1594226859
10407 \begin_inset Flex Code
10410 \begin_layout Plain Layout
10412 \change_inserted 1075283030 1594226785
10413 DocBookForceAbstract
10421 \begin_inset Flex Code
10424 \begin_layout Plain Layout
10426 \change_inserted 1075283030 1594226804
10435 \begin_inset Quotes eld
10443 \begin_inset Quotes erd
10447 the root element will always have an
10452 The default value is
10453 \begin_inset Quotes eld
10461 \begin_inset Quotes erd
10469 \begin_layout Description
10470 \begin_inset Flex Code
10473 \begin_layout Plain Layout
10480 \begin_inset Flex Code
10483 \begin_layout Plain Layout
10489 ] This tag indicates that the module (which is specified by filename without the
10490 \begin_inset Flex Code
10493 \begin_layout Plain Layout
10499 extension) cannot be used with this document class.
10500 This might be used in a journal-specific layout file to prevent,
10503 \begin_inset Flex Code
10506 \begin_layout Plain Layout
10512 module that numbers theorems by section.
10517 be used in a module.
10518 Modules have their own way of excluding other modules (see
10519 \begin_inset CommandInset ref
10521 reference "subsec:Layout-modules"
10529 \begin_layout Description
10530 \begin_inset Flex Code
10533 \begin_layout Plain Layout
10539 Defines a new float.
10541 \begin_inset CommandInset ref
10543 reference "subsec:Floats"
10550 \begin_inset Quotes eld
10554 \begin_inset Flex Code
10557 \begin_layout Plain Layout
10564 \begin_inset Quotes erd
10570 \begin_layout Description
10571 \begin_inset Flex Code
10574 \begin_layout Plain Layout
10580 Sets the information that will be output in the
10581 \begin_inset Flex Code
10584 \begin_layout Plain Layout
10590 block when this document class is output to XHTML.
10591 Note that this will completely override any prior
10592 \begin_inset Flex Code
10595 \begin_layout Plain Layout
10602 \begin_inset Flex Code
10605 \begin_layout Plain Layout
10613 \begin_inset Newline newline
10617 \begin_inset Flex Code
10620 \begin_layout Plain Layout
10626 if you just want to add material to the preamble.) Must end with
10627 \begin_inset Quotes eld
10631 \begin_inset Flex Code
10634 \begin_layout Plain Layout
10641 \begin_inset Quotes erd
10647 \begin_layout Description
10648 \begin_inset Flex Code
10651 \begin_layout Plain Layout
10658 \begin_inset Flex Code
10661 \begin_layout Plain Layout
10667 ] The style to use for the table of contents,
10670 when the document is output to HTML.
10672 this should normally be
10673 \begin_inset Flex Code
10676 \begin_layout Plain Layout
10684 \begin_inset Flex Code
10687 \begin_layout Plain Layout
10694 If it is not given,
10695 then \SpecialChar LyX
10696 will attempt to figure out which layout to use.
10699 \begin_layout Description
10700 \begin_inset Flex Code
10703 \begin_layout Plain Layout
10710 \begin_inset Flex Code
10713 \begin_layout Plain Layout
10719 ] Modifies the properties of the given counter.
10720 If the counter does not exist,
10721 the statement is ignored.
10723 \begin_inset Quotes eld
10727 \begin_inset Flex Code
10730 \begin_layout Plain Layout
10737 \begin_inset Quotes erd
10741 \begin_inset Newline newline
10745 \begin_inset CommandInset ref
10747 reference "subsec:Counters"
10752 for details on counters.
10755 \begin_layout Description
10756 \begin_inset Flex Code
10759 \begin_layout Plain Layout
10766 \begin_inset Flex Code
10769 \begin_layout Plain Layout
10775 ] This allows you to include another layout definition file within yours to avoid duplicating commands.
10776 Common examples are the standard layout files,
10779 \begin_inset Flex Code
10782 \begin_layout Plain Layout
10789 which contains most of the basic layouts.
10790 \change_inserted -712698321 1611646803
10794 \begin_layout Description
10796 \change_inserted -712698321 1611646804
10797 \begin_inset Flex Code
10800 \begin_layout Plain Layout
10802 \change_inserted -712698321 1611646837
10811 \begin_inset Flex Code
10814 \begin_layout Plain Layout
10816 \change_inserted -712698321 1611646804
10824 ] is a variant of the
10825 \begin_inset Flex Code
10828 \begin_layout Plain Layout
10830 \change_inserted -712698321 1611646804
10838 command which does not look for files in the user directory.
10839 This allows to create a file
10840 \begin_inset Flex Code
10843 \begin_layout Plain Layout
10845 \change_inserted -712698321 1611646804
10854 \begin_inset Flex Code
10857 \begin_layout Plain Layout
10859 \change_inserted -712698321 1611646804
10867 in the user directory which includes a global file with the same name via
10868 \begin_inset Flex Code
10871 \begin_layout Plain Layout
10873 \change_inserted -712698321 1611646853
10882 \begin_inset Flex Code
10885 \begin_layout Plain Layout
10887 \change_inserted -712698321 1611646855
10888 InputGlobal name.inc
10897 \begin_inset Flex Code
10900 \begin_layout Plain Layout
10902 \change_inserted -712698321 1611646804
10911 the file would recursively include itself).
10913 you can modify global files without having to completely copy them.
10918 \begin_layout Description
10919 \begin_inset Flex Code
10922 \begin_layout Plain Layout
10929 \begin_inset Flex Code
10932 \begin_layout Plain Layout
10938 ] This section (re-)defines the layout of an inset.
10939 It can be applied to an existing inset or to a new,
10940 user-defined inset,
10942 a new character style.
10944 \begin_inset Quotes eld
10948 \begin_inset Flex Code
10951 \begin_layout Plain Layout
10958 \begin_inset Quotes erd
10962 \begin_inset Newline newline
10966 \begin_inset CommandInset ref
10968 reference "subsec:Flex-insets-and"
10973 for more information.
10977 \begin_layout Description
10978 \begin_inset Flex Code
10981 \begin_layout Plain Layout
10988 \begin_inset Flex Code
10991 \begin_layout Plain Layout
10997 ] A string that indicates the width of the left margin on the screen,
11000 \begin_inset Quotes eld
11004 \begin_inset Flex Code
11007 \begin_layout Plain Layout
11014 \begin_inset Quotes erd
11018 (Note that this is not a `length',
11020 \begin_inset Quotes eld
11024 \begin_inset Quotes erd
11030 \begin_layout Description
11031 \begin_inset Flex Code
11034 \begin_layout Plain Layout
11041 \begin_inset Flex Code
11044 \begin_layout Plain Layout
11050 ] An integer that determines the maximal number of names displayed in an author-year citation before the citation switches to
11051 \begin_inset Quotes eld
11055 \begin_inset Quotes erd
11059 Primarily used in cite engine files (see
11060 \begin_inset CommandInset ref
11062 reference "subsec:Cite-Engine-Files"
11073 \begin_layout Description
11075 \change_inserted -712698321 1612018485
11076 \begin_inset Flex Code
11079 \begin_layout Plain Layout
11081 \change_inserted -712698321 1612018457
11090 \begin_inset Flex Code
11093 \begin_layout Plain Layout
11095 \change_inserted -712698321 1612018466
11103 ] Modifies the layout of an inset.
11104 If the layout does not exist,
11105 this section is ignored.
11107 \begin_inset Quotes eld
11111 \begin_inset Flex Code
11114 \begin_layout Plain Layout
11116 \change_inserted -712698321 1612018452
11125 \begin_inset Quotes erd
11131 \begin_layout Description
11132 \begin_inset Flex Code
11135 \begin_layout Plain Layout
11142 \begin_inset Flex Code
11145 \begin_layout Plain Layout
11151 ] Modifies the properties of the given paragraph style.
11152 If the style does not exist,
11153 this section is ignored.
11155 \begin_inset Quotes eld
11159 \begin_inset Flex Code
11162 \begin_layout Plain Layout
11169 \begin_inset Quotes erd
11175 \begin_layout Description
11176 \begin_inset Flex Code
11179 \begin_layout Plain Layout
11186 \begin_inset Flex Code
11189 \begin_layout Plain Layout
11195 ] Deletes an existing counter,
11196 usually one defined in an included file.
11199 \begin_layout Description
11200 \begin_inset Flex Code
11203 \begin_layout Plain Layout
11210 \begin_inset Flex Code
11213 \begin_layout Plain Layout
11219 ] Deletes an existing float.
11220 This is particularly useful when you want to suppress a float that has been defined in an input file.
11223 \begin_layout Description
11224 \begin_inset Flex Code
11227 \begin_layout Plain Layout
11234 \begin_inset Flex Code
11237 \begin_layout Plain Layout
11243 ] Deletes an existing style.
11246 \begin_layout Description
11247 \begin_inset Flex Code
11250 \begin_layout Plain Layout
11257 \begin_inset Flex Code
11260 \begin_layout Plain Layout
11267 \begin_inset Flex Code
11270 \begin_layout Plain Layout
11276 ] Define a new table of contents with type
11277 \begin_inset Flex Code
11280 \begin_layout Plain Layout
11287 \begin_inset Flex Code
11290 \begin_layout Plain Layout
11297 See also the AddToToc commands.
11300 \begin_layout Description
11301 \begin_inset Flex Code
11304 \begin_layout Plain Layout
11311 \begin_inset Flex Code
11314 \begin_layout Plain Layout
11320 ] The file format (as defined in the \SpecialChar LyX
11321 preferences) produced by this document class.
11322 It is mainly useful when
11323 \begin_inset Flex Code
11326 \begin_layout Plain Layout
11333 \begin_inset Flex Code
11336 \begin_layout Plain Layout
11342 and one wants to define a new type of literate document.
11343 The format is reset to
11344 \change_deleted 5863208 1594239413
11346 \begin_inset Quotes eld
11350 \begin_inset Flex Code
11353 \begin_layout Plain Layout
11360 \begin_inset Quotes erd
11366 \begin_inset Quotes eld
11370 \begin_inset Flex Code
11373 \begin_layout Plain Layout
11380 \begin_inset Quotes erd
11383 when the corresponding
11384 \begin_inset Flex Code
11387 \begin_layout Plain Layout
11393 parameter is encountered.
11396 \begin_layout Description
11397 \begin_inset Flex Code
11400 \begin_layout Plain Layout
11407 \begin_inset Flex Code
11410 \begin_layout Plain Layout
11422 \change_deleted 5863208 1594239430
11424 \begin_inset Flex Code
11427 \begin_layout Plain Layout
11437 \begin_inset Flex Code
11440 \begin_layout Plain Layout
11446 ] Specifies what sort of output documents using this class will produce.
11449 \begin_layout Description
11450 \begin_inset Flex Code
11453 \begin_layout Plain Layout
11460 \begin_inset Flex Code
11463 \begin_layout Plain Layout
11470 \begin_inset Flex Code
11473 \begin_layout Plain Layout
11479 ] Specifies options,
11480 given in the second string,
11481 for the package named by the first string.
11484 \begin_inset Quotes eld
11488 \begin_inset Flex Code
11491 \begin_layout Plain Layout
11492 PackageOptions natbib square
11498 \begin_inset Quotes erd
11502 \begin_inset Flex Code
11505 \begin_layout Plain Layout
11511 to be loaded with the
11512 \begin_inset Flex Code
11515 \begin_layout Plain Layout
11522 (For \SpecialChar TeX
11524 this causes \SpecialChar LyX
11527 \begin_inset Flex Code
11530 \begin_layout Plain Layout
11533 PassOptionsToPackage{natbib}{square}
11539 \begin_inset Flex Code
11542 \begin_layout Plain Layout
11549 \change_inserted -712698321 1565102364
11553 \begin_layout Description
11555 \change_inserted -712698321 1565102470
11556 \begin_inset Flex Code
11559 \begin_layout Plain Layout
11561 \change_inserted -712698321 1565102365
11570 \begin_inset Flex Code
11573 \begin_layout Plain Layout
11575 \change_inserted -712698321 1565105222
11618 ] The default page size.
11619 This is used by some converters.
11624 \begin_layout Description
11625 \begin_inset Flex Code
11628 \begin_layout Plain Layout
11635 \begin_inset Flex Code
11638 \begin_layout Plain Layout
11648 \begin_inset Flex Code
11651 \begin_layout Plain Layout
11659 \begin_inset Flex Code
11662 \begin_layout Plain Layout
11668 ] The default pagestyle.
11669 Can be changed in the
11670 \begin_inset Flex Noun
11673 \begin_layout Plain Layout
11674 Document\SpecialChar menuseparator
11683 \begin_layout Description
11684 \begin_inset Flex Code
11687 \begin_layout Plain Layout
11693 Sets the preamble for the \SpecialChar LaTeX
11695 Note that this will completely override any prior
11696 \begin_inset Flex Code
11699 \begin_layout Plain Layout
11706 \begin_inset Flex Code
11709 \begin_layout Plain Layout
11717 \begin_inset Flex Code
11720 \begin_layout Plain Layout
11726 if you just want to add material to the preamble.) Must end with
11727 \begin_inset Quotes eld
11731 \begin_inset Flex Code
11734 \begin_layout Plain Layout
11741 \begin_inset Quotes erd
11745 \change_inserted -712698321 1612018500
11749 \begin_layout Description
11751 \change_inserted -712698321 1612018547
11752 \begin_inset Flex Code
11755 \begin_layout Plain Layout
11757 \change_inserted -712698321 1612018506
11766 \begin_inset Flex Code
11769 \begin_layout Plain Layout
11771 \change_inserted -712698321 1612018509
11779 ] Defines the layout of an inset if it does not already exist.
11780 If the layout does exist,
11781 this section is ignored.
11783 \begin_inset Quotes eld
11787 \begin_inset Flex Code
11790 \begin_layout Plain Layout
11792 \change_inserted -712698321 1612018500
11801 \begin_inset Quotes erd
11809 \begin_layout Description
11810 \begin_inset Flex Code
11813 \begin_layout Plain Layout
11820 \begin_inset Flex Code
11823 \begin_layout Plain Layout
11830 \begin_inset Flex Code
11833 \begin_layout Plain Layout
11842 \begin_inset space \thinspace{}
11846 \begin_inset Flex Code
11849 \begin_layout Plain Layout
11855 ] Whether the class already provides the feature
11856 \begin_inset Flex Code
11859 \begin_layout Plain Layout
11866 A feature is in general the name of a package (e.
11867 \begin_inset space \thinspace{}
11871 \begin_inset space \space{}
11875 \begin_inset Flex Code
11878 \begin_layout Plain Layout
11885 \begin_inset Flex Code
11888 \begin_layout Plain Layout
11895 \begin_inset space \thinspace{}
11899 \begin_inset space \space{}
11903 \begin_inset Flex Code
11906 \begin_layout Plain Layout
11913 \begin_inset Flex Code
11916 \begin_layout Plain Layout
11924 \begin_inset CommandInset ref
11926 reference "chap:List-of-functions"
11931 for the list of features.
11934 \begin_layout Description
11935 \begin_inset Flex Code
11938 \begin_layout Plain Layout
11945 \begin_inset Flex Code
11948 \begin_layout Plain Layout
11954 ] Indicates that this layout provides the functionality of the module mentioned,
11955 which should be specified by the filename without the
11956 \begin_inset Flex Code
11959 \begin_layout Plain Layout
11966 This will typically be used if the layout includes the module directly,
11967 rather than using the
11968 \begin_inset Flex Code
11971 \begin_layout Plain Layout
11977 tag to indicate that it ought to be used.
11978 It could also be used in a module that provided an alternate implementation of the same functionality.
11981 \begin_layout Description
11982 \begin_inset Flex Code
11985 \begin_layout Plain Layout
11992 \begin_inset Flex Code
11995 \begin_layout Plain Layout
12001 ] Creates a new paragraph style if it does not already exist.
12002 If the style does exist,
12003 this section is ignored.
12005 \begin_inset Quotes eld
12009 \begin_inset Flex Code
12012 \begin_layout Plain Layout
12019 \begin_inset Quotes erd
12025 \begin_layout Description
12026 \begin_inset Flex Code
12029 \begin_layout Plain Layout
12036 \begin_inset Flex Code
12039 \begin_layout Plain Layout
12045 ] Whether the class requires the feature
12046 \begin_inset Flex Code
12049 \begin_layout Plain Layout
12056 Multiple features must be separated by commas.
12057 Note that you can only request supported features.
12059 \begin_inset CommandInset ref
12061 reference "chap:List-of-functions"
12066 for the list of features.).
12067 If you require a package with specific options,
12068 you can additionally use
12069 \begin_inset Flex Code
12072 \begin_layout Plain Layout
12081 \begin_layout Description
12082 \begin_inset Flex Code
12085 \begin_layout Plain Layout
12092 \begin_inset Flex Code
12095 \begin_layout Plain Layout
12101 ] A string that indicates the width of the right margin on the screen,
12104 \begin_inset Quotes eld
12108 \begin_inset Flex Code
12111 \begin_layout Plain Layout
12118 \begin_inset Quotes erd
12124 \begin_layout Description
12125 \begin_inset Flex Code
12128 \begin_layout Plain Layout
12135 \begin_inset Flex Code
12138 \begin_layout Plain Layout
12144 ] Sets which divisions get numbered.
12146 \begin_inset Newline newline
12150 \begin_inset Flex Code
12153 \begin_layout Plain Layout
12159 counter in \SpecialChar LaTeX
12163 \begin_layout Description
12164 \begin_inset Flex Code
12167 \begin_layout Plain Layout
12174 \begin_inset Flex Code
12177 \begin_layout Plain Layout
12186 \begin_inset space \thinspace{}
12190 \begin_inset Flex Code
12193 \begin_layout Plain Layout
12199 ] Whether the class-default should be printing on one or both sides of the paper.
12200 Can be changed in the
12201 \begin_inset Flex Noun
12204 \begin_layout Plain Layout
12205 Document\SpecialChar menuseparator
12214 \begin_layout Description
12215 \begin_inset Flex Code
12218 \begin_layout Plain Layout
12225 \begin_inset Flex Code
12228 \begin_layout Plain Layout
12234 ] This sequence defines a paragraph style.
12235 If the style does not yet exist,
12238 its parameters are modified.
12240 \begin_inset Quotes eld
12244 \begin_inset Flex Code
12247 \begin_layout Plain Layout
12254 \begin_inset Quotes erd
12258 \begin_inset Newline newline
12262 \begin_inset CommandInset ref
12264 reference "subsec:Paragraph-Styles"
12269 for details on paragraph styles.
12270 \change_inserted -712698321 1553617804
12274 \begin_layout Description
12276 \change_inserted -712698321 1553617862
12277 \begin_inset Flex Code
12280 \begin_layout Plain Layout
12282 \change_inserted -712698321 1553617809
12291 \begin_inset Flex Code
12294 \begin_layout Plain Layout
12296 \change_inserted -712698321 1553617805
12304 ] defines the default table style that is used when inserting a table.
12305 The following styles are available:
12309 \begin_layout Itemize
12311 \change_inserted -712698321 1554308039
12312 \begin_inset Flex Code
12315 \begin_layout Plain Layout
12317 \change_inserted -712698321 1554307928
12318 Formal_with_Footline
12327 \begin_inset Quotes eld
12331 \begin_inset Quotes erd
12334 ) style with horizontal lines only,
12335 using a bold top and bottom line,
12336 the first and last row are additionally separated from the table body with a thin middle line.
12339 \begin_layout Itemize
12341 \change_inserted -712698321 1554308087
12342 \begin_inset Flex Code
12345 \begin_layout Plain Layout
12347 \change_inserted -712698321 1554308042
12348 Formal_without_Footline
12357 but the last row is not separated with a middle line from the body.
12360 \begin_layout Itemize
12362 \change_inserted -712698321 1553618031
12363 \begin_inset Flex Code
12366 \begin_layout Plain Layout
12368 \change_inserted -712698321 1553618006
12377 Simple table lines.
12380 \begin_layout Itemize
12382 \change_inserted -712698321 1553618309
12383 \begin_inset Flex Code
12386 \begin_layout Plain Layout
12388 \change_inserted -712698321 1553618031
12398 \begin_inset Flex Code
12401 \begin_layout Plain Layout
12403 \change_inserted -712698321 1553618043
12412 but with the header
12413 \change_deleted 34634807 1619712593
12415 \change_inserted 34634807 1619712594
12417 \change_inserted -712698321 1553618309
12418 offset with a second horizontal line.
12419 This is also the default style of \SpecialChar LyX
12423 \begin_layout Itemize
12425 \change_inserted -712698321 1553618280
12426 \begin_inset Flex Code
12429 \begin_layout Plain Layout
12431 \change_inserted -712698321 1553618261
12440 Table without lines.
12446 \begin_layout Description
12447 \begin_inset Flex Code
12450 \begin_layout Plain Layout
12457 \begin_inset Flex Code
12460 \begin_layout Plain Layout
12466 ] The name of the command or environment to be used with
12467 \begin_inset Flex Code
12470 \begin_layout Plain Layout
12479 \begin_layout Description
12480 \begin_inset Flex Code
12483 \begin_layout Plain Layout
12490 \begin_inset Flex Code
12493 \begin_layout Plain Layout
12503 \begin_inset Flex Code
12506 \begin_layout Plain Layout
12512 ] Indicates what kind of markup is used to define the title of a document.
12514 \begin_inset Flex Code
12517 \begin_layout Plain Layout
12523 means that the macro with name
12524 \begin_inset Flex Code
12527 \begin_layout Plain Layout
12533 will be inserted after the last layout which has
12534 \begin_inset Quotes eld
12538 \begin_inset Flex Code
12541 \begin_layout Plain Layout
12543 \begin_inset space ~
12552 \begin_inset Quotes erd
12557 \begin_inset Flex Code
12560 \begin_layout Plain Layout
12566 corresponds to the case where all layouts which have
12567 \begin_inset Quotes eld
12571 \begin_inset Flex Code
12574 \begin_layout Plain Layout
12576 \begin_inset space ~
12585 \begin_inset Quotes erd
12588 should be enclosed into the
12589 \begin_inset Flex Code
12592 \begin_layout Plain Layout
12601 \begin_layout Description
12602 \begin_inset Flex Code
12605 \begin_layout Plain Layout
12612 \begin_inset Flex Code
12615 \begin_layout Plain Layout
12621 ] Sets which divisions are included in the table of contents.
12623 \begin_inset Flex Code
12626 \begin_layout Plain Layout
12632 counter in \SpecialChar LaTeX
12636 \begin_layout Subsection
12637 \begin_inset Flex Code
12640 \begin_layout Plain Layout
12647 \begin_inset CommandInset label
12649 name "subsec:ClassOptions"
12656 \begin_layout Standard
12658 \begin_inset Flex Code
12661 \begin_layout Plain Layout
12667 section can contain the following entries:
12670 \begin_layout Description
12671 \begin_inset Flex Code
12674 \begin_layout Plain Layout
12681 \begin_inset Flex Code
12684 \begin_layout Plain Layout
12690 ] The list of available font sizes for the document's main font,
12692 \begin_inset Quotes eld
12696 \begin_inset Flex Code
12699 \begin_layout Plain Layout
12706 \begin_inset Quotes erd
12711 \change_inserted -712698321 1565110196
12712 Any number is possible.
12715 \begin_layout Description
12717 \change_inserted -712698321 1565110259
12718 \begin_inset Flex Code
12721 \begin_layout Plain Layout
12723 \change_inserted -712698321 1565110199
12732 \begin_inset Flex Code
12735 \begin_layout Plain Layout
12737 \change_inserted -712698321 1565110196
12745 ] The format for the font size option.
12748 \begin_inset Flex Code
12751 \begin_layout Plain Layout
12753 \change_inserted -712698321 1565110238
12763 \begin_inset Flex Code
12766 \begin_layout Plain Layout
12768 \change_inserted -712698321 1565110248
12776 is a placeholder for the font size.
12781 \begin_layout Description
12783 \change_deleted 5863208 1594239483
12784 \begin_inset Flex Code
12787 \begin_layout Plain Layout
12793 Used to set the DTD line with XML-based output classes.
12795 \begin_inset space \thinspace{}
12800 \begin_inset Quotes eld
12803 -//OASIS//DTD DocBook V4.2//EN
12804 \begin_inset Quotes erd
12808 \change_inserted -712698321 1565101761
12812 \begin_layout Description
12814 \change_inserted -712698321 1565180598
12815 \begin_inset Flex Code
12818 \begin_layout Plain Layout
12820 \change_inserted -712698321 1565101918
12829 \begin_inset Flex Code
12832 \begin_layout Plain Layout
12834 \change_inserted -712698321 1565105399
12835 string="letter|\SpecialChar allowbreak
12836 legal|\SpecialChar allowbreak
12837 executive|\SpecialChar allowbreak
12838 a0|\SpecialChar allowbreak
12839 a1|\SpecialChar allowbreak
12840 a2|\SpecialChar allowbreak
12841 a3|\SpecialChar allowbreak
12842 a4|\SpecialChar allowbreak
12843 a5|\SpecialChar allowbreak
12844 a6|\SpecialChar allowbreak
12845 b0|\SpecialChar allowbreak
12846 b1|\SpecialChar allowbreak
12847 b2|\SpecialChar allowbreak
12848 b3|\SpecialChar allowbreak
12849 b4|\SpecialChar allowbreak
12850 b5|\SpecialChar allowbreak
12851 b6|\SpecialChar allowbreak
12852 c0|\SpecialChar allowbreak
12853 c1|\SpecialChar allowbreak
12854 c2|\SpecialChar allowbreak
12855 c3|\SpecialChar allowbreak
12856 c4|\SpecialChar allowbreak
12857 c5|\SpecialChar allowbreak
12858 c6|\SpecialChar allowbreak
12859 b0j|\SpecialChar allowbreak
12860 b1j|\SpecialChar allowbreak
12861 b2j|\SpecialChar allowbreak
12862 b3j|\SpecialChar allowbreak
12863 b4j|\SpecialChar allowbreak
12864 b5j|\SpecialChar allowbreak
12872 ] The list of available page sizes,
12874 \begin_inset Quotes eld
12878 \begin_inset Flex Code
12881 \begin_layout Plain Layout
12883 \change_inserted -712698321 1565101779
12892 \begin_inset Quotes erd
12897 only the listed sizes are supported.
12898 Other sizes might be entered as custom class option.
12901 \begin_layout Description
12903 \change_inserted -712698321 1565180623
12904 \begin_inset Flex Code
12907 \begin_layout Plain Layout
12909 \change_inserted -712698321 1565180605
12918 \begin_inset Flex Code
12921 \begin_layout Plain Layout
12923 \change_inserted -712698321 1565180601
12931 ] The format for the page size option.
12934 \begin_inset Flex Code
12937 \begin_layout Plain Layout
12939 \change_inserted -712698321 1565180618
12949 \begin_inset Flex Code
12952 \begin_layout Plain Layout
12954 \change_inserted -712698321 1565180601
12962 is a placeholder for the paper size.
12967 \begin_layout Description
12968 \begin_inset Flex Code
12971 \begin_layout Plain Layout
12978 \begin_inset Flex Code
12981 \begin_layout Plain Layout
12982 string="empty|plain|headings|fancy"
12987 ] The list of available page sty\SpecialChar softhyphen
12990 \begin_inset Quotes eld
12994 \begin_inset Flex Code
12997 \begin_layout Plain Layout
13004 \begin_inset Quotes erd
13010 \begin_layout Description
13011 \begin_inset Flex Code
13014 \begin_layout Plain Layout
13021 \begin_inset Flex Code
13024 \begin_layout Plain Layout
13030 ] Some document class options,
13031 separated by a comma,
13032 that will be added to the optional part of the
13033 \begin_inset Flex Code
13036 \begin_layout Plain Layout
13047 \begin_layout Standard
13049 \begin_inset Flex Code
13052 \begin_layout Plain Layout
13058 section must end with
13059 \begin_inset Quotes eld
13063 \begin_inset Flex Code
13066 \begin_layout Plain Layout
13073 \begin_inset Quotes erd
13079 \begin_layout Subsection
13081 \begin_inset CommandInset label
13083 name "subsec:Paragraph-Styles"
13090 \begin_layout Standard
13091 A paragraph style description looks like this:
13095 \begin_layout Plain Layout
13096 Note that this will either define a new style or modify an existing one.
13104 \begin_layout LyX-Code
13111 \begin_layout LyX-Code
13115 \begin_layout LyX-Code
13119 \begin_layout Standard
13120 where the following commands are allowed:
13123 \begin_layout Description
13124 \begin_inset Flex Code
13127 \begin_layout Plain Layout
13134 \begin_inset Flex Code
13137 \begin_layout Plain Layout
13143 =""] This paragraph will appear in the table of contents of the given type.
13144 An empty string disables.
13145 See also the OutlinerName and the IsTocCaption commands.
13150 \begin_layout Description
13151 \begin_inset Flex Code
13154 \begin_layout Plain Layout
13161 \begin_inset Flex Code
13164 \begin_layout Plain Layout
13177 ] Paragraph alignment.
13180 \begin_layout Description
13181 \begin_inset Flex Code
13184 \begin_layout Plain Layout
13191 \begin_inset Flex Code
13194 \begin_layout Plain Layout
13207 ] A comma separated list of permitted alignments.
13208 (Some \SpecialChar LaTeX
13209 styles prohibit certain alignments,
13210 since those wouldn't make sense.
13211 For example a right-aligned or centered enumeration isn't possible.)
13214 \begin_layout Description
13215 \begin_inset Flex Code
13218 \begin_layout Plain Layout
13225 \begin_inset Flex Code
13228 \begin_layout Plain Layout
13234 ] Defines argument number <int> of a command\SpecialChar breakableslash
13235 environment associated with the current style.
13237 \change_inserted -584632292 1615846868
13238 The definition must end with
13239 \begin_inset Flex Code
13242 \begin_layout Plain Layout
13244 \change_inserted -584632292 1615846867
13256 \change_inserted -584632292 1615846880
13258 \begin_inset CommandInset ref
13260 reference "subsec:Arguments"
13268 for more information.
13270 \change_deleted -584632292 1615846694
13271 This is useful for things like section headings,
13272 and only makes sense with \SpecialChar LaTeX
13274 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,
13275 where the number specifies the order of the arguments.
13276 The definition must end with
13277 \begin_inset Flex Code
13280 \begin_layout Plain Layout
13287 So a command with two optional arguments has:
13291 \begin_layout Quote
13293 \change_deleted -584632292 1615846694
13299 \begin_layout Quote
13301 \change_deleted -584632292 1615846694
13307 \begin_layout Quote
13309 \change_deleted -584632292 1615846694
13315 \begin_layout Quote
13317 \change_deleted -584632292 1615846694
13323 \begin_layout Quote
13325 \change_deleted -584632292 1615846694
13331 \begin_layout Quote
13333 \change_deleted -584632292 1615846694
13339 \begin_layout Standard
13341 \change_deleted -584632292 1615846694
13343 \begin_inset Flex Code
13346 \begin_layout Plain Layout
13353 the following specifications are possible:
13356 \begin_layout Itemize
13358 \change_deleted -584632292 1615846694
13359 \begin_inset Flex Code
13362 \begin_layout Plain Layout
13369 \begin_inset Flex Code
13372 \begin_layout Plain Layout
13378 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
13379 \begin_inset Flex Code
13382 \begin_layout Plain Layout
13390 you can define an accelerator by appending the respective character to the string,
13392 \begin_inset Quotes eld
13396 \begin_inset Quotes erd
13400 \begin_inset space \thinspace{}
13404 \begin_inset space \space{}
13408 \begin_inset Quotes eld
13412 \begin_inset Flex Code
13415 \begin_layout Plain Layout
13422 \begin_inset Quotes erd
13428 \begin_layout Itemize
13430 \change_deleted -584632292 1615846694
13431 \begin_inset Flex Code
13434 \begin_layout Plain Layout
13441 \begin_inset Flex Code
13444 \begin_layout Plain Layout
13450 A separate string for the menu.
13451 You can define an accelerator by appending the respective character to the string,
13453 \begin_inset Quotes eld
13457 \begin_inset Quotes erd
13461 \begin_inset space \thinspace{}
13465 \begin_inset space \space{}
13469 \begin_inset Quotes eld
13473 \begin_inset Flex Code
13476 \begin_layout Plain Layout
13483 \begin_inset Quotes erd
13487 This specification is optional.
13488 If it is not given the
13489 \begin_inset Flex Code
13492 \begin_layout Plain Layout
13498 will be used instead for the menu.
13501 \begin_layout Itemize
13503 \change_deleted -584632292 1615846694
13504 \begin_inset Flex Code
13507 \begin_layout Plain Layout
13514 \begin_inset Flex Code
13517 \begin_layout Plain Layout
13523 A longer explanatory text that appears in the tooltip when hovering over the argument inset.
13526 \begin_layout Itemize
13528 \change_deleted -584632292 1615846694
13529 \begin_inset Flex Code
13532 \begin_layout Plain Layout
13539 \begin_inset Flex Code
13542 \begin_layout Plain Layout
13551 \begin_inset space \thinspace{}
13555 \begin_inset Flex Code
13558 \begin_layout Plain Layout
13564 ] Declare if this is a mandatory (1) or an optional (0) argument.
13565 Mandatory arguments will be output empty if not given,
13566 while optional arguments will not be output at all.
13568 mandatory arguments are delimited by
13569 \begin_inset Flex Code
13572 \begin_layout Plain Layout
13579 while optional arguments are delimited by
13580 \begin_inset Flex Code
13583 \begin_layout Plain Layout
13592 \begin_layout Itemize
13594 \change_deleted -584632292 1615846694
13595 \begin_inset Flex Code
13598 \begin_layout Plain Layout
13600 \change_inserted -712698321 1555579780
13609 \begin_inset Flex Code
13612 \begin_layout Plain Layout
13614 \change_inserted -712698321 1555579780
13622 Option to define a different command (from the default
13623 \begin_inset Flex Code
13626 \begin_layout Plain Layout
13628 \change_inserted -712698321 1555579780
13640 ) to be used for line breaks.
13641 The initial backslash must not be specified.
13644 \begin_layout Itemize
13646 \change_deleted -584632292 1615846694
13647 \begin_inset Flex Code
13650 \begin_layout Plain Layout
13657 \begin_inset Flex Code
13660 \begin_layout Plain Layout
13666 defines another argument (by its number) which this argument requires to be output if it is itself output.
13668 \begin_inset space \thinspace{}
13672 in \SpecialChar LaTeX
13674 optional arguments often require previous optional arguments to be output (at least empty),
13676 \begin_inset Flex Code
13679 \begin_layout Plain Layout
13682 command[][argument]{text}
13688 This can be achieved by the statement
13689 \begin_inset Flex Code
13692 \begin_layout Plain Layout
13699 \begin_inset Flex Code
13702 \begin_layout Plain Layout
13711 \begin_layout Itemize
13713 \change_deleted -584632292 1615846694
13714 \begin_inset Flex Code
13717 \begin_layout Plain Layout
13724 \begin_inset Flex Code
13727 \begin_layout Plain Layout
13733 defines a custom left delimiter (instead of
13734 \begin_inset Flex Code
13737 \begin_layout Plain Layout
13744 \begin_inset Flex Code
13747 \begin_layout Plain Layout
13754 A line break in the output can be indicated by
13755 \begin_inset Flex Code
13758 \begin_layout Plain Layout
13767 \begin_layout Itemize
13769 \change_deleted -584632292 1615846694
13770 \begin_inset Flex Code
13773 \begin_layout Plain Layout
13780 \begin_inset Flex Code
13783 \begin_layout Plain Layout
13789 defines a custom right delimiter (instead of
13790 \begin_inset Flex Code
13793 \begin_layout Plain Layout
13800 \begin_inset Flex Code
13803 \begin_layout Plain Layout
13810 A line break in the output can be indicated by
13811 \begin_inset Flex Code
13814 \begin_layout Plain Layout
13823 \begin_layout Itemize
13825 \change_deleted -584632292 1615846694
13826 \begin_inset Flex Code
13829 \begin_layout Plain Layout
13836 \begin_inset Flex Code
13839 \begin_layout Plain Layout
13845 defines an argument that is inserted if and only if no user-specified arguments were given,
13847 \begin_inset space \thinspace{}
13851 \begin_inset space \space{}
13854 if no argument inset has been inserted (note that also an empty argument inset omits the DefaultArg).
13855 Multiple arguments need to be separated by comma.
13858 \begin_layout Itemize
13860 \change_deleted -584632292 1615846694
13861 \begin_inset Flex Code
13864 \begin_layout Plain Layout
13871 \begin_inset Flex Code
13874 \begin_layout Plain Layout
13880 defines an argument that is inserted in any case (alone or in addition to user-specified arguments).
13881 Multiple arguments need to be separated by comma.
13884 \begin_layout Itemize
13886 \change_deleted -584632292 1615846694
13887 \begin_inset Flex Code
13890 \begin_layout Plain Layout
13896 The font used for the argument content,
13898 \begin_inset CommandInset ref
13900 reference "subsec:Font-description"
13908 \begin_layout Itemize
13910 \change_deleted -584632292 1615846694
13911 \begin_inset Flex Code
13914 \begin_layout Plain Layout
13916 \change_inserted -712698321 1559484228
13925 \begin_inset Flex Code
13928 \begin_layout Plain Layout
13930 \change_inserted -712698321 1559484228
13941 \begin_inset space \thinspace{}
13945 \begin_inset Flex Code
13948 \begin_layout Plain Layout
13950 \change_inserted -712698321 1559484228
13958 ] As with paragraph styles,
13960 \begin_inset CommandInset ref
13962 reference "subsec:Paragraph-Styles"
13970 \begin_layout Itemize
13972 \change_deleted -584632292 1615846694
13973 \begin_inset Flex Code
13976 \begin_layout Plain Layout
13982 The font used for the label;
13984 \begin_inset CommandInset ref
13986 reference "subsec:Font-description"
13994 \begin_layout Itemize
13996 \change_deleted -584632292 1615846694
13997 \begin_inset Flex Code
14000 \begin_layout Plain Layout
14007 \begin_inset Flex Code
14010 \begin_layout Plain Layout
14022 ] describes the rendering style used for the inset's frame and buttons.
14025 \begin_layout Itemize
14027 \change_deleted -584632292 1615846694
14028 \begin_inset Flex Code
14031 \begin_layout Plain Layout
14038 \begin_inset Flex Code
14041 \begin_layout Plain Layout
14048 \begin_inset Flex Code
14051 \begin_layout Plain Layout
14058 this argument is automatically inserted when the respective style is selected.
14060 \change_deleted -712698321 1559484200
14062 only one argument per style\SpecialChar breakableslash
14063 layout can be automatically inserted.
14064 \change_deleted -584632292 1615846694
14068 \begin_layout Itemize
14070 \change_deleted -584632292 1615846694
14071 \begin_inset Flex Code
14074 \begin_layout Plain Layout
14076 \change_inserted -712698321 1559490711
14085 \begin_inset Flex Code
14088 \begin_layout Plain Layout
14090 \change_inserted -712698321 1559490703
14099 \begin_inset Flex Code
14102 \begin_layout Plain Layout
14104 \change_inserted -712698321 1559490703
14113 this argument will be inserted on a new line with
14114 \begin_inset Flex Code
14117 \begin_layout Plain Layout
14119 \change_inserted -712698321 1559491402
14127 (only available within Flex insets).
14130 \begin_layout Itemize
14132 \change_deleted -584632292 1615846694
14133 \begin_inset Flex Code
14136 \begin_layout Plain Layout
14143 \begin_inset Flex Code
14146 \begin_layout Plain Layout
14153 \begin_inset Flex Code
14156 \begin_layout Plain Layout
14163 this argument will be inserted with a copy of the co-text (either selected text or the whole paragraph) as content.
14166 \begin_layout Itemize
14168 \change_deleted -584632292 1615846694
14169 \begin_inset Flex Code
14172 \begin_layout Plain Layout
14179 \begin_inset Flex Code
14182 \begin_layout Plain Layout
14194 ] Whether the contents of this argument should be output in raw form,
14195 meaning without special translations that \SpecialChar LaTeX
14199 \begin_inset Flex Code
14202 \begin_layout Plain Layout
14208 status is inherited by the inset or paragraph layout the argument belongs to,
14209 true and false change the status for the given argument only.
14212 \begin_layout Itemize
14214 \change_deleted -584632292 1615846694
14215 \begin_inset Flex Code
14218 \begin_layout Plain Layout
14225 \begin_inset Flex Code
14228 \begin_layout Plain Layout
14229 string of characters
14238 Defines individual characters
14239 \begin_inset Newline linebreak
14242 that should be output in raw form,
14243 meaning without special translations that \SpecialChar LaTeX
14246 contrary to PassThru,
14247 this needs to be explicitly defined for arguments.
14249 arguments do not inherit PassThruChars from their parent inset or layout.
14252 \begin_layout Itemize
14254 \change_deleted -584632292 1615846694
14255 \begin_inset Flex Code
14258 \begin_layout Plain Layout
14265 \begin_inset Flex Code
14268 \begin_layout Plain Layout
14277 \begin_inset space \thinspace{}
14281 \begin_inset Flex Code
14284 \begin_layout Plain Layout
14290 ] If this is set to 1,
14291 the argument will output its content in the corresponding item in the table of contents.
14295 \begin_layout Standard
14297 \change_deleted -584632292 1615846694
14299 the text entered in the \SpecialChar LyX
14300 workarea in the respective layout is the last (mandatory) argument of a command if the
14301 \begin_inset Flex Code
14304 \begin_layout Plain Layout
14311 \begin_inset Flex Code
14314 \begin_layout Plain Layout
14322 arguments with the prefix
14323 \begin_inset Flex Code
14326 \begin_layout Plain Layout
14332 are output after this workarea argument.
14333 Note that post-argument numbering restarts at 1,
14334 so the first argument following the workarea argument is
14335 \begin_inset Flex Code
14338 \begin_layout Plain Layout
14345 Post-arguments are ignored in any other
14346 \begin_inset Flex Code
14349 \begin_layout Plain Layout
14356 \begin_inset Flex Code
14359 \begin_layout Plain Layout
14368 \begin_layout Standard
14370 \change_deleted -584632292 1615846694
14372 \begin_inset Flex Code
14375 \begin_layout Plain Layout
14384 \begin_inset Flex Code
14387 \begin_layout Plain Layout
14396 \begin_inset Flex Code
14399 \begin_layout Plain Layout
14405 followed by the number (e.
14406 \begin_inset space \thinspace{}
14410 \begin_inset space \space{}
14414 \begin_inset Flex Code
14417 \begin_layout Plain Layout
14426 \begin_layout Standard
14428 \change_deleted -584632292 1615846694
14430 there is a special argument type with the prefix
14431 \begin_inset Flex Code
14434 \begin_layout Plain Layout
14436 \change_inserted -712698321 1534487844
14445 It is not really an argument,
14446 but uses the argument interface (thus,
14447 the prefix is also followed by a number,
14449 \begin_inset space \thinspace{}
14454 \begin_inset Flex Code
14457 \begin_layout Plain Layout
14459 \change_inserted -712698321 1534488412
14460 Argument listpreamble:1
14468 As the name implies,
14469 it is targeted at lists such as
14489 Its content will be output at the list start,
14491 \begin_inset Flex Code
14494 \begin_layout Plain Layout
14496 \change_inserted -712698321 1534488058
14507 on an own line (a place that is otherwise not accessible in \SpecialChar LyX
14510 users can insert redefinitions (of lengths etc.) to individual lists.
14512 these arguments do not have a delimiter.
14518 \begin_layout Description
14519 \begin_inset Flex Code
14522 \begin_layout Plain Layout
14528 Includes a comma-separated list of layouts that should be nested in and after the current layout.
14529 Only makes sense for nestable layouts (such as environments).
14531 \begin_inset Quotes eld
14535 \begin_inset Flex Code
14538 \begin_layout Plain Layout
14545 \begin_inset Quotes erd
14550 \begin_inset Flex Code
14553 \begin_layout Plain Layout
14562 \begin_layout Description
14563 \begin_inset Flex Code
14566 \begin_layout Plain Layout
14572 Note that this will completely override any prior
14573 \begin_inset Flex Code
14576 \begin_layout Plain Layout
14582 declaration for this style.
14584 \begin_inset Quotes eld
14588 \begin_inset Flex Code
14591 \begin_layout Plain Layout
14598 \begin_inset Quotes erd
14603 \begin_inset CommandInset ref
14605 reference "subsec:I18n"
14610 for details on its use.
14613 \begin_layout Description
14614 \begin_inset Flex Code
14617 \begin_layout Plain Layout
14624 \begin_inset Flex Code
14627 \begin_layout Plain Layout
14637 \begin_layout Plain Layout
14638 Note that a `float' here is a real number,
14645 The vertical space with which the last of a chain of paragraphs with this style is separated from the following paragraph.
14646 If the next paragraph has another style,
14647 the separations are not simply added,
14648 but the maximum is taken.
14651 \begin_layout Description
14652 \begin_inset Flex Code
14655 \begin_layout Plain Layout
14662 \begin_inset Flex Code
14665 \begin_layout Plain Layout
14671 ] The category for this style.
14672 This is used to group related styles in the style combobox on the toolbar.
14673 Any string can be used,
14674 but you may want to use existing categories with your own styles.
14678 \begin_layout Description
14680 \change_deleted 1075283030 1672014981
14681 \begin_inset Flex Code
14684 \begin_layout Plain Layout
14690 Depth of XML command.
14691 Used only with XML-type formats.
14694 \begin_layout Description
14695 \begin_inset Flex Code
14698 \begin_layout Plain Layout
14705 \begin_inset Flex Code
14708 \begin_layout Plain Layout
14714 ] Copies all the features of an existing style into the current one.
14716 \change_inserted -584632292 1678808972
14717 Note that this copies the style as it is defined at that point.
14718 Later changes to it will not affect styles into which it has been copied.
14723 \begin_layout Description
14725 \change_inserted 1075283030 1672014806
14726 \begin_inset Flex Code
14729 \begin_layout Plain Layout
14731 \change_inserted 1075283030 1671679781
14732 DocBookGenerateTitle
14740 \begin_inset Flex Code
14743 \begin_layout Plain Layout
14745 \change_inserted 1075283030 1672014763
14754 \begin_inset Flex Code
14757 \begin_layout Plain Layout
14759 \change_inserted 1075283030 1672014789
14767 tag after the wrapper tag.
14768 This parameter should only be used with
14769 \begin_inset Flex Code
14772 \begin_layout Plain Layout
14774 \change_inserted 1075283030 1671679828
14783 otherwise the title will be output
14787 the contents of the environment.
14788 The generated title is the same as the LyXHTML label:
14789 a combination of the environment type and its number.
14790 A major use is when DocBook has no close mapping for LaTeX environments and users must fallback to using a generic container such as
14791 \begin_inset Flex Code
14794 \begin_layout Plain Layout
14796 \change_inserted 1075283030 1672014801
14805 which requires a title although there is none in LaTeX.
14806 This feature is heavily used for theorem-like environments.
14811 \begin_layout Description
14812 \begin_inset Flex Code
14815 \begin_layout Plain Layout
14822 \begin_inset Flex Code
14825 \begin_layout Plain Layout
14831 ] The name of a style whose preamble should be output
14836 This allows to ensure some ordering of the preamble snippets when macros definitions depend on one another.
14840 \begin_layout Plain Layout
14842 besides that functionality,
14843 there is no way to ensure any ordering of preambles.
14844 The ordering that you see in a given version of \SpecialChar LyX
14845 may change without warning in later versions.
14853 \begin_layout Description
14854 \begin_inset Flex Code
14857 \begin_layout Plain Layout
14864 \begin_inset Flex Code
14867 \begin_layout Plain Layout
14880 ] The type of label that stands at the end of the paragraph (or sequence of paragraphs if
14881 \begin_inset Flex Code
14884 \begin_layout Plain Layout
14891 \begin_inset Newline newline
14895 \begin_inset Flex Code
14898 \begin_layout Plain Layout
14906 \begin_inset Flex Code
14909 \begin_layout Plain Layout
14916 \begin_inset Flex Code
14919 \begin_layout Plain Layout
14927 \begin_inset Flex Code
14930 \begin_layout Plain Layout
14937 \begin_inset Quotes eld
14941 \begin_inset Quotes erd
14946 \begin_inset Flex Code
14949 \begin_layout Plain Layout
14956 \begin_inset space \space{}
14960 \begin_inset Flex Code
14963 \begin_layout Plain Layout
14969 ) is a white (resp.
14970 \begin_inset space ~
14973 black) square suitable for end of proof markers,
14975 \begin_inset Flex Code
14978 \begin_layout Plain Layout
14984 is an explicit text string.
14987 \begin_layout Description
14988 \begin_inset Flex Code
14991 \begin_layout Plain Layout
14998 \begin_inset Flex Code
15001 \begin_layout Plain Layout
15007 ] The string used for a label with a
15008 \begin_inset Flex Code
15011 \begin_layout Plain Layout
15018 \begin_inset Newline newline
15022 \begin_inset Flex Code
15025 \begin_layout Plain Layout
15035 \begin_layout Description
15036 \begin_inset Flex Code
15039 \begin_layout Plain Layout
15045 The font used for both the text body
15051 \begin_inset CommandInset ref
15053 reference "subsec:Font-description"
15059 Note that defining this font automatically defines the
15060 \begin_inset Flex Code
15063 \begin_layout Plain Layout
15070 So you should define this one first if you also want to define
15071 \begin_inset Flex Code
15074 \begin_layout Plain Layout
15083 \begin_layout Description
15084 \begin_inset Flex Code
15087 \begin_layout Plain Layout
15094 \begin_inset Flex Code
15097 \begin_layout Plain Layout
15103 ] Used for backporting new styles to stable \SpecialChar LyX
15105 The first stable version that supports this tag is \SpecialChar LyX
15107 The argument is a number which may either be 0,
15108 -1 or any value greater than zero.
15110 \begin_inset Flex Code
15113 \begin_layout Plain Layout
15119 flag of a style is greater than zero,
15120 it will always be written to the document header.
15121 If a .lyx file is read,
15122 the style definitions from the document header are added to the document class.
15123 Therefore even older \SpecialChar LyX
15124 versions can handle the style.
15126 \begin_inset Flex Code
15129 \begin_layout Plain Layout
15135 is a version number:
15136 if the style is read,
15137 and the version number is less than the version number of the already existing style in the document class,
15138 the new style is ignored.
15139 If the version number is greater,
15140 the new style replaces the existing style.
15141 A value of -1 means an infinite version number,
15143 \begin_inset space \thinspace{}
15147 \begin_inset space \space{}
15150 the style is always used.
15153 \begin_layout Description
15154 \begin_inset Flex Code
15157 \begin_layout Plain Layout
15164 \begin_inset Flex Code
15167 \begin_layout Plain Layout
15176 \begin_inset space \thinspace{}
15180 \begin_inset Flex Code
15183 \begin_layout Plain Layout
15189 ] Usually \SpecialChar LyX
15190 does not allow you to insert more than one space between words,
15191 since a space is considered as the separation between two words,
15192 not a character or symbol of its own.
15193 This is a very fine thing but sometimes annoying,
15195 when typing program code or plain \SpecialChar LaTeX
15199 \begin_inset Flex Code
15202 \begin_layout Plain Layout
15210 \change_deleted -495245474 1550490105
15215 \change_deleted 177693 1654669077
15217 \change_inserted 177693 1654669079
15221 \change_deleted 177693 1654669082
15223 \change_inserted 177693 1654669082
15226 for the additional blanks when
15227 \change_deleted 34634807 1619626461
15231 \change_inserted -495245474 1550490096
15233 \begin_inset Flex Code
15236 \begin_layout Plain Layout
15238 \change_inserted -495245474 1550490089
15247 \change_deleted -495245474 1550490116
15248 another mode than \SpecialChar LaTeX
15251 \change_inserted -495245474 1550247760
15253 \begin_inset Flex Code
15256 \begin_layout Plain Layout
15258 \change_inserted -495245474 1550247736
15267 \begin_inset Flex Code
15270 \begin_layout Plain Layout
15272 \change_inserted -495245474 1550247755
15285 \begin_layout Description
15286 \begin_inset Flex Code
15289 \begin_layout Plain Layout
15295 These tags are used with XHTML output.
15297 \begin_inset CommandInset ref
15299 reference "subsec:Paragraph-Style-XHTML"
15307 \begin_layout Description
15309 \change_deleted 1075283030 1672014684
15310 \begin_inset Flex Code
15313 \begin_layout Plain Layout
15319 [FIXME] (Used only with XML-type formats.)
15324 \begin_layout Description
15325 \begin_inset Flex Code
15328 \begin_layout Plain Layout
15335 \begin_inset Flex Code
15338 \begin_layout Plain Layout
15347 \begin_inset space \thinspace{}
15351 \begin_inset Flex Code
15354 \begin_layout Plain Layout
15361 \begin_inset Flex Code
15364 \begin_layout Plain Layout
15371 marks the style as to be included in the document preamble and not in the document body.
15372 This is useful for document classes that want such information as the title and author to appear in the preamble.
15373 Note that this works only for styles for which the
15374 \begin_inset Flex Code
15377 \begin_layout Plain Layout
15384 \begin_inset Flex Code
15387 \begin_layout Plain Layout
15394 \begin_inset Flex Code
15397 \begin_layout Plain Layout
15406 \begin_layout Description
15407 \begin_inset Flex Code
15410 \begin_layout Plain Layout
15417 \begin_inset Flex Code
15420 \begin_layout Plain Layout
15429 \begin_inset space \thinspace{}
15433 \begin_inset Flex Code
15436 \begin_layout Plain Layout
15443 \begin_inset Flex Code
15446 \begin_layout Plain Layout
15453 marks the style as being part of a title block (see also the
15454 \begin_inset Flex Code
15457 \begin_layout Plain Layout
15464 \begin_inset Flex Code
15467 \begin_layout Plain Layout
15476 \begin_layout Description
15477 \begin_inset Flex Code
15480 \begin_layout Plain Layout
15486 Includes a comma-separated list of layouts after which this one should be nested.
15487 Only makes sense with regard to nestable layouts (such as environments).
15489 \begin_inset Quotes eld
15493 \begin_inset Flex Code
15496 \begin_layout Plain Layout
15503 \begin_inset Quotes erd
15508 \begin_inset Flex Code
15511 \begin_layout Plain Layout
15520 \begin_layout Description
15521 \begin_inset Flex Code
15524 \begin_layout Plain Layout
15531 \begin_inset Flex Code
15534 \begin_layout Plain Layout
15543 \begin_inset space \thinspace{}
15547 \begin_inset Flex Code
15550 \begin_layout Plain Layout
15556 ] If this is set to 1 and AddToToc is enabled,
15557 the paragraph adds a summary of its contents in its item in the table of contents.
15564 \begin_layout Description
15565 \begin_inset Flex Code
15568 \begin_layout Plain Layout
15575 \begin_inset Flex Code
15578 \begin_layout Plain Layout
15584 ] The \SpecialChar LaTeX
15585 command sequence declaring an item in a list.
15586 The command is to be defined without the preceding backslash (the default is
15587 \begin_inset Quotes eld
15591 \begin_inset Quotes erd
15596 \begin_inset Flex Code
15599 \begin_layout Plain Layout
15607 in the \SpecialChar LaTeX
15611 \begin_layout Description
15612 \begin_inset Flex Code
15615 \begin_layout Plain Layout
15622 \begin_inset Flex Code
15625 \begin_layout Plain Layout
15631 ] This provides extra space between paragraphs that have the same style.
15632 If you put other styles into an environment,
15633 each is separated with the environment's
15634 \begin_inset Flex Code
15637 \begin_layout Plain Layout
15644 But the whole items of the environment are additionally separated with this
15645 \begin_inset Flex Code
15648 \begin_layout Plain Layout
15655 Note that this is a
15660 \begin_layout Description
15662 \change_deleted 1075283030 1672014680
15663 \begin_inset Flex Code
15666 \begin_layout Plain Layout
15672 [FIXME] (Used only with XML-type formats.)
15677 \begin_layout Description
15678 \begin_inset Flex Code
15681 \begin_layout Plain Layout
15688 \begin_inset Flex Code
15691 \begin_layout Plain Layout
15700 \begin_inset space \thinspace{}
15704 \begin_inset Flex Code
15707 \begin_layout Plain Layout
15713 ] Usually \SpecialChar LyX
15714 does not allow you to leave a paragraph empty,
15715 since it would lead to empty \SpecialChar LaTeX
15717 There are some cases where this could be desirable however:
15718 in a letter template,
15719 the required fields can be provided as empty fields,
15720 so that people do not forget them;
15721 in some special classes,
15722 a style can be used as some kind of break,
15723 which does not contain actual text.
15726 \begin_layout Description
15727 \begin_inset Flex Code
15730 \begin_layout Plain Layout
15737 \begin_inset Flex Code
15740 \begin_layout Plain Layout
15746 ] The vertical space between the label and the text body.
15747 Only used for labels that are above the text body (
15748 \begin_inset Flex Code
15751 \begin_layout Plain Layout
15758 \begin_inset Newline newline
15762 \begin_inset Flex Code
15765 \begin_layout Plain Layout
15766 Centered_Top_Environment
15774 \begin_layout Description
15775 \begin_inset Flex Code
15778 \begin_layout Plain Layout
15785 \begin_inset Flex Code
15788 \begin_layout Plain Layout
15794 ] The name of the counter for automatic numbering.
15795 In order to have the counter appear with your label,
15796 you will need to reference it in the
15797 \begin_inset Flex Code
15800 \begin_layout Plain Layout
15809 This will work with
15810 \begin_inset Flex Code
15813 \begin_layout Plain Layout
15821 \begin_inset Flex Code
15824 \begin_layout Plain Layout
15832 \begin_inset Flex Code
15835 \begin_layout Plain Layout
15842 \begin_inset Flex Code
15845 \begin_layout Plain Layout
15853 \begin_inset Newline newline
15861 \begin_inset Flex Code
15864 \begin_layout Plain Layout
15871 \begin_inset Flex Code
15874 \begin_layout Plain Layout
15881 though this case is a bit complicated.
15882 Suppose you declare
15883 \begin_inset Quotes eld
15887 \begin_inset Flex Code
15890 \begin_layout Plain Layout
15891 LabelCounter myenum
15897 \begin_inset Quotes erd
15901 Then the actual counters used are
15902 \begin_inset Flex Code
15905 \begin_layout Plain Layout
15913 \begin_inset Flex Code
15916 \begin_layout Plain Layout
15924 \begin_inset Flex Code
15927 \begin_layout Plain Layout
15934 \begin_inset Flex Code
15937 \begin_layout Plain Layout
15944 much as in \SpecialChar LaTeX
15946 These counters must all be declared separately.
15947 \begin_inset Newline newline
15951 \begin_inset CommandInset ref
15953 reference "subsec:Counters"
15958 for details on counters.
15961 \begin_layout Description
15962 \begin_inset Flex Code
15965 \begin_layout Plain Layout
15971 The font used for the label.
15973 \begin_inset CommandInset ref
15975 reference "subsec:Font-description"
15983 \begin_layout Description
15984 \begin_inset Flex Code
15987 \begin_layout Plain Layout
15994 \begin_inset Flex Code
15997 \begin_layout Plain Layout
16003 ] Text that indicates how far a label should be indented.
16006 \begin_layout Description
16007 \begin_inset Flex Code
16010 \begin_layout Plain Layout
16017 \begin_inset Flex Code
16020 \begin_layout Plain Layout
16026 ] Text that indicates the amount of horizontal space between the label and the text body.
16027 Only used for labels that are not above the text body.
16030 \begin_layout Description
16031 \begin_inset Flex Code
16034 \begin_layout Plain Layout
16041 \begin_inset Flex Code
16044 \begin_layout Plain Layout
16050 ] The string used for the label.
16052 \begin_inset Flex Code
16055 \begin_layout Plain Layout
16062 this string can be contain the special formatting commands described in
16063 \begin_inset CommandInset ref
16065 reference "subsec:Counters"
16073 \begin_layout Description
16074 \begin_inset Flex Code
16077 \begin_layout Plain Layout
16078 LabelStringAppendix
16084 \begin_inset Flex Code
16087 \begin_layout Plain Layout
16093 ] This is used inside the appendix instead of
16094 \begin_inset Newline newline
16098 \begin_inset Flex Code
16101 \begin_layout Plain Layout
16109 \begin_inset Flex Code
16112 \begin_layout Plain Layout
16119 \begin_inset Newline newline
16123 \begin_inset Flex Code
16126 \begin_layout Plain Layout
16127 LabelStringAppendix
16133 \change_deleted 1075283030 1672015070
16137 \begin_layout Description
16139 \change_deleted 1075283030 1672015070
16140 \begin_inset Flex Code
16143 \begin_layout Plain Layout
16149 [FIXME] (Used only with XML-type formats.)
16154 \begin_layout Description
16155 \begin_inset Flex Code
16158 \begin_layout Plain Layout
16165 \begin_inset Flex Code
16168 \begin_layout Plain Layout
16178 \begin_inset Newline newline
16184 \begin_inset Newline newline
16197 \begin_layout Description
16198 \begin_inset Flex Code
16201 \begin_layout Plain Layout
16207 means the label is the very first word (up to the first real blank).
16209 \change_deleted 177693 1654669087
16211 \change_inserted 177693 1654669089
16214 spaces if you want more than one word as the label.
16218 \begin_layout Description
16219 \begin_inset Flex Code
16222 \begin_layout Plain Layout
16228 means the label is simply what is declared as
16229 \begin_inset Flex Code
16232 \begin_layout Plain Layout
16239 This will be displayed
16240 \begin_inset Quotes eld
16244 \begin_inset Quotes erd
16248 at the beginning of the paragraph.
16250 \begin_inset Flex Code
16253 \begin_layout Plain Layout
16260 \begin_inset Flex Code
16263 \begin_layout Plain Layout
16270 then it will be displayed only in the first paragraph of any sequence of paragraphs with the same
16271 \begin_inset Flex Code
16274 \begin_layout Plain Layout
16283 \begin_layout Description
16284 \begin_inset Flex Code
16287 \begin_layout Plain Layout
16294 \begin_inset space ~
16298 \begin_inset space ~
16302 \begin_inset Flex Code
16305 \begin_layout Plain Layout
16311 are special cases of
16312 \begin_inset Flex Code
16315 \begin_layout Plain Layout
16322 The label will be printed above the paragraph either at the beginning of the line or centered.
16325 \begin_layout Description
16326 \begin_inset Flex Code
16329 \begin_layout Plain Layout
16335 is a special case for the caption-labels
16336 \begin_inset Quotes eld
16340 \begin_inset Quotes erd
16344 \begin_inset Quotes eld
16348 \begin_inset Quotes erd
16352 \begin_inset Newline newline
16356 \begin_inset Flex Code
16359 \begin_layout Plain Layout
16365 means the (hardcoded) label string depends on the kind of float:
16366 It is hardcoded to be `FloatType N',
16367 where N is the value of the counter associated with the float.
16368 For the case that a caption is inserted outside of a float the
16369 \begin_inset Flex Code
16372 \begin_layout Plain Layout
16379 \begin_inset Quotes eld
16383 \begin_inset Quotes erd
16389 \begin_layout Description
16390 \begin_inset Flex Code
16393 \begin_layout Plain Layout
16399 produces the usual sort of enumeration labels.
16400 The number type needs to be set in the
16406 \begin_inset CommandInset ref
16408 reference "subsec:Counters"
16416 \begin_layout Description
16417 \begin_inset Flex Code
16420 \begin_layout Plain Layout
16426 produces various bullets at the different levels.
16427 The bullet types displayed can be set via
16428 \begin_inset Flex Noun
16431 \begin_layout Plain Layout
16432 Document\SpecialChar menuseparator
16433 Settings\SpecialChar menuseparator
16442 \begin_layout Description
16443 \begin_inset Flex Code
16446 \begin_layout Plain Layout
16452 should be used only with
16453 \begin_inset Flex Code
16456 \begin_layout Plain Layout
16457 LatexType BibEnvironment
16466 \begin_layout Description
16467 \begin_inset Flex Code
16470 \begin_layout Plain Layout
16476 Note that this will completely override any prior
16477 \begin_inset Flex Code
16480 \begin_layout Plain Layout
16486 declaration for this style.
16488 \begin_inset Quotes eld
16492 \begin_inset Flex Code
16495 \begin_layout Plain Layout
16502 \begin_inset Quotes erd
16507 \begin_inset CommandInset ref
16509 reference "subsec:I18n"
16514 for details on its use.
16517 \begin_layout Description
16518 \begin_inset Flex Code
16521 \begin_layout Plain Layout
16528 \begin_inset Flex Code
16531 \begin_layout Plain Layout
16537 ] The name of the corresponding \SpecialChar LaTeX
16539 Either the environment or command name.
16542 \begin_layout Description
16543 \begin_inset Flex Code
16546 \begin_layout Plain Layout
16553 \begin_inset Flex Code
16556 \begin_layout Plain Layout
16562 ] An optional parameter for the corresponding
16563 \begin_inset Flex Code
16566 \begin_layout Plain Layout
16573 This parameter cannot be changed from within \SpecialChar LyX
16575 \begin_inset Flex Code
16578 \begin_layout Plain Layout
16584 for customizable parameters).
16585 This will be output as is after all \SpecialChar LaTeX
16587 \begin_inset Flex Code
16590 \begin_layout Plain Layout
16599 \begin_layout Description
16600 \begin_inset Flex Code
16603 \begin_layout Plain Layout
16610 \begin_inset Flex Code
16613 \begin_layout Plain Layout
16622 \begin_inset Newline newline
16631 ] How the style should be translated into \SpecialChar LaTeX
16636 \begin_layout Plain Layout
16637 \begin_inset Flex Code
16640 \begin_layout Plain Layout
16646 is perhaps a bit misleading,
16647 since these rules apply to SGML classes,
16649 Visit the SGML class files for specific examples.
16658 \begin_layout Description
16659 \begin_inset Flex Code
16662 \begin_layout Plain Layout
16668 means nothing special.
16671 \begin_layout Description
16672 \begin_inset Flex Code
16675 \begin_layout Plain Layout
16682 \begin_inset Flex Code
16685 \begin_layout Plain Layout
16692 {\SpecialChar ldots
16701 \begin_layout Description
16702 \begin_inset Flex Code
16705 \begin_layout Plain Layout
16712 \begin_inset Flex Code
16715 \begin_layout Plain Layout
16722 }\SpecialChar ldots
16738 \begin_layout Description
16739 \begin_inset Flex Code
16742 \begin_layout Plain Layout
16749 \begin_inset Flex Code
16752 \begin_layout Plain Layout
16760 \begin_inset Flex Code
16763 \begin_layout Plain Layout
16771 is generated for each paragraph of this environment.
16775 \begin_layout Description
16776 \begin_inset Flex Code
16779 \begin_layout Plain Layout
16786 \begin_inset Flex Code
16789 \begin_layout Plain Layout
16797 \begin_inset Newline newline
16801 \begin_inset Flex Code
16804 \begin_layout Plain Layout
16810 is passed as an argument to the environment.
16811 \begin_inset Newline newline
16815 \begin_inset Flex Code
16818 \begin_layout Plain Layout
16824 can be defined in the
16825 \begin_inset Flex Noun
16828 \begin_layout Plain Layout
16829 Edit\SpecialChar menuseparator
16831 \begin_inset space ~
16842 \begin_layout Description
16843 \begin_inset Flex Code
16846 \begin_layout Plain Layout
16853 \begin_inset Flex Code
16856 \begin_layout Plain Layout
16862 but adds the necessary mandatory argument (the longest label) to the begin statement of the bibliography environment:
16863 \begin_inset Newline newline
16867 \begin_inset Flex Code
16870 \begin_layout Plain Layout
16873 begin{thebibliography}{99}
16879 It is therefore only useful for bibliography environments.
16880 The default longest label
16881 \begin_inset Quotes eld
16885 \begin_inset Quotes erd
16888 can be changed by the user in the paragraph settings of a bibliography item.
16891 \begin_layout Standard
16892 Putting the last few things together,
16893 the \SpecialChar LaTeX
16894 output will be either:
16898 \begin_layout LyX-Code
16901 LatexName[LatexParam]{\SpecialChar ldots
16905 \begin_layout Standard
16910 \begin_layout LyX-Code
16913 begin{LatexName}[LatexParam] \SpecialChar ldots
16919 \begin_layout Standard
16920 depending upon the \SpecialChar LaTeX
16925 \begin_layout Description
16926 \begin_inset Flex Code
16929 \begin_layout Plain Layout
16936 \begin_inset Flex Code
16939 \begin_layout Plain Layout
16945 ] A string that is put at the beginning of the style content.
16946 A line break in the output can be indicated by
16947 \begin_inset Flex Code
16950 \begin_layout Plain Layout
16959 \begin_layout Description
16960 \begin_inset Flex Code
16963 \begin_layout Plain Layout
16970 \begin_inset Flex Code
16973 \begin_layout Plain Layout
16979 ] If you put styles into environments,
16981 \begin_inset Flex Code
16984 \begin_layout Plain Layout
16990 are not simply added,
16991 but added with a factor
16992 \begin_inset Formula $\frac{4}{\mathrm{depth}+4}$
16996 Note that this parameter is also used when
16997 \begin_inset Flex Code
17000 \begin_layout Plain Layout
17007 \begin_inset Flex Code
17010 \begin_layout Plain Layout
17017 \begin_inset Flex Code
17020 \begin_layout Plain Layout
17027 Then it is added to the manual or dynamic margin.
17028 \begin_inset Newline newline
17032 \begin_inset Quotes eld
17036 \begin_inset Flex Code
17039 \begin_layout Plain Layout
17046 \begin_inset Quotes erd
17049 means that the paragraph is indented with the width of
17050 \begin_inset Quotes eld
17054 \begin_inset Flex Code
17057 \begin_layout Plain Layout
17064 \begin_inset Quotes erd
17067 in the normal font.
17068 You can get a negative width by prefixing the string with
17069 \begin_inset Quotes eld
17073 \begin_inset Flex Code
17076 \begin_layout Plain Layout
17083 \begin_inset Quotes erd
17087 This way was chosen so that the look is the same with each used screen font.
17090 \begin_layout Description
17091 \begin_inset Flex Code
17094 \begin_layout Plain Layout
17101 \begin_inset Flex Code
17104 \begin_layout Plain Layout
17119 \begin_inset Newline newline
17122 The kind of margin that the style has on the left side.
17126 \begin_layout Description
17127 \begin_inset Flex Code
17130 \begin_layout Plain Layout
17136 just means a fixed margin.
17139 \begin_layout Description
17140 \begin_inset Flex Code
17143 \begin_layout Plain Layout
17149 means that the left margin depends on the string entered in the
17150 \begin_inset Flex Noun
17153 \begin_layout Plain Layout
17154 Edit\SpecialChar menuseparator
17156 \begin_inset space ~
17165 This is used to typeset nice lists without tabulators.
17168 \begin_layout Description
17169 \begin_inset Flex Code
17172 \begin_layout Plain Layout
17178 means that the margin depends on the size of the label.
17179 This is used for automatic enumerated headlines.
17180 It is obvious that the headline
17181 \begin_inset Quotes eld
17184 5.4.3.2.1 Very long headline
17185 \begin_inset Quotes erd
17188 must have a wider left margin (as wide as
17189 \begin_inset Quotes eld
17193 \begin_inset Quotes erd
17196 plus the space) than
17197 \begin_inset Quotes eld
17200 3.2 Very long headline
17201 \begin_inset Quotes erd
17206 \begin_inset Quotes eld
17210 \begin_inset Quotes erd
17213 are not able to do this.
17216 \begin_layout Description
17217 \begin_inset Flex Code
17220 \begin_layout Plain Layout
17227 but only the very first row of the paragraph is dynamic,
17228 while the others are static;
17234 \begin_layout Description
17235 \begin_inset Flex Code
17238 \begin_layout Plain Layout
17244 means the margin is chosen in a way that the longest row of this paragraph fits to the right margin.
17245 This is used to typeset an address on the right edge of the page.
17249 \begin_layout Description
17250 \begin_inset Flex Code
17253 \begin_layout Plain Layout
17260 \begin_inset Flex Code
17263 \begin_layout Plain Layout
17272 \begin_inset space \thinspace{}
17276 \begin_inset Flex Code
17279 \begin_layout Plain Layout
17285 ] Whether fragile commands in this style should be
17286 \begin_inset Flex Code
17289 \begin_layout Plain Layout
17303 whether this command should itself be protected.)
17304 \change_inserted -712698321 1523696949
17308 \begin_layout Description
17310 \change_inserted -712698321 1552395557
17311 \begin_inset Flex Code
17314 \begin_layout Plain Layout
17316 \change_inserted -712698321 1523696950
17325 \begin_inset Flex Code
17328 \begin_layout Plain Layout
17330 \change_inserted -712698321 1523696950
17341 \begin_inset space \thinspace{}
17345 \begin_inset Flex Code
17348 \begin_layout Plain Layout
17350 \change_inserted -712698321 1523696950
17358 ] This causes macros that contain this layout to be protected with
17359 \begin_inset Flex Code
17362 \begin_layout Plain Layout
17364 \change_inserted -712698321 1523696950
17379 ) if necessary and thus allows (some) verbatim stuff in macros.
17382 \begin_layout Description
17384 \change_inserted -712698321 1552395844
17385 \begin_inset Flex Code
17388 \begin_layout Plain Layout
17390 \change_inserted -712698321 1552395561
17399 \begin_inset Flex Code
17402 \begin_layout Plain Layout
17404 \change_inserted -712698321 1552395557
17415 \begin_inset space \thinspace{}
17419 \begin_inset Flex Code
17422 \begin_layout Plain Layout
17424 \change_inserted -712698321 1552395557
17432 ] Whether specific commands in this style (such as
17433 \begin_inset Flex Code
17436 \begin_layout Plain Layout
17438 \change_inserted -712698321 1552395655
17449 \begin_inset Flex Code
17452 \begin_layout Plain Layout
17454 \change_inserted -712698321 1552395661
17464 ) should be protected in an
17465 \begin_inset Flex Code
17468 \begin_layout Plain Layout
17470 \change_inserted -712698321 1552395631
17481 This is particularly needed for styles that draw on
17489 commands which parse their content in complex ways.
17494 \begin_layout Description
17495 \begin_inset Flex Code
17498 \begin_layout Plain Layout
17505 \begin_inset Flex Code
17508 \begin_layout Plain Layout
17515 \begin_inset space \thinspace{}
17519 \begin_inset Flex Code
17522 \begin_layout Plain Layout
17530 ] Whether newlines are translated into \SpecialChar LaTeX
17532 \begin_inset Flex Code
17535 \begin_layout Plain Layout
17546 The translation can be switched off to allow more comfortable \SpecialChar LaTeX
17547 editing inside \SpecialChar LyX
17551 \begin_layout Description
17552 \begin_inset Flex Code
17555 \begin_layout Plain Layout
17562 \begin_inset Flex Code
17565 \begin_layout Plain Layout
17574 \begin_inset space \thinspace{}
17578 \begin_inset Flex Code
17581 \begin_layout Plain Layout
17589 \begin_inset Flex Code
17592 \begin_layout Plain Layout
17599 \begin_inset Flex Code
17602 \begin_layout Plain Layout
17608 ) paragraphs are being indented,
17609 then the indentation of such a paragraph following one of this type will be suppressed.
17610 (So this will not affect the display of non-default paragraphs.)
17613 \begin_layout Description
17614 \begin_inset Flex Code
17617 \begin_layout Plain Layout
17624 \begin_inset Flex Code
17627 \begin_layout Plain Layout
17633 ] Name of a style that has replaced this style.
17634 This is used to rename a style,
17635 while keeping backward compatibility.
17638 \begin_layout Description
17639 \begin_inset Flex Code
17642 \begin_layout Plain Layout
17649 \begin_inset Flex Code
17652 \begin_layout Plain Layout
17659 \begin_inset space \thinspace{}
17663 \begin_inset Flex Code
17666 \begin_layout Plain Layout
17672 ] Determines whether consecutive paragraphs of the same type are treated as belonging together.
17673 This has the effect that the
17674 \begin_inset Flex Code
17677 \begin_layout Plain Layout
17683 is only printed once before such a group.
17686 \begin_inset Flex Code
17689 \begin_layout Plain Layout
17696 \begin_inset Flex Code
17699 \begin_layout Plain Layout
17706 \begin_inset Flex Code
17709 \begin_layout Plain Layout
17715 and false for all other types.
17718 \begin_layout Description
17719 \begin_inset Flex Code
17722 \begin_layout Plain Layout
17729 \begin_inset Flex Code
17732 \begin_layout Plain Layout
17741 \begin_inset space \thinspace{}
17745 \begin_inset Flex Code
17748 \begin_layout Plain Layout
17754 ] Indicates that paragraphs will not be separated by an empty line in \SpecialChar LaTeX
17756 but only by a line break;
17758 \begin_inset Flex Code
17761 \begin_layout Plain Layout
17768 this allows to emulate a plain text editor (like the ERT inset).
17771 \begin_layout Description
17772 \begin_inset Flex Code
17775 \begin_layout Plain Layout
17782 \begin_inset Flex Code
17785 \begin_layout Plain Layout
17791 ] The indent of the very first line of a paragraph.
17793 \begin_inset Newline newline
17797 \begin_inset Flex Code
17800 \begin_layout Plain Layout
17806 will be fixed for a certain style.
17807 The exception is the default style,
17808 since the indentation for these paragraphs can be prohibited with
17809 \begin_inset Flex Code
17812 \begin_layout Plain Layout
17821 \begin_inset Flex Code
17824 \begin_layout Plain Layout
17830 style paragraphs inside environments use the
17831 \begin_inset Flex Code
17834 \begin_layout Plain Layout
17840 of the environment,
17841 not their native one.
17844 \begin_inset Flex Code
17847 \begin_layout Plain Layout
17853 paragraphs inside an enumeration are not indented.
17856 \begin_layout Description
17857 \begin_inset Flex Code
17860 \begin_layout Plain Layout
17867 \begin_inset Flex Code
17870 \begin_layout Plain Layout
17876 ] The vertical space between two paragraphs of this style.
17879 \begin_layout Description
17880 \begin_inset Flex Code
17883 \begin_layout Plain Layout
17890 \begin_inset Flex Code
17893 \begin_layout Plain Layout
17900 allows the user to choose either
17901 \begin_inset Quotes eld
17905 \begin_inset Quotes erd
17909 \begin_inset Quotes eld
17913 \begin_inset Quotes erd
17916 to separate paragraphs.
17918 \begin_inset Quotes eld
17922 \begin_inset Quotes erd
17927 \begin_inset Flex Code
17930 \begin_layout Plain Layout
17938 \begin_inset Quotes eld
17942 \begin_inset Quotes erd
17947 \begin_inset Flex Code
17950 \begin_layout Plain Layout
17956 is ignored and all paragraphs are separated by the
17957 \begin_inset Flex Code
17960 \begin_layout Plain Layout
17967 The vertical space is calculated with
17968 \begin_inset Flex Code
17971 \begin_layout Plain Layout
17973 \begin_inset space ~
17982 \begin_inset Flex Code
17985 \begin_layout Plain Layout
17991 is the height of a row with the normal font.
17993 the look stays the same with different screen fonts.
17996 \begin_layout Description
17997 \begin_inset Flex Code
18000 \begin_layout Plain Layout
18007 \begin_inset Flex Code
18010 \begin_layout Plain Layout
18019 \begin_inset space \thinspace{}
18023 \begin_inset Flex Code
18026 \begin_layout Plain Layout
18032 ] Whether the contents of this paragraph should be output in raw form,
18033 meaning without special translations that \SpecialChar LaTeX
18037 \begin_layout Description
18038 \begin_inset Flex Code
18041 \begin_layout Plain Layout
18048 \begin_inset Flex Code
18051 \begin_layout Plain Layout
18061 Defines individual characters that should be output in raw form,
18062 meaning without special translations that \SpecialChar LaTeX
18066 \begin_layout Description
18067 \begin_inset Flex Code
18070 \begin_layout Plain Layout
18076 Information to be included in the \SpecialChar LaTeX
18077 preamble when this style is used.
18078 Used to define macros,
18081 required by this particular style.
18083 \begin_inset Quotes eld
18087 \begin_inset Flex Code
18090 \begin_layout Plain Layout
18097 \begin_inset Quotes erd
18103 \begin_layout Description
18104 \begin_inset Flex Code
18107 \begin_layout Plain Layout
18114 \begin_inset Flex Code
18117 \begin_layout Plain Layout
18123 ] The prefix to use when creating labels referring to paragraphs of this type.
18124 This allows the use of formatted references.
18127 \begin_layout Description
18128 \begin_inset Flex Code
18131 \begin_layout Plain Layout
18138 \begin_inset Flex Code
18141 \begin_layout Plain Layout
18147 ] Whether the style requires the feature
18148 \begin_inset Flex Code
18151 \begin_layout Plain Layout
18158 \begin_inset CommandInset ref
18160 reference "chap:List-of-functions"
18165 for the list of features).
18166 If you require a package with specific options,
18167 you can additionally use
18168 \begin_inset Flex Code
18171 \begin_layout Plain Layout
18177 as a general text class parameter (see
18178 \begin_inset CommandInset ref
18180 reference "subsec:General-text-class"
18188 \begin_layout Description
18189 \begin_inset Flex Code
18192 \begin_layout Plain Layout
18199 \begin_inset Flex Code
18202 \begin_layout Plain Layout
18211 \begin_inset Flex Code
18214 \begin_layout Plain Layout
18220 ] Resets the \SpecialChar LaTeX
18221 arguments of this style (as defined via the
18222 \begin_inset Flex Code
18225 \begin_layout Plain Layout
18232 This is useful if you have copied a style via
18233 \begin_inset Flex Code
18236 \begin_layout Plain Layout
18243 but you do not want to inherit its (required and optional) arguments.
18246 \begin_layout Description
18247 \begin_inset Flex Code
18250 \begin_layout Plain Layout
18257 \begin_inset Flex Code
18260 \begin_layout Plain Layout
18269 \begin_inset Flex Code
18272 \begin_layout Plain Layout
18278 ] Resumes a counter that is usually reset at each new sequence of layouts.
18279 This is currently only useful when
18280 \begin_inset Flex Code
18283 \begin_layout Plain Layout
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
18322 ] A string that is put at the end of the layout content.
18323 A line break in the output can be indicated by
18324 \begin_inset Flex Code
18327 \begin_layout Plain Layout
18336 \begin_layout Description
18337 \begin_inset Flex Code
18340 \begin_layout Plain Layout
18347 \begin_inset Flex Code
18350 \begin_layout Plain Layout
18357 \begin_inset Flex Code
18360 \begin_layout Plain Layout
18369 \begin_layout Description
18370 \begin_inset Flex Code
18373 \begin_layout Plain Layout
18380 \begin_inset Flex Code
18383 \begin_layout Plain Layout
18393 \begin_inset Flex Code
18396 \begin_layout Plain Layout
18404 \begin_inset Flex Code
18407 \begin_layout Plain Layout
18415 \begin_inset Flex Code
18418 \begin_layout Plain Layout
18420 \begin_inset space ~
18428 ] This defines what the default spacing should be in the style.
18430 \begin_inset Flex Code
18433 \begin_layout Plain Layout
18441 \begin_inset Flex Code
18444 \begin_layout Plain Layout
18451 \begin_inset Flex Code
18454 \begin_layout Plain Layout
18460 correspond respectively to a multiplier value of 1,
18462 If you specify the argument
18463 \begin_inset Flex Code
18466 \begin_layout Plain Layout
18473 then you must also provide a value argument which will be the actual multiplier value.
18475 contrary to other parameters,
18477 \begin_inset Flex Code
18480 \begin_layout Plain Layout
18486 implies the generation of specific \SpecialChar LaTeX
18488 using the \SpecialChar LaTeX
18492 \begin_inset Flex Code
18495 \begin_layout Plain Layout
18504 \begin_layout Description
18505 \begin_inset Flex Code
18508 \begin_layout Plain Layout
18515 \begin_inset Flex Code
18518 \begin_layout Plain Layout
18525 \begin_inset space \thinspace{}
18529 \begin_inset Flex Code
18532 \begin_layout Plain Layout
18540 ] Allow spell-checking paragraphs of this style.
18544 \begin_layout Description
18545 \begin_inset Flex Code
18548 \begin_layout Plain Layout
18550 \change_deleted 731793113 1604355211
18552 \change_inserted 731793113 1604355212
18561 \begin_inset Flex Code
18564 \begin_layout Plain Layout
18573 \begin_inset Flex Code
18576 \begin_layout Plain Layout
18583 \change_deleted 731793113 1604355214
18585 \change_inserted 731793113 1604355216
18588 counter of a given counter at the beginning of a new sequence of layouts.
18589 This is currently only useful when
18590 \begin_inset Flex Code
18593 \begin_layout Plain Layout
18600 \begin_inset Flex Code
18603 \begin_layout Plain Layout
18612 \begin_layout Description
18613 \begin_inset Flex Code
18616 \begin_layout Plain Layout
18622 The font used for the text body .
18624 \begin_inset CommandInset ref
18626 reference "subsec:Font-description"
18634 \begin_layout Description
18635 \begin_inset Flex Code
18638 \begin_layout Plain Layout
18647 \begin_inset Flex Code
18650 \begin_layout Plain Layout
18660 The level of the style in the table of contents.
18661 This is used for automatic numbering of section headings.
18664 \begin_layout Description
18665 \begin_inset Flex Code
18668 \begin_layout Plain Layout
18677 \begin_inset Flex Code
18680 \begin_layout Plain Layout
18692 \begin_inset Flex Code
18695 \begin_layout Plain Layout
18703 \begin_inset Flex Code
18706 \begin_layout Plain Layout
18712 ] This tag determines whether the first line indentation of this paragraph can be toggled via the Paragraph settings dialog.
18716 \begin_inset Flex Code
18719 \begin_layout Plain Layout
18730 indentation can be toggled if the document settings use
18731 \begin_inset Quotes eld
18735 \begin_inset Quotes erd
18740 \begin_inset Flex Code
18743 \begin_layout Plain Layout
18750 indentation can always be toggled,
18751 notwithstanding the document settings,
18753 \begin_inset Flex Code
18756 \begin_layout Plain Layout
18763 indentation can never be toggled.
18766 \begin_layout Description
18767 \begin_inset Flex Code
18770 \begin_layout Plain Layout
18777 \begin_inset Flex Code
18780 \begin_layout Plain Layout
18786 ] The vertical space with which the very first of a chain of paragraphs with this style is separated from the previous paragraph.
18787 If the previous paragraph has another style,
18788 the separations are not simply added,
18789 but the maximum is taken.
18792 \begin_layout Subsection
18793 \begin_inset CommandInset label
18799 Internationalization of Paragraph Styles
18802 \begin_layout Standard
18804 has long supported internationalization of layout information,
18807 this applied only to the user interface and not to,
18811 French authors were forced to resort to ugly hacks if they wanted `
18815 1' instead of `Theorem 1'.
18816 Thanks to Georg Baum,
18817 that is no longer the case.
18820 \begin_layout Standard
18822 \begin_inset Flex Code
18825 \begin_layout Plain Layout
18831 defines text that is to appear in the typeset document,
18833 \begin_inset Flex Code
18836 \begin_layout Plain Layout
18843 \begin_inset Flex Code
18846 \begin_layout Plain Layout
18852 to support non-English and even multi-language documents correctly.
18853 The following excerpt (from the
18854 \begin_inset Flex Code
18857 \begin_layout Plain Layout
18863 file) shows how this works:
18866 \begin_layout LyX-Code
18871 \begin_layout LyX-Code
18874 theoremstyle{remark}
18877 \begin_layout LyX-Code
18880 newtheorem{claim}[thm]{
18887 \begin_layout LyX-Code
18891 \begin_layout LyX-Code
18895 \begin_layout LyX-Code
18900 claimname}{_(Claim)}
18903 \begin_layout LyX-Code
18907 \begin_layout LyX-Code
18911 \begin_layout LyX-Code
18920 claimname}{_(Claim)}}
18923 \begin_layout LyX-Code
18928 \begin_layout Standard
18930 any legal \SpecialChar LaTeX
18932 \begin_inset Flex Code
18935 \begin_layout Plain Layout
18942 \begin_inset Flex Code
18945 \begin_layout Plain Layout
18952 but in practice they will typically look as they do here.
18953 The key to correct translation of the typeset text is the definition of the \SpecialChar LaTeX
18955 \begin_inset Flex Code
18958 \begin_layout Plain Layout
18967 \begin_inset Flex Code
18970 \begin_layout Plain Layout
18982 \begin_layout Standard
18984 \begin_inset Flex Code
18987 \begin_layout Plain Layout
18993 tag provides for internationalization based upon the overall language of the document.
18994 The contents of the tag will be included in the preamble,
18996 \begin_inset Flex Code
18999 \begin_layout Plain Layout
19006 What makes it special is the use of the
19007 \begin_inset Quotes eld
19011 \begin_inset Quotes erd
19015 \begin_inset Flex Code
19018 \begin_layout Plain Layout
19025 which will be replaced,
19026 when \SpecialChar LyX
19027 produces \SpecialChar LaTeX
19029 with the translation of its argument into the document language.
19032 \begin_layout Standard
19034 \begin_inset Flex Code
19037 \begin_layout Plain Layout
19043 tag is more complex,
19044 since it is meant to provide support for multi-language documents and so offers an interface to the
19045 \begin_inset Flex Code
19048 \begin_layout Plain Layout
19055 Its contents will be added to the preamble once for each language that appears in the document.
19058 \begin_inset Flex Code
19061 \begin_layout Plain Layout
19067 will be replaced with its translation into the language in question;
19069 \begin_inset Flex Code
19072 \begin_layout Plain Layout
19078 is replaced by the language name (as used by the babel package).
19081 \begin_layout Standard
19082 A German document that also included a French section would thus have the following in the preamble:
19085 \begin_layout LyX-Code
19094 claimname}{Affirmation}}
19095 \begin_inset Newline newline
19106 claimname}{Behauptung}}
19107 \begin_inset Newline newline
19114 claimname}{Behauptung}
19117 \begin_layout Standard
19120 \begin_inset Flex Code
19123 \begin_layout Plain Layout
19129 will then conspire to produce the correct text in the output.
19132 \begin_layout Standard
19133 One important point to note here is that the translations are provided by \SpecialChar LyX
19136 \begin_inset Flex Code
19139 \begin_layout Plain Layout
19149 \begin_inset Flex Code
19152 \begin_layout Plain Layout
19159 \begin_inset Flex Code
19162 \begin_layout Plain Layout
19168 are really only of use in layout files that are provided with \SpecialChar LyX
19170 since text entered in user-created layout files will not be seen by \SpecialChar LyX
19171 's internationalization routines unless the
19172 \begin_inset Flex Code
19175 \begin_layout Plain Layout
19181 file is modified accordingly.
19184 any layout created with the intention that it will be included with \SpecialChar LyX
19185 should use these tags where appropriate.
19186 Please note that the paragraph style translations provided by \SpecialChar LyX
19187 will never change with a minor update (e.
19188 \begin_inset space \thinspace{}
19192 \begin_inset space \space{}
19195 from version 2.1.x to 2.1.y).
19196 It is however quite likely that a major update (e.
19197 \begin_inset space \thinspace{}
19201 \begin_inset space \space{}
19204 from 2.0.x to 2.1.0) will introduce new translations or corrections.
19207 \begin_layout Subsection
19209 \begin_inset CommandInset label
19211 name "subsec:Floats"
19218 \begin_layout Standard
19219 It is necessary to define the floats (
19220 \begin_inset Flex Noun
19223 \begin_layout Plain Layout
19231 \begin_inset Flex Noun
19234 \begin_layout Plain Layout
19242 ) in the text class itself.
19243 Standard floats are included in the file
19244 \begin_inset Flex Code
19247 \begin_layout Plain Layout
19254 so you may have to do no more than add
19257 \begin_layout LyX-Code
19258 Input stdfloats.inc
19261 \begin_layout Standard
19262 to your layout file.
19263 If you want to implement a text class that proposes some other float types (like the AGU class bundled with \SpecialChar LyX
19265 the information below will hopefully help you:
19268 \begin_layout Description
19269 \begin_inset Flex Code
19272 \begin_layout Plain Layout
19279 \begin_inset Flex Code
19282 \begin_layout Plain Layout
19288 =!htbpH] Allowed placement options for this float type.
19289 The value is a string of placement characters.
19290 Possible characters include:
19296 \begin_inset Quotes eld
19300 \begin_inset Quotes erd
19309 \begin_inset Quotes eld
19313 \begin_inset Quotes erd
19322 \begin_inset Quotes eld
19326 \begin_inset Quotes erd
19335 \begin_inset Quotes eld
19339 \begin_inset Quotes erd
19348 \begin_inset Quotes eld
19352 \begin_inset Quotes erd
19361 \begin_inset Quotes eld
19365 \begin_inset Quotes erd
19369 The order of the characters in the string does not matter.
19370 If no placement options are allowed,
19378 \begin_layout Description
19379 \begin_inset Flex Code
19382 \begin_layout Plain Layout
19389 \begin_inset Flex Code
19392 \begin_layout Plain Layout
19401 \begin_inset space \thinspace{}
19407 \begin_inset Flex Code
19410 \begin_layout Plain Layout
19420 ] Defines whether the float allows to be rotated via the \SpecialChar LaTeX
19427 \begin_inset Flex Code
19430 \begin_layout Plain Layout
19436 if the float does not support this feature.
19439 \begin_layout Description
19440 \begin_inset Flex Code
19443 \begin_layout Plain Layout
19450 \begin_inset Flex Code
19453 \begin_layout Plain Layout
19462 \begin_inset space \thinspace{}
19468 \begin_inset Flex Code
19471 \begin_layout Plain Layout
19481 ] Defines whether the float has a starred variant that spans columns in a two column paragraph.
19483 \begin_inset Flex Code
19486 \begin_layout Plain Layout
19492 if the float does not support this feature.
19495 \begin_layout Description
19496 \begin_inset Flex Code
19499 \begin_layout Plain Layout
19506 \begin_inset Flex Code
19509 \begin_layout Plain Layout
19516 \begin_inset Quotes erd
19520 \begin_inset Quotes erd
19523 ] The file name extension of an auxiliary file for the list of figures (or whatever).
19525 writes the captions to this file.
19528 \begin_layout Description
19529 \begin_inset Flex Code
19532 \begin_layout Plain Layout
19539 \begin_inset Flex Code
19542 \begin_layout Plain Layout
19549 \begin_inset Quotes erd
19553 \begin_inset Quotes erd
19556 ] The string that will be used in the menus and also for the caption.
19557 This is translated to the current language if babel is used.
19560 \begin_layout Description
19561 \begin_inset Flex Code
19564 \begin_layout Plain Layout
19570 These tags control the XHTML output.
19572 \begin_inset CommandInset ref
19574 reference "sec:Tags-for-XHTML"
19582 \begin_layout Description
19583 \begin_inset Flex Code
19586 \begin_layout Plain Layout
19595 \begin_inset Flex Code
19598 \begin_layout Plain Layout
19607 \begin_inset space \thinspace{}
19611 \begin_inset Flex Code
19614 \begin_layout Plain Layout
19620 ] Indicates whether the float is already defined in the document class or if instead the \SpecialChar LaTeX
19622 \begin_inset Flex Code
19625 \begin_layout Plain Layout
19631 needs to be loaded to define it on-the-fly.
19633 \begin_inset Flex Code
19636 \begin_layout Plain Layout
19645 \begin_inset Flex Code
19648 \begin_layout Plain Layout
19655 It should be set to
19656 \begin_inset Flex Code
19659 \begin_layout Plain Layout
19665 if the float is already defined by the \SpecialChar LaTeX
19669 \begin_layout Description
19670 \begin_inset Flex Code
19673 \begin_layout Plain Layout
19680 \begin_inset Flex Code
19683 \begin_layout Plain Layout
19690 \begin_inset Quotes erd
19694 \begin_inset Quotes erd
19697 ] The command used to generate a list of floats of this type;
19706 \begin_inset Flex Code
19709 \begin_layout Plain Layout
19716 since there is no standard way to generate this command.
19718 \begin_inset Flex Code
19721 \begin_layout Plain Layout
19728 since in that case there is a standard way to define the command.
19731 \begin_layout Description
19732 \begin_inset Flex Code
19735 \begin_layout Plain Layout
19742 \begin_inset Flex Code
19745 \begin_layout Plain Layout
19752 \begin_inset Quotes erd
19756 \begin_inset Quotes erd
19759 ] A title for a list of floats of this kind (list of figures,
19762 It is used for the screen label within \SpecialChar LyX
19764 it is used by \SpecialChar LaTeX
19765 for the title and it is used as the title in the XHTML output.
19766 It will be translated to the document language.
19769 \begin_layout Description
19770 \begin_inset Flex Code
19773 \begin_layout Plain Layout
19780 \begin_inset Flex Code
19783 \begin_layout Plain Layout
19790 \begin_inset Quotes erd
19794 \begin_inset Quotes erd
19797 ] This (optional) argument determines whether floats of this class will be numbered within some sectional unit of the document.
19800 \begin_inset Flex Code
19803 \begin_layout Plain Layout
19810 \begin_inset Quotes eld
19814 \begin_inset Flex Code
19817 \begin_layout Plain Layout
19824 \begin_inset Quotes erd
19828 the floats will be numbered within chapters.
19832 \begin_layout Description
19833 \begin_inset Flex Code
19836 \begin_layout Plain Layout
19843 \begin_inset Flex Code
19846 \begin_layout Plain Layout
19853 \begin_inset Quotes erd
19857 \begin_inset Quotes erd
19860 ] The default placement for the given class of floats.
19861 The string should be as in standard \SpecialChar LaTeX
19864 \begin_inset Flex Code
19867 \begin_layout Plain Layout
19875 \begin_inset Flex Code
19878 \begin_layout Plain Layout
19886 \begin_inset Flex Code
19889 \begin_layout Plain Layout
19896 \begin_inset Flex Code
19899 \begin_layout Plain Layout
19913 \begin_layout Plain Layout
19914 Note that the order of these letters in the string is irrelevant,
19915 like in \SpecialChar LaTeX
19921 On top of that there is a new type,
19923 \begin_inset Flex Code
19926 \begin_layout Plain Layout
19933 which does not really correspond to a float,
19936 \begin_inset Quotes eld
19940 \begin_inset Quotes erd
19944 Note however that the
19945 \begin_inset Flex Code
19948 \begin_layout Plain Layout
19954 specifier is special and,
19955 because of implementation details,
19956 cannot be used in non-built in float types.
19957 If you do not understand what this means,
19959 \begin_inset Quotes eld
19963 \begin_inset Flex Code
19966 \begin_layout Plain Layout
19973 \begin_inset Quotes erd
19977 \change_inserted -584632292 1690588297
19981 \begin_layout Description
19983 \change_inserted -584632292 1690593080
19984 \begin_inset Flex Code
19987 \begin_layout Plain Layout
19989 \change_inserted -584632292 1690588298
19998 \begin_inset Flex Code
20001 \begin_layout Plain Layout
20003 \change_inserted -584632292 1690588298
20012 \begin_inset Quotes erd
20016 \begin_inset Quotes erd
20019 ] A format for use with formatted references to this counter.
20021 one might want to have references to tables appear as
20022 \begin_inset Quotes eld
20026 \begin_inset Quotes erd
20030 The string may contain
20031 \begin_inset Quotes eld
20035 \begin_inset Quotes erd
20038 or a counter specification.
20039 (See the documentation for
20040 \begin_inset Flex Code
20043 \begin_layout Plain Layout
20045 \change_inserted -584632292 1690588298
20054 \begin_inset CommandInset ref
20055 LatexCommand formatted
20056 reference "subsec:Counters"
20064 .) The former will be replaced by the counter number itself.
20072 arabic{section} (which might render as:
20076 \begin_layout Description
20077 \begin_inset Flex Code
20080 \begin_layout Plain Layout
20087 \begin_inset Flex Code
20090 \begin_layout Plain Layout
20096 ] The prefix to use when creating labels referring to floats of this type.
20097 This allows the use of formatted references.
20098 Note that you can remove any
20099 \begin_inset Flex Code
20102 \begin_layout Plain Layout
20108 set by a copied style by using the special value
20109 \begin_inset Quotes eld
20113 \begin_inset Quotes erd
20117 which must be all caps.
20118 \change_inserted -712698321 1565605014
20122 \begin_layout Description
20124 \change_inserted -712698321 1565605014
20125 \begin_inset Flex Code
20128 \begin_layout Plain Layout
20130 \change_inserted -712698321 1565605014
20139 \begin_inset Flex Code
20142 \begin_layout Plain Layout
20144 \change_inserted -712698321 1565605014
20152 ] As with paragraph styles,
20154 \begin_inset CommandInset ref
20156 reference "subsec:Paragraph-Styles"
20166 \begin_layout Description
20167 \begin_inset Flex Code
20170 \begin_layout Plain Layout
20177 \begin_inset Flex Code
20180 \begin_layout Plain Layout
20187 \begin_inset Quotes erd
20191 \begin_inset Quotes erd
20194 ] The style used when defining the float using
20195 \begin_inset Flex Code
20198 \begin_layout Plain Layout
20209 \begin_layout Description
20210 \begin_inset Flex Code
20213 \begin_layout Plain Layout
20220 \begin_inset Flex Code
20223 \begin_layout Plain Layout
20230 \begin_inset Quotes erd
20234 \begin_inset Quotes erd
20238 \begin_inset Quotes eld
20242 \begin_inset Quotes erd
20245 of the new class of floats,
20246 like program or algorithm.
20247 After the appropriate
20248 \begin_inset Flex Code
20251 \begin_layout Plain Layout
20261 \begin_inset Flex Code
20264 \begin_layout Plain Layout
20273 \begin_inset Flex Code
20276 \begin_layout Plain Layout
20287 \begin_layout Description
20288 \begin_inset Flex Code
20291 \begin_layout Plain Layout
20298 \begin_inset Flex Code
20301 \begin_layout Plain Layout
20308 \begin_inset space \thinspace{}
20312 \begin_inset Flex Code
20315 \begin_layout Plain Layout
20323 ] Specifies whether this float is defined using the \SpecialChar LaTeX
20325 \begin_inset Flex Code
20328 \begin_layout Plain Layout
20335 either by the class file,
20336 another package or on-the-fly by \SpecialChar LyX
20340 \begin_layout Standard
20341 Note that defining a float with type
20342 \begin_inset Flex Code
20345 \begin_layout Plain Layout
20353 automatically defines the corresponding counter with name
20354 \begin_inset Flex Code
20357 \begin_layout Plain Layout
20368 \begin_layout Subsection
20369 Flex insets and InsetLayout
20370 \begin_inset CommandInset label
20372 name "subsec:Flex-insets-and"
20379 \begin_layout Standard
20380 Flex insets come in
20381 \change_deleted 5863208 1594239511
20383 \change_inserted 5863208 1594239512
20390 \begin_layout Itemize
20392 \begin_inset Flex Code
20395 \begin_layout Plain Layout
20402 These define semantic markup corresponding to such \SpecialChar LaTeX
20404 \begin_inset Flex Code
20407 \begin_layout Plain Layout
20416 \begin_inset Flex Code
20419 \begin_layout Plain Layout
20430 \begin_layout Itemize
20432 \begin_inset Flex Code
20435 \begin_layout Plain Layout
20442 These can be used to define custom collapsible insets,
20443 similar to \SpecialChar TeX
20447 An obvious example is an endnote inset,
20448 which is defined in the
20449 \begin_inset Flex Code
20452 \begin_layout Plain Layout
20461 \begin_layout Itemize
20463 \change_deleted 5863208 1594239528
20465 \begin_inset Flex Code
20468 \begin_layout Plain Layout
20475 For use with DocBook classes.
20480 \begin_layout Standard
20481 Flex insets are defined using the
20482 \begin_inset Flex Code
20485 \begin_layout Plain Layout
20492 which shall be explained in a moment.
20495 \begin_layout Standard
20497 \begin_inset Flex Code
20500 \begin_layout Plain Layout
20506 tag also serves another function:
20507 It can be used to customize the general layout of many different types of insets.
20510 \begin_inset Flex Code
20513 \begin_layout Plain Layout
20519 can be used to customize the layout parameters for footnotes,
20532 as well as to define Flex insets.
20535 \begin_layout Standard
20537 \begin_inset Flex Code
20540 \begin_layout Plain Layout
20546 definition must begin with a line of the form:
20549 \begin_layout LyX-Code
20553 \begin_layout Standard
20555 \begin_inset Flex Code
20558 \begin_layout Plain Layout
20564 indicates the inset whose layout is being defined,
20565 and here there are four cases.
20568 \begin_layout Enumerate
20569 The layout for a pre-existing inset is being modified.
20572 \begin_inset Flex Code
20575 \begin_layout Plain Layout
20581 any one of the following:
20583 \begin_inset Flex Code
20586 \begin_layout Plain Layout
20594 \begin_inset Flex Code
20597 \begin_layout Plain Layout
20605 \begin_inset Flex Code
20608 \begin_layout Plain Layout
20616 \begin_inset Flex Code
20619 \begin_layout Plain Layout
20627 \begin_inset Flex Code
20630 \begin_layout Plain Layout
20638 \begin_inset Flex Code
20641 \begin_layout Plain Layout
20649 \begin_inset Flex Code
20652 \begin_layout Plain Layout
20660 \begin_inset Flex Code
20663 \begin_layout Plain Layout
20671 \begin_inset Flex Code
20674 \begin_layout Plain Layout
20682 \begin_inset Flex Code
20685 \begin_layout Plain Layout
20693 \begin_inset Flex Code
20696 \begin_layout Plain Layout
20704 \begin_inset Flex Code
20707 \begin_layout Plain Layout
20715 \begin_inset Flex Code
20718 \begin_layout Plain Layout
20726 \begin_inset Flex Code
20729 \begin_layout Plain Layout
20737 \begin_inset Flex Code
20740 \begin_layout Plain Layout
20748 \begin_inset Flex Code
20751 \begin_layout Plain Layout
20759 \begin_inset Flex Code
20762 \begin_layout Plain Layout
20770 \begin_inset Flex Code
20773 \begin_layout Plain Layout
20781 \begin_inset Flex Code
20784 \begin_layout Plain Layout
20792 \begin_inset Flex Code
20795 \begin_layout Plain Layout
20804 \begin_layout Enumerate
20805 The layout for a Flex inset is being defined.
20808 \begin_inset Flex Code
20811 \begin_layout Plain Layout
20817 must be of the form
20818 \begin_inset Quotes eld
20822 \begin_inset Flex Code
20825 \begin_layout Plain Layout
20832 \begin_inset Quotes erd
20837 \begin_inset Flex Code
20840 \begin_layout Plain Layout
20846 may be any valid identifier not used by a pre-existing Flex inset.
20847 The identifier may include spaces,
20848 but in that case the whole thing must be wrapped in quotes.
20849 Note that the definition of a flex inset
20854 \begin_inset Flex Code
20857 \begin_layout Plain Layout
20864 declaring which type of inset it defines.
20867 \begin_layout Enumerate
20868 The layout for user specific branch is being defined.
20871 \begin_inset Flex Code
20874 \begin_layout Plain Layout
20880 must be of the form
20881 \begin_inset Quotes eld
20885 \begin_inset Flex Code
20888 \begin_layout Plain Layout
20895 \begin_inset Quotes erd
20900 \begin_inset Flex Code
20903 \begin_layout Plain Layout
20909 may be any valid identifier of branch defined in user's document.
20910 The identifier may include spaces,
20911 but in that case the whole thing must be wrapped in quotes.
20912 The main purpose of this feature is to allow \SpecialChar LaTeX
20913 wrapping around specific branches as user needs.
20916 \begin_layout Enumerate
20917 The layout of a user (or class) specific caption is being defined.
20920 \begin_inset Flex Code
20923 \begin_layout Plain Layout
20929 must be of the form
20930 \begin_inset Quotes eld
20934 \begin_inset Flex Code
20937 \begin_layout Plain Layout
20944 \begin_inset Quotes erd
20949 \begin_inset Flex Code
20952 \begin_layout Plain Layout
20958 specifies the name of the caption as it appears in the menu.
20959 Have a look at the standard caption (
20960 \begin_inset Flex Code
20963 \begin_layout Plain Layout
20970 the specific captions of the KOMA-Script classes (
20971 \begin_inset Flex Code
20974 \begin_layout Plain Layout
20982 \begin_inset Flex Code
20985 \begin_layout Plain Layout
20994 \begin_inset space ~
20998 \begin_inset Newline linebreak
21004 \begin_inset Flex Code
21007 \begin_layout Plain Layout
21013 ) for applications.
21016 \begin_layout Standard
21018 \begin_inset Flex Code
21021 \begin_layout Plain Layout
21027 definition can contain the following entries:
21030 \begin_layout Description
21031 \begin_inset Flex Code
21034 \begin_layout Plain Layout
21041 \begin_inset Flex Code
21044 \begin_layout Plain Layout
21050 =""] This inset will appear in the table of contents of the given type.
21051 An empty string disables.
21052 See also the OutlinerName and the IsTocCaption commands.
21053 This is only implemented for Flex insets.
21056 \change_inserted -712698321 1690284265
21060 \begin_layout Description
21062 \change_inserted -712698321 1690284544
21063 \begin_inset Flex Code
21066 \begin_layout Plain Layout
21068 \change_inserted -712698321 1690284277
21076 Includes a comma-separated list of insets to which this inset can be inserted.
21078 \begin_inset Quotes eld
21082 \begin_inset Flex Code
21085 \begin_layout Plain Layout
21087 \change_inserted -712698321 1690284318
21096 \begin_inset Quotes erd
21100 If you you also want the insertion to be allowed in specific arguments of the target insets,
21101 append the argument name after @ (e.
21102 \begin_inset space \thinspace{}
21107 \begin_inset Flex Code
21110 \begin_layout Plain Layout
21112 \change_inserted -712698321 1690284445
21121 Note that this currently only supports immediately containing insets (no deeper nesting).
21123 \begin_inset Flex Code
21126 \begin_layout Plain Layout
21128 \change_inserted -712698321 1690284329
21139 \begin_layout Description
21141 \change_inserted -712698321 1690292495
21142 \begin_inset Flex Code
21145 \begin_layout Plain Layout
21147 \change_inserted -712698321 1690284338
21155 Includes a comma-separated list of layouts within which this inset can be inserted.
21157 \begin_inset Quotes eld
21161 \begin_inset Flex Code
21164 \begin_layout Plain Layout
21166 \change_inserted -712698321 1690284353
21167 EndAllowedInLayouts
21175 \begin_inset Quotes erd
21179 Note that this currently only supports immediately containing layouts (no deeper nesting).
21181 \begin_inset Flex Code
21184 \begin_layout Plain Layout
21186 \change_inserted -712698321 1690284358
21197 \begin_layout Description
21199 \change_inserted -712698321 1690357747
21200 \begin_inset Flex Code
21203 \begin_layout Plain Layout
21205 \change_inserted -712698321 1690292501
21214 \begin_inset Flex Code
21217 \begin_layout Plain Layout
21219 \change_inserted -712698321 1690292507
21228 \begin_inset Flex Code
21231 \begin_layout Plain Layout
21233 \change_inserted -712698321 1690292530
21242 \begin_inset Flex Code
21245 \begin_layout Plain Layout
21247 \change_inserted -712698321 1690292536
21256 this can be used to determine how many times the inset can be inserted to a given inset or the paragraph (group).
21259 \begin_layout Description
21261 \change_inserted -712698321 1690357828
21262 \begin_inset Flex Code
21265 \begin_layout Plain Layout
21267 \change_inserted -712698321 1690357753
21268 AllowedOccurrencesPerItem
21276 \begin_inset Flex Code
21279 \begin_layout Plain Layout
21281 \change_inserted -712698321 1690357747
21292 \begin_inset space \thinspace{}
21296 \begin_inset Flex Code
21299 \begin_layout Plain Layout
21301 \change_inserted -712698321 1690357747
21309 ] If this is set to true,
21311 \begin_inset Flex Code
21314 \begin_layout Plain Layout
21316 \change_inserted -712698321 1690357774
21324 applies to single paragraphs if we are in a list-type environment (with
21325 \begin_inset Flex Code
21328 \begin_layout Plain Layout
21330 \change_inserted -712698321 1690357825
21345 \begin_layout Description
21346 \begin_inset Flex Code
21349 \begin_layout Plain Layout
21356 \begin_inset Flex Code
21359 \begin_layout Plain Layout
21365 ] Defines argument number of a command\SpecialChar breakableslash
21366 environment associated with the current layout.
21367 The definition must end with
21368 \begin_inset Flex Code
21371 \begin_layout Plain Layout
21379 \change_inserted -584632292 1615846847
21381 \begin_inset CommandInset ref
21383 reference "subsec:Arguments"
21392 \change_deleted -584632292 1615846847
21394 \begin_inset CommandInset ref
21396 reference "subsec:Paragraph-Styles"
21404 \change_deleted -584632292 1615846902
21406 \change_inserted -584632292 1615846906
21412 \begin_layout Description
21413 \begin_inset Flex Code
21416 \begin_layout Plain Layout
21422 Preamble for changing language commands;
21424 \begin_inset CommandInset ref
21426 reference "subsec:I18n"
21434 \begin_layout Description
21435 \begin_inset Flex Code
21438 \begin_layout Plain Layout
21445 \begin_inset Flex Code
21448 \begin_layout Plain Layout
21454 ] The color for the inset's background.
21456 \begin_inset CommandInset ref
21458 reference "chap:Names-of-colors"
21463 for a list of the available color names.
21466 \begin_layout Description
21467 \begin_inset Flex Code
21470 \begin_layout Plain Layout
21477 \begin_inset Flex Code
21480 \begin_layout Plain Layout
21489 \begin_inset space \thinspace{}
21493 \begin_inset Flex Code
21496 \begin_layout Plain Layout
21502 ] Whether to use the content of the inset as the label,
21503 when the inset is closed.
21507 \begin_layout Description
21508 \begin_inset Flex Code
21511 \begin_layout Plain Layout
21518 \begin_inset Flex Code
21521 \begin_layout Plain Layout
21527 ] As with paragraph styles,
21529 \begin_inset CommandInset ref
21531 reference "subsec:Paragraph-Styles"
21537 Note that you need to specify the complete type,
21539 \begin_inset space \thinspace{}
21543 \begin_inset space ~
21547 \begin_inset Flex Code
21550 \begin_layout Plain Layout
21551 CopyStyle Flex:<name>
21559 \begin_layout Description
21560 \begin_inset Flex Code
21563 \begin_layout Plain Layout
21570 \begin_inset Flex Code
21573 \begin_layout Plain Layout
21582 \begin_inset space \thinspace{}
21586 \begin_inset Flex Code
21589 \begin_layout Plain Layout
21595 ] Indicates whether the user may employ the Paragraph Settings dialog to customize the paragraph.
21598 \begin_layout Description
21599 \begin_inset Flex Code
21602 \begin_layout Plain Layout
21609 \begin_inset Flex Code
21612 \begin_layout Plain Layout
21620 \begin_inset Flex Code
21623 \begin_layout Plain Layout
21631 \begin_inset Flex Code
21634 \begin_layout Plain Layout
21641 describing the rendering style used for the inset's frame and buttons.
21642 Footnotes generally use
21643 \begin_inset Flex Code
21646 \begin_layout Plain Layout
21653 ERT insets generally
21654 \begin_inset Flex Code
21657 \begin_layout Plain Layout
21664 and character styles
21665 \begin_inset Flex Code
21668 \begin_layout Plain Layout
21677 \begin_layout Description
21678 \begin_inset Flex Code
21681 \begin_layout Plain Layout
21688 \begin_inset Flex Code
21691 \begin_layout Plain Layout
21700 \begin_inset space \thinspace{}
21706 \begin_inset Flex Code
21709 \begin_layout Plain Layout
21718 \begin_inset Flex Code
21721 \begin_layout Plain Layout
21728 \begin_inset Flex Code
21731 \begin_layout Plain Layout
21738 Indicates whether the environment will stand on its own in the output or will appear inline with the surrounding text.
21740 it is supposed that the \SpecialChar LaTeX
21741 environment ignores white space (including one newline character) after the
21742 \begin_inset Flex Code
21745 \begin_layout Plain Layout
21758 \begin_inset Flex Code
21761 \begin_layout Plain Layout
21775 \change_inserted 731793113 1538674858
21779 \begin_layout Description
21781 \change_inserted 731793113 1538674891
21782 \begin_inset Flex Code
21785 \begin_layout Plain Layout
21787 \change_inserted 731793113 1538674863
21799 ,1] Allow the contents of the inset to be edited externally (using whatever editor is defined for the document's output format).
21804 \begin_layout Description
21805 \begin_inset Flex Code
21808 \begin_layout Plain Layout
21814 Required at the end of the
21815 \begin_inset Flex Code
21818 \begin_layout Plain Layout
21827 \begin_layout Description
21828 \begin_inset Flex Code
21831 \begin_layout Plain Layout
21837 The font used for both the text body
21843 \begin_inset CommandInset ref
21844 LatexCommand formatted
21845 reference "subsec:Font-description"
21851 Note that defining this font automatically defines the
21852 \begin_inset Flex Code
21855 \begin_layout Plain Layout
21862 so define this first and define
21863 \begin_inset Flex Code
21866 \begin_layout Plain Layout
21872 later if you want them to be different.
21875 \begin_layout Description
21876 \begin_inset Flex Code
21879 \begin_layout Plain Layout
21880 FixedWidthPreambleEncoding
21886 \begin_inset Flex Code
21889 \begin_layout Plain Layout
21898 \begin_inset space \thinspace{}
21902 \begin_inset Flex Code
21905 \begin_layout Plain Layout
21911 ] Force a fixed width encoding for the translated contents of
21912 \begin_inset Flex Code
21915 \begin_layout Plain Layout
21922 \begin_inset Flex Code
21925 \begin_layout Plain Layout
21931 code generated by this layout.
21932 This is needed for special \SpecialChar LaTeX
21937 that do not work with variable width encodings such as
21942 This setting is ignored if fully Unicode aware \SpecialChar LaTeX
21943 backends such as Xe\SpecialChar TeX
21944 or Lua\SpecialChar TeX
21948 \begin_layout Description
21949 \begin_inset Flex Code
21952 \begin_layout Plain Layout
21953 ForceLocalFontSwitch
21959 \begin_inset Flex Code
21962 \begin_layout Plain Layout
21971 \begin_inset space \thinspace{}
21975 \begin_inset Flex Code
21978 \begin_layout Plain Layout
21984 ] When using babel,
21985 always use a local font switch (
21986 \begin_inset Flex Code
21989 \begin_layout Plain Layout
21998 never a global one (such as
21999 \begin_inset Flex Code
22002 \begin_layout Plain Layout
22013 \begin_layout Description
22014 \begin_inset Flex Code
22017 \begin_layout Plain Layout
22024 \begin_inset Flex Code
22027 \begin_layout Plain Layout
22036 \begin_inset space \thinspace{}
22040 \begin_inset Flex Code
22043 \begin_layout Plain Layout
22050 \begin_inset Quotes eld
22054 \begin_inset Quotes erd
22058 leading to Left-to-Right (Latin) output,
22060 \begin_inset space \thinspace{}
22064 \begin_inset space \space{}
22067 in \SpecialChar TeX
22072 \begin_layout Description
22073 \begin_inset Flex Code
22076 \begin_layout Plain Layout
22083 \begin_inset Flex Code
22086 \begin_layout Plain Layout
22095 \begin_inset space \thinspace{}
22099 \begin_inset Flex Code
22102 \begin_layout Plain Layout
22108 ] Force a line break in the \SpecialChar LaTeX
22109 output before the inset starts and after the inset ends.
22110 This assures the inset itself is output on its own lines,
22111 for parsing purposes.
22114 \begin_layout Description
22115 \begin_inset Flex Code
22118 \begin_layout Plain Layout
22125 \begin_inset Flex Code
22128 \begin_layout Plain Layout
22137 \begin_inset space \thinspace{}
22141 \begin_inset Flex Code
22144 \begin_layout Plain Layout
22150 ] Indicates whether the
22151 \begin_inset Flex Code
22154 \begin_layout Plain Layout
22162 the user can change the paragraph style used in the inset.
22166 \begin_layout Description
22167 \begin_inset Flex Code
22170 \begin_layout Plain Layout
22177 \begin_inset Flex Code
22180 \begin_layout Plain Layout
22189 \begin_inset space \thinspace{}
22193 \begin_inset Flex Code
22196 \begin_layout Plain Layout
22202 ] As with paragraph styles,
22204 \begin_inset CommandInset ref
22206 reference "subsec:Paragraph-Styles"
22214 \begin_layout Description
22215 \begin_inset Flex Code
22218 \begin_layout Plain Layout
22224 These tags control the XHTML output.
22226 \begin_inset CommandInset ref
22228 reference "sec:Tags-for-XHTML"
22234 \change_inserted 47243155 1689528605
22238 \begin_layout Description
22240 \change_inserted 47243155 1689528735
22241 \begin_inset Flex Code
22244 \begin_layout Plain Layout
22246 \change_inserted 47243155 1689528630
22255 \begin_inset Flex Code
22258 \begin_layout Plain Layout
22260 \change_inserted 47243155 1689528607
22269 \begin_inset space \thinspace{}
22273 \begin_inset Flex Code
22276 \begin_layout Plain Layout
22278 \change_inserted 47243155 1689528607
22288 ] The font inside the inset is inherited from the parent for \SpecialChar LaTeX
22289 export if this parameter is 1,
22290 as well as on screen.
22291 Otherwise the document default font is used.
22296 \begin_layout Description
22297 \begin_inset Flex Code
22300 \begin_layout Plain Layout
22307 \begin_inset Flex Code
22310 \begin_layout Plain Layout
22319 \begin_inset space \thinspace{}
22323 \begin_inset Flex Code
22326 \begin_layout Plain Layout
22332 ] Whether to include the contents of this inset in the strings generated for the `Outline' pane for all table of contents,
22333 regardless of the AddToToc setting.
22336 want the content of a footnote in a section header to be included in the TOC displayed in the outline,
22337 but one would normally want the content of a character style displayed.
22342 \begin_layout Description
22343 \begin_inset Flex Code
22346 \begin_layout Plain Layout
22353 \begin_inset Flex Code
22356 \begin_layout Plain Layout
22365 \begin_inset space \thinspace{}
22369 \begin_inset Flex Code
22372 \begin_layout Plain Layout
22378 ] If this is set to 1 and AddToToc is enabled,
22379 the inset adds a summary of its contents in its item in the table of contents.
22381 only the label appears.
22384 \begin_layout Description
22385 \begin_inset Flex Code
22388 \begin_layout Plain Layout
22397 \begin_inset Flex Code
22400 \begin_layout Plain Layout
22409 \begin_inset space \thinspace{}
22413 \begin_inset Flex Code
22416 \begin_layout Plain Layout
22422 ] As with paragraph styles,
22424 \begin_inset CommandInset ref
22426 reference "subsec:Paragraph-Styles"
22434 \begin_layout Description
22435 \begin_inset Flex Code
22438 \begin_layout Plain Layout
22444 The font used for the label.
22446 \begin_inset CommandInset ref
22448 reference "subsec:Font-description"
22454 Note that this definition can never appear before
22455 \begin_inset Flex Code
22458 \begin_layout Plain Layout
22465 lest it be ineffective.
22468 \begin_layout Description
22469 \begin_inset Flex Code
22472 \begin_layout Plain Layout
22479 \begin_inset Flex Code
22482 \begin_layout Plain Layout
22489 \begin_inset Quotes erd
22493 \begin_inset Quotes erd
22496 ] What will be displayed on the button or elsewhere as the inset label.
22498 \begin_inset Flex Code
22501 \begin_layout Plain Layout
22509 \begin_inset Flex Code
22512 \begin_layout Plain Layout
22518 ) modify this label on the fly.
22521 \begin_layout Description
22522 \begin_inset Flex Code
22525 \begin_layout Plain Layout
22531 Language dependent preamble;
22533 \begin_inset CommandInset ref
22535 reference "subsec:I18n"
22543 \begin_layout Description
22544 \begin_inset Flex Code
22547 \begin_layout Plain Layout
22554 \begin_inset Flex Code
22557 \begin_layout Plain Layout
22563 ] The name of the corresponding \SpecialChar LaTeX
22565 Either the environment or command name.
22568 \begin_layout Description
22569 \begin_inset Flex Code
22572 \begin_layout Plain Layout
22579 \begin_inset Flex Code
22582 \begin_layout Plain Layout
22588 ] The optional parameter for the corresponding
22589 \begin_inset Flex Code
22592 \begin_layout Plain Layout
22599 including possible bracket pairs like
22600 \begin_inset Flex Code
22603 \begin_layout Plain Layout
22610 This parameter cannot be changed from within \SpecialChar LyX
22612 \begin_inset Flex Code
22615 \begin_layout Plain Layout
22621 for customizable parameters).
22622 It will be output as is after all \SpecialChar LaTeX
22624 \begin_inset Flex Code
22627 \begin_layout Plain Layout
22636 \begin_layout Description
22637 \begin_inset Flex Code
22640 \begin_layout Plain Layout
22647 \begin_inset Flex Code
22650 \begin_layout Plain Layout
22658 ] How the style should be translated into \SpecialChar LaTeX
22663 \begin_layout Plain Layout
22664 \begin_inset Flex Code
22667 \begin_layout Plain Layout
22673 is perhaps a bit misleading,
22674 since these rules apply to SGML classes too.
22675 Visit the SGML class files for specific examples.
22684 \begin_layout Description
22685 \begin_inset Flex Code
22688 \begin_layout Plain Layout
22694 means nothing special
22697 \begin_layout Description
22698 \begin_inset Flex Code
22701 \begin_layout Plain Layout
22708 \begin_inset Flex Code
22711 \begin_layout Plain Layout
22718 {\SpecialChar ldots
22727 \begin_layout Description
22728 \begin_inset Flex Code
22731 \begin_layout Plain Layout
22738 \begin_inset Flex Code
22741 \begin_layout Plain Layout
22748 }\SpecialChar ldots
22763 \begin_layout Standard
22764 Putting the last few things together,
22765 the \SpecialChar LaTeX
22766 output will be either:
22770 \begin_layout LyX-Code
22773 LatexName[LatexParam]{\SpecialChar ldots
22777 \begin_layout Standard
22782 \begin_layout LyX-Code
22785 begin{LatexName}[LatexParam] \SpecialChar ldots
22791 \begin_layout Standard
22792 depending upon the \SpecialChar LaTeX
22797 \begin_layout Description
22798 \begin_inset Flex Code
22801 \begin_layout Plain Layout
22808 \begin_inset Flex Code
22811 \begin_layout Plain Layout
22817 ] A string that is put at the beginning of the layout content.
22818 A line break in the output can be indicated by
22819 \begin_inset Flex Code
22822 \begin_layout Plain Layout
22831 \begin_layout Description
22832 \begin_inset Flex Code
22835 \begin_layout Plain Layout
22842 \begin_inset Flex Code
22845 \begin_layout Plain Layout
22853 \begin_inset Flex Code
22856 \begin_layout Plain Layout
22864 \change_deleted -584632292 1615846609
22866 \begin_inset Flex Code
22869 \begin_layout Plain Layout
22878 \begin_inset Flex Code
22881 \begin_layout Plain Layout
22887 (indicating a dummy definition ending definitions of charstyles,
22889 This entry is required in and is only meaningful for Flex insets.
22890 Among other things,
22891 it determines on which menu this inset will appear.
22893 \begin_inset Flex Code
22896 \begin_layout Plain Layout
22903 \begin_inset Flex Code
22906 \begin_layout Plain Layout
22912 will automatically set
22913 \begin_inset Flex Code
22916 \begin_layout Plain Layout
22923 \begin_inset Flex Code
22926 \begin_layout Plain Layout
22934 \begin_inset Flex Code
22937 \begin_layout Plain Layout
22943 can be set to true,
22945 \begin_inset Flex Code
22948 \begin_layout Plain Layout
22956 \begin_inset Flex Code
22959 \begin_layout Plain Layout
22965 insets by setting it
22970 \begin_inset Flex Code
22973 \begin_layout Plain Layout
22980 \change_inserted -712698321 1555575738
22984 \begin_layout Description
22986 \change_inserted -712698321 1555575844
22987 \begin_inset Flex Code
22990 \begin_layout Plain Layout
22992 \change_inserted -712698321 1555575740
23001 \begin_inset Flex Code
23004 \begin_layout Plain Layout
23006 \change_inserted -712698321 1555575740
23014 A dedicated string for the menu.
23015 You can define an accelerator by appending the respective character to the string,
23017 \begin_inset Quotes eld
23021 \begin_inset Quotes erd
23025 \begin_inset space \thinspace{}
23029 \begin_inset space \space{}
23033 \begin_inset Quotes eld
23037 \begin_inset Flex Code
23040 \begin_layout Plain Layout
23042 \change_inserted -712698321 1555575781
23051 \begin_inset Quotes erd
23055 This specification is optional.
23056 If it is not given the inset name as specified in the type declaration will be used instead for the menu.
23061 \begin_layout Description
23062 \begin_inset Flex Code
23065 \begin_layout Plain Layout
23072 \begin_inset Flex Code
23075 \begin_layout Plain Layout
23084 \begin_inset space \thinspace{}
23088 \begin_inset Flex Code
23091 \begin_layout Plain Layout
23097 ] Whether multiple paragraphs are permitted in this inset.
23099 \begin_inset Flex Code
23102 \begin_layout Plain Layout
23108 to the same value and
23109 \begin_inset Flex Code
23112 \begin_layout Plain Layout
23118 to the opposite value.
23119 These can be reset to other values,
23125 \begin_inset Flex Code
23128 \begin_layout Plain Layout
23138 \begin_layout Description
23139 \begin_inset Flex Code
23142 \begin_layout Plain Layout
23149 \begin_inset Flex Code
23152 \begin_layout Plain Layout
23161 \begin_inset space \thinspace{}
23165 \begin_inset Flex Code
23168 \begin_layout Plain Layout
23174 ] Whether fragile commands in this inset should be
23175 \begin_inset Flex Code
23178 \begin_layout Plain Layout
23192 whether the command should itself be protected.) Default is false.
23193 \change_inserted -712698321 1523633958
23197 \begin_layout Description
23199 \change_inserted -712698321 1552395786
23200 \begin_inset Flex Code
23203 \begin_layout Plain Layout
23205 \change_inserted -712698321 1523633961
23214 \begin_inset Flex Code
23217 \begin_layout Plain Layout
23219 \change_inserted -712698321 1523633958
23230 \begin_inset space \thinspace{}
23234 \begin_inset Flex Code
23237 \begin_layout Plain Layout
23239 \change_inserted -712698321 1523633958
23247 ] This causes macros that contain this inset to be protected with
23248 \begin_inset Flex Code
23251 \begin_layout Plain Layout
23253 \change_inserted -712698321 1523634038
23268 ) if necessary and thus allows (some) verbatim stuff in macros.
23272 \begin_layout Description
23274 \change_inserted -712698321 1555579651
23275 \begin_inset Flex Code
23278 \begin_layout Plain Layout
23280 \change_inserted -712698321 1552395787
23289 \begin_inset Flex Code
23292 \begin_layout Plain Layout
23294 \change_inserted -712698321 1552395787
23305 \begin_inset space \thinspace{}
23309 \begin_inset Flex Code
23312 \begin_layout Plain Layout
23314 \change_inserted -712698321 1552395787
23322 ] Whether specific commands in this inset (such as
23323 \begin_inset Flex Code
23326 \begin_layout Plain Layout
23328 \change_inserted -712698321 1552395787
23339 \begin_inset Flex Code
23342 \begin_layout Plain Layout
23344 \change_inserted -712698321 1552395787
23354 ) should be protected in an
23355 \begin_inset Flex Code
23358 \begin_layout Plain Layout
23360 \change_inserted -712698321 1552395787
23371 This is particularly needed for insets that draw on
23379 commands which parse their content in complex ways.
23383 \begin_layout Description
23385 \change_inserted -712698321 1555579742
23386 \begin_inset Flex Code
23389 \begin_layout Plain Layout
23391 \change_inserted -712698321 1555579658
23400 \begin_inset Flex Code
23403 \begin_layout Plain Layout
23405 \change_inserted -712698321 1555579651
23413 Option to define a different command (from the default
23414 \begin_inset Flex Code
23417 \begin_layout Plain Layout
23419 \change_inserted -712698321 1555579742
23431 ) to be used for line breaks.
23432 The initial backslash must not be specified.
23437 \begin_layout Description
23438 \begin_inset Flex Code
23441 \begin_layout Plain Layout
23448 \begin_inset Flex Code
23451 \begin_layout Plain Layout
23457 ] Deletes an existing
23458 \begin_inset Flex Code
23461 \begin_layout Plain Layout
23470 \begin_layout Description
23471 \begin_inset Flex Code
23474 \begin_layout Plain Layout
23481 \begin_inset Flex Code
23484 \begin_layout Plain Layout
23491 \begin_inset Flex Code
23494 \begin_layout Plain Layout
23500 that has replaced this
23501 \begin_inset Flex Code
23504 \begin_layout Plain Layout
23511 This is used to rename an
23512 \begin_inset Flex Code
23515 \begin_layout Plain Layout
23522 while keeping backward compatibility.
23523 \change_inserted -712698321 1559491850
23527 \begin_layout Description
23529 \change_inserted -712698321 1559492002
23530 \begin_inset Flex Code
23533 \begin_layout Plain Layout
23535 \change_inserted -712698321 1559491854
23544 \begin_inset Flex Code
23547 \begin_layout Plain Layout
23549 \change_inserted -712698321 1559491850
23560 \begin_inset space \thinspace{}
23564 \begin_inset Flex Code
23567 \begin_layout Plain Layout
23569 \change_inserted -712698321 1559491850
23577 ] If this is set to
23578 \begin_inset Flex Code
23581 \begin_layout Plain Layout
23583 \change_inserted -712698321 1559491881
23592 paragraph breaks will be ignored in the output.
23593 This might be useful for insets where the content should be alignable on different lines only in the \SpecialChar LyX
23595 without any effect in the output.
23600 \begin_layout Description
23601 \begin_inset Flex Code
23604 \begin_layout Plain Layout
23611 \begin_inset Flex Code
23614 \begin_layout Plain Layout
23623 \begin_inset space \thinspace{}
23627 \begin_inset Flex Code
23630 \begin_layout Plain Layout
23636 ] As with paragraph styles,
23638 \begin_inset CommandInset ref
23640 reference "subsec:Paragraph-Styles"
23649 \begin_layout Description
23650 \begin_inset Flex Code
23653 \begin_layout Plain Layout
23660 \begin_inset Flex Code
23663 \begin_layout Plain Layout
23672 \begin_inset space \thinspace{}
23676 \begin_inset Flex Code
23679 \begin_layout Plain Layout
23685 ] As with paragraph styles,
23687 \begin_inset CommandInset ref
23689 reference "subsec:Paragraph-Styles"
23698 \begin_layout Description
23699 \begin_inset Flex Code
23702 \begin_layout Plain Layout
23708 As with paragraph styles,
23710 \begin_inset CommandInset ref
23712 reference "subsec:Paragraph-Styles"
23720 \begin_layout Description
23721 \begin_inset Flex Code
23724 \begin_layout Plain Layout
23731 \begin_inset Flex Code
23734 \begin_layout Plain Layout
23740 ] The prefix to use when creating labels referring to insets of this type.
23741 This allows the use of formatted references.
23744 \begin_layout Description
23745 \begin_inset Flex Code
23748 \begin_layout Plain Layout
23755 \begin_inset Flex Code
23758 \begin_layout Plain Layout
23764 ] As with paragraph styles,
23766 \begin_inset CommandInset ref
23768 reference "subsec:Paragraph-Styles"
23776 \begin_layout Description
23777 \begin_inset Flex Code
23780 \begin_layout Plain Layout
23787 \begin_inset Flex Code
23790 \begin_layout Plain Layout
23799 \begin_inset space \thinspace{}
23803 \begin_inset Flex Code
23806 \begin_layout Plain Layout
23812 ] Resets the \SpecialChar LaTeX
23813 arguments of this layout (as defined via the
23814 \begin_inset Flex Code
23817 \begin_layout Plain Layout
23824 This is useful if you have copied a style via
23825 \begin_inset Flex Code
23828 \begin_layout Plain Layout
23835 but you do not want to inherit its (required and optional) arguments.
23838 \begin_layout Description
23839 \begin_inset Flex Code
23842 \begin_layout Plain Layout
23849 \begin_inset Flex Code
23852 \begin_layout Plain Layout
23861 \begin_inset space \thinspace{}
23865 \begin_inset Flex Code
23868 \begin_layout Plain Layout
23875 \change_inserted -712698321 1597733473
23877 \begin_inset Flex Code
23880 \begin_layout Plain Layout
23882 \change_inserted -712698321 1597732178
23891 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.
23892 \begin_inset space \thinspace{}
23897 \begin_inset Flex Code
23900 \begin_layout Plain Layout
23902 \change_inserted -712698321 1597733683
23905 textbf{Sourrounding text
23909 textbf{content}}\SpecialChar ldots
23918 \begin_inset Flex Code
23921 \begin_layout Plain Layout
23923 \change_inserted -712698321 1597733686
23926 textbf{Sourrounding text
23928 myinset{content}\SpecialChar ldots
23937 Setting this makes sense for commands that internally reset font settings (e.
23938 \begin_inset space \thinspace{}
23943 Note that wrongly setting this might lead to unwanted result (e.
23944 \begin_inset space \thinspace{}
23949 \begin_inset Flex Code
23952 \begin_layout Plain Layout
23954 \change_inserted -712698321 1597733688
23957 emph{Sourrounding text
23961 emph{content}}\SpecialChar ldots
23970 content is upright,
23972 \begin_inset Flex Code
23975 \begin_layout Plain Layout
23977 \change_inserted -712698321 1597733278
23989 \change_deleted -712698321 1597733283
23990 Whether this inset should use the font of its surrounding environment or uses its own.
23994 \change_deleted -712698321 1597733290
23996 \change_inserted -712698321 1597733290
23998 \begin_inset Flex Code
24001 \begin_layout Plain Layout
24003 \change_inserted -712698321 1597733292
24015 \change_deleted -712698321 1597733327
24016 use the font of the surrounding environment
24017 \change_inserted -712698321 1597733343
24018 font changes are not redone inside the inset
24023 \begin_layout Description
24024 \begin_inset Flex Code
24027 \begin_layout Plain Layout
24034 \begin_inset Flex Code
24037 \begin_layout Plain Layout
24043 ] A string that is put at the end of the layout content.
24044 A line break in the output can be indicated by
24045 \begin_inset Flex Code
24048 \begin_layout Plain Layout
24057 \begin_layout Description
24058 \begin_inset Flex Code
24061 \begin_layout Plain Layout
24068 \begin_inset Flex Code
24071 \begin_layout Plain Layout
24078 \begin_inset space \thinspace{}
24082 \begin_inset Flex Code
24085 \begin_layout Plain Layout
24093 ] Allow spell-checking the contents of this inset.
24095 \change_inserted -584632292 1615846659
24099 \begin_layout Subsection
24101 \change_inserted -584632292 1615846729
24103 \begin_inset CommandInset label
24105 name "subsec:Arguments"
24112 \begin_layout Standard
24114 \change_inserted -584632292 1615846807
24115 Both paragraph styles and inset layouts allow for
24119 as well as the main content.
24120 This is especially useful for things like section headings and only makes sense with \SpecialChar LaTeX
24122 Each (optional or required) argument of a command or environment—
24123 except for the required argument that is associated with the content—
24124 has a separate definition,
24125 where the number specifies the order of the arguments.
24126 The definition must end with
24127 \begin_inset Flex Code
24130 \begin_layout Plain Layout
24132 \change_inserted -584632292 1615846730
24141 So a command with two optional arguments looks like:
24144 \begin_layout Quote
24146 \change_inserted -584632292 1615846730
24152 \begin_layout Quote
24154 \change_inserted -584632292 1615846730
24160 \begin_layout Quote
24162 \change_inserted -584632292 1615846730
24168 \begin_layout Quote
24170 \change_inserted -584632292 1615846730
24176 \begin_layout Quote
24178 \change_inserted -584632292 1615846730
24184 \begin_layout Quote
24186 \change_inserted -584632292 1615846730
24192 \begin_layout Standard
24194 \change_inserted -584632292 1615846730
24196 \begin_inset Flex Code
24199 \begin_layout Plain Layout
24201 \change_inserted -584632292 1615846730
24210 the following specifications are possible:
24213 \begin_layout Itemize
24215 \change_inserted -584632292 1615846730
24216 \begin_inset Flex Code
24219 \begin_layout Plain Layout
24221 \change_inserted -584632292 1615846730
24230 \begin_inset Flex Code
24233 \begin_layout Plain Layout
24235 \change_inserted -584632292 1615846730
24243 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
24244 \begin_inset Flex Code
24247 \begin_layout Plain Layout
24249 \change_inserted -584632292 1615846730
24259 you can define an accelerator by appending the respective character to the string,
24261 \begin_inset Quotes eld
24265 \begin_inset Quotes erd
24269 \begin_inset space \thinspace{}
24273 \begin_inset space \space{}
24277 \begin_inset Quotes eld
24281 \begin_inset Flex Code
24284 \begin_layout Plain Layout
24286 \change_inserted -584632292 1615846730
24295 \begin_inset Quotes erd
24301 \begin_layout Itemize
24303 \change_inserted -584632292 1615846730
24304 \begin_inset Flex Code
24307 \begin_layout Plain Layout
24309 \change_inserted -584632292 1615846730
24318 \begin_inset Flex Code
24321 \begin_layout Plain Layout
24323 \change_inserted -584632292 1615846730
24331 A separate string for the menu.
24332 You can define an accelerator by appending the respective character to the string,
24334 \begin_inset Quotes eld
24338 \begin_inset Quotes erd
24342 \begin_inset space \thinspace{}
24346 \begin_inset space \space{}
24350 \begin_inset Quotes eld
24354 \begin_inset Flex Code
24357 \begin_layout Plain Layout
24359 \change_inserted -584632292 1615846730
24368 \begin_inset Quotes erd
24372 This specification is optional.
24373 If it is not given the
24374 \begin_inset Flex Code
24377 \begin_layout Plain Layout
24379 \change_inserted -584632292 1615846730
24387 will be used instead for the menu.
24390 \begin_layout Itemize
24392 \change_inserted -584632292 1615846730
24393 \begin_inset Flex Code
24396 \begin_layout Plain Layout
24398 \change_inserted -584632292 1615846730
24407 \begin_inset Flex Code
24410 \begin_layout Plain Layout
24412 \change_inserted -584632292 1615846730
24420 A longer explanatory text that appears in the tooltip when hovering over the argument inset.
24423 \begin_layout Itemize
24425 \change_inserted -584632292 1615846730
24426 \begin_inset Flex Code
24429 \begin_layout Plain Layout
24431 \change_inserted -584632292 1615846730
24440 \begin_inset Flex Code
24443 \begin_layout Plain Layout
24445 \change_inserted -584632292 1615846730
24456 \begin_inset space \thinspace{}
24460 \begin_inset Flex Code
24463 \begin_layout Plain Layout
24465 \change_inserted -584632292 1615846730
24473 ] Declare if this is a mandatory (1) or an optional (0) argument.
24474 Mandatory arguments will be output empty if not given,
24475 while optional arguments will not be output at all.
24477 mandatory arguments are delimited by
24478 \begin_inset Flex Code
24481 \begin_layout Plain Layout
24483 \change_inserted -584632292 1615846730
24492 while optional arguments are delimited by
24493 \begin_inset Flex Code
24496 \begin_layout Plain Layout
24498 \change_inserted -584632292 1615846730
24509 \begin_layout Itemize
24511 \change_inserted -584632292 1615846730
24512 \begin_inset Flex Code
24515 \begin_layout Plain Layout
24517 \change_inserted -584632292 1615846730
24526 \begin_inset Flex Code
24529 \begin_layout Plain Layout
24531 \change_inserted -584632292 1615846730
24539 Option to define a different command (from the default
24540 \begin_inset Flex Code
24543 \begin_layout Plain Layout
24545 \change_inserted -584632292 1615846730
24557 ) to be used for line breaks.
24558 The initial backslash must not be specified.
24561 \begin_layout Itemize
24563 \change_inserted -584632292 1615846730
24564 \begin_inset Flex Code
24567 \begin_layout Plain Layout
24569 \change_inserted -584632292 1615846730
24578 \begin_inset Flex Code
24581 \begin_layout Plain Layout
24583 \change_inserted -584632292 1615846730
24591 defines another argument (by its number) which this argument requires to be output if it is itself output.
24593 \begin_inset space \thinspace{}
24597 in \SpecialChar LaTeX
24599 optional arguments often require previous optional arguments to be output (at least empty),
24601 \begin_inset Flex Code
24604 \begin_layout Plain Layout
24606 \change_inserted -584632292 1615846730
24609 command[][argument]{text}
24617 This can be achieved by the statement
24618 \begin_inset Flex Code
24621 \begin_layout Plain Layout
24623 \change_inserted -584632292 1615846730
24632 \begin_inset Flex Code
24635 \begin_layout Plain Layout
24637 \change_inserted -584632292 1615846730
24648 \begin_layout Itemize
24650 \change_inserted -584632292 1615846730
24651 \begin_inset Flex Code
24654 \begin_layout Plain Layout
24656 \change_inserted -584632292 1615846730
24665 \begin_inset Flex Code
24668 \begin_layout Plain Layout
24670 \change_inserted -584632292 1615846730
24678 defines a custom left delimiter (instead of
24679 \begin_inset Flex Code
24682 \begin_layout Plain Layout
24684 \change_inserted -584632292 1615846730
24693 \begin_inset Flex Code
24696 \begin_layout Plain Layout
24698 \change_inserted -584632292 1615846730
24707 A line break in the output can be indicated by
24708 \begin_inset Flex Code
24711 \begin_layout Plain Layout
24713 \change_inserted -584632292 1615846730
24724 \begin_layout Itemize
24726 \change_inserted -584632292 1615846730
24727 \begin_inset Flex Code
24730 \begin_layout Plain Layout
24732 \change_inserted -584632292 1615846730
24741 \begin_inset Flex Code
24744 \begin_layout Plain Layout
24746 \change_inserted -584632292 1615846730
24754 defines a custom right delimiter (instead of
24755 \begin_inset Flex Code
24758 \begin_layout Plain Layout
24760 \change_inserted -584632292 1615846730
24769 \begin_inset Flex Code
24772 \begin_layout Plain Layout
24774 \change_inserted -584632292 1615846730
24783 A line break in the output can be indicated by
24784 \begin_inset Flex Code
24787 \begin_layout Plain Layout
24789 \change_inserted -584632292 1615846730
24800 \begin_layout Itemize
24802 \change_inserted -584632292 1615846730
24803 \begin_inset Flex Code
24806 \begin_layout Plain Layout
24808 \change_inserted -584632292 1615846730
24817 \begin_inset Flex Code
24820 \begin_layout Plain Layout
24822 \change_inserted -584632292 1615846730
24830 defines an argument that is inserted if and only if no user-specified arguments were given,
24832 \begin_inset space \thinspace{}
24836 \begin_inset space \space{}
24839 if no argument inset has been inserted (note that also an empty argument inset omits the DefaultArg).
24840 Multiple arguments need to be separated by comma.
24843 \begin_layout Itemize
24845 \change_inserted -584632292 1615846730
24846 \begin_inset Flex Code
24849 \begin_layout Plain Layout
24851 \change_inserted -584632292 1615846730
24860 \begin_inset Flex Code
24863 \begin_layout Plain Layout
24865 \change_inserted -584632292 1615846730
24873 defines an argument that is inserted in any case (alone or in addition to user-specified arguments).
24874 Multiple arguments need to be separated by comma.
24877 \begin_layout Itemize
24879 \change_inserted -584632292 1615846730
24880 \begin_inset Flex Code
24883 \begin_layout Plain Layout
24885 \change_inserted -584632292 1615846730
24893 The font used for the argument content,
24895 \begin_inset CommandInset ref
24897 reference "subsec:Font-description"
24905 \begin_layout Itemize
24907 \change_inserted -584632292 1615846730
24908 \begin_inset Flex Code
24911 \begin_layout Plain Layout
24913 \change_inserted -584632292 1615846730
24922 \begin_inset Flex Code
24925 \begin_layout Plain Layout
24927 \change_inserted -584632292 1615846730
24938 \begin_inset space \thinspace{}
24942 \begin_inset Flex Code
24945 \begin_layout Plain Layout
24947 \change_inserted -584632292 1615846730
24955 ] As with paragraph styles,
24957 \begin_inset CommandInset ref
24959 reference "subsec:Paragraph-Styles"
24967 \begin_layout Itemize
24969 \change_inserted -584632292 1615846730
24970 \begin_inset Flex Code
24973 \begin_layout Plain Layout
24975 \change_inserted -584632292 1615846730
24983 The font used for the label;
24985 \begin_inset CommandInset ref
24987 reference "subsec:Font-description"
24995 \begin_layout Itemize
24997 \change_inserted -584632292 1615846730
24998 \begin_inset Flex Code
25001 \begin_layout Plain Layout
25003 \change_inserted -584632292 1615846730
25012 \begin_inset Flex Code
25015 \begin_layout Plain Layout
25017 \change_inserted -584632292 1615846730
25031 ] describes the rendering style used for the inset's frame and buttons.
25034 \begin_layout Itemize
25036 \change_inserted -584632292 1615846730
25037 \begin_inset Flex Code
25040 \begin_layout Plain Layout
25042 \change_inserted -584632292 1615846730
25051 \begin_inset Flex Code
25054 \begin_layout Plain Layout
25056 \change_inserted -584632292 1615846730
25065 \begin_inset Flex Code
25068 \begin_layout Plain Layout
25070 \change_inserted -584632292 1615846730
25079 this argument is automatically inserted when the respective style is selected.
25082 \begin_layout Itemize
25084 \change_inserted -584632292 1615846730
25085 \begin_inset Flex Code
25088 \begin_layout Plain Layout
25090 \change_inserted -584632292 1615846730
25099 \begin_inset Flex Code
25102 \begin_layout Plain Layout
25104 \change_inserted -584632292 1615846730
25113 \begin_inset Flex Code
25116 \begin_layout Plain Layout
25118 \change_inserted -584632292 1615846730
25127 this argument will be inserted on a new line with
25128 \begin_inset Flex Code
25131 \begin_layout Plain Layout
25133 \change_inserted -584632292 1615846730
25141 (only available within Flex insets).
25144 \begin_layout Itemize
25146 \change_inserted -584632292 1615846730
25147 \begin_inset Flex Code
25150 \begin_layout Plain Layout
25152 \change_inserted -584632292 1615846730
25161 \begin_inset Flex Code
25164 \begin_layout Plain Layout
25166 \change_inserted -584632292 1615846730
25175 \begin_inset Flex Code
25178 \begin_layout Plain Layout
25180 \change_inserted -584632292 1615846730
25189 this argument will be inserted with a copy of the co-text (either selected text or the whole paragraph) as content.
25192 \begin_layout Itemize
25194 \change_inserted -584632292 1615846730
25195 \begin_inset Flex Code
25198 \begin_layout Plain Layout
25200 \change_inserted -584632292 1615846730
25209 \begin_inset Flex Code
25212 \begin_layout Plain Layout
25214 \change_inserted -584632292 1615846730
25228 ] Whether the contents of this argument should be output in raw form,
25229 meaning without special translations that \SpecialChar LaTeX
25233 \begin_inset Flex Code
25236 \begin_layout Plain Layout
25238 \change_inserted -584632292 1615846730
25246 status is inherited by the inset or paragraph layout the argument belongs to,
25247 true and false change the status for the given argument only.
25250 \begin_layout Itemize
25252 \change_inserted -584632292 1615846730
25253 \begin_inset Flex Code
25256 \begin_layout Plain Layout
25258 \change_inserted -584632292 1615846730
25267 \begin_inset Flex Code
25270 \begin_layout Plain Layout
25272 \change_inserted -584632292 1615846730
25273 string of characters
25284 Defines individual characters
25285 \begin_inset Newline linebreak
25288 that should be output in raw form,
25289 meaning without special translations that \SpecialChar LaTeX
25292 contrary to PassThru,
25293 this needs to be explicitly defined for arguments.
25295 arguments do not inherit PassThruChars from their parent inset or layout.
25298 \begin_layout Itemize
25300 \change_inserted -584632292 1615846730
25301 \begin_inset Flex Code
25304 \begin_layout Plain Layout
25306 \change_inserted -584632292 1615846730
25315 \begin_inset Flex Code
25318 \begin_layout Plain Layout
25320 \change_inserted -584632292 1615846730
25331 \begin_inset space \thinspace{}
25335 \begin_inset Flex Code
25338 \begin_layout Plain Layout
25340 \change_inserted -584632292 1615846730
25348 ] If this is set to 1,
25349 the argument will output its content in the corresponding item in the table of contents.
25353 \begin_layout Standard
25355 \change_inserted -584632292 1615846730
25357 the text entered in the \SpecialChar LyX
25358 workarea in the respective layout is the last (mandatory) argument of a command if the
25359 \begin_inset Flex Code
25362 \begin_layout Plain Layout
25364 \change_inserted -584632292 1615846730
25373 \begin_inset Flex Code
25376 \begin_layout Plain Layout
25378 \change_inserted -584632292 1615846730
25388 arguments with the prefix
25389 \begin_inset Flex Code
25392 \begin_layout Plain Layout
25394 \change_inserted -584632292 1615846730
25402 are output after this workarea argument.
25403 Note that post-argument numbering restarts at 1,
25404 so the first argument following the workarea argument is
25405 \begin_inset Flex Code
25408 \begin_layout Plain Layout
25410 \change_inserted -584632292 1615846730
25419 Post-arguments are ignored in any other
25420 \begin_inset Flex Code
25423 \begin_layout Plain Layout
25425 \change_inserted -584632292 1615846730
25434 \begin_inset Flex Code
25437 \begin_layout Plain Layout
25439 \change_inserted -584632292 1615846730
25450 \begin_layout Standard
25452 \change_inserted -584632292 1615846730
25454 \begin_inset Flex Code
25457 \begin_layout Plain Layout
25459 \change_inserted -584632292 1615846730
25470 \begin_inset Flex Code
25473 \begin_layout Plain Layout
25475 \change_inserted -584632292 1615846730
25486 \begin_inset Flex Code
25489 \begin_layout Plain Layout
25491 \change_inserted -584632292 1615846730
25499 followed by the number (e.
25500 \begin_inset space \thinspace{}
25504 \begin_inset space \space{}
25508 \begin_inset Flex Code
25511 \begin_layout Plain Layout
25513 \change_inserted -584632292 1615846730
25524 \begin_layout Standard
25526 \change_inserted -584632292 1615846730
25528 there is a special argument type with the prefix
25529 \begin_inset Flex Code
25532 \begin_layout Plain Layout
25534 \change_inserted -584632292 1615846730
25543 It is not really an argument,
25544 but uses the argument interface (thus,
25545 the prefix is also followed by a number,
25547 \begin_inset space \thinspace{}
25552 \begin_inset Flex Code
25555 \begin_layout Plain Layout
25557 \change_inserted -584632292 1615846730
25558 Argument listpreamble:1
25566 As the name implies,
25567 it is targeted at lists such as
25587 Its content will be output at the list start,
25589 \begin_inset Flex Code
25592 \begin_layout Plain Layout
25594 \change_inserted -584632292 1615846730
25605 on an own line (a place that is otherwise not accessible in \SpecialChar LyX
25608 users can insert redefinitions (of lengths etc.) to individual lists.
25610 these arguments do not have a delimiter.
25615 \begin_layout Subsection
25617 \begin_inset CommandInset label
25619 name "subsec:Counters"
25626 \begin_layout Standard
25627 It is necessary to define the counters (
25628 \begin_inset Flex Noun
25631 \begin_layout Plain Layout
25639 \begin_inset Flex Noun
25642 \begin_layout Plain Layout
25650 ) in the text class itself.
25651 The standard counters are defined in the file
25652 \begin_inset Flex Code
25655 \begin_layout Plain Layout
25662 so you may have to do no more than add
25665 \begin_layout LyX-Code
25666 Input stdcounters.inc
25669 \begin_layout Standard
25670 to your layout file to get them to work.
25671 But if you want to define custom counters,
25672 then you can do so.
25673 The counter declaration must begin with:
25676 \begin_layout LyX-Code
25677 Counter CounterName
25680 \begin_layout Standard
25682 \begin_inset Flex Code
25685 \begin_layout Plain Layout
25691 ' is replaced by the name of the counter.
25692 And it must end with
25693 \begin_inset Quotes eld
25697 \begin_inset Flex Code
25700 \begin_layout Plain Layout
25707 \begin_inset Quotes erd
25711 The following parameters can also be used:
25714 \begin_layout Description
25715 \begin_inset Flex Code
25718 \begin_layout Plain Layout
25725 \begin_inset Flex Code
25728 \begin_layout Plain Layout
25734 ] Sets the initial value for the counter,
25735 to which it will be reset whenever that happens.
25737 one will want the default,
25741 \begin_layout Description
25742 \begin_inset Flex Code
25745 \begin_layout Plain Layout
25752 \begin_inset Flex Code
25755 \begin_layout Plain Layout
25762 \begin_inset Quotes erd
25766 \begin_inset Quotes erd
25770 this string defines how the counter is displayed.
25771 Setting this value sets
25772 \begin_inset Flex Code
25775 \begin_layout Plain Layout
25776 LabelStringAppendix
25782 The following special constructs can be used in the string:
25786 \begin_layout Itemize
25787 \begin_inset Flex Code
25790 \begin_layout Plain Layout
25798 will be replaced by the expansion of the
25799 \begin_inset Flex Code
25802 \begin_layout Plain Layout
25809 \begin_inset Flex Code
25812 \begin_layout Plain Layout
25813 LabelStringAppendix
25819 \begin_inset Flex Code
25822 \begin_layout Plain Layout
25832 \begin_layout Itemize
25833 counter values can be expressed using \SpecialChar LaTeX
25835 \begin_inset Newline newline
25839 \begin_inset Flex Code
25842 \begin_layout Plain Layout
25860 \begin_inset Flex Code
25863 \begin_layout Plain Layout
25875 \begin_layout Plain Layout
25886 the situation is a bit more complicated:
25906 other than those described below will produce arabic numerals.
25907 It would not be surprising to see this change in the future.
25913 \begin_inset Flex Code
25916 \begin_layout Plain Layout
25925 3,\SpecialChar ldots
25928 \begin_inset Flex Code
25931 \begin_layout Plain Layout
25937 for lower-case letters:
25944 \begin_inset Flex Code
25947 \begin_layout Plain Layout
25953 for upper-case letters:
25960 \begin_inset Flex Code
25963 \begin_layout Plain Layout
25969 for lower-case roman numerals:
25976 \begin_inset Flex Code
25979 \begin_layout Plain Layout
25985 for upper-case roman numerals:
25988 III\SpecialChar ldots
25991 \begin_inset Flex Code
25994 \begin_layout Plain Layout
26000 for hebrew numerals.
26004 \begin_layout Standard
26005 If LabelString is not defined,
26006 a default value is constructed as follows:
26007 if the counter has a
26008 \change_deleted 731793113 1604355218
26010 \change_inserted 731793113 1604355221
26014 \begin_inset Flex Code
26017 \begin_layout Plain Layout
26019 \change_deleted 731793113 1604355223
26021 \change_inserted 731793113 1604355226
26030 \begin_inset Flex Code
26033 \begin_layout Plain Layout
26041 \begin_inset Newline newline
26045 \begin_inset Flex Code
26048 \begin_layout Plain Layout
26052 \change_inserted 731793113 1604355228
26054 \change_deleted 731793113 1604355230
26065 otherwise the string
26066 \begin_inset Flex Code
26069 \begin_layout Plain Layout
26080 \begin_layout Description
26081 \begin_inset Flex Code
26084 \begin_layout Plain Layout
26085 LabelStringAppendix
26091 \begin_inset Flex Code
26094 \begin_layout Plain Layout
26101 \begin_inset Quotes eld
26105 \begin_inset Quotes erd
26109 \begin_inset Flex Code
26112 \begin_layout Plain Layout
26119 but for use in the Appendix.
26120 \change_inserted -584632292 1607202551
26124 \begin_layout Description
26126 \change_inserted -584632292 1607202682
26127 \begin_inset Flex Code
26130 \begin_layout Plain Layout
26137 \begin_inset Flex Code
26140 \begin_layout Plain Layout
26142 \change_inserted -584632292 1607202576
26151 \begin_inset Quotes eld
26155 \begin_inset Quotes erd
26158 ] The counter name as used in \SpecialChar LaTeX
26161 \change_inserted 34634807 1619711355
26163 \change_deleted 34634807 1619711355
26165 \change_inserted -584632292 1607202682
26167 in \SpecialChar LyX
26169 there is a counter named `theorem',
26170 but it is output to \SpecialChar LaTeX
26176 \begin_layout Description
26177 \begin_inset Flex Code
26180 \begin_layout Plain Layout
26187 \begin_inset Flex Code
26190 \begin_layout Plain Layout
26197 \begin_inset Quotes erd
26201 \begin_inset Quotes erd
26204 ] A format for use with formatted references to this counter.
26206 one might want to have references to section numbers appear as
26207 \begin_inset Quotes eld
26211 \begin_inset Quotes erd
26216 \change_deleted -584632292 1690588038
26218 \change_inserted -584632292 1690588041
26222 \begin_inset Quotes eld
26226 \begin_inset Quotes erd
26230 \change_inserted -584632292 1690588059
26231 or a counter specification as in
26232 \begin_inset Flex Code
26235 \begin_layout Plain Layout
26237 \change_inserted -584632292 1690588059
26249 \change_inserted -584632292 1690588078
26251 \change_deleted -584632292 1690588076
26254 will be replaced by the counter number itself.
26259 \change_inserted -584632292 1690588159
26263 \change_deleted -712698321 1691671418
26269 \change_inserted -712698321 1691671418
26271 \begin_inset Flex Code
26274 \begin_layout Plain Layout
26276 \change_inserted -712698321 1691671418
26289 \change_inserted -584632292 1690588159
26290 (which might render as §2.7)
26293 \change_inserted -584632292 1690587966
26297 \begin_layout Description
26299 \change_inserted -584632292 1690588264
26300 \begin_inset Flex Code
26303 \begin_layout Plain Layout
26305 \change_inserted -584632292 1690587970
26314 \begin_inset Flex Code
26317 \begin_layout Plain Layout
26319 \change_inserted -584632292 1690587966
26329 \begin_inset Flex Code
26332 \begin_layout Plain Layout
26334 \change_inserted -584632292 1690587981
26342 ] For use with `formatted references',
26343 specifically when a single counter is used with multiple sorts of styles.
26346 \begin_inset Flex Code
26349 \begin_layout Plain Layout
26351 \change_inserted -584632292 1690588222
26359 counter is often used for all sorts of theorem-like environments:
26363 \change_deleted -712698321 1691671691
26365 \change_inserted -584632292 1690588264
26367 The first argument gives a prefix used in the labels (e.g.,
26369 \begin_inset Quotes eld
26373 \begin_inset Quotes erd
26377 \begin_inset Quotes eld
26381 \begin_inset Quotes erd
26385 and the second a formatting string,
26387 \begin_inset Flex Code
26390 \begin_layout Plain Layout
26392 \change_inserted -584632292 1690588181
26401 \begin_inset Flex Code
26404 \begin_layout Plain Layout
26406 \change_inserted -584632292 1690588177
26415 If this is not given,
26417 \begin_inset Flex Code
26420 \begin_layout Plain Layout
26422 \change_inserted -584632292 1690588264
26433 \begin_layout Description
26434 \begin_inset Flex Code
26437 \begin_layout Plain Layout
26444 \begin_inset Flex Code
26447 \begin_layout Plain Layout
26454 \begin_inset Quotes erd
26458 \begin_inset Quotes erd
26461 ] If this is set to the name of another counter,
26462 the present counter will be reset every time the other one is increased.
26465 \begin_inset Flex Code
26468 \begin_layout Plain Layout
26475 \begin_inset Flex Code
26478 \begin_layout Plain Layout
26487 \begin_layout Subsection
26489 \begin_inset CommandInset label
26491 name "subsec:Font-description"
26498 \begin_layout Standard
26499 A font description looks like this:
26502 \begin_layout LyX-Code
26519 \begin_layout LyX-Code
26523 \begin_layout LyX-Code
26527 \begin_layout Standard
26528 The following commands are available:
26531 \begin_layout Description
26532 \begin_inset Flex Code
26535 \begin_layout Plain Layout
26542 \change_deleted -712698321 1607682984
26544 \begin_inset Flex Code
26547 \begin_layout Plain Layout
26557 \begin_inset Flex Code
26560 \begin_layout Plain Layout
26568 \begin_inset Flex Code
26571 \begin_layout Plain Layout
26579 \begin_inset Flex Code
26582 \begin_layout Plain Layout
26590 \begin_inset Flex Code
26593 \begin_layout Plain Layout
26601 \begin_inset Flex Code
26604 \begin_layout Plain Layout
26612 \begin_inset Flex Code
26615 \begin_layout Plain Layout
26623 \begin_inset Flex Code
26626 \begin_layout Plain Layout
26634 \begin_inset Flex Code
26637 \begin_layout Plain Layout
26645 \begin_inset Flex Code
26648 \begin_layout Plain Layout
26656 \begin_inset Flex Code
26659 \begin_layout Plain Layout
26667 \begin_inset Flex Code
26670 \begin_layout Plain Layout
26678 \begin_inset Flex Code
26681 \begin_layout Plain Layout
26689 \begin_inset Flex Code
26692 \begin_layout Plain Layout
26700 \begin_inset Flex Code
26703 \begin_layout Plain Layout
26711 \begin_inset Flex Code
26714 \begin_layout Plain Layout
26722 \begin_inset Flex Code
26725 \begin_layout Plain Layout
26733 \begin_inset Flex Code
26736 \begin_layout Plain Layout
26744 \begin_inset Flex Code
26747 \begin_layout Plain Layout
26755 \begin_inset Flex Code
26758 \begin_layout Plain Layout
26765 \change_inserted -712698321 1607683139
26767 \begin_inset Flex Code
26770 \begin_layout Plain Layout
26772 \change_inserted -712698321 1607683135
26781 \begin_inset space ~
26785 \begin_inset CommandInset ref
26787 reference "chap:Names-of-colors"
26796 \change_deleted -712698321 1607683144
26798 \change_inserted -712698321 1607683146
26804 \begin_layout Description
26805 \begin_inset Flex Code
26808 \begin_layout Plain Layout
26815 \begin_inset Flex Code
26818 \begin_layout Plain Layout
26828 \begin_inset Flex Code
26831 \begin_layout Plain Layout
26839 \begin_inset Flex Code
26842 \begin_layout Plain Layout
26851 \begin_layout Description
26852 \begin_inset Flex Code
26855 \begin_layout Plain Layout
26862 \begin_inset Flex Code
26865 \begin_layout Plain Layout
26871 ] Valid arguments are:
26873 \begin_inset Flex Code
26876 \begin_layout Plain Layout
26884 \begin_inset Flex Code
26887 \begin_layout Plain Layout
26895 \begin_inset Flex Code
26898 \begin_layout Plain Layout
26906 \begin_inset Flex Code
26909 \begin_layout Plain Layout
26917 \begin_inset Flex Code
26920 \begin_layout Plain Layout
26928 \begin_inset Flex Code
26931 \begin_layout Plain Layout
26939 \begin_inset Flex Code
26942 \begin_layout Plain Layout
26950 \begin_inset Flex Code
26953 \begin_layout Plain Layout
26961 \begin_inset Flex Code
26964 \begin_layout Plain Layout
26972 \begin_inset Flex Code
26975 \begin_layout Plain Layout
26983 \begin_inset Flex Code
26986 \begin_layout Plain Layout
26993 \begin_inset Flex Code
26996 \begin_layout Plain Layout
27003 Each of these turns on or off the corresponding attribute.
27006 \begin_inset Flex Code
27009 \begin_layout Plain Layout
27017 \begin_inset Flex Code
27020 \begin_layout Plain Layout
27028 \begin_inset Newline newline
27031 If the latter seems puzzling,
27032 remember that the font settings for the present context are generally inherited from the surrounding context.
27034 \begin_inset Flex Code
27037 \begin_layout Plain Layout
27043 would turn off the emphasis that was anyway in effect,
27045 in a theorem environment.
27048 \begin_layout Description
27049 \begin_inset Flex Code
27052 \begin_layout Plain Layout
27059 \begin_inset Flex Code
27062 \begin_layout Plain Layout
27072 \begin_inset Flex Code
27075 \begin_layout Plain Layout
27084 \begin_layout Description
27085 \begin_inset Flex Code
27088 \begin_layout Plain Layout
27095 \begin_inset Flex Code
27098 \begin_layout Plain Layout
27108 \begin_inset Flex Code
27111 \begin_layout Plain Layout
27119 \begin_inset Flex Code
27122 \begin_layout Plain Layout
27130 \begin_inset Flex Code
27133 \begin_layout Plain Layout
27142 \begin_layout Description
27143 \begin_inset Flex Code
27146 \begin_layout Plain Layout
27153 \begin_inset Flex Code
27156 \begin_layout Plain Layout
27164 \begin_inset Flex Code
27167 \begin_layout Plain Layout
27175 \begin_inset Flex Code
27178 \begin_layout Plain Layout
27188 \begin_inset Flex Code
27191 \begin_layout Plain Layout
27199 \begin_inset Flex Code
27202 \begin_layout Plain Layout
27210 \begin_inset Flex Code
27213 \begin_layout Plain Layout
27221 \begin_inset Flex Code
27224 \begin_layout Plain Layout
27232 \begin_inset Flex Code
27235 \begin_layout Plain Layout
27244 \begin_layout Subsection
27245 \begin_inset CommandInset label
27247 name "subsec:Citation-engine-description"
27251 Cite engine description
27254 \begin_layout Standard
27256 \begin_inset Flex Code
27259 \begin_layout Plain Layout
27266 as used mainly in cite engine files (see
27267 \begin_inset CommandInset ref
27269 reference "subsec:Cite-Engine-Files"
27278 define the citation commands provided by a specific
27279 \begin_inset Quotes eld
27283 \begin_inset Quotes erd
27288 in \SpecialChar LyX
27290 is way specific way to format citations,
27292 author names and/or years.
27295 supports three such engine types,
27299 \begin_layout Enumerate
27300 \begin_inset Flex Code
27303 \begin_layout Plain Layout
27310 the default Bib\SpecialChar TeX
27311 way to format citations,
27312 a simple numeric style (e.
27313 \begin_inset space \thinspace{}
27318 \begin_inset Quotes eld
27322 \begin_inset Quotes erd
27328 \begin_layout Enumerate
27329 \begin_inset Flex Code
27332 \begin_layout Plain Layout
27339 Harvard-styled citations using author names and publication year (e.
27340 \begin_inset space \thinspace{}
27345 \begin_inset Quotes eld
27348 Smith and Miller (2017b)
27349 \begin_inset Quotes erd
27355 \begin_layout Enumerate
27356 \begin_inset Flex Code
27359 \begin_layout Plain Layout
27366 extended numerical citations that also allow for author or title next to the number (e.
27367 \begin_inset space \thinspace{}
27372 \begin_inset Quotes eld
27375 Smith and Miller [1]
27376 \begin_inset Quotes erd
27382 \begin_layout Standard
27383 \begin_inset Flex Code
27386 \begin_layout Plain Layout
27392 blocks look like this:
27395 \begin_layout LyX-Code
27399 \begin_layout LyX-Code
27403 \begin_layout LyX-Code
27407 \begin_layout LyX-Code
27408 citeyearpar[][]=parencite*
27411 \begin_layout LyX-Code
27415 \begin_layout LyX-Code
27419 \begin_layout Standard
27421 \begin_inset Flex Code
27424 \begin_layout Plain Layout
27430 denotes the engine.
27431 The individual lines respectively define a cite command or cite command paradigm supported by this engine.
27432 The line can be as simple as a cite command that is used both to name the respective \SpecialChar LyX
27433 command and the \SpecialChar LaTeX
27434 output or more complex in order to differentiate things.
27435 The full syntax is:
27438 \begin_layout LyX-Code
27439 LyXName|alias$*<!_stardesc!_stardesctooltip>[][]=latexcmd
27442 \begin_layout Itemize
27443 \begin_inset Flex Code
27446 \begin_layout Plain Layout
27453 The name as used in the
27454 \begin_inset Flex Code
27457 \begin_layout Plain Layout
27467 \begin_layout Standard
27468 For portability reasons,
27469 we try to use the same name for same-formatted commands in different cite packages (thus many names stem from natbib,
27470 and thus we need to differentiate a
27471 \begin_inset Flex Code
27474 \begin_layout Plain Layout
27481 if the \SpecialChar LaTeX
27482 command names differ).
27486 \begin_layout Itemize
27487 \begin_inset Flex Code
27490 \begin_layout Plain Layout
27497 a (comma-separated) list of commands that fall back to the given
27498 \begin_inset Flex Code
27501 \begin_layout Plain Layout
27507 in the current engine.
27508 This eases the switch of citation packages and engines.
27510 \begin_inset Flex Code
27513 \begin_layout Plain Layout
27520 \begin_inset Flex Code
27523 \begin_layout Plain Layout
27529 in layout definitions.
27532 \begin_layout Itemize
27533 \begin_inset Flex Code
27536 \begin_layout Plain Layout
27543 The actual \SpecialChar LaTeX
27544 command that is output.
27548 \begin_layout Standard
27549 \begin_inset Flex Code
27552 \begin_layout Plain Layout
27559 \begin_inset Flex Code
27562 \begin_layout Plain Layout
27570 \begin_inset Flex Code
27573 \begin_layout Plain Layout
27581 \begin_inset Flex Code
27584 \begin_layout Plain Layout
27590 will be output to \SpecialChar LaTeX
27594 \begin_layout Standard
27598 \begin_layout Itemize
27599 Capitalization indicates that the command also has a capitalized form (
27600 \begin_inset Flex Code
27603 \begin_layout Plain Layout
27613 \begin_inset Flex Code
27616 \begin_layout Plain Layout
27625 These usually enforce up-casing of name prefixes (
27630 \begin_inset Formula $\Rightarrow$
27640 \begin_layout Itemize
27642 \begin_inset Flex Code
27645 \begin_layout Plain Layout
27651 indicate the number of optional arguments (there can be 0–2).
27654 \begin_layout Itemize
27656 \begin_inset Flex Code
27659 \begin_layout Plain Layout
27665 indicates there is a starred version of the command (
27666 \begin_inset Flex Code
27669 \begin_layout Plain Layout
27679 \begin_inset Flex Code
27682 \begin_layout Plain Layout
27695 \begin_layout Standard
27697 the starred version means:
27698 Output all authors even if it should be shortened with
27699 \begin_inset Quotes eld
27703 \begin_inset Quotes erd
27707 \begin_inset Flex Code
27710 \begin_layout Plain Layout
27719 \begin_layout Standard
27720 If the star has a different meaning for a given command,
27721 it can be specified in angle brackets:
27723 \begin_inset Flex Code
27726 \begin_layout Plain Layout
27727 <!_stardesc!_stardesctooltip>
27733 Maximal two translatable macro keywords,
27734 marked by the prefix
27735 \begin_inset Flex Code
27738 \begin_layout Plain Layout
27746 The first points to the string that replaces the
27747 \begin_inset Quotes eld
27751 \begin_inset Quotes erd
27754 checkbox label in the citation dialog,
27755 the second one to an optional tool tip for this checkbox.
27759 \begin_layout Standard
27760 Note that these two macros have to be defined in a
27761 \begin_inset Flex Code
27764 \begin_layout Plain Layout
27770 (see next section),
27772 \begin_inset Flex Code
27775 \begin_layout Plain Layout
27786 \begin_layout LyX-Code
27787 _stardesc Sta&rred command label
27790 \begin_layout LyX-Code
27791 _stardesctooltip Tooltip for the starred command checkbox.
27795 \begin_layout Itemize
27797 \begin_inset Flex Code
27800 \begin_layout Plain Layout
27806 indicates that this command features
27807 \begin_inset Quotes eld
27810 qualified citation lists
27811 \begin_inset Quotes erd
27819 -specific feature for multi-reference citations where an individual pre- and postnote can be given to each reference in the list.
27820 Please refer to the
27824 manual for details.
27825 \change_inserted -712698321 1526898670
27829 \begin_layout Standard
27831 \change_inserted -712698321 1526899524
27832 If you want to add a cite command to a cite engine (e.
27833 \begin_inset space \thinspace{}
27837 add a specific command provided by a class),
27839 \begin_inset Flex Code
27842 \begin_layout Plain Layout
27844 \change_inserted -712698321 1526898768
27845 AddToCiteEngine <engine type> \SpecialChar ldots
27854 Note that only cite commands that do not exist yet are added.
27859 \begin_layout Subsection
27860 \begin_inset CommandInset label
27862 name "subsec:Citation-format-description"
27866 Cite format description
27869 \begin_layout Standard
27871 \begin_inset Flex Code
27874 \begin_layout Plain Layout
27880 blocks are used to describe how bibliographic information should be displayed,
27881 both within \SpecialChar LyX
27882 itself (in the citation dialog and in tooltips,
27883 for example) and in XHTML output.
27884 Such a block might look like this:
27887 \begin_layout LyX-Code
27891 \begin_layout LyX-Code
27895 \begin_layout LyX-Code
27899 \begin_layout LyX-Code
27903 \begin_layout Standard
27907 \begin_layout LyX-Code
27911 \begin_layout LyX-Code
27915 \begin_layout LyX-Code
27919 \begin_layout LyX-Code
27923 \begin_layout Standard
27925 the individual lines define how the bibliographic information associated with an article or book,
27927 is to be displayed,
27928 and such a definition can be given for any
27929 \begin_inset Quotes els
27933 \begin_inset Quotes ers
27936 that might be present in a Bib\SpecialChar TeX
27939 defines a default format in the source code that will be used if no specific definition has been given.
27941 predefines several formats in the file
27942 \begin_inset Flex Code
27945 \begin_layout Plain Layout
27952 which is included in most of \SpecialChar LyX
27953 's document classes.
27956 \begin_layout Standard
27957 In the second case,
27958 the lines define how a specific citation command (in the example
27959 \begin_inset Flex Code
27962 \begin_layout Plain Layout
27972 \begin_inset Flex Code
27975 \begin_layout Plain Layout
27983 ) is to be displayed on the citation inset label,
27984 in the citation dialog,
27985 menu or XHTML output.
27987 defines such formats for the citation style variants it supports via
27989 Document\SpecialChar menuseparator
27990 Setting\SpecialChar menuseparator
27991 Bibliography\SpecialChar ldots
27995 \begin_inset Flex Code
27998 \begin_layout Plain Layout
28004 files that are shipped with \SpecialChar LyX
28006 \begin_inset CommandInset ref
28008 reference "subsec:Cite-Engine-Files"
28019 \begin_layout Standard
28020 The definitions use a simple language that allows Bib\SpecialChar TeX
28021 keys to be replaced with their values.
28022 Keys should be enclosed in
28023 \begin_inset Flex Code
28026 \begin_layout Plain Layout
28035 \begin_inset Flex Code
28038 \begin_layout Plain Layout
28045 So a simple definition might look like this:
28048 \begin_layout LyX-Code
28051 \begin_inset Quotes eld
28055 \begin_inset Quotes erd
28061 \begin_layout Standard
28062 This would print the author,
28063 followed by a comma,
28064 followed by the title,
28066 followed by a period.
28069 \begin_layout Standard
28071 sometimes you may want to print a key only if it exists.
28072 This can be done by using a conditional construction,
28075 \begin_inset Flex Code
28078 \begin_layout Plain Layout
28080 \begin_inset space ~
28091 \begin_inset Flex Code
28094 \begin_layout Plain Layout
28102 \begin_inset Quotes eld
28106 \begin_inset space ~
28110 \begin_inset Quotes erd
28113 followed by the volume key.
28114 It is also possible to have an else clause in the conditional,
28116 \begin_inset Newline newline
28120 \begin_inset Flex Code
28123 \begin_layout Plain Layout
28124 {%author%[[%author%]][[%editor%,
28131 \begin_inset Newline newline
28136 \begin_inset Flex Code
28139 \begin_layout Plain Layout
28145 key is printed if it exists;
28147 the editor key is printed,
28149 \begin_inset Quotes eld
28153 \begin_inset space ~
28157 \begin_inset Quotes erd
28160 Note that the key is again enclosed in
28161 \begin_inset Flex Code
28164 \begin_layout Plain Layout
28171 the entire conditional is enclosed in braces;
28172 and the if and else clauses are enclosed in double brackets,
28174 \begin_inset Quotes eld
28178 \begin_inset Flex Code
28181 \begin_layout Plain Layout
28188 \begin_inset Quotes eld
28192 \begin_inset Quotes eld
28196 \begin_inset Flex Code
28199 \begin_layout Plain Layout
28206 \begin_inset Quotes erd
28210 There must be no space between any of these.
28213 \begin_layout Standard
28214 Next to the entry keys,
28215 there are some special keys that can be used for these conditionals:
28218 \begin_layout Itemize
28219 \begin_inset Flex Code
28222 \begin_layout Plain Layout
28223 {%dialog%[[true]][[false]]}
28230 \begin_inset Quotes eld
28234 \begin_inset Quotes erd
28237 part for dialogs and menus,
28239 \begin_inset Quotes eld
28243 \begin_inset Quotes erd
28246 part for other contexts (workarea,
28250 \begin_layout Itemize
28251 \begin_inset Flex Code
28254 \begin_layout Plain Layout
28255 {%export%[[true]][[false]]}
28262 \begin_inset Quotes eld
28266 \begin_inset Quotes erd
28269 part for export and menus,
28271 \begin_inset Quotes eld
28275 \begin_inset Quotes erd
28278 part for other contexts (workarea,
28282 \begin_layout Itemize
28283 \begin_inset Flex Code
28286 \begin_layout Plain Layout
28294 \begin_inset Quotes eld
28298 \begin_inset Quotes erd
28301 part if another item follows (e.
28302 \begin_inset space \thinspace{}
28306 in a citation with multiple keys)
28309 \begin_layout Itemize
28310 \begin_inset Flex Code
28313 \begin_layout Plain Layout
28314 {%second%[[true]][[false]]}
28321 \begin_inset Quotes eld
28325 \begin_inset Quotes erd
28328 if this is the second of multiple items,
28330 \begin_inset Quotes eld
28334 \begin_inset Quotes erd
28340 \begin_layout Itemize
28341 \begin_inset Flex Code
28344 \begin_layout Plain Layout
28345 {%ifstar%[[true]][[false]]}
28352 \begin_inset Quotes eld
28356 \begin_inset Quotes erd
28359 part for starred citation commands (such as
28360 \begin_inset Flex Code
28363 \begin_layout Plain Layout
28372 the false part for unstarred
28375 \begin_layout Itemize
28376 \begin_inset Flex Code
28379 \begin_layout Plain Layout
28380 {%ifentrytype:<type>%[[true]][[false]]}
28387 \begin_inset Quotes eld
28391 \begin_inset Quotes erd
28394 if the current entry type matches
28395 \begin_inset Flex Code
28398 \begin_layout Plain Layout
28405 else the false part (e.g.,
28406 in a citation definition:
28408 \begin_inset Flex Code
28411 \begin_layout Plain Layout
28412 {%ifentrytype:book%[[this is a book]][[this is no book]]}
28420 \begin_layout Itemize
28421 \begin_inset Flex Code
28424 \begin_layout Plain Layout
28425 {%ifmultiple:<authortype>%[[true]][[false]]}
28432 \begin_inset Quotes eld
28436 \begin_inset Quotes erd
28439 if the current author type (author,
28440 editor etc.) has multiple authors,
28441 else the false part (e.g.,
28442 in a bibliography definition:
28444 \begin_inset Flex Code
28447 \begin_layout Plain Layout
28448 {%ifmultiple:editor%[[eds.]][[ed.]]}
28456 \begin_layout Itemize
28457 \begin_inset Flex Code
28460 \begin_layout Plain Layout
28461 {%ifqualified%[[true]][[false]]}
28468 \begin_inset Quotes eld
28472 \begin_inset Quotes erd
28475 part if the current citation is a qualified citation list (a specific
28479 format for multi-reference citations),
28480 the false part if this is not the case.
28483 \begin_layout Standard
28485 \begin_inset Flex Code
28488 \begin_layout Plain Layout
28494 prints the author key as it is recorded in the bibliography file.
28495 This might not be what you want,
28496 since it will result in a string such as
28497 \begin_inset Quotes eld
28504 \begin_inset Quotes erd
28508 \begin_inset Quotes eld
28512 \begin_inset Quotes erd
28515 is used by Bib\SpecialChar TeX
28516 to delimit authors).
28518 therefore provides some methods to get properly formatted name lists (which will also get translated).
28519 The following keys are provided:
28522 \begin_layout Enumerate
28523 For name lists with pre- and surname,
28524 suitable for the main authors/editors of a bibliography item.
28526 \begin_inset Flex Code
28529 \begin_layout Plain Layout
28535 part denotes the kind of list that is requested (e.g.
28537 \begin_inset Flex Code
28540 \begin_layout Plain Layout
28550 \begin_layout Itemize
28551 \begin_inset Flex Code
28554 \begin_layout Plain Layout
28555 %abbrvnames:<nametype>%
28561 Provides a name list which is abbreviated (with
28562 \begin_inset Quotes eld
28566 \begin_inset Quotes erd
28570 \begin_inset Flex Code
28573 \begin_layout Plain Layout
28582 \begin_layout Itemize
28583 \begin_inset Flex Code
28586 \begin_layout Plain Layout
28587 %fullnames:<nametype>%
28593 Provides a full name list (never abbreviated with
28594 \begin_inset Quotes eld
28598 \begin_inset Quotes erd
28604 \begin_layout Itemize
28605 \begin_inset Flex Code
28608 \begin_layout Plain Layout
28609 %forceabbrvnames:<nametype>%
28615 Provides a name list which is always abbreviated (with
28616 \begin_inset Quotes eld
28620 \begin_inset Quotes erd
28624 \begin_inset Flex Code
28627 \begin_layout Plain Layout
28637 \begin_layout Enumerate
28638 Alternative name lists with pre- and surname,
28639 if the order of pre- and surname inside the bibliography item differs (as in:
28641 \begin_inset Quotes eld
28651 \begin_inset Quotes erd
28658 \begin_layout Itemize
28659 \begin_inset Flex Code
28662 \begin_layout Plain Layout
28663 %abbrvbynames:<nametype>%
28669 Provides a name list which is abbreviated (with
28670 \begin_inset Quotes eld
28674 \begin_inset Quotes erd
28678 \begin_inset Flex Code
28681 \begin_layout Plain Layout
28690 \begin_layout Itemize
28691 \begin_inset Flex Code
28694 \begin_layout Plain Layout
28695 %fullbynames:<nametype>%
28701 Provides a full name list (never abbreviated with
28702 \begin_inset Quotes eld
28706 \begin_inset Quotes erd
28712 \begin_layout Itemize
28713 \begin_inset Flex Code
28716 \begin_layout Plain Layout
28717 %forceabbrvbynames:<nametype>%
28723 Provides a name list which is always abbreviated (with
28724 \begin_inset Quotes eld
28728 \begin_inset Quotes erd
28732 \begin_inset Flex Code
28735 \begin_layout Plain Layout
28745 \begin_layout Enumerate
28746 And finally name lists which consist of family names only,
28747 as used in author-year citation labels.
28748 These do not take a
28749 \begin_inset Flex Code
28752 \begin_layout Plain Layout
28759 but always return either an author list or,
28760 if this does not exist,
28761 an editor list (as common in author-year labels):
28765 \begin_layout Itemize
28766 \begin_inset Flex Code
28769 \begin_layout Plain Layout
28776 Provides a name list which is abbreviated (with
28777 \begin_inset Quotes eld
28781 \begin_inset Quotes erd
28785 \begin_inset Flex Code
28788 \begin_layout Plain Layout
28797 \begin_layout Itemize
28798 \begin_inset Flex Code
28801 \begin_layout Plain Layout
28808 Provides a full name list (never abbreviated with
28809 \begin_inset Quotes eld
28813 \begin_inset Quotes erd
28819 \begin_layout Itemize
28820 \begin_inset Flex Code
28823 \begin_layout Plain Layout
28824 %forceabbrvciteauthor%
28830 Provides a name list which is always abbreviated (with
28831 \begin_inset Quotes eld
28835 \begin_inset Quotes erd
28839 \begin_inset Flex Code
28842 \begin_layout Plain Layout
28852 \begin_layout Standard
28853 The order of pre- and surname in the former two lists can be adjusted by these macros:
28856 \begin_layout Itemize
28857 \begin_inset Flex Code
28860 \begin_layout Plain Layout
28861 !firstnameform %surname%,
28867 (first author in lists of type 1)
28870 \begin_layout Itemize
28871 \begin_inset Flex Code
28874 \begin_layout Plain Layout
28875 !othernameform %surname%,
28881 (other authors in lists of type 1)
28884 \begin_layout Itemize
28885 \begin_inset Flex Code
28888 \begin_layout Plain Layout
28889 !firstbynameform %prename% %surname%
28894 (first author in lists of type 2)
28897 \begin_layout Itemize
28898 \begin_inset Flex Code
28901 \begin_layout Plain Layout
28902 !otherbynameform %prename% %surname%
28907 (other authors in lists of type 2)
28910 \begin_layout Standard
28911 This allows you to configure namings like
28912 \begin_inset Quotes eld
28916 Peter and Mary Smith:
28920 John Doe and Pat Green,
28921 eds.:\SpecialChar ldots
28923 \begin_inset Quotes erd
28929 \begin_layout Standard
28930 There is one other piece of syntax available in definitions,
28931 which looks like this:
28933 \begin_inset Flex Code
28936 \begin_layout Plain Layout
28943 This defines a piece of formatting information that is to be used when creating
28944 \begin_inset Quotes eld
28948 \begin_inset Quotes erd
28953 we do not want to output HTML tags when writing plain text,
28954 so they should be wrapped in
28955 \begin_inset Quotes eld
28959 \begin_inset Quotes erd
28963 \begin_inset Quotes eld
28967 \begin_inset Quotes erd
28973 \begin_layout Standard
28974 Two special sorts of definitions are also possible in a
28975 \begin_inset Flex Code
28978 \begin_layout Plain Layout
28985 An example of the first would be:
28988 \begin_layout LyX-Code
28990 \begin_inset Quotes eld
28994 \begin_inset Quotes erd
29000 \begin_layout Standard
29001 This is an abbreviation,
29003 and it can be used by treating it as if it were a key:
29005 \begin_inset Flex Code
29008 \begin_layout Plain Layout
29017 \begin_inset Flex Code
29020 \begin_layout Plain Layout
29026 exactly as it would treat its definition.
29028 let us issue the obvious
29036 \begin_layout LyX-Code
29040 \begin_layout Standard
29041 or anything like it.
29043 shouldn't go into an infinite loop,
29044 but it may go into a long one before it gives up.
29047 \begin_layout Standard
29048 The second sort of special definition might look like this:
29051 \begin_layout LyX-Code
29055 \begin_layout Standard
29056 This defines a translatable piece of text,
29057 which allows relevant parts of the bibliography or citation to be translated.
29058 It can be included in a definition by treating it as a key:
29060 \begin_inset Flex Code
29063 \begin_layout Plain Layout
29070 Note that there are two different translation paths:
29071 All definitions starting with
29072 \begin_inset Flex Code
29075 \begin_layout Plain Layout
29082 such as in the example above,
29083 will be translated to the currently active buffer language (so the translation will match the generated document).
29084 All definitions starting with underscore only will be translated to the GUI language.
29085 This is the proper translation for strings that only occur in the dialogs or on buttons,
29089 \begin_layout LyX-Code
29090 _addtobib Add to bibliography only.
29093 \begin_layout Standard
29094 Several of these translatable strings are predefined in
29095 \begin_inset Flex Code
29098 \begin_layout Plain Layout
29105 \begin_inset Flex Code
29108 \begin_layout Plain Layout
29115 Note that these are not macros,
29116 in the sense just defined.
29117 They will not be expanded.
29120 \begin_layout Standard
29121 So here then is an example that uses several of these features:
29122 \begin_inset VSpace defskip
29128 \begin_layout Standard
29132 !authoredit {%author%[[%author%,
29133 ]][[{%editor%[[%editor%,
29138 \begin_layout Standard
29139 \begin_inset VSpace defskip
29142 This defines a macro that prints the author,
29143 followed by a comma,
29145 \begin_inset Flex Code
29148 \begin_layout Plain Layout
29155 or else prints the name of the editor,
29157 \begin_inset Flex Code
29160 \begin_layout Plain Layout
29166 or its translation (it is by default
29167 \begin_inset Quotes eld
29171 \begin_inset Quotes erd
29176 \begin_inset Flex Code
29179 \begin_layout Plain Layout
29186 Note that this is in fact defined in
29187 \begin_inset Flex Code
29190 \begin_layout Plain Layout
29197 so you can use it in your own definitions,
29199 if you load that file first.
29202 \begin_layout Section
29203 \begin_inset CommandInset label
29205 name "sec:Tags-for-XHTML"
29209 Tags for XHTML output
29212 \begin_layout Standard
29213 As with \SpecialChar LaTeX
29215 the format of \SpecialChar LyX
29216 's XHTML output is also controlled by layout information.
29219 provides sensible defaults and,
29220 as mentioned earlier,
29221 it will even construct default CSS style rules from the other layout tags.
29224 will attempt to use the information provided in the
29225 \begin_inset Flex Code
29228 \begin_layout Plain Layout
29234 declaration for the Chapter style to write CSS that will appropriately format chapter headings.
29237 \begin_layout Standard
29240 you may not have to do anything at all to get acceptable XHTML output for your own environments,
29243 But in some cases you will,
29244 and so \SpecialChar LyX
29245 provides a number of layout tags that can be used to customize the XHTML and CSS that are generated.
29248 \begin_layout Standard
29249 Note that there are two tags,
29251 \begin_inset Flex Code
29254 \begin_layout Plain Layout
29261 \begin_inset Flex Code
29264 \begin_layout Plain Layout
29270 that may appear outside style and inset declarations.
29272 \begin_inset CommandInset ref
29274 reference "subsec:General-text-class"
29279 for details on these.
29282 \begin_layout Subsection
29283 \begin_inset CommandInset label
29285 name "subsec:Paragraph-Style-XHTML"
29292 \begin_layout Standard
29293 The sort of XHTML \SpecialChar LyX
29294 outputs for a paragraph depends upon whether we are dealing with a normal paragraph,
29297 where this is itself determined by the contents of the corresponding
29298 \begin_inset Flex Code
29301 \begin_layout Plain Layout
29312 \begin_layout Standard
29313 For a command or normal paragraph,
29314 the output XHTML has the following form:
29317 \begin_layout LyX-Code
29321 \begin_inset Quotes erd
29325 \begin_inset Quotes erd
29331 \begin_layout LyX-Code
29335 \begin_inset Quotes erd
29339 \begin_inset Quotes erd
29345 \begin_layout LyX-Code
29348 Contents of the paragraph.
29351 \begin_layout LyX-Code
29357 \begin_layout Standard
29358 The label tags are of course omitted if the paragraph does not have a label.
29361 \begin_layout Standard
29362 For an environment that is not some sort of list,
29363 the XHTML takes this form:
29366 \begin_layout LyX-Code
29370 \begin_inset Quotes erd
29374 \begin_inset Quotes erd
29380 \begin_layout LyX-Code
29384 \begin_inset Quotes erd
29388 \begin_inset Quotes erd
29392 \begin_inset Quotes erd
29396 \begin_inset Quotes erd
29399 >Environment Label</labeltag>First paragraph.</itemtag>
29402 \begin_layout LyX-Code
29405 <itemtag>Second paragraph.</itemtag>
29408 \begin_layout LyX-Code
29414 \begin_layout Standard
29415 Note that the label is output only for the first paragraph,
29416 as it should be for a theorem,
29421 \begin_layout Standard
29423 we have one of these forms:
29426 \begin_layout LyX-Code
29430 \begin_inset Quotes erd
29434 \begin_inset Quotes erd
29440 \begin_layout LyX-Code
29444 \begin_inset Quotes erd
29448 \begin_inset Quotes erd
29452 \begin_inset Quotes erd
29456 \begin_inset Quotes erd
29459 >List Label</labeltag>First item.</itemtag>
29462 \begin_layout LyX-Code
29466 \begin_inset Quotes erd
29470 \begin_inset Quotes erd
29474 \begin_inset Quotes erd
29478 \begin_inset Quotes erd
29481 >List Label</labeltag>Second item.</itemtag>
29484 \begin_layout LyX-Code
29490 \begin_layout LyX-Code
29494 \begin_layout LyX-Code
29498 \begin_inset Quotes erd
29502 \begin_inset Quotes erd
29508 \begin_layout LyX-Code
29512 \begin_inset Quotes erd
29516 \begin_inset Quotes erd
29519 >List Label</labeltag><itemtag attr=
29520 \begin_inset Quotes erd
29524 \begin_inset Quotes erd
29527 >First item.</itemtag>
29530 \begin_layout LyX-Code
29534 \begin_inset Quotes erd
29538 \begin_inset Quotes erd
29541 >List Label</labeltag><itemtag attr=
29542 \begin_inset Quotes erd
29546 \begin_inset Quotes erd
29549 >Second item.</itemtag>
29552 \begin_layout LyX-Code
29558 \begin_layout Standard
29559 Note the different orders of
29560 \begin_inset Flex Code
29563 \begin_layout Plain Layout
29570 \begin_inset Flex Code
29573 \begin_layout Plain Layout
29580 Which order we get depends upon the setting of
29581 \begin_inset Flex Code
29584 \begin_layout Plain Layout
29592 \begin_inset Flex Code
29595 \begin_layout Plain Layout
29601 is false (the default),
29602 you get the first of these,
29603 with the label within the item;
29605 you get the second,
29606 with the label outside the item.
29609 \begin_layout Standard
29610 The specific tags and attributes output for each paragraph type can be controlled by means of the layout tags we are about to describe.
29611 As mentioned earlier,
29614 uses sensible defaults for many of these,
29615 so you often may not need to do very much to get good XHTML output.
29616 Think of the available tags as there so you can tweak things to your liking.
29619 \begin_layout Description
29620 \begin_inset Flex Code
29623 \begin_layout Plain Layout
29630 \begin_inset Flex Code
29633 \begin_layout Plain Layout
29639 ] Specifies attribute information to be output with the main tag.
29642 \begin_inset Quotes eld
29646 \begin_inset Flex Code
29649 \begin_layout Plain Layout
29656 \begin_inset Quotes erd
29663 \begin_inset Quotes eld
29667 \begin_inset Flex Code
29670 \begin_layout Plain Layout
29677 \begin_inset Quotes erd
29682 \begin_inset Flex Code
29685 \begin_layout Plain Layout
29691 is the \SpecialChar LyX
29692 name of the layout,
29700 contain any style information.
29702 \begin_inset Flex Code
29705 \begin_layout Plain Layout
29712 \change_inserted -584632292 1670182206
29716 \begin_layout Description
29718 \change_inserted -584632292 1670182369
29719 \begin_inset Flex Code
29722 \begin_layout Plain Layout
29724 \change_inserted -584632292 1670182222
29733 \begin_inset Flex Code
29736 \begin_layout Plain Layout
29738 \change_inserted -584632292 1670182217
29746 ] The CSS class to use for this paragraph.
29748 if the paragarph is of enumerate or itemize type,
29749 then the default will be
29750 \begin_inset Quotes eld
29754 \begin_inset Quotes erd
29758 \begin_inset Quotes eld
29762 \begin_inset Quotes erd
29767 \begin_inset Quotes eld
29771 \begin_inset Quotes erd
29776 \begin_inset Quotes eld
29780 \begin_inset Quotes erd
29785 \begin_inset Quotes eld
29789 \begin_inset Quotes erd
29794 \begin_inset Quotes eld
29798 \begin_inset Quotes erd
29802 depending upon the depth.
29803 That can be over-ridden here.
29805 the suffix will not be added in that case.
29807 the CSS class will always be exactly what it is declared to be here.
29812 \begin_layout Description
29813 \begin_inset Flex Code
29816 \begin_layout Plain Layout
29823 \begin_inset Flex Code
29826 \begin_layout Plain Layout
29836 ] Whether to output the default CSS information \SpecialChar LyX
29837 generates for this layout,
29838 even if additional information is explicitly provided via
29839 \begin_inset Flex Code
29842 \begin_layout Plain Layout
29850 \begin_inset Flex Code
29853 \begin_layout Plain Layout
29859 allows you to alter or augment the generated CSS,
29860 rather than to override it completely.
29862 \begin_inset Flex Code
29865 \begin_layout Plain Layout
29872 \change_inserted -584632292 1670132213
29876 \begin_layout Description
29878 \change_inserted -584632292 1670132277
29879 \begin_inset Flex Code
29882 \begin_layout Plain Layout
29884 \change_inserted -584632292 1670132221
29893 \begin_inset Flex Code
29896 \begin_layout Plain Layout
29898 \change_inserted -584632292 1670132214
29908 ] Whether to include this paragraph (usually,
29909 a section or something of the sort) in the TOC.
29912 so it should be set to false e.g.
29913 \begin_inset space ~
29916 for starred sections.
29921 \begin_layout Description
29922 \begin_inset Flex Code
29925 \begin_layout Plain Layout
29932 \begin_inset Flex Code
29935 \begin_layout Plain Layout
29941 ] The tag to be used for individual paragraphs of environments,
29943 \begin_inset Flex Code
29946 \begin_layout Plain Layout
29952 in the examples above.
29954 \begin_inset Flex Code
29957 \begin_layout Plain Layout
29966 \begin_layout Description
29967 \begin_inset Flex Code
29970 \begin_layout Plain Layout
29977 \begin_inset Flex Code
29980 \begin_layout Plain Layout
29986 ] Attributes for the item tag.
29988 \begin_inset Newline newline
29992 \begin_inset Quotes eld
29996 \begin_inset Flex Code
29999 \begin_layout Plain Layout
30000 class=`layoutname_item'
30006 \begin_inset Quotes erd
30014 contain any style information.
30016 \begin_inset Flex Code
30019 \begin_layout Plain Layout
30028 \begin_layout Description
30029 \begin_inset Flex Code
30032 \begin_layout Plain Layout
30039 \begin_inset Flex Code
30042 \begin_layout Plain Layout
30048 ] The tag to be used for paragraph and item labels,
30050 \begin_inset Flex Code
30053 \begin_layout Plain Layout
30059 in the examples above.
30061 \begin_inset Flex Code
30064 \begin_layout Plain Layout
30072 \begin_inset Flex Code
30075 \begin_layout Plain Layout
30082 \begin_inset Flex Code
30085 \begin_layout Plain Layout
30092 \begin_inset Flex Code
30095 \begin_layout Plain Layout
30096 Centered_Top_Environment
30102 in which case it defaults to
30103 \begin_inset Flex Code
30106 \begin_layout Plain Layout
30115 \begin_layout Description
30116 \begin_inset Flex Code
30119 \begin_layout Plain Layout
30126 \begin_inset Flex Code
30129 \begin_layout Plain Layout
30135 ] Attributes for the label tag.
30137 \begin_inset Newline newline
30141 \begin_inset Quotes eld
30145 \begin_inset Flex Code
30148 \begin_layout Plain Layout
30149 class=`layoutname_label'
30155 \begin_inset Quotes erd
30163 contain any style information.
30165 \begin_inset Flex Code
30168 \begin_layout Plain Layout
30177 \begin_layout Description
30178 \begin_inset Flex Code
30181 \begin_layout Plain Layout
30188 \begin_inset Flex Code
30191 \begin_layout Plain Layout
30201 ] Meaningful only for list-like environments,
30202 this tag controls whether the label tag is output before or inside the item tag.
30205 in the description environment,
30207 \begin_inset Flex Code
30210 \begin_layout Plain Layout
30211 <dt>\SpecialChar ldots
30212 </dt><dd>\SpecialChar ldots
30220 \begin_inset Flex Code
30223 \begin_layout Plain Layout
30230 The label tag is output inside the item tag.
30233 \begin_layout Description
30234 \begin_inset Flex Code
30237 \begin_layout Plain Layout
30243 Information to be output in the
30244 \begin_inset Flex Code
30247 \begin_layout Plain Layout
30253 section when this style is used.
30256 be used to include a
30257 \begin_inset Flex Code
30260 \begin_layout Plain Layout
30267 \begin_inset Flex Code
30270 \begin_layout Plain Layout
30279 \begin_layout Description
30280 \begin_inset Flex Code
30283 \begin_layout Plain Layout
30289 CSS style information to be included when this style is used.
30290 Note that this will automatically be wrapped in a layout-generated
30291 \begin_inset Flex Code
30294 \begin_layout Plain Layout
30301 so only the CSS itself need be included.
30303 \begin_inset Flex Code
30306 \begin_layout Plain Layout
30315 \begin_layout Description
30316 \begin_inset Flex Code
30319 \begin_layout Plain Layout
30326 \begin_inset Flex Code
30329 \begin_layout Plain Layout
30335 ] The tag to be used for the main label,
30337 \begin_inset Flex Code
30340 \begin_layout Plain Layout
30346 in the examples above.
30348 \begin_inset Flex Code
30351 \begin_layout Plain Layout
30360 \begin_layout Description
30361 \begin_inset Flex Code
30364 \begin_layout Plain Layout
30371 \begin_inset Flex Code
30374 \begin_layout Plain Layout
30384 ] Marks this style as the one to be used to generate the
30385 \begin_inset Flex Code
30388 \begin_layout Plain Layout
30394 tag for the XHTML file.
30398 \begin_inset Flex Code
30401 \begin_layout Plain Layout
30407 file sets it to true for the
30408 \begin_inset Flex Code
30411 \begin_layout Plain Layout
30421 \begin_layout Subsection
30425 \begin_layout Standard
30426 The XHTML output of insets can also be controlled by information in layout files.
30430 \begin_layout Plain Layout
30432 this is true only for
30433 \begin_inset Quotes eld
30437 \begin_inset Quotes erd
30440 insets (insets you can type into) and is not true for
30441 \begin_inset Quotes eld
30445 \begin_inset Quotes erd
30448 insets (insets that are associated with dialog boxes).
30456 tries to provide sensible defaults,
30457 and it constructs default CSS style rules.
30458 But everything can be customized.
30461 \begin_layout Standard
30462 The XHTML \SpecialChar LyX
30463 outputs for an inset has the following form:
30466 \begin_layout LyX-Code
30468 \begin_inset Quotes erd
30472 \begin_inset Quotes erd
30478 \begin_layout LyX-Code
30479 <labeltag>Label</labeltag>
30482 \begin_layout LyX-Code
30484 \begin_inset Quotes erd
30488 \begin_inset Quotes erd
30491 >Contents of the inset.</innertag>
30494 \begin_layout LyX-Code
30498 \begin_layout Standard
30499 If the inset permits multiple paragraphs—
30502 \begin_inset Flex Code
30505 \begin_layout Plain Layout
30512 then the contents of the inset will itself be output as paragraphs formatted according to the styles used for those paragraphs (standard,
30515 The label tag is of course omitted if the paragraph does not have a label and,
30518 \begin_inset Flex Code
30521 \begin_layout Plain Layout
30528 The inner tag is optional and,
30533 \begin_layout Standard
30534 The specific tags and attributes output for each inset can be controlled by means of the following layout tags.
30537 \begin_layout Description
30538 \begin_inset Flex Code
30541 \begin_layout Plain Layout
30548 \begin_inset Flex Code
30551 \begin_layout Plain Layout
30557 ] Specifies attribute information to be output with the main tag.
30560 \begin_inset Quotes eld
30564 \begin_inset Flex Code
30567 \begin_layout Plain Layout
30568 class=`myinset' onclick=`\SpecialChar ldots
30575 \begin_inset Quotes erd
30582 \begin_inset Quotes eld
30586 \begin_inset Flex Code
30589 \begin_layout Plain Layout
30596 \begin_inset Quotes erd
30601 \begin_inset Flex Code
30604 \begin_layout Plain Layout
30610 is the \SpecialChar LyX
30612 made lowercase and with non-alphanumeric characters converted to underscores,
30617 \begin_layout Description
30618 \begin_inset Flex Code
30621 \begin_layout Plain Layout
30628 \begin_inset Flex Code
30631 \begin_layout Plain Layout
30641 ] Whether to output the default CSS information \SpecialChar LyX
30642 generates for this layout,
30643 even if additional information is explicitly provided via
30644 \begin_inset Flex Code
30647 \begin_layout Plain Layout
30655 \begin_inset Flex Code
30658 \begin_layout Plain Layout
30664 allows you to alter or augment the generated CSS,
30665 rather than to override it completely.
30669 \begin_layout Description
30670 \begin_inset Flex Code
30673 \begin_layout Plain Layout
30680 \begin_inset Flex Code
30683 \begin_layout Plain Layout
30689 ] Attributes for the inner tag.
30691 \begin_inset Newline newline
30695 \begin_inset Quotes eld
30699 \begin_inset Flex Code
30702 \begin_layout Plain Layout
30703 class=`insetname_inner'
30709 \begin_inset Quotes erd
30715 \begin_layout Description
30716 \begin_inset Flex Code
30719 \begin_layout Plain Layout
30726 \begin_inset Flex Code
30729 \begin_layout Plain Layout
30737 \begin_inset Flex Code
30740 \begin_layout Plain Layout
30746 in the examples above.
30751 \begin_layout Description
30752 \begin_inset Flex Code
30755 \begin_layout Plain Layout
30762 \begin_inset Flex Code
30765 \begin_layout Plain Layout
30773 ] 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).
30777 \begin_layout Description
30778 \begin_inset Flex Code
30781 \begin_layout Plain Layout
30788 \begin_inset Flex Code
30791 \begin_layout Plain Layout
30797 ] A label for this inset,
30798 possibly including a reference to a counter.
30803 \begin_inset Flex Code
30806 \begin_layout Plain Layout
30816 and there is no default.
30819 \begin_layout Description
30820 \begin_inset Flex Code
30823 \begin_layout Plain Layout
30829 Information to be output in the
30830 \begin_inset Flex Code
30833 \begin_layout Plain Layout
30839 section when this style is used.
30842 be used to include a
30843 \begin_inset Flex Code
30846 \begin_layout Plain Layout
30853 \begin_inset Flex Code
30856 \begin_layout Plain Layout
30865 \begin_layout Description
30866 \begin_inset Flex Code
30869 \begin_layout Plain Layout
30875 CSS style information to be included when this style is used.
30876 Note that this will automatically be wrapped in a layout-generated
30877 \begin_inset Flex Code
30880 \begin_layout Plain Layout
30887 so only the CSS itself need be included.
30890 \begin_layout Description
30891 \begin_inset Flex Code
30894 \begin_layout Plain Layout
30901 \begin_inset Flex Code
30904 \begin_layout Plain Layout
30910 ] The tag to be used for the main label,
30912 \begin_inset Flex Code
30915 \begin_layout Plain Layout
30921 in the examples above.
30922 The default depends upon the setting of
30923 \begin_inset Flex Code
30926 \begin_layout Plain Layout
30934 \begin_inset Flex Code
30937 \begin_layout Plain Layout
30945 \begin_inset Flex Code
30948 \begin_layout Plain Layout
30957 \begin_inset Flex Code
30960 \begin_layout Plain Layout
30969 \begin_layout Subsection
30973 \begin_layout Standard
30974 The XHTML output for floats too can be controlled by layout information.
30975 The output has the following form:
30978 \begin_layout LyX-Code
30980 \begin_inset Quotes erd
30984 \begin_inset Quotes erd
30990 \begin_layout LyX-Code
30991 Contents of the float.
30994 \begin_layout LyX-Code
30998 \begin_layout Standard
31001 is a separate inset and will be output as such.
31002 Its appearance can be controlled via the InsetLayout for caption insets.
31006 \begin_layout Description
31007 \begin_inset Flex Code
31010 \begin_layout Plain Layout
31017 \begin_inset Flex Code
31020 \begin_layout Plain Layout
31026 ] Specifies attribute information to be output with the main tag.
31029 \begin_inset Quotes eld
31033 \begin_inset Flex Code
31036 \begin_layout Plain Layout
31037 class=`myfloat' onclick=`\SpecialChar ldots
31044 \begin_inset Quotes erd
31051 \begin_inset Quotes eld
31055 \begin_inset Flex Code
31058 \begin_layout Plain Layout
31059 class=`float float-floattype'
31065 \begin_inset Quotes erd
31070 \begin_inset Flex Code
31073 \begin_layout Plain Layout
31079 is \SpecialChar LyX
31080 's name for this type of float,
31081 as determined by the float declaration (see
31082 \begin_inset CommandInset ref
31084 reference "subsec:Floats"
31090 though made lowercase and with non-alphanumeric characters converted to underscores,
31095 \begin_layout Description
31096 \begin_inset Flex Code
31099 \begin_layout Plain Layout
31105 CSS style information to be included when this float is used.
31106 Note that this will automatically be wrapped in a layout-generated
31107 \begin_inset Flex Code
31110 \begin_layout Plain Layout
31117 so only the CSS itself need be included.
31120 \begin_layout Description
31121 \begin_inset Flex Code
31124 \begin_layout Plain Layout
31131 \begin_inset Flex Code
31134 \begin_layout Plain Layout
31140 ] The tag to be used for this float,
31142 \begin_inset Quotes eld
31146 \begin_inset Flex Code
31149 \begin_layout Plain Layout
31156 \begin_inset Quotes erd
31159 in the example above.
31161 \begin_inset Flex Code
31164 \begin_layout Plain Layout
31170 and will rarely need changing.
31173 \begin_layout Subsection
31174 Bibliography formatting
31177 \begin_layout Standard
31178 The bibliography can be formatted using
31179 \begin_inset Flex Code
31182 \begin_layout Plain Layout
31190 \begin_inset CommandInset ref
31192 reference "subsec:Citation-format-description"
31200 \begin_layout Subsection
31205 \begin_layout Standard
31206 We have several times mentioned that \SpecialChar LyX
31207 will generate default CSS style rules for both insets and paragraph styles,
31208 based upon the other layout information that is provided.
31210 we shall say a word about which layout information \SpecialChar LyX
31214 \begin_layout Standard
31217 auto-generates CSS only for font information,
31219 \begin_inset Flex Code
31222 \begin_layout Plain Layout
31230 \begin_inset Flex Code
31233 \begin_layout Plain Layout
31241 \begin_inset Flex Code
31244 \begin_layout Plain Layout
31252 \begin_inset Flex Code
31255 \begin_layout Plain Layout
31262 \begin_inset Flex Code
31265 \begin_layout Plain Layout
31272 \begin_inset CommandInset ref
31274 reference "subsec:Font-description"
31280 The translation is mostly straightforward and obvious.
31283 \begin_inset Quotes eld
31287 \begin_inset Flex Code
31290 \begin_layout Plain Layout
31297 \begin_inset Quotes erd
31301 \begin_inset Quotes eld
31305 \begin_inset Flex Code
31308 \begin_layout Plain Layout
31316 \begin_inset Quotes erd
31320 The correspondence of \SpecialChar LyX
31321 sizes and CSS sizes is a little less obvious but nonetheless intuitive.
31323 \begin_inset Flex Code
31326 \begin_layout Plain Layout
31333 \begin_inset Flex URL
31336 \begin_layout Plain Layout
31344 \change_inserted -970929547 1496610908
31348 \begin_layout Section
31350 \change_inserted -970929547 1496610966
31351 \begin_inset CommandInset label
31353 name "sec:Tags-for-DocBook"
31357 Tags for DocBook output
31360 \begin_layout Standard
31362 \change_inserted -970929547 1496611615
31363 As with \SpecialChar LaTeX
31365 the format of \SpecialChar LyX
31366 's DocBook output is also controlled by layout information.
31369 provides sensible defaults;
31371 much of the styling is lost during the conversion,
31372 as DocBook is strictly semantic and does not allow formatting.
31374 information from \SpecialChar LyX
31375 will be rendered in
31383 \begin_layout Standard
31385 \change_inserted -970929547 1496612080
31388 you may not have to do anything at all to get acceptable DocBook output for your own environments,
31391 But in some cases you will,
31392 and so \SpecialChar LyX
31393 provides a number of layout tags that can be used to customize the DocBook that is generated.
31396 \begin_layout Standard
31398 \change_inserted -970929547 1515109912
31399 Labels are rarely output,
31400 as they are redundant in DocBook:
31401 this information is carried by the tags themselves,
31402 and whether labels appear in the final documents (after processing of DocBook files) is controlled by the stylesheets.
31405 labels are not redundant content,
31406 such as definition lists:
31408 the term being defined will be the label.
31412 \begin_layout Subsection
31414 \change_inserted 1075283030 1597699417
31415 \begin_inset CommandInset label
31417 name "subsec:Paragraph-Style-DocBook"
31422 \change_deleted 1075283030 1597699417
31424 \begin_inset CommandInset label
31426 name "subsec:Paragraph-Style-XHTML-1"
31431 \change_inserted -970929547 1496610966
31435 \begin_layout Standard
31437 \change_inserted -970929547 1496612059
31438 The sort of DocBook \SpecialChar LyX
31439 outputs for a paragraph depends upon whether we are dealing with a normal paragraph,
31442 where this is itself determined by the contents of the corresponding
31443 \begin_inset Flex Code
31446 \begin_layout Plain Layout
31448 \change_inserted -970929547 1496610966
31461 \begin_layout Standard
31463 \change_inserted -970929547 1496612107
31464 For a command or normal paragraph,
31465 the output DocBook has the following form:
31468 \begin_layout LyX-Code
31470 \change_inserted -970929547 1515109666
31474 \begin_layout LyX-Code
31476 \change_inserted -970929547 1496610966
31477 Contents of the paragraph.
31480 \begin_layout LyX-Code
31482 \change_inserted -970929547 1496610966
31486 \begin_layout Standard
31488 \change_inserted -970929547 1515109821
31489 For an environment that is not some sort of list,
31490 the generated DocBook takes this form:
31493 \begin_layout LyX-Code
31495 \change_inserted -970929547 1515109671
31499 \begin_layout LyX-Code
31501 \change_inserted -970929547 1496612114
31502 <itemtag>First paragraph.</itemtag>
31505 \begin_layout LyX-Code
31507 \change_inserted -970929547 1496610966
31508 <itemtag>Second paragraph.</itemtag>
31511 \begin_layout LyX-Code
31513 \change_inserted -970929547 1496610966
31517 \begin_layout Standard
31519 \change_inserted -970929547 1515109825
31521 the resulting DocBook takes this form:
31524 \begin_layout LyX-Code
31526 \change_inserted -970929547 1515109672
31530 \begin_layout LyX-Code
31532 \change_inserted -970929547 1515109676
31533 <itemtag attr>First item.</itemtag>
31536 \begin_layout LyX-Code
31538 \change_inserted -970929547 1515109678
31539 <itemtag attr>Second item.</itemtag>
31542 \begin_layout LyX-Code
31544 \change_inserted -970929547 1496610966
31548 \begin_layout Standard
31550 \change_inserted -970929547 1496612243
31551 The specific tags and roles output for each paragraph type can be controlled by means of the layout tags we are about to describe.
31553 due to the very nature of DocBook,
31554 no sensible defaults really exist,
31555 and the values must always be carefully chosen.
31559 \begin_layout Description
31561 \change_inserted -970929547 1515110057
31562 \begin_inset Flex Code
31565 \begin_layout Plain Layout
31567 \change_inserted -970929547 1515109656
31576 \begin_inset Flex Code
31579 \begin_layout Plain Layout
31581 \change_inserted -970929547 1496610966
31589 ] Specifies attribute information to be output with the main tag,
31591 \begin_inset Quotes eld
31595 \begin_inset Flex Code
31598 \begin_layout Plain Layout
31600 \change_inserted -970929547 1515110057
31609 \begin_inset Quotes erd
31612 in the example above.
31613 This information can be used in further processing of the DocBook files.
31619 \begin_layout Description
31621 \change_inserted -970929547 1496612296
31622 \begin_inset Flex Code
31625 \begin_layout Plain Layout
31627 \change_inserted -970929547 1496612269
31636 \begin_inset Flex Code
31639 \begin_layout Plain Layout
31641 \change_inserted -970929547 1496610966
31649 ] The tag to be used for this inset,
31651 \begin_inset Quotes eld
31655 \begin_inset Flex Code
31658 \begin_layout Plain Layout
31660 \change_inserted -970929547 1496612296
31669 \begin_inset Quotes erd
31672 in the example above.
31673 The default is the name of the float and always needs to be changed,
31674 as DocBook provides no generic tag.
31675 \change_inserted 1075283030 1597698868
31679 \begin_layout Description
31681 \change_inserted 1075283030 1597699399
31682 \begin_inset Flex Code
31685 \begin_layout Plain Layout
31687 \change_inserted 1075283030 1597698872
31696 \begin_inset Flex Code
31699 \begin_layout Plain Layout
31701 \change_inserted 1075283030 1597700585
31711 ] The new-line policy for this tag,
31713 \begin_inset space ~
31717 \begin_inset CommandInset ref
31719 reference "subsec:DocBook-New-line-policy"
31733 \begin_layout Subsection
31735 \change_inserted 1075283030 1597699385
31737 \begin_inset CommandInset label
31739 name "subsec:DocBook-New-line-policy"
31746 \begin_layout Standard
31748 \change_inserted 1075283030 1597698993
31750 there are three possible policies for outputting new lines (given in the
31751 \begin_inset Flex Code
31754 \begin_layout Plain Layout
31756 \change_inserted 1075283030 1597698987
31768 \begin_layout Itemize
31770 \change_inserted 1075283030 1597699279
31771 \begin_inset Quotes eld
31775 \begin_inset Flex Code
31778 \begin_layout Plain Layout
31780 \change_inserted 1075283030 1597699012
31789 \begin_inset Quotes erd
31793 the opening and closing tags are on their own lines (i.e.
31794 a line feed after and before the opening and the closing tags).
31795 Typical elements are floats.
31800 \begin_layout LyX-Code
31802 \change_inserted 1075283030 1597699194
31806 \begin_layout LyX-Code
31808 \change_inserted 1075283030 1597699194
31812 \begin_layout LyX-Code
31814 \change_inserted 1075283030 1597699098
31815 Contents of the block.
31818 \begin_layout LyX-Code
31820 \change_inserted 1075283030 1597699196
31824 \begin_layout LyX-Code
31826 \change_inserted 1075283030 1597699198
31830 \begin_layout Itemize
31832 \change_inserted 1075283030 1597699289
31833 \begin_inset Quotes eld
31837 \begin_inset Flex Code
31840 \begin_layout Plain Layout
31842 \change_inserted 1075283030 1597699113
31851 \begin_inset Quotes erd
31855 the opening and closing tags are on the same,
31857 a line feed is output before the opening tag and after the closing tag.
31858 Typical elements are paragraphs and list items.
31863 \begin_layout LyX-Code
31865 \change_inserted 1075283030 1597699186
31869 \begin_layout LyX-Code
31871 \change_inserted 1075283030 1597699357
31872 <paratag>Contents of the paragraph.</paratag>
31875 \begin_layout LyX-Code
31877 \change_inserted 1075283030 1597699231
31881 \begin_layout Itemize
31883 \change_inserted 1075283030 1597699343
31884 \begin_inset Quotes eld
31888 \begin_inset Flex Code
31891 \begin_layout Plain Layout
31893 \change_inserted 1075283030 1597699307
31902 \begin_inset Quotes erd
31906 the opening and closing tags are on the same line as the rest of the content.
31907 No line feeds are output.
31908 Typical elements are fonts.
31913 \begin_layout LyX-Code
31915 \change_inserted 1075283030 1597699585
31916 Content before<inlinetag>Contents of the paragraph.</inlinetag>Content after
31919 \begin_layout Standard
31921 \change_inserted 1075283030 1597699585
31922 The default value is always
31923 \begin_inset Quotes eld
31927 \begin_inset Flex Code
31930 \begin_layout Plain Layout
31932 \change_inserted 1075283030 1597699585
31941 \begin_inset Quotes erd
31949 \begin_layout Subsection
31951 \change_inserted -970929547 1515111533
31952 InsetLayout DocBook
31957 \begin_layout Standard
31959 \change_inserted -970929547 1496611894
31960 The DocBook output of insets can also be controlled by information in layout files.
31963 \begin_layout Standard
31965 \change_inserted -970929547 1496612045
31966 The DocBook \SpecialChar LyX
31967 outputs for an inset has the following form:
31970 \begin_layout LyX-Code
31972 \change_inserted -970929547 1515110861
31973 <wrappertag wrapperattr>
31976 \begin_layout LyX-Code
31978 \change_inserted -970929547 1515110868
31982 \begin_layout LyX-Code
31984 \change_inserted -970929547 1515110869
31985 <innertag innerattr>
31988 \begin_layout LyX-Code
31990 \change_inserted -970929547 1515110869
31991 Contents of the inset.
31994 \begin_layout LyX-Code
31996 \change_inserted -970929547 1515110870
32000 \begin_layout LyX-Code
32002 \change_inserted -970929547 1515110871
32006 \begin_layout LyX-Code
32008 \change_inserted -970929547 1515111172
32012 \begin_layout Standard
32014 \change_inserted -970929547 1515111186
32015 For an itemising inset,
32016 it rather looks like this:
32020 \begin_layout LyX-Code
32022 \change_inserted -970929547 1515111186
32023 <wrappertag wrapperattr>
32026 \begin_layout LyX-Code
32028 \change_inserted -970929547 1515111186
32032 \begin_layout LyX-Code
32034 \change_inserted -970929547 1515111186
32035 <innertag innerattr>
32038 \begin_layout LyX-Code
32040 \change_inserted -970929547 1515111362
32041 <itemwrappertag itemwrapperattr>
32044 \begin_layout LyX-Code
32046 \change_inserted -970929547 1515111364
32047 <itemlabeltag itemattr>
32050 \begin_layout LyX-Code
32052 \change_inserted -970929547 1515111367
32053 Label of the first item.
32056 \begin_layout LyX-Code
32058 \change_inserted -970929547 1515111362
32064 \begin_layout LyX-Code
32066 \change_inserted -970929547 1515111517
32070 \begin_layout LyX-Code
32072 \change_inserted -970929547 1515111517
32078 \begin_layout LyX-Code
32080 \change_inserted -970929547 1515111516
32081 Contents of the first item.
32084 \begin_layout LyX-Code
32086 \change_inserted -970929547 1515111514
32092 \begin_layout LyX-Code
32094 \change_inserted -970929547 1515111247
32100 \begin_layout LyX-Code
32102 \change_inserted -970929547 1515111221
32106 \begin_layout LyX-Code
32108 \change_inserted -970929547 1515111370
32109 <itemwrappertag itemwrapperattr>
32112 \begin_layout LyX-Code
32114 \change_inserted -970929547 1515111370
32115 <itemlabeltag itemattr>
32118 \begin_layout LyX-Code
32120 \change_inserted -970929547 1515111372
32121 Label of the second item.
32124 \begin_layout LyX-Code
32126 \change_inserted -970929547 1515111370
32132 \begin_layout LyX-Code
32134 \change_inserted -970929547 1515111504
32138 \begin_layout LyX-Code
32140 \change_inserted -970929547 1515111505
32146 \begin_layout LyX-Code
32148 \change_inserted -970929547 1515111507
32149 Contents of the second item.
32152 \begin_layout LyX-Code
32154 \change_inserted -970929547 1515111509
32160 \begin_layout LyX-Code
32162 \change_inserted -970929547 1515111251
32168 \begin_layout LyX-Code
32170 \change_inserted -970929547 1515111221
32176 \begin_layout LyX-Code
32178 \change_inserted -970929547 1515111219
32184 \begin_layout LyX-Code
32186 \change_inserted -970929547 1515111186
32190 \begin_layout LyX-Code
32192 \change_inserted -970929547 1515111186
32196 \begin_layout LyX-Code
32198 \change_inserted -970929547 1515111186
32202 \begin_layout Standard
32204 \change_inserted -970929547 1515111183
32205 If the inset permits multiple paragraphs—
32208 \begin_inset Flex Code
32211 \begin_layout Plain Layout
32213 \change_inserted -970929547 1496610966
32222 then the contents of the inset will
32223 \change_deleted 34634807 1620029217
32225 \change_inserted 34634807 1620029219
32227 \change_inserted -970929547 1515111183
32228 be output as paragraphs formatted according to the styles used for those paragraphs (standard,
32231 The inner tag is optional and,
32236 \begin_layout Standard
32238 \change_inserted -970929547 1496610966
32239 The specific tags and attributes output for each inset can be controlled by means of the following layout tags.
32242 \begin_layout Description
32244 \change_inserted -970929547 1515110317
32245 \begin_inset Flex Code
32248 \begin_layout Plain Layout
32250 \change_inserted -970929547 1515109695
32259 \begin_inset Flex Code
32262 \begin_layout Plain Layout
32264 \change_inserted -970929547 1496611854
32272 ] Specifies attribute information to be output with the main tag,
32274 \begin_inset Quotes eld
32278 \begin_inset Flex Code
32281 \begin_layout Plain Layout
32283 \change_inserted -970929547 1515110044
32292 \begin_inset Quotes erd
32295 in the example above.
32296 This information can be used in further processing of the DocBook files.
32300 \begin_layout Description
32302 \change_inserted -970929547 1515110973
32303 \begin_inset Flex Code
32306 \begin_layout Plain Layout
32308 \change_inserted -970929547 1515110319
32317 \begin_inset Flex Code
32320 \begin_layout Plain Layout
32322 \change_inserted -970929547 1515110384
32332 ] Specifies whether this tag goes into the
32333 \begin_inset Flex Code
32336 \begin_layout Plain Layout
32338 \change_inserted -970929547 1515110412
32346 tag at the beginning of the parent layout.
32348 \begin_inset Flex Code
32351 \begin_layout Plain Layout
32353 \change_inserted -970929547 1515110437
32361 indicates that the tag never goes into
32362 \begin_inset Flex Code
32365 \begin_layout Plain Layout
32367 \change_inserted -970929547 1515110497
32375 (this is default value,
32376 and corresponds to usual content).
32378 \begin_inset Flex Code
32381 \begin_layout Plain Layout
32383 \change_inserted -970929547 1515110517
32391 indicates that the tag always goes into
32392 \begin_inset Flex Code
32395 \begin_layout Plain Layout
32397 \change_inserted -970929547 1515110514
32405 (this corresponds to usual metadata):
32407 \begin_inset Flex Code
32410 \begin_layout Plain Layout
32412 \change_inserted -970929547 1515110550
32420 tag for the parent,
32427 \begin_inset Flex Code
32430 \begin_layout Plain Layout
32432 \change_inserted -970929547 1515110540
32440 indicates that the tag may go into
32441 \begin_inset Flex Code
32444 \begin_layout Plain Layout
32446 \change_inserted -970929547 1515110538
32454 (this is only the case for titles):
32456 \begin_inset Flex Code
32459 \begin_layout Plain Layout
32461 \change_inserted -970929547 1515110585
32469 tag for the parent,
32475 the corresponding tag will be output directly as content.
32479 \begin_layout Description
32481 \change_inserted -970929547 1515111461
32482 \begin_inset Flex Code
32485 \begin_layout Plain Layout
32487 \change_inserted -970929547 1515110974
32496 \begin_inset Flex Code
32499 \begin_layout Plain Layout
32501 \change_inserted -970929547 1515110973
32509 ] Specifies attribute information to be output with the item tag,
32511 \begin_inset Quotes eld
32515 \begin_inset Flex Code
32518 \begin_layout Plain Layout
32520 \change_inserted -970929547 1515110984
32529 \begin_inset Quotes erd
32532 in the example above.
32533 This information can be used in further processing of the DocBook files.
32537 \begin_layout Description
32539 \change_inserted -970929547 1515111471
32540 \begin_inset Flex Code
32543 \begin_layout Plain Layout
32545 \change_inserted -970929547 1515111465
32546 DocBookItemInnerAttr
32554 \begin_inset Flex Code
32557 \begin_layout Plain Layout
32559 \change_inserted -970929547 1515111461
32567 ] Specifies attribute information to be output with the item inner tag,
32569 \begin_inset Quotes eld
32573 \begin_inset Flex Code
32576 \begin_layout Plain Layout
32578 \change_inserted -970929547 1515111476
32587 \begin_inset Quotes erd
32590 in the example above.
32591 This information can be used in further processing of the DocBook files.
32595 \begin_layout Description
32597 \change_inserted -970929547 1515111494
32598 \begin_inset Flex Code
32601 \begin_layout Plain Layout
32603 \change_inserted -970929547 1515111467
32604 DocBookItemInnerTag
32612 \begin_inset Flex Code
32615 \begin_layout Plain Layout
32617 \change_inserted -970929547 1515111461
32625 ] The tag to be used for the item inner tag within the inset,
32627 \begin_inset Quotes eld
32631 \begin_inset Flex Code
32634 \begin_layout Plain Layout
32636 \change_inserted -970929547 1515111486
32645 \begin_inset Quotes erd
32648 in the example above.
32650 \begin_inset Flex Code
32653 \begin_layout Plain Layout
32655 \change_inserted -970929547 1515111461
32664 indicating that there is no item inner tag:
32665 content is directly output without it for each itemised element.
32666 This parameter only makes sense when itemising layouts are used,
32669 \change_inserted 1075283030 1598469472
32670 The most likely value is
32671 \begin_inset Quotes eld
32675 \begin_inset Flex Code
32678 \begin_layout Plain Layout
32680 \change_inserted 1075283030 1598469476
32689 \begin_inset Quotes erd
32693 \begin_inset Newline newline
32696 When a list item is split using a new line,
32697 the item inner tag will be repeated for each part of the paragraph,
32698 parts being separated by new lines.
32702 \begin_layout Description
32704 \change_inserted 1075283030 1597699866
32705 \begin_inset Flex Code
32708 \begin_layout Plain Layout
32710 \change_inserted 1075283030 1597699853
32711 DocBookItemInnerTagType
32719 \begin_inset Flex Code
32722 \begin_layout Plain Layout
32724 \change_inserted 1075283030 1597699866
32734 ] The new-line policy for this tag,
32736 \begin_inset space ~
32740 \begin_inset CommandInset ref
32742 reference "subsec:DocBook-New-line-policy"
32756 \begin_layout Description
32758 \change_inserted -970929547 1515111290
32759 \begin_inset Flex Code
32762 \begin_layout Plain Layout
32764 \change_inserted -970929547 1515111283
32765 DocBookItemLabelAttr
32773 \begin_inset Flex Code
32776 \begin_layout Plain Layout
32778 \change_inserted -970929547 1515111279
32786 ] Specifies attribute information to be output with the item label tag,
32788 \begin_inset Quotes eld
32792 \begin_inset Flex Code
32795 \begin_layout Plain Layout
32797 \change_inserted -970929547 1515111304
32806 \begin_inset Quotes erd
32809 in the example above.
32810 This information can be used in further processing of the DocBook files.
32814 \begin_layout Description
32816 \change_inserted -970929547 1515111337
32817 \begin_inset Flex Code
32820 \begin_layout Plain Layout
32822 \change_inserted -970929547 1515111285
32823 DocBookItemLabelTag
32831 \begin_inset Flex Code
32834 \begin_layout Plain Layout
32836 \change_inserted -970929547 1515111279
32844 ] The tag to be used for the item label tag within the inset,
32846 \begin_inset Quotes eld
32850 \begin_inset Flex Code
32853 \begin_layout Plain Layout
32855 \change_inserted -970929547 1515111311
32864 \begin_inset Quotes erd
32867 in the example above.
32868 This parameter only makes sense when itemising layouts are used with a notion of labels,
32869 such as definition lists.
32871 \change_inserted 1075283030 1597699874
32875 \begin_layout Description
32877 \change_inserted 1075283030 1597699874
32878 \begin_inset Flex Code
32881 \begin_layout Plain Layout
32883 \change_inserted 1075283030 1597699880
32884 DocBookItemLabelTagType
32892 \begin_inset Flex Code
32895 \begin_layout Plain Layout
32897 \change_inserted 1075283030 1597699874
32907 ] The new-line policy for this tag,
32909 \begin_inset space ~
32913 \begin_inset CommandInset ref
32915 reference "subsec:DocBook-New-line-policy"
32929 \begin_layout Description
32931 \change_inserted -970929547 1515111124
32932 \begin_inset Flex Code
32935 \begin_layout Plain Layout
32937 \change_inserted -970929547 1515111060
32946 \begin_inset Flex Code
32949 \begin_layout Plain Layout
32951 \change_inserted -970929547 1515111060
32959 ] The tag to be used for the item tag within the inset,
32961 \begin_inset Quotes eld
32965 \begin_inset Flex Code
32968 \begin_layout Plain Layout
32970 \change_inserted -970929547 1515111060
32979 \begin_inset Quotes erd
32982 in the example above.
32984 \begin_inset Flex Code
32987 \begin_layout Plain Layout
32989 \change_inserted -970929547 1515111060
32998 indicating that there is no item tag.
32999 This parameter only makes sense when itemising layouts are used,
33002 \change_inserted 1075283030 1597699890
33006 \begin_layout Description
33008 \change_inserted 1075283030 1597699890
33009 \begin_inset Flex Code
33012 \begin_layout Plain Layout
33014 \change_inserted 1075283030 1597699890
33023 \begin_inset Flex Code
33026 \begin_layout Plain Layout
33028 \change_inserted 1075283030 1597699890
33038 ] The new-line policy for this tag,
33040 \begin_inset space ~
33044 \begin_inset CommandInset ref
33046 reference "subsec:DocBook-New-line-policy"
33060 \begin_layout Description
33062 \change_inserted -970929547 1515111298
33063 \begin_inset Flex Code
33066 \begin_layout Plain Layout
33068 \change_inserted -970929547 1515111124
33069 DocBookItemWrapperAttr
33077 \begin_inset Flex Code
33080 \begin_layout Plain Layout
33082 \change_inserted -970929547 1515111124
33090 ] Specifies attribute information to be output with the item wrapper tag,
33092 \begin_inset Quotes eld
33096 \begin_inset Flex Code
33099 \begin_layout Plain Layout
33101 \change_inserted -970929547 1515111150
33110 \begin_inset Quotes erd
33113 in the example above.
33114 This information can be used in further processing of the DocBook files.
33120 \begin_layout Description
33122 \change_inserted -970929547 1515111113
33123 \begin_inset Flex Code
33126 \begin_layout Plain Layout
33128 \change_inserted -970929547 1515111073
33129 DocBookItemWrapperTag
33137 \begin_inset Flex Code
33140 \begin_layout Plain Layout
33142 \change_inserted -970929547 1515111073
33150 ] The tag to be used for the item wrapper tag within the inset,
33152 \begin_inset Quotes eld
33156 \begin_inset Flex Code
33159 \begin_layout Plain Layout
33161 \change_inserted -970929547 1515111083
33170 \begin_inset Quotes erd
33173 in the example above.
33175 \begin_inset Flex Code
33178 \begin_layout Plain Layout
33180 \change_inserted -970929547 1515111073
33189 indicating that there is no item wrapper tag:
33190 tag and content are directly output without it for each itemised element.
33191 This parameter only makes sense when itemising layouts are used,
33194 \change_inserted 1075283030 1597699897
33198 \begin_layout Description
33200 \change_inserted 1075283030 1597699897
33201 \begin_inset Flex Code
33204 \begin_layout Plain Layout
33206 \change_inserted 1075283030 1597699900
33207 DocBookItemWrapperTagType
33215 \begin_inset Flex Code
33218 \begin_layout Plain Layout
33220 \change_inserted 1075283030 1597699897
33230 ] The new-line policy for this tag,
33232 \begin_inset space ~
33236 \begin_inset CommandInset ref
33238 reference "subsec:DocBook-New-line-policy"
33252 \begin_layout Description
33254 \change_inserted -970929547 1515110104
33255 \begin_inset Flex Code
33258 \begin_layout Plain Layout
33260 \change_inserted -970929547 1515110104
33269 \begin_inset Flex Code
33272 \begin_layout Plain Layout
33274 \change_inserted -970929547 1515110104
33282 ] Specifies attribute information to be output with the inner tag,
33284 \begin_inset Quotes eld
33288 \begin_inset Flex Code
33291 \begin_layout Plain Layout
33293 \change_inserted -970929547 1515110104
33302 \begin_inset Quotes erd
33305 in the example above.
33306 This information can be used in further processing of the DocBook files.
33310 \begin_layout Description
33312 \change_inserted -970929547 1515110906
33313 \begin_inset Flex Code
33316 \begin_layout Plain Layout
33318 \change_inserted -970929547 1515110104
33327 \begin_inset Flex Code
33330 \begin_layout Plain Layout
33332 \change_inserted -970929547 1515110104
33340 ] The tag to be used for the inner tag within the inset,
33342 \begin_inset Quotes eld
33346 \begin_inset Flex Code
33349 \begin_layout Plain Layout
33351 \change_inserted -970929547 1515110104
33360 \begin_inset Quotes erd
33363 in the example above.
33365 \begin_inset Flex Code
33368 \begin_layout Plain Layout
33370 \change_inserted -970929547 1515110791
33379 indicating that there is no inner tag:
33380 content is directly output without it.
33381 \change_inserted 1075283030 1597699904
33385 \begin_layout Description
33387 \change_inserted 1075283030 1597699904
33388 \begin_inset Flex Code
33391 \begin_layout Plain Layout
33393 \change_inserted 1075283030 1597699904
33394 DocBookInnerTagType
33402 \begin_inset Flex Code
33405 \begin_layout Plain Layout
33407 \change_inserted 1075283030 1597699904
33417 ] The new-line policy for this tag,
33419 \begin_inset space ~
33423 \begin_inset CommandInset ref
33425 reference "subsec:DocBook-New-line-policy"
33439 \begin_layout Description
33441 \change_inserted -970929547 1515110753
33442 \begin_inset Flex Code
33445 \begin_layout Plain Layout
33447 \change_inserted -970929547 1515110665
33456 \begin_inset Flex Code
33459 \begin_layout Plain Layout
33461 \change_inserted -970929547 1515110661
33469 ] Specifies the tag that corresponds to this kind of section.
33470 This parameter only makes sense for sectioning elements (part,
33474 The default value is
33475 \begin_inset Flex Code
33478 \begin_layout Plain Layout
33480 \change_inserted -970929547 1515110721
33489 and is only overridden when DocBook uses something else for sectioning (
33490 \change_inserted 1075283030 1597699921
33493 \change_inserted -970929547 1515110753
33494 parts and chapters of a book).
33500 \begin_layout Description
33502 \change_inserted -970929547 1515110811
33503 \begin_inset Flex Code
33506 \begin_layout Plain Layout
33508 \change_inserted -970929547 1496612023
33517 \begin_inset Flex Code
33520 \begin_layout Plain Layout
33522 \change_inserted -970929547 1496610966
33530 ] The tag to be used for this inset,
33532 \begin_inset Quotes eld
33536 \begin_inset Flex Code
33539 \begin_layout Plain Layout
33541 \change_inserted -970929547 1496612033
33550 \begin_inset Quotes erd
33553 in the example above.
33554 The default is the name of the float and always needs to be changed,
33555 as DocBook provides no generic inset tag.
33556 \change_inserted 1075283030 1597699924
33560 \begin_layout Description
33562 \change_inserted 1075283030 1597699924
33563 \begin_inset Flex Code
33566 \begin_layout Plain Layout
33568 \change_inserted 1075283030 1597699924
33577 \begin_inset Flex Code
33580 \begin_layout Plain Layout
33582 \change_inserted 1075283030 1597699924
33592 ] The new-line policy for this tag,
33594 \begin_inset space ~
33598 \begin_inset CommandInset ref
33600 reference "subsec:DocBook-New-line-policy"
33614 \begin_layout Description
33616 \change_inserted -970929547 1515110832
33617 \begin_inset Flex Code
33620 \begin_layout Plain Layout
33622 \change_inserted -970929547 1515110822
33631 \begin_inset Flex Code
33634 \begin_layout Plain Layout
33636 \change_inserted -970929547 1515110811
33644 ] Specifies attribute information to be output with the outer
33645 \change_inserted 34634807 1620057958
33647 \change_inserted -970929547 1515110832
33650 \begin_inset Quotes eld
33654 \begin_inset Flex Code
33657 \begin_layout Plain Layout
33659 \change_inserted -970929547 1515110845
33668 \begin_inset Quotes erd
33671 in the example above.
33672 This information can be used in further processing of the DocBook files.
33676 \begin_layout Description
33678 \change_inserted -970929547 1515110917
33679 \begin_inset Flex Code
33682 \begin_layout Plain Layout
33684 \change_inserted -970929547 1515110826
33693 \begin_inset Flex Code
33696 \begin_layout Plain Layout
33698 \change_inserted -970929547 1515110811
33706 ] The tag to be used for the wrapper tag around the inset,
33708 \begin_inset Quotes eld
33712 \begin_inset Flex Code
33715 \begin_layout Plain Layout
33717 \change_inserted -970929547 1515110842
33726 \begin_inset Quotes erd
33729 in the example above.
33731 \begin_inset Flex Code
33734 \begin_layout Plain Layout
33736 \change_inserted -970929547 1515110811
33745 indicating that there is no wrapper tag:
33746 tag and content are directly output without it.
33747 \change_inserted 1075283030 1597699929
33751 \begin_layout Description
33753 \change_inserted 1075283030 1597699929
33754 \begin_inset Flex Code
33757 \begin_layout Plain Layout
33759 \change_inserted 1075283030 1597699932
33760 DocBookWrapperTagType
33768 \begin_inset Flex Code
33771 \begin_layout Plain Layout
33773 \change_inserted 1075283030 1597699929
33783 ] The new-line policy for this tag,
33785 \begin_inset space ~
33789 \begin_inset CommandInset ref
33791 reference "subsec:DocBook-New-line-policy"
33805 \begin_layout Subsection
33807 \change_inserted -970929547 1515110040
33811 \begin_layout Standard
33813 \change_inserted -970929547 1496611700
33814 The DocBook output for floats too can be controlled by layout information.
33815 The output has the following form:
33818 \begin_layout LyX-Code
33820 \change_inserted -970929547 1515109700
33824 \begin_layout LyX-Code
33826 \change_inserted -970929547 1515110138
33827 Contents of the float as DocBook.
33830 \begin_layout LyX-Code
33832 \change_inserted -970929547 1496610966
33836 \begin_layout Standard
33838 \change_inserted -970929547 1496611715
33841 is a separate inset and will be output as a title.
33845 \begin_layout Description
33847 \change_inserted -970929547 1515110033
33848 \begin_inset Flex Code
33851 \begin_layout Plain Layout
33853 \change_inserted -970929547 1515109702
33862 \begin_inset Flex Code
33865 \begin_layout Plain Layout
33867 \change_inserted -970929547 1496610966
33875 ] Specifies attribute information to be output with the main tag,
33877 \begin_inset Quotes eld
33881 \begin_inset Flex Code
33884 \begin_layout Plain Layout
33886 \change_inserted -970929547 1515110035
33895 \begin_inset Quotes erd
33898 in the example above.
33899 This information can be used in further processing of the DocBook files.
33903 \begin_layout Description
33905 \change_inserted -970929547 1515110157
33906 \begin_inset Flex Code
33909 \begin_layout Plain Layout
33911 \change_inserted -970929547 1496611782
33920 \begin_inset Flex Code
33923 \begin_layout Plain Layout
33925 \change_inserted -970929547 1496610966
33933 ] The tag to be used for this float,
33935 \begin_inset Quotes eld
33939 \begin_inset Flex Code
33942 \begin_layout Plain Layout
33944 \change_inserted -970929547 1496610966
33953 \begin_inset Quotes erd
33956 in the example above.
33957 The default is the name of the float and always needs to be changed,
33958 as DocBook provides no generic float tag.
33961 \begin_layout Subsection
33963 \change_inserted -970929547 1515110157
33964 Bibliography formatting
33967 \begin_layout Standard
33969 \change_deleted 1075283030 1597699984
33971 \change_inserted 1075283030 1597699985
33973 \change_inserted -970929547 1515110187
33975 \change_deleted 1075283030 1597699987
33977 \change_inserted 1075283030 1597699987
33979 \change_inserted -970929547 1515110187
33980 cannot be formatted:
33981 all fields are always output in the database-like DocBook format (equivalent to a BibTeX file)
33982 \change_inserted 1075283030 1597700117
33985 \begin_inset Flex Code
33988 \begin_layout Plain Layout
33990 \change_inserted 1075283030 1597700120
33999 \change_inserted -970929547 1515110187
34001 \change_inserted 1075283030 1597700092
34005 \begin_layout Standard
34007 \change_inserted 1075283030 1597700112
34008 When the bibliographic entries are manually inserted into the
34009 \change_deleted 34634807 1620057319
34011 \change_inserted 34634807 1620057319
34014 \change_inserted 1075283030 1597700112
34015 document as Bibliography Items,
34016 the user deals with formatting
34019 \change_inserted 1075283030 1597700112
34021 there is no attempt of parsing what the user wrote,
34022 the string is directly used (with the
34023 \begin_inset Flex Code
34026 \begin_layout Plain Layout
34028 \change_inserted 1075283030 1597700076
34042 \begin_layout Chapter
34043 Including External Material
34044 \begin_inset CommandInset label
34046 name "chap:Including-External-Material"
34053 \begin_layout Standard
34054 \begin_inset Box Shadowbox
34064 height_special "totalheight"
34069 backgroundcolor "none"
34072 \begin_layout Plain Layout
34074 This portion of the documentation has not been updated for some time.
34075 We certainly hope that it is still accurate,
34076 but there are no guarantees.
34084 \begin_layout Standard
34085 The use of material from sources external to \SpecialChar LyX
34086 is covered in detail in the
34091 This part of the manual covers what needs to happen behind the scenes for new sorts of material to be included.
34094 \begin_layout Section
34098 \begin_layout Standard
34099 The external material feature is based on the concept of a
34104 A template is a specification of how \SpecialChar LyX
34105 should interface with a certain kind of material.
34108 comes with predefined templates for Xfig figures,
34109 various raster format images,
34111 and LilyPond music notation.
34112 You can check the actual list by using the menu
34113 \begin_inset Flex Noun
34116 \begin_layout Plain Layout
34117 Insert\SpecialChar menuseparator
34118 File\SpecialChar menuseparator
34126 it is possible to roll your own template to support a specific kind of material.
34127 Later we'll describe in more detail what is involved,
34128 and hopefully you will submit all the templates you create so we can include them in a later \SpecialChar LyX
34132 \begin_layout Standard
34133 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.
34135 consider the case of a figure produced with
34136 \begin_inset Flex Code
34139 \begin_layout Plain Layout
34146 The Xfig application itself works on an original file with the
34147 \begin_inset Flex Code
34150 \begin_layout Plain Layout
34158 you create and change your figure,
34159 and when you are done,
34161 \begin_inset Flex Code
34164 \begin_layout Plain Layout
34171 When you want to include the figure in your document,
34173 \begin_inset Flex Code
34176 \begin_layout Plain Layout
34182 in order to create a PostScript file that can readily be included in your \SpecialChar LaTeX
34186 \begin_inset Flex Code
34189 \begin_layout Plain Layout
34195 file is the original file,
34196 and the PostScript file is the produced file.
34199 \begin_layout Standard
34200 This distinction is important in order to allow updating of the material while you are in the process of writing the document.
34202 it provides us with the flexibility that is needed to support multiple export formats.
34204 in the case of a plain text file,
34205 it is not exactly an award-winning idea to include the figure as raw PostScript.
34207 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.
34208 The external material management allows you to do this,
34209 because it is parametrized on the different export formats that \SpecialChar LyX
34213 \begin_layout Standard
34214 Besides supporting the production of different products according to the exported format,
34215 it supports tight integration with editing and viewing applications.
34216 In the case of an Xfig figure,
34217 you are able to invoke Xfig on the original file with a single click from within the external material dialog in \SpecialChar LyX
34219 and also preview the produced PostScript file with Ghostview with another click.
34220 No more fiddling around with the command line and/or file browsers to locate and manipulate the original or produced files.
34222 you are finally able to take full advantage of the many different applications that are relevant to use when you write your documents,
34223 and ultimately be more productive.
34226 \begin_layout Section
34227 The external template configuration files
34230 \begin_layout Standard
34231 It is relatively easy to add custom external template definitions to \SpecialChar LyX
34234 be aware that doing this in an careless manner most probably
34238 introduce an easily exploitable security hole.
34239 So before you do this,
34240 please read the discussion about security in
34241 \begin_inset CommandInset ref
34243 reference "sec:Security-discussion"
34251 \begin_layout Standard
34253 we encourage you to submit any interesting templates that you create.
34257 \begin_layout Standard
34258 The external templates are defined in the
34259 \begin_inset Flex Code
34262 \begin_layout Plain Layout
34268 files that are stored in the
34269 \begin_inset Flex Code
34272 \begin_layout Plain Layout
34273 LyXDir/lib/xtemplates/
34279 Each template is defined in a file of its own.
34280 You can place your own templates in
34281 \begin_inset Flex Code
34284 \begin_layout Plain Layout
34285 UserDir/xtemplates/
34290 or copy existing templates to that directory in order to modify them.
34293 \begin_layout Standard
34294 A typical template looks like this:
34297 \begin_layout LyX-Code
34301 \begin_layout LyX-Code
34303 $$AbsOrRelPathParent$$Basename"
34306 \begin_layout LyX-Code
34310 \begin_layout LyX-Code
34314 \begin_layout LyX-Code
34318 \begin_layout LyX-Code
34322 \begin_layout LyX-Code
34326 \begin_layout LyX-Code
34327 AutomaticProduction true
34330 \begin_layout LyX-Code
34334 \begin_layout LyX-Code
34338 \begin_layout LyX-Code
34342 \begin_layout LyX-Code
34343 TransformCommand Rotate RotationLatexCommand
34346 \begin_layout LyX-Code
34347 TransformCommand Resize ResizeLatexCommand
34350 \begin_layout LyX-Code
34351 Product "$$RotateFront$$ResizeFront
34354 \begin_layout LyX-Code
34359 input{$$AbsOrRelPathMaster$$Basename.pstex_t}
34362 \begin_layout LyX-Code
34363 $$ResizeBack$$RotateBack"
34366 \begin_layout LyX-Code
34370 \begin_layout LyX-Code
34371 UpdateResult "$$AbsPath$$Basename.pstex_t"
34374 \begin_layout LyX-Code
34375 Requirement "graphicx"
34378 \begin_layout LyX-Code
34379 ReferencedFile latex "$$AbsOrRelPathMaster$$Basename.pstex_t"
34382 \begin_layout LyX-Code
34383 ReferencedFile latex "$$AbsPath$$Basename.eps"
34386 \begin_layout LyX-Code
34387 ReferencedFile dvi "$$AbsPath$$Basename.eps"
34390 \begin_layout LyX-Code
34394 \begin_layout LyX-Code
34398 \begin_layout LyX-Code
34399 TransformCommand Rotate RotationLatexCommand
34402 \begin_layout LyX-Code
34403 TransformCommand Resize ResizeLatexCommand
34406 \begin_layout LyX-Code
34407 Product "$$RotateFront$$ResizeFront
34410 \begin_layout LyX-Code
34415 input{$$AbsOrRelPathMaster$$Basename.pdftex_t}
34418 \begin_layout LyX-Code
34419 $$ResizeBack$$RotateBack"
34422 \begin_layout LyX-Code
34423 UpdateFormat pdftex
34426 \begin_layout LyX-Code
34427 UpdateResult "$$AbsPath$$Basename.pdftex_t"
34430 \begin_layout LyX-Code
34431 Requirement "graphicx"
34434 \begin_layout LyX-Code
34435 ReferencedFile latex "$$AbsOrRelPathMaster$$Basename.pdftex_t"
34438 \begin_layout LyX-Code
34439 ReferencedFile latex "$$AbsPath$$Basename.pdf"
34442 \begin_layout LyX-Code
34446 \begin_layout LyX-Code
34450 \begin_layout LyX-Code
34455 \begin_layout LyX-Code
34459 \begin_layout LyX-Code
34463 \begin_layout LyX-Code
34464 Product "<graphic fileref=
34466 "$$AbsOrRelPathMaster$$Basename.eps
34471 \begin_layout LyX-Code
34475 \begin_layout LyX-Code
34479 \begin_layout LyX-Code
34480 UpdateResult "$$AbsPath$$Basename.eps"
34483 \begin_layout LyX-Code
34484 ReferencedFile docbook "$$AbsPath$$Basename.eps"
34487 \begin_layout LyX-Code
34488 ReferencedFile docbook-xml "$$AbsPath$$Basename.eps"
34491 \begin_layout LyX-Code
34495 \begin_layout LyX-Code
34499 \begin_layout Standard
34501 the template is enclosed in
34502 \begin_inset Flex Code
34505 \begin_layout Plain Layout
34513 \begin_inset Flex Code
34516 \begin_layout Plain Layout
34523 It contains a header specifying some general settings and,
34524 for each supported primary document file format,
34526 \begin_inset Flex Code
34529 \begin_layout Plain Layout
34537 \begin_inset Flex Code
34540 \begin_layout Plain Layout
34549 \begin_layout Subsection
34550 The template header
34553 \begin_layout Description
34554 \begin_inset Flex Code
34557 \begin_layout Plain Layout
34558 AutomaticProduction
34559 \begin_inset space ~
34567 Whether the file represented by the template must be generated by \SpecialChar LyX
34569 This command must occur exactly once.
34572 \begin_layout Description
34573 \begin_inset Flex Code
34576 \begin_layout Plain Layout
34578 \begin_inset space ~
34586 A glob pattern that is used in the file dialog to filter out the desired files.
34587 If there is more than one possible file extension (e.
34588 \begin_inset space \thinspace{}
34592 \begin_inset space \space{}
34596 \begin_inset Flex Code
34599 \begin_layout Plain Layout
34606 \begin_inset Flex Code
34609 \begin_layout Plain Layout
34617 \begin_inset Flex Code
34620 \begin_layout Plain Layout
34627 This command must occur exactly once.
34630 \begin_layout Description
34631 \begin_inset Flex Code
34634 \begin_layout Plain Layout
34636 \begin_inset space ~
34644 The text that is displayed on the button.
34645 This command must occur exactly once.
34648 \begin_layout Description
34649 \begin_inset Flex Code
34652 \begin_layout Plain Layout
34654 \begin_inset space ~
34658 \begin_inset space ~
34666 The help text that is used in the External dialog.
34667 Provide enough information to explain to the user just what the template can provide him with.
34668 This command must occur exactly once.
34671 \begin_layout Description
34672 \begin_inset Flex Code
34675 \begin_layout Plain Layout
34677 \begin_inset space ~
34685 The file format of the original file.
34686 This must be the name of a format that is known to \SpecialChar LyX
34688 \begin_inset CommandInset ref
34690 reference "sec:Formats"
34697 \begin_inset Quotes eld
34701 \begin_inset Flex Code
34704 \begin_layout Plain Layout
34711 \begin_inset Quotes erd
34714 if the template can handle original files of more than one format.
34716 will attempt to interrogate the file itself in order to deduce its format in this case.
34717 This command must occur exactly once.
34720 \begin_layout Description
34721 \begin_inset Flex Code
34724 \begin_layout Plain Layout
34726 \begin_inset space ~
34734 A unique name for the template.
34735 It must not contain substitution macros (see below).
34738 \begin_layout Description
34739 \begin_inset Flex Code
34742 \begin_layout Plain Layout
34744 \begin_inset space ~
34747 Rotate|Resize|Clip|Extra
34752 This command specifies which transformations are supported by this template.
34753 It may occur zero or more times.
34754 This command enables the corresponding tabs in the external dialog.
34756 \begin_inset Flex Code
34759 \begin_layout Plain Layout
34765 command must have either a corresponding
34766 \begin_inset Flex Code
34769 \begin_layout Plain Layout
34776 \begin_inset Flex Code
34779 \begin_layout Plain Layout
34786 \begin_inset Flex Code
34789 \begin_layout Plain Layout
34796 Otherwise the transformation will not be supported by that format.
34799 \begin_layout Subsection
34803 \begin_layout Description
34804 \begin_inset Flex Code
34807 \begin_layout Plain Layout
34809 \begin_inset space ~
34812 LaTeX|PDFLaTeX|PlainText|DocBook|XHTML
34817 The primary document file format that this format definition is for.
34818 Not every template has a sensible representation in all document file formats.
34819 Please define nevertheless a
34820 \begin_inset Flex Code
34823 \begin_layout Plain Layout
34829 section for all templates.
34830 Use a dummy text when no representation is available.
34831 Then you can at least see a reference to the external material in the exported document.
34834 \begin_layout Description
34835 \begin_inset Flex Code
34838 \begin_layout Plain Layout
34840 \begin_inset space ~
34844 \begin_inset space ~
34852 This command defines an additional macro
34853 \begin_inset Flex Code
34856 \begin_layout Plain Layout
34862 for substitution in
34863 \begin_inset Flex Code
34866 \begin_layout Plain Layout
34874 \begin_inset Flex Code
34877 \begin_layout Plain Layout
34883 itself may contain substitution macros.
34884 The advantage over using
34885 \begin_inset Flex Code
34888 \begin_layout Plain Layout
34895 \begin_inset Flex Code
34898 \begin_layout Plain Layout
34904 is that the substituted value of
34905 \begin_inset Flex Code
34908 \begin_layout Plain Layout
34914 is sanitized so that it is a valid optional argument in the document format.
34915 This command may occur zero or more times.
34918 \begin_layout Description
34919 \begin_inset Flex Code
34922 \begin_layout Plain Layout
34924 \begin_inset space ~
34932 The text that is inserted in the exported document.
34933 This is actually the most important command and can be quite complex.
34934 This command must occur exactly once.
34937 \begin_layout Description
34938 \begin_inset Flex Code
34941 \begin_layout Plain Layout
34943 \begin_inset space ~
34951 This command specifies a preamble snippet that will be included in the \SpecialChar LaTeX
34953 It has to be defined using
34954 \begin_inset Flex Code
34957 \begin_layout Plain Layout
34965 \begin_inset Flex Code
34968 \begin_layout Plain Layout
34975 This command may occur zero or more times.
34978 \begin_layout Description
34979 \begin_inset Flex Code
34982 \begin_layout Plain Layout
34984 \begin_inset space ~
34988 \begin_inset space ~
34996 This command denotes files that are created by the conversion process and are needed for a particular export format.
34997 If the filename is relative,
34998 it is interpreted relative to the master document.
34999 This command may be given zero or more times.
35002 \begin_layout Description
35003 \begin_inset Flex Code
35006 \begin_layout Plain Layout
35008 \begin_inset space ~
35016 The name of a required \SpecialChar LaTeX
35018 The package is included via
35019 \begin_inset Flex Code
35022 \begin_layout Plain Layout
35030 in the \SpecialChar LaTeX
35032 This command may occur zero or more times.
35035 \begin_layout Description
35036 \begin_inset Flex Code
35039 \begin_layout Plain Layout
35041 \begin_inset space ~
35045 \begin_inset space ~
35048 RotationLatexCommand
35053 This command specifies that the built in \SpecialChar LaTeX
35054 command should be used for rotation.
35055 This command may occur once or not at all.
35058 \begin_layout Description
35059 \begin_inset Flex Code
35062 \begin_layout Plain Layout
35064 \begin_inset space ~
35068 \begin_inset space ~
35076 This command specifies that the built in \SpecialChar LaTeX
35077 command should be used for resizing.
35078 This command may occur once or not at all.
35081 \begin_layout Description
35082 \begin_inset Flex Code
35085 \begin_layout Plain Layout
35087 \begin_inset space ~
35091 \begin_inset space ~
35094 RotationLatexOption
35099 This command specifies that rotation is done via an optional argument.
35100 This command may occur once or not at all.
35103 \begin_layout Description
35104 \begin_inset Flex Code
35107 \begin_layout Plain Layout
35109 \begin_inset space ~
35113 \begin_inset space ~
35121 This command specifies that resizing is done via an optional argument.
35122 This command may occur once or not at all.
35125 \begin_layout Description
35126 \begin_inset Flex Code
35129 \begin_layout Plain Layout
35131 \begin_inset space ~
35135 \begin_inset space ~
35143 This command specifies that clipping is done via an optional argument.
35144 This command may occur once or not at all.
35147 \begin_layout Description
35148 \begin_inset Flex Code
35151 \begin_layout Plain Layout
35153 \begin_inset space ~
35157 \begin_inset space ~
35165 This command specifies that an extra optional argument is used.
35166 This command may occur once or not at all.
35169 \begin_layout Description
35170 \begin_inset Flex Code
35173 \begin_layout Plain Layout
35175 \begin_inset space ~
35183 The file format of the converted file.
35184 This must be the name of a format that is known to \SpecialChar LyX
35186 \begin_inset Flex Noun
35189 \begin_layout Plain Layout
35190 Tools\SpecialChar menuseparator
35191 Preferences\SpecialChar menuseparator
35192 File Handling\SpecialChar menuseparator
35199 This command must occur exactly once.
35200 If the resulting file format is PDF,
35201 you need to specify the format
35202 \begin_inset Flex Code
35205 \begin_layout Plain Layout
35212 This is the PDF format used for including graphics.
35213 The other defined PDF formats are for document export.
35216 \begin_layout Description
35217 \begin_inset Flex Code
35220 \begin_layout Plain Layout
35222 \begin_inset space ~
35230 The file name of the converted file.
35231 The file name must be absolute.
35232 This command must occur exactly once.
35235 \begin_layout Subsection
35236 Preamble definitions
35239 \begin_layout Standard
35240 The external template configuration file may contain additional preamble definitions enclosed by
35241 \begin_inset Flex Code
35244 \begin_layout Plain Layout
35252 \begin_inset Flex Code
35255 \begin_layout Plain Layout
35262 They can be used by the templates in the
35263 \begin_inset Flex Code
35266 \begin_layout Plain Layout
35275 \begin_layout Section
35276 The substitution mechanism
35279 \begin_layout Standard
35280 When the external material facility invokes an external program,
35281 it is done on the basis of a command defined in the template configuration file.
35282 These commands can contain various macros that are expanded before execution.
35283 Execution always take place in the directory of the containing document.
35286 \begin_layout Standard
35288 whenever external material is to be displayed,
35289 the name will be produced by the substitution mechanism,
35290 and most other commands in the template definition support substitution as well.
35293 \begin_layout Standard
35294 The available macros are the following:
35297 \begin_layout Description
35298 \begin_inset Flex Code
35301 \begin_layout Plain Layout
35302 $$AbsOrRelPathMaster
35308 absolute or relative to the master \SpecialChar LyX
35312 \begin_layout Description
35313 \begin_inset Flex Code
35316 \begin_layout Plain Layout
35317 $$AbsOrRelPathParent
35323 absolute or relative to the \SpecialChar LyX
35327 \begin_layout Description
35328 \begin_inset Flex Code
35331 \begin_layout Plain Layout
35337 The absolute file path.
35340 \begin_layout Description
35341 \begin_inset Flex Code
35344 \begin_layout Plain Layout
35350 The filename without path and without the extension.
35353 \begin_layout Description
35354 \begin_inset Flex Code
35357 \begin_layout Plain Layout
35359 \begin_inset Quotes eld
35363 \begin_inset Quotes erd
35371 This macro will expand to the contents of the file with the name
35372 \begin_inset Flex Code
35375 \begin_layout Plain Layout
35384 \begin_layout Description
35385 \begin_inset Flex Code
35388 \begin_layout Plain Layout
35394 The file extension (including the dot).
35397 \begin_layout Description
35398 \begin_inset Flex Code
35401 \begin_layout Plain Layout
35407 This will be the string
35408 \begin_inset Quotes eld
35412 \begin_inset Quotes erd
35415 if the file is in JPEG format,
35416 otherwise it will be the string
35417 \begin_inset Quotes eld
35421 \begin_inset Quotes erd
35425 This is useful to avoid uneeded conversions for output formats that support both PNG and JPEG fomats.
35426 The predefined RasterImage template uses this macro for the pdf\SpecialChar TeX
35430 \begin_layout Description
35431 \begin_inset Flex Code
35434 \begin_layout Plain Layout
35440 The filename of the file specified in the external material dialog.
35441 This is either an absolute name,
35442 or it is relative to the \SpecialChar LyX
35446 \begin_layout Description
35447 \begin_inset Flex Code
35450 \begin_layout Plain Layout
35457 \begin_inset Flex Code
35460 \begin_layout Plain Layout
35466 (absolute name or relative to the \SpecialChar LyX
35470 \begin_layout Description
35471 \begin_inset Flex Code
35474 \begin_layout Plain Layout
35481 relative to the master \SpecialChar LyX
35485 \begin_layout Description
35486 \begin_inset Flex Code
35489 \begin_layout Plain Layout
35496 relative to the \SpecialChar LyX
35500 \begin_layout Description
35501 \begin_inset Flex Code
35504 \begin_layout Plain Layout
35510 This macro will expand to the absolute path of the system directory.
35511 This is typically used to point to the various helper scripts that are bundled with \SpecialChar LyX
35515 \begin_layout Description
35516 \begin_inset Flex Code
35519 \begin_layout Plain Layout
35525 A name and full path to a temporary file which will be automatically deleted whenever the containing document is closed,
35526 or the external material insertion deleted.
35529 \begin_layout Standard
35530 All path macros contain a trailing directory separator,
35531 so you can construct e.
35532 \begin_inset space \thinspace{}
35536 \begin_inset space \space{}
35539 the absolute filename with
35540 \begin_inset Flex Code
35543 \begin_layout Plain Layout
35544 $$AbsPath$$Basename$$Extension
35552 \begin_layout Standard
35553 The macros above are substituted in all commands unless otherwise noted.
35555 \begin_inset Flex Code
35558 \begin_layout Plain Layout
35564 supports additionally the following substitutions if they are enabled by the
35565 \begin_inset Flex Code
35568 \begin_layout Plain Layout
35575 \begin_inset Flex Code
35578 \begin_layout Plain Layout
35587 \begin_layout Description
35588 \begin_inset Flex Code
35591 \begin_layout Plain Layout
35597 The front part of the resize command.
35600 \begin_layout Description
35601 \begin_inset Flex Code
35604 \begin_layout Plain Layout
35610 The back part of the resize command.
35613 \begin_layout Description
35614 \begin_inset Flex Code
35617 \begin_layout Plain Layout
35623 The front part of the rotation command.
35626 \begin_layout Description
35627 \begin_inset Flex Code
35630 \begin_layout Plain Layout
35636 The back part of the rotation command.
35639 \begin_layout Standard
35640 The value string of the
35641 \begin_inset Flex Code
35644 \begin_layout Plain Layout
35650 command supports additionally the following substitutions if they are enabled by the
35651 \begin_inset Flex Code
35654 \begin_layout Plain Layout
35661 \begin_inset Flex Code
35664 \begin_layout Plain Layout
35673 \begin_layout Description
35674 \begin_inset Flex Code
35677 \begin_layout Plain Layout
35686 \begin_layout Description
35687 \begin_inset Flex Code
35690 \begin_layout Plain Layout
35699 \begin_layout Description
35700 \begin_inset Flex Code
35703 \begin_layout Plain Layout
35712 \begin_layout Description
35713 \begin_inset Flex Code
35716 \begin_layout Plain Layout
35722 The rotation option.
35725 \begin_layout Standard
35726 You may ask why there are so many path macros.
35727 There are mainly two reasons:
35730 \begin_layout Enumerate
35731 Relative and absolute file names should remain relative or absolute,
35733 Users may have reasons to prefer either form.
35734 Relative names are useful for portable documents that should work on different machines,
35736 Absolute names may be required by some programs.
35739 \begin_layout Enumerate
35741 treats relative file names differently than \SpecialChar LyX
35742 and other programs in nested included files.
35743 For \SpecialChar LyX
35745 a relative file name is always relative to the document that contains the file name.
35746 For \SpecialChar LaTeX
35748 it is always relative to the master document.
35749 These two definitions are identical if you have only one document,
35750 but differ if you have a master document that includes part documents.
35751 That means that relative filenames must be transformed when presented to \SpecialChar LaTeX
35753 Fortunately \SpecialChar LyX
35754 does this automatically for you if you choose the right macros.
35757 \begin_layout Standard
35758 So which path macro should be used in new template definitions?
35759 The rule is not difficult:
35762 \begin_layout Itemize
35764 \begin_inset Flex Code
35767 \begin_layout Plain Layout
35773 if an absolute path is required.
35776 \begin_layout Itemize
35778 \begin_inset Flex Code
35781 \begin_layout Plain Layout
35782 $$AbsOrRelPathMaster
35787 if the substituted string is some kind of \SpecialChar LaTeX
35791 \begin_layout Itemize
35793 \begin_inset Flex Code
35796 \begin_layout Plain Layout
35797 $$AbsOrRelPathParent
35802 in order to preserve the user's choice.
35805 \begin_layout Standard
35806 There are special cases where this rule does not work and e.
35807 \begin_inset space \thinspace{}
35811 \begin_inset space \space{}
35814 relative names are needed,
35815 but normally it will work just fine.
35816 One example for such a case is the command
35817 \begin_inset Flex Code
35820 \begin_layout Plain Layout
35821 ReferencedFile latex "$$AbsOrRelPathMaster$$Basename.pstex_t"
35826 in the XFig template above:
35827 We can't use the absolute name because the copier for
35828 \begin_inset Flex Code
35831 \begin_layout Plain Layout
35837 files needs the relative name in order to rewrite the file content.
35840 \begin_layout Section
35841 Security discussion
35842 \begin_inset CommandInset label
35844 name "sec:Security-discussion"
35851 \begin_layout Standard
35852 The external material feature interfaces with a lot of external programs and does so automatically,
35853 so we have to consider the security implications of this.
35855 since you have the option of including your own filenames and/or parameter strings and those are expanded into a command,
35856 it seems that it would be possible to create a malicious document which executes arbitrary commands when a user views or prints the document.
35857 This is something we definitely want to avoid.
35860 \begin_layout Standard
35862 since the external program commands are specified in the template configuration file only,
35863 there are no security issues if \SpecialChar LyX
35864 is properly configured with safe templates only.
35865 This is so because the external programs are invoked with the
35866 \begin_inset Flex Code
35869 \begin_layout Plain Layout
35875 -system call rather than the
35876 \begin_inset Flex Code
35879 \begin_layout Plain Layout
35886 so it's not possible to execute arbitrary commands from the filename or parameter section via the shell.
35889 \begin_layout Standard
35890 This also implies that you are restricted in what command strings you can use in the external material templates.
35892 pipes and redirection are not readily available.
35893 This has to be so if \SpecialChar LyX
35894 should remain safe.
35895 If you want to use some of the shell features,
35896 you should write a safe script to do this in a controlled manner,
35897 and then invoke the script from the command string.
35901 \begin_layout Standard
35902 It is possible to design a template that interacts directly with the shell,
35903 but since this would allow a malicious user to execute arbitrary commands by writing clever filenames and/or parameters,
35904 we generally recommend that you only use safe scripts that work with the
35905 \begin_inset Flex Code
35908 \begin_layout Plain Layout
35914 system call in a controlled manner.
35916 for use in a controlled environment,
35917 it can be tempting to just fall back to use ordinary shell scripts.
35923 provide an easily exploitable security hole in your system.
35924 Of course it stands to reason that such unsafe templates will never be included in the standard \SpecialChar LyX
35926 although we do encourage people to submit new templates in the open source tradition.
35927 But \SpecialChar LyX
35928 as shipped from the official distribution channels will never have unsafe templates.
35931 \begin_layout Standard
35932 Including external material provides a lot of power,
35933 and you have to be careful not to introduce security hazards with this power.
35934 A subtle error in a single line in an innocent looking script can open the door to huge security problems.
35935 So if you do not fully understand the issues,
35936 we recommend that you consult a knowledgeable security professional or the \SpecialChar LyX
35937 development team if you have any questions about whether a given template is safe or not.
35938 And do this before you use it in an uncontrolled environment.
35941 \begin_layout Chapter
35943 List of supported \SpecialChar LyX
35944 functions to be used in layouts
35945 \begin_inset CommandInset label
35947 name "chap:List-of-functions"
35954 \begin_layout Standard
35956 \begin_inset Tabular
35957 <lyxtabular version="3" rows="11" columns="8">
35958 <features tabularvalignment="middle">
35959 <column alignment="left" valignment="top">
35960 <column alignment="left" valignment="top">
35961 <column alignment="left" valignment="top">
35962 <column alignment="left" valignment="top">
35963 <column alignment="left" valignment="top">
35964 <column alignment="left" valignment="top">
35965 <column alignment="left" valignment="top">
35966 <column alignment="left" valignment="top">
35968 <cell alignment="left" valignment="top" usebox="none">
35971 \begin_layout Plain Layout
35977 <cell alignment="left" valignment="top" usebox="none">
35980 \begin_layout Plain Layout
35986 <cell alignment="left" valignment="top" usebox="none">
35989 \begin_layout Plain Layout
35995 <cell alignment="left" valignment="top" usebox="none">
35998 \begin_layout Plain Layout
36004 <cell alignment="center" valignment="top" usebox="none">
36007 \begin_layout Plain Layout
36013 <cell alignment="center" valignment="top" usebox="none">
36016 \begin_layout Plain Layout
36022 <cell alignment="center" valignment="top" usebox="none">
36025 \begin_layout Plain Layout
36031 <cell alignment="center" valignment="top" usebox="none">
36034 \begin_layout Plain Layout
36042 <cell alignment="left" valignment="top" usebox="none">
36045 \begin_layout Plain Layout
36051 <cell alignment="left" valignment="top" usebox="none">
36054 \begin_layout Plain Layout
36060 <cell alignment="left" valignment="top" usebox="none">
36063 \begin_layout Plain Layout
36069 <cell alignment="left" valignment="top" usebox="none">
36072 \begin_layout Plain Layout
36078 <cell alignment="center" valignment="top" usebox="none">
36081 \begin_layout Plain Layout
36087 <cell alignment="center" valignment="top" usebox="none">
36090 \begin_layout Plain Layout
36096 <cell alignment="center" valignment="top" usebox="none">
36099 \begin_layout Plain Layout
36105 <cell alignment="center" valignment="top" usebox="none">
36108 \begin_layout Plain Layout
36116 <cell alignment="left" valignment="top" usebox="none">
36119 \begin_layout Plain Layout
36125 <cell alignment="left" valignment="top" usebox="none">
36128 \begin_layout Plain Layout
36134 <cell alignment="left" valignment="top" usebox="none">
36137 \begin_layout Plain Layout
36143 <cell alignment="left" valignment="top" usebox="none">
36146 \begin_layout Plain Layout
36152 <cell alignment="center" valignment="top" usebox="none">
36155 \begin_layout Plain Layout
36161 <cell alignment="center" valignment="top" usebox="none">
36164 \begin_layout Plain Layout
36170 <cell alignment="center" valignment="top" usebox="none">
36173 \begin_layout Plain Layout
36179 <cell alignment="center" valignment="top" usebox="none">
36182 \begin_layout Plain Layout
36190 <cell alignment="left" valignment="top" usebox="none">
36193 \begin_layout Plain Layout
36199 <cell alignment="left" valignment="top" usebox="none">
36202 \begin_layout Plain Layout
36208 <cell alignment="left" valignment="top" usebox="none">
36211 \begin_layout Plain Layout
36217 <cell alignment="left" valignment="top" usebox="none">
36220 \begin_layout Plain Layout
36226 <cell alignment="center" valignment="top" usebox="none">
36229 \begin_layout Plain Layout
36235 <cell alignment="center" valignment="top" usebox="none">
36238 \begin_layout Plain Layout
36244 <cell alignment="center" valignment="top" usebox="none">
36247 \begin_layout Plain Layout
36253 <cell alignment="center" valignment="top" usebox="none">
36256 \begin_layout Plain Layout
36264 <cell alignment="left" valignment="top" usebox="none">
36267 \begin_layout Plain Layout
36273 <cell alignment="left" valignment="top" usebox="none">
36276 \begin_layout Plain Layout
36282 <cell alignment="left" valignment="top" usebox="none">
36285 \begin_layout Plain Layout
36291 <cell alignment="left" valignment="top" usebox="none">
36294 \begin_layout Plain Layout
36300 <cell alignment="center" valignment="top" usebox="none">
36303 \begin_layout Plain Layout
36309 <cell alignment="center" valignment="top" usebox="none">
36312 \begin_layout Plain Layout
36318 <cell alignment="center" valignment="top" usebox="none">
36321 \begin_layout Plain Layout
36327 <cell alignment="center" valignment="top" usebox="none">
36330 \begin_layout Plain Layout
36338 <cell alignment="left" valignment="top" usebox="none">
36341 \begin_layout Plain Layout
36347 <cell alignment="left" valignment="top" usebox="none">
36350 \begin_layout Plain Layout
36356 <cell alignment="left" valignment="top" usebox="none">
36359 \begin_layout Plain Layout
36365 <cell alignment="left" valignment="top" usebox="none">
36368 \begin_layout Plain Layout
36374 <cell alignment="center" valignment="top" usebox="none">
36377 \begin_layout Plain Layout
36383 <cell alignment="center" valignment="top" usebox="none">
36386 \begin_layout Plain Layout
36392 <cell alignment="center" valignment="top" usebox="none">
36395 \begin_layout Plain Layout
36401 <cell alignment="center" valignment="top" usebox="none">
36404 \begin_layout Plain Layout
36412 <cell alignment="left" valignment="top" usebox="none">
36415 \begin_layout Plain Layout
36421 <cell alignment="left" valignment="top" usebox="none">
36424 \begin_layout Plain Layout
36430 <cell alignment="left" valignment="top" usebox="none">
36433 \begin_layout Plain Layout
36439 <cell alignment="left" valignment="top" usebox="none">
36442 \begin_layout Plain Layout
36448 <cell alignment="center" valignment="top" usebox="none">
36451 \begin_layout Plain Layout
36457 <cell alignment="center" valignment="top" usebox="none">
36460 \begin_layout Plain Layout
36466 <cell alignment="center" valignment="top" usebox="none">
36469 \begin_layout Plain Layout
36475 <cell alignment="center" valignment="top" usebox="none">
36478 \begin_layout Plain Layout
36486 <cell alignment="left" valignment="top" usebox="none">
36489 \begin_layout Plain Layout
36495 <cell alignment="left" valignment="top" usebox="none">
36498 \begin_layout Plain Layout
36504 <cell alignment="left" valignment="top" usebox="none">
36507 \begin_layout Plain Layout
36513 <cell alignment="left" valignment="top" usebox="none">
36516 \begin_layout Plain Layout
36522 <cell alignment="center" valignment="top" usebox="none">
36525 \begin_layout Plain Layout
36531 <cell alignment="center" valignment="top" usebox="none">
36534 \begin_layout Plain Layout
36540 <cell alignment="center" valignment="top" usebox="none">
36543 \begin_layout Plain Layout
36549 <cell alignment="center" valignment="top" usebox="none">
36552 \begin_layout Plain Layout
36560 <cell alignment="left" valignment="top" usebox="none">
36563 \begin_layout Plain Layout
36569 <cell alignment="left" valignment="top" usebox="none">
36572 \begin_layout Plain Layout
36578 <cell alignment="left" valignment="top" usebox="none">
36581 \begin_layout Plain Layout
36587 <cell alignment="left" valignment="top" usebox="none">
36590 \begin_layout Plain Layout
36596 <cell alignment="center" valignment="top" usebox="none">
36599 \begin_layout Plain Layout
36605 <cell alignment="center" valignment="top" usebox="none">
36608 \begin_layout Plain Layout
36614 <cell alignment="center" valignment="top" usebox="none">
36617 \begin_layout Plain Layout
36623 <cell alignment="center" valignment="top" usebox="none">
36626 \begin_layout Plain Layout
36634 <cell alignment="left" valignment="top" usebox="none">
36637 \begin_layout Plain Layout
36643 <cell alignment="left" valignment="top" usebox="none">
36646 \begin_layout Plain Layout
36652 <cell alignment="left" valignment="top" usebox="none">
36655 \begin_layout Plain Layout
36661 <cell alignment="left" valignment="top" usebox="none">
36664 \begin_layout Plain Layout
36670 <cell alignment="center" valignment="top" usebox="none">
36673 \begin_layout Plain Layout
36679 <cell alignment="center" valignment="top" usebox="none">
36682 \begin_layout Plain Layout
36688 <cell alignment="center" valignment="top" usebox="none">
36691 \begin_layout Plain Layout
36697 <cell alignment="center" valignment="top" usebox="none">
36700 \begin_layout Plain Layout
36708 <cell alignment="center" valignment="top" usebox="none">
36711 \begin_layout Plain Layout
36717 <cell alignment="center" valignment="top" usebox="none">
36720 \begin_layout Plain Layout
36726 <cell alignment="center" valignment="top" usebox="none">
36729 \begin_layout Plain Layout
36735 <cell alignment="center" valignment="top" usebox="none">
36738 \begin_layout Plain Layout
36744 <cell alignment="center" valignment="top" usebox="none">
36747 \begin_layout Plain Layout
36753 <cell alignment="center" valignment="top" usebox="none">
36756 \begin_layout Plain Layout
36762 <cell alignment="center" valignment="top" usebox="none">
36765 \begin_layout Plain Layout
36771 <cell alignment="center" valignment="top" usebox="none">
36774 \begin_layout Plain Layout
36788 \begin_layout Chapter
36789 Names of available colors to be used in layouts
36790 \begin_inset CommandInset label
36792 name "chap:Names-of-colors"
36799 \begin_layout Standard
36800 The colors listed below are the standard colors and those that you can adjust in the \SpecialChar LyX
36804 \begin_layout Section
36808 \begin_layout Standard
36809 The following are no real colors,
36810 but rather act on color definitions:
36813 \begin_layout Description
36814 ignore The color is ignored
36817 \begin_layout Description
36818 inherit The color is inherited
36821 \begin_layout Description
36834 No particular color – clear or default
36837 \begin_layout Section
36841 \begin_layout Standard
36842 These are fixed colors that cannot be customized
36843 \change_inserted -712698321 1607683177
36849 use these colors in layout definitions,
36850 since they will not work well with some color themes (such as dark themes)
36855 \begin_layout Description
36859 \begin_layout Description
36863 \begin_layout Description
36867 \begin_layout Description
36871 \begin_layout Description
36875 \begin_layout Description
36879 \begin_layout Description
36883 \begin_layout Description
36887 \begin_layout Description
36891 \begin_layout Description
36895 \begin_layout Description
36899 \begin_layout Description
36903 \begin_layout Description
36907 \begin_layout Description
36911 \begin_layout Description
36915 \begin_layout Description
36919 \begin_layout Description
36923 \begin_layout Description
36927 \begin_layout Description
36931 \begin_layout Section
36935 \begin_layout Standard
36936 These are the colors allocated to specific elements in
36939 arg "dialog-show prefs"
36945 \begin_layout Description
36946 added_space Added space color
36949 \begin_layout Description
36950 addedtext Added text color
36953 \begin_layout Description
36954 appendix Appendix marker color
36957 \begin_layout Description
36958 background Background color
36959 \change_inserted 5863208 1681507589
36963 \begin_layout Description
36965 \change_inserted 5863208 1681507597
36966 bookmark Bookmark indicator color
36971 \begin_layout Description
36972 bottomarea Bottom area color
36975 \begin_layout Description
36976 branchlabel Label color for branches
36979 \begin_layout Description
36980 buttonbg Color used for button background
36983 \begin_layout Description
36984 buttonframe Color for inset button frames
36987 \begin_layout Description
36988 buttonhoverbg Color used for button background under focus
36989 \change_inserted -712698321 1681555554
36993 \begin_layout Description
36995 \change_inserted -712698321 1681555554
36996 buttonhoverbg_broken Color used for broken inset button under focus
37001 \begin_layout Description
37002 changebar Changebar color
37005 \begin_layout Description
37006 changedtextauthor1 Changed text color author 1
37009 \begin_layout Description
37010 changedtextauthor2 Changed text color author 2
37013 \begin_layout Description
37014 changedtextauthor3 Changed text color author 3
37017 \begin_layout Description
37018 changedtextauthor4 Changed text color author 4
37021 \begin_layout Description
37022 changedtextauthor5 Changed text color author 5
37023 \change_inserted 5863208 1681507402
37027 \begin_layout Description
37029 \change_inserted 5863208 1681507414
37030 changedtextcomparison Changed text color document comparison (workarea)
37035 \begin_layout Description
37036 collapsible Collapsible insets text color
37039 \begin_layout Description
37040 collapsibleframe Collapsible insets framecolor
37043 \begin_layout Description
37044 command Text color for command insets
37047 \begin_layout Description
37048 commandbg Background color for command insets
37051 \begin_layout Description
37052 commandframe Frame color for command insets
37053 \change_inserted 5863208 1681507735
37057 \begin_layout Description
37059 \change_inserted 5863208 1681507880
37060 command_broken Text color for broken
37061 \change_inserted -712698321 1681555620
37063 \change_inserted 5863208 1681507880
37065 \change_deleted -712698321 1681555620
37067 \change_inserted 5863208 1681507880
37071 \begin_layout Description
37073 \change_inserted 5863208 1681507827
37074 commandbg_broken Background color for broken insets
37077 \begin_layout Description
37079 \change_inserted 5863208 1681507835
37080 commandframe_broken Frame color for broken insets
37083 \begin_layout Description
37085 \change_deleted -712698321 1681555548
37086 buttonhoverbg_broken Color used for broken inset button under focus
37091 \begin_layout Description
37092 comment Label color for comments
37095 \begin_layout Description
37096 commentbg Background color of comments
37099 \begin_layout Description
37100 cursor Cursor color
37103 \begin_layout Description
37104 deletedtext Deleted text color
37107 \begin_layout Description
37108 deletedtextmodifier Deleted text modifying color
37109 \change_inserted 5863208 1681507525
37111 \change_deleted -712698321 1681555611
37113 \change_inserted -712698321 1681555611
37115 \change_inserted 5863208 1681507525
37121 \begin_layout Description
37122 depthbar Color for the depth bars in the margin
37125 \begin_layout Description
37126 eolmarker End of line marker color
37129 \begin_layout Description
37130 error Color of the \SpecialChar LaTeX
37134 \begin_layout Description
37135 footlabel Label color for footnotes
37138 \begin_layout Description
37139 foreground Foreground color
37142 \begin_layout Description
37143 graphicsbg Graphics inset background color
37146 \begin_layout Description
37147 greyedoutbg Background color of greyedout inset
37150 \begin_layout Description
37151 greyedoutlabel Label color for greyedout insets
37154 \begin_layout Description
37155 greyedouttext Color for greyedout inset text
37158 \begin_layout Description
37159 indexlabel Label color for index insets
37162 \begin_layout Description
37163 inlinecompletion Inline completion color
37166 \begin_layout Description
37167 insetbg Inset marker background color
37170 \begin_layout Description
37171 insetframe Inset marker frame color
37174 \begin_layout Description
37175 language Color for marking foreign language words
37178 \begin_layout Description
37179 latex Text color in \SpecialChar LaTeX
37183 \begin_layout Description
37184 listingsbg Background color of listings inset
37187 \begin_layout Description
37188 marginlabel Label color for margin notes
37191 \begin_layout Description
37192 math Math inset text color
37195 \begin_layout Description
37196 mathbg Math inset background color
37199 \begin_layout Description
37200 mathcorners Math inset frame color not under focus
37203 \begin_layout Description
37204 mathframe Math inset frame color under focus
37207 \begin_layout Description
37208 mathline Math line color
37211 \begin_layout Description
37212 mathmacrobg Macro math inset background color
37215 \begin_layout Description
37216 mathmacroblend Macro math blended color
37219 \begin_layout Description
37220 mathmacroframe Macro math frame color
37223 \begin_layout Description
37224 mathmacrohoverbg Macro math inset background color hovered
37227 \begin_layout Description
37228 mathmacrolabel Macro math label color
37231 \begin_layout Description
37232 mathmacronewarg Macro template color for new parameters
37235 \begin_layout Description
37236 mathmacrooldarg Macro template color for old parameters
37239 \begin_layout Description
37240 newpage New page color
37243 \begin_layout Description
37244 nonunique_inlinecompletion Inline completion color for the non-unique part
37247 \begin_layout Description
37248 note Label color for notes
37251 \begin_layout Description
37252 notebg Background color of notes
37255 \begin_layout Description
37256 pagebreak Page break/line break color
37259 \begin_layout Description
37260 paragraphmarker Color used for the pilcrow sign to mark the end of a paragraph
37263 \begin_layout Description
37264 phantomtext Text color for phantom insets
37267 \begin_layout Description
37268 preview The color used for previews
37271 \begin_layout Description
37272 previewframe Preview frame color
37275 \begin_layout Description
37276 regexpframe Color for regexp frame
37279 \begin_layout Description
37280 scroll Color that indicates when a row can be scrolled
37283 \begin_layout Description
37284 selection Background color of selected text
37287 \begin_layout Description
37288 selectiontext Foreground color of selected text
37291 \begin_layout Description
37292 shadedbg Background color of shaded box
37295 \begin_layout Description
37296 special Special chars text color
37299 \begin_layout Description
37300 tabularline Table line color
37303 \begin_layout Description
37304 tabularonoffline Table line color
37305 \change_inserted -712698321 1607682522
37309 \begin_layout Description
37311 \change_inserted -712698321 1607682563
37312 textlabel1 Color 1 of layout and custom inset labels
37315 \begin_layout Description
37317 \change_inserted -712698321 1607682565
37318 textlabel2 Color 2 of layout and custom inset labels
37321 \begin_layout Description
37323 \change_inserted -712698321 1607682568
37324 textlabel3 Color 3 of layout and custom inset labels
37329 \begin_layout Description
37330 urllabel Label color for URL insets
37333 \begin_layout Description
37334 urltext Color for URL inset text