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 \begin_inset Flex Code
15116 \begin_layout Plain Layout
15125 \begin_inset space \thinspace{}
15129 \begin_inset Flex Code
15132 \begin_layout Plain Layout
15138 ] This causes macros that contain this layout to be protected with
15139 \begin_inset Flex Code
15142 \begin_layout Plain Layout
15155 ) if necessary and thus allows (some) verbatim stuff in macros.
15158 \begin_layout Description
15159 \begin_inset Flex Code
15162 \begin_layout Plain Layout
15169 \begin_inset Flex Code
15172 \begin_layout Plain Layout
15181 \begin_inset space \thinspace{}
15185 \begin_inset Flex Code
15188 \begin_layout Plain Layout
15194 ] Whether specific commands in this style (such as
15195 \begin_inset Flex Code
15198 \begin_layout Plain Layout
15207 \begin_inset Flex Code
15210 \begin_layout Plain Layout
15218 ) should be protected in an
15219 \begin_inset Flex Code
15222 \begin_layout Plain Layout
15231 This is particularly needed for styles that draw on
15239 commands which parse their content in complex ways.
15242 \begin_layout Description
15243 \begin_inset Flex Code
15246 \begin_layout Plain Layout
15253 \begin_inset Flex Code
15256 \begin_layout Plain Layout
15263 \begin_inset space \thinspace{}
15267 \begin_inset Flex Code
15270 \begin_layout Plain Layout
15278 ] Whether newlines are translated into \SpecialChar LaTeX
15280 \begin_inset Flex Code
15283 \begin_layout Plain Layout
15294 The translation can be switched off to allow more comfortable \SpecialChar LaTeX
15295 editing inside \SpecialChar LyX
15299 \begin_layout Description
15300 \begin_inset Flex Code
15303 \begin_layout Plain Layout
15310 \begin_inset Flex Code
15313 \begin_layout Plain Layout
15322 \begin_inset space \thinspace{}
15326 \begin_inset Flex Code
15329 \begin_layout Plain Layout
15337 \begin_inset Flex Code
15340 \begin_layout Plain Layout
15347 \begin_inset Flex Code
15350 \begin_layout Plain Layout
15356 ) paragraphs are being indented,
15357 then the indentation of such a paragraph following one of this type will be suppressed.
15358 (So this will not affect the display of non-default paragraphs.)
15361 \begin_layout Description
15362 \begin_inset Flex Code
15365 \begin_layout Plain Layout
15372 \begin_inset Flex Code
15375 \begin_layout Plain Layout
15381 ] Name of a style that has replaced this style.
15382 This is used to rename a style,
15383 while keeping backward compatibility.
15386 \begin_layout Description
15387 \begin_inset Flex Code
15390 \begin_layout Plain Layout
15397 \begin_inset Flex Code
15400 \begin_layout Plain Layout
15407 \begin_inset space \thinspace{}
15411 \begin_inset Flex Code
15414 \begin_layout Plain Layout
15420 ] Determines whether consecutive paragraphs of the same type are treated as belonging together.
15421 This has the effect that the
15422 \begin_inset Flex Code
15425 \begin_layout Plain Layout
15431 is only printed once before such a group.
15434 \begin_inset Flex Code
15437 \begin_layout Plain Layout
15444 \begin_inset Flex Code
15447 \begin_layout Plain Layout
15454 \begin_inset Flex Code
15457 \begin_layout Plain Layout
15463 and false for all other types.
15466 \begin_layout Description
15467 \begin_inset Flex Code
15470 \begin_layout Plain Layout
15477 \begin_inset Flex Code
15480 \begin_layout Plain Layout
15489 \begin_inset space \thinspace{}
15493 \begin_inset Flex Code
15496 \begin_layout Plain Layout
15502 ] Indicates that paragraphs will not be separated by an empty line in \SpecialChar LaTeX
15504 but only by a line break;
15506 \begin_inset Flex Code
15509 \begin_layout Plain Layout
15516 this allows to emulate a plain text editor (like the ERT inset).
15519 \begin_layout Description
15520 \begin_inset Flex Code
15523 \begin_layout Plain Layout
15530 \begin_inset Flex Code
15533 \begin_layout Plain Layout
15539 ] The indent of the very first line of a paragraph.
15541 \begin_inset Newline newline
15545 \begin_inset Flex Code
15548 \begin_layout Plain Layout
15554 will be fixed for a certain style.
15555 The exception is the default style,
15556 since the indentation for these paragraphs can be prohibited with
15557 \begin_inset Flex Code
15560 \begin_layout Plain Layout
15569 \begin_inset Flex Code
15572 \begin_layout Plain Layout
15578 style paragraphs inside environments use the
15579 \begin_inset Flex Code
15582 \begin_layout Plain Layout
15588 of the environment,
15589 not their native one.
15592 \begin_inset Flex Code
15595 \begin_layout Plain Layout
15601 paragraphs inside an enumeration are not indented.
15604 \begin_layout Description
15605 \begin_inset Flex Code
15608 \begin_layout Plain Layout
15615 \begin_inset Flex Code
15618 \begin_layout Plain Layout
15624 ] The vertical space between two paragraphs of this style.
15627 \begin_layout Description
15628 \begin_inset Flex Code
15631 \begin_layout Plain Layout
15638 \begin_inset Flex Code
15641 \begin_layout Plain Layout
15648 allows the user to choose either
15649 \begin_inset Quotes eld
15653 \begin_inset Quotes erd
15657 \begin_inset Quotes eld
15661 \begin_inset Quotes erd
15664 to separate paragraphs.
15666 \begin_inset Quotes eld
15670 \begin_inset Quotes erd
15675 \begin_inset Flex Code
15678 \begin_layout Plain Layout
15686 \begin_inset Quotes eld
15690 \begin_inset Quotes erd
15695 \begin_inset Flex Code
15698 \begin_layout Plain Layout
15704 is ignored and all paragraphs are separated by the
15705 \begin_inset Flex Code
15708 \begin_layout Plain Layout
15715 The vertical space is calculated with
15716 \begin_inset Flex Code
15719 \begin_layout Plain Layout
15721 \begin_inset space ~
15730 \begin_inset Flex Code
15733 \begin_layout Plain Layout
15739 is the height of a row with the normal font.
15741 the look stays the same with different screen fonts.
15744 \begin_layout Description
15745 \begin_inset Flex Code
15748 \begin_layout Plain Layout
15755 \begin_inset Flex Code
15758 \begin_layout Plain Layout
15767 \begin_inset space \thinspace{}
15771 \begin_inset Flex Code
15774 \begin_layout Plain Layout
15780 ] Whether the contents of this paragraph should be output in raw form,
15781 meaning without special translations that \SpecialChar LaTeX
15785 \begin_layout Description
15786 \begin_inset Flex Code
15789 \begin_layout Plain Layout
15796 \begin_inset Flex Code
15799 \begin_layout Plain Layout
15809 Defines individual characters that should be output in raw form,
15810 meaning without special translations that \SpecialChar LaTeX
15814 \begin_layout Description
15815 \begin_inset Flex Code
15818 \begin_layout Plain Layout
15824 Information to be included in the \SpecialChar LaTeX
15825 preamble when this style is used.
15826 Used to define macros,
15829 required by this particular style.
15831 \begin_inset Quotes eld
15835 \begin_inset Flex Code
15838 \begin_layout Plain Layout
15845 \begin_inset Quotes erd
15851 \begin_layout Description
15852 \begin_inset Flex Code
15855 \begin_layout Plain Layout
15862 \begin_inset Flex Code
15865 \begin_layout Plain Layout
15871 ] The prefix to use when creating labels referring to paragraphs of this type.
15872 This allows the use of formatted references.
15875 \begin_layout Description
15876 \begin_inset Flex Code
15879 \begin_layout Plain Layout
15886 \begin_inset Flex Code
15889 \begin_layout Plain Layout
15895 ] Whether the style requires the feature
15896 \begin_inset Flex Code
15899 \begin_layout Plain Layout
15906 \begin_inset CommandInset ref
15908 reference "chap:List-of-functions"
15913 for the list of features).
15914 If you require a package with specific options,
15915 you can additionally use
15916 \begin_inset Flex Code
15919 \begin_layout Plain Layout
15925 as a general text class parameter (see
15926 \begin_inset CommandInset ref
15928 reference "subsec:General-text-class"
15936 \begin_layout Description
15937 \begin_inset Flex Code
15940 \begin_layout Plain Layout
15947 \begin_inset Flex Code
15950 \begin_layout Plain Layout
15959 \begin_inset Flex Code
15962 \begin_layout Plain Layout
15968 ] Resets the \SpecialChar LaTeX
15969 arguments of this style (as defined via the
15970 \begin_inset Flex Code
15973 \begin_layout Plain Layout
15980 This is useful if you have copied a style via
15981 \begin_inset Flex Code
15984 \begin_layout Plain Layout
15991 but you do not want to inherit its (required and optional) arguments.
15994 \begin_layout Description
15995 \begin_inset Flex Code
15998 \begin_layout Plain Layout
16005 \begin_inset Flex Code
16008 \begin_layout Plain Layout
16017 \begin_inset Flex Code
16020 \begin_layout Plain Layout
16026 ] Resumes a counter that is usually reset at each new sequence of layouts.
16027 This is currently only useful when
16028 \begin_inset Flex Code
16031 \begin_layout Plain Layout
16038 \begin_inset Flex Code
16041 \begin_layout Plain Layout
16050 \begin_layout Description
16051 \begin_inset Flex Code
16054 \begin_layout Plain Layout
16061 \begin_inset Flex Code
16064 \begin_layout Plain Layout
16070 ] A string that is put at the end of the layout content.
16071 A line break in the output can be indicated by
16072 \begin_inset Flex Code
16075 \begin_layout Plain Layout
16084 \begin_layout Description
16085 \begin_inset Flex Code
16088 \begin_layout Plain Layout
16095 \begin_inset Flex Code
16098 \begin_layout Plain Layout
16105 \begin_inset Flex Code
16108 \begin_layout Plain Layout
16117 \begin_layout Description
16118 \begin_inset Flex Code
16121 \begin_layout Plain Layout
16128 \begin_inset Flex Code
16131 \begin_layout Plain Layout
16141 \begin_inset Flex Code
16144 \begin_layout Plain Layout
16152 \begin_inset Flex Code
16155 \begin_layout Plain Layout
16163 \begin_inset Flex Code
16166 \begin_layout Plain Layout
16168 \begin_inset space ~
16176 ] This defines what the default spacing should be in the style.
16178 \begin_inset Flex Code
16181 \begin_layout Plain Layout
16189 \begin_inset Flex Code
16192 \begin_layout Plain Layout
16199 \begin_inset Flex Code
16202 \begin_layout Plain Layout
16208 correspond respectively to a multiplier value of 1,
16210 If you specify the argument
16211 \begin_inset Flex Code
16214 \begin_layout Plain Layout
16221 then you must also provide a value argument which will be the actual multiplier value.
16223 contrary to other parameters,
16225 \begin_inset Flex Code
16228 \begin_layout Plain Layout
16234 implies the generation of specific \SpecialChar LaTeX
16236 using the \SpecialChar LaTeX
16240 \begin_inset Flex Code
16243 \begin_layout Plain Layout
16252 \begin_layout Description
16253 \begin_inset Flex Code
16256 \begin_layout Plain Layout
16263 \begin_inset Flex Code
16266 \begin_layout Plain Layout
16273 \begin_inset space \thinspace{}
16277 \begin_inset Flex Code
16280 \begin_layout Plain Layout
16288 ] Allow spell-checking paragraphs of this style.
16292 \begin_layout Description
16293 \begin_inset Flex Code
16296 \begin_layout Plain Layout
16303 \begin_inset Flex Code
16306 \begin_layout Plain Layout
16315 \begin_inset Flex Code
16318 \begin_layout Plain Layout
16324 ] Steps the parent counter of a given counter at the beginning of a new sequence of layouts.
16325 This is currently only useful when
16326 \begin_inset Flex Code
16329 \begin_layout Plain Layout
16336 \begin_inset Flex Code
16339 \begin_layout Plain Layout
16348 \begin_layout Description
16349 \begin_inset Flex Code
16352 \begin_layout Plain Layout
16358 The font used for the text body .
16360 \begin_inset CommandInset ref
16362 reference "subsec:Font-description"
16370 \begin_layout Description
16371 \begin_inset Flex Code
16374 \begin_layout Plain Layout
16383 \begin_inset Flex Code
16386 \begin_layout Plain Layout
16396 The level of the style in the table of contents.
16397 This is used for automatic numbering of section headings.
16400 \begin_layout Description
16401 \begin_inset Flex Code
16404 \begin_layout Plain Layout
16413 \begin_inset Flex Code
16416 \begin_layout Plain Layout
16428 \begin_inset Flex Code
16431 \begin_layout Plain Layout
16439 \begin_inset Flex Code
16442 \begin_layout Plain Layout
16448 ] This tag determines whether the first line indentation of this paragraph can be toggled via the Paragraph settings dialog.
16452 \begin_inset Flex Code
16455 \begin_layout Plain Layout
16466 indentation can be toggled if the document settings use
16467 \begin_inset Quotes eld
16471 \begin_inset Quotes erd
16476 \begin_inset Flex Code
16479 \begin_layout Plain Layout
16486 indentation can always be toggled,
16487 notwithstanding the document settings,
16489 \begin_inset Flex Code
16492 \begin_layout Plain Layout
16499 indentation can never be toggled.
16502 \begin_layout Description
16503 \begin_inset Flex Code
16506 \begin_layout Plain Layout
16513 \begin_inset Flex Code
16516 \begin_layout Plain Layout
16522 ] The vertical space with which the very first of a chain of paragraphs with this style is separated from the previous paragraph.
16523 If the previous paragraph has another style,
16524 the separations are not simply added,
16525 but the maximum is taken.
16528 \begin_layout Subsection
16529 \begin_inset CommandInset label
16535 Internationalization of Paragraph Styles
16538 \begin_layout Standard
16540 has long supported internationalization of layout information,
16543 this applied only to the user interface and not to,
16547 French authors were forced to resort to ugly hacks if they wanted `
16551 1' instead of `Theorem 1'.
16552 Thanks to Georg Baum,
16553 that is no longer the case.
16556 \begin_layout Standard
16558 \begin_inset Flex Code
16561 \begin_layout Plain Layout
16567 defines text that is to appear in the typeset document,
16569 \begin_inset Flex Code
16572 \begin_layout Plain Layout
16579 \begin_inset Flex Code
16582 \begin_layout Plain Layout
16588 to support non-English and even multi-language documents correctly.
16589 The following excerpt (from the
16590 \begin_inset Flex Code
16593 \begin_layout Plain Layout
16599 file) shows how this works:
16602 \begin_layout LyX-Code
16607 \begin_layout LyX-Code
16610 theoremstyle{remark}
16613 \begin_layout LyX-Code
16616 newtheorem{claim}[thm]{
16623 \begin_layout LyX-Code
16627 \begin_layout LyX-Code
16631 \begin_layout LyX-Code
16636 claimname}{_(Claim)}
16639 \begin_layout LyX-Code
16643 \begin_layout LyX-Code
16647 \begin_layout LyX-Code
16656 claimname}{_(Claim)}}
16659 \begin_layout LyX-Code
16664 \begin_layout Standard
16666 any legal \SpecialChar LaTeX
16668 \begin_inset Flex Code
16671 \begin_layout Plain Layout
16678 \begin_inset Flex Code
16681 \begin_layout Plain Layout
16688 but in practice they will typically look as they do here.
16689 The key to correct translation of the typeset text is the definition of the \SpecialChar LaTeX
16691 \begin_inset Flex Code
16694 \begin_layout Plain Layout
16703 \begin_inset Flex Code
16706 \begin_layout Plain Layout
16718 \begin_layout Standard
16720 \begin_inset Flex Code
16723 \begin_layout Plain Layout
16729 tag provides for internationalization based upon the overall language of the document.
16730 The contents of the tag will be included in the preamble,
16732 \begin_inset Flex Code
16735 \begin_layout Plain Layout
16742 What makes it special is the use of the
16743 \begin_inset Quotes eld
16747 \begin_inset Quotes erd
16751 \begin_inset Flex Code
16754 \begin_layout Plain Layout
16761 which will be replaced,
16762 when \SpecialChar LyX
16763 produces \SpecialChar LaTeX
16765 with the translation of its argument into the document language.
16768 \begin_layout Standard
16770 \begin_inset Flex Code
16773 \begin_layout Plain Layout
16779 tag is more complex,
16780 since it is meant to provide support for multi-language documents and so offers an interface to the
16781 \begin_inset Flex Code
16784 \begin_layout Plain Layout
16791 Its contents will be added to the preamble once for each language that appears in the document.
16794 \begin_inset Flex Code
16797 \begin_layout Plain Layout
16803 will be replaced with its translation into the language in question;
16805 \begin_inset Flex Code
16808 \begin_layout Plain Layout
16814 is replaced by the language name (as used by the babel package).
16817 \begin_layout Standard
16818 A German document that also included a French section would thus have the following in the preamble:
16821 \begin_layout LyX-Code
16830 claimname}{Affirmation}}
16831 \begin_inset Newline newline
16842 claimname}{Behauptung}}
16843 \begin_inset Newline newline
16850 claimname}{Behauptung}
16853 \begin_layout Standard
16856 \begin_inset Flex Code
16859 \begin_layout Plain Layout
16865 will then conspire to produce the correct text in the output.
16868 \begin_layout Standard
16869 One important point to note here is that the translations are provided by \SpecialChar LyX
16872 \begin_inset Flex Code
16875 \begin_layout Plain Layout
16885 \begin_inset Flex Code
16888 \begin_layout Plain Layout
16895 \begin_inset Flex Code
16898 \begin_layout Plain Layout
16904 are really only of use in layout files that are provided with \SpecialChar LyX
16906 since text entered in user-created layout files will not be seen by \SpecialChar LyX
16907 's internationalization routines unless the
16908 \begin_inset Flex Code
16911 \begin_layout Plain Layout
16917 file is modified accordingly.
16920 any layout created with the intention that it will be included with \SpecialChar LyX
16921 should use these tags where appropriate.
16922 Please note that the paragraph style translations provided by \SpecialChar LyX
16923 will never change with a minor update (e.
16924 \begin_inset space \thinspace{}
16928 \begin_inset space \space{}
16931 from version 2.1.x to 2.1.y).
16932 It is however quite likely that a major update (e.
16933 \begin_inset space \thinspace{}
16937 \begin_inset space \space{}
16940 from 2.0.x to 2.1.0) will introduce new translations or corrections.
16943 \begin_layout Subsection
16945 \begin_inset CommandInset label
16947 name "subsec:Floats"
16954 \begin_layout Standard
16955 It is necessary to define the floats (
16956 \begin_inset Flex Noun
16959 \begin_layout Plain Layout
16967 \begin_inset Flex Noun
16970 \begin_layout Plain Layout
16978 ) in the text class itself.
16979 Standard floats are included in the file
16980 \begin_inset Flex Code
16983 \begin_layout Plain Layout
16990 so you may have to do no more than add
16993 \begin_layout LyX-Code
16994 Input stdfloats.inc
16997 \begin_layout Standard
16998 to your layout file.
16999 If you want to implement a text class that proposes some other float types (like the AGU class bundled with \SpecialChar LyX
17001 the information below will hopefully help you:
17004 \begin_layout Description
17005 \begin_inset Flex Code
17008 \begin_layout Plain Layout
17015 \begin_inset Flex Code
17018 \begin_layout Plain Layout
17024 =!htbpH] Allowed placement options for this float type.
17025 The value is a string of placement characters.
17026 Possible characters include:
17032 \begin_inset Quotes eld
17036 \begin_inset Quotes erd
17045 \begin_inset Quotes eld
17049 \begin_inset Quotes erd
17058 \begin_inset Quotes eld
17062 \begin_inset Quotes erd
17071 \begin_inset Quotes eld
17075 \begin_inset Quotes erd
17084 \begin_inset Quotes eld
17088 \begin_inset Quotes erd
17097 \begin_inset Quotes eld
17101 \begin_inset Quotes erd
17105 The order of the characters in the string does not matter.
17106 If no placement options are allowed,
17114 \begin_layout Description
17115 \begin_inset Flex Code
17118 \begin_layout Plain Layout
17125 \begin_inset Flex Code
17128 \begin_layout Plain Layout
17137 \begin_inset space \thinspace{}
17143 \begin_inset Flex Code
17146 \begin_layout Plain Layout
17156 ] Defines whether the float allows to be rotated via the \SpecialChar LaTeX
17163 \begin_inset Flex Code
17166 \begin_layout Plain Layout
17172 if the float does not support this feature.
17175 \begin_layout Description
17176 \begin_inset Flex Code
17179 \begin_layout Plain Layout
17186 \begin_inset Flex Code
17189 \begin_layout Plain Layout
17198 \begin_inset space \thinspace{}
17204 \begin_inset Flex Code
17207 \begin_layout Plain Layout
17217 ] Defines whether the float has a starred variant that spans columns in a two column paragraph.
17219 \begin_inset Flex Code
17222 \begin_layout Plain Layout
17228 if the float does not support this feature.
17231 \begin_layout Description
17232 \begin_inset Flex Code
17235 \begin_layout Plain Layout
17242 \begin_inset Flex Code
17245 \begin_layout Plain Layout
17252 \begin_inset Quotes erd
17256 \begin_inset Quotes erd
17259 ] The file name extension of an auxiliary file for the list of figures (or whatever).
17261 writes the captions to this file.
17264 \begin_layout Description
17265 \begin_inset Flex Code
17268 \begin_layout Plain Layout
17275 \begin_inset Flex Code
17278 \begin_layout Plain Layout
17285 \begin_inset Quotes erd
17289 \begin_inset Quotes erd
17292 ] The string that will be used in the menus and also for the caption.
17293 This is translated to the current language if babel is used.
17296 \begin_layout Description
17297 \begin_inset Flex Code
17300 \begin_layout Plain Layout
17306 These tags control the XHTML output.
17308 \begin_inset CommandInset ref
17310 reference "sec:Tags-for-XHTML"
17318 \begin_layout Description
17319 \begin_inset Flex Code
17322 \begin_layout Plain Layout
17331 \begin_inset Flex Code
17334 \begin_layout Plain Layout
17343 \begin_inset space \thinspace{}
17347 \begin_inset Flex Code
17350 \begin_layout Plain Layout
17356 ] Indicates whether the float is already defined in the document class or if instead the \SpecialChar LaTeX
17358 \begin_inset Flex Code
17361 \begin_layout Plain Layout
17367 needs to be loaded to define it on-the-fly.
17369 \begin_inset Flex Code
17372 \begin_layout Plain Layout
17381 \begin_inset Flex Code
17384 \begin_layout Plain Layout
17391 It should be set to
17392 \begin_inset Flex Code
17395 \begin_layout Plain Layout
17401 if the float is already defined by the \SpecialChar LaTeX
17405 \begin_layout Description
17406 \begin_inset Flex Code
17409 \begin_layout Plain Layout
17416 \begin_inset Flex Code
17419 \begin_layout Plain Layout
17426 \begin_inset Quotes erd
17430 \begin_inset Quotes erd
17433 ] The command used to generate a list of floats of this type;
17442 \begin_inset Flex Code
17445 \begin_layout Plain Layout
17452 since there is no standard way to generate this command.
17454 \begin_inset Flex Code
17457 \begin_layout Plain Layout
17464 since in that case there is a standard way to define the command.
17467 \begin_layout Description
17468 \begin_inset Flex Code
17471 \begin_layout Plain Layout
17478 \begin_inset Flex Code
17481 \begin_layout Plain Layout
17488 \begin_inset Quotes erd
17492 \begin_inset Quotes erd
17495 ] A title for a list of floats of this kind (list of figures,
17498 It is used for the screen label within \SpecialChar LyX
17500 it is used by \SpecialChar LaTeX
17501 for the title and it is used as the title in the XHTML output.
17502 It will be translated to the document language.
17505 \begin_layout Description
17506 \begin_inset Flex Code
17509 \begin_layout Plain Layout
17516 \begin_inset Flex Code
17519 \begin_layout Plain Layout
17526 \begin_inset Quotes erd
17530 \begin_inset Quotes erd
17533 ] This (optional) argument determines whether floats of this class will be numbered within some sectional unit of the document.
17536 \begin_inset Flex Code
17539 \begin_layout Plain Layout
17546 \begin_inset Quotes eld
17550 \begin_inset Flex Code
17553 \begin_layout Plain Layout
17560 \begin_inset Quotes erd
17564 the floats will be numbered within chapters.
17568 \begin_layout Description
17569 \begin_inset Flex Code
17572 \begin_layout Plain Layout
17579 \begin_inset Flex Code
17582 \begin_layout Plain Layout
17589 \begin_inset Quotes erd
17593 \begin_inset Quotes erd
17596 ] The default placement for the given class of floats.
17597 The string should be as in standard \SpecialChar LaTeX
17600 \begin_inset Flex Code
17603 \begin_layout Plain Layout
17611 \begin_inset Flex Code
17614 \begin_layout Plain Layout
17622 \begin_inset Flex Code
17625 \begin_layout Plain Layout
17632 \begin_inset Flex Code
17635 \begin_layout Plain Layout
17649 \begin_layout Plain Layout
17650 Note that the order of these letters in the string is irrelevant,
17651 like in \SpecialChar LaTeX
17657 On top of that there is a new type,
17659 \begin_inset Flex Code
17662 \begin_layout Plain Layout
17669 which does not really correspond to a float,
17672 \begin_inset Quotes eld
17676 \begin_inset Quotes erd
17680 Note however that the
17681 \begin_inset Flex Code
17684 \begin_layout Plain Layout
17690 specifier is special and,
17691 because of implementation details,
17692 cannot be used in non-built in float types.
17693 If you do not understand what this means,
17695 \begin_inset Quotes eld
17699 \begin_inset Flex Code
17702 \begin_layout Plain Layout
17709 \begin_inset Quotes erd
17715 \begin_layout Description
17716 \begin_inset Flex Code
17719 \begin_layout Plain Layout
17726 \begin_inset Flex Code
17729 \begin_layout Plain Layout
17736 \begin_inset Quotes erd
17740 \begin_inset Quotes erd
17743 ] A format for use with formatted references to this counter.
17745 one might want to have references to tables appear as
17746 \begin_inset Quotes eld
17750 \begin_inset Quotes erd
17754 The string may contain
17755 \begin_inset Quotes eld
17759 \begin_inset Quotes erd
17762 or a counter specification.
17763 (See the documentation for
17764 \begin_inset Flex Code
17767 \begin_layout Plain Layout
17774 \begin_inset CommandInset ref
17775 LatexCommand formatted
17776 reference "subsec:Counters"
17784 .) The former will be replaced by the counter number itself.
17792 arabic{section} (which might render as:
17796 \begin_layout Description
17797 \begin_inset Flex Code
17800 \begin_layout Plain Layout
17807 \begin_inset Flex Code
17810 \begin_layout Plain Layout
17816 ] The prefix to use when creating labels referring to floats of this type.
17817 This allows the use of formatted references.
17818 Note that you can remove any
17819 \begin_inset Flex Code
17822 \begin_layout Plain Layout
17828 set by a copied style by using the special value
17829 \begin_inset Quotes eld
17833 \begin_inset Quotes erd
17837 which must be all caps.
17840 \begin_layout Description
17841 \begin_inset Flex Code
17844 \begin_layout Plain Layout
17851 \begin_inset Flex Code
17854 \begin_layout Plain Layout
17860 ] As with paragraph styles,
17862 \begin_inset CommandInset ref
17864 reference "subsec:Paragraph-Styles"
17872 \begin_layout Description
17873 \begin_inset Flex Code
17876 \begin_layout Plain Layout
17883 \begin_inset Flex Code
17886 \begin_layout Plain Layout
17893 \begin_inset Quotes erd
17897 \begin_inset Quotes erd
17900 ] The style used when defining the float using
17901 \begin_inset Flex Code
17904 \begin_layout Plain Layout
17915 \begin_layout Description
17916 \begin_inset Flex Code
17919 \begin_layout Plain Layout
17926 \begin_inset Flex Code
17929 \begin_layout Plain Layout
17936 \begin_inset Quotes erd
17940 \begin_inset Quotes erd
17944 \begin_inset Quotes eld
17948 \begin_inset Quotes erd
17951 of the new class of floats,
17952 like program or algorithm.
17953 After the appropriate
17954 \begin_inset Flex Code
17957 \begin_layout Plain Layout
17967 \begin_inset Flex Code
17970 \begin_layout Plain Layout
17979 \begin_inset Flex Code
17982 \begin_layout Plain Layout
17993 \begin_layout Description
17994 \begin_inset Flex Code
17997 \begin_layout Plain Layout
18004 \begin_inset Flex Code
18007 \begin_layout Plain Layout
18014 \begin_inset space \thinspace{}
18018 \begin_inset Flex Code
18021 \begin_layout Plain Layout
18029 ] Specifies whether this float is defined using the \SpecialChar LaTeX
18031 \begin_inset Flex Code
18034 \begin_layout Plain Layout
18041 either by the class file,
18042 another package or on-the-fly by \SpecialChar LyX
18046 \begin_layout Standard
18047 Note that defining a float with type
18048 \begin_inset Flex Code
18051 \begin_layout Plain Layout
18059 automatically defines the corresponding counter with name
18060 \begin_inset Flex Code
18063 \begin_layout Plain Layout
18074 \begin_layout Subsection
18075 Flex insets and InsetLayout
18076 \begin_inset CommandInset label
18078 name "subsec:Flex-insets-and"
18085 \begin_layout Standard
18086 Flex insets come in two different kinds:
18090 \begin_layout Itemize
18092 \begin_inset Flex Code
18095 \begin_layout Plain Layout
18102 These define semantic markup corresponding to such \SpecialChar LaTeX
18104 \begin_inset Flex Code
18107 \begin_layout Plain Layout
18116 \begin_inset Flex Code
18119 \begin_layout Plain Layout
18130 \begin_layout Itemize
18132 \begin_inset Flex Code
18135 \begin_layout Plain Layout
18142 These can be used to define custom collapsible insets,
18143 similar to \SpecialChar TeX
18147 An obvious example is an endnote inset,
18148 which is defined in the
18149 \begin_inset Flex Code
18152 \begin_layout Plain Layout
18161 \begin_layout Standard
18162 Flex insets are defined using the
18163 \begin_inset Flex Code
18166 \begin_layout Plain Layout
18173 which shall be explained in a moment.
18176 \begin_layout Standard
18178 \begin_inset Flex Code
18181 \begin_layout Plain Layout
18187 tag also serves another function:
18188 It can be used to customize the general layout of many different types of insets.
18191 \begin_inset Flex Code
18194 \begin_layout Plain Layout
18200 can be used to customize the layout parameters for footnotes,
18213 as well as to define Flex insets.
18216 \begin_layout Standard
18218 \begin_inset Flex Code
18221 \begin_layout Plain Layout
18227 definition must begin with a line of the form:
18230 \begin_layout LyX-Code
18234 \begin_layout Standard
18236 \begin_inset Flex Code
18239 \begin_layout Plain Layout
18245 indicates the inset whose layout is being defined,
18246 and here there are four cases.
18249 \begin_layout Enumerate
18250 The layout for a pre-existing inset is being modified.
18253 \begin_inset Flex Code
18256 \begin_layout Plain Layout
18262 any one of the following:
18264 \begin_inset Flex Code
18267 \begin_layout Plain Layout
18275 \begin_inset Flex Code
18278 \begin_layout Plain Layout
18286 \begin_inset Flex Code
18289 \begin_layout Plain Layout
18297 \begin_inset Flex Code
18300 \begin_layout Plain Layout
18308 \begin_inset Flex Code
18311 \begin_layout Plain Layout
18319 \begin_inset Flex Code
18322 \begin_layout Plain Layout
18330 \begin_inset Flex Code
18333 \begin_layout Plain Layout
18341 \begin_inset Flex Code
18344 \begin_layout Plain Layout
18352 \begin_inset Flex Code
18355 \begin_layout Plain Layout
18363 \begin_inset Flex Code
18366 \begin_layout Plain Layout
18374 \begin_inset Flex Code
18377 \begin_layout Plain Layout
18385 \begin_inset Flex Code
18388 \begin_layout Plain Layout
18396 \begin_inset Flex Code
18399 \begin_layout Plain Layout
18407 \begin_inset Flex Code
18410 \begin_layout Plain Layout
18418 \begin_inset Flex Code
18421 \begin_layout Plain Layout
18429 \begin_inset Flex Code
18432 \begin_layout Plain Layout
18440 \begin_inset Flex Code
18443 \begin_layout Plain Layout
18451 \begin_inset Flex Code
18454 \begin_layout Plain Layout
18462 \begin_inset Flex Code
18465 \begin_layout Plain Layout
18473 \begin_inset Flex Code
18476 \begin_layout Plain Layout
18485 \begin_layout Enumerate
18486 The layout for a Flex inset is being defined.
18489 \begin_inset Flex Code
18492 \begin_layout Plain Layout
18498 must be of the form
18499 \begin_inset Quotes eld
18503 \begin_inset Flex Code
18506 \begin_layout Plain Layout
18513 \begin_inset Quotes erd
18518 \begin_inset Flex Code
18521 \begin_layout Plain Layout
18527 may be any valid identifier not used by a pre-existing Flex inset.
18528 The identifier may include spaces,
18529 but in that case the whole thing must be wrapped in quotes.
18530 Note that the definition of a flex inset
18535 \begin_inset Flex Code
18538 \begin_layout Plain Layout
18545 declaring which type of inset it defines.
18548 \begin_layout Enumerate
18549 The layout for user specific branch is being defined.
18552 \begin_inset Flex Code
18555 \begin_layout Plain Layout
18561 must be of the form
18562 \begin_inset Quotes eld
18566 \begin_inset Flex Code
18569 \begin_layout Plain Layout
18576 \begin_inset Quotes erd
18581 \begin_inset Flex Code
18584 \begin_layout Plain Layout
18590 may be any valid identifier of branch defined in user's document.
18591 The identifier may include spaces,
18592 but in that case the whole thing must be wrapped in quotes.
18593 The main purpose of this feature is to allow \SpecialChar LaTeX
18594 wrapping around specific branches as user needs.
18597 \begin_layout Enumerate
18598 The layout of a user (or class) specific caption is being defined.
18601 \begin_inset Flex Code
18604 \begin_layout Plain Layout
18610 must be of the form
18611 \begin_inset Quotes eld
18615 \begin_inset Flex Code
18618 \begin_layout Plain Layout
18625 \begin_inset Quotes erd
18630 \begin_inset Flex Code
18633 \begin_layout Plain Layout
18639 specifies the name of the caption as it appears in the menu.
18640 Have a look at the standard caption (
18641 \begin_inset Flex Code
18644 \begin_layout Plain Layout
18651 the specific captions of the KOMA-Script classes (
18652 \begin_inset Flex Code
18655 \begin_layout Plain Layout
18663 \begin_inset Flex Code
18666 \begin_layout Plain Layout
18675 \begin_inset space ~
18679 \begin_inset Newline linebreak
18685 \begin_inset Flex Code
18688 \begin_layout Plain Layout
18694 ) for applications.
18697 \begin_layout Standard
18699 \begin_inset Flex Code
18702 \begin_layout Plain Layout
18708 definition can contain the following entries:
18711 \begin_layout Description
18712 \begin_inset Flex Code
18715 \begin_layout Plain Layout
18722 \begin_inset Flex Code
18725 \begin_layout Plain Layout
18731 =""] This inset will appear in the table of contents of the given type.
18732 An empty string disables.
18733 See also the OutlinerName and the IsTocCaption commands.
18734 This is only implemented for Flex insets.
18739 \begin_layout Description
18740 \begin_inset Flex Code
18743 \begin_layout Plain Layout
18749 Includes a comma-separated list of insets to which this inset can be inserted.
18751 \begin_inset Quotes eld
18755 \begin_inset Flex Code
18758 \begin_layout Plain Layout
18765 \begin_inset Quotes erd
18769 If you you also want the insertion to be allowed in specific arguments of the target insets,
18770 append the argument name after @ (e.
18771 \begin_inset space \thinspace{}
18776 \begin_inset Flex Code
18779 \begin_layout Plain Layout
18786 Note that this currently only supports immediately containing insets (no deeper nesting).
18788 \begin_inset Flex Code
18791 \begin_layout Plain Layout
18800 \begin_layout Description
18801 \begin_inset Flex Code
18804 \begin_layout Plain Layout
18810 Includes a comma-separated list of layouts within which this inset can be inserted.
18812 \begin_inset Quotes eld
18816 \begin_inset Flex Code
18819 \begin_layout Plain Layout
18820 EndAllowedInLayouts
18826 \begin_inset Quotes erd
18830 Note that this currently only supports immediately containing layouts (no deeper nesting).
18832 \begin_inset Flex Code
18835 \begin_layout Plain Layout
18844 \begin_layout Description
18845 \begin_inset Flex Code
18848 \begin_layout Plain Layout
18855 \begin_inset Flex Code
18858 \begin_layout Plain Layout
18865 \begin_inset Flex Code
18868 \begin_layout Plain Layout
18875 \begin_inset Flex Code
18878 \begin_layout Plain Layout
18885 this can be used to determine how many times the inset can be inserted to a given inset or the paragraph (group).
18888 \begin_layout Description
18889 \begin_inset Flex Code
18892 \begin_layout Plain Layout
18893 AllowedOccurrencesPerItem
18899 \begin_inset Flex Code
18902 \begin_layout Plain Layout
18911 \begin_inset space \thinspace{}
18915 \begin_inset Flex Code
18918 \begin_layout Plain Layout
18924 ] If this is set to true,
18926 \begin_inset Flex Code
18929 \begin_layout Plain Layout
18935 applies to single paragraphs if we are in a list-type environment (with
18936 \begin_inset Flex Code
18939 \begin_layout Plain Layout
18950 \begin_layout Description
18951 \begin_inset Flex Code
18954 \begin_layout Plain Layout
18961 \begin_inset Flex Code
18964 \begin_layout Plain Layout
18970 ] Defines argument number of a command\SpecialChar breakableslash
18971 environment associated with the current layout.
18972 The definition must end with
18973 \begin_inset Flex Code
18976 \begin_layout Plain Layout
18984 \begin_inset CommandInset ref
18986 reference "subsec:Arguments"
18994 for more information.
18997 \begin_layout Description
18998 \begin_inset Flex Code
19001 \begin_layout Plain Layout
19007 Preamble for changing language commands;
19009 \begin_inset CommandInset ref
19011 reference "subsec:I18n"
19019 \begin_layout Description
19020 \begin_inset Flex Code
19023 \begin_layout Plain Layout
19030 \begin_inset Flex Code
19033 \begin_layout Plain Layout
19039 ] The color for the inset's background.
19041 \begin_inset CommandInset ref
19043 reference "chap:Names-of-colors"
19048 for a list of the available color names.
19051 \begin_layout Description
19052 \begin_inset Flex Code
19055 \begin_layout Plain Layout
19062 \begin_inset Flex Code
19065 \begin_layout Plain Layout
19074 \begin_inset space \thinspace{}
19078 \begin_inset Flex Code
19081 \begin_layout Plain Layout
19087 ] Whether to use the content of the inset as the label,
19088 when the inset is closed.
19092 \begin_layout Description
19093 \begin_inset Flex Code
19096 \begin_layout Plain Layout
19103 \begin_inset Flex Code
19106 \begin_layout Plain Layout
19112 ] As with paragraph styles,
19114 \begin_inset CommandInset ref
19116 reference "subsec:Paragraph-Styles"
19122 Note that you need to specify the complete type,
19124 \begin_inset space \thinspace{}
19128 \begin_inset space ~
19132 \begin_inset Flex Code
19135 \begin_layout Plain Layout
19136 CopyStyle Flex:<name>
19144 \begin_layout Description
19145 \begin_inset Flex Code
19148 \begin_layout Plain Layout
19155 \begin_inset Flex Code
19158 \begin_layout Plain Layout
19167 \begin_inset space \thinspace{}
19171 \begin_inset Flex Code
19174 \begin_layout Plain Layout
19180 ] Indicates whether the user may employ the Paragraph Settings dialog to customize the paragraph.
19183 \begin_layout Description
19184 \begin_inset Flex Code
19187 \begin_layout Plain Layout
19194 \begin_inset Flex Code
19197 \begin_layout Plain Layout
19205 \begin_inset Flex Code
19208 \begin_layout Plain Layout
19216 \begin_inset Flex Code
19219 \begin_layout Plain Layout
19226 describing the rendering style used for the inset's frame and buttons.
19227 Footnotes generally use
19228 \begin_inset Flex Code
19231 \begin_layout Plain Layout
19238 ERT insets generally
19239 \begin_inset Flex Code
19242 \begin_layout Plain Layout
19249 and character styles
19250 \begin_inset Flex Code
19253 \begin_layout Plain Layout
19262 \begin_layout Description
19263 \begin_inset Flex Code
19266 \begin_layout Plain Layout
19273 \begin_inset Flex Code
19276 \begin_layout Plain Layout
19285 \begin_inset space \thinspace{}
19291 \begin_inset Flex Code
19294 \begin_layout Plain Layout
19303 \begin_inset Flex Code
19306 \begin_layout Plain Layout
19313 \begin_inset Flex Code
19316 \begin_layout Plain Layout
19323 Indicates whether the environment will stand on its own in the output or will appear inline with the surrounding text.
19325 it is supposed that the \SpecialChar LaTeX
19326 environment ignores white space (including one newline character) after the
19327 \begin_inset Flex Code
19330 \begin_layout Plain Layout
19343 \begin_inset Flex Code
19346 \begin_layout Plain Layout
19362 \begin_layout Description
19363 \begin_inset Flex Code
19366 \begin_layout Plain Layout
19376 ,1] Allow the contents of the inset to be edited externally (using whatever editor is defined for the document's output format).
19379 \begin_layout Description
19380 \begin_inset Flex Code
19383 \begin_layout Plain Layout
19389 Required at the end of the
19390 \begin_inset Flex Code
19393 \begin_layout Plain Layout
19402 \begin_layout Description
19403 \begin_inset Flex Code
19406 \begin_layout Plain Layout
19412 The font used for both the text body
19418 \begin_inset CommandInset ref
19419 LatexCommand formatted
19420 reference "subsec:Font-description"
19426 Note that defining this font automatically defines the
19427 \begin_inset Flex Code
19430 \begin_layout Plain Layout
19437 so define this first and define
19438 \begin_inset Flex Code
19441 \begin_layout Plain Layout
19447 later if you want them to be different.
19450 \begin_layout Description
19451 \begin_inset Flex Code
19454 \begin_layout Plain Layout
19455 FixedWidthPreambleEncoding
19461 \begin_inset Flex Code
19464 \begin_layout Plain Layout
19473 \begin_inset space \thinspace{}
19477 \begin_inset Flex Code
19480 \begin_layout Plain Layout
19486 ] Force a fixed width encoding for the translated contents of
19487 \begin_inset Flex Code
19490 \begin_layout Plain Layout
19497 \begin_inset Flex Code
19500 \begin_layout Plain Layout
19506 code generated by this layout.
19507 This is needed for special \SpecialChar LaTeX
19512 that do not work with variable width encodings such as
19517 This setting is ignored if fully Unicode aware \SpecialChar LaTeX
19518 backends such as Xe\SpecialChar TeX
19519 or Lua\SpecialChar TeX
19523 \begin_layout Description
19524 \begin_inset Flex Code
19527 \begin_layout Plain Layout
19528 ForceLocalFontSwitch
19534 \begin_inset Flex Code
19537 \begin_layout Plain Layout
19546 \begin_inset space \thinspace{}
19550 \begin_inset Flex Code
19553 \begin_layout Plain Layout
19559 ] When using babel,
19560 always use a local font switch (
19561 \begin_inset Flex Code
19564 \begin_layout Plain Layout
19573 never a global one (such as
19574 \begin_inset Flex Code
19577 \begin_layout Plain Layout
19588 \begin_layout Description
19589 \begin_inset Flex Code
19592 \begin_layout Plain Layout
19599 \begin_inset Flex Code
19602 \begin_layout Plain Layout
19611 \begin_inset space \thinspace{}
19615 \begin_inset Flex Code
19618 \begin_layout Plain Layout
19625 \begin_inset Quotes eld
19629 \begin_inset Quotes erd
19633 leading to Left-to-Right (Latin) output,
19635 \begin_inset space \thinspace{}
19639 \begin_inset space \space{}
19642 in \SpecialChar TeX
19647 \begin_layout Description
19648 \begin_inset Flex Code
19651 \begin_layout Plain Layout
19658 \begin_inset Flex Code
19661 \begin_layout Plain Layout
19670 \begin_inset space \thinspace{}
19674 \begin_inset Flex Code
19677 \begin_layout Plain Layout
19683 ] Force a line break in the \SpecialChar LaTeX
19684 output before the inset starts and after the inset ends.
19685 This assures the inset itself is output on its own lines,
19686 for parsing purposes.
19689 \begin_layout Description
19690 \begin_inset Flex Code
19693 \begin_layout Plain Layout
19700 \begin_inset Flex Code
19703 \begin_layout Plain Layout
19712 \begin_inset space \thinspace{}
19716 \begin_inset Flex Code
19719 \begin_layout Plain Layout
19725 ] Indicates whether the
19726 \begin_inset Flex Code
19729 \begin_layout Plain Layout
19737 the user can change the paragraph style used in the inset.
19741 \begin_layout Description
19742 \begin_inset Flex Code
19745 \begin_layout Plain Layout
19752 \begin_inset Flex Code
19755 \begin_layout Plain Layout
19764 \begin_inset space \thinspace{}
19768 \begin_inset Flex Code
19771 \begin_layout Plain Layout
19777 ] As with paragraph styles,
19779 \begin_inset CommandInset ref
19781 reference "subsec:Paragraph-Styles"
19789 \begin_layout Description
19790 \begin_inset Flex Code
19793 \begin_layout Plain Layout
19799 These tags control the XHTML output.
19801 \begin_inset CommandInset ref
19803 reference "sec:Tags-for-XHTML"
19811 \begin_layout Description
19812 \begin_inset Flex Code
19815 \begin_layout Plain Layout
19822 \begin_inset Flex Code
19825 \begin_layout Plain Layout
19832 \begin_inset space \thinspace{}
19836 \begin_inset Flex Code
19839 \begin_layout Plain Layout
19847 ] The font inside the inset is inherited from the parent for \SpecialChar LaTeX
19848 export if this parameter is 1,
19849 as well as on screen.
19850 Otherwise the document default font is used.
19853 \begin_layout Description
19854 \begin_inset Flex Code
19857 \begin_layout Plain Layout
19864 \begin_inset Flex Code
19867 \begin_layout Plain Layout
19876 \begin_inset space \thinspace{}
19880 \begin_inset Flex Code
19883 \begin_layout Plain Layout
19889 ] Whether to include the contents of this inset in the strings generated for the `Outline' pane for all table of contents,
19890 regardless of the AddToToc setting.
19893 want the content of a footnote in a section header to be included in the TOC displayed in the outline,
19894 but one would normally want the content of a character style displayed.
19899 \begin_layout Description
19900 \begin_inset Flex Code
19903 \begin_layout Plain Layout
19910 \begin_inset Flex Code
19913 \begin_layout Plain Layout
19922 \begin_inset space \thinspace{}
19926 \begin_inset Flex Code
19929 \begin_layout Plain Layout
19935 ] If this is set to 1 and AddToToc is enabled,
19936 the inset adds a summary of its contents in its item in the table of contents.
19938 only the label appears.
19941 \begin_layout Description
19942 \begin_inset Flex Code
19945 \begin_layout Plain Layout
19954 \begin_inset Flex Code
19957 \begin_layout Plain Layout
19966 \begin_inset space \thinspace{}
19970 \begin_inset Flex Code
19973 \begin_layout Plain Layout
19979 ] As with paragraph styles,
19981 \begin_inset CommandInset ref
19983 reference "subsec:Paragraph-Styles"
19991 \begin_layout Description
19992 \begin_inset Flex Code
19995 \begin_layout Plain Layout
20001 The font used for the label.
20003 \begin_inset CommandInset ref
20005 reference "subsec:Font-description"
20011 Note that this definition can never appear before
20012 \begin_inset Flex Code
20015 \begin_layout Plain Layout
20022 lest it be ineffective.
20025 \begin_layout Description
20026 \begin_inset Flex Code
20029 \begin_layout Plain Layout
20036 \begin_inset Flex Code
20039 \begin_layout Plain Layout
20046 \begin_inset Quotes erd
20050 \begin_inset Quotes erd
20053 ] What will be displayed on the button or elsewhere as the inset label.
20055 \begin_inset Flex Code
20058 \begin_layout Plain Layout
20066 \begin_inset Flex Code
20069 \begin_layout Plain Layout
20075 ) modify this label on the fly.
20078 \begin_layout Description
20079 \begin_inset Flex Code
20082 \begin_layout Plain Layout
20088 Language dependent preamble;
20090 \begin_inset CommandInset ref
20092 reference "subsec:I18n"
20100 \begin_layout Description
20101 \begin_inset Flex Code
20104 \begin_layout Plain Layout
20111 \begin_inset Flex Code
20114 \begin_layout Plain Layout
20120 ] The name of the corresponding \SpecialChar LaTeX
20122 Either the environment or command name.
20125 \begin_layout Description
20126 \begin_inset Flex Code
20129 \begin_layout Plain Layout
20136 \begin_inset Flex Code
20139 \begin_layout Plain Layout
20145 ] The optional parameter for the corresponding
20146 \begin_inset Flex Code
20149 \begin_layout Plain Layout
20156 including possible bracket pairs like
20157 \begin_inset Flex Code
20160 \begin_layout Plain Layout
20167 This parameter cannot be changed from within \SpecialChar LyX
20169 \begin_inset Flex Code
20172 \begin_layout Plain Layout
20178 for customizable parameters).
20179 It will be output as is after all \SpecialChar LaTeX
20181 \begin_inset Flex Code
20184 \begin_layout Plain Layout
20193 \begin_layout Description
20194 \begin_inset Flex Code
20197 \begin_layout Plain Layout
20204 \begin_inset Flex Code
20207 \begin_layout Plain Layout
20215 ] How the style should be translated into \SpecialChar LaTeX
20220 \begin_layout Plain Layout
20221 \begin_inset Flex Code
20224 \begin_layout Plain Layout
20230 is perhaps a bit misleading,
20231 since these rules apply to SGML classes too.
20232 Visit the SGML class files for specific examples.
20241 \begin_layout Description
20242 \begin_inset Flex Code
20245 \begin_layout Plain Layout
20251 means nothing special
20254 \begin_layout Description
20255 \begin_inset Flex Code
20258 \begin_layout Plain Layout
20265 \begin_inset Flex Code
20268 \begin_layout Plain Layout
20275 {\SpecialChar ldots
20284 \begin_layout Description
20285 \begin_inset Flex Code
20288 \begin_layout Plain Layout
20295 \begin_inset Flex Code
20298 \begin_layout Plain Layout
20305 }\SpecialChar ldots
20320 \begin_layout Standard
20321 Putting the last few things together,
20322 the \SpecialChar LaTeX
20323 output will be either:
20327 \begin_layout LyX-Code
20330 LatexName[LatexParam]{\SpecialChar ldots
20334 \begin_layout Standard
20339 \begin_layout LyX-Code
20342 begin{LatexName}[LatexParam] \SpecialChar ldots
20348 \begin_layout Standard
20349 depending upon the \SpecialChar LaTeX
20354 \begin_layout Description
20355 \begin_inset Flex Code
20358 \begin_layout Plain Layout
20365 \begin_inset Flex Code
20368 \begin_layout Plain Layout
20374 ] A string that is put at the beginning of the layout content.
20375 A line break in the output can be indicated by
20376 \begin_inset Flex Code
20379 \begin_layout Plain Layout
20388 \begin_layout Description
20389 \begin_inset Flex Code
20392 \begin_layout Plain Layout
20399 \begin_inset Flex Code
20402 \begin_layout Plain Layout
20410 \begin_inset Flex Code
20413 \begin_layout Plain Layout
20421 \begin_inset Flex Code
20424 \begin_layout Plain Layout
20430 (indicating a dummy definition ending definitions of charstyles,
20432 This entry is required in and is only meaningful for Flex insets.
20433 Among other things,
20434 it determines on which menu this inset will appear.
20436 \begin_inset Flex Code
20439 \begin_layout Plain Layout
20446 \begin_inset Flex Code
20449 \begin_layout Plain Layout
20455 will automatically set
20456 \begin_inset Flex Code
20459 \begin_layout Plain Layout
20466 \begin_inset Flex Code
20469 \begin_layout Plain Layout
20477 \begin_inset Flex Code
20480 \begin_layout Plain Layout
20486 can be set to true,
20488 \begin_inset Flex Code
20491 \begin_layout Plain Layout
20499 \begin_inset Flex Code
20502 \begin_layout Plain Layout
20508 insets by setting it
20513 \begin_inset Flex Code
20516 \begin_layout Plain Layout
20525 \begin_layout Description
20526 \begin_inset Flex Code
20529 \begin_layout Plain Layout
20536 \begin_inset Flex Code
20539 \begin_layout Plain Layout
20545 A dedicated string for the menu.
20546 You can define an accelerator by appending the respective character to the string,
20548 \begin_inset Quotes eld
20552 \begin_inset Quotes erd
20556 \begin_inset space \thinspace{}
20560 \begin_inset space \space{}
20564 \begin_inset Quotes eld
20568 \begin_inset Flex Code
20571 \begin_layout Plain Layout
20578 \begin_inset Quotes erd
20582 This specification is optional.
20583 If it is not given the inset name as specified in the type declaration will be used instead for the menu.
20586 \begin_layout Description
20587 \begin_inset Flex Code
20590 \begin_layout Plain Layout
20597 \begin_inset Flex Code
20600 \begin_layout Plain Layout
20609 \begin_inset space \thinspace{}
20613 \begin_inset Flex Code
20616 \begin_layout Plain Layout
20622 ] Whether multiple paragraphs are permitted in this inset.
20624 \begin_inset Flex Code
20627 \begin_layout Plain Layout
20633 to the same value and
20634 \begin_inset Flex Code
20637 \begin_layout Plain Layout
20643 to the opposite value.
20644 These can be reset to other values,
20650 \begin_inset Flex Code
20653 \begin_layout Plain Layout
20663 \begin_layout Description
20664 \begin_inset Flex Code
20667 \begin_layout Plain Layout
20674 \begin_inset Flex Code
20677 \begin_layout Plain Layout
20686 \begin_inset space \thinspace{}
20690 \begin_inset Flex Code
20693 \begin_layout Plain Layout
20699 ] Whether fragile commands in this inset should be
20700 \begin_inset Flex Code
20703 \begin_layout Plain Layout
20717 whether the command should itself be protected.) Default is false.
20720 \begin_layout Description
20721 \begin_inset Flex Code
20724 \begin_layout Plain Layout
20731 \begin_inset Flex Code
20734 \begin_layout Plain Layout
20743 \begin_inset space \thinspace{}
20747 \begin_inset Flex Code
20750 \begin_layout Plain Layout
20756 ] This causes macros that contain this inset to be protected with
20757 \begin_inset Flex Code
20760 \begin_layout Plain Layout
20773 ) if necessary and thus allows (some) verbatim stuff in macros.
20777 \begin_layout Description
20778 \begin_inset Flex Code
20781 \begin_layout Plain Layout
20788 \begin_inset Flex Code
20791 \begin_layout Plain Layout
20800 \begin_inset space \thinspace{}
20804 \begin_inset Flex Code
20807 \begin_layout Plain Layout
20813 ] Whether specific commands in this inset (such as
20814 \begin_inset Flex Code
20817 \begin_layout Plain Layout
20826 \begin_inset Flex Code
20829 \begin_layout Plain Layout
20837 ) should be protected in an
20838 \begin_inset Flex Code
20841 \begin_layout Plain Layout
20850 This is particularly needed for insets that draw on
20858 commands which parse their content in complex ways.
20862 \begin_layout Description
20863 \begin_inset Flex Code
20866 \begin_layout Plain Layout
20873 \begin_inset Flex Code
20876 \begin_layout Plain Layout
20882 Option to define a different command (from the default
20883 \begin_inset Flex Code
20886 \begin_layout Plain Layout
20896 ) to be used for line breaks.
20897 The initial backslash must not be specified.
20900 \begin_layout Description
20901 \begin_inset Flex Code
20904 \begin_layout Plain Layout
20911 \begin_inset Flex Code
20914 \begin_layout Plain Layout
20920 ] Deletes an existing
20921 \begin_inset Flex Code
20924 \begin_layout Plain Layout
20933 \begin_layout Description
20934 \begin_inset Flex Code
20937 \begin_layout Plain Layout
20944 \begin_inset Flex Code
20947 \begin_layout Plain Layout
20954 \begin_inset Flex Code
20957 \begin_layout Plain Layout
20963 that has replaced this
20964 \begin_inset Flex Code
20967 \begin_layout Plain Layout
20974 This is used to rename an
20975 \begin_inset Flex Code
20978 \begin_layout Plain Layout
20985 while keeping backward compatibility.
20988 \begin_layout Description
20989 \begin_inset Flex Code
20992 \begin_layout Plain Layout
20999 \begin_inset Flex Code
21002 \begin_layout Plain Layout
21011 \begin_inset space \thinspace{}
21015 \begin_inset Flex Code
21018 \begin_layout Plain Layout
21024 ] If this is set to
21025 \begin_inset Flex Code
21028 \begin_layout Plain Layout
21035 paragraph breaks will be ignored in the output.
21036 This might be useful for insets where the content should be alignable on different lines only in the \SpecialChar LyX
21038 without any effect in the output.
21041 \begin_layout Description
21042 \begin_inset Flex Code
21045 \begin_layout Plain Layout
21052 \begin_inset Flex Code
21055 \begin_layout Plain Layout
21064 \begin_inset space \thinspace{}
21068 \begin_inset Flex Code
21071 \begin_layout Plain Layout
21077 ] As with paragraph styles,
21079 \begin_inset CommandInset ref
21081 reference "subsec:Paragraph-Styles"
21090 \begin_layout Description
21091 \begin_inset Flex Code
21094 \begin_layout Plain Layout
21101 \begin_inset Flex Code
21104 \begin_layout Plain Layout
21113 \begin_inset space \thinspace{}
21117 \begin_inset Flex Code
21120 \begin_layout Plain Layout
21126 ] As with paragraph styles,
21128 \begin_inset CommandInset ref
21130 reference "subsec:Paragraph-Styles"
21139 \begin_layout Description
21140 \begin_inset Flex Code
21143 \begin_layout Plain Layout
21149 As with paragraph styles,
21151 \begin_inset CommandInset ref
21153 reference "subsec:Paragraph-Styles"
21161 \begin_layout Description
21162 \begin_inset Flex Code
21165 \begin_layout Plain Layout
21172 \begin_inset Flex Code
21175 \begin_layout Plain Layout
21181 ] The prefix to use when creating labels referring to insets of this type.
21182 This allows the use of formatted references.
21185 \begin_layout Description
21186 \begin_inset Flex Code
21189 \begin_layout Plain Layout
21196 \begin_inset Flex Code
21199 \begin_layout Plain Layout
21205 ] As with paragraph styles,
21207 \begin_inset CommandInset ref
21209 reference "subsec:Paragraph-Styles"
21217 \begin_layout Description
21218 \begin_inset Flex Code
21221 \begin_layout Plain Layout
21228 \begin_inset Flex Code
21231 \begin_layout Plain Layout
21240 \begin_inset space \thinspace{}
21244 \begin_inset Flex Code
21247 \begin_layout Plain Layout
21253 ] Resets the \SpecialChar LaTeX
21254 arguments of this layout (as defined via the
21255 \begin_inset Flex Code
21258 \begin_layout Plain Layout
21265 This is useful if you have copied a style via
21266 \begin_inset Flex Code
21269 \begin_layout Plain Layout
21276 but you do not want to inherit its (required and optional) arguments.
21279 \begin_layout Description
21280 \begin_inset Flex Code
21283 \begin_layout Plain Layout
21290 \begin_inset Flex Code
21293 \begin_layout Plain Layout
21302 \begin_inset space \thinspace{}
21306 \begin_inset Flex Code
21309 \begin_layout Plain Layout
21316 \begin_inset Flex Code
21319 \begin_layout Plain Layout
21326 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.
21327 \begin_inset space \thinspace{}
21332 \begin_inset Flex Code
21335 \begin_layout Plain Layout
21338 textbf{Sourrounding text
21342 textbf{content}}\SpecialChar ldots
21349 \begin_inset Flex Code
21352 \begin_layout Plain Layout
21355 textbf{Sourrounding text
21357 myinset{content}\SpecialChar ldots
21364 Setting this makes sense for commands that internally reset font settings (e.
21365 \begin_inset space \thinspace{}
21370 Note that wrongly setting this might lead to unwanted result (e.
21371 \begin_inset space \thinspace{}
21376 \begin_inset Flex Code
21379 \begin_layout Plain Layout
21382 emph{Sourrounding text
21386 emph{content}}\SpecialChar ldots
21393 content is upright,
21395 \begin_inset Flex Code
21398 \begin_layout Plain Layout
21408 \begin_inset Flex Code
21411 \begin_layout Plain Layout
21418 font changes are not redone inside the inset.
21421 \begin_layout Description
21422 \begin_inset Flex Code
21425 \begin_layout Plain Layout
21432 \begin_inset Flex Code
21435 \begin_layout Plain Layout
21441 ] A string that is put at the end of the layout content.
21442 A line break in the output can be indicated by
21443 \begin_inset Flex Code
21446 \begin_layout Plain Layout
21455 \begin_layout Description
21456 \begin_inset Flex Code
21459 \begin_layout Plain Layout
21466 \begin_inset Flex Code
21469 \begin_layout Plain Layout
21476 \begin_inset space \thinspace{}
21480 \begin_inset Flex Code
21483 \begin_layout Plain Layout
21491 ] Allow spell-checking the contents of this inset.
21495 \begin_layout Subsection
21497 \begin_inset CommandInset label
21499 name "subsec:Arguments"
21506 \begin_layout Standard
21507 Both paragraph styles and inset layouts allow for
21511 as well as the main content.
21512 This is especially useful for things like section headings and only makes sense with \SpecialChar LaTeX
21514 Each (optional or required) argument of a command or environment—
21515 except for the required argument that is associated with the content—
21516 has a separate definition,
21517 where the number specifies the order of the arguments.
21518 The definition must end with
21519 \begin_inset Flex Code
21522 \begin_layout Plain Layout
21529 So a command with two optional arguments looks like:
21532 \begin_layout Quote
21538 \begin_layout Quote
21544 \begin_layout Quote
21550 \begin_layout Quote
21556 \begin_layout Quote
21562 \begin_layout Quote
21568 \begin_layout Standard
21570 \begin_inset Flex Code
21573 \begin_layout Plain Layout
21580 the following specifications are possible:
21583 \begin_layout Itemize
21584 \begin_inset Flex Code
21587 \begin_layout Plain Layout
21594 \begin_inset Flex Code
21597 \begin_layout Plain Layout
21603 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
21604 \begin_inset Flex Code
21607 \begin_layout Plain Layout
21615 you can define an accelerator by appending the respective character to the string,
21617 \begin_inset Quotes eld
21621 \begin_inset Quotes erd
21625 \begin_inset space \thinspace{}
21629 \begin_inset space \space{}
21633 \begin_inset Quotes eld
21637 \begin_inset Flex Code
21640 \begin_layout Plain Layout
21647 \begin_inset Quotes erd
21653 \begin_layout Itemize
21654 \begin_inset Flex Code
21657 \begin_layout Plain Layout
21664 \begin_inset Flex Code
21667 \begin_layout Plain Layout
21673 A separate string for the menu.
21674 You can define an accelerator by appending the respective character to the string,
21676 \begin_inset Quotes eld
21680 \begin_inset Quotes erd
21684 \begin_inset space \thinspace{}
21688 \begin_inset space \space{}
21692 \begin_inset Quotes eld
21696 \begin_inset Flex Code
21699 \begin_layout Plain Layout
21706 \begin_inset Quotes erd
21710 This specification is optional.
21711 If it is not given the
21712 \begin_inset Flex Code
21715 \begin_layout Plain Layout
21721 will be used instead for the menu.
21724 \begin_layout Itemize
21725 \begin_inset Flex Code
21728 \begin_layout Plain Layout
21735 \begin_inset Flex Code
21738 \begin_layout Plain Layout
21744 A longer explanatory text that appears in the tooltip when hovering over the argument inset.
21747 \begin_layout Itemize
21748 \begin_inset Flex Code
21751 \begin_layout Plain Layout
21758 \begin_inset Flex Code
21761 \begin_layout Plain Layout
21770 \begin_inset space \thinspace{}
21774 \begin_inset Flex Code
21777 \begin_layout Plain Layout
21783 ] Declare if this is a mandatory (1) or an optional (0) argument.
21784 Mandatory arguments will be output empty if not given,
21785 while optional arguments will not be output at all.
21787 mandatory arguments are delimited by
21788 \begin_inset Flex Code
21791 \begin_layout Plain Layout
21798 while optional arguments are delimited by
21799 \begin_inset Flex Code
21802 \begin_layout Plain Layout
21811 \begin_layout Itemize
21812 \begin_inset Flex Code
21815 \begin_layout Plain Layout
21822 \begin_inset Flex Code
21825 \begin_layout Plain Layout
21831 Option to define a different command (from the default
21832 \begin_inset Flex Code
21835 \begin_layout Plain Layout
21845 ) to be used for line breaks.
21846 The initial backslash must not be specified.
21849 \begin_layout Itemize
21850 \begin_inset Flex Code
21853 \begin_layout Plain Layout
21860 \begin_inset Flex Code
21863 \begin_layout Plain Layout
21869 defines another argument or arguments (by their number) which this argument requires to be output if it is itself output.
21871 \begin_inset space \thinspace{}
21875 in \SpecialChar LaTeX
21877 optional arguments often require previous optional arguments to be output (at least empty),
21879 \begin_inset Flex Code
21882 \begin_layout Plain Layout
21885 command[][argument]{text}
21891 This can be achieved by the statement
21892 \begin_inset Flex Code
21895 \begin_layout Plain Layout
21902 \begin_inset Flex Code
21905 \begin_layout Plain Layout
21912 If multiple arguments are required,
21913 separate them by comma (e.g.,
21915 \begin_inset Flex Code
21918 \begin_layout Plain Layout
21927 \begin_layout Itemize
21928 \begin_inset Flex Code
21931 \begin_layout Plain Layout
21938 \begin_inset Flex Code
21941 \begin_layout Plain Layout
21947 defines a custom left delimiter (instead of
21948 \begin_inset Flex Code
21951 \begin_layout Plain Layout
21958 \begin_inset Flex Code
21961 \begin_layout Plain Layout
21968 A line break in the output can be indicated by
21969 \begin_inset Flex Code
21972 \begin_layout Plain Layout
21981 \begin_layout Itemize
21982 \begin_inset Flex Code
21985 \begin_layout Plain Layout
21992 \begin_inset Flex Code
21995 \begin_layout Plain Layout
22001 defines a custom right delimiter (instead of
22002 \begin_inset Flex Code
22005 \begin_layout Plain Layout
22012 \begin_inset Flex Code
22015 \begin_layout Plain Layout
22022 A line break in the output can be indicated by
22023 \begin_inset Flex Code
22026 \begin_layout Plain Layout
22035 \begin_layout Itemize
22036 \begin_inset Flex Code
22039 \begin_layout Plain Layout
22046 \begin_inset Flex Code
22049 \begin_layout Plain Layout
22055 defines an argument that is inserted if and only if no user-specified arguments were given,
22057 \begin_inset space \thinspace{}
22061 \begin_inset space \space{}
22064 if no argument inset has been inserted (note that also an empty argument inset omits the DefaultArg).
22065 Multiple arguments need to be separated by comma.
22068 \begin_layout Itemize
22069 \begin_inset Flex Code
22072 \begin_layout Plain Layout
22079 \begin_inset Flex Code
22082 \begin_layout Plain Layout
22088 defines an argument that is inserted in any case (alone or in addition to user-specified arguments).
22089 Multiple arguments need to be separated by comma.
22092 \begin_layout Itemize
22093 \begin_inset Flex Code
22096 \begin_layout Plain Layout
22102 The font used for the argument content,
22104 \begin_inset CommandInset ref
22106 reference "subsec:Font-description"
22114 \begin_layout Itemize
22115 \begin_inset Flex Code
22118 \begin_layout Plain Layout
22125 \begin_inset Flex Code
22128 \begin_layout Plain Layout
22137 \begin_inset space \thinspace{}
22141 \begin_inset Flex Code
22144 \begin_layout Plain Layout
22150 ] As with paragraph styles,
22152 \begin_inset CommandInset ref
22154 reference "subsec:Paragraph-Styles"
22162 \begin_layout Itemize
22163 \begin_inset Flex Code
22166 \begin_layout Plain Layout
22172 The font used for the label;
22174 \begin_inset CommandInset ref
22176 reference "subsec:Font-description"
22184 \begin_layout Itemize
22185 \begin_inset Flex Code
22188 \begin_layout Plain Layout
22195 \begin_inset Flex Code
22198 \begin_layout Plain Layout
22210 ] describes the rendering style used for the inset's frame and buttons.
22213 \begin_layout Itemize
22214 \begin_inset Flex Code
22217 \begin_layout Plain Layout
22224 \begin_inset Flex Code
22227 \begin_layout Plain Layout
22234 \begin_inset Flex Code
22237 \begin_layout Plain Layout
22244 this argument is automatically inserted when the respective style is selected.
22247 \begin_layout Itemize
22248 \begin_inset Flex Code
22251 \begin_layout Plain Layout
22258 \begin_inset Flex Code
22261 \begin_layout Plain Layout
22268 \begin_inset Flex Code
22271 \begin_layout Plain Layout
22278 this argument will be inserted on a new line with
22279 \begin_inset Flex Code
22282 \begin_layout Plain Layout
22288 (only available within Flex insets).
22291 \begin_layout Itemize
22292 \begin_inset Flex Code
22295 \begin_layout Plain Layout
22302 \begin_inset Flex Code
22305 \begin_layout Plain Layout
22312 \begin_inset Flex Code
22315 \begin_layout Plain Layout
22322 this argument will be inserted with a copy of the co-text (either selected text or the whole paragraph) as content.
22325 \begin_layout Itemize
22326 \begin_inset Flex Code
22329 \begin_layout Plain Layout
22336 \begin_inset Flex Code
22339 \begin_layout Plain Layout
22351 ] Whether the contents of this argument should be output in raw form,
22352 meaning without special translations that \SpecialChar LaTeX
22356 \begin_inset Flex Code
22359 \begin_layout Plain Layout
22365 status is inherited by the inset or paragraph layout the argument belongs to,
22366 true and false change the status for the given argument only.
22369 \begin_layout Itemize
22370 \begin_inset Flex Code
22373 \begin_layout Plain Layout
22380 \begin_inset Flex Code
22383 \begin_layout Plain Layout
22384 string of characters
22393 Defines individual characters
22394 \begin_inset Newline linebreak
22397 that should be output in raw form,
22398 meaning without special translations that \SpecialChar LaTeX
22401 contrary to PassThru,
22402 this needs to be explicitly defined for arguments.
22404 arguments do not inherit PassThruChars from their parent inset or layout.
22407 \begin_layout Itemize
22408 \begin_inset Flex Code
22411 \begin_layout Plain Layout
22418 \begin_inset Flex Code
22421 \begin_layout Plain Layout
22430 \begin_inset space \thinspace{}
22434 \begin_inset Flex Code
22437 \begin_layout Plain Layout
22443 ] If this is set to 1,
22444 the argument will output its content in the corresponding item in the table of contents.
22448 \begin_layout Standard
22450 the text entered in the \SpecialChar LyX
22451 workarea in the respective layout is the last (mandatory) argument of a command if the
22452 \begin_inset Flex Code
22455 \begin_layout Plain Layout
22462 \begin_inset Flex Code
22465 \begin_layout Plain Layout
22473 arguments with the prefix
22474 \begin_inset Flex Code
22477 \begin_layout Plain Layout
22483 are output after this workarea argument.
22484 Note that post-argument numbering restarts at 1,
22485 so the first argument following the workarea argument is
22486 \begin_inset Flex Code
22489 \begin_layout Plain Layout
22496 Post-arguments are ignored in any other
22497 \begin_inset Flex Code
22500 \begin_layout Plain Layout
22507 \begin_inset Flex Code
22510 \begin_layout Plain Layout
22519 \begin_layout Standard
22521 \begin_inset Flex Code
22524 \begin_layout Plain Layout
22533 \begin_inset Flex Code
22536 \begin_layout Plain Layout
22545 \begin_inset Flex Code
22548 \begin_layout Plain Layout
22554 followed by the number (e.
22555 \begin_inset space \thinspace{}
22559 \begin_inset space \space{}
22563 \begin_inset Flex Code
22566 \begin_layout Plain Layout
22575 \begin_layout Standard
22577 there is a special argument type with the prefix
22578 \begin_inset Flex Code
22581 \begin_layout Plain Layout
22588 It is not really an argument,
22589 but uses the argument interface (thus,
22590 the prefix is also followed by a number,
22592 \begin_inset space \thinspace{}
22597 \begin_inset Flex Code
22600 \begin_layout Plain Layout
22601 Argument listpreamble:1
22607 As the name implies,
22608 it is targeted at lists such as
22628 Its content will be output at the list start,
22630 \begin_inset Flex Code
22633 \begin_layout Plain Layout
22642 on an own line (a place that is otherwise not accessible in \SpecialChar LyX
22645 users can insert redefinitions (of lengths etc.) to individual lists.
22647 these arguments do not have a delimiter.
22650 \begin_layout Subsection
22652 \begin_inset CommandInset label
22654 name "subsec:Counters"
22661 \begin_layout Standard
22662 It is necessary to define the counters (
22663 \begin_inset Flex Noun
22666 \begin_layout Plain Layout
22674 \begin_inset Flex Noun
22677 \begin_layout Plain Layout
22685 ) in the text class itself.
22686 The standard counters are defined in the file
22687 \begin_inset Flex Code
22690 \begin_layout Plain Layout
22697 so you may have to do no more than add
22700 \begin_layout LyX-Code
22701 Input stdcounters.inc
22704 \begin_layout Standard
22705 to your layout file to get them to work.
22706 But if you want to define custom counters,
22707 then you can do so.
22708 The counter declaration must begin with:
22711 \begin_layout LyX-Code
22712 Counter CounterName
22715 \begin_layout Standard
22717 \begin_inset Flex Code
22720 \begin_layout Plain Layout
22726 ' is replaced by the name of the counter.
22727 And it must end with
22728 \begin_inset Quotes eld
22732 \begin_inset Flex Code
22735 \begin_layout Plain Layout
22742 \begin_inset Quotes erd
22746 The following parameters can also be used:
22749 \begin_layout Description
22750 \begin_inset Flex Code
22753 \begin_layout Plain Layout
22760 \begin_inset Flex Code
22763 \begin_layout Plain Layout
22769 ] Sets the initial value for the counter,
22770 to which it will be reset whenever that happens.
22772 one will want the default,
22776 \begin_layout Description
22777 \begin_inset Flex Code
22780 \begin_layout Plain Layout
22787 \begin_inset Flex Code
22790 \begin_layout Plain Layout
22797 \begin_inset Quotes erd
22801 \begin_inset Quotes erd
22805 this string defines how the counter is displayed.
22806 Setting this value sets
22807 \begin_inset Flex Code
22810 \begin_layout Plain Layout
22811 LabelStringAppendix
22817 The following special constructs can be used in the string:
22821 \begin_layout Itemize
22822 \begin_inset Flex Code
22825 \begin_layout Plain Layout
22833 will be replaced by the expansion of the
22834 \begin_inset Flex Code
22837 \begin_layout Plain Layout
22844 \begin_inset Flex Code
22847 \begin_layout Plain Layout
22848 LabelStringAppendix
22854 \begin_inset Flex Code
22857 \begin_layout Plain Layout
22867 \begin_layout Itemize
22868 counter values can be expressed using \SpecialChar LaTeX
22870 \begin_inset Newline newline
22874 \begin_inset Flex Code
22877 \begin_layout Plain Layout
22895 \begin_inset Flex Code
22898 \begin_layout Plain Layout
22910 \begin_layout Plain Layout
22921 the situation is a bit more complicated:
22941 other than those described below will produce arabic numerals.
22942 It would not be surprising to see this change in the future.
22948 \begin_inset Flex Code
22951 \begin_layout Plain Layout
22960 3,\SpecialChar ldots
22963 \begin_inset Flex Code
22966 \begin_layout Plain Layout
22972 for lower-case letters:
22979 \begin_inset Flex Code
22982 \begin_layout Plain Layout
22988 for upper-case letters:
22995 \begin_inset Flex Code
22998 \begin_layout Plain Layout
23004 for lower-case roman numerals:
23011 \begin_inset Flex Code
23014 \begin_layout Plain Layout
23020 for upper-case roman numerals:
23023 III\SpecialChar ldots
23026 \begin_inset Flex Code
23029 \begin_layout Plain Layout
23035 for hebrew numerals.
23039 \begin_layout Standard
23040 If LabelString is not defined,
23041 a default value is constructed as follows:
23042 if the counter has a parent counter
23043 \begin_inset Flex Code
23046 \begin_layout Plain Layout
23053 \begin_inset Flex Code
23056 \begin_layout Plain Layout
23064 \begin_inset Newline newline
23068 \begin_inset Flex Code
23071 \begin_layout Plain Layout
23082 otherwise the string
23083 \begin_inset Flex Code
23086 \begin_layout Plain Layout
23097 \begin_layout Description
23098 \begin_inset Flex Code
23101 \begin_layout Plain Layout
23102 LabelStringAppendix
23108 \begin_inset Flex Code
23111 \begin_layout Plain Layout
23118 \begin_inset Quotes eld
23122 \begin_inset Quotes erd
23126 \begin_inset Flex Code
23129 \begin_layout Plain Layout
23136 but for use in the Appendix.
23139 \begin_layout Description
23140 \begin_inset Flex Code
23143 \begin_layout Plain Layout
23150 \begin_inset Flex Code
23153 \begin_layout Plain Layout
23160 \begin_inset Quotes eld
23164 \begin_inset Quotes erd
23167 ] The counter name as used in \SpecialChar LaTeX
23170 in \SpecialChar LyX
23172 there is a counter named `theorem',
23173 but it is output to \SpecialChar LaTeX
23177 \begin_layout Description
23178 \begin_inset Flex Code
23181 \begin_layout Plain Layout
23188 \begin_inset Flex Code
23191 \begin_layout Plain Layout
23198 \begin_inset Quotes erd
23202 \begin_inset Quotes erd
23205 ] A format for use with formatted references to this counter.
23207 one might want to have references to section numbers appear as
23208 \begin_inset Quotes eld
23212 \begin_inset Quotes erd
23216 The string may contain
23217 \begin_inset Quotes eld
23221 \begin_inset Quotes erd
23224 or a counter specification as in
23225 \begin_inset Flex Code
23228 \begin_layout Plain Layout
23235 The former will be replaced by the counter number itself.
23242 \begin_inset Flex Code
23245 \begin_layout Plain Layout
23255 (which might render as §2.7).
23258 \begin_layout Description
23259 \begin_inset Flex Code
23262 \begin_layout Plain Layout
23269 \begin_inset Flex Code
23272 \begin_layout Plain Layout
23280 \begin_inset Flex Code
23283 \begin_layout Plain Layout
23289 ] For use with `formatted references',
23290 specifically when a single counter is used with multiple sorts of styles.
23293 \begin_inset Flex Code
23296 \begin_layout Plain Layout
23302 counter is often used for all sorts of theorem-like environments:
23306 The first argument gives a prefix used in the labels (e.g.,
23308 \begin_inset Quotes eld
23312 \begin_inset Quotes erd
23316 \begin_inset Quotes eld
23320 \begin_inset Quotes erd
23324 and the second a formatting string,
23326 \begin_inset Flex Code
23329 \begin_layout Plain Layout
23336 \begin_inset Flex Code
23339 \begin_layout Plain Layout
23346 If this is not given,
23348 \begin_inset Flex Code
23351 \begin_layout Plain Layout
23360 \begin_layout Description
23361 \begin_inset Flex Code
23364 \begin_layout Plain Layout
23371 \begin_inset Flex Code
23374 \begin_layout Plain Layout
23381 \begin_inset Quotes erd
23385 \begin_inset Quotes erd
23388 ] If this is set to the name of another counter,
23389 the present counter will be reset every time the other one is increased.
23392 \begin_inset Flex Code
23395 \begin_layout Plain Layout
23402 \begin_inset Flex Code
23405 \begin_layout Plain Layout
23414 \begin_layout Subsection
23416 \begin_inset CommandInset label
23418 name "subsec:Font-description"
23425 \begin_layout Standard
23426 A font description looks like this:
23429 \begin_layout LyX-Code
23446 \begin_layout LyX-Code
23450 \begin_layout LyX-Code
23454 \begin_layout Standard
23455 The following commands are available:
23458 \begin_layout Description
23459 \begin_inset Flex Code
23462 \begin_layout Plain Layout
23469 \begin_inset Flex Code
23472 \begin_layout Plain Layout
23479 \begin_inset space ~
23483 \begin_inset CommandInset ref
23485 reference "chap:Names-of-colors"
23493 for valid arguments.
23496 \begin_layout Description
23497 \begin_inset Flex Code
23500 \begin_layout Plain Layout
23507 \begin_inset Flex Code
23510 \begin_layout Plain Layout
23520 \begin_inset Flex Code
23523 \begin_layout Plain Layout
23531 \begin_inset Flex Code
23534 \begin_layout Plain Layout
23543 \begin_layout Description
23544 \begin_inset Flex Code
23547 \begin_layout Plain Layout
23554 \begin_inset Flex Code
23557 \begin_layout Plain Layout
23563 ] Valid arguments are:
23565 \begin_inset Flex Code
23568 \begin_layout Plain Layout
23576 \begin_inset Flex Code
23579 \begin_layout Plain Layout
23587 \begin_inset Flex Code
23590 \begin_layout Plain Layout
23598 \begin_inset Flex Code
23601 \begin_layout Plain Layout
23609 \begin_inset Flex Code
23612 \begin_layout Plain Layout
23620 \begin_inset Flex Code
23623 \begin_layout Plain Layout
23631 \begin_inset Flex Code
23634 \begin_layout Plain Layout
23642 \begin_inset Flex Code
23645 \begin_layout Plain Layout
23653 \begin_inset Flex Code
23656 \begin_layout Plain Layout
23664 \begin_inset Flex Code
23667 \begin_layout Plain Layout
23675 \begin_inset Flex Code
23678 \begin_layout Plain Layout
23685 \begin_inset Flex Code
23688 \begin_layout Plain Layout
23695 Each of these turns on or off the corresponding attribute.
23698 \begin_inset Flex Code
23701 \begin_layout Plain Layout
23709 \begin_inset Flex Code
23712 \begin_layout Plain Layout
23720 \begin_inset Newline newline
23723 If the latter seems puzzling,
23724 remember that the font settings for the present context are generally inherited from the surrounding context.
23726 \begin_inset Flex Code
23729 \begin_layout Plain Layout
23735 would turn off the emphasis that was anyway in effect,
23737 in a theorem environment.
23740 \begin_layout Description
23741 \begin_inset Flex Code
23744 \begin_layout Plain Layout
23751 \begin_inset Flex Code
23754 \begin_layout Plain Layout
23764 \begin_inset Flex Code
23767 \begin_layout Plain Layout
23776 \begin_layout Description
23777 \begin_inset Flex Code
23780 \begin_layout Plain Layout
23787 \begin_inset Flex Code
23790 \begin_layout Plain Layout
23800 \begin_inset Flex Code
23803 \begin_layout Plain Layout
23811 \begin_inset Flex Code
23814 \begin_layout Plain Layout
23822 \begin_inset Flex Code
23825 \begin_layout Plain Layout
23834 \begin_layout Description
23835 \begin_inset Flex Code
23838 \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
23880 \begin_inset Flex Code
23883 \begin_layout Plain Layout
23891 \begin_inset Flex Code
23894 \begin_layout Plain Layout
23902 \begin_inset Flex Code
23905 \begin_layout Plain Layout
23913 \begin_inset Flex Code
23916 \begin_layout Plain Layout
23924 \begin_inset Flex Code
23927 \begin_layout Plain Layout
23936 \begin_layout Subsection
23937 \begin_inset CommandInset label
23939 name "subsec:Citation-engine-description"
23943 Cite engine description
23946 \begin_layout Standard
23948 \begin_inset Flex Code
23951 \begin_layout Plain Layout
23958 as used mainly in cite engine files (see
23959 \begin_inset CommandInset ref
23961 reference "subsec:Cite-Engine-Files"
23970 define the citation commands provided by a specific
23971 \begin_inset Quotes eld
23975 \begin_inset Quotes erd
23980 in \SpecialChar LyX
23982 is way specific way to format citations,
23984 author names and/or years.
23987 supports three such engine types,
23991 \begin_layout Enumerate
23992 \begin_inset Flex Code
23995 \begin_layout Plain Layout
24002 the default Bib\SpecialChar TeX
24003 way to format citations,
24004 a simple numeric style (e.
24005 \begin_inset space \thinspace{}
24010 \begin_inset Quotes eld
24014 \begin_inset Quotes erd
24020 \begin_layout Enumerate
24021 \begin_inset Flex Code
24024 \begin_layout Plain Layout
24031 Harvard-styled citations using author names and publication year (e.
24032 \begin_inset space \thinspace{}
24037 \begin_inset Quotes eld
24040 Smith and Miller (2017b)
24041 \begin_inset Quotes erd
24047 \begin_layout Enumerate
24048 \begin_inset Flex Code
24051 \begin_layout Plain Layout
24058 extended numerical citations that also allow for author or title next to the number (e.
24059 \begin_inset space \thinspace{}
24064 \begin_inset Quotes eld
24067 Smith and Miller [1]
24068 \begin_inset Quotes erd
24074 \begin_layout Standard
24075 \begin_inset Flex Code
24078 \begin_layout Plain Layout
24084 blocks look like this:
24087 \begin_layout LyX-Code
24091 \begin_layout LyX-Code
24095 \begin_layout LyX-Code
24099 \begin_layout LyX-Code
24100 citeyearpar[][]=parencite*
24103 \begin_layout LyX-Code
24107 \begin_layout LyX-Code
24111 \begin_layout Standard
24113 \begin_inset Flex Code
24116 \begin_layout Plain Layout
24122 denotes the engine.
24123 The individual lines respectively define a cite command or cite command paradigm supported by this engine.
24124 The line can be as simple as a cite command that is used both to name the respective \SpecialChar LyX
24125 command and the \SpecialChar LaTeX
24126 output or more complex in order to differentiate things.
24127 The full syntax is:
24130 \begin_layout LyX-Code
24131 LyXName|alias$*<!_stardesc!_stardesctooltip>[][]=latexcmd
24134 \begin_layout Itemize
24135 \begin_inset Flex Code
24138 \begin_layout Plain Layout
24145 The name as used in the
24146 \begin_inset Flex Code
24149 \begin_layout Plain Layout
24159 \begin_layout Standard
24160 For portability reasons,
24161 we try to use the same name for same-formatted commands in different cite packages (thus many names stem from natbib,
24162 and thus we need to differentiate a
24163 \begin_inset Flex Code
24166 \begin_layout Plain Layout
24173 if the \SpecialChar LaTeX
24174 command names differ).
24178 \begin_layout Itemize
24179 \begin_inset Flex Code
24182 \begin_layout Plain Layout
24189 a (comma-separated) list of commands that fall back to the given
24190 \begin_inset Flex Code
24193 \begin_layout Plain Layout
24199 in the current engine.
24200 This eases the switch of citation packages and engines.
24202 \begin_inset Flex Code
24205 \begin_layout Plain Layout
24212 \begin_inset Flex Code
24215 \begin_layout Plain Layout
24221 in layout definitions.
24224 \begin_layout Itemize
24225 \begin_inset Flex Code
24228 \begin_layout Plain Layout
24235 The actual \SpecialChar LaTeX
24236 command that is output.
24240 \begin_layout Standard
24241 \begin_inset Flex Code
24244 \begin_layout Plain Layout
24251 \begin_inset Flex Code
24254 \begin_layout Plain Layout
24262 \begin_inset Flex Code
24265 \begin_layout Plain Layout
24273 \begin_inset Flex Code
24276 \begin_layout Plain Layout
24282 will be output to \SpecialChar LaTeX
24286 \begin_layout Standard
24290 \begin_layout Itemize
24291 Capitalization indicates that the command also has a capitalized form (
24292 \begin_inset Flex Code
24295 \begin_layout Plain Layout
24305 \begin_inset Flex Code
24308 \begin_layout Plain Layout
24317 These usually enforce up-casing of name prefixes (
24322 \begin_inset Formula $\Rightarrow$
24332 \begin_layout Itemize
24334 \begin_inset Flex Code
24337 \begin_layout Plain Layout
24343 indicate the number of optional arguments (there can be 0–2).
24346 \begin_layout Itemize
24348 \begin_inset Flex Code
24351 \begin_layout Plain Layout
24357 indicates there is a starred version of the command (
24358 \begin_inset Flex Code
24361 \begin_layout Plain Layout
24371 \begin_inset Flex Code
24374 \begin_layout Plain Layout
24387 \begin_layout Standard
24389 the starred version means:
24390 Output all authors even if it should be shortened with
24391 \begin_inset Quotes eld
24395 \begin_inset Quotes erd
24399 \begin_inset Flex Code
24402 \begin_layout Plain Layout
24411 \begin_layout Standard
24412 If the star has a different meaning for a given command,
24413 it can be specified in angle brackets:
24415 \begin_inset Flex Code
24418 \begin_layout Plain Layout
24419 <!_stardesc!_stardesctooltip>
24425 Maximal two translatable macro keywords,
24426 marked by the prefix
24427 \begin_inset Flex Code
24430 \begin_layout Plain Layout
24438 The first points to the string that replaces the
24439 \begin_inset Quotes eld
24443 \begin_inset Quotes erd
24446 checkbox label in the citation dialog,
24447 the second one to an optional tool tip for this checkbox.
24451 \begin_layout Standard
24452 Note that these two macros have to be defined in a
24453 \begin_inset Flex Code
24456 \begin_layout Plain Layout
24462 (see next section),
24464 \begin_inset Flex Code
24467 \begin_layout Plain Layout
24478 \begin_layout LyX-Code
24479 _stardesc Sta&rred command label
24482 \begin_layout LyX-Code
24483 _stardesctooltip Tooltip for the starred command checkbox.
24487 \begin_layout Itemize
24489 \begin_inset Flex Code
24492 \begin_layout Plain Layout
24498 indicates that this command features
24499 \begin_inset Quotes eld
24502 qualified citation lists
24503 \begin_inset Quotes erd
24511 -specific feature for multi-reference citations where an individual pre- and postnote can be given to each reference in the list.
24512 Please refer to the
24516 manual for details.
24519 \begin_layout Standard
24520 If you want to add a cite command to a cite engine (e.
24521 \begin_inset space \thinspace{}
24525 add a specific command provided by a class),
24527 \begin_inset Flex Code
24530 \begin_layout Plain Layout
24531 AddToCiteEngine <engine type> \SpecialChar ldots
24538 Note that only cite commands that do not exist yet are added.
24541 \begin_layout Subsection
24542 \begin_inset CommandInset label
24544 name "subsec:Citation-format-description"
24548 Cite format description
24551 \begin_layout Standard
24553 \begin_inset Flex Code
24556 \begin_layout Plain Layout
24562 blocks are used to describe how bibliographic information should be displayed,
24563 both within \SpecialChar LyX
24564 itself (in the citation dialog and in tooltips,
24565 for example) and in XHTML output.
24566 Such a block might look like this:
24569 \begin_layout LyX-Code
24573 \begin_layout LyX-Code
24577 \begin_layout LyX-Code
24581 \begin_layout LyX-Code
24585 \begin_layout Standard
24589 \begin_layout LyX-Code
24593 \begin_layout LyX-Code
24597 \begin_layout LyX-Code
24601 \begin_layout LyX-Code
24605 \begin_layout Standard
24607 the individual lines define how the bibliographic information associated with an article or book,
24609 is to be displayed,
24610 and such a definition can be given for any
24611 \begin_inset Quotes els
24615 \begin_inset Quotes ers
24618 that might be present in a Bib\SpecialChar TeX
24621 defines a default format in the source code that will be used if no specific definition has been given.
24623 predefines several formats in the file
24624 \begin_inset Flex Code
24627 \begin_layout Plain Layout
24634 which is included in most of \SpecialChar LyX
24635 's document classes.
24638 \begin_layout Standard
24639 In the second case,
24640 the lines define how a specific citation command (in the example
24641 \begin_inset Flex Code
24644 \begin_layout Plain Layout
24654 \begin_inset Flex Code
24657 \begin_layout Plain Layout
24665 ) is to be displayed on the citation inset label,
24666 in the citation dialog,
24667 menu or XHTML output.
24669 defines such formats for the citation style variants it supports via
24671 Document\SpecialChar menuseparator
24672 Setting\SpecialChar menuseparator
24673 Bibliography\SpecialChar ldots
24677 \begin_inset Flex Code
24680 \begin_layout Plain Layout
24686 files that are shipped with \SpecialChar LyX
24688 \begin_inset CommandInset ref
24690 reference "subsec:Cite-Engine-Files"
24701 \begin_layout Standard
24702 The definitions use a simple language that allows Bib\SpecialChar TeX
24703 keys to be replaced with their values.
24704 Keys should be enclosed in
24705 \begin_inset Flex Code
24708 \begin_layout Plain Layout
24717 \begin_inset Flex Code
24720 \begin_layout Plain Layout
24727 So a simple definition might look like this:
24730 \begin_layout LyX-Code
24733 \begin_inset Quotes eld
24737 \begin_inset Quotes erd
24743 \begin_layout Standard
24744 This would print the author,
24745 followed by a comma,
24746 followed by the title,
24748 followed by a period.
24751 \begin_layout Standard
24753 sometimes you may want to print a key only if it exists.
24754 This can be done by using a conditional construction,
24757 \begin_inset Flex Code
24760 \begin_layout Plain Layout
24762 \begin_inset space ~
24773 \begin_inset Flex Code
24776 \begin_layout Plain Layout
24784 \begin_inset Quotes eld
24788 \begin_inset space ~
24792 \begin_inset Quotes erd
24795 followed by the volume key.
24796 It is also possible to have an else clause in the conditional,
24798 \begin_inset Newline newline
24802 \begin_inset Flex Code
24805 \begin_layout Plain Layout
24806 {%author%[[%author%]][[%editor%,
24813 \begin_inset Newline newline
24818 \begin_inset Flex Code
24821 \begin_layout Plain Layout
24827 key is printed if it exists;
24829 the editor key is printed,
24831 \begin_inset Quotes eld
24835 \begin_inset space ~
24839 \begin_inset Quotes erd
24842 Note that the key is again enclosed in
24843 \begin_inset Flex Code
24846 \begin_layout Plain Layout
24853 the entire conditional is enclosed in braces;
24854 and the if and else clauses are enclosed in double brackets,
24856 \begin_inset Quotes eld
24860 \begin_inset Flex Code
24863 \begin_layout Plain Layout
24870 \begin_inset Quotes eld
24874 \begin_inset Quotes eld
24878 \begin_inset Flex Code
24881 \begin_layout Plain Layout
24888 \begin_inset Quotes erd
24892 There must be no space between any of these.
24895 \begin_layout Standard
24896 Next to the entry keys,
24897 there are some special keys that can be used for these conditionals:
24900 \begin_layout Itemize
24901 \begin_inset Flex Code
24904 \begin_layout Plain Layout
24905 {%dialog%[[true]][[false]]}
24912 \begin_inset Quotes eld
24916 \begin_inset Quotes erd
24919 part for dialogs and menus,
24921 \begin_inset Quotes eld
24925 \begin_inset Quotes erd
24928 part for other contexts (workarea,
24932 \begin_layout Itemize
24933 \begin_inset Flex Code
24936 \begin_layout Plain Layout
24937 {%export%[[true]][[false]]}
24944 \begin_inset Quotes eld
24948 \begin_inset Quotes erd
24951 part for export and menus,
24953 \begin_inset Quotes eld
24957 \begin_inset Quotes erd
24960 part for other contexts (workarea,
24964 \begin_layout Itemize
24965 \begin_inset Flex Code
24968 \begin_layout Plain Layout
24976 \begin_inset Quotes eld
24980 \begin_inset Quotes erd
24983 part if another item follows (e.
24984 \begin_inset space \thinspace{}
24988 in a citation with multiple keys)
24991 \begin_layout Itemize
24992 \begin_inset Flex Code
24995 \begin_layout Plain Layout
24996 {%second%[[true]][[false]]}
25003 \begin_inset Quotes eld
25007 \begin_inset Quotes erd
25010 if this is the second of multiple items,
25012 \begin_inset Quotes eld
25016 \begin_inset Quotes erd
25022 \begin_layout Itemize
25023 \begin_inset Flex Code
25026 \begin_layout Plain Layout
25027 {%ifstar%[[true]][[false]]}
25034 \begin_inset Quotes eld
25038 \begin_inset Quotes erd
25041 part for starred citation commands (such as
25042 \begin_inset Flex Code
25045 \begin_layout Plain Layout
25054 the false part for unstarred
25057 \begin_layout Itemize
25058 \begin_inset Flex Code
25061 \begin_layout Plain Layout
25062 {%ifentrytype:<type>%[[true]][[false]]}
25069 \begin_inset Quotes eld
25073 \begin_inset Quotes erd
25076 if the current entry type matches
25077 \begin_inset Flex Code
25080 \begin_layout Plain Layout
25087 else the false part (e.g.,
25088 in a citation definition:
25090 \begin_inset Flex Code
25093 \begin_layout Plain Layout
25094 {%ifentrytype:book%[[this is a book]][[this is no book]]}
25102 \begin_layout Itemize
25103 \begin_inset Flex Code
25106 \begin_layout Plain Layout
25107 {%ifmultiple:<authortype>%[[true]][[false]]}
25114 \begin_inset Quotes eld
25118 \begin_inset Quotes erd
25121 if the current author type (author,
25122 editor etc.) has multiple authors,
25123 else the false part (e.g.,
25124 in a bibliography definition:
25126 \begin_inset Flex Code
25129 \begin_layout Plain Layout
25130 {%ifmultiple:editor%[[eds.]][[ed.]]}
25138 \begin_layout Itemize
25139 \begin_inset Flex Code
25142 \begin_layout Plain Layout
25143 {%ifqualified%[[true]][[false]]}
25150 \begin_inset Quotes eld
25154 \begin_inset Quotes erd
25157 part if the current citation is a qualified citation list (a specific
25161 format for multi-reference citations),
25162 the false part if this is not the case.
25165 \begin_layout Standard
25167 \begin_inset Flex Code
25170 \begin_layout Plain Layout
25176 prints the author key as it is recorded in the bibliography file.
25177 This might not be what you want,
25178 since it will result in a string such as
25179 \begin_inset Quotes eld
25186 \begin_inset Quotes erd
25190 \begin_inset Quotes eld
25194 \begin_inset Quotes erd
25197 is used by Bib\SpecialChar TeX
25198 to delimit authors).
25200 therefore provides some methods to get properly formatted name lists (which will also get translated).
25201 The following keys are provided:
25204 \begin_layout Enumerate
25205 For name lists with pre- and surname,
25206 suitable for the main authors/editors of a bibliography item.
25208 \begin_inset Flex Code
25211 \begin_layout Plain Layout
25217 part denotes the kind of list that is requested (e.g.
25219 \begin_inset Flex Code
25222 \begin_layout Plain Layout
25232 \begin_layout Itemize
25233 \begin_inset Flex Code
25236 \begin_layout Plain Layout
25237 %abbrvnames:<nametype>%
25243 Provides a name list which is abbreviated (with
25244 \begin_inset Quotes eld
25248 \begin_inset Quotes erd
25252 \begin_inset Flex Code
25255 \begin_layout Plain Layout
25264 \begin_layout Itemize
25265 \begin_inset Flex Code
25268 \begin_layout Plain Layout
25269 %fullnames:<nametype>%
25275 Provides a full name list (never abbreviated with
25276 \begin_inset Quotes eld
25280 \begin_inset Quotes erd
25286 \begin_layout Itemize
25287 \begin_inset Flex Code
25290 \begin_layout Plain Layout
25291 %forceabbrvnames:<nametype>%
25297 Provides a name list which is always abbreviated (with
25298 \begin_inset Quotes eld
25302 \begin_inset Quotes erd
25306 \begin_inset Flex Code
25309 \begin_layout Plain Layout
25319 \begin_layout Enumerate
25320 Alternative name lists with pre- and surname,
25321 if the order of pre- and surname inside the bibliography item differs (as in:
25323 \begin_inset Quotes eld
25333 \begin_inset Quotes erd
25340 \begin_layout Itemize
25341 \begin_inset Flex Code
25344 \begin_layout Plain Layout
25345 %abbrvbynames:<nametype>%
25351 Provides a name list which is abbreviated (with
25352 \begin_inset Quotes eld
25356 \begin_inset Quotes erd
25360 \begin_inset Flex Code
25363 \begin_layout Plain Layout
25372 \begin_layout Itemize
25373 \begin_inset Flex Code
25376 \begin_layout Plain Layout
25377 %fullbynames:<nametype>%
25383 Provides a full name list (never abbreviated with
25384 \begin_inset Quotes eld
25388 \begin_inset Quotes erd
25394 \begin_layout Itemize
25395 \begin_inset Flex Code
25398 \begin_layout Plain Layout
25399 %forceabbrvbynames:<nametype>%
25405 Provides a name list which is always abbreviated (with
25406 \begin_inset Quotes eld
25410 \begin_inset Quotes erd
25414 \begin_inset Flex Code
25417 \begin_layout Plain Layout
25427 \begin_layout Enumerate
25428 And finally name lists which consist of family names only,
25429 as used in author-year citation labels.
25430 These do not take a
25431 \begin_inset Flex Code
25434 \begin_layout Plain Layout
25441 but always return either an author list or,
25442 if this does not exist,
25443 an editor list (as common in author-year labels):
25447 \begin_layout Itemize
25448 \begin_inset Flex Code
25451 \begin_layout Plain Layout
25458 Provides a name list which is abbreviated (with
25459 \begin_inset Quotes eld
25463 \begin_inset Quotes erd
25467 \begin_inset Flex Code
25470 \begin_layout Plain Layout
25479 \begin_layout Itemize
25480 \begin_inset Flex Code
25483 \begin_layout Plain Layout
25490 Provides a full name list (never abbreviated with
25491 \begin_inset Quotes eld
25495 \begin_inset Quotes erd
25501 \begin_layout Itemize
25502 \begin_inset Flex Code
25505 \begin_layout Plain Layout
25506 %forceabbrvciteauthor%
25512 Provides a name list which is always abbreviated (with
25513 \begin_inset Quotes eld
25517 \begin_inset Quotes erd
25521 \begin_inset Flex Code
25524 \begin_layout Plain Layout
25534 \begin_layout Standard
25535 The order of pre- and surname in the former two lists can be adjusted by these macros:
25538 \begin_layout Itemize
25539 \begin_inset Flex Code
25542 \begin_layout Plain Layout
25543 !firstnameform %surname%,
25549 (first author in lists of type 1)
25552 \begin_layout Itemize
25553 \begin_inset Flex Code
25556 \begin_layout Plain Layout
25557 !othernameform %surname%,
25563 (other authors in lists of type 1)
25566 \begin_layout Itemize
25567 \begin_inset Flex Code
25570 \begin_layout Plain Layout
25571 !firstbynameform %prename% %surname%
25576 (first author in lists of type 2)
25579 \begin_layout Itemize
25580 \begin_inset Flex Code
25583 \begin_layout Plain Layout
25584 !otherbynameform %prename% %surname%
25589 (other authors in lists of type 2)
25592 \begin_layout Standard
25593 This allows you to configure namings like
25594 \begin_inset Quotes eld
25598 Peter and Mary Smith:
25602 John Doe and Pat Green,
25603 eds.:\SpecialChar ldots
25605 \begin_inset Quotes erd
25611 \begin_layout Standard
25612 There is one other piece of syntax available in definitions,
25613 which looks like this:
25615 \begin_inset Flex Code
25618 \begin_layout Plain Layout
25625 This defines a piece of formatting information that is to be used when creating
25626 \begin_inset Quotes eld
25630 \begin_inset Quotes erd
25635 we do not want to output HTML tags when writing plain text,
25636 so they should be wrapped in
25637 \begin_inset Quotes eld
25641 \begin_inset Quotes erd
25645 \begin_inset Quotes eld
25649 \begin_inset Quotes erd
25655 \begin_layout Standard
25656 Two special sorts of definitions are also possible in a
25657 \begin_inset Flex Code
25660 \begin_layout Plain Layout
25667 An example of the first would be:
25670 \begin_layout LyX-Code
25672 \begin_inset Quotes eld
25676 \begin_inset Quotes erd
25682 \begin_layout Standard
25683 This is an abbreviation,
25685 and it can be used by treating it as if it were a key:
25687 \begin_inset Flex Code
25690 \begin_layout Plain Layout
25699 \begin_inset Flex Code
25702 \begin_layout Plain Layout
25708 exactly as it would treat its definition.
25710 let us issue the obvious
25718 \begin_layout LyX-Code
25722 \begin_layout Standard
25723 or anything like it.
25725 shouldn't go into an infinite loop,
25726 but it may go into a long one before it gives up.
25729 \begin_layout Standard
25730 The second sort of special definition might look like this:
25733 \begin_layout LyX-Code
25737 \begin_layout Standard
25738 This defines a translatable piece of text,
25739 which allows relevant parts of the bibliography or citation to be translated.
25740 It can be included in a definition by treating it as a key:
25742 \begin_inset Flex Code
25745 \begin_layout Plain Layout
25752 Note that there are two different translation paths:
25753 All definitions starting with
25754 \begin_inset Flex Code
25757 \begin_layout Plain Layout
25764 such as in the example above,
25765 will be translated to the currently active buffer language (so the translation will match the generated document).
25766 All definitions starting with underscore only will be translated to the GUI language.
25767 This is the proper translation for strings that only occur in the dialogs or on buttons,
25771 \begin_layout LyX-Code
25772 _addtobib Add to bibliography only.
25775 \begin_layout Standard
25776 Several of these translatable strings are predefined in
25777 \begin_inset Flex Code
25780 \begin_layout Plain Layout
25787 \begin_inset Flex Code
25790 \begin_layout Plain Layout
25797 Note that these are not macros,
25798 in the sense just defined.
25799 They will not be expanded.
25802 \begin_layout Standard
25803 So here then is an example that uses several of these features:
25804 \begin_inset VSpace defskip
25810 \begin_layout Standard
25814 !authoredit {%author%[[%author%,
25815 ]][[{%editor%[[%editor%,
25820 \begin_layout Standard
25821 \begin_inset VSpace defskip
25824 This defines a macro that prints the author,
25825 followed by a comma,
25827 \begin_inset Flex Code
25830 \begin_layout Plain Layout
25837 or else prints the name of the editor,
25839 \begin_inset Flex Code
25842 \begin_layout Plain Layout
25848 or its translation (it is by default
25849 \begin_inset Quotes eld
25853 \begin_inset Quotes erd
25858 \begin_inset Flex Code
25861 \begin_layout Plain Layout
25868 Note that this is in fact defined in
25869 \begin_inset Flex Code
25872 \begin_layout Plain Layout
25879 so you can use it in your own definitions,
25881 if you load that file first.
25884 \begin_layout Section
25885 \begin_inset CommandInset label
25887 name "sec:Tags-for-XHTML"
25891 Tags for XHTML output
25894 \begin_layout Standard
25895 As with \SpecialChar LaTeX
25897 the format of \SpecialChar LyX
25898 's XHTML output is also controlled by layout information.
25901 provides sensible defaults and,
25902 as mentioned earlier,
25903 it will even construct default CSS style rules from the other layout tags.
25906 will attempt to use the information provided in the
25907 \begin_inset Flex Code
25910 \begin_layout Plain Layout
25916 declaration for the Chapter style to write CSS that will appropriately format chapter headings.
25919 \begin_layout Standard
25922 you may not have to do anything at all to get acceptable XHTML output for your own environments,
25925 But in some cases you will,
25926 and so \SpecialChar LyX
25927 provides a number of layout tags that can be used to customize the XHTML and CSS that are generated.
25930 \begin_layout Standard
25931 Note that there are two tags,
25933 \begin_inset Flex Code
25936 \begin_layout Plain Layout
25943 \begin_inset Flex Code
25946 \begin_layout Plain Layout
25952 that may appear outside style and inset declarations.
25954 \begin_inset CommandInset ref
25956 reference "subsec:General-text-class"
25961 for details on these.
25964 \begin_layout Subsection
25965 \begin_inset CommandInset label
25967 name "subsec:Paragraph-Style-XHTML"
25974 \begin_layout Standard
25975 The sort of XHTML \SpecialChar LyX
25976 outputs for a paragraph depends upon whether we are dealing with a normal paragraph,
25979 where this is itself determined by the contents of the corresponding
25980 \begin_inset Flex Code
25983 \begin_layout Plain Layout
25994 \begin_layout Standard
25995 For a command or normal paragraph,
25996 the output XHTML has the following form:
25999 \begin_layout LyX-Code
26003 \begin_inset Quotes erd
26007 \begin_inset Quotes erd
26013 \begin_layout LyX-Code
26017 \begin_inset Quotes erd
26021 \begin_inset Quotes erd
26027 \begin_layout LyX-Code
26030 Contents of the paragraph.
26033 \begin_layout LyX-Code
26039 \begin_layout Standard
26040 The label tags are of course omitted if the paragraph does not have a label.
26043 \begin_layout Standard
26044 For an environment that is not some sort of list,
26045 the XHTML takes this form:
26048 \begin_layout LyX-Code
26052 \begin_inset Quotes erd
26056 \begin_inset Quotes erd
26062 \begin_layout LyX-Code
26066 \begin_inset Quotes erd
26070 \begin_inset Quotes erd
26074 \begin_inset Quotes erd
26078 \begin_inset Quotes erd
26081 >Environment Label</labeltag>First paragraph.</itemtag>
26084 \begin_layout LyX-Code
26087 <itemtag>Second paragraph.</itemtag>
26090 \begin_layout LyX-Code
26096 \begin_layout Standard
26097 Note that the label is output only for the first paragraph,
26098 as it should be for a theorem,
26103 \begin_layout Standard
26105 we have one of these forms:
26108 \begin_layout LyX-Code
26112 \begin_inset Quotes erd
26116 \begin_inset Quotes erd
26122 \begin_layout LyX-Code
26126 \begin_inset Quotes erd
26130 \begin_inset Quotes erd
26134 \begin_inset Quotes erd
26138 \begin_inset Quotes erd
26141 >List Label</labeltag>First item.</itemtag>
26144 \begin_layout LyX-Code
26148 \begin_inset Quotes erd
26152 \begin_inset Quotes erd
26156 \begin_inset Quotes erd
26160 \begin_inset Quotes erd
26163 >List Label</labeltag>Second item.</itemtag>
26166 \begin_layout LyX-Code
26172 \begin_layout LyX-Code
26176 \begin_layout LyX-Code
26180 \begin_inset Quotes erd
26184 \begin_inset Quotes erd
26190 \begin_layout LyX-Code
26194 \begin_inset Quotes erd
26198 \begin_inset Quotes erd
26201 >List Label</labeltag><itemtag attr=
26202 \begin_inset Quotes erd
26206 \begin_inset Quotes erd
26209 >First item.</itemtag>
26212 \begin_layout LyX-Code
26216 \begin_inset Quotes erd
26220 \begin_inset Quotes erd
26223 >List Label</labeltag><itemtag attr=
26224 \begin_inset Quotes erd
26228 \begin_inset Quotes erd
26231 >Second item.</itemtag>
26234 \begin_layout LyX-Code
26240 \begin_layout Standard
26241 Note the different orders of
26242 \begin_inset Flex Code
26245 \begin_layout Plain Layout
26252 \begin_inset Flex Code
26255 \begin_layout Plain Layout
26262 Which order we get depends upon the setting of
26263 \begin_inset Flex Code
26266 \begin_layout Plain Layout
26274 \begin_inset Flex Code
26277 \begin_layout Plain Layout
26283 is false (the default),
26284 you get the first of these,
26285 with the label within the item;
26287 you get the second,
26288 with the label outside the item.
26291 \begin_layout Standard
26292 The specific tags and attributes output for each paragraph type can be controlled by means of the layout tags we are about to describe.
26293 As mentioned earlier,
26296 uses sensible defaults for many of these,
26297 so you often may not need to do very much to get good XHTML output.
26298 Think of the available tags as there so you can tweak things to your liking.
26301 \begin_layout Description
26302 \begin_inset Flex Code
26305 \begin_layout Plain Layout
26312 \begin_inset Flex Code
26315 \begin_layout Plain Layout
26321 ] Specifies attribute information to be output with the main tag.
26324 \begin_inset Quotes eld
26328 \begin_inset Flex Code
26331 \begin_layout Plain Layout
26338 \begin_inset Quotes erd
26345 \begin_inset Quotes eld
26349 \begin_inset Flex Code
26352 \begin_layout Plain Layout
26359 \begin_inset Quotes erd
26364 \begin_inset Flex Code
26367 \begin_layout Plain Layout
26373 is the \SpecialChar LyX
26374 name of the layout,
26382 contain any style information.
26384 \begin_inset Flex Code
26387 \begin_layout Plain Layout
26396 \begin_layout Description
26397 \begin_inset Flex Code
26400 \begin_layout Plain Layout
26407 \begin_inset Flex Code
26410 \begin_layout Plain Layout
26416 ] The CSS class to use for this paragraph.
26418 if the paragarph is of enumerate or itemize type,
26419 then the default will be
26420 \begin_inset Quotes eld
26424 \begin_inset Quotes erd
26428 \begin_inset Quotes eld
26432 \begin_inset Quotes erd
26437 \begin_inset Quotes eld
26441 \begin_inset Quotes erd
26446 \begin_inset Quotes eld
26450 \begin_inset Quotes erd
26455 \begin_inset Quotes eld
26459 \begin_inset Quotes erd
26464 \begin_inset Quotes eld
26468 \begin_inset Quotes erd
26472 depending upon the depth.
26473 That can be over-ridden here.
26475 the suffix will not be added in that case.
26477 the CSS class will always be exactly what it is declared to be here.
26480 \begin_layout Description
26481 \begin_inset Flex Code
26484 \begin_layout Plain Layout
26491 \begin_inset Flex Code
26494 \begin_layout Plain Layout
26504 ] Whether to output the default CSS information \SpecialChar LyX
26505 generates for this layout,
26506 even if additional information is explicitly provided via
26507 \begin_inset Flex Code
26510 \begin_layout Plain Layout
26518 \begin_inset Flex Code
26521 \begin_layout Plain Layout
26527 allows you to alter or augment the generated CSS,
26528 rather than to override it completely.
26530 \begin_inset Flex Code
26533 \begin_layout Plain Layout
26542 \begin_layout Description
26543 \begin_inset Flex Code
26546 \begin_layout Plain Layout
26553 \begin_inset Flex Code
26556 \begin_layout Plain Layout
26564 ] Whether to include this paragraph (usually,
26565 a section or something of the sort) in the TOC.
26568 so it should be set to false e.g.
26569 \begin_inset space ~
26572 for starred sections.
26575 \begin_layout Description
26576 \begin_inset Flex Code
26579 \begin_layout Plain Layout
26586 \begin_inset Flex Code
26589 \begin_layout Plain Layout
26595 ] The tag to be used for individual paragraphs of environments,
26597 \begin_inset Flex Code
26600 \begin_layout Plain Layout
26606 in the examples above.
26608 \begin_inset Flex Code
26611 \begin_layout Plain Layout
26620 \begin_layout Description
26621 \begin_inset Flex Code
26624 \begin_layout Plain Layout
26631 \begin_inset Flex Code
26634 \begin_layout Plain Layout
26640 ] Attributes for the item tag.
26642 \begin_inset Newline newline
26646 \begin_inset Quotes eld
26650 \begin_inset Flex Code
26653 \begin_layout Plain Layout
26654 class=`layoutname_item'
26660 \begin_inset Quotes erd
26668 contain any style information.
26670 \begin_inset Flex Code
26673 \begin_layout Plain Layout
26682 \begin_layout Description
26683 \begin_inset Flex Code
26686 \begin_layout Plain Layout
26693 \begin_inset Flex Code
26696 \begin_layout Plain Layout
26702 ] The tag to be used for paragraph and item labels,
26704 \begin_inset Flex Code
26707 \begin_layout Plain Layout
26713 in the examples above.
26715 \begin_inset Flex Code
26718 \begin_layout Plain Layout
26726 \begin_inset Flex Code
26729 \begin_layout Plain Layout
26736 \begin_inset Flex Code
26739 \begin_layout Plain Layout
26746 \begin_inset Flex Code
26749 \begin_layout Plain Layout
26750 Centered_Top_Environment
26756 in which case it defaults to
26757 \begin_inset Flex Code
26760 \begin_layout Plain Layout
26769 \begin_layout Description
26770 \begin_inset Flex Code
26773 \begin_layout Plain Layout
26780 \begin_inset Flex Code
26783 \begin_layout Plain Layout
26789 ] Attributes for the label tag.
26791 \begin_inset Newline newline
26795 \begin_inset Quotes eld
26799 \begin_inset Flex Code
26802 \begin_layout Plain Layout
26803 class=`layoutname_label'
26809 \begin_inset Quotes erd
26817 contain any style information.
26819 \begin_inset Flex Code
26822 \begin_layout Plain Layout
26831 \begin_layout Description
26832 \begin_inset Flex Code
26835 \begin_layout Plain Layout
26842 \begin_inset Flex Code
26845 \begin_layout Plain Layout
26855 ] Meaningful only for list-like environments,
26856 this tag controls whether the label tag is output before or inside the item tag.
26859 in the description environment,
26861 \begin_inset Flex Code
26864 \begin_layout Plain Layout
26865 <dt>\SpecialChar ldots
26866 </dt><dd>\SpecialChar ldots
26874 \begin_inset Flex Code
26877 \begin_layout Plain Layout
26884 The label tag is output inside the item tag.
26887 \begin_layout Description
26888 \begin_inset Flex Code
26891 \begin_layout Plain Layout
26897 Information to be output in the
26898 \begin_inset Flex Code
26901 \begin_layout Plain Layout
26907 section when this style is used.
26910 be used to include a
26911 \begin_inset Flex Code
26914 \begin_layout Plain Layout
26921 \begin_inset Flex Code
26924 \begin_layout Plain Layout
26933 \begin_layout Description
26934 \begin_inset Flex Code
26937 \begin_layout Plain Layout
26943 CSS style information to be included when this style is used.
26944 Note that this will automatically be wrapped in a layout-generated
26945 \begin_inset Flex Code
26948 \begin_layout Plain Layout
26955 so only the CSS itself need be included.
26957 \begin_inset Flex Code
26960 \begin_layout Plain Layout
26969 \begin_layout Description
26970 \begin_inset Flex Code
26973 \begin_layout Plain Layout
26980 \begin_inset Flex Code
26983 \begin_layout Plain Layout
26989 ] The tag to be used for the main label,
26991 \begin_inset Flex Code
26994 \begin_layout Plain Layout
27000 in the examples above.
27002 \begin_inset Flex Code
27005 \begin_layout Plain Layout
27014 \begin_layout Description
27015 \begin_inset Flex Code
27018 \begin_layout Plain Layout
27025 \begin_inset Flex Code
27028 \begin_layout Plain Layout
27038 ] Marks this style as the one to be used to generate the
27039 \begin_inset Flex Code
27042 \begin_layout Plain Layout
27048 tag for the XHTML file.
27052 \begin_inset Flex Code
27055 \begin_layout Plain Layout
27061 file sets it to true for the
27062 \begin_inset Flex Code
27065 \begin_layout Plain Layout
27075 \begin_layout Subsection
27079 \begin_layout Standard
27080 The XHTML output of insets can also be controlled by information in layout files.
27084 \begin_layout Plain Layout
27086 this is true only for
27087 \begin_inset Quotes eld
27091 \begin_inset Quotes erd
27094 insets (insets you can type into) and is not true for
27095 \begin_inset Quotes eld
27099 \begin_inset Quotes erd
27102 insets (insets that are associated with dialog boxes).
27110 tries to provide sensible defaults,
27111 and it constructs default CSS style rules.
27112 But everything can be customized.
27115 \begin_layout Standard
27116 The XHTML \SpecialChar LyX
27117 outputs for an inset has the following form:
27120 \begin_layout LyX-Code
27122 \begin_inset Quotes erd
27126 \begin_inset Quotes erd
27132 \begin_layout LyX-Code
27133 <labeltag>Label</labeltag>
27136 \begin_layout LyX-Code
27138 \begin_inset Quotes erd
27142 \begin_inset Quotes erd
27145 >Contents of the inset.</innertag>
27148 \begin_layout LyX-Code
27152 \begin_layout Standard
27153 If the inset permits multiple paragraphs—
27156 \begin_inset Flex Code
27159 \begin_layout Plain Layout
27166 then the contents of the inset will itself be output as paragraphs formatted according to the styles used for those paragraphs (standard,
27169 The label tag is of course omitted if the paragraph does not have a label and,
27172 \begin_inset Flex Code
27175 \begin_layout Plain Layout
27182 The inner tag is optional and,
27187 \begin_layout Standard
27188 The specific tags and attributes output for each inset can be controlled by means of the following layout tags.
27191 \begin_layout Description
27192 \begin_inset Flex Code
27195 \begin_layout Plain Layout
27202 \begin_inset Flex Code
27205 \begin_layout Plain Layout
27211 ] Specifies attribute information to be output with the main tag.
27214 \begin_inset Quotes eld
27218 \begin_inset Flex Code
27221 \begin_layout Plain Layout
27222 class=`myinset' onclick=`\SpecialChar ldots
27229 \begin_inset Quotes erd
27236 \begin_inset Quotes eld
27240 \begin_inset Flex Code
27243 \begin_layout Plain Layout
27250 \begin_inset Quotes erd
27255 \begin_inset Flex Code
27258 \begin_layout Plain Layout
27264 is the \SpecialChar LyX
27266 made lowercase and with non-alphanumeric characters converted to underscores,
27271 \begin_layout Description
27272 \begin_inset Flex Code
27275 \begin_layout Plain Layout
27282 \begin_inset Flex Code
27285 \begin_layout Plain Layout
27295 ] Whether to output the default CSS information \SpecialChar LyX
27296 generates for this layout,
27297 even if additional information is explicitly provided via
27298 \begin_inset Flex Code
27301 \begin_layout Plain Layout
27309 \begin_inset Flex Code
27312 \begin_layout Plain Layout
27318 allows you to alter or augment the generated CSS,
27319 rather than to override it completely.
27323 \begin_layout Description
27324 \begin_inset Flex Code
27327 \begin_layout Plain Layout
27334 \begin_inset Flex Code
27337 \begin_layout Plain Layout
27343 ] Attributes for the inner tag.
27345 \begin_inset Newline newline
27349 \begin_inset Quotes eld
27353 \begin_inset Flex Code
27356 \begin_layout Plain Layout
27357 class=`insetname_inner'
27363 \begin_inset Quotes erd
27369 \begin_layout Description
27370 \begin_inset Flex Code
27373 \begin_layout Plain Layout
27380 \begin_inset Flex Code
27383 \begin_layout Plain Layout
27391 \begin_inset Flex Code
27394 \begin_layout Plain Layout
27400 in the examples above.
27405 \begin_layout Description
27406 \begin_inset Flex Code
27409 \begin_layout Plain Layout
27416 \begin_inset Flex Code
27419 \begin_layout Plain Layout
27427 ] 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).
27431 \begin_layout Description
27432 \begin_inset Flex Code
27435 \begin_layout Plain Layout
27442 \begin_inset Flex Code
27445 \begin_layout Plain Layout
27451 ] A label for this inset,
27452 possibly including a reference to a counter.
27457 \begin_inset Flex Code
27460 \begin_layout Plain Layout
27470 and there is no default.
27473 \begin_layout Description
27474 \begin_inset Flex Code
27477 \begin_layout Plain Layout
27483 Information to be output in the
27484 \begin_inset Flex Code
27487 \begin_layout Plain Layout
27493 section when this style is used.
27496 be used to include a
27497 \begin_inset Flex Code
27500 \begin_layout Plain Layout
27507 \begin_inset Flex Code
27510 \begin_layout Plain Layout
27519 \begin_layout Description
27520 \begin_inset Flex Code
27523 \begin_layout Plain Layout
27529 CSS style information to be included when this style is used.
27530 Note that this will automatically be wrapped in a layout-generated
27531 \begin_inset Flex Code
27534 \begin_layout Plain Layout
27541 so only the CSS itself need be included.
27544 \begin_layout Description
27545 \begin_inset Flex Code
27548 \begin_layout Plain Layout
27555 \begin_inset Flex Code
27558 \begin_layout Plain Layout
27564 ] The tag to be used for the main label,
27566 \begin_inset Flex Code
27569 \begin_layout Plain Layout
27575 in the examples above.
27576 The default depends upon the setting of
27577 \begin_inset Flex Code
27580 \begin_layout Plain Layout
27588 \begin_inset Flex Code
27591 \begin_layout Plain Layout
27599 \begin_inset Flex Code
27602 \begin_layout Plain Layout
27611 \begin_inset Flex Code
27614 \begin_layout Plain Layout
27623 \begin_layout Subsection
27627 \begin_layout Standard
27628 The XHTML output for floats too can be controlled by layout information.
27629 The output has the following form:
27632 \begin_layout LyX-Code
27634 \begin_inset Quotes erd
27638 \begin_inset Quotes erd
27644 \begin_layout LyX-Code
27645 Contents of the float.
27648 \begin_layout LyX-Code
27652 \begin_layout Standard
27655 is a separate inset and will be output as such.
27656 Its appearance can be controlled via the InsetLayout for caption insets.
27660 \begin_layout Description
27661 \begin_inset Flex Code
27664 \begin_layout Plain Layout
27671 \begin_inset Flex Code
27674 \begin_layout Plain Layout
27680 ] Specifies attribute information to be output with the main tag.
27683 \begin_inset Quotes eld
27687 \begin_inset Flex Code
27690 \begin_layout Plain Layout
27691 class=`myfloat' onclick=`\SpecialChar ldots
27698 \begin_inset Quotes erd
27705 \begin_inset Quotes eld
27709 \begin_inset Flex Code
27712 \begin_layout Plain Layout
27713 class=`float float-floattype'
27719 \begin_inset Quotes erd
27724 \begin_inset Flex Code
27727 \begin_layout Plain Layout
27733 is \SpecialChar LyX
27734 's name for this type of float,
27735 as determined by the float declaration (see
27736 \begin_inset CommandInset ref
27738 reference "subsec:Floats"
27744 though made lowercase and with non-alphanumeric characters converted to underscores,
27749 \begin_layout Description
27750 \begin_inset Flex Code
27753 \begin_layout Plain Layout
27759 CSS style information to be included when this float is used.
27760 Note that this will automatically be wrapped in a layout-generated
27761 \begin_inset Flex Code
27764 \begin_layout Plain Layout
27771 so only the CSS itself need be included.
27774 \begin_layout Description
27775 \begin_inset Flex Code
27778 \begin_layout Plain Layout
27785 \begin_inset Flex Code
27788 \begin_layout Plain Layout
27794 ] The tag to be used for this float,
27796 \begin_inset Quotes eld
27800 \begin_inset Flex Code
27803 \begin_layout Plain Layout
27810 \begin_inset Quotes erd
27813 in the example above.
27815 \begin_inset Flex Code
27818 \begin_layout Plain Layout
27824 and will rarely need changing.
27827 \begin_layout Subsection
27828 Bibliography formatting
27831 \begin_layout Standard
27832 The bibliography can be formatted using
27833 \begin_inset Flex Code
27836 \begin_layout Plain Layout
27844 \begin_inset CommandInset ref
27846 reference "subsec:Citation-format-description"
27854 \begin_layout Subsection
27859 \begin_layout Standard
27860 We have several times mentioned that \SpecialChar LyX
27861 will generate default CSS style rules for both insets and paragraph styles,
27862 based upon the other layout information that is provided.
27864 we shall say a word about which layout information \SpecialChar LyX
27868 \begin_layout Standard
27871 auto-generates CSS only for font information,
27873 \begin_inset Flex Code
27876 \begin_layout Plain Layout
27884 \begin_inset Flex Code
27887 \begin_layout Plain Layout
27895 \begin_inset Flex Code
27898 \begin_layout Plain Layout
27906 \begin_inset Flex Code
27909 \begin_layout Plain Layout
27916 \begin_inset Flex Code
27919 \begin_layout Plain Layout
27926 \begin_inset CommandInset ref
27928 reference "subsec:Font-description"
27934 The translation is mostly straightforward and obvious.
27937 \begin_inset Quotes eld
27941 \begin_inset Flex Code
27944 \begin_layout Plain Layout
27951 \begin_inset Quotes erd
27955 \begin_inset Quotes eld
27959 \begin_inset Flex Code
27962 \begin_layout Plain Layout
27970 \begin_inset Quotes erd
27974 The correspondence of \SpecialChar LyX
27975 sizes and CSS sizes is a little less obvious but nonetheless intuitive.
27977 \begin_inset Flex Code
27980 \begin_layout Plain Layout
27987 \begin_inset Flex URL
27990 \begin_layout Plain Layout
28000 \begin_layout Section
28001 \begin_inset CommandInset label
28003 name "sec:Tags-for-DocBook"
28007 Tags for DocBook output
28010 \begin_layout Standard
28011 As with \SpecialChar LaTeX
28013 the format of \SpecialChar LyX
28014 's DocBook output is also controlled by layout information.
28017 provides sensible defaults;
28019 much of the styling is lost during the conversion,
28020 as DocBook is strictly semantic and does not allow formatting.
28022 information from \SpecialChar LyX
28023 will be rendered in
28030 \begin_layout Standard
28033 you may not have to do anything at all to get acceptable DocBook output for your own environments,
28036 But in some cases you will,
28037 and so \SpecialChar LyX
28038 provides a number of layout tags that can be used to customize the DocBook that is generated.
28041 \begin_layout Standard
28042 Labels are rarely output,
28043 as they are redundant in DocBook:
28044 this information is carried by the tags themselves,
28045 and whether labels appear in the final documents (after processing of DocBook files) is controlled by the stylesheets.
28048 labels are not redundant content,
28049 such as definition lists:
28051 the term being defined will be the label.
28054 \begin_layout Subsection
28055 \begin_inset CommandInset label
28057 name "subsec:Paragraph-Style-DocBook"
28064 \begin_layout Standard
28065 The sort of DocBook \SpecialChar LyX
28066 outputs for a paragraph depends upon whether we are dealing with a normal paragraph,
28069 where this is itself determined by the contents of the corresponding
28070 \begin_inset Flex Code
28073 \begin_layout Plain Layout
28083 \begin_layout Standard
28084 For a command or normal paragraph,
28085 the output DocBook has the following form:
28088 \begin_layout LyX-Code
28092 \begin_layout LyX-Code
28093 Contents of the paragraph.
28096 \begin_layout LyX-Code
28100 \begin_layout Standard
28101 For an environment that is not some sort of list,
28102 the generated DocBook takes this form:
28105 \begin_layout LyX-Code
28109 \begin_layout LyX-Code
28110 <itemtag>First paragraph.</itemtag>
28113 \begin_layout LyX-Code
28114 <itemtag>Second paragraph.</itemtag>
28117 \begin_layout LyX-Code
28121 \begin_layout Standard
28123 the resulting DocBook takes this form:
28126 \begin_layout LyX-Code
28130 \begin_layout LyX-Code
28131 <itemtag attr>First item.</itemtag>
28134 \begin_layout LyX-Code
28135 <itemtag attr>Second item.</itemtag>
28138 \begin_layout LyX-Code
28142 \begin_layout Standard
28143 The specific tags and roles output for each paragraph type can be controlled by means of the layout tags we are about to describe.
28145 due to the very nature of DocBook,
28146 no sensible defaults really exist,
28147 and the values must always be carefully chosen.
28150 \begin_layout Description
28151 \begin_inset Flex Code
28154 \begin_layout Plain Layout
28161 \begin_inset Flex Code
28164 \begin_layout Plain Layout
28170 ] Specifies attribute information to be output with the main tag,
28172 \begin_inset Quotes eld
28176 \begin_inset Flex Code
28179 \begin_layout Plain Layout
28186 \begin_inset Quotes erd
28189 in the example above.
28190 This information can be used in further processing of the DocBook files.
28193 \begin_layout Description
28194 \begin_inset Flex Code
28197 \begin_layout Plain Layout
28204 \begin_inset Flex Code
28207 \begin_layout Plain Layout
28213 ] The tag to be used for this inset,
28215 \begin_inset Quotes eld
28219 \begin_inset Flex Code
28222 \begin_layout Plain Layout
28229 \begin_inset Quotes erd
28232 in the example above.
28233 The default is the name of the float and always needs to be changed,
28234 as DocBook provides no generic tag.
28237 \begin_layout Description
28238 \begin_inset Flex Code
28241 \begin_layout Plain Layout
28248 \begin_inset Flex Code
28251 \begin_layout Plain Layout
28259 ] The new-line policy for this tag,
28261 \begin_inset space ~
28265 \begin_inset CommandInset ref
28267 reference "subsec:DocBook-New-line-policy"
28278 \begin_layout Subsection
28280 \begin_inset CommandInset label
28282 name "subsec:DocBook-New-line-policy"
28289 \begin_layout Standard
28291 there are three possible policies for outputting new lines (given in the
28292 \begin_inset Flex Code
28295 \begin_layout Plain Layout
28304 \begin_layout Itemize
28305 \begin_inset Quotes eld
28309 \begin_inset Flex Code
28312 \begin_layout Plain Layout
28319 \begin_inset Quotes erd
28323 the opening and closing tags are on their own lines (i.e.
28324 a line feed after and before the opening and the closing tags).
28325 Typical elements are floats.
28329 \begin_layout LyX-Code
28333 \begin_layout LyX-Code
28337 \begin_layout LyX-Code
28338 Contents of the block.
28341 \begin_layout LyX-Code
28345 \begin_layout LyX-Code
28349 \begin_layout Itemize
28350 \begin_inset Quotes eld
28354 \begin_inset Flex Code
28357 \begin_layout Plain Layout
28364 \begin_inset Quotes erd
28368 the opening and closing tags are on the same,
28370 a line feed is output before the opening tag and after the closing tag.
28371 Typical elements are paragraphs and list items.
28375 \begin_layout LyX-Code
28379 \begin_layout LyX-Code
28380 <paratag>Contents of the paragraph.</paratag>
28383 \begin_layout LyX-Code
28387 \begin_layout Itemize
28388 \begin_inset Quotes eld
28392 \begin_inset Flex Code
28395 \begin_layout Plain Layout
28402 \begin_inset Quotes erd
28406 the opening and closing tags are on the same line as the rest of the content.
28407 No line feeds are output.
28408 Typical elements are fonts.
28412 \begin_layout LyX-Code
28413 Content before<inlinetag>Contents of the paragraph.</inlinetag>Content after
28416 \begin_layout Standard
28417 The default value is always
28418 \begin_inset Quotes eld
28422 \begin_inset Flex Code
28425 \begin_layout Plain Layout
28432 \begin_inset Quotes erd
28438 \begin_layout Subsection
28439 InsetLayout DocBook
28442 \begin_layout Standard
28443 The DocBook output of insets can also be controlled by information in layout files.
28446 \begin_layout Standard
28447 The DocBook \SpecialChar LyX
28448 outputs for an inset has the following form:
28451 \begin_layout LyX-Code
28452 <wrappertag wrapperattr>
28455 \begin_layout LyX-Code
28459 \begin_layout LyX-Code
28460 <innertag innerattr>
28463 \begin_layout LyX-Code
28464 Contents of the inset.
28467 \begin_layout LyX-Code
28471 \begin_layout LyX-Code
28475 \begin_layout LyX-Code
28479 \begin_layout Standard
28480 For an itemising inset,
28481 it rather looks like this:
28484 \begin_layout LyX-Code
28485 <wrappertag wrapperattr>
28488 \begin_layout LyX-Code
28492 \begin_layout LyX-Code
28493 <innertag innerattr>
28496 \begin_layout LyX-Code
28497 <itemwrappertag itemwrapperattr>
28500 \begin_layout LyX-Code
28501 <itemlabeltag itemattr>
28504 \begin_layout LyX-Code
28505 Label of the first item.
28508 \begin_layout LyX-Code
28512 \begin_layout LyX-Code
28516 \begin_layout LyX-Code
28520 \begin_layout LyX-Code
28521 Contents of the first item.
28524 \begin_layout LyX-Code
28528 \begin_layout LyX-Code
28532 \begin_layout LyX-Code
28536 \begin_layout LyX-Code
28537 <itemwrappertag itemwrapperattr>
28540 \begin_layout LyX-Code
28541 <itemlabeltag itemattr>
28544 \begin_layout LyX-Code
28545 Label of the second item.
28548 \begin_layout LyX-Code
28552 \begin_layout LyX-Code
28556 \begin_layout LyX-Code
28560 \begin_layout LyX-Code
28561 Contents of the second item.
28564 \begin_layout LyX-Code
28568 \begin_layout LyX-Code
28572 \begin_layout LyX-Code
28576 \begin_layout LyX-Code
28580 \begin_layout LyX-Code
28584 \begin_layout LyX-Code
28588 \begin_layout LyX-Code
28592 \begin_layout Standard
28593 If the inset permits multiple paragraphs—
28596 \begin_inset Flex Code
28599 \begin_layout Plain Layout
28606 then the contents of the inset will themselves be output as paragraphs formatted according to the styles used for those paragraphs (standard,
28609 The inner tag is optional and,
28614 \begin_layout Standard
28615 The specific tags and attributes output for each inset can be controlled by means of the following layout tags.
28618 \begin_layout Description
28619 \begin_inset Flex Code
28622 \begin_layout Plain Layout
28629 \begin_inset Flex Code
28632 \begin_layout Plain Layout
28638 ] Specifies attribute information to be output with the main tag,
28640 \begin_inset Quotes eld
28644 \begin_inset Flex Code
28647 \begin_layout Plain Layout
28654 \begin_inset Quotes erd
28657 in the example above.
28658 This information can be used in further processing of the DocBook files.
28661 \begin_layout Description
28662 \begin_inset Flex Code
28665 \begin_layout Plain Layout
28672 \begin_inset Flex Code
28675 \begin_layout Plain Layout
28683 ] Specifies whether this tag goes into the
28684 \begin_inset Flex Code
28687 \begin_layout Plain Layout
28693 tag at the beginning of the parent layout.
28695 \begin_inset Flex Code
28698 \begin_layout Plain Layout
28704 indicates that the tag never goes into
28705 \begin_inset Flex Code
28708 \begin_layout Plain Layout
28714 (this is default value,
28715 and corresponds to usual content).
28717 \begin_inset Flex Code
28720 \begin_layout Plain Layout
28726 indicates that the tag always goes into
28727 \begin_inset Flex Code
28730 \begin_layout Plain Layout
28736 (this corresponds to usual metadata):
28738 \begin_inset Flex Code
28741 \begin_layout Plain Layout
28747 tag for the parent,
28754 \begin_inset Flex Code
28757 \begin_layout Plain Layout
28763 indicates that the tag may go into
28764 \begin_inset Flex Code
28767 \begin_layout Plain Layout
28773 (this is only the case for titles):
28775 \begin_inset Flex Code
28778 \begin_layout Plain Layout
28784 tag for the parent,
28790 the corresponding tag will be output directly as content.
28793 \begin_layout Description
28794 \begin_inset Flex Code
28797 \begin_layout Plain Layout
28804 \begin_inset Flex Code
28807 \begin_layout Plain Layout
28813 ] Specifies attribute information to be output with the item tag,
28815 \begin_inset Quotes eld
28819 \begin_inset Flex Code
28822 \begin_layout Plain Layout
28829 \begin_inset Quotes erd
28832 in the example above.
28833 This information can be used in further processing of the DocBook files.
28836 \begin_layout Description
28837 \begin_inset Flex Code
28840 \begin_layout Plain Layout
28841 DocBookItemInnerAttr
28847 \begin_inset Flex Code
28850 \begin_layout Plain Layout
28856 ] Specifies attribute information to be output with the item inner tag,
28858 \begin_inset Quotes eld
28862 \begin_inset Flex Code
28865 \begin_layout Plain Layout
28872 \begin_inset Quotes erd
28875 in the example above.
28876 This information can be used in further processing of the DocBook files.
28879 \begin_layout Description
28880 \begin_inset Flex Code
28883 \begin_layout Plain Layout
28884 DocBookItemInnerTag
28890 \begin_inset Flex Code
28893 \begin_layout Plain Layout
28899 ] The tag to be used for the item inner tag within the inset,
28901 \begin_inset Quotes eld
28905 \begin_inset Flex Code
28908 \begin_layout Plain Layout
28915 \begin_inset Quotes erd
28918 in the example above.
28920 \begin_inset Flex Code
28923 \begin_layout Plain Layout
28930 indicating that there is no item inner tag:
28931 content is directly output without it for each itemised element.
28932 This parameter only makes sense when itemising layouts are used,
28934 The most likely value is
28935 \begin_inset Quotes eld
28939 \begin_inset Flex Code
28942 \begin_layout Plain Layout
28949 \begin_inset Quotes erd
28953 \begin_inset Newline newline
28956 When a list item is split using a new line,
28957 the item inner tag will be repeated for each part of the paragraph,
28958 parts being separated by new lines.
28961 \begin_layout Description
28962 \begin_inset Flex Code
28965 \begin_layout Plain Layout
28966 DocBookItemInnerTagType
28972 \begin_inset Flex Code
28975 \begin_layout Plain Layout
28983 ] The new-line policy for this tag,
28985 \begin_inset space ~
28989 \begin_inset CommandInset ref
28991 reference "subsec:DocBook-New-line-policy"
29002 \begin_layout Description
29003 \begin_inset Flex Code
29006 \begin_layout Plain Layout
29007 DocBookItemLabelAttr
29013 \begin_inset Flex Code
29016 \begin_layout Plain Layout
29022 ] Specifies attribute information to be output with the item label tag,
29024 \begin_inset Quotes eld
29028 \begin_inset Flex Code
29031 \begin_layout Plain Layout
29038 \begin_inset Quotes erd
29041 in the example above.
29042 This information can be used in further processing of the DocBook files.
29045 \begin_layout Description
29046 \begin_inset Flex Code
29049 \begin_layout Plain Layout
29050 DocBookItemLabelTag
29056 \begin_inset Flex Code
29059 \begin_layout Plain Layout
29065 ] The tag to be used for the item label tag within the inset,
29067 \begin_inset Quotes eld
29071 \begin_inset Flex Code
29074 \begin_layout Plain Layout
29081 \begin_inset Quotes erd
29084 in the example above.
29085 This parameter only makes sense when itemising layouts are used with a notion of labels,
29086 such as definition lists.
29089 \begin_layout Description
29090 \begin_inset Flex Code
29093 \begin_layout Plain Layout
29094 DocBookItemLabelTagType
29100 \begin_inset Flex Code
29103 \begin_layout Plain Layout
29111 ] The new-line policy for this tag,
29113 \begin_inset space ~
29117 \begin_inset CommandInset ref
29119 reference "subsec:DocBook-New-line-policy"
29130 \begin_layout Description
29131 \begin_inset Flex Code
29134 \begin_layout Plain Layout
29141 \begin_inset Flex Code
29144 \begin_layout Plain Layout
29150 ] The tag to be used for the item tag within the inset,
29152 \begin_inset Quotes eld
29156 \begin_inset Flex Code
29159 \begin_layout Plain Layout
29166 \begin_inset Quotes erd
29169 in the example above.
29171 \begin_inset Flex Code
29174 \begin_layout Plain Layout
29181 indicating that there is no item tag.
29182 This parameter only makes sense when itemising layouts are used,
29186 \begin_layout Description
29187 \begin_inset Flex Code
29190 \begin_layout Plain Layout
29197 \begin_inset Flex Code
29200 \begin_layout Plain Layout
29208 ] The new-line policy for this tag,
29210 \begin_inset space ~
29214 \begin_inset CommandInset ref
29216 reference "subsec:DocBook-New-line-policy"
29227 \begin_layout Description
29228 \begin_inset Flex Code
29231 \begin_layout Plain Layout
29232 DocBookItemWrapperAttr
29238 \begin_inset Flex Code
29241 \begin_layout Plain Layout
29247 ] Specifies attribute information to be output with the item wrapper tag,
29249 \begin_inset Quotes eld
29253 \begin_inset Flex Code
29256 \begin_layout Plain Layout
29263 \begin_inset Quotes erd
29266 in the example above.
29267 This information can be used in further processing of the DocBook files.
29270 \begin_layout Description
29271 \begin_inset Flex Code
29274 \begin_layout Plain Layout
29275 DocBookItemWrapperTag
29281 \begin_inset Flex Code
29284 \begin_layout Plain Layout
29290 ] The tag to be used for the item wrapper tag within the inset,
29292 \begin_inset Quotes eld
29296 \begin_inset Flex Code
29299 \begin_layout Plain Layout
29306 \begin_inset Quotes erd
29309 in the example above.
29311 \begin_inset Flex Code
29314 \begin_layout Plain Layout
29321 indicating that there is no item wrapper tag:
29322 tag and content are directly output without it for each itemised element.
29323 This parameter only makes sense when itemising layouts are used,
29327 \begin_layout Description
29328 \begin_inset Flex Code
29331 \begin_layout Plain Layout
29332 DocBookItemWrapperTagType
29338 \begin_inset Flex Code
29341 \begin_layout Plain Layout
29349 ] The new-line policy for this tag,
29351 \begin_inset space ~
29355 \begin_inset CommandInset ref
29357 reference "subsec:DocBook-New-line-policy"
29368 \begin_layout Description
29369 \begin_inset Flex Code
29372 \begin_layout Plain Layout
29379 \begin_inset Flex Code
29382 \begin_layout Plain Layout
29388 ] Specifies attribute information to be output with the inner tag,
29390 \begin_inset Quotes eld
29394 \begin_inset Flex Code
29397 \begin_layout Plain Layout
29404 \begin_inset Quotes erd
29407 in the example above.
29408 This information can be used in further processing of the DocBook files.
29411 \begin_layout Description
29412 \begin_inset Flex Code
29415 \begin_layout Plain Layout
29422 \begin_inset Flex Code
29425 \begin_layout Plain Layout
29431 ] The tag to be used for the inner tag within the inset,
29433 \begin_inset Quotes eld
29437 \begin_inset Flex Code
29440 \begin_layout Plain Layout
29447 \begin_inset Quotes erd
29450 in the example above.
29452 \begin_inset Flex Code
29455 \begin_layout Plain Layout
29462 indicating that there is no inner tag:
29463 content is directly output without it.
29466 \begin_layout Description
29467 \begin_inset Flex Code
29470 \begin_layout Plain Layout
29471 DocBookInnerTagType
29477 \begin_inset Flex Code
29480 \begin_layout Plain Layout
29488 ] The new-line policy for this tag,
29490 \begin_inset space ~
29494 \begin_inset CommandInset ref
29496 reference "subsec:DocBook-New-line-policy"
29507 \begin_layout Description
29508 \begin_inset Flex Code
29511 \begin_layout Plain Layout
29518 \begin_inset Flex Code
29521 \begin_layout Plain Layout
29527 ] Specifies the tag that corresponds to this kind of section.
29528 This parameter only makes sense for sectioning elements (part,
29532 The default value is
29533 \begin_inset Flex Code
29536 \begin_layout Plain Layout
29543 and is only overridden when DocBook uses something else for sectioning (typically,
29544 parts and chapters of a book).
29547 \begin_layout Description
29548 \begin_inset Flex Code
29551 \begin_layout Plain Layout
29558 \begin_inset Flex Code
29561 \begin_layout Plain Layout
29567 ] The tag to be used for this inset,
29569 \begin_inset Quotes eld
29573 \begin_inset Flex Code
29576 \begin_layout Plain Layout
29583 \begin_inset Quotes erd
29586 in the example above.
29587 The default is the name of the float and always needs to be changed,
29588 as DocBook provides no generic inset tag.
29591 \begin_layout Description
29592 \begin_inset Flex Code
29595 \begin_layout Plain Layout
29602 \begin_inset Flex Code
29605 \begin_layout Plain Layout
29613 ] The new-line policy for this tag,
29615 \begin_inset space ~
29619 \begin_inset CommandInset ref
29621 reference "subsec:DocBook-New-line-policy"
29632 \begin_layout Description
29633 \begin_inset Flex Code
29636 \begin_layout Plain Layout
29643 \begin_inset Flex Code
29646 \begin_layout Plain Layout
29652 ] Specifies attribute information to be output with the outer wrapper tag,
29654 \begin_inset Quotes eld
29658 \begin_inset Flex Code
29661 \begin_layout Plain Layout
29668 \begin_inset Quotes erd
29671 in the example above.
29672 This information can be used in further processing of the DocBook files.
29675 \begin_layout Description
29676 \begin_inset Flex Code
29679 \begin_layout Plain Layout
29686 \begin_inset Flex Code
29689 \begin_layout Plain Layout
29695 ] The tag to be used for the wrapper tag around the inset,
29697 \begin_inset Quotes eld
29701 \begin_inset Flex Code
29704 \begin_layout Plain Layout
29711 \begin_inset Quotes erd
29714 in the example above.
29716 \begin_inset Flex Code
29719 \begin_layout Plain Layout
29726 indicating that there is no wrapper tag:
29727 tag and content are directly output without it.
29730 \begin_layout Description
29731 \begin_inset Flex Code
29734 \begin_layout Plain Layout
29735 DocBookWrapperTagType
29741 \begin_inset Flex Code
29744 \begin_layout Plain Layout
29752 ] The new-line policy for this tag,
29754 \begin_inset space ~
29758 \begin_inset CommandInset ref
29760 reference "subsec:DocBook-New-line-policy"
29771 \begin_layout Subsection
29775 \begin_layout Standard
29776 The DocBook output for floats too can be controlled by layout information.
29777 The output has the following form:
29780 \begin_layout LyX-Code
29784 \begin_layout LyX-Code
29785 Contents of the float as DocBook.
29788 \begin_layout LyX-Code
29792 \begin_layout Standard
29795 is a separate inset and will be output as a title.
29798 \begin_layout Description
29799 \begin_inset Flex Code
29802 \begin_layout Plain Layout
29809 \begin_inset Flex Code
29812 \begin_layout Plain Layout
29818 ] Specifies attribute information to be output with the main tag,
29820 \begin_inset Quotes eld
29824 \begin_inset Flex Code
29827 \begin_layout Plain Layout
29834 \begin_inset Quotes erd
29837 in the example above.
29838 This information can be used in further processing of the DocBook files.
29841 \begin_layout Description
29842 \begin_inset Flex Code
29845 \begin_layout Plain Layout
29852 \begin_inset Flex Code
29855 \begin_layout Plain Layout
29861 ] The tag to be used for this float,
29863 \begin_inset Quotes eld
29867 \begin_inset Flex Code
29870 \begin_layout Plain Layout
29877 \begin_inset Quotes erd
29880 in the example above.
29881 The default is the name of the float and always needs to be changed,
29882 as DocBook provides no generic float tag.
29885 \begin_layout Subsection
29886 Bibliography formatting
29889 \begin_layout Standard
29890 Included bibliographies cannot be formatted:
29891 all fields are always output in the database-like DocBook format (equivalent to a BibTeX file),
29893 \begin_inset Flex Code
29896 \begin_layout Plain Layout
29905 \begin_layout Standard
29906 When the bibliographic entries are manually inserted into the \SpecialChar LyX
29907 document as Bibliography Items,
29908 the user deals with formatting themself:
29909 there is no attempt of parsing what the user wrote,
29910 the string is directly used (with the
29911 \begin_inset Flex Code
29914 \begin_layout Plain Layout
29923 \begin_layout Chapter
29924 Including External Material
29925 \begin_inset CommandInset label
29927 name "chap:Including-External-Material"
29934 \begin_layout Standard
29935 \begin_inset Box Shadowbox
29945 height_special "totalheight"
29950 backgroundcolor "none"
29953 \begin_layout Plain Layout
29955 This portion of the documentation has not been updated for some time.
29956 We certainly hope that it is still accurate,
29957 but there are no guarantees.
29965 \begin_layout Standard
29966 The use of material from sources external to \SpecialChar LyX
29967 is covered in detail in the
29972 This part of the manual covers what needs to happen behind the scenes for new sorts of material to be included.
29975 \begin_layout Section
29979 \begin_layout Standard
29980 The external material feature is based on the concept of a
29985 A template is a specification of how \SpecialChar LyX
29986 should interface with a certain kind of material.
29989 comes with predefined templates for Xfig figures,
29990 various raster format images,
29992 and LilyPond music notation.
29993 You can check the actual list by using the menu
29994 \begin_inset Flex Noun
29997 \begin_layout Plain Layout
29998 Insert\SpecialChar menuseparator
29999 File\SpecialChar menuseparator
30007 it is possible to roll your own template to support a specific kind of material.
30008 Later we'll describe in more detail what is involved,
30009 and hopefully you will submit all the templates you create so we can include them in a later \SpecialChar LyX
30013 \begin_layout Standard
30014 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.
30016 consider the case of a figure produced with
30017 \begin_inset Flex Code
30020 \begin_layout Plain Layout
30027 The Xfig application itself works on an original file with the
30028 \begin_inset Flex Code
30031 \begin_layout Plain Layout
30039 you create and change your figure,
30040 and when you are done,
30042 \begin_inset Flex Code
30045 \begin_layout Plain Layout
30052 When you want to include the figure in your document,
30054 \begin_inset Flex Code
30057 \begin_layout Plain Layout
30063 in order to create a PostScript file that can readily be included in your \SpecialChar LaTeX
30067 \begin_inset Flex Code
30070 \begin_layout Plain Layout
30076 file is the original file,
30077 and the PostScript file is the produced file.
30080 \begin_layout Standard
30081 This distinction is important in order to allow updating of the material while you are in the process of writing the document.
30083 it provides us with the flexibility that is needed to support multiple export formats.
30085 in the case of a plain text file,
30086 it is not exactly an award-winning idea to include the figure as raw PostScript.
30088 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.
30089 The external material management allows you to do this,
30090 because it is parametrized on the different export formats that \SpecialChar LyX
30094 \begin_layout Standard
30095 Besides supporting the production of different products according to the exported format,
30096 it supports tight integration with editing and viewing applications.
30097 In the case of an Xfig figure,
30098 you are able to invoke Xfig on the original file with a single click from within the external material dialog in \SpecialChar LyX
30100 and also preview the produced PostScript file with Ghostview with another click.
30101 No more fiddling around with the command line and/or file browsers to locate and manipulate the original or produced files.
30103 you are finally able to take full advantage of the many different applications that are relevant to use when you write your documents,
30104 and ultimately be more productive.
30107 \begin_layout Section
30108 The external template configuration files
30111 \begin_layout Standard
30112 It is relatively easy to add custom external template definitions to \SpecialChar LyX
30115 be aware that doing this in an careless manner most probably
30119 introduce an easily exploitable security hole.
30120 So before you do this,
30121 please read the discussion about security in
30122 \begin_inset CommandInset ref
30124 reference "sec:Security-discussion"
30132 \begin_layout Standard
30134 we encourage you to submit any interesting templates that you create.
30138 \begin_layout Standard
30139 The external templates are defined in the
30140 \begin_inset Flex Code
30143 \begin_layout Plain Layout
30149 files that are stored in the
30150 \begin_inset Flex Code
30153 \begin_layout Plain Layout
30154 LyXDir/lib/xtemplates/
30160 Each template is defined in a file of its own.
30161 You can place your own templates in
30162 \begin_inset Flex Code
30165 \begin_layout Plain Layout
30166 UserDir/xtemplates/
30171 or copy existing templates to that directory in order to modify them.
30174 \begin_layout Standard
30175 A typical template looks like this:
30178 \begin_layout LyX-Code
30182 \begin_layout LyX-Code
30184 $$AbsOrRelPathParent$$Basename"
30187 \begin_layout LyX-Code
30191 \begin_layout LyX-Code
30195 \begin_layout LyX-Code
30199 \begin_layout LyX-Code
30203 \begin_layout LyX-Code
30207 \begin_layout LyX-Code
30208 AutomaticProduction true
30211 \begin_layout LyX-Code
30215 \begin_layout LyX-Code
30219 \begin_layout LyX-Code
30223 \begin_layout LyX-Code
30224 TransformCommand Rotate RotationLatexCommand
30227 \begin_layout LyX-Code
30228 TransformCommand Resize ResizeLatexCommand
30231 \begin_layout LyX-Code
30232 Product "$$RotateFront$$ResizeFront
30235 \begin_layout LyX-Code
30240 input{$$AbsOrRelPathMaster$$Basename.pstex_t}
30243 \begin_layout LyX-Code
30244 $$ResizeBack$$RotateBack"
30247 \begin_layout LyX-Code
30251 \begin_layout LyX-Code
30252 UpdateResult "$$AbsPath$$Basename.pstex_t"
30255 \begin_layout LyX-Code
30256 Requirement "graphicx"
30259 \begin_layout LyX-Code
30260 ReferencedFile latex "$$AbsOrRelPathMaster$$Basename.pstex_t"
30263 \begin_layout LyX-Code
30264 ReferencedFile latex "$$AbsPath$$Basename.eps"
30267 \begin_layout LyX-Code
30268 ReferencedFile dvi "$$AbsPath$$Basename.eps"
30271 \begin_layout LyX-Code
30275 \begin_layout LyX-Code
30279 \begin_layout LyX-Code
30280 TransformCommand Rotate RotationLatexCommand
30283 \begin_layout LyX-Code
30284 TransformCommand Resize ResizeLatexCommand
30287 \begin_layout LyX-Code
30288 Product "$$RotateFront$$ResizeFront
30291 \begin_layout LyX-Code
30296 input{$$AbsOrRelPathMaster$$Basename.pdftex_t}
30299 \begin_layout LyX-Code
30300 $$ResizeBack$$RotateBack"
30303 \begin_layout LyX-Code
30304 UpdateFormat pdftex
30307 \begin_layout LyX-Code
30308 UpdateResult "$$AbsPath$$Basename.pdftex_t"
30311 \begin_layout LyX-Code
30312 Requirement "graphicx"
30315 \begin_layout LyX-Code
30316 ReferencedFile latex "$$AbsOrRelPathMaster$$Basename.pdftex_t"
30319 \begin_layout LyX-Code
30320 ReferencedFile latex "$$AbsPath$$Basename.pdf"
30323 \begin_layout LyX-Code
30327 \begin_layout LyX-Code
30331 \begin_layout LyX-Code
30336 \begin_layout LyX-Code
30340 \begin_layout LyX-Code
30344 \begin_layout LyX-Code
30345 Product "<graphic fileref=
30347 "$$AbsOrRelPathMaster$$Basename.eps
30352 \begin_layout LyX-Code
30356 \begin_layout LyX-Code
30360 \begin_layout LyX-Code
30361 UpdateResult "$$AbsPath$$Basename.eps"
30364 \begin_layout LyX-Code
30365 ReferencedFile docbook "$$AbsPath$$Basename.eps"
30368 \begin_layout LyX-Code
30369 ReferencedFile docbook-xml "$$AbsPath$$Basename.eps"
30372 \begin_layout LyX-Code
30376 \begin_layout LyX-Code
30380 \begin_layout Standard
30382 the template is enclosed in
30383 \begin_inset Flex Code
30386 \begin_layout Plain Layout
30394 \begin_inset Flex Code
30397 \begin_layout Plain Layout
30404 It contains a header specifying some general settings and,
30405 for each supported primary document file format,
30407 \begin_inset Flex Code
30410 \begin_layout Plain Layout
30418 \begin_inset Flex Code
30421 \begin_layout Plain Layout
30430 \begin_layout Subsection
30431 The template header
30434 \begin_layout Description
30435 \begin_inset Flex Code
30438 \begin_layout Plain Layout
30439 AutomaticProduction
30440 \begin_inset space ~
30448 Whether the file represented by the template must be generated by \SpecialChar LyX
30450 This command must occur exactly once.
30453 \begin_layout Description
30454 \begin_inset Flex Code
30457 \begin_layout Plain Layout
30459 \begin_inset space ~
30467 A glob pattern that is used in the file dialog to filter out the desired files.
30468 If there is more than one possible file extension (e.
30469 \begin_inset space \thinspace{}
30473 \begin_inset space \space{}
30477 \begin_inset Flex Code
30480 \begin_layout Plain Layout
30487 \begin_inset Flex Code
30490 \begin_layout Plain Layout
30498 \begin_inset Flex Code
30501 \begin_layout Plain Layout
30508 This command must occur exactly once.
30511 \begin_layout Description
30512 \begin_inset Flex Code
30515 \begin_layout Plain Layout
30517 \begin_inset space ~
30525 The text that is displayed on the button.
30526 This command must occur exactly once.
30529 \begin_layout Description
30530 \begin_inset Flex Code
30533 \begin_layout Plain Layout
30535 \begin_inset space ~
30539 \begin_inset space ~
30547 The help text that is used in the External dialog.
30548 Provide enough information to explain to the user just what the template can provide him with.
30549 This command must occur exactly once.
30552 \begin_layout Description
30553 \begin_inset Flex Code
30556 \begin_layout Plain Layout
30558 \begin_inset space ~
30566 The file format of the original file.
30567 This must be the name of a format that is known to \SpecialChar LyX
30569 \begin_inset CommandInset ref
30571 reference "sec:Formats"
30578 \begin_inset Quotes eld
30582 \begin_inset Flex Code
30585 \begin_layout Plain Layout
30592 \begin_inset Quotes erd
30595 if the template can handle original files of more than one format.
30597 will attempt to interrogate the file itself in order to deduce its format in this case.
30598 This command must occur exactly once.
30601 \begin_layout Description
30602 \begin_inset Flex Code
30605 \begin_layout Plain Layout
30607 \begin_inset space ~
30615 A unique name for the template.
30616 It must not contain substitution macros (see below).
30619 \begin_layout Description
30620 \begin_inset Flex Code
30623 \begin_layout Plain Layout
30625 \begin_inset space ~
30628 Rotate|Resize|Clip|Extra
30633 This command specifies which transformations are supported by this template.
30634 It may occur zero or more times.
30635 This command enables the corresponding tabs in the external dialog.
30637 \begin_inset Flex Code
30640 \begin_layout Plain Layout
30646 command must have either a corresponding
30647 \begin_inset Flex Code
30650 \begin_layout Plain Layout
30657 \begin_inset Flex Code
30660 \begin_layout Plain Layout
30667 \begin_inset Flex Code
30670 \begin_layout Plain Layout
30677 Otherwise the transformation will not be supported by that format.
30680 \begin_layout Subsection
30684 \begin_layout Description
30685 \begin_inset Flex Code
30688 \begin_layout Plain Layout
30690 \begin_inset space ~
30693 LaTeX|PDFLaTeX|PlainText|DocBook|XHTML
30698 The primary document file format that this format definition is for.
30699 Not every template has a sensible representation in all document file formats.
30700 Please define nevertheless a
30701 \begin_inset Flex Code
30704 \begin_layout Plain Layout
30710 section for all templates.
30711 Use a dummy text when no representation is available.
30712 Then you can at least see a reference to the external material in the exported document.
30715 \begin_layout Description
30716 \begin_inset Flex Code
30719 \begin_layout Plain Layout
30721 \begin_inset space ~
30725 \begin_inset space ~
30733 This command defines an additional macro
30734 \begin_inset Flex Code
30737 \begin_layout Plain Layout
30743 for substitution in
30744 \begin_inset Flex Code
30747 \begin_layout Plain Layout
30755 \begin_inset Flex Code
30758 \begin_layout Plain Layout
30764 itself may contain substitution macros.
30765 The advantage over using
30766 \begin_inset Flex Code
30769 \begin_layout Plain Layout
30776 \begin_inset Flex Code
30779 \begin_layout Plain Layout
30785 is that the substituted value of
30786 \begin_inset Flex Code
30789 \begin_layout Plain Layout
30795 is sanitized so that it is a valid optional argument in the document format.
30796 This command may occur zero or more times.
30799 \begin_layout Description
30800 \begin_inset Flex Code
30803 \begin_layout Plain Layout
30805 \begin_inset space ~
30813 The text that is inserted in the exported document.
30814 This is actually the most important command and can be quite complex.
30815 This command must occur exactly once.
30818 \begin_layout Description
30819 \begin_inset Flex Code
30822 \begin_layout Plain Layout
30824 \begin_inset space ~
30832 This command specifies a preamble snippet that will be included in the \SpecialChar LaTeX
30834 It has to be defined using
30835 \begin_inset Flex Code
30838 \begin_layout Plain Layout
30846 \begin_inset Flex Code
30849 \begin_layout Plain Layout
30856 This command may occur zero or more times.
30859 \begin_layout Description
30860 \begin_inset Flex Code
30863 \begin_layout Plain Layout
30865 \begin_inset space ~
30869 \begin_inset space ~
30877 This command denotes files that are created by the conversion process and are needed for a particular export format.
30878 If the filename is relative,
30879 it is interpreted relative to the master document.
30880 This command may be given zero or more times.
30883 \begin_layout Description
30884 \begin_inset Flex Code
30887 \begin_layout Plain Layout
30889 \begin_inset space ~
30897 The name of a required \SpecialChar LaTeX
30899 The package is included via
30900 \begin_inset Flex Code
30903 \begin_layout Plain Layout
30911 in the \SpecialChar LaTeX
30913 This command may occur zero or more times.
30916 \begin_layout Description
30917 \begin_inset Flex Code
30920 \begin_layout Plain Layout
30922 \begin_inset space ~
30926 \begin_inset space ~
30929 RotationLatexCommand
30934 This command specifies that the built in \SpecialChar LaTeX
30935 command should be used for rotation.
30936 This command may occur once or not at all.
30939 \begin_layout Description
30940 \begin_inset Flex Code
30943 \begin_layout Plain Layout
30945 \begin_inset space ~
30949 \begin_inset space ~
30957 This command specifies that the built in \SpecialChar LaTeX
30958 command should be used for resizing.
30959 This command may occur once or not at all.
30962 \begin_layout Description
30963 \begin_inset Flex Code
30966 \begin_layout Plain Layout
30968 \begin_inset space ~
30972 \begin_inset space ~
30975 RotationLatexOption
30980 This command specifies that rotation is done via an optional argument.
30981 This command may occur once or not at all.
30984 \begin_layout Description
30985 \begin_inset Flex Code
30988 \begin_layout Plain Layout
30990 \begin_inset space ~
30994 \begin_inset space ~
31002 This command specifies that resizing is done via an optional argument.
31003 This command may occur once or not at all.
31006 \begin_layout Description
31007 \begin_inset Flex Code
31010 \begin_layout Plain Layout
31012 \begin_inset space ~
31016 \begin_inset space ~
31024 This command specifies that clipping is done via an optional argument.
31025 This command may occur once or not at all.
31028 \begin_layout Description
31029 \begin_inset Flex Code
31032 \begin_layout Plain Layout
31034 \begin_inset space ~
31038 \begin_inset space ~
31046 This command specifies that an extra optional argument is used.
31047 This command may occur once or not at all.
31050 \begin_layout Description
31051 \begin_inset Flex Code
31054 \begin_layout Plain Layout
31056 \begin_inset space ~
31064 The file format of the converted file.
31065 This must be the name of a format that is known to \SpecialChar LyX
31067 \begin_inset Flex Noun
31070 \begin_layout Plain Layout
31071 Tools\SpecialChar menuseparator
31072 Preferences\SpecialChar menuseparator
31073 File Handling\SpecialChar menuseparator
31080 This command must occur exactly once.
31081 If the resulting file format is PDF,
31082 you need to specify the format
31083 \begin_inset Flex Code
31086 \begin_layout Plain Layout
31093 This is the PDF format used for including graphics.
31094 The other defined PDF formats are for document export.
31097 \begin_layout Description
31098 \begin_inset Flex Code
31101 \begin_layout Plain Layout
31103 \begin_inset space ~
31111 The file name of the converted file.
31112 The file name must be absolute.
31113 This command must occur exactly once.
31116 \begin_layout Subsection
31117 Preamble definitions
31120 \begin_layout Standard
31121 The external template configuration file may contain additional preamble definitions enclosed by
31122 \begin_inset Flex Code
31125 \begin_layout Plain Layout
31133 \begin_inset Flex Code
31136 \begin_layout Plain Layout
31143 They can be used by the templates in the
31144 \begin_inset Flex Code
31147 \begin_layout Plain Layout
31156 \begin_layout Section
31157 The substitution mechanism
31160 \begin_layout Standard
31161 When the external material facility invokes an external program,
31162 it is done on the basis of a command defined in the template configuration file.
31163 These commands can contain various macros that are expanded before execution.
31164 Execution always take place in the directory of the containing document.
31167 \begin_layout Standard
31169 whenever external material is to be displayed,
31170 the name will be produced by the substitution mechanism,
31171 and most other commands in the template definition support substitution as well.
31174 \begin_layout Standard
31175 The available macros are the following:
31178 \begin_layout Description
31179 \begin_inset Flex Code
31182 \begin_layout Plain Layout
31183 $$AbsOrRelPathMaster
31189 absolute or relative to the master \SpecialChar LyX
31193 \begin_layout Description
31194 \begin_inset Flex Code
31197 \begin_layout Plain Layout
31198 $$AbsOrRelPathParent
31204 absolute or relative to the \SpecialChar LyX
31208 \begin_layout Description
31209 \begin_inset Flex Code
31212 \begin_layout Plain Layout
31218 The absolute file path
31219 \change_inserted -712698321 1712390130
31221 If compiling with \SpecialChar LyX
31223 this is the path to the file in the temporary directory
31228 \begin_layout Description
31229 \begin_inset Flex Code
31232 \begin_layout Plain Layout
31238 The filename without path and without the extension.
31241 \begin_layout Description
31242 \begin_inset Flex Code
31245 \begin_layout Plain Layout
31247 \begin_inset Quotes eld
31251 \begin_inset Quotes erd
31259 This macro will expand to the contents of the file with the name
31260 \begin_inset Flex Code
31263 \begin_layout Plain Layout
31272 \begin_layout Description
31273 \begin_inset Flex Code
31276 \begin_layout Plain Layout
31282 The file extension (including the dot).
31285 \begin_layout Description
31286 \begin_inset Flex Code
31289 \begin_layout Plain Layout
31295 This will be the string
31296 \begin_inset Quotes eld
31300 \begin_inset Quotes erd
31303 if the file is in JPEG format,
31304 otherwise it will be the string
31305 \begin_inset Quotes eld
31309 \begin_inset Quotes erd
31313 This is useful to avoid uneeded conversions for output formats that support both PNG and JPEG fomats.
31314 The predefined RasterImage template uses this macro for the pdf\SpecialChar TeX
31318 \begin_layout Description
31319 \begin_inset Flex Code
31322 \begin_layout Plain Layout
31328 The filename of the file specified in the external material dialog.
31329 This is either an absolute name,
31330 or it is relative to the \SpecialChar LyX
31334 \begin_layout Description
31335 \begin_inset Flex Code
31338 \begin_layout Plain Layout
31345 \begin_inset Flex Code
31348 \begin_layout Plain Layout
31354 (absolute name or relative to the \SpecialChar LyX
31356 \change_inserted -712698321 1712389740
31360 \begin_layout Description
31362 \change_inserted -712698321 1712390181
31363 \begin_inset Flex Code
31366 \begin_layout Plain Layout
31368 \change_inserted -712698321 1712389749
31374 The file name with absolute path to the original directory (not the temporary directory).
31379 \begin_layout Description
31380 \begin_inset Flex Code
31383 \begin_layout Plain Layout
31390 relative to the master \SpecialChar LyX
31394 \begin_layout Description
31395 \begin_inset Flex Code
31398 \begin_layout Plain Layout
31405 relative to the \SpecialChar LyX
31409 \begin_layout Description
31410 \begin_inset Flex Code
31413 \begin_layout Plain Layout
31419 This macro will expand to the absolute path of the system directory.
31420 This is typically used to point to the various helper scripts that are bundled with \SpecialChar LyX
31424 \begin_layout Description
31425 \begin_inset Flex Code
31428 \begin_layout Plain Layout
31434 A name and full path to a temporary file which will be automatically deleted whenever the containing document is closed,
31435 or the external material insertion deleted.
31438 \begin_layout Standard
31439 All path macros contain a trailing directory separator,
31440 so you can construct e.
31441 \begin_inset space \thinspace{}
31445 \begin_inset space \space{}
31448 the absolute filename with
31449 \begin_inset Flex Code
31452 \begin_layout Plain Layout
31453 $$AbsPath$$Basename$$Extension
31461 \begin_layout Standard
31462 The macros above are substituted in all commands unless otherwise noted.
31464 \begin_inset Flex Code
31467 \begin_layout Plain Layout
31473 supports additionally the following substitutions if they are enabled by the
31474 \begin_inset Flex Code
31477 \begin_layout Plain Layout
31484 \begin_inset Flex Code
31487 \begin_layout Plain Layout
31496 \begin_layout Description
31497 \begin_inset Flex Code
31500 \begin_layout Plain Layout
31506 The front part of the resize command.
31509 \begin_layout Description
31510 \begin_inset Flex Code
31513 \begin_layout Plain Layout
31519 The back part of the resize command.
31522 \begin_layout Description
31523 \begin_inset Flex Code
31526 \begin_layout Plain Layout
31532 The front part of the rotation command.
31535 \begin_layout Description
31536 \begin_inset Flex Code
31539 \begin_layout Plain Layout
31545 The back part of the rotation command.
31548 \begin_layout Standard
31549 The value string of the
31550 \begin_inset Flex Code
31553 \begin_layout Plain Layout
31559 command supports additionally the following substitutions if they are enabled by the
31560 \begin_inset Flex Code
31563 \begin_layout Plain Layout
31570 \begin_inset Flex Code
31573 \begin_layout Plain Layout
31582 \begin_layout Description
31583 \begin_inset Flex Code
31586 \begin_layout Plain Layout
31595 \begin_layout Description
31596 \begin_inset Flex Code
31599 \begin_layout Plain Layout
31608 \begin_layout Description
31609 \begin_inset Flex Code
31612 \begin_layout Plain Layout
31621 \begin_layout Description
31622 \begin_inset Flex Code
31625 \begin_layout Plain Layout
31631 The rotation option.
31634 \begin_layout Standard
31635 You may ask why there are so many path macros.
31636 There are mainly two reasons:
31639 \begin_layout Enumerate
31640 Relative and absolute file names should remain relative or absolute,
31642 Users may have reasons to prefer either form.
31643 Relative names are useful for portable documents that should work on different machines,
31645 Absolute names may be required by some programs.
31648 \begin_layout Enumerate
31650 treats relative file names differently than \SpecialChar LyX
31651 and other programs in nested included files.
31652 For \SpecialChar LyX
31654 a relative file name is always relative to the document that contains the file name.
31655 For \SpecialChar LaTeX
31657 it is always relative to the master document.
31658 These two definitions are identical if you have only one document,
31659 but differ if you have a master document that includes part documents.
31660 That means that relative filenames must be transformed when presented to \SpecialChar LaTeX
31662 Fortunately \SpecialChar LyX
31663 does this automatically for you if you choose the right macros.
31666 \begin_layout Standard
31667 So which path macro should be used in new template definitions?
31668 The rule is not difficult:
31671 \begin_layout Itemize
31673 \begin_inset Flex Code
31676 \begin_layout Plain Layout
31682 if an absolute path is required.
31685 \begin_layout Itemize
31687 \begin_inset Flex Code
31690 \begin_layout Plain Layout
31691 $$AbsOrRelPathMaster
31696 if the substituted string is some kind of \SpecialChar LaTeX
31700 \begin_layout Itemize
31702 \begin_inset Flex Code
31705 \begin_layout Plain Layout
31706 $$AbsOrRelPathParent
31711 in order to preserve the user's choice.
31714 \begin_layout Standard
31715 There are special cases where this rule does not work and e.
31716 \begin_inset space \thinspace{}
31720 \begin_inset space \space{}
31723 relative names are needed,
31724 but normally it will work just fine.
31725 One example for such a case is the command
31726 \begin_inset Flex Code
31729 \begin_layout Plain Layout
31730 ReferencedFile latex "$$AbsOrRelPathMaster$$Basename.pstex_t"
31735 in the XFig template above:
31736 We can't use the absolute name because the copier for
31737 \begin_inset Flex Code
31740 \begin_layout Plain Layout
31746 files needs the relative name in order to rewrite the file content.
31749 \begin_layout Section
31750 Security discussion
31751 \begin_inset CommandInset label
31753 name "sec:Security-discussion"
31760 \begin_layout Standard
31761 The external material feature interfaces with a lot of external programs and does so automatically,
31762 so we have to consider the security implications of this.
31764 since you have the option of including your own filenames and/or parameter strings and those are expanded into a command,
31765 it seems that it would be possible to create a malicious document which executes arbitrary commands when a user views or prints the document.
31766 This is something we definitely want to avoid.
31769 \begin_layout Standard
31771 since the external program commands are specified in the template configuration file only,
31772 there are no security issues if \SpecialChar LyX
31773 is properly configured with safe templates only.
31774 This is so because the external programs are invoked with the
31775 \begin_inset Flex Code
31778 \begin_layout Plain Layout
31784 -system call rather than the
31785 \begin_inset Flex Code
31788 \begin_layout Plain Layout
31795 so it's not possible to execute arbitrary commands from the filename or parameter section via the shell.
31798 \begin_layout Standard
31799 This also implies that you are restricted in what command strings you can use in the external material templates.
31801 pipes and redirection are not readily available.
31802 This has to be so if \SpecialChar LyX
31803 should remain safe.
31804 If you want to use some of the shell features,
31805 you should write a safe script to do this in a controlled manner,
31806 and then invoke the script from the command string.
31810 \begin_layout Standard
31811 It is possible to design a template that interacts directly with the shell,
31812 but since this would allow a malicious user to execute arbitrary commands by writing clever filenames and/or parameters,
31813 we generally recommend that you only use safe scripts that work with the
31814 \begin_inset Flex Code
31817 \begin_layout Plain Layout
31823 system call in a controlled manner.
31825 for use in a controlled environment,
31826 it can be tempting to just fall back to use ordinary shell scripts.
31832 provide an easily exploitable security hole in your system.
31833 Of course it stands to reason that such unsafe templates will never be included in the standard \SpecialChar LyX
31835 although we do encourage people to submit new templates in the open source tradition.
31836 But \SpecialChar LyX
31837 as shipped from the official distribution channels will never have unsafe templates.
31840 \begin_layout Standard
31841 Including external material provides a lot of power,
31842 and you have to be careful not to introduce security hazards with this power.
31843 A subtle error in a single line in an innocent looking script can open the door to huge security problems.
31844 So if you do not fully understand the issues,
31845 we recommend that you consult a knowledgeable security professional or the \SpecialChar LyX
31846 development team if you have any questions about whether a given template is safe or not.
31847 And do this before you use it in an uncontrolled environment.
31850 \begin_layout Chapter
31852 List of supported \SpecialChar LyX
31853 functions to be used in layouts
31854 \begin_inset CommandInset label
31856 name "chap:List-of-functions"
31863 \begin_layout Standard
31865 \begin_inset Tabular
31866 <lyxtabular version="3" rows="11" columns="8">
31867 <features tabularvalignment="middle">
31868 <column alignment="left" valignment="top">
31869 <column alignment="left" valignment="top">
31870 <column alignment="left" valignment="top">
31871 <column alignment="left" valignment="top">
31872 <column alignment="left" valignment="top">
31873 <column alignment="left" valignment="top">
31874 <column alignment="left" valignment="top">
31875 <column alignment="left" valignment="top">
31877 <cell alignment="left" valignment="top" usebox="none">
31880 \begin_layout Plain Layout
31886 <cell alignment="left" valignment="top" usebox="none">
31889 \begin_layout Plain Layout
31895 <cell alignment="left" valignment="top" usebox="none">
31898 \begin_layout Plain Layout
31904 <cell alignment="left" valignment="top" usebox="none">
31907 \begin_layout Plain Layout
31913 <cell alignment="center" valignment="top" usebox="none">
31916 \begin_layout Plain Layout
31922 <cell alignment="center" valignment="top" usebox="none">
31925 \begin_layout Plain Layout
31931 <cell alignment="center" valignment="top" usebox="none">
31934 \begin_layout Plain Layout
31940 <cell alignment="center" valignment="top" usebox="none">
31943 \begin_layout Plain Layout
31951 <cell alignment="left" valignment="top" usebox="none">
31954 \begin_layout Plain Layout
31960 <cell alignment="left" valignment="top" usebox="none">
31963 \begin_layout Plain Layout
31969 <cell alignment="left" valignment="top" usebox="none">
31972 \begin_layout Plain Layout
31978 <cell alignment="left" valignment="top" usebox="none">
31981 \begin_layout Plain Layout
31987 <cell alignment="center" valignment="top" usebox="none">
31990 \begin_layout Plain Layout
31996 <cell alignment="center" valignment="top" usebox="none">
31999 \begin_layout Plain Layout
32005 <cell alignment="center" valignment="top" usebox="none">
32008 \begin_layout Plain Layout
32014 <cell alignment="center" valignment="top" usebox="none">
32017 \begin_layout Plain Layout
32025 <cell alignment="left" valignment="top" usebox="none">
32028 \begin_layout Plain Layout
32034 <cell alignment="left" valignment="top" usebox="none">
32037 \begin_layout Plain Layout
32043 <cell alignment="left" valignment="top" usebox="none">
32046 \begin_layout Plain Layout
32052 <cell alignment="left" valignment="top" usebox="none">
32055 \begin_layout Plain Layout
32061 <cell alignment="center" valignment="top" usebox="none">
32064 \begin_layout Plain Layout
32070 <cell alignment="center" valignment="top" usebox="none">
32073 \begin_layout Plain Layout
32079 <cell alignment="center" valignment="top" usebox="none">
32082 \begin_layout Plain Layout
32088 <cell alignment="center" valignment="top" usebox="none">
32091 \begin_layout Plain Layout
32099 <cell alignment="left" valignment="top" usebox="none">
32102 \begin_layout Plain Layout
32108 <cell alignment="left" valignment="top" usebox="none">
32111 \begin_layout Plain Layout
32117 <cell alignment="left" valignment="top" usebox="none">
32120 \begin_layout Plain Layout
32126 <cell alignment="left" valignment="top" usebox="none">
32129 \begin_layout Plain Layout
32135 <cell alignment="center" valignment="top" usebox="none">
32138 \begin_layout Plain Layout
32144 <cell alignment="center" valignment="top" usebox="none">
32147 \begin_layout Plain Layout
32153 <cell alignment="center" valignment="top" usebox="none">
32156 \begin_layout Plain Layout
32162 <cell alignment="center" valignment="top" usebox="none">
32165 \begin_layout Plain Layout
32173 <cell alignment="left" valignment="top" usebox="none">
32176 \begin_layout Plain Layout
32182 <cell alignment="left" valignment="top" usebox="none">
32185 \begin_layout Plain Layout
32191 <cell alignment="left" valignment="top" usebox="none">
32194 \begin_layout Plain Layout
32200 <cell alignment="left" valignment="top" usebox="none">
32203 \begin_layout Plain Layout
32209 <cell alignment="center" valignment="top" usebox="none">
32212 \begin_layout Plain Layout
32218 <cell alignment="center" valignment="top" usebox="none">
32221 \begin_layout Plain Layout
32227 <cell alignment="center" valignment="top" usebox="none">
32230 \begin_layout Plain Layout
32236 <cell alignment="center" valignment="top" usebox="none">
32239 \begin_layout Plain Layout
32247 <cell alignment="left" valignment="top" usebox="none">
32250 \begin_layout Plain Layout
32256 <cell alignment="left" valignment="top" usebox="none">
32259 \begin_layout Plain Layout
32265 <cell alignment="left" valignment="top" usebox="none">
32268 \begin_layout Plain Layout
32274 <cell alignment="left" valignment="top" usebox="none">
32277 \begin_layout Plain Layout
32283 <cell alignment="center" valignment="top" usebox="none">
32286 \begin_layout Plain Layout
32292 <cell alignment="center" valignment="top" usebox="none">
32295 \begin_layout Plain Layout
32301 <cell alignment="center" valignment="top" usebox="none">
32304 \begin_layout Plain Layout
32310 <cell alignment="center" valignment="top" usebox="none">
32313 \begin_layout Plain Layout
32321 <cell alignment="left" valignment="top" usebox="none">
32324 \begin_layout Plain Layout
32330 <cell alignment="left" valignment="top" usebox="none">
32333 \begin_layout Plain Layout
32339 <cell alignment="left" valignment="top" usebox="none">
32342 \begin_layout Plain Layout
32348 <cell alignment="left" valignment="top" usebox="none">
32351 \begin_layout Plain Layout
32357 <cell alignment="center" valignment="top" usebox="none">
32360 \begin_layout Plain Layout
32366 <cell alignment="center" valignment="top" usebox="none">
32369 \begin_layout Plain Layout
32375 <cell alignment="center" valignment="top" usebox="none">
32378 \begin_layout Plain Layout
32384 <cell alignment="center" valignment="top" usebox="none">
32387 \begin_layout Plain Layout
32395 <cell alignment="left" valignment="top" usebox="none">
32398 \begin_layout Plain Layout
32404 <cell alignment="left" valignment="top" usebox="none">
32407 \begin_layout Plain Layout
32413 <cell alignment="left" valignment="top" usebox="none">
32416 \begin_layout Plain Layout
32422 <cell alignment="left" valignment="top" usebox="none">
32425 \begin_layout Plain Layout
32431 <cell alignment="center" valignment="top" usebox="none">
32434 \begin_layout Plain Layout
32440 <cell alignment="center" valignment="top" usebox="none">
32443 \begin_layout Plain Layout
32449 <cell alignment="center" valignment="top" usebox="none">
32452 \begin_layout Plain Layout
32458 <cell alignment="center" valignment="top" usebox="none">
32461 \begin_layout Plain Layout
32469 <cell alignment="left" valignment="top" usebox="none">
32472 \begin_layout Plain Layout
32478 <cell alignment="left" valignment="top" usebox="none">
32481 \begin_layout Plain Layout
32487 <cell alignment="left" valignment="top" usebox="none">
32490 \begin_layout Plain Layout
32496 <cell alignment="left" valignment="top" usebox="none">
32499 \begin_layout Plain Layout
32505 <cell alignment="center" valignment="top" usebox="none">
32508 \begin_layout Plain Layout
32514 <cell alignment="center" valignment="top" usebox="none">
32517 \begin_layout Plain Layout
32523 <cell alignment="center" valignment="top" usebox="none">
32526 \begin_layout Plain Layout
32532 <cell alignment="center" valignment="top" usebox="none">
32535 \begin_layout Plain Layout
32543 <cell alignment="left" valignment="top" usebox="none">
32546 \begin_layout Plain Layout
32552 <cell alignment="left" valignment="top" usebox="none">
32555 \begin_layout Plain Layout
32561 <cell alignment="left" valignment="top" usebox="none">
32564 \begin_layout Plain Layout
32570 <cell alignment="left" valignment="top" usebox="none">
32573 \begin_layout Plain Layout
32579 <cell alignment="center" valignment="top" usebox="none">
32582 \begin_layout Plain Layout
32588 <cell alignment="center" valignment="top" usebox="none">
32591 \begin_layout Plain Layout
32597 <cell alignment="center" valignment="top" usebox="none">
32600 \begin_layout Plain Layout
32606 <cell alignment="center" valignment="top" usebox="none">
32609 \begin_layout Plain Layout
32617 <cell alignment="center" valignment="top" usebox="none">
32620 \begin_layout Plain Layout
32626 <cell alignment="center" valignment="top" usebox="none">
32629 \begin_layout Plain Layout
32635 <cell alignment="center" valignment="top" usebox="none">
32638 \begin_layout Plain Layout
32644 <cell alignment="center" valignment="top" usebox="none">
32647 \begin_layout Plain Layout
32653 <cell alignment="center" valignment="top" usebox="none">
32656 \begin_layout Plain Layout
32662 <cell alignment="center" valignment="top" usebox="none">
32665 \begin_layout Plain Layout
32671 <cell alignment="center" valignment="top" usebox="none">
32674 \begin_layout Plain Layout
32680 <cell alignment="center" valignment="top" usebox="none">
32683 \begin_layout Plain Layout
32697 \begin_layout Chapter
32698 Names of available colors to be used in layouts
32699 \begin_inset CommandInset label
32701 name "chap:Names-of-colors"
32708 \begin_layout Standard
32709 The colors listed below are the standard colors and those that you can adjust in the \SpecialChar LyX
32713 \begin_layout Section
32717 \begin_layout Standard
32718 The following are no real colors,
32719 but rather act on color definitions:
32722 \begin_layout Description
32723 ignore The color is ignored
32726 \begin_layout Description
32727 inherit The color is inherited
32730 \begin_layout Description
32743 No particular color – clear or default
32746 \begin_layout Section
32750 \begin_layout Standard
32751 These are fixed colors that cannot be customized.
32756 use these colors in layout definitions,
32757 since they will not work well with some color themes (such as dark themes):
32760 \begin_layout Description
32764 \begin_layout Description
32768 \begin_layout Description
32772 \begin_layout Description
32776 \begin_layout Description
32780 \begin_layout Description
32784 \begin_layout Description
32788 \begin_layout Description
32792 \begin_layout Description
32796 \begin_layout Description
32800 \begin_layout Description
32804 \begin_layout Description
32808 \begin_layout Description
32812 \begin_layout Description
32816 \begin_layout Description
32820 \begin_layout Description
32824 \begin_layout Description
32828 \begin_layout Description
32832 \begin_layout Description
32836 \begin_layout Section
32840 \begin_layout Standard
32841 These are the colors allocated to specific elements in
32844 arg "dialog-show prefs"
32850 \begin_layout Description
32851 added_space Added space color
32854 \begin_layout Description
32855 addedtext Added text color
32858 \begin_layout Description
32859 appendix Appendix marker color
32862 \begin_layout Description
32863 background Background color
32866 \begin_layout Description
32867 bookmark Bookmark indicator color
32870 \begin_layout Description
32871 bottomarea Bottom area color
32874 \begin_layout Description
32875 branchlabel Label color for branches
32878 \begin_layout Description
32879 buttonbg Color used for button background
32882 \begin_layout Description
32883 buttonframe Color for inset button frames
32886 \begin_layout Description
32887 buttonhoverbg Color used for button background under focus
32890 \begin_layout Description
32891 buttonhoverbg_broken Color used for broken inset button under focus
32894 \begin_layout Description
32895 changebar Changebar color
32898 \begin_layout Description
32899 changedtextauthor1 Changed text color author 1
32902 \begin_layout Description
32903 changedtextauthor2 Changed text color author 2
32906 \begin_layout Description
32907 changedtextauthor3 Changed text color author 3
32910 \begin_layout Description
32911 changedtextauthor4 Changed text color author 4
32914 \begin_layout Description
32915 changedtextauthor5 Changed text color author 5
32918 \begin_layout Description
32919 changedtextcomparison Changed text color document comparison (workarea)
32922 \begin_layout Description
32923 collapsible Collapsible insets text color
32926 \begin_layout Description
32927 collapsibleframe Collapsible insets framecolor
32930 \begin_layout Description
32931 command Text color for command insets
32934 \begin_layout Description
32935 commandbg Background color for command insets
32938 \begin_layout Description
32939 commandframe Frame color for command insets
32942 \begin_layout Description
32943 command_broken Text color for broken (reference) insets
32946 \begin_layout Description
32947 commandbg_broken Background color for broken insets
32950 \begin_layout Description
32951 commandframe_broken Frame color for broken insets
32954 \begin_layout Description
32955 comment Label color for comments
32958 \begin_layout Description
32959 commentbg Background color of comments
32962 \begin_layout Description
32963 cursor Cursor color
32966 \begin_layout Description
32967 deletedtext Deleted text color
32970 \begin_layout Description
32971 deletedtextmodifier Deleted text modifying color (for adjusting the brightness)
32974 \begin_layout Description
32975 depthbar Color for the depth bars in the margin
32978 \begin_layout Description
32979 eolmarker End of line marker color
32982 \begin_layout Description
32983 error Color of the \SpecialChar LaTeX
32987 \begin_layout Description
32988 footlabel Label color for footnotes
32991 \begin_layout Description
32992 foreground Foreground color
32995 \begin_layout Description
32996 graphicsbg Graphics inset background color
32999 \begin_layout Description
33000 greyedoutbg Background color of greyedout inset
33003 \begin_layout Description
33004 greyedoutlabel Label color for greyedout insets
33007 \begin_layout Description
33008 greyedouttext Color for greyedout inset text
33011 \begin_layout Description
33012 indexlabel Label color for index insets
33015 \begin_layout Description
33016 inlinecompletion Inline completion color
33019 \begin_layout Description
33020 insetbg Inset marker background color
33023 \begin_layout Description
33024 insetframe Inset marker frame color
33027 \begin_layout Description
33028 language Color for marking foreign language words
33031 \begin_layout Description
33032 latex Text color in \SpecialChar LaTeX
33036 \begin_layout Description
33037 listingsbg Background color of listings inset
33040 \begin_layout Description
33041 marginlabel Label color for margin notes
33044 \begin_layout Description
33045 math Math inset text color
33048 \begin_layout Description
33049 mathbg Math inset background color
33052 \begin_layout Description
33053 mathcorners Math inset frame color not under focus
33056 \begin_layout Description
33057 mathframe Math inset frame color under focus
33060 \begin_layout Description
33061 mathline Math line color
33064 \begin_layout Description
33065 mathmacrobg Macro math inset background color
33068 \begin_layout Description
33069 mathmacroblend Macro math blended color
33072 \begin_layout Description
33073 mathmacroframe Macro math frame color
33076 \begin_layout Description
33077 mathmacrohoverbg Macro math inset background color hovered
33080 \begin_layout Description
33081 mathmacrolabel Macro math label color
33084 \begin_layout Description
33085 mathmacronewarg Macro template color for new parameters
33088 \begin_layout Description
33089 mathmacrooldarg Macro template color for old parameters
33092 \begin_layout Description
33093 newpage New page color
33096 \begin_layout Description
33097 nonunique_inlinecompletion Inline completion color for the non-unique part
33100 \begin_layout Description
33101 note Label color for notes
33104 \begin_layout Description
33105 notebg Background color of notes
33108 \begin_layout Description
33109 pagebreak Page break/line break color
33112 \begin_layout Description
33113 paragraphmarker Color used for the pilcrow sign to mark the end of a paragraph
33116 \begin_layout Description
33117 phantomtext Text color for phantom insets
33120 \begin_layout Description
33121 preview The color used for previews
33124 \begin_layout Description
33125 previewframe Preview frame color
33128 \begin_layout Description
33129 regexpframe Color for regexp frame
33132 \begin_layout Description
33133 scroll Color that indicates when a row can be scrolled
33136 \begin_layout Description
33137 selection Background color of selected text
33140 \begin_layout Description
33141 selectionmath Foreground color of selected text in math insets
33144 \begin_layout Description
33145 selectiontext Foreground color of selected text
33148 \begin_layout Description
33149 shadedbg Background color of shaded box
33152 \begin_layout Description
33153 special Special chars text color
33156 \begin_layout Description
33157 tabularline Table line color
33160 \begin_layout Description
33161 tabularonoffline Table line color
33164 \begin_layout Description
33165 textlabel1 Color 1 of layout and custom inset labels
33168 \begin_layout Description
33169 textlabel2 Color 2 of layout and custom inset labels
33172 \begin_layout Description
33173 textlabel3 Color 3 of layout and custom inset labels
33176 \begin_layout Description
33177 urllabel Label color for URL insets
33180 \begin_layout Description
33181 urltext Color for URL inset text