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 \@ifpackageloaded{babel}{
39 \addto\extrasenglish{%
40 \renewcommand*{\equationautorefname}[1]{}%
41 \renewcommand{\sectionautorefname}{sec.\negthinspace}%
42 \renewcommand{\subsectionautorefname}{sec.\negthinspace}%
43 \renewcommand{\subsubsectionautorefname}{sec.\negthinspace}%
47 \options fleqn,bibliography=totoc,index=totoc,BCOR7.5mm,titlepage,captions=tableheading
48 \use_default_options false
52 \maintain_unincluded_children false
55 InsetLayout Flex:MenuItem
64 \newcommand*{\menuitem}[1]{{\sffamily #1}}
67 # In case we need to do with sans...
68 #InsetLayout CharStyle:Code
73 #\renewcommand{\code}[1]{{\sffamily #1}}
78 \language_package default
81 \font_roman "default" "default"
82 \font_sans "default" "default"
83 \font_typewriter "default" "default"
84 \font_math "auto" "auto"
85 \font_default_family default
86 \use_non_tex_fonts false
89 \font_sf_scale 100 100
90 \font_tt_scale 100 100
92 \default_output_format default
94 \bibtex_command default
95 \index_command default
99 \pdf_title "LyX Configuration Manual"
100 \pdf_author "LyX Team"
101 \pdf_subject "LyX-documentation Customization"
102 \pdf_keywords "LyX, documentation, customization"
104 \pdf_bookmarksnumbered true
105 \pdf_bookmarksopen true
106 \pdf_bookmarksopenlevel 1
107 \pdf_breaklinks false
111 \pdf_pdfusetitle false
112 \pdf_quoted_options "linkcolor=black, citecolor=black, urlcolor=blue, filecolor=blue,pdfpagelayout=OneColumn, pdfnewwindow=true, pdfstartview=XYZ, plainpages=false"
115 \use_package amsmath 0
116 \use_package amssymb 0
117 \use_package cancel 0
119 \use_package mathdots 1
120 \use_package mathtools 0
121 \use_package mhchem 0
122 \use_package stackrel 0
123 \use_package stmaryrd 0
124 \use_package undertilde 0
126 \cite_engine_type default
130 \paperorientation portrait
145 \paragraph_separation indent
146 \paragraph_indentation default
147 \quotes_language english
150 \paperpagestyle headings
151 \tracking_changes true
152 \output_changes false
156 \author -712698321 "Jürgen Spitzmüller"
157 \author -195340706 "Georg Baum"
158 \author 155139281 "Jrgen Spitzmller"
159 \author 274215730 "scott"
165 Customizing \SpecialChar LyX
166 : Features for the Advanced User
170 by the \SpecialChar LyX
175 \begin_layout Plain Layout
177 If you have comments or error corrections, please send them to the \SpecialChar LyX
180 \begin_inset CommandInset href
182 target "lyx-docs@lists.lyx.org"
189 \begin_inset Quotes eld
193 \begin_inset Quotes erd
196 in the subject header, and please cc the current maintainer of this file,
197 Richard Heck <rgheck@comcast.net>.
203 \begin_inset Newline newline
207 \begin_inset Newline newline
213 \begin_layout Standard
214 \begin_inset CommandInset toc
215 LatexCommand tableofcontents
222 \begin_layout Standard
223 \begin_inset Note Note
226 \begin_layout Plain Layout
227 Please use change tracking when modifying this document.
228 This makes it easier for our translators to recognize things that have
229 been changed, and it helps the maintainer keep up-to-date with what's been
238 \begin_layout Chapter
242 \begin_layout Standard
243 This manual covers the customization features present in \SpecialChar LyX
245 In it, we discuss issues like keyboard shortcuts, screen previewing options,
246 printer options, sending commands to \SpecialChar LyX
247 via the \SpecialChar LyX
248 Server, internationalization,
249 installing new \SpecialChar LaTeX
250 classes and \SpecialChar LyX
252 We can't possibly hope to touch on everything you can change—our developers
253 add new features faster than we can document them—but we will explain the
254 most common customizations and hopefully point you in the right direction
255 for some of the more obscure ones.
258 \begin_layout Standard
259 \begin_inset Branch OutDated
262 \begin_layout Standard
263 Information from previous versions of this document that now seems to be
264 outdated is contained in the OutDated branch of this document.
265 By default, this information will not appear in the \SpecialChar LaTeX
274 \begin_layout Chapter
279 \begin_layout Standard
280 This chapter aims to help you to find your way through the \SpecialChar LyX
283 Before continuing to read this chapter, you should find out where your
285 library and user directories are by using
286 \begin_inset Flex MenuItem
289 \begin_layout Plain Layout
290 Help\SpecialChar menuseparator
296 \change_deleted -712698321 1437634470
299 \change_inserted -712698321 1437634471
308 The library directory is the place where \SpecialChar LyX
309 places its system-wide configuration
310 files; the user directory is where you can place your modified versions.
311 We will call the former
312 \begin_inset Flex Code
315 \begin_layout Plain Layout
317 \change_inserted -712698321 1437634480
319 \change_deleted -712698321 1437634481
329 \begin_inset Flex MenuItem
332 \begin_layout Plain Layout
338 in the remainder of this document.
342 \begin_layout Section
344 \begin_inset Flex Code
347 \begin_layout Plain Layout
349 \change_inserted -712698321 1437634488
351 \change_deleted -712698321 1437634487
363 \begin_layout Standard
364 \begin_inset Flex Code
367 \begin_layout Plain Layout
369 \change_deleted -712698321 1437634497
372 \change_inserted -712698321 1437634498
380 and its sub-directories contain a number of files and that can be used
381 to customize \SpecialChar LyX
383 You can change many of these files from within \SpecialChar LyX
385 \begin_inset Flex MenuItem
388 \begin_layout Plain Layout
389 Tools\SpecialChar menuseparator
396 Most customization that you will want to do in \SpecialChar LyX
397 is possible through this
399 However, many other inner aspects of \SpecialChar LyX
400 can be customized by modifying the
402 \begin_inset Flex Code
405 \begin_layout Plain Layout
407 \change_deleted -712698321 1437634507
410 \change_inserted -712698321 1437634507
419 These files fall in different categories, described in the following subsection
423 \begin_layout Subsection
424 Automatically generated files
427 \begin_layout Standard
428 The files, which are to be found in
429 \begin_inset Flex MenuItem
432 \begin_layout Plain Layout
438 , are generated when you configure \SpecialChar LyX
440 They contain various default values that are guessed by inspection.
441 In general, it is not a good idea to modify them, since they might be overwritt
445 \begin_layout Labeling
446 \labelwidthstring 00.00.0000
447 \begin_inset Flex Code
450 \begin_layout Plain Layout
456 contains defaults for various commands.
459 \begin_layout Labeling
460 \labelwidthstring 00.00.0000
461 \begin_inset Flex Code
464 \begin_layout Plain Layout
470 contains the list of packages that have been recognized by \SpecialChar LyX
472 It is currently unused by the \SpecialChar LyX
473 program itself, but the information extracted,
474 and more, is made available with
475 \begin_inset Flex MenuItem
478 \begin_layout Plain Layout
479 Help\SpecialChar menuseparator
493 \begin_layout Labeling
494 \labelwidthstring 00.00.0000
495 \begin_inset Flex Code
498 \begin_layout Plain Layout
504 the list of text classes that have been found in your
505 \begin_inset Flex Code
508 \begin_layout Plain Layout
514 directories, along with the associated \SpecialChar LaTeX
515 document class and their description.
518 \begin_layout Labeling
519 \labelwidthstring 00.00.0000
520 \begin_inset Flex Code
523 \begin_layout Plain Layout
529 the list of layout modules found in your
530 \begin_inset Flex Code
533 \begin_layout Plain Layout
542 \begin_layout Labeling
543 \labelwidthstring 00.00.0000
544 \begin_inset Flex Code
547 \begin_layout Plain Layout
553 lists of various sorts of \SpecialChar LaTeX
554 -related files found on your system
557 \begin_layout Labeling
558 \labelwidthstring 00.00.0000
559 \begin_inset Flex Code
562 \begin_layout Plain Layout
563 doc/\SpecialChar LaTeX
569 is automatically generated during configuration from the file
570 \begin_inset Flex Code
573 \begin_layout Plain Layout
581 It contains information on your \SpecialChar LaTeX
585 \begin_layout Subsection
589 \begin_layout Standard
590 These directories are duplicated between
591 \begin_inset Flex Code
594 \begin_layout Plain Layout
596 \change_deleted -712698321 1437634516
599 \change_inserted -712698321 1437634517
608 \begin_inset Flex Code
611 \begin_layout Plain Layout
618 If a particular files exists in both places, the one in
619 \begin_inset Flex Code
622 \begin_layout Plain Layout
631 \begin_layout Labeling
632 \labelwidthstring 00.00.0000
633 \begin_inset Flex Code
636 \begin_layout Plain Layout
642 this directory contains files with the extension
643 \begin_inset Flex Code
646 \begin_layout Plain Layout
652 that define the keybindings used in \SpecialChar LyX
654 If there exists an internationalized version of the bind file named
655 \begin_inset Flex Code
658 \begin_layout Plain Layout
664 , that will be used first.
667 \begin_layout Labeling
668 \labelwidthstring 00.00.0000
669 \begin_inset Flex Code
672 \begin_layout Plain Layout
678 contains graphics files that can be included in documents.
682 \begin_layout Labeling
683 \labelwidthstring 00.00.0000
684 \begin_inset Flex Code
687 \begin_layout Plain Layout
693 contains \SpecialChar LyX
694 documentation files (including the one you are currently reading).
696 \begin_inset Flex Code
699 \begin_layout Plain Layout
706 deserves special attention, as noted above.
707 The internationalized help docs are in subdirectories
708 \begin_inset Flex Code
711 \begin_layout Plain Layout
718 \begin_inset Quotes eld
722 \begin_inset Quotes erd
725 is the ISO language code.
727 \begin_inset CommandInset ref
729 reference "cha:Internationalizing-LyX"
736 \begin_layout Labeling
737 \labelwidthstring 00.00.0000
738 \begin_inset Flex Code
741 \begin_layout Plain Layout
747 contains example files that explain how to use some features.
748 In the file browser, press the
749 \begin_inset Flex MenuItem
752 \begin_layout Plain Layout
761 \begin_layout Labeling
762 \labelwidthstring 00.00.0000
763 \begin_inset Flex Code
766 \begin_layout Plain Layout
772 contains image files that are used by the
773 \begin_inset Flex MenuItem
776 \begin_layout Plain Layout
783 In addition, it also contains the individual icons used in the toolbar
784 and the banners that can be shown when \SpecialChar LyX
788 \begin_layout Labeling
789 \labelwidthstring 00.00.0000
790 \begin_inset Flex Code
793 \begin_layout Plain Layout
799 contains keyboard keymapping files.
801 \begin_inset CommandInset ref
803 reference "sec:International-Keymap-Stuff"
810 \begin_layout Labeling
811 \labelwidthstring 00.00.0000
812 \begin_inset Flex Code
815 \begin_layout Plain Layout
821 contains the text class and module files described in
822 \begin_inset CommandInset ref
824 reference "cha:Installing-New-Document"
831 \begin_layout Labeling
832 \labelwidthstring 00.00.0000
833 \begin_inset Flex Code
836 \begin_layout Plain Layout
843 \begin_inset Flex Code
846 \begin_layout Plain Layout
852 Python scripts used to convert between \SpecialChar LyX
854 These can be run from the command line if, say, you want to batch-convert
858 \begin_layout Labeling
859 \labelwidthstring 00.00.0000
860 \begin_inset Flex Code
863 \begin_layout Plain Layout
869 contains some files that demonstrate the capabilities of the
870 \begin_inset Flex MenuItem
873 \begin_layout Plain Layout
884 Also contains some scripts used by \SpecialChar LyX
888 \begin_layout Labeling
889 \labelwidthstring 00.00.0000
890 \begin_inset Flex Code
893 \begin_layout Plain Layout
899 contains the standard \SpecialChar LyX
900 template files described in
901 \begin_inset CommandInset ref
903 reference "subsec:Creating-Templates"
910 \begin_layout Labeling
911 \labelwidthstring 00.00.0000
912 \begin_inset Flex Code
915 \begin_layout Plain Layout
921 contains files with the extension
922 \begin_inset Flex Code
925 \begin_layout Plain Layout
931 that define the user interface to \SpecialChar LyX
933 That is, the files define which items appear in which menus and the items
934 appearing on the toolbar.
937 \begin_layout Subsection
938 Files you don't want to modify
941 \begin_layout Standard
942 These files are used internally by \SpecialChar LyX
943 and you generally do not need to modify
944 them unless you are a developer.
947 \begin_layout Labeling
948 \labelwidthstring 00.00.0000
949 \begin_inset Flex Code
952 \begin_layout Plain Layout
958 this file contains the list of \SpecialChar LyX
960 The contents are displayed with the menu entry
961 \begin_inset Flex MenuItem
964 \begin_layout Plain Layout
965 Help\SpecialChar menuseparator
971 \change_deleted -712698321 1437634530
974 \change_inserted -712698321 1437634531
985 \begin_layout Labeling
986 \labelwidthstring 00.00.0000
987 \begin_inset Flex Code
990 \begin_layout Plain Layout
996 this is a \SpecialChar LaTeX
997 script used during the configuration process.
1001 \begin_layout Labeling
1002 \labelwidthstring 00.00.0000
1003 \begin_inset Flex Code
1006 \begin_layout Plain Layout
1012 this is a Python script that is used to re-configure \SpecialChar LyX
1014 It creates configuration files in the directory it was run from.
1017 \begin_layout Subsection
1018 Other files needing a line or two
1021 \begin_layout Labeling
1022 \labelwidthstring 00.00.0000
1023 \begin_inset Flex Code
1026 \begin_layout Plain Layout
1032 this contains tables describing how different character encodings can be
1036 \begin_layout Labeling
1037 \labelwidthstring 00.00.0000
1038 \begin_inset Flex Code
1041 \begin_layout Plain Layout
1047 this file contains the templates available to the new
1048 \begin_inset Flex MenuItem
1051 \begin_layout Plain Layout
1053 \begin_inset space ~
1062 \begin_inset CommandInset ref
1064 reference "chap:Including-External-Material"
1071 \begin_layout Labeling
1072 \labelwidthstring 00.00.0000
1073 \begin_inset Flex Code
1076 \begin_layout Plain Layout
1082 this file contains a list of all the languages currently supported by \SpecialChar LyX
1086 \begin_layout Labeling
1087 \labelwidthstring 00.00.0000
1088 \begin_inset Flex Code
1091 \begin_layout Plain Layout
1097 contains information about the supported fonts.
1100 \begin_layout Labeling
1101 \labelwidthstring 00.00.0000
1102 \begin_inset Flex Code
1105 \begin_layout Plain Layout
1111 this file contains translations for internationalized paragraph styles
1113 \begin_inset CommandInset ref
1115 reference "subsec:I18n"
1122 \begin_layout Labeling
1123 \labelwidthstring 00.00.0000
1124 \begin_inset Flex Code
1127 \begin_layout Plain Layout
1133 this file contains information about unicode-encoded glyphs and the way
1134 they are supported by \SpecialChar LyX
1135 via \SpecialChar LaTeX
1139 \begin_layout Section
1140 Your local configuration directory
1143 \begin_layout Standard
1144 Even if you are using \SpecialChar LyX
1145 as an unprivileged user, you might want to change
1147 configuration for your own use.
1149 \begin_inset Flex Code
1152 \begin_layout Plain Layout
1158 directory contains all your personal configuration files.
1159 This is the directory described as
1160 \begin_inset Quotes eld
1164 \begin_inset Quotes erd
1168 \begin_inset Flex MenuItem
1171 \begin_layout Plain Layout
1172 Help\SpecialChar menuseparator
1174 \begin_inset space ~
1178 \change_inserted -712698321 1437634544
1180 \change_deleted -712698321 1437634543
1190 This directory is used as a mirror of
1191 \begin_inset Flex Code
1194 \begin_layout Plain Layout
1196 \change_deleted -712698321 1437634548
1199 \change_inserted -712698321 1437634549
1207 , which means that every file in
1208 \begin_inset Flex Code
1211 \begin_layout Plain Layout
1217 is a replacement for the corresponding file in
1218 \begin_inset Flex Code
1221 \begin_layout Plain Layout
1223 \change_deleted -712698321 1437634553
1226 \change_inserted -712698321 1437634554
1235 Any configuration file described in the above sections can be placed either
1236 in the system-wide directory, in which case it will affect all users, or
1237 in your local directory for your own use.
1240 \begin_layout Standard
1241 To make things clearer, let's provide a few examples:
1244 \begin_layout Itemize
1245 The preferences set in the
1246 \begin_inset Flex MenuItem
1249 \begin_layout Plain Layout
1250 Tools\SpecialChar menuseparator
1256 dialog are saved to a file
1257 \begin_inset Flex Code
1260 \begin_layout Plain Layout
1267 \begin_inset Flex Code
1270 \begin_layout Plain Layout
1279 \begin_layout Itemize
1280 When you reconfigure using
1281 \begin_inset Flex MenuItem
1284 \begin_layout Plain Layout
1285 Tools\SpecialChar menuseparator
1293 \begin_inset Flex Code
1296 \begin_layout Plain Layout
1302 script, and the resulting files are written in your local configuration
1304 This means that any additional text class file that you might have added
1306 \begin_inset Flex Code
1309 \begin_layout Plain Layout
1315 will be added to the list of classes in the
1316 \begin_inset Flex MenuItem
1319 \begin_layout Plain Layout
1320 Document\SpecialChar menuseparator
1329 \begin_layout Itemize
1330 If you get some updated documentation from \SpecialChar LyX
1331 ftp site and cannot install
1332 it because you do not have sysadmin rights on your system, you can just
1334 \begin_inset Flex Code
1337 \begin_layout Plain Layout
1343 and the items in the
1344 \begin_inset Flex MenuItem
1347 \begin_layout Plain Layout
1353 menu will open them!
1356 \begin_layout Section
1357 Running \SpecialChar LyX
1358 with multiple configurations
1361 \begin_layout Standard
1362 The configuration freedom of the local configuration directory may not suffice
1363 if you want to have more than one configuration at your disposal.
1364 For example, you may want to be use different key bindings or printer settings
1366 You can achieve this by having several such directories.
1367 You then specify which directory to use at run-time.
1370 \begin_layout Standard
1371 Invoking \SpecialChar LyX
1372 with the command line switch
1373 \begin_inset Flex Code
1376 \begin_layout Plain Layout
1386 instructs the program to read the configuration from that directory, and
1387 not from the default directory.
1388 (You can determine the default directory by running \SpecialChar LyX
1390 \begin_inset Flex Code
1393 \begin_layout Plain Layout
1399 switch.) If the specified directory does not exist, \SpecialChar LyX
1401 for you, just like it does for the default directory on the first time
1402 you run the program.
1403 You can modify the configuration options in this additional user directory
1404 exactly as you would for the default directory.
1405 These directories are completely independent (but read on).
1406 Note that setting the environment variable
1407 \begin_inset Flex Code
1410 \begin_layout Plain Layout
1416 to some value has exactly the same effect.
1419 \begin_layout Standard
1420 Having several configurations also requires more maintenance: if you want
1421 to add a new layout to
1422 \begin_inset Flex Code
1425 \begin_layout Plain Layout
1431 which you want available from all your configurations, you must add it
1432 to each directory separately.
1433 You can avoid this with the following trick: after \SpecialChar LyX
1434 creates the additional
1435 directory, most of the subdirectories (see above) are empty.
1436 If you want the new configuration to mirror an existing one, replace the
1437 empty subdirectory with a symbolic link to the matching subdirectory in
1438 the existing configuration.
1440 \begin_inset Flex Code
1443 \begin_layout Plain Layout
1449 subdirectory, however, since it contains a file written by the configuration
1450 script (also accessible through
1451 \begin_inset Flex MenuItem
1454 \begin_layout Plain Layout
1455 Tools\SpecialChar menuseparator
1461 ) which is configuration-specific.
1464 \begin_layout Chapter
1465 The Preferences dialog
1468 \begin_layout Standard
1469 All options of the preferences dialog are described in the Appendix
1471 The Preferences Dialog
1478 For some options you might find here more details.
1481 \begin_layout Section
1483 \begin_inset CommandInset label
1492 \begin_layout Standard
1493 The first step is to define your file formats if they are not already defined.
1495 \begin_inset Flex MenuItem
1498 \begin_layout Plain Layout
1499 Tools\SpecialChar menuseparator
1507 \begin_inset Flex MenuItem
1510 \begin_layout Plain Layout
1511 File Handling\SpecialChar menuseparator
1518 \begin_inset Flex MenuItem
1521 \begin_layout Plain Layout
1527 button to define your new format.
1529 \begin_inset Flex MenuItem
1532 \begin_layout Plain Layout
1538 field contains the name used to identify the format in the GUI.
1540 \begin_inset Flex MenuItem
1543 \begin_layout Plain Layout
1549 is used to identify the format internally.
1550 You will also need to enter a file extension.
1551 These are all required.
1553 \begin_inset Flex MenuItem
1556 \begin_layout Plain Layout
1562 field is used to provide a keyboard shortcut on the menus.
1563 (For example, pressing
1564 \begin_inset Flex MenuItem
1567 \begin_layout Plain Layout
1574 \begin_inset Flex MenuItem
1577 \begin_layout Plain Layout
1578 Document\SpecialChar menuseparator
1579 View (Other Formats)\SpecialChar menuseparator
1588 \begin_layout Standard
1590 \begin_inset Flex MenuItem
1593 \begin_layout Plain Layout
1600 \begin_inset Flex MenuItem
1603 \begin_layout Plain Layout
1610 For example, you might want to use
1611 \begin_inset Flex MenuItem
1614 \begin_layout Plain Layout
1620 to view PostScript files.
1621 You can enter the command needed to start the program in the corresponding
1623 In defining this command, you can use the four variables listed in the
1625 The viewer is launched when you view an image in \SpecialChar LyX
1627 \begin_inset Flex MenuItem
1630 \begin_layout Plain Layout
1631 Document\SpecialChar menuseparator
1638 The editor is for example launched when you right-click on an image and
1640 \begin_inset Flex MenuItem
1643 \begin_layout Plain Layout
1649 in the appearing context menu.
1652 \begin_layout Standard
1654 \begin_inset Flex MenuItem
1657 \begin_layout Plain Layout
1663 type of a format is optional, but if it is specified, it must be unique
1665 It is used to detect files of this format from the file contents.
1666 For some important file formats there is no MIME type officially registered
1668 \begin_inset CommandInset href
1671 target "http://www.iana.org/assignments/media-types/"
1676 Therefore \SpecialChar LyX
1677 uses the extended list of MIME types as specified by
1678 \begin_inset CommandInset href
1680 name "freedesktop.org"
1681 target "http://www.freedesktop.org/wiki/Specifications/shared-mime-info-spec"
1688 \begin_layout Standard
1690 \begin_inset Flex MenuItem
1693 \begin_layout Plain Layout
1699 option tells \SpecialChar LyX
1700 that a format is suitable for document export.
1701 If this is set and if a suitable conversion route exists (see
1702 \begin_inset CommandInset ref
1704 reference "sec:Converters"
1708 ), the format will appear in the
1709 \begin_inset Flex MenuItem
1712 \begin_layout Plain Layout
1713 File\SpecialChar menuseparator
1720 The format will also appear in the
1721 \begin_inset Flex MenuItem
1724 \begin_layout Plain Layout
1725 Document\SpecialChar menuseparator
1731 menu if a viewer is specified for the format.
1732 Pure image formats, such as
1733 \begin_inset Flex Code
1736 \begin_layout Plain Layout
1742 , should not use this option.
1743 Formats that can both represent vector graphics and documents like
1744 \begin_inset Flex Code
1747 \begin_layout Plain Layout
1756 \begin_layout Standard
1758 \begin_inset Flex MenuItem
1761 \begin_layout Plain Layout
1762 Vector graphics format
1767 tells \SpecialChar LyX
1768 that a format can contain vector graphics.
1769 This information is used to determine the target format of included graphics
1771 \begin_inset Flex MenuItem
1774 \begin_layout Plain Layout
1781 Included graphics may need to be converted to either
1782 \begin_inset Flex MenuItem
1785 \begin_layout Plain Layout
1792 \begin_inset Flex MenuItem
1795 \begin_layout Plain Layout
1802 \begin_inset Flex MenuItem
1805 \begin_layout Plain Layout
1812 \begin_inset Flex MenuItem
1815 \begin_layout Plain Layout
1821 cannot handle other image formats.
1822 If an included graphic is not already in
1823 \begin_inset Flex MenuItem
1826 \begin_layout Plain Layout
1833 \begin_inset Flex MenuItem
1836 \begin_layout Plain Layout
1843 \begin_inset Flex MenuItem
1846 \begin_layout Plain Layout
1852 format, it is converted to
1853 \begin_inset Flex MenuItem
1856 \begin_layout Plain Layout
1862 if the vector format option is set, and otherwise to
1863 \begin_inset Flex MenuItem
1866 \begin_layout Plain Layout
1875 \begin_layout Section
1879 \begin_layout Standard
1880 Since all conversions from one format to another take place in \SpecialChar LyX
1882 directory, it is sometimes necessary to modify a file before copying it
1883 to the temporary directory in order that the conversion may be performed.
1887 \begin_layout Plain Layout
1888 For example, the file may refer to other files—images, for example—using
1889 relative file names, and these may become invalid when the file is copied
1890 to the temporary directory.
1895 This is done by a Copier: It copies a file to (or from) the temporary directory
1896 and may modify it in the process.
1899 \begin_layout Standard
1900 The definitions of the copiers may use four variables:
1903 \begin_layout Labeling
1904 \labelwidthstring 00.00.0000
1905 \begin_inset Flex Code
1908 \begin_layout Plain Layout
1914 The \SpecialChar LyX
1915 system directory (e.
1916 \begin_inset space \thinspace{}
1920 \begin_inset space \space{}
1924 \begin_inset Flex MenuItem
1927 \begin_layout Plain Layout
1936 \begin_layout Labeling
1937 \labelwidthstring 00.00.0000
1938 \begin_inset Flex Code
1941 \begin_layout Plain Layout
1950 \begin_layout Labeling
1951 \labelwidthstring 00.00.0000
1952 \begin_inset Flex Code
1955 \begin_layout Plain Layout
1964 \begin_layout Labeling
1965 \labelwidthstring 00.00.0000
1966 \begin_inset Flex Code
1969 \begin_layout Plain Layout
1975 The base name (without filename extension) in the \SpecialChar LyX
1979 \begin_layout Labeling
1980 \labelwidthstring 00.00.0000
1981 \begin_inset Flex Code
1984 \begin_layout Plain Layout
1990 The full directory path of the \SpecialChar LyX
1994 \begin_layout Labeling
1995 \labelwidthstring 00.00.0000
1996 \begin_inset Flex Code
1999 \begin_layout Plain Layout
2005 The full pathname to the original \SpecialChar LyX
2006 file being processed
2009 \begin_layout Labeling
2010 \labelwidthstring 00.00.0000
2011 \begin_inset Flex Code
2014 \begin_layout Plain Layout
2020 The filename (without any directory path) of the \SpecialChar LyX
2024 \begin_layout Labeling
2025 \labelwidthstring 00.00.0000
2026 \begin_inset Flex Code
2029 \begin_layout Plain Layout
2035 The `\SpecialChar LaTeX
2039 \begin_layout Standard
2040 The latter should be the filename as it would be used in a \SpecialChar LaTeX
2048 It is relevant only when exporting files suitable for such inclusion.
2051 \begin_layout Standard
2052 Copiers can be used to do almost anything with output files.
2053 For example, suppose you want generated pdf files to be copied to a special
2055 \begin_inset Flex Code
2058 \begin_layout Plain Layout
2065 Then you could write a shell script such as this one:
2068 \begin_layout Standard
2069 \begin_inset listings
2073 \begin_layout Plain Layout
2078 \begin_layout Plain Layout
2083 \begin_layout Plain Layout
2085 TOFILE=`basename $2`
2088 \begin_layout Plain Layout
2090 cp $FROMFILE /home/you/pdf/$TOFILE
2095 Save it in your local \SpecialChar LyX
2097 \begin_inset Flex Code
2100 \begin_layout Plain Layout
2101 /home/you/.lyx/scripts/pdfcopier.sh
2106 —and make it executable, if you need to do so on your platform.
2108 \begin_inset Flex MenuItem
2111 \begin_layout Plain Layout
2112 Tools\SpecialChar menuseparator
2118 dialog, select under
2119 \begin_inset Flex MenuItem
2122 \begin_layout Plain Layout
2123 File Handling\SpecialChar menuseparator
2130 \begin_inset Flex MenuItem
2133 \begin_layout Plain Layout
2139 format—or one of the other pdf formats—and enter
2140 \begin_inset Flex Code
2143 \begin_layout Plain Layout
2144 pdfcopier.sh $$i $$o
2150 \begin_inset Flex MenuItem
2153 \begin_layout Plain Layout
2163 \begin_layout Standard
2164 Copiers are used by \SpecialChar LyX
2165 in various of its own conversions.
2166 For example, if appropriate programs are found, \SpecialChar LyX
2167 will automatically install
2169 \begin_inset Flex MenuItem
2172 \begin_layout Plain Layout
2179 \begin_inset Flex MenuItem
2182 \begin_layout Plain Layout
2184 \begin_inset space ~
2193 When these formats are exported, the copier sees that not just the main
2194 HTML file but various associated files (style files, images, etc.) are also
2196 All these files are written to a subdirectory of the directory in which
2197 the original \SpecialChar LyX
2202 \begin_layout Plain Layout
2203 This copier can be customized.
2205 \begin_inset Quotes eld
2209 \begin_inset Quotes erd
2212 argument takes a comma-separated list of extensions to be copied; if it
2213 is omitted, all files will be copied.
2215 \begin_inset Quotes eld
2219 \begin_inset Quotes erd
2222 argument determines the extension added to the generated directory.
2224 \begin_inset Quotes eld
2228 \begin_inset Flex MenuItem
2231 \begin_layout Plain Layout
2233 \change_inserted -712698321 1437634589
2235 \change_deleted -712698321 1437634588
2245 \begin_inset Quotes erd
2248 , so HTML generated from
2249 \begin_inset Flex MenuItem
2252 \begin_layout Plain Layout
2253 /path/to/filename.lyx
2259 \begin_inset Flex MenuItem
2262 \begin_layout Plain Layout
2263 /path/to/filename.html.
2264 \change_deleted -712698321 1437634593
2267 \change_inserted -712698321 1437634595
2284 \begin_layout Section
2286 \begin_inset CommandInset label
2288 name "sec:Converters"
2295 \begin_layout Standard
2296 You can define your own Converters to convert files between different formats.
2298 \begin_inset Flex MenuItem
2301 \begin_layout Plain Layout
2302 Tools\SpecialChar menuseparator
2303 Preferences\SpecialChar menuseparator
2304 File Handling\SpecialChar menuseparator
2313 \begin_layout Standard
2314 To define a new converter, select the
2315 \begin_inset Flex MenuItem
2318 \begin_layout Plain Layout
2320 \begin_inset space ~
2329 \begin_inset Flex MenuItem
2332 \begin_layout Plain Layout
2334 \begin_inset space ~
2342 from the drop-down lists, enter the command needed for the conversion,
2344 \begin_inset Flex MenuItem
2347 \begin_layout Plain Layout
2354 Several variables can be used in the definition of converters:
2357 \begin_layout Labeling
2358 \labelwidthstring 00.00.0000
2359 \begin_inset Flex Code
2362 \begin_layout Plain Layout
2368 The \SpecialChar LyX
2372 \begin_layout Labeling
2373 \labelwidthstring 00.00.0000
2374 \begin_inset Flex Code
2377 \begin_layout Plain Layout
2386 \begin_layout Labeling
2387 \labelwidthstring 00.00.0000
2388 \begin_inset Flex Code
2391 \begin_layout Plain Layout
2400 \begin_layout Labeling
2401 \labelwidthstring 00.00.0000
2402 \begin_inset Flex Code
2405 \begin_layout Plain Layout
2411 The base filename of the input file (i.
2412 \begin_inset space \thinspace{}
2415 g., without the extension)
2418 \begin_layout Labeling
2419 \labelwidthstring 00.00.0000
2420 \begin_inset Flex Code
2423 \begin_layout Plain Layout
2429 The path to the input file
2432 \begin_layout Labeling
2433 \labelwidthstring 00.00.0000
2434 \begin_inset Flex Code
2437 \begin_layout Plain Layout
2443 The path to the original input file (this is different from $$p when a
2444 chain of converters is called)
2447 \begin_layout Labeling
2448 \labelwidthstring 00.00.0000
2449 \begin_inset Flex Code
2452 \begin_layout Plain Layout
2458 The iconv name for the encoding of the document.
2461 \begin_layout Standard
2463 \begin_inset Flex MenuItem
2466 \begin_layout Plain Layout
2468 \begin_inset space ~
2476 field you can enter the following flags, separated by commas:
2479 \begin_layout Labeling
2480 \labelwidthstring 00.00.0000
2481 \begin_inset Flex Code
2484 \begin_layout Plain Layout
2490 This converter runs some form of \SpecialChar LaTeX
2492 This will make \SpecialChar LyX
2493 's \SpecialChar LaTeX
2494 error logs available.
2497 \begin_layout Labeling
2498 \labelwidthstring 00.00.0000
2499 \begin_inset Flex Code
2502 \begin_layout Plain Layout
2508 Needs the \SpecialChar LaTeX
2510 \begin_inset Flex MenuItem
2513 \begin_layout Plain Layout
2519 file for the conversion.
2522 \begin_layout Labeling
2523 \labelwidthstring 00.00.0000
2524 \begin_inset Flex Code
2527 \begin_layout Plain Layout
2534 \begin_inset Quotes eld
2538 \begin_inset Quotes erd
2541 file from the backend, which in practice means a \SpecialChar LaTeX
2542 file like the one we
2543 would export, without
2544 \begin_inset Flex Code
2547 \begin_layout Plain Layout
2556 \begin_layout Labeling
2557 \labelwidthstring 00.00.0000
2558 \begin_inset Flex Code
2561 \begin_layout Plain Layout
2570 \begin_layout Standard
2571 The following three flags are not really flags at all because they take
2573 \begin_inset Flex MenuItem
2576 \begin_layout Plain Layout
2578 \begin_inset space ~
2582 \begin_inset space ~
2593 \begin_layout Labeling
2594 \labelwidthstring 00.00.0000
2595 \begin_inset Flex Code
2598 \begin_layout Plain Layout
2604 If set, the converter's standard error will be redirected to a file
2605 \begin_inset Flex Code
2608 \begin_layout Plain Layout
2614 , and the script given as argument will be run as:
2615 \begin_inset Flex Code
2618 \begin_layout Plain Layout
2619 script < infile.out > infile.log
2625 The argument may contain
2626 \begin_inset Flex Code
2629 \begin_layout Plain Layout
2638 \begin_layout Labeling
2639 \labelwidthstring 00.00.0000
2640 \begin_inset Flex Code
2643 \begin_layout Plain Layout
2649 The name of the directory in which the converter will dump the generated
2652 will not create this directory, and it does not copy anything into it,
2653 though it will copy this directory to the destination.
2654 The argument may contain
2655 \begin_inset Flex Code
2658 \begin_layout Plain Layout
2664 , which will be replaced by the base name of the input and output files,
2665 respectively, when the directory is copied.
2666 \begin_inset Newline newline
2669 Note that resultdir and usetempdir make no sense together.
2670 The latter will be ignored if the former is given.
2673 \begin_layout Labeling
2674 \labelwidthstring 00.00.0000
2675 \begin_inset Flex Code
2678 \begin_layout Plain Layout
2684 Determines the output file name and may, contain
2685 \begin_inset Flex Code
2688 \begin_layout Plain Layout
2695 Sensible only with resultdir and optional even then; if not given, it defaults
2699 \begin_layout Standard
2700 None of these last three are presently used in any of the converters that
2701 are installed with \SpecialChar LyX
2706 \begin_layout Standard
2707 You do not have to define converters for all formats between which you want
2709 For example, you will note that there is no `\SpecialChar LyX
2710 to PostScript' converter,
2711 but \SpecialChar LyX
2712 will export PostScript.
2713 It does so by first creating a \SpecialChar LaTeX
2714 file (no converter needs to be defined
2715 for this) which is then converted to DVI using the `\SpecialChar LaTeX
2717 and finally converting the resulting DVI file to PostScript.
2719 finds such `chains' of converters automatically, and it will always choose
2720 the shortest possible chain.
2721 You can, though, still define multiple conversion methods between file
2723 For example, the standard \SpecialChar LyX
2724 configuration provides five ways to convert
2729 \begin_layout Enumerate
2731 \begin_inset Flex MenuItem
2734 \begin_layout Plain Layout
2743 \begin_layout Enumerate
2744 via (DVI and) PostScript, using
2745 \begin_inset Flex MenuItem
2748 \begin_layout Plain Layout
2757 \begin_layout Enumerate
2759 \begin_inset Flex MenuItem
2762 \begin_layout Plain Layout
2771 \begin_layout Enumerate
2773 \begin_inset Flex MenuItem
2776 \begin_layout Plain Layout
2786 \begin_layout Enumerate
2788 \begin_inset Flex MenuItem
2791 \begin_layout Plain Layout
2801 \begin_layout Standard
2802 To define such alternate chains, you must define multiple target `file formats',
2804 \begin_inset CommandInset ref
2806 reference "sec:Formats"
2811 For example, in the standard configuration, the formats named
2812 \begin_inset Flex MenuItem
2815 \begin_layout Plain Layout
2822 \begin_inset Flex MenuItem
2825 \begin_layout Plain Layout
2832 \begin_inset Flex MenuItem
2835 \begin_layout Plain Layout
2842 \begin_inset Flex MenuItem
2845 \begin_layout Plain Layout
2852 \begin_inset Flex MenuItem
2855 \begin_layout Plain Layout
2862 \begin_inset Flex MenuItem
2865 \begin_layout Plain Layout
2872 \begin_inset Flex MenuItem
2875 \begin_layout Plain Layout
2882 \begin_inset Flex MenuItem
2885 \begin_layout Plain Layout
2893 \begin_inset Flex MenuItem
2896 \begin_layout Plain Layout
2903 \begin_inset Flex MenuItem
2906 \begin_layout Plain Layout
2913 ) are defined, all of which share the extension
2914 \begin_inset Flex MenuItem
2917 \begin_layout Plain Layout
2923 , and which correspond to the conversion methods just mentioned.
2926 \begin_layout Chapter
2927 Internationalizing \SpecialChar LyX
2929 \begin_inset CommandInset label
2931 name "cha:Internationalizing-LyX"
2938 \begin_layout Standard
2940 supports using a translated interface.
2941 Last time we checked, \SpecialChar LyX
2942 provided text in thirty languages.
2943 The language of choice is called your
2948 (For further reading on locale settings, see also the documentation for
2949 locale that comes with your operating system.
2950 For Linux, the manual page for
2951 \begin_inset Flex Code
2954 \begin_layout Plain Layout
2960 could be a good place to start).
2963 \begin_layout Standard
2964 Notice that these translations will work, but do contain a few flaws.
2965 In particular, all dialogs have been designed with the English text in
2966 mind, which means that some of the translated text will be too large to
2967 fit within the space allocated.
2968 This is only a display problem and will not cause any harm.
2969 Also, you will find that some of the translations do not define shortcut
2970 keys for everything.
2971 Sometimes, there are simply not enough free letters to do it.
2972 Other times, the translator just hasn't got around to doing it yet.
2973 Our localization team, which you may wish to join,
2977 \begin_layout Plain Layout
2978 If you are a fluent speaker of a language other than English, joining these
2979 teams is a great way to give back to the \SpecialChar LyX
2985 will of course try to fix these shortcomings in future versions of \SpecialChar LyX
2989 \begin_layout Section
2990 Translating \SpecialChar LyX
2994 \begin_layout Subsection
2995 Translating the graphical user interface (text messages).
2998 \begin_layout Standard
3001 \begin_inset Flex Code
3004 \begin_layout Plain Layout
3010 library to handle the internationalization of the interface.
3011 To have \SpecialChar LyX
3012 speak your favorite language in all menus and dialogs, you need
3014 \begin_inset Flex Code
3017 \begin_layout Plain Layout
3023 -file for that language.
3024 When this is available, you'll have to generate a
3025 \begin_inset Flex Code
3028 \begin_layout Plain Layout
3034 -file from it and install the
3035 \begin_inset Flex Code
3038 \begin_layout Plain Layout
3045 The process of doing all of this is explained in the documentation for
3047 \begin_inset Flex Code
3050 \begin_layout Plain Layout
3057 It is possible to do this just for yourself, but if you're going to do
3058 it, you might as well share the results of your labors with the rest of
3059 the \SpecialChar LyX
3061 Send a message to the \SpecialChar LyX
3062 developers' list for more information about how
3066 \begin_layout Standard
3067 In short, this is what you should do (xx denotes the language code):
3070 \begin_layout Itemize
3071 Check out the \SpecialChar LyX
3074 \begin_inset CommandInset href
3076 name "information on the web"
3077 target "http://www.lyx.org/HowToUseSVN"
3084 \begin_layout Itemize
3086 \begin_inset Flex Code
3089 \begin_layout Plain Layout
3095 to the folder of the
3096 \begin_inset Flex Code
3099 \begin_layout Plain Layout
3107 \begin_inset Flex Code
3110 \begin_layout Plain Layout
3118 \begin_inset Flex Code
3121 \begin_layout Plain Layout
3127 doesn't exist anywhere, it can be remade with the console command
3128 \begin_inset Flex Code
3131 \begin_layout Plain Layout
3137 in that directory, or you can use an existing po-file for some other language
3141 \begin_layout Itemize
3143 \begin_inset Flex Code
3146 \begin_layout Plain Layout
3156 \begin_layout Plain Layout
3157 This is just a text file, so it can be edited in any text editor.
3158 But there are also specialized programs that support such editing, such
3163 (for all platforms) or
3172 contains a `mode' for editing
3173 \begin_inset Flex Code
3176 \begin_layout Plain Layout
3187 For some menu- and widget-labels, there are also shortcut keys that should
3189 Those keys are marked after a `|', and should be translated according to
3190 the words and phrases of the language.
3191 You should also fill also out the information at the beginning of the new
3193 \begin_inset Flex Code
3196 \begin_layout Plain Layout
3202 -file with your email-address, etc., so people know where to reach you with
3203 suggestions and entertaining flames.
3206 \begin_layout Standard
3207 If you are just doing this on your own, then:
3210 \begin_layout Itemize
3212 \begin_inset Flex Code
3215 \begin_layout Plain Layout
3222 This can be done with
3223 \begin_inset Flex Code
3226 \begin_layout Plain Layout
3227 msgfmt -o xx.mo < xx.po
3235 \begin_layout Itemize
3237 \begin_inset Flex Code
3240 \begin_layout Plain Layout
3246 -file to your locale-tree, at the correct directory for application messages
3251 xx, and under the name
3252 \begin_inset Flex Code
3255 \begin_layout Plain Layout
3262 \begin_inset space \thinspace{}
3266 \begin_inset space \space{}
3270 \begin_inset Flex Code
3273 \begin_layout Plain Layout
3274 /usr/local/share/locale/xx/LC_MESSAGES/lyx.mo
3284 \begin_layout Standard
3285 As said, however, it would be best if the new
3286 \begin_inset Flex Code
3289 \begin_layout Plain Layout
3296 \change_inserted -712698321 1437634626
3298 \change_deleted -712698321 1437634624
3301 file could be added to the \SpecialChar LyX
3302 distribution, so others can use it.
3303 Adding it involves making additional changes to \SpecialChar LyX
3305 So send an email to the developers' mailing list if you're interested in
3309 \begin_layout Subsubsection
3313 \begin_layout Standard
3314 Sometimes it turns out that one English message needs to be translated into
3315 different messages in the target language.
3316 One example is the message
3317 \begin_inset Flex Code
3320 \begin_layout Plain Layout
3326 which has the German translation
3334 , depending upon exactly what the English
3335 \begin_inset Quotes eld
3339 \begin_inset Quotes erd
3344 \begin_inset Flex Code
3347 \begin_layout Plain Layout
3353 does not handle such ambiguous translations.
3354 Therefore you have to add some context information to the message: Instead
3356 \begin_inset Flex Code
3359 \begin_layout Plain Layout
3366 \begin_inset Flex Code
3369 \begin_layout Plain Layout
3370 To[[as in 'From format x to format y']]
3376 \begin_inset Flex Code
3379 \begin_layout Plain Layout
3380 To[[as in 'From page x to page y']].
3385 Now the two occurrences of
3386 \begin_inset Flex Code
3389 \begin_layout Plain Layout
3396 \begin_inset Flex Code
3399 \begin_layout Plain Layout
3405 and can be translated correctly to
3416 \begin_layout Standard
3417 Of course the context information needs to be stripped off the original
3418 message when no translation is used.
3419 Therefore you have to put it in double square brackets at the end of the
3420 message (see the example above).
3421 The translation mechanism of \SpecialChar LyX
3422 ensures that everything in double square
3423 brackets at the end of messages is removed before displaying the message.
3426 \begin_layout Subsection
3427 Translating the documentation.
3430 \begin_layout Standard
3431 The online documentation (in the
3432 \begin_inset Flex MenuItem
3435 \begin_layout Plain Layout
3441 -menu) can (and should!) be translated.
3442 If there are translated versions of the documentation available
3446 \begin_layout Plain Layout
3447 As of March 2008, at least some of the documents have been translated into
3448 fourteen languages, with the Tutorial available in a few more.
3453 and the locale is set accordingly, these will be used automagically by
3457 looks for translated versions as
3458 \begin_inset Flex Code
3461 \begin_layout Plain Layout
3463 \change_deleted -712698321 1437634637
3466 \change_inserted -712698321 1437634639
3469 Dir/doc/xx/DocName.lyx
3475 \begin_inset Flex Code
3478 \begin_layout Plain Layout
3484 is the code for the language currently in use.
3485 If there are no translated documents, the default English versions will
3487 Note that the translated versions must have the same filenames (
3488 \begin_inset Flex Code
3491 \begin_layout Plain Layout
3497 above) as the original.
3498 If you feel up to translating the documentation (an excellent way to proof-read
3499 the original documentation by the way!), there are a few things you should
3503 \begin_layout Itemize
3504 Check out the documentation translation web page at
3505 \begin_inset CommandInset href
3507 name "http://www.lyx.org/Translation"
3508 target "http://www.lyx.org/Translation"
3513 That way, you can find out which (if any) documents have already been translate
3514 d into your language.
3515 You can also find out who (if anyone) is organizing the effort to translate
3516 the documentation into your language.
3517 If no one is organizing the effort, please let us know that you're interested.
3520 \begin_layout Standard
3521 Once you get to actually translating, here's a few hints for you that may
3525 \begin_layout Itemize
3526 Join the documentation team! There is information on how to do that in
3527 \begin_inset Flex Code
3530 \begin_layout Plain Layout
3537 \begin_inset Flex MenuItem
3540 \begin_layout Plain Layout
3541 Help\SpecialChar menuseparator
3547 ), which by the way is the first document you should translate.
3550 \begin_layout Itemize
3551 Learn the typographic conventions for the language you are translating to.
3552 Typography is an ancient art and over the centuries, a great variety of
3553 conventions have developed throughout different parts of the world.
3554 Also study the professional terminology amongst typographers in your country.
3555 Inventing your own terminology will only confuse the users.
3558 (Warning! Typography is addictive!)
3561 \begin_layout Itemize
3562 Make a copy of the document.
3563 This will be your working copy.
3564 You can use this as your personal translated help-file by placing it in
3566 \begin_inset Flex Code
3569 \begin_layout Plain Layout
3578 \begin_layout Itemize
3579 Sometimes the original document (from the \SpecialChar LyX
3581 \change_inserted -712698321 1437634643
3583 \change_deleted -712698321 1437634643
3586 team) will be updated.
3587 Use the source viewer at
3588 \begin_inset CommandInset href
3590 name "http://www.lyx.org/trac/timeline"
3591 target "http://www.lyx.org/trac/timeline"
3595 to see what has been changed.
3596 That way you can easily see which parts of the translated document need
3600 \begin_layout Standard
3601 If you ever find an error in the original document, fix it and notify the
3602 rest of the documentation team of the changes! (You didn't forget to join
3603 the documentation team, did you?)
3606 \begin_layout Standard
3607 \begin_inset Branch OutDated
3610 \begin_layout Section
3611 International Keyboard Support
3614 \begin_layout Standard
3617 [Editor's Note: The following section is by
3625 It needs to be fixed to conform to the new Documentation Style sheet and
3626 to make use of the new v1.0 features.
3627 The whole thing also needs to be merged with the section following it.-jw
3628 It may also be badly out of date.-rh (2008)]
3631 \begin_layout Subsection
3632 Defining Own Keymaps: Keymap File Format
3635 \begin_layout Standard
3636 Let's look at a keyboard definition file a little closer.
3637 It is a plain text file defining
3640 \begin_layout Itemize
3641 key-to-key or key-to-string translations
3644 \begin_layout Itemize
3648 \begin_layout Itemize
3649 dead keys exceptions
3652 \begin_layout Standard
3653 To define key-to-key or key-to-string translation, use this command:
3656 \begin_layout Quotation
3657 \begin_inset Flex Code
3660 \begin_layout Plain Layout
3669 \begin_inset Flex Code
3672 \begin_layout Plain Layout
3681 \begin_layout Standard
3683 \begin_inset Flex Code
3686 \begin_layout Plain Layout
3692 is the key to be translated and
3693 \begin_inset Flex Code
3696 \begin_layout Plain Layout
3702 is the string to be inserted into the document.
3703 To define dead keys, use:
3706 \begin_layout Quotation
3707 \begin_inset Flex Code
3710 \begin_layout Plain Layout
3719 \begin_inset Flex Code
3722 \begin_layout Plain Layout
3731 \begin_layout Standard
3733 \begin_inset Flex Code
3736 \begin_layout Plain Layout
3742 is a keyboard key and
3743 \begin_inset Flex Code
3746 \begin_layout Plain Layout
3753 The following dead keys are supported (shortcut name is in parentheses):
3756 \begin_layout Quotation
3760 \begin_inset space \hfill{}
3766 \begin_layout Quotation
3768 \begin_inset space \hfill{}
3774 \begin_layout Quotation
3776 \begin_inset space \hfill{}
3782 \begin_layout Quotation
3784 \begin_inset space \hfill{}
3790 \begin_layout Quotation
3792 \begin_inset space \hfill{}
3798 \begin_layout Quotation
3800 \begin_inset space \hfill{}
3807 \begin_layout Plain Layout
3819 \begin_layout Quotation
3821 \begin_inset space \hfill{}
3827 \begin_layout Quotation
3829 \begin_inset space \hfill{}
3836 \begin_layout Plain Layout
3848 \begin_layout Quotation
3850 \begin_inset space \hfill{}
3856 \begin_layout Quotation
3858 \begin_inset space \hfill{}
3864 \begin_layout Quotation
3866 \begin_inset space \hfill{}
3873 \begin_layout Plain Layout
3885 \begin_layout Quotation
3887 \begin_inset space \hfill{}
3894 \begin_layout Plain Layout
3906 \begin_layout Quotation
3908 \begin_inset space \hfill{}
3914 \begin_layout Quotation
3915 hungarian umlaut (hug)
3916 \begin_inset space \hfill{}
3922 \begin_layout Quotation
3924 \begin_inset space \hfill{}
3930 \begin_layout Quotation
3932 \begin_inset space \hfill{}
3939 \begin_layout Plain Layout
3951 \begin_layout Standard
3952 Since in many international keyboards there are exceptions to what some
3953 dead keys should do, you can define them using
3956 \begin_layout Quotation
3957 \begin_inset Flex Code
3960 \begin_layout Plain Layout
3968 deadkey key outstring
3971 \begin_layout Standard
3972 For example, on Slovak keyboard, if you enter caron-o, it generates circumflex-o
3976 \begin_layout Quotation
3977 \begin_inset Flex Code
3980 \begin_layout Plain Layout
3993 \begin_layout Standard
3994 to make it work correctly.
3995 Also, you have to define as exceptions dead keys over i and j, to remove
3996 the dot from them before inserting an accent mark.
3997 I will change this when the time comes, but so far I haven't had time.
4000 \begin_layout Standard
4001 Oh, and about characters: backslash is escaped, so to enter it, you'll need
4004 \begin_inset Flex Code
4007 \begin_layout Plain Layout
4013 have different meaning.
4015 \begin_inset Flex Code
4018 \begin_layout Plain Layout
4024 marks comments, quotes start and end \SpecialChar LaTeX
4026 To enter quote, you'll need to use
4027 \begin_inset Flex Code
4030 \begin_layout Plain Layout
4039 \begin_inset Flex Code
4042 \begin_layout Plain Layout
4049 \begin_inset Flex Code
4052 \begin_layout Plain Layout
4063 \begin_layout Standard
4064 If you make a keyboard description file that works for your language, please
4065 mail it to me, so I can include it in the next keymap distribution.
4068 \begin_layout Standard
4069 More keywords will be supported in keymap configuration file in future,
4073 \begin_layout Itemize
4074 \begin_inset Flex Code
4077 \begin_layout Plain Layout
4088 \begin_inset space \hfill{}
4092 \begin_inset Flex Code
4095 \begin_layout Plain Layout
4104 \begin_layout Itemize
4105 \begin_inset Flex Code
4108 \begin_layout Plain Layout
4119 \begin_inset space \hfill{}
4123 \begin_inset Flex Code
4126 \begin_layout Plain Layout
4132 an external keymap translation program
4135 \begin_layout Standard
4136 Also, it should look into
4137 \begin_inset Flex Code
4140 \begin_layout Plain Layout
4146 file for defaults, too (for example, a
4147 \begin_inset Flex Code
4150 \begin_layout Plain Layout
4158 option to include default keyboard).
4166 \begin_layout Section
4167 International Keymap Stuff
4168 \begin_inset CommandInset label
4170 name "sec:International-Keymap-Stuff"
4177 \begin_layout Standard
4178 \begin_inset Note Note
4181 \begin_layout Plain Layout
4182 In doing the revisions on this document in March 2008, I did not look over
4183 this stuff, as I do not understand it.
4184 It would be good if someone else could do so.
4193 \begin_layout Standard
4194 The next two sections describe the
4195 \begin_inset Flex Code
4198 \begin_layout Plain Layout
4207 \begin_inset Flex Code
4210 \begin_layout Plain Layout
4218 file syntax in detail.
4219 These sections should help you design your own key map if the ones provided
4220 do not meet your needs.
4223 \begin_layout Subsection
4227 \begin_layout Standard
4231 \begin_inset Flex Code
4234 \begin_layout Plain Layout
4240 file maps keystrokes to characters or strings.
4241 As the name suggests, it sets a keyboard mapping.
4243 \begin_inset Flex Code
4246 \begin_layout Plain Layout
4257 \begin_inset Flex Code
4260 \begin_layout Plain Layout
4275 \begin_inset Flex Code
4278 \begin_layout Plain Layout
4291 \begin_inset Flex Code
4294 \begin_layout Plain Layout
4303 \begin_inset Flex Code
4306 \begin_layout Plain Layout
4314 are described in this section.
4317 \begin_layout Labeling
4318 \labelwidthstring 00.00.0000
4319 \begin_inset Flex Code
4322 \begin_layout Plain Layout
4330 Map a character to a string
4333 \begin_layout LyX-Code
4348 \begin_layout Standard
4381 the double-quote (")
4398 must be escaped with a preceding backslash (
4409 \begin_layout Standard
4411 \begin_inset Flex MenuItem
4414 \begin_layout Plain Layout
4422 statement to cause the symbol
4423 \begin_inset Flex MenuItem
4426 \begin_layout Plain Layout
4434 to be output for the keystroke
4435 \begin_inset Flex MenuItem
4438 \begin_layout Plain Layout
4449 \begin_layout LyX-Code
4455 \begin_layout Labeling
4456 \labelwidthstring 00.00.0000
4457 \begin_inset Flex Code
4460 \begin_layout Plain Layout
4468 Specify an accent character
4471 \begin_layout LyX-Code
4480 \begin_layout Standard
4481 This will make the cha
4519 This is the dead key
4523 \begin_layout Plain Layout
4530 refers to a key that does not produce a character by itself, but when followed
4531 with another key, produces the desired accent character.
4532 For example, a German characte
4534 r with an umlaut like
4544 can be produced in this manner.
4553 \begin_layout Standard
4566 and then another key not in
4583 followed by the other, not allowed key, as output.
4587 \begin_inset Flex MenuItem
4590 \begin_layout Plain Layout
4598 cancels a dead key, so if
4609 \begin_inset Flex MenuItem
4612 \begin_layout Plain Layout
4621 , the cursor will not go one position backwards but will instead cancel
4637 might have had on the next keystroke.
4641 \begin_layout Standard
4642 The following example specifies that the character ' is to be an acute accent,
4643 allowed on the characters a, e, i, o, u, A, E, I, O, and U:
4646 \begin_layout LyX-Code
4649 kmod ' acute aeiouAEIOU
4652 \begin_layout Labeling
4653 \labelwidthstring 00.00.0000
4654 \begin_inset Flex Code
4657 \begin_layout Plain Layout
4663 Specify an exception to the accent character
4666 \begin_layout LyX-Code
4675 \begin_layout Standard
4676 This defines an exce
4717 have been assigned a keystroke with a previous
4720 \begin_inset Flex Code
4723 \begin_layout Plain Layout
4747 must not belong in the
4794 If such a declaration does not exist in
4802 \begin_inset Flex Code
4805 \begin_layout Plain Layout
4839 \begin_inset Flex Code
4842 \begin_layout Plain Layout
4856 \begin_layout Standard
4857 The following command produces causes äi to be produced when you enter acute-i
4861 \begin_layout LyX-Code
4875 \begin_layout Labeling
4876 \labelwidthstring 00.00.0000
4877 \begin_inset Flex Code
4880 \begin_layout Plain Layout
4886 Combine two accent characters
4889 \begin_layout LyX-Code
4895 accent1 accent2 allowed
4898 \begin_layout Standard
4899 This one is getting pretty esoteric.
4900 It allows you to combine the effect
4956 \begin_inset Flex Code
4959 \begin_layout Plain Layout
4987 \begin_layout Standard
4988 Consider this example from the
4989 \begin_inset Flex Code
4992 \begin_layout Plain Layout
5003 \begin_layout LyX-Code
5006 kmod ; acute aeioyvhAEIOYVH
5010 kcomb acute umlaut iyIY
5013 \begin_layout Standard
5014 This allows you to press
5015 \begin_inset Flex MenuItem
5018 \begin_layout Plain Layout
5026 and get the effect of
5027 \begin_inset Flex Code
5030 \begin_layout Plain Layout
5049 in this case cancels the last dead key, so if you press
5050 \begin_inset Flex MenuItem
5053 \begin_layout Plain Layout
5062 \begin_inset Flex Code
5065 \begin_layout Plain Layout
5078 \begin_layout Subsection
5082 \begin_layout Standard
5084 \begin_inset Flex Code
5087 \begin_layout Plain Layout
5095 mapping is performed, a
5096 \begin_inset Flex Code
5099 \begin_layout Plain Layout
5109 file maps the strings that the symbols generate to characters in the current
5111 The \SpecialChar LyX
5112 distribution currently includes at least the
5113 \begin_inset Flex Code
5116 \begin_layout Plain Layout
5125 \begin_inset Flex Code
5128 \begin_layout Plain Layout
5139 \begin_layout Standard
5141 \begin_inset Flex Code
5144 \begin_layout Plain Layout
5152 file is a sequence of declarations of the form
5155 \begin_layout LyX-Code
5168 \begin_layout Standard
5169 For example, in order to map
5170 \begin_inset Flex MenuItem
5173 \begin_layout Plain Layout
5183 to the corresponding character in the iso-8859-1 set (233), the following
5187 \begin_layout LyX-Code
5195 \begin_layout Standard
5197 \begin_inset Flex Code
5200 \begin_layout Plain Layout
5209 \begin_inset Flex Code
5212 \begin_layout Plain Layout
5230 the same character can apply to more than one string.
5232 \begin_inset Flex Code
5235 \begin_layout Plain Layout
5246 \begin_layout LyX-Code
5258 \begin_inset Newline newline
5274 \begin_layout Standard
5276 cannot find a mapping for the string produced by the keystroke or a
5277 deadkey sequence, it will check if it looks like an accented char and try
5278 to draw an accent over the character on screen.
5281 \begin_layout Subsection
5285 \begin_layout Standard
5286 There is a second way to add support for international characters through
5287 so-called dead-keys.
5288 A dead-key works in combination with a letter to produce an accented character.
5289 Here, we'll explain how to create a really simple dead-key to illustrate
5293 \begin_layout Standard
5294 Suppose you happen to need the circumflex character,
5295 \begin_inset Quotes eld
5299 \begin_inset Quotes erd
5304 \begin_inset Flex MenuItem
5307 \begin_layout Plain Layout
5314 \begin_inset space ~
5318 \begin_inset Flex MenuItem
5321 \begin_layout Plain Layout
5327 ] to the \SpecialChar LyX
5329 \begin_inset Flex Code
5332 \begin_layout Plain Layout
5339 \begin_inset Flex Code
5342 \begin_layout Plain Layout
5349 Now, whenever you type the
5350 \begin_inset Flex MenuItem
5353 \begin_layout Plain Layout
5359 -key followed by a letter, that letter will have a circumflex accent on
5361 For example, the sequence
5362 \begin_inset Quotes eld
5366 \begin_inset Flex MenuItem
5369 \begin_layout Plain Layout
5376 \begin_inset Quotes erd
5379 produces the letter:
5380 \begin_inset Quotes eld
5384 \begin_inset Quotes erd
5388 If you tried to type
5389 \begin_inset Quotes eld
5393 \begin_inset Flex MenuItem
5396 \begin_layout Plain Layout
5403 \begin_inset Quotes erd
5406 , however, \SpecialChar LyX
5407 will complain with a beep, since a
5408 \begin_inset Quotes eld
5412 \begin_inset Flex MenuItem
5415 \begin_layout Plain Layout
5422 \begin_inset Quotes erd
5425 never takes a circumflex accent.
5427 \begin_inset Flex MenuItem
5430 \begin_layout Plain Layout
5436 after a dead-key produces the bare-accent.
5437 Please note this last point! If you bind a key to a dead-key, you'll need
5438 to rebind the character on that key to yet another key.
5440 \begin_inset Flex MenuItem
5443 \begin_layout Plain Layout
5449 to a cedilla is a bad idea, since you'll only get cedillas instead of commas.
5452 \begin_layout Standard
5453 One common way to bind dead-keys is to use
5454 \begin_inset Flex MenuItem
5457 \begin_layout Plain Layout
5464 \begin_inset Flex MenuItem
5467 \begin_layout Plain Layout
5474 \begin_inset Flex MenuItem
5477 \begin_layout Plain Layout
5483 in combination with an accent, like
5484 \begin_inset Quotes eld
5488 \begin_inset Flex MenuItem
5491 \begin_layout Plain Layout
5498 \begin_inset Quotes erd
5502 \begin_inset Quotes eld
5506 \begin_inset Flex MenuItem
5509 \begin_layout Plain Layout
5516 \begin_inset Quotes erd
5520 \begin_inset Quotes eld
5524 \begin_inset Flex MenuItem
5527 \begin_layout Plain Layout
5534 \begin_inset Quotes erd
5538 Another way involves using
5539 \begin_inset Flex Code
5542 \begin_layout Plain Layout
5549 \begin_inset Flex Code
5552 \begin_layout Plain Layout
5558 to set up the special
5559 \begin_inset Flex Code
5562 \begin_layout Plain Layout
5570 \begin_inset Flex Code
5573 \begin_layout Plain Layout
5579 acts in some ways just like
5580 \begin_inset Flex MenuItem
5583 \begin_layout Plain Layout
5589 and permits you to bind keys to accented characters.
5590 You can also turn keys into dead-keys by binding them to something like
5592 \begin_inset Flex Code
5595 \begin_layout Plain Layout
5601 and then binding this symbolic key to the corresponding \SpecialChar LyX
5606 \begin_layout Plain Layout
5611 : This is exactly what I do in my
5612 \begin_inset Flex Code
5615 \begin_layout Plain Layout
5622 \begin_inset Flex Code
5625 \begin_layout Plain Layout
5633 \begin_inset Flex MenuItem
5636 \begin_layout Plain Layout
5638 \begin_inset space ~
5647 \begin_inset Flex Code
5650 \begin_layout Plain Layout
5656 and a bunch of these
5657 \begin_inset Quotes eld
5661 \begin_inset Flex Code
5664 \begin_layout Plain Layout
5671 \begin_inset Quotes erd
5674 symbolic keys bound such things as
5675 \begin_inset Flex MenuItem
5678 \begin_layout Plain Layout
5680 \begin_inset space ~
5689 \begin_inset Flex MenuItem
5692 \begin_layout Plain Layout
5694 \begin_inset space ~
5703 This is how I produce my accented characters.
5708 You can make just about anything into the
5709 \begin_inset Flex Code
5712 \begin_layout Plain Layout
5719 \begin_inset Flex MenuItem
5722 \begin_layout Plain Layout
5728 keys, a spare function key, etc.
5729 As for the \SpecialChar LyX
5730 commands that produce accents, check the entry for
5731 \begin_inset Flex Code
5734 \begin_layout Plain Layout
5745 You'll find the complete list there.
5748 \begin_layout Subsection
5749 Saving your Language Configuration
5752 \begin_layout Standard
5753 You can edit your preferences so that your desired language environment
5754 is automatically configured when \SpecialChar LyX
5756 \begin_inset Flex MenuItem
5759 \begin_layout Plain Layout
5760 Edit\SpecialChar menuseparator
5769 \begin_layout Chapter
5770 Installing New Document Classes, Layouts, and Templates
5771 \begin_inset CommandInset label
5773 name "cha:Installing-New-Document"
5778 \begin_inset Argument 1
5781 \begin_layout Plain Layout
5782 Installing New Document Classes
5790 \begin_layout Standard
5791 In this chapter, we describe the procedures for creating and installing
5792 new \SpecialChar LyX
5793 layout and template files, as well as offer a refresher on correctly
5794 installing new \SpecialChar LaTeX
5799 \begin_layout Standard
5800 First, let us a say a few words about how one ought to think about the relation
5801 between \SpecialChar LyX
5802 and \SpecialChar LaTeX
5804 The thing to understand is that, in a certain sense, \SpecialChar LyX
5805 doesn't know anything
5806 about \SpecialChar LaTeX
5808 Indeed, from \SpecialChar LyX
5809 's point of view, \SpecialChar LaTeX
5810 is just one of several
5811 \begin_inset Quotes eld
5815 \begin_inset Quotes erd
5818 in which it is capable of producing output.
5819 Other such formats are DocBook, plaintext, and XHTML.
5821 is, of course, a particularly important format, but very little of the
5822 information \SpecialChar LyX
5823 has about \SpecialChar LaTeX
5824 is actually contained in the program itself.
5828 \begin_layout Plain Layout
5829 Some commands are sufficiently complex that they are
5830 \begin_inset Quotes eld
5834 \begin_inset Quotes erd
5837 into \SpecialChar LyX
5839 But the developers generally regard this as a Bad Thing.
5844 Rather, that information, even for the standard classes like
5845 \begin_inset Flex Code
5848 \begin_layout Plain Layout
5854 , is contained in `layout files'.
5855 Similarly, \SpecialChar LyX
5856 itself does not know much about DocBook or XHTML.
5857 What it knows is contained in layout files.
5860 \begin_layout Standard
5861 You can think of the layout file for a given document class as a translation
5862 manual between \SpecialChar LyX
5863 constructs—paragraphs with their corresponding styles,
5864 certain sorts of insets, etc—and the corresponding \SpecialChar LaTeX
5867 Almost everything \SpecialChar LyX
5869 \begin_inset Flex Code
5872 \begin_layout Plain Layout
5878 , for example, is contained in the file
5879 \begin_inset Flex Code
5882 \begin_layout Plain Layout
5888 and in various other files it includes.
5889 For this reason, anyone intending to write layout files should plan to
5890 study the existing files.
5891 A good place to start is with
5892 \begin_inset Flex Code
5895 \begin_layout Plain Layout
5901 , which is included in
5902 \begin_inset Flex Code
5905 \begin_layout Plain Layout
5912 \begin_inset Flex Code
5915 \begin_layout Plain Layout
5921 , and many of the other layout files for document classes.
5922 This file is where sections and the like are defined:
5923 \begin_inset Flex Code
5926 \begin_layout Plain Layout
5932 tells \SpecialChar LyX
5933 how paragraphs that are marked with the Section, Subsection, etc,
5934 styles can be translated into corresponding \SpecialChar LaTeX
5935 , DocBook, and XHTML commands
5938 \begin_inset Flex Code
5941 \begin_layout Plain Layout
5947 file basically just includes several of these
5948 \begin_inset Flex Code
5951 \begin_layout Plain Layout
5960 \begin_layout Standard
5961 Defining the \SpecialChar LyX
5963 correspondence is not the only thing layout files do, though.
5964 Their other job is to define how the \SpecialChar LyX
5965 constructs themselves will appear
5967 The fact that layout files have these two jobs is often a source of confusion,
5968 because they are completely separate.
5969 Telling \SpecialChar LyX
5970 how to translate a certain paragraph style into \SpecialChar LaTeX
5973 how to display it; conversely, telling \SpecialChar LyX
5974 how to display a certain paragraph
5975 style does not tell \SpecialChar LyX
5976 how to translate it into \SpecialChar LaTeX
5977 (let alone tell \SpecialChar LaTeX
5980 So, in general, when you define a new \SpecialChar LyX
5981 construct, you must always do two
5982 quite separate things: (i)
5983 \begin_inset space ~
5986 tell \SpecialChar LyX
5987 how to translate it into \SpecialChar LaTeX
5989 \begin_inset space ~
5992 tell \SpecialChar LyX
5996 \begin_layout Standard
5997 Much the same is true, of course, as regards \SpecialChar LyX
5998 's other backend formats, though
5999 XHTML is in some ways different, because in that case \SpecialChar LyX
6004 able, to some extent, to use information about how it should display a
6005 paragraph on the screen to output information (in the form of CSS) about
6006 how the paragraph should be displayed in a browser.
6007 Even in this case, however, the distinction between what \SpecialChar LyX
6009 and how things are rendered externally remains in force, and the two can
6010 be controlled separately.
6012 \begin_inset CommandInset ref
6014 reference "sec:Tags-for-XHTML"
6021 \begin_layout Section
6022 Installing new \SpecialChar LaTeX
6026 \begin_layout Standard
6027 Some installations may not include a \SpecialChar LaTeX
6028 package or class file that you would
6029 like to use within \SpecialChar LyX
6031 For example, you might need Foil\SpecialChar TeX
6032 , a package for preparing slides for overhead
6034 Modern \SpecialChar LaTeX
6035 distributions like \SpecialChar TeX
6036 Live (2008 or newer) or MiK\SpecialChar TeX
6037 provide a user interface
6038 for installing such packages.
6039 For example, with MiK\SpecialChar TeX
6040 , you start the program
6041 \begin_inset Quotes eld
6045 \begin_inset space ~
6049 \begin_inset Quotes erd
6052 to get a list of available packages.
6053 To install one of them, right click on it or use the corresponding toolbar
6057 \begin_layout Standard
6058 If your \SpecialChar LaTeX
6059 distribution does not provide such a `package manager', or if the
6060 package is not available from your distribution, then follow these steps
6061 to install it manually:
6064 \begin_layout Enumerate
6065 Get the package from
6066 \begin_inset CommandInset href
6069 target "http://www.ctan.org/"
6076 \begin_layout Enumerate
6077 If the package contains a file with the ending
6078 \begin_inset Quotes eld
6082 \begin_inset Flex Code
6085 \begin_layout Plain Layout
6092 \begin_inset Quotes erd
6095 (is the case for Foil\SpecialChar TeX
6096 ) then open a console, change to the folder of this
6097 file and execute the command
6098 \begin_inset Flex Code
6101 \begin_layout Plain Layout
6108 You have now unpacked the package and have all files to install it.
6109 Most \SpecialChar LaTeX
6110 -packages are not packed and you can skip this step.
6113 \begin_layout Enumerate
6114 Now you need to decide if the package should be available for all users
6116 \begin_inset Separator parbreak
6123 \begin_layout Enumerate
6124 On *nix systems (Linux, OSX, etc.), if you want the new package to be available
6125 for all users on your system, then install it in your `local' \SpecialChar TeX
6127 install it in your own `user' \SpecialChar TeX
6129 Where these trees should be created, if they do not already exist, depends
6131 To find this out, look in the file
6132 \begin_inset Flex Code
6135 \begin_layout Plain Layout
6145 \begin_layout Plain Layout
6146 This is usually in the directory
6147 \begin_inset Flex Code
6150 \begin_layout Plain Layout
6156 , though you can execute the command
6157 \begin_inset Flex Code
6160 \begin_layout Plain Layout
6171 The location of the `local' \SpecialChar TeX
6172 tree is defined by the
6173 \begin_inset Flex Code
6176 \begin_layout Plain Layout
6182 variable; this is usually somewhere like
6183 \begin_inset Flex Code
6186 \begin_layout Plain Layout
6187 /usr/local/share/texmf
6193 The location of the `user' \SpecialChar TeX
6195 \begin_inset Flex Code
6198 \begin_layout Plain Layout
6205 \begin_inset Flex Code
6208 \begin_layout Plain Layout
6215 (If these variables are not predefined, you have to define them.) You'll
6216 probably need root permissions to create or modify the `local' tree, but
6217 not for your `user' tree.
6218 \begin_inset Newline newline
6221 In general, it is recommended to install in the user tree because your user
6222 will not be modified or even overwritten when you upgrade your system.
6223 It will typically also be backed up together with everything else when
6224 you backup your home directory (which, of course, you do on a regular basis).
6227 \begin_layout Enumerate
6228 On Windows, if you want the new package to be available for all users on
6229 your system, change to the folder where \SpecialChar LaTeX
6230 is installed and then change to
6232 \begin_inset Flex Code
6235 \begin_layout Plain Layout
6246 (For MiK\SpecialChar TeX
6247 , this would be by default the folder
6248 \begin_inset Flex Code
6251 \begin_layout Plain Layout
6257 \change_deleted -712698321 1437634323
6260 \change_inserted -712698321 1437634327
6276 \begin_layout Plain Layout
6277 Note that this will be the correct path only on English installations.
6278 On a German one, it would be
6279 \begin_inset Flex Code
6282 \begin_layout Plain Layout
6288 \change_deleted -712698321 1437634336
6291 \change_inserted -712698321 1437634337
6303 , and similarly for other languages.
6308 Create there a new folder
6309 \begin_inset Flex Code
6312 \begin_layout Plain Layout
6318 and copy all files of the package into it.
6320 \begin_inset Newline newline
6323 If the package should only available for you or you don't have admin permissions
6324 , do the same, but in the local \SpecialChar LaTeX
6327 \begin_inset space \thinspace{}
6330 g., for MiK\SpecialChar TeX
6332 \begin_inset space ~
6335 2.8 under Windows XP, this would be the folder:
6336 \begin_inset Newline newline
6342 \begin_inset Flex Code
6345 \begin_layout Plain Layout
6348 Documents and Settings
6360 \begin_inset Newline newline
6366 \begin_inset Phantom HPhantom
6369 \begin_layout Plain Layout
6380 \begin_inset Flex Code
6383 \begin_layout Plain Layout
6385 \change_deleted -712698321 1437634345
6388 \change_inserted -712698321 1437634347
6403 \begin_inset Newline newline
6406 On Vista, it would be:
6407 \begin_inset Newline newline
6411 \begin_inset Flex Code
6414 \begin_layout Plain Layout
6428 \change_inserted -712698321 1437634351
6430 \change_deleted -712698321 1437634351
6447 \begin_layout Enumerate
6448 Now one only need to tell \SpecialChar LaTeX
6449 that there are new files.
6450 This depends on the used \SpecialChar LaTeX
6452 \begin_inset Separator parbreak
6459 \begin_layout Enumerate
6460 For \SpecialChar TeX
6461 Live execute the command
6462 \begin_inset Flex Code
6465 \begin_layout Plain Layout
6472 If you installed the package for all users, then you will probably need
6473 to have root permissions for that.
6476 \begin_layout Enumerate
6477 For MiK\SpecialChar TeX
6478 , if you have installed the package for all users, start the program
6480 \begin_inset Quotes eld
6484 \begin_inset space ~
6488 \begin_inset Quotes erd
6491 and press the button marked
6492 \begin_inset Quotes eld
6496 \begin_inset Quotes erd
6500 Otherwise start the program
6501 \begin_inset Quotes eld
6505 \begin_inset Quotes erd
6512 \begin_layout Enumerate
6513 Finally, you need to tell \SpecialChar LyX
6514 that there are new packages available.
6515 So, in \SpecialChar LyX
6517 \begin_inset Flex MenuItem
6520 \begin_layout Plain Layout
6523 \SpecialChar menuseparator
6529 and then restart \SpecialChar LyX
6533 \begin_layout Standard
6534 Now the package is installed.
6535 In our example, the document class
6536 \begin_inset Flex Code
6539 \begin_layout Plain Layout
6541 \begin_inset space ~
6545 \change_deleted -712698321 1437634694
6550 \begin_layout Plain Layout
6564 will now be available under
6565 \begin_inset Flex MenuItem
6568 \begin_layout Plain Layout
6569 Document\SpecialChar menuseparator
6570 Settings\SpecialChar menuseparator
6580 \begin_layout Standard
6581 If you would like to use a \SpecialChar LaTeX
6582 document class that is not even listed in the
6584 \begin_inset Flex MenuItem
6587 \begin_layout Plain Layout
6588 Document\SpecialChar menuseparator
6589 Settings\SpecialChar menuseparator
6595 , then you need to create a `layout' file for it.
6596 That is the topic of the next section.
6599 \begin_layout Section
6600 Types of layout files
6603 \begin_layout Standard
6604 This section describes the various sorts of \SpecialChar LyX
6605 files that contain layout informati
6607 These files describe various paragraph and character styles, determining
6608 how \SpecialChar LyX
6609 should display them and how they should be translated into \SpecialChar LaTeX
6611 XHTML, or whatever output format is being used.
6615 \begin_layout Standard
6616 We shall try to provide a thorough description of the process of writing
6618 However, there are so many different types of documents supported even
6619 by just \SpecialChar LaTeX
6620 that we can't hope to cover every different possibility or problem
6621 you might encounter.
6622 The \SpecialChar LyX
6623 users' list is frequented by people with lots of experience with layout
6624 design who are willing to share what they've learned, so please feel free
6625 to ask questions there.
6628 \begin_layout Standard
6629 As you prepare to write a new layout, it is extremely helpful to look at
6630 the layouts distributed with \SpecialChar LyX
6632 If you write a \SpecialChar LyX
6633 layout for a \SpecialChar LaTeX
6634 document class that might also be used by
6635 others, or write a module that might be useful to others, then you should
6636 consider posting your layout to the
6637 \begin_inset CommandInset href
6639 name "layout section on the LyX wiki"
6640 target "http://wiki.lyx.org/Layouts/Layouts"
6644 or even to the \SpecialChar LyX
6645 developers' list, so that it might be included in \SpecialChar LyX
6650 \begin_layout Plain Layout
6651 Note that \SpecialChar LyX
6652 is licensed under the General Public License, so any material
6653 that is contributed to \SpecialChar LyX
6654 must be similarly licensed.
6662 \begin_layout Subsection
6664 \begin_inset CommandInset label
6666 name "subsec:Layout-modules"
6673 \begin_layout Standard
6674 We have spoken to this point about `layout files'.
6675 But there are different sorts of files that contain layout information.
6676 Layout files, strictly so called, have the
6677 \begin_inset Flex Code
6680 \begin_layout Plain Layout
6686 extension and provide \SpecialChar LyX
6687 with information about document classes.
6688 Since \SpecialChar LyX
6689 1.6 layout information can also be contained in layout
6694 \begin_inset Flex Code
6697 \begin_layout Plain Layout
6704 Modules are to \SpecialChar LaTeX
6705 packages much as layouts are to \SpecialChar LaTeX
6706 classes, and some modules—such
6708 \begin_inset Flex Code
6711 \begin_layout Plain Layout
6717 module—specifically provide support for one package.
6718 In a sense, layout modules are similar to included
6722 \begin_layout Plain Layout
6723 These can have any extension, but by convention have the
6724 \begin_inset Flex Code
6727 \begin_layout Plain Layout
6739 \begin_inset Flex Code
6742 \begin_layout Plain Layout
6748 —in that modules are not specific to a given document class but may be used
6749 with many different classes.
6750 The difference is that using an included file with
6751 \begin_inset Flex Code
6754 \begin_layout Plain Layout
6760 requires editing that file.
6761 Modules, by contrast, are selected in the
6762 \begin_inset Flex MenuItem
6765 \begin_layout Plain Layout
6766 Document\SpecialChar menuseparator
6775 \begin_layout Standard
6776 Building modules is the easiest way to get started with layout editing,
6777 since it can be as simple as adding a single new paragraph style or flex
6779 But modules may, in principle, contain anything a layout file can contain.
6782 \begin_layout Standard
6783 After creating a new module and copying it to the
6784 \begin_inset Flex Code
6787 \begin_layout Plain Layout
6793 folder, you will need to reconfigure and then restart \SpecialChar LyX
6796 However, changes you make to the module will be seen immediately, if you
6798 \begin_inset Flex MenuItem
6801 \begin_layout Plain Layout
6802 Document\SpecialChar menuseparator
6808 , highlight something, and then hit
6809 \begin_inset Quotes eld
6813 \begin_inset Quotes erd
6819 It is strongly recommended that you save your work before doing this
6824 it is strongly recommended that you not attempt to edit modules while simultaneo
6825 usly working on actual documents
6828 Though of course the developers strive to keep \SpecialChar LyX
6829 stable in such situations,
6830 syntax errors and the like in your module file could cause strange behavior.
6833 \begin_layout Subsubsection
6837 \begin_layout Standard
6838 Modules are to \SpecialChar LyX
6839 as packages are to \SpecialChar LaTeX
6841 Sometimes, however, you find yourself wanting a specific inset or character
6842 style just for one document and writing a module that will also be available
6843 to other documents makes little sense.
6844 What you need is \SpecialChar LyX
6846 \begin_inset Quotes eld
6850 \begin_inset Quotes erd
6856 \begin_layout Standard
6857 You will find it under
6859 Document\SpecialChar menuseparator
6860 Settings\SpecialChar menuseparator
6864 The large text box allows you to enter anything that you might enter in
6865 a layout file or module.
6866 You can think of a document's local layout, in fact, as a module that belongs
6868 So, in particular, you must enter a
6869 \begin_inset Flex Code
6872 \begin_layout Plain Layout
6879 Any format is acceptable, but one would normally use the format current
6881 (In \SpecialChar LyX
6882 2.1, the current layout format is 48.) You should be aware that local
6883 layout is not supported by versions of \SpecialChar LyX
6884 prior to 1.6, so you should not
6885 use it if you want to be able to export your document to \SpecialChar LyX
6887 (without, that is, losing the local layout information).
6888 If you wish to be able to export to 1.6—local layout is supported in 1.6,
6889 though there is no UI for it—then you should use format 11 and, of course,
6890 use only layout constructs that were available in \SpecialChar LyX
6894 \begin_layout Standard
6895 When you have entered something in the
6896 \begin_inset Flex Code
6899 \begin_layout Plain Layout
6905 pane, \SpecialChar LyX
6907 \begin_inset Quotes eld
6911 \begin_inset Quotes erd
6914 button at the bottom.
6915 Clicking this button will cause \SpecialChar LyX
6916 to determine whether what you have entered
6917 is valid layout information for the chosen format.
6919 will report the result but, unfortunately, will not tell you what errors
6920 there might have been.
6921 These will be written to the terminal, however, if \SpecialChar LyX
6922 is started from a terminal.
6923 You will not be permitted to save your local layout until you have entered
6927 \begin_layout Standard
6928 The warnings at the end of the previous section apply here, too.
6929 Do not play with local layout while you are actually working, especially
6930 if you have not saved your document.
6931 That said, using local layout with a test document can be a very convenient
6932 way to try out layout ideas, or even to start developing a module.
6935 \begin_layout Subsection
6937 \begin_inset Flex MenuItem
6940 \begin_layout Plain Layout
6949 \begin_layout Standard
6950 There are two situations you are likely to encounter when wanting to support
6951 a new \SpecialChar LaTeX
6952 document class, involving style (
6953 \begin_inset Flex Code
6956 \begin_layout Plain Layout
6962 ) files and \SpecialChar LaTeX2e
6964 \begin_inset Flex Code
6967 \begin_layout Plain Layout
6974 Supporting a style file is usually fairly easy.
6975 Supporting a new class file is a bit harder.
6976 We'll discuss the former in this section and the latter in the next.
6977 Similar remarks apply, of course, if you want to support a new DocBook
6981 \begin_layout Standard
6982 The easier case is the one in which your new document class is provided
6983 as a style file that is to be used in conjunction with an already supported
6985 For the sake of the example, we'll assume that the style file is called
6987 \begin_inset Flex MenuItem
6990 \begin_layout Plain Layout
6996 and that it is meant to be used with
6997 \begin_inset Flex MenuItem
7000 \begin_layout Plain Layout
7006 , which is a standard class.
7010 \begin_layout Standard
7011 Start by copying the existing class's layout file into your local directory:
7015 \begin_layout Plain Layout
7016 Of course, which directory is your local directory will vary by platform,
7017 and \SpecialChar LyX
7018 allows you to specify your local directory on startup, too, using
7020 \begin_inset Flex Code
7023 \begin_layout Plain Layout
7037 \begin_layout LyX-Code
7038 cp report.layout ~/.lyx/layouts/myclass.layout
7041 \begin_layout Standard
7043 \begin_inset Flex Code
7046 \begin_layout Plain Layout
7052 and change the line:
7055 \begin_layout LyX-Code
7058 Declare\SpecialChar LaTeX
7062 \begin_layout Standard
7066 \begin_layout LyX-Code
7069 Declare\SpecialChar LaTeX
7070 Class[report, myclass.sty]{report (myclass)}
7073 \begin_layout Standard
7077 \begin_layout LyX-Code
7079 \begin_inset Newline newline
7085 \begin_inset Newline newline
7091 \begin_layout Standard
7092 near the top of the file.
7095 \begin_layout Standard
7096 Start \SpecialChar LyX
7098 \begin_inset Flex MenuItem
7101 \begin_layout Plain Layout
7102 Tools\SpecialChar menuseparator
7109 Then restart \SpecialChar LyX
7110 and try creating a new document.
7112 \begin_inset Flex MenuItem
7115 \begin_layout Plain Layout
7121 " as a document class option in the
7122 \begin_inset Flex MenuItem
7125 \begin_layout Plain Layout
7126 Document\SpecialChar menuseparator
7133 It is likely that some of the sectioning commands and such in your new
7134 class will work differently from how they worked in the base class—
7135 \begin_inset Flex Code
7138 \begin_layout Plain Layout
7144 in this example—so you can fiddle around with the settings for the different
7145 sections if you wish.
7146 The layout information for sections is contained in
7147 \begin_inset Flex Code
7150 \begin_layout Plain Layout
7156 , but you do not need to copy and change this file.
7157 Instead, you can simply add your changes to your layout file, after the
7159 \begin_inset Flex Code
7162 \begin_layout Plain Layout
7168 , which itself includes
7169 \begin_inset Flex Code
7172 \begin_layout Plain Layout
7179 For example, you might add these lines:
7182 \begin_layout LyX-Code
7186 \begin_layout LyX-Code
7190 \begin_layout LyX-Code
7194 \begin_layout LyX-Code
7198 \begin_layout LyX-Code
7202 \begin_layout Standard
7203 to change the font for chapter headings to sans-serif.
7204 This will override (or, in this case, add to) the existing declaration
7205 for the Chapter style.
7209 \begin_layout Standard
7210 Your new package may also provide commands or environments not present in
7212 In this case, you will want to add these to the layout file.
7214 \begin_inset CommandInset ref
7216 reference "sec:TextClass"
7220 for information on how to do so.
7223 \begin_layout Standard
7225 \begin_inset Flex MenuItem
7228 \begin_layout Plain Layout
7234 can be used with several different document classes, and even if it cannot,
7235 you might find it easiest just to write a module that you can load with
7237 The simplest possible such module would be:
7240 \begin_layout LyX-Code
7244 \change_deleted -712698321 1437634736
7247 \change_inserted -712698321 1437634737
7253 \begin_layout LyX-Code
7257 \begin_layout LyX-Code
7258 #Support for mypkg.sty.
7261 \begin_layout LyX-Code
7263 \begin_inset Newline newline
7269 \begin_layout LyX-Code
7271 \begin_inset Newline newline
7277 \begin_layout LyX-Code
7279 \begin_inset Newline newline
7285 \begin_inset Newline newline
7291 \begin_layout Standard
7292 A more complex module might modify the behavior of some existing constructs
7293 or define some new ones.
7295 \begin_inset CommandInset ref
7297 reference "sec:TextClass"
7304 \begin_layout Subsection
7306 \begin_inset Flex MenuItem
7309 \begin_layout Plain Layout
7318 \begin_layout Standard
7319 There are two possibilities here.
7320 One is that the class file is itself based upon an existing document class.
7321 For example, many thesis classes are based upon
7322 \begin_inset Flex MenuItem
7325 \begin_layout Plain Layout
7332 To see whether yours is, look for a line like
7335 \begin_layout LyX-Code
7341 \begin_layout Standard
7343 If so, then you may proceed largely as in the previous section, though
7345 \begin_inset Flex Code
7348 \begin_layout Plain Layout
7349 Declare\SpecialChar LaTeX
7355 line will be different.
7356 If your new class is
7357 \begin_inset Flex Code
7360 \begin_layout Plain Layout
7366 and it is based upon
7367 \begin_inset Flex Code
7370 \begin_layout Plain Layout
7376 , then the line should read:
7380 \begin_layout Plain Layout
7381 And it will be easiest if you save the file to
7382 \begin_inset Flex Code
7385 \begin_layout Plain Layout
7392 assumes that the document class has the same name as the layout file.
7401 \begin_layout LyX-Code
7404 Declare\SpecialChar LaTeX
7405 Class[thesis,book]{thesis}
7408 \begin_layout Standard
7409 If, on the other hand, the new class is not based upon an existing class,
7410 you will probably have to
7411 \begin_inset Quotes eld
7415 \begin_inset Quotes erd
7419 We strongly suggest copying an existing layout file which uses a similar
7421 class and then modifying it, if you can do so.
7422 At least use an existing file as a starting point so you can find out what
7423 items you need to worry about.
7424 Again, the specifics are covered below.
7427 \begin_layout Subsection
7429 \begin_inset CommandInset label
7431 name "subsec:Creating-Templates"
7438 \begin_layout Standard
7439 Once you have written a layout file for a new document class, you might
7440 want to consider writing a
7445 A template acts as a kind of tutorial for your layout, showing how it might
7446 be used, though containing dummy content.
7447 You can of course look at the various templates included with \SpecialChar LyX
7451 \begin_layout Standard
7452 Templates are created just like usual documents: using \SpecialChar LyX
7454 The only difference is that usual documents contain all possible settings,
7455 including the font scheme and the paper size.
7456 Usually a user doesn't want a template to overwrite his preferred settings
7457 for such parameters.
7458 For that reason, the designer of a template should remove the corresponding
7460 \begin_inset Flex Code
7463 \begin_layout Plain Layout
7472 \begin_inset Flex Code
7475 \begin_layout Plain Layout
7483 from the template \SpecialChar LyX
7485 This can be done with any simple text-editor, for example
7486 \begin_inset Flex Code
7489 \begin_layout Plain Layout
7496 \begin_inset Flex Code
7499 \begin_layout Plain Layout
7508 \begin_layout Standard
7509 Put the edited template files you create in
7510 \begin_inset Flex Code
7513 \begin_layout Plain Layout
7519 , copy the ones you use from the global template directory in
7520 \begin_inset Flex Code
7523 \begin_layout Plain Layout
7525 \change_deleted -712698321 1437634751
7528 \change_inserted -712698321 1437634752
7536 to the same place, and redefine the template path in the
7537 \begin_inset Flex MenuItem
7540 \begin_layout Plain Layout
7541 Tools\SpecialChar menuseparator
7542 Preferences\SpecialChar menuseparator
7551 \begin_layout Standard
7552 Note, by the way, that there is a template which has a particular meaning:
7554 \begin_inset Flex Code
7557 \begin_layout Plain Layout
7564 This template is loaded every time you create a new document with
7565 \begin_inset Flex MenuItem
7568 \begin_layout Plain Layout
7569 File\SpecialChar menuseparator
7575 in order to provide useful defaults.
7576 To create this template from inside \SpecialChar LyX
7577 , all you have to do is to open a document
7578 with the correct settings, and use the
7579 \begin_inset Flex MenuItem
7582 \begin_layout Plain Layout
7583 Save as Document Defaults
7591 \begin_layout Subsection
7592 Upgrading old layout files
7595 \begin_layout Standard
7596 The format of layout files changes with each \SpecialChar LyX
7597 release, so old layout files
7598 need to be converted to the new format.
7600 reads a layout file in an older format, it automatically calls the
7602 \begin_inset Flex Code
7605 \begin_layout Plain Layout
7611 to convert it to a temporary file in current format.
7612 The original file is left untouched.
7613 If you use the layout file often, then, you may want to convert it permanently,
7614 so that \SpecialChar LyX
7615 does not have to do so itself every time.
7616 To do this, you can call the converter manually:
7619 \begin_layout Enumerate
7621 \begin_inset Flex Code
7624 \begin_layout Plain Layout
7631 \begin_inset Flex Code
7634 \begin_layout Plain Layout
7643 \begin_layout Enumerate
7645 \begin_inset Newline newline
7649 \begin_inset Flex Code
7652 \begin_layout Plain Layout
7654 \change_deleted -712698321 1437634764
7657 \change_inserted -712698321 1437634766
7660 Dir/scripts/layout2layout.py myclass.old myclass.layout
7666 \begin_inset Newline newline
7670 \begin_inset Flex Code
7673 \begin_layout Plain Layout
7675 \change_deleted -712698321 1437634771
7678 \change_inserted -712698321 1437634772
7686 is the name of your \SpecialChar LyX
7690 \begin_layout Standard
7691 Note that manual conversion does not affect included files, so these will
7692 have to be converted separately.
7695 \begin_layout Section
7696 \begin_inset CommandInset label
7698 name "sec:TextClass"
7702 The layout file format
7705 \begin_layout Standard
7706 The following sections describe how layout files are structured and written.
7707 Our advice is to go slowly, save and test often.
7708 It is really not that hard, except that the multitude of options can become
7709 overwhelming, especially if you try to check out too many at once.
7710 It becomes easier if you use existing layouts of \SpecialChar LyX
7711 as examples/reference
7712 or if you modify an existing layout to your needs.
7715 \begin_layout Standard
7716 Note that all the tags used in layout files are case-insensitive.
7718 \begin_inset Flex Code
7721 \begin_layout Plain Layout
7728 \begin_inset Flex Code
7731 \begin_layout Plain Layout
7738 \begin_inset Flex Code
7741 \begin_layout Plain Layout
7747 are really the same tag.
7748 The possible arguments are printed in brackets after the tag's name.
7749 The default argument is typeset
7750 \begin_inset Flex Code
7753 \begin_layout Plain Layout
7762 If the argument has a data type like
7763 \begin_inset Quotes eld
7767 \begin_inset Quotes erd
7771 \begin_inset Quotes eld
7775 \begin_inset Quotes erd
7778 , the default is shown like this:
7779 \begin_inset Flex Code
7782 \begin_layout Plain Layout
7793 \begin_layout Subsection
7794 The document class declaration and classification
7797 \begin_layout Standard
7798 Lines in a layout file which begin with
7799 \begin_inset Flex Code
7802 \begin_layout Plain Layout
7809 There is one exception to this rule.
7811 \begin_inset Flex Code
7814 \begin_layout Plain Layout
7820 files should begin with lines like:
7823 \begin_layout LyX-Code
7826 #% Do not delete the line below; configure depends on this
7829 \begin_layout LyX-Code
7835 \change_deleted -712698321 1437634362
7842 \begin_layout Plain Layout
7853 eXClass{Article (Standard Class)}
7856 \begin_layout LyX-Code
7861 DeclareCategory{Articles}
7864 \begin_layout Standard
7865 The second and third lines are used when you (re)configure \SpecialChar LyX
7867 The layout file is read by the \SpecialChar LaTeX
7869 \begin_inset Flex Code
7872 \begin_layout Plain Layout
7878 , in a special mode where
7879 \begin_inset Flex Code
7882 \begin_layout Plain Layout
7889 The first line is just a \SpecialChar LaTeX
7890 comment, the second one contains the mandatory
7891 declaration of the text class and the third line contains the optional
7892 classification of the class.
7893 If these lines appear in a file named
7894 \begin_inset Flex Code
7897 \begin_layout Plain Layout
7903 , then they define a text class of name
7904 \begin_inset Flex Code
7907 \begin_layout Plain Layout
7913 (the name of the layout file) which uses the \SpecialChar LaTeX
7915 \begin_inset Flex Code
7918 \begin_layout Plain Layout
7924 (the default is to use the same name as the layout).
7926 \begin_inset Quotes eld
7929 Article (Standard Class)
7930 \begin_inset Quotes erd
7933 that appears above is used as a description of the text class in the
7934 \begin_inset Flex MenuItem
7937 \begin_layout Plain Layout
7938 Document\SpecialChar menuseparator
7946 \begin_inset Quotes eld
7950 \begin_inset Quotes erd
7953 in the example) is also used in the
7954 \begin_inset Flex MenuItem
7957 \begin_layout Plain Layout
7958 Document\SpecialChar menuseparator
7964 dialog: the text classes are grouped by these categories (which are usually
7965 genres, so typical categories are
7966 \begin_inset Quotes eld
7970 \begin_inset Quotes erd
7974 \begin_inset Quotes eld
7978 \begin_inset Quotes erd
7982 \begin_inset Quotes eld
7986 \begin_inset Quotes erd
7990 \begin_inset Quotes eld
7994 \begin_inset Quotes erd
7998 \begin_inset Quotes eld
8002 \begin_inset Quotes erd
8006 \begin_inset Quotes eld
8010 \begin_inset Quotes erd
8014 If no category has been declared, the class will be put in the
8015 \begin_inset Quotes eld
8019 \begin_inset Quotes erd
8025 \begin_layout Standard
8026 Let's assume that you wrote your own text class that uses the
8027 \begin_inset Flex Code
8030 \begin_layout Plain Layout
8036 document class, but where you changed the appearance of the section headings.
8037 If you put it in a file
8038 \begin_inset Flex Code
8041 \begin_layout Plain Layout
8047 , the header of this file should be:
8050 \begin_layout LyX-Code
8053 #% Do not delete the line below; configure depends on this
8056 \begin_layout LyX-Code
8067 \begin_layout Plain Layout
8076 eXClass[article]{Article (with My Own Headings)}
8079 \begin_layout LyX-Code
8084 DeclareCategory{Articles}
8087 \begin_layout Standard
8088 This declares a text class
8089 \begin_inset Flex Code
8092 \begin_layout Plain Layout
8098 , associated with the \SpecialChar LaTeX
8100 \begin_inset Flex Code
8103 \begin_layout Plain Layout
8110 \begin_inset Quotes eld
8113 Article (with My Own Headings)
8114 \begin_inset Quotes erd
8118 If your text class depends on several packages, you can declare it as:
8121 \begin_layout LyX-Code
8124 #% Do not delete the line below; configure depends on this
8127 \begin_layout LyX-Code
8133 \change_deleted -712698321 1437634376
8140 \begin_layout Plain Layout
8151 eXClass[article,foo.sty]{Article (with My Own Headings)}
8154 \begin_layout LyX-Code
8159 DeclareCategory{Articles}
8162 \begin_layout Standard
8163 This indicates that your text class uses the
8164 \begin_inset Flex Code
8167 \begin_layout Plain Layout
8174 Finally, it is also possible to declare classes for DocBook code.
8175 Typical declarations will look like:
8178 \begin_layout LyX-Code
8181 #% Do not delete the line below; configure depends on this
8184 \begin_layout LyX-Code
8189 DeclareDocBookClass[article]{SGML (DocBook Article)}
8192 \begin_layout LyX-Code
8197 DeclareCategory{Articles (DocBook)}
8200 \begin_layout Standard
8201 Note that these declarations can also be given an optional parameter declaring
8202 the name of the document class (but not a list).
8205 \begin_layout Standard
8206 So, to be as explicit as possible, the form of the layout declaration is:
8209 \begin_layout LyX-Code
8215 \change_deleted -712698321 1437634381
8222 \begin_layout Plain Layout
8233 eXClass[class,package.sty]{layout description}
8236 \begin_layout LyX-Code
8241 DeclareCategory{category}
8244 \begin_layout Standard
8245 The class need only be specified if the name of the \SpecialChar LaTeX
8247 name of the layout file are different or if there are packages to load.
8248 If the name of the class file is not specified, then \SpecialChar LyX
8250 that it is the same as the name of the layout file.
8253 \begin_layout Standard
8254 When the text class has been modified to your taste, all you have to do
8255 is to copy it either to
8256 \begin_inset Flex Code
8259 \begin_layout Plain Layout
8261 \change_deleted -712698321 1437634783
8264 \change_inserted -712698321 1437634784
8273 \begin_inset Flex Code
8276 \begin_layout Plain Layout
8283 \begin_inset Flex MenuItem
8286 \begin_layout Plain Layout
8287 Tools\SpecialChar menuseparator
8293 , exit \SpecialChar LyX
8295 Then your new text class should be available along with the others.
8298 \begin_layout Standard
8299 Once the layout file is installed, you can edit it and see your changes
8300 without having to reconfigure or to restart \SpecialChar LyX
8306 \begin_layout Plain Layout
8307 In versions of \SpecialChar LyX
8308 prior to 1.6, this was not true.
8309 As a result, editing layout files was very time consuming, since you had
8310 constantly to restart \SpecialChar LyX
8316 You can force a reload of the current layout by using the \SpecialChar LyX
8318 \begin_inset Flex MenuItem
8321 \begin_layout Plain Layout
8328 There is no default binding for this function—though, of course, you can
8329 bind it to a key yourself.
8330 But you will normally use this function simply by entering it in the mini-buffe
8335 \begin_layout Standard
8341 \begin_inset Flex MenuItem
8344 \begin_layout Plain Layout
8350 is very much an `advanced feature'.
8355 recommended that you save your work before using this function.
8360 recommended that you not attempt to edit layout information while simultaneousl
8361 y working on a document that you care about.
8362 Use a test document.
8363 Syntax errors and the like in your layout file could cause peculiar behavior.
8364 In particular, such errors could cause \SpecialChar LyX
8365 to regard the current layout as
8366 invalid and to attempt to switch to some other layout.
8370 \begin_layout Plain Layout
8371 Really bad syntax errors may even caused \SpecialChar LyX
8373 This is because certain sorts of errors may make \SpecialChar LyX
8384 The \SpecialChar LyX
8385 team strives to keep \SpecialChar LyX
8386 stable in such situations, but safe is better
8391 \begin_layout Plain Layout
8392 While we're giving advice: make regular backups.
8393 And be nice to your mother.
8401 \begin_layout Subsection
8402 The Module declaration
8405 \begin_layout Standard
8406 A module must begin with a line like the following:
8409 \begin_layout LyX-Code
8413 \change_deleted -712698321 1437634801
8418 \begin_layout Plain Layout
8427 yXModule[endnotes.sty]{Endnotes}
8430 \begin_layout Standard
8431 The mandatory argument, in curly brackets, is the name of the module, as
8433 \begin_inset Flex MenuItem
8436 \begin_layout Plain Layout
8437 Document\SpecialChar menuseparator
8438 Settings\SpecialChar menuseparator
8445 The argument in square brackets is optional: It declares any \SpecialChar LaTeX
8447 on which the module depends.
8448 It is also possible to use the form
8449 \begin_inset Flex MenuItem
8452 \begin_layout Plain Layout
8458 as an optional argument, which declares that the module can only be used
8459 when there exists a conversion chain between the formats `
8460 \begin_inset Flex Code
8463 \begin_layout Plain Layout
8470 \begin_inset Flex Code
8473 \begin_layout Plain Layout
8482 \begin_layout Standard
8483 The module declaration should then be followed by lines like the following
8487 \begin_layout Plain Layout
8488 Preferably in English if the module should be published with \SpecialChar LyX
8490 This description will appear in the list of messages to be translated and
8491 will be thus translated with the next interface update.
8499 \begin_layout LyX-Code
8503 \begin_layout LyX-Code
8504 #Adds an endnote command, in addition to footnotes.
8508 \begin_layout LyX-Code
8509 #You will need to add
8512 \change_deleted -712698321 1437634393
8515 \change_inserted -712698321 1437634395
8521 \begin_layout LyX-Code
8522 #want the endnotes to appear.
8526 \begin_layout LyX-Code
8530 \begin_layout LyX-Code
8531 #Requires: somemodule | othermodule
8534 \begin_layout LyX-Code
8535 #Excludes: badmodule
8538 \begin_layout Standard
8539 The description is used in
8540 \begin_inset Flex MenuItem
8543 \begin_layout Plain Layout
8544 Document\SpecialChar menuseparator
8545 Settings\SpecialChar menuseparator
8551 to provide the user with information about what the module does.
8553 \begin_inset Flex Code
8556 \begin_layout Plain Layout
8562 line is used to identify other modules with which this one must be used;
8564 \begin_inset Flex Code
8567 \begin_layout Plain Layout
8573 line is used to identify modules with which this one may not be used.
8574 Both are optional, and, as shown, multiple modules should be separated
8575 with the pipe symbol: |.
8576 Note that the required modules are treated disjunctively:
8580 of the required modules must be used.
8585 excluded module may be used.
8586 Note that modules are identified here by their filenames without the
8587 \begin_inset Flex Code
8590 \begin_layout Plain Layout
8598 \begin_inset Flex Code
8601 \begin_layout Plain Layout
8608 \begin_inset Flex Code
8611 \begin_layout Plain Layout
8620 \begin_layout Subsection
8624 \begin_layout Standard
8625 The first non-comment line of any layout file, included file, or module
8630 contain the file format number:
8633 \begin_layout Description
8634 \begin_inset Flex Code
8637 \begin_layout Plain Layout
8644 \begin_inset Flex Code
8647 \begin_layout Plain Layout
8653 ] The format number of the layout file.
8656 \begin_layout Standard
8657 This tag was introduced with \SpecialChar LyX
8659 \begin_inset space ~
8663 Layout files from older \SpecialChar LyX
8664 versions do not have an explicit file format and
8665 are considered to have
8666 \begin_inset Flex Code
8669 \begin_layout Plain Layout
8671 \begin_inset space ~
8680 The format for the present version of \SpecialChar LyX
8682 But each version of \SpecialChar LyX
8683 is capable of reading earlier versions' layout files,
8684 just as they are capable of reading files produced by earlier versions
8687 There is, however, no provision for converting to earlier formats.
8690 \begin_layout Subsection
8691 \begin_inset CommandInset label
8693 name "subsec:General-text-class"
8697 General text class parameters
8700 \begin_layout Standard
8701 These are general parameters that govern the behavior of an entire document
8707 mean that they must appear in
8708 \begin_inset Flex Code
8711 \begin_layout Plain Layout
8717 files rather than in modules.
8718 A module can contain any layout tag.)
8721 \begin_layout Description
8722 \begin_inset Flex Code
8725 \begin_layout Plain Layout
8731 Adds information that will be output in the
8732 \begin_inset Flex Code
8735 \begin_layout Plain Layout
8741 block when the document is output to XHTML.
8742 Typically, this would be used to output CSS style information, but it can
8743 be used for anything that can appear in
8744 \begin_inset Flex Code
8747 \begin_layout Plain Layout
8755 \begin_inset Quotes eld
8759 \begin_inset Flex Code
8762 \begin_layout Plain Layout
8769 \begin_inset Quotes erd
8775 \begin_layout Description
8776 \begin_inset Flex Code
8779 \begin_layout Plain Layout
8785 Adds information to the document preamble.
8787 \begin_inset Newline newline
8791 \begin_inset Quotes eld
8795 \begin_inset Flex Code
8798 \begin_layout Plain Layout
8805 \begin_inset Quotes erd
8811 \begin_layout Description
8812 \begin_inset Flex Code
8815 \begin_layout Plain Layout
8821 Defines formats for use in the display of bibliographic information.
8823 \begin_inset CommandInset ref
8825 reference "subsec:Citation-format-description"
8831 \begin_inset Quotes eld
8835 \begin_inset Flex Code
8838 \begin_layout Plain Layout
8845 \begin_inset Quotes erd
8851 \begin_layout Description
8852 \begin_inset Flex Code
8855 \begin_layout Plain Layout
8861 Describes various global options supported by the document class.
8863 \begin_inset CommandInset ref
8865 reference "subsec:ClassOptions"
8871 \begin_inset Quotes eld
8875 \begin_inset Flex Code
8878 \begin_layout Plain Layout
8885 \begin_inset Quotes erd
8891 \begin_layout Description
8892 \begin_inset Flex Code
8895 \begin_layout Plain Layout
8902 \begin_inset Flex Code
8905 \begin_layout Plain Layout
8914 \begin_inset space \thinspace{}
8918 \begin_inset Flex Code
8921 \begin_layout Plain Layout
8927 ] Whether the class should
8931 to having one or two columns.
8932 Can be changed in the
8933 \begin_inset Flex MenuItem
8936 \begin_layout Plain Layout
8937 Document\SpecialChar menuseparator
8946 \begin_layout Description
8947 \begin_inset Flex Code
8950 \begin_layout Plain Layout
8957 \begin_inset Flex Code
8960 \begin_layout Plain Layout
8966 ] This sequence defines the properties for a counter.
8967 If the counter does not yet exist, it is created; if it does exist, it
8970 \begin_inset Quotes eld
8974 \begin_inset Flex Code
8977 \begin_layout Plain Layout
8984 \begin_inset Quotes erd
8988 \begin_inset Newline newline
8992 \begin_inset CommandInset ref
8994 reference "subsec:Counters"
8998 for details on counters.
9001 \begin_layout Description
9002 \begin_inset Flex Code
9005 \begin_layout Plain Layout
9011 Sets the default font used to display the document.
9013 \begin_inset CommandInset ref
9015 reference "subsec:Font-description"
9019 for how to declare fonts.
9021 \begin_inset Quotes eld
9025 \begin_inset Flex Code
9028 \begin_layout Plain Layout
9035 \begin_inset Quotes erd
9041 \begin_layout Description
9042 \begin_inset Flex Code
9045 \begin_layout Plain Layout
9052 \begin_inset Flex Code
9055 \begin_layout Plain Layout
9061 ] Specifies a module to be included by default with this document class.
9062 The module is specified as filename without the
9063 \begin_inset Flex Code
9066 \begin_layout Plain Layout
9073 The user can still remove the module, but it will be active at the outset.
9074 (This applies only when new files are created, or when this class is chosen
9075 for an existing document.)
9078 \begin_layout Description
9079 \begin_inset Flex Code
9082 \begin_layout Plain Layout
9089 \begin_inset Flex Code
9092 \begin_layout Plain Layout
9098 ] This is the style that will be assigned to new paragraphs, usually
9099 \begin_inset Flex MenuItem
9102 \begin_layout Plain Layout
9109 This will default to the first defined style if not given, but you are
9110 encouraged to use this directive.
9113 \begin_layout Description
9114 \begin_inset Flex Code
9117 \begin_layout Plain Layout
9124 \begin_inset Flex Code
9127 \begin_layout Plain Layout
9133 ] This tag indicates that the module (which is specified by filename without
9135 \begin_inset Flex Code
9138 \begin_layout Plain Layout
9144 extension) cannot be used with this document class.
9145 This might be used in a journal-specific layout file to prevent, say, the
9147 \begin_inset Flex Code
9150 \begin_layout Plain Layout
9156 module that numbers theorems by section.
9161 be used in a module.
9162 Modules have their own way of excluding other modules (see
9163 \begin_inset CommandInset ref
9165 reference "subsec:Layout-modules"
9172 \begin_layout Description
9173 \begin_inset Flex Code
9176 \begin_layout Plain Layout
9182 Defines a new float.
9184 \begin_inset CommandInset ref
9186 reference "subsec:Floats"
9192 \begin_inset Quotes eld
9196 \begin_inset Flex Code
9199 \begin_layout Plain Layout
9206 \begin_inset Quotes erd
9212 \begin_layout Description
9213 \begin_inset Flex Code
9216 \begin_layout Plain Layout
9222 Sets the information that will be output in the
9223 \begin_inset Flex Code
9226 \begin_layout Plain Layout
9232 block when this document class is output to XHTML.
9233 Note that this will completely override any prior
9234 \begin_inset Flex Code
9237 \begin_layout Plain Layout
9244 \begin_inset Flex Code
9247 \begin_layout Plain Layout
9255 \begin_inset Newline newline
9259 \begin_inset Flex Code
9262 \begin_layout Plain Layout
9268 if you just want to add material to the preamble.) Must end with
9269 \begin_inset Quotes eld
9273 \begin_inset Flex Code
9276 \begin_layout Plain Layout
9283 \begin_inset Quotes erd
9289 \begin_layout Description
9290 \begin_inset Flex Code
9293 \begin_layout Plain Layout
9300 \begin_inset Flex Code
9303 \begin_layout Plain Layout
9309 ] The style to use for the table of contents, bibliography, and so forth,
9310 when the document is output to HTML.
9311 For articles, this should normally be
9312 \begin_inset Flex Code
9315 \begin_layout Plain Layout
9322 \begin_inset Flex Code
9325 \begin_layout Plain Layout
9332 If it is not given, then \SpecialChar LyX
9333 will attempt to figure out which layout to use.
9336 \begin_layout Description
9337 \begin_inset Flex Code
9340 \begin_layout Plain Layout
9347 \begin_inset Flex Code
9350 \begin_layout Plain Layout
9356 ] Modifies the properties of the given counter.
9357 If the counter does not exist, the statement is ignored.
9359 \begin_inset Quotes eld
9363 \begin_inset Flex Code
9366 \begin_layout Plain Layout
9373 \begin_inset Quotes erd
9377 \begin_inset Newline newline
9381 \begin_inset CommandInset ref
9383 reference "subsec:Counters"
9387 for details on counters.
9390 \begin_layout Description
9391 \begin_inset Flex Code
9394 \begin_layout Plain Layout
9401 \begin_inset Flex Code
9404 \begin_layout Plain Layout
9410 ] Modifies the properties of the given paragraph style.
9411 If the style does not exist, the statement is ignored.
9413 \begin_inset Quotes eld
9417 \begin_inset Flex Code
9420 \begin_layout Plain Layout
9427 \begin_inset Quotes erd
9433 \begin_layout Description
9434 \begin_inset Flex Code
9437 \begin_layout Plain Layout
9444 \begin_inset Flex Code
9447 \begin_layout Plain Layout
9453 ] This allows you to include another layout definition file within yours
9454 to avoid duplicating commands.
9455 Common examples are the standard layout files, for example,
9456 \begin_inset Flex Code
9459 \begin_layout Plain Layout
9465 , which contains most of the basic layouts.
9468 \begin_layout Description
9469 \begin_inset Flex Code
9472 \begin_layout Plain Layout
9479 \begin_inset Flex Code
9482 \begin_layout Plain Layout
9488 ] This section (re-)defines the layout of an inset.
9489 It can be applied to an existing inset or to a new, user-defined inset,
9490 e.g., a new character style.
9492 \begin_inset Quotes eld
9496 \begin_inset Flex Code
9499 \begin_layout Plain Layout
9506 \begin_inset Quotes erd
9510 \begin_inset Newline newline
9514 \begin_inset CommandInset ref
9516 reference "subsec:Flex-insets-and"
9520 for more information.
9524 \begin_layout Description
9525 \begin_inset Flex Code
9528 \begin_layout Plain Layout
9535 \begin_inset Flex Code
9538 \begin_layout Plain Layout
9544 ] A string that indicates the width of the left margin on the screen, for
9546 \begin_inset Quotes eld
9550 \begin_inset Flex Code
9553 \begin_layout Plain Layout
9560 \begin_inset Quotes erd
9564 (Note that this is not a `length', like
9565 \begin_inset Quotes eld
9569 \begin_inset Quotes erd
9575 \begin_layout Description
9576 \begin_inset Flex Code
9579 \begin_layout Plain Layout
9586 \begin_inset Flex Code
9589 \begin_layout Plain Layout
9595 ] Deletes an existing counter, usually one defined in an included file.
9598 \begin_layout Description
9599 \begin_inset Flex Code
9602 \begin_layout Plain Layout
9609 \begin_inset Flex Code
9612 \begin_layout Plain Layout
9618 ] Deletes an existing float.
9619 This is particularly useful when you want to suppress a float that has
9620 been defined in an input file.
9623 \begin_layout Description
9624 \begin_inset Flex Code
9627 \begin_layout Plain Layout
9634 \begin_inset Flex Code
9637 \begin_layout Plain Layout
9643 ] Deletes an existing style.
9646 \begin_layout Description
9647 \begin_inset Flex Code
9650 \begin_layout Plain Layout
9657 \begin_inset Flex Code
9660 \begin_layout Plain Layout
9666 ] The file format (as defined in the \SpecialChar LyX
9667 preferences) produced by this document
9669 It is mainly useful when
9670 \begin_inset Flex Code
9673 \begin_layout Plain Layout
9680 \begin_inset Flex Code
9683 \begin_layout Plain Layout
9689 and one wants to define a new type of literate document.
9690 The format is reset to
9691 \begin_inset Quotes eld
9695 \begin_inset Flex Code
9698 \begin_layout Plain Layout
9705 \begin_inset Quotes erd
9709 \begin_inset Quotes eld
9713 \begin_inset Flex Code
9716 \begin_layout Plain Layout
9723 \begin_inset Quotes erd
9726 when the corresponding
9727 \begin_inset Flex Code
9730 \begin_layout Plain Layout
9736 parameter is encountered.
9739 \begin_layout Description
9740 \begin_inset Flex Code
9743 \begin_layout Plain Layout
9750 \begin_inset Flex Code
9753 \begin_layout Plain Layout
9764 \begin_inset Flex Code
9767 \begin_layout Plain Layout
9774 \begin_inset Flex Code
9777 \begin_layout Plain Layout
9783 ] Specifies what sort of output documents using this class will produce.
9786 \begin_layout Description
9787 \begin_inset Flex Code
9790 \begin_layout Plain Layout
9797 \begin_inset Flex Code
9800 \begin_layout Plain Layout
9807 \begin_inset Flex Code
9810 \begin_layout Plain Layout
9816 ] Specifies options, given in the second string, for the package named by
9819 \begin_inset Quotes eld
9823 \begin_inset Flex Code
9826 \begin_layout Plain Layout
9827 PackageOptions natbib square
9833 \begin_inset Quotes erd
9837 \begin_inset Flex Code
9840 \begin_layout Plain Layout
9846 to be loaded with the
9847 \begin_inset Flex Code
9850 \begin_layout Plain Layout
9857 (For \SpecialChar TeX
9858 perts, this causes \SpecialChar LyX
9860 \begin_inset Flex Code
9863 \begin_layout Plain Layout
9866 PassOptionsToPackage{natbib}{square}
9872 \begin_inset Flex Code
9875 \begin_layout Plain Layout
9884 \begin_layout Description
9885 \begin_inset Flex Code
9888 \begin_layout Plain Layout
9895 \begin_inset Flex Code
9898 \begin_layout Plain Layout
9907 \begin_inset Flex Code
9910 \begin_layout Plain Layout
9917 \begin_inset Flex Code
9920 \begin_layout Plain Layout
9926 ] The default pagestyle.
9927 Can be changed in the
9928 \begin_inset Flex MenuItem
9931 \begin_layout Plain Layout
9932 Document\SpecialChar menuseparator
9941 \begin_layout Description
9942 \begin_inset Flex Code
9945 \begin_layout Plain Layout
9951 Sets the preamble for the \SpecialChar LaTeX
9953 Note that this will completely override any prior
9954 \begin_inset Flex Code
9957 \begin_layout Plain Layout
9964 \begin_inset Flex Code
9967 \begin_layout Plain Layout
9975 \begin_inset Flex Code
9978 \begin_layout Plain Layout
9984 if you just want to add material to the preamble.) Must end with
9985 \begin_inset Quotes eld
9989 \begin_inset Flex Code
9992 \begin_layout Plain Layout
9999 \begin_inset Quotes erd
10005 \begin_layout Description
10006 \begin_inset Flex Code
10009 \begin_layout Plain Layout
10016 \begin_inset Flex Code
10019 \begin_layout Plain Layout
10026 \begin_inset Flex Code
10029 \begin_layout Plain Layout
10038 \begin_inset space \thinspace{}
10042 \begin_inset Flex Code
10045 \begin_layout Plain Layout
10051 ] Whether the class already provides the feature
10052 \begin_inset Flex Code
10055 \begin_layout Plain Layout
10062 A feature is in general the name of a package (e.
10063 \begin_inset space \thinspace{}
10067 \begin_inset space \space{}
10071 \begin_inset Flex Code
10074 \begin_layout Plain Layout
10081 \begin_inset Flex Code
10084 \begin_layout Plain Layout
10091 \begin_inset space \thinspace{}
10095 \begin_inset space \space{}
10099 \begin_inset Flex Code
10102 \begin_layout Plain Layout
10109 \begin_inset Flex Code
10112 \begin_layout Plain Layout
10120 \begin_inset CommandInset ref
10122 reference "chap:List-of-functions"
10126 for the list of features.
10129 \begin_layout Description
10130 \begin_inset Flex Code
10133 \begin_layout Plain Layout
10140 \begin_inset Flex Code
10143 \begin_layout Plain Layout
10149 ] Indicates that this layout provides the functionality of the module mentioned,
10150 which should be specified by the filename without the
10151 \begin_inset Flex Code
10154 \begin_layout Plain Layout
10161 This will typically be used if the layout includes the module directly,
10162 rather than using the
10163 \begin_inset Flex Code
10166 \begin_layout Plain Layout
10172 tag to indicate that it ought to be used.
10173 It could also be used in a module that provided an alternate implementation
10174 of the same functionality.
10177 \begin_layout Description
10178 \begin_inset Flex Code
10181 \begin_layout Plain Layout
10188 \begin_inset Flex Code
10191 \begin_layout Plain Layout
10197 ] Whether the class requires the feature
10198 \begin_inset Flex Code
10201 \begin_layout Plain Layout
10208 Multiple features must be separated by commas.
10209 Note that you can only request supported features.
10211 \begin_inset CommandInset ref
10213 reference "chap:List-of-functions"
10217 for the list of features.)
10218 \change_inserted -712698321 1438601536
10220 If you require a package with specific options, you can additionally use
10222 \begin_inset Flex Code
10225 \begin_layout Plain Layout
10227 \change_inserted -712698321 1438601526
10238 \begin_layout Description
10239 \begin_inset Flex Code
10242 \begin_layout Plain Layout
10249 \begin_inset Flex Code
10252 \begin_layout Plain Layout
10258 ] A string that indicates the width of the right margin on the screen, for
10260 \begin_inset Quotes eld
10264 \begin_inset Flex Code
10267 \begin_layout Plain Layout
10274 \begin_inset Quotes erd
10280 \begin_layout Description
10281 \begin_inset Flex Code
10284 \begin_layout Plain Layout
10291 \begin_inset Flex Code
10294 \begin_layout Plain Layout
10300 ] Sets which divisions get numbered.
10302 \begin_inset Newline newline
10306 \begin_inset Flex Code
10309 \begin_layout Plain Layout
10315 counter in \SpecialChar LaTeX
10319 \begin_layout Description
10320 \begin_inset Flex Code
10323 \begin_layout Plain Layout
10330 \begin_inset Flex Code
10333 \begin_layout Plain Layout
10342 \begin_inset space \thinspace{}
10346 \begin_inset Flex Code
10349 \begin_layout Plain Layout
10355 ] Whether the class-default should be printing on one or both sides of the
10357 Can be changed in the
10358 \begin_inset Flex MenuItem
10361 \begin_layout Plain Layout
10362 Document\SpecialChar menuseparator
10371 \begin_layout Description
10372 \begin_inset Flex Code
10375 \begin_layout Plain Layout
10382 \begin_inset Flex Code
10385 \begin_layout Plain Layout
10391 ] This sequence defines a paragraph style.
10392 If the style does not yet exist, it is created; if it does exist, its parameter
10395 \begin_inset Quotes eld
10399 \begin_inset Flex Code
10402 \begin_layout Plain Layout
10409 \begin_inset Quotes erd
10413 \begin_inset Newline newline
10417 \begin_inset CommandInset ref
10419 reference "subsec:Paragraph-Styles"
10423 for details on paragraph styles.
10426 \begin_layout Description
10427 \begin_inset Flex Code
10430 \begin_layout Plain Layout
10437 \begin_inset Flex Code
10440 \begin_layout Plain Layout
10446 ] The name of the command or environment to be used with
10447 \begin_inset Flex Code
10450 \begin_layout Plain Layout
10459 \begin_layout Description
10460 \begin_inset Flex Code
10463 \begin_layout Plain Layout
10470 \begin_inset Flex Code
10473 \begin_layout Plain Layout
10482 \begin_inset Flex Code
10485 \begin_layout Plain Layout
10491 ] Indicates what kind of markup is used to define the title of a document.
10493 \begin_inset Flex Code
10496 \begin_layout Plain Layout
10502 means that the macro with name
10503 \begin_inset Flex Code
10506 \begin_layout Plain Layout
10512 will be inserted after the last layout which has
10513 \begin_inset Quotes eld
10517 \begin_inset Flex Code
10520 \begin_layout Plain Layout
10522 \begin_inset space ~
10531 \begin_inset Quotes erd
10536 \begin_inset Flex Code
10539 \begin_layout Plain Layout
10545 corresponds to the case where all layouts which have
10546 \begin_inset Quotes eld
10550 \begin_inset Flex Code
10553 \begin_layout Plain Layout
10555 \begin_inset space ~
10564 \begin_inset Quotes erd
10567 should be enclosed into the
10568 \begin_inset Flex Code
10571 \begin_layout Plain Layout
10580 \begin_layout Description
10581 \begin_inset Flex Code
10584 \begin_layout Plain Layout
10591 \begin_inset Flex Code
10594 \begin_layout Plain Layout
10600 ] Sets which divisions are included in the table of contents.
10602 \begin_inset Flex Code
10605 \begin_layout Plain Layout
10611 counter in \SpecialChar LaTeX
10615 \begin_layout Subsection
10616 \begin_inset Flex Code
10619 \begin_layout Plain Layout
10626 \begin_inset CommandInset label
10628 name "subsec:ClassOptions"
10635 \begin_layout Standard
10637 \begin_inset Flex Code
10640 \begin_layout Plain Layout
10646 section can contain the following entries:
10649 \begin_layout Description
10650 \begin_inset Flex Code
10653 \begin_layout Plain Layout
10660 \begin_inset Flex Code
10663 \begin_layout Plain Layout
10669 ] The list of available font sizes for the document's main font, separated
10671 \begin_inset Quotes eld
10675 \begin_inset Flex Code
10678 \begin_layout Plain Layout
10685 \begin_inset Quotes erd
10691 \begin_layout Description
10692 \begin_inset Flex Code
10695 \begin_layout Plain Layout
10701 Used to set the DTD line with XML-based output classes.
10703 \begin_inset space \thinspace{}
10707 \begin_inset Quotes eld
10710 -//OASIS//DTD DocBook V4.2//EN
10711 \begin_inset Quotes erd
10717 \begin_layout Description
10718 \begin_inset Flex Code
10721 \begin_layout Plain Layout
10728 \begin_inset Flex Code
10731 \begin_layout Plain Layout
10732 string="empty|plain|headings|fancy"
10737 ] The list of available page sty\SpecialChar softhyphen
10739 \begin_inset Quotes eld
10743 \begin_inset Flex Code
10746 \begin_layout Plain Layout
10753 \begin_inset Quotes erd
10759 \begin_layout Description
10760 \begin_inset Flex Code
10763 \begin_layout Plain Layout
10770 \begin_inset Flex Code
10773 \begin_layout Plain Layout
10779 ] Some document class options, separated by a comma, that will be added
10780 to the optional part of the
10781 \begin_inset Flex Code
10784 \begin_layout Plain Layout
10795 \begin_layout Standard
10797 \begin_inset Flex Code
10800 \begin_layout Plain Layout
10806 section must end with
10807 \begin_inset Quotes eld
10811 \begin_inset Flex Code
10814 \begin_layout Plain Layout
10821 \begin_inset Quotes erd
10827 \begin_layout Subsection
10829 \begin_inset CommandInset label
10831 name "subsec:Paragraph-Styles"
10838 \begin_layout Standard
10839 A paragraph style description looks like this:
10843 \begin_layout Plain Layout
10844 Note that this will either define a new style or modify an existing one.
10852 \begin_layout LyX-Code
10859 \begin_layout LyX-Code
10863 \begin_layout LyX-Code
10867 \begin_layout Standard
10868 where the following commands are allowed:
10871 \begin_layout Description
10872 \begin_inset Flex Code
10875 \begin_layout Plain Layout
10882 \begin_inset Flex Code
10885 \begin_layout Plain Layout
10890 , left, right, center
10895 ] Paragraph alignment.
10898 \begin_layout Description
10899 \begin_inset Flex Code
10902 \begin_layout Plain Layout
10909 \begin_inset Flex Code
10912 \begin_layout Plain Layout
10917 , left, right, center
10922 ] A comma separated list of permitted alignments.
10923 (Some \SpecialChar LaTeX
10924 styles prohibit certain alignments, since those wouldn't make sense.
10925 For example a right-aligned or centered enumeration isn't possible.)
10928 \begin_layout Description
10929 \begin_inset Flex Code
10932 \begin_layout Plain Layout
10939 \begin_inset Flex Code
10942 \begin_layout Plain Layout
10948 ] Defines argument number <int> of a command\SpecialChar breakableslash
10949 environment associated with
10951 This is useful for things like section headings, and only makes sense with
10954 Every (optional or required) argument of a command or environment – except
10955 for the required argument that is associated with the content of the paragraph
10956 itself – has a separate definition, where the number specifies the order
10958 The definition must end with
10959 \begin_inset Flex Code
10962 \begin_layout Plain Layout
10969 So a command with two optional arguments has:
10970 \begin_inset Separator parbreak
10977 \begin_layout Quote
10983 \begin_layout Quote
10989 \begin_layout Quote
10995 \begin_layout Quote
11001 \begin_layout Quote
11007 \begin_layout Quote
11013 \begin_layout Standard
11015 \begin_inset Flex Code
11018 \begin_layout Plain Layout
11024 definition, the following specifications are possible:
11027 \begin_layout Itemize
11028 \begin_inset Flex Code
11031 \begin_layout Plain Layout
11038 \begin_inset Flex Code
11041 \begin_layout Plain Layout
11047 The string that will appear both in the menu (to insert this argument)
11048 and on the argument inset button (unless you also specify a separate
11049 \begin_inset Flex Code
11052 \begin_layout Plain Layout
11059 For the menu, you can define an accelerator by appending the respective
11060 character to the string, divided by
11061 \begin_inset Quotes eld
11065 \begin_inset Quotes erd
11069 \begin_inset space \thinspace{}
11073 \begin_inset space \space{}
11077 \begin_inset Quotes eld
11081 \begin_inset Flex Code
11084 \begin_layout Plain Layout
11091 \begin_inset Quotes erd
11097 \begin_layout Itemize
11098 \begin_inset Flex Code
11101 \begin_layout Plain Layout
11108 \begin_inset Flex Code
11111 \begin_layout Plain Layout
11117 A separate string for the menu.
11118 You can define an accelerator by appending the respective character to
11119 the string, divided by
11120 \begin_inset Quotes eld
11124 \begin_inset Quotes erd
11128 \begin_inset space \thinspace{}
11132 \begin_inset space \space{}
11136 \begin_inset Quotes eld
11140 \begin_inset Flex Code
11143 \begin_layout Plain Layout
11150 \begin_inset Quotes erd
11154 This specification is optional.
11155 If it is not given the
11156 \begin_inset Flex Code
11159 \begin_layout Plain Layout
11165 will be used instead for the menu.
11168 \begin_layout Itemize
11169 \begin_inset Flex Code
11172 \begin_layout Plain Layout
11179 \begin_inset Flex Code
11182 \begin_layout Plain Layout
11188 A longer explanatory text that appears in the tooltip when hovering over
11189 the argument inset.
11192 \begin_layout Itemize
11193 \begin_inset Flex Code
11196 \begin_layout Plain Layout
11203 \begin_inset Flex Code
11206 \begin_layout Plain Layout
11215 \begin_inset space \thinspace{}
11219 \begin_inset Flex Code
11222 \begin_layout Plain Layout
11228 ] Declare if this is a mandatory (1) or an optional (0) argument.
11229 Mandatory arguments will be output empty if not given, while optional arguments
11230 will not be output at all.
11231 By default, mandatory arguments are delimited by
11232 \begin_inset Flex Code
11235 \begin_layout Plain Layout
11241 , while optional arguments are delimited by
11242 \begin_inset Flex Code
11245 \begin_layout Plain Layout
11254 \begin_layout Itemize
11255 \begin_inset Flex Code
11258 \begin_layout Plain Layout
11265 \begin_inset Flex Code
11268 \begin_layout Plain Layout
11274 defines another argument (by its number) which this argument requires to
11275 be output if it is itself output.
11277 \begin_inset space \thinspace{}
11280 g., in \SpecialChar LaTeX
11281 commands, optional arguments often require previous optional arguments
11282 to be output (at least empty), as in
11283 \begin_inset Flex Code
11286 \begin_layout Plain Layout
11289 command[][argument]{text}
11295 This can be achieved by the statement
11296 \begin_inset Flex Code
11299 \begin_layout Plain Layout
11306 \begin_inset Flex Code
11309 \begin_layout Plain Layout
11318 \begin_layout Itemize
11319 \begin_inset Flex Code
11322 \begin_layout Plain Layout
11329 \begin_inset Flex Code
11332 \begin_layout Plain Layout
11338 defines a custom left delimiter (instead of
11339 \begin_inset Flex Code
11342 \begin_layout Plain Layout
11349 \begin_inset Flex Code
11352 \begin_layout Plain Layout
11359 A line break in the output can be indicated by
11360 \begin_inset Flex Code
11363 \begin_layout Plain Layout
11372 \begin_layout Itemize
11373 \begin_inset Flex Code
11376 \begin_layout Plain Layout
11383 \begin_inset Flex Code
11386 \begin_layout Plain Layout
11392 defines a custom right delimiter (instead of
11393 \begin_inset Flex Code
11396 \begin_layout Plain Layout
11403 \begin_inset Flex Code
11406 \begin_layout Plain Layout
11413 A line break in the output can be indicated by
11414 \begin_inset Flex Code
11417 \begin_layout Plain Layout
11426 \begin_layout Itemize
11427 \begin_inset Flex Code
11430 \begin_layout Plain Layout
11437 \begin_inset Flex Code
11440 \begin_layout Plain Layout
11446 defines an argument that is inserted if and only if no user-specified arguments
11448 \begin_inset space \thinspace{}
11452 \begin_inset space \space{}
11455 if no argument inset has been inserted (note that also an empty argument
11456 inset omits the DefaultArg).
11457 Multiple arguments need to be separated by comma.
11460 \begin_layout Itemize
11461 \begin_inset Flex Code
11464 \begin_layout Plain Layout
11471 \begin_inset Flex Code
11474 \begin_layout Plain Layout
11480 defines an argument that is inserted in any case (alone or in addition
11481 to user-specified arguments).
11482 Multiple arguments need to be separated by comma.
11485 \begin_layout Itemize
11486 \begin_inset Flex Code
11489 \begin_layout Plain Layout
11495 The font used for the argument content, see
11496 \begin_inset CommandInset ref
11498 reference "subsec:Font-description"
11505 \begin_layout Itemize
11506 \begin_inset Flex Code
11509 \begin_layout Plain Layout
11515 The font used for the label; see
11516 \begin_inset CommandInset ref
11518 reference "subsec:Font-description"
11525 \begin_layout Itemize
11526 \begin_inset Flex Code
11529 \begin_layout Plain Layout
11536 \begin_inset Flex Code
11539 \begin_layout Plain Layout
11544 , Minimalistic, Conglomerate
11549 ] describes the rendering style used for the inset's frame and buttons.
11552 \begin_layout Itemize
11553 \begin_inset Flex Code
11556 \begin_layout Plain Layout
11563 \begin_inset Flex Code
11566 \begin_layout Plain Layout
11573 \begin_inset Flex Code
11576 \begin_layout Plain Layout
11582 , this argument is automatically inserted when the respective style is selected.
11583 Currently, only one argument per style\SpecialChar breakableslash
11584 layout can be automatically inserted.
11585 \change_inserted -712698321 1431166542
11589 \begin_layout Itemize
11591 \change_inserted -712698321 1431166604
11592 \begin_inset Flex Code
11595 \begin_layout Plain Layout
11597 \change_inserted -712698321 1431166548
11604 \begin_inset Flex Code
11607 \begin_layout Plain Layout
11609 \change_inserted -712698321 1431166543
11616 \begin_inset Flex Code
11619 \begin_layout Plain Layout
11621 \change_inserted -712698321 1431166543
11627 , this argument will be inserted with a copy of the co-text (either selected
11628 text or the whole paragraph) as content.
11631 \begin_layout Itemize
11633 \change_inserted -712698321 1431070588
11634 \begin_inset Flex Code
11637 \begin_layout Plain Layout
11639 \change_inserted -712698321 1431070522
11646 \begin_inset Flex Code
11649 \begin_layout Plain Layout
11651 \change_inserted -712698321 1431070522
11652 string of characters
11661 Defines individual characters that should be output in raw form, meaning
11662 without special translations that \SpecialChar LaTeX
11664 Note that, contrary to PassThru, this needs to be explicitly defined for
11666 That is, arguments do not inherit PassThruChars from their parent inset
11672 \begin_layout Standard
11673 By default, the text entered in the \SpecialChar LyX
11674 workarea in the respective layout is
11675 the last (mandatory) argument of a command if the
11676 \begin_inset Flex Code
11679 \begin_layout Plain Layout
11686 \begin_inset Flex Code
11689 \begin_layout Plain Layout
11696 However, arguments with the prefix
11697 \begin_inset Flex Code
11700 \begin_layout Plain Layout
11706 are output after this workarea argument.
11707 Note that post-argument numbering restarts at 1, so the first argument
11708 following the workarea argument is
11709 \begin_inset Flex Code
11712 \begin_layout Plain Layout
11719 Post-arguments are ignored in any other
11720 \begin_inset Flex Code
11723 \begin_layout Plain Layout
11730 \begin_inset Flex Code
11733 \begin_layout Plain Layout
11742 \begin_layout Standard
11744 \begin_inset Flex Code
11747 \begin_layout Plain Layout
11756 \begin_inset Flex Code
11759 \begin_layout Plain Layout
11768 \begin_inset Flex Code
11771 \begin_layout Plain Layout
11777 followed by the number (e.
11778 \begin_inset space \thinspace{}
11782 \begin_inset space \space{}
11786 \begin_inset Flex Code
11789 \begin_layout Plain Layout
11799 \begin_layout Description
11800 \begin_inset Flex Code
11803 \begin_layout Plain Layout
11809 Note that this will completely override any prior
11810 \begin_inset Flex Code
11813 \begin_layout Plain Layout
11819 declaration for this style.
11821 \begin_inset Quotes eld
11825 \begin_inset Flex Code
11828 \begin_layout Plain Layout
11835 \begin_inset Quotes erd
11840 \begin_inset CommandInset ref
11842 reference "subsec:I18n"
11846 for details on its use.
11849 \begin_layout Description
11850 \begin_inset Flex Code
11853 \begin_layout Plain Layout
11860 \begin_inset Flex Code
11863 \begin_layout Plain Layout
11873 \begin_layout Plain Layout
11874 Note that a `float' here is a real number, such as: 1.5.
11879 The vertical space with which the last of a chain of paragraphs with this
11880 style is separated from the following paragraph.
11881 If the next paragraph has another style, the separations are not simply
11882 added, but the maximum is taken.
11885 \begin_layout Description
11886 \begin_inset Flex Code
11889 \begin_layout Plain Layout
11896 \begin_inset Flex Code
11899 \begin_layout Plain Layout
11905 ] The category for this style.
11906 This is used to group related styles in the style combobox on the toolbar.
11907 Any string can be used, but you may want to use existing categories with
11912 \begin_layout Description
11913 \begin_inset Flex Code
11916 \begin_layout Plain Layout
11922 Depth of XML command.
11923 Used only with XML-type formats.
11926 \begin_layout Description
11927 \begin_inset Flex Code
11930 \begin_layout Plain Layout
11937 \begin_inset Flex Code
11940 \begin_layout Plain Layout
11946 ] Copies all the features of an existing style into the current one.
11950 \begin_layout Description
11951 \begin_inset Flex Code
11954 \begin_layout Plain Layout
11961 \begin_inset Flex Code
11964 \begin_layout Plain Layout
11970 ] The name of a style whose preamble should be output
11975 This allows to ensure some ordering of the preamble snippets when macros
11976 definitions depend on one another.
11980 \begin_layout Plain Layout
11981 Note that, besides that functionality, there is no way to ensure any ordering
11983 The ordering that you see in a given version of \SpecialChar LyX
11984 may change without warning
11993 \begin_layout Description
11994 \begin_inset Flex Code
11997 \begin_layout Plain Layout
12004 \begin_inset Flex Code
12007 \begin_layout Plain Layout
12012 , Box, Filled_Box, Static
12017 ] The type of label that stands at the end of the paragraph (or sequence
12019 \begin_inset Flex Code
12022 \begin_layout Plain Layout
12029 \begin_inset Newline newline
12033 \begin_inset Flex Code
12036 \begin_layout Plain Layout
12043 \begin_inset Flex Code
12046 \begin_layout Plain Layout
12053 \begin_inset Flex Code
12056 \begin_layout Plain Layout
12064 \begin_inset Flex Code
12067 \begin_layout Plain Layout
12074 \begin_inset Quotes eld
12078 \begin_inset Quotes erd
12082 \begin_inset Flex Code
12085 \begin_layout Plain Layout
12092 \begin_inset space \space{}
12096 \begin_inset Flex Code
12099 \begin_layout Plain Layout
12105 ) is a white (resp.
12106 \begin_inset space ~
12109 black) square suitable for end of proof markers,
12110 \begin_inset Flex Code
12113 \begin_layout Plain Layout
12119 is an explicit text string.
12122 \begin_layout Description
12123 \begin_inset Flex Code
12126 \begin_layout Plain Layout
12133 \begin_inset Flex Code
12136 \begin_layout Plain Layout
12142 ] The string used for a label with a
12143 \begin_inset Flex Code
12146 \begin_layout Plain Layout
12153 \begin_inset Newline newline
12157 \begin_inset Flex Code
12160 \begin_layout Plain Layout
12170 \begin_layout Description
12171 \begin_inset Flex Code
12174 \begin_layout Plain Layout
12180 The font used for both the text body
12186 \begin_inset CommandInset ref
12188 reference "subsec:Font-description"
12193 Note that defining this font automatically defines the
12194 \begin_inset Flex Code
12197 \begin_layout Plain Layout
12204 So you should define this one first if you also want to define
12205 \begin_inset Flex Code
12208 \begin_layout Plain Layout
12217 \begin_layout Description
12218 \begin_inset Flex Code
12221 \begin_layout Plain Layout
12228 \begin_inset Flex Code
12231 \begin_layout Plain Layout
12237 ] Used for backporting new styles to stable \SpecialChar LyX
12239 The first stable version that supports this tag is \SpecialChar LyX
12241 The argument is a number which may either be 0, -1 or any value greater
12244 \begin_inset Flex Code
12247 \begin_layout Plain Layout
12253 flag of a style is greater than zero, it will always be written to the
12255 If a .lyx file is read, the style definitions from the document header are
12256 added to the document class.
12257 Therefore even older \SpecialChar LyX
12258 versions can handle the style.
12260 \begin_inset Flex Code
12263 \begin_layout Plain Layout
12269 is a version number: If the style is read, and the version number is less
12270 than the version number of the already existing style in the document class,
12271 the new style is ignored.
12272 If the version number is greater, the new style replaces the existing style.
12273 A value of -1 means an infinite version number, i.
12274 \begin_inset space \thinspace{}
12278 \begin_inset space \space{}
12281 the style is always used.
12284 \begin_layout Description
12285 \begin_inset Flex Code
12288 \begin_layout Plain Layout
12295 \begin_inset Flex Code
12298 \begin_layout Plain Layout
12307 \begin_inset space \thinspace{}
12311 \begin_inset Flex Code
12314 \begin_layout Plain Layout
12320 ] Usually \SpecialChar LyX
12321 does not allow you to insert more than one space between words,
12322 since a space is considered as the separation between two words, not a
12323 character or symbol of its own.
12324 This is a very fine thing but sometimes annoying, for example, when typing
12325 program code or plain \SpecialChar LaTeX
12328 \begin_inset Flex Code
12331 \begin_layout Plain Layout
12338 Note that \SpecialChar LyX
12339 will create protected blanks for the additional blanks when
12340 in another mode than \SpecialChar LaTeX
12344 \begin_layout Description
12345 \begin_inset Flex Code
12348 \begin_layout Plain Layout
12354 These tags are used with XHTML output.
12356 \begin_inset CommandInset ref
12358 reference "subsec:Paragraph-Style-XHTML"
12365 \begin_layout Description
12366 \begin_inset Flex Code
12369 \begin_layout Plain Layout
12375 [FIXME] (Used only with XML-type formats.)
12378 \begin_layout Description
12379 \begin_inset Flex Code
12382 \begin_layout Plain Layout
12389 \begin_inset Flex Code
12392 \begin_layout Plain Layout
12401 \begin_inset space \thinspace{}
12405 \begin_inset Flex Code
12408 \begin_layout Plain Layout
12415 \begin_inset Flex Code
12418 \begin_layout Plain Layout
12424 , marks the style as to be included in the document preamble and not in
12426 This is useful for document classes that want such information as the title
12427 and author to appear in the preamble.
12428 Note that this works only for styles for which the
12429 \begin_inset Flex Code
12432 \begin_layout Plain Layout
12439 \begin_inset Flex Code
12442 \begin_layout Plain Layout
12449 \begin_inset Flex Code
12452 \begin_layout Plain Layout
12461 \begin_layout Description
12462 \begin_inset Flex Code
12465 \begin_layout Plain Layout
12472 \begin_inset Flex Code
12475 \begin_layout Plain Layout
12484 \begin_inset space \thinspace{}
12488 \begin_inset Flex Code
12491 \begin_layout Plain Layout
12498 \begin_inset Flex Code
12501 \begin_layout Plain Layout
12507 , marks the style as being part of a title block (see also the
12508 \begin_inset Flex Code
12511 \begin_layout Plain Layout
12518 \begin_inset Flex Code
12521 \begin_layout Plain Layout
12530 \begin_layout Description
12531 \begin_inset Flex Code
12534 \begin_layout Plain Layout
12541 \begin_inset Flex Code
12544 \begin_layout Plain Layout
12550 ] The \SpecialChar LaTeX
12551 command sequence declaring an item in a list.
12552 The command is to be defined without the preceding backslash (the default
12554 \begin_inset Quotes eld
12558 \begin_inset Quotes erd
12562 \begin_inset Flex Code
12565 \begin_layout Plain Layout
12573 in the \SpecialChar LaTeX
12577 \begin_layout Description
12578 \begin_inset Flex Code
12581 \begin_layout Plain Layout
12588 \begin_inset Flex Code
12591 \begin_layout Plain Layout
12597 ] This provides extra space between paragraphs that have the same style.
12598 If you put other styles into an environment, each is separated with the
12600 \begin_inset Flex Code
12603 \begin_layout Plain Layout
12610 But the whole items of the environment are additionally separated with
12612 \begin_inset Flex Code
12615 \begin_layout Plain Layout
12622 Note that this is a
12627 \begin_layout Description
12628 \begin_inset Flex Code
12631 \begin_layout Plain Layout
12637 [FIXME] (Used only with XML-type formats.)
12640 \begin_layout Description
12641 \begin_inset Flex Code
12644 \begin_layout Plain Layout
12651 \begin_inset Flex Code
12654 \begin_layout Plain Layout
12663 \begin_inset space \thinspace{}
12667 \begin_inset Flex Code
12670 \begin_layout Plain Layout
12676 ] Usually \SpecialChar LyX
12677 does not allow you to leave a paragraph empty, since it would
12678 lead to empty \SpecialChar LaTeX
12680 There are some cases where this could be desirable however: in a letter
12681 template, the required fields can be provided as empty fields, so that
12682 people do not forget them; in some special classes, a style can be used
12683 as some kind of break, which does not contain actual text.
12686 \begin_layout Description
12687 \begin_inset Flex Code
12690 \begin_layout Plain Layout
12697 \begin_inset Flex Code
12700 \begin_layout Plain Layout
12706 ] The vertical space between the label and the text body.
12707 Only used for labels that are above the text body (
12708 \begin_inset Flex Code
12711 \begin_layout Plain Layout
12718 \begin_inset Newline newline
12722 \begin_inset Flex Code
12725 \begin_layout Plain Layout
12726 Centered_Top_Environment
12734 \begin_layout Description
12735 \begin_inset Flex Code
12738 \begin_layout Plain Layout
12745 \begin_inset Flex Code
12748 \begin_layout Plain Layout
12754 ] The name of the counter for automatic numbering.
12755 In order to have the counter appear with your label, you will need to reference
12757 \begin_inset Flex Code
12760 \begin_layout Plain Layout
12769 This will work with
12770 \begin_inset Flex Code
12773 \begin_layout Plain Layout
12780 \begin_inset Flex Code
12783 \begin_layout Plain Layout
12790 \begin_inset Flex Code
12793 \begin_layout Plain Layout
12800 \begin_inset Flex Code
12803 \begin_layout Plain Layout
12810 \begin_inset Newline newline
12818 \begin_inset Flex Code
12821 \begin_layout Plain Layout
12828 \begin_inset Flex Code
12831 \begin_layout Plain Layout
12837 , though this case is a bit complicated.
12838 Suppose you declare
12839 \begin_inset Quotes eld
12843 \begin_inset Flex Code
12846 \begin_layout Plain Layout
12847 LabelCounter myenum
12853 \begin_inset Quotes erd
12857 Then the actual counters used are
12858 \begin_inset Flex Code
12861 \begin_layout Plain Layout
12868 \begin_inset Flex Code
12871 \begin_layout Plain Layout
12878 \begin_inset Flex Code
12881 \begin_layout Plain Layout
12888 \begin_inset Flex Code
12891 \begin_layout Plain Layout
12897 , much as in \SpecialChar LaTeX
12899 These counters must all be declared separately.
12900 \begin_inset Newline newline
12904 \begin_inset CommandInset ref
12906 reference "subsec:Counters"
12910 for details on counters.
12913 \begin_layout Description
12914 \begin_inset Flex Code
12917 \begin_layout Plain Layout
12923 The font used for the label.
12925 \begin_inset CommandInset ref
12927 reference "subsec:Font-description"
12934 \begin_layout Description
12935 \begin_inset Flex Code
12938 \begin_layout Plain Layout
12945 \begin_inset Flex Code
12948 \begin_layout Plain Layout
12954 ] Text that indicates how far a label should be indented.
12957 \begin_layout Description
12958 \begin_inset Flex Code
12961 \begin_layout Plain Layout
12968 \begin_inset Flex Code
12971 \begin_layout Plain Layout
12977 ] Text that indicates the amount of horizontal space between the label and
12979 Only used for labels that are not above the text body.
12982 \begin_layout Description
12983 \begin_inset Flex Code
12986 \begin_layout Plain Layout
12993 \begin_inset Flex Code
12996 \begin_layout Plain Layout
13002 ] The string used for the label.
13004 \begin_inset Flex Code
13007 \begin_layout Plain Layout
13013 is set, this string can be contain the special formatting commands described
13015 \begin_inset CommandInset ref
13017 reference "subsec:Counters"
13024 \begin_layout Description
13025 \begin_inset Flex Code
13028 \begin_layout Plain Layout
13029 LabelStringAppendix
13035 \begin_inset Flex Code
13038 \begin_layout Plain Layout
13044 ] This is used inside the appendix instead of
13045 \begin_inset Newline newline
13049 \begin_inset Flex Code
13052 \begin_layout Plain Layout
13060 \begin_inset Flex Code
13063 \begin_layout Plain Layout
13070 \begin_inset Newline newline
13074 \begin_inset Flex Code
13077 \begin_layout Plain Layout
13078 LabelStringAppendix
13086 \begin_layout Description
13087 \begin_inset Flex Code
13090 \begin_layout Plain Layout
13096 [FIXME] (Used only with XML-type formats.)
13099 \begin_layout Description
13100 \begin_inset Flex Code
13103 \begin_layout Plain Layout
13110 \begin_inset Flex Code
13113 \begin_layout Plain Layout
13118 , Manual, Static, Above,
13119 \begin_inset Newline newline
13122 Centered, Sensitive, Enumerate,
13123 \begin_inset Newline newline
13126 Itemize, Bibliography
13132 \begin_inset Separator parbreak
13139 \begin_layout Description
13140 \begin_inset Flex Code
13143 \begin_layout Plain Layout
13149 means the label is the very first word (up to the first real blank).
13150 Use protected spaces if you want more than one word as the label.
13154 \begin_layout Description
13155 \begin_inset Flex Code
13158 \begin_layout Plain Layout
13164 means the label is simply what is declared as
13165 \begin_inset Flex Code
13168 \begin_layout Plain Layout
13175 This will be displayed
13176 \begin_inset Quotes eld
13180 \begin_inset Quotes erd
13183 , at the beginning of the paragraph.
13185 \begin_inset Flex Code
13188 \begin_layout Plain Layout
13195 \begin_inset Flex Code
13198 \begin_layout Plain Layout
13204 , then it will be displayed only in the first paragraph of any sequence
13205 of paragraphs with the same
13206 \begin_inset Flex Code
13209 \begin_layout Plain Layout
13218 \begin_layout Description
13219 \begin_inset Flex Code
13222 \begin_layout Plain Layout
13229 \begin_inset space ~
13233 \begin_inset space ~
13237 \begin_inset Flex Code
13240 \begin_layout Plain Layout
13246 are special cases of
13247 \begin_inset Flex Code
13250 \begin_layout Plain Layout
13257 The label will be printed above the paragraph either at the beginning of
13258 the line or centered.
13261 \begin_layout Description
13262 \begin_inset Flex Code
13265 \begin_layout Plain Layout
13271 is a special case for the caption-labels
13272 \begin_inset Quotes eld
13276 \begin_inset Quotes erd
13280 \begin_inset Quotes eld
13284 \begin_inset Quotes erd
13288 \begin_inset Newline newline
13292 \begin_inset Flex Code
13295 \begin_layout Plain Layout
13301 means the (hardcoded) label string depends on the kind of float: It is
13302 hardcoded to be `FloatType N', where N is the value of the counter associated
13304 For the case that a caption is inserted outside of a float the
13305 \begin_inset Flex Code
13308 \begin_layout Plain Layout
13315 \begin_inset Quotes eld
13319 \begin_inset Quotes erd
13325 \begin_layout Description
13326 \begin_inset Flex Code
13329 \begin_layout Plain Layout
13335 produces the usual sort of enumeration labels.
13336 At present, it is hardcoded to use Arabic numerals, lowercase letters,
13337 small Roman numerals, and uppercase letters for the four possible depths.
13340 \begin_layout Description
13341 \begin_inset Flex Code
13344 \begin_layout Plain Layout
13350 produces various bullets at the different levels.
13351 It is also hardcoded.
13354 \begin_layout Description
13355 \begin_inset Flex Code
13358 \begin_layout Plain Layout
13364 should be used only with
13365 \begin_inset Flex Code
13368 \begin_layout Plain Layout
13369 LatexType BibEnvironment
13378 \begin_layout Description
13379 \begin_inset Flex Code
13382 \begin_layout Plain Layout
13388 Note that this will completely override any prior
13389 \begin_inset Flex Code
13392 \begin_layout Plain Layout
13398 declaration for this style.
13400 \begin_inset Quotes eld
13404 \begin_inset Flex Code
13407 \begin_layout Plain Layout
13414 \begin_inset Quotes erd
13419 \begin_inset CommandInset ref
13421 reference "subsec:I18n"
13425 for details on its use.
13428 \begin_layout Description
13429 \begin_inset Flex Code
13432 \begin_layout Plain Layout
13439 \begin_inset Flex Code
13442 \begin_layout Plain Layout
13448 ] The name of the corresponding \SpecialChar LaTeX
13450 Either the environment or command name.
13453 \begin_layout Description
13454 \begin_inset Flex Code
13457 \begin_layout Plain Layout
13464 \begin_inset Flex Code
13467 \begin_layout Plain Layout
13473 ] An optional parameter for the corresponding
13474 \begin_inset Flex Code
13477 \begin_layout Plain Layout
13484 This parameter cannot be changed from within \SpecialChar LyX
13486 \begin_inset Flex Code
13489 \begin_layout Plain Layout
13495 for customizable parameters).
13496 This will be output as is after all \SpecialChar LaTeX
13498 \begin_inset Flex Code
13501 \begin_layout Plain Layout
13510 \begin_layout Description
13511 \begin_inset Flex Code
13514 \begin_layout Plain Layout
13521 \begin_inset Flex Code
13524 \begin_layout Plain Layout
13529 , Command, Environment, Item_Environment,
13530 \begin_inset Newline newline
13533 List_Environment, Bib_Environment
13538 ] How the style should be translated into \SpecialChar LaTeX
13543 \begin_layout Plain Layout
13544 \begin_inset Flex Code
13547 \begin_layout Plain Layout
13553 is perhaps a bit misleading, since these rules apply to SGML classes, too.
13554 Visit the SGML class files for specific examples.
13560 \begin_inset Separator parbreak
13567 \begin_layout Description
13568 \begin_inset Flex Code
13571 \begin_layout Plain Layout
13577 means nothing special.
13580 \begin_layout Description
13581 \begin_inset Flex Code
13584 \begin_layout Plain Layout
13591 \begin_inset Flex Code
13594 \begin_layout Plain Layout
13601 {\SpecialChar ldots
13610 \begin_layout Description
13611 \begin_inset Flex Code
13614 \begin_layout Plain Layout
13621 \begin_inset Flex Code
13624 \begin_layout Plain Layout
13631 }\SpecialChar ldots
13647 \begin_layout Description
13648 \begin_inset Flex Code
13651 \begin_layout Plain Layout
13658 \begin_inset Flex Code
13661 \begin_layout Plain Layout
13668 \begin_inset Flex Code
13671 \begin_layout Plain Layout
13679 is generated for each paragraph of this environment.
13683 \begin_layout Description
13684 \begin_inset Flex Code
13687 \begin_layout Plain Layout
13694 \begin_inset Flex Code
13697 \begin_layout Plain Layout
13704 \begin_inset Newline newline
13708 \begin_inset Flex Code
13711 \begin_layout Plain Layout
13717 is passed as an argument to the environment.
13718 \begin_inset Newline newline
13722 \begin_inset Flex Code
13725 \begin_layout Plain Layout
13731 can be defined in the
13732 \begin_inset Flex MenuItem
13735 \begin_layout Plain Layout
13736 Edit\SpecialChar menuseparator
13738 \begin_inset space ~
13749 \begin_layout Description
13750 \begin_inset Flex Code
13753 \begin_layout Plain Layout
13760 \begin_inset Flex Code
13763 \begin_layout Plain Layout
13769 but adds additionally the necessary mandatory argument (the longest label)
13770 to the begin statement of the bibliography environment:
13771 \begin_inset Newline newline
13775 \begin_inset Flex Code
13778 \begin_layout Plain Layout
13781 begin{thebibliography}{99}
13786 It is therefore only useful for bibliography environments.
13787 The default longest label
13788 \begin_inset Quotes eld
13792 \begin_inset Quotes erd
13795 can be changed by the user in the paragraph settings of a bibliography
13799 \begin_layout Standard
13800 Putting the last few things together, the \SpecialChar LaTeX
13801 output will be either:
13804 \begin_layout LyX-Code
13807 LatexName[LatexParam]{\SpecialChar ldots
13811 \begin_layout Standard
13815 \begin_layout LyX-Code
13818 begin{LatexName}[LatexParam] \SpecialChar ldots
13824 \begin_layout Standard
13825 depending upon the \SpecialChar LaTeX
13830 \begin_layout Description
13831 \begin_inset Flex Code
13834 \begin_layout Plain Layout
13841 \begin_inset Flex Code
13844 \begin_layout Plain Layout
13850 ] A string that is put at the beginning of the style content.
13851 A line break in the output can be indicated by
13852 \begin_inset Flex Code
13855 \begin_layout Plain Layout
13864 \begin_layout Description
13865 \begin_inset Flex Code
13868 \begin_layout Plain Layout
13875 \begin_inset Flex Code
13878 \begin_layout Plain Layout
13884 ] If you put styles into environments, the different
13885 \begin_inset Flex Code
13888 \begin_layout Plain Layout
13894 are not simply added, but added with a factor
13895 \begin_inset Formula $\frac{4}{\mathrm{depth}+4}$
13899 Note that this parameter is also used when
13900 \begin_inset Flex Code
13903 \begin_layout Plain Layout
13910 \begin_inset Flex Code
13913 \begin_layout Plain Layout
13920 \begin_inset Flex Code
13923 \begin_layout Plain Layout
13930 Then it is added to the manual or dynamic margin.
13931 \begin_inset Newline newline
13935 \begin_inset Quotes eld
13939 \begin_inset Flex Code
13942 \begin_layout Plain Layout
13949 \begin_inset Quotes erd
13952 means that the paragraph is indented with the width of
13953 \begin_inset Quotes eld
13957 \begin_inset Flex Code
13960 \begin_layout Plain Layout
13967 \begin_inset Quotes erd
13970 in the normal font.
13971 You can get a negative width by prefixing the string with
13972 \begin_inset Quotes eld
13976 \begin_inset Flex Code
13979 \begin_layout Plain Layout
13986 \begin_inset Quotes erd
13990 This way was chosen so that the look is the same with each used screen
13994 \begin_layout Description
13995 \begin_inset Flex Code
13998 \begin_layout Plain Layout
14005 \begin_inset Flex Code
14008 \begin_layout Plain Layout
14013 , Manual, Dynamic, First_Dynamic, Right_Address_Box
14019 \begin_inset Newline newline
14022 The kind of margin that the style has on the left side.
14023 \begin_inset Separator parbreak
14030 \begin_layout Description
14031 \begin_inset Flex Code
14034 \begin_layout Plain Layout
14040 just means a fixed margin.
14043 \begin_layout Description
14044 \begin_inset Flex Code
14047 \begin_layout Plain Layout
14053 means that the left margin depends on the string entered in the
14054 \begin_inset Flex MenuItem
14057 \begin_layout Plain Layout
14058 Edit\SpecialChar menuseparator
14060 \begin_inset space ~
14069 This is used to typeset nice lists without tabulators.
14072 \begin_layout Description
14073 \begin_inset Flex Code
14076 \begin_layout Plain Layout
14082 means that the margin depends on the size of the label.
14083 This is used for automatic enumerated headlines.
14084 It is obvious that the headline
14085 \begin_inset Quotes eld
14088 5.4.3.2.1 Very long headline
14089 \begin_inset Quotes erd
14092 must have a wider left margin (as wide as
14093 \begin_inset Quotes eld
14097 \begin_inset Quotes erd
14100 plus the space) than
14101 \begin_inset Quotes eld
14104 3.2 Very long headline
14105 \begin_inset Quotes erd
14109 \begin_inset Quotes eld
14113 \begin_inset Quotes erd
14116 are not able to do this.
14119 \begin_layout Description
14120 \begin_inset Flex Code
14123 \begin_layout Plain Layout
14129 is similar, but only the very first row of the paragraph is dynamic, while
14130 the others are static; this is used, for example, for descriptions.
14133 \begin_layout Description
14134 \begin_inset Flex Code
14137 \begin_layout Plain Layout
14143 means the margin is chosen in a way that the longest row of this paragraph
14144 fits to the right margin.
14145 This is used to typeset an address on the right edge of the page.
14149 \begin_layout Description
14150 \begin_inset Flex Code
14153 \begin_layout Plain Layout
14160 \begin_inset Flex Code
14163 \begin_layout Plain Layout
14172 \begin_inset space \thinspace{}
14176 \begin_inset Flex Code
14179 \begin_layout Plain Layout
14185 ] Whether fragile commands in this style should be
14186 \begin_inset Flex Code
14189 \begin_layout Plain Layout
14202 whether this command should itself be protected.)
14205 \begin_layout Description
14206 \begin_inset Flex Code
14209 \begin_layout Plain Layout
14216 \begin_inset Flex Code
14219 \begin_layout Plain Layout
14226 \begin_inset space \thinspace{}
14230 \begin_inset Flex Code
14233 \begin_layout Plain Layout
14241 ] Whether newlines are translated into \SpecialChar LaTeX
14243 \begin_inset Flex Code
14246 \begin_layout Plain Layout
14257 The translation can be switched off to allow more comfortable \SpecialChar LaTeX
14259 inside \SpecialChar LyX
14263 \begin_layout Description
14264 \begin_inset Flex Code
14267 \begin_layout Plain Layout
14274 \begin_inset Flex Code
14277 \begin_layout Plain Layout
14286 \begin_inset space \thinspace{}
14290 \begin_inset Flex Code
14293 \begin_layout Plain Layout
14299 ] If set to true, and if
14300 \begin_inset Flex Code
14303 \begin_layout Plain Layout
14310 \begin_inset Flex Code
14313 \begin_layout Plain Layout
14319 ) paragraphs are being indented, then the indentation of such a paragraph
14320 following one of this type will be suppressed.
14321 (So this will not affect the display of non-default paragraphs.)
14324 \begin_layout Description
14325 \begin_inset Flex Code
14328 \begin_layout Plain Layout
14335 \begin_inset Flex Code
14338 \begin_layout Plain Layout
14344 ] Name of a style that has replaced this style.
14345 This is used to rename a style, while keeping backward compatibility.
14346 \change_inserted -712698321 1432986397
14350 \begin_layout Description
14352 \change_inserted -712698321 1432986583
14353 \begin_inset Flex Code
14356 \begin_layout Plain Layout
14358 \change_inserted -712698321 1432986403
14365 \begin_inset Flex Code
14368 \begin_layout Plain Layout
14370 \change_inserted -712698321 1432986397
14377 \begin_inset space \thinspace{}
14381 \begin_inset Flex Code
14384 \begin_layout Plain Layout
14386 \change_inserted -712698321 1432986397
14392 ] Determines whether consecutive pragraphs of the same type are treated
14393 as belonging together.
14394 This has the effect that the
14395 \begin_inset Flex Code
14398 \begin_layout Plain Layout
14400 \change_inserted -712698321 1432986460
14406 is only printed once before such a group.
14407 By default, this is true for
14408 \begin_inset Flex Code
14411 \begin_layout Plain Layout
14413 \change_inserted -712698321 1432986491
14420 \begin_inset Flex Code
14423 \begin_layout Plain Layout
14425 \change_inserted -712698321 1432986583
14434 \begin_inset Flex Code
14437 \begin_layout Plain Layout
14439 \change_inserted -712698321 1432986572
14447 and false for all other types.
14452 \begin_layout Description
14453 \begin_inset Flex Code
14456 \begin_layout Plain Layout
14463 \begin_inset Flex Code
14466 \begin_layout Plain Layout
14475 \begin_inset space \thinspace{}
14479 \begin_inset Flex Code
14482 \begin_layout Plain Layout
14488 ] Indicates that paragraphs will not be separated by an empty line in \SpecialChar LaTeX
14490 but only by a line break; together with
14491 \begin_inset Flex Code
14494 \begin_layout Plain Layout
14500 , this allows to emulate a plain text editor (like the ERT inset).
14503 \begin_layout Description
14504 \begin_inset Flex Code
14507 \begin_layout Plain Layout
14514 \begin_inset Flex Code
14517 \begin_layout Plain Layout
14523 ] The indent of the very first line of a paragraph.
14525 \begin_inset Newline newline
14529 \begin_inset Flex Code
14532 \begin_layout Plain Layout
14538 will be fixed for a certain style.
14539 The exception is the default style, since the indentation for these paragraphs
14540 can be prohibited with
14541 \begin_inset Flex Code
14544 \begin_layout Plain Layout
14552 \begin_inset Flex Code
14555 \begin_layout Plain Layout
14561 style paragraphs inside environments use the
14562 \begin_inset Flex Code
14565 \begin_layout Plain Layout
14571 of the environment, not their native one.
14573 \begin_inset Flex Code
14576 \begin_layout Plain Layout
14582 paragraphs inside an enumeration are not indented.
14585 \begin_layout Description
14586 \begin_inset Flex Code
14589 \begin_layout Plain Layout
14596 \begin_inset Flex Code
14599 \begin_layout Plain Layout
14605 ] The vertical space between two paragraphs of this style.
14608 \begin_layout Description
14609 \begin_inset Flex Code
14612 \begin_layout Plain Layout
14619 \begin_inset Flex Code
14622 \begin_layout Plain Layout
14629 allows the user to choose either
14630 \begin_inset Quotes eld
14634 \begin_inset Quotes erd
14638 \begin_inset Quotes eld
14642 \begin_inset Quotes erd
14645 to separate paragraphs.
14647 \begin_inset Quotes eld
14651 \begin_inset Quotes erd
14655 \begin_inset Flex Code
14658 \begin_layout Plain Layout
14666 \begin_inset Quotes eld
14670 \begin_inset Quotes erd
14674 \begin_inset Flex Code
14677 \begin_layout Plain Layout
14683 is ignored and all paragraphs are separated by the
14684 \begin_inset Flex Code
14687 \begin_layout Plain Layout
14694 The vertical space is calculated with
14695 \begin_inset Flex Code
14698 \begin_layout Plain Layout
14700 \begin_inset space ~
14709 \begin_inset Flex Code
14712 \begin_layout Plain Layout
14718 is the height of a row with the normal font.
14719 This way, the look stays the same with different screen fonts.
14722 \begin_layout Description
14723 \begin_inset Flex Code
14726 \begin_layout Plain Layout
14733 \begin_inset Flex Code
14736 \begin_layout Plain Layout
14745 \begin_inset space \thinspace{}
14749 \begin_inset Flex Code
14752 \begin_layout Plain Layout
14758 ] Whether the contents of this paragraph should be output in raw form, meaning
14759 without special translations that \SpecialChar LaTeX
14761 \change_inserted 155139281 1429534178
14765 \begin_layout Description
14767 \change_inserted 155139281 1429534242
14770 \begin_inset Flex Code
14773 \begin_layout Plain Layout
14775 \change_inserted 155139281 1429534178
14784 \begin_inset Flex Code
14787 \begin_layout Plain Layout
14789 \change_inserted 155139281 1429534178
14790 string of characters
14799 Defines individual characters that should be output in raw form, meaning
14800 without special translations that \SpecialChar LaTeX
14806 \begin_layout Description
14807 \begin_inset Flex Code
14810 \begin_layout Plain Layout
14816 Information to be included in the \SpecialChar LaTeX
14817 preamble when this style is used.
14818 Used to define macros, load packages, etc., required by this particular
14821 \begin_inset Quotes eld
14825 \begin_inset Flex Code
14828 \begin_layout Plain Layout
14835 \begin_inset Quotes erd
14841 \begin_layout Description
14842 \begin_inset Flex Code
14845 \begin_layout Plain Layout
14852 \begin_inset Flex Code
14855 \begin_layout Plain Layout
14861 ] The prefix to use when creating labels referring to paragraphs of this
14863 This allows the use of formatted references.
14866 \begin_layout Description
14867 \begin_inset Flex Code
14870 \begin_layout Plain Layout
14877 \begin_inset Flex Code
14880 \begin_layout Plain Layout
14886 ] Whether the style requires the feature
14887 \begin_inset Flex Code
14890 \begin_layout Plain Layout
14897 \change_deleted -712698321 1438601713
14902 \change_deleted -712698321 1438601638
14903 See the description of
14904 \begin_inset Flex Code
14907 \begin_layout Plain Layout
14914 \begin_inset CommandInset ref
14916 reference "subsec:General-text-class"
14920 ) for information on `features'.
14921 \change_inserted -712698321 1438601711
14923 \begin_inset CommandInset ref
14925 reference "chap:List-of-functions"
14929 for the list of features).
14930 If you require a package with specific options, you can additionally use
14932 \begin_inset Flex Code
14935 \begin_layout Plain Layout
14937 \change_inserted -712698321 1438601638
14943 as a general text class parameter (see sec.
14944 \begin_inset space ~
14948 \begin_inset CommandInset ref
14950 reference "subsec:General-text-class"
14959 \begin_layout Description
14960 \begin_inset Flex Code
14963 \begin_layout Plain Layout
14970 \begin_inset Flex Code
14973 \begin_layout Plain Layout
14982 \begin_inset Flex Code
14985 \begin_layout Plain Layout
14991 ] Resets the \SpecialChar LaTeX
14992 arguments of this style (as defined via the
14993 \begin_inset Flex Code
14996 \begin_layout Plain Layout
15003 This is useful if you have copied a style via
15004 \begin_inset Flex Code
15007 \begin_layout Plain Layout
15013 , but you do not want to inherit its (required and optional) arguments.
15016 \begin_layout Description
15017 \begin_inset Flex Code
15020 \begin_layout Plain Layout
15027 \begin_inset Flex Code
15030 \begin_layout Plain Layout
15036 ] A string that is put at the end of the layout content.
15037 A line break in the output can be indicated by
15038 \begin_inset Flex Code
15041 \begin_layout Plain Layout
15050 \begin_layout Description
15051 \begin_inset Flex Code
15054 \begin_layout Plain Layout
15061 \begin_inset Flex Code
15064 \begin_layout Plain Layout
15071 \begin_inset Flex Code
15074 \begin_layout Plain Layout
15083 \begin_layout Description
15084 \begin_inset Flex Code
15087 \begin_layout Plain Layout
15094 \begin_inset Flex Code
15097 \begin_layout Plain Layout
15106 \begin_inset Flex Code
15109 \begin_layout Plain Layout
15116 \begin_inset Flex Code
15119 \begin_layout Plain Layout
15126 \begin_inset Flex Code
15129 \begin_layout Plain Layout
15131 \begin_inset space ~
15139 ] This defines what the default spacing should be in the style.
15141 \begin_inset Flex Code
15144 \begin_layout Plain Layout
15151 \begin_inset Flex Code
15154 \begin_layout Plain Layout
15161 \begin_inset Flex Code
15164 \begin_layout Plain Layout
15170 correspond respectively to a multiplier value of 1, 1.25 and 1.667.
15171 If you specify the argument
15172 \begin_inset Flex Code
15175 \begin_layout Plain Layout
15181 , then you must also provide a value argument which will be the actual multiplie
15183 Note that, contrary to other parameters,
15184 \begin_inset Flex Code
15187 \begin_layout Plain Layout
15193 implies the generation of specific \SpecialChar LaTeX
15194 code, using the \SpecialChar LaTeX
15198 \begin_inset Flex Code
15201 \begin_layout Plain Layout
15210 \begin_layout Description
15211 \begin_inset Flex Code
15214 \begin_layout Plain Layout
15221 \begin_inset Flex Code
15224 \begin_layout Plain Layout
15231 \begin_inset space \thinspace{}
15235 \begin_inset Flex Code
15238 \begin_layout Plain Layout
15246 ] Allow spell-checking paragraphs of this style.
15250 \begin_layout Description
15251 \begin_inset Flex Code
15254 \begin_layout Plain Layout
15260 The font used for the text body .
15262 \begin_inset CommandInset ref
15264 reference "subsec:Font-description"
15271 \begin_layout Description
15272 \begin_inset Flex Code
15275 \begin_layout Plain Layout
15284 \begin_inset Flex Code
15287 \begin_layout Plain Layout
15297 The level of the style in the table of contents.
15298 This is used for automatic numbering of section headings.
15299 \change_inserted -712698321 1401363541
15303 \begin_layout Description
15305 \change_inserted -712698321 1401363906
15306 \begin_inset Flex Code
15309 \begin_layout Plain Layout
15311 \change_inserted -712698321 1401363547
15320 \begin_inset Flex Code
15323 \begin_layout Plain Layout
15325 \change_inserted -712698321 1401363664
15338 \begin_inset Flex Code
15341 \begin_layout Plain Layout
15343 \change_inserted -712698321 1401363669
15352 \begin_inset Flex Code
15355 \begin_layout Plain Layout
15357 \change_inserted -712698321 1401363675
15365 ] This tag determines whether the first line indentation of this paragraph
15366 can be toggled via the Paragraph settings dialog.
15370 \begin_inset Flex Code
15373 \begin_layout Plain Layout
15375 \change_inserted -712698321 1401363761
15385 is set, indentation can be toggled if the document settings use
15386 \begin_inset Quotes eld
15390 \begin_inset Quotes erd
15393 paragraph style, with
15394 \begin_inset Flex Code
15397 \begin_layout Plain Layout
15399 \change_inserted -712698321 1401363844
15405 , indentation can always be toggled, notwithstanding the document settings,
15407 \begin_inset Flex Code
15410 \begin_layout Plain Layout
15412 \change_inserted -712698321 1401363901
15418 , indentation can never be toggled.
15423 \begin_layout Description
15424 \begin_inset Flex Code
15427 \begin_layout Plain Layout
15434 \begin_inset Flex Code
15437 \begin_layout Plain Layout
15443 ] The vertical space with which the very first of a chain of paragraphs
15444 with this style is separated from the previous paragraph.
15445 If the previous paragraph has another style, the separations are not simply
15446 added, but the maximum is taken.
15449 \begin_layout Subsection
15450 \begin_inset CommandInset label
15456 Internationalization of Paragraph Styles
15459 \begin_layout Standard
15461 has long supported internationalization of layout information, but, until
15462 version 2.0, this applied only to the user interface and not to, say, PDF
15464 Thus, French authors were forced to resort to ugly hacks if they wanted
15469 1' instead of `Theorem 1'.
15470 Thanks to Georg Baum, that is no longer the case.
15473 \begin_layout Standard
15475 \begin_inset Flex Code
15478 \begin_layout Plain Layout
15484 defines text that is to appear in the typeset document, it may use
15485 \begin_inset Flex Code
15488 \begin_layout Plain Layout
15495 \begin_inset Flex Code
15498 \begin_layout Plain Layout
15504 to support non-English and even multi-language documents correctly.
15505 The following excerpt (from the
15506 \begin_inset Flex Code
15509 \begin_layout Plain Layout
15515 file) shows how this works:
15518 \begin_layout LyX-Code
15520 \begin_inset Separator parbreak
15527 \begin_layout LyX-Code
15530 theoremstyle{remark}
15533 \begin_layout LyX-Code
15536 newtheorem{claim}[thm]{
15543 \begin_layout LyX-Code
15547 \begin_layout LyX-Code
15551 \begin_layout LyX-Code
15556 claimname}{_(Claim)}
15559 \begin_layout LyX-Code
15563 \begin_layout LyX-Code
15567 \begin_layout LyX-Code
15576 claimname}{_(Claim)}}
15579 \begin_layout LyX-Code
15584 \begin_layout Standard
15585 In principle, any legal \SpecialChar LaTeX
15587 \begin_inset Flex Code
15590 \begin_layout Plain Layout
15597 \begin_inset Flex Code
15600 \begin_layout Plain Layout
15606 tags, but in practice they will typically look as they do here.
15607 The key to correct translation of the typeset text is the definition of
15608 the \SpecialChar LaTeX
15610 \begin_inset Flex Code
15613 \begin_layout Plain Layout
15622 \begin_inset Flex Code
15625 \begin_layout Plain Layout
15637 \begin_layout Standard
15639 \begin_inset Flex Code
15642 \begin_layout Plain Layout
15648 tag provides for internationalization based upon the overall language of
15650 The contents of the tag will be included in the preamble, just as with
15652 \begin_inset Flex Code
15655 \begin_layout Plain Layout
15662 What makes it special is the use of the
15663 \begin_inset Quotes eld
15667 \begin_inset Quotes erd
15671 \begin_inset Flex Code
15674 \begin_layout Plain Layout
15680 , which will be replaced, when \SpecialChar LyX
15681 produces \SpecialChar LaTeX
15682 output, with the translation of
15683 its argument into the document language.
15686 \begin_layout Standard
15688 \begin_inset Flex Code
15691 \begin_layout Plain Layout
15697 tag is more complex, since it is meant to provide support for multi-language
15698 documents and so offers an interface to the
15699 \begin_inset Flex Code
15702 \begin_layout Plain Layout
15709 Its contents will be added to the preamble once for each language that
15710 appears in the document.
15711 In this case, the argument to
15712 \begin_inset Flex Code
15715 \begin_layout Plain Layout
15721 will be replaced with its translation into the language in question; the
15723 \begin_inset Flex Code
15726 \begin_layout Plain Layout
15732 is replaced by the language name (as used by the babel package).
15735 \begin_layout Standard
15736 A German document that also included a French section would thus have the
15737 following in the preamble:
15740 \begin_layout LyX-Code
15749 claimname}{Affirmation}}
15750 \begin_inset Newline newline
15761 claimname}{Behauptung}}
15762 \begin_inset Newline newline
15769 claimname}{Behauptung}
15772 \begin_layout Standard
15775 \begin_inset Flex Code
15778 \begin_layout Plain Layout
15784 will then conspire to produce the correct text in the output.
15787 \begin_layout Standard
15788 One important point to note here is that the translations are provided by
15790 itself, through the file
15791 \begin_inset Flex Code
15794 \begin_layout Plain Layout
15801 This means, in effect, that
15802 \begin_inset Flex Code
15805 \begin_layout Plain Layout
15812 \begin_inset Flex Code
15815 \begin_layout Plain Layout
15821 are really only of use in layout files that are provided with \SpecialChar LyX
15823 entered in user-created layout files will not be seen by \SpecialChar LyX
15824 's internationalizatio
15825 n routines unless the
15826 \begin_inset Flex Code
15829 \begin_layout Plain Layout
15835 file is modified accordingly.
15836 That said, however, any layout created with the intention that it will
15837 be included with \SpecialChar LyX
15838 should use these tags where appropriate.
15839 Please note that the paragraph style translations provided by \SpecialChar LyX
15841 change with a minor update (e.
15842 \begin_inset space \thinspace{}
15846 \begin_inset space \space{}
15849 from version 2.1.x to 2.1.y).
15850 It is however quite likely that a major update (e.
15851 \begin_inset space \thinspace{}
15855 \begin_inset space \space{}
15858 from 2.0.x to 2.1.y) will introduce new translations or corrections.
15861 \begin_layout Subsection
15863 \begin_inset CommandInset label
15865 name "subsec:Floats"
15872 \begin_layout Standard
15873 It is necessary to define the floats (
15874 \begin_inset Flex MenuItem
15877 \begin_layout Plain Layout
15884 \begin_inset Flex MenuItem
15887 \begin_layout Plain Layout
15893 , \SpecialChar ldots
15894 ) in the text class itself.
15895 Standard floats are included in the file
15896 \begin_inset Flex Code
15899 \begin_layout Plain Layout
15905 , so you may have to do no more than add
15908 \begin_layout LyX-Code
15909 Input stdfloats.inc
15912 \begin_layout Standard
15913 to your layout file.
15914 If you want to implement a text class that proposes some other float types
15915 (like the AGU class bundled with \SpecialChar LyX
15916 ), the information below will hopefully
15918 \change_inserted -712698321 1432283506
15922 \begin_layout Description
15924 \change_inserted -712698321 1432313622
15925 \begin_inset Flex Code
15928 \begin_layout Plain Layout
15930 \change_inserted -712698321 1432283514
15937 \begin_inset Flex Code
15940 \begin_layout Plain Layout
15942 \change_inserted -712698321 1432283507
15948 =!htbpH] Allowed placement options for this float type.
15949 The value is a string of placement characters.
15950 Possible characters include:
15955 \begin_inset Quotes eld
15959 \begin_inset Quotes erd
15967 \begin_inset Quotes eld
15971 \begin_inset Quotes erd
15979 \begin_inset Quotes eld
15983 \begin_inset Quotes erd
15991 \begin_inset Quotes eld
15995 \begin_inset Quotes erd
16003 \begin_inset Quotes eld
16007 \begin_inset Quotes erd
16015 \begin_inset Quotes eld
16019 \begin_inset Quotes erd
16023 The order of the characters in the string does not matter.
16024 If no placement options are allowed, use the string
16031 \begin_layout Description
16033 \change_inserted -712698321 1432313755
16034 \begin_inset Flex Code
16037 \begin_layout Plain Layout
16039 \change_inserted -712698321 1432313630
16046 \begin_inset Flex Code
16049 \begin_layout Plain Layout
16051 \change_inserted -712698321 1432313646
16060 \begin_inset space \thinspace{}
16066 \begin_inset Flex Code
16069 \begin_layout Plain Layout
16071 \change_inserted -712698321 1432313646
16081 ] Defines whether the float allows to be rotated via the rotfloat package
16084 \begin_inset Flex Code
16087 \begin_layout Plain Layout
16089 \change_inserted -712698321 1432313721
16095 if the float does not support this feature.
16098 \begin_layout Description
16100 \change_inserted -712698321 1432313802
16101 \begin_inset Flex Code
16104 \begin_layout Plain Layout
16106 \change_inserted -712698321 1432313759
16113 \begin_inset Flex Code
16116 \begin_layout Plain Layout
16118 \change_inserted -712698321 1432313755
16127 \begin_inset space \thinspace{}
16133 \begin_inset Flex Code
16136 \begin_layout Plain Layout
16138 \change_inserted -712698321 1432313755
16148 ] Defines whether the float has a starred variant that spans columns in
16149 a two column paragraph.
16151 \begin_inset Flex Code
16154 \begin_layout Plain Layout
16156 \change_inserted -712698321 1432313755
16162 if the float does not support this feature.
16167 \begin_layout Description
16168 \begin_inset Flex Code
16171 \begin_layout Plain Layout
16178 \begin_inset Flex Code
16181 \begin_layout Plain Layout
16188 \begin_inset Quotes erd
16192 \begin_inset Quotes erd
16195 ] The file name extension of an auxiliary file for the list of figures (or
16198 writes the captions to this file.
16201 \begin_layout Description
16202 \begin_inset Flex Code
16205 \begin_layout Plain Layout
16212 \begin_inset Flex Code
16215 \begin_layout Plain Layout
16222 \begin_inset Quotes erd
16226 \begin_inset Quotes erd
16229 ] The string that will be used in the menus and also for the caption.
16230 This is translated to the current language if babel is used.
16233 \begin_layout Description
16234 \begin_inset Flex Code
16237 \begin_layout Plain Layout
16243 These tags control the XHTML output.
16245 \begin_inset CommandInset ref
16247 reference "sec:Tags-for-XHTML"
16254 \begin_layout Description
16255 \begin_inset Flex Code
16258 \begin_layout Plain Layout
16267 \begin_inset Flex Code
16270 \begin_layout Plain Layout
16279 \begin_inset space \thinspace{}
16283 \begin_inset Flex Code
16286 \begin_layout Plain Layout
16292 ] Indicates whether the float is already defined in the document class or
16293 if instead the \SpecialChar LaTeX
16295 \begin_inset Flex Code
16298 \begin_layout Plain Layout
16304 needs to be loaded to define it on-the-fly.
16306 \begin_inset Flex Code
16309 \begin_layout Plain Layout
16316 \begin_inset Flex Code
16319 \begin_layout Plain Layout
16326 It should be set to
16327 \begin_inset Flex Code
16330 \begin_layout Plain Layout
16336 if the float is already defined by the \SpecialChar LaTeX
16340 \begin_layout Description
16341 \begin_inset Flex Code
16344 \begin_layout Plain Layout
16351 \begin_inset Flex Code
16354 \begin_layout Plain Layout
16361 \begin_inset Quotes erd
16365 \begin_inset Quotes erd
16368 ] The command used to generate a list of floats of this type; the leading
16377 \begin_inset Flex Code
16380 \begin_layout Plain Layout
16386 is false, since there is no standard way to generate this command.
16388 \begin_inset Flex Code
16391 \begin_layout Plain Layout
16397 is true, since in that case there is a standard way to define the command.
16400 \begin_layout Description
16401 \begin_inset Flex Code
16404 \begin_layout Plain Layout
16411 \begin_inset Flex Code
16414 \begin_layout Plain Layout
16421 \begin_inset Quotes erd
16425 \begin_inset Quotes erd
16428 ] A title for a list of floats of this kind (list of figures, tables, or
16430 It is used for the screen label within \SpecialChar LyX
16431 , it is used by \SpecialChar LaTeX
16433 it is used as the title in the XHTML output.
16434 It will be translated to the document language.
16437 \begin_layout Description
16438 \begin_inset Flex Code
16441 \begin_layout Plain Layout
16448 \begin_inset Flex Code
16451 \begin_layout Plain Layout
16458 \begin_inset Quotes erd
16462 \begin_inset Quotes erd
16465 ] This (optional) argument determines whether floats of this class will
16466 be numbered within some sectional unit of the document.
16468 \begin_inset Flex Code
16471 \begin_layout Plain Layout
16478 \begin_inset Quotes eld
16482 \begin_inset Flex Code
16485 \begin_layout Plain Layout
16492 \begin_inset Quotes erd
16495 , the floats will be numbered within chapters.
16499 \begin_layout Description
16500 \begin_inset Flex Code
16503 \begin_layout Plain Layout
16510 \begin_inset Flex Code
16513 \begin_layout Plain Layout
16520 \begin_inset Quotes erd
16524 \begin_inset Quotes erd
16527 ] The default placement for the given class of floats.
16528 The string should be as in standard \SpecialChar LaTeX
16530 \begin_inset Flex Code
16533 \begin_layout Plain Layout
16540 \begin_inset Flex Code
16543 \begin_layout Plain Layout
16550 \begin_inset Flex Code
16553 \begin_layout Plain Layout
16560 \begin_inset Flex Code
16563 \begin_layout Plain Layout
16569 for top, bottom, page, and here, respectively.
16573 \begin_layout Plain Layout
16574 Note that the order of these letters in the string is irrelevant, like in
16581 On top of that there is a new type,
16582 \begin_inset Flex Code
16585 \begin_layout Plain Layout
16591 , which does not really correspond to a float, since it means: put it
16592 \begin_inset Quotes eld
16596 \begin_inset Quotes erd
16600 Note however that the
16601 \begin_inset Flex Code
16604 \begin_layout Plain Layout
16610 specifier is special and, because of implementation details, cannot be
16611 used in non-built in float types.
16612 If you do not understand what this means, just use
16613 \begin_inset Quotes eld
16617 \begin_inset Flex Code
16620 \begin_layout Plain Layout
16627 \begin_inset Quotes erd
16633 \begin_layout Description
16634 \begin_inset Flex Code
16637 \begin_layout Plain Layout
16644 \begin_inset Flex Code
16647 \begin_layout Plain Layout
16653 ] The prefix to use when creating labels referring to floats of this type.
16654 This allows the use of formatted references.
16655 Note that you can remove any
16656 \begin_inset Flex Code
16659 \begin_layout Plain Layout
16665 set by a copied style by using the special value
16666 \begin_inset Quotes eld
16670 \begin_inset Quotes erd
16673 , which must be all caps.
16676 \begin_layout Description
16677 \begin_inset Flex Code
16680 \begin_layout Plain Layout
16687 \begin_inset Flex Code
16690 \begin_layout Plain Layout
16697 \begin_inset Quotes erd
16701 \begin_inset Quotes erd
16704 ] The style used when defining the float using
16705 \begin_inset Flex Code
16708 \begin_layout Plain Layout
16719 \begin_layout Description
16720 \begin_inset Flex Code
16723 \begin_layout Plain Layout
16730 \begin_inset Flex Code
16733 \begin_layout Plain Layout
16740 \begin_inset Quotes erd
16744 \begin_inset Quotes erd
16748 \begin_inset Quotes eld
16752 \begin_inset Quotes erd
16755 of the new class of floats, like program or algorithm.
16756 After the appropriate
16757 \begin_inset Flex Code
16760 \begin_layout Plain Layout
16769 \begin_inset Flex Code
16772 \begin_layout Plain Layout
16781 \begin_inset Flex Code
16784 \begin_layout Plain Layout
16795 \begin_layout Description
16796 \begin_inset Flex Code
16799 \begin_layout Plain Layout
16806 \begin_inset Flex Code
16809 \begin_layout Plain Layout
16816 \begin_inset space \thinspace{}
16820 \begin_inset Flex Code
16823 \begin_layout Plain Layout
16831 ] Specifies whether this float is defined using the \SpecialChar LaTeX
16833 \begin_inset Flex Code
16836 \begin_layout Plain Layout
16842 , either by the class file, another package or on-the-fly by \SpecialChar LyX
16846 \begin_layout Standard
16847 Note that defining a float with type
16848 \begin_inset Flex Code
16851 \begin_layout Plain Layout
16859 automatically defines the corresponding counter with name
16860 \begin_inset Flex Code
16863 \begin_layout Plain Layout
16874 \begin_layout Subsection
16875 Flex insets and InsetLayout
16876 \begin_inset CommandInset label
16878 name "subsec:Flex-insets-and"
16885 \begin_layout Standard
16886 Flex insets come in three different kinds:
16889 \begin_layout Itemize
16891 \begin_inset Flex Code
16894 \begin_layout Plain Layout
16900 ): These define semantic markup corresponding to such \SpecialChar LaTeX
16902 \begin_inset Flex Code
16905 \begin_layout Plain Layout
16914 \begin_inset Flex Code
16917 \begin_layout Plain Layout
16928 \begin_layout Itemize
16930 \begin_inset Flex Code
16933 \begin_layout Plain Layout
16939 ): These can be used to define custom collapsible insets, similar to \SpecialChar TeX
16941 footnote, and the like.
16942 An obvious example is an endnote inset, which is defined in the
16943 \begin_inset Flex Code
16946 \begin_layout Plain Layout
16955 \begin_layout Itemize
16957 \begin_inset Flex Code
16960 \begin_layout Plain Layout
16966 ): For use with DocBook classes.
16969 \begin_layout Standard
16970 Flex insets are defined using the
16971 \begin_inset Flex Code
16974 \begin_layout Plain Layout
16980 tag, which shall be explained in a moment.
16983 \begin_layout Standard
16985 \begin_inset Flex Code
16988 \begin_layout Plain Layout
16994 tag also serves another function: It can be used to customize the general
16995 layout of many different types of insets.
16997 \begin_inset Flex Code
17000 \begin_layout Plain Layout
17006 can be used to customize the layout parameters for footnotes, marginal
17007 notes, note insets, \SpecialChar TeX
17008 code (ERT) insets, branches, listings, indexes, boxes,
17009 tables, algorithms, URLs, and captions, as well as to define Flex insets.
17012 \begin_layout Standard
17014 \begin_inset Flex Code
17017 \begin_layout Plain Layout
17023 definition must begin with a line of the form:
17026 \begin_layout LyX-Code
17030 \begin_layout Standard
17032 \begin_inset Flex Code
17035 \begin_layout Plain Layout
17041 indicates the inset whose layout is being defined, and here there are four
17045 \begin_layout Enumerate
17046 The layout for a pre-existing inset is being modified.
17047 In this case, can be
17048 \begin_inset Flex Code
17051 \begin_layout Plain Layout
17057 any one of the following:
17058 \begin_inset Flex Code
17061 \begin_layout Plain Layout
17068 \begin_inset Flex Code
17071 \begin_layout Plain Layout
17078 \begin_inset Flex Code
17081 \begin_layout Plain Layout
17088 \begin_inset Flex Code
17091 \begin_layout Plain Layout
17098 \begin_inset Flex Code
17101 \begin_layout Plain Layout
17108 \begin_inset Flex Code
17111 \begin_layout Plain Layout
17118 \begin_inset Flex Code
17121 \begin_layout Plain Layout
17128 \begin_inset Flex Code
17131 \begin_layout Plain Layout
17138 \begin_inset Flex Code
17141 \begin_layout Plain Layout
17148 \begin_inset Flex Code
17151 \begin_layout Plain Layout
17158 \begin_inset Flex Code
17161 \begin_layout Plain Layout
17168 \begin_inset Flex Code
17171 \begin_layout Plain Layout
17178 \begin_inset Flex Code
17181 \begin_layout Plain Layout
17188 \begin_inset Flex Code
17191 \begin_layout Plain Layout
17198 \begin_inset Flex Code
17201 \begin_layout Plain Layout
17208 \begin_inset Flex Code
17211 \begin_layout Plain Layout
17218 \begin_inset Flex Code
17221 \begin_layout Plain Layout
17228 \begin_inset Flex Code
17231 \begin_layout Plain Layout
17238 \begin_inset Flex Code
17241 \begin_layout Plain Layout
17248 \begin_inset Flex Code
17251 \begin_layout Plain Layout
17260 \begin_layout Enumerate
17261 The layout for a Flex inset is being defined.
17263 \begin_inset Flex Code
17266 \begin_layout Plain Layout
17272 must be of the form
17273 \begin_inset Quotes eld
17277 \begin_inset Flex Code
17280 \begin_layout Plain Layout
17287 \begin_inset Quotes erd
17291 \begin_inset Flex Code
17294 \begin_layout Plain Layout
17300 may be be any valid identifier not used by a pre-existing Flex inset.
17301 The identifier may include spaces, but in that case the whole thing must
17302 be wrapped in quotes.
17303 Note that the definition of a flex inset
17308 \begin_inset Flex Code
17311 \begin_layout Plain Layout
17313 \change_deleted -712698321 1437634848
17316 \change_inserted -712698321 1437634847
17324 entry, declaring which type of inset it defines.
17327 \begin_layout Enumerate
17328 The layout for user specific branch is being defined.
17330 \begin_inset Flex Code
17333 \begin_layout Plain Layout
17339 must be of the form
17340 \begin_inset Quotes eld
17344 \begin_inset Flex Code
17347 \begin_layout Plain Layout
17354 \begin_inset Quotes erd
17358 \begin_inset Flex Code
17361 \begin_layout Plain Layout
17367 may be be any valid identifier of branch defined in user's document.
17368 The identifier may include spaces, but in that case the whole thing must
17369 be wrapped in quotes.
17370 The main purpose of this feature is to allow \SpecialChar LaTeX
17371 wrapping around specific
17372 branches as user needs.
17375 \begin_layout Enumerate
17376 The layout of a user (or class) specific caption is being defined.
17378 \begin_inset Flex Code
17381 \begin_layout Plain Layout
17387 must be of the form
17388 \begin_inset Quotes eld
17392 \begin_inset Flex Code
17395 \begin_layout Plain Layout
17402 \begin_inset Quotes erd
17406 \begin_inset Flex Code
17409 \begin_layout Plain Layout
17415 specifies the name of the caption as it appears in the menu.
17416 Have a look at the standard caption (
17417 \begin_inset Flex Code
17420 \begin_layout Plain Layout
17426 ), the specific captions of the KOMA-Script classes (
17427 \begin_inset Flex Code
17430 \begin_layout Plain Layout
17437 \begin_inset Flex Code
17440 \begin_layout Plain Layout
17449 \begin_inset space ~
17455 \begin_inset Flex Code
17458 \begin_layout Plain Layout
17464 ) for applications.
17467 \begin_layout Standard
17469 \begin_inset Flex Code
17472 \begin_layout Plain Layout
17478 definition can contain the following entries:
17481 \begin_layout Description
17482 \begin_inset Flex Code
17485 \begin_layout Plain Layout
17492 \begin_inset Flex Code
17495 \begin_layout Plain Layout
17501 ] Defines argument number of a command\SpecialChar breakableslash
17502 environment associated with the current
17504 The definition must end with
17505 \begin_inset Flex Code
17508 \begin_layout Plain Layout
17516 \begin_inset CommandInset ref
17518 reference "subsec:Paragraph-Styles"
17525 \begin_layout Description
17526 \begin_inset Flex Code
17529 \begin_layout Plain Layout
17535 Preamble for changing language commands; see
17536 \begin_inset CommandInset ref
17538 reference "subsec:I18n"
17545 \begin_layout Description
17546 \begin_inset Flex Code
17549 \begin_layout Plain Layout
17556 \begin_inset Flex Code
17559 \begin_layout Plain Layout
17565 ] The color for the inset's background.
17567 \begin_inset CommandInset ref
17569 reference "chap:Names-of-colors"
17573 for a list of the available color names.
17576 \begin_layout Description
17577 \begin_inset Flex Code
17580 \begin_layout Plain Layout
17587 \begin_inset Flex Code
17590 \begin_layout Plain Layout
17599 \begin_inset space \thinspace{}
17603 \begin_inset Flex Code
17606 \begin_layout Plain Layout
17612 ] Whether to use the content of the inset as the label, when the inset is
17617 \begin_layout Description
17618 \begin_inset Flex Code
17621 \begin_layout Plain Layout
17628 \begin_inset Flex Code
17631 \begin_layout Plain Layout
17637 ] As with paragraph styles, see
17638 \begin_inset CommandInset ref
17640 reference "subsec:Paragraph-Styles"
17645 Note that you need to specify the complete type, e.
17646 \begin_inset space \thinspace{}
17650 \begin_inset space ~
17654 \begin_inset Flex Code
17657 \begin_layout Plain Layout
17658 CopyStyle Flex:<name>
17666 \begin_layout Description
17667 \begin_inset Flex Code
17670 \begin_layout Plain Layout
17677 \begin_inset Flex Code
17680 \begin_layout Plain Layout
17689 \begin_inset space \thinspace{}
17693 \begin_inset Flex Code
17696 \begin_layout Plain Layout
17702 ] Indicates whether the user may employ the Paragraph Settings dialog to
17703 customize the paragraph.
17706 \begin_layout Description
17707 \begin_inset Flex Code
17710 \begin_layout Plain Layout
17717 \begin_inset Flex Code
17720 \begin_layout Plain Layout
17727 \begin_inset Flex Code
17730 \begin_layout Plain Layout
17737 \begin_inset Flex Code
17740 \begin_layout Plain Layout
17746 , describing the rendering style used for the inset's frame and buttons.
17747 Footnotes generally use
17748 \begin_inset Flex Code
17751 \begin_layout Plain Layout
17757 , ERT insets generally
17758 \begin_inset Flex Code
17761 \begin_layout Plain Layout
17767 , and character styles
17768 \begin_inset Flex Code
17771 \begin_layout Plain Layout
17780 \begin_layout Description
17781 \begin_inset Flex Code
17784 \begin_layout Plain Layout
17791 \begin_inset Flex Code
17794 \begin_layout Plain Layout
17803 \begin_inset space \thinspace{}
17809 \begin_inset Flex Code
17812 \begin_layout Plain Layout
17821 \begin_inset Flex Code
17824 \begin_layout Plain Layout
17831 \begin_inset Flex Code
17834 \begin_layout Plain Layout
17841 Indicates whether the environment will stand on its own in the output or
17842 will appear inline with the surrounding text.
17843 If set to false, it is supposed that the \SpecialChar LaTeX
17844 environment ignores white space
17845 (including one newline character) after the
17846 \begin_inset Flex Code
17849 \begin_layout Plain Layout
17862 \begin_inset Flex Code
17865 \begin_layout Plain Layout
17881 \begin_layout Description
17882 \begin_inset Flex Code
17885 \begin_layout Plain Layout
17891 Required at the end of the
17892 \begin_inset Flex Code
17895 \begin_layout Plain Layout
17904 \begin_layout Description
17905 \begin_inset Flex Code
17908 \begin_layout Plain Layout
17914 The font used for both the text body
17920 \begin_inset CommandInset ref
17922 reference "subsec:Font-description"
17927 Note that defining this font automatically defines the
17928 \begin_inset Flex Code
17931 \begin_layout Plain Layout
17937 to the same value, so define this first and define
17938 \begin_inset Flex Code
17941 \begin_layout Plain Layout
17947 later if you want them to be different.
17948 \change_inserted -195340706 1421002157
17952 \begin_layout Description
17954 \change_inserted -195340706 1421002157
17955 \begin_inset Flex Code
17958 \begin_layout Plain Layout
17960 \change_inserted -195340706 1421002157
17961 FixedWidthPreambleEncoding
17967 \begin_inset Flex Code
17970 \begin_layout Plain Layout
17972 \change_inserted -195340706 1421002157
17981 \begin_inset space \thinspace{}
17985 \begin_inset Flex Code
17988 \begin_layout Plain Layout
17990 \change_inserted -195340706 1421002157
17996 ] Force a fixed width encoding for the translated contents of
17997 \begin_inset Flex Code
18000 \begin_layout Plain Layout
18002 \change_inserted -195340706 1421002157
18009 \begin_inset Flex Code
18012 \begin_layout Plain Layout
18014 \change_inserted -195340706 1421002157
18020 code generated by this layout.
18021 This is needed for special packages like the listings package that do not
18022 work with variable width encodings such as utf8.
18024 This setting is ignored if fully unicode aware \SpecialChar LaTeX
18025 backends such as Xe\SpecialChar LaTeX
18032 \begin_layout Description
18033 \begin_inset Flex Code
18036 \begin_layout Plain Layout
18037 ForceLocalFontSwitch
18043 \begin_inset Flex Code
18046 \begin_layout Plain Layout
18055 \begin_inset space \thinspace{}
18059 \begin_inset Flex Code
18062 \begin_layout Plain Layout
18068 ] When using babel, always use a local font switch (
18069 \begin_inset Flex Code
18072 \begin_layout Plain Layout
18080 ), never a global one (such as
18081 \begin_inset Flex Code
18084 \begin_layout Plain Layout
18095 \begin_layout Description
18096 \begin_inset Flex Code
18099 \begin_layout Plain Layout
18106 \begin_inset Flex Code
18109 \begin_layout Plain Layout
18118 \begin_inset space \thinspace{}
18122 \begin_inset Flex Code
18125 \begin_layout Plain Layout
18132 \begin_inset Quotes eld
18136 \begin_inset Quotes erd
18139 language, leading to Left-to-Right (Latin) output, e.
18140 \begin_inset space \thinspace{}
18144 \begin_inset space \space{}
18147 in \SpecialChar TeX
18150 \change_inserted -712698321 1417441977
18154 \begin_layout Description
18156 \change_inserted -712698321 1417442090
18157 \begin_inset Flex Code
18160 \begin_layout Plain Layout
18162 \change_inserted -712698321 1417441983
18169 \begin_inset Flex Code
18172 \begin_layout Plain Layout
18174 \change_inserted -712698321 1417441978
18183 \begin_inset space \thinspace{}
18187 \begin_inset Flex Code
18190 \begin_layout Plain Layout
18192 \change_inserted -712698321 1417441978
18198 ] Force a a line break in the \SpecialChar LaTeX
18199 output before the inset starts and after
18201 This assures the inset itself is output on its own lines, for parsing purposes.
18203 \change_inserted 274215730 1419105878
18209 \begin_layout Description
18210 \begin_inset Flex Code
18213 \begin_layout Plain Layout
18220 \begin_inset Flex Code
18223 \begin_layout Plain Layout
18232 \begin_inset space \thinspace{}
18236 \begin_inset Flex Code
18239 \begin_layout Plain Layout
18245 ] Indicates whether the
18246 \begin_inset Flex Code
18249 \begin_layout Plain Layout
18255 should be used or, instead, the user can change the paragraph style used
18260 \begin_layout Description
18261 \begin_inset Flex Code
18264 \begin_layout Plain Layout
18271 \begin_inset Flex Code
18274 \begin_layout Plain Layout
18283 \begin_inset space \thinspace{}
18287 \begin_inset Flex Code
18290 \begin_layout Plain Layout
18296 ] As with paragraph styles, see
18297 \begin_inset CommandInset ref
18299 reference "subsec:Paragraph-Styles"
18306 \begin_layout Description
18307 \begin_inset Flex Code
18310 \begin_layout Plain Layout
18316 These tags control the XHTML output.
18318 \begin_inset CommandInset ref
18320 reference "sec:Tags-for-XHTML"
18327 \begin_layout Description
18328 \begin_inset Flex Code
18331 \begin_layout Plain Layout
18338 \begin_inset Flex Code
18341 \begin_layout Plain Layout
18350 \begin_inset space \thinspace{}
18354 \begin_inset Flex Code
18357 \begin_layout Plain Layout
18363 ] Whether to include the contents of this inset in the strings generated
18364 for the `Outline' pane.
18365 One would not, for example, want the content of a footnote in a section
18366 header to be included in the TOC displayed in the outline, but one would
18367 normally want the content of a character style displayed.
18368 Default is false: not to include.
18371 \begin_layout Description
18372 \begin_inset Flex Code
18375 \begin_layout Plain Layout
18384 \begin_inset Flex Code
18387 \begin_layout Plain Layout
18396 \begin_inset space \thinspace{}
18400 \begin_inset Flex Code
18403 \begin_layout Plain Layout
18409 ] As with paragraph styles, see
18410 \begin_inset CommandInset ref
18412 reference "subsec:Paragraph-Styles"
18419 \begin_layout Description
18420 \begin_inset Flex Code
18423 \begin_layout Plain Layout
18429 The font used for the label.
18431 \begin_inset CommandInset ref
18433 reference "subsec:Font-description"
18438 Note that this definition can never appear before
18439 \begin_inset Flex Code
18442 \begin_layout Plain Layout
18448 , lest it be ineffective.
18451 \begin_layout Description
18452 \begin_inset Flex Code
18455 \begin_layout Plain Layout
18462 \begin_inset Flex Code
18465 \begin_layout Plain Layout
18472 \begin_inset Quotes erd
18476 \begin_inset Quotes erd
18479 ] What will be displayed on the button or elsewhere as the inset label.
18481 \begin_inset Flex Code
18484 \begin_layout Plain Layout
18492 \begin_inset Flex Code
18495 \begin_layout Plain Layout
18501 ) modify this label on the fly.
18504 \begin_layout Description
18505 \begin_inset Flex Code
18508 \begin_layout Plain Layout
18514 Language dependent preamble; see
18515 \begin_inset CommandInset ref
18517 reference "subsec:I18n"
18524 \begin_layout Description
18525 \begin_inset Flex Code
18528 \begin_layout Plain Layout
18535 \begin_inset Flex Code
18538 \begin_layout Plain Layout
18544 ] The name of the corresponding \SpecialChar LaTeX
18546 Either the environment or command name.
18549 \begin_layout Description
18550 \begin_inset Flex Code
18553 \begin_layout Plain Layout
18560 \begin_inset Flex Code
18563 \begin_layout Plain Layout
18569 ] The optional parameter for the corresponding
18570 \begin_inset Flex Code
18573 \begin_layout Plain Layout
18579 stuff, including possible bracket pairs like
18580 \begin_inset Flex Code
18583 \begin_layout Plain Layout
18590 This parameter cannot be changed from within \SpecialChar LyX
18592 \begin_inset Flex Code
18595 \begin_layout Plain Layout
18601 for customizable parameters).
18602 It will be output as is after all \SpecialChar LaTeX
18604 \begin_inset Flex Code
18607 \begin_layout Plain Layout
18616 \begin_layout Description
18617 \begin_inset Flex Code
18620 \begin_layout Plain Layout
18627 \begin_inset Flex Code
18630 \begin_layout Plain Layout
18631 Command, Environment, None
18636 ] How the style should be translated into \SpecialChar LaTeX
18641 \begin_layout Plain Layout
18642 \begin_inset Flex Code
18645 \begin_layout Plain Layout
18651 is perhaps a bit misleading, since these rules apply to SGML classes too.
18652 Visit the SGML class files for specific examples.
18658 \begin_inset Separator parbreak
18665 \begin_layout Description
18666 \begin_inset Flex Code
18669 \begin_layout Plain Layout
18675 means nothing special
18678 \begin_layout Description
18679 \begin_inset Flex Code
18682 \begin_layout Plain Layout
18689 \begin_inset Flex Code
18692 \begin_layout Plain Layout
18699 {\SpecialChar ldots
18708 \begin_layout Description
18709 \begin_inset Flex Code
18712 \begin_layout Plain Layout
18719 \begin_inset Flex Code
18722 \begin_layout Plain Layout
18729 }\SpecialChar ldots
18744 \begin_layout Standard
18745 Putting the last few things together, the \SpecialChar LaTeX
18746 output will be either:
18749 \begin_layout LyX-Code
18752 LatexName[LatexParam]{\SpecialChar ldots
18756 \begin_layout Standard
18760 \begin_layout LyX-Code
18763 begin{LatexName}[LatexParam] \SpecialChar ldots
18769 \begin_layout Standard
18770 depending upon the \SpecialChar LaTeX
18775 \begin_layout Description
18776 \begin_inset Flex Code
18779 \begin_layout Plain Layout
18786 \begin_inset Flex Code
18789 \begin_layout Plain Layout
18795 ] A string that is put at the beginning of the layout content.
18796 A line break in the output can be indicated by
18797 \begin_inset Flex Code
18800 \begin_layout Plain Layout
18809 \begin_layout Description
18810 \begin_inset Flex Code
18813 \begin_layout Plain Layout
18820 \begin_inset Flex Code
18823 \begin_layout Plain Layout
18830 \begin_inset Flex Code
18833 \begin_layout Plain Layout
18840 \begin_inset Flex Code
18843 \begin_layout Plain Layout
18850 \begin_inset Flex Code
18853 \begin_layout Plain Layout
18859 (indicating a dummy definition ending definitions of charstyles, etc).
18860 This entry is required in and is only meaningful for Flex insets.
18861 Among other things, it determines on which menu this inset will appear.
18863 \begin_inset Flex Code
18866 \begin_layout Plain Layout
18868 \change_deleted -712698321 1437634857
18871 \change_inserted -712698321 1437634858
18880 \begin_inset Flex Code
18883 \begin_layout Plain Layout
18889 will automatically set
18890 \begin_inset Flex Code
18893 \begin_layout Plain Layout
18901 \begin_inset Flex Code
18904 \begin_layout Plain Layout
18910 can be set to true for
18911 \begin_inset Flex Code
18914 \begin_layout Plain Layout
18920 insets by setting it
18925 \begin_inset Flex Code
18928 \begin_layout Plain Layout
18930 \change_deleted -712698321 1437634864
18933 \change_inserted -712698321 1437634865
18944 \begin_layout Description
18945 \begin_inset Flex Code
18948 \begin_layout Plain Layout
18955 \begin_inset Flex Code
18958 \begin_layout Plain Layout
18967 \begin_inset space \thinspace{}
18971 \begin_inset Flex Code
18974 \begin_layout Plain Layout
18980 ] Whether multiple paragraphs are permitted in this inset.
18982 \begin_inset Flex Code
18985 \begin_layout Plain Layout
18991 to the same value and
18992 \begin_inset Flex Code
18995 \begin_layout Plain Layout
19001 to the opposite value.
19002 These can be reset to other values, if they are used
19007 \begin_inset Flex Code
19010 \begin_layout Plain Layout
19020 \begin_layout Description
19021 \begin_inset Flex Code
19024 \begin_layout Plain Layout
19031 \begin_inset Flex Code
19034 \begin_layout Plain Layout
19043 \begin_inset space \thinspace{}
19047 \begin_inset Flex Code
19050 \begin_layout Plain Layout
19056 ] Whether fragile commands in this inset should be
19057 \begin_inset Flex Code
19060 \begin_layout Plain Layout
19073 whether the command should itself be protected.) Default is false.
19076 \begin_layout Description
19077 \begin_inset Flex Code
19080 \begin_layout Plain Layout
19087 \begin_inset Flex Code
19090 \begin_layout Plain Layout
19096 ] Deletes an existing
19097 \begin_inset Flex Code
19100 \begin_layout Plain Layout
19107 \change_inserted -712698321 1417953494
19111 \begin_layout Description
19113 \change_inserted -712698321 1417953559
19114 \begin_inset Flex Code
19117 \begin_layout Plain Layout
19119 \change_inserted -712698321 1417953494
19126 \begin_inset Flex Code
19129 \begin_layout Plain Layout
19131 \change_inserted -712698321 1417953574
19138 \begin_inset Flex Code
19141 \begin_layout Plain Layout
19143 \change_inserted -712698321 1417953533
19149 that has replaced this
19150 \begin_inset Flex Code
19153 \begin_layout Plain Layout
19155 \change_inserted -712698321 1417953551
19162 This is used to rename an
19163 \begin_inset Flex Code
19166 \begin_layout Plain Layout
19168 \change_inserted -712698321 1417953559
19174 , while keeping backward compatibility.
19179 \begin_layout Description
19180 \begin_inset Flex Code
19183 \begin_layout Plain Layout
19190 \begin_inset Flex Code
19193 \begin_layout Plain Layout
19202 \begin_inset space \thinspace{}
19206 \begin_inset Flex Code
19209 \begin_layout Plain Layout
19215 ] As with paragraph styles, see
19216 \begin_inset CommandInset ref
19218 reference "subsec:Paragraph-Styles"
19226 \begin_layout Description
19227 \begin_inset Flex Code
19230 \begin_layout Plain Layout
19237 \begin_inset Flex Code
19240 \begin_layout Plain Layout
19249 \begin_inset space \thinspace{}
19253 \begin_inset Flex Code
19256 \begin_layout Plain Layout
19262 ] As with paragraph styles, see
19263 \begin_inset CommandInset ref
19265 reference "subsec:Paragraph-Styles"
19273 \begin_layout Description
19274 \begin_inset Flex Code
19277 \begin_layout Plain Layout
19283 As with paragraph styles, see
19284 \begin_inset CommandInset ref
19286 reference "subsec:Paragraph-Styles"
19293 \begin_layout Description
19294 \begin_inset Flex Code
19297 \begin_layout Plain Layout
19304 \begin_inset Flex Code
19307 \begin_layout Plain Layout
19313 ] The prefix to use when creating labels referring to insets of this type.
19314 This allows the use of formatted references.
19317 \begin_layout Description
19318 \begin_inset Flex Code
19321 \begin_layout Plain Layout
19328 \begin_inset Flex Code
19331 \begin_layout Plain Layout
19337 ] As with paragraph styles, see
19338 \begin_inset CommandInset ref
19340 reference "subsec:Paragraph-Styles"
19347 \begin_layout Description
19348 \begin_inset Flex Code
19351 \begin_layout Plain Layout
19358 \begin_inset Flex Code
19361 \begin_layout Plain Layout
19370 \begin_inset space \thinspace{}
19374 \begin_inset Flex Code
19377 \begin_layout Plain Layout
19383 ] Resets the \SpecialChar LaTeX
19384 arguments of this layout (as defined via the
19385 \begin_inset Flex Code
19388 \begin_layout Plain Layout
19395 This is useful if you have copied a style via
19396 \begin_inset Flex Code
19399 \begin_layout Plain Layout
19405 , but you do not want to inherit its (required and optional) arguments.
19408 \begin_layout Description
19409 \begin_inset Flex Code
19412 \begin_layout Plain Layout
19419 \begin_inset Flex Code
19422 \begin_layout Plain Layout
19429 \begin_inset space \thinspace{}
19433 \begin_inset Flex Code
19436 \begin_layout Plain Layout
19444 ] Whether this inset should use the font of its surrounding environment
19446 Default is false: use the font of the surrounding environment.
19449 \begin_layout Description
19450 \begin_inset Flex Code
19453 \begin_layout Plain Layout
19460 \begin_inset Flex Code
19463 \begin_layout Plain Layout
19469 ] A string that is put at the end of the layout content.
19470 A line break in the output can be indicated by
19471 \begin_inset Flex Code
19474 \begin_layout Plain Layout
19483 \begin_layout Description
19484 \begin_inset Flex Code
19487 \begin_layout Plain Layout
19494 \begin_inset Flex Code
19497 \begin_layout Plain Layout
19504 \begin_inset space \thinspace{}
19508 \begin_inset Flex Code
19511 \begin_layout Plain Layout
19519 ] Allow spell-checking the contents of this inset.
19523 \begin_layout Subsection
19525 \begin_inset CommandInset label
19527 name "subsec:Counters"
19534 \begin_layout Standard
19535 It is necessary to define the counters (
19536 \begin_inset Flex MenuItem
19539 \begin_layout Plain Layout
19546 \begin_inset Flex MenuItem
19549 \begin_layout Plain Layout
19555 , \SpecialChar ldots
19556 ) in the text class itself.
19557 The standard counters are defined in the file
19558 \begin_inset Flex Code
19561 \begin_layout Plain Layout
19567 , so you may have to do no more than add
19570 \begin_layout LyX-Code
19571 Input stdcounters.inc
19574 \begin_layout Standard
19575 to your layout file to get them to work.
19576 But if you want to define custom counters, then you can do so.
19577 The counter declaration must begin with:
19580 \begin_layout LyX-Code
19581 Counter CounterName
19584 \begin_layout Standard
19586 \begin_inset Flex Code
19589 \begin_layout Plain Layout
19595 ' is replaced by the name of the counter.
19596 And it must end with
19597 \begin_inset Quotes eld
19601 \begin_inset Flex Code
19604 \begin_layout Plain Layout
19611 \begin_inset Quotes erd
19615 The following parameters can also be used:
19618 \begin_layout Description
19619 \begin_inset Flex Code
19622 \begin_layout Plain Layout
19629 \begin_inset Flex Code
19632 \begin_layout Plain Layout
19638 ] Sets the initial value for the counter, to which it will be reset whenever
19640 Normally, one will want the default, 1.
19643 \begin_layout Description
19644 \begin_inset Flex Code
19647 \begin_layout Plain Layout
19654 \begin_inset Flex Code
19657 \begin_layout Plain Layout
19664 \begin_inset Quotes erd
19668 \begin_inset Quotes erd
19671 ] When defined, this string defines how the counter is displayed.
19672 Setting this value sets
19673 \begin_inset Flex Code
19676 \begin_layout Plain Layout
19677 LabelStringAppendix
19683 The following special constructs can be used in the string:
19684 \begin_inset Separator parbreak
19691 \begin_layout Itemize
19692 \begin_inset Flex Code
19695 \begin_layout Plain Layout
19703 will be replaced by the expansion of the
19704 \begin_inset Flex Code
19707 \begin_layout Plain Layout
19714 \begin_inset Flex Code
19717 \begin_layout Plain Layout
19718 LabelStringAppendix
19724 \begin_inset Flex Code
19727 \begin_layout Plain Layout
19737 \begin_layout Itemize
19738 counter values can be expressed using \SpecialChar LaTeX
19740 \begin_inset Newline newline
19744 \begin_inset Flex Code
19747 \begin_layout Plain Layout
19764 \begin_inset Flex Code
19767 \begin_layout Plain Layout
19779 \begin_layout Plain Layout
19789 Actually, the situation is a bit more complicated: any
19808 other than those described below will produce arabic numerals.
19809 It would not be surprising to see this change in the future.
19815 \begin_inset Flex Code
19818 \begin_layout Plain Layout
19824 : 1, 2, 3,\SpecialChar ldots
19826 \begin_inset Flex Code
19829 \begin_layout Plain Layout
19835 for lower-case letters: a, b, c, \SpecialChar ldots
19837 \begin_inset Flex Code
19840 \begin_layout Plain Layout
19846 for upper-case letters: A, B, C, \SpecialChar ldots
19848 \begin_inset Flex Code
19851 \begin_layout Plain Layout
19857 for lower-case roman numerals: i, ii, iii, \SpecialChar ldots
19859 \begin_inset Flex Code
19862 \begin_layout Plain Layout
19868 for upper-case roman numerals: I, II, III\SpecialChar ldots
19870 \begin_inset Flex Code
19873 \begin_layout Plain Layout
19879 for hebrew numerals.
19883 \begin_layout Standard
19884 If LabelString is not defined, a default value is constructed as follows:
19885 if the counter has a master counter
19886 \begin_inset Flex Code
19889 \begin_layout Plain Layout
19896 \begin_inset Flex Code
19899 \begin_layout Plain Layout
19906 \begin_inset Newline newline
19910 \begin_inset Flex Code
19913 \begin_layout Plain Layout
19923 is used; otherwise the string
19924 \begin_inset Flex Code
19927 \begin_layout Plain Layout
19938 \begin_layout Description
19939 \begin_inset Flex Code
19942 \begin_layout Plain Layout
19943 LabelStringAppendix
19949 \begin_inset Flex Code
19952 \begin_layout Plain Layout
19959 \begin_inset Quotes erd
19963 \begin_inset Quotes erd
19967 \begin_inset Flex Code
19970 \begin_layout Plain Layout
19976 , but for use in the Appendix.
19979 \begin_layout Description
19980 \begin_inset Flex Code
19983 \begin_layout Plain Layout
19990 \begin_inset Flex Code
19993 \begin_layout Plain Layout
20000 \begin_inset Quotes erd
20004 \begin_inset Quotes erd
20007 ] A format for use with formatted references to this counter.
20008 For example, one might want to have references to section numbers appear
20010 \begin_inset Quotes eld
20014 \begin_inset Quotes erd
20018 The string should contain
20019 \begin_inset Quotes eld
20023 \begin_inset Quotes erd
20027 This will be replaced by the counter number itself.
20028 So, for sections, it would be: Section ##.
20031 \begin_layout Description
20032 \begin_inset Flex Code
20035 \begin_layout Plain Layout
20042 \begin_inset Flex Code
20045 \begin_layout Plain Layout
20052 \begin_inset Quotes erd
20056 \begin_inset Quotes erd
20059 ] If this is set to the name of another counter, the present counter will
20060 be reset every time the other one is increased.
20062 \begin_inset Flex Code
20065 \begin_layout Plain Layout
20072 \begin_inset Flex Code
20075 \begin_layout Plain Layout
20084 \begin_layout Subsection
20086 \begin_inset CommandInset label
20088 name "subsec:Font-description"
20095 \begin_layout Standard
20096 A font description looks like this:
20099 \begin_layout LyX-Code
20113 \begin_layout LyX-Code
20117 \begin_layout LyX-Code
20121 \begin_layout Standard
20122 The following commands are available:
20125 \begin_layout Description
20126 \begin_inset Flex Code
20129 \begin_layout Plain Layout
20136 \begin_inset Flex Code
20139 \begin_layout Plain Layout
20148 \begin_inset Flex Code
20151 \begin_layout Plain Layout
20158 \begin_inset Flex Code
20161 \begin_layout Plain Layout
20168 \begin_inset Flex Code
20171 \begin_layout Plain Layout
20178 \begin_inset Flex Code
20181 \begin_layout Plain Layout
20188 \begin_inset Flex Code
20191 \begin_layout Plain Layout
20198 \begin_inset Flex Code
20201 \begin_layout Plain Layout
20208 \begin_inset Flex Code
20211 \begin_layout Plain Layout
20218 \begin_inset Flex Code
20221 \begin_layout Plain Layout
20230 \begin_layout Description
20231 \begin_inset Flex Code
20234 \begin_layout Plain Layout
20241 \begin_inset Flex Code
20244 \begin_layout Plain Layout
20253 \begin_inset Flex Code
20256 \begin_layout Plain Layout
20263 \begin_inset Flex Code
20266 \begin_layout Plain Layout
20275 \begin_layout Description
20276 \begin_inset Flex Code
20279 \begin_layout Plain Layout
20286 \begin_inset Flex Code
20289 \begin_layout Plain Layout
20295 ] Valid arguments are:
20296 \begin_inset Flex Code
20299 \begin_layout Plain Layout
20306 \begin_inset Flex Code
20309 \begin_layout Plain Layout
20316 \begin_inset Flex Code
20319 \begin_layout Plain Layout
20326 \begin_inset Flex Code
20329 \begin_layout Plain Layout
20336 \begin_inset Flex Code
20339 \begin_layout Plain Layout
20346 \begin_inset Flex Code
20349 \begin_layout Plain Layout
20356 \begin_inset Flex Code
20359 \begin_layout Plain Layout
20366 \begin_inset Flex Code
20369 \begin_layout Plain Layout
20376 \begin_inset Flex Code
20379 \begin_layout Plain Layout
20386 \begin_inset Flex Code
20389 \begin_layout Plain Layout
20396 \begin_inset Flex Code
20399 \begin_layout Plain Layout
20406 \begin_inset Flex Code
20409 \begin_layout Plain Layout
20416 Each of these turns on or off the corresponding attribute.
20418 \begin_inset Flex Code
20421 \begin_layout Plain Layout
20427 turns on emphasis, and
20428 \begin_inset Flex Code
20431 \begin_layout Plain Layout
20439 \begin_inset Newline newline
20442 If the latter seems puzzling, remember that the font settings for the present
20443 context are generally inherited from the surrounding context.
20445 \begin_inset Flex Code
20448 \begin_layout Plain Layout
20454 would turn off the emphasis that was anyway in effect, say, in a theorem
20458 \begin_layout Description
20459 \begin_inset Flex Code
20462 \begin_layout Plain Layout
20469 \begin_inset Flex Code
20472 \begin_layout Plain Layout
20481 \begin_inset Flex Code
20484 \begin_layout Plain Layout
20493 \begin_layout Description
20494 \begin_inset Flex Code
20497 \begin_layout Plain Layout
20504 \begin_inset Flex Code
20507 \begin_layout Plain Layout
20516 \begin_inset Flex Code
20519 \begin_layout Plain Layout
20526 \begin_inset Flex Code
20529 \begin_layout Plain Layout
20536 \begin_inset Flex Code
20539 \begin_layout Plain Layout
20548 \begin_layout Description
20549 \begin_inset Flex Code
20552 \begin_layout Plain Layout
20559 \begin_inset Flex Code
20562 \begin_layout Plain Layout
20569 \begin_inset Flex Code
20572 \begin_layout Plain Layout
20579 \begin_inset Flex Code
20582 \begin_layout Plain Layout
20591 \begin_inset Flex Code
20594 \begin_layout Plain Layout
20601 \begin_inset Flex Code
20604 \begin_layout Plain Layout
20611 \begin_inset Flex Code
20614 \begin_layout Plain Layout
20621 \begin_inset Flex Code
20624 \begin_layout Plain Layout
20631 \begin_inset Flex Code
20634 \begin_layout Plain Layout
20643 \begin_layout Subsection
20644 \begin_inset CommandInset label
20646 name "subsec:Citation-format-description"
20650 Citation format description
20653 \begin_layout Standard
20655 \begin_inset Flex Code
20658 \begin_layout Plain Layout
20664 blocks are used to describe how bibliographic information should be displayed,
20665 both within \SpecialChar LyX
20666 itself (in the citation dialog and in tooltips, for example)
20667 and in XHTML output.
20668 Such a block might look like this:
20671 \begin_layout LyX-Code
20675 \begin_layout LyX-Code
20679 \begin_layout LyX-Code
20683 \begin_layout LyX-Code
20687 \begin_layout Standard
20688 The individual lines define how the bibliographic information associated
20689 with an article or book, respectively, is to be displayed, and such a definitio
20690 n can be given for any `entry type' that might be present in a Bib\SpecialChar TeX
20693 defines a default format in the source code that will be used if no specific
20694 definition has been given.
20696 predefines several formats in the file
20697 \begin_inset Flex Code
20700 \begin_layout Plain Layout
20706 , which is included in most of \SpecialChar LyX
20707 's document classes.
20710 \begin_layout Standard
20711 The definitions use a simple language that allows Bib\SpecialChar TeX
20712 keys to be replaced
20714 Keys should be enclosed in
20715 \begin_inset Flex Code
20718 \begin_layout Plain Layout
20725 \begin_inset Flex Code
20728 \begin_layout Plain Layout
20735 So a simple definition might look like this:
20738 \begin_layout LyX-Code
20740 \begin_inset Quotes eld
20744 \begin_inset Quotes erd
20750 \begin_layout Standard
20751 This would print the author, followed by a comma, followed by the title,
20752 in quotes, followed by a period.
20755 \begin_layout Standard
20756 Of course, sometimes you may want to print a key only if it exists.
20757 This can be done by using a conditional construction, such as:
20758 \begin_inset Flex Code
20761 \begin_layout Plain Layout
20763 \begin_inset space ~
20773 \begin_inset Flex Code
20776 \begin_layout Plain Layout
20782 key exists, then print
20783 \begin_inset Quotes eld
20787 \begin_inset space ~
20791 \begin_inset Quotes erd
20794 followed by the volume key.
20795 It is also possible to have an else clause in the conditional, such as:
20796 \begin_inset Newline newline
20800 \begin_inset Flex Code
20803 \begin_layout Plain Layout
20804 {%author%[[%author%]][[%editor%, ed.]]}
20810 \begin_inset Newline newline
20814 \begin_inset Flex Code
20817 \begin_layout Plain Layout
20823 key is printed if it exists; otherwise, the editor key is printed, followed
20825 \begin_inset Quotes eld
20829 \begin_inset space ~
20833 \begin_inset Quotes erd
20836 Note that the key is again enclosed in
20837 \begin_inset Flex Code
20840 \begin_layout Plain Layout
20846 signs; the entire conditional is enclosed in braces; and the if and else
20847 clauses are enclosed in double brackets,
20848 \begin_inset Quotes eld
20852 \begin_inset Flex Code
20855 \begin_layout Plain Layout
20862 \begin_inset Quotes eld
20866 \begin_inset Quotes eld
20870 \begin_inset Flex Code
20873 \begin_layout Plain Layout
20880 \begin_inset Quotes erd
20884 There must be no space between any of these.
20887 \begin_layout Standard
20888 There is one other piece of syntax available in definitions, which looks
20890 \begin_inset Flex Code
20893 \begin_layout Plain Layout
20900 This defines a piece of formatting information that is to be used when
20902 \begin_inset Quotes eld
20906 \begin_inset Quotes erd
20910 Obviously, we do not want to output HTML tags when writing plain text,
20911 so they should be wrapped in
20912 \begin_inset Quotes eld
20916 \begin_inset Quotes erd
20920 \begin_inset Quotes eld
20924 \begin_inset Quotes erd
20930 \begin_layout Standard
20931 Two special sorts of definitions are also possible in a
20932 \begin_inset Flex Code
20935 \begin_layout Plain Layout
20942 An example of the first would be:
20945 \begin_layout LyX-Code
20947 \begin_inset Quotes eld
20951 \begin_inset Quotes erd
20957 \begin_layout Standard
20958 This is an abbreviation, or macro, and it can be used by treating it as
20960 \begin_inset Flex Code
20963 \begin_layout Plain Layout
20972 \begin_inset Flex Code
20975 \begin_layout Plain Layout
20981 exactly as it would treat its definition.
20982 So, let us issue the obvious
20990 \begin_layout LyX-Code
20994 \begin_layout Standard
20995 or anything like it.
20997 shouldn't go into an infinite loop, but it may go into a long one before
21001 \begin_layout Standard
21002 The second sort of special definition might look like this:
21005 \begin_layout LyX-Code
21009 \begin_layout Standard
21010 This defines a translatable piece of text, which allows relevant parts of
21011 the bibliography to be translated.
21012 It can be included in a definition by treating it as a key:
21013 \begin_inset Flex Code
21016 \begin_layout Plain Layout
21023 Several of these are predefined in
21024 \begin_inset Flex Code
21027 \begin_layout Plain Layout
21034 Note that these are not macros, in the sense just defined.
21035 They will not be expanded.
21038 \begin_layout Standard
21039 So here then is an example that use all these features:
21040 \begin_inset VSpace defskip
21046 \begin_layout Standard
21050 !authoredit {%author%[[%author%, ]][[{%editor%[[%editor%, %_edtext%, ]]}]]}
21053 \begin_layout Standard
21054 \begin_inset VSpace defskip
21057 This defines a macro that prints the author, followed by a comma, if the
21059 \begin_inset Flex Code
21062 \begin_layout Plain Layout
21068 key is defined, or else prints the name of the editor, followed by the
21070 \begin_inset Flex Code
21073 \begin_layout Plain Layout
21079 or its translation (it is by default
21080 \begin_inset Quotes eld
21084 \begin_inset Quotes erd
21088 \begin_inset Flex Code
21091 \begin_layout Plain Layout
21098 Note that this is in fact defined in
21099 \begin_inset Flex Code
21102 \begin_layout Plain Layout
21108 , so you can use it in your own definitions, or re-definitions, if you load
21112 \begin_layout Section
21113 \begin_inset CommandInset label
21115 name "sec:Tags-for-XHTML"
21119 Tags for XHTML output
21122 \begin_layout Standard
21123 As with \SpecialChar LaTeX
21124 or DocBook, the format of \SpecialChar LyX
21125 's XHTML output is also controlled by
21126 layout information.
21127 In general, \SpecialChar LyX
21128 provides sensible defaults and, as mentioned earlier, it will
21129 even construct default CSS style rules from the other layout tags.
21130 For example, \SpecialChar LyX
21131 will attempt to use the information provided in the
21132 \begin_inset Flex Code
21135 \begin_layout Plain Layout
21141 declaration for the Chapter style to write CSS that will appropriately
21142 format chapter headings.
21145 \begin_layout Standard
21146 In many cases, then, you may not have to do anything at all to get acceptable
21147 XHTML output for your own environments, custom insets, and so forth.
21148 But in some cases you will, and so \SpecialChar LyX
21149 provides a number of layout tags that
21150 can be used to customize the XHTML and CSS that are generated.
21153 \begin_layout Standard
21154 Note that there are two tags,
21155 \begin_inset Flex Code
21158 \begin_layout Plain Layout
21165 \begin_inset Flex Code
21168 \begin_layout Plain Layout
21174 that may appear outside style and inset declarations.
21176 \begin_inset CommandInset ref
21178 reference "subsec:General-text-class"
21182 for details on these.
21185 \begin_layout Subsection
21186 \begin_inset CommandInset label
21188 name "subsec:Paragraph-Style-XHTML"
21195 \begin_layout Standard
21196 The sort of XHTML \SpecialChar LyX
21197 outputs for a paragraph depends upon whether we are dealing
21198 with a normal paragraph, a command, or an environment, where this is itself
21199 determined by the contents of the corresponding
21200 \begin_inset Flex Code
21203 \begin_layout Plain Layout
21214 \begin_layout Standard
21215 For a command or normal paragraph, the output XHTML has the following form:
21218 \begin_layout LyX-Code
21220 \begin_inset Quotes erd
21224 \begin_inset Quotes erd
21230 \begin_layout LyX-Code
21232 \begin_inset Quotes erd
21236 \begin_inset Quotes erd
21242 \begin_layout LyX-Code
21243 Contents of the paragraph.
21246 \begin_layout LyX-Code
21250 \begin_layout Standard
21251 The label tags are of course omitted if the paragraph does not have a label.
21254 \begin_layout Standard
21255 For an environment that is not some sort of list, the XHTML takes this form:
21258 \begin_layout LyX-Code
21260 \begin_inset Quotes erd
21264 \begin_inset Quotes erd
21270 \begin_layout LyX-Code
21272 \begin_inset Quotes erd
21276 \begin_inset Quotes erd
21280 \begin_inset Quotes erd
21284 \begin_inset Quotes erd
21287 >Environment Label</labeltag>First paragraph.</itemtag>
21290 \begin_layout LyX-Code
21291 <itemtag>Second paragraph.</itemtag>
21294 \begin_layout LyX-Code
21298 \begin_layout Standard
21299 Note that the label is output only for the first paragraph, as it should
21300 be for a theorem, for example.
21304 \begin_layout Standard
21305 For a list, we have one of these forms:
21308 \begin_layout LyX-Code
21310 \begin_inset Quotes erd
21314 \begin_inset Quotes erd
21320 \begin_layout LyX-Code
21322 \begin_inset Quotes erd
21326 \begin_inset Quotes erd
21330 \begin_inset Quotes erd
21334 \begin_inset Quotes erd
21337 >List Label</labeltag>First item.</itemtag>
21340 \begin_layout LyX-Code
21342 \begin_inset Quotes erd
21346 \begin_inset Quotes erd
21350 \begin_inset Quotes erd
21354 \begin_inset Quotes erd
21357 >List Label</labeltag>Second item.</itemtag>
21360 \begin_layout LyX-Code
21364 \begin_layout LyX-Code
21368 \begin_layout LyX-Code
21370 \begin_inset Quotes erd
21374 \begin_inset Quotes erd
21380 \begin_layout LyX-Code
21382 \begin_inset Quotes erd
21386 \begin_inset Quotes erd
21389 >List Label</labeltag><itemtag attr=
21390 \begin_inset Quotes erd
21394 \begin_inset Quotes erd
21397 >First item.</itemtag>
21400 \begin_layout LyX-Code
21402 \begin_inset Quotes erd
21406 \begin_inset Quotes erd
21409 >List Label</labeltag><itemtag attr=
21410 \begin_inset Quotes erd
21414 \begin_inset Quotes erd
21417 >Second item.</itemtag>
21420 \begin_layout LyX-Code
21424 \begin_layout Standard
21425 Note the different orders of
21426 \begin_inset Flex Code
21429 \begin_layout Plain Layout
21436 \begin_inset Flex Code
21439 \begin_layout Plain Layout
21446 Which order we get depends upon the setting of
21447 \begin_inset Flex Code
21450 \begin_layout Plain Layout
21457 \begin_inset Flex Code
21460 \begin_layout Plain Layout
21466 is false (the default), you get the first of these, with the label within
21467 the item; if true, you get the second, with the label outside the item.
21470 \begin_layout Standard
21471 The specific tags and attributes output for each paragraph type can be controlle
21472 d by means of the layout tags we are about to describe.
21473 As mentioned earlier, however, \SpecialChar LyX
21474 uses sensible defaults for many of these,
21475 so you often may not need to do very much to get good XHTML output.
21476 Think of the available tags as there so you can tweak things to your liking.
21479 \begin_layout Description
21480 \begin_inset Flex Code
21483 \begin_layout Plain Layout
21490 \begin_inset Flex Code
21493 \begin_layout Plain Layout
21499 ] Specifies attribute information to be output with the main tag.
21501 \begin_inset Quotes eld
21505 \begin_inset Flex Code
21508 \begin_layout Plain Layout
21515 \begin_inset Quotes erd
21519 By default, \SpecialChar LyX
21521 \begin_inset Quotes eld
21525 \begin_inset Flex Code
21528 \begin_layout Plain Layout
21535 \begin_inset Quotes erd
21539 \begin_inset Flex Code
21542 \begin_layout Plain Layout
21548 is the \SpecialChar LyX
21549 name of the layout, made lowercase, for example: chapter.
21554 contain any style information.
21556 \begin_inset Flex Code
21559 \begin_layout Plain Layout
21568 \begin_layout Description
21569 \begin_inset Flex Code
21572 \begin_layout Plain Layout
21579 \begin_inset Flex Code
21582 \begin_layout Plain Layout
21592 ] Whether to output the default CSS information \SpecialChar LyX
21593 generates for this layout,
21594 even if additional information is explicitly provided via
21595 \begin_inset Flex Code
21598 \begin_layout Plain Layout
21606 \begin_inset Flex Code
21609 \begin_layout Plain Layout
21615 allows you to alter or augment the generated CSS, rather than to override
21618 \begin_inset Flex Code
21621 \begin_layout Plain Layout
21630 \begin_layout Description
21631 \begin_inset Flex Code
21634 \begin_layout Plain Layout
21641 \begin_inset Flex Code
21644 \begin_layout Plain Layout
21650 ] The tag to be used for individual paragraphs of environments, replacing
21652 \begin_inset Flex Code
21655 \begin_layout Plain Layout
21661 in the examples above.
21663 \begin_inset Flex Code
21666 \begin_layout Plain Layout
21675 \begin_layout Description
21676 \begin_inset Flex Code
21679 \begin_layout Plain Layout
21686 \begin_inset Flex Code
21689 \begin_layout Plain Layout
21695 ] Attributes for the item tag.
21697 \begin_inset Quotes eld
21701 \begin_inset Flex Code
21704 \begin_layout Plain Layout
21705 class=`layoutname_item'
21711 \begin_inset Quotes erd
21719 contain any style information.
21721 \begin_inset Flex Code
21724 \begin_layout Plain Layout
21733 \begin_layout Description
21734 \begin_inset Flex Code
21737 \begin_layout Plain Layout
21744 \begin_inset Flex Code
21747 \begin_layout Plain Layout
21753 ] The tag to be used for paragraph and item labels, replacing
21754 \begin_inset Flex Code
21757 \begin_layout Plain Layout
21763 in the examples above.
21765 \begin_inset Flex Code
21768 \begin_layout Plain Layout
21775 \begin_inset Flex Code
21778 \begin_layout Plain Layout
21785 \begin_inset Flex Code
21788 \begin_layout Plain Layout
21795 \begin_inset Flex Code
21798 \begin_layout Plain Layout
21799 Centered_Top_Environment
21804 , in which case it defaults to
21805 \begin_inset Flex Code
21808 \begin_layout Plain Layout
21817 \begin_layout Description
21818 \begin_inset Flex Code
21821 \begin_layout Plain Layout
21828 \begin_inset Flex Code
21831 \begin_layout Plain Layout
21837 ] Attributes for the label tag.
21839 \begin_inset Quotes eld
21843 \begin_inset Flex Code
21846 \begin_layout Plain Layout
21847 class=`layoutname_label'
21853 \begin_inset Quotes erd
21861 contain any style information.
21863 \begin_inset Flex Code
21866 \begin_layout Plain Layout
21875 \begin_layout Description
21876 \begin_inset Flex Code
21879 \begin_layout Plain Layout
21886 \begin_inset Flex Code
21889 \begin_layout Plain Layout
21899 ] Meaningful only for list-like environments, this tag controls whether
21900 the label tag is output before or inside the item tag.
21901 This is used, for example, in the description environment, where we want
21903 \begin_inset Flex Code
21906 \begin_layout Plain Layout
21907 <dt>\SpecialChar ldots
21908 </dt><dd>\SpecialChar ldots
21916 \begin_inset Flex Code
21919 \begin_layout Plain Layout
21925 : The label tag is output inside the item tag.
21928 \begin_layout Description
21929 \begin_inset Flex Code
21932 \begin_layout Plain Layout
21938 Information to be output in the
21939 \begin_inset Flex Code
21942 \begin_layout Plain Layout
21948 section when this style is used.
21949 This might, for example, be used to include a
21950 \begin_inset Flex Code
21953 \begin_layout Plain Layout
21960 \begin_inset Flex Code
21963 \begin_layout Plain Layout
21972 \begin_layout Description
21973 \begin_inset Flex Code
21976 \begin_layout Plain Layout
21982 CSS style information to be included when this style is used.
21983 Note that this will automatically be wrapped in a layout-generated
21984 \begin_inset Flex Code
21987 \begin_layout Plain Layout
21993 block, so only the CSS itself need be included.
21995 \begin_inset Flex Code
21998 \begin_layout Plain Layout
22007 \begin_layout Description
22008 \begin_inset Flex Code
22011 \begin_layout Plain Layout
22018 \begin_inset Flex Code
22021 \begin_layout Plain Layout
22027 ] The tag to be used for the main label, replacing
22028 \begin_inset Flex Code
22031 \begin_layout Plain Layout
22037 in the examples above.
22039 \begin_inset Flex Code
22042 \begin_layout Plain Layout
22051 \begin_layout Description
22052 \begin_inset Flex Code
22055 \begin_layout Plain Layout
22062 \begin_inset Flex Code
22065 \begin_layout Plain Layout
22075 ] Marks this style as the one to be used to generate the
22076 \begin_inset Flex Code
22079 \begin_layout Plain Layout
22085 tag for the XHTML file.
22086 By default, it is false.
22088 \begin_inset Flex Code
22091 \begin_layout Plain Layout
22097 file sets it to true for the
22098 \begin_inset Flex Code
22101 \begin_layout Plain Layout
22111 \begin_layout Subsection
22115 \begin_layout Standard
22116 The XHTML output of insets can also be controlled by information in layout
22121 \begin_layout Plain Layout
22122 At present, this is true only for
22123 \begin_inset Quotes eld
22127 \begin_inset Quotes erd
22130 insets (insets you can type into) and is not true for
22131 \begin_inset Quotes eld
22135 \begin_inset Quotes erd
22138 insets (insets that are associated with dialog boxes).
22143 Here, too, \SpecialChar LyX
22144 tries to provide sensible defaults, and it constructs default
22146 But everything can be customized.
22149 \begin_layout Standard
22150 The XHTML \SpecialChar LyX
22151 outputs for an inset has the following form:
22154 \begin_layout LyX-Code
22156 \begin_inset Quotes erd
22160 \begin_inset Quotes erd
22166 \begin_layout LyX-Code
22167 <labeltag>Label</labeltag>
22170 \begin_layout LyX-Code
22172 \begin_inset Quotes erd
22176 \begin_inset Quotes erd
22179 >Contents of the inset.</innertag>
22182 \begin_layout LyX-Code
22186 \begin_layout Standard
22187 If the inset permits multiple paragraphs—that is, if
22188 \begin_inset Flex Code
22191 \begin_layout Plain Layout
22197 is true—then the contents of the inset will itself be output as paragraphs
22198 formatted according to the styles used for those paragraphs (standard,
22199 quote, and the like).
22200 The label tag is of course omitted if the paragraph does not have a label
22201 and, at present, is always
22202 \begin_inset Flex Code
22205 \begin_layout Plain Layout
22212 The inner tag is optional and, by default, does not appear.
22215 \begin_layout Standard
22216 The specific tags and attributes output for each inset can be controlled
22217 by means of the following layout tags.
22220 \begin_layout Description
22221 \begin_inset Flex Code
22224 \begin_layout Plain Layout
22231 \begin_inset Flex Code
22234 \begin_layout Plain Layout
22240 ] Specifies attribute information to be output with the main tag.
22242 \begin_inset Quotes eld
22246 \begin_inset Flex Code
22249 \begin_layout Plain Layout
22250 class=`myinset' onclick=`\SpecialChar ldots
22257 \begin_inset Quotes erd
22261 By default, \SpecialChar LyX
22263 \begin_inset Quotes eld
22267 \begin_inset Flex Code
22270 \begin_layout Plain Layout
22277 \begin_inset Quotes erd
22281 \begin_inset Flex Code
22284 \begin_layout Plain Layout
22290 is the \SpecialChar LyX
22291 name of the inset, made lowercase and with non-alphanumeric characters
22292 converted to underscores, for example: footnote.
22295 \begin_layout Description
22296 \begin_inset Flex Code
22299 \begin_layout Plain Layout
22306 \begin_inset Flex Code
22309 \begin_layout Plain Layout
22319 ] Whether to output the default CSS information \SpecialChar LyX
22320 generates for this layout,
22321 even if additional information is explicitly provided via
22322 \begin_inset Flex Code
22325 \begin_layout Plain Layout
22333 \begin_inset Flex Code
22336 \begin_layout Plain Layout
22342 allows you to alter or augment the generated CSS, rather than to override
22347 \begin_layout Description
22348 \begin_inset Flex Code
22351 \begin_layout Plain Layout
22358 \begin_inset Flex Code
22361 \begin_layout Plain Layout
22367 ] Attributes for the inner tag.
22369 \begin_inset Quotes eld
22373 \begin_inset Flex Code
22376 \begin_layout Plain Layout
22377 class=`insetname_inner'
22383 \begin_inset Quotes erd
22389 \begin_layout Description
22390 \begin_inset Flex Code
22393 \begin_layout Plain Layout
22400 \begin_inset Flex Code
22403 \begin_layout Plain Layout
22409 ] The inner tag, replacing
22410 \begin_inset Flex Code
22413 \begin_layout Plain Layout
22419 in the examples above.
22420 By default, there is none.
22423 \begin_layout Description
22424 \begin_inset Flex Code
22427 \begin_layout Plain Layout
22434 \begin_inset Flex Code
22437 \begin_layout Plain Layout
22445 ] Whether this inset represents a standalone block of text (such as a footnote)
22446 or instead represents material that is included in the surrounding text
22447 (such as a branch).
22451 \begin_layout Description
22452 \begin_inset Flex Code
22455 \begin_layout Plain Layout
22462 \begin_inset Flex Code
22465 \begin_layout Plain Layout
22471 ] A label for this inset, possibly including a reference to a counter.
22472 For example, for footnote, it might be:
22473 \begin_inset Flex Code
22476 \begin_layout Plain Layout
22485 This is optional, and there is no default.
22488 \begin_layout Description
22489 \begin_inset Flex Code
22492 \begin_layout Plain Layout
22498 Information to be output in the
22499 \begin_inset Flex Code
22502 \begin_layout Plain Layout
22508 section when this style is used.
22509 This might, for example, be used to include a
22510 \begin_inset Flex Code
22513 \begin_layout Plain Layout
22520 \begin_inset Flex Code
22523 \begin_layout Plain Layout
22532 \begin_layout Description
22533 \begin_inset Flex Code
22536 \begin_layout Plain Layout
22542 CSS style information to be included when this style is used.
22543 Note that this will automatically be wrapped in a layout-generated
22544 \begin_inset Flex Code
22547 \begin_layout Plain Layout
22553 block, so only the CSS itself need be included.
22556 \begin_layout Description
22557 \begin_inset Flex Code
22560 \begin_layout Plain Layout
22567 \begin_inset Flex Code
22570 \begin_layout Plain Layout
22576 ] The tag to be used for the main label, replacing
22577 \begin_inset Flex Code
22580 \begin_layout Plain Layout
22586 in the examples above.
22587 The default depends upon the setting of
22588 \begin_inset Flex Code
22591 \begin_layout Plain Layout
22598 \begin_inset Flex Code
22601 \begin_layout Plain Layout
22607 is true, the default is
22608 \begin_inset Flex Code
22611 \begin_layout Plain Layout
22617 ; if it is false, the default is
22618 \begin_inset Flex Code
22621 \begin_layout Plain Layout
22630 \begin_layout Subsection
22634 \begin_layout Standard
22635 The XHTML output for floats too can be controlled by layout information.
22636 The output has the following form:
22639 \begin_layout LyX-Code
22641 \begin_inset Quotes erd
22645 \begin_inset Quotes erd
22651 \begin_layout LyX-Code
22652 Contents of the float.
22655 \begin_layout LyX-Code
22659 \begin_layout Standard
22660 The caption, if there is one, is a separate inset and will be output as
22662 Its appearance can be controlled via the InsetLayout for caption insets.
22666 \begin_layout Description
22667 \begin_inset Flex Code
22670 \begin_layout Plain Layout
22677 \begin_inset Flex Code
22680 \begin_layout Plain Layout
22686 ] Specifies attribute information to be output with the main tag.
22688 \begin_inset Quotes eld
22692 \begin_inset Flex Code
22695 \begin_layout Plain Layout
22696 class=`myfloat' onclick=`\SpecialChar ldots
22703 \begin_inset Quotes erd
22707 By default, \SpecialChar LyX
22709 \begin_inset Quotes eld
22713 \begin_inset Flex Code
22716 \begin_layout Plain Layout
22717 class=`float float-floattype'
22723 \begin_inset Quotes erd
22727 \begin_inset Flex Code
22730 \begin_layout Plain Layout
22736 is \SpecialChar LyX
22737 's name for this type of float, as determined by the float declaration
22739 \begin_inset CommandInset ref
22741 reference "subsec:Floats"
22745 ), though made lowercase and with non-alphanumeric characters converted
22746 to underscores, for example: float-table.
22749 \begin_layout Description
22750 \begin_inset Flex Code
22753 \begin_layout Plain Layout
22759 CSS style information to be included when this float is used.
22760 Note that this will automatically be wrapped in a layout-generated
22761 \begin_inset Flex Code
22764 \begin_layout Plain Layout
22770 block, so only the CSS itself need be included.
22773 \begin_layout Description
22774 \begin_inset Flex Code
22777 \begin_layout Plain Layout
22784 \begin_inset Flex Code
22787 \begin_layout Plain Layout
22793 ] The tag to be used for this float, replacing
22794 \begin_inset Quotes eld
22798 \begin_inset Flex Code
22801 \begin_layout Plain Layout
22808 \begin_inset Quotes erd
22811 in the example above.
22813 \begin_inset Flex Code
22816 \begin_layout Plain Layout
22822 and will rarely need changing.
22825 \begin_layout Subsection
22826 Bibliography formatting
22829 \begin_layout Standard
22830 The bibliography can be formatted using
22831 \begin_inset Flex Code
22834 \begin_layout Plain Layout
22842 \begin_inset CommandInset ref
22844 reference "subsec:Citation-format-description"
22851 \begin_layout Subsection
22856 \begin_layout Standard
22857 We have several times mentioned that \SpecialChar LyX
22858 will generate default CSS style rules
22859 for both insets and paragraph styles, based upon the other layout information
22861 In this section, we shall say a word about which layout information \SpecialChar LyX
22866 \begin_layout Standard
22867 At present, \SpecialChar LyX
22868 auto-generates CSS only for font information, making use of
22870 \begin_inset Flex Code
22873 \begin_layout Plain Layout
22880 \begin_inset Flex Code
22883 \begin_layout Plain Layout
22890 \begin_inset Flex Code
22893 \begin_layout Plain Layout
22900 \begin_inset Flex Code
22903 \begin_layout Plain Layout
22910 \begin_inset Flex Code
22913 \begin_layout Plain Layout
22920 \begin_inset CommandInset ref
22922 reference "subsec:Font-description"
22927 The translation is mostly straightforward and obvious.
22929 \begin_inset Quotes eld
22933 \begin_inset Flex Code
22936 \begin_layout Plain Layout
22943 \begin_inset Quotes erd
22947 \begin_inset Quotes eld
22951 \begin_inset Flex Code
22954 \begin_layout Plain Layout
22955 font-family: sans-serif;
22961 \begin_inset Quotes erd
22965 The correspondence of \SpecialChar LyX
22966 sizes and CSS sizes is a little less obvious but
22967 nonetheless intuitive.
22969 \begin_inset Flex Code
22972 \begin_layout Plain Layout
22979 \begin_inset Flex URL
22982 \begin_layout Plain Layout
22992 \begin_layout Chapter
22993 Including External Material
22994 \begin_inset CommandInset label
22996 name "chap:Including-External-Material"
23003 \begin_layout Standard
23004 \begin_inset Box Shadowbox
23014 height_special "totalheight"
23019 backgroundcolor "none"
23022 \begin_layout Plain Layout
23023 WARNING: This portion of the documentation has not been updated for some
23025 We certainly hope that it is still accurate, but there are no guarantees.
23033 \begin_layout Standard
23034 The use of material from sources external to \SpecialChar LyX
23035 is covered in detail in the
23041 This part of the manual covers what needs to happen behind the scenes for
23042 new sorts of material to be included.
23045 \begin_layout Section
23049 \begin_layout Standard
23050 The external material feature is based on the concept of a
23055 A template is a specification of how \SpecialChar LyX
23056 should interface with a certain kind
23058 As bundled, \SpecialChar LyX
23059 comes with predefined templates for Xfig figures, various
23060 raster format images, chess diagrams, and LilyPond music notation.
23061 You can check the actual list by using the menu
23062 \begin_inset Flex MenuItem
23065 \begin_layout Plain Layout
23066 Insert\SpecialChar menuseparator
23067 File\SpecialChar menuseparator
23074 Furthermore, it is possible to roll your own template to support a specific
23076 Later we'll describe in more detail what is involved, and hopefully you
23077 will submit all the templates you create so we can include them in a later
23082 \begin_layout Standard
23083 Another basic idea of the external material feature is to distinguish between
23084 the original file that serves as a base for final material and the produced
23085 file that is included in your exported or printed document.
23086 For example, consider the case of a figure produced with
23087 \begin_inset Flex Code
23090 \begin_layout Plain Layout
23097 The Xfig application itself works on an original file with the
23098 \begin_inset Flex Code
23101 \begin_layout Plain Layout
23108 Within Xfig, you create and change your figure, and when you are done,
23110 \begin_inset Flex Code
23113 \begin_layout Plain Layout
23120 When you want to include the figure in your document, you invoke
23121 \begin_inset Flex Code
23124 \begin_layout Plain Layout
23130 in order to create a PostScript file that can readily be included in your
23134 \begin_inset Flex Code
23137 \begin_layout Plain Layout
23143 file is the original file, and the PostScript file is the produced file.
23146 \begin_layout Standard
23147 This distinction is important in order to allow updating of the material
23148 while you are in the process of writing the document.
23149 Furthermore, it provides us with the flexibility that is needed to support
23150 multiple export formats.
23151 For instance, in the case of a plain text file, it is not exactly an award-winn
23152 ing idea to include the figure as raw PostScript.
23153 Instead, you would either prefer to just include a reference to the figure
23154 or try to invoke some graphics to ASCII converter to make the final result
23155 look similar to the real graphics.
23156 The external material management allows you to do this, because it is parametri
23157 zed on the different export formats that \SpecialChar LyX
23161 \begin_layout Standard
23162 Besides supporting the production of different products according to the
23163 exported format, it supports tight integration with editing and viewing
23165 In the case of an Xfig figure, you are able to invoke Xfig on the original
23166 file with a single click from within the external material dialog in \SpecialChar LyX
23168 and also preview the produced PostScript file with Ghostview with another
23170 No more fiddling around with the command line and/or file browsers to locate
23171 and manipulate the original or produced files.
23172 In this way, you are finally able to take full advantage of the many different
23173 applications that are relevant to use when you write your documents, and
23174 ultimately be more productive.
23177 \begin_layout Section
23178 The external template configuration file
23181 \begin_layout Standard
23182 It is relatively easy to add custom external template definitions to \SpecialChar LyX
23184 However, be aware that doing this in an careless manner most probably
23188 introduce an easily exploitable security hole.
23189 So before you do this, please read the discussion about security in
23190 \begin_inset CommandInset ref
23192 reference "sec:Security-discussion"
23199 \begin_layout Standard
23200 Having said that, we encourage you to submit any interesting templates that
23205 \begin_layout Standard
23206 The external templates are defined in the
23207 \begin_inset Flex Code
23210 \begin_layout Plain Layout
23212 \change_deleted -712698321 1437634905
23215 \change_inserted -712698321 1437634906
23218 Dir/lib/external_templates
23224 You can place your own version in
23225 \begin_inset Flex Code
23228 \begin_layout Plain Layout
23229 UserDir/external_templates
23237 \begin_layout Standard
23238 A typical template looks like this:
23241 \begin_layout LyX-Code
23245 \begin_layout LyX-Code
23246 GuiName "XFig: $$AbsOrRelPathParent$$Basename"
23249 \begin_layout LyX-Code
23253 \begin_layout LyX-Code
23257 \begin_layout LyX-Code
23261 \begin_layout LyX-Code
23265 \begin_layout LyX-Code
23269 \begin_layout LyX-Code
23270 AutomaticProduction true
23273 \begin_layout LyX-Code
23277 \begin_layout LyX-Code
23281 \begin_layout LyX-Code
23282 Format \SpecialChar LaTeX
23286 \begin_layout LyX-Code
23287 TransformCommand Rotate RotationLatexCommand
23290 \begin_layout LyX-Code
23291 TransformCommand Resize ResizeLatexCommand
23294 \begin_layout LyX-Code
23295 Product "$$RotateFront$$ResizeFront
23298 \begin_layout LyX-Code
23303 input{$$AbsOrRelPathMaster$$Basename.pstex_t}
23306 \begin_layout LyX-Code
23307 $$ResizeBack$$RotateBack"
23310 \begin_layout LyX-Code
23314 \begin_layout LyX-Code
23315 UpdateResult "$$AbsPath$$Basename.pstex_t"
23318 \begin_layout LyX-Code
23319 Requirement "graphicx"
23322 \begin_layout LyX-Code
23323 ReferencedFile latex "$$AbsOrRelPathMaster$$Basename.pstex_t"
23326 \begin_layout LyX-Code
23327 ReferencedFile latex "$$AbsPath$$Basename.eps"
23330 \begin_layout LyX-Code
23331 ReferencedFile dvi "$$AbsPath$$Basename.eps"
23334 \begin_layout LyX-Code
23338 \begin_layout LyX-Code
23339 Format PDF\SpecialChar LaTeX
23343 \begin_layout LyX-Code
23344 TransformCommand Rotate RotationLatexCommand
23347 \begin_layout LyX-Code
23348 TransformCommand Resize ResizeLatexCommand
23351 \begin_layout LyX-Code
23352 Product "$$RotateFront$$ResizeFront
23355 \begin_layout LyX-Code
23360 input{$$AbsOrRelPathMaster$$Basename.pdftex_t}
23363 \begin_layout LyX-Code
23364 $$ResizeBack$$RotateBack"
23367 \begin_layout LyX-Code
23368 UpdateFormat pdftex
23371 \begin_layout LyX-Code
23372 UpdateResult "$$AbsPath$$Basename.pdftex_t"
23375 \begin_layout LyX-Code
23376 Requirement "graphicx"
23379 \begin_layout LyX-Code
23380 ReferencedFile latex "$$AbsOrRelPathMaster$$Basename.pdftex_t"
23383 \begin_layout LyX-Code
23384 ReferencedFile latex "$$AbsPath$$Basename.pdf"
23387 \begin_layout LyX-Code
23391 \begin_layout LyX-Code
23395 \begin_layout LyX-Code
23396 Product "$$Contents(
23398 "$$AbsPath$$Basename.asc
23403 \begin_layout LyX-Code
23404 UpdateFormat asciixfig
23407 \begin_layout LyX-Code
23408 UpdateResult "$$AbsPath$$Basename.asc"
23411 \begin_layout LyX-Code
23415 \begin_layout LyX-Code
23419 \begin_layout LyX-Code
23420 Product "<graphic fileref=
23422 "$$AbsOrRelPathMaster$$Basename.eps
23427 \begin_layout LyX-Code
23431 \begin_layout LyX-Code
23435 \begin_layout LyX-Code
23436 UpdateResult "$$AbsPath$$Basename.eps"
23439 \begin_layout LyX-Code
23440 ReferencedFile docbook "$$AbsPath$$Basename.eps"
23443 \begin_layout LyX-Code
23444 ReferencedFile docbook-xml "$$AbsPath$$Basename.eps"
23447 \begin_layout LyX-Code
23451 \begin_layout LyX-Code
23452 Product "[XFig: $$FName]"
23455 \begin_layout LyX-Code
23459 \begin_layout LyX-Code
23463 \begin_layout Standard
23464 As you can see, the template is enclosed in
23465 \begin_inset Flex Code
23468 \begin_layout Plain Layout
23476 \begin_inset Flex Code
23479 \begin_layout Plain Layout
23486 It contains a header specifying some general settings and, for each supported
23487 primary document file format, a section
23488 \begin_inset Flex Code
23491 \begin_layout Plain Layout
23499 \begin_inset Flex Code
23502 \begin_layout Plain Layout
23511 \begin_layout Subsection
23512 The template header
23515 \begin_layout Description
23516 \begin_inset Flex Code
23519 \begin_layout Plain Layout
23520 AutomaticProduction
23521 \begin_inset space ~
23529 Whether the file represented by the template must be generated by \SpecialChar LyX
23531 This command must occur exactly once.
23534 \begin_layout Description
23535 \begin_inset Flex Code
23538 \begin_layout Plain Layout
23540 \begin_inset space ~
23548 A glob pattern that is used in the file dialog to filter out the desired
23550 If there is more than one possible file extension (e.
23551 \begin_inset space \thinspace{}
23555 \begin_inset space \space{}
23559 \begin_inset Flex Code
23562 \begin_layout Plain Layout
23569 \begin_inset Flex Code
23572 \begin_layout Plain Layout
23578 ), use something like
23579 \begin_inset Flex Code
23582 \begin_layout Plain Layout
23589 This command must occur exactly once.
23592 \begin_layout Description
23593 \begin_inset Flex Code
23596 \begin_layout Plain Layout
23598 \begin_inset space ~
23606 The text that is displayed on the button.
23607 This command must occur exactly once.
23610 \begin_layout Description
23611 \begin_inset Flex Code
23614 \begin_layout Plain Layout
23616 \begin_inset space ~
23620 \begin_inset space ~
23628 The help text that is used in the External dialog.
23629 Provide enough information to explain to the user just what the template
23630 can provide him with.
23631 This command must occur exactly once.
23634 \begin_layout Description
23635 \begin_inset Flex Code
23638 \begin_layout Plain Layout
23640 \begin_inset space ~
23648 The file format of the original file.
23649 This must be the name of a format that is known to \SpecialChar LyX
23651 \begin_inset CommandInset ref
23653 reference "sec:Formats"
23659 \begin_inset Quotes eld
23663 \begin_inset Flex Code
23666 \begin_layout Plain Layout
23673 \begin_inset Quotes erd
23676 if the template can handle original files of more than one format.
23678 will attempt to interrogate the file itself in order to deduce its format
23680 This command must occur exactly once.
23683 \begin_layout Description
23684 \begin_inset Flex Code
23687 \begin_layout Plain Layout
23689 \begin_inset space ~
23697 A unique name for the template.
23698 It must not contain substitution macros (see below).
23701 \begin_layout Description
23702 \begin_inset Flex Code
23705 \begin_layout Plain Layout
23707 \begin_inset space ~
23710 Rotate|Resize|Clip|Extra
23715 This command specifies which transformations are supported by this template.
23716 It may occur zero or more times.
23717 This command enables the corresponding tabs in the external dialog.
23719 \begin_inset Flex Code
23722 \begin_layout Plain Layout
23728 command must have either a corresponding
23729 \begin_inset Flex Code
23732 \begin_layout Plain Layout
23739 \begin_inset Flex Code
23742 \begin_layout Plain Layout
23749 \begin_inset Flex Code
23752 \begin_layout Plain Layout
23759 Otherwise the transformation will not be supported by that format.
23762 \begin_layout Subsection
23766 \begin_layout Description
23767 \begin_inset Flex Code
23770 \begin_layout Plain Layout
23772 \begin_inset space ~
23776 \change_inserted -195340706 1437418821
23778 \change_inserted -712698321 1437634430
23780 \change_deleted -712698321 1437634429
23782 \change_inserted -195340706 1437418821
23784 \change_deleted -195340706 1437418827
23789 \change_inserted -195340706 1437418856
23791 \change_inserted -712698321 1437634432
23793 \change_deleted -712698321 1437634432
23795 \change_inserted -195340706 1437418856
23797 \change_deleted -195340706 1437418857
23806 The primary document file format that this format definition is for.
23807 Not every template has a sensible representation in all document file formats.
23808 Please define nevertheless a
23809 \begin_inset Flex Code
23812 \begin_layout Plain Layout
23818 section for all templates.
23819 Use a dummy text when no representation is available.
23820 Then you can at least see a reference to the external material in the exported
23824 \begin_layout Description
23825 \begin_inset Flex Code
23828 \begin_layout Plain Layout
23830 \begin_inset space ~
23834 \begin_inset space ~
23842 This command defines an additional macro
23843 \begin_inset Flex Code
23846 \begin_layout Plain Layout
23852 for substitution in
23853 \begin_inset Flex Code
23856 \begin_layout Plain Layout
23864 \begin_inset Flex Code
23867 \begin_layout Plain Layout
23873 itself may contain substitution macros.
23874 The advantage over using
23875 \begin_inset Flex Code
23878 \begin_layout Plain Layout
23885 \begin_inset Flex Code
23888 \begin_layout Plain Layout
23894 is that the substituted value of
23895 \begin_inset Flex Code
23898 \begin_layout Plain Layout
23904 is sanitized so that it is a valid optional argument in the document format.
23905 This command may occur zero or more times.
23908 \begin_layout Description
23909 \begin_inset Flex Code
23912 \begin_layout Plain Layout
23914 \begin_inset space ~
23922 The text that is inserted in the exported document.
23923 This is actually the most important command and can be quite complex.
23924 This command must occur exactly once.
23927 \begin_layout Description
23928 \begin_inset Flex Code
23931 \begin_layout Plain Layout
23933 \begin_inset space ~
23941 This command specifies a preamble snippet that will be included in the
23944 It has to be defined using
23945 \begin_inset Flex Code
23948 \begin_layout Plain Layout
23956 \begin_inset Flex Code
23959 \begin_layout Plain Layout
23966 This command may occur zero or more times.
23969 \begin_layout Description
23970 \begin_inset Flex Code
23973 \begin_layout Plain Layout
23975 \begin_inset space ~
23979 \begin_inset space ~
23987 This command denotes files that are created by the conversion process and
23988 are needed for a particular export format.
23989 If the filename is relative, it is interpreted relative to the master document.
23990 This command may be given zero or more times.
23993 \begin_layout Description
23994 \begin_inset Flex Code
23997 \begin_layout Plain Layout
23999 \begin_inset space ~
24007 The name of a required \SpecialChar LaTeX
24009 The package is included via
24010 \begin_inset Flex Code
24013 \begin_layout Plain Layout
24021 in the \SpecialChar LaTeX
24023 This command may occur zero or more times.
24026 \begin_layout Description
24027 \begin_inset Flex Code
24030 \begin_layout Plain Layout
24032 \begin_inset space ~
24036 \begin_inset space ~
24039 RotationLatexCommand
24044 This command specifies that the built in \SpecialChar LaTeX
24045 command should be used for rotation.
24046 This command may occur once or not at all.
24049 \begin_layout Description
24050 \begin_inset Flex Code
24053 \begin_layout Plain Layout
24055 \begin_inset space ~
24059 \begin_inset space ~
24067 This command specifies that the built in \SpecialChar LaTeX
24068 command should be used for resizing.
24069 This command may occur once or not at all.
24072 \begin_layout Description
24073 \begin_inset Flex Code
24076 \begin_layout Plain Layout
24078 \begin_inset space ~
24082 \begin_inset space ~
24085 RotationLatexOption
24090 This command specifies that rotation is done via an optional argument.
24091 This command may occur once or not at all.
24094 \begin_layout Description
24095 \begin_inset Flex Code
24098 \begin_layout Plain Layout
24100 \begin_inset space ~
24104 \begin_inset space ~
24112 This command specifies that resizing is done via an optional argument.
24113 This command may occur once or not at all.
24116 \begin_layout Description
24117 \begin_inset Flex Code
24120 \begin_layout Plain Layout
24122 \begin_inset space ~
24126 \begin_inset space ~
24134 This command specifies that clipping is done via an optional argument.
24135 This command may occur once or not at all.
24138 \begin_layout Description
24139 \begin_inset Flex Code
24142 \begin_layout Plain Layout
24144 \begin_inset space ~
24148 \begin_inset space ~
24156 This command specifies that an extra optional argument is used.
24157 This command may occur once or not at all.
24160 \begin_layout Description
24161 \begin_inset Flex Code
24164 \begin_layout Plain Layout
24166 \begin_inset space ~
24174 The file format of the converted file.
24175 This must be the name of a format that is known to \SpecialChar LyX
24177 \begin_inset Flex MenuItem
24180 \begin_layout Plain Layout
24181 Tools\SpecialChar menuseparator
24182 Preferences\SpecialChar menuseparator
24183 File Handling\SpecialChar menuseparator
24190 This command must occur exactly once.
24191 If the resulting file format is PDF, you need to specify the format
24192 \begin_inset Flex Code
24195 \begin_layout Plain Layout
24202 This is the PDF format used for including graphics.
24203 The other defined PDF formats are for document export.
24206 \begin_layout Description
24207 \begin_inset Flex Code
24210 \begin_layout Plain Layout
24212 \begin_inset space ~
24220 The file name of the converted file.
24221 The file name must be absolute.
24222 This command must occur exactly once.
24225 \begin_layout Subsection
24226 Preamble definitions
24229 \begin_layout Standard
24230 The external template configuration file may contain additional preamble
24231 definitions enclosed by
24232 \begin_inset Flex Code
24235 \begin_layout Plain Layout
24243 \begin_inset Flex Code
24246 \begin_layout Plain Layout
24253 They can be used by the templates in the
24254 \begin_inset Flex Code
24257 \begin_layout Plain Layout
24266 \begin_layout Section
24267 The substitution mechanism
24270 \begin_layout Standard
24271 When the external material facility invokes an external program, it is done
24272 on the basis of a command defined in the template configuration file.
24273 These commands can contain various macros that are expanded before execution.
24274 Execution always take place in the directory of the containing document.
24277 \begin_layout Standard
24278 Also, whenever external material is to be displayed, the name will be produced
24279 by the substitution mechanism, and most other commands in the template
24280 definition support substitution as well.
24283 \begin_layout Standard
24284 The available macros are the following:
24287 \begin_layout Description
24288 \begin_inset Flex Code
24291 \begin_layout Plain Layout
24292 $$AbsOrRelPathMaster
24297 The file path, absolute or relative to the master \SpecialChar LyX
24301 \begin_layout Description
24302 \begin_inset Flex Code
24305 \begin_layout Plain Layout
24306 $$AbsOrRelPathParent
24311 The file path, absolute or relative to the \SpecialChar LyX
24315 \begin_layout Description
24316 \begin_inset Flex Code
24319 \begin_layout Plain Layout
24325 The absolute file path.
24328 \begin_layout Description
24329 \begin_inset Flex Code
24332 \begin_layout Plain Layout
24338 The filename without path and without the extension.
24341 \begin_layout Description
24342 \begin_inset Flex Code
24345 \begin_layout Plain Layout
24347 \begin_inset Quotes eld
24351 \begin_inset Quotes erd
24359 This macro will expand to the contents of the file with the name
24360 \begin_inset Flex Code
24363 \begin_layout Plain Layout
24372 \begin_layout Description
24373 \begin_inset Flex Code
24376 \begin_layout Plain Layout
24382 The file extension (including the dot).
24383 \change_inserted -195340706 1437418878
24387 \begin_layout Description
24389 \change_inserted -195340706 1437418878
24390 \begin_inset Flex Code
24393 \begin_layout Plain Layout
24395 \change_inserted -195340706 1437418878
24401 This will be the string
24402 \begin_inset Quotes eld
24406 \begin_inset Quotes erd
24409 if the file is in JPEG format, otherwise it will be the string
24410 \begin_inset Quotes eld
24414 \begin_inset Quotes erd
24418 This is useful to avoid uneeded conversions for output formats that support
24419 both PNG and JPEG fomats.
24420 The predefined RasterImage template uses this macro for the PDFL
24421 \change_deleted -712698321 1437634446
24423 \change_inserted -712698321 1437634446
24425 \change_inserted -195340706 1437418878
24431 \begin_layout Description
24432 \begin_inset Flex Code
24435 \begin_layout Plain Layout
24441 The filename of the file specified in the external material dialog.
24442 This is either an absolute name, or it is relative to the \SpecialChar LyX
24446 \begin_layout Description
24447 \begin_inset Flex Code
24450 \begin_layout Plain Layout
24457 \begin_inset Flex Code
24460 \begin_layout Plain Layout
24466 (absolute name or relative to the \SpecialChar LyX
24470 \begin_layout Description
24471 \begin_inset Flex Code
24474 \begin_layout Plain Layout
24480 The file path, relative to the master \SpecialChar LyX
24484 \begin_layout Description
24485 \begin_inset Flex Code
24488 \begin_layout Plain Layout
24494 The file path, relative to the \SpecialChar LyX
24498 \begin_layout Description
24499 \begin_inset Flex Code
24502 \begin_layout Plain Layout
24508 This macro will expand to the absolute path of the system directory.
24509 This is typically used to point to the various helper scripts that are
24510 bundled with \SpecialChar LyX
24514 \begin_layout Description
24515 \begin_inset Flex Code
24518 \begin_layout Plain Layout
24524 A name and full path to a temporary file which will be automatically deleted
24525 whenever the containing document is closed, or the external material insertion
24529 \begin_layout Standard
24530 All path macros contain a trailing directory separator, so you can construct
24532 \begin_inset space \thinspace{}
24536 \begin_inset space \space{}
24539 the absolute filename with
24540 \begin_inset Flex Code
24543 \begin_layout Plain Layout
24544 $$AbsPath$$Basename$$Extension
24552 \begin_layout Standard
24553 The macros above are substituted in all commands unless otherwise noted.
24555 \begin_inset Flex Code
24558 \begin_layout Plain Layout
24564 supports additionally the following substitutions if they are enabled by
24566 \begin_inset Flex Code
24569 \begin_layout Plain Layout
24576 \begin_inset Flex Code
24579 \begin_layout Plain Layout
24588 \begin_layout Description
24589 \begin_inset Flex Code
24592 \begin_layout Plain Layout
24598 The front part of the resize command.
24601 \begin_layout Description
24602 \begin_inset Flex Code
24605 \begin_layout Plain Layout
24611 The back part of the resize command.
24614 \begin_layout Description
24615 \begin_inset Flex Code
24618 \begin_layout Plain Layout
24624 The front part of the rotation command.
24627 \begin_layout Description
24628 \begin_inset Flex Code
24631 \begin_layout Plain Layout
24637 The back part of the rotation command.
24640 \begin_layout Standard
24641 The value string of the
24642 \begin_inset Flex Code
24645 \begin_layout Plain Layout
24651 command supports additionally the following substitutions if they are enabled
24653 \begin_inset Flex Code
24656 \begin_layout Plain Layout
24663 \begin_inset Flex Code
24666 \begin_layout Plain Layout
24675 \begin_layout Description
24676 \begin_inset Flex Code
24679 \begin_layout Plain Layout
24688 \begin_layout Description
24689 \begin_inset Flex Code
24692 \begin_layout Plain Layout
24701 \begin_layout Description
24702 \begin_inset Flex Code
24705 \begin_layout Plain Layout
24714 \begin_layout Description
24715 \begin_inset Flex Code
24718 \begin_layout Plain Layout
24724 The rotation option.
24727 \begin_layout Standard
24728 You may ask why there are so many path macros.
24729 There are mainly two reasons:
24732 \begin_layout Enumerate
24733 Relative and absolute file names should remain relative or absolute, respectivel
24735 Users may have reasons to prefer either form.
24736 Relative names are useful for portable documents that should work on different
24737 machines, for example.
24738 Absolute names may be required by some programs.
24741 \begin_layout Enumerate
24743 treats relative file names differently than \SpecialChar LyX
24744 and other programs in nested
24746 For \SpecialChar LyX
24747 , a relative file name is always relative to the document that contains
24749 For \SpecialChar LaTeX
24750 , it is always relative to the master document.
24751 These two definitions are identical if you have only one document, but
24752 differ if you have a master document that includes part documents.
24753 That means that relative filenames must be transformed when presented to
24756 Fortunately \SpecialChar LyX
24757 does this automatically for you if you choose the right macros.
24760 \begin_layout Standard
24761 So which path macro should be used in new template definitions? The rule
24765 \begin_layout Itemize
24767 \begin_inset Flex Code
24770 \begin_layout Plain Layout
24776 if an absolute path is required.
24779 \begin_layout Itemize
24781 \begin_inset Flex Code
24784 \begin_layout Plain Layout
24785 $$AbsOrRelPathMaster
24790 if the substituted string is some kind of \SpecialChar LaTeX
24794 \begin_layout Itemize
24796 \begin_inset Flex Code
24799 \begin_layout Plain Layout
24800 $$AbsOrRelPathParent
24805 in order to preserve the user's choice.
24808 \begin_layout Standard
24809 There are special cases where this rule does not work and e.
24810 \begin_inset space \thinspace{}
24814 \begin_inset space \space{}
24817 relative names are needed, but normally it will work just fine.
24818 One example for such a case is the command
24819 \begin_inset Flex Code
24822 \begin_layout Plain Layout
24823 ReferencedFile latex "$$AbsOrRelPathMaster$$Basename.pstex_t"
24828 in the XFig template above: We can't use the absolute name because the
24830 \begin_inset Flex Code
24833 \begin_layout Plain Layout
24839 files needs the relative name in order to rewrite the file content.
24842 \begin_layout Section
24843 Security discussion
24844 \begin_inset CommandInset label
24846 name "sec:Security-discussion"
24853 \begin_layout Standard
24854 The external material feature interfaces with a lot of external programs
24855 and does so automatically, so we have to consider the security implications
24857 In particular, since you have the option of including your own filenames
24858 and/or parameter strings and those are expanded into a command, it seems
24859 that it would be possible to create a malicious document which executes
24860 arbitrary commands when a user views or prints the document.
24861 This is something we definitely want to avoid.
24864 \begin_layout Standard
24865 However, since the external program commands are specified in the template
24866 configuration file only, there are no security issues if \SpecialChar LyX
24867 is properly configure
24868 d with safe templates only.
24869 This is so because the external programs are invoked with the
24870 \begin_inset Flex Code
24873 \begin_layout Plain Layout
24879 -system call rather than the
24880 \begin_inset Flex Code
24883 \begin_layout Plain Layout
24889 system-call, so it's not possible to execute arbitrary commands from the
24890 filename or parameter section via the shell.
24893 \begin_layout Standard
24894 This also implies that you are restricted in what command strings you can
24895 use in the external material templates.
24896 In particular, pipes and redirection are not readily available.
24897 This has to be so if \SpecialChar LyX
24898 should remain safe.
24899 If you want to use some of the shell features, you should write a safe
24900 script to do this in a controlled manner, and then invoke the script from
24901 the command string.
24905 \begin_layout Standard
24906 It is possible to design a template that interacts directly with the shell,
24907 but since this would allow a malicious user to execute arbitrary commands
24908 by writing clever filenames and/or parameters, we generally recommend that
24909 you only use safe scripts that work with the
24910 \begin_inset Flex Code
24913 \begin_layout Plain Layout
24919 system call in a controlled manner.
24920 Of course, for use in a controlled environment, it can be tempting to just
24921 fall back to use ordinary shell scripts.
24922 If you do so, be aware that you
24926 provide an easily exploitable security hole in your system.
24927 Of course it stands to reason that such unsafe templates will never be
24928 included in the standard \SpecialChar LyX
24929 distribution, although we do encourage people
24930 to submit new templates in the open source tradition.
24931 But \SpecialChar LyX
24932 as shipped from the official distribution channels will never have
24936 \begin_layout Standard
24937 Including external material provides a lot of power, and you have to be
24938 careful not to introduce security hazards with this power.
24939 A subtle error in a single line in an innocent looking script can open
24940 the door to huge security problems.
24941 So if you do not fully understand the issues, we recommend that you consult
24942 a knowledgeable security professional or the \SpecialChar LyX
24943 development team if you have
24944 any questions about whether a given template is safe or not.
24945 And do this before you use it in an uncontrolled environment.
24948 \begin_layout Chapter
24950 List of supported \SpecialChar LyX
24951 functions to be used in layouts
24952 \begin_inset CommandInset label
24954 name "chap:List-of-functions"
24961 \begin_layout Standard
24963 \begin_inset Tabular
24964 <lyxtabular version="3" rows="11" columns="8">
24965 <features tabularvalignment="middle">
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">
24972 <column alignment="left" valignment="top">
24973 <column alignment="left" valignment="top">
24975 <cell alignment="left" valignment="top" usebox="none">
24978 \begin_layout Plain Layout
24984 <cell alignment="left" valignment="top" usebox="none">
24987 \begin_layout Plain Layout
24993 <cell alignment="left" valignment="top" usebox="none">
24996 \begin_layout Plain Layout
25002 <cell alignment="left" valignment="top" usebox="none">
25005 \begin_layout Plain Layout
25011 <cell alignment="center" valignment="top" usebox="none">
25014 \begin_layout Plain Layout
25020 <cell alignment="center" valignment="top" usebox="none">
25023 \begin_layout Plain Layout
25029 <cell alignment="center" valignment="top" usebox="none">
25032 \begin_layout Plain Layout
25038 <cell alignment="center" valignment="top" usebox="none">
25041 \begin_layout Plain Layout
25049 <cell alignment="left" valignment="top" usebox="none">
25052 \begin_layout Plain Layout
25058 <cell alignment="left" valignment="top" usebox="none">
25061 \begin_layout Plain Layout
25067 <cell alignment="left" valignment="top" usebox="none">
25070 \begin_layout Plain Layout
25076 <cell alignment="left" valignment="top" usebox="none">
25079 \begin_layout Plain Layout
25085 <cell alignment="center" valignment="top" usebox="none">
25088 \begin_layout Plain Layout
25094 <cell alignment="center" valignment="top" usebox="none">
25097 \begin_layout Plain Layout
25103 <cell alignment="center" valignment="top" usebox="none">
25106 \begin_layout Plain Layout
25112 <cell alignment="center" valignment="top" usebox="none">
25115 \begin_layout Plain Layout
25123 <cell alignment="left" valignment="top" usebox="none">
25126 \begin_layout Plain Layout
25132 <cell alignment="left" valignment="top" usebox="none">
25135 \begin_layout Plain Layout
25141 <cell alignment="left" valignment="top" usebox="none">
25144 \begin_layout Plain Layout
25150 <cell alignment="left" valignment="top" usebox="none">
25153 \begin_layout Plain Layout
25159 <cell alignment="center" valignment="top" usebox="none">
25162 \begin_layout Plain Layout
25168 <cell alignment="center" valignment="top" usebox="none">
25171 \begin_layout Plain Layout
25177 <cell alignment="center" valignment="top" usebox="none">
25180 \begin_layout Plain Layout
25186 <cell alignment="center" valignment="top" usebox="none">
25189 \begin_layout Plain Layout
25197 <cell alignment="left" valignment="top" usebox="none">
25200 \begin_layout Plain Layout
25206 <cell alignment="left" valignment="top" usebox="none">
25209 \begin_layout Plain Layout
25215 <cell alignment="left" valignment="top" usebox="none">
25218 \begin_layout Plain Layout
25224 <cell alignment="left" valignment="top" usebox="none">
25227 \begin_layout Plain Layout
25233 <cell alignment="center" valignment="top" usebox="none">
25236 \begin_layout Plain Layout
25242 <cell alignment="center" valignment="top" usebox="none">
25245 \begin_layout Plain Layout
25251 <cell alignment="center" valignment="top" usebox="none">
25254 \begin_layout Plain Layout
25260 <cell alignment="center" valignment="top" usebox="none">
25263 \begin_layout Plain Layout
25271 <cell alignment="left" valignment="top" usebox="none">
25274 \begin_layout Plain Layout
25280 <cell alignment="left" valignment="top" usebox="none">
25283 \begin_layout Plain Layout
25289 <cell alignment="left" valignment="top" usebox="none">
25292 \begin_layout Plain Layout
25298 <cell alignment="left" valignment="top" usebox="none">
25301 \begin_layout Plain Layout
25307 <cell alignment="center" valignment="top" usebox="none">
25310 \begin_layout Plain Layout
25316 <cell alignment="center" valignment="top" usebox="none">
25319 \begin_layout Plain Layout
25325 <cell alignment="center" valignment="top" usebox="none">
25328 \begin_layout Plain Layout
25334 <cell alignment="center" valignment="top" usebox="none">
25337 \begin_layout Plain Layout
25345 <cell alignment="left" valignment="top" usebox="none">
25348 \begin_layout Plain Layout
25354 <cell alignment="left" valignment="top" usebox="none">
25357 \begin_layout Plain Layout
25363 <cell alignment="left" valignment="top" usebox="none">
25366 \begin_layout Plain Layout
25372 <cell alignment="left" valignment="top" usebox="none">
25375 \begin_layout Plain Layout
25381 <cell alignment="center" valignment="top" usebox="none">
25384 \begin_layout Plain Layout
25390 <cell alignment="center" valignment="top" usebox="none">
25393 \begin_layout Plain Layout
25399 <cell alignment="center" valignment="top" usebox="none">
25402 \begin_layout Plain Layout
25408 <cell alignment="center" valignment="top" usebox="none">
25411 \begin_layout Plain Layout
25419 <cell alignment="left" valignment="top" usebox="none">
25422 \begin_layout Plain Layout
25428 <cell alignment="left" valignment="top" usebox="none">
25431 \begin_layout Plain Layout
25437 <cell alignment="left" valignment="top" usebox="none">
25440 \begin_layout Plain Layout
25446 <cell alignment="left" valignment="top" usebox="none">
25449 \begin_layout Plain Layout
25455 <cell alignment="center" valignment="top" usebox="none">
25458 \begin_layout Plain Layout
25464 <cell alignment="center" valignment="top" usebox="none">
25467 \begin_layout Plain Layout
25473 <cell alignment="center" valignment="top" usebox="none">
25476 \begin_layout Plain Layout
25482 <cell alignment="center" valignment="top" usebox="none">
25485 \begin_layout Plain Layout
25493 <cell alignment="left" valignment="top" usebox="none">
25496 \begin_layout Plain Layout
25502 <cell alignment="left" valignment="top" usebox="none">
25505 \begin_layout Plain Layout
25511 <cell alignment="left" valignment="top" usebox="none">
25514 \begin_layout Plain Layout
25520 <cell alignment="left" valignment="top" usebox="none">
25523 \begin_layout Plain Layout
25529 <cell alignment="center" valignment="top" usebox="none">
25532 \begin_layout Plain Layout
25538 <cell alignment="center" valignment="top" usebox="none">
25541 \begin_layout Plain Layout
25547 <cell alignment="center" valignment="top" usebox="none">
25550 \begin_layout Plain Layout
25556 <cell alignment="center" valignment="top" usebox="none">
25559 \begin_layout Plain Layout
25567 <cell alignment="left" valignment="top" usebox="none">
25570 \begin_layout Plain Layout
25576 <cell alignment="left" valignment="top" usebox="none">
25579 \begin_layout Plain Layout
25585 <cell alignment="left" valignment="top" usebox="none">
25588 \begin_layout Plain Layout
25594 <cell alignment="left" valignment="top" usebox="none">
25597 \begin_layout Plain Layout
25603 <cell alignment="center" valignment="top" usebox="none">
25606 \begin_layout Plain Layout
25612 <cell alignment="center" valignment="top" usebox="none">
25615 \begin_layout Plain Layout
25621 <cell alignment="center" valignment="top" usebox="none">
25624 \begin_layout Plain Layout
25630 <cell alignment="center" valignment="top" usebox="none">
25633 \begin_layout Plain Layout
25641 <cell alignment="left" valignment="top" usebox="none">
25644 \begin_layout Plain Layout
25650 <cell alignment="left" valignment="top" usebox="none">
25653 \begin_layout Plain Layout
25659 <cell alignment="left" valignment="top" usebox="none">
25662 \begin_layout Plain Layout
25668 <cell alignment="left" valignment="top" usebox="none">
25671 \begin_layout Plain Layout
25677 <cell alignment="center" valignment="top" usebox="none">
25680 \begin_layout Plain Layout
25686 <cell alignment="center" valignment="top" usebox="none">
25689 \begin_layout Plain Layout
25695 <cell alignment="center" valignment="top" usebox="none">
25698 \begin_layout Plain Layout
25704 <cell alignment="center" valignment="top" usebox="none">
25707 \begin_layout Plain Layout
25715 <cell alignment="center" valignment="top" usebox="none">
25718 \begin_layout Plain Layout
25724 <cell alignment="center" valignment="top" usebox="none">
25727 \begin_layout Plain Layout
25733 <cell alignment="center" valignment="top" usebox="none">
25736 \begin_layout Plain Layout
25742 <cell alignment="center" valignment="top" usebox="none">
25745 \begin_layout Plain Layout
25751 <cell alignment="center" valignment="top" usebox="none">
25754 \begin_layout Plain Layout
25760 <cell alignment="center" valignment="top" usebox="none">
25763 \begin_layout Plain Layout
25769 <cell alignment="center" valignment="top" usebox="none">
25772 \begin_layout Plain Layout
25778 <cell alignment="center" valignment="top" usebox="none">
25781 \begin_layout Plain Layout
25795 \begin_layout Chapter
25796 Names of available colors to be used in layouts
25797 \begin_inset CommandInset label
25799 name "chap:Names-of-colors"
25806 \begin_layout Standard
25807 The colors listed here are the standard colors and the those that you can
25808 adjust in the \SpecialChar LyX
25812 \begin_layout Description
25825 No particular color – clear or default
25828 \begin_layout Description
25832 \begin_layout Description
25836 \begin_layout Description
25840 \begin_layout Description
25844 \begin_layout Description
25848 \begin_layout Description
25852 \begin_layout Description
25856 \begin_layout Description
25860 \begin_layout Description
25861 added_space Added space marker color
25864 \begin_layout Description
25865 addedtext Added text color
25868 \begin_layout Description
25869 appendix Appendix marker color
25872 \begin_layout Description
25873 background Background color
25876 \begin_layout Description
25877 bottomarea Bottom area color
25880 \begin_layout Description
25881 branchlabel Label color for branches
25884 \begin_layout Description
25885 buttonbg Color used for bottom background
25888 \begin_layout Description
25889 buttonhoverbg Color used for button background under focus
25892 \begin_layout Description
25893 buttonframe Color for inset button frames
25896 \begin_layout Description
25897 changebar Changebar color
25900 \begin_layout Description
25901 changedtextauthor1 Changed text color author 1
25904 \begin_layout Description
25905 changedtextauthor2 Changed text color author 2
25908 \begin_layout Description
25909 changedtextauthor3 Changed text color author 3
25912 \begin_layout Description
25913 changedtextauthor4 Changed text color author 4
25916 \begin_layout Description
25917 changedtextauthor5 Changed text color author 5
25920 \begin_layout Description
25921 collapsable_inset_frame Collapsable insets framecolor
25924 \begin_layout Description
25925 collapsable_inset_text Collapsable insets text color
25928 \begin_layout Description
25929 command Text color for command insets
25932 \begin_layout Description
25933 commandbg Background color for command insets
25936 \begin_layout Description
25937 commandframe Frame color for command insets
25940 \begin_layout Description
25941 comment color for comments
25944 \begin_layout Description
25945 commentbg Background color of comments
25948 \begin_layout Description
25949 cursor Cursor color
25952 \begin_layout Description
25953 deletedtext Deleted text color
25956 \begin_layout Description
25957 deletedtextmodifier Deleted text modifying color
25960 \begin_layout Description
25961 depthbar Color for the depth bars in the margin
25964 \begin_layout Description
25965 eolmarker End of line marker color
25968 \begin_layout Description
25969 error Color of the \SpecialChar LaTeX
25973 \begin_layout Description
25974 footlabel Label color for footnotes
25977 \begin_layout Description
25978 graphicsbg Graphics inset background color
25981 \begin_layout Description
25982 greyedout Label color for greyedout insets
25985 \begin_layout Description
25986 greyedoutbg Background color of greyedout inset
25989 \begin_layout Description
25990 greyedouttext Color for greyedout inset text
25993 \begin_layout Description
25994 indexlabel Label color for index insets
25997 \begin_layout Description
25998 ignore The color is ignored
26001 \begin_layout Description
26002 inherit The color is inherited
26005 \begin_layout Description
26006 inlinecompletion Inline completion color
26009 \begin_layout Description
26010 insetbg Inset marker background color
26013 \begin_layout Description
26014 insetframe Inset marker frame color
26017 \begin_layout Description
26018 language Color for marking foreign language words
26021 \begin_layout Description
26022 latex Text color in \SpecialChar LaTeX
26026 \begin_layout Description
26027 listingsbg Background color of listings inset
26030 \begin_layout Description
26031 marginlabel Label color for margin notes
26034 \begin_layout Description
26035 math Math inset text color
26038 \begin_layout Description
26039 mathbg Math inset background color
26042 \begin_layout Description
26043 mathcorners Math inset frame color not under focus
26046 \begin_layout Description
26047 mathframe Math inset frame color under focus
26050 \begin_layout Description
26051 mathline Math line color
26054 \begin_layout Description
26055 mathmacrobg Macro math inset background color
26058 \begin_layout Description
26059 mathmacroblend Macro math blended color
26062 \begin_layout Description
26063 mathmacroframe Macro math frame color
26066 \begin_layout Description
26067 mathmacrohoverbg Macro math inset background color hovered
26070 \begin_layout Description
26071 mathmacrolabel Macro math label color
26074 \begin_layout Description
26075 mathmacronewarg Macro template color for new parameters
26078 \begin_layout Description
26079 mathmacrooldarg Macro template color for old parameters
26082 \begin_layout Description
26083 newpage New page color
26086 \begin_layout Description
26087 nonunique_inlinecompletion Inline completion color for the non-unique part
26090 \begin_layout Description
26091 notebg Background color of notes
26094 \begin_layout Description
26095 notelabel Label color for notes
26098 \begin_layout Description
26099 pagebreak Page break/line break color
26102 \begin_layout Description
26103 paragraphmarker Color used for the pilcrow sign to mark the end of a paragraph
26106 \begin_layout Description
26107 phantomtext Text color for phantom insets
26110 \begin_layout Description
26111 preview The color used for previews
26114 \begin_layout Description
26115 previewframe Preview frame color
26118 \begin_layout Description
26119 regexpframe Color for regexp frame
26122 \begin_layout Description
26123 selection Background color of selected text
26126 \begin_layout Description
26127 selectiontext Foreground color of selected text
26130 \begin_layout Description
26131 shadedbg Background color of shaded box
26134 \begin_layout Description
26135 special Special chars text color
26138 \begin_layout Description
26139 tabularline Table line color
26142 \begin_layout Description
26143 tabularonoffline Table line color
26146 \begin_layout Description
26147 urllabel Label color for URL insets
26150 \begin_layout Description
26151 urltext Color for URL inset text