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.)
10216 \change_inserted -712698321 1438601536
10218 If you require a package with specific options, you can additionally use
10220 \begin_inset Flex Code
10223 \begin_layout Plain Layout
10225 \change_inserted -712698321 1438601526
10236 \begin_layout Description
10237 \begin_inset Flex Code
10240 \begin_layout Plain Layout
10247 \begin_inset Flex Code
10250 \begin_layout Plain Layout
10256 ] A string that indicates the width of the right margin on the screen, for
10258 \begin_inset Quotes eld
10262 \begin_inset Flex Code
10265 \begin_layout Plain Layout
10272 \begin_inset Quotes erd
10278 \begin_layout Description
10279 \begin_inset Flex Code
10282 \begin_layout Plain Layout
10289 \begin_inset Flex Code
10292 \begin_layout Plain Layout
10298 ] Sets which divisions get numbered.
10300 \begin_inset Newline newline
10304 \begin_inset Flex Code
10307 \begin_layout Plain Layout
10313 counter in \SpecialChar LaTeX
10317 \begin_layout Description
10318 \begin_inset Flex Code
10321 \begin_layout Plain Layout
10328 \begin_inset Flex Code
10331 \begin_layout Plain Layout
10340 \begin_inset space \thinspace{}
10344 \begin_inset Flex Code
10347 \begin_layout Plain Layout
10353 ] Whether the class-default should be printing on one or both sides of the
10355 Can be changed in the
10356 \begin_inset Flex MenuItem
10359 \begin_layout Plain Layout
10360 Document\SpecialChar menuseparator
10369 \begin_layout Description
10370 \begin_inset Flex Code
10373 \begin_layout Plain Layout
10380 \begin_inset Flex Code
10383 \begin_layout Plain Layout
10389 ] This sequence defines a paragraph style.
10390 If the style does not yet exist, it is created; if it does exist, its parameter
10393 \begin_inset Quotes eld
10397 \begin_inset Flex Code
10400 \begin_layout Plain Layout
10407 \begin_inset Quotes erd
10411 \begin_inset Newline newline
10415 \begin_inset CommandInset ref
10417 reference "subsec:Paragraph-Styles"
10421 for details on paragraph styles.
10424 \begin_layout Description
10425 \begin_inset Flex Code
10428 \begin_layout Plain Layout
10435 \begin_inset Flex Code
10438 \begin_layout Plain Layout
10444 ] The name of the command or environment to be used with
10445 \begin_inset Flex Code
10448 \begin_layout Plain Layout
10457 \begin_layout Description
10458 \begin_inset Flex Code
10461 \begin_layout Plain Layout
10468 \begin_inset Flex Code
10471 \begin_layout Plain Layout
10480 \begin_inset Flex Code
10483 \begin_layout Plain Layout
10489 ] Indicates what kind of markup is used to define the title of a document.
10491 \begin_inset Flex Code
10494 \begin_layout Plain Layout
10500 means that the macro with name
10501 \begin_inset Flex Code
10504 \begin_layout Plain Layout
10510 will be inserted after the last layout which has
10511 \begin_inset Quotes eld
10515 \begin_inset Flex Code
10518 \begin_layout Plain Layout
10520 \begin_inset space ~
10529 \begin_inset Quotes erd
10534 \begin_inset Flex Code
10537 \begin_layout Plain Layout
10543 corresponds to the case where all layouts which have
10544 \begin_inset Quotes eld
10548 \begin_inset Flex Code
10551 \begin_layout Plain Layout
10553 \begin_inset space ~
10562 \begin_inset Quotes erd
10565 should be enclosed into the
10566 \begin_inset Flex Code
10569 \begin_layout Plain Layout
10578 \begin_layout Description
10579 \begin_inset Flex Code
10582 \begin_layout Plain Layout
10589 \begin_inset Flex Code
10592 \begin_layout Plain Layout
10598 ] Sets which divisions are included in the table of contents.
10600 \begin_inset Flex Code
10603 \begin_layout Plain Layout
10609 counter in \SpecialChar LaTeX
10613 \begin_layout Subsection
10614 \begin_inset Flex Code
10617 \begin_layout Plain Layout
10624 \begin_inset CommandInset label
10626 name "subsec:ClassOptions"
10633 \begin_layout Standard
10635 \begin_inset Flex Code
10638 \begin_layout Plain Layout
10644 section can contain the following entries:
10647 \begin_layout Description
10648 \begin_inset Flex Code
10651 \begin_layout Plain Layout
10658 \begin_inset Flex Code
10661 \begin_layout Plain Layout
10667 ] The list of available font sizes for the document's main font, separated
10669 \begin_inset Quotes eld
10673 \begin_inset Flex Code
10676 \begin_layout Plain Layout
10683 \begin_inset Quotes erd
10689 \begin_layout Description
10690 \begin_inset Flex Code
10693 \begin_layout Plain Layout
10699 Used to set the DTD line with XML-based output classes.
10701 \begin_inset space \thinspace{}
10705 \begin_inset Quotes eld
10708 -//OASIS//DTD DocBook V4.2//EN
10709 \begin_inset Quotes erd
10715 \begin_layout Description
10716 \begin_inset Flex Code
10719 \begin_layout Plain Layout
10726 \begin_inset Flex Code
10729 \begin_layout Plain Layout
10730 string="empty|plain|headings|fancy"
10735 ] The list of available page sty\SpecialChar softhyphen
10737 \begin_inset Quotes eld
10741 \begin_inset Flex Code
10744 \begin_layout Plain Layout
10751 \begin_inset Quotes erd
10757 \begin_layout Description
10758 \begin_inset Flex Code
10761 \begin_layout Plain Layout
10768 \begin_inset Flex Code
10771 \begin_layout Plain Layout
10777 ] Some document class options, separated by a comma, that will be added
10778 to the optional part of the
10779 \begin_inset Flex Code
10782 \begin_layout Plain Layout
10793 \begin_layout Standard
10795 \begin_inset Flex Code
10798 \begin_layout Plain Layout
10804 section must end with
10805 \begin_inset Quotes eld
10809 \begin_inset Flex Code
10812 \begin_layout Plain Layout
10819 \begin_inset Quotes erd
10825 \begin_layout Subsection
10827 \begin_inset CommandInset label
10829 name "subsec:Paragraph-Styles"
10836 \begin_layout Standard
10837 A paragraph style description looks like this:
10841 \begin_layout Plain Layout
10842 Note that this will either define a new style or modify an existing one.
10850 \begin_layout LyX-Code
10857 \begin_layout LyX-Code
10861 \begin_layout LyX-Code
10865 \begin_layout Standard
10866 where the following commands are allowed:
10869 \begin_layout Description
10870 \begin_inset Flex Code
10873 \begin_layout Plain Layout
10880 \begin_inset Flex Code
10883 \begin_layout Plain Layout
10888 , left, right, center
10893 ] Paragraph alignment.
10896 \begin_layout Description
10897 \begin_inset Flex Code
10900 \begin_layout Plain Layout
10907 \begin_inset Flex Code
10910 \begin_layout Plain Layout
10915 , left, right, center
10920 ] A comma separated list of permitted alignments.
10921 (Some \SpecialChar LaTeX
10922 styles prohibit certain alignments, since those wouldn't make sense.
10923 For example a right-aligned or centered enumeration isn't possible.)
10926 \begin_layout Description
10927 \begin_inset Flex Code
10930 \begin_layout Plain Layout
10937 \begin_inset Flex Code
10940 \begin_layout Plain Layout
10946 ] Defines argument number <int> of a command\SpecialChar breakableslash
10947 environment associated with
10949 This is useful for things like section headings, and only makes sense with
10952 Every (optional or required) argument of a command or environment – except
10953 for the required argument that is associated with the content of the paragraph
10954 itself – has a separate definition, where the number specifies the order
10956 The definition must end with
10957 \begin_inset Flex Code
10960 \begin_layout Plain Layout
10967 So a command with two optional arguments has:
10968 \begin_inset Separator parbreak
10975 \begin_layout Quote
10981 \begin_layout Quote
10987 \begin_layout Quote
10993 \begin_layout Quote
10999 \begin_layout Quote
11005 \begin_layout Quote
11011 \begin_layout Standard
11013 \begin_inset Flex Code
11016 \begin_layout Plain Layout
11022 definition, the following specifications are possible:
11025 \begin_layout Itemize
11026 \begin_inset Flex Code
11029 \begin_layout Plain Layout
11036 \begin_inset Flex Code
11039 \begin_layout Plain Layout
11045 The string that will appear both in the menu (to insert this argument)
11046 and on the argument inset button (unless you also specify a separate
11047 \begin_inset Flex Code
11050 \begin_layout Plain Layout
11057 For the menu, you can define an accelerator by appending the respective
11058 character to the string, divided by
11059 \begin_inset Quotes eld
11063 \begin_inset Quotes erd
11067 \begin_inset space \thinspace{}
11071 \begin_inset space \space{}
11075 \begin_inset Quotes eld
11079 \begin_inset Flex Code
11082 \begin_layout Plain Layout
11089 \begin_inset Quotes erd
11095 \begin_layout Itemize
11096 \begin_inset Flex Code
11099 \begin_layout Plain Layout
11106 \begin_inset Flex Code
11109 \begin_layout Plain Layout
11115 A separate string for the menu.
11116 You can define an accelerator by appending the respective character to
11117 the string, divided by
11118 \begin_inset Quotes eld
11122 \begin_inset Quotes erd
11126 \begin_inset space \thinspace{}
11130 \begin_inset space \space{}
11134 \begin_inset Quotes eld
11138 \begin_inset Flex Code
11141 \begin_layout Plain Layout
11148 \begin_inset Quotes erd
11152 This specification is optional.
11153 If it is not given the
11154 \begin_inset Flex Code
11157 \begin_layout Plain Layout
11163 will be used instead for the menu.
11166 \begin_layout Itemize
11167 \begin_inset Flex Code
11170 \begin_layout Plain Layout
11177 \begin_inset Flex Code
11180 \begin_layout Plain Layout
11186 A longer explanatory text that appears in the tooltip when hovering over
11187 the argument inset.
11190 \begin_layout Itemize
11191 \begin_inset Flex Code
11194 \begin_layout Plain Layout
11201 \begin_inset Flex Code
11204 \begin_layout Plain Layout
11213 \begin_inset space \thinspace{}
11217 \begin_inset Flex Code
11220 \begin_layout Plain Layout
11226 ] Declare if this is a mandatory (1) or an optional (0) argument.
11227 Mandatory arguments will be output empty if not given, while optional arguments
11228 will not be output at all.
11229 By default, mandatory arguments are delimited by
11230 \begin_inset Flex Code
11233 \begin_layout Plain Layout
11239 , while optional arguments are delimited by
11240 \begin_inset Flex Code
11243 \begin_layout Plain Layout
11252 \begin_layout Itemize
11253 \begin_inset Flex Code
11256 \begin_layout Plain Layout
11263 \begin_inset Flex Code
11266 \begin_layout Plain Layout
11272 defines another argument (by its number) which this argument requires to
11273 be output if it is itself output.
11275 \begin_inset space \thinspace{}
11278 g., in \SpecialChar LaTeX
11279 commands, optional arguments often require previous optional arguments
11280 to be output (at least empty), as in
11281 \begin_inset Flex Code
11284 \begin_layout Plain Layout
11287 command[][argument]{text}
11293 This can be achieved by the statement
11294 \begin_inset Flex Code
11297 \begin_layout Plain Layout
11304 \begin_inset Flex Code
11307 \begin_layout Plain Layout
11316 \begin_layout Itemize
11317 \begin_inset Flex Code
11320 \begin_layout Plain Layout
11327 \begin_inset Flex Code
11330 \begin_layout Plain Layout
11336 defines a custom left delimiter (instead of
11337 \begin_inset Flex Code
11340 \begin_layout Plain Layout
11347 \begin_inset Flex Code
11350 \begin_layout Plain Layout
11357 A line break in the output can be indicated by
11358 \begin_inset Flex Code
11361 \begin_layout Plain Layout
11370 \begin_layout Itemize
11371 \begin_inset Flex Code
11374 \begin_layout Plain Layout
11381 \begin_inset Flex Code
11384 \begin_layout Plain Layout
11390 defines a custom right delimiter (instead of
11391 \begin_inset Flex Code
11394 \begin_layout Plain Layout
11401 \begin_inset Flex Code
11404 \begin_layout Plain Layout
11411 A line break in the output can be indicated by
11412 \begin_inset Flex Code
11415 \begin_layout Plain Layout
11424 \begin_layout Itemize
11425 \begin_inset Flex Code
11428 \begin_layout Plain Layout
11435 \begin_inset Flex Code
11438 \begin_layout Plain Layout
11444 defines an argument that is inserted if and only if no user-specified arguments
11446 \begin_inset space \thinspace{}
11450 \begin_inset space \space{}
11453 if no argument inset has been inserted (note that also an empty argument
11454 inset omits the DefaultArg).
11455 Multiple arguments need to be separated by comma.
11458 \begin_layout Itemize
11459 \begin_inset Flex Code
11462 \begin_layout Plain Layout
11469 \begin_inset Flex Code
11472 \begin_layout Plain Layout
11478 defines an argument that is inserted in any case (alone or in addition
11479 to user-specified arguments).
11480 Multiple arguments need to be separated by comma.
11483 \begin_layout Itemize
11484 \begin_inset Flex Code
11487 \begin_layout Plain Layout
11493 The font used for the argument content, see
11494 \begin_inset CommandInset ref
11496 reference "subsec:Font-description"
11503 \begin_layout Itemize
11504 \begin_inset Flex Code
11507 \begin_layout Plain Layout
11513 The font used for the label; see
11514 \begin_inset CommandInset ref
11516 reference "subsec:Font-description"
11523 \begin_layout Itemize
11524 \begin_inset Flex Code
11527 \begin_layout Plain Layout
11534 \begin_inset Flex Code
11537 \begin_layout Plain Layout
11542 , Minimalistic, Conglomerate
11547 ] describes the rendering style used for the inset's frame and buttons.
11550 \begin_layout Itemize
11551 \begin_inset Flex Code
11554 \begin_layout Plain Layout
11561 \begin_inset Flex Code
11564 \begin_layout Plain Layout
11571 \begin_inset Flex Code
11574 \begin_layout Plain Layout
11580 , this argument is automatically inserted when the respective style is selected.
11581 Currently, only one argument per style\SpecialChar breakableslash
11582 layout can be automatically inserted.
11583 \change_inserted -712698321 1431166542
11587 \begin_layout Itemize
11589 \change_inserted -712698321 1431166604
11590 \begin_inset Flex Code
11593 \begin_layout Plain Layout
11595 \change_inserted -712698321 1431166548
11602 \begin_inset Flex Code
11605 \begin_layout Plain Layout
11607 \change_inserted -712698321 1431166543
11614 \begin_inset Flex Code
11617 \begin_layout Plain Layout
11619 \change_inserted -712698321 1431166543
11625 , this argument will bei inserted with a copy of the co-text (either selected
11626 text or the whole paragraph) as content.
11629 \begin_layout Itemize
11631 \change_inserted -712698321 1431070588
11632 \begin_inset Flex Code
11635 \begin_layout Plain Layout
11637 \change_inserted -712698321 1431070522
11644 \begin_inset Flex Code
11647 \begin_layout Plain Layout
11649 \change_inserted -712698321 1431070522
11650 string of characters
11659 Defines individual characters that should be output in raw form, meaning
11660 without special translations that \SpecialChar LaTeX
11662 Note that, contrary to PassThru, this needs to be explicitly defined for
11664 That is, arguments do not inherit PassThruChars from their parent inset
11670 \begin_layout Standard
11671 By default, the text entered in the \SpecialChar LyX
11672 workarea in the respective layout is
11673 the last (mandatory) argument of a command if the
11674 \begin_inset Flex Code
11677 \begin_layout Plain Layout
11684 \begin_inset Flex Code
11687 \begin_layout Plain Layout
11694 However, arguments with the prefix
11695 \begin_inset Flex Code
11698 \begin_layout Plain Layout
11704 are output after this workarea argument.
11705 Note that post-argument numbering restarts at 1, so the first argument
11706 following the workarea argument is
11707 \begin_inset Flex Code
11710 \begin_layout Plain Layout
11717 Post-arguments are ignored in any other
11718 \begin_inset Flex Code
11721 \begin_layout Plain Layout
11728 \begin_inset Flex Code
11731 \begin_layout Plain Layout
11740 \begin_layout Standard
11742 \begin_inset Flex Code
11745 \begin_layout Plain Layout
11754 \begin_inset Flex Code
11757 \begin_layout Plain Layout
11766 \begin_inset Flex Code
11769 \begin_layout Plain Layout
11775 followed by the number (e.
11776 \begin_inset space \thinspace{}
11780 \begin_inset space \space{}
11784 \begin_inset Flex Code
11787 \begin_layout Plain Layout
11797 \begin_layout Description
11798 \begin_inset Flex Code
11801 \begin_layout Plain Layout
11807 Note that this will completely override any prior
11808 \begin_inset Flex Code
11811 \begin_layout Plain Layout
11817 declaration for this style.
11819 \begin_inset Quotes eld
11823 \begin_inset Flex Code
11826 \begin_layout Plain Layout
11833 \begin_inset Quotes erd
11838 \begin_inset CommandInset ref
11840 reference "subsec:I18n"
11844 for details on its use.
11847 \begin_layout Description
11848 \begin_inset Flex Code
11851 \begin_layout Plain Layout
11858 \begin_inset Flex Code
11861 \begin_layout Plain Layout
11871 \begin_layout Plain Layout
11872 Note that a `float' here is a real number, such as: 1.5.
11877 The vertical space with which the last of a chain of paragraphs with this
11878 style is separated from the following paragraph.
11879 If the next paragraph has another style, the separations are not simply
11880 added, but the maximum is taken.
11883 \begin_layout Description
11884 \begin_inset Flex Code
11887 \begin_layout Plain Layout
11894 \begin_inset Flex Code
11897 \begin_layout Plain Layout
11903 ] The category for this style.
11904 This is used to group related styles in the style combobox on the toolbar.
11905 Any string can be used, but you may want to use existing categories with
11910 \begin_layout Description
11911 \begin_inset Flex Code
11914 \begin_layout Plain Layout
11920 Depth of XML command.
11921 Used only with XML-type formats.
11924 \begin_layout Description
11925 \begin_inset Flex Code
11928 \begin_layout Plain Layout
11935 \begin_inset Flex Code
11938 \begin_layout Plain Layout
11944 ] Copies all the features of an existing style into the current one.
11948 \begin_layout Description
11949 \begin_inset Flex Code
11952 \begin_layout Plain Layout
11959 \begin_inset Flex Code
11962 \begin_layout Plain Layout
11968 ] The name of a style whose preamble should be output
11973 This allows to ensure some ordering of the preamble snippets when macros
11974 definitions depend on one another.
11978 \begin_layout Plain Layout
11979 Note that, besides that functionality, there is no way to ensure any ordering
11981 The ordering that you see in a given version of \SpecialChar LyX
11982 may change without warning
11991 \begin_layout Description
11992 \begin_inset Flex Code
11995 \begin_layout Plain Layout
12002 \begin_inset Flex Code
12005 \begin_layout Plain Layout
12010 , Box, Filled_Box, Static
12015 ] The type of label that stands at the end of the paragraph (or sequence
12017 \begin_inset Flex Code
12020 \begin_layout Plain Layout
12027 \begin_inset Newline newline
12031 \begin_inset Flex Code
12034 \begin_layout Plain Layout
12041 \begin_inset Flex Code
12044 \begin_layout Plain Layout
12051 \begin_inset Flex Code
12054 \begin_layout Plain Layout
12062 \begin_inset Flex Code
12065 \begin_layout Plain Layout
12072 \begin_inset Quotes eld
12076 \begin_inset Quotes erd
12080 \begin_inset Flex Code
12083 \begin_layout Plain Layout
12090 \begin_inset space \space{}
12094 \begin_inset Flex Code
12097 \begin_layout Plain Layout
12103 ) is a white (resp.
12104 \begin_inset space ~
12107 black) square suitable for end of proof markers,
12108 \begin_inset Flex Code
12111 \begin_layout Plain Layout
12117 is an explicit text string.
12120 \begin_layout Description
12121 \begin_inset Flex Code
12124 \begin_layout Plain Layout
12131 \begin_inset Flex Code
12134 \begin_layout Plain Layout
12140 ] The string used for a label with a
12141 \begin_inset Flex Code
12144 \begin_layout Plain Layout
12151 \begin_inset Newline newline
12155 \begin_inset Flex Code
12158 \begin_layout Plain Layout
12168 \begin_layout Description
12169 \begin_inset Flex Code
12172 \begin_layout Plain Layout
12178 The font used for both the text body
12184 \begin_inset CommandInset ref
12186 reference "subsec:Font-description"
12191 Note that defining this font automatically defines the
12192 \begin_inset Flex Code
12195 \begin_layout Plain Layout
12202 So you should define this one first if you also want to define
12203 \begin_inset Flex Code
12206 \begin_layout Plain Layout
12215 \begin_layout Description
12216 \begin_inset Flex Code
12219 \begin_layout Plain Layout
12226 \begin_inset Flex Code
12229 \begin_layout Plain Layout
12235 ] Used for backporting new styles to stable \SpecialChar LyX
12237 The first stable version that supports this tag is \SpecialChar LyX
12239 The argument is a number which may either be 0, -1 or any value greater
12242 \begin_inset Flex Code
12245 \begin_layout Plain Layout
12251 flag of a style is greater than zero, it will always be written to the
12253 If a .lyx file is read, the style definitions from the document header are
12254 added to the document class.
12255 Therefore even older \SpecialChar LyX
12256 versions can handle the style.
12258 \begin_inset Flex Code
12261 \begin_layout Plain Layout
12267 is a version number: If the style is read, and the version number is less
12268 than the version number of the already existing style in the document class,
12269 the new style is ignored.
12270 If the version number is greater, the new style replaces the existing style.
12271 A value of -1 means an infinite version number, i.
12272 \begin_inset space \thinspace{}
12276 \begin_inset space \space{}
12279 the style is always used.
12282 \begin_layout Description
12283 \begin_inset Flex Code
12286 \begin_layout Plain Layout
12293 \begin_inset Flex Code
12296 \begin_layout Plain Layout
12305 \begin_inset space \thinspace{}
12309 \begin_inset Flex Code
12312 \begin_layout Plain Layout
12318 ] Usually \SpecialChar LyX
12319 does not allow you to insert more than one space between words,
12320 since a space is considered as the separation between two words, not a
12321 character or symbol of its own.
12322 This is a very fine thing but sometimes annoying, for example, when typing
12323 program code or plain \SpecialChar LaTeX
12326 \begin_inset Flex Code
12329 \begin_layout Plain Layout
12336 Note that \SpecialChar LyX
12337 will create protected blanks for the additional blanks when
12338 in another mode than \SpecialChar LaTeX
12342 \begin_layout Description
12343 \begin_inset Flex Code
12346 \begin_layout Plain Layout
12352 These tags are used with XHTML output.
12354 \begin_inset CommandInset ref
12356 reference "subsec:Paragraph-Style-XHTML"
12363 \begin_layout Description
12364 \begin_inset Flex Code
12367 \begin_layout Plain Layout
12373 [FIXME] (Used only with XML-type formats.)
12376 \begin_layout Description
12377 \begin_inset Flex Code
12380 \begin_layout Plain Layout
12387 \begin_inset Flex Code
12390 \begin_layout Plain Layout
12399 \begin_inset space \thinspace{}
12403 \begin_inset Flex Code
12406 \begin_layout Plain Layout
12413 \begin_inset Flex Code
12416 \begin_layout Plain Layout
12422 , marks the style as to be included in the document preamble and not in
12424 This is useful for document classes that want such information as the title
12425 and author to appear in the preamble.
12426 Note that this works only for styles for which the
12427 \begin_inset Flex Code
12430 \begin_layout Plain Layout
12437 \begin_inset Flex Code
12440 \begin_layout Plain Layout
12447 \begin_inset Flex Code
12450 \begin_layout Plain Layout
12459 \begin_layout Description
12460 \begin_inset Flex Code
12463 \begin_layout Plain Layout
12470 \begin_inset Flex Code
12473 \begin_layout Plain Layout
12482 \begin_inset space \thinspace{}
12486 \begin_inset Flex Code
12489 \begin_layout Plain Layout
12496 \begin_inset Flex Code
12499 \begin_layout Plain Layout
12505 , marks the style as being part of a title block (see also the
12506 \begin_inset Flex Code
12509 \begin_layout Plain Layout
12516 \begin_inset Flex Code
12519 \begin_layout Plain Layout
12528 \begin_layout Description
12529 \begin_inset Flex Code
12532 \begin_layout Plain Layout
12539 \begin_inset Flex Code
12542 \begin_layout Plain Layout
12548 ] The \SpecialChar LaTeX
12549 command sequence declaring an item in a list.
12550 The command is to be defined without the preceding backslash (the default
12552 \begin_inset Quotes eld
12556 \begin_inset Quotes erd
12560 \begin_inset Flex Code
12563 \begin_layout Plain Layout
12571 in the \SpecialChar LaTeX
12575 \begin_layout Description
12576 \begin_inset Flex Code
12579 \begin_layout Plain Layout
12586 \begin_inset Flex Code
12589 \begin_layout Plain Layout
12595 ] This provides extra space between paragraphs that have the same style.
12596 If you put other styles into an environment, each is separated with the
12598 \begin_inset Flex Code
12601 \begin_layout Plain Layout
12608 But the whole items of the environment are additionally separated with
12610 \begin_inset Flex Code
12613 \begin_layout Plain Layout
12620 Note that this is a
12625 \begin_layout Description
12626 \begin_inset Flex Code
12629 \begin_layout Plain Layout
12635 [FIXME] (Used only with XML-type formats.)
12638 \begin_layout Description
12639 \begin_inset Flex Code
12642 \begin_layout Plain Layout
12649 \begin_inset Flex Code
12652 \begin_layout Plain Layout
12661 \begin_inset space \thinspace{}
12665 \begin_inset Flex Code
12668 \begin_layout Plain Layout
12674 ] Usually \SpecialChar LyX
12675 does not allow you to leave a paragraph empty, since it would
12676 lead to empty \SpecialChar LaTeX
12678 There are some cases where this could be desirable however: in a letter
12679 template, the required fields can be provided as empty fields, so that
12680 people do not forget them; in some special classes, a style can be used
12681 as some kind of break, which does not contain actual text.
12684 \begin_layout Description
12685 \begin_inset Flex Code
12688 \begin_layout Plain Layout
12695 \begin_inset Flex Code
12698 \begin_layout Plain Layout
12704 ] The vertical space between the label and the text body.
12705 Only used for labels that are above the text body (
12706 \begin_inset Flex Code
12709 \begin_layout Plain Layout
12716 \begin_inset Newline newline
12720 \begin_inset Flex Code
12723 \begin_layout Plain Layout
12724 Centered_Top_Environment
12732 \begin_layout Description
12733 \begin_inset Flex Code
12736 \begin_layout Plain Layout
12743 \begin_inset Flex Code
12746 \begin_layout Plain Layout
12752 ] The name of the counter for automatic numbering.
12753 In order to have the counter appear with your label, you will need to reference
12755 \begin_inset Flex Code
12758 \begin_layout Plain Layout
12767 This will work with
12768 \begin_inset Flex Code
12771 \begin_layout Plain Layout
12778 \begin_inset Flex Code
12781 \begin_layout Plain Layout
12788 \begin_inset Flex Code
12791 \begin_layout Plain Layout
12798 \begin_inset Flex Code
12801 \begin_layout Plain Layout
12808 \begin_inset Newline newline
12816 \begin_inset Flex Code
12819 \begin_layout Plain Layout
12826 \begin_inset Flex Code
12829 \begin_layout Plain Layout
12835 , though this case is a bit complicated.
12836 Suppose you declare
12837 \begin_inset Quotes eld
12841 \begin_inset Flex Code
12844 \begin_layout Plain Layout
12845 LabelCounter myenum
12851 \begin_inset Quotes erd
12855 Then the actual counters used are
12856 \begin_inset Flex Code
12859 \begin_layout Plain Layout
12866 \begin_inset Flex Code
12869 \begin_layout Plain Layout
12876 \begin_inset Flex Code
12879 \begin_layout Plain Layout
12886 \begin_inset Flex Code
12889 \begin_layout Plain Layout
12895 , much as in \SpecialChar LaTeX
12897 These counters must all be declared separately.
12898 \begin_inset Newline newline
12902 \begin_inset CommandInset ref
12904 reference "subsec:Counters"
12908 for details on counters.
12911 \begin_layout Description
12912 \begin_inset Flex Code
12915 \begin_layout Plain Layout
12921 The font used for the label.
12923 \begin_inset CommandInset ref
12925 reference "subsec:Font-description"
12932 \begin_layout Description
12933 \begin_inset Flex Code
12936 \begin_layout Plain Layout
12943 \begin_inset Flex Code
12946 \begin_layout Plain Layout
12952 ] Text that indicates how far a label should be indented.
12955 \begin_layout Description
12956 \begin_inset Flex Code
12959 \begin_layout Plain Layout
12966 \begin_inset Flex Code
12969 \begin_layout Plain Layout
12975 ] Text that indicates the amount of horizontal space between the label and
12977 Only used for labels that are not above the text body.
12980 \begin_layout Description
12981 \begin_inset Flex Code
12984 \begin_layout Plain Layout
12991 \begin_inset Flex Code
12994 \begin_layout Plain Layout
13000 ] The string used for the label.
13002 \begin_inset Flex Code
13005 \begin_layout Plain Layout
13011 is set, this string can be contain the special formatting commands described
13013 \begin_inset CommandInset ref
13015 reference "subsec:Counters"
13022 \begin_layout Description
13023 \begin_inset Flex Code
13026 \begin_layout Plain Layout
13027 LabelStringAppendix
13033 \begin_inset Flex Code
13036 \begin_layout Plain Layout
13042 ] This is used inside the appendix instead of
13043 \begin_inset Newline newline
13047 \begin_inset Flex Code
13050 \begin_layout Plain Layout
13058 \begin_inset Flex Code
13061 \begin_layout Plain Layout
13068 \begin_inset Newline newline
13072 \begin_inset Flex Code
13075 \begin_layout Plain Layout
13076 LabelStringAppendix
13084 \begin_layout Description
13085 \begin_inset Flex Code
13088 \begin_layout Plain Layout
13094 [FIXME] (Used only with XML-type formats.)
13097 \begin_layout Description
13098 \begin_inset Flex Code
13101 \begin_layout Plain Layout
13108 \begin_inset Flex Code
13111 \begin_layout Plain Layout
13116 , Manual, Static, Above,
13117 \begin_inset Newline newline
13120 Centered, Sensitive, Enumerate,
13121 \begin_inset Newline newline
13124 Itemize, Bibliography
13130 \begin_inset Separator parbreak
13137 \begin_layout Description
13138 \begin_inset Flex Code
13141 \begin_layout Plain Layout
13147 means the label is the very first word (up to the first real blank).
13148 Use protected spaces if you want more than one word as the label.
13152 \begin_layout Description
13153 \begin_inset Flex Code
13156 \begin_layout Plain Layout
13162 means the label is simply what is declared as
13163 \begin_inset Flex Code
13166 \begin_layout Plain Layout
13173 This will be displayed
13174 \begin_inset Quotes eld
13178 \begin_inset Quotes erd
13181 , at the beginning of the paragraph.
13183 \begin_inset Flex Code
13186 \begin_layout Plain Layout
13193 \begin_inset Flex Code
13196 \begin_layout Plain Layout
13202 , then it will be displayed only in the first paragraph of any sequence
13203 of paragraphs with the same
13204 \begin_inset Flex Code
13207 \begin_layout Plain Layout
13216 \begin_layout Description
13217 \begin_inset Flex Code
13220 \begin_layout Plain Layout
13227 \begin_inset space ~
13231 \begin_inset space ~
13235 \begin_inset Flex Code
13238 \begin_layout Plain Layout
13244 are special cases of
13245 \begin_inset Flex Code
13248 \begin_layout Plain Layout
13255 The label will be printed above the paragraph either at the beginning of
13256 the line or centered.
13259 \begin_layout Description
13260 \begin_inset Flex Code
13263 \begin_layout Plain Layout
13269 is a special case for the caption-labels
13270 \begin_inset Quotes eld
13274 \begin_inset Quotes erd
13278 \begin_inset Quotes eld
13282 \begin_inset Quotes erd
13286 \begin_inset Newline newline
13290 \begin_inset Flex Code
13293 \begin_layout Plain Layout
13299 means the (hardcoded) label string depends on the kind of float: It is
13300 hardcoded to be `FloatType N', where N is the value of the counter associated
13302 For the case that a caption is inserted outside of a float the
13303 \begin_inset Flex Code
13306 \begin_layout Plain Layout
13313 \begin_inset Quotes eld
13317 \begin_inset Quotes erd
13323 \begin_layout Description
13324 \begin_inset Flex Code
13327 \begin_layout Plain Layout
13333 produces the usual sort of enumeration labels.
13334 At present, it is hardcoded to use Arabic numerals, lowercase letters,
13335 small Roman numerals, and uppercase letters for the four possible depths.
13338 \begin_layout Description
13339 \begin_inset Flex Code
13342 \begin_layout Plain Layout
13348 produces various bullets at the different levels.
13349 It is also hardcoded.
13352 \begin_layout Description
13353 \begin_inset Flex Code
13356 \begin_layout Plain Layout
13362 should be used only with
13363 \begin_inset Flex Code
13366 \begin_layout Plain Layout
13367 LatexType BibEnvironment
13376 \begin_layout Description
13377 \begin_inset Flex Code
13380 \begin_layout Plain Layout
13386 Note that this will completely override any prior
13387 \begin_inset Flex Code
13390 \begin_layout Plain Layout
13396 declaration for this style.
13398 \begin_inset Quotes eld
13402 \begin_inset Flex Code
13405 \begin_layout Plain Layout
13412 \begin_inset Quotes erd
13417 \begin_inset CommandInset ref
13419 reference "subsec:I18n"
13423 for details on its use.
13426 \begin_layout Description
13427 \begin_inset Flex Code
13430 \begin_layout Plain Layout
13437 \begin_inset Flex Code
13440 \begin_layout Plain Layout
13446 ] The name of the corresponding \SpecialChar LaTeX
13448 Either the environment or command name.
13451 \begin_layout Description
13452 \begin_inset Flex Code
13455 \begin_layout Plain Layout
13462 \begin_inset Flex Code
13465 \begin_layout Plain Layout
13471 ] An optional parameter for the corresponding
13472 \begin_inset Flex Code
13475 \begin_layout Plain Layout
13482 This parameter cannot be changed from within \SpecialChar LyX
13484 \begin_inset Flex Code
13487 \begin_layout Plain Layout
13493 for customizable parameters).
13494 This will be output as is after all \SpecialChar LaTeX
13496 \begin_inset Flex Code
13499 \begin_layout Plain Layout
13508 \begin_layout Description
13509 \begin_inset Flex Code
13512 \begin_layout Plain Layout
13519 \begin_inset Flex Code
13522 \begin_layout Plain Layout
13527 , Command, Environment, Item_Environment,
13528 \begin_inset Newline newline
13531 List_Environment, Bib_Environment
13536 ] How the style should be translated into \SpecialChar LaTeX
13541 \begin_layout Plain Layout
13542 \begin_inset Flex Code
13545 \begin_layout Plain Layout
13551 is perhaps a bit misleading, since these rules apply to SGML classes, too.
13552 Visit the SGML class files for specific examples.
13558 \begin_inset Separator parbreak
13565 \begin_layout Description
13566 \begin_inset Flex Code
13569 \begin_layout Plain Layout
13575 means nothing special.
13578 \begin_layout Description
13579 \begin_inset Flex Code
13582 \begin_layout Plain Layout
13589 \begin_inset Flex Code
13592 \begin_layout Plain Layout
13599 {\SpecialChar ldots
13608 \begin_layout Description
13609 \begin_inset Flex Code
13612 \begin_layout Plain Layout
13619 \begin_inset Flex Code
13622 \begin_layout Plain Layout
13629 }\SpecialChar ldots
13645 \begin_layout Description
13646 \begin_inset Flex Code
13649 \begin_layout Plain Layout
13656 \begin_inset Flex Code
13659 \begin_layout Plain Layout
13666 \begin_inset Flex Code
13669 \begin_layout Plain Layout
13677 is generated for each paragraph of this environment.
13681 \begin_layout Description
13682 \begin_inset Flex Code
13685 \begin_layout Plain Layout
13692 \begin_inset Flex Code
13695 \begin_layout Plain Layout
13702 \begin_inset Newline newline
13706 \begin_inset Flex Code
13709 \begin_layout Plain Layout
13715 is passed as an argument to the environment.
13716 \begin_inset Newline newline
13720 \begin_inset Flex Code
13723 \begin_layout Plain Layout
13729 can be defined in the
13730 \begin_inset Flex MenuItem
13733 \begin_layout Plain Layout
13734 Edit\SpecialChar menuseparator
13736 \begin_inset space ~
13747 \begin_layout Description
13748 \begin_inset Flex Code
13751 \begin_layout Plain Layout
13758 \begin_inset Flex Code
13761 \begin_layout Plain Layout
13767 but adds additionally the necessary mandatory argument (the longest label)
13768 to the begin statement of the bibliography environment:
13769 \begin_inset Newline newline
13773 \begin_inset Flex Code
13776 \begin_layout Plain Layout
13779 begin{thebibliography}{99}
13784 It is therefore only useful for bibliography environments.
13785 The default longest label
13786 \begin_inset Quotes eld
13790 \begin_inset Quotes erd
13793 can be changed by the user in the paragraph settings of a bibliography
13797 \begin_layout Standard
13798 Putting the last few things together, the \SpecialChar LaTeX
13799 output will be either:
13802 \begin_layout LyX-Code
13805 LatexName[LatexParam]{\SpecialChar ldots
13809 \begin_layout Standard
13813 \begin_layout LyX-Code
13816 begin{LatexName}[LatexParam] \SpecialChar ldots
13822 \begin_layout Standard
13823 depending upon the \SpecialChar LaTeX
13828 \begin_layout Description
13829 \begin_inset Flex Code
13832 \begin_layout Plain Layout
13839 \begin_inset Flex Code
13842 \begin_layout Plain Layout
13848 ] A string that is put at the beginning of the style content.
13849 A line break in the output can be indicated by
13850 \begin_inset Flex Code
13853 \begin_layout Plain Layout
13862 \begin_layout Description
13863 \begin_inset Flex Code
13866 \begin_layout Plain Layout
13873 \begin_inset Flex Code
13876 \begin_layout Plain Layout
13882 ] If you put styles into environments, the different
13883 \begin_inset Flex Code
13886 \begin_layout Plain Layout
13892 are not simply added, but added with a factor
13893 \begin_inset Formula $\frac{4}{\mathrm{depth}+4}$
13897 Note that this parameter is also used when
13898 \begin_inset Flex Code
13901 \begin_layout Plain Layout
13908 \begin_inset Flex Code
13911 \begin_layout Plain Layout
13918 \begin_inset Flex Code
13921 \begin_layout Plain Layout
13928 Then it is added to the manual or dynamic margin.
13929 \begin_inset Newline newline
13933 \begin_inset Quotes eld
13937 \begin_inset Flex Code
13940 \begin_layout Plain Layout
13947 \begin_inset Quotes erd
13950 means that the paragraph is indented with the width of
13951 \begin_inset Quotes eld
13955 \begin_inset Flex Code
13958 \begin_layout Plain Layout
13965 \begin_inset Quotes erd
13968 in the normal font.
13969 You can get a negative width by prefixing the string with
13970 \begin_inset Quotes eld
13974 \begin_inset Flex Code
13977 \begin_layout Plain Layout
13984 \begin_inset Quotes erd
13988 This way was chosen so that the look is the same with each used screen
13992 \begin_layout Description
13993 \begin_inset Flex Code
13996 \begin_layout Plain Layout
14003 \begin_inset Flex Code
14006 \begin_layout Plain Layout
14011 , Manual, Dynamic, First_Dynamic, Right_Address_Box
14017 \begin_inset Newline newline
14020 The kind of margin that the style has on the left side.
14021 \begin_inset Separator parbreak
14028 \begin_layout Description
14029 \begin_inset Flex Code
14032 \begin_layout Plain Layout
14038 just means a fixed margin.
14041 \begin_layout Description
14042 \begin_inset Flex Code
14045 \begin_layout Plain Layout
14051 means that the left margin depends on the string entered in the
14052 \begin_inset Flex MenuItem
14055 \begin_layout Plain Layout
14056 Edit\SpecialChar menuseparator
14058 \begin_inset space ~
14067 This is used to typeset nice lists without tabulators.
14070 \begin_layout Description
14071 \begin_inset Flex Code
14074 \begin_layout Plain Layout
14080 means that the margin depends on the size of the label.
14081 This is used for automatic enumerated headlines.
14082 It is obvious that the headline
14083 \begin_inset Quotes eld
14086 5.4.3.2.1 Very long headline
14087 \begin_inset Quotes erd
14090 must have a wider left margin (as wide as
14091 \begin_inset Quotes eld
14095 \begin_inset Quotes erd
14098 plus the space) than
14099 \begin_inset Quotes eld
14102 3.2 Very long headline
14103 \begin_inset Quotes erd
14107 \begin_inset Quotes eld
14111 \begin_inset Quotes erd
14114 are not able to do this.
14117 \begin_layout Description
14118 \begin_inset Flex Code
14121 \begin_layout Plain Layout
14127 is similar, but only the very first row of the paragraph is dynamic, while
14128 the others are static; this is used, for example, for descriptions.
14131 \begin_layout Description
14132 \begin_inset Flex Code
14135 \begin_layout Plain Layout
14141 means the margin is chosen in a way that the longest row of this paragraph
14142 fits to the right margin.
14143 This is used to typeset an address on the right edge of the page.
14147 \begin_layout Description
14148 \begin_inset Flex Code
14151 \begin_layout Plain Layout
14158 \begin_inset Flex Code
14161 \begin_layout Plain Layout
14170 \begin_inset space \thinspace{}
14174 \begin_inset Flex Code
14177 \begin_layout Plain Layout
14183 ] Whether fragile commands in this style should be
14184 \begin_inset Flex Code
14187 \begin_layout Plain Layout
14200 whether this command should itself be protected.)
14203 \begin_layout Description
14204 \begin_inset Flex Code
14207 \begin_layout Plain Layout
14214 \begin_inset Flex Code
14217 \begin_layout Plain Layout
14224 \begin_inset space \thinspace{}
14228 \begin_inset Flex Code
14231 \begin_layout Plain Layout
14239 ] Whether newlines are translated into \SpecialChar LaTeX
14241 \begin_inset Flex Code
14244 \begin_layout Plain Layout
14255 The translation can be switched off to allow more comfortable \SpecialChar LaTeX
14257 inside \SpecialChar LyX
14261 \begin_layout Description
14262 \begin_inset Flex Code
14265 \begin_layout Plain Layout
14272 \begin_inset Flex Code
14275 \begin_layout Plain Layout
14284 \begin_inset space \thinspace{}
14288 \begin_inset Flex Code
14291 \begin_layout Plain Layout
14297 ] If set to true, and if
14298 \begin_inset Flex Code
14301 \begin_layout Plain Layout
14308 \begin_inset Flex Code
14311 \begin_layout Plain Layout
14317 ) paragraphs are being indented, then the indentation of such a paragraph
14318 following one of this type will be suppressed.
14319 (So this will not affect the display of non-default paragraphs.)
14322 \begin_layout Description
14323 \begin_inset Flex Code
14326 \begin_layout Plain Layout
14333 \begin_inset Flex Code
14336 \begin_layout Plain Layout
14342 ] Name of a style that has replaced this style.
14343 This is used to rename a style, while keeping backward compatibility.
14344 \change_inserted -712698321 1432986397
14348 \begin_layout Description
14350 \change_inserted -712698321 1432986583
14351 \begin_inset Flex Code
14354 \begin_layout Plain Layout
14356 \change_inserted -712698321 1432986403
14363 \begin_inset Flex Code
14366 \begin_layout Plain Layout
14368 \change_inserted -712698321 1432986397
14375 \begin_inset space \thinspace{}
14379 \begin_inset Flex Code
14382 \begin_layout Plain Layout
14384 \change_inserted -712698321 1432986397
14390 ] Determines whether consecutive pragraphs of the same type are treated
14391 as belonging together.
14392 This has the effect that the
14393 \begin_inset Flex Code
14396 \begin_layout Plain Layout
14398 \change_inserted -712698321 1432986460
14404 is only printed once before such a group.
14405 By default, this is true for
14406 \begin_inset Flex Code
14409 \begin_layout Plain Layout
14411 \change_inserted -712698321 1432986491
14418 \begin_inset Flex Code
14421 \begin_layout Plain Layout
14423 \change_inserted -712698321 1432986583
14432 \begin_inset Flex Code
14435 \begin_layout Plain Layout
14437 \change_inserted -712698321 1432986572
14445 and false for all other types.
14450 \begin_layout Description
14451 \begin_inset Flex Code
14454 \begin_layout Plain Layout
14461 \begin_inset Flex Code
14464 \begin_layout Plain Layout
14473 \begin_inset space \thinspace{}
14477 \begin_inset Flex Code
14480 \begin_layout Plain Layout
14486 ] Indicates that paragraphs will not be separated by an empty line in \SpecialChar LaTeX
14488 but only by a line break; together with
14489 \begin_inset Flex Code
14492 \begin_layout Plain Layout
14498 , this allows to emulate a plain text editor (like the ERT inset).
14501 \begin_layout Description
14502 \begin_inset Flex Code
14505 \begin_layout Plain Layout
14512 \begin_inset Flex Code
14515 \begin_layout Plain Layout
14521 ] The indent of the very first line of a paragraph.
14523 \begin_inset Newline newline
14527 \begin_inset Flex Code
14530 \begin_layout Plain Layout
14536 will be fixed for a certain style.
14537 The exception is the default style, since the indentation for these paragraphs
14538 can be prohibited with
14539 \begin_inset Flex Code
14542 \begin_layout Plain Layout
14550 \begin_inset Flex Code
14553 \begin_layout Plain Layout
14559 style paragraphs inside environments use the
14560 \begin_inset Flex Code
14563 \begin_layout Plain Layout
14569 of the environment, not their native one.
14571 \begin_inset Flex Code
14574 \begin_layout Plain Layout
14580 paragraphs inside an enumeration are not indented.
14583 \begin_layout Description
14584 \begin_inset Flex Code
14587 \begin_layout Plain Layout
14594 \begin_inset Flex Code
14597 \begin_layout Plain Layout
14603 ] The vertical space between two paragraphs of this style.
14606 \begin_layout Description
14607 \begin_inset Flex Code
14610 \begin_layout Plain Layout
14617 \begin_inset Flex Code
14620 \begin_layout Plain Layout
14627 allows the user to choose either
14628 \begin_inset Quotes eld
14632 \begin_inset Quotes erd
14636 \begin_inset Quotes eld
14640 \begin_inset Quotes erd
14643 to separate paragraphs.
14645 \begin_inset Quotes eld
14649 \begin_inset Quotes erd
14653 \begin_inset Flex Code
14656 \begin_layout Plain Layout
14664 \begin_inset Quotes eld
14668 \begin_inset Quotes erd
14672 \begin_inset Flex Code
14675 \begin_layout Plain Layout
14681 is ignored and all paragraphs are separated by the
14682 \begin_inset Flex Code
14685 \begin_layout Plain Layout
14692 The vertical space is calculated with
14693 \begin_inset Flex Code
14696 \begin_layout Plain Layout
14698 \begin_inset space ~
14707 \begin_inset Flex Code
14710 \begin_layout Plain Layout
14716 is the height of a row with the normal font.
14717 This way, the look stays the same with different screen fonts.
14720 \begin_layout Description
14721 \begin_inset Flex Code
14724 \begin_layout Plain Layout
14731 \begin_inset Flex Code
14734 \begin_layout Plain Layout
14743 \begin_inset space \thinspace{}
14747 \begin_inset Flex Code
14750 \begin_layout Plain Layout
14756 ] Whether the contents of this paragraph should be output in raw form, meaning
14757 without special translations that \SpecialChar LaTeX
14759 \change_inserted 155139281 1429534178
14763 \begin_layout Description
14765 \change_inserted 155139281 1429534242
14768 \begin_inset Flex Code
14771 \begin_layout Plain Layout
14773 \change_inserted 155139281 1429534178
14782 \begin_inset Flex Code
14785 \begin_layout Plain Layout
14787 \change_inserted 155139281 1429534178
14788 string of characters
14797 Defines individual characters that should be output in raw form, meaning
14798 without special translations that \SpecialChar LaTeX
14804 \begin_layout Description
14805 \begin_inset Flex Code
14808 \begin_layout Plain Layout
14814 Information to be included in the \SpecialChar LaTeX
14815 preamble when this style is used.
14816 Used to define macros, load packages, etc., required by this particular
14819 \begin_inset Quotes eld
14823 \begin_inset Flex Code
14826 \begin_layout Plain Layout
14833 \begin_inset Quotes erd
14839 \begin_layout Description
14840 \begin_inset Flex Code
14843 \begin_layout Plain Layout
14850 \begin_inset Flex Code
14853 \begin_layout Plain Layout
14859 ] The prefix to use when creating labels referring to paragraphs of this
14861 This allows the use of formatted references.
14864 \begin_layout Description
14865 \begin_inset Flex Code
14868 \begin_layout Plain Layout
14875 \begin_inset Flex Code
14878 \begin_layout Plain Layout
14884 ] Whether the style requires the feature
14885 \begin_inset Flex Code
14888 \begin_layout Plain Layout
14895 \change_deleted -712698321 1438601713
14900 \change_deleted -712698321 1438601638
14901 See the description of
14902 \begin_inset Flex Code
14905 \begin_layout Plain Layout
14912 \begin_inset CommandInset ref
14914 reference "subsec:General-text-class"
14918 ) for information on `features'.
14919 \change_inserted -712698321 1438601711
14921 \begin_inset CommandInset ref
14923 reference "chap:List-of-functions"
14927 for the list of features).
14928 If you require a package with specific options, you can additionally use
14930 \begin_inset Flex Code
14933 \begin_layout Plain Layout
14935 \change_inserted -712698321 1438601638
14941 as a general text class parameter (see sec.
14942 \begin_inset space ~
14946 \begin_inset CommandInset ref
14948 reference "subsec:General-text-class"
14957 \begin_layout Description
14958 \begin_inset Flex Code
14961 \begin_layout Plain Layout
14968 \begin_inset Flex Code
14971 \begin_layout Plain Layout
14980 \begin_inset Flex Code
14983 \begin_layout Plain Layout
14989 ] Resets the \SpecialChar LaTeX
14990 arguments of this style (as defined via the
14991 \begin_inset Flex Code
14994 \begin_layout Plain Layout
15001 This is useful if you have copied a style via
15002 \begin_inset Flex Code
15005 \begin_layout Plain Layout
15011 , but you do not want to inherit its (required and optional) arguments.
15014 \begin_layout Description
15015 \begin_inset Flex Code
15018 \begin_layout Plain Layout
15025 \begin_inset Flex Code
15028 \begin_layout Plain Layout
15034 ] A string that is put at the end of the layout content.
15035 A line break in the output can be indicated by
15036 \begin_inset Flex Code
15039 \begin_layout Plain Layout
15048 \begin_layout Description
15049 \begin_inset Flex Code
15052 \begin_layout Plain Layout
15059 \begin_inset Flex Code
15062 \begin_layout Plain Layout
15069 \begin_inset Flex Code
15072 \begin_layout Plain Layout
15081 \begin_layout Description
15082 \begin_inset Flex Code
15085 \begin_layout Plain Layout
15092 \begin_inset Flex Code
15095 \begin_layout Plain Layout
15104 \begin_inset Flex Code
15107 \begin_layout Plain Layout
15114 \begin_inset Flex Code
15117 \begin_layout Plain Layout
15124 \begin_inset Flex Code
15127 \begin_layout Plain Layout
15129 \begin_inset space ~
15137 ] This defines what the default spacing should be in the style.
15139 \begin_inset Flex Code
15142 \begin_layout Plain Layout
15149 \begin_inset Flex Code
15152 \begin_layout Plain Layout
15159 \begin_inset Flex Code
15162 \begin_layout Plain Layout
15168 correspond respectively to a multiplier value of 1, 1.25 and 1.667.
15169 If you specify the argument
15170 \begin_inset Flex Code
15173 \begin_layout Plain Layout
15179 , then you must also provide a value argument which will be the actual multiplie
15181 Note that, contrary to other parameters,
15182 \begin_inset Flex Code
15185 \begin_layout Plain Layout
15191 implies the generation of specific \SpecialChar LaTeX
15192 code, using the \SpecialChar LaTeX
15196 \begin_inset Flex Code
15199 \begin_layout Plain Layout
15208 \begin_layout Description
15209 \begin_inset Flex Code
15212 \begin_layout Plain Layout
15219 \begin_inset Flex Code
15222 \begin_layout Plain Layout
15229 \begin_inset space \thinspace{}
15233 \begin_inset Flex Code
15236 \begin_layout Plain Layout
15244 ] Allow spell-checking paragraphs of this style.
15248 \begin_layout Description
15249 \begin_inset Flex Code
15252 \begin_layout Plain Layout
15258 The font used for the text body .
15260 \begin_inset CommandInset ref
15262 reference "subsec:Font-description"
15269 \begin_layout Description
15270 \begin_inset Flex Code
15273 \begin_layout Plain Layout
15282 \begin_inset Flex Code
15285 \begin_layout Plain Layout
15295 The level of the style in the table of contents.
15296 This is used for automatic numbering of section headings.
15297 \change_inserted -712698321 1401363541
15301 \begin_layout Description
15303 \change_inserted -712698321 1401363906
15304 \begin_inset Flex Code
15307 \begin_layout Plain Layout
15309 \change_inserted -712698321 1401363547
15318 \begin_inset Flex Code
15321 \begin_layout Plain Layout
15323 \change_inserted -712698321 1401363664
15336 \begin_inset Flex Code
15339 \begin_layout Plain Layout
15341 \change_inserted -712698321 1401363669
15350 \begin_inset Flex Code
15353 \begin_layout Plain Layout
15355 \change_inserted -712698321 1401363675
15363 ] This tag determines whether the first line indentation of this paragraph
15364 can be toggled via the Paragraph settings dialog.
15368 \begin_inset Flex Code
15371 \begin_layout Plain Layout
15373 \change_inserted -712698321 1401363761
15383 is set, indentation can be toggled if the document settings use
15384 \begin_inset Quotes eld
15388 \begin_inset Quotes erd
15391 paragraph style, with
15392 \begin_inset Flex Code
15395 \begin_layout Plain Layout
15397 \change_inserted -712698321 1401363844
15403 , indentation can always be toggled, notwithstanding the document settings,
15405 \begin_inset Flex Code
15408 \begin_layout Plain Layout
15410 \change_inserted -712698321 1401363901
15416 , indentation can never be toggled.
15421 \begin_layout Description
15422 \begin_inset Flex Code
15425 \begin_layout Plain Layout
15432 \begin_inset Flex Code
15435 \begin_layout Plain Layout
15441 ] The vertical space with which the very first of a chain of paragraphs
15442 with this style is separated from the previous paragraph.
15443 If the previous paragraph has another style, the separations are not simply
15444 added, but the maximum is taken.
15447 \begin_layout Subsection
15448 \begin_inset CommandInset label
15454 Internationalization of Paragraph Styles
15457 \begin_layout Standard
15459 has long supported internationalization of layout information, but, until
15460 version 2.0, this applied only to the user interface and not to, say, PDF
15462 Thus, French authors were forced to resort to ugly hacks if they wanted
15467 1' instead of `Theorem 1'.
15468 Thanks to Georg Baum, that is no longer the case.
15471 \begin_layout Standard
15473 \begin_inset Flex Code
15476 \begin_layout Plain Layout
15482 defines text that is to appear in the typeset document, it may use
15483 \begin_inset Flex Code
15486 \begin_layout Plain Layout
15493 \begin_inset Flex Code
15496 \begin_layout Plain Layout
15502 to support non-English and even multi-language documents correctly.
15503 The following excerpt (from the
15504 \begin_inset Flex Code
15507 \begin_layout Plain Layout
15513 file) shows how this works:
15516 \begin_layout LyX-Code
15518 \begin_inset Separator parbreak
15525 \begin_layout LyX-Code
15528 theoremstyle{remark}
15531 \begin_layout LyX-Code
15534 newtheorem{claim}[thm]{
15541 \begin_layout LyX-Code
15545 \begin_layout LyX-Code
15549 \begin_layout LyX-Code
15554 claimname}{_(Claim)}
15557 \begin_layout LyX-Code
15561 \begin_layout LyX-Code
15565 \begin_layout LyX-Code
15574 claimname}{_(Claim)}}
15577 \begin_layout LyX-Code
15582 \begin_layout Standard
15583 In principle, any legal \SpecialChar LaTeX
15585 \begin_inset Flex Code
15588 \begin_layout Plain Layout
15595 \begin_inset Flex Code
15598 \begin_layout Plain Layout
15604 tags, but in practice they will typically look as they do here.
15605 The key to correct translation of the typeset text is the definition of
15606 the \SpecialChar LaTeX
15608 \begin_inset Flex Code
15611 \begin_layout Plain Layout
15620 \begin_inset Flex Code
15623 \begin_layout Plain Layout
15635 \begin_layout Standard
15637 \begin_inset Flex Code
15640 \begin_layout Plain Layout
15646 tag provides for internationalization based upon the overall language of
15648 The contents of the tag will be included in the preamble, just as with
15650 \begin_inset Flex Code
15653 \begin_layout Plain Layout
15660 What makes it special is the use of the
15661 \begin_inset Quotes eld
15665 \begin_inset Quotes erd
15669 \begin_inset Flex Code
15672 \begin_layout Plain Layout
15678 , which will be replaced, when \SpecialChar LyX
15679 produces \SpecialChar LaTeX
15680 output, with the translation of
15681 its argument into the document language.
15684 \begin_layout Standard
15686 \begin_inset Flex Code
15689 \begin_layout Plain Layout
15695 tag is more complex, since it is meant to provide support for multi-language
15696 documents and so offers an interface to the
15697 \begin_inset Flex Code
15700 \begin_layout Plain Layout
15707 Its contents will be added to the preamble once for each language that
15708 appears in the document.
15709 In this case, the argument to
15710 \begin_inset Flex Code
15713 \begin_layout Plain Layout
15719 will be replaced with its translation into the language in question; the
15721 \begin_inset Flex Code
15724 \begin_layout Plain Layout
15730 is replaced by the language name (as used by the babel package).
15733 \begin_layout Standard
15734 A German document that also included a French section would thus have the
15735 following in the preamble:
15738 \begin_layout LyX-Code
15747 claimname}{Affirmation}}
15748 \begin_inset Newline newline
15759 claimname}{Behauptung}}
15760 \begin_inset Newline newline
15767 claimname}{Behauptung}
15770 \begin_layout Standard
15773 \begin_inset Flex Code
15776 \begin_layout Plain Layout
15782 will then conspire to produce the correct text in the output.
15785 \begin_layout Standard
15786 One important point to note here is that the translations are provided by
15788 itself, through the file
15789 \begin_inset Flex Code
15792 \begin_layout Plain Layout
15799 This means, in effect, that
15800 \begin_inset Flex Code
15803 \begin_layout Plain Layout
15810 \begin_inset Flex Code
15813 \begin_layout Plain Layout
15819 are really only of use in layout files that are provided with \SpecialChar LyX
15821 entered in user-created layout files will not be seen by \SpecialChar LyX
15822 's internationalizatio
15823 n routines unless the
15824 \begin_inset Flex Code
15827 \begin_layout Plain Layout
15833 file is modified accordingly.
15834 That said, however, any layout created with the intention that it will
15835 be included with \SpecialChar LyX
15836 should use these tags where appropriate.
15837 Please note that the paragraph style translations provided by \SpecialChar LyX
15839 change with a minor update (e.
15840 \begin_inset space \thinspace{}
15844 \begin_inset space \space{}
15847 from version 2.1.x to 2.1.y).
15848 It is however quite likely that a major update (e.
15849 \begin_inset space \thinspace{}
15853 \begin_inset space \space{}
15856 from 2.0.x to 2.1.y) will introduce new translations or corrections.
15859 \begin_layout Subsection
15861 \begin_inset CommandInset label
15863 name "subsec:Floats"
15870 \begin_layout Standard
15871 It is necessary to define the floats (
15872 \begin_inset Flex MenuItem
15875 \begin_layout Plain Layout
15882 \begin_inset Flex MenuItem
15885 \begin_layout Plain Layout
15891 , \SpecialChar ldots
15892 ) in the text class itself.
15893 Standard floats are included in the file
15894 \begin_inset Flex Code
15897 \begin_layout Plain Layout
15903 , so you may have to do no more than add
15906 \begin_layout LyX-Code
15907 Input stdfloats.inc
15910 \begin_layout Standard
15911 to your layout file.
15912 If you want to implement a text class that proposes some other float types
15913 (like the AGU class bundled with \SpecialChar LyX
15914 ), the information below will hopefully
15916 \change_inserted -712698321 1432283506
15920 \begin_layout Description
15922 \change_inserted -712698321 1432313622
15923 \begin_inset Flex Code
15926 \begin_layout Plain Layout
15928 \change_inserted -712698321 1432283514
15935 \begin_inset Flex Code
15938 \begin_layout Plain Layout
15940 \change_inserted -712698321 1432283507
15946 =!htbpH] Allowed placement options for this float type.
15947 The value is a string of placement characters.
15948 Possible characters include:
15953 \begin_inset Quotes eld
15957 \begin_inset Quotes erd
15965 \begin_inset Quotes eld
15969 \begin_inset Quotes erd
15977 \begin_inset Quotes eld
15981 \begin_inset Quotes erd
15989 \begin_inset Quotes eld
15993 \begin_inset Quotes erd
16001 \begin_inset Quotes eld
16005 \begin_inset Quotes erd
16013 \begin_inset Quotes eld
16017 \begin_inset Quotes erd
16021 The order of the characters in the string does not matter.
16022 If no placement options are allowed, use the string
16029 \begin_layout Description
16031 \change_inserted -712698321 1432313755
16032 \begin_inset Flex Code
16035 \begin_layout Plain Layout
16037 \change_inserted -712698321 1432313630
16044 \begin_inset Flex Code
16047 \begin_layout Plain Layout
16049 \change_inserted -712698321 1432313646
16058 \begin_inset space \thinspace{}
16064 \begin_inset Flex Code
16067 \begin_layout Plain Layout
16069 \change_inserted -712698321 1432313646
16079 ] Defines whether the float allows to be rotated via the rotfloat package
16082 \begin_inset Flex Code
16085 \begin_layout Plain Layout
16087 \change_inserted -712698321 1432313721
16093 if the float does not support this feature.
16096 \begin_layout Description
16098 \change_inserted -712698321 1432313802
16099 \begin_inset Flex Code
16102 \begin_layout Plain Layout
16104 \change_inserted -712698321 1432313759
16111 \begin_inset Flex Code
16114 \begin_layout Plain Layout
16116 \change_inserted -712698321 1432313755
16125 \begin_inset space \thinspace{}
16131 \begin_inset Flex Code
16134 \begin_layout Plain Layout
16136 \change_inserted -712698321 1432313755
16146 ] Defines whether the float has a starred variant that spans columns in
16147 a two column paragraph.
16149 \begin_inset Flex Code
16152 \begin_layout Plain Layout
16154 \change_inserted -712698321 1432313755
16160 if the float does not support this feature.
16165 \begin_layout Description
16166 \begin_inset Flex Code
16169 \begin_layout Plain Layout
16176 \begin_inset Flex Code
16179 \begin_layout Plain Layout
16186 \begin_inset Quotes erd
16190 \begin_inset Quotes erd
16193 ] The file name extension of an auxiliary file for the list of figures (or
16196 writes the captions to this file.
16199 \begin_layout Description
16200 \begin_inset Flex Code
16203 \begin_layout Plain Layout
16210 \begin_inset Flex Code
16213 \begin_layout Plain Layout
16220 \begin_inset Quotes erd
16224 \begin_inset Quotes erd
16227 ] The string that will be used in the menus and also for the caption.
16228 This is translated to the current language if babel is used.
16231 \begin_layout Description
16232 \begin_inset Flex Code
16235 \begin_layout Plain Layout
16241 These tags control the XHTML output.
16243 \begin_inset CommandInset ref
16245 reference "sec:Tags-for-XHTML"
16252 \begin_layout Description
16253 \begin_inset Flex Code
16256 \begin_layout Plain Layout
16265 \begin_inset Flex Code
16268 \begin_layout Plain Layout
16277 \begin_inset space \thinspace{}
16281 \begin_inset Flex Code
16284 \begin_layout Plain Layout
16290 ] Indicates whether the float is already defined in the document class or
16291 if instead the \SpecialChar LaTeX
16293 \begin_inset Flex Code
16296 \begin_layout Plain Layout
16302 needs to be loaded to define it on-the-fly.
16304 \begin_inset Flex Code
16307 \begin_layout Plain Layout
16314 \begin_inset Flex Code
16317 \begin_layout Plain Layout
16324 It should be set to
16325 \begin_inset Flex Code
16328 \begin_layout Plain Layout
16334 if the float is already defined by the \SpecialChar LaTeX
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 ] The command used to generate a list of floats of this type; the leading
16375 \begin_inset Flex Code
16378 \begin_layout Plain Layout
16384 is false, since there is no standard way to generate this command.
16386 \begin_inset Flex Code
16389 \begin_layout Plain Layout
16395 is true, since in that case there is a standard way to define the command.
16398 \begin_layout Description
16399 \begin_inset Flex Code
16402 \begin_layout Plain Layout
16409 \begin_inset Flex Code
16412 \begin_layout Plain Layout
16419 \begin_inset Quotes erd
16423 \begin_inset Quotes erd
16426 ] A title for a list of floats of this kind (list of figures, tables, or
16428 It is used for the screen label within \SpecialChar LyX
16429 , it is used by \SpecialChar LaTeX
16431 it is used as the title in the XHTML output.
16432 It will be translated to the document language.
16435 \begin_layout Description
16436 \begin_inset Flex Code
16439 \begin_layout Plain Layout
16446 \begin_inset Flex Code
16449 \begin_layout Plain Layout
16456 \begin_inset Quotes erd
16460 \begin_inset Quotes erd
16463 ] This (optional) argument determines whether floats of this class will
16464 be numbered within some sectional unit of the document.
16466 \begin_inset Flex Code
16469 \begin_layout Plain Layout
16476 \begin_inset Quotes eld
16480 \begin_inset Flex Code
16483 \begin_layout Plain Layout
16490 \begin_inset Quotes erd
16493 , the floats will be numbered within chapters.
16497 \begin_layout Description
16498 \begin_inset Flex Code
16501 \begin_layout Plain Layout
16508 \begin_inset Flex Code
16511 \begin_layout Plain Layout
16518 \begin_inset Quotes erd
16522 \begin_inset Quotes erd
16525 ] The default placement for the given class of floats.
16526 The string should be as in standard \SpecialChar LaTeX
16528 \begin_inset Flex Code
16531 \begin_layout Plain Layout
16538 \begin_inset Flex Code
16541 \begin_layout Plain Layout
16548 \begin_inset Flex Code
16551 \begin_layout Plain Layout
16558 \begin_inset Flex Code
16561 \begin_layout Plain Layout
16567 for top, bottom, page, and here, respectively.
16571 \begin_layout Plain Layout
16572 Note that the order of these letters in the string is irrelevant, like in
16579 On top of that there is a new type,
16580 \begin_inset Flex Code
16583 \begin_layout Plain Layout
16589 , which does not really correspond to a float, since it means: put it
16590 \begin_inset Quotes eld
16594 \begin_inset Quotes erd
16598 Note however that the
16599 \begin_inset Flex Code
16602 \begin_layout Plain Layout
16608 specifier is special and, because of implementation details, cannot be
16609 used in non-built in float types.
16610 If you do not understand what this means, just use
16611 \begin_inset Quotes eld
16615 \begin_inset Flex Code
16618 \begin_layout Plain Layout
16625 \begin_inset Quotes erd
16631 \begin_layout Description
16632 \begin_inset Flex Code
16635 \begin_layout Plain Layout
16642 \begin_inset Flex Code
16645 \begin_layout Plain Layout
16651 ] The prefix to use when creating labels referring to floats of this type.
16652 This allows the use of formatted references.
16653 Note that you can remove any
16654 \begin_inset Flex Code
16657 \begin_layout Plain Layout
16663 set by a copied style by using the special value
16664 \begin_inset Quotes eld
16668 \begin_inset Quotes erd
16671 , which must be all caps.
16674 \begin_layout Description
16675 \begin_inset Flex Code
16678 \begin_layout Plain Layout
16685 \begin_inset Flex Code
16688 \begin_layout Plain Layout
16695 \begin_inset Quotes erd
16699 \begin_inset Quotes erd
16702 ] The style used when defining the float using
16703 \begin_inset Flex Code
16706 \begin_layout Plain Layout
16717 \begin_layout Description
16718 \begin_inset Flex Code
16721 \begin_layout Plain Layout
16728 \begin_inset Flex Code
16731 \begin_layout Plain Layout
16738 \begin_inset Quotes erd
16742 \begin_inset Quotes erd
16746 \begin_inset Quotes eld
16750 \begin_inset Quotes erd
16753 of the new class of floats, like program or algorithm.
16754 After the appropriate
16755 \begin_inset Flex Code
16758 \begin_layout Plain Layout
16767 \begin_inset Flex Code
16770 \begin_layout Plain Layout
16779 \begin_inset Flex Code
16782 \begin_layout Plain Layout
16793 \begin_layout Description
16794 \begin_inset Flex Code
16797 \begin_layout Plain Layout
16804 \begin_inset Flex Code
16807 \begin_layout Plain Layout
16814 \begin_inset space \thinspace{}
16818 \begin_inset Flex Code
16821 \begin_layout Plain Layout
16829 ] Specifies whether this float is defined using the \SpecialChar LaTeX
16831 \begin_inset Flex Code
16834 \begin_layout Plain Layout
16840 , either by the class file, another package or on-the-fly by \SpecialChar LyX
16844 \begin_layout Standard
16845 Note that defining a float with type
16846 \begin_inset Flex Code
16849 \begin_layout Plain Layout
16857 automatically defines the corresponding counter with name
16858 \begin_inset Flex Code
16861 \begin_layout Plain Layout
16872 \begin_layout Subsection
16873 Flex insets and InsetLayout
16874 \begin_inset CommandInset label
16876 name "subsec:Flex-insets-and"
16883 \begin_layout Standard
16884 Flex insets come in three different kinds:
16887 \begin_layout Itemize
16889 \begin_inset Flex Code
16892 \begin_layout Plain Layout
16898 ): These define semantic markup corresponding to such \SpecialChar LaTeX
16900 \begin_inset Flex Code
16903 \begin_layout Plain Layout
16912 \begin_inset Flex Code
16915 \begin_layout Plain Layout
16926 \begin_layout Itemize
16928 \begin_inset Flex Code
16931 \begin_layout Plain Layout
16937 ): These can be used to define custom collapsible insets, similar to \SpecialChar TeX
16939 footnote, and the like.
16940 An obvious example is an endnote inset, which is defined in the
16941 \begin_inset Flex Code
16944 \begin_layout Plain Layout
16953 \begin_layout Itemize
16955 \begin_inset Flex Code
16958 \begin_layout Plain Layout
16964 ): For use with DocBook classes.
16967 \begin_layout Standard
16968 Flex insets are defined using the
16969 \begin_inset Flex Code
16972 \begin_layout Plain Layout
16978 tag, which shall be explained in a moment.
16981 \begin_layout Standard
16983 \begin_inset Flex Code
16986 \begin_layout Plain Layout
16992 tag also serves another function: It can be used to customize the general
16993 layout of many different types of insets.
16995 \begin_inset Flex Code
16998 \begin_layout Plain Layout
17004 can be used to customize the layout parameters for footnotes, marginal
17005 notes, note insets, \SpecialChar TeX
17006 code (ERT) insets, branches, listings, indexes, boxes,
17007 tables, algorithms, URLs, and captions, as well as to define Flex insets.
17010 \begin_layout Standard
17012 \begin_inset Flex Code
17015 \begin_layout Plain Layout
17021 definition must begin with a line of the form:
17024 \begin_layout LyX-Code
17028 \begin_layout Standard
17030 \begin_inset Flex Code
17033 \begin_layout Plain Layout
17039 indicates the inset whose layout is being defined, and here there are four
17043 \begin_layout Enumerate
17044 The layout for a pre-existing inset is being modified.
17045 In this case, can be
17046 \begin_inset Flex Code
17049 \begin_layout Plain Layout
17055 any one of the following:
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
17196 \begin_inset Flex Code
17199 \begin_layout Plain Layout
17206 \begin_inset Flex Code
17209 \begin_layout Plain Layout
17216 \begin_inset Flex Code
17219 \begin_layout Plain Layout
17226 \begin_inset Flex Code
17229 \begin_layout Plain Layout
17236 \begin_inset Flex Code
17239 \begin_layout Plain Layout
17246 \begin_inset Flex Code
17249 \begin_layout Plain Layout
17258 \begin_layout Enumerate
17259 The layout for a Flex inset is being defined.
17261 \begin_inset Flex Code
17264 \begin_layout Plain Layout
17270 must be of the form
17271 \begin_inset Quotes eld
17275 \begin_inset Flex Code
17278 \begin_layout Plain Layout
17285 \begin_inset Quotes erd
17289 \begin_inset Flex Code
17292 \begin_layout Plain Layout
17298 may be be any valid identifier not used by a pre-existing Flex inset.
17299 The identifier may include spaces, but in that case the whole thing must
17300 be wrapped in quotes.
17301 Note that the definition of a flex inset
17306 \begin_inset Flex Code
17309 \begin_layout Plain Layout
17311 \change_deleted -712698321 1437634848
17314 \change_inserted -712698321 1437634847
17322 entry, declaring which type of inset it defines.
17325 \begin_layout Enumerate
17326 The layout for user specific branch is being defined.
17328 \begin_inset Flex Code
17331 \begin_layout Plain Layout
17337 must be of the form
17338 \begin_inset Quotes eld
17342 \begin_inset Flex Code
17345 \begin_layout Plain Layout
17352 \begin_inset Quotes erd
17356 \begin_inset Flex Code
17359 \begin_layout Plain Layout
17365 may be be any valid identifier of branch defined in user's document.
17366 The identifier may include spaces, but in that case the whole thing must
17367 be wrapped in quotes.
17368 The main purpose of this feature is to allow \SpecialChar LaTeX
17369 wrapping around specific
17370 branches as user needs.
17373 \begin_layout Enumerate
17374 The layout of a user (or class) specific caption is being defined.
17376 \begin_inset Flex Code
17379 \begin_layout Plain Layout
17385 must be of the form
17386 \begin_inset Quotes eld
17390 \begin_inset Flex Code
17393 \begin_layout Plain Layout
17400 \begin_inset Quotes erd
17404 \begin_inset Flex Code
17407 \begin_layout Plain Layout
17413 specifies the name of the caption as it appears in the menu.
17414 Have a look at the standard caption (
17415 \begin_inset Flex Code
17418 \begin_layout Plain Layout
17424 ), the specific captions of the KOMA-Script classes (
17425 \begin_inset Flex Code
17428 \begin_layout Plain Layout
17435 \begin_inset Flex Code
17438 \begin_layout Plain Layout
17447 \begin_inset space ~
17453 \begin_inset Flex Code
17456 \begin_layout Plain Layout
17462 ) for applications.
17465 \begin_layout Standard
17467 \begin_inset Flex Code
17470 \begin_layout Plain Layout
17476 definition can contain the following entries:
17479 \begin_layout Description
17480 \begin_inset Flex Code
17483 \begin_layout Plain Layout
17490 \begin_inset Flex Code
17493 \begin_layout Plain Layout
17499 ] Defines argument number of a command\SpecialChar breakableslash
17500 environment associated with the current
17502 The definition must end with
17503 \begin_inset Flex Code
17506 \begin_layout Plain Layout
17514 \begin_inset CommandInset ref
17516 reference "subsec:Paragraph-Styles"
17523 \begin_layout Description
17524 \begin_inset Flex Code
17527 \begin_layout Plain Layout
17533 Preamble for changing language commands; see
17534 \begin_inset CommandInset ref
17536 reference "subsec:I18n"
17543 \begin_layout Description
17544 \begin_inset Flex Code
17547 \begin_layout Plain Layout
17554 \begin_inset Flex Code
17557 \begin_layout Plain Layout
17563 ] The color for the inset's background.
17565 \begin_inset CommandInset ref
17567 reference "chap:Names-of-colors"
17571 for a list of the available color names.
17574 \begin_layout Description
17575 \begin_inset Flex Code
17578 \begin_layout Plain Layout
17585 \begin_inset Flex Code
17588 \begin_layout Plain Layout
17597 \begin_inset space \thinspace{}
17601 \begin_inset Flex Code
17604 \begin_layout Plain Layout
17610 ] Whether to use the content of the inset as the label, when the inset is
17615 \begin_layout Description
17616 \begin_inset Flex Code
17619 \begin_layout Plain Layout
17626 \begin_inset Flex Code
17629 \begin_layout Plain Layout
17635 ] As with paragraph styles, see
17636 \begin_inset CommandInset ref
17638 reference "subsec:Paragraph-Styles"
17643 Note that you need to specify the complete type, e.
17644 \begin_inset space \thinspace{}
17648 \begin_inset space ~
17652 \begin_inset Flex Code
17655 \begin_layout Plain Layout
17656 CopyStyle Flex:<name>
17664 \begin_layout Description
17665 \begin_inset Flex Code
17668 \begin_layout Plain Layout
17675 \begin_inset Flex Code
17678 \begin_layout Plain Layout
17687 \begin_inset space \thinspace{}
17691 \begin_inset Flex Code
17694 \begin_layout Plain Layout
17700 ] Indicates whether the user may employ the Paragraph Settings dialog to
17701 customize the paragraph.
17704 \begin_layout Description
17705 \begin_inset Flex Code
17708 \begin_layout Plain Layout
17715 \begin_inset Flex Code
17718 \begin_layout Plain Layout
17725 \begin_inset Flex Code
17728 \begin_layout Plain Layout
17735 \begin_inset Flex Code
17738 \begin_layout Plain Layout
17744 , describing the rendering style used for the inset's frame and buttons.
17745 Footnotes generally use
17746 \begin_inset Flex Code
17749 \begin_layout Plain Layout
17755 , ERT insets generally
17756 \begin_inset Flex Code
17759 \begin_layout Plain Layout
17765 , and character styles
17766 \begin_inset Flex Code
17769 \begin_layout Plain Layout
17778 \begin_layout Description
17779 \begin_inset Flex Code
17782 \begin_layout Plain Layout
17789 \begin_inset Flex Code
17792 \begin_layout Plain Layout
17801 \begin_inset space \thinspace{}
17807 \begin_inset Flex Code
17810 \begin_layout Plain Layout
17819 \begin_inset Flex Code
17822 \begin_layout Plain Layout
17829 \begin_inset Flex Code
17832 \begin_layout Plain Layout
17839 Indicates whether the environment will stand on its own in the output or
17840 will appear inline with the surrounding text.
17841 If set to false, it is supposed that the \SpecialChar LaTeX
17842 environment ignores white space
17843 (including one newline character) after the
17844 \begin_inset Flex Code
17847 \begin_layout Plain Layout
17860 \begin_inset Flex Code
17863 \begin_layout Plain Layout
17879 \begin_layout Description
17880 \begin_inset Flex Code
17883 \begin_layout Plain Layout
17889 Required at the end of the
17890 \begin_inset Flex Code
17893 \begin_layout Plain Layout
17902 \begin_layout Description
17903 \begin_inset Flex Code
17906 \begin_layout Plain Layout
17912 The font used for both the text body
17918 \begin_inset CommandInset ref
17920 reference "subsec:Font-description"
17925 Note that defining this font automatically defines the
17926 \begin_inset Flex Code
17929 \begin_layout Plain Layout
17935 to the same value, so define this first and define
17936 \begin_inset Flex Code
17939 \begin_layout Plain Layout
17945 later if you want them to be different.
17946 \change_inserted -195340706 1421002157
17950 \begin_layout Description
17952 \change_inserted -195340706 1421002157
17953 \begin_inset Flex Code
17956 \begin_layout Plain Layout
17958 \change_inserted -195340706 1421002157
17959 FixedWidthPreambleEncoding
17965 \begin_inset Flex Code
17968 \begin_layout Plain Layout
17970 \change_inserted -195340706 1421002157
17979 \begin_inset space \thinspace{}
17983 \begin_inset Flex Code
17986 \begin_layout Plain Layout
17988 \change_inserted -195340706 1421002157
17994 ] Force a fixed width encoding for the translated contents of
17995 \begin_inset Flex Code
17998 \begin_layout Plain Layout
18000 \change_inserted -195340706 1421002157
18007 \begin_inset Flex Code
18010 \begin_layout Plain Layout
18012 \change_inserted -195340706 1421002157
18018 code generated by this layout.
18019 This is needed for special packages like the listings package that do not
18020 work with variable width encodings such as utf8.
18022 This setting is ignored if fully unicode aware \SpecialChar LaTeX
18023 backends such as Xe\SpecialChar LaTeX
18030 \begin_layout Description
18031 \begin_inset Flex Code
18034 \begin_layout Plain Layout
18035 ForceLocalFontSwitch
18041 \begin_inset Flex Code
18044 \begin_layout Plain Layout
18053 \begin_inset space \thinspace{}
18057 \begin_inset Flex Code
18060 \begin_layout Plain Layout
18066 ] When using babel, always use a local font switch (
18067 \begin_inset Flex Code
18070 \begin_layout Plain Layout
18078 ), never a global one (such as
18079 \begin_inset Flex Code
18082 \begin_layout Plain Layout
18093 \begin_layout Description
18094 \begin_inset Flex Code
18097 \begin_layout Plain Layout
18104 \begin_inset Flex Code
18107 \begin_layout Plain Layout
18116 \begin_inset space \thinspace{}
18120 \begin_inset Flex Code
18123 \begin_layout Plain Layout
18130 \begin_inset Quotes eld
18134 \begin_inset Quotes erd
18137 language, leading to Left-to-Right (Latin) output, e.
18138 \begin_inset space \thinspace{}
18142 \begin_inset space \space{}
18145 in \SpecialChar TeX
18148 \change_inserted -712698321 1417441977
18152 \begin_layout Description
18154 \change_inserted -712698321 1417442090
18155 \begin_inset Flex Code
18158 \begin_layout Plain Layout
18160 \change_inserted -712698321 1417441983
18167 \begin_inset Flex Code
18170 \begin_layout Plain Layout
18172 \change_inserted -712698321 1417441978
18181 \begin_inset space \thinspace{}
18185 \begin_inset Flex Code
18188 \begin_layout Plain Layout
18190 \change_inserted -712698321 1417441978
18196 ] Force a a line break in the \SpecialChar LaTeX
18197 output before the inset starts and after
18199 This assures the inset itself is output on its own lines, for parsing purposes.
18201 \change_inserted 274215730 1419105878
18207 \begin_layout Description
18208 \begin_inset Flex Code
18211 \begin_layout Plain Layout
18218 \begin_inset Flex Code
18221 \begin_layout Plain Layout
18230 \begin_inset space \thinspace{}
18234 \begin_inset Flex Code
18237 \begin_layout Plain Layout
18243 ] Indicates whether the
18244 \begin_inset Flex Code
18247 \begin_layout Plain Layout
18253 should be used or, instead, the user can change the paragraph style used
18258 \begin_layout Description
18259 \begin_inset Flex Code
18262 \begin_layout Plain Layout
18269 \begin_inset Flex Code
18272 \begin_layout Plain Layout
18281 \begin_inset space \thinspace{}
18285 \begin_inset Flex Code
18288 \begin_layout Plain Layout
18294 ] As with paragraph styles, see
18295 \begin_inset CommandInset ref
18297 reference "subsec:Paragraph-Styles"
18304 \begin_layout Description
18305 \begin_inset Flex Code
18308 \begin_layout Plain Layout
18314 These tags control the XHTML output.
18316 \begin_inset CommandInset ref
18318 reference "sec:Tags-for-XHTML"
18325 \begin_layout Description
18326 \begin_inset Flex Code
18329 \begin_layout Plain Layout
18336 \begin_inset Flex Code
18339 \begin_layout Plain Layout
18348 \begin_inset space \thinspace{}
18352 \begin_inset Flex Code
18355 \begin_layout Plain Layout
18361 ] Whether to include the contents of this inset in the strings generated
18362 for the `Outline' pane.
18363 One would not, for example, want the content of a footnote in a section
18364 header to be included in the TOC displayed in the outline, but one would
18365 normally want the content of a character style displayed.
18366 Default is false: not to include.
18369 \begin_layout Description
18370 \begin_inset Flex Code
18373 \begin_layout Plain Layout
18382 \begin_inset Flex Code
18385 \begin_layout Plain Layout
18394 \begin_inset space \thinspace{}
18398 \begin_inset Flex Code
18401 \begin_layout Plain Layout
18407 ] As with paragraph styles, see
18408 \begin_inset CommandInset ref
18410 reference "subsec:Paragraph-Styles"
18417 \begin_layout Description
18418 \begin_inset Flex Code
18421 \begin_layout Plain Layout
18427 The font used for the label.
18429 \begin_inset CommandInset ref
18431 reference "subsec:Font-description"
18436 Note that this definition can never appear before
18437 \begin_inset Flex Code
18440 \begin_layout Plain Layout
18446 , lest it be ineffective.
18449 \begin_layout Description
18450 \begin_inset Flex Code
18453 \begin_layout Plain Layout
18460 \begin_inset Flex Code
18463 \begin_layout Plain Layout
18470 \begin_inset Quotes erd
18474 \begin_inset Quotes erd
18477 ] What will be displayed on the button or elsewhere as the inset label.
18479 \begin_inset Flex Code
18482 \begin_layout Plain Layout
18490 \begin_inset Flex Code
18493 \begin_layout Plain Layout
18499 ) modify this label on the fly.
18502 \begin_layout Description
18503 \begin_inset Flex Code
18506 \begin_layout Plain Layout
18512 Language dependent preamble; see
18513 \begin_inset CommandInset ref
18515 reference "subsec:I18n"
18522 \begin_layout Description
18523 \begin_inset Flex Code
18526 \begin_layout Plain Layout
18533 \begin_inset Flex Code
18536 \begin_layout Plain Layout
18542 ] The name of the corresponding \SpecialChar LaTeX
18544 Either the environment or command name.
18547 \begin_layout Description
18548 \begin_inset Flex Code
18551 \begin_layout Plain Layout
18558 \begin_inset Flex Code
18561 \begin_layout Plain Layout
18567 ] The optional parameter for the corresponding
18568 \begin_inset Flex Code
18571 \begin_layout Plain Layout
18577 stuff, including possible bracket pairs like
18578 \begin_inset Flex Code
18581 \begin_layout Plain Layout
18588 This parameter cannot be changed from within \SpecialChar LyX
18590 \begin_inset Flex Code
18593 \begin_layout Plain Layout
18599 for customizable parameters).
18600 It will be output as is after all \SpecialChar LaTeX
18602 \begin_inset Flex Code
18605 \begin_layout Plain Layout
18614 \begin_layout Description
18615 \begin_inset Flex Code
18618 \begin_layout Plain Layout
18625 \begin_inset Flex Code
18628 \begin_layout Plain Layout
18629 Command, Environment, None
18634 ] How the style should be translated into \SpecialChar LaTeX
18639 \begin_layout Plain Layout
18640 \begin_inset Flex Code
18643 \begin_layout Plain Layout
18649 is perhaps a bit misleading, since these rules apply to SGML classes too.
18650 Visit the SGML class files for specific examples.
18656 \begin_inset Separator parbreak
18663 \begin_layout Description
18664 \begin_inset Flex Code
18667 \begin_layout Plain Layout
18673 means nothing special
18676 \begin_layout Description
18677 \begin_inset Flex Code
18680 \begin_layout Plain Layout
18687 \begin_inset Flex Code
18690 \begin_layout Plain Layout
18697 {\SpecialChar ldots
18706 \begin_layout Description
18707 \begin_inset Flex Code
18710 \begin_layout Plain Layout
18717 \begin_inset Flex Code
18720 \begin_layout Plain Layout
18727 }\SpecialChar ldots
18742 \begin_layout Standard
18743 Putting the last few things together, the \SpecialChar LaTeX
18744 output will be either:
18747 \begin_layout LyX-Code
18750 LatexName[LatexParam]{\SpecialChar ldots
18754 \begin_layout Standard
18758 \begin_layout LyX-Code
18761 begin{LatexName}[LatexParam] \SpecialChar ldots
18767 \begin_layout Standard
18768 depending upon the \SpecialChar LaTeX
18773 \begin_layout Description
18774 \begin_inset Flex Code
18777 \begin_layout Plain Layout
18784 \begin_inset Flex Code
18787 \begin_layout Plain Layout
18793 ] A string that is put at the beginning of the layout content.
18794 A line break in the output can be indicated by
18795 \begin_inset Flex Code
18798 \begin_layout Plain Layout
18807 \begin_layout Description
18808 \begin_inset Flex Code
18811 \begin_layout Plain Layout
18818 \begin_inset Flex Code
18821 \begin_layout Plain Layout
18828 \begin_inset Flex Code
18831 \begin_layout Plain Layout
18838 \begin_inset Flex Code
18841 \begin_layout Plain Layout
18848 \begin_inset Flex Code
18851 \begin_layout Plain Layout
18857 (indicating a dummy definition ending definitions of charstyles, etc).
18858 This entry is required in and is only meaningful for Flex insets.
18859 Among other things, it determines on which menu this inset will appear.
18861 \begin_inset Flex Code
18864 \begin_layout Plain Layout
18866 \change_deleted -712698321 1437634857
18869 \change_inserted -712698321 1437634858
18878 \begin_inset Flex Code
18881 \begin_layout Plain Layout
18887 will automatically set
18888 \begin_inset Flex Code
18891 \begin_layout Plain Layout
18899 \begin_inset Flex Code
18902 \begin_layout Plain Layout
18908 can be set to true for
18909 \begin_inset Flex Code
18912 \begin_layout Plain Layout
18918 insets by setting it
18923 \begin_inset Flex Code
18926 \begin_layout Plain Layout
18928 \change_deleted -712698321 1437634864
18931 \change_inserted -712698321 1437634865
18942 \begin_layout Description
18943 \begin_inset Flex Code
18946 \begin_layout Plain Layout
18953 \begin_inset Flex Code
18956 \begin_layout Plain Layout
18965 \begin_inset space \thinspace{}
18969 \begin_inset Flex Code
18972 \begin_layout Plain Layout
18978 ] Whether multiple paragraphs are permitted in this inset.
18980 \begin_inset Flex Code
18983 \begin_layout Plain Layout
18989 to the same value and
18990 \begin_inset Flex Code
18993 \begin_layout Plain Layout
18999 to the opposite value.
19000 These can be reset to other values, if they are used
19005 \begin_inset Flex Code
19008 \begin_layout Plain Layout
19018 \begin_layout Description
19019 \begin_inset Flex Code
19022 \begin_layout Plain Layout
19029 \begin_inset Flex Code
19032 \begin_layout Plain Layout
19041 \begin_inset space \thinspace{}
19045 \begin_inset Flex Code
19048 \begin_layout Plain Layout
19054 ] Whether fragile commands in this inset should be
19055 \begin_inset Flex Code
19058 \begin_layout Plain Layout
19071 whether the command should itself be protected.) Default is false.
19074 \begin_layout Description
19075 \begin_inset Flex Code
19078 \begin_layout Plain Layout
19085 \begin_inset Flex Code
19088 \begin_layout Plain Layout
19094 ] Deletes an existing
19095 \begin_inset Flex Code
19098 \begin_layout Plain Layout
19105 \change_inserted -712698321 1417953494
19109 \begin_layout Description
19111 \change_inserted -712698321 1417953559
19112 \begin_inset Flex Code
19115 \begin_layout Plain Layout
19117 \change_inserted -712698321 1417953494
19124 \begin_inset Flex Code
19127 \begin_layout Plain Layout
19129 \change_inserted -712698321 1417953574
19136 \begin_inset Flex Code
19139 \begin_layout Plain Layout
19141 \change_inserted -712698321 1417953533
19147 that has replaced this
19148 \begin_inset Flex Code
19151 \begin_layout Plain Layout
19153 \change_inserted -712698321 1417953551
19160 This is used to rename an
19161 \begin_inset Flex Code
19164 \begin_layout Plain Layout
19166 \change_inserted -712698321 1417953559
19172 , while keeping backward compatibility.
19177 \begin_layout Description
19178 \begin_inset Flex Code
19181 \begin_layout Plain Layout
19188 \begin_inset Flex Code
19191 \begin_layout Plain Layout
19200 \begin_inset space \thinspace{}
19204 \begin_inset Flex Code
19207 \begin_layout Plain Layout
19213 ] As with paragraph styles, see
19214 \begin_inset CommandInset ref
19216 reference "subsec:Paragraph-Styles"
19224 \begin_layout Description
19225 \begin_inset Flex Code
19228 \begin_layout Plain Layout
19235 \begin_inset Flex Code
19238 \begin_layout Plain Layout
19247 \begin_inset space \thinspace{}
19251 \begin_inset Flex Code
19254 \begin_layout Plain Layout
19260 ] As with paragraph styles, see
19261 \begin_inset CommandInset ref
19263 reference "subsec:Paragraph-Styles"
19271 \begin_layout Description
19272 \begin_inset Flex Code
19275 \begin_layout Plain Layout
19281 As with paragraph styles, see
19282 \begin_inset CommandInset ref
19284 reference "subsec:Paragraph-Styles"
19291 \begin_layout Description
19292 \begin_inset Flex Code
19295 \begin_layout Plain Layout
19302 \begin_inset Flex Code
19305 \begin_layout Plain Layout
19311 ] The prefix to use when creating labels referring to insets of this type.
19312 This allows the use of formatted references.
19315 \begin_layout Description
19316 \begin_inset Flex Code
19319 \begin_layout Plain Layout
19326 \begin_inset Flex Code
19329 \begin_layout Plain Layout
19335 ] As with paragraph styles, see
19336 \begin_inset CommandInset ref
19338 reference "subsec:Paragraph-Styles"
19345 \begin_layout Description
19346 \begin_inset Flex Code
19349 \begin_layout Plain Layout
19356 \begin_inset Flex Code
19359 \begin_layout Plain Layout
19368 \begin_inset space \thinspace{}
19372 \begin_inset Flex Code
19375 \begin_layout Plain Layout
19381 ] Resets the \SpecialChar LaTeX
19382 arguments of this layout (as defined via the
19383 \begin_inset Flex Code
19386 \begin_layout Plain Layout
19393 This is useful if you have copied a style via
19394 \begin_inset Flex Code
19397 \begin_layout Plain Layout
19403 , but you do not want to inherit its (required and optional) arguments.
19406 \begin_layout Description
19407 \begin_inset Flex Code
19410 \begin_layout Plain Layout
19417 \begin_inset Flex Code
19420 \begin_layout Plain Layout
19427 \begin_inset space \thinspace{}
19431 \begin_inset Flex Code
19434 \begin_layout Plain Layout
19442 ] Whether this inset should use the font of its surrounding environment
19444 Default is false: use the font of the surrounding environment.
19447 \begin_layout Description
19448 \begin_inset Flex Code
19451 \begin_layout Plain Layout
19458 \begin_inset Flex Code
19461 \begin_layout Plain Layout
19467 ] A string that is put at the end of the layout content.
19468 A line break in the output can be indicated by
19469 \begin_inset Flex Code
19472 \begin_layout Plain Layout
19481 \begin_layout Description
19482 \begin_inset Flex Code
19485 \begin_layout Plain Layout
19492 \begin_inset Flex Code
19495 \begin_layout Plain Layout
19502 \begin_inset space \thinspace{}
19506 \begin_inset Flex Code
19509 \begin_layout Plain Layout
19517 ] Allow spell-checking the contents of this inset.
19521 \begin_layout Subsection
19523 \begin_inset CommandInset label
19525 name "subsec:Counters"
19532 \begin_layout Standard
19533 It is necessary to define the counters (
19534 \begin_inset Flex MenuItem
19537 \begin_layout Plain Layout
19544 \begin_inset Flex MenuItem
19547 \begin_layout Plain Layout
19553 , \SpecialChar ldots
19554 ) in the text class itself.
19555 The standard counters are defined in the file
19556 \begin_inset Flex Code
19559 \begin_layout Plain Layout
19565 , so you may have to do no more than add
19568 \begin_layout LyX-Code
19569 Input stdcounters.inc
19572 \begin_layout Standard
19573 to your layout file to get them to work.
19574 But if you want to define custom counters, then you can do so.
19575 The counter declaration must begin with:
19578 \begin_layout LyX-Code
19579 Counter CounterName
19582 \begin_layout Standard
19584 \begin_inset Flex Code
19587 \begin_layout Plain Layout
19593 ' is replaced by the name of the counter.
19594 And it must end with
19595 \begin_inset Quotes eld
19599 \begin_inset Flex Code
19602 \begin_layout Plain Layout
19609 \begin_inset Quotes erd
19613 The following parameters can also be used:
19616 \begin_layout Description
19617 \begin_inset Flex Code
19620 \begin_layout Plain Layout
19627 \begin_inset Flex Code
19630 \begin_layout Plain Layout
19636 ] Sets the initial value for the counter, to which it will be reset whenever
19638 Normally, one will want the default, 1.
19641 \begin_layout Description
19642 \begin_inset Flex Code
19645 \begin_layout Plain Layout
19652 \begin_inset Flex Code
19655 \begin_layout Plain Layout
19662 \begin_inset Quotes erd
19666 \begin_inset Quotes erd
19669 ] When defined, this string defines how the counter is displayed.
19670 Setting this value sets
19671 \begin_inset Flex Code
19674 \begin_layout Plain Layout
19675 LabelStringAppendix
19681 The following special constructs can be used in the string:
19682 \begin_inset Separator parbreak
19689 \begin_layout Itemize
19690 \begin_inset Flex Code
19693 \begin_layout Plain Layout
19701 will be replaced by the expansion of the
19702 \begin_inset Flex Code
19705 \begin_layout Plain Layout
19712 \begin_inset Flex Code
19715 \begin_layout Plain Layout
19716 LabelStringAppendix
19722 \begin_inset Flex Code
19725 \begin_layout Plain Layout
19735 \begin_layout Itemize
19736 counter values can be expressed using \SpecialChar LaTeX
19738 \begin_inset Newline newline
19742 \begin_inset Flex Code
19745 \begin_layout Plain Layout
19762 \begin_inset Flex Code
19765 \begin_layout Plain Layout
19777 \begin_layout Plain Layout
19787 Actually, the situation is a bit more complicated: any
19806 other than those described below will produce arabic numerals.
19807 It would not be surprising to see this change in the future.
19813 \begin_inset Flex Code
19816 \begin_layout Plain Layout
19822 : 1, 2, 3,\SpecialChar ldots
19824 \begin_inset Flex Code
19827 \begin_layout Plain Layout
19833 for lower-case letters: a, b, c, \SpecialChar ldots
19835 \begin_inset Flex Code
19838 \begin_layout Plain Layout
19844 for upper-case letters: A, B, C, \SpecialChar ldots
19846 \begin_inset Flex Code
19849 \begin_layout Plain Layout
19855 for lower-case roman numerals: i, ii, iii, \SpecialChar ldots
19857 \begin_inset Flex Code
19860 \begin_layout Plain Layout
19866 for upper-case roman numerals: I, II, III\SpecialChar ldots
19868 \begin_inset Flex Code
19871 \begin_layout Plain Layout
19877 for hebrew numerals.
19881 \begin_layout Standard
19882 If LabelString is not defined, a default value is constructed as follows:
19883 if the counter has a master counter
19884 \begin_inset Flex Code
19887 \begin_layout Plain Layout
19894 \begin_inset Flex Code
19897 \begin_layout Plain Layout
19904 \begin_inset Newline newline
19908 \begin_inset Flex Code
19911 \begin_layout Plain Layout
19921 is used; otherwise the string
19922 \begin_inset Flex Code
19925 \begin_layout Plain Layout
19936 \begin_layout Description
19937 \begin_inset Flex Code
19940 \begin_layout Plain Layout
19941 LabelStringAppendix
19947 \begin_inset Flex Code
19950 \begin_layout Plain Layout
19957 \begin_inset Quotes erd
19961 \begin_inset Quotes erd
19965 \begin_inset Flex Code
19968 \begin_layout Plain Layout
19974 , but for use in the Appendix.
19977 \begin_layout Description
19978 \begin_inset Flex Code
19981 \begin_layout Plain Layout
19988 \begin_inset Flex Code
19991 \begin_layout Plain Layout
19998 \begin_inset Quotes erd
20002 \begin_inset Quotes erd
20005 ] A format for use with formatted references to this counter.
20006 For example, one might want to have references to section numbers appear
20008 \begin_inset Quotes eld
20012 \begin_inset Quotes erd
20016 The string should contain
20017 \begin_inset Quotes eld
20021 \begin_inset Quotes erd
20025 This will be replaced by the counter number itself.
20026 So, for sections, it would be: Section ##.
20029 \begin_layout Description
20030 \begin_inset Flex Code
20033 \begin_layout Plain Layout
20040 \begin_inset Flex Code
20043 \begin_layout Plain Layout
20050 \begin_inset Quotes erd
20054 \begin_inset Quotes erd
20057 ] If this is set to the name of another counter, the present counter will
20058 be reset every time the other one is increased.
20060 \begin_inset Flex Code
20063 \begin_layout Plain Layout
20070 \begin_inset Flex Code
20073 \begin_layout Plain Layout
20082 \begin_layout Subsection
20084 \begin_inset CommandInset label
20086 name "subsec:Font-description"
20093 \begin_layout Standard
20094 A font description looks like this:
20097 \begin_layout LyX-Code
20111 \begin_layout LyX-Code
20115 \begin_layout LyX-Code
20119 \begin_layout Standard
20120 The following commands are available:
20123 \begin_layout Description
20124 \begin_inset Flex Code
20127 \begin_layout Plain Layout
20134 \begin_inset Flex Code
20137 \begin_layout Plain Layout
20146 \begin_inset Flex Code
20149 \begin_layout Plain Layout
20156 \begin_inset Flex Code
20159 \begin_layout Plain Layout
20166 \begin_inset Flex Code
20169 \begin_layout Plain Layout
20176 \begin_inset Flex Code
20179 \begin_layout Plain Layout
20186 \begin_inset Flex Code
20189 \begin_layout Plain Layout
20196 \begin_inset Flex Code
20199 \begin_layout Plain Layout
20206 \begin_inset Flex Code
20209 \begin_layout Plain Layout
20216 \begin_inset Flex Code
20219 \begin_layout Plain Layout
20228 \begin_layout Description
20229 \begin_inset Flex Code
20232 \begin_layout Plain Layout
20239 \begin_inset Flex Code
20242 \begin_layout Plain Layout
20251 \begin_inset Flex Code
20254 \begin_layout Plain Layout
20261 \begin_inset Flex Code
20264 \begin_layout Plain Layout
20273 \begin_layout Description
20274 \begin_inset Flex Code
20277 \begin_layout Plain Layout
20284 \begin_inset Flex Code
20287 \begin_layout Plain Layout
20293 ] Valid arguments are:
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 \begin_inset Flex Code
20357 \begin_layout Plain Layout
20364 \begin_inset Flex Code
20367 \begin_layout Plain Layout
20374 \begin_inset Flex Code
20377 \begin_layout Plain Layout
20384 \begin_inset Flex Code
20387 \begin_layout Plain Layout
20394 \begin_inset Flex Code
20397 \begin_layout Plain Layout
20404 \begin_inset Flex Code
20407 \begin_layout Plain Layout
20414 Each of these turns on or off the corresponding attribute.
20416 \begin_inset Flex Code
20419 \begin_layout Plain Layout
20425 turns on emphasis, and
20426 \begin_inset Flex Code
20429 \begin_layout Plain Layout
20437 \begin_inset Newline newline
20440 If the latter seems puzzling, remember that the font settings for the present
20441 context are generally inherited from the surrounding context.
20443 \begin_inset Flex Code
20446 \begin_layout Plain Layout
20452 would turn off the emphasis that was anyway in effect, say, in a theorem
20456 \begin_layout Description
20457 \begin_inset Flex Code
20460 \begin_layout Plain Layout
20467 \begin_inset Flex Code
20470 \begin_layout Plain Layout
20479 \begin_inset Flex Code
20482 \begin_layout Plain Layout
20491 \begin_layout Description
20492 \begin_inset Flex Code
20495 \begin_layout Plain Layout
20502 \begin_inset Flex Code
20505 \begin_layout Plain Layout
20514 \begin_inset Flex Code
20517 \begin_layout Plain Layout
20524 \begin_inset Flex Code
20527 \begin_layout Plain Layout
20534 \begin_inset Flex Code
20537 \begin_layout Plain Layout
20546 \begin_layout Description
20547 \begin_inset Flex Code
20550 \begin_layout Plain Layout
20557 \begin_inset Flex Code
20560 \begin_layout Plain Layout
20567 \begin_inset Flex Code
20570 \begin_layout Plain Layout
20577 \begin_inset Flex Code
20580 \begin_layout Plain Layout
20589 \begin_inset Flex Code
20592 \begin_layout Plain Layout
20599 \begin_inset Flex Code
20602 \begin_layout Plain Layout
20609 \begin_inset Flex Code
20612 \begin_layout Plain Layout
20619 \begin_inset Flex Code
20622 \begin_layout Plain Layout
20629 \begin_inset Flex Code
20632 \begin_layout Plain Layout
20641 \begin_layout Subsection
20642 \begin_inset CommandInset label
20644 name "subsec:Citation-format-description"
20648 Citation format description
20651 \begin_layout Standard
20653 \begin_inset Flex Code
20656 \begin_layout Plain Layout
20662 blocks are used to describe how bibliographic information should be displayed,
20663 both within \SpecialChar LyX
20664 itself (in the citation dialog and in tooltips, for example)
20665 and in XHTML output.
20666 Such a block might look like this:
20669 \begin_layout LyX-Code
20673 \begin_layout LyX-Code
20677 \begin_layout LyX-Code
20681 \begin_layout LyX-Code
20685 \begin_layout Standard
20686 The individual lines define how the bibliographic information associated
20687 with an article or book, respectively, is to be displayed, and such a definitio
20688 n can be given for any `entry type' that might be present in a Bib\SpecialChar TeX
20691 defines a default format in the source code that will be used if no specific
20692 definition has been given.
20694 predefines several formats in the file
20695 \begin_inset Flex Code
20698 \begin_layout Plain Layout
20704 , which is included in most of \SpecialChar LyX
20705 's document classes.
20708 \begin_layout Standard
20709 The definitions use a simple language that allows Bib\SpecialChar TeX
20710 keys to be replaced
20712 Keys should be enclosed in
20713 \begin_inset Flex Code
20716 \begin_layout Plain Layout
20723 \begin_inset Flex Code
20726 \begin_layout Plain Layout
20733 So a simple definition might look like this:
20736 \begin_layout LyX-Code
20738 \begin_inset Quotes eld
20742 \begin_inset Quotes erd
20748 \begin_layout Standard
20749 This would print the author, followed by a comma, followed by the title,
20750 in quotes, followed by a period.
20753 \begin_layout Standard
20754 Of course, sometimes you may want to print a key only if it exists.
20755 This can be done by using a conditional construction, such as:
20756 \begin_inset Flex Code
20759 \begin_layout Plain Layout
20761 \begin_inset space ~
20771 \begin_inset Flex Code
20774 \begin_layout Plain Layout
20780 key exists, then print
20781 \begin_inset Quotes eld
20785 \begin_inset space ~
20789 \begin_inset Quotes erd
20792 followed by the volume key.
20793 It is also possible to have an else clause in the conditional, such as:
20794 \begin_inset Newline newline
20798 \begin_inset Flex Code
20801 \begin_layout Plain Layout
20802 {%author%[[%author%]][[%editor%, ed.]]}
20808 \begin_inset Newline newline
20812 \begin_inset Flex Code
20815 \begin_layout Plain Layout
20821 key is printed if it exists; otherwise, the editor key is printed, followed
20823 \begin_inset Quotes eld
20827 \begin_inset space ~
20831 \begin_inset Quotes erd
20834 Note that the key is again enclosed in
20835 \begin_inset Flex Code
20838 \begin_layout Plain Layout
20844 signs; the entire conditional is enclosed in braces; and the if and else
20845 clauses are enclosed in double brackets,
20846 \begin_inset Quotes eld
20850 \begin_inset Flex Code
20853 \begin_layout Plain Layout
20860 \begin_inset Quotes eld
20864 \begin_inset Quotes eld
20868 \begin_inset Flex Code
20871 \begin_layout Plain Layout
20878 \begin_inset Quotes erd
20882 There must be no space between any of these.
20885 \begin_layout Standard
20886 There is one other piece of syntax available in definitions, which looks
20888 \begin_inset Flex Code
20891 \begin_layout Plain Layout
20898 This defines a piece of formatting information that is to be used when
20900 \begin_inset Quotes eld
20904 \begin_inset Quotes erd
20908 Obviously, we do not want to output HTML tags when writing plain text,
20909 so they should be wrapped in
20910 \begin_inset Quotes eld
20914 \begin_inset Quotes erd
20918 \begin_inset Quotes eld
20922 \begin_inset Quotes erd
20928 \begin_layout Standard
20929 Two special sorts of definitions are also possible in a
20930 \begin_inset Flex Code
20933 \begin_layout Plain Layout
20940 An example of the first would be:
20943 \begin_layout LyX-Code
20945 \begin_inset Quotes eld
20949 \begin_inset Quotes erd
20955 \begin_layout Standard
20956 This is an abbreviation, or macro, and it can be used by treating it as
20958 \begin_inset Flex Code
20961 \begin_layout Plain Layout
20970 \begin_inset Flex Code
20973 \begin_layout Plain Layout
20979 exactly as it would treat its definition.
20980 So, let us issue the obvious
20988 \begin_layout LyX-Code
20992 \begin_layout Standard
20993 or anything like it.
20995 shouldn't go into an infinite loop, but it may go into a long one before
20999 \begin_layout Standard
21000 The second sort of special definition might look like this:
21003 \begin_layout LyX-Code
21007 \begin_layout Standard
21008 This defines a translatable piece of text, which allows relevant parts of
21009 the bibliography to be translated.
21010 It can be included in a definition by treating it as a key:
21011 \begin_inset Flex Code
21014 \begin_layout Plain Layout
21021 Several of these are predefined in
21022 \begin_inset Flex Code
21025 \begin_layout Plain Layout
21032 Note that these are not macros, in the sense just defined.
21033 They will not be expanded.
21036 \begin_layout Standard
21037 So here then is an example that use all these features:
21038 \begin_inset VSpace defskip
21044 \begin_layout Standard
21048 !authoredit {%author%[[%author%, ]][[{%editor%[[%editor%, %_edtext%, ]]}]]}
21051 \begin_layout Standard
21052 \begin_inset VSpace defskip
21055 This defines a macro that prints the author, followed by a comma, if the
21057 \begin_inset Flex Code
21060 \begin_layout Plain Layout
21066 key is defined, or else prints the name of the editor, followed by the
21068 \begin_inset Flex Code
21071 \begin_layout Plain Layout
21077 or its translation (it is by default
21078 \begin_inset Quotes eld
21082 \begin_inset Quotes erd
21086 \begin_inset Flex Code
21089 \begin_layout Plain Layout
21096 Note that this is in fact defined in
21097 \begin_inset Flex Code
21100 \begin_layout Plain Layout
21106 , so you can use it in your own definitions, or re-definitions, if you load
21110 \begin_layout Section
21111 \begin_inset CommandInset label
21113 name "sec:Tags-for-XHTML"
21117 Tags for XHTML output
21120 \begin_layout Standard
21121 As with \SpecialChar LaTeX
21122 or DocBook, the format of \SpecialChar LyX
21123 's XHTML output is also controlled by
21124 layout information.
21125 In general, \SpecialChar LyX
21126 provides sensible defaults and, as mentioned earlier, it will
21127 even construct default CSS style rules from the other layout tags.
21128 For example, \SpecialChar LyX
21129 will attempt to use the information provided in the
21130 \begin_inset Flex Code
21133 \begin_layout Plain Layout
21139 declaration for the Chapter style to write CSS that will appropriately
21140 format chapter headings.
21143 \begin_layout Standard
21144 In many cases, then, you may not have to do anything at all to get acceptable
21145 XHTML output for your own environments, custom insets, and so forth.
21146 But in some cases you will, and so \SpecialChar LyX
21147 provides a number of layout tags that
21148 can be used to customize the XHTML and CSS that are generated.
21151 \begin_layout Standard
21152 Note that there are two tags,
21153 \begin_inset Flex Code
21156 \begin_layout Plain Layout
21163 \begin_inset Flex Code
21166 \begin_layout Plain Layout
21172 that may appear outside style and inset declarations.
21174 \begin_inset CommandInset ref
21176 reference "subsec:General-text-class"
21180 for details on these.
21183 \begin_layout Subsection
21184 \begin_inset CommandInset label
21186 name "subsec:Paragraph-Style-XHTML"
21193 \begin_layout Standard
21194 The sort of XHTML \SpecialChar LyX
21195 outputs for a paragraph depends upon whether we are dealing
21196 with a normal paragraph, a command, or an environment, where this is itself
21197 determined by the contents of the corresponding
21198 \begin_inset Flex Code
21201 \begin_layout Plain Layout
21212 \begin_layout Standard
21213 For a command or normal paragraph, the output XHTML has the following form:
21216 \begin_layout LyX-Code
21218 \begin_inset Quotes erd
21222 \begin_inset Quotes erd
21228 \begin_layout LyX-Code
21230 \begin_inset Quotes erd
21234 \begin_inset Quotes erd
21240 \begin_layout LyX-Code
21241 Contents of the paragraph.
21244 \begin_layout LyX-Code
21248 \begin_layout Standard
21249 The label tags are of course omitted if the paragraph does not have a label.
21252 \begin_layout Standard
21253 For an environment that is not some sort of list, the XHTML takes this form:
21256 \begin_layout LyX-Code
21258 \begin_inset Quotes erd
21262 \begin_inset Quotes erd
21268 \begin_layout LyX-Code
21270 \begin_inset Quotes erd
21274 \begin_inset Quotes erd
21278 \begin_inset Quotes erd
21282 \begin_inset Quotes erd
21285 >Environment Label</labeltag>First paragraph.</itemtag>
21288 \begin_layout LyX-Code
21289 <itemtag>Second paragraph.</itemtag>
21292 \begin_layout LyX-Code
21296 \begin_layout Standard
21297 Note that the label is output only for the first paragraph, as it should
21298 be for a theorem, for example.
21302 \begin_layout Standard
21303 For a list, we have one of these forms:
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
21328 \begin_inset Quotes erd
21332 \begin_inset Quotes erd
21335 >List Label</labeltag>First item.</itemtag>
21338 \begin_layout LyX-Code
21340 \begin_inset Quotes erd
21344 \begin_inset Quotes erd
21348 \begin_inset Quotes erd
21352 \begin_inset Quotes erd
21355 >List Label</labeltag>Second item.</itemtag>
21358 \begin_layout LyX-Code
21362 \begin_layout LyX-Code
21366 \begin_layout LyX-Code
21368 \begin_inset Quotes erd
21372 \begin_inset Quotes erd
21378 \begin_layout LyX-Code
21380 \begin_inset Quotes erd
21384 \begin_inset Quotes erd
21387 >List Label</labeltag><itemtag attr=
21388 \begin_inset Quotes erd
21392 \begin_inset Quotes erd
21395 >First item.</itemtag>
21398 \begin_layout LyX-Code
21400 \begin_inset Quotes erd
21404 \begin_inset Quotes erd
21407 >List Label</labeltag><itemtag attr=
21408 \begin_inset Quotes erd
21412 \begin_inset Quotes erd
21415 >Second item.</itemtag>
21418 \begin_layout LyX-Code
21422 \begin_layout Standard
21423 Note the different orders of
21424 \begin_inset Flex Code
21427 \begin_layout Plain Layout
21434 \begin_inset Flex Code
21437 \begin_layout Plain Layout
21444 Which order we get depends upon the setting of
21445 \begin_inset Flex Code
21448 \begin_layout Plain Layout
21455 \begin_inset Flex Code
21458 \begin_layout Plain Layout
21464 is false (the default), you get the first of these, with the label within
21465 the item; if true, you get the second, with the label outside the item.
21468 \begin_layout Standard
21469 The specific tags and attributes output for each paragraph type can be controlle
21470 d by means of the layout tags we are about to describe.
21471 As mentioned earlier, however, \SpecialChar LyX
21472 uses sensible defaults for many of these,
21473 so you often may not need to do very much to get good XHTML output.
21474 Think of the available tags as there so you can tweak things to your liking.
21477 \begin_layout Description
21478 \begin_inset Flex Code
21481 \begin_layout Plain Layout
21488 \begin_inset Flex Code
21491 \begin_layout Plain Layout
21497 ] Specifies attribute information to be output with the main tag.
21499 \begin_inset Quotes eld
21503 \begin_inset Flex Code
21506 \begin_layout Plain Layout
21513 \begin_inset Quotes erd
21517 By default, \SpecialChar LyX
21519 \begin_inset Quotes eld
21523 \begin_inset Flex Code
21526 \begin_layout Plain Layout
21533 \begin_inset Quotes erd
21537 \begin_inset Flex Code
21540 \begin_layout Plain Layout
21546 is the \SpecialChar LyX
21547 name of the layout, made lowercase, for example: chapter.
21552 contain any style information.
21554 \begin_inset Flex Code
21557 \begin_layout Plain Layout
21566 \begin_layout Description
21567 \begin_inset Flex Code
21570 \begin_layout Plain Layout
21577 \begin_inset Flex Code
21580 \begin_layout Plain Layout
21590 ] Whether to output the default CSS information \SpecialChar LyX
21591 generates for this layout,
21592 even if additional information is explicitly provided via
21593 \begin_inset Flex Code
21596 \begin_layout Plain Layout
21604 \begin_inset Flex Code
21607 \begin_layout Plain Layout
21613 allows you to alter or augment the generated CSS, rather than to override
21616 \begin_inset Flex Code
21619 \begin_layout Plain Layout
21628 \begin_layout Description
21629 \begin_inset Flex Code
21632 \begin_layout Plain Layout
21639 \begin_inset Flex Code
21642 \begin_layout Plain Layout
21648 ] The tag to be used for individual paragraphs of environments, replacing
21650 \begin_inset Flex Code
21653 \begin_layout Plain Layout
21659 in the examples above.
21661 \begin_inset Flex Code
21664 \begin_layout Plain Layout
21673 \begin_layout Description
21674 \begin_inset Flex Code
21677 \begin_layout Plain Layout
21684 \begin_inset Flex Code
21687 \begin_layout Plain Layout
21693 ] Attributes for the item tag.
21695 \begin_inset Quotes eld
21699 \begin_inset Flex Code
21702 \begin_layout Plain Layout
21703 class=`layoutname_item'
21709 \begin_inset Quotes erd
21717 contain any style information.
21719 \begin_inset Flex Code
21722 \begin_layout Plain Layout
21731 \begin_layout Description
21732 \begin_inset Flex Code
21735 \begin_layout Plain Layout
21742 \begin_inset Flex Code
21745 \begin_layout Plain Layout
21751 ] The tag to be used for paragraph and item labels, replacing
21752 \begin_inset Flex Code
21755 \begin_layout Plain Layout
21761 in the examples above.
21763 \begin_inset Flex Code
21766 \begin_layout Plain Layout
21773 \begin_inset Flex Code
21776 \begin_layout Plain Layout
21783 \begin_inset Flex Code
21786 \begin_layout Plain Layout
21793 \begin_inset Flex Code
21796 \begin_layout Plain Layout
21797 Centered_Top_Environment
21802 , in which case it defaults to
21803 \begin_inset Flex Code
21806 \begin_layout Plain Layout
21815 \begin_layout Description
21816 \begin_inset Flex Code
21819 \begin_layout Plain Layout
21826 \begin_inset Flex Code
21829 \begin_layout Plain Layout
21835 ] Attributes for the label tag.
21837 \begin_inset Quotes eld
21841 \begin_inset Flex Code
21844 \begin_layout Plain Layout
21845 class=`layoutname_label'
21851 \begin_inset Quotes erd
21859 contain any style information.
21861 \begin_inset Flex Code
21864 \begin_layout Plain Layout
21873 \begin_layout Description
21874 \begin_inset Flex Code
21877 \begin_layout Plain Layout
21884 \begin_inset Flex Code
21887 \begin_layout Plain Layout
21897 ] Meaningful only for list-like environments, this tag controls whether
21898 the label tag is output before or inside the item tag.
21899 This is used, for example, in the description environment, where we want
21901 \begin_inset Flex Code
21904 \begin_layout Plain Layout
21905 <dt>\SpecialChar ldots
21906 </dt><dd>\SpecialChar ldots
21914 \begin_inset Flex Code
21917 \begin_layout Plain Layout
21923 : The label tag is output inside the item tag.
21926 \begin_layout Description
21927 \begin_inset Flex Code
21930 \begin_layout Plain Layout
21936 Information to be output in the
21937 \begin_inset Flex Code
21940 \begin_layout Plain Layout
21946 section when this style is used.
21947 This might, for example, be used to include a
21948 \begin_inset Flex Code
21951 \begin_layout Plain Layout
21958 \begin_inset Flex Code
21961 \begin_layout Plain Layout
21970 \begin_layout Description
21971 \begin_inset Flex Code
21974 \begin_layout Plain Layout
21980 CSS style information to be included when this style is used.
21981 Note that this will automatically be wrapped in a layout-generated
21982 \begin_inset Flex Code
21985 \begin_layout Plain Layout
21991 block, so only the CSS itself need be included.
21993 \begin_inset Flex Code
21996 \begin_layout Plain Layout
22005 \begin_layout Description
22006 \begin_inset Flex Code
22009 \begin_layout Plain Layout
22016 \begin_inset Flex Code
22019 \begin_layout Plain Layout
22025 ] The tag to be used for the main label, replacing
22026 \begin_inset Flex Code
22029 \begin_layout Plain Layout
22035 in the examples above.
22037 \begin_inset Flex Code
22040 \begin_layout Plain Layout
22049 \begin_layout Description
22050 \begin_inset Flex Code
22053 \begin_layout Plain Layout
22060 \begin_inset Flex Code
22063 \begin_layout Plain Layout
22073 ] Marks this style as the one to be used to generate the
22074 \begin_inset Flex Code
22077 \begin_layout Plain Layout
22083 tag for the XHTML file.
22084 By default, it is false.
22086 \begin_inset Flex Code
22089 \begin_layout Plain Layout
22095 file sets it to true for the
22096 \begin_inset Flex Code
22099 \begin_layout Plain Layout
22109 \begin_layout Subsection
22113 \begin_layout Standard
22114 The XHTML output of insets can also be controlled by information in layout
22119 \begin_layout Plain Layout
22120 At present, this is true only for
22121 \begin_inset Quotes eld
22125 \begin_inset Quotes erd
22128 insets (insets you can type into) and is not true for
22129 \begin_inset Quotes eld
22133 \begin_inset Quotes erd
22136 insets (insets that are associated with dialog boxes).
22141 Here, too, \SpecialChar LyX
22142 tries to provide sensible defaults, and it constructs default
22144 But everything can be customized.
22147 \begin_layout Standard
22148 The XHTML \SpecialChar LyX
22149 outputs for an inset has the following form:
22152 \begin_layout LyX-Code
22154 \begin_inset Quotes erd
22158 \begin_inset Quotes erd
22164 \begin_layout LyX-Code
22165 <labeltag>Label</labeltag>
22168 \begin_layout LyX-Code
22170 \begin_inset Quotes erd
22174 \begin_inset Quotes erd
22177 >Contents of the inset.</innertag>
22180 \begin_layout LyX-Code
22184 \begin_layout Standard
22185 If the inset permits multiple paragraphs—that is, if
22186 \begin_inset Flex Code
22189 \begin_layout Plain Layout
22195 is true—then the contents of the inset will itself be output as paragraphs
22196 formatted according to the styles used for those paragraphs (standard,
22197 quote, and the like).
22198 The label tag is of course omitted if the paragraph does not have a label
22199 and, at present, is always
22200 \begin_inset Flex Code
22203 \begin_layout Plain Layout
22210 The inner tag is optional and, by default, does not appear.
22213 \begin_layout Standard
22214 The specific tags and attributes output for each inset can be controlled
22215 by means of the following layout tags.
22218 \begin_layout Description
22219 \begin_inset Flex Code
22222 \begin_layout Plain Layout
22229 \begin_inset Flex Code
22232 \begin_layout Plain Layout
22238 ] Specifies attribute information to be output with the main tag.
22240 \begin_inset Quotes eld
22244 \begin_inset Flex Code
22247 \begin_layout Plain Layout
22248 class=`myinset' onclick=`\SpecialChar ldots
22255 \begin_inset Quotes erd
22259 By default, \SpecialChar LyX
22261 \begin_inset Quotes eld
22265 \begin_inset Flex Code
22268 \begin_layout Plain Layout
22275 \begin_inset Quotes erd
22279 \begin_inset Flex Code
22282 \begin_layout Plain Layout
22288 is the \SpecialChar LyX
22289 name of the inset, made lowercase and with non-alphanumeric characters
22290 converted to underscores, for example: footnote.
22293 \begin_layout Description
22294 \begin_inset Flex Code
22297 \begin_layout Plain Layout
22304 \begin_inset Flex Code
22307 \begin_layout Plain Layout
22317 ] Whether to output the default CSS information \SpecialChar LyX
22318 generates for this layout,
22319 even if additional information is explicitly provided via
22320 \begin_inset Flex Code
22323 \begin_layout Plain Layout
22331 \begin_inset Flex Code
22334 \begin_layout Plain Layout
22340 allows you to alter or augment the generated CSS, rather than to override
22345 \begin_layout Description
22346 \begin_inset Flex Code
22349 \begin_layout Plain Layout
22356 \begin_inset Flex Code
22359 \begin_layout Plain Layout
22365 ] Attributes for the inner tag.
22367 \begin_inset Quotes eld
22371 \begin_inset Flex Code
22374 \begin_layout Plain Layout
22375 class=`insetname_inner'
22381 \begin_inset Quotes erd
22387 \begin_layout Description
22388 \begin_inset Flex Code
22391 \begin_layout Plain Layout
22398 \begin_inset Flex Code
22401 \begin_layout Plain Layout
22407 ] The inner tag, replacing
22408 \begin_inset Flex Code
22411 \begin_layout Plain Layout
22417 in the examples above.
22418 By default, there is none.
22421 \begin_layout Description
22422 \begin_inset Flex Code
22425 \begin_layout Plain Layout
22432 \begin_inset Flex Code
22435 \begin_layout Plain Layout
22443 ] Whether this inset represents a standalone block of text (such as a footnote)
22444 or instead represents material that is included in the surrounding text
22445 (such as a branch).
22449 \begin_layout Description
22450 \begin_inset Flex Code
22453 \begin_layout Plain Layout
22460 \begin_inset Flex Code
22463 \begin_layout Plain Layout
22469 ] A label for this inset, possibly including a reference to a counter.
22470 For example, for footnote, it might be:
22471 \begin_inset Flex Code
22474 \begin_layout Plain Layout
22483 This is optional, and there is no default.
22486 \begin_layout Description
22487 \begin_inset Flex Code
22490 \begin_layout Plain Layout
22496 Information to be output in the
22497 \begin_inset Flex Code
22500 \begin_layout Plain Layout
22506 section when this style is used.
22507 This might, for example, be used to include a
22508 \begin_inset Flex Code
22511 \begin_layout Plain Layout
22518 \begin_inset Flex Code
22521 \begin_layout Plain Layout
22530 \begin_layout Description
22531 \begin_inset Flex Code
22534 \begin_layout Plain Layout
22540 CSS style information to be included when this style is used.
22541 Note that this will automatically be wrapped in a layout-generated
22542 \begin_inset Flex Code
22545 \begin_layout Plain Layout
22551 block, so only the CSS itself need be included.
22554 \begin_layout Description
22555 \begin_inset Flex Code
22558 \begin_layout Plain Layout
22565 \begin_inset Flex Code
22568 \begin_layout Plain Layout
22574 ] The tag to be used for the main label, replacing
22575 \begin_inset Flex Code
22578 \begin_layout Plain Layout
22584 in the examples above.
22585 The default depends upon the setting of
22586 \begin_inset Flex Code
22589 \begin_layout Plain Layout
22596 \begin_inset Flex Code
22599 \begin_layout Plain Layout
22605 is true, the default is
22606 \begin_inset Flex Code
22609 \begin_layout Plain Layout
22615 ; if it is false, the default is
22616 \begin_inset Flex Code
22619 \begin_layout Plain Layout
22628 \begin_layout Subsection
22632 \begin_layout Standard
22633 The XHTML output for floats too can be controlled by layout information.
22634 The output has the following form:
22637 \begin_layout LyX-Code
22639 \begin_inset Quotes erd
22643 \begin_inset Quotes erd
22649 \begin_layout LyX-Code
22650 Contents of the float.
22653 \begin_layout LyX-Code
22657 \begin_layout Standard
22658 The caption, if there is one, is a separate inset and will be output as
22660 Its appearance can be controlled via the InsetLayout for caption insets.
22664 \begin_layout Description
22665 \begin_inset Flex Code
22668 \begin_layout Plain Layout
22675 \begin_inset Flex Code
22678 \begin_layout Plain Layout
22684 ] Specifies attribute information to be output with the main tag.
22686 \begin_inset Quotes eld
22690 \begin_inset Flex Code
22693 \begin_layout Plain Layout
22694 class=`myfloat' onclick=`\SpecialChar ldots
22701 \begin_inset Quotes erd
22705 By default, \SpecialChar LyX
22707 \begin_inset Quotes eld
22711 \begin_inset Flex Code
22714 \begin_layout Plain Layout
22715 class=`float float-floattype'
22721 \begin_inset Quotes erd
22725 \begin_inset Flex Code
22728 \begin_layout Plain Layout
22734 is \SpecialChar LyX
22735 's name for this type of float, as determined by the float declaration
22737 \begin_inset CommandInset ref
22739 reference "subsec:Floats"
22743 ), though made lowercase and with non-alphanumeric characters converted
22744 to underscores, for example: float-table.
22747 \begin_layout Description
22748 \begin_inset Flex Code
22751 \begin_layout Plain Layout
22757 CSS style information to be included when this float is used.
22758 Note that this will automatically be wrapped in a layout-generated
22759 \begin_inset Flex Code
22762 \begin_layout Plain Layout
22768 block, so only the CSS itself need be included.
22771 \begin_layout Description
22772 \begin_inset Flex Code
22775 \begin_layout Plain Layout
22782 \begin_inset Flex Code
22785 \begin_layout Plain Layout
22791 ] The tag to be used for this float, replacing
22792 \begin_inset Quotes eld
22796 \begin_inset Flex Code
22799 \begin_layout Plain Layout
22806 \begin_inset Quotes erd
22809 in the example above.
22811 \begin_inset Flex Code
22814 \begin_layout Plain Layout
22820 and will rarely need changing.
22823 \begin_layout Subsection
22824 Bibliography formatting
22827 \begin_layout Standard
22828 The bibliography can be formatted using
22829 \begin_inset Flex Code
22832 \begin_layout Plain Layout
22840 \begin_inset CommandInset ref
22842 reference "subsec:Citation-format-description"
22849 \begin_layout Subsection
22854 \begin_layout Standard
22855 We have several times mentioned that \SpecialChar LyX
22856 will generate default CSS style rules
22857 for both insets and paragraph styles, based upon the other layout information
22859 In this section, we shall say a word about which layout information \SpecialChar LyX
22864 \begin_layout Standard
22865 At present, \SpecialChar LyX
22866 auto-generates CSS only for font information, making use of
22868 \begin_inset Flex Code
22871 \begin_layout Plain Layout
22878 \begin_inset Flex Code
22881 \begin_layout Plain Layout
22888 \begin_inset Flex Code
22891 \begin_layout Plain Layout
22898 \begin_inset Flex Code
22901 \begin_layout Plain Layout
22908 \begin_inset Flex Code
22911 \begin_layout Plain Layout
22918 \begin_inset CommandInset ref
22920 reference "subsec:Font-description"
22925 The translation is mostly straightforward and obvious.
22927 \begin_inset Quotes eld
22931 \begin_inset Flex Code
22934 \begin_layout Plain Layout
22941 \begin_inset Quotes erd
22945 \begin_inset Quotes eld
22949 \begin_inset Flex Code
22952 \begin_layout Plain Layout
22953 font-family: sans-serif;
22959 \begin_inset Quotes erd
22963 The correspondence of \SpecialChar LyX
22964 sizes and CSS sizes is a little less obvious but
22965 nonetheless intuitive.
22967 \begin_inset Flex Code
22970 \begin_layout Plain Layout
22977 \begin_inset Flex URL
22980 \begin_layout Plain Layout
22990 \begin_layout Chapter
22991 Including External Material
22992 \begin_inset CommandInset label
22994 name "chap:Including-External-Material"
23001 \begin_layout Standard
23002 \begin_inset Box Shadowbox
23012 height_special "totalheight"
23017 backgroundcolor "none"
23020 \begin_layout Plain Layout
23021 WARNING: This portion of the documentation has not been updated for some
23023 We certainly hope that it is still accurate, but there are no guarantees.
23031 \begin_layout Standard
23032 The use of material from sources external to \SpecialChar LyX
23033 is covered in detail in the
23039 This part of the manual covers what needs to happen behind the scenes for
23040 new sorts of material to be included.
23043 \begin_layout Section
23047 \begin_layout Standard
23048 The external material feature is based on the concept of a
23053 A template is a specification of how \SpecialChar LyX
23054 should interface with a certain kind
23056 As bundled, \SpecialChar LyX
23057 comes with predefined templates for Xfig figures, various
23058 raster format images, chess diagrams, and LilyPond music notation.
23059 You can check the actual list by using the menu
23060 \begin_inset Flex MenuItem
23063 \begin_layout Plain Layout
23064 Insert\SpecialChar menuseparator
23065 File\SpecialChar menuseparator
23072 Furthermore, it is possible to roll your own template to support a specific
23074 Later we'll describe in more detail what is involved, and hopefully you
23075 will submit all the templates you create so we can include them in a later
23080 \begin_layout Standard
23081 Another basic idea of the external material feature is to distinguish between
23082 the original file that serves as a base for final material and the produced
23083 file that is included in your exported or printed document.
23084 For example, consider the case of a figure produced with
23085 \begin_inset Flex Code
23088 \begin_layout Plain Layout
23095 The Xfig application itself works on an original file with the
23096 \begin_inset Flex Code
23099 \begin_layout Plain Layout
23106 Within Xfig, you create and change your figure, and when you are done,
23108 \begin_inset Flex Code
23111 \begin_layout Plain Layout
23118 When you want to include the figure in your document, you invoke
23119 \begin_inset Flex Code
23122 \begin_layout Plain Layout
23128 in order to create a PostScript file that can readily be included in your
23132 \begin_inset Flex Code
23135 \begin_layout Plain Layout
23141 file is the original file, and the PostScript file is the produced file.
23144 \begin_layout Standard
23145 This distinction is important in order to allow updating of the material
23146 while you are in the process of writing the document.
23147 Furthermore, it provides us with the flexibility that is needed to support
23148 multiple export formats.
23149 For instance, in the case of a plain text file, it is not exactly an award-winn
23150 ing idea to include the figure as raw PostScript.
23151 Instead, you would either prefer to just include a reference to the figure
23152 or try to invoke some graphics to ASCII converter to make the final result
23153 look similar to the real graphics.
23154 The external material management allows you to do this, because it is parametri
23155 zed on the different export formats that \SpecialChar LyX
23159 \begin_layout Standard
23160 Besides supporting the production of different products according to the
23161 exported format, it supports tight integration with editing and viewing
23163 In the case of an Xfig figure, you are able to invoke Xfig on the original
23164 file with a single click from within the external material dialog in \SpecialChar LyX
23166 and also preview the produced PostScript file with Ghostview with another
23168 No more fiddling around with the command line and/or file browsers to locate
23169 and manipulate the original or produced files.
23170 In this way, you are finally able to take full advantage of the many different
23171 applications that are relevant to use when you write your documents, and
23172 ultimately be more productive.
23175 \begin_layout Section
23176 The external template configuration file
23179 \begin_layout Standard
23180 It is relatively easy to add custom external template definitions to \SpecialChar LyX
23182 However, be aware that doing this in an careless manner most probably
23186 introduce an easily exploitable security hole.
23187 So before you do this, please read the discussion about security in
23188 \begin_inset CommandInset ref
23190 reference "sec:Security-discussion"
23197 \begin_layout Standard
23198 Having said that, we encourage you to submit any interesting templates that
23203 \begin_layout Standard
23204 The external templates are defined in the
23205 \begin_inset Flex Code
23208 \begin_layout Plain Layout
23210 \change_deleted -712698321 1437634905
23213 \change_inserted -712698321 1437634906
23216 Dir/lib/external_templates
23222 You can place your own version in
23223 \begin_inset Flex Code
23226 \begin_layout Plain Layout
23227 UserDir/external_templates
23235 \begin_layout Standard
23236 A typical template looks like this:
23239 \begin_layout LyX-Code
23243 \begin_layout LyX-Code
23244 GuiName "XFig: $$AbsOrRelPathParent$$Basename"
23247 \begin_layout LyX-Code
23251 \begin_layout LyX-Code
23255 \begin_layout LyX-Code
23259 \begin_layout LyX-Code
23263 \begin_layout LyX-Code
23267 \begin_layout LyX-Code
23268 AutomaticProduction true
23271 \begin_layout LyX-Code
23275 \begin_layout LyX-Code
23279 \begin_layout LyX-Code
23280 Format \SpecialChar LaTeX
23284 \begin_layout LyX-Code
23285 TransformCommand Rotate RotationLatexCommand
23288 \begin_layout LyX-Code
23289 TransformCommand Resize ResizeLatexCommand
23292 \begin_layout LyX-Code
23293 Product "$$RotateFront$$ResizeFront
23296 \begin_layout LyX-Code
23301 input{$$AbsOrRelPathMaster$$Basename.pstex_t}
23304 \begin_layout LyX-Code
23305 $$ResizeBack$$RotateBack"
23308 \begin_layout LyX-Code
23312 \begin_layout LyX-Code
23313 UpdateResult "$$AbsPath$$Basename.pstex_t"
23316 \begin_layout LyX-Code
23317 Requirement "graphicx"
23320 \begin_layout LyX-Code
23321 ReferencedFile latex "$$AbsOrRelPathMaster$$Basename.pstex_t"
23324 \begin_layout LyX-Code
23325 ReferencedFile latex "$$AbsPath$$Basename.eps"
23328 \begin_layout LyX-Code
23329 ReferencedFile dvi "$$AbsPath$$Basename.eps"
23332 \begin_layout LyX-Code
23336 \begin_layout LyX-Code
23337 Format PDF\SpecialChar LaTeX
23341 \begin_layout LyX-Code
23342 TransformCommand Rotate RotationLatexCommand
23345 \begin_layout LyX-Code
23346 TransformCommand Resize ResizeLatexCommand
23349 \begin_layout LyX-Code
23350 Product "$$RotateFront$$ResizeFront
23353 \begin_layout LyX-Code
23358 input{$$AbsOrRelPathMaster$$Basename.pdftex_t}
23361 \begin_layout LyX-Code
23362 $$ResizeBack$$RotateBack"
23365 \begin_layout LyX-Code
23366 UpdateFormat pdftex
23369 \begin_layout LyX-Code
23370 UpdateResult "$$AbsPath$$Basename.pdftex_t"
23373 \begin_layout LyX-Code
23374 Requirement "graphicx"
23377 \begin_layout LyX-Code
23378 ReferencedFile latex "$$AbsOrRelPathMaster$$Basename.pdftex_t"
23381 \begin_layout LyX-Code
23382 ReferencedFile latex "$$AbsPath$$Basename.pdf"
23385 \begin_layout LyX-Code
23389 \begin_layout LyX-Code
23393 \begin_layout LyX-Code
23394 Product "$$Contents(
23396 "$$AbsPath$$Basename.asc
23401 \begin_layout LyX-Code
23402 UpdateFormat asciixfig
23405 \begin_layout LyX-Code
23406 UpdateResult "$$AbsPath$$Basename.asc"
23409 \begin_layout LyX-Code
23413 \begin_layout LyX-Code
23417 \begin_layout LyX-Code
23418 Product "<graphic fileref=
23420 "$$AbsOrRelPathMaster$$Basename.eps
23425 \begin_layout LyX-Code
23429 \begin_layout LyX-Code
23433 \begin_layout LyX-Code
23434 UpdateResult "$$AbsPath$$Basename.eps"
23437 \begin_layout LyX-Code
23438 ReferencedFile docbook "$$AbsPath$$Basename.eps"
23441 \begin_layout LyX-Code
23442 ReferencedFile docbook-xml "$$AbsPath$$Basename.eps"
23445 \begin_layout LyX-Code
23449 \begin_layout LyX-Code
23450 Product "[XFig: $$FName]"
23453 \begin_layout LyX-Code
23457 \begin_layout LyX-Code
23461 \begin_layout Standard
23462 As you can see, the template is enclosed in
23463 \begin_inset Flex Code
23466 \begin_layout Plain Layout
23474 \begin_inset Flex Code
23477 \begin_layout Plain Layout
23484 It contains a header specifying some general settings and, for each supported
23485 primary document file format, a section
23486 \begin_inset Flex Code
23489 \begin_layout Plain Layout
23497 \begin_inset Flex Code
23500 \begin_layout Plain Layout
23509 \begin_layout Subsection
23510 The template header
23513 \begin_layout Description
23514 \begin_inset Flex Code
23517 \begin_layout Plain Layout
23518 AutomaticProduction
23519 \begin_inset space ~
23527 Whether the file represented by the template must be generated by \SpecialChar LyX
23529 This command must occur exactly once.
23532 \begin_layout Description
23533 \begin_inset Flex Code
23536 \begin_layout Plain Layout
23538 \begin_inset space ~
23546 A glob pattern that is used in the file dialog to filter out the desired
23548 If there is more than one possible file extension (e.
23549 \begin_inset space \thinspace{}
23553 \begin_inset space \space{}
23557 \begin_inset Flex Code
23560 \begin_layout Plain Layout
23567 \begin_inset Flex Code
23570 \begin_layout Plain Layout
23576 ), use something like
23577 \begin_inset Flex Code
23580 \begin_layout Plain Layout
23587 This command must occur exactly once.
23590 \begin_layout Description
23591 \begin_inset Flex Code
23594 \begin_layout Plain Layout
23596 \begin_inset space ~
23604 The text that is displayed on the button.
23605 This command must occur exactly once.
23608 \begin_layout Description
23609 \begin_inset Flex Code
23612 \begin_layout Plain Layout
23614 \begin_inset space ~
23618 \begin_inset space ~
23626 The help text that is used in the External dialog.
23627 Provide enough information to explain to the user just what the template
23628 can provide him with.
23629 This command must occur exactly once.
23632 \begin_layout Description
23633 \begin_inset Flex Code
23636 \begin_layout Plain Layout
23638 \begin_inset space ~
23646 The file format of the original file.
23647 This must be the name of a format that is known to \SpecialChar LyX
23649 \begin_inset CommandInset ref
23651 reference "sec:Formats"
23657 \begin_inset Quotes eld
23661 \begin_inset Flex Code
23664 \begin_layout Plain Layout
23671 \begin_inset Quotes erd
23674 if the template can handle original files of more than one format.
23676 will attempt to interrogate the file itself in order to deduce its format
23678 This command must occur exactly once.
23681 \begin_layout Description
23682 \begin_inset Flex Code
23685 \begin_layout Plain Layout
23687 \begin_inset space ~
23695 A unique name for the template.
23696 It must not contain substitution macros (see below).
23699 \begin_layout Description
23700 \begin_inset Flex Code
23703 \begin_layout Plain Layout
23705 \begin_inset space ~
23708 Rotate|Resize|Clip|Extra
23713 This command specifies which transformations are supported by this template.
23714 It may occur zero or more times.
23715 This command enables the corresponding tabs in the external dialog.
23717 \begin_inset Flex Code
23720 \begin_layout Plain Layout
23726 command must have either a corresponding
23727 \begin_inset Flex Code
23730 \begin_layout Plain Layout
23737 \begin_inset Flex Code
23740 \begin_layout Plain Layout
23747 \begin_inset Flex Code
23750 \begin_layout Plain Layout
23757 Otherwise the transformation will not be supported by that format.
23760 \begin_layout Subsection
23764 \begin_layout Description
23765 \begin_inset Flex Code
23768 \begin_layout Plain Layout
23770 \begin_inset space ~
23774 \change_inserted -195340706 1437418821
23776 \change_inserted -712698321 1437634430
23778 \change_deleted -712698321 1437634429
23780 \change_inserted -195340706 1437418821
23782 \change_deleted -195340706 1437418827
23787 \change_inserted -195340706 1437418856
23789 \change_inserted -712698321 1437634432
23791 \change_deleted -712698321 1437634432
23793 \change_inserted -195340706 1437418856
23795 \change_deleted -195340706 1437418857
23804 The primary document file format that this format definition is for.
23805 Not every template has a sensible representation in all document file formats.
23806 Please define nevertheless a
23807 \begin_inset Flex Code
23810 \begin_layout Plain Layout
23816 section for all templates.
23817 Use a dummy text when no representation is available.
23818 Then you can at least see a reference to the external material in the exported
23822 \begin_layout Description
23823 \begin_inset Flex Code
23826 \begin_layout Plain Layout
23828 \begin_inset space ~
23832 \begin_inset space ~
23840 This command defines an additional macro
23841 \begin_inset Flex Code
23844 \begin_layout Plain Layout
23850 for substitution in
23851 \begin_inset Flex Code
23854 \begin_layout Plain Layout
23862 \begin_inset Flex Code
23865 \begin_layout Plain Layout
23871 itself may contain substitution macros.
23872 The advantage over using
23873 \begin_inset Flex Code
23876 \begin_layout Plain Layout
23883 \begin_inset Flex Code
23886 \begin_layout Plain Layout
23892 is that the substituted value of
23893 \begin_inset Flex Code
23896 \begin_layout Plain Layout
23902 is sanitized so that it is a valid optional argument in the document format.
23903 This command may occur zero or more times.
23906 \begin_layout Description
23907 \begin_inset Flex Code
23910 \begin_layout Plain Layout
23912 \begin_inset space ~
23920 The text that is inserted in the exported document.
23921 This is actually the most important command and can be quite complex.
23922 This command must occur exactly once.
23925 \begin_layout Description
23926 \begin_inset Flex Code
23929 \begin_layout Plain Layout
23931 \begin_inset space ~
23939 This command specifies a preamble snippet that will be included in the
23942 It has to be defined using
23943 \begin_inset Flex Code
23946 \begin_layout Plain Layout
23954 \begin_inset Flex Code
23957 \begin_layout Plain Layout
23964 This command may occur zero or more times.
23967 \begin_layout Description
23968 \begin_inset Flex Code
23971 \begin_layout Plain Layout
23973 \begin_inset space ~
23977 \begin_inset space ~
23985 This command denotes files that are created by the conversion process and
23986 are needed for a particular export format.
23987 If the filename is relative, it is interpreted relative to the master document.
23988 This command may be given zero or more times.
23991 \begin_layout Description
23992 \begin_inset Flex Code
23995 \begin_layout Plain Layout
23997 \begin_inset space ~
24005 The name of a required \SpecialChar LaTeX
24007 The package is included via
24008 \begin_inset Flex Code
24011 \begin_layout Plain Layout
24019 in the \SpecialChar LaTeX
24021 This command may occur zero or more times.
24024 \begin_layout Description
24025 \begin_inset Flex Code
24028 \begin_layout Plain Layout
24030 \begin_inset space ~
24034 \begin_inset space ~
24037 RotationLatexCommand
24042 This command specifies that the built in \SpecialChar LaTeX
24043 command should be used for rotation.
24044 This command may occur once or not at all.
24047 \begin_layout Description
24048 \begin_inset Flex Code
24051 \begin_layout Plain Layout
24053 \begin_inset space ~
24057 \begin_inset space ~
24065 This command specifies that the built in \SpecialChar LaTeX
24066 command should be used for resizing.
24067 This command may occur once or not at all.
24070 \begin_layout Description
24071 \begin_inset Flex Code
24074 \begin_layout Plain Layout
24076 \begin_inset space ~
24080 \begin_inset space ~
24083 RotationLatexOption
24088 This command specifies that rotation is done via an optional argument.
24089 This command may occur once or not at all.
24092 \begin_layout Description
24093 \begin_inset Flex Code
24096 \begin_layout Plain Layout
24098 \begin_inset space ~
24102 \begin_inset space ~
24110 This command specifies that resizing is done via an optional argument.
24111 This command may occur once or not at all.
24114 \begin_layout Description
24115 \begin_inset Flex Code
24118 \begin_layout Plain Layout
24120 \begin_inset space ~
24124 \begin_inset space ~
24132 This command specifies that clipping is done via an optional argument.
24133 This command may occur once or not at all.
24136 \begin_layout Description
24137 \begin_inset Flex Code
24140 \begin_layout Plain Layout
24142 \begin_inset space ~
24146 \begin_inset space ~
24154 This command specifies that an extra optional argument is used.
24155 This command may occur once or not at all.
24158 \begin_layout Description
24159 \begin_inset Flex Code
24162 \begin_layout Plain Layout
24164 \begin_inset space ~
24172 The file format of the converted file.
24173 This must be the name of a format that is known to \SpecialChar LyX
24175 \begin_inset Flex MenuItem
24178 \begin_layout Plain Layout
24179 Tools\SpecialChar menuseparator
24180 Preferences\SpecialChar menuseparator
24181 File Handling\SpecialChar menuseparator
24188 This command must occur exactly once.
24189 If the resulting file format is PDF, you need to specify the format
24190 \begin_inset Flex Code
24193 \begin_layout Plain Layout
24200 This is the PDF format used for including graphics.
24201 The other defined PDF formats are for document export.
24204 \begin_layout Description
24205 \begin_inset Flex Code
24208 \begin_layout Plain Layout
24210 \begin_inset space ~
24218 The file name of the converted file.
24219 The file name must be absolute.
24220 This command must occur exactly once.
24223 \begin_layout Subsection
24224 Preamble definitions
24227 \begin_layout Standard
24228 The external template configuration file may contain additional preamble
24229 definitions enclosed by
24230 \begin_inset Flex Code
24233 \begin_layout Plain Layout
24241 \begin_inset Flex Code
24244 \begin_layout Plain Layout
24251 They can be used by the templates in the
24252 \begin_inset Flex Code
24255 \begin_layout Plain Layout
24264 \begin_layout Section
24265 The substitution mechanism
24268 \begin_layout Standard
24269 When the external material facility invokes an external program, it is done
24270 on the basis of a command defined in the template configuration file.
24271 These commands can contain various macros that are expanded before execution.
24272 Execution always take place in the directory of the containing document.
24275 \begin_layout Standard
24276 Also, whenever external material is to be displayed, the name will be produced
24277 by the substitution mechanism, and most other commands in the template
24278 definition support substitution as well.
24281 \begin_layout Standard
24282 The available macros are the following:
24285 \begin_layout Description
24286 \begin_inset Flex Code
24289 \begin_layout Plain Layout
24290 $$AbsOrRelPathMaster
24295 The file path, absolute or relative to the master \SpecialChar LyX
24299 \begin_layout Description
24300 \begin_inset Flex Code
24303 \begin_layout Plain Layout
24304 $$AbsOrRelPathParent
24309 The file path, absolute or relative to the \SpecialChar LyX
24313 \begin_layout Description
24314 \begin_inset Flex Code
24317 \begin_layout Plain Layout
24323 The absolute file path.
24326 \begin_layout Description
24327 \begin_inset Flex Code
24330 \begin_layout Plain Layout
24336 The filename without path and without the extension.
24339 \begin_layout Description
24340 \begin_inset Flex Code
24343 \begin_layout Plain Layout
24345 \begin_inset Quotes eld
24349 \begin_inset Quotes erd
24357 This macro will expand to the contents of the file with the name
24358 \begin_inset Flex Code
24361 \begin_layout Plain Layout
24370 \begin_layout Description
24371 \begin_inset Flex Code
24374 \begin_layout Plain Layout
24380 The file extension (including the dot).
24381 \change_inserted -195340706 1437418878
24385 \begin_layout Description
24387 \change_inserted -195340706 1437418878
24388 \begin_inset Flex Code
24391 \begin_layout Plain Layout
24393 \change_inserted -195340706 1437418878
24399 This will be the string
24400 \begin_inset Quotes eld
24404 \begin_inset Quotes erd
24407 if the file is in JPEG format, otherwise it will be the string
24408 \begin_inset Quotes eld
24412 \begin_inset Quotes erd
24416 This is useful to avoid uneeded conversions for output formats that support
24417 both PNG and JPEG fomats.
24418 The predefined RasterImage template uses this macro for the PDFL
24419 \change_deleted -712698321 1437634446
24421 \change_inserted -712698321 1437634446
24423 \change_inserted -195340706 1437418878
24429 \begin_layout Description
24430 \begin_inset Flex Code
24433 \begin_layout Plain Layout
24439 The filename of the file specified in the external material dialog.
24440 This is either an absolute name, or it is relative to the \SpecialChar LyX
24444 \begin_layout Description
24445 \begin_inset Flex Code
24448 \begin_layout Plain Layout
24455 \begin_inset Flex Code
24458 \begin_layout Plain Layout
24464 (absolute name or relative to the \SpecialChar LyX
24468 \begin_layout Description
24469 \begin_inset Flex Code
24472 \begin_layout Plain Layout
24478 The file path, relative to the master \SpecialChar LyX
24482 \begin_layout Description
24483 \begin_inset Flex Code
24486 \begin_layout Plain Layout
24492 The file path, relative to the \SpecialChar LyX
24496 \begin_layout Description
24497 \begin_inset Flex Code
24500 \begin_layout Plain Layout
24506 This macro will expand to the absolute path of the system directory.
24507 This is typically used to point to the various helper scripts that are
24508 bundled with \SpecialChar LyX
24512 \begin_layout Description
24513 \begin_inset Flex Code
24516 \begin_layout Plain Layout
24522 A name and full path to a temporary file which will be automatically deleted
24523 whenever the containing document is closed, or the external material insertion
24527 \begin_layout Standard
24528 All path macros contain a trailing directory separator, so you can construct
24530 \begin_inset space \thinspace{}
24534 \begin_inset space \space{}
24537 the absolute filename with
24538 \begin_inset Flex Code
24541 \begin_layout Plain Layout
24542 $$AbsPath$$Basename$$Extension
24550 \begin_layout Standard
24551 The macros above are substituted in all commands unless otherwise noted.
24553 \begin_inset Flex Code
24556 \begin_layout Plain Layout
24562 supports additionally the following substitutions if they are enabled by
24564 \begin_inset Flex Code
24567 \begin_layout Plain Layout
24574 \begin_inset Flex Code
24577 \begin_layout Plain Layout
24586 \begin_layout Description
24587 \begin_inset Flex Code
24590 \begin_layout Plain Layout
24596 The front part of the resize command.
24599 \begin_layout Description
24600 \begin_inset Flex Code
24603 \begin_layout Plain Layout
24609 The back part of the resize command.
24612 \begin_layout Description
24613 \begin_inset Flex Code
24616 \begin_layout Plain Layout
24622 The front part of the rotation command.
24625 \begin_layout Description
24626 \begin_inset Flex Code
24629 \begin_layout Plain Layout
24635 The back part of the rotation command.
24638 \begin_layout Standard
24639 The value string of the
24640 \begin_inset Flex Code
24643 \begin_layout Plain Layout
24649 command supports additionally the following substitutions if they are enabled
24651 \begin_inset Flex Code
24654 \begin_layout Plain Layout
24661 \begin_inset Flex Code
24664 \begin_layout Plain Layout
24673 \begin_layout Description
24674 \begin_inset Flex Code
24677 \begin_layout Plain Layout
24686 \begin_layout Description
24687 \begin_inset Flex Code
24690 \begin_layout Plain Layout
24699 \begin_layout Description
24700 \begin_inset Flex Code
24703 \begin_layout Plain Layout
24712 \begin_layout Description
24713 \begin_inset Flex Code
24716 \begin_layout Plain Layout
24722 The rotation option.
24725 \begin_layout Standard
24726 You may ask why there are so many path macros.
24727 There are mainly two reasons:
24730 \begin_layout Enumerate
24731 Relative and absolute file names should remain relative or absolute, respectivel
24733 Users may have reasons to prefer either form.
24734 Relative names are useful for portable documents that should work on different
24735 machines, for example.
24736 Absolute names may be required by some programs.
24739 \begin_layout Enumerate
24741 treats relative file names differently than \SpecialChar LyX
24742 and other programs in nested
24744 For \SpecialChar LyX
24745 , a relative file name is always relative to the document that contains
24747 For \SpecialChar LaTeX
24748 , it is always relative to the master document.
24749 These two definitions are identical if you have only one document, but
24750 differ if you have a master document that includes part documents.
24751 That means that relative filenames must be transformed when presented to
24754 Fortunately \SpecialChar LyX
24755 does this automatically for you if you choose the right macros.
24758 \begin_layout Standard
24759 So which path macro should be used in new template definitions? The rule
24763 \begin_layout Itemize
24765 \begin_inset Flex Code
24768 \begin_layout Plain Layout
24774 if an absolute path is required.
24777 \begin_layout Itemize
24779 \begin_inset Flex Code
24782 \begin_layout Plain Layout
24783 $$AbsOrRelPathMaster
24788 if the substituted string is some kind of \SpecialChar LaTeX
24792 \begin_layout Itemize
24794 \begin_inset Flex Code
24797 \begin_layout Plain Layout
24798 $$AbsOrRelPathParent
24803 in order to preserve the user's choice.
24806 \begin_layout Standard
24807 There are special cases where this rule does not work and e.
24808 \begin_inset space \thinspace{}
24812 \begin_inset space \space{}
24815 relative names are needed, but normally it will work just fine.
24816 One example for such a case is the command
24817 \begin_inset Flex Code
24820 \begin_layout Plain Layout
24821 ReferencedFile latex "$$AbsOrRelPathMaster$$Basename.pstex_t"
24826 in the XFig template above: We can't use the absolute name because the
24828 \begin_inset Flex Code
24831 \begin_layout Plain Layout
24837 files needs the relative name in order to rewrite the file content.
24840 \begin_layout Section
24841 Security discussion
24842 \begin_inset CommandInset label
24844 name "sec:Security-discussion"
24851 \begin_layout Standard
24852 The external material feature interfaces with a lot of external programs
24853 and does so automatically, so we have to consider the security implications
24855 In particular, since you have the option of including your own filenames
24856 and/or parameter strings and those are expanded into a command, it seems
24857 that it would be possible to create a malicious document which executes
24858 arbitrary commands when a user views or prints the document.
24859 This is something we definitely want to avoid.
24862 \begin_layout Standard
24863 However, since the external program commands are specified in the template
24864 configuration file only, there are no security issues if \SpecialChar LyX
24865 is properly configure
24866 d with safe templates only.
24867 This is so because the external programs are invoked with the
24868 \begin_inset Flex Code
24871 \begin_layout Plain Layout
24877 -system call rather than the
24878 \begin_inset Flex Code
24881 \begin_layout Plain Layout
24887 system-call, so it's not possible to execute arbitrary commands from the
24888 filename or parameter section via the shell.
24891 \begin_layout Standard
24892 This also implies that you are restricted in what command strings you can
24893 use in the external material templates.
24894 In particular, pipes and redirection are not readily available.
24895 This has to be so if \SpecialChar LyX
24896 should remain safe.
24897 If you want to use some of the shell features, you should write a safe
24898 script to do this in a controlled manner, and then invoke the script from
24899 the command string.
24903 \begin_layout Standard
24904 It is possible to design a template that interacts directly with the shell,
24905 but since this would allow a malicious user to execute arbitrary commands
24906 by writing clever filenames and/or parameters, we generally recommend that
24907 you only use safe scripts that work with the
24908 \begin_inset Flex Code
24911 \begin_layout Plain Layout
24917 system call in a controlled manner.
24918 Of course, for use in a controlled environment, it can be tempting to just
24919 fall back to use ordinary shell scripts.
24920 If you do so, be aware that you
24924 provide an easily exploitable security hole in your system.
24925 Of course it stands to reason that such unsafe templates will never be
24926 included in the standard \SpecialChar LyX
24927 distribution, although we do encourage people
24928 to submit new templates in the open source tradition.
24929 But \SpecialChar LyX
24930 as shipped from the official distribution channels will never have
24934 \begin_layout Standard
24935 Including external material provides a lot of power, and you have to be
24936 careful not to introduce security hazards with this power.
24937 A subtle error in a single line in an innocent looking script can open
24938 the door to huge security problems.
24939 So if you do not fully understand the issues, we recommend that you consult
24940 a knowledgeable security professional or the \SpecialChar LyX
24941 development team if you have
24942 any questions about whether a given template is safe or not.
24943 And do this before you use it in an uncontrolled environment.
24946 \begin_layout Chapter
24948 List of supported \SpecialChar LyX
24949 functions to be used in layouts
24950 \begin_inset CommandInset label
24952 name "chap:List-of-functions"
24959 \begin_layout Standard
24961 \begin_inset Tabular
24962 <lyxtabular version="3" rows="11" columns="8">
24963 <features tabularvalignment="middle">
24964 <column alignment="left" valignment="top">
24965 <column alignment="left" valignment="top">
24966 <column alignment="left" valignment="top">
24967 <column alignment="left" valignment="top">
24968 <column alignment="left" valignment="top">
24969 <column alignment="left" valignment="top">
24970 <column alignment="left" valignment="top">
24971 <column alignment="left" valignment="top">
24973 <cell alignment="left" valignment="top" usebox="none">
24976 \begin_layout Plain Layout
24982 <cell alignment="left" valignment="top" usebox="none">
24985 \begin_layout Plain Layout
24991 <cell alignment="left" valignment="top" usebox="none">
24994 \begin_layout Plain Layout
25000 <cell alignment="left" valignment="top" usebox="none">
25003 \begin_layout Plain Layout
25009 <cell alignment="center" valignment="top" usebox="none">
25012 \begin_layout Plain Layout
25018 <cell alignment="center" valignment="top" usebox="none">
25021 \begin_layout Plain Layout
25027 <cell alignment="center" valignment="top" usebox="none">
25030 \begin_layout Plain Layout
25036 <cell alignment="center" valignment="top" usebox="none">
25039 \begin_layout Plain Layout
25047 <cell alignment="left" valignment="top" usebox="none">
25050 \begin_layout Plain Layout
25056 <cell alignment="left" valignment="top" usebox="none">
25059 \begin_layout Plain Layout
25065 <cell alignment="left" valignment="top" usebox="none">
25068 \begin_layout Plain Layout
25074 <cell alignment="left" valignment="top" usebox="none">
25077 \begin_layout Plain Layout
25083 <cell alignment="center" valignment="top" usebox="none">
25086 \begin_layout Plain Layout
25092 <cell alignment="center" valignment="top" usebox="none">
25095 \begin_layout Plain Layout
25101 <cell alignment="center" valignment="top" usebox="none">
25104 \begin_layout Plain Layout
25110 <cell alignment="center" valignment="top" usebox="none">
25113 \begin_layout Plain Layout
25121 <cell alignment="left" valignment="top" usebox="none">
25124 \begin_layout Plain Layout
25130 <cell alignment="left" valignment="top" usebox="none">
25133 \begin_layout Plain Layout
25139 <cell alignment="left" valignment="top" usebox="none">
25142 \begin_layout Plain Layout
25148 <cell alignment="left" valignment="top" usebox="none">
25151 \begin_layout Plain Layout
25157 <cell alignment="center" valignment="top" usebox="none">
25160 \begin_layout Plain Layout
25166 <cell alignment="center" valignment="top" usebox="none">
25169 \begin_layout Plain Layout
25175 <cell alignment="center" valignment="top" usebox="none">
25178 \begin_layout Plain Layout
25184 <cell alignment="center" valignment="top" usebox="none">
25187 \begin_layout Plain Layout
25195 <cell alignment="left" valignment="top" usebox="none">
25198 \begin_layout Plain Layout
25204 <cell alignment="left" valignment="top" usebox="none">
25207 \begin_layout Plain Layout
25213 <cell alignment="left" valignment="top" usebox="none">
25216 \begin_layout Plain Layout
25222 <cell alignment="left" valignment="top" usebox="none">
25225 \begin_layout Plain Layout
25231 <cell alignment="center" valignment="top" usebox="none">
25234 \begin_layout Plain Layout
25240 <cell alignment="center" valignment="top" usebox="none">
25243 \begin_layout Plain Layout
25249 <cell alignment="center" valignment="top" usebox="none">
25252 \begin_layout Plain Layout
25258 <cell alignment="center" valignment="top" usebox="none">
25261 \begin_layout Plain Layout
25269 <cell alignment="left" valignment="top" usebox="none">
25272 \begin_layout Plain Layout
25278 <cell alignment="left" valignment="top" usebox="none">
25281 \begin_layout Plain Layout
25287 <cell alignment="left" valignment="top" usebox="none">
25290 \begin_layout Plain Layout
25296 <cell alignment="left" valignment="top" usebox="none">
25299 \begin_layout Plain Layout
25305 <cell alignment="center" valignment="top" usebox="none">
25308 \begin_layout Plain Layout
25314 <cell alignment="center" valignment="top" usebox="none">
25317 \begin_layout Plain Layout
25323 <cell alignment="center" valignment="top" usebox="none">
25326 \begin_layout Plain Layout
25332 <cell alignment="center" valignment="top" usebox="none">
25335 \begin_layout Plain Layout
25343 <cell alignment="left" valignment="top" usebox="none">
25346 \begin_layout Plain Layout
25352 <cell alignment="left" valignment="top" usebox="none">
25355 \begin_layout Plain Layout
25361 <cell alignment="left" valignment="top" usebox="none">
25364 \begin_layout Plain Layout
25370 <cell alignment="left" valignment="top" usebox="none">
25373 \begin_layout Plain Layout
25379 <cell alignment="center" valignment="top" usebox="none">
25382 \begin_layout Plain Layout
25388 <cell alignment="center" valignment="top" usebox="none">
25391 \begin_layout Plain Layout
25397 <cell alignment="center" valignment="top" usebox="none">
25400 \begin_layout Plain Layout
25406 <cell alignment="center" valignment="top" usebox="none">
25409 \begin_layout Plain Layout
25417 <cell alignment="left" valignment="top" usebox="none">
25420 \begin_layout Plain Layout
25426 <cell alignment="left" valignment="top" usebox="none">
25429 \begin_layout Plain Layout
25435 <cell alignment="left" valignment="top" usebox="none">
25438 \begin_layout Plain Layout
25444 <cell alignment="left" valignment="top" usebox="none">
25447 \begin_layout Plain Layout
25453 <cell alignment="center" valignment="top" usebox="none">
25456 \begin_layout Plain Layout
25462 <cell alignment="center" valignment="top" usebox="none">
25465 \begin_layout Plain Layout
25471 <cell alignment="center" valignment="top" usebox="none">
25474 \begin_layout Plain Layout
25480 <cell alignment="center" valignment="top" usebox="none">
25483 \begin_layout Plain Layout
25491 <cell alignment="left" valignment="top" usebox="none">
25494 \begin_layout Plain Layout
25500 <cell alignment="left" valignment="top" usebox="none">
25503 \begin_layout Plain Layout
25509 <cell alignment="left" valignment="top" usebox="none">
25512 \begin_layout Plain Layout
25518 <cell alignment="left" valignment="top" usebox="none">
25521 \begin_layout Plain Layout
25527 <cell alignment="center" valignment="top" usebox="none">
25530 \begin_layout Plain Layout
25536 <cell alignment="center" valignment="top" usebox="none">
25539 \begin_layout Plain Layout
25545 <cell alignment="center" valignment="top" usebox="none">
25548 \begin_layout Plain Layout
25554 <cell alignment="center" valignment="top" usebox="none">
25557 \begin_layout Plain Layout
25565 <cell alignment="left" valignment="top" usebox="none">
25568 \begin_layout Plain Layout
25574 <cell alignment="left" valignment="top" usebox="none">
25577 \begin_layout Plain Layout
25583 <cell alignment="left" valignment="top" usebox="none">
25586 \begin_layout Plain Layout
25592 <cell alignment="left" valignment="top" usebox="none">
25595 \begin_layout Plain Layout
25601 <cell alignment="center" valignment="top" usebox="none">
25604 \begin_layout Plain Layout
25610 <cell alignment="center" valignment="top" usebox="none">
25613 \begin_layout Plain Layout
25619 <cell alignment="center" valignment="top" usebox="none">
25622 \begin_layout Plain Layout
25628 <cell alignment="center" valignment="top" usebox="none">
25631 \begin_layout Plain Layout
25639 <cell alignment="left" valignment="top" usebox="none">
25642 \begin_layout Plain Layout
25648 <cell alignment="left" valignment="top" usebox="none">
25651 \begin_layout Plain Layout
25657 <cell alignment="left" valignment="top" usebox="none">
25660 \begin_layout Plain Layout
25666 <cell alignment="left" valignment="top" usebox="none">
25669 \begin_layout Plain Layout
25675 <cell alignment="center" valignment="top" usebox="none">
25678 \begin_layout Plain Layout
25684 <cell alignment="center" valignment="top" usebox="none">
25687 \begin_layout Plain Layout
25693 <cell alignment="center" valignment="top" usebox="none">
25696 \begin_layout Plain Layout
25702 <cell alignment="center" valignment="top" usebox="none">
25705 \begin_layout Plain Layout
25713 <cell alignment="center" valignment="top" usebox="none">
25716 \begin_layout Plain Layout
25722 <cell alignment="center" valignment="top" usebox="none">
25725 \begin_layout Plain Layout
25731 <cell alignment="center" valignment="top" usebox="none">
25734 \begin_layout Plain Layout
25740 <cell alignment="center" valignment="top" usebox="none">
25743 \begin_layout Plain Layout
25749 <cell alignment="center" valignment="top" usebox="none">
25752 \begin_layout Plain Layout
25758 <cell alignment="center" valignment="top" usebox="none">
25761 \begin_layout Plain Layout
25767 <cell alignment="center" valignment="top" usebox="none">
25770 \begin_layout Plain Layout
25776 <cell alignment="center" valignment="top" usebox="none">
25779 \begin_layout Plain Layout
25793 \begin_layout Chapter
25794 Names of available colors to be used in layouts
25795 \begin_inset CommandInset label
25797 name "chap:Names-of-colors"
25804 \begin_layout Standard
25805 The colors listed here are the standard colors and the those that you can
25806 adjust in the \SpecialChar LyX
25810 \begin_layout Description
25823 No particular color – clear or default
25826 \begin_layout Description
25830 \begin_layout Description
25834 \begin_layout Description
25838 \begin_layout Description
25842 \begin_layout Description
25846 \begin_layout Description
25850 \begin_layout Description
25854 \begin_layout Description
25858 \begin_layout Description
25859 added_space Added space marker color
25862 \begin_layout Description
25863 addedtext Added text color
25866 \begin_layout Description
25867 appendix Appendix marker color
25870 \begin_layout Description
25871 background Background color
25874 \begin_layout Description
25875 bottomarea Bottom area color
25878 \begin_layout Description
25879 branchlabel Label color for branches
25882 \begin_layout Description
25883 buttonbg Color used for bottom background
25886 \begin_layout Description
25887 buttonhoverbg Color used for button background under focus
25890 \begin_layout Description
25891 buttonframe Color for inset button frames
25894 \begin_layout Description
25895 changebar Changebar color
25898 \begin_layout Description
25899 changedtextauthor1 Changed text color author 1
25902 \begin_layout Description
25903 changedtextauthor2 Changed text color author 2
25906 \begin_layout Description
25907 changedtextauthor3 Changed text color author 3
25910 \begin_layout Description
25911 changedtextauthor4 Changed text color author 4
25914 \begin_layout Description
25915 changedtextauthor5 Changed text color author 5
25918 \begin_layout Description
25919 collapsable_inset_frame Collapsable insets framecolor
25922 \begin_layout Description
25923 collapsable_inset_text Collapsable insets text color
25926 \begin_layout Description
25927 command Text color for command insets
25930 \begin_layout Description
25931 commandbg Background color for command insets
25934 \begin_layout Description
25935 commandframe Frame color for command insets
25938 \begin_layout Description
25939 comment color for comments
25942 \begin_layout Description
25943 commentbg Background color of comments
25946 \begin_layout Description
25947 cursor Cursor color
25950 \begin_layout Description
25951 deletedtext Deleted text color
25954 \begin_layout Description
25955 deletedtextmodifier Deleted text modifying color
25958 \begin_layout Description
25959 depthbar Color for the depth bars in the margin
25962 \begin_layout Description
25963 eolmarker End of line marker color
25966 \begin_layout Description
25967 error Color of the \SpecialChar LaTeX
25971 \begin_layout Description
25972 footlabel Label color for footnotes
25975 \begin_layout Description
25976 graphicsbg Graphics inset background color
25979 \begin_layout Description
25980 greyedout Label color for greyedout insets
25983 \begin_layout Description
25984 greyedoutbg Background color of greyedout inset
25987 \begin_layout Description
25988 greyedouttext Color for greyedout inset text
25991 \begin_layout Description
25992 indexlabel Label color for index insets
25995 \begin_layout Description
25996 ignore The color is ignored
25999 \begin_layout Description
26000 inherit The color is inherited
26003 \begin_layout Description
26004 inlinecompletion Inline completion color
26007 \begin_layout Description
26008 insetbg Inset marker background color
26011 \begin_layout Description
26012 insetframe Inset marker frame color
26015 \begin_layout Description
26016 language Color for marking foreign language words
26019 \begin_layout Description
26020 latex Text color in \SpecialChar LaTeX
26024 \begin_layout Description
26025 listingsbg Background color of listings inset
26028 \begin_layout Description
26029 marginlabel Label color for margin notes
26032 \begin_layout Description
26033 math Math inset text color
26036 \begin_layout Description
26037 mathbg Math inset background color
26040 \begin_layout Description
26041 mathcorners Math inset frame color not under focus
26044 \begin_layout Description
26045 mathframe Math inset frame color under focus
26048 \begin_layout Description
26049 mathline Math line color
26052 \begin_layout Description
26053 mathmacrobg Macro math inset background color
26056 \begin_layout Description
26057 mathmacroblend Macro math blended color
26060 \begin_layout Description
26061 mathmacroframe Macro math frame color
26064 \begin_layout Description
26065 mathmacrohoverbg Macro math inset background color hovered
26068 \begin_layout Description
26069 mathmacrolabel Macro math label color
26072 \begin_layout Description
26073 mathmacronewarg Macro template color for new parameters
26076 \begin_layout Description
26077 mathmacrooldarg Macro template color for old parameters
26080 \begin_layout Description
26081 newpage New page color
26084 \begin_layout Description
26085 nonunique_inlinecompletion Inline completion color for the non-unique part
26088 \begin_layout Description
26089 notebg Background color of notes
26092 \begin_layout Description
26093 notelabel Label color for notes
26096 \begin_layout Description
26097 pagebreak Page break/line break color
26100 \begin_layout Description
26101 paragraphmarker Color used for the pilcrow sign to mark the end of a paragraph
26104 \begin_layout Description
26105 phantomtext Text color for phantom insets
26108 \begin_layout Description
26109 preview The color used for previews
26112 \begin_layout Description
26113 previewframe Preview frame color
26116 \begin_layout Description
26117 regexpframe Color for regexp frame
26120 \begin_layout Description
26121 selection Background color of selected text
26124 \begin_layout Description
26125 selectiontext Foreground color of selected text
26128 \begin_layout Description
26129 shadedbg Background color of shaded box
26132 \begin_layout Description
26133 special Special chars text color
26136 \begin_layout Description
26137 tabularline Table line color
26140 \begin_layout Description
26141 tabularonoffline Table line color
26144 \begin_layout Description
26145 urllabel Label color for URL insets
26148 \begin_layout Description
26149 urltext Color for URL inset text