1 #LyX 2.0.0svn created this file. For more info see http://www.lyx.org/
7 % DO NOT ALTER THIS PREAMBLE!!!
9 % This preamble is designed to ensure that this document prints
10 % out as advertised. If you mess with this preamble,
11 % parts of this document may not print out as expected. If you
12 % have problems LaTeXing this file, please contact
13 % the documentation team
14 % email: lyx-docs@lists.lyx.org
16 \usepackage{ifpdf} % part of the hyperref bundle
17 \ifpdf % if pdflatex is used
19 % set fonts for nicer pdf view
20 \IfFileExists{lmodern.sty}
21 {\usepackage{lmodern}}{}
23 \fi % end if pdflatex is used
25 % the pages of the TOC is numbered roman
26 % and a pdf-bookmark for the TOC is added
27 \let\myTOC\tableofcontents
28 \renewcommand\tableofcontents{%
30 \pdfbookmark[1]{\contentsname}{}
34 % redefine the \LyX macro for PDF bookmarks
35 \def\LyX{\texorpdfstring{%
36 L\kern-.1667em\lower.25em\hbox{Y}\kern-.125emX\@}
39 % used for multi-column text
43 \options fleqn,liststotoc,bibtotoc,idxtotoc,BCOR7.5mm,titlepage,tablecaptionabove
44 \use_default_options false
48 \maintain_unincluded_children false
51 InsetLayout CharStyle:MenuItem
60 \newcommand*{\menuitem}[1]{{\sffamily #1}}
69 \font_typewriter default
70 \font_default_family default
78 \default_output_format default
79 \bibtex_command default
80 \index_command default
84 \pdf_title "LyX Configuration Manual"
85 \pdf_author "LyX Team"
86 \pdf_subject "LyX-documentation Customization"
87 \pdf_keywords "LyX, documentation, customization"
89 \pdf_bookmarksnumbered true
90 \pdf_bookmarksopen true
91 \pdf_bookmarksopenlevel 1
96 \pdf_pdfusetitle false
97 \pdf_quoted_options "linkcolor=black, citecolor=black, urlcolor=blue, filecolor=blue,pdfpagelayout=OneColumn, pdfnewwindow=true,pdfstartview=XYZ, plainpages=false, pdfpagelabels"
106 \paperorientation portrait
119 \paragraph_separation indent
120 \paragraph_indentation default
121 \quotes_language english
124 \paperpagestyle headings
125 \tracking_changes false
126 \output_changes false
127 \html_use_mathml true
134 Customizing LyX: Features for the Advanced User
142 \begin_layout Plain Layout
144 If you have comments or error corrections, please send them to the LyX Documenta
146 \begin_inset CommandInset href
148 target "lyx-docs@lists.lyx.org"
155 \begin_inset Quotes eld
159 \begin_inset Quotes erd
162 in the subject header, and please cc the current maintainer of this file,
163 Richard Heck <rgheck@comcast.net>.
169 \begin_inset Newline newline
173 \begin_inset Newline newline
179 \begin_layout Standard
180 \begin_inset CommandInset toc
181 LatexCommand tableofcontents
188 \begin_layout Standard
189 \begin_inset Note Note
192 \begin_layout Plain Layout
193 Please use change tracking when modifying this document.
194 This makes it easier for our translators to recognize things that have
195 been changed, and it helps the maintainer keep up-to-date with what's been
204 \begin_layout Chapter
208 \begin_layout Standard
209 This manual covers the customization features present in LyX.
210 In it, we discuss issues like keyboard shortcuts, screen previewing options,
211 printer options, sending commands to LyX via the LyX Server, internationalizati
212 on, installing new LaTeX classes and LyX layouts, etc.
213 We can't possibly hope to touch on everything you can change—our developers
214 add new features faster than we can document them—but we will explain the
215 most common customizations and hopefully point you in the right direction
216 for some of the more obscure ones.
219 \begin_layout Standard
220 \begin_inset Branch OutDated
223 \begin_layout Standard
224 Information from previous versions of this document that now seems to be
225 outdated is contained in the OutDated branch of this document.
226 By default, this information will not appear in the LaTeX output.
234 \begin_layout Chapter
235 LyX configuration files
238 \begin_layout Standard
239 This chapter aims to help you to find your way through the LyX configuration
241 Before continuing to read this chapter, you should find out where your
242 LyX library and user directories are by using
243 \begin_inset Flex CharStyle:MenuItem
246 \begin_layout Plain Layout
247 Help\SpecialChar \menuseparator
258 The library directory is the place where LyX places its system-wide configurati
259 on files; the user directory is where you can place your modified versions.
260 We will call the former
261 \begin_inset Flex CharStyle:Code
264 \begin_layout Plain Layout
271 \begin_inset Flex CharStyle:MenuItem
274 \begin_layout Plain Layout
280 in the remainder of this document.
284 \begin_layout Section
286 \begin_inset Flex CharStyle:Code
289 \begin_layout Plain Layout
298 \begin_layout Standard
299 \begin_inset Flex CharStyle:Code
302 \begin_layout Plain Layout
308 and its sub-directories contain a number of files and that can be used
309 to customize LyX's behavior.
310 You can change many of these files from within LyX itself through the
311 \begin_inset Flex CharStyle:MenuItem
314 \begin_layout Plain Layout
315 Tools\SpecialChar \menuseparator
322 Most customization that you will want to do in LyX is possible through
324 However, many other inner aspects of LyX can be customized by modifying
326 \begin_inset Flex CharStyle:Code
329 \begin_layout Plain Layout
336 These files fall in different categories, described in the following subsection
340 \begin_layout Subsection
341 Automatically generated files
344 \begin_layout Standard
345 The files, which are to be found in
346 \begin_inset Flex CharStyle:MenuItem
349 \begin_layout Plain Layout
355 , are generated when you configure LyX.
356 They contain various default values that are guessed by inspection.
357 In general, it is not a good idea to modify them, since they might be overwritt
361 \begin_layout Labeling
362 \labelwidthstring 00.00.0000
363 \begin_inset Flex CharStyle:Code
366 \begin_layout Plain Layout
372 contains defaults for various commands.
375 \begin_layout Labeling
376 \labelwidthstring 00.00.0000
377 \begin_inset Flex CharStyle:Code
380 \begin_layout Plain Layout
386 contains the list of packages that have been recognized by LyX.
387 It is currently unused by the LyX program itself, but the information extracted
388 , and more, is made available with
389 \begin_inset Flex CharStyle:MenuItem
392 \begin_layout Plain Layout
393 Help\SpecialChar \menuseparator
406 \begin_layout Labeling
407 \labelwidthstring 00.00.0000
408 \begin_inset Flex CharStyle:Code
411 \begin_layout Plain Layout
417 the list of text classes that have been found in your
418 \begin_inset Flex CharStyle:Code
421 \begin_layout Plain Layout
427 directories, along with the associated LaTeX document class and their descripti
431 \begin_layout Labeling
432 \labelwidthstring 00.00.0000
433 \begin_inset Flex CharStyle:Code
436 \begin_layout Plain Layout
442 the list of layout modules found in your
443 \begin_inset Flex CharStyle:Code
446 \begin_layout Plain Layout
455 \begin_layout Labeling
456 \labelwidthstring 00.00.0000
457 \begin_inset Flex CharStyle:Code
460 \begin_layout Plain Layout
466 lists of various sorts of LaTeX-related files found on your system
469 \begin_layout Labeling
470 \labelwidthstring 00.00.0000
471 \begin_inset Flex CharStyle:Code
474 \begin_layout Plain Layout
480 is automatically generated during configuration from the file
481 \begin_inset Flex CharStyle:Code
484 \begin_layout Plain Layout
491 It contains information on your LaTeX configuration.
494 \begin_layout Subsection
498 \begin_layout Standard
499 These directories are duplicated between
500 \begin_inset Flex CharStyle:Code
503 \begin_layout Plain Layout
510 \begin_inset Flex CharStyle:Code
513 \begin_layout Plain Layout
520 If a particular files exists in both places, the one in
521 \begin_inset Flex CharStyle:Code
524 \begin_layout Plain Layout
533 \begin_layout Labeling
534 \labelwidthstring 00.00.0000
535 \begin_inset Flex CharStyle:Code
538 \begin_layout Plain Layout
544 this directory contains files with the extension
545 \begin_inset Flex CharStyle:Code
548 \begin_layout Plain Layout
554 that define the keybindings used in LyX.
555 If there exists an internationalized version of the bind file named
556 \begin_inset Flex CharStyle:Code
559 \begin_layout Plain Layout
565 , that will be used first.
568 \begin_layout Labeling
569 \labelwidthstring 00.00.0000
570 \begin_inset Flex CharStyle:Code
573 \begin_layout Plain Layout
579 contains graphics files that can be included in documents.
583 \begin_layout Labeling
584 \labelwidthstring 00.00.0000
585 \begin_inset Flex CharStyle:Code
588 \begin_layout Plain Layout
594 contains LyX documentation files (including the one you are currently reading).
596 \begin_inset Flex CharStyle:Code
599 \begin_layout Plain Layout
605 deserves special attention, as noted above.
606 The internationalized help docs are in subdirectories
607 \begin_inset Flex CharStyle:Code
610 \begin_layout Plain Layout
617 \begin_inset Quotes eld
621 \begin_inset Quotes erd
624 is the ISO language code.
630 \begin_inset CommandInset ref
632 reference "cha:Internationalizing-LyX"
639 \begin_layout Labeling
640 \labelwidthstring 00.00.0000
641 \begin_inset Flex CharStyle:Code
644 \begin_layout Plain Layout
650 contains example files that explain how to use some features.
651 In the file browser, press the
652 \begin_inset Flex CharStyle:MenuItem
655 \begin_layout Plain Layout
664 \begin_layout Labeling
665 \labelwidthstring 00.00.0000
666 \begin_inset Flex CharStyle:Code
669 \begin_layout Plain Layout
675 contains image files that are used by the
676 \begin_inset Flex CharStyle:MenuItem
679 \begin_layout Plain Layout
686 In addition, it also contains the individual icons used in the toolbar
687 and the banners that can be shown when LyX is launched.
690 \begin_layout Labeling
691 \labelwidthstring 00.00.0000
692 \begin_inset Flex CharStyle:Code
695 \begin_layout Plain Layout
701 contains keyboard keymapping files.
707 \begin_inset CommandInset ref
709 reference "sec:International-Keymap-Stuff"
716 \begin_layout Labeling
717 \labelwidthstring 00.00.0000
718 \begin_inset Flex CharStyle:Code
721 \begin_layout Plain Layout
727 contains the text class and module files described in Chapter
732 \begin_inset CommandInset ref
734 reference "cha:Installing-New-Document"
741 \begin_layout Labeling
742 \labelwidthstring 00.00.0000
743 \begin_inset Flex CharStyle:Code
746 \begin_layout Plain Layout
753 \begin_inset Flex CharStyle:Code
756 \begin_layout Plain Layout
762 Python scripts used to convert between LyX versions.
763 These can be run from the command line if, say, you want to batch-convert
767 \begin_layout Labeling
768 \labelwidthstring 00.00.0000
769 \begin_inset Flex CharStyle:Code
772 \begin_layout Plain Layout
778 contains some files that demonstrate the capabilities of the
779 \begin_inset Flex CharStyle:MenuItem
782 \begin_layout Plain Layout
793 Also contains some scripts used by LyX itself.
796 \begin_layout Labeling
797 \labelwidthstring 00.00.0000
798 \begin_inset Flex CharStyle:Code
801 \begin_layout Plain Layout
807 contains the standard LyX template files described in Chapter
812 \begin_inset CommandInset ref
814 reference "sub:Creating-Templates"
821 \begin_layout Labeling
822 \labelwidthstring 00.00.0000
823 \begin_inset Flex CharStyle:Code
826 \begin_layout Plain Layout
832 contains files with the extension
833 \begin_inset Flex CharStyle:Code
836 \begin_layout Plain Layout
842 that define the user interface to LyX.
843 That is, the files define which items appear in which menus and the items
844 appearing on the toolbar.
847 \begin_layout Subsection
848 Files you don't want to modify
851 \begin_layout Standard
852 These files are used internally by LyX and you generally do not need to
853 modify them unless you are a developer.
856 \begin_layout Labeling
857 \labelwidthstring 00.00.0000
858 \begin_inset Flex CharStyle:Code
861 \begin_layout Plain Layout
867 this file contains the list of LyX developers.
868 The contents are displayed with the menu entry
869 \begin_inset Flex CharStyle:MenuItem
872 \begin_layout Plain Layout
873 Help\SpecialChar \menuseparator
886 \begin_layout Labeling
887 \labelwidthstring 00.00.0000
888 \begin_inset Flex CharStyle:Code
891 \begin_layout Plain Layout
897 this is a LaTeX script used during the configuration process.
901 \begin_layout Labeling
902 \labelwidthstring 00.00.0000
903 \begin_inset Flex CharStyle:Code
906 \begin_layout Plain Layout
912 this is the script that is used to re-configure LyX.
913 It creates configuration files in the directory it was run from.
916 \begin_layout Subsection
917 Other files needing a line or two...
920 \begin_layout Labeling
921 \labelwidthstring 00.00.0000
922 \begin_inset Flex CharStyle:Code
925 \begin_layout Plain Layout
931 this contains tables describing how different character encodings can be
935 \begin_layout Labeling
936 \labelwidthstring 00.00.0000
937 \begin_inset Flex CharStyle:Code
940 \begin_layout Plain Layout
946 this file contains the templates available to the new
947 \begin_inset Flex CharStyle:MenuItem
950 \begin_layout Plain Layout
963 \begin_layout Labeling
964 \labelwidthstring 00.00.0000
965 \begin_inset Flex CharStyle:Code
968 \begin_layout Plain Layout
974 this file contains a list of all the languages currently supported by LyX.
977 \begin_layout Section
978 Your local configuration directory
981 \begin_layout Standard
982 Even if you are using LyX as an unprivileged user, you might want to change
983 LyX configuration for your own use.
985 \begin_inset Flex CharStyle:Code
988 \begin_layout Plain Layout
994 directory contains all your personal configuration files.
995 This is the directory described as
996 \begin_inset Quotes eld
1000 \begin_inset Quotes erd
1004 \begin_inset Flex CharStyle:MenuItem
1007 \begin_layout Plain Layout
1008 Help\SpecialChar \menuseparator
1010 \begin_inset space ~
1019 This directory is used as a mirror of
1020 \begin_inset Flex CharStyle:Code
1023 \begin_layout Plain Layout
1029 , which means that every file in
1030 \begin_inset Flex CharStyle:Code
1033 \begin_layout Plain Layout
1039 is a replacement for the corresponding file in
1040 \begin_inset Flex CharStyle:Code
1043 \begin_layout Plain Layout
1050 Any configuration file described in the above sections can be placed either
1051 in the system-wide directory, in which case it will affect all users, or
1052 in your local directory for your own use.
1055 \begin_layout Standard
1056 To make things clearer, let's provide a few examples:
1059 \begin_layout Itemize
1060 The preferences set in the
1061 \begin_inset Flex CharStyle:MenuItem
1064 \begin_layout Plain Layout
1065 Tools\SpecialChar \menuseparator
1071 dialog are saved to a file
1072 \begin_inset Flex CharStyle:Code
1075 \begin_layout Plain Layout
1082 \begin_inset Flex CharStyle:Code
1085 \begin_layout Plain Layout
1094 \begin_layout Itemize
1095 When you reconfigure using
1096 \begin_inset Flex CharStyle:MenuItem
1099 \begin_layout Plain Layout
1100 Tools\SpecialChar \menuseparator
1107 \begin_inset Flex CharStyle:Code
1110 \begin_layout Plain Layout
1116 script, and the resulting files are written in your local configuration
1118 This means that any additional text class file that you might have added
1120 \begin_inset Flex CharStyle:Code
1123 \begin_layout Plain Layout
1129 will be added to the list of classes in the
1130 \begin_inset Flex CharStyle:MenuItem
1133 \begin_layout Plain Layout
1134 Document\SpecialChar \menuseparator
1143 \begin_layout Itemize
1144 If you get some updated documentation from LyX ftp site and cannot install
1145 it because you do not have sysadmin rights on your system, you can just
1147 \begin_inset Flex CharStyle:Code
1150 \begin_layout Plain Layout
1156 and the items in the
1157 \begin_inset Flex CharStyle:MenuItem
1160 \begin_layout Plain Layout
1166 menu will open them!
1169 \begin_layout Section
1170 Running LyX with multiple configurations
1173 \begin_layout Standard
1174 The configuration freedom of the local configuration directory may not suffice
1175 if you want to have more than one configuration at your disposal.
1176 For example, you may want to be use different key bindings or printer settings
1178 You can achieve this by having several such directories.
1179 You then specify which directory to use at run-time.
1182 \begin_layout Standard
1183 Invoking LyX with the command line switch
1184 \begin_inset Flex CharStyle:Code
1187 \begin_layout Plain Layout
1197 instructs the program to read the configuration from that directory, and
1198 not from the default directory.
1199 (You can determine the default directory by running LyX without the
1200 \begin_inset Flex CharStyle:Code
1203 \begin_layout Plain Layout
1209 switch.) If the specified directory does not exist, LyX offers to create
1210 it for you, just like it does for the default directory on the first time
1211 you run the program.
1212 You can modify the configuration options in this additional user directory
1213 exactly as you would for the default directory.
1214 These directories are completely independent (but read on).
1215 Note that setting the environment variable
1216 \begin_inset Flex CharStyle:Code
1219 \begin_layout Plain Layout
1225 to some value has exactly the same effect.
1228 \begin_layout Standard
1229 Having several configurations also requires more maintenance: if you want
1230 to add a new layout to
1231 \begin_inset Flex CharStyle:Code
1234 \begin_layout Plain Layout
1240 which you want available from all your configurations, you must add it
1241 to each directory separately.
1242 You can avoid this with the following trick: after LyX creates the additional
1243 directory, most of the subdirectories (see above) are empty.
1244 If you want the new configuration to mirror an existing one, replace the
1245 empty subdirectory with a symbolic link to the matching subdirectory in
1246 the existing configuration.
1248 \begin_inset Flex CharStyle:Code
1251 \begin_layout Plain Layout
1257 subdirectory, however, since it contains a file written by the configuration
1258 script (also accessible through
1259 \begin_inset Flex CharStyle:MenuItem
1262 \begin_layout Plain Layout
1263 Tools\SpecialChar \menuseparator
1269 ) which is configuration-specific.
1272 \begin_layout Chapter
1273 The Preferences dialog
1276 \begin_layout Standard
1277 All options of the preferences dialog are described in the Appendix
1279 The Preferences Dialog
1286 For some options you might find here more details.
1289 \begin_layout Section
1291 \begin_inset CommandInset label
1300 \begin_layout Standard
1301 The first step is to define your file formats if they are not already defined.
1303 \begin_inset Flex CharStyle:MenuItem
1306 \begin_layout Plain Layout
1307 Tools\SpecialChar \menuseparator
1315 \begin_inset Flex CharStyle:MenuItem
1318 \begin_layout Plain Layout
1319 File Handling\SpecialChar \menuseparator
1326 \begin_inset Flex CharStyle:MenuItem
1329 \begin_layout Plain Layout
1330 New\SpecialChar \ldots{}
1336 button to define your new format.
1338 \begin_inset Flex CharStyle:MenuItem
1341 \begin_layout Plain Layout
1347 field contains the name used to identify the format in the GUI.
1349 \begin_inset Flex CharStyle:MenuItem
1352 \begin_layout Plain Layout
1358 is used to identify the format internally.
1359 You will also need to enter a file extension.
1360 These are all required.
1362 \begin_inset Flex CharStyle:MenuItem
1365 \begin_layout Plain Layout
1371 field is used to provide a keyboard shortcut on the menus.
1372 (For example, pressing
1373 \begin_inset Flex CharStyle:MenuItem
1376 \begin_layout Plain Layout
1383 \begin_inset Flex CharStyle:MenuItem
1386 \begin_layout Plain Layout
1387 View\SpecialChar \menuseparator
1396 \begin_layout Standard
1398 \begin_inset Flex CharStyle:MenuItem
1401 \begin_layout Plain Layout
1408 \begin_inset Flex CharStyle:MenuItem
1411 \begin_layout Plain Layout
1418 For example, you might want to use
1419 \begin_inset Flex CharStyle:MenuItem
1422 \begin_layout Plain Layout
1428 to view PostScript files.
1429 You can enter the command needed to start the program in the corresponding
1431 In defining this command, you can use the four variables listed in the
1433 The viewer is launched when you view an image in LyX or use the
1434 \begin_inset Flex CharStyle:MenuItem
1437 \begin_layout Plain Layout
1444 The editor is for example launched when you right-click on an image and
1446 \begin_inset Flex CharStyle:MenuItem
1449 \begin_layout Plain Layout
1455 in the appearing context menu.
1458 \begin_layout Standard
1460 \begin_inset Flex CharStyle:MenuItem
1463 \begin_layout Plain Layout
1469 option tells LyX that a format is suitable for document export.
1470 If this is set and if a suitable conversion route exists (see sec.
1471 \begin_inset space \thinspace{}
1475 \begin_inset CommandInset ref
1477 reference "sec:Converters"
1481 ), the format will appear in the
1482 \begin_inset Flex CharStyle:MenuItem
1485 \begin_layout Plain Layout
1486 File\SpecialChar \menuseparator
1493 The format will also appear in the
1494 \begin_inset Flex CharStyle:MenuItem
1497 \begin_layout Plain Layout
1503 menu if a viewer is specified for the format.
1504 Pure image formats, such as
1505 \begin_inset Flex CharStyle:Code
1508 \begin_layout Plain Layout
1514 , should not use this option.
1515 Formats that can both represent vector graphics and documents like
1516 \begin_inset Flex CharStyle:Code
1519 \begin_layout Plain Layout
1528 \begin_layout Standard
1530 \begin_inset Flex CharStyle:MenuItem
1533 \begin_layout Plain Layout
1534 Vector graphics format
1539 tells LyX that a format can contain vector graphics.
1540 This information is used to determine the target format of included graphics
1542 \begin_inset Flex CharStyle:MenuItem
1545 \begin_layout Plain Layout
1552 Included graphics may need to be converted to either
1553 \begin_inset Flex CharStyle:MenuItem
1556 \begin_layout Plain Layout
1563 \begin_inset Flex CharStyle:MenuItem
1566 \begin_layout Plain Layout
1573 \begin_inset Flex CharStyle:MenuItem
1576 \begin_layout Plain Layout
1583 \begin_inset Flex CharStyle:MenuItem
1586 \begin_layout Plain Layout
1592 cannot handle other image formats.
1593 If an included graphic is not already in
1594 \begin_inset Flex CharStyle:MenuItem
1597 \begin_layout Plain Layout
1604 \begin_inset Flex CharStyle:MenuItem
1607 \begin_layout Plain Layout
1614 \begin_inset Flex CharStyle:MenuItem
1617 \begin_layout Plain Layout
1623 format, it is converted to
1624 \begin_inset Flex CharStyle:MenuItem
1627 \begin_layout Plain Layout
1633 if the vector format option is set, and otherwise to
1634 \begin_inset Flex CharStyle:MenuItem
1637 \begin_layout Plain Layout
1646 \begin_layout Section
1650 \begin_layout Standard
1651 Since all conversions from one format to another take place in LyX's temporary
1652 directory, it is sometimes necessary to modify a file before copying it
1653 to the temporary directory in order that the conversion may be performed.
1657 \begin_layout Plain Layout
1658 For example, the file may refer to other files—images, for example—using
1659 relative file names, and these may become invalid when the file is copied
1660 to the temporary directory.
1665 This is done by a Copier: It copies a file to (or from) the temporary directory
1666 and may modify it in the process.
1669 \begin_layout Standard
1670 The definitions of the copiers may use four variables:
1673 \begin_layout Labeling
1674 \labelwidthstring 00.00.0000
1675 \begin_inset Flex CharStyle:Code
1678 \begin_layout Plain Layout
1684 The LyX system directory (e.
1685 \begin_inset space \thinspace{}
1689 \begin_inset space \space{}
1693 \begin_inset Flex CharStyle:MenuItem
1696 \begin_layout Plain Layout
1705 \begin_layout Labeling
1706 \labelwidthstring 00.00.0000
1707 \begin_inset Flex CharStyle:Code
1710 \begin_layout Plain Layout
1719 \begin_layout Labeling
1720 \labelwidthstring 00.00.0000
1721 \begin_inset Flex CharStyle:Code
1724 \begin_layout Plain Layout
1733 \begin_layout Labeling
1734 \labelwidthstring 00.00.0000
1735 \begin_inset Flex CharStyle:Code
1738 \begin_layout Plain Layout
1747 \begin_layout Standard
1748 The latter should be the filename as it would be used in a LaTeX's
1755 It is relevant only when exporting files suitable for such inclusion.
1758 \begin_layout Standard
1759 Copiers can be used to do almost anything with output files.
1760 For example, suppose you want generated pdf files to be copied to a special
1762 \begin_inset Flex CharStyle:Code
1765 \begin_layout Plain Layout
1772 Then you could write a shell script such as this one:
1775 \begin_layout Standard
1776 \begin_inset listings
1780 \begin_layout Plain Layout
1785 \begin_layout Plain Layout
1790 \begin_layout Plain Layout
1792 TOFILE=`basename $2`
1795 \begin_layout Plain Layout
1797 cp $FROMFILE /home/you/pdf/$TOFILE
1802 Save it in your local LyX directory—say,
1803 \begin_inset Flex CharStyle:Code
1806 \begin_layout Plain Layout
1807 /home/you/.lyx/scripts/pdfcopier.sh
1812 —and make it executable, if you need to do so on your platform.
1814 \begin_inset Flex CharStyle:MenuItem
1817 \begin_layout Plain Layout
1818 Tools\SpecialChar \menuseparator
1824 dialog, select under
1825 \begin_inset Flex CharStyle:MenuItem
1828 \begin_layout Plain Layout
1829 File Handling\SpecialChar \menuseparator
1836 \begin_inset Flex CharStyle:MenuItem
1839 \begin_layout Plain Layout
1845 format—or one of the other pdf formats—and enter
1846 \begin_inset Flex CharStyle:Code
1849 \begin_layout Plain Layout
1850 pdfcopier.sh $$i $$o
1856 \begin_inset Flex CharStyle:MenuItem
1859 \begin_layout Plain Layout
1869 \begin_layout Standard
1870 Copiers are used by LyX in various of its own conversions.
1871 For example, if appropriate programs are found, LyX will automatically
1872 install copiers for the
1873 \begin_inset Flex CharStyle:MenuItem
1876 \begin_layout Plain Layout
1883 \begin_inset Flex CharStyle:MenuItem
1886 \begin_layout Plain Layout
1888 \begin_inset space ~
1897 When these formats are exported, the copier sees that not just the main
1898 HTML file but various associated files (style files, images, etc.) are also
1900 All these files are written to a subdirectory of the directory in which
1901 the original LyX file was found.
1905 \begin_layout Plain Layout
1906 This copier can be customized.
1908 \begin_inset Quotes eld
1912 \begin_inset Quotes erd
1915 argument takes a comma-separated list of extensions to be copied; if it
1916 is omitted, all files will be copied.
1918 \begin_inset Quotes eld
1922 \begin_inset Quotes erd
1925 argument determines the extension added to the generated directory.
1927 \begin_inset Quotes eld
1931 \begin_inset Flex CharStyle:MenuItem
1934 \begin_layout Plain Layout
1941 \begin_inset Quotes erd
1944 , so HTML generated from
1945 \begin_inset Flex CharStyle:MenuItem
1948 \begin_layout Plain Layout
1949 /path/to/filename.lyx
1955 \begin_inset Flex CharStyle:MenuItem
1958 \begin_layout Plain Layout
1959 /path/to/filename.html.LyXconv
1973 \begin_layout Section
1975 \begin_inset CommandInset label
1977 name "sec:Converters"
1984 \begin_layout Standard
1985 You can define your own Converters to convert files between different formats.
1987 \begin_inset Flex CharStyle:MenuItem
1990 \begin_layout Plain Layout
1991 Tools\SpecialChar \menuseparator
1992 Preferences\SpecialChar \menuseparator
1993 File Handling\SpecialChar \menuseparator
2002 \begin_layout Standard
2003 To define a new converter, select the
2004 \begin_inset Flex CharStyle:MenuItem
2007 \begin_layout Plain Layout
2009 \begin_inset space ~
2018 \begin_inset Flex CharStyle:MenuItem
2021 \begin_layout Plain Layout
2023 \begin_inset space ~
2031 from the drop-down lists, enter the command needed for the conversion,
2033 \begin_inset Flex CharStyle:MenuItem
2036 \begin_layout Plain Layout
2043 Several variables can be used in the definition of converters:
2046 \begin_layout Labeling
2047 \labelwidthstring 00.00.0000
2048 \begin_inset Flex CharStyle:Code
2051 \begin_layout Plain Layout
2057 The LyX system directory
2060 \begin_layout Labeling
2061 \labelwidthstring 00.00.0000
2062 \begin_inset Flex CharStyle:Code
2065 \begin_layout Plain Layout
2074 \begin_layout Labeling
2075 \labelwidthstring 00.00.0000
2076 \begin_inset Flex CharStyle:Code
2079 \begin_layout Plain Layout
2088 \begin_layout Labeling
2089 \labelwidthstring 00.00.0000
2090 \begin_inset Flex CharStyle:Code
2093 \begin_layout Plain Layout
2099 The base filename of the input file (i.
2100 \begin_inset space \thinspace{}
2103 g., without the extension)
2106 \begin_layout Labeling
2107 \labelwidthstring 00.00.0000
2108 \begin_inset Flex CharStyle:Code
2111 \begin_layout Plain Layout
2117 The path to the input file
2120 \begin_layout Labeling
2121 \labelwidthstring 00.00.0000
2122 \begin_inset Flex CharStyle:Code
2125 \begin_layout Plain Layout
2131 The path to the original input file (this is different from $$p when a
2132 chain of converters is called).
2135 \begin_layout Standard
2137 \begin_inset Flex CharStyle:MenuItem
2140 \begin_layout Plain Layout
2142 \begin_inset space ~
2150 field you can enter the following flags, separated by commas:
2153 \begin_layout Labeling
2154 \labelwidthstring 00.00.0000
2155 \begin_inset Flex CharStyle:Code
2158 \begin_layout Plain Layout
2164 This converter runs some form of LaTeX.
2165 This will make LyX's LaTeX error logs available.
2168 \begin_layout Labeling
2169 \labelwidthstring 00.00.0000
2170 \begin_inset Flex CharStyle:Code
2173 \begin_layout Plain Layout
2180 \begin_inset Flex CharStyle:MenuItem
2183 \begin_layout Plain Layout
2189 file for the conversion.
2192 \begin_layout Labeling
2193 \labelwidthstring 00.00.0000
2194 \begin_inset Flex CharStyle:Code
2197 \begin_layout Plain Layout
2206 \begin_layout Standard
2207 The following three flags are not really flags at all because they take
2209 \begin_inset Flex CharStyle:MenuItem
2212 \begin_layout Plain Layout
2214 \begin_inset space ~
2218 \begin_inset space ~
2229 \begin_layout Labeling
2230 \labelwidthstring 00.00.0000
2231 \begin_inset Flex CharStyle:Code
2234 \begin_layout Plain Layout
2240 If set, the converter's standard error will be redirected to a file
2241 \begin_inset Flex CharStyle:Code
2244 \begin_layout Plain Layout
2250 , and the script given as argument will be run as:
2251 \begin_inset Flex CharStyle:Code
2254 \begin_layout Plain Layout
2255 script < infile.out > infile.log
2261 The argument may contain
2262 \begin_inset Flex CharStyle:Code
2265 \begin_layout Plain Layout
2274 \begin_layout Labeling
2275 \labelwidthstring 00.00.0000
2276 \begin_inset Flex CharStyle:Code
2279 \begin_layout Plain Layout
2285 The name of the directory in which the converter will dump the generated
2287 LyX will not create this directory, and it does not copy anything into
2288 it, though it will copy this directory to the destination.
2289 The argument may contain
2290 \begin_inset Flex CharStyle:Code
2293 \begin_layout Plain Layout
2299 , which will be replaced by the base name of the input and output files,
2300 respectively, when the directory is copied.
2301 \begin_inset Newline newline
2304 Note that resultdir and usetempdir make no sense together.
2305 The latter will be ignored if the former is given.
2308 \begin_layout Labeling
2309 \labelwidthstring 00.00.0000
2310 \begin_inset Flex CharStyle:Code
2313 \begin_layout Plain Layout
2319 Determines the output file name and may, contain
2320 \begin_inset Flex CharStyle:Code
2323 \begin_layout Plain Layout
2330 Sensible only with resultdir and optional even then; if not given, it defaults
2334 \begin_layout Standard
2335 None of these last three are presently used in any of the converters that
2336 are installed with LyX.
2340 \begin_layout Standard
2341 You do not have to define converters for all formats between which you want
2343 For example, you will note that there is no `LyX to PostScript' converter,
2344 but LyX will export PostScript.
2345 It does so by first creating a LaTeX file (no converter needs to be defined
2346 for this) which is then converted to DVI using the `LaTeX to DVI' converter,
2347 and finally converting the resulting DVI file to PostScript.
2348 LyX finds such `chains' of converters automatically, and it will always
2349 choose the shortest possible chain.
2350 You can, though, still define multiple conversion methods between file
2352 For example, the standard LyX configuration provides three ways to convert
2353 LaTeX to PDF: Directly, using
2354 \begin_inset Flex CharStyle:MenuItem
2357 \begin_layout Plain Layout
2363 ; via (DVI and) PostScript, using
2364 \begin_inset Flex CharStyle:MenuItem
2367 \begin_layout Plain Layout
2374 \begin_inset Flex CharStyle:MenuItem
2377 \begin_layout Plain Layout
2384 To define such alternate chains, you must define multiple target `file
2385 formats', as described in section
2386 \begin_inset CommandInset ref
2388 reference "sec:Formats"
2393 For example, in the standard configuration, the formats named
2394 \begin_inset Flex CharStyle:MenuItem
2397 \begin_layout Plain Layout
2404 \begin_inset Flex CharStyle:MenuItem
2407 \begin_layout Plain Layout
2414 \begin_inset Flex CharStyle:MenuItem
2417 \begin_layout Plain Layout
2423 are defined, all of which share the extension
2424 \begin_inset Flex CharStyle:MenuItem
2427 \begin_layout Plain Layout
2433 , and which correspond to the conversion methods just mentioned.
2436 \begin_layout Chapter
2437 Internationalizing LyX
2438 \begin_inset CommandInset label
2440 name "cha:Internationalizing-LyX"
2447 \begin_layout Standard
2448 LyX supports using a translated interface.
2449 Last time we checked, LyX provided text in thirty languages.
2450 The language of choice is called your
2455 (For further reading on locale settings, see also the documentation for
2456 locale that comes with your operating system.
2457 For Linux, the manual page for
2458 \begin_inset Flex CharStyle:Code
2461 \begin_layout Plain Layout
2467 could be a good place to start).
2470 \begin_layout Standard
2471 Notice that these translations will work, but do contain a few flaws.
2472 In particular, all dialogs have been designed with the English text in
2473 mind, which means that some of the translated text will be too large to
2474 fit within the space allocated.
2475 This is only a display problem and will not cause any harm.
2476 Also, you will find that some of the translations do not define shortcut
2477 keys for everything.
2478 Sometimes, there are simply not enough free letters to do it.
2479 Other times, the translator just hasn't got around to doing it yet.
2480 Our localization team, which you may wish to join,
2484 \begin_layout Plain Layout
2485 If you are a fluent speaker of a language other than English, joining these
2486 teams is a great way to give back to the LyX community!
2491 will of course try to fix these shortcomings in future versions of LyX.
2494 \begin_layout Section
2498 \begin_layout Subsection
2499 Translating the graphical user interface (text messages).
2502 \begin_layout Standard
2504 \begin_inset Flex CharStyle:Code
2507 \begin_layout Plain Layout
2513 library to handle the internationalization of the interface.
2514 To have LyX speak your favorite language in all menus and dialogs, you
2516 \begin_inset Flex CharStyle:Code
2519 \begin_layout Plain Layout
2525 -file for that language.
2526 When this is available, you'll have to generate a
2527 \begin_inset Flex CharStyle:Code
2530 \begin_layout Plain Layout
2536 -file from it and install the
2537 \begin_inset Flex CharStyle:Code
2540 \begin_layout Plain Layout
2547 The process of doing all of this is explained in the documentation for
2549 \begin_inset Flex CharStyle:Code
2552 \begin_layout Plain Layout
2559 It is possible to do this just for yourself, but if you're going to do
2560 it, you might as well share the results of your labors with the rest of
2562 Send a message to the LyX developers' list for more information about how
2566 \begin_layout Standard
2567 In short, this is what you should do (xx denotes the language code):
2570 \begin_layout Itemize
2571 Check out the LyX source code.
2573 \begin_inset CommandInset href
2575 name "information on the web"
2576 target "http://www.lyx.org/devel/cvs.php"
2583 \begin_layout Itemize
2585 \begin_inset Flex CharStyle:Code
2588 \begin_layout Plain Layout
2594 to the folder of the
2595 \begin_inset Flex CharStyle:Code
2598 \begin_layout Plain Layout
2606 \begin_inset Flex CharStyle:Code
2609 \begin_layout Plain Layout
2617 \begin_inset Flex CharStyle:Code
2620 \begin_layout Plain Layout
2626 doesn't exist anywhere, it can be remade with the console command
2627 \begin_inset Flex CharStyle:Code
2630 \begin_layout Plain Layout
2636 in that directory, or you can use an existing po-file for some other language
2640 \begin_layout Itemize
2642 \begin_inset Flex CharStyle:Code
2645 \begin_layout Plain Layout
2655 \begin_layout Plain Layout
2656 This is just a text file, so it can be edited in any text editor.
2657 But there are also specialized programs that support such editing, such
2662 (for all platforms) or
2671 contains a `mode' for editing
2672 \begin_inset Flex CharStyle:Code
2675 \begin_layout Plain Layout
2686 For some menu- and widget-labels, there are also shortcut keys that should
2688 Those keys are marked after a `|', and should be translated according to
2689 the words and phrases of the language.
2690 You should also fill also out the information at the beginning of the new
2692 \begin_inset Flex CharStyle:Code
2695 \begin_layout Plain Layout
2701 -file with your email-address, etc., so people know where to reach you with
2702 suggestions and entertaining flames.
2705 \begin_layout Standard
2706 If you are just doing this on your own, then:
2709 \begin_layout Itemize
2711 \begin_inset Flex CharStyle:Code
2714 \begin_layout Plain Layout
2721 This can be done with
2722 \begin_inset Flex CharStyle:Code
2725 \begin_layout Plain Layout
2726 msgfmt -o xx.mo < xx.po
2734 \begin_layout Itemize
2736 \begin_inset Flex CharStyle:Code
2739 \begin_layout Plain Layout
2745 -file to your locale-tree, at the correct directory for application messages
2750 xx, and under the name
2751 \begin_inset Flex CharStyle:Code
2754 \begin_layout Plain Layout
2761 \begin_inset space \thinspace{}
2765 \begin_inset space \space{}
2769 \begin_inset Flex CharStyle:Code
2772 \begin_layout Plain Layout
2773 /usr/local/share/locale/xx/LC_MESSAGES/lyx.mo
2783 \begin_layout Standard
2784 As said, however, it would be best if the new
2785 \begin_inset Flex CharStyle:Code
2788 \begin_layout Plain Layout
2794 -file could be added to the LyX distribution, so others can use it.
2795 Adding it involves making additional changes to LyX.
2796 So send an email to the developers' mailing list if you're interested in
2800 \begin_layout Subsubsection
2804 \begin_layout Standard
2805 Sometimes it turns out that one English message needs to be translated into
2806 different messages in the target language.
2807 One example is the message
2808 \begin_inset Flex CharStyle:Code
2811 \begin_layout Plain Layout
2817 which has the German translation
2825 , depending upon exactly what the English
2826 \begin_inset Quotes eld
2830 \begin_inset Quotes erd
2835 \begin_inset Flex CharStyle:Code
2838 \begin_layout Plain Layout
2844 does not handle such ambiguous translations.
2845 Therefore you have to add some context information to the message: Instead
2847 \begin_inset Flex CharStyle:Code
2850 \begin_layout Plain Layout
2857 \begin_inset Flex CharStyle:Code
2860 \begin_layout Plain Layout
2861 To[[as in 'From format x to format y']]
2867 \begin_inset Flex CharStyle:Code
2870 \begin_layout Plain Layout
2871 To[[as in 'From page x to page y']].
2876 Now the two occurrences of
2877 \begin_inset Flex CharStyle:Code
2880 \begin_layout Plain Layout
2887 \begin_inset Flex CharStyle:Code
2890 \begin_layout Plain Layout
2896 and can be translated correctly to
2907 \begin_layout Standard
2908 Of course the context information needs to be stripped off the original
2909 message when no translation is used.
2910 Therefore you have to put it in double square brackets at the end of the
2911 message (see the example above).
2912 The translation mechanism of LyX ensures that everything in double square
2913 brackets at the end of messages is removed before displaying the message.
2916 \begin_layout Subsection
2917 Translating the documentation.
2920 \begin_layout Standard
2921 The online documentation (in the
2922 \begin_inset Flex CharStyle:MenuItem
2925 \begin_layout Plain Layout
2931 -menu) can (and should!) be translated.
2932 If there are translated versions of the documentation available
2936 \begin_layout Plain Layout
2937 As of March 2008, at least some of the documents have been translated into
2938 fourteen languages, with the Tutorial available in a few more.
2943 and the locale is set accordingly, these will be used automagically by
2945 LyX looks for translated versions as
2946 \begin_inset Flex CharStyle:Code
2949 \begin_layout Plain Layout
2950 LyXDir/doc/xx/DocName.lyx
2956 \begin_inset Flex CharStyle:Code
2959 \begin_layout Plain Layout
2965 is the code for the language currently in use.
2966 If there are no translated documents, the default English versions will
2968 Note that the translated versions must have the same filenames (
2969 \begin_inset Flex CharStyle:Code
2972 \begin_layout Plain Layout
2978 above) as the original.
2979 If you feel up to translating the documentation (an excellent way to proof-read
2980 the original documentation by the way!), there are a few things you should
2984 \begin_layout Itemize
2985 Check out the documentation translation web page at
2986 \begin_inset CommandInset href
2988 name "http://www.lyx.org/Translation"
2989 target "http://www.lyx.org/Translation"
2994 That way, you can find out which (if any) documents have already been translate
2995 d into your language.
2996 You can also find out who (if anyone) is organizing the effort to translate
2997 the documentation into your language.
2998 If no one is organizing the effort, please let us know that you're interested.
3001 \begin_layout Standard
3002 Once you get to actually translating, here's a few hints for you that may
3006 \begin_layout Itemize
3007 Join the documentation team! There is information on how to do that in
3008 \begin_inset Flex CharStyle:Code
3011 \begin_layout Plain Layout
3018 \begin_inset Flex CharStyle:MenuItem
3021 \begin_layout Plain Layout
3022 Help\SpecialChar \menuseparator
3028 ), which by the way is the first document you should translate.
3031 \begin_layout Itemize
3032 Learn the typographic conventions for the language you are translating to.
3033 Typography is an ancient art and over the centuries, a great variety of
3034 conventions have developed throughout different parts of the world.
3035 Also study the professional terminology amongst typographers in your country.
3036 Inventing your own terminology will only confuse the users.
3039 (Warning! Typography is addictive!)
3042 \begin_layout Itemize
3043 Make a copy of the document.
3044 This will be your working copy.
3045 You can use this as your personal translated help-file by placing it in
3047 \begin_inset Flex CharStyle:Code
3050 \begin_layout Plain Layout
3059 \begin_layout Itemize
3060 Sometimes the original document (from the LyX-team) will be updated.
3061 Use the source viewer at
3062 \begin_inset CommandInset href
3064 name "http://www.lyx.org/trac/timeline"
3065 target "http://www.lyx.org/trac/timeline"
3069 to see what has been changed.
3070 That way you can easily see which parts of the translated document need
3074 \begin_layout Standard
3075 If you ever find an error in the original document, fix it and notify the
3076 rest of the documentation team of the changes! (You didn't forget to join
3077 the documentation team, did you?)
3080 \begin_layout Standard
3081 \begin_inset Branch OutDated
3084 \begin_layout Section
3085 International Keyboard Support
3088 \begin_layout Standard
3091 [Editor's Note: The following section is by
3099 It needs to be fixed to conform to the new Documentation Style sheet and
3100 to make use of the new v1.0 features.
3101 The whole thing also needs to be merged with the section following it.-jw
3102 It may also be badly out of date.-rh (2008)]
3105 \begin_layout Subsection
3106 Defining Own Keymaps: Keymap File Format
3109 \begin_layout Standard
3110 Let's look at a keyboard definition file a little closer.
3111 It is a plain text file defining
3114 \begin_layout Itemize
3115 key-to-key or key-to-string translations
3118 \begin_layout Itemize
3122 \begin_layout Itemize
3123 dead keys exceptions
3126 \begin_layout Standard
3127 To define key-to-key or key-to-string translation, use this command:
3130 \begin_layout Quotation
3131 \begin_inset Flex CharStyle:Code
3134 \begin_layout Plain Layout
3143 \begin_inset Flex CharStyle:Code
3146 \begin_layout Plain Layout
3155 \begin_layout Standard
3157 \begin_inset Flex CharStyle:Code
3160 \begin_layout Plain Layout
3166 is the key to be translated and
3167 \begin_inset Flex CharStyle:Code
3170 \begin_layout Plain Layout
3176 is the string to be inserted into the document.
3177 To define dead keys, use:
3180 \begin_layout Quotation
3181 \begin_inset Flex CharStyle:Code
3184 \begin_layout Plain Layout
3193 \begin_inset Flex CharStyle:Code
3196 \begin_layout Plain Layout
3205 \begin_layout Standard
3207 \begin_inset Flex CharStyle:Code
3210 \begin_layout Plain Layout
3216 is a keyboard key and
3217 \begin_inset Flex CharStyle:Code
3220 \begin_layout Plain Layout
3227 The following dead keys are supported (shortcut name is in parentheses):
3230 \begin_layout Quotation
3234 \begin_inset space \hfill{}
3240 \begin_layout Quotation
3242 \begin_inset space \hfill{}
3248 \begin_layout Quotation
3250 \begin_inset space \hfill{}
3256 \begin_layout Quotation
3258 \begin_inset space \hfill{}
3264 \begin_layout Quotation
3266 \begin_inset space \hfill{}
3272 \begin_layout Quotation
3274 \begin_inset space \hfill{}
3281 \begin_layout Plain Layout
3293 \begin_layout Quotation
3295 \begin_inset space \hfill{}
3301 \begin_layout Quotation
3303 \begin_inset space \hfill{}
3310 \begin_layout Plain Layout
3322 \begin_layout Quotation
3324 \begin_inset space \hfill{}
3330 \begin_layout Quotation
3332 \begin_inset space \hfill{}
3338 \begin_layout Quotation
3340 \begin_inset space \hfill{}
3347 \begin_layout Plain Layout
3359 \begin_layout Quotation
3361 \begin_inset space \hfill{}
3368 \begin_layout Plain Layout
3380 \begin_layout Quotation
3382 \begin_inset space \hfill{}
3388 \begin_layout Quotation
3389 hungarian umlaut (hug)
3390 \begin_inset space \hfill{}
3396 \begin_layout Quotation
3398 \begin_inset space \hfill{}
3404 \begin_layout Quotation
3406 \begin_inset space \hfill{}
3413 \begin_layout Plain Layout
3425 \begin_layout Standard
3426 Since in many international keyboards there are exceptions to what some
3427 dead keys should do, you can define them using
3430 \begin_layout Quotation
3431 \begin_inset Flex CharStyle:Code
3434 \begin_layout Plain Layout
3442 deadkey key outstring
3445 \begin_layout Standard
3446 For example, on Slovak keyboard, if you enter caron-o, it generates circumflex-o
3450 \begin_layout Quotation
3451 \begin_inset Flex CharStyle:Code
3454 \begin_layout Plain Layout
3467 \begin_layout Standard
3468 to make it work correctly.
3469 Also, you have to define as exceptions dead keys over i and j, to remove
3470 the dot from them before inserting an accent mark.
3471 I will change this when the time comes, but so far I haven't had time.
3474 \begin_layout Standard
3475 Oh, and about characters: backslash is escaped, so to enter it, you'll need
3478 \begin_inset Flex CharStyle:Code
3481 \begin_layout Plain Layout
3487 have different meaning.
3489 \begin_inset Flex CharStyle:Code
3492 \begin_layout Plain Layout
3498 marks comments, quotes start and end LaTeX-style commands.
3499 To enter quote, you'll need to use
3500 \begin_inset Flex CharStyle:Code
3503 \begin_layout Plain Layout
3512 \begin_inset Flex CharStyle:Code
3515 \begin_layout Plain Layout
3522 \begin_inset Flex CharStyle:Code
3525 \begin_layout Plain Layout
3536 \begin_layout Standard
3537 If you make a keyboard description file that works for your language, please
3538 mail it to me, so I can include it in the next keymap distribution.
3541 \begin_layout Standard
3542 More keywords will be supported in keymap configuration file in future,
3546 \begin_layout Itemize
3547 \begin_inset Flex CharStyle:Code
3550 \begin_layout Plain Layout
3561 \begin_inset space \hfill{}
3565 \begin_inset Flex CharStyle:Code
3568 \begin_layout Plain Layout
3577 \begin_layout Itemize
3578 \begin_inset Flex CharStyle:Code
3581 \begin_layout Plain Layout
3592 \begin_inset space \hfill{}
3596 \begin_inset Flex CharStyle:Code
3599 \begin_layout Plain Layout
3605 an external keymap translation program
3608 \begin_layout Standard
3609 Also, it should look into
3610 \begin_inset Flex CharStyle:Code
3613 \begin_layout Plain Layout
3619 file for defaults, too (for example, a
3620 \begin_inset Flex CharStyle:Code
3623 \begin_layout Plain Layout
3631 option to include default keyboard).
3639 \begin_layout Section
3640 International Keymap Stuff
3641 \begin_inset CommandInset label
3643 name "sec:International-Keymap-Stuff"
3650 \begin_layout Standard
3651 \begin_inset Note Note
3654 \begin_layout Plain Layout
3655 In doing the revisions on this document in March 2008, I did not look over
3656 this stuff, as I do not understand it.
3657 It would be good if someone else could do so.
3666 \begin_layout Standard
3667 The next two sections describe the
3668 \begin_inset Flex CharStyle:Code
3671 \begin_layout Plain Layout
3680 \begin_inset Flex CharStyle:Code
3683 \begin_layout Plain Layout
3691 file syntax in detail.
3692 These sections should help you design your own key map if the ones provided
3693 do not meet your needs.
3696 \begin_layout Subsection
3700 \begin_layout Standard
3704 \begin_inset Flex CharStyle:Code
3707 \begin_layout Plain Layout
3713 file maps keystrokes to characters or strings.
3714 As the name suggests, it sets a keyboard mapping.
3716 \begin_inset Flex CharStyle:Code
3719 \begin_layout Plain Layout
3730 \begin_inset Flex CharStyle:Code
3733 \begin_layout Plain Layout
3748 \begin_inset Flex CharStyle:Code
3751 \begin_layout Plain Layout
3764 \begin_inset Flex CharStyle:Code
3767 \begin_layout Plain Layout
3776 \begin_inset Flex CharStyle:Code
3779 \begin_layout Plain Layout
3787 are described in this section.
3790 \begin_layout Labeling
3791 \labelwidthstring 00.00.0000
3792 \begin_inset Flex CharStyle:Code
3795 \begin_layout Plain Layout
3803 Map a character to a string
3806 \begin_layout LyX-Code
3821 \begin_layout Standard
3854 the double-quote (")
3871 must be escaped with a preceding backslash (
3882 \begin_layout Standard
3884 \begin_inset Flex CharStyle:MenuItem
3887 \begin_layout Plain Layout
3895 statement to cause the symbol
3896 \begin_inset Flex CharStyle:MenuItem
3899 \begin_layout Plain Layout
3907 to be output for the keystroke
3908 \begin_inset Flex CharStyle:MenuItem
3911 \begin_layout Plain Layout
3922 \begin_layout LyX-Code
3928 \begin_layout Labeling
3929 \labelwidthstring 00.00.0000
3930 \begin_inset Flex CharStyle:Code
3933 \begin_layout Plain Layout
3941 Specify an accent character
3944 \begin_layout LyX-Code
3953 \begin_layout Standard
3954 This will make the cha
3992 This is the dead key
3996 \begin_layout Plain Layout
4003 refers to a key that does not produce a character by itself, but when followed
4004 with another key, produces the desired accent character.
4005 For example, a German characte
4007 r with an umlaut like
4017 can be produced in this manner.
4026 \begin_layout Standard
4039 and then another key not in
4056 followed by the other, not allowed key, as output.
4060 \begin_inset Flex CharStyle:MenuItem
4063 \begin_layout Plain Layout
4071 cancels a dead key, so if
4082 \begin_inset Flex CharStyle:MenuItem
4085 \begin_layout Plain Layout
4094 , the cursor will not go one position backwards but will instead cancel
4110 might have had on the next keystroke.
4114 \begin_layout Standard
4115 The following example specifies that the character ' is to be an acute accent,
4116 allowed on the characters a, e, i, o, u, A, E, I, O, and U:
4119 \begin_layout LyX-Code
4122 kmod ' acute aeiouAEIOU
4125 \begin_layout Labeling
4126 \labelwidthstring 00.00.0000
4127 \begin_inset Flex CharStyle:Code
4130 \begin_layout Plain Layout
4136 Specify an exception to the accent character
4139 \begin_layout LyX-Code
4148 \begin_layout Standard
4149 This defines an exce
4190 have been assigned a keystroke with a previous
4193 \begin_inset Flex CharStyle:Code
4196 \begin_layout Plain Layout
4220 must not belong in the
4267 If such a declaration does not exist in
4275 \begin_inset Flex CharStyle:Code
4278 \begin_layout Plain Layout
4312 \begin_inset Flex CharStyle:Code
4315 \begin_layout Plain Layout
4329 \begin_layout Standard
4330 The following command produces causes äi to be produced when you enter acute-i
4334 \begin_layout LyX-Code
4348 \begin_layout Labeling
4349 \labelwidthstring 00.00.0000
4350 \begin_inset Flex CharStyle:Code
4353 \begin_layout Plain Layout
4359 Combine two accent characters
4362 \begin_layout LyX-Code
4368 accent1 accent2 allowed
4371 \begin_layout Standard
4372 This one is getting pretty esoteric.
4373 It allows you to combine the effect
4429 \begin_inset Flex CharStyle:Code
4432 \begin_layout Plain Layout
4460 \begin_layout Standard
4461 Consider this example from the
4462 \begin_inset Flex CharStyle:Code
4465 \begin_layout Plain Layout
4476 \begin_layout LyX-Code
4479 kmod ; acute aeioyvhAEIOYVH
4483 kcomb acute umlaut iyIY
4486 \begin_layout Standard
4487 This allows you to press
4488 \begin_inset Flex CharStyle:MenuItem
4491 \begin_layout Plain Layout
4499 and get the effect of
4500 \begin_inset Flex CharStyle:Code
4503 \begin_layout Plain Layout
4522 in this case cancels the last dead key, so if you press
4523 \begin_inset Flex CharStyle:MenuItem
4526 \begin_layout Plain Layout
4535 \begin_inset Flex CharStyle:Code
4538 \begin_layout Plain Layout
4551 \begin_layout Subsection
4555 \begin_layout Standard
4557 \begin_inset Flex CharStyle:Code
4560 \begin_layout Plain Layout
4568 mapping is performed, a
4569 \begin_inset Flex CharStyle:Code
4572 \begin_layout Plain Layout
4582 file maps the strings that the symbols generate to characters in the current
4584 The LyX distribution currently includes at least the
4585 \begin_inset Flex CharStyle:Code
4588 \begin_layout Plain Layout
4597 \begin_inset Flex CharStyle:Code
4600 \begin_layout Plain Layout
4611 \begin_layout Standard
4613 \begin_inset Flex CharStyle:Code
4616 \begin_layout Plain Layout
4624 file is a sequence of declarations of the form
4627 \begin_layout LyX-Code
4640 \begin_layout Standard
4641 For example, in order to map
4642 \begin_inset Flex CharStyle:MenuItem
4645 \begin_layout Plain Layout
4655 to the corresponding character in the iso-8859-1 set (233), the following
4659 \begin_layout LyX-Code
4667 \begin_layout Standard
4669 \begin_inset Flex CharStyle:Code
4672 \begin_layout Plain Layout
4681 \begin_inset Flex CharStyle:Code
4684 \begin_layout Plain Layout
4702 the same character can apply to more than one string.
4704 \begin_inset Flex CharStyle:Code
4707 \begin_layout Plain Layout
4718 \begin_layout LyX-Code
4730 \begin_inset Newline newline
4746 \begin_layout Standard
4747 If LyX cannot find a mapping for the string produced by the keystroke or
4748 a deadkey sequence, it will check if it looks like an accented char and
4749 try to draw an accent over the character on screen.
4752 \begin_layout Subsection
4756 \begin_layout Standard
4757 There is a second way to add support for international characters through
4758 so-called dead-keys.
4759 A dead-key works in combination with a letter to produce an accented character.
4760 Here, we'll explain how to create a really simple dead-key to illustrate
4764 \begin_layout Standard
4765 Suppose you happen to need the circumflex character,
4766 \begin_inset Quotes eld
4770 \begin_inset Quotes erd
4775 \begin_inset Flex CharStyle:MenuItem
4778 \begin_layout Plain Layout
4785 \begin_inset space ~
4789 \begin_inset Flex CharStyle:MenuItem
4792 \begin_layout Plain Layout
4798 ] to the LyX command
4799 \begin_inset Flex CharStyle:Code
4802 \begin_layout Plain Layout
4809 \begin_inset Flex CharStyle:Code
4812 \begin_layout Plain Layout
4819 Now, whenever you type the
4820 \begin_inset Flex CharStyle:MenuItem
4823 \begin_layout Plain Layout
4829 -key followed by a letter, that letter will have a circumflex accent on
4831 For example, the sequence
4832 \begin_inset Quotes eld
4836 \begin_inset Flex CharStyle:MenuItem
4839 \begin_layout Plain Layout
4846 \begin_inset Quotes erd
4849 produces the letter:
4850 \begin_inset Quotes eld
4854 \begin_inset Quotes erd
4858 If you tried to type
4859 \begin_inset Quotes eld
4863 \begin_inset Flex CharStyle:MenuItem
4866 \begin_layout Plain Layout
4873 \begin_inset Quotes erd
4876 , however, LyX will complain with a beep, since a
4877 \begin_inset Quotes eld
4881 \begin_inset Flex CharStyle:MenuItem
4884 \begin_layout Plain Layout
4891 \begin_inset Quotes erd
4894 never takes a circumflex accent.
4896 \begin_inset Flex CharStyle:MenuItem
4899 \begin_layout Plain Layout
4905 after a dead-key produces the bare-accent.
4906 Please note this last point! If you bind a key to a dead-key, you'll need
4907 to rebind the character on that key to yet another key.
4909 \begin_inset Flex CharStyle:MenuItem
4912 \begin_layout Plain Layout
4918 to a cedilla is a bad idea, since you'll only get cedillas instead of commas.
4921 \begin_layout Standard
4922 One common way to bind dead-keys is to use
4923 \begin_inset Flex CharStyle:MenuItem
4926 \begin_layout Plain Layout
4933 \begin_inset Flex CharStyle:MenuItem
4936 \begin_layout Plain Layout
4943 \begin_inset Flex CharStyle:MenuItem
4946 \begin_layout Plain Layout
4952 in combination with an accent, like
4953 \begin_inset Quotes eld
4957 \begin_inset Flex CharStyle:MenuItem
4960 \begin_layout Plain Layout
4967 \begin_inset Quotes erd
4971 \begin_inset Quotes eld
4975 \begin_inset Flex CharStyle:MenuItem
4978 \begin_layout Plain Layout
4985 \begin_inset Quotes erd
4989 \begin_inset Quotes eld
4993 \begin_inset Flex CharStyle:MenuItem
4996 \begin_layout Plain Layout
5003 \begin_inset Quotes erd
5007 Another way involves using
5008 \begin_inset Flex CharStyle:Code
5011 \begin_layout Plain Layout
5018 \begin_inset Flex CharStyle:Code
5021 \begin_layout Plain Layout
5027 to set up the special
5028 \begin_inset Flex CharStyle:Code
5031 \begin_layout Plain Layout
5039 \begin_inset Flex CharStyle:Code
5042 \begin_layout Plain Layout
5048 acts in some ways just like
5049 \begin_inset Flex CharStyle:MenuItem
5052 \begin_layout Plain Layout
5058 and permits you to bind keys to accented characters.
5059 You can also turn keys into dead-keys by binding them to something like
5061 \begin_inset Flex CharStyle:Code
5064 \begin_layout Plain Layout
5070 and then binding this symbolic key to the corresponding LyX command.
5074 \begin_layout Plain Layout
5079 : This is exactly what I do in my
5080 \begin_inset Flex CharStyle:Code
5083 \begin_layout Plain Layout
5090 \begin_inset Flex CharStyle:Code
5093 \begin_layout Plain Layout
5101 \begin_inset Flex CharStyle:MenuItem
5104 \begin_layout Plain Layout
5106 \begin_inset space ~
5115 \begin_inset Flex CharStyle:Code
5118 \begin_layout Plain Layout
5124 and a bunch of these
5125 \begin_inset Quotes eld
5129 \begin_inset Flex CharStyle:Code
5132 \begin_layout Plain Layout
5139 \begin_inset Quotes erd
5142 symbolic keys bound such things as
5143 \begin_inset Flex CharStyle:MenuItem
5146 \begin_layout Plain Layout
5148 \begin_inset space ~
5157 \begin_inset Flex CharStyle:MenuItem
5160 \begin_layout Plain Layout
5162 \begin_inset space ~
5171 This is how I produce my accented characters.
5176 You can make just about anything into the
5177 \begin_inset Flex CharStyle:Code
5180 \begin_layout Plain Layout
5187 \begin_inset Flex CharStyle:MenuItem
5190 \begin_layout Plain Layout
5196 keys, a spare function key, etc.
5197 As for the LyX commands that produce accents, check the entry for
5198 \begin_inset Flex CharStyle:Code
5201 \begin_layout Plain Layout
5212 You'll find the complete list there.
5215 \begin_layout Subsection
5216 Saving your Language Configuration
5219 \begin_layout Standard
5220 You can edit your preferences so that your desired language environment
5221 is automatically configured when LyX starts up, via the
5222 \begin_inset Flex CharStyle:MenuItem
5225 \begin_layout Plain Layout
5226 Edit\SpecialChar \menuseparator
5235 \begin_layout Chapter
5236 Installing New Document Classes, Layouts, and Templates
5237 \begin_inset CommandInset label
5239 name "cha:Installing-New-Document"
5247 \begin_layout Plain Layout
5248 Installing New Document Classes
5256 \begin_layout Standard
5257 In this chapter, we describe the procedures for creating and installing
5258 new LyX layout and template files, as well as offer a refresher on correctly
5259 installing new LaTeX document classes.
5263 \begin_layout Standard
5264 First, let us a say a few words about how one ought to think about the relation
5265 between LyX and LaTeX.
5266 The thing to understand is that, in a certain sense, LyX doesn't know anything
5268 Indeed, from LyX's point of view, LaTeX is just one of several
5269 \begin_inset Quotes eld
5273 \begin_inset Quotes erd
5276 in which it is capable of producing output.
5277 Other such formats are DocBook, plaintext, and XHTML.
5278 LaTeX is, of course, a particularly important format, but very little of
5279 the information LyX has about LaTeX is actually contained in the program
5284 \begin_layout Plain Layout
5285 Some commands are sufficiently complex that they are
5286 \begin_inset Quotes eld
5290 \begin_inset Quotes erd
5294 But the developers generally regard this as a Bad Thing.
5299 Rather, that information, even for the standard classes like
5300 \begin_inset Flex CharStyle:Code
5303 \begin_layout Plain Layout
5309 , is contained in `layout files'.
5310 Similarly, LyX itself does not know much about DocBook or XHTML.
5311 What it knows is contained in layout files.
5314 \begin_layout Standard
5315 You can think of the layout file for a given document class as a translation
5316 manual between LyX constructs---paragraphs with their corresponding styles,
5317 certain sorts of insets, etc---and the corresponding LaTeX, DocBook, or
5319 Almost everything LyX knows about
5320 \begin_inset Flex CharStyle:Code
5323 \begin_layout Plain Layout
5329 , for example, is contained in the file
5330 \begin_inset Flex CharStyle:Code
5333 \begin_layout Plain Layout
5339 and in various other files it includes.
5340 For this reason, anyone intending to write layout files should plan to
5341 study the existing files.
5342 A good place to start is with
5343 \begin_inset Flex CharStyle:Code
5346 \begin_layout Plain Layout
5352 , which is included in
5353 \begin_inset Flex CharStyle:Code
5356 \begin_layout Plain Layout
5363 \begin_inset Flex CharStyle:Code
5366 \begin_layout Plain Layout
5372 , and many of the other layout files for document classes.
5373 This file is where sections and the like are defined:
5374 \begin_inset Flex CharStyle:Code
5377 \begin_layout Plain Layout
5383 tells LyX how paragraphs that are marked with the Section, Subsection,
5384 etc, styles can be translated into corresponding LaTeX, DocBook, and XHTML
5387 \begin_inset Flex CharStyle:Code
5390 \begin_layout Plain Layout
5396 file basically just includes several of these
5397 \begin_inset Flex CharStyle:Code
5400 \begin_layout Plain Layout
5409 \begin_layout Standard
5410 Defining the LyX--LaTeX correspondence is not the only thing layout files
5412 Their other job is to define how the LyX constructs themselves will appear
5414 The fact that layout files have these two jobs is often a source of confusion,
5415 because they are completely separate.
5416 Telling LyX how to translate a certain paragraph style into LaTeX does
5417 not tell LyX how to display it; conversely, telling LyX how to display
5418 a certain paragraph style does not tell LyX how to translate it into LaTeX
5419 (let alone tell LaTeX how to display it).
5420 So, in general, when you define a new LyX construct, you must always do
5421 two quite separate things: (i)
5422 \begin_inset space ~
5425 tell LyX how to translate it into LaTeX and (ii)
5426 \begin_inset space ~
5429 tell LyX how to display it.
5432 \begin_layout Standard
5433 Much the same is true, of course, as regards LyX's other backend formats,
5434 though XHTML is in some ways different, because in that case LyX
5438 able, to some extent, to use information about how it should display a
5439 paragraph on the screen to output information (in the form of CSS) about
5440 how the paragraph should be displayed in a browser.
5441 Even in this case, however, the distinction between what LyX does internally
5442 and how things are rendered externally remains in force, and the two can
5443 be controlled separately.
5445 \begin_inset CommandInset ref
5446 LatexCommand prettyref
5447 reference "sec:Tags-for-XHTML"
5454 \begin_layout Section
5455 Installing new LaTeX files
5458 \begin_layout Standard
5459 Some installations may not include a LaTeX package or class file that you
5460 would like to use within LyX.
5461 For example, you might need FoilTeX, a package for preparing slides for
5462 overhead projectors.
5463 Modern LaTeX distributions like TeXLive (2008 or newer) or MiKTeX provide
5464 a user interface for installing such packages.
5465 For example, with MiKTeX, you start the program
5466 \begin_inset Quotes eld
5470 \begin_inset Quotes erd
5473 to get a list of available packages.
5474 To install one, right click on it or use the toolbar button to install
5479 \begin_layout Standard
5480 If your LaTeX distribution doesn't provide such a `package manager', or
5481 if the file is not available from your distribution, then you can follow
5482 these steps to install it manually.
5485 \begin_layout Enumerate
5486 Get the package from
5487 \begin_inset CommandInset href
5490 target "http://www.ctan.org/"
5497 \begin_layout Enumerate
5498 You can install the package in several different places.
5499 If you want it to be available for all users on your system, then you should
5500 install it in your `local' TeX tree; if you want (or need) it to be available
5501 just for you, then you can install it in your own `user' TeX tree.
5502 Where these trees should be created, if they do not already exist, depends
5503 upon the details of your system.
5504 To find out where they are, look in the file
5505 \begin_inset Flex CharStyle:Code
5508 \begin_layout Plain Layout
5518 \begin_layout Plain Layout
5519 This usually lives in the directory
5520 \begin_inset Flex CharStyle:Code
5523 \begin_layout Plain Layout
5529 , though you can run
5530 \begin_inset Flex CharStyle:Code
5533 \begin_layout Plain Layout
5544 The location of the `local' TeX tree is defined by the
5545 \begin_inset Flex CharStyle:Code
5548 \begin_layout Plain Layout
5554 variable; this is usually somewhere like
5555 \begin_inset Flex URL
5558 \begin_layout Plain Layout
5560 /usr/local/share/texmf/
5566 The location of the `user' TeX tree is defined by
5567 \begin_inset Flex CharStyle:Code
5570 \begin_layout Plain Layout
5577 \begin_inset Flex CharStyle:Code
5580 \begin_layout Plain Layout
5587 (If these variables are not predefined, you can define them.) You'll probably
5588 need root permissions to create or modify the `local' tree, but your `user'
5589 tree shouldn't have such limitations.
5592 \begin_layout Enumerate
5594 \begin_inset Flex CharStyle:Code
5597 \begin_layout Plain Layout
5604 \begin_inset Flex CharStyle:Code
5607 \begin_layout Plain Layout
5614 \begin_inset Flex CharStyle:Code
5617 \begin_layout Plain Layout
5624 \begin_inset space \thinspace{}
5628 \begin_inset Newline newline
5632 \begin_inset Flex CharStyle:Code
5635 \begin_layout Plain Layout
5636 TEXMF = {$TEXMFHOME,!!$TEXMFLOCAL,!!$TEXMFMAIN}
5642 \begin_inset Newline newline
5648 \begin_layout Enumerate
5649 Your local and user trees
5653 have the same sort of directory structure as your main existing
5654 \begin_inset Flex CharStyle:Code
5657 \begin_layout Plain Layout
5663 directory, which will be found at
5664 \begin_inset Flex CharStyle:Code
5667 \begin_layout Plain Layout
5674 \begin_inset Flex CharStyle:Code
5677 \begin_layout Plain Layout
5683 .) For example, latex packages should go under
5684 \begin_inset Flex CharStyle:Code
5687 \begin_layout Plain Layout
5688 $TEXMFLOCAL/tex/latex/
5694 \begin_inset Flex CharStyle:Code
5697 \begin_layout Plain Layout
5698 $TEXMFHOME/tex/latex/
5704 If you do not put them here, they probably will not work.
5707 \begin_layout Enumerate
5708 Once your tree is properly set up, you can install the package into an appropria
5710 If you are lucky, your package will have been provided as a so-called `TDS'
5711 (TeX Directory Structure) zip file.
5712 To install it, you want to unzip it from the top of your tree.
5713 So, for example, you can copy the file
5714 \begin_inset Flex CharStyle:Code
5717 \begin_layout Plain Layout
5724 \begin_inset Flex CharStyle:Code
5727 \begin_layout Plain Layout
5728 /home/yourname/texmf/
5733 and then, from inside that directory, just run:
5734 \begin_inset Flex CharStyle:Code
5737 \begin_layout Plain Layout
5744 This will extract the needed files and copy them where they need to be.
5745 \begin_inset Newline newline
5748 If you do not have a TDS file, then you have to do this manually.
5749 For example, you might install the FoilTeX files into
5750 \begin_inset Flex URL
5753 \begin_layout Plain Layout
5755 $TEXMFLOCAL/tex/latex/contrib/foiltex
5761 Why there? The CTAN download directories are themselves organized much
5762 like a TeX tree, and it isn't a bad idea to follow its structure when you
5763 install your own files.
5764 FoilTeX, as it happens, is found at
5765 \begin_inset Flex URL
5768 \begin_layout Plain Layout
5770 http://ctan.org/texarchive/macros/latex/contrib/foiltex/
5779 \begin_layout Enumerate
5780 Finally, you must update the database TeX uses to find files.
5781 On MiKTeX, this is done by pressing the button
5784 \begin_inset space ~
5789 that you find in MiKTeX's
5790 \begin_inset Quotes eld
5794 \begin_inset Quotes erd
5799 \begin_inset Flex CharStyle:Code
5802 \begin_layout Plain Layout
5803 $TEXMFLOCAL/tex/latex/
5809 Under TeXLive and the like, you should run
5810 \begin_inset Flex CharStyle:Code
5813 \begin_layout Plain Layout
5819 from a terminal, with root permissions if necessary.
5823 \begin_layout Standard
5824 Your package is now installed and available to LaTeX.
5825 You can verify this from a terminal by typing `
5826 \begin_inset Flex CharStyle:Code
5829 \begin_layout Plain Layout
5830 kpsewhich yourfile.ext
5836 To make LyX aware of it, however, you will need to reconfigure (
5837 \begin_inset Flex CharStyle:MenuItem
5840 \begin_layout Plain Layout
5841 Tools\SpecialChar \menuseparator
5847 ) and then restart LyX.
5848 If the new package was a document class, such as FoilTeX again, you will
5849 now see it available under
5850 \begin_inset Flex CharStyle:MenuItem
5853 \begin_layout Plain Layout
5854 Document\SpecialChar \menuseparator
5855 Settings\SpecialChar \menuseparator
5862 \begin_inset Flex CharStyle:MenuItem
5865 \begin_layout Plain Layout
5874 \begin_layout Standard
5875 What if there isn't a layout file is available for your new document class?
5876 Then, unfortunately, LyX will know nothing about it until you create a
5877 layout file yourself (or get someone else to do it).
5878 That is the topic of the next section.
5881 \begin_layout Section
5882 Types of layout files
5885 \begin_layout Standard
5886 This section describes the various sorts of LyX files that contain layout
5888 These files describe various paragraph and character styles, determining
5889 how LyX should display them and how they should be translated into LaTeX,
5890 DocBook, XHTML, or whatever output format is being used.
5894 \begin_layout Standard
5895 We shall try to provide a thorough description of the process of writing
5897 However, there are so many different types of documents supported even
5898 by just LaTeX that we can't hope to cover every different possibility or
5899 problem you might encounter.
5900 The LyX users' list is frequented by people with lots of experience with
5901 layout design who are willing to share what they've learned, so please
5902 feel free to ask questions there.
5905 \begin_layout Standard
5906 As you prepare to write a new layout, it is extremely helpful to look at
5907 the layouts distributed with LyX.
5908 If you write a LyX layout for a LaTeX document class that might also be
5909 used by others, or write a module that might be useful to others, then
5910 you should consider posting your layout to the
5911 \begin_inset CommandInset href
5913 name "layout section on the LyX wiki"
5914 target "http://wiki.lyx.org/Layouts/Layouts"
5918 or even to the LyX developers' list, so that it might be included in LyX
5923 \begin_layout Plain Layout
5924 Note that LyX is licensed under the General Public License, so any material
5925 that is contribued to LyX must be similarly licensed.
5933 \begin_layout Subsection
5935 \begin_inset CommandInset label
5937 name "sub:Layout-modules"
5944 \begin_layout Standard
5945 We have spoken to this point about `layout files'.
5946 But there are different sorts of files that contain layout information.
5947 Layout files, strictly so called, have the
5948 \begin_inset Flex CharStyle:Code
5951 \begin_layout Plain Layout
5957 extension and provide LyX with information about document classes.
5958 As of LyX 1.6, however, layout information can also be contained in layout
5964 \begin_inset Flex CharStyle:Code
5967 \begin_layout Plain Layout
5974 Modules are to LaTeX packages much as layouts are to LaTeX classes, and
5975 some modules—such as the
5976 \begin_inset Flex CharStyle:Code
5979 \begin_layout Plain Layout
5985 module—specifcally provide support for one package.
5986 In a sense, layout modules are similar to included
5990 \begin_layout Plain Layout
5991 These can have any extension, but by convention have the
5992 \begin_inset Flex CharStyle:Code
5995 \begin_layout Plain Layout
6007 \begin_inset Flex CharStyle:Code
6010 \begin_layout Plain Layout
6016 —in that modules are not specific to a given document class but may be used
6017 with many different classes.
6018 The difference is that using an included file with
6019 \begin_inset Flex CharStyle:Code
6022 \begin_layout Plain Layout
6028 requires editing that file.
6029 Modules, by contrast, are selected in the
6030 \begin_inset Flex CharStyle:MenuItem
6033 \begin_layout Plain Layout
6034 Document\SpecialChar \menuseparator
6043 \begin_layout Standard
6044 Building modules is the easiest way to get started with layout editing,
6045 since it can be as simple as adding a single new paragraph style or flex
6047 But modules may, in principle, contain anything a layout file can contain.
6050 \begin_layout Standard
6051 After creating a new module and copying it to the
6052 \begin_inset Flex CharStyle:Code
6055 \begin_layout Plain Layout
6061 folder, you will need to reconfigure and then restart LyX for the module
6062 to appear in the menu.
6063 However, changes you make to the module will be seen immediately, if you
6065 \begin_inset Flex CharStyle:MenuItem
6068 \begin_layout Plain Layout
6069 Document\SpecialChar \menuseparator
6075 , highlight something, and then hit
6076 \begin_inset Quotes eld
6080 \begin_inset Quotes erd
6086 It is strongly recommended that you save your work before doing this
6091 it is strongly recommended that you not attempt to edit modules while simultaneo
6092 usly working on actual documents
6095 Though of course the developers strive to keep LyX stable in such situations,
6096 syntax errors and the like in your module file could cause strange behavior.
6099 \begin_layout Subsection
6101 \begin_inset Flex CharStyle:MenuItem
6104 \begin_layout Plain Layout
6113 \begin_layout Standard
6114 There are two situations you are likely to encounter when wanting to support
6115 a new LaTeX document class, involving LaTeX2e class (
6116 \begin_inset Flex CharStyle:Code
6119 \begin_layout Plain Layout
6126 \begin_inset Flex CharStyle:Code
6129 \begin_layout Plain Layout
6136 Supporting a style file is usually fairly easy.
6137 Supporting a new class file is a bit harder.
6138 We'll discuss the former in this section and the latter in the next.
6139 Similar remarks apply, of course, if you want to support a new DocBook
6143 \begin_layout Standard
6144 The easier case is the one in which your new document class is provided
6145 as a style file that is to be used in conjunction with an already supported
6147 For the sake of the example, we'll assume that the style file is called
6149 \begin_inset Flex CharStyle:MenuItem
6152 \begin_layout Plain Layout
6158 and that it is meant to be used with
6159 \begin_inset Flex CharStyle:MenuItem
6162 \begin_layout Plain Layout
6168 , which is a standard class.
6172 \begin_layout Standard
6173 Start by copying the existing class's layout file into your local directory:
6177 \begin_layout Plain Layout
6178 Of course, which directory is your local directory will vary by platform,
6179 and LyX allows you to specify your local directory on startup, too, using
6181 \begin_inset Flex CharStyle:Code
6184 \begin_layout Plain Layout
6198 \begin_layout LyX-Code
6199 cp report.layout ~/.lyx/layouts/myclass.layout
6202 \begin_layout Standard
6204 \begin_inset Flex CharStyle:Code
6207 \begin_layout Plain Layout
6213 and change the line:
6216 \begin_layout LyX-Code
6219 DeclareLaTeXClass{report}
6222 \begin_layout Standard
6226 \begin_layout LyX-Code
6229 DeclareLaTeXClass[report, myclass.sty]{report (myclass)}
6232 \begin_layout Standard
6236 \begin_layout LyX-Code
6238 \begin_inset Newline newline
6244 \begin_inset Newline newline
6250 \begin_layout Standard
6251 near the top of the file.
6254 \begin_layout Standard
6255 Start LyX and select
6256 \begin_inset Flex CharStyle:MenuItem
6259 \begin_layout Plain Layout
6260 Tools\SpecialChar \menuseparator
6267 Then restart LyX and try creating a new document.
6269 \begin_inset Flex CharStyle:MenuItem
6272 \begin_layout Plain Layout
6278 " as a document class option in the
6279 \begin_inset Flex CharStyle:MenuItem
6282 \begin_layout Plain Layout
6283 Document\SpecialChar \menuseparator
6290 It is likely that some of the sectioning commands and such in your new
6291 class will work differently from how they worked in the base class—
6292 \begin_inset Flex CharStyle:Code
6295 \begin_layout Plain Layout
6301 in this example—so you can fiddle around with the settings for the different
6302 sections if you wish.
6303 The layout information for sections is contained in
6304 \begin_inset Flex CharStyle:Code
6307 \begin_layout Plain Layout
6313 , but you do not need to copy and change this file.
6314 Instead, you can simply add your changes to your layout file, after the
6316 \begin_inset Flex CharStyle:Code
6319 \begin_layout Plain Layout
6325 , which itself includes
6326 \begin_inset Flex CharStyle:Code
6329 \begin_layout Plain Layout
6336 For example, you might add these lines:
6339 \begin_layout LyX-Code
6343 \begin_layout LyX-Code
6347 \begin_layout LyX-Code
6351 \begin_layout LyX-Code
6355 \begin_layout LyX-Code
6359 \begin_layout Standard
6360 to change the font for chapter headings to sans-serif.
6361 This will override (or, in this case, add to) the existing declaration
6362 for the Chapter style.
6366 \begin_layout Standard
6367 Your new package may also provide commands or environments not present in
6369 In this case, you will want to add these to the layout file.
6371 \begin_inset CommandInset ref
6373 reference "sec:TextClass"
6377 for information on how to do so.
6380 \begin_layout Standard
6382 \begin_inset Flex CharStyle:MenuItem
6385 \begin_layout Plain Layout
6391 can be used with several different document classes, and even if it cannot,
6392 you might find it easiest just to write a module that you can load with
6394 The simplest possible such module would be:
6397 \begin_layout LyX-Code
6400 DeclareLyXModule{My Package}
6403 \begin_layout LyX-Code
6407 \begin_layout LyX-Code
6408 #Support for mypkg.sty.
6411 \begin_layout LyX-Code
6413 \begin_inset Newline newline
6419 \begin_layout LyX-Code
6421 \begin_inset Newline newline
6427 \begin_layout LyX-Code
6429 \begin_inset Newline newline
6435 \begin_inset Newline newline
6441 \begin_layout Standard
6442 A more complex module might modify the behavior of some existing constructs
6443 or define some new ones.
6445 \begin_inset CommandInset ref
6447 reference "sec:TextClass"
6454 \begin_layout Subsection
6456 \begin_inset Flex CharStyle:MenuItem
6459 \begin_layout Plain Layout
6468 \begin_layout Standard
6469 There are two possibilities here.
6470 One is that the class file is itself based upon an existing document class.
6471 For example, many thesis classes are based upon
6472 \begin_inset Flex CharStyle:MenuItem
6475 \begin_layout Plain Layout
6482 To see whether yours is, look for a line like
6485 \begin_layout LyX-Code
6491 \begin_layout Standard
6493 If so, then you may proceed largely as in the previous section, though
6495 \begin_inset Flex CharStyle:Code
6498 \begin_layout Plain Layout
6504 line will be different.
6505 If your new class is
6506 \begin_inset Flex CharStyle:Code
6509 \begin_layout Plain Layout
6515 and it is based upon
6516 \begin_inset Flex CharStyle:Code
6519 \begin_layout Plain Layout
6525 , then the line should read:
6529 \begin_layout Plain Layout
6530 And it will be easiest if you save the file to
6531 \begin_inset Flex CharStyle:Code
6534 \begin_layout Plain Layout
6540 : LyX assumes that the document class has the same name as the layout file.
6549 \begin_layout LyX-Code
6552 DeclareLaTeXClass[thesis,book]{thesis}
6555 \begin_layout Standard
6556 If, on the other hand, the new class is not based upon an existing class,
6557 you will probably have to
6558 \begin_inset Quotes eld
6562 \begin_inset Quotes erd
6566 We strongly suggest copying an existing layout file which uses a similar
6567 LaTeX class and then modifying it, if you can do so.
6568 At least use an existing file as a starting point so you can find out what
6569 items you need to worry about.
6570 Again, the specifics are covered below.
6573 \begin_layout Subsection
6575 \begin_inset CommandInset label
6577 name "sub:Creating-Templates"
6584 \begin_layout Standard
6585 Once you have written a layout file for a new document class, you might
6586 want to consider writing a
6591 A template acts as a kind of tutorial for your layout, showing how it might
6592 be used, though containing dummy content.
6593 You can of course look at the various templates included with LyX for ideas.
6596 \begin_layout Standard
6597 Templates are created just like usual documents: using LyX.
6598 The only difference is that usual documents contain all possible settings,
6599 including the font scheme and the paper size.
6600 Usually a user doesn't want a template to overwrite his preferred settings
6601 for such parameters.
6602 For that reason, the designer of a template should remove the corresponding
6604 \begin_inset Flex CharStyle:Code
6607 \begin_layout Plain Layout
6616 \begin_inset Flex CharStyle:Code
6619 \begin_layout Plain Layout
6627 from the template LyX file.
6628 This can be done with any simple text-editor, for example
6629 \begin_inset Flex CharStyle:Code
6632 \begin_layout Plain Layout
6639 \begin_inset Flex CharStyle:Code
6642 \begin_layout Plain Layout
6652 \begin_layout Standard
6653 Put the edited template files you create in
6654 \begin_inset Flex CharStyle:Code
6657 \begin_layout Plain Layout
6663 , copy the ones you use from the global template directory in
6664 \begin_inset Flex CharStyle:Code
6667 \begin_layout Plain Layout
6673 to the same place, and redefine the template path in the
6674 \begin_inset Flex CharStyle:MenuItem
6677 \begin_layout Plain Layout
6678 Tools\SpecialChar \menuseparator
6679 Preferences\SpecialChar \menuseparator
6688 \begin_layout Standard
6689 Note, by the way, that there is a template which has a particular meaning:
6691 \begin_inset Flex CharStyle:Code
6694 \begin_layout Plain Layout
6701 This template is loaded every time you create a new document with
6702 \begin_inset Flex CharStyle:MenuItem
6705 \begin_layout Plain Layout
6706 File\SpecialChar \menuseparator
6712 in order to provide useful defaults.
6713 To create this template from inside LyX, all you have to do is to open
6714 a document with the correct settings, and use the
6715 \begin_inset Flex CharStyle:MenuItem
6718 \begin_layout Plain Layout
6719 Save as Document Defaults
6727 \begin_layout Subsection
6728 Upgrading old layout files
6731 \begin_layout Standard
6732 The format of layout files changes with each LyX release, so old layout
6733 files need to be converted to the new format.
6734 This process has been automated since LyX 1.4: If LyX reads a layout file
6735 in an older format, it automatically calls the script
6736 \begin_inset Flex CharStyle:Code
6739 \begin_layout Plain Layout
6745 to convert it to a temporary file in current format.
6746 The original file is left untouched.
6747 If you use the layout file often, then, you may want to convert it permanently,
6748 so that LyX does not have to do so itself every time.
6749 To do this, you can call the converter manually:
6752 \begin_layout LyX-Code
6753 mv myclass.layout myclass.old
6756 \begin_layout LyX-Code
6757 python LyXDir/scripts/layout2layout.py myclass.old myclass.layout
6760 \begin_layout Standard
6762 \begin_inset Flex CharStyle:Code
6765 \begin_layout Plain Layout
6771 with the name of your LyX system directory, of course.
6774 \begin_layout Standard
6775 Note that manual conversion does not affect included files, so these will
6776 have to be converted separately.
6779 \begin_layout Section
6780 \begin_inset CommandInset label
6782 name "sec:TextClass"
6786 The layout file format
6789 \begin_layout Standard
6790 When it's finally time to get your hands dirty and create or edit your own
6791 layout file, the following sections describe what you're up against.
6792 Our advice is to go slowly, save and test often, listen to soothing music,
6793 and enjoy one or two of your favorite adult beverages; more if you are
6794 getting particularly stuck.
6795 It's really not that hard, except that the multitude of options can become
6796 overwhelming if you try to do too much in one sitting.
6797 Go have another adult beverage, just for good measure.
6800 \begin_layout Standard
6801 Note that all the tags used in layout files are case-insensitive.
6803 \begin_inset Flex CharStyle:Code
6806 \begin_layout Plain Layout
6813 \begin_inset Flex CharStyle:Code
6816 \begin_layout Plain Layout
6823 \begin_inset Flex CharStyle:Code
6826 \begin_layout Plain Layout
6832 are really the same tag.
6833 The possible values are printed in brackets after the feature's name.
6834 The default value if a feature isn't specified inside a text class-description
6836 \begin_inset Flex CharStyle:Code
6839 \begin_layout Plain Layout
6848 If the argument has a data type like
6849 \begin_inset Quotes eld
6853 \begin_inset Quotes erd
6857 \begin_inset Quotes eld
6861 \begin_inset Quotes erd
6864 , the default is shown like this:
6865 \begin_inset Flex CharStyle:Code
6868 \begin_layout Plain Layout
6879 \begin_layout Subsection
6880 The Document Class Declaration
6883 \begin_layout Standard
6884 Lines in a layout file which begin with
6885 \begin_inset Flex CharStyle:Code
6888 \begin_layout Plain Layout
6895 There is one exception to this rule.
6897 \begin_inset Flex CharStyle:Code
6900 \begin_layout Plain Layout
6906 files should begin with a line like:
6909 \begin_layout LyX-Code
6912 #% Do not delete the line below; configure depends on this
6915 \begin_layout LyX-Code
6920 DeclareLaTeXClass{article}
6923 \begin_layout Standard
6924 The second line is used when you (re)configure LyX.
6925 The layout file is read by the LaTeX script
6926 \begin_inset Flex CharStyle:Code
6929 \begin_layout Plain Layout
6935 , in a special mode where
6936 \begin_inset Flex CharStyle:Code
6939 \begin_layout Plain Layout
6946 The first line is just a LaTeX comment, and the second one contains the
6947 declaration of the text class.
6948 If these lines appear in a file named
6949 \begin_inset Flex CharStyle:Code
6952 \begin_layout Plain Layout
6958 , then they define a text class of name
6959 \begin_inset Flex CharStyle:Code
6962 \begin_layout Plain Layout
6968 (the name of the layout file) which uses the LaTeX document class
6969 \begin_inset Flex CharStyle:Code
6972 \begin_layout Plain Layout
6978 (the default is to use the same name as the layout).
6980 \begin_inset Quotes eld
6984 \begin_inset Quotes erd
6987 that appears above is used as a description of the text class in the
6988 \begin_inset Flex CharStyle:MenuItem
6991 \begin_layout Plain Layout
6992 Document\SpecialChar \menuseparator
7001 \begin_layout Standard
7002 Let's assume that you wrote your own text class that uses the
7003 \begin_inset Flex CharStyle:Code
7006 \begin_layout Plain Layout
7012 document class, but where you changed the appearance of the section headings.
7013 If you put it in a file
7014 \begin_inset Flex CharStyle:Code
7017 \begin_layout Plain Layout
7023 , the header of this file should be:
7026 \begin_layout LyX-Code
7029 #% Do not delete the line below; configure depends on this
7032 \begin_layout LyX-Code
7037 DeclareLaTeXClass[article]{article (with my own headings)}
7040 \begin_layout Standard
7041 This declares a text class
7042 \begin_inset Flex CharStyle:Code
7045 \begin_layout Plain Layout
7051 , associated with the LaTeX document class
7052 \begin_inset Flex CharStyle:Code
7055 \begin_layout Plain Layout
7062 \begin_inset Quotes eld
7065 article (with my own headings)
7066 \begin_inset Quotes erd
7070 If your text class depends on several packages, you can declare it as:
7073 \begin_layout LyX-Code
7076 #% Do not delete the line below; configure depends on this
7079 \begin_layout LyX-Code
7084 DeclareLaTeXClass[article,foo.sty]{article (with my own headings)}
7087 \begin_layout Standard
7088 This indicates that your text class uses the
7089 \begin_inset Flex CharStyle:Code
7092 \begin_layout Plain Layout
7099 Finally, it is also possible to declare classes for DocBook code.
7100 Typical declarations will look like:
7103 \begin_layout LyX-Code
7106 #% Do not delete the line below; configure depends on this
7109 \begin_layout LyX-Code
7114 DeclareDocBookClass[article]{SGML (DocBook article)}
7117 \begin_layout Standard
7118 Note that these declarations can also be given an optional parameter declaring
7119 the name of the document class (but not a list).
7122 \begin_layout Standard
7123 So, to be as explicit as possible, the form of the layout declaration is:
7126 \begin_layout LyX-Code
7131 DeclareLaTeXClass[class,package.sty]{layout description}
7134 \begin_layout Standard
7135 The class need only be specified if the name of the LaTeX class file and
7136 the name of the layout file are different; if the name of the class file
7137 is not specified, then LyX will simply assume that it is the same as the
7138 name of the layout file.
7141 \begin_layout Standard
7142 When the text class has been modified to your taste, all you have to do
7143 is to copy it either to
7144 \begin_inset Flex CharStyle:Code
7147 \begin_layout Plain Layout
7154 \begin_inset Flex CharStyle:Code
7157 \begin_layout Plain Layout
7164 \begin_inset Flex CharStyle:MenuItem
7167 \begin_layout Plain Layout
7168 Tools\SpecialChar \menuseparator
7174 , exit LyX and restart.
7175 Then your new text class should be available along with the others.
7178 \begin_layout Standard
7179 Once the layout file is installed, you can edit it and see your changes
7180 without having to reconfigure or to restart LyX.
7185 \begin_layout Plain Layout
7186 In versions of LyX prior to 1.6, this was not true.
7187 As a result, editing layout files was very time consuming, since you had
7188 constantly to restart LyX to see changes.
7193 You can force a reload of the current layout by using the LyX function
7195 \begin_inset Flex CharStyle:MenuItem
7198 \begin_layout Plain Layout
7205 There is no default binding for this function—though, of course, you can
7206 bind it to a key yourself.
7207 But you will normally use this function simply by entering it in the mini-buffe
7212 \begin_layout Standard
7218 \begin_inset Flex CharStyle:MenuItem
7221 \begin_layout Plain Layout
7227 is very much an `advanced feature'.
7232 recommended that you save your work before using this function.
7237 recommended that you not attempt to edit layout information while simultaneousl
7238 y working on a document that you care about.
7239 Use a test document.
7240 Syntax errors and the like in your layout file could cause peculiar behavior.
7241 In particular, such errors could cause LyX to regard the current layout
7242 as invalid and to attempt to switch to some other layout.
7246 \begin_layout Plain Layout
7247 Really bad syntax errors may even caused LyX to exit.
7248 This is because certain sorts of errors may make LyX unable to read
7258 The LyX team strives to keep LyX stable in such situations, but safe is
7263 \begin_layout Plain Layout
7264 While we're giving advice: make regular backups.
7265 And be nice to your mother.
7273 \begin_layout Subsection
7274 The Module Declaration
7277 \begin_layout Standard
7278 A module must begin with a line like the following:
7281 \begin_layout LyX-Code
7284 DeclareLyXModule[endnotes.sty]{Endnotes}
7287 \begin_layout Standard
7288 The mandatory argument, in curly brackets, is the name of the module, as
7290 \begin_inset Flex CharStyle:MenuItem
7293 \begin_layout Plain Layout
7294 Document\SpecialChar \menuseparator
7301 The argument in square brackets is optional: It declares any LaTeX packages
7302 on which the module depends.
7303 Please note that only packages about which LyX knows should be listed in
7304 the square brackets.
7308 \begin_layout Plain Layout
7309 The list of such packages is documented only in the source code.
7314 LyX will not check for arbitrary packages.
7315 It is also possible to use the form
7316 \begin_inset Flex CharStyle:MenuItem
7319 \begin_layout Plain Layout
7325 as an optional argument, which declares that the module can only be used
7326 when there exists a conversion chain between the formats `
7327 \begin_inset Flex CharStyle:Code
7330 \begin_layout Plain Layout
7337 \begin_inset Flex CharStyle:Code
7340 \begin_layout Plain Layout
7349 \begin_layout Standard
7350 The module declaration should then be followed by lines like the following:
7353 \begin_layout LyX-Code
7357 \begin_layout LyX-Code
7358 #Adds an endnote command, in addition to footnotes.
7362 \begin_layout LyX-Code
7363 #You will need to add
7365 theendnotes in TeX code where you
7368 \begin_layout LyX-Code
7369 #want the endnotes to appear.
7373 \begin_layout LyX-Code
7377 \begin_layout LyX-Code
7378 #Requires: somemodule | othermodule
7381 \begin_layout LyX-Code
7382 #Excludes: badmodule
7385 \begin_layout Standard
7386 The description is used in
7387 \begin_inset Flex CharStyle:MenuItem
7390 \begin_layout Plain Layout
7391 Document\SpecialChar \menuseparator
7397 to provide the user with information about what the module does.
7399 \begin_inset Flex CharStyle:Code
7402 \begin_layout Plain Layout
7408 line is used to identify other modules with which this one must be used;
7410 \begin_inset Flex CharStyle:Code
7413 \begin_layout Plain Layout
7419 line is used to identify modules with which this one may not be used.
7420 Both are optional, and, as shown, multiple modules should be separated
7421 with the pipe symbol: |.
7422 Note that the required modules are treated disjunctively:
7426 of the required modules must be used.
7431 excluded module may be used.
7432 Note that modules are identified here by their
7437 \begin_inset Flex CharStyle:Code
7440 \begin_layout Plain Layout
7448 \begin_inset Flex CharStyle:Code
7451 \begin_layout Plain Layout
7458 \begin_inset Flex CharStyle:Code
7461 \begin_layout Plain Layout
7470 \begin_layout Subsection
7474 \begin_layout Standard
7475 The first non-comment line of any layout file, included file, or module
7480 contain the file format number:
7483 \begin_layout Description
7484 \begin_inset Flex CharStyle:Code
7487 \begin_layout Plain Layout
7494 \begin_inset Flex CharStyle:Code
7497 \begin_layout Plain Layout
7503 ] The format of the layout file.
7506 \begin_layout Standard
7507 This tag was introduced with LyX 1.4.0.
7508 Layout files from LyX 1.3.x and earlier don't have an explicit file format
7509 and are considered to be of format 1.
7510 The format for the present version of LyX is format 21.
7511 But each version of LyX is capable of reading earlier versions' layout
7512 files, just as they are capable of reading files produced by earlier versions
7514 There is, however, no provision for converting to earlier formats.
7515 So LyX 1.6.x will not read layout files in format 21 but only files in format
7519 \begin_layout Subsection
7520 \begin_inset CommandInset label
7522 name "sub:General-text-class"
7526 General text class parameters
7529 \begin_layout Standard
7530 These are general parameters that govern the behavior of an entire document
7536 mean that they must appear in
7537 \begin_inset Flex CharStyle:Code
7540 \begin_layout Plain Layout
7546 files rather than in modules.
7547 A module can contain any layout tag.)
7550 \begin_layout Description
7551 \begin_inset Flex CharStyle:Code
7554 \begin_layout Plain Layout
7560 Adds information that will be output in the
7561 \begin_inset Flex CharStyle:Code
7564 \begin_layout Plain Layout
7570 block when this document class is output to XHTML.
7571 Typically, this would be used to output CSS style information, but it can
7572 be used for anything that can appear in
7573 \begin_inset Flex CharStyle:Code
7576 \begin_layout Plain Layout
7584 \begin_inset Quotes eld
7588 \begin_inset Flex CharStyle:Code
7591 \begin_layout Plain Layout
7598 \begin_inset Quotes erd
7604 \begin_layout Description
7605 \begin_inset Flex CharStyle:Code
7608 \begin_layout Plain Layout
7614 Adds information to the document preamble.
7616 \begin_inset Quotes eld
7620 \begin_inset Flex CharStyle:Code
7623 \begin_layout Plain Layout
7630 \begin_inset Quotes erd
7636 \begin_layout Description
7637 \begin_inset Flex CharStyle:Code
7640 \begin_layout Plain Layout
7646 Describes various global options supported by the document class.
7648 \begin_inset space ~
7652 \begin_inset CommandInset ref
7654 reference "sub:ClassOptions"
7660 \begin_inset Quotes eld
7664 \begin_inset Flex CharStyle:Code
7667 \begin_layout Plain Layout
7674 \begin_inset Quotes erd
7680 \begin_layout Description
7681 \begin_inset Flex CharStyle:Code
7684 \begin_layout Plain Layout
7691 \begin_inset Flex CharStyle:Code
7694 \begin_layout Plain Layout
7703 \begin_inset Flex CharStyle:Code
7706 \begin_layout Plain Layout
7712 ] Whether the class should
7716 to having one or two columns.
7717 Can be changed in the
7718 \begin_inset Flex CharStyle:MenuItem
7721 \begin_layout Plain Layout
7722 Document\SpecialChar \menuseparator
7731 \begin_layout Description
7732 \begin_inset Flex CharStyle:Code
7735 \begin_layout Plain Layout
7742 \begin_inset Flex CharStyle:Code
7745 \begin_layout Plain Layout
7751 ] This sequence defines the properties for a counter.
7752 If the counter does not yet exist, it is created; if it does exist, it
7755 \begin_inset Quotes eld
7759 \begin_inset Flex CharStyle:Code
7762 \begin_layout Plain Layout
7769 \begin_inset Quotes erd
7773 \begin_inset Newline newline
7777 \begin_inset space ~
7781 \begin_inset CommandInset ref
7783 reference "sub:Counters"
7787 for details on counters.
7790 \begin_layout Description
7791 \begin_inset Flex CharStyle:Code
7794 \begin_layout Plain Layout
7800 Sets the default font used to display the document.
7802 \begin_inset space ~
7806 \begin_inset CommandInset ref
7808 reference "sub:Font-description"
7812 for how to declare fonts.
7814 \begin_inset Quotes eld
7818 \begin_inset Flex CharStyle:Code
7821 \begin_layout Plain Layout
7828 \begin_inset Quotes erd
7834 \begin_layout Description
7835 \begin_inset Flex CharStyle:Code
7838 \begin_layout Plain Layout
7845 \begin_inset Flex CharStyle:Code
7848 \begin_layout Plain Layout
7854 Specifies a module to be included by default with this document class.
7855 The module should be specified by filename without the
7856 \begin_inset Flex CharStyle:Code
7859 \begin_layout Plain Layout
7866 The user can still remove the module, but it will be active at the outset.
7867 (This applies only when new files are created, or when this class is chosen
7868 for an existing document.)
7871 \begin_layout Description
7872 \begin_inset Flex CharStyle:Code
7875 \begin_layout Plain Layout
7882 \begin_inset Flex CharStyle:Code
7885 \begin_layout Plain Layout
7891 ] This is the style that will be assigned to new paragraphs, usually
7892 \begin_inset Flex CharStyle:MenuItem
7895 \begin_layout Plain Layout
7902 This will default to the first defined style if not given, but you are
7903 encouraged to use this directive.
7906 \begin_layout Description
7907 \begin_inset Flex CharStyle:Code
7910 \begin_layout Plain Layout
7917 \begin_inset Flex CharStyle:Code
7920 \begin_layout Plain Layout
7926 ] This tag indicates that the module in question—which should be specified
7927 by filename without the
7928 \begin_inset Flex CharStyle:Code
7931 \begin_layout Plain Layout
7937 extension—cannot be used with this document class.
7938 This might be used in a journal-specific layout file to prevent, say, the
7940 \begin_inset Flex CharStyle:Code
7943 \begin_layout Plain Layout
7949 module that numbers theorems by section.
7954 be used in a module.
7955 Modules have their own way of excluding other modules (see
7956 \begin_inset CommandInset ref
7958 reference "sub:Layout-modules"
7965 \begin_layout Description
7966 \begin_inset Flex CharStyle:Code
7969 \begin_layout Plain Layout
7975 Defines a new float.
7977 \begin_inset space ~
7981 \begin_inset CommandInset ref
7983 reference "sub:Floats"
7989 \begin_inset Quotes eld
7993 \begin_inset Flex CharStyle:Code
7996 \begin_layout Plain Layout
8003 \begin_inset Quotes erd
8009 \begin_layout Description
8010 \begin_inset Flex CharStyle:Code
8013 \begin_layout Plain Layout
8019 Sets the information that will be output in the
8020 \begin_inset Flex CharStyle:Code
8023 \begin_layout Plain Layout
8029 block when this document class is output to XHTML.
8030 Note that this will completely override any prior
8031 \begin_inset Flex CharStyle:Code
8034 \begin_layout Plain Layout
8041 \begin_inset Flex CharStyle:Code
8044 \begin_layout Plain Layout
8052 \begin_inset Flex CharStyle:Code
8055 \begin_layout Plain Layout
8061 if you just want to add material to the preamble.) Must end with
8062 \begin_inset Quotes eld
8066 \begin_inset Flex CharStyle:Code
8069 \begin_layout Plain Layout
8076 \begin_inset Quotes erd
8082 \begin_layout Description
8083 \begin_inset Flex CharStyle:Code
8086 \begin_layout Plain Layout
8093 \begin_inset Flex CharStyle:Code
8096 \begin_layout Plain Layout
8102 ] The layout to use for the table of contents, bibliography, and so forth,
8103 when the document is output to HTML.
8104 For articles, this should normally be Section; for books, Chapter.
8105 If it is not given, then LyX will attempt to figure out which layout to
8109 \begin_layout Description
8110 \begin_inset Flex CharStyle:Code
8113 \begin_layout Plain Layout
8120 \begin_inset Flex CharStyle:Code
8123 \begin_layout Plain Layout
8129 ] Modifies the properties of the given counter.
8130 If the counter does not exist, the section is ignored.
8132 \begin_inset Quotes eld
8136 \begin_inset Flex CharStyle:Code
8139 \begin_layout Plain Layout
8146 \begin_inset Quotes erd
8150 \begin_inset Newline newline
8154 \begin_inset space ~
8158 \begin_inset CommandInset ref
8160 reference "sub:Counters"
8164 for details on counters.
8167 \begin_layout Description
8168 \begin_inset Flex CharStyle:Code
8171 \begin_layout Plain Layout
8178 \begin_inset Flex CharStyle:Code
8181 \begin_layout Plain Layout
8187 ] Modifies the properties of the given paragraph style.
8188 If the style does not exist, the section is ignored.
8190 \begin_inset Quotes eld
8194 \begin_inset Flex CharStyle:Code
8197 \begin_layout Plain Layout
8204 \begin_inset Quotes erd
8210 \begin_layout Description
8211 \begin_inset Flex CharStyle:Code
8214 \begin_layout Plain Layout
8220 As its name implies, this command allows you to include another layout
8221 definition file within yours to avoid duplicating commands.
8222 Common examples are the standard layout files, for example,
8223 \begin_inset Flex CharStyle:Code
8226 \begin_layout Plain Layout
8232 , which contains most of the basic layouts.
8235 \begin_layout Description
8236 \begin_inset Flex CharStyle:Code
8239 \begin_layout Plain Layout
8245 This section (re-)defines the layout of an inset.
8246 It can be applied to an existing inset or to a new, user-defined inset,
8247 e.g., a new character style.
8249 \begin_inset Quotes eld
8253 \begin_inset Flex CharStyle:Code
8256 \begin_layout Plain Layout
8263 \begin_inset Quotes erd
8267 \begin_inset Newline newline
8271 \begin_inset space ~
8275 \begin_inset CommandInset ref
8277 reference "sub:Flex-insets-and"
8281 for more information.
8285 \begin_layout Description
8286 \begin_inset Flex CharStyle:Code
8289 \begin_layout Plain Layout
8296 \begin_inset Flex CharStyle:Code
8299 \begin_layout Plain Layout
8305 ] A string that indicates the width of the left margin on the screen, for
8307 \begin_inset Quotes eld
8311 \begin_inset Quotes erd
8315 (Note that this is not a `length', like
8316 \begin_inset Quotes eld
8320 \begin_inset Quotes erd
8326 \begin_layout Description
8327 \begin_inset Flex CharStyle:Code
8330 \begin_layout Plain Layout
8336 This command deletes an existing float.
8337 This is particularly useful when you want to suppress a float that has
8338 been defined in an input file.
8341 \begin_layout Description
8342 \begin_inset Flex CharStyle:Code
8345 \begin_layout Plain Layout
8351 This command deletes an existing style.
8352 This is particularly useful when you want to suppress a style that has
8353 be defined in an input file.
8356 \begin_layout Description
8357 \begin_inset Flex CharStyle:Code
8360 \begin_layout Plain Layout
8366 A string indicating the file format (as defined in the Preferences dialog)
8367 produced by this class.
8368 It is mainly useful when
8369 \begin_inset Flex CharStyle:Code
8372 \begin_layout Plain Layout
8378 is `literate' and one wants to define a new type of literate document.
8379 This string is reset to `docbook', `latex', or `literate' when the correspondin
8381 \begin_inset Flex CharStyle:Code
8384 \begin_layout Plain Layout
8390 parameter is encountered.
8393 \begin_layout Description
8394 \begin_inset Flex CharStyle:Code
8397 \begin_layout Plain Layout
8403 A string indicating what sort of output documents using this class will
8405 At present, the options are: `docbook', `latex', and `literate'.
8408 \begin_layout Description
8409 \begin_inset Flex CharStyle:Code
8412 \begin_layout Plain Layout
8419 \begin_inset Flex CharStyle:Code
8422 \begin_layout Plain Layout
8431 \begin_inset Flex CharStyle:Code
8434 \begin_layout Plain Layout
8441 \begin_inset Flex CharStyle:Code
8444 \begin_layout Plain Layout
8450 ] The default pagestyle.
8451 Can be changed in the
8452 \begin_inset Flex CharStyle:MenuItem
8455 \begin_layout Plain Layout
8456 Document\SpecialChar \menuseparator
8465 \begin_layout Description
8466 \begin_inset Flex CharStyle:Code
8469 \begin_layout Plain Layout
8475 Sets the preamble for the LaTeX document.
8476 Note that this will completely override any prior
8477 \begin_inset Flex CharStyle:Code
8480 \begin_layout Plain Layout
8487 \begin_inset Flex CharStyle:Code
8490 \begin_layout Plain Layout
8498 \begin_inset Flex CharStyle:Code
8501 \begin_layout Plain Layout
8507 if you just want to add material to the preamble.) Must end with
8508 \begin_inset Quotes eld
8512 \begin_inset Flex CharStyle:Code
8515 \begin_layout Plain Layout
8522 \begin_inset Quotes erd
8528 \begin_layout Description
8529 \begin_inset Flex CharStyle:Code
8532 \begin_layout Plain Layout
8539 \begin_inset Flex CharStyle:Code
8542 \begin_layout Plain Layout
8549 \begin_inset Flex CharStyle:Code
8552 \begin_layout Plain Layout
8561 \begin_inset Flex CharStyle:Code
8564 \begin_layout Plain Layout
8570 ] Whether the class already provides the feature
8571 \begin_inset Flex CharStyle:Code
8574 \begin_layout Plain Layout
8581 A feature is in general the name of a package (
8582 \begin_inset Flex CharStyle:Code
8585 \begin_layout Plain Layout
8592 \begin_inset Flex CharStyle:Code
8595 \begin_layout Plain Layout
8601 , \SpecialChar \ldots{}
8603 \begin_inset Flex CharStyle:Code
8606 \begin_layout Plain Layout
8613 \begin_inset Flex CharStyle:Code
8616 \begin_layout Plain Layout
8622 ,\SpecialChar \ldots{}
8623 ); the complete list of supported features is unfortunately not documented
8624 outside the LyX source code—but see
8625 \begin_inset Flex CharStyle:Code
8628 \begin_layout Plain Layout
8634 if you're interested.
8636 \begin_inset Flex CharStyle:MenuItem
8639 \begin_layout Plain Layout
8640 Help\SpecialChar \menuseparator
8646 also gives an overview of the supported packages.
8649 \begin_layout Description
8650 \begin_inset Flex CharStyle:Code
8653 \begin_layout Plain Layout
8660 \begin_inset Flex CharStyle:Code
8663 \begin_layout Plain Layout
8669 ] Indicates that this layout provides the functionality of the module mentioned,
8670 which should be specified by the filename without the
8671 \begin_inset Flex CharStyle:Code
8674 \begin_layout Plain Layout
8681 This will typically be used if the layout includes the module directly,
8682 rather than using the
8683 \begin_inset Flex CharStyle:Code
8686 \begin_layout Plain Layout
8692 tag to indicate that it ought to be used.
8693 It could also be used in a module that provided an alternate implementation
8694 of the same functionality.
8697 \begin_layout Description
8698 \begin_inset Flex CharStyle:Code
8701 \begin_layout Plain Layout
8708 \begin_inset Flex CharStyle:Code
8711 \begin_layout Plain Layout
8717 ] Whether the class requires the feature
8718 \begin_inset Flex CharStyle:Code
8721 \begin_layout Plain Layout
8728 Multiple features must be separated by commas.
8729 Note that you can only request supported features.
8731 \begin_inset Flex CharStyle:Code
8734 \begin_layout Plain Layout
8740 for a list of these.)
8743 \begin_layout Description
8744 \begin_inset Flex CharStyle:Code
8747 \begin_layout Plain Layout
8753 A string that indicates the width of the right margin on the screen, for
8755 \begin_inset Quotes eld
8759 \begin_inset Quotes erd
8765 \begin_layout Description
8766 \begin_inset Flex CharStyle:Code
8769 \begin_layout Plain Layout
8775 Sets which divisions get numbered.
8777 \begin_inset Flex CharStyle:Code
8780 \begin_layout Plain Layout
8789 \begin_layout Description
8790 \begin_inset Flex CharStyle:Code
8793 \begin_layout Plain Layout
8800 \begin_inset Flex CharStyle:Code
8803 \begin_layout Plain Layout
8812 \begin_inset Flex CharStyle:Code
8815 \begin_layout Plain Layout
8821 ] Whether the class-default should be printing on one or both sides of the
8823 Can be changed in the
8824 \begin_inset Flex CharStyle:MenuItem
8827 \begin_layout Plain Layout
8828 Document\SpecialChar \menuseparator
8837 \begin_layout Description
8838 \begin_inset Flex CharStyle:Code
8841 \begin_layout Plain Layout
8847 This sequence defines a paragraph style.
8848 If the style does not yet exist, it is created; if it does exist, its parameter
8851 \begin_inset Quotes eld
8855 \begin_inset Flex CharStyle:Code
8858 \begin_layout Plain Layout
8865 \begin_inset Quotes erd
8869 \begin_inset Newline newline
8873 \begin_inset space ~
8877 \begin_inset CommandInset ref
8879 reference "sub:Paragraph-Styles"
8883 for details on paragraph styles.
8886 \begin_layout Description
8887 \begin_inset Flex CharStyle:Code
8890 \begin_layout Plain Layout
8897 \begin_inset Flex CharStyle:Code
8900 \begin_layout Plain Layout
8906 ] The name of the command or environment to be used with
8907 \begin_inset Flex CharStyle:Code
8910 \begin_layout Plain Layout
8919 \begin_layout Description
8920 \begin_inset Flex CharStyle:Code
8923 \begin_layout Plain Layout
8930 \begin_inset Flex CharStyle:Code
8933 \begin_layout Plain Layout
8942 \begin_inset Flex CharStyle:Code
8945 \begin_layout Plain Layout
8951 ] Indicates what kind of markup is used to define the title of a document.
8953 \begin_inset Flex CharStyle:Code
8956 \begin_layout Plain Layout
8962 means that the macro with name
8963 \begin_inset Flex CharStyle:Code
8966 \begin_layout Plain Layout
8972 will be inserted after the last layout which has
8973 \begin_inset Quotes eld
8977 \begin_inset Flex CharStyle:Code
8980 \begin_layout Plain Layout
8987 \begin_inset Quotes erd
8992 \begin_inset Flex CharStyle:Code
8995 \begin_layout Plain Layout
9001 corresponds to the case where the block of paragraphs which have
9002 \begin_inset Quotes eld
9006 \begin_inset Flex CharStyle:Code
9009 \begin_layout Plain Layout
9016 \begin_inset Quotes erd
9019 should be enclosed into the
9020 \begin_inset Flex CharStyle:Code
9023 \begin_layout Plain Layout
9032 \begin_layout Description
9033 \begin_inset Flex CharStyle:Code
9036 \begin_layout Plain Layout
9042 Sets which divisions are included in the table of contents.
9044 \begin_inset Flex CharStyle:Code
9047 \begin_layout Plain Layout
9056 \begin_layout Subsection
9057 \begin_inset Flex CharStyle:Code
9060 \begin_layout Plain Layout
9067 \begin_inset CommandInset label
9069 name "sub:ClassOptions"
9076 \begin_layout Standard
9078 \begin_inset Flex CharStyle:Code
9081 \begin_layout Plain Layout
9087 section can contain the following entries:
9090 \begin_layout Description
9091 \begin_inset Flex CharStyle:Code
9094 \begin_layout Plain Layout
9101 \begin_inset Flex CharStyle:Code
9104 \begin_layout Plain Layout
9110 ] The list of available font sizes for the document's main font, separated
9112 \begin_inset Quotes eld
9116 \begin_inset Flex CharStyle:Code
9119 \begin_layout Plain Layout
9126 \begin_inset Quotes erd
9132 \begin_layout Description
9133 \begin_inset Flex CharStyle:Code
9136 \begin_layout Plain Layout
9142 Used to set the DTD line with XML-based output classes.
9144 \begin_inset space \thinspace{}
9148 \begin_inset Quotes eld
9151 -//OASIS//DTD DocBook V4.2//EN
9152 \begin_inset Quotes erd
9158 \begin_layout Description
9159 \begin_inset Flex CharStyle:Code
9162 \begin_layout Plain Layout
9169 \begin_inset Flex CharStyle:Code
9172 \begin_layout Plain Layout
9173 string="empty|plain|headings|fancy"
9178 ] The list of available page styles, separated by
9179 \begin_inset Quotes eld
9183 \begin_inset Flex CharStyle:Code
9186 \begin_layout Plain Layout
9193 \begin_inset Quotes erd
9199 \begin_layout Description
9200 \begin_inset Flex CharStyle:Code
9203 \begin_layout Plain Layout
9210 \begin_inset Flex CharStyle:Code
9213 \begin_layout Plain Layout
9219 ] Some document class options, separated by a comma, that will be added
9220 to the optional part of the
9221 \begin_inset Flex CharStyle:Code
9224 \begin_layout Plain Layout
9235 \begin_layout Standard
9237 \begin_inset Flex CharStyle:Code
9240 \begin_layout Plain Layout
9246 section must end with
9247 \begin_inset Quotes eld
9251 \begin_inset Flex CharStyle:Code
9254 \begin_layout Plain Layout
9261 \begin_inset Quotes erd
9267 \begin_layout Subsection
9269 \begin_inset CommandInset label
9271 name "sub:Paragraph-Styles"
9278 \begin_layout Standard
9279 A paragraph style description looks like this:
9283 \begin_layout Plain Layout
9284 Note that this will either define a new layout or modify an existing one.
9292 \begin_layout LyX-Code
9299 \begin_layout LyX-Code
9303 \begin_layout LyX-Code
9307 \begin_layout Standard
9308 where the following commands are allowed:
9311 \begin_layout Description
9312 \begin_inset Flex CharStyle:Code
9315 \begin_layout Plain Layout
9322 \begin_inset Flex CharStyle:Code
9325 \begin_layout Plain Layout
9330 , left, right, center
9335 ] Paragraph alignment.
9338 \begin_layout Description
9339 \begin_inset Flex CharStyle:Code
9342 \begin_layout Plain Layout
9349 \begin_inset Flex CharStyle:Code
9352 \begin_layout Plain Layout
9357 , left, right, center
9362 ] A comma separated list of permitted alignments.
9363 (Some LaTeX styles prohibit certain alignments, since those wouldn't make
9365 For example a right-aligned or centered enumeration isn't possible.)
9368 \begin_layout Description
9369 \begin_inset Flex CharStyle:Code
9372 \begin_layout Plain Layout
9378 Language dependent information to be included in the LaTeX preamble when
9380 Note that this will completely override any prior
9381 \begin_inset Flex CharStyle:Code
9384 \begin_layout Plain Layout
9392 \begin_inset Quotes eld
9396 \begin_inset Flex CharStyle:Code
9399 \begin_layout Plain Layout
9406 \begin_inset Quotes erd
9410 The contents of this tag will occur once in the LaTeX preamble for each
9411 language used by the document.
9412 Each time, the following substitutions are made:
9416 \begin_layout Itemize
9417 \begin_inset Flex CharStyle:Code
9420 \begin_layout Plain Layout
9426 is replaced by the language name (as used by the babel package).
9429 \begin_layout Itemize
9431 \begin_inset Quotes eld
9435 \begin_inset Quotes erd
9439 \begin_inset Flex CharStyle:Code
9442 \begin_layout Plain Layout
9448 replaces its argument by the translation of the argument to the current
9452 \begin_layout Standard
9453 This preamble snippet will only be used if the document contains more than
9454 one language and the babel package is used.
9458 \begin_layout Description
9459 \begin_inset Flex CharStyle:Code
9462 \begin_layout Plain Layout
9469 \begin_inset Flex CharStyle:Code
9472 \begin_layout Plain Layout
9482 \begin_layout Plain Layout
9483 Note that a `float' here is a real number, such as: 1.5.
9488 The vertical space with which the last of a chain of paragraphs with this
9489 layout is separated from the following paragraph.
9490 If the next paragraph has another layout, the separations are not simply
9491 added, but the maximum is taken.
9494 \begin_layout Description
9495 \begin_inset Flex CharStyle:Code
9498 \begin_layout Plain Layout
9505 \begin_inset Flex CharStyle:Code
9508 \begin_layout Plain Layout
9514 The category for this style.
9515 This is used to group related styles in the Layout combobox on the toolbar.
9516 Any string can be used, but you may want to use existing categories with
9521 \begin_layout Description
9522 \begin_inset Flex CharStyle:Code
9525 \begin_layout Plain Layout
9531 Depth of XML command.
9532 Used only with XML-type formats.
9535 \begin_layout Description
9536 \begin_inset Flex CharStyle:Code
9539 \begin_layout Plain Layout
9546 \begin_inset CommandInset label
9548 name "des:CopyStyle"
9553 \begin_inset Flex CharStyle:Code
9556 \begin_layout Plain Layout
9562 Copies all the features of an existing style into the current one.
9566 \begin_layout Description
9567 \begin_inset Flex CharStyle:Code
9570 \begin_layout Plain Layout
9576 The name of a style whose preamble should be output
9581 This allows to ensure some ordering of the preamble snippets when macros
9582 definitions depend on one another.
9586 \begin_layout Plain Layout
9587 Note that, besides that functionality, there is no way to ensure any ordering
9589 The ordering that you see in a given version of LyX may change without
9590 warning in later versions.
9598 \begin_layout Description
9599 \begin_inset Flex CharStyle:Code
9602 \begin_layout Plain Layout
9609 \begin_inset Flex CharStyle:Code
9612 \begin_layout Plain Layout
9617 , Box, Filled_Box, Static
9622 ] The type of label that stands at the end of the paragraph (or sequence
9624 \begin_inset Flex CharStyle:Code
9627 \begin_layout Plain Layout
9634 \begin_inset Flex CharStyle:Code
9637 \begin_layout Plain Layout
9644 \begin_inset Flex CharStyle:Code
9647 \begin_layout Plain Layout
9654 \begin_inset Flex CharStyle:Code
9657 \begin_layout Plain Layout
9665 \begin_inset Flex CharStyle:Code
9668 \begin_layout Plain Layout
9675 \begin_inset Quotes eld
9679 \begin_inset Quotes erd
9683 \begin_inset Flex CharStyle:Code
9686 \begin_layout Plain Layout
9693 \begin_inset Flex CharStyle:Code
9696 \begin_layout Plain Layout
9697 \begin_inset space ~
9706 \begin_inset space ~
9709 black) square suitable for end of proof markers,
9710 \begin_inset Flex CharStyle:Code
9713 \begin_layout Plain Layout
9719 is an explicit text string.
9722 \begin_layout Description
9723 \begin_inset Flex CharStyle:Code
9726 \begin_layout Plain Layout
9733 \begin_inset Flex CharStyle:Code
9736 \begin_layout Plain Layout
9742 ] The string used for a label with a
9743 \begin_inset Flex CharStyle:Code
9746 \begin_layout Plain Layout
9753 \begin_inset Flex CharStyle:Code
9756 \begin_layout Plain Layout
9766 \begin_layout Description
9767 \begin_inset Flex CharStyle:Code
9770 \begin_layout Plain Layout
9777 \begin_inset Flex CharStyle:Code
9780 \begin_layout Plain Layout
9791 \begin_inset Flex CharStyle:Code
9794 \begin_layout Plain Layout
9803 \begin_layout Description
9804 \begin_inset Flex CharStyle:Code
9807 \begin_layout Plain Layout
9814 \begin_inset Flex CharStyle:Code
9817 \begin_layout Plain Layout
9827 ] With this parameter the
9828 \begin_inset Flex CharStyle:MenuItem
9831 \begin_layout Plain Layout
9838 \begin_inset Quotes eld
9841 Vertical space above
9842 \begin_inset Quotes erd
9846 \begin_inset Flex CharStyle:MenuItem
9849 \begin_layout Plain Layout
9850 Edit\SpecialChar \menuseparator
9852 \begin_inset space ~
9860 dialog can be set when initializing a paragraph with this style.
9864 \begin_layout Plain Layout
9867 Note from Jean-Marc:
9869 I'm not sure that this setting has much use, and it should probably be
9870 removed in later versions.
9878 \begin_layout Description
9879 \begin_inset Flex CharStyle:Code
9882 \begin_layout Plain Layout
9888 The font used for both the text body
9894 \begin_inset space ~
9898 \begin_inset CommandInset ref
9900 reference "sub:Font-description"
9905 Note that defining this font automatically defines the
9906 \begin_inset Flex CharStyle:Code
9909 \begin_layout Plain Layout
9916 So you should define this one first if you also want to define
9917 \begin_inset Flex CharStyle:Code
9920 \begin_layout Plain Layout
9929 \begin_layout Description
9930 \begin_inset Flex CharStyle:Code
9933 \begin_layout Plain Layout
9940 \begin_inset CommandInset label
9942 name "des:FreeSpacing"
9947 \begin_inset Flex CharStyle:Code
9950 \begin_layout Plain Layout
9959 \begin_inset Flex CharStyle:Code
9962 \begin_layout Plain Layout
9968 ] Usually LyX doesn't allow you to insert more than one space between words,
9969 since a space is considered as the separation between two words, not a
9970 character or symbol of its own.
9971 This is a very fine thing but sometimes annoying, for example, when typing
9972 program code or plain LaTeX code.
9974 \begin_inset Flex CharStyle:Code
9977 \begin_layout Plain Layout
9984 Note that LyX will create protected blanks for the additional blanks when
9985 in another mode than LaTeX-mode.
9988 \begin_layout Description
9989 \begin_inset Flex CharStyle:Code
9992 \begin_layout Plain Layout
9998 These tags are used with XHTML output.
10000 \begin_inset CommandInset ref
10001 LatexCommand prettyref
10002 reference "sub:Paragraph-Style-XHTML"
10009 \begin_layout Description
10010 \begin_inset Flex CharStyle:Code
10013 \begin_layout Plain Layout
10019 [[FIXME]] (Used only with XML-type formats.)
10022 \begin_layout Description
10023 \begin_inset Flex CharStyle:Code
10026 \begin_layout Plain Layout
10033 \begin_inset Flex CharStyle:Code
10036 \begin_layout Plain Layout
10042 If 1, marks the layout as to be included in the document preamble rather
10043 than in the document body.
10044 This is useful for document classes that want such information as the title
10045 and author to appear in the preamble.
10048 \begin_layout Description
10049 \begin_inset Flex CharStyle:Code
10052 \begin_layout Plain Layout
10059 \begin_inset Flex CharStyle:Code
10062 \begin_layout Plain Layout
10068 If 1, marks the layout as being part of a title block (see also the
10069 \begin_inset Flex CharStyle:Code
10072 \begin_layout Plain Layout
10079 \begin_inset Flex CharStyle:Code
10082 \begin_layout Plain Layout
10091 \begin_layout Description
10092 \begin_inset Flex CharStyle:Code
10095 \begin_layout Plain Layout
10102 \begin_inset Flex CharStyle:Code
10105 \begin_layout Plain Layout
10111 ] This provides extra space between paragraphs that have the same layout.
10112 If you put other layouts into an environment, each is separated with the
10114 \begin_inset Flex CharStyle:Code
10117 \begin_layout Plain Layout
10124 But the whole items of the environment are additionally separated with
10126 \begin_inset Flex CharStyle:Code
10129 \begin_layout Plain Layout
10136 Note that this is a
10141 \begin_layout Description
10142 \begin_inset Flex CharStyle:Code
10145 \begin_layout Plain Layout
10151 [[FIXME]] (Used only with XML-type formats.)
10154 \begin_layout Description
10155 \begin_inset Flex CharStyle:Code
10158 \begin_layout Plain Layout
10165 \begin_inset CommandInset label
10167 name "des:KeepEmpty"
10172 \begin_inset Flex CharStyle:Code
10175 \begin_layout Plain Layout
10184 \begin_inset Flex CharStyle:Code
10187 \begin_layout Plain Layout
10193 ] Usually LyX does not allow you to leave a paragraph empty, since it would
10194 lead to empty LaTeX output.
10195 There are some cases where this could be desirable however: in a letter
10196 template, the required fields can be provided as empty fields, so that
10197 people do not forget them; in some special classes, a layout can be used
10198 as some kind of break, which does not contain actual text.
10201 \begin_layout Description
10202 \begin_inset Flex CharStyle:Code
10205 \begin_layout Plain Layout
10211 [float=0] The vertical space between the label and the text body.
10212 Only used for labels that are above the text body (
10213 \begin_inset Flex CharStyle:Code
10216 \begin_layout Plain Layout
10223 \begin_inset Flex CharStyle:Code
10226 \begin_layout Plain Layout
10227 Centered_Top_Environment
10235 \begin_layout Description
10236 \begin_inset Flex CharStyle:Code
10239 \begin_layout Plain Layout
10246 \begin_inset Flex CharStyle:Code
10249 \begin_layout Plain Layout
10256 \begin_inset Newline newline
10259 The name of the counter for automatic numbering.
10261 \begin_inset Newline newline
10269 \begin_inset Flex CharStyle:Code
10272 \begin_layout Plain Layout
10279 \begin_inset Flex CharStyle:Code
10282 \begin_layout Plain Layout
10289 In that case, the counter will be stepped each time the layout appears.
10291 \begin_inset Newline newline
10299 \begin_inset Flex CharStyle:Code
10302 \begin_layout Plain Layout
10309 \begin_inset Flex CharStyle:Code
10312 \begin_layout Plain Layout
10318 , though this case is a bit complicated.
10319 Suppose you declare
10320 \begin_inset Quotes eld
10324 \begin_inset Flex CharStyle:Code
10327 \begin_layout Plain Layout
10328 LabelCounter myenum
10334 \begin_inset Quotes erd
10338 Then the actual counters used are
10339 \begin_inset Flex CharStyle:Code
10342 \begin_layout Plain Layout
10349 \begin_inset Flex CharStyle:Code
10352 \begin_layout Plain Layout
10359 \begin_inset Flex CharStyle:Code
10362 \begin_layout Plain Layout
10369 \begin_inset Flex CharStyle:Code
10372 \begin_layout Plain Layout
10378 , much as in LaTeX.
10379 These counters must all be declared separately.
10380 \begin_inset Newline newline
10384 \begin_inset CommandInset ref
10386 reference "sub:Counters"
10390 for details on counters.
10393 \begin_layout Description
10394 \begin_inset Flex CharStyle:Code
10397 \begin_layout Plain Layout
10403 The font used for the label.
10405 \begin_inset space ~
10409 \begin_inset CommandInset ref
10411 reference "sub:Font-description"
10418 \begin_layout Description
10419 \begin_inset Flex CharStyle:Code
10422 \begin_layout Plain Layout
10428 Text that indicates how far a label should be indented.
10431 \begin_layout Description
10432 \begin_inset Flex CharStyle:Code
10435 \begin_layout Plain Layout
10442 \begin_inset Flex CharStyle:Code
10445 \begin_layout Plain Layout
10451 ] The horizontal space between the label and the text body.
10452 Only used for labels that are not above the text body.
10455 \begin_layout Description
10456 \begin_inset Flex CharStyle:Code
10459 \begin_layout Plain Layout
10466 \begin_inset Flex CharStyle:Code
10469 \begin_layout Plain Layout
10475 ] The string used for a label with a
10476 \begin_inset Flex CharStyle:Code
10479 \begin_layout Plain Layout
10487 \begin_inset Flex CharStyle:Code
10490 \begin_layout Plain Layout
10496 is set, this string can be contain the special formatting commands described
10498 \begin_inset CommandInset ref
10500 reference "sub:Counters"
10508 \begin_layout Plain Layout
10509 For the sake of backwards compatibility, the string
10510 \begin_inset Flex CharStyle:Code
10513 \begin_layout Plain Layout
10523 will be replaced by the expanded
10524 \begin_inset Flex CharStyle:Code
10527 \begin_layout Plain Layout
10534 \begin_inset Flex CharStyle:Code
10537 \begin_layout Plain Layout
10546 This feature is now obsolete and should be replaced by the mechanisms of
10548 \begin_inset CommandInset ref
10550 reference "sub:Counters"
10562 \begin_layout Description
10563 \begin_inset Flex CharStyle:Code
10566 \begin_layout Plain Layout
10567 LabelStringAppendix
10573 \begin_inset Flex CharStyle:Code
10576 \begin_layout Plain Layout
10582 ] This is used inside the appendix instead of
10583 \begin_inset Flex CharStyle:Code
10586 \begin_layout Plain Layout
10594 \begin_inset Flex CharStyle:Code
10597 \begin_layout Plain Layout
10604 \begin_inset Flex CharStyle:Code
10607 \begin_layout Plain Layout
10608 LabelStringAppendix
10616 \begin_layout Description
10617 \begin_inset Flex CharStyle:Code
10620 \begin_layout Plain Layout
10626 [FIXME] (Used only with XML-type formats.)
10629 \begin_layout Description
10630 \begin_inset Flex CharStyle:Code
10633 \begin_layout Plain Layout
10640 \begin_inset Flex CharStyle:Code
10643 \begin_layout Plain Layout
10648 , Manual, Static, Top_Environment, Centered_Top_Environment, Counter, Sensitive,
10649 Enumerate, Itemize, Bibliography
10658 \begin_layout Itemize
10659 \begin_inset Flex CharStyle:Code
10662 \begin_layout Plain Layout
10668 means the label is the very first word (up to the first real blank).
10669 Use protected spaces (like
10670 \begin_inset space ~
10673 that one) if you want more than one word as the label.
10677 \begin_layout Itemize
10678 \begin_inset Flex CharStyle:Code
10681 \begin_layout Plain Layout
10687 means the label is simply whatever
10688 \begin_inset Flex CharStyle:Code
10691 \begin_layout Plain Layout
10698 Note that this really is `static'.
10701 \begin_layout Itemize
10702 \begin_inset Flex CharStyle:Code
10705 \begin_layout Plain Layout
10712 \begin_inset Flex CharStyle:Code
10715 \begin_layout Plain Layout
10716 Centered_Top_Environment
10721 are special cases of
10722 \begin_inset Flex CharStyle:Code
10725 \begin_layout Plain Layout
10732 The label will be printed above the paragraph, but only at the top of an
10733 environment or the top of a chain of paragraphs with this layout.
10734 This might be used with the
10735 \begin_inset Flex CharStyle:MenuItem
10738 \begin_layout Plain Layout
10744 layout, for example.
10747 \begin_layout Itemize
10748 \begin_inset Flex CharStyle:Code
10751 \begin_layout Plain Layout
10757 is a special case for the caption-labels
10758 \begin_inset Quotes eld
10762 \begin_inset Quotes erd
10766 \begin_inset Quotes eld
10770 \begin_inset Quotes erd
10775 \begin_inset Flex CharStyle:Code
10778 \begin_layout Plain Layout
10784 means the (hardcoded) label string depends on the kind of float: It is
10785 hardcoded to be `FloatType N', where N is the value of the counter associated
10789 \begin_layout Itemize
10791 \begin_inset Flex CharStyle:Code
10794 \begin_layout Plain Layout
10800 label type defines automatically numbered labels.
10802 \begin_inset Flex CharStyle:Code
10805 \begin_layout Plain Layout
10811 will be expanded to resolve any counter references it contains: For example,
10813 \begin_inset Quotes eld
10817 \begin_inset Flex CharStyle:Code
10820 \begin_layout Plain Layout
10831 \begin_inset Quotes erd
10836 \begin_inset CommandInset ref
10838 reference "sub:Counters"
10842 for more information on counters.
10845 \begin_layout Itemize
10846 \begin_inset Flex CharStyle:Code
10849 \begin_layout Plain Layout
10855 produces the usual sort of enumeration labels.
10856 At present, it is hardcoded to use Arabic numerals, lowercase letters,
10857 small Roman numerals, and uppercase letters for the four possible depths.
10860 \begin_layout Itemize
10861 \begin_inset Flex CharStyle:Code
10864 \begin_layout Plain Layout
10870 produces various bullets at the different levels.
10871 It is also hardcoded.
10874 \begin_layout Itemize
10875 \begin_inset Flex CharStyle:Code
10878 \begin_layout Plain Layout
10884 is used internally by LyX and should be used only with
10885 \begin_inset Flex CharStyle:Code
10888 \begin_layout Plain Layout
10889 LatexType BibEnvironment
10898 \begin_layout Description
10899 \begin_inset Flex CharStyle:Code
10902 \begin_layout Plain Layout
10909 \begin_inset Flex CharStyle:Code
10912 \begin_layout Plain Layout
10918 , but this preamble snippet occurs independently from the babel package,
10919 and only for the document language.
10921 \begin_inset Quotes eld
10925 \begin_inset Flex CharStyle:Code
10928 \begin_layout Plain Layout
10935 \begin_inset Quotes erd
10942 \begin_layout Standard
10943 If the style defines text that appears in the typeset document, it may use
10945 \begin_inset Flex CharStyle:Code
10948 \begin_layout Plain Layout
10955 \begin_inset Flex CharStyle:Code
10958 \begin_layout Plain Layout
10964 to support non-english and even multilanguage documents correctly.
10965 The following excerpt (from the
10966 \begin_inset Flex CharStyle:Code
10969 \begin_layout Plain Layout
10975 file) shows how this works:
10978 \begin_layout LyX-Code
10982 \begin_layout LyX-Code
10985 theoremstyle{remark}
10988 \begin_layout LyX-Code
10991 newtheorem{claim}[thm]{
10998 \begin_layout LyX-Code
11002 \begin_layout LyX-Code
11006 \begin_layout LyX-Code
11011 claimname}{_(Claim)}
11014 \begin_layout LyX-Code
11018 \begin_layout LyX-Code
11022 \begin_layout LyX-Code
11026 \begin_layout LyX-Code
11035 claimname}{_(Claim)}}
11038 \begin_layout LyX-Code
11042 \begin_layout Standard
11043 The key to correct translation of the user visible text is the definition
11045 \begin_inset Flex CharStyle:Code
11048 \begin_layout Plain Layout
11056 in the language preamble.
11057 This command holds the name of the theorem that will appear in the output.
11059 \begin_inset Flex CharStyle:Code
11062 \begin_layout Plain Layout
11068 then uses the commands offered by the babel package to redefine
11069 \begin_inset Flex CharStyle:Code
11072 \begin_layout Plain Layout
11080 for each used language in multilanguage documents.
11084 \begin_layout Description
11085 \begin_inset Flex CharStyle:Code
11088 \begin_layout Plain Layout
11094 The name of the corresponding LaTeX stuff.
11095 Either the environment or command name.
11098 \begin_layout Description
11099 \begin_inset Flex CharStyle:Code
11102 \begin_layout Plain Layout
11108 An optional parameter for the corresponding
11109 \begin_inset Flex CharStyle:Code
11112 \begin_layout Plain Layout
11119 This parameter cannot be changed from within LyX.
11122 \begin_layout Description
11123 \begin_inset Flex CharStyle:Code
11126 \begin_layout Plain Layout
11133 \begin_inset CommandInset label
11135 name "des:LatexType"
11140 \begin_inset Flex CharStyle:Code
11143 \begin_layout Plain Layout
11148 , Command, Environment, Item_Environment,
11154 \begin_inset Flex CharStyle:Code
11157 \begin_layout Plain Layout
11158 List_Environment, Bib_Environment
11163 ] How the layout should be translated into LaTeX.
11167 \begin_layout Plain Layout
11168 \begin_inset Flex CharStyle:Code
11171 \begin_layout Plain Layout
11177 is perhaps a bit misleading, since these rules apply to SGML classes, too.
11178 Visit the SGML class files for specific examples.
11187 \begin_layout Itemize
11188 \begin_inset Flex CharStyle:Code
11191 \begin_layout Plain Layout
11197 means nothing special.
11201 \begin_layout Itemize
11202 \begin_inset Flex CharStyle:Code
11205 \begin_layout Plain Layout
11212 \begin_inset Flex CharStyle:Code
11215 \begin_layout Plain Layout
11222 {\SpecialChar \ldots{}
11231 \begin_layout Itemize
11232 \begin_inset Flex CharStyle:Code
11235 \begin_layout Plain Layout
11242 \begin_inset Flex CharStyle:Code
11245 \begin_layout Plain Layout
11252 }\SpecialChar \ldots{}
11268 \begin_layout Itemize
11269 \begin_inset Flex CharStyle:Code
11272 \begin_layout Plain Layout
11279 \begin_inset Flex CharStyle:Code
11282 \begin_layout Plain Layout
11289 \begin_inset Flex CharStyle:Code
11292 \begin_layout Plain Layout
11300 is generated for each paragraph of this environment.
11304 \begin_layout Itemize
11305 \begin_inset Flex CharStyle:Code
11308 \begin_layout Plain Layout
11315 \begin_inset Flex CharStyle:Code
11318 \begin_layout Plain Layout
11325 \begin_inset Flex CharStyle:Code
11328 \begin_layout Plain Layout
11334 is passed as an argument to the environment.
11336 \begin_inset Flex CharStyle:Code
11339 \begin_layout Plain Layout
11345 can be defined in the
11346 \begin_inset Flex CharStyle:MenuItem
11349 \begin_layout Plain Layout
11354 ayout\SpecialChar \menuseparator
11368 \begin_layout Standard
11369 Putting the last few things together, the LaTeX output will be either:
11372 \begin_layout LyX-Code
11375 latexname[latexparam]{\SpecialChar \ldots{}
11379 \begin_layout Standard
11383 \begin_layout LyX-Code
11386 begin{latexname}[latexparam] \SpecialChar \ldots{}
11392 \begin_layout Standard
11393 depending upon the LaTeX type.
11397 \begin_layout Description
11398 \begin_inset Flex CharStyle:Code
11401 \begin_layout Plain Layout
11408 \begin_inset Flex CharStyle:Code
11411 \begin_layout Plain Layout
11417 ] If you put layouts into environments, the leftmargins are not simply added,
11418 but added with a factor
11419 \begin_inset Formula $\frac{4}{depth+4}$
11423 Note that this parameter is also used when the margin is defined as
11424 \begin_inset Flex CharStyle:Code
11427 \begin_layout Plain Layout
11434 \begin_inset Flex CharStyle:Code
11437 \begin_layout Plain Layout
11444 Then it is added to the manual or dynamic margin.
11446 \begin_inset Newline newline
11449 The argument is passed as a string.
11451 \begin_inset Quotes eld
11455 \begin_inset Flex CharStyle:Code
11458 \begin_layout Plain Layout
11465 \begin_inset Quotes erd
11468 means that the paragraph is indented with the width of
11469 \begin_inset Quotes eld
11473 \begin_inset Flex CharStyle:Code
11476 \begin_layout Plain Layout
11483 \begin_inset Quotes erd
11486 in the normal font.
11487 You can get a negative width by prefixing the string with
11488 \begin_inset Quotes eld
11492 \begin_inset Flex CharStyle:Code
11495 \begin_layout Plain Layout
11502 \begin_inset Quotes erd
11506 This way was chosen so that the look is the same with each used screen
11511 \begin_layout Description
11512 \begin_inset Flex CharStyle:Code
11515 \begin_layout Plain Layout
11522 \begin_inset Flex CharStyle:Code
11525 \begin_layout Plain Layout
11530 , Manual, Dynamic, First_Dynamic, Right_Address_Box
11536 \begin_inset Newline newline
11539 The kind of margin that the layout has on the left side.
11541 \begin_inset Flex CharStyle:Code
11544 \begin_layout Plain Layout
11550 just means a fixed margin.
11552 \begin_inset Flex CharStyle:Code
11555 \begin_layout Plain Layout
11561 means that the left margin depends on the string entered in the
11562 \begin_inset Flex CharStyle:MenuItem
11565 \begin_layout Plain Layout
11566 Edit\SpecialChar \menuseparator
11568 \begin_inset space ~
11577 This is used to typeset nice lists without tabulators.
11579 \begin_inset Flex CharStyle:Code
11582 \begin_layout Plain Layout
11588 means that the margin depends on the size of the label.
11589 This is used for automatic enumerated headlines.
11590 It is obvious that the headline
11591 \begin_inset Quotes eld
11594 5.4.3.2.1 Very long headline
11595 \begin_inset Quotes erd
11598 must have a wider left margin (as wide as
11599 \begin_inset Quotes eld
11603 \begin_inset Quotes erd
11606 plus the space) than
11607 \begin_inset Quotes eld
11610 3.2 Very long headline
11611 \begin_inset Quotes erd
11615 \begin_inset Quotes eld
11619 \begin_inset Quotes erd
11622 are not able to do this.
11624 \begin_inset Flex CharStyle:Code
11627 \begin_layout Plain Layout
11633 is similar, but only the very first row of the paragraph is dynamic, while
11634 the others are static; this is used, for example, for descriptions.
11636 \begin_inset Flex CharStyle:Code
11639 \begin_layout Plain Layout
11645 means the margin is chosen in a way that the longest row of this paragraph
11646 fits to the right margin.
11647 This is used to typeset an address on the right edge of the page.
11650 \begin_layout Description
11651 \begin_inset Flex CharStyle:Code
11654 \begin_layout Plain Layout
11661 \begin_inset Flex CharStyle:Code
11664 \begin_layout Plain Layout
11673 \begin_inset Flex CharStyle:Code
11676 \begin_layout Plain Layout
11682 ] Whether fragile commands in this layout should be
11683 \begin_inset Flex CharStyle:Code
11686 \begin_layout Plain Layout
11699 whether this command should itself be protected.)
11702 \begin_layout Description
11703 \begin_inset Flex CharStyle:Code
11706 \begin_layout Plain Layout
11713 \begin_inset Flex CharStyle:Code
11716 \begin_layout Plain Layout
11723 \begin_inset Flex CharStyle:Code
11726 \begin_layout Plain Layout
11734 ] Whether newlines are translated into LaTeX newlines (
11735 \begin_inset Flex CharStyle:Code
11738 \begin_layout Plain Layout
11749 The translation can be switched off to allow more comfortable LaTeX editing
11753 \begin_layout Description
11754 \begin_inset Flex CharStyle:Code
11757 \begin_layout Plain Layout
11764 \begin_inset Flex CharStyle:Code
11767 \begin_layout Plain Layout
11774 \begin_inset Flex CharStyle:Code
11777 \begin_layout Plain Layout
11785 ] Whether the following Paragraph is allowed to indent its very first row.
11787 \begin_inset Flex CharStyle:Code
11790 \begin_layout Plain Layout
11796 means that it is not allowed to do so;
11797 \begin_inset Flex CharStyle:Code
11800 \begin_layout Plain Layout
11806 means it could do so if it wants to.
11809 \begin_layout Description
11810 \begin_inset Flex CharStyle:Code
11813 \begin_layout Plain Layout
11819 Name of a layout that has replaced this layout.
11820 This is used to rename a layout, while keeping backward compatibility.
11823 \begin_layout Description
11824 \begin_inset Flex CharStyle:Code
11827 \begin_layout Plain Layout
11834 \begin_inset Flex CharStyle:Code
11837 \begin_layout Plain Layout
11843 ] The number of optional arguments that can be used with this layout.
11844 This is useful for things like section headings, and only makes sense with
11848 \begin_layout Description
11849 \begin_inset Flex CharStyle:Code
11852 \begin_layout Plain Layout
11859 \begin_inset Flex CharStyle:Code
11862 \begin_layout Plain Layout
11868 ] The indent of the very first line of a paragraph.
11870 \begin_inset Flex CharStyle:Code
11873 \begin_layout Plain Layout
11879 will be fixed for a certain layout.
11880 The exception is Standard layout, since the indentation of a Standard layout
11881 paragraph can be prohibited with
11882 \begin_inset Flex CharStyle:Code
11885 \begin_layout Plain Layout
11892 Also, Standard layout paragraphs inside environments use the
11893 \begin_inset Flex CharStyle:Code
11896 \begin_layout Plain Layout
11902 of the environment, not their native one.
11903 For example, Standard paragraphs inside an enumeration are not indented.
11906 \begin_layout Description
11907 \begin_inset Flex CharStyle:Code
11910 \begin_layout Plain Layout
11917 \begin_inset Flex CharStyle:Code
11920 \begin_layout Plain Layout
11926 ] The vertical space between two paragraphs of this layout.
11929 \begin_layout Description
11930 \begin_inset Flex CharStyle:Code
11933 \begin_layout Plain Layout
11940 \begin_inset Flex CharStyle:Code
11943 \begin_layout Plain Layout
11949 ] LyX allows the user to choose either
11950 \begin_inset Quotes eld
11954 \begin_inset Quotes erd
11958 \begin_inset Quotes eld
11962 \begin_inset Quotes erd
11965 to typeset a document.
11967 \begin_inset Quotes eld
11971 \begin_inset Quotes erd
11974 is chosen, this value is completely ignored.
11976 \begin_inset Quotes eld
11980 \begin_inset Quotes erd
11983 is chosen, the parindent of a LaTeXtype
11984 \begin_inset Quotes eld
11988 \begin_inset Quotes erd
11991 layout is ignored and all paragraphs are separated by this parskip argument.
11992 The vertical space is calculated with
11993 \begin_inset Flex CharStyle:Code
11996 \begin_layout Plain Layout
11998 \begin_inset space ~
12007 \begin_inset Flex CharStyle:Code
12010 \begin_layout Plain Layout
12016 is the height of a row with the normal font.
12017 This way, the look stays the same with different screen fonts.
12020 \begin_layout Description
12021 \begin_inset Flex CharStyle:Code
12024 \begin_layout Plain Layout
12031 \begin_inset CommandInset label
12033 name "des:PathThru"
12038 \begin_inset Flex CharStyle:Code
12041 \begin_layout Plain Layout
12050 \begin_inset Flex CharStyle:Code
12053 \begin_layout Plain Layout
12059 ] Whether the contents of this paragraph should be output in raw form, meaning
12060 without special translations that LaTeX would require.
12063 \begin_layout Description
12064 \begin_inset Flex CharStyle:Code
12067 \begin_layout Plain Layout
12074 \begin_inset CommandInset label
12076 name "des:Preamble"
12080 Information to be included in the LaTeX preamble when this style is used.
12081 Used to define macros, load packages, etc., required by this particular
12084 \begin_inset Quotes eld
12088 \begin_inset Flex CharStyle:Code
12091 \begin_layout Plain Layout
12098 \begin_inset Quotes erd
12104 \begin_layout Description
12105 \begin_inset Flex CharStyle:Code
12108 \begin_layout Plain Layout
12115 \begin_inset Flex CharStyle:Code
12118 \begin_layout Plain Layout
12125 \begin_inset CommandInset label
12127 name "des:Requires"
12131 Whether the layout requires the feature
12132 \begin_inset Flex CharStyle:Code
12135 \begin_layout Plain Layout
12142 See the description of
12143 \begin_inset Flex CharStyle:Code
12146 \begin_layout Plain Layout
12153 \begin_inset CommandInset ref
12154 LatexCommand pageref
12155 reference "des:FreeSpacing"
12159 ) for information on `features'.
12163 \begin_layout Description
12164 \begin_inset Flex CharStyle:Code
12167 \begin_layout Plain Layout
12174 \begin_inset Flex CharStyle:Code
12177 \begin_layout Plain Layout
12184 \begin_inset Flex CharStyle:Code
12187 \begin_layout Plain Layout
12196 \begin_layout Description
12197 \begin_inset Flex CharStyle:Code
12200 \begin_layout Plain Layout
12207 \begin_inset Flex CharStyle:Code
12210 \begin_layout Plain Layout
12215 , onehalf, double, other
12224 ] This defines what the default spacing should be in the layout.
12226 \begin_inset Flex CharStyle:Code
12229 \begin_layout Plain Layout
12236 \begin_inset Flex CharStyle:Code
12239 \begin_layout Plain Layout
12246 \begin_inset Flex CharStyle:Code
12249 \begin_layout Plain Layout
12255 correspond respectively to a multiplier value of 1, 1.25 and 1.667.
12256 If you specify the argument
12257 \begin_inset Flex CharStyle:Code
12260 \begin_layout Plain Layout
12266 , then you should also provide a numerical argument which will be the actual
12268 Note that, contrary to other parameters,
12269 \begin_inset Flex CharStyle:Code
12272 \begin_layout Plain Layout
12278 implies the generation of specific LaTeX code, using the package
12281 \begin_inset Flex CharStyle:Code
12284 \begin_layout Plain Layout
12293 \begin_layout Description
12294 \begin_inset Flex CharStyle:Code
12297 \begin_layout Plain Layout
12304 \begin_inset Flex CharStyle:Code
12307 \begin_layout Plain Layout
12314 \begin_inset Flex CharStyle:Code
12317 \begin_layout Plain Layout
12325 ] Spellcheck paragraphs of this style.
12329 \begin_layout Description
12330 \begin_inset Flex CharStyle:Code
12333 \begin_layout Plain Layout
12339 The font used for the text body .
12341 \begin_inset CommandInset ref
12343 reference "sub:Font-description"
12350 \begin_layout Description
12351 \begin_inset Flex CharStyle:Code
12354 \begin_layout Plain Layout
12363 \begin_inset Flex CharStyle:Code
12366 \begin_layout Plain Layout
12376 The level of the style in the table of contents.
12377 This is used for automatic numbering of section headings.
12380 \begin_layout Description
12381 \begin_inset Flex CharStyle:Code
12384 \begin_layout Plain Layout
12391 \begin_inset Flex CharStyle:Code
12394 \begin_layout Plain Layout
12400 ] The vertical space with which the very first of a chain of paragraphs
12401 with this layout is separated from the previous paragraph.
12402 If the previous paragraph has another layout, the separations are not simply
12403 added, but the maximum is taken.
12406 \begin_layout Subsection
12408 \begin_inset CommandInset label
12417 \begin_layout Standard
12418 Since version 1.3.0 of LyX, it is has been both possible and necessary to
12419 define the floats (
12420 \begin_inset Flex CharStyle:MenuItem
12423 \begin_layout Plain Layout
12430 \begin_inset Flex CharStyle:MenuItem
12433 \begin_layout Plain Layout
12439 , \SpecialChar \ldots{}
12440 ) in the text class itself.
12441 Standard floats are included in the file
12442 \begin_inset Flex CharStyle:Code
12445 \begin_layout Plain Layout
12451 , so you may have to do no more than add
12454 \begin_layout LyX-Code
12455 Input stdfloats.inc
12458 \begin_layout Standard
12459 to your layout file.
12460 If you want to implement a text class that proposes some other float types
12461 (like the AGU class bundled with LyX), the information below will hopefully
12465 \begin_layout Description
12466 \begin_inset Flex CharStyle:Code
12469 \begin_layout Plain Layout
12476 \begin_inset Flex CharStyle:Code
12479 \begin_layout Plain Layout
12486 \begin_inset Quotes erd
12490 \begin_inset Quotes erd
12493 ] The file name extension of an auxiliary file for the list of figures (or
12495 LaTeX writes the captions to this file.
12498 \begin_layout Description
12499 \begin_inset Flex CharStyle:Code
12502 \begin_layout Plain Layout
12509 \begin_inset Flex CharStyle:Code
12512 \begin_layout Plain Layout
12519 \begin_inset Quotes erd
12523 \begin_inset Quotes erd
12526 ] The string that will be used in the menus and also for the caption.
12527 This is translated to the current language if babel is used.
12530 \begin_layout Description
12531 \begin_inset Flex CharStyle:Code
12534 \begin_layout Plain Layout
12540 These are used for XHTML output.
12542 \begin_inset CommandInset ref
12544 reference "sec:Tags-for-XHTML"
12551 \begin_layout Description
12552 \begin_inset Flex CharStyle:Code
12555 \begin_layout Plain Layout
12562 \begin_inset Flex CharStyle:Code
12565 \begin_layout Plain Layout
12572 \begin_inset Quotes erd
12576 \begin_inset Quotes erd
12579 ] The command used to generate a list of floats of this type; the leading
12582 ' should be omitted.
12588 \begin_inset Flex CharStyle:Code
12591 \begin_layout Plain Layout
12597 is false, since there is no standard way to generate this command.
12599 \begin_inset Flex CharStyle:Code
12602 \begin_layout Plain Layout
12608 is true, since in that case there is a standard way.
12611 \begin_layout Description
12612 \begin_inset Flex CharStyle:Code
12615 \begin_layout Plain Layout
12622 \begin_inset Flex CharStyle:Code
12625 \begin_layout Plain Layout
12632 \begin_inset Quotes erd
12636 \begin_inset Quotes erd
12639 ] A title for a list of floats of this kind (list of figures, tables, or
12641 It is used for the screen label within LyX; it is passed to LaTeX for use
12642 as the title there; and it is used as the title in XHTML output.
12643 It will be translated to the document language.
12646 \begin_layout Description
12647 \begin_inset Flex CharStyle:Code
12650 \begin_layout Plain Layout
12657 \begin_inset Flex CharStyle:Code
12660 \begin_layout Plain Layout
12667 \begin_inset Flex CharStyle:Code
12670 \begin_layout Plain Layout
12678 ] Indicates whether the float is already defined in the document class or
12679 if we instead need to load
12680 \begin_inset Flex CharStyle:Code
12683 \begin_layout Plain Layout
12689 and use what it provides.
12691 \begin_inset Flex CharStyle:Code
12694 \begin_layout Plain Layout
12701 \begin_inset Flex CharStyle:Code
12704 \begin_layout Plain Layout
12711 It should be set to
12712 \begin_inset Flex CharStyle:Code
12715 \begin_layout Plain Layout
12721 if the float is already defined by the LaTeX document class.
12724 \begin_layout Description
12725 \begin_inset Flex CharStyle:Code
12728 \begin_layout Plain Layout
12735 \begin_inset Flex CharStyle:Code
12738 \begin_layout Plain Layout
12745 \begin_inset Quotes erd
12749 \begin_inset Quotes erd
12752 ] This (optional) argument determines whether floats of this class will
12753 be numbered within some sectional unit of the document.
12754 For example, if within is equal to
12755 \begin_inset Flex CharStyle:Code
12758 \begin_layout Plain Layout
12764 , the floats will be numbered within chapters.
12768 \begin_layout Description
12769 \begin_inset Flex CharStyle:Code
12772 \begin_layout Plain Layout
12779 \begin_inset Flex CharStyle:Code
12782 \begin_layout Plain Layout
12789 \begin_inset Quotes erd
12793 \begin_inset Quotes erd
12796 ] The default placement for the given class of floats.
12797 The string should be as in standard LaTeX:
12798 \begin_inset Flex CharStyle:Code
12801 \begin_layout Plain Layout
12808 \begin_inset Flex CharStyle:Code
12811 \begin_layout Plain Layout
12818 \begin_inset Flex CharStyle:Code
12821 \begin_layout Plain Layout
12828 \begin_inset Flex CharStyle:Code
12831 \begin_layout Plain Layout
12837 for top, bottom, page, and here, respectively.
12841 \begin_layout Plain Layout
12842 Note that the order of these letters in the string is irrelevant, like in
12848 On top of that there is a new type,
12849 \begin_inset Flex CharStyle:Code
12852 \begin_layout Plain Layout
12858 , which does not really correspond to a float, since it means: put it
12859 \begin_inset Quotes eld
12863 \begin_inset Quotes erd
12867 Note however that the
12868 \begin_inset Flex CharStyle:Code
12871 \begin_layout Plain Layout
12877 specifier is special and, because of implementation details, cannot be
12878 used in non-built in float types.
12879 If you do not understand what this means, just use
12880 \begin_inset Quotes eld
12884 \begin_inset Flex CharStyle:Code
12887 \begin_layout Plain Layout
12894 \begin_inset Quotes erd
12900 \begin_layout Description
12901 \begin_inset Flex CharStyle:Code
12904 \begin_layout Plain Layout
12911 \begin_inset Flex CharStyle:Code
12914 \begin_layout Plain Layout
12921 \begin_inset Quotes erd
12925 \begin_inset Quotes erd
12928 ] The style used when defining the float using
12929 \begin_inset Flex CharStyle:Code
12932 \begin_layout Plain Layout
12943 \begin_layout Description
12944 \begin_inset Flex CharStyle:Code
12947 \begin_layout Plain Layout
12954 \begin_inset Flex CharStyle:Code
12957 \begin_layout Plain Layout
12964 \begin_inset Quotes erd
12968 \begin_inset Quotes erd
12972 \begin_inset Quotes eld
12976 \begin_inset Quotes erd
12979 of the new class of floats, like program or algorithm.
12980 After the appropriate
12981 \begin_inset Flex CharStyle:Code
12984 \begin_layout Plain Layout
12993 \begin_inset Flex CharStyle:Code
12996 \begin_layout Plain Layout
13005 \begin_inset Flex CharStyle:Code
13008 \begin_layout Plain Layout
13019 \begin_layout Standard
13020 Note that defining a float with type
13021 \begin_inset Flex CharStyle:Code
13024 \begin_layout Plain Layout
13032 automatically defines the corresponding counter with name
13033 \begin_inset Flex CharStyle:Code
13036 \begin_layout Plain Layout
13047 \begin_layout Subsection
13048 Flex insets and InsetLayout
13049 \begin_inset CommandInset label
13051 name "sub:Flex-insets-and"
13058 \begin_layout Standard
13059 LyX has supported character styles since version 1.4.0; as of version 1.6.0,
13060 these are called Flex insets.
13064 \begin_layout Standard
13065 Flex insets come in three different kinds:
13068 \begin_layout Itemize
13070 \begin_inset Flex CharStyle:Code
13073 \begin_layout Plain Layout
13079 ): These define semantic markup corresponding to such LaTeX commands as
13081 \begin_inset Flex CharStyle:Code
13084 \begin_layout Plain Layout
13093 \begin_inset Flex CharStyle:Code
13096 \begin_layout Plain Layout
13107 \begin_layout Itemize
13109 \begin_inset Flex CharStyle:Code
13112 \begin_layout Plain Layout
13118 ): These can be used to define custom collapsible insets, similar to TeX
13119 code, footnote, and the like.
13120 An obvious example is an endnote inset, which is defined in the
13121 \begin_inset Flex CharStyle:Code
13124 \begin_layout Plain Layout
13133 \begin_layout Itemize
13135 \begin_inset Flex CharStyle:Code
13138 \begin_layout Plain Layout
13144 ): For use with DocBook classes.
13147 \begin_layout Standard
13148 Flex insets are defined using the
13149 \begin_inset Flex CharStyle:Code
13152 \begin_layout Plain Layout
13158 tag, which shall be explained in a moment.
13161 \begin_layout Standard
13163 \begin_inset Flex CharStyle:Code
13166 \begin_layout Plain Layout
13172 tag also serves another function: It can be used to customize the general
13173 layout of many different types of insets.
13175 \begin_inset Flex CharStyle:Code
13178 \begin_layout Plain Layout
13184 can be used to customize the layout parameters for footnotes, marginal
13185 notes, note insets, TeX code (ERT) insets, branches, listings, indexes,
13186 boxes, tables, algorithms, URLs, and optional arguments, as well as to
13187 define Flex insets.
13190 \begin_layout Standard
13192 \begin_inset Flex CharStyle:Code
13195 \begin_layout Plain Layout
13201 definition must begin with a line of the form:
13204 \begin_layout LyX-Code
13208 \begin_layout Standard
13210 \begin_inset Flex CharStyle:Code
13213 \begin_layout Plain Layout
13219 indicates the inset whose layout is being defined, and here there are two
13223 \begin_layout Enumerate
13224 The layout for a pre-existing inset is being modified.
13225 In this case, can be
13226 \begin_inset Flex CharStyle:Code
13229 \begin_layout Plain Layout
13235 any one of the following:
13236 \begin_inset Flex CharStyle:Code
13239 \begin_layout Plain Layout
13246 \begin_inset Flex CharStyle:Code
13249 \begin_layout Plain Layout
13256 \begin_inset Flex CharStyle:Code
13259 \begin_layout Plain Layout
13266 \begin_inset Flex CharStyle:Code
13269 \begin_layout Plain Layout
13276 \begin_inset Flex CharStyle:Code
13279 \begin_layout Plain Layout
13286 \begin_inset Flex CharStyle:Code
13289 \begin_layout Plain Layout
13296 \begin_inset Flex CharStyle:Code
13299 \begin_layout Plain Layout
13306 \begin_inset Flex CharStyle:Code
13309 \begin_layout Plain Layout
13316 \begin_inset Flex CharStyle:Code
13319 \begin_layout Plain Layout
13326 \begin_inset Flex CharStyle:Code
13329 \begin_layout Plain Layout
13336 \begin_inset Flex CharStyle:Code
13339 \begin_layout Plain Layout
13346 \begin_inset Flex CharStyle:Code
13349 \begin_layout Plain Layout
13356 \begin_inset Flex CharStyle:Code
13359 \begin_layout Plain Layout
13366 \begin_inset Flex CharStyle:Code
13369 \begin_layout Plain Layout
13376 \begin_inset Flex CharStyle:Code
13379 \begin_layout Plain Layout
13386 \begin_inset Flex CharStyle:Code
13389 \begin_layout Plain Layout
13396 \begin_inset Flex CharStyle:Code
13399 \begin_layout Plain Layout
13406 \begin_inset Flex CharStyle:Code
13409 \begin_layout Plain Layout
13416 \begin_inset Flex CharStyle:Code
13419 \begin_layout Plain Layout
13426 \begin_inset Flex CharStyle:Code
13429 \begin_layout Plain Layout
13438 \begin_layout Enumerate
13439 The layout for a Flex inset is being defined.
13441 \begin_inset Flex CharStyle:Code
13444 \begin_layout Plain Layout
13450 can be any valid identifier not used by a pre-existing inset.
13451 Note that the definition of a flex inset
13456 \begin_inset Flex CharStyle:Code
13459 \begin_layout Plain Layout
13465 entry, declaring which type of inset this is.
13468 \begin_layout Standard
13470 \begin_inset Flex CharStyle:Code
13473 \begin_layout Plain Layout
13479 definition can contain the following entries:
13482 \begin_layout Description
13483 \begin_inset Flex CharStyle:Code
13486 \begin_layout Plain Layout
13492 The color for the inset's background.
13493 The valid colors are defined in
13494 \begin_inset Flex CharStyle:Code
13497 \begin_layout Plain Layout
13506 \begin_layout Description
13507 \begin_inset Flex CharStyle:Code
13510 \begin_layout Plain Layout
13517 \begin_inset Flex CharStyle:Code
13520 \begin_layout Plain Layout
13529 \begin_inset Flex CharStyle:Code
13532 \begin_layout Plain Layout
13538 ] Whether to use the content of the inset as the label, when the inset is
13543 \begin_layout Description
13544 \begin_inset Flex CharStyle:Code
13547 \begin_layout Plain Layout
13553 As with paragraph styles (see page
13554 \begin_inset CommandInset ref
13556 reference "des:CopyStyle"
13563 \begin_layout Description
13564 \begin_inset Flex CharStyle:Code
13567 \begin_layout Plain Layout
13574 \begin_inset Flex CharStyle:Code
13577 \begin_layout Plain Layout
13586 \begin_inset Flex CharStyle:Code
13589 \begin_layout Plain Layout
13595 ] Indicates whether the user may employ the Paragraph Settings dialog to
13596 customize the paragraph.
13599 \begin_layout Description
13600 \begin_inset Flex CharStyle:Code
13603 \begin_layout Plain Layout
13610 \begin_inset Flex CharStyle:Code
13613 \begin_layout Plain Layout
13620 \begin_inset Flex CharStyle:Code
13623 \begin_layout Plain Layout
13630 \begin_inset Flex CharStyle:Code
13633 \begin_layout Plain Layout
13639 , describing the rendering style used for the inset's frame and buttons.
13640 Footnotes generally use
13641 \begin_inset Flex CharStyle:Code
13644 \begin_layout Plain Layout
13650 , ERT insets generally
13651 \begin_inset Flex CharStyle:Code
13654 \begin_layout Plain Layout
13660 , and character styles
13661 \begin_inset Flex CharStyle:Code
13664 \begin_layout Plain Layout
13673 \begin_layout Description
13674 \begin_inset Flex CharStyle:Code
13677 \begin_layout Plain Layout
13683 Required at the end of the InsetLayout declarations.
13686 \begin_layout Description
13687 \begin_inset Flex CharStyle:Code
13690 \begin_layout Plain Layout
13696 The font used for both the text body
13702 \begin_inset space ~
13706 \begin_inset CommandInset ref
13708 reference "sub:Font-description"
13713 Note that defining this font automatically defines the
13714 \begin_inset Flex CharStyle:Code
13717 \begin_layout Plain Layout
13723 to the same value, so define this first and define
13724 \begin_inset Flex CharStyle:Code
13727 \begin_layout Plain Layout
13733 later if you want them to be different.
13736 \begin_layout Description
13737 \begin_inset Flex CharStyle:Code
13740 \begin_layout Plain Layout
13747 \begin_inset Quotes eld
13751 \begin_inset Quotes erd
13754 language, leading to Left-to-Right (latin) output, e.
13755 \begin_inset space \thinspace{}
13759 \begin_inset space \space{}
13762 in TeX code or URL.
13766 \begin_layout Description
13767 \begin_inset Flex CharStyle:Code
13770 \begin_layout Plain Layout
13777 \begin_inset Flex CharStyle:Code
13780 \begin_layout Plain Layout
13789 \begin_inset Flex CharStyle:Code
13792 \begin_layout Plain Layout
13798 ] Indicates whether the PlainLayout should be used or, instead, the user
13799 can change the paragraph style used in the inset.
13803 \begin_layout Description
13804 \begin_inset Flex CharStyle:Code
13807 \begin_layout Plain Layout
13813 As with paragraph styles (see page
13814 \begin_inset CommandInset ref
13815 LatexCommand pageref
13816 reference "des:FreeSpacing"
13824 \begin_layout Description
13825 \begin_inset Flex CharStyle:Code
13828 \begin_layout Plain Layout
13834 These tags control XHTML output.
13838 \begin_layout Description
13839 \begin_inset Flex CharStyle:Code
13842 \begin_layout Plain Layout
13849 \begin_inset Flex CharStyle:Code
13852 \begin_layout Plain Layout
13861 \begin_inset Flex CharStyle:Code
13864 \begin_layout Plain Layout
13870 ] Whether to include the contents of this inset in the strings generated
13871 for the `Outline' pane.
13872 One would not, for example, want the content of a footnote in a section
13873 header to be included in the TOC displayed in the outline, but one would
13874 normally want the content of a character style displayed.
13875 Default is false: not to include.
13878 \begin_layout Description
13879 \begin_inset Flex CharStyle:Code
13882 \begin_layout Plain Layout
13888 As with paragraph styles (see page
13889 \begin_inset CommandInset ref
13890 LatexCommand pageref
13891 reference "des:KeepEmpty"
13899 \begin_layout Description
13900 \begin_inset Flex CharStyle:Code
13903 \begin_layout Plain Layout
13909 The font used for the label.
13911 \begin_inset space ~
13915 \begin_inset CommandInset ref
13917 reference "sub:Font-description"
13922 Note that this definition can never appear before
13923 \begin_inset Flex CharStyle:Code
13926 \begin_layout Plain Layout
13932 , lest it be ineffective.
13935 \begin_layout Description
13936 \begin_inset Flex CharStyle:Code
13939 \begin_layout Plain Layout
13945 What will be displayed on the button or elsewhere as the inset label.
13946 Some inset types (TeX code and Branch) modify this label on the fly.
13949 \begin_layout Description
13950 \begin_inset Flex CharStyle:Code
13953 \begin_layout Plain Layout
13959 The name of the corresponding LaTeX stuff.
13960 Either the environment or command name.
13963 \begin_layout Description
13964 \begin_inset Flex CharStyle:Code
13967 \begin_layout Plain Layout
13973 The optional parameter for the corresponding
13974 \begin_inset Flex CharStyle:Code
13977 \begin_layout Plain Layout
13983 stuff, including possible bracket pairs like
13984 \begin_inset Flex CharStyle:Code
13987 \begin_layout Plain Layout
13994 This parameter cannot be changed from within LyX.
13997 \begin_layout Description
13998 \begin_inset Flex CharStyle:Code
14001 \begin_layout Plain Layout
14007 As with paragraph styles (see page
14008 \begin_inset CommandInset ref
14009 LatexCommand pageref
14010 reference "des:LatexType"
14017 \begin_layout Description
14018 \begin_inset Flex CharStyle:Code
14021 \begin_layout Plain Layout
14028 \begin_inset Flex CharStyle:Code
14031 \begin_layout Plain Layout
14038 \begin_inset Flex CharStyle:Code
14041 \begin_layout Plain Layout
14048 \begin_inset Flex CharStyle:Code
14051 \begin_layout Plain Layout
14058 \begin_inset Flex CharStyle:Code
14061 \begin_layout Plain Layout
14067 (indicating a dummy definition ending definitions of charstyles, etc).
14068 This entry is required in and is only meaningful for Flex insets.
14069 Among other things, it determines on which menu this inset will appear.
14071 \begin_inset Flex CharStyle:Code
14074 \begin_layout Plain Layout
14081 \begin_inset Flex CharStyle:Code
14084 \begin_layout Plain Layout
14091 \begin_inset Flex CharStyle:Code
14094 \begin_layout Plain Layout
14102 \begin_inset Flex CharStyle:Code
14105 \begin_layout Plain Layout
14111 can be set to true for charstyle insets, if you wish, by setting it
14116 \begin_inset Flex CharStyle:Code
14119 \begin_layout Plain Layout
14128 \begin_layout Description
14129 \begin_inset Flex CharStyle:Code
14132 \begin_layout Plain Layout
14139 \begin_inset Flex CharStyle:Code
14142 \begin_layout Plain Layout
14151 \begin_inset Flex CharStyle:Code
14154 \begin_layout Plain Layout
14160 ] Whether multiple paragraphs are permitted in this inset.
14162 \begin_inset Flex CharStyle:Code
14165 \begin_layout Plain Layout
14171 to the same value and
14172 \begin_inset Flex CharStyle:Code
14175 \begin_layout Plain Layout
14181 to the opposite value.
14182 These can be reset to other values, if they are used
14187 \begin_inset Flex CharStyle:Code
14190 \begin_layout Plain Layout
14200 \begin_layout Description
14201 \begin_inset Flex CharStyle:Code
14204 \begin_layout Plain Layout
14211 \begin_inset Flex CharStyle:Code
14214 \begin_layout Plain Layout
14223 \begin_inset Flex CharStyle:Code
14226 \begin_layout Plain Layout
14232 ] Whether fragile commands in this layout should be
14233 \begin_inset Flex CharStyle:Code
14236 \begin_layout Plain Layout
14249 whether the command should itself be protected.) Default is false.
14252 \begin_layout Description
14253 \begin_inset Flex CharStyle:Code
14256 \begin_layout Plain Layout
14263 \begin_inset Flex CharStyle:Code
14266 \begin_layout Plain Layout
14275 \begin_inset Flex CharStyle:Code
14278 \begin_layout Plain Layout
14284 ] As with paragraph styles (see page
14285 \begin_inset CommandInset ref
14286 LatexCommand pageref
14287 reference "des:PathThru"
14295 \begin_layout Description
14296 \begin_inset Flex CharStyle:Code
14299 \begin_layout Plain Layout
14305 As with paragraph styles (see page
14306 \begin_inset CommandInset ref
14307 LatexCommand pageref
14308 reference "des:Preamble"
14315 \begin_layout Description
14316 \begin_inset Flex CharStyle:Code
14319 \begin_layout Plain Layout
14326 \begin_inset Flex CharStyle:Code
14329 \begin_layout Plain Layout
14335 ] As with paragraph styles (see page
14336 \begin_inset CommandInset ref
14337 LatexCommand pageref
14338 reference "des:Requires"
14345 \begin_layout Description
14346 \begin_inset Flex CharStyle:Code
14349 \begin_layout Plain Layout
14356 \begin_inset Flex CharStyle:Code
14359 \begin_layout Plain Layout
14366 \begin_inset Flex CharStyle:Code
14369 \begin_layout Plain Layout
14377 ] Spellcheck the contents of this inset.
14381 \begin_layout Subsection
14383 \begin_inset CommandInset label
14385 name "sub:Counters"
14392 \begin_layout Standard
14393 Since version 1.3.0 of LyX, it is both possible and necessary to define the
14395 \begin_inset Flex CharStyle:MenuItem
14398 \begin_layout Plain Layout
14405 \begin_inset Flex CharStyle:MenuItem
14408 \begin_layout Plain Layout
14414 , \SpecialChar \ldots{}
14415 ) in the text class itself.
14416 The standard counters are defined in the file
14417 \begin_inset Flex CharStyle:Code
14420 \begin_layout Plain Layout
14426 , so you may have to do no more than add
14429 \begin_layout LyX-Code
14430 Input stdcounters.inc
14433 \begin_layout Standard
14434 to your layout file to get them to work.
14435 But if you want to define custom counters, then you can do so.
14436 The counter declaration must begin with:
14439 \begin_layout LyX-Code
14440 Counter CounterName
14443 \begin_layout Standard
14445 \begin_inset Flex CharStyle:Code
14448 \begin_layout Plain Layout
14454 ' is replaced by the name of the counter.
14455 And it must end with
14456 \begin_inset Quotes eld
14460 \begin_inset Flex CharStyle:Code
14463 \begin_layout Plain Layout
14470 \begin_inset Quotes erd
14474 The following parameters can also be used:
14477 \begin_layout Description
14478 \begin_inset Flex CharStyle:Code
14481 \begin_layout Plain Layout
14488 \begin_inset Flex CharStyle:Code
14491 \begin_layout Plain Layout
14498 \begin_inset Quotes erd
14502 \begin_inset Quotes erd
14505 ] When defined, this string defines how the counter is displayed.
14506 Setting this value sets
14507 \begin_inset Flex CharStyle:Code
14510 \begin_layout Plain Layout
14511 LabelStringAppendix
14517 The following special constructs can be used in the string:
14521 \begin_layout Itemize
14522 \begin_inset Flex CharStyle:Code
14525 \begin_layout Plain Layout
14533 will be replaced by the expansion of the
14534 \begin_inset Flex CharStyle:Code
14537 \begin_layout Plain Layout
14544 \begin_inset Flex CharStyle:Code
14547 \begin_layout Plain Layout
14548 LabelStringAppendix
14554 \begin_inset Flex CharStyle:Code
14557 \begin_layout Plain Layout
14567 \begin_layout Itemize
14568 counter values can be expressed using LaTeX-like macros
14569 \begin_inset Flex CharStyle:Code
14572 \begin_layout Plain Layout
14589 \begin_inset Flex CharStyle:Code
14592 \begin_layout Plain Layout
14604 \begin_layout Plain Layout
14614 Actually, the situation is a bit more complicated: any
14633 other than those described below will produce arabic numerals.
14634 It would not be surprising to see this change in the future.
14640 \begin_inset Flex CharStyle:Code
14643 \begin_layout Plain Layout
14649 : 1, 2, 3,\SpecialChar \ldots{}
14651 \begin_inset Flex CharStyle:Code
14654 \begin_layout Plain Layout
14660 for lower-case letters: a, b, c, \SpecialChar \ldots{}
14662 \begin_inset Flex CharStyle:Code
14665 \begin_layout Plain Layout
14671 for upper-case letters: A, B, C, \SpecialChar \ldots{}
14673 \begin_inset Flex CharStyle:Code
14676 \begin_layout Plain Layout
14682 for lower-case roman numerals: i, ii, iii, \SpecialChar \ldots{}
14684 \begin_inset Flex CharStyle:Code
14687 \begin_layout Plain Layout
14693 for upper-case roman numerals: I, II, III\SpecialChar \ldots{}
14695 \begin_inset Flex CharStyle:Code
14698 \begin_layout Plain Layout
14704 for hebrew numerals.
14708 \begin_layout Standard
14709 If LabelString is not defined, a default value is constructed as follows:
14710 if the counter has a master counter
14711 \begin_inset Flex CharStyle:Code
14714 \begin_layout Plain Layout
14721 \begin_inset Flex CharStyle:Code
14724 \begin_layout Plain Layout
14731 \begin_inset Flex CharStyle:Code
14734 \begin_layout Plain Layout
14744 is used; otherwise the string
14745 \begin_inset Flex CharStyle:Code
14748 \begin_layout Plain Layout
14759 \begin_layout Description
14760 \begin_inset Flex CharStyle:Code
14763 \begin_layout Plain Layout
14764 LabelStringAppendix
14770 \begin_inset Flex CharStyle:Code
14773 \begin_layout Plain Layout
14780 \begin_inset Quotes erd
14784 \begin_inset Quotes erd
14788 \begin_inset Flex CharStyle:Code
14791 \begin_layout Plain Layout
14797 , but for use in the Appendix.
14800 \begin_layout Description
14801 \begin_inset Flex CharStyle:Code
14804 \begin_layout Plain Layout
14811 \begin_inset Flex CharStyle:Code
14814 \begin_layout Plain Layout
14821 \begin_inset Quotes erd
14825 \begin_inset Quotes erd
14828 ] A format for use with formatted references to this counter.
14829 For example, one might want to have references to section numbers appear
14831 \begin_inset Quotes eld
14835 \begin_inset Quotes erd
14839 The string should contain
14840 \begin_inset Quotes eld
14844 \begin_inset Quotes erd
14848 This will be replaced by the counter number itself.
14849 So, for sections, it would be: Section ##.
14852 \begin_layout Description
14853 \begin_inset Flex CharStyle:Code
14856 \begin_layout Plain Layout
14863 \begin_inset Flex CharStyle:Code
14866 \begin_layout Plain Layout
14873 \begin_inset Quotes erd
14877 \begin_inset Quotes erd
14880 ] If this is set to the name of another counter, the present counter will
14881 be reset every time the other one is increased.
14883 \begin_inset Flex CharStyle:Code
14886 \begin_layout Plain Layout
14893 \begin_inset Flex CharStyle:Code
14896 \begin_layout Plain Layout
14905 \begin_layout Subsection
14907 \begin_inset CommandInset label
14909 name "sub:Font-description"
14916 \begin_layout Standard
14917 A font description looks like this:
14920 \begin_layout LyX-Code
14930 \begin_layout LyX-Code
14934 \begin_layout LyX-Code
14938 \begin_layout Standard
14939 The following commands are available:
14942 \begin_layout Description
14943 \begin_inset Flex CharStyle:Code
14946 \begin_layout Plain Layout
14953 \begin_inset Flex CharStyle:Code
14956 \begin_layout Plain Layout
14965 \begin_inset Flex CharStyle:Code
14968 \begin_layout Plain Layout
14975 \begin_inset Flex CharStyle:Code
14978 \begin_layout Plain Layout
14985 \begin_inset Flex CharStyle:Code
14988 \begin_layout Plain Layout
14995 \begin_inset Flex CharStyle:Code
14998 \begin_layout Plain Layout
15005 \begin_inset Flex CharStyle:Code
15008 \begin_layout Plain Layout
15015 \begin_inset Flex CharStyle:Code
15018 \begin_layout Plain Layout
15025 \begin_inset Flex CharStyle:Code
15028 \begin_layout Plain Layout
15035 \begin_inset Flex CharStyle:Code
15038 \begin_layout Plain Layout
15047 \begin_layout Description
15048 \begin_inset Flex CharStyle:Code
15051 \begin_layout Plain Layout
15058 \begin_inset Flex CharStyle:Code
15061 \begin_layout Plain Layout
15070 \begin_inset Flex CharStyle:Code
15073 \begin_layout Plain Layout
15080 \begin_inset Flex CharStyle:Code
15083 \begin_layout Plain Layout
15092 \begin_layout Description
15093 \begin_inset Flex CharStyle:Code
15096 \begin_layout Plain Layout
15103 \begin_inset Flex CharStyle:Code
15106 \begin_layout Plain Layout
15112 ] Valid arguments are:
15113 \begin_inset Flex CharStyle:Code
15116 \begin_layout Plain Layout
15123 \begin_inset Flex CharStyle:Code
15126 \begin_layout Plain Layout
15133 \begin_inset Flex CharStyle:Code
15136 \begin_layout Plain Layout
15143 \begin_inset Flex CharStyle:Code
15146 \begin_layout Plain Layout
15153 \begin_inset Flex CharStyle:Code
15156 \begin_layout Plain Layout
15163 \begin_inset Flex CharStyle:Code
15166 \begin_layout Plain Layout
15173 Each of these turns on or off the corresponding attribute.
15175 \begin_inset Flex CharStyle:Code
15178 \begin_layout Plain Layout
15184 turns on emphasis, and
15185 \begin_inset Flex CharStyle:Code
15188 \begin_layout Plain Layout
15196 \begin_inset Newline newline
15199 If the latter seems puzzling, remember that the font settings for the present
15200 context are generally inherited from the surrounding context.
15202 \begin_inset Flex CharStyle:Code
15205 \begin_layout Plain Layout
15211 would turn off the emphasis that was anyway in effect, say, in a theorem
15215 \begin_layout Description
15216 \begin_inset Flex CharStyle:Code
15219 \begin_layout Plain Layout
15226 \begin_inset Flex CharStyle:Code
15229 \begin_layout Plain Layout
15238 \begin_inset Flex CharStyle:Code
15241 \begin_layout Plain Layout
15250 \begin_layout Description
15251 \begin_inset Flex CharStyle:Code
15254 \begin_layout Plain Layout
15261 \begin_inset Flex CharStyle:Code
15264 \begin_layout Plain Layout
15273 \begin_inset Flex CharStyle:Code
15276 \begin_layout Plain Layout
15283 \begin_inset Flex CharStyle:Code
15286 \begin_layout Plain Layout
15293 \begin_inset Flex CharStyle:Code
15296 \begin_layout Plain Layout
15305 \begin_layout Description
15306 \begin_inset Flex CharStyle:Code
15309 \begin_layout Plain Layout
15316 \begin_inset Flex CharStyle:Code
15319 \begin_layout Plain Layout
15326 \begin_inset Flex CharStyle:Code
15329 \begin_layout Plain Layout
15336 \begin_inset Flex CharStyle:Code
15339 \begin_layout Plain Layout
15348 \begin_inset Flex CharStyle:Code
15351 \begin_layout Plain Layout
15358 \begin_inset Flex CharStyle:Code
15361 \begin_layout Plain Layout
15368 \begin_inset Flex CharStyle:Code
15371 \begin_layout Plain Layout
15378 \begin_inset Flex CharStyle:Code
15381 \begin_layout Plain Layout
15388 \begin_inset Flex CharStyle:Code
15391 \begin_layout Plain Layout
15400 \begin_layout Section
15401 \begin_inset CommandInset label
15403 name "sec:Tags-for-XHTML"
15407 Tags for XHTML output
15410 \begin_layout Standard
15411 As with LaTeX or DocBook, the format of LyX's XHTML output is also controlled
15412 by layout information.
15413 In general, LyX provides sensible defaults and, as mentioned earlier, it
15414 will even construct default CSS style rules from the other layout tags.
15415 For example, LyX will attempt to use the information provided in the
15416 \begin_inset Flex CharStyle:Code
15419 \begin_layout Plain Layout
15425 declaration for the Chapter style to write CSS that will appropriately
15426 format chapter headings.
15429 \begin_layout Standard
15430 In many cases, then, you may not have to do anything at all to get acceptable
15431 XHTML output for your own environments, custom insets, and so forth.
15432 But in some cases you will, and so LyX provides a number of layout tags
15433 that can be used to customize the XHTML and CSS that are generated.
15436 \begin_layout Standard
15437 Note that there are two tags,
15438 \begin_inset Flex CharStyle:Code
15441 \begin_layout Plain Layout
15448 \begin_inset Flex CharStyle:Code
15451 \begin_layout Plain Layout
15457 that may appear outside style and inset declarations.
15459 \begin_inset CommandInset ref
15460 LatexCommand prettyref
15461 reference "sub:General-text-class"
15465 for details on these.
15468 \begin_layout Subsection
15469 \begin_inset CommandInset label
15471 name "sub:Paragraph-Style-XHTML"
15478 \begin_layout Standard
15479 The sort of XHTML LyX outputs for a paragraph depends upon whether we are
15480 dealing with a normal paragraph, a command, or an environment, where this
15481 is itself determined by the contents of the corresponding
15482 \begin_inset Flex CharStyle:Code
15485 \begin_layout Plain Layout
15495 \begin_layout Standard
15496 For a command or normal paragraph, the output XHTML has the following form:
15499 \begin_layout LyX-Code
15501 \begin_inset Quotes erd
15505 \begin_inset Quotes erd
15511 \begin_layout LyX-Code
15513 \begin_inset Quotes erd
15517 \begin_inset Quotes erd
15523 \begin_layout LyX-Code
15524 Contents of the paragraph.
15527 \begin_layout LyX-Code
15531 \begin_layout Standard
15532 The label tags are of course omitted if the paragraph does not have a label.
15535 \begin_layout Standard
15536 For an environment that is not some sort of list, the XHTML takes this form:
15539 \begin_layout LyX-Code
15541 \begin_inset Quotes erd
15545 \begin_inset Quotes erd
15551 \begin_layout LyX-Code
15553 \begin_inset Quotes erd
15557 \begin_inset Quotes erd
15561 \begin_inset Quotes erd
15565 \begin_inset Quotes erd
15568 >Environment Label</labeltag>First paragraph.</itemtag>
15571 \begin_layout LyX-Code
15572 <itemtag>Second paragraph.</itemtag>
15575 \begin_layout LyX-Code
15579 \begin_layout Standard
15580 Note that the label is output only for the first paragraph, as it should
15581 be for a theorem, for example.
15585 \begin_layout Standard
15586 For a list, we have one of these forms:
15589 \begin_layout LyX-Code
15591 \begin_inset Quotes erd
15595 \begin_inset Quotes erd
15601 \begin_layout LyX-Code
15603 \begin_inset Quotes erd
15607 \begin_inset Quotes erd
15611 \begin_inset Quotes erd
15615 \begin_inset Quotes erd
15618 >List Label</labeltag>First item.</itemtag>
15621 \begin_layout LyX-Code
15623 \begin_inset Quotes erd
15627 \begin_inset Quotes erd
15631 \begin_inset Quotes erd
15635 \begin_inset Quotes erd
15638 >List Label</labeltag>Second item.</itemtag>
15641 \begin_layout LyX-Code
15645 \begin_layout LyX-Code
15649 \begin_layout LyX-Code
15651 \begin_inset Quotes erd
15655 \begin_inset Quotes erd
15661 \begin_layout LyX-Code
15663 \begin_inset Quotes erd
15667 \begin_inset Quotes erd
15670 >List Label</labeltag><itemtag attr=
15671 \begin_inset Quotes erd
15675 \begin_inset Quotes erd
15678 >First item.</itemtag>
15681 \begin_layout LyX-Code
15683 \begin_inset Quotes erd
15687 \begin_inset Quotes erd
15690 >List Label</labeltag><itemtag attr=
15691 \begin_inset Quotes erd
15695 \begin_inset Quotes erd
15698 >Second item.</itemtag>
15701 \begin_layout LyX-Code
15705 \begin_layout Standard
15706 Note the different orders of
15707 \begin_inset Flex CharStyle:Code
15710 \begin_layout Plain Layout
15717 \begin_inset Flex CharStyle:Code
15720 \begin_layout Plain Layout
15727 Which order we get depends upon the setting of
15728 \begin_inset Flex CharStyle:Code
15731 \begin_layout Plain Layout
15738 \begin_inset Flex CharStyle:Code
15741 \begin_layout Plain Layout
15747 is false (the default), you get the first of these, with the label within
15748 the item; if true, you get the second, with the label outside the item.
15751 \begin_layout Standard
15752 The specific tags and attributes output for each paragraph type can be controlle
15753 d by means of the layout tags we are about to describe.
15754 As mentioned earlier, however, LyX uses sensible defaults for many of these,
15755 so you often may not need to do very much to get good XHTML output.
15756 Think of the available tags as there so you can tweak things to your liking.
15759 \begin_layout Description
15760 \begin_inset Flex CharStyle:Code
15763 \begin_layout Plain Layout
15770 \begin_inset Flex CharStyle:Code
15773 \begin_layout Plain Layout
15779 ] Specifies attribute information to be output with the main tag.
15781 \begin_inset Quotes eld
15785 \begin_inset Flex CharStyle:Code
15788 \begin_layout Plain Layout
15795 \begin_inset Quotes erd
15799 By default, LyX will output
15800 \begin_inset Quotes eld
15804 \begin_inset Flex CharStyle:Code
15807 \begin_layout Plain Layout
15814 \begin_inset Quotes erd
15818 \begin_inset Flex CharStyle:Code
15821 \begin_layout Plain Layout
15827 is the LyX name of the layout, made lowercase, for example: chapter.
15830 \begin_layout Description
15831 \begin_inset Flex CharStyle:Code
15834 \begin_layout Plain Layout
15841 \begin_inset Flex CharStyle:Code
15844 \begin_layout Plain Layout
15854 ] Whether to output the default CSS information LyX generates for this layout,
15855 even if additional information is explicitly provided via
15856 \begin_inset Flex CharStyle:Code
15859 \begin_layout Plain Layout
15867 \begin_inset Flex CharStyle:Code
15870 \begin_layout Plain Layout
15876 allows you to alter or augment the generated CSS, rather than to override
15879 \begin_inset Flex CharStyle:Code
15882 \begin_layout Plain Layout
15891 \begin_layout Description
15892 \begin_inset Flex CharStyle:Code
15895 \begin_layout Plain Layout
15902 \begin_inset Flex CharStyle:Code
15905 \begin_layout Plain Layout
15911 ] The tag to be used for individual paragraphs of environments, replacing
15913 \begin_inset Flex CharStyle:Code
15916 \begin_layout Plain Layout
15922 in the examples above.
15924 \begin_inset Flex CharStyle:Code
15927 \begin_layout Plain Layout
15936 \begin_layout Description
15937 \begin_inset Flex CharStyle:Code
15940 \begin_layout Plain Layout
15947 \begin_inset Flex CharStyle:Code
15950 \begin_layout Plain Layout
15956 ] Attributes for the item tag.
15958 \begin_inset Quotes eld
15962 \begin_inset Flex CharStyle:Code
15965 \begin_layout Plain Layout
15966 class=`layoutname_item'
15972 \begin_inset Quotes erd
15978 \begin_layout Description
15979 \begin_inset Flex CharStyle:Code
15982 \begin_layout Plain Layout
15989 \begin_inset Flex CharStyle:Code
15992 \begin_layout Plain Layout
15998 ] The tag to be used for paragraph and item labels, replacing
15999 \begin_inset Flex CharStyle:Code
16002 \begin_layout Plain Layout
16008 in the examples above.
16010 \begin_inset Flex CharStyle:Code
16013 \begin_layout Plain Layout
16022 \begin_layout Description
16023 \begin_inset Flex CharStyle:Code
16026 \begin_layout Plain Layout
16033 \begin_inset Flex CharStyle:Code
16036 \begin_layout Plain Layout
16042 ] Attributes for the label tag.
16044 \begin_inset Quotes eld
16048 \begin_inset Flex CharStyle:Code
16051 \begin_layout Plain Layout
16052 class=`layoutname_label'
16058 \begin_inset Quotes erd
16064 \begin_layout Description
16065 \begin_inset Flex CharStyle:Code
16068 \begin_layout Plain Layout
16075 \begin_inset Flex CharStyle:Code
16078 \begin_layout Plain Layout
16088 ] Meaningful only for list-like environments, this tag controls whether
16089 the label tag is output before or inside the item tag.
16090 This is used, for example, in the description environment, where we want
16092 \begin_inset Flex CharStyle:Code
16095 \begin_layout Plain Layout
16096 <dt>\SpecialChar \ldots{}
16097 </dt><dd>\SpecialChar \ldots{}
16105 \begin_inset Flex CharStyle:Code
16108 \begin_layout Plain Layout
16114 : The label tag is output inside the item tag.
16117 \begin_layout Description
16118 \begin_inset Flex CharStyle:Code
16121 \begin_layout Plain Layout
16127 Information to be output in the
16128 \begin_inset Flex CharStyle:Code
16131 \begin_layout Plain Layout
16137 section when this style is used.
16138 This might, for example, be used to include a
16139 \begin_inset Flex CharStyle:Code
16142 \begin_layout Plain Layout
16149 \begin_inset Flex CharStyle:Code
16152 \begin_layout Plain Layout
16161 \begin_layout Description
16162 \begin_inset Flex CharStyle:Code
16165 \begin_layout Plain Layout
16171 CSS style information to be included when this style is used.
16172 Note that this will automatically be wrapped in a layout-generated
16173 \begin_inset Flex CharStyle:Code
16176 \begin_layout Plain Layout
16182 block, so only the CSS itself need be included.
16185 \begin_layout Description
16186 \begin_inset Flex CharStyle:Code
16189 \begin_layout Plain Layout
16196 \begin_inset Flex CharStyle:Code
16199 \begin_layout Plain Layout
16205 ] The tag to be used for the main label, replacing
16206 \begin_inset Flex CharStyle:Code
16209 \begin_layout Plain Layout
16215 in the examples above.
16217 \begin_inset Flex CharStyle:Code
16220 \begin_layout Plain Layout
16229 \begin_layout Description
16230 \begin_inset Flex CharStyle:Code
16233 \begin_layout Plain Layout
16240 \begin_inset Flex CharStyle:Code
16243 \begin_layout Plain Layout
16253 ] Marks this style as the one to be used to generate the
16254 \begin_inset Flex CharStyle:Code
16257 \begin_layout Plain Layout
16263 tag for the XHTML file.
16264 By default, it is false.
16266 \begin_inset Flex CharStyle:Code
16269 \begin_layout Plain Layout
16275 file sets it to true for the
16276 \begin_inset Flex CharStyle:Code
16279 \begin_layout Plain Layout
16289 \begin_layout Subsection
16293 \begin_layout Standard
16294 The XHTML output of insets can also be controlled by information in layout
16299 \begin_layout Plain Layout
16300 At present, this is true only for
16301 \begin_inset Quotes eld
16305 \begin_inset Quotes erd
16308 insets (insets you can type into) and is not true for
16309 \begin_inset Quotes eld
16313 \begin_inset Quotes erd
16316 insets (insets that are associated with dialog boxes).
16321 Here, too, LyX tries to provide sensible defaults, and it constructs default
16323 But everything can be customized.
16326 \begin_layout Standard
16327 The XHTML LyX outputs for an inset has the following form:
16330 \begin_layout LyX-Code
16332 \begin_inset Quotes erd
16336 \begin_inset Quotes erd
16342 \begin_layout LyX-Code
16343 <labeltag>Label</labeltag>
16346 \begin_layout LyX-Code
16348 \begin_inset Quotes erd
16352 \begin_inset Quotes erd
16355 >Contents of the inset.</innertag>
16358 \begin_layout LyX-Code
16362 \begin_layout Standard
16363 If the inset permits multiple paragraphs---that is, if
16364 \begin_inset Flex CharStyle:Code
16367 \begin_layout Plain Layout
16373 is true---then the contents of the inset will itself be output as paragraphs
16374 formatted according to the styles used for those paragraphs (standard,
16375 quote, and the like).
16376 The label tag is of course omitted if the paragraph does not have a label
16377 and, at present, is always
16378 \begin_inset Flex CharStyle:Code
16381 \begin_layout Plain Layout
16388 The inner tag is optional and, by default, does not appear.
16391 \begin_layout Standard
16392 The specific tags and attributes output for each inset can be controlled
16393 by means of the following layout tags.
16396 \begin_layout Description
16397 \begin_inset Flex CharStyle:Code
16400 \begin_layout Plain Layout
16407 \begin_inset Flex CharStyle:Code
16410 \begin_layout Plain Layout
16416 ] Specifies attribute information to be output with the main tag.
16418 \begin_inset Quotes eld
16422 \begin_inset Flex CharStyle:Code
16425 \begin_layout Plain Layout
16426 class=`myinset' onclick=`\SpecialChar \ldots{}
16433 \begin_inset Quotes erd
16437 By default, LyX will output
16438 \begin_inset Quotes eld
16442 \begin_inset Flex CharStyle:Code
16445 \begin_layout Plain Layout
16452 \begin_inset Quotes erd
16456 \begin_inset Flex CharStyle:Code
16459 \begin_layout Plain Layout
16465 is the LyX name of the inset, made lowercase and with non-alphanumeric
16466 characters converted to underscores, for example: footnote.
16469 \begin_layout Description
16470 \begin_inset Flex CharStyle:Code
16473 \begin_layout Plain Layout
16480 \begin_inset Flex CharStyle:Code
16483 \begin_layout Plain Layout
16493 ] Whether to output the default CSS information LyX generates for this layout,
16494 even if additional information is explicitly provided via
16495 \begin_inset Flex CharStyle:Code
16498 \begin_layout Plain Layout
16506 \begin_inset Flex CharStyle:Code
16509 \begin_layout Plain Layout
16515 allows you to alter or augment the generated CSS, rather than to override
16520 \begin_layout Description
16521 \begin_inset Flex CharStyle:Code
16524 \begin_layout Plain Layout
16531 \begin_inset Flex CharStyle:Code
16534 \begin_layout Plain Layout
16540 ] Attributes for the inner tag.
16542 \begin_inset Quotes eld
16546 \begin_inset Flex CharStyle:Code
16549 \begin_layout Plain Layout
16550 class=`insetname_inner'
16556 \begin_inset Quotes erd
16562 \begin_layout Description
16563 \begin_inset Flex CharStyle:Code
16566 \begin_layout Plain Layout
16573 \begin_inset Flex CharStyle:Code
16576 \begin_layout Plain Layout
16582 ] The inner tag, replacing
16583 \begin_inset Flex CharStyle:Code
16586 \begin_layout Plain Layout
16592 in the examples above.
16593 By default, there is none.
16596 \begin_layout Description
16597 \begin_inset Flex CharStyle:Code
16600 \begin_layout Plain Layout
16607 \begin_inset Flex CharStyle:Code
16610 \begin_layout Plain Layout
16618 ] Whether this inset represents a standalone block of text (such as a footnote)
16619 or instead represents material that is included in the surrounding text
16620 (such as a branch).
16624 \begin_layout Description
16625 \begin_inset Flex CharStyle:Code
16628 \begin_layout Plain Layout
16635 \begin_inset Flex CharStyle:Code
16638 \begin_layout Plain Layout
16644 ] A label for this inset, possibly including a reference to a counter.
16645 For example, for footnote, it might be:
16646 \begin_inset Flex CharStyle:Code
16649 \begin_layout Plain Layout
16658 This is optional, and there is no default.
16661 \begin_layout Description
16662 \begin_inset Flex CharStyle:Code
16665 \begin_layout Plain Layout
16671 Information to be output in the
16672 \begin_inset Flex CharStyle:Code
16675 \begin_layout Plain Layout
16681 section when this style is used.
16682 This might, for example, be used to include a
16683 \begin_inset Flex CharStyle:Code
16686 \begin_layout Plain Layout
16693 \begin_inset Flex CharStyle:Code
16696 \begin_layout Plain Layout
16705 \begin_layout Description
16706 \begin_inset Flex CharStyle:Code
16709 \begin_layout Plain Layout
16715 CSS style information to be included when this style is used.
16716 Note that this will automatically be wrapped in a layout-generated
16717 \begin_inset Flex CharStyle:Code
16720 \begin_layout Plain Layout
16726 block, so only the CSS itself need be included.
16729 \begin_layout Description
16730 \begin_inset Flex CharStyle:Code
16733 \begin_layout Plain Layout
16740 \begin_inset Flex CharStyle:Code
16743 \begin_layout Plain Layout
16749 ] The tag to be used for the main label, replacing
16750 \begin_inset Flex CharStyle:Code
16753 \begin_layout Plain Layout
16759 in the examples above.
16760 The default depends upon the setting of
16761 \begin_inset Flex CharStyle:Code
16764 \begin_layout Plain Layout
16771 \begin_inset Flex CharStyle:Code
16774 \begin_layout Plain Layout
16780 is true, the default is
16781 \begin_inset Flex CharStyle:Code
16784 \begin_layout Plain Layout
16790 ; if it is false, the default is
16791 \begin_inset Flex CharStyle:Code
16794 \begin_layout Plain Layout
16803 \begin_layout Subsection
16807 \begin_layout Standard
16808 The XHTML output for floats too can be controlled by layout information.
16809 The output has the following form:
16812 \begin_layout LyX-Code
16814 \begin_inset Quotes erd
16818 \begin_inset Quotes erd
16824 \begin_layout LyX-Code
16825 Contents of the float.
16828 \begin_layout LyX-Code
16832 \begin_layout Standard
16833 The caption, if there is one, is a separate inset and will be output as
16835 Its appearance can be controlled via the InsetLayout for caption insets.
16839 \begin_layout Description
16840 \begin_inset Flex CharStyle:Code
16843 \begin_layout Plain Layout
16850 \begin_inset Flex CharStyle:Code
16853 \begin_layout Plain Layout
16859 ] Specifies attribute information to be output with the main tag.
16861 \begin_inset Quotes eld
16865 \begin_inset Flex CharStyle:Code
16868 \begin_layout Plain Layout
16869 class=`myfloat' onclick=`\SpecialChar \ldots{}
16876 \begin_inset Quotes erd
16880 By default, LyX will output
16881 \begin_inset Quotes eld
16885 \begin_inset Flex CharStyle:Code
16888 \begin_layout Plain Layout
16889 class=`float float-floattype'
16895 \begin_inset Quotes erd
16899 \begin_inset Flex CharStyle:Code
16902 \begin_layout Plain Layout
16908 is LyX's name for this type of float, as determined by the float delcaration
16910 \begin_inset CommandInset ref
16912 reference "sub:Floats"
16916 ), though made lowercase and with non-alphanumeric characters converted
16917 to underscores, for example: float-table.
16920 \begin_layout Description
16921 \begin_inset Flex CharStyle:Code
16924 \begin_layout Plain Layout
16930 CSS style information to be included when this float is used.
16931 Note that this will automatically be wrapped in a layout-generated
16932 \begin_inset Flex CharStyle:Code
16935 \begin_layout Plain Layout
16941 block, so only the CSS itself need be included.
16944 \begin_layout Description
16945 \begin_inset Flex CharStyle:Code
16948 \begin_layout Plain Layout
16955 \begin_inset Flex CharStyle:Code
16958 \begin_layout Plain Layout
16964 ] The tag to be used for this float, replacing
16965 \begin_inset Quotes eld
16969 \begin_inset Flex CharStyle:Code
16972 \begin_layout Plain Layout
16979 \begin_inset Quotes erd
16982 in the example above.
16984 \begin_inset Flex CharStyle:Code
16987 \begin_layout Plain Layout
16993 and will rarely need changing.
16996 \begin_layout Subsection
17000 \begin_layout Standard
17001 We have several times mentioned that LyX will generate default CSS style
17002 rules for both insets and paragraph styles, based upon the other layout
17003 information that is provided.
17004 In this section, we shall say a word about which layout information LyX
17008 \begin_layout Standard
17009 At present, LyX auto-generates CSS only for font information, making use
17011 \begin_inset Flex CharStyle:Code
17014 \begin_layout Plain Layout
17021 \begin_inset Flex CharStyle:Code
17024 \begin_layout Plain Layout
17031 \begin_inset Flex CharStyle:Code
17034 \begin_layout Plain Layout
17041 \begin_inset Flex CharStyle:Code
17044 \begin_layout Plain Layout
17051 \begin_inset Flex CharStyle:Code
17054 \begin_layout Plain Layout
17062 \begin_inset CommandInset ref
17064 reference "sub:Font-description"
17068 .) The translation is mostly straightforward and obvious.
17070 \begin_inset Quotes eld
17074 \begin_inset Flex CharStyle:Code
17077 \begin_layout Plain Layout
17084 \begin_inset Quotes erd
17088 \begin_inset Quotes eld
17092 \begin_inset Flex CharStyle:Code
17095 \begin_layout Plain Layout
17096 font-family: sans-serif;
17102 \begin_inset Quotes erd
17106 The correspondence of LyX sizes and CSS sizes is a little less obvious
17107 but nonetheless intuitive.
17109 \begin_inset Flex CharStyle:Code
17112 \begin_layout Plain Layout
17119 \begin_inset Flex URL
17122 \begin_layout Plain Layout
17133 \begin_layout Chapter
17134 Including External Material
17137 \begin_layout Standard
17138 \begin_inset Box Shadowbox
17147 height_special "totalheight"
17150 \begin_layout Plain Layout
17151 WARNING: This portion of the documentation has not been updated for some
17153 We certainly hope that it is still accurate, but there are no guarantees.
17161 \begin_layout Standard
17162 The use of material from sources external to LyX is covered in detail in
17168 This part of the manual covers what needs to happen behind the scenes for
17169 new sorts of material to be included.
17172 \begin_layout Section
17176 \begin_layout Standard
17177 The external material feature is based on the concept of a
17182 A template is a specification of how LyX should interface with a certain
17184 As bundled, LyX comes with predefined templates for Xfig figures, various
17185 raster format images, chess diagrams, and LilyPond music notation.
17186 You can check the actual list by using the menu
17187 \begin_inset Flex CharStyle:MenuItem
17190 \begin_layout Plain Layout
17191 Insert\SpecialChar \menuseparator
17192 File\SpecialChar \menuseparator
17199 Furthermore, it is possible to roll your own template to support a specific
17201 Later we'll describe in more detail what is involved, and hopefully you
17202 will submit all the templates you create so we can include them in a later
17206 \begin_layout Standard
17207 Another basic idea of the external material feature is to distinguish between
17208 the original file that serves as a base for final material and the produced
17209 file that is included in your exported or printed document.
17210 For example, consider the case of a figure produced with
17211 \begin_inset Flex CharStyle:Code
17214 \begin_layout Plain Layout
17221 The Xfig application itself works on an original file with the
17222 \begin_inset Flex CharStyle:Code
17225 \begin_layout Plain Layout
17232 Within Xfig, you create and change your figure, and when you are done,
17234 \begin_inset Flex CharStyle:Code
17237 \begin_layout Plain Layout
17244 When you want to include the figure in your document, you invoke
17245 \begin_inset Flex CharStyle:Code
17248 \begin_layout Plain Layout
17254 in order to create a PostScript file that can readily be included in your
17257 \begin_inset Flex CharStyle:Code
17260 \begin_layout Plain Layout
17266 file is the original file, and the PostScript file is the produced file.
17269 \begin_layout Standard
17270 This distinction is important in order to allow updating of the material
17271 while you are in the process of writing the document.
17272 Furthermore, it provides us with the flexibility that is needed to support
17273 multiple export formats.
17274 For instance, in the case of a plain text file, it is not exactly an award-winn
17275 ing idea to include the figure as raw PostScript.
17276 Instead, you'd either prefer to just include a reference to the figure
17277 or try to invoke some graphics to ASCII converter to make the final result
17278 look similar to the real graphics.
17279 The external material management allows you to do this, because it is parametri
17280 zed on the different export formats that LyX supports.
17283 \begin_layout Standard
17284 Besides supporting the production of different products according to the
17285 exported format, it supports tight integration with editing and viewing
17287 In the case of an Xfig figure, you are able to invoke Xfig on the original
17288 file with a single click from within the external material dialog in LyX,
17289 and also preview the produced PostScript file with Ghostview with another
17291 No more fiddling around with the command line and/or file browsers to locate
17292 and manipulate the original or produced files.
17293 In this way, you are finally able to take full advantage of the many different
17294 applications that are relevant to use when you write your documents, and
17295 ultimately be more productive.
17298 \begin_layout Section
17299 The external template configuration file
17302 \begin_layout Standard
17303 It is relatively easy to add custom external template definitions to LyX.
17304 However, be aware that doing this in an careless manner most probably
17308 introduce an easily exploitable security hole.
17309 So before you do this, please read the discussion about security in section
17311 \begin_inset CommandInset ref
17313 reference "sec:Security-discussion"
17320 \begin_layout Standard
17321 Having said that, we encourage you to submit any interesting templates that
17326 \begin_layout Standard
17327 The external templates are defined in the
17328 \begin_inset Flex CharStyle:Code
17331 \begin_layout Plain Layout
17332 LyXDir/lib/external_templates
17338 You can place your own version in
17339 \begin_inset Flex CharStyle:Code
17342 \begin_layout Plain Layout
17343 UserDir/external_templates
17351 \begin_layout Standard
17352 A typical template looks like this:
17355 \begin_layout LyX-Code
17359 \begin_layout LyX-Code
17360 GuiName "XFig: $$AbsOrRelPathParent$$Basename"
17363 \begin_layout LyX-Code
17367 \begin_layout LyX-Code
17371 \begin_layout LyX-Code
17375 \begin_layout LyX-Code
17379 \begin_layout LyX-Code
17383 \begin_layout LyX-Code
17384 AutomaticProduction true
17387 \begin_layout LyX-Code
17391 \begin_layout LyX-Code
17395 \begin_layout LyX-Code
17399 \begin_layout LyX-Code
17400 TransformCommand Rotate RotationLatexCommand
17403 \begin_layout LyX-Code
17404 TransformCommand Resize ResizeLatexCommand
17407 \begin_layout LyX-Code
17408 Product "$$RotateFront$$ResizeFront
17411 \begin_layout LyX-Code
17416 input{$$AbsOrRelPathMaster$$Basename.pstex_t}
17419 \begin_layout LyX-Code
17420 $$ResizeBack$$RotateBack"
17423 \begin_layout LyX-Code
17427 \begin_layout LyX-Code
17428 UpdateResult "$$AbsPath$$Basename.pstex_t"
17431 \begin_layout LyX-Code
17432 Requirement "graphicx"
17435 \begin_layout LyX-Code
17436 ReferencedFile latex "$$AbsOrRelPathMaster$$Basename.pstex_t"
17439 \begin_layout LyX-Code
17440 ReferencedFile latex "$$AbsPath$$Basename.eps"
17443 \begin_layout LyX-Code
17444 ReferencedFile dvi "$$AbsPath$$Basename.eps"
17447 \begin_layout LyX-Code
17451 \begin_layout LyX-Code
17455 \begin_layout LyX-Code
17456 TransformCommand Rotate RotationLatexCommand
17459 \begin_layout LyX-Code
17460 TransformCommand Resize ResizeLatexCommand
17463 \begin_layout LyX-Code
17464 Product "$$RotateFront$$ResizeFront
17467 \begin_layout LyX-Code
17472 input{$$AbsOrRelPathMaster$$Basename.pdftex_t}
17475 \begin_layout LyX-Code
17476 $$ResizeBack$$RotateBack"
17479 \begin_layout LyX-Code
17480 UpdateFormat pdftex
17483 \begin_layout LyX-Code
17484 UpdateResult "$$AbsPath$$Basename.pdftex_t"
17487 \begin_layout LyX-Code
17488 Requirement "graphicx"
17491 \begin_layout LyX-Code
17492 ReferencedFile latex "$$AbsOrRelPathMaster$$Basename.pdftex_t"
17495 \begin_layout LyX-Code
17496 ReferencedFile latex "$$AbsPath$$Basename.pdf"
17499 \begin_layout LyX-Code
17503 \begin_layout LyX-Code
17507 \begin_layout LyX-Code
17508 Product "$$Contents(
17510 "$$AbsPath$$Basename.asc
17515 \begin_layout LyX-Code
17516 UpdateFormat asciixfig
17519 \begin_layout LyX-Code
17520 UpdateResult "$$AbsPath$$Basename.asc"
17523 \begin_layout LyX-Code
17527 \begin_layout LyX-Code
17531 \begin_layout LyX-Code
17532 Product "<graphic fileref=
17534 "$$AbsOrRelPathMaster$$Basename.eps
17539 \begin_layout LyX-Code
17543 \begin_layout LyX-Code
17547 \begin_layout LyX-Code
17548 UpdateResult "$$AbsPath$$Basename.eps"
17551 \begin_layout LyX-Code
17552 ReferencedFile docbook "$$AbsPath$$Basename.eps"
17555 \begin_layout LyX-Code
17556 ReferencedFile docbook-xml "$$AbsPath$$Basename.eps"
17559 \begin_layout LyX-Code
17563 \begin_layout LyX-Code
17564 Product "[XFig: $$FName]"
17567 \begin_layout LyX-Code
17571 \begin_layout LyX-Code
17575 \begin_layout Standard
17576 As you can see, the template is enclosed in
17577 \begin_inset Flex CharStyle:Code
17580 \begin_layout Plain Layout
17586 \SpecialChar \ldots{}
17588 \begin_inset Flex CharStyle:Code
17591 \begin_layout Plain Layout
17598 It contains a header specifying some general settings and, for each supported
17599 primary document file format, a section
17600 \begin_inset Flex CharStyle:Code
17603 \begin_layout Plain Layout
17609 \SpecialChar \ldots{}
17611 \begin_inset Flex CharStyle:Code
17614 \begin_layout Plain Layout
17623 \begin_layout Subsection
17624 The template header
17627 \begin_layout Description
17628 \begin_inset Flex CharStyle:Code
17631 \begin_layout Plain Layout
17632 AutomaticProduction
17633 \begin_inset space ~
17641 Whether the file represented by the template must be generated by LyX.
17642 This command must occur exactly once.
17645 \begin_layout Description
17646 \begin_inset Flex CharStyle:Code
17649 \begin_layout Plain Layout
17651 \begin_inset space ~
17659 A glob pattern that is used in the file dialog to filter out the desired
17661 If there is more than one possible file extension (e.
17662 \begin_inset space \thinspace{}
17666 \begin_inset space \space{}
17670 \begin_inset Flex CharStyle:Code
17673 \begin_layout Plain Layout
17680 \begin_inset Flex CharStyle:Code
17683 \begin_layout Plain Layout
17689 ), use something like
17690 \begin_inset Flex CharStyle:Code
17693 \begin_layout Plain Layout
17700 This command must occur exactly once.
17703 \begin_layout Description
17704 \begin_inset Flex CharStyle:Code
17707 \begin_layout Plain Layout
17709 \begin_inset space ~
17717 The text that is displayed on the button.
17718 This command must occur exactly once.
17721 \begin_layout Description
17722 \begin_inset Flex CharStyle:Code
17725 \begin_layout Plain Layout
17727 \begin_inset space ~
17731 \begin_inset space ~
17739 The help text that is used in the External dialog.
17740 Provide enough information to explain to the user just what the template
17741 can provide him with.
17742 This command must occur exactly once.
17745 \begin_layout Description
17746 \begin_inset Flex CharStyle:Code
17749 \begin_layout Plain Layout
17751 \begin_inset space ~
17759 The file format of the original file.
17760 This must be the name of a format that is known to LyX (see section
17761 \begin_inset CommandInset ref
17763 reference "sec:Formats"
17769 \begin_inset Quotes eld
17773 \begin_inset Flex CharStyle:Code
17776 \begin_layout Plain Layout
17783 \begin_inset Quotes erd
17786 if the template can handle original files of more than one format.
17787 LyX will attempt to interrogate the file itself in order to deduce its
17788 format in this case.
17789 This command must occur exactly once.
17792 \begin_layout Description
17793 \begin_inset Flex CharStyle:Code
17796 \begin_layout Plain Layout
17798 \begin_inset space ~
17806 A unique name for the template.
17807 It must not contain substitution macros (see below).
17810 \begin_layout Description
17811 \begin_inset Flex CharStyle:Code
17814 \begin_layout Plain Layout
17816 \begin_inset space ~
17819 Rotate|Resize|Clip|Extra
17824 This command specifies which transformations are supported by this template.
17825 It may occur zero or more times.
17826 This command enables the corresponding tabs in the external dialog.
17828 \begin_inset Flex CharStyle:Code
17831 \begin_layout Plain Layout
17837 command must have either a corresponding
17838 \begin_inset Flex CharStyle:Code
17841 \begin_layout Plain Layout
17848 \begin_inset Flex CharStyle:Code
17851 \begin_layout Plain Layout
17858 \begin_inset Flex CharStyle:Code
17861 \begin_layout Plain Layout
17868 Otherwise the transformation will not be supported by that format.
17871 \begin_layout Subsection
17875 \begin_layout Description
17876 \begin_inset Flex CharStyle:Code
17879 \begin_layout Plain Layout
17881 \begin_inset space ~
17884 LaTeX|PDFLaTeX|PlainText|DocBook
17889 The primary document file format that this format definition is for.
17890 Not every template has a sensible representation in all document file formats.
17891 Please define nevertheless a
17892 \begin_inset Flex CharStyle:Code
17895 \begin_layout Plain Layout
17901 section for all formats.
17902 Use a dummy text when no representation is available.
17903 Then you can at least see a reference to the external material in the exported
17907 \begin_layout Description
17908 \begin_inset Flex CharStyle:Code
17911 \begin_layout Plain Layout
17913 \begin_inset space ~
17917 \begin_inset space ~
17925 This command defines an additional macro
17926 \begin_inset Flex CharStyle:Code
17929 \begin_layout Plain Layout
17935 for substitution in
17936 \begin_inset Flex CharStyle:Code
17939 \begin_layout Plain Layout
17947 \begin_inset Flex CharStyle:Code
17950 \begin_layout Plain Layout
17956 itself may contain substitution macros.
17957 The advantage over using
17958 \begin_inset Flex CharStyle:Code
17961 \begin_layout Plain Layout
17968 \begin_inset Flex CharStyle:Code
17971 \begin_layout Plain Layout
17977 is that the substituted value of
17978 \begin_inset Flex CharStyle:Code
17981 \begin_layout Plain Layout
17987 is sanitized so that it is a valid optional argument in the document format.
17988 This command may occur zero or more times.
17991 \begin_layout Description
17992 \begin_inset Flex CharStyle:Code
17995 \begin_layout Plain Layout
17997 \begin_inset space ~
18005 The text that is inserted in the exported document.
18006 This is actually the most important command and can be quite complex.
18007 This command must occur exactly once.
18010 \begin_layout Description
18011 \begin_inset Flex CharStyle:Code
18014 \begin_layout Plain Layout
18016 \begin_inset space ~
18024 This command specifies a preamble snippet that will be included in the
18026 It has to be defined using
18027 \begin_inset Flex CharStyle:Code
18030 \begin_layout Plain Layout
18036 \SpecialChar \ldots{}
18038 \begin_inset Flex CharStyle:Code
18041 \begin_layout Plain Layout
18048 This command may occur zero or more times.
18051 \begin_layout Description
18052 \begin_inset Flex CharStyle:Code
18055 \begin_layout Plain Layout
18057 \begin_inset space ~
18061 \begin_inset space ~
18069 This command denotes files that are created by the conversion process and
18070 are needed for a particular export format.
18071 If the filename is relative, it is interpreted relative to the master document.
18072 This command may be given zero or more times.
18075 \begin_layout Description
18076 \begin_inset Flex CharStyle:Code
18079 \begin_layout Plain Layout
18081 \begin_inset space ~
18089 The name of a required LaTeX package.
18090 The package is included via
18091 \begin_inset Flex CharStyle:Code
18094 \begin_layout Plain Layout
18102 in the LaTeX preamble.
18103 This command may occur zero or more times.
18106 \begin_layout Description
18107 \begin_inset Flex CharStyle:Code
18110 \begin_layout Plain Layout
18112 \begin_inset space ~
18116 \begin_inset space ~
18119 RotationLatexCommand
18124 This command specifies that the built in LaTeX command should be used for
18126 This command may occur once or not at all.
18129 \begin_layout Description
18130 \begin_inset Flex CharStyle:Code
18133 \begin_layout Plain Layout
18135 \begin_inset space ~
18139 \begin_inset space ~
18147 This command specifies that the built in LaTeX command should be used for
18149 This command may occur once or not at all.
18152 \begin_layout Description
18153 \begin_inset Flex CharStyle:Code
18156 \begin_layout Plain Layout
18158 \begin_inset space ~
18162 \begin_inset space ~
18165 RotationLatexOption
18170 This command specifies that rotation is done via an optional argument.
18171 This command may occur once or not at all.
18174 \begin_layout Description
18175 \begin_inset Flex CharStyle:Code
18178 \begin_layout Plain Layout
18180 \begin_inset space ~
18184 \begin_inset space ~
18192 This command specifies that resizing is done via an optional argument.
18193 This command may occur once or not at all.
18196 \begin_layout Description
18197 \begin_inset Flex CharStyle:Code
18200 \begin_layout Plain Layout
18202 \begin_inset space ~
18206 \begin_inset space ~
18214 This command specifies that clipping is done via an optional argument.
18215 This command may occur once or not at all.
18218 \begin_layout Description
18219 \begin_inset Flex CharStyle:Code
18222 \begin_layout Plain Layout
18224 \begin_inset space ~
18228 \begin_inset space ~
18236 This command specifies that an extra optional argument is used.
18237 This command may occur once or not at all.
18240 \begin_layout Description
18241 \begin_inset Flex CharStyle:Code
18244 \begin_layout Plain Layout
18246 \begin_inset space ~
18254 The file format of the converted file.
18255 This must be the name of a format that is known to LyX (see the
18256 \begin_inset Flex CharStyle:MenuItem
18259 \begin_layout Plain Layout
18264 ools\SpecialChar \menuseparator
18269 references:Conversion
18275 This command must occur exactly once.
18278 \begin_layout Description
18279 \begin_inset Flex CharStyle:Code
18282 \begin_layout Plain Layout
18284 \begin_inset space ~
18292 The file name of the converted file.
18293 The file name must be absolute.
18294 This command must occur exactly once.
18297 \begin_layout Subsection
18298 Preamble definitions
18301 \begin_layout Standard
18302 The external template configuration file may contain additional preamble
18303 definitions enclosed by
18304 \begin_inset Flex CharStyle:Code
18307 \begin_layout Plain Layout
18313 \SpecialChar \ldots{}
18315 \begin_inset Flex CharStyle:Code
18318 \begin_layout Plain Layout
18325 They can be used by the templates in the
18326 \begin_inset Flex CharStyle:Code
18329 \begin_layout Plain Layout
18338 \begin_layout Section
18339 The substitution mechanism
18342 \begin_layout Standard
18343 When the external material facility invokes an external program, it is done
18344 on the basis of a command defined in the template configuration file.
18345 These commands can contain various macros that are expanded before execution.
18346 Execution always take place in the directory of the containing document.
18349 \begin_layout Standard
18350 Also, whenever external material is to be displayed, the name will be produced
18351 by the substitution mechanism, and most other commands in the template
18352 definition support substitution as well.
18355 \begin_layout Standard
18356 The available macros are the following:
18359 \begin_layout Description
18360 \begin_inset Flex CharStyle:Code
18363 \begin_layout Plain Layout
18364 $$AbsOrRelPathMaster
18369 The file path, absolute or relative to the master LyX document.
18372 \begin_layout Description
18373 \begin_inset Flex CharStyle:Code
18376 \begin_layout Plain Layout
18377 $$AbsOrRelPathParent
18382 The file path, absolute or relative to the LyX document.
18385 \begin_layout Description
18386 \begin_inset Flex CharStyle:Code
18389 \begin_layout Plain Layout
18395 The absolute file path.
18398 \begin_layout Description
18399 \begin_inset Flex CharStyle:Code
18402 \begin_layout Plain Layout
18408 The filename without path and without the extension.
18411 \begin_layout Description
18412 \begin_inset Flex CharStyle:Code
18415 \begin_layout Plain Layout
18417 \begin_inset Quotes eld
18421 \begin_inset Quotes erd
18429 This macro will expand to the contents of the file with the name
18430 \begin_inset Flex CharStyle:Code
18433 \begin_layout Plain Layout
18442 \begin_layout Description
18443 \begin_inset Flex CharStyle:Code
18446 \begin_layout Plain Layout
18452 The file extension (including the dot).
18455 \begin_layout Description
18456 \begin_inset Flex CharStyle:Code
18459 \begin_layout Plain Layout
18465 The filename of the file specified in the external material dialog.
18466 This is either an absolute name, or it is relative to the LyX document.
18469 \begin_layout Description
18470 \begin_inset Flex CharStyle:Code
18473 \begin_layout Plain Layout
18480 \begin_inset Flex CharStyle:Code
18483 \begin_layout Plain Layout
18489 (absolute name or relative to the LyX document).
18492 \begin_layout Description
18493 \begin_inset Flex CharStyle:Code
18496 \begin_layout Plain Layout
18502 The file path, relative to the master LyX document.
18505 \begin_layout Description
18506 \begin_inset Flex CharStyle:Code
18509 \begin_layout Plain Layout
18515 The file path, relative to the LyX document.
18518 \begin_layout Description
18519 \begin_inset Flex CharStyle:Code
18522 \begin_layout Plain Layout
18528 This macro will expand to the absolute path of the system directory.
18529 This is typically used to point to the various helper scripts that are
18533 \begin_layout Description
18534 \begin_inset Flex CharStyle:Code
18537 \begin_layout Plain Layout
18543 A name and full path to a temporary file which will be automatically deleted
18544 whenever the containing document is closed, or the external material insertion
18548 \begin_layout Standard
18549 All path macros contain a trailing directory separator, so you can construct
18551 \begin_inset space \thinspace{}
18555 \begin_inset space \space{}
18558 the absolute filename with
18559 \begin_inset Flex CharStyle:Code
18562 \begin_layout Plain Layout
18563 $$AbsPath$$Basename$$Extension
18571 \begin_layout Standard
18572 The macros above are substituted in all commands unless otherwise noted.
18574 \begin_inset Flex CharStyle:Code
18577 \begin_layout Plain Layout
18583 supports additionally the following substitutions if they are enabled by
18585 \begin_inset Flex CharStyle:Code
18588 \begin_layout Plain Layout
18595 \begin_inset Flex CharStyle:Code
18598 \begin_layout Plain Layout
18607 \begin_layout Description
18608 \begin_inset Flex CharStyle:Code
18611 \begin_layout Plain Layout
18617 The front part of the resize command.
18620 \begin_layout Description
18621 \begin_inset Flex CharStyle:Code
18624 \begin_layout Plain Layout
18630 The back part of the resize command.
18633 \begin_layout Description
18634 \begin_inset Flex CharStyle:Code
18637 \begin_layout Plain Layout
18643 The front part of the rotation command.
18646 \begin_layout Description
18647 \begin_inset Flex CharStyle:Code
18650 \begin_layout Plain Layout
18656 The back part of the rotation command.
18659 \begin_layout Standard
18660 The value string of the
18661 \begin_inset Flex CharStyle:Code
18664 \begin_layout Plain Layout
18670 command supports additionally the following substitutions if they are enabled
18672 \begin_inset Flex CharStyle:Code
18675 \begin_layout Plain Layout
18682 \begin_inset Flex CharStyle:Code
18685 \begin_layout Plain Layout
18694 \begin_layout Description
18695 \begin_inset Flex CharStyle:Code
18698 \begin_layout Plain Layout
18707 \begin_layout Description
18708 \begin_inset Flex CharStyle:Code
18711 \begin_layout Plain Layout
18720 \begin_layout Description
18721 \begin_inset Flex CharStyle:Code
18724 \begin_layout Plain Layout
18733 \begin_layout Description
18734 \begin_inset Flex CharStyle:Code
18737 \begin_layout Plain Layout
18743 The rotation option.
18746 \begin_layout Standard
18747 You may ask why there are so many path macros.
18748 There are mainly two reasons:
18751 \begin_layout Enumerate
18752 Relative and absolute file names should remain relative or absolute, respectivel
18754 Users may have reasons to prefer either form.
18755 Relative names are useful for portable documents that should work on different
18756 machines, for example.
18757 Absolute names may be required by some programs.
18760 \begin_layout Enumerate
18761 LaTeX treats relative file names differently than LyX and other programs
18762 in nested included files.
18763 For LyX, a relative file name is always relative to the document that contains
18765 For LaTeX, it is always relative to the master document.
18766 These two definitions are identical if you have only one document, but
18767 differ if you have a master document that includes part documents.
18768 That means that relative filenames must be transformed when presented to
18770 Fortunately LyX does this automatically for you if you choose the right
18774 \begin_layout Standard
18775 So which path macro should be used in new template definitions? The rule
18779 \begin_layout Itemize
18781 \begin_inset Flex CharStyle:Code
18784 \begin_layout Plain Layout
18790 if an absolute path is required.
18793 \begin_layout Itemize
18795 \begin_inset Flex CharStyle:Code
18798 \begin_layout Plain Layout
18799 $$AbsOrRelPathMaster
18804 if the substituted string is some kind of LaTeX input.
18807 \begin_layout Itemize
18809 \begin_inset Flex CharStyle:Code
18812 \begin_layout Plain Layout
18813 $$AbsOrRelPathParent
18818 in order to preserve the user's choice.
18821 \begin_layout Standard
18822 There are special cases where this rule does not work and e.
18823 \begin_inset space \thinspace{}
18827 \begin_inset space \space{}
18830 relative names are needed, but normally it will work just fine.
18831 One example for such a case is the command
18832 \begin_inset Flex CharStyle:Code
18835 \begin_layout Plain Layout
18836 ReferencedFile latex "$$AbsOrRelPathMaster$$Basename.pstex_t"
18841 in the XFig template above: We can't use the absolute name because the
18843 \begin_inset Flex CharStyle:Code
18846 \begin_layout Plain Layout
18852 files needs the relative name in order to rewrite the file content.
18855 \begin_layout Section
18856 Security discussion
18857 \begin_inset CommandInset label
18859 name "sec:Security-discussion"
18866 \begin_layout Standard
18867 The external material feature interfaces with a lot of external programs
18868 and does so automatically, so we have to consider the security implications
18870 In particular, since you have the option of including your own filenames
18871 and/or parameter strings and those are expanded into a command, it seems
18872 that it would be possible to create a malicious document which executes
18873 arbitrary commands when a user views or prints the document.
18874 This is something we definitely want to avoid.
18877 \begin_layout Standard
18878 However, since the external program commands are specified in the template
18879 configuration file only, there are no security issues if LyX is properly
18880 configured with safe templates only.
18881 This is so because the external programs are invoked with the
18882 \begin_inset Flex CharStyle:Code
18885 \begin_layout Plain Layout
18891 -system call rather than the
18892 \begin_inset Flex CharStyle:Code
18895 \begin_layout Plain Layout
18901 system-call, so it's not possible to execute arbitrary commands from the
18902 filename or parameter section via the shell.
18905 \begin_layout Standard
18906 This also implies that you are restricted in what command strings you can
18907 use in the external material templates.
18908 In particular, pipes and redirection are not readily available.
18909 This has to be so if LyX should remain safe.
18910 If you want to use some of the shell features, you should write a safe
18911 script to do this in a controlled manner, and then invoke the script from
18912 the command string.
18916 \begin_layout Standard
18917 It is possible to design a template that interacts directly with the shell,
18918 but since this would allow a malicious user to execute arbitrary commands
18919 by writing clever filenames and/or parameters, we generally recommend that
18920 you only use safe scripts that work with the
18921 \begin_inset Flex CharStyle:Code
18924 \begin_layout Plain Layout
18930 system call in a controlled manner.
18931 Of course, for use in a controlled environment, it can be tempting to just
18932 fall back to use ordinary shell scripts.
18933 If you do so, be aware that you
18937 provide an easily exploitable security hole in your system.
18938 Of course it stands to reason that such unsafe templates will never be
18939 included in the standard LyX distribution, although we do encourage people
18940 to submit new templates in the open source tradition.
18941 But LyX as shipped from the official distribution channels will never have
18945 \begin_layout Standard
18946 Including external material provides a lot of power, and you have to be
18947 careful not to introduce security hazards with this power.
18948 A subtle error in a single line in an innocent looking script can open
18949 the door to huge security problems.
18950 So if you do not fully understand the issues, we recommend that you consult
18951 a knowledgeable security professional or the LyX development team if you
18952 have any questions about whether a given template is safe or not.
18953 And do this before you use it in an uncontrolled environment.