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
80 \bibtex_command default
81 \index_command default
85 \pdf_title "LyX Configuration Manual"
86 \pdf_author "LyX Team"
87 \pdf_subject "LyX-documentation Customization"
88 \pdf_keywords "LyX, documentation, customization"
90 \pdf_bookmarksnumbered true
91 \pdf_bookmarksopen true
92 \pdf_bookmarksopenlevel 1
97 \pdf_pdfusetitle false
98 \pdf_quoted_options "linkcolor=black, citecolor=black, urlcolor=blue, filecolor=blue,pdfpagelayout=OneColumn, pdfnewwindow=true,pdfstartview=XYZ, plainpages=false, pdfpagelabels"
107 \paperorientation portrait
120 \paragraph_separation indent
121 \paragraph_indentation default
122 \quotes_language english
125 \paperpagestyle headings
126 \tracking_changes false
127 \output_changes false
135 Customizing LyX: Features for the Advanced User
143 \begin_layout Plain Layout
145 If you have comments or error corrections, please send them to the LyX Documenta
147 \begin_inset CommandInset href
149 target "lyx-docs@lists.lyx.org"
156 \begin_inset Quotes eld
160 \begin_inset Quotes erd
163 in the subject header, and please cc the current maintainer of this file,
164 Richard Heck <rgheck@comcast.net>.
170 \begin_inset Newline newline
174 \begin_inset Newline newline
180 \begin_layout Standard
181 \begin_inset CommandInset toc
182 LatexCommand tableofcontents
189 \begin_layout Standard
190 \begin_inset Note Note
193 \begin_layout Plain Layout
194 Please use change tracking when modifying this document.
195 This makes it easier for our translators to recognize things that have
196 been changed, and it helps the maintainer keep up-to-date with what's been
205 \begin_layout Chapter
209 \begin_layout Standard
210 This manual covers the customization features present in LyX.
211 In it, we discuss issues like keyboard shortcuts, screen previewing options,
212 printer options, sending commands to LyX via the LyX Server, internationalizati
213 on, installing new LaTeX classes and LyX layouts, etc.
214 We can't possibly hope to touch on everything you can change—our developers
215 add new features faster than we can document them—but we will explain the
216 most common customizations and hopefully point you in the right direction
217 for some of the more obscure ones.
220 \begin_layout Standard
221 \begin_inset Branch OutDated
224 \begin_layout Standard
225 Information from previous versions of this document that now seems to be
226 outdated is contained in the OutDated branch of this document.
227 By default, this information will not appear in the LaTeX output.
235 \begin_layout Chapter
236 LyX configuration files
239 \begin_layout Standard
240 This chapter aims to help you to find your way through the LyX configuration
242 Before continuing to read this chapter, you should find out where your
243 LyX library and user directories are by using
244 \begin_inset Flex CharStyle:MenuItem
247 \begin_layout Plain Layout
248 Help\SpecialChar \menuseparator
259 The library directory is the place where LyX places its system-wide configurati
260 on files; the user directory is where you can place your modified versions.
261 We will call the former
262 \begin_inset Flex CharStyle:Code
265 \begin_layout Plain Layout
272 \begin_inset Flex CharStyle:MenuItem
275 \begin_layout Plain Layout
281 in the remainder of this document.
285 \begin_layout Section
287 \begin_inset Flex CharStyle:Code
290 \begin_layout Plain Layout
299 \begin_layout Standard
300 \begin_inset Flex CharStyle:Code
303 \begin_layout Plain Layout
309 and its sub-directories contain a number of files and that can be used
310 to customize LyX's behavior.
311 You can change many of these files from within LyX itself through the
312 \begin_inset Flex CharStyle:MenuItem
315 \begin_layout Plain Layout
316 Tools\SpecialChar \menuseparator
323 Most customization that you will want to do in LyX is possible through
325 However, many other inner aspects of LyX can be customized by modifying
327 \begin_inset Flex CharStyle:Code
330 \begin_layout Plain Layout
337 These files fall in different categories, described in the following subsection
341 \begin_layout Subsection
342 Automatically generated files
345 \begin_layout Standard
346 The files, which are to be found in
347 \begin_inset Flex CharStyle:MenuItem
350 \begin_layout Plain Layout
356 , are generated when you configure LyX.
357 They contain various default values that are guessed by inspection.
358 In general, it is not a good idea to modify them, since they might be overwritt
362 \begin_layout Labeling
363 \labelwidthstring 00.00.0000
364 \begin_inset Flex CharStyle:Code
367 \begin_layout Plain Layout
373 contains defaults for various commands.
376 \begin_layout Labeling
377 \labelwidthstring 00.00.0000
378 \begin_inset Flex CharStyle:Code
381 \begin_layout Plain Layout
387 contains the list of packages that have been recognized by LyX.
388 It is currently unused by the LyX program itself, but the information extracted
389 , and more, is made available with
390 \begin_inset Flex CharStyle:MenuItem
393 \begin_layout Plain Layout
394 Help\SpecialChar \menuseparator
407 \begin_layout Labeling
408 \labelwidthstring 00.00.0000
409 \begin_inset Flex CharStyle:Code
412 \begin_layout Plain Layout
418 the list of text classes that have been found in your
419 \begin_inset Flex CharStyle:Code
422 \begin_layout Plain Layout
428 directories, along with the associated LaTeX document class and their descripti
432 \begin_layout Labeling
433 \labelwidthstring 00.00.0000
434 \begin_inset Flex CharStyle:Code
437 \begin_layout Plain Layout
443 the list of layout modules found in your
444 \begin_inset Flex CharStyle:Code
447 \begin_layout Plain Layout
456 \begin_layout Labeling
457 \labelwidthstring 00.00.0000
458 \begin_inset Flex CharStyle:Code
461 \begin_layout Plain Layout
467 lists of various sorts of LaTeX-related files found on your system
470 \begin_layout Labeling
471 \labelwidthstring 00.00.0000
472 \begin_inset Flex CharStyle:Code
475 \begin_layout Plain Layout
481 is automatically generated during configuration from the file
482 \begin_inset Flex CharStyle:Code
485 \begin_layout Plain Layout
492 It contains information on your LaTeX configuration.
495 \begin_layout Subsection
499 \begin_layout Standard
500 These directories are duplicated between
501 \begin_inset Flex CharStyle:Code
504 \begin_layout Plain Layout
511 \begin_inset Flex CharStyle:Code
514 \begin_layout Plain Layout
521 If a particular files exists in both places, the one in
522 \begin_inset Flex CharStyle:Code
525 \begin_layout Plain Layout
534 \begin_layout Labeling
535 \labelwidthstring 00.00.0000
536 \begin_inset Flex CharStyle:Code
539 \begin_layout Plain Layout
545 this directory contains files with the extension
546 \begin_inset Flex CharStyle:Code
549 \begin_layout Plain Layout
555 that define the keybindings used in LyX.
556 If there exists an internationalized version of the bind file named
557 \begin_inset Flex CharStyle:Code
560 \begin_layout Plain Layout
566 , that will be used first.
569 \begin_layout Labeling
570 \labelwidthstring 00.00.0000
571 \begin_inset Flex CharStyle:Code
574 \begin_layout Plain Layout
580 contains graphics files that can be included in documents.
584 \begin_layout Labeling
585 \labelwidthstring 00.00.0000
586 \begin_inset Flex CharStyle:Code
589 \begin_layout Plain Layout
595 contains LyX documentation files (including the one you are currently reading).
597 \begin_inset Flex CharStyle:Code
600 \begin_layout Plain Layout
606 deserves special attention, as noted above.
607 The internationalized help docs are in subdirectories
608 \begin_inset Flex CharStyle:Code
611 \begin_layout Plain Layout
618 \begin_inset Quotes eld
622 \begin_inset Quotes erd
625 is the ISO language code.
631 \begin_inset CommandInset ref
633 reference "cha:Internationalizing-LyX"
640 \begin_layout Labeling
641 \labelwidthstring 00.00.0000
642 \begin_inset Flex CharStyle:Code
645 \begin_layout Plain Layout
651 contains example files that explain how to use some features.
652 In the file browser, press the
653 \begin_inset Flex CharStyle:MenuItem
656 \begin_layout Plain Layout
665 \begin_layout Labeling
666 \labelwidthstring 00.00.0000
667 \begin_inset Flex CharStyle:Code
670 \begin_layout Plain Layout
676 contains image files that are used by the
677 \begin_inset Flex CharStyle:MenuItem
680 \begin_layout Plain Layout
687 In addition, it also contains the individual icons used in the toolbar
688 and the banners that can be shown when LyX is launched.
691 \begin_layout Labeling
692 \labelwidthstring 00.00.0000
693 \begin_inset Flex CharStyle:Code
696 \begin_layout Plain Layout
702 contains keyboard keymapping files.
708 \begin_inset CommandInset ref
710 reference "sec:International-Keymap-Stuff"
717 \begin_layout Labeling
718 \labelwidthstring 00.00.0000
719 \begin_inset Flex CharStyle:Code
722 \begin_layout Plain Layout
728 contains the text class and module files described in Chapter
733 \begin_inset CommandInset ref
735 reference "cha:Installing-New-Document"
742 \begin_layout Labeling
743 \labelwidthstring 00.00.0000
744 \begin_inset Flex CharStyle:Code
747 \begin_layout Plain Layout
754 \begin_inset Flex CharStyle:Code
757 \begin_layout Plain Layout
763 Python scripts used to convert between LyX versions.
764 These can be run from the command line if, say, you want to batch-convert
768 \begin_layout Labeling
769 \labelwidthstring 00.00.0000
770 \begin_inset Flex CharStyle:Code
773 \begin_layout Plain Layout
779 contains some files that demonstrate the capabilities of the
780 \begin_inset Flex CharStyle:MenuItem
783 \begin_layout Plain Layout
794 Also contains some scripts used by LyX itself.
797 \begin_layout Labeling
798 \labelwidthstring 00.00.0000
799 \begin_inset Flex CharStyle:Code
802 \begin_layout Plain Layout
808 contains the standard LyX template files described in Chapter
813 \begin_inset CommandInset ref
815 reference "sub:Creating-Templates"
822 \begin_layout Labeling
823 \labelwidthstring 00.00.0000
824 \begin_inset Flex CharStyle:Code
827 \begin_layout Plain Layout
833 contains files with the extension
834 \begin_inset Flex CharStyle:Code
837 \begin_layout Plain Layout
843 that define the user interface to LyX.
844 That is, the files define which items appear in which menus and the items
845 appearing on the toolbar.
848 \begin_layout Subsection
849 Files you don't want to modify
852 \begin_layout Standard
853 These files are used internally by LyX and you generally do not need to
854 modify them unless you are a developer.
857 \begin_layout Labeling
858 \labelwidthstring 00.00.0000
859 \begin_inset Flex CharStyle:Code
862 \begin_layout Plain Layout
868 this file contains the list of LyX developers.
869 The contents are displayed with the menu entry
870 \begin_inset Flex CharStyle:MenuItem
873 \begin_layout Plain Layout
874 Help\SpecialChar \menuseparator
887 \begin_layout Labeling
888 \labelwidthstring 00.00.0000
889 \begin_inset Flex CharStyle:Code
892 \begin_layout Plain Layout
898 this is a LaTeX script used during the configuration process.
902 \begin_layout Labeling
903 \labelwidthstring 00.00.0000
904 \begin_inset Flex CharStyle:Code
907 \begin_layout Plain Layout
913 this is the script that is used to re-configure LyX.
914 It creates configuration files in the directory it was run from.
917 \begin_layout Subsection
918 Other files needing a line or two...
921 \begin_layout Labeling
922 \labelwidthstring 00.00.0000
923 \begin_inset Flex CharStyle:Code
926 \begin_layout Plain Layout
932 this contains tables describing how different character encodings can be
936 \begin_layout Labeling
937 \labelwidthstring 00.00.0000
938 \begin_inset Flex CharStyle:Code
941 \begin_layout Plain Layout
947 this file contains the templates available to the new
948 \begin_inset Flex CharStyle:MenuItem
951 \begin_layout Plain Layout
964 \begin_layout Labeling
965 \labelwidthstring 00.00.0000
966 \begin_inset Flex CharStyle:Code
969 \begin_layout Plain Layout
975 this file contains a list of all the languages currently supported by LyX.
978 \begin_layout Section
979 Your local configuration directory
982 \begin_layout Standard
983 Even if you are using LyX as an unprivileged user, you might want to change
984 LyX configuration for your own use.
986 \begin_inset Flex CharStyle:Code
989 \begin_layout Plain Layout
995 directory contains all your personal configuration files.
996 This is the directory described as
997 \begin_inset Quotes eld
1001 \begin_inset Quotes erd
1005 \begin_inset Flex CharStyle:MenuItem
1008 \begin_layout Plain Layout
1009 Help\SpecialChar \menuseparator
1011 \begin_inset space ~
1020 This directory is used as a mirror of
1021 \begin_inset Flex CharStyle:Code
1024 \begin_layout Plain Layout
1030 , which means that every file in
1031 \begin_inset Flex CharStyle:Code
1034 \begin_layout Plain Layout
1040 is a replacement for the corresponding file in
1041 \begin_inset Flex CharStyle:Code
1044 \begin_layout Plain Layout
1051 Any configuration file described in the above sections can be placed either
1052 in the system-wide directory, in which case it will affect all users, or
1053 in your local directory for your own use.
1056 \begin_layout Standard
1057 To make things clearer, let's provide a few examples:
1060 \begin_layout Itemize
1061 The preferences set in the
1062 \begin_inset Flex CharStyle:MenuItem
1065 \begin_layout Plain Layout
1066 Tools\SpecialChar \menuseparator
1072 dialog are saved to a file
1073 \begin_inset Flex CharStyle:Code
1076 \begin_layout Plain Layout
1083 \begin_inset Flex CharStyle:Code
1086 \begin_layout Plain Layout
1095 \begin_layout Itemize
1096 When you reconfigure using
1097 \begin_inset Flex CharStyle:MenuItem
1100 \begin_layout Plain Layout
1101 Tools\SpecialChar \menuseparator
1108 \begin_inset Flex CharStyle:Code
1111 \begin_layout Plain Layout
1117 script, and the resulting files are written in your local configuration
1119 This means that any additional text class file that you might have added
1121 \begin_inset Flex CharStyle:Code
1124 \begin_layout Plain Layout
1130 will be added to the list of classes in the
1131 \begin_inset Flex CharStyle:MenuItem
1134 \begin_layout Plain Layout
1135 Document\SpecialChar \menuseparator
1144 \begin_layout Itemize
1145 If you get some updated documentation from LyX ftp site and cannot install
1146 it because you do not have sysadmin rights on your system, you can just
1148 \begin_inset Flex CharStyle:Code
1151 \begin_layout Plain Layout
1157 and the items in the
1158 \begin_inset Flex CharStyle:MenuItem
1161 \begin_layout Plain Layout
1167 menu will open them!
1170 \begin_layout Section
1171 Running LyX with multiple configurations
1174 \begin_layout Standard
1175 The configuration freedom of the local configuration directory may not suffice
1176 if you want to have more than one configuration at your disposal.
1177 For example, you may want to be use different key bindings or printer settings
1179 You can achieve this by having several such directories.
1180 You then specify which directory to use at run-time.
1183 \begin_layout Standard
1184 Invoking LyX with the command line switch
1185 \begin_inset Flex CharStyle:Code
1188 \begin_layout Plain Layout
1198 instructs the program to read the configuration from that directory, and
1199 not from the default directory.
1200 (You can determine the default directory by running LyX without the
1201 \begin_inset Flex CharStyle:Code
1204 \begin_layout Plain Layout
1210 switch.) If the specified directory does not exist, LyX offers to create
1211 it for you, just like it does for the default directory on the first time
1212 you run the program.
1213 You can modify the configuration options in this additional user directory
1214 exactly as you would for the default directory.
1215 These directories are completely independent (but read on).
1216 Note that setting the environment variable
1217 \begin_inset Flex CharStyle:Code
1220 \begin_layout Plain Layout
1226 to some value has exactly the same effect.
1229 \begin_layout Standard
1230 Having several configurations also requires more maintenance: if you want
1231 to add a new layout to
1232 \begin_inset Flex CharStyle:Code
1235 \begin_layout Plain Layout
1241 which you want available from all your configurations, you must add it
1242 to each directory separately.
1243 You can avoid this with the following trick: after LyX creates the additional
1244 directory, most of the subdirectories (see above) are empty.
1245 If you want the new configuration to mirror an existing one, replace the
1246 empty subdirectory with a symbolic link to the matching subdirectory in
1247 the existing configuration.
1249 \begin_inset Flex CharStyle:Code
1252 \begin_layout Plain Layout
1258 subdirectory, however, since it contains a file written by the configuration
1259 script (also accessible through
1260 \begin_inset Flex CharStyle:MenuItem
1263 \begin_layout Plain Layout
1264 Tools\SpecialChar \menuseparator
1270 ) which is configuration-specific.
1273 \begin_layout Chapter
1274 The Preferences dialog
1277 \begin_layout Standard
1278 All options of the preferences dialog are described in the Appendix
1280 The Preferences Dialog
1287 For some options you might find here more details.
1290 \begin_layout Section
1292 \begin_inset CommandInset label
1301 \begin_layout Standard
1302 The first step is to define your file formats if they are not already defined.
1304 \begin_inset Flex CharStyle:MenuItem
1307 \begin_layout Plain Layout
1308 Tools\SpecialChar \menuseparator
1316 \begin_inset Flex CharStyle:MenuItem
1319 \begin_layout Plain Layout
1320 File Handling\SpecialChar \menuseparator
1327 \begin_inset Flex CharStyle:MenuItem
1330 \begin_layout Plain Layout
1331 New\SpecialChar \ldots{}
1337 button to define your new format.
1339 \begin_inset Flex CharStyle:MenuItem
1342 \begin_layout Plain Layout
1348 field contains the name used to identify the format in the GUI.
1350 \begin_inset Flex CharStyle:MenuItem
1353 \begin_layout Plain Layout
1359 is used to identify the format internally.
1360 You will also need to enter a file extension.
1361 These are all required.
1363 \begin_inset Flex CharStyle:MenuItem
1366 \begin_layout Plain Layout
1372 field is used to provide a keyboard shortcut on the menus.
1373 (For example, pressing
1374 \begin_inset Flex CharStyle:MenuItem
1377 \begin_layout Plain Layout
1384 \begin_inset Flex CharStyle:MenuItem
1387 \begin_layout Plain Layout
1388 View\SpecialChar \menuseparator
1397 \begin_layout Standard
1399 \begin_inset Flex CharStyle:MenuItem
1402 \begin_layout Plain Layout
1409 \begin_inset Flex CharStyle:MenuItem
1412 \begin_layout Plain Layout
1419 For example, you might want to use
1420 \begin_inset Flex CharStyle:MenuItem
1423 \begin_layout Plain Layout
1429 to view PostScript files.
1430 You can enter the command needed to start the program in the corresponding
1432 In defining this command, you can use the four variables listed in the
1434 The viewer is launched when you view an image in LyX or use the
1435 \begin_inset Flex CharStyle:MenuItem
1438 \begin_layout Plain Layout
1445 The editor is for example launched when you right-click on an image and
1447 \begin_inset Flex CharStyle:MenuItem
1450 \begin_layout Plain Layout
1456 in the appearing context menu.
1459 \begin_layout Standard
1461 \begin_inset Flex CharStyle:MenuItem
1464 \begin_layout Plain Layout
1470 option tells LyX that a format is suitable for document export.
1471 If this is set and if a suitable conversion route exists (see sec.
1472 \begin_inset space \thinspace{}
1476 \begin_inset CommandInset ref
1478 reference "sec:Converters"
1482 ), the format will appear in the
1483 \begin_inset Flex CharStyle:MenuItem
1486 \begin_layout Plain Layout
1487 File\SpecialChar \menuseparator
1494 The format will also appear in the
1495 \begin_inset Flex CharStyle:MenuItem
1498 \begin_layout Plain Layout
1504 menu if a viewer is specified for the format.
1505 Pure image formats, such as
1506 \begin_inset Flex CharStyle:Code
1509 \begin_layout Plain Layout
1515 , should not use this option.
1516 Formats that can both represent vector graphics and documents like
1517 \begin_inset Flex CharStyle:Code
1520 \begin_layout Plain Layout
1529 \begin_layout Standard
1531 \begin_inset Flex CharStyle:MenuItem
1534 \begin_layout Plain Layout
1535 Vector graphics format
1540 tells LyX that a format can contain vector graphics.
1541 This information is used to determine the target format of included graphics
1543 \begin_inset Flex CharStyle:MenuItem
1546 \begin_layout Plain Layout
1553 Included graphics may need to be converted to either
1554 \begin_inset Flex CharStyle:MenuItem
1557 \begin_layout Plain Layout
1564 \begin_inset Flex CharStyle:MenuItem
1567 \begin_layout Plain Layout
1574 \begin_inset Flex CharStyle:MenuItem
1577 \begin_layout Plain Layout
1584 \begin_inset Flex CharStyle:MenuItem
1587 \begin_layout Plain Layout
1593 cannot handle other image formats.
1594 If an included graphic is not already in
1595 \begin_inset Flex CharStyle:MenuItem
1598 \begin_layout Plain Layout
1605 \begin_inset Flex CharStyle:MenuItem
1608 \begin_layout Plain Layout
1615 \begin_inset Flex CharStyle:MenuItem
1618 \begin_layout Plain Layout
1624 format, it is converted to
1625 \begin_inset Flex CharStyle:MenuItem
1628 \begin_layout Plain Layout
1634 if the vector format option is set, and otherwise to
1635 \begin_inset Flex CharStyle:MenuItem
1638 \begin_layout Plain Layout
1647 \begin_layout Section
1651 \begin_layout Standard
1652 Since all conversions from one format to another take place in LyX's temporary
1653 directory, it is sometimes necessary to modify a file before copying it
1654 to the temporary directory in order that the conversion may be performed.
1658 \begin_layout Plain Layout
1659 For example, the file may refer to other files—images, for example—using
1660 relative file names, and these may become invalid when the file is copied
1661 to the temporary directory.
1666 This is done by a Copier: It copies a file to (or from) the temporary directory
1667 and may modify it in the process.
1670 \begin_layout Standard
1671 The definitions of the copiers may use four variables:
1674 \begin_layout Labeling
1675 \labelwidthstring 00.00.0000
1676 \begin_inset Flex CharStyle:Code
1679 \begin_layout Plain Layout
1685 The LyX system directory (e.
1686 \begin_inset space \thinspace{}
1690 \begin_inset space \space{}
1694 \begin_inset Flex CharStyle:MenuItem
1697 \begin_layout Plain Layout
1706 \begin_layout Labeling
1707 \labelwidthstring 00.00.0000
1708 \begin_inset Flex CharStyle:Code
1711 \begin_layout Plain Layout
1720 \begin_layout Labeling
1721 \labelwidthstring 00.00.0000
1722 \begin_inset Flex CharStyle:Code
1725 \begin_layout Plain Layout
1734 \begin_layout Labeling
1735 \labelwidthstring 00.00.0000
1736 \begin_inset Flex CharStyle:Code
1739 \begin_layout Plain Layout
1748 \begin_layout Standard
1749 The latter should be the filename as it would be used in a LaTeX's
1756 It is relevant only when exporting files suitable for such inclusion.
1759 \begin_layout Standard
1760 Copiers can be used to do almost anything with output files.
1761 For example, suppose you want generated pdf files to be copied to a special
1763 \begin_inset Flex CharStyle:Code
1766 \begin_layout Plain Layout
1773 Then you could write a shell script such as this one:
1776 \begin_layout Standard
1777 \begin_inset listings
1781 \begin_layout Plain Layout
1786 \begin_layout Plain Layout
1791 \begin_layout Plain Layout
1793 TOFILE=`basename $2`
1796 \begin_layout Plain Layout
1798 cp $FROMFILE /home/you/pdf/$TOFILE
1803 Save it in your local LyX directory—say,
1804 \begin_inset Flex CharStyle:Code
1807 \begin_layout Plain Layout
1808 /home/you/.lyx/scripts/pdfcopier.sh
1813 —and make it executable, if you need to do so on your platform.
1815 \begin_inset Flex CharStyle:MenuItem
1818 \begin_layout Plain Layout
1819 Tools\SpecialChar \menuseparator
1825 dialog, select under
1826 \begin_inset Flex CharStyle:MenuItem
1829 \begin_layout Plain Layout
1830 File Handling\SpecialChar \menuseparator
1837 \begin_inset Flex CharStyle:MenuItem
1840 \begin_layout Plain Layout
1846 format—or one of the other pdf formats—and enter
1847 \begin_inset Flex CharStyle:Code
1850 \begin_layout Plain Layout
1851 pdfcopier.sh $$i $$o
1857 \begin_inset Flex CharStyle:MenuItem
1860 \begin_layout Plain Layout
1870 \begin_layout Standard
1871 Copiers are used by LyX in various of its own conversions.
1872 For example, if appropriate programs are found, LyX will automatically
1873 install copiers for the
1874 \begin_inset Flex CharStyle:MenuItem
1877 \begin_layout Plain Layout
1884 \begin_inset Flex CharStyle:MenuItem
1887 \begin_layout Plain Layout
1889 \begin_inset space ~
1898 When these formats are exported, the copier sees that not just the main
1899 HTML file but various associated files (style files, images, etc.) are also
1901 All these files are written to a subdirectory of the directory in which
1902 the original LyX file was found.
1906 \begin_layout Plain Layout
1907 This copier can be customized.
1909 \begin_inset Quotes eld
1913 \begin_inset Quotes erd
1916 argument takes a comma-separated list of extensions to be copied; if it
1917 is omitted, all files will be copied.
1919 \begin_inset Quotes eld
1923 \begin_inset Quotes erd
1926 argument determines the extension added to the generated directory.
1928 \begin_inset Quotes eld
1932 \begin_inset Flex CharStyle:MenuItem
1935 \begin_layout Plain Layout
1942 \begin_inset Quotes erd
1945 , so HTML generated from
1946 \begin_inset Flex CharStyle:MenuItem
1949 \begin_layout Plain Layout
1950 /path/to/filename.lyx
1956 \begin_inset Flex CharStyle:MenuItem
1959 \begin_layout Plain Layout
1960 /path/to/filename.html.LyXconv
1974 \begin_layout Section
1976 \begin_inset CommandInset label
1978 name "sec:Converters"
1985 \begin_layout Standard
1986 You can define your own Converters to convert files between different formats.
1988 \begin_inset Flex CharStyle:MenuItem
1991 \begin_layout Plain Layout
1992 Tools\SpecialChar \menuseparator
1993 Preferences\SpecialChar \menuseparator
1994 File Handling\SpecialChar \menuseparator
2003 \begin_layout Standard
2004 To define a new converter, select the
2005 \begin_inset Flex CharStyle:MenuItem
2008 \begin_layout Plain Layout
2010 \begin_inset space ~
2019 \begin_inset Flex CharStyle:MenuItem
2022 \begin_layout Plain Layout
2024 \begin_inset space ~
2032 from the drop-down lists, enter the command needed for the conversion,
2034 \begin_inset Flex CharStyle:MenuItem
2037 \begin_layout Plain Layout
2044 Several variables can be used in the definition of converters:
2047 \begin_layout Labeling
2048 \labelwidthstring 00.00.0000
2049 \begin_inset Flex CharStyle:Code
2052 \begin_layout Plain Layout
2058 The LyX system directory
2061 \begin_layout Labeling
2062 \labelwidthstring 00.00.0000
2063 \begin_inset Flex CharStyle:Code
2066 \begin_layout Plain Layout
2075 \begin_layout Labeling
2076 \labelwidthstring 00.00.0000
2077 \begin_inset Flex CharStyle:Code
2080 \begin_layout Plain Layout
2089 \begin_layout Labeling
2090 \labelwidthstring 00.00.0000
2091 \begin_inset Flex CharStyle:Code
2094 \begin_layout Plain Layout
2100 The base filename of the input file (i.
2101 \begin_inset space \thinspace{}
2104 g., without the extension)
2107 \begin_layout Labeling
2108 \labelwidthstring 00.00.0000
2109 \begin_inset Flex CharStyle:Code
2112 \begin_layout Plain Layout
2118 The path to the input file
2121 \begin_layout Labeling
2122 \labelwidthstring 00.00.0000
2123 \begin_inset Flex CharStyle:Code
2126 \begin_layout Plain Layout
2132 The path to the original input file (this is different from $$p when a
2133 chain of converters is called).
2136 \begin_layout Standard
2138 \begin_inset Flex CharStyle:MenuItem
2141 \begin_layout Plain Layout
2143 \begin_inset space ~
2151 field you can enter the following flags, separated by commas:
2154 \begin_layout Labeling
2155 \labelwidthstring 00.00.0000
2156 \begin_inset Flex CharStyle:Code
2159 \begin_layout Plain Layout
2165 This converter runs some form of LaTeX.
2166 This will make LyX's LaTeX error logs available.
2169 \begin_layout Labeling
2170 \labelwidthstring 00.00.0000
2171 \begin_inset Flex CharStyle:Code
2174 \begin_layout Plain Layout
2181 \begin_inset Flex CharStyle:MenuItem
2184 \begin_layout Plain Layout
2190 file for the conversion.
2193 \begin_layout Labeling
2194 \labelwidthstring 00.00.0000
2195 \begin_inset Flex CharStyle:Code
2198 \begin_layout Plain Layout
2207 \begin_layout Standard
2208 The following three flags are not really flags at all because they take
2210 \begin_inset Flex CharStyle:MenuItem
2213 \begin_layout Plain Layout
2215 \begin_inset space ~
2219 \begin_inset space ~
2230 \begin_layout Labeling
2231 \labelwidthstring 00.00.0000
2232 \begin_inset Flex CharStyle:Code
2235 \begin_layout Plain Layout
2241 If set, the converter's standard error will be redirected to a file
2242 \begin_inset Flex CharStyle:Code
2245 \begin_layout Plain Layout
2251 , and the script given as argument will be run as:
2252 \begin_inset Flex CharStyle:Code
2255 \begin_layout Plain Layout
2256 script < infile.out > infile.log
2262 The argument may contain
2263 \begin_inset Flex CharStyle:Code
2266 \begin_layout Plain Layout
2275 \begin_layout Labeling
2276 \labelwidthstring 00.00.0000
2277 \begin_inset Flex CharStyle:Code
2280 \begin_layout Plain Layout
2286 The name of the directory in which the converter will dump the generated
2288 LyX will not create this directory, and it does not copy anything into
2289 it, though it will copy this directory to the destination.
2290 The argument may contain
2291 \begin_inset Flex CharStyle:Code
2294 \begin_layout Plain Layout
2300 , which will be replaced by the base name of the input and output files,
2301 respectively, when the directory is copied.
2302 \begin_inset Newline newline
2305 Note that resultdir and usetempdir make no sense together.
2306 The latter will be ignored if the former is given.
2309 \begin_layout Labeling
2310 \labelwidthstring 00.00.0000
2311 \begin_inset Flex CharStyle:Code
2314 \begin_layout Plain Layout
2320 Determines the output file name and may, contain
2321 \begin_inset Flex CharStyle:Code
2324 \begin_layout Plain Layout
2331 Sensible only with resultdir and optional even then; if not given, it defaults
2335 \begin_layout Standard
2336 None of these last three are presently used in any of the converters that
2337 are installed with LyX.
2341 \begin_layout Standard
2342 You do not have to define converters for all formats between which you want
2344 For example, you will note that there is no `LyX to PostScript' converter,
2345 but LyX will export PostScript.
2346 It does so by first creating a LaTeX file (no converter needs to be defined
2347 for this) which is then converted to DVI using the `LaTeX to DVI' converter,
2348 and finally converting the resulting DVI file to PostScript.
2349 LyX finds such `chains' of converters automatically, and it will always
2350 choose the shortest possible chain.
2351 You can, though, still define multiple conversion methods between file
2353 For example, the standard LyX configuration provides three ways to convert
2354 LaTeX to PDF: Directly, using
2355 \begin_inset Flex CharStyle:MenuItem
2358 \begin_layout Plain Layout
2364 ; via (DVI and) PostScript, using
2365 \begin_inset Flex CharStyle:MenuItem
2368 \begin_layout Plain Layout
2375 \begin_inset Flex CharStyle:MenuItem
2378 \begin_layout Plain Layout
2385 To define such alternate chains, you must define multiple target `file
2386 formats', as described in section
2387 \begin_inset CommandInset ref
2389 reference "sec:Formats"
2394 For example, in the standard configuration, the formats named
2395 \begin_inset Flex CharStyle:MenuItem
2398 \begin_layout Plain Layout
2405 \begin_inset Flex CharStyle:MenuItem
2408 \begin_layout Plain Layout
2415 \begin_inset Flex CharStyle:MenuItem
2418 \begin_layout Plain Layout
2424 are defined, all of which share the extension
2425 \begin_inset Flex CharStyle:MenuItem
2428 \begin_layout Plain Layout
2434 , and which correspond to the conversion methods just mentioned.
2437 \begin_layout Chapter
2438 Internationalizing LyX
2439 \begin_inset CommandInset label
2441 name "cha:Internationalizing-LyX"
2448 \begin_layout Standard
2449 LyX supports using a translated interface.
2450 Last time we checked, LyX provided text in thirty languages.
2451 The language of choice is called your
2456 (For further reading on locale settings, see also the documentation for
2457 locale that comes with your operating system.
2458 For Linux, the manual page for
2459 \begin_inset Flex CharStyle:Code
2462 \begin_layout Plain Layout
2468 could be a good place to start).
2471 \begin_layout Standard
2472 Notice that these translations will work, but do contain a few flaws.
2473 In particular, all dialogs have been designed with the English text in
2474 mind, which means that some of the translated text will be too large to
2475 fit within the space allocated.
2476 This is only a display problem and will not cause any harm.
2477 Also, you will find that some of the translations do not define shortcut
2478 keys for everything.
2479 Sometimes, there are simply not enough free letters to do it.
2480 Other times, the translator just hasn't got around to doing it yet.
2481 Our localization team, which you may wish to join,
2485 \begin_layout Plain Layout
2486 If you are a fluent speaker of a language other than English, joining these
2487 teams is a great way to give back to the LyX community!
2492 will of course try to fix these shortcomings in future versions of LyX.
2495 \begin_layout Section
2499 \begin_layout Subsection
2500 Translating the graphical user interface (text messages).
2503 \begin_layout Standard
2505 \begin_inset Flex CharStyle:Code
2508 \begin_layout Plain Layout
2514 library to handle the internationalization of the interface.
2515 To have LyX speak your favorite language in all menus and dialogs, you
2517 \begin_inset Flex CharStyle:Code
2520 \begin_layout Plain Layout
2526 -file for that language.
2527 When this is available, you'll have to generate a
2528 \begin_inset Flex CharStyle:Code
2531 \begin_layout Plain Layout
2537 -file from it and install the
2538 \begin_inset Flex CharStyle:Code
2541 \begin_layout Plain Layout
2548 The process of doing all of this is explained in the documentation for
2550 \begin_inset Flex CharStyle:Code
2553 \begin_layout Plain Layout
2560 It is possible to do this just for yourself, but if you're going to do
2561 it, you might as well share the results of your labors with the rest of
2563 Send a message to the LyX developers' list for more information about how
2567 \begin_layout Standard
2568 In short, this is what you should do (xx denotes the language code):
2571 \begin_layout Itemize
2572 Check out the LyX source code.
2574 \begin_inset CommandInset href
2576 name "information on the web"
2577 target "http://www.lyx.org/devel/cvs.php"
2584 \begin_layout Itemize
2586 \begin_inset Flex CharStyle:Code
2589 \begin_layout Plain Layout
2595 to the folder of the
2596 \begin_inset Flex CharStyle:Code
2599 \begin_layout Plain Layout
2607 \begin_inset Flex CharStyle:Code
2610 \begin_layout Plain Layout
2618 \begin_inset Flex CharStyle:Code
2621 \begin_layout Plain Layout
2627 doesn't exist anywhere, it can be remade with the console command
2628 \begin_inset Flex CharStyle:Code
2631 \begin_layout Plain Layout
2637 in that directory, or you can use an existing po-file for some other language
2641 \begin_layout Itemize
2643 \begin_inset Flex CharStyle:Code
2646 \begin_layout Plain Layout
2656 \begin_layout Plain Layout
2657 This is just a text file, so it can be edited in any text editor.
2658 But there are also specialized programs that support such editing, such
2663 (for all platforms) or
2672 contains a `mode' for editing
2673 \begin_inset Flex CharStyle:Code
2676 \begin_layout Plain Layout
2687 For some menu- and widget-labels, there are also shortcut keys that should
2689 Those keys are marked after a `|', and should be translated according to
2690 the words and phrases of the language.
2691 You should also fill also out the information at the beginning of the new
2693 \begin_inset Flex CharStyle:Code
2696 \begin_layout Plain Layout
2702 -file with your email-address, etc., so people know where to reach you with
2703 suggestions and entertaining flames.
2706 \begin_layout Standard
2707 If you are just doing this on your own, then:
2710 \begin_layout Itemize
2712 \begin_inset Flex CharStyle:Code
2715 \begin_layout Plain Layout
2722 This can be done with
2723 \begin_inset Flex CharStyle:Code
2726 \begin_layout Plain Layout
2727 msgfmt -o xx.mo < xx.po
2735 \begin_layout Itemize
2737 \begin_inset Flex CharStyle:Code
2740 \begin_layout Plain Layout
2746 -file to your locale-tree, at the correct directory for application messages
2751 xx, and under the name
2752 \begin_inset Flex CharStyle:Code
2755 \begin_layout Plain Layout
2762 \begin_inset space \thinspace{}
2766 \begin_inset space \space{}
2770 \begin_inset Flex CharStyle:Code
2773 \begin_layout Plain Layout
2774 /usr/local/share/locale/xx/LC_MESSAGES/lyx.mo
2784 \begin_layout Standard
2785 As said, however, it would be best if the new
2786 \begin_inset Flex CharStyle:Code
2789 \begin_layout Plain Layout
2795 -file could be added to the LyX distribution, so others can use it.
2796 Adding it involves making additional changes to LyX.
2797 So send an email to the developers' mailing list if you're interested in
2801 \begin_layout Subsubsection
2805 \begin_layout Standard
2806 Sometimes it turns out that one English message needs to be translated into
2807 different messages in the target language.
2808 One example is the message
2809 \begin_inset Flex CharStyle:Code
2812 \begin_layout Plain Layout
2818 which has the German translation
2826 , depending upon exactly what the English
2827 \begin_inset Quotes eld
2831 \begin_inset Quotes erd
2836 \begin_inset Flex CharStyle:Code
2839 \begin_layout Plain Layout
2845 does not handle such ambiguous translations.
2846 Therefore you have to add some context information to the message: Instead
2848 \begin_inset Flex CharStyle:Code
2851 \begin_layout Plain Layout
2858 \begin_inset Flex CharStyle:Code
2861 \begin_layout Plain Layout
2862 To[[as in 'From format x to format y']]
2868 \begin_inset Flex CharStyle:Code
2871 \begin_layout Plain Layout
2872 To[[as in 'From page x to page y']].
2877 Now the two occurrences of
2878 \begin_inset Flex CharStyle:Code
2881 \begin_layout Plain Layout
2888 \begin_inset Flex CharStyle:Code
2891 \begin_layout Plain Layout
2897 and can be translated correctly to
2908 \begin_layout Standard
2909 Of course the context information needs to be stripped off the original
2910 message when no translation is used.
2911 Therefore you have to put it in double square brackets at the end of the
2912 message (see the example above).
2913 The translation mechanism of LyX ensures that everything in double square
2914 brackets at the end of messages is removed before displaying the message.
2917 \begin_layout Subsection
2918 Translating the documentation.
2921 \begin_layout Standard
2922 The online documentation (in the
2923 \begin_inset Flex CharStyle:MenuItem
2926 \begin_layout Plain Layout
2932 -menu) can (and should!) be translated.
2933 If there are translated versions of the documentation available
2937 \begin_layout Plain Layout
2938 As of March 2008, at least some of the documents have been translated into
2939 fourteen languages, with the Tutorial available in a few more.
2944 and the locale is set accordingly, these will be used automagically by
2946 LyX looks for translated versions as
2947 \begin_inset Flex CharStyle:Code
2950 \begin_layout Plain Layout
2951 LyXDir/doc/xx/DocName.lyx
2957 \begin_inset Flex CharStyle:Code
2960 \begin_layout Plain Layout
2966 is the code for the language currently in use.
2967 If there are no translated documents, the default English versions will
2969 Note that the translated versions must have the same filenames (
2970 \begin_inset Flex CharStyle:Code
2973 \begin_layout Plain Layout
2979 above) as the original.
2980 If you feel up to translating the documentation (an excellent way to proof-read
2981 the original documentation by the way!), there are a few things you should
2985 \begin_layout Itemize
2986 Check out the documentation translation web page at
2987 \begin_inset CommandInset href
2989 name "http://www.lyx.org/Translation"
2990 target "http://www.lyx.org/Translation"
2995 That way, you can find out which (if any) documents have already been translate
2996 d into your language.
2997 You can also find out who (if anyone) is organizing the effort to translate
2998 the documentation into your language.
2999 If no one is organizing the effort, please let us know that you're interested.
3002 \begin_layout Standard
3003 Once you get to actually translating, here's a few hints for you that may
3007 \begin_layout Itemize
3008 Join the documentation team! There is information on how to do that in
3009 \begin_inset Flex CharStyle:Code
3012 \begin_layout Plain Layout
3019 \begin_inset Flex CharStyle:MenuItem
3022 \begin_layout Plain Layout
3023 Help\SpecialChar \menuseparator
3029 ), which by the way is the first document you should translate.
3032 \begin_layout Itemize
3033 Learn the typographic conventions for the language you are translating to.
3034 Typography is an ancient art and over the centuries, a great variety of
3035 conventions have developed throughout different parts of the world.
3036 Also study the professional terminology amongst typographers in your country.
3037 Inventing your own terminology will only confuse the users.
3040 (Warning! Typography is addictive!)
3043 \begin_layout Itemize
3044 Make a copy of the document.
3045 This will be your working copy.
3046 You can use this as your personal translated help-file by placing it in
3048 \begin_inset Flex CharStyle:Code
3051 \begin_layout Plain Layout
3060 \begin_layout Itemize
3061 Sometimes the original document (from the LyX-team) will be updated.
3062 Use the source viewer at
3063 \begin_inset CommandInset href
3065 name "http://www.lyx.org/trac/timeline"
3066 target "http://www.lyx.org/trac/timeline"
3070 to see what has been changed.
3071 That way you can easily see which parts of the translated document need
3075 \begin_layout Standard
3076 If you ever find an error in the original document, fix it and notify the
3077 rest of the documentation team of the changes! (You didn't forget to join
3078 the documentation team, did you?)
3081 \begin_layout Standard
3082 \begin_inset Branch OutDated
3085 \begin_layout Section
3086 International Keyboard Support
3089 \begin_layout Standard
3092 [Editor's Note: The following section is by
3100 It needs to be fixed to conform to the new Documentation Style sheet and
3101 to make use of the new v1.0 features.
3102 The whole thing also needs to be merged with the section following it.-jw
3103 It may also be badly out of date.-rh (2008)]
3106 \begin_layout Subsection
3107 Defining Own Keymaps: Keymap File Format
3110 \begin_layout Standard
3111 Let's look at a keyboard definition file a little closer.
3112 It is a plain text file defining
3115 \begin_layout Itemize
3116 key-to-key or key-to-string translations
3119 \begin_layout Itemize
3123 \begin_layout Itemize
3124 dead keys exceptions
3127 \begin_layout Standard
3128 To define key-to-key or key-to-string translation, use this command:
3131 \begin_layout Quotation
3132 \begin_inset Flex CharStyle:Code
3135 \begin_layout Plain Layout
3144 \begin_inset Flex CharStyle:Code
3147 \begin_layout Plain Layout
3156 \begin_layout Standard
3158 \begin_inset Flex CharStyle:Code
3161 \begin_layout Plain Layout
3167 is the key to be translated and
3168 \begin_inset Flex CharStyle:Code
3171 \begin_layout Plain Layout
3177 is the string to be inserted into the document.
3178 To define dead keys, use:
3181 \begin_layout Quotation
3182 \begin_inset Flex CharStyle:Code
3185 \begin_layout Plain Layout
3194 \begin_inset Flex CharStyle:Code
3197 \begin_layout Plain Layout
3206 \begin_layout Standard
3208 \begin_inset Flex CharStyle:Code
3211 \begin_layout Plain Layout
3217 is a keyboard key and
3218 \begin_inset Flex CharStyle:Code
3221 \begin_layout Plain Layout
3228 The following dead keys are supported (shortcut name is in parentheses):
3231 \begin_layout Quotation
3235 \begin_inset space \hfill{}
3241 \begin_layout Quotation
3243 \begin_inset space \hfill{}
3249 \begin_layout Quotation
3251 \begin_inset space \hfill{}
3257 \begin_layout Quotation
3259 \begin_inset space \hfill{}
3265 \begin_layout Quotation
3267 \begin_inset space \hfill{}
3273 \begin_layout Quotation
3275 \begin_inset space \hfill{}
3282 \begin_layout Plain Layout
3294 \begin_layout Quotation
3296 \begin_inset space \hfill{}
3302 \begin_layout Quotation
3304 \begin_inset space \hfill{}
3311 \begin_layout Plain Layout
3323 \begin_layout Quotation
3325 \begin_inset space \hfill{}
3331 \begin_layout Quotation
3333 \begin_inset space \hfill{}
3339 \begin_layout Quotation
3341 \begin_inset space \hfill{}
3348 \begin_layout Plain Layout
3360 \begin_layout Quotation
3362 \begin_inset space \hfill{}
3369 \begin_layout Plain Layout
3381 \begin_layout Quotation
3383 \begin_inset space \hfill{}
3389 \begin_layout Quotation
3390 hungarian umlaut (hug)
3391 \begin_inset space \hfill{}
3397 \begin_layout Quotation
3399 \begin_inset space \hfill{}
3405 \begin_layout Quotation
3407 \begin_inset space \hfill{}
3414 \begin_layout Plain Layout
3426 \begin_layout Standard
3427 Since in many international keyboards there are exceptions to what some
3428 dead keys should do, you can define them using
3431 \begin_layout Quotation
3432 \begin_inset Flex CharStyle:Code
3435 \begin_layout Plain Layout
3443 deadkey key outstring
3446 \begin_layout Standard
3447 For example, on Slovak keyboard, if you enter caron-o, it generates circumflex-o
3451 \begin_layout Quotation
3452 \begin_inset Flex CharStyle:Code
3455 \begin_layout Plain Layout
3468 \begin_layout Standard
3469 to make it work correctly.
3470 Also, you have to define as exceptions dead keys over i and j, to remove
3471 the dot from them before inserting an accent mark.
3472 I will change this when the time comes, but so far I haven't had time.
3475 \begin_layout Standard
3476 Oh, and about characters: backslash is escaped, so to enter it, you'll need
3479 \begin_inset Flex CharStyle:Code
3482 \begin_layout Plain Layout
3488 have different meaning.
3490 \begin_inset Flex CharStyle:Code
3493 \begin_layout Plain Layout
3499 marks comments, quotes start and end LaTeX-style commands.
3500 To enter quote, you'll need to use
3501 \begin_inset Flex CharStyle:Code
3504 \begin_layout Plain Layout
3513 \begin_inset Flex CharStyle:Code
3516 \begin_layout Plain Layout
3523 \begin_inset Flex CharStyle:Code
3526 \begin_layout Plain Layout
3537 \begin_layout Standard
3538 If you make a keyboard description file that works for your language, please
3539 mail it to me, so I can include it in the next keymap distribution.
3542 \begin_layout Standard
3543 More keywords will be supported in keymap configuration file in future,
3547 \begin_layout Itemize
3548 \begin_inset Flex CharStyle:Code
3551 \begin_layout Plain Layout
3562 \begin_inset space \hfill{}
3566 \begin_inset Flex CharStyle:Code
3569 \begin_layout Plain Layout
3578 \begin_layout Itemize
3579 \begin_inset Flex CharStyle:Code
3582 \begin_layout Plain Layout
3593 \begin_inset space \hfill{}
3597 \begin_inset Flex CharStyle:Code
3600 \begin_layout Plain Layout
3606 an external keymap translation program
3609 \begin_layout Standard
3610 Also, it should look into
3611 \begin_inset Flex CharStyle:Code
3614 \begin_layout Plain Layout
3620 file for defaults, too (for example, a
3621 \begin_inset Flex CharStyle:Code
3624 \begin_layout Plain Layout
3632 option to include default keyboard).
3640 \begin_layout Section
3641 International Keymap Stuff
3642 \begin_inset CommandInset label
3644 name "sec:International-Keymap-Stuff"
3651 \begin_layout Standard
3652 \begin_inset Note Note
3655 \begin_layout Plain Layout
3656 In doing the revisions on this document in March 2008, I did not look over
3657 this stuff, as I do not understand it.
3658 It would be good if someone else could do so.
3667 \begin_layout Standard
3668 The next two sections describe the
3669 \begin_inset Flex CharStyle:Code
3672 \begin_layout Plain Layout
3681 \begin_inset Flex CharStyle:Code
3684 \begin_layout Plain Layout
3692 file syntax in detail.
3693 These sections should help you design your own key map if the ones provided
3694 do not meet your needs.
3697 \begin_layout Subsection
3701 \begin_layout Standard
3705 \begin_inset Flex CharStyle:Code
3708 \begin_layout Plain Layout
3714 file maps keystrokes to characters or strings.
3715 As the name suggests, it sets a keyboard mapping.
3717 \begin_inset Flex CharStyle:Code
3720 \begin_layout Plain Layout
3731 \begin_inset Flex CharStyle:Code
3734 \begin_layout Plain Layout
3749 \begin_inset Flex CharStyle:Code
3752 \begin_layout Plain Layout
3765 \begin_inset Flex CharStyle:Code
3768 \begin_layout Plain Layout
3777 \begin_inset Flex CharStyle:Code
3780 \begin_layout Plain Layout
3788 are described in this section.
3791 \begin_layout Labeling
3792 \labelwidthstring 00.00.0000
3793 \begin_inset Flex CharStyle:Code
3796 \begin_layout Plain Layout
3804 Map a character to a string
3807 \begin_layout LyX-Code
3822 \begin_layout Standard
3855 the double-quote (")
3872 must be escaped with a preceding backslash (
3883 \begin_layout Standard
3885 \begin_inset Flex CharStyle:MenuItem
3888 \begin_layout Plain Layout
3896 statement to cause the symbol
3897 \begin_inset Flex CharStyle:MenuItem
3900 \begin_layout Plain Layout
3908 to be output for the keystroke
3909 \begin_inset Flex CharStyle:MenuItem
3912 \begin_layout Plain Layout
3923 \begin_layout LyX-Code
3929 \begin_layout Labeling
3930 \labelwidthstring 00.00.0000
3931 \begin_inset Flex CharStyle:Code
3934 \begin_layout Plain Layout
3942 Specify an accent character
3945 \begin_layout LyX-Code
3954 \begin_layout Standard
3955 This will make the cha
3993 This is the dead key
3997 \begin_layout Plain Layout
4004 refers to a key that does not produce a character by itself, but when followed
4005 with another key, produces the desired accent character.
4006 For example, a German characte
4008 r with an umlaut like
4018 can be produced in this manner.
4027 \begin_layout Standard
4040 and then another key not in
4057 followed by the other, not allowed key, as output.
4061 \begin_inset Flex CharStyle:MenuItem
4064 \begin_layout Plain Layout
4072 cancels a dead key, so if
4083 \begin_inset Flex CharStyle:MenuItem
4086 \begin_layout Plain Layout
4095 , the cursor will not go one position backwards but will instead cancel
4111 might have had on the next keystroke.
4115 \begin_layout Standard
4116 The following example specifies that the character ' is to be an acute accent,
4117 allowed on the characters a, e, i, o, u, A, E, I, O, and U:
4120 \begin_layout LyX-Code
4123 kmod ' acute aeiouAEIOU
4126 \begin_layout Labeling
4127 \labelwidthstring 00.00.0000
4128 \begin_inset Flex CharStyle:Code
4131 \begin_layout Plain Layout
4137 Specify an exception to the accent character
4140 \begin_layout LyX-Code
4149 \begin_layout Standard
4150 This defines an exce
4191 have been assigned a keystroke with a previous
4194 \begin_inset Flex CharStyle:Code
4197 \begin_layout Plain Layout
4221 must not belong in the
4268 If such a declaration does not exist in
4276 \begin_inset Flex CharStyle:Code
4279 \begin_layout Plain Layout
4313 \begin_inset Flex CharStyle:Code
4316 \begin_layout Plain Layout
4330 \begin_layout Standard
4331 The following command produces causes äi to be produced when you enter acute-i
4335 \begin_layout LyX-Code
4349 \begin_layout Labeling
4350 \labelwidthstring 00.00.0000
4351 \begin_inset Flex CharStyle:Code
4354 \begin_layout Plain Layout
4360 Combine two accent characters
4363 \begin_layout LyX-Code
4369 accent1 accent2 allowed
4372 \begin_layout Standard
4373 This one is getting pretty esoteric.
4374 It allows you to combine the effect
4430 \begin_inset Flex CharStyle:Code
4433 \begin_layout Plain Layout
4461 \begin_layout Standard
4462 Consider this example from the
4463 \begin_inset Flex CharStyle:Code
4466 \begin_layout Plain Layout
4477 \begin_layout LyX-Code
4480 kmod ; acute aeioyvhAEIOYVH
4484 kcomb acute umlaut iyIY
4487 \begin_layout Standard
4488 This allows you to press
4489 \begin_inset Flex CharStyle:MenuItem
4492 \begin_layout Plain Layout
4500 and get the effect of
4501 \begin_inset Flex CharStyle:Code
4504 \begin_layout Plain Layout
4523 in this case cancels the last dead key, so if you press
4524 \begin_inset Flex CharStyle:MenuItem
4527 \begin_layout Plain Layout
4536 \begin_inset Flex CharStyle:Code
4539 \begin_layout Plain Layout
4552 \begin_layout Subsection
4556 \begin_layout Standard
4558 \begin_inset Flex CharStyle:Code
4561 \begin_layout Plain Layout
4569 mapping is performed, a
4570 \begin_inset Flex CharStyle:Code
4573 \begin_layout Plain Layout
4583 file maps the strings that the symbols generate to characters in the current
4585 The LyX distribution currently includes at least the
4586 \begin_inset Flex CharStyle:Code
4589 \begin_layout Plain Layout
4598 \begin_inset Flex CharStyle:Code
4601 \begin_layout Plain Layout
4612 \begin_layout Standard
4614 \begin_inset Flex CharStyle:Code
4617 \begin_layout Plain Layout
4625 file is a sequence of declarations of the form
4628 \begin_layout LyX-Code
4641 \begin_layout Standard
4642 For example, in order to map
4643 \begin_inset Flex CharStyle:MenuItem
4646 \begin_layout Plain Layout
4656 to the corresponding character in the iso-8859-1 set (233), the following
4660 \begin_layout LyX-Code
4668 \begin_layout Standard
4670 \begin_inset Flex CharStyle:Code
4673 \begin_layout Plain Layout
4682 \begin_inset Flex CharStyle:Code
4685 \begin_layout Plain Layout
4703 the same character can apply to more than one string.
4705 \begin_inset Flex CharStyle:Code
4708 \begin_layout Plain Layout
4719 \begin_layout LyX-Code
4731 \begin_inset Newline newline
4747 \begin_layout Standard
4748 If LyX cannot find a mapping for the string produced by the keystroke or
4749 a deadkey sequence, it will check if it looks like an accented char and
4750 try to draw an accent over the character on screen.
4753 \begin_layout Subsection
4757 \begin_layout Standard
4758 There is a second way to add support for international characters through
4759 so-called dead-keys.
4760 A dead-key works in combination with a letter to produce an accented character.
4761 Here, we'll explain how to create a really simple dead-key to illustrate
4765 \begin_layout Standard
4766 Suppose you happen to need the circumflex character,
4767 \begin_inset Quotes eld
4771 \begin_inset Quotes erd
4776 \begin_inset Flex CharStyle:MenuItem
4779 \begin_layout Plain Layout
4786 \begin_inset space ~
4790 \begin_inset Flex CharStyle:MenuItem
4793 \begin_layout Plain Layout
4799 ] to the LyX command
4800 \begin_inset Flex CharStyle:Code
4803 \begin_layout Plain Layout
4810 \begin_inset Flex CharStyle:Code
4813 \begin_layout Plain Layout
4820 Now, whenever you type the
4821 \begin_inset Flex CharStyle:MenuItem
4824 \begin_layout Plain Layout
4830 -key followed by a letter, that letter will have a circumflex accent on
4832 For example, the sequence
4833 \begin_inset Quotes eld
4837 \begin_inset Flex CharStyle:MenuItem
4840 \begin_layout Plain Layout
4847 \begin_inset Quotes erd
4850 produces the letter:
4851 \begin_inset Quotes eld
4855 \begin_inset Quotes erd
4859 If you tried to type
4860 \begin_inset Quotes eld
4864 \begin_inset Flex CharStyle:MenuItem
4867 \begin_layout Plain Layout
4874 \begin_inset Quotes erd
4877 , however, LyX will complain with a beep, since a
4878 \begin_inset Quotes eld
4882 \begin_inset Flex CharStyle:MenuItem
4885 \begin_layout Plain Layout
4892 \begin_inset Quotes erd
4895 never takes a circumflex accent.
4897 \begin_inset Flex CharStyle:MenuItem
4900 \begin_layout Plain Layout
4906 after a dead-key produces the bare-accent.
4907 Please note this last point! If you bind a key to a dead-key, you'll need
4908 to rebind the character on that key to yet another key.
4910 \begin_inset Flex CharStyle:MenuItem
4913 \begin_layout Plain Layout
4919 to a cedilla is a bad idea, since you'll only get cedillas instead of commas.
4922 \begin_layout Standard
4923 One common way to bind dead-keys is to use
4924 \begin_inset Flex CharStyle:MenuItem
4927 \begin_layout Plain Layout
4934 \begin_inset Flex CharStyle:MenuItem
4937 \begin_layout Plain Layout
4944 \begin_inset Flex CharStyle:MenuItem
4947 \begin_layout Plain Layout
4953 in combination with an accent, like
4954 \begin_inset Quotes eld
4958 \begin_inset Flex CharStyle:MenuItem
4961 \begin_layout Plain Layout
4968 \begin_inset Quotes erd
4972 \begin_inset Quotes eld
4976 \begin_inset Flex CharStyle:MenuItem
4979 \begin_layout Plain Layout
4986 \begin_inset Quotes erd
4990 \begin_inset Quotes eld
4994 \begin_inset Flex CharStyle:MenuItem
4997 \begin_layout Plain Layout
5004 \begin_inset Quotes erd
5008 Another way involves using
5009 \begin_inset Flex CharStyle:Code
5012 \begin_layout Plain Layout
5019 \begin_inset Flex CharStyle:Code
5022 \begin_layout Plain Layout
5028 to set up the special
5029 \begin_inset Flex CharStyle:Code
5032 \begin_layout Plain Layout
5040 \begin_inset Flex CharStyle:Code
5043 \begin_layout Plain Layout
5049 acts in some ways just like
5050 \begin_inset Flex CharStyle:MenuItem
5053 \begin_layout Plain Layout
5059 and permits you to bind keys to accented characters.
5060 You can also turn keys into dead-keys by binding them to something like
5062 \begin_inset Flex CharStyle:Code
5065 \begin_layout Plain Layout
5071 and then binding this symbolic key to the corresponding LyX command.
5075 \begin_layout Plain Layout
5080 : This is exactly what I do in my
5081 \begin_inset Flex CharStyle:Code
5084 \begin_layout Plain Layout
5091 \begin_inset Flex CharStyle:Code
5094 \begin_layout Plain Layout
5102 \begin_inset Flex CharStyle:MenuItem
5105 \begin_layout Plain Layout
5107 \begin_inset space ~
5116 \begin_inset Flex CharStyle:Code
5119 \begin_layout Plain Layout
5125 and a bunch of these
5126 \begin_inset Quotes eld
5130 \begin_inset Flex CharStyle:Code
5133 \begin_layout Plain Layout
5140 \begin_inset Quotes erd
5143 symbolic keys bound such things as
5144 \begin_inset Flex CharStyle:MenuItem
5147 \begin_layout Plain Layout
5149 \begin_inset space ~
5158 \begin_inset Flex CharStyle:MenuItem
5161 \begin_layout Plain Layout
5163 \begin_inset space ~
5172 This is how I produce my accented characters.
5177 You can make just about anything into the
5178 \begin_inset Flex CharStyle:Code
5181 \begin_layout Plain Layout
5188 \begin_inset Flex CharStyle:MenuItem
5191 \begin_layout Plain Layout
5197 keys, a spare function key, etc.
5198 As for the LyX commands that produce accents, check the entry for
5199 \begin_inset Flex CharStyle:Code
5202 \begin_layout Plain Layout
5213 You'll find the complete list there.
5216 \begin_layout Subsection
5217 Saving your Language Configuration
5220 \begin_layout Standard
5221 You can edit your preferences so that your desired language environment
5222 is automatically configured when LyX starts up, via the
5223 \begin_inset Flex CharStyle:MenuItem
5226 \begin_layout Plain Layout
5227 Edit\SpecialChar \menuseparator
5236 \begin_layout Chapter
5237 Installing New Document Classes, Layouts, and Templates
5238 \begin_inset CommandInset label
5240 name "cha:Installing-New-Document"
5248 \begin_layout Plain Layout
5249 Installing New Document Classes
5257 \begin_layout Standard
5258 In this chapter, we describe the procedures for creating and installing
5259 new LyX layout and template files, as well as offer a refresher on correctly
5260 installing new LaTeX document classes.
5264 \begin_layout Standard
5265 First, let us a say a few words about how one ought to think about the relation
5266 between LyX and LaTeX.
5267 The thing to understand is that, in a certain sense, LyX doesn't know anything
5269 Indeed, from LyX's point of view, LaTeX is just one of several
5270 \begin_inset Quotes eld
5274 \begin_inset Quotes erd
5277 in which it is capable of producing output.
5278 Other such formats are DocBook, plaintext, and XHTML.
5279 LaTeX is, of course, a particularly important format, but very little of
5280 the information LyX has about LaTeX is actually contained in the program
5285 \begin_layout Plain Layout
5286 Some commands are sufficiently complex that they are
5287 \begin_inset Quotes eld
5291 \begin_inset Quotes erd
5295 But the developers generally regard this as a Bad Thing.
5300 Rather, that information, even for the standard classes like
5301 \begin_inset Flex CharStyle:Code
5304 \begin_layout Plain Layout
5310 , is contained in `layout files'.
5311 Similarly, LyX itself does not know much about DocBook or XHTML.
5312 What it knows is contained in layout files.
5315 \begin_layout Standard
5316 You can think of the layout file for a given document class as a translation
5317 manual between LyX constructs---paragraphs with their corresponding styles,
5318 certain sorts of insets, etc---and the corresponding LaTeX, DocBook, or
5320 Almost everything LyX knows about
5321 \begin_inset Flex CharStyle:Code
5324 \begin_layout Plain Layout
5330 , for example, is contained in the file
5331 \begin_inset Flex CharStyle:Code
5334 \begin_layout Plain Layout
5340 and in various other files it includes.
5341 For this reason, anyone intending to write layout files should plan to
5342 study the existing files.
5343 A good place to start is with
5344 \begin_inset Flex CharStyle:Code
5347 \begin_layout Plain Layout
5353 , which is included in
5354 \begin_inset Flex CharStyle:Code
5357 \begin_layout Plain Layout
5364 \begin_inset Flex CharStyle:Code
5367 \begin_layout Plain Layout
5373 , and many of the other layout files for document classes.
5374 This file is where sections and the like are defined:
5375 \begin_inset Flex CharStyle:Code
5378 \begin_layout Plain Layout
5384 tells LyX how paragraphs that are marked with the Section, Subsection,
5385 etc, styles can be translated into corresponding LaTeX, DocBook, and XHTML
5388 \begin_inset Flex CharStyle:Code
5391 \begin_layout Plain Layout
5397 file basically just includes several of these
5398 \begin_inset Flex CharStyle:Code
5401 \begin_layout Plain Layout
5410 \begin_layout Standard
5411 Defining the LyX--LaTeX correspondence is not the only thing layout files
5413 Their other job is to define how the LyX constructs themselves will appear
5415 The fact that layout files have these two jobs is often a source of confusion,
5416 because they are completely separate.
5417 Telling LyX how to translate a certain paragraph style into LaTeX does
5418 not tell LyX how to display it; conversely, telling LyX how to display
5419 a certain paragraph style does not tell LyX how to translate it into LaTeX
5420 (let alone tell LaTeX how to display it).
5421 So, in general, when you define a new LyX construct, you must always do
5422 two quite separate things: (i)
5423 \begin_inset space ~
5426 tell LyX how to translate it into LaTeX and (ii)
5427 \begin_inset space ~
5430 tell LyX how to display it.
5433 \begin_layout Standard
5434 Much the same is true, of course, as regards LyX's other backend formats,
5435 though XHTML is in some ways different, because in that case LyX
5439 able, to some extent, to use information about how it should display a
5440 paragraph on the screen to output information (in the form of CSS) about
5441 how the paragraph should be displayed in a browser.
5442 Even in this case, however, the distinction between what LyX does internally
5443 and how things are rendered externally remains in force, and the two can
5444 be controlled separately.
5446 \begin_inset CommandInset ref
5447 LatexCommand prettyref
5448 reference "sec:Tags-for-XHTML"
5455 \begin_layout Section
5456 Installing new LaTeX files
5459 \begin_layout Standard
5460 Some installations may not include a LaTeX package or class file that you
5461 would like to use within LyX.
5462 For example, you might need FoilTeX, a package for preparing slides for
5463 overhead projectors.
5464 Modern LaTeX distributions like TeXLive (2008 or newer) or MiKTeX provide
5465 a user interface for installing such packages.
5466 For example, with MiKTeX, you start the program
5467 \begin_inset Quotes eld
5471 \begin_inset Quotes erd
5474 to get a list of available packages.
5475 To install one, right click on it or use the toolbar button to install
5480 \begin_layout Standard
5481 If your LaTeX distribution doesn't provide such a `package manager', or
5482 if the file is not available from your distribution, then you can follow
5483 these steps to install it manually.
5486 \begin_layout Enumerate
5487 Get the package from
5488 \begin_inset CommandInset href
5491 target "http://www.ctan.org/"
5498 \begin_layout Enumerate
5499 You can install the package in several different places.
5500 If you want it to be available for all users on your system, then you should
5501 install it in your `local' TeX tree; if you want (or need) it to be available
5502 just for you, then you can install it in your own `user' TeX tree.
5503 Where these trees should be created, if they do not already exist, depends
5504 upon the details of your system.
5505 To find out where they are, look in the file
5506 \begin_inset Flex CharStyle:Code
5509 \begin_layout Plain Layout
5519 \begin_layout Plain Layout
5520 This usually lives in the directory
5521 \begin_inset Flex CharStyle:Code
5524 \begin_layout Plain Layout
5530 , though you can run
5531 \begin_inset Flex CharStyle:Code
5534 \begin_layout Plain Layout
5545 The location of the `local' TeX tree is defined by the
5546 \begin_inset Flex CharStyle:Code
5549 \begin_layout Plain Layout
5555 variable; this is usually somewhere like
5556 \begin_inset Flex URL
5559 \begin_layout Plain Layout
5561 /usr/local/share/texmf/
5567 The location of the `user' TeX tree is defined by
5568 \begin_inset Flex CharStyle:Code
5571 \begin_layout Plain Layout
5578 \begin_inset Flex CharStyle:Code
5581 \begin_layout Plain Layout
5588 (If these variables are not predefined, you can define them.) You'll probably
5589 need root permissions to create or modify the `local' tree, but your `user'
5590 tree shouldn't have such limitations.
5593 \begin_layout Enumerate
5595 \begin_inset Flex CharStyle:Code
5598 \begin_layout Plain Layout
5605 \begin_inset Flex CharStyle:Code
5608 \begin_layout Plain Layout
5615 \begin_inset Flex CharStyle:Code
5618 \begin_layout Plain Layout
5625 \begin_inset space \thinspace{}
5629 \begin_inset Newline newline
5633 \begin_inset Flex CharStyle:Code
5636 \begin_layout Plain Layout
5637 TEXMF = {$TEXMFHOME,!!$TEXMFLOCAL,!!$TEXMFMAIN}
5643 \begin_inset Newline newline
5649 \begin_layout Enumerate
5650 Your local and user trees
5654 have the same sort of directory structure as your main existing
5655 \begin_inset Flex CharStyle:Code
5658 \begin_layout Plain Layout
5664 directory, which will be found at
5665 \begin_inset Flex CharStyle:Code
5668 \begin_layout Plain Layout
5675 \begin_inset Flex CharStyle:Code
5678 \begin_layout Plain Layout
5684 .) For example, latex packages should go under
5685 \begin_inset Flex CharStyle:Code
5688 \begin_layout Plain Layout
5689 $TEXMFLOCAL/tex/latex/
5695 \begin_inset Flex CharStyle:Code
5698 \begin_layout Plain Layout
5699 $TEXMFHOME/tex/latex/
5705 If you do not put them here, they probably will not work.
5708 \begin_layout Enumerate
5709 Once your tree is properly set up, you can install the package into an appropria
5711 If you are lucky, your package will have been provided as a so-called `TDS'
5712 (TeX Directory Structure) zip file.
5713 To install it, you want to unzip it from the top of your tree.
5714 So, for example, you can copy the file
5715 \begin_inset Flex CharStyle:Code
5718 \begin_layout Plain Layout
5725 \begin_inset Flex CharStyle:Code
5728 \begin_layout Plain Layout
5729 /home/yourname/texmf/
5734 and then, from inside that directory, just run:
5735 \begin_inset Flex CharStyle:Code
5738 \begin_layout Plain Layout
5745 This will extract the needed files and copy them where they need to be.
5746 \begin_inset Newline newline
5749 If you do not have a TDS file, then you have to do this manually.
5750 For example, you might install the FoilTeX files into
5751 \begin_inset Flex URL
5754 \begin_layout Plain Layout
5756 $TEXMFLOCAL/tex/latex/contrib/foiltex
5762 Why there? The CTAN download directories are themselves organized much
5763 like a TeX tree, and it isn't a bad idea to follow its structure when you
5764 install your own files.
5765 FoilTeX, as it happens, is found at
5766 \begin_inset Flex URL
5769 \begin_layout Plain Layout
5771 http://ctan.org/texarchive/macros/latex/contrib/foiltex/
5780 \begin_layout Enumerate
5781 Finally, you must update the database TeX uses to find files.
5782 On MiKTeX, this is done by pressing the button
5785 \begin_inset space ~
5790 that you find in MiKTeX's
5791 \begin_inset Quotes eld
5795 \begin_inset Quotes erd
5800 \begin_inset Flex CharStyle:Code
5803 \begin_layout Plain Layout
5804 $TEXMFLOCAL/tex/latex/
5810 Under TeXLive and the like, you should run
5811 \begin_inset Flex CharStyle:Code
5814 \begin_layout Plain Layout
5820 from a terminal, with root permissions if necessary.
5824 \begin_layout Standard
5825 Your package is now installed and available to LaTeX.
5826 You can verify this from a terminal by typing `
5827 \begin_inset Flex CharStyle:Code
5830 \begin_layout Plain Layout
5831 kpsewhich yourfile.ext
5837 To make LyX aware of it, however, you will need to reconfigure (
5838 \begin_inset Flex CharStyle:MenuItem
5841 \begin_layout Plain Layout
5842 Tools\SpecialChar \menuseparator
5848 ) and then restart LyX.
5849 If the new package was a document class, such as FoilTeX again, you will
5850 now see it available under
5851 \begin_inset Flex CharStyle:MenuItem
5854 \begin_layout Plain Layout
5855 Document\SpecialChar \menuseparator
5856 Settings\SpecialChar \menuseparator
5863 \begin_inset Flex CharStyle:MenuItem
5866 \begin_layout Plain Layout
5875 \begin_layout Standard
5876 What if there isn't a layout file is available for your new document class?
5877 Then, unfortunately, LyX will know nothing about it until you create a
5878 layout file yourself (or get someone else to do it).
5879 That is the topic of the next section.
5882 \begin_layout Section
5883 Types of layout files
5886 \begin_layout Standard
5887 This section describes the various sorts of LyX files that contain layout
5889 These files describe various paragraph and character styles, determining
5890 how LyX should display them and how they should be translated into LaTeX,
5891 DocBook, XHTML, or whatever output format is being used.
5895 \begin_layout Standard
5896 We shall try to provide a thorough description of the process of writing
5898 However, there are so many different types of documents supported even
5899 by just LaTeX that we can't hope to cover every different possibility or
5900 problem you might encounter.
5901 The LyX users' list is frequented by people with lots of experience with
5902 layout design who are willing to share what they've learned, so please
5903 feel free to ask questions there.
5906 \begin_layout Standard
5907 As you prepare to write a new layout, it is extremely helpful to look at
5908 the layouts distributed with LyX.
5909 If you write a LyX layout for a LaTeX document class that might also be
5910 used by others, or write a module that might be useful to others, then
5911 you should consider posting your layout to the
5912 \begin_inset CommandInset href
5914 name "layout section on the LyX wiki"
5915 target "http://wiki.lyx.org/Layouts/Layouts"
5919 or even to the LyX developers' list, so that it might be included in LyX
5924 \begin_layout Plain Layout
5925 Note that LyX is licensed under the General Public License, so any material
5926 that is contribued to LyX must be similarly licensed.
5934 \begin_layout Subsection
5936 \begin_inset CommandInset label
5938 name "sub:Layout-modules"
5945 \begin_layout Standard
5946 We have spoken to this point about `layout files'.
5947 But there are different sorts of files that contain layout information.
5948 Layout files, strictly so called, have the
5949 \begin_inset Flex CharStyle:Code
5952 \begin_layout Plain Layout
5958 extension and provide LyX with information about document classes.
5959 As of LyX 1.6, however, layout information can also be contained in layout
5965 \begin_inset Flex CharStyle:Code
5968 \begin_layout Plain Layout
5975 Modules are to LaTeX packages much as layouts are to LaTeX classes, and
5976 some modules—such as the
5977 \begin_inset Flex CharStyle:Code
5980 \begin_layout Plain Layout
5986 module—specifcally provide support for one package.
5987 In a sense, layout modules are similar to included
5991 \begin_layout Plain Layout
5992 These can have any extension, but by convention have the
5993 \begin_inset Flex CharStyle:Code
5996 \begin_layout Plain Layout
6008 \begin_inset Flex CharStyle:Code
6011 \begin_layout Plain Layout
6017 —in that modules are not specific to a given document class but may be used
6018 with many different classes.
6019 The difference is that using an included file with
6020 \begin_inset Flex CharStyle:Code
6023 \begin_layout Plain Layout
6029 requires editing that file.
6030 Modules, by contrast, are selected in the
6031 \begin_inset Flex CharStyle:MenuItem
6034 \begin_layout Plain Layout
6035 Document\SpecialChar \menuseparator
6044 \begin_layout Standard
6045 Building modules is the easiest way to get started with layout editing,
6046 since it can be as simple as adding a single new paragraph style or flex
6048 But modules may, in principle, contain anything a layout file can contain.
6051 \begin_layout Standard
6052 After creating a new module and copying it to the
6053 \begin_inset Flex CharStyle:Code
6056 \begin_layout Plain Layout
6062 folder, you will need to reconfigure and then restart LyX for the module
6063 to appear in the menu.
6064 However, changes you make to the module will be seen immediately, if you
6066 \begin_inset Flex CharStyle:MenuItem
6069 \begin_layout Plain Layout
6070 Document\SpecialChar \menuseparator
6076 , highlight something, and then hit
6077 \begin_inset Quotes eld
6081 \begin_inset Quotes erd
6087 It is strongly recommended that you save your work before doing this
6092 it is strongly recommended that you not attempt to edit modules while simultaneo
6093 usly working on actual documents
6096 Though of course the developers strive to keep LyX stable in such situations,
6097 syntax errors and the like in your module file could cause strange behavior.
6100 \begin_layout Subsection
6102 \begin_inset Flex CharStyle:MenuItem
6105 \begin_layout Plain Layout
6114 \begin_layout Standard
6115 There are two situations you are likely to encounter when wanting to support
6116 a new LaTeX document class, involving LaTeX2e class (
6117 \begin_inset Flex CharStyle:Code
6120 \begin_layout Plain Layout
6127 \begin_inset Flex CharStyle:Code
6130 \begin_layout Plain Layout
6137 Supporting a style file is usually fairly easy.
6138 Supporting a new class file is a bit harder.
6139 We'll discuss the former in this section and the latter in the next.
6140 Similar remarks apply, of course, if you want to support a new DocBook
6144 \begin_layout Standard
6145 The easier case is the one in which your new document class is provided
6146 as a style file that is to be used in conjunction with an already supported
6148 For the sake of the example, we'll assume that the style file is called
6150 \begin_inset Flex CharStyle:MenuItem
6153 \begin_layout Plain Layout
6159 and that it is meant to be used with
6160 \begin_inset Flex CharStyle:MenuItem
6163 \begin_layout Plain Layout
6169 , which is a standard class.
6173 \begin_layout Standard
6174 Start by copying the existing class's layout file into your local directory:
6178 \begin_layout Plain Layout
6179 Of course, which directory is your local directory will vary by platform,
6180 and LyX allows you to specify your local directory on startup, too, using
6182 \begin_inset Flex CharStyle:Code
6185 \begin_layout Plain Layout
6199 \begin_layout LyX-Code
6200 cp report.layout ~/.lyx/layouts/myclass.layout
6203 \begin_layout Standard
6205 \begin_inset Flex CharStyle:Code
6208 \begin_layout Plain Layout
6214 and change the line:
6217 \begin_layout LyX-Code
6220 DeclareLaTeXClass{report}
6223 \begin_layout Standard
6227 \begin_layout LyX-Code
6230 DeclareLaTeXClass[report, myclass.sty]{report (myclass)}
6233 \begin_layout Standard
6237 \begin_layout LyX-Code
6239 \begin_inset Newline newline
6245 \begin_inset Newline newline
6251 \begin_layout Standard
6252 near the top of the file.
6255 \begin_layout Standard
6256 Start LyX and select
6257 \begin_inset Flex CharStyle:MenuItem
6260 \begin_layout Plain Layout
6261 Tools\SpecialChar \menuseparator
6268 Then restart LyX and try creating a new document.
6270 \begin_inset Flex CharStyle:MenuItem
6273 \begin_layout Plain Layout
6279 " as a document class option in the
6280 \begin_inset Flex CharStyle:MenuItem
6283 \begin_layout Plain Layout
6284 Document\SpecialChar \menuseparator
6291 It is likely that some of the sectioning commands and such in your new
6292 class will work differently from how they worked in the base class—
6293 \begin_inset Flex CharStyle:Code
6296 \begin_layout Plain Layout
6302 in this example—so you can fiddle around with the settings for the different
6303 sections if you wish.
6304 The layout information for sections is contained in
6305 \begin_inset Flex CharStyle:Code
6308 \begin_layout Plain Layout
6314 , but you do not need to copy and change this file.
6315 Instead, you can simply add your changes to your layout file, after the
6317 \begin_inset Flex CharStyle:Code
6320 \begin_layout Plain Layout
6326 , which itself includes
6327 \begin_inset Flex CharStyle:Code
6330 \begin_layout Plain Layout
6337 For example, you might add these lines:
6340 \begin_layout LyX-Code
6344 \begin_layout LyX-Code
6348 \begin_layout LyX-Code
6352 \begin_layout LyX-Code
6356 \begin_layout LyX-Code
6360 \begin_layout Standard
6361 to change the font for chapter headings to sans-serif.
6362 This will override (or, in this case, add to) the existing declaration
6363 for the Chapter style.
6367 \begin_layout Standard
6368 Your new package may also provide commands or environments not present in
6370 In this case, you will want to add these to the layout file.
6372 \begin_inset CommandInset ref
6374 reference "sec:TextClass"
6378 for information on how to do so.
6381 \begin_layout Standard
6383 \begin_inset Flex CharStyle:MenuItem
6386 \begin_layout Plain Layout
6392 can be used with several different document classes, and even if it cannot,
6393 you might find it easiest just to write a module that you can load with
6395 The simplest possible such module would be:
6398 \begin_layout LyX-Code
6401 DeclareLyXModule{My Package}
6404 \begin_layout LyX-Code
6408 \begin_layout LyX-Code
6409 #Support for mypkg.sty.
6412 \begin_layout LyX-Code
6414 \begin_inset Newline newline
6420 \begin_layout LyX-Code
6422 \begin_inset Newline newline
6428 \begin_layout LyX-Code
6430 \begin_inset Newline newline
6436 \begin_inset Newline newline
6442 \begin_layout Standard
6443 A more complex module might modify the behavior of some existing constructs
6444 or define some new ones.
6446 \begin_inset CommandInset ref
6448 reference "sec:TextClass"
6455 \begin_layout Subsection
6457 \begin_inset Flex CharStyle:MenuItem
6460 \begin_layout Plain Layout
6469 \begin_layout Standard
6470 There are two possibilities here.
6471 One is that the class file is itself based upon an existing document class.
6472 For example, many thesis classes are based upon
6473 \begin_inset Flex CharStyle:MenuItem
6476 \begin_layout Plain Layout
6483 To see whether yours is, look for a line like
6486 \begin_layout LyX-Code
6492 \begin_layout Standard
6494 If so, then you may proceed largely as in the previous section, though
6496 \begin_inset Flex CharStyle:Code
6499 \begin_layout Plain Layout
6505 line will be different.
6506 If your new class is
6507 \begin_inset Flex CharStyle:Code
6510 \begin_layout Plain Layout
6516 and it is based upon
6517 \begin_inset Flex CharStyle:Code
6520 \begin_layout Plain Layout
6526 , then the line should read:
6530 \begin_layout Plain Layout
6531 And it will be easiest if you save the file to
6532 \begin_inset Flex CharStyle:Code
6535 \begin_layout Plain Layout
6541 : LyX assumes that the document class has the same name as the layout file.
6550 \begin_layout LyX-Code
6553 DeclareLaTeXClass[thesis,book]{thesis}
6556 \begin_layout Standard
6557 If, on the other hand, the new class is not based upon an existing class,
6558 you will probably have to
6559 \begin_inset Quotes eld
6563 \begin_inset Quotes erd
6567 We strongly suggest copying an existing layout file which uses a similar
6568 LaTeX class and then modifying it, if you can do so.
6569 At least use an existing file as a starting point so you can find out what
6570 items you need to worry about.
6571 Again, the specifics are covered below.
6574 \begin_layout Subsection
6576 \begin_inset CommandInset label
6578 name "sub:Creating-Templates"
6585 \begin_layout Standard
6586 Once you have written a layout file for a new document class, you might
6587 want to consider writing a
6592 A template acts as a kind of tutorial for your layout, showing how it might
6593 be used, though containing dummy content.
6594 You can of course look at the various templates included with LyX for ideas.
6597 \begin_layout Standard
6598 Templates are created just like usual documents: using LyX.
6599 The only difference is that usual documents contain all possible settings,
6600 including the font scheme and the paper size.
6601 Usually a user doesn't want a template to overwrite his preferred settings
6602 for such parameters.
6603 For that reason, the designer of a template should remove the corresponding
6605 \begin_inset Flex CharStyle:Code
6608 \begin_layout Plain Layout
6617 \begin_inset Flex CharStyle:Code
6620 \begin_layout Plain Layout
6628 from the template LyX file.
6629 This can be done with any simple text-editor, for example
6630 \begin_inset Flex CharStyle:Code
6633 \begin_layout Plain Layout
6640 \begin_inset Flex CharStyle:Code
6643 \begin_layout Plain Layout
6653 \begin_layout Standard
6654 Put the edited template files you create in
6655 \begin_inset Flex CharStyle:Code
6658 \begin_layout Plain Layout
6664 , copy the ones you use from the global template directory in
6665 \begin_inset Flex CharStyle:Code
6668 \begin_layout Plain Layout
6674 to the same place, and redefine the template path in the
6675 \begin_inset Flex CharStyle:MenuItem
6678 \begin_layout Plain Layout
6679 Tools\SpecialChar \menuseparator
6680 Preferences\SpecialChar \menuseparator
6689 \begin_layout Standard
6690 Note, by the way, that there is a template which has a particular meaning:
6692 \begin_inset Flex CharStyle:Code
6695 \begin_layout Plain Layout
6702 This template is loaded every time you create a new document with
6703 \begin_inset Flex CharStyle:MenuItem
6706 \begin_layout Plain Layout
6707 File\SpecialChar \menuseparator
6713 in order to provide useful defaults.
6714 To create this template from inside LyX, all you have to do is to open
6715 a document with the correct settings, and use the
6716 \begin_inset Flex CharStyle:MenuItem
6719 \begin_layout Plain Layout
6720 Save as Document Defaults
6728 \begin_layout Subsection
6729 Upgrading old layout files
6732 \begin_layout Standard
6733 The format of layout files changes with each LyX release, so old layout
6734 files need to be converted to the new format.
6735 This process has been automated since LyX 1.4: If LyX reads a layout file
6736 in an older format, it automatically calls the script
6737 \begin_inset Flex CharStyle:Code
6740 \begin_layout Plain Layout
6746 to convert it to a temporary file in current format.
6747 The original file is left untouched.
6748 If you use the layout file often, then, you may want to convert it permanently,
6749 so that LyX does not have to do so itself every time.
6750 To do this, you can call the converter manually:
6753 \begin_layout LyX-Code
6754 mv myclass.layout myclass.old
6757 \begin_layout LyX-Code
6758 python LyXDir/scripts/layout2layout.py myclass.old myclass.layout
6761 \begin_layout Standard
6763 \begin_inset Flex CharStyle:Code
6766 \begin_layout Plain Layout
6772 with the name of your LyX system directory, of course.
6775 \begin_layout Standard
6776 Note that manual conversion does not affect included files, so these will
6777 have to be converted separately.
6780 \begin_layout Section
6781 \begin_inset CommandInset label
6783 name "sec:TextClass"
6787 The layout file format
6790 \begin_layout Standard
6791 When it's finally time to get your hands dirty and create or edit your own
6792 layout file, the following sections describe what you're up against.
6793 Our advice is to go slowly, save and test often, listen to soothing music,
6794 and enjoy one or two of your favorite adult beverages; more if you are
6795 getting particularly stuck.
6796 It's really not that hard, except that the multitude of options can become
6797 overwhelming if you try to do too much in one sitting.
6798 Go have another adult beverage, just for good measure.
6801 \begin_layout Standard
6802 Note that all the tags used in layout files are case-insensitive.
6804 \begin_inset Flex CharStyle:Code
6807 \begin_layout Plain Layout
6814 \begin_inset Flex CharStyle:Code
6817 \begin_layout Plain Layout
6824 \begin_inset Flex CharStyle:Code
6827 \begin_layout Plain Layout
6833 are really the same tag.
6834 The possible values are printed in brackets after the feature's name.
6835 The default value if a feature isn't specified inside a text class-description
6837 \begin_inset Flex CharStyle:Code
6840 \begin_layout Plain Layout
6849 If the argument has a data type like
6850 \begin_inset Quotes eld
6854 \begin_inset Quotes erd
6858 \begin_inset Quotes eld
6862 \begin_inset Quotes erd
6865 , the default is shown like this:
6866 \begin_inset Flex CharStyle:Code
6869 \begin_layout Plain Layout
6880 \begin_layout Subsection
6881 The document class declaration
6884 \begin_layout Standard
6885 Lines in a layout file which begin with
6886 \begin_inset Flex CharStyle:Code
6889 \begin_layout Plain Layout
6896 There is one exception to this rule.
6898 \begin_inset Flex CharStyle:Code
6901 \begin_layout Plain Layout
6907 files should begin with a line like:
6910 \begin_layout LyX-Code
6913 #% Do not delete the line below; configure depends on this
6916 \begin_layout LyX-Code
6921 DeclareLaTeXClass{article}
6924 \begin_layout Standard
6925 The second line is used when you (re)configure LyX.
6926 The layout file is read by the LaTeX script
6927 \begin_inset Flex CharStyle:Code
6930 \begin_layout Plain Layout
6936 , in a special mode where
6937 \begin_inset Flex CharStyle:Code
6940 \begin_layout Plain Layout
6947 The first line is just a LaTeX comment, and the second one contains the
6948 declaration of the text class.
6949 If these lines appear in a file named
6950 \begin_inset Flex CharStyle:Code
6953 \begin_layout Plain Layout
6959 , then they define a text class of name
6960 \begin_inset Flex CharStyle:Code
6963 \begin_layout Plain Layout
6969 (the name of the layout file) which uses the LaTeX document class
6970 \begin_inset Flex CharStyle:Code
6973 \begin_layout Plain Layout
6979 (the default is to use the same name as the layout).
6981 \begin_inset Quotes eld
6985 \begin_inset Quotes erd
6988 that appears above is used as a description of the text class in the
6989 \begin_inset Flex CharStyle:MenuItem
6992 \begin_layout Plain Layout
6993 Document\SpecialChar \menuseparator
7002 \begin_layout Standard
7003 Let's assume that you wrote your own text class that uses the
7004 \begin_inset Flex CharStyle:Code
7007 \begin_layout Plain Layout
7013 document class, but where you changed the appearance of the section headings.
7014 If you put it in a file
7015 \begin_inset Flex CharStyle:Code
7018 \begin_layout Plain Layout
7024 , the header of this file should be:
7027 \begin_layout LyX-Code
7030 #% Do not delete the line below; configure depends on this
7033 \begin_layout LyX-Code
7038 DeclareLaTeXClass[article]{article (with my own headings)}
7041 \begin_layout Standard
7042 This declares a text class
7043 \begin_inset Flex CharStyle:Code
7046 \begin_layout Plain Layout
7052 , associated with the LaTeX document class
7053 \begin_inset Flex CharStyle:Code
7056 \begin_layout Plain Layout
7063 \begin_inset Quotes eld
7066 article (with my own headings)
7067 \begin_inset Quotes erd
7071 If your text class depends on several packages, you can declare it as:
7074 \begin_layout LyX-Code
7077 #% Do not delete the line below; configure depends on this
7080 \begin_layout LyX-Code
7085 DeclareLaTeXClass[article,foo.sty]{article (with my own headings)}
7088 \begin_layout Standard
7089 This indicates that your text class uses the
7090 \begin_inset Flex CharStyle:Code
7093 \begin_layout Plain Layout
7100 Finally, it is also possible to declare classes for DocBook code.
7101 Typical declarations will look like:
7104 \begin_layout LyX-Code
7107 #% Do not delete the line below; configure depends on this
7110 \begin_layout LyX-Code
7115 DeclareDocBookClass[article]{SGML (DocBook article)}
7118 \begin_layout Standard
7119 Note that these declarations can also be given an optional parameter declaring
7120 the name of the document class (but not a list).
7123 \begin_layout Standard
7124 So, to be as explicit as possible, the form of the layout declaration is:
7127 \begin_layout LyX-Code
7132 DeclareLaTeXClass[class,package.sty]{layout description}
7135 \begin_layout Standard
7136 The class need only be specified if the name of the LaTeX class file and
7137 the name of the layout file are different; if the name of the class file
7138 is not specified, then LyX will simply assume that it is the same as the
7139 name of the layout file.
7142 \begin_layout Standard
7143 When the text class has been modified to your taste, all you have to do
7144 is to copy it either to
7145 \begin_inset Flex CharStyle:Code
7148 \begin_layout Plain Layout
7155 \begin_inset Flex CharStyle:Code
7158 \begin_layout Plain Layout
7165 \begin_inset Flex CharStyle:MenuItem
7168 \begin_layout Plain Layout
7169 Tools\SpecialChar \menuseparator
7175 , exit LyX and restart.
7176 Then your new text class should be available along with the others.
7179 \begin_layout Standard
7180 Once the layout file is installed, you can edit it and see your changes
7181 without having to reconfigure or to restart LyX.
7186 \begin_layout Plain Layout
7187 In versions of LyX prior to 1.6, this was not true.
7188 As a result, editing layout files was very time consuming, since you had
7189 constantly to restart LyX to see changes.
7194 You can force a reload of the current layout by using the LyX function
7196 \begin_inset Flex CharStyle:MenuItem
7199 \begin_layout Plain Layout
7206 There is no default binding for this function—though, of course, you can
7207 bind it to a key yourself.
7208 But you will normally use this function simply by entering it in the mini-buffe
7213 \begin_layout Standard
7219 \begin_inset Flex CharStyle:MenuItem
7222 \begin_layout Plain Layout
7228 is very much an `advanced feature'.
7233 recommended that you save your work before using this function.
7238 recommended that you not attempt to edit layout information while simultaneousl
7239 y working on a document that you care about.
7240 Use a test document.
7241 Syntax errors and the like in your layout file could cause peculiar behavior.
7242 In particular, such errors could cause LyX to regard the current layout
7243 as invalid and to attempt to switch to some other layout.
7247 \begin_layout Plain Layout
7248 Really bad syntax errors may even caused LyX to exit.
7249 This is because certain sorts of errors may make LyX unable to read
7259 The LyX team strives to keep LyX stable in such situations, but safe is
7264 \begin_layout Plain Layout
7265 While we're giving advice: make regular backups.
7266 And be nice to your mother.
7274 \begin_layout Subsection
7275 The Module declaration
7278 \begin_layout Standard
7279 A module must begin with a line like the following:
7282 \begin_layout LyX-Code
7285 DeclareLyXModule[endnotes.sty]{Endnotes}
7288 \begin_layout Standard
7289 The mandatory argument, in curly brackets, is the name of the module, as
7291 \begin_inset Flex CharStyle:MenuItem
7294 \begin_layout Plain Layout
7295 Document\SpecialChar \menuseparator
7302 The argument in square brackets is optional: It declares any LaTeX packages
7303 on which the module depends.
7304 Please note that only packages about which LyX knows should be listed in
7305 the square brackets.
7309 \begin_layout Plain Layout
7310 The list of such packages is documented only in the source code.
7315 LyX will not check for arbitrary packages.
7316 It is also possible to use the form
7317 \begin_inset Flex CharStyle:MenuItem
7320 \begin_layout Plain Layout
7326 as an optional argument, which declares that the module can only be used
7327 when there exists a conversion chain between the formats `
7328 \begin_inset Flex CharStyle:Code
7331 \begin_layout Plain Layout
7338 \begin_inset Flex CharStyle:Code
7341 \begin_layout Plain Layout
7350 \begin_layout Standard
7351 The module declaration should then be followed by lines like the following:
7354 \begin_layout LyX-Code
7358 \begin_layout LyX-Code
7359 #Adds an endnote command, in addition to footnotes.
7363 \begin_layout LyX-Code
7364 #You will need to add
7366 theendnotes in TeX code where you
7369 \begin_layout LyX-Code
7370 #want the endnotes to appear.
7374 \begin_layout LyX-Code
7378 \begin_layout LyX-Code
7379 #Requires: somemodule | othermodule
7382 \begin_layout LyX-Code
7383 #Excludes: badmodule
7386 \begin_layout Standard
7387 The description is used in
7388 \begin_inset Flex CharStyle:MenuItem
7391 \begin_layout Plain Layout
7392 Document\SpecialChar \menuseparator
7398 to provide the user with information about what the module does.
7400 \begin_inset Flex CharStyle:Code
7403 \begin_layout Plain Layout
7409 line is used to identify other modules with which this one must be used;
7411 \begin_inset Flex CharStyle:Code
7414 \begin_layout Plain Layout
7420 line is used to identify modules with which this one may not be used.
7421 Both are optional, and, as shown, multiple modules should be separated
7422 with the pipe symbol: |.
7423 Note that the required modules are treated disjunctively:
7427 of the required modules must be used.
7432 excluded module may be used.
7433 Note that modules are identified here by their
7438 \begin_inset Flex CharStyle:Code
7441 \begin_layout Plain Layout
7449 \begin_inset Flex CharStyle:Code
7452 \begin_layout Plain Layout
7459 \begin_inset Flex CharStyle:Code
7462 \begin_layout Plain Layout
7471 \begin_layout Subsection
7475 \begin_layout Standard
7476 The first non-comment line of any layout file, included file, or module
7481 contain the file format number:
7484 \begin_layout Description
7485 \begin_inset Flex CharStyle:Code
7488 \begin_layout Plain Layout
7495 \begin_inset Flex CharStyle:Code
7498 \begin_layout Plain Layout
7504 ] The format of the layout file.
7507 \begin_layout Standard
7508 This tag was introduced with LyX 1.4.0.
7509 Layout files from LyX 1.3.x and earlier don't have an explicit file format
7510 and are considered to be of format 1.
7511 The format for the present version of LyX is format 21.
7512 But each version of LyX is capable of reading earlier versions' layout
7513 files, just as they are capable of reading files produced by earlier versions
7515 There is, however, no provision for converting to earlier formats.
7516 So LyX 1.6.x will not read layout files in format 21 but only files in format
7520 \begin_layout Subsection
7521 \begin_inset CommandInset label
7523 name "sub:General-text-class"
7527 General text class parameters
7530 \begin_layout Standard
7531 These are general parameters that govern the behavior of an entire document
7537 mean that they must appear in
7538 \begin_inset Flex CharStyle:Code
7541 \begin_layout Plain Layout
7547 files rather than in modules.
7548 A module can contain any layout tag.)
7551 \begin_layout Description
7552 \begin_inset Flex CharStyle:Code
7555 \begin_layout Plain Layout
7561 Adds information that will be output in the
7562 \begin_inset Flex CharStyle:Code
7565 \begin_layout Plain Layout
7571 block when this document class is output to XHTML.
7572 Typically, this would be used to output CSS style information, but it can
7573 be used for anything that can appear in
7574 \begin_inset Flex CharStyle:Code
7577 \begin_layout Plain Layout
7585 \begin_inset Quotes eld
7589 \begin_inset Flex CharStyle:Code
7592 \begin_layout Plain Layout
7599 \begin_inset Quotes erd
7605 \begin_layout Description
7606 \begin_inset Flex CharStyle:Code
7609 \begin_layout Plain Layout
7615 Adds information to the document preamble.
7617 \begin_inset Quotes eld
7621 \begin_inset Flex CharStyle:Code
7624 \begin_layout Plain Layout
7631 \begin_inset Quotes erd
7637 \begin_layout Description
7638 \begin_inset Flex CharStyle:Code
7641 \begin_layout Plain Layout
7647 Defines formats for use in the display of bibliographic information.
7649 \begin_inset CommandInset ref
7651 reference "sub:Citation-format-description"
7657 \begin_inset Quotes eld
7661 \begin_inset Flex CharStyle:Code
7664 \begin_layout Plain Layout
7671 \begin_inset Quotes erd
7677 \begin_layout Description
7678 \begin_inset Flex CharStyle:Code
7681 \begin_layout Plain Layout
7687 Describes various global options supported by the document class.
7689 \begin_inset space ~
7693 \begin_inset CommandInset ref
7695 reference "sub:ClassOptions"
7701 \begin_inset Quotes eld
7705 \begin_inset Flex CharStyle:Code
7708 \begin_layout Plain Layout
7715 \begin_inset Quotes erd
7721 \begin_layout Description
7722 \begin_inset Flex CharStyle:Code
7725 \begin_layout Plain Layout
7732 \begin_inset Flex CharStyle:Code
7735 \begin_layout Plain Layout
7744 \begin_inset Flex CharStyle:Code
7747 \begin_layout Plain Layout
7753 ] Whether the class should
7757 to having one or two columns.
7758 Can be changed in the
7759 \begin_inset Flex CharStyle:MenuItem
7762 \begin_layout Plain Layout
7763 Document\SpecialChar \menuseparator
7772 \begin_layout Description
7773 \begin_inset Flex CharStyle:Code
7776 \begin_layout Plain Layout
7783 \begin_inset Flex CharStyle:Code
7786 \begin_layout Plain Layout
7792 ] This sequence defines the properties for a counter.
7793 If the counter does not yet exist, it is created; if it does exist, it
7796 \begin_inset Quotes eld
7800 \begin_inset Flex CharStyle:Code
7803 \begin_layout Plain Layout
7810 \begin_inset Quotes erd
7814 \begin_inset Newline newline
7818 \begin_inset space ~
7822 \begin_inset CommandInset ref
7824 reference "sub:Counters"
7828 for details on counters.
7831 \begin_layout Description
7832 \begin_inset Flex CharStyle:Code
7835 \begin_layout Plain Layout
7841 Sets the default font used to display the document.
7843 \begin_inset space ~
7847 \begin_inset CommandInset ref
7849 reference "sub:Font-description"
7853 for how to declare fonts.
7855 \begin_inset Quotes eld
7859 \begin_inset Flex CharStyle:Code
7862 \begin_layout Plain Layout
7869 \begin_inset Quotes erd
7875 \begin_layout Description
7876 \begin_inset Flex CharStyle:Code
7879 \begin_layout Plain Layout
7886 \begin_inset Flex CharStyle:Code
7889 \begin_layout Plain Layout
7895 Specifies a module to be included by default with this document class.
7896 The module should be specified by filename without the
7897 \begin_inset Flex CharStyle:Code
7900 \begin_layout Plain Layout
7907 The user can still remove the module, but it will be active at the outset.
7908 (This applies only when new files are created, or when this class is chosen
7909 for an existing document.)
7912 \begin_layout Description
7913 \begin_inset Flex CharStyle:Code
7916 \begin_layout Plain Layout
7923 \begin_inset Flex CharStyle:Code
7926 \begin_layout Plain Layout
7932 ] This is the style that will be assigned to new paragraphs, usually
7933 \begin_inset Flex CharStyle:MenuItem
7936 \begin_layout Plain Layout
7943 This will default to the first defined style if not given, but you are
7944 encouraged to use this directive.
7947 \begin_layout Description
7948 \begin_inset Flex CharStyle:Code
7951 \begin_layout Plain Layout
7958 \begin_inset Flex CharStyle:Code
7961 \begin_layout Plain Layout
7967 ] This tag indicates that the module in question—which should be specified
7968 by filename without the
7969 \begin_inset Flex CharStyle:Code
7972 \begin_layout Plain Layout
7978 extension—cannot be used with this document class.
7979 This might be used in a journal-specific layout file to prevent, say, the
7981 \begin_inset Flex CharStyle:Code
7984 \begin_layout Plain Layout
7990 module that numbers theorems by section.
7995 be used in a module.
7996 Modules have their own way of excluding other modules (see
7997 \begin_inset CommandInset ref
7999 reference "sub:Layout-modules"
8006 \begin_layout Description
8007 \begin_inset Flex CharStyle:Code
8010 \begin_layout Plain Layout
8016 Defines a new float.
8018 \begin_inset space ~
8022 \begin_inset CommandInset ref
8024 reference "sub:Floats"
8030 \begin_inset Quotes eld
8034 \begin_inset Flex CharStyle:Code
8037 \begin_layout Plain Layout
8044 \begin_inset Quotes erd
8050 \begin_layout Description
8051 \begin_inset Flex CharStyle:Code
8054 \begin_layout Plain Layout
8060 Sets the information that will be output in the
8061 \begin_inset Flex CharStyle:Code
8064 \begin_layout Plain Layout
8070 block when this document class is output to XHTML.
8071 Note that this will completely override any prior
8072 \begin_inset Flex CharStyle:Code
8075 \begin_layout Plain Layout
8082 \begin_inset Flex CharStyle:Code
8085 \begin_layout Plain Layout
8093 \begin_inset Flex CharStyle:Code
8096 \begin_layout Plain Layout
8102 if you just want to add material to the preamble.) Must end with
8103 \begin_inset Quotes eld
8107 \begin_inset Flex CharStyle:Code
8110 \begin_layout Plain Layout
8117 \begin_inset Quotes erd
8123 \begin_layout Description
8124 \begin_inset Flex CharStyle:Code
8127 \begin_layout Plain Layout
8134 \begin_inset Flex CharStyle:Code
8137 \begin_layout Plain Layout
8143 ] The layout to use for the table of contents, bibliography, and so forth,
8144 when the document is output to HTML.
8145 For articles, this should normally be Section; for books, Chapter.
8146 If it is not given, then LyX will attempt to figure out which layout to
8150 \begin_layout Description
8151 \begin_inset Flex CharStyle:Code
8154 \begin_layout Plain Layout
8161 \begin_inset Flex CharStyle:Code
8164 \begin_layout Plain Layout
8170 ] Modifies the properties of the given counter.
8171 If the counter does not exist, the section is ignored.
8173 \begin_inset Quotes eld
8177 \begin_inset Flex CharStyle:Code
8180 \begin_layout Plain Layout
8187 \begin_inset Quotes erd
8191 \begin_inset Newline newline
8195 \begin_inset space ~
8199 \begin_inset CommandInset ref
8201 reference "sub:Counters"
8205 for details on counters.
8208 \begin_layout Description
8209 \begin_inset Flex CharStyle:Code
8212 \begin_layout Plain Layout
8219 \begin_inset Flex CharStyle:Code
8222 \begin_layout Plain Layout
8228 ] Modifies the properties of the given paragraph style.
8229 If the style does not exist, the section is ignored.
8231 \begin_inset Quotes eld
8235 \begin_inset Flex CharStyle:Code
8238 \begin_layout Plain Layout
8245 \begin_inset Quotes erd
8251 \begin_layout Description
8252 \begin_inset Flex CharStyle:Code
8255 \begin_layout Plain Layout
8261 As its name implies, this command allows you to include another layout
8262 definition file within yours to avoid duplicating commands.
8263 Common examples are the standard layout files, for example,
8264 \begin_inset Flex CharStyle:Code
8267 \begin_layout Plain Layout
8273 , which contains most of the basic layouts.
8276 \begin_layout Description
8277 \begin_inset Flex CharStyle:Code
8280 \begin_layout Plain Layout
8286 This section (re-)defines the layout of an inset.
8287 It can be applied to an existing inset or to a new, user-defined inset,
8288 e.g., a new character style.
8290 \begin_inset Quotes eld
8294 \begin_inset Flex CharStyle:Code
8297 \begin_layout Plain Layout
8304 \begin_inset Quotes erd
8308 \begin_inset Newline newline
8312 \begin_inset space ~
8316 \begin_inset CommandInset ref
8318 reference "sub:Flex-insets-and"
8322 for more information.
8326 \begin_layout Description
8327 \begin_inset Flex CharStyle:Code
8330 \begin_layout Plain Layout
8337 \begin_inset Flex CharStyle:Code
8340 \begin_layout Plain Layout
8346 ] A string that indicates the width of the left margin on the screen, for
8348 \begin_inset Quotes eld
8352 \begin_inset Quotes erd
8356 (Note that this is not a `length', like
8357 \begin_inset Quotes eld
8361 \begin_inset Quotes erd
8367 \begin_layout Description
8368 \begin_inset Flex CharStyle:Code
8371 \begin_layout Plain Layout
8377 This command deletes an existing float.
8378 This is particularly useful when you want to suppress a float that has
8379 been defined in an input file.
8382 \begin_layout Description
8383 \begin_inset Flex CharStyle:Code
8386 \begin_layout Plain Layout
8392 This command deletes an existing style.
8393 This is particularly useful when you want to suppress a style that has
8394 be defined in an input file.
8397 \begin_layout Description
8398 \begin_inset Flex CharStyle:Code
8401 \begin_layout Plain Layout
8407 A string indicating the file format (as defined in the Preferences dialog)
8408 produced by this class.
8409 It is mainly useful when
8410 \begin_inset Flex CharStyle:Code
8413 \begin_layout Plain Layout
8419 is `literate' and one wants to define a new type of literate document.
8420 This string is reset to `docbook', `latex', or `literate' when the correspondin
8422 \begin_inset Flex CharStyle:Code
8425 \begin_layout Plain Layout
8431 parameter is encountered.
8434 \begin_layout Description
8435 \begin_inset Flex CharStyle:Code
8438 \begin_layout Plain Layout
8444 A string indicating what sort of output documents using this class will
8446 At present, the options are: `docbook', `latex', and `literate'.
8449 \begin_layout Description
8450 \begin_inset Flex CharStyle:Code
8453 \begin_layout Plain Layout
8460 \begin_inset Flex CharStyle:Code
8463 \begin_layout Plain Layout
8472 \begin_inset Flex CharStyle:Code
8475 \begin_layout Plain Layout
8482 \begin_inset Flex CharStyle:Code
8485 \begin_layout Plain Layout
8491 ] The default pagestyle.
8492 Can be changed in the
8493 \begin_inset Flex CharStyle:MenuItem
8496 \begin_layout Plain Layout
8497 Document\SpecialChar \menuseparator
8506 \begin_layout Description
8507 \begin_inset Flex CharStyle:Code
8510 \begin_layout Plain Layout
8516 Sets the preamble for the LaTeX document.
8517 Note that this will completely override any prior
8518 \begin_inset Flex CharStyle:Code
8521 \begin_layout Plain Layout
8528 \begin_inset Flex CharStyle:Code
8531 \begin_layout Plain Layout
8539 \begin_inset Flex CharStyle:Code
8542 \begin_layout Plain Layout
8548 if you just want to add material to the preamble.) Must end with
8549 \begin_inset Quotes eld
8553 \begin_inset Flex CharStyle:Code
8556 \begin_layout Plain Layout
8563 \begin_inset Quotes erd
8569 \begin_layout Description
8570 \begin_inset Flex CharStyle:Code
8573 \begin_layout Plain Layout
8580 \begin_inset Flex CharStyle:Code
8583 \begin_layout Plain Layout
8590 \begin_inset Flex CharStyle:Code
8593 \begin_layout Plain Layout
8602 \begin_inset Flex CharStyle:Code
8605 \begin_layout Plain Layout
8611 ] Whether the class already provides the feature
8612 \begin_inset Flex CharStyle:Code
8615 \begin_layout Plain Layout
8622 A feature is in general the name of a package (
8623 \begin_inset Flex CharStyle:Code
8626 \begin_layout Plain Layout
8633 \begin_inset Flex CharStyle:Code
8636 \begin_layout Plain Layout
8642 , \SpecialChar \ldots{}
8644 \begin_inset Flex CharStyle:Code
8647 \begin_layout Plain Layout
8654 \begin_inset Flex CharStyle:Code
8657 \begin_layout Plain Layout
8663 ,\SpecialChar \ldots{}
8664 ); the complete list of supported features is unfortunately not documented
8665 outside the LyX source code—but see
8666 \begin_inset Flex CharStyle:Code
8669 \begin_layout Plain Layout
8675 if you're interested.
8677 \begin_inset Flex CharStyle:MenuItem
8680 \begin_layout Plain Layout
8681 Help\SpecialChar \menuseparator
8687 also gives an overview of the supported packages.
8690 \begin_layout Description
8691 \begin_inset Flex CharStyle:Code
8694 \begin_layout Plain Layout
8701 \begin_inset Flex CharStyle:Code
8704 \begin_layout Plain Layout
8710 ] Indicates that this layout provides the functionality of the module mentioned,
8711 which should be specified by the filename without the
8712 \begin_inset Flex CharStyle:Code
8715 \begin_layout Plain Layout
8722 This will typically be used if the layout includes the module directly,
8723 rather than using the
8724 \begin_inset Flex CharStyle:Code
8727 \begin_layout Plain Layout
8733 tag to indicate that it ought to be used.
8734 It could also be used in a module that provided an alternate implementation
8735 of the same functionality.
8738 \begin_layout Description
8739 \begin_inset Flex CharStyle:Code
8742 \begin_layout Plain Layout
8749 \begin_inset Flex CharStyle:Code
8752 \begin_layout Plain Layout
8758 ] Whether the class requires the feature
8759 \begin_inset Flex CharStyle:Code
8762 \begin_layout Plain Layout
8769 Multiple features must be separated by commas.
8770 Note that you can only request supported features.
8772 \begin_inset Flex CharStyle:Code
8775 \begin_layout Plain Layout
8781 for a list of these.)
8784 \begin_layout Description
8785 \begin_inset Flex CharStyle:Code
8788 \begin_layout Plain Layout
8794 A string that indicates the width of the right margin on the screen, for
8796 \begin_inset Quotes eld
8800 \begin_inset Quotes erd
8806 \begin_layout Description
8807 \begin_inset Flex CharStyle:Code
8810 \begin_layout Plain Layout
8816 Sets which divisions get numbered.
8818 \begin_inset Flex CharStyle:Code
8821 \begin_layout Plain Layout
8830 \begin_layout Description
8831 \begin_inset Flex CharStyle:Code
8834 \begin_layout Plain Layout
8841 \begin_inset Flex CharStyle:Code
8844 \begin_layout Plain Layout
8853 \begin_inset Flex CharStyle:Code
8856 \begin_layout Plain Layout
8862 ] Whether the class-default should be printing on one or both sides of the
8864 Can be changed in the
8865 \begin_inset Flex CharStyle:MenuItem
8868 \begin_layout Plain Layout
8869 Document\SpecialChar \menuseparator
8878 \begin_layout Description
8879 \begin_inset Flex CharStyle:Code
8882 \begin_layout Plain Layout
8888 This sequence defines a paragraph style.
8889 If the style does not yet exist, it is created; if it does exist, its parameter
8892 \begin_inset Quotes eld
8896 \begin_inset Flex CharStyle:Code
8899 \begin_layout Plain Layout
8906 \begin_inset Quotes erd
8910 \begin_inset Newline newline
8914 \begin_inset space ~
8918 \begin_inset CommandInset ref
8920 reference "sub:Paragraph-Styles"
8924 for details on paragraph styles.
8927 \begin_layout Description
8928 \begin_inset Flex CharStyle:Code
8931 \begin_layout Plain Layout
8938 \begin_inset Flex CharStyle:Code
8941 \begin_layout Plain Layout
8947 ] The name of the command or environment to be used with
8948 \begin_inset Flex CharStyle:Code
8951 \begin_layout Plain Layout
8960 \begin_layout Description
8961 \begin_inset Flex CharStyle:Code
8964 \begin_layout Plain Layout
8971 \begin_inset Flex CharStyle:Code
8974 \begin_layout Plain Layout
8983 \begin_inset Flex CharStyle:Code
8986 \begin_layout Plain Layout
8992 ] Indicates what kind of markup is used to define the title of a document.
8994 \begin_inset Flex CharStyle:Code
8997 \begin_layout Plain Layout
9003 means that the macro with name
9004 \begin_inset Flex CharStyle:Code
9007 \begin_layout Plain Layout
9013 will be inserted after the last layout which has
9014 \begin_inset Quotes eld
9018 \begin_inset Flex CharStyle:Code
9021 \begin_layout Plain Layout
9028 \begin_inset Quotes erd
9033 \begin_inset Flex CharStyle:Code
9036 \begin_layout Plain Layout
9042 corresponds to the case where the block of paragraphs which have
9043 \begin_inset Quotes eld
9047 \begin_inset Flex CharStyle:Code
9050 \begin_layout Plain Layout
9057 \begin_inset Quotes erd
9060 should be enclosed into the
9061 \begin_inset Flex CharStyle:Code
9064 \begin_layout Plain Layout
9073 \begin_layout Description
9074 \begin_inset Flex CharStyle:Code
9077 \begin_layout Plain Layout
9083 Sets which divisions are included in the table of contents.
9085 \begin_inset Flex CharStyle:Code
9088 \begin_layout Plain Layout
9097 \begin_layout Subsection
9098 \begin_inset Flex CharStyle:Code
9101 \begin_layout Plain Layout
9108 \begin_inset CommandInset label
9110 name "sub:ClassOptions"
9117 \begin_layout Standard
9119 \begin_inset Flex CharStyle:Code
9122 \begin_layout Plain Layout
9128 section can contain the following entries:
9131 \begin_layout Description
9132 \begin_inset Flex CharStyle:Code
9135 \begin_layout Plain Layout
9142 \begin_inset Flex CharStyle:Code
9145 \begin_layout Plain Layout
9151 ] The list of available font sizes for the document's main font, separated
9153 \begin_inset Quotes eld
9157 \begin_inset Flex CharStyle:Code
9160 \begin_layout Plain Layout
9167 \begin_inset Quotes erd
9173 \begin_layout Description
9174 \begin_inset Flex CharStyle:Code
9177 \begin_layout Plain Layout
9183 Used to set the DTD line with XML-based output classes.
9185 \begin_inset space \thinspace{}
9189 \begin_inset Quotes eld
9192 -//OASIS//DTD DocBook V4.2//EN
9193 \begin_inset Quotes erd
9199 \begin_layout Description
9200 \begin_inset Flex CharStyle:Code
9203 \begin_layout Plain Layout
9210 \begin_inset Flex CharStyle:Code
9213 \begin_layout Plain Layout
9214 string="empty|plain|headings|fancy"
9219 ] The list of available page styles, separated by
9220 \begin_inset Quotes eld
9224 \begin_inset Flex CharStyle:Code
9227 \begin_layout Plain Layout
9234 \begin_inset Quotes erd
9240 \begin_layout Description
9241 \begin_inset Flex CharStyle:Code
9244 \begin_layout Plain Layout
9251 \begin_inset Flex CharStyle:Code
9254 \begin_layout Plain Layout
9260 ] Some document class options, separated by a comma, that will be added
9261 to the optional part of the
9262 \begin_inset Flex CharStyle:Code
9265 \begin_layout Plain Layout
9276 \begin_layout Standard
9278 \begin_inset Flex CharStyle:Code
9281 \begin_layout Plain Layout
9287 section must end with
9288 \begin_inset Quotes eld
9292 \begin_inset Flex CharStyle:Code
9295 \begin_layout Plain Layout
9302 \begin_inset Quotes erd
9308 \begin_layout Subsection
9310 \begin_inset CommandInset label
9312 name "sub:Paragraph-Styles"
9319 \begin_layout Standard
9320 A paragraph style description looks like this:
9324 \begin_layout Plain Layout
9325 Note that this will either define a new layout or modify an existing one.
9333 \begin_layout LyX-Code
9340 \begin_layout LyX-Code
9344 \begin_layout LyX-Code
9348 \begin_layout Standard
9349 where the following commands are allowed:
9352 \begin_layout Description
9353 \begin_inset Flex CharStyle:Code
9356 \begin_layout Plain Layout
9363 \begin_inset Flex CharStyle:Code
9366 \begin_layout Plain Layout
9371 , left, right, center
9376 ] Paragraph alignment.
9379 \begin_layout Description
9380 \begin_inset Flex CharStyle:Code
9383 \begin_layout Plain Layout
9390 \begin_inset Flex CharStyle:Code
9393 \begin_layout Plain Layout
9398 , left, right, center
9403 ] A comma separated list of permitted alignments.
9404 (Some LaTeX styles prohibit certain alignments, since those wouldn't make
9406 For example a right-aligned or centered enumeration isn't possible.)
9409 \begin_layout Description
9410 \begin_inset Flex CharStyle:Code
9413 \begin_layout Plain Layout
9419 Language dependent information to be included in the LaTeX preamble when
9421 Note that this will completely override any prior
9422 \begin_inset Flex CharStyle:Code
9425 \begin_layout Plain Layout
9433 \begin_inset Quotes eld
9437 \begin_inset Flex CharStyle:Code
9440 \begin_layout Plain Layout
9447 \begin_inset Quotes erd
9451 The contents of this tag will occur once in the LaTeX preamble for each
9452 language used by the document.
9453 Each time, the following substitutions are made:
9457 \begin_layout Itemize
9458 \begin_inset Flex CharStyle:Code
9461 \begin_layout Plain Layout
9467 is replaced by the language name (as used by the babel package).
9470 \begin_layout Itemize
9472 \begin_inset Quotes eld
9476 \begin_inset Quotes erd
9480 \begin_inset Flex CharStyle:Code
9483 \begin_layout Plain Layout
9489 replaces its argument by the translation of the argument to the current
9493 \begin_layout Standard
9494 This preamble snippet will only be used if the document contains more than
9495 one language and the babel package is used.
9499 \begin_layout Description
9500 \begin_inset Flex CharStyle:Code
9503 \begin_layout Plain Layout
9510 \begin_inset Flex CharStyle:Code
9513 \begin_layout Plain Layout
9523 \begin_layout Plain Layout
9524 Note that a `float' here is a real number, such as: 1.5.
9529 The vertical space with which the last of a chain of paragraphs with this
9530 layout is separated from the following paragraph.
9531 If the next paragraph has another layout, the separations are not simply
9532 added, but the maximum is taken.
9535 \begin_layout Description
9536 \begin_inset Flex CharStyle:Code
9539 \begin_layout Plain Layout
9546 \begin_inset Flex CharStyle:Code
9549 \begin_layout Plain Layout
9555 The category for this style.
9556 This is used to group related styles in the Layout combobox on the toolbar.
9557 Any string can be used, but you may want to use existing categories with
9562 \begin_layout Description
9563 \begin_inset Flex CharStyle:Code
9566 \begin_layout Plain Layout
9572 Depth of XML command.
9573 Used only with XML-type formats.
9576 \begin_layout Description
9577 \begin_inset Flex CharStyle:Code
9580 \begin_layout Plain Layout
9587 \begin_inset CommandInset label
9589 name "des:CopyStyle"
9594 \begin_inset Flex CharStyle:Code
9597 \begin_layout Plain Layout
9603 Copies all the features of an existing style into the current one.
9607 \begin_layout Description
9608 \begin_inset Flex CharStyle:Code
9611 \begin_layout Plain Layout
9617 The name of a style whose preamble should be output
9622 This allows to ensure some ordering of the preamble snippets when macros
9623 definitions depend on one another.
9627 \begin_layout Plain Layout
9628 Note that, besides that functionality, there is no way to ensure any ordering
9630 The ordering that you see in a given version of LyX may change without
9631 warning in later versions.
9639 \begin_layout Description
9640 \begin_inset Flex CharStyle:Code
9643 \begin_layout Plain Layout
9650 \begin_inset Flex CharStyle:Code
9653 \begin_layout Plain Layout
9658 , Box, Filled_Box, Static
9663 ] The type of label that stands at the end of the paragraph (or sequence
9665 \begin_inset Flex CharStyle:Code
9668 \begin_layout Plain Layout
9675 \begin_inset Flex CharStyle:Code
9678 \begin_layout Plain Layout
9685 \begin_inset Flex CharStyle:Code
9688 \begin_layout Plain Layout
9695 \begin_inset Flex CharStyle:Code
9698 \begin_layout Plain Layout
9706 \begin_inset Flex CharStyle:Code
9709 \begin_layout Plain Layout
9716 \begin_inset Quotes eld
9720 \begin_inset Quotes erd
9724 \begin_inset Flex CharStyle:Code
9727 \begin_layout Plain Layout
9734 \begin_inset Flex CharStyle:Code
9737 \begin_layout Plain Layout
9738 \begin_inset space ~
9747 \begin_inset space ~
9750 black) square suitable for end of proof markers,
9751 \begin_inset Flex CharStyle:Code
9754 \begin_layout Plain Layout
9760 is an explicit text string.
9763 \begin_layout Description
9764 \begin_inset Flex CharStyle:Code
9767 \begin_layout Plain Layout
9774 \begin_inset Flex CharStyle:Code
9777 \begin_layout Plain Layout
9783 ] The string used for a label with a
9784 \begin_inset Flex CharStyle:Code
9787 \begin_layout Plain Layout
9794 \begin_inset Flex CharStyle:Code
9797 \begin_layout Plain Layout
9807 \begin_layout Description
9808 \begin_inset Flex CharStyle:Code
9811 \begin_layout Plain Layout
9818 \begin_inset Flex CharStyle:Code
9821 \begin_layout Plain Layout
9832 \begin_inset Flex CharStyle:Code
9835 \begin_layout Plain Layout
9844 \begin_layout Description
9845 \begin_inset Flex CharStyle:Code
9848 \begin_layout Plain Layout
9855 \begin_inset Flex CharStyle:Code
9858 \begin_layout Plain Layout
9868 ] With this parameter the
9869 \begin_inset Flex CharStyle:MenuItem
9872 \begin_layout Plain Layout
9879 \begin_inset Quotes eld
9882 Vertical space above
9883 \begin_inset Quotes erd
9887 \begin_inset Flex CharStyle:MenuItem
9890 \begin_layout Plain Layout
9891 Edit\SpecialChar \menuseparator
9893 \begin_inset space ~
9901 dialog can be set when initializing a paragraph with this style.
9905 \begin_layout Plain Layout
9908 Note from Jean-Marc:
9910 I'm not sure that this setting has much use, and it should probably be
9911 removed in later versions.
9919 \begin_layout Description
9920 \begin_inset Flex CharStyle:Code
9923 \begin_layout Plain Layout
9929 The font used for both the text body
9935 \begin_inset space ~
9939 \begin_inset CommandInset ref
9941 reference "sub:Font-description"
9946 Note that defining this font automatically defines the
9947 \begin_inset Flex CharStyle:Code
9950 \begin_layout Plain Layout
9957 So you should define this one first if you also want to define
9958 \begin_inset Flex CharStyle:Code
9961 \begin_layout Plain Layout
9970 \begin_layout Description
9971 \begin_inset Flex CharStyle:Code
9974 \begin_layout Plain Layout
9981 \begin_inset CommandInset label
9983 name "des:FreeSpacing"
9988 \begin_inset Flex CharStyle:Code
9991 \begin_layout Plain Layout
10000 \begin_inset Flex CharStyle:Code
10003 \begin_layout Plain Layout
10009 ] Usually LyX doesn't allow you to insert more than one space between words,
10010 since a space is considered as the separation between two words, not a
10011 character or symbol of its own.
10012 This is a very fine thing but sometimes annoying, for example, when typing
10013 program code or plain LaTeX code.
10015 \begin_inset Flex CharStyle:Code
10018 \begin_layout Plain Layout
10025 Note that LyX will create protected blanks for the additional blanks when
10026 in another mode than LaTeX-mode.
10029 \begin_layout Description
10030 \begin_inset Flex CharStyle:Code
10033 \begin_layout Plain Layout
10039 These tags are used with XHTML output.
10041 \begin_inset CommandInset ref
10042 LatexCommand prettyref
10043 reference "sub:Paragraph-Style-XHTML"
10050 \begin_layout Description
10051 \begin_inset Flex CharStyle:Code
10054 \begin_layout Plain Layout
10060 [[FIXME]] (Used only with XML-type formats.)
10063 \begin_layout Description
10064 \begin_inset Flex CharStyle:Code
10067 \begin_layout Plain Layout
10074 \begin_inset Flex CharStyle:Code
10077 \begin_layout Plain Layout
10083 If 1, marks the layout as to be included in the document preamble rather
10084 than in the document body.
10085 This is useful for document classes that want such information as the title
10086 and author to appear in the preamble.
10089 \begin_layout Description
10090 \begin_inset Flex CharStyle:Code
10093 \begin_layout Plain Layout
10100 \begin_inset Flex CharStyle:Code
10103 \begin_layout Plain Layout
10109 If 1, marks the layout as being part of a title block (see also the
10110 \begin_inset Flex CharStyle:Code
10113 \begin_layout Plain Layout
10120 \begin_inset Flex CharStyle:Code
10123 \begin_layout Plain Layout
10132 \begin_layout Description
10133 \begin_inset Flex CharStyle:Code
10136 \begin_layout Plain Layout
10143 \begin_inset Flex CharStyle:Code
10146 \begin_layout Plain Layout
10152 ] This provides extra space between paragraphs that have the same layout.
10153 If you put other layouts into an environment, each is separated with the
10155 \begin_inset Flex CharStyle:Code
10158 \begin_layout Plain Layout
10165 But the whole items of the environment are additionally separated with
10167 \begin_inset Flex CharStyle:Code
10170 \begin_layout Plain Layout
10177 Note that this is a
10182 \begin_layout Description
10183 \begin_inset Flex CharStyle:Code
10186 \begin_layout Plain Layout
10192 [[FIXME]] (Used only with XML-type formats.)
10195 \begin_layout Description
10196 \begin_inset Flex CharStyle:Code
10199 \begin_layout Plain Layout
10206 \begin_inset CommandInset label
10208 name "des:KeepEmpty"
10213 \begin_inset Flex CharStyle:Code
10216 \begin_layout Plain Layout
10225 \begin_inset Flex CharStyle:Code
10228 \begin_layout Plain Layout
10234 ] Usually LyX does not allow you to leave a paragraph empty, since it would
10235 lead to empty LaTeX output.
10236 There are some cases where this could be desirable however: in a letter
10237 template, the required fields can be provided as empty fields, so that
10238 people do not forget them; in some special classes, a layout can be used
10239 as some kind of break, which does not contain actual text.
10242 \begin_layout Description
10243 \begin_inset Flex CharStyle:Code
10246 \begin_layout Plain Layout
10252 [float=0] The vertical space between the label and the text body.
10253 Only used for labels that are above the text body (
10254 \begin_inset Flex CharStyle:Code
10257 \begin_layout Plain Layout
10264 \begin_inset Flex CharStyle:Code
10267 \begin_layout Plain Layout
10268 Centered_Top_Environment
10276 \begin_layout Description
10277 \begin_inset Flex CharStyle:Code
10280 \begin_layout Plain Layout
10287 \begin_inset Flex CharStyle:Code
10290 \begin_layout Plain Layout
10297 \begin_inset Newline newline
10300 The name of the counter for automatic numbering.
10302 \begin_inset Newline newline
10310 \begin_inset Flex CharStyle:Code
10313 \begin_layout Plain Layout
10320 \begin_inset Flex CharStyle:Code
10323 \begin_layout Plain Layout
10330 In that case, the counter will be stepped each time the layout appears.
10332 \begin_inset Newline newline
10340 \begin_inset Flex CharStyle:Code
10343 \begin_layout Plain Layout
10350 \begin_inset Flex CharStyle:Code
10353 \begin_layout Plain Layout
10359 , though this case is a bit complicated.
10360 Suppose you declare
10361 \begin_inset Quotes eld
10365 \begin_inset Flex CharStyle:Code
10368 \begin_layout Plain Layout
10369 LabelCounter myenum
10375 \begin_inset Quotes erd
10379 Then the actual counters used are
10380 \begin_inset Flex CharStyle:Code
10383 \begin_layout Plain Layout
10390 \begin_inset Flex CharStyle:Code
10393 \begin_layout Plain Layout
10400 \begin_inset Flex CharStyle:Code
10403 \begin_layout Plain Layout
10410 \begin_inset Flex CharStyle:Code
10413 \begin_layout Plain Layout
10419 , much as in LaTeX.
10420 These counters must all be declared separately.
10421 \begin_inset Newline newline
10425 \begin_inset CommandInset ref
10427 reference "sub:Counters"
10431 for details on counters.
10434 \begin_layout Description
10435 \begin_inset Flex CharStyle:Code
10438 \begin_layout Plain Layout
10444 The font used for the label.
10446 \begin_inset space ~
10450 \begin_inset CommandInset ref
10452 reference "sub:Font-description"
10459 \begin_layout Description
10460 \begin_inset Flex CharStyle:Code
10463 \begin_layout Plain Layout
10469 Text that indicates how far a label should be indented.
10472 \begin_layout Description
10473 \begin_inset Flex CharStyle:Code
10476 \begin_layout Plain Layout
10483 \begin_inset Flex CharStyle:Code
10486 \begin_layout Plain Layout
10492 ] The horizontal space between the label and the text body.
10493 Only used for labels that are not above the text body.
10496 \begin_layout Description
10497 \begin_inset Flex CharStyle:Code
10500 \begin_layout Plain Layout
10507 \begin_inset Flex CharStyle:Code
10510 \begin_layout Plain Layout
10516 ] The string used for a label with a
10517 \begin_inset Flex CharStyle:Code
10520 \begin_layout Plain Layout
10528 \begin_inset Flex CharStyle:Code
10531 \begin_layout Plain Layout
10537 is set, this string can be contain the special formatting commands described
10539 \begin_inset CommandInset ref
10541 reference "sub:Counters"
10549 \begin_layout Plain Layout
10550 For the sake of backwards compatibility, the string
10551 \begin_inset Flex CharStyle:Code
10554 \begin_layout Plain Layout
10564 will be replaced by the expanded
10565 \begin_inset Flex CharStyle:Code
10568 \begin_layout Plain Layout
10575 \begin_inset Flex CharStyle:Code
10578 \begin_layout Plain Layout
10587 This feature is now obsolete and should be replaced by the mechanisms of
10589 \begin_inset CommandInset ref
10591 reference "sub:Counters"
10603 \begin_layout Description
10604 \begin_inset Flex CharStyle:Code
10607 \begin_layout Plain Layout
10608 LabelStringAppendix
10614 \begin_inset Flex CharStyle:Code
10617 \begin_layout Plain Layout
10623 ] This is used inside the appendix instead of
10624 \begin_inset Flex CharStyle:Code
10627 \begin_layout Plain Layout
10635 \begin_inset Flex CharStyle:Code
10638 \begin_layout Plain Layout
10645 \begin_inset Flex CharStyle:Code
10648 \begin_layout Plain Layout
10649 LabelStringAppendix
10657 \begin_layout Description
10658 \begin_inset Flex CharStyle:Code
10661 \begin_layout Plain Layout
10667 [FIXME] (Used only with XML-type formats.)
10670 \begin_layout Description
10671 \begin_inset Flex CharStyle:Code
10674 \begin_layout Plain Layout
10681 \begin_inset Flex CharStyle:Code
10684 \begin_layout Plain Layout
10689 , Manual, Static, Top_Environment, Centered_Top_Environment, Counter, Sensitive,
10690 Enumerate, Itemize, Bibliography
10699 \begin_layout Itemize
10700 \begin_inset Flex CharStyle:Code
10703 \begin_layout Plain Layout
10709 means the label is the very first word (up to the first real blank).
10710 Use protected spaces (like
10711 \begin_inset space ~
10714 that one) if you want more than one word as the label.
10718 \begin_layout Itemize
10719 \begin_inset Flex CharStyle:Code
10722 \begin_layout Plain Layout
10728 means the label is simply whatever
10729 \begin_inset Flex CharStyle:Code
10732 \begin_layout Plain Layout
10739 Note that this really is `static'.
10742 \begin_layout Itemize
10743 \begin_inset Flex CharStyle:Code
10746 \begin_layout Plain Layout
10753 \begin_inset Flex CharStyle:Code
10756 \begin_layout Plain Layout
10757 Centered_Top_Environment
10762 are special cases of
10763 \begin_inset Flex CharStyle:Code
10766 \begin_layout Plain Layout
10773 The label will be printed above the paragraph, but only at the top of an
10774 environment or the top of a chain of paragraphs with this layout.
10775 This might be used with the
10776 \begin_inset Flex CharStyle:MenuItem
10779 \begin_layout Plain Layout
10785 layout, for example.
10788 \begin_layout Itemize
10789 \begin_inset Flex CharStyle:Code
10792 \begin_layout Plain Layout
10798 is a special case for the caption-labels
10799 \begin_inset Quotes eld
10803 \begin_inset Quotes erd
10807 \begin_inset Quotes eld
10811 \begin_inset Quotes erd
10816 \begin_inset Flex CharStyle:Code
10819 \begin_layout Plain Layout
10825 means the (hardcoded) label string depends on the kind of float: It is
10826 hardcoded to be `FloatType N', where N is the value of the counter associated
10830 \begin_layout Itemize
10832 \begin_inset Flex CharStyle:Code
10835 \begin_layout Plain Layout
10841 label type defines automatically numbered labels.
10843 \begin_inset Flex CharStyle:Code
10846 \begin_layout Plain Layout
10852 will be expanded to resolve any counter references it contains: For example,
10854 \begin_inset Quotes eld
10858 \begin_inset Flex CharStyle:Code
10861 \begin_layout Plain Layout
10872 \begin_inset Quotes erd
10877 \begin_inset CommandInset ref
10879 reference "sub:Counters"
10883 for more information on counters.
10886 \begin_layout Itemize
10887 \begin_inset Flex CharStyle:Code
10890 \begin_layout Plain Layout
10896 produces the usual sort of enumeration labels.
10897 At present, it is hardcoded to use Arabic numerals, lowercase letters,
10898 small Roman numerals, and uppercase letters for the four possible depths.
10901 \begin_layout Itemize
10902 \begin_inset Flex CharStyle:Code
10905 \begin_layout Plain Layout
10911 produces various bullets at the different levels.
10912 It is also hardcoded.
10915 \begin_layout Itemize
10916 \begin_inset Flex CharStyle:Code
10919 \begin_layout Plain Layout
10925 is used internally by LyX and should be used only with
10926 \begin_inset Flex CharStyle:Code
10929 \begin_layout Plain Layout
10930 LatexType BibEnvironment
10939 \begin_layout Description
10940 \begin_inset Flex CharStyle:Code
10943 \begin_layout Plain Layout
10950 \begin_inset Flex CharStyle:Code
10953 \begin_layout Plain Layout
10959 , but this preamble snippet occurs independently from the babel package,
10960 and only for the document language.
10962 \begin_inset Quotes eld
10966 \begin_inset Flex CharStyle:Code
10969 \begin_layout Plain Layout
10976 \begin_inset Quotes erd
10983 \begin_layout Standard
10984 If the style defines text that appears in the typeset document, it may use
10986 \begin_inset Flex CharStyle:Code
10989 \begin_layout Plain Layout
10996 \begin_inset Flex CharStyle:Code
10999 \begin_layout Plain Layout
11005 to support non-english and even multilanguage documents correctly.
11006 The following excerpt (from the
11007 \begin_inset Flex CharStyle:Code
11010 \begin_layout Plain Layout
11016 file) shows how this works:
11019 \begin_layout LyX-Code
11023 \begin_layout LyX-Code
11026 theoremstyle{remark}
11029 \begin_layout LyX-Code
11032 newtheorem{claim}[thm]{
11039 \begin_layout LyX-Code
11043 \begin_layout LyX-Code
11047 \begin_layout LyX-Code
11052 claimname}{_(Claim)}
11055 \begin_layout LyX-Code
11059 \begin_layout LyX-Code
11063 \begin_layout LyX-Code
11067 \begin_layout LyX-Code
11076 claimname}{_(Claim)}}
11079 \begin_layout LyX-Code
11083 \begin_layout Standard
11084 The key to correct translation of the user visible text is the definition
11086 \begin_inset Flex CharStyle:Code
11089 \begin_layout Plain Layout
11097 in the language preamble.
11098 This command holds the name of the theorem that will appear in the output.
11100 \begin_inset Flex CharStyle:Code
11103 \begin_layout Plain Layout
11109 then uses the commands offered by the babel package to redefine
11110 \begin_inset Flex CharStyle:Code
11113 \begin_layout Plain Layout
11121 for each used language in multilanguage documents.
11125 \begin_layout Description
11126 \begin_inset Flex CharStyle:Code
11129 \begin_layout Plain Layout
11135 The name of the corresponding LaTeX stuff.
11136 Either the environment or command name.
11139 \begin_layout Description
11140 \begin_inset Flex CharStyle:Code
11143 \begin_layout Plain Layout
11149 An optional parameter for the corresponding
11150 \begin_inset Flex CharStyle:Code
11153 \begin_layout Plain Layout
11160 This parameter cannot be changed from within LyX.
11163 \begin_layout Description
11164 \begin_inset Flex CharStyle:Code
11167 \begin_layout Plain Layout
11174 \begin_inset CommandInset label
11176 name "des:LatexType"
11181 \begin_inset Flex CharStyle:Code
11184 \begin_layout Plain Layout
11189 , Command, Environment, Item_Environment,
11195 \begin_inset Flex CharStyle:Code
11198 \begin_layout Plain Layout
11199 List_Environment, Bib_Environment
11204 ] How the layout should be translated into LaTeX.
11208 \begin_layout Plain Layout
11209 \begin_inset Flex CharStyle:Code
11212 \begin_layout Plain Layout
11218 is perhaps a bit misleading, since these rules apply to SGML classes, too.
11219 Visit the SGML class files for specific examples.
11228 \begin_layout Itemize
11229 \begin_inset Flex CharStyle:Code
11232 \begin_layout Plain Layout
11238 means nothing special.
11242 \begin_layout Itemize
11243 \begin_inset Flex CharStyle:Code
11246 \begin_layout Plain Layout
11253 \begin_inset Flex CharStyle:Code
11256 \begin_layout Plain Layout
11263 {\SpecialChar \ldots{}
11272 \begin_layout Itemize
11273 \begin_inset Flex CharStyle:Code
11276 \begin_layout Plain Layout
11283 \begin_inset Flex CharStyle:Code
11286 \begin_layout Plain Layout
11293 }\SpecialChar \ldots{}
11309 \begin_layout Itemize
11310 \begin_inset Flex CharStyle:Code
11313 \begin_layout Plain Layout
11320 \begin_inset Flex CharStyle:Code
11323 \begin_layout Plain Layout
11330 \begin_inset Flex CharStyle:Code
11333 \begin_layout Plain Layout
11341 is generated for each paragraph of this environment.
11345 \begin_layout Itemize
11346 \begin_inset Flex CharStyle:Code
11349 \begin_layout Plain Layout
11356 \begin_inset Flex CharStyle:Code
11359 \begin_layout Plain Layout
11366 \begin_inset Flex CharStyle:Code
11369 \begin_layout Plain Layout
11375 is passed as an argument to the environment.
11377 \begin_inset Flex CharStyle:Code
11380 \begin_layout Plain Layout
11386 can be defined in the
11387 \begin_inset Flex CharStyle:MenuItem
11390 \begin_layout Plain Layout
11395 ayout\SpecialChar \menuseparator
11409 \begin_layout Standard
11410 Putting the last few things together, the LaTeX output will be either:
11413 \begin_layout LyX-Code
11416 latexname[latexparam]{\SpecialChar \ldots{}
11420 \begin_layout Standard
11424 \begin_layout LyX-Code
11427 begin{latexname}[latexparam] \SpecialChar \ldots{}
11433 \begin_layout Standard
11434 depending upon the LaTeX type.
11438 \begin_layout Description
11439 \begin_inset Flex CharStyle:Code
11442 \begin_layout Plain Layout
11449 \begin_inset Flex CharStyle:Code
11452 \begin_layout Plain Layout
11458 ] If you put layouts into environments, the leftmargins are not simply added,
11459 but added with a factor
11460 \begin_inset Formula $\frac{4}{depth+4}$
11464 Note that this parameter is also used when the margin is defined as
11465 \begin_inset Flex CharStyle:Code
11468 \begin_layout Plain Layout
11475 \begin_inset Flex CharStyle:Code
11478 \begin_layout Plain Layout
11485 Then it is added to the manual or dynamic margin.
11487 \begin_inset Newline newline
11490 The argument is passed as a string.
11492 \begin_inset Quotes eld
11496 \begin_inset Flex CharStyle:Code
11499 \begin_layout Plain Layout
11506 \begin_inset Quotes erd
11509 means that the paragraph is indented with the width of
11510 \begin_inset Quotes eld
11514 \begin_inset Flex CharStyle:Code
11517 \begin_layout Plain Layout
11524 \begin_inset Quotes erd
11527 in the normal font.
11528 You can get a negative width by prefixing the string with
11529 \begin_inset Quotes eld
11533 \begin_inset Flex CharStyle:Code
11536 \begin_layout Plain Layout
11543 \begin_inset Quotes erd
11547 This way was chosen so that the look is the same with each used screen
11552 \begin_layout Description
11553 \begin_inset Flex CharStyle:Code
11556 \begin_layout Plain Layout
11563 \begin_inset Flex CharStyle:Code
11566 \begin_layout Plain Layout
11571 , Manual, Dynamic, First_Dynamic, Right_Address_Box
11577 \begin_inset Newline newline
11580 The kind of margin that the layout has on the left side.
11582 \begin_inset Flex CharStyle:Code
11585 \begin_layout Plain Layout
11591 just means a fixed margin.
11593 \begin_inset Flex CharStyle:Code
11596 \begin_layout Plain Layout
11602 means that the left margin depends on the string entered in the
11603 \begin_inset Flex CharStyle:MenuItem
11606 \begin_layout Plain Layout
11607 Edit\SpecialChar \menuseparator
11609 \begin_inset space ~
11618 This is used to typeset nice lists without tabulators.
11620 \begin_inset Flex CharStyle:Code
11623 \begin_layout Plain Layout
11629 means that the margin depends on the size of the label.
11630 This is used for automatic enumerated headlines.
11631 It is obvious that the headline
11632 \begin_inset Quotes eld
11635 5.4.3.2.1 Very long headline
11636 \begin_inset Quotes erd
11639 must have a wider left margin (as wide as
11640 \begin_inset Quotes eld
11644 \begin_inset Quotes erd
11647 plus the space) than
11648 \begin_inset Quotes eld
11651 3.2 Very long headline
11652 \begin_inset Quotes erd
11656 \begin_inset Quotes eld
11660 \begin_inset Quotes erd
11663 are not able to do this.
11665 \begin_inset Flex CharStyle:Code
11668 \begin_layout Plain Layout
11674 is similar, but only the very first row of the paragraph is dynamic, while
11675 the others are static; this is used, for example, for descriptions.
11677 \begin_inset Flex CharStyle:Code
11680 \begin_layout Plain Layout
11686 means the margin is chosen in a way that the longest row of this paragraph
11687 fits to the right margin.
11688 This is used to typeset an address on the right edge of the page.
11691 \begin_layout Description
11692 \begin_inset Flex CharStyle:Code
11695 \begin_layout Plain Layout
11702 \begin_inset Flex CharStyle:Code
11705 \begin_layout Plain Layout
11714 \begin_inset Flex CharStyle:Code
11717 \begin_layout Plain Layout
11723 ] Whether fragile commands in this layout should be
11724 \begin_inset Flex CharStyle:Code
11727 \begin_layout Plain Layout
11740 whether this command should itself be protected.)
11743 \begin_layout Description
11744 \begin_inset Flex CharStyle:Code
11747 \begin_layout Plain Layout
11754 \begin_inset Flex CharStyle:Code
11757 \begin_layout Plain Layout
11764 \begin_inset Flex CharStyle:Code
11767 \begin_layout Plain Layout
11775 ] Whether newlines are translated into LaTeX newlines (
11776 \begin_inset Flex CharStyle:Code
11779 \begin_layout Plain Layout
11790 The translation can be switched off to allow more comfortable LaTeX editing
11794 \begin_layout Description
11795 \begin_inset Flex CharStyle:Code
11798 \begin_layout Plain Layout
11805 \begin_inset Flex CharStyle:Code
11808 \begin_layout Plain Layout
11815 \begin_inset Flex CharStyle:Code
11818 \begin_layout Plain Layout
11826 ] Whether the following Paragraph is allowed to indent its very first row.
11828 \begin_inset Flex CharStyle:Code
11831 \begin_layout Plain Layout
11837 means that it is not allowed to do so;
11838 \begin_inset Flex CharStyle:Code
11841 \begin_layout Plain Layout
11847 means it could do so if it wants to.
11850 \begin_layout Description
11851 \begin_inset Flex CharStyle:Code
11854 \begin_layout Plain Layout
11860 Name of a layout that has replaced this layout.
11861 This is used to rename a layout, while keeping backward compatibility.
11864 \begin_layout Description
11865 \begin_inset Flex CharStyle:Code
11868 \begin_layout Plain Layout
11875 \begin_inset Flex CharStyle:Code
11878 \begin_layout Plain Layout
11884 ] The number of optional arguments that can be used with this layout.
11885 This is useful for things like section headings, and only makes sense with
11887 Note that, on output, the optional arguments will all precede any required
11888 arguments (see below).
11889 So one can have constructs like:
11893 \begin_layout LyX-Code
11896 mycmd[opt1]{req1}{contents of paragraph}
11899 \begin_layout Standard
11900 but one cannot have things like:
11903 \begin_layout LyX-Code
11906 mycmd[opt1]{req1}[opt2]{contents of paragraph}
11909 \begin_layout Standard
11910 at least, not without ERT (with which you can have anything).
11915 \begin_layout Description
11916 \begin_inset Flex CharStyle:Code
11919 \begin_layout Plain Layout
11926 \begin_inset Flex CharStyle:Code
11929 \begin_layout Plain Layout
11935 ] The indent of the very first line of a paragraph.
11937 \begin_inset Flex CharStyle:Code
11940 \begin_layout Plain Layout
11946 will be fixed for a certain layout.
11947 The exception is Standard layout, since the indentation of a Standard layout
11948 paragraph can be prohibited with
11949 \begin_inset Flex CharStyle:Code
11952 \begin_layout Plain Layout
11959 Also, Standard layout paragraphs inside environments use the
11960 \begin_inset Flex CharStyle:Code
11963 \begin_layout Plain Layout
11969 of the environment, not their native one.
11970 For example, Standard paragraphs inside an enumeration are not indented.
11973 \begin_layout Description
11974 \begin_inset Flex CharStyle:Code
11977 \begin_layout Plain Layout
11984 \begin_inset Flex CharStyle:Code
11987 \begin_layout Plain Layout
11993 ] The vertical space between two paragraphs of this layout.
11996 \begin_layout Description
11997 \begin_inset Flex CharStyle:Code
12000 \begin_layout Plain Layout
12007 \begin_inset Flex CharStyle:Code
12010 \begin_layout Plain Layout
12016 ] LyX allows the user to choose either
12017 \begin_inset Quotes eld
12021 \begin_inset Quotes erd
12025 \begin_inset Quotes eld
12029 \begin_inset Quotes erd
12032 to typeset a document.
12034 \begin_inset Quotes eld
12038 \begin_inset Quotes erd
12041 is chosen, this value is completely ignored.
12043 \begin_inset Quotes eld
12047 \begin_inset Quotes erd
12050 is chosen, the parindent of a LaTeXtype
12051 \begin_inset Quotes eld
12055 \begin_inset Quotes erd
12058 layout is ignored and all paragraphs are separated by this parskip argument.
12059 The vertical space is calculated with
12060 \begin_inset Flex CharStyle:Code
12063 \begin_layout Plain Layout
12065 \begin_inset space ~
12074 \begin_inset Flex CharStyle:Code
12077 \begin_layout Plain Layout
12083 is the height of a row with the normal font.
12084 This way, the look stays the same with different screen fonts.
12087 \begin_layout Description
12088 \begin_inset Flex CharStyle:Code
12091 \begin_layout Plain Layout
12098 \begin_inset CommandInset label
12100 name "des:PathThru"
12105 \begin_inset Flex CharStyle:Code
12108 \begin_layout Plain Layout
12117 \begin_inset Flex CharStyle:Code
12120 \begin_layout Plain Layout
12126 ] Whether the contents of this paragraph should be output in raw form, meaning
12127 without special translations that LaTeX would require.
12130 \begin_layout Description
12131 \begin_inset Flex CharStyle:Code
12134 \begin_layout Plain Layout
12141 \begin_inset CommandInset label
12143 name "des:Preamble"
12147 Information to be included in the LaTeX preamble when this style is used.
12148 Used to define macros, load packages, etc., required by this particular
12151 \begin_inset Quotes eld
12155 \begin_inset Flex CharStyle:Code
12158 \begin_layout Plain Layout
12165 \begin_inset Quotes erd
12171 \begin_layout Description
12172 \begin_inset Flex CharStyle:Code
12175 \begin_layout Plain Layout
12182 \begin_inset Flex CharStyle:Code
12185 \begin_layout Plain Layout
12191 ] The prefix to use when creating labels referring to paragraphs of this
12193 This allows the use of formatted references.
12196 \begin_layout Description
12197 \begin_inset Flex CharStyle:Code
12200 \begin_layout Plain Layout
12207 \begin_inset Flex CharStyle:Code
12210 \begin_layout Plain Layout
12216 ] The number of required arguments that the LaTeX command or environment
12217 corresponding to this layout expects.
12218 In the case of a command, these are required arguments
12222 that associated with the content of the paragraph itself.
12223 These do not actually have to be provided: LyX will output empty arguments
12225 Note that optional arguments will be output before required arguments.
12226 See the discussion of the
12227 \begin_inset Flex CharStyle:Code
12230 \begin_layout Plain Layout
12236 tag above for more information.
12239 \begin_layout Description
12240 \begin_inset Flex CharStyle:Code
12243 \begin_layout Plain Layout
12250 \begin_inset Flex CharStyle:Code
12253 \begin_layout Plain Layout
12260 \begin_inset CommandInset label
12262 name "des:Requires"
12266 Whether the layout requires the feature
12267 \begin_inset Flex CharStyle:Code
12270 \begin_layout Plain Layout
12277 See the description of
12278 \begin_inset Flex CharStyle:Code
12281 \begin_layout Plain Layout
12288 \begin_inset CommandInset ref
12289 LatexCommand pageref
12290 reference "des:FreeSpacing"
12294 ) for information on `features'.
12298 \begin_layout Description
12299 \begin_inset Flex CharStyle:Code
12302 \begin_layout Plain Layout
12309 \begin_inset Flex CharStyle:Code
12312 \begin_layout Plain Layout
12319 \begin_inset Flex CharStyle:Code
12322 \begin_layout Plain Layout
12331 \begin_layout Description
12332 \begin_inset Flex CharStyle:Code
12335 \begin_layout Plain Layout
12342 \begin_inset Flex CharStyle:Code
12345 \begin_layout Plain Layout
12350 , onehalf, double, other
12359 ] This defines what the default spacing should be in the layout.
12361 \begin_inset Flex CharStyle:Code
12364 \begin_layout Plain Layout
12371 \begin_inset Flex CharStyle:Code
12374 \begin_layout Plain Layout
12381 \begin_inset Flex CharStyle:Code
12384 \begin_layout Plain Layout
12390 correspond respectively to a multiplier value of 1, 1.25 and 1.667.
12391 If you specify the argument
12392 \begin_inset Flex CharStyle:Code
12395 \begin_layout Plain Layout
12401 , then you should also provide a numerical argument which will be the actual
12403 Note that, contrary to other parameters,
12404 \begin_inset Flex CharStyle:Code
12407 \begin_layout Plain Layout
12413 implies the generation of specific LaTeX code, using the package
12416 \begin_inset Flex CharStyle:Code
12419 \begin_layout Plain Layout
12428 \begin_layout Description
12429 \begin_inset Flex CharStyle:Code
12432 \begin_layout Plain Layout
12439 \begin_inset Flex CharStyle:Code
12442 \begin_layout Plain Layout
12449 \begin_inset Flex CharStyle:Code
12452 \begin_layout Plain Layout
12460 ] Spellcheck paragraphs of this style.
12464 \begin_layout Description
12465 \begin_inset Flex CharStyle:Code
12468 \begin_layout Plain Layout
12474 The font used for the text body .
12476 \begin_inset CommandInset ref
12478 reference "sub:Font-description"
12485 \begin_layout Description
12486 \begin_inset Flex CharStyle:Code
12489 \begin_layout Plain Layout
12498 \begin_inset Flex CharStyle:Code
12501 \begin_layout Plain Layout
12511 The level of the style in the table of contents.
12512 This is used for automatic numbering of section headings.
12515 \begin_layout Description
12516 \begin_inset Flex CharStyle:Code
12519 \begin_layout Plain Layout
12526 \begin_inset Flex CharStyle:Code
12529 \begin_layout Plain Layout
12535 ] The vertical space with which the very first of a chain of paragraphs
12536 with this layout is separated from the previous paragraph.
12537 If the previous paragraph has another layout, the separations are not simply
12538 added, but the maximum is taken.
12541 \begin_layout Subsection
12543 \begin_inset CommandInset label
12552 \begin_layout Standard
12553 Since version 1.3.0 of LyX, it is has been both possible and necessary to
12554 define the floats (
12555 \begin_inset Flex CharStyle:MenuItem
12558 \begin_layout Plain Layout
12565 \begin_inset Flex CharStyle:MenuItem
12568 \begin_layout Plain Layout
12574 , \SpecialChar \ldots{}
12575 ) in the text class itself.
12576 Standard floats are included in the file
12577 \begin_inset Flex CharStyle:Code
12580 \begin_layout Plain Layout
12586 , so you may have to do no more than add
12589 \begin_layout LyX-Code
12590 Input stdfloats.inc
12593 \begin_layout Standard
12594 to your layout file.
12595 If you want to implement a text class that proposes some other float types
12596 (like the AGU class bundled with LyX), the information below will hopefully
12600 \begin_layout Description
12601 \begin_inset Flex CharStyle:Code
12604 \begin_layout Plain Layout
12611 \begin_inset Flex CharStyle:Code
12614 \begin_layout Plain Layout
12621 \begin_inset Quotes erd
12625 \begin_inset Quotes erd
12628 ] The file name extension of an auxiliary file for the list of figures (or
12630 LaTeX writes the captions to this file.
12633 \begin_layout Description
12634 \begin_inset Flex CharStyle:Code
12637 \begin_layout Plain Layout
12644 \begin_inset Flex CharStyle:Code
12647 \begin_layout Plain Layout
12654 \begin_inset Quotes erd
12658 \begin_inset Quotes erd
12661 ] The string that will be used in the menus and also for the caption.
12662 This is translated to the current language if babel is used.
12665 \begin_layout Description
12666 \begin_inset Flex CharStyle:Code
12669 \begin_layout Plain Layout
12675 These are used for XHTML output.
12677 \begin_inset CommandInset ref
12679 reference "sec:Tags-for-XHTML"
12686 \begin_layout Description
12687 \begin_inset Flex CharStyle:Code
12690 \begin_layout Plain Layout
12697 \begin_inset Flex CharStyle:Code
12700 \begin_layout Plain Layout
12707 \begin_inset Quotes erd
12711 \begin_inset Quotes erd
12714 ] The command used to generate a list of floats of this type; the leading
12717 ' should be omitted.
12723 \begin_inset Flex CharStyle:Code
12726 \begin_layout Plain Layout
12732 is false, since there is no standard way to generate this command.
12734 \begin_inset Flex CharStyle:Code
12737 \begin_layout Plain Layout
12743 is true, since in that case there is a standard way.
12746 \begin_layout Description
12747 \begin_inset Flex CharStyle:Code
12750 \begin_layout Plain Layout
12757 \begin_inset Flex CharStyle:Code
12760 \begin_layout Plain Layout
12767 \begin_inset Quotes erd
12771 \begin_inset Quotes erd
12774 ] A title for a list of floats of this kind (list of figures, tables, or
12776 It is used for the screen label within LyX; it is passed to LaTeX for use
12777 as the title there; and it is used as the title in XHTML output.
12778 It will be translated to the document language.
12781 \begin_layout Description
12782 \begin_inset Flex CharStyle:Code
12785 \begin_layout Plain Layout
12792 \begin_inset Flex CharStyle:Code
12795 \begin_layout Plain Layout
12802 \begin_inset Flex CharStyle:Code
12805 \begin_layout Plain Layout
12813 ] Indicates whether the float is already defined in the document class or
12814 if we instead need to load
12815 \begin_inset Flex CharStyle:Code
12818 \begin_layout Plain Layout
12824 and use what it provides.
12826 \begin_inset Flex CharStyle:Code
12829 \begin_layout Plain Layout
12836 \begin_inset Flex CharStyle:Code
12839 \begin_layout Plain Layout
12846 It should be set to
12847 \begin_inset Flex CharStyle:Code
12850 \begin_layout Plain Layout
12856 if the float is already defined by the LaTeX document class.
12859 \begin_layout Description
12860 \begin_inset Flex CharStyle:Code
12863 \begin_layout Plain Layout
12870 \begin_inset Flex CharStyle:Code
12873 \begin_layout Plain Layout
12880 \begin_inset Quotes erd
12884 \begin_inset Quotes erd
12887 ] This (optional) argument determines whether floats of this class will
12888 be numbered within some sectional unit of the document.
12889 For example, if within is equal to
12890 \begin_inset Flex CharStyle:Code
12893 \begin_layout Plain Layout
12899 , the floats will be numbered within chapters.
12903 \begin_layout Description
12904 \begin_inset Flex CharStyle:Code
12907 \begin_layout Plain Layout
12914 \begin_inset Flex CharStyle:Code
12917 \begin_layout Plain Layout
12924 \begin_inset Quotes erd
12928 \begin_inset Quotes erd
12931 ] The default placement for the given class of floats.
12932 The string should be as in standard LaTeX:
12933 \begin_inset Flex CharStyle:Code
12936 \begin_layout Plain Layout
12943 \begin_inset Flex CharStyle:Code
12946 \begin_layout Plain Layout
12953 \begin_inset Flex CharStyle:Code
12956 \begin_layout Plain Layout
12963 \begin_inset Flex CharStyle:Code
12966 \begin_layout Plain Layout
12972 for top, bottom, page, and here, respectively.
12976 \begin_layout Plain Layout
12977 Note that the order of these letters in the string is irrelevant, like in
12983 On top of that there is a new type,
12984 \begin_inset Flex CharStyle:Code
12987 \begin_layout Plain Layout
12993 , which does not really correspond to a float, since it means: put it
12994 \begin_inset Quotes eld
12998 \begin_inset Quotes erd
13002 Note however that the
13003 \begin_inset Flex CharStyle:Code
13006 \begin_layout Plain Layout
13012 specifier is special and, because of implementation details, cannot be
13013 used in non-built in float types.
13014 If you do not understand what this means, just use
13015 \begin_inset Quotes eld
13019 \begin_inset Flex CharStyle:Code
13022 \begin_layout Plain Layout
13029 \begin_inset Quotes erd
13035 \begin_layout Description
13036 \begin_inset Flex CharStyle:Code
13039 \begin_layout Plain Layout
13046 \begin_inset Flex CharStyle:Code
13049 \begin_layout Plain Layout
13055 ] The prefix to use when creating labels referring to floats of this type.
13056 This allows the use of formatted references.
13059 \begin_layout Description
13060 \begin_inset Flex CharStyle:Code
13063 \begin_layout Plain Layout
13070 \begin_inset Flex CharStyle:Code
13073 \begin_layout Plain Layout
13080 \begin_inset Quotes erd
13084 \begin_inset Quotes erd
13087 ] The style used when defining the float using
13088 \begin_inset Flex CharStyle:Code
13091 \begin_layout Plain Layout
13102 \begin_layout Description
13103 \begin_inset Flex CharStyle:Code
13106 \begin_layout Plain Layout
13113 \begin_inset Flex CharStyle:Code
13116 \begin_layout Plain Layout
13123 \begin_inset Quotes erd
13127 \begin_inset Quotes erd
13131 \begin_inset Quotes eld
13135 \begin_inset Quotes erd
13138 of the new class of floats, like program or algorithm.
13139 After the appropriate
13140 \begin_inset Flex CharStyle:Code
13143 \begin_layout Plain Layout
13152 \begin_inset Flex CharStyle:Code
13155 \begin_layout Plain Layout
13164 \begin_inset Flex CharStyle:Code
13167 \begin_layout Plain Layout
13178 \begin_layout Standard
13179 Note that defining a float with type
13180 \begin_inset Flex CharStyle:Code
13183 \begin_layout Plain Layout
13191 automatically defines the corresponding counter with name
13192 \begin_inset Flex CharStyle:Code
13195 \begin_layout Plain Layout
13206 \begin_layout Subsection
13207 Flex insets and InsetLayout
13208 \begin_inset CommandInset label
13210 name "sub:Flex-insets-and"
13217 \begin_layout Standard
13218 LyX has supported character styles since version 1.4.0; as of version 1.6.0,
13219 these are called Flex insets.
13223 \begin_layout Standard
13224 Flex insets come in three different kinds:
13227 \begin_layout Itemize
13229 \begin_inset Flex CharStyle:Code
13232 \begin_layout Plain Layout
13238 ): These define semantic markup corresponding to such LaTeX commands as
13240 \begin_inset Flex CharStyle:Code
13243 \begin_layout Plain Layout
13252 \begin_inset Flex CharStyle:Code
13255 \begin_layout Plain Layout
13266 \begin_layout Itemize
13268 \begin_inset Flex CharStyle:Code
13271 \begin_layout Plain Layout
13277 ): These can be used to define custom collapsible insets, similar to TeX
13278 code, footnote, and the like.
13279 An obvious example is an endnote inset, which is defined in the
13280 \begin_inset Flex CharStyle:Code
13283 \begin_layout Plain Layout
13292 \begin_layout Itemize
13294 \begin_inset Flex CharStyle:Code
13297 \begin_layout Plain Layout
13303 ): For use with DocBook classes.
13306 \begin_layout Standard
13307 Flex insets are defined using the
13308 \begin_inset Flex CharStyle:Code
13311 \begin_layout Plain Layout
13317 tag, which shall be explained in a moment.
13320 \begin_layout Standard
13322 \begin_inset Flex CharStyle:Code
13325 \begin_layout Plain Layout
13331 tag also serves another function: It can be used to customize the general
13332 layout of many different types of insets.
13334 \begin_inset Flex CharStyle:Code
13337 \begin_layout Plain Layout
13343 can be used to customize the layout parameters for footnotes, marginal
13344 notes, note insets, TeX code (ERT) insets, branches, listings, indexes,
13345 boxes, tables, algorithms, URLs, and optional arguments, as well as to
13346 define Flex insets.
13349 \begin_layout Standard
13351 \begin_inset Flex CharStyle:Code
13354 \begin_layout Plain Layout
13360 definition must begin with a line of the form:
13363 \begin_layout LyX-Code
13367 \begin_layout Standard
13369 \begin_inset Flex CharStyle:Code
13372 \begin_layout Plain Layout
13378 indicates the inset whose layout is being defined, and here there are two
13382 \begin_layout Enumerate
13383 The layout for a pre-existing inset is being modified.
13384 In this case, can be
13385 \begin_inset Flex CharStyle:Code
13388 \begin_layout Plain Layout
13394 any one of the following:
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
13525 \begin_inset Flex CharStyle:Code
13528 \begin_layout Plain Layout
13535 \begin_inset Flex CharStyle:Code
13538 \begin_layout Plain Layout
13545 \begin_inset Flex CharStyle:Code
13548 \begin_layout Plain Layout
13555 \begin_inset Flex CharStyle:Code
13558 \begin_layout Plain Layout
13565 \begin_inset Flex CharStyle:Code
13568 \begin_layout Plain Layout
13575 \begin_inset Flex CharStyle:Code
13578 \begin_layout Plain Layout
13585 \begin_inset Flex CharStyle:Code
13588 \begin_layout Plain Layout
13597 \begin_layout Enumerate
13598 The layout for a Flex inset is being defined.
13600 \begin_inset Flex CharStyle:Code
13603 \begin_layout Plain Layout
13609 can be any valid identifier not used by a pre-existing inset.
13610 Note that the definition of a flex inset
13615 \begin_inset Flex CharStyle:Code
13618 \begin_layout Plain Layout
13624 entry, declaring which type of inset this is.
13627 \begin_layout Standard
13629 \begin_inset Flex CharStyle:Code
13632 \begin_layout Plain Layout
13638 definition can contain the following entries:
13641 \begin_layout Description
13642 \begin_inset Flex CharStyle:Code
13645 \begin_layout Plain Layout
13651 The color for the inset's background.
13652 The valid colors are defined in
13653 \begin_inset Flex CharStyle:Code
13656 \begin_layout Plain Layout
13665 \begin_layout Description
13666 \begin_inset Flex CharStyle:Code
13669 \begin_layout Plain Layout
13676 \begin_inset Flex CharStyle:Code
13679 \begin_layout Plain Layout
13688 \begin_inset Flex CharStyle:Code
13691 \begin_layout Plain Layout
13697 ] Whether to use the content of the inset as the label, when the inset is
13702 \begin_layout Description
13703 \begin_inset Flex CharStyle:Code
13706 \begin_layout Plain Layout
13712 As with paragraph styles (see page
13713 \begin_inset CommandInset ref
13715 reference "des:CopyStyle"
13722 \begin_layout Description
13723 \begin_inset Flex CharStyle:Code
13726 \begin_layout Plain Layout
13733 \begin_inset Flex CharStyle:Code
13736 \begin_layout Plain Layout
13745 \begin_inset Flex CharStyle:Code
13748 \begin_layout Plain Layout
13754 ] Indicates whether the user may employ the Paragraph Settings dialog to
13755 customize the paragraph.
13758 \begin_layout Description
13759 \begin_inset Flex CharStyle:Code
13762 \begin_layout Plain Layout
13769 \begin_inset Flex CharStyle:Code
13772 \begin_layout Plain Layout
13779 \begin_inset Flex CharStyle:Code
13782 \begin_layout Plain Layout
13789 \begin_inset Flex CharStyle:Code
13792 \begin_layout Plain Layout
13798 , describing the rendering style used for the inset's frame and buttons.
13799 Footnotes generally use
13800 \begin_inset Flex CharStyle:Code
13803 \begin_layout Plain Layout
13809 , ERT insets generally
13810 \begin_inset Flex CharStyle:Code
13813 \begin_layout Plain Layout
13819 , and character styles
13820 \begin_inset Flex CharStyle:Code
13823 \begin_layout Plain Layout
13832 \begin_layout Description
13833 \begin_inset Flex CharStyle:Code
13836 \begin_layout Plain Layout
13842 Required at the end of the InsetLayout declarations.
13845 \begin_layout Description
13846 \begin_inset Flex CharStyle:Code
13849 \begin_layout Plain Layout
13855 The font used for both the text body
13861 \begin_inset space ~
13865 \begin_inset CommandInset ref
13867 reference "sub:Font-description"
13872 Note that defining this font automatically defines the
13873 \begin_inset Flex CharStyle:Code
13876 \begin_layout Plain Layout
13882 to the same value, so define this first and define
13883 \begin_inset Flex CharStyle:Code
13886 \begin_layout Plain Layout
13892 later if you want them to be different.
13895 \begin_layout Description
13896 \begin_inset Flex CharStyle:Code
13899 \begin_layout Plain Layout
13906 \begin_inset Quotes eld
13910 \begin_inset Quotes erd
13913 language, leading to Left-to-Right (latin) output, e.
13914 \begin_inset space \thinspace{}
13918 \begin_inset space \space{}
13921 in TeX code or URL.
13925 \begin_layout Description
13926 \begin_inset Flex CharStyle:Code
13929 \begin_layout Plain Layout
13936 \begin_inset Flex CharStyle:Code
13939 \begin_layout Plain Layout
13948 \begin_inset Flex CharStyle:Code
13951 \begin_layout Plain Layout
13957 ] Indicates whether the PlainLayout should be used or, instead, the user
13958 can change the paragraph style used in the inset.
13962 \begin_layout Description
13963 \begin_inset Flex CharStyle:Code
13966 \begin_layout Plain Layout
13972 As with paragraph styles (see page
13973 \begin_inset CommandInset ref
13974 LatexCommand pageref
13975 reference "des:FreeSpacing"
13983 \begin_layout Description
13984 \begin_inset Flex CharStyle:Code
13987 \begin_layout Plain Layout
13993 These tags control XHTML output.
13997 \begin_layout Description
13998 \begin_inset Flex CharStyle:Code
14001 \begin_layout Plain Layout
14008 \begin_inset Flex CharStyle:Code
14011 \begin_layout Plain Layout
14020 \begin_inset Flex CharStyle:Code
14023 \begin_layout Plain Layout
14029 ] Whether to include the contents of this inset in the strings generated
14030 for the `Outline' pane.
14031 One would not, for example, want the content of a footnote in a section
14032 header to be included in the TOC displayed in the outline, but one would
14033 normally want the content of a character style displayed.
14034 Default is false: not to include.
14037 \begin_layout Description
14038 \begin_inset Flex CharStyle:Code
14041 \begin_layout Plain Layout
14047 As with paragraph styles (see page
14048 \begin_inset CommandInset ref
14049 LatexCommand pageref
14050 reference "des:KeepEmpty"
14058 \begin_layout Description
14059 \begin_inset Flex CharStyle:Code
14062 \begin_layout Plain Layout
14068 The font used for the label.
14070 \begin_inset space ~
14074 \begin_inset CommandInset ref
14076 reference "sub:Font-description"
14081 Note that this definition can never appear before
14082 \begin_inset Flex CharStyle:Code
14085 \begin_layout Plain Layout
14091 , lest it be ineffective.
14094 \begin_layout Description
14095 \begin_inset Flex CharStyle:Code
14098 \begin_layout Plain Layout
14104 What will be displayed on the button or elsewhere as the inset label.
14105 Some inset types (TeX code and Branch) modify this label on the fly.
14108 \begin_layout Description
14109 \begin_inset Flex CharStyle:Code
14112 \begin_layout Plain Layout
14118 The name of the corresponding LaTeX stuff.
14119 Either the environment or command name.
14122 \begin_layout Description
14123 \begin_inset Flex CharStyle:Code
14126 \begin_layout Plain Layout
14132 The optional parameter for the corresponding
14133 \begin_inset Flex CharStyle:Code
14136 \begin_layout Plain Layout
14142 stuff, including possible bracket pairs like
14143 \begin_inset Flex CharStyle:Code
14146 \begin_layout Plain Layout
14153 This parameter cannot be changed from within LyX.
14156 \begin_layout Description
14157 \begin_inset Flex CharStyle:Code
14160 \begin_layout Plain Layout
14166 As with paragraph styles (see page
14167 \begin_inset CommandInset ref
14168 LatexCommand pageref
14169 reference "des:LatexType"
14176 \begin_layout Description
14177 \begin_inset Flex CharStyle:Code
14180 \begin_layout Plain Layout
14187 \begin_inset Flex CharStyle:Code
14190 \begin_layout Plain Layout
14197 \begin_inset Flex CharStyle:Code
14200 \begin_layout Plain Layout
14207 \begin_inset Flex CharStyle:Code
14210 \begin_layout Plain Layout
14217 \begin_inset Flex CharStyle:Code
14220 \begin_layout Plain Layout
14226 (indicating a dummy definition ending definitions of charstyles, etc).
14227 This entry is required in and is only meaningful for Flex insets.
14228 Among other things, it determines on which menu this inset will appear.
14230 \begin_inset Flex CharStyle:Code
14233 \begin_layout Plain Layout
14240 \begin_inset Flex CharStyle:Code
14243 \begin_layout Plain Layout
14250 \begin_inset Flex CharStyle:Code
14253 \begin_layout Plain Layout
14261 \begin_inset Flex CharStyle:Code
14264 \begin_layout Plain Layout
14270 can be set to true for charstyle insets, if you wish, by setting it
14275 \begin_inset Flex CharStyle:Code
14278 \begin_layout Plain Layout
14287 \begin_layout Description
14288 \begin_inset Flex CharStyle:Code
14291 \begin_layout Plain Layout
14298 \begin_inset Flex CharStyle:Code
14301 \begin_layout Plain Layout
14310 \begin_inset Flex CharStyle:Code
14313 \begin_layout Plain Layout
14319 ] Whether multiple paragraphs are permitted in this inset.
14321 \begin_inset Flex CharStyle:Code
14324 \begin_layout Plain Layout
14330 to the same value and
14331 \begin_inset Flex CharStyle:Code
14334 \begin_layout Plain Layout
14340 to the opposite value.
14341 These can be reset to other values, if they are used
14346 \begin_inset Flex CharStyle:Code
14349 \begin_layout Plain Layout
14359 \begin_layout Description
14360 \begin_inset Flex CharStyle:Code
14363 \begin_layout Plain Layout
14370 \begin_inset Flex CharStyle:Code
14373 \begin_layout Plain Layout
14382 \begin_inset Flex CharStyle:Code
14385 \begin_layout Plain Layout
14391 ] Whether fragile commands in this layout should be
14392 \begin_inset Flex CharStyle:Code
14395 \begin_layout Plain Layout
14408 whether the command should itself be protected.) Default is false.
14411 \begin_layout Description
14412 \begin_inset Flex CharStyle:Code
14415 \begin_layout Plain Layout
14422 \begin_inset Flex CharStyle:Code
14425 \begin_layout Plain Layout
14434 \begin_inset Flex CharStyle:Code
14437 \begin_layout Plain Layout
14443 ] As with paragraph styles (see page
14444 \begin_inset CommandInset ref
14445 LatexCommand pageref
14446 reference "des:PathThru"
14454 \begin_layout Description
14455 \begin_inset Flex CharStyle:Code
14458 \begin_layout Plain Layout
14464 As with paragraph styles (see page
14465 \begin_inset CommandInset ref
14466 LatexCommand pageref
14467 reference "des:Preamble"
14474 \begin_layout Description
14475 \begin_inset Flex CharStyle:Code
14478 \begin_layout Plain Layout
14485 \begin_inset Flex CharStyle:Code
14488 \begin_layout Plain Layout
14494 ] The prefix to use when creating labels referring to insets of this type.
14495 This allows the use of formatted references.
14498 \begin_layout Description
14499 \begin_inset Flex CharStyle:Code
14502 \begin_layout Plain Layout
14509 \begin_inset Flex CharStyle:Code
14512 \begin_layout Plain Layout
14518 ] As with paragraph styles (see page
14519 \begin_inset CommandInset ref
14520 LatexCommand pageref
14521 reference "des:Requires"
14528 \begin_layout Description
14529 \begin_inset Flex CharStyle:Code
14532 \begin_layout Plain Layout
14539 \begin_inset Flex CharStyle:Code
14542 \begin_layout Plain Layout
14549 \begin_inset Flex CharStyle:Code
14552 \begin_layout Plain Layout
14560 ] Spellcheck the contents of this inset.
14564 \begin_layout Subsection
14566 \begin_inset CommandInset label
14568 name "sub:Counters"
14575 \begin_layout Standard
14576 Since version 1.3.0 of LyX, it is both possible and necessary to define the
14578 \begin_inset Flex CharStyle:MenuItem
14581 \begin_layout Plain Layout
14588 \begin_inset Flex CharStyle:MenuItem
14591 \begin_layout Plain Layout
14597 , \SpecialChar \ldots{}
14598 ) in the text class itself.
14599 The standard counters are defined in the file
14600 \begin_inset Flex CharStyle:Code
14603 \begin_layout Plain Layout
14609 , so you may have to do no more than add
14612 \begin_layout LyX-Code
14613 Input stdcounters.inc
14616 \begin_layout Standard
14617 to your layout file to get them to work.
14618 But if you want to define custom counters, then you can do so.
14619 The counter declaration must begin with:
14622 \begin_layout LyX-Code
14623 Counter CounterName
14626 \begin_layout Standard
14628 \begin_inset Flex CharStyle:Code
14631 \begin_layout Plain Layout
14637 ' is replaced by the name of the counter.
14638 And it must end with
14639 \begin_inset Quotes eld
14643 \begin_inset Flex CharStyle:Code
14646 \begin_layout Plain Layout
14653 \begin_inset Quotes erd
14657 The following parameters can also be used:
14660 \begin_layout Description
14661 \begin_inset Flex CharStyle:Code
14664 \begin_layout Plain Layout
14671 \begin_inset Flex CharStyle:Code
14674 \begin_layout Plain Layout
14681 \begin_inset Quotes erd
14685 \begin_inset Quotes erd
14688 ] When defined, this string defines how the counter is displayed.
14689 Setting this value sets
14690 \begin_inset Flex CharStyle:Code
14693 \begin_layout Plain Layout
14694 LabelStringAppendix
14700 The following special constructs can be used in the string:
14704 \begin_layout Itemize
14705 \begin_inset Flex CharStyle:Code
14708 \begin_layout Plain Layout
14716 will be replaced by the expansion of the
14717 \begin_inset Flex CharStyle:Code
14720 \begin_layout Plain Layout
14727 \begin_inset Flex CharStyle:Code
14730 \begin_layout Plain Layout
14731 LabelStringAppendix
14737 \begin_inset Flex CharStyle:Code
14740 \begin_layout Plain Layout
14750 \begin_layout Itemize
14751 counter values can be expressed using LaTeX-like macros
14752 \begin_inset Flex CharStyle:Code
14755 \begin_layout Plain Layout
14772 \begin_inset Flex CharStyle:Code
14775 \begin_layout Plain Layout
14787 \begin_layout Plain Layout
14797 Actually, the situation is a bit more complicated: any
14816 other than those described below will produce arabic numerals.
14817 It would not be surprising to see this change in the future.
14823 \begin_inset Flex CharStyle:Code
14826 \begin_layout Plain Layout
14832 : 1, 2, 3,\SpecialChar \ldots{}
14834 \begin_inset Flex CharStyle:Code
14837 \begin_layout Plain Layout
14843 for lower-case letters: a, b, c, \SpecialChar \ldots{}
14845 \begin_inset Flex CharStyle:Code
14848 \begin_layout Plain Layout
14854 for upper-case letters: A, B, C, \SpecialChar \ldots{}
14856 \begin_inset Flex CharStyle:Code
14859 \begin_layout Plain Layout
14865 for lower-case roman numerals: i, ii, iii, \SpecialChar \ldots{}
14867 \begin_inset Flex CharStyle:Code
14870 \begin_layout Plain Layout
14876 for upper-case roman numerals: I, II, III\SpecialChar \ldots{}
14878 \begin_inset Flex CharStyle:Code
14881 \begin_layout Plain Layout
14887 for hebrew numerals.
14891 \begin_layout Standard
14892 If LabelString is not defined, a default value is constructed as follows:
14893 if the counter has a master counter
14894 \begin_inset Flex CharStyle:Code
14897 \begin_layout Plain Layout
14904 \begin_inset Flex CharStyle:Code
14907 \begin_layout Plain Layout
14914 \begin_inset Flex CharStyle:Code
14917 \begin_layout Plain Layout
14927 is used; otherwise the string
14928 \begin_inset Flex CharStyle:Code
14931 \begin_layout Plain Layout
14942 \begin_layout Description
14943 \begin_inset Flex CharStyle:Code
14946 \begin_layout Plain Layout
14947 LabelStringAppendix
14953 \begin_inset Flex CharStyle:Code
14956 \begin_layout Plain Layout
14963 \begin_inset Quotes erd
14967 \begin_inset Quotes erd
14971 \begin_inset Flex CharStyle:Code
14974 \begin_layout Plain Layout
14980 , but for use in the Appendix.
14983 \begin_layout Description
14984 \begin_inset Flex CharStyle:Code
14987 \begin_layout Plain Layout
14994 \begin_inset Flex CharStyle:Code
14997 \begin_layout Plain Layout
15004 \begin_inset Quotes erd
15008 \begin_inset Quotes erd
15011 ] A format for use with formatted references to this counter.
15012 For example, one might want to have references to section numbers appear
15014 \begin_inset Quotes eld
15018 \begin_inset Quotes erd
15022 The string should contain
15023 \begin_inset Quotes eld
15027 \begin_inset Quotes erd
15031 This will be replaced by the counter number itself.
15032 So, for sections, it would be: Section ##.
15035 \begin_layout Description
15036 \begin_inset Flex CharStyle:Code
15039 \begin_layout Plain Layout
15046 \begin_inset Flex CharStyle:Code
15049 \begin_layout Plain Layout
15056 \begin_inset Quotes erd
15060 \begin_inset Quotes erd
15063 ] If this is set to the name of another counter, the present counter will
15064 be reset every time the other one is increased.
15066 \begin_inset Flex CharStyle:Code
15069 \begin_layout Plain Layout
15076 \begin_inset Flex CharStyle:Code
15079 \begin_layout Plain Layout
15088 \begin_layout Subsection
15090 \begin_inset CommandInset label
15092 name "sub:Font-description"
15099 \begin_layout Standard
15100 A font description looks like this:
15103 \begin_layout LyX-Code
15113 \begin_layout LyX-Code
15117 \begin_layout LyX-Code
15121 \begin_layout Standard
15122 The following commands are available:
15125 \begin_layout Description
15126 \begin_inset Flex CharStyle:Code
15129 \begin_layout Plain Layout
15136 \begin_inset Flex CharStyle:Code
15139 \begin_layout Plain Layout
15148 \begin_inset Flex CharStyle:Code
15151 \begin_layout Plain Layout
15158 \begin_inset Flex CharStyle:Code
15161 \begin_layout Plain Layout
15168 \begin_inset Flex CharStyle:Code
15171 \begin_layout Plain Layout
15178 \begin_inset Flex CharStyle:Code
15181 \begin_layout Plain Layout
15188 \begin_inset Flex CharStyle:Code
15191 \begin_layout Plain Layout
15198 \begin_inset Flex CharStyle:Code
15201 \begin_layout Plain Layout
15208 \begin_inset Flex CharStyle:Code
15211 \begin_layout Plain Layout
15218 \begin_inset Flex CharStyle:Code
15221 \begin_layout Plain Layout
15230 \begin_layout Description
15231 \begin_inset Flex CharStyle:Code
15234 \begin_layout Plain Layout
15241 \begin_inset Flex CharStyle:Code
15244 \begin_layout Plain Layout
15253 \begin_inset Flex CharStyle:Code
15256 \begin_layout Plain Layout
15263 \begin_inset Flex CharStyle:Code
15266 \begin_layout Plain Layout
15275 \begin_layout Description
15276 \begin_inset Flex CharStyle:Code
15279 \begin_layout Plain Layout
15286 \begin_inset Flex CharStyle:Code
15289 \begin_layout Plain Layout
15295 ] Valid arguments are:
15296 \begin_inset Flex CharStyle:Code
15299 \begin_layout Plain Layout
15306 \begin_inset Flex CharStyle:Code
15309 \begin_layout Plain Layout
15316 \begin_inset Flex CharStyle:Code
15319 \begin_layout Plain Layout
15326 \begin_inset Flex CharStyle:Code
15329 \begin_layout Plain Layout
15336 \begin_inset Flex CharStyle:Code
15339 \begin_layout Plain Layout
15346 \begin_inset Flex CharStyle:Code
15349 \begin_layout Plain Layout
15356 Each of these turns on or off the corresponding attribute.
15358 \begin_inset Flex CharStyle:Code
15361 \begin_layout Plain Layout
15367 turns on emphasis, and
15368 \begin_inset Flex CharStyle:Code
15371 \begin_layout Plain Layout
15379 \begin_inset Newline newline
15382 If the latter seems puzzling, remember that the font settings for the present
15383 context are generally inherited from the surrounding context.
15385 \begin_inset Flex CharStyle:Code
15388 \begin_layout Plain Layout
15394 would turn off the emphasis that was anyway in effect, say, in a theorem
15398 \begin_layout Description
15399 \begin_inset Flex CharStyle:Code
15402 \begin_layout Plain Layout
15409 \begin_inset Flex CharStyle:Code
15412 \begin_layout Plain Layout
15421 \begin_inset Flex CharStyle:Code
15424 \begin_layout Plain Layout
15433 \begin_layout Description
15434 \begin_inset Flex CharStyle:Code
15437 \begin_layout Plain Layout
15444 \begin_inset Flex CharStyle:Code
15447 \begin_layout Plain Layout
15456 \begin_inset Flex CharStyle:Code
15459 \begin_layout Plain Layout
15466 \begin_inset Flex CharStyle:Code
15469 \begin_layout Plain Layout
15476 \begin_inset Flex CharStyle:Code
15479 \begin_layout Plain Layout
15488 \begin_layout Description
15489 \begin_inset Flex CharStyle:Code
15492 \begin_layout Plain Layout
15499 \begin_inset Flex CharStyle:Code
15502 \begin_layout Plain Layout
15509 \begin_inset Flex CharStyle:Code
15512 \begin_layout Plain Layout
15519 \begin_inset Flex CharStyle:Code
15522 \begin_layout Plain Layout
15531 \begin_inset Flex CharStyle:Code
15534 \begin_layout Plain Layout
15541 \begin_inset Flex CharStyle:Code
15544 \begin_layout Plain Layout
15551 \begin_inset Flex CharStyle:Code
15554 \begin_layout Plain Layout
15561 \begin_inset Flex CharStyle:Code
15564 \begin_layout Plain Layout
15571 \begin_inset Flex CharStyle:Code
15574 \begin_layout Plain Layout
15583 \begin_layout Subsection
15584 \begin_inset CommandInset label
15586 name "sub:Citation-format-description"
15590 Citation format description
15593 \begin_layout Standard
15595 \begin_inset Flex CharStyle:Code
15598 \begin_layout Plain Layout
15604 blocks are used to describe how bibliographic information should be displayed,
15605 both within LyX itself (in the citation dialog and in tooltips, for example)
15606 and in XHTML output.
15607 Such a block might look like this:
15610 \begin_layout LyX-Code
15614 \begin_layout LyX-Code
15618 \begin_layout LyX-Code
15622 \begin_layout LyX-Code
15626 \begin_layout Standard
15627 The individual lines define how the bibliographic information associated
15628 with an article or book, respectively, is to be displayed, and such a definitio
15629 n can be given for any `entry type' that might be present in a BibTeX file.
15630 LyX defines a default format in the source code that will be used if no
15631 specific definition has been given.
15632 LyX predefines several formats in the file
15633 \begin_inset Flex CharStyle:Code
15636 \begin_layout Plain Layout
15642 , which is included in most of LyX's document classes.
15645 \begin_layout Standard
15646 The definitions use a simple language that allows BibTeX keys to be replaced
15648 Keys should be enclosed in % signs, e.g.:
15649 \begin_inset Flex CharStyle:Code
15652 \begin_layout Plain Layout
15659 So a simple definition might look like this:
15662 \begin_layout LyX-Code
15664 \begin_inset Quotes eld
15668 \begin_inset Quotes erd
15674 \begin_layout Standard
15675 This would print the author, followed by a comma, followed by the title,
15676 in quotes, followed by a period.
15679 \begin_layout Standard
15680 Of course, sometimes you may want to print a key only if it exists.
15681 This can be done by using a conditional construction, such as:
15682 \begin_inset Flex CharStyle:Code
15685 \begin_layout Plain Layout
15687 \begin_inset space ~
15697 \begin_inset Flex CharStyle:Code
15700 \begin_layout Plain Layout
15706 key exists, then print
15707 \begin_inset Quotes eld
15711 \begin_inset space ~
15715 \begin_inset Quotes erd
15718 followed by the volume key.
15719 It is also possible to have an else clause in the conditional, such as:
15721 \begin_inset Flex CharStyle:Code
15724 \begin_layout Plain Layout
15725 {%author%[[%author%]][[%editor%, ed.]]}
15732 \begin_inset Flex CharStyle:Code
15735 \begin_layout Plain Layout
15741 key is printed if it exists; otherwise, the editor key is printed, followed
15743 \begin_inset Quotes eld
15747 \begin_inset space ~
15751 \begin_inset Quotes erd
15754 Note that the key is again enclosed in % signs; the entire conditional
15755 is enclosed in braces; and the if and else clauses are enclosed in double
15757 \begin_inset Quotes eld
15761 \begin_inset Quotes eld
15765 \begin_inset Quotes eld
15769 \begin_inset Quotes erd
15773 There must be no space between any of these.
15776 \begin_layout Standard
15777 There is one other piece of syntax available in definitions, which looks
15779 \begin_inset Flex CharStyle:Code
15782 \begin_layout Plain Layout
15789 This defines a piece of formatting information that is to be used when
15791 \begin_inset Quotes eld
15795 \begin_inset Quotes erd
15799 Obviously, we do not want to output HTML tags when writing plain text,
15800 so they should be wrapped in
15801 \begin_inset Quotes eld
15805 \begin_inset Quotes erd
15809 \begin_inset Quotes eld
15813 \begin_inset Quotes erd
15819 \begin_layout Standard
15820 Two special sorts of definitions are also possible in a
15821 \begin_inset Flex CharStyle:Code
15824 \begin_layout Plain Layout
15831 An example of the first would be:
15834 \begin_layout LyX-Code
15836 \begin_inset Quotes eld
15840 \begin_inset Quotes erd
15846 \begin_layout Standard
15847 This is an abbreviation, or macro, and it can be used by treating it as
15849 \begin_inset Flex CharStyle:Code
15852 \begin_layout Plain Layout
15860 \begin_inset Flex CharStyle:Code
15863 \begin_layout Plain Layout
15869 exactly as it would treat its definition.
15870 So, let us issue the obvious
15878 \begin_layout LyX-Code
15882 \begin_layout Standard
15883 or anything like it.
15884 LyX shouldn't go into an infinite loop, but it may go into a long one before
15888 \begin_layout Standard
15889 The second sort of special definition might look like this:
15892 \begin_layout LyX-Code
15896 \begin_layout Standard
15897 This defines a translatable piece of text, which allows relevant parts of
15898 the bibliography to be translated.
15899 It can be included in a definition by treating it as a key:
15900 \begin_inset Flex CharStyle:Code
15903 \begin_layout Plain Layout
15910 Several of these are predefined in
15911 \begin_inset Flex CharStyle:Code
15914 \begin_layout Plain Layout
15921 Note that these are not macros, in the sense just defined.
15922 They will not be expanded.
15925 \begin_layout Standard
15926 So here then is an example that use all these features:
15929 \begin_layout LyX-Code
15930 !authoredit {%author%[[%author%, ]][[{%editor%[[%editor%, %_edtext%, ]]}]]}
15933 \begin_layout Standard
15934 The defines a macro that prints the author, followed by a comma, if the
15936 \begin_inset Flex CharStyle:Code
15939 \begin_layout Plain Layout
15945 key is defined, or else prints the name of the editor, followed by the
15947 \begin_inset Flex CharStyle:Code
15950 \begin_layout Plain Layout
15956 or its translation (it is by default
15957 \begin_inset Quotes eld
15961 \begin_inset Quotes erd
15965 \begin_inset Flex CharStyle:Code
15968 \begin_layout Plain Layout
15975 Note that this is in fact defined in
15976 \begin_inset Flex CharStyle:Code
15979 \begin_layout Plain Layout
15985 , so you can use it in your own definitions, or re-definitions, if you load
15989 \begin_layout Section
15990 \begin_inset CommandInset label
15992 name "sec:Tags-for-XHTML"
15996 Tags for XHTML output
15999 \begin_layout Standard
16000 As with LaTeX or DocBook, the format of LyX's XHTML output is also controlled
16001 by layout information.
16002 In general, LyX provides sensible defaults and, as mentioned earlier, it
16003 will even construct default CSS style rules from the other layout tags.
16004 For example, LyX will attempt to use the information provided in the
16005 \begin_inset Flex CharStyle:Code
16008 \begin_layout Plain Layout
16014 declaration for the Chapter style to write CSS that will appropriately
16015 format chapter headings.
16018 \begin_layout Standard
16019 In many cases, then, you may not have to do anything at all to get acceptable
16020 XHTML output for your own environments, custom insets, and so forth.
16021 But in some cases you will, and so LyX provides a number of layout tags
16022 that can be used to customize the XHTML and CSS that are generated.
16025 \begin_layout Standard
16026 Note that there are two tags,
16027 \begin_inset Flex CharStyle:Code
16030 \begin_layout Plain Layout
16037 \begin_inset Flex CharStyle:Code
16040 \begin_layout Plain Layout
16046 that may appear outside style and inset declarations.
16048 \begin_inset CommandInset ref
16049 LatexCommand prettyref
16050 reference "sub:General-text-class"
16054 for details on these.
16057 \begin_layout Subsection
16058 \begin_inset CommandInset label
16060 name "sub:Paragraph-Style-XHTML"
16067 \begin_layout Standard
16068 The sort of XHTML LyX outputs for a paragraph depends upon whether we are
16069 dealing with a normal paragraph, a command, or an environment, where this
16070 is itself determined by the contents of the corresponding
16071 \begin_inset Flex CharStyle:Code
16074 \begin_layout Plain Layout
16084 \begin_layout Standard
16085 For a command or normal paragraph, the output XHTML has the following form:
16088 \begin_layout LyX-Code
16090 \begin_inset Quotes erd
16094 \begin_inset Quotes erd
16100 \begin_layout LyX-Code
16102 \begin_inset Quotes erd
16106 \begin_inset Quotes erd
16112 \begin_layout LyX-Code
16113 Contents of the paragraph.
16116 \begin_layout LyX-Code
16120 \begin_layout Standard
16121 The label tags are of course omitted if the paragraph does not have a label.
16124 \begin_layout Standard
16125 For an environment that is not some sort of list, the XHTML takes this form:
16128 \begin_layout LyX-Code
16130 \begin_inset Quotes erd
16134 \begin_inset Quotes erd
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 >Environment Label</labeltag>First paragraph.</itemtag>
16160 \begin_layout LyX-Code
16161 <itemtag>Second paragraph.</itemtag>
16164 \begin_layout LyX-Code
16168 \begin_layout Standard
16169 Note that the label is output only for the first paragraph, as it should
16170 be for a theorem, for example.
16174 \begin_layout Standard
16175 For a list, we have one of these forms:
16178 \begin_layout LyX-Code
16180 \begin_inset Quotes erd
16184 \begin_inset Quotes erd
16190 \begin_layout LyX-Code
16192 \begin_inset Quotes erd
16196 \begin_inset Quotes erd
16200 \begin_inset Quotes erd
16204 \begin_inset Quotes erd
16207 >List Label</labeltag>First item.</itemtag>
16210 \begin_layout LyX-Code
16212 \begin_inset Quotes erd
16216 \begin_inset Quotes erd
16220 \begin_inset Quotes erd
16224 \begin_inset Quotes erd
16227 >List Label</labeltag>Second item.</itemtag>
16230 \begin_layout LyX-Code
16234 \begin_layout LyX-Code
16238 \begin_layout LyX-Code
16240 \begin_inset Quotes erd
16244 \begin_inset Quotes erd
16250 \begin_layout LyX-Code
16252 \begin_inset Quotes erd
16256 \begin_inset Quotes erd
16259 >List Label</labeltag><itemtag attr=
16260 \begin_inset Quotes erd
16264 \begin_inset Quotes erd
16267 >First item.</itemtag>
16270 \begin_layout LyX-Code
16272 \begin_inset Quotes erd
16276 \begin_inset Quotes erd
16279 >List Label</labeltag><itemtag attr=
16280 \begin_inset Quotes erd
16284 \begin_inset Quotes erd
16287 >Second item.</itemtag>
16290 \begin_layout LyX-Code
16294 \begin_layout Standard
16295 Note the different orders of
16296 \begin_inset Flex CharStyle:Code
16299 \begin_layout Plain Layout
16306 \begin_inset Flex CharStyle:Code
16309 \begin_layout Plain Layout
16316 Which order we get depends upon the setting of
16317 \begin_inset Flex CharStyle:Code
16320 \begin_layout Plain Layout
16327 \begin_inset Flex CharStyle:Code
16330 \begin_layout Plain Layout
16336 is false (the default), you get the first of these, with the label within
16337 the item; if true, you get the second, with the label outside the item.
16340 \begin_layout Standard
16341 The specific tags and attributes output for each paragraph type can be controlle
16342 d by means of the layout tags we are about to describe.
16343 As mentioned earlier, however, LyX uses sensible defaults for many of these,
16344 so you often may not need to do very much to get good XHTML output.
16345 Think of the available tags as there so you can tweak things to your liking.
16348 \begin_layout Description
16349 \begin_inset Flex CharStyle:Code
16352 \begin_layout Plain Layout
16359 \begin_inset Flex CharStyle:Code
16362 \begin_layout Plain Layout
16368 ] Specifies attribute information to be output with the main tag.
16370 \begin_inset Quotes eld
16374 \begin_inset Flex CharStyle:Code
16377 \begin_layout Plain Layout
16384 \begin_inset Quotes erd
16388 By default, LyX will output
16389 \begin_inset Quotes eld
16393 \begin_inset Flex CharStyle:Code
16396 \begin_layout Plain Layout
16403 \begin_inset Quotes erd
16407 \begin_inset Flex CharStyle:Code
16410 \begin_layout Plain Layout
16416 is the LyX name of the layout, made lowercase, for example: chapter.
16419 \begin_layout Description
16420 \begin_inset Flex CharStyle:Code
16423 \begin_layout Plain Layout
16430 \begin_inset Flex CharStyle:Code
16433 \begin_layout Plain Layout
16443 ] Whether to output the default CSS information LyX generates for this layout,
16444 even if additional information is explicitly provided via
16445 \begin_inset Flex CharStyle:Code
16448 \begin_layout Plain Layout
16456 \begin_inset Flex CharStyle:Code
16459 \begin_layout Plain Layout
16465 allows you to alter or augment the generated CSS, rather than to override
16468 \begin_inset Flex CharStyle:Code
16471 \begin_layout Plain Layout
16480 \begin_layout Description
16481 \begin_inset Flex CharStyle:Code
16484 \begin_layout Plain Layout
16491 \begin_inset Flex CharStyle:Code
16494 \begin_layout Plain Layout
16500 ] The tag to be used for individual paragraphs of environments, replacing
16502 \begin_inset Flex CharStyle:Code
16505 \begin_layout Plain Layout
16511 in the examples above.
16513 \begin_inset Flex CharStyle:Code
16516 \begin_layout Plain Layout
16525 \begin_layout Description
16526 \begin_inset Flex CharStyle:Code
16529 \begin_layout Plain Layout
16536 \begin_inset Flex CharStyle:Code
16539 \begin_layout Plain Layout
16545 ] Attributes for the item tag.
16547 \begin_inset Quotes eld
16551 \begin_inset Flex CharStyle:Code
16554 \begin_layout Plain Layout
16555 class=`layoutname_item'
16561 \begin_inset Quotes erd
16567 \begin_layout Description
16568 \begin_inset Flex CharStyle:Code
16571 \begin_layout Plain Layout
16578 \begin_inset Flex CharStyle:Code
16581 \begin_layout Plain Layout
16587 ] The tag to be used for paragraph and item labels, replacing
16588 \begin_inset Flex CharStyle:Code
16591 \begin_layout Plain Layout
16597 in the examples above.
16599 \begin_inset Flex CharStyle:Code
16602 \begin_layout Plain Layout
16611 \begin_layout Description
16612 \begin_inset Flex CharStyle:Code
16615 \begin_layout Plain Layout
16622 \begin_inset Flex CharStyle:Code
16625 \begin_layout Plain Layout
16631 ] Attributes for the label tag.
16633 \begin_inset Quotes eld
16637 \begin_inset Flex CharStyle:Code
16640 \begin_layout Plain Layout
16641 class=`layoutname_label'
16647 \begin_inset Quotes erd
16653 \begin_layout Description
16654 \begin_inset Flex CharStyle:Code
16657 \begin_layout Plain Layout
16664 \begin_inset Flex CharStyle:Code
16667 \begin_layout Plain Layout
16677 ] Meaningful only for list-like environments, this tag controls whether
16678 the label tag is output before or inside the item tag.
16679 This is used, for example, in the description environment, where we want
16681 \begin_inset Flex CharStyle:Code
16684 \begin_layout Plain Layout
16685 <dt>\SpecialChar \ldots{}
16686 </dt><dd>\SpecialChar \ldots{}
16694 \begin_inset Flex CharStyle:Code
16697 \begin_layout Plain Layout
16703 : The label tag is output inside the item tag.
16706 \begin_layout Description
16707 \begin_inset Flex CharStyle:Code
16710 \begin_layout Plain Layout
16716 Information to be output in the
16717 \begin_inset Flex CharStyle:Code
16720 \begin_layout Plain Layout
16726 section when this style is used.
16727 This might, for example, be used to include a
16728 \begin_inset Flex CharStyle:Code
16731 \begin_layout Plain Layout
16738 \begin_inset Flex CharStyle:Code
16741 \begin_layout Plain Layout
16750 \begin_layout Description
16751 \begin_inset Flex CharStyle:Code
16754 \begin_layout Plain Layout
16760 CSS style information to be included when this style is used.
16761 Note that this will automatically be wrapped in a layout-generated
16762 \begin_inset Flex CharStyle:Code
16765 \begin_layout Plain Layout
16771 block, so only the CSS itself need be included.
16774 \begin_layout Description
16775 \begin_inset Flex CharStyle:Code
16778 \begin_layout Plain Layout
16785 \begin_inset Flex CharStyle:Code
16788 \begin_layout Plain Layout
16794 ] The tag to be used for the main label, replacing
16795 \begin_inset Flex CharStyle:Code
16798 \begin_layout Plain Layout
16804 in the examples above.
16806 \begin_inset Flex CharStyle:Code
16809 \begin_layout Plain Layout
16818 \begin_layout Description
16819 \begin_inset Flex CharStyle:Code
16822 \begin_layout Plain Layout
16829 \begin_inset Flex CharStyle:Code
16832 \begin_layout Plain Layout
16842 ] Marks this style as the one to be used to generate the
16843 \begin_inset Flex CharStyle:Code
16846 \begin_layout Plain Layout
16852 tag for the XHTML file.
16853 By default, it is false.
16855 \begin_inset Flex CharStyle:Code
16858 \begin_layout Plain Layout
16864 file sets it to true for the
16865 \begin_inset Flex CharStyle:Code
16868 \begin_layout Plain Layout
16878 \begin_layout Subsection
16882 \begin_layout Standard
16883 The XHTML output of insets can also be controlled by information in layout
16888 \begin_layout Plain Layout
16889 At present, this is true only for
16890 \begin_inset Quotes eld
16894 \begin_inset Quotes erd
16897 insets (insets you can type into) and is not true for
16898 \begin_inset Quotes eld
16902 \begin_inset Quotes erd
16905 insets (insets that are associated with dialog boxes).
16910 Here, too, LyX tries to provide sensible defaults, and it constructs default
16912 But everything can be customized.
16915 \begin_layout Standard
16916 The XHTML LyX outputs for an inset has the following form:
16919 \begin_layout LyX-Code
16921 \begin_inset Quotes erd
16925 \begin_inset Quotes erd
16931 \begin_layout LyX-Code
16932 <labeltag>Label</labeltag>
16935 \begin_layout LyX-Code
16937 \begin_inset Quotes erd
16941 \begin_inset Quotes erd
16944 >Contents of the inset.</innertag>
16947 \begin_layout LyX-Code
16951 \begin_layout Standard
16952 If the inset permits multiple paragraphs---that is, if
16953 \begin_inset Flex CharStyle:Code
16956 \begin_layout Plain Layout
16962 is true---then the contents of the inset will itself be output as paragraphs
16963 formatted according to the styles used for those paragraphs (standard,
16964 quote, and the like).
16965 The label tag is of course omitted if the paragraph does not have a label
16966 and, at present, is always
16967 \begin_inset Flex CharStyle:Code
16970 \begin_layout Plain Layout
16977 The inner tag is optional and, by default, does not appear.
16980 \begin_layout Standard
16981 The specific tags and attributes output for each inset can be controlled
16982 by means of the following layout tags.
16985 \begin_layout Description
16986 \begin_inset Flex CharStyle:Code
16989 \begin_layout Plain Layout
16996 \begin_inset Flex CharStyle:Code
16999 \begin_layout Plain Layout
17005 ] Specifies attribute information to be output with the main tag.
17007 \begin_inset Quotes eld
17011 \begin_inset Flex CharStyle:Code
17014 \begin_layout Plain Layout
17015 class=`myinset' onclick=`\SpecialChar \ldots{}
17022 \begin_inset Quotes erd
17026 By default, LyX will output
17027 \begin_inset Quotes eld
17031 \begin_inset Flex CharStyle:Code
17034 \begin_layout Plain Layout
17041 \begin_inset Quotes erd
17045 \begin_inset Flex CharStyle:Code
17048 \begin_layout Plain Layout
17054 is the LyX name of the inset, made lowercase and with non-alphanumeric
17055 characters converted to underscores, for example: footnote.
17058 \begin_layout Description
17059 \begin_inset Flex CharStyle:Code
17062 \begin_layout Plain Layout
17069 \begin_inset Flex CharStyle:Code
17072 \begin_layout Plain Layout
17082 ] Whether to output the default CSS information LyX generates for this layout,
17083 even if additional information is explicitly provided via
17084 \begin_inset Flex CharStyle:Code
17087 \begin_layout Plain Layout
17095 \begin_inset Flex CharStyle:Code
17098 \begin_layout Plain Layout
17104 allows you to alter or augment the generated CSS, rather than to override
17109 \begin_layout Description
17110 \begin_inset Flex CharStyle:Code
17113 \begin_layout Plain Layout
17120 \begin_inset Flex CharStyle:Code
17123 \begin_layout Plain Layout
17129 ] Attributes for the inner tag.
17131 \begin_inset Quotes eld
17135 \begin_inset Flex CharStyle:Code
17138 \begin_layout Plain Layout
17139 class=`insetname_inner'
17145 \begin_inset Quotes erd
17151 \begin_layout Description
17152 \begin_inset Flex CharStyle:Code
17155 \begin_layout Plain Layout
17162 \begin_inset Flex CharStyle:Code
17165 \begin_layout Plain Layout
17171 ] The inner tag, replacing
17172 \begin_inset Flex CharStyle:Code
17175 \begin_layout Plain Layout
17181 in the examples above.
17182 By default, there is none.
17185 \begin_layout Description
17186 \begin_inset Flex CharStyle:Code
17189 \begin_layout Plain Layout
17196 \begin_inset Flex CharStyle:Code
17199 \begin_layout Plain Layout
17207 ] Whether this inset represents a standalone block of text (such as a footnote)
17208 or instead represents material that is included in the surrounding text
17209 (such as a branch).
17213 \begin_layout Description
17214 \begin_inset Flex CharStyle:Code
17217 \begin_layout Plain Layout
17224 \begin_inset Flex CharStyle:Code
17227 \begin_layout Plain Layout
17233 ] A label for this inset, possibly including a reference to a counter.
17234 For example, for footnote, it might be:
17235 \begin_inset Flex CharStyle:Code
17238 \begin_layout Plain Layout
17247 This is optional, and there is no default.
17250 \begin_layout Description
17251 \begin_inset Flex CharStyle:Code
17254 \begin_layout Plain Layout
17260 Information to be output in the
17261 \begin_inset Flex CharStyle:Code
17264 \begin_layout Plain Layout
17270 section when this style is used.
17271 This might, for example, be used to include a
17272 \begin_inset Flex CharStyle:Code
17275 \begin_layout Plain Layout
17282 \begin_inset Flex CharStyle:Code
17285 \begin_layout Plain Layout
17294 \begin_layout Description
17295 \begin_inset Flex CharStyle:Code
17298 \begin_layout Plain Layout
17304 CSS style information to be included when this style is used.
17305 Note that this will automatically be wrapped in a layout-generated
17306 \begin_inset Flex CharStyle:Code
17309 \begin_layout Plain Layout
17315 block, so only the CSS itself need be included.
17318 \begin_layout Description
17319 \begin_inset Flex CharStyle:Code
17322 \begin_layout Plain Layout
17329 \begin_inset Flex CharStyle:Code
17332 \begin_layout Plain Layout
17338 ] The tag to be used for the main label, replacing
17339 \begin_inset Flex CharStyle:Code
17342 \begin_layout Plain Layout
17348 in the examples above.
17349 The default depends upon the setting of
17350 \begin_inset Flex CharStyle:Code
17353 \begin_layout Plain Layout
17360 \begin_inset Flex CharStyle:Code
17363 \begin_layout Plain Layout
17369 is true, the default is
17370 \begin_inset Flex CharStyle:Code
17373 \begin_layout Plain Layout
17379 ; if it is false, the default is
17380 \begin_inset Flex CharStyle:Code
17383 \begin_layout Plain Layout
17392 \begin_layout Subsection
17396 \begin_layout Standard
17397 The XHTML output for floats too can be controlled by layout information.
17398 The output has the following form:
17401 \begin_layout LyX-Code
17403 \begin_inset Quotes erd
17407 \begin_inset Quotes erd
17413 \begin_layout LyX-Code
17414 Contents of the float.
17417 \begin_layout LyX-Code
17421 \begin_layout Standard
17422 The caption, if there is one, is a separate inset and will be output as
17424 Its appearance can be controlled via the InsetLayout for caption insets.
17428 \begin_layout Description
17429 \begin_inset Flex CharStyle:Code
17432 \begin_layout Plain Layout
17439 \begin_inset Flex CharStyle:Code
17442 \begin_layout Plain Layout
17448 ] Specifies attribute information to be output with the main tag.
17450 \begin_inset Quotes eld
17454 \begin_inset Flex CharStyle:Code
17457 \begin_layout Plain Layout
17458 class=`myfloat' onclick=`\SpecialChar \ldots{}
17465 \begin_inset Quotes erd
17469 By default, LyX will output
17470 \begin_inset Quotes eld
17474 \begin_inset Flex CharStyle:Code
17477 \begin_layout Plain Layout
17478 class=`float float-floattype'
17484 \begin_inset Quotes erd
17488 \begin_inset Flex CharStyle:Code
17491 \begin_layout Plain Layout
17497 is LyX's name for this type of float, as determined by the float delcaration
17499 \begin_inset CommandInset ref
17501 reference "sub:Floats"
17505 ), though made lowercase and with non-alphanumeric characters converted
17506 to underscores, for example: float-table.
17509 \begin_layout Description
17510 \begin_inset Flex CharStyle:Code
17513 \begin_layout Plain Layout
17519 CSS style information to be included when this float is used.
17520 Note that this will automatically be wrapped in a layout-generated
17521 \begin_inset Flex CharStyle:Code
17524 \begin_layout Plain Layout
17530 block, so only the CSS itself need be included.
17533 \begin_layout Description
17534 \begin_inset Flex CharStyle:Code
17537 \begin_layout Plain Layout
17544 \begin_inset Flex CharStyle:Code
17547 \begin_layout Plain Layout
17553 ] The tag to be used for this float, replacing
17554 \begin_inset Quotes eld
17558 \begin_inset Flex CharStyle:Code
17561 \begin_layout Plain Layout
17568 \begin_inset Quotes erd
17571 in the example above.
17573 \begin_inset Flex CharStyle:Code
17576 \begin_layout Plain Layout
17582 and will rarely need changing.
17585 \begin_layout Subsection
17586 Bibliography formatting
17589 \begin_layout Standard
17590 The bibliography can be formatted using
17591 \begin_inset Flex CharStyle:Code
17594 \begin_layout Plain Layout
17602 \begin_inset CommandInset ref
17604 reference "sub:Citation-format-description"
17611 \begin_layout Subsection
17615 \begin_layout Standard
17616 We have several times mentioned that LyX will generate default CSS style
17617 rules for both insets and paragraph styles, based upon the other layout
17618 information that is provided.
17619 In this section, we shall say a word about which layout information LyX
17623 \begin_layout Standard
17624 At present, LyX auto-generates CSS only for font information, making use
17626 \begin_inset Flex CharStyle:Code
17629 \begin_layout Plain Layout
17636 \begin_inset Flex CharStyle:Code
17639 \begin_layout Plain Layout
17646 \begin_inset Flex CharStyle:Code
17649 \begin_layout Plain Layout
17656 \begin_inset Flex CharStyle:Code
17659 \begin_layout Plain Layout
17666 \begin_inset Flex CharStyle:Code
17669 \begin_layout Plain Layout
17677 \begin_inset CommandInset ref
17679 reference "sub:Font-description"
17683 .) The translation is mostly straightforward and obvious.
17685 \begin_inset Quotes eld
17689 \begin_inset Flex CharStyle:Code
17692 \begin_layout Plain Layout
17699 \begin_inset Quotes erd
17703 \begin_inset Quotes eld
17707 \begin_inset Flex CharStyle:Code
17710 \begin_layout Plain Layout
17711 font-family: sans-serif;
17717 \begin_inset Quotes erd
17721 The correspondence of LyX sizes and CSS sizes is a little less obvious
17722 but nonetheless intuitive.
17724 \begin_inset Flex CharStyle:Code
17727 \begin_layout Plain Layout
17734 \begin_inset Flex URL
17737 \begin_layout Plain Layout
17748 \begin_layout Chapter
17749 Including External Material
17752 \begin_layout Standard
17753 \begin_inset Box Shadowbox
17762 height_special "totalheight"
17765 \begin_layout Plain Layout
17766 WARNING: This portion of the documentation has not been updated for some
17768 We certainly hope that it is still accurate, but there are no guarantees.
17776 \begin_layout Standard
17777 The use of material from sources external to LyX is covered in detail in
17783 This part of the manual covers what needs to happen behind the scenes for
17784 new sorts of material to be included.
17787 \begin_layout Section
17791 \begin_layout Standard
17792 The external material feature is based on the concept of a
17797 A template is a specification of how LyX should interface with a certain
17799 As bundled, LyX comes with predefined templates for Xfig figures, various
17800 raster format images, chess diagrams, and LilyPond music notation.
17801 You can check the actual list by using the menu
17802 \begin_inset Flex CharStyle:MenuItem
17805 \begin_layout Plain Layout
17806 Insert\SpecialChar \menuseparator
17807 File\SpecialChar \menuseparator
17814 Furthermore, it is possible to roll your own template to support a specific
17816 Later we'll describe in more detail what is involved, and hopefully you
17817 will submit all the templates you create so we can include them in a later
17821 \begin_layout Standard
17822 Another basic idea of the external material feature is to distinguish between
17823 the original file that serves as a base for final material and the produced
17824 file that is included in your exported or printed document.
17825 For example, consider the case of a figure produced with
17826 \begin_inset Flex CharStyle:Code
17829 \begin_layout Plain Layout
17836 The Xfig application itself works on an original file with the
17837 \begin_inset Flex CharStyle:Code
17840 \begin_layout Plain Layout
17847 Within Xfig, you create and change your figure, and when you are done,
17849 \begin_inset Flex CharStyle:Code
17852 \begin_layout Plain Layout
17859 When you want to include the figure in your document, you invoke
17860 \begin_inset Flex CharStyle:Code
17863 \begin_layout Plain Layout
17869 in order to create a PostScript file that can readily be included in your
17872 \begin_inset Flex CharStyle:Code
17875 \begin_layout Plain Layout
17881 file is the original file, and the PostScript file is the produced file.
17884 \begin_layout Standard
17885 This distinction is important in order to allow updating of the material
17886 while you are in the process of writing the document.
17887 Furthermore, it provides us with the flexibility that is needed to support
17888 multiple export formats.
17889 For instance, in the case of a plain text file, it is not exactly an award-winn
17890 ing idea to include the figure as raw PostScript.
17891 Instead, you'd either prefer to just include a reference to the figure
17892 or try to invoke some graphics to ASCII converter to make the final result
17893 look similar to the real graphics.
17894 The external material management allows you to do this, because it is parametri
17895 zed on the different export formats that LyX supports.
17898 \begin_layout Standard
17899 Besides supporting the production of different products according to the
17900 exported format, it supports tight integration with editing and viewing
17902 In the case of an Xfig figure, you are able to invoke Xfig on the original
17903 file with a single click from within the external material dialog in LyX,
17904 and also preview the produced PostScript file with Ghostview with another
17906 No more fiddling around with the command line and/or file browsers to locate
17907 and manipulate the original or produced files.
17908 In this way, you are finally able to take full advantage of the many different
17909 applications that are relevant to use when you write your documents, and
17910 ultimately be more productive.
17913 \begin_layout Section
17914 The external template configuration file
17917 \begin_layout Standard
17918 It is relatively easy to add custom external template definitions to LyX.
17919 However, be aware that doing this in an careless manner most probably
17923 introduce an easily exploitable security hole.
17924 So before you do this, please read the discussion about security in section
17926 \begin_inset CommandInset ref
17928 reference "sec:Security-discussion"
17935 \begin_layout Standard
17936 Having said that, we encourage you to submit any interesting templates that
17941 \begin_layout Standard
17942 The external templates are defined in the
17943 \begin_inset Flex CharStyle:Code
17946 \begin_layout Plain Layout
17947 LyXDir/lib/external_templates
17953 You can place your own version in
17954 \begin_inset Flex CharStyle:Code
17957 \begin_layout Plain Layout
17958 UserDir/external_templates
17966 \begin_layout Standard
17967 A typical template looks like this:
17970 \begin_layout LyX-Code
17974 \begin_layout LyX-Code
17975 GuiName "XFig: $$AbsOrRelPathParent$$Basename"
17978 \begin_layout LyX-Code
17982 \begin_layout LyX-Code
17986 \begin_layout LyX-Code
17990 \begin_layout LyX-Code
17994 \begin_layout LyX-Code
17998 \begin_layout LyX-Code
17999 AutomaticProduction true
18002 \begin_layout LyX-Code
18006 \begin_layout LyX-Code
18010 \begin_layout LyX-Code
18014 \begin_layout LyX-Code
18015 TransformCommand Rotate RotationLatexCommand
18018 \begin_layout LyX-Code
18019 TransformCommand Resize ResizeLatexCommand
18022 \begin_layout LyX-Code
18023 Product "$$RotateFront$$ResizeFront
18026 \begin_layout LyX-Code
18031 input{$$AbsOrRelPathMaster$$Basename.pstex_t}
18034 \begin_layout LyX-Code
18035 $$ResizeBack$$RotateBack"
18038 \begin_layout LyX-Code
18042 \begin_layout LyX-Code
18043 UpdateResult "$$AbsPath$$Basename.pstex_t"
18046 \begin_layout LyX-Code
18047 Requirement "graphicx"
18050 \begin_layout LyX-Code
18051 ReferencedFile latex "$$AbsOrRelPathMaster$$Basename.pstex_t"
18054 \begin_layout LyX-Code
18055 ReferencedFile latex "$$AbsPath$$Basename.eps"
18058 \begin_layout LyX-Code
18059 ReferencedFile dvi "$$AbsPath$$Basename.eps"
18062 \begin_layout LyX-Code
18066 \begin_layout LyX-Code
18070 \begin_layout LyX-Code
18071 TransformCommand Rotate RotationLatexCommand
18074 \begin_layout LyX-Code
18075 TransformCommand Resize ResizeLatexCommand
18078 \begin_layout LyX-Code
18079 Product "$$RotateFront$$ResizeFront
18082 \begin_layout LyX-Code
18087 input{$$AbsOrRelPathMaster$$Basename.pdftex_t}
18090 \begin_layout LyX-Code
18091 $$ResizeBack$$RotateBack"
18094 \begin_layout LyX-Code
18095 UpdateFormat pdftex
18098 \begin_layout LyX-Code
18099 UpdateResult "$$AbsPath$$Basename.pdftex_t"
18102 \begin_layout LyX-Code
18103 Requirement "graphicx"
18106 \begin_layout LyX-Code
18107 ReferencedFile latex "$$AbsOrRelPathMaster$$Basename.pdftex_t"
18110 \begin_layout LyX-Code
18111 ReferencedFile latex "$$AbsPath$$Basename.pdf"
18114 \begin_layout LyX-Code
18118 \begin_layout LyX-Code
18122 \begin_layout LyX-Code
18123 Product "$$Contents(
18125 "$$AbsPath$$Basename.asc
18130 \begin_layout LyX-Code
18131 UpdateFormat asciixfig
18134 \begin_layout LyX-Code
18135 UpdateResult "$$AbsPath$$Basename.asc"
18138 \begin_layout LyX-Code
18142 \begin_layout LyX-Code
18146 \begin_layout LyX-Code
18147 Product "<graphic fileref=
18149 "$$AbsOrRelPathMaster$$Basename.eps
18154 \begin_layout LyX-Code
18158 \begin_layout LyX-Code
18162 \begin_layout LyX-Code
18163 UpdateResult "$$AbsPath$$Basename.eps"
18166 \begin_layout LyX-Code
18167 ReferencedFile docbook "$$AbsPath$$Basename.eps"
18170 \begin_layout LyX-Code
18171 ReferencedFile docbook-xml "$$AbsPath$$Basename.eps"
18174 \begin_layout LyX-Code
18178 \begin_layout LyX-Code
18179 Product "[XFig: $$FName]"
18182 \begin_layout LyX-Code
18186 \begin_layout LyX-Code
18190 \begin_layout Standard
18191 As you can see, the template is enclosed in
18192 \begin_inset Flex CharStyle:Code
18195 \begin_layout Plain Layout
18201 \SpecialChar \ldots{}
18203 \begin_inset Flex CharStyle:Code
18206 \begin_layout Plain Layout
18213 It contains a header specifying some general settings and, for each supported
18214 primary document file format, a section
18215 \begin_inset Flex CharStyle:Code
18218 \begin_layout Plain Layout
18224 \SpecialChar \ldots{}
18226 \begin_inset Flex CharStyle:Code
18229 \begin_layout Plain Layout
18238 \begin_layout Subsection
18239 The template header
18242 \begin_layout Description
18243 \begin_inset Flex CharStyle:Code
18246 \begin_layout Plain Layout
18247 AutomaticProduction
18248 \begin_inset space ~
18256 Whether the file represented by the template must be generated by LyX.
18257 This command must occur exactly once.
18260 \begin_layout Description
18261 \begin_inset Flex CharStyle:Code
18264 \begin_layout Plain Layout
18266 \begin_inset space ~
18274 A glob pattern that is used in the file dialog to filter out the desired
18276 If there is more than one possible file extension (e.
18277 \begin_inset space \thinspace{}
18281 \begin_inset space \space{}
18285 \begin_inset Flex CharStyle:Code
18288 \begin_layout Plain Layout
18295 \begin_inset Flex CharStyle:Code
18298 \begin_layout Plain Layout
18304 ), use something like
18305 \begin_inset Flex CharStyle:Code
18308 \begin_layout Plain Layout
18315 This command must occur exactly once.
18318 \begin_layout Description
18319 \begin_inset Flex CharStyle:Code
18322 \begin_layout Plain Layout
18324 \begin_inset space ~
18332 The text that is displayed on the button.
18333 This command must occur exactly once.
18336 \begin_layout Description
18337 \begin_inset Flex CharStyle:Code
18340 \begin_layout Plain Layout
18342 \begin_inset space ~
18346 \begin_inset space ~
18354 The help text that is used in the External dialog.
18355 Provide enough information to explain to the user just what the template
18356 can provide him with.
18357 This command must occur exactly once.
18360 \begin_layout Description
18361 \begin_inset Flex CharStyle:Code
18364 \begin_layout Plain Layout
18366 \begin_inset space ~
18374 The file format of the original file.
18375 This must be the name of a format that is known to LyX (see section
18376 \begin_inset CommandInset ref
18378 reference "sec:Formats"
18384 \begin_inset Quotes eld
18388 \begin_inset Flex CharStyle:Code
18391 \begin_layout Plain Layout
18398 \begin_inset Quotes erd
18401 if the template can handle original files of more than one format.
18402 LyX will attempt to interrogate the file itself in order to deduce its
18403 format in this case.
18404 This command must occur exactly once.
18407 \begin_layout Description
18408 \begin_inset Flex CharStyle:Code
18411 \begin_layout Plain Layout
18413 \begin_inset space ~
18421 A unique name for the template.
18422 It must not contain substitution macros (see below).
18425 \begin_layout Description
18426 \begin_inset Flex CharStyle:Code
18429 \begin_layout Plain Layout
18431 \begin_inset space ~
18434 Rotate|Resize|Clip|Extra
18439 This command specifies which transformations are supported by this template.
18440 It may occur zero or more times.
18441 This command enables the corresponding tabs in the external dialog.
18443 \begin_inset Flex CharStyle:Code
18446 \begin_layout Plain Layout
18452 command must have either a corresponding
18453 \begin_inset Flex CharStyle:Code
18456 \begin_layout Plain Layout
18463 \begin_inset Flex CharStyle:Code
18466 \begin_layout Plain Layout
18473 \begin_inset Flex CharStyle:Code
18476 \begin_layout Plain Layout
18483 Otherwise the transformation will not be supported by that format.
18486 \begin_layout Subsection
18490 \begin_layout Description
18491 \begin_inset Flex CharStyle:Code
18494 \begin_layout Plain Layout
18496 \begin_inset space ~
18499 LaTeX|PDFLaTeX|PlainText|DocBook
18504 The primary document file format that this format definition is for.
18505 Not every template has a sensible representation in all document file formats.
18506 Please define nevertheless a
18507 \begin_inset Flex CharStyle:Code
18510 \begin_layout Plain Layout
18516 section for all formats.
18517 Use a dummy text when no representation is available.
18518 Then you can at least see a reference to the external material in the exported
18522 \begin_layout Description
18523 \begin_inset Flex CharStyle:Code
18526 \begin_layout Plain Layout
18528 \begin_inset space ~
18532 \begin_inset space ~
18540 This command defines an additional macro
18541 \begin_inset Flex CharStyle:Code
18544 \begin_layout Plain Layout
18550 for substitution in
18551 \begin_inset Flex CharStyle:Code
18554 \begin_layout Plain Layout
18562 \begin_inset Flex CharStyle:Code
18565 \begin_layout Plain Layout
18571 itself may contain substitution macros.
18572 The advantage over using
18573 \begin_inset Flex CharStyle:Code
18576 \begin_layout Plain Layout
18583 \begin_inset Flex CharStyle:Code
18586 \begin_layout Plain Layout
18592 is that the substituted value of
18593 \begin_inset Flex CharStyle:Code
18596 \begin_layout Plain Layout
18602 is sanitized so that it is a valid optional argument in the document format.
18603 This command may occur zero or more times.
18606 \begin_layout Description
18607 \begin_inset Flex CharStyle:Code
18610 \begin_layout Plain Layout
18612 \begin_inset space ~
18620 The text that is inserted in the exported document.
18621 This is actually the most important command and can be quite complex.
18622 This command must occur exactly once.
18625 \begin_layout Description
18626 \begin_inset Flex CharStyle:Code
18629 \begin_layout Plain Layout
18631 \begin_inset space ~
18639 This command specifies a preamble snippet that will be included in the
18641 It has to be defined using
18642 \begin_inset Flex CharStyle:Code
18645 \begin_layout Plain Layout
18651 \SpecialChar \ldots{}
18653 \begin_inset Flex CharStyle:Code
18656 \begin_layout Plain Layout
18663 This command may occur zero or more times.
18666 \begin_layout Description
18667 \begin_inset Flex CharStyle:Code
18670 \begin_layout Plain Layout
18672 \begin_inset space ~
18676 \begin_inset space ~
18684 This command denotes files that are created by the conversion process and
18685 are needed for a particular export format.
18686 If the filename is relative, it is interpreted relative to the master document.
18687 This command may be given zero or more times.
18690 \begin_layout Description
18691 \begin_inset Flex CharStyle:Code
18694 \begin_layout Plain Layout
18696 \begin_inset space ~
18704 The name of a required LaTeX package.
18705 The package is included via
18706 \begin_inset Flex CharStyle:Code
18709 \begin_layout Plain Layout
18717 in the LaTeX preamble.
18718 This command may occur zero or more times.
18721 \begin_layout Description
18722 \begin_inset Flex CharStyle:Code
18725 \begin_layout Plain Layout
18727 \begin_inset space ~
18731 \begin_inset space ~
18734 RotationLatexCommand
18739 This command specifies that the built in LaTeX command should be used for
18741 This command may occur once or not at all.
18744 \begin_layout Description
18745 \begin_inset Flex CharStyle:Code
18748 \begin_layout Plain Layout
18750 \begin_inset space ~
18754 \begin_inset space ~
18762 This command specifies that the built in LaTeX command should be used for
18764 This command may occur once or not at all.
18767 \begin_layout Description
18768 \begin_inset Flex CharStyle:Code
18771 \begin_layout Plain Layout
18773 \begin_inset space ~
18777 \begin_inset space ~
18780 RotationLatexOption
18785 This command specifies that rotation is done via an optional argument.
18786 This command may occur once or not at all.
18789 \begin_layout Description
18790 \begin_inset Flex CharStyle:Code
18793 \begin_layout Plain Layout
18795 \begin_inset space ~
18799 \begin_inset space ~
18807 This command specifies that resizing is done via an optional argument.
18808 This command may occur once or not at all.
18811 \begin_layout Description
18812 \begin_inset Flex CharStyle:Code
18815 \begin_layout Plain Layout
18817 \begin_inset space ~
18821 \begin_inset space ~
18829 This command specifies that clipping is done via an optional argument.
18830 This command may occur once or not at all.
18833 \begin_layout Description
18834 \begin_inset Flex CharStyle:Code
18837 \begin_layout Plain Layout
18839 \begin_inset space ~
18843 \begin_inset space ~
18851 This command specifies that an extra optional argument is used.
18852 This command may occur once or not at all.
18855 \begin_layout Description
18856 \begin_inset Flex CharStyle:Code
18859 \begin_layout Plain Layout
18861 \begin_inset space ~
18869 The file format of the converted file.
18870 This must be the name of a format that is known to LyX (see the
18871 \begin_inset Flex CharStyle:MenuItem
18874 \begin_layout Plain Layout
18879 ools\SpecialChar \menuseparator
18884 references:Conversion
18890 This command must occur exactly once.
18893 \begin_layout Description
18894 \begin_inset Flex CharStyle:Code
18897 \begin_layout Plain Layout
18899 \begin_inset space ~
18907 The file name of the converted file.
18908 The file name must be absolute.
18909 This command must occur exactly once.
18912 \begin_layout Subsection
18913 Preamble definitions
18916 \begin_layout Standard
18917 The external template configuration file may contain additional preamble
18918 definitions enclosed by
18919 \begin_inset Flex CharStyle:Code
18922 \begin_layout Plain Layout
18928 \SpecialChar \ldots{}
18930 \begin_inset Flex CharStyle:Code
18933 \begin_layout Plain Layout
18940 They can be used by the templates in the
18941 \begin_inset Flex CharStyle:Code
18944 \begin_layout Plain Layout
18953 \begin_layout Section
18954 The substitution mechanism
18957 \begin_layout Standard
18958 When the external material facility invokes an external program, it is done
18959 on the basis of a command defined in the template configuration file.
18960 These commands can contain various macros that are expanded before execution.
18961 Execution always take place in the directory of the containing document.
18964 \begin_layout Standard
18965 Also, whenever external material is to be displayed, the name will be produced
18966 by the substitution mechanism, and most other commands in the template
18967 definition support substitution as well.
18970 \begin_layout Standard
18971 The available macros are the following:
18974 \begin_layout Description
18975 \begin_inset Flex CharStyle:Code
18978 \begin_layout Plain Layout
18979 $$AbsOrRelPathMaster
18984 The file path, absolute or relative to the master LyX document.
18987 \begin_layout Description
18988 \begin_inset Flex CharStyle:Code
18991 \begin_layout Plain Layout
18992 $$AbsOrRelPathParent
18997 The file path, absolute or relative to the LyX document.
19000 \begin_layout Description
19001 \begin_inset Flex CharStyle:Code
19004 \begin_layout Plain Layout
19010 The absolute file path.
19013 \begin_layout Description
19014 \begin_inset Flex CharStyle:Code
19017 \begin_layout Plain Layout
19023 The filename without path and without the extension.
19026 \begin_layout Description
19027 \begin_inset Flex CharStyle:Code
19030 \begin_layout Plain Layout
19032 \begin_inset Quotes eld
19036 \begin_inset Quotes erd
19044 This macro will expand to the contents of the file with the name
19045 \begin_inset Flex CharStyle:Code
19048 \begin_layout Plain Layout
19057 \begin_layout Description
19058 \begin_inset Flex CharStyle:Code
19061 \begin_layout Plain Layout
19067 The file extension (including the dot).
19070 \begin_layout Description
19071 \begin_inset Flex CharStyle:Code
19074 \begin_layout Plain Layout
19080 The filename of the file specified in the external material dialog.
19081 This is either an absolute name, or it is relative to the LyX document.
19084 \begin_layout Description
19085 \begin_inset Flex CharStyle:Code
19088 \begin_layout Plain Layout
19095 \begin_inset Flex CharStyle:Code
19098 \begin_layout Plain Layout
19104 (absolute name or relative to the LyX document).
19107 \begin_layout Description
19108 \begin_inset Flex CharStyle:Code
19111 \begin_layout Plain Layout
19117 The file path, relative to the master LyX document.
19120 \begin_layout Description
19121 \begin_inset Flex CharStyle:Code
19124 \begin_layout Plain Layout
19130 The file path, relative to the LyX document.
19133 \begin_layout Description
19134 \begin_inset Flex CharStyle:Code
19137 \begin_layout Plain Layout
19143 This macro will expand to the absolute path of the system directory.
19144 This is typically used to point to the various helper scripts that are
19148 \begin_layout Description
19149 \begin_inset Flex CharStyle:Code
19152 \begin_layout Plain Layout
19158 A name and full path to a temporary file which will be automatically deleted
19159 whenever the containing document is closed, or the external material insertion
19163 \begin_layout Standard
19164 All path macros contain a trailing directory separator, so you can construct
19166 \begin_inset space \thinspace{}
19170 \begin_inset space \space{}
19173 the absolute filename with
19174 \begin_inset Flex CharStyle:Code
19177 \begin_layout Plain Layout
19178 $$AbsPath$$Basename$$Extension
19186 \begin_layout Standard
19187 The macros above are substituted in all commands unless otherwise noted.
19189 \begin_inset Flex CharStyle:Code
19192 \begin_layout Plain Layout
19198 supports additionally the following substitutions if they are enabled by
19200 \begin_inset Flex CharStyle:Code
19203 \begin_layout Plain Layout
19210 \begin_inset Flex CharStyle:Code
19213 \begin_layout Plain Layout
19222 \begin_layout Description
19223 \begin_inset Flex CharStyle:Code
19226 \begin_layout Plain Layout
19232 The front part of the resize command.
19235 \begin_layout Description
19236 \begin_inset Flex CharStyle:Code
19239 \begin_layout Plain Layout
19245 The back part of the resize command.
19248 \begin_layout Description
19249 \begin_inset Flex CharStyle:Code
19252 \begin_layout Plain Layout
19258 The front part of the rotation command.
19261 \begin_layout Description
19262 \begin_inset Flex CharStyle:Code
19265 \begin_layout Plain Layout
19271 The back part of the rotation command.
19274 \begin_layout Standard
19275 The value string of the
19276 \begin_inset Flex CharStyle:Code
19279 \begin_layout Plain Layout
19285 command supports additionally the following substitutions if they are enabled
19287 \begin_inset Flex CharStyle:Code
19290 \begin_layout Plain Layout
19297 \begin_inset Flex CharStyle:Code
19300 \begin_layout Plain Layout
19309 \begin_layout Description
19310 \begin_inset Flex CharStyle:Code
19313 \begin_layout Plain Layout
19322 \begin_layout Description
19323 \begin_inset Flex CharStyle:Code
19326 \begin_layout Plain Layout
19335 \begin_layout Description
19336 \begin_inset Flex CharStyle:Code
19339 \begin_layout Plain Layout
19348 \begin_layout Description
19349 \begin_inset Flex CharStyle:Code
19352 \begin_layout Plain Layout
19358 The rotation option.
19361 \begin_layout Standard
19362 You may ask why there are so many path macros.
19363 There are mainly two reasons:
19366 \begin_layout Enumerate
19367 Relative and absolute file names should remain relative or absolute, respectivel
19369 Users may have reasons to prefer either form.
19370 Relative names are useful for portable documents that should work on different
19371 machines, for example.
19372 Absolute names may be required by some programs.
19375 \begin_layout Enumerate
19376 LaTeX treats relative file names differently than LyX and other programs
19377 in nested included files.
19378 For LyX, a relative file name is always relative to the document that contains
19380 For LaTeX, it is always relative to the master document.
19381 These two definitions are identical if you have only one document, but
19382 differ if you have a master document that includes part documents.
19383 That means that relative filenames must be transformed when presented to
19385 Fortunately LyX does this automatically for you if you choose the right
19389 \begin_layout Standard
19390 So which path macro should be used in new template definitions? The rule
19394 \begin_layout Itemize
19396 \begin_inset Flex CharStyle:Code
19399 \begin_layout Plain Layout
19405 if an absolute path is required.
19408 \begin_layout Itemize
19410 \begin_inset Flex CharStyle:Code
19413 \begin_layout Plain Layout
19414 $$AbsOrRelPathMaster
19419 if the substituted string is some kind of LaTeX input.
19422 \begin_layout Itemize
19424 \begin_inset Flex CharStyle:Code
19427 \begin_layout Plain Layout
19428 $$AbsOrRelPathParent
19433 in order to preserve the user's choice.
19436 \begin_layout Standard
19437 There are special cases where this rule does not work and e.
19438 \begin_inset space \thinspace{}
19442 \begin_inset space \space{}
19445 relative names are needed, but normally it will work just fine.
19446 One example for such a case is the command
19447 \begin_inset Flex CharStyle:Code
19450 \begin_layout Plain Layout
19451 ReferencedFile latex "$$AbsOrRelPathMaster$$Basename.pstex_t"
19456 in the XFig template above: We can't use the absolute name because the
19458 \begin_inset Flex CharStyle:Code
19461 \begin_layout Plain Layout
19467 files needs the relative name in order to rewrite the file content.
19470 \begin_layout Section
19471 Security discussion
19472 \begin_inset CommandInset label
19474 name "sec:Security-discussion"
19481 \begin_layout Standard
19482 The external material feature interfaces with a lot of external programs
19483 and does so automatically, so we have to consider the security implications
19485 In particular, since you have the option of including your own filenames
19486 and/or parameter strings and those are expanded into a command, it seems
19487 that it would be possible to create a malicious document which executes
19488 arbitrary commands when a user views or prints the document.
19489 This is something we definitely want to avoid.
19492 \begin_layout Standard
19493 However, since the external program commands are specified in the template
19494 configuration file only, there are no security issues if LyX is properly
19495 configured with safe templates only.
19496 This is so because the external programs are invoked with the
19497 \begin_inset Flex CharStyle:Code
19500 \begin_layout Plain Layout
19506 -system call rather than the
19507 \begin_inset Flex CharStyle:Code
19510 \begin_layout Plain Layout
19516 system-call, so it's not possible to execute arbitrary commands from the
19517 filename or parameter section via the shell.
19520 \begin_layout Standard
19521 This also implies that you are restricted in what command strings you can
19522 use in the external material templates.
19523 In particular, pipes and redirection are not readily available.
19524 This has to be so if LyX should remain safe.
19525 If you want to use some of the shell features, you should write a safe
19526 script to do this in a controlled manner, and then invoke the script from
19527 the command string.
19531 \begin_layout Standard
19532 It is possible to design a template that interacts directly with the shell,
19533 but since this would allow a malicious user to execute arbitrary commands
19534 by writing clever filenames and/or parameters, we generally recommend that
19535 you only use safe scripts that work with the
19536 \begin_inset Flex CharStyle:Code
19539 \begin_layout Plain Layout
19545 system call in a controlled manner.
19546 Of course, for use in a controlled environment, it can be tempting to just
19547 fall back to use ordinary shell scripts.
19548 If you do so, be aware that you
19552 provide an easily exploitable security hole in your system.
19553 Of course it stands to reason that such unsafe templates will never be
19554 included in the standard LyX distribution, although we do encourage people
19555 to submit new templates in the open source tradition.
19556 But LyX as shipped from the official distribution channels will never have
19560 \begin_layout Standard
19561 Including external material provides a lot of power, and you have to be
19562 careful not to introduce security hazards with this power.
19563 A subtle error in a single line in an innocent looking script can open
19564 the door to huge security problems.
19565 So if you do not fully understand the issues, we recommend that you consult
19566 a knowledgeable security professional or the LyX development team if you
19567 have any questions about whether a given template is safe or not.
19568 And do this before you use it in an uncontrolled environment.