1 #LyX 2.4 created this file. For more info see https://www.lyx.org/
5 \save_transient_properties true
6 \origin /systemlyxdir/doc/
9 % DO NOT ALTER THIS PREAMBLE!!!
11 % This preamble is designed to ensure that this document prints
12 % out as advertised. If you mess with this preamble,
13 % parts of this document may not print out as expected. If you
14 % have problems LaTeXing this file, please contact
15 % the documentation team
16 % email: lyx-docs@lists.lyx.org
18 % the pages of the TOC is numbered roman
19 % and a pdf-bookmark for the TOC is added
20 \let\myTOC\tableofcontents
21 \renewcommand\tableofcontents{%
23 \pdfbookmark[1]{\contentsname}{}
27 % increase link area for cross-references and autoname them,
28 \AtBeginDocument{\renewcommand{\ref}[1]{\mbox{\autoref{#1}}}}
29 \@ifundefined{extrasenglish}{\usepackage[english]{babel}}{}
30 \@ifpackageloaded{babel}{
31 \addto\extrasenglish{%
32 \renewcommand*{\equationautorefname}[1]{}%
33 \renewcommand{\sectionautorefname}{sec.\negthinspace}%
34 \renewcommand{\subsectionautorefname}{sec.\negthinspace}%
35 \renewcommand{\subsubsectionautorefname}{sec.\negthinspace}%
39 \options bibliography=totoc,index=totoc,BCOR7.5mm,titlepage,captions=tableheading
40 \use_default_options false
44 \maintain_unincluded_children no
46 \language_package default
49 \font_roman "lmodern" "default"
50 \font_sans "lmss" "default"
51 \font_typewriter "lmtt" "default"
52 \font_math "auto" "auto"
53 \font_default_family default
54 \use_non_tex_fonts false
58 \font_typewriter_osf false
59 \font_sf_scale 100 100
60 \font_tt_scale 100 100
62 \use_dash_ligatures true
64 \default_output_format pdf2
66 \bibtex_command default
67 \index_command default
71 \pdf_title "LyX Configuration Manual"
72 \pdf_author "LyX Team"
73 \pdf_subject "LyX-documentation Customization"
74 \pdf_keywords "LyX, documentation, customization"
76 \pdf_bookmarksnumbered true
77 \pdf_bookmarksopen true
78 \pdf_bookmarksopenlevel 1
83 \pdf_pdfusetitle false
84 \pdf_quoted_options "linkcolor=black, citecolor=black, urlcolor=blue, filecolor=blue,pdfpagelayout=OneColumn, pdfnewwindow=true, pdfstartview=XYZ, plainpages=false"
87 \use_package amsmath 1
88 \use_package amssymb 1
91 \use_package mathdots 1
92 \use_package mathtools 1
94 \use_package stackrel 1
95 \use_package stmaryrd 1
96 \use_package undertilde 1
98 \cite_engine_type default
102 \paperorientation portrait
109 \notefontcolor #0000ff
113 \color #f5fae7 #0a0518
121 \paragraph_separation indent
122 \paragraph_indentation default
124 \math_indentation default
125 \math_numbering_side default
126 \quotes_style english
130 \paperpagestyle headings
132 \tracking_changes true
133 \output_changes false
135 \postpone_fragile_content false
139 \docbook_table_output 0
140 \docbook_mathml_prefix 1
141 \author -712698321 "Jürgen Spitzmüller"
147 Customizing \SpecialChar LyX
149 Features for the Advanced User
153 by the \SpecialChar LyX
158 \begin_layout Plain Layout
159 If you have comments or error corrections,
160 please send them to the \SpecialChar LyX
161 Documentation mailing list,
163 \begin_inset CommandInset href
165 target "lyx-docs@lists.lyx.org"
173 \begin_inset Quotes eld
177 \begin_inset Quotes erd
180 in the subject header,
181 and please cc the current maintainer of this file,
182 Richard Kimberly Heck <rikiheck@lyx.org>.
188 \begin_inset Newline newline
192 \begin_inset Newline newline
198 \begin_layout Standard
199 \begin_inset CommandInset toc
200 LatexCommand tableofcontents
207 \begin_layout Standard
208 \begin_inset Note Note
211 \begin_layout Plain Layout
212 Please use change tracking when modifying this document.
213 This makes it easier for our translators to recognize things that have been changed,
214 and it helps the maintainer keep up-to-date with what's been done.
222 \begin_layout Chapter
226 \begin_layout Standard
227 This manual covers the customization features present in \SpecialChar LyX
230 we discuss issues like keyboard shortcuts,
231 screen previewing options,
233 sending commands to \SpecialChar LyX
234 via the \SpecialChar LyX
236 internationalization,
237 installing new \SpecialChar LaTeX
238 classes and \SpecialChar LyX
241 We can't possibly hope to touch on everything you can change—
242 our developers add new features faster than we can document them—
243 but we will explain the most common customizations and hopefully point you in the right direction for some of the more obscure ones.
246 \begin_layout Standard
247 \begin_inset Branch OutDated
251 \begin_layout Standard
252 Information from previous versions of this document that now seems to be outdated is contained in the OutDated branch of this document.
254 this information will not appear in the \SpecialChar LaTeX
263 \begin_layout Chapter
268 \begin_layout Standard
269 This chapter aims to help you to find your way through the \SpecialChar LyX
271 Before continuing to read this chapter,
272 you should find out where your \SpecialChar LyX
273 system and user directories are by using
274 \begin_inset Flex Noun
277 \begin_layout Plain Layout
278 Help\SpecialChar menuseparator
289 The system directory is the place where \SpecialChar LyX
290 places its system-wide configuration files;
291 the user directory is where you can place your modified versions.
292 We will call the former
293 \begin_inset Flex Code
296 \begin_layout Plain Layout
303 \begin_inset Flex Noun
306 \begin_layout Plain Layout
312 in the remainder of this document.
316 \begin_layout Section
318 \begin_inset Flex Code
321 \begin_layout Plain Layout
330 \begin_layout Standard
331 \begin_inset Flex Code
334 \begin_layout Plain Layout
340 and its sub-directories contain a number of files that can be used to customize \SpecialChar LyX
342 You can change many of these files from within \SpecialChar LyX
344 \begin_inset Flex Noun
347 \begin_layout Plain Layout
348 Tools\SpecialChar menuseparator
355 Most customization that you will want to do in \SpecialChar LyX
356 is possible through this dialog.
358 many other inner aspects of \SpecialChar LyX
359 can be customized by modifying the files in
360 \begin_inset Flex Code
363 \begin_layout Plain Layout
370 These files fall in different categories,
371 described in the following subsections.
374 \begin_layout Subsection
375 Automatically generated files
378 \begin_layout Standard
380 \begin_inset Flex Noun
383 \begin_layout Plain Layout
389 are generated when you configure \SpecialChar LyX
391 They contain various default values that are automatically detected during reconfiguration.
393 it is not a good idea to modify them,
394 since they might be overwritten at any time.
397 \begin_layout Labeling
398 \labelwidthstring 00.00.0000
399 \begin_inset Flex Code
402 \begin_layout Plain Layout
408 Contains defaults for various commands.
411 \begin_layout Labeling
412 \labelwidthstring 00.00.0000
413 \begin_inset Flex Code
416 \begin_layout Plain Layout
422 Contains the list of packages that have been recognized by \SpecialChar LyX
424 It is currently unused by the \SpecialChar LyX
426 but the information extracted,
428 is made available with
429 \begin_inset Flex Noun
432 \begin_layout Plain Layout
433 Help\SpecialChar menuseparator
447 \begin_layout Labeling
448 \labelwidthstring 00.00.0000
449 \begin_inset Flex Code
452 \begin_layout Plain Layout
458 The list of text classes that have been found in your
459 \begin_inset Flex Code
462 \begin_layout Plain Layout
469 along with the associated \SpecialChar LaTeX
470 document class and their description.
473 \begin_layout Labeling
474 \labelwidthstring 00.00.0000
475 \begin_inset Flex Code
478 \begin_layout Plain Layout
484 The list of layout modules found in your
485 \begin_inset Flex Code
488 \begin_layout Plain Layout
497 \begin_layout Labeling
498 \labelwidthstring 00.00.0000
499 \begin_inset Flex Code
502 \begin_layout Plain Layout
508 Lists of various sorts of \SpecialChar LaTeX
509 -related files found on your system
512 \begin_layout Labeling
513 \labelwidthstring 00.00.0000
514 \begin_inset Flex Code
517 \begin_layout Plain Layout
518 doc/\SpecialChar LaTeX
524 is automatically generated during configuration from the file
525 \begin_inset Flex Code
528 \begin_layout Plain Layout
536 It contains information on your \SpecialChar LaTeX
540 \begin_layout Subsection
544 \begin_layout Standard
545 The following directories in
546 \begin_inset Flex Code
549 \begin_layout Plain Layout
556 \begin_inset Flex Code
559 \begin_layout Plain Layout
566 If a particular file exists in both places,
568 \begin_inset Flex Code
571 \begin_layout Plain Layout
580 \begin_layout Labeling
581 \labelwidthstring 00.00.0000
582 \begin_inset Flex Code
585 \begin_layout Plain Layout
591 This directory contains files with the extension
592 \begin_inset Flex Code
595 \begin_layout Plain Layout
601 that define the keybindings used in \SpecialChar LyX
603 If there exists an internationalized version of the bind file in a subdirectory
604 \begin_inset Flex Code
607 \begin_layout Plain Layout
614 \begin_inset Quotes eld
618 \begin_inset Quotes erd
621 is the ISO language code,
622 that will be used first.
625 \begin_layout Labeling
626 \labelwidthstring 00.00.0000
627 \begin_inset Flex Code
630 \begin_layout Plain Layout
636 Contains files with the extension
637 \begin_inset Flex Code
640 \begin_layout Plain Layout
646 which define the diverse citation possibilities (natbib,
649 \begin_inset CommandInset ref
651 reference "subsec:Cite-Engine-Files"
662 \begin_layout Labeling
663 \labelwidthstring 00.00.0000
664 \begin_inset Flex Code
667 \begin_layout Plain Layout
673 Contains graphics files that can be included in documents.
677 \begin_layout Labeling
678 \labelwidthstring 00.00.0000
679 \begin_inset Flex Code
682 \begin_layout Plain Layout
688 Contains \SpecialChar LyX
689 documentation files (including the one you are currently reading).
691 \begin_inset Flex Code
694 \begin_layout Plain Layout
700 deserves special attention,
702 The internationalized help docs are in subdirectories
703 \begin_inset Flex Code
706 \begin_layout Plain Layout
713 \begin_inset Quotes eld
717 \begin_inset Quotes erd
720 is the ISO language code.
722 \begin_inset CommandInset ref
724 reference "cha:Internationalizing-LyX"
732 \begin_layout Labeling
733 \labelwidthstring 00.00.0000
734 \begin_inset Flex Code
737 \begin_layout Plain Layout
743 Contains example files that explain how to use some features.
746 \begin_inset Flex Noun
749 \begin_layout Plain Layout
758 \begin_layout Labeling
759 \labelwidthstring 00.00.0000
760 \begin_inset Flex Code
763 \begin_layout Plain Layout
769 Contains image files that are used by the
770 \begin_inset Flex Noun
773 \begin_layout Plain Layout
781 it also contains the individual icons used in the toolbar and the banners that can be shown when \SpecialChar LyX
785 \begin_layout Labeling
786 \labelwidthstring 00.00.0000
787 \begin_inset Flex Code
790 \begin_layout Plain Layout
796 Contains keyboard keymapping files.
798 \begin_inset CommandInset ref
800 reference "sec:International-Keymap-Stuff"
808 \begin_layout Labeling
809 \labelwidthstring 00.00.0000
810 \begin_inset Flex Code
813 \begin_layout Plain Layout
819 Contains the text class and module files described in
820 \begin_inset CommandInset ref
822 reference "cha:Installing-New-Document"
830 \begin_layout Labeling
831 \labelwidthstring 00.00.0000
832 \begin_inset Flex Code
835 \begin_layout Plain Layout
842 \begin_inset Flex Code
845 \begin_layout Plain Layout
851 Python scripts used to convert between \SpecialChar LyX
853 These can be run from the command line if you want to batch-convert files.
856 \begin_layout Labeling
857 \labelwidthstring 00.00.0000
858 \begin_inset Flex Code
861 \begin_layout Plain Layout
867 Contains some files that demonstrate the capabilities of the
868 \begin_inset Flex Noun
871 \begin_layout Plain Layout
882 Also contains some scripts used by \SpecialChar LyX
886 \begin_layout Labeling
887 \labelwidthstring 00.00.0000
888 \begin_inset Flex Code
891 \begin_layout Plain Layout
897 Contains the standard \SpecialChar LyX
898 template files described in
899 \begin_inset CommandInset ref
901 reference "subsec:Creating-Templates"
909 \begin_layout Labeling
910 \labelwidthstring 00.00.0000
911 \begin_inset Flex Code
914 \begin_layout Plain Layout
920 Contains files with the extension
921 \begin_inset Flex Code
924 \begin_layout Plain Layout
930 that define the user interface to \SpecialChar LyX
933 the files define which items appear in which menus and the items appearing on the toolbar.
936 \begin_layout Labeling
937 \labelwidthstring 00.00.0000
938 \begin_inset Flex Code
941 \begin_layout Plain Layout
947 Contains files with the extension
948 \begin_inset Flex Code
951 \begin_layout Plain Layout
957 which define the templates for the insertion of external material to a \SpecialChar LyX
960 \begin_inset CommandInset ref
962 reference "chap:Including-External-Material"
970 \begin_layout Subsection
971 Files you don't want to modify
974 \begin_layout Standard
975 These files are used internally by \SpecialChar LyX
976 and you generally do not need to modify them unless you are a developer.
979 \begin_layout Labeling
980 \labelwidthstring 00.00.0000
981 \begin_inset Flex Code
984 \begin_layout Plain Layout
990 This file contains the list of \SpecialChar LyX
992 The contents are displayed with the menu entry
993 \begin_inset Flex Noun
996 \begin_layout Plain Layout
997 Help\SpecialChar menuseparator
1010 \begin_layout Labeling
1011 \labelwidthstring 00.00.0000
1012 \begin_inset Flex Code
1015 \begin_layout Plain Layout
1021 This is a \SpecialChar LaTeX
1022 script used during the configuration process.
1023 Do not run directly.
1026 \begin_layout Labeling
1027 \labelwidthstring 00.00.0000
1028 \begin_inset Flex Code
1031 \begin_layout Plain Layout
1037 This is a Python script that is used to re-configure \SpecialChar LyX
1039 It creates configuration files in the directory it was run from.
1042 \begin_layout Subsection
1043 Other files needing a line or two
1046 \begin_layout Labeling
1047 \labelwidthstring 00.00.0000
1048 \begin_inset Flex Code
1051 \begin_layout Plain Layout
1057 This contains tables describing how different character encodings can be mapped to Unicode
1060 \begin_layout Labeling
1061 \labelwidthstring 00.00.0000
1062 \begin_inset Flex Code
1065 \begin_layout Plain Layout
1071 This file contains a list of all the languages currently supported by \SpecialChar LyX
1075 \begin_layout Labeling
1076 \labelwidthstring 00.00.0000
1077 \begin_inset Flex Code
1080 \begin_layout Plain Layout
1086 Contains information about the supported fonts.
1089 \begin_layout Labeling
1090 \labelwidthstring 00.00.0000
1091 \begin_inset Flex Code
1094 \begin_layout Plain Layout
1100 This file contains translations for internationalized paragraph styles (see
1101 \begin_inset CommandInset ref
1103 reference "subsec:I18n"
1111 \begin_layout Labeling
1112 \labelwidthstring 00.00.0000
1113 \begin_inset Flex Code
1116 \begin_layout Plain Layout
1122 This file contains information about Unicode-encoded glyphs and the way they are supported by \SpecialChar LyX
1123 via \SpecialChar LaTeX
1127 \begin_layout Section
1128 Your local configuration directory
1131 \begin_layout Standard
1132 Even if you are using \SpecialChar LyX
1133 as an unprivileged user,
1134 you might want to change \SpecialChar LyX
1135 configuration for your own use.
1137 \begin_inset Flex Code
1140 \begin_layout Plain Layout
1146 directory contains all your personal configuration files.
1147 This is the directory described as
1148 \begin_inset Quotes eld
1152 \begin_inset Quotes erd
1156 \begin_inset Flex Noun
1159 \begin_layout Plain Layout
1160 Help\SpecialChar menuseparator
1162 \begin_inset space ~
1171 This directory is used as a mirror of
1172 \begin_inset Flex Code
1175 \begin_layout Plain Layout
1182 which means that every file in
1183 \begin_inset Flex Code
1186 \begin_layout Plain Layout
1192 is a replacement for the corresponding file in
1193 \begin_inset Flex Code
1196 \begin_layout Plain Layout
1203 Any configuration file described in the above sections can be placed either in the system-wide directory,
1204 in which case it will affect all users,
1205 or in your local directory for your own use.
1208 \begin_layout Standard
1209 To make things clearer,
1210 let's provide a few examples:
1213 \begin_layout Itemize
1214 The preferences set in the
1215 \begin_inset Flex Noun
1218 \begin_layout Plain Layout
1219 Tools\SpecialChar menuseparator
1225 dialog are saved to a file
1226 \begin_inset Flex Code
1229 \begin_layout Plain Layout
1236 \begin_inset Flex Code
1239 \begin_layout Plain Layout
1248 \begin_layout Itemize
1249 When you reconfigure using
1250 \begin_inset Flex Noun
1253 \begin_layout Plain Layout
1254 Tools\SpecialChar menuseparator
1263 \begin_inset Flex Code
1266 \begin_layout Plain Layout
1273 and the resulting files are written in your local configuration directory.
1274 This means that any additional text class file that you might have added in
1275 \begin_inset Flex Code
1278 \begin_layout Plain Layout
1284 will be added to the list of classes in the
1285 \begin_inset Flex Noun
1288 \begin_layout Plain Layout
1289 Document\SpecialChar menuseparator
1298 \begin_layout Itemize
1299 If you get some updated documentation from a \SpecialChar LyX
1300 ftp site and cannot install it because you do not have sysadmin rights on your system,
1301 you can just copy the files to
1302 \begin_inset Flex Code
1305 \begin_layout Plain Layout
1311 and the items in the
1312 \begin_inset Flex Noun
1315 \begin_layout Plain Layout
1321 menu will open them!
1324 \begin_layout Section
1325 Running \SpecialChar LyX
1326 with multiple configurations
1329 \begin_layout Standard
1330 The configuration freedom of the local configuration directory may not suffice if you want to have more than one configuration at your disposal.
1332 you may want to use different key bindings or printer settings at different times.
1333 You can achieve this by having several such directories.
1334 You then specify which directory to use at run-time.
1337 \begin_layout Standard
1338 Invoking \SpecialChar LyX
1339 with the command line switch
1340 \begin_inset Flex Code
1343 \begin_layout Plain Layout
1353 instructs the program to read the configuration from that directory,
1354 and not from the default directory.
1355 (You can determine the default directory by running \SpecialChar LyX
1357 \begin_inset Flex Code
1360 \begin_layout Plain Layout
1366 switch.) If the specified directory does not exist,
1368 offers to create it for you,
1369 just like it does for the default directory the first time you run the program.
1370 You can modify the configuration options in this additional user directory exactly as you would for the default directory.
1371 These directories are completely independent (but read on).
1372 Note that setting the environment variable
1373 \begin_inset Flex Code
1376 \begin_layout Plain Layout
1382 to some value has exactly the same effect.
1385 \begin_layout Standard
1386 Having several configurations also requires more maintenance:
1387 if you want to add a new layout to
1388 \begin_inset Flex Code
1391 \begin_layout Plain Layout
1397 which you want available from all your configurations,
1398 you must add it to each directory separately.
1399 You can avoid this with the following trick:
1400 after \SpecialChar LyX
1401 creates the additional directory,
1402 most of the subdirectories (see above) are empty.
1403 If you want the new configuration to mirror an existing one,
1404 replace the empty subdirectory with a symbolic link to the matching subdirectory in the existing configuration.
1406 \begin_inset Flex Code
1409 \begin_layout Plain Layout
1417 since it contains a file written by the configuration script (also accessible through
1418 \begin_inset Flex Noun
1421 \begin_layout Plain Layout
1422 Tools\SpecialChar menuseparator
1428 ) which is configuration specific.
1431 \begin_layout Chapter
1432 The Preferences dialog
1435 \begin_layout Standard
1436 All options of the preferences dialog are described in the Appendix
1438 The Preferences Dialog
1445 For some options you might find here more details.
1448 \begin_layout Section
1450 \begin_inset CommandInset label
1459 \begin_layout Standard
1460 The first step is to define your file formats if they are not already defined.
1463 \begin_inset Flex Noun
1466 \begin_layout Plain Layout
1467 Tools\SpecialChar menuseparator
1475 \begin_inset Flex Noun
1478 \begin_layout Plain Layout
1479 File Handling\SpecialChar menuseparator
1486 \begin_inset Flex Noun
1489 \begin_layout Plain Layout
1495 button to define your new format.
1497 \begin_inset Flex Noun
1500 \begin_layout Plain Layout
1506 field contains the name used to identify the format in the GUI.
1508 \begin_inset Flex Noun
1511 \begin_layout Plain Layout
1517 is used to identify the format internally.
1518 You will also need to enter a file extension.
1519 These are all required.
1521 \begin_inset Flex Noun
1524 \begin_layout Plain Layout
1530 field is used to provide a keyboard shortcut on the menus.
1533 \begin_inset Flex Noun
1536 \begin_layout Plain Layout
1543 \begin_inset Flex Noun
1546 \begin_layout Plain Layout
1547 Document\SpecialChar menuseparator
1548 View (Other Formats)\SpecialChar menuseparator
1557 \begin_layout Standard
1559 \begin_inset Flex Noun
1562 \begin_layout Plain Layout
1569 \begin_inset Flex Noun
1572 \begin_layout Plain Layout
1580 you might want to use
1581 \begin_inset Flex Noun
1584 \begin_layout Plain Layout
1590 to view PostScript files.
1591 You can enter the command needed to start the program in the corresponding fields.
1592 In defining this command,
1593 you can use the four variables listed in the next section.
1594 The viewer is launched when you view an image in \SpecialChar LyX
1596 \begin_inset Flex Noun
1599 \begin_layout Plain Layout
1600 Document\SpecialChar menuseparator
1607 The editor is for example launched when you right-click on an image and choose
1608 \begin_inset Flex Noun
1611 \begin_layout Plain Layout
1617 in the appearing context menu.
1620 \begin_layout Standard
1622 \begin_inset Flex Noun
1625 \begin_layout Plain Layout
1631 type of a format is optional,
1632 but if it is specified,
1633 it must be unique across all formats.
1634 It is used to detect files of this format from the file contents.
1635 For some important file formats there is no MIME type officially registered with the
1636 \begin_inset CommandInset href
1639 target "http://www.iana.org/assignments/media-types/"
1645 Therefore \SpecialChar LyX
1646 uses the extended list of MIME types as specified by
1647 \begin_inset CommandInset href
1649 name "freedesktop.org"
1650 target "http://www.freedesktop.org/wiki/Specifications/shared-mime-info-spec"
1658 \begin_layout Standard
1660 \begin_inset Flex Noun
1663 \begin_layout Plain Layout
1669 option tells \SpecialChar LyX
1670 that a format is suitable for document export.
1671 If this is set and if a suitable conversion route exists (see
1672 \begin_inset CommandInset ref
1674 reference "sec:Converters"
1680 the format will appear in the
1681 \begin_inset Flex Noun
1684 \begin_layout Plain Layout
1685 File\SpecialChar menuseparator
1692 The format will also appear in the
1693 \begin_inset Flex Noun
1696 \begin_layout Plain Layout
1697 Document\SpecialChar menuseparator
1703 menu if a viewer is specified for the format.
1706 \begin_inset Flex Code
1709 \begin_layout Plain Layout
1716 should not use this option.
1717 Formats that can both represent vector graphics and documents like
1718 \begin_inset Flex Code
1721 \begin_layout Plain Layout
1730 \begin_layout Standard
1732 \begin_inset Flex Noun
1735 \begin_layout Plain Layout
1736 Vector graphics format
1741 tells \SpecialChar LyX
1742 that a format can contain vector graphics.
1743 This information is used to determine the target format of included graphics for
1744 \begin_inset Flex Noun
1747 \begin_layout Plain Layout
1754 Included graphics may need to be converted to either
1755 \begin_inset Flex Noun
1758 \begin_layout Plain Layout
1766 \begin_inset Flex Noun
1769 \begin_layout Plain Layout
1777 \begin_inset Flex Noun
1780 \begin_layout Plain Layout
1788 \begin_inset Flex Noun
1791 \begin_layout Plain Layout
1797 cannot handle other image formats.
1798 If an included graphic is not already in
1799 \begin_inset Flex Noun
1802 \begin_layout Plain Layout
1810 \begin_inset Flex Noun
1813 \begin_layout Plain Layout
1821 \begin_inset Flex Noun
1824 \begin_layout Plain Layout
1832 \begin_inset Flex Noun
1835 \begin_layout Plain Layout
1841 if the vector format option is set,
1843 \begin_inset Flex Noun
1846 \begin_layout Plain Layout
1855 \begin_layout Section
1859 \begin_layout Standard
1860 Since all conversions from one format to another take place in \SpecialChar LyX
1861 's temporary directory,
1862 it is sometimes necessary to modify a file before copying it to the temporary directory in order that the conversion may be performed.
1866 \begin_layout Plain Layout
1868 the file may refer to other files—
1871 using relative file names,
1872 and these may become invalid when the file is copied to the temporary directory.
1877 This is done by a Copier:
1878 It copies a file to (or from) the temporary directory and may modify it in the process.
1881 \begin_layout Standard
1882 The definitions of the copiers may use eight variables:
1885 \begin_layout Labeling
1886 \labelwidthstring 00.00.0000
1887 \begin_inset Flex Code
1890 \begin_layout Plain Layout
1896 The \SpecialChar LyX
1897 system directory (e.
1898 \begin_inset space \thinspace{}
1902 \begin_inset space \space{}
1906 \begin_inset Flex Noun
1909 \begin_layout Plain Layout
1918 \begin_layout Labeling
1919 \labelwidthstring 00.00.0000
1920 \begin_inset Flex Code
1923 \begin_layout Plain Layout
1932 \begin_layout Labeling
1933 \labelwidthstring 00.00.0000
1934 \begin_inset Flex Code
1937 \begin_layout Plain Layout
1946 \begin_layout Labeling
1947 \labelwidthstring 00.00.0000
1948 \begin_inset Flex Code
1951 \begin_layout Plain Layout
1957 The base name (without filename extension) in the \SpecialChar LyX
1961 \begin_layout Labeling
1962 \labelwidthstring 00.00.0000
1963 \begin_inset Flex Code
1966 \begin_layout Plain Layout
1972 The full directory path of the \SpecialChar LyX
1976 \begin_layout Labeling
1977 \labelwidthstring 00.00.0000
1978 \begin_inset Flex Code
1981 \begin_layout Plain Layout
1987 The full pathname to the original \SpecialChar LyX
1988 file being processed
1991 \begin_layout Labeling
1992 \labelwidthstring 00.00.0000
1993 \begin_inset Flex Code
1996 \begin_layout Plain Layout
2002 The filename (without any directory path) of the \SpecialChar LyX
2006 \begin_layout Labeling
2007 \labelwidthstring 00.00.0000
2008 \begin_inset Flex Code
2011 \begin_layout Plain Layout
2017 The `\SpecialChar LaTeX
2021 \begin_layout Standard
2022 The latter should be the filename as it would be used in a \SpecialChar LaTeX
2030 It is relevant only when exporting files suitable for such inclusion.
2033 \begin_layout Standard
2034 Copiers can be used to do almost anything with output files.
2036 suppose you want generated pdf files to be copied to a special directory,
2038 \begin_inset Flex Code
2041 \begin_layout Plain Layout
2048 Then you could write a shell script such as this one:
2051 \begin_layout Standard
2052 \begin_inset listings
2056 \begin_layout Plain Layout
2061 \begin_layout Plain Layout
2066 \begin_layout Plain Layout
2068 TOFILE=`basename $2`
2071 \begin_layout Plain Layout
2073 cp $FROMFILE /home/you/pdf/$TOFILE
2078 Save it in your local \SpecialChar LyX
2082 \begin_inset Flex Code
2085 \begin_layout Plain Layout
2086 /home/you/.lyx/scripts/pdfcopier.sh
2092 and make it executable,
2093 if you need to do so on your platform.
2096 \begin_inset Flex Noun
2099 \begin_layout Plain Layout
2100 Tools\SpecialChar menuseparator
2108 \begin_inset Flex Noun
2111 \begin_layout Plain Layout
2112 File Handling\SpecialChar menuseparator
2119 \begin_inset Flex Noun
2122 \begin_layout Plain Layout
2129 or one of the other pdf formats—
2131 \begin_inset Flex Code
2134 \begin_layout Plain Layout
2135 pdfcopier.sh $$i $$o
2141 \begin_inset Flex Noun
2144 \begin_layout Plain Layout
2154 \begin_layout Standard
2155 Copiers are used by \SpecialChar LyX
2156 in various of its own conversions.
2158 if appropriate programs are found,
2160 will automatically install copiers for the
2161 \begin_inset Flex Noun
2164 \begin_layout Plain Layout
2171 \begin_inset Flex Noun
2174 \begin_layout Plain Layout
2176 \begin_inset space ~
2185 When these formats are exported,
2186 the copier sees that not just the main HTML file but various associated files (style files,
2188 etc.) are also copied.
2189 All these files are written to a subdirectory of the directory in which the original \SpecialChar LyX
2194 \begin_layout Plain Layout
2195 This copier can be customized.
2197 \begin_inset Quotes eld
2201 \begin_inset Quotes erd
2204 argument takes a comma-separated list of extensions to be copied;
2206 all files will be copied.
2208 \begin_inset Quotes eld
2212 \begin_inset Quotes erd
2215 argument determines the extension added to the generated directory.
2218 \begin_inset Quotes eld
2222 \begin_inset Flex Noun
2225 \begin_layout Plain Layout
2232 \begin_inset Quotes erd
2236 so HTML generated from
2237 \begin_inset Flex Noun
2240 \begin_layout Plain Layout
2241 /path/to/filename.lyx
2247 \begin_inset Flex Noun
2250 \begin_layout Plain Layout
2251 /path/to/filename.html.LyXconv
2265 \begin_layout Section
2267 \begin_inset CommandInset label
2269 name "sec:Converters"
2276 \begin_layout Standard
2277 You can define your own Converters to convert files between different formats.
2279 \begin_inset Flex Noun
2282 \begin_layout Plain Layout
2283 Tools\SpecialChar menuseparator
2284 Preferences\SpecialChar menuseparator
2285 File Handling\SpecialChar menuseparator
2294 \begin_layout Standard
2295 To define a new converter,
2297 \begin_inset Flex Noun
2300 \begin_layout Plain Layout
2302 \begin_inset space ~
2311 \begin_inset Flex Noun
2314 \begin_layout Plain Layout
2316 \begin_inset space ~
2324 from the drop-down lists,
2325 enter the command needed for the conversion,
2327 \begin_inset Flex Noun
2330 \begin_layout Plain Layout
2337 Several variables can be used in the definition of converters:
2340 \begin_layout Labeling
2341 \labelwidthstring 00.00.0000
2342 \begin_inset Flex Code
2345 \begin_layout Plain Layout
2351 The \SpecialChar LyX
2355 \begin_layout Labeling
2356 \labelwidthstring 00.00.0000
2357 \begin_inset Flex Code
2360 \begin_layout Plain Layout
2369 \begin_layout Labeling
2370 \labelwidthstring 00.00.0000
2371 \begin_inset Flex Code
2374 \begin_layout Plain Layout
2383 \begin_layout Labeling
2384 \labelwidthstring 00.00.0000
2385 \begin_inset Flex Code
2388 \begin_layout Plain Layout
2394 The base filename of the input file (i.
2395 \begin_inset space \thinspace{}
2399 without the extension)
2402 \begin_layout Labeling
2403 \labelwidthstring 00.00.0000
2404 \begin_inset Flex Code
2407 \begin_layout Plain Layout
2413 The path to the input file
2416 \begin_layout Labeling
2417 \labelwidthstring 00.00.0000
2418 \begin_inset Flex Code
2421 \begin_layout Plain Layout
2427 The path to the original input file (this is different from $$p when a chain of converters is called)
2430 \begin_layout Labeling
2431 \labelwidthstring 00.00.0000
2432 \begin_inset Flex Code
2435 \begin_layout Plain Layout
2441 The iconv name for the encoding of the document.
2444 \begin_layout Standard
2446 \begin_inset Flex Noun
2449 \begin_layout Plain Layout
2451 \begin_inset space ~
2459 field you can enter the following flags,
2460 separated by commas:
2463 \begin_layout Labeling
2464 \labelwidthstring 00.00.0000
2465 \begin_inset Flex Code
2468 \begin_layout Plain Layout
2474 This converter runs some form of \SpecialChar LaTeX
2476 This will make \SpecialChar LyX
2477 's \SpecialChar LaTeX
2478 error logs available.
2480 \begin_inset Flex Code
2483 \begin_layout Plain Layout
2489 value specifies the form of \SpecialChar LaTeX
2491 \begin_inset Flex Code
2494 \begin_layout Plain Layout
2505 If no value is specified,
2507 \begin_inset Flex Code
2510 \begin_layout Plain Layout
2519 \begin_layout Labeling
2520 \labelwidthstring 00.00.0000
2521 \begin_inset Flex Code
2524 \begin_layout Plain Layout
2530 This converter is considered non-safe and needs authorization by the user.
2531 Depending on the settings in
2533 Tools\SpecialChar menuseparator
2534 Preferences\SpecialChar menuseparator
2535 File Handling\SpecialChar menuseparator
2539 users will (a.) be asked whether they trust the current document temporarily,
2542 (b.) be informed that conversion is not possible due to security concerns,
2543 or (c.) not be informed as they gave permanent consent.
2544 Set this flag for converters that might execute arbitrary programs.
2547 \begin_layout Labeling
2548 \labelwidthstring 00.00.0000
2549 \begin_inset Flex Code
2552 \begin_layout Plain Layout
2558 Needs the \SpecialChar LaTeX
2560 \begin_inset Flex Noun
2563 \begin_layout Plain Layout
2569 file for the conversion.
2571 \begin_inset Flex Code
2574 \begin_layout Plain Layout
2580 value specifies the form of \SpecialChar LaTeX
2581 that is run in order to generate the
2582 \begin_inset Flex Noun
2585 \begin_layout Plain Layout
2592 \begin_inset Flex Code
2595 \begin_layout Plain Layout
2606 If no value is specified,
2608 \begin_inset Flex Code
2611 \begin_layout Plain Layout
2620 \begin_layout Labeling
2621 \labelwidthstring 00.00.0000
2622 \begin_inset Flex Code
2625 \begin_layout Plain Layout
2632 \begin_inset Quotes eld
2636 \begin_inset Quotes erd
2639 file from the backend,
2640 which in practice means a \SpecialChar LaTeX
2641 file like the one we would export,
2643 \begin_inset Flex Code
2646 \begin_layout Plain Layout
2655 \begin_layout Labeling
2656 \labelwidthstring 00.00.0000
2657 \begin_inset Flex Code
2660 \begin_layout Plain Layout
2669 \begin_layout Standard
2670 The following three flags are not really flags at all because they take an argument in the
2671 \begin_inset Flex Noun
2674 \begin_layout Plain Layout
2676 \begin_inset space ~
2680 \begin_inset space ~
2691 \begin_layout Labeling
2692 \labelwidthstring 00.00.0000
2693 \begin_inset Flex Code
2696 \begin_layout Plain Layout
2702 The name of the driver that needs to be loaded with the
2706 package for this converter.
2707 The loading of the correct driver is necessary to get some PDF-specific features.
2715 \begin_layout Labeling
2716 \labelwidthstring 00.00.0000
2717 \begin_inset Flex Code
2720 \begin_layout Plain Layout
2727 the converter's standard error will be redirected to a file
2728 \begin_inset Flex Code
2731 \begin_layout Plain Layout
2738 and the script given as argument will be run as:
2740 \begin_inset Flex Code
2743 \begin_layout Plain Layout
2744 script < infile.out > infile.log
2750 The argument may contain
2751 \begin_inset Flex Code
2754 \begin_layout Plain Layout
2763 \begin_layout Labeling
2764 \labelwidthstring 00.00.0000
2765 \begin_inset Flex Code
2768 \begin_layout Plain Layout
2774 The name of the directory in which the converter will dump the generated files.
2776 will not create this directory,
2777 and it does not copy anything into it,
2778 though it will copy this directory to the destination.
2779 The argument may contain
2780 \begin_inset Flex Code
2783 \begin_layout Plain Layout
2790 which will be replaced by the base name of the input and output files,
2792 when the directory is copied.
2793 \begin_inset Newline newline
2796 Note that resultdir and usetempdir make no sense together.
2797 The latter will be ignored if the former is given.
2800 \begin_layout Labeling
2801 \labelwidthstring 00.00.0000
2802 \begin_inset Flex Code
2805 \begin_layout Plain Layout
2811 Determines the output file name and may,
2813 \begin_inset Flex Code
2816 \begin_layout Plain Layout
2823 Sensible only with resultdir and optional even then;
2825 it defaults to `index'.
2828 \begin_layout Standard
2829 A suitable hyperref-driver is set for some converters that are installed with \SpecialChar LyX
2831 The last three flags,
2833 are presently not used in any of the pre-installed converters.
2836 \begin_layout Standard
2837 You do not have to define converters for all formats between which you want to convert.
2839 you will note that there is no `\SpecialChar LyX
2840 to PostScript' converter,
2841 but \SpecialChar LyX
2842 will export PostScript.
2843 It does so by first creating a \SpecialChar LaTeX
2844 file (no converter needs to be defined for this) which is then converted to DVI using the `\SpecialChar LaTeX
2846 and finally converting the resulting DVI file to PostScript.
2848 finds such `chains' of converters automatically,
2849 and it will always choose the shortest possible chain.
2852 still define multiple conversion methods between file formats.
2854 the standard \SpecialChar LyX
2855 configuration provides five ways to convert \SpecialChar LaTeX
2859 \begin_layout Enumerate
2862 \begin_inset Flex Noun
2865 \begin_layout Plain Layout
2874 \begin_layout Enumerate
2875 via (DVI and) PostScript,
2877 \begin_inset Flex Noun
2880 \begin_layout Plain Layout
2889 \begin_layout Enumerate
2892 \begin_inset Flex Noun
2895 \begin_layout Plain Layout
2904 \begin_layout Enumerate
2906 \begin_inset Flex Noun
2909 \begin_layout Plain Layout
2919 \begin_layout Enumerate
2921 \begin_inset Flex Noun
2924 \begin_layout Plain Layout
2934 \begin_layout Standard
2935 To define such alternate chains,
2936 you must define multiple target `file formats',
2938 \begin_inset CommandInset ref
2940 reference "sec:Formats"
2947 in the standard configuration,
2949 \begin_inset Flex Noun
2952 \begin_layout Plain Layout
2959 \begin_inset Flex Noun
2962 \begin_layout Plain Layout
2970 \begin_inset Flex Noun
2973 \begin_layout Plain Layout
2980 \begin_inset Flex Noun
2983 \begin_layout Plain Layout
2991 \begin_inset Flex Noun
2994 \begin_layout Plain Layout
3001 \begin_inset Flex Noun
3004 \begin_layout Plain Layout
3012 \begin_inset Flex Noun
3015 \begin_layout Plain Layout
3022 \begin_inset Flex Noun
3025 \begin_layout Plain Layout
3034 \begin_inset Flex Noun
3037 \begin_layout Plain Layout
3044 \begin_inset Flex Noun
3047 \begin_layout Plain Layout
3055 all of which share the extension
3056 \begin_inset Flex Noun
3059 \begin_layout Plain Layout
3066 and which correspond to the conversion methods just mentioned.
3069 \begin_layout Chapter
3070 Internationalizing \SpecialChar LyX
3072 \begin_inset CommandInset label
3074 name "cha:Internationalizing-LyX"
3081 \begin_layout Standard
3083 supports using a translated interface.
3084 Last time we checked,
3086 provided text in thirty languages.
3087 The language of choice is called your
3092 (For further reading on locale settings,
3093 see also the documentation for locale that comes with your operating system.
3096 \begin_inset Flex Code
3099 \begin_layout Plain Layout
3105 could be a good place to start).
3108 \begin_layout Standard
3109 Notice that these translations will work,
3110 but do contain a few flaws.
3112 all dialogs have been designed with the English text in mind,
3113 which means that some of the translated text will be too large to fit within the space allocated.
3114 This is only a display problem and will not cause any harm.
3116 you will find that some of the translations do not define shortcut keys for everything.
3118 there are simply not enough free letters to do it.
3120 the translator just hasn't got around to doing it yet.
3121 Our localization team,
3122 which you may wish to join,
3126 \begin_layout Plain Layout
3127 If you are a fluent speaker of a language other than English,
3128 joining these teams is a great way to give back to the \SpecialChar LyX
3134 will of course try to fix these shortcomings in future versions of \SpecialChar LyX
3138 \begin_layout Section
3139 Translating \SpecialChar LyX
3143 \begin_layout Subsection
3144 Translating the graphical user interface (text messages).
3147 \begin_layout Standard
3150 \begin_inset Flex Code
3153 \begin_layout Plain Layout
3159 library to handle the internationalization of the interface.
3160 To have \SpecialChar LyX
3161 speak your favorite language in all menus and dialogs,
3163 \begin_inset Flex Code
3166 \begin_layout Plain Layout
3172 -file for that language.
3173 When this is available,
3174 you'll have to generate a
3175 \begin_inset Flex Code
3178 \begin_layout Plain Layout
3184 -file from it and install the
3185 \begin_inset Flex Code
3188 \begin_layout Plain Layout
3195 The process of doing all of this is explained in the documentation for GNU
3196 \begin_inset Flex Code
3199 \begin_layout Plain Layout
3206 It is possible to do this just for yourself,
3207 but if you're going to do it,
3208 you might as well share the results of your labors with the rest of the \SpecialChar LyX
3210 Send a message to the \SpecialChar LyX
3211 developers' list for more information about how to proceed.
3214 \begin_layout Standard
3216 this is what you should do (xx denotes the language code):
3219 \begin_layout Itemize
3220 Check out the \SpecialChar LyX
3223 \begin_inset CommandInset href
3225 name "information on the web"
3226 target "https://www.lyx.org/HowToUseGIT"
3234 \begin_layout Itemize
3236 \begin_inset Flex Code
3239 \begin_layout Plain Layout
3245 to the folder of the
3246 \begin_inset Flex Code
3249 \begin_layout Plain Layout
3257 \begin_inset Flex Code
3260 \begin_layout Plain Layout
3268 \begin_inset Flex Code
3271 \begin_layout Plain Layout
3277 doesn't exist anywhere,
3278 it can be remade with the console command
3279 \begin_inset Flex Code
3282 \begin_layout Plain Layout
3289 or you can use an existing po-file for some other language as a template).
3292 \begin_layout Itemize
3294 \begin_inset Flex Code
3297 \begin_layout Plain Layout
3307 \begin_layout Plain Layout
3308 This is just a text file,
3309 so it can be edited in any text editor.
3310 But there are also specialized programs that support such editing,
3315 (for all platforms) or
3324 contains a `mode' for editing
3325 \begin_inset Flex Code
3328 \begin_layout Plain Layout
3337 \begin_inset Flex URL
3340 \begin_layout Plain Layout
3342 https://www.gnu.org/software/gettext/manual/html_node/PO-Mode.html#PO-Mode
3352 For some menu- and widget-labels,
3353 there are also shortcut keys that should be translated.
3354 Those keys are marked after a `|',
3355 and should be translated according to the words and phrases of the language.
3356 You should also fill also out the information at the beginning of the new
3357 \begin_inset Flex Code
3360 \begin_layout Plain Layout
3366 -file with your email-address,
3368 so people know where to reach you with suggestions and entertaining flames.
3371 \begin_layout Standard
3372 If you are just doing this on your own,
3376 \begin_layout Itemize
3378 \begin_inset Flex Code
3381 \begin_layout Plain Layout
3388 This can be done with
3389 \begin_inset Flex Code
3392 \begin_layout Plain Layout
3393 msgfmt -o xx.mo < xx.po
3401 \begin_layout Itemize
3403 \begin_inset Flex Code
3406 \begin_layout Plain Layout
3412 -file to your locale-tree,
3413 at the correct directory for application messages for the language
3419 \begin_inset Flex Code
3422 \begin_layout Plain Layout
3429 \begin_inset space \thinspace{}
3433 \begin_inset space \space{}
3437 \begin_inset Flex Code
3440 \begin_layout Plain Layout
3441 /usr/local/share/locale/xx/LC_MESSAGES/lyx.mo
3451 \begin_layout Standard
3454 it would be best if the new
3455 \begin_inset Flex Code
3458 \begin_layout Plain Layout
3464 file could be added to the \SpecialChar LyX
3466 so others can use it.
3467 Adding it involves making additional changes to \SpecialChar LyX
3469 So send an email to the developers' mailing list if you're interested in doing that.
3472 \begin_layout Subsubsection
3476 \begin_layout Standard
3477 Sometimes it turns out that one English message needs to be translated into different messages in the target language.
3478 One example is the message
3479 \begin_inset Flex Code
3482 \begin_layout Plain Layout
3488 which has the German translation
3497 depending upon exactly what the English
3498 \begin_inset Quotes eld
3502 \begin_inset Quotes erd
3507 \begin_inset Flex Code
3510 \begin_layout Plain Layout
3516 does not handle such ambiguous translations.
3517 Therefore you have to add some context information to the message:
3519 \begin_inset Flex Code
3522 \begin_layout Plain Layout
3529 \begin_inset Flex Code
3532 \begin_layout Plain Layout
3533 To[[as in 'From format x to format y']]
3539 \begin_inset Flex Code
3542 \begin_layout Plain Layout
3543 To[[as in 'From page x to page y']].
3548 Now the two occurrences of
3549 \begin_inset Flex Code
3552 \begin_layout Plain Layout
3559 \begin_inset Flex Code
3562 \begin_layout Plain Layout
3568 and can be translated correctly to
3580 \begin_layout Standard
3581 Of course the context information needs to be stripped off the original message when no translation is used.
3582 Therefore you have to put it in double square brackets at the end of the message (see the example above).
3583 The translation mechanism of \SpecialChar LyX
3584 ensures that everything in double square brackets at the end of messages is removed before displaying the message.
3587 \begin_layout Subsection
3588 Translating the documentation.
3591 \begin_layout Standard
3592 The online documentation (in the
3593 \begin_inset Flex Noun
3596 \begin_layout Plain Layout
3602 -menu) can (and should!) be translated.
3603 If there are translated versions of the documentation available
3607 \begin_layout Plain Layout
3609 at least some of the documents have been translated into fourteen languages,
3610 with the Tutorial available in a few more.
3615 and the locale is set accordingly,
3616 these will be used automagically by \SpecialChar LyX
3619 looks for translated versions as
3620 \begin_inset Flex Code
3623 \begin_layout Plain Layout
3624 LyXDir/doc/xx/DocName.lyx
3631 \begin_inset Flex Code
3634 \begin_layout Plain Layout
3640 is the code for the language currently in use.
3641 If there are no translated documents,
3642 the default English versions will be displayed.
3643 Note that the translated versions must have the same filenames (
3644 \begin_inset Flex Code
3647 \begin_layout Plain Layout
3653 above) as the original.
3654 If you feel up to translating the documentation (an excellent way to proof-read the original documentation by the way!),
3655 there are a few things you should do right away:
3658 \begin_layout Itemize
3659 Check out the documentation translation web page at
3660 \begin_inset CommandInset href
3662 name "https://www.lyx.org/Translation"
3663 target "https://www.lyx.org/Translation"
3670 you can find out which (if any) documents have already been translated into your language.
3671 You can also find out who (if anyone) is organizing the effort to translate the documentation into your language.
3672 If no one is organizing the effort,
3673 please let us know that you're interested.
3676 \begin_layout Standard
3677 Once you get to actually translating,
3678 here's a few hints for you that may save you trouble:
3681 \begin_layout Itemize
3682 Join the documentation team!
3683 There is information on how to do that in
3684 \begin_inset Flex Code
3687 \begin_layout Plain Layout
3694 \begin_inset Flex Noun
3697 \begin_layout Plain Layout
3698 Help\SpecialChar menuseparator
3705 which by the way is the first document you should translate.
3708 \begin_layout Itemize
3709 Learn the typographic conventions for the language you are translating to.
3710 Typography is an ancient art and over the centuries,
3711 a great variety of conventions have developed throughout different parts of the world.
3712 Also study the professional terminology amongst typographers in your country.
3713 Inventing your own terminology will only confuse the users.
3717 Typography is addictive!)
3720 \begin_layout Itemize
3721 Make a copy of the document.
3722 This will be your working copy.
3723 You can use this as your personal translated help-file by placing it in your
3724 \begin_inset Flex Code
3727 \begin_layout Plain Layout
3734 \begin_inset Note Greyedout
3737 \begin_layout Plain Layout
3743 For a complex document with external material (images,
3745 if you make a copy e.
3746 \begin_inset space \thinspace{}
3750 \begin_inset space \space{}
3754 beware that the links to external material may be broken when the document is moved to a different place.
3755 The best way is to retrieve the \SpecialChar LyX
3757 \begin_inset Flex URL
3760 \begin_layout Plain Layout
3762 https://www.lyx.org/HowToUseGIT
3767 ) and to edit the doc file in place.
3775 \begin_layout Itemize
3776 Sometimes the original document (from the \SpecialChar LyX
3777 team) will be updated.
3778 Use the source viewer at
3779 \begin_inset CommandInset href
3781 name "https://www.lyx.org/trac/timeline"
3782 target "https://www.lyx.org/trac/timeline"
3787 to see what has been changed.
3788 That way you can easily see which parts of the translated document need to be updated.
3791 \begin_layout Standard
3792 If you ever find an error in the original document,
3793 fix it and notify the rest of the documentation team of the changes!
3794 (You didn't forget to join the documentation team,
3798 \begin_layout Standard
3799 \begin_inset Branch OutDated
3803 \begin_layout Section
3804 International Keyboard Support
3807 \begin_layout Standard
3811 The following section is by
3819 It needs to be fixed to conform to the new Documentation Style sheet and to make use of the new v1.0 features.
3820 The whole thing also needs to be merged with the section following it.-jw It may also be badly out of date.-rh (2008)]
3823 \begin_layout Subsection
3824 Defining Own Keymaps:
3828 \begin_layout Standard
3829 Let's look at a keyboard definition file a little closer.
3830 It is a plain text file defining
3833 \begin_layout Itemize
3834 key-to-key or key-to-string translations
3837 \begin_layout Itemize
3841 \begin_layout Itemize
3842 dead keys exceptions
3845 \begin_layout Standard
3846 To define key-to-key or key-to-string translation,
3850 \begin_layout Quotation
3851 \begin_inset Flex Code
3854 \begin_layout Plain Layout
3863 \begin_inset Flex Code
3866 \begin_layout Plain Layout
3875 \begin_layout Standard
3877 \begin_inset Flex Code
3880 \begin_layout Plain Layout
3886 is the key to be translated and
3887 \begin_inset Flex Code
3890 \begin_layout Plain Layout
3896 is the string to be inserted into the document.
3897 To define dead keys,
3901 \begin_layout Quotation
3902 \begin_inset Flex Code
3905 \begin_layout Plain Layout
3914 \begin_inset Flex Code
3917 \begin_layout Plain Layout
3926 \begin_layout Standard
3928 \begin_inset Flex Code
3931 \begin_layout Plain Layout
3937 is a keyboard key and
3938 \begin_inset Flex Code
3941 \begin_layout Plain Layout
3948 The following dead keys are supported (shortcut name is in parentheses):
3951 \begin_layout Quotation
3955 \begin_inset space \hfill{}
3961 \begin_layout Quotation
3963 \begin_inset space \hfill{}
3969 \begin_layout Quotation
3971 \begin_inset space \hfill{}
3977 \begin_layout Quotation
3979 \begin_inset space \hfill{}
3985 \begin_layout Quotation
3987 \begin_inset space \hfill{}
3993 \begin_layout Quotation
3995 \begin_inset space \hfill{}
4002 \begin_layout Plain Layout
4014 \begin_layout Quotation
4016 \begin_inset space \hfill{}
4022 \begin_layout Quotation
4024 \begin_inset space \hfill{}
4031 \begin_layout Plain Layout
4043 \begin_layout Quotation
4045 \begin_inset space \hfill{}
4051 \begin_layout Quotation
4053 \begin_inset space \hfill{}
4059 \begin_layout Quotation
4061 \begin_inset space \hfill{}
4068 \begin_layout Plain Layout
4080 \begin_layout Quotation
4082 \begin_inset space \hfill{}
4089 \begin_layout Plain Layout
4101 \begin_layout Quotation
4103 \begin_inset space \hfill{}
4109 \begin_layout Quotation
4110 hungarian umlaut (hug)
4111 \begin_inset space \hfill{}
4117 \begin_layout Quotation
4119 \begin_inset space \hfill{}
4125 \begin_layout Quotation
4127 \begin_inset space \hfill{}
4134 \begin_layout Plain Layout
4146 \begin_layout Standard
4147 Since in many international keyboards there are exceptions to what some dead keys should do,
4148 you can define them using
4151 \begin_layout Quotation
4152 \begin_inset Flex Code
4155 \begin_layout Plain Layout
4163 deadkey key outstring
4166 \begin_layout Standard
4169 if you enter caron-o,
4170 it generates circumflex-o,
4174 \begin_layout Quotation
4175 \begin_inset Flex Code
4178 \begin_layout Plain Layout
4191 \begin_layout Standard
4192 to make it work correctly.
4194 you have to define as exceptions dead keys over i and j,
4195 to remove the dot from them before inserting an accent mark.
4196 I will change this when the time comes,
4197 but so far I haven't had time.
4200 \begin_layout Standard
4202 and about characters:
4203 backslash is escaped,
4205 you'll need double backslash.
4208 \begin_inset Flex Code
4211 \begin_layout Plain Layout
4217 have different meaning.
4219 \begin_inset Flex Code
4222 \begin_layout Plain Layout
4229 quotes start and end \SpecialChar LaTeX
4233 \begin_inset Flex Code
4236 \begin_layout Plain Layout
4246 \begin_inset Flex Code
4249 \begin_layout Plain Layout
4257 \begin_inset Flex Code
4260 \begin_layout Plain Layout
4271 \begin_layout Standard
4272 If you make a keyboard description file that works for your language,
4273 please mail it to me,
4274 so I can include it in the next keymap distribution.
4277 \begin_layout Standard
4278 More keywords will be supported in keymap configuration file in future,
4282 \begin_layout Itemize
4283 \begin_inset Flex Code
4286 \begin_layout Plain Layout
4297 \begin_inset space \hfill{}
4301 \begin_inset Flex Code
4304 \begin_layout Plain Layout
4313 \begin_layout Itemize
4314 \begin_inset Flex Code
4317 \begin_layout Plain Layout
4328 \begin_inset space \hfill{}
4332 \begin_inset Flex Code
4335 \begin_layout Plain Layout
4341 an external keymap translation program
4344 \begin_layout Standard
4347 \begin_inset Flex Code
4350 \begin_layout Plain Layout
4359 \begin_inset Flex Code
4362 \begin_layout Plain Layout
4370 option to include default keyboard).
4378 \begin_layout Section
4379 International Keymap Stuff
4380 \begin_inset CommandInset label
4382 name "sec:International-Keymap-Stuff"
4389 \begin_layout Standard
4390 \begin_inset Note Note
4393 \begin_layout Plain Layout
4394 In doing the revisions on this document in March 2008,
4395 I did not look over this stuff,
4396 as I do not understand it.
4397 It would be good if someone else could do so.
4406 \begin_layout Standard
4407 The next two sections describe the
4408 \begin_inset Flex Code
4411 \begin_layout Plain Layout
4420 \begin_inset Flex Code
4423 \begin_layout Plain Layout
4431 file syntax in detail.
4432 These sections should help you design your own key map if the ones provided do not meet your needs.
4435 \begin_layout Subsection
4439 \begin_layout Standard
4443 \begin_inset Flex Code
4446 \begin_layout Plain Layout
4452 file maps keystrokes to characters or strings.
4453 As the name suggests,
4454 it sets a keyboard mapping.
4456 \begin_inset Flex Code
4459 \begin_layout Plain Layout
4470 \begin_inset Flex Code
4473 \begin_layout Plain Layout
4489 \begin_inset Flex Code
4492 \begin_layout Plain Layout
4506 \begin_inset Flex Code
4509 \begin_layout Plain Layout
4519 \begin_inset Flex Code
4522 \begin_layout Plain Layout
4530 are described in this section.
4533 \begin_layout Labeling
4534 \labelwidthstring 00.00.0000
4535 \begin_inset Flex Code
4538 \begin_layout Plain Layout
4546 Map a character to a string
4549 \begin_layout LyX-Code
4564 \begin_layout Standard
4598 the double-quote (")
4615 must be escaped with a preceding backslash (
4626 \begin_layout Standard
4628 \begin_inset Flex Noun
4631 \begin_layout Plain Layout
4639 statement to cause the symbol
4640 \begin_inset Flex Noun
4643 \begin_layout Plain Layout
4651 to be output for the keystroke
4652 \begin_inset Flex Noun
4655 \begin_layout Plain Layout
4666 \begin_layout LyX-Code
4672 \begin_layout Labeling
4673 \labelwidthstring 00.00.0000
4674 \begin_inset Flex Code
4677 \begin_layout Plain Layout
4685 Specify an accent character
4688 \begin_layout LyX-Code
4697 \begin_layout Standard
4698 This will make the cha
4736 This is the dead key
4740 \begin_layout Plain Layout
4747 refers to a key that does not produce a character by itself,
4748 but when followed with another key,
4749 produces the desired accent character.
4753 r with an umlaut like
4763 can be produced in this manner.
4772 \begin_layout Standard
4785 and then another key not in
4803 followed by the other,
4809 \begin_inset Flex Noun
4812 \begin_layout Plain Layout
4832 \begin_inset Flex Noun
4835 \begin_layout Plain Layout
4845 the cursor will not go one position backwards but will instead cancel the effect t
4860 might have had on the next keystroke.
4864 \begin_layout Standard
4865 The following example specifies that the character ' is to be an acute accent,
4866 allowed on the characters a,
4878 \begin_layout LyX-Code
4881 kmod ' acute aeiouAEIOU
4884 \begin_layout Labeling
4885 \labelwidthstring 00.00.0000
4886 \begin_inset Flex Code
4889 \begin_layout Plain Layout
4895 Specify an exception to the accent character
4898 \begin_layout LyX-Code
4907 \begin_layout Standard
4908 This defines an exce
4949 have been assigned a keystroke with a previous
4952 \begin_inset Flex Code
4955 \begin_layout Plain Layout
4979 must not belong in the
5027 If such a declaration does not exist in
5035 \begin_inset Flex Code
5038 \begin_layout Plain Layout
5073 \begin_inset Flex Code
5076 \begin_layout Plain Layout
5090 \begin_layout Standard
5091 The following command produces causes äi to be produced when you enter acute-i ('i):
5094 \begin_layout LyX-Code
5108 \begin_layout Labeling
5109 \labelwidthstring 00.00.0000
5110 \begin_inset Flex Code
5113 \begin_layout Plain Layout
5119 Combine two accent characters
5122 \begin_layout LyX-Code
5128 accent1 accent2 allowed
5131 \begin_layout Standard
5132 This one is getting pretty esoteric.
5133 It allows you to combine the effect
5189 \begin_inset Flex Code
5192 \begin_layout Plain Layout
5220 \begin_layout Standard
5221 Consider this example from the
5222 \begin_inset Flex Code
5225 \begin_layout Plain Layout
5236 \begin_layout LyX-Code
5240 acute aeioyvhAEIOYVH
5245 kcomb acute umlaut iyIY
5248 \begin_layout Standard
5249 This allows you to press
5250 \begin_inset Flex Noun
5253 \begin_layout Plain Layout
5261 and get the effect of
5262 \begin_inset Flex Code
5265 \begin_layout Plain Layout
5284 in this case cancels the last dead key,
5286 \begin_inset Flex Noun
5289 \begin_layout Plain Layout
5299 \begin_inset Flex Code
5302 \begin_layout Plain Layout
5315 \begin_layout Subsection
5319 \begin_layout Standard
5321 \begin_inset Flex Code
5324 \begin_layout Plain Layout
5332 mapping is performed,
5334 \begin_inset Flex Code
5337 \begin_layout Plain Layout
5347 file maps the strings that the symbols generate to characters in the current font.
5348 The \SpecialChar LyX
5349 distribution currently includes at least the
5350 \begin_inset Flex Code
5353 \begin_layout Plain Layout
5362 \begin_inset Flex Code
5365 \begin_layout Plain Layout
5376 \begin_layout Standard
5378 \begin_inset Flex Code
5381 \begin_layout Plain Layout
5389 file is a sequence of declarations of the form
5392 \begin_layout LyX-Code
5405 \begin_layout Standard
5408 \begin_inset Flex Noun
5411 \begin_layout Plain Layout
5421 to the corresponding character in the iso-8859-1 set (233),
5422 the following declaration is used
5425 \begin_layout LyX-Code
5433 \begin_layout Standard
5435 \begin_inset Flex Code
5438 \begin_layout Plain Layout
5447 \begin_inset Flex Code
5450 \begin_layout Plain Layout
5468 the same character can apply to more than one string.
5470 \begin_inset Flex Code
5473 \begin_layout Plain Layout
5484 \begin_layout LyX-Code
5496 \begin_inset Newline newline
5512 \begin_layout Standard
5514 cannot find a mapping for the string produced by the keystroke or a deadkey sequence,
5515 it will check if it looks like an accented char and try to draw an accent over the character on screen.
5518 \begin_layout Subsection
5522 \begin_layout Standard
5523 There is a second way to add support for international characters through so-called dead-keys.
5524 A dead-key works in combination with a letter to produce an accented character.
5526 we'll explain how to create a really simple dead-key to illustrate how they work.
5529 \begin_layout Standard
5530 Suppose you happen to need the circumflex character,
5532 \begin_inset Quotes eld
5536 \begin_inset Quotes erd
5541 \begin_inset Flex Noun
5544 \begin_layout Plain Layout
5551 \begin_inset space ~
5555 \begin_inset Flex Noun
5558 \begin_layout Plain Layout
5564 ] to the \SpecialChar LyX
5566 \begin_inset Flex Code
5569 \begin_layout Plain Layout
5576 \begin_inset Flex Code
5579 \begin_layout Plain Layout
5587 whenever you type the
5588 \begin_inset Flex Noun
5591 \begin_layout Plain Layout
5597 -key followed by a letter,
5598 that letter will have a circumflex accent on it.
5601 \begin_inset Quotes eld
5605 \begin_inset Flex Noun
5608 \begin_layout Plain Layout
5615 \begin_inset Quotes erd
5618 produces the letter:
5620 \begin_inset Quotes eld
5624 \begin_inset Quotes erd
5628 If you tried to type
5629 \begin_inset Quotes eld
5633 \begin_inset Flex Noun
5636 \begin_layout Plain Layout
5643 \begin_inset Quotes erd
5649 will complain with a beep,
5651 \begin_inset Quotes eld
5655 \begin_inset Flex Noun
5658 \begin_layout Plain Layout
5665 \begin_inset Quotes erd
5668 never takes a circumflex accent.
5670 \begin_inset Flex Noun
5673 \begin_layout Plain Layout
5679 after a dead-key produces the bare-accent.
5680 Please note this last point!
5681 If you bind a key to a dead-key,
5682 you'll need to rebind the character on that key to yet another key.
5684 \begin_inset Flex Noun
5687 \begin_layout Plain Layout
5693 to a cedilla is a bad idea,
5694 since you'll only get cedillas instead of commas.
5697 \begin_layout Standard
5698 One common way to bind dead-keys is to use
5699 \begin_inset Flex Noun
5702 \begin_layout Plain Layout
5710 \begin_inset Flex Noun
5713 \begin_layout Plain Layout
5721 \begin_inset Flex Noun
5724 \begin_layout Plain Layout
5730 in combination with an accent,
5732 \begin_inset Quotes eld
5736 \begin_inset Flex Noun
5739 \begin_layout Plain Layout
5746 \begin_inset Quotes erd
5750 \begin_inset Quotes eld
5754 \begin_inset Flex Noun
5757 \begin_layout Plain Layout
5764 \begin_inset Quotes erd
5768 \begin_inset Quotes eld
5772 \begin_inset Flex Noun
5775 \begin_layout Plain Layout
5782 \begin_inset Quotes erd
5786 Another way involves using
5787 \begin_inset Flex Code
5790 \begin_layout Plain Layout
5797 \begin_inset Flex Code
5800 \begin_layout Plain Layout
5806 to set up the special
5807 \begin_inset Flex Code
5810 \begin_layout Plain Layout
5818 \begin_inset Flex Code
5821 \begin_layout Plain Layout
5827 acts in some ways just like
5828 \begin_inset Flex Noun
5831 \begin_layout Plain Layout
5837 and permits you to bind keys to accented characters.
5838 You can also turn keys into dead-keys by binding them to something like
5839 \begin_inset Flex Code
5842 \begin_layout Plain Layout
5848 and then binding this symbolic key to the corresponding \SpecialChar LyX
5853 \begin_layout Plain Layout
5859 This is exactly what I do in my
5860 \begin_inset Flex Code
5863 \begin_layout Plain Layout
5870 \begin_inset Flex Code
5873 \begin_layout Plain Layout
5881 \begin_inset Flex Noun
5884 \begin_layout Plain Layout
5886 \begin_inset space ~
5895 \begin_inset Flex Code
5898 \begin_layout Plain Layout
5904 and a bunch of these
5905 \begin_inset Quotes eld
5909 \begin_inset Flex Code
5912 \begin_layout Plain Layout
5919 \begin_inset Quotes erd
5922 symbolic keys bound such things as
5923 \begin_inset Flex Noun
5926 \begin_layout Plain Layout
5928 \begin_inset space ~
5937 \begin_inset Flex Noun
5940 \begin_layout Plain Layout
5942 \begin_inset space ~
5951 This is how I produce my accented characters.
5956 You can make just about anything into the
5957 \begin_inset Flex Code
5960 \begin_layout Plain Layout
5968 \begin_inset Flex Noun
5971 \begin_layout Plain Layout
5978 a spare function key,
5980 As for the \SpecialChar LyX
5981 commands that produce accents,
5983 \begin_inset Flex Code
5986 \begin_layout Plain Layout
5997 You'll find the complete list there.
6000 \begin_layout Subsection
6001 Saving your Language Configuration
6004 \begin_layout Standard
6005 You can edit your preferences so that your desired language environment is automatically configured when \SpecialChar LyX
6008 \begin_inset Flex Noun
6011 \begin_layout Plain Layout
6012 Edit\SpecialChar menuseparator
6021 \begin_layout Chapter
6022 Creating and Installing New Document Classes,
6025 \begin_inset CommandInset label
6027 name "cha:Installing-New-Document"
6032 \begin_inset Argument 1
6035 \begin_layout Plain Layout
6036 Installing New Document Classes
6044 \begin_layout Standard
6046 we describe the procedures for creating and installing new \SpecialChar LyX
6047 layout and template files,
6048 as well as offer a refresher on correctly installing new \SpecialChar LaTeX
6053 \begin_layout Standard
6055 let us a say a few words about how one ought to think about the relation between \SpecialChar LyX
6056 and \SpecialChar LaTeX
6058 The thing to understand is that,
6061 doesn't know anything about \SpecialChar LaTeX
6064 from \SpecialChar LyX
6067 is just one of several
6068 \begin_inset Quotes eld
6072 \begin_inset Quotes erd
6075 in which it is capable of producing output.
6076 Other such formats are DocBook,
6082 a particularly important format,
6083 but very little of the information \SpecialChar LyX
6084 has about \SpecialChar LaTeX
6085 is actually contained in the program itself.
6089 \begin_layout Plain Layout
6090 Some commands are sufficiently complex that they are
6091 \begin_inset Quotes eld
6095 \begin_inset Quotes erd
6098 into \SpecialChar LyX
6100 But the developers generally regard this as a Bad Thing.
6107 even for the standard classes like
6108 \begin_inset Flex Code
6111 \begin_layout Plain Layout
6118 is contained in `layout files'.
6121 itself does not know much about DocBook or XHTML.
6122 What it knows is contained in layout files.
6125 \begin_layout Standard
6126 You can think of the layout file for a given document class as a translation manual between \SpecialChar LyX
6128 paragraphs with their corresponding styles,
6129 certain sorts of insets,
6131 and the corresponding \SpecialChar LaTeX
6134 or XHTML constructs.
6135 Almost everything \SpecialChar LyX
6137 \begin_inset Flex Code
6140 \begin_layout Plain Layout
6148 is contained in the file
6149 \begin_inset Flex Code
6152 \begin_layout Plain Layout
6158 and in various other files it includes.
6160 anyone intending to write layout files should plan to study the existing files.
6161 A good place to start is with
6162 \begin_inset Flex Code
6165 \begin_layout Plain Layout
6172 which is included in
6173 \begin_inset Flex Code
6176 \begin_layout Plain Layout
6184 \begin_inset Flex Code
6187 \begin_layout Plain Layout
6194 and many of the other layout files for document classes.
6195 This file is where sections and the like are defined:
6197 \begin_inset Flex Code
6200 \begin_layout Plain Layout
6206 tells \SpecialChar LyX
6207 how paragraphs that are marked with the Section,
6210 styles can be translated into corresponding \SpecialChar LaTeX
6213 and XHTML commands and tags.
6215 \begin_inset Flex Code
6218 \begin_layout Plain Layout
6224 file basically just includes several of these
6225 \begin_inset Flex Code
6228 \begin_layout Plain Layout
6237 \begin_layout Standard
6238 Defining the \SpecialChar LyX
6240 correspondence is not the only thing layout files do,
6242 Their other job is to define how the \SpecialChar LyX
6243 constructs themselves will appear on-screen.
6244 The fact that layout files have these two jobs is often a source of confusion,
6245 because they are completely separate.
6246 Telling \SpecialChar LyX
6247 how to translate a certain paragraph style into \SpecialChar LaTeX
6248 does not tell \SpecialChar LyX
6251 telling \SpecialChar LyX
6252 how to display a certain paragraph style does not tell \SpecialChar LyX
6253 how to translate it into \SpecialChar LaTeX
6254 (let alone tell \SpecialChar LaTeX
6258 when you define a new \SpecialChar LyX
6260 you must always do two quite separate things:
6262 \begin_inset space ~
6265 tell \SpecialChar LyX
6266 how to translate it into \SpecialChar LaTeX
6268 \begin_inset space ~
6271 tell \SpecialChar LyX
6275 \begin_layout Standard
6276 Much the same is true,
6278 as regards \SpecialChar LyX
6279 's other backend formats,
6280 though XHTML is in some ways different,
6281 because in that case \SpecialChar LyX
6288 to use information about how it should display a paragraph on the screen to output information (in the form of CSS) about how the paragraph should be displayed in a browser.
6291 the distinction between what \SpecialChar LyX
6292 does internally and how things are rendered externally remains in force,
6293 and the two can be controlled separately.
6295 \begin_inset CommandInset ref
6297 reference "sec:Tags-for-XHTML"
6305 \begin_layout Section
6306 Installing new \SpecialChar LaTeX
6310 \begin_layout Standard
6311 Some installations may not include a \SpecialChar LaTeX
6312 package or class file that you would like to use within \SpecialChar LyX
6315 you might need Foil\SpecialChar TeX
6317 a package for preparing slides for overhead projectors.
6318 Modern \SpecialChar LaTeX
6319 distributions like \SpecialChar TeX
6320 Live (2008 or newer) or MiK\SpecialChar TeX
6321 provide a user interface for installing such packages.
6323 with MiK\SpecialChar TeX
6325 you start the program
6326 \begin_inset Quotes eld
6330 \begin_inset space ~
6334 \begin_inset Quotes erd
6337 to get a list of available packages.
6338 To install one of them,
6339 right click on it or use the corresponding toolbar button.
6342 \begin_layout Standard
6343 If your \SpecialChar LaTeX
6344 distribution does not provide such a `package manager',
6345 or if the package is not available from your distribution,
6346 then follow these steps to install it manually:
6349 \begin_layout Enumerate
6350 Get the package from
6351 \begin_inset CommandInset href
6354 target "http://www.ctan.org/"
6362 \begin_layout Enumerate
6363 If the package contains a file with the ending
6364 \begin_inset Quotes eld
6368 \begin_inset Flex Code
6371 \begin_layout Plain Layout
6378 \begin_inset Quotes erd
6381 (is the case for Foil\SpecialChar TeX
6382 ) then open a console,
6383 change to the folder of this file and execute the command
6384 \begin_inset Flex Code
6387 \begin_layout Plain Layout
6394 You have now unpacked the package and have all files to install it.
6395 Most \SpecialChar LaTeX
6396 -packages are not packed and you can skip this step.
6399 \begin_layout Enumerate
6400 Now you need to decide if the package should be available for all users or only for you.
6404 \begin_layout Enumerate
6405 On *nix systems (Linux,
6408 if you want the new package to be available for all users on your system,
6409 then install it in your `local' \SpecialChar TeX
6411 otherwise install it in your own `user' \SpecialChar TeX
6413 Where these trees should be created,
6414 if they do not already exist,
6415 depends on your system.
6418 \begin_inset Flex Code
6421 \begin_layout Plain Layout
6431 \begin_layout Plain Layout
6432 This is usually in the directory
6433 \begin_inset Flex Code
6436 \begin_layout Plain Layout
6443 though you can execute the command
6444 \begin_inset Flex Code
6447 \begin_layout Plain Layout
6458 The location of the `local' \SpecialChar TeX
6459 tree is defined by the
6460 \begin_inset Flex Code
6463 \begin_layout Plain Layout
6470 this is usually somewhere like
6471 \begin_inset Flex Code
6474 \begin_layout Plain Layout
6475 /usr/local/share/texmf
6480 or /usr/local/texlive/XXXX where XXXX is the year of the installed \SpecialChar TeX
6482 The location of the `user' \SpecialChar TeX
6484 \begin_inset Flex Code
6487 \begin_layout Plain Layout
6494 \begin_inset Flex Code
6497 \begin_layout Plain Layout
6504 \begin_inset Flex Code
6507 \begin_layout Plain Layout
6516 (If these variables are not predefined,
6517 you have to define them.) You'll probably need root permissions to create or modify the `local' tree,
6518 but not for your `user' tree.
6519 \begin_inset Newline newline
6523 it is recommended to install in the user tree because your user will not be modified or even overwritten when you upgrade your system.
6524 It will typically also be backed up together with everything else when you backup your home directory (which,
6526 you do on a regular basis).
6529 \begin_layout Enumerate
6531 if you want the new package to be available for all users on your system,
6532 change to the folder where \SpecialChar LaTeX
6533 is installed and then change to the subfolder
6534 \begin_inset Flex Code
6537 \begin_layout Plain Layout
6548 (For MiK\SpecialChar TeX
6550 this would be by default the folder
6551 \begin_inset Flex Code
6554 \begin_layout Plain Layout
6572 \begin_layout Plain Layout
6573 Note that this will be the correct path only on English installations.
6576 \begin_inset Flex Code
6579 \begin_layout Plain Layout
6594 and similarly for other languages.
6599 Create there a new folder
6600 \begin_inset Flex Code
6603 \begin_layout Plain Layout
6609 and copy all files of the package into it.
6611 \begin_inset Newline newline
6614 If the package should only available for you or you don't have admin permissions,
6616 but in the local \SpecialChar LaTeX
6619 \begin_inset space \thinspace{}
6623 for MiK\SpecialChar TeX
6625 \begin_inset space ~
6628 2.8 under Windows XP,
6629 this would be the folder:
6630 \begin_inset Newline newline
6636 \begin_inset Flex Code
6639 \begin_layout Plain Layout
6642 Documents and Settings
6654 \begin_inset Newline newline
6660 \begin_inset Phantom HPhantom
6663 \begin_layout Plain Layout
6674 \begin_inset Flex Code
6677 \begin_layout Plain Layout
6690 \begin_inset Newline newline
6695 \begin_inset Newline newline
6699 \begin_inset Flex Code
6702 \begin_layout Plain Layout
6728 \begin_layout Enumerate
6729 Now one only need to tell \SpecialChar LaTeX
6730 that there are new files.
6731 This depends on the used \SpecialChar LaTeX
6736 \begin_layout Enumerate
6737 For \SpecialChar TeX
6738 Live execute the command
6739 \begin_inset Flex Code
6742 \begin_layout Plain Layout
6749 If you installed the package for all users,
6750 then you will probably need to have root permissions for that.
6753 \begin_layout Enumerate
6754 For MiK\SpecialChar TeX
6756 if you have installed the package for all users,
6758 \begin_inset Quotes eld
6762 \begin_inset space ~
6766 \begin_inset Quotes erd
6769 and press the button marked
6770 \begin_inset Quotes eld
6774 \begin_inset Quotes erd
6778 Otherwise start the program
6779 \begin_inset Quotes eld
6783 \begin_inset Quotes erd
6790 \begin_layout Enumerate
6792 you need to tell \SpecialChar LyX
6793 that there are new packages available.
6798 \begin_inset Flex Noun
6801 \begin_layout Plain Layout
6804 \SpecialChar menuseparator
6810 and then restart \SpecialChar LyX
6814 \begin_layout Standard
6815 Now the package is installed.
6818 \begin_inset Flex Code
6821 \begin_layout Plain Layout
6827 will now be available under
6828 \begin_inset Flex Noun
6831 \begin_layout Plain Layout
6832 Document\SpecialChar menuseparator
6833 Settings\SpecialChar menuseparator
6840 \begin_inset Quotes eld
6844 \begin_inset Quotes erd
6851 \begin_layout Standard
6852 If you would like to use a \SpecialChar LaTeX
6853 document class that is not even listed in the menu
6854 \begin_inset Flex Noun
6857 \begin_layout Plain Layout
6858 Document\SpecialChar menuseparator
6859 Settings\SpecialChar menuseparator
6866 then you need to create a `layout' file for it.
6867 That is the topic of the next section.
6870 \begin_layout Section
6871 Types of layout files
6874 \begin_layout Standard
6875 This section describes the various sorts of \SpecialChar LyX
6876 files that contain layout information.
6877 These files describe various paragraph and character styles,
6878 determining how \SpecialChar LyX
6879 should display them and how they should be translated into \SpecialChar LaTeX
6883 or whatever output format is being used.
6887 \begin_layout Standard
6888 We shall try to provide a thorough description of the process of writing layout files here.
6890 there are so many different types of documents supported even by just \SpecialChar LaTeX
6891 that we can't hope to cover every different possibility or problem you might encounter.
6892 The \SpecialChar LyX
6893 users' list is frequented by people with lots of experience with layout design who are willing to share what they've learned,
6894 so please feel free to ask questions there.
6897 \begin_layout Standard
6898 As you prepare to write a new layout,
6899 it is extremely helpful to look at the layouts distributed with \SpecialChar LyX
6901 If you write a \SpecialChar LyX
6902 layout for a \SpecialChar LaTeX
6903 document class that might also be used by others,
6904 or write a module that might be useful to others,
6905 then you should consider posting your layout to the
6906 \begin_inset CommandInset href
6908 name "layout section on the LyX wiki"
6909 target "https://wiki.lyx.org/Layouts/Layouts"
6914 or even to the \SpecialChar LyX
6916 so that it might be included in \SpecialChar LyX
6921 \begin_layout Plain Layout
6922 Note that \SpecialChar LyX
6923 is licensed under the General Public License,
6924 so any material that is contributed to \SpecialChar LyX
6925 must be similarly licensed.
6933 \begin_layout Subsection
6935 \begin_inset CommandInset label
6937 name "subsec:Layout-modules"
6944 \begin_layout Standard
6945 We have spoken to this point about `layout files'.
6946 But there are different sorts of files that contain layout information.
6950 \begin_inset Flex Code
6953 \begin_layout Plain Layout
6959 extension and provide \SpecialChar LyX
6960 with information about document classes.
6961 Since \SpecialChar LyX
6962 1.6 layout information can also be contained in layout
6968 \begin_inset Flex Code
6971 \begin_layout Plain Layout
6978 Modules are to \SpecialChar LaTeX
6979 packages much as layouts are to \SpecialChar LaTeX
6983 \begin_inset Flex Code
6986 \begin_layout Plain Layout
6993 specifically provide support for one package.
6995 layout modules are similar to included
6999 \begin_layout Plain Layout
7000 These can have any extension,
7001 but by convention have the
7002 \begin_inset Flex Code
7005 \begin_layout Plain Layout
7018 \begin_inset Flex Code
7021 \begin_layout Plain Layout
7028 in that modules are not specific to a given document class but may be used with many different classes.
7029 The difference is that using an included file with
7030 \begin_inset Flex Code
7033 \begin_layout Plain Layout
7039 requires editing that file.
7043 \begin_inset Flex Noun
7046 \begin_layout Plain Layout
7047 Document\SpecialChar menuseparator
7056 \begin_layout Standard
7057 Building modules is the easiest way to get started with layout editing,
7058 since it can be as simple as adding a single new paragraph style or flex inset.
7061 contain anything a layout file can contain.
7064 \begin_layout Standard
7065 After creating a new module and copying it to the
7066 \begin_inset Flex Code
7069 \begin_layout Plain Layout
7076 you will need to reconfigure and then restart \SpecialChar LyX
7077 for the module to appear in the menu.
7079 changes you make to the module will be seen immediately,
7081 \begin_inset Flex Noun
7084 \begin_layout Plain Layout
7085 Document\SpecialChar menuseparator
7092 highlight something,
7094 \begin_inset Quotes eld
7098 \begin_inset Quotes erd
7104 It is strongly recommended that you save your work before doing this
7110 it is strongly recommended that you not attempt to edit modules while simultaneously working on actual documents
7113 Though of course the developers strive to keep \SpecialChar LyX
7114 stable in such situations,
7115 syntax errors and the like in your module file could cause strange behavior.
7118 \begin_layout Subsubsection
7122 \begin_layout Standard
7123 Modules are to \SpecialChar LyX
7124 as packages are to \SpecialChar LaTeX
7128 you find yourself wanting a specific inset or character style just for one document and writing a module that will also be available to other documents makes little sense.
7129 What you need is \SpecialChar LyX
7131 \begin_inset Quotes eld
7135 \begin_inset Quotes erd
7141 \begin_layout Standard
7142 You will find it under
7144 Document\SpecialChar menuseparator
7145 Settings\SpecialChar menuseparator
7149 The large text box allows you to enter anything that you might enter in a layout file or module.
7150 You can think of a document's local layout,
7152 as a module that belongs just to it.
7156 \begin_inset Flex Code
7159 \begin_layout Plain Layout
7166 Any format is acceptable,
7167 but one would normally use the format current at the time.
7168 (In \SpecialChar LyX
7176 the current layout format is
7185 \begin_layout Standard
7186 When you have entered something in the
7187 \begin_inset Flex Code
7190 \begin_layout Plain Layout
7199 \begin_inset Quotes eld
7203 \begin_inset Quotes erd
7206 button at the bottom.
7207 Clicking this button will cause \SpecialChar LyX
7208 to determine whether what you have entered is valid layout information for the chosen format.
7210 will report the result but,
7212 will not tell you what errors there might have been.
7213 These will be written to the terminal,
7216 is started from a terminal.
7217 You will not be permitted to save your local layout until you have entered something valid.
7220 \begin_layout Standard
7221 The warnings at the end of the previous section apply here,
7223 Do not play with local layout while you are actually working,
7224 especially if you have not saved your document.
7226 using local layout with a test document can be a very convenient way to try out layout ideas,
7227 or even to start developing a module.
7230 \begin_layout Subsection
7232 \begin_inset Flex Noun
7235 \begin_layout Plain Layout
7244 \begin_layout Standard
7245 There are two situations you are likely to encounter when wanting to support a new \SpecialChar LaTeX
7248 \begin_inset Flex Code
7251 \begin_layout Plain Layout
7257 ) files and \SpecialChar LaTeX2e
7259 \begin_inset Flex Code
7262 \begin_layout Plain Layout
7269 Supporting a style file is usually fairly easy.
7270 Supporting a new class file is a bit harder.
7271 We'll discuss the former in this section and the latter in the next.
7275 \begin_layout Standard
7276 The easier case is the one in which your new document class is provided as a style file that is to be used in conjunction with an already supported document class.
7277 For the sake of the example,
7278 we'll assume that the style file is called
7279 \begin_inset Flex Noun
7282 \begin_layout Plain Layout
7288 and that it is meant to be used with
7289 \begin_inset Flex Noun
7292 \begin_layout Plain Layout
7299 which is a standard class.
7303 \begin_layout Standard
7304 Start by copying the existing class's layout file into your local directory:
7308 \begin_layout Plain Layout
7310 which directory is your local directory will vary by platform,
7311 and \SpecialChar LyX
7312 allows you to specify your local directory on startup,
7315 \begin_inset Flex Code
7318 \begin_layout Plain Layout
7332 \begin_layout LyX-Code
7333 cp report.layout ~/.lyx/layouts/myclass.layout
7336 \begin_layout Standard
7338 \begin_inset Flex Code
7341 \begin_layout Plain Layout
7347 and change the line:
7351 \begin_layout LyX-Code
7354 DeclareLaTeXClass{Report (Standard Class)}
7357 \begin_layout Standard
7361 \begin_layout LyX-Code
7364 DeclareLaTeXClass[report,
7365 myclass.sty]{Report (My Class)}
7368 \begin_layout Standard
7372 \begin_layout LyX-Code
7374 \begin_inset Newline newline
7380 \begin_inset Newline newline
7386 \begin_layout Standard
7387 near the top of the file.
7390 \begin_layout Standard
7391 Start \SpecialChar LyX
7393 \begin_inset Flex Noun
7396 \begin_layout Plain Layout
7397 Tools\SpecialChar menuseparator
7404 Then restart \SpecialChar LyX
7405 and try creating a new document.
7407 \begin_inset Flex Noun
7410 \begin_layout Plain Layout
7416 " as a document class option in the
7417 \begin_inset Flex Noun
7420 \begin_layout Plain Layout
7421 Document\SpecialChar menuseparator
7428 It is likely that some of the sectioning commands and such in your new class will work differently from how they worked in the base class—
7430 \begin_inset Flex Code
7433 \begin_layout Plain Layout
7440 so you can fiddle around with the settings for the different sections if you wish.
7441 The layout information for sections is contained in
7442 \begin_inset Flex Code
7445 \begin_layout Plain Layout
7452 but you do not need to copy and change this file.
7454 you can simply add your changes to your layout file,
7456 \begin_inset Flex Code
7459 \begin_layout Plain Layout
7466 which itself includes
7467 \begin_inset Flex Code
7470 \begin_layout Plain Layout
7478 you might add these lines:
7481 \begin_layout LyX-Code
7485 \begin_layout LyX-Code
7489 \begin_layout LyX-Code
7493 \begin_layout LyX-Code
7497 \begin_layout LyX-Code
7501 \begin_layout Standard
7502 to change the font for chapter headings to sans-serif.
7503 This will override (or,
7505 add to) the existing declaration for the Chapter style.
7509 \begin_layout Standard
7510 Your new package may also provide commands or environments not present in the base class.
7512 you will want to add these to the layout file.
7514 \begin_inset CommandInset ref
7516 reference "sec:TextClass"
7521 for information on how to do so.
7524 \begin_layout Standard
7526 \begin_inset Flex Noun
7529 \begin_layout Plain Layout
7535 can be used with several different document classes,
7536 and even if it cannot,
7537 you might find it easiest just to write a module that you can load with the base class.
7538 The simplest possible such module would be:
7541 \begin_layout LyX-Code
7544 DeclareLyXModule{My Class}
7547 \begin_layout LyX-Code
7551 \begin_layout LyX-Code
7552 #Support for myclass.sty.
7555 \begin_layout LyX-Code
7557 \begin_inset Newline newline
7563 \begin_layout LyX-Code
7571 \begin_inset Newline newline
7577 \begin_layout LyX-Code
7579 \begin_inset Newline newline
7585 \begin_inset Newline newline
7591 \begin_layout Standard
7592 A more complex module might modify the behavior of some existing constructs or define some new ones.
7595 \begin_inset CommandInset ref
7597 reference "sec:TextClass"
7605 \begin_layout Subsection
7607 \begin_inset Flex Noun
7610 \begin_layout Plain Layout
7619 \begin_layout Standard
7620 There are two possibilities here.
7621 One is that the class file is itself based upon an existing document class.
7623 many thesis classes are based upon
7624 \begin_inset Flex Noun
7627 \begin_layout Plain Layout
7634 To see whether yours is,
7635 look for a line like
7638 \begin_layout LyX-Code
7644 \begin_layout Standard
7647 then you may proceed largely as in the previous section,
7649 \begin_inset Flex Code
7652 \begin_layout Plain Layout
7653 Declare\SpecialChar LaTeX
7659 line will be different.
7660 If your new class is
7661 \begin_inset Flex Code
7664 \begin_layout Plain Layout
7670 and it is based upon
7671 \begin_inset Flex Code
7674 \begin_layout Plain Layout
7681 then the line should read:
7685 \begin_layout Plain Layout
7686 And it will be easiest if you save the file to
7687 \begin_inset Flex Code
7690 \begin_layout Plain Layout
7698 assumes that the document class has the same name as the layout file.
7707 \begin_layout LyX-Code
7710 DeclareLaTeXClass[thesis,book]{thesis}
7713 \begin_layout Standard
7716 the new class is not based upon an existing class,
7717 you will probably have to
7718 \begin_inset Quotes eld
7722 \begin_inset Quotes erd
7726 We strongly suggest copying an existing layout file which uses a similar \SpecialChar LaTeX
7727 class and then modifying it,
7729 At least use an existing file as a starting point so you can find out what items you need to worry about.
7731 the specifics are covered below.
7734 \begin_layout Subsection
7736 \begin_inset CommandInset label
7738 name "subsec:Creating-Templates"
7745 \begin_layout Standard
7746 Once you have written a layout file for a new document class,
7747 you might want to consider writing a
7753 A template acts as a kind of tutorial for your layout,
7754 showing how it might be used,
7755 though containing dummy content.
7756 You can of course look at the various templates included with \SpecialChar LyX
7760 \begin_layout Standard
7761 Templates are created just like usual documents:
7762 using \SpecialChar LyX
7764 The only difference is that usual documents contain all possible settings,
7765 including the font scheme and the paper size.
7766 Usually a user doesn't want a template to overwrite his preferred settings for such parameters.
7768 the designer of a template should remove the corresponding commands like
7769 \begin_inset Flex Code
7772 \begin_layout Plain Layout
7781 \begin_inset Flex Code
7784 \begin_layout Plain Layout
7792 from the template \SpecialChar LyX
7794 This can be done with any simple text-editor,
7796 \begin_inset Flex Code
7799 \begin_layout Plain Layout
7806 \begin_inset Flex Code
7809 \begin_layout Plain Layout
7818 \begin_layout Standard
7819 Put the edited template files you create in
7820 \begin_inset Flex Code
7823 \begin_layout Plain Layout
7830 copy the ones you use from the global template directory in
7831 \begin_inset Flex Code
7834 \begin_layout Plain Layout
7841 and redefine the template path in the
7842 \begin_inset Flex Noun
7845 \begin_layout Plain Layout
7846 Tools\SpecialChar menuseparator
7847 Preferences\SpecialChar menuseparator
7856 \begin_layout Standard
7859 that there is a template which has a particular meaning:
7860 \begin_inset Newline linebreak
7864 \begin_inset Flex Code
7867 \begin_layout Plain Layout
7874 This template is loaded every time you create a new document with
7875 \begin_inset Flex Noun
7878 \begin_layout Plain Layout
7879 File\SpecialChar menuseparator
7885 in order to provide useful defaults.
7886 To create this template from inside \SpecialChar LyX
7888 all you have to do is to open a document with the correct settings,
7890 \begin_inset Flex Noun
7893 \begin_layout Plain Layout
7894 Save as Document Defaults
7902 \begin_layout Subsection
7903 Upgrading old layout files
7906 \begin_layout Standard
7907 The format of layout files changes with each \SpecialChar LyX
7909 so old layout files need to be converted to the new format.
7911 reads a layout file in an older format,
7912 it automatically calls the script
7913 \begin_inset Flex Code
7916 \begin_layout Plain Layout
7922 to convert it to a temporary file in current format.
7923 The original file is left untouched.
7924 If you use the layout file often,
7926 you may want to convert it permanently,
7927 so that \SpecialChar LyX
7928 does not have to do so itself every time.
7930 you can call the converter manually:
7933 \begin_layout Enumerate
7935 \begin_inset Flex Code
7938 \begin_layout Plain Layout
7945 \begin_inset Flex Code
7948 \begin_layout Plain Layout
7957 \begin_layout Enumerate
7959 \begin_inset Newline newline
7963 \begin_inset Flex Code
7966 \begin_layout Plain Layout
7967 python LyXDir/scripts/layout2layout.py myclass.old myclass.layout
7973 \begin_inset Newline newline
7977 \begin_inset Flex Code
7980 \begin_layout Plain Layout
7986 is the name of your \SpecialChar LyX
7990 \begin_layout Standard
7991 Note that manual conversion does not affect included files,
7992 so these will have to be converted separately.
7995 \begin_layout Subsection
7996 \begin_inset CommandInset label
7998 name "subsec:Cite-Engine-Files"
8005 \begin_layout Standard
8006 A specific form of layout files are the so-called
8007 \begin_inset Flex Code
8010 \begin_layout Plain Layout
8016 files that are located in the
8017 \begin_inset Flex Code
8020 \begin_layout Plain Layout
8027 Their purpose is to define the specifics of \SpecialChar LaTeX
8028 packages aimed at bibliography generation,
8043 but also the way how normal Bib\SpecialChar TeX
8044 citations (without additional packages) are handled in \SpecialChar LyX
8045 is defined in such a file.
8049 \begin_layout Standard
8051 it is defined which packages \SpecialChar LyX
8053 which citation commands are available,
8054 how these are to be displayed in \SpecialChar LyX
8057 the context menus) as well as in the XHTML and plain text output.
8059 the files specify available style variants (author-year,
8061 etc.) and their specifics.
8062 The cite engine files are also used to generate the options that are available in
8064 Document\SpecialChar menuseparator
8065 Settings\SpecialChar menuseparator
8066 Bibliography\SpecialChar menuseparator
8072 \begin_layout Standard
8073 Even though a cite engine file is essentially a normal layout file that could theoretically include any layout information,
8074 it usually primarily includes some specific parameters such as
8075 \begin_inset Flex Code
8078 \begin_layout Plain Layout
8086 \begin_inset Flex Code
8089 \begin_layout Plain Layout
8097 \begin_inset Flex Code
8100 \begin_layout Plain Layout
8107 \begin_inset Flex Code
8110 \begin_layout Plain Layout
8117 The syntax of the latter two is described in
8118 \begin_inset CommandInset ref
8120 reference "subsec:Citation-engine-description"
8129 \begin_inset CommandInset ref
8131 reference "subsec:Citation-format-description"
8137 as well as in the files themselves.
8140 \begin_layout Section
8141 \begin_inset CommandInset label
8143 name "sec:TextClass"
8147 The layout file format
8150 \begin_layout Standard
8151 The following sections describe how layout files are structured and written.
8152 Our advice is to go slowly,
8153 save and test often.
8154 It is really not that hard,
8155 except that the multitude of options can become overwhelming,
8156 especially if you try to check out too many at once.
8157 It becomes easier if you use existing layouts of \SpecialChar LyX
8158 as examples/reference or if you modify an existing layout to your needs.
8161 \begin_layout Standard
8162 Note that all the tags used in layout files are case-insensitive.
8164 \begin_inset Flex Code
8167 \begin_layout Plain Layout
8175 \begin_inset Flex Code
8178 \begin_layout Plain Layout
8185 \begin_inset Flex Code
8188 \begin_layout Plain Layout
8194 are really the same tag.
8195 The possible arguments are printed in brackets after the tag's name.
8196 The default argument is typeset
8197 \begin_inset Flex Code
8200 \begin_layout Plain Layout
8209 If the argument has a data type like
8210 \begin_inset Quotes eld
8214 \begin_inset Quotes erd
8218 \begin_inset Quotes eld
8222 \begin_inset Quotes erd
8226 the default is shown like this:
8228 \begin_inset Flex Code
8231 \begin_layout Plain Layout
8242 \begin_layout Subsection
8243 The document class declaration and classification
8246 \begin_layout Standard
8247 Lines in a layout file which begin with
8248 \begin_inset Flex Code
8251 \begin_layout Plain Layout
8258 There is one exception to this rule.
8260 \begin_inset Flex Code
8263 \begin_layout Plain Layout
8269 files should begin with lines like:
8272 \begin_layout LyX-Code
8275 #% Do not delete the line below;
8276 configure depends on this
8279 \begin_layout LyX-Code
8284 DeclareLaTeXClass{Article (Standard Class)}
8287 \begin_layout LyX-Code
8292 DeclareCategory{Articles}
8295 \begin_layout Standard
8296 The second and third lines are used when you (re)configure \SpecialChar LyX
8298 The layout file is read by the \SpecialChar LaTeX
8300 \begin_inset Flex Code
8303 \begin_layout Plain Layout
8310 in a special mode where
8311 \begin_inset Flex Code
8314 \begin_layout Plain Layout
8321 The first line is just a \SpecialChar LaTeX
8323 the second one contains the mandatory declaration of the text class and the third line contains the optional classification of the class.
8324 If these lines appear in a file named
8325 \begin_inset Flex Code
8328 \begin_layout Plain Layout
8335 then they define a text class of name
8336 \begin_inset Flex Code
8339 \begin_layout Plain Layout
8345 (the name of the layout file) which uses the \SpecialChar LaTeX
8347 \begin_inset Flex Code
8350 \begin_layout Plain Layout
8356 (the default is to use the same name as the layout).
8358 \begin_inset Quotes eld
8361 Article (Standard Class)
8362 \begin_inset Quotes erd
8365 that appears above is used as a description of the text class in the
8366 \begin_inset Flex Noun
8369 \begin_layout Plain Layout
8370 Document\SpecialChar menuseparator
8378 \begin_inset Quotes eld
8382 \begin_inset Quotes erd
8385 in the example) is also used in the
8386 \begin_inset Flex Noun
8389 \begin_layout Plain Layout
8390 Document\SpecialChar menuseparator
8397 the text classes are grouped by these categories (which are usually genres,
8398 so typical categories are
8399 \begin_inset Quotes eld
8403 \begin_inset Quotes erd
8408 \begin_inset Quotes eld
8412 \begin_inset Quotes erd
8417 \begin_inset Quotes eld
8421 \begin_inset Quotes erd
8426 \begin_inset Quotes eld
8430 \begin_inset Quotes erd
8435 \begin_inset Quotes eld
8439 \begin_inset Quotes erd
8444 \begin_inset Quotes eld
8448 \begin_inset Quotes erd
8452 If no category has been declared,
8453 the class will be put in the
8454 \begin_inset Quotes eld
8458 \begin_inset Quotes erd
8464 \begin_layout Standard
8465 Let's assume that you wrote your own text class that uses the
8466 \begin_inset Flex Code
8469 \begin_layout Plain Layout
8476 but where you changed the appearance of the section headings.
8477 If you put it in a file
8478 \begin_inset Flex Code
8481 \begin_layout Plain Layout
8488 the header of this file should be:
8491 \begin_layout LyX-Code
8494 #% Do not delete the line below;
8495 configure depends on this
8498 \begin_layout LyX-Code
8503 DeclareLaTeXClass[article]{Article (with My Own Headings)}
8506 \begin_layout LyX-Code
8511 DeclareCategory{Articles}
8514 \begin_layout Standard
8515 This declares a text class
8516 \begin_inset Flex Code
8519 \begin_layout Plain Layout
8526 associated with the \SpecialChar LaTeX
8528 \begin_inset Flex Code
8531 \begin_layout Plain Layout
8538 \begin_inset Quotes eld
8541 Article (with My Own Headings)
8542 \begin_inset Quotes erd
8546 If your text class depends on several packages,
8547 you can declare it as:
8550 \begin_layout LyX-Code
8553 #% Do not delete the line below;
8554 configure depends on this
8557 \begin_layout LyX-Code
8562 DeclareLaTeXClass[article,foo.sty]{Article (with My Own Headings)}
8565 \begin_layout LyX-Code
8570 DeclareCategory{Articles}
8573 \begin_layout Standard
8574 This indicates that your text class uses the
8575 \begin_inset Flex Code
8578 \begin_layout Plain Layout
8588 \begin_layout Standard
8589 Note that these declarations can also be given an optional parameter declaring the name of the document class (but not a list).
8592 \begin_layout Standard
8594 to be as explicit as possible,
8595 the form of the layout declaration is:
8598 \begin_layout LyX-Code
8603 DeclareLaTeXClass[class,package.sty]{layout description}
8606 \begin_layout LyX-Code
8611 DeclareCategory{category}
8614 \begin_layout Standard
8615 The class need only be specified if the name of the \SpecialChar LaTeX
8616 class file and the name of the layout file are different or if there are packages to load.
8617 If the name of the class file is not specified,
8618 then \SpecialChar LyX
8619 will simply assume that it is the same as the name of the layout file.
8622 \begin_layout Standard
8623 When the text class has been modified to your taste,
8624 all you have to do is to copy it either to
8625 \begin_inset Flex Code
8628 \begin_layout Plain Layout
8635 \begin_inset Flex Code
8638 \begin_layout Plain Layout
8646 \begin_inset Flex Noun
8649 \begin_layout Plain Layout
8650 Tools\SpecialChar menuseparator
8657 exit \SpecialChar LyX
8659 Then your new text class should be available along with the others.
8662 \begin_layout Standard
8663 Once the layout file is installed,
8664 you can edit it and see your changes without having to reconfigure or to restart \SpecialChar LyX
8669 \begin_layout Plain Layout
8670 In versions of \SpecialChar LyX
8674 editing layout files was very time consuming,
8675 since you had constantly to restart \SpecialChar LyX
8681 You can force a reload of the current layout by using the \SpecialChar LyX
8683 \begin_inset Flex Noun
8686 \begin_layout Plain Layout
8693 There is no default binding for this function—
8696 you can bind it to a key yourself.
8697 But you will normally use this function simply by entering it in the mini-buffer.
8701 \begin_layout Standard
8708 \begin_inset Flex Noun
8711 \begin_layout Plain Layout
8717 is very much an `advanced feature'.
8722 recommended that you save your work before using this function.
8728 recommended that you not attempt to edit layout information while simultaneously working on a document that you care about.
8729 Use a test document.
8730 Syntax errors and the like in your layout file could cause peculiar behavior.
8732 such errors could cause \SpecialChar LyX
8733 to regard the current layout as invalid and to attempt to switch to some other layout.
8737 \begin_layout Plain Layout
8738 Really bad syntax errors may even caused \SpecialChar LyX
8740 This is because certain sorts of errors may make \SpecialChar LyX
8751 The \SpecialChar LyX
8752 team strives to keep \SpecialChar LyX
8753 stable in such situations,
8754 but safe is better than sorry.
8758 \begin_layout Plain Layout
8759 While we're giving advice:
8760 make regular backups.
8761 And be nice to your mother.
8769 \begin_layout Subsection
8770 The Module declaration
8773 \begin_layout Standard
8774 A module must begin with a line like the following:
8777 \begin_layout LyX-Code
8780 DeclareLyXModule[endnotes.sty]{Endnotes}
8783 \begin_layout LyX-Code
8788 DeclareCategory{Foot- and Endnotes}
8791 \begin_layout Standard
8792 The mandatory argument of
8800 is the name of the module,
8801 as it should appear in
8802 \begin_inset Flex Noun
8805 \begin_layout Plain Layout
8806 Document\SpecialChar menuseparator
8807 Settings\SpecialChar menuseparator
8814 The argument in square brackets is optional:
8815 It declares any \SpecialChar LaTeX
8816 packages on which the module depends.
8817 It is also possible to use the form
8818 \begin_inset Flex Noun
8821 \begin_layout Plain Layout
8827 as an optional argument,
8828 which declares that the module can only be used when there exists a conversion chain between the formats `
8829 \begin_inset Flex Code
8832 \begin_layout Plain Layout
8839 \begin_inset Flex Code
8842 \begin_layout Plain Layout
8855 declaration is not strictly mandatory,
8856 but you should add it,
8857 since it is helpful to find the module.
8858 Please have a look at the existing module categories and if appropriate,
8862 \begin_layout Standard
8863 The module and category declaration should then be followed by lines like the following:
8867 \begin_layout Plain Layout
8868 Preferably in English if the module should be published with \SpecialChar LyX
8870 This description will appear in the list of messages to be translated and will be thus translated with the next interface update.
8878 \begin_layout LyX-Code
8882 \begin_layout LyX-Code
8883 #Adds an endnote command,
8884 in addition to footnotes.
8888 \begin_layout LyX-Code
8889 #You will need to add
8891 theendnotes in TeX code where you
8894 \begin_layout LyX-Code
8895 #want the endnotes to appear.
8899 \begin_layout LyX-Code
8903 \begin_layout LyX-Code
8905 somemodule | othermodule
8908 \begin_layout LyX-Code
8913 \begin_layout Standard
8914 The description is used in
8915 \begin_inset Flex Noun
8918 \begin_layout Plain Layout
8919 Document\SpecialChar menuseparator
8920 Settings\SpecialChar menuseparator
8926 to provide the user with information about what the module does.
8928 \begin_inset Flex Code
8931 \begin_layout Plain Layout
8937 line is used to identify other modules with which this one must be used;
8939 \begin_inset Flex Code
8942 \begin_layout Plain Layout
8948 line is used to identify modules with which this one may not be used.
8952 multiple modules should be separated with the pipe symbol:
8954 Note that the required modules are treated disjunctively:
8959 of the required modules must be used.
8965 excluded module may be used.
8966 Note that modules are identified here by their filenames without the
8967 \begin_inset Flex Code
8970 \begin_layout Plain Layout
8978 \begin_inset Flex Code
8981 \begin_layout Plain Layout
8988 \begin_inset Flex Code
8991 \begin_layout Plain Layout
9000 \begin_layout Subsection
9001 The CiteEngine file declaration
9004 \begin_layout Standard
9005 A cite engine file must begin with a line like the following:
9008 \begin_layout LyX-Code
9011 DeclareLyXCiteEngineModule[biblatex.sty]{Biblatex}
9014 \begin_layout Standard
9015 The mandatory argument,
9017 is the name of the cite style,
9018 as it should appear in
9019 \begin_inset Flex Noun
9022 \begin_layout Plain Layout
9023 Document\SpecialChar menuseparator
9024 Settings\SpecialChar menuseparator
9031 The argument in square brackets is optional:
9032 It declares any \SpecialChar LaTeX
9033 packages on which the cite engine depends.
9036 \begin_layout Standard
9037 The cite engine declaration should then be followed by lines like the following:
9041 \begin_layout Plain Layout
9042 Preferably in English if the module should be published with \SpecialChar LyX
9044 This description will appear in the list of messages to be translated and will be thus translated with the next interface update.
9052 \begin_layout LyX-Code
9056 \begin_layout LyX-Code
9057 # Biblatex supports many author-year and numerical styles.
9060 \begin_layout LyX-Code
9061 # It is mainly aimed at the Humanities.
9065 \begin_layout LyX-Code
9067 fully localized and provides many features
9070 \begin_layout LyX-Code
9071 # that are not possible with BibTeX.
9072 The use of 'biber' as
9075 \begin_layout LyX-Code
9076 # bibliography processor is advised.
9079 \begin_layout LyX-Code
9083 \begin_layout Standard
9084 The description is used in
9085 \begin_inset Flex Noun
9088 \begin_layout Plain Layout
9089 Document\SpecialChar menuseparator
9090 Settings\SpecialChar menuseparator
9096 to provide the user with information about the cite engine.
9099 \begin_layout Subsection
9103 \begin_layout Standard
9104 The first non-comment line of any layout file,
9110 contain the file format number:
9113 \begin_layout Description
9114 \begin_inset Flex Code
9117 \begin_layout Plain Layout
9124 \begin_inset Flex Code
9127 \begin_layout Plain Layout
9133 ] The format number of the layout file.
9136 \begin_layout Standard
9137 This tag was introduced with \SpecialChar LyX
9139 \begin_inset space ~
9143 Layout files from older \SpecialChar LyX
9144 versions do not have an explicit file format and are considered to have
9145 \begin_inset Flex Code
9148 \begin_layout Plain Layout
9150 \begin_inset space ~
9159 The format for the present version of \SpecialChar LyX
9161 But each version of \SpecialChar LyX
9162 is capable of reading earlier versions' layout files,
9163 just as they are capable of reading files produced by earlier versions of \SpecialChar LyX
9167 no provision for converting to earlier formats.
9170 \begin_layout Subsection
9171 \begin_inset CommandInset label
9173 name "subsec:General-text-class"
9177 General text class parameters
9180 \begin_layout Standard
9181 These are general parameters that govern the behavior of an entire document class.
9186 mean that they must appear in
9187 \begin_inset Flex Code
9190 \begin_layout Plain Layout
9196 files rather than in modules.
9197 A module can contain any layout tag.)
9200 \begin_layout Description
9201 \begin_inset Flex Code
9204 \begin_layout Plain Layout
9205 AddToCiteEngine <engine>
9210 Extends the possibilities for displaying citation references.
9212 \begin_inset CommandInset ref
9214 reference "subsec:Citation-engine-description"
9224 \begin_inset Flex Code
9227 \begin_layout Plain Layout
9236 \begin_layout Description
9237 \begin_inset Flex Code
9240 \begin_layout Plain Layout
9246 Adds information that will be output in the
9247 \begin_inset Flex Code
9250 \begin_layout Plain Layout
9256 block when the document is output to XHTML.
9258 this would be used to output CSS style information,
9259 but it can be used for anything that can appear in
9260 \begin_inset Flex Code
9263 \begin_layout Plain Layout
9271 \begin_inset Quotes eld
9275 \begin_inset Flex Code
9278 \begin_layout Plain Layout
9285 \begin_inset Quotes erd
9291 \begin_layout Description
9292 \begin_inset Flex Code
9295 \begin_layout Plain Layout
9301 Adds information to the document preamble.
9303 \begin_inset Newline newline
9307 \begin_inset Quotes eld
9311 \begin_inset Flex Code
9314 \begin_layout Plain Layout
9321 \begin_inset Quotes erd
9327 \begin_layout Description
9328 \begin_inset Flex Code
9331 \begin_layout Plain Layout
9338 \begin_inset Flex Code
9341 \begin_layout Plain Layout
9350 \begin_inset space \thinspace{}
9354 \begin_inset Flex Code
9357 \begin_layout Plain Layout
9363 ] If the document class adds the bibliography to the table of contents,
9364 add this option with value
9365 \begin_inset Flex Code
9368 \begin_layout Plain Layout
9375 \begin_inset Flex Code
9378 \begin_layout Plain Layout
9385 This prevents the bibliography from being added twice.
9388 \begin_layout Description
9389 \begin_inset Flex Code
9392 \begin_layout Plain Layout
9398 Defines the possibilities for displaying citation references.
9400 \begin_inset CommandInset ref
9402 reference "subsec:Citation-engine-description"
9412 \begin_inset Quotes eld
9416 \begin_inset Flex Code
9419 \begin_layout Plain Layout
9426 \begin_inset Quotes erd
9430 Primarily used in cite engine files (see
9431 \begin_inset CommandInset ref
9433 reference "subsec:Cite-Engine-Files"
9442 Note that if you specify this in a layout file or module,
9443 any cite engine definition will be overridden.
9445 \begin_inset Flex Code
9448 \begin_layout Plain Layout
9457 \begin_layout Description
9458 \begin_inset Flex Code
9461 \begin_layout Plain Layout
9467 Defines formats for use in the display of bibliographic information.
9469 \begin_inset CommandInset ref
9471 reference "subsec:Citation-format-description"
9478 \begin_inset Quotes eld
9482 \begin_inset Flex Code
9485 \begin_layout Plain Layout
9492 \begin_inset Quotes erd
9496 Primarily used in cite engine files (see
9497 \begin_inset CommandInset ref
9499 reference "subsec:Cite-Engine-Files"
9508 A cite format defined in a layout or module will override the cite engine definition.
9511 \begin_layout Description
9512 \begin_inset Flex Code
9515 \begin_layout Plain Layout
9522 \begin_inset Flex Code
9525 \begin_layout Plain Layout
9534 \begin_inset Flex Code
9537 \begin_layout Plain Layout
9543 ] Determines whether
9547 or Bib\SpecialChar TeX
9548 is used to generate a Bibliography.
9549 Primarily used in cite engine files (see
9550 \begin_inset CommandInset ref
9552 reference "subsec:Cite-Engine-Files"
9563 \begin_layout Description
9564 \begin_inset Flex Code
9567 \begin_layout Plain Layout
9573 Describes various global options supported by the document class.
9575 \begin_inset CommandInset ref
9577 reference "subsec:ClassOptions"
9584 \begin_inset Quotes eld
9588 \begin_inset Flex Code
9591 \begin_layout Plain Layout
9598 \begin_inset Quotes erd
9604 \begin_layout Description
9605 \begin_inset Flex Code
9608 \begin_layout Plain Layout
9615 \begin_inset Flex Code
9618 \begin_layout Plain Layout
9627 \begin_inset space \thinspace{}
9631 \begin_inset Flex Code
9634 \begin_layout Plain Layout
9640 ] Whether the class should
9644 to having one or two columns.
9645 Can be changed in the
9646 \begin_inset Flex Noun
9649 \begin_layout Plain Layout
9650 Document\SpecialChar menuseparator
9659 \begin_layout Description
9660 \begin_inset Flex Code
9663 \begin_layout Plain Layout
9670 \begin_inset Flex Code
9673 \begin_layout Plain Layout
9679 ] This sequence defines the properties for a counter.
9680 If the counter does not yet exist,
9685 \begin_inset Quotes eld
9689 \begin_inset Flex Code
9692 \begin_layout Plain Layout
9699 \begin_inset Quotes erd
9703 \begin_inset Newline newline
9707 \begin_inset CommandInset ref
9709 reference "subsec:Counters"
9714 for details on counters.
9717 \begin_layout Description
9718 \begin_inset Flex Code
9721 \begin_layout Plain Layout
9727 Sets the default font used to display the document.
9729 \begin_inset CommandInset ref
9731 reference "subsec:Font-description"
9736 for how to declare fonts.
9738 \begin_inset Quotes eld
9742 \begin_inset Flex Code
9745 \begin_layout Plain Layout
9752 \begin_inset Quotes erd
9758 \begin_layout Description
9759 \begin_inset Flex Code
9762 \begin_layout Plain Layout
9769 \begin_inset Flex Code
9772 \begin_layout Plain Layout
9778 ] Specifies a module to be included by default with this document class.
9779 The module is specified as filename without the
9780 \begin_inset Flex Code
9783 \begin_layout Plain Layout
9790 The user can still remove the module,
9791 but it will be active at the outset.
9792 (This applies only when new files are created,
9793 or when this class is chosen for an existing document.)
9796 \begin_layout Description
9797 \begin_inset Flex Code
9800 \begin_layout Plain Layout
9807 \begin_inset Flex Code
9810 \begin_layout Plain Layout
9816 ] This is the style that will be assigned to new paragraphs,
9818 \begin_inset Flex Noun
9821 \begin_layout Plain Layout
9828 This will default to the first defined style if not given,
9829 but you are encouraged to use this directive.
9832 \begin_layout Description
9833 \begin_inset Flex Code
9836 \begin_layout Plain Layout
9843 \begin_inset Flex Code
9846 \begin_layout Plain Layout
9852 ] The root element (at the top of the document) to use when outputting documents with this class in DocBook.
9853 The default value is
9854 \begin_inset Quotes eld
9858 \begin_inset Flex Code
9861 \begin_layout Plain Layout
9868 \begin_inset Quotes erd
9874 \begin_layout Description
9875 \begin_inset Flex Code
9878 \begin_layout Plain Layout
9879 DocBookForceAbstract
9885 \begin_inset Flex Code
9888 \begin_layout Plain Layout
9895 \begin_inset Quotes eld
9903 \begin_inset Quotes erd
9907 the root element will always have an
9912 The default value is
9913 \begin_inset Quotes eld
9921 \begin_inset Quotes erd
9927 \begin_layout Description
9928 \begin_inset Flex Code
9931 \begin_layout Plain Layout
9938 \begin_inset Flex Code
9941 \begin_layout Plain Layout
9947 ] This tag indicates that the module (which is specified by filename without the
9948 \begin_inset Flex Code
9951 \begin_layout Plain Layout
9957 extension) cannot be used with this document class.
9958 This might be used in a journal-specific layout file to prevent,
9961 \begin_inset Flex Code
9964 \begin_layout Plain Layout
9970 module that numbers theorems by section.
9975 be used in a module.
9976 Modules have their own way of excluding other modules (see
9977 \begin_inset CommandInset ref
9979 reference "subsec:Layout-modules"
9987 \begin_layout Description
9988 \begin_inset Flex Code
9991 \begin_layout Plain Layout
9997 Defines a new float.
9999 \begin_inset CommandInset ref
10001 reference "subsec:Floats"
10008 \begin_inset Quotes eld
10012 \begin_inset Flex Code
10015 \begin_layout Plain Layout
10022 \begin_inset Quotes erd
10028 \begin_layout Description
10029 \begin_inset Flex Code
10032 \begin_layout Plain Layout
10038 Sets the information that will be output in the
10039 \begin_inset Flex Code
10042 \begin_layout Plain Layout
10048 block when this document class is output to XHTML.
10049 Note that this will completely override any prior
10050 \begin_inset Flex Code
10053 \begin_layout Plain Layout
10060 \begin_inset Flex Code
10063 \begin_layout Plain Layout
10071 \begin_inset Newline newline
10075 \begin_inset Flex Code
10078 \begin_layout Plain Layout
10084 if you just want to add material to the preamble.) Must end with
10085 \begin_inset Quotes eld
10089 \begin_inset Flex Code
10092 \begin_layout Plain Layout
10099 \begin_inset Quotes erd
10105 \begin_layout Description
10106 \begin_inset Flex Code
10109 \begin_layout Plain Layout
10116 \begin_inset Flex Code
10119 \begin_layout Plain Layout
10125 ] The style to use for the table of contents,
10128 when the document is output to HTML.
10130 this should normally be
10131 \begin_inset Flex Code
10134 \begin_layout Plain Layout
10142 \begin_inset Flex Code
10145 \begin_layout Plain Layout
10152 If it is not given,
10153 then \SpecialChar LyX
10154 will attempt to figure out which layout to use.
10157 \begin_layout Description
10158 \begin_inset Flex Code
10161 \begin_layout Plain Layout
10168 \begin_inset Flex Code
10171 \begin_layout Plain Layout
10177 ] Modifies the properties of the given counter.
10178 If the counter does not exist,
10179 the statement is ignored.
10181 \begin_inset Quotes eld
10185 \begin_inset Flex Code
10188 \begin_layout Plain Layout
10195 \begin_inset Quotes erd
10199 \begin_inset Newline newline
10203 \begin_inset CommandInset ref
10205 reference "subsec:Counters"
10210 for details on counters.
10213 \begin_layout Description
10214 \begin_inset Flex Code
10217 \begin_layout Plain Layout
10224 \begin_inset Flex Code
10227 \begin_layout Plain Layout
10233 ] This allows you to include another layout definition file within yours to avoid duplicating commands.
10234 Common examples are the standard layout files,
10237 \begin_inset Flex Code
10240 \begin_layout Plain Layout
10247 which contains most of the basic layouts.
10250 \begin_layout Description
10251 \begin_inset Flex Code
10254 \begin_layout Plain Layout
10261 \begin_inset Flex Code
10264 \begin_layout Plain Layout
10270 ] is a variant of the
10271 \begin_inset Flex Code
10274 \begin_layout Plain Layout
10280 command which does not look for files in the user directory.
10281 This allows to create a file
10282 \begin_inset Flex Code
10285 \begin_layout Plain Layout
10292 \begin_inset Flex Code
10295 \begin_layout Plain Layout
10301 in the user directory which includes a global file with the same name via
10302 \begin_inset Flex Code
10305 \begin_layout Plain Layout
10312 \begin_inset Flex Code
10315 \begin_layout Plain Layout
10316 InputGlobal name.inc
10323 \begin_inset Flex Code
10326 \begin_layout Plain Layout
10333 the file would recursively include itself).
10335 you can modify global files without having to completely copy them.
10338 \begin_layout Description
10339 \begin_inset Flex Code
10342 \begin_layout Plain Layout
10349 \begin_inset Flex Code
10352 \begin_layout Plain Layout
10358 ] This section (re-)defines the layout of an inset.
10359 It can be applied to an existing inset or to a new,
10360 user-defined inset,
10362 a new character style.
10364 \begin_inset Quotes eld
10368 \begin_inset Flex Code
10371 \begin_layout Plain Layout
10378 \begin_inset Quotes erd
10382 \begin_inset Newline newline
10386 \begin_inset CommandInset ref
10388 reference "subsec:Flex-insets-and"
10393 for more information.
10397 \begin_layout Description
10398 \begin_inset Flex Code
10401 \begin_layout Plain Layout
10408 \begin_inset Flex Code
10411 \begin_layout Plain Layout
10417 ] A string that indicates the width of the left margin on the screen,
10420 \begin_inset Quotes eld
10424 \begin_inset Flex Code
10427 \begin_layout Plain Layout
10434 \begin_inset Quotes erd
10438 (Note that this is not a `length',
10440 \begin_inset Quotes eld
10444 \begin_inset Quotes erd
10450 \begin_layout Description
10451 \begin_inset Flex Code
10454 \begin_layout Plain Layout
10461 \begin_inset Flex Code
10464 \begin_layout Plain Layout
10470 ] An integer that determines the maximal number of names displayed in an author-year citation before the citation switches to
10471 \begin_inset Quotes eld
10475 \begin_inset Quotes erd
10479 Primarily used in cite engine files (see
10480 \begin_inset CommandInset ref
10482 reference "subsec:Cite-Engine-Files"
10493 \begin_layout Description
10494 \begin_inset Flex Code
10497 \begin_layout Plain Layout
10504 \begin_inset Flex Code
10507 \begin_layout Plain Layout
10513 ] Modifies the layout of an inset.
10514 If the layout does not exist,
10515 this section is ignored.
10517 \begin_inset Quotes eld
10521 \begin_inset Flex Code
10524 \begin_layout Plain Layout
10531 \begin_inset Quotes erd
10537 \begin_layout Description
10538 \begin_inset Flex Code
10541 \begin_layout Plain Layout
10548 \begin_inset Flex Code
10551 \begin_layout Plain Layout
10557 ] Modifies the properties of the given paragraph style.
10558 If the style does not exist,
10559 this section is ignored.
10561 \begin_inset Quotes eld
10565 \begin_inset Flex Code
10568 \begin_layout Plain Layout
10575 \begin_inset Quotes erd
10581 \begin_layout Description
10582 \begin_inset Flex Code
10585 \begin_layout Plain Layout
10592 \begin_inset Flex Code
10595 \begin_layout Plain Layout
10601 ] Deletes an existing counter,
10602 usually one defined in an included file.
10605 \begin_layout Description
10606 \begin_inset Flex Code
10609 \begin_layout Plain Layout
10616 \begin_inset Flex Code
10619 \begin_layout Plain Layout
10625 ] Deletes an existing float.
10626 This is particularly useful when you want to suppress a float that has been defined in an input file.
10629 \begin_layout Description
10630 \begin_inset Flex Code
10633 \begin_layout Plain Layout
10640 \begin_inset Flex Code
10643 \begin_layout Plain Layout
10649 ] Deletes an existing style.
10652 \begin_layout Description
10653 \begin_inset Flex Code
10656 \begin_layout Plain Layout
10663 \begin_inset Flex Code
10666 \begin_layout Plain Layout
10673 \begin_inset Flex Code
10676 \begin_layout Plain Layout
10682 ] Define a new table of contents with type
10683 \begin_inset Flex Code
10686 \begin_layout Plain Layout
10693 \begin_inset Flex Code
10696 \begin_layout Plain Layout
10703 See also the AddToToc commands.
10706 \begin_layout Description
10707 \begin_inset Flex Code
10710 \begin_layout Plain Layout
10717 \begin_inset Flex Code
10720 \begin_layout Plain Layout
10726 ] The file format (as defined in the \SpecialChar LyX
10727 preferences) produced by this document class.
10728 It is mainly useful when
10729 \begin_inset Flex Code
10732 \begin_layout Plain Layout
10739 \begin_inset Flex Code
10742 \begin_layout Plain Layout
10748 and one wants to define a new type of literate document.
10749 The format is reset to
10750 \begin_inset Quotes eld
10754 \begin_inset Flex Code
10757 \begin_layout Plain Layout
10764 \begin_inset Quotes erd
10767 when the corresponding
10768 \begin_inset Flex Code
10771 \begin_layout Plain Layout
10777 parameter is encountered.
10780 \begin_layout Description
10781 \begin_inset Flex Code
10784 \begin_layout Plain Layout
10791 \begin_inset Flex Code
10794 \begin_layout Plain Layout
10806 \begin_inset Flex Code
10809 \begin_layout Plain Layout
10815 ] Specifies what sort of output documents using this class will produce.
10818 \begin_layout Description
10819 \begin_inset Flex Code
10822 \begin_layout Plain Layout
10829 \begin_inset Flex Code
10832 \begin_layout Plain Layout
10839 \begin_inset Flex Code
10842 \begin_layout Plain Layout
10848 ] Specifies options,
10849 given in the second string,
10850 for the package named by the first string.
10853 \begin_inset Quotes eld
10857 \begin_inset Flex Code
10860 \begin_layout Plain Layout
10861 PackageOptions natbib square
10867 \begin_inset Quotes erd
10871 \begin_inset Flex Code
10874 \begin_layout Plain Layout
10880 to be loaded with the
10881 \begin_inset Flex Code
10884 \begin_layout Plain Layout
10891 (For \SpecialChar TeX
10893 this causes \SpecialChar LyX
10896 \begin_inset Flex Code
10899 \begin_layout Plain Layout
10902 PassOptionsToPackage{natbib}{square}
10908 \begin_inset Flex Code
10911 \begin_layout Plain Layout
10920 \begin_layout Description
10921 \begin_inset Flex Code
10924 \begin_layout Plain Layout
10931 \begin_inset Flex Code
10934 \begin_layout Plain Layout
10975 ] The default page size.
10976 This is used by some converters.
10979 \begin_layout Description
10980 \begin_inset Flex Code
10983 \begin_layout Plain Layout
10990 \begin_inset Flex Code
10993 \begin_layout Plain Layout
11003 \begin_inset Flex Code
11006 \begin_layout Plain Layout
11014 \begin_inset Flex Code
11017 \begin_layout Plain Layout
11023 ] The default pagestyle.
11024 Can be changed in the
11025 \begin_inset Flex Noun
11028 \begin_layout Plain Layout
11029 Document\SpecialChar menuseparator
11038 \begin_layout Description
11039 \begin_inset Flex Code
11042 \begin_layout Plain Layout
11048 Sets the preamble for the \SpecialChar LaTeX
11050 Note that this will completely override any prior
11051 \begin_inset Flex Code
11054 \begin_layout Plain Layout
11061 \begin_inset Flex Code
11064 \begin_layout Plain Layout
11072 \begin_inset Flex Code
11075 \begin_layout Plain Layout
11081 if you just want to add material to the preamble.) Must end with
11082 \begin_inset Quotes eld
11086 \begin_inset Flex Code
11089 \begin_layout Plain Layout
11096 \begin_inset Quotes erd
11102 \begin_layout Description
11103 \begin_inset Flex Code
11106 \begin_layout Plain Layout
11113 \begin_inset Flex Code
11116 \begin_layout Plain Layout
11122 ] Defines the layout of an inset if it does not already exist.
11123 If the layout does exist,
11124 this section is ignored.
11126 \begin_inset Quotes eld
11130 \begin_inset Flex Code
11133 \begin_layout Plain Layout
11140 \begin_inset Quotes erd
11146 \begin_layout Description
11147 \begin_inset Flex Code
11150 \begin_layout Plain Layout
11157 \begin_inset Flex Code
11160 \begin_layout Plain Layout
11167 \begin_inset Flex Code
11170 \begin_layout Plain Layout
11179 \begin_inset space \thinspace{}
11183 \begin_inset Flex Code
11186 \begin_layout Plain Layout
11192 ] Whether the class already provides the feature
11193 \begin_inset Flex Code
11196 \begin_layout Plain Layout
11203 A feature is in general the name of a package (e.
11204 \begin_inset space \thinspace{}
11208 \begin_inset space \space{}
11212 \begin_inset Flex Code
11215 \begin_layout Plain Layout
11222 \begin_inset Flex Code
11225 \begin_layout Plain Layout
11232 \begin_inset space \thinspace{}
11236 \begin_inset space \space{}
11240 \begin_inset Flex Code
11243 \begin_layout Plain Layout
11250 \begin_inset Flex Code
11253 \begin_layout Plain Layout
11261 \begin_inset CommandInset ref
11263 reference "chap:List-of-functions"
11268 for the list of features.
11271 \begin_layout Description
11272 \begin_inset Flex Code
11275 \begin_layout Plain Layout
11282 \begin_inset Flex Code
11285 \begin_layout Plain Layout
11291 ] Indicates that this layout provides the functionality of the module mentioned,
11292 which should be specified by the filename without the
11293 \begin_inset Flex Code
11296 \begin_layout Plain Layout
11303 This will typically be used if the layout includes the module directly,
11304 rather than using the
11305 \begin_inset Flex Code
11308 \begin_layout Plain Layout
11314 tag to indicate that it ought to be used.
11315 It could also be used in a module that provided an alternate implementation of the same functionality.
11318 \begin_layout Description
11319 \begin_inset Flex Code
11322 \begin_layout Plain Layout
11329 \begin_inset Flex Code
11332 \begin_layout Plain Layout
11338 ] Creates a new paragraph style if it does not already exist.
11339 If the style does exist,
11340 this section is ignored.
11342 \begin_inset Quotes eld
11346 \begin_inset Flex Code
11349 \begin_layout Plain Layout
11356 \begin_inset Quotes erd
11362 \begin_layout Description
11363 \begin_inset Flex Code
11366 \begin_layout Plain Layout
11373 \begin_inset Flex Code
11376 \begin_layout Plain Layout
11382 ] Whether the class requires the feature
11383 \begin_inset Flex Code
11386 \begin_layout Plain Layout
11393 Multiple features must be separated by commas.
11394 Note that you can only request supported features.
11396 \begin_inset CommandInset ref
11398 reference "chap:List-of-functions"
11403 for the list of features.).
11404 If you require a package with specific options,
11405 you can additionally use
11406 \begin_inset Flex Code
11409 \begin_layout Plain Layout
11418 \begin_layout Description
11419 \begin_inset Flex Code
11422 \begin_layout Plain Layout
11429 \begin_inset Flex Code
11432 \begin_layout Plain Layout
11438 ] A string that indicates the width of the right margin on the screen,
11441 \begin_inset Quotes eld
11445 \begin_inset Flex Code
11448 \begin_layout Plain Layout
11455 \begin_inset Quotes erd
11461 \begin_layout Description
11462 \begin_inset Flex Code
11465 \begin_layout Plain Layout
11472 \begin_inset Flex Code
11475 \begin_layout Plain Layout
11481 ] Sets which divisions get numbered.
11483 \begin_inset Newline newline
11487 \begin_inset Flex Code
11490 \begin_layout Plain Layout
11496 counter in \SpecialChar LaTeX
11500 \begin_layout Description
11501 \begin_inset Flex Code
11504 \begin_layout Plain Layout
11511 \begin_inset Flex Code
11514 \begin_layout Plain Layout
11523 \begin_inset space \thinspace{}
11527 \begin_inset Flex Code
11530 \begin_layout Plain Layout
11536 ] Whether the class-default should be printing on one or both sides of the paper.
11537 Can be changed in the
11538 \begin_inset Flex Noun
11541 \begin_layout Plain Layout
11542 Document\SpecialChar menuseparator
11551 \begin_layout Description
11552 \begin_inset Flex Code
11555 \begin_layout Plain Layout
11562 \begin_inset Flex Code
11565 \begin_layout Plain Layout
11571 ] This sequence defines a paragraph style.
11572 If the style does not yet exist,
11575 its parameters are modified.
11577 \begin_inset Quotes eld
11581 \begin_inset Flex Code
11584 \begin_layout Plain Layout
11591 \begin_inset Quotes erd
11595 \begin_inset Newline newline
11599 \begin_inset CommandInset ref
11601 reference "subsec:Paragraph-Styles"
11606 for details on paragraph styles.
11609 \begin_layout Description
11610 \begin_inset Flex Code
11613 \begin_layout Plain Layout
11620 \begin_inset Flex Code
11623 \begin_layout Plain Layout
11629 ] defines the default table style that is used when inserting a table.
11630 The following styles are available:
11634 \begin_layout Itemize
11635 \begin_inset Flex Code
11638 \begin_layout Plain Layout
11639 Formal_with_Footline
11646 \begin_inset Quotes eld
11650 \begin_inset Quotes erd
11653 ) style with horizontal lines only,
11654 using a bold top and bottom line,
11655 the first and last row are additionally separated from the table body with a thin middle line.
11658 \begin_layout Itemize
11659 \begin_inset Flex Code
11662 \begin_layout Plain Layout
11663 Formal_without_Footline
11670 but the last row is not separated with a middle line from the body.
11673 \begin_layout Itemize
11674 \begin_inset Flex Code
11677 \begin_layout Plain Layout
11684 Simple table lines.
11687 \begin_layout Itemize
11688 \begin_inset Flex Code
11691 \begin_layout Plain Layout
11699 \begin_inset Flex Code
11702 \begin_layout Plain Layout
11709 but with the header row offset with a second horizontal line.
11710 This is also the default style of \SpecialChar LyX
11714 \begin_layout Itemize
11715 \begin_inset Flex Code
11718 \begin_layout Plain Layout
11725 Table without lines.
11729 \begin_layout Description
11730 \begin_inset Flex Code
11733 \begin_layout Plain Layout
11740 \begin_inset Flex Code
11743 \begin_layout Plain Layout
11749 ] The name of the command or environment to be used with
11750 \begin_inset Flex Code
11753 \begin_layout Plain Layout
11762 \begin_layout Description
11763 \begin_inset Flex Code
11766 \begin_layout Plain Layout
11773 \begin_inset Flex Code
11776 \begin_layout Plain Layout
11786 \begin_inset Flex Code
11789 \begin_layout Plain Layout
11795 ] Indicates what kind of markup is used to define the title of a document.
11797 \begin_inset Flex Code
11800 \begin_layout Plain Layout
11806 means that the macro with name
11807 \begin_inset Flex Code
11810 \begin_layout Plain Layout
11816 will be inserted after the last layout which has
11817 \begin_inset Quotes eld
11821 \begin_inset Flex Code
11824 \begin_layout Plain Layout
11826 \begin_inset space ~
11835 \begin_inset Quotes erd
11840 \begin_inset Flex Code
11843 \begin_layout Plain Layout
11849 corresponds to the case where all layouts which have
11850 \begin_inset Quotes eld
11854 \begin_inset Flex Code
11857 \begin_layout Plain Layout
11859 \begin_inset space ~
11868 \begin_inset Quotes erd
11871 should be enclosed into the
11872 \begin_inset Flex Code
11875 \begin_layout Plain Layout
11884 \begin_layout Description
11885 \begin_inset Flex Code
11888 \begin_layout Plain Layout
11895 \begin_inset Flex Code
11898 \begin_layout Plain Layout
11904 ] Sets which divisions are included in the table of contents.
11906 \begin_inset Flex Code
11909 \begin_layout Plain Layout
11915 counter in \SpecialChar LaTeX
11919 \begin_layout Subsection
11920 \begin_inset Flex Code
11923 \begin_layout Plain Layout
11930 \begin_inset CommandInset label
11932 name "subsec:ClassOptions"
11939 \begin_layout Standard
11941 \begin_inset Flex Code
11944 \begin_layout Plain Layout
11950 section can contain the following entries:
11953 \begin_layout Description
11954 \begin_inset Flex Code
11957 \begin_layout Plain Layout
11964 \begin_inset Flex Code
11967 \begin_layout Plain Layout
11973 ] The list of available font sizes for the document's main font,
11975 \begin_inset Quotes eld
11979 \begin_inset Flex Code
11982 \begin_layout Plain Layout
11989 \begin_inset Quotes erd
11993 Any number is possible.
11996 \begin_layout Description
11997 \begin_inset Flex Code
12000 \begin_layout Plain Layout
12007 \begin_inset Flex Code
12010 \begin_layout Plain Layout
12016 ] The format for the font size option.
12019 \begin_inset Flex Code
12022 \begin_layout Plain Layout
12030 \begin_inset Flex Code
12033 \begin_layout Plain Layout
12039 is a placeholder for the font size.
12042 \begin_layout Description
12043 \begin_inset Flex Code
12046 \begin_layout Plain Layout
12053 \begin_inset Flex Code
12056 \begin_layout Plain Layout
12057 string="letter|\SpecialChar allowbreak
12058 legal|\SpecialChar allowbreak
12059 executive|\SpecialChar allowbreak
12060 a0|\SpecialChar allowbreak
12061 a1|\SpecialChar allowbreak
12062 a2|\SpecialChar allowbreak
12063 a3|\SpecialChar allowbreak
12064 a4|\SpecialChar allowbreak
12065 a5|\SpecialChar allowbreak
12066 a6|\SpecialChar allowbreak
12067 b0|\SpecialChar allowbreak
12068 b1|\SpecialChar allowbreak
12069 b2|\SpecialChar allowbreak
12070 b3|\SpecialChar allowbreak
12071 b4|\SpecialChar allowbreak
12072 b5|\SpecialChar allowbreak
12073 b6|\SpecialChar allowbreak
12074 c0|\SpecialChar allowbreak
12075 c1|\SpecialChar allowbreak
12076 c2|\SpecialChar allowbreak
12077 c3|\SpecialChar allowbreak
12078 c4|\SpecialChar allowbreak
12079 c5|\SpecialChar allowbreak
12080 c6|\SpecialChar allowbreak
12081 b0j|\SpecialChar allowbreak
12082 b1j|\SpecialChar allowbreak
12083 b2j|\SpecialChar allowbreak
12084 b3j|\SpecialChar allowbreak
12085 b4j|\SpecialChar allowbreak
12086 b5j|\SpecialChar allowbreak
12092 ] The list of available page sizes,
12094 \begin_inset Quotes eld
12098 \begin_inset Flex Code
12101 \begin_layout Plain Layout
12108 \begin_inset Quotes erd
12113 only the listed sizes are supported.
12114 Other sizes might be entered as custom class option.
12117 \begin_layout Description
12118 \begin_inset Flex Code
12121 \begin_layout Plain Layout
12128 \begin_inset Flex Code
12131 \begin_layout Plain Layout
12137 ] The format for the page size option.
12140 \begin_inset Flex Code
12143 \begin_layout Plain Layout
12151 \begin_inset Flex Code
12154 \begin_layout Plain Layout
12160 is a placeholder for the paper size.
12163 \begin_layout Description
12164 \begin_inset Flex Code
12167 \begin_layout Plain Layout
12174 \begin_inset Flex Code
12177 \begin_layout Plain Layout
12178 string="empty|plain|headings|fancy"
12183 ] The list of available page sty\SpecialChar softhyphen
12186 \begin_inset Quotes eld
12190 \begin_inset Flex Code
12193 \begin_layout Plain Layout
12200 \begin_inset Quotes erd
12206 \begin_layout Description
12207 \begin_inset Flex Code
12210 \begin_layout Plain Layout
12217 \begin_inset Flex Code
12220 \begin_layout Plain Layout
12226 ] Some document class options,
12227 separated by a comma,
12228 that will be added to the optional part of the
12229 \begin_inset Flex Code
12232 \begin_layout Plain Layout
12243 \begin_layout Standard
12245 \begin_inset Flex Code
12248 \begin_layout Plain Layout
12254 section must end with
12255 \begin_inset Quotes eld
12259 \begin_inset Flex Code
12262 \begin_layout Plain Layout
12269 \begin_inset Quotes erd
12275 \begin_layout Subsection
12277 \begin_inset CommandInset label
12279 name "subsec:Paragraph-Styles"
12286 \begin_layout Standard
12287 A paragraph style description looks like this:
12291 \begin_layout Plain Layout
12292 Note that this will either define a new style or modify an existing one.
12300 \begin_layout LyX-Code
12307 \begin_layout LyX-Code
12311 \begin_layout LyX-Code
12315 \begin_layout Standard
12316 where the following commands are allowed:
12319 \begin_layout Description
12320 \begin_inset Flex Code
12323 \begin_layout Plain Layout
12330 \begin_inset Flex Code
12333 \begin_layout Plain Layout
12339 =""] This paragraph will appear in the table of contents of the given type.
12340 An empty string disables.
12341 See also the OutlinerName and the IsTocCaption commands.
12346 \begin_layout Description
12347 \begin_inset Flex Code
12350 \begin_layout Plain Layout
12357 \begin_inset Flex Code
12360 \begin_layout Plain Layout
12373 ] Paragraph alignment.
12376 \begin_layout Description
12377 \begin_inset Flex Code
12380 \begin_layout Plain Layout
12387 \begin_inset Flex Code
12390 \begin_layout Plain Layout
12403 ] A comma separated list of permitted alignments.
12404 (Some \SpecialChar LaTeX
12405 styles prohibit certain alignments,
12406 since those wouldn't make sense.
12407 For example a right-aligned or centered enumeration isn't possible.)
12410 \begin_layout Description
12411 \begin_inset Flex Code
12414 \begin_layout Plain Layout
12421 \begin_inset Flex Code
12424 \begin_layout Plain Layout
12430 ] Defines argument number <int> of a command\SpecialChar breakableslash
12431 environment associated with the current style.
12432 The definition must end with
12433 \begin_inset Flex Code
12436 \begin_layout Plain Layout
12444 \begin_inset CommandInset ref
12446 reference "subsec:Arguments"
12454 for more information.
12458 \begin_layout Description
12459 \begin_inset Flex Code
12462 \begin_layout Plain Layout
12468 Includes a comma-separated list of layouts that should be nested in and after the current layout.
12469 Only makes sense for nestable layouts (such as environments).
12471 \begin_inset Quotes eld
12475 \begin_inset Flex Code
12478 \begin_layout Plain Layout
12485 \begin_inset Quotes erd
12490 \begin_inset Flex Code
12493 \begin_layout Plain Layout
12502 \begin_layout Description
12503 \begin_inset Flex Code
12506 \begin_layout Plain Layout
12512 Note that this will completely override any prior
12513 \begin_inset Flex Code
12516 \begin_layout Plain Layout
12522 declaration for this style.
12524 \begin_inset Quotes eld
12528 \begin_inset Flex Code
12531 \begin_layout Plain Layout
12538 \begin_inset Quotes erd
12543 \begin_inset CommandInset ref
12545 reference "subsec:I18n"
12550 for details on its use.
12553 \begin_layout Description
12554 \begin_inset Flex Code
12557 \begin_layout Plain Layout
12564 \begin_inset Flex Code
12567 \begin_layout Plain Layout
12577 \begin_layout Plain Layout
12578 Note that a `float' here is a real number,
12585 The vertical space with which the last of a chain of paragraphs with this style is separated from the following paragraph.
12586 If the next paragraph has another style,
12587 the separations are not simply added,
12588 but the maximum is taken.
12591 \begin_layout Description
12592 \begin_inset Flex Code
12595 \begin_layout Plain Layout
12602 \begin_inset Flex Code
12605 \begin_layout Plain Layout
12611 ] The category for this style.
12612 This is used to group related styles in the style combobox on the toolbar.
12613 Any string can be used,
12614 but you may want to use existing categories with your own styles.
12618 \begin_layout Description
12619 \begin_inset Flex Code
12622 \begin_layout Plain Layout
12629 \begin_inset Flex Code
12632 \begin_layout Plain Layout
12638 ] Copies all the features of an existing style into the current one.
12639 Note that this copies the style as it is defined at that point.
12640 Later changes to it will not affect styles into which it has been copied.
12643 \begin_layout Description
12644 \begin_inset Flex Code
12647 \begin_layout Plain Layout
12654 \begin_inset Flex Code
12657 \begin_layout Plain Layout
12663 ] The name of a style whose preamble should be output
12668 This allows to ensure some ordering of the preamble snippets when macros definitions depend on one another.
12672 \begin_layout Plain Layout
12674 besides that functionality,
12675 there is no way to ensure any ordering of preambles.
12676 The ordering that you see in a given version of \SpecialChar LyX
12677 may change without warning in later versions.
12685 \begin_layout Description
12686 \begin_inset Flex Code
12689 \begin_layout Plain Layout
12690 DocBookGenerateTitle
12696 \begin_inset Flex Code
12699 \begin_layout Plain Layout
12706 \begin_inset Flex Code
12709 \begin_layout Plain Layout
12715 tag after the wrapper tag.
12716 This parameter should only be used with
12717 \begin_inset Flex Code
12720 \begin_layout Plain Layout
12727 otherwise the title will be output
12731 the contents of the environment.
12732 The generated title is the same as the LyXHTML label:
12733 a combination of the environment type and its number.
12734 A major use is when DocBook has no close mapping for LaTeX environments and users must fallback to using a generic container such as
12735 \begin_inset Flex Code
12738 \begin_layout Plain Layout
12745 which requires a title although there is none in LaTeX.
12746 This feature is heavily used for theorem-like environments.
12749 \begin_layout Description
12750 \begin_inset Flex Code
12753 \begin_layout Plain Layout
12760 \begin_inset Flex Code
12763 \begin_layout Plain Layout
12776 ] The type of label that stands at the end of the paragraph (or sequence of paragraphs if
12777 \begin_inset Flex Code
12780 \begin_layout Plain Layout
12787 \begin_inset Newline newline
12791 \begin_inset Flex Code
12794 \begin_layout Plain Layout
12802 \begin_inset Flex Code
12805 \begin_layout Plain Layout
12812 \begin_inset Flex Code
12815 \begin_layout Plain Layout
12823 \begin_inset Flex Code
12826 \begin_layout Plain Layout
12833 \begin_inset Quotes eld
12837 \begin_inset Quotes erd
12842 \begin_inset Flex Code
12845 \begin_layout Plain Layout
12852 \begin_inset space \space{}
12856 \begin_inset Flex Code
12859 \begin_layout Plain Layout
12865 ) is a white (resp.
12866 \begin_inset space ~
12869 black) square suitable for end of proof markers,
12871 \begin_inset Flex Code
12874 \begin_layout Plain Layout
12880 is an explicit text string.
12883 \begin_layout Description
12884 \begin_inset Flex Code
12887 \begin_layout Plain Layout
12894 \begin_inset Flex Code
12897 \begin_layout Plain Layout
12903 ] The string used for a label with a
12904 \begin_inset Flex Code
12907 \begin_layout Plain Layout
12914 \begin_inset Newline newline
12918 \begin_inset Flex Code
12921 \begin_layout Plain Layout
12931 \begin_layout Description
12932 \begin_inset Flex Code
12935 \begin_layout Plain Layout
12941 The font used for both the text body
12947 \begin_inset CommandInset ref
12949 reference "subsec:Font-description"
12955 Note that defining this font automatically defines the
12956 \begin_inset Flex Code
12959 \begin_layout Plain Layout
12966 So you should define this one first if you also want to define
12967 \begin_inset Flex Code
12970 \begin_layout Plain Layout
12979 \begin_layout Description
12980 \begin_inset Flex Code
12983 \begin_layout Plain Layout
12990 \begin_inset Flex Code
12993 \begin_layout Plain Layout
12999 ] Used for backporting new styles to stable \SpecialChar LyX
13001 The first stable version that supports this tag is \SpecialChar LyX
13003 The argument is a number which may either be 0,
13004 -1 or any value greater than zero.
13006 \begin_inset Flex Code
13009 \begin_layout Plain Layout
13015 flag of a style is greater than zero,
13016 it will always be written to the document header.
13017 If a .lyx file is read,
13018 the style definitions from the document header are added to the document class.
13019 Therefore even older \SpecialChar LyX
13020 versions can handle the style.
13022 \begin_inset Flex Code
13025 \begin_layout Plain Layout
13031 is a version number:
13032 if the style is read,
13033 and the version number is less than the version number of the already existing style in the document class,
13034 the new style is ignored.
13035 If the version number is greater,
13036 the new style replaces the existing style.
13037 A value of -1 means an infinite version number,
13039 \begin_inset space \thinspace{}
13043 \begin_inset space \space{}
13046 the style is always used.
13049 \begin_layout Description
13050 \begin_inset Flex Code
13053 \begin_layout Plain Layout
13060 \begin_inset Flex Code
13063 \begin_layout Plain Layout
13072 \begin_inset space \thinspace{}
13076 \begin_inset Flex Code
13079 \begin_layout Plain Layout
13085 ] Usually \SpecialChar LyX
13086 does not allow you to insert more than one space between words,
13087 since a space is considered as the separation between two words,
13088 not a character or symbol of its own.
13089 This is a very fine thing but sometimes annoying,
13091 when typing program code or plain \SpecialChar LaTeX
13095 \begin_inset Flex Code
13098 \begin_layout Plain Layout
13106 will create non-breaking spaces for the additional blanks when
13107 \begin_inset Flex Code
13110 \begin_layout Plain Layout
13118 \begin_inset Flex Code
13121 \begin_layout Plain Layout
13128 \begin_inset Flex Code
13131 \begin_layout Plain Layout
13140 \begin_layout Description
13141 \begin_inset Flex Code
13144 \begin_layout Plain Layout
13150 These tags are used with XHTML output.
13152 \begin_inset CommandInset ref
13154 reference "subsec:Paragraph-Style-XHTML"
13162 \begin_layout Description
13163 \begin_inset Flex Code
13166 \begin_layout Plain Layout
13173 \begin_inset Flex Code
13176 \begin_layout Plain Layout
13185 \begin_inset space \thinspace{}
13189 \begin_inset Flex Code
13192 \begin_layout Plain Layout
13199 \begin_inset Flex Code
13202 \begin_layout Plain Layout
13209 marks the style as to be included in the document preamble and not in the document body.
13210 This is useful for document classes that want such information as the title and author to appear in the preamble.
13211 Note that this works only for styles for which the
13212 \begin_inset Flex Code
13215 \begin_layout Plain Layout
13222 \begin_inset Flex Code
13225 \begin_layout Plain Layout
13232 \begin_inset Flex Code
13235 \begin_layout Plain Layout
13244 \begin_layout Description
13245 \begin_inset Flex Code
13248 \begin_layout Plain Layout
13255 \begin_inset Flex Code
13258 \begin_layout Plain Layout
13267 \begin_inset space \thinspace{}
13271 \begin_inset Flex Code
13274 \begin_layout Plain Layout
13281 \begin_inset Flex Code
13284 \begin_layout Plain Layout
13291 marks the style as being part of a title block (see also the
13292 \begin_inset Flex Code
13295 \begin_layout Plain Layout
13302 \begin_inset Flex Code
13305 \begin_layout Plain Layout
13314 \begin_layout Description
13315 \begin_inset Flex Code
13318 \begin_layout Plain Layout
13324 Includes a comma-separated list of layouts after which this one should be nested.
13325 Only makes sense with regard to nestable layouts (such as environments).
13327 \begin_inset Quotes eld
13331 \begin_inset Flex Code
13334 \begin_layout Plain Layout
13341 \begin_inset Quotes erd
13346 \begin_inset Flex Code
13349 \begin_layout Plain Layout
13358 \begin_layout Description
13359 \begin_inset Flex Code
13362 \begin_layout Plain Layout
13369 \begin_inset Flex Code
13372 \begin_layout Plain Layout
13381 \begin_inset space \thinspace{}
13385 \begin_inset Flex Code
13388 \begin_layout Plain Layout
13394 ] If this is set to 1 and AddToToc is enabled,
13395 the paragraph adds a summary of its contents in its item in the table of contents.
13402 \begin_layout Description
13403 \begin_inset Flex Code
13406 \begin_layout Plain Layout
13413 \begin_inset Flex Code
13416 \begin_layout Plain Layout
13422 ] The \SpecialChar LaTeX
13423 command sequence declaring an item in a list.
13424 The command is to be defined without the preceding backslash (the default is
13425 \begin_inset Quotes eld
13429 \begin_inset Quotes erd
13434 \begin_inset Flex Code
13437 \begin_layout Plain Layout
13445 in the \SpecialChar LaTeX
13449 \begin_layout Description
13450 \begin_inset Flex Code
13453 \begin_layout Plain Layout
13460 \begin_inset Flex Code
13463 \begin_layout Plain Layout
13469 ] This provides extra space between paragraphs that have the same style.
13470 If you put other styles into an environment,
13471 each is separated with the environment's
13472 \begin_inset Flex Code
13475 \begin_layout Plain Layout
13482 But the whole items of the environment are additionally separated with this
13483 \begin_inset Flex Code
13486 \begin_layout Plain Layout
13493 Note that this is a
13498 \begin_layout Description
13499 \begin_inset Flex Code
13502 \begin_layout Plain Layout
13509 \begin_inset Flex Code
13512 \begin_layout Plain Layout
13521 \begin_inset space \thinspace{}
13525 \begin_inset Flex Code
13528 \begin_layout Plain Layout
13534 ] Usually \SpecialChar LyX
13535 does not allow you to leave a paragraph empty,
13536 since it would lead to empty \SpecialChar LaTeX
13538 There are some cases where this could be desirable however:
13539 in a letter template,
13540 the required fields can be provided as empty fields,
13541 so that people do not forget them;
13542 in some special classes,
13543 a style can be used as some kind of break,
13544 which does not contain actual text.
13547 \begin_layout Description
13548 \begin_inset Flex Code
13551 \begin_layout Plain Layout
13558 \begin_inset Flex Code
13561 \begin_layout Plain Layout
13567 ] The vertical space between the label and the text body.
13568 Only used for labels that are above the text body (
13569 \begin_inset Flex Code
13572 \begin_layout Plain Layout
13579 \begin_inset Newline newline
13583 \begin_inset Flex Code
13586 \begin_layout Plain Layout
13587 Centered_Top_Environment
13595 \begin_layout Description
13596 \begin_inset Flex Code
13599 \begin_layout Plain Layout
13606 \begin_inset Flex Code
13609 \begin_layout Plain Layout
13615 ] The name of the counter for automatic numbering.
13616 In order to have the counter appear with your label,
13617 you will need to reference it in the
13618 \begin_inset Flex Code
13621 \begin_layout Plain Layout
13630 This will work with
13631 \begin_inset Flex Code
13634 \begin_layout Plain Layout
13642 \begin_inset Flex Code
13645 \begin_layout Plain Layout
13653 \begin_inset Flex Code
13656 \begin_layout Plain Layout
13663 \begin_inset Flex Code
13666 \begin_layout Plain Layout
13674 \begin_inset Newline newline
13682 \begin_inset Flex Code
13685 \begin_layout Plain Layout
13692 \begin_inset Flex Code
13695 \begin_layout Plain Layout
13702 though this case is a bit complicated.
13703 Suppose you declare
13704 \begin_inset Quotes eld
13708 \begin_inset Flex Code
13711 \begin_layout Plain Layout
13712 LabelCounter myenum
13718 \begin_inset Quotes erd
13722 Then the actual counters used are
13723 \begin_inset Flex Code
13726 \begin_layout Plain Layout
13734 \begin_inset Flex Code
13737 \begin_layout Plain Layout
13745 \begin_inset Flex Code
13748 \begin_layout Plain Layout
13755 \begin_inset Flex Code
13758 \begin_layout Plain Layout
13765 much as in \SpecialChar LaTeX
13767 These counters must all be declared separately.
13768 \begin_inset Newline newline
13772 \begin_inset CommandInset ref
13774 reference "subsec:Counters"
13779 for details on counters.
13782 \begin_layout Description
13783 \begin_inset Flex Code
13786 \begin_layout Plain Layout
13792 The font used for the label.
13794 \begin_inset CommandInset ref
13796 reference "subsec:Font-description"
13804 \begin_layout Description
13805 \begin_inset Flex Code
13808 \begin_layout Plain Layout
13815 \begin_inset Flex Code
13818 \begin_layout Plain Layout
13824 ] Text that indicates how far a label should be indented.
13827 \begin_layout Description
13828 \begin_inset Flex Code
13831 \begin_layout Plain Layout
13838 \begin_inset Flex Code
13841 \begin_layout Plain Layout
13847 ] Text that indicates the amount of horizontal space between the label and the text body.
13848 Only used for labels that are not above the text body.
13851 \begin_layout Description
13852 \begin_inset Flex Code
13855 \begin_layout Plain Layout
13862 \begin_inset Flex Code
13865 \begin_layout Plain Layout
13871 ] The string used for the label.
13873 \begin_inset Flex Code
13876 \begin_layout Plain Layout
13883 this string can be contain the special formatting commands described in
13884 \begin_inset CommandInset ref
13886 reference "subsec:Counters"
13894 \begin_layout Description
13895 \begin_inset Flex Code
13898 \begin_layout Plain Layout
13899 LabelStringAppendix
13905 \begin_inset Flex Code
13908 \begin_layout Plain Layout
13914 ] This is used inside the appendix instead of
13915 \begin_inset Newline newline
13919 \begin_inset Flex Code
13922 \begin_layout Plain Layout
13930 \begin_inset Flex Code
13933 \begin_layout Plain Layout
13940 \begin_inset Newline newline
13944 \begin_inset Flex Code
13947 \begin_layout Plain Layout
13948 LabelStringAppendix
13956 \begin_layout Description
13957 \begin_inset Flex Code
13960 \begin_layout Plain Layout
13967 \begin_inset Flex Code
13970 \begin_layout Plain Layout
13980 \begin_inset Newline newline
13986 \begin_inset Newline newline
13999 \begin_layout Description
14000 \begin_inset Flex Code
14003 \begin_layout Plain Layout
14009 means the label is the very first word (up to the first real blank).
14010 Use non-breaking spaces if you want more than one word as the label.
14014 \begin_layout Description
14015 \begin_inset Flex Code
14018 \begin_layout Plain Layout
14024 means the label is simply what is declared as
14025 \begin_inset Flex Code
14028 \begin_layout Plain Layout
14035 This will be displayed
14036 \begin_inset Quotes eld
14040 \begin_inset Quotes erd
14044 at the beginning of the paragraph.
14046 \begin_inset Flex Code
14049 \begin_layout Plain Layout
14056 \begin_inset Flex Code
14059 \begin_layout Plain Layout
14066 then it will be displayed only in the first paragraph of any sequence of paragraphs with the same
14067 \begin_inset Flex Code
14070 \begin_layout Plain Layout
14079 \begin_layout Description
14080 \begin_inset Flex Code
14083 \begin_layout Plain Layout
14090 \begin_inset space ~
14094 \begin_inset space ~
14098 \begin_inset Flex Code
14101 \begin_layout Plain Layout
14107 are special cases of
14108 \begin_inset Flex Code
14111 \begin_layout Plain Layout
14118 The label will be printed above the paragraph either at the beginning of the line or centered.
14121 \begin_layout Description
14122 \begin_inset Flex Code
14125 \begin_layout Plain Layout
14131 is a special case for the caption-labels
14132 \begin_inset Quotes eld
14136 \begin_inset Quotes erd
14140 \begin_inset Quotes eld
14144 \begin_inset Quotes erd
14148 \begin_inset Newline newline
14152 \begin_inset Flex Code
14155 \begin_layout Plain Layout
14161 means the (hardcoded) label string depends on the kind of float:
14162 It is hardcoded to be `FloatType N',
14163 where N is the value of the counter associated with the float.
14164 For the case that a caption is inserted outside of a float the
14165 \begin_inset Flex Code
14168 \begin_layout Plain Layout
14175 \begin_inset Quotes eld
14179 \begin_inset Quotes erd
14185 \begin_layout Description
14186 \begin_inset Flex Code
14189 \begin_layout Plain Layout
14195 produces the usual sort of enumeration labels.
14196 The number type needs to be set in the
14202 \begin_inset CommandInset ref
14204 reference "subsec:Counters"
14212 \begin_layout Description
14213 \begin_inset Flex Code
14216 \begin_layout Plain Layout
14222 produces various bullets at the different levels.
14223 The bullet types displayed can be set via
14224 \begin_inset Flex Noun
14227 \begin_layout Plain Layout
14228 Document\SpecialChar menuseparator
14229 Settings\SpecialChar menuseparator
14238 \begin_layout Description
14239 \begin_inset Flex Code
14242 \begin_layout Plain Layout
14248 should be used only with
14249 \begin_inset Flex Code
14252 \begin_layout Plain Layout
14253 LatexType BibEnvironment
14262 \begin_layout Description
14263 \begin_inset Flex Code
14266 \begin_layout Plain Layout
14272 Note that this will completely override any prior
14273 \begin_inset Flex Code
14276 \begin_layout Plain Layout
14282 declaration for this style.
14284 \begin_inset Quotes eld
14288 \begin_inset Flex Code
14291 \begin_layout Plain Layout
14298 \begin_inset Quotes erd
14303 \begin_inset CommandInset ref
14305 reference "subsec:I18n"
14310 for details on its use.
14313 \begin_layout Description
14314 \begin_inset Flex Code
14317 \begin_layout Plain Layout
14324 \begin_inset Flex Code
14327 \begin_layout Plain Layout
14333 ] The name of the corresponding \SpecialChar LaTeX
14335 Either the environment or command name.
14338 \begin_layout Description
14339 \begin_inset Flex Code
14342 \begin_layout Plain Layout
14349 \begin_inset Flex Code
14352 \begin_layout Plain Layout
14358 ] An optional parameter for the corresponding
14359 \begin_inset Flex Code
14362 \begin_layout Plain Layout
14369 This parameter cannot be changed from within \SpecialChar LyX
14371 \begin_inset Flex Code
14374 \begin_layout Plain Layout
14380 for customizable parameters).
14381 This will be output as is after all \SpecialChar LaTeX
14383 \begin_inset Flex Code
14386 \begin_layout Plain Layout
14395 \begin_layout Description
14396 \begin_inset Flex Code
14399 \begin_layout Plain Layout
14406 \begin_inset Flex Code
14409 \begin_layout Plain Layout
14418 \begin_inset Newline newline
14427 ] How the style should be translated into \SpecialChar LaTeX
14432 \begin_layout Plain Layout
14433 \begin_inset Flex Code
14436 \begin_layout Plain Layout
14442 is perhaps a bit misleading,
14443 since these rules apply to SGML classes,
14445 Visit the SGML class files for specific examples.
14454 \begin_layout Description
14455 \begin_inset Flex Code
14458 \begin_layout Plain Layout
14464 means nothing special.
14467 \begin_layout Description
14468 \begin_inset Flex Code
14471 \begin_layout Plain Layout
14478 \begin_inset Flex Code
14481 \begin_layout Plain Layout
14488 {\SpecialChar ldots
14497 \begin_layout Description
14498 \begin_inset Flex Code
14501 \begin_layout Plain Layout
14508 \begin_inset Flex Code
14511 \begin_layout Plain Layout
14518 }\SpecialChar ldots
14534 \begin_layout Description
14535 \begin_inset Flex Code
14538 \begin_layout Plain Layout
14545 \begin_inset Flex Code
14548 \begin_layout Plain Layout
14556 \begin_inset Flex Code
14559 \begin_layout Plain Layout
14567 is generated for each paragraph of this environment.
14571 \begin_layout Description
14572 \begin_inset Flex Code
14575 \begin_layout Plain Layout
14582 \begin_inset Flex Code
14585 \begin_layout Plain Layout
14593 \begin_inset Newline newline
14597 \begin_inset Flex Code
14600 \begin_layout Plain Layout
14606 is passed as an argument to the environment.
14607 \begin_inset Newline newline
14611 \begin_inset Flex Code
14614 \begin_layout Plain Layout
14620 can be defined in the
14621 \begin_inset Flex Noun
14624 \begin_layout Plain Layout
14625 Edit\SpecialChar menuseparator
14627 \begin_inset space ~
14638 \begin_layout Description
14639 \begin_inset Flex Code
14642 \begin_layout Plain Layout
14649 \begin_inset Flex Code
14652 \begin_layout Plain Layout
14658 but adds the necessary mandatory argument (the longest label) to the begin statement of the bibliography environment:
14659 \begin_inset Newline newline
14663 \begin_inset Flex Code
14666 \begin_layout Plain Layout
14669 begin{thebibliography}{99}
14675 It is therefore only useful for bibliography environments.
14676 The default longest label
14677 \begin_inset Quotes eld
14681 \begin_inset Quotes erd
14684 can be changed by the user in the paragraph settings of a bibliography item.
14687 \begin_layout Standard
14688 Putting the last few things together,
14689 the \SpecialChar LaTeX
14690 output will be either:
14694 \begin_layout LyX-Code
14697 LatexName[LatexParam]{\SpecialChar ldots
14701 \begin_layout Standard
14706 \begin_layout LyX-Code
14709 begin{LatexName}[LatexParam] \SpecialChar ldots
14715 \begin_layout Standard
14716 depending upon the \SpecialChar LaTeX
14721 \begin_layout Description
14722 \begin_inset Flex Code
14725 \begin_layout Plain Layout
14732 \begin_inset Flex Code
14735 \begin_layout Plain Layout
14741 ] A string that is put at the beginning of the style content.
14742 A line break in the output can be indicated by
14743 \begin_inset Flex Code
14746 \begin_layout Plain Layout
14755 \begin_layout Description
14756 \begin_inset Flex Code
14759 \begin_layout Plain Layout
14766 \begin_inset Flex Code
14769 \begin_layout Plain Layout
14775 ] If you put styles into environments,
14777 \begin_inset Flex Code
14780 \begin_layout Plain Layout
14786 are not simply added,
14787 but added with a factor
14788 \begin_inset Formula $\frac{4}{\mathrm{depth}+4}$
14792 Note that this parameter is also used when
14793 \begin_inset Flex Code
14796 \begin_layout Plain Layout
14803 \begin_inset Flex Code
14806 \begin_layout Plain Layout
14813 \begin_inset Flex Code
14816 \begin_layout Plain Layout
14823 Then it is added to the manual or dynamic margin.
14824 \begin_inset Newline newline
14828 \begin_inset Quotes eld
14832 \begin_inset Flex Code
14835 \begin_layout Plain Layout
14842 \begin_inset Quotes erd
14845 means that the paragraph is indented with the width of
14846 \begin_inset Quotes eld
14850 \begin_inset Flex Code
14853 \begin_layout Plain Layout
14860 \begin_inset Quotes erd
14863 in the normal font.
14864 You can get a negative width by prefixing the string with
14865 \begin_inset Quotes eld
14869 \begin_inset Flex Code
14872 \begin_layout Plain Layout
14879 \begin_inset Quotes erd
14883 This way was chosen so that the look is the same with each used screen font.
14886 \begin_layout Description
14887 \begin_inset Flex Code
14890 \begin_layout Plain Layout
14897 \begin_inset Flex Code
14900 \begin_layout Plain Layout
14915 \begin_inset Newline newline
14918 The kind of margin that the style has on the left side.
14922 \begin_layout Description
14923 \begin_inset Flex Code
14926 \begin_layout Plain Layout
14932 just means a fixed margin.
14935 \begin_layout Description
14936 \begin_inset Flex Code
14939 \begin_layout Plain Layout
14945 means that the left margin depends on the string entered in the
14946 \begin_inset Flex Noun
14949 \begin_layout Plain Layout
14950 Edit\SpecialChar menuseparator
14952 \begin_inset space ~
14961 This is used to typeset nice lists without tabulators.
14964 \begin_layout Description
14965 \begin_inset Flex Code
14968 \begin_layout Plain Layout
14974 means that the margin depends on the size of the label.
14975 This is used for automatic enumerated headlines.
14976 It is obvious that the headline
14977 \begin_inset Quotes eld
14980 5.4.3.2.1 Very long headline
14981 \begin_inset Quotes erd
14984 must have a wider left margin (as wide as
14985 \begin_inset Quotes eld
14989 \begin_inset Quotes erd
14992 plus the space) than
14993 \begin_inset Quotes eld
14996 3.2 Very long headline
14997 \begin_inset Quotes erd
15002 \begin_inset Quotes eld
15006 \begin_inset Quotes erd
15009 are not able to do this.
15012 \begin_layout Description
15013 \begin_inset Flex Code
15016 \begin_layout Plain Layout
15023 but only the very first row of the paragraph is dynamic,
15024 while the others are static;
15030 \begin_layout Description
15031 \begin_inset Flex Code
15034 \begin_layout Plain Layout
15040 means the margin is chosen in a way that the longest row of this paragraph fits to the right margin.
15041 This is used to typeset an address on the right edge of the page.
15045 \begin_layout Description
15046 \begin_inset Flex Code
15049 \begin_layout Plain Layout
15056 \begin_inset Flex Code
15059 \begin_layout Plain Layout
15068 \begin_inset space \thinspace{}
15072 \begin_inset Flex Code
15075 \begin_layout Plain Layout
15081 ] Whether fragile commands in this style should be
15082 \begin_inset Flex Code
15085 \begin_layout Plain Layout
15099 whether this command should itself be protected.)
15102 \begin_layout Description
15103 \begin_inset Flex Code
15106 \begin_layout Plain Layout
15113 \change_inserted -712698321 1715492667
15115 \begin_inset Flex Code
15118 \begin_layout Plain Layout
15120 \change_inserted -712698321 1715492433
15129 \begin_inset space \thinspace{}
15135 \begin_inset Flex Code
15138 \begin_layout Plain Layout
15147 \begin_inset space \thinspace{}
15151 \begin_inset Flex Code
15154 \begin_layout Plain Layout
15161 \change_inserted -712698321 1715492466
15163 \begin_inset Flex Code
15166 \begin_layout Plain Layout
15168 \change_inserted -712698321 1715492466
15177 \change_deleted -712698321 1715492468
15180 causes macros that contain this layout to be protected with
15181 \begin_inset Flex Code
15184 \begin_layout Plain Layout
15197 ) if necessary and thus allows (some) verbatim stuff in macros.
15199 \change_inserted -712698321 1715492595
15200 With the default setting (value
15201 \begin_inset Flex Code
15204 \begin_layout Plain Layout
15206 \change_inserted -712698321 1715492536
15216 \begin_inset Flex Code
15219 \begin_layout Plain Layout
15221 \change_inserted -712698321 1715492551
15231 is used if a nested element requires it.
15233 \begin_inset Flex Code
15236 \begin_layout Plain Layout
15238 \change_inserted -712698321 1715492585
15246 prevents any use of
15247 \begin_inset Flex Code
15250 \begin_layout Plain Layout
15252 \change_inserted -712698321 1715492585
15262 within this layout,
15263 even if required by a nested element.
15268 \begin_layout Description
15269 \begin_inset Flex Code
15272 \begin_layout Plain Layout
15279 \begin_inset Flex Code
15282 \begin_layout Plain Layout
15291 \begin_inset space \thinspace{}
15295 \begin_inset Flex Code
15298 \begin_layout Plain Layout
15304 ] Whether specific commands in this style (such as
15305 \begin_inset Flex Code
15308 \begin_layout Plain Layout
15317 \begin_inset Flex Code
15320 \begin_layout Plain Layout
15328 ) should be protected in an
15329 \begin_inset Flex Code
15332 \begin_layout Plain Layout
15341 This is particularly needed for styles that draw on
15349 commands which parse their content in complex ways.
15352 \begin_layout Description
15353 \begin_inset Flex Code
15356 \begin_layout Plain Layout
15363 \begin_inset Flex Code
15366 \begin_layout Plain Layout
15373 \begin_inset space \thinspace{}
15377 \begin_inset Flex Code
15380 \begin_layout Plain Layout
15388 ] Whether newlines are translated into \SpecialChar LaTeX
15390 \begin_inset Flex Code
15393 \begin_layout Plain Layout
15404 The translation can be switched off to allow more comfortable \SpecialChar LaTeX
15405 editing inside \SpecialChar LyX
15409 \begin_layout Description
15410 \begin_inset Flex Code
15413 \begin_layout Plain Layout
15420 \begin_inset Flex Code
15423 \begin_layout Plain Layout
15432 \begin_inset space \thinspace{}
15436 \begin_inset Flex Code
15439 \begin_layout Plain Layout
15447 \begin_inset Flex Code
15450 \begin_layout Plain Layout
15457 \begin_inset Flex Code
15460 \begin_layout Plain Layout
15466 ) paragraphs are being indented,
15467 then the indentation of such a paragraph following one of this type will be suppressed.
15468 (So this will not affect the display of non-default paragraphs.)
15471 \begin_layout Description
15473 \change_inserted -712698321 1715509676
15474 \begin_inset Flex Code
15477 \begin_layout Plain Layout
15479 \change_inserted -712698321 1715509206
15488 \begin_inset Flex Code
15491 \begin_layout Plain Layout
15493 \change_inserted -712698321 1715509203
15505 Defines individual characters that should
15509 be output in raw form (without special translations that \SpecialChar LaTeX
15511 even if such handling is requested by an element in this layout.
15512 This tag can be used to overwrite
15513 \begin_inset Quotes els
15517 \begin_inset Quotes ers
15520 conditions if they are unsuitable in a given context.
15523 \begin_layout Description
15524 \begin_inset Flex Code
15527 \begin_layout Plain Layout
15534 \begin_inset Flex Code
15537 \begin_layout Plain Layout
15543 ] Name of a style that has replaced this style.
15544 This is used to rename a style,
15545 while keeping backward compatibility.
15548 \begin_layout Description
15549 \begin_inset Flex Code
15552 \begin_layout Plain Layout
15559 \begin_inset Flex Code
15562 \begin_layout Plain Layout
15569 \begin_inset space \thinspace{}
15573 \begin_inset Flex Code
15576 \begin_layout Plain Layout
15582 ] Determines whether consecutive paragraphs of the same type are treated as belonging together.
15583 This has the effect that the
15584 \begin_inset Flex Code
15587 \begin_layout Plain Layout
15593 is only printed once before such a group.
15596 \begin_inset Flex Code
15599 \begin_layout Plain Layout
15606 \begin_inset Flex Code
15609 \begin_layout Plain Layout
15616 \begin_inset Flex Code
15619 \begin_layout Plain Layout
15625 and false for all other types.
15628 \begin_layout Description
15629 \begin_inset Flex Code
15632 \begin_layout Plain Layout
15639 \begin_inset Flex Code
15642 \begin_layout Plain Layout
15651 \begin_inset space \thinspace{}
15655 \begin_inset Flex Code
15658 \begin_layout Plain Layout
15664 ] Indicates that paragraphs will not be separated by an empty line in \SpecialChar LaTeX
15666 but only by a line break;
15668 \begin_inset Flex Code
15671 \begin_layout Plain Layout
15678 this allows to emulate a plain text editor (like the ERT inset).
15681 \begin_layout Description
15682 \begin_inset Flex Code
15685 \begin_layout Plain Layout
15692 \begin_inset Flex Code
15695 \begin_layout Plain Layout
15701 ] The indent of the very first line of a paragraph.
15703 \begin_inset Newline newline
15707 \begin_inset Flex Code
15710 \begin_layout Plain Layout
15716 will be fixed for a certain style.
15717 The exception is the default style,
15718 since the indentation for these paragraphs can be prohibited with
15719 \begin_inset Flex Code
15722 \begin_layout Plain Layout
15731 \begin_inset Flex Code
15734 \begin_layout Plain Layout
15740 style paragraphs inside environments use the
15741 \begin_inset Flex Code
15744 \begin_layout Plain Layout
15750 of the environment,
15751 not their native one.
15754 \begin_inset Flex Code
15757 \begin_layout Plain Layout
15763 paragraphs inside an enumeration are not indented.
15766 \begin_layout Description
15767 \begin_inset Flex Code
15770 \begin_layout Plain Layout
15777 \begin_inset Flex Code
15780 \begin_layout Plain Layout
15786 ] The vertical space between two paragraphs of this style.
15789 \begin_layout Description
15790 \begin_inset Flex Code
15793 \begin_layout Plain Layout
15800 \begin_inset Flex Code
15803 \begin_layout Plain Layout
15810 allows the user to choose either
15811 \begin_inset Quotes eld
15815 \begin_inset Quotes erd
15819 \begin_inset Quotes eld
15823 \begin_inset Quotes erd
15826 to separate paragraphs.
15828 \begin_inset Quotes eld
15832 \begin_inset Quotes erd
15837 \begin_inset Flex Code
15840 \begin_layout Plain Layout
15848 \begin_inset Quotes eld
15852 \begin_inset Quotes erd
15857 \begin_inset Flex Code
15860 \begin_layout Plain Layout
15866 is ignored and all paragraphs are separated by the
15867 \begin_inset Flex Code
15870 \begin_layout Plain Layout
15877 The vertical space is calculated with
15878 \begin_inset Flex Code
15881 \begin_layout Plain Layout
15883 \begin_inset space ~
15892 \begin_inset Flex Code
15895 \begin_layout Plain Layout
15901 is the height of a row with the normal font.
15903 the look stays the same with different screen fonts.
15906 \begin_layout Description
15907 \begin_inset Flex Code
15910 \begin_layout Plain Layout
15917 \begin_inset Flex Code
15920 \begin_layout Plain Layout
15929 \begin_inset space \thinspace{}
15933 \begin_inset Flex Code
15936 \begin_layout Plain Layout
15942 ] Whether the contents of this paragraph should be output in raw form,
15943 meaning without special translations that \SpecialChar LaTeX
15947 \begin_layout Description
15948 \begin_inset Flex Code
15951 \begin_layout Plain Layout
15958 \begin_inset Flex Code
15961 \begin_layout Plain Layout
15971 Defines individual characters that should be output in raw form,
15972 meaning without special translations that \SpecialChar LaTeX
15976 \begin_layout Description
15977 \begin_inset Flex Code
15980 \begin_layout Plain Layout
15986 Information to be included in the \SpecialChar LaTeX
15987 preamble when this style is used.
15988 Used to define macros,
15991 required by this particular style.
15993 \begin_inset Quotes eld
15997 \begin_inset Flex Code
16000 \begin_layout Plain Layout
16007 \begin_inset Quotes erd
16013 \begin_layout Description
16014 \begin_inset Flex Code
16017 \begin_layout Plain Layout
16024 \begin_inset Flex Code
16027 \begin_layout Plain Layout
16033 ] The prefix to use when creating labels referring to paragraphs of this type.
16034 This allows the use of formatted references.
16037 \begin_layout Description
16038 \begin_inset Flex Code
16041 \begin_layout Plain Layout
16048 \begin_inset Flex Code
16051 \begin_layout Plain Layout
16057 ] Whether the style requires the feature
16058 \begin_inset Flex Code
16061 \begin_layout Plain Layout
16068 \begin_inset CommandInset ref
16070 reference "chap:List-of-functions"
16075 for the list of features).
16076 If you require a package with specific options,
16077 you can additionally use
16078 \begin_inset Flex Code
16081 \begin_layout Plain Layout
16087 as a general text class parameter (see
16088 \begin_inset CommandInset ref
16090 reference "subsec:General-text-class"
16098 \begin_layout Description
16099 \begin_inset Flex Code
16102 \begin_layout Plain Layout
16109 \begin_inset Flex Code
16112 \begin_layout Plain Layout
16121 \begin_inset Flex Code
16124 \begin_layout Plain Layout
16130 ] Resets the \SpecialChar LaTeX
16131 arguments of this style (as defined via the
16132 \begin_inset Flex Code
16135 \begin_layout Plain Layout
16142 This is useful if you have copied a style via
16143 \begin_inset Flex Code
16146 \begin_layout Plain Layout
16153 but you do not want to inherit its (required and optional) arguments.
16156 \begin_layout Description
16157 \begin_inset Flex Code
16160 \begin_layout Plain Layout
16167 \begin_inset Flex Code
16170 \begin_layout Plain Layout
16179 \begin_inset Flex Code
16182 \begin_layout Plain Layout
16188 ] Resumes a counter that is usually reset at each new sequence of layouts.
16189 This is currently only useful when
16190 \begin_inset Flex Code
16193 \begin_layout Plain Layout
16200 \begin_inset Flex Code
16203 \begin_layout Plain Layout
16212 \begin_layout Description
16213 \begin_inset Flex Code
16216 \begin_layout Plain Layout
16223 \begin_inset Flex Code
16226 \begin_layout Plain Layout
16232 ] A string that is put at the end of the layout content.
16233 A line break in the output can be indicated by
16234 \begin_inset Flex Code
16237 \begin_layout Plain Layout
16246 \begin_layout Description
16247 \begin_inset Flex Code
16250 \begin_layout Plain Layout
16257 \begin_inset Flex Code
16260 \begin_layout Plain Layout
16267 \begin_inset Flex Code
16270 \begin_layout Plain Layout
16279 \begin_layout Description
16280 \begin_inset Flex Code
16283 \begin_layout Plain Layout
16290 \begin_inset Flex Code
16293 \begin_layout Plain Layout
16303 \begin_inset Flex Code
16306 \begin_layout Plain Layout
16314 \begin_inset Flex Code
16317 \begin_layout Plain Layout
16325 \begin_inset Flex Code
16328 \begin_layout Plain Layout
16330 \begin_inset space ~
16338 ] This defines what the default spacing should be in the style.
16340 \begin_inset Flex Code
16343 \begin_layout Plain Layout
16351 \begin_inset Flex Code
16354 \begin_layout Plain Layout
16361 \begin_inset Flex Code
16364 \begin_layout Plain Layout
16370 correspond respectively to a multiplier value of 1,
16372 If you specify the argument
16373 \begin_inset Flex Code
16376 \begin_layout Plain Layout
16383 then you must also provide a value argument which will be the actual multiplier value.
16385 contrary to other parameters,
16387 \begin_inset Flex Code
16390 \begin_layout Plain Layout
16396 implies the generation of specific \SpecialChar LaTeX
16398 using the \SpecialChar LaTeX
16402 \begin_inset Flex Code
16405 \begin_layout Plain Layout
16414 \begin_layout Description
16415 \begin_inset Flex Code
16418 \begin_layout Plain Layout
16425 \begin_inset Flex Code
16428 \begin_layout Plain Layout
16435 \begin_inset space \thinspace{}
16439 \begin_inset Flex Code
16442 \begin_layout Plain Layout
16450 ] Allow spell-checking paragraphs of this style.
16454 \begin_layout Description
16455 \begin_inset Flex Code
16458 \begin_layout Plain Layout
16465 \begin_inset Flex Code
16468 \begin_layout Plain Layout
16477 \begin_inset Flex Code
16480 \begin_layout Plain Layout
16486 ] Steps the parent counter of a given counter at the beginning of a new sequence of layouts.
16487 This is currently only useful when
16488 \begin_inset Flex Code
16491 \begin_layout Plain Layout
16498 \begin_inset Flex Code
16501 \begin_layout Plain Layout
16510 \begin_layout Description
16511 \begin_inset Flex Code
16514 \begin_layout Plain Layout
16520 The font used for the text body .
16522 \begin_inset CommandInset ref
16524 reference "subsec:Font-description"
16532 \begin_layout Description
16533 \begin_inset Flex Code
16536 \begin_layout Plain Layout
16545 \begin_inset Flex Code
16548 \begin_layout Plain Layout
16558 The level of the style in the table of contents.
16559 This is used for automatic numbering of section headings.
16562 \begin_layout Description
16563 \begin_inset Flex Code
16566 \begin_layout Plain Layout
16575 \begin_inset Flex Code
16578 \begin_layout Plain Layout
16590 \begin_inset Flex Code
16593 \begin_layout Plain Layout
16601 \begin_inset Flex Code
16604 \begin_layout Plain Layout
16610 ] This tag determines whether the first line indentation of this paragraph can be toggled via the Paragraph settings dialog.
16614 \begin_inset Flex Code
16617 \begin_layout Plain Layout
16628 indentation can be toggled if the document settings use
16629 \begin_inset Quotes eld
16633 \begin_inset Quotes erd
16638 \begin_inset Flex Code
16641 \begin_layout Plain Layout
16648 indentation can always be toggled,
16649 notwithstanding the document settings,
16651 \begin_inset Flex Code
16654 \begin_layout Plain Layout
16661 indentation can never be toggled.
16664 \begin_layout Description
16665 \begin_inset Flex Code
16668 \begin_layout Plain Layout
16675 \begin_inset Flex Code
16678 \begin_layout Plain Layout
16684 ] The vertical space with which the very first of a chain of paragraphs with this style is separated from the previous paragraph.
16685 If the previous paragraph has another style,
16686 the separations are not simply added,
16687 but the maximum is taken.
16690 \begin_layout Subsection
16691 \begin_inset CommandInset label
16697 Internationalization of Paragraph Styles
16700 \begin_layout Standard
16702 has long supported internationalization of layout information,
16705 this applied only to the user interface and not to,
16709 French authors were forced to resort to ugly hacks if they wanted `
16713 1' instead of `Theorem 1'.
16714 Thanks to Georg Baum,
16715 that is no longer the case.
16718 \begin_layout Standard
16720 \begin_inset Flex Code
16723 \begin_layout Plain Layout
16729 defines text that is to appear in the typeset document,
16731 \begin_inset Flex Code
16734 \begin_layout Plain Layout
16741 \begin_inset Flex Code
16744 \begin_layout Plain Layout
16750 to support non-English and even multi-language documents correctly.
16751 The following excerpt (from the
16752 \begin_inset Flex Code
16755 \begin_layout Plain Layout
16761 file) shows how this works:
16764 \begin_layout LyX-Code
16769 \begin_layout LyX-Code
16772 theoremstyle{remark}
16775 \begin_layout LyX-Code
16778 newtheorem{claim}[thm]{
16785 \begin_layout LyX-Code
16789 \begin_layout LyX-Code
16793 \begin_layout LyX-Code
16798 claimname}{_(Claim)}
16801 \begin_layout LyX-Code
16805 \begin_layout LyX-Code
16809 \begin_layout LyX-Code
16818 claimname}{_(Claim)}}
16821 \begin_layout LyX-Code
16826 \begin_layout Standard
16828 any legal \SpecialChar LaTeX
16830 \begin_inset Flex Code
16833 \begin_layout Plain Layout
16840 \begin_inset Flex Code
16843 \begin_layout Plain Layout
16850 but in practice they will typically look as they do here.
16851 The key to correct translation of the typeset text is the definition of the \SpecialChar LaTeX
16853 \begin_inset Flex Code
16856 \begin_layout Plain Layout
16865 \begin_inset Flex Code
16868 \begin_layout Plain Layout
16880 \begin_layout Standard
16882 \begin_inset Flex Code
16885 \begin_layout Plain Layout
16891 tag provides for internationalization based upon the overall language of the document.
16892 The contents of the tag will be included in the preamble,
16894 \begin_inset Flex Code
16897 \begin_layout Plain Layout
16904 What makes it special is the use of the
16905 \begin_inset Quotes eld
16909 \begin_inset Quotes erd
16913 \begin_inset Flex Code
16916 \begin_layout Plain Layout
16923 which will be replaced,
16924 when \SpecialChar LyX
16925 produces \SpecialChar LaTeX
16927 with the translation of its argument into the document language.
16930 \begin_layout Standard
16932 \begin_inset Flex Code
16935 \begin_layout Plain Layout
16941 tag is more complex,
16942 since it is meant to provide support for multi-language documents and so offers an interface to the
16943 \begin_inset Flex Code
16946 \begin_layout Plain Layout
16953 Its contents will be added to the preamble once for each language that appears in the document.
16956 \begin_inset Flex Code
16959 \begin_layout Plain Layout
16965 will be replaced with its translation into the language in question;
16967 \begin_inset Flex Code
16970 \begin_layout Plain Layout
16976 is replaced by the language name (as used by the babel package).
16979 \begin_layout Standard
16980 A German document that also included a French section would thus have the following in the preamble:
16983 \begin_layout LyX-Code
16992 claimname}{Affirmation}}
16993 \begin_inset Newline newline
17004 claimname}{Behauptung}}
17005 \begin_inset Newline newline
17012 claimname}{Behauptung}
17015 \begin_layout Standard
17018 \begin_inset Flex Code
17021 \begin_layout Plain Layout
17027 will then conspire to produce the correct text in the output.
17030 \begin_layout Standard
17031 One important point to note here is that the translations are provided by \SpecialChar LyX
17034 \begin_inset Flex Code
17037 \begin_layout Plain Layout
17047 \begin_inset Flex Code
17050 \begin_layout Plain Layout
17057 \begin_inset Flex Code
17060 \begin_layout Plain Layout
17066 are really only of use in layout files that are provided with \SpecialChar LyX
17068 since text entered in user-created layout files will not be seen by \SpecialChar LyX
17069 's internationalization routines unless the
17070 \begin_inset Flex Code
17073 \begin_layout Plain Layout
17079 file is modified accordingly.
17082 any layout created with the intention that it will be included with \SpecialChar LyX
17083 should use these tags where appropriate.
17084 Please note that the paragraph style translations provided by \SpecialChar LyX
17085 will never change with a minor update (e.
17086 \begin_inset space \thinspace{}
17090 \begin_inset space \space{}
17093 from version 2.1.x to 2.1.y).
17094 It is however quite likely that a major update (e.
17095 \begin_inset space \thinspace{}
17099 \begin_inset space \space{}
17102 from 2.0.x to 2.1.0) will introduce new translations or corrections.
17105 \begin_layout Subsection
17107 \begin_inset CommandInset label
17109 name "subsec:Floats"
17116 \begin_layout Standard
17117 It is necessary to define the floats (
17118 \begin_inset Flex Noun
17121 \begin_layout Plain Layout
17129 \begin_inset Flex Noun
17132 \begin_layout Plain Layout
17140 ) in the text class itself.
17141 Standard floats are included in the file
17142 \begin_inset Flex Code
17145 \begin_layout Plain Layout
17152 so you may have to do no more than add
17155 \begin_layout LyX-Code
17156 Input stdfloats.inc
17159 \begin_layout Standard
17160 to your layout file.
17161 If you want to implement a text class that proposes some other float types (like the AGU class bundled with \SpecialChar LyX
17163 the information below will hopefully help you:
17166 \begin_layout Description
17167 \begin_inset Flex Code
17170 \begin_layout Plain Layout
17177 \begin_inset Flex Code
17180 \begin_layout Plain Layout
17186 =!htbpH] Allowed placement options for this float type.
17187 The value is a string of placement characters.
17188 Possible characters include:
17194 \begin_inset Quotes eld
17198 \begin_inset Quotes erd
17207 \begin_inset Quotes eld
17211 \begin_inset Quotes erd
17220 \begin_inset Quotes eld
17224 \begin_inset Quotes erd
17233 \begin_inset Quotes eld
17237 \begin_inset Quotes erd
17246 \begin_inset Quotes eld
17250 \begin_inset Quotes erd
17259 \begin_inset Quotes eld
17263 \begin_inset Quotes erd
17267 The order of the characters in the string does not matter.
17268 If no placement options are allowed,
17276 \begin_layout Description
17277 \begin_inset Flex Code
17280 \begin_layout Plain Layout
17287 \begin_inset Flex Code
17290 \begin_layout Plain Layout
17299 \begin_inset space \thinspace{}
17305 \begin_inset Flex Code
17308 \begin_layout Plain Layout
17318 ] Defines whether the float allows to be rotated via the \SpecialChar LaTeX
17325 \begin_inset Flex Code
17328 \begin_layout Plain Layout
17334 if the float does not support this feature.
17337 \begin_layout Description
17338 \begin_inset Flex Code
17341 \begin_layout Plain Layout
17348 \begin_inset Flex Code
17351 \begin_layout Plain Layout
17360 \begin_inset space \thinspace{}
17366 \begin_inset Flex Code
17369 \begin_layout Plain Layout
17379 ] Defines whether the float has a starred variant that spans columns in a two column paragraph.
17381 \begin_inset Flex Code
17384 \begin_layout Plain Layout
17390 if the float does not support this feature.
17393 \begin_layout Description
17394 \begin_inset Flex Code
17397 \begin_layout Plain Layout
17404 \begin_inset Flex Code
17407 \begin_layout Plain Layout
17414 \begin_inset Quotes erd
17418 \begin_inset Quotes erd
17421 ] The file name extension of an auxiliary file for the list of figures (or whatever).
17423 writes the captions to this file.
17426 \begin_layout Description
17427 \begin_inset Flex Code
17430 \begin_layout Plain Layout
17437 \begin_inset Flex Code
17440 \begin_layout Plain Layout
17447 \begin_inset Quotes erd
17451 \begin_inset Quotes erd
17454 ] The string that will be used in the menus and also for the caption.
17455 This is translated to the current language if babel is used.
17458 \begin_layout Description
17459 \begin_inset Flex Code
17462 \begin_layout Plain Layout
17468 These tags control the XHTML output.
17470 \begin_inset CommandInset ref
17472 reference "sec:Tags-for-XHTML"
17480 \begin_layout Description
17481 \begin_inset Flex Code
17484 \begin_layout Plain Layout
17493 \begin_inset Flex Code
17496 \begin_layout Plain Layout
17505 \begin_inset space \thinspace{}
17509 \begin_inset Flex Code
17512 \begin_layout Plain Layout
17518 ] Indicates whether the float is already defined in the document class or if instead the \SpecialChar LaTeX
17520 \begin_inset Flex Code
17523 \begin_layout Plain Layout
17529 needs to be loaded to define it on-the-fly.
17531 \begin_inset Flex Code
17534 \begin_layout Plain Layout
17543 \begin_inset Flex Code
17546 \begin_layout Plain Layout
17553 It should be set to
17554 \begin_inset Flex Code
17557 \begin_layout Plain Layout
17563 if the float is already defined by the \SpecialChar LaTeX
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 command used to generate a list of floats of this type;
17604 \begin_inset Flex Code
17607 \begin_layout Plain Layout
17614 since there is no standard way to generate this command.
17616 \begin_inset Flex Code
17619 \begin_layout Plain Layout
17626 since in that case there is a standard way to define the command.
17629 \begin_layout Description
17630 \begin_inset Flex Code
17633 \begin_layout Plain Layout
17640 \begin_inset Flex Code
17643 \begin_layout Plain Layout
17650 \begin_inset Quotes erd
17654 \begin_inset Quotes erd
17657 ] A title for a list of floats of this kind (list of figures,
17660 It is used for the screen label within \SpecialChar LyX
17662 it is used by \SpecialChar LaTeX
17663 for the title and it is used as the title in the XHTML output.
17664 It will be translated to the document language.
17667 \begin_layout Description
17668 \begin_inset Flex Code
17671 \begin_layout Plain Layout
17678 \begin_inset Flex Code
17681 \begin_layout Plain Layout
17688 \begin_inset Quotes erd
17692 \begin_inset Quotes erd
17695 ] This (optional) argument determines whether floats of this class will be numbered within some sectional unit of the document.
17698 \begin_inset Flex Code
17701 \begin_layout Plain Layout
17708 \begin_inset Quotes eld
17712 \begin_inset Flex Code
17715 \begin_layout Plain Layout
17722 \begin_inset Quotes erd
17726 the floats will be numbered within chapters.
17730 \begin_layout Description
17731 \begin_inset Flex Code
17734 \begin_layout Plain Layout
17741 \begin_inset Flex Code
17744 \begin_layout Plain Layout
17751 \begin_inset Quotes erd
17755 \begin_inset Quotes erd
17758 ] The default placement for the given class of floats.
17759 The string should be as in standard \SpecialChar LaTeX
17762 \begin_inset Flex Code
17765 \begin_layout Plain Layout
17773 \begin_inset Flex Code
17776 \begin_layout Plain Layout
17784 \begin_inset Flex Code
17787 \begin_layout Plain Layout
17794 \begin_inset Flex Code
17797 \begin_layout Plain Layout
17811 \begin_layout Plain Layout
17812 Note that the order of these letters in the string is irrelevant,
17813 like in \SpecialChar LaTeX
17819 On top of that there is a new type,
17821 \begin_inset Flex Code
17824 \begin_layout Plain Layout
17831 which does not really correspond to a float,
17834 \begin_inset Quotes eld
17838 \begin_inset Quotes erd
17842 Note however that the
17843 \begin_inset Flex Code
17846 \begin_layout Plain Layout
17852 specifier is special and,
17853 because of implementation details,
17854 cannot be used in non-built in float types.
17855 If you do not understand what this means,
17857 \begin_inset Quotes eld
17861 \begin_inset Flex Code
17864 \begin_layout Plain Layout
17871 \begin_inset Quotes erd
17877 \begin_layout Description
17878 \begin_inset Flex Code
17881 \begin_layout Plain Layout
17888 \begin_inset Flex Code
17891 \begin_layout Plain Layout
17898 \begin_inset Quotes erd
17902 \begin_inset Quotes erd
17905 ] A format for use with formatted references to this counter.
17907 one might want to have references to tables appear as
17908 \begin_inset Quotes eld
17912 \begin_inset Quotes erd
17916 The string may contain
17917 \begin_inset Quotes eld
17921 \begin_inset Quotes erd
17924 or a counter specification.
17925 (See the documentation for
17926 \begin_inset Flex Code
17929 \begin_layout Plain Layout
17936 \begin_inset CommandInset ref
17937 LatexCommand formatted
17938 reference "subsec:Counters"
17946 .) The former will be replaced by the counter number itself.
17954 arabic{section} (which might render as:
17958 \begin_layout Description
17959 \begin_inset Flex Code
17962 \begin_layout Plain Layout
17969 \begin_inset Flex Code
17972 \begin_layout Plain Layout
17978 ] The prefix to use when creating labels referring to floats of this type.
17979 This allows the use of formatted references.
17980 Note that you can remove any
17981 \begin_inset Flex Code
17984 \begin_layout Plain Layout
17990 set by a copied style by using the special value
17991 \begin_inset Quotes eld
17995 \begin_inset Quotes erd
17999 which must be all caps.
18002 \begin_layout Description
18003 \begin_inset Flex Code
18006 \begin_layout Plain Layout
18013 \begin_inset Flex Code
18016 \begin_layout Plain Layout
18022 ] As with paragraph styles,
18024 \begin_inset CommandInset ref
18026 reference "subsec:Paragraph-Styles"
18034 \begin_layout Description
18035 \begin_inset Flex Code
18038 \begin_layout Plain Layout
18045 \begin_inset Flex Code
18048 \begin_layout Plain Layout
18055 \begin_inset Quotes erd
18059 \begin_inset Quotes erd
18062 ] The style used when defining the float using
18063 \begin_inset Flex Code
18066 \begin_layout Plain Layout
18077 \begin_layout Description
18078 \begin_inset Flex Code
18081 \begin_layout Plain Layout
18088 \begin_inset Flex Code
18091 \begin_layout Plain Layout
18098 \begin_inset Quotes erd
18102 \begin_inset Quotes erd
18106 \begin_inset Quotes eld
18110 \begin_inset Quotes erd
18113 of the new class of floats,
18114 like program or algorithm.
18115 After the appropriate
18116 \begin_inset Flex Code
18119 \begin_layout Plain Layout
18129 \begin_inset Flex Code
18132 \begin_layout Plain Layout
18141 \begin_inset Flex Code
18144 \begin_layout Plain Layout
18155 \begin_layout Description
18156 \begin_inset Flex Code
18159 \begin_layout Plain Layout
18166 \begin_inset Flex Code
18169 \begin_layout Plain Layout
18176 \begin_inset space \thinspace{}
18180 \begin_inset Flex Code
18183 \begin_layout Plain Layout
18191 ] Specifies whether this float is defined using the \SpecialChar LaTeX
18193 \begin_inset Flex Code
18196 \begin_layout Plain Layout
18203 either by the class file,
18204 another package or on-the-fly by \SpecialChar LyX
18208 \begin_layout Standard
18209 Note that defining a float with type
18210 \begin_inset Flex Code
18213 \begin_layout Plain Layout
18221 automatically defines the corresponding counter with name
18222 \begin_inset Flex Code
18225 \begin_layout Plain Layout
18236 \begin_layout Subsection
18237 Flex insets and InsetLayout
18238 \begin_inset CommandInset label
18240 name "subsec:Flex-insets-and"
18247 \begin_layout Standard
18248 Flex insets come in two different kinds:
18252 \begin_layout Itemize
18254 \begin_inset Flex Code
18257 \begin_layout Plain Layout
18264 These define semantic markup corresponding to such \SpecialChar LaTeX
18266 \begin_inset Flex Code
18269 \begin_layout Plain Layout
18278 \begin_inset Flex Code
18281 \begin_layout Plain Layout
18292 \begin_layout Itemize
18294 \begin_inset Flex Code
18297 \begin_layout Plain Layout
18304 These can be used to define custom collapsible insets,
18305 similar to \SpecialChar TeX
18309 An obvious example is an endnote inset,
18310 which is defined in the
18311 \begin_inset Flex Code
18314 \begin_layout Plain Layout
18323 \begin_layout Standard
18324 Flex insets are defined using the
18325 \begin_inset Flex Code
18328 \begin_layout Plain Layout
18335 which shall be explained in a moment.
18338 \begin_layout Standard
18340 \begin_inset Flex Code
18343 \begin_layout Plain Layout
18349 tag also serves another function:
18350 It can be used to customize the general layout of many different types of insets.
18353 \begin_inset Flex Code
18356 \begin_layout Plain Layout
18362 can be used to customize the layout parameters for footnotes,
18375 as well as to define Flex insets.
18378 \begin_layout Standard
18380 \begin_inset Flex Code
18383 \begin_layout Plain Layout
18389 definition must begin with a line of the form:
18392 \begin_layout LyX-Code
18396 \begin_layout Standard
18398 \begin_inset Flex Code
18401 \begin_layout Plain Layout
18407 indicates the inset whose layout is being defined,
18408 and here there are four cases.
18411 \begin_layout Enumerate
18412 The layout for a pre-existing inset is being modified.
18415 \begin_inset Flex Code
18418 \begin_layout Plain Layout
18424 any one of the following:
18426 \begin_inset Flex Code
18429 \begin_layout Plain Layout
18437 \begin_inset Flex Code
18440 \begin_layout Plain Layout
18448 \begin_inset Flex Code
18451 \begin_layout Plain Layout
18459 \begin_inset Flex Code
18462 \begin_layout Plain Layout
18470 \begin_inset Flex Code
18473 \begin_layout Plain Layout
18481 \begin_inset Flex Code
18484 \begin_layout Plain Layout
18492 \begin_inset Flex Code
18495 \begin_layout Plain Layout
18503 \begin_inset Flex Code
18506 \begin_layout Plain Layout
18514 \begin_inset Flex Code
18517 \begin_layout Plain Layout
18525 \begin_inset Flex Code
18528 \begin_layout Plain Layout
18536 \begin_inset Flex Code
18539 \begin_layout Plain Layout
18547 \begin_inset Flex Code
18550 \begin_layout Plain Layout
18558 \begin_inset Flex Code
18561 \begin_layout Plain Layout
18569 \begin_inset Flex Code
18572 \begin_layout Plain Layout
18580 \begin_inset Flex Code
18583 \begin_layout Plain Layout
18591 \begin_inset Flex Code
18594 \begin_layout Plain Layout
18602 \begin_inset Flex Code
18605 \begin_layout Plain Layout
18613 \begin_inset Flex Code
18616 \begin_layout Plain Layout
18624 \begin_inset Flex Code
18627 \begin_layout Plain Layout
18635 \begin_inset Flex Code
18638 \begin_layout Plain Layout
18647 \begin_layout Enumerate
18648 The layout for a Flex inset is being defined.
18651 \begin_inset Flex Code
18654 \begin_layout Plain Layout
18660 must be of the form
18661 \begin_inset Quotes eld
18665 \begin_inset Flex Code
18668 \begin_layout Plain Layout
18675 \begin_inset Quotes erd
18680 \begin_inset Flex Code
18683 \begin_layout Plain Layout
18689 may be any valid identifier not used by a pre-existing Flex inset.
18690 The identifier may include spaces,
18691 but in that case the whole thing must be wrapped in quotes.
18692 Note that the definition of a flex inset
18697 \begin_inset Flex Code
18700 \begin_layout Plain Layout
18707 declaring which type of inset it defines.
18710 \begin_layout Enumerate
18711 The layout for user specific branch is being defined.
18714 \begin_inset Flex Code
18717 \begin_layout Plain Layout
18723 must be of the form
18724 \begin_inset Quotes eld
18728 \begin_inset Flex Code
18731 \begin_layout Plain Layout
18738 \begin_inset Quotes erd
18743 \begin_inset Flex Code
18746 \begin_layout Plain Layout
18752 may be any valid identifier of branch defined in user's document.
18753 The identifier may include spaces,
18754 but in that case the whole thing must be wrapped in quotes.
18755 The main purpose of this feature is to allow \SpecialChar LaTeX
18756 wrapping around specific branches as user needs.
18759 \begin_layout Enumerate
18760 The layout of a user (or class) specific caption is being defined.
18763 \begin_inset Flex Code
18766 \begin_layout Plain Layout
18772 must be of the form
18773 \begin_inset Quotes eld
18777 \begin_inset Flex Code
18780 \begin_layout Plain Layout
18787 \begin_inset Quotes erd
18792 \begin_inset Flex Code
18795 \begin_layout Plain Layout
18801 specifies the name of the caption as it appears in the menu.
18802 Have a look at the standard caption (
18803 \begin_inset Flex Code
18806 \begin_layout Plain Layout
18813 the specific captions of the KOMA-Script classes (
18814 \begin_inset Flex Code
18817 \begin_layout Plain Layout
18825 \begin_inset Flex Code
18828 \begin_layout Plain Layout
18837 \begin_inset space ~
18841 \begin_inset Newline linebreak
18847 \begin_inset Flex Code
18850 \begin_layout Plain Layout
18856 ) for applications.
18859 \begin_layout Standard
18861 \begin_inset Flex Code
18864 \begin_layout Plain Layout
18870 definition can contain the following entries:
18873 \begin_layout Description
18874 \begin_inset Flex Code
18877 \begin_layout Plain Layout
18884 \begin_inset Flex Code
18887 \begin_layout Plain Layout
18893 =""] This inset will appear in the table of contents of the given type.
18894 An empty string disables.
18895 See also the OutlinerName and the IsTocCaption commands.
18896 This is only implemented for Flex insets.
18901 \begin_layout Description
18902 \begin_inset Flex Code
18905 \begin_layout Plain Layout
18911 Includes a comma-separated list of insets to which this inset can be inserted.
18913 \begin_inset Quotes eld
18917 \begin_inset Flex Code
18920 \begin_layout Plain Layout
18927 \begin_inset Quotes erd
18931 If you you also want the insertion to be allowed in specific arguments of the target insets,
18932 append the argument name after @ (e.
18933 \begin_inset space \thinspace{}
18938 \begin_inset Flex Code
18941 \begin_layout Plain Layout
18948 Note that this currently only supports immediately containing insets (no deeper nesting).
18950 \begin_inset Flex Code
18953 \begin_layout Plain Layout
18962 \begin_layout Description
18963 \begin_inset Flex Code
18966 \begin_layout Plain Layout
18972 Includes a comma-separated list of layouts within which this inset can be inserted.
18974 \begin_inset Quotes eld
18978 \begin_inset Flex Code
18981 \begin_layout Plain Layout
18982 EndAllowedInLayouts
18988 \begin_inset Quotes erd
18992 Note that this currently only supports immediately containing layouts (no deeper nesting).
18994 \begin_inset Flex Code
18997 \begin_layout Plain Layout
19006 \begin_layout Description
19007 \begin_inset Flex Code
19010 \begin_layout Plain Layout
19017 \begin_inset Flex Code
19020 \begin_layout Plain Layout
19027 \begin_inset Flex Code
19030 \begin_layout Plain Layout
19037 \begin_inset Flex Code
19040 \begin_layout Plain Layout
19047 this can be used to determine how many times the inset can be inserted to a given inset or the paragraph (group).
19050 \begin_layout Description
19051 \begin_inset Flex Code
19054 \begin_layout Plain Layout
19055 AllowedOccurrencesPerItem
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 ] If this is set to true,
19088 \begin_inset Flex Code
19091 \begin_layout Plain Layout
19097 applies to single paragraphs if we are in a list-type environment (with
19098 \begin_inset Flex Code
19101 \begin_layout Plain Layout
19112 \begin_layout Description
19113 \begin_inset Flex Code
19116 \begin_layout Plain Layout
19123 \begin_inset Flex Code
19126 \begin_layout Plain Layout
19132 ] Defines argument number of a command\SpecialChar breakableslash
19133 environment associated with the current layout.
19134 The definition must end with
19135 \begin_inset Flex Code
19138 \begin_layout Plain Layout
19146 \begin_inset CommandInset ref
19148 reference "subsec:Arguments"
19156 for more information.
19159 \begin_layout Description
19160 \begin_inset Flex Code
19163 \begin_layout Plain Layout
19169 Preamble for changing language commands;
19171 \begin_inset CommandInset ref
19173 reference "subsec:I18n"
19181 \begin_layout Description
19182 \begin_inset Flex Code
19185 \begin_layout Plain Layout
19192 \begin_inset Flex Code
19195 \begin_layout Plain Layout
19201 ] The color for the inset's background.
19203 \begin_inset CommandInset ref
19205 reference "chap:Names-of-colors"
19210 for a list of the available color names.
19213 \begin_layout Description
19214 \begin_inset Flex Code
19217 \begin_layout Plain Layout
19224 \begin_inset Flex Code
19227 \begin_layout Plain Layout
19236 \begin_inset space \thinspace{}
19240 \begin_inset Flex Code
19243 \begin_layout Plain Layout
19249 ] Whether to use the content of the inset as the label,
19250 when the inset is closed.
19254 \begin_layout Description
19255 \begin_inset Flex Code
19258 \begin_layout Plain Layout
19265 \begin_inset Flex Code
19268 \begin_layout Plain Layout
19274 ] As with paragraph styles,
19276 \begin_inset CommandInset ref
19278 reference "subsec:Paragraph-Styles"
19284 Note that you need to specify the complete type,
19286 \begin_inset space \thinspace{}
19290 \begin_inset space ~
19294 \begin_inset Flex Code
19297 \begin_layout Plain Layout
19298 CopyStyle Flex:<name>
19306 \begin_layout Description
19307 \begin_inset Flex Code
19310 \begin_layout Plain Layout
19317 \begin_inset Flex Code
19320 \begin_layout Plain Layout
19329 \begin_inset space \thinspace{}
19333 \begin_inset Flex Code
19336 \begin_layout Plain Layout
19342 ] Indicates whether the user may employ the Paragraph Settings dialog to customize the paragraph.
19345 \begin_layout Description
19346 \begin_inset Flex Code
19349 \begin_layout Plain Layout
19356 \begin_inset Flex Code
19359 \begin_layout Plain Layout
19367 \begin_inset Flex Code
19370 \begin_layout Plain Layout
19378 \begin_inset Flex Code
19381 \begin_layout Plain Layout
19388 describing the rendering style used for the inset's frame and buttons.
19389 Footnotes generally use
19390 \begin_inset Flex Code
19393 \begin_layout Plain Layout
19400 ERT insets generally
19401 \begin_inset Flex Code
19404 \begin_layout Plain Layout
19411 and character styles
19412 \begin_inset Flex Code
19415 \begin_layout Plain Layout
19424 \begin_layout Description
19425 \begin_inset Flex Code
19428 \begin_layout Plain Layout
19435 \begin_inset Flex Code
19438 \begin_layout Plain Layout
19447 \begin_inset space \thinspace{}
19453 \begin_inset Flex Code
19456 \begin_layout Plain Layout
19465 \begin_inset Flex Code
19468 \begin_layout Plain Layout
19475 \begin_inset Flex Code
19478 \begin_layout Plain Layout
19485 Indicates whether the environment will stand on its own in the output or will appear inline with the surrounding text.
19487 it is supposed that the \SpecialChar LaTeX
19488 environment ignores white space (including one newline character) after the
19489 \begin_inset Flex Code
19492 \begin_layout Plain Layout
19505 \begin_inset Flex Code
19508 \begin_layout Plain Layout
19524 \begin_layout Description
19525 \begin_inset Flex Code
19528 \begin_layout Plain Layout
19538 ,1] Allow the contents of the inset to be edited externally (using whatever editor is defined for the document's output format).
19541 \begin_layout Description
19542 \begin_inset Flex Code
19545 \begin_layout Plain Layout
19551 Required at the end of the
19552 \begin_inset Flex Code
19555 \begin_layout Plain Layout
19564 \begin_layout Description
19565 \begin_inset Flex Code
19568 \begin_layout Plain Layout
19574 The font used for both the text body
19580 \begin_inset CommandInset ref
19581 LatexCommand formatted
19582 reference "subsec:Font-description"
19588 Note that defining this font automatically defines the
19589 \begin_inset Flex Code
19592 \begin_layout Plain Layout
19599 so define this first and define
19600 \begin_inset Flex Code
19603 \begin_layout Plain Layout
19609 later if you want them to be different.
19612 \begin_layout Description
19613 \begin_inset Flex Code
19616 \begin_layout Plain Layout
19617 FixedWidthPreambleEncoding
19623 \begin_inset Flex Code
19626 \begin_layout Plain Layout
19635 \begin_inset space \thinspace{}
19639 \begin_inset Flex Code
19642 \begin_layout Plain Layout
19648 ] Force a fixed width encoding for the translated contents of
19649 \begin_inset Flex Code
19652 \begin_layout Plain Layout
19659 \begin_inset Flex Code
19662 \begin_layout Plain Layout
19668 code generated by this layout.
19669 This is needed for special \SpecialChar LaTeX
19674 that do not work with variable width encodings such as
19679 This setting is ignored if fully Unicode aware \SpecialChar LaTeX
19680 backends such as Xe\SpecialChar TeX
19681 or Lua\SpecialChar TeX
19685 \begin_layout Description
19686 \begin_inset Flex Code
19689 \begin_layout Plain Layout
19690 ForceLocalFontSwitch
19696 \begin_inset Flex Code
19699 \begin_layout Plain Layout
19708 \begin_inset space \thinspace{}
19712 \begin_inset Flex Code
19715 \begin_layout Plain Layout
19721 ] When using babel,
19722 always use a local font switch (
19723 \begin_inset Flex Code
19726 \begin_layout Plain Layout
19735 never a global one (such as
19736 \begin_inset Flex Code
19739 \begin_layout Plain Layout
19750 \begin_layout Description
19751 \begin_inset Flex Code
19754 \begin_layout Plain Layout
19761 \begin_inset Flex Code
19764 \begin_layout Plain Layout
19773 \begin_inset space \thinspace{}
19777 \begin_inset Flex Code
19780 \begin_layout Plain Layout
19787 \begin_inset Quotes eld
19791 \begin_inset Quotes erd
19795 leading to Left-to-Right (Latin) output,
19797 \begin_inset space \thinspace{}
19801 \begin_inset space \space{}
19804 in \SpecialChar TeX
19809 \begin_layout Description
19810 \begin_inset Flex Code
19813 \begin_layout Plain Layout
19820 \begin_inset Flex Code
19823 \begin_layout Plain Layout
19832 \begin_inset space \thinspace{}
19836 \begin_inset Flex Code
19839 \begin_layout Plain Layout
19845 ] Force a line break in the \SpecialChar LaTeX
19846 output before the inset starts and after the inset ends.
19847 This assures the inset itself is output on its own lines,
19848 for parsing purposes.
19851 \begin_layout Description
19852 \begin_inset Flex Code
19855 \begin_layout Plain Layout
19862 \begin_inset Flex Code
19865 \begin_layout Plain Layout
19874 \begin_inset space \thinspace{}
19878 \begin_inset Flex Code
19881 \begin_layout Plain Layout
19887 ] Indicates whether the
19888 \begin_inset Flex Code
19891 \begin_layout Plain Layout
19899 the user can change the paragraph style used in the inset.
19903 \begin_layout Description
19904 \begin_inset Flex Code
19907 \begin_layout Plain Layout
19914 \begin_inset Flex Code
19917 \begin_layout Plain Layout
19926 \begin_inset space \thinspace{}
19930 \begin_inset Flex Code
19933 \begin_layout Plain Layout
19939 ] As with paragraph styles,
19941 \begin_inset CommandInset ref
19943 reference "subsec:Paragraph-Styles"
19951 \begin_layout Description
19952 \begin_inset Flex Code
19955 \begin_layout Plain Layout
19961 These tags control the XHTML output.
19963 \begin_inset CommandInset ref
19965 reference "sec:Tags-for-XHTML"
19973 \begin_layout Description
19974 \begin_inset Flex Code
19977 \begin_layout Plain Layout
19984 \begin_inset Flex Code
19987 \begin_layout Plain Layout
19994 \begin_inset space \thinspace{}
19998 \begin_inset Flex Code
20001 \begin_layout Plain Layout
20009 ] The font inside the inset is inherited from the parent for \SpecialChar LaTeX
20010 export if this parameter is 1,
20011 as well as on screen.
20012 Otherwise the document default font is used.
20015 \begin_layout Description
20016 \begin_inset Flex Code
20019 \begin_layout Plain Layout
20026 \begin_inset Flex Code
20029 \begin_layout Plain Layout
20038 \begin_inset space \thinspace{}
20042 \begin_inset Flex Code
20045 \begin_layout Plain Layout
20051 ] Whether to include the contents of this inset in the strings generated for the `Outline' pane for all table of contents,
20052 regardless of the AddToToc setting.
20055 want the content of a footnote in a section header to be included in the TOC displayed in the outline,
20056 but one would normally want the content of a character style displayed.
20061 \begin_layout Description
20062 \begin_inset Flex Code
20065 \begin_layout Plain Layout
20072 \begin_inset Flex Code
20075 \begin_layout Plain Layout
20084 \begin_inset space \thinspace{}
20088 \begin_inset Flex Code
20091 \begin_layout Plain Layout
20097 ] If this is set to 1 and AddToToc is enabled,
20098 the inset adds a summary of its contents in its item in the table of contents.
20100 only the label appears.
20103 \begin_layout Description
20104 \begin_inset Flex Code
20107 \begin_layout Plain Layout
20116 \begin_inset Flex Code
20119 \begin_layout Plain Layout
20128 \begin_inset space \thinspace{}
20132 \begin_inset Flex Code
20135 \begin_layout Plain Layout
20141 ] As with paragraph styles,
20143 \begin_inset CommandInset ref
20145 reference "subsec:Paragraph-Styles"
20153 \begin_layout Description
20154 \begin_inset Flex Code
20157 \begin_layout Plain Layout
20163 The font used for the label.
20165 \begin_inset CommandInset ref
20167 reference "subsec:Font-description"
20173 Note that this definition can never appear before
20174 \begin_inset Flex Code
20177 \begin_layout Plain Layout
20184 lest it be ineffective.
20187 \begin_layout Description
20188 \begin_inset Flex Code
20191 \begin_layout Plain Layout
20198 \begin_inset Flex Code
20201 \begin_layout Plain Layout
20208 \begin_inset Quotes erd
20212 \begin_inset Quotes erd
20215 ] What will be displayed on the button or elsewhere as the inset label.
20217 \begin_inset Flex Code
20220 \begin_layout Plain Layout
20228 \begin_inset Flex Code
20231 \begin_layout Plain Layout
20237 ) modify this label on the fly.
20240 \begin_layout Description
20241 \begin_inset Flex Code
20244 \begin_layout Plain Layout
20250 Language dependent preamble;
20252 \begin_inset CommandInset ref
20254 reference "subsec:I18n"
20262 \begin_layout Description
20263 \begin_inset Flex Code
20266 \begin_layout Plain Layout
20273 \begin_inset Flex Code
20276 \begin_layout Plain Layout
20282 ] The name of the corresponding \SpecialChar LaTeX
20284 Either the environment or command name.
20287 \begin_layout Description
20288 \begin_inset Flex Code
20291 \begin_layout Plain Layout
20298 \begin_inset Flex Code
20301 \begin_layout Plain Layout
20307 ] The optional parameter for the corresponding
20308 \begin_inset Flex Code
20311 \begin_layout Plain Layout
20318 including possible bracket pairs like
20319 \begin_inset Flex Code
20322 \begin_layout Plain Layout
20329 This parameter cannot be changed from within \SpecialChar LyX
20331 \begin_inset Flex Code
20334 \begin_layout Plain Layout
20340 for customizable parameters).
20341 It will be output as is after all \SpecialChar LaTeX
20343 \begin_inset Flex Code
20346 \begin_layout Plain Layout
20355 \begin_layout Description
20356 \begin_inset Flex Code
20359 \begin_layout Plain Layout
20366 \begin_inset Flex Code
20369 \begin_layout Plain Layout
20377 ] How the style should be translated into \SpecialChar LaTeX
20382 \begin_layout Plain Layout
20383 \begin_inset Flex Code
20386 \begin_layout Plain Layout
20392 is perhaps a bit misleading,
20393 since these rules apply to SGML classes too.
20394 Visit the SGML class files for specific examples.
20403 \begin_layout Description
20404 \begin_inset Flex Code
20407 \begin_layout Plain Layout
20413 means nothing special
20416 \begin_layout Description
20417 \begin_inset Flex Code
20420 \begin_layout Plain Layout
20427 \begin_inset Flex Code
20430 \begin_layout Plain Layout
20437 {\SpecialChar ldots
20446 \begin_layout Description
20447 \begin_inset Flex Code
20450 \begin_layout Plain Layout
20457 \begin_inset Flex Code
20460 \begin_layout Plain Layout
20467 }\SpecialChar ldots
20482 \begin_layout Standard
20483 Putting the last few things together,
20484 the \SpecialChar LaTeX
20485 output will be either:
20489 \begin_layout LyX-Code
20492 LatexName[LatexParam]{\SpecialChar ldots
20496 \begin_layout Standard
20501 \begin_layout LyX-Code
20504 begin{LatexName}[LatexParam] \SpecialChar ldots
20510 \begin_layout Standard
20511 depending upon the \SpecialChar LaTeX
20516 \begin_layout Description
20517 \begin_inset Flex Code
20520 \begin_layout Plain Layout
20527 \begin_inset Flex Code
20530 \begin_layout Plain Layout
20536 ] A string that is put at the beginning of the layout content.
20537 A line break in the output can be indicated by
20538 \begin_inset Flex Code
20541 \begin_layout Plain Layout
20550 \begin_layout Description
20551 \begin_inset Flex Code
20554 \begin_layout Plain Layout
20561 \begin_inset Flex Code
20564 \begin_layout Plain Layout
20572 \begin_inset Flex Code
20575 \begin_layout Plain Layout
20583 \begin_inset Flex Code
20586 \begin_layout Plain Layout
20592 (indicating a dummy definition ending definitions of charstyles,
20594 This entry is required in and is only meaningful for Flex insets.
20595 Among other things,
20596 it determines on which menu this inset will appear.
20598 \begin_inset Flex Code
20601 \begin_layout Plain Layout
20608 \begin_inset Flex Code
20611 \begin_layout Plain Layout
20617 will automatically set
20618 \begin_inset Flex Code
20621 \begin_layout Plain Layout
20628 \begin_inset Flex Code
20631 \begin_layout Plain Layout
20639 \begin_inset Flex Code
20642 \begin_layout Plain Layout
20648 can be set to true,
20650 \begin_inset Flex Code
20653 \begin_layout Plain Layout
20661 \begin_inset Flex Code
20664 \begin_layout Plain Layout
20670 insets by setting it
20675 \begin_inset Flex Code
20678 \begin_layout Plain Layout
20687 \begin_layout Description
20688 \begin_inset Flex Code
20691 \begin_layout Plain Layout
20698 \begin_inset Flex Code
20701 \begin_layout Plain Layout
20707 A dedicated string for the menu.
20708 You can define an accelerator by appending the respective character to the string,
20710 \begin_inset Quotes eld
20714 \begin_inset Quotes erd
20718 \begin_inset space \thinspace{}
20722 \begin_inset space \space{}
20726 \begin_inset Quotes eld
20730 \begin_inset Flex Code
20733 \begin_layout Plain Layout
20740 \begin_inset Quotes erd
20744 This specification is optional.
20745 If it is not given the inset name as specified in the type declaration will be used instead for the menu.
20748 \begin_layout Description
20749 \begin_inset Flex Code
20752 \begin_layout Plain Layout
20759 \begin_inset Flex Code
20762 \begin_layout Plain Layout
20771 \begin_inset space \thinspace{}
20775 \begin_inset Flex Code
20778 \begin_layout Plain Layout
20784 ] Whether multiple paragraphs are permitted in this inset.
20786 \begin_inset Flex Code
20789 \begin_layout Plain Layout
20795 to the same value and
20796 \begin_inset Flex Code
20799 \begin_layout Plain Layout
20805 to the opposite value.
20806 These can be reset to other values,
20812 \begin_inset Flex Code
20815 \begin_layout Plain Layout
20825 \begin_layout Description
20826 \begin_inset Flex Code
20829 \begin_layout Plain Layout
20836 \begin_inset Flex Code
20839 \begin_layout Plain Layout
20848 \begin_inset space \thinspace{}
20852 \begin_inset Flex Code
20855 \begin_layout Plain Layout
20861 ] Whether fragile commands in this inset should be
20862 \begin_inset Flex Code
20865 \begin_layout Plain Layout
20879 whether the command should itself be protected.) Default is false.
20882 \begin_layout Description
20883 \begin_inset Flex Code
20886 \begin_layout Plain Layout
20893 \begin_inset Flex Code
20896 \begin_layout Plain Layout
20905 \begin_inset space \thinspace{}
20909 \begin_inset Flex Code
20912 \begin_layout Plain Layout
20918 ] This causes macros that contain this inset to be protected with
20919 \begin_inset Flex Code
20922 \begin_layout Plain Layout
20935 ) if necessary and thus allows (some) verbatim stuff in macros.
20939 \begin_layout Description
20940 \begin_inset Flex Code
20943 \begin_layout Plain Layout
20950 \begin_inset Flex Code
20953 \begin_layout Plain Layout
20962 \begin_inset space \thinspace{}
20966 \begin_inset Flex Code
20969 \begin_layout Plain Layout
20975 ] Whether specific commands in this inset (such as
20976 \begin_inset Flex Code
20979 \begin_layout Plain Layout
20988 \begin_inset Flex Code
20991 \begin_layout Plain Layout
20999 ) should be protected in an
21000 \begin_inset Flex Code
21003 \begin_layout Plain Layout
21012 This is particularly needed for insets that draw on
21020 commands which parse their content in complex ways.
21024 \begin_layout Description
21025 \begin_inset Flex Code
21028 \begin_layout Plain Layout
21035 \begin_inset Flex Code
21038 \begin_layout Plain Layout
21044 Option to define a different command (from the default
21045 \begin_inset Flex Code
21048 \begin_layout Plain Layout
21058 ) to be used for line breaks.
21059 The initial backslash must not be specified.
21062 \begin_layout Description
21063 \begin_inset Flex Code
21066 \begin_layout Plain Layout
21073 \begin_inset Flex Code
21076 \begin_layout Plain Layout
21082 ] Deletes an existing
21083 \begin_inset Flex Code
21086 \begin_layout Plain Layout
21093 \change_inserted -712698321 1715512954
21097 \begin_layout Description
21099 \change_inserted -712698321 1715512954
21100 \begin_inset Flex Code
21103 \begin_layout Plain Layout
21105 \change_inserted -712698321 1715512954
21112 \begin_inset Flex Code
21115 \begin_layout Plain Layout
21117 \change_inserted -712698321 1715512954
21127 Defines individual characters that should
21131 be output in raw form (without special translations that \SpecialChar LaTeX
21133 even if such handling is requested by an element in this layout.
21134 This tag can be used to overwrite
21135 \begin_inset Quotes els
21139 \begin_inset Quotes ers
21142 conditions if they are unsuitable in a given context.
21147 \begin_layout Description
21148 \begin_inset Flex Code
21151 \begin_layout Plain Layout
21158 \begin_inset Flex Code
21161 \begin_layout Plain Layout
21168 \begin_inset Flex Code
21171 \begin_layout Plain Layout
21177 that has replaced this
21178 \begin_inset Flex Code
21181 \begin_layout Plain Layout
21188 This is used to rename an
21189 \begin_inset Flex Code
21192 \begin_layout Plain Layout
21199 while keeping backward compatibility.
21202 \begin_layout Description
21203 \begin_inset Flex Code
21206 \begin_layout Plain Layout
21213 \begin_inset Flex Code
21216 \begin_layout Plain Layout
21225 \begin_inset space \thinspace{}
21229 \begin_inset Flex Code
21232 \begin_layout Plain Layout
21238 ] If this is set to
21239 \begin_inset Flex Code
21242 \begin_layout Plain Layout
21249 paragraph breaks will be ignored in the output.
21250 This might be useful for insets where the content should be alignable on different lines only in the \SpecialChar LyX
21252 without any effect in the output.
21255 \begin_layout Description
21256 \begin_inset Flex Code
21259 \begin_layout Plain Layout
21266 \begin_inset Flex Code
21269 \begin_layout Plain Layout
21278 \begin_inset space \thinspace{}
21282 \begin_inset Flex Code
21285 \begin_layout Plain Layout
21291 ] As with paragraph styles,
21293 \begin_inset CommandInset ref
21295 reference "subsec:Paragraph-Styles"
21304 \begin_layout Description
21305 \begin_inset Flex Code
21308 \begin_layout Plain Layout
21315 \begin_inset Flex Code
21318 \begin_layout Plain Layout
21327 \begin_inset space \thinspace{}
21331 \begin_inset Flex Code
21334 \begin_layout Plain Layout
21340 ] As with paragraph styles,
21342 \begin_inset CommandInset ref
21344 reference "subsec:Paragraph-Styles"
21353 \begin_layout Description
21354 \begin_inset Flex Code
21357 \begin_layout Plain Layout
21363 As with paragraph styles,
21365 \begin_inset CommandInset ref
21367 reference "subsec:Paragraph-Styles"
21375 \begin_layout Description
21376 \begin_inset Flex Code
21379 \begin_layout Plain Layout
21386 \begin_inset Flex Code
21389 \begin_layout Plain Layout
21395 ] The prefix to use when creating labels referring to insets of this type.
21396 This allows the use of formatted references.
21399 \begin_layout Description
21400 \begin_inset Flex Code
21403 \begin_layout Plain Layout
21410 \begin_inset Flex Code
21413 \begin_layout Plain Layout
21419 ] As with paragraph styles,
21421 \begin_inset CommandInset ref
21423 reference "subsec:Paragraph-Styles"
21431 \begin_layout Description
21432 \begin_inset Flex Code
21435 \begin_layout Plain Layout
21442 \begin_inset Flex Code
21445 \begin_layout Plain Layout
21454 \begin_inset space \thinspace{}
21458 \begin_inset Flex Code
21461 \begin_layout Plain Layout
21467 ] Resets the \SpecialChar LaTeX
21468 arguments of this layout (as defined via the
21469 \begin_inset Flex Code
21472 \begin_layout Plain Layout
21479 This is useful if you have copied a style via
21480 \begin_inset Flex Code
21483 \begin_layout Plain Layout
21490 but you do not want to inherit its (required and optional) arguments.
21493 \begin_layout Description
21494 \begin_inset Flex Code
21497 \begin_layout Plain Layout
21504 \begin_inset Flex Code
21507 \begin_layout Plain Layout
21516 \begin_inset space \thinspace{}
21520 \begin_inset Flex Code
21523 \begin_layout Plain Layout
21530 \begin_inset Flex Code
21533 \begin_layout Plain Layout
21540 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.
21541 \begin_inset space \thinspace{}
21546 \begin_inset Flex Code
21549 \begin_layout Plain Layout
21552 textbf{Sourrounding text
21556 textbf{content}}\SpecialChar ldots
21563 \begin_inset Flex Code
21566 \begin_layout Plain Layout
21569 textbf{Sourrounding text
21571 myinset{content}\SpecialChar ldots
21578 Setting this makes sense for commands that internally reset font settings (e.
21579 \begin_inset space \thinspace{}
21584 Note that wrongly setting this might lead to unwanted result (e.
21585 \begin_inset space \thinspace{}
21590 \begin_inset Flex Code
21593 \begin_layout Plain Layout
21596 emph{Sourrounding text
21600 emph{content}}\SpecialChar ldots
21607 content is upright,
21609 \begin_inset Flex Code
21612 \begin_layout Plain Layout
21622 \begin_inset Flex Code
21625 \begin_layout Plain Layout
21632 font changes are not redone inside the inset.
21635 \begin_layout Description
21636 \begin_inset Flex Code
21639 \begin_layout Plain Layout
21646 \begin_inset Flex Code
21649 \begin_layout Plain Layout
21655 ] A string that is put at the end of the layout content.
21656 A line break in the output can be indicated by
21657 \begin_inset Flex Code
21660 \begin_layout Plain Layout
21669 \begin_layout Description
21670 \begin_inset Flex Code
21673 \begin_layout Plain Layout
21680 \begin_inset Flex Code
21683 \begin_layout Plain Layout
21690 \begin_inset space \thinspace{}
21694 \begin_inset Flex Code
21697 \begin_layout Plain Layout
21705 ] Allow spell-checking the contents of this inset.
21709 \begin_layout Subsection
21711 \begin_inset CommandInset label
21713 name "subsec:Arguments"
21720 \begin_layout Standard
21721 Both paragraph styles and inset layouts allow for
21725 as well as the main content.
21726 This is especially useful for things like section headings and only makes sense with \SpecialChar LaTeX
21728 Each (optional or required) argument of a command or environment—
21729 except for the required argument that is associated with the content—
21730 has a separate definition,
21731 where the number specifies the order of the arguments.
21732 The definition must end with
21733 \begin_inset Flex Code
21736 \begin_layout Plain Layout
21743 So a command with two optional arguments looks like:
21746 \begin_layout Quote
21752 \begin_layout Quote
21758 \begin_layout Quote
21764 \begin_layout Quote
21770 \begin_layout Quote
21776 \begin_layout Quote
21782 \begin_layout Standard
21784 \begin_inset Flex Code
21787 \begin_layout Plain Layout
21794 the following specifications are possible:
21797 \begin_layout Itemize
21798 \begin_inset Flex Code
21801 \begin_layout Plain Layout
21808 \begin_inset Flex Code
21811 \begin_layout Plain Layout
21817 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
21818 \begin_inset Flex Code
21821 \begin_layout Plain Layout
21829 you can define an accelerator by appending the respective character to the string,
21831 \begin_inset Quotes eld
21835 \begin_inset Quotes erd
21839 \begin_inset space \thinspace{}
21843 \begin_inset space \space{}
21847 \begin_inset Quotes eld
21851 \begin_inset Flex Code
21854 \begin_layout Plain Layout
21861 \begin_inset Quotes erd
21867 \begin_layout Itemize
21868 \begin_inset Flex Code
21871 \begin_layout Plain Layout
21878 \begin_inset Flex Code
21881 \begin_layout Plain Layout
21887 A separate string for the menu.
21888 You can define an accelerator by appending the respective character to the string,
21890 \begin_inset Quotes eld
21894 \begin_inset Quotes erd
21898 \begin_inset space \thinspace{}
21902 \begin_inset space \space{}
21906 \begin_inset Quotes eld
21910 \begin_inset Flex Code
21913 \begin_layout Plain Layout
21920 \begin_inset Quotes erd
21924 This specification is optional.
21925 If it is not given the
21926 \begin_inset Flex Code
21929 \begin_layout Plain Layout
21935 will be used instead for the menu.
21938 \begin_layout Itemize
21939 \begin_inset Flex Code
21942 \begin_layout Plain Layout
21949 \begin_inset Flex Code
21952 \begin_layout Plain Layout
21958 A longer explanatory text that appears in the tooltip when hovering over the argument inset.
21961 \begin_layout Itemize
21962 \begin_inset Flex Code
21965 \begin_layout Plain Layout
21972 \begin_inset Flex Code
21975 \begin_layout Plain Layout
21984 \begin_inset space \thinspace{}
21988 \begin_inset Flex Code
21991 \begin_layout Plain Layout
21997 ] Declare if this is a mandatory (1) or an optional (0) argument.
21998 Mandatory arguments will be output empty if not given,
21999 while optional arguments will not be output at all.
22001 mandatory arguments are delimited by
22002 \begin_inset Flex Code
22005 \begin_layout Plain Layout
22012 while optional arguments are delimited by
22013 \begin_inset Flex Code
22016 \begin_layout Plain Layout
22025 \begin_layout Itemize
22026 \begin_inset Flex Code
22029 \begin_layout Plain Layout
22036 \begin_inset Flex Code
22039 \begin_layout Plain Layout
22045 Option to define a different command (from the default
22046 \begin_inset Flex Code
22049 \begin_layout Plain Layout
22059 ) to be used for line breaks.
22060 The initial backslash must not be specified.
22063 \begin_layout Itemize
22064 \begin_inset Flex Code
22067 \begin_layout Plain Layout
22074 \begin_inset Flex Code
22077 \begin_layout Plain Layout
22083 defines another argument or arguments (by their number) which this argument requires to be output if it is itself output.
22085 \begin_inset space \thinspace{}
22089 in \SpecialChar LaTeX
22091 optional arguments often require previous optional arguments to be output (at least empty),
22093 \begin_inset Flex Code
22096 \begin_layout Plain Layout
22099 command[][argument]{text}
22105 This can be achieved by the statement
22106 \begin_inset Flex Code
22109 \begin_layout Plain Layout
22116 \begin_inset Flex Code
22119 \begin_layout Plain Layout
22126 If multiple arguments are required,
22127 separate them by comma (e.g.,
22129 \begin_inset Flex Code
22132 \begin_layout Plain Layout
22141 \begin_layout Itemize
22142 \begin_inset Flex Code
22145 \begin_layout Plain Layout
22152 \begin_inset Flex Code
22155 \begin_layout Plain Layout
22161 defines a custom left delimiter (instead of
22162 \begin_inset Flex Code
22165 \begin_layout Plain Layout
22172 \begin_inset Flex Code
22175 \begin_layout Plain Layout
22182 A line break in the output can be indicated by
22183 \begin_inset Flex Code
22186 \begin_layout Plain Layout
22195 \begin_layout Itemize
22196 \begin_inset Flex Code
22199 \begin_layout Plain Layout
22206 \begin_inset Flex Code
22209 \begin_layout Plain Layout
22215 defines a custom right delimiter (instead of
22216 \begin_inset Flex Code
22219 \begin_layout Plain Layout
22226 \begin_inset Flex Code
22229 \begin_layout Plain Layout
22236 A line break in the output can be indicated by
22237 \begin_inset Flex Code
22240 \begin_layout Plain Layout
22249 \begin_layout Itemize
22250 \begin_inset Flex Code
22253 \begin_layout Plain Layout
22260 \begin_inset Flex Code
22263 \begin_layout Plain Layout
22269 defines an argument that is inserted if and only if no user-specified arguments were given,
22271 \begin_inset space \thinspace{}
22275 \begin_inset space \space{}
22278 if no argument inset has been inserted (note that also an empty argument inset omits the DefaultArg).
22279 Multiple arguments need to be separated by comma.
22282 \begin_layout Itemize
22283 \begin_inset Flex Code
22286 \begin_layout Plain Layout
22293 \begin_inset Flex Code
22296 \begin_layout Plain Layout
22302 defines an argument that is inserted in any case (alone or in addition to user-specified arguments).
22303 Multiple arguments need to be separated by comma.
22306 \begin_layout Itemize
22307 \begin_inset Flex Code
22310 \begin_layout Plain Layout
22316 The font used for the argument content,
22318 \begin_inset CommandInset ref
22320 reference "subsec:Font-description"
22328 \begin_layout Itemize
22329 \begin_inset Flex Code
22332 \begin_layout Plain Layout
22339 \begin_inset Flex Code
22342 \begin_layout Plain Layout
22351 \begin_inset space \thinspace{}
22355 \begin_inset Flex Code
22358 \begin_layout Plain Layout
22364 ] As with paragraph styles,
22366 \begin_inset CommandInset ref
22368 reference "subsec:Paragraph-Styles"
22376 \begin_layout Itemize
22377 \begin_inset Flex Code
22380 \begin_layout Plain Layout
22386 The font used for the label;
22388 \begin_inset CommandInset ref
22390 reference "subsec:Font-description"
22398 \begin_layout Itemize
22399 \begin_inset Flex Code
22402 \begin_layout Plain Layout
22409 \begin_inset Flex Code
22412 \begin_layout Plain Layout
22424 ] describes the rendering style used for the inset's frame and buttons.
22427 \begin_layout Itemize
22428 \begin_inset Flex Code
22431 \begin_layout Plain Layout
22438 \begin_inset Flex Code
22441 \begin_layout Plain Layout
22448 \begin_inset Flex Code
22451 \begin_layout Plain Layout
22458 this argument is automatically inserted when the respective style is selected.
22461 \begin_layout Itemize
22462 \begin_inset Flex Code
22465 \begin_layout Plain Layout
22472 \begin_inset Flex Code
22475 \begin_layout Plain Layout
22482 \begin_inset Flex Code
22485 \begin_layout Plain Layout
22492 this argument will be inserted on a new line with
22493 \begin_inset Flex Code
22496 \begin_layout Plain Layout
22502 (only available within Flex insets).
22505 \begin_layout Itemize
22506 \begin_inset Flex Code
22509 \begin_layout Plain Layout
22516 \begin_inset Flex Code
22519 \begin_layout Plain Layout
22526 \begin_inset Flex Code
22529 \begin_layout Plain Layout
22536 this argument will be inserted with a copy of the co-text (either selected text or the whole paragraph) as content.
22539 \begin_layout Itemize
22540 \begin_inset Flex Code
22543 \begin_layout Plain Layout
22550 \begin_inset Flex Code
22553 \begin_layout Plain Layout
22565 ] Whether the contents of this argument should be output in raw form,
22566 meaning without special translations that \SpecialChar LaTeX
22570 \begin_inset Flex Code
22573 \begin_layout Plain Layout
22579 status is inherited by the inset or paragraph layout the argument belongs to,
22580 true and false change the status for the given argument only.
22583 \begin_layout Itemize
22584 \begin_inset Flex Code
22587 \begin_layout Plain Layout
22594 \begin_inset Flex Code
22597 \begin_layout Plain Layout
22598 string of characters
22607 Defines individual characters
22608 \begin_inset Newline linebreak
22611 that should be output in raw form,
22612 meaning without special translations that \SpecialChar LaTeX
22615 contrary to PassThru,
22616 this needs to be explicitly defined for arguments.
22618 arguments do not inherit PassThruChars from their parent inset or layout.
22621 \begin_layout Itemize
22622 \begin_inset Flex Code
22625 \begin_layout Plain Layout
22632 \begin_inset Flex Code
22635 \begin_layout Plain Layout
22644 \begin_inset space \thinspace{}
22648 \begin_inset Flex Code
22651 \begin_layout Plain Layout
22657 ] If this is set to 1,
22658 the argument will output its content in the corresponding item in the table of contents.
22662 \begin_layout Standard
22664 the text entered in the \SpecialChar LyX
22665 workarea in the respective layout is the last (mandatory) argument of a command if the
22666 \begin_inset Flex Code
22669 \begin_layout Plain Layout
22676 \begin_inset Flex Code
22679 \begin_layout Plain Layout
22687 arguments with the prefix
22688 \begin_inset Flex Code
22691 \begin_layout Plain Layout
22697 are output after this workarea argument.
22698 Note that post-argument numbering restarts at 1,
22699 so the first argument following the workarea argument is
22700 \begin_inset Flex Code
22703 \begin_layout Plain Layout
22710 Post-arguments are ignored in any other
22711 \begin_inset Flex Code
22714 \begin_layout Plain Layout
22721 \begin_inset Flex Code
22724 \begin_layout Plain Layout
22733 \begin_layout Standard
22735 \begin_inset Flex Code
22738 \begin_layout Plain Layout
22747 \begin_inset Flex Code
22750 \begin_layout Plain Layout
22759 \begin_inset Flex Code
22762 \begin_layout Plain Layout
22768 followed by the number (e.
22769 \begin_inset space \thinspace{}
22773 \begin_inset space \space{}
22777 \begin_inset Flex Code
22780 \begin_layout Plain Layout
22789 \begin_layout Standard
22791 there is a special argument type with the prefix
22792 \begin_inset Flex Code
22795 \begin_layout Plain Layout
22802 It is not really an argument,
22803 but uses the argument interface (thus,
22804 the prefix is also followed by a number,
22806 \begin_inset space \thinspace{}
22811 \begin_inset Flex Code
22814 \begin_layout Plain Layout
22815 Argument listpreamble:1
22821 As the name implies,
22822 it is targeted at lists such as
22842 Its content will be output at the list start,
22844 \begin_inset Flex Code
22847 \begin_layout Plain Layout
22856 on an own line (a place that is otherwise not accessible in \SpecialChar LyX
22859 users can insert redefinitions (of lengths etc.) to individual lists.
22861 these arguments do not have a delimiter.
22864 \begin_layout Subsection
22866 \begin_inset CommandInset label
22868 name "subsec:Counters"
22875 \begin_layout Standard
22876 It is necessary to define the counters (
22877 \begin_inset Flex Noun
22880 \begin_layout Plain Layout
22888 \begin_inset Flex Noun
22891 \begin_layout Plain Layout
22899 ) in the text class itself.
22900 The standard counters are defined in the file
22901 \begin_inset Flex Code
22904 \begin_layout Plain Layout
22911 so you may have to do no more than add
22914 \begin_layout LyX-Code
22915 Input stdcounters.inc
22918 \begin_layout Standard
22919 to your layout file to get them to work.
22920 But if you want to define custom counters,
22921 then you can do so.
22922 The counter declaration must begin with:
22925 \begin_layout LyX-Code
22926 Counter CounterName
22929 \begin_layout Standard
22931 \begin_inset Flex Code
22934 \begin_layout Plain Layout
22940 ' is replaced by the name of the counter.
22941 And it must end with
22942 \begin_inset Quotes eld
22946 \begin_inset Flex Code
22949 \begin_layout Plain Layout
22956 \begin_inset Quotes erd
22960 The following parameters can also be used:
22963 \begin_layout Description
22964 \begin_inset Flex Code
22967 \begin_layout Plain Layout
22974 \begin_inset Flex Code
22977 \begin_layout Plain Layout
22983 ] Sets the initial value for the counter,
22984 to which it will be reset whenever that happens.
22986 one will want the default,
22990 \begin_layout Description
22991 \begin_inset Flex Code
22994 \begin_layout Plain Layout
23001 \begin_inset Flex Code
23004 \begin_layout Plain Layout
23011 \begin_inset Quotes erd
23015 \begin_inset Quotes erd
23019 this string defines how the counter is displayed.
23020 Setting this value sets
23021 \begin_inset Flex Code
23024 \begin_layout Plain Layout
23025 LabelStringAppendix
23031 The following special constructs can be used in the string:
23035 \begin_layout Itemize
23036 \begin_inset Flex Code
23039 \begin_layout Plain Layout
23047 will be replaced by the expansion of the
23048 \begin_inset Flex Code
23051 \begin_layout Plain Layout
23058 \begin_inset Flex Code
23061 \begin_layout Plain Layout
23062 LabelStringAppendix
23068 \begin_inset Flex Code
23071 \begin_layout Plain Layout
23081 \begin_layout Itemize
23082 counter values can be expressed using \SpecialChar LaTeX
23084 \begin_inset Newline newline
23088 \begin_inset Flex Code
23091 \begin_layout Plain Layout
23109 \begin_inset Flex Code
23112 \begin_layout Plain Layout
23124 \begin_layout Plain Layout
23135 the situation is a bit more complicated:
23155 other than those described below will produce arabic numerals.
23156 It would not be surprising to see this change in the future.
23162 \begin_inset Flex Code
23165 \begin_layout Plain Layout
23174 3,\SpecialChar ldots
23177 \begin_inset Flex Code
23180 \begin_layout Plain Layout
23186 for lower-case letters:
23193 \begin_inset Flex Code
23196 \begin_layout Plain Layout
23202 for upper-case letters:
23209 \begin_inset Flex Code
23212 \begin_layout Plain Layout
23218 for lower-case roman numerals:
23225 \begin_inset Flex Code
23228 \begin_layout Plain Layout
23234 for upper-case roman numerals:
23237 III\SpecialChar ldots
23240 \begin_inset Flex Code
23243 \begin_layout Plain Layout
23249 for hebrew numerals.
23253 \begin_layout Standard
23254 If LabelString is not defined,
23255 a default value is constructed as follows:
23256 if the counter has a parent counter
23257 \begin_inset Flex Code
23260 \begin_layout Plain Layout
23267 \begin_inset Flex Code
23270 \begin_layout Plain Layout
23278 \begin_inset Newline newline
23282 \begin_inset Flex Code
23285 \begin_layout Plain Layout
23296 otherwise the string
23297 \begin_inset Flex Code
23300 \begin_layout Plain Layout
23311 \begin_layout Description
23312 \begin_inset Flex Code
23315 \begin_layout Plain Layout
23316 LabelStringAppendix
23322 \begin_inset Flex Code
23325 \begin_layout Plain Layout
23332 \begin_inset Quotes eld
23336 \begin_inset Quotes erd
23340 \begin_inset Flex Code
23343 \begin_layout Plain Layout
23350 but for use in the Appendix.
23353 \begin_layout Description
23354 \begin_inset Flex Code
23357 \begin_layout Plain Layout
23364 \begin_inset Flex Code
23367 \begin_layout Plain Layout
23374 \begin_inset Quotes eld
23378 \begin_inset Quotes erd
23381 ] The counter name as used in \SpecialChar LaTeX
23384 in \SpecialChar LyX
23386 there is a counter named `theorem',
23387 but it is output to \SpecialChar LaTeX
23391 \begin_layout Description
23392 \begin_inset Flex Code
23395 \begin_layout Plain Layout
23402 \begin_inset Flex Code
23405 \begin_layout Plain Layout
23412 \begin_inset Quotes erd
23416 \begin_inset Quotes erd
23419 ] A format for use with formatted references to this counter.
23421 one might want to have references to section numbers appear as
23422 \begin_inset Quotes eld
23426 \begin_inset Quotes erd
23430 The string may contain
23431 \begin_inset Quotes eld
23435 \begin_inset Quotes erd
23438 or a counter specification as in
23439 \begin_inset Flex Code
23442 \begin_layout Plain Layout
23449 The former will be replaced by the counter number itself.
23456 \begin_inset Flex Code
23459 \begin_layout Plain Layout
23469 (which might render as §2.7).
23472 \begin_layout Description
23473 \begin_inset Flex Code
23476 \begin_layout Plain Layout
23483 \begin_inset Flex Code
23486 \begin_layout Plain Layout
23494 \begin_inset Flex Code
23497 \begin_layout Plain Layout
23503 ] For use with `formatted references',
23504 specifically when a single counter is used with multiple sorts of styles.
23507 \begin_inset Flex Code
23510 \begin_layout Plain Layout
23516 counter is often used for all sorts of theorem-like environments:
23520 The first argument gives a prefix used in the labels (e.g.,
23522 \begin_inset Quotes eld
23526 \begin_inset Quotes erd
23530 \begin_inset Quotes eld
23534 \begin_inset Quotes erd
23538 and the second a formatting string,
23540 \begin_inset Flex Code
23543 \begin_layout Plain Layout
23550 \begin_inset Flex Code
23553 \begin_layout Plain Layout
23560 If this is not given,
23562 \begin_inset Flex Code
23565 \begin_layout Plain Layout
23574 \begin_layout Description
23575 \begin_inset Flex Code
23578 \begin_layout Plain Layout
23585 \begin_inset Flex Code
23588 \begin_layout Plain Layout
23595 \begin_inset Quotes erd
23599 \begin_inset Quotes erd
23602 ] If this is set to the name of another counter,
23603 the present counter will be reset every time the other one is increased.
23606 \begin_inset Flex Code
23609 \begin_layout Plain Layout
23616 \begin_inset Flex Code
23619 \begin_layout Plain Layout
23628 \begin_layout Subsection
23630 \begin_inset CommandInset label
23632 name "subsec:Font-description"
23639 \begin_layout Standard
23640 A font description looks like this:
23643 \begin_layout LyX-Code
23660 \begin_layout LyX-Code
23664 \begin_layout LyX-Code
23668 \begin_layout Standard
23669 The following commands are available:
23672 \begin_layout Description
23673 \begin_inset Flex Code
23676 \begin_layout Plain Layout
23683 \begin_inset Flex Code
23686 \begin_layout Plain Layout
23693 \begin_inset space ~
23697 \begin_inset CommandInset ref
23699 reference "chap:Names-of-colors"
23707 for valid arguments.
23710 \begin_layout Description
23711 \begin_inset Flex Code
23714 \begin_layout Plain Layout
23721 \begin_inset Flex Code
23724 \begin_layout Plain Layout
23734 \begin_inset Flex Code
23737 \begin_layout Plain Layout
23745 \begin_inset Flex Code
23748 \begin_layout Plain Layout
23757 \begin_layout Description
23758 \begin_inset Flex Code
23761 \begin_layout Plain Layout
23768 \begin_inset Flex Code
23771 \begin_layout Plain Layout
23777 ] Valid arguments are:
23779 \begin_inset Flex Code
23782 \begin_layout Plain Layout
23790 \begin_inset Flex Code
23793 \begin_layout Plain Layout
23801 \begin_inset Flex Code
23804 \begin_layout Plain Layout
23812 \begin_inset Flex Code
23815 \begin_layout Plain Layout
23823 \begin_inset Flex Code
23826 \begin_layout Plain Layout
23834 \begin_inset Flex Code
23837 \begin_layout Plain Layout
23845 \begin_inset Flex Code
23848 \begin_layout Plain Layout
23856 \begin_inset Flex Code
23859 \begin_layout Plain Layout
23867 \begin_inset Flex Code
23870 \begin_layout Plain Layout
23878 \begin_inset Flex Code
23881 \begin_layout Plain Layout
23889 \begin_inset Flex Code
23892 \begin_layout Plain Layout
23899 \begin_inset Flex Code
23902 \begin_layout Plain Layout
23909 Each of these turns on or off the corresponding attribute.
23912 \begin_inset Flex Code
23915 \begin_layout Plain Layout
23923 \begin_inset Flex Code
23926 \begin_layout Plain Layout
23934 \begin_inset Newline newline
23937 If the latter seems puzzling,
23938 remember that the font settings for the present context are generally inherited from the surrounding context.
23940 \begin_inset Flex Code
23943 \begin_layout Plain Layout
23949 would turn off the emphasis that was anyway in effect,
23951 in a theorem environment.
23954 \begin_layout Description
23955 \begin_inset Flex Code
23958 \begin_layout Plain Layout
23965 \begin_inset Flex Code
23968 \begin_layout Plain Layout
23978 \begin_inset Flex Code
23981 \begin_layout Plain Layout
23990 \begin_layout Description
23991 \begin_inset Flex Code
23994 \begin_layout Plain Layout
24001 \begin_inset Flex Code
24004 \begin_layout Plain Layout
24014 \begin_inset Flex Code
24017 \begin_layout Plain Layout
24025 \begin_inset Flex Code
24028 \begin_layout Plain Layout
24036 \begin_inset Flex Code
24039 \begin_layout Plain Layout
24048 \begin_layout Description
24049 \begin_inset Flex Code
24052 \begin_layout Plain Layout
24059 \begin_inset Flex Code
24062 \begin_layout Plain Layout
24070 \begin_inset Flex Code
24073 \begin_layout Plain Layout
24081 \begin_inset Flex Code
24084 \begin_layout Plain Layout
24094 \begin_inset Flex Code
24097 \begin_layout Plain Layout
24105 \begin_inset Flex Code
24108 \begin_layout Plain Layout
24116 \begin_inset Flex Code
24119 \begin_layout Plain Layout
24127 \begin_inset Flex Code
24130 \begin_layout Plain Layout
24138 \begin_inset Flex Code
24141 \begin_layout Plain Layout
24150 \begin_layout Subsection
24151 \begin_inset CommandInset label
24153 name "subsec:Citation-engine-description"
24157 Cite engine description
24160 \begin_layout Standard
24162 \begin_inset Flex Code
24165 \begin_layout Plain Layout
24172 as used mainly in cite engine files (see
24173 \begin_inset CommandInset ref
24175 reference "subsec:Cite-Engine-Files"
24184 define the citation commands provided by a specific
24185 \begin_inset Quotes eld
24189 \begin_inset Quotes erd
24194 in \SpecialChar LyX
24196 is way specific way to format citations,
24198 author names and/or years.
24201 supports three such engine types,
24205 \begin_layout Enumerate
24206 \begin_inset Flex Code
24209 \begin_layout Plain Layout
24216 the default Bib\SpecialChar TeX
24217 way to format citations,
24218 a simple numeric style (e.
24219 \begin_inset space \thinspace{}
24224 \begin_inset Quotes eld
24228 \begin_inset Quotes erd
24234 \begin_layout Enumerate
24235 \begin_inset Flex Code
24238 \begin_layout Plain Layout
24245 Harvard-styled citations using author names and publication year (e.
24246 \begin_inset space \thinspace{}
24251 \begin_inset Quotes eld
24254 Smith and Miller (2017b)
24255 \begin_inset Quotes erd
24261 \begin_layout Enumerate
24262 \begin_inset Flex Code
24265 \begin_layout Plain Layout
24272 extended numerical citations that also allow for author or title next to the number (e.
24273 \begin_inset space \thinspace{}
24278 \begin_inset Quotes eld
24281 Smith and Miller [1]
24282 \begin_inset Quotes erd
24288 \begin_layout Standard
24289 \begin_inset Flex Code
24292 \begin_layout Plain Layout
24298 blocks look like this:
24301 \begin_layout LyX-Code
24305 \begin_layout LyX-Code
24309 \begin_layout LyX-Code
24313 \begin_layout LyX-Code
24314 citeyearpar[][]=parencite*
24317 \begin_layout LyX-Code
24321 \begin_layout LyX-Code
24325 \begin_layout Standard
24327 \begin_inset Flex Code
24330 \begin_layout Plain Layout
24336 denotes the engine.
24337 The individual lines respectively define a cite command or cite command paradigm supported by this engine.
24338 The line can be as simple as a cite command that is used both to name the respective \SpecialChar LyX
24339 command and the \SpecialChar LaTeX
24340 output or more complex in order to differentiate things.
24341 The full syntax is:
24344 \begin_layout LyX-Code
24345 LyXName|alias$*<!_stardesc!_stardesctooltip>[][]=latexcmd
24348 \begin_layout Itemize
24349 \begin_inset Flex Code
24352 \begin_layout Plain Layout
24359 The name as used in the
24360 \begin_inset Flex Code
24363 \begin_layout Plain Layout
24373 \begin_layout Standard
24374 For portability reasons,
24375 we try to use the same name for same-formatted commands in different cite packages (thus many names stem from natbib,
24376 and thus we need to differentiate a
24377 \begin_inset Flex Code
24380 \begin_layout Plain Layout
24387 if the \SpecialChar LaTeX
24388 command names differ).
24392 \begin_layout Itemize
24393 \begin_inset Flex Code
24396 \begin_layout Plain Layout
24403 a (comma-separated) list of commands that fall back to the given
24404 \begin_inset Flex Code
24407 \begin_layout Plain Layout
24413 in the current engine.
24414 This eases the switch of citation packages and engines.
24416 \begin_inset Flex Code
24419 \begin_layout Plain Layout
24426 \begin_inset Flex Code
24429 \begin_layout Plain Layout
24435 in layout definitions.
24438 \begin_layout Itemize
24439 \begin_inset Flex Code
24442 \begin_layout Plain Layout
24449 The actual \SpecialChar LaTeX
24450 command that is output.
24454 \begin_layout Standard
24455 \begin_inset Flex Code
24458 \begin_layout Plain Layout
24465 \begin_inset Flex Code
24468 \begin_layout Plain Layout
24476 \begin_inset Flex Code
24479 \begin_layout Plain Layout
24487 \begin_inset Flex Code
24490 \begin_layout Plain Layout
24496 will be output to \SpecialChar LaTeX
24500 \begin_layout Standard
24504 \begin_layout Itemize
24505 Capitalization indicates that the command also has a capitalized form (
24506 \begin_inset Flex Code
24509 \begin_layout Plain Layout
24519 \begin_inset Flex Code
24522 \begin_layout Plain Layout
24531 These usually enforce up-casing of name prefixes (
24536 \begin_inset Formula $\Rightarrow$
24546 \begin_layout Itemize
24548 \begin_inset Flex Code
24551 \begin_layout Plain Layout
24557 indicate the number of optional arguments (there can be 0–2).
24560 \begin_layout Itemize
24562 \begin_inset Flex Code
24565 \begin_layout Plain Layout
24571 indicates there is a starred version of the command (
24572 \begin_inset Flex Code
24575 \begin_layout Plain Layout
24585 \begin_inset Flex Code
24588 \begin_layout Plain Layout
24601 \begin_layout Standard
24603 the starred version means:
24604 Output all authors even if it should be shortened with
24605 \begin_inset Quotes eld
24609 \begin_inset Quotes erd
24613 \begin_inset Flex Code
24616 \begin_layout Plain Layout
24625 \begin_layout Standard
24626 If the star has a different meaning for a given command,
24627 it can be specified in angle brackets:
24629 \begin_inset Flex Code
24632 \begin_layout Plain Layout
24633 <!_stardesc!_stardesctooltip>
24639 Maximal two translatable macro keywords,
24640 marked by the prefix
24641 \begin_inset Flex Code
24644 \begin_layout Plain Layout
24652 The first points to the string that replaces the
24653 \begin_inset Quotes eld
24657 \begin_inset Quotes erd
24660 checkbox label in the citation dialog,
24661 the second one to an optional tool tip for this checkbox.
24665 \begin_layout Standard
24666 Note that these two macros have to be defined in a
24667 \begin_inset Flex Code
24670 \begin_layout Plain Layout
24676 (see next section),
24678 \begin_inset Flex Code
24681 \begin_layout Plain Layout
24692 \begin_layout LyX-Code
24693 _stardesc Sta&rred command label
24696 \begin_layout LyX-Code
24697 _stardesctooltip Tooltip for the starred command checkbox.
24701 \begin_layout Itemize
24703 \begin_inset Flex Code
24706 \begin_layout Plain Layout
24712 indicates that this command features
24713 \begin_inset Quotes eld
24716 qualified citation lists
24717 \begin_inset Quotes erd
24725 -specific feature for multi-reference citations where an individual pre- and postnote can be given to each reference in the list.
24726 Please refer to the
24730 manual for details.
24733 \begin_layout Standard
24734 If you want to add a cite command to a cite engine (e.
24735 \begin_inset space \thinspace{}
24739 add a specific command provided by a class),
24741 \begin_inset Flex Code
24744 \begin_layout Plain Layout
24745 AddToCiteEngine <engine type> \SpecialChar ldots
24752 Note that only cite commands that do not exist yet are added.
24755 \begin_layout Subsection
24756 \begin_inset CommandInset label
24758 name "subsec:Citation-format-description"
24762 Cite format description
24765 \begin_layout Standard
24767 \begin_inset Flex Code
24770 \begin_layout Plain Layout
24776 blocks are used to describe how bibliographic information should be displayed,
24777 both within \SpecialChar LyX
24778 itself (in the citation dialog and in tooltips,
24779 for example) and in XHTML output.
24780 Such a block might look like this:
24783 \begin_layout LyX-Code
24787 \begin_layout LyX-Code
24791 \begin_layout LyX-Code
24795 \begin_layout LyX-Code
24799 \begin_layout Standard
24803 \begin_layout LyX-Code
24807 \begin_layout LyX-Code
24811 \begin_layout LyX-Code
24815 \begin_layout LyX-Code
24819 \begin_layout Standard
24821 the individual lines define how the bibliographic information associated with an article or book,
24823 is to be displayed,
24824 and such a definition can be given for any
24825 \begin_inset Quotes els
24829 \begin_inset Quotes ers
24832 that might be present in a Bib\SpecialChar TeX
24835 defines a default format in the source code that will be used if no specific definition has been given.
24837 predefines several formats in the file
24838 \begin_inset Flex Code
24841 \begin_layout Plain Layout
24848 which is included in most of \SpecialChar LyX
24849 's document classes.
24852 \begin_layout Standard
24853 In the second case,
24854 the lines define how a specific citation command (in the example
24855 \begin_inset Flex Code
24858 \begin_layout Plain Layout
24868 \begin_inset Flex Code
24871 \begin_layout Plain Layout
24879 ) is to be displayed on the citation inset label,
24880 in the citation dialog,
24881 menu or XHTML output.
24883 defines such formats for the citation style variants it supports via
24885 Document\SpecialChar menuseparator
24886 Setting\SpecialChar menuseparator
24887 Bibliography\SpecialChar ldots
24891 \begin_inset Flex Code
24894 \begin_layout Plain Layout
24900 files that are shipped with \SpecialChar LyX
24902 \begin_inset CommandInset ref
24904 reference "subsec:Cite-Engine-Files"
24915 \begin_layout Standard
24916 The definitions use a simple language that allows Bib\SpecialChar TeX
24917 keys to be replaced with their values.
24918 Keys should be enclosed in
24919 \begin_inset Flex Code
24922 \begin_layout Plain Layout
24931 \begin_inset Flex Code
24934 \begin_layout Plain Layout
24941 So a simple definition might look like this:
24944 \begin_layout LyX-Code
24947 \begin_inset Quotes eld
24951 \begin_inset Quotes erd
24957 \begin_layout Standard
24958 This would print the author,
24959 followed by a comma,
24960 followed by the title,
24962 followed by a period.
24965 \begin_layout Standard
24967 sometimes you may want to print a key only if it exists.
24968 This can be done by using a conditional construction,
24971 \begin_inset Flex Code
24974 \begin_layout Plain Layout
24976 \begin_inset space ~
24987 \begin_inset Flex Code
24990 \begin_layout Plain Layout
24998 \begin_inset Quotes eld
25002 \begin_inset space ~
25006 \begin_inset Quotes erd
25009 followed by the volume key.
25010 It is also possible to have an else clause in the conditional,
25012 \begin_inset Newline newline
25016 \begin_inset Flex Code
25019 \begin_layout Plain Layout
25020 {%author%[[%author%]][[%editor%,
25027 \begin_inset Newline newline
25032 \begin_inset Flex Code
25035 \begin_layout Plain Layout
25041 key is printed if it exists;
25043 the editor key is printed,
25045 \begin_inset Quotes eld
25049 \begin_inset space ~
25053 \begin_inset Quotes erd
25056 Note that the key is again enclosed in
25057 \begin_inset Flex Code
25060 \begin_layout Plain Layout
25067 the entire conditional is enclosed in braces;
25068 and the if and else clauses are enclosed in double brackets,
25070 \begin_inset Quotes eld
25074 \begin_inset Flex Code
25077 \begin_layout Plain Layout
25084 \begin_inset Quotes eld
25088 \begin_inset Quotes eld
25092 \begin_inset Flex Code
25095 \begin_layout Plain Layout
25102 \begin_inset Quotes erd
25106 There must be no space between any of these.
25109 \begin_layout Standard
25110 Next to the entry keys,
25111 there are some special keys that can be used for these conditionals:
25114 \begin_layout Itemize
25115 \begin_inset Flex Code
25118 \begin_layout Plain Layout
25119 {%dialog%[[true]][[false]]}
25126 \begin_inset Quotes eld
25130 \begin_inset Quotes erd
25133 part for dialogs and menus,
25135 \begin_inset Quotes eld
25139 \begin_inset Quotes erd
25142 part for other contexts (workarea,
25146 \begin_layout Itemize
25147 \begin_inset Flex Code
25150 \begin_layout Plain Layout
25151 {%export%[[true]][[false]]}
25158 \begin_inset Quotes eld
25162 \begin_inset Quotes erd
25165 part for export and menus,
25167 \begin_inset Quotes eld
25171 \begin_inset Quotes erd
25174 part for other contexts (workarea,
25178 \begin_layout Itemize
25179 \begin_inset Flex Code
25182 \begin_layout Plain Layout
25190 \begin_inset Quotes eld
25194 \begin_inset Quotes erd
25197 part if another item follows (e.
25198 \begin_inset space \thinspace{}
25202 in a citation with multiple keys)
25205 \begin_layout Itemize
25206 \begin_inset Flex Code
25209 \begin_layout Plain Layout
25210 {%second%[[true]][[false]]}
25217 \begin_inset Quotes eld
25221 \begin_inset Quotes erd
25224 if this is the second of multiple items,
25226 \begin_inset Quotes eld
25230 \begin_inset Quotes erd
25236 \begin_layout Itemize
25237 \begin_inset Flex Code
25240 \begin_layout Plain Layout
25241 {%ifstar%[[true]][[false]]}
25248 \begin_inset Quotes eld
25252 \begin_inset Quotes erd
25255 part for starred citation commands (such as
25256 \begin_inset Flex Code
25259 \begin_layout Plain Layout
25268 the false part for unstarred
25271 \begin_layout Itemize
25272 \begin_inset Flex Code
25275 \begin_layout Plain Layout
25276 {%ifentrytype:<type>%[[true]][[false]]}
25283 \begin_inset Quotes eld
25287 \begin_inset Quotes erd
25290 if the current entry type matches
25291 \begin_inset Flex Code
25294 \begin_layout Plain Layout
25301 else the false part (e.g.,
25302 in a citation definition:
25304 \begin_inset Flex Code
25307 \begin_layout Plain Layout
25308 {%ifentrytype:book%[[this is a book]][[this is no book]]}
25316 \begin_layout Itemize
25317 \begin_inset Flex Code
25320 \begin_layout Plain Layout
25321 {%ifmultiple:<authortype>%[[true]][[false]]}
25328 \begin_inset Quotes eld
25332 \begin_inset Quotes erd
25335 if the current author type (author,
25336 editor etc.) has multiple authors,
25337 else the false part (e.g.,
25338 in a bibliography definition:
25340 \begin_inset Flex Code
25343 \begin_layout Plain Layout
25344 {%ifmultiple:editor%[[eds.]][[ed.]]}
25352 \begin_layout Itemize
25353 \begin_inset Flex Code
25356 \begin_layout Plain Layout
25357 {%ifqualified%[[true]][[false]]}
25364 \begin_inset Quotes eld
25368 \begin_inset Quotes erd
25371 part if the current citation is a qualified citation list (a specific
25375 format for multi-reference citations),
25376 the false part if this is not the case.
25379 \begin_layout Standard
25381 \begin_inset Flex Code
25384 \begin_layout Plain Layout
25390 prints the author key as it is recorded in the bibliography file.
25391 This might not be what you want,
25392 since it will result in a string such as
25393 \begin_inset Quotes eld
25400 \begin_inset Quotes erd
25404 \begin_inset Quotes eld
25408 \begin_inset Quotes erd
25411 is used by Bib\SpecialChar TeX
25412 to delimit authors).
25414 therefore provides some methods to get properly formatted name lists (which will also get translated).
25415 The following keys are provided:
25418 \begin_layout Enumerate
25419 For name lists with pre- and surname,
25420 suitable for the main authors/editors of a bibliography item.
25422 \begin_inset Flex Code
25425 \begin_layout Plain Layout
25431 part denotes the kind of list that is requested (e.g.
25433 \begin_inset Flex Code
25436 \begin_layout Plain Layout
25446 \begin_layout Itemize
25447 \begin_inset Flex Code
25450 \begin_layout Plain Layout
25451 %abbrvnames:<nametype>%
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
25483 %fullnames:<nametype>%
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 %forceabbrvnames:<nametype>%
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 Enumerate
25534 Alternative name lists with pre- and surname,
25535 if the order of pre- and surname inside the bibliography item differs (as in:
25537 \begin_inset Quotes eld
25547 \begin_inset Quotes erd
25554 \begin_layout Itemize
25555 \begin_inset Flex Code
25558 \begin_layout Plain Layout
25559 %abbrvbynames:<nametype>%
25565 Provides a name list which is abbreviated (with
25566 \begin_inset Quotes eld
25570 \begin_inset Quotes erd
25574 \begin_inset Flex Code
25577 \begin_layout Plain Layout
25586 \begin_layout Itemize
25587 \begin_inset Flex Code
25590 \begin_layout Plain Layout
25591 %fullbynames:<nametype>%
25597 Provides a full name list (never abbreviated with
25598 \begin_inset Quotes eld
25602 \begin_inset Quotes erd
25608 \begin_layout Itemize
25609 \begin_inset Flex Code
25612 \begin_layout Plain Layout
25613 %forceabbrvbynames:<nametype>%
25619 Provides a name list which is always abbreviated (with
25620 \begin_inset Quotes eld
25624 \begin_inset Quotes erd
25628 \begin_inset Flex Code
25631 \begin_layout Plain Layout
25641 \begin_layout Enumerate
25642 And finally name lists which consist of family names only,
25643 as used in author-year citation labels.
25644 These do not take a
25645 \begin_inset Flex Code
25648 \begin_layout Plain Layout
25655 but always return either an author list or,
25656 if this does not exist,
25657 an editor list (as common in author-year labels):
25661 \begin_layout Itemize
25662 \begin_inset Flex Code
25665 \begin_layout Plain Layout
25672 Provides a name list which is abbreviated (with
25673 \begin_inset Quotes eld
25677 \begin_inset Quotes erd
25681 \begin_inset Flex Code
25684 \begin_layout Plain Layout
25693 \begin_layout Itemize
25694 \begin_inset Flex Code
25697 \begin_layout Plain Layout
25704 Provides a full name list (never abbreviated with
25705 \begin_inset Quotes eld
25709 \begin_inset Quotes erd
25715 \begin_layout Itemize
25716 \begin_inset Flex Code
25719 \begin_layout Plain Layout
25720 %forceabbrvciteauthor%
25726 Provides a name list which is always abbreviated (with
25727 \begin_inset Quotes eld
25731 \begin_inset Quotes erd
25735 \begin_inset Flex Code
25738 \begin_layout Plain Layout
25748 \begin_layout Standard
25749 The order of pre- and surname in the former two lists can be adjusted by these macros:
25752 \begin_layout Itemize
25753 \begin_inset Flex Code
25756 \begin_layout Plain Layout
25757 !firstnameform %surname%,
25763 (first author in lists of type 1)
25766 \begin_layout Itemize
25767 \begin_inset Flex Code
25770 \begin_layout Plain Layout
25771 !othernameform %surname%,
25777 (other authors in lists of type 1)
25780 \begin_layout Itemize
25781 \begin_inset Flex Code
25784 \begin_layout Plain Layout
25785 !firstbynameform %prename% %surname%
25790 (first author in lists of type 2)
25793 \begin_layout Itemize
25794 \begin_inset Flex Code
25797 \begin_layout Plain Layout
25798 !otherbynameform %prename% %surname%
25803 (other authors in lists of type 2)
25806 \begin_layout Standard
25807 This allows you to configure namings like
25808 \begin_inset Quotes eld
25812 Peter and Mary Smith:
25816 John Doe and Pat Green,
25817 eds.:\SpecialChar ldots
25819 \begin_inset Quotes erd
25825 \begin_layout Standard
25826 There is one other piece of syntax available in definitions,
25827 which looks like this:
25829 \begin_inset Flex Code
25832 \begin_layout Plain Layout
25839 This defines a piece of formatting information that is to be used when creating
25840 \begin_inset Quotes eld
25844 \begin_inset Quotes erd
25849 we do not want to output HTML tags when writing plain text,
25850 so they should be wrapped in
25851 \begin_inset Quotes eld
25855 \begin_inset Quotes erd
25859 \begin_inset Quotes eld
25863 \begin_inset Quotes erd
25869 \begin_layout Standard
25870 Two special sorts of definitions are also possible in a
25871 \begin_inset Flex Code
25874 \begin_layout Plain Layout
25881 An example of the first would be:
25884 \begin_layout LyX-Code
25886 \begin_inset Quotes eld
25890 \begin_inset Quotes erd
25896 \begin_layout Standard
25897 This is an abbreviation,
25899 and it can be used by treating it as if it were a key:
25901 \begin_inset Flex Code
25904 \begin_layout Plain Layout
25913 \begin_inset Flex Code
25916 \begin_layout Plain Layout
25922 exactly as it would treat its definition.
25924 let us issue the obvious
25932 \begin_layout LyX-Code
25936 \begin_layout Standard
25937 or anything like it.
25939 shouldn't go into an infinite loop,
25940 but it may go into a long one before it gives up.
25943 \begin_layout Standard
25944 The second sort of special definition might look like this:
25947 \begin_layout LyX-Code
25951 \begin_layout Standard
25952 This defines a translatable piece of text,
25953 which allows relevant parts of the bibliography or citation to be translated.
25954 It can be included in a definition by treating it as a key:
25956 \begin_inset Flex Code
25959 \begin_layout Plain Layout
25966 Note that there are two different translation paths:
25967 All definitions starting with
25968 \begin_inset Flex Code
25971 \begin_layout Plain Layout
25978 such as in the example above,
25979 will be translated to the currently active buffer language (so the translation will match the generated document).
25980 All definitions starting with underscore only will be translated to the GUI language.
25981 This is the proper translation for strings that only occur in the dialogs or on buttons,
25985 \begin_layout LyX-Code
25986 _addtobib Add to bibliography only.
25989 \begin_layout Standard
25990 Several of these translatable strings are predefined in
25991 \begin_inset Flex Code
25994 \begin_layout Plain Layout
26001 \begin_inset Flex Code
26004 \begin_layout Plain Layout
26011 Note that these are not macros,
26012 in the sense just defined.
26013 They will not be expanded.
26016 \begin_layout Standard
26017 So here then is an example that uses several of these features:
26018 \begin_inset VSpace defskip
26024 \begin_layout Standard
26028 !authoredit {%author%[[%author%,
26029 ]][[{%editor%[[%editor%,
26034 \begin_layout Standard
26035 \begin_inset VSpace defskip
26038 This defines a macro that prints the author,
26039 followed by a comma,
26041 \begin_inset Flex Code
26044 \begin_layout Plain Layout
26051 or else prints the name of the editor,
26053 \begin_inset Flex Code
26056 \begin_layout Plain Layout
26062 or its translation (it is by default
26063 \begin_inset Quotes eld
26067 \begin_inset Quotes erd
26072 \begin_inset Flex Code
26075 \begin_layout Plain Layout
26082 Note that this is in fact defined in
26083 \begin_inset Flex Code
26086 \begin_layout Plain Layout
26093 so you can use it in your own definitions,
26095 if you load that file first.
26098 \begin_layout Section
26099 \begin_inset CommandInset label
26101 name "sec:Tags-for-XHTML"
26105 Tags for XHTML output
26108 \begin_layout Standard
26109 As with \SpecialChar LaTeX
26111 the format of \SpecialChar LyX
26112 's XHTML output is also controlled by layout information.
26115 provides sensible defaults and,
26116 as mentioned earlier,
26117 it will even construct default CSS style rules from the other layout tags.
26120 will attempt to use the information provided in the
26121 \begin_inset Flex Code
26124 \begin_layout Plain Layout
26130 declaration for the Chapter style to write CSS that will appropriately format chapter headings.
26133 \begin_layout Standard
26136 you may not have to do anything at all to get acceptable XHTML output for your own environments,
26139 But in some cases you will,
26140 and so \SpecialChar LyX
26141 provides a number of layout tags that can be used to customize the XHTML and CSS that are generated.
26144 \begin_layout Standard
26145 Note that there are two tags,
26147 \begin_inset Flex Code
26150 \begin_layout Plain Layout
26157 \begin_inset Flex Code
26160 \begin_layout Plain Layout
26166 that may appear outside style and inset declarations.
26168 \begin_inset CommandInset ref
26170 reference "subsec:General-text-class"
26175 for details on these.
26178 \begin_layout Subsection
26179 \begin_inset CommandInset label
26181 name "subsec:Paragraph-Style-XHTML"
26188 \begin_layout Standard
26189 The sort of XHTML \SpecialChar LyX
26190 outputs for a paragraph depends upon whether we are dealing with a normal paragraph,
26193 where this is itself determined by the contents of the corresponding
26194 \begin_inset Flex Code
26197 \begin_layout Plain Layout
26208 \begin_layout Standard
26209 For a command or normal paragraph,
26210 the output XHTML has the following form:
26213 \begin_layout LyX-Code
26217 \begin_inset Quotes erd
26221 \begin_inset Quotes erd
26227 \begin_layout LyX-Code
26231 \begin_inset Quotes erd
26235 \begin_inset Quotes erd
26241 \begin_layout LyX-Code
26244 Contents of the paragraph.
26247 \begin_layout LyX-Code
26253 \begin_layout Standard
26254 The label tags are of course omitted if the paragraph does not have a label.
26257 \begin_layout Standard
26258 For an environment that is not some sort of list,
26259 the XHTML takes this form:
26262 \begin_layout LyX-Code
26266 \begin_inset Quotes erd
26270 \begin_inset Quotes erd
26276 \begin_layout LyX-Code
26280 \begin_inset Quotes erd
26284 \begin_inset Quotes erd
26288 \begin_inset Quotes erd
26292 \begin_inset Quotes erd
26295 >Environment Label</labeltag>First paragraph.</itemtag>
26298 \begin_layout LyX-Code
26301 <itemtag>Second paragraph.</itemtag>
26304 \begin_layout LyX-Code
26310 \begin_layout Standard
26311 Note that the label is output only for the first paragraph,
26312 as it should be for a theorem,
26317 \begin_layout Standard
26319 we have one of these forms:
26322 \begin_layout LyX-Code
26326 \begin_inset Quotes erd
26330 \begin_inset Quotes erd
26336 \begin_layout LyX-Code
26340 \begin_inset Quotes erd
26344 \begin_inset Quotes erd
26348 \begin_inset Quotes erd
26352 \begin_inset Quotes erd
26355 >List Label</labeltag>First item.</itemtag>
26358 \begin_layout LyX-Code
26362 \begin_inset Quotes erd
26366 \begin_inset Quotes erd
26370 \begin_inset Quotes erd
26374 \begin_inset Quotes erd
26377 >List Label</labeltag>Second item.</itemtag>
26380 \begin_layout LyX-Code
26386 \begin_layout LyX-Code
26390 \begin_layout LyX-Code
26394 \begin_inset Quotes erd
26398 \begin_inset Quotes erd
26404 \begin_layout LyX-Code
26408 \begin_inset Quotes erd
26412 \begin_inset Quotes erd
26415 >List Label</labeltag><itemtag attr=
26416 \begin_inset Quotes erd
26420 \begin_inset Quotes erd
26423 >First item.</itemtag>
26426 \begin_layout LyX-Code
26430 \begin_inset Quotes erd
26434 \begin_inset Quotes erd
26437 >List Label</labeltag><itemtag attr=
26438 \begin_inset Quotes erd
26442 \begin_inset Quotes erd
26445 >Second item.</itemtag>
26448 \begin_layout LyX-Code
26454 \begin_layout Standard
26455 Note the different orders of
26456 \begin_inset Flex Code
26459 \begin_layout Plain Layout
26466 \begin_inset Flex Code
26469 \begin_layout Plain Layout
26476 Which order we get depends upon the setting of
26477 \begin_inset Flex Code
26480 \begin_layout Plain Layout
26488 \begin_inset Flex Code
26491 \begin_layout Plain Layout
26497 is false (the default),
26498 you get the first of these,
26499 with the label within the item;
26501 you get the second,
26502 with the label outside the item.
26505 \begin_layout Standard
26506 The specific tags and attributes output for each paragraph type can be controlled by means of the layout tags we are about to describe.
26507 As mentioned earlier,
26510 uses sensible defaults for many of these,
26511 so you often may not need to do very much to get good XHTML output.
26512 Think of the available tags as there so you can tweak things to your liking.
26515 \begin_layout Description
26516 \begin_inset Flex Code
26519 \begin_layout Plain Layout
26526 \begin_inset Flex Code
26529 \begin_layout Plain Layout
26535 ] Specifies attribute information to be output with the main tag.
26538 \begin_inset Quotes eld
26542 \begin_inset Flex Code
26545 \begin_layout Plain Layout
26552 \begin_inset Quotes erd
26559 \begin_inset Quotes eld
26563 \begin_inset Flex Code
26566 \begin_layout Plain Layout
26573 \begin_inset Quotes erd
26578 \begin_inset Flex Code
26581 \begin_layout Plain Layout
26587 is the \SpecialChar LyX
26588 name of the layout,
26596 contain any style information.
26598 \begin_inset Flex Code
26601 \begin_layout Plain Layout
26610 \begin_layout Description
26611 \begin_inset Flex Code
26614 \begin_layout Plain Layout
26621 \begin_inset Flex Code
26624 \begin_layout Plain Layout
26630 ] The CSS class to use for this paragraph.
26632 if the paragarph is of enumerate or itemize type,
26633 then the default will be
26634 \begin_inset Quotes eld
26638 \begin_inset Quotes erd
26642 \begin_inset Quotes eld
26646 \begin_inset Quotes erd
26651 \begin_inset Quotes eld
26655 \begin_inset Quotes erd
26660 \begin_inset Quotes eld
26664 \begin_inset Quotes erd
26669 \begin_inset Quotes eld
26673 \begin_inset Quotes erd
26678 \begin_inset Quotes eld
26682 \begin_inset Quotes erd
26686 depending upon the depth.
26687 That can be over-ridden here.
26689 the suffix will not be added in that case.
26691 the CSS class will always be exactly what it is declared to be here.
26694 \begin_layout Description
26695 \begin_inset Flex Code
26698 \begin_layout Plain Layout
26705 \begin_inset Flex Code
26708 \begin_layout Plain Layout
26718 ] Whether to output the default CSS information \SpecialChar LyX
26719 generates for this layout,
26720 even if additional information is explicitly provided via
26721 \begin_inset Flex Code
26724 \begin_layout Plain Layout
26732 \begin_inset Flex Code
26735 \begin_layout Plain Layout
26741 allows you to alter or augment the generated CSS,
26742 rather than to override it completely.
26744 \begin_inset Flex Code
26747 \begin_layout Plain Layout
26756 \begin_layout Description
26757 \begin_inset Flex Code
26760 \begin_layout Plain Layout
26767 \begin_inset Flex Code
26770 \begin_layout Plain Layout
26778 ] Whether to include this paragraph (usually,
26779 a section or something of the sort) in the TOC.
26782 so it should be set to false e.g.
26783 \begin_inset space ~
26786 for starred sections.
26789 \begin_layout Description
26790 \begin_inset Flex Code
26793 \begin_layout Plain Layout
26800 \begin_inset Flex Code
26803 \begin_layout Plain Layout
26809 ] The tag to be used for individual paragraphs of environments,
26811 \begin_inset Flex Code
26814 \begin_layout Plain Layout
26820 in the examples above.
26822 \begin_inset Flex Code
26825 \begin_layout Plain Layout
26834 \begin_layout Description
26835 \begin_inset Flex Code
26838 \begin_layout Plain Layout
26845 \begin_inset Flex Code
26848 \begin_layout Plain Layout
26854 ] Attributes for the item tag.
26856 \begin_inset Newline newline
26860 \begin_inset Quotes eld
26864 \begin_inset Flex Code
26867 \begin_layout Plain Layout
26868 class=`layoutname_item'
26874 \begin_inset Quotes erd
26882 contain any style information.
26884 \begin_inset Flex Code
26887 \begin_layout Plain Layout
26896 \begin_layout Description
26897 \begin_inset Flex Code
26900 \begin_layout Plain Layout
26907 \begin_inset Flex Code
26910 \begin_layout Plain Layout
26916 ] The tag to be used for paragraph and item labels,
26918 \begin_inset Flex Code
26921 \begin_layout Plain Layout
26927 in the examples above.
26929 \begin_inset Flex Code
26932 \begin_layout Plain Layout
26940 \begin_inset Flex Code
26943 \begin_layout Plain Layout
26950 \begin_inset Flex Code
26953 \begin_layout Plain Layout
26960 \begin_inset Flex Code
26963 \begin_layout Plain Layout
26964 Centered_Top_Environment
26970 in which case it defaults to
26971 \begin_inset Flex Code
26974 \begin_layout Plain Layout
26983 \begin_layout Description
26984 \begin_inset Flex Code
26987 \begin_layout Plain Layout
26994 \begin_inset Flex Code
26997 \begin_layout Plain Layout
27003 ] Attributes for the label tag.
27005 \begin_inset Newline newline
27009 \begin_inset Quotes eld
27013 \begin_inset Flex Code
27016 \begin_layout Plain Layout
27017 class=`layoutname_label'
27023 \begin_inset Quotes erd
27031 contain any style information.
27033 \begin_inset Flex Code
27036 \begin_layout Plain Layout
27045 \begin_layout Description
27046 \begin_inset Flex Code
27049 \begin_layout Plain Layout
27056 \begin_inset Flex Code
27059 \begin_layout Plain Layout
27069 ] Meaningful only for list-like environments,
27070 this tag controls whether the label tag is output before or inside the item tag.
27073 in the description environment,
27075 \begin_inset Flex Code
27078 \begin_layout Plain Layout
27079 <dt>\SpecialChar ldots
27080 </dt><dd>\SpecialChar ldots
27088 \begin_inset Flex Code
27091 \begin_layout Plain Layout
27098 The label tag is output inside the item tag.
27101 \begin_layout Description
27102 \begin_inset Flex Code
27105 \begin_layout Plain Layout
27111 Information to be output in the
27112 \begin_inset Flex Code
27115 \begin_layout Plain Layout
27121 section when this style is used.
27124 be used to include a
27125 \begin_inset Flex Code
27128 \begin_layout Plain Layout
27135 \begin_inset Flex Code
27138 \begin_layout Plain Layout
27147 \begin_layout Description
27148 \begin_inset Flex Code
27151 \begin_layout Plain Layout
27157 CSS style information to be included when this style is used.
27158 Note that this will automatically be wrapped in a layout-generated
27159 \begin_inset Flex Code
27162 \begin_layout Plain Layout
27169 so only the CSS itself need be included.
27171 \begin_inset Flex Code
27174 \begin_layout Plain Layout
27183 \begin_layout Description
27184 \begin_inset Flex Code
27187 \begin_layout Plain Layout
27194 \begin_inset Flex Code
27197 \begin_layout Plain Layout
27203 ] The tag to be used for the main label,
27205 \begin_inset Flex Code
27208 \begin_layout Plain Layout
27214 in the examples above.
27216 \begin_inset Flex Code
27219 \begin_layout Plain Layout
27228 \begin_layout Description
27229 \begin_inset Flex Code
27232 \begin_layout Plain Layout
27239 \begin_inset Flex Code
27242 \begin_layout Plain Layout
27252 ] Marks this style as the one to be used to generate the
27253 \begin_inset Flex Code
27256 \begin_layout Plain Layout
27262 tag for the XHTML file.
27266 \begin_inset Flex Code
27269 \begin_layout Plain Layout
27275 file sets it to true for the
27276 \begin_inset Flex Code
27279 \begin_layout Plain Layout
27289 \begin_layout Subsection
27293 \begin_layout Standard
27294 The XHTML output of insets can also be controlled by information in layout files.
27298 \begin_layout Plain Layout
27300 this is true only for
27301 \begin_inset Quotes eld
27305 \begin_inset Quotes erd
27308 insets (insets you can type into) and is not true for
27309 \begin_inset Quotes eld
27313 \begin_inset Quotes erd
27316 insets (insets that are associated with dialog boxes).
27324 tries to provide sensible defaults,
27325 and it constructs default CSS style rules.
27326 But everything can be customized.
27329 \begin_layout Standard
27330 The XHTML \SpecialChar LyX
27331 outputs for an inset has the following form:
27334 \begin_layout LyX-Code
27336 \begin_inset Quotes erd
27340 \begin_inset Quotes erd
27346 \begin_layout LyX-Code
27347 <labeltag>Label</labeltag>
27350 \begin_layout LyX-Code
27352 \begin_inset Quotes erd
27356 \begin_inset Quotes erd
27359 >Contents of the inset.</innertag>
27362 \begin_layout LyX-Code
27366 \begin_layout Standard
27367 If the inset permits multiple paragraphs—
27370 \begin_inset Flex Code
27373 \begin_layout Plain Layout
27380 then the contents of the inset will itself be output as paragraphs formatted according to the styles used for those paragraphs (standard,
27383 The label tag is of course omitted if the paragraph does not have a label and,
27386 \begin_inset Flex Code
27389 \begin_layout Plain Layout
27396 The inner tag is optional and,
27401 \begin_layout Standard
27402 The specific tags and attributes output for each inset can be controlled by means of the following layout tags.
27405 \begin_layout Description
27406 \begin_inset Flex Code
27409 \begin_layout Plain Layout
27416 \begin_inset Flex Code
27419 \begin_layout Plain Layout
27425 ] Specifies attribute information to be output with the main tag.
27428 \begin_inset Quotes eld
27432 \begin_inset Flex Code
27435 \begin_layout Plain Layout
27436 class=`myinset' onclick=`\SpecialChar ldots
27443 \begin_inset Quotes erd
27450 \begin_inset Quotes eld
27454 \begin_inset Flex Code
27457 \begin_layout Plain Layout
27464 \begin_inset Quotes erd
27469 \begin_inset Flex Code
27472 \begin_layout Plain Layout
27478 is the \SpecialChar LyX
27480 made lowercase and with non-alphanumeric characters converted to underscores,
27485 \begin_layout Description
27486 \begin_inset Flex Code
27489 \begin_layout Plain Layout
27496 \begin_inset Flex Code
27499 \begin_layout Plain Layout
27509 ] Whether to output the default CSS information \SpecialChar LyX
27510 generates for this layout,
27511 even if additional information is explicitly provided via
27512 \begin_inset Flex Code
27515 \begin_layout Plain Layout
27523 \begin_inset Flex Code
27526 \begin_layout Plain Layout
27532 allows you to alter or augment the generated CSS,
27533 rather than to override it completely.
27537 \begin_layout Description
27538 \begin_inset Flex Code
27541 \begin_layout Plain Layout
27548 \begin_inset Flex Code
27551 \begin_layout Plain Layout
27557 ] Attributes for the inner tag.
27559 \begin_inset Newline newline
27563 \begin_inset Quotes eld
27567 \begin_inset Flex Code
27570 \begin_layout Plain Layout
27571 class=`insetname_inner'
27577 \begin_inset Quotes erd
27583 \begin_layout Description
27584 \begin_inset Flex Code
27587 \begin_layout Plain Layout
27594 \begin_inset Flex Code
27597 \begin_layout Plain Layout
27605 \begin_inset Flex Code
27608 \begin_layout Plain Layout
27614 in the examples above.
27619 \begin_layout Description
27620 \begin_inset Flex Code
27623 \begin_layout Plain Layout
27630 \begin_inset Flex Code
27633 \begin_layout Plain Layout
27641 ] 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).
27645 \begin_layout Description
27646 \begin_inset Flex Code
27649 \begin_layout Plain Layout
27656 \begin_inset Flex Code
27659 \begin_layout Plain Layout
27665 ] A label for this inset,
27666 possibly including a reference to a counter.
27671 \begin_inset Flex Code
27674 \begin_layout Plain Layout
27684 and there is no default.
27687 \begin_layout Description
27688 \begin_inset Flex Code
27691 \begin_layout Plain Layout
27697 Information to be output in the
27698 \begin_inset Flex Code
27701 \begin_layout Plain Layout
27707 section when this style is used.
27710 be used to include a
27711 \begin_inset Flex Code
27714 \begin_layout Plain Layout
27721 \begin_inset Flex Code
27724 \begin_layout Plain Layout
27733 \begin_layout Description
27734 \begin_inset Flex Code
27737 \begin_layout Plain Layout
27743 CSS style information to be included when this style is used.
27744 Note that this will automatically be wrapped in a layout-generated
27745 \begin_inset Flex Code
27748 \begin_layout Plain Layout
27755 so only the CSS itself need be included.
27758 \begin_layout Description
27759 \begin_inset Flex Code
27762 \begin_layout Plain Layout
27769 \begin_inset Flex Code
27772 \begin_layout Plain Layout
27778 ] The tag to be used for the main label,
27780 \begin_inset Flex Code
27783 \begin_layout Plain Layout
27789 in the examples above.
27790 The default depends upon the setting of
27791 \begin_inset Flex Code
27794 \begin_layout Plain Layout
27802 \begin_inset Flex Code
27805 \begin_layout Plain Layout
27813 \begin_inset Flex Code
27816 \begin_layout Plain Layout
27825 \begin_inset Flex Code
27828 \begin_layout Plain Layout
27837 \begin_layout Subsection
27841 \begin_layout Standard
27842 The XHTML output for floats too can be controlled by layout information.
27843 The output has the following form:
27846 \begin_layout LyX-Code
27848 \begin_inset Quotes erd
27852 \begin_inset Quotes erd
27858 \begin_layout LyX-Code
27859 Contents of the float.
27862 \begin_layout LyX-Code
27866 \begin_layout Standard
27869 is a separate inset and will be output as such.
27870 Its appearance can be controlled via the InsetLayout for caption insets.
27874 \begin_layout Description
27875 \begin_inset Flex Code
27878 \begin_layout Plain Layout
27885 \begin_inset Flex Code
27888 \begin_layout Plain Layout
27894 ] Specifies attribute information to be output with the main tag.
27897 \begin_inset Quotes eld
27901 \begin_inset Flex Code
27904 \begin_layout Plain Layout
27905 class=`myfloat' onclick=`\SpecialChar ldots
27912 \begin_inset Quotes erd
27919 \begin_inset Quotes eld
27923 \begin_inset Flex Code
27926 \begin_layout Plain Layout
27927 class=`float float-floattype'
27933 \begin_inset Quotes erd
27938 \begin_inset Flex Code
27941 \begin_layout Plain Layout
27947 is \SpecialChar LyX
27948 's name for this type of float,
27949 as determined by the float declaration (see
27950 \begin_inset CommandInset ref
27952 reference "subsec:Floats"
27958 though made lowercase and with non-alphanumeric characters converted to underscores,
27963 \begin_layout Description
27964 \begin_inset Flex Code
27967 \begin_layout Plain Layout
27973 CSS style information to be included when this float is used.
27974 Note that this will automatically be wrapped in a layout-generated
27975 \begin_inset Flex Code
27978 \begin_layout Plain Layout
27985 so only the CSS itself need be included.
27988 \begin_layout Description
27989 \begin_inset Flex Code
27992 \begin_layout Plain Layout
27999 \begin_inset Flex Code
28002 \begin_layout Plain Layout
28008 ] The tag to be used for this float,
28010 \begin_inset Quotes eld
28014 \begin_inset Flex Code
28017 \begin_layout Plain Layout
28024 \begin_inset Quotes erd
28027 in the example above.
28029 \begin_inset Flex Code
28032 \begin_layout Plain Layout
28038 and will rarely need changing.
28041 \begin_layout Subsection
28042 Bibliography formatting
28045 \begin_layout Standard
28046 The bibliography can be formatted using
28047 \begin_inset Flex Code
28050 \begin_layout Plain Layout
28058 \begin_inset CommandInset ref
28060 reference "subsec:Citation-format-description"
28068 \begin_layout Subsection
28073 \begin_layout Standard
28074 We have several times mentioned that \SpecialChar LyX
28075 will generate default CSS style rules for both insets and paragraph styles,
28076 based upon the other layout information that is provided.
28078 we shall say a word about which layout information \SpecialChar LyX
28082 \begin_layout Standard
28085 auto-generates CSS only for font information,
28087 \begin_inset Flex Code
28090 \begin_layout Plain Layout
28098 \begin_inset Flex Code
28101 \begin_layout Plain Layout
28109 \begin_inset Flex Code
28112 \begin_layout Plain Layout
28120 \begin_inset Flex Code
28123 \begin_layout Plain Layout
28130 \begin_inset Flex Code
28133 \begin_layout Plain Layout
28140 \begin_inset CommandInset ref
28142 reference "subsec:Font-description"
28148 The translation is mostly straightforward and obvious.
28151 \begin_inset Quotes eld
28155 \begin_inset Flex Code
28158 \begin_layout Plain Layout
28165 \begin_inset Quotes erd
28169 \begin_inset Quotes eld
28173 \begin_inset Flex Code
28176 \begin_layout Plain Layout
28184 \begin_inset Quotes erd
28188 The correspondence of \SpecialChar LyX
28189 sizes and CSS sizes is a little less obvious but nonetheless intuitive.
28191 \begin_inset Flex Code
28194 \begin_layout Plain Layout
28201 \begin_inset Flex URL
28204 \begin_layout Plain Layout
28214 \begin_layout Section
28215 \begin_inset CommandInset label
28217 name "sec:Tags-for-DocBook"
28221 Tags for DocBook output
28224 \begin_layout Standard
28225 As with \SpecialChar LaTeX
28227 the format of \SpecialChar LyX
28228 's DocBook output is also controlled by layout information.
28231 provides sensible defaults;
28233 much of the styling is lost during the conversion,
28234 as DocBook is strictly semantic and does not allow formatting.
28236 information from \SpecialChar LyX
28237 will be rendered in
28244 \begin_layout Standard
28247 you may not have to do anything at all to get acceptable DocBook output for your own environments,
28250 But in some cases you will,
28251 and so \SpecialChar LyX
28252 provides a number of layout tags that can be used to customize the DocBook that is generated.
28255 \begin_layout Standard
28256 Labels are rarely output,
28257 as they are redundant in DocBook:
28258 this information is carried by the tags themselves,
28259 and whether labels appear in the final documents (after processing of DocBook files) is controlled by the stylesheets.
28262 labels are not redundant content,
28263 such as definition lists:
28265 the term being defined will be the label.
28268 \begin_layout Subsection
28269 \begin_inset CommandInset label
28271 name "subsec:Paragraph-Style-DocBook"
28278 \begin_layout Standard
28279 The sort of DocBook \SpecialChar LyX
28280 outputs for a paragraph depends upon whether we are dealing with a normal paragraph,
28283 where this is itself determined by the contents of the corresponding
28284 \begin_inset Flex Code
28287 \begin_layout Plain Layout
28297 \begin_layout Standard
28298 For a command or normal paragraph,
28299 the output DocBook has the following form:
28302 \begin_layout LyX-Code
28306 \begin_layout LyX-Code
28307 Contents of the paragraph.
28310 \begin_layout LyX-Code
28314 \begin_layout Standard
28315 For an environment that is not some sort of list,
28316 the generated DocBook takes this form:
28319 \begin_layout LyX-Code
28323 \begin_layout LyX-Code
28324 <itemtag>First paragraph.</itemtag>
28327 \begin_layout LyX-Code
28328 <itemtag>Second paragraph.</itemtag>
28331 \begin_layout LyX-Code
28335 \begin_layout Standard
28337 the resulting DocBook takes this form:
28340 \begin_layout LyX-Code
28344 \begin_layout LyX-Code
28345 <itemtag attr>First item.</itemtag>
28348 \begin_layout LyX-Code
28349 <itemtag attr>Second item.</itemtag>
28352 \begin_layout LyX-Code
28356 \begin_layout Standard
28357 The specific tags and roles output for each paragraph type can be controlled by means of the layout tags we are about to describe.
28359 due to the very nature of DocBook,
28360 no sensible defaults really exist,
28361 and the values must always be carefully chosen.
28364 \begin_layout Description
28365 \begin_inset Flex Code
28368 \begin_layout Plain Layout
28375 \begin_inset Flex Code
28378 \begin_layout Plain Layout
28384 ] Specifies attribute information to be output with the main tag,
28386 \begin_inset Quotes eld
28390 \begin_inset Flex Code
28393 \begin_layout Plain Layout
28400 \begin_inset Quotes erd
28403 in the example above.
28404 This information can be used in further processing of the DocBook files.
28407 \begin_layout Description
28408 \begin_inset Flex Code
28411 \begin_layout Plain Layout
28418 \begin_inset Flex Code
28421 \begin_layout Plain Layout
28427 ] The tag to be used for this inset,
28429 \begin_inset Quotes eld
28433 \begin_inset Flex Code
28436 \begin_layout Plain Layout
28443 \begin_inset Quotes erd
28446 in the example above.
28447 The default is the name of the float and always needs to be changed,
28448 as DocBook provides no generic tag.
28451 \begin_layout Description
28452 \begin_inset Flex Code
28455 \begin_layout Plain Layout
28462 \begin_inset Flex Code
28465 \begin_layout Plain Layout
28473 ] The new-line policy for this tag,
28475 \begin_inset space ~
28479 \begin_inset CommandInset ref
28481 reference "subsec:DocBook-New-line-policy"
28492 \begin_layout Subsection
28494 \begin_inset CommandInset label
28496 name "subsec:DocBook-New-line-policy"
28503 \begin_layout Standard
28505 there are three possible policies for outputting new lines (given in the
28506 \begin_inset Flex Code
28509 \begin_layout Plain Layout
28518 \begin_layout Itemize
28519 \begin_inset Quotes eld
28523 \begin_inset Flex Code
28526 \begin_layout Plain Layout
28533 \begin_inset Quotes erd
28537 the opening and closing tags are on their own lines (i.e.
28538 a line feed after and before the opening and the closing tags).
28539 Typical elements are floats.
28543 \begin_layout LyX-Code
28547 \begin_layout LyX-Code
28551 \begin_layout LyX-Code
28552 Contents of the block.
28555 \begin_layout LyX-Code
28559 \begin_layout LyX-Code
28563 \begin_layout Itemize
28564 \begin_inset Quotes eld
28568 \begin_inset Flex Code
28571 \begin_layout Plain Layout
28578 \begin_inset Quotes erd
28582 the opening and closing tags are on the same,
28584 a line feed is output before the opening tag and after the closing tag.
28585 Typical elements are paragraphs and list items.
28589 \begin_layout LyX-Code
28593 \begin_layout LyX-Code
28594 <paratag>Contents of the paragraph.</paratag>
28597 \begin_layout LyX-Code
28601 \begin_layout Itemize
28602 \begin_inset Quotes eld
28606 \begin_inset Flex Code
28609 \begin_layout Plain Layout
28616 \begin_inset Quotes erd
28620 the opening and closing tags are on the same line as the rest of the content.
28621 No line feeds are output.
28622 Typical elements are fonts.
28626 \begin_layout LyX-Code
28627 Content before<inlinetag>Contents of the paragraph.</inlinetag>Content after
28630 \begin_layout Standard
28631 The default value is always
28632 \begin_inset Quotes eld
28636 \begin_inset Flex Code
28639 \begin_layout Plain Layout
28646 \begin_inset Quotes erd
28652 \begin_layout Subsection
28653 InsetLayout DocBook
28656 \begin_layout Standard
28657 The DocBook output of insets can also be controlled by information in layout files.
28660 \begin_layout Standard
28661 The DocBook \SpecialChar LyX
28662 outputs for an inset has the following form:
28665 \begin_layout LyX-Code
28666 <wrappertag wrapperattr>
28669 \begin_layout LyX-Code
28673 \begin_layout LyX-Code
28674 <innertag innerattr>
28677 \begin_layout LyX-Code
28678 Contents of the inset.
28681 \begin_layout LyX-Code
28685 \begin_layout LyX-Code
28689 \begin_layout LyX-Code
28693 \begin_layout Standard
28694 For an itemising inset,
28695 it rather looks like this:
28698 \begin_layout LyX-Code
28699 <wrappertag wrapperattr>
28702 \begin_layout LyX-Code
28706 \begin_layout LyX-Code
28707 <innertag innerattr>
28710 \begin_layout LyX-Code
28711 <itemwrappertag itemwrapperattr>
28714 \begin_layout LyX-Code
28715 <itemlabeltag itemattr>
28718 \begin_layout LyX-Code
28719 Label of the first item.
28722 \begin_layout LyX-Code
28726 \begin_layout LyX-Code
28730 \begin_layout LyX-Code
28734 \begin_layout LyX-Code
28735 Contents of the first item.
28738 \begin_layout LyX-Code
28742 \begin_layout LyX-Code
28746 \begin_layout LyX-Code
28750 \begin_layout LyX-Code
28751 <itemwrappertag itemwrapperattr>
28754 \begin_layout LyX-Code
28755 <itemlabeltag itemattr>
28758 \begin_layout LyX-Code
28759 Label of the second item.
28762 \begin_layout LyX-Code
28766 \begin_layout LyX-Code
28770 \begin_layout LyX-Code
28774 \begin_layout LyX-Code
28775 Contents of the second item.
28778 \begin_layout LyX-Code
28782 \begin_layout LyX-Code
28786 \begin_layout LyX-Code
28790 \begin_layout LyX-Code
28794 \begin_layout LyX-Code
28798 \begin_layout LyX-Code
28802 \begin_layout LyX-Code
28806 \begin_layout Standard
28807 If the inset permits multiple paragraphs—
28810 \begin_inset Flex Code
28813 \begin_layout Plain Layout
28820 then the contents of the inset will themselves be output as paragraphs formatted according to the styles used for those paragraphs (standard,
28823 The inner tag is optional and,
28828 \begin_layout Standard
28829 The specific tags and attributes output for each inset can be controlled by means of the following layout tags.
28832 \begin_layout Description
28833 \begin_inset Flex Code
28836 \begin_layout Plain Layout
28843 \begin_inset Flex Code
28846 \begin_layout Plain Layout
28852 ] Specifies attribute information to be output with the main tag,
28854 \begin_inset Quotes eld
28858 \begin_inset Flex Code
28861 \begin_layout Plain Layout
28868 \begin_inset Quotes erd
28871 in the example above.
28872 This information can be used in further processing of the DocBook files.
28875 \begin_layout Description
28876 \begin_inset Flex Code
28879 \begin_layout Plain Layout
28886 \begin_inset Flex Code
28889 \begin_layout Plain Layout
28897 ] Specifies whether this tag goes into the
28898 \begin_inset Flex Code
28901 \begin_layout Plain Layout
28907 tag at the beginning of the parent layout.
28909 \begin_inset Flex Code
28912 \begin_layout Plain Layout
28918 indicates that the tag never goes into
28919 \begin_inset Flex Code
28922 \begin_layout Plain Layout
28928 (this is default value,
28929 and corresponds to usual content).
28931 \begin_inset Flex Code
28934 \begin_layout Plain Layout
28940 indicates that the tag always goes into
28941 \begin_inset Flex Code
28944 \begin_layout Plain Layout
28950 (this corresponds to usual metadata):
28952 \begin_inset Flex Code
28955 \begin_layout Plain Layout
28961 tag for the parent,
28968 \begin_inset Flex Code
28971 \begin_layout Plain Layout
28977 indicates that the tag may go into
28978 \begin_inset Flex Code
28981 \begin_layout Plain Layout
28987 (this is only the case for titles):
28989 \begin_inset Flex Code
28992 \begin_layout Plain Layout
28998 tag for the parent,
29004 the corresponding tag will be output directly as content.
29007 \begin_layout Description
29008 \begin_inset Flex Code
29011 \begin_layout Plain Layout
29018 \begin_inset Flex Code
29021 \begin_layout Plain Layout
29027 ] Specifies attribute information to be output with the item tag,
29029 \begin_inset Quotes eld
29033 \begin_inset Flex Code
29036 \begin_layout Plain Layout
29043 \begin_inset Quotes erd
29046 in the example above.
29047 This information can be used in further processing of the DocBook files.
29050 \begin_layout Description
29051 \begin_inset Flex Code
29054 \begin_layout Plain Layout
29055 DocBookItemInnerAttr
29061 \begin_inset Flex Code
29064 \begin_layout Plain Layout
29070 ] Specifies attribute information to be output with the item inner tag,
29072 \begin_inset Quotes eld
29076 \begin_inset Flex Code
29079 \begin_layout Plain Layout
29086 \begin_inset Quotes erd
29089 in the example above.
29090 This information can be used in further processing of the DocBook files.
29093 \begin_layout Description
29094 \begin_inset Flex Code
29097 \begin_layout Plain Layout
29098 DocBookItemInnerTag
29104 \begin_inset Flex Code
29107 \begin_layout Plain Layout
29113 ] The tag to be used for the item inner tag within the inset,
29115 \begin_inset Quotes eld
29119 \begin_inset Flex Code
29122 \begin_layout Plain Layout
29129 \begin_inset Quotes erd
29132 in the example above.
29134 \begin_inset Flex Code
29137 \begin_layout Plain Layout
29144 indicating that there is no item inner tag:
29145 content is directly output without it for each itemised element.
29146 This parameter only makes sense when itemising layouts are used,
29148 The most likely value is
29149 \begin_inset Quotes eld
29153 \begin_inset Flex Code
29156 \begin_layout Plain Layout
29163 \begin_inset Quotes erd
29167 \begin_inset Newline newline
29170 When a list item is split using a new line,
29171 the item inner tag will be repeated for each part of the paragraph,
29172 parts being separated by new lines.
29175 \begin_layout Description
29176 \begin_inset Flex Code
29179 \begin_layout Plain Layout
29180 DocBookItemInnerTagType
29186 \begin_inset Flex Code
29189 \begin_layout Plain Layout
29197 ] The new-line policy for this tag,
29199 \begin_inset space ~
29203 \begin_inset CommandInset ref
29205 reference "subsec:DocBook-New-line-policy"
29216 \begin_layout Description
29217 \begin_inset Flex Code
29220 \begin_layout Plain Layout
29221 DocBookItemLabelAttr
29227 \begin_inset Flex Code
29230 \begin_layout Plain Layout
29236 ] Specifies attribute information to be output with the item label tag,
29238 \begin_inset Quotes eld
29242 \begin_inset Flex Code
29245 \begin_layout Plain Layout
29252 \begin_inset Quotes erd
29255 in the example above.
29256 This information can be used in further processing of the DocBook files.
29259 \begin_layout Description
29260 \begin_inset Flex Code
29263 \begin_layout Plain Layout
29264 DocBookItemLabelTag
29270 \begin_inset Flex Code
29273 \begin_layout Plain Layout
29279 ] The tag to be used for the item label tag within the inset,
29281 \begin_inset Quotes eld
29285 \begin_inset Flex Code
29288 \begin_layout Plain Layout
29295 \begin_inset Quotes erd
29298 in the example above.
29299 This parameter only makes sense when itemising layouts are used with a notion of labels,
29300 such as definition lists.
29303 \begin_layout Description
29304 \begin_inset Flex Code
29307 \begin_layout Plain Layout
29308 DocBookItemLabelTagType
29314 \begin_inset Flex Code
29317 \begin_layout Plain Layout
29325 ] The new-line policy for this tag,
29327 \begin_inset space ~
29331 \begin_inset CommandInset ref
29333 reference "subsec:DocBook-New-line-policy"
29344 \begin_layout Description
29345 \begin_inset Flex Code
29348 \begin_layout Plain Layout
29355 \begin_inset Flex Code
29358 \begin_layout Plain Layout
29364 ] The tag to be used for the item tag within the inset,
29366 \begin_inset Quotes eld
29370 \begin_inset Flex Code
29373 \begin_layout Plain Layout
29380 \begin_inset Quotes erd
29383 in the example above.
29385 \begin_inset Flex Code
29388 \begin_layout Plain Layout
29395 indicating that there is no item tag.
29396 This parameter only makes sense when itemising layouts are used,
29400 \begin_layout Description
29401 \begin_inset Flex Code
29404 \begin_layout Plain Layout
29411 \begin_inset Flex Code
29414 \begin_layout Plain Layout
29422 ] The new-line policy for this tag,
29424 \begin_inset space ~
29428 \begin_inset CommandInset ref
29430 reference "subsec:DocBook-New-line-policy"
29441 \begin_layout Description
29442 \begin_inset Flex Code
29445 \begin_layout Plain Layout
29446 DocBookItemWrapperAttr
29452 \begin_inset Flex Code
29455 \begin_layout Plain Layout
29461 ] Specifies attribute information to be output with the item wrapper tag,
29463 \begin_inset Quotes eld
29467 \begin_inset Flex Code
29470 \begin_layout Plain Layout
29477 \begin_inset Quotes erd
29480 in the example above.
29481 This information can be used in further processing of the DocBook files.
29484 \begin_layout Description
29485 \begin_inset Flex Code
29488 \begin_layout Plain Layout
29489 DocBookItemWrapperTag
29495 \begin_inset Flex Code
29498 \begin_layout Plain Layout
29504 ] The tag to be used for the item wrapper tag within the inset,
29506 \begin_inset Quotes eld
29510 \begin_inset Flex Code
29513 \begin_layout Plain Layout
29520 \begin_inset Quotes erd
29523 in the example above.
29525 \begin_inset Flex Code
29528 \begin_layout Plain Layout
29535 indicating that there is no item wrapper tag:
29536 tag and content are directly output without it for each itemised element.
29537 This parameter only makes sense when itemising layouts are used,
29541 \begin_layout Description
29542 \begin_inset Flex Code
29545 \begin_layout Plain Layout
29546 DocBookItemWrapperTagType
29552 \begin_inset Flex Code
29555 \begin_layout Plain Layout
29563 ] The new-line policy for this tag,
29565 \begin_inset space ~
29569 \begin_inset CommandInset ref
29571 reference "subsec:DocBook-New-line-policy"
29582 \begin_layout Description
29583 \begin_inset Flex Code
29586 \begin_layout Plain Layout
29593 \begin_inset Flex Code
29596 \begin_layout Plain Layout
29602 ] Specifies attribute information to be output with the inner tag,
29604 \begin_inset Quotes eld
29608 \begin_inset Flex Code
29611 \begin_layout Plain Layout
29618 \begin_inset Quotes erd
29621 in the example above.
29622 This information can be used in further processing of the DocBook files.
29625 \begin_layout Description
29626 \begin_inset Flex Code
29629 \begin_layout Plain Layout
29636 \begin_inset Flex Code
29639 \begin_layout Plain Layout
29645 ] The tag to be used for the inner tag within the inset,
29647 \begin_inset Quotes eld
29651 \begin_inset Flex Code
29654 \begin_layout Plain Layout
29661 \begin_inset Quotes erd
29664 in the example above.
29666 \begin_inset Flex Code
29669 \begin_layout Plain Layout
29676 indicating that there is no inner tag:
29677 content is directly output without it.
29680 \begin_layout Description
29681 \begin_inset Flex Code
29684 \begin_layout Plain Layout
29685 DocBookInnerTagType
29691 \begin_inset Flex Code
29694 \begin_layout Plain Layout
29702 ] The new-line policy for this tag,
29704 \begin_inset space ~
29708 \begin_inset CommandInset ref
29710 reference "subsec:DocBook-New-line-policy"
29721 \begin_layout Description
29722 \begin_inset Flex Code
29725 \begin_layout Plain Layout
29732 \begin_inset Flex Code
29735 \begin_layout Plain Layout
29741 ] Specifies the tag that corresponds to this kind of section.
29742 This parameter only makes sense for sectioning elements (part,
29746 The default value is
29747 \begin_inset Flex Code
29750 \begin_layout Plain Layout
29757 and is only overridden when DocBook uses something else for sectioning (typically,
29758 parts and chapters of a book).
29761 \begin_layout Description
29762 \begin_inset Flex Code
29765 \begin_layout Plain Layout
29772 \begin_inset Flex Code
29775 \begin_layout Plain Layout
29781 ] The tag to be used for this inset,
29783 \begin_inset Quotes eld
29787 \begin_inset Flex Code
29790 \begin_layout Plain Layout
29797 \begin_inset Quotes erd
29800 in the example above.
29801 The default is the name of the float and always needs to be changed,
29802 as DocBook provides no generic inset tag.
29805 \begin_layout Description
29806 \begin_inset Flex Code
29809 \begin_layout Plain Layout
29816 \begin_inset Flex Code
29819 \begin_layout Plain Layout
29827 ] The new-line policy for this tag,
29829 \begin_inset space ~
29833 \begin_inset CommandInset ref
29835 reference "subsec:DocBook-New-line-policy"
29846 \begin_layout Description
29847 \begin_inset Flex Code
29850 \begin_layout Plain Layout
29857 \begin_inset Flex Code
29860 \begin_layout Plain Layout
29866 ] Specifies attribute information to be output with the outer wrapper tag,
29868 \begin_inset Quotes eld
29872 \begin_inset Flex Code
29875 \begin_layout Plain Layout
29882 \begin_inset Quotes erd
29885 in the example above.
29886 This information can be used in further processing of the DocBook files.
29889 \begin_layout Description
29890 \begin_inset Flex Code
29893 \begin_layout Plain Layout
29900 \begin_inset Flex Code
29903 \begin_layout Plain Layout
29909 ] The tag to be used for the wrapper tag around the inset,
29911 \begin_inset Quotes eld
29915 \begin_inset Flex Code
29918 \begin_layout Plain Layout
29925 \begin_inset Quotes erd
29928 in the example above.
29930 \begin_inset Flex Code
29933 \begin_layout Plain Layout
29940 indicating that there is no wrapper tag:
29941 tag and content are directly output without it.
29944 \begin_layout Description
29945 \begin_inset Flex Code
29948 \begin_layout Plain Layout
29949 DocBookWrapperTagType
29955 \begin_inset Flex Code
29958 \begin_layout Plain Layout
29966 ] The new-line policy for this tag,
29968 \begin_inset space ~
29972 \begin_inset CommandInset ref
29974 reference "subsec:DocBook-New-line-policy"
29985 \begin_layout Subsection
29989 \begin_layout Standard
29990 The DocBook output for floats too can be controlled by layout information.
29991 The output has the following form:
29994 \begin_layout LyX-Code
29998 \begin_layout LyX-Code
29999 Contents of the float as DocBook.
30002 \begin_layout LyX-Code
30006 \begin_layout Standard
30009 is a separate inset and will be output as a title.
30012 \begin_layout Description
30013 \begin_inset Flex Code
30016 \begin_layout Plain Layout
30023 \begin_inset Flex Code
30026 \begin_layout Plain Layout
30032 ] Specifies attribute information to be output with the main tag,
30034 \begin_inset Quotes eld
30038 \begin_inset Flex Code
30041 \begin_layout Plain Layout
30048 \begin_inset Quotes erd
30051 in the example above.
30052 This information can be used in further processing of the DocBook files.
30055 \begin_layout Description
30056 \begin_inset Flex Code
30059 \begin_layout Plain Layout
30066 \begin_inset Flex Code
30069 \begin_layout Plain Layout
30075 ] The tag to be used for this float,
30077 \begin_inset Quotes eld
30081 \begin_inset Flex Code
30084 \begin_layout Plain Layout
30091 \begin_inset Quotes erd
30094 in the example above.
30095 The default is the name of the float and always needs to be changed,
30096 as DocBook provides no generic float tag.
30099 \begin_layout Subsection
30100 Bibliography formatting
30103 \begin_layout Standard
30104 Included bibliographies cannot be formatted:
30105 all fields are always output in the database-like DocBook format (equivalent to a BibTeX file),
30107 \begin_inset Flex Code
30110 \begin_layout Plain Layout
30119 \begin_layout Standard
30120 When the bibliographic entries are manually inserted into the \SpecialChar LyX
30121 document as Bibliography Items,
30122 the user deals with formatting themself:
30123 there is no attempt of parsing what the user wrote,
30124 the string is directly used (with the
30125 \begin_inset Flex Code
30128 \begin_layout Plain Layout
30137 \begin_layout Chapter
30138 Including External Material
30139 \begin_inset CommandInset label
30141 name "chap:Including-External-Material"
30148 \begin_layout Standard
30149 \begin_inset Box Shadowbox
30159 height_special "totalheight"
30164 backgroundcolor "none"
30167 \begin_layout Plain Layout
30169 This portion of the documentation has not been updated for some time.
30170 We certainly hope that it is still accurate,
30171 but there are no guarantees.
30179 \begin_layout Standard
30180 The use of material from sources external to \SpecialChar LyX
30181 is covered in detail in the
30186 This part of the manual covers what needs to happen behind the scenes for new sorts of material to be included.
30189 \begin_layout Section
30193 \begin_layout Standard
30194 The external material feature is based on the concept of a
30199 A template is a specification of how \SpecialChar LyX
30200 should interface with a certain kind of material.
30203 comes with predefined templates for Xfig figures,
30204 various raster format images,
30206 and LilyPond music notation.
30207 You can check the actual list by using the menu
30208 \begin_inset Flex Noun
30211 \begin_layout Plain Layout
30212 Insert\SpecialChar menuseparator
30213 File\SpecialChar menuseparator
30221 it is possible to roll your own template to support a specific kind of material.
30222 Later we'll describe in more detail what is involved,
30223 and hopefully you will submit all the templates you create so we can include them in a later \SpecialChar LyX
30227 \begin_layout Standard
30228 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.
30230 consider the case of a figure produced with
30231 \begin_inset Flex Code
30234 \begin_layout Plain Layout
30241 The Xfig application itself works on an original file with the
30242 \begin_inset Flex Code
30245 \begin_layout Plain Layout
30253 you create and change your figure,
30254 and when you are done,
30256 \begin_inset Flex Code
30259 \begin_layout Plain Layout
30266 When you want to include the figure in your document,
30268 \begin_inset Flex Code
30271 \begin_layout Plain Layout
30277 in order to create a PostScript file that can readily be included in your \SpecialChar LaTeX
30281 \begin_inset Flex Code
30284 \begin_layout Plain Layout
30290 file is the original file,
30291 and the PostScript file is the produced file.
30294 \begin_layout Standard
30295 This distinction is important in order to allow updating of the material while you are in the process of writing the document.
30297 it provides us with the flexibility that is needed to support multiple export formats.
30299 in the case of a plain text file,
30300 it is not exactly an award-winning idea to include the figure as raw PostScript.
30302 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.
30303 The external material management allows you to do this,
30304 because it is parametrized on the different export formats that \SpecialChar LyX
30308 \begin_layout Standard
30309 Besides supporting the production of different products according to the exported format,
30310 it supports tight integration with editing and viewing applications.
30311 In the case of an Xfig figure,
30312 you are able to invoke Xfig on the original file with a single click from within the external material dialog in \SpecialChar LyX
30314 and also preview the produced PostScript file with Ghostview with another click.
30315 No more fiddling around with the command line and/or file browsers to locate and manipulate the original or produced files.
30317 you are finally able to take full advantage of the many different applications that are relevant to use when you write your documents,
30318 and ultimately be more productive.
30321 \begin_layout Section
30322 The external template configuration files
30325 \begin_layout Standard
30326 It is relatively easy to add custom external template definitions to \SpecialChar LyX
30329 be aware that doing this in an careless manner most probably
30333 introduce an easily exploitable security hole.
30334 So before you do this,
30335 please read the discussion about security in
30336 \begin_inset CommandInset ref
30338 reference "sec:Security-discussion"
30346 \begin_layout Standard
30348 we encourage you to submit any interesting templates that you create.
30352 \begin_layout Standard
30353 The external templates are defined in the
30354 \begin_inset Flex Code
30357 \begin_layout Plain Layout
30363 files that are stored in the
30364 \begin_inset Flex Code
30367 \begin_layout Plain Layout
30368 LyXDir/lib/xtemplates/
30374 Each template is defined in a file of its own.
30375 You can place your own templates in
30376 \begin_inset Flex Code
30379 \begin_layout Plain Layout
30380 UserDir/xtemplates/
30385 or copy existing templates to that directory in order to modify them.
30388 \begin_layout Standard
30389 A typical template looks like this:
30392 \begin_layout LyX-Code
30396 \begin_layout LyX-Code
30398 $$AbsOrRelPathParent$$Basename"
30401 \begin_layout LyX-Code
30405 \begin_layout LyX-Code
30409 \begin_layout LyX-Code
30413 \begin_layout LyX-Code
30417 \begin_layout LyX-Code
30421 \begin_layout LyX-Code
30422 AutomaticProduction true
30425 \begin_layout LyX-Code
30429 \begin_layout LyX-Code
30433 \begin_layout LyX-Code
30437 \begin_layout LyX-Code
30438 TransformCommand Rotate RotationLatexCommand
30441 \begin_layout LyX-Code
30442 TransformCommand Resize ResizeLatexCommand
30445 \begin_layout LyX-Code
30446 Product "$$RotateFront$$ResizeFront
30449 \begin_layout LyX-Code
30454 input{$$AbsOrRelPathMaster$$Basename.pstex_t}
30457 \begin_layout LyX-Code
30458 $$ResizeBack$$RotateBack"
30461 \begin_layout LyX-Code
30465 \begin_layout LyX-Code
30466 UpdateResult "$$AbsPath$$Basename.pstex_t"
30469 \begin_layout LyX-Code
30470 Requirement "graphicx"
30473 \begin_layout LyX-Code
30474 ReferencedFile latex "$$AbsOrRelPathMaster$$Basename.pstex_t"
30477 \begin_layout LyX-Code
30478 ReferencedFile latex "$$AbsPath$$Basename.eps"
30481 \begin_layout LyX-Code
30482 ReferencedFile dvi "$$AbsPath$$Basename.eps"
30485 \begin_layout LyX-Code
30489 \begin_layout LyX-Code
30493 \begin_layout LyX-Code
30494 TransformCommand Rotate RotationLatexCommand
30497 \begin_layout LyX-Code
30498 TransformCommand Resize ResizeLatexCommand
30501 \begin_layout LyX-Code
30502 Product "$$RotateFront$$ResizeFront
30505 \begin_layout LyX-Code
30510 input{$$AbsOrRelPathMaster$$Basename.pdftex_t}
30513 \begin_layout LyX-Code
30514 $$ResizeBack$$RotateBack"
30517 \begin_layout LyX-Code
30518 UpdateFormat pdftex
30521 \begin_layout LyX-Code
30522 UpdateResult "$$AbsPath$$Basename.pdftex_t"
30525 \begin_layout LyX-Code
30526 Requirement "graphicx"
30529 \begin_layout LyX-Code
30530 ReferencedFile latex "$$AbsOrRelPathMaster$$Basename.pdftex_t"
30533 \begin_layout LyX-Code
30534 ReferencedFile latex "$$AbsPath$$Basename.pdf"
30537 \begin_layout LyX-Code
30541 \begin_layout LyX-Code
30545 \begin_layout LyX-Code
30550 \begin_layout LyX-Code
30554 \begin_layout LyX-Code
30558 \begin_layout LyX-Code
30559 Product "<graphic fileref=
30561 "$$AbsOrRelPathMaster$$Basename.eps
30566 \begin_layout LyX-Code
30570 \begin_layout LyX-Code
30574 \begin_layout LyX-Code
30575 UpdateResult "$$AbsPath$$Basename.eps"
30578 \begin_layout LyX-Code
30579 ReferencedFile docbook "$$AbsPath$$Basename.eps"
30582 \begin_layout LyX-Code
30583 ReferencedFile docbook-xml "$$AbsPath$$Basename.eps"
30586 \begin_layout LyX-Code
30590 \begin_layout LyX-Code
30594 \begin_layout Standard
30596 the template is enclosed in
30597 \begin_inset Flex Code
30600 \begin_layout Plain Layout
30608 \begin_inset Flex Code
30611 \begin_layout Plain Layout
30618 It contains a header specifying some general settings and,
30619 for each supported primary document file format,
30621 \begin_inset Flex Code
30624 \begin_layout Plain Layout
30632 \begin_inset Flex Code
30635 \begin_layout Plain Layout
30644 \begin_layout Subsection
30645 The template header
30648 \begin_layout Description
30649 \begin_inset Flex Code
30652 \begin_layout Plain Layout
30653 AutomaticProduction
30654 \begin_inset space ~
30662 Whether the file represented by the template must be generated by \SpecialChar LyX
30664 This command must occur exactly once.
30667 \begin_layout Description
30668 \begin_inset Flex Code
30671 \begin_layout Plain Layout
30673 \begin_inset space ~
30681 A glob pattern that is used in the file dialog to filter out the desired files.
30682 If there is more than one possible file extension (e.
30683 \begin_inset space \thinspace{}
30687 \begin_inset space \space{}
30691 \begin_inset Flex Code
30694 \begin_layout Plain Layout
30701 \begin_inset Flex Code
30704 \begin_layout Plain Layout
30712 \begin_inset Flex Code
30715 \begin_layout Plain Layout
30722 This command must occur exactly once.
30725 \begin_layout Description
30726 \begin_inset Flex Code
30729 \begin_layout Plain Layout
30731 \begin_inset space ~
30739 The text that is displayed on the button.
30740 This command must occur exactly once.
30743 \begin_layout Description
30744 \begin_inset Flex Code
30747 \begin_layout Plain Layout
30749 \begin_inset space ~
30753 \begin_inset space ~
30761 The help text that is used in the External dialog.
30762 Provide enough information to explain to the user just what the template can provide him with.
30763 This command must occur exactly once.
30766 \begin_layout Description
30767 \begin_inset Flex Code
30770 \begin_layout Plain Layout
30772 \begin_inset space ~
30780 The file format of the original file.
30781 This must be the name of a format that is known to \SpecialChar LyX
30783 \begin_inset CommandInset ref
30785 reference "sec:Formats"
30792 \begin_inset Quotes eld
30796 \begin_inset Flex Code
30799 \begin_layout Plain Layout
30806 \begin_inset Quotes erd
30809 if the template can handle original files of more than one format.
30811 will attempt to interrogate the file itself in order to deduce its format in this case.
30812 This command must occur exactly once.
30815 \begin_layout Description
30816 \begin_inset Flex Code
30819 \begin_layout Plain Layout
30821 \begin_inset space ~
30829 A unique name for the template.
30830 It must not contain substitution macros (see below).
30833 \begin_layout Description
30834 \begin_inset Flex Code
30837 \begin_layout Plain Layout
30839 \begin_inset space ~
30842 Rotate|Resize|Clip|Extra
30847 This command specifies which transformations are supported by this template.
30848 It may occur zero or more times.
30849 This command enables the corresponding tabs in the external dialog.
30851 \begin_inset Flex Code
30854 \begin_layout Plain Layout
30860 command must have either a corresponding
30861 \begin_inset Flex Code
30864 \begin_layout Plain Layout
30871 \begin_inset Flex Code
30874 \begin_layout Plain Layout
30881 \begin_inset Flex Code
30884 \begin_layout Plain Layout
30891 Otherwise the transformation will not be supported by that format.
30894 \begin_layout Subsection
30898 \begin_layout Description
30899 \begin_inset Flex Code
30902 \begin_layout Plain Layout
30904 \begin_inset space ~
30907 LaTeX|PDFLaTeX|PlainText|DocBook|XHTML
30912 The primary document file format that this format definition is for.
30913 Not every template has a sensible representation in all document file formats.
30914 Please define nevertheless a
30915 \begin_inset Flex Code
30918 \begin_layout Plain Layout
30924 section for all templates.
30925 Use a dummy text when no representation is available.
30926 Then you can at least see a reference to the external material in the exported document.
30929 \begin_layout Description
30930 \begin_inset Flex Code
30933 \begin_layout Plain Layout
30935 \begin_inset space ~
30939 \begin_inset space ~
30947 This command defines an additional macro
30948 \begin_inset Flex Code
30951 \begin_layout Plain Layout
30957 for substitution in
30958 \begin_inset Flex Code
30961 \begin_layout Plain Layout
30969 \begin_inset Flex Code
30972 \begin_layout Plain Layout
30978 itself may contain substitution macros.
30979 The advantage over using
30980 \begin_inset Flex Code
30983 \begin_layout Plain Layout
30990 \begin_inset Flex Code
30993 \begin_layout Plain Layout
30999 is that the substituted value of
31000 \begin_inset Flex Code
31003 \begin_layout Plain Layout
31009 is sanitized so that it is a valid optional argument in the document format.
31010 This command may occur zero or more times.
31013 \begin_layout Description
31014 \begin_inset Flex Code
31017 \begin_layout Plain Layout
31019 \begin_inset space ~
31027 The text that is inserted in the exported document.
31028 This is actually the most important command and can be quite complex.
31029 This command must occur exactly once.
31032 \begin_layout Description
31033 \begin_inset Flex Code
31036 \begin_layout Plain Layout
31038 \begin_inset space ~
31046 This command specifies a preamble snippet that will be included in the \SpecialChar LaTeX
31048 It has to be defined using
31049 \begin_inset Flex Code
31052 \begin_layout Plain Layout
31060 \begin_inset Flex Code
31063 \begin_layout Plain Layout
31070 This command may occur zero or more times.
31073 \begin_layout Description
31074 \begin_inset Flex Code
31077 \begin_layout Plain Layout
31079 \begin_inset space ~
31083 \begin_inset space ~
31091 This command denotes files that are created by the conversion process and are needed for a particular export format.
31092 If the filename is relative,
31093 it is interpreted relative to the master document.
31094 This command may be given zero or more times.
31097 \begin_layout Description
31098 \begin_inset Flex Code
31101 \begin_layout Plain Layout
31103 \begin_inset space ~
31111 The name of a required \SpecialChar LaTeX
31113 The package is included via
31114 \begin_inset Flex Code
31117 \begin_layout Plain Layout
31125 in the \SpecialChar LaTeX
31127 This command may occur zero or more times.
31130 \begin_layout Description
31131 \begin_inset Flex Code
31134 \begin_layout Plain Layout
31136 \begin_inset space ~
31140 \begin_inset space ~
31143 RotationLatexCommand
31148 This command specifies that the built in \SpecialChar LaTeX
31149 command should be used for rotation.
31150 This command may occur once or not at all.
31153 \begin_layout Description
31154 \begin_inset Flex Code
31157 \begin_layout Plain Layout
31159 \begin_inset space ~
31163 \begin_inset space ~
31171 This command specifies that the built in \SpecialChar LaTeX
31172 command should be used for resizing.
31173 This command may occur once or not at all.
31176 \begin_layout Description
31177 \begin_inset Flex Code
31180 \begin_layout Plain Layout
31182 \begin_inset space ~
31186 \begin_inset space ~
31189 RotationLatexOption
31194 This command specifies that rotation is done via an optional argument.
31195 This command may occur once or not at all.
31198 \begin_layout Description
31199 \begin_inset Flex Code
31202 \begin_layout Plain Layout
31204 \begin_inset space ~
31208 \begin_inset space ~
31216 This command specifies that resizing is done via an optional argument.
31217 This command may occur once or not at all.
31220 \begin_layout Description
31221 \begin_inset Flex Code
31224 \begin_layout Plain Layout
31226 \begin_inset space ~
31230 \begin_inset space ~
31238 This command specifies that clipping is done via an optional argument.
31239 This command may occur once or not at all.
31242 \begin_layout Description
31243 \begin_inset Flex Code
31246 \begin_layout Plain Layout
31248 \begin_inset space ~
31252 \begin_inset space ~
31260 This command specifies that an extra optional argument is used.
31261 This command may occur once or not at all.
31264 \begin_layout Description
31265 \begin_inset Flex Code
31268 \begin_layout Plain Layout
31270 \begin_inset space ~
31278 The file format of the converted file.
31279 This must be the name of a format that is known to \SpecialChar LyX
31281 \begin_inset Flex Noun
31284 \begin_layout Plain Layout
31285 Tools\SpecialChar menuseparator
31286 Preferences\SpecialChar menuseparator
31287 File Handling\SpecialChar menuseparator
31294 This command must occur exactly once.
31295 If the resulting file format is PDF,
31296 you need to specify the format
31297 \begin_inset Flex Code
31300 \begin_layout Plain Layout
31307 This is the PDF format used for including graphics.
31308 The other defined PDF formats are for document export.
31311 \begin_layout Description
31312 \begin_inset Flex Code
31315 \begin_layout Plain Layout
31317 \begin_inset space ~
31325 The file name of the converted file.
31326 The file name must be absolute.
31327 This command must occur exactly once.
31330 \begin_layout Subsection
31331 Preamble definitions
31334 \begin_layout Standard
31335 The external template configuration file may contain additional preamble definitions enclosed by
31336 \begin_inset Flex Code
31339 \begin_layout Plain Layout
31347 \begin_inset Flex Code
31350 \begin_layout Plain Layout
31357 They can be used by the templates in the
31358 \begin_inset Flex Code
31361 \begin_layout Plain Layout
31370 \begin_layout Section
31371 The substitution mechanism
31374 \begin_layout Standard
31375 When the external material facility invokes an external program,
31376 it is done on the basis of a command defined in the template configuration file.
31377 These commands can contain various macros that are expanded before execution.
31378 Execution always take place in the directory of the containing document.
31381 \begin_layout Standard
31383 whenever external material is to be displayed,
31384 the name will be produced by the substitution mechanism,
31385 and most other commands in the template definition support substitution as well.
31388 \begin_layout Standard
31389 The available macros are the following:
31392 \begin_layout Description
31393 \begin_inset Flex Code
31396 \begin_layout Plain Layout
31397 $$AbsOrRelPathMaster
31403 absolute or relative to the master \SpecialChar LyX
31407 \begin_layout Description
31408 \begin_inset Flex Code
31411 \begin_layout Plain Layout
31412 $$AbsOrRelPathParent
31418 absolute or relative to the \SpecialChar LyX
31422 \begin_layout Description
31423 \begin_inset Flex Code
31426 \begin_layout Plain Layout
31432 The absolute file path
31433 \change_inserted -712698321 1712390130
31435 If compiling with \SpecialChar LyX
31437 this is the path to the file in the temporary directory
31442 \begin_layout Description
31443 \begin_inset Flex Code
31446 \begin_layout Plain Layout
31452 The filename without path and without the extension.
31455 \begin_layout Description
31456 \begin_inset Flex Code
31459 \begin_layout Plain Layout
31461 \begin_inset Quotes eld
31465 \begin_inset Quotes erd
31473 This macro will expand to the contents of the file with the name
31474 \begin_inset Flex Code
31477 \begin_layout Plain Layout
31486 \begin_layout Description
31487 \begin_inset Flex Code
31490 \begin_layout Plain Layout
31496 The file extension (including the dot).
31499 \begin_layout Description
31500 \begin_inset Flex Code
31503 \begin_layout Plain Layout
31509 This will be the string
31510 \begin_inset Quotes eld
31514 \begin_inset Quotes erd
31517 if the file is in JPEG format,
31518 otherwise it will be the string
31519 \begin_inset Quotes eld
31523 \begin_inset Quotes erd
31527 This is useful to avoid uneeded conversions for output formats that support both PNG and JPEG fomats.
31528 The predefined RasterImage template uses this macro for the pdf\SpecialChar TeX
31532 \begin_layout Description
31533 \begin_inset Flex Code
31536 \begin_layout Plain Layout
31542 The filename of the file specified in the external material dialog.
31543 This is either an absolute name,
31544 or it is relative to the \SpecialChar LyX
31548 \begin_layout Description
31549 \begin_inset Flex Code
31552 \begin_layout Plain Layout
31559 \begin_inset Flex Code
31562 \begin_layout Plain Layout
31568 (absolute name or relative to the \SpecialChar LyX
31570 \change_inserted -712698321 1712389740
31574 \begin_layout Description
31576 \change_inserted -712698321 1712390181
31577 \begin_inset Flex Code
31580 \begin_layout Plain Layout
31582 \change_inserted -712698321 1712389749
31590 The file name with absolute path to the original directory (not the temporary directory).
31595 \begin_layout Description
31596 \begin_inset Flex Code
31599 \begin_layout Plain Layout
31606 relative to the master \SpecialChar LyX
31610 \begin_layout Description
31611 \begin_inset Flex Code
31614 \begin_layout Plain Layout
31621 relative to the \SpecialChar LyX
31625 \begin_layout Description
31626 \begin_inset Flex Code
31629 \begin_layout Plain Layout
31635 This macro will expand to the absolute path of the system directory.
31636 This is typically used to point to the various helper scripts that are bundled with \SpecialChar LyX
31640 \begin_layout Description
31641 \begin_inset Flex Code
31644 \begin_layout Plain Layout
31650 A name and full path to a temporary file which will be automatically deleted whenever the containing document is closed,
31651 or the external material insertion deleted.
31654 \begin_layout Standard
31655 All path macros contain a trailing directory separator,
31656 so you can construct e.
31657 \begin_inset space \thinspace{}
31661 \begin_inset space \space{}
31664 the absolute filename with
31665 \begin_inset Flex Code
31668 \begin_layout Plain Layout
31669 $$AbsPath$$Basename$$Extension
31677 \begin_layout Standard
31678 The macros above are substituted in all commands unless otherwise noted.
31680 \begin_inset Flex Code
31683 \begin_layout Plain Layout
31689 supports additionally the following substitutions if they are enabled by the
31690 \begin_inset Flex Code
31693 \begin_layout Plain Layout
31700 \begin_inset Flex Code
31703 \begin_layout Plain Layout
31712 \begin_layout Description
31713 \begin_inset Flex Code
31716 \begin_layout Plain Layout
31722 The front part of the resize command.
31725 \begin_layout Description
31726 \begin_inset Flex Code
31729 \begin_layout Plain Layout
31735 The back part of the resize command.
31738 \begin_layout Description
31739 \begin_inset Flex Code
31742 \begin_layout Plain Layout
31748 The front part of the rotation command.
31751 \begin_layout Description
31752 \begin_inset Flex Code
31755 \begin_layout Plain Layout
31761 The back part of the rotation command.
31764 \begin_layout Standard
31765 The value string of the
31766 \begin_inset Flex Code
31769 \begin_layout Plain Layout
31775 command supports additionally the following substitutions if they are enabled by the
31776 \begin_inset Flex Code
31779 \begin_layout Plain Layout
31786 \begin_inset Flex Code
31789 \begin_layout Plain Layout
31798 \begin_layout Description
31799 \begin_inset Flex Code
31802 \begin_layout Plain Layout
31811 \begin_layout Description
31812 \begin_inset Flex Code
31815 \begin_layout Plain Layout
31824 \begin_layout Description
31825 \begin_inset Flex Code
31828 \begin_layout Plain Layout
31837 \begin_layout Description
31838 \begin_inset Flex Code
31841 \begin_layout Plain Layout
31847 The rotation option.
31850 \begin_layout Standard
31851 You may ask why there are so many path macros.
31852 There are mainly two reasons:
31855 \begin_layout Enumerate
31856 Relative and absolute file names should remain relative or absolute,
31858 Users may have reasons to prefer either form.
31859 Relative names are useful for portable documents that should work on different machines,
31861 Absolute names may be required by some programs.
31864 \begin_layout Enumerate
31866 treats relative file names differently than \SpecialChar LyX
31867 and other programs in nested included files.
31868 For \SpecialChar LyX
31870 a relative file name is always relative to the document that contains the file name.
31871 For \SpecialChar LaTeX
31873 it is always relative to the master document.
31874 These two definitions are identical if you have only one document,
31875 but differ if you have a master document that includes part documents.
31876 That means that relative filenames must be transformed when presented to \SpecialChar LaTeX
31878 Fortunately \SpecialChar LyX
31879 does this automatically for you if you choose the right macros.
31882 \begin_layout Standard
31883 So which path macro should be used in new template definitions?
31884 The rule is not difficult:
31887 \begin_layout Itemize
31889 \begin_inset Flex Code
31892 \begin_layout Plain Layout
31898 if an absolute path is required.
31901 \begin_layout Itemize
31903 \begin_inset Flex Code
31906 \begin_layout Plain Layout
31907 $$AbsOrRelPathMaster
31912 if the substituted string is some kind of \SpecialChar LaTeX
31916 \begin_layout Itemize
31918 \begin_inset Flex Code
31921 \begin_layout Plain Layout
31922 $$AbsOrRelPathParent
31927 in order to preserve the user's choice.
31930 \begin_layout Standard
31931 There are special cases where this rule does not work and e.
31932 \begin_inset space \thinspace{}
31936 \begin_inset space \space{}
31939 relative names are needed,
31940 but normally it will work just fine.
31941 One example for such a case is the command
31942 \begin_inset Flex Code
31945 \begin_layout Plain Layout
31946 ReferencedFile latex "$$AbsOrRelPathMaster$$Basename.pstex_t"
31951 in the XFig template above:
31952 We can't use the absolute name because the copier for
31953 \begin_inset Flex Code
31956 \begin_layout Plain Layout
31962 files needs the relative name in order to rewrite the file content.
31965 \begin_layout Section
31966 Security discussion
31967 \begin_inset CommandInset label
31969 name "sec:Security-discussion"
31976 \begin_layout Standard
31977 The external material feature interfaces with a lot of external programs and does so automatically,
31978 so we have to consider the security implications of this.
31980 since you have the option of including your own filenames and/or parameter strings and those are expanded into a command,
31981 it seems that it would be possible to create a malicious document which executes arbitrary commands when a user views or prints the document.
31982 This is something we definitely want to avoid.
31985 \begin_layout Standard
31987 since the external program commands are specified in the template configuration file only,
31988 there are no security issues if \SpecialChar LyX
31989 is properly configured with safe templates only.
31990 This is so because the external programs are invoked with the
31991 \begin_inset Flex Code
31994 \begin_layout Plain Layout
32000 -system call rather than the
32001 \begin_inset Flex Code
32004 \begin_layout Plain Layout
32011 so it's not possible to execute arbitrary commands from the filename or parameter section via the shell.
32014 \begin_layout Standard
32015 This also implies that you are restricted in what command strings you can use in the external material templates.
32017 pipes and redirection are not readily available.
32018 This has to be so if \SpecialChar LyX
32019 should remain safe.
32020 If you want to use some of the shell features,
32021 you should write a safe script to do this in a controlled manner,
32022 and then invoke the script from the command string.
32026 \begin_layout Standard
32027 It is possible to design a template that interacts directly with the shell,
32028 but since this would allow a malicious user to execute arbitrary commands by writing clever filenames and/or parameters,
32029 we generally recommend that you only use safe scripts that work with the
32030 \begin_inset Flex Code
32033 \begin_layout Plain Layout
32039 system call in a controlled manner.
32041 for use in a controlled environment,
32042 it can be tempting to just fall back to use ordinary shell scripts.
32048 provide an easily exploitable security hole in your system.
32049 Of course it stands to reason that such unsafe templates will never be included in the standard \SpecialChar LyX
32051 although we do encourage people to submit new templates in the open source tradition.
32052 But \SpecialChar LyX
32053 as shipped from the official distribution channels will never have unsafe templates.
32056 \begin_layout Standard
32057 Including external material provides a lot of power,
32058 and you have to be careful not to introduce security hazards with this power.
32059 A subtle error in a single line in an innocent looking script can open the door to huge security problems.
32060 So if you do not fully understand the issues,
32061 we recommend that you consult a knowledgeable security professional or the \SpecialChar LyX
32062 development team if you have any questions about whether a given template is safe or not.
32063 And do this before you use it in an uncontrolled environment.
32066 \begin_layout Chapter
32068 List of supported \SpecialChar LyX
32069 functions to be used in layouts
32070 \begin_inset CommandInset label
32072 name "chap:List-of-functions"
32079 \begin_layout Standard
32081 \begin_inset Tabular
32082 <lyxtabular version="3" rows="11" columns="8">
32083 <features tabularvalignment="middle">
32084 <column alignment="left" valignment="top">
32085 <column alignment="left" valignment="top">
32086 <column alignment="left" valignment="top">
32087 <column alignment="left" valignment="top">
32088 <column alignment="left" valignment="top">
32089 <column alignment="left" valignment="top">
32090 <column alignment="left" valignment="top">
32091 <column alignment="left" valignment="top">
32093 <cell alignment="left" valignment="top" usebox="none">
32096 \begin_layout Plain Layout
32102 <cell alignment="left" valignment="top" usebox="none">
32105 \begin_layout Plain Layout
32111 <cell alignment="left" valignment="top" usebox="none">
32114 \begin_layout Plain Layout
32120 <cell alignment="left" valignment="top" usebox="none">
32123 \begin_layout Plain Layout
32129 <cell alignment="center" valignment="top" usebox="none">
32132 \begin_layout Plain Layout
32138 <cell alignment="center" valignment="top" usebox="none">
32141 \begin_layout Plain Layout
32147 <cell alignment="center" valignment="top" usebox="none">
32150 \begin_layout Plain Layout
32156 <cell alignment="center" valignment="top" usebox="none">
32159 \begin_layout Plain Layout
32167 <cell alignment="left" valignment="top" usebox="none">
32170 \begin_layout Plain Layout
32176 <cell alignment="left" valignment="top" usebox="none">
32179 \begin_layout Plain Layout
32185 <cell alignment="left" valignment="top" usebox="none">
32188 \begin_layout Plain Layout
32194 <cell alignment="left" valignment="top" usebox="none">
32197 \begin_layout Plain Layout
32203 <cell alignment="center" valignment="top" usebox="none">
32206 \begin_layout Plain Layout
32212 <cell alignment="center" valignment="top" usebox="none">
32215 \begin_layout Plain Layout
32221 <cell alignment="center" valignment="top" usebox="none">
32224 \begin_layout Plain Layout
32230 <cell alignment="center" valignment="top" usebox="none">
32233 \begin_layout Plain Layout
32241 <cell alignment="left" valignment="top" usebox="none">
32244 \begin_layout Plain Layout
32250 <cell alignment="left" valignment="top" usebox="none">
32253 \begin_layout Plain Layout
32259 <cell alignment="left" valignment="top" usebox="none">
32262 \begin_layout Plain Layout
32268 <cell alignment="left" valignment="top" usebox="none">
32271 \begin_layout Plain Layout
32277 <cell alignment="center" valignment="top" usebox="none">
32280 \begin_layout Plain Layout
32286 <cell alignment="center" valignment="top" usebox="none">
32289 \begin_layout Plain Layout
32295 <cell alignment="center" valignment="top" usebox="none">
32298 \begin_layout Plain Layout
32304 <cell alignment="center" valignment="top" usebox="none">
32307 \begin_layout Plain Layout
32315 <cell alignment="left" valignment="top" usebox="none">
32318 \begin_layout Plain Layout
32324 <cell alignment="left" valignment="top" usebox="none">
32327 \begin_layout Plain Layout
32333 <cell alignment="left" valignment="top" usebox="none">
32336 \begin_layout Plain Layout
32342 <cell alignment="left" valignment="top" usebox="none">
32345 \begin_layout Plain Layout
32351 <cell alignment="center" valignment="top" usebox="none">
32354 \begin_layout Plain Layout
32360 <cell alignment="center" valignment="top" usebox="none">
32363 \begin_layout Plain Layout
32369 <cell alignment="center" valignment="top" usebox="none">
32372 \begin_layout Plain Layout
32378 <cell alignment="center" valignment="top" usebox="none">
32381 \begin_layout Plain Layout
32389 <cell alignment="left" valignment="top" usebox="none">
32392 \begin_layout Plain Layout
32398 <cell alignment="left" valignment="top" usebox="none">
32401 \begin_layout Plain Layout
32407 <cell alignment="left" valignment="top" usebox="none">
32410 \begin_layout Plain Layout
32416 <cell alignment="left" valignment="top" usebox="none">
32419 \begin_layout Plain Layout
32425 <cell alignment="center" valignment="top" usebox="none">
32428 \begin_layout Plain Layout
32434 <cell alignment="center" valignment="top" usebox="none">
32437 \begin_layout Plain Layout
32443 <cell alignment="center" valignment="top" usebox="none">
32446 \begin_layout Plain Layout
32452 <cell alignment="center" valignment="top" usebox="none">
32455 \begin_layout Plain Layout
32463 <cell alignment="left" valignment="top" usebox="none">
32466 \begin_layout Plain Layout
32472 <cell alignment="left" valignment="top" usebox="none">
32475 \begin_layout Plain Layout
32481 <cell alignment="left" valignment="top" usebox="none">
32484 \begin_layout Plain Layout
32490 <cell alignment="left" valignment="top" usebox="none">
32493 \begin_layout Plain Layout
32499 <cell alignment="center" valignment="top" usebox="none">
32502 \begin_layout Plain Layout
32508 <cell alignment="center" valignment="top" usebox="none">
32511 \begin_layout Plain Layout
32517 <cell alignment="center" valignment="top" usebox="none">
32520 \begin_layout Plain Layout
32526 <cell alignment="center" valignment="top" usebox="none">
32529 \begin_layout Plain Layout
32537 <cell alignment="left" valignment="top" usebox="none">
32540 \begin_layout Plain Layout
32546 <cell alignment="left" valignment="top" usebox="none">
32549 \begin_layout Plain Layout
32555 <cell alignment="left" valignment="top" usebox="none">
32558 \begin_layout Plain Layout
32564 <cell alignment="left" valignment="top" usebox="none">
32567 \begin_layout Plain Layout
32573 <cell alignment="center" valignment="top" usebox="none">
32576 \begin_layout Plain Layout
32582 <cell alignment="center" valignment="top" usebox="none">
32585 \begin_layout Plain Layout
32591 <cell alignment="center" valignment="top" usebox="none">
32594 \begin_layout Plain Layout
32600 <cell alignment="center" valignment="top" usebox="none">
32603 \begin_layout Plain Layout
32611 <cell alignment="left" valignment="top" usebox="none">
32614 \begin_layout Plain Layout
32620 <cell alignment="left" valignment="top" usebox="none">
32623 \begin_layout Plain Layout
32629 <cell alignment="left" valignment="top" usebox="none">
32632 \begin_layout Plain Layout
32638 <cell alignment="left" valignment="top" usebox="none">
32641 \begin_layout Plain Layout
32647 <cell alignment="center" valignment="top" usebox="none">
32650 \begin_layout Plain Layout
32656 <cell alignment="center" valignment="top" usebox="none">
32659 \begin_layout Plain Layout
32665 <cell alignment="center" valignment="top" usebox="none">
32668 \begin_layout Plain Layout
32674 <cell alignment="center" valignment="top" usebox="none">
32677 \begin_layout Plain Layout
32685 <cell alignment="left" valignment="top" usebox="none">
32688 \begin_layout Plain Layout
32694 <cell alignment="left" valignment="top" usebox="none">
32697 \begin_layout Plain Layout
32703 <cell alignment="left" valignment="top" usebox="none">
32706 \begin_layout Plain Layout
32712 <cell alignment="left" valignment="top" usebox="none">
32715 \begin_layout Plain Layout
32721 <cell alignment="center" valignment="top" usebox="none">
32724 \begin_layout Plain Layout
32730 <cell alignment="center" valignment="top" usebox="none">
32733 \begin_layout Plain Layout
32739 <cell alignment="center" valignment="top" usebox="none">
32742 \begin_layout Plain Layout
32748 <cell alignment="center" valignment="top" usebox="none">
32751 \begin_layout Plain Layout
32759 <cell alignment="left" valignment="top" usebox="none">
32762 \begin_layout Plain Layout
32768 <cell alignment="left" valignment="top" usebox="none">
32771 \begin_layout Plain Layout
32777 <cell alignment="left" valignment="top" usebox="none">
32780 \begin_layout Plain Layout
32786 <cell alignment="left" valignment="top" usebox="none">
32789 \begin_layout Plain Layout
32795 <cell alignment="center" valignment="top" usebox="none">
32798 \begin_layout Plain Layout
32804 <cell alignment="center" valignment="top" usebox="none">
32807 \begin_layout Plain Layout
32813 <cell alignment="center" valignment="top" usebox="none">
32816 \begin_layout Plain Layout
32822 <cell alignment="center" valignment="top" usebox="none">
32825 \begin_layout Plain Layout
32833 <cell alignment="center" valignment="top" usebox="none">
32836 \begin_layout Plain Layout
32842 <cell alignment="center" valignment="top" usebox="none">
32845 \begin_layout Plain Layout
32851 <cell alignment="center" valignment="top" usebox="none">
32854 \begin_layout Plain Layout
32860 <cell alignment="center" valignment="top" usebox="none">
32863 \begin_layout Plain Layout
32869 <cell alignment="center" valignment="top" usebox="none">
32872 \begin_layout Plain Layout
32878 <cell alignment="center" valignment="top" usebox="none">
32881 \begin_layout Plain Layout
32887 <cell alignment="center" valignment="top" usebox="none">
32890 \begin_layout Plain Layout
32896 <cell alignment="center" valignment="top" usebox="none">
32899 \begin_layout Plain Layout
32913 \begin_layout Chapter
32914 Names of available colors to be used in layouts
32915 \begin_inset CommandInset label
32917 name "chap:Names-of-colors"
32924 \begin_layout Standard
32925 The colors listed below are the standard colors and those that you can adjust in the \SpecialChar LyX
32929 \begin_layout Section
32933 \begin_layout Standard
32934 The following are no real colors,
32935 but rather act on color definitions:
32938 \begin_layout Description
32939 ignore The color is ignored
32942 \begin_layout Description
32943 inherit The color is inherited
32946 \begin_layout Description
32959 No particular color – clear or default
32962 \begin_layout Section
32966 \begin_layout Standard
32967 These are fixed colors that cannot be customized.
32972 use these colors in layout definitions,
32973 since they will not work well with some color themes (such as dark themes):
32976 \begin_layout Description
32980 \begin_layout Description
32984 \begin_layout Description
32988 \begin_layout Description
32992 \begin_layout Description
32996 \begin_layout Description
33000 \begin_layout Description
33004 \begin_layout Description
33008 \begin_layout Description
33012 \begin_layout Description
33016 \begin_layout Description
33020 \begin_layout Description
33024 \begin_layout Description
33028 \begin_layout Description
33032 \begin_layout Description
33036 \begin_layout Description
33040 \begin_layout Description
33044 \begin_layout Description
33048 \begin_layout Description
33052 \begin_layout Section
33056 \begin_layout Standard
33057 These are the colors allocated to specific elements in
33060 arg "dialog-show prefs"
33066 \begin_layout Description
33067 added_space Added space color
33070 \begin_layout Description
33071 addedtext Added text color
33074 \begin_layout Description
33075 appendix Appendix marker color
33078 \begin_layout Description
33079 background Background color
33082 \begin_layout Description
33083 bookmark Bookmark indicator color
33086 \begin_layout Description
33087 bottomarea Bottom area color
33090 \begin_layout Description
33091 branchlabel Label color for branches
33094 \begin_layout Description
33095 buttonbg Color used for button background
33098 \begin_layout Description
33099 buttonframe Color for inset button frames
33102 \begin_layout Description
33103 buttonhoverbg Color used for button background under focus
33106 \begin_layout Description
33107 buttonhoverbg_broken Color used for broken inset button under focus
33110 \begin_layout Description
33111 changebar Changebar color
33114 \begin_layout Description
33115 changedtextauthor1 Changed text color author 1
33118 \begin_layout Description
33119 changedtextauthor2 Changed text color author 2
33122 \begin_layout Description
33123 changedtextauthor3 Changed text color author 3
33126 \begin_layout Description
33127 changedtextauthor4 Changed text color author 4
33130 \begin_layout Description
33131 changedtextauthor5 Changed text color author 5
33134 \begin_layout Description
33135 changedtextcomparison Changed text color document comparison (workarea)
33138 \begin_layout Description
33139 collapsible Collapsible insets text color
33142 \begin_layout Description
33143 collapsibleframe Collapsible insets framecolor
33146 \begin_layout Description
33147 command Text color for command insets
33150 \begin_layout Description
33151 commandbg Background color for command insets
33154 \begin_layout Description
33155 commandframe Frame color for command insets
33158 \begin_layout Description
33159 command_broken Text color for broken (reference) insets
33162 \begin_layout Description
33163 commandbg_broken Background color for broken insets
33166 \begin_layout Description
33167 commandframe_broken Frame color for broken insets
33170 \begin_layout Description
33171 comment Label color for comments
33174 \begin_layout Description
33175 commentbg Background color of comments
33178 \begin_layout Description
33179 cursor Cursor color
33182 \begin_layout Description
33183 deletedtext Deleted text color
33186 \begin_layout Description
33187 deletedtextmodifier Deleted text modifying color (for adjusting the brightness)
33190 \begin_layout Description
33191 depthbar Color for the depth bars in the margin
33194 \begin_layout Description
33195 eolmarker End of line marker color
33198 \begin_layout Description
33199 error Color of the \SpecialChar LaTeX
33203 \begin_layout Description
33204 footlabel Label color for footnotes
33207 \begin_layout Description
33208 foreground Foreground color
33211 \begin_layout Description
33212 graphicsbg Graphics inset background color
33215 \begin_layout Description
33216 greyedoutbg Background color of greyedout inset
33219 \begin_layout Description
33220 greyedoutlabel Label color for greyedout insets
33223 \begin_layout Description
33224 greyedouttext Color for greyedout inset text
33227 \begin_layout Description
33228 indexlabel Label color for index insets
33231 \begin_layout Description
33232 inlinecompletion Inline completion color
33235 \begin_layout Description
33236 insetbg Inset marker background color
33239 \begin_layout Description
33240 insetframe Inset marker frame color
33243 \begin_layout Description
33244 language Color for marking foreign language words
33247 \begin_layout Description
33248 latex Text color in \SpecialChar LaTeX
33252 \begin_layout Description
33253 listingsbg Background color of listings inset
33256 \begin_layout Description
33257 marginlabel Label color for margin notes
33260 \begin_layout Description
33261 math Math inset text color
33264 \begin_layout Description
33265 mathbg Math inset background color
33268 \begin_layout Description
33269 mathcorners Math inset frame color not under focus
33272 \begin_layout Description
33273 mathframe Math inset frame color under focus
33276 \begin_layout Description
33277 mathline Math line color
33280 \begin_layout Description
33281 mathmacrobg Macro math inset background color
33284 \begin_layout Description
33285 mathmacroblend Macro math blended color
33288 \begin_layout Description
33289 mathmacroframe Macro math frame color
33292 \begin_layout Description
33293 mathmacrohoverbg Macro math inset background color hovered
33296 \begin_layout Description
33297 mathmacrolabel Macro math label color
33300 \begin_layout Description
33301 mathmacronewarg Macro template color for new parameters
33304 \begin_layout Description
33305 mathmacrooldarg Macro template color for old parameters
33308 \begin_layout Description
33309 newpage New page color
33312 \begin_layout Description
33313 nonunique_inlinecompletion Inline completion color for the non-unique part
33316 \begin_layout Description
33317 note Label color for notes
33320 \begin_layout Description
33321 notebg Background color of notes
33324 \begin_layout Description
33325 pagebreak Page break/line break color
33328 \begin_layout Description
33329 paragraphmarker Color used for the pilcrow sign to mark the end of a paragraph
33332 \begin_layout Description
33333 phantomtext Text color for phantom insets
33336 \begin_layout Description
33337 preview The color used for previews
33340 \begin_layout Description
33341 previewframe Preview frame color
33344 \begin_layout Description
33345 regexpframe Color for regexp frame
33348 \begin_layout Description
33349 scroll Color that indicates when a row can be scrolled
33352 \begin_layout Description
33353 selection Background color of selected text
33356 \begin_layout Description
33357 selectionmath Foreground color of selected text in math insets
33360 \begin_layout Description
33361 selectiontext Foreground color of selected text
33364 \begin_layout Description
33365 shadedbg Background color of shaded box
33368 \begin_layout Description
33369 special Special chars text color
33372 \begin_layout Description
33373 tabularline Table line color
33376 \begin_layout Description
33377 tabularonoffline Table line color
33380 \begin_layout Description
33381 textlabel1 Color 1 of layout and custom inset labels
33384 \begin_layout Description
33385 textlabel2 Color 2 of layout and custom inset labels
33388 \begin_layout Description
33389 textlabel3 Color 3 of layout and custom inset labels
33392 \begin_layout Description
33393 urllabel Label color for URL insets
33396 \begin_layout Description
33397 urltext Color for URL inset text