1 #LyX 1.6.0rc2 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 the User's Guide prints
10 % out as advertised. If you mess with this preamble,
11 % parts of the User's Guide 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
49 InsetLayout CharStyle:MenuItem
58 \newcommand*{\menuitem}[1]{{\sffamily #1}}
66 \font_typewriter default
67 \font_default_family default
77 \pdf_title "LyX Configuration Manual"
78 \pdf_author "LyX Team"
79 \pdf_subject "LyX-documentation Customization"
80 \pdf_keywords "LyX, documentation, customization"
82 \pdf_bookmarksnumbered true
83 \pdf_bookmarksopen true
84 \pdf_bookmarksopenlevel 1
89 \pdf_pagebackref false
90 \pdf_pdfusetitle false
91 \pdf_quoted_options "linkcolor=black, citecolor=black, urlcolor=blue, filecolor=blue,pdfpagelayout=OneColumn, pdfnewwindow=true,pdfstartview=XYZ, plainpages=false, pdfpagelabels"
98 \paperorientation portrait
105 \paragraph_separation indent
107 \quotes_language english
110 \paperpagestyle headings
111 \tracking_changes false
112 \output_changes false
120 Customizing LyX: Features for the Advanced User
128 \begin_layout Plain Layout
130 If you have comments or error corrections, please send them to the LyX Documenta
132 \begin_inset CommandInset href
134 target "lyx-docs@lists.lyx.org"
147 \begin_layout Standard
148 \begin_inset CommandInset toc
149 LatexCommand tableofcontents
156 \begin_layout Chapter
160 \begin_layout Standard
161 This manual covers the customization features present in LyX.
162 In it, we discuss issues like keyboard shortcuts, screen previewing options,
163 printer options, sending commands to LyX via the LyX Server, internationalizati
164 on, installing new LaTeX classes and LyX layouts, etc.
165 We can't possibly hope to touch on everything you can change---our developers
166 add new features faster than we can document them---but we will explain
167 the most common customizations and hopefully point you in the right direction
168 for some of the more obscure ones.
171 \begin_layout Standard
172 \begin_inset Branch OutDated
175 \begin_layout Standard
176 Information from previous versions of this document that now seems to be
177 outdated is contained in the OutDated branch of this document.
178 By default, this information will not appear in the LaTeX output.
186 \begin_layout Chapter
187 LyX configuration files
190 \begin_layout Standard
191 \begin_inset CommandInset label
197 This chapter aims to help you to find your way through the LyX configuration
199 Before continuing to read this chapter, you should find out where your
200 LyX library and user directories are by using
201 \begin_inset Flex CharStyle:MenuItem
204 \begin_layout Plain Layout
209 elp\SpecialChar \menuseparator
222 The library directory is the place where LyX places its system-wide configurati
223 on files; the user directory is where you can place your modified versions.
224 We will call the former
225 \begin_inset Flex CharStyle:Code
228 \begin_layout Plain Layout
235 \begin_inset Flex CharStyle:MenuItem
238 \begin_layout Plain Layout
244 in the remainder of this document.
248 \begin_layout Section
250 \begin_inset Flex CharStyle:Code
253 \begin_layout Plain Layout
262 \begin_layout Standard
263 \begin_inset Flex CharStyle:Code
266 \begin_layout Plain Layout
272 and its sub-directories contain a number of files and that can be used
273 to customise LyX's behaviour.
274 You can change many of these files from within LyX itself through the
275 \begin_inset Flex CharStyle:MenuItem
278 \begin_layout Plain Layout
283 ools\SpecialChar \menuseparator
294 Most customization that you will want to do in LyX is possible through
296 However, many other inner aspects of LyX can be customized by modifying
298 \begin_inset Flex CharStyle:Code
301 \begin_layout Plain Layout
308 These files fall in different categories, described in the following subsection
312 \begin_layout Subsection
313 Automatically generated files
316 \begin_layout Standard
317 The files, which are to be found in
318 \begin_inset Flex CharStyle:MenuItem
321 \begin_layout Plain Layout
327 , are generated when you configure LyX.
328 They contain various default values that are guessed by inspection.
329 In general, it is not a good idea to modify them, since they might be overwritt
333 \begin_layout Labeling
334 \labelwidthstring 00.00.0000
335 \begin_inset Flex CharStyle:Code
338 \begin_layout Plain Layout
344 contains defaults for various commands.
347 \begin_layout Labeling
348 \labelwidthstring 00.00.0000
349 \begin_inset Flex CharStyle:Code
352 \begin_layout Plain Layout
358 contains the list of packages that have been recognized by LyX.
359 It is currently unused by the LyX program itself, but the information extracted
360 , and more, is made available with
361 \begin_inset Flex CharStyle:MenuItem
364 \begin_layout Plain Layout
369 elp\SpecialChar \menuseparator
386 \begin_layout Labeling
387 \labelwidthstring 00.00.0000
388 \begin_inset Flex CharStyle:Code
391 \begin_layout Plain Layout
397 the list of text classes that have been found in your
398 \begin_inset Flex CharStyle:Code
401 \begin_layout Plain Layout
407 directories, along with the associated LaTeX document class and their descripti
411 \begin_layout Labeling
412 \labelwidthstring 00.00.0000
413 \begin_inset Flex CharStyle:Code
416 \begin_layout Plain Layout
422 the list of layout modules found in your
423 \begin_inset Flex CharStyle:Code
426 \begin_layout Plain Layout
435 \begin_layout Labeling
436 \labelwidthstring 00.00.0000
437 \begin_inset Flex CharStyle:Code
440 \begin_layout Plain Layout
446 lists of various sorts of LaTeX-related files found on your system
449 \begin_layout Labeling
450 \labelwidthstring 00.00.0000
451 \begin_inset Flex CharStyle:Code
454 \begin_layout Plain Layout
460 is automatically generated during configuration from the file
461 \begin_inset Flex CharStyle:Code
464 \begin_layout Plain Layout
471 It contains information on your LaTeX configuration.
474 \begin_layout Subsection
478 \begin_layout Standard
479 These directories are duplicated between
480 \begin_inset Flex CharStyle:Code
483 \begin_layout Plain Layout
490 \begin_inset Flex CharStyle:Code
493 \begin_layout Plain Layout
500 If a particular files exists in both places, the one in
501 \begin_inset Flex CharStyle:Code
504 \begin_layout Plain Layout
513 \begin_layout Labeling
514 \labelwidthstring 00.00.0000
515 \begin_inset Flex CharStyle:Code
518 \begin_layout Plain Layout
524 this directory contains files with the extension
525 \begin_inset Flex CharStyle:Code
528 \begin_layout Plain Layout
534 that define the keybindings used in LyX (see section
539 \begin_inset CommandInset ref
541 reference "sec:bindings"
546 If there exists an internationalized version of the bind file named
547 \begin_inset Flex CharStyle:Code
550 \begin_layout Plain Layout
556 , that will be used first.
562 \begin_inset CommandInset ref
564 reference "chap:i18n"
569 \begin_inset CommandInset ref
571 reference "sec:bindings"
578 \begin_layout Labeling
579 \labelwidthstring 00.00.0000
580 \begin_inset Flex CharStyle:Code
583 \begin_layout Plain Layout
589 contains graphics files that can be included in documents.
593 \begin_layout Labeling
594 \labelwidthstring 00.00.0000
595 \begin_inset Flex CharStyle:Code
598 \begin_layout Plain Layout
604 contains LyX documentation files (including the one you are currently reading).
606 \begin_inset Flex CharStyle:Code
609 \begin_layout Plain Layout
615 deserves special attention, as noted above.
616 If there exists an internationalized version of the help-document with
618 \begin_inset Flex CharStyle:Code
621 \begin_layout Plain Layout
627 prepended to the name, that will be used first.
633 \begin_inset CommandInset ref
635 reference "chap:i18n"
642 \begin_layout Labeling
643 \labelwidthstring 00.00.0000
644 \begin_inset Flex CharStyle:Code
647 \begin_layout Plain Layout
653 contains example files that explain how to use some features.
654 In the file browser, press the
655 \begin_inset Flex CharStyle:MenuItem
658 \begin_layout Plain Layout
667 \begin_layout Labeling
668 \labelwidthstring 00.00.0000
669 \begin_inset Flex CharStyle:Code
672 \begin_layout Plain Layout
678 contains image files that are used by the
679 \begin_inset Flex CharStyle:MenuItem
682 \begin_layout Plain Layout
689 In addition, it also contains the individual icons used in the toolbar
690 and the banners that can be shown when LyX is launched.
693 \begin_layout Labeling
694 \labelwidthstring 00.00.0000
695 \begin_inset Flex CharStyle:Code
698 \begin_layout Plain Layout
704 contains keyboard keymapping files.
710 \begin_inset CommandInset ref
712 reference "sec:keymap"
719 \begin_layout Labeling
720 \labelwidthstring 00.00.0000
721 \begin_inset Flex CharStyle:Code
724 \begin_layout Plain Layout
730 contains the text class and module files described in Chapter
735 \begin_inset CommandInset ref
737 reference "chap:textclass"
744 \begin_layout Labeling
745 \labelwidthstring 00.00.0000
746 \begin_inset Flex CharStyle:Code
749 \begin_layout Plain Layout
756 \begin_inset Flex CharStyle:Code
759 \begin_layout Plain Layout
765 Python scripts used to convert between LyX versions.
766 These can be run from the command line if, say, you want to batch-convert
770 \begin_layout Labeling
771 \labelwidthstring 00.00.0000
772 \begin_inset Flex CharStyle:Code
775 \begin_layout Plain Layout
781 contains some files that demonstrate the capabilities of the
782 \begin_inset Flex CharStyle:MenuItem
785 \begin_layout Plain Layout
796 Also contains some scripts used by LyX itself.
799 \begin_layout Labeling
800 \labelwidthstring 00.00.0000
801 \begin_inset Flex CharStyle:Code
804 \begin_layout Plain Layout
810 contains the standard LyX template files described in Chapter
815 \begin_inset CommandInset ref
817 reference "sec:templates"
824 \begin_layout Labeling
825 \labelwidthstring 00.00.0000
826 \begin_inset Flex CharStyle:Code
829 \begin_layout Plain Layout
835 contains files with the extension
836 \begin_inset Flex CharStyle:Code
839 \begin_layout Plain Layout
845 that define the user interface to LyX.
846 That is, the files define which items appear in which menus and the items
847 appearing on the toolbar.
849 \begin_inset CommandInset ref
858 \begin_layout Subsection
859 Files you don't want to modify
862 \begin_layout Standard
863 These files are used internally by LyX and you generally do not need to
864 modify them unless you are a developer.
867 \begin_layout Labeling
868 \labelwidthstring 00.00.0000
869 \begin_inset Flex CharStyle:Code
872 \begin_layout Plain Layout
878 this file contains the list of LyX developers.
879 The contents are displayed with the menu entry
880 \begin_inset Flex CharStyle:MenuItem
883 \begin_layout Plain Layout
888 elp\SpecialChar \menuseparator
901 \begin_layout Labeling
902 \labelwidthstring 00.00.0000
903 \begin_inset Flex CharStyle:Code
906 \begin_layout Plain Layout
912 this is a LaTeX script used during the configuration process.
916 \begin_layout Labeling
917 \labelwidthstring 00.00.0000
918 \begin_inset Flex CharStyle:Code
921 \begin_layout Plain Layout
927 this is the script that is used to re-configure LyX.
928 It creates configuration files in the directory it was run from.
931 \begin_layout Subsection
932 Other files needing a line or two...
935 \begin_layout Labeling
936 \labelwidthstring 00.00.0000
937 \begin_inset Flex CharStyle:Code
940 \begin_layout Plain Layout
946 this contains tables describing how different character encodings can be
950 \begin_layout Labeling
951 \labelwidthstring 00.00.0000
952 \begin_inset Flex CharStyle:Code
955 \begin_layout Plain Layout
961 this file contains the templates available to the new
962 \begin_inset Flex CharStyle:MenuItem
965 \begin_layout Plain Layout
978 \begin_layout Labeling
979 \labelwidthstring 00.00.0000
980 \begin_inset Flex CharStyle:Code
983 \begin_layout Plain Layout
989 this file contains a list of all the languages currently supported by LyX.
992 \begin_layout Section
993 Your local configuration directory
996 \begin_layout Standard
997 Even if you are using LyX as an unprivileged user, you might want to change
998 LyX configuration for your own use.
1000 \begin_inset Flex CharStyle:Code
1003 \begin_layout Plain Layout
1009 directory contains all your personal configuration files.
1010 This is the directory described as
1011 \begin_inset Quotes eld
1015 \begin_inset Quotes erd
1019 \begin_inset Flex CharStyle:MenuItem
1022 \begin_layout Plain Layout
1027 elp\SpecialChar \menuseparator
1029 \begin_inset space ~
1038 This directory is used as a mirror of
1039 \begin_inset Flex CharStyle:Code
1042 \begin_layout Plain Layout
1048 , which means that every file in
1049 \begin_inset Flex CharStyle:Code
1052 \begin_layout Plain Layout
1058 is a replacement for the corresponding file in
1059 \begin_inset Flex CharStyle:Code
1062 \begin_layout Plain Layout
1069 Any configuration file described in the above sections can be placed either
1070 in the system-wide directory, in which case it will affect all users, or
1071 in your local directory for your own use.
1074 \begin_layout Standard
1075 To make things clearer, let's provide a few examples:
1078 \begin_layout Itemize
1079 The preferences set in the
1080 \begin_inset Flex CharStyle:MenuItem
1083 \begin_layout Plain Layout
1088 ools\SpecialChar \menuseparator
1098 dialog are saved to a file
1099 \begin_inset Flex CharStyle:Code
1102 \begin_layout Plain Layout
1109 \begin_inset Flex CharStyle:Code
1112 \begin_layout Plain Layout
1121 \begin_layout Itemize
1122 When you reconfigure using
1123 \begin_inset Flex CharStyle:MenuItem
1126 \begin_layout Plain Layout
1131 ools\SpecialChar \menuseparator
1142 \begin_inset Flex CharStyle:Code
1145 \begin_layout Plain Layout
1151 script, and the resulting files are written in your local configuration
1153 This means that any additional text class file that you might have added
1155 \begin_inset Flex CharStyle:Code
1158 \begin_layout Plain Layout
1164 will be added to the list of classes in the
1165 \begin_inset Flex CharStyle:MenuItem
1168 \begin_layout Plain Layout
1173 ocument\SpecialChar \menuseparator
1186 \begin_layout Itemize
1187 If you get some updated documentation from LyX ftp site and cannot install
1188 it because you do not have sysadmin rights on your system, you can just
1190 \begin_inset Flex CharStyle:Code
1193 \begin_layout Plain Layout
1199 and the items in the
1200 \begin_inset Flex CharStyle:MenuItem
1203 \begin_layout Plain Layout
1213 menu will open them!
1216 \begin_layout Section
1217 Running LyX with multiple configurations
1220 \begin_layout Standard
1221 The configuration freedom of the local configuration directory may not suffice
1222 if you want to have more than one configuration at your disposal.
1223 For example, you may want to be use different key bindings or printer settings
1225 You can achieve this by having several such directories.
1226 You then specify which directory to use at run-time.
1229 \begin_layout Standard
1230 Invoking LyX with the command line switch
1231 \begin_inset Flex CharStyle:Code
1234 \begin_layout Plain Layout
1244 instructs the program to read the configuration from that directory, and
1245 not from the default directory.
1246 (You can determine the default directory by running LyX without the
1247 \begin_inset Flex CharStyle:Code
1250 \begin_layout Plain Layout
1256 switch.) If the specified directory does not exist, LyX offers to create
1257 it for you, just like it does for the default directory on the first time
1258 you run the program.
1259 You can modify the configuration options in this additional user directory
1260 exactly as you would for the default directory.
1261 These directories are completely independent (but read on).
1262 Note that setting the environment variable
1263 \begin_inset Flex CharStyle:Code
1266 \begin_layout Plain Layout
1272 to some value has exactly the same effect.
1275 \begin_layout Standard
1276 Having several configurations also requires more maintenance: if you want
1277 to add a new layout to
1278 \begin_inset Flex CharStyle:Code
1281 \begin_layout Plain Layout
1287 which you want available from all your configurations, you must add it
1288 to each directory separately.
1289 You can avoid this with the following trick: after LyX creates the additional
1290 directory, most of the subdirectories (see above) are empty.
1291 If you want the new configuration to mirror an existing one, replace the
1292 empty subdirectory with a symbolic link to the matching subdirectory in
1293 the existing configuration.
1295 \begin_inset Flex CharStyle:Code
1298 \begin_layout Plain Layout
1304 subirectory, however, since it contains a file written by the configuration
1305 script (also accessible through
1306 \begin_inset Flex CharStyle:MenuItem
1309 \begin_layout Plain Layout
1314 ools\SpecialChar \menuseparator
1324 ) which is configuration-specific.
1327 \begin_layout Chapter
1328 The Preferences dialog
1331 \begin_layout Section
1332 Using the dialog for the first time
1335 \begin_layout Standard
1337 \begin_inset Flex CharStyle:Code
1340 \begin_layout Plain Layout
1346 file will contain only changes that you have made to the default behaviour,
1347 some of which is hard-coded into LyX and some of which is contained in
1349 \begin_inset Flex CharStyle:Code
1352 \begin_layout Plain Layout
1353 LyXDir/lyxrc.defaults
1359 Note that in both files lines beginning with a
1360 \begin_inset Quotes eld
1364 \begin_inset Quotes erd
1367 are just comments and are not interpreted.
1368 However, only system administrators should edit
1369 \begin_inset Flex CharStyle:Code
1372 \begin_layout Plain Layout
1373 LyXDir/lyxrc.defaults
1379 Users should use the
1380 \begin_inset Flex CharStyle:MenuItem
1383 \begin_layout Plain Layout
1388 ools\SpecialChar \menuseparator
1398 dialog to create and modify their own
1399 \begin_inset Flex CharStyle:Code
1402 \begin_layout Plain Layout
1411 \begin_layout Standard
1413 \begin_inset Flex CharStyle:MenuItem
1416 \begin_layout Plain Layout
1421 ools\SpecialChar \menuseparator
1431 dialog will be largely self-explanatory.
1432 Most things in the dialog have associated `tool tips': hover your mouse
1433 pointer over something for more information.
1434 Before we highlight a few of the more important commands below, however,
1436 \begin_inset Flex CharStyle:MenuItem
1439 \begin_layout Plain Layout
1445 ing some of your changes (e.g., screen fonts) will have an instant effect.
1447 changing the bind file) will not.
1448 If nothing appears to have changed, just
1449 \begin_inset Flex CharStyle:MenuItem
1452 \begin_layout Plain Layout
1458 the changes and restart LyX.
1461 \begin_layout Section
1465 \begin_layout Subsection
1469 \begin_layout Standard
1470 The font used to display your documents on the LyX screen is very important,
1471 since you'll be reading all your documents with this font.
1472 Therefore it is important that the font be as readable and good-looking
1474 The LyX team tried to provide the best possible default font for you, but
1475 since systems can be so different, it's quite possible that the default
1476 fonts will be sub-optimal on your system.
1477 Fortunately, you can do something about this.
1478 Before we explain how, you should learn a bit more about fonts so that
1479 you are better prepared for choosing your fonts.
1480 There are trade-offs that are specific to your preferences and the capabilities
1484 \begin_layout Standard
1485 Notice that this section only deals with the fonts on the
1489 inside the LyX window.
1490 The fonts that appear on the
1498 are independent from these fonts, and are determined by the document class.
1503 to learn how to change the font of the printed version of your document.
1506 \begin_layout Standard
1507 Basically, screen fonts come in two different kinds: scalable outline fonts
1508 and non-scalable bitmap fonts.
1509 This distinction seems a bit arbitrary, since non-scalable fonts are actually
1510 scalable in most modern font renderers.
1511 The difference lies in the
1515 of the scaling and the
1520 The most important decision is thus whether you should use non-scalable
1521 bitmap fonts or scalable outline fonts.
1524 \begin_layout Standard
1525 The scalable fonts are built from
1529 of the single glyphs (i.e.
1530 characters) in the font.
1531 This means that each glyph is defined using mathematical curves that are
1532 well suited for scaling to any requested size.
1533 This mathematical definition is interpreted by the font renderer and turned
1534 into a small picture composed of pixels according to which size and glyph
1535 (or symbol) the programmer requests.
1536 This means that scalable fonts will look pretty good in most sizes.Since
1537 scalable fonts are defined in an abstract way, it can be hard to provide
1538 a good rendering at small sizes, where each pixel has to be very carefully
1539 computed to provide a good image.
1540 Technically it is possible to do this from the mathematical definition,
1541 but in order to keep the rendering reasonably fast, tradeoffs have to be
1542 made, and the result is that scalable fonts can be difficult to read at
1546 \begin_layout Standard
1547 Bitmap fonts on the other hand, are defined by bitmap graphics from the
1548 start, so they will look good at all the sizes they are meant for.
1549 However, they don't scale well, because in order to scale a glyph, each
1550 pixel is enlarged into several pixels.
1551 It is the same effect that happens if you try to enlarge a picture in an
1552 image manipulation program.
1553 In order to relieve this effect, bitmap fonts are typically provided in
1554 several fixed sizes typically from around 8 pixels high up to 34 pixels
1555 or so high in steps according to what is believed to be useful.
1556 The advantage of bitmap fonts is that no complicated computations are necessary
1557 to display each glyph, so bitmap fonts are thus faster displayed than scalable
1559 The disadvantage is that sizes that don't exists as fixed versions have
1560 to be scaled by doubling pixels, and thus look bad.
1563 \begin_layout Standard
1564 The net result of all this is that bitmap fonts are generally best for the
1565 small sizes, where they are available, while scalable fonts are generally
1566 best for large sizes.
1567 The logical conclusion would thus be to use bitmap fonts for the small
1568 sizes, and scalable fonts for the large sizes.
1569 Unfortunately, this is not a good idea, since bitmap fonts and scalable
1570 fonts are not designed to be used together, so the overall look of such
1571 a scheme would be bad.
1572 The best you can do is thus to try both schemes and decide for yourself
1576 \begin_layout Standard
1577 In the following, we will describe what to do if the text does not look
1579 We'll start with the most important parameters: DPI and font zoom.
1582 \begin_layout Subsubsection
1583 DPI setting and Font Zoom
1586 \begin_layout Standard
1587 LyX automatically tries to scale the fonts to look as close as the paper
1588 output size as possible, except for the so-called font zoom factor.
1591 \begin_layout Standard
1592 In order for this to work on all systems, it relies on the screen DPI (dots
1593 per inch) setting to be correct.
1594 The DPI setting for your system is autodetected by LyX using information
1595 provided by your system.
1596 You can check what LyX autodetects the DPI setting to, by running LyX as
1598 \begin_inset Flex CharStyle:Code
1601 \begin_layout Plain Layout
1610 \begin_layout Standard
1611 On many systems, this will not be correct, so you should check that it is
1613 On X11 systems, you can run
1614 \begin_inset Quotes eld
1618 \begin_inset Flex CharStyle:Code
1621 \begin_layout Plain Layout
1628 \begin_inset Quotes erd
1631 and write down what the DPI is for the resolution you use (this will be
1632 close to the value LyX detects).
1633 It is the number mentioned as
1634 \begin_inset Quotes eld
1638 \begin_inset Quotes erd
1642 Also write down the number of pixels you have in the width (the first number
1644 \begin_inset Quotes eld
1648 \begin_inset Quotes erd
1654 \begin_layout Standard
1655 Then get the good old ruler out of the closet, and measure the width of
1656 the visible screen-image on your monitor.
1657 Convert this measurement to inches if you used a centimeter ruler by dividing
1659 Now you can determine the correct DPI setting for your screen by dividing
1660 the number of pixels in the width by the width of the screen-image on the
1662 If this number is more than, say, 5 DPI from the detected value, you should
1663 either fix your system setup, or at least tell LyX that the DPI is different
1664 than the detected value.
1667 \begin_layout Standard
1668 If you can't fix system setup (which of course is best since other programs
1669 than LyX will benefit from this as well), you can tell LyX the correct
1671 \begin_inset Flex CharStyle:MenuItem
1674 \begin_layout Plain Layout
1683 \begin_layout Standard
1684 If the text is too small or too big for your taste, you should fiddle with
1685 the font zoom setting.
1686 This setting is used to scale the point size of the text.
1687 If your DPI setting is correct, and the font zoom setting is set to 100,
1688 this means that LyX will try to display the text exactly the same size
1689 as it will appear on the paper-output.
1690 If you set the zoom factor to 200, the text will try to be 2 times as big
1692 Of course, this will only happen if LyX can find a font that has the appropriat
1693 e size, which you can't count on.
1694 Since LyX is a WYSIWYM system anyways, this limitation isn't much of an
1698 \begin_layout Standard
1699 The default font zoom setting is 150, since a monitor is typically wider
1700 than a piece of paper, but you should try to fiddle with it through the
1702 \begin_inset Flex CharStyle:MenuItem
1705 \begin_layout Plain Layout
1707 \begin_inset space ~
1720 \begin_inset Flex CharStyle:MenuItem
1723 \begin_layout Plain Layout
1729 dialog to find a size that you like.
1730 When you've found a setting that seems to work nicely for you (tip: use
1732 \begin_inset Flex CharStyle:MenuItem
1735 \begin_layout Plain Layout
1745 button to keep the dialog open while you experiment), you can make this
1746 setting the default by using the
1747 \begin_inset Flex CharStyle:MenuItem
1750 \begin_layout Plain Layout
1763 \begin_layout Standard
1764 While it is often possible to find a suitable size for the text on the screen,
1765 this doesn't necessarily mean that the fonts are the best ones available
1767 In order to help you get the most out of your system, you can use the font
1768 definition commands to fine-tune the look of the text in greater detail
1772 \begin_layout Subsubsection
1773 Font definition commands
1776 \begin_layout Standard
1777 You can change LyX's screen fonts from within the
1778 \begin_inset Flex CharStyle:MenuItem
1781 \begin_layout Plain Layout
1788 The number of fonts that are available on different systems vary.
1792 \begin_layout Standard
1793 Before you go about scrapping a bitmap font because the larger sizes look
1795 \begin_inset Quotes eld
1799 \begin_inset Quotes erd
1802 , you should toggle the
1803 \begin_inset Flex CharStyle:Code
1806 \begin_layout Plain Layout
1813 This is only useful if you use bitmap fonts, because only these don't scale
1815 If you define this flag, LyX will only use the fixed font sizes that are
1816 available, and this guarantees that all bitmap fonts look good.
1817 However, the downside is that there will be a greater difference between
1818 the size of the fonts on screen and the size of fonts on paper because
1819 LyX will have to be satisfied with the closest available size, and not
1820 try to scale a size to fit.
1821 Also, you can risk that some logically different sizes, such as
1822 \begin_inset Flex CharStyle:MenuItem
1825 \begin_layout Plain Layout
1832 \begin_inset Flex CharStyle:MenuItem
1835 \begin_layout Plain Layout
1841 , will be mapped to the same screen font, making it hard for you to see
1842 the difference on screen.
1846 \begin_layout Standard
1847 One final note regarding the
1848 \begin_inset Flex CharStyle:Code
1851 \begin_layout Plain Layout
1857 flag: you should know that there is nothing wrong with using bitmap and
1858 scalable fonts at the same time for different purposes.
1859 For instance, it's common to use the scalable
1860 \begin_inset Quotes eld
1864 \begin_inset Quotes erd
1867 for the serif text together with a bitmap version of
1868 \begin_inset Quotes eld
1872 \begin_inset Quotes erd
1876 And you can safely select the
1877 \begin_inset Quotes eld
1881 \begin_inset Quotes erd
1884 button without worries: It will only apply to the Helvetica font.
1887 \begin_layout Standard
1888 Sometimes the artifacts introduced by use of the flag can be relieved by
1889 using the fine-detail screen font sizes which defines which point sizes
1890 the different logical font sizes correspond to.
1892 \begin_inset Flex CharStyle:Code
1895 \begin_layout Plain Layout
1901 to see exactly what concrete fonts the logical sizes map to, and try adjusting
1902 the corresponding entries in the
1903 \begin_inset Flex CharStyle:MenuItem
1906 \begin_layout Plain Layout
1912 dialog until you've managed to hit the nail and get the fonts you want.
1913 This can be hard to do, because LyX uses the DPI setting and the font zoom
1914 settings to calculate which exact screen font size to ask the X server
1915 for, thus obfuscating the mapping.
1916 If you can't make it by trial-and-error, you can make the process more
1917 transparent if you set both the DPI setting and font zoom settings to 100---eve
1918 n when this is known to be wrong.
1919 This will of course make your scalable fonts look weird, so use with care.
1922 \begin_layout Standard
1923 \begin_inset Branch OutDated
1926 \begin_layout Subsubsection
1930 \begin_layout Standard
1931 By default, LyX will use fonts meant to write Western European text, including
1932 all kinds of English.
1933 This is defined through the so-called
1942 If you want to use LyX to write for instance Eastern European text, Cyrillic
1943 or any other language not covered by the ISO-8859-1 font encoding, you
1944 can define a different one with the encoding setting.
1945 This requires you to have special fonts installed.
1947 \begin_inset Flex CharStyle:Code
1950 \begin_layout Plain Layout
1956 to see whether this is the case: check the
1957 \begin_inset Quotes eld
1961 \begin_inset Quotes erd
1965 \begin_inset Quotes eld
1969 \begin_inset Quotes erd
1972 fields for ISO-8859-X values different from ISO-8859-1, and search for
1973 one that contains the national characters of your language.
1974 If you find any, enter this encoding in the dialog.
1975 If not, go searching the Web for appropriate fonts.
1976 For the Qt frontend, it's recommended you use an iso646 font set.
1979 \begin_layout Standard
1980 When you've set LyX up to use a different font encoding, you should also
1981 consider changing the font used by dialog windows in LyX.
1983 \begin_inset Flex CharStyle:MenuItem
1986 \begin_layout Plain Layout
1988 \begin_inset space ~
1992 \begin_inset space ~
2000 dialog will not be understandable unless you tell LyX to use a different
2002 By default the menu font is set to
2003 \begin_inset Flex CharStyle:Code
2006 \begin_layout Plain Layout
2007 -*-helvetica-medium-r
2012 , but often Helvetica is not available in the font encoding you need, so
2013 the dialog allows this to be changed.
2016 \begin_layout Standard
2017 As you can see, there are quite a few options that can be used to fine tune
2018 the look of your fonts.
2019 This should not scare you from fiddling with the settings, because after
2020 all, you will hopefully be using LyX for many hours in the future.
2021 And contrary to real WYSIWYG word processors where you are tied to using
2022 fonts that have to look good both on paper and on screen, LyX gives you
2023 the possibility of using fonts that are designed to look good on the screen
2024 while using a different set of fonts to look good on paper.
2032 \begin_layout Subsection
2034 \begin_inset CommandInset label
2043 \begin_layout Standard
2044 The appearance of both the menu and toolbar may both be changed using the
2046 \begin_inset Flex CharStyle:MenuItem
2049 \begin_layout Plain Layout
2056 Simply select a different
2057 \begin_inset Flex CharStyle:Code
2060 \begin_layout Plain Layout
2067 \begin_inset Flex CharStyle:MenuItem
2070 \begin_layout Plain Layout
2071 Look & Feel\SpecialChar \menuseparator
2078 You can customize the interface by copying one of the
2079 \begin_inset Flex CharStyle:Code
2082 \begin_layout Plain Layout
2089 \begin_inset Flex CharStyle:Code
2092 \begin_layout Plain Layout
2099 \begin_inset Flex CharStyle:Code
2102 \begin_layout Plain Layout
2109 You may have to restart LyX for these changes to take effect.
2112 \begin_layout Standard
2114 \begin_inset Flex CharStyle:Code
2117 \begin_layout Plain Layout
2123 files is straightforward: have a look at
2124 \begin_inset Flex CharStyle:Code
2127 \begin_layout Plain Layout
2135 \begin_inset Flex CharStyle:Code
2138 \begin_layout Plain Layout
2145 \begin_inset Flex CharStyle:Code
2148 \begin_layout Plain Layout
2155 \begin_inset Flex CharStyle:Code
2158 \begin_layout Plain Layout
2164 entries must be ended with an explicit
2165 \begin_inset Flex CharStyle:Code
2168 \begin_layout Plain Layout
2176 \begin_inset Flex CharStyle:Code
2179 \begin_layout Plain Layout
2186 \begin_inset Flex CharStyle:Code
2189 \begin_layout Plain Layout
2196 \begin_inset Flex CharStyle:Code
2199 \begin_layout Plain Layout
2206 \begin_inset Flex CharStyle:Code
2209 \begin_layout Plain Layout
2216 \begin_inset Flex CharStyle:Code
2219 \begin_layout Plain Layout
2225 s and in the case of the
2226 \begin_inset Quotes eld
2230 \begin_inset Quotes erd
2234 \begin_inset Flex CharStyle:Code
2237 \begin_layout Plain Layout
2244 One small word of warning.
2246 \begin_inset Flex CharStyle:Code
2249 \begin_layout Plain Layout
2255 s may be inserted in a
2256 \begin_inset Flex CharStyle:Code
2259 \begin_layout Plain Layout
2266 \begin_inset Flex CharStyle:Code
2269 \begin_layout Plain Layout
2275 , but they are defined as
2276 \begin_inset Flex CharStyle:Code
2279 \begin_layout Plain Layout
2286 \begin_inset Flex CharStyle:Code
2289 \begin_layout Plain Layout
2297 \begin_inset Flex CharStyle:Code
2300 \begin_layout Plain Layout
2306 tag is used to insert context-dependent information that is generated by
2308 Unfortunately, the available tags are not documented outside the source
2312 \begin_layout Standard
2313 Note that, as of LyX 1.6, there are extensive context menus, normally accessed
2315 These are defined in the
2316 \begin_inset Flex CharStyle:Code
2319 \begin_layout Plain Layout
2328 \begin_layout Section
2332 \begin_layout Standard
2333 The settings in this section are used to customise the behavior of the LyX
2337 \begin_layout Subsection
2338 Fullscreen mode and toggling window elements
2341 \begin_layout Standard
2342 Fullscreen mode switch is done by internal call of
2343 \begin_inset Flex CharStyle:Code
2346 \begin_layout Plain Layout
2347 ui-toggle fullscreen
2353 Note that except standard switches in the preference dialog additional
2355 \begin_inset Flex CharStyle:Code
2358 \begin_layout Plain Layout
2365 \begin_inset Flex CharStyle:Code
2368 \begin_layout Plain Layout
2374 can be used for toggling.
2376 \begin_inset Flex CharStyle:Code
2379 \begin_layout Plain Layout
2380 toolbar-toggle <toolbar>
2385 LFUN for advanced settings of toolbars.
2388 \begin_layout Subsection
2389 \begin_inset CommandInset label
2398 \begin_layout Standard
2399 Bindings are used to associate a LyX function to a key.
2400 Several prepackaged binding files are available: a CUA set of bindings
2401 (familiar as the typical set of PC and CDE set of keyboard shortcuts),
2402 an Emacs set of bindings, for those of us who follow the One True Way and
2403 refuse to lower our standards,
2407 \begin_layout Plain Layout
2408 I'm kidding here, of course!
2413 as well as specialty bindings (broadway and hollywood) and bindings for
2414 languages other than English.
2415 You can select your binding in the
2416 \begin_inset Flex CharStyle:MenuItem
2419 \begin_layout Plain Layout
2420 Editing\SpecialChar \menuseparator
2429 \begin_inset Flex CharStyle:MenuItem
2432 \begin_layout Plain Layout
2437 ools\SpecialChar \menuseparator
2453 \begin_layout Standard
2454 If, however, you'd like to customise the bindings to your own exacting tastes,
2455 then there are two ways to proceed.
2456 The first, and older method, is to copy a file from
2457 \begin_inset Flex CharStyle:Code
2460 \begin_layout Plain Layout
2467 \begin_inset Flex CharStyle:Code
2470 \begin_layout Plain Layout
2476 and modify that in a text editor.
2477 Don't forget to select this file in
2478 \begin_inset Flex CharStyle:MenuItem
2481 \begin_layout Plain Layout
2482 Editing\SpecialChar \menuseparator
2489 The second method is to use the shortcut editor, which you will also find
2491 \begin_inset Flex CharStyle:MenuItem
2494 \begin_layout Plain Layout
2495 Editing\SpecialChar \menuseparator
2502 The changes you make here will be stored at
2503 \begin_inset Flex CharStyle:Code
2506 \begin_layout Plain Layout
2507 UserDir/bind/user.bind
2515 \begin_layout Standard
2516 LyX supports internationalization of the user interface (see Chapter
2517 \begin_inset space ~
2521 \begin_inset CommandInset ref
2523 reference "chap:i18n"
2532 is set, LyX will try to use bindfiles by prepending the standard language
2534 For example, you can put a translated copy of some standard bind file in
2536 \begin_inset Flex CharStyle:Code
2539 \begin_layout Plain Layout
2545 directory, and LyX will use it automatically.
2548 \begin_layout Standard
2550 \begin_inset Flex CharStyle:Code
2553 \begin_layout Plain Layout
2559 files is straightforward:
2562 \begin_layout LyX-Code
2565 bind ``<key combination>'' ``<lyx-function>
2566 \begin_inset Quotes erd
2572 \begin_layout Standard
2573 Both key combination and lyx-function (including any arguments) must be
2574 enclosed in "double quotes".
2575 The LyX functions are partially documented on listed on the
2576 \begin_inset CommandInset href
2579 target "http://wiki.lyx.org/LyX/LyxFunctions"
2584 A major effort is presently underway to improve this documentation.
2587 \begin_layout Section
2588 \begin_inset CommandInset label
2590 name "sec:converters-etc"
2597 \begin_layout Standard
2598 LyX has a powerful mechanism to convert to and from any file format using
2603 \begin_layout Subsection
2604 \begin_inset CommandInset label
2613 \begin_layout Standard
2614 The first step is to define your file formats if they are not already defined.
2616 \begin_inset Flex CharStyle:MenuItem
2619 \begin_layout Plain Layout
2620 Tools\SpecialChar \menuseparator
2621 Preferences\SpecialChar \menuseparator
2622 File Handling\SpecialChar \menuseparator
2630 \begin_inset Flex CharStyle:MenuItem
2633 \begin_layout Plain Layout
2634 New\SpecialChar \ldots{}
2640 button to define your new format.
2642 \begin_inset Flex CharStyle:MenuItem
2645 \begin_layout Plain Layout
2651 field contains the named used to identify the format in the GUI.
2653 \begin_inset Flex CharStyle:MenuItem
2656 \begin_layout Plain Layout
2662 is used to identify the format interally.
2663 You will also need to enter a file extension.
2664 These are all required.
2666 \begin_inset Flex CharStyle:MenuItem
2669 \begin_layout Plain Layout
2675 field is used to provide a keyboard shortcut on the menus.
2676 (For example, pressing
2677 \begin_inset Flex CharStyle:MenuItem
2680 \begin_layout Plain Layout
2687 \begin_inset Flex CharStyle:MenuItem
2690 \begin_layout Plain Layout
2691 View\SpecialChar \menuseparator
2700 \begin_layout Standard
2702 \begin_inset Flex CharStyle:MenuItem
2705 \begin_layout Plain Layout
2712 \begin_inset Flex CharStyle:MenuItem
2715 \begin_layout Plain Layout
2722 For example, you might want to use
2723 \begin_inset Flex CharStyle:MenuItem
2726 \begin_layout Plain Layout
2732 to view PostScript files.
2733 You can enter the command needed to start the program in the corresponding
2735 In defining this command, you can use the four variables listed in the
2737 The viewer is launched when you view an image in LyX or use the
2738 \begin_inset Flex CharStyle:MenuItem
2741 \begin_layout Plain Layout
2748 The editor is for example launched when you press the
2749 \begin_inset Flex CharStyle:MenuItem
2752 \begin_layout Plain Layout
2759 \begin_inset Flex CharStyle:MenuItem
2762 \begin_layout Plain Layout
2769 \begin_inset Flex CharStyle:MenuItem
2772 \begin_layout Plain Layout
2781 \begin_layout Standard
2783 \begin_inset Flex CharStyle:MenuItem
2786 \begin_layout Plain Layout
2792 option tells LyX that a format is suitable for document export.
2793 If this is is set and if a suitable conversion route exists (see
2794 \begin_inset CommandInset ref
2796 reference "sub:Converters"
2800 ), the format will appear in the
2801 \begin_inset Flex CharStyle:MenuItem
2804 \begin_layout Plain Layout
2805 File\SpecialChar \menuseparator
2812 The format will also appear in the
2813 \begin_inset Flex CharStyle:MenuItem
2816 \begin_layout Plain Layout
2822 menu if a viewer is specified for the format.
2823 Pure image formats, such as
2824 \begin_inset Flex CharStyle:Code
2827 \begin_layout Plain Layout
2833 , should not use this option.
2834 Formats that can both represent vector graphics and documents like
2835 \begin_inset Flex CharStyle:Code
2838 \begin_layout Plain Layout
2847 \begin_layout Standard
2849 \begin_inset Flex CharStyle:MenuItem
2852 \begin_layout Plain Layout
2853 Vector graphics format
2858 tells LyX that a format can contain vector graphics.
2859 This information is used to determine the target format of included graphics
2861 \begin_inset Flex CharStyle:MenuItem
2864 \begin_layout Plain Layout
2871 Included graphics may need to be converted to either
2872 \begin_inset Flex CharStyle:MenuItem
2875 \begin_layout Plain Layout
2882 \begin_inset Flex CharStyle:MenuItem
2885 \begin_layout Plain Layout
2892 \begin_inset Flex CharStyle:MenuItem
2895 \begin_layout Plain Layout
2902 \begin_inset Flex CharStyle:MenuItem
2905 \begin_layout Plain Layout
2911 cannot handle other image formats.
2912 If an included graphic is not already in
2913 \begin_inset Flex CharStyle:MenuItem
2916 \begin_layout Plain Layout
2923 \begin_inset Flex CharStyle:MenuItem
2926 \begin_layout Plain Layout
2933 \begin_inset Flex CharStyle:MenuItem
2936 \begin_layout Plain Layout
2942 format, it is converted to
2943 \begin_inset Flex CharStyle:MenuItem
2946 \begin_layout Plain Layout
2952 if the vector format option is set, and otherwise to
2953 \begin_inset Flex CharStyle:MenuItem
2956 \begin_layout Plain Layout
2965 \begin_layout Subsection
2969 \begin_layout Standard
2970 Since all conversions from one format to another take place in LyX's temporary
2971 directory, it is sometimes necessary to modify a file before copying it
2972 to the temporary directory in order that the conversion may be performed.
2976 \begin_layout Plain Layout
2977 For example, the file may refer to other files---images, for example---using
2978 relative filenames, and these may become invalid when the file is copied
2979 to the temporary directory.
2984 This is done by a Copier: It copies a file to (or from) the temporary directory
2985 and may modify it in the process.
2988 \begin_layout Standard
2989 The definitions of the copiers may use four variables:
2992 \begin_layout Labeling
2993 \labelwidthstring 00.00.0000
2994 \begin_inset Flex CharStyle:Code
2997 \begin_layout Plain Layout
3003 The LyX system directory (e.
3004 \begin_inset space \thinspace{}
3008 \begin_inset space ~
3012 \begin_inset Flex CharStyle:MenuItem
3015 \begin_layout Plain Layout
3024 \begin_layout Labeling
3025 \labelwidthstring 00.00.0000
3026 \begin_inset Flex CharStyle:Code
3029 \begin_layout Plain Layout
3038 \begin_layout Labeling
3039 \labelwidthstring 00.00.0000
3040 \begin_inset Flex CharStyle:Code
3043 \begin_layout Plain Layout
3052 \begin_layout Labeling
3053 \labelwidthstring 00.00.0000
3054 \begin_inset Flex CharStyle:Code
3057 \begin_layout Plain Layout
3066 \begin_layout Standard
3067 The latter is to be given in a form suitable for inclusion in a LaTeX's
3074 command and is relevant only when exporting files suitable for such inclusion.
3077 \begin_layout Standard
3078 Copiers can be used to do almost anything with output files.
3079 For example, suppose you want generated pdf files to be copied to a special
3081 \begin_inset Flex CharStyle:Code
3084 \begin_layout Plain Layout
3091 Then you could write a shell script such as this one:
3094 \begin_layout Standard
3095 \begin_inset listings
3099 \begin_layout Plain Layout
3104 \begin_layout Plain Layout
3109 \begin_layout Plain Layout
3111 TOFILE=`basename $2`
3114 \begin_layout Plain Layout
3116 cp $FROMFILE /home/you/pdf/$TOFILE
3121 Save that in your local LyX directory---say,
3122 \begin_inset Flex CharStyle:Code
3125 \begin_layout Plain Layout
3126 /home/you/.lyx/scripts/pdfcopier.sh
3131 ---and make it executable, if you need to do so on your platform.
3133 \begin_inset Flex CharStyle:MenuItem
3136 \begin_layout Plain Layout
3137 Tools\SpecialChar \menuseparator
3144 \begin_inset Flex CharStyle:MenuItem
3147 \begin_layout Plain Layout
3153 format---or one of the other pdf formats---and enter
3154 \begin_inset Flex CharStyle:Code
3157 \begin_layout Plain Layout
3158 pdfcopier.sh $$i $$o
3164 \begin_inset Flex CharStyle:MenuItem
3167 \begin_layout Plain Layout
3177 \begin_layout Standard
3178 Copiers are used by LyX in various of its own conversions.
3179 For example, if appropriate programs are found, LyX will automatically
3180 install copiers for the
3181 \begin_inset Flex CharStyle:MenuItem
3184 \begin_layout Plain Layout
3191 \begin_inset Flex CharStyle:MenuItem
3194 \begin_layout Plain Layout
3196 \begin_inset space ~
3205 When these formats are exported, the copier sees that not just the main
3206 HTML file but various associated files (style files, images, etc.) are also
3208 All these files are written to a subdirectory of the directory in which
3209 the original LyX file was found.
3213 \begin_layout Plain Layout
3214 This copier can be customized.
3216 \begin_inset Quotes eld
3220 \begin_inset Quotes erd
3223 argument takes a comma-separated list of extensions to be copied; if it
3224 is omitted, all files will be copied.
3226 \begin_inset Quotes eld
3230 \begin_inset Quotes erd
3233 argument determines the extension added to the generated directory.
3235 \begin_inset Quotes eld
3239 \begin_inset Flex CharStyle:MenuItem
3242 \begin_layout Plain Layout
3249 \begin_inset Quotes erd
3252 , so HTML generated from
3253 \begin_inset Flex CharStyle:MenuItem
3256 \begin_layout Plain Layout
3257 /path/to/filename.lyx
3263 \begin_inset Flex CharStyle:MenuItem
3266 \begin_layout Plain Layout
3267 /path/to/filename.html.LyXconv
3281 \begin_layout Subsection
3282 \begin_inset CommandInset label
3284 name "sub:Converters"
3291 \begin_layout Standard
3292 You can define your own Converters to, uhh, convert files between different
3295 \begin_inset Flex CharStyle:MenuItem
3298 \begin_layout Plain Layout
3299 Tools\SpecialChar \menuseparator
3300 Preferences\SpecialChar \menuseparator
3301 File Handling\SpecialChar \menuseparator
3310 \begin_layout Standard
3311 To define a new converter, select the
3312 \begin_inset Flex CharStyle:MenuItem
3315 \begin_layout Plain Layout
3317 \begin_inset space ~
3326 \begin_inset space \thinspace{}
3330 \begin_inset Flex CharStyle:MenuItem
3333 \begin_layout Plain Layout
3335 \begin_inset space ~
3343 from the drop-down lists, enter the command needed for the conversion,
3345 \begin_inset Flex CharStyle:MenuItem
3348 \begin_layout Plain Layout
3355 Several variables can be used in the definition of converters:
3358 \begin_layout Labeling
3359 \labelwidthstring 00.00.0000
3360 \begin_inset Flex CharStyle:Code
3363 \begin_layout Plain Layout
3369 The LyX system directory
3372 \begin_layout Labeling
3373 \labelwidthstring 00.00.0000
3374 \begin_inset Flex CharStyle:Code
3377 \begin_layout Plain Layout
3386 \begin_layout Labeling
3387 \labelwidthstring 00.00.0000
3388 \begin_inset Flex CharStyle:Code
3391 \begin_layout Plain Layout
3400 \begin_layout Labeling
3401 \labelwidthstring 00.00.0000
3402 \begin_inset Flex CharStyle:Code
3405 \begin_layout Plain Layout
3411 The base filename of the input file (i.e., without the extension)
3414 \begin_layout Labeling
3415 \labelwidthstring 00.00.0000
3416 \begin_inset Flex CharStyle:Code
3419 \begin_layout Plain Layout
3425 The path to the input file
3428 \begin_layout Standard
3430 \begin_inset Flex CharStyle:MenuItem
3433 \begin_layout Plain Layout
3435 \begin_inset space ~
3443 field you can enter the following flags, separated by commas:
3446 \begin_layout Labeling
3447 \labelwidthstring 00.00.0000
3448 \begin_inset Flex CharStyle:Code
3451 \begin_layout Plain Layout
3457 This converter runs some form of LaTeX.
3458 This will make LyX's LaTeX error logs available.
3461 \begin_layout Labeling
3462 \labelwidthstring 00.00.0000
3463 \begin_inset Flex CharStyle:Code
3466 \begin_layout Plain Layout
3473 \begin_inset Flex CharStyle:MenuItem
3476 \begin_layout Plain Layout
3482 file for the conversion.
3485 \begin_layout Labeling
3486 \labelwidthstring 00.00.0000
3487 \begin_inset Flex CharStyle:Code
3490 \begin_layout Plain Layout
3499 \begin_layout Standard
3500 The following three flags are not really flags at all because they take
3502 \begin_inset Flex CharStyle:MenuItem
3505 \begin_layout Plain Layout
3507 \begin_inset space ~
3511 \begin_inset space ~
3522 \begin_layout Labeling
3523 \labelwidthstring 00.00.0000
3524 \begin_inset Flex CharStyle:Code
3527 \begin_layout Plain Layout
3533 If set, the converter's standard error will be redirected to a file
3534 \begin_inset Flex CharStyle:Code
3537 \begin_layout Plain Layout
3543 , and the script given as argument will be run as:
3544 \begin_inset Flex CharStyle:Code
3547 \begin_layout Plain Layout
3548 script <infile.out >infile.log
3554 The argument may contain
3555 \begin_inset Flex CharStyle:Code
3558 \begin_layout Plain Layout
3567 \begin_layout Labeling
3568 \labelwidthstring 00.00.0000
3569 \begin_inset Flex CharStyle:Code
3572 \begin_layout Plain Layout
3578 The name of the directory in which the converter will dump the generated
3580 LyX will not create this directory, and it does not copy anything into
3581 it, though it will copy this directory to the destination.
3582 The argument may contain
3583 \begin_inset Flex CharStyle:Code
3586 \begin_layout Plain Layout
3592 , which will be replaced by the basename of the input and output files,
3593 respectively, when the directory is copied.
3594 \begin_inset Newline newline
3597 Note that resultdir and usetempdir make no sense together.
3598 The latter will be ignored if the former is given.
3601 \begin_layout Labeling
3602 \labelwidthstring 00.00.0000
3603 \begin_inset Flex CharStyle:Code
3606 \begin_layout Plain Layout
3612 Determines the output filename and may, contain
3613 \begin_inset Flex CharStyle:Code
3616 \begin_layout Plain Layout
3623 Sensible only with resultdir and optional even then; if not given, it defaults
3627 \begin_layout Standard
3628 None of these last three are presently used in any of the converters that
3629 are installed with LyX.
3633 \begin_layout Standard
3634 You do not have to define converters between all the formats between which
3635 you want to convert.
3636 For example, you will note that there is no `LyX to PostScript®' converter,
3637 but LyX will export PostScript®.
3638 It does so by first creating a LaTeX file (no converter needs to be defined
3639 for this) which is then converted to DVI using the `LaTeX to DVI' converter,
3640 and finally converting the resulting DVI file to PostScript®.
3641 LyX finds such `chains' of converters automatically, and it will always
3642 choose the shortest possible chain.
3643 You can, though, still define multiple conversion methods between file
3645 For example, the standard LyX configuration provides three ways to convert
3646 LaTeX to PDF: Directly, using
3647 \begin_inset Flex CharStyle:MenuItem
3650 \begin_layout Plain Layout
3656 ; via (DVI and) PostScript®, using
3657 \begin_inset Flex CharStyle:MenuItem
3660 \begin_layout Plain Layout
3667 \begin_inset Flex CharStyle:MenuItem
3670 \begin_layout Plain Layout
3677 To define such alternate chains, you must define multiple target `file
3678 formats', as described in section
3679 \begin_inset CommandInset ref
3681 reference "sub:Formats"
3686 For example, in the standard configuration, the formats named
3687 \begin_inset Flex CharStyle:MenuItem
3690 \begin_layout Plain Layout
3697 \begin_inset Flex CharStyle:MenuItem
3700 \begin_layout Plain Layout
3707 \begin_inset Flex CharStyle:MenuItem
3710 \begin_layout Plain Layout
3716 are defined, all of which share the extension
3717 \begin_inset Flex CharStyle:MenuItem
3720 \begin_layout Plain Layout
3726 , and which correspond to the conversion methods just mentioned.
3729 \begin_layout Section
3733 \begin_layout Standard
3734 The settings in this section affect the output LyX produces.
3737 \begin_layout Subsection
3738 Plain text export options
3741 \begin_layout Standard
3743 There are a couple of commands that can be used to
3744 \begin_inset Quotes eld
3748 \begin_inset Quotes erd
3751 exported plain text files.
3752 Note that LyX automatically detects and tries to use the best settings
3753 for your system at installation time, but you can modify them in the
3754 \begin_inset Flex CharStyle:MenuItem
3757 \begin_layout Plain Layout
3758 Output\SpecialChar \menuseparator
3764 dialog if you disagree with its interpretation.
3767 \begin_layout Description
3768 \begin_inset Flex CharStyle:Code
3771 \begin_layout Plain Layout
3777 This option defines the command used to produce better plain text tables
3779 \begin_inset Flex CharStyle:Code
3782 \begin_layout Plain Layout
3788 UNIX-commands (refer to their manpages for more information about them).
3789 Setting this as empty tells LyX to use the internal (inferior) formatter.
3792 \begin_layout Description
3793 \begin_inset Flex CharStyle:Code
3796 \begin_layout Plain Layout
3802 With this command you can set the default line length of the plain text
3804 Setting it to 0 means that no line breaks will be inserted except between
3805 paragraphs and the like.
3808 \begin_layout Section
3812 \begin_layout Standard
3813 There are many other configuration options that can be used to customize
3815 Most of them are sufficiently self-explanatory that we have not felt it
3816 necessary to document them here.
3818 \begin_inset CommandInset href
3820 name "mailing lists"
3821 target "http://www.lyx.org/mailing.php"
3825 if you need some more information.
3828 \begin_layout Chapter
3829 Internationalizing LyX
3830 \begin_inset CommandInset label
3839 \begin_layout Standard
3840 LyX supports using a translated interface.
3841 Last time we checked, LyX provided text in thirty languages.
3842 The language of choice is called your
3847 (For further reading on locale settings, see also the documentation for
3848 locale that comes with your operating system.
3849 For Linux, the manual page for
3850 \begin_inset Flex CharStyle:Code
3853 \begin_layout Plain Layout
3859 could be a good place to start).
3862 \begin_layout Standard
3863 Notice that these translations will work, but do contain a few flaws.
3864 In particular, all dialogs have been designed with the English text in
3865 mind, which means that some of the translated text will be too large to
3866 fit within the space allocated.
3867 This is only a display problem and will not cause any harm.
3868 Also, you will find that some of the translations do not define shortcut
3869 keys for everything.
3870 Sometimes, there are simply not enough free letters to do it.
3871 Other times, the translator just hasn't got around to doing it yet.
3872 Our localization team, which you may wish to join,
3876 \begin_layout Plain Layout
3877 If you are a fluent speaker of a language other than English, joining these
3878 teams is a great way to give back to the LyX community!
3883 will of course try to fix these shortcomings in future versions of LyX.
3886 \begin_layout Section
3890 \begin_layout Subsection
3891 Translating the graphical user interface (text messages).
3894 \begin_layout Standard
3896 \begin_inset Flex CharStyle:Code
3899 \begin_layout Plain Layout
3905 library to handle the internationalization of the interface.
3906 To have LyX speak your favorite language in all menus and dialogs, you
3908 \begin_inset Flex CharStyle:Code
3911 \begin_layout Plain Layout
3917 -file for that language.
3918 When this is available, you'll have to generate a
3919 \begin_inset Flex CharStyle:Code
3922 \begin_layout Plain Layout
3928 -file from it and install the
3929 \begin_inset Flex CharStyle:Code
3932 \begin_layout Plain Layout
3939 The process of doing all of this is explained in the documentation for
3941 \begin_inset Flex CharStyle:Code
3944 \begin_layout Plain Layout
3951 It is possible to do this just for yourself, but if you're going to do
3952 it, you might as well share the results of your labors with the rest of
3954 Send a message to the LyX developers' list for more information about how
3958 \begin_layout Standard
3959 In short, this is what you should do (xx denotes the language code):
3962 \begin_layout Itemize
3963 Check out the LyX source code.
3965 \begin_inset CommandInset href
3967 name "information on the web"
3968 target "http://www.lyx.org/devel/cvs.php"
3975 \begin_layout Itemize
3977 \begin_inset Flex CharStyle:Code
3980 \begin_layout Plain Layout
3986 to the folder of the
3987 \begin_inset Flex CharStyle:Code
3990 \begin_layout Plain Layout
3998 \begin_inset Flex CharStyle:Code
4001 \begin_layout Plain Layout
4009 \begin_inset Flex CharStyle:Code
4012 \begin_layout Plain Layout
4018 doesn't exist anywhere, it can be remade with the console command
4019 \begin_inset Flex CharStyle:Code
4022 \begin_layout Plain Layout
4028 in that directory, or you can use an existing po-file for some other language
4032 \begin_layout Itemize
4034 \begin_inset Flex CharStyle:Code
4037 \begin_layout Plain Layout
4047 \begin_layout Plain Layout
4048 This is just a text file, so it can be edited in any text editor.
4049 But there are also specialized programs that support such editing, such
4054 (for all platforms) or
4063 contains a `mode' for editing
4064 \begin_inset Flex CharStyle:Code
4067 \begin_layout Plain Layout
4078 For some menu- and widget-labels, there are also shortcut keys that should
4080 Those keys are marked after a `|', and should be translated according to
4081 the words and phrases of the language.
4082 You should also fill also out the information at the beginning of the new
4084 \begin_inset Flex CharStyle:Code
4087 \begin_layout Plain Layout
4093 -file with your email-address, etc., so people know where to reach you with
4094 suggestions and entertaining flames.
4097 \begin_layout Standard
4098 If you are just doing this on your own, then:
4101 \begin_layout Itemize
4103 \begin_inset Flex CharStyle:Code
4106 \begin_layout Plain Layout
4113 This can be done with
4114 \begin_inset Flex CharStyle:Code
4117 \begin_layout Plain Layout
4118 msgfmt -o xx.mo < xx.po
4126 \begin_layout Itemize
4128 \begin_inset Flex CharStyle:Code
4131 \begin_layout Plain Layout
4137 -file to your locale-tree, at the correct directory for application messages
4142 xx, and under the name
4143 \begin_inset Flex CharStyle:Code
4146 \begin_layout Plain Layout
4154 \begin_inset Flex CharStyle:Code
4157 \begin_layout Plain Layout
4158 /usr/local/share/locale/xx/LC_MESSAGES/lyx.mo
4168 \begin_layout Standard
4169 As said, however, it would be best if the new
4170 \begin_inset Flex CharStyle:Code
4173 \begin_layout Plain Layout
4179 -file could be added to the LyX distribution, so others can use it.
4180 Adding it involves making additional changes to LyX.
4181 So send an email to the developers' mailing list if you're interested in
4185 \begin_layout Subsubsection
4189 \begin_layout Standard
4190 Sometimes it turns out that one English message needs to be translated into
4191 different messages in the target language.
4192 One example is the message
4193 \begin_inset Flex CharStyle:Code
4196 \begin_layout Plain Layout
4202 which has the German translation
4210 , depending upon exactly what the English
4211 \begin_inset Quotes eld
4215 \begin_inset Quotes erd
4220 \begin_inset Flex CharStyle:Code
4223 \begin_layout Plain Layout
4229 does not handle such ambigous translations.
4230 Therefore you have to add some context information to the message: Instead
4232 \begin_inset Flex CharStyle:Code
4235 \begin_layout Plain Layout
4242 \begin_inset Flex CharStyle:Code
4245 \begin_layout Plain Layout
4246 To[[as in 'From format x to format y']]
4252 \begin_inset Flex CharStyle:Code
4255 \begin_layout Plain Layout
4256 To[[as in 'From page x to page y']].
4261 Now the two occurences of
4262 \begin_inset Flex CharStyle:Code
4265 \begin_layout Plain Layout
4272 \begin_inset Flex CharStyle:Code
4275 \begin_layout Plain Layout
4281 and can be translated correctly to
4292 \begin_layout Standard
4293 Of course the context information needs to be stripped off the original
4294 message when no translation is used.
4295 Therefore you have to put it in double square brackets at the end of the
4296 message (see the example above).
4297 The translation mechanism of LyX ensures that everything in double square
4298 brackets at the end of messages is removed before displaying the message.
4301 \begin_layout Subsection
4302 Translating the documentation.
4305 \begin_layout Standard
4306 The online documentation (in the
4307 \begin_inset Flex CharStyle:MenuItem
4310 \begin_layout Plain Layout
4320 -menu) can (and should!) be translated.
4321 If there are translated versions of the documentation available
4325 \begin_layout Plain Layout
4326 As of March 2008, at least some of the documents have been translated into
4327 fourteen languages, with the Tutorial available in a few more.
4332 and the locale is set accordingly, these will be used automagically by
4334 LyX looks for translated versions as
4335 \begin_inset Flex CharStyle:Code
4338 \begin_layout Plain Layout
4339 LyXDir/doc/xx_DocName.lyx
4345 \begin_inset Flex CharStyle:Code
4348 \begin_layout Plain Layout
4354 is the code for the language currently in use.
4355 If there are no translated documents, the default English versions will
4357 Note that the translated versions must have the same filenames (
4358 \begin_inset Flex CharStyle:Code
4361 \begin_layout Plain Layout
4367 above) as the original.
4368 If you feel up to translating the documentation (an excellent way to proof-read
4369 the original documentation by the way!), there are a few things you should
4373 \begin_layout Itemize
4375 \begin_inset Flex CharStyle:Code
4378 \begin_layout Plain Layout
4384 , the guide to writing LyX documentation.
4385 Pay special attention to the translator's section.
4388 \begin_layout Itemize
4389 Check out the documentation translation web page at
4390 \begin_inset CommandInset href
4392 name "http://www.devel.lyx.org"
4393 target "http://www.devel.lyx.org"
4398 That way, you can find out which (if any) documents have already been translate
4399 d into your language.
4400 You can also find out who (if anyone) is organizing the effort to translate
4401 the documentation into your language.
4402 If no one is organizing the effort, please let us know that you're interested.
4405 \begin_layout Standard
4406 Once you get to actually translating, here's a few hints for you that may
4410 \begin_layout Itemize
4411 Join the documentation team! There is information on how to do that in
4412 \begin_inset Flex CharStyle:Code
4415 \begin_layout Plain Layout
4422 \begin_inset Flex CharStyle:MenuItem
4425 \begin_layout Plain Layout
4430 elp\SpecialChar \menuseparator
4440 ), which by the way is the first document you should translate.
4443 \begin_layout Itemize
4444 Learn the typographic conventions for the language you are translating to.
4445 Typography is an ancient art and over the centuries, a great variety of
4446 conventions have developed throughout different parts of the world.
4447 Also study the professional terminology amongst typographers in your country.
4448 Inventing your own terminology will only confuse the users.
4451 (Warning! Typography is addictive!)
4454 \begin_layout Itemize
4455 Make a copy of the document.
4456 This will be your working copy.
4457 You can use this as your personal translated help-file by placing it in
4459 \begin_inset Flex CharStyle:Code
4462 \begin_layout Plain Layout
4471 \begin_layout Itemize
4472 Sometimes the original document (from the LyX-team) will be updated.
4473 Use the source viewer at
4474 \begin_inset CommandInset href
4476 name "http://www.lyx.org/trac/timeline"
4477 target "http://www.lyx.org/trac/timeline"
4481 to see what has been changed.
4482 That way you can easily see which parts of the translated document need
4486 \begin_layout Standard
4487 If you ever find an error in the original document, fix it and notify the
4488 rest of the documentation team of the changes! (You didn't forget to join
4489 the documentation team, did you?)
4492 \begin_layout Standard
4493 \begin_inset Branch OutDated
4496 \begin_layout Section
4497 International Keyboard Support
4500 \begin_layout Standard
4503 [Editor's Note: The following section is by
4511 It needs to be fixed to conform to the new Documentation Style sheet and
4512 to make use of the new v1.0 features.
4513 The whole thing also needs to be merged with the section following it.-jw
4514 It may also be badly out of date.-rh (2008)]
4517 \begin_layout Subsection
4518 Defining Own Keymaps: Keymap File Format
4521 \begin_layout Standard
4522 Let's look at a keyboard definition file a little closer.
4523 It is a plain text file defining
4526 \begin_layout Itemize
4527 key-to-key or key-to-string translations
4530 \begin_layout Itemize
4534 \begin_layout Itemize
4535 dead keys exceptions
4538 \begin_layout Standard
4539 To define key-to-key or key-to-string translation, use this command:
4542 \begin_layout Quotation
4543 \begin_inset Flex CharStyle:Code
4546 \begin_layout Plain Layout
4555 \begin_inset Flex CharStyle:Code
4558 \begin_layout Plain Layout
4567 \begin_layout Standard
4569 \begin_inset Flex CharStyle:Code
4572 \begin_layout Plain Layout
4578 is the key to be translated and
4579 \begin_inset Flex CharStyle:Code
4582 \begin_layout Plain Layout
4588 is the string to be inserted into the document.
4589 To define dead keys, use:
4592 \begin_layout Quotation
4593 \begin_inset Flex CharStyle:Code
4596 \begin_layout Plain Layout
4605 \begin_inset Flex CharStyle:Code
4608 \begin_layout Plain Layout
4617 \begin_layout Standard
4619 \begin_inset Flex CharStyle:Code
4622 \begin_layout Plain Layout
4628 is a keyboard key and
4629 \begin_inset Flex CharStyle:Code
4632 \begin_layout Plain Layout
4639 The following dead keys are supported (shortcut name is in parentheses):
4642 \begin_layout Quotation
4646 \begin_inset space \hfill{}
4652 \begin_layout Quotation
4654 \begin_inset space \hfill{}
4660 \begin_layout Quotation
4662 \begin_inset space \hfill{}
4668 \begin_layout Quotation
4670 \begin_inset space \hfill{}
4676 \begin_layout Quotation
4678 \begin_inset space \hfill{}
4684 \begin_layout Quotation
4686 \begin_inset space \hfill{}
4693 \begin_layout Plain Layout
4705 \begin_layout Quotation
4707 \begin_inset space \hfill{}
4713 \begin_layout Quotation
4715 \begin_inset space \hfill{}
4722 \begin_layout Plain Layout
4734 \begin_layout Quotation
4736 \begin_inset space \hfill{}
4742 \begin_layout Quotation
4744 \begin_inset space \hfill{}
4750 \begin_layout Quotation
4752 \begin_inset space \hfill{}
4759 \begin_layout Plain Layout
4771 \begin_layout Quotation
4773 \begin_inset space \hfill{}
4780 \begin_layout Plain Layout
4792 \begin_layout Quotation
4794 \begin_inset space \hfill{}
4800 \begin_layout Quotation
4801 hungarian umlaut (hug)
4802 \begin_inset space \hfill{}
4808 \begin_layout Quotation
4810 \begin_inset space \hfill{}
4816 \begin_layout Quotation
4818 \begin_inset space \hfill{}
4825 \begin_layout Plain Layout
4837 \begin_layout Standard
4838 Since in many international keyboards there are exceptions to what some
4839 dead keys should do, you can define them using
4842 \begin_layout Quotation
4843 \begin_inset Flex CharStyle:Code
4846 \begin_layout Plain Layout
4854 deadkey key outstring
4857 \begin_layout Standard
4858 For example, on Slovak keyboard, if you enter caron-o, it generates circumflex-o
4862 \begin_layout Quotation
4863 \begin_inset Flex CharStyle:Code
4866 \begin_layout Plain Layout
4879 \begin_layout Standard
4880 to make it work correctly.
4881 Also, you have to define as exceptions dead keys over i and j, to remove
4882 the dot from them before inserting an accent mark.
4883 I will change this when the time comes, but so far I haven't had time.
4886 \begin_layout Standard
4887 Oh, and about characters: backslash is escaped, so to enter it, you'll need
4890 \begin_inset Flex CharStyle:Code
4893 \begin_layout Plain Layout
4899 have different meaning.
4901 \begin_inset Flex CharStyle:Code
4904 \begin_layout Plain Layout
4910 marks comments, quotes start and end LaTeX-style commands.
4911 To enter quote, you'll need to use
4912 \begin_inset Flex CharStyle:Code
4915 \begin_layout Plain Layout
4924 \begin_inset Flex CharStyle:Code
4927 \begin_layout Plain Layout
4934 \begin_inset Flex CharStyle:Code
4937 \begin_layout Plain Layout
4948 \begin_layout Standard
4949 If you make a keyboard description file that works for your language, please
4950 mail it to me, so I can include it in the next keymap distribution.
4953 \begin_layout Standard
4954 More keywords will be supported in keymap configuration file in future,
4958 \begin_layout Itemize
4959 \begin_inset Flex CharStyle:Code
4962 \begin_layout Plain Layout
4973 \begin_inset space \hfill{}
4977 \begin_inset Flex CharStyle:Code
4980 \begin_layout Plain Layout
4989 \begin_layout Itemize
4990 \begin_inset Flex CharStyle:Code
4993 \begin_layout Plain Layout
5004 \begin_inset space \hfill{}
5008 \begin_inset Flex CharStyle:Code
5011 \begin_layout Plain Layout
5017 an external keymap translation program
5020 \begin_layout Standard
5021 Also, it should look into
5022 \begin_inset Flex CharStyle:Code
5025 \begin_layout Plain Layout
5031 file for defaults, too (for example, a
5032 \begin_inset Flex CharStyle:Code
5035 \begin_layout Plain Layout
5043 option to include default keyboard).
5051 \begin_layout Section
5052 \begin_inset CommandInset label
5058 International Keymap Stuff
5061 \begin_layout Standard
5062 \begin_inset Note Note
5065 \begin_layout Plain Layout
5066 In doing the revisions on this document in March 2008, I did not look over
5067 this stuff, as I do not understand it.
5068 It would be good if someone else could do so.
5076 \begin_layout Standard
5077 The next two sections describe the
5078 \begin_inset Flex CharStyle:Code
5081 \begin_layout Plain Layout
5090 \begin_inset Flex CharStyle:Code
5093 \begin_layout Plain Layout
5101 file syntax in detail.
5102 These sections should help you design your own key map if the ones provided
5103 do not meet your needs.
5106 \begin_layout Subsection
5110 \begin_layout Standard
5114 \begin_inset Flex CharStyle:Code
5117 \begin_layout Plain Layout
5123 file maps keystrokes to characters or strings.
5124 As the name suggests, it sets a keyboard mapping.
5126 \begin_inset Flex CharStyle:Code
5129 \begin_layout Plain Layout
5140 \begin_inset Flex CharStyle:Code
5143 \begin_layout Plain Layout
5158 \begin_inset Flex CharStyle:Code
5161 \begin_layout Plain Layout
5174 \begin_inset Flex CharStyle:Code
5177 \begin_layout Plain Layout
5186 \begin_inset Flex CharStyle:Code
5189 \begin_layout Plain Layout
5197 are described in this section.
5200 \begin_layout Labeling
5201 \labelwidthstring 00.00.0000
5202 \begin_inset Flex CharStyle:Code
5205 \begin_layout Plain Layout
5213 Map a character to a string
5216 \begin_layout LyX-Code
5231 \begin_layout Standard
5264 the double-quote (")
5281 must be escaped with a preceding backslash (
5292 \begin_layout Standard
5294 \begin_inset Flex CharStyle:MenuItem
5297 \begin_layout Plain Layout
5305 statement to cause the symbol
5306 \begin_inset Flex CharStyle:MenuItem
5309 \begin_layout Plain Layout
5317 to be output for the keystroke
5318 \begin_inset Flex CharStyle:MenuItem
5321 \begin_layout Plain Layout
5332 \begin_layout LyX-Code
5338 \begin_layout Labeling
5339 \labelwidthstring 00.00.0000
5340 \begin_inset Flex CharStyle:Code
5343 \begin_layout Plain Layout
5351 Specify an accent character
5354 \begin_layout LyX-Code
5363 \begin_layout Standard
5364 This will make the cha
5402 This is the dead key
5406 \begin_layout Plain Layout
5413 refers to a key that does not produce a character by itself, but when followed
5414 with another key, produces the desired accent character.
5415 For example, a German characte
5417 r with an umlaut like
5427 can be produced in this manner.
5436 \begin_layout Standard
5449 and then another key not in
5466 followed by the other, unallowed key, as output.
5470 \begin_inset Flex CharStyle:MenuItem
5473 \begin_layout Plain Layout
5481 cancels a dead key, so if
5492 \begin_inset Flex CharStyle:MenuItem
5495 \begin_layout Plain Layout
5504 , the cursor will not go one position backwards but will instead cancel
5520 might have had on the next keystroke.
5524 \begin_layout Standard
5525 The following example specifies that the character ' is to be an acute accent,
5526 allowed on the characters a, e, i, o, u, A, E, I, O, and U:
5529 \begin_layout LyX-Code
5532 kmod ' acute aeiouAEIOU
5535 \begin_layout Labeling
5536 \labelwidthstring 00.00.0000
5537 \begin_inset Flex CharStyle:Code
5540 \begin_layout Plain Layout
5546 Specify an exception to the accent character
5549 \begin_layout LyX-Code
5558 \begin_layout Standard
5559 This defines an exce
5600 have been assigned a keystroke with a previous
5603 \begin_inset Flex CharStyle:Code
5606 \begin_layout Plain Layout
5630 must not belong in the
5682 If such a declaration does not exist in
5690 \begin_inset Flex CharStyle:Code
5693 \begin_layout Plain Layout
5733 \begin_inset Flex CharStyle:Code
5736 \begin_layout Plain Layout
5750 \begin_layout Standard
5751 The following command produces causes äi to be produced when you enter acute-i
5755 \begin_layout LyX-Code
5769 \begin_layout Labeling
5770 \labelwidthstring 00.00.0000
5771 \begin_inset Flex CharStyle:Code
5774 \begin_layout Plain Layout
5780 Combine two accent characters
5783 \begin_layout LyX-Code
5789 accent1 accent2 allowed
5792 \begin_layout Standard
5793 This one is getting pretty esoteric.
5794 It allows you to combine the effect
5850 \begin_inset Flex CharStyle:Code
5853 \begin_layout Plain Layout
5881 \begin_layout Standard
5882 Consider this example from the
5883 \begin_inset Flex CharStyle:Code
5886 \begin_layout Plain Layout
5897 \begin_layout LyX-Code
5900 kmod ; acute aeioyvhAEIOYVH
5904 kcomb acute umlaut iyIY
5907 \begin_layout Standard
5908 This allows you to press
5909 \begin_inset Flex CharStyle:MenuItem
5912 \begin_layout Plain Layout
5920 and get the effect of
5921 \begin_inset Flex CharStyle:Code
5924 \begin_layout Plain Layout
5943 in this case cancels the last dead key, so if you press
5944 \begin_inset Flex CharStyle:MenuItem
5947 \begin_layout Plain Layout
5956 \begin_inset Flex CharStyle:Code
5959 \begin_layout Plain Layout
5972 \begin_layout Subsection
5976 \begin_layout Standard
5978 \begin_inset Flex CharStyle:Code
5981 \begin_layout Plain Layout
5989 mapping is performed, a
5990 \begin_inset Flex CharStyle:Code
5993 \begin_layout Plain Layout
6003 file maps the strings that the symbols generate to characters in the current
6005 The LyX distribution currently includes at least the
6006 \begin_inset Flex CharStyle:Code
6009 \begin_layout Plain Layout
6018 \begin_inset Flex CharStyle:Code
6021 \begin_layout Plain Layout
6032 \begin_layout Standard
6034 \begin_inset Flex CharStyle:Code
6037 \begin_layout Plain Layout
6045 file is a sequence of declarations of the form
6048 \begin_layout LyX-Code
6061 \begin_layout Standard
6062 For example, in order to map
6063 \begin_inset Flex CharStyle:MenuItem
6066 \begin_layout Plain Layout
6076 to the corresponding character in the iso-8859-1 set (233), the following
6080 \begin_layout LyX-Code
6088 \begin_layout Standard
6090 \begin_inset Flex CharStyle:Code
6093 \begin_layout Plain Layout
6102 \begin_inset Flex CharStyle:Code
6105 \begin_layout Plain Layout
6123 the same character can apply to more than one string.
6125 \begin_inset Flex CharStyle:Code
6128 \begin_layout Plain Layout
6139 \begin_layout LyX-Code
6151 \begin_inset Newline newline
6167 \begin_layout Standard
6168 If LyX cannot find a mapping for the string produced by the keystroke or
6169 a deadkey sequence, it will check if it looks like an accented char and
6170 try to draw an accent over the character on screen.
6173 \begin_layout Subsection
6177 \begin_layout Standard
6178 There is a second way to add support for international characters through
6179 so-called dead-keys.
6180 A dead-key works in combination with a letter to produce an accented character.
6181 Here, we'll explain how to create a really simple dead-key to illustrate
6185 \begin_layout Standard
6186 Suppose you happen to need the circumflex character,
6187 \begin_inset Quotes eld
6191 \begin_inset Quotes erd
6196 \begin_inset Flex CharStyle:MenuItem
6199 \begin_layout Plain Layout
6206 \begin_inset space ~
6210 \begin_inset Flex CharStyle:MenuItem
6213 \begin_layout Plain Layout
6219 ] to the LyX command
6220 \begin_inset Flex CharStyle:Code
6223 \begin_layout Plain Layout
6230 \begin_inset Flex CharStyle:Code
6233 \begin_layout Plain Layout
6240 Now, whenever you type the
6241 \begin_inset Flex CharStyle:MenuItem
6244 \begin_layout Plain Layout
6250 -key followed by a letter, that letter will have a circumflex accent on
6252 For example, the sequence
6253 \begin_inset Quotes eld
6257 \begin_inset Flex CharStyle:MenuItem
6260 \begin_layout Plain Layout
6267 \begin_inset Quotes erd
6270 produces the letter:
6271 \begin_inset Quotes eld
6275 \begin_inset Quotes erd
6279 If you tried to type
6280 \begin_inset Quotes eld
6284 \begin_inset Flex CharStyle:MenuItem
6287 \begin_layout Plain Layout
6294 \begin_inset Quotes erd
6297 , however, LyX will complain with a beep, since a
6298 \begin_inset Quotes eld
6302 \begin_inset Flex CharStyle:MenuItem
6305 \begin_layout Plain Layout
6312 \begin_inset Quotes erd
6315 never takes a circumflex accent.
6317 \begin_inset Flex CharStyle:MenuItem
6320 \begin_layout Plain Layout
6326 after a dead-key produces the bare-accent.
6327 Please note this last point! If you bind a key to a dead-key, you'll need
6328 to rebind the character on that key to yet another key.
6330 \begin_inset Flex CharStyle:MenuItem
6333 \begin_layout Plain Layout
6339 to a cedilla is a bad idea, since you'll only get cedillas instead of commas.
6342 \begin_layout Standard
6343 One common way to bind dead-keys is to use
6344 \begin_inset Flex CharStyle:MenuItem
6347 \begin_layout Plain Layout
6354 \begin_inset Flex CharStyle:MenuItem
6357 \begin_layout Plain Layout
6364 \begin_inset Flex CharStyle:MenuItem
6367 \begin_layout Plain Layout
6373 in combination with an accent, like
6374 \begin_inset Quotes eld
6378 \begin_inset Flex CharStyle:MenuItem
6381 \begin_layout Plain Layout
6388 \begin_inset Quotes erd
6392 \begin_inset Quotes eld
6396 \begin_inset Flex CharStyle:MenuItem
6399 \begin_layout Plain Layout
6406 \begin_inset Quotes erd
6410 \begin_inset Quotes eld
6414 \begin_inset Flex CharStyle:MenuItem
6417 \begin_layout Plain Layout
6424 \begin_inset Quotes erd
6428 Another way involves using
6429 \begin_inset Flex CharStyle:Code
6432 \begin_layout Plain Layout
6439 \begin_inset Flex CharStyle:Code
6442 \begin_layout Plain Layout
6448 to set up the special
6449 \begin_inset Flex CharStyle:Code
6452 \begin_layout Plain Layout
6460 \begin_inset Flex CharStyle:Code
6463 \begin_layout Plain Layout
6469 acts in some ways just like
6470 \begin_inset Flex CharStyle:MenuItem
6473 \begin_layout Plain Layout
6479 and permits you to bind keys to accented characters.
6480 You can also turn keys into dead-keys by binding them to something like
6482 \begin_inset Flex CharStyle:Code
6485 \begin_layout Plain Layout
6491 and then binding this symbolic key to the corresponding LyX command.
6495 \begin_layout Plain Layout
6500 : This is exactly what I do in my
6501 \begin_inset Flex CharStyle:Code
6504 \begin_layout Plain Layout
6511 \begin_inset Flex CharStyle:Code
6514 \begin_layout Plain Layout
6522 \begin_inset Flex CharStyle:MenuItem
6525 \begin_layout Plain Layout
6527 \begin_inset space ~
6536 \begin_inset Flex CharStyle:Code
6539 \begin_layout Plain Layout
6545 and a bunch of these
6546 \begin_inset Quotes eld
6550 \begin_inset Flex CharStyle:Code
6553 \begin_layout Plain Layout
6560 \begin_inset Quotes erd
6563 symbolic keys bound such things as
6564 \begin_inset Flex CharStyle:MenuItem
6567 \begin_layout Plain Layout
6569 \begin_inset space ~
6578 \begin_inset Flex CharStyle:MenuItem
6581 \begin_layout Plain Layout
6583 \begin_inset space ~
6592 This is how I produce my accented characters.
6597 You can make just about anything into the
6598 \begin_inset Flex CharStyle:Code
6601 \begin_layout Plain Layout
6608 \begin_inset Flex CharStyle:MenuItem
6611 \begin_layout Plain Layout
6617 keys, a spare function key, etc.
6618 As for the LyX commands that produce accents, check the entry for
6619 \begin_inset Flex CharStyle:Code
6622 \begin_layout Plain Layout
6633 You'll find the complete list there.
6636 \begin_layout Subsection
6637 Saving your Language Configuration
6640 \begin_layout Standard
6641 \begin_inset CommandInset label
6647 You can edit your preferences so that your desired language environment
6648 is automatically configured when LyX starts up, via the
6649 \begin_inset Flex CharStyle:MenuItem
6652 \begin_layout Plain Layout
6657 dit\SpecialChar \menuseparator
6670 \begin_layout Chapter
6671 Installing New Document Classes, Layouts, and Templates
6672 \begin_inset CommandInset label
6674 name "chap:textclass"
6682 \begin_layout Plain Layout
6683 Installing New Document Classes
6691 \begin_layout Standard
6692 In this chapter, we describe the procedures for creating and installing
6693 new LyX layout and template files, as well as offer a refresher on correctly
6694 installing new LaTeX document classes.
6695 Some definitions: a document class is a LaTeX file (usually ending in
6696 \begin_inset Flex CharStyle:Code
6699 \begin_layout Plain Layout
6706 \begin_inset Flex CharStyle:Code
6709 \begin_layout Plain Layout
6715 ) that describes the format of a document such as an article, report, journal
6716 preprint, etc, and all the commands needed to realize that format.
6717 A layout file is a LyX file that corresponds to a LaTeX document class
6718 and that tells LyX how to
6719 \begin_inset Quotes eld
6723 \begin_inset Quotes erd
6726 things on the screen to make the display look something like the final
6728 More precisely, a layout file describes a
6729 \begin_inset Quotes eld
6733 \begin_inset Quotes erd
6736 which is the internal construct LyX uses to render the screen display.
6738 \begin_inset Quotes eld
6742 \begin_inset Quotes erd
6746 \begin_inset Quotes eld
6750 \begin_inset Quotes erd
6753 can be used somewhat interchangeably, but it is better to refer to the
6754 file as the layout, and the thing living in LyX's memory as the text class.
6755 A template file is simply a LyX document that contains a set of predefined
6756 entries for a given document class---entries that are generally required
6758 Templates are especially useful for things like journal manuscripts that
6759 are to be submitted electronically.
6762 \begin_layout Section
6763 Installing a new LaTeX package
6766 \begin_layout Standard
6767 Some installations may not include a LaTeX package that you would like to
6769 For example, you might need FoilTeX, a common (and very powerful) package
6770 for preparing slides or viewgraphs for overhead projectors.
6771 On some systems, you may have a GUI for installing such packages: MikTeX
6772 on Windows®, for example.
6775 \begin_layout Standard
6776 If you don't have such a GUI, then you can follow these steps.
6779 \begin_layout Enumerate
6780 Get the package from
6781 \begin_inset CommandInset href
6784 target "http://www.ctan.org/"
6791 \begin_layout Enumerate
6792 You can install this package in several different places.
6793 If you want it to be available for all users on your system, then you should
6794 install it in your `local' TeX tree; if you want (or need) it to be available
6795 just for you, then you can install it in your own `user' TeX tree.
6796 Where these should be created, if they do not already exist, depends upon
6797 the details of your system.
6798 To find out, look in the file
6799 \begin_inset Flex CharStyle:Code
6802 \begin_layout Plain Layout
6812 \begin_layout Plain Layout
6813 This usually lives in the directory
6814 \begin_inset Flex CharStyle:Code
6817 \begin_layout Plain Layout
6823 , though you can run
6824 \begin_inset Flex CharStyle:Code
6827 \begin_layout Plain Layout
6838 The location of the `local' TeX tree is defined by
6839 \begin_inset Flex CharStyle:Code
6842 \begin_layout Plain Layout
6848 ; this is usually somewhere like
6849 \begin_inset Flex CharStyle:Code
6852 \begin_layout Plain Layout
6853 /usr/local/share/texmf/
6859 The `user' TeX tree is defined by
6860 \begin_inset Flex CharStyle:Code
6863 \begin_layout Plain Layout
6870 \begin_inset Flex CharStyle:Code
6873 \begin_layout Plain Layout
6880 (If these variables are not predefined, you can define them.) You'll probably
6881 need root permissions to create or modify the `local' tree; but your `user'
6882 tree shouldn't have such limitations.
6885 \begin_layout Enumerate
6887 \begin_inset Flex CharStyle:Code
6890 \begin_layout Plain Layout
6897 \begin_inset Flex CharStyle:Code
6900 \begin_layout Plain Layout
6907 \begin_inset Flex CharStyle:Code
6910 \begin_layout Plain Layout
6918 \begin_inset Newline newline
6922 \begin_inset Flex CharStyle:Code
6925 \begin_layout Plain Layout
6926 TEXMF = {$TEXMFHOME,!!$TEXMFLOCAL,!!$TEXMFMAIN}
6932 \begin_inset Newline newline
6935 But, again, most of this will
6936 \begin_inset Quotes eld
6940 \begin_inset Quotes erd
6946 \begin_layout Enumerate
6951 \begin_layout Plain Layout
6952 We'll assume henceforth that you're defining `local' TeX tree.
6953 If you're defining a user tree, just adjust as necessary.
6959 You must follow the directory structure of your existing
6960 \begin_inset Flex CharStyle:Code
6963 \begin_layout Plain Layout
6969 directory, which will be found at
6970 \begin_inset Flex CharStyle:Code
6973 \begin_layout Plain Layout
6980 For example, latex packages should go under
6981 \begin_inset Flex CharStyle:Code
6984 \begin_layout Plain Layout
6985 $TEXMFLOCAL/tex/latex/
6993 \begin_layout Enumerate
6994 Install the package.
6995 For example, you would unpack the FoilTeX tarball and copy it to
6996 \begin_inset Flex CharStyle:Code
6999 \begin_layout Plain Layout
7000 $TEXMFLOCAL/tex/latex/foiltex
7007 \begin_inset Flex CharStyle:Code
7010 \begin_layout Plain Layout
7016 directory contains various files.
7019 \begin_layout Enumerate
7021 \begin_inset Flex CharStyle:Code
7024 \begin_layout Plain Layout
7032 \begin_inset Flex CharStyle:Code
7035 \begin_layout Plain Layout
7044 \begin_layout Standard
7045 Your package is now installed and available to LaTeX.
7046 To make it available to LyX, you need to create a Layout file, if one is
7047 not already available.
7048 (See the next section.) Once you have a layout file, you need only reconfigure
7050 \begin_inset Flex CharStyle:MenuItem
7053 \begin_layout Plain Layout
7058 ools\SpecialChar \menuseparator
7068 ) and then restart LyX.
7069 You should then see your new package---for example
7070 \begin_inset Flex CharStyle:MenuItem
7073 \begin_layout Plain Layout
7080 \begin_inset Flex CharStyle:MenuItem
7083 \begin_layout Plain Layout
7088 ocument\SpecialChar \menuseparator
7099 \begin_inset Flex CharStyle:MenuItem
7102 \begin_layout Plain Layout
7112 \begin_layout Section
7113 \begin_inset CommandInset label
7122 \begin_layout Standard
7123 This section describes how to write and install your own LyX layout files
7124 and walks through the
7125 \begin_inset Flex CharStyle:Code
7128 \begin_layout Plain Layout
7134 text class format as an example.
7136 \begin_inset Flex CharStyle:Code
7139 \begin_layout Plain Layout
7145 files describe what paragraph and character styles are available for a
7146 given document class and how LyX should display them.
7147 We try to provide a thorough description of the process here; however,
7148 there are so many different types of documents supported by LaTeX classes
7149 that we can't hope to cover every different possibility or problem you
7151 (The LyX users' list is frequented by people with lots of experience with
7152 layout design who are willing to share what they've learned.)
7155 \begin_layout Standard
7156 As you prepare to write a new layout, it is extremely helpful to look at
7157 the example layouts distributed with LyX.
7158 If you use a nice LaTeX document class that might be of interest for others,
7159 too, and have a nice corresponding LyX layout, feel free to contribute
7160 the stuff to us, so we may put it into the distribution.
7162 \begin_inset CommandInset href
7164 name "section on the LyX wiki"
7165 target "http://wiki.lyx.org/Layouts/Layouts"
7169 for this kind of material.
7172 \begin_layout Standard
7173 All the tags described in this chapter are case-insensitive; this means
7175 \begin_inset Flex CharStyle:Code
7178 \begin_layout Plain Layout
7185 \begin_inset Flex CharStyle:Code
7188 \begin_layout Plain Layout
7195 \begin_inset Flex CharStyle:Code
7198 \begin_layout Plain Layout
7204 are really the same command.
7205 The possible values are printed in brackets after the feature's name.
7206 The default value if a feature isn't specified inside a text class-description
7208 \begin_inset Flex CharStyle:Code
7211 \begin_layout Plain Layout
7220 If the argument has a datatype like
7221 \begin_inset Quotes eld
7225 \begin_inset Quotes erd
7229 \begin_inset Quotes eld
7233 \begin_inset Quotes erd
7236 , the default is shown like this:
7237 \begin_inset Flex CharStyle:Code
7240 \begin_layout Plain Layout
7251 \begin_layout Subsection
7252 \begin_inset CommandInset label
7254 name "sub:Layout-modules"
7261 \begin_layout Standard
7262 Similar to layout files, and new with LyX 1.6, are layout
7267 Modules are to LaTeX packages much as layouts are to LaTeX classes, and
7268 some modules---such as the Endnotes module---provide support for just such
7270 In a sense, layout modules are similar to included files---files like
7271 \begin_inset Flex CharStyle:Code
7274 \begin_layout Plain Layout
7280 ---in that modules are not specific to a given document layout but may be
7281 used with many different layouts.
7282 The difference is that using a layout module does not require editing the
7284 Rather, modules are selected in the
7285 \begin_inset Flex CharStyle:MenuItem
7288 \begin_layout Plain Layout
7293 ocument\SpecialChar \menuseparator
7306 \begin_layout Standard
7307 Building modules is the easiest way to get started with layout editing,
7308 since it can be as simple as adding a single new paragraph or flex inset.
7309 But modules may, in principle, contain anything a layout file can contain.
7312 \begin_layout Standard
7313 A module must begin with a line like the following:
7316 \begin_layout LyX-Code
7319 DeclareLyXModule[endnotes.sty]{Endnotes}
7322 \begin_layout Standard
7323 The argument in square brackets is optional: It declares any LaTeX packages
7324 on which the module depends.
7325 The mandatory argument, in curly brackets, is the name of the module, as
7327 \begin_inset Flex CharStyle:MenuItem
7330 \begin_layout Plain Layout
7331 Document\SpecialChar \menuseparator
7341 \begin_layout Standard
7342 The module declaration should then be followed by lines like the following:
7345 \begin_layout LyX-Code
7349 \begin_layout LyX-Code
7350 #Adds an endnote command, in addition to footnotes.
7354 \begin_layout LyX-Code
7355 #You will need to add
7357 theendnotes in ERT where you
7360 \begin_layout LyX-Code
7361 #want the endnotes to appear.
7365 \begin_layout LyX-Code
7369 \begin_layout LyX-Code
7370 #Requires: somemodule | othermodule
7373 \begin_layout LyX-Code
7374 #Excludes: badmodule
7377 \begin_layout Standard
7378 The description is used in
7379 \begin_inset Flex CharStyle:MenuItem
7382 \begin_layout Plain Layout
7383 Document\SpecialChar \menuseparator
7389 to provide the user with information about what the module does.
7391 \begin_inset Flex CharStyle:Code
7394 \begin_layout Plain Layout
7400 line is used to identify other modules with which this one must be used;
7402 \begin_inset Flex CharStyle:Code
7405 \begin_layout Plain Layout
7411 line is used to identify modules with which this one may not be used.
7412 Both are optional, and, as shown, multiple modules should be separated
7413 with the pipe symbol: |.
7414 Note that the required modules are treated disjunctively:
7418 of the required modules must be used.
7423 excluded module may be used.
7424 Note that modules are identified here by their
7428 without the .module extension.
7430 \begin_inset Flex CharStyle:Code
7433 \begin_layout Plain Layout
7440 \begin_inset Flex CharStyle:Code
7443 \begin_layout Plain Layout
7452 \begin_layout Standard
7453 After creating a new module, you will need to reconfigure and then restart
7454 LyX for the module to appear in the menu.
7455 However, changes you make to the module will be seen immediately, if you
7457 \begin_inset Flex CharStyle:MenuItem
7460 \begin_layout Plain Layout
7461 Document\SpecialChar \menuseparator
7467 , highlight something, and then hit
7468 \begin_inset Quotes eld
7472 \begin_inset Quotes erd
7478 It is strongly recommended that you save your work before doing so
7483 it is strongly recommended that you not attempt to edit modules while simultaneo
7484 usly working on documents
7487 Though of course the developers strive to keep LyX stable in such situations,
7488 syntax errors and the like in your module file could cause strange behavior.
7491 \begin_layout Subsection
7492 Supporting new document classes
7495 \begin_layout Standard
7496 There are two situations you are likely to encounter when wanting to support
7497 a new LaTeX document class, involving LaTeX2e class (
7498 \begin_inset Flex CharStyle:Code
7501 \begin_layout Plain Layout
7508 \begin_inset Flex CharStyle:Code
7511 \begin_layout Plain Layout
7518 Supporting a style file is usually fairly easy.
7519 Supporting a new document class is a bit harder.
7522 \begin_layout Subsection
7524 \begin_inset Flex CharStyle:MenuItem
7527 \begin_layout Plain Layout
7536 \begin_layout Standard
7537 If your new document class is provided as a style file that is used in conjuncti
7538 on with an existing, supported document class---for the sake of the example,
7539 we'll assume that the style file is called
7540 \begin_inset Flex CharStyle:MenuItem
7543 \begin_layout Plain Layout
7549 and it is meant to be used with
7550 \begin_inset Flex CharStyle:MenuItem
7553 \begin_layout Plain Layout
7559 , which is a standard class---start by copying the existing class's layout
7560 file into your local directory:
7563 \begin_layout LyX-Code
7564 cp report.layout ~/.lyx/layouts/myclass.layout
7567 \begin_layout Standard
7569 \begin_inset Flex CharStyle:Code
7572 \begin_layout Plain Layout
7578 and change the line:
7581 \begin_layout LyX-Code
7584 DeclareLaTeXClass{report}
7587 \begin_layout Standard
7591 \begin_layout LyX-Code
7594 DeclareLaTeXClass[report, myclass.sty]{report (myclass)}
7597 \begin_layout Standard
7601 \begin_layout LyX-Code
7603 \begin_inset Newline newline
7609 \begin_inset Newline newline
7615 \begin_layout Standard
7616 near the top of the file.
7619 \begin_layout Standard
7620 Start LyX and select
7621 \begin_inset Flex CharStyle:MenuItem
7624 \begin_layout Plain Layout
7629 ools\SpecialChar \menuseparator
7640 Then restart LyX and try creating a new document.
7642 \begin_inset Flex CharStyle:MenuItem
7645 \begin_layout Plain Layout
7651 " as a document class option in the
7652 \begin_inset Flex CharStyle:MenuItem
7655 \begin_layout Plain Layout
7660 ocument\SpecialChar \menuseparator
7671 It is likely that some of the sectioning commands and such in your new
7672 class will work differently from how they worked in the base class---
7673 \begin_inset Flex CharStyle:Code
7676 \begin_layout Plain Layout
7682 in this example---so you can fiddle around with the settings for the different
7683 sections if you wish.
7686 \begin_layout Subsection
7688 \begin_inset Flex CharStyle:MenuItem
7691 \begin_layout Plain Layout
7700 \begin_layout Standard
7701 There are two possibilities here.
7702 One is that the class file is itself based upon an existing document class.
7703 For example, many thesis classes are based upon
7704 \begin_inset Flex CharStyle:MenuItem
7707 \begin_layout Plain Layout
7714 To see whether yours is, look for a line like
7717 \begin_layout LyX-Code
7723 \begin_layout Standard
7725 If so, then you may proceed largely as in the previous section, though
7726 the DeclareLaTeXClass line will be different.
7727 If your new class is thesis, and it is based upon book, then the line should
7732 \begin_layout Plain Layout
7733 And it will be easiest if you save the file to
7734 \begin_inset Flex CharStyle:Code
7737 \begin_layout Plain Layout
7743 : LyX assumes that the document class has the same name as the layout file.
7752 \begin_layout LyX-Code
7755 DeclareLaTeXClass[thesis,book]{thesis}
7758 \begin_layout Standard
7759 If, on the other hand, the new class is not based upon an existing class,
7760 you will probably have to
7761 \begin_inset Quotes eld
7765 \begin_inset Quotes erd
7769 We strongly suggest copying an existing layout file which uses a similar
7770 LaTeX class and then modifying it, if you can do so.
7771 At least use an existing file as a starting point so you can find out what
7772 items you need to worry about.
7773 Again, the specifics are covered below.
7776 \begin_layout Section
7777 Declaring a new text class
7780 \begin_layout Standard
7781 When it's finally time to get your hands dirty and create or edit your own
7782 layout file, the following sections describe what you're up against.
7783 Our advice is to go slowly, save and test often, listen to soothing music,
7784 and enjoy one or two of your favorite adult beverages; more if you are
7785 getting particularly stuck.
7786 It's really not that hard, except that the multitude of options can become
7787 overwhelming if you try to do to much in one sitting.
7788 Go have another adult beverage, just for good measure.
7791 \begin_layout Standard
7795 \begin_layout Standard
7796 Lines in a layout file which begin with a
7797 \begin_inset Flex CharStyle:Code
7800 \begin_layout Plain Layout
7807 There is one exception to this rule: all layouts should begin with lines
7811 \begin_layout LyX-Code
7814 #% Do not delete the line below; configure depends on this
7817 \begin_layout LyX-Code
7822 DeclareLaTeXClass{article}
7825 \begin_layout Standard
7826 The second line is used when you configure LyX.
7827 The layout file is read by the LaTeX script
7828 \begin_inset Flex CharStyle:Code
7831 \begin_layout Plain Layout
7837 , in a special mode where
7838 \begin_inset Flex CharStyle:Code
7841 \begin_layout Plain Layout
7848 The first line is just a LaTeX comment, and the second one contains the
7849 declaration of the text class.
7850 If these lines appear in a file named
7851 \begin_inset Flex CharStyle:Code
7854 \begin_layout Plain Layout
7860 , then they define a text class of name
7861 \begin_inset Flex CharStyle:Code
7864 \begin_layout Plain Layout
7870 (the name of the layout file) which uses the LaTeX document class
7871 \begin_inset Flex CharStyle:Code
7874 \begin_layout Plain Layout
7880 (the default is to use the same name as the layout).
7882 \begin_inset Quotes eld
7886 \begin_inset Quotes erd
7889 that appears above is used as a description of the text class in the
7890 \begin_inset Flex CharStyle:MenuItem
7893 \begin_layout Plain Layout
7898 ocument\SpecialChar \menuseparator
7911 \begin_layout Standard
7912 Let's assume that you wrote your own text class that uses the
7913 \begin_inset Flex CharStyle:Code
7916 \begin_layout Plain Layout
7922 document class, but where you changed the appearance of the section headings.
7923 If you put it in a file
7924 \begin_inset Flex CharStyle:Code
7927 \begin_layout Plain Layout
7933 , the header of this file should be:
7936 \begin_layout LyX-Code
7939 #% Do not delete the line below; configure depends on this
7942 \begin_layout LyX-Code
7947 DeclareLaTeXClass[article]{article (with my own headings)}
7950 \begin_layout Standard
7951 This declares a text class
7952 \begin_inset Flex CharStyle:Code
7955 \begin_layout Plain Layout
7961 , associated with the LaTeX document class
7962 \begin_inset Flex CharStyle:Code
7965 \begin_layout Plain Layout
7972 \begin_inset Quotes eld
7975 article (with my own headings)
7976 \begin_inset Quotes erd
7980 If your text class depends on several packages, you can declare it as:
7983 \begin_layout LyX-Code
7986 #% Do not delete the line below; configure depends on this
7989 \begin_layout LyX-Code
7994 DeclareLaTeXClass[article,foo.sty]{article (with my own headings)}
7997 \begin_layout Standard
7998 This indicates that your text class uses the foo.sty package.
7999 Finally, it is also possible to declare classes for DocBook code.
8000 Typical declarations will look like
8003 \begin_layout LyX-Code
8006 #% Do not delete the line below; configure depends on this
8009 \begin_layout LyX-Code
8014 DeclareDocBookClass[article]{SGML (DocBook article)}
8017 \begin_layout Standard
8018 Note that these declarations can also be given an optional parameter declaring
8019 the name of the document class (but not a list).
8022 \begin_layout Standard
8023 So, to be as explicit as possible, the form of the layout declaration is:
8026 \begin_layout LyX-Code
8031 DeclareLaTeXClass[class,package.sty]{layout description}
8034 \begin_layout Standard
8035 The class need only be specified if the name of the LaTeX class file and
8036 the name of the layout file are different; if the name of the classfile
8037 is not specified, then LyX will simply assume that it is the same as the
8038 name of the layout file.
8041 \begin_layout Standard
8042 When the text class has been modified to your taste, all you have to do
8043 is to copy it either to
8044 \begin_inset Flex CharStyle:Code
8047 \begin_layout Plain Layout
8054 \begin_inset Flex CharStyle:Code
8057 \begin_layout Plain Layout
8064 \begin_inset Flex CharStyle:MenuItem
8067 \begin_layout Plain Layout
8072 ools\SpecialChar \menuseparator
8082 , exit LyX and restart it.
8083 Then your new text class should be available along with the others.
8086 \begin_layout Standard
8087 In versions of LyX prior to 1.6, you had to restart LyX to see any changes
8088 you made to your layout files.
8089 As a result, editing layout files could be very time consuming.
8090 Beginning with 1.6, however, you can force a reload of the layout currently
8091 in use by using the LyX function
8092 \begin_inset Flex CharStyle:MenuItem
8095 \begin_layout Plain Layout
8102 There is no default binding for this function---though, of course, you
8103 can bind it to a key yourself (see section
8104 \begin_inset CommandInset ref
8106 reference "sec:bindings"
8111 If you want to use this function, then, you should simply enter it in the
8117 : This is very much an `advanced feature'.
8122 recommended that you save your work before using this function.
8127 recommended that you not attempt to edit your layout while simultaneously
8128 working on a document that you care about.
8129 Use a test document.
8130 Syntax errors and the like in your layout file could cause peculiar behavior.
8131 In particular, such errors could cause LyX to regard the current layout
8132 as invalid and to attempt to switch to some other layout.
8133 The LyX team strives to keep LyX stable in such situations, but safe is
8137 \begin_layout Subsection
8141 \begin_layout Standard
8142 The first non-comment line must contain the file format number:
8145 \begin_layout Description
8146 \begin_inset Flex CharStyle:Code
8149 \begin_layout Plain Layout
8156 \begin_inset Flex CharStyle:Code
8159 \begin_layout Plain Layout
8165 ] This tag was introduced with LyX 1.4.0 (layout files of LyX 1.3.x and earlier
8166 don't have an explicit file format).
8167 The file format that is documented here is format 7.
8170 \begin_layout Subsection
8171 General text class parameters
8174 \begin_layout Standard
8175 These are the general parameters which describe the form of the entire document:
8178 \begin_layout Description
8179 \begin_inset Flex CharStyle:Code
8182 \begin_layout Plain Layout
8188 Adds information to the document preamble.
8190 \begin_inset Quotes eld
8194 \begin_inset Flex CharStyle:Code
8197 \begin_layout Plain Layout
8204 \begin_inset Quotes erd
8210 \begin_layout Description
8211 \begin_inset Flex CharStyle:Code
8214 \begin_layout Plain Layout
8220 Describes various global options supported by the document class.
8222 \begin_inset space ~
8226 \begin_inset CommandInset ref
8228 reference "sec:classoptions"
8234 \begin_inset Quotes eld
8238 \begin_inset Flex CharStyle:Code
8241 \begin_layout Plain Layout
8248 \begin_inset Quotes erd
8254 \begin_layout Description
8255 \begin_inset Flex CharStyle:Code
8258 \begin_layout Plain Layout
8265 \begin_inset Flex CharStyle:Code
8268 \begin_layout Plain Layout
8277 \begin_inset Flex CharStyle:Code
8280 \begin_layout Plain Layout
8286 ] Whether the class should default to having one or two columns.
8287 Can be changed in the
8288 \begin_inset Flex CharStyle:MenuItem
8291 \begin_layout Plain Layout
8296 ocument\SpecialChar \menuseparator
8309 \begin_layout Description
8310 \begin_inset Flex CharStyle:Code
8313 \begin_layout Plain Layout
8319 This sequence defines a new counter.
8321 \begin_inset space ~
8325 \begin_inset CommandInset ref
8327 reference "sec:counter"
8333 \begin_inset Quotes eld
8337 \begin_inset Flex CharStyle:Code
8340 \begin_layout Plain Layout
8347 \begin_inset Quotes erd
8353 \begin_layout Description
8354 \begin_inset Flex CharStyle:Code
8357 \begin_layout Plain Layout
8363 Sets the default font used to display the document.
8365 \begin_inset space ~
8369 \begin_inset CommandInset ref
8371 reference "sec:fonts"
8375 for how to declare fonts.
8377 \begin_inset Quotes eld
8381 \begin_inset Flex CharStyle:Code
8384 \begin_layout Plain Layout
8391 \begin_inset Quotes erd
8397 \begin_layout Description
8398 \begin_inset Flex CharStyle:Code
8401 \begin_layout Plain Layout
8408 \begin_inset Flex CharStyle:Code
8411 \begin_layout Plain Layout
8417 ] This is the style that will be assigned to new paragraphs, usually
8418 \begin_inset Flex CharStyle:MenuItem
8421 \begin_layout Plain Layout
8428 This will default to the first defined style if not given, but you are
8429 highly encouraged to use this directive.
8432 \begin_layout Description
8433 \begin_inset Flex CharStyle:Code
8436 \begin_layout Plain Layout
8442 Defines a new float.
8444 \begin_inset space ~
8448 \begin_inset CommandInset ref
8450 reference "sec:floats"
8456 \begin_inset Quotes eld
8460 \begin_inset Flex CharStyle:Code
8463 \begin_layout Plain Layout
8470 \begin_inset Quotes erd
8476 \begin_layout Description
8477 \begin_inset Flex CharStyle:Code
8480 \begin_layout Plain Layout
8486 As its name implies, this command allows you to include another layout
8487 definition file within yours to avoid duplicating commands.
8488 Common examples are the standard layout files, for example,
8489 \begin_inset Flex CharStyle:Code
8492 \begin_layout Plain Layout
8498 , which contains most of the basic layouts.
8501 \begin_layout Description
8502 \begin_inset Flex CharStyle:Code
8505 \begin_layout Plain Layout
8511 This section (re-)defines the layout of an inset.
8512 It can be applied to an existing inset of to a new, user-defined inset,
8513 e.g., a new character style.
8515 \begin_inset space ~
8519 \begin_inset CommandInset ref
8521 reference "sec:charstyle"
8525 for more information.
8527 \begin_inset Quotes eld
8531 \begin_inset Flex CharStyle:Code
8534 \begin_layout Plain Layout
8541 \begin_inset Quotes erd
8547 \begin_layout Description
8548 \begin_inset Flex CharStyle:Code
8551 \begin_layout Plain Layout
8560 \begin_layout Description
8561 \begin_inset Flex CharStyle:Code
8564 \begin_layout Plain Layout
8570 This command deletes an existing float.
8571 This is particularly useful when you want to suppress a float that has
8572 be defined in an input file.
8575 \begin_layout Description
8576 \begin_inset Flex CharStyle:Code
8579 \begin_layout Plain Layout
8585 This command deletes an existing style.
8586 This is particularly useful when you want to suppress a style that has
8587 be defined in an input file.
8590 \begin_layout Description
8591 \begin_inset Flex CharStyle:Code
8594 \begin_layout Plain Layout
8603 \begin_layout Description
8604 \begin_inset Flex CharStyle:Code
8607 \begin_layout Plain Layout
8618 \begin_inset Flex CharStyle:Code
8621 \begin_layout Plain Layout
8632 \begin_inset Flex CharStyle:Code
8635 \begin_layout Plain Layout
8642 \begin_inset Flex CharStyle:Code
8645 \begin_layout Plain Layout
8651 ] The class default pagestyle.
8652 Can be changed in the
8653 \begin_inset Flex CharStyle:MenuItem
8656 \begin_layout Plain Layout
8661 ocument\SpecialChar \menuseparator
8674 \begin_layout Description
8675 \begin_inset Flex CharStyle:Code
8678 \begin_layout Plain Layout
8684 Sets the preamble for the LaTeX document.
8685 Note that this will completely override any prior
8686 \begin_inset Flex CharStyle:Code
8689 \begin_layout Plain Layout
8696 \begin_inset Flex CharStyle:Code
8699 \begin_layout Plain Layout
8707 \begin_inset Quotes eld
8711 \begin_inset Flex CharStyle:Code
8714 \begin_layout Plain Layout
8721 \begin_inset Quotes erd
8727 \begin_layout Description
8728 \begin_inset Flex CharStyle:Code
8731 \begin_layout Plain Layout
8738 \begin_inset CommandInset label
8745 \begin_inset Flex CharStyle:Code
8748 \begin_layout Plain Layout
8755 \begin_inset Flex CharStyle:Code
8758 \begin_layout Plain Layout
8767 \begin_inset Flex CharStyle:Code
8770 \begin_layout Plain Layout
8776 ] Whether the class already provides the feature
8777 \begin_inset Flex CharStyle:Code
8780 \begin_layout Plain Layout
8787 A feature is in general the name of a package (
8788 \begin_inset Flex CharStyle:Code
8791 \begin_layout Plain Layout
8798 \begin_inset Flex CharStyle:Code
8801 \begin_layout Plain Layout
8807 , \SpecialChar \ldots{}
8809 \begin_inset Flex CharStyle:Code
8812 \begin_layout Plain Layout
8819 \begin_inset Flex CharStyle:Code
8822 \begin_layout Plain Layout
8828 ,\SpecialChar \ldots{}
8829 ); the complete list of supported features is unfortunately not documented
8830 outside the LyX source code---but see
8831 \begin_inset Flex CharStyle:Code
8834 \begin_layout Plain Layout
8840 if you're interested.
8842 \begin_inset Flex CharStyle:MenuItem
8845 \begin_layout Plain Layout
8850 elp\SpecialChar \menuseparator
8860 also gives an overview of the supported packages.
8863 \begin_layout Description
8864 \begin_inset Flex CharStyle:Code
8867 \begin_layout Plain Layout
8874 \begin_inset Flex CharStyle:Code
8877 \begin_layout Plain Layout
8883 ] Whether the class requires the feature
8884 \begin_inset Flex CharStyle:Code
8887 \begin_layout Plain Layout
8894 Multiple features must be separated by commas.
8895 Note that you can only request supported features.
8898 \begin_layout Description
8899 \begin_inset Flex CharStyle:Code
8902 \begin_layout Plain Layout
8911 \begin_layout Description
8912 \begin_inset Flex CharStyle:Code
8915 \begin_layout Plain Layout
8924 \begin_layout Description
8925 \begin_inset Flex CharStyle:Code
8928 \begin_layout Plain Layout
8937 \begin_inset Flex CharStyle:Code
8940 \begin_layout Plain Layout
8951 \begin_inset Flex CharStyle:Code
8954 \begin_layout Plain Layout
8960 ] Whether the class-default should be printing on one or both sides of the
8962 Can be changed in the
8963 \begin_inset Flex CharStyle:MenuItem
8966 \begin_layout Plain Layout
8971 ocument\SpecialChar \menuseparator
8984 \begin_layout Description
8985 \begin_inset Flex CharStyle:Code
8988 \begin_layout Plain Layout
8994 This sequence defines a new paragraph style.
8995 If the style already exists, it will redefine some of its parameters instead.
8997 \begin_inset space ~
9001 \begin_inset CommandInset ref
9003 reference "sec:style"
9009 \begin_inset Quotes eld
9013 \begin_inset Flex CharStyle:Code
9016 \begin_layout Plain Layout
9023 \begin_inset Quotes erd
9029 \begin_layout Description
9030 \begin_inset Flex CharStyle:Code
9033 \begin_layout Plain Layout
9040 \begin_inset Flex CharStyle:Code
9043 \begin_layout Plain Layout
9049 ] The name of the command or environment to be used with
9050 \begin_inset Flex CharStyle:Code
9053 \begin_layout Plain Layout
9062 \begin_layout Description
9063 \begin_inset Flex CharStyle:Code
9066 \begin_layout Plain Layout
9073 \begin_inset Flex CharStyle:Code
9076 \begin_layout Plain Layout
9085 \begin_inset Flex CharStyle:Code
9088 \begin_layout Plain Layout
9094 ] Indicates what kind of markup is used to define the title of a document.
9096 \begin_inset Flex CharStyle:Code
9099 \begin_layout Plain Layout
9105 means that the macro with name
9106 \begin_inset Flex CharStyle:Code
9109 \begin_layout Plain Layout
9115 will be inserted after the last layout which has
9116 \begin_inset Quotes eld
9120 \begin_inset Flex CharStyle:Code
9123 \begin_layout Plain Layout
9130 \begin_inset Quotes erd
9135 \begin_inset Flex CharStyle:Code
9138 \begin_layout Plain Layout
9144 corresponds to the case where the block of paragraphs which have
9145 \begin_inset Quotes eld
9149 \begin_inset Flex CharStyle:Code
9152 \begin_layout Plain Layout
9159 \begin_inset Quotes erd
9162 should be enclosed into the
9163 \begin_inset Flex CharStyle:Code
9166 \begin_layout Plain Layout
9175 \begin_layout Description
9176 \begin_inset Flex CharStyle:Code
9179 \begin_layout Plain Layout
9188 \begin_layout Subsection
9189 \begin_inset Flex CharStyle:Code
9192 \begin_layout Plain Layout
9201 \begin_layout Standard
9202 \begin_inset CommandInset label
9204 name "sec:classoptions"
9209 \begin_inset Flex CharStyle:Code
9212 \begin_layout Plain Layout
9218 section can contain the following entries:
9221 \begin_layout Description
9222 \begin_inset Flex CharStyle:Code
9225 \begin_layout Plain Layout
9232 \begin_inset Flex CharStyle:Code
9235 \begin_layout Plain Layout
9241 ] The list of available font sizes for the document's main font, separated
9243 \begin_inset Quotes eld
9247 \begin_inset Flex CharStyle:Code
9250 \begin_layout Plain Layout
9257 \begin_inset Quotes erd
9263 \begin_layout Description
9264 \begin_inset Flex CharStyle:Code
9267 \begin_layout Plain Layout
9276 \begin_layout Description
9277 \begin_inset Flex CharStyle:Code
9280 \begin_layout Plain Layout
9287 \begin_inset Flex CharStyle:Code
9290 \begin_layout Plain Layout
9291 string="empty|plain|headings|fancy"
9296 ] The list of available page styles, separated by
9297 \begin_inset Quotes eld
9301 \begin_inset Flex CharStyle:Code
9304 \begin_layout Plain Layout
9311 \begin_inset Quotes erd
9317 \begin_layout Description
9318 \begin_inset Flex CharStyle:Code
9321 \begin_layout Plain Layout
9328 \begin_inset Flex CharStyle:Code
9331 \begin_layout Plain Layout
9337 ] Some document class options, separated by a comma, that will be added
9338 to the optional part of the
9339 \begin_inset Flex CharStyle:Code
9342 \begin_layout Plain Layout
9353 \begin_layout Standard
9355 \begin_inset Flex CharStyle:Code
9358 \begin_layout Plain Layout
9364 section must end with
9365 \begin_inset Quotes eld
9369 \begin_inset Flex CharStyle:Code
9372 \begin_layout Plain Layout
9379 \begin_inset Quotes erd
9385 \begin_layout Subsection
9389 \begin_layout Standard
9390 \begin_inset CommandInset label
9396 A paragraph style description looks like this:
9400 \begin_layout Plain Layout
9401 Note that this will either define a new layout or modify an existing one.
9409 \begin_layout LyX-Code
9416 \begin_layout LyX-Code
9420 \begin_layout LyX-Code
9424 \begin_layout Standard
9425 where the following commands are allowed:
9428 \begin_layout Description
9429 \begin_inset Flex CharStyle:Code
9432 \begin_layout Plain Layout
9439 \begin_inset Flex CharStyle:Code
9442 \begin_layout Plain Layout
9447 , left, right, center
9452 ] Paragraph alignment.
9455 \begin_layout Description
9456 \begin_inset Flex CharStyle:Code
9459 \begin_layout Plain Layout
9466 \begin_inset Flex CharStyle:Code
9469 \begin_layout Plain Layout
9474 , left, right, center
9479 ] A comma separated list of permitted alignments.
9480 (Some LaTeX styles prohibit certain alignments, since those wouldn't make
9482 For example a right-aligned or centered enumeration isn't possible.)
9485 \begin_layout Description
9486 \begin_inset Flex CharStyle:Code
9489 \begin_layout Plain Layout
9496 \begin_inset Flex CharStyle:Code
9499 \begin_layout Plain Layout
9509 \begin_layout Plain Layout
9510 Note that a `float' here is a real number, such as: 1.5.
9515 The vertical space with which the last of a chain of paragraphs with this
9516 layout is separated from the following paragraph.
9517 If the next paragraph has another layout, the separations are not simply
9518 added, but the maximum is taken.
9521 \begin_layout Description
9522 \begin_inset Flex CharStyle:Code
9525 \begin_layout Plain Layout
9532 \begin_inset Flex CharStyle:Code
9535 \begin_layout Plain Layout
9541 The category for this style.
9542 This is used to group related styles in the Layout combobox on the toolbar.
9543 Any string can be used, but you may want to use existing categories with
9548 \begin_layout Description
9549 \begin_inset Flex CharStyle:Code
9552 \begin_layout Plain Layout
9561 \begin_layout Description
9562 \begin_inset Flex CharStyle:Code
9565 \begin_layout Plain Layout
9572 \begin_inset CommandInset label
9574 name "des:CopyStyle"
9579 \begin_inset Flex CharStyle:Code
9582 \begin_layout Plain Layout
9588 Copies all the features of an existing style into the current one.
9592 \begin_layout Description
9593 \begin_inset Flex CharStyle:Code
9596 \begin_layout Plain Layout
9602 The name of a style whose preamble should be output
9607 This allows to ensure some ordering of the preamble snippets when macros
9608 definitions depend on one another.
9612 \begin_layout Plain Layout
9613 Note that, besides that functionality, there is no way to ensure any ordering
9615 The ordering that you see in a given version of LyX may change without
9616 warning in later versions.
9624 \begin_layout Description
9625 \begin_inset Flex CharStyle:Code
9628 \begin_layout Plain Layout
9635 \begin_inset Flex CharStyle:Code
9638 \begin_layout Plain Layout
9643 , Box, Filled_Box, Static
9648 ] The type of label that stands at the end of the paragraph (or sequence
9650 \begin_inset Flex CharStyle:Code
9653 \begin_layout Plain Layout
9660 \begin_inset Flex CharStyle:Code
9663 \begin_layout Plain Layout
9670 \begin_inset Flex CharStyle:Code
9673 \begin_layout Plain Layout
9680 \begin_inset Flex CharStyle:Code
9683 \begin_layout Plain Layout
9691 \begin_inset Flex CharStyle:Code
9694 \begin_layout Plain Layout
9701 \begin_inset Quotes eld
9705 \begin_inset Quotes erd
9709 \begin_inset Flex CharStyle:Code
9712 \begin_layout Plain Layout
9719 \begin_inset Flex CharStyle:Code
9722 \begin_layout Plain Layout
9723 \begin_inset space ~
9732 \begin_inset space ~
9735 black) square suitable for end of proof markers,
9736 \begin_inset Flex CharStyle:Code
9739 \begin_layout Plain Layout
9745 is an explicit text string.
9748 \begin_layout Description
9749 \begin_inset Flex CharStyle:Code
9752 \begin_layout Plain Layout
9759 \begin_inset Flex CharStyle:Code
9762 \begin_layout Plain Layout
9768 ] The string used for a label with a
9769 \begin_inset Flex CharStyle:Code
9772 \begin_layout Plain Layout
9779 \begin_inset Flex CharStyle:Code
9782 \begin_layout Plain Layout
9792 \begin_layout Description
9793 \begin_inset Flex CharStyle:Code
9796 \begin_layout Plain Layout
9803 \begin_inset Flex CharStyle:Code
9806 \begin_layout Plain Layout
9817 \begin_inset Flex CharStyle:Code
9820 \begin_layout Plain Layout
9829 \begin_layout Description
9830 \begin_inset Flex CharStyle:Code
9833 \begin_layout Plain Layout
9840 \begin_inset Flex CharStyle:Code
9843 \begin_layout Plain Layout
9853 ] With this parameter the
9854 \begin_inset Flex CharStyle:MenuItem
9857 \begin_layout Plain Layout
9864 \begin_inset Quotes eld
9867 Vertical space above
9868 \begin_inset Quotes erd
9872 \begin_inset Flex CharStyle:MenuItem
9875 \begin_layout Plain Layout
9880 dit\SpecialChar \menuseparator
9886 \begin_inset space ~
9894 dialog can be set when initializing a paragraph with this style.
9898 \begin_layout Plain Layout
9901 Note from Jean-Marc:
9903 I'm not sure that this setting has much use, and it should probably be
9904 removed in later versions.
9912 \begin_layout Description
9913 \begin_inset Flex CharStyle:Code
9916 \begin_layout Plain Layout
9922 The font used for both the text body
9928 \begin_inset space ~
9932 \begin_inset CommandInset ref
9934 reference "sec:fonts"
9939 Note that defining this font automatically defines the
9940 \begin_inset Flex CharStyle:Code
9943 \begin_layout Plain Layout
9950 So you should define this one first if you also want to define
9951 \begin_inset Flex CharStyle:Code
9954 \begin_layout Plain Layout
9963 \begin_layout Description
9964 \begin_inset Flex CharStyle:Code
9967 \begin_layout Plain Layout
9974 \begin_inset CommandInset label
9976 name "des:FreeSpacing"
9983 \begin_inset Flex CharStyle:Code
9986 \begin_layout Plain Layout
9997 \begin_inset Flex CharStyle:Code
10000 \begin_layout Plain Layout
10006 ] Usually LyX doesn't allow you to insert more than one space between words,
10007 since a space is considered as the separation between two words, not a
10008 character or symbol of its own.
10009 This is a very fine thing but sometimes annoying, for example, when typing
10010 program code or plain LaTeX code.
10012 \begin_inset Flex CharStyle:Code
10015 \begin_layout Plain Layout
10022 Note that LyX will create protected blanks for the additional blanks when
10023 in another mode than LaTeX-mode.
10026 \begin_layout Description
10027 \begin_inset Flex CharStyle:Code
10030 \begin_layout Plain Layout
10039 \begin_layout Description
10040 \begin_inset Flex CharStyle:Code
10043 \begin_layout Plain Layout
10050 \begin_inset Flex CharStyle:Code
10053 \begin_layout Plain Layout
10059 If 1, marks the layout as being part of a title block (see also the
10060 \begin_inset Flex CharStyle:Code
10063 \begin_layout Plain Layout
10070 \begin_inset Flex CharStyle:Code
10073 \begin_layout Plain Layout
10082 \begin_layout Description
10083 \begin_inset Flex CharStyle:Code
10086 \begin_layout Plain Layout
10093 \begin_inset Flex CharStyle:Code
10096 \begin_layout Plain Layout
10102 ] This provides extra space between paragraphs that have the same layout.
10103 If you put other layouts into an environment, each is separated with the
10105 \begin_inset Flex CharStyle:Code
10108 \begin_layout Plain Layout
10115 But the whole items of the environment are additionally separated with
10117 \begin_inset Flex CharStyle:Code
10120 \begin_layout Plain Layout
10127 Note that this is a
10132 \begin_layout Description
10133 \begin_inset Flex CharStyle:Code
10136 \begin_layout Plain Layout
10145 \begin_layout Description
10146 \begin_inset Flex CharStyle:Code
10149 \begin_layout Plain Layout
10156 \begin_inset CommandInset label
10158 name "des:KeepEmpty"
10165 \begin_inset Flex CharStyle:Code
10168 \begin_layout Plain Layout
10179 \begin_inset Flex CharStyle:Code
10182 \begin_layout Plain Layout
10188 ] Usually LyX does not allow you to leave a paragraph empty, since it would
10189 lead to empty LaTeX output.
10190 There are some cases where this could be desirable however: in a letter
10191 template, the required fields can be provided as empty fields, so that
10192 people do not forget them; in some special classes, a layout can be used
10193 as some kind of break, which does not contain actual text.
10196 \begin_layout Description
10197 \begin_inset Flex CharStyle:Code
10200 \begin_layout Plain Layout
10206 [float=0] The vertical space between the label and the text body.
10207 Only used for labels that are above the text body (
10208 \begin_inset Flex CharStyle:Code
10211 \begin_layout Plain Layout
10218 \begin_inset Flex CharStyle:Code
10221 \begin_layout Plain Layout
10222 Centered_Top_Environment
10230 \begin_layout Description
10231 \begin_inset Flex CharStyle:Code
10234 \begin_layout Plain Layout
10241 \begin_inset Flex CharStyle:Code
10244 \begin_layout Plain Layout
10251 \begin_inset Newline newline
10254 The name of the counter for automatic numbering (see Section
10255 \begin_inset CommandInset ref
10257 reference "sec:counter"
10262 This must be given if
10263 \begin_inset Flex CharStyle:Code
10266 \begin_layout Plain Layout
10273 \begin_inset Flex CharStyle:Code
10276 \begin_layout Plain Layout
10285 \begin_layout Description
10286 \begin_inset Flex CharStyle:Code
10289 \begin_layout Plain Layout
10295 The font used for the label.
10297 \begin_inset space ~
10301 \begin_inset CommandInset ref
10303 reference "sec:fonts"
10310 \begin_layout Description
10311 \begin_inset Flex CharStyle:Code
10314 \begin_layout Plain Layout
10321 \begin_inset Flex CharStyle:Code
10324 \begin_layout Plain Layout
10330 ] The horizontal space between the label and the text body.
10331 Only used for labels that are not above the text body.
10334 \begin_layout Description
10335 \begin_inset Flex CharStyle:Code
10338 \begin_layout Plain Layout
10345 \begin_inset Flex CharStyle:Code
10348 \begin_layout Plain Layout
10354 ] The string used for a label with a
10355 \begin_inset Flex CharStyle:Code
10358 \begin_layout Plain Layout
10366 \begin_inset Flex CharStyle:Code
10369 \begin_layout Plain Layout
10375 is set, this string can be contain the special formatting commands described
10377 \begin_inset CommandInset ref
10379 reference "sec:counter"
10387 \begin_layout Plain Layout
10388 For the sake of backwards compatibility, the string
10389 \begin_inset Flex CharStyle:Code
10392 \begin_layout Plain Layout
10402 will be replaced by the expanded
10403 \begin_inset Flex CharStyle:Code
10406 \begin_layout Plain Layout
10413 \begin_inset Flex CharStyle:Code
10416 \begin_layout Plain Layout
10425 This feature is now obsolete and should be replaced by the mechanisms of
10427 \begin_inset CommandInset ref
10429 reference "sec:counter"
10441 \begin_layout Description
10442 \begin_inset Flex CharStyle:Code
10445 \begin_layout Plain Layout
10446 LabelStringAppendix
10452 \begin_inset Flex CharStyle:Code
10455 \begin_layout Plain Layout
10461 ] This is used inside the appendix instead of
10462 \begin_inset Flex CharStyle:Code
10465 \begin_layout Plain Layout
10473 \begin_inset Flex CharStyle:Code
10476 \begin_layout Plain Layout
10483 \begin_inset Flex CharStyle:Code
10486 \begin_layout Plain Layout
10487 LabelStringAppendix
10495 \begin_layout Description
10496 \begin_inset Flex CharStyle:Code
10499 \begin_layout Plain Layout
10506 \begin_inset Flex CharStyle:Code
10509 \begin_layout Plain Layout
10514 , Manual, Static, Top_Environment,
10515 \begin_inset Newline newline
10518 Centered_Top_Environment, Sensitive, Counter
10524 \begin_inset Newline newline
10528 \begin_inset Flex CharStyle:Code
10531 \begin_layout Plain Layout
10537 means the label is the very first word (up to the first real blank).
10541 \begin_layout Plain Layout
10542 Use protected spaces if you want more than one word as the label.
10548 \begin_inset Flex CharStyle:Code
10551 \begin_layout Plain Layout
10557 means it is defined in the layout (see
10558 \begin_inset Flex CharStyle:Code
10561 \begin_layout Plain Layout
10569 \begin_inset Flex CharStyle:Code
10572 \begin_layout Plain Layout
10579 \begin_inset Flex CharStyle:Code
10582 \begin_layout Plain Layout
10583 Centered_Top_Environment
10588 are special cases of
10589 \begin_inset Flex CharStyle:Code
10592 \begin_layout Plain Layout
10599 The label will be printed above the paragraph, but only at the top of an
10600 environment or the top of a chain of paragraphs with this layout.
10601 Usage is for example the
10602 \begin_inset Flex CharStyle:MenuItem
10605 \begin_layout Plain Layout
10612 \begin_inset Flex CharStyle:MenuItem
10615 \begin_layout Plain Layout
10622 This is also the case for
10623 \begin_inset Flex CharStyle:Code
10626 \begin_layout Plain Layout
10632 labels with latex type
10633 \begin_inset Flex CharStyle:Code
10636 \begin_layout Plain Layout
10642 , in order to make layouts for theorems work correctly.
10644 \begin_inset Flex CharStyle:Code
10647 \begin_layout Plain Layout
10653 is a special case for the caption-labels
10654 \begin_inset Quotes eld
10658 \begin_inset Quotes erd
10662 \begin_inset Quotes eld
10666 \begin_inset Quotes erd
10671 \begin_inset Flex CharStyle:Code
10674 \begin_layout Plain Layout
10680 means the (hardcoded) label string depends on the kind of float.
10682 \begin_inset Flex CharStyle:Code
10685 \begin_layout Plain Layout
10691 label type defines automatically numbered labels.
10693 \begin_inset CommandInset ref
10695 reference "sec:counter"
10702 \begin_layout Description
10703 \begin_inset Flex CharStyle:Code
10706 \begin_layout Plain Layout
10715 \begin_layout Description
10716 \begin_inset Flex CharStyle:Code
10719 \begin_layout Plain Layout
10728 \begin_layout Description
10729 \begin_inset Flex CharStyle:Code
10732 \begin_layout Plain Layout
10739 \begin_inset CommandInset label
10741 name "des:LatexName"
10745 The name of the corresponding LaTeX stuff.
10746 Either the environment or command name.
10749 \begin_layout Description
10750 \begin_inset Flex CharStyle:Code
10753 \begin_layout Plain Layout
10762 \begin_layout Description
10763 \begin_inset Flex CharStyle:Code
10766 \begin_layout Plain Layout
10773 \begin_inset CommandInset label
10775 name "des:LatexParam"
10779 An optional parameter for the corresponding
10780 \begin_inset Flex CharStyle:Code
10783 \begin_layout Plain Layout
10790 This parameter cannot be changed from within LyX.
10793 \begin_layout Description
10794 \begin_inset Flex CharStyle:Code
10797 \begin_layout Plain Layout
10804 \begin_inset CommandInset label
10806 name "des:LatexType"
10811 \begin_inset Flex CharStyle:Code
10814 \begin_layout Plain Layout
10819 , Command, Environment, Item_Environment,
10825 \begin_inset Flex CharStyle:Code
10828 \begin_layout Plain Layout
10834 ] How the layout should be translated into LaTeX.
10836 \begin_inset Flex CharStyle:Code
10839 \begin_layout Plain Layout
10845 means nothing special.
10847 \begin_inset Flex CharStyle:Code
10850 \begin_layout Plain Layout
10857 \begin_inset Flex CharStyle:Code
10860 \begin_layout Plain Layout
10867 {\SpecialChar \ldots{}
10874 \begin_inset Flex CharStyle:Code
10877 \begin_layout Plain Layout
10884 \begin_inset Flex CharStyle:Code
10887 \begin_layout Plain Layout
10894 }\SpecialChar \ldots{}
10908 \begin_inset Flex CharStyle:Code
10911 \begin_layout Plain Layout
10918 \begin_inset Flex CharStyle:Code
10921 \begin_layout Plain Layout
10928 \begin_inset Flex CharStyle:Code
10931 \begin_layout Plain Layout
10939 is generated for each paragraph of this environment.
10941 \begin_inset Flex CharStyle:Code
10944 \begin_layout Plain Layout
10951 \begin_inset Flex CharStyle:Code
10954 \begin_layout Plain Layout
10961 \begin_inset Flex CharStyle:Code
10964 \begin_layout Plain Layout
10970 is passed as an argument to the environment.
10972 \begin_inset Flex CharStyle:Code
10975 \begin_layout Plain Layout
10981 can be defined in the
10982 \begin_inset Flex CharStyle:MenuItem
10985 \begin_layout Plain Layout
10990 ayout\SpecialChar \menuseparator
11002 \begin_inset Flex CharStyle:Code
11005 \begin_layout Plain Layout
11013 is perhaps a bit misleading, since these rules apply to SGML classes, too.
11014 Visit the SGML class files for specific examples.
11017 \begin_layout Standard
11018 Putting the last few things together, the LaTeX output will be either:
11021 \begin_layout LyX-Code
11024 latexname[latexparam]{\SpecialChar \ldots{}
11028 \begin_layout Standard
11032 \begin_layout LyX-Code
11035 begin{latexname}[latexparam] \SpecialChar \ldots{}
11041 \begin_layout Standard
11042 depending upon the LaTex type.
11045 \begin_layout Description
11046 \begin_inset Flex CharStyle:Code
11049 \begin_layout Plain Layout
11056 \begin_inset Flex CharStyle:Code
11059 \begin_layout Plain Layout
11065 ] If you put layouts into environments, the leftmargins are not simply added,
11066 but added with a factor
11067 \begin_inset Formula $\frac{4}{depth+4}$
11071 Note that this parameter is also used when the margin is defined as
11072 \begin_inset Flex CharStyle:Code
11075 \begin_layout Plain Layout
11082 \begin_inset Flex CharStyle:Code
11085 \begin_layout Plain Layout
11092 Then it is added to the manual or dynamic margin.
11094 \begin_inset Newline newline
11097 The argument is passed as a string.
11099 \begin_inset Quotes eld
11103 \begin_inset Flex CharStyle:Code
11106 \begin_layout Plain Layout
11113 \begin_inset Quotes erd
11116 means that the paragraph is indented with the width of
11117 \begin_inset Quotes eld
11121 \begin_inset Flex CharStyle:Code
11124 \begin_layout Plain Layout
11131 \begin_inset Quotes erd
11134 in the normal font.
11135 You can get a negative width by prefixing the string with
11136 \begin_inset Quotes eld
11140 \begin_inset Flex CharStyle:Code
11143 \begin_layout Plain Layout
11150 \begin_inset Quotes erd
11154 This way was chosen so that the look is the same with each used screen
11159 \begin_layout Description
11160 \begin_inset Flex CharStyle:Code
11163 \begin_layout Plain Layout
11170 \begin_inset Flex CharStyle:Code
11173 \begin_layout Plain Layout
11178 , Manual, Dynamic, First_Dynamic, Right_Address_Box
11184 \begin_inset Newline newline
11187 The kind of margin that the layout has on the left side.
11189 \begin_inset Flex CharStyle:Code
11192 \begin_layout Plain Layout
11198 just means a fixed margin.
11200 \begin_inset Flex CharStyle:Code
11203 \begin_layout Plain Layout
11209 means that the left margin depends on the string entered in the
11210 \begin_inset Flex CharStyle:MenuItem
11213 \begin_layout Plain Layout
11218 dit\SpecialChar \menuseparator
11224 \begin_inset space ~
11233 This is used to typeset nice lists without tabulators.
11235 \begin_inset Flex CharStyle:Code
11238 \begin_layout Plain Layout
11244 means that the margin depends on the size of the label.
11245 This is used for automatic enumerated headlines.
11246 It is obvious that the headline
11247 \begin_inset Quotes eld
11250 5.4.3.2.1 Very long headline
11251 \begin_inset Quotes erd
11254 must have a wider left margin (as wide as
11255 \begin_inset Quotes eld
11259 \begin_inset Quotes erd
11262 plus the space) than
11263 \begin_inset Quotes eld
11266 3.2 Very long headline
11267 \begin_inset Quotes erd
11271 \begin_inset Quotes eld
11275 \begin_inset Quotes erd
11278 are not able to do this.
11280 \begin_inset Flex CharStyle:Code
11283 \begin_layout Plain Layout
11289 is similar, but only the very first row of the paragraph is dynamic, while
11290 the others are static; this is used, for example, for descriptions.
11292 \begin_inset Flex CharStyle:Code
11295 \begin_layout Plain Layout
11301 means the margin is chosen in a way that the longest row of this paragraph
11302 fits to the right margin.
11303 This is used to typeset an address on the right edge of the page.
11306 \begin_layout Description
11307 \begin_inset Flex CharStyle:Code
11310 \begin_layout Plain Layout
11317 \begin_inset CommandInset label
11319 name "des:NeedProtect"
11324 \begin_inset Flex CharStyle:Code
11327 \begin_layout Plain Layout
11336 \begin_inset Flex CharStyle:Code
11339 \begin_layout Plain Layout
11345 ] Whether fragile commands in this layout should be
11346 \begin_inset Flex CharStyle:Code
11349 \begin_layout Plain Layout
11362 whether this command should itself be protected.)
11365 \begin_layout Description
11366 \begin_inset Flex CharStyle:Code
11369 \begin_layout Plain Layout
11376 \begin_inset Flex CharStyle:Code
11379 \begin_layout Plain Layout
11386 \begin_inset Flex CharStyle:Code
11389 \begin_layout Plain Layout
11397 ] Whether newlines are translated into LaTeX newlines (
11398 \begin_inset Flex CharStyle:Code
11401 \begin_layout Plain Layout
11412 The translation can be switched off to allow more comfortable LaTeX editing
11416 \begin_layout Description
11417 \begin_inset Flex CharStyle:Code
11420 \begin_layout Plain Layout
11427 \begin_inset Flex CharStyle:Code
11430 \begin_layout Plain Layout
11437 \begin_inset Flex CharStyle:Code
11440 \begin_layout Plain Layout
11448 ] Whether the following Paragraph is allowed to indent its very first row.
11450 \begin_inset Flex CharStyle:Code
11453 \begin_layout Plain Layout
11459 means that it is not allowed to do so;
11460 \begin_inset Flex CharStyle:Code
11463 \begin_layout Plain Layout
11469 means it could do so if it wants to.
11472 \begin_layout Description
11473 \begin_inset Flex CharStyle:Code
11476 \begin_layout Plain Layout
11485 \begin_layout Description
11486 \begin_inset Flex CharStyle:Code
11489 \begin_layout Plain Layout
11496 \begin_inset Flex CharStyle:Code
11499 \begin_layout Plain Layout
11505 ] The number of optional arguments that can be used with this layout.
11506 This is useful for things like section headings, and only makes sense with
11510 \begin_layout Description
11511 \begin_inset Flex CharStyle:Code
11514 \begin_layout Plain Layout
11521 \begin_inset Flex CharStyle:Code
11524 \begin_layout Plain Layout
11530 ] The indent of the very first line of a paragraph.
11532 \begin_inset Flex CharStyle:Code
11535 \begin_layout Plain Layout
11541 will be fixed for a certain layout.
11542 The exception is Standard layout, since the indentation of a Standard layout
11543 paragraph can be prohibited with
11544 \begin_inset Flex CharStyle:Code
11547 \begin_layout Plain Layout
11554 Also, Standard layout paragraphs inside environments use the
11555 \begin_inset Flex CharStyle:Code
11558 \begin_layout Plain Layout
11564 of the environment, not their native one.
11565 For example, Standard paragraphs inside an enumeration are not indented.
11568 \begin_layout Description
11569 \begin_inset Flex CharStyle:Code
11572 \begin_layout Plain Layout
11579 \begin_inset Flex CharStyle:Code
11582 \begin_layout Plain Layout
11588 ] The vertical space between two paragraphs of this layout.
11591 \begin_layout Description
11592 \begin_inset Flex CharStyle:Code
11595 \begin_layout Plain Layout
11602 \begin_inset Flex CharStyle:Code
11605 \begin_layout Plain Layout
11611 ] LyX allows the user to choose either
11612 \begin_inset Quotes eld
11616 \begin_inset Quotes erd
11620 \begin_inset Quotes eld
11624 \begin_inset Quotes erd
11627 to typeset a document.
11629 \begin_inset Quotes eld
11633 \begin_inset Quotes erd
11636 is chosen, this value is completely ignored.
11638 \begin_inset Quotes eld
11642 \begin_inset Quotes erd
11645 is chosen, the parindent of a LaTeXtype
11646 \begin_inset Quotes eld
11650 \begin_inset Quotes erd
11653 layout is ignored and all paragraphs are separated by this parskip argument.
11654 The vertical space is calculated with
11655 \begin_inset Flex CharStyle:Code
11658 \begin_layout Plain Layout
11660 \begin_inset space ~
11669 \begin_inset Flex CharStyle:Code
11672 \begin_layout Plain Layout
11678 is the height of a row with the normal font.
11679 This way, the look stays the same with different screen fonts.
11682 \begin_layout Description
11683 \begin_inset Flex CharStyle:Code
11686 \begin_layout Plain Layout
11693 \begin_inset CommandInset label
11695 name "des:PassThru"
11702 \begin_inset Flex CharStyle:Code
11705 \begin_layout Plain Layout
11716 \begin_inset Flex CharStyle:Code
11719 \begin_layout Plain Layout
11725 ] Whether the contents of this paragraph should be output in raw form, meaning
11726 without special translations that LaTeX would require.
11729 \begin_layout Description
11730 \begin_inset Flex CharStyle:Code
11733 \begin_layout Plain Layout
11740 \begin_inset CommandInset label
11742 name "des:Preamble"
11746 Information to be included in the LaTeX preamable when this style is used.
11747 Used to define macros, load packages, etc., required by this particular
11750 \begin_inset Quotes eld
11754 \begin_inset Flex CharStyle:Code
11757 \begin_layout Plain Layout
11764 \begin_inset Quotes erd
11770 \begin_layout Description
11771 \begin_inset Flex CharStyle:Code
11774 \begin_layout Plain Layout
11781 \begin_inset Flex CharStyle:Code
11784 \begin_layout Plain Layout
11791 \begin_inset CommandInset label
11793 name "des:Requires"
11797 Whether the layout requires the feature
11798 \begin_inset Flex CharStyle:Code
11801 \begin_layout Plain Layout
11808 See the description of
11809 \begin_inset Flex CharStyle:Code
11812 \begin_layout Plain Layout
11819 \begin_inset CommandInset ref
11820 LatexCommand pageref
11821 reference "des:FreeSpacing"
11825 ) for information on `features'.
11829 \begin_layout Description
11830 \begin_inset Flex CharStyle:Code
11833 \begin_layout Plain Layout
11840 \begin_inset Flex CharStyle:Code
11843 \begin_layout Plain Layout
11850 \begin_inset Flex CharStyle:Code
11853 \begin_layout Plain Layout
11862 \begin_layout Description
11863 \begin_inset Flex CharStyle:Code
11866 \begin_layout Plain Layout
11873 \begin_inset Flex CharStyle:Code
11876 \begin_layout Plain Layout
11881 , onehalf, double, other
11890 ] This defines what the default spacing should be in the layout.
11892 \begin_inset Flex CharStyle:Code
11895 \begin_layout Plain Layout
11902 \begin_inset Flex CharStyle:Code
11905 \begin_layout Plain Layout
11912 \begin_inset Flex CharStyle:Code
11915 \begin_layout Plain Layout
11921 correspond respectively to a multiplier value of 1, 1.25 and 1.667.
11922 If you specify the argument
11923 \begin_inset Flex CharStyle:Code
11926 \begin_layout Plain Layout
11932 , then you should also provide a numerical argument which will be the actual
11934 Note that, contrary to other parameters,
11935 \begin_inset Flex CharStyle:Code
11938 \begin_layout Plain Layout
11944 implies the generation of specific LaTeX code, using the package
11947 \begin_inset Flex CharStyle:Code
11950 \begin_layout Plain Layout
11959 \begin_layout Description
11960 \begin_inset Flex CharStyle:Code
11963 \begin_layout Plain Layout
11969 The font used for the text body .
11971 \begin_inset CommandInset ref
11973 reference "sec:fonts"
11980 \begin_layout Description
11982 \begin_inset Flex CharStyle:Code
11985 \begin_layout Plain Layout
11993 The level of the style in the table of contents.
11994 This is used for automatic numbering of section headings.
11997 \begin_layout Description
11998 \begin_inset Flex CharStyle:Code
12001 \begin_layout Plain Layout
12008 \begin_inset Flex CharStyle:Code
12011 \begin_layout Plain Layout
12017 ] The vertical space with which the very first of a chain of paragraphs
12018 with this layout is separated from the previous paragraph.
12019 If the previous paragraph has another layout, the separations are not simply
12020 added, but the maximum is taken.
12023 \begin_layout Subsection
12027 \begin_layout Standard
12028 \begin_inset CommandInset label
12034 Since version 1.3.0 of LyX, it is has been both possible and necessary to
12035 define the floats (
12036 \begin_inset Flex CharStyle:MenuItem
12039 \begin_layout Plain Layout
12046 \begin_inset Flex CharStyle:MenuItem
12049 \begin_layout Plain Layout
12055 , \SpecialChar \ldots{}
12056 ) in the text class itself.
12057 Standard floats are included in the file
12058 \begin_inset Flex CharStyle:Code
12061 \begin_layout Plain Layout
12067 , so you may have to do no more than add
12070 \begin_layout LyX-Code
12071 Input stdfloats.inc
12074 \begin_layout Standard
12075 to your layout file.
12076 If you want to implement a text class that proposes some other float types
12077 (like the AGU class bundled with LyX), the information below will hopefully
12081 \begin_layout Description
12082 \begin_inset Flex CharStyle:Code
12085 \begin_layout Plain Layout
12092 \begin_inset Flex CharStyle:Code
12095 \begin_layout Plain Layout
12102 \begin_inset Quotes erd
12106 \begin_inset Quotes erd
12109 ] The file name extension of an auxiliary file for the list of figures (or
12111 LaTeX writes the captions to this file.
12114 \begin_layout Description
12115 \begin_inset Flex CharStyle:Code
12118 \begin_layout Plain Layout
12125 \begin_inset Flex CharStyle:Code
12128 \begin_layout Plain Layout
12135 \begin_inset Quotes erd
12139 \begin_inset Quotes erd
12142 ] The string that will be used in the menus and also for the caption.
12145 \begin_layout Description
12146 \begin_inset Flex CharStyle:Code
12149 \begin_layout Plain Layout
12156 \begin_inset Flex CharStyle:Code
12159 \begin_layout Plain Layout
12168 \begin_inset Flex CharStyle:Code
12171 \begin_layout Plain Layout
12178 \begin_inset Flex CharStyle:Code
12181 \begin_layout Plain Layout
12187 if the float is already defined by the LaTeX document class.
12189 \begin_inset Flex CharStyle:Code
12192 \begin_layout Plain Layout
12198 , the float will be defined using the LaTeX package
12199 \begin_inset Flex CharStyle:Code
12202 \begin_layout Plain Layout
12211 \begin_layout Description
12212 \begin_inset Flex CharStyle:Code
12215 \begin_layout Plain Layout
12222 \begin_inset Flex CharStyle:Code
12225 \begin_layout Plain Layout
12232 \begin_inset Quotes erd
12236 \begin_inset Quotes erd
12239 ] The heading used for the list of floats.
12242 \begin_layout Description
12243 \begin_inset Flex CharStyle:Code
12246 \begin_layout Plain Layout
12253 \begin_inset Flex CharStyle:Code
12256 \begin_layout Plain Layout
12263 \begin_inset Quotes erd
12267 \begin_inset Quotes erd
12270 ] This (optional) argument determines whether floats of this class will
12271 be numbered within some sectional unit of the document.
12272 For example, if within is equal to
12273 \begin_inset Flex CharStyle:Code
12276 \begin_layout Plain Layout
12282 , the floats will be numbered within chapters.
12286 \begin_layout Description
12287 \begin_inset Flex CharStyle:Code
12290 \begin_layout Plain Layout
12297 \begin_inset Flex CharStyle:Code
12300 \begin_layout Plain Layout
12307 \begin_inset Quotes erd
12311 \begin_inset Quotes erd
12314 ] The default placement for the given class of floats.
12315 The string should be as in standard LaTeX:
12316 \begin_inset Flex CharStyle:Code
12319 \begin_layout Plain Layout
12326 \begin_inset Flex CharStyle:Code
12329 \begin_layout Plain Layout
12336 \begin_inset Flex CharStyle:Code
12339 \begin_layout Plain Layout
12346 \begin_inset Flex CharStyle:Code
12349 \begin_layout Plain Layout
12355 for top, bottom, page, and here, respectively.
12359 \begin_layout Plain Layout
12360 Note that the order of these letters in the string is irrelevant, like in
12366 On top of that there is a new type,
12367 \begin_inset Flex CharStyle:Code
12370 \begin_layout Plain Layout
12376 , which does not really correspond to a float, since it means: put it
12377 \begin_inset Quotes eld
12381 \begin_inset Quotes erd
12385 Note however that the
12386 \begin_inset Flex CharStyle:Code
12389 \begin_layout Plain Layout
12395 specifier is special and, because of implementation details, cannot be
12396 used in non-builtin float types.
12397 If you do not understand what this means, just use
12398 \begin_inset Quotes eld
12402 \begin_inset Flex CharStyle:Code
12405 \begin_layout Plain Layout
12412 \begin_inset Quotes erd
12418 \begin_layout Description
12419 \begin_inset Flex CharStyle:Code
12422 \begin_layout Plain Layout
12429 \begin_inset Flex CharStyle:Code
12432 \begin_layout Plain Layout
12439 \begin_inset Quotes erd
12443 \begin_inset Quotes erd
12446 ] The style used when defining the float using
12447 \begin_inset Flex CharStyle:Code
12450 \begin_layout Plain Layout
12461 \begin_layout Description
12462 \begin_inset Flex CharStyle:Code
12465 \begin_layout Plain Layout
12472 \begin_inset Flex CharStyle:Code
12475 \begin_layout Plain Layout
12482 \begin_inset Quotes erd
12486 \begin_inset Quotes erd
12490 \begin_inset Quotes eld
12494 \begin_inset Quotes erd
12497 of the new class of floats, like program or algorithm.
12498 After the appropriate
12499 \begin_inset Flex CharStyle:Code
12502 \begin_layout Plain Layout
12511 \begin_inset Flex CharStyle:Code
12514 \begin_layout Plain Layout
12523 \begin_inset Flex CharStyle:Code
12526 \begin_layout Plain Layout
12537 \begin_layout Standard
12538 Note that defining a float with type
12539 \begin_inset Flex CharStyle:Code
12542 \begin_layout Plain Layout
12550 automatically defines the corresponding counter with name
12551 \begin_inset Flex CharStyle:Code
12554 \begin_layout Plain Layout
12565 \begin_layout Subsection
12566 Inset layouts and Flex insets
12569 \begin_layout Standard
12570 \begin_inset CommandInset label
12572 name "sec:charstyle"
12576 LyX has supported character styles since version 1.4.0; since version 1.6.0
12577 these are called Flex insets.
12581 \begin_layout Standard
12582 Furthermore, it is possible to define the general layout of many different
12584 Currently, InsetLayout can be used to customize the layout parameters
12585 for footnotes, marginal notes, note insets, ERT insets, branches, listings,
12586 indexes, boxes, tables, algorithms, URLs, and optional arguments, as well
12591 \begin_layout Standard
12592 Flex insets come in three different kinds:
12595 \begin_layout Itemize
12597 \begin_inset Flex CharStyle:Code
12600 \begin_layout Plain Layout
12606 ): These define semantic markup corresponding to such LaTeX commands as
12608 \begin_inset Flex CharStyle:Code
12611 \begin_layout Plain Layout
12620 \begin_inset Flex CharStyle:Code
12623 \begin_layout Plain Layout
12634 \begin_layout Itemize
12636 \begin_inset Flex CharStyle:Code
12639 \begin_layout Plain Layout
12645 ): These can be used to define custom collapsable insets, similar to ERT,
12646 footnote, and the like.
12649 \begin_layout Itemize
12651 \begin_inset Flex CharStyle:Code
12654 \begin_layout Plain Layout
12660 ): For use with DocBook classes.
12663 \begin_layout Standard
12665 \begin_inset Flex CharStyle:Code
12668 \begin_layout Plain Layout
12674 definition starting line is of the form
12677 \begin_layout LyX-Code
12678 InsetLayout <Type> <Name>
12681 \begin_layout Standard
12683 \begin_inset Flex CharStyle:Code
12686 \begin_layout Plain Layout
12693 \begin_inset Flex CharStyle:Code
12696 \begin_layout Plain Layout
12703 \begin_inset Flex CharStyle:Code
12706 \begin_layout Plain Layout
12713 \begin_inset Flex CharStyle:Code
12716 \begin_layout Plain Layout
12723 \begin_inset Flex CharStyle:Code
12726 \begin_layout Plain Layout
12733 \begin_inset Flex CharStyle:Code
12736 \begin_layout Plain Layout
12743 \begin_inset Flex CharStyle:Code
12746 \begin_layout Plain Layout
12753 \begin_inset Flex CharStyle:Code
12756 \begin_layout Plain Layout
12763 \begin_inset Flex CharStyle:Code
12766 \begin_layout Plain Layout
12773 \begin_inset Flex CharStyle:Code
12776 \begin_layout Plain Layout
12783 \begin_inset Flex CharStyle:Code
12786 \begin_layout Plain Layout
12793 \begin_inset Flex CharStyle:Code
12796 \begin_layout Plain Layout
12803 \begin_inset Flex CharStyle:Code
12806 \begin_layout Plain Layout
12813 \begin_inset Flex CharStyle:Code
12816 \begin_layout Plain Layout
12823 \begin_inset Flex CharStyle:Code
12826 \begin_layout Plain Layout
12833 \begin_inset Flex CharStyle:Code
12836 \begin_layout Plain Layout
12843 \begin_inset Flex CharStyle:Code
12846 \begin_layout Plain Layout
12854 \begin_inset Flex CharStyle:Code
12857 \begin_layout Plain Layout
12864 \begin_inset Flex CharStyle:Code
12867 \begin_layout Plain Layout
12874 \begin_inset Flex CharStyle:Code
12877 \begin_layout Plain Layout
12883 should have the form
12884 \begin_inset Flex CharStyle:Code
12887 \begin_layout Plain Layout
12894 \begin_inset Flex CharStyle:Code
12897 \begin_layout Plain Layout
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 Flex CharStyle:Code
12927 \begin_layout Plain Layout
12934 \begin_inset Flex CharStyle:Code
12937 \begin_layout Plain Layout
12943 is any valid identifier.
12947 \begin_layout Standard
12949 \begin_inset Flex CharStyle:Code
12952 \begin_layout Plain Layout
12958 section can contain the following entries:
12961 \begin_layout Description
12962 \begin_inset Flex CharStyle:Code
12965 \begin_layout Plain Layout
12971 The color for the inset's background.
12972 These valid colors are defined in
12973 \begin_inset Flex CharStyle:Code
12976 \begin_layout Plain Layout
12985 \begin_layout Description
12986 \begin_inset Flex CharStyle:Code
12989 \begin_layout Plain Layout
12995 As with paragraph styles (see page
12996 \begin_inset CommandInset ref
12998 reference "des:CopyStyle"
13005 \begin_layout Description
13006 \begin_inset Flex CharStyle:Code
13009 \begin_layout Plain Layout
13016 \begin_inset Flex CharStyle:Code
13019 \begin_layout Plain Layout
13026 \begin_inset Flex CharStyle:Code
13029 \begin_layout Plain Layout
13036 \begin_inset Flex CharStyle:Code
13039 \begin_layout Plain Layout
13045 , describing the rendering style used for the inset's frame and buttons.
13046 Footnotes generally use
13047 \begin_inset Flex CharStyle:Code
13050 \begin_layout Plain Layout
13056 ; ERT insets generally use
13057 \begin_inset Flex CharStyle:Code
13060 \begin_layout Plain Layout
13066 ; and character styles use
13067 \begin_inset Flex CharStyle:Code
13070 \begin_layout Plain Layout
13079 \begin_layout Description
13080 \begin_inset Flex CharStyle:Code
13083 \begin_layout Plain Layout
13089 The font used for both the text body
13095 \begin_inset space ~
13099 \begin_inset CommandInset ref
13101 reference "sec:fonts"
13106 Note that defining this font automatically defines the
13107 \begin_inset Flex CharStyle:Code
13110 \begin_layout Plain Layout
13116 to the same value, so define this first and define
13117 \begin_inset Flex CharStyle:Code
13120 \begin_layout Plain Layout
13126 later if you want them to be different.
13129 \begin_layout Description
13130 \begin_inset Flex CharStyle:Code
13133 \begin_layout Plain Layout
13142 \begin_layout Description
13143 \begin_inset Flex CharStyle:Code
13146 \begin_layout Plain Layout
13152 As with paragraph styles (see page
13153 \begin_inset CommandInset ref
13154 LatexCommand pageref
13155 reference "des:FreeSpacing"
13162 \begin_layout Description
13163 \begin_inset Flex CharStyle:Code
13166 \begin_layout Plain Layout
13172 As with paragraph styles (see page
13173 \begin_inset CommandInset ref
13174 LatexCommand pageref
13175 reference "des:KeepEmpty"
13182 \begin_layout Description
13183 \begin_inset Flex CharStyle:Code
13186 \begin_layout Plain Layout
13192 What will be displayed on the button or elsewhere as the inset label.
13193 Some inset types (ERT and Branch) modify this label on the fly.
13196 \begin_layout Description
13197 \begin_inset Flex CharStyle:Code
13200 \begin_layout Plain Layout
13206 The font used for the label.
13208 \begin_inset space ~
13212 \begin_inset CommandInset ref
13214 reference "sec:fonts"
13219 Note that this definition can never appear before
13220 \begin_inset Flex CharStyle:Code
13223 \begin_layout Plain Layout
13229 , lest it be ineffective.
13232 \begin_layout Description
13233 \begin_inset Flex CharStyle:Code
13236 \begin_layout Plain Layout
13242 The name of the corresponding LaTeX stuff.
13243 Either the environment or command name.
13246 \begin_layout Description
13247 \begin_inset Flex CharStyle:Code
13250 \begin_layout Plain Layout
13256 The optional parameter for the corresponding
13257 \begin_inset Flex CharStyle:Code
13260 \begin_layout Plain Layout
13266 stuff, including possible bracket pairs like
13267 \begin_inset Flex CharStyle:Code
13270 \begin_layout Plain Layout
13277 This parameter cannot be changed from within LyX.
13280 \begin_layout Description
13281 \begin_inset Flex CharStyle:Code
13284 \begin_layout Plain Layout
13290 As with paragraph styles (see page
13291 \begin_inset CommandInset ref
13292 LatexCommand pageref
13293 reference "des:LatexType"
13300 \begin_layout Description
13301 \begin_inset Flex CharStyle:Code
13304 \begin_layout Plain Layout
13311 \begin_inset Flex CharStyle:Code
13314 \begin_layout Plain Layout
13321 \begin_inset Flex CharStyle:Code
13324 \begin_layout Plain Layout
13331 \begin_inset Flex CharStyle:Code
13334 \begin_layout Plain Layout
13341 \begin_inset Flex CharStyle:Code
13344 \begin_layout Plain Layout
13350 (indicating a dummy definition ending definitions of charstyles etc.).
13351 This entry is only meaningful for Flex (user definable) insets.
13354 \begin_layout Description
13355 \begin_inset Flex CharStyle:Code
13358 \begin_layout Plain Layout
13365 \begin_inset Flex CharStyle:Code
13368 \begin_layout Plain Layout
13377 \begin_inset Flex CharStyle:Code
13380 \begin_layout Plain Layout
13386 ] Whether fragile commands in this layout should be
13387 \begin_inset Flex CharStyle:Code
13390 \begin_layout Plain Layout
13403 whether this command should itself be protected.)
13406 \begin_layout Description
13407 \begin_inset Flex CharStyle:Code
13410 \begin_layout Plain Layout
13416 As with paragraph styles (see page
13417 \begin_inset CommandInset ref
13418 LatexCommand pageref
13419 reference "des:Preamble"
13426 \begin_layout Description
13427 \begin_inset Flex CharStyle:Code
13430 \begin_layout Plain Layout
13437 \begin_inset Flex CharStyle:Code
13440 \begin_layout Plain Layout
13446 ] As with paragraph styles (see page
13447 \begin_inset CommandInset ref
13448 LatexCommand pageref
13449 reference "des:Requires"
13456 \begin_layout Subsection
13460 \begin_layout Standard
13461 \begin_inset CommandInset label
13467 Since version 1.3.0 of LyX, it is both possible and necessary to define the
13469 \begin_inset Flex CharStyle:MenuItem
13472 \begin_layout Plain Layout
13479 \begin_inset Flex CharStyle:MenuItem
13482 \begin_layout Plain Layout
13488 , \SpecialChar \ldots{}
13489 ) in the text class itself.
13490 The standard counters are defined in the file
13491 \begin_inset Flex CharStyle:Code
13494 \begin_layout Plain Layout
13500 , so you may have to do no more than add
13503 \begin_layout LyX-Code
13504 Input stdcounters.inc
13507 \begin_layout Standard
13508 to your layout file to get them to work.
13509 But if you want to define custom counters, then you can do so, using the
13510 following parameters:
13513 \begin_layout Description
13514 \begin_inset Flex CharStyle:Code
13517 \begin_layout Plain Layout
13518 LabelString [string=""]
13523 when this is defined, this string defines how the counter is displayed.
13524 Setting this value sets
13525 \begin_inset Flex CharStyle:Code
13528 \begin_layout Plain Layout
13529 LabelStringAppendix
13535 The following special constructs can be used in the string:
13539 \begin_layout Itemize
13540 \begin_inset Flex CharStyle:Code
13543 \begin_layout Plain Layout
13551 will be replaced by the expansion of the
13552 \begin_inset Flex CharStyle:Code
13555 \begin_layout Plain Layout
13562 \begin_inset Flex CharStyle:Code
13565 \begin_layout Plain Layout
13566 LabelStringAppendix
13572 \begin_inset Flex CharStyle:Code
13575 \begin_layout Plain Layout
13585 \begin_layout Itemize
13586 counter values can be expressed using LaTeX-like macros
13587 \begin_inset Flex CharStyle:Code
13590 \begin_layout Plain Layout
13607 \begin_inset Flex CharStyle:Code
13610 \begin_layout Plain Layout
13622 \begin_layout Plain Layout
13632 Actually, the situation is a bit more complicated: any
13651 other than those descibed below will produce arabic numerals.
13652 It would not be surprising to see this change in the future.
13658 \begin_inset Flex CharStyle:Code
13661 \begin_layout Plain Layout
13667 : 1, 2, 3,\SpecialChar \ldots{}
13669 \begin_inset Flex CharStyle:Code
13672 \begin_layout Plain Layout
13678 for lower-case letters: a, b, c, \SpecialChar \ldots{}
13680 \begin_inset Flex CharStyle:Code
13683 \begin_layout Plain Layout
13689 for upper-case letters: A, B, C, \SpecialChar \ldots{}
13691 \begin_inset Flex CharStyle:Code
13694 \begin_layout Plain Layout
13700 for lower-case roman numerals: i, ii, iii, \SpecialChar \ldots{}
13702 \begin_inset Flex CharStyle:Code
13705 \begin_layout Plain Layout
13711 for upper-case roman numerals: I, II, III\SpecialChar \ldots{}
13713 \begin_inset Flex CharStyle:Code
13716 \begin_layout Plain Layout
13722 for hebrew numerals.
13726 \begin_layout Standard
13727 If LabelString is not defined, a default value is constructed as follows:
13728 if the counter has a master counter
13729 \begin_inset Flex CharStyle:Code
13732 \begin_layout Plain Layout
13739 \begin_inset Flex CharStyle:Code
13742 \begin_layout Plain Layout
13749 \begin_inset Flex CharStyle:Code
13752 \begin_layout Plain Layout
13762 is used; otherwise the string
13763 \begin_inset Flex CharStyle:Code
13766 \begin_layout Plain Layout
13777 \begin_layout Description
13778 \begin_inset Flex CharStyle:Code
13781 \begin_layout Plain Layout
13782 LabelStringAppendix [string=""]
13788 \begin_inset Flex CharStyle:Code
13791 \begin_layout Plain Layout
13800 \begin_layout Description
13801 \begin_inset Flex CharStyle:Code
13804 \begin_layout Plain Layout
13811 \begin_inset Flex CharStyle:Code
13814 \begin_layout Plain Layout
13821 \begin_inset Quotes erd
13825 \begin_inset Quotes erd
13828 ] The name of the counter.
13831 \begin_layout Description
13832 \begin_inset Flex CharStyle:Code
13835 \begin_layout Plain Layout
13842 \begin_inset Flex CharStyle:Code
13845 \begin_layout Plain Layout
13852 \begin_inset Quotes erd
13856 \begin_inset Quotes erd
13859 ] If this is set to the name of another counter, the present counter will
13860 be reset everytime the other one is increased.
13862 \begin_inset Flex CharStyle:Code
13865 \begin_layout Plain Layout
13872 \begin_inset Flex CharStyle:Code
13875 \begin_layout Plain Layout
13884 \begin_layout Subsection
13888 \begin_layout Standard
13889 \begin_inset CommandInset label
13895 A font description looks like this:
13898 \begin_layout LyX-Code
13908 \begin_layout LyX-Code
13912 \begin_layout LyX-Code
13916 \begin_layout Standard
13917 The following commands are available:
13920 \begin_layout Description
13921 \begin_inset Flex CharStyle:Code
13924 \begin_layout Plain Layout
13931 \begin_inset Flex CharStyle:Code
13934 \begin_layout Plain Layout
13943 \begin_inset Flex CharStyle:Code
13946 \begin_layout Plain Layout
13953 \begin_inset Flex CharStyle:Code
13956 \begin_layout Plain Layout
13963 \begin_inset Flex CharStyle:Code
13966 \begin_layout Plain Layout
13973 \begin_inset Flex CharStyle:Code
13976 \begin_layout Plain Layout
13983 \begin_inset Flex CharStyle:Code
13986 \begin_layout Plain Layout
13993 \begin_inset Flex CharStyle:Code
13996 \begin_layout Plain Layout
14003 \begin_inset Flex CharStyle:Code
14006 \begin_layout Plain Layout
14013 \begin_inset Flex CharStyle:Code
14016 \begin_layout Plain Layout
14025 \begin_layout Description
14026 \begin_inset Flex CharStyle:Code
14029 \begin_layout Plain Layout
14038 \begin_inset Flex CharStyle:Code
14041 \begin_layout Plain Layout
14052 \begin_inset Flex CharStyle:Code
14055 \begin_layout Plain Layout
14062 \begin_inset Flex CharStyle:Code
14065 \begin_layout Plain Layout
14074 \begin_layout Description
14075 \begin_inset Flex CharStyle:Code
14078 \begin_layout Plain Layout
14085 \begin_inset Flex CharStyle:Code
14088 \begin_layout Plain Layout
14094 ] Valid argument sare:
14095 \begin_inset Flex CharStyle:Code
14098 \begin_layout Plain Layout
14105 \begin_inset Flex CharStyle:Code
14108 \begin_layout Plain Layout
14115 \begin_inset Flex CharStyle:Code
14118 \begin_layout Plain Layout
14125 \begin_inset Flex CharStyle:Code
14128 \begin_layout Plain Layout
14135 \begin_inset Flex CharStyle:Code
14138 \begin_layout Plain Layout
14145 \begin_inset Flex CharStyle:Code
14148 \begin_layout Plain Layout
14155 Each of these turns on or off the corresponding attribute.
14158 \begin_layout Description
14159 \begin_inset Flex CharStyle:Code
14162 \begin_layout Plain Layout
14171 \begin_inset Flex CharStyle:Code
14174 \begin_layout Plain Layout
14185 \begin_inset Flex CharStyle:Code
14188 \begin_layout Plain Layout
14197 \begin_layout Description
14198 \begin_inset Flex CharStyle:Code
14201 \begin_layout Plain Layout
14210 \begin_inset Flex CharStyle:Code
14213 \begin_layout Plain Layout
14224 \begin_inset Flex CharStyle:Code
14227 \begin_layout Plain Layout
14234 \begin_inset Flex CharStyle:Code
14237 \begin_layout Plain Layout
14244 \begin_inset Flex CharStyle:Code
14247 \begin_layout Plain Layout
14256 \begin_layout Description
14257 \begin_inset Flex CharStyle:Code
14260 \begin_layout Plain Layout
14267 \begin_inset Flex CharStyle:Code
14270 \begin_layout Plain Layout
14277 \begin_inset Flex CharStyle:Code
14280 \begin_layout Plain Layout
14287 \begin_inset Flex CharStyle:Code
14290 \begin_layout Plain Layout
14299 \begin_inset Flex CharStyle:Code
14302 \begin_layout Plain Layout
14309 \begin_inset Flex CharStyle:Code
14312 \begin_layout Plain Layout
14319 \begin_inset Flex CharStyle:Code
14322 \begin_layout Plain Layout
14329 \begin_inset Flex CharStyle:Code
14332 \begin_layout Plain Layout
14339 \begin_inset Flex CharStyle:Code
14342 \begin_layout Plain Layout
14351 \begin_layout Subsection
14352 Upgrading old layout files
14355 \begin_layout Standard
14356 The file format of layout files changes from time to time, so old layout
14357 files need to be converted.
14358 This process has been automated since LyX 1.4.0: If LyX reads an old format
14359 layout file it will call the conversion tool
14360 \begin_inset Flex CharStyle:Code
14363 \begin_layout Plain Layout
14364 LyXDir/scripts/layout2layout.py
14369 and convert it to a temporary file in current format.
14370 The original file is left untouched.
14371 If you want to convert the layout file permanently, just call the converter
14375 \begin_layout LyX-Code
14376 python $LyXDir/scripts/layout2layout.py myclass.layout myclassnew.layout
14379 \begin_layout Standard
14380 (You need to replace
14381 \begin_inset Flex CharStyle:Code
14384 \begin_layout Plain Layout
14390 with the name of your LyX system directory, unless you happen to have defined
14391 such an environment variable.) Then copy
14392 \begin_inset Flex CharStyle:Code
14395 \begin_layout Plain Layout
14402 \begin_inset Flex CharStyle:Code
14405 \begin_layout Plain Layout
14414 \begin_layout Standard
14415 The automatic conversion only handles syntax changes.
14416 It cannot handle the case where the contents of included files was changed,
14417 so these will have to be converted separately.
14420 \begin_layout Section
14422 \begin_inset CommandInset label
14424 name "sec:templates"
14431 \begin_layout Standard
14432 Templates are created just like usual documents.
14433 The only difference is that usual documents contain all possible settings,
14434 including the font scheme and the paper size.
14435 Usually a user doesn't want a template to overwrite his defaults in these
14437 For that reason, the designer of a template should remove the corresponding
14439 \begin_inset Flex CharStyle:Code
14442 \begin_layout Plain Layout
14451 \begin_inset Flex CharStyle:Code
14454 \begin_layout Plain Layout
14462 from the template LyX file.
14463 This can be done with any simple text-editor, for example
14464 \begin_inset Flex CharStyle:Code
14467 \begin_layout Plain Layout
14474 \begin_inset Flex CharStyle:Code
14477 \begin_layout Plain Layout
14487 \begin_layout Standard
14488 Put the edited template files you create in
14489 \begin_inset Flex CharStyle:Code
14492 \begin_layout Plain Layout
14498 , copy the ones you use from the global template directory in
14499 \begin_inset Flex CharStyle:Code
14502 \begin_layout Plain Layout
14508 to the same place, and redefine the template path in the
14509 \begin_inset Flex CharStyle:MenuItem
14512 \begin_layout Plain Layout
14520 \SpecialChar \menuseparator
14525 references\SpecialChar \menuseparator
14534 \begin_layout Standard
14535 Note that there is a template which has a particular meaning:
14536 \begin_inset Flex CharStyle:Code
14539 \begin_layout Plain Layout
14546 This template is loaded everytime you create a new document with
14547 \begin_inset Flex CharStyle:MenuItem
14550 \begin_layout Plain Layout
14560 \SpecialChar \menuseparator
14562 \begin_inset Flex CharStyle:MenuItem
14565 \begin_layout Plain Layout
14575 in order to provide useful defaults.
14576 To create this template from inside LyX, all you have to do is to open
14577 a document with the correct settings, and use the
14578 \begin_inset Flex CharStyle:MenuItem
14581 \begin_layout Plain Layout
14586 e as Document Defaults
14594 \begin_layout Chapter
14595 Including External Material
14598 \begin_layout Standard
14599 The use of material from sources external to LyX is covered in detail in
14605 This part of the manual covers what needs to happen behind the scenes for
14606 new sorts of material to be included.
14609 \begin_layout Section
14613 \begin_layout Standard
14614 The external material feature is based on the concept of a
14619 A template is a specification of how LyX should interface with a certain
14621 As bundled, LyX comes with predefined templates for Xfig figures, various
14622 raster format images, chess diagrams, and LilyPond music notation.
14623 You can check the actual list by using the menu
14624 \begin_inset Flex CharStyle:MenuItem
14627 \begin_layout Plain Layout
14628 Insert\SpecialChar \menuseparator
14629 File\SpecialChar \menuseparator
14636 Furthermore, it is possible to roll your own template to support a specific
14638 Later we'll describe in more detail what is involved, and hopefully you
14639 will submit all the templates you create so we can include them in a later
14643 \begin_layout Standard
14644 Another basic idea of the external material feature is to distinguish between
14645 the original file that serves as a base for final material and the produced
14646 file that is included in your exported or printed document.
14647 For example, consider the case of a figure produced with
14648 \begin_inset Flex CharStyle:Code
14651 \begin_layout Plain Layout
14658 The Xfig application itself works on an original file with the
14659 \begin_inset Flex CharStyle:Code
14662 \begin_layout Plain Layout
14669 Within XFig, you create and change your figure, and when you are done,
14671 \begin_inset Flex CharStyle:Code
14674 \begin_layout Plain Layout
14681 When you want to include the figure in your document, you invoke
14682 \begin_inset Flex CharStyle:Code
14685 \begin_layout Plain Layout
14691 in order to create a PostScript file that can readily be included in your
14694 \begin_inset Flex CharStyle:Code
14697 \begin_layout Plain Layout
14703 file is the original file, and the PostScript file is the produced file.
14706 \begin_layout Standard
14707 This distinction is important in order to allow updating of the material
14708 while you are in the process of writing the document.
14709 Furthermore, it provides us with the flexibility that is needed to support
14710 multiple export formats.
14711 For instance, in the case of a plain text file, it is not exactly an award-winn
14712 ing idea to include the figure as raw PostScript®.
14713 Instead, you'd either prefer to just include a reference to the figure
14714 or try to invoke some graphics to Ascii converter to make the final result
14715 look similar to the real graphics.
14716 The external material management allows you to do this, because it is parameter
14717 ized on the different export formats that LyX supports.
14720 \begin_layout Standard
14721 Besides supporting the production of different products according to the
14722 exported format, it supports tight integration with editing and viewing
14724 In the case of an XFig figure, you are able to invoke Xfig on the original
14725 file with a single click from within the external material dialog in LyX,
14726 and also preview the produced PostScript file with ghostview with another
14728 No more fiddling around with the command line and/or file browsers to locate
14729 and manipulate the original or produced files.
14730 In this way, you are finally able to take full advantage of the many different
14731 applications that are relevant to use when you write your documents, and
14732 ultimately be more productive.
14735 \begin_layout Section
14736 The external template configuration file
14739 \begin_layout Standard
14740 It is relatively easy to add custom external template definitions to LyX.
14741 However, be aware that doing this in an careless manner most probably
14745 introduce an easily exploitable security hole.
14746 So before you do this, please read the discussion about security in section
14748 \begin_inset CommandInset ref
14750 reference "sec:Security-discussion"
14757 \begin_layout Standard
14758 Having said that, we encourage you to submit any interesting templates that
14763 \begin_layout Standard
14764 The external templates are defined in the
14765 \begin_inset Flex CharStyle:Code
14768 \begin_layout Plain Layout
14769 LyXDir/lib/external_templates
14775 You can place your own version in
14776 \begin_inset Flex CharStyle:Code
14779 \begin_layout Plain Layout
14780 UserDir/external_templates
14788 \begin_layout Standard
14789 A typical template looks like this:
14792 \begin_layout LyX-Code
14796 \begin_layout LyX-Code
14797 GuiName "XFig: $$AbsOrRelPathParent$$Basename"
14800 \begin_layout LyX-Code
14804 \begin_layout LyX-Code
14808 \begin_layout LyX-Code
14812 \begin_layout LyX-Code
14816 \begin_layout LyX-Code
14820 \begin_layout LyX-Code
14821 AutomaticProduction true
14824 \begin_layout LyX-Code
14828 \begin_layout LyX-Code
14832 \begin_layout LyX-Code
14836 \begin_layout LyX-Code
14837 TransformCommand Rotate RotationLatexCommand
14840 \begin_layout LyX-Code
14841 TransformCommand Resize ResizeLatexCommand
14844 \begin_layout LyX-Code
14845 Product "$$RotateFront$$ResizeFront
14848 \begin_layout LyX-Code
14853 input{$$AbsOrRelPathMaster$$Basename.pstex_t}
14856 \begin_layout LyX-Code
14857 $$ResizeBack$$RotateBack"
14860 \begin_layout LyX-Code
14864 \begin_layout LyX-Code
14865 UpdateResult "$$AbsPath$$Basename.pstex_t"
14868 \begin_layout LyX-Code
14869 Requirement "graphicx"
14872 \begin_layout LyX-Code
14873 ReferencedFile latex "$$AbsOrRelPathMaster$$Basename.pstex_t"
14876 \begin_layout LyX-Code
14877 ReferencedFile latex "$$AbsPath$$Basename.eps"
14880 \begin_layout LyX-Code
14881 ReferencedFile dvi "$$AbsPath$$Basename.eps"
14884 \begin_layout LyX-Code
14888 \begin_layout LyX-Code
14892 \begin_layout LyX-Code
14893 TransformCommand Rotate RotationLatexCommand
14896 \begin_layout LyX-Code
14897 TransformCommand Resize ResizeLatexCommand
14900 \begin_layout LyX-Code
14901 Product "$$RotateFront$$ResizeFront
14904 \begin_layout LyX-Code
14909 input{$$AbsOrRelPathMaster$$Basename.pdftex_t}
14912 \begin_layout LyX-Code
14913 $$ResizeBack$$RotateBack"
14916 \begin_layout LyX-Code
14917 UpdateFormat pdftex
14920 \begin_layout LyX-Code
14921 UpdateResult "$$AbsPath$$Basename.pdftex_t"
14924 \begin_layout LyX-Code
14925 Requirement "graphicx"
14928 \begin_layout LyX-Code
14929 ReferencedFile latex "$$AbsOrRelPathMaster$$Basename.pdftex_t"
14932 \begin_layout LyX-Code
14933 ReferencedFile latex "$$AbsPath$$Basename.pdf"
14936 \begin_layout LyX-Code
14940 \begin_layout LyX-Code
14944 \begin_layout LyX-Code
14945 Product "$$Contents(
14947 "$$AbsPath$$Basename.asc
14952 \begin_layout LyX-Code
14953 UpdateFormat asciixfig
14956 \begin_layout LyX-Code
14957 UpdateResult "$$AbsPath$$Basename.asc"
14960 \begin_layout LyX-Code
14964 \begin_layout LyX-Code
14968 \begin_layout LyX-Code
14969 Product "<graphic fileref=
14971 "$$AbsOrRelPathMaster$$Basename.eps
14976 \begin_layout LyX-Code
14980 \begin_layout LyX-Code
14984 \begin_layout LyX-Code
14985 UpdateResult "$$AbsPath$$Basename.eps"
14988 \begin_layout LyX-Code
14989 ReferencedFile docbook "$$AbsPath$$Basename.eps"
14992 \begin_layout LyX-Code
14993 ReferencedFile docbook-xml "$$AbsPath$$Basename.eps"
14996 \begin_layout LyX-Code
15000 \begin_layout LyX-Code
15001 Product "[XFig: $$FName]"
15004 \begin_layout LyX-Code
15008 \begin_layout LyX-Code
15012 \begin_layout Standard
15013 As you can see, the template is enclosed in
15014 \begin_inset Flex CharStyle:Code
15017 \begin_layout Plain Layout
15023 \SpecialChar \ldots{}
15025 \begin_inset Flex CharStyle:Code
15028 \begin_layout Plain Layout
15035 It contains a header specifying some general settings and, for each supported
15036 primary document file format, a section
15037 \begin_inset Flex CharStyle:Code
15040 \begin_layout Plain Layout
15046 \SpecialChar \ldots{}
15048 \begin_inset Flex CharStyle:Code
15051 \begin_layout Plain Layout
15060 \begin_layout Subsection
15061 The template header
15064 \begin_layout Description
15065 \begin_inset Flex CharStyle:Code
15068 \begin_layout Plain Layout
15069 AutomaticProduction
15070 \begin_inset space ~
15078 Whether the file represented by the template must be generated by LyX.
15079 This command must occur exactly once.
15082 \begin_layout Description
15083 \begin_inset Flex CharStyle:Code
15086 \begin_layout Plain Layout
15088 \begin_inset space ~
15096 A glob pattern that is used in the file dialog to filter out the desired
15098 If there is more than one possible file extension (e.g.
15099 \begin_inset space ~
15103 \begin_inset Flex CharStyle:Code
15106 \begin_layout Plain Layout
15113 \begin_inset Flex CharStyle:Code
15116 \begin_layout Plain Layout
15122 ), use something like
15123 \begin_inset Flex CharStyle:Code
15126 \begin_layout Plain Layout
15133 This command must occur exactly once.
15136 \begin_layout Description
15137 \begin_inset Flex CharStyle:Code
15140 \begin_layout Plain Layout
15142 \begin_inset space ~
15150 The text that is displayed on the button.
15151 This command must occur exactly once.
15154 \begin_layout Description
15155 \begin_inset Flex CharStyle:Code
15158 \begin_layout Plain Layout
15160 \begin_inset space ~
15164 \begin_inset space ~
15172 The help text that is used in the External dialog.
15173 Provide enough information to explain to the user just what the template
15174 can provide him with.
15175 This command must occur exactly once.
15178 \begin_layout Description
15179 \begin_inset Flex CharStyle:Code
15182 \begin_layout Plain Layout
15184 \begin_inset space ~
15192 The file format of the original file.
15193 This must be the name of a format that is known to LyX (see section
15194 \begin_inset CommandInset ref
15196 reference "sub:Formats"
15202 \begin_inset Quotes eld
15206 \begin_inset Flex CharStyle:Code
15209 \begin_layout Plain Layout
15216 \begin_inset Quotes erd
15219 if the template can handle original files of more than one format.
15220 LyX will attempt to interrogate the file itself in order to deduce its
15221 format in this case.
15222 This command must occur exactly once.
15225 \begin_layout Description
15226 \begin_inset Flex CharStyle:Code
15229 \begin_layout Plain Layout
15231 \begin_inset space ~
15239 A unique name for the template.
15240 It must not contain substitution macros (see below).
15243 \begin_layout Description
15244 \begin_inset Flex CharStyle:Code
15247 \begin_layout Plain Layout
15249 \begin_inset space ~
15252 Rotate|Resize|Clip|Extra
15257 This command specifies which transformations are supported by this template.
15258 It may occur zero or more times.
15259 This command enables the corresponding tabs in the external dialog.
15261 \begin_inset Flex CharStyle:Code
15264 \begin_layout Plain Layout
15270 command must have either a corresponding
15271 \begin_inset Flex CharStyle:Code
15274 \begin_layout Plain Layout
15281 \begin_inset Flex CharStyle:Code
15284 \begin_layout Plain Layout
15291 \begin_inset Flex CharStyle:Code
15294 \begin_layout Plain Layout
15301 Otherwise the transformation will not be supported by that format.
15304 \begin_layout Subsection
15308 \begin_layout Description
15309 \begin_inset Flex CharStyle:Code
15312 \begin_layout Plain Layout
15314 \begin_inset space ~
15317 LaTeX|PDFLaTeX|PlainText|DocBook
15322 The primary document file format that this format definition is for.
15323 Not every template has a sensible representation in all document file formats.
15324 Please define nevertheless a
15325 \begin_inset Flex CharStyle:Code
15328 \begin_layout Plain Layout
15334 section for all formats.
15335 Use a dummy text when no representation is available.
15336 Then you can at least see a reference to the external material in the exported
15340 \begin_layout Description
15341 \begin_inset Flex CharStyle:Code
15344 \begin_layout Plain Layout
15346 \begin_inset space ~
15350 \begin_inset space ~
15358 This command defines an additional macro
15359 \begin_inset Flex CharStyle:Code
15362 \begin_layout Plain Layout
15368 for substitution in
15369 \begin_inset Flex CharStyle:Code
15372 \begin_layout Plain Layout
15380 \begin_inset Flex CharStyle:Code
15383 \begin_layout Plain Layout
15389 itself may contain substitution macros.
15390 The advantage over using
15391 \begin_inset Flex CharStyle:Code
15394 \begin_layout Plain Layout
15401 \begin_inset Flex CharStyle:Code
15404 \begin_layout Plain Layout
15410 is that the substituted value of
15411 \begin_inset Flex CharStyle:Code
15414 \begin_layout Plain Layout
15420 is sanitized so that it is a valid optional argument in the document format.
15421 This command may occur zero or more times.
15424 \begin_layout Description
15425 \begin_inset Flex CharStyle:Code
15428 \begin_layout Plain Layout
15430 \begin_inset space ~
15438 The text that is inserted in the exported document.
15439 This is actually the most important command and can be quite complex.
15440 This command must occur exactly once.
15443 \begin_layout Description
15444 \begin_inset Flex CharStyle:Code
15447 \begin_layout Plain Layout
15449 \begin_inset space ~
15457 This command specifies a preamble snippet that will be included in the
15459 It has to be defined using
15460 \begin_inset Flex CharStyle:Code
15463 \begin_layout Plain Layout
15469 \SpecialChar \ldots{}
15471 \begin_inset Flex CharStyle:Code
15474 \begin_layout Plain Layout
15481 This command may occur zero or more times.
15484 \begin_layout Description
15485 \begin_inset Flex CharStyle:Code
15488 \begin_layout Plain Layout
15490 \begin_inset space ~
15494 \begin_inset space ~
15502 This command denotes files that are created by the conversion process and
15503 are needed for a particular export format.
15504 If the filename is relative, it is interpreted relative to the master document.
15505 This command may be given zero or more times.
15508 \begin_layout Description
15509 \begin_inset Flex CharStyle:Code
15512 \begin_layout Plain Layout
15514 \begin_inset space ~
15522 The name of a required LaTeX package.
15523 The package is included via
15524 \begin_inset Flex CharStyle:Code
15527 \begin_layout Plain Layout
15535 in the LaTeX preamble.
15536 This command may occur zero or more times.
15539 \begin_layout Description
15540 \begin_inset Flex CharStyle:Code
15543 \begin_layout Plain Layout
15545 \begin_inset space ~
15549 \begin_inset space ~
15552 RotationLatexCommand
15557 This command specifies that the built in LaTeX command should be used for
15559 This command may occur once or not at all.
15562 \begin_layout Description
15563 \begin_inset Flex CharStyle:Code
15566 \begin_layout Plain Layout
15568 \begin_inset space ~
15572 \begin_inset space ~
15580 This command specifies that the built in LaTeX command should be used for
15582 This command may occur once or not at all.
15585 \begin_layout Description
15586 \begin_inset Flex CharStyle:Code
15589 \begin_layout Plain Layout
15591 \begin_inset space ~
15595 \begin_inset space ~
15598 RotationLatexOption
15603 This command specifies that rotation is done via an optional argument.
15604 This command may occur once or not at all.
15607 \begin_layout Description
15608 \begin_inset Flex CharStyle:Code
15611 \begin_layout Plain Layout
15613 \begin_inset space ~
15617 \begin_inset space ~
15625 This command specifies that resizing is done via an optional argument.
15626 This command may occur once or not at all.
15629 \begin_layout Description
15630 \begin_inset Flex CharStyle:Code
15633 \begin_layout Plain Layout
15635 \begin_inset space ~
15639 \begin_inset space ~
15647 This command specifies that clipping is done via an optional argument.
15648 This command may occur once or not at all.
15651 \begin_layout Description
15652 \begin_inset Flex CharStyle:Code
15655 \begin_layout Plain Layout
15657 \begin_inset space ~
15661 \begin_inset space ~
15669 This command specifies that an extra optional argument is used.
15670 This command may occur once or not at all.
15673 \begin_layout Description
15674 \begin_inset Flex CharStyle:Code
15677 \begin_layout Plain Layout
15679 \begin_inset space ~
15687 The file format of the converted file.
15688 This must be the name of a format that is known to LyX (see the
15689 \begin_inset Flex CharStyle:MenuItem
15692 \begin_layout Plain Layout
15697 ools\SpecialChar \menuseparator
15702 references:Conversion
15708 This command must occur exactly once.
15711 \begin_layout Description
15712 \begin_inset Flex CharStyle:Code
15715 \begin_layout Plain Layout
15717 \begin_inset space ~
15725 The file name of the converted file.
15726 The file name must be absolute.
15727 This command must occur exactly once.
15730 \begin_layout Subsection
15731 Preamble definitions
15734 \begin_layout Standard
15735 The external template configuration file may contain additional preamble
15736 definitions enclosed by
15737 \begin_inset Flex CharStyle:Code
15740 \begin_layout Plain Layout
15746 \SpecialChar \ldots{}
15748 \begin_inset Flex CharStyle:Code
15751 \begin_layout Plain Layout
15758 They can be used by the templates in the
15759 \begin_inset Flex CharStyle:Code
15762 \begin_layout Plain Layout
15771 \begin_layout Section
15772 The substitution mechanism
15775 \begin_layout Standard
15776 When the external material facility invokes an external program, it is done
15777 on the basis of a command defined in the template configuration file.
15778 These commands can contain various macros that are expanded before execution.
15779 Execution always take place in the directory of the containing document.
15782 \begin_layout Standard
15783 Also, whenever external material is to be displayed, the name will be produced
15784 by the substitution mechanism, and most other commands in the template
15785 definition support substitution as well.
15788 \begin_layout Standard
15789 The available macros are the following:
15792 \begin_layout Description
15793 \begin_inset Flex CharStyle:Code
15796 \begin_layout Plain Layout
15797 $$AbsOrRelPathMaster
15802 The file path, absolute or relative to the master LyX document.
15805 \begin_layout Description
15806 \begin_inset Flex CharStyle:Code
15809 \begin_layout Plain Layout
15810 $$AbsOrRelPathParent
15815 The file path, absolute or relative to the LyX document.
15818 \begin_layout Description
15819 \begin_inset Flex CharStyle:Code
15822 \begin_layout Plain Layout
15828 The absolute file path.
15831 \begin_layout Description
15832 \begin_inset Flex CharStyle:Code
15835 \begin_layout Plain Layout
15841 The filename without path and without the extension.
15844 \begin_layout Description
15845 \begin_inset Flex CharStyle:Code
15848 \begin_layout Plain Layout
15850 \begin_inset Quotes eld
15854 \begin_inset Quotes erd
15862 This macro will expand to the contents of the file with the name
15863 \begin_inset Flex CharStyle:Code
15866 \begin_layout Plain Layout
15875 \begin_layout Description
15876 \begin_inset Flex CharStyle:Code
15879 \begin_layout Plain Layout
15885 The file extension (including the dot).
15888 \begin_layout Description
15889 \begin_inset Flex CharStyle:Code
15892 \begin_layout Plain Layout
15898 The filename of the file specified in the external material dialog.
15899 This is either an absolute name, or it is relative to the LyX document.
15902 \begin_layout Description
15903 \begin_inset Flex CharStyle:Code
15906 \begin_layout Plain Layout
15913 \begin_inset Flex CharStyle:Code
15916 \begin_layout Plain Layout
15922 (absolute name or relative to the LyX document).
15925 \begin_layout Description
15926 \begin_inset Flex CharStyle:Code
15929 \begin_layout Plain Layout
15935 The file path, relative to the master LyX document.
15938 \begin_layout Description
15939 \begin_inset Flex CharStyle:Code
15942 \begin_layout Plain Layout
15948 The file path, relative to the LyX document.
15951 \begin_layout Description
15952 \begin_inset Flex CharStyle:Code
15955 \begin_layout Plain Layout
15961 This macro will expand to the absolute path of the system directory.
15962 This is typically used to point to the various helper scripts that are
15966 \begin_layout Description
15967 \begin_inset Flex CharStyle:Code
15970 \begin_layout Plain Layout
15976 A name and full path to a temporary file which will be automatically deleted
15977 whenever the containing document is closed, or the external material insertion
15981 \begin_layout Standard
15982 All path macros contain a trailing directory separator, so you can construct
15984 the absolute filename with
15985 \begin_inset Flex CharStyle:Code
15988 \begin_layout Plain Layout
15989 $$AbsPath$$Basename$$Extension
15997 \begin_layout Standard
15998 The macros above are substituted in all commands unless otherwise noted.
16000 \begin_inset Flex CharStyle:Code
16003 \begin_layout Plain Layout
16009 supports additionally the following substitutions if they are enabled by
16011 \begin_inset Flex CharStyle:Code
16014 \begin_layout Plain Layout
16021 \begin_inset Flex CharStyle:Code
16024 \begin_layout Plain Layout
16033 \begin_layout Description
16034 \begin_inset Flex CharStyle:Code
16037 \begin_layout Plain Layout
16043 The front part of the resize command.
16046 \begin_layout Description
16047 \begin_inset Flex CharStyle:Code
16050 \begin_layout Plain Layout
16056 The back part of the resize command.
16059 \begin_layout Description
16060 \begin_inset Flex CharStyle:Code
16063 \begin_layout Plain Layout
16069 The front part of the rotation command.
16072 \begin_layout Description
16073 \begin_inset Flex CharStyle:Code
16076 \begin_layout Plain Layout
16082 The back part of the rotation command.
16085 \begin_layout Standard
16086 The value string of the
16087 \begin_inset Flex CharStyle:Code
16090 \begin_layout Plain Layout
16096 command supports additionally the following substitutions if they are enabled
16098 \begin_inset Flex CharStyle:Code
16101 \begin_layout Plain Layout
16108 \begin_inset Flex CharStyle:Code
16111 \begin_layout Plain Layout
16120 \begin_layout Description
16121 \begin_inset Flex CharStyle:Code
16124 \begin_layout Plain Layout
16133 \begin_layout Description
16134 \begin_inset Flex CharStyle:Code
16137 \begin_layout Plain Layout
16146 \begin_layout Description
16147 \begin_inset Flex CharStyle:Code
16150 \begin_layout Plain Layout
16159 \begin_layout Description
16160 \begin_inset Flex CharStyle:Code
16163 \begin_layout Plain Layout
16169 The rotation option.
16172 \begin_layout Standard
16173 You may ask why there are so many path macros.
16174 There are mainly two reasons:
16177 \begin_layout Enumerate
16178 Relative and absolute file names should remain relative or absolute, respectivel
16180 Users may have reasons to prefer either form.
16181 Relative names are useful for portable documents that should work on different
16182 machines, for example.
16183 Absolute names may be required by some programs.
16186 \begin_layout Enumerate
16187 LaTeX treats relative file names differently than LyX and other programs
16188 in nested included files.
16189 For LyX, a relative file name is always relative to the document that contains
16191 For LaTeX, it is always relative to the master document.
16192 These two definitions are identical if you have only one document, but
16193 differ if you have a master document that includes part documents.
16194 That means that relative filenames must be transformed when presented to
16196 Fortunately LyX does this automatically for you if you choose the right
16200 \begin_layout Standard
16201 So which path macro should be used in new template definitions? The rule
16205 \begin_layout Itemize
16207 \begin_inset Flex CharStyle:Code
16210 \begin_layout Plain Layout
16216 if an absolute path is required.
16219 \begin_layout Itemize
16221 \begin_inset Flex CharStyle:Code
16224 \begin_layout Plain Layout
16225 $$AbsOrRelPathMaster
16230 if the substituted string is some kind of LaTeX input.
16233 \begin_layout Itemize
16235 \begin_inset Flex CharStyle:Code
16238 \begin_layout Plain Layout
16239 $$AbsOrRelPathParent
16244 in order to preserve the user's choice.
16247 \begin_layout Standard
16248 There are special cases where this rule does not work and e.g.
16249 \begin_inset space ~
16252 relative names are needed, but normally it will work just fine.
16253 One example for such a case is the command
16254 \begin_inset Flex CharStyle:Code
16257 \begin_layout Plain Layout
16258 ReferencedFile latex "$$AbsOrRelPathMaster$$Basename.pstex_t"
16263 in the XFig template above: We can't use the absolute name because the
16265 \begin_inset Flex CharStyle:Code
16268 \begin_layout Plain Layout
16274 files needs the relative name in order to rewrite the file content.
16277 \begin_layout Section
16278 \begin_inset CommandInset label
16280 name "sec:Security-discussion"
16284 Security discussion
16287 \begin_layout Standard
16288 \begin_inset Note Note
16291 \begin_layout Plain Layout
16292 This section is outdated
16297 The external material feature interfaces with a lot of external programs
16298 and does so automatically, so we have to consider the security implications
16300 In particular, since you have the option of including your own filenames
16301 and/or parameter strings and those are expanded into a command, it seems
16302 that it would be possible to create a malicious document which executes
16303 arbitrary commands when a user views or prints the document.
16304 This is something we definately want to avoid.
16307 \begin_layout Standard
16308 However, since the external program commands are specified in the template
16309 configuration file only, there are no security issues if LyX is properly
16310 configured with safe templates only.
16311 This is so because the external programs are invoked with the
16312 \begin_inset Flex CharStyle:Code
16315 \begin_layout Plain Layout
16321 -system call rather than the
16322 \begin_inset Flex CharStyle:Code
16325 \begin_layout Plain Layout
16331 system-call, so it's not possible to execute arbitrary commands from the
16332 filename or parameter section via the shell.
16335 \begin_layout Standard
16336 This also implies that you are restricted in what command strings you can
16337 use in the external material templates.
16338 In particular, pipes and redirection are not readily available.
16339 This has to be so if LyX should remain safe.
16340 If you want to use some of the shell features, you should write a safe
16341 script to do this in a controlled manner, and then invoke the script from
16342 the command string.
16344 \begin_inset Flex CharStyle:Code
16347 \begin_layout Plain Layout
16353 directory of the LyX installation, you can find a safe wrapper script
16354 \begin_inset Flex CharStyle:Code
16357 \begin_layout Plain Layout
16358 general_command_wrapper.py
16363 that supports redirection of input and output.
16364 That can serve as an example for how to write safe template scripts.
16365 For a more advanced example that uses
16366 \begin_inset Flex CharStyle:Code
16369 \begin_layout Plain Layout
16375 and friends, take a look at the
16376 \begin_inset Flex CharStyle:Code
16379 \begin_layout Plain Layout
16388 \begin_layout Standard
16389 It is possible to design a template that interacts directly with the shell,
16390 but since this would allow a malicious user to execute arbitrary commands
16391 by writing clever filenames and/or parameters, we generally recommend that
16392 you only use safe scripts that work with the
16393 \begin_inset Flex CharStyle:Code
16396 \begin_layout Plain Layout
16402 system call in a controlled manner.
16403 Of course, for use in a controlled environment, it can be tempting to just
16404 fall back to use ordinary shell scripts.
16405 If you do so, be aware that you
16409 provide an easily exploitable security hole in your system.
16410 Of course it stands to reason that such unsafe templates will never be
16411 included in the standard LyX distribution, although we do encourage people
16412 to submit new templates in the open source tradition.
16413 But LyX as shipped from the official distribution channels will never have
16417 \begin_layout Standard
16418 Including external material provides a lot of power, and you have to be
16419 careful not to introduce security hazards with this power.
16420 A subtle error in a single line in an innocent looking script can open
16421 the door to huge security problems.
16422 So if you do not fully understand the issues, we recommend that you consult
16423 a knowledgable security professional or the LyX development team if you
16424 have any questions about whether a given template is safe or not.
16425 And do this before you use it in an uncontrolled environment.
16428 \begin_layout Chapter
16432 \begin_layout Section
16436 \begin_layout Standard
16437 The LyX server is a method implemented in LyX that will enable other programs
16438 to talk to LyX, invoke LyX commands, and retrieve information about the
16439 LyX internal state.
16440 This is only intended for advanced users, but they should find it useful.
16441 Please note that, at present,
16443 the server does not work on Windows
16449 \begin_layout Plain Layout
16450 There is no principled reason it cannot do so.
16451 But none of the developers on Windows® have yet implemented this functionality
16460 \begin_layout Section
16461 Starting the LyX Server
16464 \begin_layout Standard
16465 The LyX server works through the use of a pair of named pipes.
16466 These are usually located in
16467 \begin_inset Flex CharStyle:Code
16470 \begin_layout Plain Layout
16477 \begin_inset Quotes eld
16481 \begin_inset Flex CharStyle:Code
16484 \begin_layout Plain Layout
16491 \begin_inset Quotes erd
16495 \begin_inset Quotes eld
16499 \begin_inset Flex CharStyle:Code
16502 \begin_layout Plain Layout
16509 \begin_inset Quotes erd
16513 External programs write into
16514 \begin_inset Flex CharStyle:Code
16517 \begin_layout Plain Layout
16523 and read back data from
16524 \begin_inset Flex CharStyle:Code
16527 \begin_layout Plain Layout
16534 The stem of the pipe names can be defined in the
16535 \begin_inset Flex CharStyle:MenuItem
16538 \begin_layout Plain Layout
16543 ools\SpecialChar \menuseparator
16553 dialog, for example
16554 \begin_inset Flex CharStyle:Code
16557 \begin_layout Plain Layout
16558 "/home/myhome/.lyxpipe"
16566 \begin_layout Standard
16568 \begin_inset Flex CharStyle:Code
16571 \begin_layout Plain Layout
16578 \begin_inset Flex CharStyle:Code
16581 \begin_layout Plain Layout
16587 ' to create the pipes.
16588 The above setting also has the effect of activating the LyX server.
16589 If one of the pipes already exists, LyX will assume that another LyX process
16590 is already running and will not start the server.
16591 To have several LyX processes with servers at the same time, you have to
16592 change the configuration between the start of the programs.
16595 \begin_layout Standard
16596 If you are developing a client program, you might find it useful to enable
16597 debugging information from the LyX server.
16598 Do this by starting LyX as lyx -dbg lyxserver.
16601 \begin_layout Standard
16602 Warning: if LyX crashes, it may not manage to remove the pipes; in this
16603 case you must remove them manually.
16604 If LyX starts and the pipes exist already, it will not start any server.
16607 \begin_layout Standard
16608 Other than this, there are a few points to consider:
16611 \begin_layout Itemize
16612 Both server and clients must run on UNIX or OS/2 machines.
16613 Communications between LyX on UNIX and clients on OS/2 or vice versa is
16614 not possible right now.
16617 \begin_layout Itemize
16618 On OS/2, only one client can connect to LyXServer at a time.
16621 \begin_layout Itemize
16622 On OS/2, clients must open inpipe with
16623 \begin_inset Flex CharStyle:Code
16626 \begin_layout Plain Layout
16635 \begin_layout Standard
16639 \begin_layout Standard
16640 You can find a complete example client written in C in the source distribution
16642 \begin_inset Flex CharStyle:Code
16645 \begin_layout Plain Layout
16646 development/lyxserver/server_monitor.c
16654 \begin_layout Section
16655 Normal communication
16658 \begin_layout Standard
16659 To issue a LyX call, the client writes a line of ASCII text into the input
16661 This line has the following format:
16664 \begin_layout Quote
16678 \begin_layout Description
16683 is a name that the client can choose arbitrarily.
16684 Its only use is that LyX will echo it if it sends an answer---so a client
16685 can dispatch results from different requesters.
16688 \begin_layout Description
16693 is the function you want LyX to perform.
16694 It is the same as the commands you'd use in the minibuffer.
16697 \begin_layout Description
16702 is an optional argument which is meaningful only to some functions (for
16704 \begin_inset Quotes eld
16708 \begin_inset Quotes erd
16711 which will insert the argument as text at the cursor position.)
16714 \begin_layout Standard
16715 The answer from LyX will arrive in the output pipe and be of the form
16718 \begin_layout Quote
16732 \begin_layout Standard
16741 are just echoed from the command request, while
16745 is more or less useful information filled according to how the command
16746 execution worked out.
16747 Some commands will return information about the internal state of LyX,
16749 \begin_inset Quotes eld
16753 \begin_inset Quotes erd
16756 , while other will return an empty data-response.
16757 This means that the command execution went fine.
16760 \begin_layout Standard
16761 In case of errors, the response from LyX will have this form
16764 \begin_layout Quote
16778 \begin_layout Standard
16783 should contain an explanation of why the command failed.
16786 \begin_layout Standard
16790 \begin_layout LyX-Code
16791 echo "LYXCMD:test:beginning-of-buffer:" >~/.lyxpipe.in
16794 \begin_layout LyX-Code
16795 echo "LYXCMD:test:get-xy:" >~/.lyxpipe.in
16796 \begin_inset Newline newline
16799 read a <~/.lyxpipe.out
16800 \begin_inset Newline newline
16806 \begin_layout Section
16810 \begin_layout Standard
16811 LyX can notify clients of events going on asynchronously.
16812 Currently it will only do this if the user binds a key sequence with the
16814 \begin_inset Quotes eld
16818 \begin_inset Quotes erd
16822 The format of the string LyX sends is as follows:
16825 \begin_layout Quote
16826 \begin_inset Flex CharStyle:Code
16829 \begin_layout Plain Layout
16840 \begin_layout Standard
16845 is the printed representation of the key sequence that was actually typed
16849 \begin_layout Standard
16850 This mechanism can be used to extend LyX's command set and implement macros:
16851 bind some key sequence to
16852 \begin_inset Quotes eld
16856 \begin_inset Quotes erd
16859 , start a client that listens on the out pipe, dispatches the command according
16860 to the sequence and starts a function that may use LyX calls and LyX requests
16861 to issue a command or a series of commands to LyX.
16864 \begin_layout Section
16865 The simple LyX Server Protocol
16868 \begin_layout Standard
16869 LyX implements a simple protocol that can be used for session management.
16870 All messages are of the form
16873 \begin_layout Quote
16883 \begin_layout Standard
16889 \begin_inset Quotes eld
16893 \begin_inset Quotes erd
16897 \begin_inset Quotes eld
16901 \begin_inset Quotes erd
16906 \begin_inset Quotes eld
16910 \begin_inset Quotes erd
16913 is received from a client, LyX will report back to inform the client that
16914 it's listening to it's messages, while
16915 \begin_inset Quotes eld
16919 \begin_inset Quotes erd
16922 sent from LyX will inform clients that LyX is closing.