1 #LyX 2.4 created this file. For more info see https://www.lyx.org/
5 \save_transient_properties true
6 \origin /systemlyxdir/doc/
9 % DO NOT ALTER THIS PREAMBLE!!!
11 % This preamble is designed to ensure that this document prints
12 % out as advertised. If you mess with this preamble,
13 % parts of this document may not print out as expected. If you
14 % have problems LaTeXing this file, please contact
15 % the documentation team
16 % email: lyx-docs@lists.lyx.org
18 % the pages of the TOC is numbered roman
19 % and a pdf-bookmark for the TOC is added
20 \let\myTOC\tableofcontents
21 \renewcommand\tableofcontents{%
23 \pdfbookmark[1]{\contentsname}{}
27 % increase link area for cross-references and autoname them,
28 \AtBeginDocument{\renewcommand{\ref}[1]{\mbox{\autoref{#1}}}}
29 \@ifundefined{extrasenglish}{\usepackage[english]{babel}}{}
30 \@ifpackageloaded{babel}{
31 \addto\extrasenglish{%
32 \renewcommand*{\equationautorefname}[1]{}%
33 \renewcommand{\sectionautorefname}{sec.\negthinspace}%
34 \renewcommand{\subsectionautorefname}{sec.\negthinspace}%
35 \renewcommand{\subsubsectionautorefname}{sec.\negthinspace}%
39 \options bibliography=totoc,index=totoc,BCOR7.5mm,titlepage,captions=tableheading
40 \use_default_options false
44 \maintain_unincluded_children no
46 \language_package default
49 \font_roman "lmodern" "default"
50 \font_sans "lmss" "default"
51 \font_typewriter "lmtt" "default"
52 \font_math "auto" "auto"
53 \font_default_family default
54 \use_non_tex_fonts false
58 \font_typewriter_osf false
59 \font_sf_scale 100 100
60 \font_tt_scale 100 100
62 \use_dash_ligatures true
64 \default_output_format pdf2
66 \bibtex_command default
67 \index_command default
71 \pdf_title "LyX Configuration Manual"
72 \pdf_author "LyX Team"
73 \pdf_subject "LyX-documentation Customization"
74 \pdf_keywords "LyX, documentation, customization"
76 \pdf_bookmarksnumbered true
77 \pdf_bookmarksopen true
78 \pdf_bookmarksopenlevel 1
83 \pdf_pdfusetitle false
84 \pdf_quoted_options "linkcolor=black, citecolor=black, urlcolor=blue, filecolor=blue,pdfpagelayout=OneColumn, pdfnewwindow=true, pdfstartview=XYZ, plainpages=false"
87 \use_package amsmath 1
88 \use_package amssymb 1
91 \use_package mathdots 1
92 \use_package mathtools 1
94 \use_package stackrel 1
95 \use_package stmaryrd 1
96 \use_package undertilde 1
98 \cite_engine_type default
102 \paperorientation portrait
108 \notefontcolor #0000ff
112 \color #f5fae7 #0a0518
120 \paragraph_separation indent
121 \paragraph_indentation default
123 \math_indentation default
124 \math_numbering_side default
125 \quotes_style english
129 \paperpagestyle headings
131 \tracking_changes true
132 \output_changes false
134 \postpone_fragile_content false
138 \docbook_table_output 0
139 \docbook_mathml_prefix 1
140 \author -970929547 "Thibaut Cuvelier"
141 \author -712698321 "Jürgen Spitzmüller"
142 \author -584632292 "Richard Kimberly Heck"
143 \author -495245474 "Jean-Marc Lasgouttes"
146 \author 34634807 "Jean-Pierre"
147 \author 47243155 "Jean-Marc"
148 \author 232239728 "Owner"
149 \author 731793113 "Richard Kimberly Heck" rikiheck@lyx.org
150 \author 1075283030 "Thibaut"
156 Customizing \SpecialChar LyX
158 Features for the Advanced User
162 by the \SpecialChar LyX
167 \begin_layout Plain Layout
168 If you have comments or error corrections,
169 please send them to the \SpecialChar LyX
170 Documentation mailing list,
172 \begin_inset CommandInset href
174 target "lyx-docs@lists.lyx.org"
182 \begin_inset Quotes eld
186 \begin_inset Quotes erd
189 in the subject header,
190 and please cc the current maintainer of this file,
192 \change_inserted 5863208 1604930692
196 \change_inserted 5863208 1604930729
198 \change_deleted 5863208 1604930668
207 \begin_inset Newline newline
211 \begin_inset Newline newline
217 \begin_layout Standard
218 \begin_inset CommandInset toc
219 LatexCommand tableofcontents
226 \begin_layout Standard
227 \begin_inset Note Note
230 \begin_layout Plain Layout
231 Please use change tracking when modifying this document.
232 This makes it easier for our translators to recognize things that have been changed,
233 and it helps the maintainer keep up-to-date with what's been done.
241 \begin_layout Chapter
245 \begin_layout Standard
246 This manual covers the customization features present in \SpecialChar LyX
249 we discuss issues like keyboard shortcuts,
250 screen previewing options,
252 sending commands to \SpecialChar LyX
253 via the \SpecialChar LyX
255 internationalization,
256 installing new \SpecialChar LaTeX
257 classes and \SpecialChar LyX
260 We can't possibly hope to touch on everything you can change—
261 our developers add new features faster than we can document them—
262 but we will explain the most common customizations and hopefully point you in the right direction for some of the more obscure ones.
265 \begin_layout Standard
266 \begin_inset Branch OutDated
270 \begin_layout Standard
271 Information from previous versions of this document that now seems to be outdated is contained in the OutDated branch of this document.
273 this information will not appear in the \SpecialChar LaTeX
282 \begin_layout Chapter
287 \begin_layout Standard
288 This chapter aims to help you to find your way through the \SpecialChar LyX
290 Before continuing to read this chapter,
291 you should find out where your \SpecialChar LyX
292 library and user directories are by using
293 \begin_inset Flex Noun
296 \begin_layout Plain Layout
297 Help\SpecialChar menuseparator
308 The library directory is the place where \SpecialChar LyX
309 places its system-wide configuration files;
310 the user directory is where you can place your modified versions.
311 We will call the former
312 \begin_inset Flex Code
315 \begin_layout Plain Layout
322 \begin_inset Flex Noun
325 \begin_layout Plain Layout
331 in the remainder of this document.
335 \begin_layout Section
337 \begin_inset Flex Code
340 \begin_layout Plain Layout
349 \begin_layout Standard
350 \begin_inset Flex Code
353 \begin_layout Plain Layout
359 and its sub-directories contain a number of files
360 \change_deleted 232239728 1604787780
363 that can be used to customize \SpecialChar LyX
365 You can change many of these files from within \SpecialChar LyX
367 \begin_inset Flex Noun
370 \begin_layout Plain Layout
371 Tools\SpecialChar menuseparator
378 Most customization that you will want to do in \SpecialChar LyX
379 is possible through this dialog.
381 many other inner aspects of \SpecialChar LyX
382 can be customized by modifying the files in
383 \begin_inset Flex Code
386 \begin_layout Plain Layout
393 These files fall in different categories,
394 described in the following subsections.
397 \begin_layout Subsection
398 Automatically generated files
401 \begin_layout Standard
403 \begin_inset Flex Noun
406 \begin_layout Plain Layout
412 are generated when you configure \SpecialChar LyX
414 They contain various default values that are
415 \change_inserted 5863208 1604919565
416 automatically detected during reconfiguration.
417 \change_deleted 232239728 1604788241
418 guessed by inspection
421 it is not a good idea to modify them,
422 since they might be overwritten at any time.
425 \begin_layout Labeling
426 \labelwidthstring 00.00.0000
427 \begin_inset Flex Code
430 \begin_layout Plain Layout
437 \change_deleted 5863208 1604919950
439 \begin_inset Note Note
442 \begin_layout Plain Layout
444 \change_inserted 232239728 1604853928
445 I capitalized the first word in all of these lists.
446 To me it looks better but it really is a stylistic thing,
448 However if you are not going to capitalize them,
449 the english in some needs to be modified to make it read correctly as a sentence.
457 \change_deleted 232239728 1604853510
459 \change_inserted 232239728 1604853510
462 ontains defaults for various commands.
465 \begin_layout Labeling
466 \labelwidthstring 00.00.0000
467 \begin_inset Flex Code
470 \begin_layout Plain Layout
477 \change_deleted 232239728 1604853512
479 \change_inserted 232239728 1604853512
482 ontains the list of packages that have been recognized by \SpecialChar LyX
484 It is currently unused by the \SpecialChar LyX
486 but the information extracted,
488 is made available with
489 \begin_inset Flex Noun
492 \begin_layout Plain Layout
493 Help\SpecialChar menuseparator
507 \begin_layout Labeling
508 \labelwidthstring 00.00.0000
509 \begin_inset Flex Code
512 \begin_layout Plain Layout
519 \change_deleted 232239728 1604853515
521 \change_inserted 232239728 1604853515
524 he list of text classes that have been found in your
525 \begin_inset Flex Code
528 \begin_layout Plain Layout
535 along with the associated \SpecialChar LaTeX
536 document class and their description.
539 \begin_layout Labeling
540 \labelwidthstring 00.00.0000
541 \begin_inset Flex Code
544 \begin_layout Plain Layout
551 \change_deleted 232239728 1604853518
553 \change_inserted 232239728 1604853518
556 he list of layout modules found in your
557 \begin_inset Flex Code
560 \begin_layout Plain Layout
569 \begin_layout Labeling
570 \labelwidthstring 00.00.0000
571 \begin_inset Flex Code
574 \begin_layout Plain Layout
581 \change_deleted 232239728 1604853523
583 \change_inserted 232239728 1604853523
586 ists of various sorts of \SpecialChar LaTeX
587 -related files found on your system
590 \begin_layout Labeling
591 \labelwidthstring 00.00.0000
592 \begin_inset Flex Code
595 \begin_layout Plain Layout
596 doc/\SpecialChar LaTeX
602 is automatically generated during configuration from the file
603 \begin_inset Flex Code
606 \begin_layout Plain Layout
614 It contains information on your \SpecialChar LaTeX
618 \begin_layout Subsection
622 \begin_layout Standard
624 \change_deleted 5863208 1604928729
628 \change_inserted 5863208 1604928636
632 \change_inserted 5863208 1604928661
636 \begin_inset Flex Code
639 \begin_layout Plain Layout
646 \change_inserted 5863208 1604928662
648 \change_deleted 5863208 1604928642
652 \change_deleted 5863208 1604928669
654 \begin_inset Flex Code
657 \begin_layout Plain Layout
664 \change_inserted 5863208 1604928680
668 \begin_inset Flex Code
671 \begin_layout Plain Layout
679 \change_deleted 232239728 1604794430
682 exists in both places,
684 \begin_inset Flex Code
687 \begin_layout Plain Layout
696 \begin_layout Labeling
697 \labelwidthstring 00.00.0000
698 \begin_inset Flex Code
701 \begin_layout Plain Layout
708 \change_deleted 232239728 1604794460
710 \change_inserted 232239728 1604794460
713 his directory contains files with the extension
714 \begin_inset Flex Code
717 \begin_layout Plain Layout
723 that define the keybindings used in \SpecialChar LyX
725 If there exists an internationalized version of the bind file
726 \change_inserted -712698321 1669371749
728 \change_deleted -712698321 1669371727
730 \begin_inset Flex Code
733 \begin_layout Plain Layout
740 \change_inserted -712698321 1669371728
742 \begin_inset Flex Code
745 \begin_layout Plain Layout
747 \change_inserted -712698321 1669371732
756 \begin_inset Quotes eld
760 \begin_inset Quotes erd
763 is the ISO language code
766 that will be used first.
769 \begin_layout Labeling
770 \labelwidthstring 00.00.0000
771 \begin_inset Flex Code
774 \begin_layout Plain Layout
781 \change_deleted 232239728 1604794478
783 \change_inserted 232239728 1604794478
786 ontains files with the extension
787 \begin_inset Flex Code
790 \begin_layout Plain Layout
796 which define the diverse citation possibilities (natbib,
799 \begin_inset CommandInset ref
801 reference "subsec:Cite-Engine-Files"
812 \begin_layout Labeling
813 \labelwidthstring 00.00.0000
814 \begin_inset Flex Code
817 \begin_layout Plain Layout
824 \change_deleted 232239728 1604794483
826 \change_inserted 232239728 1604794486
829 ontains graphics files that can be included in documents.
833 \begin_layout Labeling
834 \labelwidthstring 00.00.0000
835 \begin_inset Flex Code
838 \begin_layout Plain Layout
845 \change_deleted 232239728 1604794492
847 \change_inserted 232239728 1604794492
850 ontains \SpecialChar LyX
851 documentation files (including the one you are currently reading).
853 \begin_inset Flex Code
856 \begin_layout Plain Layout
858 \change_deleted 232239728 1604794660
861 \change_inserted 232239728 1604794661
869 deserves special attention,
871 The internationalized help docs are in subdirectories
872 \begin_inset Flex Code
875 \begin_layout Plain Layout
882 \begin_inset Quotes eld
886 \begin_inset Quotes erd
889 is the ISO language code.
891 \begin_inset CommandInset ref
893 reference "cha:Internationalizing-LyX"
901 \begin_layout Labeling
902 \labelwidthstring 00.00.0000
903 \begin_inset Flex Code
906 \begin_layout Plain Layout
913 \change_deleted 232239728 1604794497
915 \change_inserted 232239728 1604794497
918 ontains example files that explain how to use some features.
921 \begin_inset Flex Noun
924 \begin_layout Plain Layout
933 \begin_layout Labeling
934 \labelwidthstring 00.00.0000
935 \begin_inset Flex Code
938 \begin_layout Plain Layout
945 \change_deleted 232239728 1604794500
947 \change_inserted 232239728 1604794500
950 ontains image files that are used by the
951 \begin_inset Flex Noun
954 \begin_layout Plain Layout
962 it also contains the individual icons used in the toolbar and the banners that can be shown when \SpecialChar LyX
966 \begin_layout Labeling
967 \labelwidthstring 00.00.0000
968 \begin_inset Flex Code
971 \begin_layout Plain Layout
978 \change_deleted 232239728 1604794505
980 \change_inserted 232239728 1604794505
983 ontains keyboard keymapping files.
985 \begin_inset CommandInset ref
987 reference "sec:International-Keymap-Stuff"
995 \begin_layout Labeling
996 \labelwidthstring 00.00.0000
997 \begin_inset Flex Code
1000 \begin_layout Plain Layout
1007 \change_deleted 232239728 1604794508
1009 \change_inserted 232239728 1604794508
1012 ontains the text class and module files described in
1013 \begin_inset CommandInset ref
1015 reference "cha:Installing-New-Document"
1023 \begin_layout Labeling
1024 \labelwidthstring 00.00.0000
1025 \begin_inset Flex Code
1028 \begin_layout Plain Layout
1035 \change_deleted 232239728 1604794513
1037 \change_inserted 232239728 1604794513
1041 \begin_inset Flex Code
1044 \begin_layout Plain Layout
1050 Python scripts used to convert between \SpecialChar LyX
1052 These can be run from the command line if
1053 \change_deleted 232239728 1604794749
1058 you want to batch-convert files.
1061 \begin_layout Labeling
1062 \labelwidthstring 00.00.0000
1063 \begin_inset Flex Code
1066 \begin_layout Plain Layout
1073 \change_deleted 232239728 1604794516
1075 \change_inserted 232239728 1604794516
1078 ontains some files that demonstrate the capabilities of the
1079 \begin_inset Flex Noun
1082 \begin_layout Plain Layout
1084 \begin_inset space ~
1093 Also contains some scripts used by \SpecialChar LyX
1097 \begin_layout Labeling
1098 \labelwidthstring 00.00.0000
1099 \begin_inset Flex Code
1102 \begin_layout Plain Layout
1109 \change_deleted 232239728 1604794520
1111 \change_inserted 232239728 1604794520
1114 ontains the standard \SpecialChar LyX
1115 template files described in
1116 \begin_inset CommandInset ref
1118 reference "subsec:Creating-Templates"
1126 \begin_layout Labeling
1127 \labelwidthstring 00.00.0000
1128 \begin_inset Flex Code
1131 \begin_layout Plain Layout
1138 \change_deleted 232239728 1604794524
1140 \change_inserted 232239728 1604794524
1143 ontains files with the extension
1144 \begin_inset Flex Code
1147 \begin_layout Plain Layout
1153 that define the user interface to \SpecialChar LyX
1156 the files define which items appear in which menus and the items appearing on the toolbar.
1159 \begin_layout Labeling
1160 \labelwidthstring 00.00.0000
1161 \begin_inset Flex Code
1164 \begin_layout Plain Layout
1171 \change_deleted 232239728 1604794528
1173 \change_inserted 232239728 1604794528
1176 ontains files with the extension
1177 \begin_inset Flex Code
1180 \begin_layout Plain Layout
1186 which define the templates for the insertion of external material to a \SpecialChar LyX
1189 \begin_inset CommandInset ref
1191 reference "chap:Including-External-Material"
1199 \begin_layout Subsection
1200 Files you don't want to modify
1203 \begin_layout Standard
1204 These files are used internally by \SpecialChar LyX
1205 and you generally do not need to modify them unless you are a developer.
1208 \begin_layout Labeling
1209 \labelwidthstring 00.00.0000
1210 \begin_inset Flex Code
1213 \begin_layout Plain Layout
1220 \change_deleted 232239728 1604797616
1222 \change_inserted 232239728 1604797616
1225 his file contains the list of \SpecialChar LyX
1227 The contents are displayed with the menu entry
1228 \begin_inset Flex Noun
1231 \begin_layout Plain Layout
1232 Help\SpecialChar menuseparator
1234 \begin_inset space ~
1245 \begin_layout Labeling
1246 \labelwidthstring 00.00.0000
1247 \begin_inset Flex Code
1250 \begin_layout Plain Layout
1257 \change_deleted 232239728 1604797620
1259 \change_inserted 232239728 1604797620
1262 his is a \SpecialChar LaTeX
1263 script used during the configuration process.
1264 Do not run directly.
1267 \begin_layout Labeling
1268 \labelwidthstring 00.00.0000
1269 \begin_inset Flex Code
1272 \begin_layout Plain Layout
1279 \change_deleted 232239728 1604797624
1281 \change_inserted 232239728 1604797624
1284 his is a Python script that is used to re-configure \SpecialChar LyX
1286 It creates configuration files in the directory it was run from.
1289 \begin_layout Subsection
1290 Other files needing a line or two
1293 \begin_layout Labeling
1294 \labelwidthstring 00.00.0000
1295 \begin_inset Flex Code
1298 \begin_layout Plain Layout
1305 \change_deleted 232239728 1604797580
1307 \change_inserted 232239728 1604797580
1310 his contains tables describing how different character encodings can be mapped to Unicode
1313 \begin_layout Labeling
1314 \labelwidthstring 00.00.0000
1315 \begin_inset Flex Code
1318 \begin_layout Plain Layout
1325 \change_deleted 232239728 1604797584
1327 \change_inserted 232239728 1604797584
1330 his file contains a list of all the languages currently supported by \SpecialChar LyX
1334 \begin_layout Labeling
1335 \labelwidthstring 00.00.0000
1336 \begin_inset Flex Code
1339 \begin_layout Plain Layout
1346 \change_deleted 232239728 1604797587
1348 \change_inserted 232239728 1604797587
1351 ontains information about the supported fonts.
1354 \begin_layout Labeling
1355 \labelwidthstring 00.00.0000
1356 \begin_inset Flex Code
1359 \begin_layout Plain Layout
1366 \change_deleted 232239728 1604797591
1368 \change_inserted 232239728 1604797591
1371 his file contains translations for internationalized paragraph styles (see
1372 \begin_inset CommandInset ref
1374 reference "subsec:I18n"
1382 \begin_layout Labeling
1383 \labelwidthstring 00.00.0000
1384 \begin_inset Flex Code
1387 \begin_layout Plain Layout
1394 \change_deleted 232239728 1604797594
1396 \change_inserted 232239728 1604797594
1399 his file contains information about Unicode-encoded glyphs and the way they are supported by \SpecialChar LyX
1400 via \SpecialChar LaTeX
1404 \begin_layout Section
1405 Your local configuration directory
1408 \begin_layout Standard
1409 Even if you are using \SpecialChar LyX
1410 as an unprivileged user,
1411 you might want to change \SpecialChar LyX
1412 configuration for your own use.
1414 \begin_inset Flex Code
1417 \begin_layout Plain Layout
1423 directory contains all your personal configuration files.
1424 This is the directory described as
1425 \begin_inset Quotes eld
1429 \begin_inset Quotes erd
1433 \begin_inset Flex Noun
1436 \begin_layout Plain Layout
1437 Help\SpecialChar menuseparator
1439 \begin_inset space ~
1448 This directory is used as a mirror of
1449 \begin_inset Flex Code
1452 \begin_layout Plain Layout
1459 which means that every file in
1460 \begin_inset Flex Code
1463 \begin_layout Plain Layout
1469 is a replacement for the corresponding file in
1470 \begin_inset Flex Code
1473 \begin_layout Plain Layout
1480 Any configuration file described in the above sections can be placed either in the system-wide directory,
1481 in which case it will affect all users,
1482 or in your local directory for your own use.
1485 \begin_layout Standard
1486 To make things clearer,
1487 let's provide a few examples:
1490 \begin_layout Itemize
1491 The preferences set in the
1492 \begin_inset Flex Noun
1495 \begin_layout Plain Layout
1496 Tools\SpecialChar menuseparator
1502 dialog are saved to a file
1503 \begin_inset Flex Code
1506 \begin_layout Plain Layout
1513 \begin_inset Flex Code
1516 \begin_layout Plain Layout
1525 \begin_layout Itemize
1526 When you reconfigure using
1527 \begin_inset Flex Noun
1530 \begin_layout Plain Layout
1531 Tools\SpecialChar menuseparator
1540 \begin_inset Flex Code
1543 \begin_layout Plain Layout
1550 and the resulting files are written in your local configuration directory.
1551 This means that any additional text class file that you might have added in
1552 \begin_inset Flex Code
1555 \begin_layout Plain Layout
1561 will be added to the list of classes in the
1562 \begin_inset Flex Noun
1565 \begin_layout Plain Layout
1566 Document\SpecialChar menuseparator
1575 \begin_layout Itemize
1576 If you get some updated documentation from
1577 \change_inserted 232239728 1604798171
1581 ftp site and cannot install it because you do not have sysadmin rights on your system,
1582 you can just copy the files
1583 \change_deleted 232239728 1604798193
1585 \change_inserted 232239728 1604798193
1589 \begin_inset Flex Code
1592 \begin_layout Plain Layout
1598 and the items in the
1599 \begin_inset Flex Noun
1602 \begin_layout Plain Layout
1608 menu will open them!
1611 \begin_layout Section
1612 Running \SpecialChar LyX
1613 with multiple configurations
1616 \begin_layout Standard
1617 The configuration freedom of the local configuration directory may not suffice if you want to have more than one configuration at your disposal.
1620 \change_deleted 232239728 1604798238
1623 use different key bindings or printer settings at different times.
1624 You can achieve this by having several such directories.
1625 You then specify which directory to use at run-time.
1628 \begin_layout Standard
1629 Invoking \SpecialChar LyX
1630 with the command line switch
1631 \begin_inset Flex Code
1634 \begin_layout Plain Layout
1644 instructs the program to read the configuration from that directory,
1645 and not from the default directory.
1646 (You can determine the default directory by running \SpecialChar LyX
1648 \begin_inset Flex Code
1651 \begin_layout Plain Layout
1657 switch.) If the specified directory does not exist,
1659 offers to create it for you,
1660 just like it does for the default directory
1661 \change_deleted 232239728 1604798318
1664 the first time you run the program.
1665 You can modify the configuration options in this additional user directory exactly as you would for the default directory.
1666 These directories are completely independent (but read on).
1667 Note that setting the environment variable
1668 \begin_inset Flex Code
1671 \begin_layout Plain Layout
1677 to some value has exactly the same effect.
1680 \begin_layout Standard
1681 Having several configurations also requires more maintenance:
1682 if you want to add a new layout to
1683 \begin_inset Flex Code
1686 \begin_layout Plain Layout
1692 which you want available from all your configurations,
1693 you must add it to each directory separately.
1694 You can avoid this with the following trick:
1695 after \SpecialChar LyX
1696 creates the additional directory,
1697 most of the subdirectories (see above) are empty.
1698 If you want the new configuration to mirror an existing one,
1699 replace the empty subdirectory with a symbolic link to the matching subdirectory in the existing configuration.
1701 \begin_inset Flex Code
1704 \begin_layout Plain Layout
1712 since it contains a file written by the configuration script (also accessible through
1713 \begin_inset Flex Noun
1716 \begin_layout Plain Layout
1717 Tools\SpecialChar menuseparator
1723 ) which is configuration
1724 \change_deleted 232239728 1604798083
1726 \change_inserted 232239728 1604798100
1732 \begin_layout Chapter
1733 The Preferences dialog
1736 \begin_layout Standard
1737 All options of the preferences dialog are described in the Appendix
1739 The Preferences Dialog
1746 For some options you might find here more details.
1749 \begin_layout Section
1751 \begin_inset CommandInset label
1760 \begin_layout Standard
1761 The first step is to define your file formats if they are not already defined.
1764 \begin_inset Flex Noun
1767 \begin_layout Plain Layout
1768 Tools\SpecialChar menuseparator
1776 \begin_inset Flex Noun
1779 \begin_layout Plain Layout
1780 File Handling\SpecialChar menuseparator
1787 \begin_inset Flex Noun
1790 \begin_layout Plain Layout
1796 button to define your new format.
1798 \begin_inset Flex Noun
1801 \begin_layout Plain Layout
1807 field contains the name used to identify the format in the GUI.
1809 \begin_inset Flex Noun
1812 \begin_layout Plain Layout
1818 is used to identify the format internally.
1819 You will also need to enter a file extension.
1820 These are all required.
1822 \begin_inset Flex Noun
1825 \begin_layout Plain Layout
1831 field is used to provide a keyboard shortcut on the menus.
1834 \begin_inset Flex Noun
1837 \begin_layout Plain Layout
1844 \begin_inset Flex Noun
1847 \begin_layout Plain Layout
1848 Document\SpecialChar menuseparator
1849 View (Other Formats)\SpecialChar menuseparator
1858 \begin_layout Standard
1860 \begin_inset Flex Noun
1863 \begin_layout Plain Layout
1870 \begin_inset Flex Noun
1873 \begin_layout Plain Layout
1881 you might want to use
1882 \begin_inset Flex Noun
1885 \begin_layout Plain Layout
1891 to view PostScript files.
1892 You can enter the command needed to start the program in the corresponding fields.
1893 In defining this command,
1894 you can use the four variables listed in the next section.
1895 The viewer is launched when you view an image in \SpecialChar LyX
1897 \begin_inset Flex Noun
1900 \begin_layout Plain Layout
1901 Document\SpecialChar menuseparator
1908 The editor is for example launched when you right-click on an image and choose
1909 \begin_inset Flex Noun
1912 \begin_layout Plain Layout
1918 in the appearing context menu.
1921 \begin_layout Standard
1923 \begin_inset Flex Noun
1926 \begin_layout Plain Layout
1932 type of a format is optional,
1933 but if it is specified,
1934 it must be unique across all formats.
1935 It is used to detect files of this format from the file contents.
1936 For some important file formats there is no MIME type officially registered with the
1937 \begin_inset CommandInset href
1940 target "http://www.iana.org/assignments/media-types/"
1946 Therefore \SpecialChar LyX
1947 uses the extended list of MIME types as specified by
1948 \begin_inset CommandInset href
1950 name "freedesktop.org"
1951 target "http://www.freedesktop.org/wiki/Specifications/shared-mime-info-spec"
1959 \begin_layout Standard
1961 \begin_inset Flex Noun
1964 \begin_layout Plain Layout
1970 option tells \SpecialChar LyX
1971 that a format is suitable for document export.
1972 If this is set and if a suitable conversion route exists (see
1973 \begin_inset CommandInset ref
1975 reference "sec:Converters"
1981 the format will appear in the
1982 \begin_inset Flex Noun
1985 \begin_layout Plain Layout
1986 File\SpecialChar menuseparator
1993 The format will also appear in the
1994 \begin_inset Flex Noun
1997 \begin_layout Plain Layout
1998 Document\SpecialChar menuseparator
2004 menu if a viewer is specified for the format.
2007 \begin_inset Flex Code
2010 \begin_layout Plain Layout
2017 should not use this option.
2018 Formats that can both represent vector graphics and documents like
2019 \begin_inset Flex Code
2022 \begin_layout Plain Layout
2031 \begin_layout Standard
2033 \begin_inset Flex Noun
2036 \begin_layout Plain Layout
2037 Vector graphics format
2042 tells \SpecialChar LyX
2043 that a format can contain vector graphics.
2044 This information is used to determine the target format of included graphics for
2045 \begin_inset Flex Noun
2048 \begin_layout Plain Layout
2055 Included graphics may need to be converted to either
2056 \begin_inset Flex Noun
2059 \begin_layout Plain Layout
2067 \begin_inset Flex Noun
2070 \begin_layout Plain Layout
2078 \begin_inset Flex Noun
2081 \begin_layout Plain Layout
2089 \begin_inset Flex Noun
2092 \begin_layout Plain Layout
2098 cannot handle other image formats.
2099 If an included graphic is not already in
2100 \begin_inset Flex Noun
2103 \begin_layout Plain Layout
2111 \begin_inset Flex Noun
2114 \begin_layout Plain Layout
2122 \begin_inset Flex Noun
2125 \begin_layout Plain Layout
2133 \begin_inset Flex Noun
2136 \begin_layout Plain Layout
2142 if the vector format option is set,
2144 \begin_inset Flex Noun
2147 \begin_layout Plain Layout
2156 \begin_layout Section
2160 \begin_layout Standard
2161 Since all conversions from one format to another take place in \SpecialChar LyX
2162 's temporary directory,
2163 it is sometimes necessary to modify a file before copying it to the temporary directory in order that the conversion may be performed.
2167 \begin_layout Plain Layout
2169 the file may refer to other files—
2172 using relative file names,
2173 and these may become invalid when the file is copied to the temporary directory.
2178 This is done by a Copier:
2179 It copies a file to (or from) the temporary directory and may modify it in the process.
2182 \begin_layout Standard
2183 The definitions of the copiers may use eight variables:
2186 \begin_layout Labeling
2187 \labelwidthstring 00.00.0000
2188 \begin_inset Flex Code
2191 \begin_layout Plain Layout
2197 The \SpecialChar LyX
2198 system directory (e.
2199 \begin_inset space \thinspace{}
2203 \begin_inset space \space{}
2207 \begin_inset Flex Noun
2210 \begin_layout Plain Layout
2219 \begin_layout Labeling
2220 \labelwidthstring 00.00.0000
2221 \begin_inset Flex Code
2224 \begin_layout Plain Layout
2233 \begin_layout Labeling
2234 \labelwidthstring 00.00.0000
2235 \begin_inset Flex Code
2238 \begin_layout Plain Layout
2247 \begin_layout Labeling
2248 \labelwidthstring 00.00.0000
2249 \begin_inset Flex Code
2252 \begin_layout Plain Layout
2258 The base name (without filename extension) in the \SpecialChar LyX
2262 \begin_layout Labeling
2263 \labelwidthstring 00.00.0000
2264 \begin_inset Flex Code
2267 \begin_layout Plain Layout
2273 The full directory path of the \SpecialChar LyX
2277 \begin_layout Labeling
2278 \labelwidthstring 00.00.0000
2279 \begin_inset Flex Code
2282 \begin_layout Plain Layout
2288 The full pathname to the original \SpecialChar LyX
2289 file being processed
2292 \begin_layout Labeling
2293 \labelwidthstring 00.00.0000
2294 \begin_inset Flex Code
2297 \begin_layout Plain Layout
2303 The filename (without any directory path) of the \SpecialChar LyX
2307 \begin_layout Labeling
2308 \labelwidthstring 00.00.0000
2309 \begin_inset Flex Code
2312 \begin_layout Plain Layout
2318 The `\SpecialChar LaTeX
2322 \begin_layout Standard
2323 The latter should be the filename as it would be used in a \SpecialChar LaTeX
2331 It is relevant only when exporting files suitable for such inclusion.
2334 \begin_layout Standard
2335 Copiers can be used to do almost anything with output files.
2337 suppose you want generated pdf files to be copied to a special directory,
2339 \begin_inset Flex Code
2342 \begin_layout Plain Layout
2349 Then you could write a shell script such as this one:
2352 \begin_layout Standard
2353 \begin_inset listings
2357 \begin_layout Plain Layout
2362 \begin_layout Plain Layout
2367 \begin_layout Plain Layout
2369 TOFILE=`basename $2`
2372 \begin_layout Plain Layout
2374 cp $FROMFILE /home/you/pdf/$TOFILE
2379 Save it in your local \SpecialChar LyX
2383 \begin_inset Flex Code
2386 \begin_layout Plain Layout
2387 /home/you/.lyx/scripts/pdfcopier.sh
2393 and make it executable,
2394 if you need to do so on your platform.
2397 \begin_inset Flex Noun
2400 \begin_layout Plain Layout
2401 Tools\SpecialChar menuseparator
2409 \begin_inset Flex Noun
2412 \begin_layout Plain Layout
2413 File Handling\SpecialChar menuseparator
2420 \begin_inset Flex Noun
2423 \begin_layout Plain Layout
2430 or one of the other pdf formats—
2432 \begin_inset Flex Code
2435 \begin_layout Plain Layout
2436 pdfcopier.sh $$i $$o
2442 \begin_inset Flex Noun
2445 \begin_layout Plain Layout
2455 \begin_layout Standard
2456 Copiers are used by \SpecialChar LyX
2457 in various of its own conversions.
2459 if appropriate programs are found,
2461 will automatically install copiers for the
2462 \begin_inset Flex Noun
2465 \begin_layout Plain Layout
2472 \begin_inset Flex Noun
2475 \begin_layout Plain Layout
2477 \begin_inset space ~
2486 When these formats are exported,
2487 the copier sees that not just the main HTML file but various associated files (style files,
2489 etc.) are also copied.
2490 All these files are written to a subdirectory of the directory in which the original \SpecialChar LyX
2495 \begin_layout Plain Layout
2496 This copier can be customized.
2498 \begin_inset Quotes eld
2502 \begin_inset Quotes erd
2505 argument takes a comma-separated list of extensions to be copied;
2507 all files will be copied.
2509 \begin_inset Quotes eld
2513 \begin_inset Quotes erd
2516 argument determines the extension added to the generated directory.
2519 \begin_inset Quotes eld
2523 \begin_inset Flex Noun
2526 \begin_layout Plain Layout
2533 \begin_inset Quotes erd
2537 so HTML generated from
2538 \begin_inset Flex Noun
2541 \begin_layout Plain Layout
2542 /path/to/filename.lyx
2548 \begin_inset Flex Noun
2551 \begin_layout Plain Layout
2552 /path/to/filename.html.LyXconv
2566 \begin_layout Section
2568 \begin_inset CommandInset label
2570 name "sec:Converters"
2577 \begin_layout Standard
2578 You can define your own Converters to convert files between different formats.
2580 \begin_inset Flex Noun
2583 \begin_layout Plain Layout
2584 Tools\SpecialChar menuseparator
2585 Preferences\SpecialChar menuseparator
2586 File Handling\SpecialChar menuseparator
2595 \begin_layout Standard
2596 To define a new converter,
2598 \begin_inset Flex Noun
2601 \begin_layout Plain Layout
2603 \begin_inset space ~
2612 \begin_inset Flex Noun
2615 \begin_layout Plain Layout
2617 \begin_inset space ~
2625 from the drop-down lists,
2626 enter the command needed for the conversion,
2628 \begin_inset Flex Noun
2631 \begin_layout Plain Layout
2638 Several variables can be used in the definition of converters:
2641 \begin_layout Labeling
2642 \labelwidthstring 00.00.0000
2643 \begin_inset Flex Code
2646 \begin_layout Plain Layout
2652 The \SpecialChar LyX
2656 \begin_layout Labeling
2657 \labelwidthstring 00.00.0000
2658 \begin_inset Flex Code
2661 \begin_layout Plain Layout
2670 \begin_layout Labeling
2671 \labelwidthstring 00.00.0000
2672 \begin_inset Flex Code
2675 \begin_layout Plain Layout
2684 \begin_layout Labeling
2685 \labelwidthstring 00.00.0000
2686 \begin_inset Flex Code
2689 \begin_layout Plain Layout
2695 The base filename of the input file (i.
2696 \begin_inset space \thinspace{}
2700 without the extension)
2703 \begin_layout Labeling
2704 \labelwidthstring 00.00.0000
2705 \begin_inset Flex Code
2708 \begin_layout Plain Layout
2714 The path to the input file
2717 \begin_layout Labeling
2718 \labelwidthstring 00.00.0000
2719 \begin_inset Flex Code
2722 \begin_layout Plain Layout
2728 The path to the original input file (this is different from $$p when a chain of converters is called)
2731 \begin_layout Labeling
2732 \labelwidthstring 00.00.0000
2733 \begin_inset Flex Code
2736 \begin_layout Plain Layout
2742 The iconv name for the encoding of the document.
2745 \begin_layout Standard
2747 \begin_inset Flex Noun
2750 \begin_layout Plain Layout
2752 \begin_inset space ~
2760 field you can enter the following flags,
2761 separated by commas:
2764 \begin_layout Labeling
2765 \labelwidthstring 00.00.0000
2766 \begin_inset Flex Code
2769 \begin_layout Plain Layout
2771 \change_inserted -712698321 1524656940
2779 This converter runs some form of \SpecialChar LaTeX
2781 This will make \SpecialChar LyX
2782 's \SpecialChar LaTeX
2783 error logs available.
2785 \change_inserted -712698321 1524657018
2787 \begin_inset Flex Code
2790 \begin_layout Plain Layout
2792 \change_inserted -712698321 1524657012
2800 value specifies the form of \SpecialChar LaTeX
2802 \begin_inset Flex Code
2805 \begin_layout Plain Layout
2807 \change_inserted -712698321 1524657005
2820 If no value is specified,
2822 \begin_inset Flex Code
2825 \begin_layout Plain Layout
2827 \change_inserted -712698321 1524657018
2840 \begin_layout Labeling
2841 \labelwidthstring 00.00.0000
2843 \change_inserted -712698321 1676553236
2844 \begin_inset Flex Code
2847 \begin_layout Plain Layout
2849 \change_inserted -712698321 1676552303
2857 This converter is considered non-safe and needs authorization by the user.
2858 Depending on the settings in
2860 Tools\SpecialChar menuseparator
2861 Preferences\SpecialChar menuseparator
2862 File Handling\SpecialChar menuseparator
2866 users will (a.) be asked whether they trust the current document temporarily,
2869 (b.) be informed that conversion is not possible due to security concerns,
2870 or (c.) not be informed as they gave permanent consent.
2871 Set this flag for converters that might execute arbitrary programs.
2874 \begin_layout Labeling
2875 \labelwidthstring 00.00.0000
2876 \begin_inset Flex Code
2879 \begin_layout Plain Layout
2881 \change_inserted -712698321 1524656935
2889 Needs the \SpecialChar LaTeX
2891 \begin_inset Flex Noun
2894 \begin_layout Plain Layout
2900 file for the conversion.
2902 \change_inserted -712698321 1524657047
2904 \begin_inset Flex Code
2907 \begin_layout Plain Layout
2909 \change_inserted -712698321 1524657030
2917 value specifies the form of \SpecialChar LaTeX
2918 that is run in order to generate the
2919 \begin_inset Flex Noun
2922 \begin_layout Plain Layout
2924 \change_inserted -712698321 1524657047
2933 \begin_inset Flex Code
2936 \begin_layout Plain Layout
2938 \change_inserted -712698321 1524657030
2951 If no value is specified,
2953 \begin_inset Flex Code
2956 \begin_layout Plain Layout
2958 \change_inserted -712698321 1524657030
2971 \begin_layout Labeling
2972 \labelwidthstring 00.00.0000
2973 \begin_inset Flex Code
2976 \begin_layout Plain Layout
2983 \begin_inset Quotes eld
2987 \begin_inset Quotes erd
2990 file from the backend,
2991 which in practice means a \SpecialChar LaTeX
2992 file like the one we would export,
2994 \begin_inset Flex Code
2997 \begin_layout Plain Layout
3006 \begin_layout Labeling
3007 \labelwidthstring 00.00.0000
3008 \begin_inset Flex Code
3011 \begin_layout Plain Layout
3020 \begin_layout Standard
3021 The following three flags are not really flags at all because they take an argument in the
3022 \begin_inset Flex Noun
3025 \begin_layout Plain Layout
3027 \begin_inset space ~
3031 \begin_inset space ~
3042 \begin_layout Labeling
3043 \labelwidthstring 00.00.0000
3045 \change_inserted -712698321 1523206314
3046 \begin_inset Flex Code
3049 \begin_layout Plain Layout
3051 \change_inserted -712698321 1523206193
3059 The name of the driver that needs to be loaded with the
3063 package for this converter.
3064 The loading of the correct driver is necessary to get some PDF-specific features.
3072 \begin_layout Labeling
3073 \labelwidthstring 00.00.0000
3074 \begin_inset Flex Code
3077 \begin_layout Plain Layout
3084 the converter's standard error will be redirected to a file
3085 \begin_inset Flex Code
3088 \begin_layout Plain Layout
3095 and the script given as argument will be run as:
3097 \begin_inset Flex Code
3100 \begin_layout Plain Layout
3101 script < infile.out > infile.log
3107 The argument may contain
3108 \begin_inset Flex Code
3111 \begin_layout Plain Layout
3120 \begin_layout Labeling
3121 \labelwidthstring 00.00.0000
3122 \begin_inset Flex Code
3125 \begin_layout Plain Layout
3131 The name of the directory in which the converter will dump the generated files.
3133 will not create this directory,
3134 and it does not copy anything into it,
3135 though it will copy this directory to the destination.
3136 The argument may contain
3137 \begin_inset Flex Code
3140 \begin_layout Plain Layout
3147 which will be replaced by the base name of the input and output files,
3149 when the directory is copied.
3150 \begin_inset Newline newline
3153 Note that resultdir and usetempdir make no sense together.
3154 The latter will be ignored if the former is given.
3157 \begin_layout Labeling
3158 \labelwidthstring 00.00.0000
3159 \begin_inset Flex Code
3162 \begin_layout Plain Layout
3168 Determines the output file name and may,
3170 \begin_inset Flex Code
3173 \begin_layout Plain Layout
3180 Sensible only with resultdir and optional even then;
3182 it defaults to `index'.
3185 \begin_layout Standard
3187 \change_inserted -712698321 1523206384
3188 A suitable hyperref-driver is set for some converters that are installed with \SpecialChar LyX
3191 \change_deleted -712698321 1523206388
3193 \change_inserted -712698321 1523206389
3197 \change_inserted -712698321 1523206400
3203 \change_inserted -712698321 1523206407
3207 \change_inserted -712698321 1523206437
3211 \change_deleted -712698321 1523206442
3212 that are installed with \SpecialChar LyX
3219 \begin_layout Standard
3220 You do not have to define converters for all formats between which you want to convert.
3222 you will note that there is no `\SpecialChar LyX
3223 to PostScript' converter,
3224 but \SpecialChar LyX
3225 will export PostScript.
3226 It does so by first creating a \SpecialChar LaTeX
3227 file (no converter needs to be defined for this) which is then converted to DVI using the `\SpecialChar LaTeX
3229 and finally converting the resulting DVI file to PostScript.
3231 finds such `chains' of converters automatically,
3232 and it will always choose the shortest possible chain.
3235 still define multiple conversion methods between file formats.
3237 the standard \SpecialChar LyX
3238 configuration provides five ways to convert \SpecialChar LaTeX
3242 \begin_layout Enumerate
3245 \begin_inset Flex Noun
3248 \begin_layout Plain Layout
3257 \begin_layout Enumerate
3258 via (DVI and) PostScript,
3260 \begin_inset Flex Noun
3263 \begin_layout Plain Layout
3272 \begin_layout Enumerate
3275 \begin_inset Flex Noun
3278 \begin_layout Plain Layout
3287 \begin_layout Enumerate
3289 \begin_inset Flex Noun
3292 \begin_layout Plain Layout
3302 \begin_layout Enumerate
3304 \begin_inset Flex Noun
3307 \begin_layout Plain Layout
3317 \begin_layout Standard
3318 To define such alternate chains,
3319 you must define multiple target `file formats',
3321 \begin_inset CommandInset ref
3323 reference "sec:Formats"
3330 in the standard configuration,
3332 \begin_inset Flex Noun
3335 \begin_layout Plain Layout
3342 \begin_inset Flex Noun
3345 \begin_layout Plain Layout
3353 \begin_inset Flex Noun
3356 \begin_layout Plain Layout
3363 \begin_inset Flex Noun
3366 \begin_layout Plain Layout
3374 \begin_inset Flex Noun
3377 \begin_layout Plain Layout
3384 \begin_inset Flex Noun
3387 \begin_layout Plain Layout
3395 \begin_inset Flex Noun
3398 \begin_layout Plain Layout
3405 \begin_inset Flex Noun
3408 \begin_layout Plain Layout
3417 \begin_inset Flex Noun
3420 \begin_layout Plain Layout
3427 \begin_inset Flex Noun
3430 \begin_layout Plain Layout
3438 all of which share the extension
3439 \begin_inset Flex Noun
3442 \begin_layout Plain Layout
3449 and which correspond to the conversion methods just mentioned.
3452 \begin_layout Chapter
3453 Internationalizing \SpecialChar LyX
3455 \begin_inset CommandInset label
3457 name "cha:Internationalizing-LyX"
3464 \begin_layout Standard
3466 supports using a translated interface.
3467 Last time we checked,
3469 provided text in thirty languages.
3470 The language of choice is called your
3475 (For further reading on locale settings,
3476 see also the documentation for locale that comes with your operating system.
3479 \begin_inset Flex Code
3482 \begin_layout Plain Layout
3488 could be a good place to start).
3491 \begin_layout Standard
3492 Notice that these translations will work,
3493 but do contain a few flaws.
3495 all dialogs have been designed with the English text in mind,
3496 which means that some of the translated text will be too large to fit within the space allocated.
3497 This is only a display problem and will not cause any harm.
3499 you will find that some of the translations do not define shortcut keys for everything.
3501 there are simply not enough free letters to do it.
3503 the translator just hasn't got around to doing it yet.
3504 Our localization team,
3505 which you may wish to join,
3509 \begin_layout Plain Layout
3510 If you are a fluent speaker of a language other than English,
3511 joining these teams is a great way to give back to the \SpecialChar LyX
3517 will of course try to fix these shortcomings in future versions of \SpecialChar LyX
3521 \begin_layout Section
3522 Translating \SpecialChar LyX
3526 \begin_layout Subsection
3527 Translating the graphical user interface (text messages).
3530 \begin_layout Standard
3533 \begin_inset Flex Code
3536 \begin_layout Plain Layout
3542 library to handle the internationalization of the interface.
3543 To have \SpecialChar LyX
3544 speak your favorite language in all menus and dialogs,
3546 \begin_inset Flex Code
3549 \begin_layout Plain Layout
3555 -file for that language.
3556 When this is available,
3557 you'll have to generate a
3558 \begin_inset Flex Code
3561 \begin_layout Plain Layout
3567 -file from it and install the
3568 \begin_inset Flex Code
3571 \begin_layout Plain Layout
3578 The process of doing all of this is explained in the documentation for GNU
3579 \begin_inset Flex Code
3582 \begin_layout Plain Layout
3589 It is possible to do this just for yourself,
3590 but if you're going to do it,
3591 you might as well share the results of your labors with the rest of the \SpecialChar LyX
3593 Send a message to the \SpecialChar LyX
3594 developers' list for more information about how to proceed.
3597 \begin_layout Standard
3599 this is what you should do (xx denotes the language code):
3602 \begin_layout Itemize
3603 Check out the \SpecialChar LyX
3606 \begin_inset CommandInset href
3608 name "information on the web"
3609 target "https://www.lyx.org/HowToUseGIT"
3617 \begin_layout Itemize
3619 \begin_inset Flex Code
3622 \begin_layout Plain Layout
3628 to the folder of the
3629 \begin_inset Flex Code
3632 \begin_layout Plain Layout
3640 \begin_inset Flex Code
3643 \begin_layout Plain Layout
3651 \begin_inset Flex Code
3654 \begin_layout Plain Layout
3660 doesn't exist anywhere,
3661 it can be remade with the console command
3662 \begin_inset Flex Code
3665 \begin_layout Plain Layout
3672 or you can use an existing po-file for some other language as a template).
3675 \begin_layout Itemize
3677 \begin_inset Flex Code
3680 \begin_layout Plain Layout
3690 \begin_layout Plain Layout
3691 This is just a text file,
3692 so it can be edited in any text editor.
3693 But there are also specialized programs that support such editing,
3698 (for all platforms) or
3707 contains a `mode' for editing
3708 \begin_inset Flex Code
3711 \begin_layout Plain Layout
3720 \begin_inset Flex URL
3723 \begin_layout Plain Layout
3725 https://www.gnu.org/software/gettext/manual/html_node/PO-Mode.html#PO-Mode
3735 For some menu- and widget-labels,
3736 there are also shortcut keys that should be translated.
3737 Those keys are marked after a `|',
3738 and should be translated according to the words and phrases of the language.
3739 You should also fill also out the information at the beginning of the new
3740 \begin_inset Flex Code
3743 \begin_layout Plain Layout
3749 -file with your email-address,
3751 so people know where to reach you with suggestions and entertaining flames.
3754 \begin_layout Standard
3755 If you are just doing this on your own,
3759 \begin_layout Itemize
3761 \begin_inset Flex Code
3764 \begin_layout Plain Layout
3771 This can be done with
3772 \begin_inset Flex Code
3775 \begin_layout Plain Layout
3776 msgfmt -o xx.mo < xx.po
3784 \begin_layout Itemize
3786 \begin_inset Flex Code
3789 \begin_layout Plain Layout
3795 -file to your locale-tree,
3796 at the correct directory for application messages for the language
3802 \begin_inset Flex Code
3805 \begin_layout Plain Layout
3812 \begin_inset space \thinspace{}
3816 \begin_inset space \space{}
3820 \begin_inset Flex Code
3823 \begin_layout Plain Layout
3824 /usr/local/share/locale/xx/LC_MESSAGES/lyx.mo
3834 \begin_layout Standard
3837 it would be best if the new
3838 \begin_inset Flex Code
3841 \begin_layout Plain Layout
3847 file could be added to the \SpecialChar LyX
3849 so others can use it.
3850 Adding it involves making additional changes to \SpecialChar LyX
3852 So send an email to the developers' mailing list if you're interested in doing that.
3855 \begin_layout Subsubsection
3859 \begin_layout Standard
3860 Sometimes it turns out that one English message needs to be translated into different messages in the target language.
3861 One example is the message
3862 \begin_inset Flex Code
3865 \begin_layout Plain Layout
3871 which has the German translation
3880 depending upon exactly what the English
3881 \begin_inset Quotes eld
3885 \begin_inset Quotes erd
3890 \begin_inset Flex Code
3893 \begin_layout Plain Layout
3899 does not handle such ambiguous translations.
3900 Therefore you have to add some context information to the message:
3902 \begin_inset Flex Code
3905 \begin_layout Plain Layout
3912 \begin_inset Flex Code
3915 \begin_layout Plain Layout
3916 To[[as in 'From format x to format y']]
3922 \begin_inset Flex Code
3925 \begin_layout Plain Layout
3926 To[[as in 'From page x to page y']].
3931 Now the two occurrences of
3932 \begin_inset Flex Code
3935 \begin_layout Plain Layout
3942 \begin_inset Flex Code
3945 \begin_layout Plain Layout
3951 and can be translated correctly to
3963 \begin_layout Standard
3964 Of course the context information needs to be stripped off the original message when no translation is used.
3965 Therefore you have to put it in double square brackets at the end of the message (see the example above).
3966 The translation mechanism of \SpecialChar LyX
3967 ensures that everything in double square brackets at the end of messages is removed before displaying the message.
3970 \begin_layout Subsection
3971 Translating the documentation.
3974 \begin_layout Standard
3975 The online documentation (in the
3976 \begin_inset Flex Noun
3979 \begin_layout Plain Layout
3985 -menu) can (and should!) be translated.
3986 If there are translated versions of the documentation available
3990 \begin_layout Plain Layout
3992 at least some of the documents have been translated into fourteen languages,
3993 with the Tutorial available in a few more.
3998 and the locale is set accordingly,
3999 these will be used automagically by \SpecialChar LyX
4002 looks for translated versions as
4003 \begin_inset Flex Code
4006 \begin_layout Plain Layout
4007 LyXDir/doc/xx/DocName.lyx
4014 \begin_inset Flex Code
4017 \begin_layout Plain Layout
4023 is the code for the language currently in use.
4024 If there are no translated documents,
4025 the default English versions will be displayed.
4026 Note that the translated versions must have the same filenames (
4027 \begin_inset Flex Code
4030 \begin_layout Plain Layout
4036 above) as the original.
4037 If you feel up to translating the documentation (an excellent way to proof-read the original documentation by the way!),
4038 there are a few things you should do right away:
4041 \begin_layout Itemize
4042 Check out the documentation translation web page at
4043 \begin_inset CommandInset href
4045 name "https://www.lyx.org/Translation"
4046 target "https://www.lyx.org/Translation"
4053 you can find out which (if any) documents have already been translated into your language.
4054 You can also find out who (if anyone) is organizing the effort to translate the documentation into your language.
4055 If no one is organizing the effort,
4056 please let us know that you're interested.
4059 \begin_layout Standard
4060 Once you get to actually translating,
4061 here's a few hints for you that may save you trouble:
4064 \begin_layout Itemize
4065 Join the documentation team!
4066 There is information on how to do that in
4067 \begin_inset Flex Code
4070 \begin_layout Plain Layout
4077 \begin_inset Flex Noun
4080 \begin_layout Plain Layout
4081 Help\SpecialChar menuseparator
4088 which by the way is the first document you should translate.
4091 \begin_layout Itemize
4092 Learn the typographic conventions for the language you are translating to.
4093 Typography is an ancient art and over the centuries,
4094 a great variety of conventions have developed throughout different parts of the world.
4095 Also study the professional terminology amongst typographers in your country.
4096 Inventing your own terminology will only confuse the users.
4100 Typography is addictive!)
4103 \begin_layout Itemize
4104 Make a copy of the document.
4105 This will be your working copy.
4106 You can use this as your personal translated help-file by placing it in your
4107 \begin_inset Flex Code
4110 \begin_layout Plain Layout
4117 \begin_inset Note Greyedout
4120 \begin_layout Plain Layout
4126 For a complex document with external material (images,
4128 if you make a copy e.
4129 \begin_inset space \thinspace{}
4133 \begin_inset space \space{}
4137 beware that the links to external material may be broken when the document is moved to a different place.
4138 The best way is to retrieve the \SpecialChar LyX
4140 \begin_inset Flex URL
4143 \begin_layout Plain Layout
4145 https://www.lyx.org/HowToUseGIT
4150 ) and to edit the doc file in place.
4158 \begin_layout Itemize
4159 Sometimes the original document (from the \SpecialChar LyX
4160 team) will be updated.
4161 Use the source viewer at
4162 \begin_inset CommandInset href
4164 name "https://www.lyx.org/trac/timeline"
4165 target "https://www.lyx.org/trac/timeline"
4170 to see what has been changed.
4171 That way you can easily see which parts of the translated document need to be updated.
4174 \begin_layout Standard
4175 If you ever find an error in the original document,
4176 fix it and notify the rest of the documentation team of the changes!
4177 (You didn't forget to join the documentation team,
4181 \begin_layout Standard
4182 \begin_inset Branch OutDated
4186 \begin_layout Section
4187 International Keyboard Support
4190 \begin_layout Standard
4194 The following section is by
4202 It needs to be fixed to conform to the new Documentation Style sheet and to make use of the new v1.0 features.
4203 The whole thing also needs to be merged with the section following it.-jw It may also be badly out of date.-rh (2008)]
4206 \begin_layout Subsection
4207 Defining Own Keymaps:
4211 \begin_layout Standard
4212 Let's look at a keyboard definition file a little closer.
4213 It is a plain text file defining
4216 \begin_layout Itemize
4217 key-to-key or key-to-string translations
4220 \begin_layout Itemize
4224 \begin_layout Itemize
4225 dead keys exceptions
4228 \begin_layout Standard
4229 To define key-to-key or key-to-string translation,
4233 \begin_layout Quotation
4234 \begin_inset Flex Code
4237 \begin_layout Plain Layout
4246 \begin_inset Flex Code
4249 \begin_layout Plain Layout
4258 \begin_layout Standard
4260 \begin_inset Flex Code
4263 \begin_layout Plain Layout
4269 is the key to be translated and
4270 \begin_inset Flex Code
4273 \begin_layout Plain Layout
4279 is the string to be inserted into the document.
4280 To define dead keys,
4284 \begin_layout Quotation
4285 \begin_inset Flex Code
4288 \begin_layout Plain Layout
4297 \begin_inset Flex Code
4300 \begin_layout Plain Layout
4309 \begin_layout Standard
4311 \begin_inset Flex Code
4314 \begin_layout Plain Layout
4320 is a keyboard key and
4321 \begin_inset Flex Code
4324 \begin_layout Plain Layout
4331 The following dead keys are supported (shortcut name is in parentheses):
4334 \begin_layout Quotation
4338 \begin_inset space \hfill{}
4344 \begin_layout Quotation
4346 \begin_inset space \hfill{}
4352 \begin_layout Quotation
4354 \begin_inset space \hfill{}
4360 \begin_layout Quotation
4362 \begin_inset space \hfill{}
4368 \begin_layout Quotation
4370 \begin_inset space \hfill{}
4376 \begin_layout Quotation
4378 \begin_inset space \hfill{}
4385 \begin_layout Plain Layout
4397 \begin_layout Quotation
4399 \begin_inset space \hfill{}
4405 \begin_layout Quotation
4407 \begin_inset space \hfill{}
4414 \begin_layout Plain Layout
4426 \begin_layout Quotation
4428 \begin_inset space \hfill{}
4434 \begin_layout Quotation
4436 \begin_inset space \hfill{}
4442 \begin_layout Quotation
4444 \begin_inset space \hfill{}
4451 \begin_layout Plain Layout
4463 \begin_layout Quotation
4465 \begin_inset space \hfill{}
4472 \begin_layout Plain Layout
4484 \begin_layout Quotation
4486 \begin_inset space \hfill{}
4492 \begin_layout Quotation
4493 hungarian umlaut (hug)
4494 \begin_inset space \hfill{}
4500 \begin_layout Quotation
4502 \begin_inset space \hfill{}
4508 \begin_layout Quotation
4510 \begin_inset space \hfill{}
4517 \begin_layout Plain Layout
4529 \begin_layout Standard
4530 Since in many international keyboards there are exceptions to what some dead keys should do,
4531 you can define them using
4534 \begin_layout Quotation
4535 \begin_inset Flex Code
4538 \begin_layout Plain Layout
4546 deadkey key outstring
4549 \begin_layout Standard
4552 if you enter caron-o,
4553 it generates circumflex-o,
4557 \begin_layout Quotation
4558 \begin_inset Flex Code
4561 \begin_layout Plain Layout
4574 \begin_layout Standard
4575 to make it work correctly.
4577 you have to define as exceptions dead keys over i and j,
4578 to remove the dot from them before inserting an accent mark.
4579 I will change this when the time comes,
4580 but so far I haven't had time.
4583 \begin_layout Standard
4585 and about characters:
4586 backslash is escaped,
4588 you'll need double backslash.
4591 \begin_inset Flex Code
4594 \begin_layout Plain Layout
4600 have different meaning.
4602 \begin_inset Flex Code
4605 \begin_layout Plain Layout
4612 quotes start and end \SpecialChar LaTeX
4616 \begin_inset Flex Code
4619 \begin_layout Plain Layout
4629 \begin_inset Flex Code
4632 \begin_layout Plain Layout
4640 \begin_inset Flex Code
4643 \begin_layout Plain Layout
4654 \begin_layout Standard
4655 If you make a keyboard description file that works for your language,
4656 please mail it to me,
4657 so I can include it in the next keymap distribution.
4660 \begin_layout Standard
4661 More keywords will be supported in keymap configuration file in future,
4665 \begin_layout Itemize
4666 \begin_inset Flex Code
4669 \begin_layout Plain Layout
4680 \begin_inset space \hfill{}
4684 \begin_inset Flex Code
4687 \begin_layout Plain Layout
4696 \begin_layout Itemize
4697 \begin_inset Flex Code
4700 \begin_layout Plain Layout
4711 \begin_inset space \hfill{}
4715 \begin_inset Flex Code
4718 \begin_layout Plain Layout
4724 an external keymap translation program
4727 \begin_layout Standard
4730 \begin_inset Flex Code
4733 \begin_layout Plain Layout
4742 \begin_inset Flex Code
4745 \begin_layout Plain Layout
4753 option to include default keyboard).
4761 \begin_layout Section
4762 International Keymap Stuff
4763 \begin_inset CommandInset label
4765 name "sec:International-Keymap-Stuff"
4772 \begin_layout Standard
4773 \begin_inset Note Note
4776 \begin_layout Plain Layout
4777 In doing the revisions on this document in March 2008,
4778 I did not look over this stuff,
4779 as I do not understand it.
4780 It would be good if someone else could do so.
4789 \begin_layout Standard
4790 The next two sections describe the
4791 \begin_inset Flex Code
4794 \begin_layout Plain Layout
4803 \begin_inset Flex Code
4806 \begin_layout Plain Layout
4814 file syntax in detail.
4815 These sections should help you design your own key map if the ones provided do not meet your needs.
4818 \begin_layout Subsection
4822 \begin_layout Standard
4826 \begin_inset Flex Code
4829 \begin_layout Plain Layout
4835 file maps keystrokes to characters or strings.
4836 As the name suggests,
4837 it sets a keyboard mapping.
4839 \begin_inset Flex Code
4842 \begin_layout Plain Layout
4853 \begin_inset Flex Code
4856 \begin_layout Plain Layout
4872 \begin_inset Flex Code
4875 \begin_layout Plain Layout
4889 \begin_inset Flex Code
4892 \begin_layout Plain Layout
4902 \begin_inset Flex Code
4905 \begin_layout Plain Layout
4913 are described in this section.
4916 \begin_layout Labeling
4917 \labelwidthstring 00.00.0000
4918 \begin_inset Flex Code
4921 \begin_layout Plain Layout
4929 Map a character to a string
4932 \begin_layout LyX-Code
4947 \begin_layout Standard
4981 the double-quote (")
4998 must be escaped with a preceding backslash (
5009 \begin_layout Standard
5011 \begin_inset Flex Noun
5014 \begin_layout Plain Layout
5022 statement to cause the symbol
5023 \begin_inset Flex Noun
5026 \begin_layout Plain Layout
5034 to be output for the keystroke
5035 \begin_inset Flex Noun
5038 \begin_layout Plain Layout
5049 \begin_layout LyX-Code
5055 \begin_layout Labeling
5056 \labelwidthstring 00.00.0000
5057 \begin_inset Flex Code
5060 \begin_layout Plain Layout
5068 Specify an accent character
5071 \begin_layout LyX-Code
5080 \begin_layout Standard
5081 This will make the cha
5119 This is the dead key
5123 \begin_layout Plain Layout
5130 refers to a key that does not produce a character by itself,
5131 but when followed with another key,
5132 produces the desired accent character.
5136 r with an umlaut like
5146 can be produced in this manner.
5155 \begin_layout Standard
5168 and then another key not in
5186 followed by the other,
5192 \begin_inset Flex Noun
5195 \begin_layout Plain Layout
5215 \begin_inset Flex Noun
5218 \begin_layout Plain Layout
5228 the cursor will not go one position backwards but will instead cancel the effect t
5243 might have had on the next keystroke.
5247 \begin_layout Standard
5248 The following example specifies that the character ' is to be an acute accent,
5249 allowed on the characters a,
5261 \begin_layout LyX-Code
5264 kmod ' acute aeiouAEIOU
5267 \begin_layout Labeling
5268 \labelwidthstring 00.00.0000
5269 \begin_inset Flex Code
5272 \begin_layout Plain Layout
5278 Specify an exception to the accent character
5281 \begin_layout LyX-Code
5290 \begin_layout Standard
5291 This defines an exce
5332 have been assigned a keystroke with a previous
5335 \begin_inset Flex Code
5338 \begin_layout Plain Layout
5362 must not belong in the
5410 If such a declaration does not exist in
5418 \begin_inset Flex Code
5421 \begin_layout Plain Layout
5456 \begin_inset Flex Code
5459 \begin_layout Plain Layout
5473 \begin_layout Standard
5474 The following command produces causes äi to be produced when you enter acute-i ('i):
5477 \begin_layout LyX-Code
5491 \begin_layout Labeling
5492 \labelwidthstring 00.00.0000
5493 \begin_inset Flex Code
5496 \begin_layout Plain Layout
5502 Combine two accent characters
5505 \begin_layout LyX-Code
5511 accent1 accent2 allowed
5514 \begin_layout Standard
5515 This one is getting pretty esoteric.
5516 It allows you to combine the effect
5572 \begin_inset Flex Code
5575 \begin_layout Plain Layout
5603 \begin_layout Standard
5604 Consider this example from the
5605 \begin_inset Flex Code
5608 \begin_layout Plain Layout
5619 \begin_layout LyX-Code
5623 acute aeioyvhAEIOYVH
5628 kcomb acute umlaut iyIY
5631 \begin_layout Standard
5632 This allows you to press
5633 \begin_inset Flex Noun
5636 \begin_layout Plain Layout
5644 and get the effect of
5645 \begin_inset Flex Code
5648 \begin_layout Plain Layout
5667 in this case cancels the last dead key,
5669 \begin_inset Flex Noun
5672 \begin_layout Plain Layout
5682 \begin_inset Flex Code
5685 \begin_layout Plain Layout
5698 \begin_layout Subsection
5702 \begin_layout Standard
5704 \begin_inset Flex Code
5707 \begin_layout Plain Layout
5715 mapping is performed,
5717 \begin_inset Flex Code
5720 \begin_layout Plain Layout
5730 file maps the strings that the symbols generate to characters in the current font.
5731 The \SpecialChar LyX
5732 distribution currently includes at least the
5733 \begin_inset Flex Code
5736 \begin_layout Plain Layout
5745 \begin_inset Flex Code
5748 \begin_layout Plain Layout
5759 \begin_layout Standard
5761 \begin_inset Flex Code
5764 \begin_layout Plain Layout
5772 file is a sequence of declarations of the form
5775 \begin_layout LyX-Code
5788 \begin_layout Standard
5791 \begin_inset Flex Noun
5794 \begin_layout Plain Layout
5804 to the corresponding character in the iso-8859-1 set (233),
5805 the following declaration is used
5808 \begin_layout LyX-Code
5816 \begin_layout Standard
5818 \begin_inset Flex Code
5821 \begin_layout Plain Layout
5830 \begin_inset Flex Code
5833 \begin_layout Plain Layout
5851 the same character can apply to more than one string.
5853 \begin_inset Flex Code
5856 \begin_layout Plain Layout
5867 \begin_layout LyX-Code
5879 \begin_inset Newline newline
5895 \begin_layout Standard
5897 cannot find a mapping for the string produced by the keystroke or a deadkey sequence,
5898 it will check if it looks like an accented char and try to draw an accent over the character on screen.
5901 \begin_layout Subsection
5905 \begin_layout Standard
5906 There is a second way to add support for international characters through so-called dead-keys.
5907 A dead-key works in combination with a letter to produce an accented character.
5909 we'll explain how to create a really simple dead-key to illustrate how they work.
5912 \begin_layout Standard
5913 Suppose you happen to need the circumflex character,
5915 \begin_inset Quotes eld
5919 \begin_inset Quotes erd
5924 \begin_inset Flex Noun
5927 \begin_layout Plain Layout
5934 \begin_inset space ~
5938 \begin_inset Flex Noun
5941 \begin_layout Plain Layout
5947 ] to the \SpecialChar LyX
5949 \begin_inset Flex Code
5952 \begin_layout Plain Layout
5959 \begin_inset Flex Code
5962 \begin_layout Plain Layout
5970 whenever you type the
5971 \begin_inset Flex Noun
5974 \begin_layout Plain Layout
5980 -key followed by a letter,
5981 that letter will have a circumflex accent on it.
5984 \begin_inset Quotes eld
5988 \begin_inset Flex Noun
5991 \begin_layout Plain Layout
5998 \begin_inset Quotes erd
6001 produces the letter:
6003 \begin_inset Quotes eld
6007 \begin_inset Quotes erd
6011 If you tried to type
6012 \begin_inset Quotes eld
6016 \begin_inset Flex Noun
6019 \begin_layout Plain Layout
6026 \begin_inset Quotes erd
6032 will complain with a beep,
6034 \begin_inset Quotes eld
6038 \begin_inset Flex Noun
6041 \begin_layout Plain Layout
6048 \begin_inset Quotes erd
6051 never takes a circumflex accent.
6053 \begin_inset Flex Noun
6056 \begin_layout Plain Layout
6062 after a dead-key produces the bare-accent.
6063 Please note this last point!
6064 If you bind a key to a dead-key,
6065 you'll need to rebind the character on that key to yet another key.
6067 \begin_inset Flex Noun
6070 \begin_layout Plain Layout
6076 to a cedilla is a bad idea,
6077 since you'll only get cedillas instead of commas.
6080 \begin_layout Standard
6081 One common way to bind dead-keys is to use
6082 \begin_inset Flex Noun
6085 \begin_layout Plain Layout
6093 \begin_inset Flex Noun
6096 \begin_layout Plain Layout
6104 \begin_inset Flex Noun
6107 \begin_layout Plain Layout
6113 in combination with an accent,
6115 \begin_inset Quotes eld
6119 \begin_inset Flex Noun
6122 \begin_layout Plain Layout
6129 \begin_inset Quotes erd
6133 \begin_inset Quotes eld
6137 \begin_inset Flex Noun
6140 \begin_layout Plain Layout
6147 \begin_inset Quotes erd
6151 \begin_inset Quotes eld
6155 \begin_inset Flex Noun
6158 \begin_layout Plain Layout
6165 \begin_inset Quotes erd
6169 Another way involves using
6170 \begin_inset Flex Code
6173 \begin_layout Plain Layout
6180 \begin_inset Flex Code
6183 \begin_layout Plain Layout
6189 to set up the special
6190 \begin_inset Flex Code
6193 \begin_layout Plain Layout
6201 \begin_inset Flex Code
6204 \begin_layout Plain Layout
6210 acts in some ways just like
6211 \begin_inset Flex Noun
6214 \begin_layout Plain Layout
6220 and permits you to bind keys to accented characters.
6221 You can also turn keys into dead-keys by binding them to something like
6222 \begin_inset Flex Code
6225 \begin_layout Plain Layout
6231 and then binding this symbolic key to the corresponding \SpecialChar LyX
6236 \begin_layout Plain Layout
6242 This is exactly what I do in my
6243 \begin_inset Flex Code
6246 \begin_layout Plain Layout
6253 \begin_inset Flex Code
6256 \begin_layout Plain Layout
6264 \begin_inset Flex Noun
6267 \begin_layout Plain Layout
6269 \begin_inset space ~
6278 \begin_inset Flex Code
6281 \begin_layout Plain Layout
6287 and a bunch of these
6288 \begin_inset Quotes eld
6292 \begin_inset Flex Code
6295 \begin_layout Plain Layout
6302 \begin_inset Quotes erd
6305 symbolic keys bound such things as
6306 \begin_inset Flex Noun
6309 \begin_layout Plain Layout
6311 \begin_inset space ~
6320 \begin_inset Flex Noun
6323 \begin_layout Plain Layout
6325 \begin_inset space ~
6334 This is how I produce my accented characters.
6339 You can make just about anything into the
6340 \begin_inset Flex Code
6343 \begin_layout Plain Layout
6351 \begin_inset Flex Noun
6354 \begin_layout Plain Layout
6361 a spare function key,
6363 As for the \SpecialChar LyX
6364 commands that produce accents,
6366 \begin_inset Flex Code
6369 \begin_layout Plain Layout
6380 You'll find the complete list there.
6383 \begin_layout Subsection
6384 Saving your Language Configuration
6387 \begin_layout Standard
6388 You can edit your preferences so that your desired language environment is automatically configured when \SpecialChar LyX
6391 \begin_inset Flex Noun
6394 \begin_layout Plain Layout
6395 Edit\SpecialChar menuseparator
6404 \begin_layout Chapter
6406 \change_inserted -584632292 1610232084
6409 Installing New Document Classes,
6412 \begin_inset CommandInset label
6414 name "cha:Installing-New-Document"
6419 \begin_inset Argument 1
6422 \begin_layout Plain Layout
6423 Installing New Document Classes
6431 \begin_layout Standard
6433 we describe the procedures for creating and installing new \SpecialChar LyX
6434 layout and template files,
6435 as well as offer a refresher on correctly installing new \SpecialChar LaTeX
6440 \begin_layout Standard
6442 let us a say a few words about how one ought to think about the relation between \SpecialChar LyX
6443 and \SpecialChar LaTeX
6445 The thing to understand is that,
6448 doesn't know anything about \SpecialChar LaTeX
6451 from \SpecialChar LyX
6454 is just one of several
6455 \begin_inset Quotes eld
6459 \begin_inset Quotes erd
6462 in which it is capable of producing output.
6463 Other such formats are DocBook,
6469 a particularly important format,
6470 but very little of the information \SpecialChar LyX
6471 has about \SpecialChar LaTeX
6472 is actually contained in the program itself.
6476 \begin_layout Plain Layout
6477 Some commands are sufficiently complex that they are
6478 \begin_inset Quotes eld
6482 \begin_inset Quotes erd
6485 into \SpecialChar LyX
6487 But the developers generally regard this as a Bad Thing.
6494 even for the standard classes like
6495 \begin_inset Flex Code
6498 \begin_layout Plain Layout
6505 is contained in `layout files'.
6508 itself does not know much about DocBook or XHTML.
6509 What it knows is contained in layout files.
6512 \begin_layout Standard
6513 You can think of the layout file for a given document class as a translation manual between \SpecialChar LyX
6515 paragraphs with their corresponding styles,
6516 certain sorts of insets,
6518 and the corresponding \SpecialChar LaTeX
6521 or XHTML constructs.
6522 Almost everything \SpecialChar LyX
6524 \begin_inset Flex Code
6527 \begin_layout Plain Layout
6535 is contained in the file
6536 \begin_inset Flex Code
6539 \begin_layout Plain Layout
6545 and in various other files it includes.
6547 anyone intending to write layout files should plan to study the existing files.
6548 A good place to start is with
6549 \begin_inset Flex Code
6552 \begin_layout Plain Layout
6559 which is included in
6560 \begin_inset Flex Code
6563 \begin_layout Plain Layout
6571 \begin_inset Flex Code
6574 \begin_layout Plain Layout
6581 and many of the other layout files for document classes.
6582 This file is where sections and the like are defined:
6584 \begin_inset Flex Code
6587 \begin_layout Plain Layout
6593 tells \SpecialChar LyX
6594 how paragraphs that are marked with the Section,
6597 styles can be translated into corresponding \SpecialChar LaTeX
6600 and XHTML commands and tags.
6602 \begin_inset Flex Code
6605 \begin_layout Plain Layout
6611 file basically just includes several of these
6612 \begin_inset Flex Code
6615 \begin_layout Plain Layout
6624 \begin_layout Standard
6625 Defining the \SpecialChar LyX
6627 correspondence is not the only thing layout files do,
6629 Their other job is to define how the \SpecialChar LyX
6630 constructs themselves will appear on-screen.
6631 The fact that layout files have these two jobs is often a source of confusion,
6632 because they are completely separate.
6633 Telling \SpecialChar LyX
6634 how to translate a certain paragraph style into \SpecialChar LaTeX
6635 does not tell \SpecialChar LyX
6638 telling \SpecialChar LyX
6639 how to display a certain paragraph style does not tell \SpecialChar LyX
6640 how to translate it into \SpecialChar LaTeX
6641 (let alone tell \SpecialChar LaTeX
6645 when you define a new \SpecialChar LyX
6647 you must always do two quite separate things:
6649 \begin_inset space ~
6652 tell \SpecialChar LyX
6653 how to translate it into \SpecialChar LaTeX
6655 \begin_inset space ~
6658 tell \SpecialChar LyX
6662 \begin_layout Standard
6663 Much the same is true,
6665 as regards \SpecialChar LyX
6666 's other backend formats,
6667 though XHTML is in some ways different,
6668 because in that case \SpecialChar LyX
6675 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.
6678 the distinction between what \SpecialChar LyX
6679 does internally and how things are rendered externally remains in force,
6680 and the two can be controlled separately.
6682 \begin_inset CommandInset ref
6684 reference "sec:Tags-for-XHTML"
6692 \begin_layout Section
6693 Installing new \SpecialChar LaTeX
6697 \begin_layout Standard
6698 Some installations may not include a \SpecialChar LaTeX
6699 package or class file that you would like to use within \SpecialChar LyX
6702 you might need Foil\SpecialChar TeX
6704 a package for preparing slides for overhead projectors.
6705 Modern \SpecialChar LaTeX
6706 distributions like \SpecialChar TeX
6707 Live (2008 or newer) or MiK\SpecialChar TeX
6708 provide a user interface for installing such packages.
6710 with MiK\SpecialChar TeX
6712 you start the program
6713 \begin_inset Quotes eld
6717 \begin_inset space ~
6721 \begin_inset Quotes erd
6724 to get a list of available packages.
6725 To install one of them,
6726 right click on it or use the corresponding toolbar button.
6729 \begin_layout Standard
6730 If your \SpecialChar LaTeX
6731 distribution does not provide such a `package manager',
6732 or if the package is not available from your distribution,
6733 then follow these steps to install it manually:
6736 \begin_layout Enumerate
6737 Get the package from
6738 \begin_inset CommandInset href
6741 target "http://www.ctan.org/"
6749 \begin_layout Enumerate
6750 If the package contains a file with the ending
6751 \begin_inset Quotes eld
6755 \begin_inset Flex Code
6758 \begin_layout Plain Layout
6765 \begin_inset Quotes erd
6768 (is the case for Foil\SpecialChar TeX
6769 ) then open a console,
6770 change to the folder of this file and execute the command
6771 \begin_inset Flex Code
6774 \begin_layout Plain Layout
6781 You have now unpacked the package and have all files to install it.
6782 Most \SpecialChar LaTeX
6783 -packages are not packed and you can skip this step.
6786 \begin_layout Enumerate
6787 Now you need to decide if the package should be available for all users or only for you.
6791 \begin_layout Enumerate
6792 On *nix systems (Linux,
6795 if you want the new package to be available for all users on your system,
6796 then install it in your `local' \SpecialChar TeX
6798 otherwise install it in your own `user' \SpecialChar TeX
6800 Where these trees should be created,
6801 if they do not already exist,
6802 depends on your system.
6805 \begin_inset Flex Code
6808 \begin_layout Plain Layout
6818 \begin_layout Plain Layout
6819 This is usually in the directory
6820 \begin_inset Flex Code
6823 \begin_layout Plain Layout
6830 though you can execute the command
6831 \begin_inset Flex Code
6834 \begin_layout Plain Layout
6845 The location of the `local' \SpecialChar TeX
6846 tree is defined by the
6847 \begin_inset Flex Code
6850 \begin_layout Plain Layout
6857 this is usually somewhere like
6858 \begin_inset Flex Code
6861 \begin_layout Plain Layout
6862 /usr/local/share/texmf
6867 or /usr/local/texlive/XXXX where XXXX is the year of the installed \SpecialChar TeX
6869 The location of the `user' \SpecialChar TeX
6871 \begin_inset Flex Code
6874 \begin_layout Plain Layout
6881 \begin_inset Flex Code
6884 \begin_layout Plain Layout
6891 \begin_inset Flex Code
6894 \begin_layout Plain Layout
6903 (If these variables are not predefined,
6904 you have to define them.) You'll probably need root permissions to create or modify the `local' tree,
6905 but not for your `user' tree.
6906 \begin_inset Newline newline
6910 it is recommended to install in the user tree because your user will not be modified or even overwritten when you upgrade your system.
6911 It will typically also be backed up together with everything else when you backup your home directory (which,
6913 you do on a regular basis).
6916 \begin_layout Enumerate
6918 if you want the new package to be available for all users on your system,
6919 change to the folder where \SpecialChar LaTeX
6920 is installed and then change to the subfolder
6921 \begin_inset Flex Code
6924 \begin_layout Plain Layout
6935 (For MiK\SpecialChar TeX
6937 this would be by default the folder
6938 \begin_inset Flex Code
6941 \begin_layout Plain Layout
6959 \begin_layout Plain Layout
6960 Note that this will be the correct path only on English installations.
6963 \begin_inset Flex Code
6966 \begin_layout Plain Layout
6981 and similarly for other languages.
6986 Create there a new folder
6987 \begin_inset Flex Code
6990 \begin_layout Plain Layout
6996 and copy all files of the package into it.
6998 \begin_inset Newline newline
7001 If the package should only available for you or you don't have admin permissions,
7003 but in the local \SpecialChar LaTeX
7006 \begin_inset space \thinspace{}
7010 for MiK\SpecialChar TeX
7012 \begin_inset space ~
7015 2.8 under Windows XP,
7016 this would be the folder:
7017 \begin_inset Newline newline
7023 \begin_inset Flex Code
7026 \begin_layout Plain Layout
7029 Documents and Settings
7041 \begin_inset Newline newline
7047 \begin_inset Phantom HPhantom
7050 \begin_layout Plain Layout
7061 \begin_inset Flex Code
7064 \begin_layout Plain Layout
7077 \begin_inset Newline newline
7082 \begin_inset Newline newline
7086 \begin_inset Flex Code
7089 \begin_layout Plain Layout
7115 \begin_layout Enumerate
7116 Now one only need to tell \SpecialChar LaTeX
7117 that there are new files.
7118 This depends on the used \SpecialChar LaTeX
7123 \begin_layout Enumerate
7124 For \SpecialChar TeX
7125 Live execute the command
7126 \begin_inset Flex Code
7129 \begin_layout Plain Layout
7136 If you installed the package for all users,
7137 then you will probably need to have root permissions for that.
7140 \begin_layout Enumerate
7141 For MiK\SpecialChar TeX
7143 if you have installed the package for all users,
7145 \begin_inset Quotes eld
7149 \begin_inset space ~
7153 \begin_inset Quotes erd
7156 and press the button marked
7157 \begin_inset Quotes eld
7161 \begin_inset Quotes erd
7165 Otherwise start the program
7166 \begin_inset Quotes eld
7170 \begin_inset Quotes erd
7177 \begin_layout Enumerate
7179 you need to tell \SpecialChar LyX
7180 that there are new packages available.
7185 \begin_inset Flex Noun
7188 \begin_layout Plain Layout
7191 \SpecialChar menuseparator
7197 and then restart \SpecialChar LyX
7201 \begin_layout Standard
7202 Now the package is installed.
7205 \begin_inset Flex Code
7208 \begin_layout Plain Layout
7214 will now be available under
7215 \begin_inset Flex Noun
7218 \begin_layout Plain Layout
7219 Document\SpecialChar menuseparator
7220 Settings\SpecialChar menuseparator
7227 \begin_inset Quotes eld
7231 \begin_inset Quotes erd
7238 \begin_layout Standard
7239 If you would like to use a \SpecialChar LaTeX
7240 document class that is not even listed in the menu
7241 \begin_inset Flex Noun
7244 \begin_layout Plain Layout
7245 Document\SpecialChar menuseparator
7246 Settings\SpecialChar menuseparator
7253 then you need to create a `layout' file for it.
7254 That is the topic of the next section.
7257 \begin_layout Section
7258 Types of layout files
7261 \begin_layout Standard
7262 This section describes the various sorts of \SpecialChar LyX
7263 files that contain layout information.
7264 These files describe various paragraph and character styles,
7265 determining how \SpecialChar LyX
7266 should display them and how they should be translated into \SpecialChar LaTeX
7270 or whatever output format is being used.
7274 \begin_layout Standard
7275 We shall try to provide a thorough description of the process of writing layout files here.
7277 there are so many different types of documents supported even by just \SpecialChar LaTeX
7278 that we can't hope to cover every different possibility or problem you might encounter.
7279 The \SpecialChar LyX
7280 users' list is frequented by people with lots of experience with layout design who are willing to share what they've learned,
7281 so please feel free to ask questions there.
7284 \begin_layout Standard
7285 As you prepare to write a new layout,
7286 it is extremely helpful to look at the layouts distributed with \SpecialChar LyX
7288 If you write a \SpecialChar LyX
7289 layout for a \SpecialChar LaTeX
7290 document class that might also be used by others,
7291 or write a module that might be useful to others,
7292 then you should consider posting your layout to the
7293 \begin_inset CommandInset href
7295 name "layout section on the LyX wiki"
7296 target "https://wiki.lyx.org/Layouts/Layouts"
7301 or even to the \SpecialChar LyX
7303 so that it might be included in \SpecialChar LyX
7308 \begin_layout Plain Layout
7309 Note that \SpecialChar LyX
7310 is licensed under the General Public License,
7311 so any material that is contributed to \SpecialChar LyX
7312 must be similarly licensed.
7320 \begin_layout Subsection
7322 \begin_inset CommandInset label
7324 name "subsec:Layout-modules"
7331 \begin_layout Standard
7332 We have spoken to this point about `layout files'.
7333 But there are different sorts of files that contain layout information.
7337 \begin_inset Flex Code
7340 \begin_layout Plain Layout
7346 extension and provide \SpecialChar LyX
7347 with information about document classes.
7348 Since \SpecialChar LyX
7349 1.6 layout information can also be contained in layout
7355 \begin_inset Flex Code
7358 \begin_layout Plain Layout
7365 Modules are to \SpecialChar LaTeX
7366 packages much as layouts are to \SpecialChar LaTeX
7370 \begin_inset Flex Code
7373 \begin_layout Plain Layout
7380 specifically provide support for one package.
7382 layout modules are similar to included
7386 \begin_layout Plain Layout
7387 These can have any extension,
7388 but by convention have the
7389 \begin_inset Flex Code
7392 \begin_layout Plain Layout
7405 \begin_inset Flex Code
7408 \begin_layout Plain Layout
7415 in that modules are not specific to a given document class but may be used with many different classes.
7416 The difference is that using an included file with
7417 \begin_inset Flex Code
7420 \begin_layout Plain Layout
7426 requires editing that file.
7430 \begin_inset Flex Noun
7433 \begin_layout Plain Layout
7434 Document\SpecialChar menuseparator
7443 \begin_layout Standard
7444 Building modules is the easiest way to get started with layout editing,
7445 since it can be as simple as adding a single new paragraph style or flex inset.
7448 contain anything a layout file can contain.
7451 \begin_layout Standard
7452 After creating a new module and copying it to the
7453 \begin_inset Flex Code
7456 \begin_layout Plain Layout
7463 you will need to reconfigure and then restart \SpecialChar LyX
7464 for the module to appear in the menu.
7466 changes you make to the module will be seen immediately,
7468 \begin_inset Flex Noun
7471 \begin_layout Plain Layout
7472 Document\SpecialChar menuseparator
7479 highlight something,
7481 \begin_inset Quotes eld
7485 \begin_inset Quotes erd
7491 It is strongly recommended that you save your work before doing this
7497 it is strongly recommended that you not attempt to edit modules while simultaneously working on actual documents
7500 Though of course the developers strive to keep \SpecialChar LyX
7501 stable in such situations,
7502 syntax errors and the like in your module file could cause strange behavior.
7505 \begin_layout Subsubsection
7509 \begin_layout Standard
7510 Modules are to \SpecialChar LyX
7511 as packages are to \SpecialChar LaTeX
7515 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.
7516 What you need is \SpecialChar LyX
7518 \begin_inset Quotes eld
7522 \begin_inset Quotes erd
7528 \begin_layout Standard
7529 You will find it under
7531 Document\SpecialChar menuseparator
7532 Settings\SpecialChar menuseparator
7536 The large text box allows you to enter anything that you might enter in a layout file or module.
7537 You can think of a document's local layout,
7539 as a module that belongs just to it.
7543 \begin_inset Flex Code
7546 \begin_layout Plain Layout
7553 Any format is acceptable,
7554 but one would normally use the format current at the time.
7555 (In \SpecialChar LyX
7563 the current layout format is
7572 \begin_layout Standard
7573 When you have entered something in the
7574 \begin_inset Flex Code
7577 \begin_layout Plain Layout
7586 \begin_inset Quotes eld
7590 \begin_inset Quotes erd
7593 button at the bottom.
7594 Clicking this button will cause \SpecialChar LyX
7595 to determine whether what you have entered is valid layout information for the chosen format.
7597 will report the result but,
7599 will not tell you what errors there might have been.
7600 These will be written to the terminal,
7603 is started from a terminal.
7604 You will not be permitted to save your local layout until you have entered something valid.
7607 \begin_layout Standard
7608 The warnings at the end of the previous section apply here,
7610 Do not play with local layout while you are actually working,
7611 especially if you have not saved your document.
7613 using local layout with a test document can be a very convenient way to try out layout ideas,
7614 or even to start developing a module.
7617 \begin_layout Subsection
7619 \begin_inset Flex Noun
7622 \begin_layout Plain Layout
7631 \begin_layout Standard
7632 There are two situations you are likely to encounter when wanting to support a new \SpecialChar LaTeX
7635 \begin_inset Flex Code
7638 \begin_layout Plain Layout
7644 ) files and \SpecialChar LaTeX2e
7646 \begin_inset Flex Code
7649 \begin_layout Plain Layout
7656 Supporting a style file is usually fairly easy.
7657 Supporting a new class file is a bit harder.
7658 We'll discuss the former in this section and the latter in the next.
7660 \change_deleted 5863208 1594239023
7661 Similar remarks apply,
7663 if you want to support a new DocBook DTD.
7668 \begin_layout Standard
7669 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.
7670 For the sake of the example,
7671 we'll assume that the style file is called
7672 \begin_inset Flex Noun
7675 \begin_layout Plain Layout
7681 and that it is meant to be used with
7682 \begin_inset Flex Noun
7685 \begin_layout Plain Layout
7692 which is a standard class.
7696 \begin_layout Standard
7697 Start by copying the existing class's layout file into your local directory:
7701 \begin_layout Plain Layout
7703 which directory is your local directory will vary by platform,
7704 and \SpecialChar LyX
7705 allows you to specify your local directory on startup,
7708 \begin_inset Flex Code
7711 \begin_layout Plain Layout
7725 \begin_layout LyX-Code
7726 cp report.layout ~/.lyx/layouts/myclass.layout
7729 \begin_layout Standard
7731 \begin_inset Flex Code
7734 \begin_layout Plain Layout
7740 and change the line:
7744 \begin_layout LyX-Code
7747 DeclareLaTeXClass{Report (Standard Class)}
7750 \begin_layout Standard
7754 \begin_layout LyX-Code
7757 DeclareLaTeXClass[report,
7758 myclass.sty]{Report (My Class)}
7761 \begin_layout Standard
7765 \begin_layout LyX-Code
7767 \begin_inset Newline newline
7773 \begin_inset Newline newline
7779 \begin_layout Standard
7780 near the top of the file.
7783 \begin_layout Standard
7784 Start \SpecialChar LyX
7786 \begin_inset Flex Noun
7789 \begin_layout Plain Layout
7790 Tools\SpecialChar menuseparator
7797 Then restart \SpecialChar LyX
7798 and try creating a new document.
7800 \begin_inset Flex Noun
7803 \begin_layout Plain Layout
7809 " as a document class option in the
7810 \begin_inset Flex Noun
7813 \begin_layout Plain Layout
7814 Document\SpecialChar menuseparator
7821 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—
7823 \begin_inset Flex Code
7826 \begin_layout Plain Layout
7833 so you can fiddle around with the settings for the different sections if you wish.
7834 The layout information for sections is contained in
7835 \begin_inset Flex Code
7838 \begin_layout Plain Layout
7845 but you do not need to copy and change this file.
7847 you can simply add your changes to your layout file,
7849 \begin_inset Flex Code
7852 \begin_layout Plain Layout
7859 which itself includes
7860 \begin_inset Flex Code
7863 \begin_layout Plain Layout
7871 you might add these lines:
7874 \begin_layout LyX-Code
7878 \begin_layout LyX-Code
7882 \begin_layout LyX-Code
7886 \begin_layout LyX-Code
7890 \begin_layout LyX-Code
7894 \begin_layout Standard
7895 to change the font for chapter headings to sans-serif.
7896 This will override (or,
7898 add to) the existing declaration for the Chapter style.
7902 \begin_layout Standard
7903 Your new package may also provide commands or environments not present in the base class.
7905 you will want to add these to the layout file.
7907 \begin_inset CommandInset ref
7909 reference "sec:TextClass"
7914 for information on how to do so.
7917 \begin_layout Standard
7919 \begin_inset Flex Noun
7922 \begin_layout Plain Layout
7928 can be used with several different document classes,
7929 and even if it cannot,
7930 you might find it easiest just to write a module that you can load with the base class.
7931 The simplest possible such module would be:
7934 \begin_layout LyX-Code
7937 DeclareLyXModule{My Class}
7940 \begin_layout LyX-Code
7944 \begin_layout LyX-Code
7945 #Support for myclass.sty.
7948 \begin_layout LyX-Code
7950 \begin_inset Newline newline
7956 \begin_layout LyX-Code
7964 \begin_inset Newline newline
7970 \begin_layout LyX-Code
7972 \begin_inset Newline newline
7978 \begin_inset Newline newline
7984 \begin_layout Standard
7985 A more complex module might modify the behavior of some existing constructs or define some new ones.
7988 \begin_inset CommandInset ref
7990 reference "sec:TextClass"
7998 \begin_layout Subsection
8000 \begin_inset Flex Noun
8003 \begin_layout Plain Layout
8012 \begin_layout Standard
8013 There are two possibilities here.
8014 One is that the class file is itself based upon an existing document class.
8016 many thesis classes are based upon
8017 \begin_inset Flex Noun
8020 \begin_layout Plain Layout
8027 To see whether yours is,
8028 look for a line like
8031 \begin_layout LyX-Code
8037 \begin_layout Standard
8040 then you may proceed largely as in the previous section,
8042 \begin_inset Flex Code
8045 \begin_layout Plain Layout
8046 Declare\SpecialChar LaTeX
8052 line will be different.
8053 If your new class is
8054 \begin_inset Flex Code
8057 \begin_layout Plain Layout
8063 and it is based upon
8064 \begin_inset Flex Code
8067 \begin_layout Plain Layout
8074 then the line should read:
8078 \begin_layout Plain Layout
8079 And it will be easiest if you save the file to
8080 \begin_inset Flex Code
8083 \begin_layout Plain Layout
8091 assumes that the document class has the same name as the layout file.
8100 \begin_layout LyX-Code
8103 DeclareLaTeXClass[thesis,book]{thesis}
8106 \begin_layout Standard
8109 the new class is not based upon an existing class,
8110 you will probably have to
8111 \begin_inset Quotes eld
8115 \begin_inset Quotes erd
8119 We strongly suggest copying an existing layout file which uses a similar \SpecialChar LaTeX
8120 class and then modifying it,
8122 At least use an existing file as a starting point so you can find out what items you need to worry about.
8124 the specifics are covered below.
8127 \begin_layout Subsection
8129 \begin_inset CommandInset label
8131 name "subsec:Creating-Templates"
8138 \begin_layout Standard
8139 Once you have written a layout file for a new document class,
8140 you might want to consider writing a
8146 A template acts as a kind of tutorial for your layout,
8147 showing how it might be used,
8148 though containing dummy content.
8149 You can of course look at the various templates included with \SpecialChar LyX
8153 \begin_layout Standard
8154 Templates are created just like usual documents:
8155 using \SpecialChar LyX
8157 The only difference is that usual documents contain all possible settings,
8158 including the font scheme and the paper size.
8159 Usually a user doesn't want a template to overwrite his preferred settings for such parameters.
8161 the designer of a template should remove the corresponding commands like
8162 \begin_inset Flex Code
8165 \begin_layout Plain Layout
8174 \begin_inset Flex Code
8177 \begin_layout Plain Layout
8185 from the template \SpecialChar LyX
8187 This can be done with any simple text-editor,
8189 \begin_inset Flex Code
8192 \begin_layout Plain Layout
8199 \begin_inset Flex Code
8202 \begin_layout Plain Layout
8211 \begin_layout Standard
8212 Put the edited template files you create in
8213 \begin_inset Flex Code
8216 \begin_layout Plain Layout
8223 copy the ones you use from the global template directory in
8224 \begin_inset Flex Code
8227 \begin_layout Plain Layout
8234 and redefine the template path in the
8235 \begin_inset Flex Noun
8238 \begin_layout Plain Layout
8239 Tools\SpecialChar menuseparator
8240 Preferences\SpecialChar menuseparator
8249 \begin_layout Standard
8252 that there is a template which has a particular meaning:
8253 \begin_inset Newline linebreak
8257 \begin_inset Flex Code
8260 \begin_layout Plain Layout
8267 This template is loaded every time you create a new document with
8268 \begin_inset Flex Noun
8271 \begin_layout Plain Layout
8272 File\SpecialChar menuseparator
8278 in order to provide useful defaults.
8279 To create this template from inside \SpecialChar LyX
8281 all you have to do is to open a document with the correct settings,
8283 \begin_inset Flex Noun
8286 \begin_layout Plain Layout
8287 Save as Document Defaults
8295 \begin_layout Subsection
8296 Upgrading old layout files
8299 \begin_layout Standard
8300 The format of layout files changes with each \SpecialChar LyX
8302 so old layout files need to be converted to the new format.
8304 reads a layout file in an older format,
8305 it automatically calls the script
8306 \begin_inset Flex Code
8309 \begin_layout Plain Layout
8315 to convert it to a temporary file in current format.
8316 The original file is left untouched.
8317 If you use the layout file often,
8319 you may want to convert it permanently,
8320 so that \SpecialChar LyX
8321 does not have to do so itself every time.
8323 you can call the converter manually:
8326 \begin_layout Enumerate
8328 \begin_inset Flex Code
8331 \begin_layout Plain Layout
8338 \begin_inset Flex Code
8341 \begin_layout Plain Layout
8350 \begin_layout Enumerate
8352 \begin_inset Newline newline
8356 \begin_inset Flex Code
8359 \begin_layout Plain Layout
8360 python LyXDir/scripts/layout2layout.py myclass.old myclass.layout
8366 \begin_inset Newline newline
8370 \begin_inset Flex Code
8373 \begin_layout Plain Layout
8379 is the name of your \SpecialChar LyX
8383 \begin_layout Standard
8384 Note that manual conversion does not affect included files,
8385 so these will have to be converted separately.
8388 \begin_layout Subsection
8389 \begin_inset CommandInset label
8391 name "subsec:Cite-Engine-Files"
8398 \begin_layout Standard
8399 A specific form of layout files are the so-called
8400 \begin_inset Flex Code
8403 \begin_layout Plain Layout
8409 files that are located in the
8410 \begin_inset Flex Code
8413 \begin_layout Plain Layout
8420 Their purpose is to define the specifics of \SpecialChar LaTeX
8421 packages aimed at bibliography generation,
8436 but also the way how normal Bib\SpecialChar TeX
8437 citations (without additional packages) are handled in \SpecialChar LyX
8438 is defined in such a file.
8442 \begin_layout Standard
8444 it is defined which packages \SpecialChar LyX
8446 which citation commands are available,
8447 how these are to be displayed in \SpecialChar LyX
8450 the context menus) as well as in the XHTML and plain text output.
8452 the files specify available style variants (author-year,
8454 etc.) and their specifics.
8455 The cite engine files are also used to generate the options that are available in
8457 Document\SpecialChar menuseparator
8458 Settings\SpecialChar menuseparator
8459 Bibliography\SpecialChar menuseparator
8465 \begin_layout Standard
8466 Even though a cite engine file is essentially a normal layout file that could theoretically include any layout information,
8467 it usually primarily includes some specific parameters such as
8468 \begin_inset Flex Code
8471 \begin_layout Plain Layout
8479 \begin_inset Flex Code
8482 \begin_layout Plain Layout
8490 \begin_inset Flex Code
8493 \begin_layout Plain Layout
8500 \begin_inset Flex Code
8503 \begin_layout Plain Layout
8510 The syntax of the latter two is described in
8511 \begin_inset CommandInset ref
8513 reference "subsec:Citation-engine-description"
8522 \begin_inset CommandInset ref
8524 reference "subsec:Citation-format-description"
8530 as well as in the files themselves.
8533 \begin_layout Section
8534 \begin_inset CommandInset label
8536 name "sec:TextClass"
8540 The layout file format
8543 \begin_layout Standard
8544 The following sections describe how layout files are structured and written.
8545 Our advice is to go slowly,
8546 save and test often.
8547 It is really not that hard,
8548 except that the multitude of options can become overwhelming,
8549 especially if you try to check out too many at once.
8550 It becomes easier if you use existing layouts of \SpecialChar LyX
8551 as examples/reference or if you modify an existing layout to your needs.
8554 \begin_layout Standard
8555 Note that all the tags used in layout files are case-insensitive.
8557 \begin_inset Flex Code
8560 \begin_layout Plain Layout
8568 \begin_inset Flex Code
8571 \begin_layout Plain Layout
8578 \begin_inset Flex Code
8581 \begin_layout Plain Layout
8587 are really the same tag.
8588 The possible arguments are printed in brackets after the tag's name.
8589 The default argument is typeset
8590 \begin_inset Flex Code
8593 \begin_layout Plain Layout
8602 If the argument has a data type like
8603 \begin_inset Quotes eld
8607 \begin_inset Quotes erd
8611 \begin_inset Quotes eld
8615 \begin_inset Quotes erd
8619 the default is shown like this:
8621 \begin_inset Flex Code
8624 \begin_layout Plain Layout
8635 \begin_layout Subsection
8636 The document class declaration and classification
8639 \begin_layout Standard
8640 Lines in a layout file which begin with
8641 \begin_inset Flex Code
8644 \begin_layout Plain Layout
8651 There is one exception to this rule.
8653 \begin_inset Flex Code
8656 \begin_layout Plain Layout
8662 files should begin with lines like:
8665 \begin_layout LyX-Code
8668 #% Do not delete the line below;
8669 configure depends on this
8672 \begin_layout LyX-Code
8677 DeclareLaTeXClass{Article (Standard Class)}
8680 \begin_layout LyX-Code
8685 DeclareCategory{Articles}
8688 \begin_layout Standard
8689 The second and third lines are used when you (re)configure \SpecialChar LyX
8691 The layout file is read by the \SpecialChar LaTeX
8693 \begin_inset Flex Code
8696 \begin_layout Plain Layout
8703 in a special mode where
8704 \begin_inset Flex Code
8707 \begin_layout Plain Layout
8714 The first line is just a \SpecialChar LaTeX
8716 the second one contains the mandatory declaration of the text class and the third line contains the optional classification of the class.
8717 If these lines appear in a file named
8718 \begin_inset Flex Code
8721 \begin_layout Plain Layout
8728 then they define a text class of name
8729 \begin_inset Flex Code
8732 \begin_layout Plain Layout
8738 (the name of the layout file) which uses the \SpecialChar LaTeX
8740 \begin_inset Flex Code
8743 \begin_layout Plain Layout
8749 (the default is to use the same name as the layout).
8751 \begin_inset Quotes eld
8754 Article (Standard Class)
8755 \begin_inset Quotes erd
8758 that appears above is used as a description of the text class in the
8759 \begin_inset Flex Noun
8762 \begin_layout Plain Layout
8763 Document\SpecialChar menuseparator
8771 \begin_inset Quotes eld
8775 \begin_inset Quotes erd
8778 in the example) is also used in the
8779 \begin_inset Flex Noun
8782 \begin_layout Plain Layout
8783 Document\SpecialChar menuseparator
8790 the text classes are grouped by these categories (which are usually genres,
8791 so typical categories are
8792 \begin_inset Quotes eld
8796 \begin_inset Quotes erd
8801 \begin_inset Quotes eld
8805 \begin_inset Quotes erd
8810 \begin_inset Quotes eld
8814 \begin_inset Quotes erd
8819 \begin_inset Quotes eld
8823 \begin_inset Quotes erd
8828 \begin_inset Quotes eld
8832 \begin_inset Quotes erd
8837 \begin_inset Quotes eld
8841 \begin_inset Quotes erd
8845 If no category has been declared,
8846 the class will be put in the
8847 \begin_inset Quotes eld
8851 \begin_inset Quotes erd
8857 \begin_layout Standard
8858 Let's assume that you wrote your own text class that uses the
8859 \begin_inset Flex Code
8862 \begin_layout Plain Layout
8869 but where you changed the appearance of the section headings.
8870 If you put it in a file
8871 \begin_inset Flex Code
8874 \begin_layout Plain Layout
8881 the header of this file should be:
8884 \begin_layout LyX-Code
8887 #% Do not delete the line below;
8888 configure depends on this
8891 \begin_layout LyX-Code
8896 DeclareLaTeXClass[article]{Article (with My Own Headings)}
8899 \begin_layout LyX-Code
8904 DeclareCategory{Articles}
8907 \begin_layout Standard
8908 This declares a text class
8909 \begin_inset Flex Code
8912 \begin_layout Plain Layout
8919 associated with the \SpecialChar LaTeX
8921 \begin_inset Flex Code
8924 \begin_layout Plain Layout
8931 \begin_inset Quotes eld
8934 Article (with My Own Headings)
8935 \begin_inset Quotes erd
8939 If your text class depends on several packages,
8940 you can declare it as:
8943 \begin_layout LyX-Code
8946 #% Do not delete the line below;
8947 configure depends on this
8950 \begin_layout LyX-Code
8955 DeclareLaTeXClass[article,foo.sty]{Article (with My Own Headings)}
8958 \begin_layout LyX-Code
8963 DeclareCategory{Articles}
8966 \begin_layout Standard
8967 This indicates that your text class uses the
8968 \begin_inset Flex Code
8971 \begin_layout Plain Layout
8979 \change_deleted 5863208 1594239179
8981 it is also possible to declare classes for DocBook code.
8982 Typical declarations will look like:
8985 \begin_layout LyX-Code
8987 \change_deleted 5863208 1594239179
8990 #% Do not delete the line below;
8991 configure depends on this
8994 \begin_layout LyX-Code
8996 \change_deleted 5863208 1594239179
9001 DeclareDocBookClass[article]{SGML (DocBook Article)}
9004 \begin_layout LyX-Code
9006 \change_deleted 5863208 1594239179
9011 DeclareCategory{Articles (DocBook)}
9016 \begin_layout Standard
9017 Note that these declarations can also be given an optional parameter declaring the name of the document class (but not a list).
9020 \begin_layout Standard
9022 to be as explicit as possible,
9023 the form of the layout declaration is:
9026 \begin_layout LyX-Code
9031 DeclareLaTeXClass[class,package.sty]{layout description}
9034 \begin_layout LyX-Code
9039 DeclareCategory{category}
9042 \begin_layout Standard
9043 The class need only be specified if the name of the \SpecialChar LaTeX
9044 class file and the name of the layout file are different or if there are packages to load.
9045 If the name of the class file is not specified,
9046 then \SpecialChar LyX
9047 will simply assume that it is the same as the name of the layout file.
9050 \begin_layout Standard
9051 When the text class has been modified to your taste,
9052 all you have to do is to copy it either to
9053 \begin_inset Flex Code
9056 \begin_layout Plain Layout
9063 \begin_inset Flex Code
9066 \begin_layout Plain Layout
9074 \begin_inset Flex Noun
9077 \begin_layout Plain Layout
9078 Tools\SpecialChar menuseparator
9085 exit \SpecialChar LyX
9087 Then your new text class should be available along with the others.
9090 \begin_layout Standard
9091 Once the layout file is installed,
9092 you can edit it and see your changes without having to reconfigure or to restart \SpecialChar LyX
9097 \begin_layout Plain Layout
9098 In versions of \SpecialChar LyX
9102 editing layout files was very time consuming,
9103 since you had constantly to restart \SpecialChar LyX
9109 You can force a reload of the current layout by using the \SpecialChar LyX
9111 \begin_inset Flex Noun
9114 \begin_layout Plain Layout
9121 There is no default binding for this function—
9124 you can bind it to a key yourself.
9125 But you will normally use this function simply by entering it in the mini-buffer.
9129 \begin_layout Standard
9136 \begin_inset Flex Noun
9139 \begin_layout Plain Layout
9145 is very much an `advanced feature'.
9150 recommended that you save your work before using this function.
9156 recommended that you not attempt to edit layout information while simultaneously working on a document that you care about.
9157 Use a test document.
9158 Syntax errors and the like in your layout file could cause peculiar behavior.
9160 such errors could cause \SpecialChar LyX
9161 to regard the current layout as invalid and to attempt to switch to some other layout.
9165 \begin_layout Plain Layout
9166 Really bad syntax errors may even caused \SpecialChar LyX
9168 This is because certain sorts of errors may make \SpecialChar LyX
9179 The \SpecialChar LyX
9180 team strives to keep \SpecialChar LyX
9181 stable in such situations,
9182 but safe is better than sorry.
9186 \begin_layout Plain Layout
9187 While we're giving advice:
9188 make regular backups.
9189 And be nice to your mother.
9197 \begin_layout Subsection
9198 The Module declaration
9201 \begin_layout Standard
9202 A module must begin with a line like the following:
9205 \begin_layout LyX-Code
9208 DeclareLyXModule[endnotes.sty]{Endnotes}
9209 \change_inserted -712698321 1554395911
9213 \begin_layout LyX-Code
9215 \change_inserted -712698321 1554395924
9220 DeclareCategory{Foot- and Endnotes}
9221 \change_deleted -712698321 1554395911
9229 \begin_layout Standard
9230 The mandatory argument
9231 \change_inserted -712698321 1554395956
9242 is the name of the module,
9243 as it should appear in
9244 \begin_inset Flex Noun
9247 \begin_layout Plain Layout
9248 Document\SpecialChar menuseparator
9249 Settings\SpecialChar menuseparator
9256 The argument in square brackets is optional:
9257 It declares any \SpecialChar LaTeX
9258 packages on which the module depends.
9259 It is also possible to use the form
9260 \begin_inset Flex Noun
9263 \begin_layout Plain Layout
9269 as an optional argument,
9270 which declares that the module can only be used when there exists a conversion chain between the formats `
9271 \begin_inset Flex Code
9274 \begin_layout Plain Layout
9281 \begin_inset Flex Code
9284 \begin_layout Plain Layout
9292 \change_inserted -712698321 1554396133
9299 declaration is not strictly mandatory,
9300 but you should add it,
9301 since it is helpful to find the module.
9302 Please have a look at the existing module categories and if appropriate,
9308 \begin_layout Standard
9310 \change_inserted -712698321 1554395988
9313 declaration should then be followed by lines like the following:
9317 \begin_layout Plain Layout
9318 Preferably in English if the module should be published with \SpecialChar LyX
9320 This description will appear in the list of messages to be translated and will be thus translated with the next interface update.
9328 \begin_layout LyX-Code
9332 \begin_layout LyX-Code
9333 #Adds an endnote command,
9334 in addition to footnotes.
9338 \begin_layout LyX-Code
9339 #You will need to add
9341 theendnotes in TeX code where you
9344 \begin_layout LyX-Code
9345 #want the endnotes to appear.
9349 \begin_layout LyX-Code
9353 \begin_layout LyX-Code
9355 somemodule | othermodule
9358 \begin_layout LyX-Code
9363 \begin_layout Standard
9364 The description is used in
9365 \begin_inset Flex Noun
9368 \begin_layout Plain Layout
9369 Document\SpecialChar menuseparator
9370 Settings\SpecialChar menuseparator
9376 to provide the user with information about what the module does.
9378 \begin_inset Flex Code
9381 \begin_layout Plain Layout
9387 line is used to identify other modules with which this one must be used;
9389 \begin_inset Flex Code
9392 \begin_layout Plain Layout
9398 line is used to identify modules with which this one may not be used.
9402 multiple modules should be separated with the pipe symbol:
9404 Note that the required modules are treated disjunctively:
9409 of the required modules must be used.
9415 excluded module may be used.
9416 Note that modules are identified here by their filenames without the
9417 \begin_inset Flex Code
9420 \begin_layout Plain Layout
9428 \begin_inset Flex Code
9431 \begin_layout Plain Layout
9438 \begin_inset Flex Code
9441 \begin_layout Plain Layout
9450 \begin_layout Subsection
9451 The CiteEngine file declaration
9454 \begin_layout Standard
9455 A cite engine file must begin with a line like the following:
9458 \begin_layout LyX-Code
9461 DeclareLyXCiteEngineModule[biblatex.sty]{Biblatex}
9464 \begin_layout Standard
9465 The mandatory argument,
9467 is the name of the cite style,
9468 as it should appear in
9469 \begin_inset Flex Noun
9472 \begin_layout Plain Layout
9473 Document\SpecialChar menuseparator
9474 Settings\SpecialChar menuseparator
9481 The argument in square brackets is optional:
9482 It declares any \SpecialChar LaTeX
9483 packages on which the cite engine depends.
9486 \begin_layout Standard
9487 The cite engine declaration should then be followed by lines like the following:
9491 \begin_layout Plain Layout
9492 Preferably in English if the module should be published with \SpecialChar LyX
9494 This description will appear in the list of messages to be translated and will be thus translated with the next interface update.
9502 \begin_layout LyX-Code
9506 \begin_layout LyX-Code
9507 # Biblatex supports many author-year and numerical styles.
9510 \begin_layout LyX-Code
9511 # It is mainly aimed at the Humanities.
9515 \begin_layout LyX-Code
9517 fully localized and provides many features
9520 \begin_layout LyX-Code
9521 # that are not possible with BibTeX.
9522 The use of 'biber' as
9525 \begin_layout LyX-Code
9526 # bibliography processor is advised.
9529 \begin_layout LyX-Code
9533 \begin_layout Standard
9534 The description is used in
9535 \begin_inset Flex Noun
9538 \begin_layout Plain Layout
9539 Document\SpecialChar menuseparator
9540 Settings\SpecialChar menuseparator
9546 to provide the user with information about the cite engine.
9549 \begin_layout Subsection
9553 \begin_layout Standard
9554 The first non-comment line of any layout file,
9560 contain the file format number:
9563 \begin_layout Description
9564 \begin_inset Flex Code
9567 \begin_layout Plain Layout
9574 \begin_inset Flex Code
9577 \begin_layout Plain Layout
9583 ] The format number of the layout file.
9586 \begin_layout Standard
9587 This tag was introduced with \SpecialChar LyX
9589 \begin_inset space ~
9593 Layout files from older \SpecialChar LyX
9594 versions do not have an explicit file format and are considered to have
9595 \begin_inset Flex Code
9598 \begin_layout Plain Layout
9600 \begin_inset space ~
9609 The format for the present version of \SpecialChar LyX
9611 But each version of \SpecialChar LyX
9612 is capable of reading earlier versions' layout files,
9613 just as they are capable of reading files produced by earlier versions of \SpecialChar LyX
9617 no provision for converting to earlier formats.
9620 \begin_layout Subsection
9621 \begin_inset CommandInset label
9623 name "subsec:General-text-class"
9627 General text class parameters
9630 \begin_layout Standard
9631 These are general parameters that govern the behavior of an entire document class.
9636 mean that they must appear in
9637 \begin_inset Flex Code
9640 \begin_layout Plain Layout
9646 files rather than in modules.
9647 A module can contain any layout tag.)
9650 \begin_layout Description
9652 \change_inserted -712698321 1526899478
9653 \begin_inset Flex Code
9656 \begin_layout Plain Layout
9658 \change_inserted -712698321 1526898610
9659 AddToCiteEngine <engine>
9666 Extends the possibilities for displaying citation references.
9668 \begin_inset CommandInset ref
9670 reference "subsec:Citation-engine-description"
9680 \begin_inset Flex Code
9683 \begin_layout Plain Layout
9685 \change_inserted -712698321 1526898823
9696 \begin_layout Description
9697 \begin_inset Flex Code
9700 \begin_layout Plain Layout
9706 Adds information that will be output in the
9707 \begin_inset Flex Code
9710 \begin_layout Plain Layout
9716 block when the document is output to XHTML.
9718 this would be used to output CSS style information,
9719 but it can be used for anything that can appear in
9720 \begin_inset Flex Code
9723 \begin_layout Plain Layout
9731 \begin_inset Quotes eld
9735 \begin_inset Flex Code
9738 \begin_layout Plain Layout
9745 \begin_inset Quotes erd
9751 \begin_layout Description
9752 \begin_inset Flex Code
9755 \begin_layout Plain Layout
9761 Adds information to the document preamble.
9763 \begin_inset Newline newline
9767 \begin_inset Quotes eld
9771 \begin_inset Flex Code
9774 \begin_layout Plain Layout
9781 \begin_inset Quotes erd
9785 \change_inserted -712698321 1562592950
9789 \begin_layout Description
9791 \change_inserted -712698321 1562593040
9792 \begin_inset Flex Code
9795 \begin_layout Plain Layout
9797 \change_inserted -712698321 1562592954
9806 \begin_inset Flex Code
9809 \begin_layout Plain Layout
9811 \change_inserted -712698321 1562592950
9822 \begin_inset space \thinspace{}
9826 \begin_inset Flex Code
9829 \begin_layout Plain Layout
9831 \change_inserted -712698321 1562592950
9839 ] If the document class adds the bibliography to the table of contents,
9840 add this option with value
9841 \begin_inset Flex Code
9844 \begin_layout Plain Layout
9846 \change_inserted -712698321 1562592996
9855 \begin_inset Flex Code
9858 \begin_layout Plain Layout
9860 \change_inserted -712698321 1562593006
9869 This prevents the bibliography from being added twice.
9874 \begin_layout Description
9875 \begin_inset Flex Code
9878 \begin_layout Plain Layout
9884 Defines the possibilities for displaying citation references.
9886 \begin_inset CommandInset ref
9888 reference "subsec:Citation-engine-description"
9898 \begin_inset Quotes eld
9902 \begin_inset Flex Code
9905 \begin_layout Plain Layout
9912 \begin_inset Quotes erd
9916 Primarily used in cite engine files (see
9917 \begin_inset CommandInset ref
9919 reference "subsec:Cite-Engine-Files"
9929 \change_inserted -712698321 1526898530
9930 Note that if you specify this in a layout file or module,
9931 any cite engine definition will be overridden.
9933 \begin_inset Flex Code
9936 \begin_layout Plain Layout
9938 \change_inserted -712698321 1526898530
9951 \begin_layout Description
9952 \begin_inset Flex Code
9955 \begin_layout Plain Layout
9961 Defines formats for use in the display of bibliographic information.
9963 \begin_inset CommandInset ref
9965 reference "subsec:Citation-format-description"
9972 \begin_inset Quotes eld
9976 \begin_inset Flex Code
9979 \begin_layout Plain Layout
9986 \begin_inset Quotes erd
9990 Primarily used in cite engine files (see
9991 \begin_inset CommandInset ref
9993 reference "subsec:Cite-Engine-Files"
10003 \change_inserted -712698321 1526898585
10004 A cite format defined in a layout or module will override the cite engine definition.
10009 \begin_layout Description
10010 \begin_inset Flex Code
10013 \begin_layout Plain Layout
10020 \begin_inset Flex Code
10023 \begin_layout Plain Layout
10032 \begin_inset Flex Code
10035 \begin_layout Plain Layout
10041 ] Determines whether
10045 or Bib\SpecialChar TeX
10046 is used to generate a Bibliography.
10047 Primarily used in cite engine files (see
10048 \begin_inset CommandInset ref
10050 reference "subsec:Cite-Engine-Files"
10061 \begin_layout Description
10062 \begin_inset Flex Code
10065 \begin_layout Plain Layout
10071 Describes various global options supported by the document class.
10073 \begin_inset CommandInset ref
10075 reference "subsec:ClassOptions"
10082 \begin_inset Quotes eld
10086 \begin_inset Flex Code
10089 \begin_layout Plain Layout
10096 \begin_inset Quotes erd
10102 \begin_layout Description
10103 \begin_inset Flex Code
10106 \begin_layout Plain Layout
10113 \begin_inset Flex Code
10116 \begin_layout Plain Layout
10125 \begin_inset space \thinspace{}
10129 \begin_inset Flex Code
10132 \begin_layout Plain Layout
10138 ] Whether the class should
10142 to having one or two columns.
10143 Can be changed in the
10144 \begin_inset Flex Noun
10147 \begin_layout Plain Layout
10148 Document\SpecialChar menuseparator
10157 \begin_layout Description
10158 \begin_inset Flex Code
10161 \begin_layout Plain Layout
10168 \begin_inset Flex Code
10171 \begin_layout Plain Layout
10177 ] This sequence defines the properties for a counter.
10178 If the counter does not yet exist,
10183 \begin_inset Quotes eld
10187 \begin_inset Flex Code
10190 \begin_layout Plain Layout
10197 \begin_inset Quotes erd
10201 \begin_inset Newline newline
10205 \begin_inset CommandInset ref
10207 reference "subsec:Counters"
10212 for details on counters.
10215 \begin_layout Description
10216 \begin_inset Flex Code
10219 \begin_layout Plain Layout
10225 Sets the default font used to display the document.
10227 \begin_inset CommandInset ref
10229 reference "subsec:Font-description"
10234 for how to declare fonts.
10236 \begin_inset Quotes eld
10240 \begin_inset Flex Code
10243 \begin_layout Plain Layout
10250 \begin_inset Quotes erd
10256 \begin_layout Description
10257 \begin_inset Flex Code
10260 \begin_layout Plain Layout
10267 \begin_inset Flex Code
10270 \begin_layout Plain Layout
10276 ] Specifies a module to be included by default with this document class.
10277 The module is specified as filename without the
10278 \begin_inset Flex Code
10281 \begin_layout Plain Layout
10288 The user can still remove the module,
10289 but it will be active at the outset.
10290 (This applies only when new files are created,
10291 or when this class is chosen for an existing document.)
10294 \begin_layout Description
10295 \begin_inset Flex Code
10298 \begin_layout Plain Layout
10305 \begin_inset Flex Code
10308 \begin_layout Plain Layout
10314 ] This is the style that will be assigned to new paragraphs,
10316 \begin_inset Flex Noun
10319 \begin_layout Plain Layout
10326 This will default to the first defined style if not given,
10327 but you are encouraged to use this directive.
10330 \begin_layout Description
10332 \change_inserted -970929547 1515112870
10333 \begin_inset Flex Code
10336 \begin_layout Plain Layout
10338 \change_inserted -970929547 1515112782
10347 \begin_inset Flex Code
10350 \begin_layout Plain Layout
10352 \change_inserted -970929547 1515112766
10360 ] The root element (at the top of the document) to use when outputting documents with this class in DocBook.
10361 The default value is
10362 \begin_inset Quotes eld
10366 \begin_inset Flex Code
10369 \begin_layout Plain Layout
10371 \change_inserted -970929547 1515112845
10380 \begin_inset Quotes erd
10385 \change_deleted 1075283030 1594226862
10387 \change_inserted 1075283030 1594226777
10391 \begin_layout Description
10393 \change_inserted 1075283030 1594226859
10394 \begin_inset Flex Code
10397 \begin_layout Plain Layout
10399 \change_inserted 1075283030 1594226785
10400 DocBookForceAbstract
10408 \begin_inset Flex Code
10411 \begin_layout Plain Layout
10413 \change_inserted 1075283030 1594226804
10422 \begin_inset Quotes eld
10430 \begin_inset Quotes erd
10434 the root element will always have an
10439 The default value is
10440 \begin_inset Quotes eld
10448 \begin_inset Quotes erd
10456 \begin_layout Description
10457 \begin_inset Flex Code
10460 \begin_layout Plain Layout
10467 \begin_inset Flex Code
10470 \begin_layout Plain Layout
10476 ] This tag indicates that the module (which is specified by filename without the
10477 \begin_inset Flex Code
10480 \begin_layout Plain Layout
10486 extension) cannot be used with this document class.
10487 This might be used in a journal-specific layout file to prevent,
10490 \begin_inset Flex Code
10493 \begin_layout Plain Layout
10499 module that numbers theorems by section.
10504 be used in a module.
10505 Modules have their own way of excluding other modules (see
10506 \begin_inset CommandInset ref
10508 reference "subsec:Layout-modules"
10516 \begin_layout Description
10517 \begin_inset Flex Code
10520 \begin_layout Plain Layout
10526 Defines a new float.
10528 \begin_inset CommandInset ref
10530 reference "subsec:Floats"
10537 \begin_inset Quotes eld
10541 \begin_inset Flex Code
10544 \begin_layout Plain Layout
10551 \begin_inset Quotes erd
10557 \begin_layout Description
10558 \begin_inset Flex Code
10561 \begin_layout Plain Layout
10567 Sets the information that will be output in the
10568 \begin_inset Flex Code
10571 \begin_layout Plain Layout
10577 block when this document class is output to XHTML.
10578 Note that this will completely override any prior
10579 \begin_inset Flex Code
10582 \begin_layout Plain Layout
10589 \begin_inset Flex Code
10592 \begin_layout Plain Layout
10600 \begin_inset Newline newline
10604 \begin_inset Flex Code
10607 \begin_layout Plain Layout
10613 if you just want to add material to the preamble.) Must end with
10614 \begin_inset Quotes eld
10618 \begin_inset Flex Code
10621 \begin_layout Plain Layout
10628 \begin_inset Quotes erd
10634 \begin_layout Description
10635 \begin_inset Flex Code
10638 \begin_layout Plain Layout
10645 \begin_inset Flex Code
10648 \begin_layout Plain Layout
10654 ] The style to use for the table of contents,
10657 when the document is output to HTML.
10659 this should normally be
10660 \begin_inset Flex Code
10663 \begin_layout Plain Layout
10671 \begin_inset Flex Code
10674 \begin_layout Plain Layout
10681 If it is not given,
10682 then \SpecialChar LyX
10683 will attempt to figure out which layout to use.
10686 \begin_layout Description
10687 \begin_inset Flex Code
10690 \begin_layout Plain Layout
10697 \begin_inset Flex Code
10700 \begin_layout Plain Layout
10706 ] Modifies the properties of the given counter.
10707 If the counter does not exist,
10708 the statement is ignored.
10710 \begin_inset Quotes eld
10714 \begin_inset Flex Code
10717 \begin_layout Plain Layout
10724 \begin_inset Quotes erd
10728 \begin_inset Newline newline
10732 \begin_inset CommandInset ref
10734 reference "subsec:Counters"
10739 for details on counters.
10742 \begin_layout Description
10743 \begin_inset Flex Code
10746 \begin_layout Plain Layout
10753 \begin_inset Flex Code
10756 \begin_layout Plain Layout
10762 ] This allows you to include another layout definition file within yours to avoid duplicating commands.
10763 Common examples are the standard layout files,
10766 \begin_inset Flex Code
10769 \begin_layout Plain Layout
10776 which contains most of the basic layouts.
10777 \change_inserted -712698321 1611646803
10781 \begin_layout Description
10783 \change_inserted -712698321 1611646804
10784 \begin_inset Flex Code
10787 \begin_layout Plain Layout
10789 \change_inserted -712698321 1611646837
10798 \begin_inset Flex Code
10801 \begin_layout Plain Layout
10803 \change_inserted -712698321 1611646804
10811 ] is a variant of the
10812 \begin_inset Flex Code
10815 \begin_layout Plain Layout
10817 \change_inserted -712698321 1611646804
10825 command which does not look for files in the user directory.
10826 This allows to create a file
10827 \begin_inset Flex Code
10830 \begin_layout Plain Layout
10832 \change_inserted -712698321 1611646804
10841 \begin_inset Flex Code
10844 \begin_layout Plain Layout
10846 \change_inserted -712698321 1611646804
10854 in the user directory which includes a global file with the same name via
10855 \begin_inset Flex Code
10858 \begin_layout Plain Layout
10860 \change_inserted -712698321 1611646853
10869 \begin_inset Flex Code
10872 \begin_layout Plain Layout
10874 \change_inserted -712698321 1611646855
10875 InputGlobal name.inc
10884 \begin_inset Flex Code
10887 \begin_layout Plain Layout
10889 \change_inserted -712698321 1611646804
10898 the file would recursively include itself).
10900 you can modify global files without having to completely copy them.
10905 \begin_layout Description
10906 \begin_inset Flex Code
10909 \begin_layout Plain Layout
10916 \begin_inset Flex Code
10919 \begin_layout Plain Layout
10925 ] This section (re-)defines the layout of an inset.
10926 It can be applied to an existing inset or to a new,
10927 user-defined inset,
10929 a new character style.
10931 \begin_inset Quotes eld
10935 \begin_inset Flex Code
10938 \begin_layout Plain Layout
10945 \begin_inset Quotes erd
10949 \begin_inset Newline newline
10953 \begin_inset CommandInset ref
10955 reference "subsec:Flex-insets-and"
10960 for more information.
10964 \begin_layout Description
10965 \begin_inset Flex Code
10968 \begin_layout Plain Layout
10975 \begin_inset Flex Code
10978 \begin_layout Plain Layout
10984 ] A string that indicates the width of the left margin on the screen,
10987 \begin_inset Quotes eld
10991 \begin_inset Flex Code
10994 \begin_layout Plain Layout
11001 \begin_inset Quotes erd
11005 (Note that this is not a `length',
11007 \begin_inset Quotes eld
11011 \begin_inset Quotes erd
11017 \begin_layout Description
11018 \begin_inset Flex Code
11021 \begin_layout Plain Layout
11028 \begin_inset Flex Code
11031 \begin_layout Plain Layout
11037 ] An integer that determines the maximal number of names displayed in an author-year citation before the citation switches to
11038 \begin_inset Quotes eld
11042 \begin_inset Quotes erd
11046 Primarily used in cite engine files (see
11047 \begin_inset CommandInset ref
11049 reference "subsec:Cite-Engine-Files"
11060 \begin_layout Description
11062 \change_inserted -712698321 1612018485
11063 \begin_inset Flex Code
11066 \begin_layout Plain Layout
11068 \change_inserted -712698321 1612018457
11077 \begin_inset Flex Code
11080 \begin_layout Plain Layout
11082 \change_inserted -712698321 1612018466
11090 ] Modifies the layout of an inset.
11091 If the layout does not exist,
11092 this section is ignored.
11094 \begin_inset Quotes eld
11098 \begin_inset Flex Code
11101 \begin_layout Plain Layout
11103 \change_inserted -712698321 1612018452
11112 \begin_inset Quotes erd
11118 \begin_layout Description
11119 \begin_inset Flex Code
11122 \begin_layout Plain Layout
11129 \begin_inset Flex Code
11132 \begin_layout Plain Layout
11138 ] Modifies the properties of the given paragraph style.
11139 If the style does not exist,
11140 this section is ignored.
11142 \begin_inset Quotes eld
11146 \begin_inset Flex Code
11149 \begin_layout Plain Layout
11156 \begin_inset Quotes erd
11162 \begin_layout Description
11163 \begin_inset Flex Code
11166 \begin_layout Plain Layout
11173 \begin_inset Flex Code
11176 \begin_layout Plain Layout
11182 ] Deletes an existing counter,
11183 usually one defined in an included file.
11186 \begin_layout Description
11187 \begin_inset Flex Code
11190 \begin_layout Plain Layout
11197 \begin_inset Flex Code
11200 \begin_layout Plain Layout
11206 ] Deletes an existing float.
11207 This is particularly useful when you want to suppress a float that has been defined in an input file.
11210 \begin_layout Description
11211 \begin_inset Flex Code
11214 \begin_layout Plain Layout
11221 \begin_inset Flex Code
11224 \begin_layout Plain Layout
11230 ] Deletes an existing style.
11233 \begin_layout Description
11234 \begin_inset Flex Code
11237 \begin_layout Plain Layout
11244 \begin_inset Flex Code
11247 \begin_layout Plain Layout
11254 \begin_inset Flex Code
11257 \begin_layout Plain Layout
11263 ] Define a new table of contents with type
11264 \begin_inset Flex Code
11267 \begin_layout Plain Layout
11274 \begin_inset Flex Code
11277 \begin_layout Plain Layout
11284 See also the AddToToc commands.
11287 \begin_layout Description
11288 \begin_inset Flex Code
11291 \begin_layout Plain Layout
11298 \begin_inset Flex Code
11301 \begin_layout Plain Layout
11307 ] The file format (as defined in the \SpecialChar LyX
11308 preferences) produced by this document class.
11309 It is mainly useful when
11310 \begin_inset Flex Code
11313 \begin_layout Plain Layout
11320 \begin_inset Flex Code
11323 \begin_layout Plain Layout
11329 and one wants to define a new type of literate document.
11330 The format is reset to
11331 \change_deleted 5863208 1594239413
11333 \begin_inset Quotes eld
11337 \begin_inset Flex Code
11340 \begin_layout Plain Layout
11347 \begin_inset Quotes erd
11353 \begin_inset Quotes eld
11357 \begin_inset Flex Code
11360 \begin_layout Plain Layout
11367 \begin_inset Quotes erd
11370 when the corresponding
11371 \begin_inset Flex Code
11374 \begin_layout Plain Layout
11380 parameter is encountered.
11383 \begin_layout Description
11384 \begin_inset Flex Code
11387 \begin_layout Plain Layout
11394 \begin_inset Flex Code
11397 \begin_layout Plain Layout
11409 \change_deleted 5863208 1594239430
11411 \begin_inset Flex Code
11414 \begin_layout Plain Layout
11424 \begin_inset Flex Code
11427 \begin_layout Plain Layout
11433 ] Specifies what sort of output documents using this class will produce.
11436 \begin_layout Description
11437 \begin_inset Flex Code
11440 \begin_layout Plain Layout
11447 \begin_inset Flex Code
11450 \begin_layout Plain Layout
11457 \begin_inset Flex Code
11460 \begin_layout Plain Layout
11466 ] Specifies options,
11467 given in the second string,
11468 for the package named by the first string.
11471 \begin_inset Quotes eld
11475 \begin_inset Flex Code
11478 \begin_layout Plain Layout
11479 PackageOptions natbib square
11485 \begin_inset Quotes erd
11489 \begin_inset Flex Code
11492 \begin_layout Plain Layout
11498 to be loaded with the
11499 \begin_inset Flex Code
11502 \begin_layout Plain Layout
11509 (For \SpecialChar TeX
11511 this causes \SpecialChar LyX
11514 \begin_inset Flex Code
11517 \begin_layout Plain Layout
11520 PassOptionsToPackage{natbib}{square}
11526 \begin_inset Flex Code
11529 \begin_layout Plain Layout
11536 \change_inserted -712698321 1565102364
11540 \begin_layout Description
11542 \change_inserted -712698321 1565102470
11543 \begin_inset Flex Code
11546 \begin_layout Plain Layout
11548 \change_inserted -712698321 1565102365
11557 \begin_inset Flex Code
11560 \begin_layout Plain Layout
11562 \change_inserted -712698321 1565105222
11605 ] The default page size.
11606 This is used by some converters.
11611 \begin_layout Description
11612 \begin_inset Flex Code
11615 \begin_layout Plain Layout
11622 \begin_inset Flex Code
11625 \begin_layout Plain Layout
11635 \begin_inset Flex Code
11638 \begin_layout Plain Layout
11646 \begin_inset Flex Code
11649 \begin_layout Plain Layout
11655 ] The default pagestyle.
11656 Can be changed in the
11657 \begin_inset Flex Noun
11660 \begin_layout Plain Layout
11661 Document\SpecialChar menuseparator
11670 \begin_layout Description
11671 \begin_inset Flex Code
11674 \begin_layout Plain Layout
11680 Sets the preamble for the \SpecialChar LaTeX
11682 Note that this will completely override any prior
11683 \begin_inset Flex Code
11686 \begin_layout Plain Layout
11693 \begin_inset Flex Code
11696 \begin_layout Plain Layout
11704 \begin_inset Flex Code
11707 \begin_layout Plain Layout
11713 if you just want to add material to the preamble.) Must end with
11714 \begin_inset Quotes eld
11718 \begin_inset Flex Code
11721 \begin_layout Plain Layout
11728 \begin_inset Quotes erd
11732 \change_inserted -712698321 1612018500
11736 \begin_layout Description
11738 \change_inserted -712698321 1612018547
11739 \begin_inset Flex Code
11742 \begin_layout Plain Layout
11744 \change_inserted -712698321 1612018506
11753 \begin_inset Flex Code
11756 \begin_layout Plain Layout
11758 \change_inserted -712698321 1612018509
11766 ] Defines the layout of an inset if it does not already exist.
11767 If the layout does exist,
11768 this section is ignored.
11770 \begin_inset Quotes eld
11774 \begin_inset Flex Code
11777 \begin_layout Plain Layout
11779 \change_inserted -712698321 1612018500
11788 \begin_inset Quotes erd
11796 \begin_layout Description
11797 \begin_inset Flex Code
11800 \begin_layout Plain Layout
11807 \begin_inset Flex Code
11810 \begin_layout Plain Layout
11817 \begin_inset Flex Code
11820 \begin_layout Plain Layout
11829 \begin_inset space \thinspace{}
11833 \begin_inset Flex Code
11836 \begin_layout Plain Layout
11842 ] Whether the class already provides the feature
11843 \begin_inset Flex Code
11846 \begin_layout Plain Layout
11853 A feature is in general the name of a package (e.
11854 \begin_inset space \thinspace{}
11858 \begin_inset space \space{}
11862 \begin_inset Flex Code
11865 \begin_layout Plain Layout
11872 \begin_inset Flex Code
11875 \begin_layout Plain Layout
11882 \begin_inset space \thinspace{}
11886 \begin_inset space \space{}
11890 \begin_inset Flex Code
11893 \begin_layout Plain Layout
11900 \begin_inset Flex Code
11903 \begin_layout Plain Layout
11911 \begin_inset CommandInset ref
11913 reference "chap:List-of-functions"
11918 for the list of features.
11921 \begin_layout Description
11922 \begin_inset Flex Code
11925 \begin_layout Plain Layout
11932 \begin_inset Flex Code
11935 \begin_layout Plain Layout
11941 ] Indicates that this layout provides the functionality of the module mentioned,
11942 which should be specified by the filename without the
11943 \begin_inset Flex Code
11946 \begin_layout Plain Layout
11953 This will typically be used if the layout includes the module directly,
11954 rather than using the
11955 \begin_inset Flex Code
11958 \begin_layout Plain Layout
11964 tag to indicate that it ought to be used.
11965 It could also be used in a module that provided an alternate implementation of the same functionality.
11968 \begin_layout Description
11969 \begin_inset Flex Code
11972 \begin_layout Plain Layout
11979 \begin_inset Flex Code
11982 \begin_layout Plain Layout
11988 ] Creates a new paragraph style if it does not already exist.
11989 If the style does exist,
11990 this section is ignored.
11992 \begin_inset Quotes eld
11996 \begin_inset Flex Code
11999 \begin_layout Plain Layout
12006 \begin_inset Quotes erd
12012 \begin_layout Description
12013 \begin_inset Flex Code
12016 \begin_layout Plain Layout
12023 \begin_inset Flex Code
12026 \begin_layout Plain Layout
12032 ] Whether the class requires the feature
12033 \begin_inset Flex Code
12036 \begin_layout Plain Layout
12043 Multiple features must be separated by commas.
12044 Note that you can only request supported features.
12046 \begin_inset CommandInset ref
12048 reference "chap:List-of-functions"
12053 for the list of features.).
12054 If you require a package with specific options,
12055 you can additionally use
12056 \begin_inset Flex Code
12059 \begin_layout Plain Layout
12068 \begin_layout Description
12069 \begin_inset Flex Code
12072 \begin_layout Plain Layout
12079 \begin_inset Flex Code
12082 \begin_layout Plain Layout
12088 ] A string that indicates the width of the right margin on the screen,
12091 \begin_inset Quotes eld
12095 \begin_inset Flex Code
12098 \begin_layout Plain Layout
12105 \begin_inset Quotes erd
12111 \begin_layout Description
12112 \begin_inset Flex Code
12115 \begin_layout Plain Layout
12122 \begin_inset Flex Code
12125 \begin_layout Plain Layout
12131 ] Sets which divisions get numbered.
12133 \begin_inset Newline newline
12137 \begin_inset Flex Code
12140 \begin_layout Plain Layout
12146 counter in \SpecialChar LaTeX
12150 \begin_layout Description
12151 \begin_inset Flex Code
12154 \begin_layout Plain Layout
12161 \begin_inset Flex Code
12164 \begin_layout Plain Layout
12173 \begin_inset space \thinspace{}
12177 \begin_inset Flex Code
12180 \begin_layout Plain Layout
12186 ] Whether the class-default should be printing on one or both sides of the paper.
12187 Can be changed in the
12188 \begin_inset Flex Noun
12191 \begin_layout Plain Layout
12192 Document\SpecialChar menuseparator
12201 \begin_layout Description
12202 \begin_inset Flex Code
12205 \begin_layout Plain Layout
12212 \begin_inset Flex Code
12215 \begin_layout Plain Layout
12221 ] This sequence defines a paragraph style.
12222 If the style does not yet exist,
12225 its parameters are modified.
12227 \begin_inset Quotes eld
12231 \begin_inset Flex Code
12234 \begin_layout Plain Layout
12241 \begin_inset Quotes erd
12245 \begin_inset Newline newline
12249 \begin_inset CommandInset ref
12251 reference "subsec:Paragraph-Styles"
12256 for details on paragraph styles.
12257 \change_inserted -712698321 1553617804
12261 \begin_layout Description
12263 \change_inserted -712698321 1553617862
12264 \begin_inset Flex Code
12267 \begin_layout Plain Layout
12269 \change_inserted -712698321 1553617809
12278 \begin_inset Flex Code
12281 \begin_layout Plain Layout
12283 \change_inserted -712698321 1553617805
12291 ] defines the default table style that is used when inserting a table.
12292 The following styles are available:
12296 \begin_layout Itemize
12298 \change_inserted -712698321 1554308039
12299 \begin_inset Flex Code
12302 \begin_layout Plain Layout
12304 \change_inserted -712698321 1554307928
12305 Formal_with_Footline
12314 \begin_inset Quotes eld
12318 \begin_inset Quotes erd
12321 ) style with horizontal lines only,
12322 using a bold top and bottom line,
12323 the first and last row are additionally separated from the table body with a thin middle line.
12326 \begin_layout Itemize
12328 \change_inserted -712698321 1554308087
12329 \begin_inset Flex Code
12332 \begin_layout Plain Layout
12334 \change_inserted -712698321 1554308042
12335 Formal_without_Footline
12344 but the last row is not separated with a middle line from the body.
12347 \begin_layout Itemize
12349 \change_inserted -712698321 1553618031
12350 \begin_inset Flex Code
12353 \begin_layout Plain Layout
12355 \change_inserted -712698321 1553618006
12364 Simple table lines.
12367 \begin_layout Itemize
12369 \change_inserted -712698321 1553618309
12370 \begin_inset Flex Code
12373 \begin_layout Plain Layout
12375 \change_inserted -712698321 1553618031
12385 \begin_inset Flex Code
12388 \begin_layout Plain Layout
12390 \change_inserted -712698321 1553618043
12399 but with the header
12400 \change_deleted 34634807 1619712593
12402 \change_inserted 34634807 1619712594
12404 \change_inserted -712698321 1553618309
12405 offset with a second horizontal line.
12406 This is also the default style of \SpecialChar LyX
12410 \begin_layout Itemize
12412 \change_inserted -712698321 1553618280
12413 \begin_inset Flex Code
12416 \begin_layout Plain Layout
12418 \change_inserted -712698321 1553618261
12427 Table without lines.
12433 \begin_layout Description
12434 \begin_inset Flex Code
12437 \begin_layout Plain Layout
12444 \begin_inset Flex Code
12447 \begin_layout Plain Layout
12453 ] The name of the command or environment to be used with
12454 \begin_inset Flex Code
12457 \begin_layout Plain Layout
12466 \begin_layout Description
12467 \begin_inset Flex Code
12470 \begin_layout Plain Layout
12477 \begin_inset Flex Code
12480 \begin_layout Plain Layout
12490 \begin_inset Flex Code
12493 \begin_layout Plain Layout
12499 ] Indicates what kind of markup is used to define the title of a document.
12501 \begin_inset Flex Code
12504 \begin_layout Plain Layout
12510 means that the macro with name
12511 \begin_inset Flex Code
12514 \begin_layout Plain Layout
12520 will be inserted after the last layout which has
12521 \begin_inset Quotes eld
12525 \begin_inset Flex Code
12528 \begin_layout Plain Layout
12530 \begin_inset space ~
12539 \begin_inset Quotes erd
12544 \begin_inset Flex Code
12547 \begin_layout Plain Layout
12553 corresponds to the case where all layouts which have
12554 \begin_inset Quotes eld
12558 \begin_inset Flex Code
12561 \begin_layout Plain Layout
12563 \begin_inset space ~
12572 \begin_inset Quotes erd
12575 should be enclosed into the
12576 \begin_inset Flex Code
12579 \begin_layout Plain Layout
12588 \begin_layout Description
12589 \begin_inset Flex Code
12592 \begin_layout Plain Layout
12599 \begin_inset Flex Code
12602 \begin_layout Plain Layout
12608 ] Sets which divisions are included in the table of contents.
12610 \begin_inset Flex Code
12613 \begin_layout Plain Layout
12619 counter in \SpecialChar LaTeX
12623 \begin_layout Subsection
12624 \begin_inset Flex Code
12627 \begin_layout Plain Layout
12634 \begin_inset CommandInset label
12636 name "subsec:ClassOptions"
12643 \begin_layout Standard
12645 \begin_inset Flex Code
12648 \begin_layout Plain Layout
12654 section can contain the following entries:
12657 \begin_layout Description
12658 \begin_inset Flex Code
12661 \begin_layout Plain Layout
12668 \begin_inset Flex Code
12671 \begin_layout Plain Layout
12677 ] The list of available font sizes for the document's main font,
12679 \begin_inset Quotes eld
12683 \begin_inset Flex Code
12686 \begin_layout Plain Layout
12693 \begin_inset Quotes erd
12698 \change_inserted -712698321 1565110196
12699 Any number is possible.
12702 \begin_layout Description
12704 \change_inserted -712698321 1565110259
12705 \begin_inset Flex Code
12708 \begin_layout Plain Layout
12710 \change_inserted -712698321 1565110199
12719 \begin_inset Flex Code
12722 \begin_layout Plain Layout
12724 \change_inserted -712698321 1565110196
12732 ] The format for the font size option.
12735 \begin_inset Flex Code
12738 \begin_layout Plain Layout
12740 \change_inserted -712698321 1565110238
12750 \begin_inset Flex Code
12753 \begin_layout Plain Layout
12755 \change_inserted -712698321 1565110248
12763 is a placeholder for the font size.
12768 \begin_layout Description
12770 \change_deleted 5863208 1594239483
12771 \begin_inset Flex Code
12774 \begin_layout Plain Layout
12780 Used to set the DTD line with XML-based output classes.
12782 \begin_inset space \thinspace{}
12787 \begin_inset Quotes eld
12790 -//OASIS//DTD DocBook V4.2//EN
12791 \begin_inset Quotes erd
12795 \change_inserted -712698321 1565101761
12799 \begin_layout Description
12801 \change_inserted -712698321 1565180598
12802 \begin_inset Flex Code
12805 \begin_layout Plain Layout
12807 \change_inserted -712698321 1565101918
12816 \begin_inset Flex Code
12819 \begin_layout Plain Layout
12821 \change_inserted -712698321 1565105399
12822 string="letter|\SpecialChar allowbreak
12823 legal|\SpecialChar allowbreak
12824 executive|\SpecialChar allowbreak
12825 a0|\SpecialChar allowbreak
12826 a1|\SpecialChar allowbreak
12827 a2|\SpecialChar allowbreak
12828 a3|\SpecialChar allowbreak
12829 a4|\SpecialChar allowbreak
12830 a5|\SpecialChar allowbreak
12831 a6|\SpecialChar allowbreak
12832 b0|\SpecialChar allowbreak
12833 b1|\SpecialChar allowbreak
12834 b2|\SpecialChar allowbreak
12835 b3|\SpecialChar allowbreak
12836 b4|\SpecialChar allowbreak
12837 b5|\SpecialChar allowbreak
12838 b6|\SpecialChar allowbreak
12839 c0|\SpecialChar allowbreak
12840 c1|\SpecialChar allowbreak
12841 c2|\SpecialChar allowbreak
12842 c3|\SpecialChar allowbreak
12843 c4|\SpecialChar allowbreak
12844 c5|\SpecialChar allowbreak
12845 c6|\SpecialChar allowbreak
12846 b0j|\SpecialChar allowbreak
12847 b1j|\SpecialChar allowbreak
12848 b2j|\SpecialChar allowbreak
12849 b3j|\SpecialChar allowbreak
12850 b4j|\SpecialChar allowbreak
12851 b5j|\SpecialChar allowbreak
12859 ] The list of available page sizes,
12861 \begin_inset Quotes eld
12865 \begin_inset Flex Code
12868 \begin_layout Plain Layout
12870 \change_inserted -712698321 1565101779
12879 \begin_inset Quotes erd
12884 only the listed sizes are supported.
12885 Other sizes might be entered as custom class option.
12888 \begin_layout Description
12890 \change_inserted -712698321 1565180623
12891 \begin_inset Flex Code
12894 \begin_layout Plain Layout
12896 \change_inserted -712698321 1565180605
12905 \begin_inset Flex Code
12908 \begin_layout Plain Layout
12910 \change_inserted -712698321 1565180601
12918 ] The format for the page size option.
12921 \begin_inset Flex Code
12924 \begin_layout Plain Layout
12926 \change_inserted -712698321 1565180618
12936 \begin_inset Flex Code
12939 \begin_layout Plain Layout
12941 \change_inserted -712698321 1565180601
12949 is a placeholder for the paper size.
12954 \begin_layout Description
12955 \begin_inset Flex Code
12958 \begin_layout Plain Layout
12965 \begin_inset Flex Code
12968 \begin_layout Plain Layout
12969 string="empty|plain|headings|fancy"
12974 ] The list of available page sty\SpecialChar softhyphen
12977 \begin_inset Quotes eld
12981 \begin_inset Flex Code
12984 \begin_layout Plain Layout
12991 \begin_inset Quotes erd
12997 \begin_layout Description
12998 \begin_inset Flex Code
13001 \begin_layout Plain Layout
13008 \begin_inset Flex Code
13011 \begin_layout Plain Layout
13017 ] Some document class options,
13018 separated by a comma,
13019 that will be added to the optional part of the
13020 \begin_inset Flex Code
13023 \begin_layout Plain Layout
13034 \begin_layout Standard
13036 \begin_inset Flex Code
13039 \begin_layout Plain Layout
13045 section must end with
13046 \begin_inset Quotes eld
13050 \begin_inset Flex Code
13053 \begin_layout Plain Layout
13060 \begin_inset Quotes erd
13066 \begin_layout Subsection
13068 \begin_inset CommandInset label
13070 name "subsec:Paragraph-Styles"
13077 \begin_layout Standard
13078 A paragraph style description looks like this:
13082 \begin_layout Plain Layout
13083 Note that this will either define a new style or modify an existing one.
13091 \begin_layout LyX-Code
13098 \begin_layout LyX-Code
13102 \begin_layout LyX-Code
13106 \begin_layout Standard
13107 where the following commands are allowed:
13110 \begin_layout Description
13111 \begin_inset Flex Code
13114 \begin_layout Plain Layout
13121 \begin_inset Flex Code
13124 \begin_layout Plain Layout
13130 =""] This paragraph will appear in the table of contents of the given type.
13131 An empty string disables.
13132 See also the OutlinerName and the IsTocCaption commands.
13137 \begin_layout Description
13138 \begin_inset Flex Code
13141 \begin_layout Plain Layout
13148 \begin_inset Flex Code
13151 \begin_layout Plain Layout
13164 ] Paragraph alignment.
13167 \begin_layout Description
13168 \begin_inset Flex Code
13171 \begin_layout Plain Layout
13178 \begin_inset Flex Code
13181 \begin_layout Plain Layout
13194 ] A comma separated list of permitted alignments.
13195 (Some \SpecialChar LaTeX
13196 styles prohibit certain alignments,
13197 since those wouldn't make sense.
13198 For example a right-aligned or centered enumeration isn't possible.)
13201 \begin_layout Description
13202 \begin_inset Flex Code
13205 \begin_layout Plain Layout
13212 \begin_inset Flex Code
13215 \begin_layout Plain Layout
13221 ] Defines argument number <int> of a command\SpecialChar breakableslash
13222 environment associated with the current style.
13224 \change_inserted -584632292 1615846868
13225 The definition must end with
13226 \begin_inset Flex Code
13229 \begin_layout Plain Layout
13231 \change_inserted -584632292 1615846867
13243 \change_inserted -584632292 1615846880
13245 \begin_inset CommandInset ref
13247 reference "subsec:Arguments"
13255 for more information.
13257 \change_deleted -584632292 1615846694
13258 This is useful for things like section headings,
13259 and only makes sense with \SpecialChar LaTeX
13261 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,
13262 where the number specifies the order of the arguments.
13263 The definition must end with
13264 \begin_inset Flex Code
13267 \begin_layout Plain Layout
13274 So a command with two optional arguments has:
13278 \begin_layout Quote
13280 \change_deleted -584632292 1615846694
13286 \begin_layout Quote
13288 \change_deleted -584632292 1615846694
13294 \begin_layout Quote
13296 \change_deleted -584632292 1615846694
13302 \begin_layout Quote
13304 \change_deleted -584632292 1615846694
13310 \begin_layout Quote
13312 \change_deleted -584632292 1615846694
13318 \begin_layout Quote
13320 \change_deleted -584632292 1615846694
13326 \begin_layout Standard
13328 \change_deleted -584632292 1615846694
13330 \begin_inset Flex Code
13333 \begin_layout Plain Layout
13340 the following specifications are possible:
13343 \begin_layout Itemize
13345 \change_deleted -584632292 1615846694
13346 \begin_inset Flex Code
13349 \begin_layout Plain Layout
13356 \begin_inset Flex Code
13359 \begin_layout Plain Layout
13365 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
13366 \begin_inset Flex Code
13369 \begin_layout Plain Layout
13377 you can define an accelerator by appending the respective character to the string,
13379 \begin_inset Quotes eld
13383 \begin_inset Quotes erd
13387 \begin_inset space \thinspace{}
13391 \begin_inset space \space{}
13395 \begin_inset Quotes eld
13399 \begin_inset Flex Code
13402 \begin_layout Plain Layout
13409 \begin_inset Quotes erd
13415 \begin_layout Itemize
13417 \change_deleted -584632292 1615846694
13418 \begin_inset Flex Code
13421 \begin_layout Plain Layout
13428 \begin_inset Flex Code
13431 \begin_layout Plain Layout
13437 A separate string for the menu.
13438 You can define an accelerator by appending the respective character to the string,
13440 \begin_inset Quotes eld
13444 \begin_inset Quotes erd
13448 \begin_inset space \thinspace{}
13452 \begin_inset space \space{}
13456 \begin_inset Quotes eld
13460 \begin_inset Flex Code
13463 \begin_layout Plain Layout
13470 \begin_inset Quotes erd
13474 This specification is optional.
13475 If it is not given the
13476 \begin_inset Flex Code
13479 \begin_layout Plain Layout
13485 will be used instead for the menu.
13488 \begin_layout Itemize
13490 \change_deleted -584632292 1615846694
13491 \begin_inset Flex Code
13494 \begin_layout Plain Layout
13501 \begin_inset Flex Code
13504 \begin_layout Plain Layout
13510 A longer explanatory text that appears in the tooltip when hovering over the argument inset.
13513 \begin_layout Itemize
13515 \change_deleted -584632292 1615846694
13516 \begin_inset Flex Code
13519 \begin_layout Plain Layout
13526 \begin_inset Flex Code
13529 \begin_layout Plain Layout
13538 \begin_inset space \thinspace{}
13542 \begin_inset Flex Code
13545 \begin_layout Plain Layout
13551 ] Declare if this is a mandatory (1) or an optional (0) argument.
13552 Mandatory arguments will be output empty if not given,
13553 while optional arguments will not be output at all.
13555 mandatory arguments are delimited by
13556 \begin_inset Flex Code
13559 \begin_layout Plain Layout
13566 while optional arguments are delimited by
13567 \begin_inset Flex Code
13570 \begin_layout Plain Layout
13579 \begin_layout Itemize
13581 \change_deleted -584632292 1615846694
13582 \begin_inset Flex Code
13585 \begin_layout Plain Layout
13587 \change_inserted -712698321 1555579780
13596 \begin_inset Flex Code
13599 \begin_layout Plain Layout
13601 \change_inserted -712698321 1555579780
13609 Option to define a different command (from the default
13610 \begin_inset Flex Code
13613 \begin_layout Plain Layout
13615 \change_inserted -712698321 1555579780
13627 ) to be used for line breaks.
13628 The initial backslash must not be specified.
13631 \begin_layout Itemize
13633 \change_deleted -584632292 1615846694
13634 \begin_inset Flex Code
13637 \begin_layout Plain Layout
13644 \begin_inset Flex Code
13647 \begin_layout Plain Layout
13653 defines another argument (by its number) which this argument requires to be output if it is itself output.
13655 \begin_inset space \thinspace{}
13659 in \SpecialChar LaTeX
13661 optional arguments often require previous optional arguments to be output (at least empty),
13663 \begin_inset Flex Code
13666 \begin_layout Plain Layout
13669 command[][argument]{text}
13675 This can be achieved by the statement
13676 \begin_inset Flex Code
13679 \begin_layout Plain Layout
13686 \begin_inset Flex Code
13689 \begin_layout Plain Layout
13698 \begin_layout Itemize
13700 \change_deleted -584632292 1615846694
13701 \begin_inset Flex Code
13704 \begin_layout Plain Layout
13711 \begin_inset Flex Code
13714 \begin_layout Plain Layout
13720 defines a custom left delimiter (instead of
13721 \begin_inset Flex Code
13724 \begin_layout Plain Layout
13731 \begin_inset Flex Code
13734 \begin_layout Plain Layout
13741 A line break in the output can be indicated by
13742 \begin_inset Flex Code
13745 \begin_layout Plain Layout
13754 \begin_layout Itemize
13756 \change_deleted -584632292 1615846694
13757 \begin_inset Flex Code
13760 \begin_layout Plain Layout
13767 \begin_inset Flex Code
13770 \begin_layout Plain Layout
13776 defines a custom right delimiter (instead of
13777 \begin_inset Flex Code
13780 \begin_layout Plain Layout
13787 \begin_inset Flex Code
13790 \begin_layout Plain Layout
13797 A line break in the output can be indicated by
13798 \begin_inset Flex Code
13801 \begin_layout Plain Layout
13810 \begin_layout Itemize
13812 \change_deleted -584632292 1615846694
13813 \begin_inset Flex Code
13816 \begin_layout Plain Layout
13823 \begin_inset Flex Code
13826 \begin_layout Plain Layout
13832 defines an argument that is inserted if and only if no user-specified arguments were given,
13834 \begin_inset space \thinspace{}
13838 \begin_inset space \space{}
13841 if no argument inset has been inserted (note that also an empty argument inset omits the DefaultArg).
13842 Multiple arguments need to be separated by comma.
13845 \begin_layout Itemize
13847 \change_deleted -584632292 1615846694
13848 \begin_inset Flex Code
13851 \begin_layout Plain Layout
13858 \begin_inset Flex Code
13861 \begin_layout Plain Layout
13867 defines an argument that is inserted in any case (alone or in addition to user-specified arguments).
13868 Multiple arguments need to be separated by comma.
13871 \begin_layout Itemize
13873 \change_deleted -584632292 1615846694
13874 \begin_inset Flex Code
13877 \begin_layout Plain Layout
13883 The font used for the argument content,
13885 \begin_inset CommandInset ref
13887 reference "subsec:Font-description"
13895 \begin_layout Itemize
13897 \change_deleted -584632292 1615846694
13898 \begin_inset Flex Code
13901 \begin_layout Plain Layout
13903 \change_inserted -712698321 1559484228
13912 \begin_inset Flex Code
13915 \begin_layout Plain Layout
13917 \change_inserted -712698321 1559484228
13928 \begin_inset space \thinspace{}
13932 \begin_inset Flex Code
13935 \begin_layout Plain Layout
13937 \change_inserted -712698321 1559484228
13945 ] As with paragraph styles,
13947 \begin_inset CommandInset ref
13949 reference "subsec:Paragraph-Styles"
13957 \begin_layout Itemize
13959 \change_deleted -584632292 1615846694
13960 \begin_inset Flex Code
13963 \begin_layout Plain Layout
13969 The font used for the label;
13971 \begin_inset CommandInset ref
13973 reference "subsec:Font-description"
13981 \begin_layout Itemize
13983 \change_deleted -584632292 1615846694
13984 \begin_inset Flex Code
13987 \begin_layout Plain Layout
13994 \begin_inset Flex Code
13997 \begin_layout Plain Layout
14009 ] describes the rendering style used for the inset's frame and buttons.
14012 \begin_layout Itemize
14014 \change_deleted -584632292 1615846694
14015 \begin_inset Flex Code
14018 \begin_layout Plain Layout
14025 \begin_inset Flex Code
14028 \begin_layout Plain Layout
14035 \begin_inset Flex Code
14038 \begin_layout Plain Layout
14045 this argument is automatically inserted when the respective style is selected.
14047 \change_deleted -712698321 1559484200
14049 only one argument per style\SpecialChar breakableslash
14050 layout can be automatically inserted.
14051 \change_deleted -584632292 1615846694
14055 \begin_layout Itemize
14057 \change_deleted -584632292 1615846694
14058 \begin_inset Flex Code
14061 \begin_layout Plain Layout
14063 \change_inserted -712698321 1559490711
14072 \begin_inset Flex Code
14075 \begin_layout Plain Layout
14077 \change_inserted -712698321 1559490703
14086 \begin_inset Flex Code
14089 \begin_layout Plain Layout
14091 \change_inserted -712698321 1559490703
14100 this argument will be inserted on a new line with
14101 \begin_inset Flex Code
14104 \begin_layout Plain Layout
14106 \change_inserted -712698321 1559491402
14114 (only available within Flex insets).
14117 \begin_layout Itemize
14119 \change_deleted -584632292 1615846694
14120 \begin_inset Flex Code
14123 \begin_layout Plain Layout
14130 \begin_inset Flex Code
14133 \begin_layout Plain Layout
14140 \begin_inset Flex Code
14143 \begin_layout Plain Layout
14150 this argument will be inserted with a copy of the co-text (either selected text or the whole paragraph) as content.
14153 \begin_layout Itemize
14155 \change_deleted -584632292 1615846694
14156 \begin_inset Flex Code
14159 \begin_layout Plain Layout
14166 \begin_inset Flex Code
14169 \begin_layout Plain Layout
14181 ] Whether the contents of this argument should be output in raw form,
14182 meaning without special translations that \SpecialChar LaTeX
14186 \begin_inset Flex Code
14189 \begin_layout Plain Layout
14195 status is inherited by the inset or paragraph layout the argument belongs to,
14196 true and false change the status for the given argument only.
14199 \begin_layout Itemize
14201 \change_deleted -584632292 1615846694
14202 \begin_inset Flex Code
14205 \begin_layout Plain Layout
14212 \begin_inset Flex Code
14215 \begin_layout Plain Layout
14216 string of characters
14225 Defines individual characters
14226 \begin_inset Newline linebreak
14229 that should be output in raw form,
14230 meaning without special translations that \SpecialChar LaTeX
14233 contrary to PassThru,
14234 this needs to be explicitly defined for arguments.
14236 arguments do not inherit PassThruChars from their parent inset or layout.
14239 \begin_layout Itemize
14241 \change_deleted -584632292 1615846694
14242 \begin_inset Flex Code
14245 \begin_layout Plain Layout
14252 \begin_inset Flex Code
14255 \begin_layout Plain Layout
14264 \begin_inset space \thinspace{}
14268 \begin_inset Flex Code
14271 \begin_layout Plain Layout
14277 ] If this is set to 1,
14278 the argument will output its content in the corresponding item in the table of contents.
14282 \begin_layout Standard
14284 \change_deleted -584632292 1615846694
14286 the text entered in the \SpecialChar LyX
14287 workarea in the respective layout is the last (mandatory) argument of a command if the
14288 \begin_inset Flex Code
14291 \begin_layout Plain Layout
14298 \begin_inset Flex Code
14301 \begin_layout Plain Layout
14309 arguments with the prefix
14310 \begin_inset Flex Code
14313 \begin_layout Plain Layout
14319 are output after this workarea argument.
14320 Note that post-argument numbering restarts at 1,
14321 so the first argument following the workarea argument is
14322 \begin_inset Flex Code
14325 \begin_layout Plain Layout
14332 Post-arguments are ignored in any other
14333 \begin_inset Flex Code
14336 \begin_layout Plain Layout
14343 \begin_inset Flex Code
14346 \begin_layout Plain Layout
14355 \begin_layout Standard
14357 \change_deleted -584632292 1615846694
14359 \begin_inset Flex Code
14362 \begin_layout Plain Layout
14371 \begin_inset Flex Code
14374 \begin_layout Plain Layout
14383 \begin_inset Flex Code
14386 \begin_layout Plain Layout
14392 followed by the number (e.
14393 \begin_inset space \thinspace{}
14397 \begin_inset space \space{}
14401 \begin_inset Flex Code
14404 \begin_layout Plain Layout
14413 \begin_layout Standard
14415 \change_deleted -584632292 1615846694
14417 there is a special argument type with the prefix
14418 \begin_inset Flex Code
14421 \begin_layout Plain Layout
14423 \change_inserted -712698321 1534487844
14432 It is not really an argument,
14433 but uses the argument interface (thus,
14434 the prefix is also followed by a number,
14436 \begin_inset space \thinspace{}
14441 \begin_inset Flex Code
14444 \begin_layout Plain Layout
14446 \change_inserted -712698321 1534488412
14447 Argument listpreamble:1
14455 As the name implies,
14456 it is targeted at lists such as
14476 Its content will be output at the list start,
14478 \begin_inset Flex Code
14481 \begin_layout Plain Layout
14483 \change_inserted -712698321 1534488058
14494 on an own line (a place that is otherwise not accessible in \SpecialChar LyX
14497 users can insert redefinitions (of lengths etc.) to individual lists.
14499 these arguments do not have a delimiter.
14505 \begin_layout Description
14506 \begin_inset Flex Code
14509 \begin_layout Plain Layout
14515 Includes a comma-separated list of layouts that should be nested in and after the current layout.
14516 Only makes sense for nestable layouts (such as environments).
14518 \begin_inset Quotes eld
14522 \begin_inset Flex Code
14525 \begin_layout Plain Layout
14532 \begin_inset Quotes erd
14537 \begin_inset Flex Code
14540 \begin_layout Plain Layout
14549 \begin_layout Description
14550 \begin_inset Flex Code
14553 \begin_layout Plain Layout
14559 Note that this will completely override any prior
14560 \begin_inset Flex Code
14563 \begin_layout Plain Layout
14569 declaration for this style.
14571 \begin_inset Quotes eld
14575 \begin_inset Flex Code
14578 \begin_layout Plain Layout
14585 \begin_inset Quotes erd
14590 \begin_inset CommandInset ref
14592 reference "subsec:I18n"
14597 for details on its use.
14600 \begin_layout Description
14601 \begin_inset Flex Code
14604 \begin_layout Plain Layout
14611 \begin_inset Flex Code
14614 \begin_layout Plain Layout
14624 \begin_layout Plain Layout
14625 Note that a `float' here is a real number,
14632 The vertical space with which the last of a chain of paragraphs with this style is separated from the following paragraph.
14633 If the next paragraph has another style,
14634 the separations are not simply added,
14635 but the maximum is taken.
14638 \begin_layout Description
14639 \begin_inset Flex Code
14642 \begin_layout Plain Layout
14649 \begin_inset Flex Code
14652 \begin_layout Plain Layout
14658 ] The category for this style.
14659 This is used to group related styles in the style combobox on the toolbar.
14660 Any string can be used,
14661 but you may want to use existing categories with your own styles.
14665 \begin_layout Description
14667 \change_deleted 1075283030 1672014981
14668 \begin_inset Flex Code
14671 \begin_layout Plain Layout
14677 Depth of XML command.
14678 Used only with XML-type formats.
14681 \begin_layout Description
14682 \begin_inset Flex Code
14685 \begin_layout Plain Layout
14692 \begin_inset Flex Code
14695 \begin_layout Plain Layout
14701 ] Copies all the features of an existing style into the current one.
14703 \change_inserted -584632292 1678808972
14704 Note that this copies the style as it is defined at that point.
14705 Later changes to it will not affect styles into which it has been copied.
14710 \begin_layout Description
14712 \change_inserted 1075283030 1672014806
14713 \begin_inset Flex Code
14716 \begin_layout Plain Layout
14718 \change_inserted 1075283030 1671679781
14719 DocBookGenerateTitle
14727 \begin_inset Flex Code
14730 \begin_layout Plain Layout
14732 \change_inserted 1075283030 1672014763
14741 \begin_inset Flex Code
14744 \begin_layout Plain Layout
14746 \change_inserted 1075283030 1672014789
14754 tag after the wrapper tag.
14755 This parameter should only be used with
14756 \begin_inset Flex Code
14759 \begin_layout Plain Layout
14761 \change_inserted 1075283030 1671679828
14770 otherwise the title will be output
14774 the contents of the environment.
14775 The generated title is the same as the LyXHTML label:
14776 a combination of the environment type and its number.
14777 A major use is when DocBook has no close mapping for LaTeX environments and users must fallback to using a generic container such as
14778 \begin_inset Flex Code
14781 \begin_layout Plain Layout
14783 \change_inserted 1075283030 1672014801
14792 which requires a title although there is none in LaTeX.
14793 This feature is heavily used for theorem-like environments.
14798 \begin_layout Description
14799 \begin_inset Flex Code
14802 \begin_layout Plain Layout
14809 \begin_inset Flex Code
14812 \begin_layout Plain Layout
14818 ] The name of a style whose preamble should be output
14823 This allows to ensure some ordering of the preamble snippets when macros definitions depend on one another.
14827 \begin_layout Plain Layout
14829 besides that functionality,
14830 there is no way to ensure any ordering of preambles.
14831 The ordering that you see in a given version of \SpecialChar LyX
14832 may change without warning in later versions.
14840 \begin_layout Description
14841 \begin_inset Flex Code
14844 \begin_layout Plain Layout
14851 \begin_inset Flex Code
14854 \begin_layout Plain Layout
14867 ] The type of label that stands at the end of the paragraph (or sequence of paragraphs if
14868 \begin_inset Flex Code
14871 \begin_layout Plain Layout
14878 \begin_inset Newline newline
14882 \begin_inset Flex Code
14885 \begin_layout Plain Layout
14893 \begin_inset Flex Code
14896 \begin_layout Plain Layout
14903 \begin_inset Flex Code
14906 \begin_layout Plain Layout
14914 \begin_inset Flex Code
14917 \begin_layout Plain Layout
14924 \begin_inset Quotes eld
14928 \begin_inset Quotes erd
14933 \begin_inset Flex Code
14936 \begin_layout Plain Layout
14943 \begin_inset space \space{}
14947 \begin_inset Flex Code
14950 \begin_layout Plain Layout
14956 ) is a white (resp.
14957 \begin_inset space ~
14960 black) square suitable for end of proof markers,
14962 \begin_inset Flex Code
14965 \begin_layout Plain Layout
14971 is an explicit text string.
14974 \begin_layout Description
14975 \begin_inset Flex Code
14978 \begin_layout Plain Layout
14985 \begin_inset Flex Code
14988 \begin_layout Plain Layout
14994 ] The string used for a label with a
14995 \begin_inset Flex Code
14998 \begin_layout Plain Layout
15005 \begin_inset Newline newline
15009 \begin_inset Flex Code
15012 \begin_layout Plain Layout
15022 \begin_layout Description
15023 \begin_inset Flex Code
15026 \begin_layout Plain Layout
15032 The font used for both the text body
15038 \begin_inset CommandInset ref
15040 reference "subsec:Font-description"
15046 Note that defining this font automatically defines the
15047 \begin_inset Flex Code
15050 \begin_layout Plain Layout
15057 So you should define this one first if you also want to define
15058 \begin_inset Flex Code
15061 \begin_layout Plain Layout
15070 \begin_layout Description
15071 \begin_inset Flex Code
15074 \begin_layout Plain Layout
15081 \begin_inset Flex Code
15084 \begin_layout Plain Layout
15090 ] Used for backporting new styles to stable \SpecialChar LyX
15092 The first stable version that supports this tag is \SpecialChar LyX
15094 The argument is a number which may either be 0,
15095 -1 or any value greater than zero.
15097 \begin_inset Flex Code
15100 \begin_layout Plain Layout
15106 flag of a style is greater than zero,
15107 it will always be written to the document header.
15108 If a .lyx file is read,
15109 the style definitions from the document header are added to the document class.
15110 Therefore even older \SpecialChar LyX
15111 versions can handle the style.
15113 \begin_inset Flex Code
15116 \begin_layout Plain Layout
15122 is a version number:
15123 if the style is read,
15124 and the version number is less than the version number of the already existing style in the document class,
15125 the new style is ignored.
15126 If the version number is greater,
15127 the new style replaces the existing style.
15128 A value of -1 means an infinite version number,
15130 \begin_inset space \thinspace{}
15134 \begin_inset space \space{}
15137 the style is always used.
15140 \begin_layout Description
15141 \begin_inset Flex Code
15144 \begin_layout Plain Layout
15151 \begin_inset Flex Code
15154 \begin_layout Plain Layout
15163 \begin_inset space \thinspace{}
15167 \begin_inset Flex Code
15170 \begin_layout Plain Layout
15176 ] Usually \SpecialChar LyX
15177 does not allow you to insert more than one space between words,
15178 since a space is considered as the separation between two words,
15179 not a character or symbol of its own.
15180 This is a very fine thing but sometimes annoying,
15182 when typing program code or plain \SpecialChar LaTeX
15186 \begin_inset Flex Code
15189 \begin_layout Plain Layout
15197 \change_deleted -495245474 1550490105
15202 \change_deleted 177693 1654669077
15204 \change_inserted 177693 1654669079
15208 \change_deleted 177693 1654669082
15210 \change_inserted 177693 1654669082
15213 for the additional blanks when
15214 \change_deleted 34634807 1619626461
15218 \change_inserted -495245474 1550490096
15220 \begin_inset Flex Code
15223 \begin_layout Plain Layout
15225 \change_inserted -495245474 1550490089
15234 \change_deleted -495245474 1550490116
15235 another mode than \SpecialChar LaTeX
15238 \change_inserted -495245474 1550247760
15240 \begin_inset Flex Code
15243 \begin_layout Plain Layout
15245 \change_inserted -495245474 1550247736
15254 \begin_inset Flex Code
15257 \begin_layout Plain Layout
15259 \change_inserted -495245474 1550247755
15272 \begin_layout Description
15273 \begin_inset Flex Code
15276 \begin_layout Plain Layout
15282 These tags are used with XHTML output.
15284 \begin_inset CommandInset ref
15286 reference "subsec:Paragraph-Style-XHTML"
15294 \begin_layout Description
15296 \change_deleted 1075283030 1672014684
15297 \begin_inset Flex Code
15300 \begin_layout Plain Layout
15306 [FIXME] (Used only with XML-type formats.)
15311 \begin_layout Description
15312 \begin_inset Flex Code
15315 \begin_layout Plain Layout
15322 \begin_inset Flex Code
15325 \begin_layout Plain Layout
15334 \begin_inset space \thinspace{}
15338 \begin_inset Flex Code
15341 \begin_layout Plain Layout
15348 \begin_inset Flex Code
15351 \begin_layout Plain Layout
15358 marks the style as to be included in the document preamble and not in the document body.
15359 This is useful for document classes that want such information as the title and author to appear in the preamble.
15360 Note that this works only for styles for which the
15361 \begin_inset Flex Code
15364 \begin_layout Plain Layout
15371 \begin_inset Flex Code
15374 \begin_layout Plain Layout
15381 \begin_inset Flex Code
15384 \begin_layout Plain Layout
15393 \begin_layout Description
15394 \begin_inset Flex Code
15397 \begin_layout Plain Layout
15404 \begin_inset Flex Code
15407 \begin_layout Plain Layout
15416 \begin_inset space \thinspace{}
15420 \begin_inset Flex Code
15423 \begin_layout Plain Layout
15430 \begin_inset Flex Code
15433 \begin_layout Plain Layout
15440 marks the style as being part of a title block (see also the
15441 \begin_inset Flex Code
15444 \begin_layout Plain Layout
15451 \begin_inset Flex Code
15454 \begin_layout Plain Layout
15463 \begin_layout Description
15464 \begin_inset Flex Code
15467 \begin_layout Plain Layout
15473 Includes a comma-separated list of layouts after which this one should be nested.
15474 Only makes sense with regard to nestable layouts (such as environments).
15476 \begin_inset Quotes eld
15480 \begin_inset Flex Code
15483 \begin_layout Plain Layout
15490 \begin_inset Quotes erd
15495 \begin_inset Flex Code
15498 \begin_layout Plain Layout
15507 \begin_layout Description
15508 \begin_inset Flex Code
15511 \begin_layout Plain Layout
15518 \begin_inset Flex Code
15521 \begin_layout Plain Layout
15530 \begin_inset space \thinspace{}
15534 \begin_inset Flex Code
15537 \begin_layout Plain Layout
15543 ] If this is set to 1 and AddToToc is enabled,
15544 the paragraph adds a summary of its contents in its item in the table of contents.
15551 \begin_layout Description
15552 \begin_inset Flex Code
15555 \begin_layout Plain Layout
15562 \begin_inset Flex Code
15565 \begin_layout Plain Layout
15571 ] The \SpecialChar LaTeX
15572 command sequence declaring an item in a list.
15573 The command is to be defined without the preceding backslash (the default is
15574 \begin_inset Quotes eld
15578 \begin_inset Quotes erd
15583 \begin_inset Flex Code
15586 \begin_layout Plain Layout
15594 in the \SpecialChar LaTeX
15598 \begin_layout Description
15599 \begin_inset Flex Code
15602 \begin_layout Plain Layout
15609 \begin_inset Flex Code
15612 \begin_layout Plain Layout
15618 ] This provides extra space between paragraphs that have the same style.
15619 If you put other styles into an environment,
15620 each is separated with the environment's
15621 \begin_inset Flex Code
15624 \begin_layout Plain Layout
15631 But the whole items of the environment are additionally separated with this
15632 \begin_inset Flex Code
15635 \begin_layout Plain Layout
15642 Note that this is a
15647 \begin_layout Description
15649 \change_deleted 1075283030 1672014680
15650 \begin_inset Flex Code
15653 \begin_layout Plain Layout
15659 [FIXME] (Used only with XML-type formats.)
15664 \begin_layout Description
15665 \begin_inset Flex Code
15668 \begin_layout Plain Layout
15675 \begin_inset Flex Code
15678 \begin_layout Plain Layout
15687 \begin_inset space \thinspace{}
15691 \begin_inset Flex Code
15694 \begin_layout Plain Layout
15700 ] Usually \SpecialChar LyX
15701 does not allow you to leave a paragraph empty,
15702 since it would lead to empty \SpecialChar LaTeX
15704 There are some cases where this could be desirable however:
15705 in a letter template,
15706 the required fields can be provided as empty fields,
15707 so that people do not forget them;
15708 in some special classes,
15709 a style can be used as some kind of break,
15710 which does not contain actual text.
15713 \begin_layout Description
15714 \begin_inset Flex Code
15717 \begin_layout Plain Layout
15724 \begin_inset Flex Code
15727 \begin_layout Plain Layout
15733 ] The vertical space between the label and the text body.
15734 Only used for labels that are above the text body (
15735 \begin_inset Flex Code
15738 \begin_layout Plain Layout
15745 \begin_inset Newline newline
15749 \begin_inset Flex Code
15752 \begin_layout Plain Layout
15753 Centered_Top_Environment
15761 \begin_layout Description
15762 \begin_inset Flex Code
15765 \begin_layout Plain Layout
15772 \begin_inset Flex Code
15775 \begin_layout Plain Layout
15781 ] The name of the counter for automatic numbering.
15782 In order to have the counter appear with your label,
15783 you will need to reference it in the
15784 \begin_inset Flex Code
15787 \begin_layout Plain Layout
15796 This will work with
15797 \begin_inset Flex Code
15800 \begin_layout Plain Layout
15808 \begin_inset Flex Code
15811 \begin_layout Plain Layout
15819 \begin_inset Flex Code
15822 \begin_layout Plain Layout
15829 \begin_inset Flex Code
15832 \begin_layout Plain Layout
15840 \begin_inset Newline newline
15848 \begin_inset Flex Code
15851 \begin_layout Plain Layout
15858 \begin_inset Flex Code
15861 \begin_layout Plain Layout
15868 though this case is a bit complicated.
15869 Suppose you declare
15870 \begin_inset Quotes eld
15874 \begin_inset Flex Code
15877 \begin_layout Plain Layout
15878 LabelCounter myenum
15884 \begin_inset Quotes erd
15888 Then the actual counters used are
15889 \begin_inset Flex Code
15892 \begin_layout Plain Layout
15900 \begin_inset Flex Code
15903 \begin_layout Plain Layout
15911 \begin_inset Flex Code
15914 \begin_layout Plain Layout
15921 \begin_inset Flex Code
15924 \begin_layout Plain Layout
15931 much as in \SpecialChar LaTeX
15933 These counters must all be declared separately.
15934 \begin_inset Newline newline
15938 \begin_inset CommandInset ref
15940 reference "subsec:Counters"
15945 for details on counters.
15948 \begin_layout Description
15949 \begin_inset Flex Code
15952 \begin_layout Plain Layout
15958 The font used for the label.
15960 \begin_inset CommandInset ref
15962 reference "subsec:Font-description"
15970 \begin_layout Description
15971 \begin_inset Flex Code
15974 \begin_layout Plain Layout
15981 \begin_inset Flex Code
15984 \begin_layout Plain Layout
15990 ] Text that indicates how far a label should be indented.
15993 \begin_layout Description
15994 \begin_inset Flex Code
15997 \begin_layout Plain Layout
16004 \begin_inset Flex Code
16007 \begin_layout Plain Layout
16013 ] Text that indicates the amount of horizontal space between the label and the text body.
16014 Only used for labels that are not above the text body.
16017 \begin_layout Description
16018 \begin_inset Flex Code
16021 \begin_layout Plain Layout
16028 \begin_inset Flex Code
16031 \begin_layout Plain Layout
16037 ] The string used for the label.
16039 \begin_inset Flex Code
16042 \begin_layout Plain Layout
16049 this string can be contain the special formatting commands described in
16050 \begin_inset CommandInset ref
16052 reference "subsec:Counters"
16060 \begin_layout Description
16061 \begin_inset Flex Code
16064 \begin_layout Plain Layout
16065 LabelStringAppendix
16071 \begin_inset Flex Code
16074 \begin_layout Plain Layout
16080 ] This is used inside the appendix instead of
16081 \begin_inset Newline newline
16085 \begin_inset Flex Code
16088 \begin_layout Plain Layout
16096 \begin_inset Flex Code
16099 \begin_layout Plain Layout
16106 \begin_inset Newline newline
16110 \begin_inset Flex Code
16113 \begin_layout Plain Layout
16114 LabelStringAppendix
16120 \change_deleted 1075283030 1672015070
16124 \begin_layout Description
16126 \change_deleted 1075283030 1672015070
16127 \begin_inset Flex Code
16130 \begin_layout Plain Layout
16136 [FIXME] (Used only with XML-type formats.)
16141 \begin_layout Description
16142 \begin_inset Flex Code
16145 \begin_layout Plain Layout
16152 \begin_inset Flex Code
16155 \begin_layout Plain Layout
16165 \begin_inset Newline newline
16171 \begin_inset Newline newline
16184 \begin_layout Description
16185 \begin_inset Flex Code
16188 \begin_layout Plain Layout
16194 means the label is the very first word (up to the first real blank).
16196 \change_deleted 177693 1654669087
16198 \change_inserted 177693 1654669089
16201 spaces if you want more than one word as the label.
16205 \begin_layout Description
16206 \begin_inset Flex Code
16209 \begin_layout Plain Layout
16215 means the label is simply what is declared as
16216 \begin_inset Flex Code
16219 \begin_layout Plain Layout
16226 This will be displayed
16227 \begin_inset Quotes eld
16231 \begin_inset Quotes erd
16235 at the beginning of the paragraph.
16237 \begin_inset Flex Code
16240 \begin_layout Plain Layout
16247 \begin_inset Flex Code
16250 \begin_layout Plain Layout
16257 then it will be displayed only in the first paragraph of any sequence of paragraphs with the same
16258 \begin_inset Flex Code
16261 \begin_layout Plain Layout
16270 \begin_layout Description
16271 \begin_inset Flex Code
16274 \begin_layout Plain Layout
16281 \begin_inset space ~
16285 \begin_inset space ~
16289 \begin_inset Flex Code
16292 \begin_layout Plain Layout
16298 are special cases of
16299 \begin_inset Flex Code
16302 \begin_layout Plain Layout
16309 The label will be printed above the paragraph either at the beginning of the line or centered.
16312 \begin_layout Description
16313 \begin_inset Flex Code
16316 \begin_layout Plain Layout
16322 is a special case for the caption-labels
16323 \begin_inset Quotes eld
16327 \begin_inset Quotes erd
16331 \begin_inset Quotes eld
16335 \begin_inset Quotes erd
16339 \begin_inset Newline newline
16343 \begin_inset Flex Code
16346 \begin_layout Plain Layout
16352 means the (hardcoded) label string depends on the kind of float:
16353 It is hardcoded to be `FloatType N',
16354 where N is the value of the counter associated with the float.
16355 For the case that a caption is inserted outside of a float the
16356 \begin_inset Flex Code
16359 \begin_layout Plain Layout
16366 \begin_inset Quotes eld
16370 \begin_inset Quotes erd
16376 \begin_layout Description
16377 \begin_inset Flex Code
16380 \begin_layout Plain Layout
16386 produces the usual sort of enumeration labels.
16387 The number type needs to be set in the
16393 \begin_inset CommandInset ref
16395 reference "subsec:Counters"
16403 \begin_layout Description
16404 \begin_inset Flex Code
16407 \begin_layout Plain Layout
16413 produces various bullets at the different levels.
16414 The bullet types displayed can be set via
16415 \begin_inset Flex Noun
16418 \begin_layout Plain Layout
16419 Document\SpecialChar menuseparator
16420 Settings\SpecialChar menuseparator
16429 \begin_layout Description
16430 \begin_inset Flex Code
16433 \begin_layout Plain Layout
16439 should be used only with
16440 \begin_inset Flex Code
16443 \begin_layout Plain Layout
16444 LatexType BibEnvironment
16453 \begin_layout Description
16454 \begin_inset Flex Code
16457 \begin_layout Plain Layout
16463 Note that this will completely override any prior
16464 \begin_inset Flex Code
16467 \begin_layout Plain Layout
16473 declaration for this style.
16475 \begin_inset Quotes eld
16479 \begin_inset Flex Code
16482 \begin_layout Plain Layout
16489 \begin_inset Quotes erd
16494 \begin_inset CommandInset ref
16496 reference "subsec:I18n"
16501 for details on its use.
16504 \begin_layout Description
16505 \begin_inset Flex Code
16508 \begin_layout Plain Layout
16515 \begin_inset Flex Code
16518 \begin_layout Plain Layout
16524 ] The name of the corresponding \SpecialChar LaTeX
16526 Either the environment or command name.
16529 \begin_layout Description
16530 \begin_inset Flex Code
16533 \begin_layout Plain Layout
16540 \begin_inset Flex Code
16543 \begin_layout Plain Layout
16549 ] An optional parameter for the corresponding
16550 \begin_inset Flex Code
16553 \begin_layout Plain Layout
16560 This parameter cannot be changed from within \SpecialChar LyX
16562 \begin_inset Flex Code
16565 \begin_layout Plain Layout
16571 for customizable parameters).
16572 This will be output as is after all \SpecialChar LaTeX
16574 \begin_inset Flex Code
16577 \begin_layout Plain Layout
16586 \begin_layout Description
16587 \begin_inset Flex Code
16590 \begin_layout Plain Layout
16597 \begin_inset Flex Code
16600 \begin_layout Plain Layout
16609 \begin_inset Newline newline
16618 ] How the style should be translated into \SpecialChar LaTeX
16623 \begin_layout Plain Layout
16624 \begin_inset Flex Code
16627 \begin_layout Plain Layout
16633 is perhaps a bit misleading,
16634 since these rules apply to SGML classes,
16636 Visit the SGML class files for specific examples.
16645 \begin_layout Description
16646 \begin_inset Flex Code
16649 \begin_layout Plain Layout
16655 means nothing special.
16658 \begin_layout Description
16659 \begin_inset Flex Code
16662 \begin_layout Plain Layout
16669 \begin_inset Flex Code
16672 \begin_layout Plain Layout
16679 {\SpecialChar ldots
16688 \begin_layout Description
16689 \begin_inset Flex Code
16692 \begin_layout Plain Layout
16699 \begin_inset Flex Code
16702 \begin_layout Plain Layout
16709 }\SpecialChar ldots
16725 \begin_layout Description
16726 \begin_inset Flex Code
16729 \begin_layout Plain Layout
16736 \begin_inset Flex Code
16739 \begin_layout Plain Layout
16747 \begin_inset Flex Code
16750 \begin_layout Plain Layout
16758 is generated for each paragraph of this environment.
16762 \begin_layout Description
16763 \begin_inset Flex Code
16766 \begin_layout Plain Layout
16773 \begin_inset Flex Code
16776 \begin_layout Plain Layout
16784 \begin_inset Newline newline
16788 \begin_inset Flex Code
16791 \begin_layout Plain Layout
16797 is passed as an argument to the environment.
16798 \begin_inset Newline newline
16802 \begin_inset Flex Code
16805 \begin_layout Plain Layout
16811 can be defined in the
16812 \begin_inset Flex Noun
16815 \begin_layout Plain Layout
16816 Edit\SpecialChar menuseparator
16818 \begin_inset space ~
16829 \begin_layout Description
16830 \begin_inset Flex Code
16833 \begin_layout Plain Layout
16840 \begin_inset Flex Code
16843 \begin_layout Plain Layout
16849 but adds the necessary mandatory argument (the longest label) to the begin statement of the bibliography environment:
16850 \begin_inset Newline newline
16854 \begin_inset Flex Code
16857 \begin_layout Plain Layout
16860 begin{thebibliography}{99}
16866 It is therefore only useful for bibliography environments.
16867 The default longest label
16868 \begin_inset Quotes eld
16872 \begin_inset Quotes erd
16875 can be changed by the user in the paragraph settings of a bibliography item.
16878 \begin_layout Standard
16879 Putting the last few things together,
16880 the \SpecialChar LaTeX
16881 output will be either:
16885 \begin_layout LyX-Code
16888 LatexName[LatexParam]{\SpecialChar ldots
16892 \begin_layout Standard
16897 \begin_layout LyX-Code
16900 begin{LatexName}[LatexParam] \SpecialChar ldots
16906 \begin_layout Standard
16907 depending upon the \SpecialChar LaTeX
16912 \begin_layout Description
16913 \begin_inset Flex Code
16916 \begin_layout Plain Layout
16923 \begin_inset Flex Code
16926 \begin_layout Plain Layout
16932 ] A string that is put at the beginning of the style content.
16933 A line break in the output can be indicated by
16934 \begin_inset Flex Code
16937 \begin_layout Plain Layout
16946 \begin_layout Description
16947 \begin_inset Flex Code
16950 \begin_layout Plain Layout
16957 \begin_inset Flex Code
16960 \begin_layout Plain Layout
16966 ] If you put styles into environments,
16968 \begin_inset Flex Code
16971 \begin_layout Plain Layout
16977 are not simply added,
16978 but added with a factor
16979 \begin_inset Formula $\frac{4}{\mathrm{depth}+4}$
16983 Note that this parameter is also used when
16984 \begin_inset Flex Code
16987 \begin_layout Plain Layout
16994 \begin_inset Flex Code
16997 \begin_layout Plain Layout
17004 \begin_inset Flex Code
17007 \begin_layout Plain Layout
17014 Then it is added to the manual or dynamic margin.
17015 \begin_inset Newline newline
17019 \begin_inset Quotes eld
17023 \begin_inset Flex Code
17026 \begin_layout Plain Layout
17033 \begin_inset Quotes erd
17036 means that the paragraph is indented with the width of
17037 \begin_inset Quotes eld
17041 \begin_inset Flex Code
17044 \begin_layout Plain Layout
17051 \begin_inset Quotes erd
17054 in the normal font.
17055 You can get a negative width by prefixing the string with
17056 \begin_inset Quotes eld
17060 \begin_inset Flex Code
17063 \begin_layout Plain Layout
17070 \begin_inset Quotes erd
17074 This way was chosen so that the look is the same with each used screen font.
17077 \begin_layout Description
17078 \begin_inset Flex Code
17081 \begin_layout Plain Layout
17088 \begin_inset Flex Code
17091 \begin_layout Plain Layout
17106 \begin_inset Newline newline
17109 The kind of margin that the style has on the left side.
17113 \begin_layout Description
17114 \begin_inset Flex Code
17117 \begin_layout Plain Layout
17123 just means a fixed margin.
17126 \begin_layout Description
17127 \begin_inset Flex Code
17130 \begin_layout Plain Layout
17136 means that the left margin depends on the string entered in the
17137 \begin_inset Flex Noun
17140 \begin_layout Plain Layout
17141 Edit\SpecialChar menuseparator
17143 \begin_inset space ~
17152 This is used to typeset nice lists without tabulators.
17155 \begin_layout Description
17156 \begin_inset Flex Code
17159 \begin_layout Plain Layout
17165 means that the margin depends on the size of the label.
17166 This is used for automatic enumerated headlines.
17167 It is obvious that the headline
17168 \begin_inset Quotes eld
17171 5.4.3.2.1 Very long headline
17172 \begin_inset Quotes erd
17175 must have a wider left margin (as wide as
17176 \begin_inset Quotes eld
17180 \begin_inset Quotes erd
17183 plus the space) than
17184 \begin_inset Quotes eld
17187 3.2 Very long headline
17188 \begin_inset Quotes erd
17193 \begin_inset Quotes eld
17197 \begin_inset Quotes erd
17200 are not able to do this.
17203 \begin_layout Description
17204 \begin_inset Flex Code
17207 \begin_layout Plain Layout
17214 but only the very first row of the paragraph is dynamic,
17215 while the others are static;
17221 \begin_layout Description
17222 \begin_inset Flex Code
17225 \begin_layout Plain Layout
17231 means the margin is chosen in a way that the longest row of this paragraph fits to the right margin.
17232 This is used to typeset an address on the right edge of the page.
17236 \begin_layout Description
17237 \begin_inset Flex Code
17240 \begin_layout Plain Layout
17247 \begin_inset Flex Code
17250 \begin_layout Plain Layout
17259 \begin_inset space \thinspace{}
17263 \begin_inset Flex Code
17266 \begin_layout Plain Layout
17272 ] Whether fragile commands in this style should be
17273 \begin_inset Flex Code
17276 \begin_layout Plain Layout
17290 whether this command should itself be protected.)
17291 \change_inserted -712698321 1523696949
17295 \begin_layout Description
17297 \change_inserted -712698321 1552395557
17298 \begin_inset Flex Code
17301 \begin_layout Plain Layout
17303 \change_inserted -712698321 1523696950
17312 \begin_inset Flex Code
17315 \begin_layout Plain Layout
17317 \change_inserted -712698321 1523696950
17328 \begin_inset space \thinspace{}
17332 \begin_inset Flex Code
17335 \begin_layout Plain Layout
17337 \change_inserted -712698321 1523696950
17345 ] This causes macros that contain this layout to be protected with
17346 \begin_inset Flex Code
17349 \begin_layout Plain Layout
17351 \change_inserted -712698321 1523696950
17366 ) if necessary and thus allows (some) verbatim stuff in macros.
17369 \begin_layout Description
17371 \change_inserted -712698321 1552395844
17372 \begin_inset Flex Code
17375 \begin_layout Plain Layout
17377 \change_inserted -712698321 1552395561
17386 \begin_inset Flex Code
17389 \begin_layout Plain Layout
17391 \change_inserted -712698321 1552395557
17402 \begin_inset space \thinspace{}
17406 \begin_inset Flex Code
17409 \begin_layout Plain Layout
17411 \change_inserted -712698321 1552395557
17419 ] Whether specific commands in this style (such as
17420 \begin_inset Flex Code
17423 \begin_layout Plain Layout
17425 \change_inserted -712698321 1552395655
17436 \begin_inset Flex Code
17439 \begin_layout Plain Layout
17441 \change_inserted -712698321 1552395661
17451 ) should be protected in an
17452 \begin_inset Flex Code
17455 \begin_layout Plain Layout
17457 \change_inserted -712698321 1552395631
17468 This is particularly needed for styles that draw on
17476 commands which parse their content in complex ways.
17481 \begin_layout Description
17482 \begin_inset Flex Code
17485 \begin_layout Plain Layout
17492 \begin_inset Flex Code
17495 \begin_layout Plain Layout
17502 \begin_inset space \thinspace{}
17506 \begin_inset Flex Code
17509 \begin_layout Plain Layout
17517 ] Whether newlines are translated into \SpecialChar LaTeX
17519 \begin_inset Flex Code
17522 \begin_layout Plain Layout
17533 The translation can be switched off to allow more comfortable \SpecialChar LaTeX
17534 editing inside \SpecialChar LyX
17538 \begin_layout Description
17539 \begin_inset Flex Code
17542 \begin_layout Plain Layout
17549 \begin_inset Flex Code
17552 \begin_layout Plain Layout
17561 \begin_inset space \thinspace{}
17565 \begin_inset Flex Code
17568 \begin_layout Plain Layout
17576 \begin_inset Flex Code
17579 \begin_layout Plain Layout
17586 \begin_inset Flex Code
17589 \begin_layout Plain Layout
17595 ) paragraphs are being indented,
17596 then the indentation of such a paragraph following one of this type will be suppressed.
17597 (So this will not affect the display of non-default paragraphs.)
17600 \begin_layout Description
17601 \begin_inset Flex Code
17604 \begin_layout Plain Layout
17611 \begin_inset Flex Code
17614 \begin_layout Plain Layout
17620 ] Name of a style that has replaced this style.
17621 This is used to rename a style,
17622 while keeping backward compatibility.
17625 \begin_layout Description
17626 \begin_inset Flex Code
17629 \begin_layout Plain Layout
17636 \begin_inset Flex Code
17639 \begin_layout Plain Layout
17646 \begin_inset space \thinspace{}
17650 \begin_inset Flex Code
17653 \begin_layout Plain Layout
17659 ] Determines whether consecutive paragraphs of the same type are treated as belonging together.
17660 This has the effect that the
17661 \begin_inset Flex Code
17664 \begin_layout Plain Layout
17670 is only printed once before such a group.
17673 \begin_inset Flex Code
17676 \begin_layout Plain Layout
17683 \begin_inset Flex Code
17686 \begin_layout Plain Layout
17693 \begin_inset Flex Code
17696 \begin_layout Plain Layout
17702 and false for all other types.
17705 \begin_layout Description
17706 \begin_inset Flex Code
17709 \begin_layout Plain Layout
17716 \begin_inset Flex Code
17719 \begin_layout Plain Layout
17728 \begin_inset space \thinspace{}
17732 \begin_inset Flex Code
17735 \begin_layout Plain Layout
17741 ] Indicates that paragraphs will not be separated by an empty line in \SpecialChar LaTeX
17743 but only by a line break;
17745 \begin_inset Flex Code
17748 \begin_layout Plain Layout
17755 this allows to emulate a plain text editor (like the ERT inset).
17758 \begin_layout Description
17759 \begin_inset Flex Code
17762 \begin_layout Plain Layout
17769 \begin_inset Flex Code
17772 \begin_layout Plain Layout
17778 ] The indent of the very first line of a paragraph.
17780 \begin_inset Newline newline
17784 \begin_inset Flex Code
17787 \begin_layout Plain Layout
17793 will be fixed for a certain style.
17794 The exception is the default style,
17795 since the indentation for these paragraphs can be prohibited with
17796 \begin_inset Flex Code
17799 \begin_layout Plain Layout
17808 \begin_inset Flex Code
17811 \begin_layout Plain Layout
17817 style paragraphs inside environments use the
17818 \begin_inset Flex Code
17821 \begin_layout Plain Layout
17827 of the environment,
17828 not their native one.
17831 \begin_inset Flex Code
17834 \begin_layout Plain Layout
17840 paragraphs inside an enumeration are not indented.
17843 \begin_layout Description
17844 \begin_inset Flex Code
17847 \begin_layout Plain Layout
17854 \begin_inset Flex Code
17857 \begin_layout Plain Layout
17863 ] The vertical space between two paragraphs of this style.
17866 \begin_layout Description
17867 \begin_inset Flex Code
17870 \begin_layout Plain Layout
17877 \begin_inset Flex Code
17880 \begin_layout Plain Layout
17887 allows the user to choose either
17888 \begin_inset Quotes eld
17892 \begin_inset Quotes erd
17896 \begin_inset Quotes eld
17900 \begin_inset Quotes erd
17903 to separate paragraphs.
17905 \begin_inset Quotes eld
17909 \begin_inset Quotes erd
17914 \begin_inset Flex Code
17917 \begin_layout Plain Layout
17925 \begin_inset Quotes eld
17929 \begin_inset Quotes erd
17934 \begin_inset Flex Code
17937 \begin_layout Plain Layout
17943 is ignored and all paragraphs are separated by the
17944 \begin_inset Flex Code
17947 \begin_layout Plain Layout
17954 The vertical space is calculated with
17955 \begin_inset Flex Code
17958 \begin_layout Plain Layout
17960 \begin_inset space ~
17969 \begin_inset Flex Code
17972 \begin_layout Plain Layout
17978 is the height of a row with the normal font.
17980 the look stays the same with different screen fonts.
17983 \begin_layout Description
17984 \begin_inset Flex Code
17987 \begin_layout Plain Layout
17994 \begin_inset Flex Code
17997 \begin_layout Plain Layout
18006 \begin_inset space \thinspace{}
18010 \begin_inset Flex Code
18013 \begin_layout Plain Layout
18019 ] Whether the contents of this paragraph should be output in raw form,
18020 meaning without special translations that \SpecialChar LaTeX
18024 \begin_layout Description
18025 \begin_inset Flex Code
18028 \begin_layout Plain Layout
18035 \begin_inset Flex Code
18038 \begin_layout Plain Layout
18048 Defines individual characters that should be output in raw form,
18049 meaning without special translations that \SpecialChar LaTeX
18053 \begin_layout Description
18054 \begin_inset Flex Code
18057 \begin_layout Plain Layout
18063 Information to be included in the \SpecialChar LaTeX
18064 preamble when this style is used.
18065 Used to define macros,
18068 required by this particular style.
18070 \begin_inset Quotes eld
18074 \begin_inset Flex Code
18077 \begin_layout Plain Layout
18084 \begin_inset Quotes erd
18090 \begin_layout Description
18091 \begin_inset Flex Code
18094 \begin_layout Plain Layout
18101 \begin_inset Flex Code
18104 \begin_layout Plain Layout
18110 ] The prefix to use when creating labels referring to paragraphs of this type.
18111 This allows the use of formatted references.
18114 \begin_layout Description
18115 \begin_inset Flex Code
18118 \begin_layout Plain Layout
18125 \begin_inset Flex Code
18128 \begin_layout Plain Layout
18134 ] Whether the style requires the feature
18135 \begin_inset Flex Code
18138 \begin_layout Plain Layout
18145 \begin_inset CommandInset ref
18147 reference "chap:List-of-functions"
18152 for the list of features).
18153 If you require a package with specific options,
18154 you can additionally use
18155 \begin_inset Flex Code
18158 \begin_layout Plain Layout
18164 as a general text class parameter (see
18165 \begin_inset CommandInset ref
18167 reference "subsec:General-text-class"
18175 \begin_layout Description
18176 \begin_inset Flex Code
18179 \begin_layout Plain Layout
18186 \begin_inset Flex Code
18189 \begin_layout Plain Layout
18198 \begin_inset Flex Code
18201 \begin_layout Plain Layout
18207 ] Resets the \SpecialChar LaTeX
18208 arguments of this style (as defined via the
18209 \begin_inset Flex Code
18212 \begin_layout Plain Layout
18219 This is useful if you have copied a style via
18220 \begin_inset Flex Code
18223 \begin_layout Plain Layout
18230 but you do not want to inherit its (required and optional) arguments.
18233 \begin_layout Description
18234 \begin_inset Flex Code
18237 \begin_layout Plain Layout
18244 \begin_inset Flex Code
18247 \begin_layout Plain Layout
18256 \begin_inset Flex Code
18259 \begin_layout Plain Layout
18265 ] Resumes a counter that is usually reset at each new sequence of layouts.
18266 This is currently only useful when
18267 \begin_inset Flex Code
18270 \begin_layout Plain Layout
18277 \begin_inset Flex Code
18280 \begin_layout Plain Layout
18289 \begin_layout Description
18290 \begin_inset Flex Code
18293 \begin_layout Plain Layout
18300 \begin_inset Flex Code
18303 \begin_layout Plain Layout
18309 ] A string that is put at the end of the layout content.
18310 A line break in the output can be indicated by
18311 \begin_inset Flex Code
18314 \begin_layout Plain Layout
18323 \begin_layout Description
18324 \begin_inset Flex Code
18327 \begin_layout Plain Layout
18334 \begin_inset Flex Code
18337 \begin_layout Plain Layout
18344 \begin_inset Flex Code
18347 \begin_layout Plain Layout
18356 \begin_layout Description
18357 \begin_inset Flex Code
18360 \begin_layout Plain Layout
18367 \begin_inset Flex Code
18370 \begin_layout Plain Layout
18380 \begin_inset Flex Code
18383 \begin_layout Plain Layout
18391 \begin_inset Flex Code
18394 \begin_layout Plain Layout
18402 \begin_inset Flex Code
18405 \begin_layout Plain Layout
18407 \begin_inset space ~
18415 ] This defines what the default spacing should be in the style.
18417 \begin_inset Flex Code
18420 \begin_layout Plain Layout
18428 \begin_inset Flex Code
18431 \begin_layout Plain Layout
18438 \begin_inset Flex Code
18441 \begin_layout Plain Layout
18447 correspond respectively to a multiplier value of 1,
18449 If you specify the argument
18450 \begin_inset Flex Code
18453 \begin_layout Plain Layout
18460 then you must also provide a value argument which will be the actual multiplier value.
18462 contrary to other parameters,
18464 \begin_inset Flex Code
18467 \begin_layout Plain Layout
18473 implies the generation of specific \SpecialChar LaTeX
18475 using the \SpecialChar LaTeX
18479 \begin_inset Flex Code
18482 \begin_layout Plain Layout
18491 \begin_layout Description
18492 \begin_inset Flex Code
18495 \begin_layout Plain Layout
18502 \begin_inset Flex Code
18505 \begin_layout Plain Layout
18512 \begin_inset space \thinspace{}
18516 \begin_inset Flex Code
18519 \begin_layout Plain Layout
18527 ] Allow spell-checking paragraphs of this style.
18531 \begin_layout Description
18532 \begin_inset Flex Code
18535 \begin_layout Plain Layout
18537 \change_deleted 731793113 1604355211
18539 \change_inserted 731793113 1604355212
18548 \begin_inset Flex Code
18551 \begin_layout Plain Layout
18560 \begin_inset Flex Code
18563 \begin_layout Plain Layout
18570 \change_deleted 731793113 1604355214
18572 \change_inserted 731793113 1604355216
18575 counter of a given counter at the beginning of a new sequence of layouts.
18576 This is currently only useful when
18577 \begin_inset Flex Code
18580 \begin_layout Plain Layout
18587 \begin_inset Flex Code
18590 \begin_layout Plain Layout
18599 \begin_layout Description
18600 \begin_inset Flex Code
18603 \begin_layout Plain Layout
18609 The font used for the text body .
18611 \begin_inset CommandInset ref
18613 reference "subsec:Font-description"
18621 \begin_layout Description
18622 \begin_inset Flex Code
18625 \begin_layout Plain Layout
18634 \begin_inset Flex Code
18637 \begin_layout Plain Layout
18647 The level of the style in the table of contents.
18648 This is used for automatic numbering of section headings.
18651 \begin_layout Description
18652 \begin_inset Flex Code
18655 \begin_layout Plain Layout
18664 \begin_inset Flex Code
18667 \begin_layout Plain Layout
18679 \begin_inset Flex Code
18682 \begin_layout Plain Layout
18690 \begin_inset Flex Code
18693 \begin_layout Plain Layout
18699 ] This tag determines whether the first line indentation of this paragraph can be toggled via the Paragraph settings dialog.
18703 \begin_inset Flex Code
18706 \begin_layout Plain Layout
18717 indentation can be toggled if the document settings use
18718 \begin_inset Quotes eld
18722 \begin_inset Quotes erd
18727 \begin_inset Flex Code
18730 \begin_layout Plain Layout
18737 indentation can always be toggled,
18738 notwithstanding the document settings,
18740 \begin_inset Flex Code
18743 \begin_layout Plain Layout
18750 indentation can never be toggled.
18753 \begin_layout Description
18754 \begin_inset Flex Code
18757 \begin_layout Plain Layout
18764 \begin_inset Flex Code
18767 \begin_layout Plain Layout
18773 ] The vertical space with which the very first of a chain of paragraphs with this style is separated from the previous paragraph.
18774 If the previous paragraph has another style,
18775 the separations are not simply added,
18776 but the maximum is taken.
18779 \begin_layout Subsection
18780 \begin_inset CommandInset label
18786 Internationalization of Paragraph Styles
18789 \begin_layout Standard
18791 has long supported internationalization of layout information,
18794 this applied only to the user interface and not to,
18798 French authors were forced to resort to ugly hacks if they wanted `
18802 1' instead of `Theorem 1'.
18803 Thanks to Georg Baum,
18804 that is no longer the case.
18807 \begin_layout Standard
18809 \begin_inset Flex Code
18812 \begin_layout Plain Layout
18818 defines text that is to appear in the typeset document,
18820 \begin_inset Flex Code
18823 \begin_layout Plain Layout
18830 \begin_inset Flex Code
18833 \begin_layout Plain Layout
18839 to support non-English and even multi-language documents correctly.
18840 The following excerpt (from the
18841 \begin_inset Flex Code
18844 \begin_layout Plain Layout
18850 file) shows how this works:
18853 \begin_layout LyX-Code
18858 \begin_layout LyX-Code
18861 theoremstyle{remark}
18864 \begin_layout LyX-Code
18867 newtheorem{claim}[thm]{
18874 \begin_layout LyX-Code
18878 \begin_layout LyX-Code
18882 \begin_layout LyX-Code
18887 claimname}{_(Claim)}
18890 \begin_layout LyX-Code
18894 \begin_layout LyX-Code
18898 \begin_layout LyX-Code
18907 claimname}{_(Claim)}}
18910 \begin_layout LyX-Code
18915 \begin_layout Standard
18917 any legal \SpecialChar LaTeX
18919 \begin_inset Flex Code
18922 \begin_layout Plain Layout
18929 \begin_inset Flex Code
18932 \begin_layout Plain Layout
18939 but in practice they will typically look as they do here.
18940 The key to correct translation of the typeset text is the definition of the \SpecialChar LaTeX
18942 \begin_inset Flex Code
18945 \begin_layout Plain Layout
18954 \begin_inset Flex Code
18957 \begin_layout Plain Layout
18969 \begin_layout Standard
18971 \begin_inset Flex Code
18974 \begin_layout Plain Layout
18980 tag provides for internationalization based upon the overall language of the document.
18981 The contents of the tag will be included in the preamble,
18983 \begin_inset Flex Code
18986 \begin_layout Plain Layout
18993 What makes it special is the use of the
18994 \begin_inset Quotes eld
18998 \begin_inset Quotes erd
19002 \begin_inset Flex Code
19005 \begin_layout Plain Layout
19012 which will be replaced,
19013 when \SpecialChar LyX
19014 produces \SpecialChar LaTeX
19016 with the translation of its argument into the document language.
19019 \begin_layout Standard
19021 \begin_inset Flex Code
19024 \begin_layout Plain Layout
19030 tag is more complex,
19031 since it is meant to provide support for multi-language documents and so offers an interface to the
19032 \begin_inset Flex Code
19035 \begin_layout Plain Layout
19042 Its contents will be added to the preamble once for each language that appears in the document.
19045 \begin_inset Flex Code
19048 \begin_layout Plain Layout
19054 will be replaced with its translation into the language in question;
19056 \begin_inset Flex Code
19059 \begin_layout Plain Layout
19065 is replaced by the language name (as used by the babel package).
19068 \begin_layout Standard
19069 A German document that also included a French section would thus have the following in the preamble:
19072 \begin_layout LyX-Code
19081 claimname}{Affirmation}}
19082 \begin_inset Newline newline
19093 claimname}{Behauptung}}
19094 \begin_inset Newline newline
19101 claimname}{Behauptung}
19104 \begin_layout Standard
19107 \begin_inset Flex Code
19110 \begin_layout Plain Layout
19116 will then conspire to produce the correct text in the output.
19119 \begin_layout Standard
19120 One important point to note here is that the translations are provided by \SpecialChar LyX
19123 \begin_inset Flex Code
19126 \begin_layout Plain Layout
19136 \begin_inset Flex Code
19139 \begin_layout Plain Layout
19146 \begin_inset Flex Code
19149 \begin_layout Plain Layout
19155 are really only of use in layout files that are provided with \SpecialChar LyX
19157 since text entered in user-created layout files will not be seen by \SpecialChar LyX
19158 's internationalization routines unless the
19159 \begin_inset Flex Code
19162 \begin_layout Plain Layout
19168 file is modified accordingly.
19171 any layout created with the intention that it will be included with \SpecialChar LyX
19172 should use these tags where appropriate.
19173 Please note that the paragraph style translations provided by \SpecialChar LyX
19174 will never change with a minor update (e.
19175 \begin_inset space \thinspace{}
19179 \begin_inset space \space{}
19182 from version 2.1.x to 2.1.y).
19183 It is however quite likely that a major update (e.
19184 \begin_inset space \thinspace{}
19188 \begin_inset space \space{}
19191 from 2.0.x to 2.1.0) will introduce new translations or corrections.
19194 \begin_layout Subsection
19196 \begin_inset CommandInset label
19198 name "subsec:Floats"
19205 \begin_layout Standard
19206 It is necessary to define the floats (
19207 \begin_inset Flex Noun
19210 \begin_layout Plain Layout
19218 \begin_inset Flex Noun
19221 \begin_layout Plain Layout
19229 ) in the text class itself.
19230 Standard floats are included in the file
19231 \begin_inset Flex Code
19234 \begin_layout Plain Layout
19241 so you may have to do no more than add
19244 \begin_layout LyX-Code
19245 Input stdfloats.inc
19248 \begin_layout Standard
19249 to your layout file.
19250 If you want to implement a text class that proposes some other float types (like the AGU class bundled with \SpecialChar LyX
19252 the information below will hopefully help you:
19255 \begin_layout Description
19256 \begin_inset Flex Code
19259 \begin_layout Plain Layout
19266 \begin_inset Flex Code
19269 \begin_layout Plain Layout
19275 =!htbpH] Allowed placement options for this float type.
19276 The value is a string of placement characters.
19277 Possible characters include:
19283 \begin_inset Quotes eld
19287 \begin_inset Quotes erd
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
19356 The order of the characters in the string does not matter.
19357 If no placement options are allowed,
19365 \begin_layout Description
19366 \begin_inset Flex Code
19369 \begin_layout Plain Layout
19376 \begin_inset Flex Code
19379 \begin_layout Plain Layout
19388 \begin_inset space \thinspace{}
19394 \begin_inset Flex Code
19397 \begin_layout Plain Layout
19407 ] Defines whether the float allows to be rotated via the \SpecialChar LaTeX
19414 \begin_inset Flex Code
19417 \begin_layout Plain Layout
19423 if the float does not support this feature.
19426 \begin_layout Description
19427 \begin_inset Flex Code
19430 \begin_layout Plain Layout
19437 \begin_inset Flex Code
19440 \begin_layout Plain Layout
19449 \begin_inset space \thinspace{}
19455 \begin_inset Flex Code
19458 \begin_layout Plain Layout
19468 ] Defines whether the float has a starred variant that spans columns in a two column paragraph.
19470 \begin_inset Flex Code
19473 \begin_layout Plain Layout
19479 if the float does not support this feature.
19482 \begin_layout Description
19483 \begin_inset Flex Code
19486 \begin_layout Plain Layout
19493 \begin_inset Flex Code
19496 \begin_layout Plain Layout
19503 \begin_inset Quotes erd
19507 \begin_inset Quotes erd
19510 ] The file name extension of an auxiliary file for the list of figures (or whatever).
19512 writes the captions to this file.
19515 \begin_layout Description
19516 \begin_inset Flex Code
19519 \begin_layout Plain Layout
19526 \begin_inset Flex Code
19529 \begin_layout Plain Layout
19536 \begin_inset Quotes erd
19540 \begin_inset Quotes erd
19543 ] The string that will be used in the menus and also for the caption.
19544 This is translated to the current language if babel is used.
19547 \begin_layout Description
19548 \begin_inset Flex Code
19551 \begin_layout Plain Layout
19557 These tags control the XHTML output.
19559 \begin_inset CommandInset ref
19561 reference "sec:Tags-for-XHTML"
19569 \begin_layout Description
19570 \begin_inset Flex Code
19573 \begin_layout Plain Layout
19582 \begin_inset Flex Code
19585 \begin_layout Plain Layout
19594 \begin_inset space \thinspace{}
19598 \begin_inset Flex Code
19601 \begin_layout Plain Layout
19607 ] Indicates whether the float is already defined in the document class or if instead the \SpecialChar LaTeX
19609 \begin_inset Flex Code
19612 \begin_layout Plain Layout
19618 needs to be loaded to define it on-the-fly.
19620 \begin_inset Flex Code
19623 \begin_layout Plain Layout
19632 \begin_inset Flex Code
19635 \begin_layout Plain Layout
19642 It should be set to
19643 \begin_inset Flex Code
19646 \begin_layout Plain Layout
19652 if the float is already defined by the \SpecialChar LaTeX
19656 \begin_layout Description
19657 \begin_inset Flex Code
19660 \begin_layout Plain Layout
19667 \begin_inset Flex Code
19670 \begin_layout Plain Layout
19677 \begin_inset Quotes erd
19681 \begin_inset Quotes erd
19684 ] The command used to generate a list of floats of this type;
19693 \begin_inset Flex Code
19696 \begin_layout Plain Layout
19703 since there is no standard way to generate this command.
19705 \begin_inset Flex Code
19708 \begin_layout Plain Layout
19715 since in that case there is a standard way to define the command.
19718 \begin_layout Description
19719 \begin_inset Flex Code
19722 \begin_layout Plain Layout
19729 \begin_inset Flex Code
19732 \begin_layout Plain Layout
19739 \begin_inset Quotes erd
19743 \begin_inset Quotes erd
19746 ] A title for a list of floats of this kind (list of figures,
19749 It is used for the screen label within \SpecialChar LyX
19751 it is used by \SpecialChar LaTeX
19752 for the title and it is used as the title in the XHTML output.
19753 It will be translated to the document language.
19756 \begin_layout Description
19757 \begin_inset Flex Code
19760 \begin_layout Plain Layout
19767 \begin_inset Flex Code
19770 \begin_layout Plain Layout
19777 \begin_inset Quotes erd
19781 \begin_inset Quotes erd
19784 ] This (optional) argument determines whether floats of this class will be numbered within some sectional unit of the document.
19787 \begin_inset Flex Code
19790 \begin_layout Plain Layout
19797 \begin_inset Quotes eld
19801 \begin_inset Flex Code
19804 \begin_layout Plain Layout
19811 \begin_inset Quotes erd
19815 the floats will be numbered within chapters.
19819 \begin_layout Description
19820 \begin_inset Flex Code
19823 \begin_layout Plain Layout
19830 \begin_inset Flex Code
19833 \begin_layout Plain Layout
19840 \begin_inset Quotes erd
19844 \begin_inset Quotes erd
19847 ] The default placement for the given class of floats.
19848 The string should be as in standard \SpecialChar LaTeX
19851 \begin_inset Flex Code
19854 \begin_layout Plain Layout
19862 \begin_inset Flex Code
19865 \begin_layout Plain Layout
19873 \begin_inset Flex Code
19876 \begin_layout Plain Layout
19883 \begin_inset Flex Code
19886 \begin_layout Plain Layout
19900 \begin_layout Plain Layout
19901 Note that the order of these letters in the string is irrelevant,
19902 like in \SpecialChar LaTeX
19908 On top of that there is a new type,
19910 \begin_inset Flex Code
19913 \begin_layout Plain Layout
19920 which does not really correspond to a float,
19923 \begin_inset Quotes eld
19927 \begin_inset Quotes erd
19931 Note however that the
19932 \begin_inset Flex Code
19935 \begin_layout Plain Layout
19941 specifier is special and,
19942 because of implementation details,
19943 cannot be used in non-built in float types.
19944 If you do not understand what this means,
19946 \begin_inset Quotes eld
19950 \begin_inset Flex Code
19953 \begin_layout Plain Layout
19960 \begin_inset Quotes erd
19966 \begin_layout Description
19967 \begin_inset Flex Code
19970 \begin_layout Plain Layout
19977 \begin_inset Flex Code
19980 \begin_layout Plain Layout
19986 ] The prefix to use when creating labels referring to floats of this type.
19987 This allows the use of formatted references.
19988 Note that you can remove any
19989 \begin_inset Flex Code
19992 \begin_layout Plain Layout
19998 set by a copied style by using the special value
19999 \begin_inset Quotes eld
20003 \begin_inset Quotes erd
20007 which must be all caps.
20008 \change_inserted -712698321 1565605014
20012 \begin_layout Description
20014 \change_inserted -712698321 1565605014
20015 \begin_inset Flex Code
20018 \begin_layout Plain Layout
20020 \change_inserted -712698321 1565605014
20029 \begin_inset Flex Code
20032 \begin_layout Plain Layout
20034 \change_inserted -712698321 1565605014
20042 ] As with paragraph styles,
20044 \begin_inset CommandInset ref
20046 reference "subsec:Paragraph-Styles"
20056 \begin_layout Description
20057 \begin_inset Flex Code
20060 \begin_layout Plain Layout
20067 \begin_inset Flex Code
20070 \begin_layout Plain Layout
20077 \begin_inset Quotes erd
20081 \begin_inset Quotes erd
20084 ] The style used when defining the float using
20085 \begin_inset Flex Code
20088 \begin_layout Plain Layout
20099 \begin_layout Description
20100 \begin_inset Flex Code
20103 \begin_layout Plain Layout
20110 \begin_inset Flex Code
20113 \begin_layout Plain Layout
20120 \begin_inset Quotes erd
20124 \begin_inset Quotes erd
20128 \begin_inset Quotes eld
20132 \begin_inset Quotes erd
20135 of the new class of floats,
20136 like program or algorithm.
20137 After the appropriate
20138 \begin_inset Flex Code
20141 \begin_layout Plain Layout
20151 \begin_inset Flex Code
20154 \begin_layout Plain Layout
20163 \begin_inset Flex Code
20166 \begin_layout Plain Layout
20177 \begin_layout Description
20178 \begin_inset Flex Code
20181 \begin_layout Plain Layout
20188 \begin_inset Flex Code
20191 \begin_layout Plain Layout
20198 \begin_inset space \thinspace{}
20202 \begin_inset Flex Code
20205 \begin_layout Plain Layout
20213 ] Specifies whether this float is defined using the \SpecialChar LaTeX
20215 \begin_inset Flex Code
20218 \begin_layout Plain Layout
20225 either by the class file,
20226 another package or on-the-fly by \SpecialChar LyX
20230 \begin_layout Standard
20231 Note that defining a float with type
20232 \begin_inset Flex Code
20235 \begin_layout Plain Layout
20243 automatically defines the corresponding counter with name
20244 \begin_inset Flex Code
20247 \begin_layout Plain Layout
20258 \begin_layout Subsection
20259 Flex insets and InsetLayout
20260 \begin_inset CommandInset label
20262 name "subsec:Flex-insets-and"
20269 \begin_layout Standard
20270 Flex insets come in
20271 \change_deleted 5863208 1594239511
20273 \change_inserted 5863208 1594239512
20280 \begin_layout Itemize
20282 \begin_inset Flex Code
20285 \begin_layout Plain Layout
20292 These define semantic markup corresponding to such \SpecialChar LaTeX
20294 \begin_inset Flex Code
20297 \begin_layout Plain Layout
20306 \begin_inset Flex Code
20309 \begin_layout Plain Layout
20320 \begin_layout Itemize
20322 \begin_inset Flex Code
20325 \begin_layout Plain Layout
20332 These can be used to define custom collapsible insets,
20333 similar to \SpecialChar TeX
20337 An obvious example is an endnote inset,
20338 which is defined in the
20339 \begin_inset Flex Code
20342 \begin_layout Plain Layout
20351 \begin_layout Itemize
20353 \change_deleted 5863208 1594239528
20355 \begin_inset Flex Code
20358 \begin_layout Plain Layout
20365 For use with DocBook classes.
20370 \begin_layout Standard
20371 Flex insets are defined using the
20372 \begin_inset Flex Code
20375 \begin_layout Plain Layout
20382 which shall be explained in a moment.
20385 \begin_layout Standard
20387 \begin_inset Flex Code
20390 \begin_layout Plain Layout
20396 tag also serves another function:
20397 It can be used to customize the general layout of many different types of insets.
20400 \begin_inset Flex Code
20403 \begin_layout Plain Layout
20409 can be used to customize the layout parameters for footnotes,
20422 as well as to define Flex insets.
20425 \begin_layout Standard
20427 \begin_inset Flex Code
20430 \begin_layout Plain Layout
20436 definition must begin with a line of the form:
20439 \begin_layout LyX-Code
20443 \begin_layout Standard
20445 \begin_inset Flex Code
20448 \begin_layout Plain Layout
20454 indicates the inset whose layout is being defined,
20455 and here there are four cases.
20458 \begin_layout Enumerate
20459 The layout for a pre-existing inset is being modified.
20462 \begin_inset Flex Code
20465 \begin_layout Plain Layout
20471 any one of the following:
20473 \begin_inset Flex Code
20476 \begin_layout Plain Layout
20484 \begin_inset Flex Code
20487 \begin_layout Plain Layout
20495 \begin_inset Flex Code
20498 \begin_layout Plain Layout
20506 \begin_inset Flex Code
20509 \begin_layout Plain Layout
20517 \begin_inset Flex Code
20520 \begin_layout Plain Layout
20528 \begin_inset Flex Code
20531 \begin_layout Plain Layout
20539 \begin_inset Flex Code
20542 \begin_layout Plain Layout
20550 \begin_inset Flex Code
20553 \begin_layout Plain Layout
20561 \begin_inset Flex Code
20564 \begin_layout Plain Layout
20572 \begin_inset Flex Code
20575 \begin_layout Plain Layout
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
20694 \begin_layout Enumerate
20695 The layout for a Flex inset is being defined.
20698 \begin_inset Flex Code
20701 \begin_layout Plain Layout
20707 must be of the form
20708 \begin_inset Quotes eld
20712 \begin_inset Flex Code
20715 \begin_layout Plain Layout
20722 \begin_inset Quotes erd
20727 \begin_inset Flex Code
20730 \begin_layout Plain Layout
20736 may be any valid identifier not used by a pre-existing Flex inset.
20737 The identifier may include spaces,
20738 but in that case the whole thing must be wrapped in quotes.
20739 Note that the definition of a flex inset
20744 \begin_inset Flex Code
20747 \begin_layout Plain Layout
20754 declaring which type of inset it defines.
20757 \begin_layout Enumerate
20758 The layout for user specific branch is being defined.
20761 \begin_inset Flex Code
20764 \begin_layout Plain Layout
20770 must be of the form
20771 \begin_inset Quotes eld
20775 \begin_inset Flex Code
20778 \begin_layout Plain Layout
20785 \begin_inset Quotes erd
20790 \begin_inset Flex Code
20793 \begin_layout Plain Layout
20799 may be any valid identifier of branch defined in user's document.
20800 The identifier may include spaces,
20801 but in that case the whole thing must be wrapped in quotes.
20802 The main purpose of this feature is to allow \SpecialChar LaTeX
20803 wrapping around specific branches as user needs.
20806 \begin_layout Enumerate
20807 The layout of a user (or class) specific caption is being defined.
20810 \begin_inset Flex Code
20813 \begin_layout Plain Layout
20819 must be of the form
20820 \begin_inset Quotes eld
20824 \begin_inset Flex Code
20827 \begin_layout Plain Layout
20834 \begin_inset Quotes erd
20839 \begin_inset Flex Code
20842 \begin_layout Plain Layout
20848 specifies the name of the caption as it appears in the menu.
20849 Have a look at the standard caption (
20850 \begin_inset Flex Code
20853 \begin_layout Plain Layout
20860 the specific captions of the KOMA-Script classes (
20861 \begin_inset Flex Code
20864 \begin_layout Plain Layout
20872 \begin_inset Flex Code
20875 \begin_layout Plain Layout
20884 \begin_inset space ~
20888 \begin_inset Newline linebreak
20894 \begin_inset Flex Code
20897 \begin_layout Plain Layout
20903 ) for applications.
20906 \begin_layout Standard
20908 \begin_inset Flex Code
20911 \begin_layout Plain Layout
20917 definition can contain the following entries:
20920 \begin_layout Description
20921 \begin_inset Flex Code
20924 \begin_layout Plain Layout
20931 \begin_inset Flex Code
20934 \begin_layout Plain Layout
20940 =""] This inset will appear in the table of contents of the given type.
20941 An empty string disables.
20942 See also the OutlinerName and the IsTocCaption commands.
20943 This is only implemented for Flex insets.
20948 \begin_layout Description
20949 \begin_inset Flex Code
20952 \begin_layout Plain Layout
20959 \begin_inset Flex Code
20962 \begin_layout Plain Layout
20968 ] Defines argument number of a command\SpecialChar breakableslash
20969 environment associated with the current layout.
20970 The definition must end with
20971 \begin_inset Flex Code
20974 \begin_layout Plain Layout
20982 \change_inserted -584632292 1615846847
20984 \begin_inset CommandInset ref
20986 reference "subsec:Arguments"
20995 \change_deleted -584632292 1615846847
20997 \begin_inset CommandInset ref
20999 reference "subsec:Paragraph-Styles"
21007 \change_deleted -584632292 1615846902
21009 \change_inserted -584632292 1615846906
21015 \begin_layout Description
21016 \begin_inset Flex Code
21019 \begin_layout Plain Layout
21025 Preamble for changing language commands;
21027 \begin_inset CommandInset ref
21029 reference "subsec:I18n"
21037 \begin_layout Description
21038 \begin_inset Flex Code
21041 \begin_layout Plain Layout
21048 \begin_inset Flex Code
21051 \begin_layout Plain Layout
21057 ] The color for the inset's background.
21059 \begin_inset CommandInset ref
21061 reference "chap:Names-of-colors"
21066 for a list of the available color names.
21069 \begin_layout Description
21070 \begin_inset Flex Code
21073 \begin_layout Plain Layout
21080 \begin_inset Flex Code
21083 \begin_layout Plain Layout
21092 \begin_inset space \thinspace{}
21096 \begin_inset Flex Code
21099 \begin_layout Plain Layout
21105 ] Whether to use the content of the inset as the label,
21106 when the inset is closed.
21110 \begin_layout Description
21111 \begin_inset Flex Code
21114 \begin_layout Plain Layout
21121 \begin_inset Flex Code
21124 \begin_layout Plain Layout
21130 ] As with paragraph styles,
21132 \begin_inset CommandInset ref
21134 reference "subsec:Paragraph-Styles"
21140 Note that you need to specify the complete type,
21142 \begin_inset space \thinspace{}
21146 \begin_inset space ~
21150 \begin_inset Flex Code
21153 \begin_layout Plain Layout
21154 CopyStyle Flex:<name>
21162 \begin_layout Description
21163 \begin_inset Flex Code
21166 \begin_layout Plain Layout
21173 \begin_inset Flex Code
21176 \begin_layout Plain Layout
21185 \begin_inset space \thinspace{}
21189 \begin_inset Flex Code
21192 \begin_layout Plain Layout
21198 ] Indicates whether the user may employ the Paragraph Settings dialog to customize the paragraph.
21201 \begin_layout Description
21202 \begin_inset Flex Code
21205 \begin_layout Plain Layout
21212 \begin_inset Flex Code
21215 \begin_layout Plain Layout
21223 \begin_inset Flex Code
21226 \begin_layout Plain Layout
21234 \begin_inset Flex Code
21237 \begin_layout Plain Layout
21244 describing the rendering style used for the inset's frame and buttons.
21245 Footnotes generally use
21246 \begin_inset Flex Code
21249 \begin_layout Plain Layout
21256 ERT insets generally
21257 \begin_inset Flex Code
21260 \begin_layout Plain Layout
21267 and character styles
21268 \begin_inset Flex Code
21271 \begin_layout Plain Layout
21280 \begin_layout Description
21281 \begin_inset Flex Code
21284 \begin_layout Plain Layout
21291 \begin_inset Flex Code
21294 \begin_layout Plain Layout
21303 \begin_inset space \thinspace{}
21309 \begin_inset Flex Code
21312 \begin_layout Plain Layout
21321 \begin_inset Flex Code
21324 \begin_layout Plain Layout
21331 \begin_inset Flex Code
21334 \begin_layout Plain Layout
21341 Indicates whether the environment will stand on its own in the output or will appear inline with the surrounding text.
21343 it is supposed that the \SpecialChar LaTeX
21344 environment ignores white space (including one newline character) after the
21345 \begin_inset Flex Code
21348 \begin_layout Plain Layout
21361 \begin_inset Flex Code
21364 \begin_layout Plain Layout
21378 \change_inserted 731793113 1538674858
21382 \begin_layout Description
21384 \change_inserted 731793113 1538674891
21385 \begin_inset Flex Code
21388 \begin_layout Plain Layout
21390 \change_inserted 731793113 1538674863
21402 ,1] Allow the contents of the inset to be edited externally (using whatever editor is defined for the document's output format).
21407 \begin_layout Description
21408 \begin_inset Flex Code
21411 \begin_layout Plain Layout
21417 Required at the end of the
21418 \begin_inset Flex Code
21421 \begin_layout Plain Layout
21430 \begin_layout Description
21431 \begin_inset Flex Code
21434 \begin_layout Plain Layout
21440 The font used for both the text body
21446 \begin_inset CommandInset ref
21448 reference "subsec:Font-description"
21454 Note that defining this font automatically defines the
21455 \begin_inset Flex Code
21458 \begin_layout Plain Layout
21465 so define this first and define
21466 \begin_inset Flex Code
21469 \begin_layout Plain Layout
21475 later if you want them to be different.
21478 \begin_layout Description
21479 \begin_inset Flex Code
21482 \begin_layout Plain Layout
21483 FixedWidthPreambleEncoding
21489 \begin_inset Flex Code
21492 \begin_layout Plain Layout
21501 \begin_inset space \thinspace{}
21505 \begin_inset Flex Code
21508 \begin_layout Plain Layout
21514 ] Force a fixed width encoding for the translated contents of
21515 \begin_inset Flex Code
21518 \begin_layout Plain Layout
21525 \begin_inset Flex Code
21528 \begin_layout Plain Layout
21534 code generated by this layout.
21535 This is needed for special \SpecialChar LaTeX
21540 that do not work with variable width encodings such as
21545 This setting is ignored if fully Unicode aware \SpecialChar LaTeX
21546 backends such as Xe\SpecialChar TeX
21547 or Lua\SpecialChar TeX
21551 \begin_layout Description
21552 \begin_inset Flex Code
21555 \begin_layout Plain Layout
21556 ForceLocalFontSwitch
21562 \begin_inset Flex Code
21565 \begin_layout Plain Layout
21574 \begin_inset space \thinspace{}
21578 \begin_inset Flex Code
21581 \begin_layout Plain Layout
21587 ] When using babel,
21588 always use a local font switch (
21589 \begin_inset Flex Code
21592 \begin_layout Plain Layout
21601 never a global one (such as
21602 \begin_inset Flex Code
21605 \begin_layout Plain Layout
21616 \begin_layout Description
21617 \begin_inset Flex Code
21620 \begin_layout Plain Layout
21627 \begin_inset Flex Code
21630 \begin_layout Plain Layout
21639 \begin_inset space \thinspace{}
21643 \begin_inset Flex Code
21646 \begin_layout Plain Layout
21653 \begin_inset Quotes eld
21657 \begin_inset Quotes erd
21661 leading to Left-to-Right (Latin) output,
21663 \begin_inset space \thinspace{}
21667 \begin_inset space \space{}
21670 in \SpecialChar TeX
21675 \begin_layout Description
21676 \begin_inset Flex Code
21679 \begin_layout Plain Layout
21686 \begin_inset Flex Code
21689 \begin_layout Plain Layout
21698 \begin_inset space \thinspace{}
21702 \begin_inset Flex Code
21705 \begin_layout Plain Layout
21711 ] Force a line break in the \SpecialChar LaTeX
21712 output before the inset starts and after the inset ends.
21713 This assures the inset itself is output on its own lines,
21714 for parsing purposes.
21717 \begin_layout Description
21718 \begin_inset Flex Code
21721 \begin_layout Plain Layout
21728 \begin_inset Flex Code
21731 \begin_layout Plain Layout
21740 \begin_inset space \thinspace{}
21744 \begin_inset Flex Code
21747 \begin_layout Plain Layout
21753 ] Indicates whether the
21754 \begin_inset Flex Code
21757 \begin_layout Plain Layout
21765 the user can change the paragraph style used in the inset.
21769 \begin_layout Description
21770 \begin_inset Flex Code
21773 \begin_layout Plain Layout
21780 \begin_inset Flex Code
21783 \begin_layout Plain Layout
21792 \begin_inset space \thinspace{}
21796 \begin_inset Flex Code
21799 \begin_layout Plain Layout
21805 ] As with paragraph styles,
21807 \begin_inset CommandInset ref
21809 reference "subsec:Paragraph-Styles"
21817 \begin_layout Description
21818 \begin_inset Flex Code
21821 \begin_layout Plain Layout
21827 These tags control the XHTML output.
21829 \begin_inset CommandInset ref
21831 reference "sec:Tags-for-XHTML"
21837 \change_inserted 47243155 1689528605
21841 \begin_layout Description
21843 \change_inserted 47243155 1689528735
21844 \begin_inset Flex Code
21847 \begin_layout Plain Layout
21849 \change_inserted 47243155 1689528630
21856 \begin_inset Flex Code
21859 \begin_layout Plain Layout
21861 \change_inserted 47243155 1689528607
21868 \begin_inset space \thinspace{}
21872 \begin_inset Flex Code
21875 \begin_layout Plain Layout
21877 \change_inserted 47243155 1689528607
21885 ] The font inside the inset is inherited from the parent for \SpecialChar LaTeX
21886 export if this parameter is 1,
21887 as well as on screen.
21888 Otherwise the document default font is used.
21893 \begin_layout Description
21894 \begin_inset Flex Code
21897 \begin_layout Plain Layout
21904 \begin_inset Flex Code
21907 \begin_layout Plain Layout
21916 \begin_inset space \thinspace{}
21920 \begin_inset Flex Code
21923 \begin_layout Plain Layout
21929 ] Whether to include the contents of this inset in the strings generated for the `Outline' pane for all table of contents,
21930 regardless of the AddToToc setting.
21933 want the content of a footnote in a section header to be included in the TOC displayed in the outline,
21934 but one would normally want the content of a character style displayed.
21939 \begin_layout Description
21940 \begin_inset Flex Code
21943 \begin_layout Plain Layout
21950 \begin_inset Flex Code
21953 \begin_layout Plain Layout
21962 \begin_inset space \thinspace{}
21966 \begin_inset Flex Code
21969 \begin_layout Plain Layout
21975 ] If this is set to 1 and AddToToc is enabled,
21976 the inset adds a summary of its contents in its item in the table of contents.
21978 only the label appears.
21981 \begin_layout Description
21982 \begin_inset Flex Code
21985 \begin_layout Plain Layout
21994 \begin_inset Flex Code
21997 \begin_layout Plain Layout
22006 \begin_inset space \thinspace{}
22010 \begin_inset Flex Code
22013 \begin_layout Plain Layout
22019 ] As with paragraph styles,
22021 \begin_inset CommandInset ref
22023 reference "subsec:Paragraph-Styles"
22031 \begin_layout Description
22032 \begin_inset Flex Code
22035 \begin_layout Plain Layout
22041 The font used for the label.
22043 \begin_inset CommandInset ref
22045 reference "subsec:Font-description"
22051 Note that this definition can never appear before
22052 \begin_inset Flex Code
22055 \begin_layout Plain Layout
22062 lest it be ineffective.
22065 \begin_layout Description
22066 \begin_inset Flex Code
22069 \begin_layout Plain Layout
22076 \begin_inset Flex Code
22079 \begin_layout Plain Layout
22086 \begin_inset Quotes erd
22090 \begin_inset Quotes erd
22093 ] What will be displayed on the button or elsewhere as the inset label.
22095 \begin_inset Flex Code
22098 \begin_layout Plain Layout
22106 \begin_inset Flex Code
22109 \begin_layout Plain Layout
22115 ) modify this label on the fly.
22118 \begin_layout Description
22119 \begin_inset Flex Code
22122 \begin_layout Plain Layout
22128 Language dependent preamble;
22130 \begin_inset CommandInset ref
22132 reference "subsec:I18n"
22140 \begin_layout Description
22141 \begin_inset Flex Code
22144 \begin_layout Plain Layout
22151 \begin_inset Flex Code
22154 \begin_layout Plain Layout
22160 ] The name of the corresponding \SpecialChar LaTeX
22162 Either the environment or command name.
22165 \begin_layout Description
22166 \begin_inset Flex Code
22169 \begin_layout Plain Layout
22176 \begin_inset Flex Code
22179 \begin_layout Plain Layout
22185 ] The optional parameter for the corresponding
22186 \begin_inset Flex Code
22189 \begin_layout Plain Layout
22196 including possible bracket pairs like
22197 \begin_inset Flex Code
22200 \begin_layout Plain Layout
22207 This parameter cannot be changed from within \SpecialChar LyX
22209 \begin_inset Flex Code
22212 \begin_layout Plain Layout
22218 for customizable parameters).
22219 It will be output as is after all \SpecialChar LaTeX
22221 \begin_inset Flex Code
22224 \begin_layout Plain Layout
22233 \begin_layout Description
22234 \begin_inset Flex Code
22237 \begin_layout Plain Layout
22244 \begin_inset Flex Code
22247 \begin_layout Plain Layout
22255 ] How the style should be translated into \SpecialChar LaTeX
22260 \begin_layout Plain Layout
22261 \begin_inset Flex Code
22264 \begin_layout Plain Layout
22270 is perhaps a bit misleading,
22271 since these rules apply to SGML classes too.
22272 Visit the SGML class files for specific examples.
22281 \begin_layout Description
22282 \begin_inset Flex Code
22285 \begin_layout Plain Layout
22291 means nothing special
22294 \begin_layout Description
22295 \begin_inset Flex Code
22298 \begin_layout Plain Layout
22305 \begin_inset Flex Code
22308 \begin_layout Plain Layout
22315 {\SpecialChar ldots
22324 \begin_layout Description
22325 \begin_inset Flex Code
22328 \begin_layout Plain Layout
22335 \begin_inset Flex Code
22338 \begin_layout Plain Layout
22345 }\SpecialChar ldots
22360 \begin_layout Standard
22361 Putting the last few things together,
22362 the \SpecialChar LaTeX
22363 output will be either:
22367 \begin_layout LyX-Code
22370 LatexName[LatexParam]{\SpecialChar ldots
22374 \begin_layout Standard
22379 \begin_layout LyX-Code
22382 begin{LatexName}[LatexParam] \SpecialChar ldots
22388 \begin_layout Standard
22389 depending upon the \SpecialChar LaTeX
22394 \begin_layout Description
22395 \begin_inset Flex Code
22398 \begin_layout Plain Layout
22405 \begin_inset Flex Code
22408 \begin_layout Plain Layout
22414 ] A string that is put at the beginning of the layout content.
22415 A line break in the output can be indicated by
22416 \begin_inset Flex Code
22419 \begin_layout Plain Layout
22428 \begin_layout Description
22429 \begin_inset Flex Code
22432 \begin_layout Plain Layout
22439 \begin_inset Flex Code
22442 \begin_layout Plain Layout
22450 \begin_inset Flex Code
22453 \begin_layout Plain Layout
22461 \change_deleted -584632292 1615846609
22463 \begin_inset Flex Code
22466 \begin_layout Plain Layout
22475 \begin_inset Flex Code
22478 \begin_layout Plain Layout
22484 (indicating a dummy definition ending definitions of charstyles,
22486 This entry is required in and is only meaningful for Flex insets.
22487 Among other things,
22488 it determines on which menu this inset will appear.
22490 \begin_inset Flex Code
22493 \begin_layout Plain Layout
22500 \begin_inset Flex Code
22503 \begin_layout Plain Layout
22509 will automatically set
22510 \begin_inset Flex Code
22513 \begin_layout Plain Layout
22520 \begin_inset Flex Code
22523 \begin_layout Plain Layout
22531 \begin_inset Flex Code
22534 \begin_layout Plain Layout
22540 can be set to true,
22542 \begin_inset Flex Code
22545 \begin_layout Plain Layout
22553 \begin_inset Flex Code
22556 \begin_layout Plain Layout
22562 insets by setting it
22567 \begin_inset Flex Code
22570 \begin_layout Plain Layout
22577 \change_inserted -712698321 1555575738
22581 \begin_layout Description
22583 \change_inserted -712698321 1555575844
22584 \begin_inset Flex Code
22587 \begin_layout Plain Layout
22589 \change_inserted -712698321 1555575740
22598 \begin_inset Flex Code
22601 \begin_layout Plain Layout
22603 \change_inserted -712698321 1555575740
22611 A dedicated string for the menu.
22612 You can define an accelerator by appending the respective character to the string,
22614 \begin_inset Quotes eld
22618 \begin_inset Quotes erd
22622 \begin_inset space \thinspace{}
22626 \begin_inset space \space{}
22630 \begin_inset Quotes eld
22634 \begin_inset Flex Code
22637 \begin_layout Plain Layout
22639 \change_inserted -712698321 1555575781
22648 \begin_inset Quotes erd
22652 This specification is optional.
22653 If it is not given the inset name as specified in the type declaration will be used instead for the menu.
22658 \begin_layout Description
22659 \begin_inset Flex Code
22662 \begin_layout Plain Layout
22669 \begin_inset Flex Code
22672 \begin_layout Plain Layout
22681 \begin_inset space \thinspace{}
22685 \begin_inset Flex Code
22688 \begin_layout Plain Layout
22694 ] Whether multiple paragraphs are permitted in this inset.
22696 \begin_inset Flex Code
22699 \begin_layout Plain Layout
22705 to the same value and
22706 \begin_inset Flex Code
22709 \begin_layout Plain Layout
22715 to the opposite value.
22716 These can be reset to other values,
22722 \begin_inset Flex Code
22725 \begin_layout Plain Layout
22735 \begin_layout Description
22736 \begin_inset Flex Code
22739 \begin_layout Plain Layout
22746 \begin_inset Flex Code
22749 \begin_layout Plain Layout
22758 \begin_inset space \thinspace{}
22762 \begin_inset Flex Code
22765 \begin_layout Plain Layout
22771 ] Whether fragile commands in this inset should be
22772 \begin_inset Flex Code
22775 \begin_layout Plain Layout
22789 whether the command should itself be protected.) Default is false.
22790 \change_inserted -712698321 1523633958
22794 \begin_layout Description
22796 \change_inserted -712698321 1552395786
22797 \begin_inset Flex Code
22800 \begin_layout Plain Layout
22802 \change_inserted -712698321 1523633961
22811 \begin_inset Flex Code
22814 \begin_layout Plain Layout
22816 \change_inserted -712698321 1523633958
22827 \begin_inset space \thinspace{}
22831 \begin_inset Flex Code
22834 \begin_layout Plain Layout
22836 \change_inserted -712698321 1523633958
22844 ] This causes macros that contain this inset to be protected with
22845 \begin_inset Flex Code
22848 \begin_layout Plain Layout
22850 \change_inserted -712698321 1523634038
22865 ) if necessary and thus allows (some) verbatim stuff in macros.
22869 \begin_layout Description
22871 \change_inserted -712698321 1555579651
22872 \begin_inset Flex Code
22875 \begin_layout Plain Layout
22877 \change_inserted -712698321 1552395787
22886 \begin_inset Flex Code
22889 \begin_layout Plain Layout
22891 \change_inserted -712698321 1552395787
22902 \begin_inset space \thinspace{}
22906 \begin_inset Flex Code
22909 \begin_layout Plain Layout
22911 \change_inserted -712698321 1552395787
22919 ] Whether specific commands in this inset (such as
22920 \begin_inset Flex Code
22923 \begin_layout Plain Layout
22925 \change_inserted -712698321 1552395787
22936 \begin_inset Flex Code
22939 \begin_layout Plain Layout
22941 \change_inserted -712698321 1552395787
22951 ) should be protected in an
22952 \begin_inset Flex Code
22955 \begin_layout Plain Layout
22957 \change_inserted -712698321 1552395787
22968 This is particularly needed for insets that draw on
22976 commands which parse their content in complex ways.
22980 \begin_layout Description
22982 \change_inserted -712698321 1555579742
22983 \begin_inset Flex Code
22986 \begin_layout Plain Layout
22988 \change_inserted -712698321 1555579658
22997 \begin_inset Flex Code
23000 \begin_layout Plain Layout
23002 \change_inserted -712698321 1555579651
23010 Option to define a different command (from the default
23011 \begin_inset Flex Code
23014 \begin_layout Plain Layout
23016 \change_inserted -712698321 1555579742
23028 ) to be used for line breaks.
23029 The initial backslash must not be specified.
23034 \begin_layout Description
23035 \begin_inset Flex Code
23038 \begin_layout Plain Layout
23045 \begin_inset Flex Code
23048 \begin_layout Plain Layout
23054 ] Deletes an existing
23055 \begin_inset Flex Code
23058 \begin_layout Plain Layout
23067 \begin_layout Description
23068 \begin_inset Flex Code
23071 \begin_layout Plain Layout
23078 \begin_inset Flex Code
23081 \begin_layout Plain Layout
23088 \begin_inset Flex Code
23091 \begin_layout Plain Layout
23097 that has replaced this
23098 \begin_inset Flex Code
23101 \begin_layout Plain Layout
23108 This is used to rename an
23109 \begin_inset Flex Code
23112 \begin_layout Plain Layout
23119 while keeping backward compatibility.
23120 \change_inserted -712698321 1559491850
23124 \begin_layout Description
23126 \change_inserted -712698321 1559492002
23127 \begin_inset Flex Code
23130 \begin_layout Plain Layout
23132 \change_inserted -712698321 1559491854
23141 \begin_inset Flex Code
23144 \begin_layout Plain Layout
23146 \change_inserted -712698321 1559491850
23157 \begin_inset space \thinspace{}
23161 \begin_inset Flex Code
23164 \begin_layout Plain Layout
23166 \change_inserted -712698321 1559491850
23174 ] If this is set to
23175 \begin_inset Flex Code
23178 \begin_layout Plain Layout
23180 \change_inserted -712698321 1559491881
23189 paragraph breaks will be ignored in the output.
23190 This might be useful for insets where the content should be alignable on different lines only in the \SpecialChar LyX
23192 without any effect in the output.
23197 \begin_layout Description
23198 \begin_inset Flex Code
23201 \begin_layout Plain Layout
23208 \begin_inset Flex Code
23211 \begin_layout Plain Layout
23220 \begin_inset space \thinspace{}
23224 \begin_inset Flex Code
23227 \begin_layout Plain Layout
23233 ] As with paragraph styles,
23235 \begin_inset CommandInset ref
23237 reference "subsec:Paragraph-Styles"
23246 \begin_layout Description
23247 \begin_inset Flex Code
23250 \begin_layout Plain Layout
23257 \begin_inset Flex Code
23260 \begin_layout Plain Layout
23269 \begin_inset space \thinspace{}
23273 \begin_inset Flex Code
23276 \begin_layout Plain Layout
23282 ] As with paragraph styles,
23284 \begin_inset CommandInset ref
23286 reference "subsec:Paragraph-Styles"
23295 \begin_layout Description
23296 \begin_inset Flex Code
23299 \begin_layout Plain Layout
23305 As with paragraph styles,
23307 \begin_inset CommandInset ref
23309 reference "subsec:Paragraph-Styles"
23317 \begin_layout Description
23318 \begin_inset Flex Code
23321 \begin_layout Plain Layout
23328 \begin_inset Flex Code
23331 \begin_layout Plain Layout
23337 ] The prefix to use when creating labels referring to insets of this type.
23338 This allows the use of formatted references.
23341 \begin_layout Description
23342 \begin_inset Flex Code
23345 \begin_layout Plain Layout
23352 \begin_inset Flex Code
23355 \begin_layout Plain Layout
23361 ] As with paragraph styles,
23363 \begin_inset CommandInset ref
23365 reference "subsec:Paragraph-Styles"
23373 \begin_layout Description
23374 \begin_inset Flex Code
23377 \begin_layout Plain Layout
23384 \begin_inset Flex Code
23387 \begin_layout Plain Layout
23396 \begin_inset space \thinspace{}
23400 \begin_inset Flex Code
23403 \begin_layout Plain Layout
23409 ] Resets the \SpecialChar LaTeX
23410 arguments of this layout (as defined via the
23411 \begin_inset Flex Code
23414 \begin_layout Plain Layout
23421 This is useful if you have copied a style via
23422 \begin_inset Flex Code
23425 \begin_layout Plain Layout
23432 but you do not want to inherit its (required and optional) arguments.
23435 \begin_layout Description
23436 \begin_inset Flex Code
23439 \begin_layout Plain Layout
23446 \begin_inset Flex Code
23449 \begin_layout Plain Layout
23458 \begin_inset space \thinspace{}
23462 \begin_inset Flex Code
23465 \begin_layout Plain Layout
23472 \change_inserted -712698321 1597733473
23474 \begin_inset Flex Code
23477 \begin_layout Plain Layout
23479 \change_inserted -712698321 1597732178
23488 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.
23489 \begin_inset space \thinspace{}
23494 \begin_inset Flex Code
23497 \begin_layout Plain Layout
23499 \change_inserted -712698321 1597733683
23502 textbf{Sourrounding text
23506 textbf{content}}\SpecialChar ldots
23515 \begin_inset Flex Code
23518 \begin_layout Plain Layout
23520 \change_inserted -712698321 1597733686
23523 textbf{Sourrounding text
23525 myinset{content}\SpecialChar ldots
23534 Setting this makes sense for commands that internally reset font settings (e.
23535 \begin_inset space \thinspace{}
23540 Note that wrongly setting this might lead to unwanted result (e.
23541 \begin_inset space \thinspace{}
23546 \begin_inset Flex Code
23549 \begin_layout Plain Layout
23551 \change_inserted -712698321 1597733688
23554 emph{Sourrounding text
23558 emph{content}}\SpecialChar ldots
23567 content is upright,
23569 \begin_inset Flex Code
23572 \begin_layout Plain Layout
23574 \change_inserted -712698321 1597733278
23586 \change_deleted -712698321 1597733283
23587 Whether this inset should use the font of its surrounding environment or uses its own.
23591 \change_deleted -712698321 1597733290
23593 \change_inserted -712698321 1597733290
23595 \begin_inset Flex Code
23598 \begin_layout Plain Layout
23600 \change_inserted -712698321 1597733292
23612 \change_deleted -712698321 1597733327
23613 use the font of the surrounding environment
23614 \change_inserted -712698321 1597733343
23615 font changes are not redone inside the inset
23620 \begin_layout Description
23621 \begin_inset Flex Code
23624 \begin_layout Plain Layout
23631 \begin_inset Flex Code
23634 \begin_layout Plain Layout
23640 ] A string that is put at the end of the layout content.
23641 A line break in the output can be indicated by
23642 \begin_inset Flex Code
23645 \begin_layout Plain Layout
23654 \begin_layout Description
23655 \begin_inset Flex Code
23658 \begin_layout Plain Layout
23665 \begin_inset Flex Code
23668 \begin_layout Plain Layout
23675 \begin_inset space \thinspace{}
23679 \begin_inset Flex Code
23682 \begin_layout Plain Layout
23690 ] Allow spell-checking the contents of this inset.
23692 \change_inserted -584632292 1615846659
23696 \begin_layout Subsection
23698 \change_inserted -584632292 1615846729
23700 \begin_inset CommandInset label
23702 name "subsec:Arguments"
23709 \begin_layout Standard
23711 \change_inserted -584632292 1615846807
23712 Both paragraph styles and inset layouts allow for
23716 as well as the main content.
23717 This is especially useful for things like section headings and only makes sense with \SpecialChar LaTeX
23719 Each (optional or required) argument of a command or environment—
23720 except for the required argument that is associated with the content—
23721 has a separate definition,
23722 where the number specifies the order of the arguments.
23723 The definition must end with
23724 \begin_inset Flex Code
23727 \begin_layout Plain Layout
23729 \change_inserted -584632292 1615846730
23738 So a command with two optional arguments looks like:
23741 \begin_layout Quote
23743 \change_inserted -584632292 1615846730
23749 \begin_layout Quote
23751 \change_inserted -584632292 1615846730
23757 \begin_layout Quote
23759 \change_inserted -584632292 1615846730
23765 \begin_layout Quote
23767 \change_inserted -584632292 1615846730
23773 \begin_layout Quote
23775 \change_inserted -584632292 1615846730
23781 \begin_layout Quote
23783 \change_inserted -584632292 1615846730
23789 \begin_layout Standard
23791 \change_inserted -584632292 1615846730
23793 \begin_inset Flex Code
23796 \begin_layout Plain Layout
23798 \change_inserted -584632292 1615846730
23807 the following specifications are possible:
23810 \begin_layout Itemize
23812 \change_inserted -584632292 1615846730
23813 \begin_inset Flex Code
23816 \begin_layout Plain Layout
23818 \change_inserted -584632292 1615846730
23827 \begin_inset Flex Code
23830 \begin_layout Plain Layout
23832 \change_inserted -584632292 1615846730
23840 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
23841 \begin_inset Flex Code
23844 \begin_layout Plain Layout
23846 \change_inserted -584632292 1615846730
23856 you can define an accelerator by appending the respective character to the string,
23858 \begin_inset Quotes eld
23862 \begin_inset Quotes erd
23866 \begin_inset space \thinspace{}
23870 \begin_inset space \space{}
23874 \begin_inset Quotes eld
23878 \begin_inset Flex Code
23881 \begin_layout Plain Layout
23883 \change_inserted -584632292 1615846730
23892 \begin_inset Quotes erd
23898 \begin_layout Itemize
23900 \change_inserted -584632292 1615846730
23901 \begin_inset Flex Code
23904 \begin_layout Plain Layout
23906 \change_inserted -584632292 1615846730
23915 \begin_inset Flex Code
23918 \begin_layout Plain Layout
23920 \change_inserted -584632292 1615846730
23928 A separate string for the menu.
23929 You can define an accelerator by appending the respective character to the string,
23931 \begin_inset Quotes eld
23935 \begin_inset Quotes erd
23939 \begin_inset space \thinspace{}
23943 \begin_inset space \space{}
23947 \begin_inset Quotes eld
23951 \begin_inset Flex Code
23954 \begin_layout Plain Layout
23956 \change_inserted -584632292 1615846730
23965 \begin_inset Quotes erd
23969 This specification is optional.
23970 If it is not given the
23971 \begin_inset Flex Code
23974 \begin_layout Plain Layout
23976 \change_inserted -584632292 1615846730
23984 will be used instead for the menu.
23987 \begin_layout Itemize
23989 \change_inserted -584632292 1615846730
23990 \begin_inset Flex Code
23993 \begin_layout Plain Layout
23995 \change_inserted -584632292 1615846730
24004 \begin_inset Flex Code
24007 \begin_layout Plain Layout
24009 \change_inserted -584632292 1615846730
24017 A longer explanatory text that appears in the tooltip when hovering over the argument inset.
24020 \begin_layout Itemize
24022 \change_inserted -584632292 1615846730
24023 \begin_inset Flex Code
24026 \begin_layout Plain Layout
24028 \change_inserted -584632292 1615846730
24037 \begin_inset Flex Code
24040 \begin_layout Plain Layout
24042 \change_inserted -584632292 1615846730
24053 \begin_inset space \thinspace{}
24057 \begin_inset Flex Code
24060 \begin_layout Plain Layout
24062 \change_inserted -584632292 1615846730
24070 ] Declare if this is a mandatory (1) or an optional (0) argument.
24071 Mandatory arguments will be output empty if not given,
24072 while optional arguments will not be output at all.
24074 mandatory arguments are delimited by
24075 \begin_inset Flex Code
24078 \begin_layout Plain Layout
24080 \change_inserted -584632292 1615846730
24089 while optional arguments are delimited by
24090 \begin_inset Flex Code
24093 \begin_layout Plain Layout
24095 \change_inserted -584632292 1615846730
24106 \begin_layout Itemize
24108 \change_inserted -584632292 1615846730
24109 \begin_inset Flex Code
24112 \begin_layout Plain Layout
24114 \change_inserted -584632292 1615846730
24123 \begin_inset Flex Code
24126 \begin_layout Plain Layout
24128 \change_inserted -584632292 1615846730
24136 Option to define a different command (from the default
24137 \begin_inset Flex Code
24140 \begin_layout Plain Layout
24142 \change_inserted -584632292 1615846730
24154 ) to be used for line breaks.
24155 The initial backslash must not be specified.
24158 \begin_layout Itemize
24160 \change_inserted -584632292 1615846730
24161 \begin_inset Flex Code
24164 \begin_layout Plain Layout
24166 \change_inserted -584632292 1615846730
24175 \begin_inset Flex Code
24178 \begin_layout Plain Layout
24180 \change_inserted -584632292 1615846730
24188 defines another argument (by its number) which this argument requires to be output if it is itself output.
24190 \begin_inset space \thinspace{}
24194 in \SpecialChar LaTeX
24196 optional arguments often require previous optional arguments to be output (at least empty),
24198 \begin_inset Flex Code
24201 \begin_layout Plain Layout
24203 \change_inserted -584632292 1615846730
24206 command[][argument]{text}
24214 This can be achieved by the statement
24215 \begin_inset Flex Code
24218 \begin_layout Plain Layout
24220 \change_inserted -584632292 1615846730
24229 \begin_inset Flex Code
24232 \begin_layout Plain Layout
24234 \change_inserted -584632292 1615846730
24245 \begin_layout Itemize
24247 \change_inserted -584632292 1615846730
24248 \begin_inset Flex Code
24251 \begin_layout Plain Layout
24253 \change_inserted -584632292 1615846730
24262 \begin_inset Flex Code
24265 \begin_layout Plain Layout
24267 \change_inserted -584632292 1615846730
24275 defines a custom left delimiter (instead of
24276 \begin_inset Flex Code
24279 \begin_layout Plain Layout
24281 \change_inserted -584632292 1615846730
24290 \begin_inset Flex Code
24293 \begin_layout Plain Layout
24295 \change_inserted -584632292 1615846730
24304 A line break in the output can be indicated by
24305 \begin_inset Flex Code
24308 \begin_layout Plain Layout
24310 \change_inserted -584632292 1615846730
24321 \begin_layout Itemize
24323 \change_inserted -584632292 1615846730
24324 \begin_inset Flex Code
24327 \begin_layout Plain Layout
24329 \change_inserted -584632292 1615846730
24338 \begin_inset Flex Code
24341 \begin_layout Plain Layout
24343 \change_inserted -584632292 1615846730
24351 defines a custom right delimiter (instead of
24352 \begin_inset Flex Code
24355 \begin_layout Plain Layout
24357 \change_inserted -584632292 1615846730
24366 \begin_inset Flex Code
24369 \begin_layout Plain Layout
24371 \change_inserted -584632292 1615846730
24380 A line break in the output can be indicated by
24381 \begin_inset Flex Code
24384 \begin_layout Plain Layout
24386 \change_inserted -584632292 1615846730
24397 \begin_layout Itemize
24399 \change_inserted -584632292 1615846730
24400 \begin_inset Flex Code
24403 \begin_layout Plain Layout
24405 \change_inserted -584632292 1615846730
24414 \begin_inset Flex Code
24417 \begin_layout Plain Layout
24419 \change_inserted -584632292 1615846730
24427 defines an argument that is inserted if and only if no user-specified arguments were given,
24429 \begin_inset space \thinspace{}
24433 \begin_inset space \space{}
24436 if no argument inset has been inserted (note that also an empty argument inset omits the DefaultArg).
24437 Multiple arguments need to be separated by comma.
24440 \begin_layout Itemize
24442 \change_inserted -584632292 1615846730
24443 \begin_inset Flex Code
24446 \begin_layout Plain Layout
24448 \change_inserted -584632292 1615846730
24457 \begin_inset Flex Code
24460 \begin_layout Plain Layout
24462 \change_inserted -584632292 1615846730
24470 defines an argument that is inserted in any case (alone or in addition to user-specified arguments).
24471 Multiple arguments need to be separated by comma.
24474 \begin_layout Itemize
24476 \change_inserted -584632292 1615846730
24477 \begin_inset Flex Code
24480 \begin_layout Plain Layout
24482 \change_inserted -584632292 1615846730
24490 The font used for the argument content,
24492 \begin_inset CommandInset ref
24494 reference "subsec:Font-description"
24502 \begin_layout Itemize
24504 \change_inserted -584632292 1615846730
24505 \begin_inset Flex Code
24508 \begin_layout Plain Layout
24510 \change_inserted -584632292 1615846730
24519 \begin_inset Flex Code
24522 \begin_layout Plain Layout
24524 \change_inserted -584632292 1615846730
24535 \begin_inset space \thinspace{}
24539 \begin_inset Flex Code
24542 \begin_layout Plain Layout
24544 \change_inserted -584632292 1615846730
24552 ] As with paragraph styles,
24554 \begin_inset CommandInset ref
24556 reference "subsec:Paragraph-Styles"
24564 \begin_layout Itemize
24566 \change_inserted -584632292 1615846730
24567 \begin_inset Flex Code
24570 \begin_layout Plain Layout
24572 \change_inserted -584632292 1615846730
24580 The font used for the label;
24582 \begin_inset CommandInset ref
24584 reference "subsec:Font-description"
24592 \begin_layout Itemize
24594 \change_inserted -584632292 1615846730
24595 \begin_inset Flex Code
24598 \begin_layout Plain Layout
24600 \change_inserted -584632292 1615846730
24609 \begin_inset Flex Code
24612 \begin_layout Plain Layout
24614 \change_inserted -584632292 1615846730
24628 ] describes the rendering style used for the inset's frame and buttons.
24631 \begin_layout Itemize
24633 \change_inserted -584632292 1615846730
24634 \begin_inset Flex Code
24637 \begin_layout Plain Layout
24639 \change_inserted -584632292 1615846730
24648 \begin_inset Flex Code
24651 \begin_layout Plain Layout
24653 \change_inserted -584632292 1615846730
24662 \begin_inset Flex Code
24665 \begin_layout Plain Layout
24667 \change_inserted -584632292 1615846730
24676 this argument is automatically inserted when the respective style is selected.
24679 \begin_layout Itemize
24681 \change_inserted -584632292 1615846730
24682 \begin_inset Flex Code
24685 \begin_layout Plain Layout
24687 \change_inserted -584632292 1615846730
24696 \begin_inset Flex Code
24699 \begin_layout Plain Layout
24701 \change_inserted -584632292 1615846730
24710 \begin_inset Flex Code
24713 \begin_layout Plain Layout
24715 \change_inserted -584632292 1615846730
24724 this argument will be inserted on a new line with
24725 \begin_inset Flex Code
24728 \begin_layout Plain Layout
24730 \change_inserted -584632292 1615846730
24738 (only available within Flex insets).
24741 \begin_layout Itemize
24743 \change_inserted -584632292 1615846730
24744 \begin_inset Flex Code
24747 \begin_layout Plain Layout
24749 \change_inserted -584632292 1615846730
24758 \begin_inset Flex Code
24761 \begin_layout Plain Layout
24763 \change_inserted -584632292 1615846730
24772 \begin_inset Flex Code
24775 \begin_layout Plain Layout
24777 \change_inserted -584632292 1615846730
24786 this argument will be inserted with a copy of the co-text (either selected text or the whole paragraph) as content.
24789 \begin_layout Itemize
24791 \change_inserted -584632292 1615846730
24792 \begin_inset Flex Code
24795 \begin_layout Plain Layout
24797 \change_inserted -584632292 1615846730
24806 \begin_inset Flex Code
24809 \begin_layout Plain Layout
24811 \change_inserted -584632292 1615846730
24825 ] Whether the contents of this argument should be output in raw form,
24826 meaning without special translations that \SpecialChar LaTeX
24830 \begin_inset Flex Code
24833 \begin_layout Plain Layout
24835 \change_inserted -584632292 1615846730
24843 status is inherited by the inset or paragraph layout the argument belongs to,
24844 true and false change the status for the given argument only.
24847 \begin_layout Itemize
24849 \change_inserted -584632292 1615846730
24850 \begin_inset Flex Code
24853 \begin_layout Plain Layout
24855 \change_inserted -584632292 1615846730
24864 \begin_inset Flex Code
24867 \begin_layout Plain Layout
24869 \change_inserted -584632292 1615846730
24870 string of characters
24881 Defines individual characters
24882 \begin_inset Newline linebreak
24885 that should be output in raw form,
24886 meaning without special translations that \SpecialChar LaTeX
24889 contrary to PassThru,
24890 this needs to be explicitly defined for arguments.
24892 arguments do not inherit PassThruChars from their parent inset or layout.
24895 \begin_layout Itemize
24897 \change_inserted -584632292 1615846730
24898 \begin_inset Flex Code
24901 \begin_layout Plain Layout
24903 \change_inserted -584632292 1615846730
24912 \begin_inset Flex Code
24915 \begin_layout Plain Layout
24917 \change_inserted -584632292 1615846730
24928 \begin_inset space \thinspace{}
24932 \begin_inset Flex Code
24935 \begin_layout Plain Layout
24937 \change_inserted -584632292 1615846730
24945 ] If this is set to 1,
24946 the argument will output its content in the corresponding item in the table of contents.
24950 \begin_layout Standard
24952 \change_inserted -584632292 1615846730
24954 the text entered in the \SpecialChar LyX
24955 workarea in the respective layout is the last (mandatory) argument of a command if the
24956 \begin_inset Flex Code
24959 \begin_layout Plain Layout
24961 \change_inserted -584632292 1615846730
24970 \begin_inset Flex Code
24973 \begin_layout Plain Layout
24975 \change_inserted -584632292 1615846730
24985 arguments with the prefix
24986 \begin_inset Flex Code
24989 \begin_layout Plain Layout
24991 \change_inserted -584632292 1615846730
24999 are output after this workarea argument.
25000 Note that post-argument numbering restarts at 1,
25001 so the first argument following the workarea argument is
25002 \begin_inset Flex Code
25005 \begin_layout Plain Layout
25007 \change_inserted -584632292 1615846730
25016 Post-arguments are ignored in any other
25017 \begin_inset Flex Code
25020 \begin_layout Plain Layout
25022 \change_inserted -584632292 1615846730
25031 \begin_inset Flex Code
25034 \begin_layout Plain Layout
25036 \change_inserted -584632292 1615846730
25047 \begin_layout Standard
25049 \change_inserted -584632292 1615846730
25051 \begin_inset Flex Code
25054 \begin_layout Plain Layout
25056 \change_inserted -584632292 1615846730
25067 \begin_inset Flex Code
25070 \begin_layout Plain Layout
25072 \change_inserted -584632292 1615846730
25083 \begin_inset Flex Code
25086 \begin_layout Plain Layout
25088 \change_inserted -584632292 1615846730
25096 followed by the number (e.
25097 \begin_inset space \thinspace{}
25101 \begin_inset space \space{}
25105 \begin_inset Flex Code
25108 \begin_layout Plain Layout
25110 \change_inserted -584632292 1615846730
25121 \begin_layout Standard
25123 \change_inserted -584632292 1615846730
25125 there is a special argument type with the prefix
25126 \begin_inset Flex Code
25129 \begin_layout Plain Layout
25131 \change_inserted -584632292 1615846730
25140 It is not really an argument,
25141 but uses the argument interface (thus,
25142 the prefix is also followed by a number,
25144 \begin_inset space \thinspace{}
25149 \begin_inset Flex Code
25152 \begin_layout Plain Layout
25154 \change_inserted -584632292 1615846730
25155 Argument listpreamble:1
25163 As the name implies,
25164 it is targeted at lists such as
25184 Its content will be output at the list start,
25186 \begin_inset Flex Code
25189 \begin_layout Plain Layout
25191 \change_inserted -584632292 1615846730
25202 on an own line (a place that is otherwise not accessible in \SpecialChar LyX
25205 users can insert redefinitions (of lengths etc.) to individual lists.
25207 these arguments do not have a delimiter.
25212 \begin_layout Subsection
25214 \begin_inset CommandInset label
25216 name "subsec:Counters"
25223 \begin_layout Standard
25224 It is necessary to define the counters (
25225 \begin_inset Flex Noun
25228 \begin_layout Plain Layout
25236 \begin_inset Flex Noun
25239 \begin_layout Plain Layout
25247 ) in the text class itself.
25248 The standard counters are defined in the file
25249 \begin_inset Flex Code
25252 \begin_layout Plain Layout
25259 so you may have to do no more than add
25262 \begin_layout LyX-Code
25263 Input stdcounters.inc
25266 \begin_layout Standard
25267 to your layout file to get them to work.
25268 But if you want to define custom counters,
25269 then you can do so.
25270 The counter declaration must begin with:
25273 \begin_layout LyX-Code
25274 Counter CounterName
25277 \begin_layout Standard
25279 \begin_inset Flex Code
25282 \begin_layout Plain Layout
25288 ' is replaced by the name of the counter.
25289 And it must end with
25290 \begin_inset Quotes eld
25294 \begin_inset Flex Code
25297 \begin_layout Plain Layout
25304 \begin_inset Quotes erd
25308 The following parameters can also be used:
25311 \begin_layout Description
25312 \begin_inset Flex Code
25315 \begin_layout Plain Layout
25322 \begin_inset Flex Code
25325 \begin_layout Plain Layout
25331 ] Sets the initial value for the counter,
25332 to which it will be reset whenever that happens.
25334 one will want the default,
25338 \begin_layout Description
25339 \begin_inset Flex Code
25342 \begin_layout Plain Layout
25349 \begin_inset Flex Code
25352 \begin_layout Plain Layout
25359 \begin_inset Quotes erd
25363 \begin_inset Quotes erd
25367 this string defines how the counter is displayed.
25368 Setting this value sets
25369 \begin_inset Flex Code
25372 \begin_layout Plain Layout
25373 LabelStringAppendix
25379 The following special constructs can be used in the string:
25383 \begin_layout Itemize
25384 \begin_inset Flex Code
25387 \begin_layout Plain Layout
25395 will be replaced by the expansion of the
25396 \begin_inset Flex Code
25399 \begin_layout Plain Layout
25406 \begin_inset Flex Code
25409 \begin_layout Plain Layout
25410 LabelStringAppendix
25416 \begin_inset Flex Code
25419 \begin_layout Plain Layout
25429 \begin_layout Itemize
25430 counter values can be expressed using \SpecialChar LaTeX
25432 \begin_inset Newline newline
25436 \begin_inset Flex Code
25439 \begin_layout Plain Layout
25457 \begin_inset Flex Code
25460 \begin_layout Plain Layout
25472 \begin_layout Plain Layout
25483 the situation is a bit more complicated:
25503 other than those described below will produce arabic numerals.
25504 It would not be surprising to see this change in the future.
25510 \begin_inset Flex Code
25513 \begin_layout Plain Layout
25522 3,\SpecialChar ldots
25525 \begin_inset Flex Code
25528 \begin_layout Plain Layout
25534 for lower-case letters:
25541 \begin_inset Flex Code
25544 \begin_layout Plain Layout
25550 for upper-case letters:
25557 \begin_inset Flex Code
25560 \begin_layout Plain Layout
25566 for lower-case roman numerals:
25573 \begin_inset Flex Code
25576 \begin_layout Plain Layout
25582 for upper-case roman numerals:
25585 III\SpecialChar ldots
25588 \begin_inset Flex Code
25591 \begin_layout Plain Layout
25597 for hebrew numerals.
25601 \begin_layout Standard
25602 If LabelString is not defined,
25603 a default value is constructed as follows:
25604 if the counter has a
25605 \change_deleted 731793113 1604355218
25607 \change_inserted 731793113 1604355221
25611 \begin_inset Flex Code
25614 \begin_layout Plain Layout
25616 \change_deleted 731793113 1604355223
25618 \change_inserted 731793113 1604355226
25627 \begin_inset Flex Code
25630 \begin_layout Plain Layout
25638 \begin_inset Newline newline
25642 \begin_inset Flex Code
25645 \begin_layout Plain Layout
25649 \change_inserted 731793113 1604355228
25651 \change_deleted 731793113 1604355230
25662 otherwise the string
25663 \begin_inset Flex Code
25666 \begin_layout Plain Layout
25677 \begin_layout Description
25678 \begin_inset Flex Code
25681 \begin_layout Plain Layout
25682 LabelStringAppendix
25688 \begin_inset Flex Code
25691 \begin_layout Plain Layout
25698 \begin_inset Quotes eld
25702 \begin_inset Quotes erd
25706 \begin_inset Flex Code
25709 \begin_layout Plain Layout
25716 but for use in the Appendix.
25717 \change_inserted -584632292 1607202551
25721 \begin_layout Description
25723 \change_inserted -584632292 1607202682
25724 \begin_inset Flex Code
25727 \begin_layout Plain Layout
25734 \begin_inset Flex Code
25737 \begin_layout Plain Layout
25739 \change_inserted -584632292 1607202576
25748 \begin_inset Quotes eld
25752 \begin_inset Quotes erd
25755 ] The counter name as used in \SpecialChar LaTeX
25758 \change_inserted 34634807 1619711355
25760 \change_deleted 34634807 1619711355
25762 \change_inserted -584632292 1607202682
25764 in \SpecialChar LyX
25766 there is a counter named `theorem',
25767 but it is output to \SpecialChar LaTeX
25773 \begin_layout Description
25774 \begin_inset Flex Code
25777 \begin_layout Plain Layout
25784 \begin_inset Flex Code
25787 \begin_layout Plain Layout
25794 \begin_inset Quotes erd
25798 \begin_inset Quotes erd
25801 ] A format for use with formatted references to this counter.
25803 one might want to have references to section numbers appear as
25804 \begin_inset Quotes eld
25808 \begin_inset Quotes erd
25812 The string should contain
25813 \begin_inset Quotes eld
25817 \begin_inset Quotes erd
25821 This will be replaced by the counter number itself.
25828 \begin_layout Description
25829 \begin_inset Flex Code
25832 \begin_layout Plain Layout
25839 \begin_inset Flex Code
25842 \begin_layout Plain Layout
25849 \begin_inset Quotes erd
25853 \begin_inset Quotes erd
25856 ] If this is set to the name of another counter,
25857 the present counter will be reset every time the other one is increased.
25860 \begin_inset Flex Code
25863 \begin_layout Plain Layout
25870 \begin_inset Flex Code
25873 \begin_layout Plain Layout
25882 \begin_layout Subsection
25884 \begin_inset CommandInset label
25886 name "subsec:Font-description"
25893 \begin_layout Standard
25894 A font description looks like this:
25897 \begin_layout LyX-Code
25914 \begin_layout LyX-Code
25918 \begin_layout LyX-Code
25922 \begin_layout Standard
25923 The following commands are available:
25926 \begin_layout Description
25927 \begin_inset Flex Code
25930 \begin_layout Plain Layout
25937 \change_deleted -712698321 1607682984
25939 \begin_inset Flex Code
25942 \begin_layout Plain Layout
25952 \begin_inset Flex Code
25955 \begin_layout Plain Layout
25963 \begin_inset Flex Code
25966 \begin_layout Plain Layout
25974 \begin_inset Flex Code
25977 \begin_layout Plain Layout
25985 \begin_inset Flex Code
25988 \begin_layout Plain Layout
25996 \begin_inset Flex Code
25999 \begin_layout Plain Layout
26007 \begin_inset Flex Code
26010 \begin_layout Plain Layout
26018 \begin_inset Flex Code
26021 \begin_layout Plain Layout
26029 \begin_inset Flex Code
26032 \begin_layout Plain Layout
26040 \begin_inset Flex Code
26043 \begin_layout Plain Layout
26051 \begin_inset Flex Code
26054 \begin_layout Plain Layout
26062 \begin_inset Flex Code
26065 \begin_layout Plain Layout
26073 \begin_inset Flex Code
26076 \begin_layout Plain Layout
26084 \begin_inset Flex Code
26087 \begin_layout Plain Layout
26095 \begin_inset Flex Code
26098 \begin_layout Plain Layout
26106 \begin_inset Flex Code
26109 \begin_layout Plain Layout
26117 \begin_inset Flex Code
26120 \begin_layout Plain Layout
26128 \begin_inset Flex Code
26131 \begin_layout Plain Layout
26139 \begin_inset Flex Code
26142 \begin_layout Plain Layout
26150 \begin_inset Flex Code
26153 \begin_layout Plain Layout
26160 \change_inserted -712698321 1607683139
26162 \begin_inset Flex Code
26165 \begin_layout Plain Layout
26167 \change_inserted -712698321 1607683135
26176 \begin_inset space ~
26180 \begin_inset CommandInset ref
26182 reference "chap:Names-of-colors"
26191 \change_deleted -712698321 1607683144
26193 \change_inserted -712698321 1607683146
26199 \begin_layout Description
26200 \begin_inset Flex Code
26203 \begin_layout Plain Layout
26210 \begin_inset Flex Code
26213 \begin_layout Plain Layout
26223 \begin_inset Flex Code
26226 \begin_layout Plain Layout
26234 \begin_inset Flex Code
26237 \begin_layout Plain Layout
26246 \begin_layout Description
26247 \begin_inset Flex Code
26250 \begin_layout Plain Layout
26257 \begin_inset Flex Code
26260 \begin_layout Plain Layout
26266 ] Valid arguments are:
26268 \begin_inset Flex Code
26271 \begin_layout Plain Layout
26279 \begin_inset Flex Code
26282 \begin_layout Plain Layout
26290 \begin_inset Flex Code
26293 \begin_layout Plain Layout
26301 \begin_inset Flex Code
26304 \begin_layout Plain Layout
26312 \begin_inset Flex Code
26315 \begin_layout Plain Layout
26323 \begin_inset Flex Code
26326 \begin_layout Plain Layout
26334 \begin_inset Flex Code
26337 \begin_layout Plain Layout
26345 \begin_inset Flex Code
26348 \begin_layout Plain Layout
26356 \begin_inset Flex Code
26359 \begin_layout Plain Layout
26367 \begin_inset Flex Code
26370 \begin_layout Plain Layout
26378 \begin_inset Flex Code
26381 \begin_layout Plain Layout
26388 \begin_inset Flex Code
26391 \begin_layout Plain Layout
26398 Each of these turns on or off the corresponding attribute.
26401 \begin_inset Flex Code
26404 \begin_layout Plain Layout
26412 \begin_inset Flex Code
26415 \begin_layout Plain Layout
26423 \begin_inset Newline newline
26426 If the latter seems puzzling,
26427 remember that the font settings for the present context are generally inherited from the surrounding context.
26429 \begin_inset Flex Code
26432 \begin_layout Plain Layout
26438 would turn off the emphasis that was anyway in effect,
26440 in a theorem environment.
26443 \begin_layout Description
26444 \begin_inset Flex Code
26447 \begin_layout Plain Layout
26454 \begin_inset Flex Code
26457 \begin_layout Plain Layout
26467 \begin_inset Flex Code
26470 \begin_layout Plain Layout
26479 \begin_layout Description
26480 \begin_inset Flex Code
26483 \begin_layout Plain Layout
26490 \begin_inset Flex Code
26493 \begin_layout Plain Layout
26503 \begin_inset Flex Code
26506 \begin_layout Plain Layout
26514 \begin_inset Flex Code
26517 \begin_layout Plain Layout
26525 \begin_inset Flex Code
26528 \begin_layout Plain Layout
26537 \begin_layout Description
26538 \begin_inset Flex Code
26541 \begin_layout Plain Layout
26548 \begin_inset Flex Code
26551 \begin_layout Plain Layout
26559 \begin_inset Flex Code
26562 \begin_layout Plain Layout
26570 \begin_inset Flex Code
26573 \begin_layout Plain Layout
26583 \begin_inset Flex Code
26586 \begin_layout Plain Layout
26594 \begin_inset Flex Code
26597 \begin_layout Plain Layout
26605 \begin_inset Flex Code
26608 \begin_layout Plain Layout
26616 \begin_inset Flex Code
26619 \begin_layout Plain Layout
26627 \begin_inset Flex Code
26630 \begin_layout Plain Layout
26639 \begin_layout Subsection
26640 \begin_inset CommandInset label
26642 name "subsec:Citation-engine-description"
26646 Cite engine description
26649 \begin_layout Standard
26651 \begin_inset Flex Code
26654 \begin_layout Plain Layout
26661 as used mainly in cite engine files (see
26662 \begin_inset CommandInset ref
26664 reference "subsec:Cite-Engine-Files"
26673 define the citation commands provided by a specific
26674 \begin_inset Quotes eld
26678 \begin_inset Quotes erd
26683 in \SpecialChar LyX
26685 is way specific way to format citations,
26687 author names and/or years.
26690 supports three such engine types,
26694 \begin_layout Enumerate
26695 \begin_inset Flex Code
26698 \begin_layout Plain Layout
26705 the default Bib\SpecialChar TeX
26706 way to format citations,
26707 a simple numeric style (e.
26708 \begin_inset space \thinspace{}
26713 \begin_inset Quotes eld
26717 \begin_inset Quotes erd
26723 \begin_layout Enumerate
26724 \begin_inset Flex Code
26727 \begin_layout Plain Layout
26734 Harvard-styled citations using author names and publication year (e.
26735 \begin_inset space \thinspace{}
26740 \begin_inset Quotes eld
26743 Smith and Miller (2017b)
26744 \begin_inset Quotes erd
26750 \begin_layout Enumerate
26751 \begin_inset Flex Code
26754 \begin_layout Plain Layout
26761 extended numerical citations that also allow for author or title next to the number (e.
26762 \begin_inset space \thinspace{}
26767 \begin_inset Quotes eld
26770 Smith and Miller [1]
26771 \begin_inset Quotes erd
26777 \begin_layout Standard
26778 \begin_inset Flex Code
26781 \begin_layout Plain Layout
26787 blocks look like this:
26790 \begin_layout LyX-Code
26794 \begin_layout LyX-Code
26798 \begin_layout LyX-Code
26802 \begin_layout LyX-Code
26803 citeyearpar[][]=parencite*
26806 \begin_layout LyX-Code
26810 \begin_layout LyX-Code
26814 \begin_layout Standard
26816 \begin_inset Flex Code
26819 \begin_layout Plain Layout
26825 denotes the engine.
26826 The individual lines respectively define a cite command or cite command paradigm supported by this engine.
26827 The line can be as simple as a cite command that is used both to name the respective \SpecialChar LyX
26828 command and the \SpecialChar LaTeX
26829 output or more complex in order to differentiate things.
26830 The full syntax is:
26833 \begin_layout LyX-Code
26834 LyXName|alias$*<!_stardesc!_stardesctooltip>[][]=latexcmd
26837 \begin_layout Itemize
26838 \begin_inset Flex Code
26841 \begin_layout Plain Layout
26848 The name as used in the
26849 \begin_inset Flex Code
26852 \begin_layout Plain Layout
26862 \begin_layout Standard
26863 For portability reasons,
26864 we try to use the same name for same-formatted commands in different cite packages (thus many names stem from natbib,
26865 and thus we need to differentiate a
26866 \begin_inset Flex Code
26869 \begin_layout Plain Layout
26876 if the \SpecialChar LaTeX
26877 command names differ).
26881 \begin_layout Itemize
26882 \begin_inset Flex Code
26885 \begin_layout Plain Layout
26892 a (comma-separated) list of commands that fall back to the given
26893 \begin_inset Flex Code
26896 \begin_layout Plain Layout
26902 in the current engine.
26903 This eases the switch of citation packages and engines.
26905 \begin_inset Flex Code
26908 \begin_layout Plain Layout
26915 \begin_inset Flex Code
26918 \begin_layout Plain Layout
26924 in layout definitions.
26927 \begin_layout Itemize
26928 \begin_inset Flex Code
26931 \begin_layout Plain Layout
26938 The actual \SpecialChar LaTeX
26939 command that is output.
26943 \begin_layout Standard
26944 \begin_inset Flex Code
26947 \begin_layout Plain Layout
26954 \begin_inset Flex Code
26957 \begin_layout Plain Layout
26965 \begin_inset Flex Code
26968 \begin_layout Plain Layout
26976 \begin_inset Flex Code
26979 \begin_layout Plain Layout
26985 will be output to \SpecialChar LaTeX
26989 \begin_layout Standard
26993 \begin_layout Itemize
26994 Capitalization indicates that the command also has a capitalized form (
26995 \begin_inset Flex Code
26998 \begin_layout Plain Layout
27008 \begin_inset Flex Code
27011 \begin_layout Plain Layout
27020 These usually enforce up-casing of name prefixes (
27025 \begin_inset Formula $\Rightarrow$
27035 \begin_layout Itemize
27037 \begin_inset Flex Code
27040 \begin_layout Plain Layout
27046 indicate the number of optional arguments (there can be 0–2).
27049 \begin_layout Itemize
27051 \begin_inset Flex Code
27054 \begin_layout Plain Layout
27060 indicates there is a starred version of the command (
27061 \begin_inset Flex Code
27064 \begin_layout Plain Layout
27074 \begin_inset Flex Code
27077 \begin_layout Plain Layout
27090 \begin_layout Standard
27092 the starred version means:
27093 Output all authors even if it should be shortened with
27094 \begin_inset Quotes eld
27098 \begin_inset Quotes erd
27102 \begin_inset Flex Code
27105 \begin_layout Plain Layout
27114 \begin_layout Standard
27115 If the star has a different meaning for a given command,
27116 it can be specified in angle brackets:
27118 \begin_inset Flex Code
27121 \begin_layout Plain Layout
27122 <!_stardesc!_stardesctooltip>
27128 Maximal two translatable macro keywords,
27129 marked by the prefix
27130 \begin_inset Flex Code
27133 \begin_layout Plain Layout
27141 The first points to the string that replaces the
27142 \begin_inset Quotes eld
27146 \begin_inset Quotes erd
27149 checkbox label in the citation dialog,
27150 the second one to an optional tool tip for this checkbox.
27154 \begin_layout Standard
27155 Note that these two macros have to be defined in a
27156 \begin_inset Flex Code
27159 \begin_layout Plain Layout
27165 (see next section),
27167 \begin_inset Flex Code
27170 \begin_layout Plain Layout
27181 \begin_layout LyX-Code
27182 _stardesc Sta&rred command label
27185 \begin_layout LyX-Code
27186 _stardesctooltip Tooltip for the starred command checkbox.
27190 \begin_layout Itemize
27192 \begin_inset Flex Code
27195 \begin_layout Plain Layout
27201 indicates that this command features
27202 \begin_inset Quotes eld
27205 qualified citation lists
27206 \begin_inset Quotes erd
27214 -specific feature for multi-reference citations where an individual pre- and postnote can be given to each reference in the list.
27215 Please refer to the
27219 manual for details.
27220 \change_inserted -712698321 1526898670
27224 \begin_layout Standard
27226 \change_inserted -712698321 1526899524
27227 If you want to add a cite command to a cite engine (e.
27228 \begin_inset space \thinspace{}
27232 add a specific command provided by a class),
27234 \begin_inset Flex Code
27237 \begin_layout Plain Layout
27239 \change_inserted -712698321 1526898768
27240 AddToCiteEngine <engine type> \SpecialChar ldots
27249 Note that only cite commands that do not exist yet are added.
27254 \begin_layout Subsection
27255 \begin_inset CommandInset label
27257 name "subsec:Citation-format-description"
27261 Cite format description
27264 \begin_layout Standard
27266 \begin_inset Flex Code
27269 \begin_layout Plain Layout
27275 blocks are used to describe how bibliographic information should be displayed,
27276 both within \SpecialChar LyX
27277 itself (in the citation dialog and in tooltips,
27278 for example) and in XHTML output.
27279 Such a block might look like this:
27282 \begin_layout LyX-Code
27286 \begin_layout LyX-Code
27290 \begin_layout LyX-Code
27294 \begin_layout LyX-Code
27298 \begin_layout Standard
27302 \begin_layout LyX-Code
27306 \begin_layout LyX-Code
27310 \begin_layout LyX-Code
27314 \begin_layout LyX-Code
27318 \begin_layout Standard
27320 the individual lines define how the bibliographic information associated with an article or book,
27322 is to be displayed,
27323 and such a definition can be given for any
27324 \begin_inset Quotes els
27328 \begin_inset Quotes ers
27331 that might be present in a Bib\SpecialChar TeX
27334 defines a default format in the source code that will be used if no specific definition has been given.
27336 predefines several formats in the file
27337 \begin_inset Flex Code
27340 \begin_layout Plain Layout
27347 which is included in most of \SpecialChar LyX
27348 's document classes.
27351 \begin_layout Standard
27352 In the second case,
27353 the lines define how a specific citation command (in the example
27354 \begin_inset Flex Code
27357 \begin_layout Plain Layout
27367 \begin_inset Flex Code
27370 \begin_layout Plain Layout
27378 ) is to be displayed on the citation inset label,
27379 in the citation dialog,
27380 menu or XHTML output.
27382 defines such formats for the citation style variants it supports via
27384 Document\SpecialChar menuseparator
27385 Setting\SpecialChar menuseparator
27386 Bibliography\SpecialChar ldots
27390 \begin_inset Flex Code
27393 \begin_layout Plain Layout
27399 files that are shipped with \SpecialChar LyX
27401 \begin_inset CommandInset ref
27403 reference "subsec:Cite-Engine-Files"
27414 \begin_layout Standard
27415 The definitions use a simple language that allows Bib\SpecialChar TeX
27416 keys to be replaced with their values.
27417 Keys should be enclosed in
27418 \begin_inset Flex Code
27421 \begin_layout Plain Layout
27430 \begin_inset Flex Code
27433 \begin_layout Plain Layout
27440 So a simple definition might look like this:
27443 \begin_layout LyX-Code
27446 \begin_inset Quotes eld
27450 \begin_inset Quotes erd
27456 \begin_layout Standard
27457 This would print the author,
27458 followed by a comma,
27459 followed by the title,
27461 followed by a period.
27464 \begin_layout Standard
27466 sometimes you may want to print a key only if it exists.
27467 This can be done by using a conditional construction,
27470 \begin_inset Flex Code
27473 \begin_layout Plain Layout
27475 \begin_inset space ~
27486 \begin_inset Flex Code
27489 \begin_layout Plain Layout
27497 \begin_inset Quotes eld
27501 \begin_inset space ~
27505 \begin_inset Quotes erd
27508 followed by the volume key.
27509 It is also possible to have an else clause in the conditional,
27511 \begin_inset Newline newline
27515 \begin_inset Flex Code
27518 \begin_layout Plain Layout
27519 {%author%[[%author%]][[%editor%,
27526 \begin_inset Newline newline
27531 \begin_inset Flex Code
27534 \begin_layout Plain Layout
27540 key is printed if it exists;
27542 the editor key is printed,
27544 \begin_inset Quotes eld
27548 \begin_inset space ~
27552 \begin_inset Quotes erd
27555 Note that the key is again enclosed in
27556 \begin_inset Flex Code
27559 \begin_layout Plain Layout
27566 the entire conditional is enclosed in braces;
27567 and the if and else clauses are enclosed in double brackets,
27569 \begin_inset Quotes eld
27573 \begin_inset Flex Code
27576 \begin_layout Plain Layout
27583 \begin_inset Quotes eld
27587 \begin_inset Quotes eld
27591 \begin_inset Flex Code
27594 \begin_layout Plain Layout
27601 \begin_inset Quotes erd
27605 There must be no space between any of these.
27608 \begin_layout Standard
27609 Next to the entry keys,
27610 there are some special keys that can be used for these conditionals:
27613 \begin_layout Itemize
27614 \begin_inset Flex Code
27617 \begin_layout Plain Layout
27618 {%dialog%[[true]][[false]]}
27625 \begin_inset Quotes eld
27629 \begin_inset Quotes erd
27632 part for dialogs and menus,
27634 \begin_inset Quotes eld
27638 \begin_inset Quotes erd
27641 part for other contexts (workarea,
27645 \begin_layout Itemize
27646 \begin_inset Flex Code
27649 \begin_layout Plain Layout
27650 {%export%[[true]][[false]]}
27657 \begin_inset Quotes eld
27661 \begin_inset Quotes erd
27664 part for export and menus,
27666 \begin_inset Quotes eld
27670 \begin_inset Quotes erd
27673 part for other contexts (workarea,
27677 \begin_layout Itemize
27678 \begin_inset Flex Code
27681 \begin_layout Plain Layout
27689 \begin_inset Quotes eld
27693 \begin_inset Quotes erd
27696 part if another item follows (e.
27697 \begin_inset space \thinspace{}
27701 in a citation with multiple keys)
27704 \begin_layout Itemize
27705 \begin_inset Flex Code
27708 \begin_layout Plain Layout
27709 {%second%[[true]][[false]]}
27716 \begin_inset Quotes eld
27720 \begin_inset Quotes erd
27723 if this is the second of multiple items,
27725 \begin_inset Quotes eld
27729 \begin_inset Quotes erd
27735 \begin_layout Itemize
27736 \begin_inset Flex Code
27739 \begin_layout Plain Layout
27740 {%ifstar%[[true]][[false]]}
27747 \begin_inset Quotes eld
27751 \begin_inset Quotes erd
27754 part for starred citation commands (such as
27755 \begin_inset Flex Code
27758 \begin_layout Plain Layout
27767 the false part for unstarred
27770 \begin_layout Itemize
27771 \begin_inset Flex Code
27774 \begin_layout Plain Layout
27775 {%ifentrytype:<type>%[[true]][[false]]}
27782 \begin_inset Quotes eld
27786 \begin_inset Quotes erd
27789 if the current entry type matches
27790 \begin_inset Flex Code
27793 \begin_layout Plain Layout
27800 else the false part (e.g.,
27801 in a citation definition:
27803 \begin_inset Flex Code
27806 \begin_layout Plain Layout
27807 {%ifentrytype:book%[[this is a book]][[this is no book]]}
27815 \begin_layout Itemize
27816 \begin_inset Flex Code
27819 \begin_layout Plain Layout
27820 {%ifmultiple:<authortype>%[[true]][[false]]}
27827 \begin_inset Quotes eld
27831 \begin_inset Quotes erd
27834 if the current author type (author,
27835 editor etc.) has multiple authors,
27836 else the false part (e.g.,
27837 in a bibliography definition:
27839 \begin_inset Flex Code
27842 \begin_layout Plain Layout
27843 {%ifmultiple:editor%[[eds.]][[ed.]]}
27851 \begin_layout Itemize
27852 \begin_inset Flex Code
27855 \begin_layout Plain Layout
27856 {%ifqualified%[[true]][[false]]}
27863 \begin_inset Quotes eld
27867 \begin_inset Quotes erd
27870 part if the current citation is a qualified citation list (a specific
27874 format for multi-reference citations),
27875 the false part if this is not the case.
27878 \begin_layout Standard
27880 \begin_inset Flex Code
27883 \begin_layout Plain Layout
27889 prints the author key as it is recorded in the bibliography file.
27890 This might not be what you want,
27891 since it will result in a string such as
27892 \begin_inset Quotes eld
27899 \begin_inset Quotes erd
27903 \begin_inset Quotes eld
27907 \begin_inset Quotes erd
27910 is used by Bib\SpecialChar TeX
27911 to delimit authors).
27913 therefore provides some methods to get properly formatted name lists (which will also get translated).
27914 The following keys are provided:
27917 \begin_layout Enumerate
27918 For name lists with pre- and surname,
27919 suitable for the main authors/editors of a bibliography item.
27921 \begin_inset Flex Code
27924 \begin_layout Plain Layout
27930 part denotes the kind of list that is requested (e.g.
27932 \begin_inset Flex Code
27935 \begin_layout Plain Layout
27945 \begin_layout Itemize
27946 \begin_inset Flex Code
27949 \begin_layout Plain Layout
27950 %abbrvnames:<nametype>%
27956 Provides a name list which is abbreviated (with
27957 \begin_inset Quotes eld
27961 \begin_inset Quotes erd
27965 \begin_inset Flex Code
27968 \begin_layout Plain Layout
27977 \begin_layout Itemize
27978 \begin_inset Flex Code
27981 \begin_layout Plain Layout
27982 %fullnames:<nametype>%
27988 Provides a full name list (never abbreviated with
27989 \begin_inset Quotes eld
27993 \begin_inset Quotes erd
27999 \begin_layout Itemize
28000 \begin_inset Flex Code
28003 \begin_layout Plain Layout
28004 %forceabbrvnames:<nametype>%
28010 Provides a name list which is always abbreviated (with
28011 \begin_inset Quotes eld
28015 \begin_inset Quotes erd
28019 \begin_inset Flex Code
28022 \begin_layout Plain Layout
28032 \begin_layout Enumerate
28033 Alternative name lists with pre- and surname,
28034 if the order of pre- and surname inside the bibliography item differs (as in:
28036 \begin_inset Quotes eld
28046 \begin_inset Quotes erd
28053 \begin_layout Itemize
28054 \begin_inset Flex Code
28057 \begin_layout Plain Layout
28058 %abbrvbynames:<nametype>%
28064 Provides a name list which is abbreviated (with
28065 \begin_inset Quotes eld
28069 \begin_inset Quotes erd
28073 \begin_inset Flex Code
28076 \begin_layout Plain Layout
28085 \begin_layout Itemize
28086 \begin_inset Flex Code
28089 \begin_layout Plain Layout
28090 %fullbynames:<nametype>%
28096 Provides a full name list (never abbreviated with
28097 \begin_inset Quotes eld
28101 \begin_inset Quotes erd
28107 \begin_layout Itemize
28108 \begin_inset Flex Code
28111 \begin_layout Plain Layout
28112 %forceabbrvbynames:<nametype>%
28118 Provides a name list which is always abbreviated (with
28119 \begin_inset Quotes eld
28123 \begin_inset Quotes erd
28127 \begin_inset Flex Code
28130 \begin_layout Plain Layout
28140 \begin_layout Enumerate
28141 And finally name lists which consist of family names only,
28142 as used in author-year citation labels.
28143 These do not take a
28144 \begin_inset Flex Code
28147 \begin_layout Plain Layout
28154 but always return either an author list or,
28155 if this does not exist,
28156 an editor list (as common in author-year labels):
28160 \begin_layout Itemize
28161 \begin_inset Flex Code
28164 \begin_layout Plain Layout
28171 Provides a name list which is abbreviated (with
28172 \begin_inset Quotes eld
28176 \begin_inset Quotes erd
28180 \begin_inset Flex Code
28183 \begin_layout Plain Layout
28192 \begin_layout Itemize
28193 \begin_inset Flex Code
28196 \begin_layout Plain Layout
28203 Provides a full name list (never abbreviated with
28204 \begin_inset Quotes eld
28208 \begin_inset Quotes erd
28214 \begin_layout Itemize
28215 \begin_inset Flex Code
28218 \begin_layout Plain Layout
28219 %forceabbrvciteauthor%
28225 Provides a name list which is always abbreviated (with
28226 \begin_inset Quotes eld
28230 \begin_inset Quotes erd
28234 \begin_inset Flex Code
28237 \begin_layout Plain Layout
28247 \begin_layout Standard
28248 The order of pre- and surname in the former two lists can be adjusted by these macros:
28251 \begin_layout Itemize
28252 \begin_inset Flex Code
28255 \begin_layout Plain Layout
28256 !firstnameform %surname%,
28262 (first author in lists of type 1)
28265 \begin_layout Itemize
28266 \begin_inset Flex Code
28269 \begin_layout Plain Layout
28270 !othernameform %surname%,
28276 (other authors in lists of type 1)
28279 \begin_layout Itemize
28280 \begin_inset Flex Code
28283 \begin_layout Plain Layout
28284 !firstbynameform %prename% %surname%
28289 (first author in lists of type 2)
28292 \begin_layout Itemize
28293 \begin_inset Flex Code
28296 \begin_layout Plain Layout
28297 !otherbynameform %prename% %surname%
28302 (other authors in lists of type 2)
28305 \begin_layout Standard
28306 This allows you to configure namings like
28307 \begin_inset Quotes eld
28311 Peter and Mary Smith:
28315 John Doe and Pat Green,
28316 eds.:\SpecialChar ldots
28318 \begin_inset Quotes erd
28324 \begin_layout Standard
28325 There is one other piece of syntax available in definitions,
28326 which looks like this:
28328 \begin_inset Flex Code
28331 \begin_layout Plain Layout
28338 This defines a piece of formatting information that is to be used when creating
28339 \begin_inset Quotes eld
28343 \begin_inset Quotes erd
28348 we do not want to output HTML tags when writing plain text,
28349 so they should be wrapped in
28350 \begin_inset Quotes eld
28354 \begin_inset Quotes erd
28358 \begin_inset Quotes eld
28362 \begin_inset Quotes erd
28368 \begin_layout Standard
28369 Two special sorts of definitions are also possible in a
28370 \begin_inset Flex Code
28373 \begin_layout Plain Layout
28380 An example of the first would be:
28383 \begin_layout LyX-Code
28385 \begin_inset Quotes eld
28389 \begin_inset Quotes erd
28395 \begin_layout Standard
28396 This is an abbreviation,
28398 and it can be used by treating it as if it were a key:
28400 \begin_inset Flex Code
28403 \begin_layout Plain Layout
28412 \begin_inset Flex Code
28415 \begin_layout Plain Layout
28421 exactly as it would treat its definition.
28423 let us issue the obvious
28431 \begin_layout LyX-Code
28435 \begin_layout Standard
28436 or anything like it.
28438 shouldn't go into an infinite loop,
28439 but it may go into a long one before it gives up.
28442 \begin_layout Standard
28443 The second sort of special definition might look like this:
28446 \begin_layout LyX-Code
28450 \begin_layout Standard
28451 This defines a translatable piece of text,
28452 which allows relevant parts of the bibliography or citation to be translated.
28453 It can be included in a definition by treating it as a key:
28455 \begin_inset Flex Code
28458 \begin_layout Plain Layout
28465 Note that there are two different translation paths:
28466 All definitions starting with
28467 \begin_inset Flex Code
28470 \begin_layout Plain Layout
28477 such as in the example above,
28478 will be translated to the currently active buffer language (so the translation will match the generated document).
28479 All definitions starting with underscore only will be translated to the GUI language.
28480 This is the proper translation for strings that only occur in the dialogs or on buttons,
28484 \begin_layout LyX-Code
28485 _addtobib Add to bibliography only.
28488 \begin_layout Standard
28489 Several of these translatable strings are predefined in
28490 \begin_inset Flex Code
28493 \begin_layout Plain Layout
28500 \begin_inset Flex Code
28503 \begin_layout Plain Layout
28510 Note that these are not macros,
28511 in the sense just defined.
28512 They will not be expanded.
28515 \begin_layout Standard
28516 So here then is an example that uses several of these features:
28517 \begin_inset VSpace defskip
28523 \begin_layout Standard
28527 !authoredit {%author%[[%author%,
28528 ]][[{%editor%[[%editor%,
28533 \begin_layout Standard
28534 \begin_inset VSpace defskip
28537 This defines a macro that prints the author,
28538 followed by a comma,
28540 \begin_inset Flex Code
28543 \begin_layout Plain Layout
28550 or else prints the name of the editor,
28552 \begin_inset Flex Code
28555 \begin_layout Plain Layout
28561 or its translation (it is by default
28562 \begin_inset Quotes eld
28566 \begin_inset Quotes erd
28571 \begin_inset Flex Code
28574 \begin_layout Plain Layout
28581 Note that this is in fact defined in
28582 \begin_inset Flex Code
28585 \begin_layout Plain Layout
28592 so you can use it in your own definitions,
28594 if you load that file first.
28597 \begin_layout Section
28598 \begin_inset CommandInset label
28600 name "sec:Tags-for-XHTML"
28604 Tags for XHTML output
28607 \begin_layout Standard
28608 As with \SpecialChar LaTeX
28610 the format of \SpecialChar LyX
28611 's XHTML output is also controlled by layout information.
28614 provides sensible defaults and,
28615 as mentioned earlier,
28616 it will even construct default CSS style rules from the other layout tags.
28619 will attempt to use the information provided in the
28620 \begin_inset Flex Code
28623 \begin_layout Plain Layout
28629 declaration for the Chapter style to write CSS that will appropriately format chapter headings.
28632 \begin_layout Standard
28635 you may not have to do anything at all to get acceptable XHTML output for your own environments,
28638 But in some cases you will,
28639 and so \SpecialChar LyX
28640 provides a number of layout tags that can be used to customize the XHTML and CSS that are generated.
28643 \begin_layout Standard
28644 Note that there are two tags,
28646 \begin_inset Flex Code
28649 \begin_layout Plain Layout
28656 \begin_inset Flex Code
28659 \begin_layout Plain Layout
28665 that may appear outside style and inset declarations.
28667 \begin_inset CommandInset ref
28669 reference "subsec:General-text-class"
28674 for details on these.
28677 \begin_layout Subsection
28678 \begin_inset CommandInset label
28680 name "subsec:Paragraph-Style-XHTML"
28687 \begin_layout Standard
28688 The sort of XHTML \SpecialChar LyX
28689 outputs for a paragraph depends upon whether we are dealing with a normal paragraph,
28692 where this is itself determined by the contents of the corresponding
28693 \begin_inset Flex Code
28696 \begin_layout Plain Layout
28707 \begin_layout Standard
28708 For a command or normal paragraph,
28709 the output XHTML has the following form:
28712 \begin_layout LyX-Code
28716 \begin_inset Quotes erd
28720 \begin_inset Quotes erd
28726 \begin_layout LyX-Code
28730 \begin_inset Quotes erd
28734 \begin_inset Quotes erd
28740 \begin_layout LyX-Code
28743 Contents of the paragraph.
28746 \begin_layout LyX-Code
28752 \begin_layout Standard
28753 The label tags are of course omitted if the paragraph does not have a label.
28756 \begin_layout Standard
28757 For an environment that is not some sort of list,
28758 the XHTML takes this form:
28761 \begin_layout LyX-Code
28765 \begin_inset Quotes erd
28769 \begin_inset Quotes erd
28775 \begin_layout LyX-Code
28779 \begin_inset Quotes erd
28783 \begin_inset Quotes erd
28787 \begin_inset Quotes erd
28791 \begin_inset Quotes erd
28794 >Environment Label</labeltag>First paragraph.</itemtag>
28797 \begin_layout LyX-Code
28800 <itemtag>Second paragraph.</itemtag>
28803 \begin_layout LyX-Code
28809 \begin_layout Standard
28810 Note that the label is output only for the first paragraph,
28811 as it should be for a theorem,
28816 \begin_layout Standard
28818 we have one of these forms:
28821 \begin_layout LyX-Code
28825 \begin_inset Quotes erd
28829 \begin_inset Quotes erd
28835 \begin_layout LyX-Code
28839 \begin_inset Quotes erd
28843 \begin_inset Quotes erd
28847 \begin_inset Quotes erd
28851 \begin_inset Quotes erd
28854 >List Label</labeltag>First item.</itemtag>
28857 \begin_layout LyX-Code
28861 \begin_inset Quotes erd
28865 \begin_inset Quotes erd
28869 \begin_inset Quotes erd
28873 \begin_inset Quotes erd
28876 >List Label</labeltag>Second item.</itemtag>
28879 \begin_layout LyX-Code
28885 \begin_layout LyX-Code
28889 \begin_layout LyX-Code
28893 \begin_inset Quotes erd
28897 \begin_inset Quotes erd
28903 \begin_layout LyX-Code
28907 \begin_inset Quotes erd
28911 \begin_inset Quotes erd
28914 >List Label</labeltag><itemtag attr=
28915 \begin_inset Quotes erd
28919 \begin_inset Quotes erd
28922 >First item.</itemtag>
28925 \begin_layout LyX-Code
28929 \begin_inset Quotes erd
28933 \begin_inset Quotes erd
28936 >List Label</labeltag><itemtag attr=
28937 \begin_inset Quotes erd
28941 \begin_inset Quotes erd
28944 >Second item.</itemtag>
28947 \begin_layout LyX-Code
28953 \begin_layout Standard
28954 Note the different orders of
28955 \begin_inset Flex Code
28958 \begin_layout Plain Layout
28965 \begin_inset Flex Code
28968 \begin_layout Plain Layout
28975 Which order we get depends upon the setting of
28976 \begin_inset Flex Code
28979 \begin_layout Plain Layout
28987 \begin_inset Flex Code
28990 \begin_layout Plain Layout
28996 is false (the default),
28997 you get the first of these,
28998 with the label within the item;
29000 you get the second,
29001 with the label outside the item.
29004 \begin_layout Standard
29005 The specific tags and attributes output for each paragraph type can be controlled by means of the layout tags we are about to describe.
29006 As mentioned earlier,
29009 uses sensible defaults for many of these,
29010 so you often may not need to do very much to get good XHTML output.
29011 Think of the available tags as there so you can tweak things to your liking.
29014 \begin_layout Description
29015 \begin_inset Flex Code
29018 \begin_layout Plain Layout
29025 \begin_inset Flex Code
29028 \begin_layout Plain Layout
29034 ] Specifies attribute information to be output with the main tag.
29037 \begin_inset Quotes eld
29041 \begin_inset Flex Code
29044 \begin_layout Plain Layout
29051 \begin_inset Quotes erd
29058 \begin_inset Quotes eld
29062 \begin_inset Flex Code
29065 \begin_layout Plain Layout
29072 \begin_inset Quotes erd
29077 \begin_inset Flex Code
29080 \begin_layout Plain Layout
29086 is the \SpecialChar LyX
29087 name of the layout,
29095 contain any style information.
29097 \begin_inset Flex Code
29100 \begin_layout Plain Layout
29107 \change_inserted -584632292 1670182206
29111 \begin_layout Description
29113 \change_inserted -584632292 1670182369
29114 \begin_inset Flex Code
29117 \begin_layout Plain Layout
29119 \change_inserted -584632292 1670182222
29128 \begin_inset Flex Code
29131 \begin_layout Plain Layout
29133 \change_inserted -584632292 1670182217
29141 ] The CSS class to use for this paragraph.
29143 if the paragarph is of enumerate or itemize type,
29144 then the default will be
29145 \begin_inset Quotes eld
29149 \begin_inset Quotes erd
29153 \begin_inset Quotes eld
29157 \begin_inset Quotes erd
29162 \begin_inset Quotes eld
29166 \begin_inset Quotes erd
29171 \begin_inset Quotes eld
29175 \begin_inset Quotes erd
29180 \begin_inset Quotes eld
29184 \begin_inset Quotes erd
29189 \begin_inset Quotes eld
29193 \begin_inset Quotes erd
29197 depending upon the depth.
29198 That can be over-ridden here.
29200 the suffix will not be added in that case.
29202 the CSS class will always be exactly what it is declared to be here.
29207 \begin_layout Description
29208 \begin_inset Flex Code
29211 \begin_layout Plain Layout
29218 \begin_inset Flex Code
29221 \begin_layout Plain Layout
29231 ] Whether to output the default CSS information \SpecialChar LyX
29232 generates for this layout,
29233 even if additional information is explicitly provided via
29234 \begin_inset Flex Code
29237 \begin_layout Plain Layout
29245 \begin_inset Flex Code
29248 \begin_layout Plain Layout
29254 allows you to alter or augment the generated CSS,
29255 rather than to override it completely.
29257 \begin_inset Flex Code
29260 \begin_layout Plain Layout
29267 \change_inserted -584632292 1670132213
29271 \begin_layout Description
29273 \change_inserted -584632292 1670132277
29274 \begin_inset Flex Code
29277 \begin_layout Plain Layout
29279 \change_inserted -584632292 1670132221
29288 \begin_inset Flex Code
29291 \begin_layout Plain Layout
29293 \change_inserted -584632292 1670132214
29303 ] Whether to include this paragraph (usually,
29304 a section or something of the sort) in the TOC.
29307 so it should be set to false e.g.
29308 \begin_inset space ~
29311 for starred sections.
29316 \begin_layout Description
29317 \begin_inset Flex Code
29320 \begin_layout Plain Layout
29327 \begin_inset Flex Code
29330 \begin_layout Plain Layout
29336 ] The tag to be used for individual paragraphs of environments,
29338 \begin_inset Flex Code
29341 \begin_layout Plain Layout
29347 in the examples above.
29349 \begin_inset Flex Code
29352 \begin_layout Plain Layout
29361 \begin_layout Description
29362 \begin_inset Flex Code
29365 \begin_layout Plain Layout
29372 \begin_inset Flex Code
29375 \begin_layout Plain Layout
29381 ] Attributes for the item tag.
29383 \begin_inset Newline newline
29387 \begin_inset Quotes eld
29391 \begin_inset Flex Code
29394 \begin_layout Plain Layout
29395 class=`layoutname_item'
29401 \begin_inset Quotes erd
29409 contain any style information.
29411 \begin_inset Flex Code
29414 \begin_layout Plain Layout
29423 \begin_layout Description
29424 \begin_inset Flex Code
29427 \begin_layout Plain Layout
29434 \begin_inset Flex Code
29437 \begin_layout Plain Layout
29443 ] The tag to be used for paragraph and item labels,
29445 \begin_inset Flex Code
29448 \begin_layout Plain Layout
29454 in the examples above.
29456 \begin_inset Flex Code
29459 \begin_layout Plain Layout
29467 \begin_inset Flex Code
29470 \begin_layout Plain Layout
29477 \begin_inset Flex Code
29480 \begin_layout Plain Layout
29487 \begin_inset Flex Code
29490 \begin_layout Plain Layout
29491 Centered_Top_Environment
29497 in which case it defaults to
29498 \begin_inset Flex Code
29501 \begin_layout Plain Layout
29510 \begin_layout Description
29511 \begin_inset Flex Code
29514 \begin_layout Plain Layout
29521 \begin_inset Flex Code
29524 \begin_layout Plain Layout
29530 ] Attributes for the label tag.
29532 \begin_inset Newline newline
29536 \begin_inset Quotes eld
29540 \begin_inset Flex Code
29543 \begin_layout Plain Layout
29544 class=`layoutname_label'
29550 \begin_inset Quotes erd
29558 contain any style information.
29560 \begin_inset Flex Code
29563 \begin_layout Plain Layout
29572 \begin_layout Description
29573 \begin_inset Flex Code
29576 \begin_layout Plain Layout
29583 \begin_inset Flex Code
29586 \begin_layout Plain Layout
29596 ] Meaningful only for list-like environments,
29597 this tag controls whether the label tag is output before or inside the item tag.
29600 in the description environment,
29602 \begin_inset Flex Code
29605 \begin_layout Plain Layout
29606 <dt>\SpecialChar ldots
29607 </dt><dd>\SpecialChar ldots
29615 \begin_inset Flex Code
29618 \begin_layout Plain Layout
29625 The label tag is output inside the item tag.
29628 \begin_layout Description
29629 \begin_inset Flex Code
29632 \begin_layout Plain Layout
29638 Information to be output in the
29639 \begin_inset Flex Code
29642 \begin_layout Plain Layout
29648 section when this style is used.
29651 be used to include a
29652 \begin_inset Flex Code
29655 \begin_layout Plain Layout
29662 \begin_inset Flex Code
29665 \begin_layout Plain Layout
29674 \begin_layout Description
29675 \begin_inset Flex Code
29678 \begin_layout Plain Layout
29684 CSS style information to be included when this style is used.
29685 Note that this will automatically be wrapped in a layout-generated
29686 \begin_inset Flex Code
29689 \begin_layout Plain Layout
29696 so only the CSS itself need be included.
29698 \begin_inset Flex Code
29701 \begin_layout Plain Layout
29710 \begin_layout Description
29711 \begin_inset Flex Code
29714 \begin_layout Plain Layout
29721 \begin_inset Flex Code
29724 \begin_layout Plain Layout
29730 ] The tag to be used for the main label,
29732 \begin_inset Flex Code
29735 \begin_layout Plain Layout
29741 in the examples above.
29743 \begin_inset Flex Code
29746 \begin_layout Plain Layout
29755 \begin_layout Description
29756 \begin_inset Flex Code
29759 \begin_layout Plain Layout
29766 \begin_inset Flex Code
29769 \begin_layout Plain Layout
29779 ] Marks this style as the one to be used to generate the
29780 \begin_inset Flex Code
29783 \begin_layout Plain Layout
29789 tag for the XHTML file.
29793 \begin_inset Flex Code
29796 \begin_layout Plain Layout
29802 file sets it to true for the
29803 \begin_inset Flex Code
29806 \begin_layout Plain Layout
29816 \begin_layout Subsection
29820 \begin_layout Standard
29821 The XHTML output of insets can also be controlled by information in layout files.
29825 \begin_layout Plain Layout
29827 this is true only for
29828 \begin_inset Quotes eld
29832 \begin_inset Quotes erd
29835 insets (insets you can type into) and is not true for
29836 \begin_inset Quotes eld
29840 \begin_inset Quotes erd
29843 insets (insets that are associated with dialog boxes).
29851 tries to provide sensible defaults,
29852 and it constructs default CSS style rules.
29853 But everything can be customized.
29856 \begin_layout Standard
29857 The XHTML \SpecialChar LyX
29858 outputs for an inset has the following form:
29861 \begin_layout LyX-Code
29863 \begin_inset Quotes erd
29867 \begin_inset Quotes erd
29873 \begin_layout LyX-Code
29874 <labeltag>Label</labeltag>
29877 \begin_layout LyX-Code
29879 \begin_inset Quotes erd
29883 \begin_inset Quotes erd
29886 >Contents of the inset.</innertag>
29889 \begin_layout LyX-Code
29893 \begin_layout Standard
29894 If the inset permits multiple paragraphs—
29897 \begin_inset Flex Code
29900 \begin_layout Plain Layout
29907 then the contents of the inset will itself be output as paragraphs formatted according to the styles used for those paragraphs (standard,
29910 The label tag is of course omitted if the paragraph does not have a label and,
29913 \begin_inset Flex Code
29916 \begin_layout Plain Layout
29923 The inner tag is optional and,
29928 \begin_layout Standard
29929 The specific tags and attributes output for each inset can be controlled by means of the following layout tags.
29932 \begin_layout Description
29933 \begin_inset Flex Code
29936 \begin_layout Plain Layout
29943 \begin_inset Flex Code
29946 \begin_layout Plain Layout
29952 ] Specifies attribute information to be output with the main tag.
29955 \begin_inset Quotes eld
29959 \begin_inset Flex Code
29962 \begin_layout Plain Layout
29963 class=`myinset' onclick=`\SpecialChar ldots
29970 \begin_inset Quotes erd
29977 \begin_inset Quotes eld
29981 \begin_inset Flex Code
29984 \begin_layout Plain Layout
29991 \begin_inset Quotes erd
29996 \begin_inset Flex Code
29999 \begin_layout Plain Layout
30005 is the \SpecialChar LyX
30007 made lowercase and with non-alphanumeric characters converted to underscores,
30012 \begin_layout Description
30013 \begin_inset Flex Code
30016 \begin_layout Plain Layout
30023 \begin_inset Flex Code
30026 \begin_layout Plain Layout
30036 ] Whether to output the default CSS information \SpecialChar LyX
30037 generates for this layout,
30038 even if additional information is explicitly provided via
30039 \begin_inset Flex Code
30042 \begin_layout Plain Layout
30050 \begin_inset Flex Code
30053 \begin_layout Plain Layout
30059 allows you to alter or augment the generated CSS,
30060 rather than to override it completely.
30064 \begin_layout Description
30065 \begin_inset Flex Code
30068 \begin_layout Plain Layout
30075 \begin_inset Flex Code
30078 \begin_layout Plain Layout
30084 ] Attributes for the inner tag.
30086 \begin_inset Newline newline
30090 \begin_inset Quotes eld
30094 \begin_inset Flex Code
30097 \begin_layout Plain Layout
30098 class=`insetname_inner'
30104 \begin_inset Quotes erd
30110 \begin_layout Description
30111 \begin_inset Flex Code
30114 \begin_layout Plain Layout
30121 \begin_inset Flex Code
30124 \begin_layout Plain Layout
30132 \begin_inset Flex Code
30135 \begin_layout Plain Layout
30141 in the examples above.
30146 \begin_layout Description
30147 \begin_inset Flex Code
30150 \begin_layout Plain Layout
30157 \begin_inset Flex Code
30160 \begin_layout Plain Layout
30168 ] 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).
30172 \begin_layout Description
30173 \begin_inset Flex Code
30176 \begin_layout Plain Layout
30183 \begin_inset Flex Code
30186 \begin_layout Plain Layout
30192 ] A label for this inset,
30193 possibly including a reference to a counter.
30198 \begin_inset Flex Code
30201 \begin_layout Plain Layout
30211 and there is no default.
30214 \begin_layout Description
30215 \begin_inset Flex Code
30218 \begin_layout Plain Layout
30224 Information to be output in the
30225 \begin_inset Flex Code
30228 \begin_layout Plain Layout
30234 section when this style is used.
30237 be used to include a
30238 \begin_inset Flex Code
30241 \begin_layout Plain Layout
30248 \begin_inset Flex Code
30251 \begin_layout Plain Layout
30260 \begin_layout Description
30261 \begin_inset Flex Code
30264 \begin_layout Plain Layout
30270 CSS style information to be included when this style is used.
30271 Note that this will automatically be wrapped in a layout-generated
30272 \begin_inset Flex Code
30275 \begin_layout Plain Layout
30282 so only the CSS itself need be included.
30285 \begin_layout Description
30286 \begin_inset Flex Code
30289 \begin_layout Plain Layout
30296 \begin_inset Flex Code
30299 \begin_layout Plain Layout
30305 ] The tag to be used for the main label,
30307 \begin_inset Flex Code
30310 \begin_layout Plain Layout
30316 in the examples above.
30317 The default depends upon the setting of
30318 \begin_inset Flex Code
30321 \begin_layout Plain Layout
30329 \begin_inset Flex Code
30332 \begin_layout Plain Layout
30340 \begin_inset Flex Code
30343 \begin_layout Plain Layout
30352 \begin_inset Flex Code
30355 \begin_layout Plain Layout
30364 \begin_layout Subsection
30368 \begin_layout Standard
30369 The XHTML output for floats too can be controlled by layout information.
30370 The output has the following form:
30373 \begin_layout LyX-Code
30375 \begin_inset Quotes erd
30379 \begin_inset Quotes erd
30385 \begin_layout LyX-Code
30386 Contents of the float.
30389 \begin_layout LyX-Code
30393 \begin_layout Standard
30396 is a separate inset and will be output as such.
30397 Its appearance can be controlled via the InsetLayout for caption insets.
30401 \begin_layout Description
30402 \begin_inset Flex Code
30405 \begin_layout Plain Layout
30412 \begin_inset Flex Code
30415 \begin_layout Plain Layout
30421 ] Specifies attribute information to be output with the main tag.
30424 \begin_inset Quotes eld
30428 \begin_inset Flex Code
30431 \begin_layout Plain Layout
30432 class=`myfloat' onclick=`\SpecialChar ldots
30439 \begin_inset Quotes erd
30446 \begin_inset Quotes eld
30450 \begin_inset Flex Code
30453 \begin_layout Plain Layout
30454 class=`float float-floattype'
30460 \begin_inset Quotes erd
30465 \begin_inset Flex Code
30468 \begin_layout Plain Layout
30474 is \SpecialChar LyX
30475 's name for this type of float,
30476 as determined by the float declaration (see
30477 \begin_inset CommandInset ref
30479 reference "subsec:Floats"
30485 though made lowercase and with non-alphanumeric characters converted to underscores,
30490 \begin_layout Description
30491 \begin_inset Flex Code
30494 \begin_layout Plain Layout
30500 CSS style information to be included when this float is used.
30501 Note that this will automatically be wrapped in a layout-generated
30502 \begin_inset Flex Code
30505 \begin_layout Plain Layout
30512 so only the CSS itself need be included.
30515 \begin_layout Description
30516 \begin_inset Flex Code
30519 \begin_layout Plain Layout
30526 \begin_inset Flex Code
30529 \begin_layout Plain Layout
30535 ] The tag to be used for this float,
30537 \begin_inset Quotes eld
30541 \begin_inset Flex Code
30544 \begin_layout Plain Layout
30551 \begin_inset Quotes erd
30554 in the example above.
30556 \begin_inset Flex Code
30559 \begin_layout Plain Layout
30565 and will rarely need changing.
30568 \begin_layout Subsection
30569 Bibliography formatting
30572 \begin_layout Standard
30573 The bibliography can be formatted using
30574 \begin_inset Flex Code
30577 \begin_layout Plain Layout
30585 \begin_inset CommandInset ref
30587 reference "subsec:Citation-format-description"
30595 \begin_layout Subsection
30600 \begin_layout Standard
30601 We have several times mentioned that \SpecialChar LyX
30602 will generate default CSS style rules for both insets and paragraph styles,
30603 based upon the other layout information that is provided.
30605 we shall say a word about which layout information \SpecialChar LyX
30609 \begin_layout Standard
30612 auto-generates CSS only for font information,
30614 \begin_inset Flex Code
30617 \begin_layout Plain Layout
30625 \begin_inset Flex Code
30628 \begin_layout Plain Layout
30636 \begin_inset Flex Code
30639 \begin_layout Plain Layout
30647 \begin_inset Flex Code
30650 \begin_layout Plain Layout
30657 \begin_inset Flex Code
30660 \begin_layout Plain Layout
30667 \begin_inset CommandInset ref
30669 reference "subsec:Font-description"
30675 The translation is mostly straightforward and obvious.
30678 \begin_inset Quotes eld
30682 \begin_inset Flex Code
30685 \begin_layout Plain Layout
30692 \begin_inset Quotes erd
30696 \begin_inset Quotes eld
30700 \begin_inset Flex Code
30703 \begin_layout Plain Layout
30711 \begin_inset Quotes erd
30715 The correspondence of \SpecialChar LyX
30716 sizes and CSS sizes is a little less obvious but nonetheless intuitive.
30718 \begin_inset Flex Code
30721 \begin_layout Plain Layout
30728 \begin_inset Flex URL
30731 \begin_layout Plain Layout
30739 \change_inserted -970929547 1496610908
30743 \begin_layout Section
30745 \change_inserted -970929547 1496610966
30746 \begin_inset CommandInset label
30748 name "sec:Tags-for-DocBook"
30752 Tags for DocBook output
30755 \begin_layout Standard
30757 \change_inserted -970929547 1496611615
30758 As with \SpecialChar LaTeX
30760 the format of \SpecialChar LyX
30761 's DocBook output is also controlled by layout information.
30764 provides sensible defaults;
30766 much of the styling is lost during the conversion,
30767 as DocBook is strictly semantic and does not allow formatting.
30769 information from \SpecialChar LyX
30770 will be rendered in
30778 \begin_layout Standard
30780 \change_inserted -970929547 1496612080
30783 you may not have to do anything at all to get acceptable DocBook output for your own environments,
30786 But in some cases you will,
30787 and so \SpecialChar LyX
30788 provides a number of layout tags that can be used to customize the DocBook that is generated.
30791 \begin_layout Standard
30793 \change_inserted -970929547 1515109912
30794 Labels are rarely output,
30795 as they are redundant in DocBook:
30796 this information is carried by the tags themselves,
30797 and whether labels appear in the final documents (after processing of DocBook files) is controlled by the stylesheets.
30800 labels are not redundant content,
30801 such as definition lists:
30803 the term being defined will be the label.
30807 \begin_layout Subsection
30809 \change_inserted 1075283030 1597699417
30810 \begin_inset CommandInset label
30812 name "subsec:Paragraph-Style-DocBook"
30817 \change_deleted 1075283030 1597699417
30819 \begin_inset CommandInset label
30821 name "subsec:Paragraph-Style-XHTML-1"
30826 \change_inserted -970929547 1496610966
30830 \begin_layout Standard
30832 \change_inserted -970929547 1496612059
30833 The sort of DocBook \SpecialChar LyX
30834 outputs for a paragraph depends upon whether we are dealing with a normal paragraph,
30837 where this is itself determined by the contents of the corresponding
30838 \begin_inset Flex Code
30841 \begin_layout Plain Layout
30843 \change_inserted -970929547 1496610966
30856 \begin_layout Standard
30858 \change_inserted -970929547 1496612107
30859 For a command or normal paragraph,
30860 the output DocBook has the following form:
30863 \begin_layout LyX-Code
30865 \change_inserted -970929547 1515109666
30869 \begin_layout LyX-Code
30871 \change_inserted -970929547 1496610966
30872 Contents of the paragraph.
30875 \begin_layout LyX-Code
30877 \change_inserted -970929547 1496610966
30881 \begin_layout Standard
30883 \change_inserted -970929547 1515109821
30884 For an environment that is not some sort of list,
30885 the generated DocBook takes this form:
30888 \begin_layout LyX-Code
30890 \change_inserted -970929547 1515109671
30894 \begin_layout LyX-Code
30896 \change_inserted -970929547 1496612114
30897 <itemtag>First paragraph.</itemtag>
30900 \begin_layout LyX-Code
30902 \change_inserted -970929547 1496610966
30903 <itemtag>Second paragraph.</itemtag>
30906 \begin_layout LyX-Code
30908 \change_inserted -970929547 1496610966
30912 \begin_layout Standard
30914 \change_inserted -970929547 1515109825
30916 the resulting DocBook takes this form:
30919 \begin_layout LyX-Code
30921 \change_inserted -970929547 1515109672
30925 \begin_layout LyX-Code
30927 \change_inserted -970929547 1515109676
30928 <itemtag attr>First item.</itemtag>
30931 \begin_layout LyX-Code
30933 \change_inserted -970929547 1515109678
30934 <itemtag attr>Second item.</itemtag>
30937 \begin_layout LyX-Code
30939 \change_inserted -970929547 1496610966
30943 \begin_layout Standard
30945 \change_inserted -970929547 1496612243
30946 The specific tags and roles output for each paragraph type can be controlled by means of the layout tags we are about to describe.
30948 due to the very nature of DocBook,
30949 no sensible defaults really exist,
30950 and the values must always be carefully chosen.
30954 \begin_layout Description
30956 \change_inserted -970929547 1515110057
30957 \begin_inset Flex Code
30960 \begin_layout Plain Layout
30962 \change_inserted -970929547 1515109656
30971 \begin_inset Flex Code
30974 \begin_layout Plain Layout
30976 \change_inserted -970929547 1496610966
30984 ] Specifies attribute information to be output with the main tag,
30986 \begin_inset Quotes eld
30990 \begin_inset Flex Code
30993 \begin_layout Plain Layout
30995 \change_inserted -970929547 1515110057
31004 \begin_inset Quotes erd
31007 in the example above.
31008 This information can be used in further processing of the DocBook files.
31014 \begin_layout Description
31016 \change_inserted -970929547 1496612296
31017 \begin_inset Flex Code
31020 \begin_layout Plain Layout
31022 \change_inserted -970929547 1496612269
31031 \begin_inset Flex Code
31034 \begin_layout Plain Layout
31036 \change_inserted -970929547 1496610966
31044 ] The tag to be used for this inset,
31046 \begin_inset Quotes eld
31050 \begin_inset Flex Code
31053 \begin_layout Plain Layout
31055 \change_inserted -970929547 1496612296
31064 \begin_inset Quotes erd
31067 in the example above.
31068 The default is the name of the float and always needs to be changed,
31069 as DocBook provides no generic tag.
31070 \change_inserted 1075283030 1597698868
31074 \begin_layout Description
31076 \change_inserted 1075283030 1597699399
31077 \begin_inset Flex Code
31080 \begin_layout Plain Layout
31082 \change_inserted 1075283030 1597698872
31091 \begin_inset Flex Code
31094 \begin_layout Plain Layout
31096 \change_inserted 1075283030 1597700585
31106 ] The new-line policy for this tag,
31108 \begin_inset space ~
31112 \begin_inset CommandInset ref
31114 reference "subsec:DocBook-New-line-policy"
31128 \begin_layout Subsection
31130 \change_inserted 1075283030 1597699385
31132 \begin_inset CommandInset label
31134 name "subsec:DocBook-New-line-policy"
31141 \begin_layout Standard
31143 \change_inserted 1075283030 1597698993
31145 there are three possible policies for outputting new lines (given in the
31146 \begin_inset Flex Code
31149 \begin_layout Plain Layout
31151 \change_inserted 1075283030 1597698987
31163 \begin_layout Itemize
31165 \change_inserted 1075283030 1597699279
31166 \begin_inset Quotes eld
31170 \begin_inset Flex Code
31173 \begin_layout Plain Layout
31175 \change_inserted 1075283030 1597699012
31184 \begin_inset Quotes erd
31188 the opening and closing tags are on their own lines (i.e.
31189 a line feed after and before the opening and the closing tags).
31190 Typical elements are floats.
31195 \begin_layout LyX-Code
31197 \change_inserted 1075283030 1597699194
31201 \begin_layout LyX-Code
31203 \change_inserted 1075283030 1597699194
31207 \begin_layout LyX-Code
31209 \change_inserted 1075283030 1597699098
31210 Contents of the block.
31213 \begin_layout LyX-Code
31215 \change_inserted 1075283030 1597699196
31219 \begin_layout LyX-Code
31221 \change_inserted 1075283030 1597699198
31225 \begin_layout Itemize
31227 \change_inserted 1075283030 1597699289
31228 \begin_inset Quotes eld
31232 \begin_inset Flex Code
31235 \begin_layout Plain Layout
31237 \change_inserted 1075283030 1597699113
31246 \begin_inset Quotes erd
31250 the opening and closing tags are on the same,
31252 a line feed is output before the opening tag and after the closing tag.
31253 Typical elements are paragraphs and list items.
31258 \begin_layout LyX-Code
31260 \change_inserted 1075283030 1597699186
31264 \begin_layout LyX-Code
31266 \change_inserted 1075283030 1597699357
31267 <paratag>Contents of the paragraph.</paratag>
31270 \begin_layout LyX-Code
31272 \change_inserted 1075283030 1597699231
31276 \begin_layout Itemize
31278 \change_inserted 1075283030 1597699343
31279 \begin_inset Quotes eld
31283 \begin_inset Flex Code
31286 \begin_layout Plain Layout
31288 \change_inserted 1075283030 1597699307
31297 \begin_inset Quotes erd
31301 the opening and closing tags are on the same line as the rest of the content.
31302 No line feeds are output.
31303 Typical elements are fonts.
31308 \begin_layout LyX-Code
31310 \change_inserted 1075283030 1597699585
31311 Content before<inlinetag>Contents of the paragraph.</inlinetag>Content after
31314 \begin_layout Standard
31316 \change_inserted 1075283030 1597699585
31317 The default value is always
31318 \begin_inset Quotes eld
31322 \begin_inset Flex Code
31325 \begin_layout Plain Layout
31327 \change_inserted 1075283030 1597699585
31336 \begin_inset Quotes erd
31344 \begin_layout Subsection
31346 \change_inserted -970929547 1515111533
31347 InsetLayout DocBook
31352 \begin_layout Standard
31354 \change_inserted -970929547 1496611894
31355 The DocBook output of insets can also be controlled by information in layout files.
31358 \begin_layout Standard
31360 \change_inserted -970929547 1496612045
31361 The DocBook \SpecialChar LyX
31362 outputs for an inset has the following form:
31365 \begin_layout LyX-Code
31367 \change_inserted -970929547 1515110861
31368 <wrappertag wrapperattr>
31371 \begin_layout LyX-Code
31373 \change_inserted -970929547 1515110868
31377 \begin_layout LyX-Code
31379 \change_inserted -970929547 1515110869
31380 <innertag innerattr>
31383 \begin_layout LyX-Code
31385 \change_inserted -970929547 1515110869
31386 Contents of the inset.
31389 \begin_layout LyX-Code
31391 \change_inserted -970929547 1515110870
31395 \begin_layout LyX-Code
31397 \change_inserted -970929547 1515110871
31401 \begin_layout LyX-Code
31403 \change_inserted -970929547 1515111172
31407 \begin_layout Standard
31409 \change_inserted -970929547 1515111186
31410 For an itemising inset,
31411 it rather looks like this:
31415 \begin_layout LyX-Code
31417 \change_inserted -970929547 1515111186
31418 <wrappertag wrapperattr>
31421 \begin_layout LyX-Code
31423 \change_inserted -970929547 1515111186
31427 \begin_layout LyX-Code
31429 \change_inserted -970929547 1515111186
31430 <innertag innerattr>
31433 \begin_layout LyX-Code
31435 \change_inserted -970929547 1515111362
31436 <itemwrappertag itemwrapperattr>
31439 \begin_layout LyX-Code
31441 \change_inserted -970929547 1515111364
31442 <itemlabeltag itemattr>
31445 \begin_layout LyX-Code
31447 \change_inserted -970929547 1515111367
31448 Label of the first item.
31451 \begin_layout LyX-Code
31453 \change_inserted -970929547 1515111362
31459 \begin_layout LyX-Code
31461 \change_inserted -970929547 1515111517
31465 \begin_layout LyX-Code
31467 \change_inserted -970929547 1515111517
31473 \begin_layout LyX-Code
31475 \change_inserted -970929547 1515111516
31476 Contents of the first item.
31479 \begin_layout LyX-Code
31481 \change_inserted -970929547 1515111514
31487 \begin_layout LyX-Code
31489 \change_inserted -970929547 1515111247
31495 \begin_layout LyX-Code
31497 \change_inserted -970929547 1515111221
31501 \begin_layout LyX-Code
31503 \change_inserted -970929547 1515111370
31504 <itemwrappertag itemwrapperattr>
31507 \begin_layout LyX-Code
31509 \change_inserted -970929547 1515111370
31510 <itemlabeltag itemattr>
31513 \begin_layout LyX-Code
31515 \change_inserted -970929547 1515111372
31516 Label of the second item.
31519 \begin_layout LyX-Code
31521 \change_inserted -970929547 1515111370
31527 \begin_layout LyX-Code
31529 \change_inserted -970929547 1515111504
31533 \begin_layout LyX-Code
31535 \change_inserted -970929547 1515111505
31541 \begin_layout LyX-Code
31543 \change_inserted -970929547 1515111507
31544 Contents of the second item.
31547 \begin_layout LyX-Code
31549 \change_inserted -970929547 1515111509
31555 \begin_layout LyX-Code
31557 \change_inserted -970929547 1515111251
31563 \begin_layout LyX-Code
31565 \change_inserted -970929547 1515111221
31571 \begin_layout LyX-Code
31573 \change_inserted -970929547 1515111219
31579 \begin_layout LyX-Code
31581 \change_inserted -970929547 1515111186
31585 \begin_layout LyX-Code
31587 \change_inserted -970929547 1515111186
31591 \begin_layout LyX-Code
31593 \change_inserted -970929547 1515111186
31597 \begin_layout Standard
31599 \change_inserted -970929547 1515111183
31600 If the inset permits multiple paragraphs—
31603 \begin_inset Flex Code
31606 \begin_layout Plain Layout
31608 \change_inserted -970929547 1496610966
31617 then the contents of the inset will
31618 \change_deleted 34634807 1620029217
31620 \change_inserted 34634807 1620029219
31622 \change_inserted -970929547 1515111183
31623 be output as paragraphs formatted according to the styles used for those paragraphs (standard,
31626 The inner tag is optional and,
31631 \begin_layout Standard
31633 \change_inserted -970929547 1496610966
31634 The specific tags and attributes output for each inset can be controlled by means of the following layout tags.
31637 \begin_layout Description
31639 \change_inserted -970929547 1515110317
31640 \begin_inset Flex Code
31643 \begin_layout Plain Layout
31645 \change_inserted -970929547 1515109695
31654 \begin_inset Flex Code
31657 \begin_layout Plain Layout
31659 \change_inserted -970929547 1496611854
31667 ] Specifies attribute information to be output with the main tag,
31669 \begin_inset Quotes eld
31673 \begin_inset Flex Code
31676 \begin_layout Plain Layout
31678 \change_inserted -970929547 1515110044
31687 \begin_inset Quotes erd
31690 in the example above.
31691 This information can be used in further processing of the DocBook files.
31695 \begin_layout Description
31697 \change_inserted -970929547 1515110973
31698 \begin_inset Flex Code
31701 \begin_layout Plain Layout
31703 \change_inserted -970929547 1515110319
31712 \begin_inset Flex Code
31715 \begin_layout Plain Layout
31717 \change_inserted -970929547 1515110384
31727 ] Specifies whether this tag goes into the
31728 \begin_inset Flex Code
31731 \begin_layout Plain Layout
31733 \change_inserted -970929547 1515110412
31741 tag at the beginning of the parent layout.
31743 \begin_inset Flex Code
31746 \begin_layout Plain Layout
31748 \change_inserted -970929547 1515110437
31756 indicates that the tag never goes into
31757 \begin_inset Flex Code
31760 \begin_layout Plain Layout
31762 \change_inserted -970929547 1515110497
31770 (this is default value,
31771 and corresponds to usual content).
31773 \begin_inset Flex Code
31776 \begin_layout Plain Layout
31778 \change_inserted -970929547 1515110517
31786 indicates that the tag always goes into
31787 \begin_inset Flex Code
31790 \begin_layout Plain Layout
31792 \change_inserted -970929547 1515110514
31800 (this corresponds to usual metadata):
31802 \begin_inset Flex Code
31805 \begin_layout Plain Layout
31807 \change_inserted -970929547 1515110550
31815 tag for the parent,
31822 \begin_inset Flex Code
31825 \begin_layout Plain Layout
31827 \change_inserted -970929547 1515110540
31835 indicates that the tag may go into
31836 \begin_inset Flex Code
31839 \begin_layout Plain Layout
31841 \change_inserted -970929547 1515110538
31849 (this is only the case for titles):
31851 \begin_inset Flex Code
31854 \begin_layout Plain Layout
31856 \change_inserted -970929547 1515110585
31864 tag for the parent,
31870 the corresponding tag will be output directly as content.
31874 \begin_layout Description
31876 \change_inserted -970929547 1515111461
31877 \begin_inset Flex Code
31880 \begin_layout Plain Layout
31882 \change_inserted -970929547 1515110974
31891 \begin_inset Flex Code
31894 \begin_layout Plain Layout
31896 \change_inserted -970929547 1515110973
31904 ] Specifies attribute information to be output with the item tag,
31906 \begin_inset Quotes eld
31910 \begin_inset Flex Code
31913 \begin_layout Plain Layout
31915 \change_inserted -970929547 1515110984
31924 \begin_inset Quotes erd
31927 in the example above.
31928 This information can be used in further processing of the DocBook files.
31932 \begin_layout Description
31934 \change_inserted -970929547 1515111471
31935 \begin_inset Flex Code
31938 \begin_layout Plain Layout
31940 \change_inserted -970929547 1515111465
31941 DocBookItemInnerAttr
31949 \begin_inset Flex Code
31952 \begin_layout Plain Layout
31954 \change_inserted -970929547 1515111461
31962 ] Specifies attribute information to be output with the item inner tag,
31964 \begin_inset Quotes eld
31968 \begin_inset Flex Code
31971 \begin_layout Plain Layout
31973 \change_inserted -970929547 1515111476
31982 \begin_inset Quotes erd
31985 in the example above.
31986 This information can be used in further processing of the DocBook files.
31990 \begin_layout Description
31992 \change_inserted -970929547 1515111494
31993 \begin_inset Flex Code
31996 \begin_layout Plain Layout
31998 \change_inserted -970929547 1515111467
31999 DocBookItemInnerTag
32007 \begin_inset Flex Code
32010 \begin_layout Plain Layout
32012 \change_inserted -970929547 1515111461
32020 ] The tag to be used for the item inner tag within the inset,
32022 \begin_inset Quotes eld
32026 \begin_inset Flex Code
32029 \begin_layout Plain Layout
32031 \change_inserted -970929547 1515111486
32040 \begin_inset Quotes erd
32043 in the example above.
32045 \begin_inset Flex Code
32048 \begin_layout Plain Layout
32050 \change_inserted -970929547 1515111461
32059 indicating that there is no item inner tag:
32060 content is directly output without it for each itemised element.
32061 This parameter only makes sense when itemising layouts are used,
32064 \change_inserted 1075283030 1598469472
32065 The most likely value is
32066 \begin_inset Quotes eld
32070 \begin_inset Flex Code
32073 \begin_layout Plain Layout
32075 \change_inserted 1075283030 1598469476
32084 \begin_inset Quotes erd
32088 \begin_inset Newline newline
32091 When a list item is split using a new line,
32092 the item inner tag will be repeated for each part of the paragraph,
32093 parts being separated by new lines.
32097 \begin_layout Description
32099 \change_inserted 1075283030 1597699866
32100 \begin_inset Flex Code
32103 \begin_layout Plain Layout
32105 \change_inserted 1075283030 1597699853
32106 DocBookItemInnerTagType
32114 \begin_inset Flex Code
32117 \begin_layout Plain Layout
32119 \change_inserted 1075283030 1597699866
32129 ] The new-line policy for this tag,
32131 \begin_inset space ~
32135 \begin_inset CommandInset ref
32137 reference "subsec:DocBook-New-line-policy"
32151 \begin_layout Description
32153 \change_inserted -970929547 1515111290
32154 \begin_inset Flex Code
32157 \begin_layout Plain Layout
32159 \change_inserted -970929547 1515111283
32160 DocBookItemLabelAttr
32168 \begin_inset Flex Code
32171 \begin_layout Plain Layout
32173 \change_inserted -970929547 1515111279
32181 ] Specifies attribute information to be output with the item label tag,
32183 \begin_inset Quotes eld
32187 \begin_inset Flex Code
32190 \begin_layout Plain Layout
32192 \change_inserted -970929547 1515111304
32201 \begin_inset Quotes erd
32204 in the example above.
32205 This information can be used in further processing of the DocBook files.
32209 \begin_layout Description
32211 \change_inserted -970929547 1515111337
32212 \begin_inset Flex Code
32215 \begin_layout Plain Layout
32217 \change_inserted -970929547 1515111285
32218 DocBookItemLabelTag
32226 \begin_inset Flex Code
32229 \begin_layout Plain Layout
32231 \change_inserted -970929547 1515111279
32239 ] The tag to be used for the item label tag within the inset,
32241 \begin_inset Quotes eld
32245 \begin_inset Flex Code
32248 \begin_layout Plain Layout
32250 \change_inserted -970929547 1515111311
32259 \begin_inset Quotes erd
32262 in the example above.
32263 This parameter only makes sense when itemising layouts are used with a notion of labels,
32264 such as definition lists.
32266 \change_inserted 1075283030 1597699874
32270 \begin_layout Description
32272 \change_inserted 1075283030 1597699874
32273 \begin_inset Flex Code
32276 \begin_layout Plain Layout
32278 \change_inserted 1075283030 1597699880
32279 DocBookItemLabelTagType
32287 \begin_inset Flex Code
32290 \begin_layout Plain Layout
32292 \change_inserted 1075283030 1597699874
32302 ] The new-line policy for this tag,
32304 \begin_inset space ~
32308 \begin_inset CommandInset ref
32310 reference "subsec:DocBook-New-line-policy"
32324 \begin_layout Description
32326 \change_inserted -970929547 1515111124
32327 \begin_inset Flex Code
32330 \begin_layout Plain Layout
32332 \change_inserted -970929547 1515111060
32341 \begin_inset Flex Code
32344 \begin_layout Plain Layout
32346 \change_inserted -970929547 1515111060
32354 ] The tag to be used for the item tag within the inset,
32356 \begin_inset Quotes eld
32360 \begin_inset Flex Code
32363 \begin_layout Plain Layout
32365 \change_inserted -970929547 1515111060
32374 \begin_inset Quotes erd
32377 in the example above.
32379 \begin_inset Flex Code
32382 \begin_layout Plain Layout
32384 \change_inserted -970929547 1515111060
32393 indicating that there is no item tag.
32394 This parameter only makes sense when itemising layouts are used,
32397 \change_inserted 1075283030 1597699890
32401 \begin_layout Description
32403 \change_inserted 1075283030 1597699890
32404 \begin_inset Flex Code
32407 \begin_layout Plain Layout
32409 \change_inserted 1075283030 1597699890
32418 \begin_inset Flex Code
32421 \begin_layout Plain Layout
32423 \change_inserted 1075283030 1597699890
32433 ] The new-line policy for this tag,
32435 \begin_inset space ~
32439 \begin_inset CommandInset ref
32441 reference "subsec:DocBook-New-line-policy"
32455 \begin_layout Description
32457 \change_inserted -970929547 1515111298
32458 \begin_inset Flex Code
32461 \begin_layout Plain Layout
32463 \change_inserted -970929547 1515111124
32464 DocBookItemWrapperAttr
32472 \begin_inset Flex Code
32475 \begin_layout Plain Layout
32477 \change_inserted -970929547 1515111124
32485 ] Specifies attribute information to be output with the item wrapper tag,
32487 \begin_inset Quotes eld
32491 \begin_inset Flex Code
32494 \begin_layout Plain Layout
32496 \change_inserted -970929547 1515111150
32505 \begin_inset Quotes erd
32508 in the example above.
32509 This information can be used in further processing of the DocBook files.
32515 \begin_layout Description
32517 \change_inserted -970929547 1515111113
32518 \begin_inset Flex Code
32521 \begin_layout Plain Layout
32523 \change_inserted -970929547 1515111073
32524 DocBookItemWrapperTag
32532 \begin_inset Flex Code
32535 \begin_layout Plain Layout
32537 \change_inserted -970929547 1515111073
32545 ] The tag to be used for the item wrapper tag within the inset,
32547 \begin_inset Quotes eld
32551 \begin_inset Flex Code
32554 \begin_layout Plain Layout
32556 \change_inserted -970929547 1515111083
32565 \begin_inset Quotes erd
32568 in the example above.
32570 \begin_inset Flex Code
32573 \begin_layout Plain Layout
32575 \change_inserted -970929547 1515111073
32584 indicating that there is no item wrapper tag:
32585 tag and content are directly output without it for each itemised element.
32586 This parameter only makes sense when itemising layouts are used,
32589 \change_inserted 1075283030 1597699897
32593 \begin_layout Description
32595 \change_inserted 1075283030 1597699897
32596 \begin_inset Flex Code
32599 \begin_layout Plain Layout
32601 \change_inserted 1075283030 1597699900
32602 DocBookItemWrapperTagType
32610 \begin_inset Flex Code
32613 \begin_layout Plain Layout
32615 \change_inserted 1075283030 1597699897
32625 ] The new-line policy for this tag,
32627 \begin_inset space ~
32631 \begin_inset CommandInset ref
32633 reference "subsec:DocBook-New-line-policy"
32647 \begin_layout Description
32649 \change_inserted -970929547 1515110104
32650 \begin_inset Flex Code
32653 \begin_layout Plain Layout
32655 \change_inserted -970929547 1515110104
32664 \begin_inset Flex Code
32667 \begin_layout Plain Layout
32669 \change_inserted -970929547 1515110104
32677 ] Specifies attribute information to be output with the inner tag,
32679 \begin_inset Quotes eld
32683 \begin_inset Flex Code
32686 \begin_layout Plain Layout
32688 \change_inserted -970929547 1515110104
32697 \begin_inset Quotes erd
32700 in the example above.
32701 This information can be used in further processing of the DocBook files.
32705 \begin_layout Description
32707 \change_inserted -970929547 1515110906
32708 \begin_inset Flex Code
32711 \begin_layout Plain Layout
32713 \change_inserted -970929547 1515110104
32722 \begin_inset Flex Code
32725 \begin_layout Plain Layout
32727 \change_inserted -970929547 1515110104
32735 ] The tag to be used for the inner tag within the inset,
32737 \begin_inset Quotes eld
32741 \begin_inset Flex Code
32744 \begin_layout Plain Layout
32746 \change_inserted -970929547 1515110104
32755 \begin_inset Quotes erd
32758 in the example above.
32760 \begin_inset Flex Code
32763 \begin_layout Plain Layout
32765 \change_inserted -970929547 1515110791
32774 indicating that there is no inner tag:
32775 content is directly output without it.
32776 \change_inserted 1075283030 1597699904
32780 \begin_layout Description
32782 \change_inserted 1075283030 1597699904
32783 \begin_inset Flex Code
32786 \begin_layout Plain Layout
32788 \change_inserted 1075283030 1597699904
32789 DocBookInnerTagType
32797 \begin_inset Flex Code
32800 \begin_layout Plain Layout
32802 \change_inserted 1075283030 1597699904
32812 ] The new-line policy for this tag,
32814 \begin_inset space ~
32818 \begin_inset CommandInset ref
32820 reference "subsec:DocBook-New-line-policy"
32834 \begin_layout Description
32836 \change_inserted -970929547 1515110753
32837 \begin_inset Flex Code
32840 \begin_layout Plain Layout
32842 \change_inserted -970929547 1515110665
32851 \begin_inset Flex Code
32854 \begin_layout Plain Layout
32856 \change_inserted -970929547 1515110661
32864 ] Specifies the tag that corresponds to this kind of section.
32865 This parameter only makes sense for sectioning elements (part,
32869 The default value is
32870 \begin_inset Flex Code
32873 \begin_layout Plain Layout
32875 \change_inserted -970929547 1515110721
32884 and is only overridden when DocBook uses something else for sectioning (
32885 \change_inserted 1075283030 1597699921
32888 \change_inserted -970929547 1515110753
32889 parts and chapters of a book).
32895 \begin_layout Description
32897 \change_inserted -970929547 1515110811
32898 \begin_inset Flex Code
32901 \begin_layout Plain Layout
32903 \change_inserted -970929547 1496612023
32912 \begin_inset Flex Code
32915 \begin_layout Plain Layout
32917 \change_inserted -970929547 1496610966
32925 ] The tag to be used for this inset,
32927 \begin_inset Quotes eld
32931 \begin_inset Flex Code
32934 \begin_layout Plain Layout
32936 \change_inserted -970929547 1496612033
32945 \begin_inset Quotes erd
32948 in the example above.
32949 The default is the name of the float and always needs to be changed,
32950 as DocBook provides no generic inset tag.
32951 \change_inserted 1075283030 1597699924
32955 \begin_layout Description
32957 \change_inserted 1075283030 1597699924
32958 \begin_inset Flex Code
32961 \begin_layout Plain Layout
32963 \change_inserted 1075283030 1597699924
32972 \begin_inset Flex Code
32975 \begin_layout Plain Layout
32977 \change_inserted 1075283030 1597699924
32987 ] The new-line policy for this tag,
32989 \begin_inset space ~
32993 \begin_inset CommandInset ref
32995 reference "subsec:DocBook-New-line-policy"
33009 \begin_layout Description
33011 \change_inserted -970929547 1515110832
33012 \begin_inset Flex Code
33015 \begin_layout Plain Layout
33017 \change_inserted -970929547 1515110822
33026 \begin_inset Flex Code
33029 \begin_layout Plain Layout
33031 \change_inserted -970929547 1515110811
33039 ] Specifies attribute information to be output with the outer
33040 \change_inserted 34634807 1620057958
33042 \change_inserted -970929547 1515110832
33045 \begin_inset Quotes eld
33049 \begin_inset Flex Code
33052 \begin_layout Plain Layout
33054 \change_inserted -970929547 1515110845
33063 \begin_inset Quotes erd
33066 in the example above.
33067 This information can be used in further processing of the DocBook files.
33071 \begin_layout Description
33073 \change_inserted -970929547 1515110917
33074 \begin_inset Flex Code
33077 \begin_layout Plain Layout
33079 \change_inserted -970929547 1515110826
33088 \begin_inset Flex Code
33091 \begin_layout Plain Layout
33093 \change_inserted -970929547 1515110811
33101 ] The tag to be used for the wrapper tag around the inset,
33103 \begin_inset Quotes eld
33107 \begin_inset Flex Code
33110 \begin_layout Plain Layout
33112 \change_inserted -970929547 1515110842
33121 \begin_inset Quotes erd
33124 in the example above.
33126 \begin_inset Flex Code
33129 \begin_layout Plain Layout
33131 \change_inserted -970929547 1515110811
33140 indicating that there is no wrapper tag:
33141 tag and content are directly output without it.
33142 \change_inserted 1075283030 1597699929
33146 \begin_layout Description
33148 \change_inserted 1075283030 1597699929
33149 \begin_inset Flex Code
33152 \begin_layout Plain Layout
33154 \change_inserted 1075283030 1597699932
33155 DocBookWrapperTagType
33163 \begin_inset Flex Code
33166 \begin_layout Plain Layout
33168 \change_inserted 1075283030 1597699929
33178 ] The new-line policy for this tag,
33180 \begin_inset space ~
33184 \begin_inset CommandInset ref
33186 reference "subsec:DocBook-New-line-policy"
33200 \begin_layout Subsection
33202 \change_inserted -970929547 1515110040
33206 \begin_layout Standard
33208 \change_inserted -970929547 1496611700
33209 The DocBook output for floats too can be controlled by layout information.
33210 The output has the following form:
33213 \begin_layout LyX-Code
33215 \change_inserted -970929547 1515109700
33219 \begin_layout LyX-Code
33221 \change_inserted -970929547 1515110138
33222 Contents of the float as DocBook.
33225 \begin_layout LyX-Code
33227 \change_inserted -970929547 1496610966
33231 \begin_layout Standard
33233 \change_inserted -970929547 1496611715
33236 is a separate inset and will be output as a title.
33240 \begin_layout Description
33242 \change_inserted -970929547 1515110033
33243 \begin_inset Flex Code
33246 \begin_layout Plain Layout
33248 \change_inserted -970929547 1515109702
33257 \begin_inset Flex Code
33260 \begin_layout Plain Layout
33262 \change_inserted -970929547 1496610966
33270 ] Specifies attribute information to be output with the main tag,
33272 \begin_inset Quotes eld
33276 \begin_inset Flex Code
33279 \begin_layout Plain Layout
33281 \change_inserted -970929547 1515110035
33290 \begin_inset Quotes erd
33293 in the example above.
33294 This information can be used in further processing of the DocBook files.
33298 \begin_layout Description
33300 \change_inserted -970929547 1515110157
33301 \begin_inset Flex Code
33304 \begin_layout Plain Layout
33306 \change_inserted -970929547 1496611782
33315 \begin_inset Flex Code
33318 \begin_layout Plain Layout
33320 \change_inserted -970929547 1496610966
33328 ] The tag to be used for this float,
33330 \begin_inset Quotes eld
33334 \begin_inset Flex Code
33337 \begin_layout Plain Layout
33339 \change_inserted -970929547 1496610966
33348 \begin_inset Quotes erd
33351 in the example above.
33352 The default is the name of the float and always needs to be changed,
33353 as DocBook provides no generic float tag.
33356 \begin_layout Subsection
33358 \change_inserted -970929547 1515110157
33359 Bibliography formatting
33362 \begin_layout Standard
33364 \change_deleted 1075283030 1597699984
33366 \change_inserted 1075283030 1597699985
33368 \change_inserted -970929547 1515110187
33370 \change_deleted 1075283030 1597699987
33372 \change_inserted 1075283030 1597699987
33374 \change_inserted -970929547 1515110187
33375 cannot be formatted:
33376 all fields are always output in the database-like DocBook format (equivalent to a BibTeX file)
33377 \change_inserted 1075283030 1597700117
33380 \begin_inset Flex Code
33383 \begin_layout Plain Layout
33385 \change_inserted 1075283030 1597700120
33394 \change_inserted -970929547 1515110187
33396 \change_inserted 1075283030 1597700092
33400 \begin_layout Standard
33402 \change_inserted 1075283030 1597700112
33403 When the bibliographic entries are manually inserted into the
33404 \change_deleted 34634807 1620057319
33406 \change_inserted 34634807 1620057319
33409 \change_inserted 1075283030 1597700112
33410 document as Bibliography Items,
33411 the user deals with formatting
33414 \change_inserted 1075283030 1597700112
33416 there is no attempt of parsing what the user wrote,
33417 the string is directly used (with the
33418 \begin_inset Flex Code
33421 \begin_layout Plain Layout
33423 \change_inserted 1075283030 1597700076
33437 \begin_layout Chapter
33438 Including External Material
33439 \begin_inset CommandInset label
33441 name "chap:Including-External-Material"
33448 \begin_layout Standard
33449 \begin_inset Box Shadowbox
33459 height_special "totalheight"
33464 backgroundcolor "none"
33467 \begin_layout Plain Layout
33469 This portion of the documentation has not been updated for some time.
33470 We certainly hope that it is still accurate,
33471 but there are no guarantees.
33479 \begin_layout Standard
33480 The use of material from sources external to \SpecialChar LyX
33481 is covered in detail in the
33486 This part of the manual covers what needs to happen behind the scenes for new sorts of material to be included.
33489 \begin_layout Section
33493 \begin_layout Standard
33494 The external material feature is based on the concept of a
33499 A template is a specification of how \SpecialChar LyX
33500 should interface with a certain kind of material.
33503 comes with predefined templates for Xfig figures,
33504 various raster format images,
33506 and LilyPond music notation.
33507 You can check the actual list by using the menu
33508 \begin_inset Flex Noun
33511 \begin_layout Plain Layout
33512 Insert\SpecialChar menuseparator
33513 File\SpecialChar menuseparator
33521 it is possible to roll your own template to support a specific kind of material.
33522 Later we'll describe in more detail what is involved,
33523 and hopefully you will submit all the templates you create so we can include them in a later \SpecialChar LyX
33527 \begin_layout Standard
33528 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.
33530 consider the case of a figure produced with
33531 \begin_inset Flex Code
33534 \begin_layout Plain Layout
33541 The Xfig application itself works on an original file with the
33542 \begin_inset Flex Code
33545 \begin_layout Plain Layout
33553 you create and change your figure,
33554 and when you are done,
33556 \begin_inset Flex Code
33559 \begin_layout Plain Layout
33566 When you want to include the figure in your document,
33568 \begin_inset Flex Code
33571 \begin_layout Plain Layout
33577 in order to create a PostScript file that can readily be included in your \SpecialChar LaTeX
33581 \begin_inset Flex Code
33584 \begin_layout Plain Layout
33590 file is the original file,
33591 and the PostScript file is the produced file.
33594 \begin_layout Standard
33595 This distinction is important in order to allow updating of the material while you are in the process of writing the document.
33597 it provides us with the flexibility that is needed to support multiple export formats.
33599 in the case of a plain text file,
33600 it is not exactly an award-winning idea to include the figure as raw PostScript.
33602 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.
33603 The external material management allows you to do this,
33604 because it is parametrized on the different export formats that \SpecialChar LyX
33608 \begin_layout Standard
33609 Besides supporting the production of different products according to the exported format,
33610 it supports tight integration with editing and viewing applications.
33611 In the case of an Xfig figure,
33612 you are able to invoke Xfig on the original file with a single click from within the external material dialog in \SpecialChar LyX
33614 and also preview the produced PostScript file with Ghostview with another click.
33615 No more fiddling around with the command line and/or file browsers to locate and manipulate the original or produced files.
33617 you are finally able to take full advantage of the many different applications that are relevant to use when you write your documents,
33618 and ultimately be more productive.
33621 \begin_layout Section
33622 The external template configuration files
33625 \begin_layout Standard
33626 It is relatively easy to add custom external template definitions to \SpecialChar LyX
33629 be aware that doing this in an careless manner most probably
33633 introduce an easily exploitable security hole.
33634 So before you do this,
33635 please read the discussion about security in
33636 \begin_inset CommandInset ref
33638 reference "sec:Security-discussion"
33646 \begin_layout Standard
33648 we encourage you to submit any interesting templates that you create.
33652 \begin_layout Standard
33653 The external templates are defined in the
33654 \begin_inset Flex Code
33657 \begin_layout Plain Layout
33663 files that are stored in the
33664 \begin_inset Flex Code
33667 \begin_layout Plain Layout
33668 LyXDir/lib/xtemplates/
33674 Each template is defined in a file of its own.
33675 You can place your own templates in
33676 \begin_inset Flex Code
33679 \begin_layout Plain Layout
33680 UserDir/xtemplates/
33685 or copy existing templates to that directory in order to modify them.
33688 \begin_layout Standard
33689 A typical template looks like this:
33692 \begin_layout LyX-Code
33696 \begin_layout LyX-Code
33698 $$AbsOrRelPathParent$$Basename"
33701 \begin_layout LyX-Code
33705 \begin_layout LyX-Code
33709 \begin_layout LyX-Code
33713 \begin_layout LyX-Code
33717 \begin_layout LyX-Code
33721 \begin_layout LyX-Code
33722 AutomaticProduction true
33725 \begin_layout LyX-Code
33729 \begin_layout LyX-Code
33733 \begin_layout LyX-Code
33737 \begin_layout LyX-Code
33738 TransformCommand Rotate RotationLatexCommand
33741 \begin_layout LyX-Code
33742 TransformCommand Resize ResizeLatexCommand
33745 \begin_layout LyX-Code
33746 Product "$$RotateFront$$ResizeFront
33749 \begin_layout LyX-Code
33754 input{$$AbsOrRelPathMaster$$Basename.pstex_t}
33757 \begin_layout LyX-Code
33758 $$ResizeBack$$RotateBack"
33761 \begin_layout LyX-Code
33765 \begin_layout LyX-Code
33766 UpdateResult "$$AbsPath$$Basename.pstex_t"
33769 \begin_layout LyX-Code
33770 Requirement "graphicx"
33773 \begin_layout LyX-Code
33774 ReferencedFile latex "$$AbsOrRelPathMaster$$Basename.pstex_t"
33777 \begin_layout LyX-Code
33778 ReferencedFile latex "$$AbsPath$$Basename.eps"
33781 \begin_layout LyX-Code
33782 ReferencedFile dvi "$$AbsPath$$Basename.eps"
33785 \begin_layout LyX-Code
33789 \begin_layout LyX-Code
33793 \begin_layout LyX-Code
33794 TransformCommand Rotate RotationLatexCommand
33797 \begin_layout LyX-Code
33798 TransformCommand Resize ResizeLatexCommand
33801 \begin_layout LyX-Code
33802 Product "$$RotateFront$$ResizeFront
33805 \begin_layout LyX-Code
33810 input{$$AbsOrRelPathMaster$$Basename.pdftex_t}
33813 \begin_layout LyX-Code
33814 $$ResizeBack$$RotateBack"
33817 \begin_layout LyX-Code
33818 UpdateFormat pdftex
33821 \begin_layout LyX-Code
33822 UpdateResult "$$AbsPath$$Basename.pdftex_t"
33825 \begin_layout LyX-Code
33826 Requirement "graphicx"
33829 \begin_layout LyX-Code
33830 ReferencedFile latex "$$AbsOrRelPathMaster$$Basename.pdftex_t"
33833 \begin_layout LyX-Code
33834 ReferencedFile latex "$$AbsPath$$Basename.pdf"
33837 \begin_layout LyX-Code
33841 \begin_layout LyX-Code
33845 \begin_layout LyX-Code
33850 \begin_layout LyX-Code
33854 \begin_layout LyX-Code
33858 \begin_layout LyX-Code
33859 Product "<graphic fileref=
33861 "$$AbsOrRelPathMaster$$Basename.eps
33866 \begin_layout LyX-Code
33870 \begin_layout LyX-Code
33874 \begin_layout LyX-Code
33875 UpdateResult "$$AbsPath$$Basename.eps"
33878 \begin_layout LyX-Code
33879 ReferencedFile docbook "$$AbsPath$$Basename.eps"
33882 \begin_layout LyX-Code
33883 ReferencedFile docbook-xml "$$AbsPath$$Basename.eps"
33886 \begin_layout LyX-Code
33890 \begin_layout LyX-Code
33894 \begin_layout Standard
33896 the template is enclosed in
33897 \begin_inset Flex Code
33900 \begin_layout Plain Layout
33908 \begin_inset Flex Code
33911 \begin_layout Plain Layout
33918 It contains a header specifying some general settings and,
33919 for each supported primary document file format,
33921 \begin_inset Flex Code
33924 \begin_layout Plain Layout
33932 \begin_inset Flex Code
33935 \begin_layout Plain Layout
33944 \begin_layout Subsection
33945 The template header
33948 \begin_layout Description
33949 \begin_inset Flex Code
33952 \begin_layout Plain Layout
33953 AutomaticProduction
33954 \begin_inset space ~
33962 Whether the file represented by the template must be generated by \SpecialChar LyX
33964 This command must occur exactly once.
33967 \begin_layout Description
33968 \begin_inset Flex Code
33971 \begin_layout Plain Layout
33973 \begin_inset space ~
33981 A glob pattern that is used in the file dialog to filter out the desired files.
33982 If there is more than one possible file extension (e.
33983 \begin_inset space \thinspace{}
33987 \begin_inset space \space{}
33991 \begin_inset Flex Code
33994 \begin_layout Plain Layout
34001 \begin_inset Flex Code
34004 \begin_layout Plain Layout
34012 \begin_inset Flex Code
34015 \begin_layout Plain Layout
34022 This command must occur exactly once.
34025 \begin_layout Description
34026 \begin_inset Flex Code
34029 \begin_layout Plain Layout
34031 \begin_inset space ~
34039 The text that is displayed on the button.
34040 This command must occur exactly once.
34043 \begin_layout Description
34044 \begin_inset Flex Code
34047 \begin_layout Plain Layout
34049 \begin_inset space ~
34053 \begin_inset space ~
34061 The help text that is used in the External dialog.
34062 Provide enough information to explain to the user just what the template can provide him with.
34063 This command must occur exactly once.
34066 \begin_layout Description
34067 \begin_inset Flex Code
34070 \begin_layout Plain Layout
34072 \begin_inset space ~
34080 The file format of the original file.
34081 This must be the name of a format that is known to \SpecialChar LyX
34083 \begin_inset CommandInset ref
34085 reference "sec:Formats"
34092 \begin_inset Quotes eld
34096 \begin_inset Flex Code
34099 \begin_layout Plain Layout
34106 \begin_inset Quotes erd
34109 if the template can handle original files of more than one format.
34111 will attempt to interrogate the file itself in order to deduce its format in this case.
34112 This command must occur exactly once.
34115 \begin_layout Description
34116 \begin_inset Flex Code
34119 \begin_layout Plain Layout
34121 \begin_inset space ~
34129 A unique name for the template.
34130 It must not contain substitution macros (see below).
34133 \begin_layout Description
34134 \begin_inset Flex Code
34137 \begin_layout Plain Layout
34139 \begin_inset space ~
34142 Rotate|Resize|Clip|Extra
34147 This command specifies which transformations are supported by this template.
34148 It may occur zero or more times.
34149 This command enables the corresponding tabs in the external dialog.
34151 \begin_inset Flex Code
34154 \begin_layout Plain Layout
34160 command must have either a corresponding
34161 \begin_inset Flex Code
34164 \begin_layout Plain Layout
34171 \begin_inset Flex Code
34174 \begin_layout Plain Layout
34181 \begin_inset Flex Code
34184 \begin_layout Plain Layout
34191 Otherwise the transformation will not be supported by that format.
34194 \begin_layout Subsection
34198 \begin_layout Description
34199 \begin_inset Flex Code
34202 \begin_layout Plain Layout
34204 \begin_inset space ~
34207 LaTeX|PDFLaTeX|PlainText|DocBook|XHTML
34212 The primary document file format that this format definition is for.
34213 Not every template has a sensible representation in all document file formats.
34214 Please define nevertheless a
34215 \begin_inset Flex Code
34218 \begin_layout Plain Layout
34224 section for all templates.
34225 Use a dummy text when no representation is available.
34226 Then you can at least see a reference to the external material in the exported document.
34229 \begin_layout Description
34230 \begin_inset Flex Code
34233 \begin_layout Plain Layout
34235 \begin_inset space ~
34239 \begin_inset space ~
34247 This command defines an additional macro
34248 \begin_inset Flex Code
34251 \begin_layout Plain Layout
34257 for substitution in
34258 \begin_inset Flex Code
34261 \begin_layout Plain Layout
34269 \begin_inset Flex Code
34272 \begin_layout Plain Layout
34278 itself may contain substitution macros.
34279 The advantage over using
34280 \begin_inset Flex Code
34283 \begin_layout Plain Layout
34290 \begin_inset Flex Code
34293 \begin_layout Plain Layout
34299 is that the substituted value of
34300 \begin_inset Flex Code
34303 \begin_layout Plain Layout
34309 is sanitized so that it is a valid optional argument in the document format.
34310 This command may occur zero or more times.
34313 \begin_layout Description
34314 \begin_inset Flex Code
34317 \begin_layout Plain Layout
34319 \begin_inset space ~
34327 The text that is inserted in the exported document.
34328 This is actually the most important command and can be quite complex.
34329 This command must occur exactly once.
34332 \begin_layout Description
34333 \begin_inset Flex Code
34336 \begin_layout Plain Layout
34338 \begin_inset space ~
34346 This command specifies a preamble snippet that will be included in the \SpecialChar LaTeX
34348 It has to be defined using
34349 \begin_inset Flex Code
34352 \begin_layout Plain Layout
34360 \begin_inset Flex Code
34363 \begin_layout Plain Layout
34370 This command may occur zero or more times.
34373 \begin_layout Description
34374 \begin_inset Flex Code
34377 \begin_layout Plain Layout
34379 \begin_inset space ~
34383 \begin_inset space ~
34391 This command denotes files that are created by the conversion process and are needed for a particular export format.
34392 If the filename is relative,
34393 it is interpreted relative to the master document.
34394 This command may be given zero or more times.
34397 \begin_layout Description
34398 \begin_inset Flex Code
34401 \begin_layout Plain Layout
34403 \begin_inset space ~
34411 The name of a required \SpecialChar LaTeX
34413 The package is included via
34414 \begin_inset Flex Code
34417 \begin_layout Plain Layout
34425 in the \SpecialChar LaTeX
34427 This command may occur zero or more times.
34430 \begin_layout Description
34431 \begin_inset Flex Code
34434 \begin_layout Plain Layout
34436 \begin_inset space ~
34440 \begin_inset space ~
34443 RotationLatexCommand
34448 This command specifies that the built in \SpecialChar LaTeX
34449 command should be used for rotation.
34450 This command may occur once or not at all.
34453 \begin_layout Description
34454 \begin_inset Flex Code
34457 \begin_layout Plain Layout
34459 \begin_inset space ~
34463 \begin_inset space ~
34471 This command specifies that the built in \SpecialChar LaTeX
34472 command should be used for resizing.
34473 This command may occur once or not at all.
34476 \begin_layout Description
34477 \begin_inset Flex Code
34480 \begin_layout Plain Layout
34482 \begin_inset space ~
34486 \begin_inset space ~
34489 RotationLatexOption
34494 This command specifies that rotation is done via an optional argument.
34495 This command may occur once or not at all.
34498 \begin_layout Description
34499 \begin_inset Flex Code
34502 \begin_layout Plain Layout
34504 \begin_inset space ~
34508 \begin_inset space ~
34516 This command specifies that resizing is done via an optional argument.
34517 This command may occur once or not at all.
34520 \begin_layout Description
34521 \begin_inset Flex Code
34524 \begin_layout Plain Layout
34526 \begin_inset space ~
34530 \begin_inset space ~
34538 This command specifies that clipping is done via an optional argument.
34539 This command may occur once or not at all.
34542 \begin_layout Description
34543 \begin_inset Flex Code
34546 \begin_layout Plain Layout
34548 \begin_inset space ~
34552 \begin_inset space ~
34560 This command specifies that an extra optional argument is used.
34561 This command may occur once or not at all.
34564 \begin_layout Description
34565 \begin_inset Flex Code
34568 \begin_layout Plain Layout
34570 \begin_inset space ~
34578 The file format of the converted file.
34579 This must be the name of a format that is known to \SpecialChar LyX
34581 \begin_inset Flex Noun
34584 \begin_layout Plain Layout
34585 Tools\SpecialChar menuseparator
34586 Preferences\SpecialChar menuseparator
34587 File Handling\SpecialChar menuseparator
34594 This command must occur exactly once.
34595 If the resulting file format is PDF,
34596 you need to specify the format
34597 \begin_inset Flex Code
34600 \begin_layout Plain Layout
34607 This is the PDF format used for including graphics.
34608 The other defined PDF formats are for document export.
34611 \begin_layout Description
34612 \begin_inset Flex Code
34615 \begin_layout Plain Layout
34617 \begin_inset space ~
34625 The file name of the converted file.
34626 The file name must be absolute.
34627 This command must occur exactly once.
34630 \begin_layout Subsection
34631 Preamble definitions
34634 \begin_layout Standard
34635 The external template configuration file may contain additional preamble definitions enclosed by
34636 \begin_inset Flex Code
34639 \begin_layout Plain Layout
34647 \begin_inset Flex Code
34650 \begin_layout Plain Layout
34657 They can be used by the templates in the
34658 \begin_inset Flex Code
34661 \begin_layout Plain Layout
34670 \begin_layout Section
34671 The substitution mechanism
34674 \begin_layout Standard
34675 When the external material facility invokes an external program,
34676 it is done on the basis of a command defined in the template configuration file.
34677 These commands can contain various macros that are expanded before execution.
34678 Execution always take place in the directory of the containing document.
34681 \begin_layout Standard
34683 whenever external material is to be displayed,
34684 the name will be produced by the substitution mechanism,
34685 and most other commands in the template definition support substitution as well.
34688 \begin_layout Standard
34689 The available macros are the following:
34692 \begin_layout Description
34693 \begin_inset Flex Code
34696 \begin_layout Plain Layout
34697 $$AbsOrRelPathMaster
34703 absolute or relative to the master \SpecialChar LyX
34707 \begin_layout Description
34708 \begin_inset Flex Code
34711 \begin_layout Plain Layout
34712 $$AbsOrRelPathParent
34718 absolute or relative to the \SpecialChar LyX
34722 \begin_layout Description
34723 \begin_inset Flex Code
34726 \begin_layout Plain Layout
34732 The absolute file path.
34735 \begin_layout Description
34736 \begin_inset Flex Code
34739 \begin_layout Plain Layout
34745 The filename without path and without the extension.
34748 \begin_layout Description
34749 \begin_inset Flex Code
34752 \begin_layout Plain Layout
34754 \begin_inset Quotes eld
34758 \begin_inset Quotes erd
34766 This macro will expand to the contents of the file with the name
34767 \begin_inset Flex Code
34770 \begin_layout Plain Layout
34779 \begin_layout Description
34780 \begin_inset Flex Code
34783 \begin_layout Plain Layout
34789 The file extension (including the dot).
34792 \begin_layout Description
34793 \begin_inset Flex Code
34796 \begin_layout Plain Layout
34802 This will be the string
34803 \begin_inset Quotes eld
34807 \begin_inset Quotes erd
34810 if the file is in JPEG format,
34811 otherwise it will be the string
34812 \begin_inset Quotes eld
34816 \begin_inset Quotes erd
34820 This is useful to avoid uneeded conversions for output formats that support both PNG and JPEG fomats.
34821 The predefined RasterImage template uses this macro for the pdf\SpecialChar TeX
34825 \begin_layout Description
34826 \begin_inset Flex Code
34829 \begin_layout Plain Layout
34835 The filename of the file specified in the external material dialog.
34836 This is either an absolute name,
34837 or it is relative to the \SpecialChar LyX
34841 \begin_layout Description
34842 \begin_inset Flex Code
34845 \begin_layout Plain Layout
34852 \begin_inset Flex Code
34855 \begin_layout Plain Layout
34861 (absolute name or relative to the \SpecialChar LyX
34865 \begin_layout Description
34866 \begin_inset Flex Code
34869 \begin_layout Plain Layout
34876 relative to the master \SpecialChar LyX
34880 \begin_layout Description
34881 \begin_inset Flex Code
34884 \begin_layout Plain Layout
34891 relative to the \SpecialChar LyX
34895 \begin_layout Description
34896 \begin_inset Flex Code
34899 \begin_layout Plain Layout
34905 This macro will expand to the absolute path of the system directory.
34906 This is typically used to point to the various helper scripts that are bundled with \SpecialChar LyX
34910 \begin_layout Description
34911 \begin_inset Flex Code
34914 \begin_layout Plain Layout
34920 A name and full path to a temporary file which will be automatically deleted whenever the containing document is closed,
34921 or the external material insertion deleted.
34924 \begin_layout Standard
34925 All path macros contain a trailing directory separator,
34926 so you can construct e.
34927 \begin_inset space \thinspace{}
34931 \begin_inset space \space{}
34934 the absolute filename with
34935 \begin_inset Flex Code
34938 \begin_layout Plain Layout
34939 $$AbsPath$$Basename$$Extension
34947 \begin_layout Standard
34948 The macros above are substituted in all commands unless otherwise noted.
34950 \begin_inset Flex Code
34953 \begin_layout Plain Layout
34959 supports additionally the following substitutions if they are enabled by the
34960 \begin_inset Flex Code
34963 \begin_layout Plain Layout
34970 \begin_inset Flex Code
34973 \begin_layout Plain Layout
34982 \begin_layout Description
34983 \begin_inset Flex Code
34986 \begin_layout Plain Layout
34992 The front part of the resize command.
34995 \begin_layout Description
34996 \begin_inset Flex Code
34999 \begin_layout Plain Layout
35005 The back part of the resize command.
35008 \begin_layout Description
35009 \begin_inset Flex Code
35012 \begin_layout Plain Layout
35018 The front part of the rotation command.
35021 \begin_layout Description
35022 \begin_inset Flex Code
35025 \begin_layout Plain Layout
35031 The back part of the rotation command.
35034 \begin_layout Standard
35035 The value string of the
35036 \begin_inset Flex Code
35039 \begin_layout Plain Layout
35045 command supports additionally the following substitutions if they are enabled by the
35046 \begin_inset Flex Code
35049 \begin_layout Plain Layout
35056 \begin_inset Flex Code
35059 \begin_layout Plain Layout
35068 \begin_layout Description
35069 \begin_inset Flex Code
35072 \begin_layout Plain Layout
35081 \begin_layout Description
35082 \begin_inset Flex Code
35085 \begin_layout Plain Layout
35094 \begin_layout Description
35095 \begin_inset Flex Code
35098 \begin_layout Plain Layout
35107 \begin_layout Description
35108 \begin_inset Flex Code
35111 \begin_layout Plain Layout
35117 The rotation option.
35120 \begin_layout Standard
35121 You may ask why there are so many path macros.
35122 There are mainly two reasons:
35125 \begin_layout Enumerate
35126 Relative and absolute file names should remain relative or absolute,
35128 Users may have reasons to prefer either form.
35129 Relative names are useful for portable documents that should work on different machines,
35131 Absolute names may be required by some programs.
35134 \begin_layout Enumerate
35136 treats relative file names differently than \SpecialChar LyX
35137 and other programs in nested included files.
35138 For \SpecialChar LyX
35140 a relative file name is always relative to the document that contains the file name.
35141 For \SpecialChar LaTeX
35143 it is always relative to the master document.
35144 These two definitions are identical if you have only one document,
35145 but differ if you have a master document that includes part documents.
35146 That means that relative filenames must be transformed when presented to \SpecialChar LaTeX
35148 Fortunately \SpecialChar LyX
35149 does this automatically for you if you choose the right macros.
35152 \begin_layout Standard
35153 So which path macro should be used in new template definitions?
35154 The rule is not difficult:
35157 \begin_layout Itemize
35159 \begin_inset Flex Code
35162 \begin_layout Plain Layout
35168 if an absolute path is required.
35171 \begin_layout Itemize
35173 \begin_inset Flex Code
35176 \begin_layout Plain Layout
35177 $$AbsOrRelPathMaster
35182 if the substituted string is some kind of \SpecialChar LaTeX
35186 \begin_layout Itemize
35188 \begin_inset Flex Code
35191 \begin_layout Plain Layout
35192 $$AbsOrRelPathParent
35197 in order to preserve the user's choice.
35200 \begin_layout Standard
35201 There are special cases where this rule does not work and e.
35202 \begin_inset space \thinspace{}
35206 \begin_inset space \space{}
35209 relative names are needed,
35210 but normally it will work just fine.
35211 One example for such a case is the command
35212 \begin_inset Flex Code
35215 \begin_layout Plain Layout
35216 ReferencedFile latex "$$AbsOrRelPathMaster$$Basename.pstex_t"
35221 in the XFig template above:
35222 We can't use the absolute name because the copier for
35223 \begin_inset Flex Code
35226 \begin_layout Plain Layout
35232 files needs the relative name in order to rewrite the file content.
35235 \begin_layout Section
35236 Security discussion
35237 \begin_inset CommandInset label
35239 name "sec:Security-discussion"
35246 \begin_layout Standard
35247 The external material feature interfaces with a lot of external programs and does so automatically,
35248 so we have to consider the security implications of this.
35250 since you have the option of including your own filenames and/or parameter strings and those are expanded into a command,
35251 it seems that it would be possible to create a malicious document which executes arbitrary commands when a user views or prints the document.
35252 This is something we definitely want to avoid.
35255 \begin_layout Standard
35257 since the external program commands are specified in the template configuration file only,
35258 there are no security issues if \SpecialChar LyX
35259 is properly configured with safe templates only.
35260 This is so because the external programs are invoked with the
35261 \begin_inset Flex Code
35264 \begin_layout Plain Layout
35270 -system call rather than the
35271 \begin_inset Flex Code
35274 \begin_layout Plain Layout
35281 so it's not possible to execute arbitrary commands from the filename or parameter section via the shell.
35284 \begin_layout Standard
35285 This also implies that you are restricted in what command strings you can use in the external material templates.
35287 pipes and redirection are not readily available.
35288 This has to be so if \SpecialChar LyX
35289 should remain safe.
35290 If you want to use some of the shell features,
35291 you should write a safe script to do this in a controlled manner,
35292 and then invoke the script from the command string.
35296 \begin_layout Standard
35297 It is possible to design a template that interacts directly with the shell,
35298 but since this would allow a malicious user to execute arbitrary commands by writing clever filenames and/or parameters,
35299 we generally recommend that you only use safe scripts that work with the
35300 \begin_inset Flex Code
35303 \begin_layout Plain Layout
35309 system call in a controlled manner.
35311 for use in a controlled environment,
35312 it can be tempting to just fall back to use ordinary shell scripts.
35318 provide an easily exploitable security hole in your system.
35319 Of course it stands to reason that such unsafe templates will never be included in the standard \SpecialChar LyX
35321 although we do encourage people to submit new templates in the open source tradition.
35322 But \SpecialChar LyX
35323 as shipped from the official distribution channels will never have unsafe templates.
35326 \begin_layout Standard
35327 Including external material provides a lot of power,
35328 and you have to be careful not to introduce security hazards with this power.
35329 A subtle error in a single line in an innocent looking script can open the door to huge security problems.
35330 So if you do not fully understand the issues,
35331 we recommend that you consult a knowledgeable security professional or the \SpecialChar LyX
35332 development team if you have any questions about whether a given template is safe or not.
35333 And do this before you use it in an uncontrolled environment.
35336 \begin_layout Chapter
35338 List of supported \SpecialChar LyX
35339 functions to be used in layouts
35340 \begin_inset CommandInset label
35342 name "chap:List-of-functions"
35349 \begin_layout Standard
35351 \begin_inset Tabular
35352 <lyxtabular version="3" rows="11" columns="8">
35353 <features tabularvalignment="middle">
35354 <column alignment="left" valignment="top">
35355 <column alignment="left" valignment="top">
35356 <column alignment="left" valignment="top">
35357 <column alignment="left" valignment="top">
35358 <column alignment="left" valignment="top">
35359 <column alignment="left" valignment="top">
35360 <column alignment="left" valignment="top">
35361 <column alignment="left" valignment="top">
35363 <cell alignment="left" valignment="top" usebox="none">
35366 \begin_layout Plain Layout
35372 <cell alignment="left" valignment="top" usebox="none">
35375 \begin_layout Plain Layout
35381 <cell alignment="left" valignment="top" usebox="none">
35384 \begin_layout Plain Layout
35390 <cell alignment="left" valignment="top" usebox="none">
35393 \begin_layout Plain Layout
35399 <cell alignment="center" valignment="top" usebox="none">
35402 \begin_layout Plain Layout
35408 <cell alignment="center" valignment="top" usebox="none">
35411 \begin_layout Plain Layout
35417 <cell alignment="center" valignment="top" usebox="none">
35420 \begin_layout Plain Layout
35426 <cell alignment="center" valignment="top" usebox="none">
35429 \begin_layout Plain Layout
35437 <cell alignment="left" valignment="top" usebox="none">
35440 \begin_layout Plain Layout
35446 <cell alignment="left" valignment="top" usebox="none">
35449 \begin_layout Plain Layout
35455 <cell alignment="left" valignment="top" usebox="none">
35458 \begin_layout Plain Layout
35464 <cell alignment="left" valignment="top" usebox="none">
35467 \begin_layout Plain Layout
35473 <cell alignment="center" valignment="top" usebox="none">
35476 \begin_layout Plain Layout
35482 <cell alignment="center" valignment="top" usebox="none">
35485 \begin_layout Plain Layout
35491 <cell alignment="center" valignment="top" usebox="none">
35494 \begin_layout Plain Layout
35500 <cell alignment="center" valignment="top" usebox="none">
35503 \begin_layout Plain Layout
35511 <cell alignment="left" valignment="top" usebox="none">
35514 \begin_layout Plain Layout
35520 <cell alignment="left" valignment="top" usebox="none">
35523 \begin_layout Plain Layout
35529 <cell alignment="left" valignment="top" usebox="none">
35532 \begin_layout Plain Layout
35538 <cell alignment="left" valignment="top" usebox="none">
35541 \begin_layout Plain Layout
35547 <cell alignment="center" valignment="top" usebox="none">
35550 \begin_layout Plain Layout
35556 <cell alignment="center" valignment="top" usebox="none">
35559 \begin_layout Plain Layout
35565 <cell alignment="center" valignment="top" usebox="none">
35568 \begin_layout Plain Layout
35574 <cell alignment="center" valignment="top" usebox="none">
35577 \begin_layout Plain Layout
35585 <cell alignment="left" valignment="top" usebox="none">
35588 \begin_layout Plain Layout
35594 <cell alignment="left" valignment="top" usebox="none">
35597 \begin_layout Plain Layout
35603 <cell alignment="left" valignment="top" usebox="none">
35606 \begin_layout Plain Layout
35612 <cell alignment="left" valignment="top" usebox="none">
35615 \begin_layout Plain Layout
35621 <cell alignment="center" valignment="top" usebox="none">
35624 \begin_layout Plain Layout
35630 <cell alignment="center" valignment="top" usebox="none">
35633 \begin_layout Plain Layout
35639 <cell alignment="center" valignment="top" usebox="none">
35642 \begin_layout Plain Layout
35648 <cell alignment="center" valignment="top" usebox="none">
35651 \begin_layout Plain Layout
35659 <cell alignment="left" valignment="top" usebox="none">
35662 \begin_layout Plain Layout
35668 <cell alignment="left" valignment="top" usebox="none">
35671 \begin_layout Plain Layout
35677 <cell alignment="left" valignment="top" usebox="none">
35680 \begin_layout Plain Layout
35686 <cell alignment="left" valignment="top" usebox="none">
35689 \begin_layout Plain Layout
35695 <cell alignment="center" valignment="top" usebox="none">
35698 \begin_layout Plain Layout
35704 <cell alignment="center" valignment="top" usebox="none">
35707 \begin_layout Plain Layout
35713 <cell alignment="center" valignment="top" usebox="none">
35716 \begin_layout Plain Layout
35722 <cell alignment="center" valignment="top" usebox="none">
35725 \begin_layout Plain Layout
35733 <cell alignment="left" valignment="top" usebox="none">
35736 \begin_layout Plain Layout
35742 <cell alignment="left" valignment="top" usebox="none">
35745 \begin_layout Plain Layout
35751 <cell alignment="left" valignment="top" usebox="none">
35754 \begin_layout Plain Layout
35760 <cell alignment="left" valignment="top" usebox="none">
35763 \begin_layout Plain Layout
35769 <cell alignment="center" valignment="top" usebox="none">
35772 \begin_layout Plain Layout
35778 <cell alignment="center" valignment="top" usebox="none">
35781 \begin_layout Plain Layout
35787 <cell alignment="center" valignment="top" usebox="none">
35790 \begin_layout Plain Layout
35796 <cell alignment="center" valignment="top" usebox="none">
35799 \begin_layout Plain Layout
35807 <cell alignment="left" valignment="top" usebox="none">
35810 \begin_layout Plain Layout
35816 <cell alignment="left" valignment="top" usebox="none">
35819 \begin_layout Plain Layout
35825 <cell alignment="left" valignment="top" usebox="none">
35828 \begin_layout Plain Layout
35834 <cell alignment="left" valignment="top" usebox="none">
35837 \begin_layout Plain Layout
35843 <cell alignment="center" valignment="top" usebox="none">
35846 \begin_layout Plain Layout
35852 <cell alignment="center" valignment="top" usebox="none">
35855 \begin_layout Plain Layout
35861 <cell alignment="center" valignment="top" usebox="none">
35864 \begin_layout Plain Layout
35870 <cell alignment="center" valignment="top" usebox="none">
35873 \begin_layout Plain Layout
35881 <cell alignment="left" valignment="top" usebox="none">
35884 \begin_layout Plain Layout
35890 <cell alignment="left" valignment="top" usebox="none">
35893 \begin_layout Plain Layout
35899 <cell alignment="left" valignment="top" usebox="none">
35902 \begin_layout Plain Layout
35908 <cell alignment="left" valignment="top" usebox="none">
35911 \begin_layout Plain Layout
35917 <cell alignment="center" valignment="top" usebox="none">
35920 \begin_layout Plain Layout
35926 <cell alignment="center" valignment="top" usebox="none">
35929 \begin_layout Plain Layout
35935 <cell alignment="center" valignment="top" usebox="none">
35938 \begin_layout Plain Layout
35944 <cell alignment="center" valignment="top" usebox="none">
35947 \begin_layout Plain Layout
35955 <cell alignment="left" valignment="top" usebox="none">
35958 \begin_layout Plain Layout
35964 <cell alignment="left" valignment="top" usebox="none">
35967 \begin_layout Plain Layout
35973 <cell alignment="left" valignment="top" usebox="none">
35976 \begin_layout Plain Layout
35982 <cell alignment="left" valignment="top" usebox="none">
35985 \begin_layout Plain Layout
35991 <cell alignment="center" valignment="top" usebox="none">
35994 \begin_layout Plain Layout
36000 <cell alignment="center" valignment="top" usebox="none">
36003 \begin_layout Plain Layout
36009 <cell alignment="center" valignment="top" usebox="none">
36012 \begin_layout Plain Layout
36018 <cell alignment="center" valignment="top" usebox="none">
36021 \begin_layout Plain Layout
36029 <cell alignment="left" valignment="top" usebox="none">
36032 \begin_layout Plain Layout
36038 <cell alignment="left" valignment="top" usebox="none">
36041 \begin_layout Plain Layout
36047 <cell alignment="left" valignment="top" usebox="none">
36050 \begin_layout Plain Layout
36056 <cell alignment="left" valignment="top" usebox="none">
36059 \begin_layout Plain Layout
36065 <cell alignment="center" valignment="top" usebox="none">
36068 \begin_layout Plain Layout
36074 <cell alignment="center" valignment="top" usebox="none">
36077 \begin_layout Plain Layout
36083 <cell alignment="center" valignment="top" usebox="none">
36086 \begin_layout Plain Layout
36092 <cell alignment="center" valignment="top" usebox="none">
36095 \begin_layout Plain Layout
36103 <cell alignment="center" valignment="top" usebox="none">
36106 \begin_layout Plain Layout
36112 <cell alignment="center" valignment="top" usebox="none">
36115 \begin_layout Plain Layout
36121 <cell alignment="center" valignment="top" usebox="none">
36124 \begin_layout Plain Layout
36130 <cell alignment="center" valignment="top" usebox="none">
36133 \begin_layout Plain Layout
36139 <cell alignment="center" valignment="top" usebox="none">
36142 \begin_layout Plain Layout
36148 <cell alignment="center" valignment="top" usebox="none">
36151 \begin_layout Plain Layout
36157 <cell alignment="center" valignment="top" usebox="none">
36160 \begin_layout Plain Layout
36166 <cell alignment="center" valignment="top" usebox="none">
36169 \begin_layout Plain Layout
36183 \begin_layout Chapter
36184 Names of available colors to be used in layouts
36185 \begin_inset CommandInset label
36187 name "chap:Names-of-colors"
36194 \begin_layout Standard
36195 The colors listed below are the standard colors and those that you can adjust in the \SpecialChar LyX
36199 \begin_layout Section
36203 \begin_layout Standard
36204 The following are no real colors,
36205 but rather act on color definitions:
36208 \begin_layout Description
36209 ignore The color is ignored
36212 \begin_layout Description
36213 inherit The color is inherited
36216 \begin_layout Description
36229 No particular color – clear or default
36232 \begin_layout Section
36236 \begin_layout Standard
36237 These are fixed colors that cannot be customized
36238 \change_inserted -712698321 1607683177
36244 use these colors in layout definitions,
36245 since they will not work well with some color themes (such as dark themes)
36250 \begin_layout Description
36254 \begin_layout Description
36258 \begin_layout Description
36262 \begin_layout Description
36266 \begin_layout Description
36270 \begin_layout Description
36274 \begin_layout Description
36278 \begin_layout Description
36282 \begin_layout Description
36286 \begin_layout Description
36290 \begin_layout Description
36294 \begin_layout Description
36298 \begin_layout Description
36302 \begin_layout Description
36306 \begin_layout Description
36310 \begin_layout Description
36314 \begin_layout Description
36318 \begin_layout Description
36322 \begin_layout Description
36326 \begin_layout Section
36330 \begin_layout Standard
36331 These are the colors allocated to specific elements in
36334 arg "dialog-show prefs"
36340 \begin_layout Description
36341 added_space Added space color
36344 \begin_layout Description
36345 addedtext Added text color
36348 \begin_layout Description
36349 appendix Appendix marker color
36352 \begin_layout Description
36353 background Background color
36354 \change_inserted 5863208 1681507589
36358 \begin_layout Description
36360 \change_inserted 5863208 1681507597
36361 bookmark Bookmark indicator color
36366 \begin_layout Description
36367 bottomarea Bottom area color
36370 \begin_layout Description
36371 branchlabel Label color for branches
36374 \begin_layout Description
36375 buttonbg Color used for button background
36378 \begin_layout Description
36379 buttonframe Color for inset button frames
36382 \begin_layout Description
36383 buttonhoverbg Color used for button background under focus
36384 \change_inserted -712698321 1681555554
36388 \begin_layout Description
36390 \change_inserted -712698321 1681555554
36391 buttonhoverbg_broken Color used for broken inset button under focus
36396 \begin_layout Description
36397 changebar Changebar color
36400 \begin_layout Description
36401 changedtextauthor1 Changed text color author 1
36404 \begin_layout Description
36405 changedtextauthor2 Changed text color author 2
36408 \begin_layout Description
36409 changedtextauthor3 Changed text color author 3
36412 \begin_layout Description
36413 changedtextauthor4 Changed text color author 4
36416 \begin_layout Description
36417 changedtextauthor5 Changed text color author 5
36418 \change_inserted 5863208 1681507402
36422 \begin_layout Description
36424 \change_inserted 5863208 1681507414
36425 changedtextcomparison Changed text color document comparison (workarea)
36430 \begin_layout Description
36431 collapsible Collapsible insets text color
36434 \begin_layout Description
36435 collapsibleframe Collapsible insets framecolor
36438 \begin_layout Description
36439 command Text color for command insets
36442 \begin_layout Description
36443 commandbg Background color for command insets
36446 \begin_layout Description
36447 commandframe Frame color for command insets
36448 \change_inserted 5863208 1681507735
36452 \begin_layout Description
36454 \change_inserted 5863208 1681507880
36455 command_broken Text color for broken
36456 \change_inserted -712698321 1681555620
36458 \change_inserted 5863208 1681507880
36460 \change_deleted -712698321 1681555620
36462 \change_inserted 5863208 1681507880
36466 \begin_layout Description
36468 \change_inserted 5863208 1681507827
36469 commandbg_broken Background color for broken insets
36472 \begin_layout Description
36474 \change_inserted 5863208 1681507835
36475 commandframe_broken Frame color for broken insets
36478 \begin_layout Description
36480 \change_deleted -712698321 1681555548
36481 buttonhoverbg_broken Color used for broken inset button under focus
36486 \begin_layout Description
36487 comment Label color for comments
36490 \begin_layout Description
36491 commentbg Background color of comments
36494 \begin_layout Description
36495 cursor Cursor color
36498 \begin_layout Description
36499 deletedtext Deleted text color
36502 \begin_layout Description
36503 deletedtextmodifier Deleted text modifying color
36504 \change_inserted 5863208 1681507525
36506 \change_deleted -712698321 1681555611
36508 \change_inserted -712698321 1681555611
36510 \change_inserted 5863208 1681507525
36516 \begin_layout Description
36517 depthbar Color for the depth bars in the margin
36520 \begin_layout Description
36521 eolmarker End of line marker color
36524 \begin_layout Description
36525 error Color of the \SpecialChar LaTeX
36529 \begin_layout Description
36530 footlabel Label color for footnotes
36533 \begin_layout Description
36534 foreground Foreground color
36537 \begin_layout Description
36538 graphicsbg Graphics inset background color
36541 \begin_layout Description
36542 greyedoutbg Background color of greyedout inset
36545 \begin_layout Description
36546 greyedoutlabel Label color for greyedout insets
36549 \begin_layout Description
36550 greyedouttext Color for greyedout inset text
36553 \begin_layout Description
36554 indexlabel Label color for index insets
36557 \begin_layout Description
36558 inlinecompletion Inline completion color
36561 \begin_layout Description
36562 insetbg Inset marker background color
36565 \begin_layout Description
36566 insetframe Inset marker frame color
36569 \begin_layout Description
36570 language Color for marking foreign language words
36573 \begin_layout Description
36574 latex Text color in \SpecialChar LaTeX
36578 \begin_layout Description
36579 listingsbg Background color of listings inset
36582 \begin_layout Description
36583 marginlabel Label color for margin notes
36586 \begin_layout Description
36587 math Math inset text color
36590 \begin_layout Description
36591 mathbg Math inset background color
36594 \begin_layout Description
36595 mathcorners Math inset frame color not under focus
36598 \begin_layout Description
36599 mathframe Math inset frame color under focus
36602 \begin_layout Description
36603 mathline Math line color
36606 \begin_layout Description
36607 mathmacrobg Macro math inset background color
36610 \begin_layout Description
36611 mathmacroblend Macro math blended color
36614 \begin_layout Description
36615 mathmacroframe Macro math frame color
36618 \begin_layout Description
36619 mathmacrohoverbg Macro math inset background color hovered
36622 \begin_layout Description
36623 mathmacrolabel Macro math label color
36626 \begin_layout Description
36627 mathmacronewarg Macro template color for new parameters
36630 \begin_layout Description
36631 mathmacrooldarg Macro template color for old parameters
36634 \begin_layout Description
36635 newpage New page color
36638 \begin_layout Description
36639 nonunique_inlinecompletion Inline completion color for the non-unique part
36642 \begin_layout Description
36643 note Label color for notes
36646 \begin_layout Description
36647 notebg Background color of notes
36650 \begin_layout Description
36651 pagebreak Page break/line break color
36654 \begin_layout Description
36655 paragraphmarker Color used for the pilcrow sign to mark the end of a paragraph
36658 \begin_layout Description
36659 phantomtext Text color for phantom insets
36662 \begin_layout Description
36663 preview The color used for previews
36666 \begin_layout Description
36667 previewframe Preview frame color
36670 \begin_layout Description
36671 regexpframe Color for regexp frame
36674 \begin_layout Description
36675 scroll Color that indicates when a row can be scrolled
36678 \begin_layout Description
36679 selection Background color of selected text
36682 \begin_layout Description
36683 selectiontext Foreground color of selected text
36686 \begin_layout Description
36687 shadedbg Background color of shaded box
36690 \begin_layout Description
36691 special Special chars text color
36694 \begin_layout Description
36695 tabularline Table line color
36698 \begin_layout Description
36699 tabularonoffline Table line color
36700 \change_inserted -712698321 1607682522
36704 \begin_layout Description
36706 \change_inserted -712698321 1607682563
36707 textlabel1 Color 1 of layout and custom inset labels
36710 \begin_layout Description
36712 \change_inserted -712698321 1607682565
36713 textlabel2 Color 2 of layout and custom inset labels
36716 \begin_layout Description
36718 \change_inserted -712698321 1607682568
36719 textlabel3 Color 3 of layout and custom inset labels
36724 \begin_layout Description
36725 urllabel Label color for URL insets
36728 \begin_layout Description
36729 urltext Color for URL inset text