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
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 Defines formats for use in the display of bibliographic information.
7648 \begin_inset CommandInset ref
7650 reference "sub:Citation-format-description"
7656 \begin_inset Quotes eld
7660 \begin_inset Flex CharStyle:Code
7663 \begin_layout Plain Layout
7670 \begin_inset Quotes erd
7676 \begin_layout Description
7677 \begin_inset Flex CharStyle:Code
7680 \begin_layout Plain Layout
7686 Describes various global options supported by the document class.
7688 \begin_inset space ~
7692 \begin_inset CommandInset ref
7694 reference "sub:ClassOptions"
7700 \begin_inset Quotes eld
7704 \begin_inset Flex CharStyle:Code
7707 \begin_layout Plain Layout
7714 \begin_inset Quotes erd
7720 \begin_layout Description
7721 \begin_inset Flex CharStyle:Code
7724 \begin_layout Plain Layout
7731 \begin_inset Flex CharStyle:Code
7734 \begin_layout Plain Layout
7743 \begin_inset Flex CharStyle:Code
7746 \begin_layout Plain Layout
7752 ] Whether the class should
7756 to having one or two columns.
7757 Can be changed in the
7758 \begin_inset Flex CharStyle:MenuItem
7761 \begin_layout Plain Layout
7762 Document\SpecialChar \menuseparator
7771 \begin_layout Description
7772 \begin_inset Flex CharStyle:Code
7775 \begin_layout Plain Layout
7782 \begin_inset Flex CharStyle:Code
7785 \begin_layout Plain Layout
7791 ] This sequence defines the properties for a counter.
7792 If the counter does not yet exist, it is created; if it does exist, it
7795 \begin_inset Quotes eld
7799 \begin_inset Flex CharStyle:Code
7802 \begin_layout Plain Layout
7809 \begin_inset Quotes erd
7813 \begin_inset Newline newline
7817 \begin_inset space ~
7821 \begin_inset CommandInset ref
7823 reference "sub:Counters"
7827 for details on counters.
7830 \begin_layout Description
7831 \begin_inset Flex CharStyle:Code
7834 \begin_layout Plain Layout
7840 Sets the default font used to display the document.
7842 \begin_inset space ~
7846 \begin_inset CommandInset ref
7848 reference "sub:Font-description"
7852 for how to declare fonts.
7854 \begin_inset Quotes eld
7858 \begin_inset Flex CharStyle:Code
7861 \begin_layout Plain Layout
7868 \begin_inset Quotes erd
7874 \begin_layout Description
7875 \begin_inset Flex CharStyle:Code
7878 \begin_layout Plain Layout
7885 \begin_inset Flex CharStyle:Code
7888 \begin_layout Plain Layout
7894 Specifies a module to be included by default with this document class.
7895 The module should be specified by filename without the
7896 \begin_inset Flex CharStyle:Code
7899 \begin_layout Plain Layout
7906 The user can still remove the module, but it will be active at the outset.
7907 (This applies only when new files are created, or when this class is chosen
7908 for an existing document.)
7911 \begin_layout Description
7912 \begin_inset Flex CharStyle:Code
7915 \begin_layout Plain Layout
7922 \begin_inset Flex CharStyle:Code
7925 \begin_layout Plain Layout
7931 ] This is the style that will be assigned to new paragraphs, usually
7932 \begin_inset Flex CharStyle:MenuItem
7935 \begin_layout Plain Layout
7942 This will default to the first defined style if not given, but you are
7943 encouraged to use this directive.
7946 \begin_layout Description
7947 \begin_inset Flex CharStyle:Code
7950 \begin_layout Plain Layout
7957 \begin_inset Flex CharStyle:Code
7960 \begin_layout Plain Layout
7966 ] This tag indicates that the module in question—which should be specified
7967 by filename without the
7968 \begin_inset Flex CharStyle:Code
7971 \begin_layout Plain Layout
7977 extension—cannot be used with this document class.
7978 This might be used in a journal-specific layout file to prevent, say, the
7980 \begin_inset Flex CharStyle:Code
7983 \begin_layout Plain Layout
7989 module that numbers theorems by section.
7994 be used in a module.
7995 Modules have their own way of excluding other modules (see
7996 \begin_inset CommandInset ref
7998 reference "sub:Layout-modules"
8005 \begin_layout Description
8006 \begin_inset Flex CharStyle:Code
8009 \begin_layout Plain Layout
8015 Defines a new float.
8017 \begin_inset space ~
8021 \begin_inset CommandInset ref
8023 reference "sub:Floats"
8029 \begin_inset Quotes eld
8033 \begin_inset Flex CharStyle:Code
8036 \begin_layout Plain Layout
8043 \begin_inset Quotes erd
8049 \begin_layout Description
8050 \begin_inset Flex CharStyle:Code
8053 \begin_layout Plain Layout
8059 Sets the information that will be output in the
8060 \begin_inset Flex CharStyle:Code
8063 \begin_layout Plain Layout
8069 block when this document class is output to XHTML.
8070 Note that this will completely override any prior
8071 \begin_inset Flex CharStyle:Code
8074 \begin_layout Plain Layout
8081 \begin_inset Flex CharStyle:Code
8084 \begin_layout Plain Layout
8092 \begin_inset Flex CharStyle:Code
8095 \begin_layout Plain Layout
8101 if you just want to add material to the preamble.) Must end with
8102 \begin_inset Quotes eld
8106 \begin_inset Flex CharStyle:Code
8109 \begin_layout Plain Layout
8116 \begin_inset Quotes erd
8122 \begin_layout Description
8123 \begin_inset Flex CharStyle:Code
8126 \begin_layout Plain Layout
8133 \begin_inset Flex CharStyle:Code
8136 \begin_layout Plain Layout
8142 ] The layout to use for the table of contents, bibliography, and so forth,
8143 when the document is output to HTML.
8144 For articles, this should normally be Section; for books, Chapter.
8145 If it is not given, then LyX will attempt to figure out which layout to
8149 \begin_layout Description
8150 \begin_inset Flex CharStyle:Code
8153 \begin_layout Plain Layout
8160 \begin_inset Flex CharStyle:Code
8163 \begin_layout Plain Layout
8169 ] Modifies the properties of the given counter.
8170 If the counter does not exist, the section is ignored.
8172 \begin_inset Quotes eld
8176 \begin_inset Flex CharStyle:Code
8179 \begin_layout Plain Layout
8186 \begin_inset Quotes erd
8190 \begin_inset Newline newline
8194 \begin_inset space ~
8198 \begin_inset CommandInset ref
8200 reference "sub:Counters"
8204 for details on counters.
8207 \begin_layout Description
8208 \begin_inset Flex CharStyle:Code
8211 \begin_layout Plain Layout
8218 \begin_inset Flex CharStyle:Code
8221 \begin_layout Plain Layout
8227 ] Modifies the properties of the given paragraph style.
8228 If the style does not exist, the section is ignored.
8230 \begin_inset Quotes eld
8234 \begin_inset Flex CharStyle:Code
8237 \begin_layout Plain Layout
8244 \begin_inset Quotes erd
8250 \begin_layout Description
8251 \begin_inset Flex CharStyle:Code
8254 \begin_layout Plain Layout
8260 As its name implies, this command allows you to include another layout
8261 definition file within yours to avoid duplicating commands.
8262 Common examples are the standard layout files, for example,
8263 \begin_inset Flex CharStyle:Code
8266 \begin_layout Plain Layout
8272 , which contains most of the basic layouts.
8275 \begin_layout Description
8276 \begin_inset Flex CharStyle:Code
8279 \begin_layout Plain Layout
8285 This section (re-)defines the layout of an inset.
8286 It can be applied to an existing inset or to a new, user-defined inset,
8287 e.g., a new character style.
8289 \begin_inset Quotes eld
8293 \begin_inset Flex CharStyle:Code
8296 \begin_layout Plain Layout
8303 \begin_inset Quotes erd
8307 \begin_inset Newline newline
8311 \begin_inset space ~
8315 \begin_inset CommandInset ref
8317 reference "sub:Flex-insets-and"
8321 for more information.
8325 \begin_layout Description
8326 \begin_inset Flex CharStyle:Code
8329 \begin_layout Plain Layout
8336 \begin_inset Flex CharStyle:Code
8339 \begin_layout Plain Layout
8345 ] A string that indicates the width of the left margin on the screen, for
8347 \begin_inset Quotes eld
8351 \begin_inset Quotes erd
8355 (Note that this is not a `length', like
8356 \begin_inset Quotes eld
8360 \begin_inset Quotes erd
8366 \begin_layout Description
8367 \begin_inset Flex CharStyle:Code
8370 \begin_layout Plain Layout
8376 This command deletes an existing float.
8377 This is particularly useful when you want to suppress a float that has
8378 been defined in an input file.
8381 \begin_layout Description
8382 \begin_inset Flex CharStyle:Code
8385 \begin_layout Plain Layout
8391 This command deletes an existing style.
8392 This is particularly useful when you want to suppress a style that has
8393 be defined in an input file.
8396 \begin_layout Description
8397 \begin_inset Flex CharStyle:Code
8400 \begin_layout Plain Layout
8406 A string indicating the file format (as defined in the Preferences dialog)
8407 produced by this class.
8408 It is mainly useful when
8409 \begin_inset Flex CharStyle:Code
8412 \begin_layout Plain Layout
8418 is `literate' and one wants to define a new type of literate document.
8419 This string is reset to `docbook', `latex', or `literate' when the correspondin
8421 \begin_inset Flex CharStyle:Code
8424 \begin_layout Plain Layout
8430 parameter is encountered.
8433 \begin_layout Description
8434 \begin_inset Flex CharStyle:Code
8437 \begin_layout Plain Layout
8443 A string indicating what sort of output documents using this class will
8445 At present, the options are: `docbook', `latex', and `literate'.
8448 \begin_layout Description
8449 \begin_inset Flex CharStyle:Code
8452 \begin_layout Plain Layout
8459 \begin_inset Flex CharStyle:Code
8462 \begin_layout Plain Layout
8471 \begin_inset Flex CharStyle:Code
8474 \begin_layout Plain Layout
8481 \begin_inset Flex CharStyle:Code
8484 \begin_layout Plain Layout
8490 ] The default pagestyle.
8491 Can be changed in the
8492 \begin_inset Flex CharStyle:MenuItem
8495 \begin_layout Plain Layout
8496 Document\SpecialChar \menuseparator
8505 \begin_layout Description
8506 \begin_inset Flex CharStyle:Code
8509 \begin_layout Plain Layout
8515 Sets the preamble for the LaTeX document.
8516 Note that this will completely override any prior
8517 \begin_inset Flex CharStyle:Code
8520 \begin_layout Plain Layout
8527 \begin_inset Flex CharStyle:Code
8530 \begin_layout Plain Layout
8538 \begin_inset Flex CharStyle:Code
8541 \begin_layout Plain Layout
8547 if you just want to add material to the preamble.) Must end with
8548 \begin_inset Quotes eld
8552 \begin_inset Flex CharStyle:Code
8555 \begin_layout Plain Layout
8562 \begin_inset Quotes erd
8568 \begin_layout Description
8569 \begin_inset Flex CharStyle:Code
8572 \begin_layout Plain Layout
8579 \begin_inset Flex CharStyle:Code
8582 \begin_layout Plain Layout
8589 \begin_inset Flex CharStyle:Code
8592 \begin_layout Plain Layout
8601 \begin_inset Flex CharStyle:Code
8604 \begin_layout Plain Layout
8610 ] Whether the class already provides the feature
8611 \begin_inset Flex CharStyle:Code
8614 \begin_layout Plain Layout
8621 A feature is in general the name of a package (
8622 \begin_inset Flex CharStyle:Code
8625 \begin_layout Plain Layout
8632 \begin_inset Flex CharStyle:Code
8635 \begin_layout Plain Layout
8641 , \SpecialChar \ldots{}
8643 \begin_inset Flex CharStyle:Code
8646 \begin_layout Plain Layout
8653 \begin_inset Flex CharStyle:Code
8656 \begin_layout Plain Layout
8662 ,\SpecialChar \ldots{}
8663 ); the complete list of supported features is unfortunately not documented
8664 outside the LyX source code—but see
8665 \begin_inset Flex CharStyle:Code
8668 \begin_layout Plain Layout
8674 if you're interested.
8676 \begin_inset Flex CharStyle:MenuItem
8679 \begin_layout Plain Layout
8680 Help\SpecialChar \menuseparator
8686 also gives an overview of the supported packages.
8689 \begin_layout Description
8690 \begin_inset Flex CharStyle:Code
8693 \begin_layout Plain Layout
8700 \begin_inset Flex CharStyle:Code
8703 \begin_layout Plain Layout
8709 ] Indicates that this layout provides the functionality of the module mentioned,
8710 which should be specified by the filename without the
8711 \begin_inset Flex CharStyle:Code
8714 \begin_layout Plain Layout
8721 This will typically be used if the layout includes the module directly,
8722 rather than using the
8723 \begin_inset Flex CharStyle:Code
8726 \begin_layout Plain Layout
8732 tag to indicate that it ought to be used.
8733 It could also be used in a module that provided an alternate implementation
8734 of the same functionality.
8737 \begin_layout Description
8738 \begin_inset Flex CharStyle:Code
8741 \begin_layout Plain Layout
8748 \begin_inset Flex CharStyle:Code
8751 \begin_layout Plain Layout
8757 ] Whether the class requires the feature
8758 \begin_inset Flex CharStyle:Code
8761 \begin_layout Plain Layout
8768 Multiple features must be separated by commas.
8769 Note that you can only request supported features.
8771 \begin_inset Flex CharStyle:Code
8774 \begin_layout Plain Layout
8780 for a list of these.)
8783 \begin_layout Description
8784 \begin_inset Flex CharStyle:Code
8787 \begin_layout Plain Layout
8793 A string that indicates the width of the right margin on the screen, for
8795 \begin_inset Quotes eld
8799 \begin_inset Quotes erd
8805 \begin_layout Description
8806 \begin_inset Flex CharStyle:Code
8809 \begin_layout Plain Layout
8815 Sets which divisions get numbered.
8817 \begin_inset Flex CharStyle:Code
8820 \begin_layout Plain Layout
8829 \begin_layout Description
8830 \begin_inset Flex CharStyle:Code
8833 \begin_layout Plain Layout
8840 \begin_inset Flex CharStyle:Code
8843 \begin_layout Plain Layout
8852 \begin_inset Flex CharStyle:Code
8855 \begin_layout Plain Layout
8861 ] Whether the class-default should be printing on one or both sides of the
8863 Can be changed in the
8864 \begin_inset Flex CharStyle:MenuItem
8867 \begin_layout Plain Layout
8868 Document\SpecialChar \menuseparator
8877 \begin_layout Description
8878 \begin_inset Flex CharStyle:Code
8881 \begin_layout Plain Layout
8887 This sequence defines a paragraph style.
8888 If the style does not yet exist, it is created; if it does exist, its parameter
8891 \begin_inset Quotes eld
8895 \begin_inset Flex CharStyle:Code
8898 \begin_layout Plain Layout
8905 \begin_inset Quotes erd
8909 \begin_inset Newline newline
8913 \begin_inset space ~
8917 \begin_inset CommandInset ref
8919 reference "sub:Paragraph-Styles"
8923 for details on paragraph styles.
8926 \begin_layout Description
8927 \begin_inset Flex CharStyle:Code
8930 \begin_layout Plain Layout
8937 \begin_inset Flex CharStyle:Code
8940 \begin_layout Plain Layout
8946 ] The name of the command or environment to be used with
8947 \begin_inset Flex CharStyle:Code
8950 \begin_layout Plain Layout
8959 \begin_layout Description
8960 \begin_inset Flex CharStyle:Code
8963 \begin_layout Plain Layout
8970 \begin_inset Flex CharStyle:Code
8973 \begin_layout Plain Layout
8982 \begin_inset Flex CharStyle:Code
8985 \begin_layout Plain Layout
8991 ] Indicates what kind of markup is used to define the title of a document.
8993 \begin_inset Flex CharStyle:Code
8996 \begin_layout Plain Layout
9002 means that the macro with name
9003 \begin_inset Flex CharStyle:Code
9006 \begin_layout Plain Layout
9012 will be inserted after the last layout which has
9013 \begin_inset Quotes eld
9017 \begin_inset Flex CharStyle:Code
9020 \begin_layout Plain Layout
9027 \begin_inset Quotes erd
9032 \begin_inset Flex CharStyle:Code
9035 \begin_layout Plain Layout
9041 corresponds to the case where the block of paragraphs which have
9042 \begin_inset Quotes eld
9046 \begin_inset Flex CharStyle:Code
9049 \begin_layout Plain Layout
9056 \begin_inset Quotes erd
9059 should be enclosed into the
9060 \begin_inset Flex CharStyle:Code
9063 \begin_layout Plain Layout
9072 \begin_layout Description
9073 \begin_inset Flex CharStyle:Code
9076 \begin_layout Plain Layout
9082 Sets which divisions are included in the table of contents.
9084 \begin_inset Flex CharStyle:Code
9087 \begin_layout Plain Layout
9096 \begin_layout Subsection
9097 \begin_inset Flex CharStyle:Code
9100 \begin_layout Plain Layout
9107 \begin_inset CommandInset label
9109 name "sub:ClassOptions"
9116 \begin_layout Standard
9118 \begin_inset Flex CharStyle:Code
9121 \begin_layout Plain Layout
9127 section can contain the following entries:
9130 \begin_layout Description
9131 \begin_inset Flex CharStyle:Code
9134 \begin_layout Plain Layout
9141 \begin_inset Flex CharStyle:Code
9144 \begin_layout Plain Layout
9150 ] The list of available font sizes for the document's main font, separated
9152 \begin_inset Quotes eld
9156 \begin_inset Flex CharStyle:Code
9159 \begin_layout Plain Layout
9166 \begin_inset Quotes erd
9172 \begin_layout Description
9173 \begin_inset Flex CharStyle:Code
9176 \begin_layout Plain Layout
9182 Used to set the DTD line with XML-based output classes.
9184 \begin_inset space \thinspace{}
9188 \begin_inset Quotes eld
9191 -//OASIS//DTD DocBook V4.2//EN
9192 \begin_inset Quotes erd
9198 \begin_layout Description
9199 \begin_inset Flex CharStyle:Code
9202 \begin_layout Plain Layout
9209 \begin_inset Flex CharStyle:Code
9212 \begin_layout Plain Layout
9213 string="empty|plain|headings|fancy"
9218 ] The list of available page styles, separated by
9219 \begin_inset Quotes eld
9223 \begin_inset Flex CharStyle:Code
9226 \begin_layout Plain Layout
9233 \begin_inset Quotes erd
9239 \begin_layout Description
9240 \begin_inset Flex CharStyle:Code
9243 \begin_layout Plain Layout
9250 \begin_inset Flex CharStyle:Code
9253 \begin_layout Plain Layout
9259 ] Some document class options, separated by a comma, that will be added
9260 to the optional part of the
9261 \begin_inset Flex CharStyle:Code
9264 \begin_layout Plain Layout
9275 \begin_layout Standard
9277 \begin_inset Flex CharStyle:Code
9280 \begin_layout Plain Layout
9286 section must end with
9287 \begin_inset Quotes eld
9291 \begin_inset Flex CharStyle:Code
9294 \begin_layout Plain Layout
9301 \begin_inset Quotes erd
9307 \begin_layout Subsection
9309 \begin_inset CommandInset label
9311 name "sub:Paragraph-Styles"
9318 \begin_layout Standard
9319 A paragraph style description looks like this:
9323 \begin_layout Plain Layout
9324 Note that this will either define a new layout or modify an existing one.
9332 \begin_layout LyX-Code
9339 \begin_layout LyX-Code
9343 \begin_layout LyX-Code
9347 \begin_layout Standard
9348 where the following commands are allowed:
9351 \begin_layout Description
9352 \begin_inset Flex CharStyle:Code
9355 \begin_layout Plain Layout
9362 \begin_inset Flex CharStyle:Code
9365 \begin_layout Plain Layout
9370 , left, right, center
9375 ] Paragraph alignment.
9378 \begin_layout Description
9379 \begin_inset Flex CharStyle:Code
9382 \begin_layout Plain Layout
9389 \begin_inset Flex CharStyle:Code
9392 \begin_layout Plain Layout
9397 , left, right, center
9402 ] A comma separated list of permitted alignments.
9403 (Some LaTeX styles prohibit certain alignments, since those wouldn't make
9405 For example a right-aligned or centered enumeration isn't possible.)
9408 \begin_layout Description
9409 \begin_inset Flex CharStyle:Code
9412 \begin_layout Plain Layout
9418 Language dependent information to be included in the LaTeX preamble when
9420 Note that this will completely override any prior
9421 \begin_inset Flex CharStyle:Code
9424 \begin_layout Plain Layout
9432 \begin_inset Quotes eld
9436 \begin_inset Flex CharStyle:Code
9439 \begin_layout Plain Layout
9446 \begin_inset Quotes erd
9450 The contents of this tag will occur once in the LaTeX preamble for each
9451 language used by the document.
9452 Each time, the following substitutions are made:
9456 \begin_layout Itemize
9457 \begin_inset Flex CharStyle:Code
9460 \begin_layout Plain Layout
9466 is replaced by the language name (as used by the babel package).
9469 \begin_layout Itemize
9471 \begin_inset Quotes eld
9475 \begin_inset Quotes erd
9479 \begin_inset Flex CharStyle:Code
9482 \begin_layout Plain Layout
9488 replaces its argument by the translation of the argument to the current
9492 \begin_layout Standard
9493 This preamble snippet will only be used if the document contains more than
9494 one language and the babel package is used.
9498 \begin_layout Description
9499 \begin_inset Flex CharStyle:Code
9502 \begin_layout Plain Layout
9509 \begin_inset Flex CharStyle:Code
9512 \begin_layout Plain Layout
9522 \begin_layout Plain Layout
9523 Note that a `float' here is a real number, such as: 1.5.
9528 The vertical space with which the last of a chain of paragraphs with this
9529 layout is separated from the following paragraph.
9530 If the next paragraph has another layout, the separations are not simply
9531 added, but the maximum is taken.
9534 \begin_layout Description
9535 \begin_inset Flex CharStyle:Code
9538 \begin_layout Plain Layout
9545 \begin_inset Flex CharStyle:Code
9548 \begin_layout Plain Layout
9554 The category for this style.
9555 This is used to group related styles in the Layout combobox on the toolbar.
9556 Any string can be used, but you may want to use existing categories with
9561 \begin_layout Description
9562 \begin_inset Flex CharStyle:Code
9565 \begin_layout Plain Layout
9571 Depth of XML command.
9572 Used only with XML-type formats.
9575 \begin_layout Description
9576 \begin_inset Flex CharStyle:Code
9579 \begin_layout Plain Layout
9586 \begin_inset CommandInset label
9588 name "des:CopyStyle"
9593 \begin_inset Flex CharStyle:Code
9596 \begin_layout Plain Layout
9602 Copies all the features of an existing style into the current one.
9606 \begin_layout Description
9607 \begin_inset Flex CharStyle:Code
9610 \begin_layout Plain Layout
9616 The name of a style whose preamble should be output
9621 This allows to ensure some ordering of the preamble snippets when macros
9622 definitions depend on one another.
9626 \begin_layout Plain Layout
9627 Note that, besides that functionality, there is no way to ensure any ordering
9629 The ordering that you see in a given version of LyX may change without
9630 warning in later versions.
9638 \begin_layout Description
9639 \begin_inset Flex CharStyle:Code
9642 \begin_layout Plain Layout
9649 \begin_inset Flex CharStyle:Code
9652 \begin_layout Plain Layout
9657 , Box, Filled_Box, Static
9662 ] The type of label that stands at the end of the paragraph (or sequence
9664 \begin_inset Flex CharStyle:Code
9667 \begin_layout Plain Layout
9674 \begin_inset Flex CharStyle:Code
9677 \begin_layout Plain Layout
9684 \begin_inset Flex CharStyle:Code
9687 \begin_layout Plain Layout
9694 \begin_inset Flex CharStyle:Code
9697 \begin_layout Plain Layout
9705 \begin_inset Flex CharStyle:Code
9708 \begin_layout Plain Layout
9715 \begin_inset Quotes eld
9719 \begin_inset Quotes erd
9723 \begin_inset Flex CharStyle:Code
9726 \begin_layout Plain Layout
9733 \begin_inset Flex CharStyle:Code
9736 \begin_layout Plain Layout
9737 \begin_inset space ~
9746 \begin_inset space ~
9749 black) square suitable for end of proof markers,
9750 \begin_inset Flex CharStyle:Code
9753 \begin_layout Plain Layout
9759 is an explicit text string.
9762 \begin_layout Description
9763 \begin_inset Flex CharStyle:Code
9766 \begin_layout Plain Layout
9773 \begin_inset Flex CharStyle:Code
9776 \begin_layout Plain Layout
9782 ] The string used for a label with a
9783 \begin_inset Flex CharStyle:Code
9786 \begin_layout Plain Layout
9793 \begin_inset Flex CharStyle:Code
9796 \begin_layout Plain Layout
9806 \begin_layout Description
9807 \begin_inset Flex CharStyle:Code
9810 \begin_layout Plain Layout
9817 \begin_inset Flex CharStyle:Code
9820 \begin_layout Plain Layout
9831 \begin_inset Flex CharStyle:Code
9834 \begin_layout Plain Layout
9843 \begin_layout Description
9844 \begin_inset Flex CharStyle:Code
9847 \begin_layout Plain Layout
9854 \begin_inset Flex CharStyle:Code
9857 \begin_layout Plain Layout
9867 ] With this parameter the
9868 \begin_inset Flex CharStyle:MenuItem
9871 \begin_layout Plain Layout
9878 \begin_inset Quotes eld
9881 Vertical space above
9882 \begin_inset Quotes erd
9886 \begin_inset Flex CharStyle:MenuItem
9889 \begin_layout Plain Layout
9890 Edit\SpecialChar \menuseparator
9892 \begin_inset space ~
9900 dialog can be set when initializing a paragraph with this style.
9904 \begin_layout Plain Layout
9907 Note from Jean-Marc:
9909 I'm not sure that this setting has much use, and it should probably be
9910 removed in later versions.
9918 \begin_layout Description
9919 \begin_inset Flex CharStyle:Code
9922 \begin_layout Plain Layout
9928 The font used for both the text body
9934 \begin_inset space ~
9938 \begin_inset CommandInset ref
9940 reference "sub:Font-description"
9945 Note that defining this font automatically defines the
9946 \begin_inset Flex CharStyle:Code
9949 \begin_layout Plain Layout
9956 So you should define this one first if you also want to define
9957 \begin_inset Flex CharStyle:Code
9960 \begin_layout Plain Layout
9969 \begin_layout Description
9970 \begin_inset Flex CharStyle:Code
9973 \begin_layout Plain Layout
9980 \begin_inset CommandInset label
9982 name "des:FreeSpacing"
9987 \begin_inset Flex CharStyle:Code
9990 \begin_layout Plain Layout
9999 \begin_inset Flex CharStyle:Code
10002 \begin_layout Plain Layout
10008 ] Usually LyX doesn't allow you to insert more than one space between words,
10009 since a space is considered as the separation between two words, not a
10010 character or symbol of its own.
10011 This is a very fine thing but sometimes annoying, for example, when typing
10012 program code or plain LaTeX code.
10014 \begin_inset Flex CharStyle:Code
10017 \begin_layout Plain Layout
10024 Note that LyX will create protected blanks for the additional blanks when
10025 in another mode than LaTeX-mode.
10028 \begin_layout Description
10029 \begin_inset Flex CharStyle:Code
10032 \begin_layout Plain Layout
10038 These tags are used with XHTML output.
10040 \begin_inset CommandInset ref
10041 LatexCommand prettyref
10042 reference "sub:Paragraph-Style-XHTML"
10049 \begin_layout Description
10050 \begin_inset Flex CharStyle:Code
10053 \begin_layout Plain Layout
10059 [[FIXME]] (Used only with XML-type formats.)
10062 \begin_layout Description
10063 \begin_inset Flex CharStyle:Code
10066 \begin_layout Plain Layout
10073 \begin_inset Flex CharStyle:Code
10076 \begin_layout Plain Layout
10082 If 1, marks the layout as to be included in the document preamble rather
10083 than in the document body.
10084 This is useful for document classes that want such information as the title
10085 and author to appear in the preamble.
10088 \begin_layout Description
10089 \begin_inset Flex CharStyle:Code
10092 \begin_layout Plain Layout
10099 \begin_inset Flex CharStyle:Code
10102 \begin_layout Plain Layout
10108 If 1, marks the layout as being part of a title block (see also the
10109 \begin_inset Flex CharStyle:Code
10112 \begin_layout Plain Layout
10119 \begin_inset Flex CharStyle:Code
10122 \begin_layout Plain Layout
10131 \begin_layout Description
10132 \begin_inset Flex CharStyle:Code
10135 \begin_layout Plain Layout
10142 \begin_inset Flex CharStyle:Code
10145 \begin_layout Plain Layout
10151 ] This provides extra space between paragraphs that have the same layout.
10152 If you put other layouts into an environment, each is separated with the
10154 \begin_inset Flex CharStyle:Code
10157 \begin_layout Plain Layout
10164 But the whole items of the environment are additionally separated with
10166 \begin_inset Flex CharStyle:Code
10169 \begin_layout Plain Layout
10176 Note that this is a
10181 \begin_layout Description
10182 \begin_inset Flex CharStyle:Code
10185 \begin_layout Plain Layout
10191 [[FIXME]] (Used only with XML-type formats.)
10194 \begin_layout Description
10195 \begin_inset Flex CharStyle:Code
10198 \begin_layout Plain Layout
10205 \begin_inset CommandInset label
10207 name "des:KeepEmpty"
10212 \begin_inset Flex CharStyle:Code
10215 \begin_layout Plain Layout
10224 \begin_inset Flex CharStyle:Code
10227 \begin_layout Plain Layout
10233 ] Usually LyX does not allow you to leave a paragraph empty, since it would
10234 lead to empty LaTeX output.
10235 There are some cases where this could be desirable however: in a letter
10236 template, the required fields can be provided as empty fields, so that
10237 people do not forget them; in some special classes, a layout can be used
10238 as some kind of break, which does not contain actual text.
10241 \begin_layout Description
10242 \begin_inset Flex CharStyle:Code
10245 \begin_layout Plain Layout
10251 [float=0] The vertical space between the label and the text body.
10252 Only used for labels that are above the text body (
10253 \begin_inset Flex CharStyle:Code
10256 \begin_layout Plain Layout
10263 \begin_inset Flex CharStyle:Code
10266 \begin_layout Plain Layout
10267 Centered_Top_Environment
10275 \begin_layout Description
10276 \begin_inset Flex CharStyle:Code
10279 \begin_layout Plain Layout
10286 \begin_inset Flex CharStyle:Code
10289 \begin_layout Plain Layout
10296 \begin_inset Newline newline
10299 The name of the counter for automatic numbering.
10301 \begin_inset Newline newline
10309 \begin_inset Flex CharStyle:Code
10312 \begin_layout Plain Layout
10319 \begin_inset Flex CharStyle:Code
10322 \begin_layout Plain Layout
10329 In that case, the counter will be stepped each time the layout appears.
10331 \begin_inset Newline newline
10339 \begin_inset Flex CharStyle:Code
10342 \begin_layout Plain Layout
10349 \begin_inset Flex CharStyle:Code
10352 \begin_layout Plain Layout
10358 , though this case is a bit complicated.
10359 Suppose you declare
10360 \begin_inset Quotes eld
10364 \begin_inset Flex CharStyle:Code
10367 \begin_layout Plain Layout
10368 LabelCounter myenum
10374 \begin_inset Quotes erd
10378 Then the actual counters used are
10379 \begin_inset Flex CharStyle:Code
10382 \begin_layout Plain Layout
10389 \begin_inset Flex CharStyle:Code
10392 \begin_layout Plain Layout
10399 \begin_inset Flex CharStyle:Code
10402 \begin_layout Plain Layout
10409 \begin_inset Flex CharStyle:Code
10412 \begin_layout Plain Layout
10418 , much as in LaTeX.
10419 These counters must all be declared separately.
10420 \begin_inset Newline newline
10424 \begin_inset CommandInset ref
10426 reference "sub:Counters"
10430 for details on counters.
10433 \begin_layout Description
10434 \begin_inset Flex CharStyle:Code
10437 \begin_layout Plain Layout
10443 The font used for the label.
10445 \begin_inset space ~
10449 \begin_inset CommandInset ref
10451 reference "sub:Font-description"
10458 \begin_layout Description
10459 \begin_inset Flex CharStyle:Code
10462 \begin_layout Plain Layout
10468 Text that indicates how far a label should be indented.
10471 \begin_layout Description
10472 \begin_inset Flex CharStyle:Code
10475 \begin_layout Plain Layout
10482 \begin_inset Flex CharStyle:Code
10485 \begin_layout Plain Layout
10491 ] The horizontal space between the label and the text body.
10492 Only used for labels that are not above the text body.
10495 \begin_layout Description
10496 \begin_inset Flex CharStyle:Code
10499 \begin_layout Plain Layout
10506 \begin_inset Flex CharStyle:Code
10509 \begin_layout Plain Layout
10515 ] The string used for a label with a
10516 \begin_inset Flex CharStyle:Code
10519 \begin_layout Plain Layout
10527 \begin_inset Flex CharStyle:Code
10530 \begin_layout Plain Layout
10536 is set, this string can be contain the special formatting commands described
10538 \begin_inset CommandInset ref
10540 reference "sub:Counters"
10548 \begin_layout Plain Layout
10549 For the sake of backwards compatibility, the string
10550 \begin_inset Flex CharStyle:Code
10553 \begin_layout Plain Layout
10563 will be replaced by the expanded
10564 \begin_inset Flex CharStyle:Code
10567 \begin_layout Plain Layout
10574 \begin_inset Flex CharStyle:Code
10577 \begin_layout Plain Layout
10586 This feature is now obsolete and should be replaced by the mechanisms of
10588 \begin_inset CommandInset ref
10590 reference "sub:Counters"
10602 \begin_layout Description
10603 \begin_inset Flex CharStyle:Code
10606 \begin_layout Plain Layout
10607 LabelStringAppendix
10613 \begin_inset Flex CharStyle:Code
10616 \begin_layout Plain Layout
10622 ] This is used inside the appendix instead of
10623 \begin_inset Flex CharStyle:Code
10626 \begin_layout Plain Layout
10634 \begin_inset Flex CharStyle:Code
10637 \begin_layout Plain Layout
10644 \begin_inset Flex CharStyle:Code
10647 \begin_layout Plain Layout
10648 LabelStringAppendix
10656 \begin_layout Description
10657 \begin_inset Flex CharStyle:Code
10660 \begin_layout Plain Layout
10666 [FIXME] (Used only with XML-type formats.)
10669 \begin_layout Description
10670 \begin_inset Flex CharStyle:Code
10673 \begin_layout Plain Layout
10680 \begin_inset Flex CharStyle:Code
10683 \begin_layout Plain Layout
10688 , Manual, Static, Top_Environment, Centered_Top_Environment, Counter, Sensitive,
10689 Enumerate, Itemize, Bibliography
10698 \begin_layout Itemize
10699 \begin_inset Flex CharStyle:Code
10702 \begin_layout Plain Layout
10708 means the label is the very first word (up to the first real blank).
10709 Use protected spaces (like
10710 \begin_inset space ~
10713 that one) if you want more than one word as the label.
10717 \begin_layout Itemize
10718 \begin_inset Flex CharStyle:Code
10721 \begin_layout Plain Layout
10727 means the label is simply whatever
10728 \begin_inset Flex CharStyle:Code
10731 \begin_layout Plain Layout
10738 Note that this really is `static'.
10741 \begin_layout Itemize
10742 \begin_inset Flex CharStyle:Code
10745 \begin_layout Plain Layout
10752 \begin_inset Flex CharStyle:Code
10755 \begin_layout Plain Layout
10756 Centered_Top_Environment
10761 are special cases of
10762 \begin_inset Flex CharStyle:Code
10765 \begin_layout Plain Layout
10772 The label will be printed above the paragraph, but only at the top of an
10773 environment or the top of a chain of paragraphs with this layout.
10774 This might be used with the
10775 \begin_inset Flex CharStyle:MenuItem
10778 \begin_layout Plain Layout
10784 layout, for example.
10787 \begin_layout Itemize
10788 \begin_inset Flex CharStyle:Code
10791 \begin_layout Plain Layout
10797 is a special case for the caption-labels
10798 \begin_inset Quotes eld
10802 \begin_inset Quotes erd
10806 \begin_inset Quotes eld
10810 \begin_inset Quotes erd
10815 \begin_inset Flex CharStyle:Code
10818 \begin_layout Plain Layout
10824 means the (hardcoded) label string depends on the kind of float: It is
10825 hardcoded to be `FloatType N', where N is the value of the counter associated
10829 \begin_layout Itemize
10831 \begin_inset Flex CharStyle:Code
10834 \begin_layout Plain Layout
10840 label type defines automatically numbered labels.
10842 \begin_inset Flex CharStyle:Code
10845 \begin_layout Plain Layout
10851 will be expanded to resolve any counter references it contains: For example,
10853 \begin_inset Quotes eld
10857 \begin_inset Flex CharStyle:Code
10860 \begin_layout Plain Layout
10871 \begin_inset Quotes erd
10876 \begin_inset CommandInset ref
10878 reference "sub:Counters"
10882 for more information on counters.
10885 \begin_layout Itemize
10886 \begin_inset Flex CharStyle:Code
10889 \begin_layout Plain Layout
10895 produces the usual sort of enumeration labels.
10896 At present, it is hardcoded to use Arabic numerals, lowercase letters,
10897 small Roman numerals, and uppercase letters for the four possible depths.
10900 \begin_layout Itemize
10901 \begin_inset Flex CharStyle:Code
10904 \begin_layout Plain Layout
10910 produces various bullets at the different levels.
10911 It is also hardcoded.
10914 \begin_layout Itemize
10915 \begin_inset Flex CharStyle:Code
10918 \begin_layout Plain Layout
10924 is used internally by LyX and should be used only with
10925 \begin_inset Flex CharStyle:Code
10928 \begin_layout Plain Layout
10929 LatexType BibEnvironment
10938 \begin_layout Description
10939 \begin_inset Flex CharStyle:Code
10942 \begin_layout Plain Layout
10949 \begin_inset Flex CharStyle:Code
10952 \begin_layout Plain Layout
10958 , but this preamble snippet occurs independently from the babel package,
10959 and only for the document language.
10961 \begin_inset Quotes eld
10965 \begin_inset Flex CharStyle:Code
10968 \begin_layout Plain Layout
10975 \begin_inset Quotes erd
10982 \begin_layout Standard
10983 If the style defines text that appears in the typeset document, it may use
10985 \begin_inset Flex CharStyle:Code
10988 \begin_layout Plain Layout
10995 \begin_inset Flex CharStyle:Code
10998 \begin_layout Plain Layout
11004 to support non-english and even multilanguage documents correctly.
11005 The following excerpt (from the
11006 \begin_inset Flex CharStyle:Code
11009 \begin_layout Plain Layout
11015 file) shows how this works:
11018 \begin_layout LyX-Code
11022 \begin_layout LyX-Code
11025 theoremstyle{remark}
11028 \begin_layout LyX-Code
11031 newtheorem{claim}[thm]{
11038 \begin_layout LyX-Code
11042 \begin_layout LyX-Code
11046 \begin_layout LyX-Code
11051 claimname}{_(Claim)}
11054 \begin_layout LyX-Code
11058 \begin_layout LyX-Code
11062 \begin_layout LyX-Code
11066 \begin_layout LyX-Code
11075 claimname}{_(Claim)}}
11078 \begin_layout LyX-Code
11082 \begin_layout Standard
11083 The key to correct translation of the user visible text is the definition
11085 \begin_inset Flex CharStyle:Code
11088 \begin_layout Plain Layout
11096 in the language preamble.
11097 This command holds the name of the theorem that will appear in the output.
11099 \begin_inset Flex CharStyle:Code
11102 \begin_layout Plain Layout
11108 then uses the commands offered by the babel package to redefine
11109 \begin_inset Flex CharStyle:Code
11112 \begin_layout Plain Layout
11120 for each used language in multilanguage documents.
11124 \begin_layout Description
11125 \begin_inset Flex CharStyle:Code
11128 \begin_layout Plain Layout
11134 The name of the corresponding LaTeX stuff.
11135 Either the environment or command name.
11138 \begin_layout Description
11139 \begin_inset Flex CharStyle:Code
11142 \begin_layout Plain Layout
11148 An optional parameter for the corresponding
11149 \begin_inset Flex CharStyle:Code
11152 \begin_layout Plain Layout
11159 This parameter cannot be changed from within LyX.
11162 \begin_layout Description
11163 \begin_inset Flex CharStyle:Code
11166 \begin_layout Plain Layout
11173 \begin_inset CommandInset label
11175 name "des:LatexType"
11180 \begin_inset Flex CharStyle:Code
11183 \begin_layout Plain Layout
11188 , Command, Environment, Item_Environment,
11194 \begin_inset Flex CharStyle:Code
11197 \begin_layout Plain Layout
11198 List_Environment, Bib_Environment
11203 ] How the layout should be translated into LaTeX.
11207 \begin_layout Plain Layout
11208 \begin_inset Flex CharStyle:Code
11211 \begin_layout Plain Layout
11217 is perhaps a bit misleading, since these rules apply to SGML classes, too.
11218 Visit the SGML class files for specific examples.
11227 \begin_layout Itemize
11228 \begin_inset Flex CharStyle:Code
11231 \begin_layout Plain Layout
11237 means nothing special.
11241 \begin_layout Itemize
11242 \begin_inset Flex CharStyle:Code
11245 \begin_layout Plain Layout
11252 \begin_inset Flex CharStyle:Code
11255 \begin_layout Plain Layout
11262 {\SpecialChar \ldots{}
11271 \begin_layout Itemize
11272 \begin_inset Flex CharStyle:Code
11275 \begin_layout Plain Layout
11282 \begin_inset Flex CharStyle:Code
11285 \begin_layout Plain Layout
11292 }\SpecialChar \ldots{}
11308 \begin_layout Itemize
11309 \begin_inset Flex CharStyle:Code
11312 \begin_layout Plain Layout
11319 \begin_inset Flex CharStyle:Code
11322 \begin_layout Plain Layout
11329 \begin_inset Flex CharStyle:Code
11332 \begin_layout Plain Layout
11340 is generated for each paragraph of this environment.
11344 \begin_layout Itemize
11345 \begin_inset Flex CharStyle:Code
11348 \begin_layout Plain Layout
11355 \begin_inset Flex CharStyle:Code
11358 \begin_layout Plain Layout
11365 \begin_inset Flex CharStyle:Code
11368 \begin_layout Plain Layout
11374 is passed as an argument to the environment.
11376 \begin_inset Flex CharStyle:Code
11379 \begin_layout Plain Layout
11385 can be defined in the
11386 \begin_inset Flex CharStyle:MenuItem
11389 \begin_layout Plain Layout
11394 ayout\SpecialChar \menuseparator
11408 \begin_layout Standard
11409 Putting the last few things together, the LaTeX output will be either:
11412 \begin_layout LyX-Code
11415 latexname[latexparam]{\SpecialChar \ldots{}
11419 \begin_layout Standard
11423 \begin_layout LyX-Code
11426 begin{latexname}[latexparam] \SpecialChar \ldots{}
11432 \begin_layout Standard
11433 depending upon the LaTeX type.
11437 \begin_layout Description
11438 \begin_inset Flex CharStyle:Code
11441 \begin_layout Plain Layout
11448 \begin_inset Flex CharStyle:Code
11451 \begin_layout Plain Layout
11457 ] If you put layouts into environments, the leftmargins are not simply added,
11458 but added with a factor
11459 \begin_inset Formula $\frac{4}{depth+4}$
11463 Note that this parameter is also used when the margin is defined as
11464 \begin_inset Flex CharStyle:Code
11467 \begin_layout Plain Layout
11474 \begin_inset Flex CharStyle:Code
11477 \begin_layout Plain Layout
11484 Then it is added to the manual or dynamic margin.
11486 \begin_inset Newline newline
11489 The argument is passed as a string.
11491 \begin_inset Quotes eld
11495 \begin_inset Flex CharStyle:Code
11498 \begin_layout Plain Layout
11505 \begin_inset Quotes erd
11508 means that the paragraph is indented with the width of
11509 \begin_inset Quotes eld
11513 \begin_inset Flex CharStyle:Code
11516 \begin_layout Plain Layout
11523 \begin_inset Quotes erd
11526 in the normal font.
11527 You can get a negative width by prefixing the string with
11528 \begin_inset Quotes eld
11532 \begin_inset Flex CharStyle:Code
11535 \begin_layout Plain Layout
11542 \begin_inset Quotes erd
11546 This way was chosen so that the look is the same with each used screen
11551 \begin_layout Description
11552 \begin_inset Flex CharStyle:Code
11555 \begin_layout Plain Layout
11562 \begin_inset Flex CharStyle:Code
11565 \begin_layout Plain Layout
11570 , Manual, Dynamic, First_Dynamic, Right_Address_Box
11576 \begin_inset Newline newline
11579 The kind of margin that the layout has on the left side.
11581 \begin_inset Flex CharStyle:Code
11584 \begin_layout Plain Layout
11590 just means a fixed margin.
11592 \begin_inset Flex CharStyle:Code
11595 \begin_layout Plain Layout
11601 means that the left margin depends on the string entered in the
11602 \begin_inset Flex CharStyle:MenuItem
11605 \begin_layout Plain Layout
11606 Edit\SpecialChar \menuseparator
11608 \begin_inset space ~
11617 This is used to typeset nice lists without tabulators.
11619 \begin_inset Flex CharStyle:Code
11622 \begin_layout Plain Layout
11628 means that the margin depends on the size of the label.
11629 This is used for automatic enumerated headlines.
11630 It is obvious that the headline
11631 \begin_inset Quotes eld
11634 5.4.3.2.1 Very long headline
11635 \begin_inset Quotes erd
11638 must have a wider left margin (as wide as
11639 \begin_inset Quotes eld
11643 \begin_inset Quotes erd
11646 plus the space) than
11647 \begin_inset Quotes eld
11650 3.2 Very long headline
11651 \begin_inset Quotes erd
11655 \begin_inset Quotes eld
11659 \begin_inset Quotes erd
11662 are not able to do this.
11664 \begin_inset Flex CharStyle:Code
11667 \begin_layout Plain Layout
11673 is similar, but only the very first row of the paragraph is dynamic, while
11674 the others are static; this is used, for example, for descriptions.
11676 \begin_inset Flex CharStyle:Code
11679 \begin_layout Plain Layout
11685 means the margin is chosen in a way that the longest row of this paragraph
11686 fits to the right margin.
11687 This is used to typeset an address on the right edge of the page.
11690 \begin_layout Description
11691 \begin_inset Flex CharStyle:Code
11694 \begin_layout Plain Layout
11701 \begin_inset Flex CharStyle:Code
11704 \begin_layout Plain Layout
11713 \begin_inset Flex CharStyle:Code
11716 \begin_layout Plain Layout
11722 ] Whether fragile commands in this layout should be
11723 \begin_inset Flex CharStyle:Code
11726 \begin_layout Plain Layout
11739 whether this command should itself be protected.)
11742 \begin_layout Description
11743 \begin_inset Flex CharStyle:Code
11746 \begin_layout Plain Layout
11753 \begin_inset Flex CharStyle:Code
11756 \begin_layout Plain Layout
11763 \begin_inset Flex CharStyle:Code
11766 \begin_layout Plain Layout
11774 ] Whether newlines are translated into LaTeX newlines (
11775 \begin_inset Flex CharStyle:Code
11778 \begin_layout Plain Layout
11789 The translation can be switched off to allow more comfortable LaTeX editing
11793 \begin_layout Description
11794 \begin_inset Flex CharStyle:Code
11797 \begin_layout Plain Layout
11804 \begin_inset Flex CharStyle:Code
11807 \begin_layout Plain Layout
11814 \begin_inset Flex CharStyle:Code
11817 \begin_layout Plain Layout
11825 ] Whether the following Paragraph is allowed to indent its very first row.
11827 \begin_inset Flex CharStyle:Code
11830 \begin_layout Plain Layout
11836 means that it is not allowed to do so;
11837 \begin_inset Flex CharStyle:Code
11840 \begin_layout Plain Layout
11846 means it could do so if it wants to.
11849 \begin_layout Description
11850 \begin_inset Flex CharStyle:Code
11853 \begin_layout Plain Layout
11859 Name of a layout that has replaced this layout.
11860 This is used to rename a layout, while keeping backward compatibility.
11863 \begin_layout Description
11864 \begin_inset Flex CharStyle:Code
11867 \begin_layout Plain Layout
11874 \begin_inset Flex CharStyle:Code
11877 \begin_layout Plain Layout
11883 ] The number of optional arguments that can be used with this layout.
11884 This is useful for things like section headings, and only makes sense with
11888 \begin_layout Description
11889 \begin_inset Flex CharStyle:Code
11892 \begin_layout Plain Layout
11899 \begin_inset Flex CharStyle:Code
11902 \begin_layout Plain Layout
11908 ] The indent of the very first line of a paragraph.
11910 \begin_inset Flex CharStyle:Code
11913 \begin_layout Plain Layout
11919 will be fixed for a certain layout.
11920 The exception is Standard layout, since the indentation of a Standard layout
11921 paragraph can be prohibited with
11922 \begin_inset Flex CharStyle:Code
11925 \begin_layout Plain Layout
11932 Also, Standard layout paragraphs inside environments use the
11933 \begin_inset Flex CharStyle:Code
11936 \begin_layout Plain Layout
11942 of the environment, not their native one.
11943 For example, Standard paragraphs inside an enumeration are not indented.
11946 \begin_layout Description
11947 \begin_inset Flex CharStyle:Code
11950 \begin_layout Plain Layout
11957 \begin_inset Flex CharStyle:Code
11960 \begin_layout Plain Layout
11966 ] The vertical space between two paragraphs of this layout.
11969 \begin_layout Description
11970 \begin_inset Flex CharStyle:Code
11973 \begin_layout Plain Layout
11980 \begin_inset Flex CharStyle:Code
11983 \begin_layout Plain Layout
11989 ] LyX allows the user to choose either
11990 \begin_inset Quotes eld
11994 \begin_inset Quotes erd
11998 \begin_inset Quotes eld
12002 \begin_inset Quotes erd
12005 to typeset a document.
12007 \begin_inset Quotes eld
12011 \begin_inset Quotes erd
12014 is chosen, this value is completely ignored.
12016 \begin_inset Quotes eld
12020 \begin_inset Quotes erd
12023 is chosen, the parindent of a LaTeXtype
12024 \begin_inset Quotes eld
12028 \begin_inset Quotes erd
12031 layout is ignored and all paragraphs are separated by this parskip argument.
12032 The vertical space is calculated with
12033 \begin_inset Flex CharStyle:Code
12036 \begin_layout Plain Layout
12038 \begin_inset space ~
12047 \begin_inset Flex CharStyle:Code
12050 \begin_layout Plain Layout
12056 is the height of a row with the normal font.
12057 This way, the look stays the same with different screen fonts.
12060 \begin_layout Description
12061 \begin_inset Flex CharStyle:Code
12064 \begin_layout Plain Layout
12071 \begin_inset CommandInset label
12073 name "des:PathThru"
12078 \begin_inset Flex CharStyle:Code
12081 \begin_layout Plain Layout
12090 \begin_inset Flex CharStyle:Code
12093 \begin_layout Plain Layout
12099 ] Whether the contents of this paragraph should be output in raw form, meaning
12100 without special translations that LaTeX would require.
12103 \begin_layout Description
12104 \begin_inset Flex CharStyle:Code
12107 \begin_layout Plain Layout
12114 \begin_inset CommandInset label
12116 name "des:Preamble"
12120 Information to be included in the LaTeX preamble when this style is used.
12121 Used to define macros, load packages, etc., required by this particular
12124 \begin_inset Quotes eld
12128 \begin_inset Flex CharStyle:Code
12131 \begin_layout Plain Layout
12138 \begin_inset Quotes erd
12144 \begin_layout Description
12145 \begin_inset Flex CharStyle:Code
12148 \begin_layout Plain Layout
12155 \begin_inset Flex CharStyle:Code
12158 \begin_layout Plain Layout
12164 ] The prefix to use when creating labels referring to paragraphs of this
12166 This allows the use of formatted references.
12169 \begin_layout Description
12170 \begin_inset Flex CharStyle:Code
12173 \begin_layout Plain Layout
12180 \begin_inset Flex CharStyle:Code
12183 \begin_layout Plain Layout
12190 \begin_inset CommandInset label
12192 name "des:Requires"
12196 Whether the layout requires the feature
12197 \begin_inset Flex CharStyle:Code
12200 \begin_layout Plain Layout
12207 See the description of
12208 \begin_inset Flex CharStyle:Code
12211 \begin_layout Plain Layout
12218 \begin_inset CommandInset ref
12219 LatexCommand pageref
12220 reference "des:FreeSpacing"
12224 ) for information on `features'.
12228 \begin_layout Description
12229 \begin_inset Flex CharStyle:Code
12232 \begin_layout Plain Layout
12239 \begin_inset Flex CharStyle:Code
12242 \begin_layout Plain Layout
12249 \begin_inset Flex CharStyle:Code
12252 \begin_layout Plain Layout
12261 \begin_layout Description
12262 \begin_inset Flex CharStyle:Code
12265 \begin_layout Plain Layout
12272 \begin_inset Flex CharStyle:Code
12275 \begin_layout Plain Layout
12280 , onehalf, double, other
12289 ] This defines what the default spacing should be in the layout.
12291 \begin_inset Flex CharStyle:Code
12294 \begin_layout Plain Layout
12301 \begin_inset Flex CharStyle:Code
12304 \begin_layout Plain Layout
12311 \begin_inset Flex CharStyle:Code
12314 \begin_layout Plain Layout
12320 correspond respectively to a multiplier value of 1, 1.25 and 1.667.
12321 If you specify the argument
12322 \begin_inset Flex CharStyle:Code
12325 \begin_layout Plain Layout
12331 , then you should also provide a numerical argument which will be the actual
12333 Note that, contrary to other parameters,
12334 \begin_inset Flex CharStyle:Code
12337 \begin_layout Plain Layout
12343 implies the generation of specific LaTeX code, using the package
12346 \begin_inset Flex CharStyle:Code
12349 \begin_layout Plain Layout
12358 \begin_layout Description
12359 \begin_inset Flex CharStyle:Code
12362 \begin_layout Plain Layout
12369 \begin_inset Flex CharStyle:Code
12372 \begin_layout Plain Layout
12379 \begin_inset Flex CharStyle:Code
12382 \begin_layout Plain Layout
12390 ] Spellcheck paragraphs of this style.
12394 \begin_layout Description
12395 \begin_inset Flex CharStyle:Code
12398 \begin_layout Plain Layout
12404 The font used for the text body .
12406 \begin_inset CommandInset ref
12408 reference "sub:Font-description"
12415 \begin_layout Description
12416 \begin_inset Flex CharStyle:Code
12419 \begin_layout Plain Layout
12428 \begin_inset Flex CharStyle:Code
12431 \begin_layout Plain Layout
12441 The level of the style in the table of contents.
12442 This is used for automatic numbering of section headings.
12445 \begin_layout Description
12446 \begin_inset Flex CharStyle:Code
12449 \begin_layout Plain Layout
12456 \begin_inset Flex CharStyle:Code
12459 \begin_layout Plain Layout
12465 ] The vertical space with which the very first of a chain of paragraphs
12466 with this layout is separated from the previous paragraph.
12467 If the previous paragraph has another layout, the separations are not simply
12468 added, but the maximum is taken.
12471 \begin_layout Subsection
12473 \begin_inset CommandInset label
12482 \begin_layout Standard
12483 Since version 1.3.0 of LyX, it is has been both possible and necessary to
12484 define the floats (
12485 \begin_inset Flex CharStyle:MenuItem
12488 \begin_layout Plain Layout
12495 \begin_inset Flex CharStyle:MenuItem
12498 \begin_layout Plain Layout
12504 , \SpecialChar \ldots{}
12505 ) in the text class itself.
12506 Standard floats are included in the file
12507 \begin_inset Flex CharStyle:Code
12510 \begin_layout Plain Layout
12516 , so you may have to do no more than add
12519 \begin_layout LyX-Code
12520 Input stdfloats.inc
12523 \begin_layout Standard
12524 to your layout file.
12525 If you want to implement a text class that proposes some other float types
12526 (like the AGU class bundled with LyX), the information below will hopefully
12530 \begin_layout Description
12531 \begin_inset Flex CharStyle:Code
12534 \begin_layout Plain Layout
12541 \begin_inset Flex CharStyle:Code
12544 \begin_layout Plain Layout
12551 \begin_inset Quotes erd
12555 \begin_inset Quotes erd
12558 ] The file name extension of an auxiliary file for the list of figures (or
12560 LaTeX writes the captions to this file.
12563 \begin_layout Description
12564 \begin_inset Flex CharStyle:Code
12567 \begin_layout Plain Layout
12574 \begin_inset Flex CharStyle:Code
12577 \begin_layout Plain Layout
12584 \begin_inset Quotes erd
12588 \begin_inset Quotes erd
12591 ] The string that will be used in the menus and also for the caption.
12592 This is translated to the current language if babel is used.
12595 \begin_layout Description
12596 \begin_inset Flex CharStyle:Code
12599 \begin_layout Plain Layout
12605 These are used for XHTML output.
12607 \begin_inset CommandInset ref
12609 reference "sec:Tags-for-XHTML"
12616 \begin_layout Description
12617 \begin_inset Flex CharStyle:Code
12620 \begin_layout Plain Layout
12627 \begin_inset Flex CharStyle:Code
12630 \begin_layout Plain Layout
12637 \begin_inset Quotes erd
12641 \begin_inset Quotes erd
12644 ] The command used to generate a list of floats of this type; the leading
12647 ' should be omitted.
12653 \begin_inset Flex CharStyle:Code
12656 \begin_layout Plain Layout
12662 is false, since there is no standard way to generate this command.
12664 \begin_inset Flex CharStyle:Code
12667 \begin_layout Plain Layout
12673 is true, since in that case there is a standard way.
12676 \begin_layout Description
12677 \begin_inset Flex CharStyle:Code
12680 \begin_layout Plain Layout
12687 \begin_inset Flex CharStyle:Code
12690 \begin_layout Plain Layout
12697 \begin_inset Quotes erd
12701 \begin_inset Quotes erd
12704 ] A title for a list of floats of this kind (list of figures, tables, or
12706 It is used for the screen label within LyX; it is passed to LaTeX for use
12707 as the title there; and it is used as the title in XHTML output.
12708 It will be translated to the document language.
12711 \begin_layout Description
12712 \begin_inset Flex CharStyle:Code
12715 \begin_layout Plain Layout
12722 \begin_inset Flex CharStyle:Code
12725 \begin_layout Plain Layout
12732 \begin_inset Flex CharStyle:Code
12735 \begin_layout Plain Layout
12743 ] Indicates whether the float is already defined in the document class or
12744 if we instead need to load
12745 \begin_inset Flex CharStyle:Code
12748 \begin_layout Plain Layout
12754 and use what it provides.
12756 \begin_inset Flex CharStyle:Code
12759 \begin_layout Plain Layout
12766 \begin_inset Flex CharStyle:Code
12769 \begin_layout Plain Layout
12776 It should be set to
12777 \begin_inset Flex CharStyle:Code
12780 \begin_layout Plain Layout
12786 if the float is already defined by the LaTeX document class.
12789 \begin_layout Description
12790 \begin_inset Flex CharStyle:Code
12793 \begin_layout Plain Layout
12800 \begin_inset Flex CharStyle:Code
12803 \begin_layout Plain Layout
12810 \begin_inset Quotes erd
12814 \begin_inset Quotes erd
12817 ] This (optional) argument determines whether floats of this class will
12818 be numbered within some sectional unit of the document.
12819 For example, if within is equal to
12820 \begin_inset Flex CharStyle:Code
12823 \begin_layout Plain Layout
12829 , the floats will be numbered within chapters.
12833 \begin_layout Description
12834 \begin_inset Flex CharStyle:Code
12837 \begin_layout Plain Layout
12844 \begin_inset Flex CharStyle:Code
12847 \begin_layout Plain Layout
12854 \begin_inset Quotes erd
12858 \begin_inset Quotes erd
12861 ] The default placement for the given class of floats.
12862 The string should be as in standard LaTeX:
12863 \begin_inset Flex CharStyle:Code
12866 \begin_layout Plain Layout
12873 \begin_inset Flex CharStyle:Code
12876 \begin_layout Plain Layout
12883 \begin_inset Flex CharStyle:Code
12886 \begin_layout Plain Layout
12893 \begin_inset Flex CharStyle:Code
12896 \begin_layout Plain Layout
12902 for top, bottom, page, and here, respectively.
12906 \begin_layout Plain Layout
12907 Note that the order of these letters in the string is irrelevant, like in
12913 On top of that there is a new type,
12914 \begin_inset Flex CharStyle:Code
12917 \begin_layout Plain Layout
12923 , which does not really correspond to a float, since it means: put it
12924 \begin_inset Quotes eld
12928 \begin_inset Quotes erd
12932 Note however that the
12933 \begin_inset Flex CharStyle:Code
12936 \begin_layout Plain Layout
12942 specifier is special and, because of implementation details, cannot be
12943 used in non-built in float types.
12944 If you do not understand what this means, just use
12945 \begin_inset Quotes eld
12949 \begin_inset Flex CharStyle:Code
12952 \begin_layout Plain Layout
12959 \begin_inset Quotes erd
12965 \begin_layout Description
12966 \begin_inset Flex CharStyle:Code
12969 \begin_layout Plain Layout
12976 \begin_inset Flex CharStyle:Code
12979 \begin_layout Plain Layout
12985 ] The prefix to use when creating labels referring to floats of this type.
12986 This allows the use of formatted references.
12989 \begin_layout Description
12990 \begin_inset Flex CharStyle:Code
12993 \begin_layout Plain Layout
13000 \begin_inset Flex CharStyle:Code
13003 \begin_layout Plain Layout
13010 \begin_inset Quotes erd
13014 \begin_inset Quotes erd
13017 ] The style used when defining the float using
13018 \begin_inset Flex CharStyle:Code
13021 \begin_layout Plain Layout
13032 \begin_layout Description
13033 \begin_inset Flex CharStyle:Code
13036 \begin_layout Plain Layout
13043 \begin_inset Flex CharStyle:Code
13046 \begin_layout Plain Layout
13053 \begin_inset Quotes erd
13057 \begin_inset Quotes erd
13061 \begin_inset Quotes eld
13065 \begin_inset Quotes erd
13068 of the new class of floats, like program or algorithm.
13069 After the appropriate
13070 \begin_inset Flex CharStyle:Code
13073 \begin_layout Plain Layout
13082 \begin_inset Flex CharStyle:Code
13085 \begin_layout Plain Layout
13094 \begin_inset Flex CharStyle:Code
13097 \begin_layout Plain Layout
13108 \begin_layout Standard
13109 Note that defining a float with type
13110 \begin_inset Flex CharStyle:Code
13113 \begin_layout Plain Layout
13121 automatically defines the corresponding counter with name
13122 \begin_inset Flex CharStyle:Code
13125 \begin_layout Plain Layout
13136 \begin_layout Subsection
13137 Flex insets and InsetLayout
13138 \begin_inset CommandInset label
13140 name "sub:Flex-insets-and"
13147 \begin_layout Standard
13148 LyX has supported character styles since version 1.4.0; as of version 1.6.0,
13149 these are called Flex insets.
13153 \begin_layout Standard
13154 Flex insets come in three different kinds:
13157 \begin_layout Itemize
13159 \begin_inset Flex CharStyle:Code
13162 \begin_layout Plain Layout
13168 ): These define semantic markup corresponding to such LaTeX commands as
13170 \begin_inset Flex CharStyle:Code
13173 \begin_layout Plain Layout
13182 \begin_inset Flex CharStyle:Code
13185 \begin_layout Plain Layout
13196 \begin_layout Itemize
13198 \begin_inset Flex CharStyle:Code
13201 \begin_layout Plain Layout
13207 ): These can be used to define custom collapsible insets, similar to TeX
13208 code, footnote, and the like.
13209 An obvious example is an endnote inset, which is defined in the
13210 \begin_inset Flex CharStyle:Code
13213 \begin_layout Plain Layout
13222 \begin_layout Itemize
13224 \begin_inset Flex CharStyle:Code
13227 \begin_layout Plain Layout
13233 ): For use with DocBook classes.
13236 \begin_layout Standard
13237 Flex insets are defined using the
13238 \begin_inset Flex CharStyle:Code
13241 \begin_layout Plain Layout
13247 tag, which shall be explained in a moment.
13250 \begin_layout Standard
13252 \begin_inset Flex CharStyle:Code
13255 \begin_layout Plain Layout
13261 tag also serves another function: It can be used to customize the general
13262 layout of many different types of insets.
13264 \begin_inset Flex CharStyle:Code
13267 \begin_layout Plain Layout
13273 can be used to customize the layout parameters for footnotes, marginal
13274 notes, note insets, TeX code (ERT) insets, branches, listings, indexes,
13275 boxes, tables, algorithms, URLs, and optional arguments, as well as to
13276 define Flex insets.
13279 \begin_layout Standard
13281 \begin_inset Flex CharStyle:Code
13284 \begin_layout Plain Layout
13290 definition must begin with a line of the form:
13293 \begin_layout LyX-Code
13297 \begin_layout Standard
13299 \begin_inset Flex CharStyle:Code
13302 \begin_layout Plain Layout
13308 indicates the inset whose layout is being defined, and here there are two
13312 \begin_layout Enumerate
13313 The layout for a pre-existing inset is being modified.
13314 In this case, can be
13315 \begin_inset Flex CharStyle:Code
13318 \begin_layout Plain Layout
13324 any one of the following:
13325 \begin_inset Flex CharStyle:Code
13328 \begin_layout Plain Layout
13335 \begin_inset Flex CharStyle:Code
13338 \begin_layout Plain Layout
13345 \begin_inset Flex CharStyle:Code
13348 \begin_layout Plain Layout
13355 \begin_inset Flex CharStyle:Code
13358 \begin_layout Plain Layout
13365 \begin_inset Flex CharStyle:Code
13368 \begin_layout Plain Layout
13375 \begin_inset Flex CharStyle:Code
13378 \begin_layout Plain Layout
13385 \begin_inset Flex CharStyle:Code
13388 \begin_layout Plain Layout
13395 \begin_inset Flex CharStyle:Code
13398 \begin_layout Plain Layout
13405 \begin_inset Flex CharStyle:Code
13408 \begin_layout Plain Layout
13415 \begin_inset Flex CharStyle:Code
13418 \begin_layout Plain Layout
13425 \begin_inset Flex CharStyle:Code
13428 \begin_layout Plain Layout
13435 \begin_inset Flex CharStyle:Code
13438 \begin_layout Plain Layout
13445 \begin_inset Flex CharStyle:Code
13448 \begin_layout Plain Layout
13455 \begin_inset Flex CharStyle:Code
13458 \begin_layout Plain Layout
13465 \begin_inset Flex CharStyle:Code
13468 \begin_layout Plain Layout
13475 \begin_inset Flex CharStyle:Code
13478 \begin_layout Plain Layout
13485 \begin_inset Flex CharStyle:Code
13488 \begin_layout Plain Layout
13495 \begin_inset Flex CharStyle:Code
13498 \begin_layout Plain Layout
13505 \begin_inset Flex CharStyle:Code
13508 \begin_layout Plain Layout
13515 \begin_inset Flex CharStyle:Code
13518 \begin_layout Plain Layout
13527 \begin_layout Enumerate
13528 The layout for a Flex inset is being defined.
13530 \begin_inset Flex CharStyle:Code
13533 \begin_layout Plain Layout
13539 can be any valid identifier not used by a pre-existing inset.
13540 Note that the definition of a flex inset
13545 \begin_inset Flex CharStyle:Code
13548 \begin_layout Plain Layout
13554 entry, declaring which type of inset this is.
13557 \begin_layout Standard
13559 \begin_inset Flex CharStyle:Code
13562 \begin_layout Plain Layout
13568 definition can contain the following entries:
13571 \begin_layout Description
13572 \begin_inset Flex CharStyle:Code
13575 \begin_layout Plain Layout
13581 The color for the inset's background.
13582 The valid colors are defined in
13583 \begin_inset Flex CharStyle:Code
13586 \begin_layout Plain Layout
13595 \begin_layout Description
13596 \begin_inset Flex CharStyle:Code
13599 \begin_layout Plain Layout
13606 \begin_inset Flex CharStyle:Code
13609 \begin_layout Plain Layout
13618 \begin_inset Flex CharStyle:Code
13621 \begin_layout Plain Layout
13627 ] Whether to use the content of the inset as the label, when the inset is
13632 \begin_layout Description
13633 \begin_inset Flex CharStyle:Code
13636 \begin_layout Plain Layout
13642 As with paragraph styles (see page
13643 \begin_inset CommandInset ref
13645 reference "des:CopyStyle"
13652 \begin_layout Description
13653 \begin_inset Flex CharStyle:Code
13656 \begin_layout Plain Layout
13663 \begin_inset Flex CharStyle:Code
13666 \begin_layout Plain Layout
13675 \begin_inset Flex CharStyle:Code
13678 \begin_layout Plain Layout
13684 ] Indicates whether the user may employ the Paragraph Settings dialog to
13685 customize the paragraph.
13688 \begin_layout Description
13689 \begin_inset Flex CharStyle:Code
13692 \begin_layout Plain Layout
13699 \begin_inset Flex CharStyle:Code
13702 \begin_layout Plain Layout
13709 \begin_inset Flex CharStyle:Code
13712 \begin_layout Plain Layout
13719 \begin_inset Flex CharStyle:Code
13722 \begin_layout Plain Layout
13728 , describing the rendering style used for the inset's frame and buttons.
13729 Footnotes generally use
13730 \begin_inset Flex CharStyle:Code
13733 \begin_layout Plain Layout
13739 , ERT insets generally
13740 \begin_inset Flex CharStyle:Code
13743 \begin_layout Plain Layout
13749 , and character styles
13750 \begin_inset Flex CharStyle:Code
13753 \begin_layout Plain Layout
13762 \begin_layout Description
13763 \begin_inset Flex CharStyle:Code
13766 \begin_layout Plain Layout
13772 Required at the end of the InsetLayout declarations.
13775 \begin_layout Description
13776 \begin_inset Flex CharStyle:Code
13779 \begin_layout Plain Layout
13785 The font used for both the text body
13791 \begin_inset space ~
13795 \begin_inset CommandInset ref
13797 reference "sub:Font-description"
13802 Note that defining this font automatically defines the
13803 \begin_inset Flex CharStyle:Code
13806 \begin_layout Plain Layout
13812 to the same value, so define this first and define
13813 \begin_inset Flex CharStyle:Code
13816 \begin_layout Plain Layout
13822 later if you want them to be different.
13825 \begin_layout Description
13826 \begin_inset Flex CharStyle:Code
13829 \begin_layout Plain Layout
13836 \begin_inset Quotes eld
13840 \begin_inset Quotes erd
13843 language, leading to Left-to-Right (latin) output, e.
13844 \begin_inset space \thinspace{}
13848 \begin_inset space \space{}
13851 in TeX code or URL.
13855 \begin_layout Description
13856 \begin_inset Flex CharStyle:Code
13859 \begin_layout Plain Layout
13866 \begin_inset Flex CharStyle:Code
13869 \begin_layout Plain Layout
13878 \begin_inset Flex CharStyle:Code
13881 \begin_layout Plain Layout
13887 ] Indicates whether the PlainLayout should be used or, instead, the user
13888 can change the paragraph style used in the inset.
13892 \begin_layout Description
13893 \begin_inset Flex CharStyle:Code
13896 \begin_layout Plain Layout
13902 As with paragraph styles (see page
13903 \begin_inset CommandInset ref
13904 LatexCommand pageref
13905 reference "des:FreeSpacing"
13913 \begin_layout Description
13914 \begin_inset Flex CharStyle:Code
13917 \begin_layout Plain Layout
13923 These tags control XHTML output.
13927 \begin_layout Description
13928 \begin_inset Flex CharStyle:Code
13931 \begin_layout Plain Layout
13938 \begin_inset Flex CharStyle:Code
13941 \begin_layout Plain Layout
13950 \begin_inset Flex CharStyle:Code
13953 \begin_layout Plain Layout
13959 ] Whether to include the contents of this inset in the strings generated
13960 for the `Outline' pane.
13961 One would not, for example, want the content of a footnote in a section
13962 header to be included in the TOC displayed in the outline, but one would
13963 normally want the content of a character style displayed.
13964 Default is false: not to include.
13967 \begin_layout Description
13968 \begin_inset Flex CharStyle:Code
13971 \begin_layout Plain Layout
13977 As with paragraph styles (see page
13978 \begin_inset CommandInset ref
13979 LatexCommand pageref
13980 reference "des:KeepEmpty"
13988 \begin_layout Description
13989 \begin_inset Flex CharStyle:Code
13992 \begin_layout Plain Layout
13998 The font used for the label.
14000 \begin_inset space ~
14004 \begin_inset CommandInset ref
14006 reference "sub:Font-description"
14011 Note that this definition can never appear before
14012 \begin_inset Flex CharStyle:Code
14015 \begin_layout Plain Layout
14021 , lest it be ineffective.
14024 \begin_layout Description
14025 \begin_inset Flex CharStyle:Code
14028 \begin_layout Plain Layout
14034 What will be displayed on the button or elsewhere as the inset label.
14035 Some inset types (TeX code and Branch) modify this label on the fly.
14038 \begin_layout Description
14039 \begin_inset Flex CharStyle:Code
14042 \begin_layout Plain Layout
14048 The name of the corresponding LaTeX stuff.
14049 Either the environment or command name.
14052 \begin_layout Description
14053 \begin_inset Flex CharStyle:Code
14056 \begin_layout Plain Layout
14062 The optional parameter for the corresponding
14063 \begin_inset Flex CharStyle:Code
14066 \begin_layout Plain Layout
14072 stuff, including possible bracket pairs like
14073 \begin_inset Flex CharStyle:Code
14076 \begin_layout Plain Layout
14083 This parameter cannot be changed from within LyX.
14086 \begin_layout Description
14087 \begin_inset Flex CharStyle:Code
14090 \begin_layout Plain Layout
14096 As with paragraph styles (see page
14097 \begin_inset CommandInset ref
14098 LatexCommand pageref
14099 reference "des:LatexType"
14106 \begin_layout Description
14107 \begin_inset Flex CharStyle:Code
14110 \begin_layout Plain Layout
14117 \begin_inset Flex CharStyle:Code
14120 \begin_layout Plain Layout
14127 \begin_inset Flex CharStyle:Code
14130 \begin_layout Plain Layout
14137 \begin_inset Flex CharStyle:Code
14140 \begin_layout Plain Layout
14147 \begin_inset Flex CharStyle:Code
14150 \begin_layout Plain Layout
14156 (indicating a dummy definition ending definitions of charstyles, etc).
14157 This entry is required in and is only meaningful for Flex insets.
14158 Among other things, it determines on which menu this inset will appear.
14160 \begin_inset Flex CharStyle:Code
14163 \begin_layout Plain Layout
14170 \begin_inset Flex CharStyle:Code
14173 \begin_layout Plain Layout
14180 \begin_inset Flex CharStyle:Code
14183 \begin_layout Plain Layout
14191 \begin_inset Flex CharStyle:Code
14194 \begin_layout Plain Layout
14200 can be set to true for charstyle insets, if you wish, by setting it
14205 \begin_inset Flex CharStyle:Code
14208 \begin_layout Plain Layout
14217 \begin_layout Description
14218 \begin_inset Flex CharStyle:Code
14221 \begin_layout Plain Layout
14228 \begin_inset Flex CharStyle:Code
14231 \begin_layout Plain Layout
14240 \begin_inset Flex CharStyle:Code
14243 \begin_layout Plain Layout
14249 ] Whether multiple paragraphs are permitted in this inset.
14251 \begin_inset Flex CharStyle:Code
14254 \begin_layout Plain Layout
14260 to the same value and
14261 \begin_inset Flex CharStyle:Code
14264 \begin_layout Plain Layout
14270 to the opposite value.
14271 These can be reset to other values, if they are used
14276 \begin_inset Flex CharStyle:Code
14279 \begin_layout Plain Layout
14289 \begin_layout Description
14290 \begin_inset Flex CharStyle:Code
14293 \begin_layout Plain Layout
14300 \begin_inset Flex CharStyle:Code
14303 \begin_layout Plain Layout
14312 \begin_inset Flex CharStyle:Code
14315 \begin_layout Plain Layout
14321 ] Whether fragile commands in this layout should be
14322 \begin_inset Flex CharStyle:Code
14325 \begin_layout Plain Layout
14338 whether the command should itself be protected.) Default is false.
14341 \begin_layout Description
14342 \begin_inset Flex CharStyle:Code
14345 \begin_layout Plain Layout
14352 \begin_inset Flex CharStyle:Code
14355 \begin_layout Plain Layout
14364 \begin_inset Flex CharStyle:Code
14367 \begin_layout Plain Layout
14373 ] As with paragraph styles (see page
14374 \begin_inset CommandInset ref
14375 LatexCommand pageref
14376 reference "des:PathThru"
14384 \begin_layout Description
14385 \begin_inset Flex CharStyle:Code
14388 \begin_layout Plain Layout
14394 As with paragraph styles (see page
14395 \begin_inset CommandInset ref
14396 LatexCommand pageref
14397 reference "des:Preamble"
14404 \begin_layout Description
14405 \begin_inset Flex CharStyle:Code
14408 \begin_layout Plain Layout
14415 \begin_inset Flex CharStyle:Code
14418 \begin_layout Plain Layout
14424 ] The prefix to use when creating labels referring to insets of this type.
14425 This allows the use of formatted references.
14428 \begin_layout Description
14429 \begin_inset Flex CharStyle:Code
14432 \begin_layout Plain Layout
14439 \begin_inset Flex CharStyle:Code
14442 \begin_layout Plain Layout
14448 ] As with paragraph styles (see page
14449 \begin_inset CommandInset ref
14450 LatexCommand pageref
14451 reference "des:Requires"
14458 \begin_layout Description
14459 \begin_inset Flex CharStyle:Code
14462 \begin_layout Plain Layout
14469 \begin_inset Flex CharStyle:Code
14472 \begin_layout Plain Layout
14479 \begin_inset Flex CharStyle:Code
14482 \begin_layout Plain Layout
14490 ] Spellcheck the contents of this inset.
14494 \begin_layout Subsection
14496 \begin_inset CommandInset label
14498 name "sub:Counters"
14505 \begin_layout Standard
14506 Since version 1.3.0 of LyX, it is both possible and necessary to define the
14508 \begin_inset Flex CharStyle:MenuItem
14511 \begin_layout Plain Layout
14518 \begin_inset Flex CharStyle:MenuItem
14521 \begin_layout Plain Layout
14527 , \SpecialChar \ldots{}
14528 ) in the text class itself.
14529 The standard counters are defined in the file
14530 \begin_inset Flex CharStyle:Code
14533 \begin_layout Plain Layout
14539 , so you may have to do no more than add
14542 \begin_layout LyX-Code
14543 Input stdcounters.inc
14546 \begin_layout Standard
14547 to your layout file to get them to work.
14548 But if you want to define custom counters, then you can do so.
14549 The counter declaration must begin with:
14552 \begin_layout LyX-Code
14553 Counter CounterName
14556 \begin_layout Standard
14558 \begin_inset Flex CharStyle:Code
14561 \begin_layout Plain Layout
14567 ' is replaced by the name of the counter.
14568 And it must end with
14569 \begin_inset Quotes eld
14573 \begin_inset Flex CharStyle:Code
14576 \begin_layout Plain Layout
14583 \begin_inset Quotes erd
14587 The following parameters can also be used:
14590 \begin_layout Description
14591 \begin_inset Flex CharStyle:Code
14594 \begin_layout Plain Layout
14601 \begin_inset Flex CharStyle:Code
14604 \begin_layout Plain Layout
14611 \begin_inset Quotes erd
14615 \begin_inset Quotes erd
14618 ] When defined, this string defines how the counter is displayed.
14619 Setting this value sets
14620 \begin_inset Flex CharStyle:Code
14623 \begin_layout Plain Layout
14624 LabelStringAppendix
14630 The following special constructs can be used in the string:
14634 \begin_layout Itemize
14635 \begin_inset Flex CharStyle:Code
14638 \begin_layout Plain Layout
14646 will be replaced by the expansion of the
14647 \begin_inset Flex CharStyle:Code
14650 \begin_layout Plain Layout
14657 \begin_inset Flex CharStyle:Code
14660 \begin_layout Plain Layout
14661 LabelStringAppendix
14667 \begin_inset Flex CharStyle:Code
14670 \begin_layout Plain Layout
14680 \begin_layout Itemize
14681 counter values can be expressed using LaTeX-like macros
14682 \begin_inset Flex CharStyle:Code
14685 \begin_layout Plain Layout
14702 \begin_inset Flex CharStyle:Code
14705 \begin_layout Plain Layout
14717 \begin_layout Plain Layout
14727 Actually, the situation is a bit more complicated: any
14746 other than those described below will produce arabic numerals.
14747 It would not be surprising to see this change in the future.
14753 \begin_inset Flex CharStyle:Code
14756 \begin_layout Plain Layout
14762 : 1, 2, 3,\SpecialChar \ldots{}
14764 \begin_inset Flex CharStyle:Code
14767 \begin_layout Plain Layout
14773 for lower-case letters: a, b, c, \SpecialChar \ldots{}
14775 \begin_inset Flex CharStyle:Code
14778 \begin_layout Plain Layout
14784 for upper-case letters: A, B, C, \SpecialChar \ldots{}
14786 \begin_inset Flex CharStyle:Code
14789 \begin_layout Plain Layout
14795 for lower-case roman numerals: i, ii, iii, \SpecialChar \ldots{}
14797 \begin_inset Flex CharStyle:Code
14800 \begin_layout Plain Layout
14806 for upper-case roman numerals: I, II, III\SpecialChar \ldots{}
14808 \begin_inset Flex CharStyle:Code
14811 \begin_layout Plain Layout
14817 for hebrew numerals.
14821 \begin_layout Standard
14822 If LabelString is not defined, a default value is constructed as follows:
14823 if the counter has a master counter
14824 \begin_inset Flex CharStyle:Code
14827 \begin_layout Plain Layout
14834 \begin_inset Flex CharStyle:Code
14837 \begin_layout Plain Layout
14844 \begin_inset Flex CharStyle:Code
14847 \begin_layout Plain Layout
14857 is used; otherwise the string
14858 \begin_inset Flex CharStyle:Code
14861 \begin_layout Plain Layout
14872 \begin_layout Description
14873 \begin_inset Flex CharStyle:Code
14876 \begin_layout Plain Layout
14877 LabelStringAppendix
14883 \begin_inset Flex CharStyle:Code
14886 \begin_layout Plain Layout
14893 \begin_inset Quotes erd
14897 \begin_inset Quotes erd
14901 \begin_inset Flex CharStyle:Code
14904 \begin_layout Plain Layout
14910 , but for use in the Appendix.
14913 \begin_layout Description
14914 \begin_inset Flex CharStyle:Code
14917 \begin_layout Plain Layout
14924 \begin_inset Flex CharStyle:Code
14927 \begin_layout Plain Layout
14934 \begin_inset Quotes erd
14938 \begin_inset Quotes erd
14941 ] A format for use with formatted references to this counter.
14942 For example, one might want to have references to section numbers appear
14944 \begin_inset Quotes eld
14948 \begin_inset Quotes erd
14952 The string should contain
14953 \begin_inset Quotes eld
14957 \begin_inset Quotes erd
14961 This will be replaced by the counter number itself.
14962 So, for sections, it would be: Section ##.
14965 \begin_layout Description
14966 \begin_inset Flex CharStyle:Code
14969 \begin_layout Plain Layout
14976 \begin_inset Flex CharStyle:Code
14979 \begin_layout Plain Layout
14986 \begin_inset Quotes erd
14990 \begin_inset Quotes erd
14993 ] If this is set to the name of another counter, the present counter will
14994 be reset every time the other one is increased.
14996 \begin_inset Flex CharStyle:Code
14999 \begin_layout Plain Layout
15006 \begin_inset Flex CharStyle:Code
15009 \begin_layout Plain Layout
15018 \begin_layout Subsection
15020 \begin_inset CommandInset label
15022 name "sub:Font-description"
15029 \begin_layout Standard
15030 A font description looks like this:
15033 \begin_layout LyX-Code
15043 \begin_layout LyX-Code
15047 \begin_layout LyX-Code
15051 \begin_layout Standard
15052 The following commands are available:
15055 \begin_layout Description
15056 \begin_inset Flex CharStyle:Code
15059 \begin_layout Plain Layout
15066 \begin_inset Flex CharStyle:Code
15069 \begin_layout Plain Layout
15078 \begin_inset Flex CharStyle:Code
15081 \begin_layout Plain Layout
15088 \begin_inset Flex CharStyle:Code
15091 \begin_layout Plain Layout
15098 \begin_inset Flex CharStyle:Code
15101 \begin_layout Plain Layout
15108 \begin_inset Flex CharStyle:Code
15111 \begin_layout Plain Layout
15118 \begin_inset Flex CharStyle:Code
15121 \begin_layout Plain Layout
15128 \begin_inset Flex CharStyle:Code
15131 \begin_layout Plain Layout
15138 \begin_inset Flex CharStyle:Code
15141 \begin_layout Plain Layout
15148 \begin_inset Flex CharStyle:Code
15151 \begin_layout Plain Layout
15160 \begin_layout Description
15161 \begin_inset Flex CharStyle:Code
15164 \begin_layout Plain Layout
15171 \begin_inset Flex CharStyle:Code
15174 \begin_layout Plain Layout
15183 \begin_inset Flex CharStyle:Code
15186 \begin_layout Plain Layout
15193 \begin_inset Flex CharStyle:Code
15196 \begin_layout Plain Layout
15205 \begin_layout Description
15206 \begin_inset Flex CharStyle:Code
15209 \begin_layout Plain Layout
15216 \begin_inset Flex CharStyle:Code
15219 \begin_layout Plain Layout
15225 ] Valid arguments are:
15226 \begin_inset Flex CharStyle:Code
15229 \begin_layout Plain Layout
15236 \begin_inset Flex CharStyle:Code
15239 \begin_layout Plain Layout
15246 \begin_inset Flex CharStyle:Code
15249 \begin_layout Plain Layout
15256 \begin_inset Flex CharStyle:Code
15259 \begin_layout Plain Layout
15266 \begin_inset Flex CharStyle:Code
15269 \begin_layout Plain Layout
15276 \begin_inset Flex CharStyle:Code
15279 \begin_layout Plain Layout
15286 Each of these turns on or off the corresponding attribute.
15288 \begin_inset Flex CharStyle:Code
15291 \begin_layout Plain Layout
15297 turns on emphasis, and
15298 \begin_inset Flex CharStyle:Code
15301 \begin_layout Plain Layout
15309 \begin_inset Newline newline
15312 If the latter seems puzzling, remember that the font settings for the present
15313 context are generally inherited from the surrounding context.
15315 \begin_inset Flex CharStyle:Code
15318 \begin_layout Plain Layout
15324 would turn off the emphasis that was anyway in effect, say, in a theorem
15328 \begin_layout Description
15329 \begin_inset Flex CharStyle:Code
15332 \begin_layout Plain Layout
15339 \begin_inset Flex CharStyle:Code
15342 \begin_layout Plain Layout
15351 \begin_inset Flex CharStyle:Code
15354 \begin_layout Plain Layout
15363 \begin_layout Description
15364 \begin_inset Flex CharStyle:Code
15367 \begin_layout Plain Layout
15374 \begin_inset Flex CharStyle:Code
15377 \begin_layout Plain Layout
15386 \begin_inset Flex CharStyle:Code
15389 \begin_layout Plain Layout
15396 \begin_inset Flex CharStyle:Code
15399 \begin_layout Plain Layout
15406 \begin_inset Flex CharStyle:Code
15409 \begin_layout Plain Layout
15418 \begin_layout Description
15419 \begin_inset Flex CharStyle:Code
15422 \begin_layout Plain Layout
15429 \begin_inset Flex CharStyle:Code
15432 \begin_layout Plain Layout
15439 \begin_inset Flex CharStyle:Code
15442 \begin_layout Plain Layout
15449 \begin_inset Flex CharStyle:Code
15452 \begin_layout Plain Layout
15461 \begin_inset Flex CharStyle:Code
15464 \begin_layout Plain Layout
15471 \begin_inset Flex CharStyle:Code
15474 \begin_layout Plain Layout
15481 \begin_inset Flex CharStyle:Code
15484 \begin_layout Plain Layout
15491 \begin_inset Flex CharStyle:Code
15494 \begin_layout Plain Layout
15501 \begin_inset Flex CharStyle:Code
15504 \begin_layout Plain Layout
15513 \begin_layout Subsection
15514 \begin_inset CommandInset label
15516 name "sub:Citation-format-description"
15520 Citation format description
15523 \begin_layout Standard
15525 \begin_inset Flex CharStyle:Code
15528 \begin_layout Plain Layout
15534 blocks are used to describe how bibliographic information should be displayed,
15535 both within LyX itself (in the citation dialog and in tooltips, for example)
15536 and in XHTML output.
15537 Such a block might look like this:
15540 \begin_layout LyX-Code
15544 \begin_layout LyX-Code
15548 \begin_layout LyX-Code
15552 \begin_layout LyX-Code
15556 \begin_layout Standard
15557 The individual lines define how the bibliographic information associated
15558 with an article or book, respectively, is to be displayed, and such a definitio
15559 n can be given for any `entry type' that might be present in a BibTeX file.
15560 LyX defines a default format in the source code that will be used if no
15561 specific definition has been given.
15562 LyX predefines several formats in the file
15563 \begin_inset Flex CharStyle:Code
15566 \begin_layout Plain Layout
15572 , which is included in most of LyX's document classes.
15575 \begin_layout Standard
15576 The definitions use a simple language that allows BibTeX keys to be replaced
15578 Keys should be enclosed in % signs, e.g.:
15579 \begin_inset Flex CharStyle:Code
15582 \begin_layout Plain Layout
15589 So a simple definition might look like this:
15592 \begin_layout LyX-Code
15594 \begin_inset Quotes eld
15598 \begin_inset Quotes erd
15604 \begin_layout Standard
15605 This would print the author, followed by a comma, followed by the title,
15606 in quotes, followed by a period.
15609 \begin_layout Standard
15610 Of course, sometimes you may want to print a key only if it exists.
15611 This can be done by using a conditional construction, such as:
15612 \begin_inset Flex CharStyle:Code
15615 \begin_layout Plain Layout
15617 \begin_inset space ~
15627 \begin_inset Flex CharStyle:Code
15630 \begin_layout Plain Layout
15636 key exists, then print
15637 \begin_inset Quotes eld
15641 \begin_inset space ~
15645 \begin_inset Quotes erd
15648 followed by the volume key.
15649 It is also possible to have an else clause in the conditional, such as:
15651 \begin_inset Flex CharStyle:Code
15654 \begin_layout Plain Layout
15655 {%author%[[%author%]][[%editor%, ed.]]}
15662 \begin_inset Flex CharStyle:Code
15665 \begin_layout Plain Layout
15671 key is printed if it exists; otherwise, the editor key is printed, followed
15673 \begin_inset Quotes eld
15677 \begin_inset space ~
15681 \begin_inset Quotes erd
15684 Note that the key is again enclosed in % signs; the entire conditional
15685 is enclosed in braces; and the if and else clauses are enclosed in double
15687 \begin_inset Quotes eld
15691 \begin_inset Quotes eld
15695 \begin_inset Quotes eld
15699 \begin_inset Quotes erd
15703 There must be no space between any of these.
15706 \begin_layout Standard
15707 There is one other piece of syntax available in definitions, which looks
15709 \begin_inset Flex CharStyle:Code
15712 \begin_layout Plain Layout
15719 This defines a piece of formatting information that is to be used when
15721 \begin_inset Quotes eld
15725 \begin_inset Quotes erd
15729 Obviously, we do not want to output HTML tags when writing plain text,
15730 so they should be wrapped in
15731 \begin_inset Quotes eld
15735 \begin_inset Quotes erd
15739 \begin_inset Quotes eld
15743 \begin_inset Quotes erd
15749 \begin_layout Standard
15750 Two special sorts of definitions are also possible in a
15751 \begin_inset Flex CharStyle:Code
15754 \begin_layout Plain Layout
15761 An example of the first would be:
15764 \begin_layout LyX-Code
15766 \begin_inset Quotes eld
15770 \begin_inset Quotes erd
15776 \begin_layout Standard
15777 This is an abbreviation, or macro, and it can be used by treating it as
15779 \begin_inset Flex CharStyle:Code
15782 \begin_layout Plain Layout
15790 \begin_inset Flex CharStyle:Code
15793 \begin_layout Plain Layout
15799 exactly as it would treat its definition.
15800 So, let us issue the obvious
15808 \begin_layout LyX-Code
15812 \begin_layout Standard
15813 or anything like it.
15814 LyX shouldn't go into an infinite loop, but it may go into a long one before
15818 \begin_layout Standard
15819 The second sort of special definition might look like this:
15822 \begin_layout LyX-Code
15826 \begin_layout Standard
15827 This defines a translatable piece of text, which allows relevant parts of
15828 the bibliography to be translated.
15829 It can be included in a definition by treating it as a key:
15830 \begin_inset Flex CharStyle:Code
15833 \begin_layout Plain Layout
15840 Several of these are predefined in
15841 \begin_inset Flex CharStyle:Code
15844 \begin_layout Plain Layout
15851 Note that these are not macros, in the sense just defined.
15852 They will not be expanded.
15855 \begin_layout Standard
15856 So here then is an example that use all these features:
15859 \begin_layout LyX-Code
15860 !authoredit {%author%[[%author%, ]][[{%editor%[[%editor%, %_edtext%, ]]}]]}
15863 \begin_layout Standard
15864 The defines a macro that prints the author, followed by a comma, if the
15866 \begin_inset Flex CharStyle:Code
15869 \begin_layout Plain Layout
15875 key is defined, or else prints the name of the editor, followed by the
15877 \begin_inset Flex CharStyle:Code
15880 \begin_layout Plain Layout
15886 or its translation (it is by default
15887 \begin_inset Quotes eld
15891 \begin_inset Quotes erd
15895 \begin_inset Flex CharStyle:Code
15898 \begin_layout Plain Layout
15905 Note that this is in fact defined in
15906 \begin_inset Flex CharStyle:Code
15909 \begin_layout Plain Layout
15915 , so you can use it in your own definitions, or re-definitions, if you load
15919 \begin_layout Section
15920 \begin_inset CommandInset label
15922 name "sec:Tags-for-XHTML"
15926 Tags for XHTML output
15929 \begin_layout Standard
15930 As with LaTeX or DocBook, the format of LyX's XHTML output is also controlled
15931 by layout information.
15932 In general, LyX provides sensible defaults and, as mentioned earlier, it
15933 will even construct default CSS style rules from the other layout tags.
15934 For example, LyX will attempt to use the information provided in the
15935 \begin_inset Flex CharStyle:Code
15938 \begin_layout Plain Layout
15944 declaration for the Chapter style to write CSS that will appropriately
15945 format chapter headings.
15948 \begin_layout Standard
15949 In many cases, then, you may not have to do anything at all to get acceptable
15950 XHTML output for your own environments, custom insets, and so forth.
15951 But in some cases you will, and so LyX provides a number of layout tags
15952 that can be used to customize the XHTML and CSS that are generated.
15955 \begin_layout Standard
15956 Note that there are two tags,
15957 \begin_inset Flex CharStyle:Code
15960 \begin_layout Plain Layout
15967 \begin_inset Flex CharStyle:Code
15970 \begin_layout Plain Layout
15976 that may appear outside style and inset declarations.
15978 \begin_inset CommandInset ref
15979 LatexCommand prettyref
15980 reference "sub:General-text-class"
15984 for details on these.
15987 \begin_layout Subsection
15988 \begin_inset CommandInset label
15990 name "sub:Paragraph-Style-XHTML"
15997 \begin_layout Standard
15998 The sort of XHTML LyX outputs for a paragraph depends upon whether we are
15999 dealing with a normal paragraph, a command, or an environment, where this
16000 is itself determined by the contents of the corresponding
16001 \begin_inset Flex CharStyle:Code
16004 \begin_layout Plain Layout
16014 \begin_layout Standard
16015 For a command or normal paragraph, the output XHTML has the following form:
16018 \begin_layout LyX-Code
16020 \begin_inset Quotes erd
16024 \begin_inset Quotes erd
16030 \begin_layout LyX-Code
16032 \begin_inset Quotes erd
16036 \begin_inset Quotes erd
16042 \begin_layout LyX-Code
16043 Contents of the paragraph.
16046 \begin_layout LyX-Code
16050 \begin_layout Standard
16051 The label tags are of course omitted if the paragraph does not have a label.
16054 \begin_layout Standard
16055 For an environment that is not some sort of list, the XHTML takes this form:
16058 \begin_layout LyX-Code
16060 \begin_inset Quotes erd
16064 \begin_inset Quotes erd
16070 \begin_layout LyX-Code
16072 \begin_inset Quotes erd
16076 \begin_inset Quotes erd
16080 \begin_inset Quotes erd
16084 \begin_inset Quotes erd
16087 >Environment Label</labeltag>First paragraph.</itemtag>
16090 \begin_layout LyX-Code
16091 <itemtag>Second paragraph.</itemtag>
16094 \begin_layout LyX-Code
16098 \begin_layout Standard
16099 Note that the label is output only for the first paragraph, as it should
16100 be for a theorem, for example.
16104 \begin_layout Standard
16105 For a list, we have one of these forms:
16108 \begin_layout LyX-Code
16110 \begin_inset Quotes erd
16114 \begin_inset Quotes erd
16120 \begin_layout LyX-Code
16122 \begin_inset Quotes erd
16126 \begin_inset Quotes erd
16130 \begin_inset Quotes erd
16134 \begin_inset Quotes erd
16137 >List Label</labeltag>First item.</itemtag>
16140 \begin_layout LyX-Code
16142 \begin_inset Quotes erd
16146 \begin_inset Quotes erd
16150 \begin_inset Quotes erd
16154 \begin_inset Quotes erd
16157 >List Label</labeltag>Second item.</itemtag>
16160 \begin_layout LyX-Code
16164 \begin_layout LyX-Code
16168 \begin_layout LyX-Code
16170 \begin_inset Quotes erd
16174 \begin_inset Quotes erd
16180 \begin_layout LyX-Code
16182 \begin_inset Quotes erd
16186 \begin_inset Quotes erd
16189 >List Label</labeltag><itemtag attr=
16190 \begin_inset Quotes erd
16194 \begin_inset Quotes erd
16197 >First item.</itemtag>
16200 \begin_layout LyX-Code
16202 \begin_inset Quotes erd
16206 \begin_inset Quotes erd
16209 >List Label</labeltag><itemtag attr=
16210 \begin_inset Quotes erd
16214 \begin_inset Quotes erd
16217 >Second item.</itemtag>
16220 \begin_layout LyX-Code
16224 \begin_layout Standard
16225 Note the different orders of
16226 \begin_inset Flex CharStyle:Code
16229 \begin_layout Plain Layout
16236 \begin_inset Flex CharStyle:Code
16239 \begin_layout Plain Layout
16246 Which order we get depends upon the setting of
16247 \begin_inset Flex CharStyle:Code
16250 \begin_layout Plain Layout
16257 \begin_inset Flex CharStyle:Code
16260 \begin_layout Plain Layout
16266 is false (the default), you get the first of these, with the label within
16267 the item; if true, you get the second, with the label outside the item.
16270 \begin_layout Standard
16271 The specific tags and attributes output for each paragraph type can be controlle
16272 d by means of the layout tags we are about to describe.
16273 As mentioned earlier, however, LyX uses sensible defaults for many of these,
16274 so you often may not need to do very much to get good XHTML output.
16275 Think of the available tags as there so you can tweak things to your liking.
16278 \begin_layout Description
16279 \begin_inset Flex CharStyle:Code
16282 \begin_layout Plain Layout
16289 \begin_inset Flex CharStyle:Code
16292 \begin_layout Plain Layout
16298 ] Specifies attribute information to be output with the main tag.
16300 \begin_inset Quotes eld
16304 \begin_inset Flex CharStyle:Code
16307 \begin_layout Plain Layout
16314 \begin_inset Quotes erd
16318 By default, LyX will output
16319 \begin_inset Quotes eld
16323 \begin_inset Flex CharStyle:Code
16326 \begin_layout Plain Layout
16333 \begin_inset Quotes erd
16337 \begin_inset Flex CharStyle:Code
16340 \begin_layout Plain Layout
16346 is the LyX name of the layout, made lowercase, for example: chapter.
16349 \begin_layout Description
16350 \begin_inset Flex CharStyle:Code
16353 \begin_layout Plain Layout
16360 \begin_inset Flex CharStyle:Code
16363 \begin_layout Plain Layout
16373 ] Whether to output the default CSS information LyX generates for this layout,
16374 even if additional information is explicitly provided via
16375 \begin_inset Flex CharStyle:Code
16378 \begin_layout Plain Layout
16386 \begin_inset Flex CharStyle:Code
16389 \begin_layout Plain Layout
16395 allows you to alter or augment the generated CSS, rather than to override
16398 \begin_inset Flex CharStyle:Code
16401 \begin_layout Plain Layout
16410 \begin_layout Description
16411 \begin_inset Flex CharStyle:Code
16414 \begin_layout Plain Layout
16421 \begin_inset Flex CharStyle:Code
16424 \begin_layout Plain Layout
16430 ] The tag to be used for individual paragraphs of environments, replacing
16432 \begin_inset Flex CharStyle:Code
16435 \begin_layout Plain Layout
16441 in the examples above.
16443 \begin_inset Flex CharStyle:Code
16446 \begin_layout Plain Layout
16455 \begin_layout Description
16456 \begin_inset Flex CharStyle:Code
16459 \begin_layout Plain Layout
16466 \begin_inset Flex CharStyle:Code
16469 \begin_layout Plain Layout
16475 ] Attributes for the item tag.
16477 \begin_inset Quotes eld
16481 \begin_inset Flex CharStyle:Code
16484 \begin_layout Plain Layout
16485 class=`layoutname_item'
16491 \begin_inset Quotes erd
16497 \begin_layout Description
16498 \begin_inset Flex CharStyle:Code
16501 \begin_layout Plain Layout
16508 \begin_inset Flex CharStyle:Code
16511 \begin_layout Plain Layout
16517 ] The tag to be used for paragraph and item labels, replacing
16518 \begin_inset Flex CharStyle:Code
16521 \begin_layout Plain Layout
16527 in the examples above.
16529 \begin_inset Flex CharStyle:Code
16532 \begin_layout Plain Layout
16541 \begin_layout Description
16542 \begin_inset Flex CharStyle:Code
16545 \begin_layout Plain Layout
16552 \begin_inset Flex CharStyle:Code
16555 \begin_layout Plain Layout
16561 ] Attributes for the label tag.
16563 \begin_inset Quotes eld
16567 \begin_inset Flex CharStyle:Code
16570 \begin_layout Plain Layout
16571 class=`layoutname_label'
16577 \begin_inset Quotes erd
16583 \begin_layout Description
16584 \begin_inset Flex CharStyle:Code
16587 \begin_layout Plain Layout
16594 \begin_inset Flex CharStyle:Code
16597 \begin_layout Plain Layout
16607 ] Meaningful only for list-like environments, this tag controls whether
16608 the label tag is output before or inside the item tag.
16609 This is used, for example, in the description environment, where we want
16611 \begin_inset Flex CharStyle:Code
16614 \begin_layout Plain Layout
16615 <dt>\SpecialChar \ldots{}
16616 </dt><dd>\SpecialChar \ldots{}
16624 \begin_inset Flex CharStyle:Code
16627 \begin_layout Plain Layout
16633 : The label tag is output inside the item tag.
16636 \begin_layout Description
16637 \begin_inset Flex CharStyle:Code
16640 \begin_layout Plain Layout
16646 Information to be output in the
16647 \begin_inset Flex CharStyle:Code
16650 \begin_layout Plain Layout
16656 section when this style is used.
16657 This might, for example, be used to include a
16658 \begin_inset Flex CharStyle:Code
16661 \begin_layout Plain Layout
16668 \begin_inset Flex CharStyle:Code
16671 \begin_layout Plain Layout
16680 \begin_layout Description
16681 \begin_inset Flex CharStyle:Code
16684 \begin_layout Plain Layout
16690 CSS style information to be included when this style is used.
16691 Note that this will automatically be wrapped in a layout-generated
16692 \begin_inset Flex CharStyle:Code
16695 \begin_layout Plain Layout
16701 block, so only the CSS itself need be included.
16704 \begin_layout Description
16705 \begin_inset Flex CharStyle:Code
16708 \begin_layout Plain Layout
16715 \begin_inset Flex CharStyle:Code
16718 \begin_layout Plain Layout
16724 ] The tag to be used for the main label, replacing
16725 \begin_inset Flex CharStyle:Code
16728 \begin_layout Plain Layout
16734 in the examples above.
16736 \begin_inset Flex CharStyle:Code
16739 \begin_layout Plain Layout
16748 \begin_layout Description
16749 \begin_inset Flex CharStyle:Code
16752 \begin_layout Plain Layout
16759 \begin_inset Flex CharStyle:Code
16762 \begin_layout Plain Layout
16772 ] Marks this style as the one to be used to generate the
16773 \begin_inset Flex CharStyle:Code
16776 \begin_layout Plain Layout
16782 tag for the XHTML file.
16783 By default, it is false.
16785 \begin_inset Flex CharStyle:Code
16788 \begin_layout Plain Layout
16794 file sets it to true for the
16795 \begin_inset Flex CharStyle:Code
16798 \begin_layout Plain Layout
16808 \begin_layout Subsection
16812 \begin_layout Standard
16813 The XHTML output of insets can also be controlled by information in layout
16818 \begin_layout Plain Layout
16819 At present, this is true only for
16820 \begin_inset Quotes eld
16824 \begin_inset Quotes erd
16827 insets (insets you can type into) and is not true for
16828 \begin_inset Quotes eld
16832 \begin_inset Quotes erd
16835 insets (insets that are associated with dialog boxes).
16840 Here, too, LyX tries to provide sensible defaults, and it constructs default
16842 But everything can be customized.
16845 \begin_layout Standard
16846 The XHTML LyX outputs for an inset has the following form:
16849 \begin_layout LyX-Code
16851 \begin_inset Quotes erd
16855 \begin_inset Quotes erd
16861 \begin_layout LyX-Code
16862 <labeltag>Label</labeltag>
16865 \begin_layout LyX-Code
16867 \begin_inset Quotes erd
16871 \begin_inset Quotes erd
16874 >Contents of the inset.</innertag>
16877 \begin_layout LyX-Code
16881 \begin_layout Standard
16882 If the inset permits multiple paragraphs---that is, if
16883 \begin_inset Flex CharStyle:Code
16886 \begin_layout Plain Layout
16892 is true---then the contents of the inset will itself be output as paragraphs
16893 formatted according to the styles used for those paragraphs (standard,
16894 quote, and the like).
16895 The label tag is of course omitted if the paragraph does not have a label
16896 and, at present, is always
16897 \begin_inset Flex CharStyle:Code
16900 \begin_layout Plain Layout
16907 The inner tag is optional and, by default, does not appear.
16910 \begin_layout Standard
16911 The specific tags and attributes output for each inset can be controlled
16912 by means of the following layout tags.
16915 \begin_layout Description
16916 \begin_inset Flex CharStyle:Code
16919 \begin_layout Plain Layout
16926 \begin_inset Flex CharStyle:Code
16929 \begin_layout Plain Layout
16935 ] Specifies attribute information to be output with the main tag.
16937 \begin_inset Quotes eld
16941 \begin_inset Flex CharStyle:Code
16944 \begin_layout Plain Layout
16945 class=`myinset' onclick=`\SpecialChar \ldots{}
16952 \begin_inset Quotes erd
16956 By default, LyX will output
16957 \begin_inset Quotes eld
16961 \begin_inset Flex CharStyle:Code
16964 \begin_layout Plain Layout
16971 \begin_inset Quotes erd
16975 \begin_inset Flex CharStyle:Code
16978 \begin_layout Plain Layout
16984 is the LyX name of the inset, made lowercase and with non-alphanumeric
16985 characters converted to underscores, for example: footnote.
16988 \begin_layout Description
16989 \begin_inset Flex CharStyle:Code
16992 \begin_layout Plain Layout
16999 \begin_inset Flex CharStyle:Code
17002 \begin_layout Plain Layout
17012 ] Whether to output the default CSS information LyX generates for this layout,
17013 even if additional information is explicitly provided via
17014 \begin_inset Flex CharStyle:Code
17017 \begin_layout Plain Layout
17025 \begin_inset Flex CharStyle:Code
17028 \begin_layout Plain Layout
17034 allows you to alter or augment the generated CSS, rather than to override
17039 \begin_layout Description
17040 \begin_inset Flex CharStyle:Code
17043 \begin_layout Plain Layout
17050 \begin_inset Flex CharStyle:Code
17053 \begin_layout Plain Layout
17059 ] Attributes for the inner tag.
17061 \begin_inset Quotes eld
17065 \begin_inset Flex CharStyle:Code
17068 \begin_layout Plain Layout
17069 class=`insetname_inner'
17075 \begin_inset Quotes erd
17081 \begin_layout Description
17082 \begin_inset Flex CharStyle:Code
17085 \begin_layout Plain Layout
17092 \begin_inset Flex CharStyle:Code
17095 \begin_layout Plain Layout
17101 ] The inner tag, replacing
17102 \begin_inset Flex CharStyle:Code
17105 \begin_layout Plain Layout
17111 in the examples above.
17112 By default, there is none.
17115 \begin_layout Description
17116 \begin_inset Flex CharStyle:Code
17119 \begin_layout Plain Layout
17126 \begin_inset Flex CharStyle:Code
17129 \begin_layout Plain Layout
17137 ] Whether this inset represents a standalone block of text (such as a footnote)
17138 or instead represents material that is included in the surrounding text
17139 (such as a branch).
17143 \begin_layout Description
17144 \begin_inset Flex CharStyle:Code
17147 \begin_layout Plain Layout
17154 \begin_inset Flex CharStyle:Code
17157 \begin_layout Plain Layout
17163 ] A label for this inset, possibly including a reference to a counter.
17164 For example, for footnote, it might be:
17165 \begin_inset Flex CharStyle:Code
17168 \begin_layout Plain Layout
17177 This is optional, and there is no default.
17180 \begin_layout Description
17181 \begin_inset Flex CharStyle:Code
17184 \begin_layout Plain Layout
17190 Information to be output in the
17191 \begin_inset Flex CharStyle:Code
17194 \begin_layout Plain Layout
17200 section when this style is used.
17201 This might, for example, be used to include a
17202 \begin_inset Flex CharStyle:Code
17205 \begin_layout Plain Layout
17212 \begin_inset Flex CharStyle:Code
17215 \begin_layout Plain Layout
17224 \begin_layout Description
17225 \begin_inset Flex CharStyle:Code
17228 \begin_layout Plain Layout
17234 CSS style information to be included when this style is used.
17235 Note that this will automatically be wrapped in a layout-generated
17236 \begin_inset Flex CharStyle:Code
17239 \begin_layout Plain Layout
17245 block, so only the CSS itself need be included.
17248 \begin_layout Description
17249 \begin_inset Flex CharStyle:Code
17252 \begin_layout Plain Layout
17259 \begin_inset Flex CharStyle:Code
17262 \begin_layout Plain Layout
17268 ] The tag to be used for the main label, replacing
17269 \begin_inset Flex CharStyle:Code
17272 \begin_layout Plain Layout
17278 in the examples above.
17279 The default depends upon the setting of
17280 \begin_inset Flex CharStyle:Code
17283 \begin_layout Plain Layout
17290 \begin_inset Flex CharStyle:Code
17293 \begin_layout Plain Layout
17299 is true, the default is
17300 \begin_inset Flex CharStyle:Code
17303 \begin_layout Plain Layout
17309 ; if it is false, the default is
17310 \begin_inset Flex CharStyle:Code
17313 \begin_layout Plain Layout
17322 \begin_layout Subsection
17326 \begin_layout Standard
17327 The XHTML output for floats too can be controlled by layout information.
17328 The output has the following form:
17331 \begin_layout LyX-Code
17333 \begin_inset Quotes erd
17337 \begin_inset Quotes erd
17343 \begin_layout LyX-Code
17344 Contents of the float.
17347 \begin_layout LyX-Code
17351 \begin_layout Standard
17352 The caption, if there is one, is a separate inset and will be output as
17354 Its appearance can be controlled via the InsetLayout for caption insets.
17358 \begin_layout Description
17359 \begin_inset Flex CharStyle:Code
17362 \begin_layout Plain Layout
17369 \begin_inset Flex CharStyle:Code
17372 \begin_layout Plain Layout
17378 ] Specifies attribute information to be output with the main tag.
17380 \begin_inset Quotes eld
17384 \begin_inset Flex CharStyle:Code
17387 \begin_layout Plain Layout
17388 class=`myfloat' onclick=`\SpecialChar \ldots{}
17395 \begin_inset Quotes erd
17399 By default, LyX will output
17400 \begin_inset Quotes eld
17404 \begin_inset Flex CharStyle:Code
17407 \begin_layout Plain Layout
17408 class=`float float-floattype'
17414 \begin_inset Quotes erd
17418 \begin_inset Flex CharStyle:Code
17421 \begin_layout Plain Layout
17427 is LyX's name for this type of float, as determined by the float delcaration
17429 \begin_inset CommandInset ref
17431 reference "sub:Floats"
17435 ), though made lowercase and with non-alphanumeric characters converted
17436 to underscores, for example: float-table.
17439 \begin_layout Description
17440 \begin_inset Flex CharStyle:Code
17443 \begin_layout Plain Layout
17449 CSS style information to be included when this float is used.
17450 Note that this will automatically be wrapped in a layout-generated
17451 \begin_inset Flex CharStyle:Code
17454 \begin_layout Plain Layout
17460 block, so only the CSS itself need be included.
17463 \begin_layout Description
17464 \begin_inset Flex CharStyle:Code
17467 \begin_layout Plain Layout
17474 \begin_inset Flex CharStyle:Code
17477 \begin_layout Plain Layout
17483 ] The tag to be used for this float, replacing
17484 \begin_inset Quotes eld
17488 \begin_inset Flex CharStyle:Code
17491 \begin_layout Plain Layout
17498 \begin_inset Quotes erd
17501 in the example above.
17503 \begin_inset Flex CharStyle:Code
17506 \begin_layout Plain Layout
17512 and will rarely need changing.
17515 \begin_layout Subsection
17516 Bibliography formatting
17519 \begin_layout Standard
17520 The bibliography can be formatted using
17521 \begin_inset Flex CharStyle:Code
17524 \begin_layout Plain Layout
17532 \begin_inset CommandInset ref
17534 reference "sub:Citation-format-description"
17541 \begin_layout Subsection
17545 \begin_layout Standard
17546 We have several times mentioned that LyX will generate default CSS style
17547 rules for both insets and paragraph styles, based upon the other layout
17548 information that is provided.
17549 In this section, we shall say a word about which layout information LyX
17553 \begin_layout Standard
17554 At present, LyX auto-generates CSS only for font information, making use
17556 \begin_inset Flex CharStyle:Code
17559 \begin_layout Plain Layout
17566 \begin_inset Flex CharStyle:Code
17569 \begin_layout Plain Layout
17576 \begin_inset Flex CharStyle:Code
17579 \begin_layout Plain Layout
17586 \begin_inset Flex CharStyle:Code
17589 \begin_layout Plain Layout
17596 \begin_inset Flex CharStyle:Code
17599 \begin_layout Plain Layout
17607 \begin_inset CommandInset ref
17609 reference "sub:Font-description"
17613 .) The translation is mostly straightforward and obvious.
17615 \begin_inset Quotes eld
17619 \begin_inset Flex CharStyle:Code
17622 \begin_layout Plain Layout
17629 \begin_inset Quotes erd
17633 \begin_inset Quotes eld
17637 \begin_inset Flex CharStyle:Code
17640 \begin_layout Plain Layout
17641 font-family: sans-serif;
17647 \begin_inset Quotes erd
17651 The correspondence of LyX sizes and CSS sizes is a little less obvious
17652 but nonetheless intuitive.
17654 \begin_inset Flex CharStyle:Code
17657 \begin_layout Plain Layout
17664 \begin_inset Flex URL
17667 \begin_layout Plain Layout
17678 \begin_layout Chapter
17679 Including External Material
17682 \begin_layout Standard
17683 \begin_inset Box Shadowbox
17692 height_special "totalheight"
17695 \begin_layout Plain Layout
17696 WARNING: This portion of the documentation has not been updated for some
17698 We certainly hope that it is still accurate, but there are no guarantees.
17706 \begin_layout Standard
17707 The use of material from sources external to LyX is covered in detail in
17713 This part of the manual covers what needs to happen behind the scenes for
17714 new sorts of material to be included.
17717 \begin_layout Section
17721 \begin_layout Standard
17722 The external material feature is based on the concept of a
17727 A template is a specification of how LyX should interface with a certain
17729 As bundled, LyX comes with predefined templates for Xfig figures, various
17730 raster format images, chess diagrams, and LilyPond music notation.
17731 You can check the actual list by using the menu
17732 \begin_inset Flex CharStyle:MenuItem
17735 \begin_layout Plain Layout
17736 Insert\SpecialChar \menuseparator
17737 File\SpecialChar \menuseparator
17744 Furthermore, it is possible to roll your own template to support a specific
17746 Later we'll describe in more detail what is involved, and hopefully you
17747 will submit all the templates you create so we can include them in a later
17751 \begin_layout Standard
17752 Another basic idea of the external material feature is to distinguish between
17753 the original file that serves as a base for final material and the produced
17754 file that is included in your exported or printed document.
17755 For example, consider the case of a figure produced with
17756 \begin_inset Flex CharStyle:Code
17759 \begin_layout Plain Layout
17766 The Xfig application itself works on an original file with the
17767 \begin_inset Flex CharStyle:Code
17770 \begin_layout Plain Layout
17777 Within Xfig, you create and change your figure, and when you are done,
17779 \begin_inset Flex CharStyle:Code
17782 \begin_layout Plain Layout
17789 When you want to include the figure in your document, you invoke
17790 \begin_inset Flex CharStyle:Code
17793 \begin_layout Plain Layout
17799 in order to create a PostScript file that can readily be included in your
17802 \begin_inset Flex CharStyle:Code
17805 \begin_layout Plain Layout
17811 file is the original file, and the PostScript file is the produced file.
17814 \begin_layout Standard
17815 This distinction is important in order to allow updating of the material
17816 while you are in the process of writing the document.
17817 Furthermore, it provides us with the flexibility that is needed to support
17818 multiple export formats.
17819 For instance, in the case of a plain text file, it is not exactly an award-winn
17820 ing idea to include the figure as raw PostScript.
17821 Instead, you'd either prefer to just include a reference to the figure
17822 or try to invoke some graphics to ASCII converter to make the final result
17823 look similar to the real graphics.
17824 The external material management allows you to do this, because it is parametri
17825 zed on the different export formats that LyX supports.
17828 \begin_layout Standard
17829 Besides supporting the production of different products according to the
17830 exported format, it supports tight integration with editing and viewing
17832 In the case of an Xfig figure, you are able to invoke Xfig on the original
17833 file with a single click from within the external material dialog in LyX,
17834 and also preview the produced PostScript file with Ghostview with another
17836 No more fiddling around with the command line and/or file browsers to locate
17837 and manipulate the original or produced files.
17838 In this way, you are finally able to take full advantage of the many different
17839 applications that are relevant to use when you write your documents, and
17840 ultimately be more productive.
17843 \begin_layout Section
17844 The external template configuration file
17847 \begin_layout Standard
17848 It is relatively easy to add custom external template definitions to LyX.
17849 However, be aware that doing this in an careless manner most probably
17853 introduce an easily exploitable security hole.
17854 So before you do this, please read the discussion about security in section
17856 \begin_inset CommandInset ref
17858 reference "sec:Security-discussion"
17865 \begin_layout Standard
17866 Having said that, we encourage you to submit any interesting templates that
17871 \begin_layout Standard
17872 The external templates are defined in the
17873 \begin_inset Flex CharStyle:Code
17876 \begin_layout Plain Layout
17877 LyXDir/lib/external_templates
17883 You can place your own version in
17884 \begin_inset Flex CharStyle:Code
17887 \begin_layout Plain Layout
17888 UserDir/external_templates
17896 \begin_layout Standard
17897 A typical template looks like this:
17900 \begin_layout LyX-Code
17904 \begin_layout LyX-Code
17905 GuiName "XFig: $$AbsOrRelPathParent$$Basename"
17908 \begin_layout LyX-Code
17912 \begin_layout LyX-Code
17916 \begin_layout LyX-Code
17920 \begin_layout LyX-Code
17924 \begin_layout LyX-Code
17928 \begin_layout LyX-Code
17929 AutomaticProduction true
17932 \begin_layout LyX-Code
17936 \begin_layout LyX-Code
17940 \begin_layout LyX-Code
17944 \begin_layout LyX-Code
17945 TransformCommand Rotate RotationLatexCommand
17948 \begin_layout LyX-Code
17949 TransformCommand Resize ResizeLatexCommand
17952 \begin_layout LyX-Code
17953 Product "$$RotateFront$$ResizeFront
17956 \begin_layout LyX-Code
17961 input{$$AbsOrRelPathMaster$$Basename.pstex_t}
17964 \begin_layout LyX-Code
17965 $$ResizeBack$$RotateBack"
17968 \begin_layout LyX-Code
17972 \begin_layout LyX-Code
17973 UpdateResult "$$AbsPath$$Basename.pstex_t"
17976 \begin_layout LyX-Code
17977 Requirement "graphicx"
17980 \begin_layout LyX-Code
17981 ReferencedFile latex "$$AbsOrRelPathMaster$$Basename.pstex_t"
17984 \begin_layout LyX-Code
17985 ReferencedFile latex "$$AbsPath$$Basename.eps"
17988 \begin_layout LyX-Code
17989 ReferencedFile dvi "$$AbsPath$$Basename.eps"
17992 \begin_layout LyX-Code
17996 \begin_layout LyX-Code
18000 \begin_layout LyX-Code
18001 TransformCommand Rotate RotationLatexCommand
18004 \begin_layout LyX-Code
18005 TransformCommand Resize ResizeLatexCommand
18008 \begin_layout LyX-Code
18009 Product "$$RotateFront$$ResizeFront
18012 \begin_layout LyX-Code
18017 input{$$AbsOrRelPathMaster$$Basename.pdftex_t}
18020 \begin_layout LyX-Code
18021 $$ResizeBack$$RotateBack"
18024 \begin_layout LyX-Code
18025 UpdateFormat pdftex
18028 \begin_layout LyX-Code
18029 UpdateResult "$$AbsPath$$Basename.pdftex_t"
18032 \begin_layout LyX-Code
18033 Requirement "graphicx"
18036 \begin_layout LyX-Code
18037 ReferencedFile latex "$$AbsOrRelPathMaster$$Basename.pdftex_t"
18040 \begin_layout LyX-Code
18041 ReferencedFile latex "$$AbsPath$$Basename.pdf"
18044 \begin_layout LyX-Code
18048 \begin_layout LyX-Code
18052 \begin_layout LyX-Code
18053 Product "$$Contents(
18055 "$$AbsPath$$Basename.asc
18060 \begin_layout LyX-Code
18061 UpdateFormat asciixfig
18064 \begin_layout LyX-Code
18065 UpdateResult "$$AbsPath$$Basename.asc"
18068 \begin_layout LyX-Code
18072 \begin_layout LyX-Code
18076 \begin_layout LyX-Code
18077 Product "<graphic fileref=
18079 "$$AbsOrRelPathMaster$$Basename.eps
18084 \begin_layout LyX-Code
18088 \begin_layout LyX-Code
18092 \begin_layout LyX-Code
18093 UpdateResult "$$AbsPath$$Basename.eps"
18096 \begin_layout LyX-Code
18097 ReferencedFile docbook "$$AbsPath$$Basename.eps"
18100 \begin_layout LyX-Code
18101 ReferencedFile docbook-xml "$$AbsPath$$Basename.eps"
18104 \begin_layout LyX-Code
18108 \begin_layout LyX-Code
18109 Product "[XFig: $$FName]"
18112 \begin_layout LyX-Code
18116 \begin_layout LyX-Code
18120 \begin_layout Standard
18121 As you can see, the template is enclosed in
18122 \begin_inset Flex CharStyle:Code
18125 \begin_layout Plain Layout
18131 \SpecialChar \ldots{}
18133 \begin_inset Flex CharStyle:Code
18136 \begin_layout Plain Layout
18143 It contains a header specifying some general settings and, for each supported
18144 primary document file format, a section
18145 \begin_inset Flex CharStyle:Code
18148 \begin_layout Plain Layout
18154 \SpecialChar \ldots{}
18156 \begin_inset Flex CharStyle:Code
18159 \begin_layout Plain Layout
18168 \begin_layout Subsection
18169 The template header
18172 \begin_layout Description
18173 \begin_inset Flex CharStyle:Code
18176 \begin_layout Plain Layout
18177 AutomaticProduction
18178 \begin_inset space ~
18186 Whether the file represented by the template must be generated by LyX.
18187 This command must occur exactly once.
18190 \begin_layout Description
18191 \begin_inset Flex CharStyle:Code
18194 \begin_layout Plain Layout
18196 \begin_inset space ~
18204 A glob pattern that is used in the file dialog to filter out the desired
18206 If there is more than one possible file extension (e.
18207 \begin_inset space \thinspace{}
18211 \begin_inset space \space{}
18215 \begin_inset Flex CharStyle:Code
18218 \begin_layout Plain Layout
18225 \begin_inset Flex CharStyle:Code
18228 \begin_layout Plain Layout
18234 ), use something like
18235 \begin_inset Flex CharStyle:Code
18238 \begin_layout Plain Layout
18245 This command must occur exactly once.
18248 \begin_layout Description
18249 \begin_inset Flex CharStyle:Code
18252 \begin_layout Plain Layout
18254 \begin_inset space ~
18262 The text that is displayed on the button.
18263 This command must occur exactly once.
18266 \begin_layout Description
18267 \begin_inset Flex CharStyle:Code
18270 \begin_layout Plain Layout
18272 \begin_inset space ~
18276 \begin_inset space ~
18284 The help text that is used in the External dialog.
18285 Provide enough information to explain to the user just what the template
18286 can provide him with.
18287 This command must occur exactly once.
18290 \begin_layout Description
18291 \begin_inset Flex CharStyle:Code
18294 \begin_layout Plain Layout
18296 \begin_inset space ~
18304 The file format of the original file.
18305 This must be the name of a format that is known to LyX (see section
18306 \begin_inset CommandInset ref
18308 reference "sec:Formats"
18314 \begin_inset Quotes eld
18318 \begin_inset Flex CharStyle:Code
18321 \begin_layout Plain Layout
18328 \begin_inset Quotes erd
18331 if the template can handle original files of more than one format.
18332 LyX will attempt to interrogate the file itself in order to deduce its
18333 format in this case.
18334 This command must occur exactly once.
18337 \begin_layout Description
18338 \begin_inset Flex CharStyle:Code
18341 \begin_layout Plain Layout
18343 \begin_inset space ~
18351 A unique name for the template.
18352 It must not contain substitution macros (see below).
18355 \begin_layout Description
18356 \begin_inset Flex CharStyle:Code
18359 \begin_layout Plain Layout
18361 \begin_inset space ~
18364 Rotate|Resize|Clip|Extra
18369 This command specifies which transformations are supported by this template.
18370 It may occur zero or more times.
18371 This command enables the corresponding tabs in the external dialog.
18373 \begin_inset Flex CharStyle:Code
18376 \begin_layout Plain Layout
18382 command must have either a corresponding
18383 \begin_inset Flex CharStyle:Code
18386 \begin_layout Plain Layout
18393 \begin_inset Flex CharStyle:Code
18396 \begin_layout Plain Layout
18403 \begin_inset Flex CharStyle:Code
18406 \begin_layout Plain Layout
18413 Otherwise the transformation will not be supported by that format.
18416 \begin_layout Subsection
18420 \begin_layout Description
18421 \begin_inset Flex CharStyle:Code
18424 \begin_layout Plain Layout
18426 \begin_inset space ~
18429 LaTeX|PDFLaTeX|PlainText|DocBook
18434 The primary document file format that this format definition is for.
18435 Not every template has a sensible representation in all document file formats.
18436 Please define nevertheless a
18437 \begin_inset Flex CharStyle:Code
18440 \begin_layout Plain Layout
18446 section for all formats.
18447 Use a dummy text when no representation is available.
18448 Then you can at least see a reference to the external material in the exported
18452 \begin_layout Description
18453 \begin_inset Flex CharStyle:Code
18456 \begin_layout Plain Layout
18458 \begin_inset space ~
18462 \begin_inset space ~
18470 This command defines an additional macro
18471 \begin_inset Flex CharStyle:Code
18474 \begin_layout Plain Layout
18480 for substitution in
18481 \begin_inset Flex CharStyle:Code
18484 \begin_layout Plain Layout
18492 \begin_inset Flex CharStyle:Code
18495 \begin_layout Plain Layout
18501 itself may contain substitution macros.
18502 The advantage over using
18503 \begin_inset Flex CharStyle:Code
18506 \begin_layout Plain Layout
18513 \begin_inset Flex CharStyle:Code
18516 \begin_layout Plain Layout
18522 is that the substituted value of
18523 \begin_inset Flex CharStyle:Code
18526 \begin_layout Plain Layout
18532 is sanitized so that it is a valid optional argument in the document format.
18533 This command may occur zero or more times.
18536 \begin_layout Description
18537 \begin_inset Flex CharStyle:Code
18540 \begin_layout Plain Layout
18542 \begin_inset space ~
18550 The text that is inserted in the exported document.
18551 This is actually the most important command and can be quite complex.
18552 This command must occur exactly once.
18555 \begin_layout Description
18556 \begin_inset Flex CharStyle:Code
18559 \begin_layout Plain Layout
18561 \begin_inset space ~
18569 This command specifies a preamble snippet that will be included in the
18571 It has to be defined using
18572 \begin_inset Flex CharStyle:Code
18575 \begin_layout Plain Layout
18581 \SpecialChar \ldots{}
18583 \begin_inset Flex CharStyle:Code
18586 \begin_layout Plain Layout
18593 This command may occur zero or more times.
18596 \begin_layout Description
18597 \begin_inset Flex CharStyle:Code
18600 \begin_layout Plain Layout
18602 \begin_inset space ~
18606 \begin_inset space ~
18614 This command denotes files that are created by the conversion process and
18615 are needed for a particular export format.
18616 If the filename is relative, it is interpreted relative to the master document.
18617 This command may be given zero or more times.
18620 \begin_layout Description
18621 \begin_inset Flex CharStyle:Code
18624 \begin_layout Plain Layout
18626 \begin_inset space ~
18634 The name of a required LaTeX package.
18635 The package is included via
18636 \begin_inset Flex CharStyle:Code
18639 \begin_layout Plain Layout
18647 in the LaTeX preamble.
18648 This command may occur zero or more times.
18651 \begin_layout Description
18652 \begin_inset Flex CharStyle:Code
18655 \begin_layout Plain Layout
18657 \begin_inset space ~
18661 \begin_inset space ~
18664 RotationLatexCommand
18669 This command specifies that the built in LaTeX command should be used for
18671 This command may occur once or not at all.
18674 \begin_layout Description
18675 \begin_inset Flex CharStyle:Code
18678 \begin_layout Plain Layout
18680 \begin_inset space ~
18684 \begin_inset space ~
18692 This command specifies that the built in LaTeX command should be used for
18694 This command may occur once or not at all.
18697 \begin_layout Description
18698 \begin_inset Flex CharStyle:Code
18701 \begin_layout Plain Layout
18703 \begin_inset space ~
18707 \begin_inset space ~
18710 RotationLatexOption
18715 This command specifies that rotation is done via an optional argument.
18716 This command may occur once or not at all.
18719 \begin_layout Description
18720 \begin_inset Flex CharStyle:Code
18723 \begin_layout Plain Layout
18725 \begin_inset space ~
18729 \begin_inset space ~
18737 This command specifies that resizing is done via an optional argument.
18738 This command may occur once or not at all.
18741 \begin_layout Description
18742 \begin_inset Flex CharStyle:Code
18745 \begin_layout Plain Layout
18747 \begin_inset space ~
18751 \begin_inset space ~
18759 This command specifies that clipping is done via an optional argument.
18760 This command may occur once or not at all.
18763 \begin_layout Description
18764 \begin_inset Flex CharStyle:Code
18767 \begin_layout Plain Layout
18769 \begin_inset space ~
18773 \begin_inset space ~
18781 This command specifies that an extra optional argument is used.
18782 This command may occur once or not at all.
18785 \begin_layout Description
18786 \begin_inset Flex CharStyle:Code
18789 \begin_layout Plain Layout
18791 \begin_inset space ~
18799 The file format of the converted file.
18800 This must be the name of a format that is known to LyX (see the
18801 \begin_inset Flex CharStyle:MenuItem
18804 \begin_layout Plain Layout
18809 ools\SpecialChar \menuseparator
18814 references:Conversion
18820 This command must occur exactly once.
18823 \begin_layout Description
18824 \begin_inset Flex CharStyle:Code
18827 \begin_layout Plain Layout
18829 \begin_inset space ~
18837 The file name of the converted file.
18838 The file name must be absolute.
18839 This command must occur exactly once.
18842 \begin_layout Subsection
18843 Preamble definitions
18846 \begin_layout Standard
18847 The external template configuration file may contain additional preamble
18848 definitions enclosed by
18849 \begin_inset Flex CharStyle:Code
18852 \begin_layout Plain Layout
18858 \SpecialChar \ldots{}
18860 \begin_inset Flex CharStyle:Code
18863 \begin_layout Plain Layout
18870 They can be used by the templates in the
18871 \begin_inset Flex CharStyle:Code
18874 \begin_layout Plain Layout
18883 \begin_layout Section
18884 The substitution mechanism
18887 \begin_layout Standard
18888 When the external material facility invokes an external program, it is done
18889 on the basis of a command defined in the template configuration file.
18890 These commands can contain various macros that are expanded before execution.
18891 Execution always take place in the directory of the containing document.
18894 \begin_layout Standard
18895 Also, whenever external material is to be displayed, the name will be produced
18896 by the substitution mechanism, and most other commands in the template
18897 definition support substitution as well.
18900 \begin_layout Standard
18901 The available macros are the following:
18904 \begin_layout Description
18905 \begin_inset Flex CharStyle:Code
18908 \begin_layout Plain Layout
18909 $$AbsOrRelPathMaster
18914 The file path, absolute or relative to the master LyX document.
18917 \begin_layout Description
18918 \begin_inset Flex CharStyle:Code
18921 \begin_layout Plain Layout
18922 $$AbsOrRelPathParent
18927 The file path, absolute or relative to the LyX document.
18930 \begin_layout Description
18931 \begin_inset Flex CharStyle:Code
18934 \begin_layout Plain Layout
18940 The absolute file path.
18943 \begin_layout Description
18944 \begin_inset Flex CharStyle:Code
18947 \begin_layout Plain Layout
18953 The filename without path and without the extension.
18956 \begin_layout Description
18957 \begin_inset Flex CharStyle:Code
18960 \begin_layout Plain Layout
18962 \begin_inset Quotes eld
18966 \begin_inset Quotes erd
18974 This macro will expand to the contents of the file with the name
18975 \begin_inset Flex CharStyle:Code
18978 \begin_layout Plain Layout
18987 \begin_layout Description
18988 \begin_inset Flex CharStyle:Code
18991 \begin_layout Plain Layout
18997 The file extension (including the dot).
19000 \begin_layout Description
19001 \begin_inset Flex CharStyle:Code
19004 \begin_layout Plain Layout
19010 The filename of the file specified in the external material dialog.
19011 This is either an absolute name, or it is relative to the LyX document.
19014 \begin_layout Description
19015 \begin_inset Flex CharStyle:Code
19018 \begin_layout Plain Layout
19025 \begin_inset Flex CharStyle:Code
19028 \begin_layout Plain Layout
19034 (absolute name or relative to the LyX document).
19037 \begin_layout Description
19038 \begin_inset Flex CharStyle:Code
19041 \begin_layout Plain Layout
19047 The file path, relative to the master LyX document.
19050 \begin_layout Description
19051 \begin_inset Flex CharStyle:Code
19054 \begin_layout Plain Layout
19060 The file path, relative to the LyX document.
19063 \begin_layout Description
19064 \begin_inset Flex CharStyle:Code
19067 \begin_layout Plain Layout
19073 This macro will expand to the absolute path of the system directory.
19074 This is typically used to point to the various helper scripts that are
19078 \begin_layout Description
19079 \begin_inset Flex CharStyle:Code
19082 \begin_layout Plain Layout
19088 A name and full path to a temporary file which will be automatically deleted
19089 whenever the containing document is closed, or the external material insertion
19093 \begin_layout Standard
19094 All path macros contain a trailing directory separator, so you can construct
19096 \begin_inset space \thinspace{}
19100 \begin_inset space \space{}
19103 the absolute filename with
19104 \begin_inset Flex CharStyle:Code
19107 \begin_layout Plain Layout
19108 $$AbsPath$$Basename$$Extension
19116 \begin_layout Standard
19117 The macros above are substituted in all commands unless otherwise noted.
19119 \begin_inset Flex CharStyle:Code
19122 \begin_layout Plain Layout
19128 supports additionally the following substitutions if they are enabled by
19130 \begin_inset Flex CharStyle:Code
19133 \begin_layout Plain Layout
19140 \begin_inset Flex CharStyle:Code
19143 \begin_layout Plain Layout
19152 \begin_layout Description
19153 \begin_inset Flex CharStyle:Code
19156 \begin_layout Plain Layout
19162 The front part of the resize command.
19165 \begin_layout Description
19166 \begin_inset Flex CharStyle:Code
19169 \begin_layout Plain Layout
19175 The back part of the resize command.
19178 \begin_layout Description
19179 \begin_inset Flex CharStyle:Code
19182 \begin_layout Plain Layout
19188 The front part of the rotation command.
19191 \begin_layout Description
19192 \begin_inset Flex CharStyle:Code
19195 \begin_layout Plain Layout
19201 The back part of the rotation command.
19204 \begin_layout Standard
19205 The value string of the
19206 \begin_inset Flex CharStyle:Code
19209 \begin_layout Plain Layout
19215 command supports additionally the following substitutions if they are enabled
19217 \begin_inset Flex CharStyle:Code
19220 \begin_layout Plain Layout
19227 \begin_inset Flex CharStyle:Code
19230 \begin_layout Plain Layout
19239 \begin_layout Description
19240 \begin_inset Flex CharStyle:Code
19243 \begin_layout Plain Layout
19252 \begin_layout Description
19253 \begin_inset Flex CharStyle:Code
19256 \begin_layout Plain Layout
19265 \begin_layout Description
19266 \begin_inset Flex CharStyle:Code
19269 \begin_layout Plain Layout
19278 \begin_layout Description
19279 \begin_inset Flex CharStyle:Code
19282 \begin_layout Plain Layout
19288 The rotation option.
19291 \begin_layout Standard
19292 You may ask why there are so many path macros.
19293 There are mainly two reasons:
19296 \begin_layout Enumerate
19297 Relative and absolute file names should remain relative or absolute, respectivel
19299 Users may have reasons to prefer either form.
19300 Relative names are useful for portable documents that should work on different
19301 machines, for example.
19302 Absolute names may be required by some programs.
19305 \begin_layout Enumerate
19306 LaTeX treats relative file names differently than LyX and other programs
19307 in nested included files.
19308 For LyX, a relative file name is always relative to the document that contains
19310 For LaTeX, it is always relative to the master document.
19311 These two definitions are identical if you have only one document, but
19312 differ if you have a master document that includes part documents.
19313 That means that relative filenames must be transformed when presented to
19315 Fortunately LyX does this automatically for you if you choose the right
19319 \begin_layout Standard
19320 So which path macro should be used in new template definitions? The rule
19324 \begin_layout Itemize
19326 \begin_inset Flex CharStyle:Code
19329 \begin_layout Plain Layout
19335 if an absolute path is required.
19338 \begin_layout Itemize
19340 \begin_inset Flex CharStyle:Code
19343 \begin_layout Plain Layout
19344 $$AbsOrRelPathMaster
19349 if the substituted string is some kind of LaTeX input.
19352 \begin_layout Itemize
19354 \begin_inset Flex CharStyle:Code
19357 \begin_layout Plain Layout
19358 $$AbsOrRelPathParent
19363 in order to preserve the user's choice.
19366 \begin_layout Standard
19367 There are special cases where this rule does not work and e.
19368 \begin_inset space \thinspace{}
19372 \begin_inset space \space{}
19375 relative names are needed, but normally it will work just fine.
19376 One example for such a case is the command
19377 \begin_inset Flex CharStyle:Code
19380 \begin_layout Plain Layout
19381 ReferencedFile latex "$$AbsOrRelPathMaster$$Basename.pstex_t"
19386 in the XFig template above: We can't use the absolute name because the
19388 \begin_inset Flex CharStyle:Code
19391 \begin_layout Plain Layout
19397 files needs the relative name in order to rewrite the file content.
19400 \begin_layout Section
19401 Security discussion
19402 \begin_inset CommandInset label
19404 name "sec:Security-discussion"
19411 \begin_layout Standard
19412 The external material feature interfaces with a lot of external programs
19413 and does so automatically, so we have to consider the security implications
19415 In particular, since you have the option of including your own filenames
19416 and/or parameter strings and those are expanded into a command, it seems
19417 that it would be possible to create a malicious document which executes
19418 arbitrary commands when a user views or prints the document.
19419 This is something we definitely want to avoid.
19422 \begin_layout Standard
19423 However, since the external program commands are specified in the template
19424 configuration file only, there are no security issues if LyX is properly
19425 configured with safe templates only.
19426 This is so because the external programs are invoked with the
19427 \begin_inset Flex CharStyle:Code
19430 \begin_layout Plain Layout
19436 -system call rather than the
19437 \begin_inset Flex CharStyle:Code
19440 \begin_layout Plain Layout
19446 system-call, so it's not possible to execute arbitrary commands from the
19447 filename or parameter section via the shell.
19450 \begin_layout Standard
19451 This also implies that you are restricted in what command strings you can
19452 use in the external material templates.
19453 In particular, pipes and redirection are not readily available.
19454 This has to be so if LyX should remain safe.
19455 If you want to use some of the shell features, you should write a safe
19456 script to do this in a controlled manner, and then invoke the script from
19457 the command string.
19461 \begin_layout Standard
19462 It is possible to design a template that interacts directly with the shell,
19463 but since this would allow a malicious user to execute arbitrary commands
19464 by writing clever filenames and/or parameters, we generally recommend that
19465 you only use safe scripts that work with the
19466 \begin_inset Flex CharStyle:Code
19469 \begin_layout Plain Layout
19475 system call in a controlled manner.
19476 Of course, for use in a controlled environment, it can be tempting to just
19477 fall back to use ordinary shell scripts.
19478 If you do so, be aware that you
19482 provide an easily exploitable security hole in your system.
19483 Of course it stands to reason that such unsafe templates will never be
19484 included in the standard LyX distribution, although we do encourage people
19485 to submit new templates in the open source tradition.
19486 But LyX as shipped from the official distribution channels will never have
19490 \begin_layout Standard
19491 Including external material provides a lot of power, and you have to be
19492 careful not to introduce security hazards with this power.
19493 A subtle error in a single line in an innocent looking script can open
19494 the door to huge security problems.
19495 So if you do not fully understand the issues, we recommend that you consult
19496 a knowledgeable security professional or the LyX development team if you
19497 have any questions about whether a given template is safe or not.
19498 And do this before you use it in an uncontrolled environment.