1 #LyX 2.3 created this file. For more info see http://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 false
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
57 \font_sf_scale 100 100
58 \font_tt_scale 100 100
60 \use_dash_ligatures true
62 \default_output_format pdf2
64 \bibtex_command default
65 \index_command default
69 \pdf_title "LyX Configuration Manual"
70 \pdf_author "LyX Team"
71 \pdf_subject "LyX-documentation Customization"
72 \pdf_keywords "LyX, documentation, customization"
74 \pdf_bookmarksnumbered true
75 \pdf_bookmarksopen true
76 \pdf_bookmarksopenlevel 1
81 \pdf_pdfusetitle false
82 \pdf_quoted_options "linkcolor=black, citecolor=black, urlcolor=blue, filecolor=blue,pdfpagelayout=OneColumn, pdfnewwindow=true, pdfstartview=XYZ, plainpages=false"
85 \use_package amsmath 0
86 \use_package amssymb 0
89 \use_package mathdots 1
90 \use_package mathtools 0
92 \use_package stackrel 0
93 \use_package stmaryrd 0
94 \use_package undertilde 0
96 \cite_engine_type default
100 \paperorientation portrait
104 \notefontcolor #0000ff
116 \paragraph_separation indent
117 \paragraph_indentation default
119 \quotes_style english
123 \paperpagestyle headings
124 \tracking_changes true
125 \output_changes false
129 \author -712698321 "Jürgen Spitzmüller"
130 \author 2047637253 "Guillaume Munch"
131 \author 2089657418 "Usti"
137 Customizing \SpecialChar LyX
138 : Features for the Advanced User
142 by the \SpecialChar LyX
147 \begin_layout Plain Layout
149 If you have comments or error corrections, please send them to the \SpecialChar LyX
152 \begin_inset CommandInset href
154 target "lyx-docs@lists.lyx.org"
162 \begin_inset Quotes eld
166 \begin_inset Quotes erd
169 in the subject header, and please cc the current maintainer of this file,
170 Richard Heck <rgheck@comcast.net>.
176 \begin_inset Newline newline
180 \begin_inset Newline newline
186 \begin_layout Standard
187 \begin_inset CommandInset toc
188 LatexCommand tableofcontents
195 \begin_layout Standard
196 \begin_inset Note Note
199 \begin_layout Plain Layout
200 Please use change tracking when modifying this document.
201 This makes it easier for our translators to recognize things that have
202 been changed, and it helps the maintainer keep up-to-date with what's been
211 \begin_layout Chapter
215 \begin_layout Standard
216 This manual covers the customization features present in \SpecialChar LyX
218 In it, we discuss issues like keyboard shortcuts, screen previewing options,
219 printer options, sending commands to \SpecialChar LyX
220 via the \SpecialChar LyX
221 Server, internationalization,
222 installing new \SpecialChar LaTeX
223 classes and \SpecialChar LyX
225 We can't possibly hope to touch on everything you can change—our developers
226 add new features faster than we can document them—but we will explain the
227 most common customizations and hopefully point you in the right direction
228 for some of the more obscure ones.
231 \begin_layout Standard
232 \begin_inset Branch OutDated
236 \begin_layout Standard
237 Information from previous versions of this document that now seems to be
238 outdated is contained in the OutDated branch of this document.
239 By default, this information will not appear in the \SpecialChar LaTeX
248 \begin_layout Chapter
253 \begin_layout Standard
254 This chapter aims to help you to find your way through the \SpecialChar LyX
257 Before continuing to read this chapter, you should find out where your
259 library and user directories are by using
260 \begin_inset Flex Noun
263 \begin_layout Plain Layout
264 Help\SpecialChar menuseparator
275 The library directory is the place where \SpecialChar LyX
276 places its system-wide configuration
277 files; the user directory is where you can place your modified versions.
278 We will call the former
279 \begin_inset Flex Code
282 \begin_layout Plain Layout
289 \begin_inset Flex Noun
292 \begin_layout Plain Layout
298 in the remainder of this document.
302 \begin_layout Section
304 \begin_inset Flex Code
307 \begin_layout Plain Layout
316 \begin_layout Standard
317 \begin_inset Flex Code
320 \begin_layout Plain Layout
326 and its sub-directories contain a number of files and that can be used
327 to customize \SpecialChar LyX
329 You can change many of these files from within \SpecialChar LyX
331 \begin_inset Flex Noun
334 \begin_layout Plain Layout
335 Tools\SpecialChar menuseparator
342 Most customization that you will want to do in \SpecialChar LyX
343 is possible through this
345 However, many other inner aspects of \SpecialChar LyX
346 can be customized by modifying the
348 \begin_inset Flex Code
351 \begin_layout Plain Layout
358 These files fall in different categories, described in the following subsection
362 \begin_layout Subsection
363 Automatically generated files
366 \begin_layout Standard
367 The files, which are to be found in
368 \begin_inset Flex Noun
371 \begin_layout Plain Layout
377 , are generated when you configure \SpecialChar LyX
379 They contain various default values that are guessed by inspection.
380 In general, it is not a good idea to modify them, since they might be overwritt
384 \begin_layout Labeling
385 \labelwidthstring 00.00.0000
386 \begin_inset Flex Code
389 \begin_layout Plain Layout
395 contains defaults for various commands.
398 \begin_layout Labeling
399 \labelwidthstring 00.00.0000
400 \begin_inset Flex Code
403 \begin_layout Plain Layout
409 contains the list of packages that have been recognized by \SpecialChar LyX
411 It is currently unused by the \SpecialChar LyX
412 program itself, but the information extracted,
413 and more, is made available with
414 \begin_inset Flex Noun
417 \begin_layout Plain Layout
418 Help\SpecialChar menuseparator
432 \begin_layout Labeling
433 \labelwidthstring 00.00.0000
434 \begin_inset Flex Code
437 \begin_layout Plain Layout
443 the list of text classes that have been found in your
444 \begin_inset Flex Code
447 \begin_layout Plain Layout
453 directories, along with the associated \SpecialChar LaTeX
454 document class and their description.
457 \begin_layout Labeling
458 \labelwidthstring 00.00.0000
459 \begin_inset Flex Code
462 \begin_layout Plain Layout
468 the list of layout modules found in your
469 \begin_inset Flex Code
472 \begin_layout Plain Layout
481 \begin_layout Labeling
482 \labelwidthstring 00.00.0000
483 \begin_inset Flex Code
486 \begin_layout Plain Layout
492 lists of various sorts of \SpecialChar LaTeX
493 -related files found on your system
496 \begin_layout Labeling
497 \labelwidthstring 00.00.0000
498 \begin_inset Flex Code
501 \begin_layout Plain Layout
502 doc/\SpecialChar LaTeX
508 is automatically generated during configuration from the file
509 \begin_inset Flex Code
512 \begin_layout Plain Layout
520 It contains information on your \SpecialChar LaTeX
524 \begin_layout Subsection
528 \begin_layout Standard
529 These directories are duplicated between
530 \begin_inset Flex Code
533 \begin_layout Plain Layout
540 \begin_inset Flex Code
543 \begin_layout Plain Layout
550 If a particular files exists in both places, the one in
551 \begin_inset Flex Code
554 \begin_layout Plain Layout
563 \begin_layout Labeling
564 \labelwidthstring 00.00.0000
565 \begin_inset Flex Code
568 \begin_layout Plain Layout
574 this directory contains files with the extension
575 \begin_inset Flex Code
578 \begin_layout Plain Layout
584 that define the keybindings used in \SpecialChar LyX
586 If there exists an internationalized version of the bind file named
587 \begin_inset Flex Code
590 \begin_layout Plain Layout
596 , that will be used first.
597 \change_inserted -712698321 1483535138
601 \begin_layout Labeling
602 \labelwidthstring 00.00.0000
604 \change_inserted -712698321 1483874001
605 \begin_inset Flex Code
608 \begin_layout Plain Layout
610 \change_inserted -712698321 1483535144
616 contains files with the extension
617 \begin_inset Flex Code
620 \begin_layout Plain Layout
622 \change_inserted -712698321 1483869840
630 which define the diverse citation possibilities (natbib, biblatex etc.).
632 \begin_inset CommandInset ref
634 reference "subsec:Cite-Engine-Files"
646 \begin_layout Labeling
647 \labelwidthstring 00.00.0000
648 \begin_inset Flex Code
651 \begin_layout Plain Layout
657 contains graphics files that can be included in documents.
661 \begin_layout Labeling
662 \labelwidthstring 00.00.0000
663 \begin_inset Flex Code
666 \begin_layout Plain Layout
672 contains \SpecialChar LyX
673 documentation files (including the one you are currently reading).
675 \begin_inset Flex Code
678 \begin_layout Plain Layout
685 deserves special attention, as noted above.
686 The internationalized help docs are in subdirectories
687 \begin_inset Flex Code
690 \begin_layout Plain Layout
697 \begin_inset Quotes eld
701 \begin_inset Quotes erd
704 is the ISO language code.
706 \begin_inset CommandInset ref
708 reference "cha:Internationalizing-LyX"
715 \begin_layout Labeling
716 \labelwidthstring 00.00.0000
717 \begin_inset Flex Code
720 \begin_layout Plain Layout
726 contains example files that explain how to use some features.
727 In the file browser, press the
728 \begin_inset Flex Noun
731 \begin_layout Plain Layout
740 \begin_layout Labeling
741 \labelwidthstring 00.00.0000
742 \begin_inset Flex Code
745 \begin_layout Plain Layout
751 contains image files that are used by the
752 \begin_inset Flex Noun
755 \begin_layout Plain Layout
762 In addition, it also contains the individual icons used in the toolbar
763 and the banners that can be shown when \SpecialChar LyX
767 \begin_layout Labeling
768 \labelwidthstring 00.00.0000
769 \begin_inset Flex Code
772 \begin_layout Plain Layout
778 contains keyboard keymapping files.
780 \begin_inset CommandInset ref
782 reference "sec:International-Keymap-Stuff"
789 \begin_layout Labeling
790 \labelwidthstring 00.00.0000
791 \begin_inset Flex Code
794 \begin_layout Plain Layout
800 contains the text class and module files described in
801 \begin_inset CommandInset ref
803 reference "cha:Installing-New-Document"
810 \begin_layout Labeling
811 \labelwidthstring 00.00.0000
812 \begin_inset Flex Code
815 \begin_layout Plain Layout
822 \begin_inset Flex Code
825 \begin_layout Plain Layout
831 Python scripts used to convert between \SpecialChar LyX
833 These can be run from the command line if, say, you want to batch-convert
837 \begin_layout Labeling
838 \labelwidthstring 00.00.0000
839 \begin_inset Flex Code
842 \begin_layout Plain Layout
848 contains some files that demonstrate the capabilities of the
849 \begin_inset Flex Noun
852 \begin_layout Plain Layout
863 Also contains some scripts used by \SpecialChar LyX
867 \begin_layout Labeling
868 \labelwidthstring 00.00.0000
869 \begin_inset Flex Code
872 \begin_layout Plain Layout
878 contains the standard \SpecialChar LyX
879 template files described in
880 \begin_inset CommandInset ref
882 reference "subsec:Creating-Templates"
889 \begin_layout Labeling
890 \labelwidthstring 00.00.0000
891 \begin_inset Flex Code
894 \begin_layout Plain Layout
900 contains files with the extension
901 \begin_inset Flex Code
904 \begin_layout Plain Layout
910 that define the user interface to \SpecialChar LyX
912 That is, the files define which items appear in which menus and the items
913 appearing on the toolbar.
914 \change_inserted -712698321 1490533733
918 \begin_layout Labeling
919 \labelwidthstring 00.00.0000
921 \change_inserted -712698321 1490533849
922 \begin_inset Flex Code
925 \begin_layout Plain Layout
927 \change_inserted -712698321 1490533738
933 contains files with the extension
934 \begin_inset Flex Code
937 \begin_layout Plain Layout
939 \change_inserted -712698321 1490533759
945 which define the templates for the insertion of external material to a
948 \begin_inset CommandInset ref
950 reference "chap:Including-External-Material"
959 \begin_layout Subsection
960 Files you don't want to modify
963 \begin_layout Standard
964 These files are used internally by \SpecialChar LyX
965 and you generally do not need to modify
966 them unless you are a developer.
969 \begin_layout Labeling
970 \labelwidthstring 00.00.0000
971 \begin_inset Flex Code
974 \begin_layout Plain Layout
980 this file contains the list of \SpecialChar LyX
982 The contents are displayed with the menu entry
983 \begin_inset Flex Noun
986 \begin_layout Plain Layout
987 Help\SpecialChar menuseparator
1000 \begin_layout Labeling
1001 \labelwidthstring 00.00.0000
1002 \begin_inset Flex Code
1005 \begin_layout Plain Layout
1011 this is a \SpecialChar LaTeX
1012 script used during the configuration process.
1013 Do not run directly.
1016 \begin_layout Labeling
1017 \labelwidthstring 00.00.0000
1018 \begin_inset Flex Code
1021 \begin_layout Plain Layout
1027 this is a Python script that is used to re-configure \SpecialChar LyX
1029 It creates configuration files in the directory it was run from.
1032 \begin_layout Subsection
1033 Other files needing a line or two
1036 \begin_layout Labeling
1037 \labelwidthstring 00.00.0000
1038 \begin_inset Flex Code
1041 \begin_layout Plain Layout
1047 this contains tables describing how different character encodings can be
1051 \begin_layout Labeling
1052 \labelwidthstring 00.00.0000
1054 \change_deleted -712698321 1490533856
1055 \begin_inset Flex Code
1058 \begin_layout Plain Layout
1064 this file contains the templates available to the new
1065 \begin_inset Flex Noun
1068 \begin_layout Plain Layout
1070 \begin_inset space ~
1079 \begin_inset CommandInset ref
1081 reference "chap:Including-External-Material"
1090 \begin_layout Labeling
1091 \labelwidthstring 00.00.0000
1092 \begin_inset Flex Code
1095 \begin_layout Plain Layout
1101 this file contains a list of all the languages currently supported by \SpecialChar LyX
1105 \begin_layout Labeling
1106 \labelwidthstring 00.00.0000
1107 \begin_inset Flex Code
1110 \begin_layout Plain Layout
1116 contains information about the supported fonts.
1119 \begin_layout Labeling
1120 \labelwidthstring 00.00.0000
1121 \begin_inset Flex Code
1124 \begin_layout Plain Layout
1130 this file contains translations for internationalized paragraph styles
1132 \begin_inset CommandInset ref
1134 reference "subsec:I18n"
1141 \begin_layout Labeling
1142 \labelwidthstring 00.00.0000
1143 \begin_inset Flex Code
1146 \begin_layout Plain Layout
1152 this file contains information about unicode-encoded glyphs and the way
1153 they are supported by \SpecialChar LyX
1154 via \SpecialChar LaTeX
1158 \begin_layout Section
1159 Your local configuration directory
1162 \begin_layout Standard
1163 Even if you are using \SpecialChar LyX
1164 as an unprivileged user, you might want to change
1166 configuration for your own use.
1168 \begin_inset Flex Code
1171 \begin_layout Plain Layout
1177 directory contains all your personal configuration files.
1178 This is the directory described as
1179 \begin_inset Quotes eld
1183 \begin_inset Quotes erd
1187 \begin_inset Flex Noun
1190 \begin_layout Plain Layout
1191 Help\SpecialChar menuseparator
1193 \begin_inset space ~
1202 This directory is used as a mirror of
1203 \begin_inset Flex Code
1206 \begin_layout Plain Layout
1212 , which means that every file in
1213 \begin_inset Flex Code
1216 \begin_layout Plain Layout
1222 is a replacement for the corresponding file in
1223 \begin_inset Flex Code
1226 \begin_layout Plain Layout
1233 Any configuration file described in the above sections can be placed either
1234 in the system-wide directory, in which case it will affect all users, or
1235 in your local directory for your own use.
1238 \begin_layout Standard
1239 To make things clearer, let's provide a few examples:
1242 \begin_layout Itemize
1243 The preferences set in the
1244 \begin_inset Flex Noun
1247 \begin_layout Plain Layout
1248 Tools\SpecialChar menuseparator
1254 dialog are saved to a file
1255 \begin_inset Flex Code
1258 \begin_layout Plain Layout
1265 \begin_inset Flex Code
1268 \begin_layout Plain Layout
1277 \begin_layout Itemize
1278 When you reconfigure using
1279 \begin_inset Flex Noun
1282 \begin_layout Plain Layout
1283 Tools\SpecialChar menuseparator
1291 \begin_inset Flex Code
1294 \begin_layout Plain Layout
1300 script, and the resulting files are written in your local configuration
1302 This means that any additional text class file that you might have added
1304 \begin_inset Flex Code
1307 \begin_layout Plain Layout
1313 will be added to the list of classes in the
1314 \begin_inset Flex Noun
1317 \begin_layout Plain Layout
1318 Document\SpecialChar menuseparator
1327 \begin_layout Itemize
1328 If you get some updated documentation from \SpecialChar LyX
1329 ftp site and cannot install
1330 it because you do not have sysadmin rights on your system, you can just
1332 \begin_inset Flex Code
1335 \begin_layout Plain Layout
1341 and the items in the
1342 \begin_inset Flex Noun
1345 \begin_layout Plain Layout
1351 menu will open them!
1354 \begin_layout Section
1355 Running \SpecialChar LyX
1356 with multiple configurations
1359 \begin_layout Standard
1360 The configuration freedom of the local configuration directory may not suffice
1361 if you want to have more than one configuration at your disposal.
1362 For example, you may want to be use different key bindings or printer settings
1364 You can achieve this by having several such directories.
1365 You then specify which directory to use at run-time.
1368 \begin_layout Standard
1369 Invoking \SpecialChar LyX
1370 with the command line switch
1371 \begin_inset Flex Code
1374 \begin_layout Plain Layout
1384 instructs the program to read the configuration from that directory, and
1385 not from the default directory.
1386 (You can determine the default directory by running \SpecialChar LyX
1388 \begin_inset Flex Code
1391 \begin_layout Plain Layout
1397 switch.) If the specified directory does not exist, \SpecialChar LyX
1399 for you, just like it does for the default directory on the first time
1400 you run the program.
1401 You can modify the configuration options in this additional user directory
1402 exactly as you would for the default directory.
1403 These directories are completely independent (but read on).
1404 Note that setting the environment variable
1405 \begin_inset Flex Code
1408 \begin_layout Plain Layout
1414 to some value has exactly the same effect.
1417 \begin_layout Standard
1418 Having several configurations also requires more maintenance: if you want
1419 to add a new layout to
1420 \begin_inset Flex Code
1423 \begin_layout Plain Layout
1429 which you want available from all your configurations, you must add it
1430 to each directory separately.
1431 You can avoid this with the following trick: after \SpecialChar LyX
1432 creates the additional
1433 directory, most of the subdirectories (see above) are empty.
1434 If you want the new configuration to mirror an existing one, replace the
1435 empty subdirectory with a symbolic link to the matching subdirectory in
1436 the existing configuration.
1438 \begin_inset Flex Code
1441 \begin_layout Plain Layout
1447 subdirectory, however, since it contains a file written by the configuration
1448 script (also accessible through
1449 \begin_inset Flex Noun
1452 \begin_layout Plain Layout
1453 Tools\SpecialChar menuseparator
1459 ) which is configuration-specific.
1462 \begin_layout Chapter
1463 The Preferences dialog
1466 \begin_layout Standard
1467 All options of the preferences dialog are described in the Appendix
1469 The Preferences Dialog
1476 For some options you might find here more details.
1479 \begin_layout Section
1481 \begin_inset CommandInset label
1490 \begin_layout Standard
1491 The first step is to define your file formats if they are not already defined.
1493 \begin_inset Flex Noun
1496 \begin_layout Plain Layout
1497 Tools\SpecialChar menuseparator
1505 \begin_inset Flex Noun
1508 \begin_layout Plain Layout
1509 File Handling\SpecialChar menuseparator
1516 \begin_inset Flex Noun
1519 \begin_layout Plain Layout
1525 button to define your new format.
1527 \begin_inset Flex Noun
1530 \begin_layout Plain Layout
1536 field contains the name used to identify the format in the GUI.
1538 \begin_inset Flex Noun
1541 \begin_layout Plain Layout
1547 is used to identify the format internally.
1548 You will also need to enter a file extension.
1549 These are all required.
1551 \begin_inset Flex Noun
1554 \begin_layout Plain Layout
1560 field is used to provide a keyboard shortcut on the menus.
1561 (For example, pressing
1562 \begin_inset Flex Noun
1565 \begin_layout Plain Layout
1572 \begin_inset Flex Noun
1575 \begin_layout Plain Layout
1576 Document\SpecialChar menuseparator
1577 View (Other Formats)\SpecialChar menuseparator
1586 \begin_layout Standard
1588 \begin_inset Flex Noun
1591 \begin_layout Plain Layout
1598 \begin_inset Flex Noun
1601 \begin_layout Plain Layout
1608 For example, you might want to use
1609 \begin_inset Flex Noun
1612 \begin_layout Plain Layout
1618 to view PostScript files.
1619 You can enter the command needed to start the program in the corresponding
1621 In defining this command, you can use the four variables listed in the
1623 The viewer is launched when you view an image in \SpecialChar LyX
1625 \begin_inset Flex Noun
1628 \begin_layout Plain Layout
1629 Document\SpecialChar menuseparator
1636 The editor is for example launched when you right-click on an image and
1638 \begin_inset Flex Noun
1641 \begin_layout Plain Layout
1647 in the appearing context menu.
1650 \begin_layout Standard
1652 \begin_inset Flex Noun
1655 \begin_layout Plain Layout
1661 type of a format is optional, but if it is specified, it must be unique
1663 It is used to detect files of this format from the file contents.
1664 For some important file formats there is no MIME type officially registered
1666 \begin_inset CommandInset href
1669 target "http://www.iana.org/assignments/media-types/"
1675 Therefore \SpecialChar LyX
1676 uses the extended list of MIME types as specified by
1677 \begin_inset CommandInset href
1679 name "freedesktop.org"
1680 target "http://www.freedesktop.org/wiki/Specifications/shared-mime-info-spec"
1688 \begin_layout Standard
1690 \begin_inset Flex Noun
1693 \begin_layout Plain Layout
1699 option tells \SpecialChar LyX
1700 that a format is suitable for document export.
1701 If this is set and if a suitable conversion route exists (see
1702 \begin_inset CommandInset ref
1704 reference "sec:Converters"
1708 ), the format will appear in the
1709 \begin_inset Flex Noun
1712 \begin_layout Plain Layout
1713 File\SpecialChar menuseparator
1720 The format will also appear in the
1721 \begin_inset Flex Noun
1724 \begin_layout Plain Layout
1725 Document\SpecialChar menuseparator
1731 menu if a viewer is specified for the format.
1732 Pure image formats, such as
1733 \begin_inset Flex Code
1736 \begin_layout Plain Layout
1742 , should not use this option.
1743 Formats that can both represent vector graphics and documents like
1744 \begin_inset Flex Code
1747 \begin_layout Plain Layout
1756 \begin_layout Standard
1758 \begin_inset Flex Noun
1761 \begin_layout Plain Layout
1762 Vector graphics format
1767 tells \SpecialChar LyX
1768 that a format can contain vector graphics.
1769 This information is used to determine the target format of included graphics
1771 \begin_inset Flex Noun
1774 \begin_layout Plain Layout
1781 Included graphics may need to be converted to either
1782 \begin_inset Flex Noun
1785 \begin_layout Plain Layout
1792 \begin_inset Flex Noun
1795 \begin_layout Plain Layout
1802 \begin_inset Flex Noun
1805 \begin_layout Plain Layout
1812 \begin_inset Flex Noun
1815 \begin_layout Plain Layout
1821 cannot handle other image formats.
1822 If an included graphic is not already in
1823 \begin_inset Flex Noun
1826 \begin_layout Plain Layout
1833 \begin_inset Flex Noun
1836 \begin_layout Plain Layout
1843 \begin_inset Flex Noun
1846 \begin_layout Plain Layout
1852 format, it is converted to
1853 \begin_inset Flex Noun
1856 \begin_layout Plain Layout
1862 if the vector format option is set, and otherwise to
1863 \begin_inset Flex Noun
1866 \begin_layout Plain Layout
1875 \begin_layout Section
1879 \begin_layout Standard
1880 Since all conversions from one format to another take place in \SpecialChar LyX
1882 directory, it is sometimes necessary to modify a file before copying it
1883 to the temporary directory in order that the conversion may be performed.
1887 \begin_layout Plain Layout
1888 For example, the file may refer to other files—images, for example—using
1889 relative file names, and these may become invalid when the file is copied
1890 to the temporary directory.
1895 This is done by a Copier: It copies a file to (or from) the temporary directory
1896 and may modify it in the process.
1899 \begin_layout Standard
1900 The definitions of the copiers may use eight variables:
1903 \begin_layout Labeling
1904 \labelwidthstring 00.00.0000
1905 \begin_inset Flex Code
1908 \begin_layout Plain Layout
1914 The \SpecialChar LyX
1915 system directory (e.
1916 \begin_inset space \thinspace{}
1920 \begin_inset space \space{}
1924 \begin_inset Flex Noun
1927 \begin_layout Plain Layout
1936 \begin_layout Labeling
1937 \labelwidthstring 00.00.0000
1938 \begin_inset Flex Code
1941 \begin_layout Plain Layout
1950 \begin_layout Labeling
1951 \labelwidthstring 00.00.0000
1952 \begin_inset Flex Code
1955 \begin_layout Plain Layout
1964 \begin_layout Labeling
1965 \labelwidthstring 00.00.0000
1966 \begin_inset Flex Code
1969 \begin_layout Plain Layout
1975 The base name (without filename extension) in the \SpecialChar LyX
1979 \begin_layout Labeling
1980 \labelwidthstring 00.00.0000
1981 \begin_inset Flex Code
1984 \begin_layout Plain Layout
1990 The full directory path of the \SpecialChar LyX
1994 \begin_layout Labeling
1995 \labelwidthstring 00.00.0000
1996 \begin_inset Flex Code
1999 \begin_layout Plain Layout
2005 The full pathname to the original \SpecialChar LyX
2006 file being processed
2009 \begin_layout Labeling
2010 \labelwidthstring 00.00.0000
2011 \begin_inset Flex Code
2014 \begin_layout Plain Layout
2020 The filename (without any directory path) of the \SpecialChar LyX
2024 \begin_layout Labeling
2025 \labelwidthstring 00.00.0000
2026 \begin_inset Flex Code
2029 \begin_layout Plain Layout
2035 The `\SpecialChar LaTeX
2039 \begin_layout Standard
2040 The latter should be the filename as it would be used in a \SpecialChar LaTeX
2048 It is relevant only when exporting files suitable for such inclusion.
2051 \begin_layout Standard
2052 Copiers can be used to do almost anything with output files.
2053 For example, suppose you want generated pdf files to be copied to a special
2055 \begin_inset Flex Code
2058 \begin_layout Plain Layout
2065 Then you could write a shell script such as this one:
2068 \begin_layout Standard
2069 \begin_inset listings
2073 \begin_layout Plain Layout
2078 \begin_layout Plain Layout
2083 \begin_layout Plain Layout
2085 TOFILE=`basename $2`
2088 \begin_layout Plain Layout
2090 cp $FROMFILE /home/you/pdf/$TOFILE
2095 Save it in your local \SpecialChar LyX
2097 \begin_inset Flex Code
2100 \begin_layout Plain Layout
2101 /home/you/.lyx/scripts/pdfcopier.sh
2106 —and make it executable, if you need to do so on your platform.
2108 \begin_inset Flex Noun
2111 \begin_layout Plain Layout
2112 Tools\SpecialChar menuseparator
2118 dialog, select under
2119 \begin_inset Flex Noun
2122 \begin_layout Plain Layout
2123 File Handling\SpecialChar menuseparator
2130 \begin_inset Flex Noun
2133 \begin_layout Plain Layout
2139 format—or one of the other pdf formats—and enter
2140 \begin_inset Flex Code
2143 \begin_layout Plain Layout
2144 pdfcopier.sh $$i $$o
2150 \begin_inset Flex Noun
2153 \begin_layout Plain Layout
2163 \begin_layout Standard
2164 Copiers are used by \SpecialChar LyX
2165 in various of its own conversions.
2166 For example, if appropriate programs are found, \SpecialChar LyX
2167 will automatically install
2169 \begin_inset Flex Noun
2172 \begin_layout Plain Layout
2179 \begin_inset Flex Noun
2182 \begin_layout Plain Layout
2184 \begin_inset space ~
2193 When these formats are exported, the copier sees that not just the main
2194 HTML file but various associated files (style files, images, etc.) are also
2196 All these files are written to a subdirectory of the directory in which
2197 the original \SpecialChar LyX
2202 \begin_layout Plain Layout
2203 This copier can be customized.
2205 \begin_inset Quotes eld
2209 \begin_inset Quotes erd
2212 argument takes a comma-separated list of extensions to be copied; if it
2213 is omitted, all files will be copied.
2215 \begin_inset Quotes eld
2219 \begin_inset Quotes erd
2222 argument determines the extension added to the generated directory.
2224 \begin_inset Quotes eld
2228 \begin_inset Flex Noun
2231 \begin_layout Plain Layout
2238 \begin_inset Quotes erd
2241 , so HTML generated from
2242 \begin_inset Flex Noun
2245 \begin_layout Plain Layout
2246 /path/to/filename.lyx
2252 \begin_inset Flex Noun
2255 \begin_layout Plain Layout
2256 /path/to/filename.html.LyXconv
2270 \begin_layout Section
2272 \begin_inset CommandInset label
2274 name "sec:Converters"
2281 \begin_layout Standard
2282 You can define your own Converters to convert files between different formats.
2284 \begin_inset Flex Noun
2287 \begin_layout Plain Layout
2288 Tools\SpecialChar menuseparator
2289 Preferences\SpecialChar menuseparator
2290 File Handling\SpecialChar menuseparator
2299 \begin_layout Standard
2300 To define a new converter, select the
2301 \begin_inset Flex Noun
2304 \begin_layout Plain Layout
2306 \begin_inset space ~
2315 \begin_inset Flex Noun
2318 \begin_layout Plain Layout
2320 \begin_inset space ~
2328 from the drop-down lists, enter the command needed for the conversion,
2330 \begin_inset Flex Noun
2333 \begin_layout Plain Layout
2340 Several variables can be used in the definition of converters:
2343 \begin_layout Labeling
2344 \labelwidthstring 00.00.0000
2345 \begin_inset Flex Code
2348 \begin_layout Plain Layout
2354 The \SpecialChar LyX
2358 \begin_layout Labeling
2359 \labelwidthstring 00.00.0000
2360 \begin_inset Flex Code
2363 \begin_layout Plain Layout
2372 \begin_layout Labeling
2373 \labelwidthstring 00.00.0000
2374 \begin_inset Flex Code
2377 \begin_layout Plain Layout
2386 \begin_layout Labeling
2387 \labelwidthstring 00.00.0000
2388 \begin_inset Flex Code
2391 \begin_layout Plain Layout
2397 The base filename of the input file (i.
2398 \begin_inset space \thinspace{}
2401 g., without the extension)
2404 \begin_layout Labeling
2405 \labelwidthstring 00.00.0000
2406 \begin_inset Flex Code
2409 \begin_layout Plain Layout
2415 The path to the input file
2418 \begin_layout Labeling
2419 \labelwidthstring 00.00.0000
2420 \begin_inset Flex Code
2423 \begin_layout Plain Layout
2429 The path to the original input file (this is different from $$p when a
2430 chain of converters is called)
2433 \begin_layout Labeling
2434 \labelwidthstring 00.00.0000
2435 \begin_inset Flex Code
2438 \begin_layout Plain Layout
2444 The iconv name for the encoding of the document.
2447 \begin_layout Standard
2449 \begin_inset Flex Noun
2452 \begin_layout Plain Layout
2454 \begin_inset space ~
2462 field you can enter the following flags, separated by commas:
2465 \begin_layout Labeling
2466 \labelwidthstring 00.00.0000
2467 \begin_inset Flex Code
2470 \begin_layout Plain Layout
2476 This converter runs some form of \SpecialChar LaTeX
2478 This will make \SpecialChar LyX
2479 's \SpecialChar LaTeX
2480 error logs available.
2483 \begin_layout Labeling
2484 \labelwidthstring 00.00.0000
2485 \begin_inset Flex Code
2488 \begin_layout Plain Layout
2494 Needs the \SpecialChar LaTeX
2496 \begin_inset Flex Noun
2499 \begin_layout Plain Layout
2505 file for the conversion.
2508 \begin_layout Labeling
2509 \labelwidthstring 00.00.0000
2510 \begin_inset Flex Code
2513 \begin_layout Plain Layout
2520 \begin_inset Quotes eld
2524 \begin_inset Quotes erd
2527 file from the backend, which in practice means a \SpecialChar LaTeX
2528 file like the one we
2529 would export, without
2530 \begin_inset Flex Code
2533 \begin_layout Plain Layout
2542 \begin_layout Labeling
2543 \labelwidthstring 00.00.0000
2544 \begin_inset Flex Code
2547 \begin_layout Plain Layout
2556 \begin_layout Standard
2557 The following three flags are not really flags at all because they take
2559 \begin_inset Flex Noun
2562 \begin_layout Plain Layout
2564 \begin_inset space ~
2568 \begin_inset space ~
2579 \begin_layout Labeling
2580 \labelwidthstring 00.00.0000
2581 \begin_inset Flex Code
2584 \begin_layout Plain Layout
2590 If set, the converter's standard error will be redirected to a file
2591 \begin_inset Flex Code
2594 \begin_layout Plain Layout
2600 , and the script given as argument will be run as:
2601 \begin_inset Flex Code
2604 \begin_layout Plain Layout
2605 script < infile.out > infile.log
2611 The argument may contain
2612 \begin_inset Flex Code
2615 \begin_layout Plain Layout
2624 \begin_layout Labeling
2625 \labelwidthstring 00.00.0000
2626 \begin_inset Flex Code
2629 \begin_layout Plain Layout
2635 The name of the directory in which the converter will dump the generated
2638 will not create this directory, and it does not copy anything into it,
2639 though it will copy this directory to the destination.
2640 The argument may contain
2641 \begin_inset Flex Code
2644 \begin_layout Plain Layout
2650 , which will be replaced by the base name of the input and output files,
2651 respectively, when the directory is copied.
2652 \begin_inset Newline newline
2655 Note that resultdir and usetempdir make no sense together.
2656 The latter will be ignored if the former is given.
2659 \begin_layout Labeling
2660 \labelwidthstring 00.00.0000
2661 \begin_inset Flex Code
2664 \begin_layout Plain Layout
2670 Determines the output file name and may, contain
2671 \begin_inset Flex Code
2674 \begin_layout Plain Layout
2681 Sensible only with resultdir and optional even then; if not given, it defaults
2685 \begin_layout Standard
2686 None of these last three are presently used in any of the converters that
2687 are installed with \SpecialChar LyX
2692 \begin_layout Standard
2693 You do not have to define converters for all formats between which you want
2695 For example, you will note that there is no `\SpecialChar LyX
2696 to PostScript' converter,
2697 but \SpecialChar LyX
2698 will export PostScript.
2699 It does so by first creating a \SpecialChar LaTeX
2700 file (no converter needs to be defined
2701 for this) which is then converted to DVI using the `\SpecialChar LaTeX
2703 and finally converting the resulting DVI file to PostScript.
2705 finds such `chains' of converters automatically, and it will always choose
2706 the shortest possible chain.
2707 You can, though, still define multiple conversion methods between file
2709 For example, the standard \SpecialChar LyX
2710 configuration provides five ways to convert
2715 \begin_layout Enumerate
2717 \begin_inset Flex Noun
2720 \begin_layout Plain Layout
2729 \begin_layout Enumerate
2730 via (DVI and) PostScript, using
2731 \begin_inset Flex Noun
2734 \begin_layout Plain Layout
2743 \begin_layout Enumerate
2745 \begin_inset Flex Noun
2748 \begin_layout Plain Layout
2757 \begin_layout Enumerate
2759 \begin_inset Flex Noun
2762 \begin_layout Plain Layout
2772 \begin_layout Enumerate
2774 \begin_inset Flex Noun
2777 \begin_layout Plain Layout
2787 \begin_layout Standard
2788 To define such alternate chains, you must define multiple target `file formats',
2790 \begin_inset CommandInset ref
2792 reference "sec:Formats"
2797 For example, in the standard configuration, the formats named
2798 \begin_inset Flex Noun
2801 \begin_layout Plain Layout
2808 \begin_inset Flex Noun
2811 \begin_layout Plain Layout
2818 \begin_inset Flex Noun
2821 \begin_layout Plain Layout
2828 \begin_inset Flex Noun
2831 \begin_layout Plain Layout
2838 \begin_inset Flex Noun
2841 \begin_layout Plain Layout
2848 \begin_inset Flex Noun
2851 \begin_layout Plain Layout
2858 \begin_inset Flex Noun
2861 \begin_layout Plain Layout
2868 \begin_inset Flex Noun
2871 \begin_layout Plain Layout
2879 \begin_inset Flex Noun
2882 \begin_layout Plain Layout
2889 \begin_inset Flex Noun
2892 \begin_layout Plain Layout
2899 ) are defined, all of which share the extension
2900 \begin_inset Flex Noun
2903 \begin_layout Plain Layout
2909 , and which correspond to the conversion methods just mentioned.
2912 \begin_layout Chapter
2913 Internationalizing \SpecialChar LyX
2915 \begin_inset CommandInset label
2917 name "cha:Internationalizing-LyX"
2924 \begin_layout Standard
2926 supports using a translated interface.
2927 Last time we checked, \SpecialChar LyX
2928 provided text in thirty languages.
2929 The language of choice is called your
2934 (For further reading on locale settings, see also the documentation for
2935 locale that comes with your operating system.
2936 For Linux, the manual page for
2937 \begin_inset Flex Code
2940 \begin_layout Plain Layout
2946 could be a good place to start).
2949 \begin_layout Standard
2950 Notice that these translations will work, but do contain a few flaws.
2951 In particular, all dialogs have been designed with the English text in
2952 mind, which means that some of the translated text will be too large to
2953 fit within the space allocated.
2954 This is only a display problem and will not cause any harm.
2955 Also, you will find that some of the translations do not define shortcut
2956 keys for everything.
2957 Sometimes, there are simply not enough free letters to do it.
2958 Other times, the translator just hasn't got around to doing it yet.
2959 Our localization team, which you may wish to join,
2963 \begin_layout Plain Layout
2964 If you are a fluent speaker of a language other than English, joining these
2965 teams is a great way to give back to the \SpecialChar LyX
2971 will of course try to fix these shortcomings in future versions of \SpecialChar LyX
2975 \begin_layout Section
2976 Translating \SpecialChar LyX
2980 \begin_layout Subsection
2981 Translating the graphical user interface (text messages).
2984 \begin_layout Standard
2987 \begin_inset Flex Code
2990 \begin_layout Plain Layout
2996 library to handle the internationalization of the interface.
2997 To have \SpecialChar LyX
2998 speak your favorite language in all menus and dialogs, you need
3000 \begin_inset Flex Code
3003 \begin_layout Plain Layout
3009 -file for that language.
3010 When this is available, you'll have to generate a
3011 \begin_inset Flex Code
3014 \begin_layout Plain Layout
3020 -file from it and install the
3021 \begin_inset Flex Code
3024 \begin_layout Plain Layout
3031 The process of doing all of this is explained in the documentation for
3033 \begin_inset Flex Code
3036 \begin_layout Plain Layout
3043 It is possible to do this just for yourself, but if you're going to do
3044 it, you might as well share the results of your labors with the rest of
3045 the \SpecialChar LyX
3047 Send a message to the \SpecialChar LyX
3048 developers' list for more information about how
3052 \begin_layout Standard
3053 In short, this is what you should do (xx denotes the language code):
3056 \begin_layout Itemize
3057 Check out the \SpecialChar LyX
3060 \begin_inset CommandInset href
3062 name "information on the web"
3063 target "http://www.lyx.org/HowToUseGIT"
3071 \begin_layout Itemize
3073 \begin_inset Flex Code
3076 \begin_layout Plain Layout
3082 to the folder of the
3083 \begin_inset Flex Code
3086 \begin_layout Plain Layout
3094 \begin_inset Flex Code
3097 \begin_layout Plain Layout
3105 \begin_inset Flex Code
3108 \begin_layout Plain Layout
3114 doesn't exist anywhere, it can be remade with the console command
3115 \begin_inset Flex Code
3118 \begin_layout Plain Layout
3124 in that directory, or you can use an existing po-file for some other language
3128 \begin_layout Itemize
3130 \begin_inset Flex Code
3133 \begin_layout Plain Layout
3143 \begin_layout Plain Layout
3144 This is just a text file, so it can be edited in any text editor.
3145 But there are also specialized programs that support such editing, such
3150 (for all platforms) or
3159 contains a `mode' for editing
3160 \begin_inset Flex Code
3163 \begin_layout Plain Layout
3170 \begin_inset Flex URL
3173 \begin_layout Plain Layout
3175 https://www.gnu.org/software/gettext/manual/html_node/PO-Mode.html
3187 For some menu- and widget-labels, there are also shortcut keys that should
3189 Those keys are marked after a `|', and should be translated according to
3190 the words and phrases of the language.
3191 You should also fill also out the information at the beginning of the new
3193 \begin_inset Flex Code
3196 \begin_layout Plain Layout
3202 -file with your email-address, etc., so people know where to reach you with
3203 suggestions and entertaining flames.
3206 \begin_layout Standard
3207 If you are just doing this on your own, then:
3210 \begin_layout Itemize
3212 \begin_inset Flex Code
3215 \begin_layout Plain Layout
3222 This can be done with
3223 \begin_inset Flex Code
3226 \begin_layout Plain Layout
3227 msgfmt -o xx.mo < xx.po
3235 \begin_layout Itemize
3237 \begin_inset Flex Code
3240 \begin_layout Plain Layout
3246 -file to your locale-tree, at the correct directory for application messages
3251 xx, and under the name
3252 \begin_inset Flex Code
3255 \begin_layout Plain Layout
3262 \begin_inset space \thinspace{}
3266 \begin_inset space \space{}
3270 \begin_inset Flex Code
3273 \begin_layout Plain Layout
3274 /usr/local/share/locale/xx/LC_MESSAGES/lyx.mo
3284 \begin_layout Standard
3285 As said, however, it would be best if the new
3286 \begin_inset Flex Code
3289 \begin_layout Plain Layout
3295 file could be added to the \SpecialChar LyX
3296 distribution, so others can use it.
3297 Adding it involves making additional changes to \SpecialChar LyX
3299 So send an email to the developers' mailing list if you're interested in
3303 \begin_layout Subsubsection
3307 \begin_layout Standard
3308 Sometimes it turns out that one English message needs to be translated into
3309 different messages in the target language.
3310 One example is the message
3311 \begin_inset Flex Code
3314 \begin_layout Plain Layout
3320 which has the German translation
3328 , depending upon exactly what the English
3329 \begin_inset Quotes eld
3333 \begin_inset Quotes erd
3338 \begin_inset Flex Code
3341 \begin_layout Plain Layout
3347 does not handle such ambiguous translations.
3348 Therefore you have to add some context information to the message: Instead
3350 \begin_inset Flex Code
3353 \begin_layout Plain Layout
3360 \begin_inset Flex Code
3363 \begin_layout Plain Layout
3364 To[[as in 'From format x to format y']]
3370 \begin_inset Flex Code
3373 \begin_layout Plain Layout
3374 To[[as in 'From page x to page y']].
3379 Now the two occurrences of
3380 \begin_inset Flex Code
3383 \begin_layout Plain Layout
3390 \begin_inset Flex Code
3393 \begin_layout Plain Layout
3399 and can be translated correctly to
3410 \begin_layout Standard
3411 Of course the context information needs to be stripped off the original
3412 message when no translation is used.
3413 Therefore you have to put it in double square brackets at the end of the
3414 message (see the example above).
3415 The translation mechanism of \SpecialChar LyX
3416 ensures that everything in double square
3417 brackets at the end of messages is removed before displaying the message.
3420 \begin_layout Subsection
3421 Translating the documentation.
3424 \begin_layout Standard
3425 The online documentation (in the
3426 \begin_inset Flex Noun
3429 \begin_layout Plain Layout
3435 -menu) can (and should!) be translated.
3436 If there are translated versions of the documentation available
3440 \begin_layout Plain Layout
3441 As of March 2008, at least some of the documents have been translated into
3442 fourteen languages, with the Tutorial available in a few more.
3447 and the locale is set accordingly, these will be used automagically by
3451 looks for translated versions as
3452 \begin_inset Flex Code
3455 \begin_layout Plain Layout
3456 LyXDir/doc/xx/DocName.lyx
3462 \begin_inset Flex Code
3465 \begin_layout Plain Layout
3471 is the code for the language currently in use.
3472 If there are no translated documents, the default English versions will
3474 Note that the translated versions must have the same filenames (
3475 \begin_inset Flex Code
3478 \begin_layout Plain Layout
3484 above) as the original.
3485 If you feel up to translating the documentation (an excellent way to proof-read
3486 the original documentation by the way!), there are a few things you should
3490 \begin_layout Itemize
3491 Check out the documentation translation web page at
3492 \begin_inset CommandInset href
3494 name "http://www.lyx.org/Translation"
3495 target "http://www.lyx.org/Translation"
3501 That way, you can find out which (if any) documents have already been translate
3502 d into your language.
3503 You can also find out who (if anyone) is organizing the effort to translate
3504 the documentation into your language.
3505 If no one is organizing the effort, please let us know that you're interested.
3508 \begin_layout Standard
3509 Once you get to actually translating, here's a few hints for you that may
3513 \begin_layout Itemize
3514 Join the documentation team! There is information on how to do that in
3515 \begin_inset Flex Code
3518 \begin_layout Plain Layout
3525 \begin_inset Flex Noun
3528 \begin_layout Plain Layout
3529 Help\SpecialChar menuseparator
3535 ), which by the way is the first document you should translate.
3538 \begin_layout Itemize
3539 Learn the typographic conventions for the language you are translating to.
3540 Typography is an ancient art and over the centuries, a great variety of
3541 conventions have developed throughout different parts of the world.
3542 Also study the professional terminology amongst typographers in your country.
3543 Inventing your own terminology will only confuse the users.
3546 (Warning! Typography is addictive!)
3549 \begin_layout Itemize
3550 Make a copy of the document.
3551 This will be your working copy.
3552 You can use this as your personal translated help-file by placing it in
3554 \begin_inset Flex Code
3557 \begin_layout Plain Layout
3564 \begin_inset Note Greyedout
3567 \begin_layout Plain Layout
3572 For a complex document with external material (images, etc.), if you make
3574 \begin_inset space \thinspace{}
3578 \begin_inset space \space{}
3581 in a temp dir, beware that the links to external material may be broken
3582 when the document is moved to a different place.
3583 The best way is to retrieve the \SpecialChar LyX
3585 \begin_inset Flex URL
3588 \begin_layout Plain Layout
3590 http://www.lyx.org/HowToUseGIT
3595 ) and to edit the doc file in place.
3603 \begin_layout Itemize
3604 Sometimes the original document (from the \SpecialChar LyX
3605 team) will be updated.
3606 Use the source viewer at
3607 \begin_inset CommandInset href
3609 name "http://www.lyx.org/trac/timeline"
3610 target "http://www.lyx.org/trac/timeline"
3615 to see what has been changed.
3616 That way you can easily see which parts of the translated document need
3620 \begin_layout Standard
3621 If you ever find an error in the original document, fix it and notify the
3622 rest of the documentation team of the changes! (You didn't forget to join
3623 the documentation team, did you?)
3626 \begin_layout Standard
3627 \begin_inset Branch OutDated
3631 \begin_layout Section
3632 International Keyboard Support
3635 \begin_layout Standard
3638 [Editor's Note: The following section is by
3646 It needs to be fixed to conform to the new Documentation Style sheet and
3647 to make use of the new v1.0 features.
3648 The whole thing also needs to be merged with the section following it.-jw
3649 It may also be badly out of date.-rh (2008)]
3652 \begin_layout Subsection
3653 Defining Own Keymaps: Keymap File Format
3656 \begin_layout Standard
3657 Let's look at a keyboard definition file a little closer.
3658 It is a plain text file defining
3661 \begin_layout Itemize
3662 key-to-key or key-to-string translations
3665 \begin_layout Itemize
3669 \begin_layout Itemize
3670 dead keys exceptions
3673 \begin_layout Standard
3674 To define key-to-key or key-to-string translation, use this command:
3677 \begin_layout Quotation
3678 \begin_inset Flex Code
3681 \begin_layout Plain Layout
3690 \begin_inset Flex Code
3693 \begin_layout Plain Layout
3702 \begin_layout Standard
3704 \begin_inset Flex Code
3707 \begin_layout Plain Layout
3713 is the key to be translated and
3714 \begin_inset Flex Code
3717 \begin_layout Plain Layout
3723 is the string to be inserted into the document.
3724 To define dead keys, use:
3727 \begin_layout Quotation
3728 \begin_inset Flex Code
3731 \begin_layout Plain Layout
3740 \begin_inset Flex Code
3743 \begin_layout Plain Layout
3752 \begin_layout Standard
3754 \begin_inset Flex Code
3757 \begin_layout Plain Layout
3763 is a keyboard key and
3764 \begin_inset Flex Code
3767 \begin_layout Plain Layout
3774 The following dead keys are supported (shortcut name is in parentheses):
3777 \begin_layout Quotation
3781 \begin_inset space \hfill{}
3787 \begin_layout Quotation
3789 \begin_inset space \hfill{}
3795 \begin_layout Quotation
3797 \begin_inset space \hfill{}
3803 \begin_layout Quotation
3805 \begin_inset space \hfill{}
3811 \begin_layout Quotation
3813 \begin_inset space \hfill{}
3819 \begin_layout Quotation
3821 \begin_inset space \hfill{}
3828 \begin_layout Plain Layout
3840 \begin_layout Quotation
3842 \begin_inset space \hfill{}
3848 \begin_layout Quotation
3850 \begin_inset space \hfill{}
3857 \begin_layout Plain Layout
3869 \begin_layout Quotation
3871 \begin_inset space \hfill{}
3877 \begin_layout Quotation
3879 \begin_inset space \hfill{}
3885 \begin_layout Quotation
3887 \begin_inset space \hfill{}
3894 \begin_layout Plain Layout
3906 \begin_layout Quotation
3908 \begin_inset space \hfill{}
3915 \begin_layout Plain Layout
3927 \begin_layout Quotation
3929 \begin_inset space \hfill{}
3935 \begin_layout Quotation
3936 hungarian umlaut (hug)
3937 \begin_inset space \hfill{}
3943 \begin_layout Quotation
3945 \begin_inset space \hfill{}
3951 \begin_layout Quotation
3953 \begin_inset space \hfill{}
3960 \begin_layout Plain Layout
3972 \begin_layout Standard
3973 Since in many international keyboards there are exceptions to what some
3974 dead keys should do, you can define them using
3977 \begin_layout Quotation
3978 \begin_inset Flex Code
3981 \begin_layout Plain Layout
3989 deadkey key outstring
3992 \begin_layout Standard
3993 For example, on Slovak keyboard, if you enter caron-o, it generates circumflex-o
3997 \begin_layout Quotation
3998 \begin_inset Flex Code
4001 \begin_layout Plain Layout
4014 \begin_layout Standard
4015 to make it work correctly.
4016 Also, you have to define as exceptions dead keys over i and j, to remove
4017 the dot from them before inserting an accent mark.
4018 I will change this when the time comes, but so far I haven't had time.
4021 \begin_layout Standard
4022 Oh, and about characters: backslash is escaped, so to enter it, you'll need
4025 \begin_inset Flex Code
4028 \begin_layout Plain Layout
4034 have different meaning.
4036 \begin_inset Flex Code
4039 \begin_layout Plain Layout
4045 marks comments, quotes start and end \SpecialChar LaTeX
4047 To enter quote, you'll need to use
4048 \begin_inset Flex Code
4051 \begin_layout Plain Layout
4060 \begin_inset Flex Code
4063 \begin_layout Plain Layout
4070 \begin_inset Flex Code
4073 \begin_layout Plain Layout
4084 \begin_layout Standard
4085 If you make a keyboard description file that works for your language, please
4086 mail it to me, so I can include it in the next keymap distribution.
4089 \begin_layout Standard
4090 More keywords will be supported in keymap configuration file in future,
4094 \begin_layout Itemize
4095 \begin_inset Flex Code
4098 \begin_layout Plain Layout
4109 \begin_inset space \hfill{}
4113 \begin_inset Flex Code
4116 \begin_layout Plain Layout
4125 \begin_layout Itemize
4126 \begin_inset Flex Code
4129 \begin_layout Plain Layout
4140 \begin_inset space \hfill{}
4144 \begin_inset Flex Code
4147 \begin_layout Plain Layout
4153 an external keymap translation program
4156 \begin_layout Standard
4157 Also, it should look into
4158 \begin_inset Flex Code
4161 \begin_layout Plain Layout
4167 file for defaults, too (for example, a
4168 \begin_inset Flex Code
4171 \begin_layout Plain Layout
4179 option to include default keyboard).
4187 \begin_layout Section
4188 International Keymap Stuff
4189 \begin_inset CommandInset label
4191 name "sec:International-Keymap-Stuff"
4198 \begin_layout Standard
4199 \begin_inset Note Note
4202 \begin_layout Plain Layout
4203 In doing the revisions on this document in March 2008, I did not look over
4204 this stuff, as I do not understand it.
4205 It would be good if someone else could do so.
4214 \begin_layout Standard
4215 The next two sections describe the
4216 \begin_inset Flex Code
4219 \begin_layout Plain Layout
4228 \begin_inset Flex Code
4231 \begin_layout Plain Layout
4239 file syntax in detail.
4240 These sections should help you design your own key map if the ones provided
4241 do not meet your needs.
4244 \begin_layout Subsection
4248 \begin_layout Standard
4252 \begin_inset Flex Code
4255 \begin_layout Plain Layout
4261 file maps keystrokes to characters or strings.
4262 As the name suggests, it sets a keyboard mapping.
4264 \begin_inset Flex Code
4267 \begin_layout Plain Layout
4278 \begin_inset Flex Code
4281 \begin_layout Plain Layout
4296 \begin_inset Flex Code
4299 \begin_layout Plain Layout
4312 \begin_inset Flex Code
4315 \begin_layout Plain Layout
4324 \begin_inset Flex Code
4327 \begin_layout Plain Layout
4335 are described in this section.
4338 \begin_layout Labeling
4339 \labelwidthstring 00.00.0000
4340 \begin_inset Flex Code
4343 \begin_layout Plain Layout
4351 Map a character to a string
4354 \begin_layout LyX-Code
4369 \begin_layout Standard
4402 the double-quote (")
4419 must be escaped with a preceding backslash (
4430 \begin_layout Standard
4432 \begin_inset Flex Noun
4435 \begin_layout Plain Layout
4443 statement to cause the symbol
4444 \begin_inset Flex Noun
4447 \begin_layout Plain Layout
4455 to be output for the keystroke
4456 \begin_inset Flex Noun
4459 \begin_layout Plain Layout
4470 \begin_layout LyX-Code
4476 \begin_layout Labeling
4477 \labelwidthstring 00.00.0000
4478 \begin_inset Flex Code
4481 \begin_layout Plain Layout
4489 Specify an accent character
4492 \begin_layout LyX-Code
4501 \begin_layout Standard
4502 This will make the cha
4540 This is the dead key
4544 \begin_layout Plain Layout
4551 refers to a key that does not produce a character by itself, but when followed
4552 with another key, produces the desired accent character.
4553 For example, a German characte
4555 r with an umlaut like
4565 can be produced in this manner.
4574 \begin_layout Standard
4587 and then another key not in
4604 followed by the other, not allowed key, as output.
4608 \begin_inset Flex Noun
4611 \begin_layout Plain Layout
4619 cancels a dead key, so if
4630 \begin_inset Flex Noun
4633 \begin_layout Plain Layout
4642 , the cursor will not go one position backwards but will instead cancel
4658 might have had on the next keystroke.
4662 \begin_layout Standard
4663 The following example specifies that the character ' is to be an acute accent,
4664 allowed on the characters a, e, i, o, u, A, E, I, O, and U:
4667 \begin_layout LyX-Code
4670 kmod ' acute aeiouAEIOU
4673 \begin_layout Labeling
4674 \labelwidthstring 00.00.0000
4675 \begin_inset Flex Code
4678 \begin_layout Plain Layout
4684 Specify an exception to the accent character
4687 \begin_layout LyX-Code
4696 \begin_layout Standard
4697 This defines an exce
4738 have been assigned a keystroke with a previous
4741 \begin_inset Flex Code
4744 \begin_layout Plain Layout
4768 must not belong in the
4815 If such a declaration does not exist in
4823 \begin_inset Flex Code
4826 \begin_layout Plain Layout
4860 \begin_inset Flex Code
4863 \begin_layout Plain Layout
4877 \begin_layout Standard
4878 The following command produces causes äi to be produced when you enter acute-i
4882 \begin_layout LyX-Code
4896 \begin_layout Labeling
4897 \labelwidthstring 00.00.0000
4898 \begin_inset Flex Code
4901 \begin_layout Plain Layout
4907 Combine two accent characters
4910 \begin_layout LyX-Code
4916 accent1 accent2 allowed
4919 \begin_layout Standard
4920 This one is getting pretty esoteric.
4921 It allows you to combine the effect
4977 \begin_inset Flex Code
4980 \begin_layout Plain Layout
5008 \begin_layout Standard
5009 Consider this example from the
5010 \begin_inset Flex Code
5013 \begin_layout Plain Layout
5024 \begin_layout LyX-Code
5027 kmod ; acute aeioyvhAEIOYVH
5031 kcomb acute umlaut iyIY
5034 \begin_layout Standard
5035 This allows you to press
5036 \begin_inset Flex Noun
5039 \begin_layout Plain Layout
5047 and get the effect of
5048 \begin_inset Flex Code
5051 \begin_layout Plain Layout
5070 in this case cancels the last dead key, so if you press
5071 \begin_inset Flex Noun
5074 \begin_layout Plain Layout
5083 \begin_inset Flex Code
5086 \begin_layout Plain Layout
5099 \begin_layout Subsection
5103 \begin_layout Standard
5105 \begin_inset Flex Code
5108 \begin_layout Plain Layout
5116 mapping is performed, a
5117 \begin_inset Flex Code
5120 \begin_layout Plain Layout
5130 file maps the strings that the symbols generate to characters in the current
5132 The \SpecialChar LyX
5133 distribution currently includes at least the
5134 \begin_inset Flex Code
5137 \begin_layout Plain Layout
5146 \begin_inset Flex Code
5149 \begin_layout Plain Layout
5160 \begin_layout Standard
5162 \begin_inset Flex Code
5165 \begin_layout Plain Layout
5173 file is a sequence of declarations of the form
5176 \begin_layout LyX-Code
5189 \begin_layout Standard
5190 For example, in order to map
5191 \begin_inset Flex Noun
5194 \begin_layout Plain Layout
5204 to the corresponding character in the iso-8859-1 set (233), the following
5208 \begin_layout LyX-Code
5216 \begin_layout Standard
5218 \begin_inset Flex Code
5221 \begin_layout Plain Layout
5230 \begin_inset Flex Code
5233 \begin_layout Plain Layout
5251 the same character can apply to more than one string.
5253 \begin_inset Flex Code
5256 \begin_layout Plain Layout
5267 \begin_layout LyX-Code
5279 \begin_inset Newline newline
5295 \begin_layout Standard
5297 cannot find a mapping for the string produced by the keystroke or a
5298 deadkey sequence, it will check if it looks like an accented char and try
5299 to draw an accent over the character on screen.
5302 \begin_layout Subsection
5306 \begin_layout Standard
5307 There is a second way to add support for international characters through
5308 so-called dead-keys.
5309 A dead-key works in combination with a letter to produce an accented character.
5310 Here, we'll explain how to create a really simple dead-key to illustrate
5314 \begin_layout Standard
5315 Suppose you happen to need the circumflex character,
5316 \begin_inset Quotes eld
5320 \begin_inset Quotes erd
5325 \begin_inset Flex Noun
5328 \begin_layout Plain Layout
5335 \begin_inset space ~
5339 \begin_inset Flex Noun
5342 \begin_layout Plain Layout
5348 ] to the \SpecialChar LyX
5350 \begin_inset Flex Code
5353 \begin_layout Plain Layout
5360 \begin_inset Flex Code
5363 \begin_layout Plain Layout
5370 Now, whenever you type the
5371 \begin_inset Flex Noun
5374 \begin_layout Plain Layout
5380 -key followed by a letter, that letter will have a circumflex accent on
5382 For example, the sequence
5383 \begin_inset Quotes eld
5387 \begin_inset Flex Noun
5390 \begin_layout Plain Layout
5397 \begin_inset Quotes erd
5400 produces the letter:
5401 \begin_inset Quotes eld
5405 \begin_inset Quotes erd
5409 If you tried to type
5410 \begin_inset Quotes eld
5414 \begin_inset Flex Noun
5417 \begin_layout Plain Layout
5424 \begin_inset Quotes erd
5427 , however, \SpecialChar LyX
5428 will complain with a beep, since a
5429 \begin_inset Quotes eld
5433 \begin_inset Flex Noun
5436 \begin_layout Plain Layout
5443 \begin_inset Quotes erd
5446 never takes a circumflex accent.
5448 \begin_inset Flex Noun
5451 \begin_layout Plain Layout
5457 after a dead-key produces the bare-accent.
5458 Please note this last point! If you bind a key to a dead-key, you'll need
5459 to rebind the character on that key to yet another key.
5461 \begin_inset Flex Noun
5464 \begin_layout Plain Layout
5470 to a cedilla is a bad idea, since you'll only get cedillas instead of commas.
5473 \begin_layout Standard
5474 One common way to bind dead-keys is to use
5475 \begin_inset Flex Noun
5478 \begin_layout Plain Layout
5485 \begin_inset Flex Noun
5488 \begin_layout Plain Layout
5495 \begin_inset Flex Noun
5498 \begin_layout Plain Layout
5504 in combination with an accent, like
5505 \begin_inset Quotes eld
5509 \begin_inset Flex Noun
5512 \begin_layout Plain Layout
5519 \begin_inset Quotes erd
5523 \begin_inset Quotes eld
5527 \begin_inset Flex Noun
5530 \begin_layout Plain Layout
5537 \begin_inset Quotes erd
5541 \begin_inset Quotes eld
5545 \begin_inset Flex Noun
5548 \begin_layout Plain Layout
5555 \begin_inset Quotes erd
5559 Another way involves using
5560 \begin_inset Flex Code
5563 \begin_layout Plain Layout
5570 \begin_inset Flex Code
5573 \begin_layout Plain Layout
5579 to set up the special
5580 \begin_inset Flex Code
5583 \begin_layout Plain Layout
5591 \begin_inset Flex Code
5594 \begin_layout Plain Layout
5600 acts in some ways just like
5601 \begin_inset Flex Noun
5604 \begin_layout Plain Layout
5610 and permits you to bind keys to accented characters.
5611 You can also turn keys into dead-keys by binding them to something like
5613 \begin_inset Flex Code
5616 \begin_layout Plain Layout
5622 and then binding this symbolic key to the corresponding \SpecialChar LyX
5627 \begin_layout Plain Layout
5632 : This is exactly what I do in my
5633 \begin_inset Flex Code
5636 \begin_layout Plain Layout
5643 \begin_inset Flex Code
5646 \begin_layout Plain Layout
5654 \begin_inset Flex Noun
5657 \begin_layout Plain Layout
5659 \begin_inset space ~
5668 \begin_inset Flex Code
5671 \begin_layout Plain Layout
5677 and a bunch of these
5678 \begin_inset Quotes eld
5682 \begin_inset Flex Code
5685 \begin_layout Plain Layout
5692 \begin_inset Quotes erd
5695 symbolic keys bound such things as
5696 \begin_inset Flex Noun
5699 \begin_layout Plain Layout
5701 \begin_inset space ~
5710 \begin_inset Flex Noun
5713 \begin_layout Plain Layout
5715 \begin_inset space ~
5724 This is how I produce my accented characters.
5729 You can make just about anything into the
5730 \begin_inset Flex Code
5733 \begin_layout Plain Layout
5740 \begin_inset Flex Noun
5743 \begin_layout Plain Layout
5749 keys, a spare function key, etc.
5750 As for the \SpecialChar LyX
5751 commands that produce accents, check the entry for
5752 \begin_inset Flex Code
5755 \begin_layout Plain Layout
5766 You'll find the complete list there.
5769 \begin_layout Subsection
5770 Saving your Language Configuration
5773 \begin_layout Standard
5774 You can edit your preferences so that your desired language environment
5775 is automatically configured when \SpecialChar LyX
5777 \begin_inset Flex Noun
5780 \begin_layout Plain Layout
5781 Edit\SpecialChar menuseparator
5790 \begin_layout Chapter
5791 Installing New Document Classes, Layouts, and Templates
5792 \begin_inset CommandInset label
5794 name "cha:Installing-New-Document"
5799 \begin_inset Argument 1
5802 \begin_layout Plain Layout
5803 Installing New Document Classes
5811 \begin_layout Standard
5812 In this chapter, we describe the procedures for creating and installing
5813 new \SpecialChar LyX
5814 layout and template files, as well as offer a refresher on correctly
5815 installing new \SpecialChar LaTeX
5820 \begin_layout Standard
5821 First, let us a say a few words about how one ought to think about the relation
5822 between \SpecialChar LyX
5823 and \SpecialChar LaTeX
5825 The thing to understand is that, in a certain sense, \SpecialChar LyX
5826 doesn't know anything
5827 about \SpecialChar LaTeX
5829 Indeed, from \SpecialChar LyX
5830 's point of view, \SpecialChar LaTeX
5831 is just one of several
5832 \begin_inset Quotes eld
5836 \begin_inset Quotes erd
5839 in which it is capable of producing output.
5840 Other such formats are DocBook, plaintext, and XHTML.
5842 is, of course, a particularly important format, but very little of the
5843 information \SpecialChar LyX
5844 has about \SpecialChar LaTeX
5845 is actually contained in the program itself.
5849 \begin_layout Plain Layout
5850 Some commands are sufficiently complex that they are
5851 \begin_inset Quotes eld
5855 \begin_inset Quotes erd
5858 into \SpecialChar LyX
5860 But the developers generally regard this as a Bad Thing.
5865 Rather, that information, even for the standard classes like
5866 \begin_inset Flex Code
5869 \begin_layout Plain Layout
5875 , is contained in `layout files'.
5876 Similarly, \SpecialChar LyX
5877 itself does not know much about DocBook or XHTML.
5878 What it knows is contained in layout files.
5881 \begin_layout Standard
5882 You can think of the layout file for a given document class as a translation
5883 manual between \SpecialChar LyX
5884 constructs—paragraphs with their corresponding styles,
5885 certain sorts of insets, etc—and the corresponding \SpecialChar LaTeX
5888 Almost everything \SpecialChar LyX
5890 \begin_inset Flex Code
5893 \begin_layout Plain Layout
5899 , for example, is contained in the file
5900 \begin_inset Flex Code
5903 \begin_layout Plain Layout
5909 and in various other files it includes.
5910 For this reason, anyone intending to write layout files should plan to
5911 study the existing files.
5912 A good place to start is with
5913 \begin_inset Flex Code
5916 \begin_layout Plain Layout
5922 , which is included in
5923 \begin_inset Flex Code
5926 \begin_layout Plain Layout
5933 \begin_inset Flex Code
5936 \begin_layout Plain Layout
5942 , and many of the other layout files for document classes.
5943 This file is where sections and the like are defined:
5944 \begin_inset Flex Code
5947 \begin_layout Plain Layout
5953 tells \SpecialChar LyX
5954 how paragraphs that are marked with the Section, Subsection, etc,
5955 styles can be translated into corresponding \SpecialChar LaTeX
5956 , DocBook, and XHTML commands
5959 \begin_inset Flex Code
5962 \begin_layout Plain Layout
5968 file basically just includes several of these
5969 \begin_inset Flex Code
5972 \begin_layout Plain Layout
5981 \begin_layout Standard
5982 Defining the \SpecialChar LyX
5984 correspondence is not the only thing layout files do, though.
5985 Their other job is to define how the \SpecialChar LyX
5986 constructs themselves will appear
5988 The fact that layout files have these two jobs is often a source of confusion,
5989 because they are completely separate.
5990 Telling \SpecialChar LyX
5991 how to translate a certain paragraph style into \SpecialChar LaTeX
5994 how to display it; conversely, telling \SpecialChar LyX
5995 how to display a certain paragraph
5996 style does not tell \SpecialChar LyX
5997 how to translate it into \SpecialChar LaTeX
5998 (let alone tell \SpecialChar LaTeX
6001 So, in general, when you define a new \SpecialChar LyX
6002 construct, you must always do two
6003 quite separate things: (i)
6004 \begin_inset space ~
6007 tell \SpecialChar LyX
6008 how to translate it into \SpecialChar LaTeX
6010 \begin_inset space ~
6013 tell \SpecialChar LyX
6017 \begin_layout Standard
6018 Much the same is true, of course, as regards \SpecialChar LyX
6019 's other backend formats, though
6020 XHTML is in some ways different, because in that case \SpecialChar LyX
6025 able, to some extent, to use information about how it should display a
6026 paragraph on the screen to output information (in the form of CSS) about
6027 how the paragraph should be displayed in a browser.
6028 Even in this case, however, the distinction between what \SpecialChar LyX
6030 and how things are rendered externally remains in force, and the two can
6031 be controlled separately.
6033 \begin_inset CommandInset ref
6035 reference "sec:Tags-for-XHTML"
6042 \begin_layout Section
6043 Installing new \SpecialChar LaTeX
6047 \begin_layout Standard
6048 Some installations may not include a \SpecialChar LaTeX
6049 package or class file that you would
6050 like to use within \SpecialChar LyX
6052 For example, you might need Foil\SpecialChar TeX
6053 , a package for preparing slides for overhead
6055 Modern \SpecialChar LaTeX
6056 distributions like \SpecialChar TeX
6057 Live (2008 or newer) or MiK\SpecialChar TeX
6058 provide a user interface
6059 for installing such packages.
6060 For example, with MiK\SpecialChar TeX
6061 , you start the program
6062 \begin_inset Quotes eld
6066 \begin_inset space ~
6070 \begin_inset Quotes erd
6073 to get a list of available packages.
6074 To install one of them, right click on it or use the corresponding toolbar
6078 \begin_layout Standard
6079 If your \SpecialChar LaTeX
6080 distribution does not provide such a `package manager', or if the
6081 package is not available from your distribution, then follow these steps
6082 to install it manually:
6085 \begin_layout Enumerate
6086 Get the package from
6087 \begin_inset CommandInset href
6090 target "http://www.ctan.org/"
6098 \begin_layout Enumerate
6099 If the package contains a file with the ending
6100 \begin_inset Quotes eld
6104 \begin_inset Flex Code
6107 \begin_layout Plain Layout
6114 \begin_inset Quotes erd
6117 (is the case for Foil\SpecialChar TeX
6118 ) then open a console, change to the folder of this
6119 file and execute the command
6120 \begin_inset Flex Code
6123 \begin_layout Plain Layout
6130 You have now unpacked the package and have all files to install it.
6131 Most \SpecialChar LaTeX
6132 -packages are not packed and you can skip this step.
6135 \begin_layout Enumerate
6136 Now you need to decide if the package should be available for all users
6141 \begin_layout Enumerate
6142 On *nix systems (Linux, OSX, etc.), if you want the new package to be available
6143 for all users on your system, then install it in your `local' \SpecialChar TeX
6145 install it in your own `user' \SpecialChar TeX
6147 Where these trees should be created, if they do not already exist, depends
6149 To find this out, look in the file
6150 \begin_inset Flex Code
6153 \begin_layout Plain Layout
6163 \begin_layout Plain Layout
6164 This is usually in the directory
6165 \begin_inset Flex Code
6168 \begin_layout Plain Layout
6174 , though you can execute the command
6175 \begin_inset Flex Code
6178 \begin_layout Plain Layout
6189 The location of the `local' \SpecialChar TeX
6190 tree is defined by the
6191 \begin_inset Flex Code
6194 \begin_layout Plain Layout
6200 variable; this is usually somewhere like
6201 \begin_inset Flex Code
6204 \begin_layout Plain Layout
6205 /usr/local/share/texmf
6210 or /usr/local/texlive/XXXX where XXXX is the year of the installed \SpecialChar TeX
6213 The location of the `user' \SpecialChar TeX
6215 \begin_inset Flex Code
6218 \begin_layout Plain Layout
6225 \begin_inset Flex Code
6228 \begin_layout Plain Layout
6235 \begin_inset Flex Code
6238 \begin_layout Plain Layout
6248 (If these variables are not predefined, you have to define them.) You'll
6249 probably need root permissions to create or modify the `local' tree, but
6250 not for your `user' tree.
6251 \begin_inset Newline newline
6254 In general, it is recommended to install in the user tree because your user
6255 will not be modified or even overwritten when you upgrade your system.
6256 It will typically also be backed up together with everything else when
6257 you backup your home directory (which, of course, you do on a regular basis).
6260 \begin_layout Enumerate
6261 On Windows, if you want the new package to be available for all users on
6262 your system, change to the folder where \SpecialChar LaTeX
6263 is installed and then change to
6265 \begin_inset Flex Code
6268 \begin_layout Plain Layout
6279 (For MiK\SpecialChar TeX
6280 , this would be by default the folder
6281 \begin_inset Flex Code
6284 \begin_layout Plain Layout
6302 \begin_layout Plain Layout
6303 Note that this will be the correct path only on English installations.
6304 On a German one, it would be
6305 \begin_inset Flex Code
6308 \begin_layout Plain Layout
6322 , and similarly for other languages.
6327 Create there a new folder
6328 \begin_inset Flex Code
6331 \begin_layout Plain Layout
6337 and copy all files of the package into it.
6339 \begin_inset Newline newline
6342 If the package should only available for you or you don't have admin permissions
6343 , do the same, but in the local \SpecialChar LaTeX
6346 \begin_inset space \thinspace{}
6349 g., for MiK\SpecialChar TeX
6351 \begin_inset space ~
6354 2.8 under Windows XP, this would be the folder:
6355 \begin_inset Newline newline
6361 \begin_inset Flex Code
6364 \begin_layout Plain Layout
6367 Documents and Settings
6379 \begin_inset Newline newline
6385 \begin_inset Phantom HPhantom
6388 \begin_layout Plain Layout
6399 \begin_inset Flex Code
6402 \begin_layout Plain Layout
6415 \begin_inset Newline newline
6418 On Vista, it would be:
6419 \begin_inset Newline newline
6423 \begin_inset Flex Code
6426 \begin_layout Plain Layout
6452 \begin_layout Enumerate
6453 Now one only need to tell \SpecialChar LaTeX
6454 that there are new files.
6455 This depends on the used \SpecialChar LaTeX
6460 \begin_layout Enumerate
6461 For \SpecialChar TeX
6462 Live execute the command
6463 \begin_inset Flex Code
6466 \begin_layout Plain Layout
6473 If you installed the package for all users, then you will probably need
6474 to have root permissions for that.
6477 \begin_layout Enumerate
6478 For MiK\SpecialChar TeX
6479 , if you have installed the package for all users, start the program
6481 \begin_inset Quotes eld
6485 \begin_inset space ~
6489 \begin_inset Quotes erd
6492 and press the button marked
6493 \begin_inset Quotes eld
6497 \begin_inset Quotes erd
6501 Otherwise start the program
6502 \begin_inset Quotes eld
6506 \begin_inset Quotes erd
6513 \begin_layout Enumerate
6514 Finally, you need to tell \SpecialChar LyX
6515 that there are new packages available.
6516 So, in \SpecialChar LyX
6518 \begin_inset Flex Noun
6521 \begin_layout Plain Layout
6524 \SpecialChar menuseparator
6530 and then restart \SpecialChar LyX
6534 \begin_layout Standard
6535 Now the package is installed.
6536 In our example, the document class
6537 \begin_inset Flex Code
6540 \begin_layout Plain Layout
6542 \begin_inset space ~
6550 will now be available under
6551 \begin_inset Flex Noun
6554 \begin_layout Plain Layout
6555 Document\SpecialChar menuseparator
6556 Settings\SpecialChar menuseparator
6566 \begin_layout Standard
6567 If you would like to use a \SpecialChar LaTeX
6568 document class that is not even listed in the
6570 \begin_inset Flex Noun
6573 \begin_layout Plain Layout
6574 Document\SpecialChar menuseparator
6575 Settings\SpecialChar menuseparator
6581 , then you need to create a `layout' file for it.
6582 That is the topic of the next section.
6585 \begin_layout Section
6586 Types of layout files
6589 \begin_layout Standard
6590 This section describes the various sorts of \SpecialChar LyX
6591 files that contain layout informati
6593 These files describe various paragraph and character styles, determining
6594 how \SpecialChar LyX
6595 should display them and how they should be translated into \SpecialChar LaTeX
6597 XHTML, or whatever output format is being used.
6601 \begin_layout Standard
6602 We shall try to provide a thorough description of the process of writing
6604 However, there are so many different types of documents supported even
6605 by just \SpecialChar LaTeX
6606 that we can't hope to cover every different possibility or problem
6607 you might encounter.
6608 The \SpecialChar LyX
6609 users' list is frequented by people with lots of experience with layout
6610 design who are willing to share what they've learned, so please feel free
6611 to ask questions there.
6614 \begin_layout Standard
6615 As you prepare to write a new layout, it is extremely helpful to look at
6616 the layouts distributed with \SpecialChar LyX
6618 If you write a \SpecialChar LyX
6619 layout for a \SpecialChar LaTeX
6620 document class that might also be used by
6621 others, or write a module that might be useful to others, then you should
6622 consider posting your layout to the
6623 \begin_inset CommandInset href
6625 name "layout section on the LyX wiki"
6626 target "http://wiki.lyx.org/Layouts/Layouts"
6631 or even to the \SpecialChar LyX
6632 developers' list, so that it might be included in \SpecialChar LyX
6637 \begin_layout Plain Layout
6638 Note that \SpecialChar LyX
6639 is licensed under the General Public License, so any material
6640 that is contributed to \SpecialChar LyX
6641 must be similarly licensed.
6649 \begin_layout Subsection
6651 \begin_inset CommandInset label
6653 name "subsec:Layout-modules"
6660 \begin_layout Standard
6661 We have spoken to this point about `layout files'.
6662 But there are different sorts of files that contain layout information.
6663 Layout files, strictly so called, have the
6664 \begin_inset Flex Code
6667 \begin_layout Plain Layout
6673 extension and provide \SpecialChar LyX
6674 with information about document classes.
6675 Since \SpecialChar LyX
6676 1.6 layout information can also be contained in layout
6681 \begin_inset Flex Code
6684 \begin_layout Plain Layout
6691 Modules are to \SpecialChar LaTeX
6692 packages much as layouts are to \SpecialChar LaTeX
6693 classes, and some modules—such
6695 \begin_inset Flex Code
6698 \begin_layout Plain Layout
6704 module—specifically provide support for one package.
6705 In a sense, layout modules are similar to included
6709 \begin_layout Plain Layout
6710 These can have any extension, but by convention have the
6711 \begin_inset Flex Code
6714 \begin_layout Plain Layout
6726 \begin_inset Flex Code
6729 \begin_layout Plain Layout
6735 —in that modules are not specific to a given document class but may be used
6736 with many different classes.
6737 The difference is that using an included file with
6738 \begin_inset Flex Code
6741 \begin_layout Plain Layout
6747 requires editing that file.
6748 Modules, by contrast, are selected in the
6749 \begin_inset Flex Noun
6752 \begin_layout Plain Layout
6753 Document\SpecialChar menuseparator
6762 \begin_layout Standard
6763 Building modules is the easiest way to get started with layout editing,
6764 since it can be as simple as adding a single new paragraph style or flex
6766 But modules may, in principle, contain anything a layout file can contain.
6769 \begin_layout Standard
6770 After creating a new module and copying it to the
6771 \begin_inset Flex Code
6774 \begin_layout Plain Layout
6780 folder, you will need to reconfigure and then restart \SpecialChar LyX
6783 However, changes you make to the module will be seen immediately, if you
6785 \begin_inset Flex Noun
6788 \begin_layout Plain Layout
6789 Document\SpecialChar menuseparator
6795 , highlight something, and then hit
6796 \begin_inset Quotes eld
6800 \begin_inset Quotes erd
6806 It is strongly recommended that you save your work before doing this
6811 it is strongly recommended that you not attempt to edit modules while simultaneo
6812 usly working on actual documents
6815 Though of course the developers strive to keep \SpecialChar LyX
6816 stable in such situations,
6817 syntax errors and the like in your module file could cause strange behavior.
6820 \begin_layout Subsubsection
6824 \begin_layout Standard
6825 Modules are to \SpecialChar LyX
6826 as packages are to \SpecialChar LaTeX
6828 Sometimes, however, you find yourself wanting a specific inset or character
6829 style just for one document and writing a module that will also be available
6830 to other documents makes little sense.
6831 What you need is \SpecialChar LyX
6833 \begin_inset Quotes eld
6837 \begin_inset Quotes erd
6843 \begin_layout Standard
6844 You will find it under
6846 Document\SpecialChar menuseparator
6847 Settings\SpecialChar menuseparator
6851 The large text box allows you to enter anything that you might enter in
6852 a layout file or module.
6853 You can think of a document's local layout, in fact, as a module that belongs
6855 So, in particular, you must enter a
6856 \begin_inset Flex Code
6859 \begin_layout Plain Layout
6866 Any format is acceptable, but one would normally use the format current
6868 (In \SpecialChar LyX
6869 2.2, the current layout format is 60.)
6872 \begin_layout Standard
6873 When you have entered something in the
6874 \begin_inset Flex Code
6877 \begin_layout Plain Layout
6883 pane, \SpecialChar LyX
6885 \begin_inset Quotes eld
6889 \begin_inset Quotes erd
6892 button at the bottom.
6893 Clicking this button will cause \SpecialChar LyX
6894 to determine whether what you have entered
6895 is valid layout information for the chosen format.
6897 will report the result but, unfortunately, will not tell you what errors
6898 there might have been.
6899 These will be written to the terminal, however, if \SpecialChar LyX
6900 is started from a terminal.
6901 You will not be permitted to save your local layout until you have entered
6905 \begin_layout Standard
6906 The warnings at the end of the previous section apply here, too.
6907 Do not play with local layout while you are actually working, especially
6908 if you have not saved your document.
6909 That said, using local layout with a test document can be a very convenient
6910 way to try out layout ideas, or even to start developing a module.
6913 \begin_layout Subsection
6915 \begin_inset Flex Noun
6918 \begin_layout Plain Layout
6927 \begin_layout Standard
6928 There are two situations you are likely to encounter when wanting to support
6929 a new \SpecialChar LaTeX
6930 document class, involving style (
6931 \begin_inset Flex Code
6934 \begin_layout Plain Layout
6940 ) files and \SpecialChar LaTeX2e
6942 \begin_inset Flex Code
6945 \begin_layout Plain Layout
6952 Supporting a style file is usually fairly easy.
6953 Supporting a new class file is a bit harder.
6954 We'll discuss the former in this section and the latter in the next.
6955 Similar remarks apply, of course, if you want to support a new DocBook
6959 \begin_layout Standard
6960 The easier case is the one in which your new document class is provided
6961 as a style file that is to be used in conjunction with an already supported
6963 For the sake of the example, we'll assume that the style file is called
6965 \begin_inset Flex Noun
6968 \begin_layout Plain Layout
6974 and that it is meant to be used with
6975 \begin_inset Flex Noun
6978 \begin_layout Plain Layout
6984 , which is a standard class.
6988 \begin_layout Standard
6989 Start by copying the existing class's layout file into your local directory:
6993 \begin_layout Plain Layout
6994 Of course, which directory is your local directory will vary by platform,
6995 and \SpecialChar LyX
6996 allows you to specify your local directory on startup, too, using
6998 \begin_inset Flex Code
7001 \begin_layout Plain Layout
7015 \begin_layout LyX-Code
7016 cp report.layout ~/.lyx/layouts/myclass.layout
7019 \begin_layout Standard
7021 \begin_inset Flex Code
7024 \begin_layout Plain Layout
7030 and change the line:
7033 \begin_layout LyX-Code
7036 DeclareLaTeXClass{report}
7039 \begin_layout Standard
7043 \begin_layout LyX-Code
7046 DeclareLaTeXClass[report, myclass.sty]{report (myclass)}
7049 \begin_layout Standard
7053 \begin_layout LyX-Code
7055 \begin_inset Newline newline
7061 \begin_inset Newline newline
7067 \begin_layout Standard
7068 near the top of the file.
7071 \begin_layout Standard
7072 Start \SpecialChar LyX
7074 \begin_inset Flex Noun
7077 \begin_layout Plain Layout
7078 Tools\SpecialChar menuseparator
7085 Then restart \SpecialChar LyX
7086 and try creating a new document.
7088 \begin_inset Flex Noun
7091 \begin_layout Plain Layout
7097 " as a document class option in the
7098 \begin_inset Flex Noun
7101 \begin_layout Plain Layout
7102 Document\SpecialChar menuseparator
7109 It is likely that some of the sectioning commands and such in your new
7110 class will work differently from how they worked in the base class—
7111 \begin_inset Flex Code
7114 \begin_layout Plain Layout
7120 in this example—so you can fiddle around with the settings for the different
7121 sections if you wish.
7122 The layout information for sections is contained in
7123 \begin_inset Flex Code
7126 \begin_layout Plain Layout
7132 , but you do not need to copy and change this file.
7133 Instead, you can simply add your changes to your layout file, after the
7135 \begin_inset Flex Code
7138 \begin_layout Plain Layout
7144 , which itself includes
7145 \begin_inset Flex Code
7148 \begin_layout Plain Layout
7155 For example, you might add these lines:
7158 \begin_layout LyX-Code
7162 \begin_layout LyX-Code
7166 \begin_layout LyX-Code
7170 \begin_layout LyX-Code
7174 \begin_layout LyX-Code
7178 \begin_layout Standard
7179 to change the font for chapter headings to sans-serif.
7180 This will override (or, in this case, add to) the existing declaration
7181 for the Chapter style.
7185 \begin_layout Standard
7186 Your new package may also provide commands or environments not present in
7188 In this case, you will want to add these to the layout file.
7190 \begin_inset CommandInset ref
7192 reference "sec:TextClass"
7196 for information on how to do so.
7199 \begin_layout Standard
7201 \begin_inset Flex Noun
7204 \begin_layout Plain Layout
7210 can be used with several different document classes, and even if it cannot,
7211 you might find it easiest just to write a module that you can load with
7213 The simplest possible such module would be:
7216 \begin_layout LyX-Code
7219 DeclareLyXModule{My Package}
7222 \begin_layout LyX-Code
7226 \begin_layout LyX-Code
7227 #Support for mypkg.sty.
7230 \begin_layout LyX-Code
7232 \begin_inset Newline newline
7238 \begin_layout LyX-Code
7240 \begin_inset Newline newline
7246 \begin_layout LyX-Code
7248 \begin_inset Newline newline
7254 \begin_inset Newline newline
7260 \begin_layout Standard
7261 A more complex module might modify the behavior of some existing constructs
7262 or define some new ones.
7264 \begin_inset CommandInset ref
7266 reference "sec:TextClass"
7273 \begin_layout Subsection
7275 \begin_inset Flex Noun
7278 \begin_layout Plain Layout
7287 \begin_layout Standard
7288 There are two possibilities here.
7289 One is that the class file is itself based upon an existing document class.
7290 For example, many thesis classes are based upon
7291 \begin_inset Flex Noun
7294 \begin_layout Plain Layout
7301 To see whether yours is, look for a line like
7304 \begin_layout LyX-Code
7310 \begin_layout Standard
7312 If so, then you may proceed largely as in the previous section, though
7314 \begin_inset Flex Code
7317 \begin_layout Plain Layout
7318 Declare\SpecialChar LaTeX
7324 line will be different.
7325 If your new class is
7326 \begin_inset Flex Code
7329 \begin_layout Plain Layout
7335 and it is based upon
7336 \begin_inset Flex Code
7339 \begin_layout Plain Layout
7345 , then the line should read:
7349 \begin_layout Plain Layout
7350 And it will be easiest if you save the file to
7351 \begin_inset Flex Code
7354 \begin_layout Plain Layout
7361 assumes that the document class has the same name as the layout file.
7370 \begin_layout LyX-Code
7373 DeclareLaTeXClass[thesis,book]{thesis}
7376 \begin_layout Standard
7377 If, on the other hand, the new class is not based upon an existing class,
7378 you will probably have to
7379 \begin_inset Quotes eld
7383 \begin_inset Quotes erd
7387 We strongly suggest copying an existing layout file which uses a similar
7389 class and then modifying it, if you can do so.
7390 At least use an existing file as a starting point so you can find out what
7391 items you need to worry about.
7392 Again, the specifics are covered below.
7395 \begin_layout Subsection
7397 \begin_inset CommandInset label
7399 name "subsec:Creating-Templates"
7406 \begin_layout Standard
7407 Once you have written a layout file for a new document class, you might
7408 want to consider writing a
7413 A template acts as a kind of tutorial for your layout, showing how it might
7414 be used, though containing dummy content.
7415 You can of course look at the various templates included with \SpecialChar LyX
7419 \begin_layout Standard
7420 Templates are created just like usual documents: using \SpecialChar LyX
7422 The only difference is that usual documents contain all possible settings,
7423 including the font scheme and the paper size.
7424 Usually a user doesn't want a template to overwrite his preferred settings
7425 for such parameters.
7426 For that reason, the designer of a template should remove the corresponding
7428 \begin_inset Flex Code
7431 \begin_layout Plain Layout
7440 \begin_inset Flex Code
7443 \begin_layout Plain Layout
7451 from the template \SpecialChar LyX
7453 This can be done with any simple text-editor, for example
7454 \begin_inset Flex Code
7457 \begin_layout Plain Layout
7464 \begin_inset Flex Code
7467 \begin_layout Plain Layout
7476 \begin_layout Standard
7477 Put the edited template files you create in
7478 \begin_inset Flex Code
7481 \begin_layout Plain Layout
7487 , copy the ones you use from the global template directory in
7488 \begin_inset Flex Code
7491 \begin_layout Plain Layout
7497 to the same place, and redefine the template path in the
7498 \begin_inset Flex Noun
7501 \begin_layout Plain Layout
7502 Tools\SpecialChar menuseparator
7503 Preferences\SpecialChar menuseparator
7512 \begin_layout Standard
7513 Note, by the way, that there is a template which has a particular meaning:
7515 \begin_inset Flex Code
7518 \begin_layout Plain Layout
7525 This template is loaded every time you create a new document with
7526 \begin_inset Flex Noun
7529 \begin_layout Plain Layout
7530 File\SpecialChar menuseparator
7536 in order to provide useful defaults.
7537 To create this template from inside \SpecialChar LyX
7538 , all you have to do is to open a document
7539 with the correct settings, and use the
7540 \begin_inset Flex Noun
7543 \begin_layout Plain Layout
7544 Save as Document Defaults
7552 \begin_layout Subsection
7553 Upgrading old layout files
7556 \begin_layout Standard
7557 The format of layout files changes with each \SpecialChar LyX
7558 release, so old layout files
7559 need to be converted to the new format.
7561 reads a layout file in an older format, it automatically calls the
7563 \begin_inset Flex Code
7566 \begin_layout Plain Layout
7572 to convert it to a temporary file in current format.
7573 The original file is left untouched.
7574 If you use the layout file often, then, you may want to convert it permanently,
7575 so that \SpecialChar LyX
7576 does not have to do so itself every time.
7577 To do this, you can call the converter manually:
7580 \begin_layout Enumerate
7582 \begin_inset Flex Code
7585 \begin_layout Plain Layout
7592 \begin_inset Flex Code
7595 \begin_layout Plain Layout
7604 \begin_layout Enumerate
7606 \begin_inset Newline newline
7610 \begin_inset Flex Code
7613 \begin_layout Plain Layout
7614 python LyXDir/scripts/layout2layout.py myclass.old myclass.layout
7620 \begin_inset Newline newline
7624 \begin_inset Flex Code
7627 \begin_layout Plain Layout
7633 is the name of your \SpecialChar LyX
7637 \begin_layout Standard
7638 Note that manual conversion does not affect included files, so these will
7639 have to be converted separately.
7640 \change_inserted -712698321 1483873435
7644 \begin_layout Subsection
7646 \change_inserted -712698321 1483875083
7647 \begin_inset CommandInset label
7649 name "subsec:Cite-Engine-Files"
7656 \begin_layout Standard
7658 \change_inserted -712698321 1483874213
7659 A specific form of layout files are the so-called
7660 \begin_inset Flex Code
7663 \begin_layout Plain Layout
7665 \change_inserted -712698321 1483873546
7671 files that are located in the
7672 \begin_inset Flex Code
7675 \begin_layout Plain Layout
7677 \change_inserted -712698321 1483873546
7684 Their purpose is to define the specifics of \SpecialChar LaTeX
7685 packages aimed at bibliography
7698 , but also the way how normal Bib\SpecialChar TeX
7699 citations (without additional packages)
7700 are handled in \SpecialChar LyX
7701 is defined in such a file.
7705 \begin_layout Standard
7707 \change_inserted -712698321 1483874969
7708 More specifically, it is defined which packages \SpecialChar LyX
7709 needs to load, which citation
7710 commands are available, how these are to be displayed in \SpecialChar LyX
7712 the dialogs, the context menus) as well as in the XHTML and plain text
7714 Furthermore, the files specify available style variants (author-year, numerical
7715 , etc.) and their specifics.
7716 The cite engine files are also used to generate the options that are available
7719 Document\SpecialChar menuseparator
7720 Settings\SpecialChar ldots
7721 \SpecialChar menuseparator
7722 Bibliography\SpecialChar menuseparator
7728 \begin_layout Standard
7730 \change_inserted -712698321 1483875180
7731 Even though a cite engine file is essentially a normal layout file that
7732 could theoretically include any layout information, it usually primarily
7733 includes some specific parameters such as
7734 \begin_inset Flex Code
7737 \begin_layout Plain Layout
7739 \change_inserted -712698321 1483874688
7748 \begin_inset Flex Code
7751 \begin_layout Plain Layout
7753 \change_inserted -712698321 1483875180
7762 \begin_inset Flex Code
7765 \begin_layout Plain Layout
7767 \change_inserted -712698321 1483874477
7776 \begin_inset Flex Code
7779 \begin_layout Plain Layout
7781 \change_inserted -712698321 1483874482
7790 The syntax of the latter two is described in
7791 \begin_inset CommandInset ref
7793 reference "subsec:Citation-engine-description"
7801 \begin_inset CommandInset ref
7803 reference "subsec:Citation-format-description"
7807 , as well as in the files themselves.
7812 \begin_layout Section
7813 \begin_inset CommandInset label
7815 name "sec:TextClass"
7819 The layout file format
7822 \begin_layout Standard
7823 The following sections describe how layout files are structured and written.
7824 Our advice is to go slowly, save and test often.
7825 It is really not that hard, except that the multitude of options can become
7826 overwhelming, especially if you try to check out too many at once.
7827 It becomes easier if you use existing layouts of \SpecialChar LyX
7828 as examples/reference
7829 or if you modify an existing layout to your needs.
7832 \begin_layout Standard
7833 Note that all the tags used in layout files are case-insensitive.
7835 \begin_inset Flex Code
7838 \begin_layout Plain Layout
7845 \begin_inset Flex Code
7848 \begin_layout Plain Layout
7855 \begin_inset Flex Code
7858 \begin_layout Plain Layout
7864 are really the same tag.
7865 The possible arguments are printed in brackets after the tag's name.
7866 The default argument is typeset
7867 \begin_inset Flex Code
7870 \begin_layout Plain Layout
7879 If the argument has a data type like
7880 \begin_inset Quotes eld
7884 \begin_inset Quotes erd
7888 \begin_inset Quotes eld
7892 \begin_inset Quotes erd
7895 , the default is shown like this:
7896 \begin_inset Flex Code
7899 \begin_layout Plain Layout
7910 \begin_layout Subsection
7911 The document class declaration and classification
7914 \begin_layout Standard
7915 Lines in a layout file which begin with
7916 \begin_inset Flex Code
7919 \begin_layout Plain Layout
7926 There is one exception to this rule.
7928 \begin_inset Flex Code
7931 \begin_layout Plain Layout
7937 files should begin with lines like:
7940 \begin_layout LyX-Code
7943 #% Do not delete the line below; configure depends on this
7946 \begin_layout LyX-Code
7951 DeclareLaTeXClass{Article (Standard Class)}
7954 \begin_layout LyX-Code
7959 DeclareCategory{Articles}
7962 \begin_layout Standard
7963 The second and third lines are used when you (re)configure \SpecialChar LyX
7965 The layout file is read by the \SpecialChar LaTeX
7967 \begin_inset Flex Code
7970 \begin_layout Plain Layout
7976 , in a special mode where
7977 \begin_inset Flex Code
7980 \begin_layout Plain Layout
7987 The first line is just a \SpecialChar LaTeX
7988 comment, the second one contains the mandatory
7989 declaration of the text class and the third line contains the optional
7990 classification of the class.
7991 If these lines appear in a file named
7992 \begin_inset Flex Code
7995 \begin_layout Plain Layout
8001 , then they define a text class of name
8002 \begin_inset Flex Code
8005 \begin_layout Plain Layout
8011 (the name of the layout file) which uses the \SpecialChar LaTeX
8013 \begin_inset Flex Code
8016 \begin_layout Plain Layout
8022 (the default is to use the same name as the layout).
8024 \begin_inset Quotes eld
8027 Article (Standard Class)
8028 \begin_inset Quotes erd
8031 that appears above is used as a description of the text class in the
8032 \begin_inset Flex Noun
8035 \begin_layout Plain Layout
8036 Document\SpecialChar menuseparator
8044 \begin_inset Quotes eld
8048 \begin_inset Quotes erd
8051 in the example) is also used in the
8052 \begin_inset Flex Noun
8055 \begin_layout Plain Layout
8056 Document\SpecialChar menuseparator
8062 dialog: the text classes are grouped by these categories (which are usually
8063 genres, so typical categories are
8064 \begin_inset Quotes eld
8068 \begin_inset Quotes erd
8072 \begin_inset Quotes eld
8076 \begin_inset Quotes erd
8080 \begin_inset Quotes eld
8084 \begin_inset Quotes erd
8088 \begin_inset Quotes eld
8092 \begin_inset Quotes erd
8096 \begin_inset Quotes eld
8100 \begin_inset Quotes erd
8104 \begin_inset Quotes eld
8108 \begin_inset Quotes erd
8112 If no category has been declared, the class will be put in the
8113 \begin_inset Quotes eld
8117 \begin_inset Quotes erd
8123 \begin_layout Standard
8124 Let's assume that you wrote your own text class that uses the
8125 \begin_inset Flex Code
8128 \begin_layout Plain Layout
8134 document class, but where you changed the appearance of the section headings.
8135 If you put it in a file
8136 \begin_inset Flex Code
8139 \begin_layout Plain Layout
8145 , the header of this file should be:
8148 \begin_layout LyX-Code
8151 #% Do not delete the line below; configure depends on this
8154 \begin_layout LyX-Code
8159 DeclareLaTeXClass[article]{Article (with My Own Headings)}
8162 \begin_layout LyX-Code
8167 DeclareCategory{Articles}
8170 \begin_layout Standard
8171 This declares a text class
8172 \begin_inset Flex Code
8175 \begin_layout Plain Layout
8181 , associated with the \SpecialChar LaTeX
8183 \begin_inset Flex Code
8186 \begin_layout Plain Layout
8193 \begin_inset Quotes eld
8196 Article (with My Own Headings)
8197 \begin_inset Quotes erd
8201 If your text class depends on several packages, you can declare it as:
8204 \begin_layout LyX-Code
8207 #% Do not delete the line below; configure depends on this
8210 \begin_layout LyX-Code
8215 DeclareLaTeXClass[article,foo.sty]{Article (with My Own Headings)}
8218 \begin_layout LyX-Code
8223 DeclareCategory{Articles}
8226 \begin_layout Standard
8227 This indicates that your text class uses the
8228 \begin_inset Flex Code
8231 \begin_layout Plain Layout
8238 Finally, it is also possible to declare classes for DocBook code.
8239 Typical declarations will look like:
8242 \begin_layout LyX-Code
8245 #% Do not delete the line below; configure depends on this
8248 \begin_layout LyX-Code
8253 DeclareDocBookClass[article]{SGML (DocBook Article)}
8256 \begin_layout LyX-Code
8261 DeclareCategory{Articles (DocBook)}
8264 \begin_layout Standard
8265 Note that these declarations can also be given an optional parameter declaring
8266 the name of the document class (but not a list).
8269 \begin_layout Standard
8270 So, to be as explicit as possible, the form of the layout declaration is:
8273 \begin_layout LyX-Code
8278 DeclareLaTeXClass[class,package.sty]{layout description}
8281 \begin_layout LyX-Code
8286 DeclareCategory{category}
8289 \begin_layout Standard
8290 The class need only be specified if the name of the \SpecialChar LaTeX
8292 name of the layout file are different or if there are packages to load.
8293 If the name of the class file is not specified, then \SpecialChar LyX
8295 that it is the same as the name of the layout file.
8298 \begin_layout Standard
8299 When the text class has been modified to your taste, all you have to do
8300 is to copy it either to
8301 \begin_inset Flex Code
8304 \begin_layout Plain Layout
8311 \begin_inset Flex Code
8314 \begin_layout Plain Layout
8321 \begin_inset Flex Noun
8324 \begin_layout Plain Layout
8325 Tools\SpecialChar menuseparator
8331 , exit \SpecialChar LyX
8333 Then your new text class should be available along with the others.
8336 \begin_layout Standard
8337 Once the layout file is installed, you can edit it and see your changes
8338 without having to reconfigure or to restart \SpecialChar LyX
8344 \begin_layout Plain Layout
8345 In versions of \SpecialChar LyX
8346 prior to 1.6, this was not true.
8347 As a result, editing layout files was very time consuming, since you had
8348 constantly to restart \SpecialChar LyX
8354 You can force a reload of the current layout by using the \SpecialChar LyX
8356 \begin_inset Flex Noun
8359 \begin_layout Plain Layout
8366 There is no default binding for this function—though, of course, you can
8367 bind it to a key yourself.
8368 But you will normally use this function simply by entering it in the mini-buffe
8373 \begin_layout Standard
8379 \begin_inset Flex Noun
8382 \begin_layout Plain Layout
8388 is very much an `advanced feature'.
8393 recommended that you save your work before using this function.
8398 recommended that you not attempt to edit layout information while simultaneousl
8399 y working on a document that you care about.
8400 Use a test document.
8401 Syntax errors and the like in your layout file could cause peculiar behavior.
8402 In particular, such errors could cause \SpecialChar LyX
8403 to regard the current layout as
8404 invalid and to attempt to switch to some other layout.
8408 \begin_layout Plain Layout
8409 Really bad syntax errors may even caused \SpecialChar LyX
8411 This is because certain sorts of errors may make \SpecialChar LyX
8422 The \SpecialChar LyX
8423 team strives to keep \SpecialChar LyX
8424 stable in such situations, but safe is better
8429 \begin_layout Plain Layout
8430 While we're giving advice: make regular backups.
8431 And be nice to your mother.
8439 \begin_layout Subsection
8440 The Module declaration
8443 \begin_layout Standard
8444 A module must begin with a line like the following:
8447 \begin_layout LyX-Code
8450 DeclareLyXModule[endnotes.sty]{Endnotes}
8453 \begin_layout Standard
8454 The mandatory argument, in curly brackets, is the name of the module, as
8456 \begin_inset Flex Noun
8459 \begin_layout Plain Layout
8460 Document\SpecialChar menuseparator
8461 Settings\SpecialChar menuseparator
8468 The argument in square brackets is optional: It declares any \SpecialChar LaTeX
8470 on which the module depends.
8471 It is also possible to use the form
8472 \begin_inset Flex Noun
8475 \begin_layout Plain Layout
8481 as an optional argument, which declares that the module can only be used
8482 when there exists a conversion chain between the formats `
8483 \begin_inset Flex Code
8486 \begin_layout Plain Layout
8493 \begin_inset Flex Code
8496 \begin_layout Plain Layout
8505 \begin_layout Standard
8506 The module declaration should then be followed by lines like the following
8510 \begin_layout Plain Layout
8511 Preferably in English if the module should be published with \SpecialChar LyX
8513 This description will appear in the list of messages to be translated and
8514 will be thus translated with the next interface update.
8522 \begin_layout LyX-Code
8526 \begin_layout LyX-Code
8527 #Adds an endnote command, in addition to footnotes.
8531 \begin_layout LyX-Code
8532 #You will need to add
8534 theendnotes in TeX code where you
8537 \begin_layout LyX-Code
8538 #want the endnotes to appear.
8542 \begin_layout LyX-Code
8546 \begin_layout LyX-Code
8547 #Requires: somemodule | othermodule
8550 \begin_layout LyX-Code
8551 #Excludes: badmodule
8554 \begin_layout Standard
8555 The description is used in
8556 \begin_inset Flex Noun
8559 \begin_layout Plain Layout
8560 Document\SpecialChar menuseparator
8561 Settings\SpecialChar menuseparator
8567 to provide the user with information about what the module does.
8569 \begin_inset Flex Code
8572 \begin_layout Plain Layout
8578 line is used to identify other modules with which this one must be used;
8580 \begin_inset Flex Code
8583 \begin_layout Plain Layout
8589 line is used to identify modules with which this one may not be used.
8590 Both are optional, and, as shown, multiple modules should be separated
8591 with the pipe symbol: |.
8592 Note that the required modules are treated disjunctively:
8596 of the required modules must be used.
8601 excluded module may be used.
8602 Note that modules are identified here by their filenames without the
8603 \begin_inset Flex Code
8606 \begin_layout Plain Layout
8614 \begin_inset Flex Code
8617 \begin_layout Plain Layout
8624 \begin_inset Flex Code
8627 \begin_layout Plain Layout
8634 \change_inserted -712698321 1483873000
8638 \begin_layout Subsection
8640 \change_inserted -712698321 1483873010
8641 The CiteEngine file declaration
8644 \begin_layout Standard
8646 \change_inserted -712698321 1483873022
8647 A cite engine file must begin with a line like the following:
8650 \begin_layout LyX-Code
8652 \change_inserted -712698321 1483873047
8655 DeclareLyXCiteEngineModule[biblatex.sty]{Biblatex}
8658 \begin_layout Standard
8660 \change_inserted -712698321 1483873077
8661 The mandatory argument, in curly brackets, is the name of the module, as
8663 \begin_inset Flex Noun
8666 \begin_layout Plain Layout
8668 \change_inserted -712698321 1483873068
8669 Document\SpecialChar menuseparator
8670 Settings\SpecialChar menuseparator
8677 The argument in square brackets is optional: It declares any \SpecialChar LaTeX
8679 on which the cite engine depends.
8682 \begin_layout Standard
8684 \change_inserted -712698321 1483873102
8685 The cite engine declaration should then be followed by lines like the following
8689 \begin_layout Plain Layout
8691 \change_inserted -712698321 1483873000
8692 Preferably in English if the module should be published with \SpecialChar LyX
8694 This description will appear in the list of messages to be translated and
8695 will be thus translated with the next interface update.
8703 \begin_layout LyX-Code
8705 \change_inserted -712698321 1483873128
8709 \begin_layout LyX-Code
8711 \change_inserted -712698321 1483873140
8712 # Biblatex supports many author-year and numerical styles.
8715 \begin_layout LyX-Code
8717 \change_inserted -712698321 1483873152
8718 # It is mainly aimed at the Humanities.
8722 \begin_layout LyX-Code
8724 \change_inserted -712698321 1483873160
8725 # customizable, fully localized and provides many features
8728 \begin_layout LyX-Code
8730 \change_inserted -712698321 1483873170
8731 # that are not possible with BibTeX.
8732 The use of 'biber' as
8735 \begin_layout LyX-Code
8737 \change_inserted -712698321 1483873174
8738 # bibliography processor is advised.
8741 \begin_layout LyX-Code
8743 \change_inserted -712698321 1483873224
8747 \begin_layout Standard
8749 \change_inserted -712698321 1483873207
8750 The description is used in
8751 \begin_inset Flex Noun
8754 \begin_layout Plain Layout
8756 \change_inserted -712698321 1483873194
8757 Document\SpecialChar menuseparator
8758 Settings\SpecialChar menuseparator
8764 to provide the user with information about the cite engine.
8769 \begin_layout Subsection
8773 \begin_layout Standard
8774 The first non-comment line of any layout file, included file, or module
8779 contain the file format number:
8782 \begin_layout Description
8783 \begin_inset Flex Code
8786 \begin_layout Plain Layout
8793 \begin_inset Flex Code
8796 \begin_layout Plain Layout
8802 ] The format number of the layout file.
8805 \begin_layout Standard
8806 This tag was introduced with \SpecialChar LyX
8808 \begin_inset space ~
8812 Layout files from older \SpecialChar LyX
8813 versions do not have an explicit file format and
8814 are considered to have
8815 \begin_inset Flex Code
8818 \begin_layout Plain Layout
8820 \begin_inset space ~
8829 The format for the present version of \SpecialChar LyX
8831 But each version of \SpecialChar LyX
8832 is capable of reading earlier versions' layout files,
8833 just as they are capable of reading files produced by earlier versions
8836 There is, however, no provision for converting to earlier formats.
8839 \begin_layout Subsection
8840 \begin_inset CommandInset label
8842 name "subsec:General-text-class"
8846 General text class parameters
8849 \begin_layout Standard
8850 These are general parameters that govern the behavior of an entire document
8856 mean that they must appear in
8857 \begin_inset Flex Code
8860 \begin_layout Plain Layout
8866 files rather than in modules.
8867 A module can contain any layout tag.)
8870 \begin_layout Description
8871 \begin_inset Flex Code
8874 \begin_layout Plain Layout
8880 Adds information that will be output in the
8881 \begin_inset Flex Code
8884 \begin_layout Plain Layout
8890 block when the document is output to XHTML.
8891 Typically, this would be used to output CSS style information, but it can
8892 be used for anything that can appear in
8893 \begin_inset Flex Code
8896 \begin_layout Plain Layout
8904 \begin_inset Quotes eld
8908 \begin_inset Flex Code
8911 \begin_layout Plain Layout
8918 \begin_inset Quotes erd
8924 \begin_layout Description
8925 \begin_inset Flex Code
8928 \begin_layout Plain Layout
8934 Adds information to the document preamble.
8936 \begin_inset Newline newline
8940 \begin_inset Quotes eld
8944 \begin_inset Flex Code
8947 \begin_layout Plain Layout
8954 \begin_inset Quotes erd
8958 \change_inserted -712698321 1483872509
8962 \begin_layout Description
8964 \change_inserted -712698321 1483874560
8965 \begin_inset Flex Code
8968 \begin_layout Plain Layout
8970 \change_inserted -712698321 1483872558
8976 Defines the possibilities for displaying citation references.
8978 \begin_inset CommandInset ref
8980 reference "subsec:Citation-engine-description"
8989 \begin_inset Quotes eld
8993 \begin_inset Flex Code
8996 \begin_layout Plain Layout
8998 \change_inserted -712698321 1483872548
9005 \begin_inset Quotes erd
9009 Primarily used in cite engine files (see
9010 \begin_inset CommandInset ref
9012 reference "subsec:Cite-Engine-Files"
9024 \begin_layout Description
9025 \begin_inset Flex Code
9028 \begin_layout Plain Layout
9034 Defines formats for use in the display of bibliographic information.
9036 \begin_inset CommandInset ref
9038 reference "subsec:Citation-format-description"
9044 \begin_inset Quotes eld
9048 \begin_inset Flex Code
9051 \begin_layout Plain Layout
9058 \begin_inset Quotes erd
9063 \change_inserted -712698321 1483875199
9064 Primarily used in cite engine files (see
9065 \begin_inset CommandInset ref
9067 reference "subsec:Cite-Engine-Files"
9079 \begin_layout Description
9081 \change_inserted -712698321 1483874578
9082 \begin_inset Flex Code
9085 \begin_layout Plain Layout
9087 \change_inserted -712698321 1483872820
9094 \begin_inset Flex Code
9097 \begin_layout Plain Layout
9099 \change_inserted -712698321 1483872852
9110 \begin_inset Flex Code
9113 \begin_layout Plain Layout
9115 \change_inserted -712698321 1483872857
9123 ] Determines whether
9127 or Bib\SpecialChar TeX
9128 is used to generate a Bibliography.
9129 Primarily used in cite engine files (see
9130 \begin_inset CommandInset ref
9132 reference "subsec:Cite-Engine-Files"
9144 \begin_layout Description
9145 \begin_inset Flex Code
9148 \begin_layout Plain Layout
9154 Describes various global options supported by the document class.
9156 \begin_inset CommandInset ref
9158 reference "subsec:ClassOptions"
9164 \begin_inset Quotes eld
9168 \begin_inset Flex Code
9171 \begin_layout Plain Layout
9178 \begin_inset Quotes erd
9184 \begin_layout Description
9185 \begin_inset Flex Code
9188 \begin_layout Plain Layout
9195 \begin_inset Flex Code
9198 \begin_layout Plain Layout
9207 \begin_inset space \thinspace{}
9211 \begin_inset Flex Code
9214 \begin_layout Plain Layout
9220 ] Whether the class should
9224 to having one or two columns.
9225 Can be changed in the
9226 \begin_inset Flex Noun
9229 \begin_layout Plain Layout
9230 Document\SpecialChar menuseparator
9239 \begin_layout Description
9240 \begin_inset Flex Code
9243 \begin_layout Plain Layout
9250 \begin_inset Flex Code
9253 \begin_layout Plain Layout
9259 ] This sequence defines the properties for a counter.
9260 If the counter does not yet exist, it is created; if it does exist, it
9263 \begin_inset Quotes eld
9267 \begin_inset Flex Code
9270 \begin_layout Plain Layout
9277 \begin_inset Quotes erd
9281 \begin_inset Newline newline
9285 \begin_inset CommandInset ref
9287 reference "subsec:Counters"
9291 for details on counters.
9294 \begin_layout Description
9295 \begin_inset Flex Code
9298 \begin_layout Plain Layout
9304 Sets the default font used to display the document.
9306 \begin_inset CommandInset ref
9308 reference "subsec:Font-description"
9312 for how to declare fonts.
9314 \begin_inset Quotes eld
9318 \begin_inset Flex Code
9321 \begin_layout Plain Layout
9328 \begin_inset Quotes erd
9334 \begin_layout Description
9335 \begin_inset Flex Code
9338 \begin_layout Plain Layout
9345 \begin_inset Flex Code
9348 \begin_layout Plain Layout
9354 ] Specifies a module to be included by default with this document class.
9355 The module is specified as filename without the
9356 \begin_inset Flex Code
9359 \begin_layout Plain Layout
9366 The user can still remove the module, but it will be active at the outset.
9367 (This applies only when new files are created, or when this class is chosen
9368 for an existing document.)
9371 \begin_layout Description
9372 \begin_inset Flex Code
9375 \begin_layout Plain Layout
9382 \begin_inset Flex Code
9385 \begin_layout Plain Layout
9391 ] This is the style that will be assigned to new paragraphs, usually
9392 \begin_inset Flex Noun
9395 \begin_layout Plain Layout
9402 This will default to the first defined style if not given, but you are
9403 encouraged to use this directive.
9406 \begin_layout Description
9407 \begin_inset Flex Code
9410 \begin_layout Plain Layout
9417 \begin_inset Flex Code
9420 \begin_layout Plain Layout
9426 ] This tag indicates that the module (which is specified by filename without
9428 \begin_inset Flex Code
9431 \begin_layout Plain Layout
9437 extension) cannot be used with this document class.
9438 This might be used in a journal-specific layout file to prevent, say, the
9440 \begin_inset Flex Code
9443 \begin_layout Plain Layout
9449 module that numbers theorems by section.
9454 be used in a module.
9455 Modules have their own way of excluding other modules (see
9456 \begin_inset CommandInset ref
9458 reference "subsec:Layout-modules"
9465 \begin_layout Description
9466 \begin_inset Flex Code
9469 \begin_layout Plain Layout
9475 Defines a new float.
9477 \begin_inset CommandInset ref
9479 reference "subsec:Floats"
9485 \begin_inset Quotes eld
9489 \begin_inset Flex Code
9492 \begin_layout Plain Layout
9499 \begin_inset Quotes erd
9505 \begin_layout Description
9506 \begin_inset Flex Code
9509 \begin_layout Plain Layout
9515 Sets the information that will be output in the
9516 \begin_inset Flex Code
9519 \begin_layout Plain Layout
9525 block when this document class is output to XHTML.
9526 Note that this will completely override any prior
9527 \begin_inset Flex Code
9530 \begin_layout Plain Layout
9537 \begin_inset Flex Code
9540 \begin_layout Plain Layout
9548 \begin_inset Newline newline
9552 \begin_inset Flex Code
9555 \begin_layout Plain Layout
9561 if you just want to add material to the preamble.) Must end with
9562 \begin_inset Quotes eld
9566 \begin_inset Flex Code
9569 \begin_layout Plain Layout
9576 \begin_inset Quotes erd
9582 \begin_layout Description
9583 \begin_inset Flex Code
9586 \begin_layout Plain Layout
9593 \begin_inset Flex Code
9596 \begin_layout Plain Layout
9602 ] The style to use for the table of contents, bibliography, and so forth,
9603 when the document is output to HTML.
9604 For articles, this should normally be
9605 \begin_inset Flex Code
9608 \begin_layout Plain Layout
9615 \begin_inset Flex Code
9618 \begin_layout Plain Layout
9625 If it is not given, then \SpecialChar LyX
9626 will attempt to figure out which layout to use.
9629 \begin_layout Description
9630 \begin_inset Flex Code
9633 \begin_layout Plain Layout
9640 \begin_inset Flex Code
9643 \begin_layout Plain Layout
9649 ] Modifies the properties of the given counter.
9650 If the counter does not exist, the statement is ignored.
9652 \begin_inset Quotes eld
9656 \begin_inset Flex Code
9659 \begin_layout Plain Layout
9666 \begin_inset Quotes erd
9670 \begin_inset Newline newline
9674 \begin_inset CommandInset ref
9676 reference "subsec:Counters"
9680 for details on counters.
9683 \begin_layout Description
9684 \begin_inset Flex Code
9687 \begin_layout Plain Layout
9694 \begin_inset Flex Code
9697 \begin_layout Plain Layout
9703 ] This allows you to include another layout definition file within yours
9704 to avoid duplicating commands.
9705 Common examples are the standard layout files, for example,
9706 \begin_inset Flex Code
9709 \begin_layout Plain Layout
9715 , which contains most of the basic layouts.
9718 \begin_layout Description
9719 \begin_inset Flex Code
9722 \begin_layout Plain Layout
9729 \begin_inset Flex Code
9732 \begin_layout Plain Layout
9738 ] This section (re-)defines the layout of an inset.
9739 It can be applied to an existing inset or to a new, user-defined inset,
9740 e.g., a new character style.
9742 \begin_inset Quotes eld
9746 \begin_inset Flex Code
9749 \begin_layout Plain Layout
9756 \begin_inset Quotes erd
9760 \begin_inset Newline newline
9764 \begin_inset CommandInset ref
9766 reference "subsec:Flex-insets-and"
9770 for more information.
9774 \begin_layout Description
9775 \begin_inset Flex Code
9778 \begin_layout Plain Layout
9785 \begin_inset Flex Code
9788 \begin_layout Plain Layout
9794 ] A string that indicates the width of the left margin on the screen, for
9796 \begin_inset Quotes eld
9800 \begin_inset Flex Code
9803 \begin_layout Plain Layout
9810 \begin_inset Quotes erd
9814 (Note that this is not a `length', like
9815 \begin_inset Quotes eld
9819 \begin_inset Quotes erd
9823 \change_inserted -712698321 1483872681
9827 \begin_layout Description
9829 \change_inserted -712698321 1483874598
9830 \begin_inset Flex Code
9833 \begin_layout Plain Layout
9835 \change_inserted -712698321 1483872687
9842 \begin_inset Flex Code
9845 \begin_layout Plain Layout
9847 \change_inserted -712698321 1483872692
9853 ] An integer that determines the maximal number of names displayed in an
9854 author-year citation before the citation switches to
9855 \begin_inset Quotes eld
9859 \begin_inset Quotes erd
9863 Primarily used in cite engine files (see
9864 \begin_inset CommandInset ref
9866 reference "subsec:Cite-Engine-Files"
9878 \begin_layout Description
9879 \begin_inset Flex Code
9882 \begin_layout Plain Layout
9889 \begin_inset Flex Code
9892 \begin_layout Plain Layout
9898 ] Modifies the properties of the given paragraph style.
9899 If the style does not exist, this section is ignored.
9901 \begin_inset Quotes eld
9905 \begin_inset Flex Code
9908 \begin_layout Plain Layout
9915 \begin_inset Quotes erd
9921 \begin_layout Description
9922 \begin_inset Flex Code
9925 \begin_layout Plain Layout
9932 \begin_inset Flex Code
9935 \begin_layout Plain Layout
9941 ] Deletes an existing counter, usually one defined in an included file.
9944 \begin_layout Description
9945 \begin_inset Flex Code
9948 \begin_layout Plain Layout
9955 \begin_inset Flex Code
9958 \begin_layout Plain Layout
9964 ] Deletes an existing float.
9965 This is particularly useful when you want to suppress a float that has
9966 been defined in an input file.
9969 \begin_layout Description
9970 \begin_inset Flex Code
9973 \begin_layout Plain Layout
9980 \begin_inset Flex Code
9983 \begin_layout Plain Layout
9989 ] Deletes an existing style.
9990 \change_inserted 2047637253 1483900342
9994 \begin_layout Description
9996 \change_inserted 2047637253 1483900479
9997 \begin_inset Flex Code
10000 \begin_layout Plain Layout
10002 \change_inserted 2047637253 1483900346
10009 \begin_inset Flex Code
10012 \begin_layout Plain Layout
10014 \change_inserted 2047637253 1483900369
10021 \begin_inset Flex Code
10024 \begin_layout Plain Layout
10026 \change_inserted 2047637253 1483900418
10032 ] Define a new table of contents with type
10033 \begin_inset Flex Code
10036 \begin_layout Plain Layout
10038 \change_inserted 2047637253 1483900414
10045 \begin_inset Flex Code
10048 \begin_layout Plain Layout
10050 \change_inserted 2047637253 1483900419
10057 See also the AddToToc commands.
10062 \begin_layout Description
10063 \begin_inset Flex Code
10066 \begin_layout Plain Layout
10073 \begin_inset Flex Code
10076 \begin_layout Plain Layout
10082 ] The file format (as defined in the \SpecialChar LyX
10083 preferences) produced by this document
10085 It is mainly useful when
10086 \begin_inset Flex Code
10089 \begin_layout Plain Layout
10096 \begin_inset Flex Code
10099 \begin_layout Plain Layout
10105 and one wants to define a new type of literate document.
10106 The format is reset to
10107 \begin_inset Quotes eld
10111 \begin_inset Flex Code
10114 \begin_layout Plain Layout
10121 \begin_inset Quotes erd
10125 \begin_inset Quotes eld
10129 \begin_inset Flex Code
10132 \begin_layout Plain Layout
10139 \begin_inset Quotes erd
10142 when the corresponding
10143 \begin_inset Flex Code
10146 \begin_layout Plain Layout
10152 parameter is encountered.
10155 \begin_layout Description
10156 \begin_inset Flex Code
10159 \begin_layout Plain Layout
10166 \begin_inset Flex Code
10169 \begin_layout Plain Layout
10180 \begin_inset Flex Code
10183 \begin_layout Plain Layout
10190 \begin_inset Flex Code
10193 \begin_layout Plain Layout
10199 ] Specifies what sort of output documents using this class will produce.
10202 \begin_layout Description
10203 \begin_inset Flex Code
10206 \begin_layout Plain Layout
10213 \begin_inset Flex Code
10216 \begin_layout Plain Layout
10223 \begin_inset Flex Code
10226 \begin_layout Plain Layout
10232 ] Specifies options, given in the second string, for the package named by
10235 \begin_inset Quotes eld
10239 \begin_inset Flex Code
10242 \begin_layout Plain Layout
10243 PackageOptions natbib square
10249 \begin_inset Quotes erd
10253 \begin_inset Flex Code
10256 \begin_layout Plain Layout
10262 to be loaded with the
10263 \begin_inset Flex Code
10266 \begin_layout Plain Layout
10273 (For \SpecialChar TeX
10274 perts, this causes \SpecialChar LyX
10276 \begin_inset Flex Code
10279 \begin_layout Plain Layout
10282 PassOptionsToPackage{natbib}{square}
10288 \begin_inset Flex Code
10291 \begin_layout Plain Layout
10300 \begin_layout Description
10301 \begin_inset Flex Code
10304 \begin_layout Plain Layout
10311 \begin_inset Flex Code
10314 \begin_layout Plain Layout
10323 \begin_inset Flex Code
10326 \begin_layout Plain Layout
10333 \begin_inset Flex Code
10336 \begin_layout Plain Layout
10342 ] The default pagestyle.
10343 Can be changed in the
10344 \begin_inset Flex Noun
10347 \begin_layout Plain Layout
10348 Document\SpecialChar menuseparator
10357 \begin_layout Description
10358 \begin_inset Flex Code
10361 \begin_layout Plain Layout
10367 Sets the preamble for the \SpecialChar LaTeX
10369 Note that this will completely override any prior
10370 \begin_inset Flex Code
10373 \begin_layout Plain Layout
10380 \begin_inset Flex Code
10383 \begin_layout Plain Layout
10391 \begin_inset Flex Code
10394 \begin_layout Plain Layout
10400 if you just want to add material to the preamble.) Must end with
10401 \begin_inset Quotes eld
10405 \begin_inset Flex Code
10408 \begin_layout Plain Layout
10415 \begin_inset Quotes erd
10421 \begin_layout Description
10422 \begin_inset Flex Code
10425 \begin_layout Plain Layout
10432 \begin_inset Flex Code
10435 \begin_layout Plain Layout
10442 \begin_inset Flex Code
10445 \begin_layout Plain Layout
10454 \begin_inset space \thinspace{}
10458 \begin_inset Flex Code
10461 \begin_layout Plain Layout
10467 ] Whether the class already provides the feature
10468 \begin_inset Flex Code
10471 \begin_layout Plain Layout
10478 A feature is in general the name of a package (e.
10479 \begin_inset space \thinspace{}
10483 \begin_inset space \space{}
10487 \begin_inset Flex Code
10490 \begin_layout Plain Layout
10497 \begin_inset Flex Code
10500 \begin_layout Plain Layout
10507 \begin_inset space \thinspace{}
10511 \begin_inset space \space{}
10515 \begin_inset Flex Code
10518 \begin_layout Plain Layout
10525 \begin_inset Flex Code
10528 \begin_layout Plain Layout
10536 \begin_inset CommandInset ref
10538 reference "chap:List-of-functions"
10542 for the list of features.
10545 \begin_layout Description
10546 \begin_inset Flex Code
10549 \begin_layout Plain Layout
10556 \begin_inset Flex Code
10559 \begin_layout Plain Layout
10565 ] Indicates that this layout provides the functionality of the module mentioned,
10566 which should be specified by the filename without the
10567 \begin_inset Flex Code
10570 \begin_layout Plain Layout
10577 This will typically be used if the layout includes the module directly,
10578 rather than using the
10579 \begin_inset Flex Code
10582 \begin_layout Plain Layout
10588 tag to indicate that it ought to be used.
10589 It could also be used in a module that provided an alternate implementation
10590 of the same functionality.
10593 \begin_layout Description
10594 \begin_inset Flex Code
10597 \begin_layout Plain Layout
10604 \begin_inset Flex Code
10607 \begin_layout Plain Layout
10613 ] Creates a new paragraph style if it does not already exist.
10614 If the style does exist, this section is ignored.
10616 \begin_inset Quotes eld
10620 \begin_inset Flex Code
10623 \begin_layout Plain Layout
10630 \begin_inset Quotes erd
10636 \begin_layout Description
10637 \begin_inset Flex Code
10640 \begin_layout Plain Layout
10647 \begin_inset Flex Code
10650 \begin_layout Plain Layout
10656 ] Whether the class requires the feature
10657 \begin_inset Flex Code
10660 \begin_layout Plain Layout
10667 Multiple features must be separated by commas.
10668 Note that you can only request supported features.
10670 \begin_inset CommandInset ref
10672 reference "chap:List-of-functions"
10676 for the list of features.).
10677 If you require a package with specific options, you can additionally use
10679 \begin_inset Flex Code
10682 \begin_layout Plain Layout
10691 \begin_layout Description
10692 \begin_inset Flex Code
10695 \begin_layout Plain Layout
10702 \begin_inset Flex Code
10705 \begin_layout Plain Layout
10711 ] A string that indicates the width of the right margin on the screen, for
10713 \begin_inset Quotes eld
10717 \begin_inset Flex Code
10720 \begin_layout Plain Layout
10727 \begin_inset Quotes erd
10733 \begin_layout Description
10734 \begin_inset Flex Code
10737 \begin_layout Plain Layout
10744 \begin_inset Flex Code
10747 \begin_layout Plain Layout
10753 ] Sets which divisions get numbered.
10755 \begin_inset Newline newline
10759 \begin_inset Flex Code
10762 \begin_layout Plain Layout
10768 counter in \SpecialChar LaTeX
10772 \begin_layout Description
10773 \begin_inset Flex Code
10776 \begin_layout Plain Layout
10783 \begin_inset Flex Code
10786 \begin_layout Plain Layout
10795 \begin_inset space \thinspace{}
10799 \begin_inset Flex Code
10802 \begin_layout Plain Layout
10808 ] Whether the class-default should be printing on one or both sides of the
10810 Can be changed in the
10811 \begin_inset Flex Noun
10814 \begin_layout Plain Layout
10815 Document\SpecialChar menuseparator
10824 \begin_layout Description
10825 \begin_inset Flex Code
10828 \begin_layout Plain Layout
10835 \begin_inset Flex Code
10838 \begin_layout Plain Layout
10844 ] This sequence defines a paragraph style.
10845 If the style does not yet exist, it is created; if it does exist, its parameter
10848 \begin_inset Quotes eld
10852 \begin_inset Flex Code
10855 \begin_layout Plain Layout
10862 \begin_inset Quotes erd
10866 \begin_inset Newline newline
10870 \begin_inset CommandInset ref
10872 reference "subsec:Paragraph-Styles"
10876 for details on paragraph styles.
10879 \begin_layout Description
10880 \begin_inset Flex Code
10883 \begin_layout Plain Layout
10890 \begin_inset Flex Code
10893 \begin_layout Plain Layout
10899 ] The name of the command or environment to be used with
10900 \begin_inset Flex Code
10903 \begin_layout Plain Layout
10912 \begin_layout Description
10913 \begin_inset Flex Code
10916 \begin_layout Plain Layout
10923 \begin_inset Flex Code
10926 \begin_layout Plain Layout
10935 \begin_inset Flex Code
10938 \begin_layout Plain Layout
10944 ] Indicates what kind of markup is used to define the title of a document.
10946 \begin_inset Flex Code
10949 \begin_layout Plain Layout
10955 means that the macro with name
10956 \begin_inset Flex Code
10959 \begin_layout Plain Layout
10965 will be inserted after the last layout which has
10966 \begin_inset Quotes eld
10970 \begin_inset Flex Code
10973 \begin_layout Plain Layout
10975 \begin_inset space ~
10984 \begin_inset Quotes erd
10989 \begin_inset Flex Code
10992 \begin_layout Plain Layout
10998 corresponds to the case where all layouts which have
10999 \begin_inset Quotes eld
11003 \begin_inset Flex Code
11006 \begin_layout Plain Layout
11008 \begin_inset space ~
11017 \begin_inset Quotes erd
11020 should be enclosed into the
11021 \begin_inset Flex Code
11024 \begin_layout Plain Layout
11033 \begin_layout Description
11034 \begin_inset Flex Code
11037 \begin_layout Plain Layout
11044 \begin_inset Flex Code
11047 \begin_layout Plain Layout
11053 ] Sets which divisions are included in the table of contents.
11055 \begin_inset Flex Code
11058 \begin_layout Plain Layout
11064 counter in \SpecialChar LaTeX
11068 \begin_layout Subsection
11069 \begin_inset Flex Code
11072 \begin_layout Plain Layout
11079 \begin_inset CommandInset label
11081 name "subsec:ClassOptions"
11088 \begin_layout Standard
11090 \begin_inset Flex Code
11093 \begin_layout Plain Layout
11099 section can contain the following entries:
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 ] The list of available font sizes for the document's main font, separated
11124 \begin_inset Quotes eld
11128 \begin_inset Flex Code
11131 \begin_layout Plain Layout
11138 \begin_inset Quotes erd
11144 \begin_layout Description
11145 \begin_inset Flex Code
11148 \begin_layout Plain Layout
11154 Used to set the DTD line with XML-based output classes.
11156 \begin_inset space \thinspace{}
11160 \begin_inset Quotes eld
11163 -//OASIS//DTD DocBook V4.2//EN
11164 \begin_inset Quotes erd
11170 \begin_layout Description
11171 \begin_inset Flex Code
11174 \begin_layout Plain Layout
11181 \begin_inset Flex Code
11184 \begin_layout Plain Layout
11185 string="empty|plain|headings|fancy"
11190 ] The list of available page sty\SpecialChar softhyphen
11192 \begin_inset Quotes eld
11196 \begin_inset Flex Code
11199 \begin_layout Plain Layout
11206 \begin_inset Quotes erd
11212 \begin_layout Description
11213 \begin_inset Flex Code
11216 \begin_layout Plain Layout
11223 \begin_inset Flex Code
11226 \begin_layout Plain Layout
11232 ] Some document class options, separated by a comma, that will be added
11233 to the optional part of the
11234 \begin_inset Flex Code
11237 \begin_layout Plain Layout
11248 \begin_layout Standard
11250 \begin_inset Flex Code
11253 \begin_layout Plain Layout
11259 section must end with
11260 \begin_inset Quotes eld
11264 \begin_inset Flex Code
11267 \begin_layout Plain Layout
11274 \begin_inset Quotes erd
11280 \begin_layout Subsection
11282 \begin_inset CommandInset label
11284 name "subsec:Paragraph-Styles"
11291 \begin_layout Standard
11292 A paragraph style description looks like this:
11296 \begin_layout Plain Layout
11297 Note that this will either define a new style or modify an existing one.
11305 \begin_layout LyX-Code
11312 \begin_layout LyX-Code
11316 \begin_layout LyX-Code
11320 \begin_layout Standard
11321 where the following commands are allowed:
11324 \begin_layout Description
11326 \change_inserted 2047637253 1483963019
11327 \begin_inset Flex Code
11330 \begin_layout Plain Layout
11332 \change_inserted 2047637253 1483901753
11339 \begin_inset Flex Code
11342 \begin_layout Plain Layout
11344 \change_inserted 2047637253 1483963007
11350 =""] This paragraph will appear in the table of contents of the given type.
11351 An empty string disables.
11352 See also the OutlinerName and the IsTocCaption commands.
11356 \begin_layout Description
11357 \begin_inset Flex Code
11360 \begin_layout Plain Layout
11367 \begin_inset Flex Code
11370 \begin_layout Plain Layout
11375 , left, right, center
11380 ] Paragraph alignment.
11383 \begin_layout Description
11384 \begin_inset Flex Code
11387 \begin_layout Plain Layout
11394 \begin_inset Flex Code
11397 \begin_layout Plain Layout
11402 , left, right, center
11407 ] A comma separated list of permitted alignments.
11408 (Some \SpecialChar LaTeX
11409 styles prohibit certain alignments, since those wouldn't make sense.
11410 For example a right-aligned or centered enumeration isn't possible.)
11413 \begin_layout Description
11414 \begin_inset Flex Code
11417 \begin_layout Plain Layout
11424 \begin_inset Flex Code
11427 \begin_layout Plain Layout
11433 ] Defines argument number <int> of a command\SpecialChar breakableslash
11434 environment associated with
11436 This is useful for things like section headings, and only makes sense with
11439 Every (optional or required) argument of a command or environment – except
11440 for the required argument that is associated with the content of the paragraph
11441 itself – has a separate definition, where the number specifies the order
11443 The definition must end with
11444 \begin_inset Flex Code
11447 \begin_layout Plain Layout
11454 So a command with two optional arguments has:
11458 \begin_layout Quote
11464 \begin_layout Quote
11470 \begin_layout Quote
11476 \begin_layout Quote
11482 \begin_layout Quote
11488 \begin_layout Quote
11494 \begin_layout Standard
11496 \begin_inset Flex Code
11499 \begin_layout Plain Layout
11505 definition, the following specifications are possible:
11508 \begin_layout Itemize
11509 \begin_inset Flex Code
11512 \begin_layout Plain Layout
11519 \begin_inset Flex Code
11522 \begin_layout Plain Layout
11528 The string that will appear both in the menu (to insert this argument)
11529 and on the argument inset button (unless you also specify a separate
11530 \begin_inset Flex Code
11533 \begin_layout Plain Layout
11540 For the menu, you can define an accelerator by appending the respective
11541 character to the string, divided by
11542 \begin_inset Quotes eld
11546 \begin_inset Quotes erd
11550 \begin_inset space \thinspace{}
11554 \begin_inset space \space{}
11558 \begin_inset Quotes eld
11562 \begin_inset Flex Code
11565 \begin_layout Plain Layout
11572 \begin_inset Quotes erd
11578 \begin_layout Itemize
11579 \begin_inset Flex Code
11582 \begin_layout Plain Layout
11589 \begin_inset Flex Code
11592 \begin_layout Plain Layout
11598 A separate string for the menu.
11599 You can define an accelerator by appending the respective character to
11600 the string, divided by
11601 \begin_inset Quotes eld
11605 \begin_inset Quotes erd
11609 \begin_inset space \thinspace{}
11613 \begin_inset space \space{}
11617 \begin_inset Quotes eld
11621 \begin_inset Flex Code
11624 \begin_layout Plain Layout
11631 \begin_inset Quotes erd
11635 This specification is optional.
11636 If it is not given the
11637 \begin_inset Flex Code
11640 \begin_layout Plain Layout
11646 will be used instead for the menu.
11649 \begin_layout Itemize
11650 \begin_inset Flex Code
11653 \begin_layout Plain Layout
11660 \begin_inset Flex Code
11663 \begin_layout Plain Layout
11669 A longer explanatory text that appears in the tooltip when hovering over
11670 the argument inset.
11673 \begin_layout Itemize
11674 \begin_inset Flex Code
11677 \begin_layout Plain Layout
11684 \begin_inset Flex Code
11687 \begin_layout Plain Layout
11696 \begin_inset space \thinspace{}
11700 \begin_inset Flex Code
11703 \begin_layout Plain Layout
11709 ] Declare if this is a mandatory (1) or an optional (0) argument.
11710 Mandatory arguments will be output empty if not given, while optional arguments
11711 will not be output at all.
11712 By default, mandatory arguments are delimited by
11713 \begin_inset Flex Code
11716 \begin_layout Plain Layout
11722 , while optional arguments are delimited by
11723 \begin_inset Flex Code
11726 \begin_layout Plain Layout
11735 \begin_layout Itemize
11736 \begin_inset Flex Code
11739 \begin_layout Plain Layout
11746 \begin_inset Flex Code
11749 \begin_layout Plain Layout
11755 defines another argument (by its number) which this argument requires to
11756 be output if it is itself output.
11758 \begin_inset space \thinspace{}
11761 g., in \SpecialChar LaTeX
11762 commands, optional arguments often require previous optional arguments
11763 to be output (at least empty), as in
11764 \begin_inset Flex Code
11767 \begin_layout Plain Layout
11770 command[][argument]{text}
11776 This can be achieved by the statement
11777 \begin_inset Flex Code
11780 \begin_layout Plain Layout
11787 \begin_inset Flex Code
11790 \begin_layout Plain Layout
11799 \begin_layout Itemize
11800 \begin_inset Flex Code
11803 \begin_layout Plain Layout
11810 \begin_inset Flex Code
11813 \begin_layout Plain Layout
11819 defines a custom left delimiter (instead of
11820 \begin_inset Flex Code
11823 \begin_layout Plain Layout
11830 \begin_inset Flex Code
11833 \begin_layout Plain Layout
11840 A line break in the output can be indicated by
11841 \begin_inset Flex Code
11844 \begin_layout Plain Layout
11853 \begin_layout Itemize
11854 \begin_inset Flex Code
11857 \begin_layout Plain Layout
11864 \begin_inset Flex Code
11867 \begin_layout Plain Layout
11873 defines a custom right delimiter (instead of
11874 \begin_inset Flex Code
11877 \begin_layout Plain Layout
11884 \begin_inset Flex Code
11887 \begin_layout Plain Layout
11894 A line break in the output can be indicated by
11895 \begin_inset Flex Code
11898 \begin_layout Plain Layout
11907 \begin_layout Itemize
11908 \begin_inset Flex Code
11911 \begin_layout Plain Layout
11918 \begin_inset Flex Code
11921 \begin_layout Plain Layout
11927 defines an argument that is inserted if and only if no user-specified arguments
11929 \begin_inset space \thinspace{}
11933 \begin_inset space \space{}
11936 if no argument inset has been inserted (note that also an empty argument
11937 inset omits the DefaultArg).
11938 Multiple arguments need to be separated by comma.
11941 \begin_layout Itemize
11942 \begin_inset Flex Code
11945 \begin_layout Plain Layout
11952 \begin_inset Flex Code
11955 \begin_layout Plain Layout
11961 defines an argument that is inserted in any case (alone or in addition
11962 to user-specified arguments).
11963 Multiple arguments need to be separated by comma.
11966 \begin_layout Itemize
11967 \begin_inset Flex Code
11970 \begin_layout Plain Layout
11976 The font used for the argument content, see
11977 \begin_inset CommandInset ref
11979 reference "subsec:Font-description"
11986 \begin_layout Itemize
11987 \begin_inset Flex Code
11990 \begin_layout Plain Layout
11996 The font used for the label; see
11997 \begin_inset CommandInset ref
11999 reference "subsec:Font-description"
12006 \begin_layout Itemize
12007 \begin_inset Flex Code
12010 \begin_layout Plain Layout
12017 \begin_inset Flex Code
12020 \begin_layout Plain Layout
12025 , Minimalistic, Conglomerate
12030 ] describes the rendering style used for the inset's frame and buttons.
12033 \begin_layout Itemize
12034 \begin_inset Flex Code
12037 \begin_layout Plain Layout
12044 \begin_inset Flex Code
12047 \begin_layout Plain Layout
12054 \begin_inset Flex Code
12057 \begin_layout Plain Layout
12063 , this argument is automatically inserted when the respective style is selected.
12064 Currently, only one argument per style\SpecialChar breakableslash
12065 layout can be automatically inserted.
12068 \begin_layout Itemize
12069 \begin_inset Flex Code
12072 \begin_layout Plain Layout
12079 \begin_inset Flex Code
12082 \begin_layout Plain Layout
12089 \begin_inset Flex Code
12092 \begin_layout Plain Layout
12098 , this argument will be inserted with a copy of the co-text (either selected
12099 text or the whole paragraph) as content.
12100 \change_inserted -712698321 1477038290
12104 \begin_layout Itemize
12106 \change_inserted -712698321 1477038425
12107 \begin_inset Flex Code
12110 \begin_layout Plain Layout
12112 \change_inserted -712698321 1477038295
12119 \begin_inset Flex Code
12122 \begin_layout Plain Layout
12124 \change_inserted -712698321 1477038311
12134 ] Whether the contents of this argument should be output in raw form, meaning
12135 without special translations that \SpecialChar LaTeX
12138 \begin_inset Flex Code
12141 \begin_layout Plain Layout
12143 \change_inserted -712698321 1477038356
12149 status is inherited by the inset or paragraph layout the argument belongs
12150 to, true and false change the status for the given argument only.
12155 \begin_layout Itemize
12156 \begin_inset Flex Code
12159 \begin_layout Plain Layout
12166 \begin_inset Flex Code
12169 \begin_layout Plain Layout
12170 string of characters
12179 Defines individual characters that should be output in raw form, meaning
12180 without special translations that \SpecialChar LaTeX
12182 Note that, contrary to PassThru, this needs to be explicitly defined for
12184 That is, arguments do not inherit PassThruChars from their parent inset
12186 \change_inserted 2047637253 1483899840
12190 \begin_layout Itemize
12192 \change_inserted 2047637253 1483900841
12193 \begin_inset Flex Code
12196 \begin_layout Plain Layout
12198 \change_inserted 2047637253 1483900841
12205 \begin_inset Flex Code
12208 \begin_layout Plain Layout
12210 \change_inserted 2047637253 1483900841
12219 \begin_inset space \thinspace{}
12223 \begin_inset Flex Code
12226 \begin_layout Plain Layout
12228 \change_inserted 2047637253 1483900841
12234 ] If this is set to 1, the argument will output its content in the corresponding
12235 item in the table of contents.
12241 \begin_layout Standard
12242 By default, the text entered in the \SpecialChar LyX
12243 workarea in the respective layout is
12244 the last (mandatory) argument of a command if the
12245 \begin_inset Flex Code
12248 \begin_layout Plain Layout
12255 \begin_inset Flex Code
12258 \begin_layout Plain Layout
12265 However, arguments with the prefix
12266 \begin_inset Flex Code
12269 \begin_layout Plain Layout
12275 are output after this workarea argument.
12276 Note that post-argument numbering restarts at 1, so the first argument
12277 following the workarea argument is
12278 \begin_inset Flex Code
12281 \begin_layout Plain Layout
12288 Post-arguments are ignored in any other
12289 \begin_inset Flex Code
12292 \begin_layout Plain Layout
12299 \begin_inset Flex Code
12302 \begin_layout Plain Layout
12311 \begin_layout Standard
12313 \begin_inset Flex Code
12316 \begin_layout Plain Layout
12325 \begin_inset Flex Code
12328 \begin_layout Plain Layout
12337 \begin_inset Flex Code
12340 \begin_layout Plain Layout
12346 followed by the number (e.
12347 \begin_inset space \thinspace{}
12351 \begin_inset space \space{}
12355 \begin_inset Flex Code
12358 \begin_layout Plain Layout
12368 \begin_layout Description
12369 \begin_inset Flex Code
12372 \begin_layout Plain Layout
12378 Note that this will completely override any prior
12379 \begin_inset Flex Code
12382 \begin_layout Plain Layout
12388 declaration for this style.
12390 \begin_inset Quotes eld
12394 \begin_inset Flex Code
12397 \begin_layout Plain Layout
12404 \begin_inset Quotes erd
12409 \begin_inset CommandInset ref
12411 reference "subsec:I18n"
12415 for details on its use.
12418 \begin_layout Description
12419 \begin_inset Flex Code
12422 \begin_layout Plain Layout
12429 \begin_inset Flex Code
12432 \begin_layout Plain Layout
12442 \begin_layout Plain Layout
12443 Note that a `float' here is a real number, such as: 1.5.
12448 The vertical space with which the last of a chain of paragraphs with this
12449 style is separated from the following paragraph.
12450 If the next paragraph has another style, the separations are not simply
12451 added, but the maximum is taken.
12454 \begin_layout Description
12455 \begin_inset Flex Code
12458 \begin_layout Plain Layout
12465 \begin_inset Flex Code
12468 \begin_layout Plain Layout
12474 ] The category for this style.
12475 This is used to group related styles in the style combobox on the toolbar.
12476 Any string can be used, but you may want to use existing categories with
12481 \begin_layout Description
12482 \begin_inset Flex Code
12485 \begin_layout Plain Layout
12491 Depth of XML command.
12492 Used only with XML-type formats.
12495 \begin_layout Description
12496 \begin_inset Flex Code
12499 \begin_layout Plain Layout
12506 \begin_inset Flex Code
12509 \begin_layout Plain Layout
12515 ] Copies all the features of an existing style into the current one.
12519 \begin_layout Description
12520 \begin_inset Flex Code
12523 \begin_layout Plain Layout
12530 \begin_inset Flex Code
12533 \begin_layout Plain Layout
12539 ] The name of a style whose preamble should be output
12544 This allows to ensure some ordering of the preamble snippets when macros
12545 definitions depend on one another.
12549 \begin_layout Plain Layout
12550 Note that, besides that functionality, there is no way to ensure any ordering
12552 The ordering that you see in a given version of \SpecialChar LyX
12553 may change without warning
12562 \begin_layout Description
12563 \begin_inset Flex Code
12566 \begin_layout Plain Layout
12573 \begin_inset Flex Code
12576 \begin_layout Plain Layout
12581 , Box, Filled_Box, Static
12586 ] The type of label that stands at the end of the paragraph (or sequence
12588 \begin_inset Flex Code
12591 \begin_layout Plain Layout
12598 \begin_inset Newline newline
12602 \begin_inset Flex Code
12605 \begin_layout Plain Layout
12612 \begin_inset Flex Code
12615 \begin_layout Plain Layout
12622 \begin_inset Flex Code
12625 \begin_layout Plain Layout
12633 \begin_inset Flex Code
12636 \begin_layout Plain Layout
12643 \begin_inset Quotes eld
12647 \begin_inset Quotes erd
12651 \begin_inset Flex Code
12654 \begin_layout Plain Layout
12661 \begin_inset space \space{}
12665 \begin_inset Flex Code
12668 \begin_layout Plain Layout
12674 ) is a white (resp.
12675 \begin_inset space ~
12678 black) square suitable for end of proof markers,
12679 \begin_inset Flex Code
12682 \begin_layout Plain Layout
12688 is an explicit text string.
12691 \begin_layout Description
12692 \begin_inset Flex Code
12695 \begin_layout Plain Layout
12702 \begin_inset Flex Code
12705 \begin_layout Plain Layout
12711 ] The string used for a label with a
12712 \begin_inset Flex Code
12715 \begin_layout Plain Layout
12722 \begin_inset Newline newline
12726 \begin_inset Flex Code
12729 \begin_layout Plain Layout
12739 \begin_layout Description
12740 \begin_inset Flex Code
12743 \begin_layout Plain Layout
12749 The font used for both the text body
12755 \begin_inset CommandInset ref
12757 reference "subsec:Font-description"
12762 Note that defining this font automatically defines the
12763 \begin_inset Flex Code
12766 \begin_layout Plain Layout
12773 So you should define this one first if you also want to define
12774 \begin_inset Flex Code
12777 \begin_layout Plain Layout
12786 \begin_layout Description
12787 \begin_inset Flex Code
12790 \begin_layout Plain Layout
12797 \begin_inset Flex Code
12800 \begin_layout Plain Layout
12806 ] Used for backporting new styles to stable \SpecialChar LyX
12808 The first stable version that supports this tag is \SpecialChar LyX
12810 The argument is a number which may either be 0, -1 or any value greater
12813 \begin_inset Flex Code
12816 \begin_layout Plain Layout
12822 flag of a style is greater than zero, it will always be written to the
12824 If a .lyx file is read, the style definitions from the document header are
12825 added to the document class.
12826 Therefore even older \SpecialChar LyX
12827 versions can handle the style.
12829 \begin_inset Flex Code
12832 \begin_layout Plain Layout
12838 is a version number: if the style is read, and the version number is less
12839 than the version number of the already existing style in the document class,
12840 the new style is ignored.
12841 If the version number is greater, the new style replaces the existing style.
12842 A value of -1 means an infinite version number, i.
12843 \begin_inset space \thinspace{}
12847 \begin_inset space \space{}
12850 the style is always used.
12853 \begin_layout Description
12854 \begin_inset Flex Code
12857 \begin_layout Plain Layout
12864 \begin_inset Flex Code
12867 \begin_layout Plain Layout
12876 \begin_inset space \thinspace{}
12880 \begin_inset Flex Code
12883 \begin_layout Plain Layout
12889 ] Usually \SpecialChar LyX
12890 does not allow you to insert more than one space between words,
12891 since a space is considered as the separation between two words, not a
12892 character or symbol of its own.
12893 This is a very fine thing but sometimes annoying, for example, when typing
12894 program code or plain \SpecialChar LaTeX
12897 \begin_inset Flex Code
12900 \begin_layout Plain Layout
12907 Note that \SpecialChar LyX
12908 will create protected blanks for the additional blanks when
12909 in another mode than \SpecialChar LaTeX
12913 \begin_layout Description
12914 \begin_inset Flex Code
12917 \begin_layout Plain Layout
12923 These tags are used with XHTML output.
12925 \begin_inset CommandInset ref
12927 reference "subsec:Paragraph-Style-XHTML"
12934 \begin_layout Description
12935 \begin_inset Flex Code
12938 \begin_layout Plain Layout
12944 [FIXME] (Used only with XML-type formats.)
12947 \begin_layout Description
12948 \begin_inset Flex Code
12951 \begin_layout Plain Layout
12958 \begin_inset Flex Code
12961 \begin_layout Plain Layout
12970 \begin_inset space \thinspace{}
12974 \begin_inset Flex Code
12977 \begin_layout Plain Layout
12984 \begin_inset Flex Code
12987 \begin_layout Plain Layout
12993 , marks the style as to be included in the document preamble and not in
12995 This is useful for document classes that want such information as the title
12996 and author to appear in the preamble.
12997 Note that this works only for styles for which the
12998 \begin_inset Flex Code
13001 \begin_layout Plain Layout
13008 \begin_inset Flex Code
13011 \begin_layout Plain Layout
13018 \begin_inset Flex Code
13021 \begin_layout Plain Layout
13030 \begin_layout Description
13031 \begin_inset Flex Code
13034 \begin_layout Plain Layout
13041 \begin_inset Flex Code
13044 \begin_layout Plain Layout
13053 \begin_inset space \thinspace{}
13057 \begin_inset Flex Code
13060 \begin_layout Plain Layout
13067 \begin_inset Flex Code
13070 \begin_layout Plain Layout
13076 , marks the style as being part of a title block (see also the
13077 \begin_inset Flex Code
13080 \begin_layout Plain Layout
13087 \begin_inset Flex Code
13090 \begin_layout Plain Layout
13099 \begin_layout Description
13101 \change_inserted 2047637253 1483902824
13102 \begin_inset Flex Code
13105 \begin_layout Plain Layout
13107 \change_inserted 2047637253 1483902211
13114 \begin_inset Flex Code
13117 \begin_layout Plain Layout
13119 \change_inserted 2047637253 1483902211
13128 \begin_inset space \thinspace{}
13132 \begin_inset Flex Code
13135 \begin_layout Plain Layout
13137 \change_inserted 2047637253 1483902211
13143 ] If this is set to 1 and AddToToc is enabled, the paragraph adds a summary
13144 of its contents in its item in the table of contents.
13145 Otherwise, only the label, if it exists, appears.
13148 \begin_layout Description
13149 \begin_inset Flex Code
13152 \begin_layout Plain Layout
13159 \begin_inset Flex Code
13162 \begin_layout Plain Layout
13168 ] The \SpecialChar LaTeX
13169 command sequence declaring an item in a list.
13170 The command is to be defined without the preceding backslash (the default
13172 \begin_inset Quotes eld
13176 \begin_inset Quotes erd
13180 \begin_inset Flex Code
13183 \begin_layout Plain Layout
13191 in the \SpecialChar LaTeX
13195 \begin_layout Description
13196 \begin_inset Flex Code
13199 \begin_layout Plain Layout
13206 \begin_inset Flex Code
13209 \begin_layout Plain Layout
13215 ] This provides extra space between paragraphs that have the same style.
13216 If you put other styles into an environment, each is separated with the
13218 \begin_inset Flex Code
13221 \begin_layout Plain Layout
13228 But the whole items of the environment are additionally separated with
13230 \begin_inset Flex Code
13233 \begin_layout Plain Layout
13240 Note that this is a
13245 \begin_layout Description
13246 \begin_inset Flex Code
13249 \begin_layout Plain Layout
13255 [FIXME] (Used only with XML-type formats.)
13258 \begin_layout Description
13259 \begin_inset Flex Code
13262 \begin_layout Plain Layout
13269 \begin_inset Flex Code
13272 \begin_layout Plain Layout
13281 \begin_inset space \thinspace{}
13285 \begin_inset Flex Code
13288 \begin_layout Plain Layout
13294 ] Usually \SpecialChar LyX
13295 does not allow you to leave a paragraph empty, since it would
13296 lead to empty \SpecialChar LaTeX
13298 There are some cases where this could be desirable however: in a letter
13299 template, the required fields can be provided as empty fields, so that
13300 people do not forget them; in some special classes, a style can be used
13301 as some kind of break, which does not contain actual text.
13304 \begin_layout Description
13305 \begin_inset Flex Code
13308 \begin_layout Plain Layout
13315 \begin_inset Flex Code
13318 \begin_layout Plain Layout
13324 ] The vertical space between the label and the text body.
13325 Only used for labels that are above the text body (
13326 \begin_inset Flex Code
13329 \begin_layout Plain Layout
13336 \begin_inset Newline newline
13340 \begin_inset Flex Code
13343 \begin_layout Plain Layout
13344 Centered_Top_Environment
13352 \begin_layout Description
13353 \begin_inset Flex Code
13356 \begin_layout Plain Layout
13363 \begin_inset Flex Code
13366 \begin_layout Plain Layout
13372 ] The name of the counter for automatic numbering.
13373 In order to have the counter appear with your label, you will need to reference
13375 \begin_inset Flex Code
13378 \begin_layout Plain Layout
13387 This will work with
13388 \begin_inset Flex Code
13391 \begin_layout Plain Layout
13398 \begin_inset Flex Code
13401 \begin_layout Plain Layout
13408 \begin_inset Flex Code
13411 \begin_layout Plain Layout
13418 \begin_inset Flex Code
13421 \begin_layout Plain Layout
13428 \begin_inset Newline newline
13436 \begin_inset Flex Code
13439 \begin_layout Plain Layout
13446 \begin_inset Flex Code
13449 \begin_layout Plain Layout
13455 , though this case is a bit complicated.
13456 Suppose you declare
13457 \begin_inset Quotes eld
13461 \begin_inset Flex Code
13464 \begin_layout Plain Layout
13465 LabelCounter myenum
13471 \begin_inset Quotes erd
13475 Then the actual counters used are
13476 \begin_inset Flex Code
13479 \begin_layout Plain Layout
13486 \begin_inset Flex Code
13489 \begin_layout Plain Layout
13496 \begin_inset Flex Code
13499 \begin_layout Plain Layout
13506 \begin_inset Flex Code
13509 \begin_layout Plain Layout
13515 , much as in \SpecialChar LaTeX
13517 These counters must all be declared separately.
13518 \begin_inset Newline newline
13522 \begin_inset CommandInset ref
13524 reference "subsec:Counters"
13528 for details on counters.
13531 \begin_layout Description
13532 \begin_inset Flex Code
13535 \begin_layout Plain Layout
13541 The font used for the label.
13543 \begin_inset CommandInset ref
13545 reference "subsec:Font-description"
13552 \begin_layout Description
13553 \begin_inset Flex Code
13556 \begin_layout Plain Layout
13563 \begin_inset Flex Code
13566 \begin_layout Plain Layout
13572 ] Text that indicates how far a label should be indented.
13575 \begin_layout Description
13576 \begin_inset Flex Code
13579 \begin_layout Plain Layout
13586 \begin_inset Flex Code
13589 \begin_layout Plain Layout
13595 ] Text that indicates the amount of horizontal space between the label and
13597 Only used for labels that are not above the text body.
13600 \begin_layout Description
13601 \begin_inset Flex Code
13604 \begin_layout Plain Layout
13611 \begin_inset Flex Code
13614 \begin_layout Plain Layout
13620 ] The string used for the label.
13622 \begin_inset Flex Code
13625 \begin_layout Plain Layout
13631 is set, this string can be contain the special formatting commands described
13633 \begin_inset CommandInset ref
13635 reference "subsec:Counters"
13642 \begin_layout Description
13643 \begin_inset Flex Code
13646 \begin_layout Plain Layout
13647 LabelStringAppendix
13653 \begin_inset Flex Code
13656 \begin_layout Plain Layout
13662 ] This is used inside the appendix instead of
13663 \begin_inset Newline newline
13667 \begin_inset Flex Code
13670 \begin_layout Plain Layout
13678 \begin_inset Flex Code
13681 \begin_layout Plain Layout
13688 \begin_inset Newline newline
13692 \begin_inset Flex Code
13695 \begin_layout Plain Layout
13696 LabelStringAppendix
13704 \begin_layout Description
13705 \begin_inset Flex Code
13708 \begin_layout Plain Layout
13714 [FIXME] (Used only with XML-type formats.)
13717 \begin_layout Description
13718 \begin_inset Flex Code
13721 \begin_layout Plain Layout
13728 \begin_inset Flex Code
13731 \begin_layout Plain Layout
13736 , Manual, Static, Above,
13737 \begin_inset Newline newline
13740 Centered, Sensitive, Enumerate,
13741 \begin_inset Newline newline
13744 Itemize, Bibliography
13753 \begin_layout Description
13754 \begin_inset Flex Code
13757 \begin_layout Plain Layout
13763 means the label is the very first word (up to the first real blank).
13764 Use protected spaces if you want more than one word as the label.
13768 \begin_layout Description
13769 \begin_inset Flex Code
13772 \begin_layout Plain Layout
13778 means the label is simply what is declared as
13779 \begin_inset Flex Code
13782 \begin_layout Plain Layout
13789 This will be displayed
13790 \begin_inset Quotes eld
13794 \begin_inset Quotes erd
13797 , at the beginning of the paragraph.
13799 \begin_inset Flex Code
13802 \begin_layout Plain Layout
13809 \begin_inset Flex Code
13812 \begin_layout Plain Layout
13818 , then it will be displayed only in the first paragraph of any sequence
13819 of paragraphs with the same
13820 \begin_inset Flex Code
13823 \begin_layout Plain Layout
13832 \begin_layout Description
13833 \begin_inset Flex Code
13836 \begin_layout Plain Layout
13843 \begin_inset space ~
13847 \begin_inset space ~
13851 \begin_inset Flex Code
13854 \begin_layout Plain Layout
13860 are special cases of
13861 \begin_inset Flex Code
13864 \begin_layout Plain Layout
13871 The label will be printed above the paragraph either at the beginning of
13872 the line or centered.
13875 \begin_layout Description
13876 \begin_inset Flex Code
13879 \begin_layout Plain Layout
13885 is a special case for the caption-labels
13886 \begin_inset Quotes eld
13890 \begin_inset Quotes erd
13894 \begin_inset Quotes eld
13898 \begin_inset Quotes erd
13902 \begin_inset Newline newline
13906 \begin_inset Flex Code
13909 \begin_layout Plain Layout
13915 means the (hardcoded) label string depends on the kind of float: It is
13916 hardcoded to be `FloatType N', where N is the value of the counter associated
13918 For the case that a caption is inserted outside of a float the
13919 \begin_inset Flex Code
13922 \begin_layout Plain Layout
13929 \begin_inset Quotes eld
13933 \begin_inset Quotes erd
13939 \begin_layout Description
13940 \begin_inset Flex Code
13943 \begin_layout Plain Layout
13949 produces the usual sort of enumeration labels.
13950 At present, it is hardcoded to use Arabic numerals, lowercase letters,
13951 small Roman numerals, and uppercase letters for the four possible depths.
13954 \begin_layout Description
13955 \begin_inset Flex Code
13958 \begin_layout Plain Layout
13964 produces various bullets at the different levels.
13965 It is also hardcoded.
13968 \begin_layout Description
13969 \begin_inset Flex Code
13972 \begin_layout Plain Layout
13978 should be used only with
13979 \begin_inset Flex Code
13982 \begin_layout Plain Layout
13983 LatexType BibEnvironment
13992 \begin_layout Description
13993 \begin_inset Flex Code
13996 \begin_layout Plain Layout
14002 Note that this will completely override any prior
14003 \begin_inset Flex Code
14006 \begin_layout Plain Layout
14012 declaration for this style.
14014 \begin_inset Quotes eld
14018 \begin_inset Flex Code
14021 \begin_layout Plain Layout
14028 \begin_inset Quotes erd
14033 \begin_inset CommandInset ref
14035 reference "subsec:I18n"
14039 for details on its use.
14042 \begin_layout Description
14043 \begin_inset Flex Code
14046 \begin_layout Plain Layout
14053 \begin_inset Flex Code
14056 \begin_layout Plain Layout
14062 ] The name of the corresponding \SpecialChar LaTeX
14064 Either the environment or command name.
14067 \begin_layout Description
14068 \begin_inset Flex Code
14071 \begin_layout Plain Layout
14078 \begin_inset Flex Code
14081 \begin_layout Plain Layout
14087 ] An optional parameter for the corresponding
14088 \begin_inset Flex Code
14091 \begin_layout Plain Layout
14098 This parameter cannot be changed from within \SpecialChar LyX
14100 \begin_inset Flex Code
14103 \begin_layout Plain Layout
14109 for customizable parameters).
14110 This will be output as is after all \SpecialChar LaTeX
14112 \begin_inset Flex Code
14115 \begin_layout Plain Layout
14124 \begin_layout Description
14125 \begin_inset Flex Code
14128 \begin_layout Plain Layout
14135 \begin_inset Flex Code
14138 \begin_layout Plain Layout
14143 , Command, Environment, Item_Environment,
14144 \begin_inset Newline newline
14147 List_Environment, Bib_Environment
14152 ] How the style should be translated into \SpecialChar LaTeX
14157 \begin_layout Plain Layout
14158 \begin_inset Flex Code
14161 \begin_layout Plain Layout
14167 is perhaps a bit misleading, since these rules apply to SGML classes, too.
14168 Visit the SGML class files for specific examples.
14177 \begin_layout Description
14178 \begin_inset Flex Code
14181 \begin_layout Plain Layout
14187 means nothing special.
14190 \begin_layout Description
14191 \begin_inset Flex Code
14194 \begin_layout Plain Layout
14201 \begin_inset Flex Code
14204 \begin_layout Plain Layout
14211 {\SpecialChar ldots
14220 \begin_layout Description
14221 \begin_inset Flex Code
14224 \begin_layout Plain Layout
14231 \begin_inset Flex Code
14234 \begin_layout Plain Layout
14241 }\SpecialChar ldots
14257 \begin_layout Description
14258 \begin_inset Flex Code
14261 \begin_layout Plain Layout
14268 \begin_inset Flex Code
14271 \begin_layout Plain Layout
14278 \begin_inset Flex Code
14281 \begin_layout Plain Layout
14289 is generated for each paragraph of this environment.
14293 \begin_layout Description
14294 \begin_inset Flex Code
14297 \begin_layout Plain Layout
14304 \begin_inset Flex Code
14307 \begin_layout Plain Layout
14314 \begin_inset Newline newline
14318 \begin_inset Flex Code
14321 \begin_layout Plain Layout
14327 is passed as an argument to the environment.
14328 \begin_inset Newline newline
14332 \begin_inset Flex Code
14335 \begin_layout Plain Layout
14341 can be defined in the
14342 \begin_inset Flex Noun
14345 \begin_layout Plain Layout
14346 Edit\SpecialChar menuseparator
14348 \begin_inset space ~
14359 \begin_layout Description
14360 \begin_inset Flex Code
14363 \begin_layout Plain Layout
14370 \begin_inset Flex Code
14373 \begin_layout Plain Layout
14379 but adds the necessary mandatory argument (the longest label) to the begin
14380 statement of the bibliography environment:
14381 \begin_inset Newline newline
14385 \begin_inset Flex Code
14388 \begin_layout Plain Layout
14391 begin{thebibliography}{99}
14397 It is therefore only useful for bibliography environments.
14398 The default longest label
14399 \begin_inset Quotes eld
14403 \begin_inset Quotes erd
14406 can be changed by the user in the paragraph settings of a bibliography
14410 \begin_layout Standard
14411 Putting the last few things together, the \SpecialChar LaTeX
14412 output will be either:
14415 \begin_layout LyX-Code
14418 LatexName[LatexParam]{\SpecialChar ldots
14422 \begin_layout Standard
14426 \begin_layout LyX-Code
14429 begin{LatexName}[LatexParam] \SpecialChar ldots
14435 \begin_layout Standard
14436 depending upon the \SpecialChar LaTeX
14441 \begin_layout Description
14442 \begin_inset Flex Code
14445 \begin_layout Plain Layout
14452 \begin_inset Flex Code
14455 \begin_layout Plain Layout
14461 ] A string that is put at the beginning of the style content.
14462 A line break in the output can be indicated by
14463 \begin_inset Flex Code
14466 \begin_layout Plain Layout
14475 \begin_layout Description
14476 \begin_inset Flex Code
14479 \begin_layout Plain Layout
14486 \begin_inset Flex Code
14489 \begin_layout Plain Layout
14495 ] If you put styles into environments, the different
14496 \begin_inset Flex Code
14499 \begin_layout Plain Layout
14505 are not simply added, but added with a factor
14506 \begin_inset Formula $\frac{4}{\mathrm{depth}+4}$
14510 Note that this parameter is also used when
14511 \begin_inset Flex Code
14514 \begin_layout Plain Layout
14521 \begin_inset Flex Code
14524 \begin_layout Plain Layout
14531 \begin_inset Flex Code
14534 \begin_layout Plain Layout
14541 Then it is added to the manual or dynamic margin.
14542 \begin_inset Newline newline
14546 \begin_inset Quotes eld
14550 \begin_inset Flex Code
14553 \begin_layout Plain Layout
14560 \begin_inset Quotes erd
14563 means that the paragraph is indented with the width of
14564 \begin_inset Quotes eld
14568 \begin_inset Flex Code
14571 \begin_layout Plain Layout
14578 \begin_inset Quotes erd
14581 in the normal font.
14582 You can get a negative width by prefixing the string with
14583 \begin_inset Quotes eld
14587 \begin_inset Flex Code
14590 \begin_layout Plain Layout
14597 \begin_inset Quotes erd
14601 This way was chosen so that the look is the same with each used screen
14605 \begin_layout Description
14606 \begin_inset Flex Code
14609 \begin_layout Plain Layout
14616 \begin_inset Flex Code
14619 \begin_layout Plain Layout
14624 , Manual, Dynamic, First_Dynamic, Right_Address_Box
14630 \begin_inset Newline newline
14633 The kind of margin that the style has on the left side.
14637 \begin_layout Description
14638 \begin_inset Flex Code
14641 \begin_layout Plain Layout
14647 just means a fixed margin.
14650 \begin_layout Description
14651 \begin_inset Flex Code
14654 \begin_layout Plain Layout
14660 means that the left margin depends on the string entered in the
14661 \begin_inset Flex Noun
14664 \begin_layout Plain Layout
14665 Edit\SpecialChar menuseparator
14667 \begin_inset space ~
14676 This is used to typeset nice lists without tabulators.
14679 \begin_layout Description
14680 \begin_inset Flex Code
14683 \begin_layout Plain Layout
14689 means that the margin depends on the size of the label.
14690 This is used for automatic enumerated headlines.
14691 It is obvious that the headline
14692 \begin_inset Quotes eld
14695 5.4.3.2.1 Very long headline
14696 \begin_inset Quotes erd
14699 must have a wider left margin (as wide as
14700 \begin_inset Quotes eld
14704 \begin_inset Quotes erd
14707 plus the space) than
14708 \begin_inset Quotes eld
14711 3.2 Very long headline
14712 \begin_inset Quotes erd
14716 \begin_inset Quotes eld
14720 \begin_inset Quotes erd
14723 are not able to do this.
14726 \begin_layout Description
14727 \begin_inset Flex Code
14730 \begin_layout Plain Layout
14736 is similar, but only the very first row of the paragraph is dynamic, while
14737 the others are static; this is used, for example, for descriptions.
14740 \begin_layout Description
14741 \begin_inset Flex Code
14744 \begin_layout Plain Layout
14750 means the margin is chosen in a way that the longest row of this paragraph
14751 fits to the right margin.
14752 This is used to typeset an address on the right edge of the page.
14756 \begin_layout Description
14757 \begin_inset Flex Code
14760 \begin_layout Plain Layout
14767 \begin_inset Flex Code
14770 \begin_layout Plain Layout
14779 \begin_inset space \thinspace{}
14783 \begin_inset Flex Code
14786 \begin_layout Plain Layout
14792 ] Whether fragile commands in this style should be
14793 \begin_inset Flex Code
14796 \begin_layout Plain Layout
14809 whether this command should itself be protected.)
14812 \begin_layout Description
14813 \begin_inset Flex Code
14816 \begin_layout Plain Layout
14823 \begin_inset Flex Code
14826 \begin_layout Plain Layout
14833 \begin_inset space \thinspace{}
14837 \begin_inset Flex Code
14840 \begin_layout Plain Layout
14848 ] Whether newlines are translated into \SpecialChar LaTeX
14850 \begin_inset Flex Code
14853 \begin_layout Plain Layout
14864 The translation can be switched off to allow more comfortable \SpecialChar LaTeX
14866 inside \SpecialChar LyX
14870 \begin_layout Description
14871 \begin_inset Flex Code
14874 \begin_layout Plain Layout
14881 \begin_inset Flex Code
14884 \begin_layout Plain Layout
14893 \begin_inset space \thinspace{}
14897 \begin_inset Flex Code
14900 \begin_layout Plain Layout
14906 ] If set to true, and if
14907 \begin_inset Flex Code
14910 \begin_layout Plain Layout
14917 \begin_inset Flex Code
14920 \begin_layout Plain Layout
14926 ) paragraphs are being indented, then the indentation of such a paragraph
14927 following one of this type will be suppressed.
14928 (So this will not affect the display of non-default paragraphs.)
14931 \begin_layout Description
14932 \begin_inset Flex Code
14935 \begin_layout Plain Layout
14942 \begin_inset Flex Code
14945 \begin_layout Plain Layout
14951 ] Name of a style that has replaced this style.
14952 This is used to rename a style, while keeping backward compatibility.
14955 \begin_layout Description
14956 \begin_inset Flex Code
14959 \begin_layout Plain Layout
14966 \begin_inset Flex Code
14969 \begin_layout Plain Layout
14976 \begin_inset space \thinspace{}
14980 \begin_inset Flex Code
14983 \begin_layout Plain Layout
14989 ] Determines whether consecutive pragraphs of the same type are treated
14990 as belonging together.
14991 This has the effect that the
14992 \begin_inset Flex Code
14995 \begin_layout Plain Layout
15001 is only printed once before such a group.
15002 By default, this is true for
15003 \begin_inset Flex Code
15006 \begin_layout Plain Layout
15013 \begin_inset Flex Code
15016 \begin_layout Plain Layout
15023 \begin_inset Flex Code
15026 \begin_layout Plain Layout
15032 and false for all other types.
15035 \begin_layout Description
15036 \begin_inset Flex Code
15039 \begin_layout Plain Layout
15046 \begin_inset Flex Code
15049 \begin_layout Plain Layout
15058 \begin_inset space \thinspace{}
15062 \begin_inset Flex Code
15065 \begin_layout Plain Layout
15071 ] Indicates that paragraphs will not be separated by an empty line in \SpecialChar LaTeX
15073 but only by a line break; together with
15074 \begin_inset Flex Code
15077 \begin_layout Plain Layout
15083 , this allows to emulate a plain text editor (like the ERT inset).
15086 \begin_layout Description
15087 \begin_inset Flex Code
15090 \begin_layout Plain Layout
15097 \begin_inset Flex Code
15100 \begin_layout Plain Layout
15106 ] The indent of the very first line of a paragraph.
15108 \begin_inset Newline newline
15112 \begin_inset Flex Code
15115 \begin_layout Plain Layout
15121 will be fixed for a certain style.
15122 The exception is the default style, since the indentation for these paragraphs
15123 can be prohibited with
15124 \begin_inset Flex Code
15127 \begin_layout Plain Layout
15135 \begin_inset Flex Code
15138 \begin_layout Plain Layout
15144 style paragraphs inside environments use the
15145 \begin_inset Flex Code
15148 \begin_layout Plain Layout
15154 of the environment, not their native one.
15156 \begin_inset Flex Code
15159 \begin_layout Plain Layout
15165 paragraphs inside an enumeration are not indented.
15168 \begin_layout Description
15169 \begin_inset Flex Code
15172 \begin_layout Plain Layout
15179 \begin_inset Flex Code
15182 \begin_layout Plain Layout
15188 ] The vertical space between two paragraphs of this style.
15191 \begin_layout Description
15192 \begin_inset Flex Code
15195 \begin_layout Plain Layout
15202 \begin_inset Flex Code
15205 \begin_layout Plain Layout
15212 allows the user to choose either
15213 \begin_inset Quotes eld
15217 \begin_inset Quotes erd
15221 \begin_inset Quotes eld
15225 \begin_inset Quotes erd
15228 to separate paragraphs.
15230 \begin_inset Quotes eld
15234 \begin_inset Quotes erd
15238 \begin_inset Flex Code
15241 \begin_layout Plain Layout
15249 \begin_inset Quotes eld
15253 \begin_inset Quotes erd
15257 \begin_inset Flex Code
15260 \begin_layout Plain Layout
15266 is ignored and all paragraphs are separated by the
15267 \begin_inset Flex Code
15270 \begin_layout Plain Layout
15277 The vertical space is calculated with
15278 \begin_inset Flex Code
15281 \begin_layout Plain Layout
15283 \begin_inset space ~
15292 \begin_inset Flex Code
15295 \begin_layout Plain Layout
15301 is the height of a row with the normal font.
15302 This way, the look stays the same with different screen fonts.
15305 \begin_layout Description
15306 \begin_inset Flex Code
15309 \begin_layout Plain Layout
15316 \begin_inset Flex Code
15319 \begin_layout Plain Layout
15328 \begin_inset space \thinspace{}
15332 \begin_inset Flex Code
15335 \begin_layout Plain Layout
15341 ] Whether the contents of this paragraph should be output in raw form, meaning
15342 without special translations that \SpecialChar LaTeX
15346 \begin_layout Description
15347 \begin_inset Flex Code
15350 \begin_layout Plain Layout
15357 \begin_inset Flex Code
15360 \begin_layout Plain Layout
15370 Defines individual characters that should be output in raw form, meaning
15371 without special translations that \SpecialChar LaTeX
15375 \begin_layout Description
15376 \begin_inset Flex Code
15379 \begin_layout Plain Layout
15385 Information to be included in the \SpecialChar LaTeX
15386 preamble when this style is used.
15387 Used to define macros, load packages, etc., required by this particular
15390 \begin_inset Quotes eld
15394 \begin_inset Flex Code
15397 \begin_layout Plain Layout
15404 \begin_inset Quotes erd
15410 \begin_layout Description
15411 \begin_inset Flex Code
15414 \begin_layout Plain Layout
15421 \begin_inset Flex Code
15424 \begin_layout Plain Layout
15430 ] The prefix to use when creating labels referring to paragraphs of this
15432 This allows the use of formatted references.
15435 \begin_layout Description
15436 \begin_inset Flex Code
15439 \begin_layout Plain Layout
15446 \begin_inset Flex Code
15449 \begin_layout Plain Layout
15455 ] Whether the style requires the feature
15456 \begin_inset Flex Code
15459 \begin_layout Plain Layout
15466 \begin_inset CommandInset ref
15468 reference "chap:List-of-functions"
15472 for the list of features).
15473 If you require a package with specific options, you can additionally use
15475 \begin_inset Flex Code
15478 \begin_layout Plain Layout
15484 as a general text class parameter (see
15485 \begin_inset CommandInset ref
15487 reference "subsec:General-text-class"
15494 \begin_layout Description
15495 \begin_inset Flex Code
15498 \begin_layout Plain Layout
15505 \begin_inset Flex Code
15508 \begin_layout Plain Layout
15517 \begin_inset Flex Code
15520 \begin_layout Plain Layout
15526 ] Resets the \SpecialChar LaTeX
15527 arguments of this style (as defined via the
15528 \begin_inset Flex Code
15531 \begin_layout Plain Layout
15538 This is useful if you have copied a style via
15539 \begin_inset Flex Code
15542 \begin_layout Plain Layout
15548 , but you do not want to inherit its (required and optional) arguments.
15549 \change_inserted 2089657418 1476488475
15553 \begin_layout Description
15555 \change_inserted 2089657418 1476488475
15556 \begin_inset Flex Code
15559 \begin_layout Plain Layout
15561 \change_inserted 2089657418 1476488475
15568 \begin_inset Flex Code
15571 \begin_layout Plain Layout
15573 \change_inserted 2089657418 1476488475
15582 \begin_inset Flex Code
15585 \begin_layout Plain Layout
15587 \change_inserted 2089657418 1476488475
15593 ] Resumes a counter that is usually reset at each new sequence of layouts.
15594 This is currently only useful when
15595 \begin_inset Flex Code
15598 \begin_layout Plain Layout
15600 \change_inserted 2089657418 1476488475
15607 \begin_inset Flex Code
15610 \begin_layout Plain Layout
15612 \change_inserted 2089657418 1476488475
15623 \begin_layout Description
15624 \begin_inset Flex Code
15627 \begin_layout Plain Layout
15634 \begin_inset Flex Code
15637 \begin_layout Plain Layout
15643 ] A string that is put at the end of the layout content.
15644 A line break in the output can be indicated by
15645 \begin_inset Flex Code
15648 \begin_layout Plain Layout
15657 \begin_layout Description
15658 \begin_inset Flex Code
15661 \begin_layout Plain Layout
15668 \begin_inset Flex Code
15671 \begin_layout Plain Layout
15678 \begin_inset Flex Code
15681 \begin_layout Plain Layout
15690 \begin_layout Description
15691 \begin_inset Flex Code
15694 \begin_layout Plain Layout
15701 \begin_inset Flex Code
15704 \begin_layout Plain Layout
15713 \begin_inset Flex Code
15716 \begin_layout Plain Layout
15723 \begin_inset Flex Code
15726 \begin_layout Plain Layout
15733 \begin_inset Flex Code
15736 \begin_layout Plain Layout
15738 \begin_inset space ~
15746 ] This defines what the default spacing should be in the style.
15748 \begin_inset Flex Code
15751 \begin_layout Plain Layout
15758 \begin_inset Flex Code
15761 \begin_layout Plain Layout
15768 \begin_inset Flex Code
15771 \begin_layout Plain Layout
15777 correspond respectively to a multiplier value of 1, 1.25 and 1.667.
15778 If you specify the argument
15779 \begin_inset Flex Code
15782 \begin_layout Plain Layout
15788 , then you must also provide a value argument which will be the actual multiplie
15790 Note that, contrary to other parameters,
15791 \begin_inset Flex Code
15794 \begin_layout Plain Layout
15800 implies the generation of specific \SpecialChar LaTeX
15801 code, using the \SpecialChar LaTeX
15805 \begin_inset Flex Code
15808 \begin_layout Plain Layout
15817 \begin_layout Description
15818 \begin_inset Flex Code
15821 \begin_layout Plain Layout
15828 \begin_inset Flex Code
15831 \begin_layout Plain Layout
15838 \begin_inset space \thinspace{}
15842 \begin_inset Flex Code
15845 \begin_layout Plain Layout
15853 ] Allow spell-checking paragraphs of this style.
15855 \change_inserted 2089657418 1476488264
15859 \begin_layout Description
15861 \change_inserted 2089657418 1476488264
15862 \begin_inset Flex Code
15865 \begin_layout Plain Layout
15867 \change_inserted 2089657418 1476488264
15874 \begin_inset Flex Code
15877 \begin_layout Plain Layout
15879 \change_inserted 2089657418 1476488264
15888 \begin_inset Flex Code
15891 \begin_layout Plain Layout
15893 \change_inserted 2089657418 1476488264
15899 ] Steps the master counter of a given counter at the beginning of a new
15900 sequence of layouts.
15901 This is currently only useful when
15902 \begin_inset Flex Code
15905 \begin_layout Plain Layout
15907 \change_inserted 2089657418 1476488264
15914 \begin_inset Flex Code
15917 \begin_layout Plain Layout
15919 \change_inserted 2089657418 1476488264
15930 \begin_layout Description
15931 \begin_inset Flex Code
15934 \begin_layout Plain Layout
15940 The font used for the text body .
15942 \begin_inset CommandInset ref
15944 reference "subsec:Font-description"
15951 \begin_layout Description
15952 \begin_inset Flex Code
15955 \begin_layout Plain Layout
15964 \begin_inset Flex Code
15967 \begin_layout Plain Layout
15977 The level of the style in the table of contents.
15978 This is used for automatic numbering of section headings.
15981 \begin_layout Description
15982 \begin_inset Flex Code
15985 \begin_layout Plain Layout
15994 \begin_inset Flex Code
15997 \begin_layout Plain Layout
16008 \begin_inset Flex Code
16011 \begin_layout Plain Layout
16018 \begin_inset Flex Code
16021 \begin_layout Plain Layout
16027 ] This tag determines whether the first line indentation of this paragraph
16028 can be toggled via the Paragraph settings dialog.
16032 \begin_inset Flex Code
16035 \begin_layout Plain Layout
16045 is set, indentation can be toggled if the document settings use
16046 \begin_inset Quotes eld
16050 \begin_inset Quotes erd
16053 paragraph style, with
16054 \begin_inset Flex Code
16057 \begin_layout Plain Layout
16063 , indentation can always be toggled, notwithstanding the document settings,
16065 \begin_inset Flex Code
16068 \begin_layout Plain Layout
16074 , indentation can never be toggled.
16077 \begin_layout Description
16078 \begin_inset Flex Code
16081 \begin_layout Plain Layout
16088 \begin_inset Flex Code
16091 \begin_layout Plain Layout
16097 ] The vertical space with which the very first of a chain of paragraphs
16098 with this style is separated from the previous paragraph.
16099 If the previous paragraph has another style, the separations are not simply
16100 added, but the maximum is taken.
16103 \begin_layout Subsection
16104 \begin_inset CommandInset label
16110 Internationalization of Paragraph Styles
16113 \begin_layout Standard
16115 has long supported internationalization of layout information, but, until
16116 version 2.0, this applied only to the user interface and not to, say, PDF
16118 Thus, French authors were forced to resort to ugly hacks if they wanted
16123 1' instead of `Theorem 1'.
16124 Thanks to Georg Baum, that is no longer the case.
16127 \begin_layout Standard
16129 \begin_inset Flex Code
16132 \begin_layout Plain Layout
16138 defines text that is to appear in the typeset document, it may use
16139 \begin_inset Flex Code
16142 \begin_layout Plain Layout
16149 \begin_inset Flex Code
16152 \begin_layout Plain Layout
16158 to support non-English and even multi-language documents correctly.
16159 The following excerpt (from the
16160 \begin_inset Flex Code
16163 \begin_layout Plain Layout
16169 file) shows how this works:
16172 \begin_layout LyX-Code
16177 \begin_layout LyX-Code
16180 theoremstyle{remark}
16183 \begin_layout LyX-Code
16186 newtheorem{claim}[thm]{
16193 \begin_layout LyX-Code
16197 \begin_layout LyX-Code
16201 \begin_layout LyX-Code
16206 claimname}{_(Claim)}
16209 \begin_layout LyX-Code
16213 \begin_layout LyX-Code
16217 \begin_layout LyX-Code
16226 claimname}{_(Claim)}}
16229 \begin_layout LyX-Code
16234 \begin_layout Standard
16235 In principle, any legal \SpecialChar LaTeX
16237 \begin_inset Flex Code
16240 \begin_layout Plain Layout
16247 \begin_inset Flex Code
16250 \begin_layout Plain Layout
16256 tags, but in practice they will typically look as they do here.
16257 The key to correct translation of the typeset text is the definition of
16258 the \SpecialChar LaTeX
16260 \begin_inset Flex Code
16263 \begin_layout Plain Layout
16272 \begin_inset Flex Code
16275 \begin_layout Plain Layout
16287 \begin_layout Standard
16289 \begin_inset Flex Code
16292 \begin_layout Plain Layout
16298 tag provides for internationalization based upon the overall language of
16300 The contents of the tag will be included in the preamble, just as with
16302 \begin_inset Flex Code
16305 \begin_layout Plain Layout
16312 What makes it special is the use of the
16313 \begin_inset Quotes eld
16317 \begin_inset Quotes erd
16321 \begin_inset Flex Code
16324 \begin_layout Plain Layout
16330 , which will be replaced, when \SpecialChar LyX
16331 produces \SpecialChar LaTeX
16332 output, with the translation of
16333 its argument into the document language.
16336 \begin_layout Standard
16338 \begin_inset Flex Code
16341 \begin_layout Plain Layout
16347 tag is more complex, since it is meant to provide support for multi-language
16348 documents and so offers an interface to the
16349 \begin_inset Flex Code
16352 \begin_layout Plain Layout
16359 Its contents will be added to the preamble once for each language that
16360 appears in the document.
16361 In this case, the argument to
16362 \begin_inset Flex Code
16365 \begin_layout Plain Layout
16371 will be replaced with its translation into the language in question; the
16373 \begin_inset Flex Code
16376 \begin_layout Plain Layout
16382 is replaced by the language name (as used by the babel package).
16385 \begin_layout Standard
16386 A German document that also included a French section would thus have the
16387 following in the preamble:
16390 \begin_layout LyX-Code
16399 claimname}{Affirmation}}
16400 \begin_inset Newline newline
16411 claimname}{Behauptung}}
16412 \begin_inset Newline newline
16419 claimname}{Behauptung}
16422 \begin_layout Standard
16425 \begin_inset Flex Code
16428 \begin_layout Plain Layout
16434 will then conspire to produce the correct text in the output.
16437 \begin_layout Standard
16438 One important point to note here is that the translations are provided by
16440 itself, through the file
16441 \begin_inset Flex Code
16444 \begin_layout Plain Layout
16451 This means, in effect, that
16452 \begin_inset Flex Code
16455 \begin_layout Plain Layout
16462 \begin_inset Flex Code
16465 \begin_layout Plain Layout
16471 are really only of use in layout files that are provided with \SpecialChar LyX
16473 entered in user-created layout files will not be seen by \SpecialChar LyX
16474 's internationalizatio
16475 n routines unless the
16476 \begin_inset Flex Code
16479 \begin_layout Plain Layout
16485 file is modified accordingly.
16486 That said, however, any layout created with the intention that it will
16487 be included with \SpecialChar LyX
16488 should use these tags where appropriate.
16489 Please note that the paragraph style translations provided by \SpecialChar LyX
16491 change with a minor update (e.
16492 \begin_inset space \thinspace{}
16496 \begin_inset space \space{}
16499 from version 2.1.x to 2.1.y).
16500 It is however quite likely that a major update (e.
16501 \begin_inset space \thinspace{}
16505 \begin_inset space \space{}
16508 from 2.0.x to 2.1.y) will introduce new translations or corrections.
16511 \begin_layout Subsection
16513 \begin_inset CommandInset label
16515 name "subsec:Floats"
16522 \begin_layout Standard
16523 It is necessary to define the floats (
16524 \begin_inset Flex Noun
16527 \begin_layout Plain Layout
16534 \begin_inset Flex Noun
16537 \begin_layout Plain Layout
16543 , \SpecialChar ldots
16544 ) in the text class itself.
16545 Standard floats are included in the file
16546 \begin_inset Flex Code
16549 \begin_layout Plain Layout
16555 , so you may have to do no more than add
16558 \begin_layout LyX-Code
16559 Input stdfloats.inc
16562 \begin_layout Standard
16563 to your layout file.
16564 If you want to implement a text class that proposes some other float types
16565 (like the AGU class bundled with \SpecialChar LyX
16566 ), the information below will hopefully
16570 \begin_layout Description
16571 \begin_inset Flex Code
16574 \begin_layout Plain Layout
16581 \begin_inset Flex Code
16584 \begin_layout Plain Layout
16590 =!htbpH] Allowed placement options for this float type.
16591 The value is a string of placement characters.
16592 Possible characters include:
16597 \begin_inset Quotes eld
16601 \begin_inset Quotes erd
16609 \begin_inset Quotes eld
16613 \begin_inset Quotes erd
16621 \begin_inset Quotes eld
16625 \begin_inset Quotes erd
16633 \begin_inset Quotes eld
16637 \begin_inset Quotes erd
16645 \begin_inset Quotes eld
16649 \begin_inset Quotes erd
16657 \begin_inset Quotes eld
16661 \begin_inset Quotes erd
16665 The order of the characters in the string does not matter.
16666 If no placement options are allowed, use the string
16673 \begin_layout Description
16674 \begin_inset Flex Code
16677 \begin_layout Plain Layout
16684 \begin_inset Flex Code
16687 \begin_layout Plain Layout
16696 \begin_inset space \thinspace{}
16702 \begin_inset Flex Code
16705 \begin_layout Plain Layout
16715 ] Defines whether the float allows to be rotated via the \SpecialChar LaTeX
16722 \begin_inset Flex Code
16725 \begin_layout Plain Layout
16731 if the float does not support this feature.
16734 \begin_layout Description
16735 \begin_inset Flex Code
16738 \begin_layout Plain Layout
16745 \begin_inset Flex Code
16748 \begin_layout Plain Layout
16757 \begin_inset space \thinspace{}
16763 \begin_inset Flex Code
16766 \begin_layout Plain Layout
16776 ] Defines whether the float has a starred variant that spans columns in
16777 a two column paragraph.
16779 \begin_inset Flex Code
16782 \begin_layout Plain Layout
16788 if the float does not support this feature.
16791 \begin_layout Description
16792 \begin_inset Flex Code
16795 \begin_layout Plain Layout
16802 \begin_inset Flex Code
16805 \begin_layout Plain Layout
16812 \begin_inset Quotes erd
16816 \begin_inset Quotes erd
16819 ] The file name extension of an auxiliary file for the list of figures (or
16822 writes the captions to this file.
16825 \begin_layout Description
16826 \begin_inset Flex Code
16829 \begin_layout Plain Layout
16836 \begin_inset Flex Code
16839 \begin_layout Plain Layout
16846 \begin_inset Quotes erd
16850 \begin_inset Quotes erd
16853 ] The string that will be used in the menus and also for the caption.
16854 This is translated to the current language if babel is used.
16857 \begin_layout Description
16858 \begin_inset Flex Code
16861 \begin_layout Plain Layout
16867 These tags control the XHTML output.
16869 \begin_inset CommandInset ref
16871 reference "sec:Tags-for-XHTML"
16878 \begin_layout Description
16879 \begin_inset Flex Code
16882 \begin_layout Plain Layout
16891 \begin_inset Flex Code
16894 \begin_layout Plain Layout
16903 \begin_inset space \thinspace{}
16907 \begin_inset Flex Code
16910 \begin_layout Plain Layout
16916 ] Indicates whether the float is already defined in the document class or
16917 if instead the \SpecialChar LaTeX
16919 \begin_inset Flex Code
16922 \begin_layout Plain Layout
16928 needs to be loaded to define it on-the-fly.
16930 \begin_inset Flex Code
16933 \begin_layout Plain Layout
16940 \begin_inset Flex Code
16943 \begin_layout Plain Layout
16950 It should be set to
16951 \begin_inset Flex Code
16954 \begin_layout Plain Layout
16960 if the float is already defined by the \SpecialChar LaTeX
16964 \begin_layout Description
16965 \begin_inset Flex Code
16968 \begin_layout Plain Layout
16975 \begin_inset Flex Code
16978 \begin_layout Plain Layout
16985 \begin_inset Quotes erd
16989 \begin_inset Quotes erd
16992 ] The command used to generate a list of floats of this type; the leading
17001 \begin_inset Flex Code
17004 \begin_layout Plain Layout
17010 is false, since there is no standard way to generate this command.
17012 \begin_inset Flex Code
17015 \begin_layout Plain Layout
17021 is true, since in that case there is a standard way to define the command.
17024 \begin_layout Description
17025 \begin_inset Flex Code
17028 \begin_layout Plain Layout
17035 \begin_inset Flex Code
17038 \begin_layout Plain Layout
17045 \begin_inset Quotes erd
17049 \begin_inset Quotes erd
17052 ] A title for a list of floats of this kind (list of figures, tables, or
17054 It is used for the screen label within \SpecialChar LyX
17055 , it is used by \SpecialChar LaTeX
17057 it is used as the title in the XHTML output.
17058 It will be translated to the document language.
17061 \begin_layout Description
17062 \begin_inset Flex Code
17065 \begin_layout Plain Layout
17072 \begin_inset Flex Code
17075 \begin_layout Plain Layout
17082 \begin_inset Quotes erd
17086 \begin_inset Quotes erd
17089 ] This (optional) argument determines whether floats of this class will
17090 be numbered within some sectional unit of the document.
17092 \begin_inset Flex Code
17095 \begin_layout Plain Layout
17102 \begin_inset Quotes eld
17106 \begin_inset Flex Code
17109 \begin_layout Plain Layout
17116 \begin_inset Quotes erd
17119 , the floats will be numbered within chapters.
17123 \begin_layout Description
17124 \begin_inset Flex Code
17127 \begin_layout Plain Layout
17134 \begin_inset Flex Code
17137 \begin_layout Plain Layout
17144 \begin_inset Quotes erd
17148 \begin_inset Quotes erd
17151 ] The default placement for the given class of floats.
17152 The string should be as in standard \SpecialChar LaTeX
17154 \begin_inset Flex Code
17157 \begin_layout Plain Layout
17164 \begin_inset Flex Code
17167 \begin_layout Plain Layout
17174 \begin_inset Flex Code
17177 \begin_layout Plain Layout
17184 \begin_inset Flex Code
17187 \begin_layout Plain Layout
17193 for top, bottom, page, and here, respectively.
17197 \begin_layout Plain Layout
17198 Note that the order of these letters in the string is irrelevant, like in
17205 On top of that there is a new type,
17206 \begin_inset Flex Code
17209 \begin_layout Plain Layout
17215 , which does not really correspond to a float, since it means: put it
17216 \begin_inset Quotes eld
17220 \begin_inset Quotes erd
17224 Note however that the
17225 \begin_inset Flex Code
17228 \begin_layout Plain Layout
17234 specifier is special and, because of implementation details, cannot be
17235 used in non-built in float types.
17236 If you do not understand what this means, just use
17237 \begin_inset Quotes eld
17241 \begin_inset Flex Code
17244 \begin_layout Plain Layout
17251 \begin_inset Quotes erd
17257 \begin_layout Description
17258 \begin_inset Flex Code
17261 \begin_layout Plain Layout
17268 \begin_inset Flex Code
17271 \begin_layout Plain Layout
17277 ] The prefix to use when creating labels referring to floats of this type.
17278 This allows the use of formatted references.
17279 Note that you can remove any
17280 \begin_inset Flex Code
17283 \begin_layout Plain Layout
17289 set by a copied style by using the special value
17290 \begin_inset Quotes eld
17294 \begin_inset Quotes erd
17297 , which must be all caps.
17300 \begin_layout Description
17301 \begin_inset Flex Code
17304 \begin_layout Plain Layout
17311 \begin_inset Flex Code
17314 \begin_layout Plain Layout
17321 \begin_inset Quotes erd
17325 \begin_inset Quotes erd
17328 ] The style used when defining the float using
17329 \begin_inset Flex Code
17332 \begin_layout Plain Layout
17343 \begin_layout Description
17344 \begin_inset Flex Code
17347 \begin_layout Plain Layout
17354 \begin_inset Flex Code
17357 \begin_layout Plain Layout
17364 \begin_inset Quotes erd
17368 \begin_inset Quotes erd
17372 \begin_inset Quotes eld
17376 \begin_inset Quotes erd
17379 of the new class of floats, like program or algorithm.
17380 After the appropriate
17381 \begin_inset Flex Code
17384 \begin_layout Plain Layout
17393 \begin_inset Flex Code
17396 \begin_layout Plain Layout
17405 \begin_inset Flex Code
17408 \begin_layout Plain Layout
17419 \begin_layout Description
17420 \begin_inset Flex Code
17423 \begin_layout Plain Layout
17430 \begin_inset Flex Code
17433 \begin_layout Plain Layout
17440 \begin_inset space \thinspace{}
17444 \begin_inset Flex Code
17447 \begin_layout Plain Layout
17455 ] Specifies whether this float is defined using the \SpecialChar LaTeX
17457 \begin_inset Flex Code
17460 \begin_layout Plain Layout
17466 , either by the class file, another package or on-the-fly by \SpecialChar LyX
17470 \begin_layout Standard
17471 Note that defining a float with type
17472 \begin_inset Flex Code
17475 \begin_layout Plain Layout
17483 automatically defines the corresponding counter with name
17484 \begin_inset Flex Code
17487 \begin_layout Plain Layout
17498 \begin_layout Subsection
17499 Flex insets and InsetLayout
17500 \begin_inset CommandInset label
17502 name "subsec:Flex-insets-and"
17509 \begin_layout Standard
17510 Flex insets come in three different kinds:
17513 \begin_layout Itemize
17515 \begin_inset Flex Code
17518 \begin_layout Plain Layout
17524 ): These define semantic markup corresponding to such \SpecialChar LaTeX
17526 \begin_inset Flex Code
17529 \begin_layout Plain Layout
17538 \begin_inset Flex Code
17541 \begin_layout Plain Layout
17552 \begin_layout Itemize
17554 \begin_inset Flex Code
17557 \begin_layout Plain Layout
17563 ): These can be used to define custom collapsible insets, similar to \SpecialChar TeX
17565 footnote, and the like.
17566 An obvious example is an endnote inset, which is defined in the
17567 \begin_inset Flex Code
17570 \begin_layout Plain Layout
17579 \begin_layout Itemize
17581 \begin_inset Flex Code
17584 \begin_layout Plain Layout
17590 ): For use with DocBook classes.
17593 \begin_layout Standard
17594 Flex insets are defined using the
17595 \begin_inset Flex Code
17598 \begin_layout Plain Layout
17604 tag, which shall be explained in a moment.
17607 \begin_layout Standard
17609 \begin_inset Flex Code
17612 \begin_layout Plain Layout
17618 tag also serves another function: It can be used to customize the general
17619 layout of many different types of insets.
17621 \begin_inset Flex Code
17624 \begin_layout Plain Layout
17630 can be used to customize the layout parameters for footnotes, marginal
17631 notes, note insets, \SpecialChar TeX
17632 code (ERT) insets, branches, listings, indexes, boxes,
17633 tables, algorithms, URLs, and captions, as well as to define Flex insets.
17636 \begin_layout Standard
17638 \begin_inset Flex Code
17641 \begin_layout Plain Layout
17647 definition must begin with a line of the form:
17650 \begin_layout LyX-Code
17654 \begin_layout Standard
17656 \begin_inset Flex Code
17659 \begin_layout Plain Layout
17665 indicates the inset whose layout is being defined, and here there are four
17669 \begin_layout Enumerate
17670 The layout for a pre-existing inset is being modified.
17671 In this case, can be
17672 \begin_inset Flex Code
17675 \begin_layout Plain Layout
17681 any one of the following:
17682 \begin_inset Flex Code
17685 \begin_layout Plain Layout
17692 \begin_inset Flex Code
17695 \begin_layout Plain Layout
17702 \begin_inset Flex Code
17705 \begin_layout Plain Layout
17712 \begin_inset Flex Code
17715 \begin_layout Plain Layout
17722 \begin_inset Flex Code
17725 \begin_layout Plain Layout
17732 \begin_inset Flex Code
17735 \begin_layout Plain Layout
17742 \begin_inset Flex Code
17745 \begin_layout Plain Layout
17752 \begin_inset Flex Code
17755 \begin_layout Plain Layout
17762 \begin_inset Flex Code
17765 \begin_layout Plain Layout
17772 \begin_inset Flex Code
17775 \begin_layout Plain Layout
17782 \begin_inset Flex Code
17785 \begin_layout Plain Layout
17792 \begin_inset Flex Code
17795 \begin_layout Plain Layout
17802 \begin_inset Flex Code
17805 \begin_layout Plain Layout
17812 \begin_inset Flex Code
17815 \begin_layout Plain Layout
17822 \begin_inset Flex Code
17825 \begin_layout Plain Layout
17832 \begin_inset Flex Code
17835 \begin_layout Plain Layout
17842 \begin_inset Flex Code
17845 \begin_layout Plain Layout
17852 \begin_inset Flex Code
17855 \begin_layout Plain Layout
17862 \begin_inset Flex Code
17865 \begin_layout Plain Layout
17872 \begin_inset Flex Code
17875 \begin_layout Plain Layout
17884 \begin_layout Enumerate
17885 The layout for a Flex inset is being defined.
17887 \begin_inset Flex Code
17890 \begin_layout Plain Layout
17896 must be of the form
17897 \begin_inset Quotes eld
17901 \begin_inset Flex Code
17904 \begin_layout Plain Layout
17911 \begin_inset Quotes erd
17915 \begin_inset Flex Code
17918 \begin_layout Plain Layout
17924 may be be any valid identifier not used by a pre-existing Flex inset.
17925 The identifier may include spaces, but in that case the whole thing must
17926 be wrapped in quotes.
17927 Note that the definition of a flex inset
17932 \begin_inset Flex Code
17935 \begin_layout Plain Layout
17941 entry, declaring which type of inset it defines.
17944 \begin_layout Enumerate
17945 The layout for user specific branch is being defined.
17947 \begin_inset Flex Code
17950 \begin_layout Plain Layout
17956 must be of the form
17957 \begin_inset Quotes eld
17961 \begin_inset Flex Code
17964 \begin_layout Plain Layout
17971 \begin_inset Quotes erd
17975 \begin_inset Flex Code
17978 \begin_layout Plain Layout
17984 may be be any valid identifier of branch defined in user's document.
17985 The identifier may include spaces, but in that case the whole thing must
17986 be wrapped in quotes.
17987 The main purpose of this feature is to allow \SpecialChar LaTeX
17988 wrapping around specific
17989 branches as user needs.
17992 \begin_layout Enumerate
17993 The layout of a user (or class) specific caption is being defined.
17995 \begin_inset Flex Code
17998 \begin_layout Plain Layout
18004 must be of the form
18005 \begin_inset Quotes eld
18009 \begin_inset Flex Code
18012 \begin_layout Plain Layout
18019 \begin_inset Quotes erd
18023 \begin_inset Flex Code
18026 \begin_layout Plain Layout
18032 specifies the name of the caption as it appears in the menu.
18033 Have a look at the standard caption (
18034 \begin_inset Flex Code
18037 \begin_layout Plain Layout
18043 ), the specific captions of the KOMA-Script classes (
18044 \begin_inset Flex Code
18047 \begin_layout Plain Layout
18054 \begin_inset Flex Code
18057 \begin_layout Plain Layout
18066 \begin_inset space ~
18072 \begin_inset Flex Code
18075 \begin_layout Plain Layout
18081 ) for applications.
18084 \begin_layout Standard
18086 \begin_inset Flex Code
18089 \begin_layout Plain Layout
18095 definition can contain the following entries:
18098 \begin_layout Description
18100 \change_inserted 2047637253 1483963036
18101 \begin_inset Flex Code
18104 \begin_layout Plain Layout
18106 \change_inserted 2047637253 1483900123
18113 \begin_inset Flex Code
18116 \begin_layout Plain Layout
18118 \change_inserted 2047637253 1483962897
18124 =""] This inset will appear in the table of contents of the given type.
18125 An empty string disables.
18126 See also the OutlinerName and the IsTocCaption commands.
18127 This is only implemented for Flex insets.
18131 \begin_layout Description
18132 \begin_inset Flex Code
18135 \begin_layout Plain Layout
18142 \begin_inset Flex Code
18145 \begin_layout Plain Layout
18151 ] Defines argument number of a command\SpecialChar breakableslash
18152 environment associated with the current
18154 The definition must end with
18155 \begin_inset Flex Code
18158 \begin_layout Plain Layout
18166 \begin_inset CommandInset ref
18168 reference "subsec:Paragraph-Styles"
18175 \begin_layout Description
18176 \begin_inset Flex Code
18179 \begin_layout Plain Layout
18185 Preamble for changing language commands; see
18186 \begin_inset CommandInset ref
18188 reference "subsec:I18n"
18195 \begin_layout Description
18196 \begin_inset Flex Code
18199 \begin_layout Plain Layout
18206 \begin_inset Flex Code
18209 \begin_layout Plain Layout
18215 ] The color for the inset's background.
18217 \begin_inset CommandInset ref
18219 reference "chap:Names-of-colors"
18223 for a list of the available color names.
18226 \begin_layout Description
18227 \begin_inset Flex Code
18230 \begin_layout Plain Layout
18237 \begin_inset Flex Code
18240 \begin_layout Plain Layout
18249 \begin_inset space \thinspace{}
18253 \begin_inset Flex Code
18256 \begin_layout Plain Layout
18262 ] Whether to use the content of the inset as the label, when the inset is
18267 \begin_layout Description
18268 \begin_inset Flex Code
18271 \begin_layout Plain Layout
18278 \begin_inset Flex Code
18281 \begin_layout Plain Layout
18287 ] As with paragraph styles, see
18288 \begin_inset CommandInset ref
18290 reference "subsec:Paragraph-Styles"
18295 Note that you need to specify the complete type, e.
18296 \begin_inset space \thinspace{}
18300 \begin_inset space ~
18304 \begin_inset Flex Code
18307 \begin_layout Plain Layout
18308 CopyStyle Flex:<name>
18316 \begin_layout Description
18317 \begin_inset Flex Code
18320 \begin_layout Plain Layout
18327 \begin_inset Flex Code
18330 \begin_layout Plain Layout
18339 \begin_inset space \thinspace{}
18343 \begin_inset Flex Code
18346 \begin_layout Plain Layout
18352 ] Indicates whether the user may employ the Paragraph Settings dialog to
18353 customize the paragraph.
18356 \begin_layout Description
18357 \begin_inset Flex Code
18360 \begin_layout Plain Layout
18367 \begin_inset Flex Code
18370 \begin_layout Plain Layout
18377 \begin_inset Flex Code
18380 \begin_layout Plain Layout
18387 \begin_inset Flex Code
18390 \begin_layout Plain Layout
18396 , describing the rendering style used for the inset's frame and buttons.
18397 Footnotes generally use
18398 \begin_inset Flex Code
18401 \begin_layout Plain Layout
18407 , ERT insets generally
18408 \begin_inset Flex Code
18411 \begin_layout Plain Layout
18417 , and character styles
18418 \begin_inset Flex Code
18421 \begin_layout Plain Layout
18430 \begin_layout Description
18431 \begin_inset Flex Code
18434 \begin_layout Plain Layout
18441 \begin_inset Flex Code
18444 \begin_layout Plain Layout
18453 \begin_inset space \thinspace{}
18459 \begin_inset Flex Code
18462 \begin_layout Plain Layout
18471 \begin_inset Flex Code
18474 \begin_layout Plain Layout
18481 \begin_inset Flex Code
18484 \begin_layout Plain Layout
18491 Indicates whether the environment will stand on its own in the output or
18492 will appear inline with the surrounding text.
18493 If set to false, it is supposed that the \SpecialChar LaTeX
18494 environment ignores white space
18495 (including one newline character) after the
18496 \begin_inset Flex Code
18499 \begin_layout Plain Layout
18512 \begin_inset Flex Code
18515 \begin_layout Plain Layout
18531 \begin_layout Description
18532 \begin_inset Flex Code
18535 \begin_layout Plain Layout
18541 Required at the end of the
18542 \begin_inset Flex Code
18545 \begin_layout Plain Layout
18554 \begin_layout Description
18555 \begin_inset Flex Code
18558 \begin_layout Plain Layout
18564 The font used for both the text body
18570 \begin_inset CommandInset ref
18572 reference "subsec:Font-description"
18577 Note that defining this font automatically defines the
18578 \begin_inset Flex Code
18581 \begin_layout Plain Layout
18587 to the same value, so define this first and define
18588 \begin_inset Flex Code
18591 \begin_layout Plain Layout
18597 later if you want them to be different.
18600 \begin_layout Description
18601 \begin_inset Flex Code
18604 \begin_layout Plain Layout
18605 FixedWidthPreambleEncoding
18611 \begin_inset Flex Code
18614 \begin_layout Plain Layout
18623 \begin_inset space \thinspace{}
18627 \begin_inset Flex Code
18630 \begin_layout Plain Layout
18636 ] Force a fixed width encoding for the translated contents of
18637 \begin_inset Flex Code
18640 \begin_layout Plain Layout
18647 \begin_inset Flex Code
18650 \begin_layout Plain Layout
18656 code generated by this layout.
18657 This is needed for special \SpecialChar LaTeX
18662 that do not work with variable width encodings such as
18667 This setting is ignored if fully Unicode aware \SpecialChar LaTeX
18668 backends such as Xe\SpecialChar TeX
18670 Lua\SpecialChar TeX
18674 \begin_layout Description
18675 \begin_inset Flex Code
18678 \begin_layout Plain Layout
18679 ForceLocalFontSwitch
18685 \begin_inset Flex Code
18688 \begin_layout Plain Layout
18697 \begin_inset space \thinspace{}
18701 \begin_inset Flex Code
18704 \begin_layout Plain Layout
18710 ] When using babel, always use a local font switch (
18711 \begin_inset Flex Code
18714 \begin_layout Plain Layout
18722 ), never a global one (such as
18723 \begin_inset Flex Code
18726 \begin_layout Plain Layout
18737 \begin_layout Description
18738 \begin_inset Flex Code
18741 \begin_layout Plain Layout
18748 \begin_inset Flex Code
18751 \begin_layout Plain Layout
18760 \begin_inset space \thinspace{}
18764 \begin_inset Flex Code
18767 \begin_layout Plain Layout
18774 \begin_inset Quotes eld
18778 \begin_inset Quotes erd
18781 language, leading to Left-to-Right (Latin) output, e.
18782 \begin_inset space \thinspace{}
18786 \begin_inset space \space{}
18789 in \SpecialChar TeX
18794 \begin_layout Description
18795 \begin_inset Flex Code
18798 \begin_layout Plain Layout
18805 \begin_inset Flex Code
18808 \begin_layout Plain Layout
18817 \begin_inset space \thinspace{}
18821 \begin_inset Flex Code
18824 \begin_layout Plain Layout
18830 ] Force a a line break in the \SpecialChar LaTeX
18831 output before the inset starts and after
18833 This assures the inset itself is output on its own lines, for parsing purposes.
18836 \begin_layout Description
18837 \begin_inset Flex Code
18840 \begin_layout Plain Layout
18847 \begin_inset Flex Code
18850 \begin_layout Plain Layout
18859 \begin_inset space \thinspace{}
18863 \begin_inset Flex Code
18866 \begin_layout Plain Layout
18872 ] Indicates whether the
18873 \begin_inset Flex Code
18876 \begin_layout Plain Layout
18882 should be used or, instead, the user can change the paragraph style used
18887 \begin_layout Description
18888 \begin_inset Flex Code
18891 \begin_layout Plain Layout
18898 \begin_inset Flex Code
18901 \begin_layout Plain Layout
18910 \begin_inset space \thinspace{}
18914 \begin_inset Flex Code
18917 \begin_layout Plain Layout
18923 ] As with paragraph styles, see
18924 \begin_inset CommandInset ref
18926 reference "subsec:Paragraph-Styles"
18933 \begin_layout Description
18934 \begin_inset Flex Code
18937 \begin_layout Plain Layout
18943 These tags control the XHTML output.
18945 \begin_inset CommandInset ref
18947 reference "sec:Tags-for-XHTML"
18954 \begin_layout Description
18955 \begin_inset Flex Code
18958 \begin_layout Plain Layout
18965 \begin_inset Flex Code
18968 \begin_layout Plain Layout
18977 \begin_inset space \thinspace{}
18981 \begin_inset Flex Code
18984 \begin_layout Plain Layout
18990 ] Whether to include the contents of this inset in the strings generated
18991 for the `Outline' pane
18992 \change_inserted 2047637253 1483900773
18993 for all table of contents, regardless of the AddToToc setting
18996 One would not, for example, want the content of a footnote in a section
18997 header to be included in the TOC displayed in the outline, but one would
18998 normally want the content of a character style displayed.
18999 Default is false: not to include.
19000 \change_inserted 2047637253 1483900609
19004 \begin_layout Description
19006 \change_inserted 2047637253 1483901257
19007 \begin_inset Flex Code
19010 \begin_layout Plain Layout
19012 \change_inserted 2047637253 1483900725
19019 \begin_inset Flex Code
19022 \begin_layout Plain Layout
19024 \change_inserted 2047637253 1483900620
19033 \begin_inset space \thinspace{}
19037 \begin_inset Flex Code
19040 \begin_layout Plain Layout
19042 \change_inserted 2047637253 1483900620
19048 ] If this is set to 1 and AddToToc is enabled, the inset adds a summary
19049 of its contents in its item in the table of contents.
19050 Otherwise, only the label appears.
19055 \begin_layout Description
19056 \begin_inset Flex Code
19059 \begin_layout Plain Layout
19068 \begin_inset Flex Code
19071 \begin_layout Plain Layout
19080 \begin_inset space \thinspace{}
19084 \begin_inset Flex Code
19087 \begin_layout Plain Layout
19093 ] As with paragraph styles, see
19094 \begin_inset CommandInset ref
19096 reference "subsec:Paragraph-Styles"
19103 \begin_layout Description
19104 \begin_inset Flex Code
19107 \begin_layout Plain Layout
19113 The font used for the label.
19115 \begin_inset CommandInset ref
19117 reference "subsec:Font-description"
19122 Note that this definition can never appear before
19123 \begin_inset Flex Code
19126 \begin_layout Plain Layout
19132 , lest it be ineffective.
19135 \begin_layout Description
19136 \begin_inset Flex Code
19139 \begin_layout Plain Layout
19146 \begin_inset Flex Code
19149 \begin_layout Plain Layout
19156 \begin_inset Quotes erd
19160 \begin_inset Quotes erd
19163 ] What will be displayed on the button or elsewhere as the inset label.
19165 \begin_inset Flex Code
19168 \begin_layout Plain Layout
19176 \begin_inset Flex Code
19179 \begin_layout Plain Layout
19185 ) modify this label on the fly.
19188 \begin_layout Description
19189 \begin_inset Flex Code
19192 \begin_layout Plain Layout
19198 Language dependent preamble; see
19199 \begin_inset CommandInset ref
19201 reference "subsec:I18n"
19208 \begin_layout Description
19209 \begin_inset Flex Code
19212 \begin_layout Plain Layout
19219 \begin_inset Flex Code
19222 \begin_layout Plain Layout
19228 ] The name of the corresponding \SpecialChar LaTeX
19230 Either the environment or command name.
19233 \begin_layout Description
19234 \begin_inset Flex Code
19237 \begin_layout Plain Layout
19244 \begin_inset Flex Code
19247 \begin_layout Plain Layout
19253 ] The optional parameter for the corresponding
19254 \begin_inset Flex Code
19257 \begin_layout Plain Layout
19263 stuff, including possible bracket pairs like
19264 \begin_inset Flex Code
19267 \begin_layout Plain Layout
19274 This parameter cannot be changed from within \SpecialChar LyX
19276 \begin_inset Flex Code
19279 \begin_layout Plain Layout
19285 for customizable parameters).
19286 It will be output as is after all \SpecialChar LaTeX
19288 \begin_inset Flex Code
19291 \begin_layout Plain Layout
19300 \begin_layout Description
19301 \begin_inset Flex Code
19304 \begin_layout Plain Layout
19311 \begin_inset Flex Code
19314 \begin_layout Plain Layout
19315 Command, Environment, None
19320 ] How the style should be translated into \SpecialChar LaTeX
19325 \begin_layout Plain Layout
19326 \begin_inset Flex Code
19329 \begin_layout Plain Layout
19335 is perhaps a bit misleading, since these rules apply to SGML classes too.
19336 Visit the SGML class files for specific examples.
19345 \begin_layout Description
19346 \begin_inset Flex Code
19349 \begin_layout Plain Layout
19355 means nothing special
19358 \begin_layout Description
19359 \begin_inset Flex Code
19362 \begin_layout Plain Layout
19369 \begin_inset Flex Code
19372 \begin_layout Plain Layout
19379 {\SpecialChar ldots
19388 \begin_layout Description
19389 \begin_inset Flex Code
19392 \begin_layout Plain Layout
19399 \begin_inset Flex Code
19402 \begin_layout Plain Layout
19409 }\SpecialChar ldots
19424 \begin_layout Standard
19425 Putting the last few things together, the \SpecialChar LaTeX
19426 output will be either:
19429 \begin_layout LyX-Code
19432 LatexName[LatexParam]{\SpecialChar ldots
19436 \begin_layout Standard
19440 \begin_layout LyX-Code
19443 begin{LatexName}[LatexParam] \SpecialChar ldots
19449 \begin_layout Standard
19450 depending upon the \SpecialChar LaTeX
19455 \begin_layout Description
19456 \begin_inset Flex Code
19459 \begin_layout Plain Layout
19466 \begin_inset Flex Code
19469 \begin_layout Plain Layout
19475 ] A string that is put at the beginning of the layout content.
19476 A line break in the output can be indicated by
19477 \begin_inset Flex Code
19480 \begin_layout Plain Layout
19489 \begin_layout Description
19490 \begin_inset Flex Code
19493 \begin_layout Plain Layout
19500 \begin_inset Flex Code
19503 \begin_layout Plain Layout
19510 \begin_inset Flex Code
19513 \begin_layout Plain Layout
19520 \begin_inset Flex Code
19523 \begin_layout Plain Layout
19530 \begin_inset Flex Code
19533 \begin_layout Plain Layout
19539 (indicating a dummy definition ending definitions of charstyles, etc).
19540 This entry is required in and is only meaningful for Flex insets.
19541 Among other things, it determines on which menu this inset will appear.
19543 \begin_inset Flex Code
19546 \begin_layout Plain Layout
19553 \begin_inset Flex Code
19556 \begin_layout Plain Layout
19562 will automatically set
19563 \begin_inset Flex Code
19566 \begin_layout Plain Layout
19573 \begin_inset Flex Code
19576 \begin_layout Plain Layout
19584 \begin_inset Flex Code
19587 \begin_layout Plain Layout
19593 can be set to true, or
19594 \begin_inset Flex Code
19597 \begin_layout Plain Layout
19604 \begin_inset Flex Code
19607 \begin_layout Plain Layout
19613 insets by setting it
19618 \begin_inset Flex Code
19621 \begin_layout Plain Layout
19630 \begin_layout Description
19631 \begin_inset Flex Code
19634 \begin_layout Plain Layout
19641 \begin_inset Flex Code
19644 \begin_layout Plain Layout
19653 \begin_inset space \thinspace{}
19657 \begin_inset Flex Code
19660 \begin_layout Plain Layout
19666 ] Whether multiple paragraphs are permitted in this inset.
19668 \begin_inset Flex Code
19671 \begin_layout Plain Layout
19677 to the same value and
19678 \begin_inset Flex Code
19681 \begin_layout Plain Layout
19687 to the opposite value.
19688 These can be reset to other values, if they are used
19693 \begin_inset Flex Code
19696 \begin_layout Plain Layout
19706 \begin_layout Description
19707 \begin_inset Flex Code
19710 \begin_layout Plain Layout
19717 \begin_inset Flex Code
19720 \begin_layout Plain Layout
19729 \begin_inset space \thinspace{}
19733 \begin_inset Flex Code
19736 \begin_layout Plain Layout
19742 ] Whether fragile commands in this inset should be
19743 \begin_inset Flex Code
19746 \begin_layout Plain Layout
19759 whether the command should itself be protected.) Default is false.
19762 \begin_layout Description
19763 \begin_inset Flex Code
19766 \begin_layout Plain Layout
19773 \begin_inset Flex Code
19776 \begin_layout Plain Layout
19782 ] Deletes an existing
19783 \begin_inset Flex Code
19786 \begin_layout Plain Layout
19795 \begin_layout Description
19796 \begin_inset Flex Code
19799 \begin_layout Plain Layout
19806 \begin_inset Flex Code
19809 \begin_layout Plain Layout
19816 \begin_inset Flex Code
19819 \begin_layout Plain Layout
19825 that has replaced this
19826 \begin_inset Flex Code
19829 \begin_layout Plain Layout
19836 This is used to rename an
19837 \begin_inset Flex Code
19840 \begin_layout Plain Layout
19846 , while keeping backward compatibility.
19849 \begin_layout Description
19850 \begin_inset Flex Code
19853 \begin_layout Plain Layout
19860 \begin_inset Flex Code
19863 \begin_layout Plain Layout
19872 \begin_inset space \thinspace{}
19876 \begin_inset Flex Code
19879 \begin_layout Plain Layout
19885 ] As with paragraph styles, see
19886 \begin_inset CommandInset ref
19888 reference "subsec:Paragraph-Styles"
19896 \begin_layout Description
19897 \begin_inset Flex Code
19900 \begin_layout Plain Layout
19907 \begin_inset Flex Code
19910 \begin_layout Plain Layout
19919 \begin_inset space \thinspace{}
19923 \begin_inset Flex Code
19926 \begin_layout Plain Layout
19932 ] As with paragraph styles, see
19933 \begin_inset CommandInset ref
19935 reference "subsec:Paragraph-Styles"
19943 \begin_layout Description
19944 \begin_inset Flex Code
19947 \begin_layout Plain Layout
19953 As with paragraph styles, see
19954 \begin_inset CommandInset ref
19956 reference "subsec:Paragraph-Styles"
19963 \begin_layout Description
19964 \begin_inset Flex Code
19967 \begin_layout Plain Layout
19974 \begin_inset Flex Code
19977 \begin_layout Plain Layout
19983 ] The prefix to use when creating labels referring to insets of this type.
19984 This allows the use of formatted references.
19987 \begin_layout Description
19988 \begin_inset Flex Code
19991 \begin_layout Plain Layout
19998 \begin_inset Flex Code
20001 \begin_layout Plain Layout
20007 ] As with paragraph styles, see
20008 \begin_inset CommandInset ref
20010 reference "subsec:Paragraph-Styles"
20017 \begin_layout Description
20018 \begin_inset Flex Code
20021 \begin_layout Plain Layout
20028 \begin_inset Flex Code
20031 \begin_layout Plain Layout
20040 \begin_inset space \thinspace{}
20044 \begin_inset Flex Code
20047 \begin_layout Plain Layout
20053 ] Resets the \SpecialChar LaTeX
20054 arguments of this layout (as defined via the
20055 \begin_inset Flex Code
20058 \begin_layout Plain Layout
20065 This is useful if you have copied a style via
20066 \begin_inset Flex Code
20069 \begin_layout Plain Layout
20075 , but you do not want to inherit its (required and optional) arguments.
20078 \begin_layout Description
20079 \begin_inset Flex Code
20082 \begin_layout Plain Layout
20089 \begin_inset Flex Code
20092 \begin_layout Plain Layout
20099 \begin_inset space \thinspace{}
20103 \begin_inset Flex Code
20106 \begin_layout Plain Layout
20114 ] Whether this inset should use the font of its surrounding environment
20116 Default is false: use the font of the surrounding environment.
20119 \begin_layout Description
20120 \begin_inset Flex Code
20123 \begin_layout Plain Layout
20130 \begin_inset Flex Code
20133 \begin_layout Plain Layout
20139 ] A string that is put at the end of the layout content.
20140 A line break in the output can be indicated by
20141 \begin_inset Flex Code
20144 \begin_layout Plain Layout
20153 \begin_layout Description
20154 \begin_inset Flex Code
20157 \begin_layout Plain Layout
20164 \begin_inset Flex Code
20167 \begin_layout Plain Layout
20174 \begin_inset space \thinspace{}
20178 \begin_inset Flex Code
20181 \begin_layout Plain Layout
20189 ] Allow spell-checking the contents of this inset.
20193 \begin_layout Subsection
20195 \begin_inset CommandInset label
20197 name "subsec:Counters"
20204 \begin_layout Standard
20205 It is necessary to define the counters (
20206 \begin_inset Flex Noun
20209 \begin_layout Plain Layout
20216 \begin_inset Flex Noun
20219 \begin_layout Plain Layout
20225 , \SpecialChar ldots
20226 ) in the text class itself.
20227 The standard counters are defined in the file
20228 \begin_inset Flex Code
20231 \begin_layout Plain Layout
20237 , so you may have to do no more than add
20240 \begin_layout LyX-Code
20241 Input stdcounters.inc
20244 \begin_layout Standard
20245 to your layout file to get them to work.
20246 But if you want to define custom counters, then you can do so.
20247 The counter declaration must begin with:
20250 \begin_layout LyX-Code
20251 Counter CounterName
20254 \begin_layout Standard
20256 \begin_inset Flex Code
20259 \begin_layout Plain Layout
20265 ' is replaced by the name of the counter.
20266 And it must end with
20267 \begin_inset Quotes eld
20271 \begin_inset Flex Code
20274 \begin_layout Plain Layout
20281 \begin_inset Quotes erd
20285 The following parameters can also be used:
20288 \begin_layout Description
20289 \begin_inset Flex Code
20292 \begin_layout Plain Layout
20299 \begin_inset Flex Code
20302 \begin_layout Plain Layout
20308 ] Sets the initial value for the counter, to which it will be reset whenever
20310 Normally, one will want the default, 1.
20313 \begin_layout Description
20314 \begin_inset Flex Code
20317 \begin_layout Plain Layout
20324 \begin_inset Flex Code
20327 \begin_layout Plain Layout
20334 \begin_inset Quotes erd
20338 \begin_inset Quotes erd
20341 ] When defined, this string defines how the counter is displayed.
20342 Setting this value sets
20343 \begin_inset Flex Code
20346 \begin_layout Plain Layout
20347 LabelStringAppendix
20353 The following special constructs can be used in the string:
20357 \begin_layout Itemize
20358 \begin_inset Flex Code
20361 \begin_layout Plain Layout
20369 will be replaced by the expansion of the
20370 \begin_inset Flex Code
20373 \begin_layout Plain Layout
20380 \begin_inset Flex Code
20383 \begin_layout Plain Layout
20384 LabelStringAppendix
20390 \begin_inset Flex Code
20393 \begin_layout Plain Layout
20403 \begin_layout Itemize
20404 counter values can be expressed using \SpecialChar LaTeX
20406 \begin_inset Newline newline
20410 \begin_inset Flex Code
20413 \begin_layout Plain Layout
20430 \begin_inset Flex Code
20433 \begin_layout Plain Layout
20445 \begin_layout Plain Layout
20455 Actually, the situation is a bit more complicated: any
20474 other than those described below will produce arabic numerals.
20475 It would not be surprising to see this change in the future.
20481 \begin_inset Flex Code
20484 \begin_layout Plain Layout
20490 : 1, 2, 3,\SpecialChar ldots
20492 \begin_inset Flex Code
20495 \begin_layout Plain Layout
20501 for lower-case letters: a, b, c, \SpecialChar ldots
20503 \begin_inset Flex Code
20506 \begin_layout Plain Layout
20512 for upper-case letters: A, B, C, \SpecialChar ldots
20514 \begin_inset Flex Code
20517 \begin_layout Plain Layout
20523 for lower-case roman numerals: i, ii, iii, \SpecialChar ldots
20525 \begin_inset Flex Code
20528 \begin_layout Plain Layout
20534 for upper-case roman numerals: I, II, III\SpecialChar ldots
20536 \begin_inset Flex Code
20539 \begin_layout Plain Layout
20545 for hebrew numerals.
20549 \begin_layout Standard
20550 If LabelString is not defined, a default value is constructed as follows:
20551 if the counter has a master counter
20552 \begin_inset Flex Code
20555 \begin_layout Plain Layout
20562 \begin_inset Flex Code
20565 \begin_layout Plain Layout
20572 \begin_inset Newline newline
20576 \begin_inset Flex Code
20579 \begin_layout Plain Layout
20589 is used; otherwise the string
20590 \begin_inset Flex Code
20593 \begin_layout Plain Layout
20604 \begin_layout Description
20605 \begin_inset Flex Code
20608 \begin_layout Plain Layout
20609 LabelStringAppendix
20615 \begin_inset Flex Code
20618 \begin_layout Plain Layout
20625 \begin_inset Quotes erd
20629 \begin_inset Quotes erd
20633 \begin_inset Flex Code
20636 \begin_layout Plain Layout
20642 , but for use in the Appendix.
20645 \begin_layout Description
20646 \begin_inset Flex Code
20649 \begin_layout Plain Layout
20656 \begin_inset Flex Code
20659 \begin_layout Plain Layout
20666 \begin_inset Quotes erd
20670 \begin_inset Quotes erd
20673 ] A format for use with formatted references to this counter.
20674 For example, one might want to have references to section numbers appear
20676 \begin_inset Quotes eld
20680 \begin_inset Quotes erd
20684 The string should contain
20685 \begin_inset Quotes eld
20689 \begin_inset Quotes erd
20693 This will be replaced by the counter number itself.
20694 So, for sections, it would be: Section ##.
20697 \begin_layout Description
20698 \begin_inset Flex Code
20701 \begin_layout Plain Layout
20708 \begin_inset Flex Code
20711 \begin_layout Plain Layout
20718 \begin_inset Quotes erd
20722 \begin_inset Quotes erd
20725 ] If this is set to the name of another counter, the present counter will
20726 be reset every time the other one is increased.
20728 \begin_inset Flex Code
20731 \begin_layout Plain Layout
20738 \begin_inset Flex Code
20741 \begin_layout Plain Layout
20750 \begin_layout Subsection
20752 \begin_inset CommandInset label
20754 name "subsec:Font-description"
20761 \begin_layout Standard
20762 A font description looks like this:
20765 \begin_layout LyX-Code
20779 \begin_layout LyX-Code
20783 \begin_layout LyX-Code
20787 \begin_layout Standard
20788 The following commands are available:
20791 \begin_layout Description
20792 \begin_inset Flex Code
20795 \begin_layout Plain Layout
20802 \begin_inset Flex Code
20805 \begin_layout Plain Layout
20814 \begin_inset Flex Code
20817 \begin_layout Plain Layout
20824 \begin_inset Flex Code
20827 \begin_layout Plain Layout
20834 \begin_inset Flex Code
20837 \begin_layout Plain Layout
20844 \begin_inset Flex Code
20847 \begin_layout Plain Layout
20854 \begin_inset Flex Code
20857 \begin_layout Plain Layout
20864 \begin_inset Flex Code
20867 \begin_layout Plain Layout
20874 \begin_inset Flex Code
20877 \begin_layout Plain Layout
20884 \begin_inset Flex Code
20887 \begin_layout Plain Layout
20894 \begin_inset Flex Code
20897 \begin_layout Plain Layout
20904 \begin_inset Flex Code
20907 \begin_layout Plain Layout
20914 \begin_inset Flex Code
20917 \begin_layout Plain Layout
20924 \begin_inset Flex Code
20927 \begin_layout Plain Layout
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
20964 \begin_inset Flex Code
20967 \begin_layout Plain Layout
20974 \begin_inset Flex Code
20977 \begin_layout Plain Layout
20984 \begin_inset Flex Code
20987 \begin_layout Plain Layout
20994 \begin_inset Flex Code
20997 \begin_layout Plain Layout
21006 \begin_layout Description
21007 \begin_inset Flex Code
21010 \begin_layout Plain Layout
21017 \begin_inset Flex Code
21020 \begin_layout Plain Layout
21029 \begin_inset Flex Code
21032 \begin_layout Plain Layout
21039 \begin_inset Flex Code
21042 \begin_layout Plain Layout
21051 \begin_layout Description
21052 \begin_inset Flex Code
21055 \begin_layout Plain Layout
21062 \begin_inset Flex Code
21065 \begin_layout Plain Layout
21071 ] Valid arguments are:
21072 \begin_inset Flex Code
21075 \begin_layout Plain Layout
21082 \begin_inset Flex Code
21085 \begin_layout Plain Layout
21092 \begin_inset Flex Code
21095 \begin_layout Plain Layout
21102 \begin_inset Flex Code
21105 \begin_layout Plain Layout
21112 \begin_inset Flex Code
21115 \begin_layout Plain Layout
21122 \begin_inset Flex Code
21125 \begin_layout Plain Layout
21132 \begin_inset Flex Code
21135 \begin_layout Plain Layout
21142 \begin_inset Flex Code
21145 \begin_layout Plain Layout
21152 \begin_inset Flex Code
21155 \begin_layout Plain Layout
21162 \begin_inset Flex Code
21165 \begin_layout Plain Layout
21172 \begin_inset Flex Code
21175 \begin_layout Plain Layout
21182 \begin_inset Flex Code
21185 \begin_layout Plain Layout
21192 Each of these turns on or off the corresponding attribute.
21194 \begin_inset Flex Code
21197 \begin_layout Plain Layout
21203 turns on emphasis, and
21204 \begin_inset Flex Code
21207 \begin_layout Plain Layout
21215 \begin_inset Newline newline
21218 If the latter seems puzzling, remember that the font settings for the present
21219 context are generally inherited from the surrounding context.
21221 \begin_inset Flex Code
21224 \begin_layout Plain Layout
21230 would turn off the emphasis that was anyway in effect, say, in a theorem
21234 \begin_layout Description
21235 \begin_inset Flex Code
21238 \begin_layout Plain Layout
21245 \begin_inset Flex Code
21248 \begin_layout Plain Layout
21257 \begin_inset Flex Code
21260 \begin_layout Plain Layout
21269 \begin_layout Description
21270 \begin_inset Flex Code
21273 \begin_layout Plain Layout
21280 \begin_inset Flex Code
21283 \begin_layout Plain Layout
21292 \begin_inset Flex Code
21295 \begin_layout Plain Layout
21302 \begin_inset Flex Code
21305 \begin_layout Plain Layout
21312 \begin_inset Flex Code
21315 \begin_layout Plain Layout
21324 \begin_layout Description
21325 \begin_inset Flex Code
21328 \begin_layout Plain Layout
21335 \begin_inset Flex Code
21338 \begin_layout Plain Layout
21345 \begin_inset Flex Code
21348 \begin_layout Plain Layout
21355 \begin_inset Flex Code
21358 \begin_layout Plain Layout
21367 \begin_inset Flex Code
21370 \begin_layout Plain Layout
21377 \begin_inset Flex Code
21380 \begin_layout Plain Layout
21387 \begin_inset Flex Code
21390 \begin_layout Plain Layout
21397 \begin_inset Flex Code
21400 \begin_layout Plain Layout
21407 \begin_inset Flex Code
21410 \begin_layout Plain Layout
21419 \begin_layout Subsection
21421 \change_inserted -712698321 1483869872
21422 \begin_inset CommandInset label
21424 name "subsec:Citation-engine-description"
21428 Citation engine description
21431 \begin_layout Standard
21433 \change_inserted -712698321 1483875281
21435 \begin_inset Flex Code
21438 \begin_layout Plain Layout
21440 \change_inserted -712698321 1483869913
21448 blocks, as used mainly in cite engine files (see
21449 \begin_inset CommandInset ref
21451 reference "subsec:Cite-Engine-Files"
21458 ), define the citation commands provided by a specific
21459 \begin_inset Quotes eld
21463 \begin_inset Quotes erd
21467 A cite engine, in \SpecialChar LyX
21468 terms, is way specific way to format citations, using
21469 numbers, author names and/or years.
21470 Currently, \SpecialChar LyX
21471 supports three such engine types, namely:
21474 \begin_layout Enumerate
21476 \change_inserted -712698321 1483875764
21477 \begin_inset Flex Code
21480 \begin_layout Plain Layout
21482 \change_inserted -712698321 1483870430
21490 : the default Bib\SpecialChar TeX
21491 way to format citations, a simple numeric style (e.
21492 \begin_inset space \thinspace{}
21496 \begin_inset Quotes eld
21500 \begin_inset Quotes erd
21506 \begin_layout Enumerate
21508 \change_inserted -712698321 1483875766
21509 \begin_inset Flex Code
21512 \begin_layout Plain Layout
21514 \change_inserted -712698321 1483870434
21522 : Harvard-styled citations using author names and publication year (e.
21523 \begin_inset space \thinspace{}
21527 \begin_inset Quotes eld
21530 Smith and Miller (2017b)
21531 \begin_inset Quotes erd
21537 \begin_layout Enumerate
21539 \change_inserted -712698321 1483875769
21540 \begin_inset Flex Code
21543 \begin_layout Plain Layout
21545 \change_inserted -712698321 1483870457
21553 : extended numerical citations that also allow for author or title next
21555 \begin_inset space \thinspace{}
21559 \begin_inset Quotes eld
21562 Smith and Miller [1]
21563 \begin_inset Quotes erd
21569 \begin_layout Standard
21571 \change_inserted -712698321 1483870566
21572 \begin_inset Flex Code
21575 \begin_layout Plain Layout
21577 \change_inserted -712698321 1483870552
21583 blocks look like this:
21586 \begin_layout LyX-Code
21588 \change_inserted -712698321 1483870590
21592 \begin_layout LyX-Code
21594 \change_inserted -712698321 1483870615
21598 \begin_layout LyX-Code
21600 \change_inserted -712698321 1483870633
21604 \begin_layout LyX-Code
21606 \change_inserted -712698321 1483870652
21607 citeyearpar[][]=parencite*
21610 \begin_layout LyX-Code
21612 \change_inserted -712698321 1483870652
21616 \begin_layout LyX-Code
21618 \change_inserted -712698321 1483870668
21622 \begin_layout Standard
21624 \change_inserted -712698321 1483871113
21626 \begin_inset Flex Code
21629 \begin_layout Plain Layout
21631 \change_inserted -712698321 1483871085
21637 denotes the engine.
21638 The individual lines respectively define a cite command or cite command
21639 paradigm supported by this engine.
21640 The line can be as simple as a cite command that is used both to name the
21641 respective \SpecialChar LyX
21642 command and the \SpecialChar LaTeX
21643 output or more complex in order to differentiate
21646 \change_deleted -712698321 1483871114
21650 \begin_layout Standard
21652 \change_inserted -712698321 1483871119
21653 The full syntax is:
21656 \begin_layout LyX-Code
21658 \change_inserted -712698321 1484997816
21659 LyXName|alias$*<!_stardesc!_stardesctooltip>[][]=latexcmd
21662 \begin_layout Itemize
21664 \change_inserted -712698321 1483871222
21665 \begin_inset Flex Code
21668 \begin_layout Plain Layout
21670 \change_inserted -712698321 1483871181
21678 : The name as used in the
21679 \begin_inset Flex Code
21682 \begin_layout Plain Layout
21684 \change_inserted -712698321 1483871216
21696 \begin_layout Standard
21698 \change_inserted -712698321 1483871487
21699 For portability reasons, we try to use the same name for same-formatted
21700 commands in different cite packages (thus many names stem from natbib,
21701 and thus we need to differentiate a
21702 \begin_inset Flex Code
21705 \begin_layout Plain Layout
21707 \change_inserted -712698321 1483871402
21713 sometimes, if the \SpecialChar LaTeX
21714 command names differ).
21718 \begin_layout Itemize
21720 \change_inserted -712698321 1483871583
21721 \begin_inset Flex Code
21724 \begin_layout Plain Layout
21726 \change_inserted -712698321 1483871186
21734 : a (comma-separated) list of commands that fall back to the given
21735 \begin_inset Flex Code
21738 \begin_layout Plain Layout
21740 \change_inserted -712698321 1483871257
21746 in the current engine.
21747 This eases the switch of citation packages and engines.
21749 \begin_inset Flex Code
21752 \begin_layout Plain Layout
21754 \change_inserted -712698321 1483871559
21761 \begin_inset Flex Code
21764 \begin_layout Plain Layout
21766 \change_inserted -712698321 1483871278
21774 in layout definitions.
21777 \begin_layout Itemize
21779 \change_inserted -712698321 1483871307
21780 \begin_inset Flex Code
21783 \begin_layout Plain Layout
21785 \change_inserted -712698321 1483871296
21793 : The actual \SpecialChar LaTeX
21794 command that is output.
21798 \begin_layout Standard
21800 \change_inserted -712698321 1483871348
21801 \begin_inset Flex Code
21804 \begin_layout Plain Layout
21806 \change_inserted -712698321 1483871316
21815 \begin_inset Flex Code
21818 \begin_layout Plain Layout
21820 \change_inserted -712698321 1483871321
21830 \begin_inset Flex Code
21833 \begin_layout Plain Layout
21835 \change_inserted -712698321 1483871333
21842 \begin_inset Flex Code
21845 \begin_layout Plain Layout
21847 \change_inserted -712698321 1483871340
21853 will be output to \SpecialChar LaTeX
21857 \begin_layout Standard
21859 \change_inserted -712698321 1483871604
21863 \begin_layout Itemize
21865 \change_inserted -712698321 1483871664
21866 Capitalization indicates that the command also has a capitalized form (
21867 \begin_inset Flex Code
21870 \begin_layout Plain Layout
21872 \change_inserted -712698321 1483871622
21884 \begin_inset Flex Code
21887 \begin_layout Plain Layout
21889 \change_inserted -712698321 1483871626
21900 These usually enforce up-casing of name prefixes (
21905 \begin_inset Formula $\Rightarrow$
21915 \begin_layout Itemize
21917 \change_inserted -712698321 1483871690
21919 \begin_inset Flex Code
21922 \begin_layout Plain Layout
21924 \change_inserted -712698321 1483871670
21932 indicate the number of optional arguments (there can be 0–2).
21935 \begin_layout Itemize
21937 \change_inserted -712698321 1483871747
21939 \begin_inset Flex Code
21942 \begin_layout Plain Layout
21944 \change_inserted -712698321 1483871698
21952 indicates there is a starred version of the command (
21953 \begin_inset Flex Code
21956 \begin_layout Plain Layout
21958 \change_inserted -712698321 1483871718
21970 \begin_inset Flex Code
21973 \begin_layout Plain Layout
21975 \change_inserted -712698321 1483871724
21990 \begin_layout Standard
21992 \change_inserted -712698321 1483871864
21993 By default, the starred version means: Output all authors even if it should
21995 \begin_inset Quotes eld
21999 \begin_inset Quotes erd
22003 \begin_inset Flex Code
22006 \begin_layout Plain Layout
22008 \change_inserted -712698321 1483871835
22019 \begin_layout Standard
22021 \change_inserted -712698321 1483872045
22022 If the star has a different meaning for a given command, it can be specified
22024 \begin_inset Flex Code
22027 \begin_layout Plain Layout
22029 \change_inserted -712698321 1483871856
22030 <!_stardesc!_stardesctooltip>
22038 Maximal two translatable macro keywords, marked by the prefix
22039 \begin_inset Flex Code
22042 \begin_layout Plain Layout
22044 \change_inserted -712698321 1483872014
22053 The first points to the string that replaces the
22054 \begin_inset Quotes eld
22058 \begin_inset Quotes erd
22061 checkbox label in the citation dialog, the second one to an optional tool
22062 tip for this checkbox.
22066 \begin_layout Standard
22068 \change_inserted -712698321 1483872164
22069 Note that these two macros have to be defined in a
22070 \begin_inset Flex Code
22073 \begin_layout Plain Layout
22075 \change_inserted -712698321 1483871983
22083 (see next section), dropping the
22084 \begin_inset Flex Code
22087 \begin_layout Plain Layout
22089 \change_inserted -712698321 1483872023
22097 from the prefix, like this:
22100 \begin_layout LyX-Code
22102 \change_inserted -712698321 1483872092
22103 _stardesc Sta&rred command label
22106 \begin_layout LyX-Code
22108 \change_inserted -712698321 1484997832
22109 _stardesctooltip Tooltip for the starred command checkbox.
22113 \begin_layout Itemize
22115 \change_inserted -712698321 1484997948
22117 \begin_inset Flex Code
22120 \begin_layout Plain Layout
22122 \change_inserted -712698321 1484997871
22130 indicates that this command features
22131 \begin_inset Quotes eld
22134 qualified citation lists
22135 \begin_inset Quotes erd
22143 -specific feature for multi-reference citations where an individual pre-
22144 and postnote can be given to each reference in the list.
22145 Please refer to the
22149 manual for details.
22152 \begin_layout Subsection
22153 \begin_inset CommandInset label
22155 name "subsec:Citation-format-description"
22159 Citation format description
22162 \begin_layout Standard
22164 \begin_inset Flex Code
22167 \begin_layout Plain Layout
22173 blocks are used to describe how bibliographic information should be displayed,
22174 both within \SpecialChar LyX
22175 itself (in the citation dialog and in tooltips, for example)
22176 and in XHTML output.
22177 Such a block might look like this:
22180 \begin_layout LyX-Code
22184 \begin_layout LyX-Code
22188 \begin_layout LyX-Code
22192 \begin_layout LyX-Code
22194 \change_inserted -712698321 1483867197
22198 \begin_layout Standard
22200 \change_inserted -712698321 1483867200
22204 \begin_layout LyX-Code
22206 \change_inserted -712698321 1483867195
22210 \begin_layout LyX-Code
22212 \change_inserted -712698321 1483867204
22216 \begin_layout LyX-Code
22218 \change_inserted -712698321 1483867359
22222 \begin_layout LyX-Code
22224 \change_inserted -712698321 1483867195
22230 \begin_layout Standard
22232 \change_inserted -712698321 1483867269
22234 \change_deleted -712698321 1483867270
22236 \change_inserted -712698321 1483867270
22239 he individual lines define how the bibliographic information associated
22240 with an article or book, respectively, is to be displayed, and such a definitio
22241 n can be given for any
22242 \change_deleted -712698321 1483867550
22244 \change_inserted -712698321 1483867550
22246 \begin_inset Quotes els
22252 \change_deleted -712698321 1483867552
22254 \change_inserted -712698321 1483867552
22256 \begin_inset Quotes ers
22261 that might be present in a Bib\SpecialChar TeX
22264 defines a default format in the source code that will be used if no specific
22265 definition has been given.
22267 predefines several formats in the file
22268 \begin_inset Flex Code
22271 \begin_layout Plain Layout
22277 , which is included in most of \SpecialChar LyX
22278 's document classes.
22279 \change_inserted -712698321 1483867288
22283 \begin_layout Standard
22285 \change_inserted -712698321 1483875512
22286 In the second case, the lines define how a specific citation command (in
22288 \begin_inset Flex Code
22291 \begin_layout Plain Layout
22293 \change_inserted -712698321 1483867674
22304 \begin_inset Flex Code
22307 \begin_layout Plain Layout
22309 \change_inserted -712698321 1483867679
22319 ) is to be displayed on the citation inset label, in the citation dialog,
22320 menu or XHTML output.
22322 defines such formats for the citation style variants it supports via
22324 Document\SpecialChar menuseparator
22325 Setting\SpecialChar menuseparator
22326 Bibliography\SpecialChar ldots
22330 \begin_inset Flex Code
22333 \begin_layout Plain Layout
22335 \change_inserted -712698321 1483875503
22341 files that are shipped with \SpecialChar LyX
22343 \begin_inset CommandInset ref
22345 reference "subsec:Cite-Engine-Files"
22357 \begin_layout Standard
22358 The definitions use a simple language that allows Bib\SpecialChar TeX
22359 keys to be replaced
22361 Keys should be enclosed in
22362 \begin_inset Flex Code
22365 \begin_layout Plain Layout
22372 \begin_inset Flex Code
22375 \begin_layout Plain Layout
22382 So a simple definition might look like this:
22385 \begin_layout LyX-Code
22387 \begin_inset Quotes eld
22391 \begin_inset Quotes erd
22397 \begin_layout Standard
22398 This would print the author, followed by a comma, followed by the title,
22399 in quotes, followed by a period.
22402 \begin_layout Standard
22403 Of course, sometimes you may want to print a key only if it exists.
22404 This can be done by using a conditional construction, such as:
22405 \begin_inset Flex Code
22408 \begin_layout Plain Layout
22410 \begin_inset space ~
22420 \begin_inset Flex Code
22423 \begin_layout Plain Layout
22429 key exists, then print
22430 \begin_inset Quotes eld
22434 \begin_inset space ~
22438 \begin_inset Quotes erd
22441 followed by the volume key.
22442 It is also possible to have an else clause in the conditional, such as:
22443 \begin_inset Newline newline
22447 \begin_inset Flex Code
22450 \begin_layout Plain Layout
22451 {%author%[[%author%]][[%editor%, ed.]]}
22457 \begin_inset Newline newline
22461 \begin_inset Flex Code
22464 \begin_layout Plain Layout
22470 key is printed if it exists; otherwise, the editor key is printed, followed
22472 \begin_inset Quotes eld
22476 \begin_inset space ~
22480 \begin_inset Quotes erd
22483 Note that the key is again enclosed in
22484 \begin_inset Flex Code
22487 \begin_layout Plain Layout
22493 signs; the entire conditional is enclosed in braces; and the if and else
22494 clauses are enclosed in double brackets,
22495 \begin_inset Quotes eld
22499 \begin_inset Flex Code
22502 \begin_layout Plain Layout
22509 \begin_inset Quotes eld
22513 \begin_inset Quotes eld
22517 \begin_inset Flex Code
22520 \begin_layout Plain Layout
22527 \begin_inset Quotes erd
22531 There must be no space between any of these.
22532 \change_inserted -712698321 1483867855
22536 \begin_layout Standard
22538 \change_inserted -712698321 1483867910
22539 Next to the entry keys, there are some special keys that can be used for
22540 these conditionals:
22543 \begin_layout Itemize
22545 \change_inserted -712698321 1483868049
22546 \begin_inset Flex Code
22549 \begin_layout Plain Layout
22551 \change_inserted -712698321 1483867962
22552 {%dialog%[[true]][[false]]}
22560 \begin_inset Quotes eld
22564 \begin_inset Quotes erd
22567 part for dialogs and menus, the
22568 \begin_inset Quotes eld
22572 \begin_inset Quotes erd
22575 part for other contexts (workarea, export)
22578 \begin_layout Itemize
22580 \change_inserted -712698321 1483868068
22581 \begin_inset Flex Code
22584 \begin_layout Plain Layout
22586 \change_inserted -712698321 1483868052
22587 {%export%[[true]][[false]]}
22593 \begin_inset Quotes eld
22597 \begin_inset Quotes erd
22600 part for export and menus, the
22601 \begin_inset Quotes eld
22605 \begin_inset Quotes erd
22608 part for other contexts (workarea, dialog)
22611 \begin_layout Itemize
22613 \change_inserted -712698321 1483868138
22614 \begin_inset Flex Code
22617 \begin_layout Plain Layout
22619 \change_inserted -712698321 1483868076
22626 \begin_inset Quotes eld
22630 \begin_inset Quotes erd
22633 part if another item follows (e.
22634 \begin_inset space \thinspace{}
22637 g., in a citation with multiple keys)
22640 \begin_layout Itemize
22642 \change_inserted -712698321 1483868174
22643 \begin_inset Flex Code
22646 \begin_layout Plain Layout
22648 \change_inserted -712698321 1483868144
22649 {%second%[[true]][[false]]}
22655 \begin_inset Quotes eld
22659 \begin_inset Quotes erd
22662 if this is the second of multiple items, else the
22663 \begin_inset Quotes eld
22667 \begin_inset Quotes erd
22673 \begin_layout Itemize
22675 \change_inserted -712698321 1483868321
22676 \begin_inset Flex Code
22679 \begin_layout Plain Layout
22681 \change_inserted -712698321 1483868259
22682 {%ifstar%[[true]][[false]]}
22688 \begin_inset Quotes eld
22692 \begin_inset Quotes erd
22695 part for starred citation commands (such as
22696 \begin_inset Flex Code
22699 \begin_layout Plain Layout
22701 \change_inserted -712698321 1483868310
22711 ), the false part for unstarred
22714 \begin_layout Itemize
22716 \change_inserted -712698321 1483978485
22717 \begin_inset Flex Code
22720 \begin_layout Plain Layout
22722 \change_inserted -712698321 1483868330
22723 {%ifentrytype:<type>%[[true]][[false]]}
22729 \begin_inset Quotes eld
22733 \begin_inset Quotes erd
22736 if the current entry type matches
22737 \begin_inset Flex Code
22740 \begin_layout Plain Layout
22742 \change_inserted -712698321 1483868364
22750 , else the false part (e.g., in a citation definition:
22751 \begin_inset Flex Code
22754 \begin_layout Plain Layout
22756 \change_inserted -712698321 1483868420
22757 {%ifentrytype:book%[[this is a book]][[this is no book]]}
22767 \begin_layout Itemize
22769 \change_inserted -712698321 1484997600
22770 \begin_inset Flex Code
22773 \begin_layout Plain Layout
22775 \change_inserted -712698321 1483978499
22776 {%ifmultiple:<authortype>%[[true]][[false]]}
22782 \begin_inset Quotes eld
22786 \begin_inset Quotes erd
22789 if the current author type (author, editor etc.) has multiple authors, else
22790 the false part (e.g., in a bibliography definition:
22791 \begin_inset Flex Code
22794 \begin_layout Plain Layout
22796 \change_inserted -712698321 1483978571
22797 {%ifmultiple:editor%[[eds.]][[ed.]]}
22805 \begin_layout Itemize
22807 \change_inserted -712698321 1484997681
22808 \begin_inset Flex Code
22811 \begin_layout Plain Layout
22813 \change_inserted -712698321 1484997608
22814 {%ifqualified%[[true]][[false]]}
22820 \begin_inset Quotes eld
22824 \begin_inset Quotes erd
22827 part if the current citation is a qualified citation list (a specific
22831 format for multi-reference citations), the false part if this is not the
22837 \begin_layout Standard
22839 \change_inserted -712698321 1483978958
22841 \begin_inset Flex Code
22844 \begin_layout Plain Layout
22846 \change_inserted -712698321 1483978693
22852 prints the author key as it is recorded in the bibliography file.
22853 This might not be what you want, since it will result in a string such
22855 \begin_inset Quotes eld
22858 Miller, Peter and Smith, Mary and White, Jane
22859 \begin_inset Quotes erd
22863 \begin_inset Quotes eld
22867 \begin_inset Quotes erd
22870 is used by Bib\SpecialChar TeX
22871 to delimit authors).
22873 therefore provides some methods to get properly formatted name lists (which
22874 will also get translated).
22875 The following keys are provided:
22878 \begin_layout Enumerate
22880 \change_inserted -712698321 1483979807
22881 For name lists with pre- and surname, suitable for the main authors/editors
22882 of a bibliography item.
22884 \begin_inset Flex Code
22887 \begin_layout Plain Layout
22889 \change_inserted -712698321 1483979800
22897 part denotes the kind of list that is requested (e.g.
22899 \begin_inset Flex Code
22902 \begin_layout Plain Layout
22904 \change_inserted -712698321 1483979807
22916 \begin_layout Itemize
22918 \change_inserted -712698321 1483979186
22919 \begin_inset Flex Code
22922 \begin_layout Plain Layout
22924 \change_inserted -712698321 1483979743
22925 %abbrvnames:<nametype>%
22932 : Provides a name list which is abbreviated (with
22933 \begin_inset Quotes eld
22937 \begin_inset Quotes erd
22941 \begin_inset Flex Code
22944 \begin_layout Plain Layout
22946 \change_inserted -712698321 1483979186
22957 \begin_layout Itemize
22959 \change_inserted -712698321 1483979527
22960 \begin_inset Flex Code
22963 \begin_layout Plain Layout
22965 \change_inserted -712698321 1483979748
22966 %fullnames:<nametype>%
22973 : Provides a full name list (never abbreviated with
22974 \begin_inset Quotes eld
22978 \begin_inset Quotes erd
22984 \begin_layout Itemize
22986 \change_inserted -712698321 1483979553
22987 \begin_inset Flex Code
22990 \begin_layout Plain Layout
22992 \change_inserted -712698321 1483980138
22993 %forceabbrvnames:<nametype>%
23000 : Provides a name list which is always abbreviated (with
23001 \begin_inset Quotes eld
23005 \begin_inset Quotes erd
23009 \begin_inset Flex Code
23012 \begin_layout Plain Layout
23014 \change_inserted -712698321 1483979535
23026 \begin_layout Enumerate
23028 \change_inserted -712698321 1483979413
23029 Alternative name lists with pre- and surname, if the order of pre- and surname
23030 inside the bibliography item differs (as in:
23031 \begin_inset Quotes eld
23034 Miller, John: Some text, in: Mary Smith, ed.: A volume
23035 \begin_inset Quotes erd
23044 \begin_layout Itemize
23046 \change_inserted -712698321 1483979565
23047 \begin_inset Flex Code
23050 \begin_layout Plain Layout
23052 \change_inserted -712698321 1483979751
23053 %abbrvbynames:<nametype>%
23060 : Provides a name list which is abbreviated (with
23061 \begin_inset Quotes eld
23065 \begin_inset Quotes erd
23069 \begin_inset Flex Code
23072 \begin_layout Plain Layout
23074 \change_inserted -712698321 1483979565
23085 \begin_layout Itemize
23087 \change_inserted -712698321 1483979570
23088 \begin_inset Flex Code
23091 \begin_layout Plain Layout
23093 \change_inserted -712698321 1483979753
23094 %fullbynames:<nametype>%
23101 : Provides a full name list (never abbreviated with
23102 \begin_inset Quotes eld
23106 \begin_inset Quotes erd
23114 \begin_layout Itemize
23116 \change_inserted -712698321 1483979576
23117 \begin_inset Flex Code
23120 \begin_layout Plain Layout
23122 \change_inserted -712698321 1483980143
23123 %forceabbrvbynames:<nametype>%
23130 : Provides a name list which is always abbreviated (with
23131 \begin_inset Quotes eld
23135 \begin_inset Quotes erd
23139 \begin_inset Flex Code
23142 \begin_layout Plain Layout
23144 \change_inserted -712698321 1483979574
23154 \begin_layout Enumerate
23156 \change_inserted -712698321 1483980219
23157 And finally name lists which consist of family names only, as used in author-yea
23159 these do not take a
23160 \begin_inset Flex Code
23163 \begin_layout Plain Layout
23165 \change_inserted -712698321 1483979871
23173 part, but always return either an author list or, if this does not exist,
23174 an editor list (as common in author-year labels):
23180 \begin_layout Itemize
23182 \change_inserted -712698321 1483979715
23183 \begin_inset Flex Code
23186 \begin_layout Plain Layout
23188 \change_inserted -712698321 1483979700
23196 : Provides a name list which is abbreviated (with
23197 \begin_inset Quotes eld
23201 \begin_inset Quotes erd
23205 \begin_inset Flex Code
23208 \begin_layout Plain Layout
23210 \change_inserted -712698321 1483979715
23221 \begin_layout Itemize
23223 \change_inserted -712698321 1483979721
23224 \begin_inset Flex Code
23227 \begin_layout Plain Layout
23229 \change_inserted -712698321 1483979703
23237 : Provides a full name list (never abbreviated with
23238 \begin_inset Quotes eld
23242 \begin_inset Quotes erd
23250 \begin_layout Itemize
23252 \change_inserted -712698321 1483980272
23253 \begin_inset Flex Code
23256 \begin_layout Plain Layout
23258 \change_inserted -712698321 1483979705
23259 %forceabbrvciteauthor%
23266 : Provides a name list which is always abbreviated (with
23267 \begin_inset Quotes eld
23271 \begin_inset Quotes erd
23275 \begin_inset Flex Code
23278 \begin_layout Plain Layout
23280 \change_inserted -712698321 1483979726
23290 \begin_layout Standard
23292 \change_inserted -712698321 1483980314
23293 The order of pre- and surname in the former two lists can be adjusted by
23297 \begin_layout Itemize
23299 \change_inserted -712698321 1483980535
23300 \begin_inset Flex Code
23303 \begin_layout Plain Layout
23305 \change_inserted -712698321 1483980354
23306 !firstnameform %surname%, %prename%
23313 (first author in lists of type 1)
23316 \begin_layout Itemize
23318 \change_inserted -712698321 1483980557
23319 \begin_inset Flex Code
23322 \begin_layout Plain Layout
23324 \change_inserted -712698321 1483980367
23325 !othernameform %surname%, %prename%
23332 (other authors in lists of type 1)
23337 \begin_layout Itemize
23339 \change_inserted -712698321 1483980550
23340 \begin_inset Flex Code
23343 \begin_layout Plain Layout
23345 \change_inserted -712698321 1483980373
23346 !firstbynameform %prename% %surname%
23353 (first author in lists of type 2)
23356 \begin_layout Itemize
23358 \change_inserted -712698321 1483980570
23359 \begin_inset Flex Code
23362 \begin_layout Plain Layout
23364 \change_inserted -712698321 1483980381
23365 !otherbynameform %prename% %surname%
23372 (other authors in lists of type 2)
23375 \begin_layout Standard
23377 \change_inserted -712698321 1483980643
23378 This allows you to configure namings like
23379 \begin_inset Quotes eld
23382 Miller, Peter and Mary Smith: \SpecialChar ldots
23383 , in: John Doe and Pat Green, eds.:\SpecialChar ldots
23385 \begin_inset Quotes erd
23393 \begin_layout Standard
23394 There is one other piece of syntax available in definitions, which looks
23396 \begin_inset Flex Code
23399 \begin_layout Plain Layout
23406 This defines a piece of formatting information that is to be used when
23408 \begin_inset Quotes eld
23412 \begin_inset Quotes erd
23416 Obviously, we do not want to output HTML tags when writing plain text,
23417 so they should be wrapped in
23418 \begin_inset Quotes eld
23422 \begin_inset Quotes erd
23426 \begin_inset Quotes eld
23430 \begin_inset Quotes erd
23436 \begin_layout Standard
23437 Two special sorts of definitions are also possible in a
23438 \begin_inset Flex Code
23441 \begin_layout Plain Layout
23448 An example of the first would be:
23451 \begin_layout LyX-Code
23453 \begin_inset Quotes eld
23457 \begin_inset Quotes erd
23463 \begin_layout Standard
23464 This is an abbreviation, or macro, and it can be used by treating it as
23466 \begin_inset Flex Code
23469 \begin_layout Plain Layout
23478 \begin_inset Flex Code
23481 \begin_layout Plain Layout
23487 exactly as it would treat its definition.
23488 So, let us issue the obvious
23496 \begin_layout LyX-Code
23500 \begin_layout Standard
23501 or anything like it.
23503 shouldn't go into an infinite loop, but it may go into a long one before
23507 \begin_layout Standard
23508 The second sort of special definition might look like this:
23511 \begin_layout LyX-Code
23515 \begin_layout Standard
23516 This defines a translatable piece of text, which allows relevant parts of
23518 \change_inserted -712698321 1483868477
23522 It can be included in a definition by treating it as a key:
23523 \begin_inset Flex Code
23526 \begin_layout Plain Layout
23533 Several of these are predefined in
23534 \begin_inset Flex Code
23537 \begin_layout Plain Layout
23544 \change_inserted -712698321 1483868503
23546 \begin_inset Flex Code
23549 \begin_layout Plain Layout
23551 \change_inserted -712698321 1483868503
23562 Note that these are not macros, in the sense just defined.
23563 They will not be expanded.
23566 \begin_layout Standard
23567 So here then is an example that use all these features:
23568 \begin_inset VSpace defskip
23574 \begin_layout Standard
23578 !authoredit {%author%[[%author%, ]][[{%editor%[[%editor%, %_edtext%, ]]}]]}
23581 \begin_layout Standard
23582 \begin_inset VSpace defskip
23585 This defines a macro that prints the author, followed by a comma, if the
23587 \begin_inset Flex Code
23590 \begin_layout Plain Layout
23596 key is defined, or else prints the name of the editor, followed by the
23598 \begin_inset Flex Code
23601 \begin_layout Plain Layout
23607 or its translation (it is by default
23608 \begin_inset Quotes eld
23612 \begin_inset Quotes erd
23616 \begin_inset Flex Code
23619 \begin_layout Plain Layout
23626 Note that this is in fact defined in
23627 \begin_inset Flex Code
23630 \begin_layout Plain Layout
23636 , so you can use it in your own definitions, or re-definitions, if you load
23640 \begin_layout Section
23641 \begin_inset CommandInset label
23643 name "sec:Tags-for-XHTML"
23647 Tags for XHTML output
23650 \begin_layout Standard
23651 As with \SpecialChar LaTeX
23652 or DocBook, the format of \SpecialChar LyX
23653 's XHTML output is also controlled by
23654 layout information.
23655 In general, \SpecialChar LyX
23656 provides sensible defaults and, as mentioned earlier, it will
23657 even construct default CSS style rules from the other layout tags.
23658 For example, \SpecialChar LyX
23659 will attempt to use the information provided in the
23660 \begin_inset Flex Code
23663 \begin_layout Plain Layout
23669 declaration for the Chapter style to write CSS that will appropriately
23670 format chapter headings.
23673 \begin_layout Standard
23674 In many cases, then, you may not have to do anything at all to get acceptable
23675 XHTML output for your own environments, custom insets, and so forth.
23676 But in some cases you will, and so \SpecialChar LyX
23677 provides a number of layout tags that
23678 can be used to customize the XHTML and CSS that are generated.
23681 \begin_layout Standard
23682 Note that there are two tags,
23683 \begin_inset Flex Code
23686 \begin_layout Plain Layout
23693 \begin_inset Flex Code
23696 \begin_layout Plain Layout
23702 that may appear outside style and inset declarations.
23704 \begin_inset CommandInset ref
23706 reference "subsec:General-text-class"
23710 for details on these.
23713 \begin_layout Subsection
23714 \begin_inset CommandInset label
23716 name "subsec:Paragraph-Style-XHTML"
23723 \begin_layout Standard
23724 The sort of XHTML \SpecialChar LyX
23725 outputs for a paragraph depends upon whether we are dealing
23726 with a normal paragraph, a command, or an environment, where this is itself
23727 determined by the contents of the corresponding
23728 \begin_inset Flex Code
23731 \begin_layout Plain Layout
23742 \begin_layout Standard
23743 For a command or normal paragraph, the output XHTML has the following form:
23746 \begin_layout LyX-Code
23748 \begin_inset Quotes erd
23752 \begin_inset Quotes erd
23758 \begin_layout LyX-Code
23760 \begin_inset Quotes erd
23764 \begin_inset Quotes erd
23770 \begin_layout LyX-Code
23771 Contents of the paragraph.
23774 \begin_layout LyX-Code
23778 \begin_layout Standard
23779 The label tags are of course omitted if the paragraph does not have a label.
23782 \begin_layout Standard
23783 For an environment that is not some sort of list, the XHTML takes this form:
23786 \begin_layout LyX-Code
23788 \begin_inset Quotes erd
23792 \begin_inset Quotes erd
23798 \begin_layout LyX-Code
23800 \begin_inset Quotes erd
23804 \begin_inset Quotes erd
23808 \begin_inset Quotes erd
23812 \begin_inset Quotes erd
23815 >Environment Label</labeltag>First paragraph.</itemtag>
23818 \begin_layout LyX-Code
23819 <itemtag>Second paragraph.</itemtag>
23822 \begin_layout LyX-Code
23826 \begin_layout Standard
23827 Note that the label is output only for the first paragraph, as it should
23828 be for a theorem, for example.
23832 \begin_layout Standard
23833 For a list, we have one of these forms:
23836 \begin_layout LyX-Code
23838 \begin_inset Quotes erd
23842 \begin_inset Quotes erd
23848 \begin_layout LyX-Code
23850 \begin_inset Quotes erd
23854 \begin_inset Quotes erd
23858 \begin_inset Quotes erd
23862 \begin_inset Quotes erd
23865 >List Label</labeltag>First item.</itemtag>
23868 \begin_layout LyX-Code
23870 \begin_inset Quotes erd
23874 \begin_inset Quotes erd
23878 \begin_inset Quotes erd
23882 \begin_inset Quotes erd
23885 >List Label</labeltag>Second item.</itemtag>
23888 \begin_layout LyX-Code
23892 \begin_layout LyX-Code
23896 \begin_layout LyX-Code
23898 \begin_inset Quotes erd
23902 \begin_inset Quotes erd
23908 \begin_layout LyX-Code
23910 \begin_inset Quotes erd
23914 \begin_inset Quotes erd
23917 >List Label</labeltag><itemtag attr=
23918 \begin_inset Quotes erd
23922 \begin_inset Quotes erd
23925 >First item.</itemtag>
23928 \begin_layout LyX-Code
23930 \begin_inset Quotes erd
23934 \begin_inset Quotes erd
23937 >List Label</labeltag><itemtag attr=
23938 \begin_inset Quotes erd
23942 \begin_inset Quotes erd
23945 >Second item.</itemtag>
23948 \begin_layout LyX-Code
23952 \begin_layout Standard
23953 Note the different orders of
23954 \begin_inset Flex Code
23957 \begin_layout Plain Layout
23964 \begin_inset Flex Code
23967 \begin_layout Plain Layout
23974 Which order we get depends upon the setting of
23975 \begin_inset Flex Code
23978 \begin_layout Plain Layout
23985 \begin_inset Flex Code
23988 \begin_layout Plain Layout
23994 is false (the default), you get the first of these, with the label within
23995 the item; if true, you get the second, with the label outside the item.
23998 \begin_layout Standard
23999 The specific tags and attributes output for each paragraph type can be controlle
24000 d by means of the layout tags we are about to describe.
24001 As mentioned earlier, however, \SpecialChar LyX
24002 uses sensible defaults for many of these,
24003 so you often may not need to do very much to get good XHTML output.
24004 Think of the available tags as there so you can tweak things to your liking.
24007 \begin_layout Description
24008 \begin_inset Flex Code
24011 \begin_layout Plain Layout
24018 \begin_inset Flex Code
24021 \begin_layout Plain Layout
24027 ] Specifies attribute information to be output with the main tag.
24029 \begin_inset Quotes eld
24033 \begin_inset Flex Code
24036 \begin_layout Plain Layout
24043 \begin_inset Quotes erd
24047 By default, \SpecialChar LyX
24049 \begin_inset Quotes eld
24053 \begin_inset Flex Code
24056 \begin_layout Plain Layout
24063 \begin_inset Quotes erd
24067 \begin_inset Flex Code
24070 \begin_layout Plain Layout
24076 is the \SpecialChar LyX
24077 name of the layout, made lowercase, for example: chapter.
24082 contain any style information.
24084 \begin_inset Flex Code
24087 \begin_layout Plain Layout
24096 \begin_layout Description
24097 \begin_inset Flex Code
24100 \begin_layout Plain Layout
24107 \begin_inset Flex Code
24110 \begin_layout Plain Layout
24120 ] Whether to output the default CSS information \SpecialChar LyX
24121 generates for this layout,
24122 even if additional information is explicitly provided via
24123 \begin_inset Flex Code
24126 \begin_layout Plain Layout
24134 \begin_inset Flex Code
24137 \begin_layout Plain Layout
24143 allows you to alter or augment the generated CSS, rather than to override
24146 \begin_inset Flex Code
24149 \begin_layout Plain Layout
24158 \begin_layout Description
24159 \begin_inset Flex Code
24162 \begin_layout Plain Layout
24169 \begin_inset Flex Code
24172 \begin_layout Plain Layout
24178 ] The tag to be used for individual paragraphs of environments, replacing
24180 \begin_inset Flex Code
24183 \begin_layout Plain Layout
24189 in the examples above.
24191 \begin_inset Flex Code
24194 \begin_layout Plain Layout
24203 \begin_layout Description
24204 \begin_inset Flex Code
24207 \begin_layout Plain Layout
24214 \begin_inset Flex Code
24217 \begin_layout Plain Layout
24223 ] Attributes for the item tag.
24225 \begin_inset Quotes eld
24229 \begin_inset Flex Code
24232 \begin_layout Plain Layout
24233 class=`layoutname_item'
24239 \begin_inset Quotes erd
24247 contain any style information.
24249 \begin_inset Flex Code
24252 \begin_layout Plain Layout
24261 \begin_layout Description
24262 \begin_inset Flex Code
24265 \begin_layout Plain Layout
24272 \begin_inset Flex Code
24275 \begin_layout Plain Layout
24281 ] The tag to be used for paragraph and item labels, replacing
24282 \begin_inset Flex Code
24285 \begin_layout Plain Layout
24291 in the examples above.
24293 \begin_inset Flex Code
24296 \begin_layout Plain Layout
24303 \begin_inset Flex Code
24306 \begin_layout Plain Layout
24313 \begin_inset Flex Code
24316 \begin_layout Plain Layout
24323 \begin_inset Flex Code
24326 \begin_layout Plain Layout
24327 Centered_Top_Environment
24332 , in which case it defaults to
24333 \begin_inset Flex Code
24336 \begin_layout Plain Layout
24345 \begin_layout Description
24346 \begin_inset Flex Code
24349 \begin_layout Plain Layout
24356 \begin_inset Flex Code
24359 \begin_layout Plain Layout
24365 ] Attributes for the label tag.
24367 \begin_inset Quotes eld
24371 \begin_inset Flex Code
24374 \begin_layout Plain Layout
24375 class=`layoutname_label'
24381 \begin_inset Quotes erd
24389 contain any style information.
24391 \begin_inset Flex Code
24394 \begin_layout Plain Layout
24403 \begin_layout Description
24404 \begin_inset Flex Code
24407 \begin_layout Plain Layout
24414 \begin_inset Flex Code
24417 \begin_layout Plain Layout
24427 ] Meaningful only for list-like environments, this tag controls whether
24428 the label tag is output before or inside the item tag.
24429 This is used, for example, in the description environment, where we want
24431 \begin_inset Flex Code
24434 \begin_layout Plain Layout
24435 <dt>\SpecialChar ldots
24436 </dt><dd>\SpecialChar ldots
24444 \begin_inset Flex Code
24447 \begin_layout Plain Layout
24453 : The label tag is output inside the item tag.
24456 \begin_layout Description
24457 \begin_inset Flex Code
24460 \begin_layout Plain Layout
24466 Information to be output in the
24467 \begin_inset Flex Code
24470 \begin_layout Plain Layout
24476 section when this style is used.
24477 This might, for example, be used to include a
24478 \begin_inset Flex Code
24481 \begin_layout Plain Layout
24488 \begin_inset Flex Code
24491 \begin_layout Plain Layout
24500 \begin_layout Description
24501 \begin_inset Flex Code
24504 \begin_layout Plain Layout
24510 CSS style information to be included when this style is used.
24511 Note that this will automatically be wrapped in a layout-generated
24512 \begin_inset Flex Code
24515 \begin_layout Plain Layout
24521 block, so only the CSS itself need be included.
24523 \begin_inset Flex Code
24526 \begin_layout Plain Layout
24535 \begin_layout Description
24536 \begin_inset Flex Code
24539 \begin_layout Plain Layout
24546 \begin_inset Flex Code
24549 \begin_layout Plain Layout
24555 ] The tag to be used for the main label, replacing
24556 \begin_inset Flex Code
24559 \begin_layout Plain Layout
24565 in the examples above.
24567 \begin_inset Flex Code
24570 \begin_layout Plain Layout
24579 \begin_layout Description
24580 \begin_inset Flex Code
24583 \begin_layout Plain Layout
24590 \begin_inset Flex Code
24593 \begin_layout Plain Layout
24603 ] Marks this style as the one to be used to generate the
24604 \begin_inset Flex Code
24607 \begin_layout Plain Layout
24613 tag for the XHTML file.
24614 By default, it is false.
24616 \begin_inset Flex Code
24619 \begin_layout Plain Layout
24625 file sets it to true for the
24626 \begin_inset Flex Code
24629 \begin_layout Plain Layout
24639 \begin_layout Subsection
24643 \begin_layout Standard
24644 The XHTML output of insets can also be controlled by information in layout
24649 \begin_layout Plain Layout
24650 At present, this is true only for
24651 \begin_inset Quotes eld
24655 \begin_inset Quotes erd
24658 insets (insets you can type into) and is not true for
24659 \begin_inset Quotes eld
24663 \begin_inset Quotes erd
24666 insets (insets that are associated with dialog boxes).
24671 Here, too, \SpecialChar LyX
24672 tries to provide sensible defaults, and it constructs default
24674 But everything can be customized.
24677 \begin_layout Standard
24678 The XHTML \SpecialChar LyX
24679 outputs for an inset has the following form:
24682 \begin_layout LyX-Code
24684 \begin_inset Quotes erd
24688 \begin_inset Quotes erd
24694 \begin_layout LyX-Code
24695 <labeltag>Label</labeltag>
24698 \begin_layout LyX-Code
24700 \begin_inset Quotes erd
24704 \begin_inset Quotes erd
24707 >Contents of the inset.</innertag>
24710 \begin_layout LyX-Code
24714 \begin_layout Standard
24715 If the inset permits multiple paragraphs—that is, if
24716 \begin_inset Flex Code
24719 \begin_layout Plain Layout
24725 is true—then the contents of the inset will itself be output as paragraphs
24726 formatted according to the styles used for those paragraphs (standard,
24727 quote, and the like).
24728 The label tag is of course omitted if the paragraph does not have a label
24729 and, at present, is always
24730 \begin_inset Flex Code
24733 \begin_layout Plain Layout
24740 The inner tag is optional and, by default, does not appear.
24743 \begin_layout Standard
24744 The specific tags and attributes output for each inset can be controlled
24745 by means of the following layout tags.
24748 \begin_layout Description
24749 \begin_inset Flex Code
24752 \begin_layout Plain Layout
24759 \begin_inset Flex Code
24762 \begin_layout Plain Layout
24768 ] Specifies attribute information to be output with the main tag.
24770 \begin_inset Quotes eld
24774 \begin_inset Flex Code
24777 \begin_layout Plain Layout
24778 class=`myinset' onclick=`\SpecialChar ldots
24785 \begin_inset Quotes erd
24789 By default, \SpecialChar LyX
24791 \begin_inset Quotes eld
24795 \begin_inset Flex Code
24798 \begin_layout Plain Layout
24805 \begin_inset Quotes erd
24809 \begin_inset Flex Code
24812 \begin_layout Plain Layout
24818 is the \SpecialChar LyX
24819 name of the inset, made lowercase and with non-alphanumeric characters
24820 converted to underscores, for example: footnote.
24823 \begin_layout Description
24824 \begin_inset Flex Code
24827 \begin_layout Plain Layout
24834 \begin_inset Flex Code
24837 \begin_layout Plain Layout
24847 ] Whether to output the default CSS information \SpecialChar LyX
24848 generates for this layout,
24849 even if additional information is explicitly provided via
24850 \begin_inset Flex Code
24853 \begin_layout Plain Layout
24861 \begin_inset Flex Code
24864 \begin_layout Plain Layout
24870 allows you to alter or augment the generated CSS, rather than to override
24875 \begin_layout Description
24876 \begin_inset Flex Code
24879 \begin_layout Plain Layout
24886 \begin_inset Flex Code
24889 \begin_layout Plain Layout
24895 ] Attributes for the inner tag.
24897 \begin_inset Quotes eld
24901 \begin_inset Flex Code
24904 \begin_layout Plain Layout
24905 class=`insetname_inner'
24911 \begin_inset Quotes erd
24917 \begin_layout Description
24918 \begin_inset Flex Code
24921 \begin_layout Plain Layout
24928 \begin_inset Flex Code
24931 \begin_layout Plain Layout
24937 ] The inner tag, replacing
24938 \begin_inset Flex Code
24941 \begin_layout Plain Layout
24947 in the examples above.
24948 By default, there is none.
24951 \begin_layout Description
24952 \begin_inset Flex Code
24955 \begin_layout Plain Layout
24962 \begin_inset Flex Code
24965 \begin_layout Plain Layout
24973 ] Whether this inset represents a standalone block of text (such as a footnote)
24974 or instead represents material that is included in the surrounding text
24975 (such as a branch).
24979 \begin_layout Description
24980 \begin_inset Flex Code
24983 \begin_layout Plain Layout
24990 \begin_inset Flex Code
24993 \begin_layout Plain Layout
24999 ] A label for this inset, possibly including a reference to a counter.
25000 For example, for footnote, it might be:
25001 \begin_inset Flex Code
25004 \begin_layout Plain Layout
25013 This is optional, and there is no default.
25016 \begin_layout Description
25017 \begin_inset Flex Code
25020 \begin_layout Plain Layout
25026 Information to be output in the
25027 \begin_inset Flex Code
25030 \begin_layout Plain Layout
25036 section when this style is used.
25037 This might, for example, be used to include a
25038 \begin_inset Flex Code
25041 \begin_layout Plain Layout
25048 \begin_inset Flex Code
25051 \begin_layout Plain Layout
25060 \begin_layout Description
25061 \begin_inset Flex Code
25064 \begin_layout Plain Layout
25070 CSS style information to be included when this style is used.
25071 Note that this will automatically be wrapped in a layout-generated
25072 \begin_inset Flex Code
25075 \begin_layout Plain Layout
25081 block, so only the CSS itself need be included.
25084 \begin_layout Description
25085 \begin_inset Flex Code
25088 \begin_layout Plain Layout
25095 \begin_inset Flex Code
25098 \begin_layout Plain Layout
25104 ] The tag to be used for the main label, replacing
25105 \begin_inset Flex Code
25108 \begin_layout Plain Layout
25114 in the examples above.
25115 The default depends upon the setting of
25116 \begin_inset Flex Code
25119 \begin_layout Plain Layout
25126 \begin_inset Flex Code
25129 \begin_layout Plain Layout
25135 is true, the default is
25136 \begin_inset Flex Code
25139 \begin_layout Plain Layout
25145 ; if it is false, the default is
25146 \begin_inset Flex Code
25149 \begin_layout Plain Layout
25158 \begin_layout Subsection
25162 \begin_layout Standard
25163 The XHTML output for floats too can be controlled by layout information.
25164 The output has the following form:
25167 \begin_layout LyX-Code
25169 \begin_inset Quotes erd
25173 \begin_inset Quotes erd
25179 \begin_layout LyX-Code
25180 Contents of the float.
25183 \begin_layout LyX-Code
25187 \begin_layout Standard
25188 The caption, if there is one, is a separate inset and will be output as
25190 Its appearance can be controlled via the InsetLayout for caption insets.
25194 \begin_layout Description
25195 \begin_inset Flex Code
25198 \begin_layout Plain Layout
25205 \begin_inset Flex Code
25208 \begin_layout Plain Layout
25214 ] Specifies attribute information to be output with the main tag.
25216 \begin_inset Quotes eld
25220 \begin_inset Flex Code
25223 \begin_layout Plain Layout
25224 class=`myfloat' onclick=`\SpecialChar ldots
25231 \begin_inset Quotes erd
25235 By default, \SpecialChar LyX
25237 \begin_inset Quotes eld
25241 \begin_inset Flex Code
25244 \begin_layout Plain Layout
25245 class=`float float-floattype'
25251 \begin_inset Quotes erd
25255 \begin_inset Flex Code
25258 \begin_layout Plain Layout
25264 is \SpecialChar LyX
25265 's name for this type of float, as determined by the float declaration
25267 \begin_inset CommandInset ref
25269 reference "subsec:Floats"
25273 ), though made lowercase and with non-alphanumeric characters converted
25274 to underscores, for example: float-table.
25277 \begin_layout Description
25278 \begin_inset Flex Code
25281 \begin_layout Plain Layout
25287 CSS style information to be included when this float is used.
25288 Note that this will automatically be wrapped in a layout-generated
25289 \begin_inset Flex Code
25292 \begin_layout Plain Layout
25298 block, so only the CSS itself need be included.
25301 \begin_layout Description
25302 \begin_inset Flex Code
25305 \begin_layout Plain Layout
25312 \begin_inset Flex Code
25315 \begin_layout Plain Layout
25321 ] The tag to be used for this float, replacing
25322 \begin_inset Quotes eld
25326 \begin_inset Flex Code
25329 \begin_layout Plain Layout
25336 \begin_inset Quotes erd
25339 in the example above.
25341 \begin_inset Flex Code
25344 \begin_layout Plain Layout
25350 and will rarely need changing.
25353 \begin_layout Subsection
25354 Bibliography formatting
25357 \begin_layout Standard
25358 The bibliography can be formatted using
25359 \begin_inset Flex Code
25362 \begin_layout Plain Layout
25370 \begin_inset CommandInset ref
25372 reference "subsec:Citation-format-description"
25379 \begin_layout Subsection
25384 \begin_layout Standard
25385 We have several times mentioned that \SpecialChar LyX
25386 will generate default CSS style rules
25387 for both insets and paragraph styles, based upon the other layout information
25389 In this section, we shall say a word about which layout information \SpecialChar LyX
25394 \begin_layout Standard
25395 At present, \SpecialChar LyX
25396 auto-generates CSS only for font information, making use of
25398 \begin_inset Flex Code
25401 \begin_layout Plain Layout
25408 \begin_inset Flex Code
25411 \begin_layout Plain Layout
25418 \begin_inset Flex Code
25421 \begin_layout Plain Layout
25428 \begin_inset Flex Code
25431 \begin_layout Plain Layout
25438 \begin_inset Flex Code
25441 \begin_layout Plain Layout
25448 \begin_inset CommandInset ref
25450 reference "subsec:Font-description"
25455 The translation is mostly straightforward and obvious.
25457 \begin_inset Quotes eld
25461 \begin_inset Flex Code
25464 \begin_layout Plain Layout
25471 \begin_inset Quotes erd
25475 \begin_inset Quotes eld
25479 \begin_inset Flex Code
25482 \begin_layout Plain Layout
25483 font-family: sans-serif;
25489 \begin_inset Quotes erd
25493 The correspondence of \SpecialChar LyX
25494 sizes and CSS sizes is a little less obvious but
25495 nonetheless intuitive.
25497 \begin_inset Flex Code
25500 \begin_layout Plain Layout
25507 \begin_inset Flex URL
25510 \begin_layout Plain Layout
25520 \begin_layout Chapter
25521 Including External Material
25522 \begin_inset CommandInset label
25524 name "chap:Including-External-Material"
25531 \begin_layout Standard
25532 \begin_inset Box Shadowbox
25542 height_special "totalheight"
25547 backgroundcolor "none"
25550 \begin_layout Plain Layout
25551 WARNING: This portion of the documentation has not been updated for some
25553 We certainly hope that it is still accurate, but there are no guarantees.
25561 \begin_layout Standard
25562 The use of material from sources external to \SpecialChar LyX
25563 is covered in detail in the
25569 This part of the manual covers what needs to happen behind the scenes for
25570 new sorts of material to be included.
25573 \begin_layout Section
25577 \begin_layout Standard
25578 The external material feature is based on the concept of a
25583 A template is a specification of how \SpecialChar LyX
25584 should interface with a certain kind
25586 As bundled, \SpecialChar LyX
25587 comes with predefined templates for Xfig figures, various
25588 raster format images, chess diagrams, and LilyPond music notation.
25589 You can check the actual list by using the menu
25590 \begin_inset Flex Noun
25593 \begin_layout Plain Layout
25594 Insert\SpecialChar menuseparator
25595 File\SpecialChar menuseparator
25602 Furthermore, it is possible to roll your own template to support a specific
25604 Later we'll describe in more detail what is involved, and hopefully you
25605 will submit all the templates you create so we can include them in a later
25610 \begin_layout Standard
25611 Another basic idea of the external material feature is to distinguish between
25612 the original file that serves as a base for final material and the produced
25613 file that is included in your exported or printed document.
25614 For example, consider the case of a figure produced with
25615 \begin_inset Flex Code
25618 \begin_layout Plain Layout
25625 The Xfig application itself works on an original file with the
25626 \begin_inset Flex Code
25629 \begin_layout Plain Layout
25636 Within Xfig, you create and change your figure, and when you are done,
25638 \begin_inset Flex Code
25641 \begin_layout Plain Layout
25648 When you want to include the figure in your document, you invoke
25649 \begin_inset Flex Code
25652 \begin_layout Plain Layout
25658 in order to create a PostScript file that can readily be included in your
25662 \begin_inset Flex Code
25665 \begin_layout Plain Layout
25671 file is the original file, and the PostScript file is the produced file.
25674 \begin_layout Standard
25675 This distinction is important in order to allow updating of the material
25676 while you are in the process of writing the document.
25677 Furthermore, it provides us with the flexibility that is needed to support
25678 multiple export formats.
25679 For instance, in the case of a plain text file, it is not exactly an award-winn
25680 ing idea to include the figure as raw PostScript.
25681 Instead, you would either prefer to just include a reference to the figure
25682 or try to invoke some graphics to ASCII converter to make the final result
25683 look similar to the real graphics.
25684 The external material management allows you to do this, because it is parametri
25685 zed on the different export formats that \SpecialChar LyX
25689 \begin_layout Standard
25690 Besides supporting the production of different products according to the
25691 exported format, it supports tight integration with editing and viewing
25693 In the case of an Xfig figure, you are able to invoke Xfig on the original
25694 file with a single click from within the external material dialog in \SpecialChar LyX
25696 and also preview the produced PostScript file with Ghostview with another
25698 No more fiddling around with the command line and/or file browsers to locate
25699 and manipulate the original or produced files.
25700 In this way, you are finally able to take full advantage of the many different
25701 applications that are relevant to use when you write your documents, and
25702 ultimately be more productive.
25705 \begin_layout Section
25706 The external template configuration file
25707 \change_inserted -712698321 1490533960
25713 \begin_layout Standard
25714 It is relatively easy to add custom external template definitions to \SpecialChar LyX
25716 However, be aware that doing this in an careless manner most probably
25720 introduce an easily exploitable security hole.
25721 So before you do this, please read the discussion about security in
25722 \begin_inset CommandInset ref
25724 reference "sec:Security-discussion"
25731 \begin_layout Standard
25732 Having said that, we encourage you to submit any interesting templates that
25737 \begin_layout Standard
25738 The external templates are defined in the
25739 \change_inserted -712698321 1490534022
25741 \begin_inset Flex Code
25744 \begin_layout Plain Layout
25746 \change_inserted -712698321 1490533996
25752 files that are stored in the
25755 \begin_inset Flex Code
25758 \begin_layout Plain Layout
25760 \change_deleted -712698321 1490533984
25762 \change_inserted -712698321 1490533984
25766 \change_inserted -712698321 1490534077
25775 \change_deleted -712698321 1490534025
25777 \change_inserted -712698321 1490534028
25782 \change_inserted -712698321 1490534233
25783 Each template is defined in a file of its own.
25786 You can place your own
25787 \change_deleted -712698321 1490534089
25789 \change_inserted -712698321 1490534090
25793 \begin_inset Flex Code
25796 \begin_layout Plain Layout
25798 \change_deleted -712698321 1490534069
25800 \change_inserted -712698321 1490534069
25804 \change_inserted -712698321 1490534080
25813 \change_inserted -712698321 1490534112
25814 or copy existing templates to that directory in order to modify them
25819 \begin_layout Standard
25820 A typical template looks like this:
25823 \begin_layout LyX-Code
25827 \begin_layout LyX-Code
25828 GuiName "XFig: $$AbsOrRelPathParent$$Basename"
25831 \begin_layout LyX-Code
25835 \begin_layout LyX-Code
25839 \begin_layout LyX-Code
25843 \begin_layout LyX-Code
25847 \begin_layout LyX-Code
25851 \begin_layout LyX-Code
25852 AutomaticProduction true
25855 \begin_layout LyX-Code
25859 \begin_layout LyX-Code
25863 \begin_layout LyX-Code
25867 \begin_layout LyX-Code
25868 TransformCommand Rotate RotationLatexCommand
25871 \begin_layout LyX-Code
25872 TransformCommand Resize ResizeLatexCommand
25875 \begin_layout LyX-Code
25876 Product "$$RotateFront$$ResizeFront
25879 \begin_layout LyX-Code
25884 input{$$AbsOrRelPathMaster$$Basename.pstex_t}
25887 \begin_layout LyX-Code
25888 $$ResizeBack$$RotateBack"
25891 \begin_layout LyX-Code
25895 \begin_layout LyX-Code
25896 UpdateResult "$$AbsPath$$Basename.pstex_t"
25899 \begin_layout LyX-Code
25900 Requirement "graphicx"
25903 \begin_layout LyX-Code
25904 ReferencedFile latex "$$AbsOrRelPathMaster$$Basename.pstex_t"
25907 \begin_layout LyX-Code
25908 ReferencedFile latex "$$AbsPath$$Basename.eps"
25911 \begin_layout LyX-Code
25912 ReferencedFile dvi "$$AbsPath$$Basename.eps"
25915 \begin_layout LyX-Code
25919 \begin_layout LyX-Code
25923 \begin_layout LyX-Code
25924 TransformCommand Rotate RotationLatexCommand
25927 \begin_layout LyX-Code
25928 TransformCommand Resize ResizeLatexCommand
25931 \begin_layout LyX-Code
25932 Product "$$RotateFront$$ResizeFront
25935 \begin_layout LyX-Code
25940 input{$$AbsOrRelPathMaster$$Basename.pdftex_t}
25943 \begin_layout LyX-Code
25944 $$ResizeBack$$RotateBack"
25947 \begin_layout LyX-Code
25948 UpdateFormat pdftex
25951 \begin_layout LyX-Code
25952 UpdateResult "$$AbsPath$$Basename.pdftex_t"
25955 \begin_layout LyX-Code
25956 Requirement "graphicx"
25959 \begin_layout LyX-Code
25960 ReferencedFile latex "$$AbsOrRelPathMaster$$Basename.pdftex_t"
25963 \begin_layout LyX-Code
25964 ReferencedFile latex "$$AbsPath$$Basename.pdf"
25967 \begin_layout LyX-Code
25971 \begin_layout LyX-Code
25975 \begin_layout LyX-Code
25976 Product "[XFig: $$FName]"
25979 \begin_layout LyX-Code
25983 \begin_layout LyX-Code
25987 \begin_layout LyX-Code
25988 Product "<graphic fileref=
25990 "$$AbsOrRelPathMaster$$Basename.eps
25995 \begin_layout LyX-Code
25999 \begin_layout LyX-Code
26003 \begin_layout LyX-Code
26004 UpdateResult "$$AbsPath$$Basename.eps"
26007 \begin_layout LyX-Code
26008 ReferencedFile docbook "$$AbsPath$$Basename.eps"
26011 \begin_layout LyX-Code
26012 ReferencedFile docbook-xml "$$AbsPath$$Basename.eps"
26015 \begin_layout LyX-Code
26019 \begin_layout LyX-Code
26023 \begin_layout Standard
26024 As you can see, the template is enclosed in
26025 \begin_inset Flex Code
26028 \begin_layout Plain Layout
26036 \begin_inset Flex Code
26039 \begin_layout Plain Layout
26046 It contains a header specifying some general settings and, for each supported
26047 primary document file format, a section
26048 \begin_inset Flex Code
26051 \begin_layout Plain Layout
26059 \begin_inset Flex Code
26062 \begin_layout Plain Layout
26071 \begin_layout Subsection
26072 The template header
26075 \begin_layout Description
26076 \begin_inset Flex Code
26079 \begin_layout Plain Layout
26080 AutomaticProduction
26081 \begin_inset space ~
26089 Whether the file represented by the template must be generated by \SpecialChar LyX
26091 This command must occur exactly once.
26094 \begin_layout Description
26095 \begin_inset Flex Code
26098 \begin_layout Plain Layout
26100 \begin_inset space ~
26108 A glob pattern that is used in the file dialog to filter out the desired
26110 If there is more than one possible file extension (e.
26111 \begin_inset space \thinspace{}
26115 \begin_inset space \space{}
26119 \begin_inset Flex Code
26122 \begin_layout Plain Layout
26129 \begin_inset Flex Code
26132 \begin_layout Plain Layout
26138 ), use something like
26139 \begin_inset Flex Code
26142 \begin_layout Plain Layout
26149 This command must occur exactly once.
26152 \begin_layout Description
26153 \begin_inset Flex Code
26156 \begin_layout Plain Layout
26158 \begin_inset space ~
26166 The text that is displayed on the button.
26167 This command must occur exactly once.
26170 \begin_layout Description
26171 \begin_inset Flex Code
26174 \begin_layout Plain Layout
26176 \begin_inset space ~
26180 \begin_inset space ~
26188 The help text that is used in the External dialog.
26189 Provide enough information to explain to the user just what the template
26190 can provide him with.
26191 This command must occur exactly once.
26194 \begin_layout Description
26195 \begin_inset Flex Code
26198 \begin_layout Plain Layout
26200 \begin_inset space ~
26208 The file format of the original file.
26209 This must be the name of a format that is known to \SpecialChar LyX
26211 \begin_inset CommandInset ref
26213 reference "sec:Formats"
26219 \begin_inset Quotes eld
26223 \begin_inset Flex Code
26226 \begin_layout Plain Layout
26233 \begin_inset Quotes erd
26236 if the template can handle original files of more than one format.
26238 will attempt to interrogate the file itself in order to deduce its format
26240 This command must occur exactly once.
26243 \begin_layout Description
26244 \begin_inset Flex Code
26247 \begin_layout Plain Layout
26249 \begin_inset space ~
26257 A unique name for the template.
26258 It must not contain substitution macros (see below).
26261 \begin_layout Description
26262 \begin_inset Flex Code
26265 \begin_layout Plain Layout
26267 \begin_inset space ~
26270 Rotate|Resize|Clip|Extra
26275 This command specifies which transformations are supported by this template.
26276 It may occur zero or more times.
26277 This command enables the corresponding tabs in the external dialog.
26279 \begin_inset Flex Code
26282 \begin_layout Plain Layout
26288 command must have either a corresponding
26289 \begin_inset Flex Code
26292 \begin_layout Plain Layout
26299 \begin_inset Flex Code
26302 \begin_layout Plain Layout
26309 \begin_inset Flex Code
26312 \begin_layout Plain Layout
26319 Otherwise the transformation will not be supported by that format.
26322 \begin_layout Subsection
26326 \begin_layout Description
26327 \begin_inset Flex Code
26330 \begin_layout Plain Layout
26332 \begin_inset space ~
26335 LaTeX|PDFLaTeX|PlainText|DocBook|XHTML
26340 The primary document file format that this format definition is for.
26341 Not every template has a sensible representation in all document file formats.
26342 Please define nevertheless a
26343 \begin_inset Flex Code
26346 \begin_layout Plain Layout
26352 section for all templates.
26353 Use a dummy text when no representation is available.
26354 Then you can at least see a reference to the external material in the exported
26358 \begin_layout Description
26359 \begin_inset Flex Code
26362 \begin_layout Plain Layout
26364 \begin_inset space ~
26368 \begin_inset space ~
26376 This command defines an additional macro
26377 \begin_inset Flex Code
26380 \begin_layout Plain Layout
26386 for substitution in
26387 \begin_inset Flex Code
26390 \begin_layout Plain Layout
26398 \begin_inset Flex Code
26401 \begin_layout Plain Layout
26407 itself may contain substitution macros.
26408 The advantage over using
26409 \begin_inset Flex Code
26412 \begin_layout Plain Layout
26419 \begin_inset Flex Code
26422 \begin_layout Plain Layout
26428 is that the substituted value of
26429 \begin_inset Flex Code
26432 \begin_layout Plain Layout
26438 is sanitized so that it is a valid optional argument in the document format.
26439 This command may occur zero or more times.
26442 \begin_layout Description
26443 \begin_inset Flex Code
26446 \begin_layout Plain Layout
26448 \begin_inset space ~
26456 The text that is inserted in the exported document.
26457 This is actually the most important command and can be quite complex.
26458 This command must occur exactly once.
26461 \begin_layout Description
26462 \begin_inset Flex Code
26465 \begin_layout Plain Layout
26467 \begin_inset space ~
26475 This command specifies a preamble snippet that will be included in the
26478 It has to be defined using
26479 \begin_inset Flex Code
26482 \begin_layout Plain Layout
26490 \begin_inset Flex Code
26493 \begin_layout Plain Layout
26500 This command may occur zero or more times.
26503 \begin_layout Description
26504 \begin_inset Flex Code
26507 \begin_layout Plain Layout
26509 \begin_inset space ~
26513 \begin_inset space ~
26521 This command denotes files that are created by the conversion process and
26522 are needed for a particular export format.
26523 If the filename is relative, it is interpreted relative to the master document.
26524 This command may be given zero or more times.
26527 \begin_layout Description
26528 \begin_inset Flex Code
26531 \begin_layout Plain Layout
26533 \begin_inset space ~
26541 The name of a required \SpecialChar LaTeX
26543 The package is included via
26544 \begin_inset Flex Code
26547 \begin_layout Plain Layout
26555 in the \SpecialChar LaTeX
26557 This command may occur zero or more times.
26560 \begin_layout Description
26561 \begin_inset Flex Code
26564 \begin_layout Plain Layout
26566 \begin_inset space ~
26570 \begin_inset space ~
26573 RotationLatexCommand
26578 This command specifies that the built in \SpecialChar LaTeX
26579 command should be used for rotation.
26580 This command may occur once or not at all.
26583 \begin_layout Description
26584 \begin_inset Flex Code
26587 \begin_layout Plain Layout
26589 \begin_inset space ~
26593 \begin_inset space ~
26601 This command specifies that the built in \SpecialChar LaTeX
26602 command should be used for resizing.
26603 This command may occur once or not at all.
26606 \begin_layout Description
26607 \begin_inset Flex Code
26610 \begin_layout Plain Layout
26612 \begin_inset space ~
26616 \begin_inset space ~
26619 RotationLatexOption
26624 This command specifies that rotation is done via an optional argument.
26625 This command may occur once or not at all.
26628 \begin_layout Description
26629 \begin_inset Flex Code
26632 \begin_layout Plain Layout
26634 \begin_inset space ~
26638 \begin_inset space ~
26646 This command specifies that resizing is done via an optional argument.
26647 This command may occur once or not at all.
26650 \begin_layout Description
26651 \begin_inset Flex Code
26654 \begin_layout Plain Layout
26656 \begin_inset space ~
26660 \begin_inset space ~
26668 This command specifies that clipping is done via an optional argument.
26669 This command may occur once or not at all.
26672 \begin_layout Description
26673 \begin_inset Flex Code
26676 \begin_layout Plain Layout
26678 \begin_inset space ~
26682 \begin_inset space ~
26690 This command specifies that an extra optional argument is used.
26691 This command may occur once or not at all.
26694 \begin_layout Description
26695 \begin_inset Flex Code
26698 \begin_layout Plain Layout
26700 \begin_inset space ~
26708 The file format of the converted file.
26709 This must be the name of a format that is known to \SpecialChar LyX
26711 \begin_inset Flex Noun
26714 \begin_layout Plain Layout
26715 Tools\SpecialChar menuseparator
26716 Preferences\SpecialChar menuseparator
26717 File Handling\SpecialChar menuseparator
26724 This command must occur exactly once.
26725 If the resulting file format is PDF, you need to specify the format
26726 \begin_inset Flex Code
26729 \begin_layout Plain Layout
26736 This is the PDF format used for including graphics.
26737 The other defined PDF formats are for document export.
26740 \begin_layout Description
26741 \begin_inset Flex Code
26744 \begin_layout Plain Layout
26746 \begin_inset space ~
26754 The file name of the converted file.
26755 The file name must be absolute.
26756 This command must occur exactly once.
26759 \begin_layout Subsection
26760 Preamble definitions
26763 \begin_layout Standard
26764 The external template configuration file may contain additional preamble
26765 definitions enclosed by
26766 \begin_inset Flex Code
26769 \begin_layout Plain Layout
26777 \begin_inset Flex Code
26780 \begin_layout Plain Layout
26787 They can be used by the templates in the
26788 \begin_inset Flex Code
26791 \begin_layout Plain Layout
26800 \begin_layout Section
26801 The substitution mechanism
26804 \begin_layout Standard
26805 When the external material facility invokes an external program, it is done
26806 on the basis of a command defined in the template configuration file.
26807 These commands can contain various macros that are expanded before execution.
26808 Execution always take place in the directory of the containing document.
26811 \begin_layout Standard
26812 Also, whenever external material is to be displayed, the name will be produced
26813 by the substitution mechanism, and most other commands in the template
26814 definition support substitution as well.
26817 \begin_layout Standard
26818 The available macros are the following:
26821 \begin_layout Description
26822 \begin_inset Flex Code
26825 \begin_layout Plain Layout
26826 $$AbsOrRelPathMaster
26831 The file path, absolute or relative to the master \SpecialChar LyX
26835 \begin_layout Description
26836 \begin_inset Flex Code
26839 \begin_layout Plain Layout
26840 $$AbsOrRelPathParent
26845 The file path, absolute or relative to the \SpecialChar LyX
26849 \begin_layout Description
26850 \begin_inset Flex Code
26853 \begin_layout Plain Layout
26859 The absolute file path.
26862 \begin_layout Description
26863 \begin_inset Flex Code
26866 \begin_layout Plain Layout
26872 The filename without path and without the extension.
26875 \begin_layout Description
26876 \begin_inset Flex Code
26879 \begin_layout Plain Layout
26881 \begin_inset Quotes eld
26885 \begin_inset Quotes erd
26893 This macro will expand to the contents of the file with the name
26894 \begin_inset Flex Code
26897 \begin_layout Plain Layout
26906 \begin_layout Description
26907 \begin_inset Flex Code
26910 \begin_layout Plain Layout
26916 The file extension (including the dot).
26919 \begin_layout Description
26920 \begin_inset Flex Code
26923 \begin_layout Plain Layout
26929 This will be the string
26930 \begin_inset Quotes eld
26934 \begin_inset Quotes erd
26937 if the file is in JPEG format, otherwise it will be the string
26938 \begin_inset Quotes eld
26942 \begin_inset Quotes erd
26946 This is useful to avoid uneeded conversions for output formats that support
26947 both PNG and JPEG fomats.
26948 The predefined RasterImage template uses this macro for the pdf\SpecialChar TeX
26953 \begin_layout Description
26954 \begin_inset Flex Code
26957 \begin_layout Plain Layout
26963 The filename of the file specified in the external material dialog.
26964 This is either an absolute name, or it is relative to the \SpecialChar LyX
26968 \begin_layout Description
26969 \begin_inset Flex Code
26972 \begin_layout Plain Layout
26979 \begin_inset Flex Code
26982 \begin_layout Plain Layout
26988 (absolute name or relative to the \SpecialChar LyX
26992 \begin_layout Description
26993 \begin_inset Flex Code
26996 \begin_layout Plain Layout
27002 The file path, relative to the master \SpecialChar LyX
27006 \begin_layout Description
27007 \begin_inset Flex Code
27010 \begin_layout Plain Layout
27016 The file path, relative to the \SpecialChar LyX
27020 \begin_layout Description
27021 \begin_inset Flex Code
27024 \begin_layout Plain Layout
27030 This macro will expand to the absolute path of the system directory.
27031 This is typically used to point to the various helper scripts that are
27032 bundled with \SpecialChar LyX
27036 \begin_layout Description
27037 \begin_inset Flex Code
27040 \begin_layout Plain Layout
27046 A name and full path to a temporary file which will be automatically deleted
27047 whenever the containing document is closed, or the external material insertion
27051 \begin_layout Standard
27052 All path macros contain a trailing directory separator, so you can construct
27054 \begin_inset space \thinspace{}
27058 \begin_inset space \space{}
27061 the absolute filename with
27062 \begin_inset Flex Code
27065 \begin_layout Plain Layout
27066 $$AbsPath$$Basename$$Extension
27074 \begin_layout Standard
27075 The macros above are substituted in all commands unless otherwise noted.
27077 \begin_inset Flex Code
27080 \begin_layout Plain Layout
27086 supports additionally the following substitutions if they are enabled by
27088 \begin_inset Flex Code
27091 \begin_layout Plain Layout
27098 \begin_inset Flex Code
27101 \begin_layout Plain Layout
27110 \begin_layout Description
27111 \begin_inset Flex Code
27114 \begin_layout Plain Layout
27120 The front part of the resize command.
27123 \begin_layout Description
27124 \begin_inset Flex Code
27127 \begin_layout Plain Layout
27133 The back part of the resize command.
27136 \begin_layout Description
27137 \begin_inset Flex Code
27140 \begin_layout Plain Layout
27146 The front part of the rotation command.
27149 \begin_layout Description
27150 \begin_inset Flex Code
27153 \begin_layout Plain Layout
27159 The back part of the rotation command.
27162 \begin_layout Standard
27163 The value string of the
27164 \begin_inset Flex Code
27167 \begin_layout Plain Layout
27173 command supports additionally the following substitutions if they are enabled
27175 \begin_inset Flex Code
27178 \begin_layout Plain Layout
27185 \begin_inset Flex Code
27188 \begin_layout Plain Layout
27197 \begin_layout Description
27198 \begin_inset Flex Code
27201 \begin_layout Plain Layout
27210 \begin_layout Description
27211 \begin_inset Flex Code
27214 \begin_layout Plain Layout
27223 \begin_layout Description
27224 \begin_inset Flex Code
27227 \begin_layout Plain Layout
27236 \begin_layout Description
27237 \begin_inset Flex Code
27240 \begin_layout Plain Layout
27246 The rotation option.
27249 \begin_layout Standard
27250 You may ask why there are so many path macros.
27251 There are mainly two reasons:
27254 \begin_layout Enumerate
27255 Relative and absolute file names should remain relative or absolute, respectivel
27257 Users may have reasons to prefer either form.
27258 Relative names are useful for portable documents that should work on different
27259 machines, for example.
27260 Absolute names may be required by some programs.
27263 \begin_layout Enumerate
27265 treats relative file names differently than \SpecialChar LyX
27266 and other programs in nested
27268 For \SpecialChar LyX
27269 , a relative file name is always relative to the document that contains
27271 For \SpecialChar LaTeX
27272 , it is always relative to the master document.
27273 These two definitions are identical if you have only one document, but
27274 differ if you have a master document that includes part documents.
27275 That means that relative filenames must be transformed when presented to
27278 Fortunately \SpecialChar LyX
27279 does this automatically for you if you choose the right macros.
27282 \begin_layout Standard
27283 So which path macro should be used in new template definitions? The rule
27287 \begin_layout Itemize
27289 \begin_inset Flex Code
27292 \begin_layout Plain Layout
27298 if an absolute path is required.
27301 \begin_layout Itemize
27303 \begin_inset Flex Code
27306 \begin_layout Plain Layout
27307 $$AbsOrRelPathMaster
27312 if the substituted string is some kind of \SpecialChar LaTeX
27316 \begin_layout Itemize
27318 \begin_inset Flex Code
27321 \begin_layout Plain Layout
27322 $$AbsOrRelPathParent
27327 in order to preserve the user's choice.
27330 \begin_layout Standard
27331 There are special cases where this rule does not work and e.
27332 \begin_inset space \thinspace{}
27336 \begin_inset space \space{}
27339 relative names are needed, but normally it will work just fine.
27340 One example for such a case is the command
27341 \begin_inset Flex Code
27344 \begin_layout Plain Layout
27345 ReferencedFile latex "$$AbsOrRelPathMaster$$Basename.pstex_t"
27350 in the XFig template above: We can't use the absolute name because the
27352 \begin_inset Flex Code
27355 \begin_layout Plain Layout
27361 files needs the relative name in order to rewrite the file content.
27364 \begin_layout Section
27365 Security discussion
27366 \begin_inset CommandInset label
27368 name "sec:Security-discussion"
27375 \begin_layout Standard
27376 The external material feature interfaces with a lot of external programs
27377 and does so automatically, so we have to consider the security implications
27379 In particular, since you have the option of including your own filenames
27380 and/or parameter strings and those are expanded into a command, it seems
27381 that it would be possible to create a malicious document which executes
27382 arbitrary commands when a user views or prints the document.
27383 This is something we definitely want to avoid.
27386 \begin_layout Standard
27387 However, since the external program commands are specified in the template
27388 configuration file only, there are no security issues if \SpecialChar LyX
27389 is properly configure
27390 d with safe templates only.
27391 This is so because the external programs are invoked with the
27392 \begin_inset Flex Code
27395 \begin_layout Plain Layout
27401 -system call rather than the
27402 \begin_inset Flex Code
27405 \begin_layout Plain Layout
27411 system-call, so it's not possible to execute arbitrary commands from the
27412 filename or parameter section via the shell.
27415 \begin_layout Standard
27416 This also implies that you are restricted in what command strings you can
27417 use in the external material templates.
27418 In particular, pipes and redirection are not readily available.
27419 This has to be so if \SpecialChar LyX
27420 should remain safe.
27421 If you want to use some of the shell features, you should write a safe
27422 script to do this in a controlled manner, and then invoke the script from
27423 the command string.
27427 \begin_layout Standard
27428 It is possible to design a template that interacts directly with the shell,
27429 but since this would allow a malicious user to execute arbitrary commands
27430 by writing clever filenames and/or parameters, we generally recommend that
27431 you only use safe scripts that work with the
27432 \begin_inset Flex Code
27435 \begin_layout Plain Layout
27441 system call in a controlled manner.
27442 Of course, for use in a controlled environment, it can be tempting to just
27443 fall back to use ordinary shell scripts.
27444 If you do so, be aware that you
27448 provide an easily exploitable security hole in your system.
27449 Of course it stands to reason that such unsafe templates will never be
27450 included in the standard \SpecialChar LyX
27451 distribution, although we do encourage people
27452 to submit new templates in the open source tradition.
27453 But \SpecialChar LyX
27454 as shipped from the official distribution channels will never have
27458 \begin_layout Standard
27459 Including external material provides a lot of power, and you have to be
27460 careful not to introduce security hazards with this power.
27461 A subtle error in a single line in an innocent looking script can open
27462 the door to huge security problems.
27463 So if you do not fully understand the issues, we recommend that you consult
27464 a knowledgeable security professional or the \SpecialChar LyX
27465 development team if you have
27466 any questions about whether a given template is safe or not.
27467 And do this before you use it in an uncontrolled environment.
27470 \begin_layout Chapter
27472 List of supported \SpecialChar LyX
27473 functions to be used in layouts
27474 \begin_inset CommandInset label
27476 name "chap:List-of-functions"
27483 \begin_layout Standard
27485 \begin_inset Tabular
27486 <lyxtabular version="3" rows="11" columns="8">
27487 <features tabularvalignment="middle">
27488 <column alignment="left" valignment="top">
27489 <column alignment="left" valignment="top">
27490 <column alignment="left" valignment="top">
27491 <column alignment="left" valignment="top">
27492 <column alignment="left" valignment="top">
27493 <column alignment="left" valignment="top">
27494 <column alignment="left" valignment="top">
27495 <column alignment="left" valignment="top">
27497 <cell alignment="left" valignment="top" usebox="none">
27500 \begin_layout Plain Layout
27506 <cell alignment="left" valignment="top" usebox="none">
27509 \begin_layout Plain Layout
27515 <cell alignment="left" valignment="top" usebox="none">
27518 \begin_layout Plain Layout
27524 <cell alignment="left" valignment="top" usebox="none">
27527 \begin_layout Plain Layout
27533 <cell alignment="center" valignment="top" usebox="none">
27536 \begin_layout Plain Layout
27542 <cell alignment="center" valignment="top" usebox="none">
27545 \begin_layout Plain Layout
27551 <cell alignment="center" valignment="top" usebox="none">
27554 \begin_layout Plain Layout
27560 <cell alignment="center" valignment="top" usebox="none">
27563 \begin_layout Plain Layout
27571 <cell alignment="left" valignment="top" usebox="none">
27574 \begin_layout Plain Layout
27580 <cell alignment="left" valignment="top" usebox="none">
27583 \begin_layout Plain Layout
27589 <cell alignment="left" valignment="top" usebox="none">
27592 \begin_layout Plain Layout
27598 <cell alignment="left" valignment="top" usebox="none">
27601 \begin_layout Plain Layout
27607 <cell alignment="center" valignment="top" usebox="none">
27610 \begin_layout Plain Layout
27616 <cell alignment="center" valignment="top" usebox="none">
27619 \begin_layout Plain Layout
27625 <cell alignment="center" valignment="top" usebox="none">
27628 \begin_layout Plain Layout
27634 <cell alignment="center" valignment="top" usebox="none">
27637 \begin_layout Plain Layout
27645 <cell alignment="left" valignment="top" usebox="none">
27648 \begin_layout Plain Layout
27654 <cell alignment="left" valignment="top" usebox="none">
27657 \begin_layout Plain Layout
27663 <cell alignment="left" valignment="top" usebox="none">
27666 \begin_layout Plain Layout
27672 <cell alignment="left" valignment="top" usebox="none">
27675 \begin_layout Plain Layout
27681 <cell alignment="center" valignment="top" usebox="none">
27684 \begin_layout Plain Layout
27690 <cell alignment="center" valignment="top" usebox="none">
27693 \begin_layout Plain Layout
27699 <cell alignment="center" valignment="top" usebox="none">
27702 \begin_layout Plain Layout
27708 <cell alignment="center" valignment="top" usebox="none">
27711 \begin_layout Plain Layout
27719 <cell alignment="left" valignment="top" usebox="none">
27722 \begin_layout Plain Layout
27728 <cell alignment="left" valignment="top" usebox="none">
27731 \begin_layout Plain Layout
27737 <cell alignment="left" valignment="top" usebox="none">
27740 \begin_layout Plain Layout
27746 <cell alignment="left" valignment="top" usebox="none">
27749 \begin_layout Plain Layout
27755 <cell alignment="center" valignment="top" usebox="none">
27758 \begin_layout Plain Layout
27764 <cell alignment="center" valignment="top" usebox="none">
27767 \begin_layout Plain Layout
27773 <cell alignment="center" valignment="top" usebox="none">
27776 \begin_layout Plain Layout
27782 <cell alignment="center" valignment="top" usebox="none">
27785 \begin_layout Plain Layout
27793 <cell alignment="left" valignment="top" usebox="none">
27796 \begin_layout Plain Layout
27802 <cell alignment="left" valignment="top" usebox="none">
27805 \begin_layout Plain Layout
27811 <cell alignment="left" valignment="top" usebox="none">
27814 \begin_layout Plain Layout
27820 <cell alignment="left" valignment="top" usebox="none">
27823 \begin_layout Plain Layout
27829 <cell alignment="center" valignment="top" usebox="none">
27832 \begin_layout Plain Layout
27838 <cell alignment="center" valignment="top" usebox="none">
27841 \begin_layout Plain Layout
27847 <cell alignment="center" valignment="top" usebox="none">
27850 \begin_layout Plain Layout
27856 <cell alignment="center" valignment="top" usebox="none">
27859 \begin_layout Plain Layout
27867 <cell alignment="left" valignment="top" usebox="none">
27870 \begin_layout Plain Layout
27876 <cell alignment="left" valignment="top" usebox="none">
27879 \begin_layout Plain Layout
27885 <cell alignment="left" valignment="top" usebox="none">
27888 \begin_layout Plain Layout
27894 <cell alignment="left" valignment="top" usebox="none">
27897 \begin_layout Plain Layout
27903 <cell alignment="center" valignment="top" usebox="none">
27906 \begin_layout Plain Layout
27912 <cell alignment="center" valignment="top" usebox="none">
27915 \begin_layout Plain Layout
27921 <cell alignment="center" valignment="top" usebox="none">
27924 \begin_layout Plain Layout
27930 <cell alignment="center" valignment="top" usebox="none">
27933 \begin_layout Plain Layout
27941 <cell alignment="left" valignment="top" usebox="none">
27944 \begin_layout Plain Layout
27950 <cell alignment="left" valignment="top" usebox="none">
27953 \begin_layout Plain Layout
27959 <cell alignment="left" valignment="top" usebox="none">
27962 \begin_layout Plain Layout
27968 <cell alignment="left" valignment="top" usebox="none">
27971 \begin_layout Plain Layout
27977 <cell alignment="center" valignment="top" usebox="none">
27980 \begin_layout Plain Layout
27986 <cell alignment="center" valignment="top" usebox="none">
27989 \begin_layout Plain Layout
27995 <cell alignment="center" valignment="top" usebox="none">
27998 \begin_layout Plain Layout
28004 <cell alignment="center" valignment="top" usebox="none">
28007 \begin_layout Plain Layout
28015 <cell alignment="left" valignment="top" usebox="none">
28018 \begin_layout Plain Layout
28024 <cell alignment="left" valignment="top" usebox="none">
28027 \begin_layout Plain Layout
28033 <cell alignment="left" valignment="top" usebox="none">
28036 \begin_layout Plain Layout
28042 <cell alignment="left" valignment="top" usebox="none">
28045 \begin_layout Plain Layout
28051 <cell alignment="center" valignment="top" usebox="none">
28054 \begin_layout Plain Layout
28060 <cell alignment="center" valignment="top" usebox="none">
28063 \begin_layout Plain Layout
28069 <cell alignment="center" valignment="top" usebox="none">
28072 \begin_layout Plain Layout
28078 <cell alignment="center" valignment="top" usebox="none">
28081 \begin_layout Plain Layout
28089 <cell alignment="left" valignment="top" usebox="none">
28092 \begin_layout Plain Layout
28098 <cell alignment="left" valignment="top" usebox="none">
28101 \begin_layout Plain Layout
28107 <cell alignment="left" valignment="top" usebox="none">
28110 \begin_layout Plain Layout
28116 <cell alignment="left" valignment="top" usebox="none">
28119 \begin_layout Plain Layout
28125 <cell alignment="center" valignment="top" usebox="none">
28128 \begin_layout Plain Layout
28134 <cell alignment="center" valignment="top" usebox="none">
28137 \begin_layout Plain Layout
28143 <cell alignment="center" valignment="top" usebox="none">
28146 \begin_layout Plain Layout
28152 <cell alignment="center" valignment="top" usebox="none">
28155 \begin_layout Plain Layout
28163 <cell alignment="left" valignment="top" usebox="none">
28166 \begin_layout Plain Layout
28172 <cell alignment="left" valignment="top" usebox="none">
28175 \begin_layout Plain Layout
28181 <cell alignment="left" valignment="top" usebox="none">
28184 \begin_layout Plain Layout
28190 <cell alignment="left" valignment="top" usebox="none">
28193 \begin_layout Plain Layout
28199 <cell alignment="center" valignment="top" usebox="none">
28202 \begin_layout Plain Layout
28208 <cell alignment="center" valignment="top" usebox="none">
28211 \begin_layout Plain Layout
28217 <cell alignment="center" valignment="top" usebox="none">
28220 \begin_layout Plain Layout
28226 <cell alignment="center" valignment="top" usebox="none">
28229 \begin_layout Plain Layout
28237 <cell alignment="center" valignment="top" usebox="none">
28240 \begin_layout Plain Layout
28246 <cell alignment="center" valignment="top" usebox="none">
28249 \begin_layout Plain Layout
28255 <cell alignment="center" valignment="top" usebox="none">
28258 \begin_layout Plain Layout
28264 <cell alignment="center" valignment="top" usebox="none">
28267 \begin_layout Plain Layout
28273 <cell alignment="center" valignment="top" usebox="none">
28276 \begin_layout Plain Layout
28282 <cell alignment="center" valignment="top" usebox="none">
28285 \begin_layout Plain Layout
28291 <cell alignment="center" valignment="top" usebox="none">
28294 \begin_layout Plain Layout
28300 <cell alignment="center" valignment="top" usebox="none">
28303 \begin_layout Plain Layout
28317 \begin_layout Chapter
28318 Names of available colors to be used in layouts
28319 \begin_inset CommandInset label
28321 name "chap:Names-of-colors"
28328 \begin_layout Standard
28329 The colors listed here are the standard colors and the those that you can
28330 adjust in the \SpecialChar LyX
28334 \begin_layout Description
28347 No particular color – clear or default
28350 \begin_layout Description
28354 \begin_layout Description
28358 \begin_layout Description
28362 \begin_layout Description
28366 \begin_layout Description
28370 \begin_layout Description
28374 \begin_layout Description
28378 \begin_layout Description
28382 \begin_layout Description
28383 added_space Added space marker color
28386 \begin_layout Description
28387 addedtext Added text color
28390 \begin_layout Description
28391 appendix Appendix marker color
28394 \begin_layout Description
28395 background Background color
28398 \begin_layout Description
28399 bottomarea Bottom area color
28402 \begin_layout Description
28403 branchlabel Label color for branches
28406 \begin_layout Description
28407 buttonbg Color used for button background
28410 \begin_layout Description
28411 buttonhoverbg Color used for button background under focus
28414 \begin_layout Description
28415 buttonframe Color for inset button frames
28418 \begin_layout Description
28419 changebar Changebar color
28422 \begin_layout Description
28423 changedtextauthor1 Changed text color author 1
28426 \begin_layout Description
28427 changedtextauthor2 Changed text color author 2
28430 \begin_layout Description
28431 changedtextauthor3 Changed text color author 3
28434 \begin_layout Description
28435 changedtextauthor4 Changed text color author 4
28438 \begin_layout Description
28439 changedtextauthor5 Changed text color author 5
28442 \begin_layout Description
28443 collapsable_inset_frame Collapsable insets framecolor
28446 \begin_layout Description
28447 collapsable_inset_text Collapsable insets text color
28450 \begin_layout Description
28451 command Text color for command insets
28454 \begin_layout Description
28455 commandbg Background color for command insets
28458 \begin_layout Description
28459 commandframe Frame color for command insets
28462 \begin_layout Description
28463 comment color for comments
28466 \begin_layout Description
28467 commentbg Background color of comments
28470 \begin_layout Description
28471 cursor Cursor color
28474 \begin_layout Description
28475 deletedtext Deleted text color
28478 \begin_layout Description
28479 deletedtextmodifier Deleted text modifying color
28482 \begin_layout Description
28483 depthbar Color for the depth bars in the margin
28486 \begin_layout Description
28487 eolmarker End of line marker color
28490 \begin_layout Description
28491 error Color of the \SpecialChar LaTeX
28495 \begin_layout Description
28496 footlabel Label color for footnotes
28499 \begin_layout Description
28500 graphicsbg Graphics inset background color
28503 \begin_layout Description
28504 greyedout Label color for greyedout insets
28507 \begin_layout Description
28508 greyedoutbg Background color of greyedout inset
28511 \begin_layout Description
28512 greyedouttext Color for greyedout inset text
28515 \begin_layout Description
28516 indexlabel Label color for index insets
28519 \begin_layout Description
28520 ignore The color is ignored
28523 \begin_layout Description
28524 inherit The color is inherited
28527 \begin_layout Description
28528 inlinecompletion Inline completion color
28531 \begin_layout Description
28532 insetbg Inset marker background color
28535 \begin_layout Description
28536 insetframe Inset marker frame color
28539 \begin_layout Description
28540 language Color for marking foreign language words
28543 \begin_layout Description
28544 latex Text color in \SpecialChar LaTeX
28548 \begin_layout Description
28549 listingsbg Background color of listings inset
28552 \begin_layout Description
28553 marginlabel Label color for margin notes
28556 \begin_layout Description
28557 math Math inset text color
28560 \begin_layout Description
28561 mathbg Math inset background color
28564 \begin_layout Description
28565 mathcorners Math inset frame color not under focus
28568 \begin_layout Description
28569 mathframe Math inset frame color under focus
28572 \begin_layout Description
28573 mathline Math line color
28576 \begin_layout Description
28577 mathmacrobg Macro math inset background color
28580 \begin_layout Description
28581 mathmacroblend Macro math blended color
28584 \begin_layout Description
28585 mathmacroframe Macro math frame color
28588 \begin_layout Description
28589 mathmacrohoverbg Macro math inset background color hovered
28592 \begin_layout Description
28593 mathmacrolabel Macro math label color
28596 \begin_layout Description
28597 mathmacronewarg Macro template color for new parameters
28600 \begin_layout Description
28601 mathmacrooldarg Macro template color for old parameters
28604 \begin_layout Description
28605 newpage New page color
28608 \begin_layout Description
28609 nonunique_inlinecompletion Inline completion color for the non-unique part
28612 \begin_layout Description
28613 notebg Background color of notes
28616 \begin_layout Description
28617 notelabel Label color for notes
28620 \begin_layout Description
28621 pagebreak Page break/line break color
28624 \begin_layout Description
28625 paragraphmarker Color used for the pilcrow sign to mark the end of a paragraph
28628 \begin_layout Description
28629 phantomtext Text color for phantom insets
28632 \begin_layout Description
28633 preview The color used for previews
28636 \begin_layout Description
28637 previewframe Preview frame color
28640 \begin_layout Description
28641 regexpframe Color for regexp frame
28644 \begin_layout Description
28645 selection Background color of selected text
28648 \begin_layout Description
28649 selectiontext Foreground color of selected text
28652 \begin_layout Description
28653 shadedbg Background color of shaded box
28656 \begin_layout Description
28657 special Special chars text color
28660 \begin_layout Description
28661 tabularline Table line color
28664 \begin_layout Description
28665 tabularonoffline Table line color
28668 \begin_layout Description
28669 urllabel Label color for URL insets
28672 \begin_layout Description
28673 urltext Color for URL inset text