1 #LyX 2.4 created this file. For more info see https://www.lyx.org/
5 \save_transient_properties true
6 \origin /systemlyxdir/doc/
9 % DO NOT ALTER THIS PREAMBLE!!!
11 % This preamble is designed to ensure that this document prints
12 % out as advertised. If you mess with this preamble,
13 % parts of this document may not print out as expected. If you
14 % have problems LaTeXing this file, please contact
15 % the documentation team
16 % email: lyx-docs@lists.lyx.org
18 % the pages of the TOC is numbered roman
19 % and a pdf-bookmark for the TOC is added
20 \let\myTOC\tableofcontents
21 \renewcommand\tableofcontents{%
23 \pdfbookmark[1]{\contentsname}{}
27 % increase link area for cross-references and autoname them,
28 \AtBeginDocument{\renewcommand{\ref}[1]{\mbox{\autoref{#1}}}}
29 \@ifundefined{extrasenglish}{\usepackage[english]{babel}}{}
30 \@ifpackageloaded{babel}{
31 \addto\extrasenglish{%
32 \renewcommand*{\equationautorefname}[1]{}%
33 \renewcommand{\sectionautorefname}{sec.\negthinspace}%
34 \renewcommand{\subsectionautorefname}{sec.\negthinspace}%
35 \renewcommand{\subsubsectionautorefname}{sec.\negthinspace}%
39 \options bibliography=totoc,index=totoc,BCOR7.5mm,titlepage,captions=tableheading
40 \use_default_options false
44 \maintain_unincluded_children no
46 \language_package default
49 \font_roman "lmodern" "default"
50 \font_sans "lmss" "default"
51 \font_typewriter "lmtt" "default"
52 \font_math "auto" "auto"
53 \font_default_family default
54 \use_non_tex_fonts false
58 \font_typewriter_osf false
59 \font_sf_scale 100 100
60 \font_tt_scale 100 100
62 \use_dash_ligatures true
64 \default_output_format pdf2
66 \bibtex_command default
67 \index_command default
71 \pdf_title "LyX Configuration Manual"
72 \pdf_author "LyX Team"
73 \pdf_subject "LyX-documentation Customization"
74 \pdf_keywords "LyX, documentation, customization"
76 \pdf_bookmarksnumbered true
77 \pdf_bookmarksopen true
78 \pdf_bookmarksopenlevel 1
83 \pdf_pdfusetitle false
84 \pdf_quoted_options "linkcolor=black, citecolor=black, urlcolor=blue, filecolor=blue,pdfpagelayout=OneColumn, pdfnewwindow=true, pdfstartview=XYZ, plainpages=false"
87 \use_package amsmath 1
88 \use_package amssymb 1
91 \use_package mathdots 1
92 \use_package mathtools 1
94 \use_package stackrel 1
95 \use_package stmaryrd 1
96 \use_package undertilde 1
98 \cite_engine_type default
102 \paperorientation portrait
109 \notefontcolor #0000ff
113 \color #f5fae7 #0a0518
121 \paragraph_separation indent
122 \paragraph_indentation default
124 \math_indentation default
125 \math_numbering_side default
126 \quotes_style english
130 \paperpagestyle headings
132 \tracking_changes true
133 \output_changes false
135 \postpone_fragile_content false
139 \docbook_table_output 0
140 \docbook_mathml_prefix 1
141 \author -712698321 "Jürgen Spitzmüller"
147 Customizing \SpecialChar LyX
149 Features for the Advanced User
153 by the \SpecialChar LyX
158 \begin_layout Plain Layout
159 If you have comments or error corrections,
160 please send them to the \SpecialChar LyX
161 Documentation mailing list,
163 \begin_inset CommandInset href
165 target "lyx-docs@lists.lyx.org"
173 \begin_inset Quotes eld
177 \begin_inset Quotes erd
180 in the subject header,
181 and please cc the current maintainer of this file,
182 Richard Kimberly Heck <rikiheck@lyx.org>.
188 \begin_inset Newline newline
192 \begin_inset Newline newline
198 \begin_layout Standard
199 \begin_inset CommandInset toc
200 LatexCommand tableofcontents
207 \begin_layout Standard
208 \begin_inset Note Note
211 \begin_layout Plain Layout
212 Please use change tracking when modifying this document.
213 This makes it easier for our translators to recognize things that have been changed,
214 and it helps the maintainer keep up-to-date with what's been done.
222 \begin_layout Chapter
226 \begin_layout Standard
227 This manual covers the customization features present in \SpecialChar LyX
230 we discuss issues like keyboard shortcuts,
231 screen previewing options,
233 sending commands to \SpecialChar LyX
234 via the \SpecialChar LyX
236 internationalization,
237 installing new \SpecialChar LaTeX
238 classes and \SpecialChar LyX
241 We can't possibly hope to touch on everything you can change—
242 our developers add new features faster than we can document them—
243 but we will explain the most common customizations and hopefully point you in the right direction for some of the more obscure ones.
246 \begin_layout Standard
247 \begin_inset Branch OutDated
251 \begin_layout Standard
252 Information from previous versions of this document that now seems to be outdated is contained in the OutDated branch of this document.
254 this information will not appear in the \SpecialChar LaTeX
263 \begin_layout Chapter
268 \begin_layout Standard
269 This chapter aims to help you to find your way through the \SpecialChar LyX
271 Before continuing to read this chapter,
272 you should find out where your \SpecialChar LyX
273 system and user directories are by using
274 \begin_inset Flex Noun
277 \begin_layout Plain Layout
278 Help\SpecialChar menuseparator
289 The system directory is the place where \SpecialChar LyX
290 places its system-wide configuration files;
291 the user directory is where you can place your modified versions.
292 We will call the former
293 \begin_inset Flex Code
296 \begin_layout Plain Layout
303 \begin_inset Flex Noun
306 \begin_layout Plain Layout
312 in the remainder of this document.
316 \begin_layout Section
318 \begin_inset Flex Code
321 \begin_layout Plain Layout
330 \begin_layout Standard
331 \begin_inset Flex Code
334 \begin_layout Plain Layout
340 and its sub-directories contain a number of files that can be used to customize \SpecialChar LyX
342 You can change many of these files from within \SpecialChar LyX
344 \begin_inset Flex Noun
347 \begin_layout Plain Layout
348 Tools\SpecialChar menuseparator
355 Most customization that you will want to do in \SpecialChar LyX
356 is possible through this dialog.
358 many other inner aspects of \SpecialChar LyX
359 can be customized by modifying the files in
360 \begin_inset Flex Code
363 \begin_layout Plain Layout
370 These files fall in different categories,
371 described in the following subsections.
374 \begin_layout Subsection
375 Automatically generated files
378 \begin_layout Standard
380 \begin_inset Flex Noun
383 \begin_layout Plain Layout
389 are generated when you configure \SpecialChar LyX
391 They contain various default values that are automatically detected during reconfiguration.
393 it is not a good idea to modify them,
394 since they might be overwritten at any time.
397 \begin_layout Labeling
398 \labelwidthstring 00.00.0000
399 \begin_inset Flex Code
402 \begin_layout Plain Layout
408 Contains defaults for various commands.
411 \begin_layout Labeling
412 \labelwidthstring 00.00.0000
413 \begin_inset Flex Code
416 \begin_layout Plain Layout
422 Contains the list of packages that have been recognized by \SpecialChar LyX
424 It is currently unused by the \SpecialChar LyX
426 but the information extracted,
428 is made available with
429 \begin_inset Flex Noun
432 \begin_layout Plain Layout
433 Help\SpecialChar menuseparator
447 \begin_layout Labeling
448 \labelwidthstring 00.00.0000
449 \begin_inset Flex Code
452 \begin_layout Plain Layout
458 The list of text classes that have been found in your
459 \begin_inset Flex Code
462 \begin_layout Plain Layout
469 along with the associated \SpecialChar LaTeX
470 document class and their description.
473 \begin_layout Labeling
474 \labelwidthstring 00.00.0000
475 \begin_inset Flex Code
478 \begin_layout Plain Layout
484 The list of layout modules found in your
485 \begin_inset Flex Code
488 \begin_layout Plain Layout
497 \begin_layout Labeling
498 \labelwidthstring 00.00.0000
499 \begin_inset Flex Code
502 \begin_layout Plain Layout
508 Lists of various sorts of \SpecialChar LaTeX
509 -related files found on your system
512 \begin_layout Labeling
513 \labelwidthstring 00.00.0000
514 \begin_inset Flex Code
517 \begin_layout Plain Layout
518 doc/\SpecialChar LaTeX
524 is automatically generated during configuration from the file
525 \begin_inset Flex Code
528 \begin_layout Plain Layout
536 It contains information on your \SpecialChar LaTeX
540 \begin_layout Subsection
544 \begin_layout Standard
545 The following directories in
546 \begin_inset Flex Code
549 \begin_layout Plain Layout
556 \begin_inset Flex Code
559 \begin_layout Plain Layout
566 If a particular file exists in both places,
568 \begin_inset Flex Code
571 \begin_layout Plain Layout
580 \begin_layout Labeling
581 \labelwidthstring 00.00.0000
582 \begin_inset Flex Code
585 \begin_layout Plain Layout
591 This directory contains files with the extension
592 \begin_inset Flex Code
595 \begin_layout Plain Layout
601 that define the keybindings used in \SpecialChar LyX
603 If there exists an internationalized version of the bind file in a subdirectory
604 \begin_inset Flex Code
607 \begin_layout Plain Layout
614 \begin_inset Quotes eld
618 \begin_inset Quotes erd
621 is the ISO language code,
622 that will be used first.
625 \begin_layout Labeling
626 \labelwidthstring 00.00.0000
627 \begin_inset Flex Code
630 \begin_layout Plain Layout
636 Contains files with the extension
637 \begin_inset Flex Code
640 \begin_layout Plain Layout
646 which define the diverse citation possibilities (natbib,
649 \begin_inset CommandInset ref
651 reference "subsec:Cite-Engine-Files"
662 \begin_layout Labeling
663 \labelwidthstring 00.00.0000
664 \begin_inset Flex Code
667 \begin_layout Plain Layout
673 Contains graphics files that can be included in documents.
677 \begin_layout Labeling
678 \labelwidthstring 00.00.0000
679 \begin_inset Flex Code
682 \begin_layout Plain Layout
688 Contains \SpecialChar LyX
689 documentation files (including the one you are currently reading).
691 \begin_inset Flex Code
694 \begin_layout Plain Layout
700 deserves special attention,
702 The internationalized help docs are in subdirectories
703 \begin_inset Flex Code
706 \begin_layout Plain Layout
713 \begin_inset Quotes eld
717 \begin_inset Quotes erd
720 is the ISO language code.
722 \begin_inset CommandInset ref
724 reference "cha:Internationalizing-LyX"
732 \begin_layout Labeling
733 \labelwidthstring 00.00.0000
734 \begin_inset Flex Code
737 \begin_layout Plain Layout
743 Contains example files that explain how to use some features.
746 \begin_inset Flex Noun
749 \begin_layout Plain Layout
758 \begin_layout Labeling
759 \labelwidthstring 00.00.0000
760 \begin_inset Flex Code
763 \begin_layout Plain Layout
769 Contains image files that are used by the
770 \begin_inset Flex Noun
773 \begin_layout Plain Layout
781 it also contains the individual icons used in the toolbar and the banners that can be shown when \SpecialChar LyX
785 \begin_layout Labeling
786 \labelwidthstring 00.00.0000
787 \begin_inset Flex Code
790 \begin_layout Plain Layout
796 Contains keyboard keymapping files.
798 \begin_inset CommandInset ref
800 reference "sec:International-Keymap-Stuff"
808 \begin_layout Labeling
809 \labelwidthstring 00.00.0000
810 \begin_inset Flex Code
813 \begin_layout Plain Layout
819 Contains the text class and module files described in
820 \begin_inset CommandInset ref
822 reference "cha:Installing-New-Document"
830 \begin_layout Labeling
831 \labelwidthstring 00.00.0000
832 \begin_inset Flex Code
835 \begin_layout Plain Layout
842 \begin_inset Flex Code
845 \begin_layout Plain Layout
851 Python scripts used to convert between \SpecialChar LyX
853 These can be run from the command line if you want to batch-convert files.
856 \begin_layout Labeling
857 \labelwidthstring 00.00.0000
858 \begin_inset Flex Code
861 \begin_layout Plain Layout
867 Contains some files that demonstrate the capabilities of the
868 \begin_inset Flex Noun
871 \begin_layout Plain Layout
882 Also contains some scripts used by \SpecialChar LyX
886 \begin_layout Labeling
887 \labelwidthstring 00.00.0000
888 \begin_inset Flex Code
891 \begin_layout Plain Layout
897 Contains the standard \SpecialChar LyX
898 template files described in
899 \begin_inset CommandInset ref
901 reference "subsec:Creating-Templates"
909 \begin_layout Labeling
910 \labelwidthstring 00.00.0000
911 \begin_inset Flex Code
914 \begin_layout Plain Layout
920 Contains files with the extension
921 \begin_inset Flex Code
924 \begin_layout Plain Layout
930 that define the user interface to \SpecialChar LyX
933 the files define which items appear in which menus and the items appearing on the toolbar.
936 \begin_layout Labeling
937 \labelwidthstring 00.00.0000
938 \begin_inset Flex Code
941 \begin_layout Plain Layout
947 Contains files with the extension
948 \begin_inset Flex Code
951 \begin_layout Plain Layout
957 which define the templates for the insertion of external material to a \SpecialChar LyX
960 \begin_inset CommandInset ref
962 reference "chap:Including-External-Material"
970 \begin_layout Subsection
971 Files you don't want to modify
974 \begin_layout Standard
975 These files are used internally by \SpecialChar LyX
976 and you generally do not need to modify them unless you are a developer.
979 \begin_layout Labeling
980 \labelwidthstring 00.00.0000
981 \begin_inset Flex Code
984 \begin_layout Plain Layout
990 This file contains the list of \SpecialChar LyX
992 The contents are displayed with the menu entry
993 \begin_inset Flex Noun
996 \begin_layout Plain Layout
997 Help\SpecialChar menuseparator
1010 \begin_layout Labeling
1011 \labelwidthstring 00.00.0000
1012 \begin_inset Flex Code
1015 \begin_layout Plain Layout
1021 This is a \SpecialChar LaTeX
1022 script used during the configuration process.
1023 Do not run directly.
1026 \begin_layout Labeling
1027 \labelwidthstring 00.00.0000
1028 \begin_inset Flex Code
1031 \begin_layout Plain Layout
1037 This is a Python script that is used to re-configure \SpecialChar LyX
1039 It creates configuration files in the directory it was run from.
1042 \begin_layout Subsection
1043 Other files needing a line or two
1046 \begin_layout Labeling
1047 \labelwidthstring 00.00.0000
1048 \begin_inset Flex Code
1051 \begin_layout Plain Layout
1057 This contains tables describing how different character encodings can be mapped to Unicode
1060 \begin_layout Labeling
1061 \labelwidthstring 00.00.0000
1062 \begin_inset Flex Code
1065 \begin_layout Plain Layout
1071 This file contains a list of all the languages currently supported by \SpecialChar LyX
1075 \begin_layout Labeling
1076 \labelwidthstring 00.00.0000
1077 \begin_inset Flex Code
1080 \begin_layout Plain Layout
1086 Contains information about the supported fonts.
1089 \begin_layout Labeling
1090 \labelwidthstring 00.00.0000
1091 \begin_inset Flex Code
1094 \begin_layout Plain Layout
1100 This file contains translations for internationalized paragraph styles (see
1101 \begin_inset CommandInset ref
1103 reference "subsec:I18n"
1111 \begin_layout Labeling
1112 \labelwidthstring 00.00.0000
1113 \begin_inset Flex Code
1116 \begin_layout Plain Layout
1122 This file contains information about Unicode-encoded glyphs and the way they are supported by \SpecialChar LyX
1123 via \SpecialChar LaTeX
1127 \begin_layout Section
1128 Your local configuration directory
1131 \begin_layout Standard
1132 Even if you are using \SpecialChar LyX
1133 as an unprivileged user,
1134 you might want to change \SpecialChar LyX
1135 configuration for your own use.
1137 \begin_inset Flex Code
1140 \begin_layout Plain Layout
1146 directory contains all your personal configuration files.
1147 This is the directory described as
1148 \begin_inset Quotes eld
1152 \begin_inset Quotes erd
1156 \begin_inset Flex Noun
1159 \begin_layout Plain Layout
1160 Help\SpecialChar menuseparator
1162 \begin_inset space ~
1171 This directory is used as a mirror of
1172 \begin_inset Flex Code
1175 \begin_layout Plain Layout
1182 which means that every file in
1183 \begin_inset Flex Code
1186 \begin_layout Plain Layout
1192 is a replacement for the corresponding file in
1193 \begin_inset Flex Code
1196 \begin_layout Plain Layout
1203 Any configuration file described in the above sections can be placed either in the system-wide directory,
1204 in which case it will affect all users,
1205 or in your local directory for your own use.
1208 \begin_layout Standard
1209 To make things clearer,
1210 let's provide a few examples:
1213 \begin_layout Itemize
1214 The preferences set in the
1215 \begin_inset Flex Noun
1218 \begin_layout Plain Layout
1219 Tools\SpecialChar menuseparator
1225 dialog are saved to a file
1226 \begin_inset Flex Code
1229 \begin_layout Plain Layout
1236 \begin_inset Flex Code
1239 \begin_layout Plain Layout
1248 \begin_layout Itemize
1249 When you reconfigure using
1250 \begin_inset Flex Noun
1253 \begin_layout Plain Layout
1254 Tools\SpecialChar menuseparator
1263 \begin_inset Flex Code
1266 \begin_layout Plain Layout
1273 and the resulting files are written in your local configuration directory.
1274 This means that any additional text class file that you might have added in
1275 \begin_inset Flex Code
1278 \begin_layout Plain Layout
1284 will be added to the list of classes in the
1285 \begin_inset Flex Noun
1288 \begin_layout Plain Layout
1289 Document\SpecialChar menuseparator
1298 \begin_layout Itemize
1299 If you get some updated documentation from a \SpecialChar LyX
1300 ftp site and cannot install it because you do not have sysadmin rights on your system,
1301 you can just copy the files to
1302 \begin_inset Flex Code
1305 \begin_layout Plain Layout
1311 and the items in the
1312 \begin_inset Flex Noun
1315 \begin_layout Plain Layout
1321 menu will open them!
1324 \begin_layout Section
1325 Running \SpecialChar LyX
1326 with multiple configurations
1329 \begin_layout Standard
1330 The configuration freedom of the local configuration directory may not suffice if you want to have more than one configuration at your disposal.
1332 you may want to use different key bindings or printer settings at different times.
1333 You can achieve this by having several such directories.
1334 You then specify which directory to use at run-time.
1337 \begin_layout Standard
1338 Invoking \SpecialChar LyX
1339 with the command line switch
1340 \begin_inset Flex Code
1343 \begin_layout Plain Layout
1353 instructs the program to read the configuration from that directory,
1354 and not from the default directory.
1355 (You can determine the default directory by running \SpecialChar LyX
1357 \begin_inset Flex Code
1360 \begin_layout Plain Layout
1366 switch.) If the specified directory does not exist,
1368 offers to create it for you,
1369 just like it does for the default directory the first time you run the program.
1370 You can modify the configuration options in this additional user directory exactly as you would for the default directory.
1371 These directories are completely independent (but read on).
1372 Note that setting the environment variable
1373 \begin_inset Flex Code
1376 \begin_layout Plain Layout
1382 to some value has exactly the same effect.
1385 \begin_layout Standard
1386 Having several configurations also requires more maintenance:
1387 if you want to add a new layout to
1388 \begin_inset Flex Code
1391 \begin_layout Plain Layout
1397 which you want available from all your configurations,
1398 you must add it to each directory separately.
1399 You can avoid this with the following trick:
1400 after \SpecialChar LyX
1401 creates the additional directory,
1402 most of the subdirectories (see above) are empty.
1403 If you want the new configuration to mirror an existing one,
1404 replace the empty subdirectory with a symbolic link to the matching subdirectory in the existing configuration.
1406 \begin_inset Flex Code
1409 \begin_layout Plain Layout
1417 since it contains a file written by the configuration script (also accessible through
1418 \begin_inset Flex Noun
1421 \begin_layout Plain Layout
1422 Tools\SpecialChar menuseparator
1428 ) which is configuration specific.
1431 \begin_layout Chapter
1432 The Preferences dialog
1435 \begin_layout Standard
1436 All options of the preferences dialog are described in the Appendix
1438 The Preferences Dialog
1445 For some options you might find here more details.
1448 \begin_layout Section
1450 \begin_inset CommandInset label
1459 \begin_layout Standard
1460 The first step is to define your file formats if they are not already defined.
1463 \begin_inset Flex Noun
1466 \begin_layout Plain Layout
1467 Tools\SpecialChar menuseparator
1475 \begin_inset Flex Noun
1478 \begin_layout Plain Layout
1479 File Handling\SpecialChar menuseparator
1486 \begin_inset Flex Noun
1489 \begin_layout Plain Layout
1495 button to define your new format.
1497 \begin_inset Flex Noun
1500 \begin_layout Plain Layout
1506 field contains the name used to identify the format in the GUI.
1508 \begin_inset Flex Noun
1511 \begin_layout Plain Layout
1517 is used to identify the format internally.
1518 You will also need to enter a file extension.
1519 These are all required.
1521 \begin_inset Flex Noun
1524 \begin_layout Plain Layout
1530 field is used to provide a keyboard shortcut on the menus.
1533 \begin_inset Flex Noun
1536 \begin_layout Plain Layout
1543 \begin_inset Flex Noun
1546 \begin_layout Plain Layout
1547 Document\SpecialChar menuseparator
1548 View (Other Formats)\SpecialChar menuseparator
1557 \begin_layout Standard
1559 \begin_inset Flex Noun
1562 \begin_layout Plain Layout
1569 \begin_inset Flex Noun
1572 \begin_layout Plain Layout
1580 you might want to use
1581 \begin_inset Flex Noun
1584 \begin_layout Plain Layout
1590 to view PostScript files.
1591 You can enter the command needed to start the program in the corresponding fields.
1592 In defining this command,
1593 you can use the four variables listed in the next section.
1594 The viewer is launched when you view an image in \SpecialChar LyX
1596 \begin_inset Flex Noun
1599 \begin_layout Plain Layout
1600 Document\SpecialChar menuseparator
1607 The editor is for example launched when you right-click on an image and choose
1608 \begin_inset Flex Noun
1611 \begin_layout Plain Layout
1617 in the appearing context menu.
1620 \begin_layout Standard
1622 \begin_inset Flex Noun
1625 \begin_layout Plain Layout
1631 type of a format is optional,
1632 but if it is specified,
1633 it must be unique across all formats.
1634 It is used to detect files of this format from the file contents.
1635 For some important file formats there is no MIME type officially registered with the
1636 \begin_inset CommandInset href
1639 target "http://www.iana.org/assignments/media-types/"
1645 Therefore \SpecialChar LyX
1646 uses the extended list of MIME types as specified by
1647 \begin_inset CommandInset href
1649 name "freedesktop.org"
1650 target "http://www.freedesktop.org/wiki/Specifications/shared-mime-info-spec"
1658 \begin_layout Standard
1660 \begin_inset Flex Noun
1663 \begin_layout Plain Layout
1669 option tells \SpecialChar LyX
1670 that a format is suitable for document export.
1671 If this is set and if a suitable conversion route exists (see
1672 \begin_inset CommandInset ref
1674 reference "sec:Converters"
1680 the format will appear in the
1681 \begin_inset Flex Noun
1684 \begin_layout Plain Layout
1685 File\SpecialChar menuseparator
1692 The format will also appear in the
1693 \begin_inset Flex Noun
1696 \begin_layout Plain Layout
1697 Document\SpecialChar menuseparator
1703 menu if a viewer is specified for the format.
1706 \begin_inset Flex Code
1709 \begin_layout Plain Layout
1716 should not use this option.
1717 Formats that can both represent vector graphics and documents like
1718 \begin_inset Flex Code
1721 \begin_layout Plain Layout
1730 \begin_layout Standard
1732 \begin_inset Flex Noun
1735 \begin_layout Plain Layout
1736 Vector graphics format
1741 tells \SpecialChar LyX
1742 that a format can contain vector graphics.
1743 This information is used to determine the target format of included graphics for
1744 \begin_inset Flex Noun
1747 \begin_layout Plain Layout
1754 Included graphics may need to be converted to either
1755 \begin_inset Flex Noun
1758 \begin_layout Plain Layout
1766 \begin_inset Flex Noun
1769 \begin_layout Plain Layout
1777 \begin_inset Flex Noun
1780 \begin_layout Plain Layout
1788 \begin_inset Flex Noun
1791 \begin_layout Plain Layout
1797 cannot handle other image formats.
1798 If an included graphic is not already in
1799 \begin_inset Flex Noun
1802 \begin_layout Plain Layout
1810 \begin_inset Flex Noun
1813 \begin_layout Plain Layout
1821 \begin_inset Flex Noun
1824 \begin_layout Plain Layout
1832 \begin_inset Flex Noun
1835 \begin_layout Plain Layout
1841 if the vector format option is set,
1843 \begin_inset Flex Noun
1846 \begin_layout Plain Layout
1855 \begin_layout Section
1859 \begin_layout Standard
1860 Since all conversions from one format to another take place in \SpecialChar LyX
1861 's temporary directory,
1862 it is sometimes necessary to modify a file before copying it to the temporary directory in order that the conversion may be performed.
1866 \begin_layout Plain Layout
1868 the file may refer to other files—
1871 using relative file names,
1872 and these may become invalid when the file is copied to the temporary directory.
1877 This is done by a Copier:
1878 It copies a file to (or from) the temporary directory and may modify it in the process.
1881 \begin_layout Standard
1882 The definitions of the copiers may use eight variables:
1885 \begin_layout Labeling
1886 \labelwidthstring 00.00.0000
1887 \begin_inset Flex Code
1890 \begin_layout Plain Layout
1896 The \SpecialChar LyX
1897 system directory (e.
1898 \begin_inset space \thinspace{}
1902 \begin_inset space \space{}
1906 \begin_inset Flex Noun
1909 \begin_layout Plain Layout
1918 \begin_layout Labeling
1919 \labelwidthstring 00.00.0000
1920 \begin_inset Flex Code
1923 \begin_layout Plain Layout
1932 \begin_layout Labeling
1933 \labelwidthstring 00.00.0000
1934 \begin_inset Flex Code
1937 \begin_layout Plain Layout
1946 \begin_layout Labeling
1947 \labelwidthstring 00.00.0000
1948 \begin_inset Flex Code
1951 \begin_layout Plain Layout
1957 The base name (without filename extension) in the \SpecialChar LyX
1961 \begin_layout Labeling
1962 \labelwidthstring 00.00.0000
1963 \begin_inset Flex Code
1966 \begin_layout Plain Layout
1972 The full directory path of the \SpecialChar LyX
1976 \begin_layout Labeling
1977 \labelwidthstring 00.00.0000
1978 \begin_inset Flex Code
1981 \begin_layout Plain Layout
1987 The full pathname to the original \SpecialChar LyX
1988 file being processed
1991 \begin_layout Labeling
1992 \labelwidthstring 00.00.0000
1993 \begin_inset Flex Code
1996 \begin_layout Plain Layout
2002 The filename (without any directory path) of the \SpecialChar LyX
2006 \begin_layout Labeling
2007 \labelwidthstring 00.00.0000
2008 \begin_inset Flex Code
2011 \begin_layout Plain Layout
2017 The `\SpecialChar LaTeX
2021 \begin_layout Standard
2022 The latter should be the filename as it would be used in a \SpecialChar LaTeX
2030 It is relevant only when exporting files suitable for such inclusion.
2033 \begin_layout Standard
2034 Copiers can be used to do almost anything with output files.
2036 suppose you want generated pdf files to be copied to a special directory,
2038 \begin_inset Flex Code
2041 \begin_layout Plain Layout
2048 Then you could write a shell script such as this one:
2051 \begin_layout Standard
2052 \begin_inset listings
2056 \begin_layout Plain Layout
2061 \begin_layout Plain Layout
2066 \begin_layout Plain Layout
2068 TOFILE=`basename $2`
2071 \begin_layout Plain Layout
2073 cp $FROMFILE /home/you/pdf/$TOFILE
2078 Save it in your local \SpecialChar LyX
2082 \begin_inset Flex Code
2085 \begin_layout Plain Layout
2086 /home/you/.lyx/scripts/pdfcopier.sh
2092 and make it executable,
2093 if you need to do so on your platform.
2096 \begin_inset Flex Noun
2099 \begin_layout Plain Layout
2100 Tools\SpecialChar menuseparator
2108 \begin_inset Flex Noun
2111 \begin_layout Plain Layout
2112 File Handling\SpecialChar menuseparator
2119 \begin_inset Flex Noun
2122 \begin_layout Plain Layout
2129 or one of the other pdf formats—
2131 \begin_inset Flex Code
2134 \begin_layout Plain Layout
2135 pdfcopier.sh $$i $$o
2141 \begin_inset Flex Noun
2144 \begin_layout Plain Layout
2154 \begin_layout Standard
2155 Copiers are used by \SpecialChar LyX
2156 in various of its own conversions.
2158 if appropriate programs are found,
2160 will automatically install copiers for the
2161 \begin_inset Flex Noun
2164 \begin_layout Plain Layout
2171 \begin_inset Flex Noun
2174 \begin_layout Plain Layout
2176 \begin_inset space ~
2185 When these formats are exported,
2186 the copier sees that not just the main HTML file but various associated files (style files,
2188 etc.) are also copied.
2189 All these files are written to a subdirectory of the directory in which the original \SpecialChar LyX
2194 \begin_layout Plain Layout
2195 This copier can be customized.
2197 \begin_inset Quotes eld
2201 \begin_inset Quotes erd
2204 argument takes a comma-separated list of extensions to be copied;
2206 all files will be copied.
2208 \begin_inset Quotes eld
2212 \begin_inset Quotes erd
2215 argument determines the extension added to the generated directory.
2218 \begin_inset Quotes eld
2222 \begin_inset Flex Noun
2225 \begin_layout Plain Layout
2232 \begin_inset Quotes erd
2236 so HTML generated from
2237 \begin_inset Flex Noun
2240 \begin_layout Plain Layout
2241 /path/to/filename.lyx
2247 \begin_inset Flex Noun
2250 \begin_layout Plain Layout
2251 /path/to/filename.html.LyXconv
2265 \begin_layout Section
2267 \begin_inset CommandInset label
2269 name "sec:Converters"
2276 \begin_layout Standard
2277 You can define your own Converters to convert files between different formats.
2279 \begin_inset Flex Noun
2282 \begin_layout Plain Layout
2283 Tools\SpecialChar menuseparator
2284 Preferences\SpecialChar menuseparator
2285 File Handling\SpecialChar menuseparator
2294 \begin_layout Standard
2295 To define a new converter,
2297 \begin_inset Flex Noun
2300 \begin_layout Plain Layout
2302 \begin_inset space ~
2311 \begin_inset Flex Noun
2314 \begin_layout Plain Layout
2316 \begin_inset space ~
2324 from the drop-down lists,
2325 enter the command needed for the conversion,
2327 \begin_inset Flex Noun
2330 \begin_layout Plain Layout
2337 Several variables can be used in the definition of converters:
2340 \begin_layout Labeling
2341 \labelwidthstring 00.00.0000
2342 \begin_inset Flex Code
2345 \begin_layout Plain Layout
2351 The \SpecialChar LyX
2355 \begin_layout Labeling
2356 \labelwidthstring 00.00.0000
2357 \begin_inset Flex Code
2360 \begin_layout Plain Layout
2369 \begin_layout Labeling
2370 \labelwidthstring 00.00.0000
2371 \begin_inset Flex Code
2374 \begin_layout Plain Layout
2383 \begin_layout Labeling
2384 \labelwidthstring 00.00.0000
2385 \begin_inset Flex Code
2388 \begin_layout Plain Layout
2394 The base filename of the input file (i.
2395 \begin_inset space \thinspace{}
2399 without the extension)
2402 \begin_layout Labeling
2403 \labelwidthstring 00.00.0000
2404 \begin_inset Flex Code
2407 \begin_layout Plain Layout
2413 The path to the input file
2416 \begin_layout Labeling
2417 \labelwidthstring 00.00.0000
2418 \begin_inset Flex Code
2421 \begin_layout Plain Layout
2427 The path to the original input file (this is different from $$p when a chain of converters is called)
2430 \begin_layout Labeling
2431 \labelwidthstring 00.00.0000
2432 \begin_inset Flex Code
2435 \begin_layout Plain Layout
2441 The iconv name for the encoding of the document.
2444 \begin_layout Standard
2446 \begin_inset Flex Noun
2449 \begin_layout Plain Layout
2451 \begin_inset space ~
2459 field you can enter the following flags,
2460 separated by commas:
2463 \begin_layout Labeling
2464 \labelwidthstring 00.00.0000
2465 \begin_inset Flex Code
2468 \begin_layout Plain Layout
2474 This converter runs some form of \SpecialChar LaTeX
2476 This will make \SpecialChar LyX
2477 's \SpecialChar LaTeX
2478 error logs available.
2480 \begin_inset Flex Code
2483 \begin_layout Plain Layout
2489 value specifies the form of \SpecialChar LaTeX
2491 \begin_inset Flex Code
2494 \begin_layout Plain Layout
2505 If no value is specified,
2507 \begin_inset Flex Code
2510 \begin_layout Plain Layout
2519 \begin_layout Labeling
2520 \labelwidthstring 00.00.0000
2521 \begin_inset Flex Code
2524 \begin_layout Plain Layout
2530 This converter is considered non-safe and needs authorization by the user.
2531 Depending on the settings in
2533 Tools\SpecialChar menuseparator
2534 Preferences\SpecialChar menuseparator
2535 File Handling\SpecialChar menuseparator
2539 users will (a.) be asked whether they trust the current document temporarily,
2542 (b.) be informed that conversion is not possible due to security concerns,
2543 or (c.) not be informed as they gave permanent consent.
2544 Set this flag for converters that might execute arbitrary programs.
2547 \begin_layout Labeling
2548 \labelwidthstring 00.00.0000
2549 \begin_inset Flex Code
2552 \begin_layout Plain Layout
2558 Needs the \SpecialChar LaTeX
2560 \begin_inset Flex Noun
2563 \begin_layout Plain Layout
2569 file for the conversion.
2571 \begin_inset Flex Code
2574 \begin_layout Plain Layout
2580 value specifies the form of \SpecialChar LaTeX
2581 that is run in order to generate the
2582 \begin_inset Flex Noun
2585 \begin_layout Plain Layout
2592 \begin_inset Flex Code
2595 \begin_layout Plain Layout
2606 If no value is specified,
2608 \begin_inset Flex Code
2611 \begin_layout Plain Layout
2620 \begin_layout Labeling
2621 \labelwidthstring 00.00.0000
2622 \begin_inset Flex Code
2625 \begin_layout Plain Layout
2632 \begin_inset Quotes eld
2636 \begin_inset Quotes erd
2639 file from the backend,
2640 which in practice means a \SpecialChar LaTeX
2641 file like the one we would export,
2643 \begin_inset Flex Code
2646 \begin_layout Plain Layout
2655 \begin_layout Labeling
2656 \labelwidthstring 00.00.0000
2657 \begin_inset Flex Code
2660 \begin_layout Plain Layout
2669 \begin_layout Standard
2670 The following three flags are not really flags at all because they take an argument in the
2671 \begin_inset Flex Noun
2674 \begin_layout Plain Layout
2676 \begin_inset space ~
2680 \begin_inset space ~
2691 \begin_layout Labeling
2692 \labelwidthstring 00.00.0000
2693 \begin_inset Flex Code
2696 \begin_layout Plain Layout
2702 The name of the driver that needs to be loaded with the
2706 package for this converter.
2707 The loading of the correct driver is necessary to get some PDF-specific features.
2715 \begin_layout Labeling
2716 \labelwidthstring 00.00.0000
2717 \begin_inset Flex Code
2720 \begin_layout Plain Layout
2727 the converter's standard error will be redirected to a file
2728 \begin_inset Flex Code
2731 \begin_layout Plain Layout
2738 and the script given as argument will be run as:
2740 \begin_inset Flex Code
2743 \begin_layout Plain Layout
2744 script < infile.out > infile.log
2750 The argument may contain
2751 \begin_inset Flex Code
2754 \begin_layout Plain Layout
2763 \begin_layout Labeling
2764 \labelwidthstring 00.00.0000
2765 \begin_inset Flex Code
2768 \begin_layout Plain Layout
2774 The name of the directory in which the converter will dump the generated files.
2776 will not create this directory,
2777 and it does not copy anything into it,
2778 though it will copy this directory to the destination.
2779 The argument may contain
2780 \begin_inset Flex Code
2783 \begin_layout Plain Layout
2790 which will be replaced by the base name of the input and output files,
2792 when the directory is copied.
2793 \begin_inset Newline newline
2796 Note that resultdir and usetempdir make no sense together.
2797 The latter will be ignored if the former is given.
2800 \begin_layout Labeling
2801 \labelwidthstring 00.00.0000
2802 \begin_inset Flex Code
2805 \begin_layout Plain Layout
2811 Determines the output file name and may,
2813 \begin_inset Flex Code
2816 \begin_layout Plain Layout
2823 Sensible only with resultdir and optional even then;
2825 it defaults to `index'.
2828 \begin_layout Standard
2829 A suitable hyperref-driver is set for some converters that are installed with \SpecialChar LyX
2831 The last three flags,
2833 are presently not used in any of the pre-installed converters.
2836 \begin_layout Standard
2837 You do not have to define converters for all formats between which you want to convert.
2839 you will note that there is no `\SpecialChar LyX
2840 to PostScript' converter,
2841 but \SpecialChar LyX
2842 will export PostScript.
2843 It does so by first creating a \SpecialChar LaTeX
2844 file (no converter needs to be defined for this) which is then converted to DVI using the `\SpecialChar LaTeX
2846 and finally converting the resulting DVI file to PostScript.
2848 finds such `chains' of converters automatically,
2849 and it will always choose the shortest possible chain.
2852 still define multiple conversion methods between file formats.
2854 the standard \SpecialChar LyX
2855 configuration provides five ways to convert \SpecialChar LaTeX
2859 \begin_layout Enumerate
2862 \begin_inset Flex Noun
2865 \begin_layout Plain Layout
2874 \begin_layout Enumerate
2875 via (DVI and) PostScript,
2877 \begin_inset Flex Noun
2880 \begin_layout Plain Layout
2889 \begin_layout Enumerate
2892 \begin_inset Flex Noun
2895 \begin_layout Plain Layout
2904 \begin_layout Enumerate
2906 \begin_inset Flex Noun
2909 \begin_layout Plain Layout
2919 \begin_layout Enumerate
2921 \begin_inset Flex Noun
2924 \begin_layout Plain Layout
2934 \begin_layout Standard
2935 To define such alternate chains,
2936 you must define multiple target `file formats',
2938 \begin_inset CommandInset ref
2940 reference "sec:Formats"
2947 in the standard configuration,
2949 \begin_inset Flex Noun
2952 \begin_layout Plain Layout
2959 \begin_inset Flex Noun
2962 \begin_layout Plain Layout
2970 \begin_inset Flex Noun
2973 \begin_layout Plain Layout
2980 \begin_inset Flex Noun
2983 \begin_layout Plain Layout
2991 \begin_inset Flex Noun
2994 \begin_layout Plain Layout
3001 \begin_inset Flex Noun
3004 \begin_layout Plain Layout
3012 \begin_inset Flex Noun
3015 \begin_layout Plain Layout
3022 \begin_inset Flex Noun
3025 \begin_layout Plain Layout
3034 \begin_inset Flex Noun
3037 \begin_layout Plain Layout
3044 \begin_inset Flex Noun
3047 \begin_layout Plain Layout
3055 all of which share the extension
3056 \begin_inset Flex Noun
3059 \begin_layout Plain Layout
3066 and which correspond to the conversion methods just mentioned.
3069 \begin_layout Chapter
3070 Internationalizing \SpecialChar LyX
3072 \begin_inset CommandInset label
3074 name "cha:Internationalizing-LyX"
3081 \begin_layout Standard
3083 supports using a translated interface.
3084 Last time we checked,
3086 provided text in thirty languages.
3087 The language of choice is called your
3092 (For further reading on locale settings,
3093 see also the documentation for locale that comes with your operating system.
3096 \begin_inset Flex Code
3099 \begin_layout Plain Layout
3105 could be a good place to start).
3108 \begin_layout Standard
3109 Notice that these translations will work,
3110 but do contain a few flaws.
3112 all dialogs have been designed with the English text in mind,
3113 which means that some of the translated text will be too large to fit within the space allocated.
3114 This is only a display problem and will not cause any harm.
3116 you will find that some of the translations do not define shortcut keys for everything.
3118 there are simply not enough free letters to do it.
3120 the translator just hasn't got around to doing it yet.
3121 Our localization team,
3122 which you may wish to join,
3126 \begin_layout Plain Layout
3127 If you are a fluent speaker of a language other than English,
3128 joining these teams is a great way to give back to the \SpecialChar LyX
3134 will of course try to fix these shortcomings in future versions of \SpecialChar LyX
3138 \begin_layout Section
3139 Translating \SpecialChar LyX
3143 \begin_layout Subsection
3144 Translating the graphical user interface (text messages).
3147 \begin_layout Standard
3150 \begin_inset Flex Code
3153 \begin_layout Plain Layout
3159 library to handle the internationalization of the interface.
3160 To have \SpecialChar LyX
3161 speak your favorite language in all menus and dialogs,
3163 \begin_inset Flex Code
3166 \begin_layout Plain Layout
3172 -file for that language.
3173 When this is available,
3174 you'll have to generate a
3175 \begin_inset Flex Code
3178 \begin_layout Plain Layout
3184 -file from it and install the
3185 \begin_inset Flex Code
3188 \begin_layout Plain Layout
3195 The process of doing all of this is explained in the documentation for GNU
3196 \begin_inset Flex Code
3199 \begin_layout Plain Layout
3206 It is possible to do this just for yourself,
3207 but if you're going to do it,
3208 you might as well share the results of your labors with the rest of the \SpecialChar LyX
3210 Send a message to the \SpecialChar LyX
3211 developers' list for more information about how to proceed.
3214 \begin_layout Standard
3216 this is what you should do (xx denotes the language code):
3219 \begin_layout Itemize
3220 Check out the \SpecialChar LyX
3223 \begin_inset CommandInset href
3225 name "information on the web"
3226 target "https://www.lyx.org/HowToUseGIT"
3234 \begin_layout Itemize
3236 \begin_inset Flex Code
3239 \begin_layout Plain Layout
3245 to the folder of the
3246 \begin_inset Flex Code
3249 \begin_layout Plain Layout
3257 \begin_inset Flex Code
3260 \begin_layout Plain Layout
3268 \begin_inset Flex Code
3271 \begin_layout Plain Layout
3277 doesn't exist anywhere,
3278 it can be remade with the console command
3279 \begin_inset Flex Code
3282 \begin_layout Plain Layout
3289 or you can use an existing po-file for some other language as a template).
3292 \begin_layout Itemize
3294 \begin_inset Flex Code
3297 \begin_layout Plain Layout
3307 \begin_layout Plain Layout
3308 This is just a text file,
3309 so it can be edited in any text editor.
3310 But there are also specialized programs that support such editing,
3315 (for all platforms) or
3324 contains a `mode' for editing
3325 \begin_inset Flex Code
3328 \begin_layout Plain Layout
3337 \begin_inset Flex URL
3340 \begin_layout Plain Layout
3342 https://www.gnu.org/software/gettext/manual/html_node/PO-Mode.html#PO-Mode
3352 For some menu- and widget-labels,
3353 there are also shortcut keys that should be translated.
3354 Those keys are marked after a `|',
3355 and should be translated according to the words and phrases of the language.
3356 You should also fill also out the information at the beginning of the new
3357 \begin_inset Flex Code
3360 \begin_layout Plain Layout
3366 -file with your email-address,
3368 so people know where to reach you with suggestions and entertaining flames.
3371 \begin_layout Standard
3372 If you are just doing this on your own,
3376 \begin_layout Itemize
3378 \begin_inset Flex Code
3381 \begin_layout Plain Layout
3388 This can be done with
3389 \begin_inset Flex Code
3392 \begin_layout Plain Layout
3393 msgfmt -o xx.mo < xx.po
3401 \begin_layout Itemize
3403 \begin_inset Flex Code
3406 \begin_layout Plain Layout
3412 -file to your locale-tree,
3413 at the correct directory for application messages for the language
3419 \begin_inset Flex Code
3422 \begin_layout Plain Layout
3429 \begin_inset space \thinspace{}
3433 \begin_inset space \space{}
3437 \begin_inset Flex Code
3440 \begin_layout Plain Layout
3441 /usr/local/share/locale/xx/LC_MESSAGES/lyx.mo
3451 \begin_layout Standard
3454 it would be best if the new
3455 \begin_inset Flex Code
3458 \begin_layout Plain Layout
3464 file could be added to the \SpecialChar LyX
3466 so others can use it.
3467 Adding it involves making additional changes to \SpecialChar LyX
3469 So send an email to the developers' mailing list if you're interested in doing that.
3472 \begin_layout Subsubsection
3476 \begin_layout Standard
3477 Sometimes it turns out that one English message needs to be translated into different messages in the target language.
3478 One example is the message
3479 \begin_inset Flex Code
3482 \begin_layout Plain Layout
3488 which has the German translation
3497 depending upon exactly what the English
3498 \begin_inset Quotes eld
3502 \begin_inset Quotes erd
3507 \begin_inset Flex Code
3510 \begin_layout Plain Layout
3516 does not handle such ambiguous translations.
3517 Therefore you have to add some context information to the message:
3519 \begin_inset Flex Code
3522 \begin_layout Plain Layout
3529 \begin_inset Flex Code
3532 \begin_layout Plain Layout
3533 To[[as in 'From format x to format y']]
3539 \begin_inset Flex Code
3542 \begin_layout Plain Layout
3543 To[[as in 'From page x to page y']].
3548 Now the two occurrences of
3549 \begin_inset Flex Code
3552 \begin_layout Plain Layout
3559 \begin_inset Flex Code
3562 \begin_layout Plain Layout
3568 and can be translated correctly to
3580 \begin_layout Standard
3581 Of course the context information needs to be stripped off the original message when no translation is used.
3582 Therefore you have to put it in double square brackets at the end of the message (see the example above).
3583 The translation mechanism of \SpecialChar LyX
3584 ensures that everything in double square brackets at the end of messages is removed before displaying the message.
3587 \begin_layout Subsection
3588 Translating the documentation.
3591 \begin_layout Standard
3592 The online documentation (in the
3593 \begin_inset Flex Noun
3596 \begin_layout Plain Layout
3602 -menu) can (and should!) be translated.
3603 If there are translated versions of the documentation available
3607 \begin_layout Plain Layout
3609 at least some of the documents have been translated into fourteen languages,
3610 with the Tutorial available in a few more.
3615 and the locale is set accordingly,
3616 these will be used automagically by \SpecialChar LyX
3619 looks for translated versions as
3620 \begin_inset Flex Code
3623 \begin_layout Plain Layout
3624 LyXDir/doc/xx/DocName.lyx
3631 \begin_inset Flex Code
3634 \begin_layout Plain Layout
3640 is the code for the language currently in use.
3641 If there are no translated documents,
3642 the default English versions will be displayed.
3643 Note that the translated versions must have the same filenames (
3644 \begin_inset Flex Code
3647 \begin_layout Plain Layout
3653 above) as the original.
3654 If you feel up to translating the documentation (an excellent way to proof-read the original documentation by the way!),
3655 there are a few things you should do right away:
3658 \begin_layout Itemize
3659 Check out the documentation translation web page at
3660 \begin_inset CommandInset href
3662 name "https://www.lyx.org/Translation"
3663 target "https://www.lyx.org/Translation"
3670 you can find out which (if any) documents have already been translated into your language.
3671 You can also find out who (if anyone) is organizing the effort to translate the documentation into your language.
3672 If no one is organizing the effort,
3673 please let us know that you're interested.
3676 \begin_layout Standard
3677 Once you get to actually translating,
3678 here's a few hints for you that may save you trouble:
3681 \begin_layout Itemize
3682 Join the documentation team!
3683 There is information on how to do that in
3684 \begin_inset Flex Code
3687 \begin_layout Plain Layout
3694 \begin_inset Flex Noun
3697 \begin_layout Plain Layout
3698 Help\SpecialChar menuseparator
3705 which by the way is the first document you should translate.
3708 \begin_layout Itemize
3709 Learn the typographic conventions for the language you are translating to.
3710 Typography is an ancient art and over the centuries,
3711 a great variety of conventions have developed throughout different parts of the world.
3712 Also study the professional terminology amongst typographers in your country.
3713 Inventing your own terminology will only confuse the users.
3717 Typography is addictive!)
3720 \begin_layout Itemize
3721 Make a copy of the document.
3722 This will be your working copy.
3723 You can use this as your personal translated help-file by placing it in your
3724 \begin_inset Flex Code
3727 \begin_layout Plain Layout
3734 \begin_inset Note Greyedout
3737 \begin_layout Plain Layout
3743 For a complex document with external material (images,
3745 if you make a copy e.
3746 \begin_inset space \thinspace{}
3750 \begin_inset space \space{}
3754 beware that the links to external material may be broken when the document is moved to a different place.
3755 The best way is to retrieve the \SpecialChar LyX
3757 \begin_inset Flex URL
3760 \begin_layout Plain Layout
3762 https://www.lyx.org/HowToUseGIT
3767 ) and to edit the doc file in place.
3775 \begin_layout Itemize
3776 Sometimes the original document (from the \SpecialChar LyX
3777 team) will be updated.
3778 Use the source viewer at
3779 \begin_inset CommandInset href
3781 name "https://www.lyx.org/trac/timeline"
3782 target "https://www.lyx.org/trac/timeline"
3787 to see what has been changed.
3788 That way you can easily see which parts of the translated document need to be updated.
3791 \begin_layout Standard
3792 If you ever find an error in the original document,
3793 fix it and notify the rest of the documentation team of the changes!
3794 (You didn't forget to join the documentation team,
3798 \begin_layout Standard
3799 \begin_inset Branch OutDated
3803 \begin_layout Section
3804 International Keyboard Support
3807 \begin_layout Standard
3811 The following section is by
3819 It needs to be fixed to conform to the new Documentation Style sheet and to make use of the new v1.0 features.
3820 The whole thing also needs to be merged with the section following it.-jw It may also be badly out of date.-rh (2008)]
3823 \begin_layout Subsection
3824 Defining Own Keymaps:
3828 \begin_layout Standard
3829 Let's look at a keyboard definition file a little closer.
3830 It is a plain text file defining
3833 \begin_layout Itemize
3834 key-to-key or key-to-string translations
3837 \begin_layout Itemize
3841 \begin_layout Itemize
3842 dead keys exceptions
3845 \begin_layout Standard
3846 To define key-to-key or key-to-string translation,
3850 \begin_layout Quotation
3851 \begin_inset Flex Code
3854 \begin_layout Plain Layout
3863 \begin_inset Flex Code
3866 \begin_layout Plain Layout
3875 \begin_layout Standard
3877 \begin_inset Flex Code
3880 \begin_layout Plain Layout
3886 is the key to be translated and
3887 \begin_inset Flex Code
3890 \begin_layout Plain Layout
3896 is the string to be inserted into the document.
3897 To define dead keys,
3901 \begin_layout Quotation
3902 \begin_inset Flex Code
3905 \begin_layout Plain Layout
3914 \begin_inset Flex Code
3917 \begin_layout Plain Layout
3926 \begin_layout Standard
3928 \begin_inset Flex Code
3931 \begin_layout Plain Layout
3937 is a keyboard key and
3938 \begin_inset Flex Code
3941 \begin_layout Plain Layout
3948 The following dead keys are supported (shortcut name is in parentheses):
3951 \begin_layout Quotation
3955 \begin_inset space \hfill{}
3961 \begin_layout Quotation
3963 \begin_inset space \hfill{}
3969 \begin_layout Quotation
3971 \begin_inset space \hfill{}
3977 \begin_layout Quotation
3979 \begin_inset space \hfill{}
3985 \begin_layout Quotation
3987 \begin_inset space \hfill{}
3993 \begin_layout Quotation
3995 \begin_inset space \hfill{}
4002 \begin_layout Plain Layout
4014 \begin_layout Quotation
4016 \begin_inset space \hfill{}
4022 \begin_layout Quotation
4024 \begin_inset space \hfill{}
4031 \begin_layout Plain Layout
4043 \begin_layout Quotation
4045 \begin_inset space \hfill{}
4051 \begin_layout Quotation
4053 \begin_inset space \hfill{}
4059 \begin_layout Quotation
4061 \begin_inset space \hfill{}
4068 \begin_layout Plain Layout
4080 \begin_layout Quotation
4082 \begin_inset space \hfill{}
4089 \begin_layout Plain Layout
4101 \begin_layout Quotation
4103 \begin_inset space \hfill{}
4109 \begin_layout Quotation
4110 hungarian umlaut (hug)
4111 \begin_inset space \hfill{}
4117 \begin_layout Quotation
4119 \begin_inset space \hfill{}
4125 \begin_layout Quotation
4127 \begin_inset space \hfill{}
4134 \begin_layout Plain Layout
4146 \begin_layout Standard
4147 Since in many international keyboards there are exceptions to what some dead keys should do,
4148 you can define them using
4151 \begin_layout Quotation
4152 \begin_inset Flex Code
4155 \begin_layout Plain Layout
4163 deadkey key outstring
4166 \begin_layout Standard
4169 if you enter caron-o,
4170 it generates circumflex-o,
4174 \begin_layout Quotation
4175 \begin_inset Flex Code
4178 \begin_layout Plain Layout
4191 \begin_layout Standard
4192 to make it work correctly.
4194 you have to define as exceptions dead keys over i and j,
4195 to remove the dot from them before inserting an accent mark.
4196 I will change this when the time comes,
4197 but so far I haven't had time.
4200 \begin_layout Standard
4202 and about characters:
4203 backslash is escaped,
4205 you'll need double backslash.
4208 \begin_inset Flex Code
4211 \begin_layout Plain Layout
4217 have different meaning.
4219 \begin_inset Flex Code
4222 \begin_layout Plain Layout
4229 quotes start and end \SpecialChar LaTeX
4233 \begin_inset Flex Code
4236 \begin_layout Plain Layout
4246 \begin_inset Flex Code
4249 \begin_layout Plain Layout
4257 \begin_inset Flex Code
4260 \begin_layout Plain Layout
4271 \begin_layout Standard
4272 If you make a keyboard description file that works for your language,
4273 please mail it to me,
4274 so I can include it in the next keymap distribution.
4277 \begin_layout Standard
4278 More keywords will be supported in keymap configuration file in future,
4282 \begin_layout Itemize
4283 \begin_inset Flex Code
4286 \begin_layout Plain Layout
4297 \begin_inset space \hfill{}
4301 \begin_inset Flex Code
4304 \begin_layout Plain Layout
4313 \begin_layout Itemize
4314 \begin_inset Flex Code
4317 \begin_layout Plain Layout
4328 \begin_inset space \hfill{}
4332 \begin_inset Flex Code
4335 \begin_layout Plain Layout
4341 an external keymap translation program
4344 \begin_layout Standard
4347 \begin_inset Flex Code
4350 \begin_layout Plain Layout
4359 \begin_inset Flex Code
4362 \begin_layout Plain Layout
4370 option to include default keyboard).
4378 \begin_layout Section
4379 International Keymap Stuff
4380 \begin_inset CommandInset label
4382 name "sec:International-Keymap-Stuff"
4389 \begin_layout Standard
4390 \begin_inset Note Note
4393 \begin_layout Plain Layout
4394 In doing the revisions on this document in March 2008,
4395 I did not look over this stuff,
4396 as I do not understand it.
4397 It would be good if someone else could do so.
4406 \begin_layout Standard
4407 The next two sections describe the
4408 \begin_inset Flex Code
4411 \begin_layout Plain Layout
4420 \begin_inset Flex Code
4423 \begin_layout Plain Layout
4431 file syntax in detail.
4432 These sections should help you design your own key map if the ones provided do not meet your needs.
4435 \begin_layout Subsection
4439 \begin_layout Standard
4443 \begin_inset Flex Code
4446 \begin_layout Plain Layout
4452 file maps keystrokes to characters or strings.
4453 As the name suggests,
4454 it sets a keyboard mapping.
4456 \begin_inset Flex Code
4459 \begin_layout Plain Layout
4470 \begin_inset Flex Code
4473 \begin_layout Plain Layout
4489 \begin_inset Flex Code
4492 \begin_layout Plain Layout
4506 \begin_inset Flex Code
4509 \begin_layout Plain Layout
4519 \begin_inset Flex Code
4522 \begin_layout Plain Layout
4530 are described in this section.
4533 \begin_layout Labeling
4534 \labelwidthstring 00.00.0000
4535 \begin_inset Flex Code
4538 \begin_layout Plain Layout
4546 Map a character to a string
4549 \begin_layout LyX-Code
4564 \begin_layout Standard
4598 the double-quote (")
4615 must be escaped with a preceding backslash (
4626 \begin_layout Standard
4628 \begin_inset Flex Noun
4631 \begin_layout Plain Layout
4639 statement to cause the symbol
4640 \begin_inset Flex Noun
4643 \begin_layout Plain Layout
4651 to be output for the keystroke
4652 \begin_inset Flex Noun
4655 \begin_layout Plain Layout
4666 \begin_layout LyX-Code
4672 \begin_layout Labeling
4673 \labelwidthstring 00.00.0000
4674 \begin_inset Flex Code
4677 \begin_layout Plain Layout
4685 Specify an accent character
4688 \begin_layout LyX-Code
4697 \begin_layout Standard
4698 This will make the cha
4736 This is the dead key
4740 \begin_layout Plain Layout
4747 refers to a key that does not produce a character by itself,
4748 but when followed with another key,
4749 produces the desired accent character.
4753 r with an umlaut like
4763 can be produced in this manner.
4772 \begin_layout Standard
4785 and then another key not in
4803 followed by the other,
4809 \begin_inset Flex Noun
4812 \begin_layout Plain Layout
4832 \begin_inset Flex Noun
4835 \begin_layout Plain Layout
4845 the cursor will not go one position backwards but will instead cancel the effect t
4860 might have had on the next keystroke.
4864 \begin_layout Standard
4865 The following example specifies that the character ' is to be an acute accent,
4866 allowed on the characters a,
4878 \begin_layout LyX-Code
4881 kmod ' acute aeiouAEIOU
4884 \begin_layout Labeling
4885 \labelwidthstring 00.00.0000
4886 \begin_inset Flex Code
4889 \begin_layout Plain Layout
4895 Specify an exception to the accent character
4898 \begin_layout LyX-Code
4907 \begin_layout Standard
4908 This defines an exce
4949 have been assigned a keystroke with a previous
4952 \begin_inset Flex Code
4955 \begin_layout Plain Layout
4979 must not belong in the
5027 If such a declaration does not exist in
5035 \begin_inset Flex Code
5038 \begin_layout Plain Layout
5073 \begin_inset Flex Code
5076 \begin_layout Plain Layout
5090 \begin_layout Standard
5091 The following command produces causes äi to be produced when you enter acute-i ('i):
5094 \begin_layout LyX-Code
5108 \begin_layout Labeling
5109 \labelwidthstring 00.00.0000
5110 \begin_inset Flex Code
5113 \begin_layout Plain Layout
5119 Combine two accent characters
5122 \begin_layout LyX-Code
5128 accent1 accent2 allowed
5131 \begin_layout Standard
5132 This one is getting pretty esoteric.
5133 It allows you to combine the effect
5189 \begin_inset Flex Code
5192 \begin_layout Plain Layout
5220 \begin_layout Standard
5221 Consider this example from the
5222 \begin_inset Flex Code
5225 \begin_layout Plain Layout
5236 \begin_layout LyX-Code
5240 acute aeioyvhAEIOYVH
5245 kcomb acute umlaut iyIY
5248 \begin_layout Standard
5249 This allows you to press
5250 \begin_inset Flex Noun
5253 \begin_layout Plain Layout
5261 and get the effect of
5262 \begin_inset Flex Code
5265 \begin_layout Plain Layout
5284 in this case cancels the last dead key,
5286 \begin_inset Flex Noun
5289 \begin_layout Plain Layout
5299 \begin_inset Flex Code
5302 \begin_layout Plain Layout
5315 \begin_layout Subsection
5319 \begin_layout Standard
5321 \begin_inset Flex Code
5324 \begin_layout Plain Layout
5332 mapping is performed,
5334 \begin_inset Flex Code
5337 \begin_layout Plain Layout
5347 file maps the strings that the symbols generate to characters in the current font.
5348 The \SpecialChar LyX
5349 distribution currently includes at least the
5350 \begin_inset Flex Code
5353 \begin_layout Plain Layout
5362 \begin_inset Flex Code
5365 \begin_layout Plain Layout
5376 \begin_layout Standard
5378 \begin_inset Flex Code
5381 \begin_layout Plain Layout
5389 file is a sequence of declarations of the form
5392 \begin_layout LyX-Code
5405 \begin_layout Standard
5408 \begin_inset Flex Noun
5411 \begin_layout Plain Layout
5421 to the corresponding character in the iso-8859-1 set (233),
5422 the following declaration is used
5425 \begin_layout LyX-Code
5433 \begin_layout Standard
5435 \begin_inset Flex Code
5438 \begin_layout Plain Layout
5447 \begin_inset Flex Code
5450 \begin_layout Plain Layout
5468 the same character can apply to more than one string.
5470 \begin_inset Flex Code
5473 \begin_layout Plain Layout
5484 \begin_layout LyX-Code
5496 \begin_inset Newline newline
5512 \begin_layout Standard
5514 cannot find a mapping for the string produced by the keystroke or a deadkey sequence,
5515 it will check if it looks like an accented char and try to draw an accent over the character on screen.
5518 \begin_layout Subsection
5522 \begin_layout Standard
5523 There is a second way to add support for international characters through so-called dead-keys.
5524 A dead-key works in combination with a letter to produce an accented character.
5526 we'll explain how to create a really simple dead-key to illustrate how they work.
5529 \begin_layout Standard
5530 Suppose you happen to need the circumflex character,
5532 \begin_inset Quotes eld
5536 \begin_inset Quotes erd
5541 \begin_inset Flex Noun
5544 \begin_layout Plain Layout
5551 \begin_inset space ~
5555 \begin_inset Flex Noun
5558 \begin_layout Plain Layout
5564 ] to the \SpecialChar LyX
5566 \begin_inset Flex Code
5569 \begin_layout Plain Layout
5576 \begin_inset Flex Code
5579 \begin_layout Plain Layout
5587 whenever you type the
5588 \begin_inset Flex Noun
5591 \begin_layout Plain Layout
5597 -key followed by a letter,
5598 that letter will have a circumflex accent on it.
5601 \begin_inset Quotes eld
5605 \begin_inset Flex Noun
5608 \begin_layout Plain Layout
5615 \begin_inset Quotes erd
5618 produces the letter:
5620 \begin_inset Quotes eld
5624 \begin_inset Quotes erd
5628 If you tried to type
5629 \begin_inset Quotes eld
5633 \begin_inset Flex Noun
5636 \begin_layout Plain Layout
5643 \begin_inset Quotes erd
5649 will complain with a beep,
5651 \begin_inset Quotes eld
5655 \begin_inset Flex Noun
5658 \begin_layout Plain Layout
5665 \begin_inset Quotes erd
5668 never takes a circumflex accent.
5670 \begin_inset Flex Noun
5673 \begin_layout Plain Layout
5679 after a dead-key produces the bare-accent.
5680 Please note this last point!
5681 If you bind a key to a dead-key,
5682 you'll need to rebind the character on that key to yet another key.
5684 \begin_inset Flex Noun
5687 \begin_layout Plain Layout
5693 to a cedilla is a bad idea,
5694 since you'll only get cedillas instead of commas.
5697 \begin_layout Standard
5698 One common way to bind dead-keys is to use
5699 \begin_inset Flex Noun
5702 \begin_layout Plain Layout
5710 \begin_inset Flex Noun
5713 \begin_layout Plain Layout
5721 \begin_inset Flex Noun
5724 \begin_layout Plain Layout
5730 in combination with an accent,
5732 \begin_inset Quotes eld
5736 \begin_inset Flex Noun
5739 \begin_layout Plain Layout
5746 \begin_inset Quotes erd
5750 \begin_inset Quotes eld
5754 \begin_inset Flex Noun
5757 \begin_layout Plain Layout
5764 \begin_inset Quotes erd
5768 \begin_inset Quotes eld
5772 \begin_inset Flex Noun
5775 \begin_layout Plain Layout
5782 \begin_inset Quotes erd
5786 Another way involves using
5787 \begin_inset Flex Code
5790 \begin_layout Plain Layout
5797 \begin_inset Flex Code
5800 \begin_layout Plain Layout
5806 to set up the special
5807 \begin_inset Flex Code
5810 \begin_layout Plain Layout
5818 \begin_inset Flex Code
5821 \begin_layout Plain Layout
5827 acts in some ways just like
5828 \begin_inset Flex Noun
5831 \begin_layout Plain Layout
5837 and permits you to bind keys to accented characters.
5838 You can also turn keys into dead-keys by binding them to something like
5839 \begin_inset Flex Code
5842 \begin_layout Plain Layout
5848 and then binding this symbolic key to the corresponding \SpecialChar LyX
5853 \begin_layout Plain Layout
5859 This is exactly what I do in my
5860 \begin_inset Flex Code
5863 \begin_layout Plain Layout
5870 \begin_inset Flex Code
5873 \begin_layout Plain Layout
5881 \begin_inset Flex Noun
5884 \begin_layout Plain Layout
5886 \begin_inset space ~
5895 \begin_inset Flex Code
5898 \begin_layout Plain Layout
5904 and a bunch of these
5905 \begin_inset Quotes eld
5909 \begin_inset Flex Code
5912 \begin_layout Plain Layout
5919 \begin_inset Quotes erd
5922 symbolic keys bound such things as
5923 \begin_inset Flex Noun
5926 \begin_layout Plain Layout
5928 \begin_inset space ~
5937 \begin_inset Flex Noun
5940 \begin_layout Plain Layout
5942 \begin_inset space ~
5951 This is how I produce my accented characters.
5956 You can make just about anything into the
5957 \begin_inset Flex Code
5960 \begin_layout Plain Layout
5968 \begin_inset Flex Noun
5971 \begin_layout Plain Layout
5978 a spare function key,
5980 As for the \SpecialChar LyX
5981 commands that produce accents,
5983 \begin_inset Flex Code
5986 \begin_layout Plain Layout
5997 You'll find the complete list there.
6000 \begin_layout Subsection
6001 Saving your Language Configuration
6004 \begin_layout Standard
6005 You can edit your preferences so that your desired language environment is automatically configured when \SpecialChar LyX
6008 \begin_inset Flex Noun
6011 \begin_layout Plain Layout
6012 Edit\SpecialChar menuseparator
6021 \begin_layout Chapter
6022 Creating and Installing New Document Classes,
6025 \begin_inset CommandInset label
6027 name "cha:Installing-New-Document"
6032 \begin_inset Argument 1
6035 \begin_layout Plain Layout
6036 Installing New Document Classes
6044 \begin_layout Standard
6046 we describe the procedures for creating and installing new \SpecialChar LyX
6047 layout and template files,
6048 as well as offer a refresher on correctly installing new \SpecialChar LaTeX
6053 \begin_layout Standard
6055 let us a say a few words about how one ought to think about the relation between \SpecialChar LyX
6056 and \SpecialChar LaTeX
6058 The thing to understand is that,
6061 doesn't know anything about \SpecialChar LaTeX
6064 from \SpecialChar LyX
6067 is just one of several
6068 \begin_inset Quotes eld
6072 \begin_inset Quotes erd
6075 in which it is capable of producing output.
6076 Other such formats are DocBook,
6082 a particularly important format,
6083 but very little of the information \SpecialChar LyX
6084 has about \SpecialChar LaTeX
6085 is actually contained in the program itself.
6089 \begin_layout Plain Layout
6090 Some commands are sufficiently complex that they are
6091 \begin_inset Quotes eld
6095 \begin_inset Quotes erd
6098 into \SpecialChar LyX
6100 But the developers generally regard this as a Bad Thing.
6107 even for the standard classes like
6108 \begin_inset Flex Code
6111 \begin_layout Plain Layout
6118 is contained in `layout files'.
6121 itself does not know much about DocBook or XHTML.
6122 What it knows is contained in layout files.
6125 \begin_layout Standard
6126 You can think of the layout file for a given document class as a translation manual between \SpecialChar LyX
6128 paragraphs with their corresponding styles,
6129 certain sorts of insets,
6131 and the corresponding \SpecialChar LaTeX
6134 or XHTML constructs.
6135 Almost everything \SpecialChar LyX
6137 \begin_inset Flex Code
6140 \begin_layout Plain Layout
6148 is contained in the file
6149 \begin_inset Flex Code
6152 \begin_layout Plain Layout
6158 and in various other files it includes.
6160 anyone intending to write layout files should plan to study the existing files.
6161 A good place to start is with
6162 \begin_inset Flex Code
6165 \begin_layout Plain Layout
6172 which is included in
6173 \begin_inset Flex Code
6176 \begin_layout Plain Layout
6184 \begin_inset Flex Code
6187 \begin_layout Plain Layout
6194 and many of the other layout files for document classes.
6195 This file is where sections and the like are defined:
6197 \begin_inset Flex Code
6200 \begin_layout Plain Layout
6206 tells \SpecialChar LyX
6207 how paragraphs that are marked with the Section,
6210 styles can be translated into corresponding \SpecialChar LaTeX
6213 and XHTML commands and tags.
6215 \begin_inset Flex Code
6218 \begin_layout Plain Layout
6224 file basically just includes several of these
6225 \begin_inset Flex Code
6228 \begin_layout Plain Layout
6237 \begin_layout Standard
6238 Defining the \SpecialChar LyX
6240 correspondence is not the only thing layout files do,
6242 Their other job is to define how the \SpecialChar LyX
6243 constructs themselves will appear on-screen.
6244 The fact that layout files have these two jobs is often a source of confusion,
6245 because they are completely separate.
6246 Telling \SpecialChar LyX
6247 how to translate a certain paragraph style into \SpecialChar LaTeX
6248 does not tell \SpecialChar LyX
6251 telling \SpecialChar LyX
6252 how to display a certain paragraph style does not tell \SpecialChar LyX
6253 how to translate it into \SpecialChar LaTeX
6254 (let alone tell \SpecialChar LaTeX
6258 when you define a new \SpecialChar LyX
6260 you must always do two quite separate things:
6262 \begin_inset space ~
6265 tell \SpecialChar LyX
6266 how to translate it into \SpecialChar LaTeX
6268 \begin_inset space ~
6271 tell \SpecialChar LyX
6275 \begin_layout Standard
6276 Much the same is true,
6278 as regards \SpecialChar LyX
6279 's other backend formats,
6280 though XHTML is in some ways different,
6281 because in that case \SpecialChar LyX
6288 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.
6291 the distinction between what \SpecialChar LyX
6292 does internally and how things are rendered externally remains in force,
6293 and the two can be controlled separately.
6295 \begin_inset CommandInset ref
6297 reference "sec:Tags-for-XHTML"
6305 \begin_layout Section
6306 Installing new \SpecialChar LaTeX
6310 \begin_layout Standard
6311 Some installations may not include a \SpecialChar LaTeX
6312 package or class file that you would like to use within \SpecialChar LyX
6315 you might need Foil\SpecialChar TeX
6317 a package for preparing slides for overhead projectors.
6318 Modern \SpecialChar LaTeX
6319 distributions like \SpecialChar TeX
6320 Live (2008 or newer) or MiK\SpecialChar TeX
6321 provide a user interface for installing such packages.
6323 with MiK\SpecialChar TeX
6325 you start the program
6326 \begin_inset Quotes eld
6330 \begin_inset space ~
6334 \begin_inset Quotes erd
6337 to get a list of available packages.
6338 To install one of them,
6339 right click on it or use the corresponding toolbar button.
6342 \begin_layout Standard
6343 If your \SpecialChar LaTeX
6344 distribution does not provide such a `package manager',
6345 or if the package is not available from your distribution,
6346 then follow these steps to install it manually:
6349 \begin_layout Enumerate
6350 Get the package from
6351 \begin_inset CommandInset href
6354 target "http://www.ctan.org/"
6362 \begin_layout Enumerate
6363 If the package contains a file with the ending
6364 \begin_inset Quotes eld
6368 \begin_inset Flex Code
6371 \begin_layout Plain Layout
6378 \begin_inset Quotes erd
6381 (is the case for Foil\SpecialChar TeX
6382 ) then open a console,
6383 change to the folder of this file and execute the command
6384 \begin_inset Flex Code
6387 \begin_layout Plain Layout
6394 You have now unpacked the package and have all files to install it.
6395 Most \SpecialChar LaTeX
6396 -packages are not packed and you can skip this step.
6399 \begin_layout Enumerate
6400 Now you need to decide if the package should be available for all users or only for you.
6404 \begin_layout Enumerate
6405 On *nix systems (Linux,
6408 if you want the new package to be available for all users on your system,
6409 then install it in your `local' \SpecialChar TeX
6411 otherwise install it in your own `user' \SpecialChar TeX
6413 Where these trees should be created,
6414 if they do not already exist,
6415 depends on your system.
6418 \begin_inset Flex Code
6421 \begin_layout Plain Layout
6431 \begin_layout Plain Layout
6432 This is usually in the directory
6433 \begin_inset Flex Code
6436 \begin_layout Plain Layout
6443 though you can execute the command
6444 \begin_inset Flex Code
6447 \begin_layout Plain Layout
6458 The location of the `local' \SpecialChar TeX
6459 tree is defined by the
6460 \begin_inset Flex Code
6463 \begin_layout Plain Layout
6470 this is usually somewhere like
6471 \begin_inset Flex Code
6474 \begin_layout Plain Layout
6475 /usr/local/share/texmf
6480 or /usr/local/texlive/XXXX where XXXX is the year of the installed \SpecialChar TeX
6482 The location of the `user' \SpecialChar TeX
6484 \begin_inset Flex Code
6487 \begin_layout Plain Layout
6494 \begin_inset Flex Code
6497 \begin_layout Plain Layout
6504 \begin_inset Flex Code
6507 \begin_layout Plain Layout
6516 (If these variables are not predefined,
6517 you have to define them.) You'll probably need root permissions to create or modify the `local' tree,
6518 but not for your `user' tree.
6519 \begin_inset Newline newline
6523 it is recommended to install in the user tree because your user will not be modified or even overwritten when you upgrade your system.
6524 It will typically also be backed up together with everything else when you backup your home directory (which,
6526 you do on a regular basis).
6529 \begin_layout Enumerate
6531 if you want the new package to be available for all users on your system,
6532 change to the folder where \SpecialChar LaTeX
6533 is installed and then change to the subfolder
6534 \begin_inset Flex Code
6537 \begin_layout Plain Layout
6548 (For MiK\SpecialChar TeX
6550 this would be by default the folder
6551 \begin_inset Flex Code
6554 \begin_layout Plain Layout
6572 \begin_layout Plain Layout
6573 Note that this will be the correct path only on English installations.
6576 \begin_inset Flex Code
6579 \begin_layout Plain Layout
6594 and similarly for other languages.
6599 Create there a new folder
6600 \begin_inset Flex Code
6603 \begin_layout Plain Layout
6609 and copy all files of the package into it.
6611 \begin_inset Newline newline
6614 If the package should only available for you or you don't have admin permissions,
6616 but in the local \SpecialChar LaTeX
6619 \begin_inset space \thinspace{}
6623 for MiK\SpecialChar TeX
6625 \begin_inset space ~
6628 2.8 under Windows XP,
6629 this would be the folder:
6630 \begin_inset Newline newline
6636 \begin_inset Flex Code
6639 \begin_layout Plain Layout
6642 Documents and Settings
6654 \begin_inset Newline newline
6660 \begin_inset Phantom HPhantom
6663 \begin_layout Plain Layout
6674 \begin_inset Flex Code
6677 \begin_layout Plain Layout
6690 \begin_inset Newline newline
6695 \begin_inset Newline newline
6699 \begin_inset Flex Code
6702 \begin_layout Plain Layout
6728 \begin_layout Enumerate
6729 Now one only need to tell \SpecialChar LaTeX
6730 that there are new files.
6731 This depends on the used \SpecialChar LaTeX
6736 \begin_layout Enumerate
6737 For \SpecialChar TeX
6738 Live execute the command
6739 \begin_inset Flex Code
6742 \begin_layout Plain Layout
6749 If you installed the package for all users,
6750 then you will probably need to have root permissions for that.
6753 \begin_layout Enumerate
6754 For MiK\SpecialChar TeX
6756 if you have installed the package for all users,
6758 \begin_inset Quotes eld
6762 \begin_inset space ~
6766 \begin_inset Quotes erd
6769 and press the button marked
6770 \begin_inset Quotes eld
6774 \begin_inset Quotes erd
6778 Otherwise start the program
6779 \begin_inset Quotes eld
6783 \begin_inset Quotes erd
6790 \begin_layout Enumerate
6792 you need to tell \SpecialChar LyX
6793 that there are new packages available.
6798 \begin_inset Flex Noun
6801 \begin_layout Plain Layout
6804 \SpecialChar menuseparator
6810 and then restart \SpecialChar LyX
6814 \begin_layout Standard
6815 Now the package is installed.
6818 \begin_inset Flex Code
6821 \begin_layout Plain Layout
6827 will now be available under
6828 \begin_inset Flex Noun
6831 \begin_layout Plain Layout
6832 Document\SpecialChar menuseparator
6833 Settings\SpecialChar menuseparator
6840 \begin_inset Quotes eld
6844 \begin_inset Quotes erd
6851 \begin_layout Standard
6852 If you would like to use a \SpecialChar LaTeX
6853 document class that is not even listed in the menu
6854 \begin_inset Flex Noun
6857 \begin_layout Plain Layout
6858 Document\SpecialChar menuseparator
6859 Settings\SpecialChar menuseparator
6866 then you need to create a `layout' file for it.
6867 That is the topic of the next section.
6870 \begin_layout Section
6871 Types of layout files
6874 \begin_layout Standard
6875 This section describes the various sorts of \SpecialChar LyX
6876 files that contain layout information.
6877 These files describe various paragraph and character styles,
6878 determining how \SpecialChar LyX
6879 should display them and how they should be translated into \SpecialChar LaTeX
6883 or whatever output format is being used.
6887 \begin_layout Standard
6888 We shall try to provide a thorough description of the process of writing layout files here.
6890 there are so many different types of documents supported even by just \SpecialChar LaTeX
6891 that we can't hope to cover every different possibility or problem you might encounter.
6892 The \SpecialChar LyX
6893 users' list is frequented by people with lots of experience with layout design who are willing to share what they've learned,
6894 so please feel free to ask questions there.
6897 \begin_layout Standard
6898 As you prepare to write a new layout,
6899 it is extremely helpful to look at the layouts distributed with \SpecialChar LyX
6901 If you write a \SpecialChar LyX
6902 layout for a \SpecialChar LaTeX
6903 document class that might also be used by others,
6904 or write a module that might be useful to others,
6905 then you should consider posting your layout to the
6906 \begin_inset CommandInset href
6908 name "layout section on the LyX wiki"
6909 target "https://wiki.lyx.org/Layouts/Layouts"
6914 or even to the \SpecialChar LyX
6916 so that it might be included in \SpecialChar LyX
6921 \begin_layout Plain Layout
6922 Note that \SpecialChar LyX
6923 is licensed under the General Public License,
6924 so any material that is contributed to \SpecialChar LyX
6925 must be similarly licensed.
6933 \begin_layout Subsection
6935 \begin_inset CommandInset label
6937 name "subsec:Layout-modules"
6944 \begin_layout Standard
6945 We have spoken to this point about `layout files'.
6946 But there are different sorts of files that contain layout information.
6950 \begin_inset Flex Code
6953 \begin_layout Plain Layout
6959 extension and provide \SpecialChar LyX
6960 with information about document classes.
6961 Since \SpecialChar LyX
6962 1.6 layout information can also be contained in layout
6968 \begin_inset Flex Code
6971 \begin_layout Plain Layout
6978 Modules are to \SpecialChar LaTeX
6979 packages much as layouts are to \SpecialChar LaTeX
6983 \begin_inset Flex Code
6986 \begin_layout Plain Layout
6993 specifically provide support for one package.
6995 layout modules are similar to included
6999 \begin_layout Plain Layout
7000 These can have any extension,
7001 but by convention have the
7002 \begin_inset Flex Code
7005 \begin_layout Plain Layout
7018 \begin_inset Flex Code
7021 \begin_layout Plain Layout
7028 in that modules are not specific to a given document class but may be used with many different classes.
7029 The difference is that using an included file with
7030 \begin_inset Flex Code
7033 \begin_layout Plain Layout
7039 requires editing that file.
7043 \begin_inset Flex Noun
7046 \begin_layout Plain Layout
7047 Document\SpecialChar menuseparator
7056 \begin_layout Standard
7057 Building modules is the easiest way to get started with layout editing,
7058 since it can be as simple as adding a single new paragraph style or flex inset.
7061 contain anything a layout file can contain.
7064 \begin_layout Standard
7065 After creating a new module and copying it to the
7066 \begin_inset Flex Code
7069 \begin_layout Plain Layout
7076 you will need to reconfigure and then restart \SpecialChar LyX
7077 for the module to appear in the menu.
7079 changes you make to the module will be seen immediately,
7081 \begin_inset Flex Noun
7084 \begin_layout Plain Layout
7085 Document\SpecialChar menuseparator
7092 highlight something,
7094 \begin_inset Quotes eld
7098 \begin_inset Quotes erd
7104 It is strongly recommended that you save your work before doing this
7110 it is strongly recommended that you not attempt to edit modules while simultaneously working on actual documents
7113 Though of course the developers strive to keep \SpecialChar LyX
7114 stable in such situations,
7115 syntax errors and the like in your module file could cause strange behavior.
7118 \begin_layout Subsubsection
7122 \begin_layout Standard
7123 Modules are to \SpecialChar LyX
7124 as packages are to \SpecialChar LaTeX
7128 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.
7129 What you need is \SpecialChar LyX
7131 \begin_inset Quotes eld
7135 \begin_inset Quotes erd
7141 \begin_layout Standard
7142 You will find it under
7144 Document\SpecialChar menuseparator
7145 Settings\SpecialChar menuseparator
7149 The large text box allows you to enter anything that you might enter in a layout file or module.
7150 You can think of a document's local layout,
7152 as a module that belongs just to it.
7156 \begin_inset Flex Code
7159 \begin_layout Plain Layout
7166 Any format is acceptable,
7167 but one would normally use the format current at the time.
7168 (In \SpecialChar LyX
7176 the current layout format is
7185 \begin_layout Standard
7186 When you have entered something in the
7187 \begin_inset Flex Code
7190 \begin_layout Plain Layout
7199 \begin_inset Quotes eld
7203 \begin_inset Quotes erd
7206 button at the bottom.
7207 Clicking this button will cause \SpecialChar LyX
7208 to determine whether what you have entered is valid layout information for the chosen format.
7210 will report the result but,
7212 will not tell you what errors there might have been.
7213 These will be written to the terminal,
7216 is started from a terminal.
7217 You will not be permitted to save your local layout until you have entered something valid.
7220 \begin_layout Standard
7221 The warnings at the end of the previous section apply here,
7223 Do not play with local layout while you are actually working,
7224 especially if you have not saved your document.
7226 using local layout with a test document can be a very convenient way to try out layout ideas,
7227 or even to start developing a module.
7230 \begin_layout Subsection
7232 \begin_inset Flex Noun
7235 \begin_layout Plain Layout
7244 \begin_layout Standard
7245 There are two situations you are likely to encounter when wanting to support a new \SpecialChar LaTeX
7248 \begin_inset Flex Code
7251 \begin_layout Plain Layout
7257 ) files and \SpecialChar LaTeX2e
7259 \begin_inset Flex Code
7262 \begin_layout Plain Layout
7269 Supporting a style file is usually fairly easy.
7270 Supporting a new class file is a bit harder.
7271 We'll discuss the former in this section and the latter in the next.
7275 \begin_layout Standard
7276 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.
7277 For the sake of the example,
7278 we'll assume that the style file is called
7279 \begin_inset Flex Noun
7282 \begin_layout Plain Layout
7288 and that it is meant to be used with
7289 \begin_inset Flex Noun
7292 \begin_layout Plain Layout
7299 which is a standard class.
7303 \begin_layout Standard
7304 Start by copying the existing class's layout file into your local directory:
7308 \begin_layout Plain Layout
7310 which directory is your local directory will vary by platform,
7311 and \SpecialChar LyX
7312 allows you to specify your local directory on startup,
7315 \begin_inset Flex Code
7318 \begin_layout Plain Layout
7332 \begin_layout LyX-Code
7333 cp report.layout ~/.lyx/layouts/myclass.layout
7336 \begin_layout Standard
7338 \begin_inset Flex Code
7341 \begin_layout Plain Layout
7347 and change the line:
7351 \begin_layout LyX-Code
7354 DeclareLaTeXClass{Report (Standard Class)}
7357 \begin_layout Standard
7361 \begin_layout LyX-Code
7364 DeclareLaTeXClass[report,
7365 myclass.sty]{Report (My Class)}
7368 \begin_layout Standard
7372 \begin_layout LyX-Code
7374 \begin_inset Newline newline
7380 \begin_inset Newline newline
7386 \begin_layout Standard
7387 near the top of the file.
7390 \begin_layout Standard
7391 Start \SpecialChar LyX
7393 \begin_inset Flex Noun
7396 \begin_layout Plain Layout
7397 Tools\SpecialChar menuseparator
7404 Then restart \SpecialChar LyX
7405 and try creating a new document.
7407 \begin_inset Flex Noun
7410 \begin_layout Plain Layout
7416 " as a document class option in the
7417 \begin_inset Flex Noun
7420 \begin_layout Plain Layout
7421 Document\SpecialChar menuseparator
7428 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—
7430 \begin_inset Flex Code
7433 \begin_layout Plain Layout
7440 so you can fiddle around with the settings for the different sections if you wish.
7441 The layout information for sections is contained in
7442 \begin_inset Flex Code
7445 \begin_layout Plain Layout
7452 but you do not need to copy and change this file.
7454 you can simply add your changes to your layout file,
7456 \begin_inset Flex Code
7459 \begin_layout Plain Layout
7466 which itself includes
7467 \begin_inset Flex Code
7470 \begin_layout Plain Layout
7478 you might add these lines:
7481 \begin_layout LyX-Code
7485 \begin_layout LyX-Code
7489 \begin_layout LyX-Code
7493 \begin_layout LyX-Code
7497 \begin_layout LyX-Code
7501 \begin_layout Standard
7502 to change the font for chapter headings to sans-serif.
7503 This will override (or,
7505 add to) the existing declaration for the Chapter style.
7509 \begin_layout Standard
7510 Your new package may also provide commands or environments not present in the base class.
7512 you will want to add these to the layout file.
7514 \begin_inset CommandInset ref
7516 reference "sec:TextClass"
7521 for information on how to do so.
7524 \begin_layout Standard
7526 \begin_inset Flex Noun
7529 \begin_layout Plain Layout
7535 can be used with several different document classes,
7536 and even if it cannot,
7537 you might find it easiest just to write a module that you can load with the base class.
7538 The simplest possible such module would be:
7541 \begin_layout LyX-Code
7544 DeclareLyXModule{My Class}
7547 \begin_layout LyX-Code
7551 \begin_layout LyX-Code
7552 #Support for myclass.sty.
7555 \begin_layout LyX-Code
7557 \begin_inset Newline newline
7563 \begin_layout LyX-Code
7571 \begin_inset Newline newline
7577 \begin_layout LyX-Code
7579 \begin_inset Newline newline
7585 \begin_inset Newline newline
7591 \begin_layout Standard
7592 A more complex module might modify the behavior of some existing constructs or define some new ones.
7595 \begin_inset CommandInset ref
7597 reference "sec:TextClass"
7605 \begin_layout Subsection
7607 \begin_inset Flex Noun
7610 \begin_layout Plain Layout
7619 \begin_layout Standard
7620 There are two possibilities here.
7621 One is that the class file is itself based upon an existing document class.
7623 many thesis classes are based upon
7624 \begin_inset Flex Noun
7627 \begin_layout Plain Layout
7634 To see whether yours is,
7635 look for a line like
7638 \begin_layout LyX-Code
7644 \begin_layout Standard
7647 then you may proceed largely as in the previous section,
7649 \begin_inset Flex Code
7652 \begin_layout Plain Layout
7653 Declare\SpecialChar LaTeX
7659 line will be different.
7660 If your new class is
7661 \begin_inset Flex Code
7664 \begin_layout Plain Layout
7670 and it is based upon
7671 \begin_inset Flex Code
7674 \begin_layout Plain Layout
7681 then the line should read:
7685 \begin_layout Plain Layout
7686 And it will be easiest if you save the file to
7687 \begin_inset Flex Code
7690 \begin_layout Plain Layout
7698 assumes that the document class has the same name as the layout file.
7707 \begin_layout LyX-Code
7710 DeclareLaTeXClass[thesis,book]{thesis}
7713 \begin_layout Standard
7716 the new class is not based upon an existing class,
7717 you will probably have to
7718 \begin_inset Quotes eld
7722 \begin_inset Quotes erd
7726 We strongly suggest copying an existing layout file which uses a similar \SpecialChar LaTeX
7727 class and then modifying it,
7729 At least use an existing file as a starting point so you can find out what items you need to worry about.
7731 the specifics are covered below.
7734 \begin_layout Subsection
7736 \begin_inset CommandInset label
7738 name "subsec:Creating-Templates"
7745 \begin_layout Standard
7746 Once you have written a layout file for a new document class,
7747 you might want to consider writing a
7753 A template acts as a kind of tutorial for your layout,
7754 showing how it might be used,
7755 though containing dummy content.
7756 You can of course look at the various templates included with \SpecialChar LyX
7760 \begin_layout Standard
7761 Templates are created just like usual documents:
7762 using \SpecialChar LyX
7764 The only difference is that usual documents contain all possible settings,
7765 including the font scheme and the paper size.
7766 Usually a user doesn't want a template to overwrite his preferred settings for such parameters.
7768 the designer of a template should remove the corresponding commands like
7769 \begin_inset Flex Code
7772 \begin_layout Plain Layout
7781 \begin_inset Flex Code
7784 \begin_layout Plain Layout
7792 from the template \SpecialChar LyX
7794 This can be done with any simple text-editor,
7796 \begin_inset Flex Code
7799 \begin_layout Plain Layout
7806 \begin_inset Flex Code
7809 \begin_layout Plain Layout
7818 \begin_layout Standard
7819 Put the edited template files you create in
7820 \begin_inset Flex Code
7823 \begin_layout Plain Layout
7830 copy the ones you use from the global template directory in
7831 \begin_inset Flex Code
7834 \begin_layout Plain Layout
7841 and redefine the template path in the
7842 \begin_inset Flex Noun
7845 \begin_layout Plain Layout
7846 Tools\SpecialChar menuseparator
7847 Preferences\SpecialChar menuseparator
7856 \begin_layout Standard
7859 that there is a template which has a particular meaning:
7860 \begin_inset Newline linebreak
7864 \begin_inset Flex Code
7867 \begin_layout Plain Layout
7874 This template is loaded every time you create a new document with
7875 \begin_inset Flex Noun
7878 \begin_layout Plain Layout
7879 File\SpecialChar menuseparator
7885 in order to provide useful defaults.
7886 To create this template from inside \SpecialChar LyX
7888 all you have to do is to open a document with the correct settings,
7890 \begin_inset Flex Noun
7893 \begin_layout Plain Layout
7894 Save as Document Defaults
7902 \begin_layout Subsection
7903 Upgrading old layout files
7906 \begin_layout Standard
7907 The format of layout files changes with each \SpecialChar LyX
7909 so old layout files need to be converted to the new format.
7911 reads a layout file in an older format,
7912 it automatically calls the script
7913 \begin_inset Flex Code
7916 \begin_layout Plain Layout
7922 to convert it to a temporary file in current format.
7923 The original file is left untouched.
7924 If you use the layout file often,
7926 you may want to convert it permanently,
7927 so that \SpecialChar LyX
7928 does not have to do so itself every time.
7930 you can call the converter manually:
7933 \begin_layout Enumerate
7935 \begin_inset Flex Code
7938 \begin_layout Plain Layout
7945 \begin_inset Flex Code
7948 \begin_layout Plain Layout
7957 \begin_layout Enumerate
7959 \begin_inset Newline newline
7963 \begin_inset Flex Code
7966 \begin_layout Plain Layout
7967 python LyXDir/scripts/layout2layout.py myclass.old myclass.layout
7973 \begin_inset Newline newline
7977 \begin_inset Flex Code
7980 \begin_layout Plain Layout
7986 is the name of your \SpecialChar LyX
7990 \begin_layout Standard
7991 Note that manual conversion does not affect included files,
7992 so these will have to be converted separately.
7995 \begin_layout Subsection
7996 \begin_inset CommandInset label
7998 name "subsec:Cite-Engine-Files"
8005 \begin_layout Standard
8006 A specific form of layout files are the so-called
8007 \begin_inset Flex Code
8010 \begin_layout Plain Layout
8016 files that are located in the
8017 \begin_inset Flex Code
8020 \begin_layout Plain Layout
8027 Their purpose is to define the specifics of \SpecialChar LaTeX
8028 packages aimed at bibliography generation,
8043 but also the way how normal Bib\SpecialChar TeX
8044 citations (without additional packages) are handled in \SpecialChar LyX
8045 is defined in such a file.
8049 \begin_layout Standard
8051 it is defined which packages \SpecialChar LyX
8053 which citation commands are available,
8054 how these are to be displayed in \SpecialChar LyX
8057 the context menus) as well as in the XHTML and plain text output.
8059 the files specify available style variants (author-year,
8061 etc.) and their specifics.
8062 The cite engine files are also used to generate the options that are available in
8064 Document\SpecialChar menuseparator
8065 Settings\SpecialChar menuseparator
8066 Bibliography\SpecialChar menuseparator
8072 \begin_layout Standard
8073 Even though a cite engine file is essentially a normal layout file that could theoretically include any layout information,
8074 it usually primarily includes some specific parameters such as
8075 \begin_inset Flex Code
8078 \begin_layout Plain Layout
8086 \begin_inset Flex Code
8089 \begin_layout Plain Layout
8097 \begin_inset Flex Code
8100 \begin_layout Plain Layout
8107 \begin_inset Flex Code
8110 \begin_layout Plain Layout
8117 The syntax of the latter two is described in
8118 \begin_inset CommandInset ref
8120 reference "subsec:Citation-engine-description"
8129 \begin_inset CommandInset ref
8131 reference "subsec:Citation-format-description"
8137 as well as in the files themselves.
8140 \begin_layout Section
8141 \begin_inset CommandInset label
8143 name "sec:TextClass"
8147 The layout file format
8150 \begin_layout Standard
8151 The following sections describe how layout files are structured and written.
8152 Our advice is to go slowly,
8153 save and test often.
8154 It is really not that hard,
8155 except that the multitude of options can become overwhelming,
8156 especially if you try to check out too many at once.
8157 It becomes easier if you use existing layouts of \SpecialChar LyX
8158 as examples/reference or if you modify an existing layout to your needs.
8161 \begin_layout Standard
8162 Note that all the tags used in layout files are case-insensitive.
8164 \begin_inset Flex Code
8167 \begin_layout Plain Layout
8175 \begin_inset Flex Code
8178 \begin_layout Plain Layout
8185 \begin_inset Flex Code
8188 \begin_layout Plain Layout
8194 are really the same tag.
8195 The possible arguments are printed in brackets after the tag's name.
8196 The default argument is typeset
8197 \begin_inset Flex Code
8200 \begin_layout Plain Layout
8209 If the argument has a data type like
8210 \begin_inset Quotes eld
8214 \begin_inset Quotes erd
8218 \begin_inset Quotes eld
8222 \begin_inset Quotes erd
8226 the default is shown like this:
8228 \begin_inset Flex Code
8231 \begin_layout Plain Layout
8242 \begin_layout Subsection
8243 The document class declaration and classification
8246 \begin_layout Standard
8247 Lines in a layout file which begin with
8248 \begin_inset Flex Code
8251 \begin_layout Plain Layout
8258 There is one exception to this rule.
8260 \begin_inset Flex Code
8263 \begin_layout Plain Layout
8269 files should begin with lines like:
8272 \begin_layout LyX-Code
8275 #% Do not delete the line below;
8276 configure depends on this
8279 \begin_layout LyX-Code
8284 DeclareLaTeXClass{Article (Standard Class)}
8287 \begin_layout LyX-Code
8292 DeclareCategory{Articles}
8295 \begin_layout Standard
8296 The second and third lines are used when you (re)configure \SpecialChar LyX
8298 The layout file is read by the \SpecialChar LaTeX
8300 \begin_inset Flex Code
8303 \begin_layout Plain Layout
8310 in a special mode where
8311 \begin_inset Flex Code
8314 \begin_layout Plain Layout
8321 The first line is just a \SpecialChar LaTeX
8323 the second one contains the mandatory declaration of the text class and the third line contains the optional classification of the class.
8324 If these lines appear in a file named
8325 \begin_inset Flex Code
8328 \begin_layout Plain Layout
8335 then they define a text class of name
8336 \begin_inset Flex Code
8339 \begin_layout Plain Layout
8345 (the name of the layout file) which uses the \SpecialChar LaTeX
8347 \begin_inset Flex Code
8350 \begin_layout Plain Layout
8356 (the default is to use the same name as the layout).
8358 \begin_inset Quotes eld
8361 Article (Standard Class)
8362 \begin_inset Quotes erd
8365 that appears above is used as a description of the text class in the
8366 \begin_inset Flex Noun
8369 \begin_layout Plain Layout
8370 Document\SpecialChar menuseparator
8378 \begin_inset Quotes eld
8382 \begin_inset Quotes erd
8385 in the example) is also used in the
8386 \begin_inset Flex Noun
8389 \begin_layout Plain Layout
8390 Document\SpecialChar menuseparator
8397 the text classes are grouped by these categories (which are usually genres,
8398 so typical categories are
8399 \begin_inset Quotes eld
8403 \begin_inset Quotes erd
8408 \begin_inset Quotes eld
8412 \begin_inset Quotes erd
8417 \begin_inset Quotes eld
8421 \begin_inset Quotes erd
8426 \begin_inset Quotes eld
8430 \begin_inset Quotes erd
8435 \begin_inset Quotes eld
8439 \begin_inset Quotes erd
8444 \begin_inset Quotes eld
8448 \begin_inset Quotes erd
8452 If no category has been declared,
8453 the class will be put in the
8454 \begin_inset Quotes eld
8458 \begin_inset Quotes erd
8464 \begin_layout Standard
8465 Let's assume that you wrote your own text class that uses the
8466 \begin_inset Flex Code
8469 \begin_layout Plain Layout
8476 but where you changed the appearance of the section headings.
8477 If you put it in a file
8478 \begin_inset Flex Code
8481 \begin_layout Plain Layout
8488 the header of this file should be:
8491 \begin_layout LyX-Code
8494 #% Do not delete the line below;
8495 configure depends on this
8498 \begin_layout LyX-Code
8503 DeclareLaTeXClass[article]{Article (with My Own Headings)}
8506 \begin_layout LyX-Code
8511 DeclareCategory{Articles}
8514 \begin_layout Standard
8515 This declares a text class
8516 \begin_inset Flex Code
8519 \begin_layout Plain Layout
8526 associated with the \SpecialChar LaTeX
8528 \begin_inset Flex Code
8531 \begin_layout Plain Layout
8538 \begin_inset Quotes eld
8541 Article (with My Own Headings)
8542 \begin_inset Quotes erd
8546 If your text class depends on several packages,
8547 you can declare it as:
8550 \begin_layout LyX-Code
8553 #% Do not delete the line below;
8554 configure depends on this
8557 \begin_layout LyX-Code
8562 DeclareLaTeXClass[article,foo.sty]{Article (with My Own Headings)}
8565 \begin_layout LyX-Code
8570 DeclareCategory{Articles}
8573 \begin_layout Standard
8574 This indicates that your text class uses the
8575 \begin_inset Flex Code
8578 \begin_layout Plain Layout
8588 \begin_layout Standard
8589 Note that these declarations can also be given an optional parameter declaring the name of the document class (but not a list).
8592 \begin_layout Standard
8594 to be as explicit as possible,
8595 the form of the layout declaration is:
8598 \begin_layout LyX-Code
8603 DeclareLaTeXClass[class,package.sty]{layout description}
8606 \begin_layout LyX-Code
8611 DeclareCategory{category}
8614 \begin_layout Standard
8615 The class need only be specified if the name of the \SpecialChar LaTeX
8616 class file and the name of the layout file are different or if there are packages to load.
8617 If the name of the class file is not specified,
8618 then \SpecialChar LyX
8619 will simply assume that it is the same as the name of the layout file.
8622 \begin_layout Standard
8623 When the text class has been modified to your taste,
8624 all you have to do is to copy it either to
8625 \begin_inset Flex Code
8628 \begin_layout Plain Layout
8635 \begin_inset Flex Code
8638 \begin_layout Plain Layout
8646 \begin_inset Flex Noun
8649 \begin_layout Plain Layout
8650 Tools\SpecialChar menuseparator
8657 exit \SpecialChar LyX
8659 Then your new text class should be available along with the others.
8662 \begin_layout Standard
8663 Once the layout file is installed,
8664 you can edit it and see your changes without having to reconfigure or to restart \SpecialChar LyX
8669 \begin_layout Plain Layout
8670 In versions of \SpecialChar LyX
8674 editing layout files was very time consuming,
8675 since you had constantly to restart \SpecialChar LyX
8681 You can force a reload of the current layout by using the \SpecialChar LyX
8683 \begin_inset Flex Noun
8686 \begin_layout Plain Layout
8693 There is no default binding for this function—
8696 you can bind it to a key yourself.
8697 But you will normally use this function simply by entering it in the mini-buffer.
8701 \begin_layout Standard
8708 \begin_inset Flex Noun
8711 \begin_layout Plain Layout
8717 is very much an `advanced feature'.
8722 recommended that you save your work before using this function.
8728 recommended that you not attempt to edit layout information while simultaneously working on a document that you care about.
8729 Use a test document.
8730 Syntax errors and the like in your layout file could cause peculiar behavior.
8732 such errors could cause \SpecialChar LyX
8733 to regard the current layout as invalid and to attempt to switch to some other layout.
8737 \begin_layout Plain Layout
8738 Really bad syntax errors may even caused \SpecialChar LyX
8740 This is because certain sorts of errors may make \SpecialChar LyX
8751 The \SpecialChar LyX
8752 team strives to keep \SpecialChar LyX
8753 stable in such situations,
8754 but safe is better than sorry.
8758 \begin_layout Plain Layout
8759 While we're giving advice:
8760 make regular backups.
8761 And be nice to your mother.
8769 \begin_layout Subsection
8770 The Module declaration
8773 \begin_layout Standard
8774 A module must begin with a line like the following:
8777 \begin_layout LyX-Code
8780 DeclareLyXModule[endnotes.sty]{Endnotes}
8783 \begin_layout LyX-Code
8788 DeclareCategory{Foot- and Endnotes}
8791 \begin_layout Standard
8792 The mandatory argument of
8800 is the name of the module,
8801 as it should appear in
8802 \begin_inset Flex Noun
8805 \begin_layout Plain Layout
8806 Document\SpecialChar menuseparator
8807 Settings\SpecialChar menuseparator
8814 The argument in square brackets is optional:
8815 It declares any \SpecialChar LaTeX
8816 packages on which the module depends.
8817 It is also possible to use the form
8818 \begin_inset Flex Noun
8821 \begin_layout Plain Layout
8827 as an optional argument,
8828 which declares that the module can only be used when there exists a conversion chain between the formats `
8829 \begin_inset Flex Code
8832 \begin_layout Plain Layout
8839 \begin_inset Flex Code
8842 \begin_layout Plain Layout
8855 declaration is not strictly mandatory,
8856 but you should add it,
8857 since it is helpful to find the module.
8858 Please have a look at the existing module categories and if appropriate,
8862 \begin_layout Standard
8863 The module and category declaration should then be followed by lines like the following:
8867 \begin_layout Plain Layout
8868 Preferably in English if the module should be published with \SpecialChar LyX
8870 This description will appear in the list of messages to be translated and will be thus translated with the next interface update.
8878 \begin_layout LyX-Code
8882 \begin_layout LyX-Code
8883 #Adds an endnote command,
8884 in addition to footnotes.
8888 \begin_layout LyX-Code
8889 #You will need to add
8891 theendnotes in TeX code where you
8894 \begin_layout LyX-Code
8895 #want the endnotes to appear.
8899 \begin_layout LyX-Code
8903 \begin_layout LyX-Code
8905 somemodule | othermodule
8908 \begin_layout LyX-Code
8913 \begin_layout Standard
8914 The description is used in
8915 \begin_inset Flex Noun
8918 \begin_layout Plain Layout
8919 Document\SpecialChar menuseparator
8920 Settings\SpecialChar menuseparator
8926 to provide the user with information about what the module does.
8928 \begin_inset Flex Code
8931 \begin_layout Plain Layout
8937 line is used to identify other modules with which this one must be used;
8939 \begin_inset Flex Code
8942 \begin_layout Plain Layout
8948 line is used to identify modules with which this one may not be used.
8952 multiple modules should be separated with the pipe symbol:
8954 Note that the required modules are treated disjunctively:
8959 of the required modules must be used.
8965 excluded module may be used.
8966 Note that modules are identified here by their filenames without the
8967 \begin_inset Flex Code
8970 \begin_layout Plain Layout
8978 \begin_inset Flex Code
8981 \begin_layout Plain Layout
8988 \begin_inset Flex Code
8991 \begin_layout Plain Layout
9000 \begin_layout Subsection
9001 The CiteEngine file declaration
9004 \begin_layout Standard
9005 A cite engine file must begin with a line like the following:
9008 \begin_layout LyX-Code
9011 DeclareLyXCiteEngineModule[biblatex.sty]{Biblatex}
9014 \begin_layout Standard
9015 The mandatory argument,
9017 is the name of the cite style,
9018 as it should appear in
9019 \begin_inset Flex Noun
9022 \begin_layout Plain Layout
9023 Document\SpecialChar menuseparator
9024 Settings\SpecialChar menuseparator
9031 The argument in square brackets is optional:
9032 It declares any \SpecialChar LaTeX
9033 packages on which the cite engine depends.
9036 \begin_layout Standard
9037 The cite engine declaration should then be followed by lines like the following:
9041 \begin_layout Plain Layout
9042 Preferably in English if the module should be published with \SpecialChar LyX
9044 This description will appear in the list of messages to be translated and will be thus translated with the next interface update.
9052 \begin_layout LyX-Code
9056 \begin_layout LyX-Code
9057 # Biblatex supports many author-year and numerical styles.
9060 \begin_layout LyX-Code
9061 # It is mainly aimed at the Humanities.
9065 \begin_layout LyX-Code
9067 fully localized and provides many features
9070 \begin_layout LyX-Code
9071 # that are not possible with BibTeX.
9072 The use of 'biber' as
9075 \begin_layout LyX-Code
9076 # bibliography processor is advised.
9079 \begin_layout LyX-Code
9083 \begin_layout Standard
9084 The description is used in
9085 \begin_inset Flex Noun
9088 \begin_layout Plain Layout
9089 Document\SpecialChar menuseparator
9090 Settings\SpecialChar menuseparator
9096 to provide the user with information about the cite engine.
9099 \begin_layout Subsection
9103 \begin_layout Standard
9104 The first non-comment line of any layout file,
9110 contain the file format number:
9113 \begin_layout Description
9114 \begin_inset Flex Code
9117 \begin_layout Plain Layout
9124 \begin_inset Flex Code
9127 \begin_layout Plain Layout
9133 ] The format number of the layout file.
9136 \begin_layout Standard
9137 This tag was introduced with \SpecialChar LyX
9139 \begin_inset space ~
9143 Layout files from older \SpecialChar LyX
9144 versions do not have an explicit file format and are considered to have
9145 \begin_inset Flex Code
9148 \begin_layout Plain Layout
9150 \begin_inset space ~
9159 The format for the present version of \SpecialChar LyX
9161 But each version of \SpecialChar LyX
9162 is capable of reading earlier versions' layout files,
9163 just as they are capable of reading files produced by earlier versions of \SpecialChar LyX
9167 no provision for converting to earlier formats.
9170 \begin_layout Subsection
9171 \begin_inset CommandInset label
9173 name "subsec:General-text-class"
9177 General text class parameters
9180 \begin_layout Standard
9181 These are general parameters that govern the behavior of an entire document class.
9186 mean that they must appear in
9187 \begin_inset Flex Code
9190 \begin_layout Plain Layout
9196 files rather than in modules.
9197 A module can contain any layout tag.)
9200 \begin_layout Description
9201 \begin_inset Flex Code
9204 \begin_layout Plain Layout
9205 AddToCiteEngine <engine>
9210 Extends the possibilities for displaying citation references.
9212 \begin_inset CommandInset ref
9214 reference "subsec:Citation-engine-description"
9224 \begin_inset Flex Code
9227 \begin_layout Plain Layout
9236 \begin_layout Description
9237 \begin_inset Flex Code
9240 \begin_layout Plain Layout
9246 Adds information that will be output in the
9247 \begin_inset Flex Code
9250 \begin_layout Plain Layout
9256 block when the document is output to XHTML.
9258 this would be used to output CSS style information,
9259 but it can be used for anything that can appear in
9260 \begin_inset Flex Code
9263 \begin_layout Plain Layout
9271 \begin_inset Quotes eld
9275 \begin_inset Flex Code
9278 \begin_layout Plain Layout
9285 \begin_inset Quotes erd
9291 \begin_layout Description
9292 \begin_inset Flex Code
9295 \begin_layout Plain Layout
9301 Adds information to the document preamble.
9303 \begin_inset Newline newline
9307 \begin_inset Quotes eld
9311 \begin_inset Flex Code
9314 \begin_layout Plain Layout
9321 \begin_inset Quotes erd
9327 \begin_layout Description
9328 \begin_inset Flex Code
9331 \begin_layout Plain Layout
9338 \begin_inset Flex Code
9341 \begin_layout Plain Layout
9350 \begin_inset space \thinspace{}
9354 \begin_inset Flex Code
9357 \begin_layout Plain Layout
9363 ] If the document class adds the bibliography to the table of contents,
9364 add this option with value
9365 \begin_inset Flex Code
9368 \begin_layout Plain Layout
9375 \begin_inset Flex Code
9378 \begin_layout Plain Layout
9385 This prevents the bibliography from being added twice.
9388 \begin_layout Description
9389 \begin_inset Flex Code
9392 \begin_layout Plain Layout
9398 Defines the possibilities for displaying citation references.
9400 \begin_inset CommandInset ref
9402 reference "subsec:Citation-engine-description"
9412 \begin_inset Quotes eld
9416 \begin_inset Flex Code
9419 \begin_layout Plain Layout
9426 \begin_inset Quotes erd
9430 Primarily used in cite engine files (see
9431 \begin_inset CommandInset ref
9433 reference "subsec:Cite-Engine-Files"
9442 Note that if you specify this in a layout file or module,
9443 any cite engine definition will be overridden.
9445 \begin_inset Flex Code
9448 \begin_layout Plain Layout
9457 \begin_layout Description
9458 \begin_inset Flex Code
9461 \begin_layout Plain Layout
9467 Defines formats for use in the display of bibliographic information.
9469 \begin_inset CommandInset ref
9471 reference "subsec:Citation-format-description"
9478 \begin_inset Quotes eld
9482 \begin_inset Flex Code
9485 \begin_layout Plain Layout
9492 \begin_inset Quotes erd
9496 Primarily used in cite engine files (see
9497 \begin_inset CommandInset ref
9499 reference "subsec:Cite-Engine-Files"
9508 A cite format defined in a layout or module will override the cite engine definition.
9511 \begin_layout Description
9512 \begin_inset Flex Code
9515 \begin_layout Plain Layout
9522 \begin_inset Flex Code
9525 \begin_layout Plain Layout
9534 \begin_inset Flex Code
9537 \begin_layout Plain Layout
9543 ] Determines whether
9547 or Bib\SpecialChar TeX
9548 is used to generate a Bibliography.
9549 Primarily used in cite engine files (see
9550 \begin_inset CommandInset ref
9552 reference "subsec:Cite-Engine-Files"
9563 \begin_layout Description
9564 \begin_inset Flex Code
9567 \begin_layout Plain Layout
9573 Describes various global options supported by the document class.
9575 \begin_inset CommandInset ref
9577 reference "subsec:ClassOptions"
9584 \begin_inset Quotes eld
9588 \begin_inset Flex Code
9591 \begin_layout Plain Layout
9598 \begin_inset Quotes erd
9604 \begin_layout Description
9605 \begin_inset Flex Code
9608 \begin_layout Plain Layout
9615 \begin_inset Flex Code
9618 \begin_layout Plain Layout
9627 \begin_inset space \thinspace{}
9631 \begin_inset Flex Code
9634 \begin_layout Plain Layout
9640 ] Whether the class should
9644 to having one or two columns.
9645 Can be changed in the
9646 \begin_inset Flex Noun
9649 \begin_layout Plain Layout
9650 Document\SpecialChar menuseparator
9659 \begin_layout Description
9660 \begin_inset Flex Code
9663 \begin_layout Plain Layout
9670 \begin_inset Flex Code
9673 \begin_layout Plain Layout
9679 ] This sequence defines the properties for a counter.
9680 If the counter does not yet exist,
9685 \begin_inset Quotes eld
9689 \begin_inset Flex Code
9692 \begin_layout Plain Layout
9699 \begin_inset Quotes erd
9703 \begin_inset Newline newline
9707 \begin_inset CommandInset ref
9709 reference "subsec:Counters"
9714 for details on counters.
9717 \begin_layout Description
9718 \begin_inset Flex Code
9721 \begin_layout Plain Layout
9727 Sets the default font used to display the document.
9729 \begin_inset CommandInset ref
9731 reference "subsec:Font-description"
9736 for how to declare fonts.
9738 \begin_inset Quotes eld
9742 \begin_inset Flex Code
9745 \begin_layout Plain Layout
9752 \begin_inset Quotes erd
9758 \begin_layout Description
9759 \begin_inset Flex Code
9762 \begin_layout Plain Layout
9769 \begin_inset Flex Code
9772 \begin_layout Plain Layout
9778 ] Specifies a module to be included by default with this document class.
9779 The module is specified as filename without the
9780 \begin_inset Flex Code
9783 \begin_layout Plain Layout
9790 The user can still remove the module,
9791 but it will be active at the outset.
9792 (This applies only when new files are created,
9793 or when this class is chosen for an existing document.)
9796 \begin_layout Description
9797 \begin_inset Flex Code
9800 \begin_layout Plain Layout
9807 \begin_inset Flex Code
9810 \begin_layout Plain Layout
9816 ] This is the style that will be assigned to new paragraphs,
9818 \begin_inset Flex Noun
9821 \begin_layout Plain Layout
9828 This will default to the first defined style if not given,
9829 but you are encouraged to use this directive.
9832 \begin_layout Description
9833 \begin_inset Flex Code
9836 \begin_layout Plain Layout
9843 \begin_inset Flex Code
9846 \begin_layout Plain Layout
9852 ] The root element (at the top of the document) to use when outputting documents with this class in DocBook.
9853 The default value is
9854 \begin_inset Quotes eld
9858 \begin_inset Flex Code
9861 \begin_layout Plain Layout
9868 \begin_inset Quotes erd
9874 \begin_layout Description
9875 \begin_inset Flex Code
9878 \begin_layout Plain Layout
9879 DocBookForceAbstract
9885 \begin_inset Flex Code
9888 \begin_layout Plain Layout
9895 \begin_inset Quotes eld
9903 \begin_inset Quotes erd
9907 the root element will always have an
9912 The default value is
9913 \begin_inset Quotes eld
9921 \begin_inset Quotes erd
9927 \begin_layout Description
9928 \begin_inset Flex Code
9931 \begin_layout Plain Layout
9938 \begin_inset Flex Code
9941 \begin_layout Plain Layout
9947 ] This tag indicates that the module (which is specified by filename without the
9948 \begin_inset Flex Code
9951 \begin_layout Plain Layout
9957 extension) cannot be used with this document class.
9958 This might be used in a journal-specific layout file to prevent,
9961 \begin_inset Flex Code
9964 \begin_layout Plain Layout
9970 module that numbers theorems by section.
9975 be used in a module.
9976 Modules have their own way of excluding other modules (see
9977 \begin_inset CommandInset ref
9979 reference "subsec:Layout-modules"
9987 \begin_layout Description
9988 \begin_inset Flex Code
9991 \begin_layout Plain Layout
9997 Defines a new float.
9999 \begin_inset CommandInset ref
10001 reference "subsec:Floats"
10008 \begin_inset Quotes eld
10012 \begin_inset Flex Code
10015 \begin_layout Plain Layout
10022 \begin_inset Quotes erd
10028 \begin_layout Description
10029 \begin_inset Flex Code
10032 \begin_layout Plain Layout
10038 Sets the information that will be output in the
10039 \begin_inset Flex Code
10042 \begin_layout Plain Layout
10048 block when this document class is output to XHTML.
10049 Note that this will completely override any prior
10050 \begin_inset Flex Code
10053 \begin_layout Plain Layout
10060 \begin_inset Flex Code
10063 \begin_layout Plain Layout
10071 \begin_inset Newline newline
10075 \begin_inset Flex Code
10078 \begin_layout Plain Layout
10084 if you just want to add material to the preamble.) Must end with
10085 \begin_inset Quotes eld
10089 \begin_inset Flex Code
10092 \begin_layout Plain Layout
10099 \begin_inset Quotes erd
10105 \begin_layout Description
10106 \begin_inset Flex Code
10109 \begin_layout Plain Layout
10116 \begin_inset Flex Code
10119 \begin_layout Plain Layout
10125 ] The style to use for the table of contents,
10128 when the document is output to HTML.
10130 this should normally be
10131 \begin_inset Flex Code
10134 \begin_layout Plain Layout
10142 \begin_inset Flex Code
10145 \begin_layout Plain Layout
10152 If it is not given,
10153 then \SpecialChar LyX
10154 will attempt to figure out which layout to use.
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 ] Modifies the properties of the given counter.
10178 If the counter does not exist,
10179 the statement is ignored.
10181 \begin_inset Quotes eld
10185 \begin_inset Flex Code
10188 \begin_layout Plain Layout
10195 \begin_inset Quotes erd
10199 \begin_inset Newline newline
10203 \begin_inset CommandInset ref
10205 reference "subsec:Counters"
10210 for details on counters.
10213 \begin_layout Description
10214 \begin_inset Flex Code
10217 \begin_layout Plain Layout
10224 \begin_inset Flex Code
10227 \begin_layout Plain Layout
10233 ] This allows you to include another layout definition file within yours to avoid duplicating commands.
10234 Common examples are the standard layout files,
10237 \begin_inset Flex Code
10240 \begin_layout Plain Layout
10247 which contains most of the basic layouts.
10250 \begin_layout Description
10251 \begin_inset Flex Code
10254 \begin_layout Plain Layout
10261 \begin_inset Flex Code
10264 \begin_layout Plain Layout
10270 ] is a variant of the
10271 \begin_inset Flex Code
10274 \begin_layout Plain Layout
10280 command which does not look for files in the user directory.
10281 This allows to create a file
10282 \begin_inset Flex Code
10285 \begin_layout Plain Layout
10292 \begin_inset Flex Code
10295 \begin_layout Plain Layout
10301 in the user directory which includes a global file with the same name via
10302 \begin_inset Flex Code
10305 \begin_layout Plain Layout
10312 \begin_inset Flex Code
10315 \begin_layout Plain Layout
10316 InputGlobal name.inc
10323 \begin_inset Flex Code
10326 \begin_layout Plain Layout
10333 the file would recursively include itself).
10335 you can modify global files without having to completely copy them.
10338 \begin_layout Description
10339 \begin_inset Flex Code
10342 \begin_layout Plain Layout
10349 \begin_inset Flex Code
10352 \begin_layout Plain Layout
10358 ] This section (re-)defines the layout of an inset.
10359 It can be applied to an existing inset or to a new,
10360 user-defined inset,
10362 a new character style.
10364 \begin_inset Quotes eld
10368 \begin_inset Flex Code
10371 \begin_layout Plain Layout
10378 \begin_inset Quotes erd
10382 \begin_inset Newline newline
10386 \begin_inset CommandInset ref
10388 reference "subsec:Flex-insets-and"
10393 for more information.
10397 \begin_layout Description
10398 \begin_inset Flex Code
10401 \begin_layout Plain Layout
10408 \begin_inset Flex Code
10411 \begin_layout Plain Layout
10417 ] A string that indicates the width of the left margin on the screen,
10420 \begin_inset Quotes eld
10424 \begin_inset Flex Code
10427 \begin_layout Plain Layout
10434 \begin_inset Quotes erd
10438 (Note that this is not a `length',
10440 \begin_inset Quotes eld
10444 \begin_inset Quotes erd
10450 \begin_layout Description
10451 \begin_inset Flex Code
10454 \begin_layout Plain Layout
10461 \begin_inset Flex Code
10464 \begin_layout Plain Layout
10470 ] An integer that determines the maximal number of names displayed in an author-year citation before the citation switches to
10471 \begin_inset Quotes eld
10475 \begin_inset Quotes erd
10479 Primarily used in cite engine files (see
10480 \begin_inset CommandInset ref
10482 reference "subsec:Cite-Engine-Files"
10493 \begin_layout Description
10494 \begin_inset Flex Code
10497 \begin_layout Plain Layout
10504 \begin_inset Flex Code
10507 \begin_layout Plain Layout
10513 ] Modifies the layout of an inset.
10514 If the layout does not exist,
10515 this section is ignored.
10517 \begin_inset Quotes eld
10521 \begin_inset Flex Code
10524 \begin_layout Plain Layout
10531 \begin_inset Quotes erd
10537 \begin_layout Description
10538 \begin_inset Flex Code
10541 \begin_layout Plain Layout
10548 \begin_inset Flex Code
10551 \begin_layout Plain Layout
10557 ] Modifies the properties of the given paragraph style.
10558 If the style does not exist,
10559 this section is ignored.
10561 \begin_inset Quotes eld
10565 \begin_inset Flex Code
10568 \begin_layout Plain Layout
10575 \begin_inset Quotes erd
10581 \begin_layout Description
10582 \begin_inset Flex Code
10585 \begin_layout Plain Layout
10592 \begin_inset Flex Code
10595 \begin_layout Plain Layout
10601 ] Deletes an existing counter,
10602 usually one defined in an included file.
10605 \begin_layout Description
10606 \begin_inset Flex Code
10609 \begin_layout Plain Layout
10616 \begin_inset Flex Code
10619 \begin_layout Plain Layout
10625 ] Deletes an existing float.
10626 This is particularly useful when you want to suppress a float that has been defined in an input file.
10629 \begin_layout Description
10630 \begin_inset Flex Code
10633 \begin_layout Plain Layout
10640 \begin_inset Flex Code
10643 \begin_layout Plain Layout
10649 ] Deletes an existing style.
10652 \begin_layout Description
10653 \begin_inset Flex Code
10656 \begin_layout Plain Layout
10663 \begin_inset Flex Code
10666 \begin_layout Plain Layout
10673 \begin_inset Flex Code
10676 \begin_layout Plain Layout
10682 ] Define a new table of contents with type
10683 \begin_inset Flex Code
10686 \begin_layout Plain Layout
10693 \begin_inset Flex Code
10696 \begin_layout Plain Layout
10703 See also the AddToToc commands.
10706 \begin_layout Description
10707 \begin_inset Flex Code
10710 \begin_layout Plain Layout
10717 \begin_inset Flex Code
10720 \begin_layout Plain Layout
10726 ] The file format (as defined in the \SpecialChar LyX
10727 preferences) produced by this document class.
10728 It is mainly useful when
10729 \begin_inset Flex Code
10732 \begin_layout Plain Layout
10739 \begin_inset Flex Code
10742 \begin_layout Plain Layout
10748 and one wants to define a new type of literate document.
10749 The format is reset to
10750 \begin_inset Quotes eld
10754 \begin_inset Flex Code
10757 \begin_layout Plain Layout
10764 \begin_inset Quotes erd
10767 when the corresponding
10768 \begin_inset Flex Code
10771 \begin_layout Plain Layout
10777 parameter is encountered.
10780 \begin_layout Description
10781 \begin_inset Flex Code
10784 \begin_layout Plain Layout
10791 \begin_inset Flex Code
10794 \begin_layout Plain Layout
10806 \begin_inset Flex Code
10809 \begin_layout Plain Layout
10815 ] Specifies what sort of output documents using this class will produce.
10818 \begin_layout Description
10819 \begin_inset Flex Code
10822 \begin_layout Plain Layout
10829 \begin_inset Flex Code
10832 \begin_layout Plain Layout
10839 \begin_inset Flex Code
10842 \begin_layout Plain Layout
10848 ] Specifies options,
10849 given in the second string,
10850 for the package named by the first string.
10853 \begin_inset Quotes eld
10857 \begin_inset Flex Code
10860 \begin_layout Plain Layout
10861 PackageOptions natbib square
10867 \begin_inset Quotes erd
10871 \begin_inset Flex Code
10874 \begin_layout Plain Layout
10880 to be loaded with the
10881 \begin_inset Flex Code
10884 \begin_layout Plain Layout
10891 (For \SpecialChar TeX
10893 this causes \SpecialChar LyX
10896 \begin_inset Flex Code
10899 \begin_layout Plain Layout
10902 PassOptionsToPackage{natbib}{square}
10908 \begin_inset Flex Code
10911 \begin_layout Plain Layout
10920 \begin_layout Description
10921 \begin_inset Flex Code
10924 \begin_layout Plain Layout
10931 \begin_inset Flex Code
10934 \begin_layout Plain Layout
10975 ] The default page size.
10976 This is used by some converters.
10979 \begin_layout Description
10980 \begin_inset Flex Code
10983 \begin_layout Plain Layout
10990 \begin_inset Flex Code
10993 \begin_layout Plain Layout
11003 \begin_inset Flex Code
11006 \begin_layout Plain Layout
11014 \begin_inset Flex Code
11017 \begin_layout Plain Layout
11023 ] The default pagestyle.
11024 Can be changed in the
11025 \begin_inset Flex Noun
11028 \begin_layout Plain Layout
11029 Document\SpecialChar menuseparator
11038 \begin_layout Description
11039 \begin_inset Flex Code
11042 \begin_layout Plain Layout
11048 Sets the preamble for the \SpecialChar LaTeX
11050 Note that this will completely override any prior
11051 \begin_inset Flex Code
11054 \begin_layout Plain Layout
11061 \begin_inset Flex Code
11064 \begin_layout Plain Layout
11072 \begin_inset Flex Code
11075 \begin_layout Plain Layout
11081 if you just want to add material to the preamble.) Must end with
11082 \begin_inset Quotes eld
11086 \begin_inset Flex Code
11089 \begin_layout Plain Layout
11096 \begin_inset Quotes erd
11102 \begin_layout Description
11103 \begin_inset Flex Code
11106 \begin_layout Plain Layout
11113 \begin_inset Flex Code
11116 \begin_layout Plain Layout
11122 ] Defines the layout of an inset if it does not already exist.
11123 If the layout does exist,
11124 this section is ignored.
11126 \begin_inset Quotes eld
11130 \begin_inset Flex Code
11133 \begin_layout Plain Layout
11140 \begin_inset Quotes erd
11146 \begin_layout Description
11147 \begin_inset Flex Code
11150 \begin_layout Plain Layout
11157 \begin_inset Flex Code
11160 \begin_layout Plain Layout
11167 \begin_inset Flex Code
11170 \begin_layout Plain Layout
11179 \begin_inset space \thinspace{}
11183 \begin_inset Flex Code
11186 \begin_layout Plain Layout
11192 ] Whether the class already provides the feature
11193 \begin_inset Flex Code
11196 \begin_layout Plain Layout
11203 A feature is in general the name of a package (e.
11204 \begin_inset space \thinspace{}
11208 \begin_inset space \space{}
11212 \begin_inset Flex Code
11215 \begin_layout Plain Layout
11222 \begin_inset Flex Code
11225 \begin_layout Plain Layout
11232 \begin_inset space \thinspace{}
11236 \begin_inset space \space{}
11240 \begin_inset Flex Code
11243 \begin_layout Plain Layout
11250 \begin_inset Flex Code
11253 \begin_layout Plain Layout
11261 \begin_inset CommandInset ref
11263 reference "chap:List-of-functions"
11268 for the list of features.
11271 \begin_layout Description
11272 \begin_inset Flex Code
11275 \begin_layout Plain Layout
11282 \begin_inset Flex Code
11285 \begin_layout Plain Layout
11291 ] Indicates that this layout provides the functionality of the module mentioned,
11292 which should be specified by the filename without the
11293 \begin_inset Flex Code
11296 \begin_layout Plain Layout
11303 This will typically be used if the layout includes the module directly,
11304 rather than using the
11305 \begin_inset Flex Code
11308 \begin_layout Plain Layout
11314 tag to indicate that it ought to be used.
11315 It could also be used in a module that provided an alternate implementation of the same functionality.
11318 \begin_layout Description
11319 \begin_inset Flex Code
11322 \begin_layout Plain Layout
11329 \begin_inset Flex Code
11332 \begin_layout Plain Layout
11338 ] Creates a new paragraph style if it does not already exist.
11339 If the style does exist,
11340 this section is ignored.
11342 \begin_inset Quotes eld
11346 \begin_inset Flex Code
11349 \begin_layout Plain Layout
11356 \begin_inset Quotes erd
11362 \begin_layout Description
11363 \begin_inset Flex Code
11366 \begin_layout Plain Layout
11373 \begin_inset Flex Code
11376 \begin_layout Plain Layout
11382 ] Whether the class requires the feature
11383 \begin_inset Flex Code
11386 \begin_layout Plain Layout
11393 Multiple features must be separated by commas.
11394 Note that you can only request supported features.
11396 \begin_inset CommandInset ref
11398 reference "chap:List-of-functions"
11403 for the list of features.).
11404 If you require a package with specific options,
11405 you can additionally use
11406 \begin_inset Flex Code
11409 \begin_layout Plain Layout
11418 \begin_layout Description
11419 \begin_inset Flex Code
11422 \begin_layout Plain Layout
11429 \begin_inset Flex Code
11432 \begin_layout Plain Layout
11438 ] A string that indicates the width of the right margin on the screen,
11441 \begin_inset Quotes eld
11445 \begin_inset Flex Code
11448 \begin_layout Plain Layout
11455 \begin_inset Quotes erd
11461 \begin_layout Description
11462 \begin_inset Flex Code
11465 \begin_layout Plain Layout
11472 \begin_inset Flex Code
11475 \begin_layout Plain Layout
11481 ] Sets which divisions get numbered.
11483 \begin_inset Newline newline
11487 \begin_inset Flex Code
11490 \begin_layout Plain Layout
11496 counter in \SpecialChar LaTeX
11500 \begin_layout Description
11501 \begin_inset Flex Code
11504 \begin_layout Plain Layout
11511 \begin_inset Flex Code
11514 \begin_layout Plain Layout
11523 \begin_inset space \thinspace{}
11527 \begin_inset Flex Code
11530 \begin_layout Plain Layout
11536 ] Whether the class-default should be printing on one or both sides of the paper.
11537 Can be changed in the
11538 \begin_inset Flex Noun
11541 \begin_layout Plain Layout
11542 Document\SpecialChar menuseparator
11551 \begin_layout Description
11552 \begin_inset Flex Code
11555 \begin_layout Plain Layout
11562 \begin_inset Flex Code
11565 \begin_layout Plain Layout
11571 ] This sequence defines a paragraph style.
11572 If the style does not yet exist,
11575 its parameters are modified.
11577 \begin_inset Quotes eld
11581 \begin_inset Flex Code
11584 \begin_layout Plain Layout
11591 \begin_inset Quotes erd
11595 \begin_inset Newline newline
11599 \begin_inset CommandInset ref
11601 reference "subsec:Paragraph-Styles"
11606 for details on paragraph styles.
11609 \begin_layout Description
11610 \begin_inset Flex Code
11613 \begin_layout Plain Layout
11620 \begin_inset Flex Code
11623 \begin_layout Plain Layout
11629 ] defines the default table style that is used when inserting a table.
11630 The following styles are available:
11634 \begin_layout Itemize
11635 \begin_inset Flex Code
11638 \begin_layout Plain Layout
11639 Formal_with_Footline
11646 \begin_inset Quotes eld
11650 \begin_inset Quotes erd
11653 ) style with horizontal lines only,
11654 using a bold top and bottom line,
11655 the first and last row are additionally separated from the table body with a thin middle line.
11658 \begin_layout Itemize
11659 \begin_inset Flex Code
11662 \begin_layout Plain Layout
11663 Formal_without_Footline
11670 but the last row is not separated with a middle line from the body.
11673 \begin_layout Itemize
11674 \begin_inset Flex Code
11677 \begin_layout Plain Layout
11684 Simple table lines.
11687 \begin_layout Itemize
11688 \begin_inset Flex Code
11691 \begin_layout Plain Layout
11699 \begin_inset Flex Code
11702 \begin_layout Plain Layout
11709 but with the header row offset with a second horizontal line.
11710 This is also the default style of \SpecialChar LyX
11714 \begin_layout Itemize
11715 \begin_inset Flex Code
11718 \begin_layout Plain Layout
11725 Table without lines.
11729 \begin_layout Description
11730 \begin_inset Flex Code
11733 \begin_layout Plain Layout
11740 \begin_inset Flex Code
11743 \begin_layout Plain Layout
11749 ] The name of the command or environment to be used with
11750 \begin_inset Flex Code
11753 \begin_layout Plain Layout
11762 \begin_layout Description
11763 \begin_inset Flex Code
11766 \begin_layout Plain Layout
11773 \begin_inset Flex Code
11776 \begin_layout Plain Layout
11786 \begin_inset Flex Code
11789 \begin_layout Plain Layout
11795 ] Indicates what kind of markup is used to define the title of a document.
11797 \begin_inset Flex Code
11800 \begin_layout Plain Layout
11806 means that the macro with name
11807 \begin_inset Flex Code
11810 \begin_layout Plain Layout
11816 will be inserted after the last layout which has
11817 \begin_inset Quotes eld
11821 \begin_inset Flex Code
11824 \begin_layout Plain Layout
11826 \begin_inset space ~
11835 \begin_inset Quotes erd
11840 \begin_inset Flex Code
11843 \begin_layout Plain Layout
11849 corresponds to the case where all layouts which have
11850 \begin_inset Quotes eld
11854 \begin_inset Flex Code
11857 \begin_layout Plain Layout
11859 \begin_inset space ~
11868 \begin_inset Quotes erd
11871 should be enclosed into the
11872 \begin_inset Flex Code
11875 \begin_layout Plain Layout
11884 \begin_layout Description
11885 \begin_inset Flex Code
11888 \begin_layout Plain Layout
11895 \begin_inset Flex Code
11898 \begin_layout Plain Layout
11904 ] Sets which divisions are included in the table of contents.
11906 \begin_inset Flex Code
11909 \begin_layout Plain Layout
11915 counter in \SpecialChar LaTeX
11919 \begin_layout Subsection
11920 \begin_inset Flex Code
11923 \begin_layout Plain Layout
11930 \begin_inset CommandInset label
11932 name "subsec:ClassOptions"
11939 \begin_layout Standard
11941 \begin_inset Flex Code
11944 \begin_layout Plain Layout
11950 section can contain the following entries:
11953 \begin_layout Description
11954 \begin_inset Flex Code
11957 \begin_layout Plain Layout
11964 \begin_inset Flex Code
11967 \begin_layout Plain Layout
11973 ] The list of available font sizes for the document's main font,
11975 \begin_inset Quotes eld
11979 \begin_inset Flex Code
11982 \begin_layout Plain Layout
11989 \begin_inset Quotes erd
11993 Any number is possible.
11996 \begin_layout Description
11997 \begin_inset Flex Code
12000 \begin_layout Plain Layout
12007 \begin_inset Flex Code
12010 \begin_layout Plain Layout
12016 ] The format for the font size option.
12019 \begin_inset Flex Code
12022 \begin_layout Plain Layout
12030 \begin_inset Flex Code
12033 \begin_layout Plain Layout
12039 is a placeholder for the font size.
12042 \begin_layout Description
12043 \begin_inset Flex Code
12046 \begin_layout Plain Layout
12053 \begin_inset Flex Code
12056 \begin_layout Plain Layout
12057 string="letter|\SpecialChar allowbreak
12058 legal|\SpecialChar allowbreak
12059 executive|\SpecialChar allowbreak
12060 a0|\SpecialChar allowbreak
12061 a1|\SpecialChar allowbreak
12062 a2|\SpecialChar allowbreak
12063 a3|\SpecialChar allowbreak
12064 a4|\SpecialChar allowbreak
12065 a5|\SpecialChar allowbreak
12066 a6|\SpecialChar allowbreak
12067 b0|\SpecialChar allowbreak
12068 b1|\SpecialChar allowbreak
12069 b2|\SpecialChar allowbreak
12070 b3|\SpecialChar allowbreak
12071 b4|\SpecialChar allowbreak
12072 b5|\SpecialChar allowbreak
12073 b6|\SpecialChar allowbreak
12074 c0|\SpecialChar allowbreak
12075 c1|\SpecialChar allowbreak
12076 c2|\SpecialChar allowbreak
12077 c3|\SpecialChar allowbreak
12078 c4|\SpecialChar allowbreak
12079 c5|\SpecialChar allowbreak
12080 c6|\SpecialChar allowbreak
12081 b0j|\SpecialChar allowbreak
12082 b1j|\SpecialChar allowbreak
12083 b2j|\SpecialChar allowbreak
12084 b3j|\SpecialChar allowbreak
12085 b4j|\SpecialChar allowbreak
12086 b5j|\SpecialChar allowbreak
12092 ] The list of available page sizes,
12094 \begin_inset Quotes eld
12098 \begin_inset Flex Code
12101 \begin_layout Plain Layout
12108 \begin_inset Quotes erd
12113 only the listed sizes are supported.
12114 Other sizes might be entered as custom class option.
12117 \begin_layout Description
12118 \begin_inset Flex Code
12121 \begin_layout Plain Layout
12128 \begin_inset Flex Code
12131 \begin_layout Plain Layout
12137 ] The format for the page size option.
12140 \begin_inset Flex Code
12143 \begin_layout Plain Layout
12151 \begin_inset Flex Code
12154 \begin_layout Plain Layout
12160 is a placeholder for the paper size.
12163 \begin_layout Description
12164 \begin_inset Flex Code
12167 \begin_layout Plain Layout
12174 \begin_inset Flex Code
12177 \begin_layout Plain Layout
12178 string="empty|plain|headings|fancy"
12183 ] The list of available page sty\SpecialChar softhyphen
12186 \begin_inset Quotes eld
12190 \begin_inset Flex Code
12193 \begin_layout Plain Layout
12200 \begin_inset Quotes erd
12204 \change_inserted -712698321 1717320820
12208 \begin_layout Description
12210 \change_inserted -712698321 1717321090
12211 \begin_inset Flex Code
12214 \begin_layout Plain Layout
12216 \change_inserted -712698321 1717320831
12223 \begin_inset Flex Code
12226 \begin_layout Plain Layout
12228 \change_inserted -712698321 1717320820
12234 ] If the class has an option to set a full line paragraph skip,
12235 specify it here (e.g.,
12237 \begin_inset Flex Code
12240 \begin_layout Plain Layout
12242 \change_inserted -712698321 1717320884
12251 This then outputs the option rather than using the
12258 \begin_layout Description
12260 \change_inserted -712698321 1717321094
12261 \begin_inset Flex Code
12264 \begin_layout Plain Layout
12266 \change_inserted -712698321 1717320913
12273 \begin_inset Flex Code
12276 \begin_layout Plain Layout
12278 \change_inserted -712698321 1717320909
12284 ] If the class has an option to set a half line paragraph skip,
12285 specify it here (e.g.,
12287 \begin_inset Flex Code
12290 \begin_layout Plain Layout
12292 \change_inserted -712698321 1717320920
12299 This then outputs the option rather than using the
12308 \begin_layout Description
12309 \begin_inset Flex Code
12312 \begin_layout Plain Layout
12319 \begin_inset Flex Code
12322 \begin_layout Plain Layout
12328 ] Some document class options,
12329 separated by a comma,
12330 that will be added to the optional part of the
12331 \begin_inset Flex Code
12334 \begin_layout Plain Layout
12345 \begin_layout Standard
12347 \begin_inset Flex Code
12350 \begin_layout Plain Layout
12356 section must end with
12357 \begin_inset Quotes eld
12361 \begin_inset Flex Code
12364 \begin_layout Plain Layout
12371 \begin_inset Quotes erd
12377 \begin_layout Subsection
12379 \begin_inset CommandInset label
12381 name "subsec:Paragraph-Styles"
12388 \begin_layout Standard
12389 A paragraph style description looks like this:
12393 \begin_layout Plain Layout
12394 Note that this will either define a new style or modify an existing one.
12402 \begin_layout LyX-Code
12409 \begin_layout LyX-Code
12413 \begin_layout LyX-Code
12417 \begin_layout Standard
12418 where the following commands are allowed:
12421 \begin_layout Description
12422 \begin_inset Flex Code
12425 \begin_layout Plain Layout
12432 \begin_inset Flex Code
12435 \begin_layout Plain Layout
12441 =""] This paragraph will appear in the table of contents of the given type.
12442 An empty string disables.
12443 See also the OutlinerName and the IsTocCaption commands.
12448 \begin_layout Description
12449 \begin_inset Flex Code
12452 \begin_layout Plain Layout
12459 \begin_inset Flex Code
12462 \begin_layout Plain Layout
12475 ] Paragraph alignment.
12478 \begin_layout Description
12479 \begin_inset Flex Code
12482 \begin_layout Plain Layout
12489 \begin_inset Flex Code
12492 \begin_layout Plain Layout
12505 ] A comma separated list of permitted alignments.
12506 (Some \SpecialChar LaTeX
12507 styles prohibit certain alignments,
12508 since those wouldn't make sense.
12509 For example a right-aligned or centered enumeration isn't possible.)
12512 \begin_layout Description
12513 \begin_inset Flex Code
12516 \begin_layout Plain Layout
12523 \begin_inset Flex Code
12526 \begin_layout Plain Layout
12532 ] Defines argument number <int> of a command\SpecialChar breakableslash
12533 environment associated with the current style.
12534 The definition must end with
12535 \begin_inset Flex Code
12538 \begin_layout Plain Layout
12546 \begin_inset CommandInset ref
12548 reference "subsec:Arguments"
12556 for more information.
12560 \begin_layout Description
12561 \begin_inset Flex Code
12564 \begin_layout Plain Layout
12570 Includes a comma-separated list of layouts that should be nested in and after the current layout.
12571 Only makes sense for nestable layouts (such as environments).
12573 \begin_inset Quotes eld
12577 \begin_inset Flex Code
12580 \begin_layout Plain Layout
12587 \begin_inset Quotes erd
12592 \begin_inset Flex Code
12595 \begin_layout Plain Layout
12604 \begin_layout Description
12605 \begin_inset Flex Code
12608 \begin_layout Plain Layout
12614 Note that this will completely override any prior
12615 \begin_inset Flex Code
12618 \begin_layout Plain Layout
12624 declaration for this style.
12626 \begin_inset Quotes eld
12630 \begin_inset Flex Code
12633 \begin_layout Plain Layout
12640 \begin_inset Quotes erd
12645 \begin_inset CommandInset ref
12647 reference "subsec:I18n"
12652 for details on its use.
12655 \begin_layout Description
12656 \begin_inset Flex Code
12659 \begin_layout Plain Layout
12666 \begin_inset Flex Code
12669 \begin_layout Plain Layout
12679 \begin_layout Plain Layout
12680 Note that a `float' here is a real number,
12687 The vertical space with which the last of a chain of paragraphs with this style is separated from the following paragraph.
12688 If the next paragraph has another style,
12689 the separations are not simply added,
12690 but the maximum is taken.
12693 \begin_layout Description
12694 \begin_inset Flex Code
12697 \begin_layout Plain Layout
12704 \begin_inset Flex Code
12707 \begin_layout Plain Layout
12713 ] The category for this style.
12714 This is used to group related styles in the style combobox on the toolbar.
12715 Any string can be used,
12716 but you may want to use existing categories with your own styles.
12720 \begin_layout Description
12721 \begin_inset Flex Code
12724 \begin_layout Plain Layout
12731 \begin_inset Flex Code
12734 \begin_layout Plain Layout
12740 ] Copies all the features of an existing style into the current one.
12741 Note that this copies the style as it is defined at that point.
12742 Later changes to it will not affect styles into which it has been copied.
12745 \begin_layout Description
12746 \begin_inset Flex Code
12749 \begin_layout Plain Layout
12756 \begin_inset Flex Code
12759 \begin_layout Plain Layout
12765 ] The name of a style whose preamble should be output
12770 This allows to ensure some ordering of the preamble snippets when macros definitions depend on one another.
12774 \begin_layout Plain Layout
12776 besides that functionality,
12777 there is no way to ensure any ordering of preambles.
12778 The ordering that you see in a given version of \SpecialChar LyX
12779 may change without warning in later versions.
12787 \begin_layout Description
12788 \begin_inset Flex Code
12791 \begin_layout Plain Layout
12792 DocBookGenerateTitle
12798 \begin_inset Flex Code
12801 \begin_layout Plain Layout
12808 \begin_inset Flex Code
12811 \begin_layout Plain Layout
12817 tag after the wrapper tag.
12818 This parameter should only be used with
12819 \begin_inset Flex Code
12822 \begin_layout Plain Layout
12829 otherwise the title will be output
12833 the contents of the environment.
12834 The generated title is the same as the LyXHTML label:
12835 a combination of the environment type and its number.
12836 A major use is when DocBook has no close mapping for LaTeX environments and users must fallback to using a generic container such as
12837 \begin_inset Flex Code
12840 \begin_layout Plain Layout
12847 which requires a title although there is none in LaTeX.
12848 This feature is heavily used for theorem-like environments.
12851 \begin_layout Description
12852 \begin_inset Flex Code
12855 \begin_layout Plain Layout
12862 \begin_inset Flex Code
12865 \begin_layout Plain Layout
12878 ] The type of label that stands at the end of the paragraph (or sequence of paragraphs if
12879 \begin_inset Flex Code
12882 \begin_layout Plain Layout
12889 \begin_inset Newline newline
12893 \begin_inset Flex Code
12896 \begin_layout Plain Layout
12904 \begin_inset Flex Code
12907 \begin_layout Plain Layout
12914 \begin_inset Flex Code
12917 \begin_layout Plain Layout
12925 \begin_inset Flex Code
12928 \begin_layout Plain Layout
12935 \begin_inset Quotes eld
12939 \begin_inset Quotes erd
12944 \begin_inset Flex Code
12947 \begin_layout Plain Layout
12954 \begin_inset space \space{}
12958 \begin_inset Flex Code
12961 \begin_layout Plain Layout
12967 ) is a white (resp.
12968 \begin_inset space ~
12971 black) square suitable for end of proof markers,
12973 \begin_inset Flex Code
12976 \begin_layout Plain Layout
12982 is an explicit text string.
12985 \begin_layout Description
12986 \begin_inset Flex Code
12989 \begin_layout Plain Layout
12996 \begin_inset Flex Code
12999 \begin_layout Plain Layout
13005 ] The string used for a label with a
13006 \begin_inset Flex Code
13009 \begin_layout Plain Layout
13016 \begin_inset Newline newline
13020 \begin_inset Flex Code
13023 \begin_layout Plain Layout
13033 \begin_layout Description
13034 \begin_inset Flex Code
13037 \begin_layout Plain Layout
13043 The font used for both the text body
13049 \begin_inset CommandInset ref
13051 reference "subsec:Font-description"
13057 Note that defining this font automatically defines the
13058 \begin_inset Flex Code
13061 \begin_layout Plain Layout
13068 So you should define this one first if you also want to define
13069 \begin_inset Flex Code
13072 \begin_layout Plain Layout
13081 \begin_layout Description
13082 \begin_inset Flex Code
13085 \begin_layout Plain Layout
13092 \begin_inset Flex Code
13095 \begin_layout Plain Layout
13101 ] Used for backporting new styles to stable \SpecialChar LyX
13103 The first stable version that supports this tag is \SpecialChar LyX
13105 The argument is a number which may either be 0,
13106 -1 or any value greater than zero.
13108 \begin_inset Flex Code
13111 \begin_layout Plain Layout
13117 flag of a style is greater than zero,
13118 it will always be written to the document header.
13119 If a .lyx file is read,
13120 the style definitions from the document header are added to the document class.
13121 Therefore even older \SpecialChar LyX
13122 versions can handle the style.
13124 \begin_inset Flex Code
13127 \begin_layout Plain Layout
13133 is a version number:
13134 if the style is read,
13135 and the version number is less than the version number of the already existing style in the document class,
13136 the new style is ignored.
13137 If the version number is greater,
13138 the new style replaces the existing style.
13139 A value of -1 means an infinite version number,
13141 \begin_inset space \thinspace{}
13145 \begin_inset space \space{}
13148 the style is always used.
13151 \begin_layout Description
13152 \begin_inset Flex Code
13155 \begin_layout Plain Layout
13162 \begin_inset Flex Code
13165 \begin_layout Plain Layout
13174 \begin_inset space \thinspace{}
13178 \begin_inset Flex Code
13181 \begin_layout Plain Layout
13187 ] Usually \SpecialChar LyX
13188 does not allow you to insert more than one space between words,
13189 since a space is considered as the separation between two words,
13190 not a character or symbol of its own.
13191 This is a very fine thing but sometimes annoying,
13193 when typing program code or plain \SpecialChar LaTeX
13197 \begin_inset Flex Code
13200 \begin_layout Plain Layout
13208 will create non-breaking spaces for the additional blanks when
13209 \begin_inset Flex Code
13212 \begin_layout Plain Layout
13220 \begin_inset Flex Code
13223 \begin_layout Plain Layout
13230 \begin_inset Flex Code
13233 \begin_layout Plain Layout
13242 \begin_layout Description
13243 \begin_inset Flex Code
13246 \begin_layout Plain Layout
13252 These tags are used with XHTML output.
13254 \begin_inset CommandInset ref
13256 reference "subsec:Paragraph-Style-XHTML"
13264 \begin_layout Description
13265 \begin_inset Flex Code
13268 \begin_layout Plain Layout
13275 \begin_inset Flex Code
13278 \begin_layout Plain Layout
13287 \begin_inset space \thinspace{}
13291 \begin_inset Flex Code
13294 \begin_layout Plain Layout
13301 \begin_inset Flex Code
13304 \begin_layout Plain Layout
13311 marks the style as to be included in the document preamble and not in the document body.
13312 This is useful for document classes that want such information as the title and author to appear in the preamble.
13313 Note that this works only for styles for which the
13314 \begin_inset Flex Code
13317 \begin_layout Plain Layout
13324 \begin_inset Flex Code
13327 \begin_layout Plain Layout
13334 \begin_inset Flex Code
13337 \begin_layout Plain Layout
13346 \begin_layout Description
13347 \begin_inset Flex Code
13350 \begin_layout Plain Layout
13357 \begin_inset Flex Code
13360 \begin_layout Plain Layout
13369 \begin_inset space \thinspace{}
13373 \begin_inset Flex Code
13376 \begin_layout Plain Layout
13383 \begin_inset Flex Code
13386 \begin_layout Plain Layout
13393 marks the style as being part of a title block (see also the
13394 \begin_inset Flex Code
13397 \begin_layout Plain Layout
13404 \begin_inset Flex Code
13407 \begin_layout Plain Layout
13416 \begin_layout Description
13417 \begin_inset Flex Code
13420 \begin_layout Plain Layout
13426 Includes a comma-separated list of layouts after which this one should be nested.
13427 Only makes sense with regard to nestable layouts (such as environments).
13429 \begin_inset Quotes eld
13433 \begin_inset Flex Code
13436 \begin_layout Plain Layout
13443 \begin_inset Quotes erd
13448 \begin_inset Flex Code
13451 \begin_layout Plain Layout
13460 \begin_layout Description
13461 \begin_inset Flex Code
13464 \begin_layout Plain Layout
13471 \begin_inset Flex Code
13474 \begin_layout Plain Layout
13483 \begin_inset space \thinspace{}
13487 \begin_inset Flex Code
13490 \begin_layout Plain Layout
13496 ] If this is set to 1 and AddToToc is enabled,
13497 the paragraph adds a summary of its contents in its item in the table of contents.
13504 \begin_layout Description
13505 \begin_inset Flex Code
13508 \begin_layout Plain Layout
13515 \begin_inset Flex Code
13518 \begin_layout Plain Layout
13524 ] The \SpecialChar LaTeX
13525 command sequence declaring an item in a list.
13526 The command is to be defined without the preceding backslash (the default is
13527 \begin_inset Quotes eld
13531 \begin_inset Quotes erd
13536 \begin_inset Flex Code
13539 \begin_layout Plain Layout
13547 in the \SpecialChar LaTeX
13551 \begin_layout Description
13552 \begin_inset Flex Code
13555 \begin_layout Plain Layout
13562 \begin_inset Flex Code
13565 \begin_layout Plain Layout
13571 ] This provides extra space between paragraphs that have the same style.
13572 If you put other styles into an environment,
13573 each is separated with the environment's
13574 \begin_inset Flex Code
13577 \begin_layout Plain Layout
13584 But the whole items of the environment are additionally separated with this
13585 \begin_inset Flex Code
13588 \begin_layout Plain Layout
13595 Note that this is a
13600 \begin_layout Description
13601 \begin_inset Flex Code
13604 \begin_layout Plain Layout
13611 \begin_inset Flex Code
13614 \begin_layout Plain Layout
13623 \begin_inset space \thinspace{}
13627 \begin_inset Flex Code
13630 \begin_layout Plain Layout
13636 ] Usually \SpecialChar LyX
13637 does not allow you to leave a paragraph empty,
13638 since it would lead to empty \SpecialChar LaTeX
13640 There are some cases where this could be desirable however:
13641 in a letter template,
13642 the required fields can be provided as empty fields,
13643 so that people do not forget them;
13644 in some special classes,
13645 a style can be used as some kind of break,
13646 which does not contain actual text.
13649 \begin_layout Description
13650 \begin_inset Flex Code
13653 \begin_layout Plain Layout
13660 \begin_inset Flex Code
13663 \begin_layout Plain Layout
13669 ] The vertical space between the label and the text body.
13670 Only used for labels that are above the text body (
13671 \begin_inset Flex Code
13674 \begin_layout Plain Layout
13681 \begin_inset Newline newline
13685 \begin_inset Flex Code
13688 \begin_layout Plain Layout
13689 Centered_Top_Environment
13697 \begin_layout Description
13698 \begin_inset Flex Code
13701 \begin_layout Plain Layout
13708 \begin_inset Flex Code
13711 \begin_layout Plain Layout
13717 ] The name of the counter for automatic numbering.
13718 In order to have the counter appear with your label,
13719 you will need to reference it in the
13720 \begin_inset Flex Code
13723 \begin_layout Plain Layout
13732 This will work with
13733 \begin_inset Flex Code
13736 \begin_layout Plain Layout
13744 \begin_inset Flex Code
13747 \begin_layout Plain Layout
13755 \begin_inset Flex Code
13758 \begin_layout Plain Layout
13765 \begin_inset Flex Code
13768 \begin_layout Plain Layout
13776 \begin_inset Newline newline
13784 \begin_inset Flex Code
13787 \begin_layout Plain Layout
13794 \begin_inset Flex Code
13797 \begin_layout Plain Layout
13804 though this case is a bit complicated.
13805 Suppose you declare
13806 \begin_inset Quotes eld
13810 \begin_inset Flex Code
13813 \begin_layout Plain Layout
13814 LabelCounter myenum
13820 \begin_inset Quotes erd
13824 Then the actual counters used are
13825 \begin_inset Flex Code
13828 \begin_layout Plain Layout
13836 \begin_inset Flex Code
13839 \begin_layout Plain Layout
13847 \begin_inset Flex Code
13850 \begin_layout Plain Layout
13857 \begin_inset Flex Code
13860 \begin_layout Plain Layout
13867 much as in \SpecialChar LaTeX
13869 These counters must all be declared separately.
13870 \begin_inset Newline newline
13874 \begin_inset CommandInset ref
13876 reference "subsec:Counters"
13881 for details on counters.
13884 \begin_layout Description
13885 \begin_inset Flex Code
13888 \begin_layout Plain Layout
13894 The font used for the label.
13896 \begin_inset CommandInset ref
13898 reference "subsec:Font-description"
13906 \begin_layout Description
13907 \begin_inset Flex Code
13910 \begin_layout Plain Layout
13917 \begin_inset Flex Code
13920 \begin_layout Plain Layout
13926 ] Text that indicates how far a label should be indented.
13929 \begin_layout Description
13930 \begin_inset Flex Code
13933 \begin_layout Plain Layout
13940 \begin_inset Flex Code
13943 \begin_layout Plain Layout
13949 ] Text that indicates the amount of horizontal space between the label and the text body.
13950 Only used for labels that are not above the text body.
13953 \begin_layout Description
13954 \begin_inset Flex Code
13957 \begin_layout Plain Layout
13964 \begin_inset Flex Code
13967 \begin_layout Plain Layout
13973 ] The string used for the label.
13975 \begin_inset Flex Code
13978 \begin_layout Plain Layout
13985 this string can be contain the special formatting commands described in
13986 \begin_inset CommandInset ref
13988 reference "subsec:Counters"
13996 \begin_layout Description
13997 \begin_inset Flex Code
14000 \begin_layout Plain Layout
14001 LabelStringAppendix
14007 \begin_inset Flex Code
14010 \begin_layout Plain Layout
14016 ] This is used inside the appendix instead of
14017 \begin_inset Newline newline
14021 \begin_inset Flex Code
14024 \begin_layout Plain Layout
14032 \begin_inset Flex Code
14035 \begin_layout Plain Layout
14042 \begin_inset Newline newline
14046 \begin_inset Flex Code
14049 \begin_layout Plain Layout
14050 LabelStringAppendix
14058 \begin_layout Description
14059 \begin_inset Flex Code
14062 \begin_layout Plain Layout
14069 \begin_inset Flex Code
14072 \begin_layout Plain Layout
14082 \begin_inset Newline newline
14088 \begin_inset Newline newline
14101 \begin_layout Description
14102 \begin_inset Flex Code
14105 \begin_layout Plain Layout
14111 means the label is the very first word (up to the first real blank).
14112 Use non-breaking spaces if you want more than one word as the label.
14116 \begin_layout Description
14117 \begin_inset Flex Code
14120 \begin_layout Plain Layout
14126 means the label is simply what is declared as
14127 \begin_inset Flex Code
14130 \begin_layout Plain Layout
14137 This will be displayed
14138 \begin_inset Quotes eld
14142 \begin_inset Quotes erd
14146 at the beginning of the paragraph.
14148 \begin_inset Flex Code
14151 \begin_layout Plain Layout
14158 \begin_inset Flex Code
14161 \begin_layout Plain Layout
14168 then it will be displayed only in the first paragraph of any sequence of paragraphs with the same
14169 \begin_inset Flex Code
14172 \begin_layout Plain Layout
14181 \begin_layout Description
14182 \begin_inset Flex Code
14185 \begin_layout Plain Layout
14192 \begin_inset space ~
14196 \begin_inset space ~
14200 \begin_inset Flex Code
14203 \begin_layout Plain Layout
14209 are special cases of
14210 \begin_inset Flex Code
14213 \begin_layout Plain Layout
14220 The label will be printed above the paragraph either at the beginning of the line or centered.
14223 \begin_layout Description
14224 \begin_inset Flex Code
14227 \begin_layout Plain Layout
14233 is a special case for the caption-labels
14234 \begin_inset Quotes eld
14238 \begin_inset Quotes erd
14242 \begin_inset Quotes eld
14246 \begin_inset Quotes erd
14250 \begin_inset Newline newline
14254 \begin_inset Flex Code
14257 \begin_layout Plain Layout
14263 means the (hardcoded) label string depends on the kind of float:
14264 It is hardcoded to be `FloatType N',
14265 where N is the value of the counter associated with the float.
14266 For the case that a caption is inserted outside of a float the
14267 \begin_inset Flex Code
14270 \begin_layout Plain Layout
14277 \begin_inset Quotes eld
14281 \begin_inset Quotes erd
14287 \begin_layout Description
14288 \begin_inset Flex Code
14291 \begin_layout Plain Layout
14297 produces the usual sort of enumeration labels.
14298 The number type needs to be set in the
14304 \begin_inset CommandInset ref
14306 reference "subsec:Counters"
14314 \begin_layout Description
14315 \begin_inset Flex Code
14318 \begin_layout Plain Layout
14324 produces various bullets at the different levels.
14325 The bullet types displayed can be set via
14326 \begin_inset Flex Noun
14329 \begin_layout Plain Layout
14330 Document\SpecialChar menuseparator
14331 Settings\SpecialChar menuseparator
14340 \begin_layout Description
14341 \begin_inset Flex Code
14344 \begin_layout Plain Layout
14350 should be used only with
14351 \begin_inset Flex Code
14354 \begin_layout Plain Layout
14355 LatexType BibEnvironment
14364 \begin_layout Description
14365 \begin_inset Flex Code
14368 \begin_layout Plain Layout
14374 Note that this will completely override any prior
14375 \begin_inset Flex Code
14378 \begin_layout Plain Layout
14384 declaration for this style.
14386 \begin_inset Quotes eld
14390 \begin_inset Flex Code
14393 \begin_layout Plain Layout
14400 \begin_inset Quotes erd
14405 \begin_inset CommandInset ref
14407 reference "subsec:I18n"
14412 for details on its use.
14415 \begin_layout Description
14416 \begin_inset Flex Code
14419 \begin_layout Plain Layout
14426 \begin_inset Flex Code
14429 \begin_layout Plain Layout
14435 ] The name of the corresponding \SpecialChar LaTeX
14437 Either the environment or command name.
14440 \begin_layout Description
14441 \begin_inset Flex Code
14444 \begin_layout Plain Layout
14451 \begin_inset Flex Code
14454 \begin_layout Plain Layout
14460 ] An optional parameter for the corresponding
14461 \begin_inset Flex Code
14464 \begin_layout Plain Layout
14471 This parameter cannot be changed from within \SpecialChar LyX
14473 \begin_inset Flex Code
14476 \begin_layout Plain Layout
14482 for customizable parameters).
14483 This will be output as is after all \SpecialChar LaTeX
14485 \begin_inset Flex Code
14488 \begin_layout Plain Layout
14497 \begin_layout Description
14498 \begin_inset Flex Code
14501 \begin_layout Plain Layout
14508 \begin_inset Flex Code
14511 \begin_layout Plain Layout
14520 \begin_inset Newline newline
14529 ] How the style should be translated into \SpecialChar LaTeX
14534 \begin_layout Plain Layout
14535 \begin_inset Flex Code
14538 \begin_layout Plain Layout
14544 is perhaps a bit misleading,
14545 since these rules apply to SGML classes,
14547 Visit the SGML class files for specific examples.
14556 \begin_layout Description
14557 \begin_inset Flex Code
14560 \begin_layout Plain Layout
14566 means nothing special.
14569 \begin_layout Description
14570 \begin_inset Flex Code
14573 \begin_layout Plain Layout
14580 \begin_inset Flex Code
14583 \begin_layout Plain Layout
14590 {\SpecialChar ldots
14599 \begin_layout Description
14600 \begin_inset Flex Code
14603 \begin_layout Plain Layout
14610 \begin_inset Flex Code
14613 \begin_layout Plain Layout
14620 }\SpecialChar ldots
14636 \begin_layout Description
14637 \begin_inset Flex Code
14640 \begin_layout Plain Layout
14647 \begin_inset Flex Code
14650 \begin_layout Plain Layout
14658 \begin_inset Flex Code
14661 \begin_layout Plain Layout
14669 is generated for each paragraph of this environment.
14673 \begin_layout Description
14674 \begin_inset Flex Code
14677 \begin_layout Plain Layout
14684 \begin_inset Flex Code
14687 \begin_layout Plain Layout
14695 \begin_inset Newline newline
14699 \begin_inset Flex Code
14702 \begin_layout Plain Layout
14708 is passed as an argument to the environment.
14709 \begin_inset Newline newline
14713 \begin_inset Flex Code
14716 \begin_layout Plain Layout
14722 can be defined in the
14723 \begin_inset Flex Noun
14726 \begin_layout Plain Layout
14727 Edit\SpecialChar menuseparator
14729 \begin_inset space ~
14740 \begin_layout Description
14741 \begin_inset Flex Code
14744 \begin_layout Plain Layout
14751 \begin_inset Flex Code
14754 \begin_layout Plain Layout
14760 but adds the necessary mandatory argument (the longest label) to the begin statement of the bibliography environment:
14761 \begin_inset Newline newline
14765 \begin_inset Flex Code
14768 \begin_layout Plain Layout
14771 begin{thebibliography}{99}
14777 It is therefore only useful for bibliography environments.
14778 The default longest label
14779 \begin_inset Quotes eld
14783 \begin_inset Quotes erd
14786 can be changed by the user in the paragraph settings of a bibliography item.
14789 \begin_layout Standard
14790 Putting the last few things together,
14791 the \SpecialChar LaTeX
14792 output will be either:
14796 \begin_layout LyX-Code
14799 LatexName[LatexParam]{\SpecialChar ldots
14803 \begin_layout Standard
14808 \begin_layout LyX-Code
14811 begin{LatexName}[LatexParam] \SpecialChar ldots
14817 \begin_layout Standard
14818 depending upon the \SpecialChar LaTeX
14823 \begin_layout Description
14824 \begin_inset Flex Code
14827 \begin_layout Plain Layout
14834 \begin_inset Flex Code
14837 \begin_layout Plain Layout
14843 ] A string that is put at the beginning of the style content.
14844 A line break in the output can be indicated by
14845 \begin_inset Flex Code
14848 \begin_layout Plain Layout
14857 \begin_layout Description
14858 \begin_inset Flex Code
14861 \begin_layout Plain Layout
14868 \begin_inset Flex Code
14871 \begin_layout Plain Layout
14877 ] If you put styles into environments,
14879 \begin_inset Flex Code
14882 \begin_layout Plain Layout
14888 are not simply added,
14889 but added with a factor
14890 \begin_inset Formula $\frac{4}{\mathrm{depth}+4}$
14894 Note that this parameter is also used when
14895 \begin_inset Flex Code
14898 \begin_layout Plain Layout
14905 \begin_inset Flex Code
14908 \begin_layout Plain Layout
14915 \begin_inset Flex Code
14918 \begin_layout Plain Layout
14925 Then it is added to the manual or dynamic margin.
14926 \begin_inset Newline newline
14930 \begin_inset Quotes eld
14934 \begin_inset Flex Code
14937 \begin_layout Plain Layout
14944 \begin_inset Quotes erd
14947 means that the paragraph is indented with the width of
14948 \begin_inset Quotes eld
14952 \begin_inset Flex Code
14955 \begin_layout Plain Layout
14962 \begin_inset Quotes erd
14965 in the normal font.
14966 You can get a negative width by prefixing the string with
14967 \begin_inset Quotes eld
14971 \begin_inset Flex Code
14974 \begin_layout Plain Layout
14981 \begin_inset Quotes erd
14985 This way was chosen so that the look is the same with each used screen font.
14988 \begin_layout Description
14989 \begin_inset Flex Code
14992 \begin_layout Plain Layout
14999 \begin_inset Flex Code
15002 \begin_layout Plain Layout
15017 \begin_inset Newline newline
15020 The kind of margin that the style has on the left side.
15024 \begin_layout Description
15025 \begin_inset Flex Code
15028 \begin_layout Plain Layout
15034 just means a fixed margin.
15037 \begin_layout Description
15038 \begin_inset Flex Code
15041 \begin_layout Plain Layout
15047 means that the left margin depends on the string entered in the
15048 \begin_inset Flex Noun
15051 \begin_layout Plain Layout
15052 Edit\SpecialChar menuseparator
15054 \begin_inset space ~
15063 This is used to typeset nice lists without tabulators.
15066 \begin_layout Description
15067 \begin_inset Flex Code
15070 \begin_layout Plain Layout
15076 means that the margin depends on the size of the label.
15077 This is used for automatic enumerated headlines.
15078 It is obvious that the headline
15079 \begin_inset Quotes eld
15082 5.4.3.2.1 Very long headline
15083 \begin_inset Quotes erd
15086 must have a wider left margin (as wide as
15087 \begin_inset Quotes eld
15091 \begin_inset Quotes erd
15094 plus the space) than
15095 \begin_inset Quotes eld
15098 3.2 Very long headline
15099 \begin_inset Quotes erd
15104 \begin_inset Quotes eld
15108 \begin_inset Quotes erd
15111 are not able to do this.
15114 \begin_layout Description
15115 \begin_inset Flex Code
15118 \begin_layout Plain Layout
15125 but only the very first row of the paragraph is dynamic,
15126 while the others are static;
15132 \begin_layout Description
15133 \begin_inset Flex Code
15136 \begin_layout Plain Layout
15142 means the margin is chosen in a way that the longest row of this paragraph fits to the right margin.
15143 This is used to typeset an address on the right edge of the page.
15147 \begin_layout Description
15148 \begin_inset Flex Code
15151 \begin_layout Plain Layout
15158 \begin_inset Flex Code
15161 \begin_layout Plain Layout
15170 \begin_inset space \thinspace{}
15174 \begin_inset Flex Code
15177 \begin_layout Plain Layout
15183 ] Whether fragile commands in this style should be
15184 \begin_inset Flex Code
15187 \begin_layout Plain Layout
15201 whether this command should itself be protected.)
15204 \begin_layout Description
15205 \begin_inset Flex Code
15208 \begin_layout Plain Layout
15215 \change_inserted -712698321 1715492667
15217 \begin_inset Flex Code
15220 \begin_layout Plain Layout
15222 \change_inserted -712698321 1715492433
15231 \begin_inset space \thinspace{}
15237 \begin_inset Flex Code
15240 \begin_layout Plain Layout
15249 \begin_inset space \thinspace{}
15253 \begin_inset Flex Code
15256 \begin_layout Plain Layout
15263 \change_inserted -712698321 1715492466
15265 \begin_inset Flex Code
15268 \begin_layout Plain Layout
15270 \change_inserted -712698321 1715492466
15279 \change_deleted -712698321 1715492468
15282 causes macros that contain this layout to be protected with
15283 \begin_inset Flex Code
15286 \begin_layout Plain Layout
15299 ) if necessary and thus allows (some) verbatim stuff in macros.
15301 \change_inserted -712698321 1715492595
15302 With the default setting (value
15303 \begin_inset Flex Code
15306 \begin_layout Plain Layout
15308 \change_inserted -712698321 1715492536
15318 \begin_inset Flex Code
15321 \begin_layout Plain Layout
15323 \change_inserted -712698321 1715492551
15333 is used if a nested element requires it.
15335 \begin_inset Flex Code
15338 \begin_layout Plain Layout
15340 \change_inserted -712698321 1715492585
15348 prevents any use of
15349 \begin_inset Flex Code
15352 \begin_layout Plain Layout
15354 \change_inserted -712698321 1715492585
15364 within this layout,
15365 even if required by a nested element.
15370 \begin_layout Description
15371 \begin_inset Flex Code
15374 \begin_layout Plain Layout
15381 \begin_inset Flex Code
15384 \begin_layout Plain Layout
15393 \begin_inset space \thinspace{}
15397 \begin_inset Flex Code
15400 \begin_layout Plain Layout
15406 ] Whether specific commands in this style (such as
15407 \begin_inset Flex Code
15410 \begin_layout Plain Layout
15419 \begin_inset Flex Code
15422 \begin_layout Plain Layout
15430 ) should be protected in an
15431 \begin_inset Flex Code
15434 \begin_layout Plain Layout
15443 This is particularly needed for styles that draw on
15451 commands which parse their content in complex ways.
15454 \begin_layout Description
15455 \begin_inset Flex Code
15458 \begin_layout Plain Layout
15465 \begin_inset Flex Code
15468 \begin_layout Plain Layout
15475 \begin_inset space \thinspace{}
15479 \begin_inset Flex Code
15482 \begin_layout Plain Layout
15490 ] Whether newlines are translated into \SpecialChar LaTeX
15492 \begin_inset Flex Code
15495 \begin_layout Plain Layout
15506 The translation can be switched off to allow more comfortable \SpecialChar LaTeX
15507 editing inside \SpecialChar LyX
15511 \begin_layout Description
15512 \begin_inset Flex Code
15515 \begin_layout Plain Layout
15522 \begin_inset Flex Code
15525 \begin_layout Plain Layout
15534 \begin_inset space \thinspace{}
15538 \begin_inset Flex Code
15541 \begin_layout Plain Layout
15549 \begin_inset Flex Code
15552 \begin_layout Plain Layout
15559 \begin_inset Flex Code
15562 \begin_layout Plain Layout
15568 ) paragraphs are being indented,
15569 then the indentation of such a paragraph following one of this type will be suppressed.
15570 (So this will not affect the display of non-default paragraphs.)
15573 \begin_layout Description
15575 \change_inserted -712698321 1715509676
15576 \begin_inset Flex Code
15579 \begin_layout Plain Layout
15581 \change_inserted -712698321 1715509206
15590 \begin_inset Flex Code
15593 \begin_layout Plain Layout
15595 \change_inserted -712698321 1715509203
15607 Defines individual characters that should
15611 be output in raw form (without special translations that \SpecialChar LaTeX
15613 even if such handling is requested by an element in this layout.
15614 This tag can be used to overwrite
15615 \begin_inset Quotes els
15619 \begin_inset Quotes ers
15622 conditions if they are unsuitable in a given context.
15625 \begin_layout Description
15626 \begin_inset Flex Code
15629 \begin_layout Plain Layout
15636 \begin_inset Flex Code
15639 \begin_layout Plain Layout
15645 ] Name of a style that has replaced this style.
15646 This is used to rename a style,
15647 while keeping backward compatibility.
15650 \begin_layout Description
15651 \begin_inset Flex Code
15654 \begin_layout Plain Layout
15661 \begin_inset Flex Code
15664 \begin_layout Plain Layout
15671 \begin_inset space \thinspace{}
15675 \begin_inset Flex Code
15678 \begin_layout Plain Layout
15684 ] Determines whether consecutive paragraphs of the same type are treated as belonging together.
15685 This has the effect that the
15686 \begin_inset Flex Code
15689 \begin_layout Plain Layout
15695 is only printed once before such a group.
15698 \begin_inset Flex Code
15701 \begin_layout Plain Layout
15708 \begin_inset Flex Code
15711 \begin_layout Plain Layout
15718 \begin_inset Flex Code
15721 \begin_layout Plain Layout
15727 and false for all other types.
15730 \begin_layout Description
15731 \begin_inset Flex Code
15734 \begin_layout Plain Layout
15741 \begin_inset Flex Code
15744 \begin_layout Plain Layout
15753 \begin_inset space \thinspace{}
15757 \begin_inset Flex Code
15760 \begin_layout Plain Layout
15766 ] Indicates that paragraphs will not be separated by an empty line in \SpecialChar LaTeX
15768 but only by a line break;
15770 \begin_inset Flex Code
15773 \begin_layout Plain Layout
15780 this allows to emulate a plain text editor (like the ERT inset).
15783 \begin_layout Description
15784 \begin_inset Flex Code
15787 \begin_layout Plain Layout
15794 \begin_inset Flex Code
15797 \begin_layout Plain Layout
15803 ] The indent of the very first line of a paragraph.
15805 \begin_inset Newline newline
15809 \begin_inset Flex Code
15812 \begin_layout Plain Layout
15818 will be fixed for a certain style.
15819 The exception is the default style,
15820 since the indentation for these paragraphs can be prohibited with
15821 \begin_inset Flex Code
15824 \begin_layout Plain Layout
15833 \begin_inset Flex Code
15836 \begin_layout Plain Layout
15842 style paragraphs inside environments use the
15843 \begin_inset Flex Code
15846 \begin_layout Plain Layout
15852 of the environment,
15853 not their native one.
15856 \begin_inset Flex Code
15859 \begin_layout Plain Layout
15865 paragraphs inside an enumeration are not indented.
15868 \begin_layout Description
15869 \begin_inset Flex Code
15872 \begin_layout Plain Layout
15879 \begin_inset Flex Code
15882 \begin_layout Plain Layout
15888 ] The vertical space between two paragraphs of this style.
15891 \begin_layout Description
15892 \begin_inset Flex Code
15895 \begin_layout Plain Layout
15902 \begin_inset Flex Code
15905 \begin_layout Plain Layout
15912 allows the user to choose either
15913 \begin_inset Quotes eld
15917 \begin_inset Quotes erd
15921 \begin_inset Quotes eld
15925 \begin_inset Quotes erd
15928 to separate paragraphs.
15930 \begin_inset Quotes eld
15934 \begin_inset Quotes erd
15939 \begin_inset Flex Code
15942 \begin_layout Plain Layout
15950 \begin_inset Quotes eld
15954 \begin_inset Quotes erd
15959 \begin_inset Flex Code
15962 \begin_layout Plain Layout
15968 is ignored and all paragraphs are separated by the
15969 \begin_inset Flex Code
15972 \begin_layout Plain Layout
15979 The vertical space is calculated with
15980 \begin_inset Flex Code
15983 \begin_layout Plain Layout
15985 \begin_inset space ~
15994 \begin_inset Flex Code
15997 \begin_layout Plain Layout
16003 is the height of a row with the normal font.
16005 the look stays the same with different screen fonts.
16008 \begin_layout Description
16009 \begin_inset Flex Code
16012 \begin_layout Plain Layout
16019 \begin_inset Flex Code
16022 \begin_layout Plain Layout
16031 \begin_inset space \thinspace{}
16035 \begin_inset Flex Code
16038 \begin_layout Plain Layout
16044 ] Whether the contents of this paragraph should be output in raw form,
16045 meaning without special translations that \SpecialChar LaTeX
16049 \begin_layout Description
16050 \begin_inset Flex Code
16053 \begin_layout Plain Layout
16060 \begin_inset Flex Code
16063 \begin_layout Plain Layout
16073 Defines individual characters that should be output in raw form,
16074 meaning without special translations that \SpecialChar LaTeX
16078 \begin_layout Description
16079 \begin_inset Flex Code
16082 \begin_layout Plain Layout
16088 Information to be included in the \SpecialChar LaTeX
16089 preamble when this style is used.
16090 Used to define macros,
16093 required by this particular style.
16095 \begin_inset Quotes eld
16099 \begin_inset Flex Code
16102 \begin_layout Plain Layout
16109 \begin_inset Quotes erd
16115 \begin_layout Description
16116 \begin_inset Flex Code
16119 \begin_layout Plain Layout
16126 \begin_inset Flex Code
16129 \begin_layout Plain Layout
16135 ] The prefix to use when creating labels referring to paragraphs of this type.
16136 This allows the use of formatted references.
16139 \begin_layout Description
16140 \begin_inset Flex Code
16143 \begin_layout Plain Layout
16150 \begin_inset Flex Code
16153 \begin_layout Plain Layout
16159 ] Whether the style requires the feature
16160 \begin_inset Flex Code
16163 \begin_layout Plain Layout
16170 \begin_inset CommandInset ref
16172 reference "chap:List-of-functions"
16177 for the list of features).
16178 If you require a package with specific options,
16179 you can additionally use
16180 \begin_inset Flex Code
16183 \begin_layout Plain Layout
16189 as a general text class parameter (see
16190 \begin_inset CommandInset ref
16192 reference "subsec:General-text-class"
16200 \begin_layout Description
16201 \begin_inset Flex Code
16204 \begin_layout Plain Layout
16211 \begin_inset Flex Code
16214 \begin_layout Plain Layout
16223 \begin_inset Flex Code
16226 \begin_layout Plain Layout
16232 ] Resets the \SpecialChar LaTeX
16233 arguments of this style (as defined via the
16234 \begin_inset Flex Code
16237 \begin_layout Plain Layout
16244 This is useful if you have copied a style via
16245 \begin_inset Flex Code
16248 \begin_layout Plain Layout
16255 but you do not want to inherit its (required and optional) arguments.
16258 \begin_layout Description
16259 \begin_inset Flex Code
16262 \begin_layout Plain Layout
16269 \begin_inset Flex Code
16272 \begin_layout Plain Layout
16281 \begin_inset Flex Code
16284 \begin_layout Plain Layout
16290 ] Resumes a counter that is usually reset at each new sequence of layouts.
16291 This is currently only useful when
16292 \begin_inset Flex Code
16295 \begin_layout Plain Layout
16302 \begin_inset Flex Code
16305 \begin_layout Plain Layout
16314 \begin_layout Description
16315 \begin_inset Flex Code
16318 \begin_layout Plain Layout
16325 \begin_inset Flex Code
16328 \begin_layout Plain Layout
16334 ] A string that is put at the end of the layout content.
16335 A line break in the output can be indicated by
16336 \begin_inset Flex Code
16339 \begin_layout Plain Layout
16348 \begin_layout Description
16349 \begin_inset Flex Code
16352 \begin_layout Plain Layout
16359 \begin_inset Flex Code
16362 \begin_layout Plain Layout
16369 \begin_inset Flex Code
16372 \begin_layout Plain Layout
16381 \begin_layout Description
16382 \begin_inset Flex Code
16385 \begin_layout Plain Layout
16392 \begin_inset Flex Code
16395 \begin_layout Plain Layout
16405 \begin_inset Flex Code
16408 \begin_layout Plain Layout
16416 \begin_inset Flex Code
16419 \begin_layout Plain Layout
16427 \begin_inset Flex Code
16430 \begin_layout Plain Layout
16432 \begin_inset space ~
16440 ] This defines what the default spacing should be in the style.
16442 \begin_inset Flex Code
16445 \begin_layout Plain Layout
16453 \begin_inset Flex Code
16456 \begin_layout Plain Layout
16463 \begin_inset Flex Code
16466 \begin_layout Plain Layout
16472 correspond respectively to a multiplier value of 1,
16474 If you specify the argument
16475 \begin_inset Flex Code
16478 \begin_layout Plain Layout
16485 then you must also provide a value argument which will be the actual multiplier value.
16487 contrary to other parameters,
16489 \begin_inset Flex Code
16492 \begin_layout Plain Layout
16498 implies the generation of specific \SpecialChar LaTeX
16500 using the \SpecialChar LaTeX
16504 \begin_inset Flex Code
16507 \begin_layout Plain Layout
16516 \begin_layout Description
16517 \begin_inset Flex Code
16520 \begin_layout Plain Layout
16527 \begin_inset Flex Code
16530 \begin_layout Plain Layout
16537 \begin_inset space \thinspace{}
16541 \begin_inset Flex Code
16544 \begin_layout Plain Layout
16552 ] Allow spell-checking paragraphs of this style.
16556 \begin_layout Description
16557 \begin_inset Flex Code
16560 \begin_layout Plain Layout
16567 \begin_inset Flex Code
16570 \begin_layout Plain Layout
16579 \begin_inset Flex Code
16582 \begin_layout Plain Layout
16588 ] Steps the parent counter of a given counter at the beginning of a new sequence of layouts.
16589 This is currently only useful when
16590 \begin_inset Flex Code
16593 \begin_layout Plain Layout
16600 \begin_inset Flex Code
16603 \begin_layout Plain Layout
16612 \begin_layout Description
16613 \begin_inset Flex Code
16616 \begin_layout Plain Layout
16622 The font used for the text body .
16624 \begin_inset CommandInset ref
16626 reference "subsec:Font-description"
16634 \begin_layout Description
16635 \begin_inset Flex Code
16638 \begin_layout Plain Layout
16647 \begin_inset Flex Code
16650 \begin_layout Plain Layout
16660 The level of the style in the table of contents.
16661 This is used for automatic numbering of section headings.
16664 \begin_layout Description
16665 \begin_inset Flex Code
16668 \begin_layout Plain Layout
16677 \begin_inset Flex Code
16680 \begin_layout Plain Layout
16692 \begin_inset Flex Code
16695 \begin_layout Plain Layout
16703 \begin_inset Flex Code
16706 \begin_layout Plain Layout
16712 ] This tag determines whether the first line indentation of this paragraph can be toggled via the Paragraph settings dialog.
16716 \begin_inset Flex Code
16719 \begin_layout Plain Layout
16730 indentation can be toggled if the document settings use
16731 \begin_inset Quotes eld
16735 \begin_inset Quotes erd
16740 \begin_inset Flex Code
16743 \begin_layout Plain Layout
16750 indentation can always be toggled,
16751 notwithstanding the document settings,
16753 \begin_inset Flex Code
16756 \begin_layout Plain Layout
16763 indentation can never be toggled.
16766 \begin_layout Description
16767 \begin_inset Flex Code
16770 \begin_layout Plain Layout
16777 \begin_inset Flex Code
16780 \begin_layout Plain Layout
16786 ] The vertical space with which the very first of a chain of paragraphs with this style is separated from the previous paragraph.
16787 If the previous paragraph has another style,
16788 the separations are not simply added,
16789 but the maximum is taken.
16792 \begin_layout Subsection
16793 \begin_inset CommandInset label
16799 Internationalization of Paragraph Styles
16802 \begin_layout Standard
16804 has long supported internationalization of layout information,
16807 this applied only to the user interface and not to,
16811 French authors were forced to resort to ugly hacks if they wanted `
16815 1' instead of `Theorem 1'.
16816 Thanks to Georg Baum,
16817 that is no longer the case.
16820 \begin_layout Standard
16822 \begin_inset Flex Code
16825 \begin_layout Plain Layout
16831 defines text that is to appear in the typeset document,
16833 \begin_inset Flex Code
16836 \begin_layout Plain Layout
16843 \begin_inset Flex Code
16846 \begin_layout Plain Layout
16852 to support non-English and even multi-language documents correctly.
16853 The following excerpt (from the
16854 \begin_inset Flex Code
16857 \begin_layout Plain Layout
16863 file) shows how this works:
16866 \begin_layout LyX-Code
16871 \begin_layout LyX-Code
16874 theoremstyle{remark}
16877 \begin_layout LyX-Code
16880 newtheorem{claim}[thm]{
16887 \begin_layout LyX-Code
16891 \begin_layout LyX-Code
16895 \begin_layout LyX-Code
16900 claimname}{_(Claim)}
16903 \begin_layout LyX-Code
16907 \begin_layout LyX-Code
16911 \begin_layout LyX-Code
16920 claimname}{_(Claim)}}
16923 \begin_layout LyX-Code
16928 \begin_layout Standard
16930 any legal \SpecialChar LaTeX
16932 \begin_inset Flex Code
16935 \begin_layout Plain Layout
16942 \begin_inset Flex Code
16945 \begin_layout Plain Layout
16952 but in practice they will typically look as they do here.
16953 The key to correct translation of the typeset text is the definition of the \SpecialChar LaTeX
16955 \begin_inset Flex Code
16958 \begin_layout Plain Layout
16967 \begin_inset Flex Code
16970 \begin_layout Plain Layout
16982 \begin_layout Standard
16984 \begin_inset Flex Code
16987 \begin_layout Plain Layout
16993 tag provides for internationalization based upon the overall language of the document.
16994 The contents of the tag will be included in the preamble,
16996 \begin_inset Flex Code
16999 \begin_layout Plain Layout
17006 What makes it special is the use of the
17007 \begin_inset Quotes eld
17011 \begin_inset Quotes erd
17015 \begin_inset Flex Code
17018 \begin_layout Plain Layout
17025 which will be replaced,
17026 when \SpecialChar LyX
17027 produces \SpecialChar LaTeX
17029 with the translation of its argument into the document language.
17032 \begin_layout Standard
17034 \begin_inset Flex Code
17037 \begin_layout Plain Layout
17043 tag is more complex,
17044 since it is meant to provide support for multi-language documents and so offers an interface to the
17045 \begin_inset Flex Code
17048 \begin_layout Plain Layout
17055 Its contents will be added to the preamble once for each language that appears in the document.
17058 \begin_inset Flex Code
17061 \begin_layout Plain Layout
17067 will be replaced with its translation into the language in question;
17069 \begin_inset Flex Code
17072 \begin_layout Plain Layout
17078 is replaced by the language name (as used by the babel package).
17081 \begin_layout Standard
17082 A German document that also included a French section would thus have the following in the preamble:
17085 \begin_layout LyX-Code
17094 claimname}{Affirmation}}
17095 \begin_inset Newline newline
17106 claimname}{Behauptung}}
17107 \begin_inset Newline newline
17114 claimname}{Behauptung}
17117 \begin_layout Standard
17120 \begin_inset Flex Code
17123 \begin_layout Plain Layout
17129 will then conspire to produce the correct text in the output.
17132 \begin_layout Standard
17133 One important point to note here is that the translations are provided by \SpecialChar LyX
17136 \begin_inset Flex Code
17139 \begin_layout Plain Layout
17149 \begin_inset Flex Code
17152 \begin_layout Plain Layout
17159 \begin_inset Flex Code
17162 \begin_layout Plain Layout
17168 are really only of use in layout files that are provided with \SpecialChar LyX
17170 since text entered in user-created layout files will not be seen by \SpecialChar LyX
17171 's internationalization routines unless the
17172 \begin_inset Flex Code
17175 \begin_layout Plain Layout
17181 file is modified accordingly.
17184 any layout created with the intention that it will be included with \SpecialChar LyX
17185 should use these tags where appropriate.
17186 Please note that the paragraph style translations provided by \SpecialChar LyX
17187 will never change with a minor update (e.
17188 \begin_inset space \thinspace{}
17192 \begin_inset space \space{}
17195 from version 2.1.x to 2.1.y).
17196 It is however quite likely that a major update (e.
17197 \begin_inset space \thinspace{}
17201 \begin_inset space \space{}
17204 from 2.0.x to 2.1.0) will introduce new translations or corrections.
17207 \begin_layout Subsection
17209 \begin_inset CommandInset label
17211 name "subsec:Floats"
17218 \begin_layout Standard
17219 It is necessary to define the floats (
17220 \begin_inset Flex Noun
17223 \begin_layout Plain Layout
17231 \begin_inset Flex Noun
17234 \begin_layout Plain Layout
17242 ) in the text class itself.
17243 Standard floats are included in the file
17244 \begin_inset Flex Code
17247 \begin_layout Plain Layout
17254 so you may have to do no more than add
17257 \begin_layout LyX-Code
17258 Input stdfloats.inc
17261 \begin_layout Standard
17262 to your layout file.
17263 If you want to implement a text class that proposes some other float types (like the AGU class bundled with \SpecialChar LyX
17265 the information below will hopefully help you:
17268 \begin_layout Description
17269 \begin_inset Flex Code
17272 \begin_layout Plain Layout
17279 \begin_inset Flex Code
17282 \begin_layout Plain Layout
17288 =!htbpH] Allowed placement options for this float type.
17289 The value is a string of placement characters.
17290 Possible characters include:
17296 \begin_inset Quotes eld
17300 \begin_inset Quotes erd
17309 \begin_inset Quotes eld
17313 \begin_inset Quotes erd
17322 \begin_inset Quotes eld
17326 \begin_inset Quotes erd
17335 \begin_inset Quotes eld
17339 \begin_inset Quotes erd
17348 \begin_inset Quotes eld
17352 \begin_inset Quotes erd
17361 \begin_inset Quotes eld
17365 \begin_inset Quotes erd
17369 The order of the characters in the string does not matter.
17370 If no placement options are allowed,
17378 \begin_layout Description
17379 \begin_inset Flex Code
17382 \begin_layout Plain Layout
17389 \begin_inset Flex Code
17392 \begin_layout Plain Layout
17401 \begin_inset space \thinspace{}
17407 \begin_inset Flex Code
17410 \begin_layout Plain Layout
17420 ] Defines whether the float allows to be rotated via the \SpecialChar LaTeX
17427 \begin_inset Flex Code
17430 \begin_layout Plain Layout
17436 if the float does not support this feature.
17439 \begin_layout Description
17440 \begin_inset Flex Code
17443 \begin_layout Plain Layout
17450 \begin_inset Flex Code
17453 \begin_layout Plain Layout
17462 \begin_inset space \thinspace{}
17468 \begin_inset Flex Code
17471 \begin_layout Plain Layout
17481 ] Defines whether the float has a starred variant that spans columns in a two column paragraph.
17483 \begin_inset Flex Code
17486 \begin_layout Plain Layout
17492 if the float does not support this feature.
17495 \begin_layout Description
17496 \begin_inset Flex Code
17499 \begin_layout Plain Layout
17506 \begin_inset Flex Code
17509 \begin_layout Plain Layout
17516 \begin_inset Quotes erd
17520 \begin_inset Quotes erd
17523 ] The file name extension of an auxiliary file for the list of figures (or whatever).
17525 writes the captions to this file.
17528 \begin_layout Description
17529 \begin_inset Flex Code
17532 \begin_layout Plain Layout
17539 \begin_inset Flex Code
17542 \begin_layout Plain Layout
17549 \begin_inset Quotes erd
17553 \begin_inset Quotes erd
17556 ] The string that will be used in the menus and also for the caption.
17557 This is translated to the current language if babel is used.
17560 \begin_layout Description
17561 \begin_inset Flex Code
17564 \begin_layout Plain Layout
17570 These tags control the XHTML output.
17572 \begin_inset CommandInset ref
17574 reference "sec:Tags-for-XHTML"
17582 \begin_layout Description
17583 \begin_inset Flex Code
17586 \begin_layout Plain Layout
17595 \begin_inset Flex Code
17598 \begin_layout Plain Layout
17607 \begin_inset space \thinspace{}
17611 \begin_inset Flex Code
17614 \begin_layout Plain Layout
17620 ] Indicates whether the float is already defined in the document class or if instead the \SpecialChar LaTeX
17622 \begin_inset Flex Code
17625 \begin_layout Plain Layout
17631 needs to be loaded to define it on-the-fly.
17633 \begin_inset Flex Code
17636 \begin_layout Plain Layout
17645 \begin_inset Flex Code
17648 \begin_layout Plain Layout
17655 It should be set to
17656 \begin_inset Flex Code
17659 \begin_layout Plain Layout
17665 if the float is already defined by the \SpecialChar LaTeX
17669 \begin_layout Description
17670 \begin_inset Flex Code
17673 \begin_layout Plain Layout
17680 \begin_inset Flex Code
17683 \begin_layout Plain Layout
17690 \begin_inset Quotes erd
17694 \begin_inset Quotes erd
17697 ] The command used to generate a list of floats of this type;
17706 \begin_inset Flex Code
17709 \begin_layout Plain Layout
17716 since there is no standard way to generate this command.
17718 \begin_inset Flex Code
17721 \begin_layout Plain Layout
17728 since in that case there is a standard way to define the command.
17731 \begin_layout Description
17732 \begin_inset Flex Code
17735 \begin_layout Plain Layout
17742 \begin_inset Flex Code
17745 \begin_layout Plain Layout
17752 \begin_inset Quotes erd
17756 \begin_inset Quotes erd
17759 ] A title for a list of floats of this kind (list of figures,
17762 It is used for the screen label within \SpecialChar LyX
17764 it is used by \SpecialChar LaTeX
17765 for the title and it is used as the title in the XHTML output.
17766 It will be translated to the document language.
17769 \begin_layout Description
17770 \begin_inset Flex Code
17773 \begin_layout Plain Layout
17780 \begin_inset Flex Code
17783 \begin_layout Plain Layout
17790 \begin_inset Quotes erd
17794 \begin_inset Quotes erd
17797 ] This (optional) argument determines whether floats of this class will be numbered within some sectional unit of the document.
17800 \begin_inset Flex Code
17803 \begin_layout Plain Layout
17810 \begin_inset Quotes eld
17814 \begin_inset Flex Code
17817 \begin_layout Plain Layout
17824 \begin_inset Quotes erd
17828 the floats will be numbered within chapters.
17832 \begin_layout Description
17833 \begin_inset Flex Code
17836 \begin_layout Plain Layout
17843 \begin_inset Flex Code
17846 \begin_layout Plain Layout
17853 \begin_inset Quotes erd
17857 \begin_inset Quotes erd
17860 ] The default placement for the given class of floats.
17861 The string should be as in standard \SpecialChar LaTeX
17864 \begin_inset Flex Code
17867 \begin_layout Plain Layout
17875 \begin_inset Flex Code
17878 \begin_layout Plain Layout
17886 \begin_inset Flex Code
17889 \begin_layout Plain Layout
17896 \begin_inset Flex Code
17899 \begin_layout Plain Layout
17913 \begin_layout Plain Layout
17914 Note that the order of these letters in the string is irrelevant,
17915 like in \SpecialChar LaTeX
17921 On top of that there is a new type,
17923 \begin_inset Flex Code
17926 \begin_layout Plain Layout
17933 which does not really correspond to a float,
17936 \begin_inset Quotes eld
17940 \begin_inset Quotes erd
17944 Note however that the
17945 \begin_inset Flex Code
17948 \begin_layout Plain Layout
17954 specifier is special and,
17955 because of implementation details,
17956 cannot be used in non-built in float types.
17957 If you do not understand what this means,
17959 \begin_inset Quotes eld
17963 \begin_inset Flex Code
17966 \begin_layout Plain Layout
17973 \begin_inset Quotes erd
17979 \begin_layout Description
17980 \begin_inset Flex Code
17983 \begin_layout Plain Layout
17990 \begin_inset Flex Code
17993 \begin_layout Plain Layout
18000 \begin_inset Quotes erd
18004 \begin_inset Quotes erd
18007 ] A format for use with formatted references to this counter.
18009 one might want to have references to tables appear as
18010 \begin_inset Quotes eld
18014 \begin_inset Quotes erd
18018 The string may contain
18019 \begin_inset Quotes eld
18023 \begin_inset Quotes erd
18026 or a counter specification.
18027 (See the documentation for
18028 \begin_inset Flex Code
18031 \begin_layout Plain Layout
18038 \begin_inset CommandInset ref
18039 LatexCommand formatted
18040 reference "subsec:Counters"
18048 .) The former will be replaced by the counter number itself.
18056 arabic{section} (which might render as:
18060 \begin_layout Description
18061 \begin_inset Flex Code
18064 \begin_layout Plain Layout
18071 \begin_inset Flex Code
18074 \begin_layout Plain Layout
18080 ] The prefix to use when creating labels referring to floats of this type.
18081 This allows the use of formatted references.
18082 Note that you can remove any
18083 \begin_inset Flex Code
18086 \begin_layout Plain Layout
18092 set by a copied style by using the special value
18093 \begin_inset Quotes eld
18097 \begin_inset Quotes erd
18101 which must be all caps.
18104 \begin_layout Description
18105 \begin_inset Flex Code
18108 \begin_layout Plain Layout
18115 \begin_inset Flex Code
18118 \begin_layout Plain Layout
18124 ] As with paragraph styles,
18126 \begin_inset CommandInset ref
18128 reference "subsec:Paragraph-Styles"
18136 \begin_layout Description
18137 \begin_inset Flex Code
18140 \begin_layout Plain Layout
18147 \begin_inset Flex Code
18150 \begin_layout Plain Layout
18157 \begin_inset Quotes erd
18161 \begin_inset Quotes erd
18164 ] The style used when defining the float using
18165 \begin_inset Flex Code
18168 \begin_layout Plain Layout
18179 \begin_layout Description
18180 \begin_inset Flex Code
18183 \begin_layout Plain Layout
18190 \begin_inset Flex Code
18193 \begin_layout Plain Layout
18200 \begin_inset Quotes erd
18204 \begin_inset Quotes erd
18208 \begin_inset Quotes eld
18212 \begin_inset Quotes erd
18215 of the new class of floats,
18216 like program or algorithm.
18217 After the appropriate
18218 \begin_inset Flex Code
18221 \begin_layout Plain Layout
18231 \begin_inset Flex Code
18234 \begin_layout Plain Layout
18243 \begin_inset Flex Code
18246 \begin_layout Plain Layout
18257 \begin_layout Description
18258 \begin_inset Flex Code
18261 \begin_layout Plain Layout
18268 \begin_inset Flex Code
18271 \begin_layout Plain Layout
18278 \begin_inset space \thinspace{}
18282 \begin_inset Flex Code
18285 \begin_layout Plain Layout
18293 ] Specifies whether this float is defined using the \SpecialChar LaTeX
18295 \begin_inset Flex Code
18298 \begin_layout Plain Layout
18305 either by the class file,
18306 another package or on-the-fly by \SpecialChar LyX
18310 \begin_layout Standard
18311 Note that defining a float with type
18312 \begin_inset Flex Code
18315 \begin_layout Plain Layout
18323 automatically defines the corresponding counter with name
18324 \begin_inset Flex Code
18327 \begin_layout Plain Layout
18338 \begin_layout Subsection
18339 Flex insets and InsetLayout
18340 \begin_inset CommandInset label
18342 name "subsec:Flex-insets-and"
18349 \begin_layout Standard
18350 Flex insets come in two different kinds:
18354 \begin_layout Itemize
18356 \begin_inset Flex Code
18359 \begin_layout Plain Layout
18366 These define semantic markup corresponding to such \SpecialChar LaTeX
18368 \begin_inset Flex Code
18371 \begin_layout Plain Layout
18380 \begin_inset Flex Code
18383 \begin_layout Plain Layout
18394 \begin_layout Itemize
18396 \begin_inset Flex Code
18399 \begin_layout Plain Layout
18406 These can be used to define custom collapsible insets,
18407 similar to \SpecialChar TeX
18411 An obvious example is an endnote inset,
18412 which is defined in the
18413 \begin_inset Flex Code
18416 \begin_layout Plain Layout
18425 \begin_layout Standard
18426 Flex insets are defined using the
18427 \begin_inset Flex Code
18430 \begin_layout Plain Layout
18437 which shall be explained in a moment.
18440 \begin_layout Standard
18442 \begin_inset Flex Code
18445 \begin_layout Plain Layout
18451 tag also serves another function:
18452 It can be used to customize the general layout of many different types of insets.
18455 \begin_inset Flex Code
18458 \begin_layout Plain Layout
18464 can be used to customize the layout parameters for footnotes,
18477 as well as to define Flex insets.
18480 \begin_layout Standard
18482 \begin_inset Flex Code
18485 \begin_layout Plain Layout
18491 definition must begin with a line of the form:
18494 \begin_layout LyX-Code
18498 \begin_layout Standard
18500 \begin_inset Flex Code
18503 \begin_layout Plain Layout
18509 indicates the inset whose layout is being defined,
18510 and here there are four cases.
18513 \begin_layout Enumerate
18514 The layout for a pre-existing inset is being modified.
18517 \begin_inset Flex Code
18520 \begin_layout Plain Layout
18526 any one of the following:
18528 \begin_inset Flex Code
18531 \begin_layout Plain Layout
18539 \begin_inset Flex Code
18542 \begin_layout Plain Layout
18550 \begin_inset Flex Code
18553 \begin_layout Plain Layout
18561 \begin_inset Flex Code
18564 \begin_layout Plain Layout
18572 \begin_inset Flex Code
18575 \begin_layout Plain Layout
18583 \begin_inset Flex Code
18586 \begin_layout Plain Layout
18594 \begin_inset Flex Code
18597 \begin_layout Plain Layout
18605 \begin_inset Flex Code
18608 \begin_layout Plain Layout
18616 \begin_inset Flex Code
18619 \begin_layout Plain Layout
18627 \begin_inset Flex Code
18630 \begin_layout Plain Layout
18638 \begin_inset Flex Code
18641 \begin_layout Plain Layout
18649 \begin_inset Flex Code
18652 \begin_layout Plain Layout
18660 \begin_inset Flex Code
18663 \begin_layout Plain Layout
18671 \begin_inset Flex Code
18674 \begin_layout Plain Layout
18682 \begin_inset Flex Code
18685 \begin_layout Plain Layout
18693 \begin_inset Flex Code
18696 \begin_layout Plain Layout
18704 \begin_inset Flex Code
18707 \begin_layout Plain Layout
18715 \begin_inset Flex Code
18718 \begin_layout Plain Layout
18726 \begin_inset Flex Code
18729 \begin_layout Plain Layout
18737 \begin_inset Flex Code
18740 \begin_layout Plain Layout
18749 \begin_layout Enumerate
18750 The layout for a Flex inset is being defined.
18753 \begin_inset Flex Code
18756 \begin_layout Plain Layout
18762 must be of the form
18763 \begin_inset Quotes eld
18767 \begin_inset Flex Code
18770 \begin_layout Plain Layout
18777 \begin_inset Quotes erd
18782 \begin_inset Flex Code
18785 \begin_layout Plain Layout
18791 may be any valid identifier not used by a pre-existing Flex inset.
18792 The identifier may include spaces,
18793 but in that case the whole thing must be wrapped in quotes.
18794 Note that the definition of a flex inset
18799 \begin_inset Flex Code
18802 \begin_layout Plain Layout
18809 declaring which type of inset it defines.
18812 \begin_layout Enumerate
18813 The layout for user specific branch is being defined.
18816 \begin_inset Flex Code
18819 \begin_layout Plain Layout
18825 must be of the form
18826 \begin_inset Quotes eld
18830 \begin_inset Flex Code
18833 \begin_layout Plain Layout
18840 \begin_inset Quotes erd
18845 \begin_inset Flex Code
18848 \begin_layout Plain Layout
18854 may be any valid identifier of branch defined in user's document.
18855 The identifier may include spaces,
18856 but in that case the whole thing must be wrapped in quotes.
18857 The main purpose of this feature is to allow \SpecialChar LaTeX
18858 wrapping around specific branches as user needs.
18861 \begin_layout Enumerate
18862 The layout of a user (or class) specific caption is being defined.
18865 \begin_inset Flex Code
18868 \begin_layout Plain Layout
18874 must be of the form
18875 \begin_inset Quotes eld
18879 \begin_inset Flex Code
18882 \begin_layout Plain Layout
18889 \begin_inset Quotes erd
18894 \begin_inset Flex Code
18897 \begin_layout Plain Layout
18903 specifies the name of the caption as it appears in the menu.
18904 Have a look at the standard caption (
18905 \begin_inset Flex Code
18908 \begin_layout Plain Layout
18915 the specific captions of the KOMA-Script classes (
18916 \begin_inset Flex Code
18919 \begin_layout Plain Layout
18927 \begin_inset Flex Code
18930 \begin_layout Plain Layout
18939 \begin_inset space ~
18943 \begin_inset Newline linebreak
18949 \begin_inset Flex Code
18952 \begin_layout Plain Layout
18958 ) for applications.
18961 \begin_layout Standard
18963 \begin_inset Flex Code
18966 \begin_layout Plain Layout
18972 definition can contain the following entries:
18975 \begin_layout Description
18976 \begin_inset Flex Code
18979 \begin_layout Plain Layout
18986 \begin_inset Flex Code
18989 \begin_layout Plain Layout
18995 =""] This inset will appear in the table of contents of the given type.
18996 An empty string disables.
18997 See also the OutlinerName and the IsTocCaption commands.
18998 This is only implemented for Flex insets.
19003 \begin_layout Description
19004 \begin_inset Flex Code
19007 \begin_layout Plain Layout
19013 Includes a comma-separated list of insets to which this inset can be inserted.
19015 \begin_inset Quotes eld
19019 \begin_inset Flex Code
19022 \begin_layout Plain Layout
19029 \begin_inset Quotes erd
19033 If you you also want the insertion to be allowed in specific arguments of the target insets,
19034 append the argument name after @ (e.
19035 \begin_inset space \thinspace{}
19040 \begin_inset Flex Code
19043 \begin_layout Plain Layout
19050 Note that this currently only supports immediately containing insets (no deeper nesting).
19052 \begin_inset Flex Code
19055 \begin_layout Plain Layout
19064 \begin_layout Description
19065 \begin_inset Flex Code
19068 \begin_layout Plain Layout
19074 Includes a comma-separated list of layouts within which this inset can be inserted.
19076 \begin_inset Quotes eld
19080 \begin_inset Flex Code
19083 \begin_layout Plain Layout
19084 EndAllowedInLayouts
19090 \begin_inset Quotes erd
19094 Note that this currently only supports immediately containing layouts (no deeper nesting).
19096 \begin_inset Flex Code
19099 \begin_layout Plain Layout
19108 \begin_layout Description
19109 \begin_inset Flex Code
19112 \begin_layout Plain Layout
19119 \begin_inset Flex Code
19122 \begin_layout Plain Layout
19129 \begin_inset Flex Code
19132 \begin_layout Plain Layout
19139 \begin_inset Flex Code
19142 \begin_layout Plain Layout
19149 this can be used to determine how many times the inset can be inserted to a given inset or the paragraph (group).
19152 \begin_layout Description
19153 \begin_inset Flex Code
19156 \begin_layout Plain Layout
19157 AllowedOccurrencesPerItem
19163 \begin_inset Flex Code
19166 \begin_layout Plain Layout
19175 \begin_inset space \thinspace{}
19179 \begin_inset Flex Code
19182 \begin_layout Plain Layout
19188 ] If this is set to true,
19190 \begin_inset Flex Code
19193 \begin_layout Plain Layout
19199 applies to single paragraphs if we are in a list-type environment (with
19200 \begin_inset Flex Code
19203 \begin_layout Plain Layout
19214 \begin_layout Description
19215 \begin_inset Flex Code
19218 \begin_layout Plain Layout
19225 \begin_inset Flex Code
19228 \begin_layout Plain Layout
19234 ] Defines argument number of a command\SpecialChar breakableslash
19235 environment associated with the current layout.
19236 The definition must end with
19237 \begin_inset Flex Code
19240 \begin_layout Plain Layout
19248 \begin_inset CommandInset ref
19250 reference "subsec:Arguments"
19258 for more information.
19261 \begin_layout Description
19262 \begin_inset Flex Code
19265 \begin_layout Plain Layout
19271 Preamble for changing language commands;
19273 \begin_inset CommandInset ref
19275 reference "subsec:I18n"
19283 \begin_layout Description
19284 \begin_inset Flex Code
19287 \begin_layout Plain Layout
19294 \begin_inset Flex Code
19297 \begin_layout Plain Layout
19303 ] The color for the inset's background.
19305 \begin_inset CommandInset ref
19307 reference "chap:Names-of-colors"
19312 for a list of the available color names.
19315 \begin_layout Description
19316 \begin_inset Flex Code
19319 \begin_layout Plain Layout
19326 \begin_inset Flex Code
19329 \begin_layout Plain Layout
19338 \begin_inset space \thinspace{}
19342 \begin_inset Flex Code
19345 \begin_layout Plain Layout
19351 ] Whether to use the content of the inset as the label,
19352 when the inset is closed.
19356 \begin_layout Description
19357 \begin_inset Flex Code
19360 \begin_layout Plain Layout
19367 \begin_inset Flex Code
19370 \begin_layout Plain Layout
19376 ] As with paragraph styles,
19378 \begin_inset CommandInset ref
19380 reference "subsec:Paragraph-Styles"
19386 Note that you need to specify the complete type,
19388 \begin_inset space \thinspace{}
19392 \begin_inset space ~
19396 \begin_inset Flex Code
19399 \begin_layout Plain Layout
19400 CopyStyle Flex:<name>
19408 \begin_layout Description
19409 \begin_inset Flex Code
19412 \begin_layout Plain Layout
19419 \begin_inset Flex Code
19422 \begin_layout Plain Layout
19431 \begin_inset space \thinspace{}
19435 \begin_inset Flex Code
19438 \begin_layout Plain Layout
19444 ] Indicates whether the user may employ the Paragraph Settings dialog to customize the paragraph.
19447 \begin_layout Description
19448 \begin_inset Flex Code
19451 \begin_layout Plain Layout
19458 \begin_inset Flex Code
19461 \begin_layout Plain Layout
19469 \begin_inset Flex Code
19472 \begin_layout Plain Layout
19480 \begin_inset Flex Code
19483 \begin_layout Plain Layout
19490 describing the rendering style used for the inset's frame and buttons.
19491 Footnotes generally use
19492 \begin_inset Flex Code
19495 \begin_layout Plain Layout
19502 ERT insets generally
19503 \begin_inset Flex Code
19506 \begin_layout Plain Layout
19513 and character styles
19514 \begin_inset Flex Code
19517 \begin_layout Plain Layout
19526 \begin_layout Description
19527 \begin_inset Flex Code
19530 \begin_layout Plain Layout
19537 \begin_inset Flex Code
19540 \begin_layout Plain Layout
19549 \begin_inset space \thinspace{}
19555 \begin_inset Flex Code
19558 \begin_layout Plain Layout
19567 \begin_inset Flex Code
19570 \begin_layout Plain Layout
19577 \begin_inset Flex Code
19580 \begin_layout Plain Layout
19587 Indicates whether the environment will stand on its own in the output or will appear inline with the surrounding text.
19589 it is supposed that the \SpecialChar LaTeX
19590 environment ignores white space (including one newline character) after the
19591 \begin_inset Flex Code
19594 \begin_layout Plain Layout
19607 \begin_inset Flex Code
19610 \begin_layout Plain Layout
19626 \begin_layout Description
19627 \begin_inset Flex Code
19630 \begin_layout Plain Layout
19640 ,1] Allow the contents of the inset to be edited externally (using whatever editor is defined for the document's output format).
19643 \begin_layout Description
19644 \begin_inset Flex Code
19647 \begin_layout Plain Layout
19653 Required at the end of the
19654 \begin_inset Flex Code
19657 \begin_layout Plain Layout
19666 \begin_layout Description
19667 \begin_inset Flex Code
19670 \begin_layout Plain Layout
19676 The font used for both the text body
19682 \begin_inset CommandInset ref
19683 LatexCommand formatted
19684 reference "subsec:Font-description"
19690 Note that defining this font automatically defines the
19691 \begin_inset Flex Code
19694 \begin_layout Plain Layout
19701 so define this first and define
19702 \begin_inset Flex Code
19705 \begin_layout Plain Layout
19711 later if you want them to be different.
19714 \begin_layout Description
19715 \begin_inset Flex Code
19718 \begin_layout Plain Layout
19719 FixedWidthPreambleEncoding
19725 \begin_inset Flex Code
19728 \begin_layout Plain Layout
19737 \begin_inset space \thinspace{}
19741 \begin_inset Flex Code
19744 \begin_layout Plain Layout
19750 ] Force a fixed width encoding for the translated contents of
19751 \begin_inset Flex Code
19754 \begin_layout Plain Layout
19761 \begin_inset Flex Code
19764 \begin_layout Plain Layout
19770 code generated by this layout.
19771 This is needed for special \SpecialChar LaTeX
19776 that do not work with variable width encodings such as
19781 This setting is ignored if fully Unicode aware \SpecialChar LaTeX
19782 backends such as Xe\SpecialChar TeX
19783 or Lua\SpecialChar TeX
19787 \begin_layout Description
19788 \begin_inset Flex Code
19791 \begin_layout Plain Layout
19792 ForceLocalFontSwitch
19798 \begin_inset Flex Code
19801 \begin_layout Plain Layout
19810 \begin_inset space \thinspace{}
19814 \begin_inset Flex Code
19817 \begin_layout Plain Layout
19823 ] When using babel,
19824 always use a local font switch (
19825 \begin_inset Flex Code
19828 \begin_layout Plain Layout
19837 never a global one (such as
19838 \begin_inset Flex Code
19841 \begin_layout Plain Layout
19852 \begin_layout Description
19853 \begin_inset Flex Code
19856 \begin_layout Plain Layout
19863 \begin_inset Flex Code
19866 \begin_layout Plain Layout
19875 \begin_inset space \thinspace{}
19879 \begin_inset Flex Code
19882 \begin_layout Plain Layout
19889 \begin_inset Quotes eld
19893 \begin_inset Quotes erd
19897 leading to Left-to-Right (Latin) output,
19899 \begin_inset space \thinspace{}
19903 \begin_inset space \space{}
19906 in \SpecialChar TeX
19911 \begin_layout Description
19912 \begin_inset Flex Code
19915 \begin_layout Plain Layout
19922 \begin_inset Flex Code
19925 \begin_layout Plain Layout
19934 \begin_inset space \thinspace{}
19938 \begin_inset Flex Code
19941 \begin_layout Plain Layout
19947 ] Force a line break in the \SpecialChar LaTeX
19948 output before the inset starts and after the inset ends.
19949 This assures the inset itself is output on its own lines,
19950 for parsing purposes.
19953 \begin_layout Description
19954 \begin_inset Flex Code
19957 \begin_layout Plain Layout
19964 \begin_inset Flex Code
19967 \begin_layout Plain Layout
19976 \begin_inset space \thinspace{}
19980 \begin_inset Flex Code
19983 \begin_layout Plain Layout
19989 ] Indicates whether the
19990 \begin_inset Flex Code
19993 \begin_layout Plain Layout
20001 the user can change the paragraph style used in the inset.
20005 \begin_layout Description
20006 \begin_inset Flex Code
20009 \begin_layout Plain Layout
20016 \begin_inset Flex Code
20019 \begin_layout Plain Layout
20028 \begin_inset space \thinspace{}
20032 \begin_inset Flex Code
20035 \begin_layout Plain Layout
20041 ] As with paragraph styles,
20043 \begin_inset CommandInset ref
20045 reference "subsec:Paragraph-Styles"
20053 \begin_layout Description
20054 \begin_inset Flex Code
20057 \begin_layout Plain Layout
20063 These tags control the XHTML output.
20065 \begin_inset CommandInset ref
20067 reference "sec:Tags-for-XHTML"
20075 \begin_layout Description
20076 \begin_inset Flex Code
20079 \begin_layout Plain Layout
20086 \begin_inset Flex Code
20089 \begin_layout Plain Layout
20096 \begin_inset space \thinspace{}
20100 \begin_inset Flex Code
20103 \begin_layout Plain Layout
20111 ] The font inside the inset is inherited from the parent for \SpecialChar LaTeX
20112 export if this parameter is 1,
20113 as well as on screen.
20114 Otherwise the document default font is used.
20117 \begin_layout Description
20118 \begin_inset Flex Code
20121 \begin_layout Plain Layout
20128 \begin_inset Flex Code
20131 \begin_layout Plain Layout
20140 \begin_inset space \thinspace{}
20144 \begin_inset Flex Code
20147 \begin_layout Plain Layout
20153 ] Whether to include the contents of this inset in the strings generated for the `Outline' pane for all table of contents,
20154 regardless of the AddToToc setting.
20157 want the content of a footnote in a section header to be included in the TOC displayed in the outline,
20158 but one would normally want the content of a character style displayed.
20163 \begin_layout Description
20164 \begin_inset Flex Code
20167 \begin_layout Plain Layout
20174 \begin_inset Flex Code
20177 \begin_layout Plain Layout
20186 \begin_inset space \thinspace{}
20190 \begin_inset Flex Code
20193 \begin_layout Plain Layout
20199 ] If this is set to 1 and AddToToc is enabled,
20200 the inset adds a summary of its contents in its item in the table of contents.
20202 only the label appears.
20205 \begin_layout Description
20206 \begin_inset Flex Code
20209 \begin_layout Plain Layout
20218 \begin_inset Flex Code
20221 \begin_layout Plain Layout
20230 \begin_inset space \thinspace{}
20234 \begin_inset Flex Code
20237 \begin_layout Plain Layout
20243 ] As with paragraph styles,
20245 \begin_inset CommandInset ref
20247 reference "subsec:Paragraph-Styles"
20255 \begin_layout Description
20256 \begin_inset Flex Code
20259 \begin_layout Plain Layout
20265 The font used for the label.
20267 \begin_inset CommandInset ref
20269 reference "subsec:Font-description"
20275 Note that this definition can never appear before
20276 \begin_inset Flex Code
20279 \begin_layout Plain Layout
20286 lest it be ineffective.
20289 \begin_layout Description
20290 \begin_inset Flex Code
20293 \begin_layout Plain Layout
20300 \begin_inset Flex Code
20303 \begin_layout Plain Layout
20310 \begin_inset Quotes erd
20314 \begin_inset Quotes erd
20317 ] What will be displayed on the button or elsewhere as the inset label.
20319 \begin_inset Flex Code
20322 \begin_layout Plain Layout
20330 \begin_inset Flex Code
20333 \begin_layout Plain Layout
20339 ) modify this label on the fly.
20342 \begin_layout Description
20343 \begin_inset Flex Code
20346 \begin_layout Plain Layout
20352 Language dependent preamble;
20354 \begin_inset CommandInset ref
20356 reference "subsec:I18n"
20364 \begin_layout Description
20365 \begin_inset Flex Code
20368 \begin_layout Plain Layout
20375 \begin_inset Flex Code
20378 \begin_layout Plain Layout
20384 ] The name of the corresponding \SpecialChar LaTeX
20386 Either the environment or command name.
20389 \begin_layout Description
20390 \begin_inset Flex Code
20393 \begin_layout Plain Layout
20400 \begin_inset Flex Code
20403 \begin_layout Plain Layout
20409 ] The optional parameter for the corresponding
20410 \begin_inset Flex Code
20413 \begin_layout Plain Layout
20420 including possible bracket pairs like
20421 \begin_inset Flex Code
20424 \begin_layout Plain Layout
20431 This parameter cannot be changed from within \SpecialChar LyX
20433 \begin_inset Flex Code
20436 \begin_layout Plain Layout
20442 for customizable parameters).
20443 It will be output as is after all \SpecialChar LaTeX
20445 \begin_inset Flex Code
20448 \begin_layout Plain Layout
20457 \begin_layout Description
20458 \begin_inset Flex Code
20461 \begin_layout Plain Layout
20468 \begin_inset Flex Code
20471 \begin_layout Plain Layout
20479 ] How the style should be translated into \SpecialChar LaTeX
20484 \begin_layout Plain Layout
20485 \begin_inset Flex Code
20488 \begin_layout Plain Layout
20494 is perhaps a bit misleading,
20495 since these rules apply to SGML classes too.
20496 Visit the SGML class files for specific examples.
20505 \begin_layout Description
20506 \begin_inset Flex Code
20509 \begin_layout Plain Layout
20515 means nothing special
20518 \begin_layout Description
20519 \begin_inset Flex Code
20522 \begin_layout Plain Layout
20529 \begin_inset Flex Code
20532 \begin_layout Plain Layout
20539 {\SpecialChar ldots
20548 \begin_layout Description
20549 \begin_inset Flex Code
20552 \begin_layout Plain Layout
20559 \begin_inset Flex Code
20562 \begin_layout Plain Layout
20569 }\SpecialChar ldots
20584 \begin_layout Standard
20585 Putting the last few things together,
20586 the \SpecialChar LaTeX
20587 output will be either:
20591 \begin_layout LyX-Code
20594 LatexName[LatexParam]{\SpecialChar ldots
20598 \begin_layout Standard
20603 \begin_layout LyX-Code
20606 begin{LatexName}[LatexParam] \SpecialChar ldots
20612 \begin_layout Standard
20613 depending upon the \SpecialChar LaTeX
20618 \begin_layout Description
20619 \begin_inset Flex Code
20622 \begin_layout Plain Layout
20629 \begin_inset Flex Code
20632 \begin_layout Plain Layout
20638 ] A string that is put at the beginning of the layout content.
20639 A line break in the output can be indicated by
20640 \begin_inset Flex Code
20643 \begin_layout Plain Layout
20652 \begin_layout Description
20653 \begin_inset Flex Code
20656 \begin_layout Plain Layout
20663 \begin_inset Flex Code
20666 \begin_layout Plain Layout
20674 \begin_inset Flex Code
20677 \begin_layout Plain Layout
20685 \begin_inset Flex Code
20688 \begin_layout Plain Layout
20694 (indicating a dummy definition ending definitions of charstyles,
20696 This entry is required in and is only meaningful for Flex insets.
20697 Among other things,
20698 it determines on which menu this inset will appear.
20700 \begin_inset Flex Code
20703 \begin_layout Plain Layout
20710 \begin_inset Flex Code
20713 \begin_layout Plain Layout
20719 will automatically set
20720 \begin_inset Flex Code
20723 \begin_layout Plain Layout
20730 \begin_inset Flex Code
20733 \begin_layout Plain Layout
20741 \begin_inset Flex Code
20744 \begin_layout Plain Layout
20750 can be set to true,
20752 \begin_inset Flex Code
20755 \begin_layout Plain Layout
20763 \begin_inset Flex Code
20766 \begin_layout Plain Layout
20772 insets by setting it
20777 \begin_inset Flex Code
20780 \begin_layout Plain Layout
20789 \begin_layout Description
20790 \begin_inset Flex Code
20793 \begin_layout Plain Layout
20800 \begin_inset Flex Code
20803 \begin_layout Plain Layout
20809 A dedicated string for the menu.
20810 You can define an accelerator by appending the respective character to the string,
20812 \begin_inset Quotes eld
20816 \begin_inset Quotes erd
20820 \begin_inset space \thinspace{}
20824 \begin_inset space \space{}
20828 \begin_inset Quotes eld
20832 \begin_inset Flex Code
20835 \begin_layout Plain Layout
20842 \begin_inset Quotes erd
20846 This specification is optional.
20847 If it is not given the inset name as specified in the type declaration will be used instead for the menu.
20850 \begin_layout Description
20851 \begin_inset Flex Code
20854 \begin_layout Plain Layout
20861 \begin_inset Flex Code
20864 \begin_layout Plain Layout
20873 \begin_inset space \thinspace{}
20877 \begin_inset Flex Code
20880 \begin_layout Plain Layout
20886 ] Whether multiple paragraphs are permitted in this inset.
20888 \begin_inset Flex Code
20891 \begin_layout Plain Layout
20897 to the same value and
20898 \begin_inset Flex Code
20901 \begin_layout Plain Layout
20907 to the opposite value.
20908 These can be reset to other values,
20914 \begin_inset Flex Code
20917 \begin_layout Plain Layout
20927 \begin_layout Description
20928 \begin_inset Flex Code
20931 \begin_layout Plain Layout
20938 \begin_inset Flex Code
20941 \begin_layout Plain Layout
20950 \begin_inset space \thinspace{}
20954 \begin_inset Flex Code
20957 \begin_layout Plain Layout
20963 ] Whether fragile commands in this inset should be
20964 \begin_inset Flex Code
20967 \begin_layout Plain Layout
20981 whether the command should itself be protected.) Default is false.
20984 \begin_layout Description
20985 \begin_inset Flex Code
20988 \begin_layout Plain Layout
20995 \change_inserted -712698321 1715685021
20997 \begin_inset Flex Code
21000 \begin_layout Plain Layout
21002 \change_inserted -712698321 1715685023
21014 \begin_inset Flex Code
21017 \begin_layout Plain Layout
21026 \begin_inset space \thinspace{}
21030 \begin_inset Flex Code
21033 \begin_layout Plain Layout
21040 \change_deleted -712698321 1715685030
21042 \change_inserted -712698321 1715685031
21044 \begin_inset Flex Code
21047 \begin_layout Plain Layout
21049 \change_inserted -712698321 1715685031
21059 causes macros that contain this inset to be protected with
21060 \begin_inset Flex Code
21063 \begin_layout Plain Layout
21076 ) if necessary and thus allows (some) verbatim stuff in macros.
21079 \change_inserted -712698321 1715685049
21080 With the default setting (value
21081 \begin_inset Flex Code
21084 \begin_layout Plain Layout
21086 \change_inserted -712698321 1715685008
21096 \begin_inset Flex Code
21099 \begin_layout Plain Layout
21101 \change_inserted -712698321 1715685008
21111 is used if a nested element requires it.
21113 \begin_inset Flex Code
21116 \begin_layout Plain Layout
21118 \change_inserted -712698321 1715685008
21126 prevents any use of
21127 \begin_inset Flex Code
21130 \begin_layout Plain Layout
21132 \change_inserted -712698321 1715685008
21143 even if required by a nested element.
21148 \begin_layout Description
21149 \begin_inset Flex Code
21152 \begin_layout Plain Layout
21159 \begin_inset Flex Code
21162 \begin_layout Plain Layout
21171 \begin_inset space \thinspace{}
21175 \begin_inset Flex Code
21178 \begin_layout Plain Layout
21184 ] Whether specific commands in this inset (such as
21185 \begin_inset Flex Code
21188 \begin_layout Plain Layout
21197 \begin_inset Flex Code
21200 \begin_layout Plain Layout
21208 ) should be protected in an
21209 \begin_inset Flex Code
21212 \begin_layout Plain Layout
21221 This is particularly needed for insets that draw on
21229 commands which parse their content in complex ways.
21233 \begin_layout Description
21234 \begin_inset Flex Code
21237 \begin_layout Plain Layout
21244 \begin_inset Flex Code
21247 \begin_layout Plain Layout
21253 Option to define a different command (from the default
21254 \begin_inset Flex Code
21257 \begin_layout Plain Layout
21267 ) to be used for line breaks.
21268 The initial backslash must not be specified.
21271 \begin_layout Description
21272 \begin_inset Flex Code
21275 \begin_layout Plain Layout
21282 \begin_inset Flex Code
21285 \begin_layout Plain Layout
21291 ] Deletes an existing
21292 \begin_inset Flex Code
21295 \begin_layout Plain Layout
21302 \change_inserted -712698321 1715512954
21306 \begin_layout Description
21308 \change_inserted -712698321 1715512954
21309 \begin_inset Flex Code
21312 \begin_layout Plain Layout
21314 \change_inserted -712698321 1715512954
21323 \begin_inset Flex Code
21326 \begin_layout Plain Layout
21328 \change_inserted -712698321 1715512954
21340 Defines individual characters that should
21344 be output in raw form (without special translations that \SpecialChar LaTeX
21346 even if such handling is requested by an element in this layout.
21347 This tag can be used to overwrite
21348 \begin_inset Quotes els
21352 \begin_inset Quotes ers
21355 conditions if they are unsuitable in a given context.
21360 \begin_layout Description
21361 \begin_inset Flex Code
21364 \begin_layout Plain Layout
21371 \begin_inset Flex Code
21374 \begin_layout Plain Layout
21381 \begin_inset Flex Code
21384 \begin_layout Plain Layout
21390 that has replaced this
21391 \begin_inset Flex Code
21394 \begin_layout Plain Layout
21401 This is used to rename an
21402 \begin_inset Flex Code
21405 \begin_layout Plain Layout
21412 while keeping backward compatibility.
21415 \begin_layout Description
21416 \begin_inset Flex Code
21419 \begin_layout Plain Layout
21426 \begin_inset Flex Code
21429 \begin_layout Plain Layout
21438 \begin_inset space \thinspace{}
21442 \begin_inset Flex Code
21445 \begin_layout Plain Layout
21451 ] If this is set to
21452 \begin_inset Flex Code
21455 \begin_layout Plain Layout
21462 paragraph breaks will be ignored in the output.
21463 This might be useful for insets where the content should be alignable on different lines only in the \SpecialChar LyX
21465 without any effect in the output.
21468 \begin_layout Description
21469 \begin_inset Flex Code
21472 \begin_layout Plain Layout
21479 \begin_inset Flex Code
21482 \begin_layout Plain Layout
21491 \begin_inset space \thinspace{}
21495 \begin_inset Flex Code
21498 \begin_layout Plain Layout
21504 ] As with paragraph styles,
21506 \begin_inset CommandInset ref
21508 reference "subsec:Paragraph-Styles"
21517 \begin_layout Description
21518 \begin_inset Flex Code
21521 \begin_layout Plain Layout
21528 \begin_inset Flex Code
21531 \begin_layout Plain Layout
21540 \begin_inset space \thinspace{}
21544 \begin_inset Flex Code
21547 \begin_layout Plain Layout
21553 ] As with paragraph styles,
21555 \begin_inset CommandInset ref
21557 reference "subsec:Paragraph-Styles"
21566 \begin_layout Description
21567 \begin_inset Flex Code
21570 \begin_layout Plain Layout
21576 As with paragraph styles,
21578 \begin_inset CommandInset ref
21580 reference "subsec:Paragraph-Styles"
21588 \begin_layout Description
21589 \begin_inset Flex Code
21592 \begin_layout Plain Layout
21599 \begin_inset Flex Code
21602 \begin_layout Plain Layout
21608 ] The prefix to use when creating labels referring to insets of this type.
21609 This allows the use of formatted references.
21612 \begin_layout Description
21613 \begin_inset Flex Code
21616 \begin_layout Plain Layout
21623 \begin_inset Flex Code
21626 \begin_layout Plain Layout
21632 ] As with paragraph styles,
21634 \begin_inset CommandInset ref
21636 reference "subsec:Paragraph-Styles"
21644 \begin_layout Description
21645 \begin_inset Flex Code
21648 \begin_layout Plain Layout
21655 \begin_inset Flex Code
21658 \begin_layout Plain Layout
21667 \begin_inset space \thinspace{}
21671 \begin_inset Flex Code
21674 \begin_layout Plain Layout
21680 ] Resets the \SpecialChar LaTeX
21681 arguments of this layout (as defined via the
21682 \begin_inset Flex Code
21685 \begin_layout Plain Layout
21692 This is useful if you have copied a style via
21693 \begin_inset Flex Code
21696 \begin_layout Plain Layout
21703 but you do not want to inherit its (required and optional) arguments.
21706 \begin_layout Description
21707 \begin_inset Flex Code
21710 \begin_layout Plain Layout
21717 \begin_inset Flex Code
21720 \begin_layout Plain Layout
21729 \begin_inset space \thinspace{}
21733 \begin_inset Flex Code
21736 \begin_layout Plain Layout
21743 \begin_inset Flex Code
21746 \begin_layout Plain Layout
21753 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.
21754 \begin_inset space \thinspace{}
21759 \begin_inset Flex Code
21762 \begin_layout Plain Layout
21765 textbf{Sourrounding text
21769 textbf{content}}\SpecialChar ldots
21776 \begin_inset Flex Code
21779 \begin_layout Plain Layout
21782 textbf{Sourrounding text
21784 myinset{content}\SpecialChar ldots
21791 Setting this makes sense for commands that internally reset font settings (e.
21792 \begin_inset space \thinspace{}
21797 Note that wrongly setting this might lead to unwanted result (e.
21798 \begin_inset space \thinspace{}
21803 \begin_inset Flex Code
21806 \begin_layout Plain Layout
21809 emph{Sourrounding text
21813 emph{content}}\SpecialChar ldots
21820 content is upright,
21822 \begin_inset Flex Code
21825 \begin_layout Plain Layout
21835 \begin_inset Flex Code
21838 \begin_layout Plain Layout
21845 font changes are not redone inside the inset.
21848 \begin_layout Description
21849 \begin_inset Flex Code
21852 \begin_layout Plain Layout
21859 \begin_inset Flex Code
21862 \begin_layout Plain Layout
21868 ] A string that is put at the end of the layout content.
21869 A line break in the output can be indicated by
21870 \begin_inset Flex Code
21873 \begin_layout Plain Layout
21882 \begin_layout Description
21883 \begin_inset Flex Code
21886 \begin_layout Plain Layout
21893 \begin_inset Flex Code
21896 \begin_layout Plain Layout
21903 \begin_inset space \thinspace{}
21907 \begin_inset Flex Code
21910 \begin_layout Plain Layout
21918 ] Allow spell-checking the contents of this inset.
21922 \begin_layout Subsection
21924 \begin_inset CommandInset label
21926 name "subsec:Arguments"
21933 \begin_layout Standard
21934 Both paragraph styles and inset layouts allow for
21938 as well as the main content.
21939 This is especially useful for things like section headings and only makes sense with \SpecialChar LaTeX
21941 Each (optional or required) argument of a command or environment—
21942 except for the required argument that is associated with the content—
21943 has a separate definition,
21944 where the number specifies the order of the arguments.
21945 The definition must end with
21946 \begin_inset Flex Code
21949 \begin_layout Plain Layout
21956 So a command with two optional arguments looks like:
21959 \begin_layout Quote
21965 \begin_layout Quote
21971 \begin_layout Quote
21977 \begin_layout Quote
21983 \begin_layout Quote
21989 \begin_layout Quote
21995 \begin_layout Standard
21997 \begin_inset Flex Code
22000 \begin_layout Plain Layout
22007 the following specifications are possible:
22010 \begin_layout Itemize
22011 \begin_inset Flex Code
22014 \begin_layout Plain Layout
22021 \begin_inset Flex Code
22024 \begin_layout Plain Layout
22030 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
22031 \begin_inset Flex Code
22034 \begin_layout Plain Layout
22042 you can define an accelerator by appending the respective character to the string,
22044 \begin_inset Quotes eld
22048 \begin_inset Quotes erd
22052 \begin_inset space \thinspace{}
22056 \begin_inset space \space{}
22060 \begin_inset Quotes eld
22064 \begin_inset Flex Code
22067 \begin_layout Plain Layout
22074 \begin_inset Quotes erd
22080 \begin_layout Itemize
22081 \begin_inset Flex Code
22084 \begin_layout Plain Layout
22091 \begin_inset Flex Code
22094 \begin_layout Plain Layout
22100 A separate string for the menu.
22101 You can define an accelerator by appending the respective character to the string,
22103 \begin_inset Quotes eld
22107 \begin_inset Quotes erd
22111 \begin_inset space \thinspace{}
22115 \begin_inset space \space{}
22119 \begin_inset Quotes eld
22123 \begin_inset Flex Code
22126 \begin_layout Plain Layout
22133 \begin_inset Quotes erd
22137 This specification is optional.
22138 If it is not given the
22139 \begin_inset Flex Code
22142 \begin_layout Plain Layout
22148 will be used instead for the menu.
22151 \begin_layout Itemize
22152 \begin_inset Flex Code
22155 \begin_layout Plain Layout
22162 \begin_inset Flex Code
22165 \begin_layout Plain Layout
22171 A longer explanatory text that appears in the tooltip when hovering over the argument inset.
22174 \begin_layout Itemize
22175 \begin_inset Flex Code
22178 \begin_layout Plain Layout
22185 \begin_inset Flex Code
22188 \begin_layout Plain Layout
22197 \begin_inset space \thinspace{}
22201 \begin_inset Flex Code
22204 \begin_layout Plain Layout
22210 ] Declare if this is a mandatory (1) or an optional (0) argument.
22211 Mandatory arguments will be output empty if not given,
22212 while optional arguments will not be output at all.
22214 mandatory arguments are delimited by
22215 \begin_inset Flex Code
22218 \begin_layout Plain Layout
22225 while optional arguments are delimited by
22226 \begin_inset Flex Code
22229 \begin_layout Plain Layout
22238 \begin_layout Itemize
22239 \begin_inset Flex Code
22242 \begin_layout Plain Layout
22249 \begin_inset Flex Code
22252 \begin_layout Plain Layout
22258 Option to define a different command (from the default
22259 \begin_inset Flex Code
22262 \begin_layout Plain Layout
22272 ) to be used for line breaks.
22273 The initial backslash must not be specified.
22276 \begin_layout Itemize
22277 \begin_inset Flex Code
22280 \begin_layout Plain Layout
22287 \begin_inset Flex Code
22290 \begin_layout Plain Layout
22296 defines another argument or arguments (by their number) which this argument requires to be output if it is itself output.
22298 \begin_inset space \thinspace{}
22302 in \SpecialChar LaTeX
22304 optional arguments often require previous optional arguments to be output (at least empty),
22306 \begin_inset Flex Code
22309 \begin_layout Plain Layout
22312 command[][argument]{text}
22318 This can be achieved by the statement
22319 \begin_inset Flex Code
22322 \begin_layout Plain Layout
22329 \begin_inset Flex Code
22332 \begin_layout Plain Layout
22339 If multiple arguments are required,
22340 separate them by comma (e.g.,
22342 \begin_inset Flex Code
22345 \begin_layout Plain Layout
22354 \begin_layout Itemize
22355 \begin_inset Flex Code
22358 \begin_layout Plain Layout
22365 \begin_inset Flex Code
22368 \begin_layout Plain Layout
22374 defines a custom left delimiter (instead of
22375 \begin_inset Flex Code
22378 \begin_layout Plain Layout
22385 \begin_inset Flex Code
22388 \begin_layout Plain Layout
22395 A line break in the output can be indicated by
22396 \begin_inset Flex Code
22399 \begin_layout Plain Layout
22408 \begin_layout Itemize
22409 \begin_inset Flex Code
22412 \begin_layout Plain Layout
22419 \begin_inset Flex Code
22422 \begin_layout Plain Layout
22428 defines a custom right delimiter (instead of
22429 \begin_inset Flex Code
22432 \begin_layout Plain Layout
22439 \begin_inset Flex Code
22442 \begin_layout Plain Layout
22449 A line break in the output can be indicated by
22450 \begin_inset Flex Code
22453 \begin_layout Plain Layout
22462 \begin_layout Itemize
22463 \begin_inset Flex Code
22466 \begin_layout Plain Layout
22473 \begin_inset Flex Code
22476 \begin_layout Plain Layout
22482 defines an argument that is inserted if and only if no user-specified arguments were given,
22484 \begin_inset space \thinspace{}
22488 \begin_inset space \space{}
22491 if no argument inset has been inserted (note that also an empty argument inset omits the DefaultArg).
22492 Multiple arguments need to be separated by comma.
22495 \begin_layout Itemize
22496 \begin_inset Flex Code
22499 \begin_layout Plain Layout
22506 \begin_inset Flex Code
22509 \begin_layout Plain Layout
22515 defines an argument that is inserted in any case (alone or in addition to user-specified arguments).
22516 Multiple arguments need to be separated by comma.
22519 \begin_layout Itemize
22520 \begin_inset Flex Code
22523 \begin_layout Plain Layout
22529 The font used for the argument content,
22531 \begin_inset CommandInset ref
22533 reference "subsec:Font-description"
22541 \begin_layout Itemize
22542 \begin_inset Flex Code
22545 \begin_layout Plain Layout
22552 \begin_inset Flex Code
22555 \begin_layout Plain Layout
22564 \begin_inset space \thinspace{}
22568 \begin_inset Flex Code
22571 \begin_layout Plain Layout
22577 ] As with paragraph styles,
22579 \begin_inset CommandInset ref
22581 reference "subsec:Paragraph-Styles"
22589 \begin_layout Itemize
22590 \begin_inset Flex Code
22593 \begin_layout Plain Layout
22599 The font used for the label;
22601 \begin_inset CommandInset ref
22603 reference "subsec:Font-description"
22611 \begin_layout Itemize
22612 \begin_inset Flex Code
22615 \begin_layout Plain Layout
22622 \begin_inset Flex Code
22625 \begin_layout Plain Layout
22637 ] describes the rendering style used for the inset's frame and buttons.
22640 \begin_layout Itemize
22641 \begin_inset Flex Code
22644 \begin_layout Plain Layout
22651 \begin_inset Flex Code
22654 \begin_layout Plain Layout
22661 \begin_inset Flex Code
22664 \begin_layout Plain Layout
22671 this argument is automatically inserted when the respective style is selected.
22674 \begin_layout Itemize
22675 \begin_inset Flex Code
22678 \begin_layout Plain Layout
22685 \begin_inset Flex Code
22688 \begin_layout Plain Layout
22695 \begin_inset Flex Code
22698 \begin_layout Plain Layout
22705 this argument will be inserted on a new line with
22706 \begin_inset Flex Code
22709 \begin_layout Plain Layout
22715 (only available within Flex insets).
22718 \begin_layout Itemize
22719 \begin_inset Flex Code
22722 \begin_layout Plain Layout
22729 \begin_inset Flex Code
22732 \begin_layout Plain Layout
22739 \begin_inset Flex Code
22742 \begin_layout Plain Layout
22749 this argument will be inserted with a copy of the co-text (either selected text or the whole paragraph) as content.
22752 \begin_layout Itemize
22753 \begin_inset Flex Code
22756 \begin_layout Plain Layout
22763 \begin_inset Flex Code
22766 \begin_layout Plain Layout
22778 ] Whether the contents of this argument should be output in raw form,
22779 meaning without special translations that \SpecialChar LaTeX
22783 \begin_inset Flex Code
22786 \begin_layout Plain Layout
22792 status is inherited by the inset or paragraph layout the argument belongs to,
22793 true and false change the status for the given argument only.
22796 \begin_layout Itemize
22797 \begin_inset Flex Code
22800 \begin_layout Plain Layout
22807 \begin_inset Flex Code
22810 \begin_layout Plain Layout
22811 string of characters
22820 Defines individual characters
22821 \begin_inset Newline linebreak
22824 that should be output in raw form,
22825 meaning without special translations that \SpecialChar LaTeX
22828 contrary to PassThru,
22829 this needs to be explicitly defined for arguments.
22831 arguments do not inherit PassThruChars from their parent inset or layout.
22834 \begin_layout Itemize
22835 \begin_inset Flex Code
22838 \begin_layout Plain Layout
22845 \begin_inset Flex Code
22848 \begin_layout Plain Layout
22857 \begin_inset space \thinspace{}
22861 \begin_inset Flex Code
22864 \begin_layout Plain Layout
22870 ] If this is set to 1,
22871 the argument will output its content in the corresponding item in the table of contents.
22875 \begin_layout Standard
22877 the text entered in the \SpecialChar LyX
22878 workarea in the respective layout is the last (mandatory) argument of a command if the
22879 \begin_inset Flex Code
22882 \begin_layout Plain Layout
22889 \begin_inset Flex Code
22892 \begin_layout Plain Layout
22900 arguments with the prefix
22901 \begin_inset Flex Code
22904 \begin_layout Plain Layout
22910 are output after this workarea argument.
22911 Note that post-argument numbering restarts at 1,
22912 so the first argument following the workarea argument is
22913 \begin_inset Flex Code
22916 \begin_layout Plain Layout
22923 Post-arguments are ignored in any other
22924 \begin_inset Flex Code
22927 \begin_layout Plain Layout
22934 \begin_inset Flex Code
22937 \begin_layout Plain Layout
22946 \begin_layout Standard
22948 \begin_inset Flex Code
22951 \begin_layout Plain Layout
22960 \begin_inset Flex Code
22963 \begin_layout Plain Layout
22972 \begin_inset Flex Code
22975 \begin_layout Plain Layout
22981 followed by the number (e.
22982 \begin_inset space \thinspace{}
22986 \begin_inset space \space{}
22990 \begin_inset Flex Code
22993 \begin_layout Plain Layout
23002 \begin_layout Standard
23004 there is a special argument type with the prefix
23005 \begin_inset Flex Code
23008 \begin_layout Plain Layout
23015 It is not really an argument,
23016 but uses the argument interface (thus,
23017 the prefix is also followed by a number,
23019 \begin_inset space \thinspace{}
23024 \begin_inset Flex Code
23027 \begin_layout Plain Layout
23028 Argument listpreamble:1
23034 As the name implies,
23035 it is targeted at lists such as
23055 Its content will be output at the list start,
23057 \begin_inset Flex Code
23060 \begin_layout Plain Layout
23069 on an own line (a place that is otherwise not accessible in \SpecialChar LyX
23072 users can insert redefinitions (of lengths etc.) to individual lists.
23074 these arguments do not have a delimiter.
23077 \begin_layout Subsection
23079 \begin_inset CommandInset label
23081 name "subsec:Counters"
23088 \begin_layout Standard
23089 It is necessary to define the counters (
23090 \begin_inset Flex Noun
23093 \begin_layout Plain Layout
23101 \begin_inset Flex Noun
23104 \begin_layout Plain Layout
23112 ) in the text class itself.
23113 The standard counters are defined in the file
23114 \begin_inset Flex Code
23117 \begin_layout Plain Layout
23124 so you may have to do no more than add
23127 \begin_layout LyX-Code
23128 Input stdcounters.inc
23131 \begin_layout Standard
23132 to your layout file to get them to work.
23133 But if you want to define custom counters,
23134 then you can do so.
23135 The counter declaration must begin with:
23138 \begin_layout LyX-Code
23139 Counter CounterName
23142 \begin_layout Standard
23144 \begin_inset Flex Code
23147 \begin_layout Plain Layout
23153 ' is replaced by the name of the counter.
23154 And it must end with
23155 \begin_inset Quotes eld
23159 \begin_inset Flex Code
23162 \begin_layout Plain Layout
23169 \begin_inset Quotes erd
23173 The following parameters can also be used:
23176 \begin_layout Description
23177 \begin_inset Flex Code
23180 \begin_layout Plain Layout
23187 \begin_inset Flex Code
23190 \begin_layout Plain Layout
23196 ] Sets the initial value for the counter,
23197 to which it will be reset whenever that happens.
23199 one will want the default,
23203 \begin_layout Description
23204 \begin_inset Flex Code
23207 \begin_layout Plain Layout
23214 \begin_inset Flex Code
23217 \begin_layout Plain Layout
23224 \begin_inset Quotes erd
23228 \begin_inset Quotes erd
23232 this string defines how the counter is displayed.
23233 Setting this value sets
23234 \begin_inset Flex Code
23237 \begin_layout Plain Layout
23238 LabelStringAppendix
23244 The following special constructs can be used in the string:
23248 \begin_layout Itemize
23249 \begin_inset Flex Code
23252 \begin_layout Plain Layout
23260 will be replaced by the expansion of the
23261 \begin_inset Flex Code
23264 \begin_layout Plain Layout
23271 \begin_inset Flex Code
23274 \begin_layout Plain Layout
23275 LabelStringAppendix
23281 \begin_inset Flex Code
23284 \begin_layout Plain Layout
23294 \begin_layout Itemize
23295 counter values can be expressed using \SpecialChar LaTeX
23297 \begin_inset Newline newline
23301 \begin_inset Flex Code
23304 \begin_layout Plain Layout
23322 \begin_inset Flex Code
23325 \begin_layout Plain Layout
23337 \begin_layout Plain Layout
23348 the situation is a bit more complicated:
23368 other than those described below will produce arabic numerals.
23369 It would not be surprising to see this change in the future.
23375 \begin_inset Flex Code
23378 \begin_layout Plain Layout
23387 3,\SpecialChar ldots
23390 \begin_inset Flex Code
23393 \begin_layout Plain Layout
23399 for lower-case letters:
23406 \begin_inset Flex Code
23409 \begin_layout Plain Layout
23415 for upper-case letters:
23422 \begin_inset Flex Code
23425 \begin_layout Plain Layout
23431 for lower-case roman numerals:
23438 \begin_inset Flex Code
23441 \begin_layout Plain Layout
23447 for upper-case roman numerals:
23450 III\SpecialChar ldots
23453 \begin_inset Flex Code
23456 \begin_layout Plain Layout
23462 for hebrew numerals.
23466 \begin_layout Standard
23467 If LabelString is not defined,
23468 a default value is constructed as follows:
23469 if the counter has a parent counter
23470 \begin_inset Flex Code
23473 \begin_layout Plain Layout
23480 \begin_inset Flex Code
23483 \begin_layout Plain Layout
23491 \begin_inset Newline newline
23495 \begin_inset Flex Code
23498 \begin_layout Plain Layout
23509 otherwise the string
23510 \begin_inset Flex Code
23513 \begin_layout Plain Layout
23524 \begin_layout Description
23525 \begin_inset Flex Code
23528 \begin_layout Plain Layout
23529 LabelStringAppendix
23535 \begin_inset Flex Code
23538 \begin_layout Plain Layout
23545 \begin_inset Quotes eld
23549 \begin_inset Quotes erd
23553 \begin_inset Flex Code
23556 \begin_layout Plain Layout
23563 but for use in the Appendix.
23566 \begin_layout Description
23567 \begin_inset Flex Code
23570 \begin_layout Plain Layout
23577 \begin_inset Flex Code
23580 \begin_layout Plain Layout
23587 \begin_inset Quotes eld
23591 \begin_inset Quotes erd
23594 ] The counter name as used in \SpecialChar LaTeX
23597 in \SpecialChar LyX
23599 there is a counter named `theorem',
23600 but it is output to \SpecialChar LaTeX
23604 \begin_layout Description
23605 \begin_inset Flex Code
23608 \begin_layout Plain Layout
23615 \begin_inset Flex Code
23618 \begin_layout Plain Layout
23625 \begin_inset Quotes erd
23629 \begin_inset Quotes erd
23632 ] A format for use with formatted references to this counter.
23634 one might want to have references to section numbers appear as
23635 \begin_inset Quotes eld
23639 \begin_inset Quotes erd
23643 The string may contain
23644 \begin_inset Quotes eld
23648 \begin_inset Quotes erd
23651 or a counter specification as in
23652 \begin_inset Flex Code
23655 \begin_layout Plain Layout
23662 The former will be replaced by the counter number itself.
23669 \begin_inset Flex Code
23672 \begin_layout Plain Layout
23682 (which might render as §2.7).
23685 \begin_layout Description
23686 \begin_inset Flex Code
23689 \begin_layout Plain Layout
23696 \begin_inset Flex Code
23699 \begin_layout Plain Layout
23707 \begin_inset Flex Code
23710 \begin_layout Plain Layout
23716 ] For use with `formatted references',
23717 specifically when a single counter is used with multiple sorts of styles.
23720 \begin_inset Flex Code
23723 \begin_layout Plain Layout
23729 counter is often used for all sorts of theorem-like environments:
23733 The first argument gives a prefix used in the labels (e.g.,
23735 \begin_inset Quotes eld
23739 \begin_inset Quotes erd
23743 \begin_inset Quotes eld
23747 \begin_inset Quotes erd
23751 and the second a formatting string,
23753 \begin_inset Flex Code
23756 \begin_layout Plain Layout
23763 \begin_inset Flex Code
23766 \begin_layout Plain Layout
23773 If this is not given,
23775 \begin_inset Flex Code
23778 \begin_layout Plain Layout
23787 \begin_layout Description
23788 \begin_inset Flex Code
23791 \begin_layout Plain Layout
23798 \begin_inset Flex Code
23801 \begin_layout Plain Layout
23808 \begin_inset Quotes erd
23812 \begin_inset Quotes erd
23815 ] If this is set to the name of another counter,
23816 the present counter will be reset every time the other one is increased.
23819 \begin_inset Flex Code
23822 \begin_layout Plain Layout
23829 \begin_inset Flex Code
23832 \begin_layout Plain Layout
23841 \begin_layout Subsection
23843 \begin_inset CommandInset label
23845 name "subsec:Font-description"
23852 \begin_layout Standard
23853 A font description looks like this:
23856 \begin_layout LyX-Code
23873 \begin_layout LyX-Code
23877 \begin_layout LyX-Code
23881 \begin_layout Standard
23882 The following commands are available:
23885 \begin_layout Description
23886 \begin_inset Flex Code
23889 \begin_layout Plain Layout
23896 \begin_inset Flex Code
23899 \begin_layout Plain Layout
23906 \begin_inset space ~
23910 \begin_inset CommandInset ref
23912 reference "chap:Names-of-colors"
23920 for valid arguments.
23923 \begin_layout Description
23924 \begin_inset Flex Code
23927 \begin_layout Plain Layout
23934 \begin_inset Flex Code
23937 \begin_layout Plain Layout
23947 \begin_inset Flex Code
23950 \begin_layout Plain Layout
23958 \begin_inset Flex Code
23961 \begin_layout Plain Layout
23970 \begin_layout Description
23971 \begin_inset Flex Code
23974 \begin_layout Plain Layout
23981 \begin_inset Flex Code
23984 \begin_layout Plain Layout
23990 ] Valid arguments are:
23992 \begin_inset Flex Code
23995 \begin_layout Plain Layout
24003 \begin_inset Flex Code
24006 \begin_layout Plain Layout
24014 \begin_inset Flex Code
24017 \begin_layout Plain Layout
24025 \begin_inset Flex Code
24028 \begin_layout Plain Layout
24036 \begin_inset Flex Code
24039 \begin_layout Plain Layout
24047 \begin_inset Flex Code
24050 \begin_layout Plain Layout
24058 \begin_inset Flex Code
24061 \begin_layout Plain Layout
24069 \begin_inset Flex Code
24072 \begin_layout Plain Layout
24080 \begin_inset Flex Code
24083 \begin_layout Plain Layout
24091 \begin_inset Flex Code
24094 \begin_layout Plain Layout
24102 \begin_inset Flex Code
24105 \begin_layout Plain Layout
24112 \begin_inset Flex Code
24115 \begin_layout Plain Layout
24122 Each of these turns on or off the corresponding attribute.
24125 \begin_inset Flex Code
24128 \begin_layout Plain Layout
24136 \begin_inset Flex Code
24139 \begin_layout Plain Layout
24147 \begin_inset Newline newline
24150 If the latter seems puzzling,
24151 remember that the font settings for the present context are generally inherited from the surrounding context.
24153 \begin_inset Flex Code
24156 \begin_layout Plain Layout
24162 would turn off the emphasis that was anyway in effect,
24164 in a theorem environment.
24167 \begin_layout Description
24168 \begin_inset Flex Code
24171 \begin_layout Plain Layout
24178 \begin_inset Flex Code
24181 \begin_layout Plain Layout
24191 \begin_inset Flex Code
24194 \begin_layout Plain Layout
24203 \begin_layout Description
24204 \begin_inset Flex Code
24207 \begin_layout Plain Layout
24214 \begin_inset Flex Code
24217 \begin_layout Plain Layout
24227 \begin_inset Flex Code
24230 \begin_layout Plain Layout
24238 \begin_inset Flex Code
24241 \begin_layout Plain Layout
24249 \begin_inset Flex Code
24252 \begin_layout Plain Layout
24261 \begin_layout Description
24262 \begin_inset Flex Code
24265 \begin_layout Plain Layout
24272 \begin_inset Flex Code
24275 \begin_layout Plain Layout
24283 \begin_inset Flex Code
24286 \begin_layout Plain Layout
24294 \begin_inset Flex Code
24297 \begin_layout Plain Layout
24307 \begin_inset Flex Code
24310 \begin_layout Plain Layout
24318 \begin_inset Flex Code
24321 \begin_layout Plain Layout
24329 \begin_inset Flex Code
24332 \begin_layout Plain Layout
24340 \begin_inset Flex Code
24343 \begin_layout Plain Layout
24351 \begin_inset Flex Code
24354 \begin_layout Plain Layout
24363 \begin_layout Subsection
24364 \begin_inset CommandInset label
24366 name "subsec:Citation-engine-description"
24370 Cite engine description
24373 \begin_layout Standard
24375 \begin_inset Flex Code
24378 \begin_layout Plain Layout
24385 as used mainly in cite engine files (see
24386 \begin_inset CommandInset ref
24388 reference "subsec:Cite-Engine-Files"
24397 define the citation commands provided by a specific
24398 \begin_inset Quotes eld
24402 \begin_inset Quotes erd
24407 in \SpecialChar LyX
24409 is way specific way to format citations,
24411 author names and/or years.
24414 supports three such engine types,
24418 \begin_layout Enumerate
24419 \begin_inset Flex Code
24422 \begin_layout Plain Layout
24429 the default Bib\SpecialChar TeX
24430 way to format citations,
24431 a simple numeric style (e.
24432 \begin_inset space \thinspace{}
24437 \begin_inset Quotes eld
24441 \begin_inset Quotes erd
24447 \begin_layout Enumerate
24448 \begin_inset Flex Code
24451 \begin_layout Plain Layout
24458 Harvard-styled citations using author names and publication year (e.
24459 \begin_inset space \thinspace{}
24464 \begin_inset Quotes eld
24467 Smith and Miller (2017b)
24468 \begin_inset Quotes erd
24474 \begin_layout Enumerate
24475 \begin_inset Flex Code
24478 \begin_layout Plain Layout
24485 extended numerical citations that also allow for author or title next to the number (e.
24486 \begin_inset space \thinspace{}
24491 \begin_inset Quotes eld
24494 Smith and Miller [1]
24495 \begin_inset Quotes erd
24501 \begin_layout Standard
24502 \begin_inset Flex Code
24505 \begin_layout Plain Layout
24511 blocks look like this:
24514 \begin_layout LyX-Code
24518 \begin_layout LyX-Code
24522 \begin_layout LyX-Code
24526 \begin_layout LyX-Code
24527 citeyearpar[][]=parencite*
24530 \begin_layout LyX-Code
24534 \begin_layout LyX-Code
24538 \begin_layout Standard
24540 \begin_inset Flex Code
24543 \begin_layout Plain Layout
24549 denotes the engine.
24550 The individual lines respectively define a cite command or cite command paradigm supported by this engine.
24551 The line can be as simple as a cite command that is used both to name the respective \SpecialChar LyX
24552 command and the \SpecialChar LaTeX
24553 output or more complex in order to differentiate things.
24554 The full syntax is:
24557 \begin_layout LyX-Code
24558 LyXName|alias$*<!_stardesc!_stardesctooltip>[][]=latexcmd
24561 \begin_layout Itemize
24562 \begin_inset Flex Code
24565 \begin_layout Plain Layout
24572 The name as used in the
24573 \begin_inset Flex Code
24576 \begin_layout Plain Layout
24586 \begin_layout Standard
24587 For portability reasons,
24588 we try to use the same name for same-formatted commands in different cite packages (thus many names stem from natbib,
24589 and thus we need to differentiate a
24590 \begin_inset Flex Code
24593 \begin_layout Plain Layout
24600 if the \SpecialChar LaTeX
24601 command names differ).
24605 \begin_layout Itemize
24606 \begin_inset Flex Code
24609 \begin_layout Plain Layout
24616 a (comma-separated) list of commands that fall back to the given
24617 \begin_inset Flex Code
24620 \begin_layout Plain Layout
24626 in the current engine.
24627 This eases the switch of citation packages and engines.
24629 \begin_inset Flex Code
24632 \begin_layout Plain Layout
24639 \begin_inset Flex Code
24642 \begin_layout Plain Layout
24648 in layout definitions.
24651 \begin_layout Itemize
24652 \begin_inset Flex Code
24655 \begin_layout Plain Layout
24662 The actual \SpecialChar LaTeX
24663 command that is output.
24667 \begin_layout Standard
24668 \begin_inset Flex Code
24671 \begin_layout Plain Layout
24678 \begin_inset Flex Code
24681 \begin_layout Plain Layout
24689 \begin_inset Flex Code
24692 \begin_layout Plain Layout
24700 \begin_inset Flex Code
24703 \begin_layout Plain Layout
24709 will be output to \SpecialChar LaTeX
24713 \begin_layout Standard
24717 \begin_layout Itemize
24718 Capitalization indicates that the command also has a capitalized form (
24719 \begin_inset Flex Code
24722 \begin_layout Plain Layout
24732 \begin_inset Flex Code
24735 \begin_layout Plain Layout
24744 These usually enforce up-casing of name prefixes (
24749 \begin_inset Formula $\Rightarrow$
24759 \begin_layout Itemize
24761 \begin_inset Flex Code
24764 \begin_layout Plain Layout
24770 indicate the number of optional arguments (there can be 0–2).
24773 \begin_layout Itemize
24775 \begin_inset Flex Code
24778 \begin_layout Plain Layout
24784 indicates there is a starred version of the command (
24785 \begin_inset Flex Code
24788 \begin_layout Plain Layout
24798 \begin_inset Flex Code
24801 \begin_layout Plain Layout
24814 \begin_layout Standard
24816 the starred version means:
24817 Output all authors even if it should be shortened with
24818 \begin_inset Quotes eld
24822 \begin_inset Quotes erd
24826 \begin_inset Flex Code
24829 \begin_layout Plain Layout
24838 \begin_layout Standard
24839 If the star has a different meaning for a given command,
24840 it can be specified in angle brackets:
24842 \begin_inset Flex Code
24845 \begin_layout Plain Layout
24846 <!_stardesc!_stardesctooltip>
24852 Maximal two translatable macro keywords,
24853 marked by the prefix
24854 \begin_inset Flex Code
24857 \begin_layout Plain Layout
24865 The first points to the string that replaces the
24866 \begin_inset Quotes eld
24870 \begin_inset Quotes erd
24873 checkbox label in the citation dialog,
24874 the second one to an optional tool tip for this checkbox.
24878 \begin_layout Standard
24879 Note that these two macros have to be defined in a
24880 \begin_inset Flex Code
24883 \begin_layout Plain Layout
24889 (see next section),
24891 \begin_inset Flex Code
24894 \begin_layout Plain Layout
24905 \begin_layout LyX-Code
24906 _stardesc Sta&rred command label
24909 \begin_layout LyX-Code
24910 _stardesctooltip Tooltip for the starred command checkbox.
24914 \begin_layout Itemize
24916 \begin_inset Flex Code
24919 \begin_layout Plain Layout
24925 indicates that this command features
24926 \begin_inset Quotes eld
24929 qualified citation lists
24930 \begin_inset Quotes erd
24938 -specific feature for multi-reference citations where an individual pre- and postnote can be given to each reference in the list.
24939 Please refer to the
24943 manual for details.
24946 \begin_layout Standard
24947 If you want to add a cite command to a cite engine (e.
24948 \begin_inset space \thinspace{}
24952 add a specific command provided by a class),
24954 \begin_inset Flex Code
24957 \begin_layout Plain Layout
24958 AddToCiteEngine <engine type> \SpecialChar ldots
24965 Note that only cite commands that do not exist yet are added.
24968 \begin_layout Subsection
24969 \begin_inset CommandInset label
24971 name "subsec:Citation-format-description"
24975 Cite format description
24978 \begin_layout Standard
24980 \begin_inset Flex Code
24983 \begin_layout Plain Layout
24989 blocks are used to describe how bibliographic information should be displayed,
24990 both within \SpecialChar LyX
24991 itself (in the citation dialog and in tooltips,
24992 for example) and in XHTML output.
24993 Such a block might look like this:
24996 \begin_layout LyX-Code
25000 \begin_layout LyX-Code
25004 \begin_layout LyX-Code
25008 \begin_layout LyX-Code
25012 \begin_layout Standard
25016 \begin_layout LyX-Code
25020 \begin_layout LyX-Code
25024 \begin_layout LyX-Code
25028 \begin_layout LyX-Code
25032 \begin_layout Standard
25034 the individual lines define how the bibliographic information associated with an article or book,
25036 is to be displayed,
25037 and such a definition can be given for any
25038 \begin_inset Quotes els
25042 \begin_inset Quotes ers
25045 that might be present in a Bib\SpecialChar TeX
25048 defines a default format in the source code that will be used if no specific definition has been given.
25050 predefines several formats in the file
25051 \begin_inset Flex Code
25054 \begin_layout Plain Layout
25061 which is included in most of \SpecialChar LyX
25062 's document classes.
25065 \begin_layout Standard
25066 In the second case,
25067 the lines define how a specific citation command (in the example
25068 \begin_inset Flex Code
25071 \begin_layout Plain Layout
25081 \begin_inset Flex Code
25084 \begin_layout Plain Layout
25092 ) is to be displayed on the citation inset label,
25093 in the citation dialog,
25094 menu or XHTML output.
25096 defines such formats for the citation style variants it supports via
25098 Document\SpecialChar menuseparator
25099 Setting\SpecialChar menuseparator
25100 Bibliography\SpecialChar ldots
25104 \begin_inset Flex Code
25107 \begin_layout Plain Layout
25113 files that are shipped with \SpecialChar LyX
25115 \begin_inset CommandInset ref
25117 reference "subsec:Cite-Engine-Files"
25128 \begin_layout Standard
25129 The definitions use a simple language that allows Bib\SpecialChar TeX
25130 keys to be replaced with their values.
25131 Keys should be enclosed in
25132 \begin_inset Flex Code
25135 \begin_layout Plain Layout
25144 \begin_inset Flex Code
25147 \begin_layout Plain Layout
25154 So a simple definition might look like this:
25157 \begin_layout LyX-Code
25160 \begin_inset Quotes eld
25164 \begin_inset Quotes erd
25170 \begin_layout Standard
25171 This would print the author,
25172 followed by a comma,
25173 followed by the title,
25175 followed by a period.
25178 \begin_layout Standard
25180 sometimes you may want to print a key only if it exists.
25181 This can be done by using a conditional construction,
25184 \begin_inset Flex Code
25187 \begin_layout Plain Layout
25189 \begin_inset space ~
25200 \begin_inset Flex Code
25203 \begin_layout Plain Layout
25211 \begin_inset Quotes eld
25215 \begin_inset space ~
25219 \begin_inset Quotes erd
25222 followed by the volume key.
25223 It is also possible to have an else clause in the conditional,
25225 \begin_inset Newline newline
25229 \begin_inset Flex Code
25232 \begin_layout Plain Layout
25233 {%author%[[%author%]][[%editor%,
25240 \begin_inset Newline newline
25245 \begin_inset Flex Code
25248 \begin_layout Plain Layout
25254 key is printed if it exists;
25256 the editor key is printed,
25258 \begin_inset Quotes eld
25262 \begin_inset space ~
25266 \begin_inset Quotes erd
25269 Note that the key is again enclosed in
25270 \begin_inset Flex Code
25273 \begin_layout Plain Layout
25280 the entire conditional is enclosed in braces;
25281 and the if and else clauses are enclosed in double brackets,
25283 \begin_inset Quotes eld
25287 \begin_inset Flex Code
25290 \begin_layout Plain Layout
25297 \begin_inset Quotes eld
25301 \begin_inset Quotes eld
25305 \begin_inset Flex Code
25308 \begin_layout Plain Layout
25315 \begin_inset Quotes erd
25319 There must be no space between any of these.
25322 \begin_layout Standard
25323 Next to the entry keys,
25324 there are some special keys that can be used for these conditionals:
25327 \begin_layout Itemize
25328 \begin_inset Flex Code
25331 \begin_layout Plain Layout
25332 {%dialog%[[true]][[false]]}
25339 \begin_inset Quotes eld
25343 \begin_inset Quotes erd
25346 part for dialogs and menus,
25348 \begin_inset Quotes eld
25352 \begin_inset Quotes erd
25355 part for other contexts (workarea,
25359 \begin_layout Itemize
25360 \begin_inset Flex Code
25363 \begin_layout Plain Layout
25364 {%export%[[true]][[false]]}
25371 \begin_inset Quotes eld
25375 \begin_inset Quotes erd
25378 part for export and menus,
25380 \begin_inset Quotes eld
25384 \begin_inset Quotes erd
25387 part for other contexts (workarea,
25391 \begin_layout Itemize
25392 \begin_inset Flex Code
25395 \begin_layout Plain Layout
25403 \begin_inset Quotes eld
25407 \begin_inset Quotes erd
25410 part if another item follows (e.
25411 \begin_inset space \thinspace{}
25415 in a citation with multiple keys)
25418 \begin_layout Itemize
25419 \begin_inset Flex Code
25422 \begin_layout Plain Layout
25423 {%second%[[true]][[false]]}
25430 \begin_inset Quotes eld
25434 \begin_inset Quotes erd
25437 if this is the second of multiple items,
25439 \begin_inset Quotes eld
25443 \begin_inset Quotes erd
25449 \begin_layout Itemize
25450 \begin_inset Flex Code
25453 \begin_layout Plain Layout
25454 {%ifstar%[[true]][[false]]}
25461 \begin_inset Quotes eld
25465 \begin_inset Quotes erd
25468 part for starred citation commands (such as
25469 \begin_inset Flex Code
25472 \begin_layout Plain Layout
25481 the false part for unstarred
25484 \begin_layout Itemize
25485 \begin_inset Flex Code
25488 \begin_layout Plain Layout
25489 {%ifentrytype:<type>%[[true]][[false]]}
25496 \begin_inset Quotes eld
25500 \begin_inset Quotes erd
25503 if the current entry type matches
25504 \begin_inset Flex Code
25507 \begin_layout Plain Layout
25514 else the false part (e.g.,
25515 in a citation definition:
25517 \begin_inset Flex Code
25520 \begin_layout Plain Layout
25521 {%ifentrytype:book%[[this is a book]][[this is no book]]}
25529 \begin_layout Itemize
25530 \begin_inset Flex Code
25533 \begin_layout Plain Layout
25534 {%ifmultiple:<authortype>%[[true]][[false]]}
25541 \begin_inset Quotes eld
25545 \begin_inset Quotes erd
25548 if the current author type (author,
25549 editor etc.) has multiple authors,
25550 else the false part (e.g.,
25551 in a bibliography definition:
25553 \begin_inset Flex Code
25556 \begin_layout Plain Layout
25557 {%ifmultiple:editor%[[eds.]][[ed.]]}
25565 \begin_layout Itemize
25566 \begin_inset Flex Code
25569 \begin_layout Plain Layout
25570 {%ifqualified%[[true]][[false]]}
25577 \begin_inset Quotes eld
25581 \begin_inset Quotes erd
25584 part if the current citation is a qualified citation list (a specific
25588 format for multi-reference citations),
25589 the false part if this is not the case.
25592 \begin_layout Standard
25594 \begin_inset Flex Code
25597 \begin_layout Plain Layout
25603 prints the author key as it is recorded in the bibliography file.
25604 This might not be what you want,
25605 since it will result in a string such as
25606 \begin_inset Quotes eld
25613 \begin_inset Quotes erd
25617 \begin_inset Quotes eld
25621 \begin_inset Quotes erd
25624 is used by Bib\SpecialChar TeX
25625 to delimit authors).
25627 therefore provides some methods to get properly formatted name lists (which will also get translated).
25628 The following keys are provided:
25631 \begin_layout Enumerate
25632 For name lists with pre- and surname,
25633 suitable for the main authors/editors of a bibliography item.
25635 \begin_inset Flex Code
25638 \begin_layout Plain Layout
25644 part denotes the kind of list that is requested (e.g.
25646 \begin_inset Flex Code
25649 \begin_layout Plain Layout
25659 \begin_layout Itemize
25660 \begin_inset Flex Code
25663 \begin_layout Plain Layout
25664 %abbrvnames:<nametype>%
25670 Provides a name list which is abbreviated (with
25671 \begin_inset Quotes eld
25675 \begin_inset Quotes erd
25679 \begin_inset Flex Code
25682 \begin_layout Plain Layout
25691 \begin_layout Itemize
25692 \begin_inset Flex Code
25695 \begin_layout Plain Layout
25696 %fullnames:<nametype>%
25702 Provides a full name list (never abbreviated with
25703 \begin_inset Quotes eld
25707 \begin_inset Quotes erd
25713 \begin_layout Itemize
25714 \begin_inset Flex Code
25717 \begin_layout Plain Layout
25718 %forceabbrvnames:<nametype>%
25724 Provides a name list which is always abbreviated (with
25725 \begin_inset Quotes eld
25729 \begin_inset Quotes erd
25733 \begin_inset Flex Code
25736 \begin_layout Plain Layout
25746 \begin_layout Enumerate
25747 Alternative name lists with pre- and surname,
25748 if the order of pre- and surname inside the bibliography item differs (as in:
25750 \begin_inset Quotes eld
25760 \begin_inset Quotes erd
25767 \begin_layout Itemize
25768 \begin_inset Flex Code
25771 \begin_layout Plain Layout
25772 %abbrvbynames:<nametype>%
25778 Provides a name list which is abbreviated (with
25779 \begin_inset Quotes eld
25783 \begin_inset Quotes erd
25787 \begin_inset Flex Code
25790 \begin_layout Plain Layout
25799 \begin_layout Itemize
25800 \begin_inset Flex Code
25803 \begin_layout Plain Layout
25804 %fullbynames:<nametype>%
25810 Provides a full name list (never abbreviated with
25811 \begin_inset Quotes eld
25815 \begin_inset Quotes erd
25821 \begin_layout Itemize
25822 \begin_inset Flex Code
25825 \begin_layout Plain Layout
25826 %forceabbrvbynames:<nametype>%
25832 Provides a name list which is always abbreviated (with
25833 \begin_inset Quotes eld
25837 \begin_inset Quotes erd
25841 \begin_inset Flex Code
25844 \begin_layout Plain Layout
25854 \begin_layout Enumerate
25855 And finally name lists which consist of family names only,
25856 as used in author-year citation labels.
25857 These do not take a
25858 \begin_inset Flex Code
25861 \begin_layout Plain Layout
25868 but always return either an author list or,
25869 if this does not exist,
25870 an editor list (as common in author-year labels):
25874 \begin_layout Itemize
25875 \begin_inset Flex Code
25878 \begin_layout Plain Layout
25885 Provides a name list which is abbreviated (with
25886 \begin_inset Quotes eld
25890 \begin_inset Quotes erd
25894 \begin_inset Flex Code
25897 \begin_layout Plain Layout
25906 \begin_layout Itemize
25907 \begin_inset Flex Code
25910 \begin_layout Plain Layout
25917 Provides a full name list (never abbreviated with
25918 \begin_inset Quotes eld
25922 \begin_inset Quotes erd
25928 \begin_layout Itemize
25929 \begin_inset Flex Code
25932 \begin_layout Plain Layout
25933 %forceabbrvciteauthor%
25939 Provides a name list which is always abbreviated (with
25940 \begin_inset Quotes eld
25944 \begin_inset Quotes erd
25948 \begin_inset Flex Code
25951 \begin_layout Plain Layout
25961 \begin_layout Standard
25962 The order of pre- and surname in the former two lists can be adjusted by these macros:
25965 \begin_layout Itemize
25966 \begin_inset Flex Code
25969 \begin_layout Plain Layout
25970 !firstnameform %surname%,
25976 (first author in lists of type 1)
25979 \begin_layout Itemize
25980 \begin_inset Flex Code
25983 \begin_layout Plain Layout
25984 !othernameform %surname%,
25990 (other authors in lists of type 1)
25993 \begin_layout Itemize
25994 \begin_inset Flex Code
25997 \begin_layout Plain Layout
25998 !firstbynameform %prename% %surname%
26003 (first author in lists of type 2)
26006 \begin_layout Itemize
26007 \begin_inset Flex Code
26010 \begin_layout Plain Layout
26011 !otherbynameform %prename% %surname%
26016 (other authors in lists of type 2)
26019 \begin_layout Standard
26020 This allows you to configure namings like
26021 \begin_inset Quotes eld
26025 Peter and Mary Smith:
26029 John Doe and Pat Green,
26030 eds.:\SpecialChar ldots
26032 \begin_inset Quotes erd
26038 \begin_layout Standard
26039 There is one other piece of syntax available in definitions,
26040 which looks like this:
26042 \begin_inset Flex Code
26045 \begin_layout Plain Layout
26052 This defines a piece of formatting information that is to be used when creating
26053 \begin_inset Quotes eld
26057 \begin_inset Quotes erd
26062 we do not want to output HTML tags when writing plain text,
26063 so they should be wrapped in
26064 \begin_inset Quotes eld
26068 \begin_inset Quotes erd
26072 \begin_inset Quotes eld
26076 \begin_inset Quotes erd
26082 \begin_layout Standard
26083 Two special sorts of definitions are also possible in a
26084 \begin_inset Flex Code
26087 \begin_layout Plain Layout
26094 An example of the first would be:
26097 \begin_layout LyX-Code
26099 \begin_inset Quotes eld
26103 \begin_inset Quotes erd
26109 \begin_layout Standard
26110 This is an abbreviation,
26112 and it can be used by treating it as if it were a key:
26114 \begin_inset Flex Code
26117 \begin_layout Plain Layout
26126 \begin_inset Flex Code
26129 \begin_layout Plain Layout
26135 exactly as it would treat its definition.
26137 let us issue the obvious
26145 \begin_layout LyX-Code
26149 \begin_layout Standard
26150 or anything like it.
26152 shouldn't go into an infinite loop,
26153 but it may go into a long one before it gives up.
26156 \begin_layout Standard
26157 The second sort of special definition might look like this:
26160 \begin_layout LyX-Code
26164 \begin_layout Standard
26165 This defines a translatable piece of text,
26166 which allows relevant parts of the bibliography or citation to be translated.
26167 It can be included in a definition by treating it as a key:
26169 \begin_inset Flex Code
26172 \begin_layout Plain Layout
26179 Note that there are two different translation paths:
26180 All definitions starting with
26181 \begin_inset Flex Code
26184 \begin_layout Plain Layout
26191 such as in the example above,
26192 will be translated to the currently active buffer language (so the translation will match the generated document).
26193 All definitions starting with underscore only will be translated to the GUI language.
26194 This is the proper translation for strings that only occur in the dialogs or on buttons,
26198 \begin_layout LyX-Code
26199 _addtobib Add to bibliography only.
26202 \begin_layout Standard
26203 Several of these translatable strings are predefined in
26204 \begin_inset Flex Code
26207 \begin_layout Plain Layout
26214 \begin_inset Flex Code
26217 \begin_layout Plain Layout
26224 Note that these are not macros,
26225 in the sense just defined.
26226 They will not be expanded.
26229 \begin_layout Standard
26230 So here then is an example that uses several of these features:
26231 \begin_inset VSpace defskip
26237 \begin_layout Standard
26241 !authoredit {%author%[[%author%,
26242 ]][[{%editor%[[%editor%,
26247 \begin_layout Standard
26248 \begin_inset VSpace defskip
26251 This defines a macro that prints the author,
26252 followed by a comma,
26254 \begin_inset Flex Code
26257 \begin_layout Plain Layout
26264 or else prints the name of the editor,
26266 \begin_inset Flex Code
26269 \begin_layout Plain Layout
26275 or its translation (it is by default
26276 \begin_inset Quotes eld
26280 \begin_inset Quotes erd
26285 \begin_inset Flex Code
26288 \begin_layout Plain Layout
26295 Note that this is in fact defined in
26296 \begin_inset Flex Code
26299 \begin_layout Plain Layout
26306 so you can use it in your own definitions,
26308 if you load that file first.
26311 \begin_layout Section
26312 \begin_inset CommandInset label
26314 name "sec:Tags-for-XHTML"
26318 Tags for XHTML output
26321 \begin_layout Standard
26322 As with \SpecialChar LaTeX
26324 the format of \SpecialChar LyX
26325 's XHTML output is also controlled by layout information.
26328 provides sensible defaults and,
26329 as mentioned earlier,
26330 it will even construct default CSS style rules from the other layout tags.
26333 will attempt to use the information provided in the
26334 \begin_inset Flex Code
26337 \begin_layout Plain Layout
26343 declaration for the Chapter style to write CSS that will appropriately format chapter headings.
26346 \begin_layout Standard
26349 you may not have to do anything at all to get acceptable XHTML output for your own environments,
26352 But in some cases you will,
26353 and so \SpecialChar LyX
26354 provides a number of layout tags that can be used to customize the XHTML and CSS that are generated.
26357 \begin_layout Standard
26358 Note that there are two tags,
26360 \begin_inset Flex Code
26363 \begin_layout Plain Layout
26370 \begin_inset Flex Code
26373 \begin_layout Plain Layout
26379 that may appear outside style and inset declarations.
26381 \begin_inset CommandInset ref
26383 reference "subsec:General-text-class"
26388 for details on these.
26391 \begin_layout Subsection
26392 \begin_inset CommandInset label
26394 name "subsec:Paragraph-Style-XHTML"
26401 \begin_layout Standard
26402 The sort of XHTML \SpecialChar LyX
26403 outputs for a paragraph depends upon whether we are dealing with a normal paragraph,
26406 where this is itself determined by the contents of the corresponding
26407 \begin_inset Flex Code
26410 \begin_layout Plain Layout
26421 \begin_layout Standard
26422 For a command or normal paragraph,
26423 the output XHTML has the following form:
26426 \begin_layout LyX-Code
26430 \begin_inset Quotes erd
26434 \begin_inset Quotes erd
26440 \begin_layout LyX-Code
26444 \begin_inset Quotes erd
26448 \begin_inset Quotes erd
26454 \begin_layout LyX-Code
26457 Contents of the paragraph.
26460 \begin_layout LyX-Code
26466 \begin_layout Standard
26467 The label tags are of course omitted if the paragraph does not have a label.
26470 \begin_layout Standard
26471 For an environment that is not some sort of list,
26472 the XHTML takes this form:
26475 \begin_layout LyX-Code
26479 \begin_inset Quotes erd
26483 \begin_inset Quotes erd
26489 \begin_layout LyX-Code
26493 \begin_inset Quotes erd
26497 \begin_inset Quotes erd
26501 \begin_inset Quotes erd
26505 \begin_inset Quotes erd
26508 >Environment Label</labeltag>First paragraph.</itemtag>
26511 \begin_layout LyX-Code
26514 <itemtag>Second paragraph.</itemtag>
26517 \begin_layout LyX-Code
26523 \begin_layout Standard
26524 Note that the label is output only for the first paragraph,
26525 as it should be for a theorem,
26530 \begin_layout Standard
26532 we have one of these forms:
26535 \begin_layout LyX-Code
26539 \begin_inset Quotes erd
26543 \begin_inset Quotes erd
26549 \begin_layout LyX-Code
26553 \begin_inset Quotes erd
26557 \begin_inset Quotes erd
26561 \begin_inset Quotes erd
26565 \begin_inset Quotes erd
26568 >List Label</labeltag>First item.</itemtag>
26571 \begin_layout LyX-Code
26575 \begin_inset Quotes erd
26579 \begin_inset Quotes erd
26583 \begin_inset Quotes erd
26587 \begin_inset Quotes erd
26590 >List Label</labeltag>Second item.</itemtag>
26593 \begin_layout LyX-Code
26599 \begin_layout LyX-Code
26603 \begin_layout LyX-Code
26607 \begin_inset Quotes erd
26611 \begin_inset Quotes erd
26617 \begin_layout LyX-Code
26621 \begin_inset Quotes erd
26625 \begin_inset Quotes erd
26628 >List Label</labeltag><itemtag attr=
26629 \begin_inset Quotes erd
26633 \begin_inset Quotes erd
26636 >First item.</itemtag>
26639 \begin_layout LyX-Code
26643 \begin_inset Quotes erd
26647 \begin_inset Quotes erd
26650 >List Label</labeltag><itemtag attr=
26651 \begin_inset Quotes erd
26655 \begin_inset Quotes erd
26658 >Second item.</itemtag>
26661 \begin_layout LyX-Code
26667 \begin_layout Standard
26668 Note the different orders of
26669 \begin_inset Flex Code
26672 \begin_layout Plain Layout
26679 \begin_inset Flex Code
26682 \begin_layout Plain Layout
26689 Which order we get depends upon the setting of
26690 \begin_inset Flex Code
26693 \begin_layout Plain Layout
26701 \begin_inset Flex Code
26704 \begin_layout Plain Layout
26710 is false (the default),
26711 you get the first of these,
26712 with the label within the item;
26714 you get the second,
26715 with the label outside the item.
26718 \begin_layout Standard
26719 The specific tags and attributes output for each paragraph type can be controlled by means of the layout tags we are about to describe.
26720 As mentioned earlier,
26723 uses sensible defaults for many of these,
26724 so you often may not need to do very much to get good XHTML output.
26725 Think of the available tags as there so you can tweak things to your liking.
26728 \begin_layout Description
26729 \begin_inset Flex Code
26732 \begin_layout Plain Layout
26739 \begin_inset Flex Code
26742 \begin_layout Plain Layout
26748 ] Specifies attribute information to be output with the main tag.
26751 \begin_inset Quotes eld
26755 \begin_inset Flex Code
26758 \begin_layout Plain Layout
26765 \begin_inset Quotes erd
26772 \begin_inset Quotes eld
26776 \begin_inset Flex Code
26779 \begin_layout Plain Layout
26786 \begin_inset Quotes erd
26791 \begin_inset Flex Code
26794 \begin_layout Plain Layout
26800 is the \SpecialChar LyX
26801 name of the layout,
26809 contain any style information.
26811 \begin_inset Flex Code
26814 \begin_layout Plain Layout
26823 \begin_layout Description
26824 \begin_inset Flex Code
26827 \begin_layout Plain Layout
26834 \begin_inset Flex Code
26837 \begin_layout Plain Layout
26843 ] The CSS class to use for this paragraph.
26845 if the paragarph is of enumerate or itemize type,
26846 then the default will be
26847 \begin_inset Quotes eld
26851 \begin_inset Quotes erd
26855 \begin_inset Quotes eld
26859 \begin_inset Quotes erd
26864 \begin_inset Quotes eld
26868 \begin_inset Quotes erd
26873 \begin_inset Quotes eld
26877 \begin_inset Quotes erd
26882 \begin_inset Quotes eld
26886 \begin_inset Quotes erd
26891 \begin_inset Quotes eld
26895 \begin_inset Quotes erd
26899 depending upon the depth.
26900 That can be over-ridden here.
26902 the suffix will not be added in that case.
26904 the CSS class will always be exactly what it is declared to be here.
26907 \begin_layout Description
26908 \begin_inset Flex Code
26911 \begin_layout Plain Layout
26918 \begin_inset Flex Code
26921 \begin_layout Plain Layout
26931 ] Whether to output the default CSS information \SpecialChar LyX
26932 generates for this layout,
26933 even if additional information is explicitly provided via
26934 \begin_inset Flex Code
26937 \begin_layout Plain Layout
26945 \begin_inset Flex Code
26948 \begin_layout Plain Layout
26954 allows you to alter or augment the generated CSS,
26955 rather than to override it completely.
26957 \begin_inset Flex Code
26960 \begin_layout Plain Layout
26969 \begin_layout Description
26970 \begin_inset Flex Code
26973 \begin_layout Plain Layout
26980 \begin_inset Flex Code
26983 \begin_layout Plain Layout
26991 ] Whether to include this paragraph (usually,
26992 a section or something of the sort) in the TOC.
26995 so it should be set to false e.g.
26996 \begin_inset space ~
26999 for starred sections.
27002 \begin_layout Description
27003 \begin_inset Flex Code
27006 \begin_layout Plain Layout
27013 \begin_inset Flex Code
27016 \begin_layout Plain Layout
27022 ] The tag to be used for individual paragraphs of environments,
27024 \begin_inset Flex Code
27027 \begin_layout Plain Layout
27033 in the examples above.
27035 \begin_inset Flex Code
27038 \begin_layout Plain Layout
27047 \begin_layout Description
27048 \begin_inset Flex Code
27051 \begin_layout Plain Layout
27058 \begin_inset Flex Code
27061 \begin_layout Plain Layout
27067 ] Attributes for the item tag.
27069 \begin_inset Newline newline
27073 \begin_inset Quotes eld
27077 \begin_inset Flex Code
27080 \begin_layout Plain Layout
27081 class=`layoutname_item'
27087 \begin_inset Quotes erd
27095 contain any style information.
27097 \begin_inset Flex Code
27100 \begin_layout Plain Layout
27109 \begin_layout Description
27110 \begin_inset Flex Code
27113 \begin_layout Plain Layout
27120 \begin_inset Flex Code
27123 \begin_layout Plain Layout
27129 ] The tag to be used for paragraph and item labels,
27131 \begin_inset Flex Code
27134 \begin_layout Plain Layout
27140 in the examples above.
27142 \begin_inset Flex Code
27145 \begin_layout Plain Layout
27153 \begin_inset Flex Code
27156 \begin_layout Plain Layout
27163 \begin_inset Flex Code
27166 \begin_layout Plain Layout
27173 \begin_inset Flex Code
27176 \begin_layout Plain Layout
27177 Centered_Top_Environment
27183 in which case it defaults to
27184 \begin_inset Flex Code
27187 \begin_layout Plain Layout
27196 \begin_layout Description
27197 \begin_inset Flex Code
27200 \begin_layout Plain Layout
27207 \begin_inset Flex Code
27210 \begin_layout Plain Layout
27216 ] Attributes for the label tag.
27218 \begin_inset Newline newline
27222 \begin_inset Quotes eld
27226 \begin_inset Flex Code
27229 \begin_layout Plain Layout
27230 class=`layoutname_label'
27236 \begin_inset Quotes erd
27244 contain any style information.
27246 \begin_inset Flex Code
27249 \begin_layout Plain Layout
27258 \begin_layout Description
27259 \begin_inset Flex Code
27262 \begin_layout Plain Layout
27269 \begin_inset Flex Code
27272 \begin_layout Plain Layout
27282 ] Meaningful only for list-like environments,
27283 this tag controls whether the label tag is output before or inside the item tag.
27286 in the description environment,
27288 \begin_inset Flex Code
27291 \begin_layout Plain Layout
27292 <dt>\SpecialChar ldots
27293 </dt><dd>\SpecialChar ldots
27301 \begin_inset Flex Code
27304 \begin_layout Plain Layout
27311 The label tag is output inside the item tag.
27314 \begin_layout Description
27315 \begin_inset Flex Code
27318 \begin_layout Plain Layout
27324 Information to be output in the
27325 \begin_inset Flex Code
27328 \begin_layout Plain Layout
27334 section when this style is used.
27337 be used to include a
27338 \begin_inset Flex Code
27341 \begin_layout Plain Layout
27348 \begin_inset Flex Code
27351 \begin_layout Plain Layout
27360 \begin_layout Description
27361 \begin_inset Flex Code
27364 \begin_layout Plain Layout
27370 CSS style information to be included when this style is used.
27371 Note that this will automatically be wrapped in a layout-generated
27372 \begin_inset Flex Code
27375 \begin_layout Plain Layout
27382 so only the CSS itself need be included.
27384 \begin_inset Flex Code
27387 \begin_layout Plain Layout
27396 \begin_layout Description
27397 \begin_inset Flex Code
27400 \begin_layout Plain Layout
27407 \begin_inset Flex Code
27410 \begin_layout Plain Layout
27416 ] The tag to be used for the main label,
27418 \begin_inset Flex Code
27421 \begin_layout Plain Layout
27427 in the examples above.
27429 \begin_inset Flex Code
27432 \begin_layout Plain Layout
27441 \begin_layout Description
27442 \begin_inset Flex Code
27445 \begin_layout Plain Layout
27452 \begin_inset Flex Code
27455 \begin_layout Plain Layout
27465 ] Marks this style as the one to be used to generate the
27466 \begin_inset Flex Code
27469 \begin_layout Plain Layout
27475 tag for the XHTML file.
27479 \begin_inset Flex Code
27482 \begin_layout Plain Layout
27488 file sets it to true for the
27489 \begin_inset Flex Code
27492 \begin_layout Plain Layout
27502 \begin_layout Subsection
27506 \begin_layout Standard
27507 The XHTML output of insets can also be controlled by information in layout files.
27511 \begin_layout Plain Layout
27513 this is true only for
27514 \begin_inset Quotes eld
27518 \begin_inset Quotes erd
27521 insets (insets you can type into) and is not true for
27522 \begin_inset Quotes eld
27526 \begin_inset Quotes erd
27529 insets (insets that are associated with dialog boxes).
27537 tries to provide sensible defaults,
27538 and it constructs default CSS style rules.
27539 But everything can be customized.
27542 \begin_layout Standard
27543 The XHTML \SpecialChar LyX
27544 outputs for an inset has the following form:
27547 \begin_layout LyX-Code
27549 \begin_inset Quotes erd
27553 \begin_inset Quotes erd
27559 \begin_layout LyX-Code
27560 <labeltag>Label</labeltag>
27563 \begin_layout LyX-Code
27565 \begin_inset Quotes erd
27569 \begin_inset Quotes erd
27572 >Contents of the inset.</innertag>
27575 \begin_layout LyX-Code
27579 \begin_layout Standard
27580 If the inset permits multiple paragraphs—
27583 \begin_inset Flex Code
27586 \begin_layout Plain Layout
27593 then the contents of the inset will itself be output as paragraphs formatted according to the styles used for those paragraphs (standard,
27596 The label tag is of course omitted if the paragraph does not have a label and,
27599 \begin_inset Flex Code
27602 \begin_layout Plain Layout
27609 The inner tag is optional and,
27614 \begin_layout Standard
27615 The specific tags and attributes output for each inset can be controlled by means of the following layout tags.
27618 \begin_layout Description
27619 \begin_inset Flex Code
27622 \begin_layout Plain Layout
27629 \begin_inset Flex Code
27632 \begin_layout Plain Layout
27638 ] Specifies attribute information to be output with the main tag.
27641 \begin_inset Quotes eld
27645 \begin_inset Flex Code
27648 \begin_layout Plain Layout
27649 class=`myinset' onclick=`\SpecialChar ldots
27656 \begin_inset Quotes erd
27663 \begin_inset Quotes eld
27667 \begin_inset Flex Code
27670 \begin_layout Plain Layout
27677 \begin_inset Quotes erd
27682 \begin_inset Flex Code
27685 \begin_layout Plain Layout
27691 is the \SpecialChar LyX
27693 made lowercase and with non-alphanumeric characters converted to underscores,
27698 \begin_layout Description
27699 \begin_inset Flex Code
27702 \begin_layout Plain Layout
27709 \begin_inset Flex Code
27712 \begin_layout Plain Layout
27722 ] Whether to output the default CSS information \SpecialChar LyX
27723 generates for this layout,
27724 even if additional information is explicitly provided via
27725 \begin_inset Flex Code
27728 \begin_layout Plain Layout
27736 \begin_inset Flex Code
27739 \begin_layout Plain Layout
27745 allows you to alter or augment the generated CSS,
27746 rather than to override it completely.
27750 \begin_layout Description
27751 \begin_inset Flex Code
27754 \begin_layout Plain Layout
27761 \begin_inset Flex Code
27764 \begin_layout Plain Layout
27770 ] Attributes for the inner tag.
27772 \begin_inset Newline newline
27776 \begin_inset Quotes eld
27780 \begin_inset Flex Code
27783 \begin_layout Plain Layout
27784 class=`insetname_inner'
27790 \begin_inset Quotes erd
27796 \begin_layout Description
27797 \begin_inset Flex Code
27800 \begin_layout Plain Layout
27807 \begin_inset Flex Code
27810 \begin_layout Plain Layout
27818 \begin_inset Flex Code
27821 \begin_layout Plain Layout
27827 in the examples above.
27832 \begin_layout Description
27833 \begin_inset Flex Code
27836 \begin_layout Plain Layout
27843 \begin_inset Flex Code
27846 \begin_layout Plain Layout
27854 ] 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).
27858 \begin_layout Description
27859 \begin_inset Flex Code
27862 \begin_layout Plain Layout
27869 \begin_inset Flex Code
27872 \begin_layout Plain Layout
27878 ] A label for this inset,
27879 possibly including a reference to a counter.
27884 \begin_inset Flex Code
27887 \begin_layout Plain Layout
27897 and there is no default.
27900 \begin_layout Description
27901 \begin_inset Flex Code
27904 \begin_layout Plain Layout
27910 Information to be output in the
27911 \begin_inset Flex Code
27914 \begin_layout Plain Layout
27920 section when this style is used.
27923 be used to include a
27924 \begin_inset Flex Code
27927 \begin_layout Plain Layout
27934 \begin_inset Flex Code
27937 \begin_layout Plain Layout
27946 \begin_layout Description
27947 \begin_inset Flex Code
27950 \begin_layout Plain Layout
27956 CSS style information to be included when this style is used.
27957 Note that this will automatically be wrapped in a layout-generated
27958 \begin_inset Flex Code
27961 \begin_layout Plain Layout
27968 so only the CSS itself need be included.
27971 \begin_layout Description
27972 \begin_inset Flex Code
27975 \begin_layout Plain Layout
27982 \begin_inset Flex Code
27985 \begin_layout Plain Layout
27991 ] The tag to be used for the main label,
27993 \begin_inset Flex Code
27996 \begin_layout Plain Layout
28002 in the examples above.
28003 The default depends upon the setting of
28004 \begin_inset Flex Code
28007 \begin_layout Plain Layout
28015 \begin_inset Flex Code
28018 \begin_layout Plain Layout
28026 \begin_inset Flex Code
28029 \begin_layout Plain Layout
28038 \begin_inset Flex Code
28041 \begin_layout Plain Layout
28050 \begin_layout Subsection
28054 \begin_layout Standard
28055 The XHTML output for floats too can be controlled by layout information.
28056 The output has the following form:
28059 \begin_layout LyX-Code
28061 \begin_inset Quotes erd
28065 \begin_inset Quotes erd
28071 \begin_layout LyX-Code
28072 Contents of the float.
28075 \begin_layout LyX-Code
28079 \begin_layout Standard
28082 is a separate inset and will be output as such.
28083 Its appearance can be controlled via the InsetLayout for caption insets.
28087 \begin_layout Description
28088 \begin_inset Flex Code
28091 \begin_layout Plain Layout
28098 \begin_inset Flex Code
28101 \begin_layout Plain Layout
28107 ] Specifies attribute information to be output with the main tag.
28110 \begin_inset Quotes eld
28114 \begin_inset Flex Code
28117 \begin_layout Plain Layout
28118 class=`myfloat' onclick=`\SpecialChar ldots
28125 \begin_inset Quotes erd
28132 \begin_inset Quotes eld
28136 \begin_inset Flex Code
28139 \begin_layout Plain Layout
28140 class=`float float-floattype'
28146 \begin_inset Quotes erd
28151 \begin_inset Flex Code
28154 \begin_layout Plain Layout
28160 is \SpecialChar LyX
28161 's name for this type of float,
28162 as determined by the float declaration (see
28163 \begin_inset CommandInset ref
28165 reference "subsec:Floats"
28171 though made lowercase and with non-alphanumeric characters converted to underscores,
28176 \begin_layout Description
28177 \begin_inset Flex Code
28180 \begin_layout Plain Layout
28186 CSS style information to be included when this float is used.
28187 Note that this will automatically be wrapped in a layout-generated
28188 \begin_inset Flex Code
28191 \begin_layout Plain Layout
28198 so only the CSS itself need be included.
28201 \begin_layout Description
28202 \begin_inset Flex Code
28205 \begin_layout Plain Layout
28212 \begin_inset Flex Code
28215 \begin_layout Plain Layout
28221 ] The tag to be used for this float,
28223 \begin_inset Quotes eld
28227 \begin_inset Flex Code
28230 \begin_layout Plain Layout
28237 \begin_inset Quotes erd
28240 in the example above.
28242 \begin_inset Flex Code
28245 \begin_layout Plain Layout
28251 and will rarely need changing.
28254 \begin_layout Subsection
28255 Bibliography formatting
28258 \begin_layout Standard
28259 The bibliography can be formatted using
28260 \begin_inset Flex Code
28263 \begin_layout Plain Layout
28271 \begin_inset CommandInset ref
28273 reference "subsec:Citation-format-description"
28281 \begin_layout Subsection
28286 \begin_layout Standard
28287 We have several times mentioned that \SpecialChar LyX
28288 will generate default CSS style rules for both insets and paragraph styles,
28289 based upon the other layout information that is provided.
28291 we shall say a word about which layout information \SpecialChar LyX
28295 \begin_layout Standard
28298 auto-generates CSS only for font information,
28300 \begin_inset Flex Code
28303 \begin_layout Plain Layout
28311 \begin_inset Flex Code
28314 \begin_layout Plain Layout
28322 \begin_inset Flex Code
28325 \begin_layout Plain Layout
28333 \begin_inset Flex Code
28336 \begin_layout Plain Layout
28343 \begin_inset Flex Code
28346 \begin_layout Plain Layout
28353 \begin_inset CommandInset ref
28355 reference "subsec:Font-description"
28361 The translation is mostly straightforward and obvious.
28364 \begin_inset Quotes eld
28368 \begin_inset Flex Code
28371 \begin_layout Plain Layout
28378 \begin_inset Quotes erd
28382 \begin_inset Quotes eld
28386 \begin_inset Flex Code
28389 \begin_layout Plain Layout
28397 \begin_inset Quotes erd
28401 The correspondence of \SpecialChar LyX
28402 sizes and CSS sizes is a little less obvious but nonetheless intuitive.
28404 \begin_inset Flex Code
28407 \begin_layout Plain Layout
28414 \begin_inset Flex URL
28417 \begin_layout Plain Layout
28427 \begin_layout Section
28428 \begin_inset CommandInset label
28430 name "sec:Tags-for-DocBook"
28434 Tags for DocBook output
28437 \begin_layout Standard
28438 As with \SpecialChar LaTeX
28440 the format of \SpecialChar LyX
28441 's DocBook output is also controlled by layout information.
28444 provides sensible defaults;
28446 much of the styling is lost during the conversion,
28447 as DocBook is strictly semantic and does not allow formatting.
28449 information from \SpecialChar LyX
28450 will be rendered in
28457 \begin_layout Standard
28460 you may not have to do anything at all to get acceptable DocBook output for your own environments,
28463 But in some cases you will,
28464 and so \SpecialChar LyX
28465 provides a number of layout tags that can be used to customize the DocBook that is generated.
28468 \begin_layout Standard
28469 Labels are rarely output,
28470 as they are redundant in DocBook:
28471 this information is carried by the tags themselves,
28472 and whether labels appear in the final documents (after processing of DocBook files) is controlled by the stylesheets.
28475 labels are not redundant content,
28476 such as definition lists:
28478 the term being defined will be the label.
28481 \begin_layout Subsection
28482 \begin_inset CommandInset label
28484 name "subsec:Paragraph-Style-DocBook"
28491 \begin_layout Standard
28492 The sort of DocBook \SpecialChar LyX
28493 outputs for a paragraph depends upon whether we are dealing with a normal paragraph,
28496 where this is itself determined by the contents of the corresponding
28497 \begin_inset Flex Code
28500 \begin_layout Plain Layout
28510 \begin_layout Standard
28511 For a command or normal paragraph,
28512 the output DocBook has the following form:
28515 \begin_layout LyX-Code
28519 \begin_layout LyX-Code
28520 Contents of the paragraph.
28523 \begin_layout LyX-Code
28527 \begin_layout Standard
28528 For an environment that is not some sort of list,
28529 the generated DocBook takes this form:
28532 \begin_layout LyX-Code
28536 \begin_layout LyX-Code
28537 <itemtag>First paragraph.</itemtag>
28540 \begin_layout LyX-Code
28541 <itemtag>Second paragraph.</itemtag>
28544 \begin_layout LyX-Code
28548 \begin_layout Standard
28550 the resulting DocBook takes this form:
28553 \begin_layout LyX-Code
28557 \begin_layout LyX-Code
28558 <itemtag attr>First item.</itemtag>
28561 \begin_layout LyX-Code
28562 <itemtag attr>Second item.</itemtag>
28565 \begin_layout LyX-Code
28569 \begin_layout Standard
28570 The specific tags and roles output for each paragraph type can be controlled by means of the layout tags we are about to describe.
28572 due to the very nature of DocBook,
28573 no sensible defaults really exist,
28574 and the values must always be carefully chosen.
28577 \begin_layout Description
28578 \begin_inset Flex Code
28581 \begin_layout Plain Layout
28588 \begin_inset Flex Code
28591 \begin_layout Plain Layout
28597 ] Specifies attribute information to be output with the main tag,
28599 \begin_inset Quotes eld
28603 \begin_inset Flex Code
28606 \begin_layout Plain Layout
28613 \begin_inset Quotes erd
28616 in the example above.
28617 This information can be used in further processing of the DocBook files.
28620 \begin_layout Description
28621 \begin_inset Flex Code
28624 \begin_layout Plain Layout
28631 \begin_inset Flex Code
28634 \begin_layout Plain Layout
28640 ] The tag to be used for this inset,
28642 \begin_inset Quotes eld
28646 \begin_inset Flex Code
28649 \begin_layout Plain Layout
28656 \begin_inset Quotes erd
28659 in the example above.
28660 The default is the name of the float and always needs to be changed,
28661 as DocBook provides no generic tag.
28664 \begin_layout Description
28665 \begin_inset Flex Code
28668 \begin_layout Plain Layout
28675 \begin_inset Flex Code
28678 \begin_layout Plain Layout
28686 ] The new-line policy for this tag,
28688 \begin_inset space ~
28692 \begin_inset CommandInset ref
28694 reference "subsec:DocBook-New-line-policy"
28705 \begin_layout Subsection
28707 \begin_inset CommandInset label
28709 name "subsec:DocBook-New-line-policy"
28716 \begin_layout Standard
28718 there are three possible policies for outputting new lines (given in the
28719 \begin_inset Flex Code
28722 \begin_layout Plain Layout
28731 \begin_layout Itemize
28732 \begin_inset Quotes eld
28736 \begin_inset Flex Code
28739 \begin_layout Plain Layout
28746 \begin_inset Quotes erd
28750 the opening and closing tags are on their own lines (i.e.
28751 a line feed after and before the opening and the closing tags).
28752 Typical elements are floats.
28756 \begin_layout LyX-Code
28760 \begin_layout LyX-Code
28764 \begin_layout LyX-Code
28765 Contents of the block.
28768 \begin_layout LyX-Code
28772 \begin_layout LyX-Code
28776 \begin_layout Itemize
28777 \begin_inset Quotes eld
28781 \begin_inset Flex Code
28784 \begin_layout Plain Layout
28791 \begin_inset Quotes erd
28795 the opening and closing tags are on the same,
28797 a line feed is output before the opening tag and after the closing tag.
28798 Typical elements are paragraphs and list items.
28802 \begin_layout LyX-Code
28806 \begin_layout LyX-Code
28807 <paratag>Contents of the paragraph.</paratag>
28810 \begin_layout LyX-Code
28814 \begin_layout Itemize
28815 \begin_inset Quotes eld
28819 \begin_inset Flex Code
28822 \begin_layout Plain Layout
28829 \begin_inset Quotes erd
28833 the opening and closing tags are on the same line as the rest of the content.
28834 No line feeds are output.
28835 Typical elements are fonts.
28839 \begin_layout LyX-Code
28840 Content before<inlinetag>Contents of the paragraph.</inlinetag>Content after
28843 \begin_layout Standard
28844 The default value is always
28845 \begin_inset Quotes eld
28849 \begin_inset Flex Code
28852 \begin_layout Plain Layout
28859 \begin_inset Quotes erd
28865 \begin_layout Subsection
28866 InsetLayout DocBook
28869 \begin_layout Standard
28870 The DocBook output of insets can also be controlled by information in layout files.
28873 \begin_layout Standard
28874 The DocBook \SpecialChar LyX
28875 outputs for an inset has the following form:
28878 \begin_layout LyX-Code
28879 <wrappertag wrapperattr>
28882 \begin_layout LyX-Code
28886 \begin_layout LyX-Code
28887 <innertag innerattr>
28890 \begin_layout LyX-Code
28891 Contents of the inset.
28894 \begin_layout LyX-Code
28898 \begin_layout LyX-Code
28902 \begin_layout LyX-Code
28906 \begin_layout Standard
28907 For an itemising inset,
28908 it rather looks like this:
28911 \begin_layout LyX-Code
28912 <wrappertag wrapperattr>
28915 \begin_layout LyX-Code
28919 \begin_layout LyX-Code
28920 <innertag innerattr>
28923 \begin_layout LyX-Code
28924 <itemwrappertag itemwrapperattr>
28927 \begin_layout LyX-Code
28928 <itemlabeltag itemattr>
28931 \begin_layout LyX-Code
28932 Label of the first item.
28935 \begin_layout LyX-Code
28939 \begin_layout LyX-Code
28943 \begin_layout LyX-Code
28947 \begin_layout LyX-Code
28948 Contents of the first item.
28951 \begin_layout LyX-Code
28955 \begin_layout LyX-Code
28959 \begin_layout LyX-Code
28963 \begin_layout LyX-Code
28964 <itemwrappertag itemwrapperattr>
28967 \begin_layout LyX-Code
28968 <itemlabeltag itemattr>
28971 \begin_layout LyX-Code
28972 Label of the second item.
28975 \begin_layout LyX-Code
28979 \begin_layout LyX-Code
28983 \begin_layout LyX-Code
28987 \begin_layout LyX-Code
28988 Contents of the second item.
28991 \begin_layout LyX-Code
28995 \begin_layout LyX-Code
28999 \begin_layout LyX-Code
29003 \begin_layout LyX-Code
29007 \begin_layout LyX-Code
29011 \begin_layout LyX-Code
29015 \begin_layout LyX-Code
29019 \begin_layout Standard
29020 If the inset permits multiple paragraphs—
29023 \begin_inset Flex Code
29026 \begin_layout Plain Layout
29033 then the contents of the inset will themselves be output as paragraphs formatted according to the styles used for those paragraphs (standard,
29036 The inner tag is optional and,
29041 \begin_layout Standard
29042 The specific tags and attributes output for each inset can be controlled by means of the following layout tags.
29045 \begin_layout Description
29046 \begin_inset Flex Code
29049 \begin_layout Plain Layout
29056 \begin_inset Flex Code
29059 \begin_layout Plain Layout
29065 ] Specifies attribute information to be output with the main tag,
29067 \begin_inset Quotes eld
29071 \begin_inset Flex Code
29074 \begin_layout Plain Layout
29081 \begin_inset Quotes erd
29084 in the example above.
29085 This information can be used in further processing of the DocBook files.
29088 \begin_layout Description
29089 \begin_inset Flex Code
29092 \begin_layout Plain Layout
29099 \begin_inset Flex Code
29102 \begin_layout Plain Layout
29110 ] Specifies whether this tag goes into the
29111 \begin_inset Flex Code
29114 \begin_layout Plain Layout
29120 tag at the beginning of the parent layout.
29122 \begin_inset Flex Code
29125 \begin_layout Plain Layout
29131 indicates that the tag never goes into
29132 \begin_inset Flex Code
29135 \begin_layout Plain Layout
29141 (this is default value,
29142 and corresponds to usual content).
29144 \begin_inset Flex Code
29147 \begin_layout Plain Layout
29153 indicates that the tag always goes into
29154 \begin_inset Flex Code
29157 \begin_layout Plain Layout
29163 (this corresponds to usual metadata):
29165 \begin_inset Flex Code
29168 \begin_layout Plain Layout
29174 tag for the parent,
29181 \begin_inset Flex Code
29184 \begin_layout Plain Layout
29190 indicates that the tag may go into
29191 \begin_inset Flex Code
29194 \begin_layout Plain Layout
29200 (this is only the case for titles):
29202 \begin_inset Flex Code
29205 \begin_layout Plain Layout
29211 tag for the parent,
29217 the corresponding tag will be output directly as content.
29220 \begin_layout Description
29221 \begin_inset Flex Code
29224 \begin_layout Plain Layout
29231 \begin_inset Flex Code
29234 \begin_layout Plain Layout
29240 ] Specifies attribute information to be output with the item tag,
29242 \begin_inset Quotes eld
29246 \begin_inset Flex Code
29249 \begin_layout Plain Layout
29256 \begin_inset Quotes erd
29259 in the example above.
29260 This information can be used in further processing of the DocBook files.
29263 \begin_layout Description
29264 \begin_inset Flex Code
29267 \begin_layout Plain Layout
29268 DocBookItemInnerAttr
29274 \begin_inset Flex Code
29277 \begin_layout Plain Layout
29283 ] Specifies attribute information to be output with the item inner tag,
29285 \begin_inset Quotes eld
29289 \begin_inset Flex Code
29292 \begin_layout Plain Layout
29299 \begin_inset Quotes erd
29302 in the example above.
29303 This information can be used in further processing of the DocBook files.
29306 \begin_layout Description
29307 \begin_inset Flex Code
29310 \begin_layout Plain Layout
29311 DocBookItemInnerTag
29317 \begin_inset Flex Code
29320 \begin_layout Plain Layout
29326 ] The tag to be used for the item inner tag within the inset,
29328 \begin_inset Quotes eld
29332 \begin_inset Flex Code
29335 \begin_layout Plain Layout
29342 \begin_inset Quotes erd
29345 in the example above.
29347 \begin_inset Flex Code
29350 \begin_layout Plain Layout
29357 indicating that there is no item inner tag:
29358 content is directly output without it for each itemised element.
29359 This parameter only makes sense when itemising layouts are used,
29361 The most likely value is
29362 \begin_inset Quotes eld
29366 \begin_inset Flex Code
29369 \begin_layout Plain Layout
29376 \begin_inset Quotes erd
29380 \begin_inset Newline newline
29383 When a list item is split using a new line,
29384 the item inner tag will be repeated for each part of the paragraph,
29385 parts being separated by new lines.
29388 \begin_layout Description
29389 \begin_inset Flex Code
29392 \begin_layout Plain Layout
29393 DocBookItemInnerTagType
29399 \begin_inset Flex Code
29402 \begin_layout Plain Layout
29410 ] The new-line policy for this tag,
29412 \begin_inset space ~
29416 \begin_inset CommandInset ref
29418 reference "subsec:DocBook-New-line-policy"
29429 \begin_layout Description
29430 \begin_inset Flex Code
29433 \begin_layout Plain Layout
29434 DocBookItemLabelAttr
29440 \begin_inset Flex Code
29443 \begin_layout Plain Layout
29449 ] Specifies attribute information to be output with the item label tag,
29451 \begin_inset Quotes eld
29455 \begin_inset Flex Code
29458 \begin_layout Plain Layout
29465 \begin_inset Quotes erd
29468 in the example above.
29469 This information can be used in further processing of the DocBook files.
29472 \begin_layout Description
29473 \begin_inset Flex Code
29476 \begin_layout Plain Layout
29477 DocBookItemLabelTag
29483 \begin_inset Flex Code
29486 \begin_layout Plain Layout
29492 ] The tag to be used for the item label tag within the inset,
29494 \begin_inset Quotes eld
29498 \begin_inset Flex Code
29501 \begin_layout Plain Layout
29508 \begin_inset Quotes erd
29511 in the example above.
29512 This parameter only makes sense when itemising layouts are used with a notion of labels,
29513 such as definition lists.
29516 \begin_layout Description
29517 \begin_inset Flex Code
29520 \begin_layout Plain Layout
29521 DocBookItemLabelTagType
29527 \begin_inset Flex Code
29530 \begin_layout Plain Layout
29538 ] The new-line policy for this tag,
29540 \begin_inset space ~
29544 \begin_inset CommandInset ref
29546 reference "subsec:DocBook-New-line-policy"
29557 \begin_layout Description
29558 \begin_inset Flex Code
29561 \begin_layout Plain Layout
29568 \begin_inset Flex Code
29571 \begin_layout Plain Layout
29577 ] The tag to be used for the item tag within the inset,
29579 \begin_inset Quotes eld
29583 \begin_inset Flex Code
29586 \begin_layout Plain Layout
29593 \begin_inset Quotes erd
29596 in the example above.
29598 \begin_inset Flex Code
29601 \begin_layout Plain Layout
29608 indicating that there is no item tag.
29609 This parameter only makes sense when itemising layouts are used,
29613 \begin_layout Description
29614 \begin_inset Flex Code
29617 \begin_layout Plain Layout
29624 \begin_inset Flex Code
29627 \begin_layout Plain Layout
29635 ] The new-line policy for this tag,
29637 \begin_inset space ~
29641 \begin_inset CommandInset ref
29643 reference "subsec:DocBook-New-line-policy"
29654 \begin_layout Description
29655 \begin_inset Flex Code
29658 \begin_layout Plain Layout
29659 DocBookItemWrapperAttr
29665 \begin_inset Flex Code
29668 \begin_layout Plain Layout
29674 ] Specifies attribute information to be output with the item wrapper tag,
29676 \begin_inset Quotes eld
29680 \begin_inset Flex Code
29683 \begin_layout Plain Layout
29690 \begin_inset Quotes erd
29693 in the example above.
29694 This information can be used in further processing of the DocBook files.
29697 \begin_layout Description
29698 \begin_inset Flex Code
29701 \begin_layout Plain Layout
29702 DocBookItemWrapperTag
29708 \begin_inset Flex Code
29711 \begin_layout Plain Layout
29717 ] The tag to be used for the item wrapper tag within the inset,
29719 \begin_inset Quotes eld
29723 \begin_inset Flex Code
29726 \begin_layout Plain Layout
29733 \begin_inset Quotes erd
29736 in the example above.
29738 \begin_inset Flex Code
29741 \begin_layout Plain Layout
29748 indicating that there is no item wrapper tag:
29749 tag and content are directly output without it for each itemised element.
29750 This parameter only makes sense when itemising layouts are used,
29754 \begin_layout Description
29755 \begin_inset Flex Code
29758 \begin_layout Plain Layout
29759 DocBookItemWrapperTagType
29765 \begin_inset Flex Code
29768 \begin_layout Plain Layout
29776 ] The new-line policy for this tag,
29778 \begin_inset space ~
29782 \begin_inset CommandInset ref
29784 reference "subsec:DocBook-New-line-policy"
29795 \begin_layout Description
29796 \begin_inset Flex Code
29799 \begin_layout Plain Layout
29806 \begin_inset Flex Code
29809 \begin_layout Plain Layout
29815 ] Specifies attribute information to be output with the inner tag,
29817 \begin_inset Quotes eld
29821 \begin_inset Flex Code
29824 \begin_layout Plain Layout
29831 \begin_inset Quotes erd
29834 in the example above.
29835 This information can be used in further processing of the DocBook files.
29838 \begin_layout Description
29839 \begin_inset Flex Code
29842 \begin_layout Plain Layout
29849 \begin_inset Flex Code
29852 \begin_layout Plain Layout
29858 ] The tag to be used for the inner tag within the inset,
29860 \begin_inset Quotes eld
29864 \begin_inset Flex Code
29867 \begin_layout Plain Layout
29874 \begin_inset Quotes erd
29877 in the example above.
29879 \begin_inset Flex Code
29882 \begin_layout Plain Layout
29889 indicating that there is no inner tag:
29890 content is directly output without it.
29893 \begin_layout Description
29894 \begin_inset Flex Code
29897 \begin_layout Plain Layout
29898 DocBookInnerTagType
29904 \begin_inset Flex Code
29907 \begin_layout Plain Layout
29915 ] The new-line policy for this tag,
29917 \begin_inset space ~
29921 \begin_inset CommandInset ref
29923 reference "subsec:DocBook-New-line-policy"
29934 \begin_layout Description
29935 \begin_inset Flex Code
29938 \begin_layout Plain Layout
29945 \begin_inset Flex Code
29948 \begin_layout Plain Layout
29954 ] Specifies the tag that corresponds to this kind of section.
29955 This parameter only makes sense for sectioning elements (part,
29959 The default value is
29960 \begin_inset Flex Code
29963 \begin_layout Plain Layout
29970 and is only overridden when DocBook uses something else for sectioning (typically,
29971 parts and chapters of a book).
29974 \begin_layout Description
29975 \begin_inset Flex Code
29978 \begin_layout Plain Layout
29985 \begin_inset Flex Code
29988 \begin_layout Plain Layout
29994 ] The tag to be used for this inset,
29996 \begin_inset Quotes eld
30000 \begin_inset Flex Code
30003 \begin_layout Plain Layout
30010 \begin_inset Quotes erd
30013 in the example above.
30014 The default is the name of the float and always needs to be changed,
30015 as DocBook provides no generic inset tag.
30018 \begin_layout Description
30019 \begin_inset Flex Code
30022 \begin_layout Plain Layout
30029 \begin_inset Flex Code
30032 \begin_layout Plain Layout
30040 ] The new-line policy for this tag,
30042 \begin_inset space ~
30046 \begin_inset CommandInset ref
30048 reference "subsec:DocBook-New-line-policy"
30059 \begin_layout Description
30060 \begin_inset Flex Code
30063 \begin_layout Plain Layout
30070 \begin_inset Flex Code
30073 \begin_layout Plain Layout
30079 ] Specifies attribute information to be output with the outer wrapper tag,
30081 \begin_inset Quotes eld
30085 \begin_inset Flex Code
30088 \begin_layout Plain Layout
30095 \begin_inset Quotes erd
30098 in the example above.
30099 This information can be used in further processing of the DocBook files.
30102 \begin_layout Description
30103 \begin_inset Flex Code
30106 \begin_layout Plain Layout
30113 \begin_inset Flex Code
30116 \begin_layout Plain Layout
30122 ] The tag to be used for the wrapper tag around the inset,
30124 \begin_inset Quotes eld
30128 \begin_inset Flex Code
30131 \begin_layout Plain Layout
30138 \begin_inset Quotes erd
30141 in the example above.
30143 \begin_inset Flex Code
30146 \begin_layout Plain Layout
30153 indicating that there is no wrapper tag:
30154 tag and content are directly output without it.
30157 \begin_layout Description
30158 \begin_inset Flex Code
30161 \begin_layout Plain Layout
30162 DocBookWrapperTagType
30168 \begin_inset Flex Code
30171 \begin_layout Plain Layout
30179 ] The new-line policy for this tag,
30181 \begin_inset space ~
30185 \begin_inset CommandInset ref
30187 reference "subsec:DocBook-New-line-policy"
30198 \begin_layout Subsection
30202 \begin_layout Standard
30203 The DocBook output for floats too can be controlled by layout information.
30204 The output has the following form:
30207 \begin_layout LyX-Code
30211 \begin_layout LyX-Code
30212 Contents of the float as DocBook.
30215 \begin_layout LyX-Code
30219 \begin_layout Standard
30222 is a separate inset and will be output as a title.
30225 \begin_layout Description
30226 \begin_inset Flex Code
30229 \begin_layout Plain Layout
30236 \begin_inset Flex Code
30239 \begin_layout Plain Layout
30245 ] Specifies attribute information to be output with the main tag,
30247 \begin_inset Quotes eld
30251 \begin_inset Flex Code
30254 \begin_layout Plain Layout
30261 \begin_inset Quotes erd
30264 in the example above.
30265 This information can be used in further processing of the DocBook files.
30268 \begin_layout Description
30269 \begin_inset Flex Code
30272 \begin_layout Plain Layout
30279 \begin_inset Flex Code
30282 \begin_layout Plain Layout
30288 ] The tag to be used for this float,
30290 \begin_inset Quotes eld
30294 \begin_inset Flex Code
30297 \begin_layout Plain Layout
30304 \begin_inset Quotes erd
30307 in the example above.
30308 The default is the name of the float and always needs to be changed,
30309 as DocBook provides no generic float tag.
30312 \begin_layout Subsection
30313 Bibliography formatting
30316 \begin_layout Standard
30317 Included bibliographies cannot be formatted:
30318 all fields are always output in the database-like DocBook format (equivalent to a BibTeX file),
30320 \begin_inset Flex Code
30323 \begin_layout Plain Layout
30332 \begin_layout Standard
30333 When the bibliographic entries are manually inserted into the \SpecialChar LyX
30334 document as Bibliography Items,
30335 the user deals with formatting themself:
30336 there is no attempt of parsing what the user wrote,
30337 the string is directly used (with the
30338 \begin_inset Flex Code
30341 \begin_layout Plain Layout
30350 \begin_layout Chapter
30351 Including External Material
30352 \begin_inset CommandInset label
30354 name "chap:Including-External-Material"
30361 \begin_layout Standard
30362 \begin_inset Box Shadowbox
30372 height_special "totalheight"
30377 backgroundcolor "none"
30380 \begin_layout Plain Layout
30382 This portion of the documentation has not been updated for some time.
30383 We certainly hope that it is still accurate,
30384 but there are no guarantees.
30392 \begin_layout Standard
30393 The use of material from sources external to \SpecialChar LyX
30394 is covered in detail in the
30399 This part of the manual covers what needs to happen behind the scenes for new sorts of material to be included.
30402 \begin_layout Section
30406 \begin_layout Standard
30407 The external material feature is based on the concept of a
30412 A template is a specification of how \SpecialChar LyX
30413 should interface with a certain kind of material.
30416 comes with predefined templates for Xfig figures,
30417 various raster format images,
30419 and LilyPond music notation.
30420 You can check the actual list by using the menu
30421 \begin_inset Flex Noun
30424 \begin_layout Plain Layout
30425 Insert\SpecialChar menuseparator
30426 File\SpecialChar menuseparator
30434 it is possible to roll your own template to support a specific kind of material.
30435 Later we'll describe in more detail what is involved,
30436 and hopefully you will submit all the templates you create so we can include them in a later \SpecialChar LyX
30440 \begin_layout Standard
30441 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.
30443 consider the case of a figure produced with
30444 \begin_inset Flex Code
30447 \begin_layout Plain Layout
30454 The Xfig application itself works on an original file with the
30455 \begin_inset Flex Code
30458 \begin_layout Plain Layout
30466 you create and change your figure,
30467 and when you are done,
30469 \begin_inset Flex Code
30472 \begin_layout Plain Layout
30479 When you want to include the figure in your document,
30481 \begin_inset Flex Code
30484 \begin_layout Plain Layout
30490 in order to create a PostScript file that can readily be included in your \SpecialChar LaTeX
30494 \begin_inset Flex Code
30497 \begin_layout Plain Layout
30503 file is the original file,
30504 and the PostScript file is the produced file.
30507 \begin_layout Standard
30508 This distinction is important in order to allow updating of the material while you are in the process of writing the document.
30510 it provides us with the flexibility that is needed to support multiple export formats.
30512 in the case of a plain text file,
30513 it is not exactly an award-winning idea to include the figure as raw PostScript.
30515 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.
30516 The external material management allows you to do this,
30517 because it is parametrized on the different export formats that \SpecialChar LyX
30521 \begin_layout Standard
30522 Besides supporting the production of different products according to the exported format,
30523 it supports tight integration with editing and viewing applications.
30524 In the case of an Xfig figure,
30525 you are able to invoke Xfig on the original file with a single click from within the external material dialog in \SpecialChar LyX
30527 and also preview the produced PostScript file with Ghostview with another click.
30528 No more fiddling around with the command line and/or file browsers to locate and manipulate the original or produced files.
30530 you are finally able to take full advantage of the many different applications that are relevant to use when you write your documents,
30531 and ultimately be more productive.
30534 \begin_layout Section
30535 The external template configuration files
30538 \begin_layout Standard
30539 It is relatively easy to add custom external template definitions to \SpecialChar LyX
30542 be aware that doing this in an careless manner most probably
30546 introduce an easily exploitable security hole.
30547 So before you do this,
30548 please read the discussion about security in
30549 \begin_inset CommandInset ref
30551 reference "sec:Security-discussion"
30559 \begin_layout Standard
30561 we encourage you to submit any interesting templates that you create.
30565 \begin_layout Standard
30566 The external templates are defined in the
30567 \begin_inset Flex Code
30570 \begin_layout Plain Layout
30576 files that are stored in the
30577 \begin_inset Flex Code
30580 \begin_layout Plain Layout
30581 LyXDir/lib/xtemplates/
30587 Each template is defined in a file of its own.
30588 You can place your own templates in
30589 \begin_inset Flex Code
30592 \begin_layout Plain Layout
30593 UserDir/xtemplates/
30598 or copy existing templates to that directory in order to modify them.
30601 \begin_layout Standard
30602 A typical template looks like this:
30605 \begin_layout LyX-Code
30609 \begin_layout LyX-Code
30611 $$AbsOrRelPathParent$$Basename"
30614 \begin_layout LyX-Code
30618 \begin_layout LyX-Code
30622 \begin_layout LyX-Code
30626 \begin_layout LyX-Code
30630 \begin_layout LyX-Code
30634 \begin_layout LyX-Code
30635 AutomaticProduction true
30638 \begin_layout LyX-Code
30642 \begin_layout LyX-Code
30646 \begin_layout LyX-Code
30650 \begin_layout LyX-Code
30651 TransformCommand Rotate RotationLatexCommand
30654 \begin_layout LyX-Code
30655 TransformCommand Resize ResizeLatexCommand
30658 \begin_layout LyX-Code
30659 Product "$$RotateFront$$ResizeFront
30662 \begin_layout LyX-Code
30667 input{$$AbsOrRelPathMaster$$Basename.pstex_t}
30670 \begin_layout LyX-Code
30671 $$ResizeBack$$RotateBack"
30674 \begin_layout LyX-Code
30678 \begin_layout LyX-Code
30679 UpdateResult "$$AbsPath$$Basename.pstex_t"
30682 \begin_layout LyX-Code
30683 Requirement "graphicx"
30686 \begin_layout LyX-Code
30687 ReferencedFile latex "$$AbsOrRelPathMaster$$Basename.pstex_t"
30690 \begin_layout LyX-Code
30691 ReferencedFile latex "$$AbsPath$$Basename.eps"
30694 \begin_layout LyX-Code
30695 ReferencedFile dvi "$$AbsPath$$Basename.eps"
30698 \begin_layout LyX-Code
30702 \begin_layout LyX-Code
30706 \begin_layout LyX-Code
30707 TransformCommand Rotate RotationLatexCommand
30710 \begin_layout LyX-Code
30711 TransformCommand Resize ResizeLatexCommand
30714 \begin_layout LyX-Code
30715 Product "$$RotateFront$$ResizeFront
30718 \begin_layout LyX-Code
30723 input{$$AbsOrRelPathMaster$$Basename.pdftex_t}
30726 \begin_layout LyX-Code
30727 $$ResizeBack$$RotateBack"
30730 \begin_layout LyX-Code
30731 UpdateFormat pdftex
30734 \begin_layout LyX-Code
30735 UpdateResult "$$AbsPath$$Basename.pdftex_t"
30738 \begin_layout LyX-Code
30739 Requirement "graphicx"
30742 \begin_layout LyX-Code
30743 ReferencedFile latex "$$AbsOrRelPathMaster$$Basename.pdftex_t"
30746 \begin_layout LyX-Code
30747 ReferencedFile latex "$$AbsPath$$Basename.pdf"
30750 \begin_layout LyX-Code
30754 \begin_layout LyX-Code
30758 \begin_layout LyX-Code
30763 \begin_layout LyX-Code
30767 \begin_layout LyX-Code
30771 \begin_layout LyX-Code
30772 Product "<graphic fileref=
30774 "$$AbsOrRelPathMaster$$Basename.eps
30779 \begin_layout LyX-Code
30783 \begin_layout LyX-Code
30787 \begin_layout LyX-Code
30788 UpdateResult "$$AbsPath$$Basename.eps"
30791 \begin_layout LyX-Code
30792 ReferencedFile docbook "$$AbsPath$$Basename.eps"
30795 \begin_layout LyX-Code
30796 ReferencedFile docbook-xml "$$AbsPath$$Basename.eps"
30799 \begin_layout LyX-Code
30803 \begin_layout LyX-Code
30807 \begin_layout Standard
30809 the template is enclosed in
30810 \begin_inset Flex Code
30813 \begin_layout Plain Layout
30821 \begin_inset Flex Code
30824 \begin_layout Plain Layout
30831 It contains a header specifying some general settings and,
30832 for each supported primary document file format,
30834 \begin_inset Flex Code
30837 \begin_layout Plain Layout
30845 \begin_inset Flex Code
30848 \begin_layout Plain Layout
30857 \begin_layout Subsection
30858 The template header
30861 \begin_layout Description
30862 \begin_inset Flex Code
30865 \begin_layout Plain Layout
30866 AutomaticProduction
30867 \begin_inset space ~
30875 Whether the file represented by the template must be generated by \SpecialChar LyX
30877 This command must occur exactly once.
30880 \begin_layout Description
30881 \begin_inset Flex Code
30884 \begin_layout Plain Layout
30886 \begin_inset space ~
30894 A glob pattern that is used in the file dialog to filter out the desired files.
30895 If there is more than one possible file extension (e.
30896 \begin_inset space \thinspace{}
30900 \begin_inset space \space{}
30904 \begin_inset Flex Code
30907 \begin_layout Plain Layout
30914 \begin_inset Flex Code
30917 \begin_layout Plain Layout
30925 \begin_inset Flex Code
30928 \begin_layout Plain Layout
30935 This command must occur exactly once.
30938 \begin_layout Description
30939 \begin_inset Flex Code
30942 \begin_layout Plain Layout
30944 \begin_inset space ~
30952 The text that is displayed on the button.
30953 This command must occur exactly once.
30956 \begin_layout Description
30957 \begin_inset Flex Code
30960 \begin_layout Plain Layout
30962 \begin_inset space ~
30966 \begin_inset space ~
30974 The help text that is used in the External dialog.
30975 Provide enough information to explain to the user just what the template can provide him with.
30976 This command must occur exactly once.
30979 \begin_layout Description
30980 \begin_inset Flex Code
30983 \begin_layout Plain Layout
30985 \begin_inset space ~
30993 The file format of the original file.
30994 This must be the name of a format that is known to \SpecialChar LyX
30996 \begin_inset CommandInset ref
30998 reference "sec:Formats"
31005 \begin_inset Quotes eld
31009 \begin_inset Flex Code
31012 \begin_layout Plain Layout
31019 \begin_inset Quotes erd
31022 if the template can handle original files of more than one format.
31024 will attempt to interrogate the file itself in order to deduce its format in this case.
31025 This command must occur exactly once.
31028 \begin_layout Description
31029 \begin_inset Flex Code
31032 \begin_layout Plain Layout
31034 \begin_inset space ~
31042 A unique name for the template.
31043 It must not contain substitution macros (see below).
31046 \begin_layout Description
31047 \begin_inset Flex Code
31050 \begin_layout Plain Layout
31052 \begin_inset space ~
31055 Rotate|Resize|Clip|Extra
31060 This command specifies which transformations are supported by this template.
31061 It may occur zero or more times.
31062 This command enables the corresponding tabs in the external dialog.
31064 \begin_inset Flex Code
31067 \begin_layout Plain Layout
31073 command must have either a corresponding
31074 \begin_inset Flex Code
31077 \begin_layout Plain Layout
31084 \begin_inset Flex Code
31087 \begin_layout Plain Layout
31094 \begin_inset Flex Code
31097 \begin_layout Plain Layout
31104 Otherwise the transformation will not be supported by that format.
31107 \begin_layout Subsection
31111 \begin_layout Description
31112 \begin_inset Flex Code
31115 \begin_layout Plain Layout
31117 \begin_inset space ~
31120 LaTeX|PDFLaTeX|PlainText|DocBook|XHTML
31125 The primary document file format that this format definition is for.
31126 Not every template has a sensible representation in all document file formats.
31127 Please define nevertheless a
31128 \begin_inset Flex Code
31131 \begin_layout Plain Layout
31137 section for all templates.
31138 Use a dummy text when no representation is available.
31139 Then you can at least see a reference to the external material in the exported document.
31142 \begin_layout Description
31143 \begin_inset Flex Code
31146 \begin_layout Plain Layout
31148 \begin_inset space ~
31152 \begin_inset space ~
31160 This command defines an additional macro
31161 \begin_inset Flex Code
31164 \begin_layout Plain Layout
31170 for substitution in
31171 \begin_inset Flex Code
31174 \begin_layout Plain Layout
31182 \begin_inset Flex Code
31185 \begin_layout Plain Layout
31191 itself may contain substitution macros.
31192 The advantage over using
31193 \begin_inset Flex Code
31196 \begin_layout Plain Layout
31203 \begin_inset Flex Code
31206 \begin_layout Plain Layout
31212 is that the substituted value of
31213 \begin_inset Flex Code
31216 \begin_layout Plain Layout
31222 is sanitized so that it is a valid optional argument in the document format.
31223 This command may occur zero or more times.
31226 \begin_layout Description
31227 \begin_inset Flex Code
31230 \begin_layout Plain Layout
31232 \begin_inset space ~
31240 The text that is inserted in the exported document.
31241 This is actually the most important command and can be quite complex.
31242 This command must occur exactly once.
31245 \begin_layout Description
31246 \begin_inset Flex Code
31249 \begin_layout Plain Layout
31251 \begin_inset space ~
31259 This command specifies a preamble snippet that will be included in the \SpecialChar LaTeX
31261 It has to be defined using
31262 \begin_inset Flex Code
31265 \begin_layout Plain Layout
31273 \begin_inset Flex Code
31276 \begin_layout Plain Layout
31283 This command may occur zero or more times.
31286 \begin_layout Description
31287 \begin_inset Flex Code
31290 \begin_layout Plain Layout
31292 \begin_inset space ~
31296 \begin_inset space ~
31304 This command denotes files that are created by the conversion process and are needed for a particular export format.
31305 If the filename is relative,
31306 it is interpreted relative to the master document.
31307 This command may be given zero or more times.
31310 \begin_layout Description
31311 \begin_inset Flex Code
31314 \begin_layout Plain Layout
31316 \begin_inset space ~
31324 The name of a required \SpecialChar LaTeX
31326 The package is included via
31327 \begin_inset Flex Code
31330 \begin_layout Plain Layout
31338 in the \SpecialChar LaTeX
31340 This command may occur zero or more times.
31343 \begin_layout Description
31344 \begin_inset Flex Code
31347 \begin_layout Plain Layout
31349 \begin_inset space ~
31353 \begin_inset space ~
31356 RotationLatexCommand
31361 This command specifies that the built in \SpecialChar LaTeX
31362 command should be used for rotation.
31363 This command may occur once or not at all.
31366 \begin_layout Description
31367 \begin_inset Flex Code
31370 \begin_layout Plain Layout
31372 \begin_inset space ~
31376 \begin_inset space ~
31384 This command specifies that the built in \SpecialChar LaTeX
31385 command should be used for resizing.
31386 This command may occur once or not at all.
31389 \begin_layout Description
31390 \begin_inset Flex Code
31393 \begin_layout Plain Layout
31395 \begin_inset space ~
31399 \begin_inset space ~
31402 RotationLatexOption
31407 This command specifies that rotation is done via an optional argument.
31408 This command may occur once or not at all.
31411 \begin_layout Description
31412 \begin_inset Flex Code
31415 \begin_layout Plain Layout
31417 \begin_inset space ~
31421 \begin_inset space ~
31429 This command specifies that resizing is done via an optional argument.
31430 This command may occur once or not at all.
31433 \begin_layout Description
31434 \begin_inset Flex Code
31437 \begin_layout Plain Layout
31439 \begin_inset space ~
31443 \begin_inset space ~
31451 This command specifies that clipping is done via an optional argument.
31452 This command may occur once or not at all.
31455 \begin_layout Description
31456 \begin_inset Flex Code
31459 \begin_layout Plain Layout
31461 \begin_inset space ~
31465 \begin_inset space ~
31473 This command specifies that an extra optional argument is used.
31474 This command may occur once or not at all.
31477 \begin_layout Description
31478 \begin_inset Flex Code
31481 \begin_layout Plain Layout
31483 \begin_inset space ~
31491 The file format of the converted file.
31492 This must be the name of a format that is known to \SpecialChar LyX
31494 \begin_inset Flex Noun
31497 \begin_layout Plain Layout
31498 Tools\SpecialChar menuseparator
31499 Preferences\SpecialChar menuseparator
31500 File Handling\SpecialChar menuseparator
31507 This command must occur exactly once.
31508 If the resulting file format is PDF,
31509 you need to specify the format
31510 \begin_inset Flex Code
31513 \begin_layout Plain Layout
31520 This is the PDF format used for including graphics.
31521 The other defined PDF formats are for document export.
31524 \begin_layout Description
31525 \begin_inset Flex Code
31528 \begin_layout Plain Layout
31530 \begin_inset space ~
31538 The file name of the converted file.
31539 The file name must be absolute.
31540 This command must occur exactly once.
31543 \begin_layout Subsection
31544 Preamble definitions
31547 \begin_layout Standard
31548 The external template configuration file may contain additional preamble definitions enclosed by
31549 \begin_inset Flex Code
31552 \begin_layout Plain Layout
31560 \begin_inset Flex Code
31563 \begin_layout Plain Layout
31570 They can be used by the templates in the
31571 \begin_inset Flex Code
31574 \begin_layout Plain Layout
31583 \begin_layout Section
31584 The substitution mechanism
31587 \begin_layout Standard
31588 When the external material facility invokes an external program,
31589 it is done on the basis of a command defined in the template configuration file.
31590 These commands can contain various macros that are expanded before execution.
31591 Execution always take place in the directory of the containing document.
31594 \begin_layout Standard
31596 whenever external material is to be displayed,
31597 the name will be produced by the substitution mechanism,
31598 and most other commands in the template definition support substitution as well.
31601 \begin_layout Standard
31602 The available macros are the following:
31605 \begin_layout Description
31606 \begin_inset Flex Code
31609 \begin_layout Plain Layout
31610 $$AbsOrRelPathMaster
31616 absolute or relative to the master \SpecialChar LyX
31620 \begin_layout Description
31621 \begin_inset Flex Code
31624 \begin_layout Plain Layout
31625 $$AbsOrRelPathParent
31631 absolute or relative to the \SpecialChar LyX
31635 \begin_layout Description
31636 \begin_inset Flex Code
31639 \begin_layout Plain Layout
31645 The absolute file path
31646 \change_inserted -712698321 1712390130
31648 If compiling with \SpecialChar LyX
31650 this is the path to the file in the temporary directory
31655 \begin_layout Description
31656 \begin_inset Flex Code
31659 \begin_layout Plain Layout
31665 The filename without path and without the extension.
31668 \begin_layout Description
31669 \begin_inset Flex Code
31672 \begin_layout Plain Layout
31674 \begin_inset Quotes eld
31678 \begin_inset Quotes erd
31686 This macro will expand to the contents of the file with the name
31687 \begin_inset Flex Code
31690 \begin_layout Plain Layout
31699 \begin_layout Description
31700 \begin_inset Flex Code
31703 \begin_layout Plain Layout
31709 The file extension (including the dot).
31712 \begin_layout Description
31713 \begin_inset Flex Code
31716 \begin_layout Plain Layout
31722 This will be the string
31723 \begin_inset Quotes eld
31727 \begin_inset Quotes erd
31730 if the file is in JPEG format,
31731 otherwise it will be the string
31732 \begin_inset Quotes eld
31736 \begin_inset Quotes erd
31740 This is useful to avoid uneeded conversions for output formats that support both PNG and JPEG fomats.
31741 The predefined RasterImage template uses this macro for the pdf\SpecialChar TeX
31745 \begin_layout Description
31746 \begin_inset Flex Code
31749 \begin_layout Plain Layout
31755 The filename of the file specified in the external material dialog.
31756 This is either an absolute name,
31757 or it is relative to the \SpecialChar LyX
31761 \begin_layout Description
31762 \begin_inset Flex Code
31765 \begin_layout Plain Layout
31772 \begin_inset Flex Code
31775 \begin_layout Plain Layout
31781 (absolute name or relative to the \SpecialChar LyX
31783 \change_inserted -712698321 1712389740
31787 \begin_layout Description
31789 \change_inserted -712698321 1712390181
31790 \begin_inset Flex Code
31793 \begin_layout Plain Layout
31795 \change_inserted -712698321 1712389749
31803 The file name with absolute path to the original directory (not the temporary directory).
31808 \begin_layout Description
31809 \begin_inset Flex Code
31812 \begin_layout Plain Layout
31819 relative to the master \SpecialChar LyX
31823 \begin_layout Description
31824 \begin_inset Flex Code
31827 \begin_layout Plain Layout
31834 relative to the \SpecialChar LyX
31838 \begin_layout Description
31839 \begin_inset Flex Code
31842 \begin_layout Plain Layout
31848 This macro will expand to the absolute path of the system directory.
31849 This is typically used to point to the various helper scripts that are bundled with \SpecialChar LyX
31853 \begin_layout Description
31854 \begin_inset Flex Code
31857 \begin_layout Plain Layout
31863 A name and full path to a temporary file which will be automatically deleted whenever the containing document is closed,
31864 or the external material insertion deleted.
31867 \begin_layout Standard
31868 All path macros contain a trailing directory separator,
31869 so you can construct e.
31870 \begin_inset space \thinspace{}
31874 \begin_inset space \space{}
31877 the absolute filename with
31878 \begin_inset Flex Code
31881 \begin_layout Plain Layout
31882 $$AbsPath$$Basename$$Extension
31890 \begin_layout Standard
31891 The macros above are substituted in all commands unless otherwise noted.
31893 \begin_inset Flex Code
31896 \begin_layout Plain Layout
31902 supports additionally the following substitutions if they are enabled by the
31903 \begin_inset Flex Code
31906 \begin_layout Plain Layout
31913 \begin_inset Flex Code
31916 \begin_layout Plain Layout
31925 \begin_layout Description
31926 \begin_inset Flex Code
31929 \begin_layout Plain Layout
31935 The front part of the resize command.
31938 \begin_layout Description
31939 \begin_inset Flex Code
31942 \begin_layout Plain Layout
31948 The back part of the resize command.
31951 \begin_layout Description
31952 \begin_inset Flex Code
31955 \begin_layout Plain Layout
31961 The front part of the rotation command.
31964 \begin_layout Description
31965 \begin_inset Flex Code
31968 \begin_layout Plain Layout
31974 The back part of the rotation command.
31977 \begin_layout Standard
31978 The value string of the
31979 \begin_inset Flex Code
31982 \begin_layout Plain Layout
31988 command supports additionally the following substitutions if they are enabled by the
31989 \begin_inset Flex Code
31992 \begin_layout Plain Layout
31999 \begin_inset Flex Code
32002 \begin_layout Plain Layout
32011 \begin_layout Description
32012 \begin_inset Flex Code
32015 \begin_layout Plain Layout
32024 \begin_layout Description
32025 \begin_inset Flex Code
32028 \begin_layout Plain Layout
32037 \begin_layout Description
32038 \begin_inset Flex Code
32041 \begin_layout Plain Layout
32050 \begin_layout Description
32051 \begin_inset Flex Code
32054 \begin_layout Plain Layout
32060 The rotation option.
32063 \begin_layout Standard
32064 You may ask why there are so many path macros.
32065 There are mainly two reasons:
32068 \begin_layout Enumerate
32069 Relative and absolute file names should remain relative or absolute,
32071 Users may have reasons to prefer either form.
32072 Relative names are useful for portable documents that should work on different machines,
32074 Absolute names may be required by some programs.
32077 \begin_layout Enumerate
32079 treats relative file names differently than \SpecialChar LyX
32080 and other programs in nested included files.
32081 For \SpecialChar LyX
32083 a relative file name is always relative to the document that contains the file name.
32084 For \SpecialChar LaTeX
32086 it is always relative to the master document.
32087 These two definitions are identical if you have only one document,
32088 but differ if you have a master document that includes part documents.
32089 That means that relative filenames must be transformed when presented to \SpecialChar LaTeX
32091 Fortunately \SpecialChar LyX
32092 does this automatically for you if you choose the right macros.
32095 \begin_layout Standard
32096 So which path macro should be used in new template definitions?
32097 The rule is not difficult:
32100 \begin_layout Itemize
32102 \begin_inset Flex Code
32105 \begin_layout Plain Layout
32111 if an absolute path is required.
32114 \begin_layout Itemize
32116 \begin_inset Flex Code
32119 \begin_layout Plain Layout
32120 $$AbsOrRelPathMaster
32125 if the substituted string is some kind of \SpecialChar LaTeX
32129 \begin_layout Itemize
32131 \begin_inset Flex Code
32134 \begin_layout Plain Layout
32135 $$AbsOrRelPathParent
32140 in order to preserve the user's choice.
32143 \begin_layout Standard
32144 There are special cases where this rule does not work and e.
32145 \begin_inset space \thinspace{}
32149 \begin_inset space \space{}
32152 relative names are needed,
32153 but normally it will work just fine.
32154 One example for such a case is the command
32155 \begin_inset Flex Code
32158 \begin_layout Plain Layout
32159 ReferencedFile latex "$$AbsOrRelPathMaster$$Basename.pstex_t"
32164 in the XFig template above:
32165 We can't use the absolute name because the copier for
32166 \begin_inset Flex Code
32169 \begin_layout Plain Layout
32175 files needs the relative name in order to rewrite the file content.
32178 \begin_layout Section
32179 Security discussion
32180 \begin_inset CommandInset label
32182 name "sec:Security-discussion"
32189 \begin_layout Standard
32190 The external material feature interfaces with a lot of external programs and does so automatically,
32191 so we have to consider the security implications of this.
32193 since you have the option of including your own filenames and/or parameter strings and those are expanded into a command,
32194 it seems that it would be possible to create a malicious document which executes arbitrary commands when a user views or prints the document.
32195 This is something we definitely want to avoid.
32198 \begin_layout Standard
32200 since the external program commands are specified in the template configuration file only,
32201 there are no security issues if \SpecialChar LyX
32202 is properly configured with safe templates only.
32203 This is so because the external programs are invoked with the
32204 \begin_inset Flex Code
32207 \begin_layout Plain Layout
32213 -system call rather than the
32214 \begin_inset Flex Code
32217 \begin_layout Plain Layout
32224 so it's not possible to execute arbitrary commands from the filename or parameter section via the shell.
32227 \begin_layout Standard
32228 This also implies that you are restricted in what command strings you can use in the external material templates.
32230 pipes and redirection are not readily available.
32231 This has to be so if \SpecialChar LyX
32232 should remain safe.
32233 If you want to use some of the shell features,
32234 you should write a safe script to do this in a controlled manner,
32235 and then invoke the script from the command string.
32239 \begin_layout Standard
32240 It is possible to design a template that interacts directly with the shell,
32241 but since this would allow a malicious user to execute arbitrary commands by writing clever filenames and/or parameters,
32242 we generally recommend that you only use safe scripts that work with the
32243 \begin_inset Flex Code
32246 \begin_layout Plain Layout
32252 system call in a controlled manner.
32254 for use in a controlled environment,
32255 it can be tempting to just fall back to use ordinary shell scripts.
32261 provide an easily exploitable security hole in your system.
32262 Of course it stands to reason that such unsafe templates will never be included in the standard \SpecialChar LyX
32264 although we do encourage people to submit new templates in the open source tradition.
32265 But \SpecialChar LyX
32266 as shipped from the official distribution channels will never have unsafe templates.
32269 \begin_layout Standard
32270 Including external material provides a lot of power,
32271 and you have to be careful not to introduce security hazards with this power.
32272 A subtle error in a single line in an innocent looking script can open the door to huge security problems.
32273 So if you do not fully understand the issues,
32274 we recommend that you consult a knowledgeable security professional or the \SpecialChar LyX
32275 development team if you have any questions about whether a given template is safe or not.
32276 And do this before you use it in an uncontrolled environment.
32279 \begin_layout Chapter
32281 List of supported \SpecialChar LyX
32282 functions to be used in layouts
32283 \begin_inset CommandInset label
32285 name "chap:List-of-functions"
32292 \begin_layout Standard
32294 \begin_inset Tabular
32295 <lyxtabular version="3" rows="11" columns="8">
32296 <features tabularvalignment="middle">
32297 <column alignment="left" valignment="top">
32298 <column alignment="left" valignment="top">
32299 <column alignment="left" valignment="top">
32300 <column alignment="left" valignment="top">
32301 <column alignment="left" valignment="top">
32302 <column alignment="left" valignment="top">
32303 <column alignment="left" valignment="top">
32304 <column alignment="left" valignment="top">
32306 <cell alignment="left" valignment="top" usebox="none">
32309 \begin_layout Plain Layout
32315 <cell alignment="left" valignment="top" usebox="none">
32318 \begin_layout Plain Layout
32324 <cell alignment="left" valignment="top" usebox="none">
32327 \begin_layout Plain Layout
32333 <cell alignment="left" valignment="top" usebox="none">
32336 \begin_layout Plain Layout
32342 <cell alignment="center" valignment="top" usebox="none">
32345 \begin_layout Plain Layout
32351 <cell alignment="center" valignment="top" usebox="none">
32354 \begin_layout Plain Layout
32360 <cell alignment="center" valignment="top" usebox="none">
32363 \begin_layout Plain Layout
32369 <cell alignment="center" valignment="top" usebox="none">
32372 \begin_layout Plain Layout
32380 <cell alignment="left" valignment="top" usebox="none">
32383 \begin_layout Plain Layout
32389 <cell alignment="left" valignment="top" usebox="none">
32392 \begin_layout Plain Layout
32398 <cell alignment="left" valignment="top" usebox="none">
32401 \begin_layout Plain Layout
32407 <cell alignment="left" valignment="top" usebox="none">
32410 \begin_layout Plain Layout
32416 <cell alignment="center" valignment="top" usebox="none">
32419 \begin_layout Plain Layout
32425 <cell alignment="center" valignment="top" usebox="none">
32428 \begin_layout Plain Layout
32434 <cell alignment="center" valignment="top" usebox="none">
32437 \begin_layout Plain Layout
32443 <cell alignment="center" valignment="top" usebox="none">
32446 \begin_layout Plain Layout
32454 <cell alignment="left" valignment="top" usebox="none">
32457 \begin_layout Plain Layout
32463 <cell alignment="left" valignment="top" usebox="none">
32466 \begin_layout Plain Layout
32472 <cell alignment="left" valignment="top" usebox="none">
32475 \begin_layout Plain Layout
32481 <cell alignment="left" valignment="top" usebox="none">
32484 \begin_layout Plain Layout
32490 <cell alignment="center" valignment="top" usebox="none">
32493 \begin_layout Plain Layout
32499 <cell alignment="center" valignment="top" usebox="none">
32502 \begin_layout Plain Layout
32508 <cell alignment="center" valignment="top" usebox="none">
32511 \begin_layout Plain Layout
32517 <cell alignment="center" valignment="top" usebox="none">
32520 \begin_layout Plain Layout
32528 <cell alignment="left" valignment="top" usebox="none">
32531 \begin_layout Plain Layout
32537 <cell alignment="left" valignment="top" usebox="none">
32540 \begin_layout Plain Layout
32546 <cell alignment="left" valignment="top" usebox="none">
32549 \begin_layout Plain Layout
32555 <cell alignment="left" valignment="top" usebox="none">
32558 \begin_layout Plain Layout
32564 <cell alignment="center" valignment="top" usebox="none">
32567 \begin_layout Plain Layout
32573 <cell alignment="center" valignment="top" usebox="none">
32576 \begin_layout Plain Layout
32582 <cell alignment="center" valignment="top" usebox="none">
32585 \begin_layout Plain Layout
32591 <cell alignment="center" valignment="top" usebox="none">
32594 \begin_layout Plain Layout
32602 <cell alignment="left" valignment="top" usebox="none">
32605 \begin_layout Plain Layout
32611 <cell alignment="left" valignment="top" usebox="none">
32614 \begin_layout Plain Layout
32620 <cell alignment="left" valignment="top" usebox="none">
32623 \begin_layout Plain Layout
32629 <cell alignment="left" valignment="top" usebox="none">
32632 \begin_layout Plain Layout
32638 <cell alignment="center" valignment="top" usebox="none">
32641 \begin_layout Plain Layout
32647 <cell alignment="center" valignment="top" usebox="none">
32650 \begin_layout Plain Layout
32656 <cell alignment="center" valignment="top" usebox="none">
32659 \begin_layout Plain Layout
32665 <cell alignment="center" valignment="top" usebox="none">
32668 \begin_layout Plain Layout
32676 <cell alignment="left" valignment="top" usebox="none">
32679 \begin_layout Plain Layout
32685 <cell alignment="left" valignment="top" usebox="none">
32688 \begin_layout Plain Layout
32694 <cell alignment="left" valignment="top" usebox="none">
32697 \begin_layout Plain Layout
32703 <cell alignment="left" valignment="top" usebox="none">
32706 \begin_layout Plain Layout
32712 <cell alignment="center" valignment="top" usebox="none">
32715 \begin_layout Plain Layout
32721 <cell alignment="center" valignment="top" usebox="none">
32724 \begin_layout Plain Layout
32730 <cell alignment="center" valignment="top" usebox="none">
32733 \begin_layout Plain Layout
32739 <cell alignment="center" valignment="top" usebox="none">
32742 \begin_layout Plain Layout
32750 <cell alignment="left" valignment="top" usebox="none">
32753 \begin_layout Plain Layout
32759 <cell alignment="left" valignment="top" usebox="none">
32762 \begin_layout Plain Layout
32768 <cell alignment="left" valignment="top" usebox="none">
32771 \begin_layout Plain Layout
32777 <cell alignment="left" valignment="top" usebox="none">
32780 \begin_layout Plain Layout
32786 <cell alignment="center" valignment="top" usebox="none">
32789 \begin_layout Plain Layout
32795 <cell alignment="center" valignment="top" usebox="none">
32798 \begin_layout Plain Layout
32804 <cell alignment="center" valignment="top" usebox="none">
32807 \begin_layout Plain Layout
32813 <cell alignment="center" valignment="top" usebox="none">
32816 \begin_layout Plain Layout
32824 <cell alignment="left" valignment="top" usebox="none">
32827 \begin_layout Plain Layout
32833 <cell alignment="left" valignment="top" usebox="none">
32836 \begin_layout Plain Layout
32842 <cell alignment="left" valignment="top" usebox="none">
32845 \begin_layout Plain Layout
32851 <cell alignment="left" valignment="top" usebox="none">
32854 \begin_layout Plain Layout
32860 <cell alignment="center" valignment="top" usebox="none">
32863 \begin_layout Plain Layout
32869 <cell alignment="center" valignment="top" usebox="none">
32872 \begin_layout Plain Layout
32878 <cell alignment="center" valignment="top" usebox="none">
32881 \begin_layout Plain Layout
32887 <cell alignment="center" valignment="top" usebox="none">
32890 \begin_layout Plain Layout
32898 <cell alignment="left" valignment="top" usebox="none">
32901 \begin_layout Plain Layout
32907 <cell alignment="left" valignment="top" usebox="none">
32910 \begin_layout Plain Layout
32916 <cell alignment="left" valignment="top" usebox="none">
32919 \begin_layout Plain Layout
32925 <cell alignment="left" valignment="top" usebox="none">
32928 \begin_layout Plain Layout
32934 <cell alignment="center" valignment="top" usebox="none">
32937 \begin_layout Plain Layout
32943 <cell alignment="center" valignment="top" usebox="none">
32946 \begin_layout Plain Layout
32952 <cell alignment="center" valignment="top" usebox="none">
32955 \begin_layout Plain Layout
32961 <cell alignment="center" valignment="top" usebox="none">
32964 \begin_layout Plain Layout
32972 <cell alignment="left" valignment="top" usebox="none">
32975 \begin_layout Plain Layout
32981 <cell alignment="left" valignment="top" usebox="none">
32984 \begin_layout Plain Layout
32990 <cell alignment="left" valignment="top" usebox="none">
32993 \begin_layout Plain Layout
32999 <cell alignment="left" valignment="top" usebox="none">
33002 \begin_layout Plain Layout
33008 <cell alignment="center" valignment="top" usebox="none">
33011 \begin_layout Plain Layout
33017 <cell alignment="center" valignment="top" usebox="none">
33020 \begin_layout Plain Layout
33026 <cell alignment="center" valignment="top" usebox="none">
33029 \begin_layout Plain Layout
33035 <cell alignment="center" valignment="top" usebox="none">
33038 \begin_layout Plain Layout
33046 <cell alignment="center" valignment="top" usebox="none">
33049 \begin_layout Plain Layout
33055 <cell alignment="center" valignment="top" usebox="none">
33058 \begin_layout Plain Layout
33064 <cell alignment="center" valignment="top" usebox="none">
33067 \begin_layout Plain Layout
33073 <cell alignment="center" valignment="top" usebox="none">
33076 \begin_layout Plain Layout
33082 <cell alignment="center" valignment="top" usebox="none">
33085 \begin_layout Plain Layout
33091 <cell alignment="center" valignment="top" usebox="none">
33094 \begin_layout Plain Layout
33100 <cell alignment="center" valignment="top" usebox="none">
33103 \begin_layout Plain Layout
33109 <cell alignment="center" valignment="top" usebox="none">
33112 \begin_layout Plain Layout
33126 \begin_layout Chapter
33127 Names of available colors to be used in layouts
33128 \begin_inset CommandInset label
33130 name "chap:Names-of-colors"
33137 \begin_layout Standard
33138 The colors listed below are the standard colors and those that you can adjust in the \SpecialChar LyX
33142 \begin_layout Section
33146 \begin_layout Standard
33147 The following are no real colors,
33148 but rather act on color definitions:
33151 \begin_layout Description
33152 ignore The color is ignored
33155 \begin_layout Description
33156 inherit The color is inherited
33159 \begin_layout Description
33172 No particular color – clear or default
33175 \begin_layout Section
33179 \begin_layout Standard
33180 These are fixed colors that cannot be customized.
33185 use these colors in layout definitions,
33186 since they will not work well with some color themes (such as dark themes):
33189 \begin_layout Description
33193 \begin_layout Description
33197 \begin_layout Description
33201 \begin_layout Description
33205 \begin_layout Description
33209 \begin_layout Description
33213 \begin_layout Description
33217 \begin_layout Description
33221 \begin_layout Description
33225 \begin_layout Description
33229 \begin_layout Description
33233 \begin_layout Description
33237 \begin_layout Description
33241 \begin_layout Description
33245 \begin_layout Description
33249 \begin_layout Description
33253 \begin_layout Description
33257 \begin_layout Description
33261 \begin_layout Description
33265 \begin_layout Section
33269 \begin_layout Standard
33270 These are the colors allocated to specific elements in
33273 arg "dialog-show prefs"
33279 \begin_layout Description
33280 added_space Added space color
33283 \begin_layout Description
33284 addedtext Added text color
33287 \begin_layout Description
33288 appendix Appendix marker color
33291 \begin_layout Description
33292 background Background color
33295 \begin_layout Description
33296 bookmark Bookmark indicator color
33299 \begin_layout Description
33300 bottomarea Bottom area color
33303 \begin_layout Description
33304 branchlabel Label color for branches
33307 \begin_layout Description
33308 buttonbg Color used for button background
33311 \begin_layout Description
33312 buttonframe Color for inset button frames
33315 \begin_layout Description
33316 buttonhoverbg Color used for button background under focus
33319 \begin_layout Description
33320 buttonhoverbg_broken Color used for broken inset button under focus
33323 \begin_layout Description
33324 changebar Changebar color
33327 \begin_layout Description
33328 changedtextauthor1 Changed text color author 1
33331 \begin_layout Description
33332 changedtextauthor2 Changed text color author 2
33335 \begin_layout Description
33336 changedtextauthor3 Changed text color author 3
33339 \begin_layout Description
33340 changedtextauthor4 Changed text color author 4
33343 \begin_layout Description
33344 changedtextauthor5 Changed text color author 5
33347 \begin_layout Description
33348 changedtextcomparison Changed text color document comparison (workarea)
33351 \begin_layout Description
33352 collapsible Collapsible insets text color
33355 \begin_layout Description
33356 collapsibleframe Collapsible insets framecolor
33359 \begin_layout Description
33360 command Text color for command insets
33363 \begin_layout Description
33364 commandbg Background color for command insets
33367 \begin_layout Description
33368 commandframe Frame color for command insets
33371 \begin_layout Description
33372 command_broken Text color for broken (reference) insets
33375 \begin_layout Description
33376 commandbg_broken Background color for broken insets
33379 \begin_layout Description
33380 commandframe_broken Frame color for broken insets
33383 \begin_layout Description
33384 comment Label color for comments
33387 \begin_layout Description
33388 commentbg Background color of comments
33391 \begin_layout Description
33392 cursor Cursor color
33395 \begin_layout Description
33396 deletedtext Deleted text color
33399 \begin_layout Description
33400 deletedtextmodifier Deleted text modifying color (for adjusting the brightness)
33403 \begin_layout Description
33404 depthbar Color for the depth bars in the margin
33407 \begin_layout Description
33408 eolmarker End of line marker color
33411 \begin_layout Description
33412 error Color of the \SpecialChar LaTeX
33416 \begin_layout Description
33417 footlabel Label color for footnotes
33420 \begin_layout Description
33421 foreground Foreground color
33424 \begin_layout Description
33425 graphicsbg Graphics inset background color
33428 \begin_layout Description
33429 greyedoutbg Background color of greyedout inset
33432 \begin_layout Description
33433 greyedoutlabel Label color for greyedout insets
33436 \begin_layout Description
33437 greyedouttext Color for greyedout inset text
33440 \begin_layout Description
33441 indexlabel Label color for index insets
33444 \begin_layout Description
33445 inlinecompletion Inline completion color
33448 \begin_layout Description
33449 insetbg Inset marker background color
33452 \begin_layout Description
33453 insetframe Inset marker frame color
33456 \begin_layout Description
33457 language Color for marking foreign language words
33460 \begin_layout Description
33461 latex Text color in \SpecialChar LaTeX
33465 \begin_layout Description
33466 listingsbg Background color of listings inset
33469 \begin_layout Description
33470 marginlabel Label color for margin notes
33473 \begin_layout Description
33474 math Math inset text color
33477 \begin_layout Description
33478 mathbg Math inset background color
33481 \begin_layout Description
33482 mathcorners Math inset frame color not under focus
33485 \begin_layout Description
33486 mathframe Math inset frame color under focus
33489 \begin_layout Description
33490 mathline Math line color
33493 \begin_layout Description
33494 mathmacrobg Macro math inset background color
33497 \begin_layout Description
33498 mathmacroblend Macro math blended color
33501 \begin_layout Description
33502 mathmacroframe Macro math frame color
33505 \begin_layout Description
33506 mathmacrohoverbg Macro math inset background color hovered
33509 \begin_layout Description
33510 mathmacrolabel Macro math label color
33513 \begin_layout Description
33514 mathmacronewarg Macro template color for new parameters
33517 \begin_layout Description
33518 mathmacrooldarg Macro template color for old parameters
33521 \begin_layout Description
33522 newpage New page color
33525 \begin_layout Description
33526 nonunique_inlinecompletion Inline completion color for the non-unique part
33529 \begin_layout Description
33530 note Label color for notes
33533 \begin_layout Description
33534 notebg Background color of notes
33537 \begin_layout Description
33538 pagebreak Page break/line break color
33541 \begin_layout Description
33542 paragraphmarker Color used for the pilcrow sign to mark the end of a paragraph
33545 \begin_layout Description
33546 phantomtext Text color for phantom insets
33549 \begin_layout Description
33550 preview The color used for previews
33553 \begin_layout Description
33554 previewframe Preview frame color
33557 \begin_layout Description
33558 regexpframe Color for regexp frame
33561 \begin_layout Description
33562 scroll Color that indicates when a row can be scrolled
33565 \begin_layout Description
33566 selection Background color of selected text
33569 \begin_layout Description
33570 selectionmath Foreground color of selected text in math insets
33573 \begin_layout Description
33574 selectiontext Foreground color of selected text
33577 \begin_layout Description
33578 shadedbg Background color of shaded box
33581 \begin_layout Description
33582 special Special chars text color
33585 \begin_layout Description
33586 tabularline Table line color
33589 \begin_layout Description
33590 tabularonoffline Table line color
33593 \begin_layout Description
33594 textlabel1 Color 1 of layout and custom inset labels
33597 \begin_layout Description
33598 textlabel2 Color 2 of layout and custom inset labels
33601 \begin_layout Description
33602 textlabel3 Color 3 of layout and custom inset labels
33605 \begin_layout Description
33606 urllabel Label color for URL insets
33609 \begin_layout Description
33610 urltext Color for URL inset text