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 false
133 \output_changes false
135 \postpone_fragile_content false
139 \docbook_table_output 0
140 \docbook_mathml_prefix 1
146 Customizing \SpecialChar LyX
148 Features for the Advanced User
152 by the \SpecialChar LyX
157 \begin_layout Plain Layout
158 If you have comments or error corrections,
159 please send them to the \SpecialChar LyX
160 Documentation mailing list,
162 \begin_inset CommandInset href
164 target "lyx-docs@lists.lyx.org"
172 \begin_inset Quotes eld
176 \begin_inset Quotes erd
179 in the subject header,
180 and please cc the current maintainer of this file,
181 Richard Kimberly Heck <rikiheck@lyx.org>.
187 \begin_inset Newline newline
191 \begin_inset Newline newline
197 \begin_layout Standard
198 \begin_inset CommandInset toc
199 LatexCommand tableofcontents
206 \begin_layout Standard
207 \begin_inset Note Note
210 \begin_layout Plain Layout
211 Please use change tracking when modifying this document.
212 This makes it easier for our translators to recognize things that have been changed,
213 and it helps the maintainer keep up-to-date with what's been done.
221 \begin_layout Chapter
225 \begin_layout Standard
226 This manual covers the customization features present in \SpecialChar LyX
229 we discuss issues like keyboard shortcuts,
230 screen previewing options,
232 sending commands to \SpecialChar LyX
233 via the \SpecialChar LyX
235 internationalization,
236 installing new \SpecialChar LaTeX
237 classes and \SpecialChar LyX
240 We can't possibly hope to touch on everything you can change—
241 our developers add new features faster than we can document them—
242 but we will explain the most common customizations and hopefully point you in the right direction for some of the more obscure ones.
245 \begin_layout Standard
246 \begin_inset Branch OutDated
250 \begin_layout Standard
251 Information from previous versions of this document that now seems to be outdated is contained in the OutDated branch of this document.
253 this information will not appear in the \SpecialChar LaTeX
262 \begin_layout Chapter
267 \begin_layout Standard
268 This chapter aims to help you to find your way through the \SpecialChar LyX
270 Before continuing to read this chapter,
271 you should find out where your \SpecialChar LyX
272 system and user directories are by using
273 \begin_inset Flex Noun
276 \begin_layout Plain Layout
277 Help\SpecialChar menuseparator
288 The system directory is the place where \SpecialChar LyX
289 places its system-wide configuration files;
290 the user directory is where you can place your modified versions.
291 We will call the former
292 \begin_inset Flex Code
295 \begin_layout Plain Layout
302 \begin_inset Flex Noun
305 \begin_layout Plain Layout
311 in the remainder of this document.
315 \begin_layout Section
317 \begin_inset Flex Code
320 \begin_layout Plain Layout
329 \begin_layout Standard
330 \begin_inset Flex Code
333 \begin_layout Plain Layout
339 and its sub-directories contain a number of files that can be used to customize \SpecialChar LyX
341 You can change many of these files from within \SpecialChar LyX
343 \begin_inset Flex Noun
346 \begin_layout Plain Layout
347 Tools\SpecialChar menuseparator
354 Most customization that you will want to do in \SpecialChar LyX
355 is possible through this dialog.
357 many other inner aspects of \SpecialChar LyX
358 can be customized by modifying the files in
359 \begin_inset Flex Code
362 \begin_layout Plain Layout
369 These files fall in different categories,
370 described in the following subsections.
373 \begin_layout Subsection
374 Automatically generated files
377 \begin_layout Standard
379 \begin_inset Flex Noun
382 \begin_layout Plain Layout
388 are generated when you configure \SpecialChar LyX
390 They contain various default values that are automatically detected during reconfiguration.
392 it is not a good idea to modify them,
393 since they might be overwritten at any time.
396 \begin_layout Labeling
397 \labelwidthstring 00.00.0000
398 \begin_inset Flex Code
401 \begin_layout Plain Layout
407 Contains defaults for various commands.
410 \begin_layout Labeling
411 \labelwidthstring 00.00.0000
412 \begin_inset Flex Code
415 \begin_layout Plain Layout
421 Contains the list of packages that have been recognized by \SpecialChar LyX
423 It is currently unused by the \SpecialChar LyX
425 but the information extracted,
427 is made available with
428 \begin_inset Flex Noun
431 \begin_layout Plain Layout
432 Help\SpecialChar menuseparator
446 \begin_layout Labeling
447 \labelwidthstring 00.00.0000
448 \begin_inset Flex Code
451 \begin_layout Plain Layout
457 The list of text classes that have been found in your
458 \begin_inset Flex Code
461 \begin_layout Plain Layout
468 along with the associated \SpecialChar LaTeX
469 document class and their description.
472 \begin_layout Labeling
473 \labelwidthstring 00.00.0000
474 \begin_inset Flex Code
477 \begin_layout Plain Layout
483 The list of layout modules found in your
484 \begin_inset Flex Code
487 \begin_layout Plain Layout
496 \begin_layout Labeling
497 \labelwidthstring 00.00.0000
498 \begin_inset Flex Code
501 \begin_layout Plain Layout
507 Lists of various sorts of \SpecialChar LaTeX
508 -related files found on your system
511 \begin_layout Labeling
512 \labelwidthstring 00.00.0000
513 \begin_inset Flex Code
516 \begin_layout Plain Layout
517 doc/\SpecialChar LaTeX
523 is automatically generated during configuration from the file
524 \begin_inset Flex Code
527 \begin_layout Plain Layout
535 It contains information on your \SpecialChar LaTeX
539 \begin_layout Subsection
543 \begin_layout Standard
544 The following directories in
545 \begin_inset Flex Code
548 \begin_layout Plain Layout
555 \begin_inset Flex Code
558 \begin_layout Plain Layout
565 If a particular file exists in both places,
567 \begin_inset Flex Code
570 \begin_layout Plain Layout
579 \begin_layout Labeling
580 \labelwidthstring 00.00.0000
581 \begin_inset Flex Code
584 \begin_layout Plain Layout
590 This directory contains files with the extension
591 \begin_inset Flex Code
594 \begin_layout Plain Layout
600 that define the keybindings used in \SpecialChar LyX
602 If there exists an internationalized version of the bind file in a subdirectory
603 \begin_inset Flex Code
606 \begin_layout Plain Layout
613 \begin_inset Quotes eld
617 \begin_inset Quotes erd
620 is the ISO language code,
621 that will be used first.
624 \begin_layout Labeling
625 \labelwidthstring 00.00.0000
626 \begin_inset Flex Code
629 \begin_layout Plain Layout
635 Contains files with the extension
636 \begin_inset Flex Code
639 \begin_layout Plain Layout
645 which define the diverse citation possibilities (natbib,
648 \begin_inset CommandInset ref
650 reference "subsec:Cite-Engine-Files"
661 \begin_layout Labeling
662 \labelwidthstring 00.00.0000
663 \begin_inset Flex Code
666 \begin_layout Plain Layout
672 Contains graphics files that can be included in documents.
676 \begin_layout Labeling
677 \labelwidthstring 00.00.0000
678 \begin_inset Flex Code
681 \begin_layout Plain Layout
687 Contains \SpecialChar LyX
688 documentation files (including the one you are currently reading).
690 \begin_inset Flex Code
693 \begin_layout Plain Layout
699 deserves special attention,
701 The internationalized help docs are in subdirectories
702 \begin_inset Flex Code
705 \begin_layout Plain Layout
712 \begin_inset Quotes eld
716 \begin_inset Quotes erd
719 is the ISO language code.
721 \begin_inset CommandInset ref
723 reference "cha:Internationalizing-LyX"
731 \begin_layout Labeling
732 \labelwidthstring 00.00.0000
733 \begin_inset Flex Code
736 \begin_layout Plain Layout
742 Contains example files that explain how to use some features.
745 \begin_inset Flex Noun
748 \begin_layout Plain Layout
757 \begin_layout Labeling
758 \labelwidthstring 00.00.0000
759 \begin_inset Flex Code
762 \begin_layout Plain Layout
768 Contains image files that are used by the
769 \begin_inset Flex Noun
772 \begin_layout Plain Layout
780 it also contains the individual icons used in the toolbar and the banners that can be shown when \SpecialChar LyX
784 \begin_layout Labeling
785 \labelwidthstring 00.00.0000
786 \begin_inset Flex Code
789 \begin_layout Plain Layout
795 Contains keyboard keymapping files.
797 \begin_inset CommandInset ref
799 reference "sec:International-Keymap-Stuff"
807 \begin_layout Labeling
808 \labelwidthstring 00.00.0000
809 \begin_inset Flex Code
812 \begin_layout Plain Layout
818 Contains the text class and module files described in
819 \begin_inset CommandInset ref
821 reference "cha:Installing-New-Document"
829 \begin_layout Labeling
830 \labelwidthstring 00.00.0000
831 \begin_inset Flex Code
834 \begin_layout Plain Layout
841 \begin_inset Flex Code
844 \begin_layout Plain Layout
850 Python scripts used to convert between \SpecialChar LyX
852 These can be run from the command line if you want to batch-convert files.
855 \begin_layout Labeling
856 \labelwidthstring 00.00.0000
857 \begin_inset Flex Code
860 \begin_layout Plain Layout
866 Contains some files that demonstrate the capabilities of the
867 \begin_inset Flex Noun
870 \begin_layout Plain Layout
881 Also contains some scripts used by \SpecialChar LyX
885 \begin_layout Labeling
886 \labelwidthstring 00.00.0000
887 \begin_inset Flex Code
890 \begin_layout Plain Layout
896 Contains the standard \SpecialChar LyX
897 template files described in
898 \begin_inset CommandInset ref
900 reference "subsec:Creating-Templates"
908 \begin_layout Labeling
909 \labelwidthstring 00.00.0000
910 \begin_inset Flex Code
913 \begin_layout Plain Layout
919 Contains files with the extension
920 \begin_inset Flex Code
923 \begin_layout Plain Layout
929 that define the user interface to \SpecialChar LyX
932 the files define which items appear in which menus and the items appearing on the toolbar.
935 \begin_layout Labeling
936 \labelwidthstring 00.00.0000
937 \begin_inset Flex Code
940 \begin_layout Plain Layout
946 Contains files with the extension
947 \begin_inset Flex Code
950 \begin_layout Plain Layout
956 which define the templates for the insertion of external material to a \SpecialChar LyX
959 \begin_inset CommandInset ref
961 reference "chap:Including-External-Material"
969 \begin_layout Subsection
970 Files you don't want to modify
973 \begin_layout Standard
974 These files are used internally by \SpecialChar LyX
975 and you generally do not need to modify them unless you are a developer.
978 \begin_layout Labeling
979 \labelwidthstring 00.00.0000
980 \begin_inset Flex Code
983 \begin_layout Plain Layout
989 This file contains the list of \SpecialChar LyX
991 The contents are displayed with the menu entry
992 \begin_inset Flex Noun
995 \begin_layout Plain Layout
996 Help\SpecialChar menuseparator
1009 \begin_layout Labeling
1010 \labelwidthstring 00.00.0000
1011 \begin_inset Flex Code
1014 \begin_layout Plain Layout
1020 This is a \SpecialChar LaTeX
1021 script used during the configuration process.
1022 Do not run directly.
1025 \begin_layout Labeling
1026 \labelwidthstring 00.00.0000
1027 \begin_inset Flex Code
1030 \begin_layout Plain Layout
1036 This is a Python script that is used to re-configure \SpecialChar LyX
1038 It creates configuration files in the directory it was run from.
1041 \begin_layout Subsection
1042 Other files needing a line or two
1045 \begin_layout Labeling
1046 \labelwidthstring 00.00.0000
1047 \begin_inset Flex Code
1050 \begin_layout Plain Layout
1056 This contains tables describing how different character encodings can be mapped to Unicode
1059 \begin_layout Labeling
1060 \labelwidthstring 00.00.0000
1061 \begin_inset Flex Code
1064 \begin_layout Plain Layout
1070 This file contains a list of all the languages currently supported by \SpecialChar LyX
1074 \begin_layout Labeling
1075 \labelwidthstring 00.00.0000
1076 \begin_inset Flex Code
1079 \begin_layout Plain Layout
1085 Contains information about the supported fonts.
1088 \begin_layout Labeling
1089 \labelwidthstring 00.00.0000
1090 \begin_inset Flex Code
1093 \begin_layout Plain Layout
1099 This file contains translations for internationalized paragraph styles (see
1100 \begin_inset CommandInset ref
1102 reference "subsec:I18n"
1110 \begin_layout Labeling
1111 \labelwidthstring 00.00.0000
1112 \begin_inset Flex Code
1115 \begin_layout Plain Layout
1121 This file contains information about Unicode-encoded glyphs and the way they are supported by \SpecialChar LyX
1122 via \SpecialChar LaTeX
1126 \begin_layout Section
1127 Your local configuration directory
1130 \begin_layout Standard
1131 Even if you are using \SpecialChar LyX
1132 as an unprivileged user,
1133 you might want to change \SpecialChar LyX
1134 configuration for your own use.
1136 \begin_inset Flex Code
1139 \begin_layout Plain Layout
1145 directory contains all your personal configuration files.
1146 This is the directory described as
1147 \begin_inset Quotes eld
1151 \begin_inset Quotes erd
1155 \begin_inset Flex Noun
1158 \begin_layout Plain Layout
1159 Help\SpecialChar menuseparator
1161 \begin_inset space ~
1170 This directory is used as a mirror of
1171 \begin_inset Flex Code
1174 \begin_layout Plain Layout
1181 which means that every file in
1182 \begin_inset Flex Code
1185 \begin_layout Plain Layout
1191 is a replacement for the corresponding file in
1192 \begin_inset Flex Code
1195 \begin_layout Plain Layout
1202 Any configuration file described in the above sections can be placed either in the system-wide directory,
1203 in which case it will affect all users,
1204 or in your local directory for your own use.
1207 \begin_layout Standard
1208 To make things clearer,
1209 let's provide a few examples:
1212 \begin_layout Itemize
1213 The preferences set in the
1214 \begin_inset Flex Noun
1217 \begin_layout Plain Layout
1218 Tools\SpecialChar menuseparator
1224 dialog are saved to a file
1225 \begin_inset Flex Code
1228 \begin_layout Plain Layout
1235 \begin_inset Flex Code
1238 \begin_layout Plain Layout
1247 \begin_layout Itemize
1248 When you reconfigure using
1249 \begin_inset Flex Noun
1252 \begin_layout Plain Layout
1253 Tools\SpecialChar menuseparator
1262 \begin_inset Flex Code
1265 \begin_layout Plain Layout
1272 and the resulting files are written in your local configuration directory.
1273 This means that any additional text class file that you might have added in
1274 \begin_inset Flex Code
1277 \begin_layout Plain Layout
1283 will be added to the list of classes in the
1284 \begin_inset Flex Noun
1287 \begin_layout Plain Layout
1288 Document\SpecialChar menuseparator
1297 \begin_layout Itemize
1298 If you get some updated documentation from a \SpecialChar LyX
1299 ftp site and cannot install it because you do not have sysadmin rights on your system,
1300 you can just copy the files to
1301 \begin_inset Flex Code
1304 \begin_layout Plain Layout
1310 and the items in the
1311 \begin_inset Flex Noun
1314 \begin_layout Plain Layout
1320 menu will open them!
1323 \begin_layout Section
1324 Running \SpecialChar LyX
1325 with multiple configurations
1328 \begin_layout Standard
1329 The configuration freedom of the local configuration directory may not suffice if you want to have more than one configuration at your disposal.
1331 you may want to use different key bindings or printer settings at different times.
1332 You can achieve this by having several such directories.
1333 You then specify which directory to use at run-time.
1336 \begin_layout Standard
1337 Invoking \SpecialChar LyX
1338 with the command line switch
1339 \begin_inset Flex Code
1342 \begin_layout Plain Layout
1352 instructs the program to read the configuration from that directory,
1353 and not from the default directory.
1354 (You can determine the default directory by running \SpecialChar LyX
1356 \begin_inset Flex Code
1359 \begin_layout Plain Layout
1365 switch.) If the specified directory does not exist,
1367 offers to create it for you,
1368 just like it does for the default directory the first time you run the program.
1369 You can modify the configuration options in this additional user directory exactly as you would for the default directory.
1370 These directories are completely independent (but read on).
1371 Note that setting the environment variable
1372 \begin_inset Flex Code
1375 \begin_layout Plain Layout
1381 to some value has exactly the same effect.
1384 \begin_layout Standard
1385 Having several configurations also requires more maintenance:
1386 if you want to add a new layout to
1387 \begin_inset Flex Code
1390 \begin_layout Plain Layout
1396 which you want available from all your configurations,
1397 you must add it to each directory separately.
1398 You can avoid this with the following trick:
1399 after \SpecialChar LyX
1400 creates the additional directory,
1401 most of the subdirectories (see above) are empty.
1402 If you want the new configuration to mirror an existing one,
1403 replace the empty subdirectory with a symbolic link to the matching subdirectory in the existing configuration.
1405 \begin_inset Flex Code
1408 \begin_layout Plain Layout
1416 since it contains a file written by the configuration script (also accessible through
1417 \begin_inset Flex Noun
1420 \begin_layout Plain Layout
1421 Tools\SpecialChar menuseparator
1427 ) which is configuration specific.
1430 \begin_layout Chapter
1431 The Preferences dialog
1434 \begin_layout Standard
1435 All options of the preferences dialog are described in the Appendix
1437 The Preferences Dialog
1444 For some options you might find here more details.
1447 \begin_layout Section
1449 \begin_inset CommandInset label
1458 \begin_layout Standard
1459 The first step is to define your file formats if they are not already defined.
1462 \begin_inset Flex Noun
1465 \begin_layout Plain Layout
1466 Tools\SpecialChar menuseparator
1474 \begin_inset Flex Noun
1477 \begin_layout Plain Layout
1478 File Handling\SpecialChar menuseparator
1485 \begin_inset Flex Noun
1488 \begin_layout Plain Layout
1494 button to define your new format.
1496 \begin_inset Flex Noun
1499 \begin_layout Plain Layout
1505 field contains the name used to identify the format in the GUI.
1507 \begin_inset Flex Noun
1510 \begin_layout Plain Layout
1516 is used to identify the format internally.
1517 You will also need to enter a file extension.
1518 These are all required.
1520 \begin_inset Flex Noun
1523 \begin_layout Plain Layout
1529 field is used to provide a keyboard shortcut on the menus.
1532 \begin_inset Flex Noun
1535 \begin_layout Plain Layout
1542 \begin_inset Flex Noun
1545 \begin_layout Plain Layout
1546 Document\SpecialChar menuseparator
1547 View (Other Formats)\SpecialChar menuseparator
1556 \begin_layout Standard
1558 \begin_inset Flex Noun
1561 \begin_layout Plain Layout
1568 \begin_inset Flex Noun
1571 \begin_layout Plain Layout
1579 you might want to use
1580 \begin_inset Flex Noun
1583 \begin_layout Plain Layout
1589 to view PostScript files.
1590 You can enter the command needed to start the program in the corresponding fields.
1591 In defining this command,
1592 you can use the four variables listed in the next section.
1593 The viewer is launched when you view an image in \SpecialChar LyX
1595 \begin_inset Flex Noun
1598 \begin_layout Plain Layout
1599 Document\SpecialChar menuseparator
1606 The editor is for example launched when you right-click on an image and choose
1607 \begin_inset Flex Noun
1610 \begin_layout Plain Layout
1616 in the appearing context menu.
1619 \begin_layout Standard
1621 \begin_inset Flex Noun
1624 \begin_layout Plain Layout
1630 type of a format is optional,
1631 but if it is specified,
1632 it must be unique across all formats.
1633 It is used to detect files of this format from the file contents.
1634 For some important file formats there is no MIME type officially registered with the
1635 \begin_inset CommandInset href
1638 target "http://www.iana.org/assignments/media-types/"
1644 Therefore \SpecialChar LyX
1645 uses the extended list of MIME types as specified by
1646 \begin_inset CommandInset href
1648 name "freedesktop.org"
1649 target "http://www.freedesktop.org/wiki/Specifications/shared-mime-info-spec"
1657 \begin_layout Standard
1659 \begin_inset Flex Noun
1662 \begin_layout Plain Layout
1668 option tells \SpecialChar LyX
1669 that a format is suitable for document export.
1670 If this is set and if a suitable conversion route exists (see
1671 \begin_inset CommandInset ref
1673 reference "sec:Converters"
1679 the format will appear in the
1680 \begin_inset Flex Noun
1683 \begin_layout Plain Layout
1684 File\SpecialChar menuseparator
1691 The format will also appear in the
1692 \begin_inset Flex Noun
1695 \begin_layout Plain Layout
1696 Document\SpecialChar menuseparator
1702 menu if a viewer is specified for the format.
1705 \begin_inset Flex Code
1708 \begin_layout Plain Layout
1715 should not use this option.
1716 Formats that can both represent vector graphics and documents like
1717 \begin_inset Flex Code
1720 \begin_layout Plain Layout
1729 \begin_layout Standard
1731 \begin_inset Flex Noun
1734 \begin_layout Plain Layout
1735 Vector graphics format
1740 tells \SpecialChar LyX
1741 that a format can contain vector graphics.
1742 This information is used to determine the target format of included graphics for
1743 \begin_inset Flex Noun
1746 \begin_layout Plain Layout
1753 Included graphics may need to be converted to either
1754 \begin_inset Flex Noun
1757 \begin_layout Plain Layout
1765 \begin_inset Flex Noun
1768 \begin_layout Plain Layout
1776 \begin_inset Flex Noun
1779 \begin_layout Plain Layout
1787 \begin_inset Flex Noun
1790 \begin_layout Plain Layout
1796 cannot handle other image formats.
1797 If an included graphic is not already in
1798 \begin_inset Flex Noun
1801 \begin_layout Plain Layout
1809 \begin_inset Flex Noun
1812 \begin_layout Plain Layout
1820 \begin_inset Flex Noun
1823 \begin_layout Plain Layout
1831 \begin_inset Flex Noun
1834 \begin_layout Plain Layout
1840 if the vector format option is set,
1842 \begin_inset Flex Noun
1845 \begin_layout Plain Layout
1854 \begin_layout Section
1858 \begin_layout Standard
1859 Since all conversions from one format to another take place in \SpecialChar LyX
1860 's temporary directory,
1861 it is sometimes necessary to modify a file before copying it to the temporary directory in order that the conversion may be performed.
1865 \begin_layout Plain Layout
1867 the file may refer to other files—
1870 using relative file names,
1871 and these may become invalid when the file is copied to the temporary directory.
1876 This is done by a Copier:
1877 It copies a file to (or from) the temporary directory and may modify it in the process.
1880 \begin_layout Standard
1881 The definitions of the copiers may use eight variables:
1884 \begin_layout Labeling
1885 \labelwidthstring 00.00.0000
1886 \begin_inset Flex Code
1889 \begin_layout Plain Layout
1895 The \SpecialChar LyX
1896 system directory (e.
1897 \begin_inset space \thinspace{}
1901 \begin_inset space \space{}
1905 \begin_inset Flex Noun
1908 \begin_layout Plain Layout
1917 \begin_layout Labeling
1918 \labelwidthstring 00.00.0000
1919 \begin_inset Flex Code
1922 \begin_layout Plain Layout
1931 \begin_layout Labeling
1932 \labelwidthstring 00.00.0000
1933 \begin_inset Flex Code
1936 \begin_layout Plain Layout
1945 \begin_layout Labeling
1946 \labelwidthstring 00.00.0000
1947 \begin_inset Flex Code
1950 \begin_layout Plain Layout
1956 The base name (without filename extension) in the \SpecialChar LyX
1960 \begin_layout Labeling
1961 \labelwidthstring 00.00.0000
1962 \begin_inset Flex Code
1965 \begin_layout Plain Layout
1971 The full directory path of the \SpecialChar LyX
1975 \begin_layout Labeling
1976 \labelwidthstring 00.00.0000
1977 \begin_inset Flex Code
1980 \begin_layout Plain Layout
1986 The full pathname to the original \SpecialChar LyX
1987 file being processed
1990 \begin_layout Labeling
1991 \labelwidthstring 00.00.0000
1992 \begin_inset Flex Code
1995 \begin_layout Plain Layout
2001 The filename (without any directory path) of the \SpecialChar LyX
2005 \begin_layout Labeling
2006 \labelwidthstring 00.00.0000
2007 \begin_inset Flex Code
2010 \begin_layout Plain Layout
2016 The `\SpecialChar LaTeX
2020 \begin_layout Standard
2021 The latter should be the filename as it would be used in a \SpecialChar LaTeX
2029 It is relevant only when exporting files suitable for such inclusion.
2032 \begin_layout Standard
2033 Copiers can be used to do almost anything with output files.
2035 suppose you want generated pdf files to be copied to a special directory,
2037 \begin_inset Flex Code
2040 \begin_layout Plain Layout
2047 Then you could write a shell script such as this one:
2050 \begin_layout Standard
2051 \begin_inset listings
2055 \begin_layout Plain Layout
2060 \begin_layout Plain Layout
2065 \begin_layout Plain Layout
2067 TOFILE=`basename $2`
2070 \begin_layout Plain Layout
2072 cp $FROMFILE /home/you/pdf/$TOFILE
2077 Save it in your local \SpecialChar LyX
2081 \begin_inset Flex Code
2084 \begin_layout Plain Layout
2085 /home/you/.lyx/scripts/pdfcopier.sh
2091 and make it executable,
2092 if you need to do so on your platform.
2095 \begin_inset Flex Noun
2098 \begin_layout Plain Layout
2099 Tools\SpecialChar menuseparator
2107 \begin_inset Flex Noun
2110 \begin_layout Plain Layout
2111 File Handling\SpecialChar menuseparator
2118 \begin_inset Flex Noun
2121 \begin_layout Plain Layout
2128 or one of the other pdf formats—
2130 \begin_inset Flex Code
2133 \begin_layout Plain Layout
2134 pdfcopier.sh $$i $$o
2140 \begin_inset Flex Noun
2143 \begin_layout Plain Layout
2153 \begin_layout Standard
2154 Copiers are used by \SpecialChar LyX
2155 in various of its own conversions.
2157 if appropriate programs are found,
2159 will automatically install copiers for the
2160 \begin_inset Flex Noun
2163 \begin_layout Plain Layout
2170 \begin_inset Flex Noun
2173 \begin_layout Plain Layout
2175 \begin_inset space ~
2184 When these formats are exported,
2185 the copier sees that not just the main HTML file but various associated files (style files,
2187 etc.) are also copied.
2188 All these files are written to a subdirectory of the directory in which the original \SpecialChar LyX
2193 \begin_layout Plain Layout
2194 This copier can be customized.
2196 \begin_inset Quotes eld
2200 \begin_inset Quotes erd
2203 argument takes a comma-separated list of extensions to be copied;
2205 all files will be copied.
2207 \begin_inset Quotes eld
2211 \begin_inset Quotes erd
2214 argument determines the extension added to the generated directory.
2217 \begin_inset Quotes eld
2221 \begin_inset Flex Noun
2224 \begin_layout Plain Layout
2231 \begin_inset Quotes erd
2235 so HTML generated from
2236 \begin_inset Flex Noun
2239 \begin_layout Plain Layout
2240 /path/to/filename.lyx
2246 \begin_inset Flex Noun
2249 \begin_layout Plain Layout
2250 /path/to/filename.html.LyXconv
2264 \begin_layout Section
2266 \begin_inset CommandInset label
2268 name "sec:Converters"
2275 \begin_layout Standard
2276 You can define your own Converters to convert files between different formats.
2278 \begin_inset Flex Noun
2281 \begin_layout Plain Layout
2282 Tools\SpecialChar menuseparator
2283 Preferences\SpecialChar menuseparator
2284 File Handling\SpecialChar menuseparator
2293 \begin_layout Standard
2294 To define a new converter,
2296 \begin_inset Flex Noun
2299 \begin_layout Plain Layout
2301 \begin_inset space ~
2310 \begin_inset Flex Noun
2313 \begin_layout Plain Layout
2315 \begin_inset space ~
2323 from the drop-down lists,
2324 enter the command needed for the conversion,
2326 \begin_inset Flex Noun
2329 \begin_layout Plain Layout
2336 Several variables can be used in the definition of converters:
2339 \begin_layout Labeling
2340 \labelwidthstring 00.00.0000
2341 \begin_inset Flex Code
2344 \begin_layout Plain Layout
2350 The \SpecialChar LyX
2354 \begin_layout Labeling
2355 \labelwidthstring 00.00.0000
2356 \begin_inset Flex Code
2359 \begin_layout Plain Layout
2368 \begin_layout Labeling
2369 \labelwidthstring 00.00.0000
2370 \begin_inset Flex Code
2373 \begin_layout Plain Layout
2382 \begin_layout Labeling
2383 \labelwidthstring 00.00.0000
2384 \begin_inset Flex Code
2387 \begin_layout Plain Layout
2393 The base filename of the input file (i.
2394 \begin_inset space \thinspace{}
2398 without the extension)
2401 \begin_layout Labeling
2402 \labelwidthstring 00.00.0000
2403 \begin_inset Flex Code
2406 \begin_layout Plain Layout
2412 The path to the input file
2415 \begin_layout Labeling
2416 \labelwidthstring 00.00.0000
2417 \begin_inset Flex Code
2420 \begin_layout Plain Layout
2426 The path to the original input file (this is different from $$p when a chain of converters is called)
2429 \begin_layout Labeling
2430 \labelwidthstring 00.00.0000
2431 \begin_inset Flex Code
2434 \begin_layout Plain Layout
2440 The iconv name for the encoding of the document.
2443 \begin_layout Standard
2445 \begin_inset Flex Noun
2448 \begin_layout Plain Layout
2450 \begin_inset space ~
2458 field you can enter the following flags,
2459 separated by commas:
2462 \begin_layout Labeling
2463 \labelwidthstring 00.00.0000
2464 \begin_inset Flex Code
2467 \begin_layout Plain Layout
2473 This converter runs some form of \SpecialChar LaTeX
2475 This will make \SpecialChar LyX
2476 's \SpecialChar LaTeX
2477 error logs available.
2479 \begin_inset Flex Code
2482 \begin_layout Plain Layout
2488 value specifies the form of \SpecialChar LaTeX
2490 \begin_inset Flex Code
2493 \begin_layout Plain Layout
2504 If no value is specified,
2506 \begin_inset Flex Code
2509 \begin_layout Plain Layout
2518 \begin_layout Labeling
2519 \labelwidthstring 00.00.0000
2520 \begin_inset Flex Code
2523 \begin_layout Plain Layout
2529 This converter is considered non-safe and needs authorization by the user.
2530 Depending on the settings in
2532 Tools\SpecialChar menuseparator
2533 Preferences\SpecialChar menuseparator
2534 File Handling\SpecialChar menuseparator
2538 users will (a.) be asked whether they trust the current document temporarily,
2541 (b.) be informed that conversion is not possible due to security concerns,
2542 or (c.) not be informed as they gave permanent consent.
2543 Set this flag for converters that might execute arbitrary programs.
2546 \begin_layout Labeling
2547 \labelwidthstring 00.00.0000
2548 \begin_inset Flex Code
2551 \begin_layout Plain Layout
2557 Needs the \SpecialChar LaTeX
2559 \begin_inset Flex Noun
2562 \begin_layout Plain Layout
2568 file for the conversion.
2570 \begin_inset Flex Code
2573 \begin_layout Plain Layout
2579 value specifies the form of \SpecialChar LaTeX
2580 that is run in order to generate the
2581 \begin_inset Flex Noun
2584 \begin_layout Plain Layout
2591 \begin_inset Flex Code
2594 \begin_layout Plain Layout
2605 If no value is specified,
2607 \begin_inset Flex Code
2610 \begin_layout Plain Layout
2619 \begin_layout Labeling
2620 \labelwidthstring 00.00.0000
2621 \begin_inset Flex Code
2624 \begin_layout Plain Layout
2631 \begin_inset Quotes eld
2635 \begin_inset Quotes erd
2638 file from the backend,
2639 which in practice means a \SpecialChar LaTeX
2640 file like the one we would export,
2642 \begin_inset Flex Code
2645 \begin_layout Plain Layout
2654 \begin_layout Labeling
2655 \labelwidthstring 00.00.0000
2656 \begin_inset Flex Code
2659 \begin_layout Plain Layout
2668 \begin_layout Standard
2669 The following three flags are not really flags at all because they take an argument in the
2670 \begin_inset Flex Noun
2673 \begin_layout Plain Layout
2675 \begin_inset space ~
2679 \begin_inset space ~
2690 \begin_layout Labeling
2691 \labelwidthstring 00.00.0000
2692 \begin_inset Flex Code
2695 \begin_layout Plain Layout
2701 The name of the driver that needs to be loaded with the
2705 package for this converter.
2706 The loading of the correct driver is necessary to get some PDF-specific features.
2714 \begin_layout Labeling
2715 \labelwidthstring 00.00.0000
2716 \begin_inset Flex Code
2719 \begin_layout Plain Layout
2726 the converter's standard error will be redirected to a file
2727 \begin_inset Flex Code
2730 \begin_layout Plain Layout
2737 and the script given as argument will be run as:
2739 \begin_inset Flex Code
2742 \begin_layout Plain Layout
2743 script < infile.out > infile.log
2749 The argument may contain
2750 \begin_inset Flex Code
2753 \begin_layout Plain Layout
2762 \begin_layout Labeling
2763 \labelwidthstring 00.00.0000
2764 \begin_inset Flex Code
2767 \begin_layout Plain Layout
2773 The name of the directory in which the converter will dump the generated files.
2775 will not create this directory,
2776 and it does not copy anything into it,
2777 though it will copy this directory to the destination.
2778 The argument may contain
2779 \begin_inset Flex Code
2782 \begin_layout Plain Layout
2789 which will be replaced by the base name of the input and output files,
2791 when the directory is copied.
2792 \begin_inset Newline newline
2795 Note that resultdir and usetempdir make no sense together.
2796 The latter will be ignored if the former is given.
2799 \begin_layout Labeling
2800 \labelwidthstring 00.00.0000
2801 \begin_inset Flex Code
2804 \begin_layout Plain Layout
2810 Determines the output file name and may,
2812 \begin_inset Flex Code
2815 \begin_layout Plain Layout
2822 Sensible only with resultdir and optional even then;
2824 it defaults to `index'.
2827 \begin_layout Standard
2828 A suitable hyperref-driver is set for some converters that are installed with \SpecialChar LyX
2830 The last three flags,
2832 are presently not used in any of the pre-installed converters.
2835 \begin_layout Standard
2836 You do not have to define converters for all formats between which you want to convert.
2838 you will note that there is no `\SpecialChar LyX
2839 to PostScript' converter,
2840 but \SpecialChar LyX
2841 will export PostScript.
2842 It does so by first creating a \SpecialChar LaTeX
2843 file (no converter needs to be defined for this) which is then converted to DVI using the `\SpecialChar LaTeX
2845 and finally converting the resulting DVI file to PostScript.
2847 finds such `chains' of converters automatically,
2848 and it will always choose the shortest possible chain.
2851 still define multiple conversion methods between file formats.
2853 the standard \SpecialChar LyX
2854 configuration provides five ways to convert \SpecialChar LaTeX
2858 \begin_layout Enumerate
2861 \begin_inset Flex Noun
2864 \begin_layout Plain Layout
2873 \begin_layout Enumerate
2874 via (DVI and) PostScript,
2876 \begin_inset Flex Noun
2879 \begin_layout Plain Layout
2888 \begin_layout Enumerate
2891 \begin_inset Flex Noun
2894 \begin_layout Plain Layout
2903 \begin_layout Enumerate
2905 \begin_inset Flex Noun
2908 \begin_layout Plain Layout
2918 \begin_layout Enumerate
2920 \begin_inset Flex Noun
2923 \begin_layout Plain Layout
2933 \begin_layout Standard
2934 To define such alternate chains,
2935 you must define multiple target `file formats',
2937 \begin_inset CommandInset ref
2939 reference "sec:Formats"
2946 in the standard configuration,
2948 \begin_inset Flex Noun
2951 \begin_layout Plain Layout
2958 \begin_inset Flex Noun
2961 \begin_layout Plain Layout
2969 \begin_inset Flex Noun
2972 \begin_layout Plain Layout
2979 \begin_inset Flex Noun
2982 \begin_layout Plain Layout
2990 \begin_inset Flex Noun
2993 \begin_layout Plain Layout
3000 \begin_inset Flex Noun
3003 \begin_layout Plain Layout
3011 \begin_inset Flex Noun
3014 \begin_layout Plain Layout
3021 \begin_inset Flex Noun
3024 \begin_layout Plain Layout
3033 \begin_inset Flex Noun
3036 \begin_layout Plain Layout
3043 \begin_inset Flex Noun
3046 \begin_layout Plain Layout
3054 all of which share the extension
3055 \begin_inset Flex Noun
3058 \begin_layout Plain Layout
3065 and which correspond to the conversion methods just mentioned.
3068 \begin_layout Chapter
3069 Internationalizing \SpecialChar LyX
3071 \begin_inset CommandInset label
3073 name "cha:Internationalizing-LyX"
3080 \begin_layout Standard
3082 supports using a translated interface.
3083 Last time we checked,
3085 provided text in thirty languages.
3086 The language of choice is called your
3091 (For further reading on locale settings,
3092 see also the documentation for locale that comes with your operating system.
3095 \begin_inset Flex Code
3098 \begin_layout Plain Layout
3104 could be a good place to start).
3107 \begin_layout Standard
3108 Notice that these translations will work,
3109 but do contain a few flaws.
3111 all dialogs have been designed with the English text in mind,
3112 which means that some of the translated text will be too large to fit within the space allocated.
3113 This is only a display problem and will not cause any harm.
3115 you will find that some of the translations do not define shortcut keys for everything.
3117 there are simply not enough free letters to do it.
3119 the translator just hasn't got around to doing it yet.
3120 Our localization team,
3121 which you may wish to join,
3125 \begin_layout Plain Layout
3126 If you are a fluent speaker of a language other than English,
3127 joining these teams is a great way to give back to the \SpecialChar LyX
3133 will of course try to fix these shortcomings in future versions of \SpecialChar LyX
3137 \begin_layout Section
3138 Translating \SpecialChar LyX
3142 \begin_layout Subsection
3143 Translating the graphical user interface (text messages).
3146 \begin_layout Standard
3149 \begin_inset Flex Code
3152 \begin_layout Plain Layout
3158 library to handle the internationalization of the interface.
3159 To have \SpecialChar LyX
3160 speak your favorite language in all menus and dialogs,
3162 \begin_inset Flex Code
3165 \begin_layout Plain Layout
3171 -file for that language.
3172 When this is available,
3173 you'll have to generate a
3174 \begin_inset Flex Code
3177 \begin_layout Plain Layout
3183 -file from it and install the
3184 \begin_inset Flex Code
3187 \begin_layout Plain Layout
3194 The process of doing all of this is explained in the documentation for GNU
3195 \begin_inset Flex Code
3198 \begin_layout Plain Layout
3205 It is possible to do this just for yourself,
3206 but if you're going to do it,
3207 you might as well share the results of your labors with the rest of the \SpecialChar LyX
3209 Send a message to the \SpecialChar LyX
3210 developers' list for more information about how to proceed.
3213 \begin_layout Standard
3215 this is what you should do (xx denotes the language code):
3218 \begin_layout Itemize
3219 Check out the \SpecialChar LyX
3222 \begin_inset CommandInset href
3224 name "information on the web"
3225 target "https://www.lyx.org/HowToUseGIT"
3233 \begin_layout Itemize
3235 \begin_inset Flex Code
3238 \begin_layout Plain Layout
3244 to the folder of the
3245 \begin_inset Flex Code
3248 \begin_layout Plain Layout
3256 \begin_inset Flex Code
3259 \begin_layout Plain Layout
3267 \begin_inset Flex Code
3270 \begin_layout Plain Layout
3276 doesn't exist anywhere,
3277 it can be remade with the console command
3278 \begin_inset Flex Code
3281 \begin_layout Plain Layout
3288 or you can use an existing po-file for some other language as a template).
3291 \begin_layout Itemize
3293 \begin_inset Flex Code
3296 \begin_layout Plain Layout
3306 \begin_layout Plain Layout
3307 This is just a text file,
3308 so it can be edited in any text editor.
3309 But there are also specialized programs that support such editing,
3314 (for all platforms) or
3323 contains a `mode' for editing
3324 \begin_inset Flex Code
3327 \begin_layout Plain Layout
3336 \begin_inset Flex URL
3339 \begin_layout Plain Layout
3341 https://www.gnu.org/software/gettext/manual/html_node/PO-Mode.html#PO-Mode
3351 For some menu- and widget-labels,
3352 there are also shortcut keys that should be translated.
3353 Those keys are marked after a `|',
3354 and should be translated according to the words and phrases of the language.
3355 You should also fill also out the information at the beginning of the new
3356 \begin_inset Flex Code
3359 \begin_layout Plain Layout
3365 -file with your email-address,
3367 so people know where to reach you with suggestions and entertaining flames.
3370 \begin_layout Standard
3371 If you are just doing this on your own,
3375 \begin_layout Itemize
3377 \begin_inset Flex Code
3380 \begin_layout Plain Layout
3387 This can be done with
3388 \begin_inset Flex Code
3391 \begin_layout Plain Layout
3392 msgfmt -o xx.mo < xx.po
3400 \begin_layout Itemize
3402 \begin_inset Flex Code
3405 \begin_layout Plain Layout
3411 -file to your locale-tree,
3412 at the correct directory for application messages for the language
3418 \begin_inset Flex Code
3421 \begin_layout Plain Layout
3428 \begin_inset space \thinspace{}
3432 \begin_inset space \space{}
3436 \begin_inset Flex Code
3439 \begin_layout Plain Layout
3440 /usr/local/share/locale/xx/LC_MESSAGES/lyx.mo
3450 \begin_layout Standard
3453 it would be best if the new
3454 \begin_inset Flex Code
3457 \begin_layout Plain Layout
3463 file could be added to the \SpecialChar LyX
3465 so others can use it.
3466 Adding it involves making additional changes to \SpecialChar LyX
3468 So send an email to the developers' mailing list if you're interested in doing that.
3471 \begin_layout Subsubsection
3475 \begin_layout Standard
3476 Sometimes it turns out that one English message needs to be translated into different messages in the target language.
3477 One example is the message
3478 \begin_inset Flex Code
3481 \begin_layout Plain Layout
3487 which has the German translation
3496 depending upon exactly what the English
3497 \begin_inset Quotes eld
3501 \begin_inset Quotes erd
3506 \begin_inset Flex Code
3509 \begin_layout Plain Layout
3515 does not handle such ambiguous translations.
3516 Therefore you have to add some context information to the message:
3518 \begin_inset Flex Code
3521 \begin_layout Plain Layout
3528 \begin_inset Flex Code
3531 \begin_layout Plain Layout
3532 To[[as in 'From format x to format y']]
3538 \begin_inset Flex Code
3541 \begin_layout Plain Layout
3542 To[[as in 'From page x to page y']].
3547 Now the two occurrences of
3548 \begin_inset Flex Code
3551 \begin_layout Plain Layout
3558 \begin_inset Flex Code
3561 \begin_layout Plain Layout
3567 and can be translated correctly to
3579 \begin_layout Standard
3580 Of course the context information needs to be stripped off the original message when no translation is used.
3581 Therefore you have to put it in double square brackets at the end of the message (see the example above).
3582 The translation mechanism of \SpecialChar LyX
3583 ensures that everything in double square brackets at the end of messages is removed before displaying the message.
3586 \begin_layout Subsection
3587 Translating the documentation.
3590 \begin_layout Standard
3591 The online documentation (in the
3592 \begin_inset Flex Noun
3595 \begin_layout Plain Layout
3601 -menu) can (and should!) be translated.
3602 If there are translated versions of the documentation available
3606 \begin_layout Plain Layout
3608 at least some of the documents have been translated into fourteen languages,
3609 with the Tutorial available in a few more.
3614 and the locale is set accordingly,
3615 these will be used automagically by \SpecialChar LyX
3618 looks for translated versions as
3619 \begin_inset Flex Code
3622 \begin_layout Plain Layout
3623 LyXDir/doc/xx/DocName.lyx
3630 \begin_inset Flex Code
3633 \begin_layout Plain Layout
3639 is the code for the language currently in use.
3640 If there are no translated documents,
3641 the default English versions will be displayed.
3642 Note that the translated versions must have the same filenames (
3643 \begin_inset Flex Code
3646 \begin_layout Plain Layout
3652 above) as the original.
3653 If you feel up to translating the documentation (an excellent way to proof-read the original documentation by the way!),
3654 there are a few things you should do right away:
3657 \begin_layout Itemize
3658 Check out the documentation translation web page at
3659 \begin_inset CommandInset href
3661 name "https://www.lyx.org/Translation"
3662 target "https://www.lyx.org/Translation"
3669 you can find out which (if any) documents have already been translated into your language.
3670 You can also find out who (if anyone) is organizing the effort to translate the documentation into your language.
3671 If no one is organizing the effort,
3672 please let us know that you're interested.
3675 \begin_layout Standard
3676 Once you get to actually translating,
3677 here's a few hints for you that may save you trouble:
3680 \begin_layout Itemize
3681 Join the documentation team!
3682 There is information on how to do that in
3683 \begin_inset Flex Code
3686 \begin_layout Plain Layout
3693 \begin_inset Flex Noun
3696 \begin_layout Plain Layout
3697 Help\SpecialChar menuseparator
3704 which by the way is the first document you should translate.
3707 \begin_layout Itemize
3708 Learn the typographic conventions for the language you are translating to.
3709 Typography is an ancient art and over the centuries,
3710 a great variety of conventions have developed throughout different parts of the world.
3711 Also study the professional terminology amongst typographers in your country.
3712 Inventing your own terminology will only confuse the users.
3716 Typography is addictive!)
3719 \begin_layout Itemize
3720 Make a copy of the document.
3721 This will be your working copy.
3722 You can use this as your personal translated help-file by placing it in your
3723 \begin_inset Flex Code
3726 \begin_layout Plain Layout
3733 \begin_inset Note Greyedout
3736 \begin_layout Plain Layout
3742 For a complex document with external material (images,
3744 if you make a copy e.
3745 \begin_inset space \thinspace{}
3749 \begin_inset space \space{}
3753 beware that the links to external material may be broken when the document is moved to a different place.
3754 The best way is to retrieve the \SpecialChar LyX
3756 \begin_inset Flex URL
3759 \begin_layout Plain Layout
3761 https://www.lyx.org/HowToUseGIT
3766 ) and to edit the doc file in place.
3774 \begin_layout Itemize
3775 Sometimes the original document (from the \SpecialChar LyX
3776 team) will be updated.
3777 Use the source viewer at
3778 \begin_inset CommandInset href
3780 name "https://www.lyx.org/trac/timeline"
3781 target "https://www.lyx.org/trac/timeline"
3786 to see what has been changed.
3787 That way you can easily see which parts of the translated document need to be updated.
3790 \begin_layout Standard
3791 If you ever find an error in the original document,
3792 fix it and notify the rest of the documentation team of the changes!
3793 (You didn't forget to join the documentation team,
3797 \begin_layout Standard
3798 \begin_inset Branch OutDated
3802 \begin_layout Section
3803 International Keyboard Support
3806 \begin_layout Standard
3810 The following section is by
3818 It needs to be fixed to conform to the new Documentation Style sheet and to make use of the new v1.0 features.
3819 The whole thing also needs to be merged with the section following it.-jw It may also be badly out of date.-rh (2008)]
3822 \begin_layout Subsection
3823 Defining Own Keymaps:
3827 \begin_layout Standard
3828 Let's look at a keyboard definition file a little closer.
3829 It is a plain text file defining
3832 \begin_layout Itemize
3833 key-to-key or key-to-string translations
3836 \begin_layout Itemize
3840 \begin_layout Itemize
3841 dead keys exceptions
3844 \begin_layout Standard
3845 To define key-to-key or key-to-string translation,
3849 \begin_layout Quotation
3850 \begin_inset Flex Code
3853 \begin_layout Plain Layout
3862 \begin_inset Flex Code
3865 \begin_layout Plain Layout
3874 \begin_layout Standard
3876 \begin_inset Flex Code
3879 \begin_layout Plain Layout
3885 is the key to be translated and
3886 \begin_inset Flex Code
3889 \begin_layout Plain Layout
3895 is the string to be inserted into the document.
3896 To define dead keys,
3900 \begin_layout Quotation
3901 \begin_inset Flex Code
3904 \begin_layout Plain Layout
3913 \begin_inset Flex Code
3916 \begin_layout Plain Layout
3925 \begin_layout Standard
3927 \begin_inset Flex Code
3930 \begin_layout Plain Layout
3936 is a keyboard key and
3937 \begin_inset Flex Code
3940 \begin_layout Plain Layout
3947 The following dead keys are supported (shortcut name is in parentheses):
3950 \begin_layout Quotation
3954 \begin_inset space \hfill{}
3960 \begin_layout Quotation
3962 \begin_inset space \hfill{}
3968 \begin_layout Quotation
3970 \begin_inset space \hfill{}
3976 \begin_layout Quotation
3978 \begin_inset space \hfill{}
3984 \begin_layout Quotation
3986 \begin_inset space \hfill{}
3992 \begin_layout Quotation
3994 \begin_inset space \hfill{}
4001 \begin_layout Plain Layout
4013 \begin_layout Quotation
4015 \begin_inset space \hfill{}
4021 \begin_layout Quotation
4023 \begin_inset space \hfill{}
4030 \begin_layout Plain Layout
4042 \begin_layout Quotation
4044 \begin_inset space \hfill{}
4050 \begin_layout Quotation
4052 \begin_inset space \hfill{}
4058 \begin_layout Quotation
4060 \begin_inset space \hfill{}
4067 \begin_layout Plain Layout
4079 \begin_layout Quotation
4081 \begin_inset space \hfill{}
4088 \begin_layout Plain Layout
4100 \begin_layout Quotation
4102 \begin_inset space \hfill{}
4108 \begin_layout Quotation
4109 hungarian umlaut (hug)
4110 \begin_inset space \hfill{}
4116 \begin_layout Quotation
4118 \begin_inset space \hfill{}
4124 \begin_layout Quotation
4126 \begin_inset space \hfill{}
4133 \begin_layout Plain Layout
4145 \begin_layout Standard
4146 Since in many international keyboards there are exceptions to what some dead keys should do,
4147 you can define them using
4150 \begin_layout Quotation
4151 \begin_inset Flex Code
4154 \begin_layout Plain Layout
4162 deadkey key outstring
4165 \begin_layout Standard
4168 if you enter caron-o,
4169 it generates circumflex-o,
4173 \begin_layout Quotation
4174 \begin_inset Flex Code
4177 \begin_layout Plain Layout
4190 \begin_layout Standard
4191 to make it work correctly.
4193 you have to define as exceptions dead keys over i and j,
4194 to remove the dot from them before inserting an accent mark.
4195 I will change this when the time comes,
4196 but so far I haven't had time.
4199 \begin_layout Standard
4201 and about characters:
4202 backslash is escaped,
4204 you'll need double backslash.
4207 \begin_inset Flex Code
4210 \begin_layout Plain Layout
4216 have different meaning.
4218 \begin_inset Flex Code
4221 \begin_layout Plain Layout
4228 quotes start and end \SpecialChar LaTeX
4232 \begin_inset Flex Code
4235 \begin_layout Plain Layout
4245 \begin_inset Flex Code
4248 \begin_layout Plain Layout
4256 \begin_inset Flex Code
4259 \begin_layout Plain Layout
4270 \begin_layout Standard
4271 If you make a keyboard description file that works for your language,
4272 please mail it to me,
4273 so I can include it in the next keymap distribution.
4276 \begin_layout Standard
4277 More keywords will be supported in keymap configuration file in future,
4281 \begin_layout Itemize
4282 \begin_inset Flex Code
4285 \begin_layout Plain Layout
4296 \begin_inset space \hfill{}
4300 \begin_inset Flex Code
4303 \begin_layout Plain Layout
4312 \begin_layout Itemize
4313 \begin_inset Flex Code
4316 \begin_layout Plain Layout
4327 \begin_inset space \hfill{}
4331 \begin_inset Flex Code
4334 \begin_layout Plain Layout
4340 an external keymap translation program
4343 \begin_layout Standard
4346 \begin_inset Flex Code
4349 \begin_layout Plain Layout
4358 \begin_inset Flex Code
4361 \begin_layout Plain Layout
4369 option to include default keyboard).
4377 \begin_layout Section
4378 International Keymap Stuff
4379 \begin_inset CommandInset label
4381 name "sec:International-Keymap-Stuff"
4388 \begin_layout Standard
4389 \begin_inset Note Note
4392 \begin_layout Plain Layout
4393 In doing the revisions on this document in March 2008,
4394 I did not look over this stuff,
4395 as I do not understand it.
4396 It would be good if someone else could do so.
4405 \begin_layout Standard
4406 The next two sections describe the
4407 \begin_inset Flex Code
4410 \begin_layout Plain Layout
4419 \begin_inset Flex Code
4422 \begin_layout Plain Layout
4430 file syntax in detail.
4431 These sections should help you design your own key map if the ones provided do not meet your needs.
4434 \begin_layout Subsection
4438 \begin_layout Standard
4442 \begin_inset Flex Code
4445 \begin_layout Plain Layout
4451 file maps keystrokes to characters or strings.
4452 As the name suggests,
4453 it sets a keyboard mapping.
4455 \begin_inset Flex Code
4458 \begin_layout Plain Layout
4469 \begin_inset Flex Code
4472 \begin_layout Plain Layout
4488 \begin_inset Flex Code
4491 \begin_layout Plain Layout
4505 \begin_inset Flex Code
4508 \begin_layout Plain Layout
4518 \begin_inset Flex Code
4521 \begin_layout Plain Layout
4529 are described in this section.
4532 \begin_layout Labeling
4533 \labelwidthstring 00.00.0000
4534 \begin_inset Flex Code
4537 \begin_layout Plain Layout
4545 Map a character to a string
4548 \begin_layout LyX-Code
4563 \begin_layout Standard
4597 the double-quote (")
4614 must be escaped with a preceding backslash (
4625 \begin_layout Standard
4627 \begin_inset Flex Noun
4630 \begin_layout Plain Layout
4638 statement to cause the symbol
4639 \begin_inset Flex Noun
4642 \begin_layout Plain Layout
4650 to be output for the keystroke
4651 \begin_inset Flex Noun
4654 \begin_layout Plain Layout
4665 \begin_layout LyX-Code
4671 \begin_layout Labeling
4672 \labelwidthstring 00.00.0000
4673 \begin_inset Flex Code
4676 \begin_layout Plain Layout
4684 Specify an accent character
4687 \begin_layout LyX-Code
4696 \begin_layout Standard
4697 This will make the cha
4735 This is the dead key
4739 \begin_layout Plain Layout
4746 refers to a key that does not produce a character by itself,
4747 but when followed with another key,
4748 produces the desired accent character.
4752 r with an umlaut like
4762 can be produced in this manner.
4771 \begin_layout Standard
4784 and then another key not in
4802 followed by the other,
4808 \begin_inset Flex Noun
4811 \begin_layout Plain Layout
4831 \begin_inset Flex Noun
4834 \begin_layout Plain Layout
4844 the cursor will not go one position backwards but will instead cancel the effect t
4859 might have had on the next keystroke.
4863 \begin_layout Standard
4864 The following example specifies that the character ' is to be an acute accent,
4865 allowed on the characters a,
4877 \begin_layout LyX-Code
4880 kmod ' acute aeiouAEIOU
4883 \begin_layout Labeling
4884 \labelwidthstring 00.00.0000
4885 \begin_inset Flex Code
4888 \begin_layout Plain Layout
4894 Specify an exception to the accent character
4897 \begin_layout LyX-Code
4906 \begin_layout Standard
4907 This defines an exce
4948 have been assigned a keystroke with a previous
4951 \begin_inset Flex Code
4954 \begin_layout Plain Layout
4978 must not belong in the
5026 If such a declaration does not exist in
5034 \begin_inset Flex Code
5037 \begin_layout Plain Layout
5072 \begin_inset Flex Code
5075 \begin_layout Plain Layout
5089 \begin_layout Standard
5090 The following command produces causes äi to be produced when you enter acute-i ('i):
5093 \begin_layout LyX-Code
5107 \begin_layout Labeling
5108 \labelwidthstring 00.00.0000
5109 \begin_inset Flex Code
5112 \begin_layout Plain Layout
5118 Combine two accent characters
5121 \begin_layout LyX-Code
5127 accent1 accent2 allowed
5130 \begin_layout Standard
5131 This one is getting pretty esoteric.
5132 It allows you to combine the effect
5188 \begin_inset Flex Code
5191 \begin_layout Plain Layout
5219 \begin_layout Standard
5220 Consider this example from the
5221 \begin_inset Flex Code
5224 \begin_layout Plain Layout
5235 \begin_layout LyX-Code
5239 acute aeioyvhAEIOYVH
5244 kcomb acute umlaut iyIY
5247 \begin_layout Standard
5248 This allows you to press
5249 \begin_inset Flex Noun
5252 \begin_layout Plain Layout
5260 and get the effect of
5261 \begin_inset Flex Code
5264 \begin_layout Plain Layout
5283 in this case cancels the last dead key,
5285 \begin_inset Flex Noun
5288 \begin_layout Plain Layout
5298 \begin_inset Flex Code
5301 \begin_layout Plain Layout
5314 \begin_layout Subsection
5318 \begin_layout Standard
5320 \begin_inset Flex Code
5323 \begin_layout Plain Layout
5331 mapping is performed,
5333 \begin_inset Flex Code
5336 \begin_layout Plain Layout
5346 file maps the strings that the symbols generate to characters in the current font.
5347 The \SpecialChar LyX
5348 distribution currently includes at least the
5349 \begin_inset Flex Code
5352 \begin_layout Plain Layout
5361 \begin_inset Flex Code
5364 \begin_layout Plain Layout
5375 \begin_layout Standard
5377 \begin_inset Flex Code
5380 \begin_layout Plain Layout
5388 file is a sequence of declarations of the form
5391 \begin_layout LyX-Code
5404 \begin_layout Standard
5407 \begin_inset Flex Noun
5410 \begin_layout Plain Layout
5420 to the corresponding character in the iso-8859-1 set (233),
5421 the following declaration is used
5424 \begin_layout LyX-Code
5432 \begin_layout Standard
5434 \begin_inset Flex Code
5437 \begin_layout Plain Layout
5446 \begin_inset Flex Code
5449 \begin_layout Plain Layout
5467 the same character can apply to more than one string.
5469 \begin_inset Flex Code
5472 \begin_layout Plain Layout
5483 \begin_layout LyX-Code
5495 \begin_inset Newline newline
5511 \begin_layout Standard
5513 cannot find a mapping for the string produced by the keystroke or a deadkey sequence,
5514 it will check if it looks like an accented char and try to draw an accent over the character on screen.
5517 \begin_layout Subsection
5521 \begin_layout Standard
5522 There is a second way to add support for international characters through so-called dead-keys.
5523 A dead-key works in combination with a letter to produce an accented character.
5525 we'll explain how to create a really simple dead-key to illustrate how they work.
5528 \begin_layout Standard
5529 Suppose you happen to need the circumflex character,
5531 \begin_inset Quotes eld
5535 \begin_inset Quotes erd
5540 \begin_inset Flex Noun
5543 \begin_layout Plain Layout
5550 \begin_inset space ~
5554 \begin_inset Flex Noun
5557 \begin_layout Plain Layout
5563 ] to the \SpecialChar LyX
5565 \begin_inset Flex Code
5568 \begin_layout Plain Layout
5575 \begin_inset Flex Code
5578 \begin_layout Plain Layout
5586 whenever you type the
5587 \begin_inset Flex Noun
5590 \begin_layout Plain Layout
5596 -key followed by a letter,
5597 that letter will have a circumflex accent on it.
5600 \begin_inset Quotes eld
5604 \begin_inset Flex Noun
5607 \begin_layout Plain Layout
5614 \begin_inset Quotes erd
5617 produces the letter:
5619 \begin_inset Quotes eld
5623 \begin_inset Quotes erd
5627 If you tried to type
5628 \begin_inset Quotes eld
5632 \begin_inset Flex Noun
5635 \begin_layout Plain Layout
5642 \begin_inset Quotes erd
5648 will complain with a beep,
5650 \begin_inset Quotes eld
5654 \begin_inset Flex Noun
5657 \begin_layout Plain Layout
5664 \begin_inset Quotes erd
5667 never takes a circumflex accent.
5669 \begin_inset Flex Noun
5672 \begin_layout Plain Layout
5678 after a dead-key produces the bare-accent.
5679 Please note this last point!
5680 If you bind a key to a dead-key,
5681 you'll need to rebind the character on that key to yet another key.
5683 \begin_inset Flex Noun
5686 \begin_layout Plain Layout
5692 to a cedilla is a bad idea,
5693 since you'll only get cedillas instead of commas.
5696 \begin_layout Standard
5697 One common way to bind dead-keys is to use
5698 \begin_inset Flex Noun
5701 \begin_layout Plain Layout
5709 \begin_inset Flex Noun
5712 \begin_layout Plain Layout
5720 \begin_inset Flex Noun
5723 \begin_layout Plain Layout
5729 in combination with an accent,
5731 \begin_inset Quotes eld
5735 \begin_inset Flex Noun
5738 \begin_layout Plain Layout
5745 \begin_inset Quotes erd
5749 \begin_inset Quotes eld
5753 \begin_inset Flex Noun
5756 \begin_layout Plain Layout
5763 \begin_inset Quotes erd
5767 \begin_inset Quotes eld
5771 \begin_inset Flex Noun
5774 \begin_layout Plain Layout
5781 \begin_inset Quotes erd
5785 Another way involves using
5786 \begin_inset Flex Code
5789 \begin_layout Plain Layout
5796 \begin_inset Flex Code
5799 \begin_layout Plain Layout
5805 to set up the special
5806 \begin_inset Flex Code
5809 \begin_layout Plain Layout
5817 \begin_inset Flex Code
5820 \begin_layout Plain Layout
5826 acts in some ways just like
5827 \begin_inset Flex Noun
5830 \begin_layout Plain Layout
5836 and permits you to bind keys to accented characters.
5837 You can also turn keys into dead-keys by binding them to something like
5838 \begin_inset Flex Code
5841 \begin_layout Plain Layout
5847 and then binding this symbolic key to the corresponding \SpecialChar LyX
5852 \begin_layout Plain Layout
5858 This is exactly what I do in my
5859 \begin_inset Flex Code
5862 \begin_layout Plain Layout
5869 \begin_inset Flex Code
5872 \begin_layout Plain Layout
5880 \begin_inset Flex Noun
5883 \begin_layout Plain Layout
5885 \begin_inset space ~
5894 \begin_inset Flex Code
5897 \begin_layout Plain Layout
5903 and a bunch of these
5904 \begin_inset Quotes eld
5908 \begin_inset Flex Code
5911 \begin_layout Plain Layout
5918 \begin_inset Quotes erd
5921 symbolic keys bound such things as
5922 \begin_inset Flex Noun
5925 \begin_layout Plain Layout
5927 \begin_inset space ~
5936 \begin_inset Flex Noun
5939 \begin_layout Plain Layout
5941 \begin_inset space ~
5950 This is how I produce my accented characters.
5955 You can make just about anything into the
5956 \begin_inset Flex Code
5959 \begin_layout Plain Layout
5967 \begin_inset Flex Noun
5970 \begin_layout Plain Layout
5977 a spare function key,
5979 As for the \SpecialChar LyX
5980 commands that produce accents,
5982 \begin_inset Flex Code
5985 \begin_layout Plain Layout
5996 You'll find the complete list there.
5999 \begin_layout Subsection
6000 Saving your Language Configuration
6003 \begin_layout Standard
6004 You can edit your preferences so that your desired language environment is automatically configured when \SpecialChar LyX
6007 \begin_inset Flex Noun
6010 \begin_layout Plain Layout
6011 Edit\SpecialChar menuseparator
6020 \begin_layout Chapter
6021 Creating and Installing New Document Classes,
6024 \begin_inset CommandInset label
6026 name "cha:Installing-New-Document"
6031 \begin_inset Argument 1
6034 \begin_layout Plain Layout
6035 Installing New Document Classes
6043 \begin_layout Standard
6045 we describe the procedures for creating and installing new \SpecialChar LyX
6046 layout and template files,
6047 as well as offer a refresher on correctly installing new \SpecialChar LaTeX
6052 \begin_layout Standard
6054 let us a say a few words about how one ought to think about the relation between \SpecialChar LyX
6055 and \SpecialChar LaTeX
6057 The thing to understand is that,
6060 doesn't know anything about \SpecialChar LaTeX
6063 from \SpecialChar LyX
6066 is just one of several
6067 \begin_inset Quotes eld
6071 \begin_inset Quotes erd
6074 in which it is capable of producing output.
6075 Other such formats are DocBook,
6081 a particularly important format,
6082 but very little of the information \SpecialChar LyX
6083 has about \SpecialChar LaTeX
6084 is actually contained in the program itself.
6088 \begin_layout Plain Layout
6089 Some commands are sufficiently complex that they are
6090 \begin_inset Quotes eld
6094 \begin_inset Quotes erd
6097 into \SpecialChar LyX
6099 But the developers generally regard this as a Bad Thing.
6106 even for the standard classes like
6107 \begin_inset Flex Code
6110 \begin_layout Plain Layout
6117 is contained in `layout files'.
6120 itself does not know much about DocBook or XHTML.
6121 What it knows is contained in layout files.
6124 \begin_layout Standard
6125 You can think of the layout file for a given document class as a translation manual between \SpecialChar LyX
6127 paragraphs with their corresponding styles,
6128 certain sorts of insets,
6130 and the corresponding \SpecialChar LaTeX
6133 or XHTML constructs.
6134 Almost everything \SpecialChar LyX
6136 \begin_inset Flex Code
6139 \begin_layout Plain Layout
6147 is contained in the file
6148 \begin_inset Flex Code
6151 \begin_layout Plain Layout
6157 and in various other files it includes.
6159 anyone intending to write layout files should plan to study the existing files.
6160 A good place to start is with
6161 \begin_inset Flex Code
6164 \begin_layout Plain Layout
6171 which is included in
6172 \begin_inset Flex Code
6175 \begin_layout Plain Layout
6183 \begin_inset Flex Code
6186 \begin_layout Plain Layout
6193 and many of the other layout files for document classes.
6194 This file is where sections and the like are defined:
6196 \begin_inset Flex Code
6199 \begin_layout Plain Layout
6205 tells \SpecialChar LyX
6206 how paragraphs that are marked with the Section,
6209 styles can be translated into corresponding \SpecialChar LaTeX
6212 and XHTML commands and tags.
6214 \begin_inset Flex Code
6217 \begin_layout Plain Layout
6223 file basically just includes several of these
6224 \begin_inset Flex Code
6227 \begin_layout Plain Layout
6236 \begin_layout Standard
6237 Defining the \SpecialChar LyX
6239 correspondence is not the only thing layout files do,
6241 Their other job is to define how the \SpecialChar LyX
6242 constructs themselves will appear on-screen.
6243 The fact that layout files have these two jobs is often a source of confusion,
6244 because they are completely separate.
6245 Telling \SpecialChar LyX
6246 how to translate a certain paragraph style into \SpecialChar LaTeX
6247 does not tell \SpecialChar LyX
6250 telling \SpecialChar LyX
6251 how to display a certain paragraph style does not tell \SpecialChar LyX
6252 how to translate it into \SpecialChar LaTeX
6253 (let alone tell \SpecialChar LaTeX
6257 when you define a new \SpecialChar LyX
6259 you must always do two quite separate things:
6261 \begin_inset space ~
6264 tell \SpecialChar LyX
6265 how to translate it into \SpecialChar LaTeX
6267 \begin_inset space ~
6270 tell \SpecialChar LyX
6274 \begin_layout Standard
6275 Much the same is true,
6277 as regards \SpecialChar LyX
6278 's other backend formats,
6279 though XHTML is in some ways different,
6280 because in that case \SpecialChar LyX
6287 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.
6290 the distinction between what \SpecialChar LyX
6291 does internally and how things are rendered externally remains in force,
6292 and the two can be controlled separately.
6294 \begin_inset CommandInset ref
6296 reference "sec:Tags-for-XHTML"
6304 \begin_layout Section
6305 Installing new \SpecialChar LaTeX
6309 \begin_layout Standard
6310 Some installations may not include a \SpecialChar LaTeX
6311 package or class file that you would like to use within \SpecialChar LyX
6314 you might need Foil\SpecialChar TeX
6316 a package for preparing slides for overhead projectors.
6317 Modern \SpecialChar LaTeX
6318 distributions like \SpecialChar TeX
6319 Live (2008 or newer) or MiK\SpecialChar TeX
6320 provide a user interface for installing such packages.
6322 with MiK\SpecialChar TeX
6324 you start the program
6325 \begin_inset Quotes eld
6329 \begin_inset space ~
6333 \begin_inset Quotes erd
6336 to get a list of available packages.
6337 To install one of them,
6338 right click on it or use the corresponding toolbar button.
6341 \begin_layout Standard
6342 If your \SpecialChar LaTeX
6343 distribution does not provide such a `package manager',
6344 or if the package is not available from your distribution,
6345 then follow these steps to install it manually:
6348 \begin_layout Enumerate
6349 Get the package from
6350 \begin_inset CommandInset href
6353 target "http://www.ctan.org/"
6361 \begin_layout Enumerate
6362 If the package contains a file with the ending
6363 \begin_inset Quotes eld
6367 \begin_inset Flex Code
6370 \begin_layout Plain Layout
6377 \begin_inset Quotes erd
6380 (is the case for Foil\SpecialChar TeX
6381 ) then open a console,
6382 change to the folder of this file and execute the command
6383 \begin_inset Flex Code
6386 \begin_layout Plain Layout
6393 You have now unpacked the package and have all files to install it.
6394 Most \SpecialChar LaTeX
6395 -packages are not packed and you can skip this step.
6398 \begin_layout Enumerate
6399 Now you need to decide if the package should be available for all users or only for you.
6403 \begin_layout Enumerate
6404 On *nix systems (Linux,
6407 if you want the new package to be available for all users on your system,
6408 then install it in your `local' \SpecialChar TeX
6410 otherwise install it in your own `user' \SpecialChar TeX
6412 Where these trees should be created,
6413 if they do not already exist,
6414 depends on your system.
6417 \begin_inset Flex Code
6420 \begin_layout Plain Layout
6430 \begin_layout Plain Layout
6431 This is usually in the directory
6432 \begin_inset Flex Code
6435 \begin_layout Plain Layout
6442 though you can execute the command
6443 \begin_inset Flex Code
6446 \begin_layout Plain Layout
6457 The location of the `local' \SpecialChar TeX
6458 tree is defined by the
6459 \begin_inset Flex Code
6462 \begin_layout Plain Layout
6469 this is usually somewhere like
6470 \begin_inset Flex Code
6473 \begin_layout Plain Layout
6474 /usr/local/share/texmf
6479 or /usr/local/texlive/XXXX where XXXX is the year of the installed \SpecialChar TeX
6481 The location of the `user' \SpecialChar TeX
6483 \begin_inset Flex Code
6486 \begin_layout Plain Layout
6493 \begin_inset Flex Code
6496 \begin_layout Plain Layout
6503 \begin_inset Flex Code
6506 \begin_layout Plain Layout
6515 (If these variables are not predefined,
6516 you have to define them.) You'll probably need root permissions to create or modify the `local' tree,
6517 but not for your `user' tree.
6518 \begin_inset Newline newline
6522 it is recommended to install in the user tree because your user will not be modified or even overwritten when you upgrade your system.
6523 It will typically also be backed up together with everything else when you backup your home directory (which,
6525 you do on a regular basis).
6528 \begin_layout Enumerate
6530 if you want the new package to be available for all users on your system,
6531 change to the folder where \SpecialChar LaTeX
6532 is installed and then change to the subfolder
6533 \begin_inset Flex Code
6536 \begin_layout Plain Layout
6547 (For MiK\SpecialChar TeX
6549 this would be by default the folder
6550 \begin_inset Flex Code
6553 \begin_layout Plain Layout
6571 \begin_layout Plain Layout
6572 Note that this will be the correct path only on English installations.
6575 \begin_inset Flex Code
6578 \begin_layout Plain Layout
6593 and similarly for other languages.
6598 Create there a new folder
6599 \begin_inset Flex Code
6602 \begin_layout Plain Layout
6608 and copy all files of the package into it.
6610 \begin_inset Newline newline
6613 If the package should only available for you or you don't have admin permissions,
6615 but in the local \SpecialChar LaTeX
6618 \begin_inset space \thinspace{}
6622 for MiK\SpecialChar TeX
6624 \begin_inset space ~
6627 2.8 under Windows XP,
6628 this would be the folder:
6629 \begin_inset Newline newline
6635 \begin_inset Flex Code
6638 \begin_layout Plain Layout
6641 Documents and Settings
6653 \begin_inset Newline newline
6659 \begin_inset Phantom HPhantom
6662 \begin_layout Plain Layout
6673 \begin_inset Flex Code
6676 \begin_layout Plain Layout
6689 \begin_inset Newline newline
6694 \begin_inset Newline newline
6698 \begin_inset Flex Code
6701 \begin_layout Plain Layout
6727 \begin_layout Enumerate
6728 Now one only need to tell \SpecialChar LaTeX
6729 that there are new files.
6730 This depends on the used \SpecialChar LaTeX
6735 \begin_layout Enumerate
6736 For \SpecialChar TeX
6737 Live execute the command
6738 \begin_inset Flex Code
6741 \begin_layout Plain Layout
6748 If you installed the package for all users,
6749 then you will probably need to have root permissions for that.
6752 \begin_layout Enumerate
6753 For MiK\SpecialChar TeX
6755 if you have installed the package for all users,
6757 \begin_inset Quotes eld
6761 \begin_inset space ~
6765 \begin_inset Quotes erd
6768 and press the button marked
6769 \begin_inset Quotes eld
6773 \begin_inset Quotes erd
6777 Otherwise start the program
6778 \begin_inset Quotes eld
6782 \begin_inset Quotes erd
6789 \begin_layout Enumerate
6791 you need to tell \SpecialChar LyX
6792 that there are new packages available.
6797 \begin_inset Flex Noun
6800 \begin_layout Plain Layout
6803 \SpecialChar menuseparator
6809 and then restart \SpecialChar LyX
6813 \begin_layout Standard
6814 Now the package is installed.
6817 \begin_inset Flex Code
6820 \begin_layout Plain Layout
6826 will now be available under
6827 \begin_inset Flex Noun
6830 \begin_layout Plain Layout
6831 Document\SpecialChar menuseparator
6832 Settings\SpecialChar menuseparator
6839 \begin_inset Quotes eld
6843 \begin_inset Quotes erd
6850 \begin_layout Standard
6851 If you would like to use a \SpecialChar LaTeX
6852 document class that is not even listed in the menu
6853 \begin_inset Flex Noun
6856 \begin_layout Plain Layout
6857 Document\SpecialChar menuseparator
6858 Settings\SpecialChar menuseparator
6865 then you need to create a `layout' file for it.
6866 That is the topic of the next section.
6869 \begin_layout Section
6870 Types of layout files
6873 \begin_layout Standard
6874 This section describes the various sorts of \SpecialChar LyX
6875 files that contain layout information.
6876 These files describe various paragraph and character styles,
6877 determining how \SpecialChar LyX
6878 should display them and how they should be translated into \SpecialChar LaTeX
6882 or whatever output format is being used.
6886 \begin_layout Standard
6887 We shall try to provide a thorough description of the process of writing layout files here.
6889 there are so many different types of documents supported even by just \SpecialChar LaTeX
6890 that we can't hope to cover every different possibility or problem you might encounter.
6891 The \SpecialChar LyX
6892 users' list is frequented by people with lots of experience with layout design who are willing to share what they've learned,
6893 so please feel free to ask questions there.
6896 \begin_layout Standard
6897 As you prepare to write a new layout,
6898 it is extremely helpful to look at the layouts distributed with \SpecialChar LyX
6900 If you write a \SpecialChar LyX
6901 layout for a \SpecialChar LaTeX
6902 document class that might also be used by others,
6903 or write a module that might be useful to others,
6904 then you should consider posting your layout to the
6905 \begin_inset CommandInset href
6907 name "layout section on the LyX wiki"
6908 target "https://wiki.lyx.org/Layouts/Layouts"
6913 or even to the \SpecialChar LyX
6915 so that it might be included in \SpecialChar LyX
6920 \begin_layout Plain Layout
6921 Note that \SpecialChar LyX
6922 is licensed under the General Public License,
6923 so any material that is contributed to \SpecialChar LyX
6924 must be similarly licensed.
6932 \begin_layout Subsection
6934 \begin_inset CommandInset label
6936 name "subsec:Layout-modules"
6943 \begin_layout Standard
6944 We have spoken to this point about `layout files'.
6945 But there are different sorts of files that contain layout information.
6949 \begin_inset Flex Code
6952 \begin_layout Plain Layout
6958 extension and provide \SpecialChar LyX
6959 with information about document classes.
6960 Since \SpecialChar LyX
6961 1.6 layout information can also be contained in layout
6967 \begin_inset Flex Code
6970 \begin_layout Plain Layout
6977 Modules are to \SpecialChar LaTeX
6978 packages much as layouts are to \SpecialChar LaTeX
6982 \begin_inset Flex Code
6985 \begin_layout Plain Layout
6992 specifically provide support for one package.
6994 layout modules are similar to included
6998 \begin_layout Plain Layout
6999 These can have any extension,
7000 but by convention have the
7001 \begin_inset Flex Code
7004 \begin_layout Plain Layout
7017 \begin_inset Flex Code
7020 \begin_layout Plain Layout
7027 in that modules are not specific to a given document class but may be used with many different classes.
7028 The difference is that using an included file with
7029 \begin_inset Flex Code
7032 \begin_layout Plain Layout
7038 requires editing that file.
7042 \begin_inset Flex Noun
7045 \begin_layout Plain Layout
7046 Document\SpecialChar menuseparator
7055 \begin_layout Standard
7056 Building modules is the easiest way to get started with layout editing,
7057 since it can be as simple as adding a single new paragraph style or flex inset.
7060 contain anything a layout file can contain.
7063 \begin_layout Standard
7064 After creating a new module and copying it to the
7065 \begin_inset Flex Code
7068 \begin_layout Plain Layout
7075 you will need to reconfigure and then restart \SpecialChar LyX
7076 for the module to appear in the menu.
7078 changes you make to the module will be seen immediately,
7080 \begin_inset Flex Noun
7083 \begin_layout Plain Layout
7084 Document\SpecialChar menuseparator
7091 highlight something,
7093 \begin_inset Quotes eld
7097 \begin_inset Quotes erd
7103 It is strongly recommended that you save your work before doing this
7109 it is strongly recommended that you not attempt to edit modules while simultaneously working on actual documents
7112 Though of course the developers strive to keep \SpecialChar LyX
7113 stable in such situations,
7114 syntax errors and the like in your module file could cause strange behavior.
7117 \begin_layout Subsubsection
7121 \begin_layout Standard
7122 Modules are to \SpecialChar LyX
7123 as packages are to \SpecialChar LaTeX
7127 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.
7128 What you need is \SpecialChar LyX
7130 \begin_inset Quotes eld
7134 \begin_inset Quotes erd
7140 \begin_layout Standard
7141 You will find it under
7143 Document\SpecialChar menuseparator
7144 Settings\SpecialChar menuseparator
7148 The large text box allows you to enter anything that you might enter in a layout file or module.
7149 You can think of a document's local layout,
7151 as a module that belongs just to it.
7155 \begin_inset Flex Code
7158 \begin_layout Plain Layout
7165 Any format is acceptable,
7166 but one would normally use the format current at the time.
7167 (In \SpecialChar LyX
7175 the current layout format is
7184 \begin_layout Standard
7185 When you have entered something in the
7186 \begin_inset Flex Code
7189 \begin_layout Plain Layout
7198 \begin_inset Quotes eld
7202 \begin_inset Quotes erd
7205 button at the bottom.
7206 Clicking this button will cause \SpecialChar LyX
7207 to determine whether what you have entered is valid layout information for the chosen format.
7209 will report the result but,
7211 will not tell you what errors there might have been.
7212 These will be written to the terminal,
7215 is started from a terminal.
7216 You will not be permitted to save your local layout until you have entered something valid.
7219 \begin_layout Standard
7220 The warnings at the end of the previous section apply here,
7222 Do not play with local layout while you are actually working,
7223 especially if you have not saved your document.
7225 using local layout with a test document can be a very convenient way to try out layout ideas,
7226 or even to start developing a module.
7229 \begin_layout Subsection
7231 \begin_inset Flex Noun
7234 \begin_layout Plain Layout
7243 \begin_layout Standard
7244 There are two situations you are likely to encounter when wanting to support a new \SpecialChar LaTeX
7247 \begin_inset Flex Code
7250 \begin_layout Plain Layout
7256 ) files and \SpecialChar LaTeX2e
7258 \begin_inset Flex Code
7261 \begin_layout Plain Layout
7268 Supporting a style file is usually fairly easy.
7269 Supporting a new class file is a bit harder.
7270 We'll discuss the former in this section and the latter in the next.
7274 \begin_layout Standard
7275 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.
7276 For the sake of the example,
7277 we'll assume that the style file is called
7278 \begin_inset Flex Noun
7281 \begin_layout Plain Layout
7287 and that it is meant to be used with
7288 \begin_inset Flex Noun
7291 \begin_layout Plain Layout
7298 which is a standard class.
7302 \begin_layout Standard
7303 Start by copying the existing class's layout file into your local directory:
7307 \begin_layout Plain Layout
7309 which directory is your local directory will vary by platform,
7310 and \SpecialChar LyX
7311 allows you to specify your local directory on startup,
7314 \begin_inset Flex Code
7317 \begin_layout Plain Layout
7331 \begin_layout LyX-Code
7332 cp report.layout ~/.lyx/layouts/myclass.layout
7335 \begin_layout Standard
7337 \begin_inset Flex Code
7340 \begin_layout Plain Layout
7346 and change the line:
7350 \begin_layout LyX-Code
7353 DeclareLaTeXClass{Report (Standard Class)}
7356 \begin_layout Standard
7360 \begin_layout LyX-Code
7363 DeclareLaTeXClass[report,
7364 myclass.sty]{Report (My Class)}
7367 \begin_layout Standard
7371 \begin_layout LyX-Code
7373 \begin_inset Newline newline
7379 \begin_inset Newline newline
7385 \begin_layout Standard
7386 near the top of the file.
7389 \begin_layout Standard
7390 Start \SpecialChar LyX
7392 \begin_inset Flex Noun
7395 \begin_layout Plain Layout
7396 Tools\SpecialChar menuseparator
7403 Then restart \SpecialChar LyX
7404 and try creating a new document.
7406 \begin_inset Flex Noun
7409 \begin_layout Plain Layout
7415 " as a document class option in the
7416 \begin_inset Flex Noun
7419 \begin_layout Plain Layout
7420 Document\SpecialChar menuseparator
7427 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—
7429 \begin_inset Flex Code
7432 \begin_layout Plain Layout
7439 so you can fiddle around with the settings for the different sections if you wish.
7440 The layout information for sections is contained in
7441 \begin_inset Flex Code
7444 \begin_layout Plain Layout
7451 but you do not need to copy and change this file.
7453 you can simply add your changes to your layout file,
7455 \begin_inset Flex Code
7458 \begin_layout Plain Layout
7465 which itself includes
7466 \begin_inset Flex Code
7469 \begin_layout Plain Layout
7477 you might add these lines:
7480 \begin_layout LyX-Code
7484 \begin_layout LyX-Code
7488 \begin_layout LyX-Code
7492 \begin_layout LyX-Code
7496 \begin_layout LyX-Code
7500 \begin_layout Standard
7501 to change the font for chapter headings to sans-serif.
7502 This will override (or,
7504 add to) the existing declaration for the Chapter style.
7508 \begin_layout Standard
7509 Your new package may also provide commands or environments not present in the base class.
7511 you will want to add these to the layout file.
7513 \begin_inset CommandInset ref
7515 reference "sec:TextClass"
7520 for information on how to do so.
7523 \begin_layout Standard
7525 \begin_inset Flex Noun
7528 \begin_layout Plain Layout
7534 can be used with several different document classes,
7535 and even if it cannot,
7536 you might find it easiest just to write a module that you can load with the base class.
7537 The simplest possible such module would be:
7540 \begin_layout LyX-Code
7543 DeclareLyXModule{My Class}
7546 \begin_layout LyX-Code
7550 \begin_layout LyX-Code
7551 #Support for myclass.sty.
7554 \begin_layout LyX-Code
7556 \begin_inset Newline newline
7562 \begin_layout LyX-Code
7570 \begin_inset Newline newline
7576 \begin_layout LyX-Code
7578 \begin_inset Newline newline
7584 \begin_inset Newline newline
7590 \begin_layout Standard
7591 A more complex module might modify the behavior of some existing constructs or define some new ones.
7594 \begin_inset CommandInset ref
7596 reference "sec:TextClass"
7604 \begin_layout Subsection
7606 \begin_inset Flex Noun
7609 \begin_layout Plain Layout
7618 \begin_layout Standard
7619 There are two possibilities here.
7620 One is that the class file is itself based upon an existing document class.
7622 many thesis classes are based upon
7623 \begin_inset Flex Noun
7626 \begin_layout Plain Layout
7633 To see whether yours is,
7634 look for a line like
7637 \begin_layout LyX-Code
7643 \begin_layout Standard
7646 then you may proceed largely as in the previous section,
7648 \begin_inset Flex Code
7651 \begin_layout Plain Layout
7652 Declare\SpecialChar LaTeX
7658 line will be different.
7659 If your new class is
7660 \begin_inset Flex Code
7663 \begin_layout Plain Layout
7669 and it is based upon
7670 \begin_inset Flex Code
7673 \begin_layout Plain Layout
7680 then the line should read:
7684 \begin_layout Plain Layout
7685 And it will be easiest if you save the file to
7686 \begin_inset Flex Code
7689 \begin_layout Plain Layout
7697 assumes that the document class has the same name as the layout file.
7706 \begin_layout LyX-Code
7709 DeclareLaTeXClass[thesis,book]{thesis}
7712 \begin_layout Standard
7715 the new class is not based upon an existing class,
7716 you will probably have to
7717 \begin_inset Quotes eld
7721 \begin_inset Quotes erd
7725 We strongly suggest copying an existing layout file which uses a similar \SpecialChar LaTeX
7726 class and then modifying it,
7728 At least use an existing file as a starting point so you can find out what items you need to worry about.
7730 the specifics are covered below.
7733 \begin_layout Subsection
7735 \begin_inset CommandInset label
7737 name "subsec:Creating-Templates"
7744 \begin_layout Standard
7745 Once you have written a layout file for a new document class,
7746 you might want to consider writing a
7752 A template acts as a kind of tutorial for your layout,
7753 showing how it might be used,
7754 though containing dummy content.
7755 You can of course look at the various templates included with \SpecialChar LyX
7759 \begin_layout Standard
7760 Templates are created just like usual documents:
7761 using \SpecialChar LyX
7763 The only difference is that usual documents contain all possible settings,
7764 including the font scheme and the paper size.
7765 Usually a user doesn't want a template to overwrite his preferred settings for such parameters.
7767 the designer of a template should remove the corresponding commands like
7768 \begin_inset Flex Code
7771 \begin_layout Plain Layout
7780 \begin_inset Flex Code
7783 \begin_layout Plain Layout
7791 from the template \SpecialChar LyX
7793 This can be done with any simple text-editor,
7795 \begin_inset Flex Code
7798 \begin_layout Plain Layout
7805 \begin_inset Flex Code
7808 \begin_layout Plain Layout
7817 \begin_layout Standard
7818 Put the edited template files you create in
7819 \begin_inset Flex Code
7822 \begin_layout Plain Layout
7829 copy the ones you use from the global template directory in
7830 \begin_inset Flex Code
7833 \begin_layout Plain Layout
7840 and redefine the template path in the
7841 \begin_inset Flex Noun
7844 \begin_layout Plain Layout
7845 Tools\SpecialChar menuseparator
7846 Preferences\SpecialChar menuseparator
7855 \begin_layout Standard
7858 that there is a template which has a particular meaning:
7859 \begin_inset Newline linebreak
7863 \begin_inset Flex Code
7866 \begin_layout Plain Layout
7873 This template is loaded every time you create a new document with
7874 \begin_inset Flex Noun
7877 \begin_layout Plain Layout
7878 File\SpecialChar menuseparator
7884 in order to provide useful defaults.
7885 To create this template from inside \SpecialChar LyX
7887 all you have to do is to open a document with the correct settings,
7889 \begin_inset Flex Noun
7892 \begin_layout Plain Layout
7893 Save as Document Defaults
7901 \begin_layout Subsection
7902 Upgrading old layout files
7905 \begin_layout Standard
7906 The format of layout files changes with each \SpecialChar LyX
7908 so old layout files need to be converted to the new format.
7910 reads a layout file in an older format,
7911 it automatically calls the script
7912 \begin_inset Flex Code
7915 \begin_layout Plain Layout
7921 to convert it to a temporary file in current format.
7922 The original file is left untouched.
7923 If you use the layout file often,
7925 you may want to convert it permanently,
7926 so that \SpecialChar LyX
7927 does not have to do so itself every time.
7929 you can call the converter manually:
7932 \begin_layout Enumerate
7934 \begin_inset Flex Code
7937 \begin_layout Plain Layout
7944 \begin_inset Flex Code
7947 \begin_layout Plain Layout
7956 \begin_layout Enumerate
7958 \begin_inset Newline newline
7962 \begin_inset Flex Code
7965 \begin_layout Plain Layout
7966 python LyXDir/scripts/layout2layout.py myclass.old myclass.layout
7972 \begin_inset Newline newline
7976 \begin_inset Flex Code
7979 \begin_layout Plain Layout
7985 is the name of your \SpecialChar LyX
7989 \begin_layout Standard
7990 Note that manual conversion does not affect included files,
7991 so these will have to be converted separately.
7994 \begin_layout Subsection
7995 \begin_inset CommandInset label
7997 name "subsec:Cite-Engine-Files"
8004 \begin_layout Standard
8005 A specific form of layout files are the so-called
8006 \begin_inset Flex Code
8009 \begin_layout Plain Layout
8015 files that are located in the
8016 \begin_inset Flex Code
8019 \begin_layout Plain Layout
8026 Their purpose is to define the specifics of \SpecialChar LaTeX
8027 packages aimed at bibliography generation,
8042 but also the way how normal Bib\SpecialChar TeX
8043 citations (without additional packages) are handled in \SpecialChar LyX
8044 is defined in such a file.
8048 \begin_layout Standard
8050 it is defined which packages \SpecialChar LyX
8052 which citation commands are available,
8053 how these are to be displayed in \SpecialChar LyX
8056 the context menus) as well as in the XHTML and plain text output.
8058 the files specify available style variants (author-year,
8060 etc.) and their specifics.
8061 The cite engine files are also used to generate the options that are available in
8063 Document\SpecialChar menuseparator
8064 Settings\SpecialChar menuseparator
8065 Bibliography\SpecialChar menuseparator
8071 \begin_layout Standard
8072 Even though a cite engine file is essentially a normal layout file that could theoretically include any layout information,
8073 it usually primarily includes some specific parameters such as
8074 \begin_inset Flex Code
8077 \begin_layout Plain Layout
8085 \begin_inset Flex Code
8088 \begin_layout Plain Layout
8096 \begin_inset Flex Code
8099 \begin_layout Plain Layout
8106 \begin_inset Flex Code
8109 \begin_layout Plain Layout
8116 The syntax of the latter two is described in
8117 \begin_inset CommandInset ref
8119 reference "subsec:Citation-engine-description"
8128 \begin_inset CommandInset ref
8130 reference "subsec:Citation-format-description"
8136 as well as in the files themselves.
8139 \begin_layout Section
8140 \begin_inset CommandInset label
8142 name "sec:TextClass"
8146 The layout file format
8149 \begin_layout Standard
8150 The following sections describe how layout files are structured and written.
8151 Our advice is to go slowly,
8152 save and test often.
8153 It is really not that hard,
8154 except that the multitude of options can become overwhelming,
8155 especially if you try to check out too many at once.
8156 It becomes easier if you use existing layouts of \SpecialChar LyX
8157 as examples/reference or if you modify an existing layout to your needs.
8160 \begin_layout Standard
8161 Note that all the tags used in layout files are case-insensitive.
8163 \begin_inset Flex Code
8166 \begin_layout Plain Layout
8174 \begin_inset Flex Code
8177 \begin_layout Plain Layout
8184 \begin_inset Flex Code
8187 \begin_layout Plain Layout
8193 are really the same tag.
8194 The possible arguments are printed in brackets after the tag's name.
8195 The default argument is typeset
8196 \begin_inset Flex Code
8199 \begin_layout Plain Layout
8208 If the argument has a data type like
8209 \begin_inset Quotes eld
8213 \begin_inset Quotes erd
8217 \begin_inset Quotes eld
8221 \begin_inset Quotes erd
8225 the default is shown like this:
8227 \begin_inset Flex Code
8230 \begin_layout Plain Layout
8241 \begin_layout Subsection
8242 The document class declaration and classification
8245 \begin_layout Standard
8246 Lines in a layout file which begin with
8247 \begin_inset Flex Code
8250 \begin_layout Plain Layout
8257 There is one exception to this rule.
8259 \begin_inset Flex Code
8262 \begin_layout Plain Layout
8268 files should begin with lines like:
8271 \begin_layout LyX-Code
8274 #% Do not delete the line below;
8275 configure depends on this
8278 \begin_layout LyX-Code
8283 DeclareLaTeXClass{Article (Standard Class)}
8286 \begin_layout LyX-Code
8291 DeclareCategory{Articles}
8294 \begin_layout Standard
8295 The second and third lines are used when you (re)configure \SpecialChar LyX
8297 The layout file is read by the \SpecialChar LaTeX
8299 \begin_inset Flex Code
8302 \begin_layout Plain Layout
8309 in a special mode where
8310 \begin_inset Flex Code
8313 \begin_layout Plain Layout
8320 The first line is just a \SpecialChar LaTeX
8322 the second one contains the mandatory declaration of the text class and the third line contains the optional classification of the class.
8323 If these lines appear in a file named
8324 \begin_inset Flex Code
8327 \begin_layout Plain Layout
8334 then they define a text class of name
8335 \begin_inset Flex Code
8338 \begin_layout Plain Layout
8344 (the name of the layout file) which uses the \SpecialChar LaTeX
8346 \begin_inset Flex Code
8349 \begin_layout Plain Layout
8355 (the default is to use the same name as the layout).
8357 \begin_inset Quotes eld
8360 Article (Standard Class)
8361 \begin_inset Quotes erd
8364 that appears above is used as a description of the text class in the
8365 \begin_inset Flex Noun
8368 \begin_layout Plain Layout
8369 Document\SpecialChar menuseparator
8377 \begin_inset Quotes eld
8381 \begin_inset Quotes erd
8384 in the example) is also used in the
8385 \begin_inset Flex Noun
8388 \begin_layout Plain Layout
8389 Document\SpecialChar menuseparator
8396 the text classes are grouped by these categories (which are usually genres,
8397 so typical categories are
8398 \begin_inset Quotes eld
8402 \begin_inset Quotes erd
8407 \begin_inset Quotes eld
8411 \begin_inset Quotes erd
8416 \begin_inset Quotes eld
8420 \begin_inset Quotes erd
8425 \begin_inset Quotes eld
8429 \begin_inset Quotes erd
8434 \begin_inset Quotes eld
8438 \begin_inset Quotes erd
8443 \begin_inset Quotes eld
8447 \begin_inset Quotes erd
8451 If no category has been declared,
8452 the class will be put in the
8453 \begin_inset Quotes eld
8457 \begin_inset Quotes erd
8463 \begin_layout Standard
8464 Let's assume that you wrote your own text class that uses the
8465 \begin_inset Flex Code
8468 \begin_layout Plain Layout
8475 but where you changed the appearance of the section headings.
8476 If you put it in a file
8477 \begin_inset Flex Code
8480 \begin_layout Plain Layout
8487 the header of this file should be:
8490 \begin_layout LyX-Code
8493 #% Do not delete the line below;
8494 configure depends on this
8497 \begin_layout LyX-Code
8502 DeclareLaTeXClass[article]{Article (with My Own Headings)}
8505 \begin_layout LyX-Code
8510 DeclareCategory{Articles}
8513 \begin_layout Standard
8514 This declares a text class
8515 \begin_inset Flex Code
8518 \begin_layout Plain Layout
8525 associated with the \SpecialChar LaTeX
8527 \begin_inset Flex Code
8530 \begin_layout Plain Layout
8537 \begin_inset Quotes eld
8540 Article (with My Own Headings)
8541 \begin_inset Quotes erd
8545 If your text class depends on several packages,
8546 you can declare it as:
8549 \begin_layout LyX-Code
8552 #% Do not delete the line below;
8553 configure depends on this
8556 \begin_layout LyX-Code
8561 DeclareLaTeXClass[article,foo.sty]{Article (with My Own Headings)}
8564 \begin_layout LyX-Code
8569 DeclareCategory{Articles}
8572 \begin_layout Standard
8573 This indicates that your text class uses the
8574 \begin_inset Flex Code
8577 \begin_layout Plain Layout
8587 \begin_layout Standard
8588 Note that these declarations can also be given an optional parameter declaring the name of the document class (but not a list).
8591 \begin_layout Standard
8593 to be as explicit as possible,
8594 the form of the layout declaration is:
8597 \begin_layout LyX-Code
8602 DeclareLaTeXClass[class,package.sty]{layout description}
8605 \begin_layout LyX-Code
8610 DeclareCategory{category}
8613 \begin_layout Standard
8614 The class need only be specified if the name of the \SpecialChar LaTeX
8615 class file and the name of the layout file are different or if there are packages to load.
8616 If the name of the class file is not specified,
8617 then \SpecialChar LyX
8618 will simply assume that it is the same as the name of the layout file.
8621 \begin_layout Standard
8622 When the text class has been modified to your taste,
8623 all you have to do is to copy it either to
8624 \begin_inset Flex Code
8627 \begin_layout Plain Layout
8634 \begin_inset Flex Code
8637 \begin_layout Plain Layout
8645 \begin_inset Flex Noun
8648 \begin_layout Plain Layout
8649 Tools\SpecialChar menuseparator
8656 exit \SpecialChar LyX
8658 Then your new text class should be available along with the others.
8661 \begin_layout Standard
8662 Once the layout file is installed,
8663 you can edit it and see your changes without having to reconfigure or to restart \SpecialChar LyX
8668 \begin_layout Plain Layout
8669 In versions of \SpecialChar LyX
8673 editing layout files was very time consuming,
8674 since you had constantly to restart \SpecialChar LyX
8680 You can force a reload of the current layout by using the \SpecialChar LyX
8682 \begin_inset Flex Noun
8685 \begin_layout Plain Layout
8692 There is no default binding for this function—
8695 you can bind it to a key yourself.
8696 But you will normally use this function simply by entering it in the mini-buffer.
8700 \begin_layout Standard
8707 \begin_inset Flex Noun
8710 \begin_layout Plain Layout
8716 is very much an `advanced feature'.
8721 recommended that you save your work before using this function.
8727 recommended that you not attempt to edit layout information while simultaneously working on a document that you care about.
8728 Use a test document.
8729 Syntax errors and the like in your layout file could cause peculiar behavior.
8731 such errors could cause \SpecialChar LyX
8732 to regard the current layout as invalid and to attempt to switch to some other layout.
8736 \begin_layout Plain Layout
8737 Really bad syntax errors may even caused \SpecialChar LyX
8739 This is because certain sorts of errors may make \SpecialChar LyX
8750 The \SpecialChar LyX
8751 team strives to keep \SpecialChar LyX
8752 stable in such situations,
8753 but safe is better than sorry.
8757 \begin_layout Plain Layout
8758 While we're giving advice:
8759 make regular backups.
8760 And be nice to your mother.
8768 \begin_layout Subsection
8769 The Module declaration
8772 \begin_layout Standard
8773 A module must begin with a line like the following:
8776 \begin_layout LyX-Code
8779 DeclareLyXModule[endnotes.sty]{Endnotes}
8782 \begin_layout LyX-Code
8787 DeclareCategory{Foot- and Endnotes}
8790 \begin_layout Standard
8791 The mandatory argument of
8799 is the name of the module,
8800 as it should appear in
8801 \begin_inset Flex Noun
8804 \begin_layout Plain Layout
8805 Document\SpecialChar menuseparator
8806 Settings\SpecialChar menuseparator
8813 The argument in square brackets is optional:
8814 It declares any \SpecialChar LaTeX
8815 packages on which the module depends.
8816 It is also possible to use the form
8817 \begin_inset Flex Noun
8820 \begin_layout Plain Layout
8826 as an optional argument,
8827 which declares that the module can only be used when there exists a conversion chain between the formats `
8828 \begin_inset Flex Code
8831 \begin_layout Plain Layout
8838 \begin_inset Flex Code
8841 \begin_layout Plain Layout
8854 declaration is not strictly mandatory,
8855 but you should add it,
8856 since it is helpful to find the module.
8857 Please have a look at the existing module categories and if appropriate,
8861 \begin_layout Standard
8862 The module and category declaration should then be followed by lines like the following:
8866 \begin_layout Plain Layout
8867 Preferably in English if the module should be published with \SpecialChar LyX
8869 This description will appear in the list of messages to be translated and will be thus translated with the next interface update.
8877 \begin_layout LyX-Code
8881 \begin_layout LyX-Code
8882 #Adds an endnote command,
8883 in addition to footnotes.
8887 \begin_layout LyX-Code
8888 #You will need to add
8890 theendnotes in TeX code where you
8893 \begin_layout LyX-Code
8894 #want the endnotes to appear.
8898 \begin_layout LyX-Code
8902 \begin_layout LyX-Code
8904 somemodule | othermodule
8907 \begin_layout LyX-Code
8912 \begin_layout Standard
8913 The description is used in
8914 \begin_inset Flex Noun
8917 \begin_layout Plain Layout
8918 Document\SpecialChar menuseparator
8919 Settings\SpecialChar menuseparator
8925 to provide the user with information about what the module does.
8927 \begin_inset Flex Code
8930 \begin_layout Plain Layout
8936 line is used to identify other modules with which this one must be used;
8938 \begin_inset Flex Code
8941 \begin_layout Plain Layout
8947 line is used to identify modules with which this one may not be used.
8951 multiple modules should be separated with the pipe symbol:
8953 Note that the required modules are treated disjunctively:
8958 of the required modules must be used.
8964 excluded module may be used.
8965 Note that modules are identified here by their filenames without the
8966 \begin_inset Flex Code
8969 \begin_layout Plain Layout
8977 \begin_inset Flex Code
8980 \begin_layout Plain Layout
8987 \begin_inset Flex Code
8990 \begin_layout Plain Layout
8999 \begin_layout Subsection
9000 The CiteEngine file declaration
9003 \begin_layout Standard
9004 A cite engine file must begin with a line like the following:
9007 \begin_layout LyX-Code
9010 DeclareLyXCiteEngineModule[biblatex.sty]{Biblatex}
9013 \begin_layout Standard
9014 The mandatory argument,
9016 is the name of the cite style,
9017 as it should appear in
9018 \begin_inset Flex Noun
9021 \begin_layout Plain Layout
9022 Document\SpecialChar menuseparator
9023 Settings\SpecialChar menuseparator
9030 The argument in square brackets is optional:
9031 It declares any \SpecialChar LaTeX
9032 packages on which the cite engine depends.
9035 \begin_layout Standard
9036 The cite engine declaration should then be followed by lines like the following:
9040 \begin_layout Plain Layout
9041 Preferably in English if the module should be published with \SpecialChar LyX
9043 This description will appear in the list of messages to be translated and will be thus translated with the next interface update.
9051 \begin_layout LyX-Code
9055 \begin_layout LyX-Code
9056 # Biblatex supports many author-year and numerical styles.
9059 \begin_layout LyX-Code
9060 # It is mainly aimed at the Humanities.
9064 \begin_layout LyX-Code
9066 fully localized and provides many features
9069 \begin_layout LyX-Code
9070 # that are not possible with BibTeX.
9071 The use of 'biber' as
9074 \begin_layout LyX-Code
9075 # bibliography processor is advised.
9078 \begin_layout LyX-Code
9082 \begin_layout Standard
9083 The description is used in
9084 \begin_inset Flex Noun
9087 \begin_layout Plain Layout
9088 Document\SpecialChar menuseparator
9089 Settings\SpecialChar menuseparator
9095 to provide the user with information about the cite engine.
9098 \begin_layout Subsection
9102 \begin_layout Standard
9103 The first non-comment line of any layout file,
9109 contain the file format number:
9112 \begin_layout Description
9113 \begin_inset Flex Code
9116 \begin_layout Plain Layout
9123 \begin_inset Flex Code
9126 \begin_layout Plain Layout
9132 ] The format number of the layout file.
9135 \begin_layout Standard
9136 This tag was introduced with \SpecialChar LyX
9138 \begin_inset space ~
9142 Layout files from older \SpecialChar LyX
9143 versions do not have an explicit file format and are considered to have
9144 \begin_inset Flex Code
9147 \begin_layout Plain Layout
9149 \begin_inset space ~
9158 The format for the present version of \SpecialChar LyX
9160 But each version of \SpecialChar LyX
9161 is capable of reading earlier versions' layout files,
9162 just as they are capable of reading files produced by earlier versions of \SpecialChar LyX
9166 no provision for converting to earlier formats.
9169 \begin_layout Subsection
9170 \begin_inset CommandInset label
9172 name "subsec:General-text-class"
9176 General text class parameters
9179 \begin_layout Standard
9180 These are general parameters that govern the behavior of an entire document class.
9185 mean that they must appear in
9186 \begin_inset Flex Code
9189 \begin_layout Plain Layout
9195 files rather than in modules.
9196 A module can contain any layout tag.)
9199 \begin_layout Description
9200 \begin_inset Flex Code
9203 \begin_layout Plain Layout
9204 AddToCiteEngine <engine>
9209 Extends the possibilities for displaying citation references.
9211 \begin_inset CommandInset ref
9213 reference "subsec:Citation-engine-description"
9223 \begin_inset Flex Code
9226 \begin_layout Plain Layout
9235 \begin_layout Description
9236 \begin_inset Flex Code
9239 \begin_layout Plain Layout
9245 Adds information that will be output in the
9246 \begin_inset Flex Code
9249 \begin_layout Plain Layout
9255 block when the document is output to XHTML.
9257 this would be used to output CSS style information,
9258 but it can be used for anything that can appear in
9259 \begin_inset Flex Code
9262 \begin_layout Plain Layout
9270 \begin_inset Quotes eld
9274 \begin_inset Flex Code
9277 \begin_layout Plain Layout
9284 \begin_inset Quotes erd
9290 \begin_layout Description
9291 \begin_inset Flex Code
9294 \begin_layout Plain Layout
9300 Adds information to the document preamble.
9302 \begin_inset Newline newline
9306 \begin_inset Quotes eld
9310 \begin_inset Flex Code
9313 \begin_layout Plain Layout
9320 \begin_inset Quotes erd
9326 \begin_layout Description
9327 \begin_inset Flex Code
9330 \begin_layout Plain Layout
9337 \begin_inset Flex Code
9340 \begin_layout Plain Layout
9349 \begin_inset space \thinspace{}
9353 \begin_inset Flex Code
9356 \begin_layout Plain Layout
9362 ] If the document class adds the bibliography to the table of contents,
9363 add this option with value
9364 \begin_inset Flex Code
9367 \begin_layout Plain Layout
9374 \begin_inset Flex Code
9377 \begin_layout Plain Layout
9384 This prevents the bibliography from being added twice.
9387 \begin_layout Description
9388 \begin_inset Flex Code
9391 \begin_layout Plain Layout
9397 Defines the possibilities for displaying citation references.
9399 \begin_inset CommandInset ref
9401 reference "subsec:Citation-engine-description"
9411 \begin_inset Quotes eld
9415 \begin_inset Flex Code
9418 \begin_layout Plain Layout
9425 \begin_inset Quotes erd
9429 Primarily used in cite engine files (see
9430 \begin_inset CommandInset ref
9432 reference "subsec:Cite-Engine-Files"
9441 Note that if you specify this in a layout file or module,
9442 any cite engine definition will be overridden.
9444 \begin_inset Flex Code
9447 \begin_layout Plain Layout
9456 \begin_layout Description
9457 \begin_inset Flex Code
9460 \begin_layout Plain Layout
9466 Defines formats for use in the display of bibliographic information.
9468 \begin_inset CommandInset ref
9470 reference "subsec:Citation-format-description"
9477 \begin_inset Quotes eld
9481 \begin_inset Flex Code
9484 \begin_layout Plain Layout
9491 \begin_inset Quotes erd
9495 Primarily used in cite engine files (see
9496 \begin_inset CommandInset ref
9498 reference "subsec:Cite-Engine-Files"
9507 A cite format defined in a layout or module will override the cite engine definition.
9510 \begin_layout Description
9511 \begin_inset Flex Code
9514 \begin_layout Plain Layout
9521 \begin_inset Flex Code
9524 \begin_layout Plain Layout
9533 \begin_inset Flex Code
9536 \begin_layout Plain Layout
9542 ] Determines whether
9546 or Bib\SpecialChar TeX
9547 is used to generate a Bibliography.
9548 Primarily used in cite engine files (see
9549 \begin_inset CommandInset ref
9551 reference "subsec:Cite-Engine-Files"
9562 \begin_layout Description
9563 \begin_inset Flex Code
9566 \begin_layout Plain Layout
9572 Describes various global options supported by the document class.
9574 \begin_inset CommandInset ref
9576 reference "subsec:ClassOptions"
9583 \begin_inset Quotes eld
9587 \begin_inset Flex Code
9590 \begin_layout Plain Layout
9597 \begin_inset Quotes erd
9603 \begin_layout Description
9604 \begin_inset Flex Code
9607 \begin_layout Plain Layout
9614 \begin_inset Flex Code
9617 \begin_layout Plain Layout
9626 \begin_inset space \thinspace{}
9630 \begin_inset Flex Code
9633 \begin_layout Plain Layout
9639 ] Whether the class should
9643 to having one or two columns.
9644 Can be changed in the
9645 \begin_inset Flex Noun
9648 \begin_layout Plain Layout
9649 Document\SpecialChar menuseparator
9658 \begin_layout Description
9659 \begin_inset Flex Code
9662 \begin_layout Plain Layout
9669 \begin_inset Flex Code
9672 \begin_layout Plain Layout
9678 ] This sequence defines the properties for a counter.
9679 If the counter does not yet exist,
9684 \begin_inset Quotes eld
9688 \begin_inset Flex Code
9691 \begin_layout Plain Layout
9698 \begin_inset Quotes erd
9702 \begin_inset Newline newline
9706 \begin_inset CommandInset ref
9708 reference "subsec:Counters"
9713 for details on counters.
9716 \begin_layout Description
9717 \begin_inset Flex Code
9720 \begin_layout Plain Layout
9726 Sets the default font used to display the document.
9728 \begin_inset CommandInset ref
9730 reference "subsec:Font-description"
9735 for how to declare fonts.
9737 \begin_inset Quotes eld
9741 \begin_inset Flex Code
9744 \begin_layout Plain Layout
9751 \begin_inset Quotes erd
9757 \begin_layout Description
9758 \begin_inset Flex Code
9761 \begin_layout Plain Layout
9768 \begin_inset Flex Code
9771 \begin_layout Plain Layout
9777 ] Specifies a module to be included by default with this document class.
9778 The module is specified as filename without the
9779 \begin_inset Flex Code
9782 \begin_layout Plain Layout
9789 The user can still remove the module,
9790 but it will be active at the outset.
9791 (This applies only when new files are created,
9792 or when this class is chosen for an existing document.)
9795 \begin_layout Description
9796 \begin_inset Flex Code
9799 \begin_layout Plain Layout
9806 \begin_inset Flex Code
9809 \begin_layout Plain Layout
9815 ] This is the style that will be assigned to new paragraphs,
9817 \begin_inset Flex Noun
9820 \begin_layout Plain Layout
9827 This will default to the first defined style if not given,
9828 but you are encouraged to use this directive.
9831 \begin_layout Description
9832 \begin_inset Flex Code
9835 \begin_layout Plain Layout
9842 \begin_inset Flex Code
9845 \begin_layout Plain Layout
9851 ] The root element (at the top of the document) to use when outputting documents with this class in DocBook.
9852 The default value is
9853 \begin_inset Quotes eld
9857 \begin_inset Flex Code
9860 \begin_layout Plain Layout
9867 \begin_inset Quotes erd
9873 \begin_layout Description
9874 \begin_inset Flex Code
9877 \begin_layout Plain Layout
9878 DocBookForceAbstract
9884 \begin_inset Flex Code
9887 \begin_layout Plain Layout
9894 \begin_inset Quotes eld
9902 \begin_inset Quotes erd
9906 the root element will always have an
9911 The default value is
9912 \begin_inset Quotes eld
9920 \begin_inset Quotes erd
9926 \begin_layout Description
9927 \begin_inset Flex Code
9930 \begin_layout Plain Layout
9937 \begin_inset Flex Code
9940 \begin_layout Plain Layout
9946 ] This tag indicates that the module (which is specified by filename without the
9947 \begin_inset Flex Code
9950 \begin_layout Plain Layout
9956 extension) cannot be used with this document class.
9957 This might be used in a journal-specific layout file to prevent,
9960 \begin_inset Flex Code
9963 \begin_layout Plain Layout
9969 module that numbers theorems by section.
9974 be used in a module.
9975 Modules have their own way of excluding other modules (see
9976 \begin_inset CommandInset ref
9978 reference "subsec:Layout-modules"
9986 \begin_layout Description
9987 \begin_inset Flex Code
9990 \begin_layout Plain Layout
9996 Defines a new float.
9998 \begin_inset CommandInset ref
10000 reference "subsec:Floats"
10007 \begin_inset Quotes eld
10011 \begin_inset Flex Code
10014 \begin_layout Plain Layout
10021 \begin_inset Quotes erd
10027 \begin_layout Description
10028 \begin_inset Flex Code
10031 \begin_layout Plain Layout
10037 Sets the information that will be output in the
10038 \begin_inset Flex Code
10041 \begin_layout Plain Layout
10047 block when this document class is output to XHTML.
10048 Note that this will completely override any prior
10049 \begin_inset Flex Code
10052 \begin_layout Plain Layout
10059 \begin_inset Flex Code
10062 \begin_layout Plain Layout
10070 \begin_inset Newline newline
10074 \begin_inset Flex Code
10077 \begin_layout Plain Layout
10083 if you just want to add material to the preamble.) Must end with
10084 \begin_inset Quotes eld
10088 \begin_inset Flex Code
10091 \begin_layout Plain Layout
10098 \begin_inset Quotes erd
10104 \begin_layout Description
10105 \begin_inset Flex Code
10108 \begin_layout Plain Layout
10115 \begin_inset Flex Code
10118 \begin_layout Plain Layout
10124 ] The style to use for the table of contents,
10127 when the document is output to HTML.
10129 this should normally be
10130 \begin_inset Flex Code
10133 \begin_layout Plain Layout
10141 \begin_inset Flex Code
10144 \begin_layout Plain Layout
10151 If it is not given,
10152 then \SpecialChar LyX
10153 will attempt to figure out which layout to use.
10156 \begin_layout Description
10157 \begin_inset Flex Code
10160 \begin_layout Plain Layout
10167 \begin_inset Flex Code
10170 \begin_layout Plain Layout
10176 ] Modifies the properties of the given counter.
10177 If the counter does not exist,
10178 the statement is ignored.
10180 \begin_inset Quotes eld
10184 \begin_inset Flex Code
10187 \begin_layout Plain Layout
10194 \begin_inset Quotes erd
10198 \begin_inset Newline newline
10202 \begin_inset CommandInset ref
10204 reference "subsec:Counters"
10209 for details on counters.
10212 \begin_layout Description
10213 \begin_inset Flex Code
10216 \begin_layout Plain Layout
10223 \begin_inset Flex Code
10226 \begin_layout Plain Layout
10232 ] This allows you to include another layout definition file within yours to avoid duplicating commands.
10233 Common examples are the standard layout files,
10236 \begin_inset Flex Code
10239 \begin_layout Plain Layout
10246 which contains most of the basic layouts.
10249 \begin_layout Description
10250 \begin_inset Flex Code
10253 \begin_layout Plain Layout
10260 \begin_inset Flex Code
10263 \begin_layout Plain Layout
10269 ] is a variant of the
10270 \begin_inset Flex Code
10273 \begin_layout Plain Layout
10279 command which does not look for files in the user directory.
10280 This allows to create a file
10281 \begin_inset Flex Code
10284 \begin_layout Plain Layout
10291 \begin_inset Flex Code
10294 \begin_layout Plain Layout
10300 in the user directory which includes a global file with the same name via
10301 \begin_inset Flex Code
10304 \begin_layout Plain Layout
10311 \begin_inset Flex Code
10314 \begin_layout Plain Layout
10315 InputGlobal name.inc
10322 \begin_inset Flex Code
10325 \begin_layout Plain Layout
10332 the file would recursively include itself).
10334 you can modify global files without having to completely copy them.
10337 \begin_layout Description
10338 \begin_inset Flex Code
10341 \begin_layout Plain Layout
10348 \begin_inset Flex Code
10351 \begin_layout Plain Layout
10357 ] This section (re-)defines the layout of an inset.
10358 It can be applied to an existing inset or to a new,
10359 user-defined inset,
10361 a new character style.
10363 \begin_inset Quotes eld
10367 \begin_inset Flex Code
10370 \begin_layout Plain Layout
10377 \begin_inset Quotes erd
10381 \begin_inset Newline newline
10385 \begin_inset CommandInset ref
10387 reference "subsec:Flex-insets-and"
10392 for more information.
10396 \begin_layout Description
10397 \begin_inset Flex Code
10400 \begin_layout Plain Layout
10407 \begin_inset Flex Code
10410 \begin_layout Plain Layout
10416 ] A string that indicates the width of the left margin on the screen,
10419 \begin_inset Quotes eld
10423 \begin_inset Flex Code
10426 \begin_layout Plain Layout
10433 \begin_inset Quotes erd
10437 (Note that this is not a `length',
10439 \begin_inset Quotes eld
10443 \begin_inset Quotes erd
10449 \begin_layout Description
10450 \begin_inset Flex Code
10453 \begin_layout Plain Layout
10460 \begin_inset Flex Code
10463 \begin_layout Plain Layout
10469 ] An integer that determines the maximal number of names displayed in an author-year citation before the citation switches to
10470 \begin_inset Quotes eld
10474 \begin_inset Quotes erd
10478 Primarily used in cite engine files (see
10479 \begin_inset CommandInset ref
10481 reference "subsec:Cite-Engine-Files"
10492 \begin_layout Description
10493 \begin_inset Flex Code
10496 \begin_layout Plain Layout
10503 \begin_inset Flex Code
10506 \begin_layout Plain Layout
10512 ] Modifies the layout of an inset.
10513 If the layout does not exist,
10514 this section is ignored.
10516 \begin_inset Quotes eld
10520 \begin_inset Flex Code
10523 \begin_layout Plain Layout
10530 \begin_inset Quotes erd
10536 \begin_layout Description
10537 \begin_inset Flex Code
10540 \begin_layout Plain Layout
10547 \begin_inset Flex Code
10550 \begin_layout Plain Layout
10556 ] Modifies the properties of the given paragraph style.
10557 If the style does not exist,
10558 this section is ignored.
10560 \begin_inset Quotes eld
10564 \begin_inset Flex Code
10567 \begin_layout Plain Layout
10574 \begin_inset Quotes erd
10580 \begin_layout Description
10581 \begin_inset Flex Code
10584 \begin_layout Plain Layout
10591 \begin_inset Flex Code
10594 \begin_layout Plain Layout
10600 ] Deletes an existing counter,
10601 usually one defined in an included file.
10604 \begin_layout Description
10605 \begin_inset Flex Code
10608 \begin_layout Plain Layout
10615 \begin_inset Flex Code
10618 \begin_layout Plain Layout
10624 ] Deletes an existing float.
10625 This is particularly useful when you want to suppress a float that has been defined in an input file.
10628 \begin_layout Description
10629 \begin_inset Flex Code
10632 \begin_layout Plain Layout
10639 \begin_inset Flex Code
10642 \begin_layout Plain Layout
10648 ] Deletes an existing style.
10651 \begin_layout Description
10652 \begin_inset Flex Code
10655 \begin_layout Plain Layout
10662 \begin_inset Flex Code
10665 \begin_layout Plain Layout
10672 \begin_inset Flex Code
10675 \begin_layout Plain Layout
10681 ] Define a new table of contents with type
10682 \begin_inset Flex Code
10685 \begin_layout Plain Layout
10692 \begin_inset Flex Code
10695 \begin_layout Plain Layout
10702 See also the AddToToc commands.
10705 \begin_layout Description
10706 \begin_inset Flex Code
10709 \begin_layout Plain Layout
10716 \begin_inset Flex Code
10719 \begin_layout Plain Layout
10725 ] The file format (as defined in the \SpecialChar LyX
10726 preferences) produced by this document class.
10727 It is mainly useful when
10728 \begin_inset Flex Code
10731 \begin_layout Plain Layout
10738 \begin_inset Flex Code
10741 \begin_layout Plain Layout
10747 and one wants to define a new type of literate document.
10748 The format is reset to
10749 \begin_inset Quotes eld
10753 \begin_inset Flex Code
10756 \begin_layout Plain Layout
10763 \begin_inset Quotes erd
10766 when the corresponding
10767 \begin_inset Flex Code
10770 \begin_layout Plain Layout
10776 parameter is encountered.
10779 \begin_layout Description
10780 \begin_inset Flex Code
10783 \begin_layout Plain Layout
10790 \begin_inset Flex Code
10793 \begin_layout Plain Layout
10805 \begin_inset Flex Code
10808 \begin_layout Plain Layout
10814 ] Specifies what sort of output documents using this class will produce.
10817 \begin_layout Description
10818 \begin_inset Flex Code
10821 \begin_layout Plain Layout
10828 \begin_inset Flex Code
10831 \begin_layout Plain Layout
10838 \begin_inset Flex Code
10841 \begin_layout Plain Layout
10847 ] Specifies options,
10848 given in the second string,
10849 for the package named by the first string.
10852 \begin_inset Quotes eld
10856 \begin_inset Flex Code
10859 \begin_layout Plain Layout
10860 PackageOptions natbib square
10866 \begin_inset Quotes erd
10870 \begin_inset Flex Code
10873 \begin_layout Plain Layout
10879 to be loaded with the
10880 \begin_inset Flex Code
10883 \begin_layout Plain Layout
10890 (For \SpecialChar TeX
10892 this causes \SpecialChar LyX
10895 \begin_inset Flex Code
10898 \begin_layout Plain Layout
10901 PassOptionsToPackage{natbib}{square}
10907 \begin_inset Flex Code
10910 \begin_layout Plain Layout
10919 \begin_layout Description
10920 \begin_inset Flex Code
10923 \begin_layout Plain Layout
10930 \begin_inset Flex Code
10933 \begin_layout Plain Layout
10974 ] The default page size.
10975 This is used by some converters.
10978 \begin_layout Description
10979 \begin_inset Flex Code
10982 \begin_layout Plain Layout
10989 \begin_inset Flex Code
10992 \begin_layout Plain Layout
11002 \begin_inset Flex Code
11005 \begin_layout Plain Layout
11013 \begin_inset Flex Code
11016 \begin_layout Plain Layout
11022 ] The default pagestyle.
11023 Can be changed in the
11024 \begin_inset Flex Noun
11027 \begin_layout Plain Layout
11028 Document\SpecialChar menuseparator
11037 \begin_layout Description
11038 \begin_inset Flex Code
11041 \begin_layout Plain Layout
11047 Sets the preamble for the \SpecialChar LaTeX
11049 Note that this will completely override any prior
11050 \begin_inset Flex Code
11053 \begin_layout Plain Layout
11060 \begin_inset Flex Code
11063 \begin_layout Plain Layout
11071 \begin_inset Flex Code
11074 \begin_layout Plain Layout
11080 if you just want to add material to the preamble.) Must end with
11081 \begin_inset Quotes eld
11085 \begin_inset Flex Code
11088 \begin_layout Plain Layout
11095 \begin_inset Quotes erd
11101 \begin_layout Description
11102 \begin_inset Flex Code
11105 \begin_layout Plain Layout
11112 \begin_inset Flex Code
11115 \begin_layout Plain Layout
11121 ] Defines the layout of an inset if it does not already exist.
11122 If the layout does exist,
11123 this section is ignored.
11125 \begin_inset Quotes eld
11129 \begin_inset Flex Code
11132 \begin_layout Plain Layout
11139 \begin_inset Quotes erd
11145 \begin_layout Description
11146 \begin_inset Flex Code
11149 \begin_layout Plain Layout
11156 \begin_inset Flex Code
11159 \begin_layout Plain Layout
11166 \begin_inset Flex Code
11169 \begin_layout Plain Layout
11178 \begin_inset space \thinspace{}
11182 \begin_inset Flex Code
11185 \begin_layout Plain Layout
11191 ] Whether the class already provides the feature
11192 \begin_inset Flex Code
11195 \begin_layout Plain Layout
11202 A feature is in general the name of a package (e.
11203 \begin_inset space \thinspace{}
11207 \begin_inset space \space{}
11211 \begin_inset Flex Code
11214 \begin_layout Plain Layout
11221 \begin_inset Flex Code
11224 \begin_layout Plain Layout
11231 \begin_inset space \thinspace{}
11235 \begin_inset space \space{}
11239 \begin_inset Flex Code
11242 \begin_layout Plain Layout
11249 \begin_inset Flex Code
11252 \begin_layout Plain Layout
11260 \begin_inset CommandInset ref
11262 reference "chap:List-of-functions"
11267 for the list of features.
11270 \begin_layout Description
11271 \begin_inset Flex Code
11274 \begin_layout Plain Layout
11281 \begin_inset Flex Code
11284 \begin_layout Plain Layout
11290 ] Indicates that this layout provides the functionality of the module mentioned,
11291 which should be specified by the filename without the
11292 \begin_inset Flex Code
11295 \begin_layout Plain Layout
11302 This will typically be used if the layout includes the module directly,
11303 rather than using the
11304 \begin_inset Flex Code
11307 \begin_layout Plain Layout
11313 tag to indicate that it ought to be used.
11314 It could also be used in a module that provided an alternate implementation of the same functionality.
11317 \begin_layout Description
11318 \begin_inset Flex Code
11321 \begin_layout Plain Layout
11328 \begin_inset Flex Code
11331 \begin_layout Plain Layout
11337 ] Creates a new paragraph style if it does not already exist.
11338 If the style does exist,
11339 this section is ignored.
11341 \begin_inset Quotes eld
11345 \begin_inset Flex Code
11348 \begin_layout Plain Layout
11355 \begin_inset Quotes erd
11361 \begin_layout Description
11362 \begin_inset Flex Code
11365 \begin_layout Plain Layout
11372 \begin_inset Flex Code
11375 \begin_layout Plain Layout
11381 ] Whether the class requires the feature
11382 \begin_inset Flex Code
11385 \begin_layout Plain Layout
11392 Multiple features must be separated by commas.
11393 Note that you can only request supported features.
11395 \begin_inset CommandInset ref
11397 reference "chap:List-of-functions"
11402 for the list of features.).
11403 If you require a package with specific options,
11404 you can additionally use
11405 \begin_inset Flex Code
11408 \begin_layout Plain Layout
11417 \begin_layout Description
11418 \begin_inset Flex Code
11421 \begin_layout Plain Layout
11428 \begin_inset Flex Code
11431 \begin_layout Plain Layout
11437 ] A string that indicates the width of the right margin on the screen,
11440 \begin_inset Quotes eld
11444 \begin_inset Flex Code
11447 \begin_layout Plain Layout
11454 \begin_inset Quotes erd
11460 \begin_layout Description
11461 \begin_inset Flex Code
11464 \begin_layout Plain Layout
11471 \begin_inset Flex Code
11474 \begin_layout Plain Layout
11480 ] Sets which divisions get numbered.
11482 \begin_inset Newline newline
11486 \begin_inset Flex Code
11489 \begin_layout Plain Layout
11495 counter in \SpecialChar LaTeX
11499 \begin_layout Description
11500 \begin_inset Flex Code
11503 \begin_layout Plain Layout
11510 \begin_inset Flex Code
11513 \begin_layout Plain Layout
11522 \begin_inset space \thinspace{}
11526 \begin_inset Flex Code
11529 \begin_layout Plain Layout
11535 ] Whether the class-default should be printing on one or both sides of the paper.
11536 Can be changed in the
11537 \begin_inset Flex Noun
11540 \begin_layout Plain Layout
11541 Document\SpecialChar menuseparator
11550 \begin_layout Description
11551 \begin_inset Flex Code
11554 \begin_layout Plain Layout
11561 \begin_inset Flex Code
11564 \begin_layout Plain Layout
11570 ] This sequence defines a paragraph style.
11571 If the style does not yet exist,
11574 its parameters are modified.
11576 \begin_inset Quotes eld
11580 \begin_inset Flex Code
11583 \begin_layout Plain Layout
11590 \begin_inset Quotes erd
11594 \begin_inset Newline newline
11598 \begin_inset CommandInset ref
11600 reference "subsec:Paragraph-Styles"
11605 for details on paragraph styles.
11608 \begin_layout Description
11609 \begin_inset Flex Code
11612 \begin_layout Plain Layout
11619 \begin_inset Flex Code
11622 \begin_layout Plain Layout
11628 ] defines the default table style that is used when inserting a table.
11629 The following styles are available:
11633 \begin_layout Itemize
11634 \begin_inset Flex Code
11637 \begin_layout Plain Layout
11638 Formal_with_Footline
11645 \begin_inset Quotes eld
11649 \begin_inset Quotes erd
11652 ) style with horizontal lines only,
11653 using a bold top and bottom line,
11654 the first and last row are additionally separated from the table body with a thin middle line.
11657 \begin_layout Itemize
11658 \begin_inset Flex Code
11661 \begin_layout Plain Layout
11662 Formal_without_Footline
11669 but the last row is not separated with a middle line from the body.
11672 \begin_layout Itemize
11673 \begin_inset Flex Code
11676 \begin_layout Plain Layout
11683 Simple table lines.
11686 \begin_layout Itemize
11687 \begin_inset Flex Code
11690 \begin_layout Plain Layout
11698 \begin_inset Flex Code
11701 \begin_layout Plain Layout
11708 but with the header row offset with a second horizontal line.
11709 This is also the default style of \SpecialChar LyX
11713 \begin_layout Itemize
11714 \begin_inset Flex Code
11717 \begin_layout Plain Layout
11724 Table without lines.
11728 \begin_layout Description
11729 \begin_inset Flex Code
11732 \begin_layout Plain Layout
11739 \begin_inset Flex Code
11742 \begin_layout Plain Layout
11748 ] The name of the command or environment to be used with
11749 \begin_inset Flex Code
11752 \begin_layout Plain Layout
11761 \begin_layout Description
11762 \begin_inset Flex Code
11765 \begin_layout Plain Layout
11772 \begin_inset Flex Code
11775 \begin_layout Plain Layout
11785 \begin_inset Flex Code
11788 \begin_layout Plain Layout
11794 ] Indicates what kind of markup is used to define the title of a document.
11796 \begin_inset Flex Code
11799 \begin_layout Plain Layout
11805 means that the macro with name
11806 \begin_inset Flex Code
11809 \begin_layout Plain Layout
11815 will be inserted after the last layout which has
11816 \begin_inset Quotes eld
11820 \begin_inset Flex Code
11823 \begin_layout Plain Layout
11825 \begin_inset space ~
11834 \begin_inset Quotes erd
11839 \begin_inset Flex Code
11842 \begin_layout Plain Layout
11848 corresponds to the case where all layouts which have
11849 \begin_inset Quotes eld
11853 \begin_inset Flex Code
11856 \begin_layout Plain Layout
11858 \begin_inset space ~
11867 \begin_inset Quotes erd
11870 should be enclosed into the
11871 \begin_inset Flex Code
11874 \begin_layout Plain Layout
11883 \begin_layout Description
11884 \begin_inset Flex Code
11887 \begin_layout Plain Layout
11894 \begin_inset Flex Code
11897 \begin_layout Plain Layout
11903 ] Sets which divisions are included in the table of contents.
11905 \begin_inset Flex Code
11908 \begin_layout Plain Layout
11914 counter in \SpecialChar LaTeX
11918 \begin_layout Subsection
11919 \begin_inset Flex Code
11922 \begin_layout Plain Layout
11929 \begin_inset CommandInset label
11931 name "subsec:ClassOptions"
11938 \begin_layout Standard
11940 \begin_inset Flex Code
11943 \begin_layout Plain Layout
11949 section can contain the following entries:
11952 \begin_layout Description
11953 \begin_inset Flex Code
11956 \begin_layout Plain Layout
11963 \begin_inset Flex Code
11966 \begin_layout Plain Layout
11972 ] The list of available font sizes for the document's main font,
11974 \begin_inset Quotes eld
11978 \begin_inset Flex Code
11981 \begin_layout Plain Layout
11988 \begin_inset Quotes erd
11992 Any number is possible.
11995 \begin_layout Description
11996 \begin_inset Flex Code
11999 \begin_layout Plain Layout
12006 \begin_inset Flex Code
12009 \begin_layout Plain Layout
12015 ] The format for the font size option.
12018 \begin_inset Flex Code
12021 \begin_layout Plain Layout
12029 \begin_inset Flex Code
12032 \begin_layout Plain Layout
12038 is a placeholder for the font size.
12041 \begin_layout Description
12042 \begin_inset Flex Code
12045 \begin_layout Plain Layout
12052 \begin_inset Flex Code
12055 \begin_layout Plain Layout
12056 string="letter|\SpecialChar allowbreak
12057 legal|\SpecialChar allowbreak
12058 executive|\SpecialChar allowbreak
12059 a0|\SpecialChar allowbreak
12060 a1|\SpecialChar allowbreak
12061 a2|\SpecialChar allowbreak
12062 a3|\SpecialChar allowbreak
12063 a4|\SpecialChar allowbreak
12064 a5|\SpecialChar allowbreak
12065 a6|\SpecialChar allowbreak
12066 b0|\SpecialChar allowbreak
12067 b1|\SpecialChar allowbreak
12068 b2|\SpecialChar allowbreak
12069 b3|\SpecialChar allowbreak
12070 b4|\SpecialChar allowbreak
12071 b5|\SpecialChar allowbreak
12072 b6|\SpecialChar allowbreak
12073 c0|\SpecialChar allowbreak
12074 c1|\SpecialChar allowbreak
12075 c2|\SpecialChar allowbreak
12076 c3|\SpecialChar allowbreak
12077 c4|\SpecialChar allowbreak
12078 c5|\SpecialChar allowbreak
12079 c6|\SpecialChar allowbreak
12080 b0j|\SpecialChar allowbreak
12081 b1j|\SpecialChar allowbreak
12082 b2j|\SpecialChar allowbreak
12083 b3j|\SpecialChar allowbreak
12084 b4j|\SpecialChar allowbreak
12085 b5j|\SpecialChar allowbreak
12091 ] The list of available page sizes,
12093 \begin_inset Quotes eld
12097 \begin_inset Flex Code
12100 \begin_layout Plain Layout
12107 \begin_inset Quotes erd
12112 only the listed sizes are supported.
12113 Other sizes might be entered as custom class option.
12116 \begin_layout Description
12117 \begin_inset Flex Code
12120 \begin_layout Plain Layout
12127 \begin_inset Flex Code
12130 \begin_layout Plain Layout
12136 ] The format for the page size option.
12139 \begin_inset Flex Code
12142 \begin_layout Plain Layout
12150 \begin_inset Flex Code
12153 \begin_layout Plain Layout
12159 is a placeholder for the paper size.
12162 \begin_layout Description
12163 \begin_inset Flex Code
12166 \begin_layout Plain Layout
12173 \begin_inset Flex Code
12176 \begin_layout Plain Layout
12177 string="empty|plain|headings|fancy"
12182 ] The list of available page sty\SpecialChar softhyphen
12185 \begin_inset Quotes eld
12189 \begin_inset Flex Code
12192 \begin_layout Plain Layout
12199 \begin_inset Quotes erd
12205 \begin_layout Description
12206 \begin_inset Flex Code
12209 \begin_layout Plain Layout
12216 \begin_inset Flex Code
12219 \begin_layout Plain Layout
12225 ] Some document class options,
12226 separated by a comma,
12227 that will be added to the optional part of the
12228 \begin_inset Flex Code
12231 \begin_layout Plain Layout
12242 \begin_layout Standard
12244 \begin_inset Flex Code
12247 \begin_layout Plain Layout
12253 section must end with
12254 \begin_inset Quotes eld
12258 \begin_inset Flex Code
12261 \begin_layout Plain Layout
12268 \begin_inset Quotes erd
12274 \begin_layout Subsection
12276 \begin_inset CommandInset label
12278 name "subsec:Paragraph-Styles"
12285 \begin_layout Standard
12286 A paragraph style description looks like this:
12290 \begin_layout Plain Layout
12291 Note that this will either define a new style or modify an existing one.
12299 \begin_layout LyX-Code
12306 \begin_layout LyX-Code
12310 \begin_layout LyX-Code
12314 \begin_layout Standard
12315 where the following commands are allowed:
12318 \begin_layout Description
12319 \begin_inset Flex Code
12322 \begin_layout Plain Layout
12329 \begin_inset Flex Code
12332 \begin_layout Plain Layout
12338 =""] This paragraph will appear in the table of contents of the given type.
12339 An empty string disables.
12340 See also the OutlinerName and the IsTocCaption commands.
12345 \begin_layout Description
12346 \begin_inset Flex Code
12349 \begin_layout Plain Layout
12356 \begin_inset Flex Code
12359 \begin_layout Plain Layout
12372 ] Paragraph alignment.
12375 \begin_layout Description
12376 \begin_inset Flex Code
12379 \begin_layout Plain Layout
12386 \begin_inset Flex Code
12389 \begin_layout Plain Layout
12402 ] A comma separated list of permitted alignments.
12403 (Some \SpecialChar LaTeX
12404 styles prohibit certain alignments,
12405 since those wouldn't make sense.
12406 For example a right-aligned or centered enumeration isn't possible.)
12409 \begin_layout Description
12410 \begin_inset Flex Code
12413 \begin_layout Plain Layout
12420 \begin_inset Flex Code
12423 \begin_layout Plain Layout
12429 ] Defines argument number <int> of a command\SpecialChar breakableslash
12430 environment associated with the current style.
12431 The definition must end with
12432 \begin_inset Flex Code
12435 \begin_layout Plain Layout
12443 \begin_inset CommandInset ref
12445 reference "subsec:Arguments"
12453 for more information.
12457 \begin_layout Description
12458 \begin_inset Flex Code
12461 \begin_layout Plain Layout
12467 Includes a comma-separated list of layouts that should be nested in and after the current layout.
12468 Only makes sense for nestable layouts (such as environments).
12470 \begin_inset Quotes eld
12474 \begin_inset Flex Code
12477 \begin_layout Plain Layout
12484 \begin_inset Quotes erd
12489 \begin_inset Flex Code
12492 \begin_layout Plain Layout
12501 \begin_layout Description
12502 \begin_inset Flex Code
12505 \begin_layout Plain Layout
12511 Note that this will completely override any prior
12512 \begin_inset Flex Code
12515 \begin_layout Plain Layout
12521 declaration for this style.
12523 \begin_inset Quotes eld
12527 \begin_inset Flex Code
12530 \begin_layout Plain Layout
12537 \begin_inset Quotes erd
12542 \begin_inset CommandInset ref
12544 reference "subsec:I18n"
12549 for details on its use.
12552 \begin_layout Description
12553 \begin_inset Flex Code
12556 \begin_layout Plain Layout
12563 \begin_inset Flex Code
12566 \begin_layout Plain Layout
12576 \begin_layout Plain Layout
12577 Note that a `float' here is a real number,
12584 The vertical space with which the last of a chain of paragraphs with this style is separated from the following paragraph.
12585 If the next paragraph has another style,
12586 the separations are not simply added,
12587 but the maximum is taken.
12590 \begin_layout Description
12591 \begin_inset Flex Code
12594 \begin_layout Plain Layout
12601 \begin_inset Flex Code
12604 \begin_layout Plain Layout
12610 ] The category for this style.
12611 This is used to group related styles in the style combobox on the toolbar.
12612 Any string can be used,
12613 but you may want to use existing categories with your own styles.
12617 \begin_layout Description
12618 \begin_inset Flex Code
12621 \begin_layout Plain Layout
12628 \begin_inset Flex Code
12631 \begin_layout Plain Layout
12637 ] Copies all the features of an existing style into the current one.
12638 Note that this copies the style as it is defined at that point.
12639 Later changes to it will not affect styles into which it has been copied.
12642 \begin_layout Description
12643 \begin_inset Flex Code
12646 \begin_layout Plain Layout
12647 DocBookGenerateTitle
12653 \begin_inset Flex Code
12656 \begin_layout Plain Layout
12663 \begin_inset Flex Code
12666 \begin_layout Plain Layout
12672 tag after the wrapper tag.
12673 This parameter should only be used with
12674 \begin_inset Flex Code
12677 \begin_layout Plain Layout
12684 otherwise the title will be output
12688 the contents of the environment.
12689 The generated title is the same as the LyXHTML label:
12690 a combination of the environment type and its number.
12691 A major use is when DocBook has no close mapping for LaTeX environments and users must fallback to using a generic container such as
12692 \begin_inset Flex Code
12695 \begin_layout Plain Layout
12702 which requires a title although there is none in LaTeX.
12703 This feature is heavily used for theorem-like environments.
12706 \begin_layout Description
12707 \begin_inset Flex Code
12710 \begin_layout Plain Layout
12717 \begin_inset Flex Code
12720 \begin_layout Plain Layout
12726 ] The name of a style whose preamble should be output
12731 This allows to ensure some ordering of the preamble snippets when macros definitions depend on one another.
12735 \begin_layout Plain Layout
12737 besides that functionality,
12738 there is no way to ensure any ordering of preambles.
12739 The ordering that you see in a given version of \SpecialChar LyX
12740 may change without warning in later versions.
12748 \begin_layout Description
12749 \begin_inset Flex Code
12752 \begin_layout Plain Layout
12759 \begin_inset Flex Code
12762 \begin_layout Plain Layout
12775 ] The type of label that stands at the end of the paragraph (or sequence of paragraphs if
12776 \begin_inset Flex Code
12779 \begin_layout Plain Layout
12786 \begin_inset Newline newline
12790 \begin_inset Flex Code
12793 \begin_layout Plain Layout
12801 \begin_inset Flex Code
12804 \begin_layout Plain Layout
12811 \begin_inset Flex Code
12814 \begin_layout Plain Layout
12822 \begin_inset Flex Code
12825 \begin_layout Plain Layout
12832 \begin_inset Quotes eld
12836 \begin_inset Quotes erd
12841 \begin_inset Flex Code
12844 \begin_layout Plain Layout
12851 \begin_inset space \space{}
12855 \begin_inset Flex Code
12858 \begin_layout Plain Layout
12864 ) is a white (resp.
12865 \begin_inset space ~
12868 black) square suitable for end of proof markers,
12870 \begin_inset Flex Code
12873 \begin_layout Plain Layout
12879 is an explicit text string.
12882 \begin_layout Description
12883 \begin_inset Flex Code
12886 \begin_layout Plain Layout
12893 \begin_inset Flex Code
12896 \begin_layout Plain Layout
12902 ] The string used for a label with a
12903 \begin_inset Flex Code
12906 \begin_layout Plain Layout
12913 \begin_inset Newline newline
12917 \begin_inset Flex Code
12920 \begin_layout Plain Layout
12930 \begin_layout Description
12931 \begin_inset Flex Code
12934 \begin_layout Plain Layout
12940 The font used for both the text body
12946 \begin_inset CommandInset ref
12948 reference "subsec:Font-description"
12954 Note that defining this font automatically defines the
12955 \begin_inset Flex Code
12958 \begin_layout Plain Layout
12965 So you should define this one first if you also want to define
12966 \begin_inset Flex Code
12969 \begin_layout Plain Layout
12978 \begin_layout Description
12979 \begin_inset Flex Code
12982 \begin_layout Plain Layout
12989 \begin_inset Flex Code
12992 \begin_layout Plain Layout
12998 ] Used for backporting new styles to stable \SpecialChar LyX
13000 The first stable version that supports this tag is \SpecialChar LyX
13002 The argument is a number which may either be 0,
13003 -1 or any value greater than zero.
13005 \begin_inset Flex Code
13008 \begin_layout Plain Layout
13014 flag of a style is greater than zero,
13015 it will always be written to the document header.
13016 If a .lyx file is read,
13017 the style definitions from the document header are added to the document class.
13018 Therefore even older \SpecialChar LyX
13019 versions can handle the style.
13021 \begin_inset Flex Code
13024 \begin_layout Plain Layout
13030 is a version number:
13031 if the style is read,
13032 and the version number is less than the version number of the already existing style in the document class,
13033 the new style is ignored.
13034 If the version number is greater,
13035 the new style replaces the existing style.
13036 A value of -1 means an infinite version number,
13038 \begin_inset space \thinspace{}
13042 \begin_inset space \space{}
13045 the style is always used.
13048 \begin_layout Description
13049 \begin_inset Flex Code
13052 \begin_layout Plain Layout
13059 \begin_inset Flex Code
13062 \begin_layout Plain Layout
13071 \begin_inset space \thinspace{}
13075 \begin_inset Flex Code
13078 \begin_layout Plain Layout
13084 ] Usually \SpecialChar LyX
13085 does not allow you to insert more than one space between words,
13086 since a space is considered as the separation between two words,
13087 not a character or symbol of its own.
13088 This is a very fine thing but sometimes annoying,
13090 when typing program code or plain \SpecialChar LaTeX
13094 \begin_inset Flex Code
13097 \begin_layout Plain Layout
13105 will create non-breaking spaces for the additional blanks when
13106 \begin_inset Flex Code
13109 \begin_layout Plain Layout
13117 \begin_inset Flex Code
13120 \begin_layout Plain Layout
13127 \begin_inset Flex Code
13130 \begin_layout Plain Layout
13139 \begin_layout Description
13140 \begin_inset Flex Code
13143 \begin_layout Plain Layout
13149 These tags are used with XHTML output.
13151 \begin_inset CommandInset ref
13153 reference "subsec:Paragraph-Style-XHTML"
13161 \begin_layout Description
13162 \begin_inset Flex Code
13165 \begin_layout Plain Layout
13172 \begin_inset Flex Code
13175 \begin_layout Plain Layout
13184 \begin_inset space \thinspace{}
13188 \begin_inset Flex Code
13191 \begin_layout Plain Layout
13198 \begin_inset Flex Code
13201 \begin_layout Plain Layout
13208 marks the style as to be included in the document preamble and not in the document body.
13209 This is useful for document classes that want such information as the title and author to appear in the preamble.
13210 Note that this works only for styles for which the
13211 \begin_inset Flex Code
13214 \begin_layout Plain Layout
13221 \begin_inset Flex Code
13224 \begin_layout Plain Layout
13231 \begin_inset Flex Code
13234 \begin_layout Plain Layout
13243 \begin_layout Description
13244 \begin_inset Flex Code
13247 \begin_layout Plain Layout
13254 \begin_inset Flex Code
13257 \begin_layout Plain Layout
13266 \begin_inset space \thinspace{}
13270 \begin_inset Flex Code
13273 \begin_layout Plain Layout
13280 \begin_inset Flex Code
13283 \begin_layout Plain Layout
13290 marks the style as being part of a title block (see also the
13291 \begin_inset Flex Code
13294 \begin_layout Plain Layout
13301 \begin_inset Flex Code
13304 \begin_layout Plain Layout
13313 \begin_layout Description
13314 \begin_inset Flex Code
13317 \begin_layout Plain Layout
13323 Includes a comma-separated list of layouts after which this one should be nested.
13324 Only makes sense with regard to nestable layouts (such as environments).
13326 \begin_inset Quotes eld
13330 \begin_inset Flex Code
13333 \begin_layout Plain Layout
13340 \begin_inset Quotes erd
13345 \begin_inset Flex Code
13348 \begin_layout Plain Layout
13357 \begin_layout Description
13358 \begin_inset Flex Code
13361 \begin_layout Plain Layout
13368 \begin_inset Flex Code
13371 \begin_layout Plain Layout
13380 \begin_inset space \thinspace{}
13384 \begin_inset Flex Code
13387 \begin_layout Plain Layout
13393 ] If this is set to 1 and AddToToc is enabled,
13394 the paragraph adds a summary of its contents in its item in the table of contents.
13401 \begin_layout Description
13402 \begin_inset Flex Code
13405 \begin_layout Plain Layout
13412 \begin_inset Flex Code
13415 \begin_layout Plain Layout
13421 ] The \SpecialChar LaTeX
13422 command sequence declaring an item in a list.
13423 The command is to be defined without the preceding backslash (the default is
13424 \begin_inset Quotes eld
13428 \begin_inset Quotes erd
13433 \begin_inset Flex Code
13436 \begin_layout Plain Layout
13444 in the \SpecialChar LaTeX
13448 \begin_layout Description
13449 \begin_inset Flex Code
13452 \begin_layout Plain Layout
13459 \begin_inset Flex Code
13462 \begin_layout Plain Layout
13468 ] This provides extra space between paragraphs that have the same style.
13469 If you put other styles into an environment,
13470 each is separated with the environment's
13471 \begin_inset Flex Code
13474 \begin_layout Plain Layout
13481 But the whole items of the environment are additionally separated with this
13482 \begin_inset Flex Code
13485 \begin_layout Plain Layout
13492 Note that this is a
13497 \begin_layout Description
13498 \begin_inset Flex Code
13501 \begin_layout Plain Layout
13508 \begin_inset Flex Code
13511 \begin_layout Plain Layout
13520 \begin_inset space \thinspace{}
13524 \begin_inset Flex Code
13527 \begin_layout Plain Layout
13533 ] Usually \SpecialChar LyX
13534 does not allow you to leave a paragraph empty,
13535 since it would lead to empty \SpecialChar LaTeX
13537 There are some cases where this could be desirable however:
13538 in a letter template,
13539 the required fields can be provided as empty fields,
13540 so that people do not forget them;
13541 in some special classes,
13542 a style can be used as some kind of break,
13543 which does not contain actual text.
13546 \begin_layout Description
13547 \begin_inset Flex Code
13550 \begin_layout Plain Layout
13557 \begin_inset Flex Code
13560 \begin_layout Plain Layout
13566 ] The vertical space between the label and the text body.
13567 Only used for labels that are above the text body (
13568 \begin_inset Flex Code
13571 \begin_layout Plain Layout
13578 \begin_inset Newline newline
13582 \begin_inset Flex Code
13585 \begin_layout Plain Layout
13586 Centered_Top_Environment
13594 \begin_layout Description
13595 \begin_inset Flex Code
13598 \begin_layout Plain Layout
13605 \begin_inset Flex Code
13608 \begin_layout Plain Layout
13614 ] The name of the counter for automatic numbering.
13615 In order to have the counter appear with your label,
13616 you will need to reference it in the
13617 \begin_inset Flex Code
13620 \begin_layout Plain Layout
13629 This will work with
13630 \begin_inset Flex Code
13633 \begin_layout Plain Layout
13641 \begin_inset Flex Code
13644 \begin_layout Plain Layout
13652 \begin_inset Flex Code
13655 \begin_layout Plain Layout
13662 \begin_inset Flex Code
13665 \begin_layout Plain Layout
13673 \begin_inset Newline newline
13681 \begin_inset Flex Code
13684 \begin_layout Plain Layout
13691 \begin_inset Flex Code
13694 \begin_layout Plain Layout
13701 though this case is a bit complicated.
13702 Suppose you declare
13703 \begin_inset Quotes eld
13707 \begin_inset Flex Code
13710 \begin_layout Plain Layout
13711 LabelCounter myenum
13717 \begin_inset Quotes erd
13721 Then the actual counters used are
13722 \begin_inset Flex Code
13725 \begin_layout Plain Layout
13733 \begin_inset Flex Code
13736 \begin_layout Plain Layout
13744 \begin_inset Flex Code
13747 \begin_layout Plain Layout
13754 \begin_inset Flex Code
13757 \begin_layout Plain Layout
13764 much as in \SpecialChar LaTeX
13766 These counters must all be declared separately.
13767 \begin_inset Newline newline
13771 \begin_inset CommandInset ref
13773 reference "subsec:Counters"
13778 for details on counters.
13781 \begin_layout Description
13782 \begin_inset Flex Code
13785 \begin_layout Plain Layout
13791 The font used for the label.
13793 \begin_inset CommandInset ref
13795 reference "subsec:Font-description"
13803 \begin_layout Description
13804 \begin_inset Flex Code
13807 \begin_layout Plain Layout
13814 \begin_inset Flex Code
13817 \begin_layout Plain Layout
13823 ] Text that indicates how far a label should be indented.
13826 \begin_layout Description
13827 \begin_inset Flex Code
13830 \begin_layout Plain Layout
13837 \begin_inset Flex Code
13840 \begin_layout Plain Layout
13846 ] Text that indicates the amount of horizontal space between the label and the text body.
13847 Only used for labels that are not above the text body.
13850 \begin_layout Description
13851 \begin_inset Flex Code
13854 \begin_layout Plain Layout
13861 \begin_inset Flex Code
13864 \begin_layout Plain Layout
13870 ] The string used for the label.
13872 \begin_inset Flex Code
13875 \begin_layout Plain Layout
13882 this string can be contain the special formatting commands described in
13883 \begin_inset CommandInset ref
13885 reference "subsec:Counters"
13893 \begin_layout Description
13894 \begin_inset Flex Code
13897 \begin_layout Plain Layout
13898 LabelStringAppendix
13904 \begin_inset Flex Code
13907 \begin_layout Plain Layout
13913 ] This is used inside the appendix instead of
13914 \begin_inset Newline newline
13918 \begin_inset Flex Code
13921 \begin_layout Plain Layout
13929 \begin_inset Flex Code
13932 \begin_layout Plain Layout
13939 \begin_inset Newline newline
13943 \begin_inset Flex Code
13946 \begin_layout Plain Layout
13947 LabelStringAppendix
13955 \begin_layout Description
13956 \begin_inset Flex Code
13959 \begin_layout Plain Layout
13966 \begin_inset Flex Code
13969 \begin_layout Plain Layout
13979 \begin_inset Newline newline
13985 \begin_inset Newline newline
13998 \begin_layout Description
13999 \begin_inset Flex Code
14002 \begin_layout Plain Layout
14008 means the label is the very first word (up to the first real blank).
14009 Use non-breaking spaces if you want more than one word as the label.
14013 \begin_layout Description
14014 \begin_inset Flex Code
14017 \begin_layout Plain Layout
14023 means the label is simply what is declared as
14024 \begin_inset Flex Code
14027 \begin_layout Plain Layout
14034 This will be displayed
14035 \begin_inset Quotes eld
14039 \begin_inset Quotes erd
14043 at the beginning of the paragraph.
14045 \begin_inset Flex Code
14048 \begin_layout Plain Layout
14055 \begin_inset Flex Code
14058 \begin_layout Plain Layout
14065 then it will be displayed only in the first paragraph of any sequence of paragraphs with the same
14066 \begin_inset Flex Code
14069 \begin_layout Plain Layout
14078 \begin_layout Description
14079 \begin_inset Flex Code
14082 \begin_layout Plain Layout
14089 \begin_inset space ~
14093 \begin_inset space ~
14097 \begin_inset Flex Code
14100 \begin_layout Plain Layout
14106 are special cases of
14107 \begin_inset Flex Code
14110 \begin_layout Plain Layout
14117 The label will be printed above the paragraph either at the beginning of the line or centered.
14120 \begin_layout Description
14121 \begin_inset Flex Code
14124 \begin_layout Plain Layout
14130 is a special case for the caption-labels
14131 \begin_inset Quotes eld
14135 \begin_inset Quotes erd
14139 \begin_inset Quotes eld
14143 \begin_inset Quotes erd
14147 \begin_inset Newline newline
14151 \begin_inset Flex Code
14154 \begin_layout Plain Layout
14160 means the (hardcoded) label string depends on the kind of float:
14161 It is hardcoded to be `FloatType N',
14162 where N is the value of the counter associated with the float.
14163 For the case that a caption is inserted outside of a float the
14164 \begin_inset Flex Code
14167 \begin_layout Plain Layout
14174 \begin_inset Quotes eld
14178 \begin_inset Quotes erd
14184 \begin_layout Description
14185 \begin_inset Flex Code
14188 \begin_layout Plain Layout
14194 produces the usual sort of enumeration labels.
14195 The number type needs to be set in the
14201 \begin_inset CommandInset ref
14203 reference "subsec:Counters"
14211 \begin_layout Description
14212 \begin_inset Flex Code
14215 \begin_layout Plain Layout
14221 produces various bullets at the different levels.
14222 The bullet types displayed can be set via
14223 \begin_inset Flex Noun
14226 \begin_layout Plain Layout
14227 Document\SpecialChar menuseparator
14228 Settings\SpecialChar menuseparator
14237 \begin_layout Description
14238 \begin_inset Flex Code
14241 \begin_layout Plain Layout
14247 should be used only with
14248 \begin_inset Flex Code
14251 \begin_layout Plain Layout
14252 LatexType BibEnvironment
14261 \begin_layout Description
14262 \begin_inset Flex Code
14265 \begin_layout Plain Layout
14271 Note that this will completely override any prior
14272 \begin_inset Flex Code
14275 \begin_layout Plain Layout
14281 declaration for this style.
14283 \begin_inset Quotes eld
14287 \begin_inset Flex Code
14290 \begin_layout Plain Layout
14297 \begin_inset Quotes erd
14302 \begin_inset CommandInset ref
14304 reference "subsec:I18n"
14309 for details on its use.
14312 \begin_layout Description
14313 \begin_inset Flex Code
14316 \begin_layout Plain Layout
14323 \begin_inset Flex Code
14326 \begin_layout Plain Layout
14332 ] The name of the corresponding \SpecialChar LaTeX
14334 Either the environment or command name.
14337 \begin_layout Description
14338 \begin_inset Flex Code
14341 \begin_layout Plain Layout
14348 \begin_inset Flex Code
14351 \begin_layout Plain Layout
14357 ] An optional parameter for the corresponding
14358 \begin_inset Flex Code
14361 \begin_layout Plain Layout
14368 This parameter cannot be changed from within \SpecialChar LyX
14370 \begin_inset Flex Code
14373 \begin_layout Plain Layout
14379 for customizable parameters).
14380 This will be output as is after all \SpecialChar LaTeX
14382 \begin_inset Flex Code
14385 \begin_layout Plain Layout
14394 \begin_layout Description
14395 \begin_inset Flex Code
14398 \begin_layout Plain Layout
14405 \begin_inset Flex Code
14408 \begin_layout Plain Layout
14417 \begin_inset Newline newline
14426 ] How the style should be translated into \SpecialChar LaTeX
14431 \begin_layout Plain Layout
14432 \begin_inset Flex Code
14435 \begin_layout Plain Layout
14441 is perhaps a bit misleading,
14442 since these rules apply to SGML classes,
14444 Visit the SGML class files for specific examples.
14453 \begin_layout Description
14454 \begin_inset Flex Code
14457 \begin_layout Plain Layout
14463 means nothing special.
14466 \begin_layout Description
14467 \begin_inset Flex Code
14470 \begin_layout Plain Layout
14477 \begin_inset Flex Code
14480 \begin_layout Plain Layout
14487 {\SpecialChar ldots
14496 \begin_layout Description
14497 \begin_inset Flex Code
14500 \begin_layout Plain Layout
14507 \begin_inset Flex Code
14510 \begin_layout Plain Layout
14517 }\SpecialChar ldots
14533 \begin_layout Description
14534 \begin_inset Flex Code
14537 \begin_layout Plain Layout
14544 \begin_inset Flex Code
14547 \begin_layout Plain Layout
14555 \begin_inset Flex Code
14558 \begin_layout Plain Layout
14566 is generated for each paragraph of this environment.
14570 \begin_layout Description
14571 \begin_inset Flex Code
14574 \begin_layout Plain Layout
14581 \begin_inset Flex Code
14584 \begin_layout Plain Layout
14592 \begin_inset Newline newline
14596 \begin_inset Flex Code
14599 \begin_layout Plain Layout
14605 is passed as an argument to the environment.
14606 \begin_inset Newline newline
14610 \begin_inset Flex Code
14613 \begin_layout Plain Layout
14619 can be defined in the
14620 \begin_inset Flex Noun
14623 \begin_layout Plain Layout
14624 Edit\SpecialChar menuseparator
14626 \begin_inset space ~
14637 \begin_layout Description
14638 \begin_inset Flex Code
14641 \begin_layout Plain Layout
14648 \begin_inset Flex Code
14651 \begin_layout Plain Layout
14657 but adds the necessary mandatory argument (the longest label) to the begin statement of the bibliography environment:
14658 \begin_inset Newline newline
14662 \begin_inset Flex Code
14665 \begin_layout Plain Layout
14668 begin{thebibliography}{99}
14674 It is therefore only useful for bibliography environments.
14675 The default longest label
14676 \begin_inset Quotes eld
14680 \begin_inset Quotes erd
14683 can be changed by the user in the paragraph settings of a bibliography item.
14686 \begin_layout Standard
14687 Putting the last few things together,
14688 the \SpecialChar LaTeX
14689 output will be either:
14693 \begin_layout LyX-Code
14696 LatexName[LatexParam]{\SpecialChar ldots
14700 \begin_layout Standard
14705 \begin_layout LyX-Code
14708 begin{LatexName}[LatexParam] \SpecialChar ldots
14714 \begin_layout Standard
14715 depending upon the \SpecialChar LaTeX
14720 \begin_layout Description
14721 \begin_inset Flex Code
14724 \begin_layout Plain Layout
14731 \begin_inset Flex Code
14734 \begin_layout Plain Layout
14740 ] A string that is put at the beginning of the style content.
14741 A line break in the output can be indicated by
14742 \begin_inset Flex Code
14745 \begin_layout Plain Layout
14754 \begin_layout Description
14755 \begin_inset Flex Code
14758 \begin_layout Plain Layout
14765 \begin_inset Flex Code
14768 \begin_layout Plain Layout
14774 ] If you put styles into environments,
14776 \begin_inset Flex Code
14779 \begin_layout Plain Layout
14785 are not simply added,
14786 but added with a factor
14787 \begin_inset Formula $\frac{4}{\mathrm{depth}+4}$
14791 Note that this parameter is also used when
14792 \begin_inset Flex Code
14795 \begin_layout Plain Layout
14802 \begin_inset Flex Code
14805 \begin_layout Plain Layout
14812 \begin_inset Flex Code
14815 \begin_layout Plain Layout
14822 Then it is added to the manual or dynamic margin.
14823 \begin_inset Newline newline
14827 \begin_inset Quotes eld
14831 \begin_inset Flex Code
14834 \begin_layout Plain Layout
14841 \begin_inset Quotes erd
14844 means that the paragraph is indented with the width of
14845 \begin_inset Quotes eld
14849 \begin_inset Flex Code
14852 \begin_layout Plain Layout
14859 \begin_inset Quotes erd
14862 in the normal font.
14863 You can get a negative width by prefixing the string with
14864 \begin_inset Quotes eld
14868 \begin_inset Flex Code
14871 \begin_layout Plain Layout
14878 \begin_inset Quotes erd
14882 This way was chosen so that the look is the same with each used screen font.
14885 \begin_layout Description
14886 \begin_inset Flex Code
14889 \begin_layout Plain Layout
14896 \begin_inset Flex Code
14899 \begin_layout Plain Layout
14914 \begin_inset Newline newline
14917 The kind of margin that the style has on the left side.
14921 \begin_layout Description
14922 \begin_inset Flex Code
14925 \begin_layout Plain Layout
14931 just means a fixed margin.
14934 \begin_layout Description
14935 \begin_inset Flex Code
14938 \begin_layout Plain Layout
14944 means that the left margin depends on the string entered in the
14945 \begin_inset Flex Noun
14948 \begin_layout Plain Layout
14949 Edit\SpecialChar menuseparator
14951 \begin_inset space ~
14960 This is used to typeset nice lists without tabulators.
14963 \begin_layout Description
14964 \begin_inset Flex Code
14967 \begin_layout Plain Layout
14973 means that the margin depends on the size of the label.
14974 This is used for automatic enumerated headlines.
14975 It is obvious that the headline
14976 \begin_inset Quotes eld
14979 5.4.3.2.1 Very long headline
14980 \begin_inset Quotes erd
14983 must have a wider left margin (as wide as
14984 \begin_inset Quotes eld
14988 \begin_inset Quotes erd
14991 plus the space) than
14992 \begin_inset Quotes eld
14995 3.2 Very long headline
14996 \begin_inset Quotes erd
15001 \begin_inset Quotes eld
15005 \begin_inset Quotes erd
15008 are not able to do this.
15011 \begin_layout Description
15012 \begin_inset Flex Code
15015 \begin_layout Plain Layout
15022 but only the very first row of the paragraph is dynamic,
15023 while the others are static;
15029 \begin_layout Description
15030 \begin_inset Flex Code
15033 \begin_layout Plain Layout
15039 means the margin is chosen in a way that the longest row of this paragraph fits to the right margin.
15040 This is used to typeset an address on the right edge of the page.
15044 \begin_layout Description
15045 \begin_inset Flex Code
15048 \begin_layout Plain Layout
15055 \begin_inset Flex Code
15058 \begin_layout Plain Layout
15067 \begin_inset space \thinspace{}
15071 \begin_inset Flex Code
15074 \begin_layout Plain Layout
15080 ] Whether fragile commands in this style should be
15081 \begin_inset Flex Code
15084 \begin_layout Plain Layout
15098 whether this command should itself be protected.)
15101 \begin_layout Description
15102 \begin_inset Flex Code
15105 \begin_layout Plain Layout
15112 \begin_inset Flex Code
15115 \begin_layout Plain Layout
15124 \begin_inset space \thinspace{}
15128 \begin_inset Flex Code
15131 \begin_layout Plain Layout
15137 ] This causes macros that contain this layout to be protected with
15138 \begin_inset Flex Code
15141 \begin_layout Plain Layout
15154 ) if necessary and thus allows (some) verbatim stuff in macros.
15157 \begin_layout Description
15158 \begin_inset Flex Code
15161 \begin_layout Plain Layout
15168 \begin_inset Flex Code
15171 \begin_layout Plain Layout
15180 \begin_inset space \thinspace{}
15184 \begin_inset Flex Code
15187 \begin_layout Plain Layout
15193 ] Whether specific commands in this style (such as
15194 \begin_inset Flex Code
15197 \begin_layout Plain Layout
15206 \begin_inset Flex Code
15209 \begin_layout Plain Layout
15217 ) should be protected in an
15218 \begin_inset Flex Code
15221 \begin_layout Plain Layout
15230 This is particularly needed for styles that draw on
15238 commands which parse their content in complex ways.
15241 \begin_layout Description
15242 \begin_inset Flex Code
15245 \begin_layout Plain Layout
15252 \begin_inset Flex Code
15255 \begin_layout Plain Layout
15262 \begin_inset space \thinspace{}
15266 \begin_inset Flex Code
15269 \begin_layout Plain Layout
15277 ] Whether newlines are translated into \SpecialChar LaTeX
15279 \begin_inset Flex Code
15282 \begin_layout Plain Layout
15293 The translation can be switched off to allow more comfortable \SpecialChar LaTeX
15294 editing inside \SpecialChar LyX
15298 \begin_layout Description
15299 \begin_inset Flex Code
15302 \begin_layout Plain Layout
15309 \begin_inset Flex Code
15312 \begin_layout Plain Layout
15321 \begin_inset space \thinspace{}
15325 \begin_inset Flex Code
15328 \begin_layout Plain Layout
15336 \begin_inset Flex Code
15339 \begin_layout Plain Layout
15346 \begin_inset Flex Code
15349 \begin_layout Plain Layout
15355 ) paragraphs are being indented,
15356 then the indentation of such a paragraph following one of this type will be suppressed.
15357 (So this will not affect the display of non-default paragraphs.)
15360 \begin_layout Description
15361 \begin_inset Flex Code
15364 \begin_layout Plain Layout
15371 \begin_inset Flex Code
15374 \begin_layout Plain Layout
15380 ] Name of a style that has replaced this style.
15381 This is used to rename a style,
15382 while keeping backward compatibility.
15385 \begin_layout Description
15386 \begin_inset Flex Code
15389 \begin_layout Plain Layout
15396 \begin_inset Flex Code
15399 \begin_layout Plain Layout
15406 \begin_inset space \thinspace{}
15410 \begin_inset Flex Code
15413 \begin_layout Plain Layout
15419 ] Determines whether consecutive paragraphs of the same type are treated as belonging together.
15420 This has the effect that the
15421 \begin_inset Flex Code
15424 \begin_layout Plain Layout
15430 is only printed once before such a group.
15433 \begin_inset Flex Code
15436 \begin_layout Plain Layout
15443 \begin_inset Flex Code
15446 \begin_layout Plain Layout
15453 \begin_inset Flex Code
15456 \begin_layout Plain Layout
15462 and false for all other types.
15465 \begin_layout Description
15466 \begin_inset Flex Code
15469 \begin_layout Plain Layout
15476 \begin_inset Flex Code
15479 \begin_layout Plain Layout
15488 \begin_inset space \thinspace{}
15492 \begin_inset Flex Code
15495 \begin_layout Plain Layout
15501 ] Indicates that paragraphs will not be separated by an empty line in \SpecialChar LaTeX
15503 but only by a line break;
15505 \begin_inset Flex Code
15508 \begin_layout Plain Layout
15515 this allows to emulate a plain text editor (like the ERT inset).
15518 \begin_layout Description
15519 \begin_inset Flex Code
15522 \begin_layout Plain Layout
15529 \begin_inset Flex Code
15532 \begin_layout Plain Layout
15538 ] The indent of the very first line of a paragraph.
15540 \begin_inset Newline newline
15544 \begin_inset Flex Code
15547 \begin_layout Plain Layout
15553 will be fixed for a certain style.
15554 The exception is the default style,
15555 since the indentation for these paragraphs can be prohibited with
15556 \begin_inset Flex Code
15559 \begin_layout Plain Layout
15568 \begin_inset Flex Code
15571 \begin_layout Plain Layout
15577 style paragraphs inside environments use the
15578 \begin_inset Flex Code
15581 \begin_layout Plain Layout
15587 of the environment,
15588 not their native one.
15591 \begin_inset Flex Code
15594 \begin_layout Plain Layout
15600 paragraphs inside an enumeration are not indented.
15603 \begin_layout Description
15604 \begin_inset Flex Code
15607 \begin_layout Plain Layout
15614 \begin_inset Flex Code
15617 \begin_layout Plain Layout
15623 ] The vertical space between two paragraphs of this style.
15626 \begin_layout Description
15627 \begin_inset Flex Code
15630 \begin_layout Plain Layout
15637 \begin_inset Flex Code
15640 \begin_layout Plain Layout
15647 allows the user to choose either
15648 \begin_inset Quotes eld
15652 \begin_inset Quotes erd
15656 \begin_inset Quotes eld
15660 \begin_inset Quotes erd
15663 to separate paragraphs.
15665 \begin_inset Quotes eld
15669 \begin_inset Quotes erd
15674 \begin_inset Flex Code
15677 \begin_layout Plain Layout
15685 \begin_inset Quotes eld
15689 \begin_inset Quotes erd
15694 \begin_inset Flex Code
15697 \begin_layout Plain Layout
15703 is ignored and all paragraphs are separated by the
15704 \begin_inset Flex Code
15707 \begin_layout Plain Layout
15714 The vertical space is calculated with
15715 \begin_inset Flex Code
15718 \begin_layout Plain Layout
15720 \begin_inset space ~
15729 \begin_inset Flex Code
15732 \begin_layout Plain Layout
15738 is the height of a row with the normal font.
15740 the look stays the same with different screen fonts.
15743 \begin_layout Description
15744 \begin_inset Flex Code
15747 \begin_layout Plain Layout
15754 \begin_inset Flex Code
15757 \begin_layout Plain Layout
15766 \begin_inset space \thinspace{}
15770 \begin_inset Flex Code
15773 \begin_layout Plain Layout
15779 ] Whether the contents of this paragraph should be output in raw form,
15780 meaning without special translations that \SpecialChar LaTeX
15784 \begin_layout Description
15785 \begin_inset Flex Code
15788 \begin_layout Plain Layout
15795 \begin_inset Flex Code
15798 \begin_layout Plain Layout
15808 Defines individual characters that should be output in raw form,
15809 meaning without special translations that \SpecialChar LaTeX
15813 \begin_layout Description
15814 \begin_inset Flex Code
15817 \begin_layout Plain Layout
15823 Information to be included in the \SpecialChar LaTeX
15824 preamble when this style is used.
15825 Used to define macros,
15828 required by this particular style.
15830 \begin_inset Quotes eld
15834 \begin_inset Flex Code
15837 \begin_layout Plain Layout
15844 \begin_inset Quotes erd
15850 \begin_layout Description
15851 \begin_inset Flex Code
15854 \begin_layout Plain Layout
15861 \begin_inset Flex Code
15864 \begin_layout Plain Layout
15870 ] The prefix to use when creating labels referring to paragraphs of this type.
15871 This allows the use of formatted references.
15874 \begin_layout Description
15875 \begin_inset Flex Code
15878 \begin_layout Plain Layout
15885 \begin_inset Flex Code
15888 \begin_layout Plain Layout
15894 ] Whether the style requires the feature
15895 \begin_inset Flex Code
15898 \begin_layout Plain Layout
15905 \begin_inset CommandInset ref
15907 reference "chap:List-of-functions"
15912 for the list of features).
15913 If you require a package with specific options,
15914 you can additionally use
15915 \begin_inset Flex Code
15918 \begin_layout Plain Layout
15924 as a general text class parameter (see
15925 \begin_inset CommandInset ref
15927 reference "subsec:General-text-class"
15935 \begin_layout Description
15936 \begin_inset Flex Code
15939 \begin_layout Plain Layout
15946 \begin_inset Flex Code
15949 \begin_layout Plain Layout
15958 \begin_inset Flex Code
15961 \begin_layout Plain Layout
15967 ] Resets the \SpecialChar LaTeX
15968 arguments of this style (as defined via the
15969 \begin_inset Flex Code
15972 \begin_layout Plain Layout
15979 This is useful if you have copied a style via
15980 \begin_inset Flex Code
15983 \begin_layout Plain Layout
15990 but you do not want to inherit its (required and optional) arguments.
15993 \begin_layout Description
15994 \begin_inset Flex Code
15997 \begin_layout Plain Layout
16004 \begin_inset Flex Code
16007 \begin_layout Plain Layout
16016 \begin_inset Flex Code
16019 \begin_layout Plain Layout
16025 ] Resumes a counter that is usually reset at each new sequence of layouts.
16026 This is currently only useful when
16027 \begin_inset Flex Code
16030 \begin_layout Plain Layout
16037 \begin_inset Flex Code
16040 \begin_layout Plain Layout
16049 \begin_layout Description
16050 \begin_inset Flex Code
16053 \begin_layout Plain Layout
16060 \begin_inset Flex Code
16063 \begin_layout Plain Layout
16069 ] A string that is put at the end of the layout content.
16070 A line break in the output can be indicated by
16071 \begin_inset Flex Code
16074 \begin_layout Plain Layout
16083 \begin_layout Description
16084 \begin_inset Flex Code
16087 \begin_layout Plain Layout
16094 \begin_inset Flex Code
16097 \begin_layout Plain Layout
16104 \begin_inset Flex Code
16107 \begin_layout Plain Layout
16116 \begin_layout Description
16117 \begin_inset Flex Code
16120 \begin_layout Plain Layout
16127 \begin_inset Flex Code
16130 \begin_layout Plain Layout
16140 \begin_inset Flex Code
16143 \begin_layout Plain Layout
16151 \begin_inset Flex Code
16154 \begin_layout Plain Layout
16162 \begin_inset Flex Code
16165 \begin_layout Plain Layout
16167 \begin_inset space ~
16175 ] This defines what the default spacing should be in the style.
16177 \begin_inset Flex Code
16180 \begin_layout Plain Layout
16188 \begin_inset Flex Code
16191 \begin_layout Plain Layout
16198 \begin_inset Flex Code
16201 \begin_layout Plain Layout
16207 correspond respectively to a multiplier value of 1,
16209 If you specify the argument
16210 \begin_inset Flex Code
16213 \begin_layout Plain Layout
16220 then you must also provide a value argument which will be the actual multiplier value.
16222 contrary to other parameters,
16224 \begin_inset Flex Code
16227 \begin_layout Plain Layout
16233 implies the generation of specific \SpecialChar LaTeX
16235 using the \SpecialChar LaTeX
16239 \begin_inset Flex Code
16242 \begin_layout Plain Layout
16251 \begin_layout Description
16252 \begin_inset Flex Code
16255 \begin_layout Plain Layout
16262 \begin_inset Flex Code
16265 \begin_layout Plain Layout
16272 \begin_inset space \thinspace{}
16276 \begin_inset Flex Code
16279 \begin_layout Plain Layout
16287 ] Allow spell-checking paragraphs of this style.
16291 \begin_layout Description
16292 \begin_inset Flex Code
16295 \begin_layout Plain Layout
16302 \begin_inset Flex Code
16305 \begin_layout Plain Layout
16314 \begin_inset Flex Code
16317 \begin_layout Plain Layout
16323 ] Steps the parent counter of a given counter at the beginning of a new sequence of layouts.
16324 This is currently only useful when
16325 \begin_inset Flex Code
16328 \begin_layout Plain Layout
16335 \begin_inset Flex Code
16338 \begin_layout Plain Layout
16347 \begin_layout Description
16348 \begin_inset Flex Code
16351 \begin_layout Plain Layout
16357 The font used for the text body .
16359 \begin_inset CommandInset ref
16361 reference "subsec:Font-description"
16369 \begin_layout Description
16370 \begin_inset Flex Code
16373 \begin_layout Plain Layout
16382 \begin_inset Flex Code
16385 \begin_layout Plain Layout
16395 The level of the style in the table of contents.
16396 This is used for automatic numbering of section headings.
16399 \begin_layout Description
16400 \begin_inset Flex Code
16403 \begin_layout Plain Layout
16412 \begin_inset Flex Code
16415 \begin_layout Plain Layout
16427 \begin_inset Flex Code
16430 \begin_layout Plain Layout
16438 \begin_inset Flex Code
16441 \begin_layout Plain Layout
16447 ] This tag determines whether the first line indentation of this paragraph can be toggled via the Paragraph settings dialog.
16451 \begin_inset Flex Code
16454 \begin_layout Plain Layout
16465 indentation can be toggled if the document settings use
16466 \begin_inset Quotes eld
16470 \begin_inset Quotes erd
16475 \begin_inset Flex Code
16478 \begin_layout Plain Layout
16485 indentation can always be toggled,
16486 notwithstanding the document settings,
16488 \begin_inset Flex Code
16491 \begin_layout Plain Layout
16498 indentation can never be toggled.
16501 \begin_layout Description
16502 \begin_inset Flex Code
16505 \begin_layout Plain Layout
16512 \begin_inset Flex Code
16515 \begin_layout Plain Layout
16521 ] The vertical space with which the very first of a chain of paragraphs with this style is separated from the previous paragraph.
16522 If the previous paragraph has another style,
16523 the separations are not simply added,
16524 but the maximum is taken.
16527 \begin_layout Subsection
16528 \begin_inset CommandInset label
16534 Internationalization of Paragraph Styles
16537 \begin_layout Standard
16539 has long supported internationalization of layout information,
16542 this applied only to the user interface and not to,
16546 French authors were forced to resort to ugly hacks if they wanted `
16550 1' instead of `Theorem 1'.
16551 Thanks to Georg Baum,
16552 that is no longer the case.
16555 \begin_layout Standard
16557 \begin_inset Flex Code
16560 \begin_layout Plain Layout
16566 defines text that is to appear in the typeset document,
16568 \begin_inset Flex Code
16571 \begin_layout Plain Layout
16578 \begin_inset Flex Code
16581 \begin_layout Plain Layout
16587 to support non-English and even multi-language documents correctly.
16588 The following excerpt (from the
16589 \begin_inset Flex Code
16592 \begin_layout Plain Layout
16598 file) shows how this works:
16601 \begin_layout LyX-Code
16606 \begin_layout LyX-Code
16609 theoremstyle{remark}
16612 \begin_layout LyX-Code
16615 newtheorem{claim}[thm]{
16622 \begin_layout LyX-Code
16626 \begin_layout LyX-Code
16630 \begin_layout LyX-Code
16635 claimname}{_(Claim)}
16638 \begin_layout LyX-Code
16642 \begin_layout LyX-Code
16646 \begin_layout LyX-Code
16655 claimname}{_(Claim)}}
16658 \begin_layout LyX-Code
16663 \begin_layout Standard
16665 any legal \SpecialChar LaTeX
16667 \begin_inset Flex Code
16670 \begin_layout Plain Layout
16677 \begin_inset Flex Code
16680 \begin_layout Plain Layout
16687 but in practice they will typically look as they do here.
16688 The key to correct translation of the typeset text is the definition of the \SpecialChar LaTeX
16690 \begin_inset Flex Code
16693 \begin_layout Plain Layout
16702 \begin_inset Flex Code
16705 \begin_layout Plain Layout
16717 \begin_layout Standard
16719 \begin_inset Flex Code
16722 \begin_layout Plain Layout
16728 tag provides for internationalization based upon the overall language of the document.
16729 The contents of the tag will be included in the preamble,
16731 \begin_inset Flex Code
16734 \begin_layout Plain Layout
16741 What makes it special is the use of the
16742 \begin_inset Quotes eld
16746 \begin_inset Quotes erd
16750 \begin_inset Flex Code
16753 \begin_layout Plain Layout
16760 which will be replaced,
16761 when \SpecialChar LyX
16762 produces \SpecialChar LaTeX
16764 with the translation of its argument into the document language.
16767 \begin_layout Standard
16769 \begin_inset Flex Code
16772 \begin_layout Plain Layout
16778 tag is more complex,
16779 since it is meant to provide support for multi-language documents and so offers an interface to the
16780 \begin_inset Flex Code
16783 \begin_layout Plain Layout
16790 Its contents will be added to the preamble once for each language that appears in the document.
16793 \begin_inset Flex Code
16796 \begin_layout Plain Layout
16802 will be replaced with its translation into the language in question;
16804 \begin_inset Flex Code
16807 \begin_layout Plain Layout
16813 is replaced by the language name (as used by the babel package).
16816 \begin_layout Standard
16817 A German document that also included a French section would thus have the following in the preamble:
16820 \begin_layout LyX-Code
16829 claimname}{Affirmation}}
16830 \begin_inset Newline newline
16841 claimname}{Behauptung}}
16842 \begin_inset Newline newline
16849 claimname}{Behauptung}
16852 \begin_layout Standard
16855 \begin_inset Flex Code
16858 \begin_layout Plain Layout
16864 will then conspire to produce the correct text in the output.
16867 \begin_layout Standard
16868 One important point to note here is that the translations are provided by \SpecialChar LyX
16871 \begin_inset Flex Code
16874 \begin_layout Plain Layout
16884 \begin_inset Flex Code
16887 \begin_layout Plain Layout
16894 \begin_inset Flex Code
16897 \begin_layout Plain Layout
16903 are really only of use in layout files that are provided with \SpecialChar LyX
16905 since text entered in user-created layout files will not be seen by \SpecialChar LyX
16906 's internationalization routines unless the
16907 \begin_inset Flex Code
16910 \begin_layout Plain Layout
16916 file is modified accordingly.
16919 any layout created with the intention that it will be included with \SpecialChar LyX
16920 should use these tags where appropriate.
16921 Please note that the paragraph style translations provided by \SpecialChar LyX
16922 will never change with a minor update (e.
16923 \begin_inset space \thinspace{}
16927 \begin_inset space \space{}
16930 from version 2.1.x to 2.1.y).
16931 It is however quite likely that a major update (e.
16932 \begin_inset space \thinspace{}
16936 \begin_inset space \space{}
16939 from 2.0.x to 2.1.0) will introduce new translations or corrections.
16942 \begin_layout Subsection
16944 \begin_inset CommandInset label
16946 name "subsec:Floats"
16953 \begin_layout Standard
16954 It is necessary to define the floats (
16955 \begin_inset Flex Noun
16958 \begin_layout Plain Layout
16966 \begin_inset Flex Noun
16969 \begin_layout Plain Layout
16977 ) in the text class itself.
16978 Standard floats are included in the file
16979 \begin_inset Flex Code
16982 \begin_layout Plain Layout
16989 so you may have to do no more than add
16992 \begin_layout LyX-Code
16993 Input stdfloats.inc
16996 \begin_layout Standard
16997 to your layout file.
16998 If you want to implement a text class that proposes some other float types (like the AGU class bundled with \SpecialChar LyX
17000 the information below will hopefully help you:
17003 \begin_layout Description
17004 \begin_inset Flex Code
17007 \begin_layout Plain Layout
17014 \begin_inset Flex Code
17017 \begin_layout Plain Layout
17023 =!htbpH] Allowed placement options for this float type.
17024 The value is a string of placement characters.
17025 Possible characters include:
17031 \begin_inset Quotes eld
17035 \begin_inset Quotes erd
17044 \begin_inset Quotes eld
17048 \begin_inset Quotes erd
17057 \begin_inset Quotes eld
17061 \begin_inset Quotes erd
17070 \begin_inset Quotes eld
17074 \begin_inset Quotes erd
17083 \begin_inset Quotes eld
17087 \begin_inset Quotes erd
17096 \begin_inset Quotes eld
17100 \begin_inset Quotes erd
17104 The order of the characters in the string does not matter.
17105 If no placement options are allowed,
17113 \begin_layout Description
17114 \begin_inset Flex Code
17117 \begin_layout Plain Layout
17124 \begin_inset Flex Code
17127 \begin_layout Plain Layout
17136 \begin_inset space \thinspace{}
17142 \begin_inset Flex Code
17145 \begin_layout Plain Layout
17155 ] Defines whether the float allows to be rotated via the \SpecialChar LaTeX
17162 \begin_inset Flex Code
17165 \begin_layout Plain Layout
17171 if the float does not support this feature.
17174 \begin_layout Description
17175 \begin_inset Flex Code
17178 \begin_layout Plain Layout
17185 \begin_inset Flex Code
17188 \begin_layout Plain Layout
17197 \begin_inset space \thinspace{}
17203 \begin_inset Flex Code
17206 \begin_layout Plain Layout
17216 ] Defines whether the float has a starred variant that spans columns in a two column paragraph.
17218 \begin_inset Flex Code
17221 \begin_layout Plain Layout
17227 if the float does not support this feature.
17230 \begin_layout Description
17231 \begin_inset Flex Code
17234 \begin_layout Plain Layout
17241 \begin_inset Flex Code
17244 \begin_layout Plain Layout
17251 \begin_inset Quotes erd
17255 \begin_inset Quotes erd
17258 ] The file name extension of an auxiliary file for the list of figures (or whatever).
17260 writes the captions to this file.
17263 \begin_layout Description
17264 \begin_inset Flex Code
17267 \begin_layout Plain Layout
17274 \begin_inset Flex Code
17277 \begin_layout Plain Layout
17284 \begin_inset Quotes erd
17288 \begin_inset Quotes erd
17291 ] The string that will be used in the menus and also for the caption.
17292 This is translated to the current language if babel is used.
17295 \begin_layout Description
17296 \begin_inset Flex Code
17299 \begin_layout Plain Layout
17305 These tags control the XHTML output.
17307 \begin_inset CommandInset ref
17309 reference "sec:Tags-for-XHTML"
17317 \begin_layout Description
17318 \begin_inset Flex Code
17321 \begin_layout Plain Layout
17330 \begin_inset Flex Code
17333 \begin_layout Plain Layout
17342 \begin_inset space \thinspace{}
17346 \begin_inset Flex Code
17349 \begin_layout Plain Layout
17355 ] Indicates whether the float is already defined in the document class or if instead the \SpecialChar LaTeX
17357 \begin_inset Flex Code
17360 \begin_layout Plain Layout
17366 needs to be loaded to define it on-the-fly.
17368 \begin_inset Flex Code
17371 \begin_layout Plain Layout
17380 \begin_inset Flex Code
17383 \begin_layout Plain Layout
17390 It should be set to
17391 \begin_inset Flex Code
17394 \begin_layout Plain Layout
17400 if the float is already defined by the \SpecialChar LaTeX
17404 \begin_layout Description
17405 \begin_inset Flex Code
17408 \begin_layout Plain Layout
17415 \begin_inset Flex Code
17418 \begin_layout Plain Layout
17425 \begin_inset Quotes erd
17429 \begin_inset Quotes erd
17432 ] The command used to generate a list of floats of this type;
17441 \begin_inset Flex Code
17444 \begin_layout Plain Layout
17451 since there is no standard way to generate this command.
17453 \begin_inset Flex Code
17456 \begin_layout Plain Layout
17463 since in that case there is a standard way to define the command.
17466 \begin_layout Description
17467 \begin_inset Flex Code
17470 \begin_layout Plain Layout
17477 \begin_inset Flex Code
17480 \begin_layout Plain Layout
17487 \begin_inset Quotes erd
17491 \begin_inset Quotes erd
17494 ] A title for a list of floats of this kind (list of figures,
17497 It is used for the screen label within \SpecialChar LyX
17499 it is used by \SpecialChar LaTeX
17500 for the title and it is used as the title in the XHTML output.
17501 It will be translated to the document language.
17504 \begin_layout Description
17505 \begin_inset Flex Code
17508 \begin_layout Plain Layout
17515 \begin_inset Flex Code
17518 \begin_layout Plain Layout
17525 \begin_inset Quotes erd
17529 \begin_inset Quotes erd
17532 ] This (optional) argument determines whether floats of this class will be numbered within some sectional unit of the document.
17535 \begin_inset Flex Code
17538 \begin_layout Plain Layout
17545 \begin_inset Quotes eld
17549 \begin_inset Flex Code
17552 \begin_layout Plain Layout
17559 \begin_inset Quotes erd
17563 the floats will be numbered within chapters.
17567 \begin_layout Description
17568 \begin_inset Flex Code
17571 \begin_layout Plain Layout
17578 \begin_inset Flex Code
17581 \begin_layout Plain Layout
17588 \begin_inset Quotes erd
17592 \begin_inset Quotes erd
17595 ] The default placement for the given class of floats.
17596 The string should be as in standard \SpecialChar LaTeX
17599 \begin_inset Flex Code
17602 \begin_layout Plain Layout
17610 \begin_inset Flex Code
17613 \begin_layout Plain Layout
17621 \begin_inset Flex Code
17624 \begin_layout Plain Layout
17631 \begin_inset Flex Code
17634 \begin_layout Plain Layout
17648 \begin_layout Plain Layout
17649 Note that the order of these letters in the string is irrelevant,
17650 like in \SpecialChar LaTeX
17656 On top of that there is a new type,
17658 \begin_inset Flex Code
17661 \begin_layout Plain Layout
17668 which does not really correspond to a float,
17671 \begin_inset Quotes eld
17675 \begin_inset Quotes erd
17679 Note however that the
17680 \begin_inset Flex Code
17683 \begin_layout Plain Layout
17689 specifier is special and,
17690 because of implementation details,
17691 cannot be used in non-built in float types.
17692 If you do not understand what this means,
17694 \begin_inset Quotes eld
17698 \begin_inset Flex Code
17701 \begin_layout Plain Layout
17708 \begin_inset Quotes erd
17714 \begin_layout Description
17715 \begin_inset Flex Code
17718 \begin_layout Plain Layout
17725 \begin_inset Flex Code
17728 \begin_layout Plain Layout
17735 \begin_inset Quotes erd
17739 \begin_inset Quotes erd
17742 ] A format for use with formatted references to this counter.
17744 one might want to have references to tables appear as
17745 \begin_inset Quotes eld
17749 \begin_inset Quotes erd
17753 The string may contain
17754 \begin_inset Quotes eld
17758 \begin_inset Quotes erd
17761 or a counter specification.
17762 (See the documentation for
17763 \begin_inset Flex Code
17766 \begin_layout Plain Layout
17773 \begin_inset CommandInset ref
17774 LatexCommand formatted
17775 reference "subsec:Counters"
17783 .) The former will be replaced by the counter number itself.
17791 arabic{section} (which might render as:
17795 \begin_layout Description
17796 \begin_inset Flex Code
17799 \begin_layout Plain Layout
17806 \begin_inset Flex Code
17809 \begin_layout Plain Layout
17815 ] The prefix to use when creating labels referring to floats of this type.
17816 This allows the use of formatted references.
17817 Note that you can remove any
17818 \begin_inset Flex Code
17821 \begin_layout Plain Layout
17827 set by a copied style by using the special value
17828 \begin_inset Quotes eld
17832 \begin_inset Quotes erd
17836 which must be all caps.
17839 \begin_layout Description
17840 \begin_inset Flex Code
17843 \begin_layout Plain Layout
17850 \begin_inset Flex Code
17853 \begin_layout Plain Layout
17859 ] As with paragraph styles,
17861 \begin_inset CommandInset ref
17863 reference "subsec:Paragraph-Styles"
17871 \begin_layout Description
17872 \begin_inset Flex Code
17875 \begin_layout Plain Layout
17882 \begin_inset Flex Code
17885 \begin_layout Plain Layout
17892 \begin_inset Quotes erd
17896 \begin_inset Quotes erd
17899 ] The style used when defining the float using
17900 \begin_inset Flex Code
17903 \begin_layout Plain Layout
17914 \begin_layout Description
17915 \begin_inset Flex Code
17918 \begin_layout Plain Layout
17925 \begin_inset Flex Code
17928 \begin_layout Plain Layout
17935 \begin_inset Quotes erd
17939 \begin_inset Quotes erd
17943 \begin_inset Quotes eld
17947 \begin_inset Quotes erd
17950 of the new class of floats,
17951 like program or algorithm.
17952 After the appropriate
17953 \begin_inset Flex Code
17956 \begin_layout Plain Layout
17966 \begin_inset Flex Code
17969 \begin_layout Plain Layout
17978 \begin_inset Flex Code
17981 \begin_layout Plain Layout
17992 \begin_layout Description
17993 \begin_inset Flex Code
17996 \begin_layout Plain Layout
18003 \begin_inset Flex Code
18006 \begin_layout Plain Layout
18013 \begin_inset space \thinspace{}
18017 \begin_inset Flex Code
18020 \begin_layout Plain Layout
18028 ] Specifies whether this float is defined using the \SpecialChar LaTeX
18030 \begin_inset Flex Code
18033 \begin_layout Plain Layout
18040 either by the class file,
18041 another package or on-the-fly by \SpecialChar LyX
18045 \begin_layout Standard
18046 Note that defining a float with type
18047 \begin_inset Flex Code
18050 \begin_layout Plain Layout
18058 automatically defines the corresponding counter with name
18059 \begin_inset Flex Code
18062 \begin_layout Plain Layout
18073 \begin_layout Subsection
18074 Flex insets and InsetLayout
18075 \begin_inset CommandInset label
18077 name "subsec:Flex-insets-and"
18084 \begin_layout Standard
18085 Flex insets come in two different kinds:
18089 \begin_layout Itemize
18091 \begin_inset Flex Code
18094 \begin_layout Plain Layout
18101 These define semantic markup corresponding to such \SpecialChar LaTeX
18103 \begin_inset Flex Code
18106 \begin_layout Plain Layout
18115 \begin_inset Flex Code
18118 \begin_layout Plain Layout
18129 \begin_layout Itemize
18131 \begin_inset Flex Code
18134 \begin_layout Plain Layout
18141 These can be used to define custom collapsible insets,
18142 similar to \SpecialChar TeX
18146 An obvious example is an endnote inset,
18147 which is defined in the
18148 \begin_inset Flex Code
18151 \begin_layout Plain Layout
18160 \begin_layout Standard
18161 Flex insets are defined using the
18162 \begin_inset Flex Code
18165 \begin_layout Plain Layout
18172 which shall be explained in a moment.
18175 \begin_layout Standard
18177 \begin_inset Flex Code
18180 \begin_layout Plain Layout
18186 tag also serves another function:
18187 It can be used to customize the general layout of many different types of insets.
18190 \begin_inset Flex Code
18193 \begin_layout Plain Layout
18199 can be used to customize the layout parameters for footnotes,
18212 as well as to define Flex insets.
18215 \begin_layout Standard
18217 \begin_inset Flex Code
18220 \begin_layout Plain Layout
18226 definition must begin with a line of the form:
18229 \begin_layout LyX-Code
18233 \begin_layout Standard
18235 \begin_inset Flex Code
18238 \begin_layout Plain Layout
18244 indicates the inset whose layout is being defined,
18245 and here there are four cases.
18248 \begin_layout Enumerate
18249 The layout for a pre-existing inset is being modified.
18252 \begin_inset Flex Code
18255 \begin_layout Plain Layout
18261 any one of the following:
18263 \begin_inset Flex Code
18266 \begin_layout Plain Layout
18274 \begin_inset Flex Code
18277 \begin_layout Plain Layout
18285 \begin_inset Flex Code
18288 \begin_layout Plain Layout
18296 \begin_inset Flex Code
18299 \begin_layout Plain Layout
18307 \begin_inset Flex Code
18310 \begin_layout Plain Layout
18318 \begin_inset Flex Code
18321 \begin_layout Plain Layout
18329 \begin_inset Flex Code
18332 \begin_layout Plain Layout
18340 \begin_inset Flex Code
18343 \begin_layout Plain Layout
18351 \begin_inset Flex Code
18354 \begin_layout Plain Layout
18362 \begin_inset Flex Code
18365 \begin_layout Plain Layout
18373 \begin_inset Flex Code
18376 \begin_layout Plain Layout
18384 \begin_inset Flex Code
18387 \begin_layout Plain Layout
18395 \begin_inset Flex Code
18398 \begin_layout Plain Layout
18406 \begin_inset Flex Code
18409 \begin_layout Plain Layout
18417 \begin_inset Flex Code
18420 \begin_layout Plain Layout
18428 \begin_inset Flex Code
18431 \begin_layout Plain Layout
18439 \begin_inset Flex Code
18442 \begin_layout Plain Layout
18450 \begin_inset Flex Code
18453 \begin_layout Plain Layout
18461 \begin_inset Flex Code
18464 \begin_layout Plain Layout
18472 \begin_inset Flex Code
18475 \begin_layout Plain Layout
18484 \begin_layout Enumerate
18485 The layout for a Flex inset is being defined.
18488 \begin_inset Flex Code
18491 \begin_layout Plain Layout
18497 must be of the form
18498 \begin_inset Quotes eld
18502 \begin_inset Flex Code
18505 \begin_layout Plain Layout
18512 \begin_inset Quotes erd
18517 \begin_inset Flex Code
18520 \begin_layout Plain Layout
18526 may be any valid identifier not used by a pre-existing Flex inset.
18527 The identifier may include spaces,
18528 but in that case the whole thing must be wrapped in quotes.
18529 Note that the definition of a flex inset
18534 \begin_inset Flex Code
18537 \begin_layout Plain Layout
18544 declaring which type of inset it defines.
18547 \begin_layout Enumerate
18548 The layout for user specific branch is being defined.
18551 \begin_inset Flex Code
18554 \begin_layout Plain Layout
18560 must be of the form
18561 \begin_inset Quotes eld
18565 \begin_inset Flex Code
18568 \begin_layout Plain Layout
18575 \begin_inset Quotes erd
18580 \begin_inset Flex Code
18583 \begin_layout Plain Layout
18589 may be any valid identifier of branch defined in user's document.
18590 The identifier may include spaces,
18591 but in that case the whole thing must be wrapped in quotes.
18592 The main purpose of this feature is to allow \SpecialChar LaTeX
18593 wrapping around specific branches as user needs.
18596 \begin_layout Enumerate
18597 The layout of a user (or class) specific caption is being defined.
18600 \begin_inset Flex Code
18603 \begin_layout Plain Layout
18609 must be of the form
18610 \begin_inset Quotes eld
18614 \begin_inset Flex Code
18617 \begin_layout Plain Layout
18624 \begin_inset Quotes erd
18629 \begin_inset Flex Code
18632 \begin_layout Plain Layout
18638 specifies the name of the caption as it appears in the menu.
18639 Have a look at the standard caption (
18640 \begin_inset Flex Code
18643 \begin_layout Plain Layout
18650 the specific captions of the KOMA-Script classes (
18651 \begin_inset Flex Code
18654 \begin_layout Plain Layout
18662 \begin_inset Flex Code
18665 \begin_layout Plain Layout
18674 \begin_inset space ~
18678 \begin_inset Newline linebreak
18684 \begin_inset Flex Code
18687 \begin_layout Plain Layout
18693 ) for applications.
18696 \begin_layout Standard
18698 \begin_inset Flex Code
18701 \begin_layout Plain Layout
18707 definition can contain the following entries:
18710 \begin_layout Description
18711 \begin_inset Flex Code
18714 \begin_layout Plain Layout
18721 \begin_inset Flex Code
18724 \begin_layout Plain Layout
18730 =""] This inset will appear in the table of contents of the given type.
18731 An empty string disables.
18732 See also the OutlinerName and the IsTocCaption commands.
18733 This is only implemented for Flex insets.
18738 \begin_layout Description
18739 \begin_inset Flex Code
18742 \begin_layout Plain Layout
18748 Includes a comma-separated list of insets to which this inset can be inserted.
18750 \begin_inset Quotes eld
18754 \begin_inset Flex Code
18757 \begin_layout Plain Layout
18764 \begin_inset Quotes erd
18768 If you you also want the insertion to be allowed in specific arguments of the target insets,
18769 append the argument name after @ (e.
18770 \begin_inset space \thinspace{}
18775 \begin_inset Flex Code
18778 \begin_layout Plain Layout
18785 Note that this currently only supports immediately containing insets (no deeper nesting).
18787 \begin_inset Flex Code
18790 \begin_layout Plain Layout
18799 \begin_layout Description
18800 \begin_inset Flex Code
18803 \begin_layout Plain Layout
18809 Includes a comma-separated list of layouts within which this inset can be inserted.
18811 \begin_inset Quotes eld
18815 \begin_inset Flex Code
18818 \begin_layout Plain Layout
18819 EndAllowedInLayouts
18825 \begin_inset Quotes erd
18829 Note that this currently only supports immediately containing layouts (no deeper nesting).
18831 \begin_inset Flex Code
18834 \begin_layout Plain Layout
18843 \begin_layout Description
18844 \begin_inset Flex Code
18847 \begin_layout Plain Layout
18854 \begin_inset Flex Code
18857 \begin_layout Plain Layout
18864 \begin_inset Flex Code
18867 \begin_layout Plain Layout
18874 \begin_inset Flex Code
18877 \begin_layout Plain Layout
18884 this can be used to determine how many times the inset can be inserted to a given inset or the paragraph (group).
18887 \begin_layout Description
18888 \begin_inset Flex Code
18891 \begin_layout Plain Layout
18892 AllowedOccurrencesPerItem
18898 \begin_inset Flex Code
18901 \begin_layout Plain Layout
18910 \begin_inset space \thinspace{}
18914 \begin_inset Flex Code
18917 \begin_layout Plain Layout
18923 ] If this is set to true,
18925 \begin_inset Flex Code
18928 \begin_layout Plain Layout
18934 applies to single paragraphs if we are in a list-type environment (with
18935 \begin_inset Flex Code
18938 \begin_layout Plain Layout
18949 \begin_layout Description
18950 \begin_inset Flex Code
18953 \begin_layout Plain Layout
18960 \begin_inset Flex Code
18963 \begin_layout Plain Layout
18969 ] Defines argument number of a command\SpecialChar breakableslash
18970 environment associated with the current layout.
18971 The definition must end with
18972 \begin_inset Flex Code
18975 \begin_layout Plain Layout
18983 \begin_inset CommandInset ref
18985 reference "subsec:Arguments"
18993 for more information.
18996 \begin_layout Description
18997 \begin_inset Flex Code
19000 \begin_layout Plain Layout
19006 Preamble for changing language commands;
19008 \begin_inset CommandInset ref
19010 reference "subsec:I18n"
19018 \begin_layout Description
19019 \begin_inset Flex Code
19022 \begin_layout Plain Layout
19029 \begin_inset Flex Code
19032 \begin_layout Plain Layout
19038 ] The color for the inset's background.
19040 \begin_inset CommandInset ref
19042 reference "chap:Names-of-colors"
19047 for a list of the available color names.
19050 \begin_layout Description
19051 \begin_inset Flex Code
19054 \begin_layout Plain Layout
19061 \begin_inset Flex Code
19064 \begin_layout Plain Layout
19073 \begin_inset space \thinspace{}
19077 \begin_inset Flex Code
19080 \begin_layout Plain Layout
19086 ] Whether to use the content of the inset as the label,
19087 when the inset is closed.
19091 \begin_layout Description
19092 \begin_inset Flex Code
19095 \begin_layout Plain Layout
19102 \begin_inset Flex Code
19105 \begin_layout Plain Layout
19111 ] As with paragraph styles,
19113 \begin_inset CommandInset ref
19115 reference "subsec:Paragraph-Styles"
19121 Note that you need to specify the complete type,
19123 \begin_inset space \thinspace{}
19127 \begin_inset space ~
19131 \begin_inset Flex Code
19134 \begin_layout Plain Layout
19135 CopyStyle Flex:<name>
19143 \begin_layout Description
19144 \begin_inset Flex Code
19147 \begin_layout Plain Layout
19154 \begin_inset Flex Code
19157 \begin_layout Plain Layout
19166 \begin_inset space \thinspace{}
19170 \begin_inset Flex Code
19173 \begin_layout Plain Layout
19179 ] Indicates whether the user may employ the Paragraph Settings dialog to customize the paragraph.
19182 \begin_layout Description
19183 \begin_inset Flex Code
19186 \begin_layout Plain Layout
19193 \begin_inset Flex Code
19196 \begin_layout Plain Layout
19204 \begin_inset Flex Code
19207 \begin_layout Plain Layout
19215 \begin_inset Flex Code
19218 \begin_layout Plain Layout
19225 describing the rendering style used for the inset's frame and buttons.
19226 Footnotes generally use
19227 \begin_inset Flex Code
19230 \begin_layout Plain Layout
19237 ERT insets generally
19238 \begin_inset Flex Code
19241 \begin_layout Plain Layout
19248 and character styles
19249 \begin_inset Flex Code
19252 \begin_layout Plain Layout
19261 \begin_layout Description
19262 \begin_inset Flex Code
19265 \begin_layout Plain Layout
19272 \begin_inset Flex Code
19275 \begin_layout Plain Layout
19284 \begin_inset space \thinspace{}
19290 \begin_inset Flex Code
19293 \begin_layout Plain Layout
19302 \begin_inset Flex Code
19305 \begin_layout Plain Layout
19312 \begin_inset Flex Code
19315 \begin_layout Plain Layout
19322 Indicates whether the environment will stand on its own in the output or will appear inline with the surrounding text.
19324 it is supposed that the \SpecialChar LaTeX
19325 environment ignores white space (including one newline character) after the
19326 \begin_inset Flex Code
19329 \begin_layout Plain Layout
19342 \begin_inset Flex Code
19345 \begin_layout Plain Layout
19361 \begin_layout Description
19362 \begin_inset Flex Code
19365 \begin_layout Plain Layout
19375 ,1] Allow the contents of the inset to be edited externally (using whatever editor is defined for the document's output format).
19378 \begin_layout Description
19379 \begin_inset Flex Code
19382 \begin_layout Plain Layout
19388 Required at the end of the
19389 \begin_inset Flex Code
19392 \begin_layout Plain Layout
19401 \begin_layout Description
19402 \begin_inset Flex Code
19405 \begin_layout Plain Layout
19411 The font used for both the text body
19417 \begin_inset CommandInset ref
19418 LatexCommand formatted
19419 reference "subsec:Font-description"
19425 Note that defining this font automatically defines the
19426 \begin_inset Flex Code
19429 \begin_layout Plain Layout
19436 so define this first and define
19437 \begin_inset Flex Code
19440 \begin_layout Plain Layout
19446 later if you want them to be different.
19449 \begin_layout Description
19450 \begin_inset Flex Code
19453 \begin_layout Plain Layout
19454 FixedWidthPreambleEncoding
19460 \begin_inset Flex Code
19463 \begin_layout Plain Layout
19472 \begin_inset space \thinspace{}
19476 \begin_inset Flex Code
19479 \begin_layout Plain Layout
19485 ] Force a fixed width encoding for the translated contents of
19486 \begin_inset Flex Code
19489 \begin_layout Plain Layout
19496 \begin_inset Flex Code
19499 \begin_layout Plain Layout
19505 code generated by this layout.
19506 This is needed for special \SpecialChar LaTeX
19511 that do not work with variable width encodings such as
19516 This setting is ignored if fully Unicode aware \SpecialChar LaTeX
19517 backends such as Xe\SpecialChar TeX
19518 or Lua\SpecialChar TeX
19522 \begin_layout Description
19523 \begin_inset Flex Code
19526 \begin_layout Plain Layout
19527 ForceLocalFontSwitch
19533 \begin_inset Flex Code
19536 \begin_layout Plain Layout
19545 \begin_inset space \thinspace{}
19549 \begin_inset Flex Code
19552 \begin_layout Plain Layout
19558 ] When using babel,
19559 always use a local font switch (
19560 \begin_inset Flex Code
19563 \begin_layout Plain Layout
19572 never a global one (such as
19573 \begin_inset Flex Code
19576 \begin_layout Plain Layout
19587 \begin_layout Description
19588 \begin_inset Flex Code
19591 \begin_layout Plain Layout
19598 \begin_inset Flex Code
19601 \begin_layout Plain Layout
19610 \begin_inset space \thinspace{}
19614 \begin_inset Flex Code
19617 \begin_layout Plain Layout
19624 \begin_inset Quotes eld
19628 \begin_inset Quotes erd
19632 leading to Left-to-Right (Latin) output,
19634 \begin_inset space \thinspace{}
19638 \begin_inset space \space{}
19641 in \SpecialChar TeX
19646 \begin_layout Description
19647 \begin_inset Flex Code
19650 \begin_layout Plain Layout
19657 \begin_inset Flex Code
19660 \begin_layout Plain Layout
19669 \begin_inset space \thinspace{}
19673 \begin_inset Flex Code
19676 \begin_layout Plain Layout
19682 ] Force a line break in the \SpecialChar LaTeX
19683 output before the inset starts and after the inset ends.
19684 This assures the inset itself is output on its own lines,
19685 for parsing purposes.
19688 \begin_layout Description
19689 \begin_inset Flex Code
19692 \begin_layout Plain Layout
19699 \begin_inset Flex Code
19702 \begin_layout Plain Layout
19711 \begin_inset space \thinspace{}
19715 \begin_inset Flex Code
19718 \begin_layout Plain Layout
19724 ] Indicates whether the
19725 \begin_inset Flex Code
19728 \begin_layout Plain Layout
19736 the user can change the paragraph style used in the inset.
19740 \begin_layout Description
19741 \begin_inset Flex Code
19744 \begin_layout Plain Layout
19751 \begin_inset Flex Code
19754 \begin_layout Plain Layout
19763 \begin_inset space \thinspace{}
19767 \begin_inset Flex Code
19770 \begin_layout Plain Layout
19776 ] As with paragraph styles,
19778 \begin_inset CommandInset ref
19780 reference "subsec:Paragraph-Styles"
19788 \begin_layout Description
19789 \begin_inset Flex Code
19792 \begin_layout Plain Layout
19798 These tags control the XHTML output.
19800 \begin_inset CommandInset ref
19802 reference "sec:Tags-for-XHTML"
19810 \begin_layout Description
19811 \begin_inset Flex Code
19814 \begin_layout Plain Layout
19821 \begin_inset Flex Code
19824 \begin_layout Plain Layout
19831 \begin_inset space \thinspace{}
19835 \begin_inset Flex Code
19838 \begin_layout Plain Layout
19846 ] The font inside the inset is inherited from the parent for \SpecialChar LaTeX
19847 export if this parameter is 1,
19848 as well as on screen.
19849 Otherwise the document default font is used.
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
19888 ] Whether to include the contents of this inset in the strings generated for the `Outline' pane for all table of contents,
19889 regardless of the AddToToc setting.
19892 want the content of a footnote in a section header to be included in the TOC displayed in the outline,
19893 but one would normally want the content of a character style displayed.
19898 \begin_layout Description
19899 \begin_inset Flex Code
19902 \begin_layout Plain Layout
19909 \begin_inset Flex Code
19912 \begin_layout Plain Layout
19921 \begin_inset space \thinspace{}
19925 \begin_inset Flex Code
19928 \begin_layout Plain Layout
19934 ] If this is set to 1 and AddToToc is enabled,
19935 the inset adds a summary of its contents in its item in the table of contents.
19937 only the label appears.
19940 \begin_layout Description
19941 \begin_inset Flex Code
19944 \begin_layout Plain Layout
19953 \begin_inset Flex Code
19956 \begin_layout Plain Layout
19965 \begin_inset space \thinspace{}
19969 \begin_inset Flex Code
19972 \begin_layout Plain Layout
19978 ] As with paragraph styles,
19980 \begin_inset CommandInset ref
19982 reference "subsec:Paragraph-Styles"
19990 \begin_layout Description
19991 \begin_inset Flex Code
19994 \begin_layout Plain Layout
20000 The font used for the label.
20002 \begin_inset CommandInset ref
20004 reference "subsec:Font-description"
20010 Note that this definition can never appear before
20011 \begin_inset Flex Code
20014 \begin_layout Plain Layout
20021 lest it be ineffective.
20024 \begin_layout Description
20025 \begin_inset Flex Code
20028 \begin_layout Plain Layout
20035 \begin_inset Flex Code
20038 \begin_layout Plain Layout
20045 \begin_inset Quotes erd
20049 \begin_inset Quotes erd
20052 ] What will be displayed on the button or elsewhere as the inset label.
20054 \begin_inset Flex Code
20057 \begin_layout Plain Layout
20065 \begin_inset Flex Code
20068 \begin_layout Plain Layout
20074 ) modify this label on the fly.
20077 \begin_layout Description
20078 \begin_inset Flex Code
20081 \begin_layout Plain Layout
20087 Language dependent preamble;
20089 \begin_inset CommandInset ref
20091 reference "subsec:I18n"
20099 \begin_layout Description
20100 \begin_inset Flex Code
20103 \begin_layout Plain Layout
20110 \begin_inset Flex Code
20113 \begin_layout Plain Layout
20119 ] The name of the corresponding \SpecialChar LaTeX
20121 Either the environment or command name.
20124 \begin_layout Description
20125 \begin_inset Flex Code
20128 \begin_layout Plain Layout
20135 \begin_inset Flex Code
20138 \begin_layout Plain Layout
20144 ] The optional parameter for the corresponding
20145 \begin_inset Flex Code
20148 \begin_layout Plain Layout
20155 including possible bracket pairs like
20156 \begin_inset Flex Code
20159 \begin_layout Plain Layout
20166 This parameter cannot be changed from within \SpecialChar LyX
20168 \begin_inset Flex Code
20171 \begin_layout Plain Layout
20177 for customizable parameters).
20178 It will be output as is after all \SpecialChar LaTeX
20180 \begin_inset Flex Code
20183 \begin_layout Plain Layout
20192 \begin_layout Description
20193 \begin_inset Flex Code
20196 \begin_layout Plain Layout
20203 \begin_inset Flex Code
20206 \begin_layout Plain Layout
20214 ] How the style should be translated into \SpecialChar LaTeX
20219 \begin_layout Plain Layout
20220 \begin_inset Flex Code
20223 \begin_layout Plain Layout
20229 is perhaps a bit misleading,
20230 since these rules apply to SGML classes too.
20231 Visit the SGML class files for specific examples.
20240 \begin_layout Description
20241 \begin_inset Flex Code
20244 \begin_layout Plain Layout
20250 means nothing special
20253 \begin_layout Description
20254 \begin_inset Flex Code
20257 \begin_layout Plain Layout
20264 \begin_inset Flex Code
20267 \begin_layout Plain Layout
20274 {\SpecialChar ldots
20283 \begin_layout Description
20284 \begin_inset Flex Code
20287 \begin_layout Plain Layout
20294 \begin_inset Flex Code
20297 \begin_layout Plain Layout
20304 }\SpecialChar ldots
20319 \begin_layout Standard
20320 Putting the last few things together,
20321 the \SpecialChar LaTeX
20322 output will be either:
20326 \begin_layout LyX-Code
20329 LatexName[LatexParam]{\SpecialChar ldots
20333 \begin_layout Standard
20338 \begin_layout LyX-Code
20341 begin{LatexName}[LatexParam] \SpecialChar ldots
20347 \begin_layout Standard
20348 depending upon the \SpecialChar LaTeX
20353 \begin_layout Description
20354 \begin_inset Flex Code
20357 \begin_layout Plain Layout
20364 \begin_inset Flex Code
20367 \begin_layout Plain Layout
20373 ] A string that is put at the beginning of the layout content.
20374 A line break in the output can be indicated by
20375 \begin_inset Flex Code
20378 \begin_layout Plain Layout
20387 \begin_layout Description
20388 \begin_inset Flex Code
20391 \begin_layout Plain Layout
20398 \begin_inset Flex Code
20401 \begin_layout Plain Layout
20409 \begin_inset Flex Code
20412 \begin_layout Plain Layout
20420 \begin_inset Flex Code
20423 \begin_layout Plain Layout
20429 (indicating a dummy definition ending definitions of charstyles,
20431 This entry is required in and is only meaningful for Flex insets.
20432 Among other things,
20433 it determines on which menu this inset will appear.
20435 \begin_inset Flex Code
20438 \begin_layout Plain Layout
20445 \begin_inset Flex Code
20448 \begin_layout Plain Layout
20454 will automatically set
20455 \begin_inset Flex Code
20458 \begin_layout Plain Layout
20465 \begin_inset Flex Code
20468 \begin_layout Plain Layout
20476 \begin_inset Flex Code
20479 \begin_layout Plain Layout
20485 can be set to true,
20487 \begin_inset Flex Code
20490 \begin_layout Plain Layout
20498 \begin_inset Flex Code
20501 \begin_layout Plain Layout
20507 insets by setting it
20512 \begin_inset Flex Code
20515 \begin_layout Plain Layout
20524 \begin_layout Description
20525 \begin_inset Flex Code
20528 \begin_layout Plain Layout
20535 \begin_inset Flex Code
20538 \begin_layout Plain Layout
20544 A dedicated string for the menu.
20545 You can define an accelerator by appending the respective character to the string,
20547 \begin_inset Quotes eld
20551 \begin_inset Quotes erd
20555 \begin_inset space \thinspace{}
20559 \begin_inset space \space{}
20563 \begin_inset Quotes eld
20567 \begin_inset Flex Code
20570 \begin_layout Plain Layout
20577 \begin_inset Quotes erd
20581 This specification is optional.
20582 If it is not given the inset name as specified in the type declaration will be used instead for the menu.
20585 \begin_layout Description
20586 \begin_inset Flex Code
20589 \begin_layout Plain Layout
20596 \begin_inset Flex Code
20599 \begin_layout Plain Layout
20608 \begin_inset space \thinspace{}
20612 \begin_inset Flex Code
20615 \begin_layout Plain Layout
20621 ] Whether multiple paragraphs are permitted in this inset.
20623 \begin_inset Flex Code
20626 \begin_layout Plain Layout
20632 to the same value and
20633 \begin_inset Flex Code
20636 \begin_layout Plain Layout
20642 to the opposite value.
20643 These can be reset to other values,
20649 \begin_inset Flex Code
20652 \begin_layout Plain Layout
20662 \begin_layout Description
20663 \begin_inset Flex Code
20666 \begin_layout Plain Layout
20673 \begin_inset Flex Code
20676 \begin_layout Plain Layout
20685 \begin_inset space \thinspace{}
20689 \begin_inset Flex Code
20692 \begin_layout Plain Layout
20698 ] Whether fragile commands in this inset should be
20699 \begin_inset Flex Code
20702 \begin_layout Plain Layout
20716 whether the command should itself be protected.) Default is false.
20719 \begin_layout Description
20720 \begin_inset Flex Code
20723 \begin_layout Plain Layout
20730 \begin_inset Flex Code
20733 \begin_layout Plain Layout
20742 \begin_inset space \thinspace{}
20746 \begin_inset Flex Code
20749 \begin_layout Plain Layout
20755 ] This causes macros that contain this inset to be protected with
20756 \begin_inset Flex Code
20759 \begin_layout Plain Layout
20772 ) if necessary and thus allows (some) verbatim stuff in macros.
20776 \begin_layout Description
20777 \begin_inset Flex Code
20780 \begin_layout Plain Layout
20787 \begin_inset Flex Code
20790 \begin_layout Plain Layout
20799 \begin_inset space \thinspace{}
20803 \begin_inset Flex Code
20806 \begin_layout Plain Layout
20812 ] Whether specific commands in this inset (such as
20813 \begin_inset Flex Code
20816 \begin_layout Plain Layout
20825 \begin_inset Flex Code
20828 \begin_layout Plain Layout
20836 ) should be protected in an
20837 \begin_inset Flex Code
20840 \begin_layout Plain Layout
20849 This is particularly needed for insets that draw on
20857 commands which parse their content in complex ways.
20861 \begin_layout Description
20862 \begin_inset Flex Code
20865 \begin_layout Plain Layout
20872 \begin_inset Flex Code
20875 \begin_layout Plain Layout
20881 Option to define a different command (from the default
20882 \begin_inset Flex Code
20885 \begin_layout Plain Layout
20895 ) to be used for line breaks.
20896 The initial backslash must not be specified.
20899 \begin_layout Description
20900 \begin_inset Flex Code
20903 \begin_layout Plain Layout
20910 \begin_inset Flex Code
20913 \begin_layout Plain Layout
20919 ] Deletes an existing
20920 \begin_inset Flex Code
20923 \begin_layout Plain Layout
20932 \begin_layout Description
20933 \begin_inset Flex Code
20936 \begin_layout Plain Layout
20943 \begin_inset Flex Code
20946 \begin_layout Plain Layout
20953 \begin_inset Flex Code
20956 \begin_layout Plain Layout
20962 that has replaced this
20963 \begin_inset Flex Code
20966 \begin_layout Plain Layout
20973 This is used to rename an
20974 \begin_inset Flex Code
20977 \begin_layout Plain Layout
20984 while keeping backward compatibility.
20987 \begin_layout Description
20988 \begin_inset Flex Code
20991 \begin_layout Plain Layout
20998 \begin_inset Flex Code
21001 \begin_layout Plain Layout
21010 \begin_inset space \thinspace{}
21014 \begin_inset Flex Code
21017 \begin_layout Plain Layout
21023 ] If this is set to
21024 \begin_inset Flex Code
21027 \begin_layout Plain Layout
21034 paragraph breaks will be ignored in the output.
21035 This might be useful for insets where the content should be alignable on different lines only in the \SpecialChar LyX
21037 without any effect in the output.
21040 \begin_layout Description
21041 \begin_inset Flex Code
21044 \begin_layout Plain Layout
21051 \begin_inset Flex Code
21054 \begin_layout Plain Layout
21063 \begin_inset space \thinspace{}
21067 \begin_inset Flex Code
21070 \begin_layout Plain Layout
21076 ] As with paragraph styles,
21078 \begin_inset CommandInset ref
21080 reference "subsec:Paragraph-Styles"
21089 \begin_layout Description
21090 \begin_inset Flex Code
21093 \begin_layout Plain Layout
21100 \begin_inset Flex Code
21103 \begin_layout Plain Layout
21112 \begin_inset space \thinspace{}
21116 \begin_inset Flex Code
21119 \begin_layout Plain Layout
21125 ] As with paragraph styles,
21127 \begin_inset CommandInset ref
21129 reference "subsec:Paragraph-Styles"
21138 \begin_layout Description
21139 \begin_inset Flex Code
21142 \begin_layout Plain Layout
21148 As with paragraph styles,
21150 \begin_inset CommandInset ref
21152 reference "subsec:Paragraph-Styles"
21160 \begin_layout Description
21161 \begin_inset Flex Code
21164 \begin_layout Plain Layout
21171 \begin_inset Flex Code
21174 \begin_layout Plain Layout
21180 ] The prefix to use when creating labels referring to insets of this type.
21181 This allows the use of formatted references.
21184 \begin_layout Description
21185 \begin_inset Flex Code
21188 \begin_layout Plain Layout
21195 \begin_inset Flex Code
21198 \begin_layout Plain Layout
21204 ] As with paragraph styles,
21206 \begin_inset CommandInset ref
21208 reference "subsec:Paragraph-Styles"
21216 \begin_layout Description
21217 \begin_inset Flex Code
21220 \begin_layout Plain Layout
21227 \begin_inset Flex Code
21230 \begin_layout Plain Layout
21239 \begin_inset space \thinspace{}
21243 \begin_inset Flex Code
21246 \begin_layout Plain Layout
21252 ] Resets the \SpecialChar LaTeX
21253 arguments of this layout (as defined via the
21254 \begin_inset Flex Code
21257 \begin_layout Plain Layout
21264 This is useful if you have copied a style via
21265 \begin_inset Flex Code
21268 \begin_layout Plain Layout
21275 but you do not want to inherit its (required and optional) arguments.
21278 \begin_layout Description
21279 \begin_inset Flex Code
21282 \begin_layout Plain Layout
21289 \begin_inset Flex Code
21292 \begin_layout Plain Layout
21301 \begin_inset space \thinspace{}
21305 \begin_inset Flex Code
21308 \begin_layout Plain Layout
21315 \begin_inset Flex Code
21318 \begin_layout Plain Layout
21325 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.
21326 \begin_inset space \thinspace{}
21331 \begin_inset Flex Code
21334 \begin_layout Plain Layout
21337 textbf{Sourrounding text
21341 textbf{content}}\SpecialChar ldots
21348 \begin_inset Flex Code
21351 \begin_layout Plain Layout
21354 textbf{Sourrounding text
21356 myinset{content}\SpecialChar ldots
21363 Setting this makes sense for commands that internally reset font settings (e.
21364 \begin_inset space \thinspace{}
21369 Note that wrongly setting this might lead to unwanted result (e.
21370 \begin_inset space \thinspace{}
21375 \begin_inset Flex Code
21378 \begin_layout Plain Layout
21381 emph{Sourrounding text
21385 emph{content}}\SpecialChar ldots
21392 content is upright,
21394 \begin_inset Flex Code
21397 \begin_layout Plain Layout
21407 \begin_inset Flex Code
21410 \begin_layout Plain Layout
21417 font changes are not redone inside the inset.
21420 \begin_layout Description
21421 \begin_inset Flex Code
21424 \begin_layout Plain Layout
21431 \begin_inset Flex Code
21434 \begin_layout Plain Layout
21440 ] A string that is put at the end of the layout content.
21441 A line break in the output can be indicated by
21442 \begin_inset Flex Code
21445 \begin_layout Plain Layout
21454 \begin_layout Description
21455 \begin_inset Flex Code
21458 \begin_layout Plain Layout
21465 \begin_inset Flex Code
21468 \begin_layout Plain Layout
21475 \begin_inset space \thinspace{}
21479 \begin_inset Flex Code
21482 \begin_layout Plain Layout
21490 ] Allow spell-checking the contents of this inset.
21494 \begin_layout Subsection
21496 \begin_inset CommandInset label
21498 name "subsec:Arguments"
21505 \begin_layout Standard
21506 Both paragraph styles and inset layouts allow for
21510 as well as the main content.
21511 This is especially useful for things like section headings and only makes sense with \SpecialChar LaTeX
21513 Each (optional or required) argument of a command or environment—
21514 except for the required argument that is associated with the content—
21515 has a separate definition,
21516 where the number specifies the order of the arguments.
21517 The definition must end with
21518 \begin_inset Flex Code
21521 \begin_layout Plain Layout
21528 So a command with two optional arguments looks like:
21531 \begin_layout Quote
21537 \begin_layout Quote
21543 \begin_layout Quote
21549 \begin_layout Quote
21555 \begin_layout Quote
21561 \begin_layout Quote
21567 \begin_layout Standard
21569 \begin_inset Flex Code
21572 \begin_layout Plain Layout
21579 the following specifications are possible:
21582 \begin_layout Itemize
21583 \begin_inset Flex Code
21586 \begin_layout Plain Layout
21593 \begin_inset Flex Code
21596 \begin_layout Plain Layout
21602 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
21603 \begin_inset Flex Code
21606 \begin_layout Plain Layout
21614 you can define an accelerator by appending the respective character to the string,
21616 \begin_inset Quotes eld
21620 \begin_inset Quotes erd
21624 \begin_inset space \thinspace{}
21628 \begin_inset space \space{}
21632 \begin_inset Quotes eld
21636 \begin_inset Flex Code
21639 \begin_layout Plain Layout
21646 \begin_inset Quotes erd
21652 \begin_layout Itemize
21653 \begin_inset Flex Code
21656 \begin_layout Plain Layout
21663 \begin_inset Flex Code
21666 \begin_layout Plain Layout
21672 A separate string for the menu.
21673 You can define an accelerator by appending the respective character to the string,
21675 \begin_inset Quotes eld
21679 \begin_inset Quotes erd
21683 \begin_inset space \thinspace{}
21687 \begin_inset space \space{}
21691 \begin_inset Quotes eld
21695 \begin_inset Flex Code
21698 \begin_layout Plain Layout
21705 \begin_inset Quotes erd
21709 This specification is optional.
21710 If it is not given the
21711 \begin_inset Flex Code
21714 \begin_layout Plain Layout
21720 will be used instead for the menu.
21723 \begin_layout Itemize
21724 \begin_inset Flex Code
21727 \begin_layout Plain Layout
21734 \begin_inset Flex Code
21737 \begin_layout Plain Layout
21743 A longer explanatory text that appears in the tooltip when hovering over the argument inset.
21746 \begin_layout Itemize
21747 \begin_inset Flex Code
21750 \begin_layout Plain Layout
21757 \begin_inset Flex Code
21760 \begin_layout Plain Layout
21769 \begin_inset space \thinspace{}
21773 \begin_inset Flex Code
21776 \begin_layout Plain Layout
21782 ] Declare if this is a mandatory (1) or an optional (0) argument.
21783 Mandatory arguments will be output empty if not given,
21784 while optional arguments will not be output at all.
21786 mandatory arguments are delimited by
21787 \begin_inset Flex Code
21790 \begin_layout Plain Layout
21797 while optional arguments are delimited by
21798 \begin_inset Flex Code
21801 \begin_layout Plain Layout
21810 \begin_layout Itemize
21811 \begin_inset Flex Code
21814 \begin_layout Plain Layout
21821 \begin_inset Flex Code
21824 \begin_layout Plain Layout
21830 Option to define a different command (from the default
21831 \begin_inset Flex Code
21834 \begin_layout Plain Layout
21844 ) to be used for line breaks.
21845 The initial backslash must not be specified.
21848 \begin_layout Itemize
21849 \begin_inset Flex Code
21852 \begin_layout Plain Layout
21859 \begin_inset Flex Code
21862 \begin_layout Plain Layout
21868 defines another argument or arguments (by their number) which this argument requires to be output if it is itself output.
21870 \begin_inset space \thinspace{}
21874 in \SpecialChar LaTeX
21876 optional arguments often require previous optional arguments to be output (at least empty),
21878 \begin_inset Flex Code
21881 \begin_layout Plain Layout
21884 command[][argument]{text}
21890 This can be achieved by the statement
21891 \begin_inset Flex Code
21894 \begin_layout Plain Layout
21901 \begin_inset Flex Code
21904 \begin_layout Plain Layout
21911 If multiple arguments are required,
21912 separate them by comma (e.g.,
21914 \begin_inset Flex Code
21917 \begin_layout Plain Layout
21926 \begin_layout Itemize
21927 \begin_inset Flex Code
21930 \begin_layout Plain Layout
21937 \begin_inset Flex Code
21940 \begin_layout Plain Layout
21946 defines a custom left delimiter (instead of
21947 \begin_inset Flex Code
21950 \begin_layout Plain Layout
21957 \begin_inset Flex Code
21960 \begin_layout Plain Layout
21967 A line break in the output can be indicated by
21968 \begin_inset Flex Code
21971 \begin_layout Plain Layout
21980 \begin_layout Itemize
21981 \begin_inset Flex Code
21984 \begin_layout Plain Layout
21991 \begin_inset Flex Code
21994 \begin_layout Plain Layout
22000 defines a custom right delimiter (instead of
22001 \begin_inset Flex Code
22004 \begin_layout Plain Layout
22011 \begin_inset Flex Code
22014 \begin_layout Plain Layout
22021 A line break in the output can be indicated by
22022 \begin_inset Flex Code
22025 \begin_layout Plain Layout
22034 \begin_layout Itemize
22035 \begin_inset Flex Code
22038 \begin_layout Plain Layout
22045 \begin_inset Flex Code
22048 \begin_layout Plain Layout
22054 defines an argument that is inserted if and only if no user-specified arguments were given,
22056 \begin_inset space \thinspace{}
22060 \begin_inset space \space{}
22063 if no argument inset has been inserted (note that also an empty argument inset omits the DefaultArg).
22064 Multiple arguments need to be separated by comma.
22067 \begin_layout Itemize
22068 \begin_inset Flex Code
22071 \begin_layout Plain Layout
22078 \begin_inset Flex Code
22081 \begin_layout Plain Layout
22087 defines an argument that is inserted in any case (alone or in addition to user-specified arguments).
22088 Multiple arguments need to be separated by comma.
22091 \begin_layout Itemize
22092 \begin_inset Flex Code
22095 \begin_layout Plain Layout
22101 The font used for the argument content,
22103 \begin_inset CommandInset ref
22105 reference "subsec:Font-description"
22113 \begin_layout Itemize
22114 \begin_inset Flex Code
22117 \begin_layout Plain Layout
22124 \begin_inset Flex Code
22127 \begin_layout Plain Layout
22136 \begin_inset space \thinspace{}
22140 \begin_inset Flex Code
22143 \begin_layout Plain Layout
22149 ] As with paragraph styles,
22151 \begin_inset CommandInset ref
22153 reference "subsec:Paragraph-Styles"
22161 \begin_layout Itemize
22162 \begin_inset Flex Code
22165 \begin_layout Plain Layout
22171 The font used for the label;
22173 \begin_inset CommandInset ref
22175 reference "subsec:Font-description"
22183 \begin_layout Itemize
22184 \begin_inset Flex Code
22187 \begin_layout Plain Layout
22194 \begin_inset Flex Code
22197 \begin_layout Plain Layout
22209 ] describes the rendering style used for the inset's frame and buttons.
22212 \begin_layout Itemize
22213 \begin_inset Flex Code
22216 \begin_layout Plain Layout
22223 \begin_inset Flex Code
22226 \begin_layout Plain Layout
22233 \begin_inset Flex Code
22236 \begin_layout Plain Layout
22243 this argument is automatically inserted when the respective style is selected.
22246 \begin_layout Itemize
22247 \begin_inset Flex Code
22250 \begin_layout Plain Layout
22257 \begin_inset Flex Code
22260 \begin_layout Plain Layout
22267 \begin_inset Flex Code
22270 \begin_layout Plain Layout
22277 this argument will be inserted on a new line with
22278 \begin_inset Flex Code
22281 \begin_layout Plain Layout
22287 (only available within Flex insets).
22290 \begin_layout Itemize
22291 \begin_inset Flex Code
22294 \begin_layout Plain Layout
22301 \begin_inset Flex Code
22304 \begin_layout Plain Layout
22311 \begin_inset Flex Code
22314 \begin_layout Plain Layout
22321 this argument will be inserted with a copy of the co-text (either selected text or the whole paragraph) as content.
22324 \begin_layout Itemize
22325 \begin_inset Flex Code
22328 \begin_layout Plain Layout
22335 \begin_inset Flex Code
22338 \begin_layout Plain Layout
22350 ] Whether the contents of this argument should be output in raw form,
22351 meaning without special translations that \SpecialChar LaTeX
22355 \begin_inset Flex Code
22358 \begin_layout Plain Layout
22364 status is inherited by the inset or paragraph layout the argument belongs to,
22365 true and false change the status for the given argument only.
22368 \begin_layout Itemize
22369 \begin_inset Flex Code
22372 \begin_layout Plain Layout
22379 \begin_inset Flex Code
22382 \begin_layout Plain Layout
22383 string of characters
22392 Defines individual characters
22393 \begin_inset Newline linebreak
22396 that should be output in raw form,
22397 meaning without special translations that \SpecialChar LaTeX
22400 contrary to PassThru,
22401 this needs to be explicitly defined for arguments.
22403 arguments do not inherit PassThruChars from their parent inset or layout.
22406 \begin_layout Itemize
22407 \begin_inset Flex Code
22410 \begin_layout Plain Layout
22417 \begin_inset Flex Code
22420 \begin_layout Plain Layout
22429 \begin_inset space \thinspace{}
22433 \begin_inset Flex Code
22436 \begin_layout Plain Layout
22442 ] If this is set to 1,
22443 the argument will output its content in the corresponding item in the table of contents.
22447 \begin_layout Standard
22449 the text entered in the \SpecialChar LyX
22450 workarea in the respective layout is the last (mandatory) argument of a command if the
22451 \begin_inset Flex Code
22454 \begin_layout Plain Layout
22461 \begin_inset Flex Code
22464 \begin_layout Plain Layout
22472 arguments with the prefix
22473 \begin_inset Flex Code
22476 \begin_layout Plain Layout
22482 are output after this workarea argument.
22483 Note that post-argument numbering restarts at 1,
22484 so the first argument following the workarea argument is
22485 \begin_inset Flex Code
22488 \begin_layout Plain Layout
22495 Post-arguments are ignored in any other
22496 \begin_inset Flex Code
22499 \begin_layout Plain Layout
22506 \begin_inset Flex Code
22509 \begin_layout Plain Layout
22518 \begin_layout Standard
22520 \begin_inset Flex Code
22523 \begin_layout Plain Layout
22532 \begin_inset Flex Code
22535 \begin_layout Plain Layout
22544 \begin_inset Flex Code
22547 \begin_layout Plain Layout
22553 followed by the number (e.
22554 \begin_inset space \thinspace{}
22558 \begin_inset space \space{}
22562 \begin_inset Flex Code
22565 \begin_layout Plain Layout
22574 \begin_layout Standard
22576 there is a special argument type with the prefix
22577 \begin_inset Flex Code
22580 \begin_layout Plain Layout
22587 It is not really an argument,
22588 but uses the argument interface (thus,
22589 the prefix is also followed by a number,
22591 \begin_inset space \thinspace{}
22596 \begin_inset Flex Code
22599 \begin_layout Plain Layout
22600 Argument listpreamble:1
22606 As the name implies,
22607 it is targeted at lists such as
22627 Its content will be output at the list start,
22629 \begin_inset Flex Code
22632 \begin_layout Plain Layout
22641 on an own line (a place that is otherwise not accessible in \SpecialChar LyX
22644 users can insert redefinitions (of lengths etc.) to individual lists.
22646 these arguments do not have a delimiter.
22649 \begin_layout Subsection
22651 \begin_inset CommandInset label
22653 name "subsec:Counters"
22660 \begin_layout Standard
22661 It is necessary to define the counters (
22662 \begin_inset Flex Noun
22665 \begin_layout Plain Layout
22673 \begin_inset Flex Noun
22676 \begin_layout Plain Layout
22684 ) in the text class itself.
22685 The standard counters are defined in the file
22686 \begin_inset Flex Code
22689 \begin_layout Plain Layout
22696 so you may have to do no more than add
22699 \begin_layout LyX-Code
22700 Input stdcounters.inc
22703 \begin_layout Standard
22704 to your layout file to get them to work.
22705 But if you want to define custom counters,
22706 then you can do so.
22707 The counter declaration must begin with:
22710 \begin_layout LyX-Code
22711 Counter CounterName
22714 \begin_layout Standard
22716 \begin_inset Flex Code
22719 \begin_layout Plain Layout
22725 ' is replaced by the name of the counter.
22726 And it must end with
22727 \begin_inset Quotes eld
22731 \begin_inset Flex Code
22734 \begin_layout Plain Layout
22741 \begin_inset Quotes erd
22745 The following parameters can also be used:
22748 \begin_layout Description
22749 \begin_inset Flex Code
22752 \begin_layout Plain Layout
22759 \begin_inset Flex Code
22762 \begin_layout Plain Layout
22768 ] Sets the initial value for the counter,
22769 to which it will be reset whenever that happens.
22771 one will want the default,
22775 \begin_layout Description
22776 \begin_inset Flex Code
22779 \begin_layout Plain Layout
22786 \begin_inset Flex Code
22789 \begin_layout Plain Layout
22796 \begin_inset Quotes erd
22800 \begin_inset Quotes erd
22804 this string defines how the counter is displayed.
22805 Setting this value sets
22806 \begin_inset Flex Code
22809 \begin_layout Plain Layout
22810 LabelStringAppendix
22816 The following special constructs can be used in the string:
22820 \begin_layout Itemize
22821 \begin_inset Flex Code
22824 \begin_layout Plain Layout
22832 will be replaced by the expansion of the
22833 \begin_inset Flex Code
22836 \begin_layout Plain Layout
22843 \begin_inset Flex Code
22846 \begin_layout Plain Layout
22847 LabelStringAppendix
22853 \begin_inset Flex Code
22856 \begin_layout Plain Layout
22866 \begin_layout Itemize
22867 counter values can be expressed using \SpecialChar LaTeX
22869 \begin_inset Newline newline
22873 \begin_inset Flex Code
22876 \begin_layout Plain Layout
22894 \begin_inset Flex Code
22897 \begin_layout Plain Layout
22909 \begin_layout Plain Layout
22920 the situation is a bit more complicated:
22940 other than those described below will produce arabic numerals.
22941 It would not be surprising to see this change in the future.
22947 \begin_inset Flex Code
22950 \begin_layout Plain Layout
22959 3,\SpecialChar ldots
22962 \begin_inset Flex Code
22965 \begin_layout Plain Layout
22971 for lower-case letters:
22978 \begin_inset Flex Code
22981 \begin_layout Plain Layout
22987 for upper-case letters:
22994 \begin_inset Flex Code
22997 \begin_layout Plain Layout
23003 for lower-case roman numerals:
23010 \begin_inset Flex Code
23013 \begin_layout Plain Layout
23019 for upper-case roman numerals:
23022 III\SpecialChar ldots
23025 \begin_inset Flex Code
23028 \begin_layout Plain Layout
23034 for hebrew numerals.
23038 \begin_layout Standard
23039 If LabelString is not defined,
23040 a default value is constructed as follows:
23041 if the counter has a parent counter
23042 \begin_inset Flex Code
23045 \begin_layout Plain Layout
23052 \begin_inset Flex Code
23055 \begin_layout Plain Layout
23063 \begin_inset Newline newline
23067 \begin_inset Flex Code
23070 \begin_layout Plain Layout
23081 otherwise the string
23082 \begin_inset Flex Code
23085 \begin_layout Plain Layout
23096 \begin_layout Description
23097 \begin_inset Flex Code
23100 \begin_layout Plain Layout
23101 LabelStringAppendix
23107 \begin_inset Flex Code
23110 \begin_layout Plain Layout
23117 \begin_inset Quotes eld
23121 \begin_inset Quotes erd
23125 \begin_inset Flex Code
23128 \begin_layout Plain Layout
23135 but for use in the Appendix.
23138 \begin_layout Description
23139 \begin_inset Flex Code
23142 \begin_layout Plain Layout
23149 \begin_inset Flex Code
23152 \begin_layout Plain Layout
23159 \begin_inset Quotes eld
23163 \begin_inset Quotes erd
23166 ] The counter name as used in \SpecialChar LaTeX
23169 in \SpecialChar LyX
23171 there is a counter named `theorem',
23172 but it is output to \SpecialChar LaTeX
23176 \begin_layout Description
23177 \begin_inset Flex Code
23180 \begin_layout Plain Layout
23187 \begin_inset Flex Code
23190 \begin_layout Plain Layout
23197 \begin_inset Quotes erd
23201 \begin_inset Quotes erd
23204 ] A format for use with formatted references to this counter.
23206 one might want to have references to section numbers appear as
23207 \begin_inset Quotes eld
23211 \begin_inset Quotes erd
23215 The string may contain
23216 \begin_inset Quotes eld
23220 \begin_inset Quotes erd
23223 or a counter specification as in
23224 \begin_inset Flex Code
23227 \begin_layout Plain Layout
23234 The former will be replaced by the counter number itself.
23241 \begin_inset Flex Code
23244 \begin_layout Plain Layout
23254 (which might render as §2.7).
23257 \begin_layout Description
23258 \begin_inset Flex Code
23261 \begin_layout Plain Layout
23268 \begin_inset Flex Code
23271 \begin_layout Plain Layout
23279 \begin_inset Flex Code
23282 \begin_layout Plain Layout
23288 ] For use with `formatted references',
23289 specifically when a single counter is used with multiple sorts of styles.
23292 \begin_inset Flex Code
23295 \begin_layout Plain Layout
23301 counter is often used for all sorts of theorem-like environments:
23305 The first argument gives a prefix used in the labels (e.g.,
23307 \begin_inset Quotes eld
23311 \begin_inset Quotes erd
23315 \begin_inset Quotes eld
23319 \begin_inset Quotes erd
23323 and the second a formatting string,
23325 \begin_inset Flex Code
23328 \begin_layout Plain Layout
23335 \begin_inset Flex Code
23338 \begin_layout Plain Layout
23345 If this is not given,
23347 \begin_inset Flex Code
23350 \begin_layout Plain Layout
23359 \begin_layout Description
23360 \begin_inset Flex Code
23363 \begin_layout Plain Layout
23370 \begin_inset Flex Code
23373 \begin_layout Plain Layout
23380 \begin_inset Quotes erd
23384 \begin_inset Quotes erd
23387 ] If this is set to the name of another counter,
23388 the present counter will be reset every time the other one is increased.
23391 \begin_inset Flex Code
23394 \begin_layout Plain Layout
23401 \begin_inset Flex Code
23404 \begin_layout Plain Layout
23413 \begin_layout Subsection
23415 \begin_inset CommandInset label
23417 name "subsec:Font-description"
23424 \begin_layout Standard
23425 A font description looks like this:
23428 \begin_layout LyX-Code
23445 \begin_layout LyX-Code
23449 \begin_layout LyX-Code
23453 \begin_layout Standard
23454 The following commands are available:
23457 \begin_layout Description
23458 \begin_inset Flex Code
23461 \begin_layout Plain Layout
23468 \begin_inset Flex Code
23471 \begin_layout Plain Layout
23478 \begin_inset space ~
23482 \begin_inset CommandInset ref
23484 reference "chap:Names-of-colors"
23492 for valid arguments.
23495 \begin_layout Description
23496 \begin_inset Flex Code
23499 \begin_layout Plain Layout
23506 \begin_inset Flex Code
23509 \begin_layout Plain Layout
23519 \begin_inset Flex Code
23522 \begin_layout Plain Layout
23530 \begin_inset Flex Code
23533 \begin_layout Plain Layout
23542 \begin_layout Description
23543 \begin_inset Flex Code
23546 \begin_layout Plain Layout
23553 \begin_inset Flex Code
23556 \begin_layout Plain Layout
23562 ] Valid arguments are:
23564 \begin_inset Flex Code
23567 \begin_layout Plain Layout
23575 \begin_inset Flex Code
23578 \begin_layout Plain Layout
23586 \begin_inset Flex Code
23589 \begin_layout Plain Layout
23597 \begin_inset Flex Code
23600 \begin_layout Plain Layout
23608 \begin_inset Flex Code
23611 \begin_layout Plain Layout
23619 \begin_inset Flex Code
23622 \begin_layout Plain Layout
23630 \begin_inset Flex Code
23633 \begin_layout Plain Layout
23641 \begin_inset Flex Code
23644 \begin_layout Plain Layout
23652 \begin_inset Flex Code
23655 \begin_layout Plain Layout
23663 \begin_inset Flex Code
23666 \begin_layout Plain Layout
23674 \begin_inset Flex Code
23677 \begin_layout Plain Layout
23684 \begin_inset Flex Code
23687 \begin_layout Plain Layout
23694 Each of these turns on or off the corresponding attribute.
23697 \begin_inset Flex Code
23700 \begin_layout Plain Layout
23708 \begin_inset Flex Code
23711 \begin_layout Plain Layout
23719 \begin_inset Newline newline
23722 If the latter seems puzzling,
23723 remember that the font settings for the present context are generally inherited from the surrounding context.
23725 \begin_inset Flex Code
23728 \begin_layout Plain Layout
23734 would turn off the emphasis that was anyway in effect,
23736 in a theorem environment.
23739 \begin_layout Description
23740 \begin_inset Flex Code
23743 \begin_layout Plain Layout
23750 \begin_inset Flex Code
23753 \begin_layout Plain Layout
23763 \begin_inset Flex Code
23766 \begin_layout Plain Layout
23775 \begin_layout Description
23776 \begin_inset Flex Code
23779 \begin_layout Plain Layout
23786 \begin_inset Flex Code
23789 \begin_layout Plain Layout
23799 \begin_inset Flex Code
23802 \begin_layout Plain Layout
23810 \begin_inset Flex Code
23813 \begin_layout Plain Layout
23821 \begin_inset Flex Code
23824 \begin_layout Plain Layout
23833 \begin_layout Description
23834 \begin_inset Flex Code
23837 \begin_layout Plain Layout
23844 \begin_inset Flex Code
23847 \begin_layout Plain Layout
23855 \begin_inset Flex Code
23858 \begin_layout Plain Layout
23866 \begin_inset Flex Code
23869 \begin_layout Plain Layout
23879 \begin_inset Flex Code
23882 \begin_layout Plain Layout
23890 \begin_inset Flex Code
23893 \begin_layout Plain Layout
23901 \begin_inset Flex Code
23904 \begin_layout Plain Layout
23912 \begin_inset Flex Code
23915 \begin_layout Plain Layout
23923 \begin_inset Flex Code
23926 \begin_layout Plain Layout
23935 \begin_layout Subsection
23936 \begin_inset CommandInset label
23938 name "subsec:Citation-engine-description"
23942 Cite engine description
23945 \begin_layout Standard
23947 \begin_inset Flex Code
23950 \begin_layout Plain Layout
23957 as used mainly in cite engine files (see
23958 \begin_inset CommandInset ref
23960 reference "subsec:Cite-Engine-Files"
23969 define the citation commands provided by a specific
23970 \begin_inset Quotes eld
23974 \begin_inset Quotes erd
23979 in \SpecialChar LyX
23981 is way specific way to format citations,
23983 author names and/or years.
23986 supports three such engine types,
23990 \begin_layout Enumerate
23991 \begin_inset Flex Code
23994 \begin_layout Plain Layout
24001 the default Bib\SpecialChar TeX
24002 way to format citations,
24003 a simple numeric style (e.
24004 \begin_inset space \thinspace{}
24009 \begin_inset Quotes eld
24013 \begin_inset Quotes erd
24019 \begin_layout Enumerate
24020 \begin_inset Flex Code
24023 \begin_layout Plain Layout
24030 Harvard-styled citations using author names and publication year (e.
24031 \begin_inset space \thinspace{}
24036 \begin_inset Quotes eld
24039 Smith and Miller (2017b)
24040 \begin_inset Quotes erd
24046 \begin_layout Enumerate
24047 \begin_inset Flex Code
24050 \begin_layout Plain Layout
24057 extended numerical citations that also allow for author or title next to the number (e.
24058 \begin_inset space \thinspace{}
24063 \begin_inset Quotes eld
24066 Smith and Miller [1]
24067 \begin_inset Quotes erd
24073 \begin_layout Standard
24074 \begin_inset Flex Code
24077 \begin_layout Plain Layout
24083 blocks look like this:
24086 \begin_layout LyX-Code
24090 \begin_layout LyX-Code
24094 \begin_layout LyX-Code
24098 \begin_layout LyX-Code
24099 citeyearpar[][]=parencite*
24102 \begin_layout LyX-Code
24106 \begin_layout LyX-Code
24110 \begin_layout Standard
24112 \begin_inset Flex Code
24115 \begin_layout Plain Layout
24121 denotes the engine.
24122 The individual lines respectively define a cite command or cite command paradigm supported by this engine.
24123 The line can be as simple as a cite command that is used both to name the respective \SpecialChar LyX
24124 command and the \SpecialChar LaTeX
24125 output or more complex in order to differentiate things.
24126 The full syntax is:
24129 \begin_layout LyX-Code
24130 LyXName|alias$*<!_stardesc!_stardesctooltip>[][]=latexcmd
24133 \begin_layout Itemize
24134 \begin_inset Flex Code
24137 \begin_layout Plain Layout
24144 The name as used in the
24145 \begin_inset Flex Code
24148 \begin_layout Plain Layout
24158 \begin_layout Standard
24159 For portability reasons,
24160 we try to use the same name for same-formatted commands in different cite packages (thus many names stem from natbib,
24161 and thus we need to differentiate a
24162 \begin_inset Flex Code
24165 \begin_layout Plain Layout
24172 if the \SpecialChar LaTeX
24173 command names differ).
24177 \begin_layout Itemize
24178 \begin_inset Flex Code
24181 \begin_layout Plain Layout
24188 a (comma-separated) list of commands that fall back to the given
24189 \begin_inset Flex Code
24192 \begin_layout Plain Layout
24198 in the current engine.
24199 This eases the switch of citation packages and engines.
24201 \begin_inset Flex Code
24204 \begin_layout Plain Layout
24211 \begin_inset Flex Code
24214 \begin_layout Plain Layout
24220 in layout definitions.
24223 \begin_layout Itemize
24224 \begin_inset Flex Code
24227 \begin_layout Plain Layout
24234 The actual \SpecialChar LaTeX
24235 command that is output.
24239 \begin_layout Standard
24240 \begin_inset Flex Code
24243 \begin_layout Plain Layout
24250 \begin_inset Flex Code
24253 \begin_layout Plain Layout
24261 \begin_inset Flex Code
24264 \begin_layout Plain Layout
24272 \begin_inset Flex Code
24275 \begin_layout Plain Layout
24281 will be output to \SpecialChar LaTeX
24285 \begin_layout Standard
24289 \begin_layout Itemize
24290 Capitalization indicates that the command also has a capitalized form (
24291 \begin_inset Flex Code
24294 \begin_layout Plain Layout
24304 \begin_inset Flex Code
24307 \begin_layout Plain Layout
24316 These usually enforce up-casing of name prefixes (
24321 \begin_inset Formula $\Rightarrow$
24331 \begin_layout Itemize
24333 \begin_inset Flex Code
24336 \begin_layout Plain Layout
24342 indicate the number of optional arguments (there can be 0–2).
24345 \begin_layout Itemize
24347 \begin_inset Flex Code
24350 \begin_layout Plain Layout
24356 indicates there is a starred version of the command (
24357 \begin_inset Flex Code
24360 \begin_layout Plain Layout
24370 \begin_inset Flex Code
24373 \begin_layout Plain Layout
24386 \begin_layout Standard
24388 the starred version means:
24389 Output all authors even if it should be shortened with
24390 \begin_inset Quotes eld
24394 \begin_inset Quotes erd
24398 \begin_inset Flex Code
24401 \begin_layout Plain Layout
24410 \begin_layout Standard
24411 If the star has a different meaning for a given command,
24412 it can be specified in angle brackets:
24414 \begin_inset Flex Code
24417 \begin_layout Plain Layout
24418 <!_stardesc!_stardesctooltip>
24424 Maximal two translatable macro keywords,
24425 marked by the prefix
24426 \begin_inset Flex Code
24429 \begin_layout Plain Layout
24437 The first points to the string that replaces the
24438 \begin_inset Quotes eld
24442 \begin_inset Quotes erd
24445 checkbox label in the citation dialog,
24446 the second one to an optional tool tip for this checkbox.
24450 \begin_layout Standard
24451 Note that these two macros have to be defined in a
24452 \begin_inset Flex Code
24455 \begin_layout Plain Layout
24461 (see next section),
24463 \begin_inset Flex Code
24466 \begin_layout Plain Layout
24477 \begin_layout LyX-Code
24478 _stardesc Sta&rred command label
24481 \begin_layout LyX-Code
24482 _stardesctooltip Tooltip for the starred command checkbox.
24486 \begin_layout Itemize
24488 \begin_inset Flex Code
24491 \begin_layout Plain Layout
24497 indicates that this command features
24498 \begin_inset Quotes eld
24501 qualified citation lists
24502 \begin_inset Quotes erd
24510 -specific feature for multi-reference citations where an individual pre- and postnote can be given to each reference in the list.
24511 Please refer to the
24515 manual for details.
24518 \begin_layout Standard
24519 If you want to add a cite command to a cite engine (e.
24520 \begin_inset space \thinspace{}
24524 add a specific command provided by a class),
24526 \begin_inset Flex Code
24529 \begin_layout Plain Layout
24530 AddToCiteEngine <engine type> \SpecialChar ldots
24537 Note that only cite commands that do not exist yet are added.
24540 \begin_layout Subsection
24541 \begin_inset CommandInset label
24543 name "subsec:Citation-format-description"
24547 Cite format description
24550 \begin_layout Standard
24552 \begin_inset Flex Code
24555 \begin_layout Plain Layout
24561 blocks are used to describe how bibliographic information should be displayed,
24562 both within \SpecialChar LyX
24563 itself (in the citation dialog and in tooltips,
24564 for example) and in XHTML output.
24565 Such a block might look like this:
24568 \begin_layout LyX-Code
24572 \begin_layout LyX-Code
24576 \begin_layout LyX-Code
24580 \begin_layout LyX-Code
24584 \begin_layout Standard
24588 \begin_layout LyX-Code
24592 \begin_layout LyX-Code
24596 \begin_layout LyX-Code
24600 \begin_layout LyX-Code
24604 \begin_layout Standard
24606 the individual lines define how the bibliographic information associated with an article or book,
24608 is to be displayed,
24609 and such a definition can be given for any
24610 \begin_inset Quotes els
24614 \begin_inset Quotes ers
24617 that might be present in a Bib\SpecialChar TeX
24620 defines a default format in the source code that will be used if no specific definition has been given.
24622 predefines several formats in the file
24623 \begin_inset Flex Code
24626 \begin_layout Plain Layout
24633 which is included in most of \SpecialChar LyX
24634 's document classes.
24637 \begin_layout Standard
24638 In the second case,
24639 the lines define how a specific citation command (in the example
24640 \begin_inset Flex Code
24643 \begin_layout Plain Layout
24653 \begin_inset Flex Code
24656 \begin_layout Plain Layout
24664 ) is to be displayed on the citation inset label,
24665 in the citation dialog,
24666 menu or XHTML output.
24668 defines such formats for the citation style variants it supports via
24670 Document\SpecialChar menuseparator
24671 Setting\SpecialChar menuseparator
24672 Bibliography\SpecialChar ldots
24676 \begin_inset Flex Code
24679 \begin_layout Plain Layout
24685 files that are shipped with \SpecialChar LyX
24687 \begin_inset CommandInset ref
24689 reference "subsec:Cite-Engine-Files"
24700 \begin_layout Standard
24701 The definitions use a simple language that allows Bib\SpecialChar TeX
24702 keys to be replaced with their values.
24703 Keys should be enclosed in
24704 \begin_inset Flex Code
24707 \begin_layout Plain Layout
24716 \begin_inset Flex Code
24719 \begin_layout Plain Layout
24726 So a simple definition might look like this:
24729 \begin_layout LyX-Code
24732 \begin_inset Quotes eld
24736 \begin_inset Quotes erd
24742 \begin_layout Standard
24743 This would print the author,
24744 followed by a comma,
24745 followed by the title,
24747 followed by a period.
24750 \begin_layout Standard
24752 sometimes you may want to print a key only if it exists.
24753 This can be done by using a conditional construction,
24756 \begin_inset Flex Code
24759 \begin_layout Plain Layout
24761 \begin_inset space ~
24772 \begin_inset Flex Code
24775 \begin_layout Plain Layout
24783 \begin_inset Quotes eld
24787 \begin_inset space ~
24791 \begin_inset Quotes erd
24794 followed by the volume key.
24795 It is also possible to have an else clause in the conditional,
24797 \begin_inset Newline newline
24801 \begin_inset Flex Code
24804 \begin_layout Plain Layout
24805 {%author%[[%author%]][[%editor%,
24812 \begin_inset Newline newline
24817 \begin_inset Flex Code
24820 \begin_layout Plain Layout
24826 key is printed if it exists;
24828 the editor key is printed,
24830 \begin_inset Quotes eld
24834 \begin_inset space ~
24838 \begin_inset Quotes erd
24841 Note that the key is again enclosed in
24842 \begin_inset Flex Code
24845 \begin_layout Plain Layout
24852 the entire conditional is enclosed in braces;
24853 and the if and else clauses are enclosed in double brackets,
24855 \begin_inset Quotes eld
24859 \begin_inset Flex Code
24862 \begin_layout Plain Layout
24869 \begin_inset Quotes eld
24873 \begin_inset Quotes eld
24877 \begin_inset Flex Code
24880 \begin_layout Plain Layout
24887 \begin_inset Quotes erd
24891 There must be no space between any of these.
24894 \begin_layout Standard
24895 Next to the entry keys,
24896 there are some special keys that can be used for these conditionals:
24899 \begin_layout Itemize
24900 \begin_inset Flex Code
24903 \begin_layout Plain Layout
24904 {%dialog%[[true]][[false]]}
24911 \begin_inset Quotes eld
24915 \begin_inset Quotes erd
24918 part for dialogs and menus,
24920 \begin_inset Quotes eld
24924 \begin_inset Quotes erd
24927 part for other contexts (workarea,
24931 \begin_layout Itemize
24932 \begin_inset Flex Code
24935 \begin_layout Plain Layout
24936 {%export%[[true]][[false]]}
24943 \begin_inset Quotes eld
24947 \begin_inset Quotes erd
24950 part for export and menus,
24952 \begin_inset Quotes eld
24956 \begin_inset Quotes erd
24959 part for other contexts (workarea,
24963 \begin_layout Itemize
24964 \begin_inset Flex Code
24967 \begin_layout Plain Layout
24975 \begin_inset Quotes eld
24979 \begin_inset Quotes erd
24982 part if another item follows (e.
24983 \begin_inset space \thinspace{}
24987 in a citation with multiple keys)
24990 \begin_layout Itemize
24991 \begin_inset Flex Code
24994 \begin_layout Plain Layout
24995 {%second%[[true]][[false]]}
25002 \begin_inset Quotes eld
25006 \begin_inset Quotes erd
25009 if this is the second of multiple items,
25011 \begin_inset Quotes eld
25015 \begin_inset Quotes erd
25021 \begin_layout Itemize
25022 \begin_inset Flex Code
25025 \begin_layout Plain Layout
25026 {%ifstar%[[true]][[false]]}
25033 \begin_inset Quotes eld
25037 \begin_inset Quotes erd
25040 part for starred citation commands (such as
25041 \begin_inset Flex Code
25044 \begin_layout Plain Layout
25053 the false part for unstarred
25056 \begin_layout Itemize
25057 \begin_inset Flex Code
25060 \begin_layout Plain Layout
25061 {%ifentrytype:<type>%[[true]][[false]]}
25068 \begin_inset Quotes eld
25072 \begin_inset Quotes erd
25075 if the current entry type matches
25076 \begin_inset Flex Code
25079 \begin_layout Plain Layout
25086 else the false part (e.g.,
25087 in a citation definition:
25089 \begin_inset Flex Code
25092 \begin_layout Plain Layout
25093 {%ifentrytype:book%[[this is a book]][[this is no book]]}
25101 \begin_layout Itemize
25102 \begin_inset Flex Code
25105 \begin_layout Plain Layout
25106 {%ifmultiple:<authortype>%[[true]][[false]]}
25113 \begin_inset Quotes eld
25117 \begin_inset Quotes erd
25120 if the current author type (author,
25121 editor etc.) has multiple authors,
25122 else the false part (e.g.,
25123 in a bibliography definition:
25125 \begin_inset Flex Code
25128 \begin_layout Plain Layout
25129 {%ifmultiple:editor%[[eds.]][[ed.]]}
25137 \begin_layout Itemize
25138 \begin_inset Flex Code
25141 \begin_layout Plain Layout
25142 {%ifqualified%[[true]][[false]]}
25149 \begin_inset Quotes eld
25153 \begin_inset Quotes erd
25156 part if the current citation is a qualified citation list (a specific
25160 format for multi-reference citations),
25161 the false part if this is not the case.
25164 \begin_layout Standard
25166 \begin_inset Flex Code
25169 \begin_layout Plain Layout
25175 prints the author key as it is recorded in the bibliography file.
25176 This might not be what you want,
25177 since it will result in a string such as
25178 \begin_inset Quotes eld
25185 \begin_inset Quotes erd
25189 \begin_inset Quotes eld
25193 \begin_inset Quotes erd
25196 is used by Bib\SpecialChar TeX
25197 to delimit authors).
25199 therefore provides some methods to get properly formatted name lists (which will also get translated).
25200 The following keys are provided:
25203 \begin_layout Enumerate
25204 For name lists with pre- and surname,
25205 suitable for the main authors/editors of a bibliography item.
25207 \begin_inset Flex Code
25210 \begin_layout Plain Layout
25216 part denotes the kind of list that is requested (e.g.
25218 \begin_inset Flex Code
25221 \begin_layout Plain Layout
25231 \begin_layout Itemize
25232 \begin_inset Flex Code
25235 \begin_layout Plain Layout
25236 %abbrvnames:<nametype>%
25242 Provides a name list which is abbreviated (with
25243 \begin_inset Quotes eld
25247 \begin_inset Quotes erd
25251 \begin_inset Flex Code
25254 \begin_layout Plain Layout
25263 \begin_layout Itemize
25264 \begin_inset Flex Code
25267 \begin_layout Plain Layout
25268 %fullnames:<nametype>%
25274 Provides a full name list (never abbreviated with
25275 \begin_inset Quotes eld
25279 \begin_inset Quotes erd
25285 \begin_layout Itemize
25286 \begin_inset Flex Code
25289 \begin_layout Plain Layout
25290 %forceabbrvnames:<nametype>%
25296 Provides a name list which is always abbreviated (with
25297 \begin_inset Quotes eld
25301 \begin_inset Quotes erd
25305 \begin_inset Flex Code
25308 \begin_layout Plain Layout
25318 \begin_layout Enumerate
25319 Alternative name lists with pre- and surname,
25320 if the order of pre- and surname inside the bibliography item differs (as in:
25322 \begin_inset Quotes eld
25332 \begin_inset Quotes erd
25339 \begin_layout Itemize
25340 \begin_inset Flex Code
25343 \begin_layout Plain Layout
25344 %abbrvbynames:<nametype>%
25350 Provides a name list which is abbreviated (with
25351 \begin_inset Quotes eld
25355 \begin_inset Quotes erd
25359 \begin_inset Flex Code
25362 \begin_layout Plain Layout
25371 \begin_layout Itemize
25372 \begin_inset Flex Code
25375 \begin_layout Plain Layout
25376 %fullbynames:<nametype>%
25382 Provides a full name list (never abbreviated with
25383 \begin_inset Quotes eld
25387 \begin_inset Quotes erd
25393 \begin_layout Itemize
25394 \begin_inset Flex Code
25397 \begin_layout Plain Layout
25398 %forceabbrvbynames:<nametype>%
25404 Provides a name list which is always abbreviated (with
25405 \begin_inset Quotes eld
25409 \begin_inset Quotes erd
25413 \begin_inset Flex Code
25416 \begin_layout Plain Layout
25426 \begin_layout Enumerate
25427 And finally name lists which consist of family names only,
25428 as used in author-year citation labels.
25429 These do not take a
25430 \begin_inset Flex Code
25433 \begin_layout Plain Layout
25440 but always return either an author list or,
25441 if this does not exist,
25442 an editor list (as common in author-year labels):
25446 \begin_layout Itemize
25447 \begin_inset Flex Code
25450 \begin_layout Plain Layout
25457 Provides a name list which is abbreviated (with
25458 \begin_inset Quotes eld
25462 \begin_inset Quotes erd
25466 \begin_inset Flex Code
25469 \begin_layout Plain Layout
25478 \begin_layout Itemize
25479 \begin_inset Flex Code
25482 \begin_layout Plain Layout
25489 Provides a full name list (never abbreviated with
25490 \begin_inset Quotes eld
25494 \begin_inset Quotes erd
25500 \begin_layout Itemize
25501 \begin_inset Flex Code
25504 \begin_layout Plain Layout
25505 %forceabbrvciteauthor%
25511 Provides a name list which is always abbreviated (with
25512 \begin_inset Quotes eld
25516 \begin_inset Quotes erd
25520 \begin_inset Flex Code
25523 \begin_layout Plain Layout
25533 \begin_layout Standard
25534 The order of pre- and surname in the former two lists can be adjusted by these macros:
25537 \begin_layout Itemize
25538 \begin_inset Flex Code
25541 \begin_layout Plain Layout
25542 !firstnameform %surname%,
25548 (first author in lists of type 1)
25551 \begin_layout Itemize
25552 \begin_inset Flex Code
25555 \begin_layout Plain Layout
25556 !othernameform %surname%,
25562 (other authors in lists of type 1)
25565 \begin_layout Itemize
25566 \begin_inset Flex Code
25569 \begin_layout Plain Layout
25570 !firstbynameform %prename% %surname%
25575 (first author in lists of type 2)
25578 \begin_layout Itemize
25579 \begin_inset Flex Code
25582 \begin_layout Plain Layout
25583 !otherbynameform %prename% %surname%
25588 (other authors in lists of type 2)
25591 \begin_layout Standard
25592 This allows you to configure namings like
25593 \begin_inset Quotes eld
25597 Peter and Mary Smith:
25601 John Doe and Pat Green,
25602 eds.:\SpecialChar ldots
25604 \begin_inset Quotes erd
25610 \begin_layout Standard
25611 There is one other piece of syntax available in definitions,
25612 which looks like this:
25614 \begin_inset Flex Code
25617 \begin_layout Plain Layout
25624 This defines a piece of formatting information that is to be used when creating
25625 \begin_inset Quotes eld
25629 \begin_inset Quotes erd
25634 we do not want to output HTML tags when writing plain text,
25635 so they should be wrapped in
25636 \begin_inset Quotes eld
25640 \begin_inset Quotes erd
25644 \begin_inset Quotes eld
25648 \begin_inset Quotes erd
25654 \begin_layout Standard
25655 Two special sorts of definitions are also possible in a
25656 \begin_inset Flex Code
25659 \begin_layout Plain Layout
25666 An example of the first would be:
25669 \begin_layout LyX-Code
25671 \begin_inset Quotes eld
25675 \begin_inset Quotes erd
25681 \begin_layout Standard
25682 This is an abbreviation,
25684 and it can be used by treating it as if it were a key:
25686 \begin_inset Flex Code
25689 \begin_layout Plain Layout
25698 \begin_inset Flex Code
25701 \begin_layout Plain Layout
25707 exactly as it would treat its definition.
25709 let us issue the obvious
25717 \begin_layout LyX-Code
25721 \begin_layout Standard
25722 or anything like it.
25724 shouldn't go into an infinite loop,
25725 but it may go into a long one before it gives up.
25728 \begin_layout Standard
25729 The second sort of special definition might look like this:
25732 \begin_layout LyX-Code
25736 \begin_layout Standard
25737 This defines a translatable piece of text,
25738 which allows relevant parts of the bibliography or citation to be translated.
25739 It can be included in a definition by treating it as a key:
25741 \begin_inset Flex Code
25744 \begin_layout Plain Layout
25751 Note that there are two different translation paths:
25752 All definitions starting with
25753 \begin_inset Flex Code
25756 \begin_layout Plain Layout
25763 such as in the example above,
25764 will be translated to the currently active buffer language (so the translation will match the generated document).
25765 All definitions starting with underscore only will be translated to the GUI language.
25766 This is the proper translation for strings that only occur in the dialogs or on buttons,
25770 \begin_layout LyX-Code
25771 _addtobib Add to bibliography only.
25774 \begin_layout Standard
25775 Several of these translatable strings are predefined in
25776 \begin_inset Flex Code
25779 \begin_layout Plain Layout
25786 \begin_inset Flex Code
25789 \begin_layout Plain Layout
25796 Note that these are not macros,
25797 in the sense just defined.
25798 They will not be expanded.
25801 \begin_layout Standard
25802 So here then is an example that uses several of these features:
25803 \begin_inset VSpace defskip
25809 \begin_layout Standard
25813 !authoredit {%author%[[%author%,
25814 ]][[{%editor%[[%editor%,
25819 \begin_layout Standard
25820 \begin_inset VSpace defskip
25823 This defines a macro that prints the author,
25824 followed by a comma,
25826 \begin_inset Flex Code
25829 \begin_layout Plain Layout
25836 or else prints the name of the editor,
25838 \begin_inset Flex Code
25841 \begin_layout Plain Layout
25847 or its translation (it is by default
25848 \begin_inset Quotes eld
25852 \begin_inset Quotes erd
25857 \begin_inset Flex Code
25860 \begin_layout Plain Layout
25867 Note that this is in fact defined in
25868 \begin_inset Flex Code
25871 \begin_layout Plain Layout
25878 so you can use it in your own definitions,
25880 if you load that file first.
25883 \begin_layout Section
25884 \begin_inset CommandInset label
25886 name "sec:Tags-for-XHTML"
25890 Tags for XHTML output
25893 \begin_layout Standard
25894 As with \SpecialChar LaTeX
25896 the format of \SpecialChar LyX
25897 's XHTML output is also controlled by layout information.
25900 provides sensible defaults and,
25901 as mentioned earlier,
25902 it will even construct default CSS style rules from the other layout tags.
25905 will attempt to use the information provided in the
25906 \begin_inset Flex Code
25909 \begin_layout Plain Layout
25915 declaration for the Chapter style to write CSS that will appropriately format chapter headings.
25918 \begin_layout Standard
25921 you may not have to do anything at all to get acceptable XHTML output for your own environments,
25924 But in some cases you will,
25925 and so \SpecialChar LyX
25926 provides a number of layout tags that can be used to customize the XHTML and CSS that are generated.
25929 \begin_layout Standard
25930 Note that there are two tags,
25932 \begin_inset Flex Code
25935 \begin_layout Plain Layout
25942 \begin_inset Flex Code
25945 \begin_layout Plain Layout
25951 that may appear outside style and inset declarations.
25953 \begin_inset CommandInset ref
25955 reference "subsec:General-text-class"
25960 for details on these.
25963 \begin_layout Subsection
25964 \begin_inset CommandInset label
25966 name "subsec:Paragraph-Style-XHTML"
25973 \begin_layout Standard
25974 The sort of XHTML \SpecialChar LyX
25975 outputs for a paragraph depends upon whether we are dealing with a normal paragraph,
25978 where this is itself determined by the contents of the corresponding
25979 \begin_inset Flex Code
25982 \begin_layout Plain Layout
25993 \begin_layout Standard
25994 For a command or normal paragraph,
25995 the output XHTML has the following form:
25998 \begin_layout LyX-Code
26002 \begin_inset Quotes erd
26006 \begin_inset Quotes erd
26012 \begin_layout LyX-Code
26016 \begin_inset Quotes erd
26020 \begin_inset Quotes erd
26026 \begin_layout LyX-Code
26029 Contents of the paragraph.
26032 \begin_layout LyX-Code
26038 \begin_layout Standard
26039 The label tags are of course omitted if the paragraph does not have a label.
26042 \begin_layout Standard
26043 For an environment that is not some sort of list,
26044 the XHTML takes this form:
26047 \begin_layout LyX-Code
26051 \begin_inset Quotes erd
26055 \begin_inset Quotes erd
26061 \begin_layout LyX-Code
26065 \begin_inset Quotes erd
26069 \begin_inset Quotes erd
26073 \begin_inset Quotes erd
26077 \begin_inset Quotes erd
26080 >Environment Label</labeltag>First paragraph.</itemtag>
26083 \begin_layout LyX-Code
26086 <itemtag>Second paragraph.</itemtag>
26089 \begin_layout LyX-Code
26095 \begin_layout Standard
26096 Note that the label is output only for the first paragraph,
26097 as it should be for a theorem,
26102 \begin_layout Standard
26104 we have one of these forms:
26107 \begin_layout LyX-Code
26111 \begin_inset Quotes erd
26115 \begin_inset Quotes erd
26121 \begin_layout LyX-Code
26125 \begin_inset Quotes erd
26129 \begin_inset Quotes erd
26133 \begin_inset Quotes erd
26137 \begin_inset Quotes erd
26140 >List Label</labeltag>First item.</itemtag>
26143 \begin_layout LyX-Code
26147 \begin_inset Quotes erd
26151 \begin_inset Quotes erd
26155 \begin_inset Quotes erd
26159 \begin_inset Quotes erd
26162 >List Label</labeltag>Second item.</itemtag>
26165 \begin_layout LyX-Code
26171 \begin_layout LyX-Code
26175 \begin_layout LyX-Code
26179 \begin_inset Quotes erd
26183 \begin_inset Quotes erd
26189 \begin_layout LyX-Code
26193 \begin_inset Quotes erd
26197 \begin_inset Quotes erd
26200 >List Label</labeltag><itemtag attr=
26201 \begin_inset Quotes erd
26205 \begin_inset Quotes erd
26208 >First item.</itemtag>
26211 \begin_layout LyX-Code
26215 \begin_inset Quotes erd
26219 \begin_inset Quotes erd
26222 >List Label</labeltag><itemtag attr=
26223 \begin_inset Quotes erd
26227 \begin_inset Quotes erd
26230 >Second item.</itemtag>
26233 \begin_layout LyX-Code
26239 \begin_layout Standard
26240 Note the different orders of
26241 \begin_inset Flex Code
26244 \begin_layout Plain Layout
26251 \begin_inset Flex Code
26254 \begin_layout Plain Layout
26261 Which order we get depends upon the setting of
26262 \begin_inset Flex Code
26265 \begin_layout Plain Layout
26273 \begin_inset Flex Code
26276 \begin_layout Plain Layout
26282 is false (the default),
26283 you get the first of these,
26284 with the label within the item;
26286 you get the second,
26287 with the label outside the item.
26290 \begin_layout Standard
26291 The specific tags and attributes output for each paragraph type can be controlled by means of the layout tags we are about to describe.
26292 As mentioned earlier,
26295 uses sensible defaults for many of these,
26296 so you often may not need to do very much to get good XHTML output.
26297 Think of the available tags as there so you can tweak things to your liking.
26300 \begin_layout Description
26301 \begin_inset Flex Code
26304 \begin_layout Plain Layout
26311 \begin_inset Flex Code
26314 \begin_layout Plain Layout
26320 ] Specifies attribute information to be output with the main tag.
26323 \begin_inset Quotes eld
26327 \begin_inset Flex Code
26330 \begin_layout Plain Layout
26337 \begin_inset Quotes erd
26344 \begin_inset Quotes eld
26348 \begin_inset Flex Code
26351 \begin_layout Plain Layout
26358 \begin_inset Quotes erd
26363 \begin_inset Flex Code
26366 \begin_layout Plain Layout
26372 is the \SpecialChar LyX
26373 name of the layout,
26381 contain any style information.
26383 \begin_inset Flex Code
26386 \begin_layout Plain Layout
26395 \begin_layout Description
26396 \begin_inset Flex Code
26399 \begin_layout Plain Layout
26406 \begin_inset Flex Code
26409 \begin_layout Plain Layout
26415 ] The CSS class to use for this paragraph.
26417 if the paragarph is of enumerate or itemize type,
26418 then the default will be
26419 \begin_inset Quotes eld
26423 \begin_inset Quotes erd
26427 \begin_inset Quotes eld
26431 \begin_inset Quotes erd
26436 \begin_inset Quotes eld
26440 \begin_inset Quotes erd
26445 \begin_inset Quotes eld
26449 \begin_inset Quotes erd
26454 \begin_inset Quotes eld
26458 \begin_inset Quotes erd
26463 \begin_inset Quotes eld
26467 \begin_inset Quotes erd
26471 depending upon the depth.
26472 That can be over-ridden here.
26474 the suffix will not be added in that case.
26476 the CSS class will always be exactly what it is declared to be here.
26479 \begin_layout Description
26480 \begin_inset Flex Code
26483 \begin_layout Plain Layout
26490 \begin_inset Flex Code
26493 \begin_layout Plain Layout
26503 ] Whether to output the default CSS information \SpecialChar LyX
26504 generates for this layout,
26505 even if additional information is explicitly provided via
26506 \begin_inset Flex Code
26509 \begin_layout Plain Layout
26517 \begin_inset Flex Code
26520 \begin_layout Plain Layout
26526 allows you to alter or augment the generated CSS,
26527 rather than to override it completely.
26529 \begin_inset Flex Code
26532 \begin_layout Plain Layout
26541 \begin_layout Description
26542 \begin_inset Flex Code
26545 \begin_layout Plain Layout
26552 \begin_inset Flex Code
26555 \begin_layout Plain Layout
26563 ] Whether to include this paragraph (usually,
26564 a section or something of the sort) in the TOC.
26567 so it should be set to false e.g.
26568 \begin_inset space ~
26571 for starred sections.
26574 \begin_layout Description
26575 \begin_inset Flex Code
26578 \begin_layout Plain Layout
26585 \begin_inset Flex Code
26588 \begin_layout Plain Layout
26594 ] The tag to be used for individual paragraphs of environments,
26596 \begin_inset Flex Code
26599 \begin_layout Plain Layout
26605 in the examples above.
26607 \begin_inset Flex Code
26610 \begin_layout Plain Layout
26619 \begin_layout Description
26620 \begin_inset Flex Code
26623 \begin_layout Plain Layout
26630 \begin_inset Flex Code
26633 \begin_layout Plain Layout
26639 ] Attributes for the item tag.
26641 \begin_inset Newline newline
26645 \begin_inset Quotes eld
26649 \begin_inset Flex Code
26652 \begin_layout Plain Layout
26653 class=`layoutname_item'
26659 \begin_inset Quotes erd
26667 contain any style information.
26669 \begin_inset Flex Code
26672 \begin_layout Plain Layout
26681 \begin_layout Description
26682 \begin_inset Flex Code
26685 \begin_layout Plain Layout
26692 \begin_inset Flex Code
26695 \begin_layout Plain Layout
26701 ] The tag to be used for paragraph and item labels,
26703 \begin_inset Flex Code
26706 \begin_layout Plain Layout
26712 in the examples above.
26714 \begin_inset Flex Code
26717 \begin_layout Plain Layout
26725 \begin_inset Flex Code
26728 \begin_layout Plain Layout
26735 \begin_inset Flex Code
26738 \begin_layout Plain Layout
26745 \begin_inset Flex Code
26748 \begin_layout Plain Layout
26749 Centered_Top_Environment
26755 in which case it defaults to
26756 \begin_inset Flex Code
26759 \begin_layout Plain Layout
26768 \begin_layout Description
26769 \begin_inset Flex Code
26772 \begin_layout Plain Layout
26779 \begin_inset Flex Code
26782 \begin_layout Plain Layout
26788 ] Attributes for the label tag.
26790 \begin_inset Newline newline
26794 \begin_inset Quotes eld
26798 \begin_inset Flex Code
26801 \begin_layout Plain Layout
26802 class=`layoutname_label'
26808 \begin_inset Quotes erd
26816 contain any style information.
26818 \begin_inset Flex Code
26821 \begin_layout Plain Layout
26830 \begin_layout Description
26831 \begin_inset Flex Code
26834 \begin_layout Plain Layout
26841 \begin_inset Flex Code
26844 \begin_layout Plain Layout
26854 ] Meaningful only for list-like environments,
26855 this tag controls whether the label tag is output before or inside the item tag.
26858 in the description environment,
26860 \begin_inset Flex Code
26863 \begin_layout Plain Layout
26864 <dt>\SpecialChar ldots
26865 </dt><dd>\SpecialChar ldots
26873 \begin_inset Flex Code
26876 \begin_layout Plain Layout
26883 The label tag is output inside the item tag.
26886 \begin_layout Description
26887 \begin_inset Flex Code
26890 \begin_layout Plain Layout
26896 Information to be output in the
26897 \begin_inset Flex Code
26900 \begin_layout Plain Layout
26906 section when this style is used.
26909 be used to include a
26910 \begin_inset Flex Code
26913 \begin_layout Plain Layout
26920 \begin_inset Flex Code
26923 \begin_layout Plain Layout
26932 \begin_layout Description
26933 \begin_inset Flex Code
26936 \begin_layout Plain Layout
26942 CSS style information to be included when this style is used.
26943 Note that this will automatically be wrapped in a layout-generated
26944 \begin_inset Flex Code
26947 \begin_layout Plain Layout
26954 so only the CSS itself need be included.
26956 \begin_inset Flex Code
26959 \begin_layout Plain Layout
26968 \begin_layout Description
26969 \begin_inset Flex Code
26972 \begin_layout Plain Layout
26979 \begin_inset Flex Code
26982 \begin_layout Plain Layout
26988 ] The tag to be used for the main label,
26990 \begin_inset Flex Code
26993 \begin_layout Plain Layout
26999 in the examples above.
27001 \begin_inset Flex Code
27004 \begin_layout Plain Layout
27013 \begin_layout Description
27014 \begin_inset Flex Code
27017 \begin_layout Plain Layout
27024 \begin_inset Flex Code
27027 \begin_layout Plain Layout
27037 ] Marks this style as the one to be used to generate the
27038 \begin_inset Flex Code
27041 \begin_layout Plain Layout
27047 tag for the XHTML file.
27051 \begin_inset Flex Code
27054 \begin_layout Plain Layout
27060 file sets it to true for the
27061 \begin_inset Flex Code
27064 \begin_layout Plain Layout
27074 \begin_layout Subsection
27078 \begin_layout Standard
27079 The XHTML output of insets can also be controlled by information in layout files.
27083 \begin_layout Plain Layout
27085 this is true only for
27086 \begin_inset Quotes eld
27090 \begin_inset Quotes erd
27093 insets (insets you can type into) and is not true for
27094 \begin_inset Quotes eld
27098 \begin_inset Quotes erd
27101 insets (insets that are associated with dialog boxes).
27109 tries to provide sensible defaults,
27110 and it constructs default CSS style rules.
27111 But everything can be customized.
27114 \begin_layout Standard
27115 The XHTML \SpecialChar LyX
27116 outputs for an inset has the following form:
27119 \begin_layout LyX-Code
27121 \begin_inset Quotes erd
27125 \begin_inset Quotes erd
27131 \begin_layout LyX-Code
27132 <labeltag>Label</labeltag>
27135 \begin_layout LyX-Code
27137 \begin_inset Quotes erd
27141 \begin_inset Quotes erd
27144 >Contents of the inset.</innertag>
27147 \begin_layout LyX-Code
27151 \begin_layout Standard
27152 If the inset permits multiple paragraphs—
27155 \begin_inset Flex Code
27158 \begin_layout Plain Layout
27165 then the contents of the inset will itself be output as paragraphs formatted according to the styles used for those paragraphs (standard,
27168 The label tag is of course omitted if the paragraph does not have a label and,
27171 \begin_inset Flex Code
27174 \begin_layout Plain Layout
27181 The inner tag is optional and,
27186 \begin_layout Standard
27187 The specific tags and attributes output for each inset can be controlled by means of the following layout tags.
27190 \begin_layout Description
27191 \begin_inset Flex Code
27194 \begin_layout Plain Layout
27201 \begin_inset Flex Code
27204 \begin_layout Plain Layout
27210 ] Specifies attribute information to be output with the main tag.
27213 \begin_inset Quotes eld
27217 \begin_inset Flex Code
27220 \begin_layout Plain Layout
27221 class=`myinset' onclick=`\SpecialChar ldots
27228 \begin_inset Quotes erd
27235 \begin_inset Quotes eld
27239 \begin_inset Flex Code
27242 \begin_layout Plain Layout
27249 \begin_inset Quotes erd
27254 \begin_inset Flex Code
27257 \begin_layout Plain Layout
27263 is the \SpecialChar LyX
27265 made lowercase and with non-alphanumeric characters converted to underscores,
27270 \begin_layout Description
27271 \begin_inset Flex Code
27274 \begin_layout Plain Layout
27281 \begin_inset Flex Code
27284 \begin_layout Plain Layout
27294 ] Whether to output the default CSS information \SpecialChar LyX
27295 generates for this layout,
27296 even if additional information is explicitly provided via
27297 \begin_inset Flex Code
27300 \begin_layout Plain Layout
27308 \begin_inset Flex Code
27311 \begin_layout Plain Layout
27317 allows you to alter or augment the generated CSS,
27318 rather than to override it completely.
27322 \begin_layout Description
27323 \begin_inset Flex Code
27326 \begin_layout Plain Layout
27333 \begin_inset Flex Code
27336 \begin_layout Plain Layout
27342 ] Attributes for the inner tag.
27344 \begin_inset Newline newline
27348 \begin_inset Quotes eld
27352 \begin_inset Flex Code
27355 \begin_layout Plain Layout
27356 class=`insetname_inner'
27362 \begin_inset Quotes erd
27368 \begin_layout Description
27369 \begin_inset Flex Code
27372 \begin_layout Plain Layout
27379 \begin_inset Flex Code
27382 \begin_layout Plain Layout
27390 \begin_inset Flex Code
27393 \begin_layout Plain Layout
27399 in the examples above.
27404 \begin_layout Description
27405 \begin_inset Flex Code
27408 \begin_layout Plain Layout
27415 \begin_inset Flex Code
27418 \begin_layout Plain Layout
27426 ] 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).
27430 \begin_layout Description
27431 \begin_inset Flex Code
27434 \begin_layout Plain Layout
27441 \begin_inset Flex Code
27444 \begin_layout Plain Layout
27450 ] A label for this inset,
27451 possibly including a reference to a counter.
27456 \begin_inset Flex Code
27459 \begin_layout Plain Layout
27469 and there is no default.
27472 \begin_layout Description
27473 \begin_inset Flex Code
27476 \begin_layout Plain Layout
27482 Information to be output in the
27483 \begin_inset Flex Code
27486 \begin_layout Plain Layout
27492 section when this style is used.
27495 be used to include a
27496 \begin_inset Flex Code
27499 \begin_layout Plain Layout
27506 \begin_inset Flex Code
27509 \begin_layout Plain Layout
27518 \begin_layout Description
27519 \begin_inset Flex Code
27522 \begin_layout Plain Layout
27528 CSS style information to be included when this style is used.
27529 Note that this will automatically be wrapped in a layout-generated
27530 \begin_inset Flex Code
27533 \begin_layout Plain Layout
27540 so only the CSS itself need be included.
27543 \begin_layout Description
27544 \begin_inset Flex Code
27547 \begin_layout Plain Layout
27554 \begin_inset Flex Code
27557 \begin_layout Plain Layout
27563 ] The tag to be used for the main label,
27565 \begin_inset Flex Code
27568 \begin_layout Plain Layout
27574 in the examples above.
27575 The default depends upon the setting of
27576 \begin_inset Flex Code
27579 \begin_layout Plain Layout
27587 \begin_inset Flex Code
27590 \begin_layout Plain Layout
27598 \begin_inset Flex Code
27601 \begin_layout Plain Layout
27610 \begin_inset Flex Code
27613 \begin_layout Plain Layout
27622 \begin_layout Subsection
27626 \begin_layout Standard
27627 The XHTML output for floats too can be controlled by layout information.
27628 The output has the following form:
27631 \begin_layout LyX-Code
27633 \begin_inset Quotes erd
27637 \begin_inset Quotes erd
27643 \begin_layout LyX-Code
27644 Contents of the float.
27647 \begin_layout LyX-Code
27651 \begin_layout Standard
27654 is a separate inset and will be output as such.
27655 Its appearance can be controlled via the InsetLayout for caption insets.
27659 \begin_layout Description
27660 \begin_inset Flex Code
27663 \begin_layout Plain Layout
27670 \begin_inset Flex Code
27673 \begin_layout Plain Layout
27679 ] Specifies attribute information to be output with the main tag.
27682 \begin_inset Quotes eld
27686 \begin_inset Flex Code
27689 \begin_layout Plain Layout
27690 class=`myfloat' onclick=`\SpecialChar ldots
27697 \begin_inset Quotes erd
27704 \begin_inset Quotes eld
27708 \begin_inset Flex Code
27711 \begin_layout Plain Layout
27712 class=`float float-floattype'
27718 \begin_inset Quotes erd
27723 \begin_inset Flex Code
27726 \begin_layout Plain Layout
27732 is \SpecialChar LyX
27733 's name for this type of float,
27734 as determined by the float declaration (see
27735 \begin_inset CommandInset ref
27737 reference "subsec:Floats"
27743 though made lowercase and with non-alphanumeric characters converted to underscores,
27748 \begin_layout Description
27749 \begin_inset Flex Code
27752 \begin_layout Plain Layout
27758 CSS style information to be included when this float is used.
27759 Note that this will automatically be wrapped in a layout-generated
27760 \begin_inset Flex Code
27763 \begin_layout Plain Layout
27770 so only the CSS itself need be included.
27773 \begin_layout Description
27774 \begin_inset Flex Code
27777 \begin_layout Plain Layout
27784 \begin_inset Flex Code
27787 \begin_layout Plain Layout
27793 ] The tag to be used for this float,
27795 \begin_inset Quotes eld
27799 \begin_inset Flex Code
27802 \begin_layout Plain Layout
27809 \begin_inset Quotes erd
27812 in the example above.
27814 \begin_inset Flex Code
27817 \begin_layout Plain Layout
27823 and will rarely need changing.
27826 \begin_layout Subsection
27827 Bibliography formatting
27830 \begin_layout Standard
27831 The bibliography can be formatted using
27832 \begin_inset Flex Code
27835 \begin_layout Plain Layout
27843 \begin_inset CommandInset ref
27845 reference "subsec:Citation-format-description"
27853 \begin_layout Subsection
27858 \begin_layout Standard
27859 We have several times mentioned that \SpecialChar LyX
27860 will generate default CSS style rules for both insets and paragraph styles,
27861 based upon the other layout information that is provided.
27863 we shall say a word about which layout information \SpecialChar LyX
27867 \begin_layout Standard
27870 auto-generates CSS only for font information,
27872 \begin_inset Flex Code
27875 \begin_layout Plain Layout
27883 \begin_inset Flex Code
27886 \begin_layout Plain Layout
27894 \begin_inset Flex Code
27897 \begin_layout Plain Layout
27905 \begin_inset Flex Code
27908 \begin_layout Plain Layout
27915 \begin_inset Flex Code
27918 \begin_layout Plain Layout
27925 \begin_inset CommandInset ref
27927 reference "subsec:Font-description"
27933 The translation is mostly straightforward and obvious.
27936 \begin_inset Quotes eld
27940 \begin_inset Flex Code
27943 \begin_layout Plain Layout
27950 \begin_inset Quotes erd
27954 \begin_inset Quotes eld
27958 \begin_inset Flex Code
27961 \begin_layout Plain Layout
27969 \begin_inset Quotes erd
27973 The correspondence of \SpecialChar LyX
27974 sizes and CSS sizes is a little less obvious but nonetheless intuitive.
27976 \begin_inset Flex Code
27979 \begin_layout Plain Layout
27986 \begin_inset Flex URL
27989 \begin_layout Plain Layout
27999 \begin_layout Section
28000 \begin_inset CommandInset label
28002 name "sec:Tags-for-DocBook"
28006 Tags for DocBook output
28009 \begin_layout Standard
28010 As with \SpecialChar LaTeX
28012 the format of \SpecialChar LyX
28013 's DocBook output is also controlled by layout information.
28016 provides sensible defaults;
28018 much of the styling is lost during the conversion,
28019 as DocBook is strictly semantic and does not allow formatting.
28021 information from \SpecialChar LyX
28022 will be rendered in
28029 \begin_layout Standard
28032 you may not have to do anything at all to get acceptable DocBook output for your own environments,
28035 But in some cases you will,
28036 and so \SpecialChar LyX
28037 provides a number of layout tags that can be used to customize the DocBook that is generated.
28040 \begin_layout Standard
28041 Labels are rarely output,
28042 as they are redundant in DocBook:
28043 this information is carried by the tags themselves,
28044 and whether labels appear in the final documents (after processing of DocBook files) is controlled by the stylesheets.
28047 labels are not redundant content,
28048 such as definition lists:
28050 the term being defined will be the label.
28053 \begin_layout Subsection
28054 \begin_inset CommandInset label
28056 name "subsec:Paragraph-Style-DocBook"
28063 \begin_layout Standard
28064 The sort of DocBook \SpecialChar LyX
28065 outputs for a paragraph depends upon whether we are dealing with a normal paragraph,
28068 where this is itself determined by the contents of the corresponding
28069 \begin_inset Flex Code
28072 \begin_layout Plain Layout
28082 \begin_layout Standard
28083 For a command or normal paragraph,
28084 the output DocBook has the following form:
28087 \begin_layout LyX-Code
28091 \begin_layout LyX-Code
28092 Contents of the paragraph.
28095 \begin_layout LyX-Code
28099 \begin_layout Standard
28100 For an environment that is not some sort of list,
28101 the generated DocBook takes this form:
28104 \begin_layout LyX-Code
28108 \begin_layout LyX-Code
28109 <itemtag>First paragraph.</itemtag>
28112 \begin_layout LyX-Code
28113 <itemtag>Second paragraph.</itemtag>
28116 \begin_layout LyX-Code
28120 \begin_layout Standard
28122 the resulting DocBook takes this form:
28125 \begin_layout LyX-Code
28129 \begin_layout LyX-Code
28130 <itemtag attr>First item.</itemtag>
28133 \begin_layout LyX-Code
28134 <itemtag attr>Second item.</itemtag>
28137 \begin_layout LyX-Code
28141 \begin_layout Standard
28142 The specific tags and roles output for each paragraph type can be controlled by means of the layout tags we are about to describe.
28144 due to the very nature of DocBook,
28145 no sensible defaults really exist,
28146 and the values must always be carefully chosen.
28149 \begin_layout Description
28150 \begin_inset Flex Code
28153 \begin_layout Plain Layout
28160 \begin_inset Flex Code
28163 \begin_layout Plain Layout
28169 ] Specifies attribute information to be output with the main tag,
28171 \begin_inset Quotes eld
28175 \begin_inset Flex Code
28178 \begin_layout Plain Layout
28185 \begin_inset Quotes erd
28188 in the example above.
28189 This information can be used in further processing of the DocBook files.
28192 \begin_layout Description
28193 \begin_inset Flex Code
28196 \begin_layout Plain Layout
28203 \begin_inset Flex Code
28206 \begin_layout Plain Layout
28212 ] The tag to be used for this inset,
28214 \begin_inset Quotes eld
28218 \begin_inset Flex Code
28221 \begin_layout Plain Layout
28228 \begin_inset Quotes erd
28231 in the example above.
28232 The default is the name of the float and always needs to be changed,
28233 as DocBook provides no generic tag.
28236 \begin_layout Description
28237 \begin_inset Flex Code
28240 \begin_layout Plain Layout
28247 \begin_inset Flex Code
28250 \begin_layout Plain Layout
28258 ] The new-line policy for this tag,
28260 \begin_inset space ~
28264 \begin_inset CommandInset ref
28266 reference "subsec:DocBook-New-line-policy"
28277 \begin_layout Subsection
28279 \begin_inset CommandInset label
28281 name "subsec:DocBook-New-line-policy"
28288 \begin_layout Standard
28290 there are three possible policies for outputting new lines (given in the
28291 \begin_inset Flex Code
28294 \begin_layout Plain Layout
28303 \begin_layout Itemize
28304 \begin_inset Quotes eld
28308 \begin_inset Flex Code
28311 \begin_layout Plain Layout
28318 \begin_inset Quotes erd
28322 the opening and closing tags are on their own lines (i.e.
28323 a line feed after and before the opening and the closing tags).
28324 Typical elements are floats.
28328 \begin_layout LyX-Code
28332 \begin_layout LyX-Code
28336 \begin_layout LyX-Code
28337 Contents of the block.
28340 \begin_layout LyX-Code
28344 \begin_layout LyX-Code
28348 \begin_layout Itemize
28349 \begin_inset Quotes eld
28353 \begin_inset Flex Code
28356 \begin_layout Plain Layout
28363 \begin_inset Quotes erd
28367 the opening and closing tags are on the same,
28369 a line feed is output before the opening tag and after the closing tag.
28370 Typical elements are paragraphs and list items.
28374 \begin_layout LyX-Code
28378 \begin_layout LyX-Code
28379 <paratag>Contents of the paragraph.</paratag>
28382 \begin_layout LyX-Code
28386 \begin_layout Itemize
28387 \begin_inset Quotes eld
28391 \begin_inset Flex Code
28394 \begin_layout Plain Layout
28401 \begin_inset Quotes erd
28405 the opening and closing tags are on the same line as the rest of the content.
28406 No line feeds are output.
28407 Typical elements are fonts.
28411 \begin_layout LyX-Code
28412 Content before<inlinetag>Contents of the paragraph.</inlinetag>Content after
28415 \begin_layout Standard
28416 The default value is always
28417 \begin_inset Quotes eld
28421 \begin_inset Flex Code
28424 \begin_layout Plain Layout
28431 \begin_inset Quotes erd
28437 \begin_layout Subsection
28438 InsetLayout DocBook
28441 \begin_layout Standard
28442 The DocBook output of insets can also be controlled by information in layout files.
28445 \begin_layout Standard
28446 The DocBook \SpecialChar LyX
28447 outputs for an inset has the following form:
28450 \begin_layout LyX-Code
28451 <wrappertag wrapperattr>
28454 \begin_layout LyX-Code
28458 \begin_layout LyX-Code
28459 <innertag innerattr>
28462 \begin_layout LyX-Code
28463 Contents of the inset.
28466 \begin_layout LyX-Code
28470 \begin_layout LyX-Code
28474 \begin_layout LyX-Code
28478 \begin_layout Standard
28479 For an itemising inset,
28480 it rather looks like this:
28483 \begin_layout LyX-Code
28484 <wrappertag wrapperattr>
28487 \begin_layout LyX-Code
28491 \begin_layout LyX-Code
28492 <innertag innerattr>
28495 \begin_layout LyX-Code
28496 <itemwrappertag itemwrapperattr>
28499 \begin_layout LyX-Code
28500 <itemlabeltag itemattr>
28503 \begin_layout LyX-Code
28504 Label of the first item.
28507 \begin_layout LyX-Code
28511 \begin_layout LyX-Code
28515 \begin_layout LyX-Code
28519 \begin_layout LyX-Code
28520 Contents of the first item.
28523 \begin_layout LyX-Code
28527 \begin_layout LyX-Code
28531 \begin_layout LyX-Code
28535 \begin_layout LyX-Code
28536 <itemwrappertag itemwrapperattr>
28539 \begin_layout LyX-Code
28540 <itemlabeltag itemattr>
28543 \begin_layout LyX-Code
28544 Label of the second item.
28547 \begin_layout LyX-Code
28551 \begin_layout LyX-Code
28555 \begin_layout LyX-Code
28559 \begin_layout LyX-Code
28560 Contents of the second item.
28563 \begin_layout LyX-Code
28567 \begin_layout LyX-Code
28571 \begin_layout LyX-Code
28575 \begin_layout LyX-Code
28579 \begin_layout LyX-Code
28583 \begin_layout LyX-Code
28587 \begin_layout LyX-Code
28591 \begin_layout Standard
28592 If the inset permits multiple paragraphs—
28595 \begin_inset Flex Code
28598 \begin_layout Plain Layout
28605 then the contents of the inset will themselves be output as paragraphs formatted according to the styles used for those paragraphs (standard,
28608 The inner tag is optional and,
28613 \begin_layout Standard
28614 The specific tags and attributes output for each inset can be controlled by means of the following layout tags.
28617 \begin_layout Description
28618 \begin_inset Flex Code
28621 \begin_layout Plain Layout
28628 \begin_inset Flex Code
28631 \begin_layout Plain Layout
28637 ] Specifies attribute information to be output with the main tag,
28639 \begin_inset Quotes eld
28643 \begin_inset Flex Code
28646 \begin_layout Plain Layout
28653 \begin_inset Quotes erd
28656 in the example above.
28657 This information can be used in further processing of the DocBook files.
28660 \begin_layout Description
28661 \begin_inset Flex Code
28664 \begin_layout Plain Layout
28671 \begin_inset Flex Code
28674 \begin_layout Plain Layout
28682 ] Specifies whether this tag goes into the
28683 \begin_inset Flex Code
28686 \begin_layout Plain Layout
28692 tag at the beginning of the parent layout.
28694 \begin_inset Flex Code
28697 \begin_layout Plain Layout
28703 indicates that the tag never goes into
28704 \begin_inset Flex Code
28707 \begin_layout Plain Layout
28713 (this is default value,
28714 and corresponds to usual content).
28716 \begin_inset Flex Code
28719 \begin_layout Plain Layout
28725 indicates that the tag always goes into
28726 \begin_inset Flex Code
28729 \begin_layout Plain Layout
28735 (this corresponds to usual metadata):
28737 \begin_inset Flex Code
28740 \begin_layout Plain Layout
28746 tag for the parent,
28753 \begin_inset Flex Code
28756 \begin_layout Plain Layout
28762 indicates that the tag may go into
28763 \begin_inset Flex Code
28766 \begin_layout Plain Layout
28772 (this is only the case for titles):
28774 \begin_inset Flex Code
28777 \begin_layout Plain Layout
28783 tag for the parent,
28789 the corresponding tag will be output directly as content.
28792 \begin_layout Description
28793 \begin_inset Flex Code
28796 \begin_layout Plain Layout
28803 \begin_inset Flex Code
28806 \begin_layout Plain Layout
28812 ] Specifies attribute information to be output with the item tag,
28814 \begin_inset Quotes eld
28818 \begin_inset Flex Code
28821 \begin_layout Plain Layout
28828 \begin_inset Quotes erd
28831 in the example above.
28832 This information can be used in further processing of the DocBook files.
28835 \begin_layout Description
28836 \begin_inset Flex Code
28839 \begin_layout Plain Layout
28840 DocBookItemInnerAttr
28846 \begin_inset Flex Code
28849 \begin_layout Plain Layout
28855 ] Specifies attribute information to be output with the item inner tag,
28857 \begin_inset Quotes eld
28861 \begin_inset Flex Code
28864 \begin_layout Plain Layout
28871 \begin_inset Quotes erd
28874 in the example above.
28875 This information can be used in further processing of the DocBook files.
28878 \begin_layout Description
28879 \begin_inset Flex Code
28882 \begin_layout Plain Layout
28883 DocBookItemInnerTag
28889 \begin_inset Flex Code
28892 \begin_layout Plain Layout
28898 ] The tag to be used for the item inner tag within the inset,
28900 \begin_inset Quotes eld
28904 \begin_inset Flex Code
28907 \begin_layout Plain Layout
28914 \begin_inset Quotes erd
28917 in the example above.
28919 \begin_inset Flex Code
28922 \begin_layout Plain Layout
28929 indicating that there is no item inner tag:
28930 content is directly output without it for each itemised element.
28931 This parameter only makes sense when itemising layouts are used,
28933 The most likely value is
28934 \begin_inset Quotes eld
28938 \begin_inset Flex Code
28941 \begin_layout Plain Layout
28948 \begin_inset Quotes erd
28952 \begin_inset Newline newline
28955 When a list item is split using a new line,
28956 the item inner tag will be repeated for each part of the paragraph,
28957 parts being separated by new lines.
28960 \begin_layout Description
28961 \begin_inset Flex Code
28964 \begin_layout Plain Layout
28965 DocBookItemInnerTagType
28971 \begin_inset Flex Code
28974 \begin_layout Plain Layout
28982 ] The new-line policy for this tag,
28984 \begin_inset space ~
28988 \begin_inset CommandInset ref
28990 reference "subsec:DocBook-New-line-policy"
29001 \begin_layout Description
29002 \begin_inset Flex Code
29005 \begin_layout Plain Layout
29006 DocBookItemLabelAttr
29012 \begin_inset Flex Code
29015 \begin_layout Plain Layout
29021 ] Specifies attribute information to be output with the item label tag,
29023 \begin_inset Quotes eld
29027 \begin_inset Flex Code
29030 \begin_layout Plain Layout
29037 \begin_inset Quotes erd
29040 in the example above.
29041 This information can be used in further processing of the DocBook files.
29044 \begin_layout Description
29045 \begin_inset Flex Code
29048 \begin_layout Plain Layout
29049 DocBookItemLabelTag
29055 \begin_inset Flex Code
29058 \begin_layout Plain Layout
29064 ] The tag to be used for the item label tag within the inset,
29066 \begin_inset Quotes eld
29070 \begin_inset Flex Code
29073 \begin_layout Plain Layout
29080 \begin_inset Quotes erd
29083 in the example above.
29084 This parameter only makes sense when itemising layouts are used with a notion of labels,
29085 such as definition lists.
29088 \begin_layout Description
29089 \begin_inset Flex Code
29092 \begin_layout Plain Layout
29093 DocBookItemLabelTagType
29099 \begin_inset Flex Code
29102 \begin_layout Plain Layout
29110 ] The new-line policy for this tag,
29112 \begin_inset space ~
29116 \begin_inset CommandInset ref
29118 reference "subsec:DocBook-New-line-policy"
29129 \begin_layout Description
29130 \begin_inset Flex Code
29133 \begin_layout Plain Layout
29140 \begin_inset Flex Code
29143 \begin_layout Plain Layout
29149 ] The tag to be used for the item tag within the inset,
29151 \begin_inset Quotes eld
29155 \begin_inset Flex Code
29158 \begin_layout Plain Layout
29165 \begin_inset Quotes erd
29168 in the example above.
29170 \begin_inset Flex Code
29173 \begin_layout Plain Layout
29180 indicating that there is no item tag.
29181 This parameter only makes sense when itemising layouts are used,
29185 \begin_layout Description
29186 \begin_inset Flex Code
29189 \begin_layout Plain Layout
29196 \begin_inset Flex Code
29199 \begin_layout Plain Layout
29207 ] The new-line policy for this tag,
29209 \begin_inset space ~
29213 \begin_inset CommandInset ref
29215 reference "subsec:DocBook-New-line-policy"
29226 \begin_layout Description
29227 \begin_inset Flex Code
29230 \begin_layout Plain Layout
29231 DocBookItemWrapperAttr
29237 \begin_inset Flex Code
29240 \begin_layout Plain Layout
29246 ] Specifies attribute information to be output with the item wrapper tag,
29248 \begin_inset Quotes eld
29252 \begin_inset Flex Code
29255 \begin_layout Plain Layout
29262 \begin_inset Quotes erd
29265 in the example above.
29266 This information can be used in further processing of the DocBook files.
29269 \begin_layout Description
29270 \begin_inset Flex Code
29273 \begin_layout Plain Layout
29274 DocBookItemWrapperTag
29280 \begin_inset Flex Code
29283 \begin_layout Plain Layout
29289 ] The tag to be used for the item wrapper tag within the inset,
29291 \begin_inset Quotes eld
29295 \begin_inset Flex Code
29298 \begin_layout Plain Layout
29305 \begin_inset Quotes erd
29308 in the example above.
29310 \begin_inset Flex Code
29313 \begin_layout Plain Layout
29320 indicating that there is no item wrapper tag:
29321 tag and content are directly output without it for each itemised element.
29322 This parameter only makes sense when itemising layouts are used,
29326 \begin_layout Description
29327 \begin_inset Flex Code
29330 \begin_layout Plain Layout
29331 DocBookItemWrapperTagType
29337 \begin_inset Flex Code
29340 \begin_layout Plain Layout
29348 ] The new-line policy for this tag,
29350 \begin_inset space ~
29354 \begin_inset CommandInset ref
29356 reference "subsec:DocBook-New-line-policy"
29367 \begin_layout Description
29368 \begin_inset Flex Code
29371 \begin_layout Plain Layout
29378 \begin_inset Flex Code
29381 \begin_layout Plain Layout
29387 ] Specifies attribute information to be output with the inner tag,
29389 \begin_inset Quotes eld
29393 \begin_inset Flex Code
29396 \begin_layout Plain Layout
29403 \begin_inset Quotes erd
29406 in the example above.
29407 This information can be used in further processing of the DocBook files.
29410 \begin_layout Description
29411 \begin_inset Flex Code
29414 \begin_layout Plain Layout
29421 \begin_inset Flex Code
29424 \begin_layout Plain Layout
29430 ] The tag to be used for the inner tag within the inset,
29432 \begin_inset Quotes eld
29436 \begin_inset Flex Code
29439 \begin_layout Plain Layout
29446 \begin_inset Quotes erd
29449 in the example above.
29451 \begin_inset Flex Code
29454 \begin_layout Plain Layout
29461 indicating that there is no inner tag:
29462 content is directly output without it.
29465 \begin_layout Description
29466 \begin_inset Flex Code
29469 \begin_layout Plain Layout
29470 DocBookInnerTagType
29476 \begin_inset Flex Code
29479 \begin_layout Plain Layout
29487 ] The new-line policy for this tag,
29489 \begin_inset space ~
29493 \begin_inset CommandInset ref
29495 reference "subsec:DocBook-New-line-policy"
29506 \begin_layout Description
29507 \begin_inset Flex Code
29510 \begin_layout Plain Layout
29517 \begin_inset Flex Code
29520 \begin_layout Plain Layout
29526 ] Specifies the tag that corresponds to this kind of section.
29527 This parameter only makes sense for sectioning elements (part,
29531 The default value is
29532 \begin_inset Flex Code
29535 \begin_layout Plain Layout
29542 and is only overridden when DocBook uses something else for sectioning (typically,
29543 parts and chapters of a book).
29546 \begin_layout Description
29547 \begin_inset Flex Code
29550 \begin_layout Plain Layout
29557 \begin_inset Flex Code
29560 \begin_layout Plain Layout
29566 ] The tag to be used for this inset,
29568 \begin_inset Quotes eld
29572 \begin_inset Flex Code
29575 \begin_layout Plain Layout
29582 \begin_inset Quotes erd
29585 in the example above.
29586 The default is the name of the float and always needs to be changed,
29587 as DocBook provides no generic inset tag.
29590 \begin_layout Description
29591 \begin_inset Flex Code
29594 \begin_layout Plain Layout
29601 \begin_inset Flex Code
29604 \begin_layout Plain Layout
29612 ] The new-line policy for this tag,
29614 \begin_inset space ~
29618 \begin_inset CommandInset ref
29620 reference "subsec:DocBook-New-line-policy"
29631 \begin_layout Description
29632 \begin_inset Flex Code
29635 \begin_layout Plain Layout
29642 \begin_inset Flex Code
29645 \begin_layout Plain Layout
29651 ] Specifies attribute information to be output with the outer wrapper tag,
29653 \begin_inset Quotes eld
29657 \begin_inset Flex Code
29660 \begin_layout Plain Layout
29667 \begin_inset Quotes erd
29670 in the example above.
29671 This information can be used in further processing of the DocBook files.
29674 \begin_layout Description
29675 \begin_inset Flex Code
29678 \begin_layout Plain Layout
29685 \begin_inset Flex Code
29688 \begin_layout Plain Layout
29694 ] The tag to be used for the wrapper tag around the inset,
29696 \begin_inset Quotes eld
29700 \begin_inset Flex Code
29703 \begin_layout Plain Layout
29710 \begin_inset Quotes erd
29713 in the example above.
29715 \begin_inset Flex Code
29718 \begin_layout Plain Layout
29725 indicating that there is no wrapper tag:
29726 tag and content are directly output without it.
29729 \begin_layout Description
29730 \begin_inset Flex Code
29733 \begin_layout Plain Layout
29734 DocBookWrapperTagType
29740 \begin_inset Flex Code
29743 \begin_layout Plain Layout
29751 ] The new-line policy for this tag,
29753 \begin_inset space ~
29757 \begin_inset CommandInset ref
29759 reference "subsec:DocBook-New-line-policy"
29770 \begin_layout Subsection
29774 \begin_layout Standard
29775 The DocBook output for floats too can be controlled by layout information.
29776 The output has the following form:
29779 \begin_layout LyX-Code
29783 \begin_layout LyX-Code
29784 Contents of the float as DocBook.
29787 \begin_layout LyX-Code
29791 \begin_layout Standard
29794 is a separate inset and will be output as a title.
29797 \begin_layout Description
29798 \begin_inset Flex Code
29801 \begin_layout Plain Layout
29808 \begin_inset Flex Code
29811 \begin_layout Plain Layout
29817 ] Specifies attribute information to be output with the main tag,
29819 \begin_inset Quotes eld
29823 \begin_inset Flex Code
29826 \begin_layout Plain Layout
29833 \begin_inset Quotes erd
29836 in the example above.
29837 This information can be used in further processing of the DocBook files.
29840 \begin_layout Description
29841 \begin_inset Flex Code
29844 \begin_layout Plain Layout
29851 \begin_inset Flex Code
29854 \begin_layout Plain Layout
29860 ] The tag to be used for this float,
29862 \begin_inset Quotes eld
29866 \begin_inset Flex Code
29869 \begin_layout Plain Layout
29876 \begin_inset Quotes erd
29879 in the example above.
29880 The default is the name of the float and always needs to be changed,
29881 as DocBook provides no generic float tag.
29884 \begin_layout Subsection
29885 Bibliography formatting
29888 \begin_layout Standard
29889 Included bibliographies cannot be formatted:
29890 all fields are always output in the database-like DocBook format (equivalent to a BibTeX file),
29892 \begin_inset Flex Code
29895 \begin_layout Plain Layout
29904 \begin_layout Standard
29905 When the bibliographic entries are manually inserted into the \SpecialChar LyX
29906 document as Bibliography Items,
29907 the user deals with formatting themself:
29908 there is no attempt of parsing what the user wrote,
29909 the string is directly used (with the
29910 \begin_inset Flex Code
29913 \begin_layout Plain Layout
29922 \begin_layout Chapter
29923 Including External Material
29924 \begin_inset CommandInset label
29926 name "chap:Including-External-Material"
29933 \begin_layout Standard
29934 \begin_inset Box Shadowbox
29944 height_special "totalheight"
29949 backgroundcolor "none"
29952 \begin_layout Plain Layout
29954 This portion of the documentation has not been updated for some time.
29955 We certainly hope that it is still accurate,
29956 but there are no guarantees.
29964 \begin_layout Standard
29965 The use of material from sources external to \SpecialChar LyX
29966 is covered in detail in the
29971 This part of the manual covers what needs to happen behind the scenes for new sorts of material to be included.
29974 \begin_layout Section
29978 \begin_layout Standard
29979 The external material feature is based on the concept of a
29984 A template is a specification of how \SpecialChar LyX
29985 should interface with a certain kind of material.
29988 comes with predefined templates for Xfig figures,
29989 various raster format images,
29991 and LilyPond music notation.
29992 You can check the actual list by using the menu
29993 \begin_inset Flex Noun
29996 \begin_layout Plain Layout
29997 Insert\SpecialChar menuseparator
29998 File\SpecialChar menuseparator
30006 it is possible to roll your own template to support a specific kind of material.
30007 Later we'll describe in more detail what is involved,
30008 and hopefully you will submit all the templates you create so we can include them in a later \SpecialChar LyX
30012 \begin_layout Standard
30013 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.
30015 consider the case of a figure produced with
30016 \begin_inset Flex Code
30019 \begin_layout Plain Layout
30026 The Xfig application itself works on an original file with the
30027 \begin_inset Flex Code
30030 \begin_layout Plain Layout
30038 you create and change your figure,
30039 and when you are done,
30041 \begin_inset Flex Code
30044 \begin_layout Plain Layout
30051 When you want to include the figure in your document,
30053 \begin_inset Flex Code
30056 \begin_layout Plain Layout
30062 in order to create a PostScript file that can readily be included in your \SpecialChar LaTeX
30066 \begin_inset Flex Code
30069 \begin_layout Plain Layout
30075 file is the original file,
30076 and the PostScript file is the produced file.
30079 \begin_layout Standard
30080 This distinction is important in order to allow updating of the material while you are in the process of writing the document.
30082 it provides us with the flexibility that is needed to support multiple export formats.
30084 in the case of a plain text file,
30085 it is not exactly an award-winning idea to include the figure as raw PostScript.
30087 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.
30088 The external material management allows you to do this,
30089 because it is parametrized on the different export formats that \SpecialChar LyX
30093 \begin_layout Standard
30094 Besides supporting the production of different products according to the exported format,
30095 it supports tight integration with editing and viewing applications.
30096 In the case of an Xfig figure,
30097 you are able to invoke Xfig on the original file with a single click from within the external material dialog in \SpecialChar LyX
30099 and also preview the produced PostScript file with Ghostview with another click.
30100 No more fiddling around with the command line and/or file browsers to locate and manipulate the original or produced files.
30102 you are finally able to take full advantage of the many different applications that are relevant to use when you write your documents,
30103 and ultimately be more productive.
30106 \begin_layout Section
30107 The external template configuration files
30110 \begin_layout Standard
30111 It is relatively easy to add custom external template definitions to \SpecialChar LyX
30114 be aware that doing this in an careless manner most probably
30118 introduce an easily exploitable security hole.
30119 So before you do this,
30120 please read the discussion about security in
30121 \begin_inset CommandInset ref
30123 reference "sec:Security-discussion"
30131 \begin_layout Standard
30133 we encourage you to submit any interesting templates that you create.
30137 \begin_layout Standard
30138 The external templates are defined in the
30139 \begin_inset Flex Code
30142 \begin_layout Plain Layout
30148 files that are stored in the
30149 \begin_inset Flex Code
30152 \begin_layout Plain Layout
30153 LyXDir/lib/xtemplates/
30159 Each template is defined in a file of its own.
30160 You can place your own templates in
30161 \begin_inset Flex Code
30164 \begin_layout Plain Layout
30165 UserDir/xtemplates/
30170 or copy existing templates to that directory in order to modify them.
30173 \begin_layout Standard
30174 A typical template looks like this:
30177 \begin_layout LyX-Code
30181 \begin_layout LyX-Code
30183 $$AbsOrRelPathParent$$Basename"
30186 \begin_layout LyX-Code
30190 \begin_layout LyX-Code
30194 \begin_layout LyX-Code
30198 \begin_layout LyX-Code
30202 \begin_layout LyX-Code
30206 \begin_layout LyX-Code
30207 AutomaticProduction true
30210 \begin_layout LyX-Code
30214 \begin_layout LyX-Code
30218 \begin_layout LyX-Code
30222 \begin_layout LyX-Code
30223 TransformCommand Rotate RotationLatexCommand
30226 \begin_layout LyX-Code
30227 TransformCommand Resize ResizeLatexCommand
30230 \begin_layout LyX-Code
30231 Product "$$RotateFront$$ResizeFront
30234 \begin_layout LyX-Code
30239 input{$$AbsOrRelPathMaster$$Basename.pstex_t}
30242 \begin_layout LyX-Code
30243 $$ResizeBack$$RotateBack"
30246 \begin_layout LyX-Code
30250 \begin_layout LyX-Code
30251 UpdateResult "$$AbsPath$$Basename.pstex_t"
30254 \begin_layout LyX-Code
30255 Requirement "graphicx"
30258 \begin_layout LyX-Code
30259 ReferencedFile latex "$$AbsOrRelPathMaster$$Basename.pstex_t"
30262 \begin_layout LyX-Code
30263 ReferencedFile latex "$$AbsPath$$Basename.eps"
30266 \begin_layout LyX-Code
30267 ReferencedFile dvi "$$AbsPath$$Basename.eps"
30270 \begin_layout LyX-Code
30274 \begin_layout LyX-Code
30278 \begin_layout LyX-Code
30279 TransformCommand Rotate RotationLatexCommand
30282 \begin_layout LyX-Code
30283 TransformCommand Resize ResizeLatexCommand
30286 \begin_layout LyX-Code
30287 Product "$$RotateFront$$ResizeFront
30290 \begin_layout LyX-Code
30295 input{$$AbsOrRelPathMaster$$Basename.pdftex_t}
30298 \begin_layout LyX-Code
30299 $$ResizeBack$$RotateBack"
30302 \begin_layout LyX-Code
30303 UpdateFormat pdftex
30306 \begin_layout LyX-Code
30307 UpdateResult "$$AbsPath$$Basename.pdftex_t"
30310 \begin_layout LyX-Code
30311 Requirement "graphicx"
30314 \begin_layout LyX-Code
30315 ReferencedFile latex "$$AbsOrRelPathMaster$$Basename.pdftex_t"
30318 \begin_layout LyX-Code
30319 ReferencedFile latex "$$AbsPath$$Basename.pdf"
30322 \begin_layout LyX-Code
30326 \begin_layout LyX-Code
30330 \begin_layout LyX-Code
30335 \begin_layout LyX-Code
30339 \begin_layout LyX-Code
30343 \begin_layout LyX-Code
30344 Product "<graphic fileref=
30346 "$$AbsOrRelPathMaster$$Basename.eps
30351 \begin_layout LyX-Code
30355 \begin_layout LyX-Code
30359 \begin_layout LyX-Code
30360 UpdateResult "$$AbsPath$$Basename.eps"
30363 \begin_layout LyX-Code
30364 ReferencedFile docbook "$$AbsPath$$Basename.eps"
30367 \begin_layout LyX-Code
30368 ReferencedFile docbook-xml "$$AbsPath$$Basename.eps"
30371 \begin_layout LyX-Code
30375 \begin_layout LyX-Code
30379 \begin_layout Standard
30381 the template is enclosed in
30382 \begin_inset Flex Code
30385 \begin_layout Plain Layout
30393 \begin_inset Flex Code
30396 \begin_layout Plain Layout
30403 It contains a header specifying some general settings and,
30404 for each supported primary document file format,
30406 \begin_inset Flex Code
30409 \begin_layout Plain Layout
30417 \begin_inset Flex Code
30420 \begin_layout Plain Layout
30429 \begin_layout Subsection
30430 The template header
30433 \begin_layout Description
30434 \begin_inset Flex Code
30437 \begin_layout Plain Layout
30438 AutomaticProduction
30439 \begin_inset space ~
30447 Whether the file represented by the template must be generated by \SpecialChar LyX
30449 This command must occur exactly once.
30452 \begin_layout Description
30453 \begin_inset Flex Code
30456 \begin_layout Plain Layout
30458 \begin_inset space ~
30466 A glob pattern that is used in the file dialog to filter out the desired files.
30467 If there is more than one possible file extension (e.
30468 \begin_inset space \thinspace{}
30472 \begin_inset space \space{}
30476 \begin_inset Flex Code
30479 \begin_layout Plain Layout
30486 \begin_inset Flex Code
30489 \begin_layout Plain Layout
30497 \begin_inset Flex Code
30500 \begin_layout Plain Layout
30507 This command must occur exactly once.
30510 \begin_layout Description
30511 \begin_inset Flex Code
30514 \begin_layout Plain Layout
30516 \begin_inset space ~
30524 The text that is displayed on the button.
30525 This command must occur exactly once.
30528 \begin_layout Description
30529 \begin_inset Flex Code
30532 \begin_layout Plain Layout
30534 \begin_inset space ~
30538 \begin_inset space ~
30546 The help text that is used in the External dialog.
30547 Provide enough information to explain to the user just what the template can provide him with.
30548 This command must occur exactly once.
30551 \begin_layout Description
30552 \begin_inset Flex Code
30555 \begin_layout Plain Layout
30557 \begin_inset space ~
30565 The file format of the original file.
30566 This must be the name of a format that is known to \SpecialChar LyX
30568 \begin_inset CommandInset ref
30570 reference "sec:Formats"
30577 \begin_inset Quotes eld
30581 \begin_inset Flex Code
30584 \begin_layout Plain Layout
30591 \begin_inset Quotes erd
30594 if the template can handle original files of more than one format.
30596 will attempt to interrogate the file itself in order to deduce its format in this case.
30597 This command must occur exactly once.
30600 \begin_layout Description
30601 \begin_inset Flex Code
30604 \begin_layout Plain Layout
30606 \begin_inset space ~
30614 A unique name for the template.
30615 It must not contain substitution macros (see below).
30618 \begin_layout Description
30619 \begin_inset Flex Code
30622 \begin_layout Plain Layout
30624 \begin_inset space ~
30627 Rotate|Resize|Clip|Extra
30632 This command specifies which transformations are supported by this template.
30633 It may occur zero or more times.
30634 This command enables the corresponding tabs in the external dialog.
30636 \begin_inset Flex Code
30639 \begin_layout Plain Layout
30645 command must have either a corresponding
30646 \begin_inset Flex Code
30649 \begin_layout Plain Layout
30656 \begin_inset Flex Code
30659 \begin_layout Plain Layout
30666 \begin_inset Flex Code
30669 \begin_layout Plain Layout
30676 Otherwise the transformation will not be supported by that format.
30679 \begin_layout Subsection
30683 \begin_layout Description
30684 \begin_inset Flex Code
30687 \begin_layout Plain Layout
30689 \begin_inset space ~
30692 LaTeX|PDFLaTeX|PlainText|DocBook|XHTML
30697 The primary document file format that this format definition is for.
30698 Not every template has a sensible representation in all document file formats.
30699 Please define nevertheless a
30700 \begin_inset Flex Code
30703 \begin_layout Plain Layout
30709 section for all templates.
30710 Use a dummy text when no representation is available.
30711 Then you can at least see a reference to the external material in the exported document.
30714 \begin_layout Description
30715 \begin_inset Flex Code
30718 \begin_layout Plain Layout
30720 \begin_inset space ~
30724 \begin_inset space ~
30732 This command defines an additional macro
30733 \begin_inset Flex Code
30736 \begin_layout Plain Layout
30742 for substitution in
30743 \begin_inset Flex Code
30746 \begin_layout Plain Layout
30754 \begin_inset Flex Code
30757 \begin_layout Plain Layout
30763 itself may contain substitution macros.
30764 The advantage over using
30765 \begin_inset Flex Code
30768 \begin_layout Plain Layout
30775 \begin_inset Flex Code
30778 \begin_layout Plain Layout
30784 is that the substituted value of
30785 \begin_inset Flex Code
30788 \begin_layout Plain Layout
30794 is sanitized so that it is a valid optional argument in the document format.
30795 This command may occur zero or more times.
30798 \begin_layout Description
30799 \begin_inset Flex Code
30802 \begin_layout Plain Layout
30804 \begin_inset space ~
30812 The text that is inserted in the exported document.
30813 This is actually the most important command and can be quite complex.
30814 This command must occur exactly once.
30817 \begin_layout Description
30818 \begin_inset Flex Code
30821 \begin_layout Plain Layout
30823 \begin_inset space ~
30831 This command specifies a preamble snippet that will be included in the \SpecialChar LaTeX
30833 It has to be defined using
30834 \begin_inset Flex Code
30837 \begin_layout Plain Layout
30845 \begin_inset Flex Code
30848 \begin_layout Plain Layout
30855 This command may occur zero or more times.
30858 \begin_layout Description
30859 \begin_inset Flex Code
30862 \begin_layout Plain Layout
30864 \begin_inset space ~
30868 \begin_inset space ~
30876 This command denotes files that are created by the conversion process and are needed for a particular export format.
30877 If the filename is relative,
30878 it is interpreted relative to the master document.
30879 This command may be given zero or more times.
30882 \begin_layout Description
30883 \begin_inset Flex Code
30886 \begin_layout Plain Layout
30888 \begin_inset space ~
30896 The name of a required \SpecialChar LaTeX
30898 The package is included via
30899 \begin_inset Flex Code
30902 \begin_layout Plain Layout
30910 in the \SpecialChar LaTeX
30912 This command may occur zero or more times.
30915 \begin_layout Description
30916 \begin_inset Flex Code
30919 \begin_layout Plain Layout
30921 \begin_inset space ~
30925 \begin_inset space ~
30928 RotationLatexCommand
30933 This command specifies that the built in \SpecialChar LaTeX
30934 command should be used for rotation.
30935 This command may occur once or not at all.
30938 \begin_layout Description
30939 \begin_inset Flex Code
30942 \begin_layout Plain Layout
30944 \begin_inset space ~
30948 \begin_inset space ~
30956 This command specifies that the built in \SpecialChar LaTeX
30957 command should be used for resizing.
30958 This command may occur once or not at all.
30961 \begin_layout Description
30962 \begin_inset Flex Code
30965 \begin_layout Plain Layout
30967 \begin_inset space ~
30971 \begin_inset space ~
30974 RotationLatexOption
30979 This command specifies that rotation is done via an optional argument.
30980 This command may occur once or not at all.
30983 \begin_layout Description
30984 \begin_inset Flex Code
30987 \begin_layout Plain Layout
30989 \begin_inset space ~
30993 \begin_inset space ~
31001 This command specifies that resizing is done via an optional argument.
31002 This command may occur once or not at all.
31005 \begin_layout Description
31006 \begin_inset Flex Code
31009 \begin_layout Plain Layout
31011 \begin_inset space ~
31015 \begin_inset space ~
31023 This command specifies that clipping is done via an optional argument.
31024 This command may occur once or not at all.
31027 \begin_layout Description
31028 \begin_inset Flex Code
31031 \begin_layout Plain Layout
31033 \begin_inset space ~
31037 \begin_inset space ~
31045 This command specifies that an extra optional argument is used.
31046 This command may occur once or not at all.
31049 \begin_layout Description
31050 \begin_inset Flex Code
31053 \begin_layout Plain Layout
31055 \begin_inset space ~
31063 The file format of the converted file.
31064 This must be the name of a format that is known to \SpecialChar LyX
31066 \begin_inset Flex Noun
31069 \begin_layout Plain Layout
31070 Tools\SpecialChar menuseparator
31071 Preferences\SpecialChar menuseparator
31072 File Handling\SpecialChar menuseparator
31079 This command must occur exactly once.
31080 If the resulting file format is PDF,
31081 you need to specify the format
31082 \begin_inset Flex Code
31085 \begin_layout Plain Layout
31092 This is the PDF format used for including graphics.
31093 The other defined PDF formats are for document export.
31096 \begin_layout Description
31097 \begin_inset Flex Code
31100 \begin_layout Plain Layout
31102 \begin_inset space ~
31110 The file name of the converted file.
31111 The file name must be absolute.
31112 This command must occur exactly once.
31115 \begin_layout Subsection
31116 Preamble definitions
31119 \begin_layout Standard
31120 The external template configuration file may contain additional preamble definitions enclosed by
31121 \begin_inset Flex Code
31124 \begin_layout Plain Layout
31132 \begin_inset Flex Code
31135 \begin_layout Plain Layout
31142 They can be used by the templates in the
31143 \begin_inset Flex Code
31146 \begin_layout Plain Layout
31155 \begin_layout Section
31156 The substitution mechanism
31159 \begin_layout Standard
31160 When the external material facility invokes an external program,
31161 it is done on the basis of a command defined in the template configuration file.
31162 These commands can contain various macros that are expanded before execution.
31163 Execution always take place in the directory of the containing document.
31166 \begin_layout Standard
31168 whenever external material is to be displayed,
31169 the name will be produced by the substitution mechanism,
31170 and most other commands in the template definition support substitution as well.
31173 \begin_layout Standard
31174 The available macros are the following:
31177 \begin_layout Description
31178 \begin_inset Flex Code
31181 \begin_layout Plain Layout
31182 $$AbsOrRelPathMaster
31188 absolute or relative to the master \SpecialChar LyX
31192 \begin_layout Description
31193 \begin_inset Flex Code
31196 \begin_layout Plain Layout
31197 $$AbsOrRelPathParent
31203 absolute or relative to the \SpecialChar LyX
31207 \begin_layout Description
31208 \begin_inset Flex Code
31211 \begin_layout Plain Layout
31217 The absolute file path.
31220 \begin_layout Description
31221 \begin_inset Flex Code
31224 \begin_layout Plain Layout
31230 The filename without path and without the extension.
31233 \begin_layout Description
31234 \begin_inset Flex Code
31237 \begin_layout Plain Layout
31239 \begin_inset Quotes eld
31243 \begin_inset Quotes erd
31251 This macro will expand to the contents of the file with the name
31252 \begin_inset Flex Code
31255 \begin_layout Plain Layout
31264 \begin_layout Description
31265 \begin_inset Flex Code
31268 \begin_layout Plain Layout
31274 The file extension (including the dot).
31277 \begin_layout Description
31278 \begin_inset Flex Code
31281 \begin_layout Plain Layout
31287 This will be the string
31288 \begin_inset Quotes eld
31292 \begin_inset Quotes erd
31295 if the file is in JPEG format,
31296 otherwise it will be the string
31297 \begin_inset Quotes eld
31301 \begin_inset Quotes erd
31305 This is useful to avoid uneeded conversions for output formats that support both PNG and JPEG fomats.
31306 The predefined RasterImage template uses this macro for the pdf\SpecialChar TeX
31310 \begin_layout Description
31311 \begin_inset Flex Code
31314 \begin_layout Plain Layout
31320 The filename of the file specified in the external material dialog.
31321 This is either an absolute name,
31322 or it is relative to the \SpecialChar LyX
31326 \begin_layout Description
31327 \begin_inset Flex Code
31330 \begin_layout Plain Layout
31337 \begin_inset Flex Code
31340 \begin_layout Plain Layout
31346 (absolute name or relative to the \SpecialChar LyX
31350 \begin_layout Description
31351 \begin_inset Flex Code
31354 \begin_layout Plain Layout
31361 relative to the master \SpecialChar LyX
31365 \begin_layout Description
31366 \begin_inset Flex Code
31369 \begin_layout Plain Layout
31376 relative to the \SpecialChar LyX
31380 \begin_layout Description
31381 \begin_inset Flex Code
31384 \begin_layout Plain Layout
31390 This macro will expand to the absolute path of the system directory.
31391 This is typically used to point to the various helper scripts that are bundled with \SpecialChar LyX
31395 \begin_layout Description
31396 \begin_inset Flex Code
31399 \begin_layout Plain Layout
31405 A name and full path to a temporary file which will be automatically deleted whenever the containing document is closed,
31406 or the external material insertion deleted.
31409 \begin_layout Standard
31410 All path macros contain a trailing directory separator,
31411 so you can construct e.
31412 \begin_inset space \thinspace{}
31416 \begin_inset space \space{}
31419 the absolute filename with
31420 \begin_inset Flex Code
31423 \begin_layout Plain Layout
31424 $$AbsPath$$Basename$$Extension
31432 \begin_layout Standard
31433 The macros above are substituted in all commands unless otherwise noted.
31435 \begin_inset Flex Code
31438 \begin_layout Plain Layout
31444 supports additionally the following substitutions if they are enabled by the
31445 \begin_inset Flex Code
31448 \begin_layout Plain Layout
31455 \begin_inset Flex Code
31458 \begin_layout Plain Layout
31467 \begin_layout Description
31468 \begin_inset Flex Code
31471 \begin_layout Plain Layout
31477 The front part of the resize command.
31480 \begin_layout Description
31481 \begin_inset Flex Code
31484 \begin_layout Plain Layout
31490 The back part of the resize command.
31493 \begin_layout Description
31494 \begin_inset Flex Code
31497 \begin_layout Plain Layout
31503 The front part of the rotation command.
31506 \begin_layout Description
31507 \begin_inset Flex Code
31510 \begin_layout Plain Layout
31516 The back part of the rotation command.
31519 \begin_layout Standard
31520 The value string of the
31521 \begin_inset Flex Code
31524 \begin_layout Plain Layout
31530 command supports additionally the following substitutions if they are enabled by the
31531 \begin_inset Flex Code
31534 \begin_layout Plain Layout
31541 \begin_inset Flex Code
31544 \begin_layout Plain Layout
31553 \begin_layout Description
31554 \begin_inset Flex Code
31557 \begin_layout Plain Layout
31566 \begin_layout Description
31567 \begin_inset Flex Code
31570 \begin_layout Plain Layout
31579 \begin_layout Description
31580 \begin_inset Flex Code
31583 \begin_layout Plain Layout
31592 \begin_layout Description
31593 \begin_inset Flex Code
31596 \begin_layout Plain Layout
31602 The rotation option.
31605 \begin_layout Standard
31606 You may ask why there are so many path macros.
31607 There are mainly two reasons:
31610 \begin_layout Enumerate
31611 Relative and absolute file names should remain relative or absolute,
31613 Users may have reasons to prefer either form.
31614 Relative names are useful for portable documents that should work on different machines,
31616 Absolute names may be required by some programs.
31619 \begin_layout Enumerate
31621 treats relative file names differently than \SpecialChar LyX
31622 and other programs in nested included files.
31623 For \SpecialChar LyX
31625 a relative file name is always relative to the document that contains the file name.
31626 For \SpecialChar LaTeX
31628 it is always relative to the master document.
31629 These two definitions are identical if you have only one document,
31630 but differ if you have a master document that includes part documents.
31631 That means that relative filenames must be transformed when presented to \SpecialChar LaTeX
31633 Fortunately \SpecialChar LyX
31634 does this automatically for you if you choose the right macros.
31637 \begin_layout Standard
31638 So which path macro should be used in new template definitions?
31639 The rule is not difficult:
31642 \begin_layout Itemize
31644 \begin_inset Flex Code
31647 \begin_layout Plain Layout
31653 if an absolute path is required.
31656 \begin_layout Itemize
31658 \begin_inset Flex Code
31661 \begin_layout Plain Layout
31662 $$AbsOrRelPathMaster
31667 if the substituted string is some kind of \SpecialChar LaTeX
31671 \begin_layout Itemize
31673 \begin_inset Flex Code
31676 \begin_layout Plain Layout
31677 $$AbsOrRelPathParent
31682 in order to preserve the user's choice.
31685 \begin_layout Standard
31686 There are special cases where this rule does not work and e.
31687 \begin_inset space \thinspace{}
31691 \begin_inset space \space{}
31694 relative names are needed,
31695 but normally it will work just fine.
31696 One example for such a case is the command
31697 \begin_inset Flex Code
31700 \begin_layout Plain Layout
31701 ReferencedFile latex "$$AbsOrRelPathMaster$$Basename.pstex_t"
31706 in the XFig template above:
31707 We can't use the absolute name because the copier for
31708 \begin_inset Flex Code
31711 \begin_layout Plain Layout
31717 files needs the relative name in order to rewrite the file content.
31720 \begin_layout Section
31721 Security discussion
31722 \begin_inset CommandInset label
31724 name "sec:Security-discussion"
31731 \begin_layout Standard
31732 The external material feature interfaces with a lot of external programs and does so automatically,
31733 so we have to consider the security implications of this.
31735 since you have the option of including your own filenames and/or parameter strings and those are expanded into a command,
31736 it seems that it would be possible to create a malicious document which executes arbitrary commands when a user views or prints the document.
31737 This is something we definitely want to avoid.
31740 \begin_layout Standard
31742 since the external program commands are specified in the template configuration file only,
31743 there are no security issues if \SpecialChar LyX
31744 is properly configured with safe templates only.
31745 This is so because the external programs are invoked with the
31746 \begin_inset Flex Code
31749 \begin_layout Plain Layout
31755 -system call rather than the
31756 \begin_inset Flex Code
31759 \begin_layout Plain Layout
31766 so it's not possible to execute arbitrary commands from the filename or parameter section via the shell.
31769 \begin_layout Standard
31770 This also implies that you are restricted in what command strings you can use in the external material templates.
31772 pipes and redirection are not readily available.
31773 This has to be so if \SpecialChar LyX
31774 should remain safe.
31775 If you want to use some of the shell features,
31776 you should write a safe script to do this in a controlled manner,
31777 and then invoke the script from the command string.
31781 \begin_layout Standard
31782 It is possible to design a template that interacts directly with the shell,
31783 but since this would allow a malicious user to execute arbitrary commands by writing clever filenames and/or parameters,
31784 we generally recommend that you only use safe scripts that work with the
31785 \begin_inset Flex Code
31788 \begin_layout Plain Layout
31794 system call in a controlled manner.
31796 for use in a controlled environment,
31797 it can be tempting to just fall back to use ordinary shell scripts.
31803 provide an easily exploitable security hole in your system.
31804 Of course it stands to reason that such unsafe templates will never be included in the standard \SpecialChar LyX
31806 although we do encourage people to submit new templates in the open source tradition.
31807 But \SpecialChar LyX
31808 as shipped from the official distribution channels will never have unsafe templates.
31811 \begin_layout Standard
31812 Including external material provides a lot of power,
31813 and you have to be careful not to introduce security hazards with this power.
31814 A subtle error in a single line in an innocent looking script can open the door to huge security problems.
31815 So if you do not fully understand the issues,
31816 we recommend that you consult a knowledgeable security professional or the \SpecialChar LyX
31817 development team if you have any questions about whether a given template is safe or not.
31818 And do this before you use it in an uncontrolled environment.
31821 \begin_layout Chapter
31823 List of supported \SpecialChar LyX
31824 functions to be used in layouts
31825 \begin_inset CommandInset label
31827 name "chap:List-of-functions"
31834 \begin_layout Standard
31836 \begin_inset Tabular
31837 <lyxtabular version="3" rows="11" columns="8">
31838 <features tabularvalignment="middle">
31839 <column alignment="left" valignment="top">
31840 <column alignment="left" valignment="top">
31841 <column alignment="left" valignment="top">
31842 <column alignment="left" valignment="top">
31843 <column alignment="left" valignment="top">
31844 <column alignment="left" valignment="top">
31845 <column alignment="left" valignment="top">
31846 <column alignment="left" valignment="top">
31848 <cell alignment="left" valignment="top" usebox="none">
31851 \begin_layout Plain Layout
31857 <cell alignment="left" valignment="top" usebox="none">
31860 \begin_layout Plain Layout
31866 <cell alignment="left" valignment="top" usebox="none">
31869 \begin_layout Plain Layout
31875 <cell alignment="left" valignment="top" usebox="none">
31878 \begin_layout Plain Layout
31884 <cell alignment="center" valignment="top" usebox="none">
31887 \begin_layout Plain Layout
31893 <cell alignment="center" valignment="top" usebox="none">
31896 \begin_layout Plain Layout
31902 <cell alignment="center" valignment="top" usebox="none">
31905 \begin_layout Plain Layout
31911 <cell alignment="center" valignment="top" usebox="none">
31914 \begin_layout Plain Layout
31922 <cell alignment="left" valignment="top" usebox="none">
31925 \begin_layout Plain Layout
31931 <cell alignment="left" valignment="top" usebox="none">
31934 \begin_layout Plain Layout
31940 <cell alignment="left" valignment="top" usebox="none">
31943 \begin_layout Plain Layout
31949 <cell alignment="left" valignment="top" usebox="none">
31952 \begin_layout Plain Layout
31958 <cell alignment="center" valignment="top" usebox="none">
31961 \begin_layout Plain Layout
31967 <cell alignment="center" valignment="top" usebox="none">
31970 \begin_layout Plain Layout
31976 <cell alignment="center" valignment="top" usebox="none">
31979 \begin_layout Plain Layout
31985 <cell alignment="center" valignment="top" usebox="none">
31988 \begin_layout Plain Layout
31996 <cell alignment="left" valignment="top" usebox="none">
31999 \begin_layout Plain Layout
32005 <cell alignment="left" valignment="top" usebox="none">
32008 \begin_layout Plain Layout
32014 <cell alignment="left" valignment="top" usebox="none">
32017 \begin_layout Plain Layout
32023 <cell alignment="left" valignment="top" usebox="none">
32026 \begin_layout Plain Layout
32032 <cell alignment="center" valignment="top" usebox="none">
32035 \begin_layout Plain Layout
32041 <cell alignment="center" valignment="top" usebox="none">
32044 \begin_layout Plain Layout
32050 <cell alignment="center" valignment="top" usebox="none">
32053 \begin_layout Plain Layout
32059 <cell alignment="center" valignment="top" usebox="none">
32062 \begin_layout Plain Layout
32070 <cell alignment="left" valignment="top" usebox="none">
32073 \begin_layout Plain Layout
32079 <cell alignment="left" valignment="top" usebox="none">
32082 \begin_layout Plain Layout
32088 <cell alignment="left" valignment="top" usebox="none">
32091 \begin_layout Plain Layout
32097 <cell alignment="left" valignment="top" usebox="none">
32100 \begin_layout Plain Layout
32106 <cell alignment="center" valignment="top" usebox="none">
32109 \begin_layout Plain Layout
32115 <cell alignment="center" valignment="top" usebox="none">
32118 \begin_layout Plain Layout
32124 <cell alignment="center" valignment="top" usebox="none">
32127 \begin_layout Plain Layout
32133 <cell alignment="center" valignment="top" usebox="none">
32136 \begin_layout Plain Layout
32144 <cell alignment="left" valignment="top" usebox="none">
32147 \begin_layout Plain Layout
32153 <cell alignment="left" valignment="top" usebox="none">
32156 \begin_layout Plain Layout
32162 <cell alignment="left" valignment="top" usebox="none">
32165 \begin_layout Plain Layout
32171 <cell alignment="left" valignment="top" usebox="none">
32174 \begin_layout Plain Layout
32180 <cell alignment="center" valignment="top" usebox="none">
32183 \begin_layout Plain Layout
32189 <cell alignment="center" valignment="top" usebox="none">
32192 \begin_layout Plain Layout
32198 <cell alignment="center" valignment="top" usebox="none">
32201 \begin_layout Plain Layout
32207 <cell alignment="center" valignment="top" usebox="none">
32210 \begin_layout Plain Layout
32218 <cell alignment="left" valignment="top" usebox="none">
32221 \begin_layout Plain Layout
32227 <cell alignment="left" valignment="top" usebox="none">
32230 \begin_layout Plain Layout
32236 <cell alignment="left" valignment="top" usebox="none">
32239 \begin_layout Plain Layout
32245 <cell alignment="left" valignment="top" usebox="none">
32248 \begin_layout Plain Layout
32254 <cell alignment="center" valignment="top" usebox="none">
32257 \begin_layout Plain Layout
32263 <cell alignment="center" valignment="top" usebox="none">
32266 \begin_layout Plain Layout
32272 <cell alignment="center" valignment="top" usebox="none">
32275 \begin_layout Plain Layout
32281 <cell alignment="center" valignment="top" usebox="none">
32284 \begin_layout Plain Layout
32292 <cell alignment="left" valignment="top" usebox="none">
32295 \begin_layout Plain Layout
32301 <cell alignment="left" valignment="top" usebox="none">
32304 \begin_layout Plain Layout
32310 <cell alignment="left" valignment="top" usebox="none">
32313 \begin_layout Plain Layout
32319 <cell alignment="left" valignment="top" usebox="none">
32322 \begin_layout Plain Layout
32328 <cell alignment="center" valignment="top" usebox="none">
32331 \begin_layout Plain Layout
32337 <cell alignment="center" valignment="top" usebox="none">
32340 \begin_layout Plain Layout
32346 <cell alignment="center" valignment="top" usebox="none">
32349 \begin_layout Plain Layout
32355 <cell alignment="center" valignment="top" usebox="none">
32358 \begin_layout Plain Layout
32366 <cell alignment="left" valignment="top" usebox="none">
32369 \begin_layout Plain Layout
32375 <cell alignment="left" valignment="top" usebox="none">
32378 \begin_layout Plain Layout
32384 <cell alignment="left" valignment="top" usebox="none">
32387 \begin_layout Plain Layout
32393 <cell alignment="left" valignment="top" usebox="none">
32396 \begin_layout Plain Layout
32402 <cell alignment="center" valignment="top" usebox="none">
32405 \begin_layout Plain Layout
32411 <cell alignment="center" valignment="top" usebox="none">
32414 \begin_layout Plain Layout
32420 <cell alignment="center" valignment="top" usebox="none">
32423 \begin_layout Plain Layout
32429 <cell alignment="center" valignment="top" usebox="none">
32432 \begin_layout Plain Layout
32440 <cell alignment="left" valignment="top" usebox="none">
32443 \begin_layout Plain Layout
32449 <cell alignment="left" valignment="top" usebox="none">
32452 \begin_layout Plain Layout
32458 <cell alignment="left" valignment="top" usebox="none">
32461 \begin_layout Plain Layout
32467 <cell alignment="left" valignment="top" usebox="none">
32470 \begin_layout Plain Layout
32476 <cell alignment="center" valignment="top" usebox="none">
32479 \begin_layout Plain Layout
32485 <cell alignment="center" valignment="top" usebox="none">
32488 \begin_layout Plain Layout
32494 <cell alignment="center" valignment="top" usebox="none">
32497 \begin_layout Plain Layout
32503 <cell alignment="center" valignment="top" usebox="none">
32506 \begin_layout Plain Layout
32514 <cell alignment="left" valignment="top" usebox="none">
32517 \begin_layout Plain Layout
32523 <cell alignment="left" valignment="top" usebox="none">
32526 \begin_layout Plain Layout
32532 <cell alignment="left" valignment="top" usebox="none">
32535 \begin_layout Plain Layout
32541 <cell alignment="left" valignment="top" usebox="none">
32544 \begin_layout Plain Layout
32550 <cell alignment="center" valignment="top" usebox="none">
32553 \begin_layout Plain Layout
32559 <cell alignment="center" valignment="top" usebox="none">
32562 \begin_layout Plain Layout
32568 <cell alignment="center" valignment="top" usebox="none">
32571 \begin_layout Plain Layout
32577 <cell alignment="center" valignment="top" usebox="none">
32580 \begin_layout Plain Layout
32588 <cell alignment="center" valignment="top" usebox="none">
32591 \begin_layout Plain Layout
32597 <cell alignment="center" valignment="top" usebox="none">
32600 \begin_layout Plain Layout
32606 <cell alignment="center" valignment="top" usebox="none">
32609 \begin_layout Plain Layout
32615 <cell alignment="center" valignment="top" usebox="none">
32618 \begin_layout Plain Layout
32624 <cell alignment="center" valignment="top" usebox="none">
32627 \begin_layout Plain Layout
32633 <cell alignment="center" valignment="top" usebox="none">
32636 \begin_layout Plain Layout
32642 <cell alignment="center" valignment="top" usebox="none">
32645 \begin_layout Plain Layout
32651 <cell alignment="center" valignment="top" usebox="none">
32654 \begin_layout Plain Layout
32668 \begin_layout Chapter
32669 Names of available colors to be used in layouts
32670 \begin_inset CommandInset label
32672 name "chap:Names-of-colors"
32679 \begin_layout Standard
32680 The colors listed below are the standard colors and those that you can adjust in the \SpecialChar LyX
32684 \begin_layout Section
32688 \begin_layout Standard
32689 The following are no real colors,
32690 but rather act on color definitions:
32693 \begin_layout Description
32694 ignore The color is ignored
32697 \begin_layout Description
32698 inherit The color is inherited
32701 \begin_layout Description
32714 No particular color – clear or default
32717 \begin_layout Section
32721 \begin_layout Standard
32722 These are fixed colors that cannot be customized.
32727 use these colors in layout definitions,
32728 since they will not work well with some color themes (such as dark themes):
32731 \begin_layout Description
32735 \begin_layout Description
32739 \begin_layout Description
32743 \begin_layout Description
32747 \begin_layout Description
32751 \begin_layout Description
32755 \begin_layout Description
32759 \begin_layout Description
32763 \begin_layout Description
32767 \begin_layout Description
32771 \begin_layout Description
32775 \begin_layout Description
32779 \begin_layout Description
32783 \begin_layout Description
32787 \begin_layout Description
32791 \begin_layout Description
32795 \begin_layout Description
32799 \begin_layout Description
32803 \begin_layout Description
32807 \begin_layout Section
32811 \begin_layout Standard
32812 These are the colors allocated to specific elements in
32815 arg "dialog-show prefs"
32821 \begin_layout Description
32822 added_space Added space color
32825 \begin_layout Description
32826 addedtext Added text color
32829 \begin_layout Description
32830 appendix Appendix marker color
32833 \begin_layout Description
32834 background Background color
32837 \begin_layout Description
32838 bookmark Bookmark indicator color
32841 \begin_layout Description
32842 bottomarea Bottom area color
32845 \begin_layout Description
32846 branchlabel Label color for branches
32849 \begin_layout Description
32850 buttonbg Color used for button background
32853 \begin_layout Description
32854 buttonframe Color for inset button frames
32857 \begin_layout Description
32858 buttonhoverbg Color used for button background under focus
32861 \begin_layout Description
32862 buttonhoverbg_broken Color used for broken inset button under focus
32865 \begin_layout Description
32866 changebar Changebar color
32869 \begin_layout Description
32870 changedtextauthor1 Changed text color author 1
32873 \begin_layout Description
32874 changedtextauthor2 Changed text color author 2
32877 \begin_layout Description
32878 changedtextauthor3 Changed text color author 3
32881 \begin_layout Description
32882 changedtextauthor4 Changed text color author 4
32885 \begin_layout Description
32886 changedtextauthor5 Changed text color author 5
32889 \begin_layout Description
32890 changedtextcomparison Changed text color document comparison (workarea)
32893 \begin_layout Description
32894 collapsible Collapsible insets text color
32897 \begin_layout Description
32898 collapsibleframe Collapsible insets framecolor
32901 \begin_layout Description
32902 command Text color for command insets
32905 \begin_layout Description
32906 commandbg Background color for command insets
32909 \begin_layout Description
32910 commandframe Frame color for command insets
32913 \begin_layout Description
32914 command_broken Text color for broken (reference) insets
32917 \begin_layout Description
32918 commandbg_broken Background color for broken insets
32921 \begin_layout Description
32922 commandframe_broken Frame color for broken insets
32925 \begin_layout Description
32926 comment Label color for comments
32929 \begin_layout Description
32930 commentbg Background color of comments
32933 \begin_layout Description
32934 cursor Cursor color
32937 \begin_layout Description
32938 deletedtext Deleted text color
32941 \begin_layout Description
32942 deletedtextmodifier Deleted text modifying color (for adjusting the brightness)
32945 \begin_layout Description
32946 depthbar Color for the depth bars in the margin
32949 \begin_layout Description
32950 eolmarker End of line marker color
32953 \begin_layout Description
32954 error Color of the \SpecialChar LaTeX
32958 \begin_layout Description
32959 footlabel Label color for footnotes
32962 \begin_layout Description
32963 foreground Foreground color
32966 \begin_layout Description
32967 graphicsbg Graphics inset background color
32970 \begin_layout Description
32971 greyedoutbg Background color of greyedout inset
32974 \begin_layout Description
32975 greyedoutlabel Label color for greyedout insets
32978 \begin_layout Description
32979 greyedouttext Color for greyedout inset text
32982 \begin_layout Description
32983 indexlabel Label color for index insets
32986 \begin_layout Description
32987 inlinecompletion Inline completion color
32990 \begin_layout Description
32991 insetbg Inset marker background color
32994 \begin_layout Description
32995 insetframe Inset marker frame color
32998 \begin_layout Description
32999 language Color for marking foreign language words
33002 \begin_layout Description
33003 latex Text color in \SpecialChar LaTeX
33007 \begin_layout Description
33008 listingsbg Background color of listings inset
33011 \begin_layout Description
33012 marginlabel Label color for margin notes
33015 \begin_layout Description
33016 math Math inset text color
33019 \begin_layout Description
33020 mathbg Math inset background color
33023 \begin_layout Description
33024 mathcorners Math inset frame color not under focus
33027 \begin_layout Description
33028 mathframe Math inset frame color under focus
33031 \begin_layout Description
33032 mathline Math line color
33035 \begin_layout Description
33036 mathmacrobg Macro math inset background color
33039 \begin_layout Description
33040 mathmacroblend Macro math blended color
33043 \begin_layout Description
33044 mathmacroframe Macro math frame color
33047 \begin_layout Description
33048 mathmacrohoverbg Macro math inset background color hovered
33051 \begin_layout Description
33052 mathmacrolabel Macro math label color
33055 \begin_layout Description
33056 mathmacronewarg Macro template color for new parameters
33059 \begin_layout Description
33060 mathmacrooldarg Macro template color for old parameters
33063 \begin_layout Description
33064 newpage New page color
33067 \begin_layout Description
33068 nonunique_inlinecompletion Inline completion color for the non-unique part
33071 \begin_layout Description
33072 note Label color for notes
33075 \begin_layout Description
33076 notebg Background color of notes
33079 \begin_layout Description
33080 pagebreak Page break/line break color
33083 \begin_layout Description
33084 paragraphmarker Color used for the pilcrow sign to mark the end of a paragraph
33087 \begin_layout Description
33088 phantomtext Text color for phantom insets
33091 \begin_layout Description
33092 preview The color used for previews
33095 \begin_layout Description
33096 previewframe Preview frame color
33099 \begin_layout Description
33100 regexpframe Color for regexp frame
33103 \begin_layout Description
33104 scroll Color that indicates when a row can be scrolled
33107 \begin_layout Description
33108 selection Background color of selected text
33111 \begin_layout Description
33112 selectionmath Foreground color of selected text in math insets
33115 \begin_layout Description
33116 selectiontext Foreground color of selected text
33119 \begin_layout Description
33120 shadedbg Background color of shaded box
33123 \begin_layout Description
33124 special Special chars text color
33127 \begin_layout Description
33128 tabularline Table line color
33131 \begin_layout Description
33132 tabularonoffline Table line color
33135 \begin_layout Description
33136 textlabel1 Color 1 of layout and custom inset labels
33139 \begin_layout Description
33140 textlabel2 Color 2 of layout and custom inset labels
33143 \begin_layout Description
33144 textlabel3 Color 3 of layout and custom inset labels
33147 \begin_layout Description
33148 urllabel Label color for URL insets
33151 \begin_layout Description
33152 urltext Color for URL inset text