1 #LyX 2.2 created this file. For more info see http://www.lyx.org/
5 \origin /systemlyxdir/doc/
8 % DO NOT ALTER THIS PREAMBLE!!!
10 % This preamble is designed to ensure that this document prints
11 % out as advertised. If you mess with this preamble,
12 % parts of this document may not print out as expected. If you
13 % have problems LaTeXing this file, please contact
14 % the documentation team
15 % email: lyx-docs@lists.lyx.org
17 \usepackage{ifpdf} % part of the hyperref bundle
18 \ifpdf % if pdflatex is used
20 % set fonts for nicer pdf view
21 \IfFileExists{lmodern.sty}
22 {\usepackage{lmodern}}{}
24 \fi % end if pdflatex is used
26 % the pages of the TOC is numbered roman
27 % and a pdf-bookmark for the TOC is added
28 \let\myTOC\tableofcontents
29 \renewcommand\tableofcontents{%
31 \pdfbookmark[1]{\contentsname}{}
35 % increase link area for cross-references and autoname them,
36 \AtBeginDocument{\renewcommand{\ref}[1]{\mbox{\autoref{#1}}}}
37 \@ifundefined{extrasenglish}{\usepackage[english]{babel}}{}
38 \addto\extrasenglish{%
39 \renewcommand*{\equationautorefname}[1]{}%
40 \renewcommand{\sectionautorefname}{sec.\negthinspace}%
41 \renewcommand{\subsectionautorefname}{sec.\negthinspace}%
42 \renewcommand{\subsubsectionautorefname}{sec.\negthinspace}%
45 \options fleqn,bibliography=totoc,index=totoc,BCOR7.5mm,titlepage,captions=tableheading
46 \use_default_options false
50 \maintain_unincluded_children false
53 InsetLayout Flex:MenuItem
62 \newcommand*{\menuitem}[1]{{\sffamily #1}}
65 # In case we need to do with sans...
66 #InsetLayout CharStyle:Code
71 #\renewcommand{\code}[1]{{\sffamily #1}}
76 \language_package default
81 \font_typewriter default
83 \font_default_family default
84 \use_non_tex_fonts false
90 \default_output_format default
92 \bibtex_command default
93 \index_command default
97 \pdf_title "LyX Configuration Manual"
98 \pdf_author "LyX Team"
99 \pdf_subject "LyX-documentation Customization"
100 \pdf_keywords "LyX, documentation, customization"
102 \pdf_bookmarksnumbered true
103 \pdf_bookmarksopen true
104 \pdf_bookmarksopenlevel 1
105 \pdf_breaklinks false
109 \pdf_pdfusetitle false
110 \pdf_quoted_options "linkcolor=black, citecolor=black, urlcolor=blue, filecolor=blue,pdfpagelayout=OneColumn, pdfnewwindow=true, pdfstartview=XYZ, plainpages=false"
113 \use_package amsmath 0
114 \use_package amssymb 0
115 \use_package cancel 0
117 \use_package mathdots 1
118 \use_package mathtools 0
119 \use_package mhchem 0
120 \use_package stackrel 0
121 \use_package stmaryrd 0
122 \use_package undertilde 0
124 \cite_engine_type default
128 \paperorientation portrait
143 \paragraph_separation indent
144 \paragraph_indentation default
145 \quotes_language english
148 \paperpagestyle headings
149 \tracking_changes true
150 \output_changes false
154 \author -712698321 "Jürgen Spitzmüller"
155 \author -195340706 "Georg Baum"
156 \author 155139281 "Jrgen Spitzmller"
157 \author 274215730 "scott"
163 Customizing \SpecialChar LyX
164 : Features for the Advanced User
168 by the \SpecialChar LyX
173 \begin_layout Plain Layout
175 If you have comments or error corrections, please send them to the \SpecialChar LyX
178 \begin_inset CommandInset href
180 target "lyx-docs@lists.lyx.org"
187 \begin_inset Quotes eld
191 \begin_inset Quotes erd
194 in the subject header, and please cc the current maintainer of this file,
195 Richard Heck <rgheck@comcast.net>.
201 \begin_inset Newline newline
205 \begin_inset Newline newline
211 \begin_layout Standard
212 \begin_inset CommandInset toc
213 LatexCommand tableofcontents
220 \begin_layout Standard
221 \begin_inset Note Note
224 \begin_layout Plain Layout
225 Please use change tracking when modifying this document.
226 This makes it easier for our translators to recognize things that have
227 been changed, and it helps the maintainer keep up-to-date with what's been
236 \begin_layout Chapter
240 \begin_layout Standard
241 This manual covers the customization features present in \SpecialChar LyX
243 In it, we discuss issues like keyboard shortcuts, screen previewing options,
244 printer options, sending commands to \SpecialChar LyX
245 via the \SpecialChar LyX
246 Server, internationalization,
247 installing new \SpecialChar LaTeX
248 classes and \SpecialChar LyX
250 We can't possibly hope to touch on everything you can change—our developers
251 add new features faster than we can document them—but we will explain the
252 most common customizations and hopefully point you in the right direction
253 for some of the more obscure ones.
256 \begin_layout Standard
257 \begin_inset Branch OutDated
260 \begin_layout Standard
261 Information from previous versions of this document that now seems to be
262 outdated is contained in the OutDated branch of this document.
263 By default, this information will not appear in the \SpecialChar LaTeX
272 \begin_layout Chapter
277 \begin_layout Standard
278 This chapter aims to help you to find your way through the \SpecialChar LyX
281 Before continuing to read this chapter, you should find out where your
283 library and user directories are by using
284 \begin_inset Flex MenuItem
287 \begin_layout Plain Layout
288 Help\SpecialChar menuseparator
294 \change_deleted -712698321 1437634470
297 \change_inserted -712698321 1437634471
306 The library directory is the place where \SpecialChar LyX
307 places its system-wide configuration
308 files; the user directory is where you can place your modified versions.
309 We will call the former
310 \begin_inset Flex Code
313 \begin_layout Plain Layout
315 \change_inserted -712698321 1437634480
317 \change_deleted -712698321 1437634481
327 \begin_inset Flex MenuItem
330 \begin_layout Plain Layout
336 in the remainder of this document.
340 \begin_layout Section
342 \begin_inset Flex Code
345 \begin_layout Plain Layout
347 \change_inserted -712698321 1437634488
349 \change_deleted -712698321 1437634487
361 \begin_layout Standard
362 \begin_inset Flex Code
365 \begin_layout Plain Layout
367 \change_deleted -712698321 1437634497
370 \change_inserted -712698321 1437634498
378 and its sub-directories contain a number of files and that can be used
379 to customize \SpecialChar LyX
381 You can change many of these files from within \SpecialChar LyX
383 \begin_inset Flex MenuItem
386 \begin_layout Plain Layout
387 Tools\SpecialChar menuseparator
394 Most customization that you will want to do in \SpecialChar LyX
395 is possible through this
397 However, many other inner aspects of \SpecialChar LyX
398 can be customized by modifying the
400 \begin_inset Flex Code
403 \begin_layout Plain Layout
405 \change_deleted -712698321 1437634507
408 \change_inserted -712698321 1437634507
417 These files fall in different categories, described in the following subsection
421 \begin_layout Subsection
422 Automatically generated files
425 \begin_layout Standard
426 The files, which are to be found in
427 \begin_inset Flex MenuItem
430 \begin_layout Plain Layout
436 , are generated when you configure \SpecialChar LyX
438 They contain various default values that are guessed by inspection.
439 In general, it is not a good idea to modify them, since they might be overwritt
443 \begin_layout Labeling
444 \labelwidthstring 00.00.0000
445 \begin_inset Flex Code
448 \begin_layout Plain Layout
454 contains defaults for various commands.
457 \begin_layout Labeling
458 \labelwidthstring 00.00.0000
459 \begin_inset Flex Code
462 \begin_layout Plain Layout
468 contains the list of packages that have been recognized by \SpecialChar LyX
470 It is currently unused by the \SpecialChar LyX
471 program itself, but the information extracted,
472 and more, is made available with
473 \begin_inset Flex MenuItem
476 \begin_layout Plain Layout
477 Help\SpecialChar menuseparator
491 \begin_layout Labeling
492 \labelwidthstring 00.00.0000
493 \begin_inset Flex Code
496 \begin_layout Plain Layout
502 the list of text classes that have been found in your
503 \begin_inset Flex Code
506 \begin_layout Plain Layout
512 directories, along with the associated \SpecialChar LaTeX
513 document class and their description.
516 \begin_layout Labeling
517 \labelwidthstring 00.00.0000
518 \begin_inset Flex Code
521 \begin_layout Plain Layout
527 the list of layout modules found in your
528 \begin_inset Flex Code
531 \begin_layout Plain Layout
540 \begin_layout Labeling
541 \labelwidthstring 00.00.0000
542 \begin_inset Flex Code
545 \begin_layout Plain Layout
551 lists of various sorts of \SpecialChar LaTeX
552 -related files found on your system
555 \begin_layout Labeling
556 \labelwidthstring 00.00.0000
557 \begin_inset Flex Code
560 \begin_layout Plain Layout
561 doc/\SpecialChar LaTeX
567 is automatically generated during configuration from the file
568 \begin_inset Flex Code
571 \begin_layout Plain Layout
579 It contains information on your \SpecialChar LaTeX
583 \begin_layout Subsection
587 \begin_layout Standard
588 These directories are duplicated between
589 \begin_inset Flex Code
592 \begin_layout Plain Layout
594 \change_deleted -712698321 1437634516
597 \change_inserted -712698321 1437634517
606 \begin_inset Flex Code
609 \begin_layout Plain Layout
616 If a particular files exists in both places, the one in
617 \begin_inset Flex Code
620 \begin_layout Plain Layout
629 \begin_layout Labeling
630 \labelwidthstring 00.00.0000
631 \begin_inset Flex Code
634 \begin_layout Plain Layout
640 this directory contains files with the extension
641 \begin_inset Flex Code
644 \begin_layout Plain Layout
650 that define the keybindings used in \SpecialChar LyX
652 If there exists an internationalized version of the bind file named
653 \begin_inset Flex Code
656 \begin_layout Plain Layout
662 , that will be used first.
665 \begin_layout Labeling
666 \labelwidthstring 00.00.0000
667 \begin_inset Flex Code
670 \begin_layout Plain Layout
676 contains graphics files that can be included in documents.
680 \begin_layout Labeling
681 \labelwidthstring 00.00.0000
682 \begin_inset Flex Code
685 \begin_layout Plain Layout
691 contains \SpecialChar LyX
692 documentation files (including the one you are currently reading).
694 \begin_inset Flex Code
697 \begin_layout Plain Layout
704 deserves special attention, as noted above.
705 The internationalized help docs are in subdirectories
706 \begin_inset Flex Code
709 \begin_layout Plain Layout
716 \begin_inset Quotes eld
720 \begin_inset Quotes erd
723 is the ISO language code.
725 \begin_inset CommandInset ref
727 reference "cha:Internationalizing-LyX"
734 \begin_layout Labeling
735 \labelwidthstring 00.00.0000
736 \begin_inset Flex Code
739 \begin_layout Plain Layout
745 contains example files that explain how to use some features.
746 In the file browser, press the
747 \begin_inset Flex MenuItem
750 \begin_layout Plain Layout
759 \begin_layout Labeling
760 \labelwidthstring 00.00.0000
761 \begin_inset Flex Code
764 \begin_layout Plain Layout
770 contains image files that are used by the
771 \begin_inset Flex MenuItem
774 \begin_layout Plain Layout
781 In addition, it also contains the individual icons used in the toolbar
782 and the banners that can be shown when \SpecialChar LyX
786 \begin_layout Labeling
787 \labelwidthstring 00.00.0000
788 \begin_inset Flex Code
791 \begin_layout Plain Layout
797 contains keyboard keymapping files.
799 \begin_inset CommandInset ref
801 reference "sec:International-Keymap-Stuff"
808 \begin_layout Labeling
809 \labelwidthstring 00.00.0000
810 \begin_inset Flex Code
813 \begin_layout Plain Layout
819 contains the text class and module files described in
820 \begin_inset CommandInset ref
822 reference "cha:Installing-New-Document"
829 \begin_layout Labeling
830 \labelwidthstring 00.00.0000
831 \begin_inset Flex Code
834 \begin_layout Plain Layout
841 \begin_inset Flex Code
844 \begin_layout Plain Layout
850 Python scripts used to convert between \SpecialChar LyX
852 These can be run from the command line if, say, you want to batch-convert
856 \begin_layout Labeling
857 \labelwidthstring 00.00.0000
858 \begin_inset Flex Code
861 \begin_layout Plain Layout
867 contains some files that demonstrate the capabilities of the
868 \begin_inset Flex MenuItem
871 \begin_layout Plain Layout
882 Also contains some scripts used by \SpecialChar LyX
886 \begin_layout Labeling
887 \labelwidthstring 00.00.0000
888 \begin_inset Flex Code
891 \begin_layout Plain Layout
897 contains the standard \SpecialChar LyX
898 template files described in
899 \begin_inset CommandInset ref
901 reference "subsec:Creating-Templates"
908 \begin_layout Labeling
909 \labelwidthstring 00.00.0000
910 \begin_inset Flex Code
913 \begin_layout Plain Layout
919 contains files with the extension
920 \begin_inset Flex Code
923 \begin_layout Plain Layout
929 that define the user interface to \SpecialChar LyX
931 That is, the files define which items appear in which menus and the items
932 appearing on the toolbar.
935 \begin_layout Subsection
936 Files you don't want to modify
939 \begin_layout Standard
940 These files are used internally by \SpecialChar LyX
941 and you generally do not need to modify
942 them unless you are a developer.
945 \begin_layout Labeling
946 \labelwidthstring 00.00.0000
947 \begin_inset Flex Code
950 \begin_layout Plain Layout
956 this file contains the list of \SpecialChar LyX
958 The contents are displayed with the menu entry
959 \begin_inset Flex MenuItem
962 \begin_layout Plain Layout
963 Help\SpecialChar menuseparator
969 \change_deleted -712698321 1437634530
972 \change_inserted -712698321 1437634531
983 \begin_layout Labeling
984 \labelwidthstring 00.00.0000
985 \begin_inset Flex Code
988 \begin_layout Plain Layout
994 this is a \SpecialChar LaTeX
995 script used during the configuration process.
999 \begin_layout Labeling
1000 \labelwidthstring 00.00.0000
1001 \begin_inset Flex Code
1004 \begin_layout Plain Layout
1010 this is a Python script that is used to re-configure \SpecialChar LyX
1012 It creates configuration files in the directory it was run from.
1015 \begin_layout Subsection
1016 Other files needing a line or two
1019 \begin_layout Labeling
1020 \labelwidthstring 00.00.0000
1021 \begin_inset Flex Code
1024 \begin_layout Plain Layout
1030 this contains tables describing how different character encodings can be
1034 \begin_layout Labeling
1035 \labelwidthstring 00.00.0000
1036 \begin_inset Flex Code
1039 \begin_layout Plain Layout
1045 this file contains the templates available to the new
1046 \begin_inset Flex MenuItem
1049 \begin_layout Plain Layout
1051 \begin_inset space ~
1060 \begin_inset CommandInset ref
1062 reference "chap:Including-External-Material"
1069 \begin_layout Labeling
1070 \labelwidthstring 00.00.0000
1071 \begin_inset Flex Code
1074 \begin_layout Plain Layout
1080 this file contains a list of all the languages currently supported by \SpecialChar LyX
1084 \begin_layout Labeling
1085 \labelwidthstring 00.00.0000
1086 \begin_inset Flex Code
1089 \begin_layout Plain Layout
1095 contains information about the supported fonts.
1098 \begin_layout Labeling
1099 \labelwidthstring 00.00.0000
1100 \begin_inset Flex Code
1103 \begin_layout Plain Layout
1109 this file contains translations for internationalized paragraph styles
1111 \begin_inset CommandInset ref
1113 reference "subsec:I18n"
1120 \begin_layout Labeling
1121 \labelwidthstring 00.00.0000
1122 \begin_inset Flex Code
1125 \begin_layout Plain Layout
1131 this file contains information about unicode-encoded glyphs and the way
1132 they are supported by \SpecialChar LyX
1133 via \SpecialChar LaTeX
1137 \begin_layout Section
1138 Your local configuration directory
1141 \begin_layout Standard
1142 Even if you are using \SpecialChar LyX
1143 as an unprivileged user, you might want to change
1145 configuration for your own use.
1147 \begin_inset Flex Code
1150 \begin_layout Plain Layout
1156 directory contains all your personal configuration files.
1157 This is the directory described as
1158 \begin_inset Quotes eld
1162 \begin_inset Quotes erd
1166 \begin_inset Flex MenuItem
1169 \begin_layout Plain Layout
1170 Help\SpecialChar menuseparator
1172 \begin_inset space ~
1176 \change_inserted -712698321 1437634544
1178 \change_deleted -712698321 1437634543
1188 This directory is used as a mirror of
1189 \begin_inset Flex Code
1192 \begin_layout Plain Layout
1194 \change_deleted -712698321 1437634548
1197 \change_inserted -712698321 1437634549
1205 , which means that every file in
1206 \begin_inset Flex Code
1209 \begin_layout Plain Layout
1215 is a replacement for the corresponding file in
1216 \begin_inset Flex Code
1219 \begin_layout Plain Layout
1221 \change_deleted -712698321 1437634553
1224 \change_inserted -712698321 1437634554
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 MenuItem
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 MenuItem
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 MenuItem
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 MenuItem
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 MenuItem
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 MenuItem
1496 \begin_layout Plain Layout
1497 Tools\SpecialChar menuseparator
1505 \begin_inset Flex MenuItem
1508 \begin_layout Plain Layout
1509 File Handling\SpecialChar menuseparator
1516 \begin_inset Flex MenuItem
1519 \begin_layout Plain Layout
1525 button to define your new format.
1527 \begin_inset Flex MenuItem
1530 \begin_layout Plain Layout
1536 field contains the name used to identify the format in the GUI.
1538 \begin_inset Flex MenuItem
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 MenuItem
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 MenuItem
1565 \begin_layout Plain Layout
1572 \begin_inset Flex MenuItem
1575 \begin_layout Plain Layout
1576 Document\SpecialChar menuseparator
1577 View (Other Formats)\SpecialChar menuseparator
1586 \begin_layout Standard
1588 \begin_inset Flex MenuItem
1591 \begin_layout Plain Layout
1598 \begin_inset Flex MenuItem
1601 \begin_layout Plain Layout
1608 For example, you might want to use
1609 \begin_inset Flex MenuItem
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 MenuItem
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 MenuItem
1641 \begin_layout Plain Layout
1647 in the appearing context menu.
1650 \begin_layout Standard
1652 \begin_inset Flex MenuItem
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/"
1674 Therefore \SpecialChar LyX
1675 uses the extended list of MIME types as specified by
1676 \begin_inset CommandInset href
1678 name "freedesktop.org"
1679 target "http://www.freedesktop.org/wiki/Specifications/shared-mime-info-spec"
1686 \begin_layout Standard
1688 \begin_inset Flex MenuItem
1691 \begin_layout Plain Layout
1697 option tells \SpecialChar LyX
1698 that a format is suitable for document export.
1699 If this is set and if a suitable conversion route exists (see
1700 \begin_inset CommandInset ref
1702 reference "sec:Converters"
1706 ), the format will appear in the
1707 \begin_inset Flex MenuItem
1710 \begin_layout Plain Layout
1711 File\SpecialChar menuseparator
1718 The format will also appear in the
1719 \begin_inset Flex MenuItem
1722 \begin_layout Plain Layout
1723 Document\SpecialChar menuseparator
1729 menu if a viewer is specified for the format.
1730 Pure image formats, such as
1731 \begin_inset Flex Code
1734 \begin_layout Plain Layout
1740 , should not use this option.
1741 Formats that can both represent vector graphics and documents like
1742 \begin_inset Flex Code
1745 \begin_layout Plain Layout
1754 \begin_layout Standard
1756 \begin_inset Flex MenuItem
1759 \begin_layout Plain Layout
1760 Vector graphics format
1765 tells \SpecialChar LyX
1766 that a format can contain vector graphics.
1767 This information is used to determine the target format of included graphics
1769 \begin_inset Flex MenuItem
1772 \begin_layout Plain Layout
1779 Included graphics may need to be converted to either
1780 \begin_inset Flex MenuItem
1783 \begin_layout Plain Layout
1790 \begin_inset Flex MenuItem
1793 \begin_layout Plain Layout
1800 \begin_inset Flex MenuItem
1803 \begin_layout Plain Layout
1810 \begin_inset Flex MenuItem
1813 \begin_layout Plain Layout
1819 cannot handle other image formats.
1820 If an included graphic is not already in
1821 \begin_inset Flex MenuItem
1824 \begin_layout Plain Layout
1831 \begin_inset Flex MenuItem
1834 \begin_layout Plain Layout
1841 \begin_inset Flex MenuItem
1844 \begin_layout Plain Layout
1850 format, it is converted to
1851 \begin_inset Flex MenuItem
1854 \begin_layout Plain Layout
1860 if the vector format option is set, and otherwise to
1861 \begin_inset Flex MenuItem
1864 \begin_layout Plain Layout
1873 \begin_layout Section
1877 \begin_layout Standard
1878 Since all conversions from one format to another take place in \SpecialChar LyX
1880 directory, it is sometimes necessary to modify a file before copying it
1881 to the temporary directory in order that the conversion may be performed.
1885 \begin_layout Plain Layout
1886 For example, the file may refer to other files—images, for example—using
1887 relative file names, and these may become invalid when the file is copied
1888 to the temporary directory.
1893 This is done by a Copier: It copies a file to (or from) the temporary directory
1894 and may modify it in the process.
1897 \begin_layout Standard
1898 The definitions of the copiers may use four variables:
1901 \begin_layout Labeling
1902 \labelwidthstring 00.00.0000
1903 \begin_inset Flex Code
1906 \begin_layout Plain Layout
1912 The \SpecialChar LyX
1913 system directory (e.
1914 \begin_inset space \thinspace{}
1918 \begin_inset space \space{}
1922 \begin_inset Flex MenuItem
1925 \begin_layout Plain Layout
1934 \begin_layout Labeling
1935 \labelwidthstring 00.00.0000
1936 \begin_inset Flex Code
1939 \begin_layout Plain Layout
1948 \begin_layout Labeling
1949 \labelwidthstring 00.00.0000
1950 \begin_inset Flex Code
1953 \begin_layout Plain Layout
1962 \begin_layout Labeling
1963 \labelwidthstring 00.00.0000
1964 \begin_inset Flex Code
1967 \begin_layout Plain Layout
1973 The base name (without filename extension) in the \SpecialChar LyX
1977 \begin_layout Labeling
1978 \labelwidthstring 00.00.0000
1979 \begin_inset Flex Code
1982 \begin_layout Plain Layout
1988 The full directory path of the \SpecialChar LyX
1992 \begin_layout Labeling
1993 \labelwidthstring 00.00.0000
1994 \begin_inset Flex Code
1997 \begin_layout Plain Layout
2003 The full pathname to the original \SpecialChar LyX
2004 file being processed
2007 \begin_layout Labeling
2008 \labelwidthstring 00.00.0000
2009 \begin_inset Flex Code
2012 \begin_layout Plain Layout
2018 The filename (without any directory path) of the \SpecialChar LyX
2022 \begin_layout Labeling
2023 \labelwidthstring 00.00.0000
2024 \begin_inset Flex Code
2027 \begin_layout Plain Layout
2033 The `\SpecialChar LaTeX
2037 \begin_layout Standard
2038 The latter should be the filename as it would be used in a \SpecialChar LaTeX
2046 It is relevant only when exporting files suitable for such inclusion.
2049 \begin_layout Standard
2050 Copiers can be used to do almost anything with output files.
2051 For example, suppose you want generated pdf files to be copied to a special
2053 \begin_inset Flex Code
2056 \begin_layout Plain Layout
2063 Then you could write a shell script such as this one:
2066 \begin_layout Standard
2067 \begin_inset listings
2071 \begin_layout Plain Layout
2076 \begin_layout Plain Layout
2081 \begin_layout Plain Layout
2083 TOFILE=`basename $2`
2086 \begin_layout Plain Layout
2088 cp $FROMFILE /home/you/pdf/$TOFILE
2093 Save it in your local \SpecialChar LyX
2095 \begin_inset Flex Code
2098 \begin_layout Plain Layout
2099 /home/you/.lyx/scripts/pdfcopier.sh
2104 —and make it executable, if you need to do so on your platform.
2106 \begin_inset Flex MenuItem
2109 \begin_layout Plain Layout
2110 Tools\SpecialChar menuseparator
2116 dialog, select under
2117 \begin_inset Flex MenuItem
2120 \begin_layout Plain Layout
2121 File Handling\SpecialChar menuseparator
2128 \begin_inset Flex MenuItem
2131 \begin_layout Plain Layout
2137 format—or one of the other pdf formats—and enter
2138 \begin_inset Flex Code
2141 \begin_layout Plain Layout
2142 pdfcopier.sh $$i $$o
2148 \begin_inset Flex MenuItem
2151 \begin_layout Plain Layout
2161 \begin_layout Standard
2162 Copiers are used by \SpecialChar LyX
2163 in various of its own conversions.
2164 For example, if appropriate programs are found, \SpecialChar LyX
2165 will automatically install
2167 \begin_inset Flex MenuItem
2170 \begin_layout Plain Layout
2177 \begin_inset Flex MenuItem
2180 \begin_layout Plain Layout
2182 \begin_inset space ~
2191 When these formats are exported, the copier sees that not just the main
2192 HTML file but various associated files (style files, images, etc.) are also
2194 All these files are written to a subdirectory of the directory in which
2195 the original \SpecialChar LyX
2200 \begin_layout Plain Layout
2201 This copier can be customized.
2203 \begin_inset Quotes eld
2207 \begin_inset Quotes erd
2210 argument takes a comma-separated list of extensions to be copied; if it
2211 is omitted, all files will be copied.
2213 \begin_inset Quotes eld
2217 \begin_inset Quotes erd
2220 argument determines the extension added to the generated directory.
2222 \begin_inset Quotes eld
2226 \begin_inset Flex MenuItem
2229 \begin_layout Plain Layout
2231 \change_inserted -712698321 1437634589
2233 \change_deleted -712698321 1437634588
2243 \begin_inset Quotes erd
2246 , so HTML generated from
2247 \begin_inset Flex MenuItem
2250 \begin_layout Plain Layout
2251 /path/to/filename.lyx
2257 \begin_inset Flex MenuItem
2260 \begin_layout Plain Layout
2261 /path/to/filename.html.
2262 \change_deleted -712698321 1437634593
2265 \change_inserted -712698321 1437634595
2282 \begin_layout Section
2284 \begin_inset CommandInset label
2286 name "sec:Converters"
2293 \begin_layout Standard
2294 You can define your own Converters to convert files between different formats.
2296 \begin_inset Flex MenuItem
2299 \begin_layout Plain Layout
2300 Tools\SpecialChar menuseparator
2301 Preferences\SpecialChar menuseparator
2302 File Handling\SpecialChar menuseparator
2311 \begin_layout Standard
2312 To define a new converter, select the
2313 \begin_inset Flex MenuItem
2316 \begin_layout Plain Layout
2318 \begin_inset space ~
2327 \begin_inset Flex MenuItem
2330 \begin_layout Plain Layout
2332 \begin_inset space ~
2340 from the drop-down lists, enter the command needed for the conversion,
2342 \begin_inset Flex MenuItem
2345 \begin_layout Plain Layout
2352 Several variables can be used in the definition of converters:
2355 \begin_layout Labeling
2356 \labelwidthstring 00.00.0000
2357 \begin_inset Flex Code
2360 \begin_layout Plain Layout
2366 The \SpecialChar LyX
2370 \begin_layout Labeling
2371 \labelwidthstring 00.00.0000
2372 \begin_inset Flex Code
2375 \begin_layout Plain Layout
2384 \begin_layout Labeling
2385 \labelwidthstring 00.00.0000
2386 \begin_inset Flex Code
2389 \begin_layout Plain Layout
2398 \begin_layout Labeling
2399 \labelwidthstring 00.00.0000
2400 \begin_inset Flex Code
2403 \begin_layout Plain Layout
2409 The base filename of the input file (i.
2410 \begin_inset space \thinspace{}
2413 g., without the extension)
2416 \begin_layout Labeling
2417 \labelwidthstring 00.00.0000
2418 \begin_inset Flex Code
2421 \begin_layout Plain Layout
2427 The path to the input file
2430 \begin_layout Labeling
2431 \labelwidthstring 00.00.0000
2432 \begin_inset Flex Code
2435 \begin_layout Plain Layout
2441 The path to the original input file (this is different from $$p when a
2442 chain of converters is called)
2445 \begin_layout Labeling
2446 \labelwidthstring 00.00.0000
2447 \begin_inset Flex Code
2450 \begin_layout Plain Layout
2456 The iconv name for the encoding of the document.
2459 \begin_layout Standard
2461 \begin_inset Flex MenuItem
2464 \begin_layout Plain Layout
2466 \begin_inset space ~
2474 field you can enter the following flags, separated by commas:
2477 \begin_layout Labeling
2478 \labelwidthstring 00.00.0000
2479 \begin_inset Flex Code
2482 \begin_layout Plain Layout
2488 This converter runs some form of \SpecialChar LaTeX
2490 This will make \SpecialChar LyX
2491 's \SpecialChar LaTeX
2492 error logs available.
2495 \begin_layout Labeling
2496 \labelwidthstring 00.00.0000
2497 \begin_inset Flex Code
2500 \begin_layout Plain Layout
2506 Needs the \SpecialChar LaTeX
2508 \begin_inset Flex MenuItem
2511 \begin_layout Plain Layout
2517 file for the conversion.
2520 \begin_layout Labeling
2521 \labelwidthstring 00.00.0000
2522 \begin_inset Flex Code
2525 \begin_layout Plain Layout
2532 \begin_inset Quotes eld
2536 \begin_inset Quotes erd
2539 file from the backend, which in practice means a \SpecialChar LaTeX
2540 file like the one we
2541 would export, without
2542 \begin_inset Flex Code
2545 \begin_layout Plain Layout
2554 \begin_layout Labeling
2555 \labelwidthstring 00.00.0000
2556 \begin_inset Flex Code
2559 \begin_layout Plain Layout
2568 \begin_layout Standard
2569 The following three flags are not really flags at all because they take
2571 \begin_inset Flex MenuItem
2574 \begin_layout Plain Layout
2576 \begin_inset space ~
2580 \begin_inset space ~
2591 \begin_layout Labeling
2592 \labelwidthstring 00.00.0000
2593 \begin_inset Flex Code
2596 \begin_layout Plain Layout
2602 If set, the converter's standard error will be redirected to a file
2603 \begin_inset Flex Code
2606 \begin_layout Plain Layout
2612 , and the script given as argument will be run as:
2613 \begin_inset Flex Code
2616 \begin_layout Plain Layout
2617 script < infile.out > infile.log
2623 The argument may contain
2624 \begin_inset Flex Code
2627 \begin_layout Plain Layout
2636 \begin_layout Labeling
2637 \labelwidthstring 00.00.0000
2638 \begin_inset Flex Code
2641 \begin_layout Plain Layout
2647 The name of the directory in which the converter will dump the generated
2650 will not create this directory, and it does not copy anything into it,
2651 though it will copy this directory to the destination.
2652 The argument may contain
2653 \begin_inset Flex Code
2656 \begin_layout Plain Layout
2662 , which will be replaced by the base name of the input and output files,
2663 respectively, when the directory is copied.
2664 \begin_inset Newline newline
2667 Note that resultdir and usetempdir make no sense together.
2668 The latter will be ignored if the former is given.
2671 \begin_layout Labeling
2672 \labelwidthstring 00.00.0000
2673 \begin_inset Flex Code
2676 \begin_layout Plain Layout
2682 Determines the output file name and may, contain
2683 \begin_inset Flex Code
2686 \begin_layout Plain Layout
2693 Sensible only with resultdir and optional even then; if not given, it defaults
2697 \begin_layout Standard
2698 None of these last three are presently used in any of the converters that
2699 are installed with \SpecialChar LyX
2704 \begin_layout Standard
2705 You do not have to define converters for all formats between which you want
2707 For example, you will note that there is no `\SpecialChar LyX
2708 to PostScript' converter,
2709 but \SpecialChar LyX
2710 will export PostScript.
2711 It does so by first creating a \SpecialChar LaTeX
2712 file (no converter needs to be defined
2713 for this) which is then converted to DVI using the `\SpecialChar LaTeX
2715 and finally converting the resulting DVI file to PostScript.
2717 finds such `chains' of converters automatically, and it will always choose
2718 the shortest possible chain.
2719 You can, though, still define multiple conversion methods between file
2721 For example, the standard \SpecialChar LyX
2722 configuration provides five ways to convert
2727 \begin_layout Enumerate
2729 \begin_inset Flex MenuItem
2732 \begin_layout Plain Layout
2741 \begin_layout Enumerate
2742 via (DVI and) PostScript, using
2743 \begin_inset Flex MenuItem
2746 \begin_layout Plain Layout
2755 \begin_layout Enumerate
2757 \begin_inset Flex MenuItem
2760 \begin_layout Plain Layout
2769 \begin_layout Enumerate
2771 \begin_inset Flex MenuItem
2774 \begin_layout Plain Layout
2784 \begin_layout Enumerate
2786 \begin_inset Flex MenuItem
2789 \begin_layout Plain Layout
2799 \begin_layout Standard
2800 To define such alternate chains, you must define multiple target `file formats',
2802 \begin_inset CommandInset ref
2804 reference "sec:Formats"
2809 For example, in the standard configuration, the formats named
2810 \begin_inset Flex MenuItem
2813 \begin_layout Plain Layout
2820 \begin_inset Flex MenuItem
2823 \begin_layout Plain Layout
2830 \begin_inset Flex MenuItem
2833 \begin_layout Plain Layout
2840 \begin_inset Flex MenuItem
2843 \begin_layout Plain Layout
2850 \begin_inset Flex MenuItem
2853 \begin_layout Plain Layout
2860 \begin_inset Flex MenuItem
2863 \begin_layout Plain Layout
2870 \begin_inset Flex MenuItem
2873 \begin_layout Plain Layout
2880 \begin_inset Flex MenuItem
2883 \begin_layout Plain Layout
2891 \begin_inset Flex MenuItem
2894 \begin_layout Plain Layout
2901 \begin_inset Flex MenuItem
2904 \begin_layout Plain Layout
2911 ) are defined, all of which share the extension
2912 \begin_inset Flex MenuItem
2915 \begin_layout Plain Layout
2921 , and which correspond to the conversion methods just mentioned.
2924 \begin_layout Chapter
2925 Internationalizing \SpecialChar LyX
2927 \begin_inset CommandInset label
2929 name "cha:Internationalizing-LyX"
2936 \begin_layout Standard
2938 supports using a translated interface.
2939 Last time we checked, \SpecialChar LyX
2940 provided text in thirty languages.
2941 The language of choice is called your
2946 (For further reading on locale settings, see also the documentation for
2947 locale that comes with your operating system.
2948 For Linux, the manual page for
2949 \begin_inset Flex Code
2952 \begin_layout Plain Layout
2958 could be a good place to start).
2961 \begin_layout Standard
2962 Notice that these translations will work, but do contain a few flaws.
2963 In particular, all dialogs have been designed with the English text in
2964 mind, which means that some of the translated text will be too large to
2965 fit within the space allocated.
2966 This is only a display problem and will not cause any harm.
2967 Also, you will find that some of the translations do not define shortcut
2968 keys for everything.
2969 Sometimes, there are simply not enough free letters to do it.
2970 Other times, the translator just hasn't got around to doing it yet.
2971 Our localization team, which you may wish to join,
2975 \begin_layout Plain Layout
2976 If you are a fluent speaker of a language other than English, joining these
2977 teams is a great way to give back to the \SpecialChar LyX
2983 will of course try to fix these shortcomings in future versions of \SpecialChar LyX
2987 \begin_layout Section
2988 Translating \SpecialChar LyX
2992 \begin_layout Subsection
2993 Translating the graphical user interface (text messages).
2996 \begin_layout Standard
2999 \begin_inset Flex Code
3002 \begin_layout Plain Layout
3008 library to handle the internationalization of the interface.
3009 To have \SpecialChar LyX
3010 speak your favorite language in all menus and dialogs, you need
3012 \begin_inset Flex Code
3015 \begin_layout Plain Layout
3021 -file for that language.
3022 When this is available, you'll have to generate a
3023 \begin_inset Flex Code
3026 \begin_layout Plain Layout
3032 -file from it and install the
3033 \begin_inset Flex Code
3036 \begin_layout Plain Layout
3043 The process of doing all of this is explained in the documentation for
3045 \begin_inset Flex Code
3048 \begin_layout Plain Layout
3055 It is possible to do this just for yourself, but if you're going to do
3056 it, you might as well share the results of your labors with the rest of
3057 the \SpecialChar LyX
3059 Send a message to the \SpecialChar LyX
3060 developers' list for more information about how
3064 \begin_layout Standard
3065 In short, this is what you should do (xx denotes the language code):
3068 \begin_layout Itemize
3069 Check out the \SpecialChar LyX
3072 \begin_inset CommandInset href
3074 name "information on the web"
3075 target "http://www.lyx.org/HowToUseSVN"
3082 \begin_layout Itemize
3084 \begin_inset Flex Code
3087 \begin_layout Plain Layout
3093 to the folder of the
3094 \begin_inset Flex Code
3097 \begin_layout Plain Layout
3105 \begin_inset Flex Code
3108 \begin_layout Plain Layout
3116 \begin_inset Flex Code
3119 \begin_layout Plain Layout
3125 doesn't exist anywhere, it can be remade with the console command
3126 \begin_inset Flex Code
3129 \begin_layout Plain Layout
3135 in that directory, or you can use an existing po-file for some other language
3139 \begin_layout Itemize
3141 \begin_inset Flex Code
3144 \begin_layout Plain Layout
3154 \begin_layout Plain Layout
3155 This is just a text file, so it can be edited in any text editor.
3156 But there are also specialized programs that support such editing, such
3161 (for all platforms) or
3170 contains a `mode' for editing
3171 \begin_inset Flex Code
3174 \begin_layout Plain Layout
3185 For some menu- and widget-labels, there are also shortcut keys that should
3187 Those keys are marked after a `|', and should be translated according to
3188 the words and phrases of the language.
3189 You should also fill also out the information at the beginning of the new
3191 \begin_inset Flex Code
3194 \begin_layout Plain Layout
3200 -file with your email-address, etc., so people know where to reach you with
3201 suggestions and entertaining flames.
3204 \begin_layout Standard
3205 If you are just doing this on your own, then:
3208 \begin_layout Itemize
3210 \begin_inset Flex Code
3213 \begin_layout Plain Layout
3220 This can be done with
3221 \begin_inset Flex Code
3224 \begin_layout Plain Layout
3225 msgfmt -o xx.mo < xx.po
3233 \begin_layout Itemize
3235 \begin_inset Flex Code
3238 \begin_layout Plain Layout
3244 -file to your locale-tree, at the correct directory for application messages
3249 xx, and under the name
3250 \begin_inset Flex Code
3253 \begin_layout Plain Layout
3260 \begin_inset space \thinspace{}
3264 \begin_inset space \space{}
3268 \begin_inset Flex Code
3271 \begin_layout Plain Layout
3272 /usr/local/share/locale/xx/LC_MESSAGES/lyx.mo
3282 \begin_layout Standard
3283 As said, however, it would be best if the new
3284 \begin_inset Flex Code
3287 \begin_layout Plain Layout
3294 \change_inserted -712698321 1437634626
3296 \change_deleted -712698321 1437634624
3299 file could be added to the \SpecialChar LyX
3300 distribution, so others can use it.
3301 Adding it involves making additional changes to \SpecialChar LyX
3303 So send an email to the developers' mailing list if you're interested in
3307 \begin_layout Subsubsection
3311 \begin_layout Standard
3312 Sometimes it turns out that one English message needs to be translated into
3313 different messages in the target language.
3314 One example is the message
3315 \begin_inset Flex Code
3318 \begin_layout Plain Layout
3324 which has the German translation
3332 , depending upon exactly what the English
3333 \begin_inset Quotes eld
3337 \begin_inset Quotes erd
3342 \begin_inset Flex Code
3345 \begin_layout Plain Layout
3351 does not handle such ambiguous translations.
3352 Therefore you have to add some context information to the message: Instead
3354 \begin_inset Flex Code
3357 \begin_layout Plain Layout
3364 \begin_inset Flex Code
3367 \begin_layout Plain Layout
3368 To[[as in 'From format x to format y']]
3374 \begin_inset Flex Code
3377 \begin_layout Plain Layout
3378 To[[as in 'From page x to page y']].
3383 Now the two occurrences of
3384 \begin_inset Flex Code
3387 \begin_layout Plain Layout
3394 \begin_inset Flex Code
3397 \begin_layout Plain Layout
3403 and can be translated correctly to
3414 \begin_layout Standard
3415 Of course the context information needs to be stripped off the original
3416 message when no translation is used.
3417 Therefore you have to put it in double square brackets at the end of the
3418 message (see the example above).
3419 The translation mechanism of \SpecialChar LyX
3420 ensures that everything in double square
3421 brackets at the end of messages is removed before displaying the message.
3424 \begin_layout Subsection
3425 Translating the documentation.
3428 \begin_layout Standard
3429 The online documentation (in the
3430 \begin_inset Flex MenuItem
3433 \begin_layout Plain Layout
3439 -menu) can (and should!) be translated.
3440 If there are translated versions of the documentation available
3444 \begin_layout Plain Layout
3445 As of March 2008, at least some of the documents have been translated into
3446 fourteen languages, with the Tutorial available in a few more.
3451 and the locale is set accordingly, these will be used automagically by
3455 looks for translated versions as
3456 \begin_inset Flex Code
3459 \begin_layout Plain Layout
3461 \change_deleted -712698321 1437634637
3464 \change_inserted -712698321 1437634639
3467 Dir/doc/xx/DocName.lyx
3473 \begin_inset Flex Code
3476 \begin_layout Plain Layout
3482 is the code for the language currently in use.
3483 If there are no translated documents, the default English versions will
3485 Note that the translated versions must have the same filenames (
3486 \begin_inset Flex Code
3489 \begin_layout Plain Layout
3495 above) as the original.
3496 If you feel up to translating the documentation (an excellent way to proof-read
3497 the original documentation by the way!), there are a few things you should
3501 \begin_layout Itemize
3502 Check out the documentation translation web page at
3503 \begin_inset CommandInset href
3505 name "http://www.lyx.org/Translation"
3506 target "http://www.lyx.org/Translation"
3511 That way, you can find out which (if any) documents have already been translate
3512 d into your language.
3513 You can also find out who (if anyone) is organizing the effort to translate
3514 the documentation into your language.
3515 If no one is organizing the effort, please let us know that you're interested.
3518 \begin_layout Standard
3519 Once you get to actually translating, here's a few hints for you that may
3523 \begin_layout Itemize
3524 Join the documentation team! There is information on how to do that in
3525 \begin_inset Flex Code
3528 \begin_layout Plain Layout
3535 \begin_inset Flex MenuItem
3538 \begin_layout Plain Layout
3539 Help\SpecialChar menuseparator
3545 ), which by the way is the first document you should translate.
3548 \begin_layout Itemize
3549 Learn the typographic conventions for the language you are translating to.
3550 Typography is an ancient art and over the centuries, a great variety of
3551 conventions have developed throughout different parts of the world.
3552 Also study the professional terminology amongst typographers in your country.
3553 Inventing your own terminology will only confuse the users.
3556 (Warning! Typography is addictive!)
3559 \begin_layout Itemize
3560 Make a copy of the document.
3561 This will be your working copy.
3562 You can use this as your personal translated help-file by placing it in
3564 \begin_inset Flex Code
3567 \begin_layout Plain Layout
3576 \begin_layout Itemize
3577 Sometimes the original document (from the \SpecialChar LyX
3579 \change_inserted -712698321 1437634643
3581 \change_deleted -712698321 1437634643
3584 team) will be updated.
3585 Use the source viewer at
3586 \begin_inset CommandInset href
3588 name "http://www.lyx.org/trac/timeline"
3589 target "http://www.lyx.org/trac/timeline"
3593 to see what has been changed.
3594 That way you can easily see which parts of the translated document need
3598 \begin_layout Standard
3599 If you ever find an error in the original document, fix it and notify the
3600 rest of the documentation team of the changes! (You didn't forget to join
3601 the documentation team, did you?)
3604 \begin_layout Standard
3605 \begin_inset Branch OutDated
3608 \begin_layout Section
3609 International Keyboard Support
3612 \begin_layout Standard
3615 [Editor's Note: The following section is by
3623 It needs to be fixed to conform to the new Documentation Style sheet and
3624 to make use of the new v1.0 features.
3625 The whole thing also needs to be merged with the section following it.-jw
3626 It may also be badly out of date.-rh (2008)]
3629 \begin_layout Subsection
3630 Defining Own Keymaps: Keymap File Format
3633 \begin_layout Standard
3634 Let's look at a keyboard definition file a little closer.
3635 It is a plain text file defining
3638 \begin_layout Itemize
3639 key-to-key or key-to-string translations
3642 \begin_layout Itemize
3646 \begin_layout Itemize
3647 dead keys exceptions
3650 \begin_layout Standard
3651 To define key-to-key or key-to-string translation, use this command:
3654 \begin_layout Quotation
3655 \begin_inset Flex Code
3658 \begin_layout Plain Layout
3667 \begin_inset Flex Code
3670 \begin_layout Plain Layout
3679 \begin_layout Standard
3681 \begin_inset Flex Code
3684 \begin_layout Plain Layout
3690 is the key to be translated and
3691 \begin_inset Flex Code
3694 \begin_layout Plain Layout
3700 is the string to be inserted into the document.
3701 To define dead keys, use:
3704 \begin_layout Quotation
3705 \begin_inset Flex Code
3708 \begin_layout Plain Layout
3717 \begin_inset Flex Code
3720 \begin_layout Plain Layout
3729 \begin_layout Standard
3731 \begin_inset Flex Code
3734 \begin_layout Plain Layout
3740 is a keyboard key and
3741 \begin_inset Flex Code
3744 \begin_layout Plain Layout
3751 The following dead keys are supported (shortcut name is in parentheses):
3754 \begin_layout Quotation
3758 \begin_inset space \hfill{}
3764 \begin_layout Quotation
3766 \begin_inset space \hfill{}
3772 \begin_layout Quotation
3774 \begin_inset space \hfill{}
3780 \begin_layout Quotation
3782 \begin_inset space \hfill{}
3788 \begin_layout Quotation
3790 \begin_inset space \hfill{}
3796 \begin_layout Quotation
3798 \begin_inset space \hfill{}
3805 \begin_layout Plain Layout
3817 \begin_layout Quotation
3819 \begin_inset space \hfill{}
3825 \begin_layout Quotation
3827 \begin_inset space \hfill{}
3834 \begin_layout Plain Layout
3846 \begin_layout Quotation
3848 \begin_inset space \hfill{}
3854 \begin_layout Quotation
3856 \begin_inset space \hfill{}
3862 \begin_layout Quotation
3864 \begin_inset space \hfill{}
3871 \begin_layout Plain Layout
3883 \begin_layout Quotation
3885 \begin_inset space \hfill{}
3892 \begin_layout Plain Layout
3904 \begin_layout Quotation
3906 \begin_inset space \hfill{}
3912 \begin_layout Quotation
3913 hungarian umlaut (hug)
3914 \begin_inset space \hfill{}
3920 \begin_layout Quotation
3922 \begin_inset space \hfill{}
3928 \begin_layout Quotation
3930 \begin_inset space \hfill{}
3937 \begin_layout Plain Layout
3949 \begin_layout Standard
3950 Since in many international keyboards there are exceptions to what some
3951 dead keys should do, you can define them using
3954 \begin_layout Quotation
3955 \begin_inset Flex Code
3958 \begin_layout Plain Layout
3966 deadkey key outstring
3969 \begin_layout Standard
3970 For example, on Slovak keyboard, if you enter caron-o, it generates circumflex-o
3974 \begin_layout Quotation
3975 \begin_inset Flex Code
3978 \begin_layout Plain Layout
3991 \begin_layout Standard
3992 to make it work correctly.
3993 Also, you have to define as exceptions dead keys over i and j, to remove
3994 the dot from them before inserting an accent mark.
3995 I will change this when the time comes, but so far I haven't had time.
3998 \begin_layout Standard
3999 Oh, and about characters: backslash is escaped, so to enter it, you'll need
4002 \begin_inset Flex Code
4005 \begin_layout Plain Layout
4011 have different meaning.
4013 \begin_inset Flex Code
4016 \begin_layout Plain Layout
4022 marks comments, quotes start and end \SpecialChar LaTeX
4024 To enter quote, you'll need to use
4025 \begin_inset Flex Code
4028 \begin_layout Plain Layout
4037 \begin_inset Flex Code
4040 \begin_layout Plain Layout
4047 \begin_inset Flex Code
4050 \begin_layout Plain Layout
4061 \begin_layout Standard
4062 If you make a keyboard description file that works for your language, please
4063 mail it to me, so I can include it in the next keymap distribution.
4066 \begin_layout Standard
4067 More keywords will be supported in keymap configuration file in future,
4071 \begin_layout Itemize
4072 \begin_inset Flex Code
4075 \begin_layout Plain Layout
4086 \begin_inset space \hfill{}
4090 \begin_inset Flex Code
4093 \begin_layout Plain Layout
4102 \begin_layout Itemize
4103 \begin_inset Flex Code
4106 \begin_layout Plain Layout
4117 \begin_inset space \hfill{}
4121 \begin_inset Flex Code
4124 \begin_layout Plain Layout
4130 an external keymap translation program
4133 \begin_layout Standard
4134 Also, it should look into
4135 \begin_inset Flex Code
4138 \begin_layout Plain Layout
4144 file for defaults, too (for example, a
4145 \begin_inset Flex Code
4148 \begin_layout Plain Layout
4156 option to include default keyboard).
4164 \begin_layout Section
4165 International Keymap Stuff
4166 \begin_inset CommandInset label
4168 name "sec:International-Keymap-Stuff"
4175 \begin_layout Standard
4176 \begin_inset Note Note
4179 \begin_layout Plain Layout
4180 In doing the revisions on this document in March 2008, I did not look over
4181 this stuff, as I do not understand it.
4182 It would be good if someone else could do so.
4191 \begin_layout Standard
4192 The next two sections describe the
4193 \begin_inset Flex Code
4196 \begin_layout Plain Layout
4205 \begin_inset Flex Code
4208 \begin_layout Plain Layout
4216 file syntax in detail.
4217 These sections should help you design your own key map if the ones provided
4218 do not meet your needs.
4221 \begin_layout Subsection
4225 \begin_layout Standard
4229 \begin_inset Flex Code
4232 \begin_layout Plain Layout
4238 file maps keystrokes to characters or strings.
4239 As the name suggests, it sets a keyboard mapping.
4241 \begin_inset Flex Code
4244 \begin_layout Plain Layout
4255 \begin_inset Flex Code
4258 \begin_layout Plain Layout
4273 \begin_inset Flex Code
4276 \begin_layout Plain Layout
4289 \begin_inset Flex Code
4292 \begin_layout Plain Layout
4301 \begin_inset Flex Code
4304 \begin_layout Plain Layout
4312 are described in this section.
4315 \begin_layout Labeling
4316 \labelwidthstring 00.00.0000
4317 \begin_inset Flex Code
4320 \begin_layout Plain Layout
4328 Map a character to a string
4331 \begin_layout LyX-Code
4346 \begin_layout Standard
4379 the double-quote (")
4396 must be escaped with a preceding backslash (
4407 \begin_layout Standard
4409 \begin_inset Flex MenuItem
4412 \begin_layout Plain Layout
4420 statement to cause the symbol
4421 \begin_inset Flex MenuItem
4424 \begin_layout Plain Layout
4432 to be output for the keystroke
4433 \begin_inset Flex MenuItem
4436 \begin_layout Plain Layout
4447 \begin_layout LyX-Code
4453 \begin_layout Labeling
4454 \labelwidthstring 00.00.0000
4455 \begin_inset Flex Code
4458 \begin_layout Plain Layout
4466 Specify an accent character
4469 \begin_layout LyX-Code
4478 \begin_layout Standard
4479 This will make the cha
4517 This is the dead key
4521 \begin_layout Plain Layout
4528 refers to a key that does not produce a character by itself, but when followed
4529 with another key, produces the desired accent character.
4530 For example, a German characte
4532 r with an umlaut like
4542 can be produced in this manner.
4551 \begin_layout Standard
4564 and then another key not in
4581 followed by the other, not allowed key, as output.
4585 \begin_inset Flex MenuItem
4588 \begin_layout Plain Layout
4596 cancels a dead key, so if
4607 \begin_inset Flex MenuItem
4610 \begin_layout Plain Layout
4619 , the cursor will not go one position backwards but will instead cancel
4635 might have had on the next keystroke.
4639 \begin_layout Standard
4640 The following example specifies that the character ' is to be an acute accent,
4641 allowed on the characters a, e, i, o, u, A, E, I, O, and U:
4644 \begin_layout LyX-Code
4647 kmod ' acute aeiouAEIOU
4650 \begin_layout Labeling
4651 \labelwidthstring 00.00.0000
4652 \begin_inset Flex Code
4655 \begin_layout Plain Layout
4661 Specify an exception to the accent character
4664 \begin_layout LyX-Code
4673 \begin_layout Standard
4674 This defines an exce
4715 have been assigned a keystroke with a previous
4718 \begin_inset Flex Code
4721 \begin_layout Plain Layout
4745 must not belong in the
4792 If such a declaration does not exist in
4800 \begin_inset Flex Code
4803 \begin_layout Plain Layout
4837 \begin_inset Flex Code
4840 \begin_layout Plain Layout
4854 \begin_layout Standard
4855 The following command produces causes äi to be produced when you enter acute-i
4859 \begin_layout LyX-Code
4873 \begin_layout Labeling
4874 \labelwidthstring 00.00.0000
4875 \begin_inset Flex Code
4878 \begin_layout Plain Layout
4884 Combine two accent characters
4887 \begin_layout LyX-Code
4893 accent1 accent2 allowed
4896 \begin_layout Standard
4897 This one is getting pretty esoteric.
4898 It allows you to combine the effect
4954 \begin_inset Flex Code
4957 \begin_layout Plain Layout
4985 \begin_layout Standard
4986 Consider this example from the
4987 \begin_inset Flex Code
4990 \begin_layout Plain Layout
5001 \begin_layout LyX-Code
5004 kmod ; acute aeioyvhAEIOYVH
5008 kcomb acute umlaut iyIY
5011 \begin_layout Standard
5012 This allows you to press
5013 \begin_inset Flex MenuItem
5016 \begin_layout Plain Layout
5024 and get the effect of
5025 \begin_inset Flex Code
5028 \begin_layout Plain Layout
5047 in this case cancels the last dead key, so if you press
5048 \begin_inset Flex MenuItem
5051 \begin_layout Plain Layout
5060 \begin_inset Flex Code
5063 \begin_layout Plain Layout
5076 \begin_layout Subsection
5080 \begin_layout Standard
5082 \begin_inset Flex Code
5085 \begin_layout Plain Layout
5093 mapping is performed, a
5094 \begin_inset Flex Code
5097 \begin_layout Plain Layout
5107 file maps the strings that the symbols generate to characters in the current
5109 The \SpecialChar LyX
5110 distribution currently includes at least the
5111 \begin_inset Flex Code
5114 \begin_layout Plain Layout
5123 \begin_inset Flex Code
5126 \begin_layout Plain Layout
5137 \begin_layout Standard
5139 \begin_inset Flex Code
5142 \begin_layout Plain Layout
5150 file is a sequence of declarations of the form
5153 \begin_layout LyX-Code
5166 \begin_layout Standard
5167 For example, in order to map
5168 \begin_inset Flex MenuItem
5171 \begin_layout Plain Layout
5181 to the corresponding character in the iso-8859-1 set (233), the following
5185 \begin_layout LyX-Code
5193 \begin_layout Standard
5195 \begin_inset Flex Code
5198 \begin_layout Plain Layout
5207 \begin_inset Flex Code
5210 \begin_layout Plain Layout
5228 the same character can apply to more than one string.
5230 \begin_inset Flex Code
5233 \begin_layout Plain Layout
5244 \begin_layout LyX-Code
5256 \begin_inset Newline newline
5272 \begin_layout Standard
5274 cannot find a mapping for the string produced by the keystroke or a
5275 deadkey sequence, it will check if it looks like an accented char and try
5276 to draw an accent over the character on screen.
5279 \begin_layout Subsection
5283 \begin_layout Standard
5284 There is a second way to add support for international characters through
5285 so-called dead-keys.
5286 A dead-key works in combination with a letter to produce an accented character.
5287 Here, we'll explain how to create a really simple dead-key to illustrate
5291 \begin_layout Standard
5292 Suppose you happen to need the circumflex character,
5293 \begin_inset Quotes eld
5297 \begin_inset Quotes erd
5302 \begin_inset Flex MenuItem
5305 \begin_layout Plain Layout
5312 \begin_inset space ~
5316 \begin_inset Flex MenuItem
5319 \begin_layout Plain Layout
5325 ] to the \SpecialChar LyX
5327 \begin_inset Flex Code
5330 \begin_layout Plain Layout
5337 \begin_inset Flex Code
5340 \begin_layout Plain Layout
5347 Now, whenever you type the
5348 \begin_inset Flex MenuItem
5351 \begin_layout Plain Layout
5357 -key followed by a letter, that letter will have a circumflex accent on
5359 For example, the sequence
5360 \begin_inset Quotes eld
5364 \begin_inset Flex MenuItem
5367 \begin_layout Plain Layout
5374 \begin_inset Quotes erd
5377 produces the letter:
5378 \begin_inset Quotes eld
5382 \begin_inset Quotes erd
5386 If you tried to type
5387 \begin_inset Quotes eld
5391 \begin_inset Flex MenuItem
5394 \begin_layout Plain Layout
5401 \begin_inset Quotes erd
5404 , however, \SpecialChar LyX
5405 will complain with a beep, since a
5406 \begin_inset Quotes eld
5410 \begin_inset Flex MenuItem
5413 \begin_layout Plain Layout
5420 \begin_inset Quotes erd
5423 never takes a circumflex accent.
5425 \begin_inset Flex MenuItem
5428 \begin_layout Plain Layout
5434 after a dead-key produces the bare-accent.
5435 Please note this last point! If you bind a key to a dead-key, you'll need
5436 to rebind the character on that key to yet another key.
5438 \begin_inset Flex MenuItem
5441 \begin_layout Plain Layout
5447 to a cedilla is a bad idea, since you'll only get cedillas instead of commas.
5450 \begin_layout Standard
5451 One common way to bind dead-keys is to use
5452 \begin_inset Flex MenuItem
5455 \begin_layout Plain Layout
5462 \begin_inset Flex MenuItem
5465 \begin_layout Plain Layout
5472 \begin_inset Flex MenuItem
5475 \begin_layout Plain Layout
5481 in combination with an accent, like
5482 \begin_inset Quotes eld
5486 \begin_inset Flex MenuItem
5489 \begin_layout Plain Layout
5496 \begin_inset Quotes erd
5500 \begin_inset Quotes eld
5504 \begin_inset Flex MenuItem
5507 \begin_layout Plain Layout
5514 \begin_inset Quotes erd
5518 \begin_inset Quotes eld
5522 \begin_inset Flex MenuItem
5525 \begin_layout Plain Layout
5532 \begin_inset Quotes erd
5536 Another way involves using
5537 \begin_inset Flex Code
5540 \begin_layout Plain Layout
5547 \begin_inset Flex Code
5550 \begin_layout Plain Layout
5556 to set up the special
5557 \begin_inset Flex Code
5560 \begin_layout Plain Layout
5568 \begin_inset Flex Code
5571 \begin_layout Plain Layout
5577 acts in some ways just like
5578 \begin_inset Flex MenuItem
5581 \begin_layout Plain Layout
5587 and permits you to bind keys to accented characters.
5588 You can also turn keys into dead-keys by binding them to something like
5590 \begin_inset Flex Code
5593 \begin_layout Plain Layout
5599 and then binding this symbolic key to the corresponding \SpecialChar LyX
5604 \begin_layout Plain Layout
5609 : This is exactly what I do in my
5610 \begin_inset Flex Code
5613 \begin_layout Plain Layout
5620 \begin_inset Flex Code
5623 \begin_layout Plain Layout
5631 \begin_inset Flex MenuItem
5634 \begin_layout Plain Layout
5636 \begin_inset space ~
5645 \begin_inset Flex Code
5648 \begin_layout Plain Layout
5654 and a bunch of these
5655 \begin_inset Quotes eld
5659 \begin_inset Flex Code
5662 \begin_layout Plain Layout
5669 \begin_inset Quotes erd
5672 symbolic keys bound such things as
5673 \begin_inset Flex MenuItem
5676 \begin_layout Plain Layout
5678 \begin_inset space ~
5687 \begin_inset Flex MenuItem
5690 \begin_layout Plain Layout
5692 \begin_inset space ~
5701 This is how I produce my accented characters.
5706 You can make just about anything into the
5707 \begin_inset Flex Code
5710 \begin_layout Plain Layout
5717 \begin_inset Flex MenuItem
5720 \begin_layout Plain Layout
5726 keys, a spare function key, etc.
5727 As for the \SpecialChar LyX
5728 commands that produce accents, check the entry for
5729 \begin_inset Flex Code
5732 \begin_layout Plain Layout
5743 You'll find the complete list there.
5746 \begin_layout Subsection
5747 Saving your Language Configuration
5750 \begin_layout Standard
5751 You can edit your preferences so that your desired language environment
5752 is automatically configured when \SpecialChar LyX
5754 \begin_inset Flex MenuItem
5757 \begin_layout Plain Layout
5758 Edit\SpecialChar menuseparator
5767 \begin_layout Chapter
5768 Installing New Document Classes, Layouts, and Templates
5769 \begin_inset CommandInset label
5771 name "cha:Installing-New-Document"
5776 \begin_inset Argument 1
5779 \begin_layout Plain Layout
5780 Installing New Document Classes
5788 \begin_layout Standard
5789 In this chapter, we describe the procedures for creating and installing
5790 new \SpecialChar LyX
5791 layout and template files, as well as offer a refresher on correctly
5792 installing new \SpecialChar LaTeX
5797 \begin_layout Standard
5798 First, let us a say a few words about how one ought to think about the relation
5799 between \SpecialChar LyX
5800 and \SpecialChar LaTeX
5802 The thing to understand is that, in a certain sense, \SpecialChar LyX
5803 doesn't know anything
5804 about \SpecialChar LaTeX
5806 Indeed, from \SpecialChar LyX
5807 's point of view, \SpecialChar LaTeX
5808 is just one of several
5809 \begin_inset Quotes eld
5813 \begin_inset Quotes erd
5816 in which it is capable of producing output.
5817 Other such formats are DocBook, plaintext, and XHTML.
5819 is, of course, a particularly important format, but very little of the
5820 information \SpecialChar LyX
5821 has about \SpecialChar LaTeX
5822 is actually contained in the program itself.
5826 \begin_layout Plain Layout
5827 Some commands are sufficiently complex that they are
5828 \begin_inset Quotes eld
5832 \begin_inset Quotes erd
5835 into \SpecialChar LyX
5837 But the developers generally regard this as a Bad Thing.
5842 Rather, that information, even for the standard classes like
5843 \begin_inset Flex Code
5846 \begin_layout Plain Layout
5852 , is contained in `layout files'.
5853 Similarly, \SpecialChar LyX
5854 itself does not know much about DocBook or XHTML.
5855 What it knows is contained in layout files.
5858 \begin_layout Standard
5859 You can think of the layout file for a given document class as a translation
5860 manual between \SpecialChar LyX
5861 constructs—paragraphs with their corresponding styles,
5862 certain sorts of insets, etc—and the corresponding \SpecialChar LaTeX
5865 Almost everything \SpecialChar LyX
5867 \begin_inset Flex Code
5870 \begin_layout Plain Layout
5876 , for example, is contained in the file
5877 \begin_inset Flex Code
5880 \begin_layout Plain Layout
5886 and in various other files it includes.
5887 For this reason, anyone intending to write layout files should plan to
5888 study the existing files.
5889 A good place to start is with
5890 \begin_inset Flex Code
5893 \begin_layout Plain Layout
5899 , which is included in
5900 \begin_inset Flex Code
5903 \begin_layout Plain Layout
5910 \begin_inset Flex Code
5913 \begin_layout Plain Layout
5919 , and many of the other layout files for document classes.
5920 This file is where sections and the like are defined:
5921 \begin_inset Flex Code
5924 \begin_layout Plain Layout
5930 tells \SpecialChar LyX
5931 how paragraphs that are marked with the Section, Subsection, etc,
5932 styles can be translated into corresponding \SpecialChar LaTeX
5933 , DocBook, and XHTML commands
5936 \begin_inset Flex Code
5939 \begin_layout Plain Layout
5945 file basically just includes several of these
5946 \begin_inset Flex Code
5949 \begin_layout Plain Layout
5958 \begin_layout Standard
5959 Defining the \SpecialChar LyX
5961 correspondence is not the only thing layout files do, though.
5962 Their other job is to define how the \SpecialChar LyX
5963 constructs themselves will appear
5965 The fact that layout files have these two jobs is often a source of confusion,
5966 because they are completely separate.
5967 Telling \SpecialChar LyX
5968 how to translate a certain paragraph style into \SpecialChar LaTeX
5971 how to display it; conversely, telling \SpecialChar LyX
5972 how to display a certain paragraph
5973 style does not tell \SpecialChar LyX
5974 how to translate it into \SpecialChar LaTeX
5975 (let alone tell \SpecialChar LaTeX
5978 So, in general, when you define a new \SpecialChar LyX
5979 construct, you must always do two
5980 quite separate things: (i)
5981 \begin_inset space ~
5984 tell \SpecialChar LyX
5985 how to translate it into \SpecialChar LaTeX
5987 \begin_inset space ~
5990 tell \SpecialChar LyX
5994 \begin_layout Standard
5995 Much the same is true, of course, as regards \SpecialChar LyX
5996 's other backend formats, though
5997 XHTML is in some ways different, because in that case \SpecialChar LyX
6002 able, to some extent, to use information about how it should display a
6003 paragraph on the screen to output information (in the form of CSS) about
6004 how the paragraph should be displayed in a browser.
6005 Even in this case, however, the distinction between what \SpecialChar LyX
6007 and how things are rendered externally remains in force, and the two can
6008 be controlled separately.
6010 \begin_inset CommandInset ref
6012 reference "sec:Tags-for-XHTML"
6019 \begin_layout Section
6020 Installing new \SpecialChar LaTeX
6024 \begin_layout Standard
6025 Some installations may not include a \SpecialChar LaTeX
6026 package or class file that you would
6027 like to use within \SpecialChar LyX
6029 For example, you might need Foil\SpecialChar TeX
6030 , a package for preparing slides for overhead
6032 Modern \SpecialChar LaTeX
6033 distributions like \SpecialChar TeX
6034 Live (2008 or newer) or MiK\SpecialChar TeX
6035 provide a user interface
6036 for installing such packages.
6037 For example, with MiK\SpecialChar TeX
6038 , you start the program
6039 \begin_inset Quotes eld
6043 \begin_inset space ~
6047 \begin_inset Quotes erd
6050 to get a list of available packages.
6051 To install one of them, right click on it or use the corresponding toolbar
6055 \begin_layout Standard
6056 If your \SpecialChar LaTeX
6057 distribution does not provide such a `package manager', or if the
6058 package is not available from your distribution, then follow these steps
6059 to install it manually:
6062 \begin_layout Enumerate
6063 Get the package from
6064 \begin_inset CommandInset href
6067 target "http://www.ctan.org/"
6074 \begin_layout Enumerate
6075 If the package contains a file with the ending
6076 \begin_inset Quotes eld
6080 \begin_inset Flex Code
6083 \begin_layout Plain Layout
6090 \begin_inset Quotes erd
6093 (is the case for Foil\SpecialChar TeX
6094 ) then open a console, change to the folder of this
6095 file and execute the command
6096 \begin_inset Flex Code
6099 \begin_layout Plain Layout
6106 You have now unpacked the package and have all files to install it.
6107 Most \SpecialChar LaTeX
6108 -packages are not packed and you can skip this step.
6111 \begin_layout Enumerate
6112 Now you need to decide if the package should be available for all users
6114 \begin_inset Separator parbreak
6121 \begin_layout Enumerate
6122 On *nix systems (Linux, OSX, etc.), if you want the new package to be available
6123 for all users on your system, then install it in your `local' \SpecialChar TeX
6125 install it in your own `user' \SpecialChar TeX
6127 Where these trees should be created, if they do not already exist, depends
6129 To find this out, look in the file
6130 \begin_inset Flex Code
6133 \begin_layout Plain Layout
6143 \begin_layout Plain Layout
6144 This is usually in the directory
6145 \begin_inset Flex Code
6148 \begin_layout Plain Layout
6154 , though you can execute the command
6155 \begin_inset Flex Code
6158 \begin_layout Plain Layout
6169 The location of the `local' \SpecialChar TeX
6170 tree is defined by the
6171 \begin_inset Flex Code
6174 \begin_layout Plain Layout
6180 variable; this is usually somewhere like
6181 \begin_inset Flex Code
6184 \begin_layout Plain Layout
6185 /usr/local/share/texmf
6191 The location of the `user' \SpecialChar TeX
6193 \begin_inset Flex Code
6196 \begin_layout Plain Layout
6203 \begin_inset Flex Code
6206 \begin_layout Plain Layout
6213 (If these variables are not predefined, you have to define them.) You'll
6214 probably need root permissions to create or modify the `local' tree, but
6215 not for your `user' tree.
6216 \begin_inset Newline newline
6219 In general, it is recommended to install in the user tree because your user
6220 will not be modified or even overwritten when you upgrade your system.
6221 It will typically also be backed up together with everything else when
6222 you backup your home directory (which, of course, you do on a regular basis).
6225 \begin_layout Enumerate
6226 On Windows, if you want the new package to be available for all users on
6227 your system, change to the folder where \SpecialChar LaTeX
6228 is installed and then change to
6230 \begin_inset Flex Code
6233 \begin_layout Plain Layout
6244 (For MiK\SpecialChar TeX
6245 , this would be by default the folder
6246 \begin_inset Flex Code
6249 \begin_layout Plain Layout
6255 \change_deleted -712698321 1437634323
6258 \change_inserted -712698321 1437634327
6274 \begin_layout Plain Layout
6275 Note that this will be the correct path only on English installations.
6276 On a German one, it would be
6277 \begin_inset Flex Code
6280 \begin_layout Plain Layout
6286 \change_deleted -712698321 1437634336
6289 \change_inserted -712698321 1437634337
6301 , and similarly for other languages.
6306 Create there a new folder
6307 \begin_inset Flex Code
6310 \begin_layout Plain Layout
6316 and copy all files of the package into it.
6318 \begin_inset Newline newline
6321 If the package should only available for you or you don't have admin permissions
6322 , do the same, but in the local \SpecialChar LaTeX
6325 \begin_inset space \thinspace{}
6328 g., for MiK\SpecialChar TeX
6330 \begin_inset space ~
6333 2.8 under Windows XP, this would be the folder:
6334 \begin_inset Newline newline
6340 \begin_inset Flex Code
6343 \begin_layout Plain Layout
6346 Documents and Settings
6358 \begin_inset Newline newline
6364 \begin_inset Phantom HPhantom
6367 \begin_layout Plain Layout
6378 \begin_inset Flex Code
6381 \begin_layout Plain Layout
6383 \change_deleted -712698321 1437634345
6386 \change_inserted -712698321 1437634347
6401 \begin_inset Newline newline
6404 On Vista, it would be:
6405 \begin_inset Newline newline
6409 \begin_inset Flex Code
6412 \begin_layout Plain Layout
6426 \change_inserted -712698321 1437634351
6428 \change_deleted -712698321 1437634351
6445 \begin_layout Enumerate
6446 Now one only need to tell \SpecialChar LaTeX
6447 that there are new files.
6448 This depends on the used \SpecialChar LaTeX
6450 \begin_inset Separator parbreak
6457 \begin_layout Enumerate
6458 For \SpecialChar TeX
6459 Live execute the command
6460 \begin_inset Flex Code
6463 \begin_layout Plain Layout
6470 If you installed the package for all users, then you will probably need
6471 to have root permissions for that.
6474 \begin_layout Enumerate
6475 For MiK\SpecialChar TeX
6476 , if you have installed the package for all users, start the program
6478 \begin_inset Quotes eld
6482 \begin_inset space ~
6486 \begin_inset Quotes erd
6489 and press the button marked
6490 \begin_inset Quotes eld
6494 \begin_inset Quotes erd
6498 Otherwise start the program
6499 \begin_inset Quotes eld
6503 \begin_inset Quotes erd
6510 \begin_layout Enumerate
6511 Finally, you need to tell \SpecialChar LyX
6512 that there are new packages available.
6513 So, in \SpecialChar LyX
6515 \begin_inset Flex MenuItem
6518 \begin_layout Plain Layout
6521 \SpecialChar menuseparator
6527 and then restart \SpecialChar LyX
6531 \begin_layout Standard
6532 Now the package is installed.
6533 In our example, the document class
6534 \begin_inset Flex Code
6537 \begin_layout Plain Layout
6539 \begin_inset space ~
6543 \change_deleted -712698321 1437634694
6548 \begin_layout Plain Layout
6562 will now be available under
6563 \begin_inset Flex MenuItem
6566 \begin_layout Plain Layout
6567 Document\SpecialChar menuseparator
6568 Settings\SpecialChar menuseparator
6578 \begin_layout Standard
6579 If you would like to use a \SpecialChar LaTeX
6580 document class that is not even listed in the
6582 \begin_inset Flex MenuItem
6585 \begin_layout Plain Layout
6586 Document\SpecialChar menuseparator
6587 Settings\SpecialChar menuseparator
6593 , then you need to create a `layout' file for it.
6594 That is the topic of the next section.
6597 \begin_layout Section
6598 Types of layout files
6601 \begin_layout Standard
6602 This section describes the various sorts of \SpecialChar LyX
6603 files that contain layout informati
6605 These files describe various paragraph and character styles, determining
6606 how \SpecialChar LyX
6607 should display them and how they should be translated into \SpecialChar LaTeX
6609 XHTML, or whatever output format is being used.
6613 \begin_layout Standard
6614 We shall try to provide a thorough description of the process of writing
6616 However, there are so many different types of documents supported even
6617 by just \SpecialChar LaTeX
6618 that we can't hope to cover every different possibility or problem
6619 you might encounter.
6620 The \SpecialChar LyX
6621 users' list is frequented by people with lots of experience with layout
6622 design who are willing to share what they've learned, so please feel free
6623 to ask questions there.
6626 \begin_layout Standard
6627 As you prepare to write a new layout, it is extremely helpful to look at
6628 the layouts distributed with \SpecialChar LyX
6630 If you write a \SpecialChar LyX
6631 layout for a \SpecialChar LaTeX
6632 document class that might also be used by
6633 others, or write a module that might be useful to others, then you should
6634 consider posting your layout to the
6635 \begin_inset CommandInset href
6637 name "layout section on the LyX wiki"
6638 target "http://wiki.lyx.org/Layouts/Layouts"
6642 or even to the \SpecialChar LyX
6643 developers' list, so that it might be included in \SpecialChar LyX
6648 \begin_layout Plain Layout
6649 Note that \SpecialChar LyX
6650 is licensed under the General Public License, so any material
6651 that is contributed to \SpecialChar LyX
6652 must be similarly licensed.
6660 \begin_layout Subsection
6662 \begin_inset CommandInset label
6664 name "subsec:Layout-modules"
6671 \begin_layout Standard
6672 We have spoken to this point about `layout files'.
6673 But there are different sorts of files that contain layout information.
6674 Layout files, strictly so called, have the
6675 \begin_inset Flex Code
6678 \begin_layout Plain Layout
6684 extension and provide \SpecialChar LyX
6685 with information about document classes.
6686 Since \SpecialChar LyX
6687 1.6 layout information can also be contained in layout
6692 \begin_inset Flex Code
6695 \begin_layout Plain Layout
6702 Modules are to \SpecialChar LaTeX
6703 packages much as layouts are to \SpecialChar LaTeX
6704 classes, and some modules—such
6706 \begin_inset Flex Code
6709 \begin_layout Plain Layout
6715 module—specifically provide support for one package.
6716 In a sense, layout modules are similar to included
6720 \begin_layout Plain Layout
6721 These can have any extension, but by convention have the
6722 \begin_inset Flex Code
6725 \begin_layout Plain Layout
6737 \begin_inset Flex Code
6740 \begin_layout Plain Layout
6746 —in that modules are not specific to a given document class but may be used
6747 with many different classes.
6748 The difference is that using an included file with
6749 \begin_inset Flex Code
6752 \begin_layout Plain Layout
6758 requires editing that file.
6759 Modules, by contrast, are selected in the
6760 \begin_inset Flex MenuItem
6763 \begin_layout Plain Layout
6764 Document\SpecialChar menuseparator
6773 \begin_layout Standard
6774 Building modules is the easiest way to get started with layout editing,
6775 since it can be as simple as adding a single new paragraph style or flex
6777 But modules may, in principle, contain anything a layout file can contain.
6780 \begin_layout Standard
6781 After creating a new module and copying it to the
6782 \begin_inset Flex Code
6785 \begin_layout Plain Layout
6791 folder, you will need to reconfigure and then restart \SpecialChar LyX
6794 However, changes you make to the module will be seen immediately, if you
6796 \begin_inset Flex MenuItem
6799 \begin_layout Plain Layout
6800 Document\SpecialChar menuseparator
6806 , highlight something, and then hit
6807 \begin_inset Quotes eld
6811 \begin_inset Quotes erd
6817 It is strongly recommended that you save your work before doing this
6822 it is strongly recommended that you not attempt to edit modules while simultaneo
6823 usly working on actual documents
6826 Though of course the developers strive to keep \SpecialChar LyX
6827 stable in such situations,
6828 syntax errors and the like in your module file could cause strange behavior.
6831 \begin_layout Subsubsection
6835 \begin_layout Standard
6836 Modules are to \SpecialChar LyX
6837 as packages are to \SpecialChar LaTeX
6839 Sometimes, however, you find yourself wanting a specific inset or character
6840 style just for one document and writing a module that will also be available
6841 to other documents makes little sense.
6842 What you need is \SpecialChar LyX
6844 \begin_inset Quotes eld
6848 \begin_inset Quotes erd
6854 \begin_layout Standard
6855 You will find it under
6857 Document\SpecialChar menuseparator
6858 Settings\SpecialChar menuseparator
6862 The large text box allows you to enter anything that you might enter in
6863 a layout file or module.
6864 You can think of a document's local layout, in fact, as a module that belongs
6866 So, in particular, you must enter a
6867 \begin_inset Flex Code
6870 \begin_layout Plain Layout
6877 Any format is acceptable, but one would normally use the format current
6879 (In \SpecialChar LyX
6880 2.1, the current layout format is 48.) You should be aware that local
6881 layout is not supported by versions of \SpecialChar LyX
6882 prior to 1.6, so you should not
6883 use it if you want to be able to export your document to \SpecialChar LyX
6885 (without, that is, losing the local layout information).
6886 If you wish to be able to export to 1.6—local layout is supported in 1.6,
6887 though there is no UI for it—then you should use format 11 and, of course,
6888 use only layout constructs that were available in \SpecialChar LyX
6892 \begin_layout Standard
6893 When you have entered something in the
6894 \begin_inset Flex Code
6897 \begin_layout Plain Layout
6903 pane, \SpecialChar LyX
6905 \begin_inset Quotes eld
6909 \begin_inset Quotes erd
6912 button at the bottom.
6913 Clicking this button will cause \SpecialChar LyX
6914 to determine whether what you have entered
6915 is valid layout information for the chosen format.
6917 will report the result but, unfortunately, will not tell you what errors
6918 there might have been.
6919 These will be written to the terminal, however, if \SpecialChar LyX
6920 is started from a terminal.
6921 You will not be permitted to save your local layout until you have entered
6925 \begin_layout Standard
6926 The warnings at the end of the previous section apply here, too.
6927 Do not play with local layout while you are actually working, especially
6928 if you have not saved your document.
6929 That said, using local layout with a test document can be a very convenient
6930 way to try out layout ideas, or even to start developing a module.
6933 \begin_layout Subsection
6935 \begin_inset Flex MenuItem
6938 \begin_layout Plain Layout
6947 \begin_layout Standard
6948 There are two situations you are likely to encounter when wanting to support
6949 a new \SpecialChar LaTeX
6950 document class, involving style (
6951 \begin_inset Flex Code
6954 \begin_layout Plain Layout
6960 ) files and \SpecialChar LaTeX2e
6962 \begin_inset Flex Code
6965 \begin_layout Plain Layout
6972 Supporting a style file is usually fairly easy.
6973 Supporting a new class file is a bit harder.
6974 We'll discuss the former in this section and the latter in the next.
6975 Similar remarks apply, of course, if you want to support a new DocBook
6979 \begin_layout Standard
6980 The easier case is the one in which your new document class is provided
6981 as a style file that is to be used in conjunction with an already supported
6983 For the sake of the example, we'll assume that the style file is called
6985 \begin_inset Flex MenuItem
6988 \begin_layout Plain Layout
6994 and that it is meant to be used with
6995 \begin_inset Flex MenuItem
6998 \begin_layout Plain Layout
7004 , which is a standard class.
7008 \begin_layout Standard
7009 Start by copying the existing class's layout file into your local directory:
7013 \begin_layout Plain Layout
7014 Of course, which directory is your local directory will vary by platform,
7015 and \SpecialChar LyX
7016 allows you to specify your local directory on startup, too, using
7018 \begin_inset Flex Code
7021 \begin_layout Plain Layout
7035 \begin_layout LyX-Code
7036 cp report.layout ~/.lyx/layouts/myclass.layout
7039 \begin_layout Standard
7041 \begin_inset Flex Code
7044 \begin_layout Plain Layout
7050 and change the line:
7053 \begin_layout LyX-Code
7056 Declare\SpecialChar LaTeX
7060 \begin_layout Standard
7064 \begin_layout LyX-Code
7067 Declare\SpecialChar LaTeX
7068 Class[report, myclass.sty]{report (myclass)}
7071 \begin_layout Standard
7075 \begin_layout LyX-Code
7077 \begin_inset Newline newline
7083 \begin_inset Newline newline
7089 \begin_layout Standard
7090 near the top of the file.
7093 \begin_layout Standard
7094 Start \SpecialChar LyX
7096 \begin_inset Flex MenuItem
7099 \begin_layout Plain Layout
7100 Tools\SpecialChar menuseparator
7107 Then restart \SpecialChar LyX
7108 and try creating a new document.
7110 \begin_inset Flex MenuItem
7113 \begin_layout Plain Layout
7119 " as a document class option in the
7120 \begin_inset Flex MenuItem
7123 \begin_layout Plain Layout
7124 Document\SpecialChar menuseparator
7131 It is likely that some of the sectioning commands and such in your new
7132 class will work differently from how they worked in the base class—
7133 \begin_inset Flex Code
7136 \begin_layout Plain Layout
7142 in this example—so you can fiddle around with the settings for the different
7143 sections if you wish.
7144 The layout information for sections is contained in
7145 \begin_inset Flex Code
7148 \begin_layout Plain Layout
7154 , but you do not need to copy and change this file.
7155 Instead, you can simply add your changes to your layout file, after the
7157 \begin_inset Flex Code
7160 \begin_layout Plain Layout
7166 , which itself includes
7167 \begin_inset Flex Code
7170 \begin_layout Plain Layout
7177 For example, you might add these lines:
7180 \begin_layout LyX-Code
7184 \begin_layout LyX-Code
7188 \begin_layout LyX-Code
7192 \begin_layout LyX-Code
7196 \begin_layout LyX-Code
7200 \begin_layout Standard
7201 to change the font for chapter headings to sans-serif.
7202 This will override (or, in this case, add to) the existing declaration
7203 for the Chapter style.
7207 \begin_layout Standard
7208 Your new package may also provide commands or environments not present in
7210 In this case, you will want to add these to the layout file.
7212 \begin_inset CommandInset ref
7214 reference "sec:TextClass"
7218 for information on how to do so.
7221 \begin_layout Standard
7223 \begin_inset Flex MenuItem
7226 \begin_layout Plain Layout
7232 can be used with several different document classes, and even if it cannot,
7233 you might find it easiest just to write a module that you can load with
7235 The simplest possible such module would be:
7238 \begin_layout LyX-Code
7242 \change_deleted -712698321 1437634736
7245 \change_inserted -712698321 1437634737
7251 \begin_layout LyX-Code
7255 \begin_layout LyX-Code
7256 #Support for mypkg.sty.
7259 \begin_layout LyX-Code
7261 \begin_inset Newline newline
7267 \begin_layout LyX-Code
7269 \begin_inset Newline newline
7275 \begin_layout LyX-Code
7277 \begin_inset Newline newline
7283 \begin_inset Newline newline
7289 \begin_layout Standard
7290 A more complex module might modify the behavior of some existing constructs
7291 or define some new ones.
7293 \begin_inset CommandInset ref
7295 reference "sec:TextClass"
7302 \begin_layout Subsection
7304 \begin_inset Flex MenuItem
7307 \begin_layout Plain Layout
7316 \begin_layout Standard
7317 There are two possibilities here.
7318 One is that the class file is itself based upon an existing document class.
7319 For example, many thesis classes are based upon
7320 \begin_inset Flex MenuItem
7323 \begin_layout Plain Layout
7330 To see whether yours is, look for a line like
7333 \begin_layout LyX-Code
7339 \begin_layout Standard
7341 If so, then you may proceed largely as in the previous section, though
7343 \begin_inset Flex Code
7346 \begin_layout Plain Layout
7347 Declare\SpecialChar LaTeX
7353 line will be different.
7354 If your new class is
7355 \begin_inset Flex Code
7358 \begin_layout Plain Layout
7364 and it is based upon
7365 \begin_inset Flex Code
7368 \begin_layout Plain Layout
7374 , then the line should read:
7378 \begin_layout Plain Layout
7379 And it will be easiest if you save the file to
7380 \begin_inset Flex Code
7383 \begin_layout Plain Layout
7390 assumes that the document class has the same name as the layout file.
7399 \begin_layout LyX-Code
7402 Declare\SpecialChar LaTeX
7403 Class[thesis,book]{thesis}
7406 \begin_layout Standard
7407 If, on the other hand, the new class is not based upon an existing class,
7408 you will probably have to
7409 \begin_inset Quotes eld
7413 \begin_inset Quotes erd
7417 We strongly suggest copying an existing layout file which uses a similar
7419 class and then modifying it, if you can do so.
7420 At least use an existing file as a starting point so you can find out what
7421 items you need to worry about.
7422 Again, the specifics are covered below.
7425 \begin_layout Subsection
7427 \begin_inset CommandInset label
7429 name "subsec:Creating-Templates"
7436 \begin_layout Standard
7437 Once you have written a layout file for a new document class, you might
7438 want to consider writing a
7443 A template acts as a kind of tutorial for your layout, showing how it might
7444 be used, though containing dummy content.
7445 You can of course look at the various templates included with \SpecialChar LyX
7449 \begin_layout Standard
7450 Templates are created just like usual documents: using \SpecialChar LyX
7452 The only difference is that usual documents contain all possible settings,
7453 including the font scheme and the paper size.
7454 Usually a user doesn't want a template to overwrite his preferred settings
7455 for such parameters.
7456 For that reason, the designer of a template should remove the corresponding
7458 \begin_inset Flex Code
7461 \begin_layout Plain Layout
7470 \begin_inset Flex Code
7473 \begin_layout Plain Layout
7481 from the template \SpecialChar LyX
7483 This can be done with any simple text-editor, for example
7484 \begin_inset Flex Code
7487 \begin_layout Plain Layout
7494 \begin_inset Flex Code
7497 \begin_layout Plain Layout
7506 \begin_layout Standard
7507 Put the edited template files you create in
7508 \begin_inset Flex Code
7511 \begin_layout Plain Layout
7517 , copy the ones you use from the global template directory in
7518 \begin_inset Flex Code
7521 \begin_layout Plain Layout
7523 \change_deleted -712698321 1437634751
7526 \change_inserted -712698321 1437634752
7534 to the same place, and redefine the template path in the
7535 \begin_inset Flex MenuItem
7538 \begin_layout Plain Layout
7539 Tools\SpecialChar menuseparator
7540 Preferences\SpecialChar menuseparator
7549 \begin_layout Standard
7550 Note, by the way, that there is a template which has a particular meaning:
7552 \begin_inset Flex Code
7555 \begin_layout Plain Layout
7562 This template is loaded every time you create a new document with
7563 \begin_inset Flex MenuItem
7566 \begin_layout Plain Layout
7567 File\SpecialChar menuseparator
7573 in order to provide useful defaults.
7574 To create this template from inside \SpecialChar LyX
7575 , all you have to do is to open a document
7576 with the correct settings, and use the
7577 \begin_inset Flex MenuItem
7580 \begin_layout Plain Layout
7581 Save as Document Defaults
7589 \begin_layout Subsection
7590 Upgrading old layout files
7593 \begin_layout Standard
7594 The format of layout files changes with each \SpecialChar LyX
7595 release, so old layout files
7596 need to be converted to the new format.
7598 reads a layout file in an older format, it automatically calls the
7600 \begin_inset Flex Code
7603 \begin_layout Plain Layout
7609 to convert it to a temporary file in current format.
7610 The original file is left untouched.
7611 If you use the layout file often, then, you may want to convert it permanently,
7612 so that \SpecialChar LyX
7613 does not have to do so itself every time.
7614 To do this, you can call the converter manually:
7617 \begin_layout Enumerate
7619 \begin_inset Flex Code
7622 \begin_layout Plain Layout
7629 \begin_inset Flex Code
7632 \begin_layout Plain Layout
7641 \begin_layout Enumerate
7643 \begin_inset Newline newline
7647 \begin_inset Flex Code
7650 \begin_layout Plain Layout
7652 \change_deleted -712698321 1437634764
7655 \change_inserted -712698321 1437634766
7658 Dir/scripts/layout2layout.py myclass.old myclass.layout
7664 \begin_inset Newline newline
7668 \begin_inset Flex Code
7671 \begin_layout Plain Layout
7673 \change_deleted -712698321 1437634771
7676 \change_inserted -712698321 1437634772
7684 is the name of your \SpecialChar LyX
7688 \begin_layout Standard
7689 Note that manual conversion does not affect included files, so these will
7690 have to be converted separately.
7693 \begin_layout Section
7694 \begin_inset CommandInset label
7696 name "sec:TextClass"
7700 The layout file format
7703 \begin_layout Standard
7704 The following sections describe how layout files are structured and written.
7705 Our advice is to go slowly, save and test often.
7706 It is really not that hard, except that the multitude of options can become
7707 overwhelming, especially if you try to check out too many at once.
7708 It becomes easier if you use existing layouts of \SpecialChar LyX
7709 as examples/reference
7710 or if you modify an existing layout to your needs.
7713 \begin_layout Standard
7714 Note that all the tags used in layout files are case-insensitive.
7716 \begin_inset Flex Code
7719 \begin_layout Plain Layout
7726 \begin_inset Flex Code
7729 \begin_layout Plain Layout
7736 \begin_inset Flex Code
7739 \begin_layout Plain Layout
7745 are really the same tag.
7746 The possible arguments are printed in brackets after the tag's name.
7747 The default argument is typeset
7748 \begin_inset Flex Code
7751 \begin_layout Plain Layout
7760 If the argument has a data type like
7761 \begin_inset Quotes eld
7765 \begin_inset Quotes erd
7769 \begin_inset Quotes eld
7773 \begin_inset Quotes erd
7776 , the default is shown like this:
7777 \begin_inset Flex Code
7780 \begin_layout Plain Layout
7791 \begin_layout Subsection
7792 The document class declaration and classification
7795 \begin_layout Standard
7796 Lines in a layout file which begin with
7797 \begin_inset Flex Code
7800 \begin_layout Plain Layout
7807 There is one exception to this rule.
7809 \begin_inset Flex Code
7812 \begin_layout Plain Layout
7818 files should begin with lines like:
7821 \begin_layout LyX-Code
7824 #% Do not delete the line below; configure depends on this
7827 \begin_layout LyX-Code
7833 \change_deleted -712698321 1437634362
7840 \begin_layout Plain Layout
7851 eXClass{Article (Standard Class)}
7854 \begin_layout LyX-Code
7859 DeclareCategory{Articles}
7862 \begin_layout Standard
7863 The second and third lines are used when you (re)configure \SpecialChar LyX
7865 The layout file is read by the \SpecialChar LaTeX
7867 \begin_inset Flex Code
7870 \begin_layout Plain Layout
7876 , in a special mode where
7877 \begin_inset Flex Code
7880 \begin_layout Plain Layout
7887 The first line is just a \SpecialChar LaTeX
7888 comment, the second one contains the mandatory
7889 declaration of the text class and the third line contains the optional
7890 classification of the class.
7891 If these lines appear in a file named
7892 \begin_inset Flex Code
7895 \begin_layout Plain Layout
7901 , then they define a text class of name
7902 \begin_inset Flex Code
7905 \begin_layout Plain Layout
7911 (the name of the layout file) which uses the \SpecialChar LaTeX
7913 \begin_inset Flex Code
7916 \begin_layout Plain Layout
7922 (the default is to use the same name as the layout).
7924 \begin_inset Quotes eld
7927 Article (Standard Class)
7928 \begin_inset Quotes erd
7931 that appears above is used as a description of the text class in the
7932 \begin_inset Flex MenuItem
7935 \begin_layout Plain Layout
7936 Document\SpecialChar menuseparator
7944 \begin_inset Quotes eld
7948 \begin_inset Quotes erd
7951 in the example) is also used in the
7952 \begin_inset Flex MenuItem
7955 \begin_layout Plain Layout
7956 Document\SpecialChar menuseparator
7962 dialog: the text classes are grouped by these categories (which are usually
7963 genres, so typical categories are
7964 \begin_inset Quotes eld
7968 \begin_inset Quotes erd
7972 \begin_inset Quotes eld
7976 \begin_inset Quotes erd
7980 \begin_inset Quotes eld
7984 \begin_inset Quotes erd
7988 \begin_inset Quotes eld
7992 \begin_inset Quotes erd
7996 \begin_inset Quotes eld
8000 \begin_inset Quotes erd
8004 \begin_inset Quotes eld
8008 \begin_inset Quotes erd
8012 If no category has been declared, the class will be put in the
8013 \begin_inset Quotes eld
8017 \begin_inset Quotes erd
8023 \begin_layout Standard
8024 Let's assume that you wrote your own text class that uses the
8025 \begin_inset Flex Code
8028 \begin_layout Plain Layout
8034 document class, but where you changed the appearance of the section headings.
8035 If you put it in a file
8036 \begin_inset Flex Code
8039 \begin_layout Plain Layout
8045 , the header of this file should be:
8048 \begin_layout LyX-Code
8051 #% Do not delete the line below; configure depends on this
8054 \begin_layout LyX-Code
8065 \begin_layout Plain Layout
8074 eXClass[article]{Article (with My Own Headings)}
8077 \begin_layout LyX-Code
8082 DeclareCategory{Articles}
8085 \begin_layout Standard
8086 This declares a text class
8087 \begin_inset Flex Code
8090 \begin_layout Plain Layout
8096 , associated with the \SpecialChar LaTeX
8098 \begin_inset Flex Code
8101 \begin_layout Plain Layout
8108 \begin_inset Quotes eld
8111 Article (with My Own Headings)
8112 \begin_inset Quotes erd
8116 If your text class depends on several packages, you can declare it as:
8119 \begin_layout LyX-Code
8122 #% Do not delete the line below; configure depends on this
8125 \begin_layout LyX-Code
8131 \change_deleted -712698321 1437634376
8138 \begin_layout Plain Layout
8149 eXClass[article,foo.sty]{Article (with My Own Headings)}
8152 \begin_layout LyX-Code
8157 DeclareCategory{Articles}
8160 \begin_layout Standard
8161 This indicates that your text class uses the
8162 \begin_inset Flex Code
8165 \begin_layout Plain Layout
8172 Finally, it is also possible to declare classes for DocBook code.
8173 Typical declarations will look like:
8176 \begin_layout LyX-Code
8179 #% Do not delete the line below; configure depends on this
8182 \begin_layout LyX-Code
8187 DeclareDocBookClass[article]{SGML (DocBook Article)}
8190 \begin_layout LyX-Code
8195 DeclareCategory{Articles (DocBook)}
8198 \begin_layout Standard
8199 Note that these declarations can also be given an optional parameter declaring
8200 the name of the document class (but not a list).
8203 \begin_layout Standard
8204 So, to be as explicit as possible, the form of the layout declaration is:
8207 \begin_layout LyX-Code
8213 \change_deleted -712698321 1437634381
8220 \begin_layout Plain Layout
8231 eXClass[class,package.sty]{layout description}
8234 \begin_layout LyX-Code
8239 DeclareCategory{category}
8242 \begin_layout Standard
8243 The class need only be specified if the name of the \SpecialChar LaTeX
8245 name of the layout file are different or if there are packages to load.
8246 If the name of the class file is not specified, then \SpecialChar LyX
8248 that it is the same as the name of the layout file.
8251 \begin_layout Standard
8252 When the text class has been modified to your taste, all you have to do
8253 is to copy it either to
8254 \begin_inset Flex Code
8257 \begin_layout Plain Layout
8259 \change_deleted -712698321 1437634783
8262 \change_inserted -712698321 1437634784
8271 \begin_inset Flex Code
8274 \begin_layout Plain Layout
8281 \begin_inset Flex MenuItem
8284 \begin_layout Plain Layout
8285 Tools\SpecialChar menuseparator
8291 , exit \SpecialChar LyX
8293 Then your new text class should be available along with the others.
8296 \begin_layout Standard
8297 Once the layout file is installed, you can edit it and see your changes
8298 without having to reconfigure or to restart \SpecialChar LyX
8304 \begin_layout Plain Layout
8305 In versions of \SpecialChar LyX
8306 prior to 1.6, this was not true.
8307 As a result, editing layout files was very time consuming, since you had
8308 constantly to restart \SpecialChar LyX
8314 You can force a reload of the current layout by using the \SpecialChar LyX
8316 \begin_inset Flex MenuItem
8319 \begin_layout Plain Layout
8326 There is no default binding for this function—though, of course, you can
8327 bind it to a key yourself.
8328 But you will normally use this function simply by entering it in the mini-buffe
8333 \begin_layout Standard
8339 \begin_inset Flex MenuItem
8342 \begin_layout Plain Layout
8348 is very much an `advanced feature'.
8353 recommended that you save your work before using this function.
8358 recommended that you not attempt to edit layout information while simultaneousl
8359 y working on a document that you care about.
8360 Use a test document.
8361 Syntax errors and the like in your layout file could cause peculiar behavior.
8362 In particular, such errors could cause \SpecialChar LyX
8363 to regard the current layout as
8364 invalid and to attempt to switch to some other layout.
8368 \begin_layout Plain Layout
8369 Really bad syntax errors may even caused \SpecialChar LyX
8371 This is because certain sorts of errors may make \SpecialChar LyX
8382 The \SpecialChar LyX
8383 team strives to keep \SpecialChar LyX
8384 stable in such situations, but safe is better
8389 \begin_layout Plain Layout
8390 While we're giving advice: make regular backups.
8391 And be nice to your mother.
8399 \begin_layout Subsection
8400 The Module declaration
8403 \begin_layout Standard
8404 A module must begin with a line like the following:
8407 \begin_layout LyX-Code
8411 \change_deleted -712698321 1437634801
8416 \begin_layout Plain Layout
8425 yXModule[endnotes.sty]{Endnotes}
8428 \begin_layout Standard
8429 The mandatory argument, in curly brackets, is the name of the module, as
8431 \begin_inset Flex MenuItem
8434 \begin_layout Plain Layout
8435 Document\SpecialChar menuseparator
8436 Settings\SpecialChar menuseparator
8443 The argument in square brackets is optional: It declares any \SpecialChar LaTeX
8445 on which the module depends.
8446 It is also possible to use the form
8447 \begin_inset Flex MenuItem
8450 \begin_layout Plain Layout
8456 as an optional argument, which declares that the module can only be used
8457 when there exists a conversion chain between the formats `
8458 \begin_inset Flex Code
8461 \begin_layout Plain Layout
8468 \begin_inset Flex Code
8471 \begin_layout Plain Layout
8480 \begin_layout Standard
8481 The module declaration should then be followed by lines like the following
8485 \begin_layout Plain Layout
8486 Preferably in English if the module should be published with \SpecialChar LyX
8488 This description will appear in the list of messages to be translated and
8489 will be thus translated with the next interface update.
8497 \begin_layout LyX-Code
8501 \begin_layout LyX-Code
8502 #Adds an endnote command, in addition to footnotes.
8506 \begin_layout LyX-Code
8507 #You will need to add
8510 \change_deleted -712698321 1437634393
8513 \change_inserted -712698321 1437634395
8519 \begin_layout LyX-Code
8520 #want the endnotes to appear.
8524 \begin_layout LyX-Code
8528 \begin_layout LyX-Code
8529 #Requires: somemodule | othermodule
8532 \begin_layout LyX-Code
8533 #Excludes: badmodule
8536 \begin_layout Standard
8537 The description is used in
8538 \begin_inset Flex MenuItem
8541 \begin_layout Plain Layout
8542 Document\SpecialChar menuseparator
8543 Settings\SpecialChar menuseparator
8549 to provide the user with information about what the module does.
8551 \begin_inset Flex Code
8554 \begin_layout Plain Layout
8560 line is used to identify other modules with which this one must be used;
8562 \begin_inset Flex Code
8565 \begin_layout Plain Layout
8571 line is used to identify modules with which this one may not be used.
8572 Both are optional, and, as shown, multiple modules should be separated
8573 with the pipe symbol: |.
8574 Note that the required modules are treated disjunctively:
8578 of the required modules must be used.
8583 excluded module may be used.
8584 Note that modules are identified here by their filenames without the
8585 \begin_inset Flex Code
8588 \begin_layout Plain Layout
8596 \begin_inset Flex Code
8599 \begin_layout Plain Layout
8606 \begin_inset Flex Code
8609 \begin_layout Plain Layout
8618 \begin_layout Subsection
8622 \begin_layout Standard
8623 The first non-comment line of any layout file, included file, or module
8628 contain the file format number:
8631 \begin_layout Description
8632 \begin_inset Flex Code
8635 \begin_layout Plain Layout
8642 \begin_inset Flex Code
8645 \begin_layout Plain Layout
8651 ] The format number of the layout file.
8654 \begin_layout Standard
8655 This tag was introduced with \SpecialChar LyX
8657 \begin_inset space ~
8661 Layout files from older \SpecialChar LyX
8662 versions do not have an explicit file format and
8663 are considered to have
8664 \begin_inset Flex Code
8667 \begin_layout Plain Layout
8669 \begin_inset space ~
8678 The format for the present version of \SpecialChar LyX
8680 But each version of \SpecialChar LyX
8681 is capable of reading earlier versions' layout files,
8682 just as they are capable of reading files produced by earlier versions
8685 There is, however, no provision for converting to earlier formats.
8688 \begin_layout Subsection
8689 \begin_inset CommandInset label
8691 name "subsec:General-text-class"
8695 General text class parameters
8698 \begin_layout Standard
8699 These are general parameters that govern the behavior of an entire document
8705 mean that they must appear in
8706 \begin_inset Flex Code
8709 \begin_layout Plain Layout
8715 files rather than in modules.
8716 A module can contain any layout tag.)
8719 \begin_layout Description
8720 \begin_inset Flex Code
8723 \begin_layout Plain Layout
8729 Adds information that will be output in the
8730 \begin_inset Flex Code
8733 \begin_layout Plain Layout
8739 block when the document is output to XHTML.
8740 Typically, this would be used to output CSS style information, but it can
8741 be used for anything that can appear in
8742 \begin_inset Flex Code
8745 \begin_layout Plain Layout
8753 \begin_inset Quotes eld
8757 \begin_inset Flex Code
8760 \begin_layout Plain Layout
8767 \begin_inset Quotes erd
8773 \begin_layout Description
8774 \begin_inset Flex Code
8777 \begin_layout Plain Layout
8783 Adds information to the document preamble.
8785 \begin_inset Newline newline
8789 \begin_inset Quotes eld
8793 \begin_inset Flex Code
8796 \begin_layout Plain Layout
8803 \begin_inset Quotes erd
8809 \begin_layout Description
8810 \begin_inset Flex Code
8813 \begin_layout Plain Layout
8819 Defines formats for use in the display of bibliographic information.
8821 \begin_inset CommandInset ref
8823 reference "subsec:Citation-format-description"
8829 \begin_inset Quotes eld
8833 \begin_inset Flex Code
8836 \begin_layout Plain Layout
8843 \begin_inset Quotes erd
8849 \begin_layout Description
8850 \begin_inset Flex Code
8853 \begin_layout Plain Layout
8859 Describes various global options supported by the document class.
8861 \begin_inset CommandInset ref
8863 reference "subsec:ClassOptions"
8869 \begin_inset Quotes eld
8873 \begin_inset Flex Code
8876 \begin_layout Plain Layout
8883 \begin_inset Quotes erd
8889 \begin_layout Description
8890 \begin_inset Flex Code
8893 \begin_layout Plain Layout
8900 \begin_inset Flex Code
8903 \begin_layout Plain Layout
8912 \begin_inset space \thinspace{}
8916 \begin_inset Flex Code
8919 \begin_layout Plain Layout
8925 ] Whether the class should
8929 to having one or two columns.
8930 Can be changed in the
8931 \begin_inset Flex MenuItem
8934 \begin_layout Plain Layout
8935 Document\SpecialChar menuseparator
8944 \begin_layout Description
8945 \begin_inset Flex Code
8948 \begin_layout Plain Layout
8955 \begin_inset Flex Code
8958 \begin_layout Plain Layout
8964 ] This sequence defines the properties for a counter.
8965 If the counter does not yet exist, it is created; if it does exist, it
8968 \begin_inset Quotes eld
8972 \begin_inset Flex Code
8975 \begin_layout Plain Layout
8982 \begin_inset Quotes erd
8986 \begin_inset Newline newline
8990 \begin_inset CommandInset ref
8992 reference "subsec:Counters"
8996 for details on counters.
8999 \begin_layout Description
9000 \begin_inset Flex Code
9003 \begin_layout Plain Layout
9009 Sets the default font used to display the document.
9011 \begin_inset CommandInset ref
9013 reference "subsec:Font-description"
9017 for how to declare fonts.
9019 \begin_inset Quotes eld
9023 \begin_inset Flex Code
9026 \begin_layout Plain Layout
9033 \begin_inset Quotes erd
9039 \begin_layout Description
9040 \begin_inset Flex Code
9043 \begin_layout Plain Layout
9050 \begin_inset Flex Code
9053 \begin_layout Plain Layout
9059 ] Specifies a module to be included by default with this document class.
9060 The module is specified as filename without the
9061 \begin_inset Flex Code
9064 \begin_layout Plain Layout
9071 The user can still remove the module, but it will be active at the outset.
9072 (This applies only when new files are created, or when this class is chosen
9073 for an existing document.)
9076 \begin_layout Description
9077 \begin_inset Flex Code
9080 \begin_layout Plain Layout
9087 \begin_inset Flex Code
9090 \begin_layout Plain Layout
9096 ] This is the style that will be assigned to new paragraphs, usually
9097 \begin_inset Flex MenuItem
9100 \begin_layout Plain Layout
9107 This will default to the first defined style if not given, but you are
9108 encouraged to use this directive.
9111 \begin_layout Description
9112 \begin_inset Flex Code
9115 \begin_layout Plain Layout
9122 \begin_inset Flex Code
9125 \begin_layout Plain Layout
9131 ] This tag indicates that the module (which is specified by filename without
9133 \begin_inset Flex Code
9136 \begin_layout Plain Layout
9142 extension) cannot be used with this document class.
9143 This might be used in a journal-specific layout file to prevent, say, the
9145 \begin_inset Flex Code
9148 \begin_layout Plain Layout
9154 module that numbers theorems by section.
9159 be used in a module.
9160 Modules have their own way of excluding other modules (see
9161 \begin_inset CommandInset ref
9163 reference "subsec:Layout-modules"
9170 \begin_layout Description
9171 \begin_inset Flex Code
9174 \begin_layout Plain Layout
9180 Defines a new float.
9182 \begin_inset CommandInset ref
9184 reference "subsec:Floats"
9190 \begin_inset Quotes eld
9194 \begin_inset Flex Code
9197 \begin_layout Plain Layout
9204 \begin_inset Quotes erd
9210 \begin_layout Description
9211 \begin_inset Flex Code
9214 \begin_layout Plain Layout
9220 Sets the information that will be output in the
9221 \begin_inset Flex Code
9224 \begin_layout Plain Layout
9230 block when this document class is output to XHTML.
9231 Note that this will completely override any prior
9232 \begin_inset Flex Code
9235 \begin_layout Plain Layout
9242 \begin_inset Flex Code
9245 \begin_layout Plain Layout
9253 \begin_inset Newline newline
9257 \begin_inset Flex Code
9260 \begin_layout Plain Layout
9266 if you just want to add material to the preamble.) Must end with
9267 \begin_inset Quotes eld
9271 \begin_inset Flex Code
9274 \begin_layout Plain Layout
9281 \begin_inset Quotes erd
9287 \begin_layout Description
9288 \begin_inset Flex Code
9291 \begin_layout Plain Layout
9298 \begin_inset Flex Code
9301 \begin_layout Plain Layout
9307 ] The style to use for the table of contents, bibliography, and so forth,
9308 when the document is output to HTML.
9309 For articles, this should normally be
9310 \begin_inset Flex Code
9313 \begin_layout Plain Layout
9320 \begin_inset Flex Code
9323 \begin_layout Plain Layout
9330 If it is not given, then \SpecialChar LyX
9331 will attempt to figure out which layout to use.
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 ] Modifies the properties of the given counter.
9355 If the counter does not exist, the statement is ignored.
9357 \begin_inset Quotes eld
9361 \begin_inset Flex Code
9364 \begin_layout Plain Layout
9371 \begin_inset Quotes erd
9375 \begin_inset Newline newline
9379 \begin_inset CommandInset ref
9381 reference "subsec:Counters"
9385 for details on counters.
9388 \begin_layout Description
9389 \begin_inset Flex Code
9392 \begin_layout Plain Layout
9399 \begin_inset Flex Code
9402 \begin_layout Plain Layout
9408 ] Modifies the properties of the given paragraph style.
9409 If the style does not exist, the statement is ignored.
9411 \begin_inset Quotes eld
9415 \begin_inset Flex Code
9418 \begin_layout Plain Layout
9425 \begin_inset Quotes erd
9431 \begin_layout Description
9432 \begin_inset Flex Code
9435 \begin_layout Plain Layout
9442 \begin_inset Flex Code
9445 \begin_layout Plain Layout
9451 ] This allows you to include another layout definition file within yours
9452 to avoid duplicating commands.
9453 Common examples are the standard layout files, for example,
9454 \begin_inset Flex Code
9457 \begin_layout Plain Layout
9463 , which contains most of the basic layouts.
9466 \begin_layout Description
9467 \begin_inset Flex Code
9470 \begin_layout Plain Layout
9477 \begin_inset Flex Code
9480 \begin_layout Plain Layout
9486 ] This section (re-)defines the layout of an inset.
9487 It can be applied to an existing inset or to a new, user-defined inset,
9488 e.g., a new character style.
9490 \begin_inset Quotes eld
9494 \begin_inset Flex Code
9497 \begin_layout Plain Layout
9504 \begin_inset Quotes erd
9508 \begin_inset Newline newline
9512 \begin_inset CommandInset ref
9514 reference "subsec:Flex-insets-and"
9518 for more information.
9522 \begin_layout Description
9523 \begin_inset Flex Code
9526 \begin_layout Plain Layout
9533 \begin_inset Flex Code
9536 \begin_layout Plain Layout
9542 ] A string that indicates the width of the left margin on the screen, for
9544 \begin_inset Quotes eld
9548 \begin_inset Flex Code
9551 \begin_layout Plain Layout
9558 \begin_inset Quotes erd
9562 (Note that this is not a `length', like
9563 \begin_inset Quotes eld
9567 \begin_inset Quotes erd
9573 \begin_layout Description
9574 \begin_inset Flex Code
9577 \begin_layout Plain Layout
9584 \begin_inset Flex Code
9587 \begin_layout Plain Layout
9593 ] Deletes an existing counter, usually one defined in an included file.
9596 \begin_layout Description
9597 \begin_inset Flex Code
9600 \begin_layout Plain Layout
9607 \begin_inset Flex Code
9610 \begin_layout Plain Layout
9616 ] Deletes an existing float.
9617 This is particularly useful when you want to suppress a float that has
9618 been defined in an input file.
9621 \begin_layout Description
9622 \begin_inset Flex Code
9625 \begin_layout Plain Layout
9632 \begin_inset Flex Code
9635 \begin_layout Plain Layout
9641 ] Deletes an existing style.
9644 \begin_layout Description
9645 \begin_inset Flex Code
9648 \begin_layout Plain Layout
9655 \begin_inset Flex Code
9658 \begin_layout Plain Layout
9664 ] The file format (as defined in the \SpecialChar LyX
9665 preferences) produced by this document
9667 It is mainly useful when
9668 \begin_inset Flex Code
9671 \begin_layout Plain Layout
9678 \begin_inset Flex Code
9681 \begin_layout Plain Layout
9687 and one wants to define a new type of literate document.
9688 The format is reset to
9689 \begin_inset Quotes eld
9693 \begin_inset Flex Code
9696 \begin_layout Plain Layout
9703 \begin_inset Quotes erd
9707 \begin_inset Quotes eld
9711 \begin_inset Flex Code
9714 \begin_layout Plain Layout
9721 \begin_inset Quotes erd
9724 when the corresponding
9725 \begin_inset Flex Code
9728 \begin_layout Plain Layout
9734 parameter is encountered.
9737 \begin_layout Description
9738 \begin_inset Flex Code
9741 \begin_layout Plain Layout
9748 \begin_inset Flex Code
9751 \begin_layout Plain Layout
9762 \begin_inset Flex Code
9765 \begin_layout Plain Layout
9772 \begin_inset Flex Code
9775 \begin_layout Plain Layout
9781 ] Specifies what sort of output documents using this class will produce.
9784 \begin_layout Description
9785 \begin_inset Flex Code
9788 \begin_layout Plain Layout
9795 \begin_inset Flex Code
9798 \begin_layout Plain Layout
9805 \begin_inset Flex Code
9808 \begin_layout Plain Layout
9814 ] Specifies options, given in the second string, for the package named by
9817 \begin_inset Quotes eld
9821 \begin_inset Flex Code
9824 \begin_layout Plain Layout
9825 PackageOptions natbib square
9831 \begin_inset Quotes erd
9835 \begin_inset Flex Code
9838 \begin_layout Plain Layout
9844 to be loaded with the
9845 \begin_inset Flex Code
9848 \begin_layout Plain Layout
9855 (For \SpecialChar TeX
9856 perts, this causes \SpecialChar LyX
9858 \begin_inset Flex Code
9861 \begin_layout Plain Layout
9864 PassOptionsToPackage{natbib}{square}
9870 \begin_inset Flex Code
9873 \begin_layout Plain Layout
9882 \begin_layout Description
9883 \begin_inset Flex Code
9886 \begin_layout Plain Layout
9893 \begin_inset Flex Code
9896 \begin_layout Plain Layout
9905 \begin_inset Flex Code
9908 \begin_layout Plain Layout
9915 \begin_inset Flex Code
9918 \begin_layout Plain Layout
9924 ] The default pagestyle.
9925 Can be changed in the
9926 \begin_inset Flex MenuItem
9929 \begin_layout Plain Layout
9930 Document\SpecialChar menuseparator
9939 \begin_layout Description
9940 \begin_inset Flex Code
9943 \begin_layout Plain Layout
9949 Sets the preamble for the \SpecialChar LaTeX
9951 Note that this will completely override any prior
9952 \begin_inset Flex Code
9955 \begin_layout Plain Layout
9962 \begin_inset Flex Code
9965 \begin_layout Plain Layout
9973 \begin_inset Flex Code
9976 \begin_layout Plain Layout
9982 if you just want to add material to the preamble.) Must end with
9983 \begin_inset Quotes eld
9987 \begin_inset Flex Code
9990 \begin_layout Plain Layout
9997 \begin_inset Quotes erd
10003 \begin_layout Description
10004 \begin_inset Flex Code
10007 \begin_layout Plain Layout
10014 \begin_inset Flex Code
10017 \begin_layout Plain Layout
10024 \begin_inset Flex Code
10027 \begin_layout Plain Layout
10036 \begin_inset space \thinspace{}
10040 \begin_inset Flex Code
10043 \begin_layout Plain Layout
10049 ] Whether the class already provides the feature
10050 \begin_inset Flex Code
10053 \begin_layout Plain Layout
10060 A feature is in general the name of a package (e.
10061 \begin_inset space \thinspace{}
10065 \begin_inset space \space{}
10069 \begin_inset Flex Code
10072 \begin_layout Plain Layout
10079 \begin_inset Flex Code
10082 \begin_layout Plain Layout
10089 \begin_inset space \thinspace{}
10093 \begin_inset space \space{}
10097 \begin_inset Flex Code
10100 \begin_layout Plain Layout
10107 \begin_inset Flex Code
10110 \begin_layout Plain Layout
10118 \begin_inset CommandInset ref
10120 reference "chap:List-of-functions"
10124 for the list of features.
10127 \begin_layout Description
10128 \begin_inset Flex Code
10131 \begin_layout Plain Layout
10138 \begin_inset Flex Code
10141 \begin_layout Plain Layout
10147 ] Indicates that this layout provides the functionality of the module mentioned,
10148 which should be specified by the filename without the
10149 \begin_inset Flex Code
10152 \begin_layout Plain Layout
10159 This will typically be used if the layout includes the module directly,
10160 rather than using the
10161 \begin_inset Flex Code
10164 \begin_layout Plain Layout
10170 tag to indicate that it ought to be used.
10171 It could also be used in a module that provided an alternate implementation
10172 of the same functionality.
10175 \begin_layout Description
10176 \begin_inset Flex Code
10179 \begin_layout Plain Layout
10186 \begin_inset Flex Code
10189 \begin_layout Plain Layout
10195 ] Whether the class requires the feature
10196 \begin_inset Flex Code
10199 \begin_layout Plain Layout
10206 Multiple features must be separated by commas.
10207 Note that you can only request supported features.
10209 \begin_inset CommandInset ref
10211 reference "chap:List-of-functions"
10215 for the list of features.)
10218 \begin_layout Description
10219 \begin_inset Flex Code
10222 \begin_layout Plain Layout
10229 \begin_inset Flex Code
10232 \begin_layout Plain Layout
10238 ] A string that indicates the width of the right margin on the screen, for
10240 \begin_inset Quotes eld
10244 \begin_inset Flex Code
10247 \begin_layout Plain Layout
10254 \begin_inset Quotes erd
10260 \begin_layout Description
10261 \begin_inset Flex Code
10264 \begin_layout Plain Layout
10271 \begin_inset Flex Code
10274 \begin_layout Plain Layout
10280 ] Sets which divisions get numbered.
10282 \begin_inset Newline newline
10286 \begin_inset Flex Code
10289 \begin_layout Plain Layout
10295 counter in \SpecialChar LaTeX
10299 \begin_layout Description
10300 \begin_inset Flex Code
10303 \begin_layout Plain Layout
10310 \begin_inset Flex Code
10313 \begin_layout Plain Layout
10322 \begin_inset space \thinspace{}
10326 \begin_inset Flex Code
10329 \begin_layout Plain Layout
10335 ] Whether the class-default should be printing on one or both sides of the
10337 Can be changed in the
10338 \begin_inset Flex MenuItem
10341 \begin_layout Plain Layout
10342 Document\SpecialChar menuseparator
10351 \begin_layout Description
10352 \begin_inset Flex Code
10355 \begin_layout Plain Layout
10362 \begin_inset Flex Code
10365 \begin_layout Plain Layout
10371 ] This sequence defines a paragraph style.
10372 If the style does not yet exist, it is created; if it does exist, its parameter
10375 \begin_inset Quotes eld
10379 \begin_inset Flex Code
10382 \begin_layout Plain Layout
10389 \begin_inset Quotes erd
10393 \begin_inset Newline newline
10397 \begin_inset CommandInset ref
10399 reference "subsec:Paragraph-Styles"
10403 for details on paragraph styles.
10406 \begin_layout Description
10407 \begin_inset Flex Code
10410 \begin_layout Plain Layout
10417 \begin_inset Flex Code
10420 \begin_layout Plain Layout
10426 ] The name of the command or environment to be used with
10427 \begin_inset Flex Code
10430 \begin_layout Plain Layout
10439 \begin_layout Description
10440 \begin_inset Flex Code
10443 \begin_layout Plain Layout
10450 \begin_inset Flex Code
10453 \begin_layout Plain Layout
10462 \begin_inset Flex Code
10465 \begin_layout Plain Layout
10471 ] Indicates what kind of markup is used to define the title of a document.
10473 \begin_inset Flex Code
10476 \begin_layout Plain Layout
10482 means that the macro with name
10483 \begin_inset Flex Code
10486 \begin_layout Plain Layout
10492 will be inserted after the last layout which has
10493 \begin_inset Quotes eld
10497 \begin_inset Flex Code
10500 \begin_layout Plain Layout
10502 \begin_inset space ~
10511 \begin_inset Quotes erd
10516 \begin_inset Flex Code
10519 \begin_layout Plain Layout
10525 corresponds to the case where all layouts which have
10526 \begin_inset Quotes eld
10530 \begin_inset Flex Code
10533 \begin_layout Plain Layout
10535 \begin_inset space ~
10544 \begin_inset Quotes erd
10547 should be enclosed into the
10548 \begin_inset Flex Code
10551 \begin_layout Plain Layout
10560 \begin_layout Description
10561 \begin_inset Flex Code
10564 \begin_layout Plain Layout
10571 \begin_inset Flex Code
10574 \begin_layout Plain Layout
10580 ] Sets which divisions are included in the table of contents.
10582 \begin_inset Flex Code
10585 \begin_layout Plain Layout
10591 counter in \SpecialChar LaTeX
10595 \begin_layout Subsection
10596 \begin_inset Flex Code
10599 \begin_layout Plain Layout
10606 \begin_inset CommandInset label
10608 name "subsec:ClassOptions"
10615 \begin_layout Standard
10617 \begin_inset Flex Code
10620 \begin_layout Plain Layout
10626 section can contain the following entries:
10629 \begin_layout Description
10630 \begin_inset Flex Code
10633 \begin_layout Plain Layout
10640 \begin_inset Flex Code
10643 \begin_layout Plain Layout
10649 ] The list of available font sizes for the document's main font, separated
10651 \begin_inset Quotes eld
10655 \begin_inset Flex Code
10658 \begin_layout Plain Layout
10665 \begin_inset Quotes erd
10671 \begin_layout Description
10672 \begin_inset Flex Code
10675 \begin_layout Plain Layout
10681 Used to set the DTD line with XML-based output classes.
10683 \begin_inset space \thinspace{}
10687 \begin_inset Quotes eld
10690 -//OASIS//DTD DocBook V4.2//EN
10691 \begin_inset Quotes erd
10697 \begin_layout Description
10698 \begin_inset Flex Code
10701 \begin_layout Plain Layout
10708 \begin_inset Flex Code
10711 \begin_layout Plain Layout
10712 string="empty|plain|headings|fancy"
10717 ] The list of available page sty\SpecialChar softhyphen
10719 \begin_inset Quotes eld
10723 \begin_inset Flex Code
10726 \begin_layout Plain Layout
10733 \begin_inset Quotes erd
10739 \begin_layout Description
10740 \begin_inset Flex Code
10743 \begin_layout Plain Layout
10750 \begin_inset Flex Code
10753 \begin_layout Plain Layout
10759 ] Some document class options, separated by a comma, that will be added
10760 to the optional part of the
10761 \begin_inset Flex Code
10764 \begin_layout Plain Layout
10775 \begin_layout Standard
10777 \begin_inset Flex Code
10780 \begin_layout Plain Layout
10786 section must end with
10787 \begin_inset Quotes eld
10791 \begin_inset Flex Code
10794 \begin_layout Plain Layout
10801 \begin_inset Quotes erd
10807 \begin_layout Subsection
10809 \begin_inset CommandInset label
10811 name "subsec:Paragraph-Styles"
10818 \begin_layout Standard
10819 A paragraph style description looks like this:
10823 \begin_layout Plain Layout
10824 Note that this will either define a new style or modify an existing one.
10832 \begin_layout LyX-Code
10839 \begin_layout LyX-Code
10843 \begin_layout LyX-Code
10847 \begin_layout Standard
10848 where the following commands are allowed:
10851 \begin_layout Description
10852 \begin_inset Flex Code
10855 \begin_layout Plain Layout
10862 \begin_inset Flex Code
10865 \begin_layout Plain Layout
10870 , left, right, center
10875 ] Paragraph alignment.
10878 \begin_layout Description
10879 \begin_inset Flex Code
10882 \begin_layout Plain Layout
10889 \begin_inset Flex Code
10892 \begin_layout Plain Layout
10897 , left, right, center
10902 ] A comma separated list of permitted alignments.
10903 (Some \SpecialChar LaTeX
10904 styles prohibit certain alignments, since those wouldn't make sense.
10905 For example a right-aligned or centered enumeration isn't possible.)
10908 \begin_layout Description
10909 \begin_inset Flex Code
10912 \begin_layout Plain Layout
10919 \begin_inset Flex Code
10922 \begin_layout Plain Layout
10928 ] Defines argument number <int> of a command\SpecialChar breakableslash
10929 environment associated with
10931 This is useful for things like section headings, and only makes sense with
10934 Every (optional or required) argument of a command or environment – except
10935 for the required argument that is associated with the content of the paragraph
10936 itself – has a separate definition, where the number specifies the order
10938 The definition must end with
10939 \begin_inset Flex Code
10942 \begin_layout Plain Layout
10949 So a command with two optional arguments has:
10950 \begin_inset Separator parbreak
10957 \begin_layout Quote
10963 \begin_layout Quote
10969 \begin_layout Quote
10975 \begin_layout Quote
10981 \begin_layout Quote
10987 \begin_layout Quote
10993 \begin_layout Standard
10995 \begin_inset Flex Code
10998 \begin_layout Plain Layout
11004 definition, the following specifications are possible:
11007 \begin_layout Itemize
11008 \begin_inset Flex Code
11011 \begin_layout Plain Layout
11018 \begin_inset Flex Code
11021 \begin_layout Plain Layout
11027 The string that will appear both in the menu (to insert this argument)
11028 and on the argument inset button (unless you also specify a separate
11029 \begin_inset Flex Code
11032 \begin_layout Plain Layout
11039 For the menu, you can define an accelerator by appending the respective
11040 character to the string, divided by
11041 \begin_inset Quotes eld
11045 \begin_inset Quotes erd
11049 \begin_inset space \thinspace{}
11053 \begin_inset space \space{}
11057 \begin_inset Quotes eld
11061 \begin_inset Flex Code
11064 \begin_layout Plain Layout
11071 \begin_inset Quotes erd
11077 \begin_layout Itemize
11078 \begin_inset Flex Code
11081 \begin_layout Plain Layout
11088 \begin_inset Flex Code
11091 \begin_layout Plain Layout
11097 A separate string for the menu.
11098 You can define an accelerator by appending the respective character to
11099 the string, divided by
11100 \begin_inset Quotes eld
11104 \begin_inset Quotes erd
11108 \begin_inset space \thinspace{}
11112 \begin_inset space \space{}
11116 \begin_inset Quotes eld
11120 \begin_inset Flex Code
11123 \begin_layout Plain Layout
11130 \begin_inset Quotes erd
11134 This specification is optional.
11135 If it is not given the
11136 \begin_inset Flex Code
11139 \begin_layout Plain Layout
11145 will be used instead for the menu.
11148 \begin_layout Itemize
11149 \begin_inset Flex Code
11152 \begin_layout Plain Layout
11159 \begin_inset Flex Code
11162 \begin_layout Plain Layout
11168 A longer explanatory text that appears in the tooltip when hovering over
11169 the argument inset.
11172 \begin_layout Itemize
11173 \begin_inset Flex Code
11176 \begin_layout Plain Layout
11183 \begin_inset Flex Code
11186 \begin_layout Plain Layout
11195 \begin_inset space \thinspace{}
11199 \begin_inset Flex Code
11202 \begin_layout Plain Layout
11208 ] Declare if this is a mandatory (1) or an optional (0) argument.
11209 Mandatory arguments will be output empty if not given, while optional arguments
11210 will not be output at all.
11211 By default, mandatory arguments are delimited by
11212 \begin_inset Flex Code
11215 \begin_layout Plain Layout
11221 , while optional arguments are delimited by
11222 \begin_inset Flex Code
11225 \begin_layout Plain Layout
11234 \begin_layout Itemize
11235 \begin_inset Flex Code
11238 \begin_layout Plain Layout
11245 \begin_inset Flex Code
11248 \begin_layout Plain Layout
11254 defines another argument (by its number) which this argument requires to
11255 be output if it is itself output.
11257 \begin_inset space \thinspace{}
11260 g., in \SpecialChar LaTeX
11261 commands, optional arguments often require previous optional arguments
11262 to be output (at least empty), as in
11263 \begin_inset Flex Code
11266 \begin_layout Plain Layout
11269 command[][argument]{text}
11275 This can be achieved by the statement
11276 \begin_inset Flex Code
11279 \begin_layout Plain Layout
11286 \begin_inset Flex Code
11289 \begin_layout Plain Layout
11298 \begin_layout Itemize
11299 \begin_inset Flex Code
11302 \begin_layout Plain Layout
11309 \begin_inset Flex Code
11312 \begin_layout Plain Layout
11318 defines a custom left delimiter (instead of
11319 \begin_inset Flex Code
11322 \begin_layout Plain Layout
11329 \begin_inset Flex Code
11332 \begin_layout Plain Layout
11339 A line break in the output can be indicated by
11340 \begin_inset Flex Code
11343 \begin_layout Plain Layout
11352 \begin_layout Itemize
11353 \begin_inset Flex Code
11356 \begin_layout Plain Layout
11363 \begin_inset Flex Code
11366 \begin_layout Plain Layout
11372 defines a custom right delimiter (instead of
11373 \begin_inset Flex Code
11376 \begin_layout Plain Layout
11383 \begin_inset Flex Code
11386 \begin_layout Plain Layout
11393 A line break in the output can be indicated by
11394 \begin_inset Flex Code
11397 \begin_layout Plain Layout
11406 \begin_layout Itemize
11407 \begin_inset Flex Code
11410 \begin_layout Plain Layout
11417 \begin_inset Flex Code
11420 \begin_layout Plain Layout
11426 defines an argument that is inserted if and only if no user-specified arguments
11428 \begin_inset space \thinspace{}
11432 \begin_inset space \space{}
11435 if no argument inset has been inserted (note that also an empty argument
11436 inset omits the DefaultArg).
11437 Multiple arguments need to be separated by comma.
11440 \begin_layout Itemize
11441 \begin_inset Flex Code
11444 \begin_layout Plain Layout
11451 \begin_inset Flex Code
11454 \begin_layout Plain Layout
11460 defines an argument that is inserted in any case (alone or in addition
11461 to user-specified arguments).
11462 Multiple arguments need to be separated by comma.
11465 \begin_layout Itemize
11466 \begin_inset Flex Code
11469 \begin_layout Plain Layout
11475 The font used for the argument content, see
11476 \begin_inset CommandInset ref
11478 reference "subsec:Font-description"
11485 \begin_layout Itemize
11486 \begin_inset Flex Code
11489 \begin_layout Plain Layout
11495 The font used for the label; see
11496 \begin_inset CommandInset ref
11498 reference "subsec:Font-description"
11505 \begin_layout Itemize
11506 \begin_inset Flex Code
11509 \begin_layout Plain Layout
11516 \begin_inset Flex Code
11519 \begin_layout Plain Layout
11524 , Minimalistic, Conglomerate
11529 ] describes the rendering style used for the inset's frame and buttons.
11532 \begin_layout Itemize
11533 \begin_inset Flex Code
11536 \begin_layout Plain Layout
11543 \begin_inset Flex Code
11546 \begin_layout Plain Layout
11553 \begin_inset Flex Code
11556 \begin_layout Plain Layout
11562 , this argument is automatically inserted when the respective style is selected.
11563 Currently, only one argument per style\SpecialChar breakableslash
11564 layout can be automatically inserted.
11565 \change_inserted -712698321 1431166542
11569 \begin_layout Itemize
11571 \change_inserted -712698321 1431166604
11572 \begin_inset Flex Code
11575 \begin_layout Plain Layout
11577 \change_inserted -712698321 1431166548
11584 \begin_inset Flex Code
11587 \begin_layout Plain Layout
11589 \change_inserted -712698321 1431166543
11596 \begin_inset Flex Code
11599 \begin_layout Plain Layout
11601 \change_inserted -712698321 1431166543
11607 , this argument will bei inserted with a copy of the co-text (either selected
11608 text or the whole paragraph) as content.
11611 \begin_layout Itemize
11613 \change_inserted -712698321 1431070588
11614 \begin_inset Flex Code
11617 \begin_layout Plain Layout
11619 \change_inserted -712698321 1431070522
11626 \begin_inset Flex Code
11629 \begin_layout Plain Layout
11631 \change_inserted -712698321 1431070522
11632 string of characters
11641 Defines individual characters that should be output in raw form, meaning
11642 without special translations that \SpecialChar LaTeX
11644 Note that, contrary to PassThru, this needs to be explicitly defined for
11646 That is, arguments do not inherit PassThruChars from their parent inset
11652 \begin_layout Standard
11653 By default, the text entered in the \SpecialChar LyX
11654 workarea in the respective layout is
11655 the last (mandatory) argument of a command if the
11656 \begin_inset Flex Code
11659 \begin_layout Plain Layout
11666 \begin_inset Flex Code
11669 \begin_layout Plain Layout
11676 However, arguments with the prefix
11677 \begin_inset Flex Code
11680 \begin_layout Plain Layout
11686 are output after this workarea argument.
11687 Note that post-argument numbering restarts at 1, so the first argument
11688 following the workarea argument is
11689 \begin_inset Flex Code
11692 \begin_layout Plain Layout
11699 Post-arguments are ignored in any other
11700 \begin_inset Flex Code
11703 \begin_layout Plain Layout
11710 \begin_inset Flex Code
11713 \begin_layout Plain Layout
11722 \begin_layout Standard
11724 \begin_inset Flex Code
11727 \begin_layout Plain Layout
11736 \begin_inset Flex Code
11739 \begin_layout Plain Layout
11748 \begin_inset Flex Code
11751 \begin_layout Plain Layout
11757 followed by the number (e.
11758 \begin_inset space \thinspace{}
11762 \begin_inset space \space{}
11766 \begin_inset Flex Code
11769 \begin_layout Plain Layout
11779 \begin_layout Description
11780 \begin_inset Flex Code
11783 \begin_layout Plain Layout
11789 Note that this will completely override any prior
11790 \begin_inset Flex Code
11793 \begin_layout Plain Layout
11799 declaration for this style.
11801 \begin_inset Quotes eld
11805 \begin_inset Flex Code
11808 \begin_layout Plain Layout
11815 \begin_inset Quotes erd
11820 \begin_inset CommandInset ref
11822 reference "subsec:I18n"
11826 for details on its use.
11829 \begin_layout Description
11830 \begin_inset Flex Code
11833 \begin_layout Plain Layout
11840 \begin_inset Flex Code
11843 \begin_layout Plain Layout
11853 \begin_layout Plain Layout
11854 Note that a `float' here is a real number, such as: 1.5.
11859 The vertical space with which the last of a chain of paragraphs with this
11860 style is separated from the following paragraph.
11861 If the next paragraph has another style, the separations are not simply
11862 added, but the maximum is taken.
11865 \begin_layout Description
11866 \begin_inset Flex Code
11869 \begin_layout Plain Layout
11876 \begin_inset Flex Code
11879 \begin_layout Plain Layout
11885 ] The category for this style.
11886 This is used to group related styles in the style combobox on the toolbar.
11887 Any string can be used, but you may want to use existing categories with
11892 \begin_layout Description
11893 \begin_inset Flex Code
11896 \begin_layout Plain Layout
11902 Depth of XML command.
11903 Used only with XML-type formats.
11906 \begin_layout Description
11907 \begin_inset Flex Code
11910 \begin_layout Plain Layout
11917 \begin_inset Flex Code
11920 \begin_layout Plain Layout
11926 ] Copies all the features of an existing style into the current one.
11930 \begin_layout Description
11931 \begin_inset Flex Code
11934 \begin_layout Plain Layout
11941 \begin_inset Flex Code
11944 \begin_layout Plain Layout
11950 ] The name of a style whose preamble should be output
11955 This allows to ensure some ordering of the preamble snippets when macros
11956 definitions depend on one another.
11960 \begin_layout Plain Layout
11961 Note that, besides that functionality, there is no way to ensure any ordering
11963 The ordering that you see in a given version of \SpecialChar LyX
11964 may change without warning
11973 \begin_layout Description
11974 \begin_inset Flex Code
11977 \begin_layout Plain Layout
11984 \begin_inset Flex Code
11987 \begin_layout Plain Layout
11992 , Box, Filled_Box, Static
11997 ] The type of label that stands at the end of the paragraph (or sequence
11999 \begin_inset Flex Code
12002 \begin_layout Plain Layout
12009 \begin_inset Newline newline
12013 \begin_inset Flex Code
12016 \begin_layout Plain Layout
12023 \begin_inset Flex Code
12026 \begin_layout Plain Layout
12033 \begin_inset Flex Code
12036 \begin_layout Plain Layout
12044 \begin_inset Flex Code
12047 \begin_layout Plain Layout
12054 \begin_inset Quotes eld
12058 \begin_inset Quotes erd
12062 \begin_inset Flex Code
12065 \begin_layout Plain Layout
12072 \begin_inset space \space{}
12076 \begin_inset Flex Code
12079 \begin_layout Plain Layout
12085 ) is a white (resp.
12086 \begin_inset space ~
12089 black) square suitable for end of proof markers,
12090 \begin_inset Flex Code
12093 \begin_layout Plain Layout
12099 is an explicit text string.
12102 \begin_layout Description
12103 \begin_inset Flex Code
12106 \begin_layout Plain Layout
12113 \begin_inset Flex Code
12116 \begin_layout Plain Layout
12122 ] The string used for a label with a
12123 \begin_inset Flex Code
12126 \begin_layout Plain Layout
12133 \begin_inset Newline newline
12137 \begin_inset Flex Code
12140 \begin_layout Plain Layout
12150 \begin_layout Description
12151 \begin_inset Flex Code
12154 \begin_layout Plain Layout
12160 The font used for both the text body
12166 \begin_inset CommandInset ref
12168 reference "subsec:Font-description"
12173 Note that defining this font automatically defines the
12174 \begin_inset Flex Code
12177 \begin_layout Plain Layout
12184 So you should define this one first if you also want to define
12185 \begin_inset Flex Code
12188 \begin_layout Plain Layout
12197 \begin_layout Description
12198 \begin_inset Flex Code
12201 \begin_layout Plain Layout
12208 \begin_inset Flex Code
12211 \begin_layout Plain Layout
12217 ] Used for backporting new styles to stable \SpecialChar LyX
12219 The first stable version that supports this tag is \SpecialChar LyX
12221 The argument is a number which may either be 0, -1 or any value greater
12224 \begin_inset Flex Code
12227 \begin_layout Plain Layout
12233 flag of a style is greater than zero, it will always be written to the
12235 If a .lyx file is read, the style definitions from the document header are
12236 added to the document class.
12237 Therefore even older \SpecialChar LyX
12238 versions can handle the style.
12240 \begin_inset Flex Code
12243 \begin_layout Plain Layout
12249 is a version number: If the style is read, and the version number is less
12250 than the version number of the already existing style in the document class,
12251 the new style is ignored.
12252 If the version number is greater, the new style replaces the existing style.
12253 A value of -1 means an infinite version number, i.
12254 \begin_inset space \thinspace{}
12258 \begin_inset space \space{}
12261 the style is always used.
12264 \begin_layout Description
12265 \begin_inset Flex Code
12268 \begin_layout Plain Layout
12275 \begin_inset Flex Code
12278 \begin_layout Plain Layout
12287 \begin_inset space \thinspace{}
12291 \begin_inset Flex Code
12294 \begin_layout Plain Layout
12300 ] Usually \SpecialChar LyX
12301 does not allow you to insert more than one space between words,
12302 since a space is considered as the separation between two words, not a
12303 character or symbol of its own.
12304 This is a very fine thing but sometimes annoying, for example, when typing
12305 program code or plain \SpecialChar LaTeX
12308 \begin_inset Flex Code
12311 \begin_layout Plain Layout
12318 Note that \SpecialChar LyX
12319 will create protected blanks for the additional blanks when
12320 in another mode than \SpecialChar LaTeX
12324 \begin_layout Description
12325 \begin_inset Flex Code
12328 \begin_layout Plain Layout
12334 These tags are used with XHTML output.
12336 \begin_inset CommandInset ref
12338 reference "subsec:Paragraph-Style-XHTML"
12345 \begin_layout Description
12346 \begin_inset Flex Code
12349 \begin_layout Plain Layout
12355 [FIXME] (Used only with XML-type formats.)
12358 \begin_layout Description
12359 \begin_inset Flex Code
12362 \begin_layout Plain Layout
12369 \begin_inset Flex Code
12372 \begin_layout Plain Layout
12381 \begin_inset space \thinspace{}
12385 \begin_inset Flex Code
12388 \begin_layout Plain Layout
12395 \begin_inset Flex Code
12398 \begin_layout Plain Layout
12404 , marks the style as to be included in the document preamble and not in
12406 This is useful for document classes that want such information as the title
12407 and author to appear in the preamble.
12408 Note that this works only for styles for which the
12409 \begin_inset Flex Code
12412 \begin_layout Plain Layout
12419 \begin_inset Flex Code
12422 \begin_layout Plain Layout
12429 \begin_inset Flex Code
12432 \begin_layout Plain Layout
12441 \begin_layout Description
12442 \begin_inset Flex Code
12445 \begin_layout Plain Layout
12452 \begin_inset Flex Code
12455 \begin_layout Plain Layout
12464 \begin_inset space \thinspace{}
12468 \begin_inset Flex Code
12471 \begin_layout Plain Layout
12478 \begin_inset Flex Code
12481 \begin_layout Plain Layout
12487 , marks the style as being part of a title block (see also the
12488 \begin_inset Flex Code
12491 \begin_layout Plain Layout
12498 \begin_inset Flex Code
12501 \begin_layout Plain Layout
12510 \begin_layout Description
12511 \begin_inset Flex Code
12514 \begin_layout Plain Layout
12521 \begin_inset Flex Code
12524 \begin_layout Plain Layout
12530 ] The \SpecialChar LaTeX
12531 command sequence declaring an item in a list.
12532 The command is to be defined without the preceding backslash (the default
12534 \begin_inset Quotes eld
12538 \begin_inset Quotes erd
12542 \begin_inset Flex Code
12545 \begin_layout Plain Layout
12553 in the \SpecialChar LaTeX
12557 \begin_layout Description
12558 \begin_inset Flex Code
12561 \begin_layout Plain Layout
12568 \begin_inset Flex Code
12571 \begin_layout Plain Layout
12577 ] This provides extra space between paragraphs that have the same style.
12578 If you put other styles into an environment, each is separated with the
12580 \begin_inset Flex Code
12583 \begin_layout Plain Layout
12590 But the whole items of the environment are additionally separated with
12592 \begin_inset Flex Code
12595 \begin_layout Plain Layout
12602 Note that this is a
12607 \begin_layout Description
12608 \begin_inset Flex Code
12611 \begin_layout Plain Layout
12617 [FIXME] (Used only with XML-type formats.)
12620 \begin_layout Description
12621 \begin_inset Flex Code
12624 \begin_layout Plain Layout
12631 \begin_inset Flex Code
12634 \begin_layout Plain Layout
12643 \begin_inset space \thinspace{}
12647 \begin_inset Flex Code
12650 \begin_layout Plain Layout
12656 ] Usually \SpecialChar LyX
12657 does not allow you to leave a paragraph empty, since it would
12658 lead to empty \SpecialChar LaTeX
12660 There are some cases where this could be desirable however: in a letter
12661 template, the required fields can be provided as empty fields, so that
12662 people do not forget them; in some special classes, a style can be used
12663 as some kind of break, which does not contain actual text.
12666 \begin_layout Description
12667 \begin_inset Flex Code
12670 \begin_layout Plain Layout
12677 \begin_inset Flex Code
12680 \begin_layout Plain Layout
12686 ] The vertical space between the label and the text body.
12687 Only used for labels that are above the text body (
12688 \begin_inset Flex Code
12691 \begin_layout Plain Layout
12698 \begin_inset Newline newline
12702 \begin_inset Flex Code
12705 \begin_layout Plain Layout
12706 Centered_Top_Environment
12714 \begin_layout Description
12715 \begin_inset Flex Code
12718 \begin_layout Plain Layout
12725 \begin_inset Flex Code
12728 \begin_layout Plain Layout
12734 ] The name of the counter for automatic numbering.
12735 In order to have the counter appear with your label, you will need to reference
12737 \begin_inset Flex Code
12740 \begin_layout Plain Layout
12749 This will work with
12750 \begin_inset Flex Code
12753 \begin_layout Plain Layout
12760 \begin_inset Flex Code
12763 \begin_layout Plain Layout
12770 \begin_inset Flex Code
12773 \begin_layout Plain Layout
12780 \begin_inset Flex Code
12783 \begin_layout Plain Layout
12790 \begin_inset Newline newline
12798 \begin_inset Flex Code
12801 \begin_layout Plain Layout
12808 \begin_inset Flex Code
12811 \begin_layout Plain Layout
12817 , though this case is a bit complicated.
12818 Suppose you declare
12819 \begin_inset Quotes eld
12823 \begin_inset Flex Code
12826 \begin_layout Plain Layout
12827 LabelCounter myenum
12833 \begin_inset Quotes erd
12837 Then the actual counters used are
12838 \begin_inset Flex Code
12841 \begin_layout Plain Layout
12848 \begin_inset Flex Code
12851 \begin_layout Plain Layout
12858 \begin_inset Flex Code
12861 \begin_layout Plain Layout
12868 \begin_inset Flex Code
12871 \begin_layout Plain Layout
12877 , much as in \SpecialChar LaTeX
12879 These counters must all be declared separately.
12880 \begin_inset Newline newline
12884 \begin_inset CommandInset ref
12886 reference "subsec:Counters"
12890 for details on counters.
12893 \begin_layout Description
12894 \begin_inset Flex Code
12897 \begin_layout Plain Layout
12903 The font used for the label.
12905 \begin_inset CommandInset ref
12907 reference "subsec:Font-description"
12914 \begin_layout Description
12915 \begin_inset Flex Code
12918 \begin_layout Plain Layout
12925 \begin_inset Flex Code
12928 \begin_layout Plain Layout
12934 ] Text that indicates how far a label should be indented.
12937 \begin_layout Description
12938 \begin_inset Flex Code
12941 \begin_layout Plain Layout
12948 \begin_inset Flex Code
12951 \begin_layout Plain Layout
12957 ] Text that indicates the amount of horizontal space between the label and
12959 Only used for labels that are not above the text body.
12962 \begin_layout Description
12963 \begin_inset Flex Code
12966 \begin_layout Plain Layout
12973 \begin_inset Flex Code
12976 \begin_layout Plain Layout
12982 ] The string used for the label.
12984 \begin_inset Flex Code
12987 \begin_layout Plain Layout
12993 is set, this string can be contain the special formatting commands described
12995 \begin_inset CommandInset ref
12997 reference "subsec:Counters"
13004 \begin_layout Description
13005 \begin_inset Flex Code
13008 \begin_layout Plain Layout
13009 LabelStringAppendix
13015 \begin_inset Flex Code
13018 \begin_layout Plain Layout
13024 ] This is used inside the appendix instead of
13025 \begin_inset Newline newline
13029 \begin_inset Flex Code
13032 \begin_layout Plain Layout
13040 \begin_inset Flex Code
13043 \begin_layout Plain Layout
13050 \begin_inset Newline newline
13054 \begin_inset Flex Code
13057 \begin_layout Plain Layout
13058 LabelStringAppendix
13066 \begin_layout Description
13067 \begin_inset Flex Code
13070 \begin_layout Plain Layout
13076 [FIXME] (Used only with XML-type formats.)
13079 \begin_layout Description
13080 \begin_inset Flex Code
13083 \begin_layout Plain Layout
13090 \begin_inset Flex Code
13093 \begin_layout Plain Layout
13098 , Manual, Static, Above,
13099 \begin_inset Newline newline
13102 Centered, Sensitive, Enumerate,
13103 \begin_inset Newline newline
13106 Itemize, Bibliography
13112 \begin_inset Separator parbreak
13119 \begin_layout Description
13120 \begin_inset Flex Code
13123 \begin_layout Plain Layout
13129 means the label is the very first word (up to the first real blank).
13130 Use protected spaces if you want more than one word as the label.
13134 \begin_layout Description
13135 \begin_inset Flex Code
13138 \begin_layout Plain Layout
13144 means the label is simply what is declared as
13145 \begin_inset Flex Code
13148 \begin_layout Plain Layout
13155 This will be displayed
13156 \begin_inset Quotes eld
13160 \begin_inset Quotes erd
13163 , at the beginning of the paragraph.
13165 \begin_inset Flex Code
13168 \begin_layout Plain Layout
13175 \begin_inset Flex Code
13178 \begin_layout Plain Layout
13184 , then it will be displayed only in the first paragraph of any sequence
13185 of paragraphs with the same
13186 \begin_inset Flex Code
13189 \begin_layout Plain Layout
13198 \begin_layout Description
13199 \begin_inset Flex Code
13202 \begin_layout Plain Layout
13209 \begin_inset space ~
13213 \begin_inset space ~
13217 \begin_inset Flex Code
13220 \begin_layout Plain Layout
13226 are special cases of
13227 \begin_inset Flex Code
13230 \begin_layout Plain Layout
13237 The label will be printed above the paragraph either at the beginning of
13238 the line or centered.
13241 \begin_layout Description
13242 \begin_inset Flex Code
13245 \begin_layout Plain Layout
13251 is a special case for the caption-labels
13252 \begin_inset Quotes eld
13256 \begin_inset Quotes erd
13260 \begin_inset Quotes eld
13264 \begin_inset Quotes erd
13268 \begin_inset Newline newline
13272 \begin_inset Flex Code
13275 \begin_layout Plain Layout
13281 means the (hardcoded) label string depends on the kind of float: It is
13282 hardcoded to be `FloatType N', where N is the value of the counter associated
13284 For the case that a caption is inserted outside of a float the
13285 \begin_inset Flex Code
13288 \begin_layout Plain Layout
13295 \begin_inset Quotes eld
13299 \begin_inset Quotes erd
13305 \begin_layout Description
13306 \begin_inset Flex Code
13309 \begin_layout Plain Layout
13315 produces the usual sort of enumeration labels.
13316 At present, it is hardcoded to use Arabic numerals, lowercase letters,
13317 small Roman numerals, and uppercase letters for the four possible depths.
13320 \begin_layout Description
13321 \begin_inset Flex Code
13324 \begin_layout Plain Layout
13330 produces various bullets at the different levels.
13331 It is also hardcoded.
13334 \begin_layout Description
13335 \begin_inset Flex Code
13338 \begin_layout Plain Layout
13344 should be used only with
13345 \begin_inset Flex Code
13348 \begin_layout Plain Layout
13349 LatexType BibEnvironment
13358 \begin_layout Description
13359 \begin_inset Flex Code
13362 \begin_layout Plain Layout
13368 Note that this will completely override any prior
13369 \begin_inset Flex Code
13372 \begin_layout Plain Layout
13378 declaration for this style.
13380 \begin_inset Quotes eld
13384 \begin_inset Flex Code
13387 \begin_layout Plain Layout
13394 \begin_inset Quotes erd
13399 \begin_inset CommandInset ref
13401 reference "subsec:I18n"
13405 for details on its use.
13408 \begin_layout Description
13409 \begin_inset Flex Code
13412 \begin_layout Plain Layout
13419 \begin_inset Flex Code
13422 \begin_layout Plain Layout
13428 ] The name of the corresponding \SpecialChar LaTeX
13430 Either the environment or command name.
13433 \begin_layout Description
13434 \begin_inset Flex Code
13437 \begin_layout Plain Layout
13444 \begin_inset Flex Code
13447 \begin_layout Plain Layout
13453 ] An optional parameter for the corresponding
13454 \begin_inset Flex Code
13457 \begin_layout Plain Layout
13464 This parameter cannot be changed from within \SpecialChar LyX
13466 \begin_inset Flex Code
13469 \begin_layout Plain Layout
13475 for customizable parameters).
13476 This will be output as is after all \SpecialChar LaTeX
13478 \begin_inset Flex Code
13481 \begin_layout Plain Layout
13490 \begin_layout Description
13491 \begin_inset Flex Code
13494 \begin_layout Plain Layout
13501 \begin_inset Flex Code
13504 \begin_layout Plain Layout
13509 , Command, Environment, Item_Environment,
13510 \begin_inset Newline newline
13513 List_Environment, Bib_Environment
13518 ] How the style should be translated into \SpecialChar LaTeX
13523 \begin_layout Plain Layout
13524 \begin_inset Flex Code
13527 \begin_layout Plain Layout
13533 is perhaps a bit misleading, since these rules apply to SGML classes, too.
13534 Visit the SGML class files for specific examples.
13540 \begin_inset Separator parbreak
13547 \begin_layout Description
13548 \begin_inset Flex Code
13551 \begin_layout Plain Layout
13557 means nothing special.
13560 \begin_layout Description
13561 \begin_inset Flex Code
13564 \begin_layout Plain Layout
13571 \begin_inset Flex Code
13574 \begin_layout Plain Layout
13581 {\SpecialChar ldots
13590 \begin_layout Description
13591 \begin_inset Flex Code
13594 \begin_layout Plain Layout
13601 \begin_inset Flex Code
13604 \begin_layout Plain Layout
13611 }\SpecialChar ldots
13627 \begin_layout Description
13628 \begin_inset Flex Code
13631 \begin_layout Plain Layout
13638 \begin_inset Flex Code
13641 \begin_layout Plain Layout
13648 \begin_inset Flex Code
13651 \begin_layout Plain Layout
13659 is generated for each paragraph of this environment.
13663 \begin_layout Description
13664 \begin_inset Flex Code
13667 \begin_layout Plain Layout
13674 \begin_inset Flex Code
13677 \begin_layout Plain Layout
13684 \begin_inset Newline newline
13688 \begin_inset Flex Code
13691 \begin_layout Plain Layout
13697 is passed as an argument to the environment.
13698 \begin_inset Newline newline
13702 \begin_inset Flex Code
13705 \begin_layout Plain Layout
13711 can be defined in the
13712 \begin_inset Flex MenuItem
13715 \begin_layout Plain Layout
13716 Edit\SpecialChar menuseparator
13718 \begin_inset space ~
13729 \begin_layout Description
13730 \begin_inset Flex Code
13733 \begin_layout Plain Layout
13740 \begin_inset Flex Code
13743 \begin_layout Plain Layout
13749 but adds additionally the necessary mandatory argument (the longest label)
13750 to the begin statement of the bibliography environment:
13751 \begin_inset Newline newline
13755 \begin_inset Flex Code
13758 \begin_layout Plain Layout
13761 begin{thebibliography}{99}
13766 It is therefore only useful for bibliography environments.
13767 The default longest label
13768 \begin_inset Quotes eld
13772 \begin_inset Quotes erd
13775 can be changed by the user in the paragraph settings of a bibliography
13779 \begin_layout Standard
13780 Putting the last few things together, the \SpecialChar LaTeX
13781 output will be either:
13784 \begin_layout LyX-Code
13787 LatexName[LatexParam]{\SpecialChar ldots
13791 \begin_layout Standard
13795 \begin_layout LyX-Code
13798 begin{LatexName}[LatexParam] \SpecialChar ldots
13804 \begin_layout Standard
13805 depending upon the \SpecialChar LaTeX
13810 \begin_layout Description
13811 \begin_inset Flex Code
13814 \begin_layout Plain Layout
13821 \begin_inset Flex Code
13824 \begin_layout Plain Layout
13830 ] A string that is put at the beginning of the style content.
13831 A line break in the output can be indicated by
13832 \begin_inset Flex Code
13835 \begin_layout Plain Layout
13844 \begin_layout Description
13845 \begin_inset Flex Code
13848 \begin_layout Plain Layout
13855 \begin_inset Flex Code
13858 \begin_layout Plain Layout
13864 ] If you put styles into environments, the different
13865 \begin_inset Flex Code
13868 \begin_layout Plain Layout
13874 are not simply added, but added with a factor
13875 \begin_inset Formula $\frac{4}{\mathrm{depth}+4}$
13879 Note that this parameter is also used when
13880 \begin_inset Flex Code
13883 \begin_layout Plain Layout
13890 \begin_inset Flex Code
13893 \begin_layout Plain Layout
13900 \begin_inset Flex Code
13903 \begin_layout Plain Layout
13910 Then it is added to the manual or dynamic margin.
13911 \begin_inset Newline newline
13915 \begin_inset Quotes eld
13919 \begin_inset Flex Code
13922 \begin_layout Plain Layout
13929 \begin_inset Quotes erd
13932 means that the paragraph is indented with the width of
13933 \begin_inset Quotes eld
13937 \begin_inset Flex Code
13940 \begin_layout Plain Layout
13947 \begin_inset Quotes erd
13950 in the normal font.
13951 You can get a negative width by prefixing the string with
13952 \begin_inset Quotes eld
13956 \begin_inset Flex Code
13959 \begin_layout Plain Layout
13966 \begin_inset Quotes erd
13970 This way was chosen so that the look is the same with each used screen
13974 \begin_layout Description
13975 \begin_inset Flex Code
13978 \begin_layout Plain Layout
13985 \begin_inset Flex Code
13988 \begin_layout Plain Layout
13993 , Manual, Dynamic, First_Dynamic, Right_Address_Box
13999 \begin_inset Newline newline
14002 The kind of margin that the style has on the left side.
14003 \begin_inset Separator parbreak
14010 \begin_layout Description
14011 \begin_inset Flex Code
14014 \begin_layout Plain Layout
14020 just means a fixed margin.
14023 \begin_layout Description
14024 \begin_inset Flex Code
14027 \begin_layout Plain Layout
14033 means that the left margin depends on the string entered in the
14034 \begin_inset Flex MenuItem
14037 \begin_layout Plain Layout
14038 Edit\SpecialChar menuseparator
14040 \begin_inset space ~
14049 This is used to typeset nice lists without tabulators.
14052 \begin_layout Description
14053 \begin_inset Flex Code
14056 \begin_layout Plain Layout
14062 means that the margin depends on the size of the label.
14063 This is used for automatic enumerated headlines.
14064 It is obvious that the headline
14065 \begin_inset Quotes eld
14068 5.4.3.2.1 Very long headline
14069 \begin_inset Quotes erd
14072 must have a wider left margin (as wide as
14073 \begin_inset Quotes eld
14077 \begin_inset Quotes erd
14080 plus the space) than
14081 \begin_inset Quotes eld
14084 3.2 Very long headline
14085 \begin_inset Quotes erd
14089 \begin_inset Quotes eld
14093 \begin_inset Quotes erd
14096 are not able to do this.
14099 \begin_layout Description
14100 \begin_inset Flex Code
14103 \begin_layout Plain Layout
14109 is similar, but only the very first row of the paragraph is dynamic, while
14110 the others are static; this is used, for example, for descriptions.
14113 \begin_layout Description
14114 \begin_inset Flex Code
14117 \begin_layout Plain Layout
14123 means the margin is chosen in a way that the longest row of this paragraph
14124 fits to the right margin.
14125 This is used to typeset an address on the right edge of the page.
14129 \begin_layout Description
14130 \begin_inset Flex Code
14133 \begin_layout Plain Layout
14140 \begin_inset Flex Code
14143 \begin_layout Plain Layout
14152 \begin_inset space \thinspace{}
14156 \begin_inset Flex Code
14159 \begin_layout Plain Layout
14165 ] Whether fragile commands in this style should be
14166 \begin_inset Flex Code
14169 \begin_layout Plain Layout
14182 whether this command should itself be protected.)
14185 \begin_layout Description
14186 \begin_inset Flex Code
14189 \begin_layout Plain Layout
14196 \begin_inset Flex Code
14199 \begin_layout Plain Layout
14206 \begin_inset space \thinspace{}
14210 \begin_inset Flex Code
14213 \begin_layout Plain Layout
14221 ] Whether newlines are translated into \SpecialChar LaTeX
14223 \begin_inset Flex Code
14226 \begin_layout Plain Layout
14237 The translation can be switched off to allow more comfortable \SpecialChar LaTeX
14239 inside \SpecialChar LyX
14243 \begin_layout Description
14244 \begin_inset Flex Code
14247 \begin_layout Plain Layout
14254 \begin_inset Flex Code
14257 \begin_layout Plain Layout
14266 \begin_inset space \thinspace{}
14270 \begin_inset Flex Code
14273 \begin_layout Plain Layout
14279 ] If set to true, and if
14280 \begin_inset Flex Code
14283 \begin_layout Plain Layout
14290 \begin_inset Flex Code
14293 \begin_layout Plain Layout
14299 ) paragraphs are being indented, then the indentation of such a paragraph
14300 following one of this type will be suppressed.
14301 (So this will not affect the display of non-default paragraphs.)
14304 \begin_layout Description
14305 \begin_inset Flex Code
14308 \begin_layout Plain Layout
14315 \begin_inset Flex Code
14318 \begin_layout Plain Layout
14324 ] Name of a style that has replaced this style.
14325 This is used to rename a style, while keeping backward compatibility.
14326 \change_inserted -712698321 1432986397
14330 \begin_layout Description
14332 \change_inserted -712698321 1432986583
14333 \begin_inset Flex Code
14336 \begin_layout Plain Layout
14338 \change_inserted -712698321 1432986403
14345 \begin_inset Flex Code
14348 \begin_layout Plain Layout
14350 \change_inserted -712698321 1432986397
14357 \begin_inset space \thinspace{}
14361 \begin_inset Flex Code
14364 \begin_layout Plain Layout
14366 \change_inserted -712698321 1432986397
14372 ] Determines whether consecutive pragraphs of the same type are treated
14373 as belonging together.
14374 This has the effect that the
14375 \begin_inset Flex Code
14378 \begin_layout Plain Layout
14380 \change_inserted -712698321 1432986460
14386 is only printed once before such a group.
14387 By default, this is true for
14388 \begin_inset Flex Code
14391 \begin_layout Plain Layout
14393 \change_inserted -712698321 1432986491
14400 \begin_inset Flex Code
14403 \begin_layout Plain Layout
14405 \change_inserted -712698321 1432986583
14414 \begin_inset Flex Code
14417 \begin_layout Plain Layout
14419 \change_inserted -712698321 1432986572
14427 and false for all other types.
14432 \begin_layout Description
14433 \begin_inset Flex Code
14436 \begin_layout Plain Layout
14443 \begin_inset Flex Code
14446 \begin_layout Plain Layout
14455 \begin_inset space \thinspace{}
14459 \begin_inset Flex Code
14462 \begin_layout Plain Layout
14468 ] Indicates that paragraphs will not be separated by an empty line in \SpecialChar LaTeX
14470 but only by a line break; together with
14471 \begin_inset Flex Code
14474 \begin_layout Plain Layout
14480 , this allows to emulate a plain text editor (like the ERT inset).
14483 \begin_layout Description
14484 \begin_inset Flex Code
14487 \begin_layout Plain Layout
14494 \begin_inset Flex Code
14497 \begin_layout Plain Layout
14503 ] The indent of the very first line of a paragraph.
14505 \begin_inset Newline newline
14509 \begin_inset Flex Code
14512 \begin_layout Plain Layout
14518 will be fixed for a certain style.
14519 The exception is the default style, since the indentation for these paragraphs
14520 can be prohibited with
14521 \begin_inset Flex Code
14524 \begin_layout Plain Layout
14532 \begin_inset Flex Code
14535 \begin_layout Plain Layout
14541 style paragraphs inside environments use the
14542 \begin_inset Flex Code
14545 \begin_layout Plain Layout
14551 of the environment, not their native one.
14553 \begin_inset Flex Code
14556 \begin_layout Plain Layout
14562 paragraphs inside an enumeration are not indented.
14565 \begin_layout Description
14566 \begin_inset Flex Code
14569 \begin_layout Plain Layout
14576 \begin_inset Flex Code
14579 \begin_layout Plain Layout
14585 ] The vertical space between two paragraphs of this style.
14588 \begin_layout Description
14589 \begin_inset Flex Code
14592 \begin_layout Plain Layout
14599 \begin_inset Flex Code
14602 \begin_layout Plain Layout
14609 allows the user to choose either
14610 \begin_inset Quotes eld
14614 \begin_inset Quotes erd
14618 \begin_inset Quotes eld
14622 \begin_inset Quotes erd
14625 to separate paragraphs.
14627 \begin_inset Quotes eld
14631 \begin_inset Quotes erd
14635 \begin_inset Flex Code
14638 \begin_layout Plain Layout
14646 \begin_inset Quotes eld
14650 \begin_inset Quotes erd
14654 \begin_inset Flex Code
14657 \begin_layout Plain Layout
14663 is ignored and all paragraphs are separated by the
14664 \begin_inset Flex Code
14667 \begin_layout Plain Layout
14674 The vertical space is calculated with
14675 \begin_inset Flex Code
14678 \begin_layout Plain Layout
14680 \begin_inset space ~
14689 \begin_inset Flex Code
14692 \begin_layout Plain Layout
14698 is the height of a row with the normal font.
14699 This way, the look stays the same with different screen fonts.
14702 \begin_layout Description
14703 \begin_inset Flex Code
14706 \begin_layout Plain Layout
14713 \begin_inset Flex Code
14716 \begin_layout Plain Layout
14725 \begin_inset space \thinspace{}
14729 \begin_inset Flex Code
14732 \begin_layout Plain Layout
14738 ] Whether the contents of this paragraph should be output in raw form, meaning
14739 without special translations that \SpecialChar LaTeX
14741 \change_inserted 155139281 1429534178
14745 \begin_layout Description
14747 \change_inserted 155139281 1429534242
14750 \begin_inset Flex Code
14753 \begin_layout Plain Layout
14755 \change_inserted 155139281 1429534178
14764 \begin_inset Flex Code
14767 \begin_layout Plain Layout
14769 \change_inserted 155139281 1429534178
14770 string of characters
14779 Defines individual characters that should be output in raw form, meaning
14780 without special translations that \SpecialChar LaTeX
14786 \begin_layout Description
14787 \begin_inset Flex Code
14790 \begin_layout Plain Layout
14796 Information to be included in the \SpecialChar LaTeX
14797 preamble when this style is used.
14798 Used to define macros, load packages, etc., required by this particular
14801 \begin_inset Quotes eld
14805 \begin_inset Flex Code
14808 \begin_layout Plain Layout
14815 \begin_inset Quotes erd
14821 \begin_layout Description
14822 \begin_inset Flex Code
14825 \begin_layout Plain Layout
14832 \begin_inset Flex Code
14835 \begin_layout Plain Layout
14841 ] The prefix to use when creating labels referring to paragraphs of this
14843 This allows the use of formatted references.
14846 \begin_layout Description
14847 \begin_inset Flex Code
14850 \begin_layout Plain Layout
14857 \begin_inset Flex Code
14860 \begin_layout Plain Layout
14866 ] Whether the style requires the feature
14867 \begin_inset Flex Code
14870 \begin_layout Plain Layout
14877 See the description of
14878 \begin_inset Flex Code
14881 \begin_layout Plain Layout
14888 \begin_inset CommandInset ref
14890 reference "subsec:General-text-class"
14894 ) for information on `features'.
14897 \begin_layout Description
14898 \begin_inset Flex Code
14901 \begin_layout Plain Layout
14908 \begin_inset Flex Code
14911 \begin_layout Plain Layout
14920 \begin_inset Flex Code
14923 \begin_layout Plain Layout
14929 ] Resets the \SpecialChar LaTeX
14930 arguments of this style (as defined via the
14931 \begin_inset Flex Code
14934 \begin_layout Plain Layout
14941 This is useful if you have copied a style via
14942 \begin_inset Flex Code
14945 \begin_layout Plain Layout
14951 , but you do not want to inherit its (required and optional) arguments.
14954 \begin_layout Description
14955 \begin_inset Flex Code
14958 \begin_layout Plain Layout
14965 \begin_inset Flex Code
14968 \begin_layout Plain Layout
14974 ] A string that is put at the end of the layout content.
14975 A line break in the output can be indicated by
14976 \begin_inset Flex Code
14979 \begin_layout Plain Layout
14988 \begin_layout Description
14989 \begin_inset Flex Code
14992 \begin_layout Plain Layout
14999 \begin_inset Flex Code
15002 \begin_layout Plain Layout
15009 \begin_inset Flex Code
15012 \begin_layout Plain Layout
15021 \begin_layout Description
15022 \begin_inset Flex Code
15025 \begin_layout Plain Layout
15032 \begin_inset Flex Code
15035 \begin_layout Plain Layout
15044 \begin_inset Flex Code
15047 \begin_layout Plain Layout
15054 \begin_inset Flex Code
15057 \begin_layout Plain Layout
15064 \begin_inset Flex Code
15067 \begin_layout Plain Layout
15069 \begin_inset space ~
15077 ] This defines what the default spacing should be in the style.
15079 \begin_inset Flex Code
15082 \begin_layout Plain Layout
15089 \begin_inset Flex Code
15092 \begin_layout Plain Layout
15099 \begin_inset Flex Code
15102 \begin_layout Plain Layout
15108 correspond respectively to a multiplier value of 1, 1.25 and 1.667.
15109 If you specify the argument
15110 \begin_inset Flex Code
15113 \begin_layout Plain Layout
15119 , then you must also provide a value argument which will be the actual multiplie
15121 Note that, contrary to other parameters,
15122 \begin_inset Flex Code
15125 \begin_layout Plain Layout
15131 implies the generation of specific \SpecialChar LaTeX
15132 code, using the \SpecialChar LaTeX
15136 \begin_inset Flex Code
15139 \begin_layout Plain Layout
15148 \begin_layout Description
15149 \begin_inset Flex Code
15152 \begin_layout Plain Layout
15159 \begin_inset Flex Code
15162 \begin_layout Plain Layout
15169 \begin_inset space \thinspace{}
15173 \begin_inset Flex Code
15176 \begin_layout Plain Layout
15184 ] Allow spell-checking paragraphs of this style.
15188 \begin_layout Description
15189 \begin_inset Flex Code
15192 \begin_layout Plain Layout
15198 The font used for the text body .
15200 \begin_inset CommandInset ref
15202 reference "subsec:Font-description"
15209 \begin_layout Description
15210 \begin_inset Flex Code
15213 \begin_layout Plain Layout
15222 \begin_inset Flex Code
15225 \begin_layout Plain Layout
15235 The level of the style in the table of contents.
15236 This is used for automatic numbering of section headings.
15237 \change_inserted -712698321 1401363541
15241 \begin_layout Description
15243 \change_inserted -712698321 1401363906
15244 \begin_inset Flex Code
15247 \begin_layout Plain Layout
15249 \change_inserted -712698321 1401363547
15258 \begin_inset Flex Code
15261 \begin_layout Plain Layout
15263 \change_inserted -712698321 1401363664
15276 \begin_inset Flex Code
15279 \begin_layout Plain Layout
15281 \change_inserted -712698321 1401363669
15290 \begin_inset Flex Code
15293 \begin_layout Plain Layout
15295 \change_inserted -712698321 1401363675
15303 ] This tag determines whether the first line indentation of this paragraph
15304 can be toggled via the Paragraph settings dialog.
15308 \begin_inset Flex Code
15311 \begin_layout Plain Layout
15313 \change_inserted -712698321 1401363761
15323 is set, indentation can be toggled if the document settings use
15324 \begin_inset Quotes eld
15328 \begin_inset Quotes erd
15331 paragraph style, with
15332 \begin_inset Flex Code
15335 \begin_layout Plain Layout
15337 \change_inserted -712698321 1401363844
15343 , indentation can always be toggled, notwithstanding the document settings,
15345 \begin_inset Flex Code
15348 \begin_layout Plain Layout
15350 \change_inserted -712698321 1401363901
15356 , indentation can never be toggled.
15361 \begin_layout Description
15362 \begin_inset Flex Code
15365 \begin_layout Plain Layout
15372 \begin_inset Flex Code
15375 \begin_layout Plain Layout
15381 ] The vertical space with which the very first of a chain of paragraphs
15382 with this style is separated from the previous paragraph.
15383 If the previous paragraph has another style, the separations are not simply
15384 added, but the maximum is taken.
15387 \begin_layout Subsection
15388 \begin_inset CommandInset label
15394 Internationalization of Paragraph Styles
15397 \begin_layout Standard
15399 has long supported internationalization of layout information, but, until
15400 version 2.0, this applied only to the user interface and not to, say, PDF
15402 Thus, French authors were forced to resort to ugly hacks if they wanted
15407 1' instead of `Theorem 1'.
15408 Thanks to Georg Baum, that is no longer the case.
15411 \begin_layout Standard
15413 \begin_inset Flex Code
15416 \begin_layout Plain Layout
15422 defines text that is to appear in the typeset document, it may use
15423 \begin_inset Flex Code
15426 \begin_layout Plain Layout
15433 \begin_inset Flex Code
15436 \begin_layout Plain Layout
15442 to support non-English and even multi-language documents correctly.
15443 The following excerpt (from the
15444 \begin_inset Flex Code
15447 \begin_layout Plain Layout
15453 file) shows how this works:
15456 \begin_layout LyX-Code
15458 \begin_inset Separator parbreak
15465 \begin_layout LyX-Code
15468 theoremstyle{remark}
15471 \begin_layout LyX-Code
15474 newtheorem{claim}[thm]{
15481 \begin_layout LyX-Code
15485 \begin_layout LyX-Code
15489 \begin_layout LyX-Code
15494 claimname}{_(Claim)}
15497 \begin_layout LyX-Code
15501 \begin_layout LyX-Code
15505 \begin_layout LyX-Code
15514 claimname}{_(Claim)}}
15517 \begin_layout LyX-Code
15522 \begin_layout Standard
15523 In principle, any legal \SpecialChar LaTeX
15525 \begin_inset Flex Code
15528 \begin_layout Plain Layout
15535 \begin_inset Flex Code
15538 \begin_layout Plain Layout
15544 tags, but in practice they will typically look as they do here.
15545 The key to correct translation of the typeset text is the definition of
15546 the \SpecialChar LaTeX
15548 \begin_inset Flex Code
15551 \begin_layout Plain Layout
15560 \begin_inset Flex Code
15563 \begin_layout Plain Layout
15575 \begin_layout Standard
15577 \begin_inset Flex Code
15580 \begin_layout Plain Layout
15586 tag provides for internationalization based upon the overall language of
15588 The contents of the tag will be included in the preamble, just as with
15590 \begin_inset Flex Code
15593 \begin_layout Plain Layout
15600 What makes it special is the use of the
15601 \begin_inset Quotes eld
15605 \begin_inset Quotes erd
15609 \begin_inset Flex Code
15612 \begin_layout Plain Layout
15618 , which will be replaced, when \SpecialChar LyX
15619 produces \SpecialChar LaTeX
15620 output, with the translation of
15621 its argument into the document language.
15624 \begin_layout Standard
15626 \begin_inset Flex Code
15629 \begin_layout Plain Layout
15635 tag is more complex, since it is meant to provide support for multi-language
15636 documents and so offers an interface to the
15637 \begin_inset Flex Code
15640 \begin_layout Plain Layout
15647 Its contents will be added to the preamble once for each language that
15648 appears in the document.
15649 In this case, the argument to
15650 \begin_inset Flex Code
15653 \begin_layout Plain Layout
15659 will be replaced with its translation into the language in question; the
15661 \begin_inset Flex Code
15664 \begin_layout Plain Layout
15670 is replaced by the language name (as used by the babel package).
15673 \begin_layout Standard
15674 A German document that also included a French section would thus have the
15675 following in the preamble:
15678 \begin_layout LyX-Code
15687 claimname}{Affirmation}}
15688 \begin_inset Newline newline
15699 claimname}{Behauptung}}
15700 \begin_inset Newline newline
15707 claimname}{Behauptung}
15710 \begin_layout Standard
15713 \begin_inset Flex Code
15716 \begin_layout Plain Layout
15722 will then conspire to produce the correct text in the output.
15725 \begin_layout Standard
15726 One important point to note here is that the translations are provided by
15728 itself, through the file
15729 \begin_inset Flex Code
15732 \begin_layout Plain Layout
15739 This means, in effect, that
15740 \begin_inset Flex Code
15743 \begin_layout Plain Layout
15750 \begin_inset Flex Code
15753 \begin_layout Plain Layout
15759 are really only of use in layout files that are provided with \SpecialChar LyX
15761 entered in user-created layout files will not be seen by \SpecialChar LyX
15762 's internationalizatio
15763 n routines unless the
15764 \begin_inset Flex Code
15767 \begin_layout Plain Layout
15773 file is modified accordingly.
15774 That said, however, any layout created with the intention that it will
15775 be included with \SpecialChar LyX
15776 should use these tags where appropriate.
15777 Please note that the paragraph style translations provided by \SpecialChar LyX
15779 change with a minor update (e.
15780 \begin_inset space \thinspace{}
15784 \begin_inset space \space{}
15787 from version 2.1.x to 2.1.y).
15788 It is however quite likely that a major update (e.
15789 \begin_inset space \thinspace{}
15793 \begin_inset space \space{}
15796 from 2.0.x to 2.1.y) will introduce new translations or corrections.
15799 \begin_layout Subsection
15801 \begin_inset CommandInset label
15803 name "subsec:Floats"
15810 \begin_layout Standard
15811 It is necessary to define the floats (
15812 \begin_inset Flex MenuItem
15815 \begin_layout Plain Layout
15822 \begin_inset Flex MenuItem
15825 \begin_layout Plain Layout
15831 , \SpecialChar ldots
15832 ) in the text class itself.
15833 Standard floats are included in the file
15834 \begin_inset Flex Code
15837 \begin_layout Plain Layout
15843 , so you may have to do no more than add
15846 \begin_layout LyX-Code
15847 Input stdfloats.inc
15850 \begin_layout Standard
15851 to your layout file.
15852 If you want to implement a text class that proposes some other float types
15853 (like the AGU class bundled with \SpecialChar LyX
15854 ), the information below will hopefully
15856 \change_inserted -712698321 1432283506
15860 \begin_layout Description
15862 \change_inserted -712698321 1432313622
15863 \begin_inset Flex Code
15866 \begin_layout Plain Layout
15868 \change_inserted -712698321 1432283514
15875 \begin_inset Flex Code
15878 \begin_layout Plain Layout
15880 \change_inserted -712698321 1432283507
15886 =!htbpH] Allowed placement options for this float type.
15887 The value is a string of placement characters.
15888 Possible characters include:
15893 \begin_inset Quotes eld
15897 \begin_inset Quotes erd
15905 \begin_inset Quotes eld
15909 \begin_inset Quotes erd
15917 \begin_inset Quotes eld
15921 \begin_inset Quotes erd
15929 \begin_inset Quotes eld
15933 \begin_inset Quotes erd
15941 \begin_inset Quotes eld
15945 \begin_inset Quotes erd
15953 \begin_inset Quotes eld
15957 \begin_inset Quotes erd
15961 The order of the characters in the string does not matter.
15962 If no placement options are allowed, use the string
15969 \begin_layout Description
15971 \change_inserted -712698321 1432313755
15972 \begin_inset Flex Code
15975 \begin_layout Plain Layout
15977 \change_inserted -712698321 1432313630
15984 \begin_inset Flex Code
15987 \begin_layout Plain Layout
15989 \change_inserted -712698321 1432313646
15998 \begin_inset space \thinspace{}
16004 \begin_inset Flex Code
16007 \begin_layout Plain Layout
16009 \change_inserted -712698321 1432313646
16019 ] Defines whether the float allows to be rotated via the rotfloat package
16022 \begin_inset Flex Code
16025 \begin_layout Plain Layout
16027 \change_inserted -712698321 1432313721
16033 if the float does not support this feature.
16036 \begin_layout Description
16038 \change_inserted -712698321 1432313802
16039 \begin_inset Flex Code
16042 \begin_layout Plain Layout
16044 \change_inserted -712698321 1432313759
16051 \begin_inset Flex Code
16054 \begin_layout Plain Layout
16056 \change_inserted -712698321 1432313755
16065 \begin_inset space \thinspace{}
16071 \begin_inset Flex Code
16074 \begin_layout Plain Layout
16076 \change_inserted -712698321 1432313755
16086 ] Defines whether the float has a starred variant that spans columns in
16087 a two column paragraph.
16089 \begin_inset Flex Code
16092 \begin_layout Plain Layout
16094 \change_inserted -712698321 1432313755
16100 if the float does not support this feature.
16105 \begin_layout Description
16106 \begin_inset Flex Code
16109 \begin_layout Plain Layout
16116 \begin_inset Flex Code
16119 \begin_layout Plain Layout
16126 \begin_inset Quotes erd
16130 \begin_inset Quotes erd
16133 ] The file name extension of an auxiliary file for the list of figures (or
16136 writes the captions to this file.
16139 \begin_layout Description
16140 \begin_inset Flex Code
16143 \begin_layout Plain Layout
16150 \begin_inset Flex Code
16153 \begin_layout Plain Layout
16160 \begin_inset Quotes erd
16164 \begin_inset Quotes erd
16167 ] The string that will be used in the menus and also for the caption.
16168 This is translated to the current language if babel is used.
16171 \begin_layout Description
16172 \begin_inset Flex Code
16175 \begin_layout Plain Layout
16181 These tags control the XHTML output.
16183 \begin_inset CommandInset ref
16185 reference "sec:Tags-for-XHTML"
16192 \begin_layout Description
16193 \begin_inset Flex Code
16196 \begin_layout Plain Layout
16205 \begin_inset Flex Code
16208 \begin_layout Plain Layout
16217 \begin_inset space \thinspace{}
16221 \begin_inset Flex Code
16224 \begin_layout Plain Layout
16230 ] Indicates whether the float is already defined in the document class or
16231 if instead the \SpecialChar LaTeX
16233 \begin_inset Flex Code
16236 \begin_layout Plain Layout
16242 needs to be loaded to define it on-the-fly.
16244 \begin_inset Flex Code
16247 \begin_layout Plain Layout
16254 \begin_inset Flex Code
16257 \begin_layout Plain Layout
16264 It should be set to
16265 \begin_inset Flex Code
16268 \begin_layout Plain Layout
16274 if the float is already defined by the \SpecialChar LaTeX
16278 \begin_layout Description
16279 \begin_inset Flex Code
16282 \begin_layout Plain Layout
16289 \begin_inset Flex Code
16292 \begin_layout Plain Layout
16299 \begin_inset Quotes erd
16303 \begin_inset Quotes erd
16306 ] The command used to generate a list of floats of this type; the leading
16315 \begin_inset Flex Code
16318 \begin_layout Plain Layout
16324 is false, since there is no standard way to generate this command.
16326 \begin_inset Flex Code
16329 \begin_layout Plain Layout
16335 is true, since in that case there is a standard way to define the command.
16338 \begin_layout Description
16339 \begin_inset Flex Code
16342 \begin_layout Plain Layout
16349 \begin_inset Flex Code
16352 \begin_layout Plain Layout
16359 \begin_inset Quotes erd
16363 \begin_inset Quotes erd
16366 ] A title for a list of floats of this kind (list of figures, tables, or
16368 It is used for the screen label within \SpecialChar LyX
16369 , it is used by \SpecialChar LaTeX
16371 it is used as the title in the XHTML output.
16372 It will be translated to the document language.
16375 \begin_layout Description
16376 \begin_inset Flex Code
16379 \begin_layout Plain Layout
16386 \begin_inset Flex Code
16389 \begin_layout Plain Layout
16396 \begin_inset Quotes erd
16400 \begin_inset Quotes erd
16403 ] This (optional) argument determines whether floats of this class will
16404 be numbered within some sectional unit of the document.
16406 \begin_inset Flex Code
16409 \begin_layout Plain Layout
16416 \begin_inset Quotes eld
16420 \begin_inset Flex Code
16423 \begin_layout Plain Layout
16430 \begin_inset Quotes erd
16433 , the floats will be numbered within chapters.
16437 \begin_layout Description
16438 \begin_inset Flex Code
16441 \begin_layout Plain Layout
16448 \begin_inset Flex Code
16451 \begin_layout Plain Layout
16458 \begin_inset Quotes erd
16462 \begin_inset Quotes erd
16465 ] The default placement for the given class of floats.
16466 The string should be as in standard \SpecialChar LaTeX
16468 \begin_inset Flex Code
16471 \begin_layout Plain Layout
16478 \begin_inset Flex Code
16481 \begin_layout Plain Layout
16488 \begin_inset Flex Code
16491 \begin_layout Plain Layout
16498 \begin_inset Flex Code
16501 \begin_layout Plain Layout
16507 for top, bottom, page, and here, respectively.
16511 \begin_layout Plain Layout
16512 Note that the order of these letters in the string is irrelevant, like in
16519 On top of that there is a new type,
16520 \begin_inset Flex Code
16523 \begin_layout Plain Layout
16529 , which does not really correspond to a float, since it means: put it
16530 \begin_inset Quotes eld
16534 \begin_inset Quotes erd
16538 Note however that the
16539 \begin_inset Flex Code
16542 \begin_layout Plain Layout
16548 specifier is special and, because of implementation details, cannot be
16549 used in non-built in float types.
16550 If you do not understand what this means, just use
16551 \begin_inset Quotes eld
16555 \begin_inset Flex Code
16558 \begin_layout Plain Layout
16565 \begin_inset Quotes erd
16571 \begin_layout Description
16572 \begin_inset Flex Code
16575 \begin_layout Plain Layout
16582 \begin_inset Flex Code
16585 \begin_layout Plain Layout
16591 ] The prefix to use when creating labels referring to floats of this type.
16592 This allows the use of formatted references.
16593 Note that you can remove any
16594 \begin_inset Flex Code
16597 \begin_layout Plain Layout
16603 set by a copied style by using the special value
16604 \begin_inset Quotes eld
16608 \begin_inset Quotes erd
16611 , which must be all caps.
16614 \begin_layout Description
16615 \begin_inset Flex Code
16618 \begin_layout Plain Layout
16625 \begin_inset Flex Code
16628 \begin_layout Plain Layout
16635 \begin_inset Quotes erd
16639 \begin_inset Quotes erd
16642 ] The style used when defining the float using
16643 \begin_inset Flex Code
16646 \begin_layout Plain Layout
16657 \begin_layout Description
16658 \begin_inset Flex Code
16661 \begin_layout Plain Layout
16668 \begin_inset Flex Code
16671 \begin_layout Plain Layout
16678 \begin_inset Quotes erd
16682 \begin_inset Quotes erd
16686 \begin_inset Quotes eld
16690 \begin_inset Quotes erd
16693 of the new class of floats, like program or algorithm.
16694 After the appropriate
16695 \begin_inset Flex Code
16698 \begin_layout Plain Layout
16707 \begin_inset Flex Code
16710 \begin_layout Plain Layout
16719 \begin_inset Flex Code
16722 \begin_layout Plain Layout
16733 \begin_layout Description
16734 \begin_inset Flex Code
16737 \begin_layout Plain Layout
16744 \begin_inset Flex Code
16747 \begin_layout Plain Layout
16754 \begin_inset space \thinspace{}
16758 \begin_inset Flex Code
16761 \begin_layout Plain Layout
16769 ] Specifies whether this float is defined using the \SpecialChar LaTeX
16771 \begin_inset Flex Code
16774 \begin_layout Plain Layout
16780 , either by the class file, another package or on-the-fly by \SpecialChar LyX
16784 \begin_layout Standard
16785 Note that defining a float with type
16786 \begin_inset Flex Code
16789 \begin_layout Plain Layout
16797 automatically defines the corresponding counter with name
16798 \begin_inset Flex Code
16801 \begin_layout Plain Layout
16812 \begin_layout Subsection
16813 Flex insets and InsetLayout
16814 \begin_inset CommandInset label
16816 name "subsec:Flex-insets-and"
16823 \begin_layout Standard
16824 Flex insets come in three different kinds:
16827 \begin_layout Itemize
16829 \begin_inset Flex Code
16832 \begin_layout Plain Layout
16838 ): These define semantic markup corresponding to such \SpecialChar LaTeX
16840 \begin_inset Flex Code
16843 \begin_layout Plain Layout
16852 \begin_inset Flex Code
16855 \begin_layout Plain Layout
16866 \begin_layout Itemize
16868 \begin_inset Flex Code
16871 \begin_layout Plain Layout
16877 ): These can be used to define custom collapsible insets, similar to \SpecialChar TeX
16879 footnote, and the like.
16880 An obvious example is an endnote inset, which is defined in the
16881 \begin_inset Flex Code
16884 \begin_layout Plain Layout
16893 \begin_layout Itemize
16895 \begin_inset Flex Code
16898 \begin_layout Plain Layout
16904 ): For use with DocBook classes.
16907 \begin_layout Standard
16908 Flex insets are defined using the
16909 \begin_inset Flex Code
16912 \begin_layout Plain Layout
16918 tag, which shall be explained in a moment.
16921 \begin_layout Standard
16923 \begin_inset Flex Code
16926 \begin_layout Plain Layout
16932 tag also serves another function: It can be used to customize the general
16933 layout of many different types of insets.
16935 \begin_inset Flex Code
16938 \begin_layout Plain Layout
16944 can be used to customize the layout parameters for footnotes, marginal
16945 notes, note insets, \SpecialChar TeX
16946 code (ERT) insets, branches, listings, indexes, boxes,
16947 tables, algorithms, URLs, and captions, as well as to define Flex insets.
16950 \begin_layout Standard
16952 \begin_inset Flex Code
16955 \begin_layout Plain Layout
16961 definition must begin with a line of the form:
16964 \begin_layout LyX-Code
16968 \begin_layout Standard
16970 \begin_inset Flex Code
16973 \begin_layout Plain Layout
16979 indicates the inset whose layout is being defined, and here there are four
16983 \begin_layout Enumerate
16984 The layout for a pre-existing inset is being modified.
16985 In this case, can be
16986 \begin_inset Flex Code
16989 \begin_layout Plain Layout
16995 any one of the following:
16996 \begin_inset Flex Code
16999 \begin_layout Plain Layout
17006 \begin_inset Flex Code
17009 \begin_layout Plain Layout
17016 \begin_inset Flex Code
17019 \begin_layout Plain Layout
17026 \begin_inset Flex Code
17029 \begin_layout Plain Layout
17036 \begin_inset Flex Code
17039 \begin_layout Plain Layout
17046 \begin_inset Flex Code
17049 \begin_layout Plain Layout
17056 \begin_inset Flex Code
17059 \begin_layout Plain Layout
17066 \begin_inset Flex Code
17069 \begin_layout Plain Layout
17076 \begin_inset Flex Code
17079 \begin_layout Plain Layout
17086 \begin_inset Flex Code
17089 \begin_layout Plain Layout
17096 \begin_inset Flex Code
17099 \begin_layout Plain Layout
17106 \begin_inset Flex Code
17109 \begin_layout Plain Layout
17116 \begin_inset Flex Code
17119 \begin_layout Plain Layout
17126 \begin_inset Flex Code
17129 \begin_layout Plain Layout
17136 \begin_inset Flex Code
17139 \begin_layout Plain Layout
17146 \begin_inset Flex Code
17149 \begin_layout Plain Layout
17156 \begin_inset Flex Code
17159 \begin_layout Plain Layout
17166 \begin_inset Flex Code
17169 \begin_layout Plain Layout
17176 \begin_inset Flex Code
17179 \begin_layout Plain Layout
17186 \begin_inset Flex Code
17189 \begin_layout Plain Layout
17198 \begin_layout Enumerate
17199 The layout for a Flex inset is being defined.
17201 \begin_inset Flex Code
17204 \begin_layout Plain Layout
17210 must be of the form
17211 \begin_inset Quotes eld
17215 \begin_inset Flex Code
17218 \begin_layout Plain Layout
17225 \begin_inset Quotes erd
17229 \begin_inset Flex Code
17232 \begin_layout Plain Layout
17238 may be be any valid identifier not used by a pre-existing Flex inset.
17239 The identifier may include spaces, but in that case the whole thing must
17240 be wrapped in quotes.
17241 Note that the definition of a flex inset
17246 \begin_inset Flex Code
17249 \begin_layout Plain Layout
17251 \change_deleted -712698321 1437634848
17254 \change_inserted -712698321 1437634847
17262 entry, declaring which type of inset it defines.
17265 \begin_layout Enumerate
17266 The layout for user specific branch is being defined.
17268 \begin_inset Flex Code
17271 \begin_layout Plain Layout
17277 must be of the form
17278 \begin_inset Quotes eld
17282 \begin_inset Flex Code
17285 \begin_layout Plain Layout
17292 \begin_inset Quotes erd
17296 \begin_inset Flex Code
17299 \begin_layout Plain Layout
17305 may be be any valid identifier of branch defined in user's document.
17306 The identifier may include spaces, but in that case the whole thing must
17307 be wrapped in quotes.
17308 The main purpose of this feature is to allow \SpecialChar LaTeX
17309 wrapping around specific
17310 branches as user needs.
17313 \begin_layout Enumerate
17314 The layout of a user (or class) specific caption is being defined.
17316 \begin_inset Flex Code
17319 \begin_layout Plain Layout
17325 must be of the form
17326 \begin_inset Quotes eld
17330 \begin_inset Flex Code
17333 \begin_layout Plain Layout
17340 \begin_inset Quotes erd
17344 \begin_inset Flex Code
17347 \begin_layout Plain Layout
17353 specifies the name of the caption as it appears in the menu.
17354 Have a look at the standard caption (
17355 \begin_inset Flex Code
17358 \begin_layout Plain Layout
17364 ), the specific captions of the KOMA-Script classes (
17365 \begin_inset Flex Code
17368 \begin_layout Plain Layout
17375 \begin_inset Flex Code
17378 \begin_layout Plain Layout
17387 \begin_inset space ~
17393 \begin_inset Flex Code
17396 \begin_layout Plain Layout
17402 ) for applications.
17405 \begin_layout Standard
17407 \begin_inset Flex Code
17410 \begin_layout Plain Layout
17416 definition can contain the following entries:
17419 \begin_layout Description
17420 \begin_inset Flex Code
17423 \begin_layout Plain Layout
17430 \begin_inset Flex Code
17433 \begin_layout Plain Layout
17439 ] Defines argument number of a command\SpecialChar breakableslash
17440 environment associated with the current
17442 The definition must end with
17443 \begin_inset Flex Code
17446 \begin_layout Plain Layout
17454 \begin_inset CommandInset ref
17456 reference "subsec:Paragraph-Styles"
17463 \begin_layout Description
17464 \begin_inset Flex Code
17467 \begin_layout Plain Layout
17473 Preamble for changing language commands; see
17474 \begin_inset CommandInset ref
17476 reference "subsec:I18n"
17483 \begin_layout Description
17484 \begin_inset Flex Code
17487 \begin_layout Plain Layout
17494 \begin_inset Flex Code
17497 \begin_layout Plain Layout
17503 ] The color for the inset's background.
17505 \begin_inset CommandInset ref
17507 reference "chap:Names-of-colors"
17511 for a list of the available color names.
17514 \begin_layout Description
17515 \begin_inset Flex Code
17518 \begin_layout Plain Layout
17525 \begin_inset Flex Code
17528 \begin_layout Plain Layout
17537 \begin_inset space \thinspace{}
17541 \begin_inset Flex Code
17544 \begin_layout Plain Layout
17550 ] Whether to use the content of the inset as the label, when the inset is
17555 \begin_layout Description
17556 \begin_inset Flex Code
17559 \begin_layout Plain Layout
17566 \begin_inset Flex Code
17569 \begin_layout Plain Layout
17575 ] As with paragraph styles, see
17576 \begin_inset CommandInset ref
17578 reference "subsec:Paragraph-Styles"
17583 Note that you need to specify the complete type, e.
17584 \begin_inset space \thinspace{}
17588 \begin_inset space ~
17592 \begin_inset Flex Code
17595 \begin_layout Plain Layout
17596 CopyStyle Flex:<name>
17604 \begin_layout Description
17605 \begin_inset Flex Code
17608 \begin_layout Plain Layout
17615 \begin_inset Flex Code
17618 \begin_layout Plain Layout
17627 \begin_inset space \thinspace{}
17631 \begin_inset Flex Code
17634 \begin_layout Plain Layout
17640 ] Indicates whether the user may employ the Paragraph Settings dialog to
17641 customize the paragraph.
17644 \begin_layout Description
17645 \begin_inset Flex Code
17648 \begin_layout Plain Layout
17655 \begin_inset Flex Code
17658 \begin_layout Plain Layout
17665 \begin_inset Flex Code
17668 \begin_layout Plain Layout
17675 \begin_inset Flex Code
17678 \begin_layout Plain Layout
17684 , describing the rendering style used for the inset's frame and buttons.
17685 Footnotes generally use
17686 \begin_inset Flex Code
17689 \begin_layout Plain Layout
17695 , ERT insets generally
17696 \begin_inset Flex Code
17699 \begin_layout Plain Layout
17705 , and character styles
17706 \begin_inset Flex Code
17709 \begin_layout Plain Layout
17718 \begin_layout Description
17719 \begin_inset Flex Code
17722 \begin_layout Plain Layout
17729 \begin_inset Flex Code
17732 \begin_layout Plain Layout
17741 \begin_inset space \thinspace{}
17747 \begin_inset Flex Code
17750 \begin_layout Plain Layout
17759 \begin_inset Flex Code
17762 \begin_layout Plain Layout
17769 \begin_inset Flex Code
17772 \begin_layout Plain Layout
17779 Indicates whether the environment will stand on its own in the output or
17780 will appear inline with the surrounding text.
17781 If set to false, it is supposed that the \SpecialChar LaTeX
17782 environment ignores white space
17783 (including one newline character) after the
17784 \begin_inset Flex Code
17787 \begin_layout Plain Layout
17800 \begin_inset Flex Code
17803 \begin_layout Plain Layout
17819 \begin_layout Description
17820 \begin_inset Flex Code
17823 \begin_layout Plain Layout
17829 Required at the end of the
17830 \begin_inset Flex Code
17833 \begin_layout Plain Layout
17842 \begin_layout Description
17843 \begin_inset Flex Code
17846 \begin_layout Plain Layout
17852 The font used for both the text body
17858 \begin_inset CommandInset ref
17860 reference "subsec:Font-description"
17865 Note that defining this font automatically defines the
17866 \begin_inset Flex Code
17869 \begin_layout Plain Layout
17875 to the same value, so define this first and define
17876 \begin_inset Flex Code
17879 \begin_layout Plain Layout
17885 later if you want them to be different.
17886 \change_inserted -195340706 1421002157
17890 \begin_layout Description
17892 \change_inserted -195340706 1421002157
17893 \begin_inset Flex Code
17896 \begin_layout Plain Layout
17898 \change_inserted -195340706 1421002157
17899 FixedWidthPreambleEncoding
17905 \begin_inset Flex Code
17908 \begin_layout Plain Layout
17910 \change_inserted -195340706 1421002157
17919 \begin_inset space \thinspace{}
17923 \begin_inset Flex Code
17926 \begin_layout Plain Layout
17928 \change_inserted -195340706 1421002157
17934 ] Force a fixed width encoding for the translated contents of
17935 \begin_inset Flex Code
17938 \begin_layout Plain Layout
17940 \change_inserted -195340706 1421002157
17947 \begin_inset Flex Code
17950 \begin_layout Plain Layout
17952 \change_inserted -195340706 1421002157
17958 code generated by this layout.
17959 This is needed for special packages like the listings package that do not
17960 work with variable width encodings such as utf8.
17962 This setting is ignored if fully unicode aware \SpecialChar LaTeX
17963 backends such as Xe\SpecialChar LaTeX
17970 \begin_layout Description
17971 \begin_inset Flex Code
17974 \begin_layout Plain Layout
17975 ForceLocalFontSwitch
17981 \begin_inset Flex Code
17984 \begin_layout Plain Layout
17993 \begin_inset space \thinspace{}
17997 \begin_inset Flex Code
18000 \begin_layout Plain Layout
18006 ] When using babel, always use a local font switch (
18007 \begin_inset Flex Code
18010 \begin_layout Plain Layout
18018 ), never a global one (such as
18019 \begin_inset Flex Code
18022 \begin_layout Plain Layout
18033 \begin_layout Description
18034 \begin_inset Flex Code
18037 \begin_layout Plain Layout
18044 \begin_inset Flex Code
18047 \begin_layout Plain Layout
18056 \begin_inset space \thinspace{}
18060 \begin_inset Flex Code
18063 \begin_layout Plain Layout
18070 \begin_inset Quotes eld
18074 \begin_inset Quotes erd
18077 language, leading to Left-to-Right (Latin) output, e.
18078 \begin_inset space \thinspace{}
18082 \begin_inset space \space{}
18085 in \SpecialChar TeX
18088 \change_inserted -712698321 1417441977
18092 \begin_layout Description
18094 \change_inserted -712698321 1417442090
18095 \begin_inset Flex Code
18098 \begin_layout Plain Layout
18100 \change_inserted -712698321 1417441983
18107 \begin_inset Flex Code
18110 \begin_layout Plain Layout
18112 \change_inserted -712698321 1417441978
18121 \begin_inset space \thinspace{}
18125 \begin_inset Flex Code
18128 \begin_layout Plain Layout
18130 \change_inserted -712698321 1417441978
18136 ] Force a a line break in the \SpecialChar LaTeX
18137 output before the inset starts and after
18139 This assures the inset itself is output on its own lines, for parsing purposes.
18141 \change_inserted 274215730 1419105878
18147 \begin_layout Description
18148 \begin_inset Flex Code
18151 \begin_layout Plain Layout
18158 \begin_inset Flex Code
18161 \begin_layout Plain Layout
18170 \begin_inset space \thinspace{}
18174 \begin_inset Flex Code
18177 \begin_layout Plain Layout
18183 ] Indicates whether the
18184 \begin_inset Flex Code
18187 \begin_layout Plain Layout
18193 should be used or, instead, the user can change the paragraph style used
18198 \begin_layout Description
18199 \begin_inset Flex Code
18202 \begin_layout Plain Layout
18209 \begin_inset Flex Code
18212 \begin_layout Plain Layout
18221 \begin_inset space \thinspace{}
18225 \begin_inset Flex Code
18228 \begin_layout Plain Layout
18234 ] As with paragraph styles, see
18235 \begin_inset CommandInset ref
18237 reference "subsec:Paragraph-Styles"
18244 \begin_layout Description
18245 \begin_inset Flex Code
18248 \begin_layout Plain Layout
18254 These tags control the XHTML output.
18256 \begin_inset CommandInset ref
18258 reference "sec:Tags-for-XHTML"
18265 \begin_layout Description
18266 \begin_inset Flex Code
18269 \begin_layout Plain Layout
18276 \begin_inset Flex Code
18279 \begin_layout Plain Layout
18288 \begin_inset space \thinspace{}
18292 \begin_inset Flex Code
18295 \begin_layout Plain Layout
18301 ] Whether to include the contents of this inset in the strings generated
18302 for the `Outline' pane.
18303 One would not, for example, want the content of a footnote in a section
18304 header to be included in the TOC displayed in the outline, but one would
18305 normally want the content of a character style displayed.
18306 Default is false: not to include.
18309 \begin_layout Description
18310 \begin_inset Flex Code
18313 \begin_layout Plain Layout
18322 \begin_inset Flex Code
18325 \begin_layout Plain Layout
18334 \begin_inset space \thinspace{}
18338 \begin_inset Flex Code
18341 \begin_layout Plain Layout
18347 ] As with paragraph styles, see
18348 \begin_inset CommandInset ref
18350 reference "subsec:Paragraph-Styles"
18357 \begin_layout Description
18358 \begin_inset Flex Code
18361 \begin_layout Plain Layout
18367 The font used for the label.
18369 \begin_inset CommandInset ref
18371 reference "subsec:Font-description"
18376 Note that this definition can never appear before
18377 \begin_inset Flex Code
18380 \begin_layout Plain Layout
18386 , lest it be ineffective.
18389 \begin_layout Description
18390 \begin_inset Flex Code
18393 \begin_layout Plain Layout
18400 \begin_inset Flex Code
18403 \begin_layout Plain Layout
18410 \begin_inset Quotes erd
18414 \begin_inset Quotes erd
18417 ] What will be displayed on the button or elsewhere as the inset label.
18419 \begin_inset Flex Code
18422 \begin_layout Plain Layout
18430 \begin_inset Flex Code
18433 \begin_layout Plain Layout
18439 ) modify this label on the fly.
18442 \begin_layout Description
18443 \begin_inset Flex Code
18446 \begin_layout Plain Layout
18452 Language dependent preamble; see
18453 \begin_inset CommandInset ref
18455 reference "subsec:I18n"
18462 \begin_layout Description
18463 \begin_inset Flex Code
18466 \begin_layout Plain Layout
18473 \begin_inset Flex Code
18476 \begin_layout Plain Layout
18482 ] The name of the corresponding \SpecialChar LaTeX
18484 Either the environment or command name.
18487 \begin_layout Description
18488 \begin_inset Flex Code
18491 \begin_layout Plain Layout
18498 \begin_inset Flex Code
18501 \begin_layout Plain Layout
18507 ] The optional parameter for the corresponding
18508 \begin_inset Flex Code
18511 \begin_layout Plain Layout
18517 stuff, including possible bracket pairs like
18518 \begin_inset Flex Code
18521 \begin_layout Plain Layout
18528 This parameter cannot be changed from within \SpecialChar LyX
18530 \begin_inset Flex Code
18533 \begin_layout Plain Layout
18539 for customizable parameters).
18540 It will be output as is after all \SpecialChar LaTeX
18542 \begin_inset Flex Code
18545 \begin_layout Plain Layout
18554 \begin_layout Description
18555 \begin_inset Flex Code
18558 \begin_layout Plain Layout
18565 \begin_inset Flex Code
18568 \begin_layout Plain Layout
18569 Command, Environment, None
18574 ] How the style should be translated into \SpecialChar LaTeX
18579 \begin_layout Plain Layout
18580 \begin_inset Flex Code
18583 \begin_layout Plain Layout
18589 is perhaps a bit misleading, since these rules apply to SGML classes too.
18590 Visit the SGML class files for specific examples.
18596 \begin_inset Separator parbreak
18603 \begin_layout Description
18604 \begin_inset Flex Code
18607 \begin_layout Plain Layout
18613 means nothing special
18616 \begin_layout Description
18617 \begin_inset Flex Code
18620 \begin_layout Plain Layout
18627 \begin_inset Flex Code
18630 \begin_layout Plain Layout
18637 {\SpecialChar ldots
18646 \begin_layout Description
18647 \begin_inset Flex Code
18650 \begin_layout Plain Layout
18657 \begin_inset Flex Code
18660 \begin_layout Plain Layout
18667 }\SpecialChar ldots
18682 \begin_layout Standard
18683 Putting the last few things together, the \SpecialChar LaTeX
18684 output will be either:
18687 \begin_layout LyX-Code
18690 LatexName[LatexParam]{\SpecialChar ldots
18694 \begin_layout Standard
18698 \begin_layout LyX-Code
18701 begin{LatexName}[LatexParam] \SpecialChar ldots
18707 \begin_layout Standard
18708 depending upon the \SpecialChar LaTeX
18713 \begin_layout Description
18714 \begin_inset Flex Code
18717 \begin_layout Plain Layout
18724 \begin_inset Flex Code
18727 \begin_layout Plain Layout
18733 ] A string that is put at the beginning of the layout content.
18734 A line break in the output can be indicated by
18735 \begin_inset Flex Code
18738 \begin_layout Plain Layout
18747 \begin_layout Description
18748 \begin_inset Flex Code
18751 \begin_layout Plain Layout
18758 \begin_inset Flex Code
18761 \begin_layout Plain Layout
18768 \begin_inset Flex Code
18771 \begin_layout Plain Layout
18778 \begin_inset Flex Code
18781 \begin_layout Plain Layout
18788 \begin_inset Flex Code
18791 \begin_layout Plain Layout
18797 (indicating a dummy definition ending definitions of charstyles, etc).
18798 This entry is required in and is only meaningful for Flex insets.
18799 Among other things, it determines on which menu this inset will appear.
18801 \begin_inset Flex Code
18804 \begin_layout Plain Layout
18806 \change_deleted -712698321 1437634857
18809 \change_inserted -712698321 1437634858
18818 \begin_inset Flex Code
18821 \begin_layout Plain Layout
18827 will automatically set
18828 \begin_inset Flex Code
18831 \begin_layout Plain Layout
18839 \begin_inset Flex Code
18842 \begin_layout Plain Layout
18848 can be set to true for
18849 \begin_inset Flex Code
18852 \begin_layout Plain Layout
18858 insets by setting it
18863 \begin_inset Flex Code
18866 \begin_layout Plain Layout
18868 \change_deleted -712698321 1437634864
18871 \change_inserted -712698321 1437634865
18882 \begin_layout Description
18883 \begin_inset Flex Code
18886 \begin_layout Plain Layout
18893 \begin_inset Flex Code
18896 \begin_layout Plain Layout
18905 \begin_inset space \thinspace{}
18909 \begin_inset Flex Code
18912 \begin_layout Plain Layout
18918 ] Whether multiple paragraphs are permitted in this inset.
18920 \begin_inset Flex Code
18923 \begin_layout Plain Layout
18929 to the same value and
18930 \begin_inset Flex Code
18933 \begin_layout Plain Layout
18939 to the opposite value.
18940 These can be reset to other values, if they are used
18945 \begin_inset Flex Code
18948 \begin_layout Plain Layout
18958 \begin_layout Description
18959 \begin_inset Flex Code
18962 \begin_layout Plain Layout
18969 \begin_inset Flex Code
18972 \begin_layout Plain Layout
18981 \begin_inset space \thinspace{}
18985 \begin_inset Flex Code
18988 \begin_layout Plain Layout
18994 ] Whether fragile commands in this inset should be
18995 \begin_inset Flex Code
18998 \begin_layout Plain Layout
19011 whether the command should itself be protected.) Default is false.
19014 \begin_layout Description
19015 \begin_inset Flex Code
19018 \begin_layout Plain Layout
19025 \begin_inset Flex Code
19028 \begin_layout Plain Layout
19034 ] Deletes an existing
19035 \begin_inset Flex Code
19038 \begin_layout Plain Layout
19045 \change_inserted -712698321 1417953494
19049 \begin_layout Description
19051 \change_inserted -712698321 1417953559
19052 \begin_inset Flex Code
19055 \begin_layout Plain Layout
19057 \change_inserted -712698321 1417953494
19064 \begin_inset Flex Code
19067 \begin_layout Plain Layout
19069 \change_inserted -712698321 1417953574
19076 \begin_inset Flex Code
19079 \begin_layout Plain Layout
19081 \change_inserted -712698321 1417953533
19087 that has replaced this
19088 \begin_inset Flex Code
19091 \begin_layout Plain Layout
19093 \change_inserted -712698321 1417953551
19100 This is used to rename an
19101 \begin_inset Flex Code
19104 \begin_layout Plain Layout
19106 \change_inserted -712698321 1417953559
19112 , while keeping backward compatibility.
19117 \begin_layout Description
19118 \begin_inset Flex Code
19121 \begin_layout Plain Layout
19128 \begin_inset Flex Code
19131 \begin_layout Plain Layout
19140 \begin_inset space \thinspace{}
19144 \begin_inset Flex Code
19147 \begin_layout Plain Layout
19153 ] As with paragraph styles, see
19154 \begin_inset CommandInset ref
19156 reference "subsec:Paragraph-Styles"
19164 \begin_layout Description
19165 \begin_inset Flex Code
19168 \begin_layout Plain Layout
19175 \begin_inset Flex Code
19178 \begin_layout Plain Layout
19187 \begin_inset space \thinspace{}
19191 \begin_inset Flex Code
19194 \begin_layout Plain Layout
19200 ] As with paragraph styles, see
19201 \begin_inset CommandInset ref
19203 reference "subsec:Paragraph-Styles"
19211 \begin_layout Description
19212 \begin_inset Flex Code
19215 \begin_layout Plain Layout
19221 As with paragraph styles, see
19222 \begin_inset CommandInset ref
19224 reference "subsec:Paragraph-Styles"
19231 \begin_layout Description
19232 \begin_inset Flex Code
19235 \begin_layout Plain Layout
19242 \begin_inset Flex Code
19245 \begin_layout Plain Layout
19251 ] The prefix to use when creating labels referring to insets of this type.
19252 This allows the use of formatted references.
19255 \begin_layout Description
19256 \begin_inset Flex Code
19259 \begin_layout Plain Layout
19266 \begin_inset Flex Code
19269 \begin_layout Plain Layout
19275 ] As with paragraph styles, see
19276 \begin_inset CommandInset ref
19278 reference "subsec:Paragraph-Styles"
19285 \begin_layout Description
19286 \begin_inset Flex Code
19289 \begin_layout Plain Layout
19296 \begin_inset Flex Code
19299 \begin_layout Plain Layout
19308 \begin_inset space \thinspace{}
19312 \begin_inset Flex Code
19315 \begin_layout Plain Layout
19321 ] Resets the \SpecialChar LaTeX
19322 arguments of this layout (as defined via the
19323 \begin_inset Flex Code
19326 \begin_layout Plain Layout
19333 This is useful if you have copied a style via
19334 \begin_inset Flex Code
19337 \begin_layout Plain Layout
19343 , but you do not want to inherit its (required and optional) arguments.
19346 \begin_layout Description
19347 \begin_inset Flex Code
19350 \begin_layout Plain Layout
19357 \begin_inset Flex Code
19360 \begin_layout Plain Layout
19367 \begin_inset space \thinspace{}
19371 \begin_inset Flex Code
19374 \begin_layout Plain Layout
19382 ] Whether this inset should use the font of its surrounding environment
19384 Default is false: use the font of the surrounding environment.
19387 \begin_layout Description
19388 \begin_inset Flex Code
19391 \begin_layout Plain Layout
19398 \begin_inset Flex Code
19401 \begin_layout Plain Layout
19407 ] A string that is put at the end of the layout content.
19408 A line break in the output can be indicated by
19409 \begin_inset Flex Code
19412 \begin_layout Plain Layout
19421 \begin_layout Description
19422 \begin_inset Flex Code
19425 \begin_layout Plain Layout
19432 \begin_inset Flex Code
19435 \begin_layout Plain Layout
19442 \begin_inset space \thinspace{}
19446 \begin_inset Flex Code
19449 \begin_layout Plain Layout
19457 ] Allow spell-checking the contents of this inset.
19461 \begin_layout Subsection
19463 \begin_inset CommandInset label
19465 name "subsec:Counters"
19472 \begin_layout Standard
19473 It is necessary to define the counters (
19474 \begin_inset Flex MenuItem
19477 \begin_layout Plain Layout
19484 \begin_inset Flex MenuItem
19487 \begin_layout Plain Layout
19493 , \SpecialChar ldots
19494 ) in the text class itself.
19495 The standard counters are defined in the file
19496 \begin_inset Flex Code
19499 \begin_layout Plain Layout
19505 , so you may have to do no more than add
19508 \begin_layout LyX-Code
19509 Input stdcounters.inc
19512 \begin_layout Standard
19513 to your layout file to get them to work.
19514 But if you want to define custom counters, then you can do so.
19515 The counter declaration must begin with:
19518 \begin_layout LyX-Code
19519 Counter CounterName
19522 \begin_layout Standard
19524 \begin_inset Flex Code
19527 \begin_layout Plain Layout
19533 ' is replaced by the name of the counter.
19534 And it must end with
19535 \begin_inset Quotes eld
19539 \begin_inset Flex Code
19542 \begin_layout Plain Layout
19549 \begin_inset Quotes erd
19553 The following parameters can also be used:
19556 \begin_layout Description
19557 \begin_inset Flex Code
19560 \begin_layout Plain Layout
19567 \begin_inset Flex Code
19570 \begin_layout Plain Layout
19576 ] Sets the initial value for the counter, to which it will be reset whenever
19578 Normally, one will want the default, 1.
19581 \begin_layout Description
19582 \begin_inset Flex Code
19585 \begin_layout Plain Layout
19592 \begin_inset Flex Code
19595 \begin_layout Plain Layout
19602 \begin_inset Quotes erd
19606 \begin_inset Quotes erd
19609 ] When defined, this string defines how the counter is displayed.
19610 Setting this value sets
19611 \begin_inset Flex Code
19614 \begin_layout Plain Layout
19615 LabelStringAppendix
19621 The following special constructs can be used in the string:
19622 \begin_inset Separator parbreak
19629 \begin_layout Itemize
19630 \begin_inset Flex Code
19633 \begin_layout Plain Layout
19641 will be replaced by the expansion of the
19642 \begin_inset Flex Code
19645 \begin_layout Plain Layout
19652 \begin_inset Flex Code
19655 \begin_layout Plain Layout
19656 LabelStringAppendix
19662 \begin_inset Flex Code
19665 \begin_layout Plain Layout
19675 \begin_layout Itemize
19676 counter values can be expressed using \SpecialChar LaTeX
19678 \begin_inset Newline newline
19682 \begin_inset Flex Code
19685 \begin_layout Plain Layout
19702 \begin_inset Flex Code
19705 \begin_layout Plain Layout
19717 \begin_layout Plain Layout
19727 Actually, the situation is a bit more complicated: any
19746 other than those described below will produce arabic numerals.
19747 It would not be surprising to see this change in the future.
19753 \begin_inset Flex Code
19756 \begin_layout Plain Layout
19762 : 1, 2, 3,\SpecialChar ldots
19764 \begin_inset Flex Code
19767 \begin_layout Plain Layout
19773 for lower-case letters: a, b, c, \SpecialChar ldots
19775 \begin_inset Flex Code
19778 \begin_layout Plain Layout
19784 for upper-case letters: A, B, C, \SpecialChar ldots
19786 \begin_inset Flex Code
19789 \begin_layout Plain Layout
19795 for lower-case roman numerals: i, ii, iii, \SpecialChar ldots
19797 \begin_inset Flex Code
19800 \begin_layout Plain Layout
19806 for upper-case roman numerals: I, II, III\SpecialChar ldots
19808 \begin_inset Flex Code
19811 \begin_layout Plain Layout
19817 for hebrew numerals.
19821 \begin_layout Standard
19822 If LabelString is not defined, a default value is constructed as follows:
19823 if the counter has a master counter
19824 \begin_inset Flex Code
19827 \begin_layout Plain Layout
19834 \begin_inset Flex Code
19837 \begin_layout Plain Layout
19844 \begin_inset Newline newline
19848 \begin_inset Flex Code
19851 \begin_layout Plain Layout
19861 is used; otherwise the string
19862 \begin_inset Flex Code
19865 \begin_layout Plain Layout
19876 \begin_layout Description
19877 \begin_inset Flex Code
19880 \begin_layout Plain Layout
19881 LabelStringAppendix
19887 \begin_inset Flex Code
19890 \begin_layout Plain Layout
19897 \begin_inset Quotes erd
19901 \begin_inset Quotes erd
19905 \begin_inset Flex Code
19908 \begin_layout Plain Layout
19914 , but for use in the Appendix.
19917 \begin_layout Description
19918 \begin_inset Flex Code
19921 \begin_layout Plain Layout
19928 \begin_inset Flex Code
19931 \begin_layout Plain Layout
19938 \begin_inset Quotes erd
19942 \begin_inset Quotes erd
19945 ] A format for use with formatted references to this counter.
19946 For example, one might want to have references to section numbers appear
19948 \begin_inset Quotes eld
19952 \begin_inset Quotes erd
19956 The string should contain
19957 \begin_inset Quotes eld
19961 \begin_inset Quotes erd
19965 This will be replaced by the counter number itself.
19966 So, for sections, it would be: Section ##.
19969 \begin_layout Description
19970 \begin_inset Flex Code
19973 \begin_layout Plain Layout
19980 \begin_inset Flex Code
19983 \begin_layout Plain Layout
19990 \begin_inset Quotes erd
19994 \begin_inset Quotes erd
19997 ] If this is set to the name of another counter, the present counter will
19998 be reset every time the other one is increased.
20000 \begin_inset Flex Code
20003 \begin_layout Plain Layout
20010 \begin_inset Flex Code
20013 \begin_layout Plain Layout
20022 \begin_layout Subsection
20024 \begin_inset CommandInset label
20026 name "subsec:Font-description"
20033 \begin_layout Standard
20034 A font description looks like this:
20037 \begin_layout LyX-Code
20051 \begin_layout LyX-Code
20055 \begin_layout LyX-Code
20059 \begin_layout Standard
20060 The following commands are available:
20063 \begin_layout Description
20064 \begin_inset Flex Code
20067 \begin_layout Plain Layout
20074 \begin_inset Flex Code
20077 \begin_layout Plain Layout
20086 \begin_inset Flex Code
20089 \begin_layout Plain Layout
20096 \begin_inset Flex Code
20099 \begin_layout Plain Layout
20106 \begin_inset Flex Code
20109 \begin_layout Plain Layout
20116 \begin_inset Flex Code
20119 \begin_layout Plain Layout
20126 \begin_inset Flex Code
20129 \begin_layout Plain Layout
20136 \begin_inset Flex Code
20139 \begin_layout Plain Layout
20146 \begin_inset Flex Code
20149 \begin_layout Plain Layout
20156 \begin_inset Flex Code
20159 \begin_layout Plain Layout
20168 \begin_layout Description
20169 \begin_inset Flex Code
20172 \begin_layout Plain Layout
20179 \begin_inset Flex Code
20182 \begin_layout Plain Layout
20191 \begin_inset Flex Code
20194 \begin_layout Plain Layout
20201 \begin_inset Flex Code
20204 \begin_layout Plain Layout
20213 \begin_layout Description
20214 \begin_inset Flex Code
20217 \begin_layout Plain Layout
20224 \begin_inset Flex Code
20227 \begin_layout Plain Layout
20233 ] Valid arguments are:
20234 \begin_inset Flex Code
20237 \begin_layout Plain Layout
20244 \begin_inset Flex Code
20247 \begin_layout Plain Layout
20254 \begin_inset Flex Code
20257 \begin_layout Plain Layout
20264 \begin_inset Flex Code
20267 \begin_layout Plain Layout
20274 \begin_inset Flex Code
20277 \begin_layout Plain Layout
20284 \begin_inset Flex Code
20287 \begin_layout Plain Layout
20294 \begin_inset Flex Code
20297 \begin_layout Plain Layout
20304 \begin_inset Flex Code
20307 \begin_layout Plain Layout
20314 \begin_inset Flex Code
20317 \begin_layout Plain Layout
20324 \begin_inset Flex Code
20327 \begin_layout Plain Layout
20334 \begin_inset Flex Code
20337 \begin_layout Plain Layout
20344 \begin_inset Flex Code
20347 \begin_layout Plain Layout
20354 Each of these turns on or off the corresponding attribute.
20356 \begin_inset Flex Code
20359 \begin_layout Plain Layout
20365 turns on emphasis, and
20366 \begin_inset Flex Code
20369 \begin_layout Plain Layout
20377 \begin_inset Newline newline
20380 If the latter seems puzzling, remember that the font settings for the present
20381 context are generally inherited from the surrounding context.
20383 \begin_inset Flex Code
20386 \begin_layout Plain Layout
20392 would turn off the emphasis that was anyway in effect, say, in a theorem
20396 \begin_layout Description
20397 \begin_inset Flex Code
20400 \begin_layout Plain Layout
20407 \begin_inset Flex Code
20410 \begin_layout Plain Layout
20419 \begin_inset Flex Code
20422 \begin_layout Plain Layout
20431 \begin_layout Description
20432 \begin_inset Flex Code
20435 \begin_layout Plain Layout
20442 \begin_inset Flex Code
20445 \begin_layout Plain Layout
20454 \begin_inset Flex Code
20457 \begin_layout Plain Layout
20464 \begin_inset Flex Code
20467 \begin_layout Plain Layout
20474 \begin_inset Flex Code
20477 \begin_layout Plain Layout
20486 \begin_layout Description
20487 \begin_inset Flex Code
20490 \begin_layout Plain Layout
20497 \begin_inset Flex Code
20500 \begin_layout Plain Layout
20507 \begin_inset Flex Code
20510 \begin_layout Plain Layout
20517 \begin_inset Flex Code
20520 \begin_layout Plain Layout
20529 \begin_inset Flex Code
20532 \begin_layout Plain Layout
20539 \begin_inset Flex Code
20542 \begin_layout Plain Layout
20549 \begin_inset Flex Code
20552 \begin_layout Plain Layout
20559 \begin_inset Flex Code
20562 \begin_layout Plain Layout
20569 \begin_inset Flex Code
20572 \begin_layout Plain Layout
20581 \begin_layout Subsection
20582 \begin_inset CommandInset label
20584 name "subsec:Citation-format-description"
20588 Citation format description
20591 \begin_layout Standard
20593 \begin_inset Flex Code
20596 \begin_layout Plain Layout
20602 blocks are used to describe how bibliographic information should be displayed,
20603 both within \SpecialChar LyX
20604 itself (in the citation dialog and in tooltips, for example)
20605 and in XHTML output.
20606 Such a block might look like this:
20609 \begin_layout LyX-Code
20613 \begin_layout LyX-Code
20617 \begin_layout LyX-Code
20621 \begin_layout LyX-Code
20625 \begin_layout Standard
20626 The individual lines define how the bibliographic information associated
20627 with an article or book, respectively, is to be displayed, and such a definitio
20628 n can be given for any `entry type' that might be present in a Bib\SpecialChar TeX
20631 defines a default format in the source code that will be used if no specific
20632 definition has been given.
20634 predefines several formats in the file
20635 \begin_inset Flex Code
20638 \begin_layout Plain Layout
20644 , which is included in most of \SpecialChar LyX
20645 's document classes.
20648 \begin_layout Standard
20649 The definitions use a simple language that allows Bib\SpecialChar TeX
20650 keys to be replaced
20652 Keys should be enclosed in
20653 \begin_inset Flex Code
20656 \begin_layout Plain Layout
20663 \begin_inset Flex Code
20666 \begin_layout Plain Layout
20673 So a simple definition might look like this:
20676 \begin_layout LyX-Code
20678 \begin_inset Quotes eld
20682 \begin_inset Quotes erd
20688 \begin_layout Standard
20689 This would print the author, followed by a comma, followed by the title,
20690 in quotes, followed by a period.
20693 \begin_layout Standard
20694 Of course, sometimes you may want to print a key only if it exists.
20695 This can be done by using a conditional construction, such as:
20696 \begin_inset Flex Code
20699 \begin_layout Plain Layout
20701 \begin_inset space ~
20711 \begin_inset Flex Code
20714 \begin_layout Plain Layout
20720 key exists, then print
20721 \begin_inset Quotes eld
20725 \begin_inset space ~
20729 \begin_inset Quotes erd
20732 followed by the volume key.
20733 It is also possible to have an else clause in the conditional, such as:
20734 \begin_inset Newline newline
20738 \begin_inset Flex Code
20741 \begin_layout Plain Layout
20742 {%author%[[%author%]][[%editor%, ed.]]}
20748 \begin_inset Newline newline
20752 \begin_inset Flex Code
20755 \begin_layout Plain Layout
20761 key is printed if it exists; otherwise, the editor key is printed, followed
20763 \begin_inset Quotes eld
20767 \begin_inset space ~
20771 \begin_inset Quotes erd
20774 Note that the key is again enclosed in
20775 \begin_inset Flex Code
20778 \begin_layout Plain Layout
20784 signs; the entire conditional is enclosed in braces; and the if and else
20785 clauses are enclosed in double brackets,
20786 \begin_inset Quotes eld
20790 \begin_inset Flex Code
20793 \begin_layout Plain Layout
20800 \begin_inset Quotes eld
20804 \begin_inset Quotes eld
20808 \begin_inset Flex Code
20811 \begin_layout Plain Layout
20818 \begin_inset Quotes erd
20822 There must be no space between any of these.
20825 \begin_layout Standard
20826 There is one other piece of syntax available in definitions, which looks
20828 \begin_inset Flex Code
20831 \begin_layout Plain Layout
20838 This defines a piece of formatting information that is to be used when
20840 \begin_inset Quotes eld
20844 \begin_inset Quotes erd
20848 Obviously, we do not want to output HTML tags when writing plain text,
20849 so they should be wrapped in
20850 \begin_inset Quotes eld
20854 \begin_inset Quotes erd
20858 \begin_inset Quotes eld
20862 \begin_inset Quotes erd
20868 \begin_layout Standard
20869 Two special sorts of definitions are also possible in a
20870 \begin_inset Flex Code
20873 \begin_layout Plain Layout
20880 An example of the first would be:
20883 \begin_layout LyX-Code
20885 \begin_inset Quotes eld
20889 \begin_inset Quotes erd
20895 \begin_layout Standard
20896 This is an abbreviation, or macro, and it can be used by treating it as
20898 \begin_inset Flex Code
20901 \begin_layout Plain Layout
20910 \begin_inset Flex Code
20913 \begin_layout Plain Layout
20919 exactly as it would treat its definition.
20920 So, let us issue the obvious
20928 \begin_layout LyX-Code
20932 \begin_layout Standard
20933 or anything like it.
20935 shouldn't go into an infinite loop, but it may go into a long one before
20939 \begin_layout Standard
20940 The second sort of special definition might look like this:
20943 \begin_layout LyX-Code
20947 \begin_layout Standard
20948 This defines a translatable piece of text, which allows relevant parts of
20949 the bibliography to be translated.
20950 It can be included in a definition by treating it as a key:
20951 \begin_inset Flex Code
20954 \begin_layout Plain Layout
20961 Several of these are predefined in
20962 \begin_inset Flex Code
20965 \begin_layout Plain Layout
20972 Note that these are not macros, in the sense just defined.
20973 They will not be expanded.
20976 \begin_layout Standard
20977 So here then is an example that use all these features:
20978 \begin_inset VSpace defskip
20984 \begin_layout Standard
20988 !authoredit {%author%[[%author%, ]][[{%editor%[[%editor%, %_edtext%, ]]}]]}
20991 \begin_layout Standard
20992 \begin_inset VSpace defskip
20995 This defines a macro that prints the author, followed by a comma, if the
20997 \begin_inset Flex Code
21000 \begin_layout Plain Layout
21006 key is defined, or else prints the name of the editor, followed by the
21008 \begin_inset Flex Code
21011 \begin_layout Plain Layout
21017 or its translation (it is by default
21018 \begin_inset Quotes eld
21022 \begin_inset Quotes erd
21026 \begin_inset Flex Code
21029 \begin_layout Plain Layout
21036 Note that this is in fact defined in
21037 \begin_inset Flex Code
21040 \begin_layout Plain Layout
21046 , so you can use it in your own definitions, or re-definitions, if you load
21050 \begin_layout Section
21051 \begin_inset CommandInset label
21053 name "sec:Tags-for-XHTML"
21057 Tags for XHTML output
21060 \begin_layout Standard
21061 As with \SpecialChar LaTeX
21062 or DocBook, the format of \SpecialChar LyX
21063 's XHTML output is also controlled by
21064 layout information.
21065 In general, \SpecialChar LyX
21066 provides sensible defaults and, as mentioned earlier, it will
21067 even construct default CSS style rules from the other layout tags.
21068 For example, \SpecialChar LyX
21069 will attempt to use the information provided in the
21070 \begin_inset Flex Code
21073 \begin_layout Plain Layout
21079 declaration for the Chapter style to write CSS that will appropriately
21080 format chapter headings.
21083 \begin_layout Standard
21084 In many cases, then, you may not have to do anything at all to get acceptable
21085 XHTML output for your own environments, custom insets, and so forth.
21086 But in some cases you will, and so \SpecialChar LyX
21087 provides a number of layout tags that
21088 can be used to customize the XHTML and CSS that are generated.
21091 \begin_layout Standard
21092 Note that there are two tags,
21093 \begin_inset Flex Code
21096 \begin_layout Plain Layout
21103 \begin_inset Flex Code
21106 \begin_layout Plain Layout
21112 that may appear outside style and inset declarations.
21114 \begin_inset CommandInset ref
21116 reference "subsec:General-text-class"
21120 for details on these.
21123 \begin_layout Subsection
21124 \begin_inset CommandInset label
21126 name "subsec:Paragraph-Style-XHTML"
21133 \begin_layout Standard
21134 The sort of XHTML \SpecialChar LyX
21135 outputs for a paragraph depends upon whether we are dealing
21136 with a normal paragraph, a command, or an environment, where this is itself
21137 determined by the contents of the corresponding
21138 \begin_inset Flex Code
21141 \begin_layout Plain Layout
21152 \begin_layout Standard
21153 For a command or normal paragraph, the output XHTML has the following form:
21156 \begin_layout LyX-Code
21158 \begin_inset Quotes erd
21162 \begin_inset Quotes erd
21168 \begin_layout LyX-Code
21170 \begin_inset Quotes erd
21174 \begin_inset Quotes erd
21180 \begin_layout LyX-Code
21181 Contents of the paragraph.
21184 \begin_layout LyX-Code
21188 \begin_layout Standard
21189 The label tags are of course omitted if the paragraph does not have a label.
21192 \begin_layout Standard
21193 For an environment that is not some sort of list, the XHTML takes this form:
21196 \begin_layout LyX-Code
21198 \begin_inset Quotes erd
21202 \begin_inset Quotes erd
21208 \begin_layout LyX-Code
21210 \begin_inset Quotes erd
21214 \begin_inset Quotes erd
21218 \begin_inset Quotes erd
21222 \begin_inset Quotes erd
21225 >Environment Label</labeltag>First paragraph.</itemtag>
21228 \begin_layout LyX-Code
21229 <itemtag>Second paragraph.</itemtag>
21232 \begin_layout LyX-Code
21236 \begin_layout Standard
21237 Note that the label is output only for the first paragraph, as it should
21238 be for a theorem, for example.
21242 \begin_layout Standard
21243 For a list, we have one of these forms:
21246 \begin_layout LyX-Code
21248 \begin_inset Quotes erd
21252 \begin_inset Quotes erd
21258 \begin_layout LyX-Code
21260 \begin_inset Quotes erd
21264 \begin_inset Quotes erd
21268 \begin_inset Quotes erd
21272 \begin_inset Quotes erd
21275 >List Label</labeltag>First item.</itemtag>
21278 \begin_layout LyX-Code
21280 \begin_inset Quotes erd
21284 \begin_inset Quotes erd
21288 \begin_inset Quotes erd
21292 \begin_inset Quotes erd
21295 >List Label</labeltag>Second item.</itemtag>
21298 \begin_layout LyX-Code
21302 \begin_layout LyX-Code
21306 \begin_layout LyX-Code
21308 \begin_inset Quotes erd
21312 \begin_inset Quotes erd
21318 \begin_layout LyX-Code
21320 \begin_inset Quotes erd
21324 \begin_inset Quotes erd
21327 >List Label</labeltag><itemtag attr=
21328 \begin_inset Quotes erd
21332 \begin_inset Quotes erd
21335 >First item.</itemtag>
21338 \begin_layout LyX-Code
21340 \begin_inset Quotes erd
21344 \begin_inset Quotes erd
21347 >List Label</labeltag><itemtag attr=
21348 \begin_inset Quotes erd
21352 \begin_inset Quotes erd
21355 >Second item.</itemtag>
21358 \begin_layout LyX-Code
21362 \begin_layout Standard
21363 Note the different orders of
21364 \begin_inset Flex Code
21367 \begin_layout Plain Layout
21374 \begin_inset Flex Code
21377 \begin_layout Plain Layout
21384 Which order we get depends upon the setting of
21385 \begin_inset Flex Code
21388 \begin_layout Plain Layout
21395 \begin_inset Flex Code
21398 \begin_layout Plain Layout
21404 is false (the default), you get the first of these, with the label within
21405 the item; if true, you get the second, with the label outside the item.
21408 \begin_layout Standard
21409 The specific tags and attributes output for each paragraph type can be controlle
21410 d by means of the layout tags we are about to describe.
21411 As mentioned earlier, however, \SpecialChar LyX
21412 uses sensible defaults for many of these,
21413 so you often may not need to do very much to get good XHTML output.
21414 Think of the available tags as there so you can tweak things to your liking.
21417 \begin_layout Description
21418 \begin_inset Flex Code
21421 \begin_layout Plain Layout
21428 \begin_inset Flex Code
21431 \begin_layout Plain Layout
21437 ] Specifies attribute information to be output with the main tag.
21439 \begin_inset Quotes eld
21443 \begin_inset Flex Code
21446 \begin_layout Plain Layout
21453 \begin_inset Quotes erd
21457 By default, \SpecialChar LyX
21459 \begin_inset Quotes eld
21463 \begin_inset Flex Code
21466 \begin_layout Plain Layout
21473 \begin_inset Quotes erd
21477 \begin_inset Flex Code
21480 \begin_layout Plain Layout
21486 is the \SpecialChar LyX
21487 name of the layout, made lowercase, for example: chapter.
21492 contain any style information.
21494 \begin_inset Flex Code
21497 \begin_layout Plain Layout
21506 \begin_layout Description
21507 \begin_inset Flex Code
21510 \begin_layout Plain Layout
21517 \begin_inset Flex Code
21520 \begin_layout Plain Layout
21530 ] Whether to output the default CSS information \SpecialChar LyX
21531 generates for this layout,
21532 even if additional information is explicitly provided via
21533 \begin_inset Flex Code
21536 \begin_layout Plain Layout
21544 \begin_inset Flex Code
21547 \begin_layout Plain Layout
21553 allows you to alter or augment the generated CSS, rather than to override
21556 \begin_inset Flex Code
21559 \begin_layout Plain Layout
21568 \begin_layout Description
21569 \begin_inset Flex Code
21572 \begin_layout Plain Layout
21579 \begin_inset Flex Code
21582 \begin_layout Plain Layout
21588 ] The tag to be used for individual paragraphs of environments, replacing
21590 \begin_inset Flex Code
21593 \begin_layout Plain Layout
21599 in the examples above.
21601 \begin_inset Flex Code
21604 \begin_layout Plain Layout
21613 \begin_layout Description
21614 \begin_inset Flex Code
21617 \begin_layout Plain Layout
21624 \begin_inset Flex Code
21627 \begin_layout Plain Layout
21633 ] Attributes for the item tag.
21635 \begin_inset Quotes eld
21639 \begin_inset Flex Code
21642 \begin_layout Plain Layout
21643 class=`layoutname_item'
21649 \begin_inset Quotes erd
21657 contain any style information.
21659 \begin_inset Flex Code
21662 \begin_layout Plain Layout
21671 \begin_layout Description
21672 \begin_inset Flex Code
21675 \begin_layout Plain Layout
21682 \begin_inset Flex Code
21685 \begin_layout Plain Layout
21691 ] The tag to be used for paragraph and item labels, replacing
21692 \begin_inset Flex Code
21695 \begin_layout Plain Layout
21701 in the examples above.
21703 \begin_inset Flex Code
21706 \begin_layout Plain Layout
21713 \begin_inset Flex Code
21716 \begin_layout Plain Layout
21723 \begin_inset Flex Code
21726 \begin_layout Plain Layout
21733 \begin_inset Flex Code
21736 \begin_layout Plain Layout
21737 Centered_Top_Environment
21742 , in which case it defaults to
21743 \begin_inset Flex Code
21746 \begin_layout Plain Layout
21755 \begin_layout Description
21756 \begin_inset Flex Code
21759 \begin_layout Plain Layout
21766 \begin_inset Flex Code
21769 \begin_layout Plain Layout
21775 ] Attributes for the label tag.
21777 \begin_inset Quotes eld
21781 \begin_inset Flex Code
21784 \begin_layout Plain Layout
21785 class=`layoutname_label'
21791 \begin_inset Quotes erd
21799 contain any style information.
21801 \begin_inset Flex Code
21804 \begin_layout Plain Layout
21813 \begin_layout Description
21814 \begin_inset Flex Code
21817 \begin_layout Plain Layout
21824 \begin_inset Flex Code
21827 \begin_layout Plain Layout
21837 ] Meaningful only for list-like environments, this tag controls whether
21838 the label tag is output before or inside the item tag.
21839 This is used, for example, in the description environment, where we want
21841 \begin_inset Flex Code
21844 \begin_layout Plain Layout
21845 <dt>\SpecialChar ldots
21846 </dt><dd>\SpecialChar ldots
21854 \begin_inset Flex Code
21857 \begin_layout Plain Layout
21863 : The label tag is output inside the item tag.
21866 \begin_layout Description
21867 \begin_inset Flex Code
21870 \begin_layout Plain Layout
21876 Information to be output in the
21877 \begin_inset Flex Code
21880 \begin_layout Plain Layout
21886 section when this style is used.
21887 This might, for example, be used to include a
21888 \begin_inset Flex Code
21891 \begin_layout Plain Layout
21898 \begin_inset Flex Code
21901 \begin_layout Plain Layout
21910 \begin_layout Description
21911 \begin_inset Flex Code
21914 \begin_layout Plain Layout
21920 CSS style information to be included when this style is used.
21921 Note that this will automatically be wrapped in a layout-generated
21922 \begin_inset Flex Code
21925 \begin_layout Plain Layout
21931 block, so only the CSS itself need be included.
21933 \begin_inset Flex Code
21936 \begin_layout Plain Layout
21945 \begin_layout Description
21946 \begin_inset Flex Code
21949 \begin_layout Plain Layout
21956 \begin_inset Flex Code
21959 \begin_layout Plain Layout
21965 ] The tag to be used for the main label, replacing
21966 \begin_inset Flex Code
21969 \begin_layout Plain Layout
21975 in the examples above.
21977 \begin_inset Flex Code
21980 \begin_layout Plain Layout
21989 \begin_layout Description
21990 \begin_inset Flex Code
21993 \begin_layout Plain Layout
22000 \begin_inset Flex Code
22003 \begin_layout Plain Layout
22013 ] Marks this style as the one to be used to generate the
22014 \begin_inset Flex Code
22017 \begin_layout Plain Layout
22023 tag for the XHTML file.
22024 By default, it is false.
22026 \begin_inset Flex Code
22029 \begin_layout Plain Layout
22035 file sets it to true for the
22036 \begin_inset Flex Code
22039 \begin_layout Plain Layout
22049 \begin_layout Subsection
22053 \begin_layout Standard
22054 The XHTML output of insets can also be controlled by information in layout
22059 \begin_layout Plain Layout
22060 At present, this is true only for
22061 \begin_inset Quotes eld
22065 \begin_inset Quotes erd
22068 insets (insets you can type into) and is not true for
22069 \begin_inset Quotes eld
22073 \begin_inset Quotes erd
22076 insets (insets that are associated with dialog boxes).
22081 Here, too, \SpecialChar LyX
22082 tries to provide sensible defaults, and it constructs default
22084 But everything can be customized.
22087 \begin_layout Standard
22088 The XHTML \SpecialChar LyX
22089 outputs for an inset has the following form:
22092 \begin_layout LyX-Code
22094 \begin_inset Quotes erd
22098 \begin_inset Quotes erd
22104 \begin_layout LyX-Code
22105 <labeltag>Label</labeltag>
22108 \begin_layout LyX-Code
22110 \begin_inset Quotes erd
22114 \begin_inset Quotes erd
22117 >Contents of the inset.</innertag>
22120 \begin_layout LyX-Code
22124 \begin_layout Standard
22125 If the inset permits multiple paragraphs—that is, if
22126 \begin_inset Flex Code
22129 \begin_layout Plain Layout
22135 is true—then the contents of the inset will itself be output as paragraphs
22136 formatted according to the styles used for those paragraphs (standard,
22137 quote, and the like).
22138 The label tag is of course omitted if the paragraph does not have a label
22139 and, at present, is always
22140 \begin_inset Flex Code
22143 \begin_layout Plain Layout
22150 The inner tag is optional and, by default, does not appear.
22153 \begin_layout Standard
22154 The specific tags and attributes output for each inset can be controlled
22155 by means of the following layout tags.
22158 \begin_layout Description
22159 \begin_inset Flex Code
22162 \begin_layout Plain Layout
22169 \begin_inset Flex Code
22172 \begin_layout Plain Layout
22178 ] Specifies attribute information to be output with the main tag.
22180 \begin_inset Quotes eld
22184 \begin_inset Flex Code
22187 \begin_layout Plain Layout
22188 class=`myinset' onclick=`\SpecialChar ldots
22195 \begin_inset Quotes erd
22199 By default, \SpecialChar LyX
22201 \begin_inset Quotes eld
22205 \begin_inset Flex Code
22208 \begin_layout Plain Layout
22215 \begin_inset Quotes erd
22219 \begin_inset Flex Code
22222 \begin_layout Plain Layout
22228 is the \SpecialChar LyX
22229 name of the inset, made lowercase and with non-alphanumeric characters
22230 converted to underscores, for example: footnote.
22233 \begin_layout Description
22234 \begin_inset Flex Code
22237 \begin_layout Plain Layout
22244 \begin_inset Flex Code
22247 \begin_layout Plain Layout
22257 ] Whether to output the default CSS information \SpecialChar LyX
22258 generates for this layout,
22259 even if additional information is explicitly provided via
22260 \begin_inset Flex Code
22263 \begin_layout Plain Layout
22271 \begin_inset Flex Code
22274 \begin_layout Plain Layout
22280 allows you to alter or augment the generated CSS, rather than to override
22285 \begin_layout Description
22286 \begin_inset Flex Code
22289 \begin_layout Plain Layout
22296 \begin_inset Flex Code
22299 \begin_layout Plain Layout
22305 ] Attributes for the inner tag.
22307 \begin_inset Quotes eld
22311 \begin_inset Flex Code
22314 \begin_layout Plain Layout
22315 class=`insetname_inner'
22321 \begin_inset Quotes erd
22327 \begin_layout Description
22328 \begin_inset Flex Code
22331 \begin_layout Plain Layout
22338 \begin_inset Flex Code
22341 \begin_layout Plain Layout
22347 ] The inner tag, replacing
22348 \begin_inset Flex Code
22351 \begin_layout Plain Layout
22357 in the examples above.
22358 By default, there is none.
22361 \begin_layout Description
22362 \begin_inset Flex Code
22365 \begin_layout Plain Layout
22372 \begin_inset Flex Code
22375 \begin_layout Plain Layout
22383 ] Whether this inset represents a standalone block of text (such as a footnote)
22384 or instead represents material that is included in the surrounding text
22385 (such as a branch).
22389 \begin_layout Description
22390 \begin_inset Flex Code
22393 \begin_layout Plain Layout
22400 \begin_inset Flex Code
22403 \begin_layout Plain Layout
22409 ] A label for this inset, possibly including a reference to a counter.
22410 For example, for footnote, it might be:
22411 \begin_inset Flex Code
22414 \begin_layout Plain Layout
22423 This is optional, and there is no default.
22426 \begin_layout Description
22427 \begin_inset Flex Code
22430 \begin_layout Plain Layout
22436 Information to be output in the
22437 \begin_inset Flex Code
22440 \begin_layout Plain Layout
22446 section when this style is used.
22447 This might, for example, be used to include a
22448 \begin_inset Flex Code
22451 \begin_layout Plain Layout
22458 \begin_inset Flex Code
22461 \begin_layout Plain Layout
22470 \begin_layout Description
22471 \begin_inset Flex Code
22474 \begin_layout Plain Layout
22480 CSS style information to be included when this style is used.
22481 Note that this will automatically be wrapped in a layout-generated
22482 \begin_inset Flex Code
22485 \begin_layout Plain Layout
22491 block, so only the CSS itself need be included.
22494 \begin_layout Description
22495 \begin_inset Flex Code
22498 \begin_layout Plain Layout
22505 \begin_inset Flex Code
22508 \begin_layout Plain Layout
22514 ] The tag to be used for the main label, replacing
22515 \begin_inset Flex Code
22518 \begin_layout Plain Layout
22524 in the examples above.
22525 The default depends upon the setting of
22526 \begin_inset Flex Code
22529 \begin_layout Plain Layout
22536 \begin_inset Flex Code
22539 \begin_layout Plain Layout
22545 is true, the default is
22546 \begin_inset Flex Code
22549 \begin_layout Plain Layout
22555 ; if it is false, the default is
22556 \begin_inset Flex Code
22559 \begin_layout Plain Layout
22568 \begin_layout Subsection
22572 \begin_layout Standard
22573 The XHTML output for floats too can be controlled by layout information.
22574 The output has the following form:
22577 \begin_layout LyX-Code
22579 \begin_inset Quotes erd
22583 \begin_inset Quotes erd
22589 \begin_layout LyX-Code
22590 Contents of the float.
22593 \begin_layout LyX-Code
22597 \begin_layout Standard
22598 The caption, if there is one, is a separate inset and will be output as
22600 Its appearance can be controlled via the InsetLayout for caption insets.
22604 \begin_layout Description
22605 \begin_inset Flex Code
22608 \begin_layout Plain Layout
22615 \begin_inset Flex Code
22618 \begin_layout Plain Layout
22624 ] Specifies attribute information to be output with the main tag.
22626 \begin_inset Quotes eld
22630 \begin_inset Flex Code
22633 \begin_layout Plain Layout
22634 class=`myfloat' onclick=`\SpecialChar ldots
22641 \begin_inset Quotes erd
22645 By default, \SpecialChar LyX
22647 \begin_inset Quotes eld
22651 \begin_inset Flex Code
22654 \begin_layout Plain Layout
22655 class=`float float-floattype'
22661 \begin_inset Quotes erd
22665 \begin_inset Flex Code
22668 \begin_layout Plain Layout
22674 is \SpecialChar LyX
22675 's name for this type of float, as determined by the float declaration
22677 \begin_inset CommandInset ref
22679 reference "subsec:Floats"
22683 ), though made lowercase and with non-alphanumeric characters converted
22684 to underscores, for example: float-table.
22687 \begin_layout Description
22688 \begin_inset Flex Code
22691 \begin_layout Plain Layout
22697 CSS style information to be included when this float is used.
22698 Note that this will automatically be wrapped in a layout-generated
22699 \begin_inset Flex Code
22702 \begin_layout Plain Layout
22708 block, so only the CSS itself need be included.
22711 \begin_layout Description
22712 \begin_inset Flex Code
22715 \begin_layout Plain Layout
22722 \begin_inset Flex Code
22725 \begin_layout Plain Layout
22731 ] The tag to be used for this float, replacing
22732 \begin_inset Quotes eld
22736 \begin_inset Flex Code
22739 \begin_layout Plain Layout
22746 \begin_inset Quotes erd
22749 in the example above.
22751 \begin_inset Flex Code
22754 \begin_layout Plain Layout
22760 and will rarely need changing.
22763 \begin_layout Subsection
22764 Bibliography formatting
22767 \begin_layout Standard
22768 The bibliography can be formatted using
22769 \begin_inset Flex Code
22772 \begin_layout Plain Layout
22780 \begin_inset CommandInset ref
22782 reference "subsec:Citation-format-description"
22789 \begin_layout Subsection
22794 \begin_layout Standard
22795 We have several times mentioned that \SpecialChar LyX
22796 will generate default CSS style rules
22797 for both insets and paragraph styles, based upon the other layout information
22799 In this section, we shall say a word about which layout information \SpecialChar LyX
22804 \begin_layout Standard
22805 At present, \SpecialChar LyX
22806 auto-generates CSS only for font information, making use of
22808 \begin_inset Flex Code
22811 \begin_layout Plain Layout
22818 \begin_inset Flex Code
22821 \begin_layout Plain Layout
22828 \begin_inset Flex Code
22831 \begin_layout Plain Layout
22838 \begin_inset Flex Code
22841 \begin_layout Plain Layout
22848 \begin_inset Flex Code
22851 \begin_layout Plain Layout
22858 \begin_inset CommandInset ref
22860 reference "subsec:Font-description"
22865 The translation is mostly straightforward and obvious.
22867 \begin_inset Quotes eld
22871 \begin_inset Flex Code
22874 \begin_layout Plain Layout
22881 \begin_inset Quotes erd
22885 \begin_inset Quotes eld
22889 \begin_inset Flex Code
22892 \begin_layout Plain Layout
22893 font-family: sans-serif;
22899 \begin_inset Quotes erd
22903 The correspondence of \SpecialChar LyX
22904 sizes and CSS sizes is a little less obvious but
22905 nonetheless intuitive.
22907 \begin_inset Flex Code
22910 \begin_layout Plain Layout
22917 \begin_inset Flex URL
22920 \begin_layout Plain Layout
22930 \begin_layout Chapter
22931 Including External Material
22932 \begin_inset CommandInset label
22934 name "chap:Including-External-Material"
22941 \begin_layout Standard
22942 \begin_inset Box Shadowbox
22952 height_special "totalheight"
22957 backgroundcolor "none"
22960 \begin_layout Plain Layout
22961 WARNING: This portion of the documentation has not been updated for some
22963 We certainly hope that it is still accurate, but there are no guarantees.
22971 \begin_layout Standard
22972 The use of material from sources external to \SpecialChar LyX
22973 is covered in detail in the
22979 This part of the manual covers what needs to happen behind the scenes for
22980 new sorts of material to be included.
22983 \begin_layout Section
22987 \begin_layout Standard
22988 The external material feature is based on the concept of a
22993 A template is a specification of how \SpecialChar LyX
22994 should interface with a certain kind
22996 As bundled, \SpecialChar LyX
22997 comes with predefined templates for Xfig figures, various
22998 raster format images, chess diagrams, and LilyPond music notation.
22999 You can check the actual list by using the menu
23000 \begin_inset Flex MenuItem
23003 \begin_layout Plain Layout
23004 Insert\SpecialChar menuseparator
23005 File\SpecialChar menuseparator
23012 Furthermore, it is possible to roll your own template to support a specific
23014 Later we'll describe in more detail what is involved, and hopefully you
23015 will submit all the templates you create so we can include them in a later
23020 \begin_layout Standard
23021 Another basic idea of the external material feature is to distinguish between
23022 the original file that serves as a base for final material and the produced
23023 file that is included in your exported or printed document.
23024 For example, consider the case of a figure produced with
23025 \begin_inset Flex Code
23028 \begin_layout Plain Layout
23035 The Xfig application itself works on an original file with the
23036 \begin_inset Flex Code
23039 \begin_layout Plain Layout
23046 Within Xfig, you create and change your figure, and when you are done,
23048 \begin_inset Flex Code
23051 \begin_layout Plain Layout
23058 When you want to include the figure in your document, you invoke
23059 \begin_inset Flex Code
23062 \begin_layout Plain Layout
23068 in order to create a PostScript file that can readily be included in your
23072 \begin_inset Flex Code
23075 \begin_layout Plain Layout
23081 file is the original file, and the PostScript file is the produced file.
23084 \begin_layout Standard
23085 This distinction is important in order to allow updating of the material
23086 while you are in the process of writing the document.
23087 Furthermore, it provides us with the flexibility that is needed to support
23088 multiple export formats.
23089 For instance, in the case of a plain text file, it is not exactly an award-winn
23090 ing idea to include the figure as raw PostScript.
23091 Instead, you would either prefer to just include a reference to the figure
23092 or try to invoke some graphics to ASCII converter to make the final result
23093 look similar to the real graphics.
23094 The external material management allows you to do this, because it is parametri
23095 zed on the different export formats that \SpecialChar LyX
23099 \begin_layout Standard
23100 Besides supporting the production of different products according to the
23101 exported format, it supports tight integration with editing and viewing
23103 In the case of an Xfig figure, you are able to invoke Xfig on the original
23104 file with a single click from within the external material dialog in \SpecialChar LyX
23106 and also preview the produced PostScript file with Ghostview with another
23108 No more fiddling around with the command line and/or file browsers to locate
23109 and manipulate the original or produced files.
23110 In this way, you are finally able to take full advantage of the many different
23111 applications that are relevant to use when you write your documents, and
23112 ultimately be more productive.
23115 \begin_layout Section
23116 The external template configuration file
23119 \begin_layout Standard
23120 It is relatively easy to add custom external template definitions to \SpecialChar LyX
23122 However, be aware that doing this in an careless manner most probably
23126 introduce an easily exploitable security hole.
23127 So before you do this, please read the discussion about security in
23128 \begin_inset CommandInset ref
23130 reference "sec:Security-discussion"
23137 \begin_layout Standard
23138 Having said that, we encourage you to submit any interesting templates that
23143 \begin_layout Standard
23144 The external templates are defined in the
23145 \begin_inset Flex Code
23148 \begin_layout Plain Layout
23150 \change_deleted -712698321 1437634905
23153 \change_inserted -712698321 1437634906
23156 Dir/lib/external_templates
23162 You can place your own version in
23163 \begin_inset Flex Code
23166 \begin_layout Plain Layout
23167 UserDir/external_templates
23175 \begin_layout Standard
23176 A typical template looks like this:
23179 \begin_layout LyX-Code
23183 \begin_layout LyX-Code
23184 GuiName "XFig: $$AbsOrRelPathParent$$Basename"
23187 \begin_layout LyX-Code
23191 \begin_layout LyX-Code
23195 \begin_layout LyX-Code
23199 \begin_layout LyX-Code
23203 \begin_layout LyX-Code
23207 \begin_layout LyX-Code
23208 AutomaticProduction true
23211 \begin_layout LyX-Code
23215 \begin_layout LyX-Code
23219 \begin_layout LyX-Code
23220 Format \SpecialChar LaTeX
23224 \begin_layout LyX-Code
23225 TransformCommand Rotate RotationLatexCommand
23228 \begin_layout LyX-Code
23229 TransformCommand Resize ResizeLatexCommand
23232 \begin_layout LyX-Code
23233 Product "$$RotateFront$$ResizeFront
23236 \begin_layout LyX-Code
23241 input{$$AbsOrRelPathMaster$$Basename.pstex_t}
23244 \begin_layout LyX-Code
23245 $$ResizeBack$$RotateBack"
23248 \begin_layout LyX-Code
23252 \begin_layout LyX-Code
23253 UpdateResult "$$AbsPath$$Basename.pstex_t"
23256 \begin_layout LyX-Code
23257 Requirement "graphicx"
23260 \begin_layout LyX-Code
23261 ReferencedFile latex "$$AbsOrRelPathMaster$$Basename.pstex_t"
23264 \begin_layout LyX-Code
23265 ReferencedFile latex "$$AbsPath$$Basename.eps"
23268 \begin_layout LyX-Code
23269 ReferencedFile dvi "$$AbsPath$$Basename.eps"
23272 \begin_layout LyX-Code
23276 \begin_layout LyX-Code
23277 Format PDF\SpecialChar LaTeX
23281 \begin_layout LyX-Code
23282 TransformCommand Rotate RotationLatexCommand
23285 \begin_layout LyX-Code
23286 TransformCommand Resize ResizeLatexCommand
23289 \begin_layout LyX-Code
23290 Product "$$RotateFront$$ResizeFront
23293 \begin_layout LyX-Code
23298 input{$$AbsOrRelPathMaster$$Basename.pdftex_t}
23301 \begin_layout LyX-Code
23302 $$ResizeBack$$RotateBack"
23305 \begin_layout LyX-Code
23306 UpdateFormat pdftex
23309 \begin_layout LyX-Code
23310 UpdateResult "$$AbsPath$$Basename.pdftex_t"
23313 \begin_layout LyX-Code
23314 Requirement "graphicx"
23317 \begin_layout LyX-Code
23318 ReferencedFile latex "$$AbsOrRelPathMaster$$Basename.pdftex_t"
23321 \begin_layout LyX-Code
23322 ReferencedFile latex "$$AbsPath$$Basename.pdf"
23325 \begin_layout LyX-Code
23329 \begin_layout LyX-Code
23333 \begin_layout LyX-Code
23334 Product "$$Contents(
23336 "$$AbsPath$$Basename.asc
23341 \begin_layout LyX-Code
23342 UpdateFormat asciixfig
23345 \begin_layout LyX-Code
23346 UpdateResult "$$AbsPath$$Basename.asc"
23349 \begin_layout LyX-Code
23353 \begin_layout LyX-Code
23357 \begin_layout LyX-Code
23358 Product "<graphic fileref=
23360 "$$AbsOrRelPathMaster$$Basename.eps
23365 \begin_layout LyX-Code
23369 \begin_layout LyX-Code
23373 \begin_layout LyX-Code
23374 UpdateResult "$$AbsPath$$Basename.eps"
23377 \begin_layout LyX-Code
23378 ReferencedFile docbook "$$AbsPath$$Basename.eps"
23381 \begin_layout LyX-Code
23382 ReferencedFile docbook-xml "$$AbsPath$$Basename.eps"
23385 \begin_layout LyX-Code
23389 \begin_layout LyX-Code
23390 Product "[XFig: $$FName]"
23393 \begin_layout LyX-Code
23397 \begin_layout LyX-Code
23401 \begin_layout Standard
23402 As you can see, the template is enclosed in
23403 \begin_inset Flex Code
23406 \begin_layout Plain Layout
23414 \begin_inset Flex Code
23417 \begin_layout Plain Layout
23424 It contains a header specifying some general settings and, for each supported
23425 primary document file format, a section
23426 \begin_inset Flex Code
23429 \begin_layout Plain Layout
23437 \begin_inset Flex Code
23440 \begin_layout Plain Layout
23449 \begin_layout Subsection
23450 The template header
23453 \begin_layout Description
23454 \begin_inset Flex Code
23457 \begin_layout Plain Layout
23458 AutomaticProduction
23459 \begin_inset space ~
23467 Whether the file represented by the template must be generated by \SpecialChar LyX
23469 This command must occur exactly once.
23472 \begin_layout Description
23473 \begin_inset Flex Code
23476 \begin_layout Plain Layout
23478 \begin_inset space ~
23486 A glob pattern that is used in the file dialog to filter out the desired
23488 If there is more than one possible file extension (e.
23489 \begin_inset space \thinspace{}
23493 \begin_inset space \space{}
23497 \begin_inset Flex Code
23500 \begin_layout Plain Layout
23507 \begin_inset Flex Code
23510 \begin_layout Plain Layout
23516 ), use something like
23517 \begin_inset Flex Code
23520 \begin_layout Plain Layout
23527 This command must occur exactly once.
23530 \begin_layout Description
23531 \begin_inset Flex Code
23534 \begin_layout Plain Layout
23536 \begin_inset space ~
23544 The text that is displayed on the button.
23545 This command must occur exactly once.
23548 \begin_layout Description
23549 \begin_inset Flex Code
23552 \begin_layout Plain Layout
23554 \begin_inset space ~
23558 \begin_inset space ~
23566 The help text that is used in the External dialog.
23567 Provide enough information to explain to the user just what the template
23568 can provide him with.
23569 This command must occur exactly once.
23572 \begin_layout Description
23573 \begin_inset Flex Code
23576 \begin_layout Plain Layout
23578 \begin_inset space ~
23586 The file format of the original file.
23587 This must be the name of a format that is known to \SpecialChar LyX
23589 \begin_inset CommandInset ref
23591 reference "sec:Formats"
23597 \begin_inset Quotes eld
23601 \begin_inset Flex Code
23604 \begin_layout Plain Layout
23611 \begin_inset Quotes erd
23614 if the template can handle original files of more than one format.
23616 will attempt to interrogate the file itself in order to deduce its format
23618 This command must occur exactly once.
23621 \begin_layout Description
23622 \begin_inset Flex Code
23625 \begin_layout Plain Layout
23627 \begin_inset space ~
23635 A unique name for the template.
23636 It must not contain substitution macros (see below).
23639 \begin_layout Description
23640 \begin_inset Flex Code
23643 \begin_layout Plain Layout
23645 \begin_inset space ~
23648 Rotate|Resize|Clip|Extra
23653 This command specifies which transformations are supported by this template.
23654 It may occur zero or more times.
23655 This command enables the corresponding tabs in the external dialog.
23657 \begin_inset Flex Code
23660 \begin_layout Plain Layout
23666 command must have either a corresponding
23667 \begin_inset Flex Code
23670 \begin_layout Plain Layout
23677 \begin_inset Flex Code
23680 \begin_layout Plain Layout
23687 \begin_inset Flex Code
23690 \begin_layout Plain Layout
23697 Otherwise the transformation will not be supported by that format.
23700 \begin_layout Subsection
23704 \begin_layout Description
23705 \begin_inset Flex Code
23708 \begin_layout Plain Layout
23710 \begin_inset space ~
23714 \change_inserted -195340706 1437418821
23716 \change_inserted -712698321 1437634430
23718 \change_deleted -712698321 1437634429
23720 \change_inserted -195340706 1437418821
23722 \change_deleted -195340706 1437418827
23727 \change_inserted -195340706 1437418856
23729 \change_inserted -712698321 1437634432
23731 \change_deleted -712698321 1437634432
23733 \change_inserted -195340706 1437418856
23735 \change_deleted -195340706 1437418857
23744 The primary document file format that this format definition is for.
23745 Not every template has a sensible representation in all document file formats.
23746 Please define nevertheless a
23747 \begin_inset Flex Code
23750 \begin_layout Plain Layout
23756 section for all templates.
23757 Use a dummy text when no representation is available.
23758 Then you can at least see a reference to the external material in the exported
23762 \begin_layout Description
23763 \begin_inset Flex Code
23766 \begin_layout Plain Layout
23768 \begin_inset space ~
23772 \begin_inset space ~
23780 This command defines an additional macro
23781 \begin_inset Flex Code
23784 \begin_layout Plain Layout
23790 for substitution in
23791 \begin_inset Flex Code
23794 \begin_layout Plain Layout
23802 \begin_inset Flex Code
23805 \begin_layout Plain Layout
23811 itself may contain substitution macros.
23812 The advantage over using
23813 \begin_inset Flex Code
23816 \begin_layout Plain Layout
23823 \begin_inset Flex Code
23826 \begin_layout Plain Layout
23832 is that the substituted value of
23833 \begin_inset Flex Code
23836 \begin_layout Plain Layout
23842 is sanitized so that it is a valid optional argument in the document format.
23843 This command may occur zero or more times.
23846 \begin_layout Description
23847 \begin_inset Flex Code
23850 \begin_layout Plain Layout
23852 \begin_inset space ~
23860 The text that is inserted in the exported document.
23861 This is actually the most important command and can be quite complex.
23862 This command must occur exactly once.
23865 \begin_layout Description
23866 \begin_inset Flex Code
23869 \begin_layout Plain Layout
23871 \begin_inset space ~
23879 This command specifies a preamble snippet that will be included in the
23882 It has to be defined using
23883 \begin_inset Flex Code
23886 \begin_layout Plain Layout
23894 \begin_inset Flex Code
23897 \begin_layout Plain Layout
23904 This command may occur zero or more times.
23907 \begin_layout Description
23908 \begin_inset Flex Code
23911 \begin_layout Plain Layout
23913 \begin_inset space ~
23917 \begin_inset space ~
23925 This command denotes files that are created by the conversion process and
23926 are needed for a particular export format.
23927 If the filename is relative, it is interpreted relative to the master document.
23928 This command may be given zero or more times.
23931 \begin_layout Description
23932 \begin_inset Flex Code
23935 \begin_layout Plain Layout
23937 \begin_inset space ~
23945 The name of a required \SpecialChar LaTeX
23947 The package is included via
23948 \begin_inset Flex Code
23951 \begin_layout Plain Layout
23959 in the \SpecialChar LaTeX
23961 This command may occur zero or more times.
23964 \begin_layout Description
23965 \begin_inset Flex Code
23968 \begin_layout Plain Layout
23970 \begin_inset space ~
23974 \begin_inset space ~
23977 RotationLatexCommand
23982 This command specifies that the built in \SpecialChar LaTeX
23983 command should be used for rotation.
23984 This command may occur once or not at all.
23987 \begin_layout Description
23988 \begin_inset Flex Code
23991 \begin_layout Plain Layout
23993 \begin_inset space ~
23997 \begin_inset space ~
24005 This command specifies that the built in \SpecialChar LaTeX
24006 command should be used for resizing.
24007 This command may occur once or not at all.
24010 \begin_layout Description
24011 \begin_inset Flex Code
24014 \begin_layout Plain Layout
24016 \begin_inset space ~
24020 \begin_inset space ~
24023 RotationLatexOption
24028 This command specifies that rotation is done via an optional argument.
24029 This command may occur once or not at all.
24032 \begin_layout Description
24033 \begin_inset Flex Code
24036 \begin_layout Plain Layout
24038 \begin_inset space ~
24042 \begin_inset space ~
24050 This command specifies that resizing is done via an optional argument.
24051 This command may occur once or not at all.
24054 \begin_layout Description
24055 \begin_inset Flex Code
24058 \begin_layout Plain Layout
24060 \begin_inset space ~
24064 \begin_inset space ~
24072 This command specifies that clipping is done via an optional argument.
24073 This command may occur once or not at all.
24076 \begin_layout Description
24077 \begin_inset Flex Code
24080 \begin_layout Plain Layout
24082 \begin_inset space ~
24086 \begin_inset space ~
24094 This command specifies that an extra optional argument is used.
24095 This command may occur once or not at all.
24098 \begin_layout Description
24099 \begin_inset Flex Code
24102 \begin_layout Plain Layout
24104 \begin_inset space ~
24112 The file format of the converted file.
24113 This must be the name of a format that is known to \SpecialChar LyX
24115 \begin_inset Flex MenuItem
24118 \begin_layout Plain Layout
24119 Tools\SpecialChar menuseparator
24120 Preferences\SpecialChar menuseparator
24121 File Handling\SpecialChar menuseparator
24128 This command must occur exactly once.
24129 If the resulting file format is PDF, you need to specify the format
24130 \begin_inset Flex Code
24133 \begin_layout Plain Layout
24140 This is the PDF format used for including graphics.
24141 The other defined PDF formats are for document export.
24144 \begin_layout Description
24145 \begin_inset Flex Code
24148 \begin_layout Plain Layout
24150 \begin_inset space ~
24158 The file name of the converted file.
24159 The file name must be absolute.
24160 This command must occur exactly once.
24163 \begin_layout Subsection
24164 Preamble definitions
24167 \begin_layout Standard
24168 The external template configuration file may contain additional preamble
24169 definitions enclosed by
24170 \begin_inset Flex Code
24173 \begin_layout Plain Layout
24181 \begin_inset Flex Code
24184 \begin_layout Plain Layout
24191 They can be used by the templates in the
24192 \begin_inset Flex Code
24195 \begin_layout Plain Layout
24204 \begin_layout Section
24205 The substitution mechanism
24208 \begin_layout Standard
24209 When the external material facility invokes an external program, it is done
24210 on the basis of a command defined in the template configuration file.
24211 These commands can contain various macros that are expanded before execution.
24212 Execution always take place in the directory of the containing document.
24215 \begin_layout Standard
24216 Also, whenever external material is to be displayed, the name will be produced
24217 by the substitution mechanism, and most other commands in the template
24218 definition support substitution as well.
24221 \begin_layout Standard
24222 The available macros are the following:
24225 \begin_layout Description
24226 \begin_inset Flex Code
24229 \begin_layout Plain Layout
24230 $$AbsOrRelPathMaster
24235 The file path, absolute or relative to the master \SpecialChar LyX
24239 \begin_layout Description
24240 \begin_inset Flex Code
24243 \begin_layout Plain Layout
24244 $$AbsOrRelPathParent
24249 The file path, absolute or relative to the \SpecialChar LyX
24253 \begin_layout Description
24254 \begin_inset Flex Code
24257 \begin_layout Plain Layout
24263 The absolute file path.
24266 \begin_layout Description
24267 \begin_inset Flex Code
24270 \begin_layout Plain Layout
24276 The filename without path and without the extension.
24279 \begin_layout Description
24280 \begin_inset Flex Code
24283 \begin_layout Plain Layout
24285 \begin_inset Quotes eld
24289 \begin_inset Quotes erd
24297 This macro will expand to the contents of the file with the name
24298 \begin_inset Flex Code
24301 \begin_layout Plain Layout
24310 \begin_layout Description
24311 \begin_inset Flex Code
24314 \begin_layout Plain Layout
24320 The file extension (including the dot).
24321 \change_inserted -195340706 1437418878
24325 \begin_layout Description
24327 \change_inserted -195340706 1437418878
24328 \begin_inset Flex Code
24331 \begin_layout Plain Layout
24333 \change_inserted -195340706 1437418878
24339 This will be the string
24340 \begin_inset Quotes eld
24344 \begin_inset Quotes erd
24347 if the file is in JPEG format, otherwise it will be the string
24348 \begin_inset Quotes eld
24352 \begin_inset Quotes erd
24356 This is useful to avoid uneeded conversions for output formats that support
24357 both PNG and JPEG fomats.
24358 The predefined RasterImage template uses this macro for the PDFL
24359 \change_deleted -712698321 1437634446
24361 \change_inserted -712698321 1437634446
24363 \change_inserted -195340706 1437418878
24369 \begin_layout Description
24370 \begin_inset Flex Code
24373 \begin_layout Plain Layout
24379 The filename of the file specified in the external material dialog.
24380 This is either an absolute name, or it is relative to the \SpecialChar LyX
24384 \begin_layout Description
24385 \begin_inset Flex Code
24388 \begin_layout Plain Layout
24395 \begin_inset Flex Code
24398 \begin_layout Plain Layout
24404 (absolute name or relative to the \SpecialChar LyX
24408 \begin_layout Description
24409 \begin_inset Flex Code
24412 \begin_layout Plain Layout
24418 The file path, relative to the master \SpecialChar LyX
24422 \begin_layout Description
24423 \begin_inset Flex Code
24426 \begin_layout Plain Layout
24432 The file path, relative to the \SpecialChar LyX
24436 \begin_layout Description
24437 \begin_inset Flex Code
24440 \begin_layout Plain Layout
24446 This macro will expand to the absolute path of the system directory.
24447 This is typically used to point to the various helper scripts that are
24448 bundled with \SpecialChar LyX
24452 \begin_layout Description
24453 \begin_inset Flex Code
24456 \begin_layout Plain Layout
24462 A name and full path to a temporary file which will be automatically deleted
24463 whenever the containing document is closed, or the external material insertion
24467 \begin_layout Standard
24468 All path macros contain a trailing directory separator, so you can construct
24470 \begin_inset space \thinspace{}
24474 \begin_inset space \space{}
24477 the absolute filename with
24478 \begin_inset Flex Code
24481 \begin_layout Plain Layout
24482 $$AbsPath$$Basename$$Extension
24490 \begin_layout Standard
24491 The macros above are substituted in all commands unless otherwise noted.
24493 \begin_inset Flex Code
24496 \begin_layout Plain Layout
24502 supports additionally the following substitutions if they are enabled by
24504 \begin_inset Flex Code
24507 \begin_layout Plain Layout
24514 \begin_inset Flex Code
24517 \begin_layout Plain Layout
24526 \begin_layout Description
24527 \begin_inset Flex Code
24530 \begin_layout Plain Layout
24536 The front part of the resize command.
24539 \begin_layout Description
24540 \begin_inset Flex Code
24543 \begin_layout Plain Layout
24549 The back part of the resize command.
24552 \begin_layout Description
24553 \begin_inset Flex Code
24556 \begin_layout Plain Layout
24562 The front part of the rotation command.
24565 \begin_layout Description
24566 \begin_inset Flex Code
24569 \begin_layout Plain Layout
24575 The back part of the rotation command.
24578 \begin_layout Standard
24579 The value string of the
24580 \begin_inset Flex Code
24583 \begin_layout Plain Layout
24589 command supports additionally the following substitutions if they are enabled
24591 \begin_inset Flex Code
24594 \begin_layout Plain Layout
24601 \begin_inset Flex Code
24604 \begin_layout Plain Layout
24613 \begin_layout Description
24614 \begin_inset Flex Code
24617 \begin_layout Plain Layout
24626 \begin_layout Description
24627 \begin_inset Flex Code
24630 \begin_layout Plain Layout
24639 \begin_layout Description
24640 \begin_inset Flex Code
24643 \begin_layout Plain Layout
24652 \begin_layout Description
24653 \begin_inset Flex Code
24656 \begin_layout Plain Layout
24662 The rotation option.
24665 \begin_layout Standard
24666 You may ask why there are so many path macros.
24667 There are mainly two reasons:
24670 \begin_layout Enumerate
24671 Relative and absolute file names should remain relative or absolute, respectivel
24673 Users may have reasons to prefer either form.
24674 Relative names are useful for portable documents that should work on different
24675 machines, for example.
24676 Absolute names may be required by some programs.
24679 \begin_layout Enumerate
24681 treats relative file names differently than \SpecialChar LyX
24682 and other programs in nested
24684 For \SpecialChar LyX
24685 , a relative file name is always relative to the document that contains
24687 For \SpecialChar LaTeX
24688 , it is always relative to the master document.
24689 These two definitions are identical if you have only one document, but
24690 differ if you have a master document that includes part documents.
24691 That means that relative filenames must be transformed when presented to
24694 Fortunately \SpecialChar LyX
24695 does this automatically for you if you choose the right macros.
24698 \begin_layout Standard
24699 So which path macro should be used in new template definitions? The rule
24703 \begin_layout Itemize
24705 \begin_inset Flex Code
24708 \begin_layout Plain Layout
24714 if an absolute path is required.
24717 \begin_layout Itemize
24719 \begin_inset Flex Code
24722 \begin_layout Plain Layout
24723 $$AbsOrRelPathMaster
24728 if the substituted string is some kind of \SpecialChar LaTeX
24732 \begin_layout Itemize
24734 \begin_inset Flex Code
24737 \begin_layout Plain Layout
24738 $$AbsOrRelPathParent
24743 in order to preserve the user's choice.
24746 \begin_layout Standard
24747 There are special cases where this rule does not work and e.
24748 \begin_inset space \thinspace{}
24752 \begin_inset space \space{}
24755 relative names are needed, but normally it will work just fine.
24756 One example for such a case is the command
24757 \begin_inset Flex Code
24760 \begin_layout Plain Layout
24761 ReferencedFile latex "$$AbsOrRelPathMaster$$Basename.pstex_t"
24766 in the XFig template above: We can't use the absolute name because the
24768 \begin_inset Flex Code
24771 \begin_layout Plain Layout
24777 files needs the relative name in order to rewrite the file content.
24780 \begin_layout Section
24781 Security discussion
24782 \begin_inset CommandInset label
24784 name "sec:Security-discussion"
24791 \begin_layout Standard
24792 The external material feature interfaces with a lot of external programs
24793 and does so automatically, so we have to consider the security implications
24795 In particular, since you have the option of including your own filenames
24796 and/or parameter strings and those are expanded into a command, it seems
24797 that it would be possible to create a malicious document which executes
24798 arbitrary commands when a user views or prints the document.
24799 This is something we definitely want to avoid.
24802 \begin_layout Standard
24803 However, since the external program commands are specified in the template
24804 configuration file only, there are no security issues if \SpecialChar LyX
24805 is properly configure
24806 d with safe templates only.
24807 This is so because the external programs are invoked with the
24808 \begin_inset Flex Code
24811 \begin_layout Plain Layout
24817 -system call rather than the
24818 \begin_inset Flex Code
24821 \begin_layout Plain Layout
24827 system-call, so it's not possible to execute arbitrary commands from the
24828 filename or parameter section via the shell.
24831 \begin_layout Standard
24832 This also implies that you are restricted in what command strings you can
24833 use in the external material templates.
24834 In particular, pipes and redirection are not readily available.
24835 This has to be so if \SpecialChar LyX
24836 should remain safe.
24837 If you want to use some of the shell features, you should write a safe
24838 script to do this in a controlled manner, and then invoke the script from
24839 the command string.
24843 \begin_layout Standard
24844 It is possible to design a template that interacts directly with the shell,
24845 but since this would allow a malicious user to execute arbitrary commands
24846 by writing clever filenames and/or parameters, we generally recommend that
24847 you only use safe scripts that work with the
24848 \begin_inset Flex Code
24851 \begin_layout Plain Layout
24857 system call in a controlled manner.
24858 Of course, for use in a controlled environment, it can be tempting to just
24859 fall back to use ordinary shell scripts.
24860 If you do so, be aware that you
24864 provide an easily exploitable security hole in your system.
24865 Of course it stands to reason that such unsafe templates will never be
24866 included in the standard \SpecialChar LyX
24867 distribution, although we do encourage people
24868 to submit new templates in the open source tradition.
24869 But \SpecialChar LyX
24870 as shipped from the official distribution channels will never have
24874 \begin_layout Standard
24875 Including external material provides a lot of power, and you have to be
24876 careful not to introduce security hazards with this power.
24877 A subtle error in a single line in an innocent looking script can open
24878 the door to huge security problems.
24879 So if you do not fully understand the issues, we recommend that you consult
24880 a knowledgeable security professional or the \SpecialChar LyX
24881 development team if you have
24882 any questions about whether a given template is safe or not.
24883 And do this before you use it in an uncontrolled environment.
24886 \begin_layout Chapter
24888 List of supported \SpecialChar LyX
24889 functions to be used in layouts
24890 \begin_inset CommandInset label
24892 name "chap:List-of-functions"
24899 \begin_layout Standard
24901 \begin_inset Tabular
24902 <lyxtabular version="3" rows="11" columns="8">
24903 <features tabularvalignment="middle">
24904 <column alignment="left" valignment="top">
24905 <column alignment="left" valignment="top">
24906 <column alignment="left" valignment="top">
24907 <column alignment="left" valignment="top">
24908 <column alignment="left" valignment="top">
24909 <column alignment="left" valignment="top">
24910 <column alignment="left" valignment="top">
24911 <column alignment="left" valignment="top">
24913 <cell alignment="left" valignment="top" usebox="none">
24916 \begin_layout Plain Layout
24922 <cell alignment="left" valignment="top" usebox="none">
24925 \begin_layout Plain Layout
24931 <cell alignment="left" valignment="top" usebox="none">
24934 \begin_layout Plain Layout
24940 <cell alignment="left" valignment="top" usebox="none">
24943 \begin_layout Plain Layout
24949 <cell alignment="center" valignment="top" usebox="none">
24952 \begin_layout Plain Layout
24958 <cell alignment="center" valignment="top" usebox="none">
24961 \begin_layout Plain Layout
24967 <cell alignment="center" valignment="top" usebox="none">
24970 \begin_layout Plain Layout
24976 <cell alignment="center" valignment="top" usebox="none">
24979 \begin_layout Plain Layout
24987 <cell alignment="left" valignment="top" usebox="none">
24990 \begin_layout Plain Layout
24996 <cell alignment="left" valignment="top" usebox="none">
24999 \begin_layout Plain Layout
25005 <cell alignment="left" valignment="top" usebox="none">
25008 \begin_layout Plain Layout
25014 <cell alignment="left" valignment="top" usebox="none">
25017 \begin_layout Plain Layout
25023 <cell alignment="center" valignment="top" usebox="none">
25026 \begin_layout Plain Layout
25032 <cell alignment="center" valignment="top" usebox="none">
25035 \begin_layout Plain Layout
25041 <cell alignment="center" valignment="top" usebox="none">
25044 \begin_layout Plain Layout
25050 <cell alignment="center" valignment="top" usebox="none">
25053 \begin_layout Plain Layout
25061 <cell alignment="left" valignment="top" usebox="none">
25064 \begin_layout Plain Layout
25070 <cell alignment="left" valignment="top" usebox="none">
25073 \begin_layout Plain Layout
25079 <cell alignment="left" valignment="top" usebox="none">
25082 \begin_layout Plain Layout
25088 <cell alignment="left" valignment="top" usebox="none">
25091 \begin_layout Plain Layout
25097 <cell alignment="center" valignment="top" usebox="none">
25100 \begin_layout Plain Layout
25106 <cell alignment="center" valignment="top" usebox="none">
25109 \begin_layout Plain Layout
25115 <cell alignment="center" valignment="top" usebox="none">
25118 \begin_layout Plain Layout
25124 <cell alignment="center" valignment="top" usebox="none">
25127 \begin_layout Plain Layout
25135 <cell alignment="left" valignment="top" usebox="none">
25138 \begin_layout Plain Layout
25144 <cell alignment="left" valignment="top" usebox="none">
25147 \begin_layout Plain Layout
25153 <cell alignment="left" valignment="top" usebox="none">
25156 \begin_layout Plain Layout
25162 <cell alignment="left" valignment="top" usebox="none">
25165 \begin_layout Plain Layout
25171 <cell alignment="center" valignment="top" usebox="none">
25174 \begin_layout Plain Layout
25180 <cell alignment="center" valignment="top" usebox="none">
25183 \begin_layout Plain Layout
25189 <cell alignment="center" valignment="top" usebox="none">
25192 \begin_layout Plain Layout
25198 <cell alignment="center" valignment="top" usebox="none">
25201 \begin_layout Plain Layout
25209 <cell alignment="left" valignment="top" usebox="none">
25212 \begin_layout Plain Layout
25218 <cell alignment="left" valignment="top" usebox="none">
25221 \begin_layout Plain Layout
25227 <cell alignment="left" valignment="top" usebox="none">
25230 \begin_layout Plain Layout
25236 <cell alignment="left" valignment="top" usebox="none">
25239 \begin_layout Plain Layout
25245 <cell alignment="center" valignment="top" usebox="none">
25248 \begin_layout Plain Layout
25254 <cell alignment="center" valignment="top" usebox="none">
25257 \begin_layout Plain Layout
25263 <cell alignment="center" valignment="top" usebox="none">
25266 \begin_layout Plain Layout
25272 <cell alignment="center" valignment="top" usebox="none">
25275 \begin_layout Plain Layout
25283 <cell alignment="left" valignment="top" usebox="none">
25286 \begin_layout Plain Layout
25292 <cell alignment="left" valignment="top" usebox="none">
25295 \begin_layout Plain Layout
25301 <cell alignment="left" valignment="top" usebox="none">
25304 \begin_layout Plain Layout
25310 <cell alignment="left" valignment="top" usebox="none">
25313 \begin_layout Plain Layout
25319 <cell alignment="center" valignment="top" usebox="none">
25322 \begin_layout Plain Layout
25328 <cell alignment="center" valignment="top" usebox="none">
25331 \begin_layout Plain Layout
25337 <cell alignment="center" valignment="top" usebox="none">
25340 \begin_layout Plain Layout
25346 <cell alignment="center" valignment="top" usebox="none">
25349 \begin_layout Plain Layout
25357 <cell alignment="left" valignment="top" usebox="none">
25360 \begin_layout Plain Layout
25366 <cell alignment="left" valignment="top" usebox="none">
25369 \begin_layout Plain Layout
25375 <cell alignment="left" valignment="top" usebox="none">
25378 \begin_layout Plain Layout
25384 <cell alignment="left" valignment="top" usebox="none">
25387 \begin_layout Plain Layout
25393 <cell alignment="center" valignment="top" usebox="none">
25396 \begin_layout Plain Layout
25402 <cell alignment="center" valignment="top" usebox="none">
25405 \begin_layout Plain Layout
25411 <cell alignment="center" valignment="top" usebox="none">
25414 \begin_layout Plain Layout
25420 <cell alignment="center" valignment="top" usebox="none">
25423 \begin_layout Plain Layout
25431 <cell alignment="left" valignment="top" usebox="none">
25434 \begin_layout Plain Layout
25440 <cell alignment="left" valignment="top" usebox="none">
25443 \begin_layout Plain Layout
25449 <cell alignment="left" valignment="top" usebox="none">
25452 \begin_layout Plain Layout
25458 <cell alignment="left" valignment="top" usebox="none">
25461 \begin_layout Plain Layout
25467 <cell alignment="center" valignment="top" usebox="none">
25470 \begin_layout Plain Layout
25476 <cell alignment="center" valignment="top" usebox="none">
25479 \begin_layout Plain Layout
25485 <cell alignment="center" valignment="top" usebox="none">
25488 \begin_layout Plain Layout
25494 <cell alignment="center" valignment="top" usebox="none">
25497 \begin_layout Plain Layout
25505 <cell alignment="left" valignment="top" usebox="none">
25508 \begin_layout Plain Layout
25514 <cell alignment="left" valignment="top" usebox="none">
25517 \begin_layout Plain Layout
25523 <cell alignment="left" valignment="top" usebox="none">
25526 \begin_layout Plain Layout
25532 <cell alignment="left" valignment="top" usebox="none">
25535 \begin_layout Plain Layout
25541 <cell alignment="center" valignment="top" usebox="none">
25544 \begin_layout Plain Layout
25550 <cell alignment="center" valignment="top" usebox="none">
25553 \begin_layout Plain Layout
25559 <cell alignment="center" valignment="top" usebox="none">
25562 \begin_layout Plain Layout
25568 <cell alignment="center" valignment="top" usebox="none">
25571 \begin_layout Plain Layout
25579 <cell alignment="left" valignment="top" usebox="none">
25582 \begin_layout Plain Layout
25588 <cell alignment="left" valignment="top" usebox="none">
25591 \begin_layout Plain Layout
25597 <cell alignment="left" valignment="top" usebox="none">
25600 \begin_layout Plain Layout
25606 <cell alignment="left" valignment="top" usebox="none">
25609 \begin_layout Plain Layout
25615 <cell alignment="center" valignment="top" usebox="none">
25618 \begin_layout Plain Layout
25624 <cell alignment="center" valignment="top" usebox="none">
25627 \begin_layout Plain Layout
25633 <cell alignment="center" valignment="top" usebox="none">
25636 \begin_layout Plain Layout
25642 <cell alignment="center" valignment="top" usebox="none">
25645 \begin_layout Plain Layout
25653 <cell alignment="center" valignment="top" usebox="none">
25656 \begin_layout Plain Layout
25662 <cell alignment="center" valignment="top" usebox="none">
25665 \begin_layout Plain Layout
25671 <cell alignment="center" valignment="top" usebox="none">
25674 \begin_layout Plain Layout
25680 <cell alignment="center" valignment="top" usebox="none">
25683 \begin_layout Plain Layout
25689 <cell alignment="center" valignment="top" usebox="none">
25692 \begin_layout Plain Layout
25698 <cell alignment="center" valignment="top" usebox="none">
25701 \begin_layout Plain Layout
25707 <cell alignment="center" valignment="top" usebox="none">
25710 \begin_layout Plain Layout
25716 <cell alignment="center" valignment="top" usebox="none">
25719 \begin_layout Plain Layout
25733 \begin_layout Chapter
25734 Names of available colors to be used in layouts
25735 \begin_inset CommandInset label
25737 name "chap:Names-of-colors"
25744 \begin_layout Standard
25745 The colors listed here are the standard colors and the those that you can
25746 adjust in the \SpecialChar LyX
25750 \begin_layout Description
25763 No particular color – clear or default
25766 \begin_layout Description
25770 \begin_layout Description
25774 \begin_layout Description
25778 \begin_layout Description
25782 \begin_layout Description
25786 \begin_layout Description
25790 \begin_layout Description
25794 \begin_layout Description
25798 \begin_layout Description
25799 added_space Added space marker color
25802 \begin_layout Description
25803 addedtext Added text color
25806 \begin_layout Description
25807 appendix Appendix marker color
25810 \begin_layout Description
25811 background Background color
25814 \begin_layout Description
25815 bottomarea Bottom area color
25818 \begin_layout Description
25819 branchlabel Label color for branches
25822 \begin_layout Description
25823 buttonbg Color used for bottom background
25826 \begin_layout Description
25827 buttonhoverbg Color used for button background under focus
25830 \begin_layout Description
25831 buttonframe Color for inset button frames
25834 \begin_layout Description
25835 changebar Changebar color
25838 \begin_layout Description
25839 changedtextauthor1 Changed text color author 1
25842 \begin_layout Description
25843 changedtextauthor2 Changed text color author 2
25846 \begin_layout Description
25847 changedtextauthor3 Changed text color author 3
25850 \begin_layout Description
25851 changedtextauthor4 Changed text color author 4
25854 \begin_layout Description
25855 changedtextauthor5 Changed text color author 5
25858 \begin_layout Description
25859 collapsable_inset_frame Collapsable insets framecolor
25862 \begin_layout Description
25863 collapsable_inset_text Collapsable insets text color
25866 \begin_layout Description
25867 command Text color for command insets
25870 \begin_layout Description
25871 commandbg Background color for command insets
25874 \begin_layout Description
25875 commandframe Frame color for command insets
25878 \begin_layout Description
25879 comment color for comments
25882 \begin_layout Description
25883 commentbg Background color of comments
25886 \begin_layout Description
25887 cursor Cursor color
25890 \begin_layout Description
25891 deletedtext Deleted text color
25894 \begin_layout Description
25895 deletedtextmodifier Deleted text modifying color
25898 \begin_layout Description
25899 depthbar Color for the depth bars in the margin
25902 \begin_layout Description
25903 eolmarker End of line marker color
25906 \begin_layout Description
25907 error Color of the \SpecialChar LaTeX
25911 \begin_layout Description
25912 footlabel Label color for footnotes
25915 \begin_layout Description
25916 graphicsbg Graphics inset background color
25919 \begin_layout Description
25920 greyedout Label color for greyedout insets
25923 \begin_layout Description
25924 greyedoutbg Background color of greyedout inset
25927 \begin_layout Description
25928 greyedouttext Color for greyedout inset text
25931 \begin_layout Description
25932 indexlabel Label color for index insets
25935 \begin_layout Description
25936 ignore The color is ignored
25939 \begin_layout Description
25940 inherit The color is inherited
25943 \begin_layout Description
25944 inlinecompletion Inline completion color
25947 \begin_layout Description
25948 insetbg Inset marker background color
25951 \begin_layout Description
25952 insetframe Inset marker frame color
25955 \begin_layout Description
25956 language Color for marking foreign language words
25959 \begin_layout Description
25960 latex Text color in \SpecialChar LaTeX
25964 \begin_layout Description
25965 listingsbg Background color of listings inset
25968 \begin_layout Description
25969 marginlabel Label color for margin notes
25972 \begin_layout Description
25973 math Math inset text color
25976 \begin_layout Description
25977 mathbg Math inset background color
25980 \begin_layout Description
25981 mathcorners Math inset frame color not under focus
25984 \begin_layout Description
25985 mathframe Math inset frame color under focus
25988 \begin_layout Description
25989 mathline Math line color
25992 \begin_layout Description
25993 mathmacrobg Macro math inset background color
25996 \begin_layout Description
25997 mathmacroblend Macro math blended color
26000 \begin_layout Description
26001 mathmacroframe Macro math frame color
26004 \begin_layout Description
26005 mathmacrohoverbg Macro math inset background color hovered
26008 \begin_layout Description
26009 mathmacrolabel Macro math label color
26012 \begin_layout Description
26013 mathmacronewarg Macro template color for new parameters
26016 \begin_layout Description
26017 mathmacrooldarg Macro template color for old parameters
26020 \begin_layout Description
26021 newpage New page color
26024 \begin_layout Description
26025 nonunique_inlinecompletion Inline completion color for the non-unique part
26028 \begin_layout Description
26029 notebg Background color of notes
26032 \begin_layout Description
26033 notelabel Label color for notes
26036 \begin_layout Description
26037 pagebreak Page break/line break color
26040 \begin_layout Description
26041 paragraphmarker Color used for the pilcrow sign to mark the end of a paragraph
26044 \begin_layout Description
26045 phantomtext Text color for phantom insets
26048 \begin_layout Description
26049 preview The color used for previews
26052 \begin_layout Description
26053 previewframe Preview frame color
26056 \begin_layout Description
26057 regexpframe Color for regexp frame
26060 \begin_layout Description
26061 selection Background color of selected text
26064 \begin_layout Description
26065 selectiontext Foreground color of selected text
26068 \begin_layout Description
26069 shadedbg Background color of shaded box
26072 \begin_layout Description
26073 special Special chars text color
26076 \begin_layout Description
26077 tabularline Table line color
26080 \begin_layout Description
26081 tabularonoffline Table line color
26084 \begin_layout Description
26085 urllabel Label color for URL insets
26088 \begin_layout Description
26089 urltext Color for URL inset text