1 #LyX 1.6.0svn created this file. For more info see http://www.lyx.org/
7 % DO NOT ALTER THIS PREAMBLE!!!
9 % This preamble is designed to ensure that 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
7289 Document\SpecialChar \menuseparator
7298 \begin_layout Standard
7299 Building modules is the easiest way to get started with layout editing,
7300 since it can be as simple as adding a single new paragraph or flex inset.
7301 But modules may, in principle, contain anything a layout file can contain.
7304 \begin_layout Standard
7305 A module must begin with a line like the following:
7308 \begin_layout LyX-Code
7311 DeclareLyXModule[endnotes.sty]{Endnotes}
7314 \begin_layout Standard
7315 The argument in square brackets is optional: It declares any LaTeX packages
7316 on which the module depends.
7317 The mandatory argument, in curly brackets, is the name of the module, as
7319 \begin_inset Flex CharStyle:MenuItem
7322 \begin_layout Plain Layout
7323 Document\SpecialChar \menuseparator
7333 \begin_layout Standard
7334 The module declaration should then be followed by lines like the following:
7337 \begin_layout LyX-Code
7341 \begin_layout LyX-Code
7342 #Adds an endnote command, in addition to footnotes.
7346 \begin_layout LyX-Code
7347 #You will need to add
7349 theendnotes in ERT where you
7352 \begin_layout LyX-Code
7353 #want the endnotes to appear.
7357 \begin_layout LyX-Code
7361 \begin_layout LyX-Code
7362 #Requires: somemodule | othermodule
7365 \begin_layout LyX-Code
7366 #Excludes: badmodule
7369 \begin_layout Standard
7370 The description is used in
7371 \begin_inset Flex CharStyle:MenuItem
7374 \begin_layout Plain Layout
7375 Document\SpecialChar \menuseparator
7381 to provide the user with information about what the module does.
7383 \begin_inset Flex CharStyle:Code
7386 \begin_layout Plain Layout
7392 line is used to identify other modules with which this one must be used;
7394 \begin_inset Flex CharStyle:Code
7397 \begin_layout Plain Layout
7403 line is used to identify modules with which this one may not be used.
7404 Both are optional, and, as shown, multiple modules should be separated
7405 with the pipe symbol: |.
7406 Note that the required modules are treated disjunctively:
7410 of the required modules must be used.
7415 excluded module may be used.
7416 Note that modules are identified here by their
7420 without the .module extension.
7422 \begin_inset Flex CharStyle:Code
7425 \begin_layout Plain Layout
7432 \begin_inset Flex CharStyle:Code
7435 \begin_layout Plain Layout
7444 \begin_layout Standard
7445 After creating a new module, you will need to reconfigure and then restart
7446 LyX for the module to appear in the menu.
7447 However, changes you make to the module will be seen immediately, if you
7449 \begin_inset Flex CharStyle:MenuItem
7452 \begin_layout Plain Layout
7453 Document\SpecialChar \menuseparator
7459 , highlight something, and then hit
7460 \begin_inset Quotes eld
7464 \begin_inset Quotes erd
7470 It is strongly recommended that you save your work before doing so
7475 it is strongly recommended that you not attempt to edit modules while simultaneo
7476 usly working on documents
7479 Though of course the developers strive to keep LyX stable in such situations,
7480 syntax errors and the like in your module file could cause strange behavior.
7483 \begin_layout Subsection
7484 Supporting new document classes
7487 \begin_layout Standard
7488 There are two situations you are likely to encounter when wanting to support
7489 a new LaTeX document class, involving LaTeX2e class (
7490 \begin_inset Flex CharStyle:Code
7493 \begin_layout Plain Layout
7500 \begin_inset Flex CharStyle:Code
7503 \begin_layout Plain Layout
7510 Supporting a style file is usually fairly easy.
7511 Supporting a new document class is a bit harder.
7514 \begin_layout Subsection
7516 \begin_inset Flex CharStyle:MenuItem
7519 \begin_layout Plain Layout
7528 \begin_layout Standard
7529 If your new document class is provided as a style file that is used in conjuncti
7530 on with an existing, supported document class---for the sake of the example,
7531 we'll assume that the style file is called
7532 \begin_inset Flex CharStyle:MenuItem
7535 \begin_layout Plain Layout
7541 and it is meant to be used with
7542 \begin_inset Flex CharStyle:MenuItem
7545 \begin_layout Plain Layout
7551 , which is a standard class---start by copying the existing class's layout
7552 file into your local directory:
7555 \begin_layout LyX-Code
7556 cp report.layout ~/.lyx/layouts/myclass.layout
7559 \begin_layout Standard
7561 \begin_inset Flex CharStyle:Code
7564 \begin_layout Plain Layout
7570 and change the line:
7573 \begin_layout LyX-Code
7576 DeclareLaTeXClass{report}
7579 \begin_layout Standard
7583 \begin_layout LyX-Code
7586 DeclareLaTeXClass[report, myclass.sty]{report (myclass)}
7589 \begin_layout Standard
7593 \begin_layout LyX-Code
7595 \begin_inset Newline newline
7601 \begin_inset Newline newline
7607 \begin_layout Standard
7608 near the top of the file.
7611 \begin_layout Standard
7612 Start LyX and select
7613 \begin_inset Flex CharStyle:MenuItem
7616 \begin_layout Plain Layout
7621 ools\SpecialChar \menuseparator
7632 Then restart LyX and try creating a new document.
7634 \begin_inset Flex CharStyle:MenuItem
7637 \begin_layout Plain Layout
7643 " as a document class option in the
7644 \begin_inset Flex CharStyle:MenuItem
7647 \begin_layout Plain Layout
7652 ocument\SpecialChar \menuseparator
7663 It is likely that some of the sectioning commands and such in your new
7664 class will work differently from how they worked in the base class---
7665 \begin_inset Flex CharStyle:Code
7668 \begin_layout Plain Layout
7674 in this example---so you can fiddle around with the settings for the different
7675 sections if you wish.
7678 \begin_layout Subsection
7680 \begin_inset Flex CharStyle:MenuItem
7683 \begin_layout Plain Layout
7692 \begin_layout Standard
7693 There are two possibilities here.
7694 One is that the class file is itself based upon an existing document class.
7695 For example, many thesis classes are based upon
7696 \begin_inset Flex CharStyle:MenuItem
7699 \begin_layout Plain Layout
7706 To see whether yours is, look for a line like
7709 \begin_layout LyX-Code
7715 \begin_layout Standard
7717 If so, then you may proceed largely as in the previous section, though
7718 the DeclareLaTeXClass line will be different.
7719 If your new class is thesis, and it is based upon book, then the line should
7724 \begin_layout Plain Layout
7725 And it will be easiest if you save the file to
7726 \begin_inset Flex CharStyle:Code
7729 \begin_layout Plain Layout
7735 : LyX assumes that the document class has the same name as the layout file.
7744 \begin_layout LyX-Code
7747 DeclareLaTeXClass[thesis,book]{thesis}
7750 \begin_layout Standard
7751 If, on the other hand, the new class is not based upon an existing class,
7752 you will probably have to
7753 \begin_inset Quotes eld
7757 \begin_inset Quotes erd
7761 We strongly suggest copying an existing layout file which uses a similar
7762 LaTeX class and then modifying it, if you can do so.
7763 At least use an existing file as a starting point so you can find out what
7764 items you need to worry about.
7765 Again, the specifics are covered below.
7768 \begin_layout Section
7769 Declaring a new text class
7772 \begin_layout Standard
7773 When it's finally time to get your hands dirty and create or edit your own
7774 layout file, the following sections describe what you're up against.
7775 Our advice is to go slowly, save and test often, listen to soothing music,
7776 and enjoy one or two of your favorite adult beverages; more if you are
7777 getting particularly stuck.
7778 It's really not that hard, except that the multitude of options can become
7779 overwhelming if you try to do to much in one sitting.
7780 Go have another adult beverage, just for good measure.
7783 \begin_layout Standard
7787 \begin_layout Standard
7788 Lines in a layout file which begin with a
7789 \begin_inset Flex CharStyle:Code
7792 \begin_layout Plain Layout
7799 There is one exception to this rule: all layouts should begin with lines
7803 \begin_layout LyX-Code
7806 #% Do not delete the line below; configure depends on this
7809 \begin_layout LyX-Code
7814 DeclareLaTeXClass{article}
7817 \begin_layout Standard
7818 The second line is used when you configure LyX.
7819 The layout file is read by the LaTeX script
7820 \begin_inset Flex CharStyle:Code
7823 \begin_layout Plain Layout
7829 , in a special mode where
7830 \begin_inset Flex CharStyle:Code
7833 \begin_layout Plain Layout
7840 The first line is just a LaTeX comment, and the second one contains the
7841 declaration of the text class.
7842 If these lines appear in a file named
7843 \begin_inset Flex CharStyle:Code
7846 \begin_layout Plain Layout
7852 , then they define a text class of name
7853 \begin_inset Flex CharStyle:Code
7856 \begin_layout Plain Layout
7862 (the name of the layout file) which uses the LaTeX document class
7863 \begin_inset Flex CharStyle:Code
7866 \begin_layout Plain Layout
7872 (the default is to use the same name as the layout).
7874 \begin_inset Quotes eld
7878 \begin_inset Quotes erd
7881 that appears above is used as a description of the text class in the
7882 \begin_inset Flex CharStyle:MenuItem
7885 \begin_layout Plain Layout
7890 ocument\SpecialChar \menuseparator
7903 \begin_layout Standard
7904 Let's assume that you wrote your own text class that uses the
7905 \begin_inset Flex CharStyle:Code
7908 \begin_layout Plain Layout
7914 document class, but where you changed the appearance of the section headings.
7915 If you put it in a file
7916 \begin_inset Flex CharStyle:Code
7919 \begin_layout Plain Layout
7925 , the header of this file should be:
7928 \begin_layout LyX-Code
7931 #% Do not delete the line below; configure depends on this
7934 \begin_layout LyX-Code
7939 DeclareLaTeXClass[article]{article (with my own headings)}
7942 \begin_layout Standard
7943 This declares a text class
7944 \begin_inset Flex CharStyle:Code
7947 \begin_layout Plain Layout
7953 , associated with the LaTeX document class
7954 \begin_inset Flex CharStyle:Code
7957 \begin_layout Plain Layout
7964 \begin_inset Quotes eld
7967 article (with my own headings)
7968 \begin_inset Quotes erd
7972 If your text class depends on several packages, you can declare it as:
7975 \begin_layout LyX-Code
7978 #% Do not delete the line below; configure depends on this
7981 \begin_layout LyX-Code
7986 DeclareLaTeXClass[article,foo.sty]{article (with my own headings)}
7989 \begin_layout Standard
7990 This indicates that your text class uses the foo.sty package.
7991 Finally, it is also possible to declare classes for DocBook code.
7992 Typical declarations will look like
7995 \begin_layout LyX-Code
7998 #% Do not delete the line below; configure depends on this
8001 \begin_layout LyX-Code
8006 DeclareDocBookClass[article]{SGML (DocBook article)}
8009 \begin_layout Standard
8010 Note that these declarations can also be given an optional parameter declaring
8011 the name of the document class (but not a list).
8014 \begin_layout Standard
8015 So, to be as explicit as possible, the form of the layout declaration is:
8018 \begin_layout LyX-Code
8023 DeclareLaTeXClass[class,package.sty]{layout description}
8026 \begin_layout Standard
8027 The class need only be specified if the name of the LaTeX class file and
8028 the name of the layout file are different; if the name of the classfile
8029 is not specified, then LyX will simply assume that it is the same as the
8030 name of the layout file.
8033 \begin_layout Standard
8034 When the text class has been modified to your taste, all you have to do
8035 is to copy it either to
8036 \begin_inset Flex CharStyle:Code
8039 \begin_layout Plain Layout
8046 \begin_inset Flex CharStyle:Code
8049 \begin_layout Plain Layout
8056 \begin_inset Flex CharStyle:MenuItem
8059 \begin_layout Plain Layout
8064 ools\SpecialChar \menuseparator
8074 , exit LyX and restart it.
8075 Then your new text class should be available along with the others.
8078 \begin_layout Standard
8079 In versions of LyX prior to 1.6, you had to restart LyX to see any changes
8080 you made to your layout files.
8081 As a result, editing layout files could be very time consuming.
8082 Beginning with 1.6, however, you can force a reload of the layout currently
8083 in use by using the LyX function
8084 \begin_inset Flex CharStyle:MenuItem
8087 \begin_layout Plain Layout
8094 There is no default binding for this function---though, of course, you
8095 can bind it to a key yourself (see section
8096 \begin_inset CommandInset ref
8098 reference "sec:bindings"
8103 If you want to use this function, then, you should simply enter it in the
8109 : This is very much an `advanced feature'.
8114 recommended that you save your work before using this function.
8119 recommended that you not attempt to edit your layout while simultaneously
8120 working on a document that you care about.
8121 Use a test document.
8122 Syntax errors and the like in your layout file could cause peculiar behavior.
8123 In particular, such errors could cause LyX to regard the current layout
8124 as invalid and to attempt to switch to some other layout.
8125 The LyX team strives to keep LyX stable in such situations, but safe is
8129 \begin_layout Subsection
8133 \begin_layout Standard
8134 The first non-comment line must contain the file format number:
8137 \begin_layout Description
8138 \begin_inset Flex CharStyle:Code
8141 \begin_layout Plain Layout
8148 \begin_inset Flex CharStyle:Code
8151 \begin_layout Plain Layout
8157 ] This tag was introduced with LyX 1.4.0 (layout files of LyX 1.3.x and earlier
8158 don't have an explicit file format).
8159 The file format that is documented here is format 8.
8162 \begin_layout Subsection
8163 General text class parameters
8166 \begin_layout Standard
8167 These are the general parameters which describe the form of the entire document:
8170 \begin_layout Description
8171 \begin_inset Flex CharStyle:Code
8174 \begin_layout Plain Layout
8180 Adds information to the document preamble.
8182 \begin_inset Quotes eld
8186 \begin_inset Flex CharStyle:Code
8189 \begin_layout Plain Layout
8196 \begin_inset Quotes erd
8202 \begin_layout Description
8203 \begin_inset Flex CharStyle:Code
8206 \begin_layout Plain Layout
8212 Describes various global options supported by the document class.
8214 \begin_inset space ~
8218 \begin_inset CommandInset ref
8220 reference "sec:classoptions"
8226 \begin_inset Quotes eld
8230 \begin_inset Flex CharStyle:Code
8233 \begin_layout Plain Layout
8240 \begin_inset Quotes erd
8246 \begin_layout Description
8247 \begin_inset Flex CharStyle:Code
8250 \begin_layout Plain Layout
8257 \begin_inset Flex CharStyle:Code
8260 \begin_layout Plain Layout
8269 \begin_inset Flex CharStyle:Code
8272 \begin_layout Plain Layout
8278 ] Whether the class should default to having one or two columns.
8279 Can be changed in the
8280 \begin_inset Flex CharStyle:MenuItem
8283 \begin_layout Plain Layout
8288 ocument\SpecialChar \menuseparator
8301 \begin_layout Description
8302 \begin_inset Flex CharStyle:Code
8305 \begin_layout Plain Layout
8311 This sequence defines a new counter.
8313 \begin_inset space ~
8317 \begin_inset CommandInset ref
8319 reference "sec:counter"
8325 \begin_inset Quotes eld
8329 \begin_inset Flex CharStyle:Code
8332 \begin_layout Plain Layout
8339 \begin_inset Quotes erd
8345 \begin_layout Description
8346 \begin_inset Flex CharStyle:Code
8349 \begin_layout Plain Layout
8355 Sets the default font used to display the document.
8357 \begin_inset space ~
8361 \begin_inset CommandInset ref
8363 reference "sec:fonts"
8367 for how to declare fonts.
8369 \begin_inset Quotes eld
8373 \begin_inset Flex CharStyle:Code
8376 \begin_layout Plain Layout
8383 \begin_inset Quotes erd
8389 \begin_layout Description
8390 \begin_inset Flex CharStyle:Code
8393 \begin_layout Plain Layout
8400 \begin_inset Flex CharStyle:Code
8403 \begin_layout Plain Layout
8409 ] This is the style that will be assigned to new paragraphs, usually
8410 \begin_inset Flex CharStyle:MenuItem
8413 \begin_layout Plain Layout
8420 This will default to the first defined style if not given, but you are
8421 highly encouraged to use this directive.
8424 \begin_layout Description
8425 \begin_inset Flex CharStyle:Code
8428 \begin_layout Plain Layout
8434 Defines a new float.
8436 \begin_inset space ~
8440 \begin_inset CommandInset ref
8442 reference "sec:floats"
8448 \begin_inset Quotes eld
8452 \begin_inset Flex CharStyle:Code
8455 \begin_layout Plain Layout
8462 \begin_inset Quotes erd
8468 \begin_layout Description
8469 \begin_inset Flex CharStyle:Code
8472 \begin_layout Plain Layout
8478 As its name implies, this command allows you to include another layout
8479 definition file within yours to avoid duplicating commands.
8480 Common examples are the standard layout files, for example,
8481 \begin_inset Flex CharStyle:Code
8484 \begin_layout Plain Layout
8490 , which contains most of the basic layouts.
8493 \begin_layout Description
8494 \begin_inset Flex CharStyle:Code
8497 \begin_layout Plain Layout
8503 This section (re-)defines the layout of an inset.
8504 It can be applied to an existing inset of to a new, user-defined inset,
8505 e.g., a new character style.
8507 \begin_inset space ~
8511 \begin_inset CommandInset ref
8513 reference "sec:charstyle"
8517 for more information.
8519 \begin_inset Quotes eld
8523 \begin_inset Flex CharStyle:Code
8526 \begin_layout Plain Layout
8533 \begin_inset Quotes erd
8539 \begin_layout Description
8540 \begin_inset Flex CharStyle:Code
8543 \begin_layout Plain Layout
8552 \begin_layout Description
8553 \begin_inset Flex CharStyle:Code
8556 \begin_layout Plain Layout
8562 This command deletes an existing float.
8563 This is particularly useful when you want to suppress a float that has
8564 be defined in an input file.
8567 \begin_layout Description
8568 \begin_inset Flex CharStyle:Code
8571 \begin_layout Plain Layout
8577 This command deletes an existing style.
8578 This is particularly useful when you want to suppress a style that has
8579 be defined in an input file.
8582 \begin_layout Description
8583 \begin_inset Flex CharStyle:Code
8586 \begin_layout Plain Layout
8595 \begin_layout Description
8596 \begin_inset Flex CharStyle:Code
8599 \begin_layout Plain Layout
8610 \begin_inset Flex CharStyle:Code
8613 \begin_layout Plain Layout
8624 \begin_inset Flex CharStyle:Code
8627 \begin_layout Plain Layout
8634 \begin_inset Flex CharStyle:Code
8637 \begin_layout Plain Layout
8643 ] The class default pagestyle.
8644 Can be changed in the
8645 \begin_inset Flex CharStyle:MenuItem
8648 \begin_layout Plain Layout
8653 ocument\SpecialChar \menuseparator
8666 \begin_layout Description
8667 \begin_inset Flex CharStyle:Code
8670 \begin_layout Plain Layout
8676 Sets the preamble for the LaTeX document.
8677 Note that this will completely override any prior
8678 \begin_inset Flex CharStyle:Code
8681 \begin_layout Plain Layout
8688 \begin_inset Flex CharStyle:Code
8691 \begin_layout Plain Layout
8699 \begin_inset Quotes eld
8703 \begin_inset Flex CharStyle:Code
8706 \begin_layout Plain Layout
8713 \begin_inset Quotes erd
8719 \begin_layout Description
8720 \begin_inset Flex CharStyle:Code
8723 \begin_layout Plain Layout
8730 \begin_inset CommandInset label
8737 \begin_inset Flex CharStyle:Code
8740 \begin_layout Plain Layout
8747 \begin_inset Flex CharStyle:Code
8750 \begin_layout Plain Layout
8759 \begin_inset Flex CharStyle:Code
8762 \begin_layout Plain Layout
8768 ] Whether the class already provides the feature
8769 \begin_inset Flex CharStyle:Code
8772 \begin_layout Plain Layout
8779 A feature is in general the name of a package (
8780 \begin_inset Flex CharStyle:Code
8783 \begin_layout Plain Layout
8790 \begin_inset Flex CharStyle:Code
8793 \begin_layout Plain Layout
8799 , \SpecialChar \ldots{}
8801 \begin_inset Flex CharStyle:Code
8804 \begin_layout Plain Layout
8811 \begin_inset Flex CharStyle:Code
8814 \begin_layout Plain Layout
8820 ,\SpecialChar \ldots{}
8821 ); the complete list of supported features is unfortunately not documented
8822 outside the LyX source code---but see
8823 \begin_inset Flex CharStyle:Code
8826 \begin_layout Plain Layout
8832 if you're interested.
8834 \begin_inset Flex CharStyle:MenuItem
8837 \begin_layout Plain Layout
8842 elp\SpecialChar \menuseparator
8852 also gives an overview of the supported packages.
8855 \begin_layout Description
8856 \begin_inset Flex CharStyle:Code
8859 \begin_layout Plain Layout
8866 \begin_inset Flex CharStyle:Code
8869 \begin_layout Plain Layout
8875 ] Whether the class requires the feature
8876 \begin_inset Flex CharStyle:Code
8879 \begin_layout Plain Layout
8886 Multiple features must be separated by commas.
8887 Note that you can only request supported features.
8890 \begin_layout Description
8891 \begin_inset Flex CharStyle:Code
8894 \begin_layout Plain Layout
8903 \begin_layout Description
8904 \begin_inset Flex CharStyle:Code
8907 \begin_layout Plain Layout
8916 \begin_layout Description
8917 \begin_inset Flex CharStyle:Code
8920 \begin_layout Plain Layout
8929 \begin_inset Flex CharStyle:Code
8932 \begin_layout Plain Layout
8943 \begin_inset Flex CharStyle:Code
8946 \begin_layout Plain Layout
8952 ] Whether the class-default should be printing on one or both sides of the
8954 Can be changed in the
8955 \begin_inset Flex CharStyle:MenuItem
8958 \begin_layout Plain Layout
8963 ocument\SpecialChar \menuseparator
8976 \begin_layout Description
8977 \begin_inset Flex CharStyle:Code
8980 \begin_layout Plain Layout
8986 This sequence defines a new paragraph style.
8987 If the style already exists, it will redefine some of its parameters instead.
8989 \begin_inset space ~
8993 \begin_inset CommandInset ref
8995 reference "sec:style"
9001 \begin_inset Quotes eld
9005 \begin_inset Flex CharStyle:Code
9008 \begin_layout Plain Layout
9015 \begin_inset Quotes erd
9021 \begin_layout Description
9022 \begin_inset Flex CharStyle:Code
9025 \begin_layout Plain Layout
9032 \begin_inset Flex CharStyle:Code
9035 \begin_layout Plain Layout
9041 ] The name of the command or environment to be used with
9042 \begin_inset Flex CharStyle:Code
9045 \begin_layout Plain Layout
9054 \begin_layout Description
9055 \begin_inset Flex CharStyle:Code
9058 \begin_layout Plain Layout
9065 \begin_inset Flex CharStyle:Code
9068 \begin_layout Plain Layout
9077 \begin_inset Flex CharStyle:Code
9080 \begin_layout Plain Layout
9086 ] Indicates what kind of markup is used to define the title of a document.
9088 \begin_inset Flex CharStyle:Code
9091 \begin_layout Plain Layout
9097 means that the macro with name
9098 \begin_inset Flex CharStyle:Code
9101 \begin_layout Plain Layout
9107 will be inserted after the last layout which has
9108 \begin_inset Quotes eld
9112 \begin_inset Flex CharStyle:Code
9115 \begin_layout Plain Layout
9122 \begin_inset Quotes erd
9127 \begin_inset Flex CharStyle:Code
9130 \begin_layout Plain Layout
9136 corresponds to the case where the block of paragraphs which have
9137 \begin_inset Quotes eld
9141 \begin_inset Flex CharStyle:Code
9144 \begin_layout Plain Layout
9151 \begin_inset Quotes erd
9154 should be enclosed into the
9155 \begin_inset Flex CharStyle:Code
9158 \begin_layout Plain Layout
9167 \begin_layout Description
9168 \begin_inset Flex CharStyle:Code
9171 \begin_layout Plain Layout
9180 \begin_layout Description
9181 \begin_inset Flex CharStyle:Code
9184 \begin_layout Plain Layout
9191 \begin_inset Flex CharStyle:Code
9194 \begin_layout Plain Layout
9200 Specifies a module to be included by default with this document class.
9201 The user can still remove the module, but it will be active at the outset.
9202 (This applies only when new files are created, or when this class is chosen
9203 for an existing document.)
9206 \begin_layout Subsection
9207 \begin_inset Flex CharStyle:Code
9210 \begin_layout Plain Layout
9219 \begin_layout Standard
9220 \begin_inset CommandInset label
9222 name "sec:classoptions"
9227 \begin_inset Flex CharStyle:Code
9230 \begin_layout Plain Layout
9236 section can contain the following entries:
9239 \begin_layout Description
9240 \begin_inset Flex CharStyle:Code
9243 \begin_layout Plain Layout
9250 \begin_inset Flex CharStyle:Code
9253 \begin_layout Plain Layout
9259 ] The list of available font sizes for the document's main font, separated
9261 \begin_inset Quotes eld
9265 \begin_inset Flex CharStyle:Code
9268 \begin_layout Plain Layout
9275 \begin_inset Quotes erd
9281 \begin_layout Description
9282 \begin_inset Flex CharStyle:Code
9285 \begin_layout Plain Layout
9294 \begin_layout Description
9295 \begin_inset Flex CharStyle:Code
9298 \begin_layout Plain Layout
9305 \begin_inset Flex CharStyle:Code
9308 \begin_layout Plain Layout
9309 string="empty|plain|headings|fancy"
9314 ] The list of available page styles, separated by
9315 \begin_inset Quotes eld
9319 \begin_inset Flex CharStyle:Code
9322 \begin_layout Plain Layout
9329 \begin_inset Quotes erd
9335 \begin_layout Description
9336 \begin_inset Flex CharStyle:Code
9339 \begin_layout Plain Layout
9346 \begin_inset Flex CharStyle:Code
9349 \begin_layout Plain Layout
9355 ] Some document class options, separated by a comma, that will be added
9356 to the optional part of the
9357 \begin_inset Flex CharStyle:Code
9360 \begin_layout Plain Layout
9371 \begin_layout Standard
9373 \begin_inset Flex CharStyle:Code
9376 \begin_layout Plain Layout
9382 section must end with
9383 \begin_inset Quotes eld
9387 \begin_inset Flex CharStyle:Code
9390 \begin_layout Plain Layout
9397 \begin_inset Quotes erd
9403 \begin_layout Subsection
9407 \begin_layout Standard
9408 \begin_inset CommandInset label
9414 A paragraph style description looks like this:
9418 \begin_layout Plain Layout
9419 Note that this will either define a new layout or modify an existing one.
9427 \begin_layout LyX-Code
9434 \begin_layout LyX-Code
9438 \begin_layout LyX-Code
9442 \begin_layout Standard
9443 where the following commands are allowed:
9446 \begin_layout Description
9447 \begin_inset Flex CharStyle:Code
9450 \begin_layout Plain Layout
9457 \begin_inset Flex CharStyle:Code
9460 \begin_layout Plain Layout
9465 , left, right, center
9470 ] Paragraph alignment.
9473 \begin_layout Description
9474 \begin_inset Flex CharStyle:Code
9477 \begin_layout Plain Layout
9484 \begin_inset Flex CharStyle:Code
9487 \begin_layout Plain Layout
9492 , left, right, center
9497 ] A comma separated list of permitted alignments.
9498 (Some LaTeX styles prohibit certain alignments, since those wouldn't make
9500 For example a right-aligned or centered enumeration isn't possible.)
9503 \begin_layout Description
9504 \begin_inset Flex CharStyle:Code
9507 \begin_layout Plain Layout
9514 \begin_inset Flex CharStyle:Code
9517 \begin_layout Plain Layout
9527 \begin_layout Plain Layout
9528 Note that a `float' here is a real number, such as: 1.5.
9533 The vertical space with which the last of a chain of paragraphs with this
9534 layout is separated from the following paragraph.
9535 If the next paragraph has another layout, the separations are not simply
9536 added, but the maximum is taken.
9539 \begin_layout Description
9540 \begin_inset Flex CharStyle:Code
9543 \begin_layout Plain Layout
9550 \begin_inset Flex CharStyle:Code
9553 \begin_layout Plain Layout
9559 The category for this style.
9560 This is used to group related styles in the Layout combobox on the toolbar.
9561 Any string can be used, but you may want to use existing categories with
9566 \begin_layout Description
9567 \begin_inset Flex CharStyle:Code
9570 \begin_layout Plain Layout
9579 \begin_layout Description
9580 \begin_inset Flex CharStyle:Code
9583 \begin_layout Plain Layout
9590 \begin_inset CommandInset label
9592 name "des:CopyStyle"
9597 \begin_inset Flex CharStyle:Code
9600 \begin_layout Plain Layout
9606 Copies all the features of an existing style into the current one.
9610 \begin_layout Description
9611 \begin_inset Flex CharStyle:Code
9614 \begin_layout Plain Layout
9620 The name of a style whose preamble should be output
9625 This allows to ensure some ordering of the preamble snippets when macros
9626 definitions depend on one another.
9630 \begin_layout Plain Layout
9631 Note that, besides that functionality, there is no way to ensure any ordering
9633 The ordering that you see in a given version of LyX may change without
9634 warning in later versions.
9642 \begin_layout Description
9643 \begin_inset Flex CharStyle:Code
9646 \begin_layout Plain Layout
9653 \begin_inset Flex CharStyle:Code
9656 \begin_layout Plain Layout
9661 , Box, Filled_Box, Static
9666 ] The type of label that stands at the end of the paragraph (or sequence
9668 \begin_inset Flex CharStyle:Code
9671 \begin_layout Plain Layout
9678 \begin_inset Flex CharStyle:Code
9681 \begin_layout Plain Layout
9688 \begin_inset Flex CharStyle:Code
9691 \begin_layout Plain Layout
9698 \begin_inset Flex CharStyle:Code
9701 \begin_layout Plain Layout
9709 \begin_inset Flex CharStyle:Code
9712 \begin_layout Plain Layout
9719 \begin_inset Quotes eld
9723 \begin_inset Quotes erd
9727 \begin_inset Flex CharStyle:Code
9730 \begin_layout Plain Layout
9737 \begin_inset Flex CharStyle:Code
9740 \begin_layout Plain Layout
9741 \begin_inset space ~
9750 \begin_inset space ~
9753 black) square suitable for end of proof markers,
9754 \begin_inset Flex CharStyle:Code
9757 \begin_layout Plain Layout
9763 is an explicit text string.
9766 \begin_layout Description
9767 \begin_inset Flex CharStyle:Code
9770 \begin_layout Plain Layout
9777 \begin_inset Flex CharStyle:Code
9780 \begin_layout Plain Layout
9786 ] The string used for a label with a
9787 \begin_inset Flex CharStyle:Code
9790 \begin_layout Plain Layout
9797 \begin_inset Flex CharStyle:Code
9800 \begin_layout Plain Layout
9810 \begin_layout Description
9811 \begin_inset Flex CharStyle:Code
9814 \begin_layout Plain Layout
9821 \begin_inset Flex CharStyle:Code
9824 \begin_layout Plain Layout
9835 \begin_inset Flex CharStyle:Code
9838 \begin_layout Plain Layout
9847 \begin_layout Description
9848 \begin_inset Flex CharStyle:Code
9851 \begin_layout Plain Layout
9858 \begin_inset Flex CharStyle:Code
9861 \begin_layout Plain Layout
9871 ] With this parameter the
9872 \begin_inset Flex CharStyle:MenuItem
9875 \begin_layout Plain Layout
9882 \begin_inset Quotes eld
9885 Vertical space above
9886 \begin_inset Quotes erd
9890 \begin_inset Flex CharStyle:MenuItem
9893 \begin_layout Plain Layout
9898 dit\SpecialChar \menuseparator
9904 \begin_inset space ~
9912 dialog can be set when initializing a paragraph with this style.
9916 \begin_layout Plain Layout
9919 Note from Jean-Marc:
9921 I'm not sure that this setting has much use, and it should probably be
9922 removed in later versions.
9930 \begin_layout Description
9931 \begin_inset Flex CharStyle:Code
9934 \begin_layout Plain Layout
9940 The font used for both the text body
9946 \begin_inset space ~
9950 \begin_inset CommandInset ref
9952 reference "sec:fonts"
9957 Note that defining this font automatically defines the
9958 \begin_inset Flex CharStyle:Code
9961 \begin_layout Plain Layout
9968 So you should define this one first if you also want to define
9969 \begin_inset Flex CharStyle:Code
9972 \begin_layout Plain Layout
9981 \begin_layout Description
9982 \begin_inset Flex CharStyle:Code
9985 \begin_layout Plain Layout
9992 \begin_inset CommandInset label
9994 name "des:FreeSpacing"
10001 \begin_inset Flex CharStyle:Code
10004 \begin_layout Plain Layout
10015 \begin_inset Flex CharStyle:Code
10018 \begin_layout Plain Layout
10024 ] Usually LyX doesn't allow you to insert more than one space between words,
10025 since a space is considered as the separation between two words, not a
10026 character or symbol of its own.
10027 This is a very fine thing but sometimes annoying, for example, when typing
10028 program code or plain LaTeX code.
10030 \begin_inset Flex CharStyle:Code
10033 \begin_layout Plain Layout
10040 Note that LyX will create protected blanks for the additional blanks when
10041 in another mode than LaTeX-mode.
10044 \begin_layout Description
10045 \begin_inset Flex CharStyle:Code
10048 \begin_layout Plain Layout
10057 \begin_layout Description
10058 \begin_inset Flex CharStyle:Code
10061 \begin_layout Plain Layout
10068 \begin_inset Flex CharStyle:Code
10071 \begin_layout Plain Layout
10077 If 1, marks the layout as being part of a title block (see also the
10078 \begin_inset Flex CharStyle:Code
10081 \begin_layout Plain Layout
10088 \begin_inset Flex CharStyle:Code
10091 \begin_layout Plain Layout
10100 \begin_layout Description
10101 \begin_inset Flex CharStyle:Code
10104 \begin_layout Plain Layout
10111 \begin_inset Flex CharStyle:Code
10114 \begin_layout Plain Layout
10120 ] This provides extra space between paragraphs that have the same layout.
10121 If you put other layouts into an environment, each is separated with the
10123 \begin_inset Flex CharStyle:Code
10126 \begin_layout Plain Layout
10133 But the whole items of the environment are additionally separated with
10135 \begin_inset Flex CharStyle:Code
10138 \begin_layout Plain Layout
10145 Note that this is a
10150 \begin_layout Description
10151 \begin_inset Flex CharStyle:Code
10154 \begin_layout Plain Layout
10163 \begin_layout Description
10164 \begin_inset Flex CharStyle:Code
10167 \begin_layout Plain Layout
10174 \begin_inset CommandInset label
10176 name "des:KeepEmpty"
10183 \begin_inset Flex CharStyle:Code
10186 \begin_layout Plain Layout
10197 \begin_inset Flex CharStyle:Code
10200 \begin_layout Plain Layout
10206 ] Usually LyX does not allow you to leave a paragraph empty, since it would
10207 lead to empty LaTeX output.
10208 There are some cases where this could be desirable however: in a letter
10209 template, the required fields can be provided as empty fields, so that
10210 people do not forget them; in some special classes, a layout can be used
10211 as some kind of break, which does not contain actual text.
10214 \begin_layout Description
10215 \begin_inset Flex CharStyle:Code
10218 \begin_layout Plain Layout
10224 [float=0] The vertical space between the label and the text body.
10225 Only used for labels that are above the text body (
10226 \begin_inset Flex CharStyle:Code
10229 \begin_layout Plain Layout
10236 \begin_inset Flex CharStyle:Code
10239 \begin_layout Plain Layout
10240 Centered_Top_Environment
10248 \begin_layout Description
10249 \begin_inset Flex CharStyle:Code
10252 \begin_layout Plain Layout
10259 \begin_inset Flex CharStyle:Code
10262 \begin_layout Plain Layout
10269 \begin_inset Newline newline
10272 The name of the counter for automatic numbering (see Section
10273 \begin_inset CommandInset ref
10275 reference "sec:counter"
10280 This must be given if
10281 \begin_inset Flex CharStyle:Code
10284 \begin_layout Plain Layout
10291 \begin_inset Flex CharStyle:Code
10294 \begin_layout Plain Layout
10303 \begin_layout Description
10304 \begin_inset Flex CharStyle:Code
10307 \begin_layout Plain Layout
10313 The font used for the label.
10315 \begin_inset space ~
10319 \begin_inset CommandInset ref
10321 reference "sec:fonts"
10328 \begin_layout Description
10329 \begin_inset Flex CharStyle:Code
10332 \begin_layout Plain Layout
10339 \begin_inset Flex CharStyle:Code
10342 \begin_layout Plain Layout
10348 ] The horizontal space between the label and the text body.
10349 Only used for labels that are not above the text body.
10352 \begin_layout Description
10353 \begin_inset Flex CharStyle:Code
10356 \begin_layout Plain Layout
10363 \begin_inset Flex CharStyle:Code
10366 \begin_layout Plain Layout
10372 ] The string used for a label with a
10373 \begin_inset Flex CharStyle:Code
10376 \begin_layout Plain Layout
10384 \begin_inset Flex CharStyle:Code
10387 \begin_layout Plain Layout
10393 is set, this string can be contain the special formatting commands described
10395 \begin_inset CommandInset ref
10397 reference "sec:counter"
10405 \begin_layout Plain Layout
10406 For the sake of backwards compatibility, the string
10407 \begin_inset Flex CharStyle:Code
10410 \begin_layout Plain Layout
10420 will be replaced by the expanded
10421 \begin_inset Flex CharStyle:Code
10424 \begin_layout Plain Layout
10431 \begin_inset Flex CharStyle:Code
10434 \begin_layout Plain Layout
10443 This feature is now obsolete and should be replaced by the mechanisms of
10445 \begin_inset CommandInset ref
10447 reference "sec:counter"
10459 \begin_layout Description
10460 \begin_inset Flex CharStyle:Code
10463 \begin_layout Plain Layout
10464 LabelStringAppendix
10470 \begin_inset Flex CharStyle:Code
10473 \begin_layout Plain Layout
10479 ] This is used inside the appendix instead of
10480 \begin_inset Flex CharStyle:Code
10483 \begin_layout Plain Layout
10491 \begin_inset Flex CharStyle:Code
10494 \begin_layout Plain Layout
10501 \begin_inset Flex CharStyle:Code
10504 \begin_layout Plain Layout
10505 LabelStringAppendix
10513 \begin_layout Description
10514 \begin_inset Flex CharStyle:Code
10517 \begin_layout Plain Layout
10524 \begin_inset Flex CharStyle:Code
10527 \begin_layout Plain Layout
10532 , Manual, Static, Top_Environment,
10533 \begin_inset Newline newline
10536 Centered_Top_Environment, Sensitive, Counter
10542 \begin_inset Newline newline
10546 \begin_inset Flex CharStyle:Code
10549 \begin_layout Plain Layout
10555 means the label is the very first word (up to the first real blank).
10559 \begin_layout Plain Layout
10560 Use protected spaces if you want more than one word as the label.
10566 \begin_inset Flex CharStyle:Code
10569 \begin_layout Plain Layout
10575 means it is defined in the layout (see
10576 \begin_inset Flex CharStyle:Code
10579 \begin_layout Plain Layout
10587 \begin_inset Flex CharStyle:Code
10590 \begin_layout Plain Layout
10597 \begin_inset Flex CharStyle:Code
10600 \begin_layout Plain Layout
10601 Centered_Top_Environment
10606 are special cases of
10607 \begin_inset Flex CharStyle:Code
10610 \begin_layout Plain Layout
10617 The label will be printed above the paragraph, but only at the top of an
10618 environment or the top of a chain of paragraphs with this layout.
10619 Usage is for example the
10620 \begin_inset Flex CharStyle:MenuItem
10623 \begin_layout Plain Layout
10630 \begin_inset Flex CharStyle:MenuItem
10633 \begin_layout Plain Layout
10640 This is also the case for
10641 \begin_inset Flex CharStyle:Code
10644 \begin_layout Plain Layout
10650 labels with latex type
10651 \begin_inset Flex CharStyle:Code
10654 \begin_layout Plain Layout
10660 , in order to make layouts for theorems work correctly.
10662 \begin_inset Flex CharStyle:Code
10665 \begin_layout Plain Layout
10671 is a special case for the caption-labels
10672 \begin_inset Quotes eld
10676 \begin_inset Quotes erd
10680 \begin_inset Quotes eld
10684 \begin_inset Quotes erd
10689 \begin_inset Flex CharStyle:Code
10692 \begin_layout Plain Layout
10698 means the (hardcoded) label string depends on the kind of float.
10700 \begin_inset Flex CharStyle:Code
10703 \begin_layout Plain Layout
10709 label type defines automatically numbered labels.
10711 \begin_inset CommandInset ref
10713 reference "sec:counter"
10720 \begin_layout Description
10721 \begin_inset Flex CharStyle:Code
10724 \begin_layout Plain Layout
10733 \begin_layout Description
10734 \begin_inset Flex CharStyle:Code
10737 \begin_layout Plain Layout
10746 \begin_layout Description
10747 \begin_inset Flex CharStyle:Code
10750 \begin_layout Plain Layout
10757 \begin_inset CommandInset label
10759 name "des:LatexName"
10763 The name of the corresponding LaTeX stuff.
10764 Either the environment or command name.
10767 \begin_layout Description
10768 \begin_inset Flex CharStyle:Code
10771 \begin_layout Plain Layout
10780 \begin_layout Description
10781 \begin_inset Flex CharStyle:Code
10784 \begin_layout Plain Layout
10791 \begin_inset CommandInset label
10793 name "des:LatexParam"
10797 An optional parameter for the corresponding
10798 \begin_inset Flex CharStyle:Code
10801 \begin_layout Plain Layout
10808 This parameter cannot be changed from within LyX.
10811 \begin_layout Description
10812 \begin_inset Flex CharStyle:Code
10815 \begin_layout Plain Layout
10822 \begin_inset CommandInset label
10824 name "des:LatexType"
10829 \begin_inset Flex CharStyle:Code
10832 \begin_layout Plain Layout
10837 , Command, Environment, Item_Environment,
10843 \begin_inset Flex CharStyle:Code
10846 \begin_layout Plain Layout
10852 ] How the layout should be translated into LaTeX.
10854 \begin_inset Flex CharStyle:Code
10857 \begin_layout Plain Layout
10863 means nothing special.
10865 \begin_inset Flex CharStyle:Code
10868 \begin_layout Plain Layout
10875 \begin_inset Flex CharStyle:Code
10878 \begin_layout Plain Layout
10885 {\SpecialChar \ldots{}
10892 \begin_inset Flex CharStyle:Code
10895 \begin_layout Plain Layout
10902 \begin_inset Flex CharStyle:Code
10905 \begin_layout Plain Layout
10912 }\SpecialChar \ldots{}
10926 \begin_inset Flex CharStyle:Code
10929 \begin_layout Plain Layout
10936 \begin_inset Flex CharStyle:Code
10939 \begin_layout Plain Layout
10946 \begin_inset Flex CharStyle:Code
10949 \begin_layout Plain Layout
10957 is generated for each paragraph of this environment.
10959 \begin_inset Flex CharStyle:Code
10962 \begin_layout Plain Layout
10969 \begin_inset Flex CharStyle:Code
10972 \begin_layout Plain Layout
10979 \begin_inset Flex CharStyle:Code
10982 \begin_layout Plain Layout
10988 is passed as an argument to the environment.
10990 \begin_inset Flex CharStyle:Code
10993 \begin_layout Plain Layout
10999 can be defined in the
11000 \begin_inset Flex CharStyle:MenuItem
11003 \begin_layout Plain Layout
11008 ayout\SpecialChar \menuseparator
11020 \begin_inset Flex CharStyle:Code
11023 \begin_layout Plain Layout
11031 is perhaps a bit misleading, since these rules apply to SGML classes, too.
11032 Visit the SGML class files for specific examples.
11035 \begin_layout Standard
11036 Putting the last few things together, the LaTeX output will be either:
11039 \begin_layout LyX-Code
11042 latexname[latexparam]{\SpecialChar \ldots{}
11046 \begin_layout Standard
11050 \begin_layout LyX-Code
11053 begin{latexname}[latexparam] \SpecialChar \ldots{}
11059 \begin_layout Standard
11060 depending upon the LaTex type.
11063 \begin_layout Description
11064 \begin_inset Flex CharStyle:Code
11067 \begin_layout Plain Layout
11074 \begin_inset Flex CharStyle:Code
11077 \begin_layout Plain Layout
11083 ] If you put layouts into environments, the leftmargins are not simply added,
11084 but added with a factor
11085 \begin_inset Formula $\frac{4}{depth+4}$
11089 Note that this parameter is also used when the margin is defined as
11090 \begin_inset Flex CharStyle:Code
11093 \begin_layout Plain Layout
11100 \begin_inset Flex CharStyle:Code
11103 \begin_layout Plain Layout
11110 Then it is added to the manual or dynamic margin.
11112 \begin_inset Newline newline
11115 The argument is passed as a string.
11117 \begin_inset Quotes eld
11121 \begin_inset Flex CharStyle:Code
11124 \begin_layout Plain Layout
11131 \begin_inset Quotes erd
11134 means that the paragraph is indented with the width of
11135 \begin_inset Quotes eld
11139 \begin_inset Flex CharStyle:Code
11142 \begin_layout Plain Layout
11149 \begin_inset Quotes erd
11152 in the normal font.
11153 You can get a negative width by prefixing the string with
11154 \begin_inset Quotes eld
11158 \begin_inset Flex CharStyle:Code
11161 \begin_layout Plain Layout
11168 \begin_inset Quotes erd
11172 This way was chosen so that the look is the same with each used screen
11177 \begin_layout Description
11178 \begin_inset Flex CharStyle:Code
11181 \begin_layout Plain Layout
11188 \begin_inset Flex CharStyle:Code
11191 \begin_layout Plain Layout
11196 , Manual, Dynamic, First_Dynamic, Right_Address_Box
11202 \begin_inset Newline newline
11205 The kind of margin that the layout has on the left side.
11207 \begin_inset Flex CharStyle:Code
11210 \begin_layout Plain Layout
11216 just means a fixed margin.
11218 \begin_inset Flex CharStyle:Code
11221 \begin_layout Plain Layout
11227 means that the left margin depends on the string entered in the
11228 \begin_inset Flex CharStyle:MenuItem
11231 \begin_layout Plain Layout
11236 dit\SpecialChar \menuseparator
11242 \begin_inset space ~
11251 This is used to typeset nice lists without tabulators.
11253 \begin_inset Flex CharStyle:Code
11256 \begin_layout Plain Layout
11262 means that the margin depends on the size of the label.
11263 This is used for automatic enumerated headlines.
11264 It is obvious that the headline
11265 \begin_inset Quotes eld
11268 5.4.3.2.1 Very long headline
11269 \begin_inset Quotes erd
11272 must have a wider left margin (as wide as
11273 \begin_inset Quotes eld
11277 \begin_inset Quotes erd
11280 plus the space) than
11281 \begin_inset Quotes eld
11284 3.2 Very long headline
11285 \begin_inset Quotes erd
11289 \begin_inset Quotes eld
11293 \begin_inset Quotes erd
11296 are not able to do this.
11298 \begin_inset Flex CharStyle:Code
11301 \begin_layout Plain Layout
11307 is similar, but only the very first row of the paragraph is dynamic, while
11308 the others are static; this is used, for example, for descriptions.
11310 \begin_inset Flex CharStyle:Code
11313 \begin_layout Plain Layout
11319 means the margin is chosen in a way that the longest row of this paragraph
11320 fits to the right margin.
11321 This is used to typeset an address on the right edge of the page.
11324 \begin_layout Description
11325 \begin_inset Flex CharStyle:Code
11328 \begin_layout Plain Layout
11335 \begin_inset CommandInset label
11337 name "des:NeedProtect"
11342 \begin_inset Flex CharStyle:Code
11345 \begin_layout Plain Layout
11354 \begin_inset Flex CharStyle:Code
11357 \begin_layout Plain Layout
11363 ] Whether fragile commands in this layout should be
11364 \begin_inset Flex CharStyle:Code
11367 \begin_layout Plain Layout
11380 whether this command should itself be protected.)
11383 \begin_layout Description
11384 \begin_inset Flex CharStyle:Code
11387 \begin_layout Plain Layout
11394 \begin_inset Flex CharStyle:Code
11397 \begin_layout Plain Layout
11404 \begin_inset Flex CharStyle:Code
11407 \begin_layout Plain Layout
11415 ] Whether newlines are translated into LaTeX newlines (
11416 \begin_inset Flex CharStyle:Code
11419 \begin_layout Plain Layout
11430 The translation can be switched off to allow more comfortable LaTeX editing
11434 \begin_layout Description
11435 \begin_inset Flex CharStyle:Code
11438 \begin_layout Plain Layout
11445 \begin_inset Flex CharStyle:Code
11448 \begin_layout Plain Layout
11455 \begin_inset Flex CharStyle:Code
11458 \begin_layout Plain Layout
11466 ] Whether the following Paragraph is allowed to indent its very first row.
11468 \begin_inset Flex CharStyle:Code
11471 \begin_layout Plain Layout
11477 means that it is not allowed to do so;
11478 \begin_inset Flex CharStyle:Code
11481 \begin_layout Plain Layout
11487 means it could do so if it wants to.
11490 \begin_layout Description
11491 \begin_inset Flex CharStyle:Code
11494 \begin_layout Plain Layout
11503 \begin_layout Description
11504 \begin_inset Flex CharStyle:Code
11507 \begin_layout Plain Layout
11514 \begin_inset Flex CharStyle:Code
11517 \begin_layout Plain Layout
11523 ] The number of optional arguments that can be used with this layout.
11524 This is useful for things like section headings, and only makes sense with
11528 \begin_layout Description
11529 \begin_inset Flex CharStyle:Code
11532 \begin_layout Plain Layout
11539 \begin_inset Flex CharStyle:Code
11542 \begin_layout Plain Layout
11548 ] The indent of the very first line of a paragraph.
11550 \begin_inset Flex CharStyle:Code
11553 \begin_layout Plain Layout
11559 will be fixed for a certain layout.
11560 The exception is Standard layout, since the indentation of a Standard layout
11561 paragraph can be prohibited with
11562 \begin_inset Flex CharStyle:Code
11565 \begin_layout Plain Layout
11572 Also, Standard layout paragraphs inside environments use the
11573 \begin_inset Flex CharStyle:Code
11576 \begin_layout Plain Layout
11582 of the environment, not their native one.
11583 For example, Standard paragraphs inside an enumeration are not indented.
11586 \begin_layout Description
11587 \begin_inset Flex CharStyle:Code
11590 \begin_layout Plain Layout
11597 \begin_inset Flex CharStyle:Code
11600 \begin_layout Plain Layout
11606 ] The vertical space between two paragraphs of this layout.
11609 \begin_layout Description
11610 \begin_inset Flex CharStyle:Code
11613 \begin_layout Plain Layout
11620 \begin_inset Flex CharStyle:Code
11623 \begin_layout Plain Layout
11629 ] LyX allows the user to choose either
11630 \begin_inset Quotes eld
11634 \begin_inset Quotes erd
11638 \begin_inset Quotes eld
11642 \begin_inset Quotes erd
11645 to typeset a document.
11647 \begin_inset Quotes eld
11651 \begin_inset Quotes erd
11654 is chosen, this value is completely ignored.
11656 \begin_inset Quotes eld
11660 \begin_inset Quotes erd
11663 is chosen, the parindent of a LaTeXtype
11664 \begin_inset Quotes eld
11668 \begin_inset Quotes erd
11671 layout is ignored and all paragraphs are separated by this parskip argument.
11672 The vertical space is calculated with
11673 \begin_inset Flex CharStyle:Code
11676 \begin_layout Plain Layout
11678 \begin_inset space ~
11687 \begin_inset Flex CharStyle:Code
11690 \begin_layout Plain Layout
11696 is the height of a row with the normal font.
11697 This way, the look stays the same with different screen fonts.
11700 \begin_layout Description
11701 \begin_inset Flex CharStyle:Code
11704 \begin_layout Plain Layout
11711 \begin_inset CommandInset label
11713 name "des:PassThru"
11720 \begin_inset Flex CharStyle:Code
11723 \begin_layout Plain Layout
11734 \begin_inset Flex CharStyle:Code
11737 \begin_layout Plain Layout
11743 ] Whether the contents of this paragraph should be output in raw form, meaning
11744 without special translations that LaTeX would require.
11747 \begin_layout Description
11748 \begin_inset Flex CharStyle:Code
11751 \begin_layout Plain Layout
11758 \begin_inset CommandInset label
11760 name "des:Preamble"
11764 Information to be included in the LaTeX preamable when this style is used.
11765 Used to define macros, load packages, etc., required by this particular
11768 \begin_inset Quotes eld
11772 \begin_inset Flex CharStyle:Code
11775 \begin_layout Plain Layout
11782 \begin_inset Quotes erd
11788 \begin_layout Description
11789 \begin_inset Flex CharStyle:Code
11792 \begin_layout Plain Layout
11799 \begin_inset Flex CharStyle:Code
11802 \begin_layout Plain Layout
11809 \begin_inset CommandInset label
11811 name "des:Requires"
11815 Whether the layout requires the feature
11816 \begin_inset Flex CharStyle:Code
11819 \begin_layout Plain Layout
11826 See the description of
11827 \begin_inset Flex CharStyle:Code
11830 \begin_layout Plain Layout
11837 \begin_inset CommandInset ref
11838 LatexCommand pageref
11839 reference "des:FreeSpacing"
11843 ) for information on `features'.
11847 \begin_layout Description
11848 \begin_inset Flex CharStyle:Code
11851 \begin_layout Plain Layout
11858 \begin_inset Flex CharStyle:Code
11861 \begin_layout Plain Layout
11868 \begin_inset Flex CharStyle:Code
11871 \begin_layout Plain Layout
11880 \begin_layout Description
11881 \begin_inset Flex CharStyle:Code
11884 \begin_layout Plain Layout
11891 \begin_inset Flex CharStyle:Code
11894 \begin_layout Plain Layout
11899 , onehalf, double, other
11908 ] This defines what the default spacing should be in the layout.
11910 \begin_inset Flex CharStyle:Code
11913 \begin_layout Plain Layout
11920 \begin_inset Flex CharStyle:Code
11923 \begin_layout Plain Layout
11930 \begin_inset Flex CharStyle:Code
11933 \begin_layout Plain Layout
11939 correspond respectively to a multiplier value of 1, 1.25 and 1.667.
11940 If you specify the argument
11941 \begin_inset Flex CharStyle:Code
11944 \begin_layout Plain Layout
11950 , then you should also provide a numerical argument which will be the actual
11952 Note that, contrary to other parameters,
11953 \begin_inset Flex CharStyle:Code
11956 \begin_layout Plain Layout
11962 implies the generation of specific LaTeX code, using the package
11965 \begin_inset Flex CharStyle:Code
11968 \begin_layout Plain Layout
11977 \begin_layout Description
11978 \begin_inset Flex CharStyle:Code
11981 \begin_layout Plain Layout
11987 The font used for the text body .
11989 \begin_inset CommandInset ref
11991 reference "sec:fonts"
11998 \begin_layout Description
12000 \begin_inset Flex CharStyle:Code
12003 \begin_layout Plain Layout
12011 The level of the style in the table of contents.
12012 This is used for automatic numbering of section headings.
12015 \begin_layout Description
12016 \begin_inset Flex CharStyle:Code
12019 \begin_layout Plain Layout
12026 \begin_inset Flex CharStyle:Code
12029 \begin_layout Plain Layout
12035 ] The vertical space with which the very first of a chain of paragraphs
12036 with this layout is separated from the previous paragraph.
12037 If the previous paragraph has another layout, the separations are not simply
12038 added, but the maximum is taken.
12041 \begin_layout Subsection
12045 \begin_layout Standard
12046 \begin_inset CommandInset label
12052 Since version 1.3.0 of LyX, it is has been both possible and necessary to
12053 define the floats (
12054 \begin_inset Flex CharStyle:MenuItem
12057 \begin_layout Plain Layout
12064 \begin_inset Flex CharStyle:MenuItem
12067 \begin_layout Plain Layout
12073 , \SpecialChar \ldots{}
12074 ) in the text class itself.
12075 Standard floats are included in the file
12076 \begin_inset Flex CharStyle:Code
12079 \begin_layout Plain Layout
12085 , so you may have to do no more than add
12088 \begin_layout LyX-Code
12089 Input stdfloats.inc
12092 \begin_layout Standard
12093 to your layout file.
12094 If you want to implement a text class that proposes some other float types
12095 (like the AGU class bundled with LyX), the information below will hopefully
12099 \begin_layout Description
12100 \begin_inset Flex CharStyle:Code
12103 \begin_layout Plain Layout
12110 \begin_inset Flex CharStyle:Code
12113 \begin_layout Plain Layout
12120 \begin_inset Quotes erd
12124 \begin_inset Quotes erd
12127 ] The file name extension of an auxiliary file for the list of figures (or
12129 LaTeX writes the captions to this file.
12132 \begin_layout Description
12133 \begin_inset Flex CharStyle:Code
12136 \begin_layout Plain Layout
12143 \begin_inset Flex CharStyle:Code
12146 \begin_layout Plain Layout
12153 \begin_inset Quotes erd
12157 \begin_inset Quotes erd
12160 ] The string that will be used in the menus and also for the caption.
12163 \begin_layout Description
12164 \begin_inset Flex CharStyle:Code
12167 \begin_layout Plain Layout
12174 \begin_inset Flex CharStyle:Code
12177 \begin_layout Plain Layout
12186 \begin_inset Flex CharStyle:Code
12189 \begin_layout Plain Layout
12196 \begin_inset Flex CharStyle:Code
12199 \begin_layout Plain Layout
12205 if the float is already defined by the LaTeX document class.
12207 \begin_inset Flex CharStyle:Code
12210 \begin_layout Plain Layout
12216 , the float will be defined using the LaTeX package
12217 \begin_inset Flex CharStyle:Code
12220 \begin_layout Plain Layout
12229 \begin_layout Description
12230 \begin_inset Flex CharStyle:Code
12233 \begin_layout Plain Layout
12240 \begin_inset Flex CharStyle:Code
12243 \begin_layout Plain Layout
12250 \begin_inset Quotes erd
12254 \begin_inset Quotes erd
12257 ] The heading used for the list of floats.
12260 \begin_layout Description
12261 \begin_inset Flex CharStyle:Code
12264 \begin_layout Plain Layout
12271 \begin_inset Flex CharStyle:Code
12274 \begin_layout Plain Layout
12281 \begin_inset Quotes erd
12285 \begin_inset Quotes erd
12288 ] This (optional) argument determines whether floats of this class will
12289 be numbered within some sectional unit of the document.
12290 For example, if within is equal to
12291 \begin_inset Flex CharStyle:Code
12294 \begin_layout Plain Layout
12300 , the floats will be numbered within chapters.
12304 \begin_layout Description
12305 \begin_inset Flex CharStyle:Code
12308 \begin_layout Plain Layout
12315 \begin_inset Flex CharStyle:Code
12318 \begin_layout Plain Layout
12325 \begin_inset Quotes erd
12329 \begin_inset Quotes erd
12332 ] The default placement for the given class of floats.
12333 The string should be as in standard LaTeX:
12334 \begin_inset Flex CharStyle:Code
12337 \begin_layout Plain Layout
12344 \begin_inset Flex CharStyle:Code
12347 \begin_layout Plain Layout
12354 \begin_inset Flex CharStyle:Code
12357 \begin_layout Plain Layout
12364 \begin_inset Flex CharStyle:Code
12367 \begin_layout Plain Layout
12373 for top, bottom, page, and here, respectively.
12377 \begin_layout Plain Layout
12378 Note that the order of these letters in the string is irrelevant, like in
12384 On top of that there is a new type,
12385 \begin_inset Flex CharStyle:Code
12388 \begin_layout Plain Layout
12394 , which does not really correspond to a float, since it means: put it
12395 \begin_inset Quotes eld
12399 \begin_inset Quotes erd
12403 Note however that the
12404 \begin_inset Flex CharStyle:Code
12407 \begin_layout Plain Layout
12413 specifier is special and, because of implementation details, cannot be
12414 used in non-builtin float types.
12415 If you do not understand what this means, just use
12416 \begin_inset Quotes eld
12420 \begin_inset Flex CharStyle:Code
12423 \begin_layout Plain Layout
12430 \begin_inset Quotes erd
12436 \begin_layout Description
12437 \begin_inset Flex CharStyle:Code
12440 \begin_layout Plain Layout
12447 \begin_inset Flex CharStyle:Code
12450 \begin_layout Plain Layout
12457 \begin_inset Quotes erd
12461 \begin_inset Quotes erd
12464 ] The style used when defining the float using
12465 \begin_inset Flex CharStyle:Code
12468 \begin_layout Plain Layout
12479 \begin_layout Description
12480 \begin_inset Flex CharStyle:Code
12483 \begin_layout Plain Layout
12490 \begin_inset Flex CharStyle:Code
12493 \begin_layout Plain Layout
12500 \begin_inset Quotes erd
12504 \begin_inset Quotes erd
12508 \begin_inset Quotes eld
12512 \begin_inset Quotes erd
12515 of the new class of floats, like program or algorithm.
12516 After the appropriate
12517 \begin_inset Flex CharStyle:Code
12520 \begin_layout Plain Layout
12529 \begin_inset Flex CharStyle:Code
12532 \begin_layout Plain Layout
12541 \begin_inset Flex CharStyle:Code
12544 \begin_layout Plain Layout
12555 \begin_layout Standard
12556 Note that defining a float with type
12557 \begin_inset Flex CharStyle:Code
12560 \begin_layout Plain Layout
12568 automatically defines the corresponding counter with name
12569 \begin_inset Flex CharStyle:Code
12572 \begin_layout Plain Layout
12583 \begin_layout Subsection
12584 Inset layouts and Flex insets
12587 \begin_layout Standard
12588 \begin_inset CommandInset label
12590 name "sec:charstyle"
12594 LyX has supported character styles since version 1.4.0; since version 1.6.0
12595 these are called Flex insets.
12599 \begin_layout Standard
12600 Furthermore, it is possible to define the general layout of many different
12602 Currently, InsetLayout can be used to customize the layout parameters
12603 for footnotes, marginal notes, note insets, ERT insets, branches, listings,
12604 indexes, boxes, tables, algorithms, URLs, and optional arguments, as well
12609 \begin_layout Standard
12610 Flex insets come in three different kinds:
12613 \begin_layout Itemize
12615 \begin_inset Flex CharStyle:Code
12618 \begin_layout Plain Layout
12624 ): These define semantic markup corresponding to such LaTeX commands as
12626 \begin_inset Flex CharStyle:Code
12629 \begin_layout Plain Layout
12638 \begin_inset Flex CharStyle:Code
12641 \begin_layout Plain Layout
12652 \begin_layout Itemize
12654 \begin_inset Flex CharStyle:Code
12657 \begin_layout Plain Layout
12663 ): These can be used to define custom collapsable insets, similar to ERT,
12664 footnote, and the like.
12667 \begin_layout Itemize
12669 \begin_inset Flex CharStyle:Code
12672 \begin_layout Plain Layout
12678 ): For use with DocBook classes.
12681 \begin_layout Standard
12683 \begin_inset Flex CharStyle:Code
12686 \begin_layout Plain Layout
12692 definition starting line is of the form
12695 \begin_layout LyX-Code
12696 InsetLayout <Type> <Name>
12699 \begin_layout Standard
12701 \begin_inset Flex CharStyle:Code
12704 \begin_layout Plain Layout
12711 \begin_inset Flex CharStyle:Code
12714 \begin_layout Plain Layout
12721 \begin_inset Flex CharStyle:Code
12724 \begin_layout Plain Layout
12731 \begin_inset Flex CharStyle:Code
12734 \begin_layout Plain Layout
12741 \begin_inset Flex CharStyle:Code
12744 \begin_layout Plain Layout
12751 \begin_inset Flex CharStyle:Code
12754 \begin_layout Plain Layout
12761 \begin_inset Flex CharStyle:Code
12764 \begin_layout Plain Layout
12771 \begin_inset Flex CharStyle:Code
12774 \begin_layout Plain Layout
12781 \begin_inset Flex CharStyle:Code
12784 \begin_layout Plain Layout
12791 \begin_inset Flex CharStyle:Code
12794 \begin_layout Plain Layout
12801 \begin_inset Flex CharStyle:Code
12804 \begin_layout Plain Layout
12811 \begin_inset Flex CharStyle:Code
12814 \begin_layout Plain Layout
12821 \begin_inset Flex CharStyle:Code
12824 \begin_layout Plain Layout
12831 \begin_inset Flex CharStyle:Code
12834 \begin_layout Plain Layout
12841 \begin_inset Flex CharStyle:Code
12844 \begin_layout Plain Layout
12851 \begin_inset Flex CharStyle:Code
12854 \begin_layout Plain Layout
12861 \begin_inset Flex CharStyle:Code
12864 \begin_layout Plain Layout
12872 \begin_inset Flex CharStyle:Code
12875 \begin_layout Plain Layout
12882 \begin_inset Flex CharStyle:Code
12885 \begin_layout Plain Layout
12892 \begin_inset Flex CharStyle:Code
12895 \begin_layout Plain Layout
12901 should have the form
12902 \begin_inset Flex CharStyle:Code
12905 \begin_layout Plain Layout
12912 \begin_inset Flex CharStyle:Code
12915 \begin_layout Plain Layout
12922 \begin_inset Flex CharStyle:Code
12925 \begin_layout Plain Layout
12932 \begin_inset Flex CharStyle:Code
12935 \begin_layout Plain Layout
12942 \begin_inset Flex CharStyle:Code
12945 \begin_layout Plain Layout
12952 \begin_inset Flex CharStyle:Code
12955 \begin_layout Plain Layout
12961 is any valid identifier.
12965 \begin_layout Standard
12967 \begin_inset Flex CharStyle:Code
12970 \begin_layout Plain Layout
12976 section can contain the following entries:
12979 \begin_layout Description
12980 \begin_inset Flex CharStyle:Code
12983 \begin_layout Plain Layout
12989 The color for the inset's background.
12990 These valid colors are defined in
12991 \begin_inset Flex CharStyle:Code
12994 \begin_layout Plain Layout
13003 \begin_layout Description
13004 \begin_inset Flex CharStyle:Code
13007 \begin_layout Plain Layout
13013 As with paragraph styles (see page
13014 \begin_inset CommandInset ref
13016 reference "des:CopyStyle"
13023 \begin_layout Description
13024 \begin_inset Flex CharStyle:Code
13027 \begin_layout Plain Layout
13034 \begin_inset Flex CharStyle:Code
13037 \begin_layout Plain Layout
13044 \begin_inset Flex CharStyle:Code
13047 \begin_layout Plain Layout
13054 \begin_inset Flex CharStyle:Code
13057 \begin_layout Plain Layout
13063 , describing the rendering style used for the inset's frame and buttons.
13064 Footnotes generally use
13065 \begin_inset Flex CharStyle:Code
13068 \begin_layout Plain Layout
13074 ; ERT insets generally use
13075 \begin_inset Flex CharStyle:Code
13078 \begin_layout Plain Layout
13084 ; and character styles use
13085 \begin_inset Flex CharStyle:Code
13088 \begin_layout Plain Layout
13097 \begin_layout Description
13098 \begin_inset Flex CharStyle:Code
13101 \begin_layout Plain Layout
13107 The font used for both the text body
13113 \begin_inset space ~
13117 \begin_inset CommandInset ref
13119 reference "sec:fonts"
13124 Note that defining this font automatically defines the
13125 \begin_inset Flex CharStyle:Code
13128 \begin_layout Plain Layout
13134 to the same value, so define this first and define
13135 \begin_inset Flex CharStyle:Code
13138 \begin_layout Plain Layout
13144 later if you want them to be different.
13147 \begin_layout Description
13148 \begin_inset Flex CharStyle:Code
13151 \begin_layout Plain Layout
13160 \begin_layout Description
13161 \begin_inset Flex CharStyle:Code
13164 \begin_layout Plain Layout
13170 As with paragraph styles (see page
13171 \begin_inset CommandInset ref
13172 LatexCommand pageref
13173 reference "des:FreeSpacing"
13180 \begin_layout Description
13181 \begin_inset Flex CharStyle:Code
13184 \begin_layout Plain Layout
13190 As with paragraph styles (see page
13191 \begin_inset CommandInset ref
13192 LatexCommand pageref
13193 reference "des:KeepEmpty"
13200 \begin_layout Description
13201 \begin_inset Flex CharStyle:Code
13204 \begin_layout Plain Layout
13210 What will be displayed on the button or elsewhere as the inset label.
13211 Some inset types (ERT and Branch) modify this label on the fly.
13214 \begin_layout Description
13215 \begin_inset Flex CharStyle:Code
13218 \begin_layout Plain Layout
13224 The font used for the label.
13226 \begin_inset space ~
13230 \begin_inset CommandInset ref
13232 reference "sec:fonts"
13237 Note that this definition can never appear before
13238 \begin_inset Flex CharStyle:Code
13241 \begin_layout Plain Layout
13247 , lest it be ineffective.
13250 \begin_layout Description
13251 \begin_inset Flex CharStyle:Code
13254 \begin_layout Plain Layout
13260 The name of the corresponding LaTeX stuff.
13261 Either the environment or command name.
13264 \begin_layout Description
13265 \begin_inset Flex CharStyle:Code
13268 \begin_layout Plain Layout
13274 The optional parameter for the corresponding
13275 \begin_inset Flex CharStyle:Code
13278 \begin_layout Plain Layout
13284 stuff, including possible bracket pairs like
13285 \begin_inset Flex CharStyle:Code
13288 \begin_layout Plain Layout
13295 This parameter cannot be changed from within LyX.
13298 \begin_layout Description
13299 \begin_inset Flex CharStyle:Code
13302 \begin_layout Plain Layout
13308 As with paragraph styles (see page
13309 \begin_inset CommandInset ref
13310 LatexCommand pageref
13311 reference "des:LatexType"
13318 \begin_layout Description
13319 \begin_inset Flex CharStyle:Code
13322 \begin_layout Plain Layout
13329 \begin_inset Flex CharStyle:Code
13332 \begin_layout Plain Layout
13339 \begin_inset Flex CharStyle:Code
13342 \begin_layout Plain Layout
13349 \begin_inset Flex CharStyle:Code
13352 \begin_layout Plain Layout
13359 \begin_inset Flex CharStyle:Code
13362 \begin_layout Plain Layout
13368 (indicating a dummy definition ending definitions of charstyles etc.).
13369 This entry is only meaningful for Flex (user definable) insets.
13372 \begin_layout Description
13373 \begin_inset Flex CharStyle:Code
13376 \begin_layout Plain Layout
13383 \begin_inset Flex CharStyle:Code
13386 \begin_layout Plain Layout
13395 \begin_inset Flex CharStyle:Code
13398 \begin_layout Plain Layout
13404 ] Whether fragile commands in this layout should be
13405 \begin_inset Flex CharStyle:Code
13408 \begin_layout Plain Layout
13421 whether this command should itself be protected.)
13424 \begin_layout Description
13425 \begin_inset Flex CharStyle:Code
13428 \begin_layout Plain Layout
13434 As with paragraph styles (see page
13435 \begin_inset CommandInset ref
13436 LatexCommand pageref
13437 reference "des:Preamble"
13444 \begin_layout Description
13445 \begin_inset Flex CharStyle:Code
13448 \begin_layout Plain Layout
13455 \begin_inset Flex CharStyle:Code
13458 \begin_layout Plain Layout
13464 ] As with paragraph styles (see page
13465 \begin_inset CommandInset ref
13466 LatexCommand pageref
13467 reference "des:Requires"
13474 \begin_layout Subsection
13478 \begin_layout Standard
13479 \begin_inset CommandInset label
13485 Since version 1.3.0 of LyX, it is both possible and necessary to define the
13487 \begin_inset Flex CharStyle:MenuItem
13490 \begin_layout Plain Layout
13497 \begin_inset Flex CharStyle:MenuItem
13500 \begin_layout Plain Layout
13506 , \SpecialChar \ldots{}
13507 ) in the text class itself.
13508 The standard counters are defined in the file
13509 \begin_inset Flex CharStyle:Code
13512 \begin_layout Plain Layout
13518 , so you may have to do no more than add
13521 \begin_layout LyX-Code
13522 Input stdcounters.inc
13525 \begin_layout Standard
13526 to your layout file to get them to work.
13527 But if you want to define custom counters, then you can do so, using the
13528 following parameters:
13531 \begin_layout Description
13532 \begin_inset Flex CharStyle:Code
13535 \begin_layout Plain Layout
13536 LabelString [string=""]
13541 when this is defined, this string defines how the counter is displayed.
13542 Setting this value sets
13543 \begin_inset Flex CharStyle:Code
13546 \begin_layout Plain Layout
13547 LabelStringAppendix
13553 The following special constructs can be used in the string:
13557 \begin_layout Itemize
13558 \begin_inset Flex CharStyle:Code
13561 \begin_layout Plain Layout
13569 will be replaced by the expansion of the
13570 \begin_inset Flex CharStyle:Code
13573 \begin_layout Plain Layout
13580 \begin_inset Flex CharStyle:Code
13583 \begin_layout Plain Layout
13584 LabelStringAppendix
13590 \begin_inset Flex CharStyle:Code
13593 \begin_layout Plain Layout
13603 \begin_layout Itemize
13604 counter values can be expressed using LaTeX-like macros
13605 \begin_inset Flex CharStyle:Code
13608 \begin_layout Plain Layout
13625 \begin_inset Flex CharStyle:Code
13628 \begin_layout Plain Layout
13640 \begin_layout Plain Layout
13650 Actually, the situation is a bit more complicated: any
13669 other than those descibed below will produce arabic numerals.
13670 It would not be surprising to see this change in the future.
13676 \begin_inset Flex CharStyle:Code
13679 \begin_layout Plain Layout
13685 : 1, 2, 3,\SpecialChar \ldots{}
13687 \begin_inset Flex CharStyle:Code
13690 \begin_layout Plain Layout
13696 for lower-case letters: a, b, c, \SpecialChar \ldots{}
13698 \begin_inset Flex CharStyle:Code
13701 \begin_layout Plain Layout
13707 for upper-case letters: A, B, C, \SpecialChar \ldots{}
13709 \begin_inset Flex CharStyle:Code
13712 \begin_layout Plain Layout
13718 for lower-case roman numerals: i, ii, iii, \SpecialChar \ldots{}
13720 \begin_inset Flex CharStyle:Code
13723 \begin_layout Plain Layout
13729 for upper-case roman numerals: I, II, III\SpecialChar \ldots{}
13731 \begin_inset Flex CharStyle:Code
13734 \begin_layout Plain Layout
13740 for hebrew numerals.
13744 \begin_layout Standard
13745 If LabelString is not defined, a default value is constructed as follows:
13746 if the counter has a master counter
13747 \begin_inset Flex CharStyle:Code
13750 \begin_layout Plain Layout
13757 \begin_inset Flex CharStyle:Code
13760 \begin_layout Plain Layout
13767 \begin_inset Flex CharStyle:Code
13770 \begin_layout Plain Layout
13780 is used; otherwise the string
13781 \begin_inset Flex CharStyle:Code
13784 \begin_layout Plain Layout
13795 \begin_layout Description
13796 \begin_inset Flex CharStyle:Code
13799 \begin_layout Plain Layout
13800 LabelStringAppendix [string=""]
13806 \begin_inset Flex CharStyle:Code
13809 \begin_layout Plain Layout
13818 \begin_layout Description
13819 \begin_inset Flex CharStyle:Code
13822 \begin_layout Plain Layout
13829 \begin_inset Flex CharStyle:Code
13832 \begin_layout Plain Layout
13839 \begin_inset Quotes erd
13843 \begin_inset Quotes erd
13846 ] The name of the counter.
13849 \begin_layout Description
13850 \begin_inset Flex CharStyle:Code
13853 \begin_layout Plain Layout
13860 \begin_inset Flex CharStyle:Code
13863 \begin_layout Plain Layout
13870 \begin_inset Quotes erd
13874 \begin_inset Quotes erd
13877 ] If this is set to the name of another counter, the present counter will
13878 be reset everytime the other one is increased.
13880 \begin_inset Flex CharStyle:Code
13883 \begin_layout Plain Layout
13890 \begin_inset Flex CharStyle:Code
13893 \begin_layout Plain Layout
13902 \begin_layout Subsection
13906 \begin_layout Standard
13907 \begin_inset CommandInset label
13913 A font description looks like this:
13916 \begin_layout LyX-Code
13926 \begin_layout LyX-Code
13930 \begin_layout LyX-Code
13934 \begin_layout Standard
13935 The following commands are available:
13938 \begin_layout Description
13939 \begin_inset Flex CharStyle:Code
13942 \begin_layout Plain Layout
13949 \begin_inset Flex CharStyle:Code
13952 \begin_layout Plain Layout
13961 \begin_inset Flex CharStyle:Code
13964 \begin_layout Plain Layout
13971 \begin_inset Flex CharStyle:Code
13974 \begin_layout Plain Layout
13981 \begin_inset Flex CharStyle:Code
13984 \begin_layout Plain Layout
13991 \begin_inset Flex CharStyle:Code
13994 \begin_layout Plain Layout
14001 \begin_inset Flex CharStyle:Code
14004 \begin_layout Plain Layout
14011 \begin_inset Flex CharStyle:Code
14014 \begin_layout Plain Layout
14021 \begin_inset Flex CharStyle:Code
14024 \begin_layout Plain Layout
14031 \begin_inset Flex CharStyle:Code
14034 \begin_layout Plain Layout
14043 \begin_layout Description
14044 \begin_inset Flex CharStyle:Code
14047 \begin_layout Plain Layout
14056 \begin_inset Flex CharStyle:Code
14059 \begin_layout Plain Layout
14070 \begin_inset Flex CharStyle:Code
14073 \begin_layout Plain Layout
14080 \begin_inset Flex CharStyle:Code
14083 \begin_layout Plain Layout
14092 \begin_layout Description
14093 \begin_inset Flex CharStyle:Code
14096 \begin_layout Plain Layout
14103 \begin_inset Flex CharStyle:Code
14106 \begin_layout Plain Layout
14112 ] Valid argument sare:
14113 \begin_inset Flex CharStyle:Code
14116 \begin_layout Plain Layout
14123 \begin_inset Flex CharStyle:Code
14126 \begin_layout Plain Layout
14133 \begin_inset Flex CharStyle:Code
14136 \begin_layout Plain Layout
14143 \begin_inset Flex CharStyle:Code
14146 \begin_layout Plain Layout
14153 \begin_inset Flex CharStyle:Code
14156 \begin_layout Plain Layout
14163 \begin_inset Flex CharStyle:Code
14166 \begin_layout Plain Layout
14173 Each of these turns on or off the corresponding attribute.
14176 \begin_layout Description
14177 \begin_inset Flex CharStyle:Code
14180 \begin_layout Plain Layout
14189 \begin_inset Flex CharStyle:Code
14192 \begin_layout Plain Layout
14203 \begin_inset Flex CharStyle:Code
14206 \begin_layout Plain Layout
14215 \begin_layout Description
14216 \begin_inset Flex CharStyle:Code
14219 \begin_layout Plain Layout
14228 \begin_inset Flex CharStyle:Code
14231 \begin_layout Plain Layout
14242 \begin_inset Flex CharStyle:Code
14245 \begin_layout Plain Layout
14252 \begin_inset Flex CharStyle:Code
14255 \begin_layout Plain Layout
14262 \begin_inset Flex CharStyle:Code
14265 \begin_layout Plain Layout
14274 \begin_layout Description
14275 \begin_inset Flex CharStyle:Code
14278 \begin_layout Plain Layout
14285 \begin_inset Flex CharStyle:Code
14288 \begin_layout Plain Layout
14295 \begin_inset Flex CharStyle:Code
14298 \begin_layout Plain Layout
14305 \begin_inset Flex CharStyle:Code
14308 \begin_layout Plain Layout
14317 \begin_inset Flex CharStyle:Code
14320 \begin_layout Plain Layout
14327 \begin_inset Flex CharStyle:Code
14330 \begin_layout Plain Layout
14337 \begin_inset Flex CharStyle:Code
14340 \begin_layout Plain Layout
14347 \begin_inset Flex CharStyle:Code
14350 \begin_layout Plain Layout
14357 \begin_inset Flex CharStyle:Code
14360 \begin_layout Plain Layout
14369 \begin_layout Subsection
14370 Upgrading old layout files
14373 \begin_layout Standard
14374 The file format of layout files changes from time to time, so old layout
14375 files need to be converted.
14376 This process has been automated since LyX 1.4.0: If LyX reads an old format
14377 layout file it will call the conversion tool
14378 \begin_inset Flex CharStyle:Code
14381 \begin_layout Plain Layout
14382 LyXDir/scripts/layout2layout.py
14387 and convert it to a temporary file in current format.
14388 The original file is left untouched.
14389 If you want to convert the layout file permanently, just call the converter
14393 \begin_layout LyX-Code
14394 python $LyXDir/scripts/layout2layout.py myclass.layout myclassnew.layout
14397 \begin_layout Standard
14398 (You need to replace
14399 \begin_inset Flex CharStyle:Code
14402 \begin_layout Plain Layout
14408 with the name of your LyX system directory, unless you happen to have defined
14409 such an environment variable.) Then copy
14410 \begin_inset Flex CharStyle:Code
14413 \begin_layout Plain Layout
14420 \begin_inset Flex CharStyle:Code
14423 \begin_layout Plain Layout
14432 \begin_layout Standard
14433 The automatic conversion only handles syntax changes.
14434 It cannot handle the case where the contents of included files was changed,
14435 so these will have to be converted separately.
14438 \begin_layout Section
14440 \begin_inset CommandInset label
14442 name "sec:templates"
14449 \begin_layout Standard
14450 Templates are created just like usual documents.
14451 The only difference is that usual documents contain all possible settings,
14452 including the font scheme and the paper size.
14453 Usually a user doesn't want a template to overwrite his defaults in these
14455 For that reason, the designer of a template should remove the corresponding
14457 \begin_inset Flex CharStyle:Code
14460 \begin_layout Plain Layout
14469 \begin_inset Flex CharStyle:Code
14472 \begin_layout Plain Layout
14480 from the template LyX file.
14481 This can be done with any simple text-editor, for example
14482 \begin_inset Flex CharStyle:Code
14485 \begin_layout Plain Layout
14492 \begin_inset Flex CharStyle:Code
14495 \begin_layout Plain Layout
14505 \begin_layout Standard
14506 Put the edited template files you create in
14507 \begin_inset Flex CharStyle:Code
14510 \begin_layout Plain Layout
14516 , copy the ones you use from the global template directory in
14517 \begin_inset Flex CharStyle:Code
14520 \begin_layout Plain Layout
14526 to the same place, and redefine the template path in the
14527 \begin_inset Flex CharStyle:MenuItem
14530 \begin_layout Plain Layout
14538 \SpecialChar \menuseparator
14543 references\SpecialChar \menuseparator
14552 \begin_layout Standard
14553 Note that there is a template which has a particular meaning:
14554 \begin_inset Flex CharStyle:Code
14557 \begin_layout Plain Layout
14564 This template is loaded everytime you create a new document with
14565 \begin_inset Flex CharStyle:MenuItem
14568 \begin_layout Plain Layout
14578 \SpecialChar \menuseparator
14580 \begin_inset Flex CharStyle:MenuItem
14583 \begin_layout Plain Layout
14593 in order to provide useful defaults.
14594 To create this template from inside LyX, all you have to do is to open
14595 a document with the correct settings, and use the
14596 \begin_inset Flex CharStyle:MenuItem
14599 \begin_layout Plain Layout
14604 e as Document Defaults
14612 \begin_layout Chapter
14613 Including External Material
14616 \begin_layout Standard
14617 The use of material from sources external to LyX is covered in detail in
14623 This part of the manual covers what needs to happen behind the scenes for
14624 new sorts of material to be included.
14627 \begin_layout Section
14631 \begin_layout Standard
14632 The external material feature is based on the concept of a
14637 A template is a specification of how LyX should interface with a certain
14639 As bundled, LyX comes with predefined templates for Xfig figures, various
14640 raster format images, chess diagrams, and LilyPond music notation.
14641 You can check the actual list by using the menu
14642 \begin_inset Flex CharStyle:MenuItem
14645 \begin_layout Plain Layout
14646 Insert\SpecialChar \menuseparator
14647 File\SpecialChar \menuseparator
14654 Furthermore, it is possible to roll your own template to support a specific
14656 Later we'll describe in more detail what is involved, and hopefully you
14657 will submit all the templates you create so we can include them in a later
14661 \begin_layout Standard
14662 Another basic idea of the external material feature is to distinguish between
14663 the original file that serves as a base for final material and the produced
14664 file that is included in your exported or printed document.
14665 For example, consider the case of a figure produced with
14666 \begin_inset Flex CharStyle:Code
14669 \begin_layout Plain Layout
14676 The Xfig application itself works on an original file with the
14677 \begin_inset Flex CharStyle:Code
14680 \begin_layout Plain Layout
14687 Within XFig, you create and change your figure, and when you are done,
14689 \begin_inset Flex CharStyle:Code
14692 \begin_layout Plain Layout
14699 When you want to include the figure in your document, you invoke
14700 \begin_inset Flex CharStyle:Code
14703 \begin_layout Plain Layout
14709 in order to create a PostScript file that can readily be included in your
14712 \begin_inset Flex CharStyle:Code
14715 \begin_layout Plain Layout
14721 file is the original file, and the PostScript file is the produced file.
14724 \begin_layout Standard
14725 This distinction is important in order to allow updating of the material
14726 while you are in the process of writing the document.
14727 Furthermore, it provides us with the flexibility that is needed to support
14728 multiple export formats.
14729 For instance, in the case of a plain text file, it is not exactly an award-winn
14730 ing idea to include the figure as raw PostScript®.
14731 Instead, you'd either prefer to just include a reference to the figure
14732 or try to invoke some graphics to Ascii converter to make the final result
14733 look similar to the real graphics.
14734 The external material management allows you to do this, because it is parameter
14735 ized on the different export formats that LyX supports.
14738 \begin_layout Standard
14739 Besides supporting the production of different products according to the
14740 exported format, it supports tight integration with editing and viewing
14742 In the case of an XFig figure, you are able to invoke Xfig on the original
14743 file with a single click from within the external material dialog in LyX,
14744 and also preview the produced PostScript file with ghostview with another
14746 No more fiddling around with the command line and/or file browsers to locate
14747 and manipulate the original or produced files.
14748 In this way, you are finally able to take full advantage of the many different
14749 applications that are relevant to use when you write your documents, and
14750 ultimately be more productive.
14753 \begin_layout Section
14754 The external template configuration file
14757 \begin_layout Standard
14758 It is relatively easy to add custom external template definitions to LyX.
14759 However, be aware that doing this in an careless manner most probably
14763 introduce an easily exploitable security hole.
14764 So before you do this, please read the discussion about security in section
14766 \begin_inset CommandInset ref
14768 reference "sec:Security-discussion"
14775 \begin_layout Standard
14776 Having said that, we encourage you to submit any interesting templates that
14781 \begin_layout Standard
14782 The external templates are defined in the
14783 \begin_inset Flex CharStyle:Code
14786 \begin_layout Plain Layout
14787 LyXDir/lib/external_templates
14793 You can place your own version in
14794 \begin_inset Flex CharStyle:Code
14797 \begin_layout Plain Layout
14798 UserDir/external_templates
14806 \begin_layout Standard
14807 A typical template looks like this:
14810 \begin_layout LyX-Code
14814 \begin_layout LyX-Code
14815 GuiName "XFig: $$AbsOrRelPathParent$$Basename"
14818 \begin_layout LyX-Code
14822 \begin_layout LyX-Code
14826 \begin_layout LyX-Code
14830 \begin_layout LyX-Code
14834 \begin_layout LyX-Code
14838 \begin_layout LyX-Code
14839 AutomaticProduction true
14842 \begin_layout LyX-Code
14846 \begin_layout LyX-Code
14850 \begin_layout LyX-Code
14854 \begin_layout LyX-Code
14855 TransformCommand Rotate RotationLatexCommand
14858 \begin_layout LyX-Code
14859 TransformCommand Resize ResizeLatexCommand
14862 \begin_layout LyX-Code
14863 Product "$$RotateFront$$ResizeFront
14866 \begin_layout LyX-Code
14871 input{$$AbsOrRelPathMaster$$Basename.pstex_t}
14874 \begin_layout LyX-Code
14875 $$ResizeBack$$RotateBack"
14878 \begin_layout LyX-Code
14882 \begin_layout LyX-Code
14883 UpdateResult "$$AbsPath$$Basename.pstex_t"
14886 \begin_layout LyX-Code
14887 Requirement "graphicx"
14890 \begin_layout LyX-Code
14891 ReferencedFile latex "$$AbsOrRelPathMaster$$Basename.pstex_t"
14894 \begin_layout LyX-Code
14895 ReferencedFile latex "$$AbsPath$$Basename.eps"
14898 \begin_layout LyX-Code
14899 ReferencedFile dvi "$$AbsPath$$Basename.eps"
14902 \begin_layout LyX-Code
14906 \begin_layout LyX-Code
14910 \begin_layout LyX-Code
14911 TransformCommand Rotate RotationLatexCommand
14914 \begin_layout LyX-Code
14915 TransformCommand Resize ResizeLatexCommand
14918 \begin_layout LyX-Code
14919 Product "$$RotateFront$$ResizeFront
14922 \begin_layout LyX-Code
14927 input{$$AbsOrRelPathMaster$$Basename.pdftex_t}
14930 \begin_layout LyX-Code
14931 $$ResizeBack$$RotateBack"
14934 \begin_layout LyX-Code
14935 UpdateFormat pdftex
14938 \begin_layout LyX-Code
14939 UpdateResult "$$AbsPath$$Basename.pdftex_t"
14942 \begin_layout LyX-Code
14943 Requirement "graphicx"
14946 \begin_layout LyX-Code
14947 ReferencedFile latex "$$AbsOrRelPathMaster$$Basename.pdftex_t"
14950 \begin_layout LyX-Code
14951 ReferencedFile latex "$$AbsPath$$Basename.pdf"
14954 \begin_layout LyX-Code
14958 \begin_layout LyX-Code
14962 \begin_layout LyX-Code
14963 Product "$$Contents(
14965 "$$AbsPath$$Basename.asc
14970 \begin_layout LyX-Code
14971 UpdateFormat asciixfig
14974 \begin_layout LyX-Code
14975 UpdateResult "$$AbsPath$$Basename.asc"
14978 \begin_layout LyX-Code
14982 \begin_layout LyX-Code
14986 \begin_layout LyX-Code
14987 Product "<graphic fileref=
14989 "$$AbsOrRelPathMaster$$Basename.eps
14994 \begin_layout LyX-Code
14998 \begin_layout LyX-Code
15002 \begin_layout LyX-Code
15003 UpdateResult "$$AbsPath$$Basename.eps"
15006 \begin_layout LyX-Code
15007 ReferencedFile docbook "$$AbsPath$$Basename.eps"
15010 \begin_layout LyX-Code
15011 ReferencedFile docbook-xml "$$AbsPath$$Basename.eps"
15014 \begin_layout LyX-Code
15018 \begin_layout LyX-Code
15019 Product "[XFig: $$FName]"
15022 \begin_layout LyX-Code
15026 \begin_layout LyX-Code
15030 \begin_layout Standard
15031 As you can see, the template is enclosed in
15032 \begin_inset Flex CharStyle:Code
15035 \begin_layout Plain Layout
15041 \SpecialChar \ldots{}
15043 \begin_inset Flex CharStyle:Code
15046 \begin_layout Plain Layout
15053 It contains a header specifying some general settings and, for each supported
15054 primary document file format, a section
15055 \begin_inset Flex CharStyle:Code
15058 \begin_layout Plain Layout
15064 \SpecialChar \ldots{}
15066 \begin_inset Flex CharStyle:Code
15069 \begin_layout Plain Layout
15078 \begin_layout Subsection
15079 The template header
15082 \begin_layout Description
15083 \begin_inset Flex CharStyle:Code
15086 \begin_layout Plain Layout
15087 AutomaticProduction
15088 \begin_inset space ~
15096 Whether the file represented by the template must be generated by LyX.
15097 This command must occur exactly once.
15100 \begin_layout Description
15101 \begin_inset Flex CharStyle:Code
15104 \begin_layout Plain Layout
15106 \begin_inset space ~
15114 A glob pattern that is used in the file dialog to filter out the desired
15116 If there is more than one possible file extension (e.g.
15117 \begin_inset space ~
15121 \begin_inset Flex CharStyle:Code
15124 \begin_layout Plain Layout
15131 \begin_inset Flex CharStyle:Code
15134 \begin_layout Plain Layout
15140 ), use something like
15141 \begin_inset Flex CharStyle:Code
15144 \begin_layout Plain Layout
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 ~
15168 The text that is displayed on the button.
15169 This command must occur exactly once.
15172 \begin_layout Description
15173 \begin_inset Flex CharStyle:Code
15176 \begin_layout Plain Layout
15178 \begin_inset space ~
15182 \begin_inset space ~
15190 The help text that is used in the External dialog.
15191 Provide enough information to explain to the user just what the template
15192 can provide him with.
15193 This command must occur exactly once.
15196 \begin_layout Description
15197 \begin_inset Flex CharStyle:Code
15200 \begin_layout Plain Layout
15202 \begin_inset space ~
15210 The file format of the original file.
15211 This must be the name of a format that is known to LyX (see section
15212 \begin_inset CommandInset ref
15214 reference "sub:Formats"
15220 \begin_inset Quotes eld
15224 \begin_inset Flex CharStyle:Code
15227 \begin_layout Plain Layout
15234 \begin_inset Quotes erd
15237 if the template can handle original files of more than one format.
15238 LyX will attempt to interrogate the file itself in order to deduce its
15239 format in this case.
15240 This command must occur exactly once.
15243 \begin_layout Description
15244 \begin_inset Flex CharStyle:Code
15247 \begin_layout Plain Layout
15249 \begin_inset space ~
15257 A unique name for the template.
15258 It must not contain substitution macros (see below).
15261 \begin_layout Description
15262 \begin_inset Flex CharStyle:Code
15265 \begin_layout Plain Layout
15267 \begin_inset space ~
15270 Rotate|Resize|Clip|Extra
15275 This command specifies which transformations are supported by this template.
15276 It may occur zero or more times.
15277 This command enables the corresponding tabs in the external dialog.
15279 \begin_inset Flex CharStyle:Code
15282 \begin_layout Plain Layout
15288 command must have either a corresponding
15289 \begin_inset Flex CharStyle:Code
15292 \begin_layout Plain Layout
15299 \begin_inset Flex CharStyle:Code
15302 \begin_layout Plain Layout
15309 \begin_inset Flex CharStyle:Code
15312 \begin_layout Plain Layout
15319 Otherwise the transformation will not be supported by that format.
15322 \begin_layout Subsection
15326 \begin_layout Description
15327 \begin_inset Flex CharStyle:Code
15330 \begin_layout Plain Layout
15332 \begin_inset space ~
15335 LaTeX|PDFLaTeX|PlainText|DocBook
15340 The primary document file format that this format definition is for.
15341 Not every template has a sensible representation in all document file formats.
15342 Please define nevertheless a
15343 \begin_inset Flex CharStyle:Code
15346 \begin_layout Plain Layout
15352 section for all formats.
15353 Use a dummy text when no representation is available.
15354 Then you can at least see a reference to the external material in the exported
15358 \begin_layout Description
15359 \begin_inset Flex CharStyle:Code
15362 \begin_layout Plain Layout
15364 \begin_inset space ~
15368 \begin_inset space ~
15376 This command defines an additional macro
15377 \begin_inset Flex CharStyle:Code
15380 \begin_layout Plain Layout
15386 for substitution in
15387 \begin_inset Flex CharStyle:Code
15390 \begin_layout Plain Layout
15398 \begin_inset Flex CharStyle:Code
15401 \begin_layout Plain Layout
15407 itself may contain substitution macros.
15408 The advantage over using
15409 \begin_inset Flex CharStyle:Code
15412 \begin_layout Plain Layout
15419 \begin_inset Flex CharStyle:Code
15422 \begin_layout Plain Layout
15428 is that the substituted value of
15429 \begin_inset Flex CharStyle:Code
15432 \begin_layout Plain Layout
15438 is sanitized so that it is a valid optional argument in the document format.
15439 This command may occur zero or more times.
15442 \begin_layout Description
15443 \begin_inset Flex CharStyle:Code
15446 \begin_layout Plain Layout
15448 \begin_inset space ~
15456 The text that is inserted in the exported document.
15457 This is actually the most important command and can be quite complex.
15458 This command must occur exactly once.
15461 \begin_layout Description
15462 \begin_inset Flex CharStyle:Code
15465 \begin_layout Plain Layout
15467 \begin_inset space ~
15475 This command specifies a preamble snippet that will be included in the
15477 It has to be defined using
15478 \begin_inset Flex CharStyle:Code
15481 \begin_layout Plain Layout
15487 \SpecialChar \ldots{}
15489 \begin_inset Flex CharStyle:Code
15492 \begin_layout Plain Layout
15499 This command may occur zero or more times.
15502 \begin_layout Description
15503 \begin_inset Flex CharStyle:Code
15506 \begin_layout Plain Layout
15508 \begin_inset space ~
15512 \begin_inset space ~
15520 This command denotes files that are created by the conversion process and
15521 are needed for a particular export format.
15522 If the filename is relative, it is interpreted relative to the master document.
15523 This command may be given zero or more times.
15526 \begin_layout Description
15527 \begin_inset Flex CharStyle:Code
15530 \begin_layout Plain Layout
15532 \begin_inset space ~
15540 The name of a required LaTeX package.
15541 The package is included via
15542 \begin_inset Flex CharStyle:Code
15545 \begin_layout Plain Layout
15553 in the LaTeX preamble.
15554 This command may occur zero or more times.
15557 \begin_layout Description
15558 \begin_inset Flex CharStyle:Code
15561 \begin_layout Plain Layout
15563 \begin_inset space ~
15567 \begin_inset space ~
15570 RotationLatexCommand
15575 This command specifies that the built in LaTeX command should be used for
15577 This command may occur once or not at all.
15580 \begin_layout Description
15581 \begin_inset Flex CharStyle:Code
15584 \begin_layout Plain Layout
15586 \begin_inset space ~
15590 \begin_inset space ~
15598 This command specifies that the built in LaTeX command should be used for
15600 This command may occur once or not at all.
15603 \begin_layout Description
15604 \begin_inset Flex CharStyle:Code
15607 \begin_layout Plain Layout
15609 \begin_inset space ~
15613 \begin_inset space ~
15616 RotationLatexOption
15621 This command specifies that rotation is done via an optional argument.
15622 This command may occur once or not at all.
15625 \begin_layout Description
15626 \begin_inset Flex CharStyle:Code
15629 \begin_layout Plain Layout
15631 \begin_inset space ~
15635 \begin_inset space ~
15643 This command specifies that resizing is done via an optional argument.
15644 This command may occur once or not at all.
15647 \begin_layout Description
15648 \begin_inset Flex CharStyle:Code
15651 \begin_layout Plain Layout
15653 \begin_inset space ~
15657 \begin_inset space ~
15665 This command specifies that clipping is done via an optional argument.
15666 This command may occur once or not at all.
15669 \begin_layout Description
15670 \begin_inset Flex CharStyle:Code
15673 \begin_layout Plain Layout
15675 \begin_inset space ~
15679 \begin_inset space ~
15687 This command specifies that an extra optional argument is used.
15688 This command may occur once or not at all.
15691 \begin_layout Description
15692 \begin_inset Flex CharStyle:Code
15695 \begin_layout Plain Layout
15697 \begin_inset space ~
15705 The file format of the converted file.
15706 This must be the name of a format that is known to LyX (see the
15707 \begin_inset Flex CharStyle:MenuItem
15710 \begin_layout Plain Layout
15715 ools\SpecialChar \menuseparator
15720 references:Conversion
15726 This command must occur exactly once.
15729 \begin_layout Description
15730 \begin_inset Flex CharStyle:Code
15733 \begin_layout Plain Layout
15735 \begin_inset space ~
15743 The file name of the converted file.
15744 The file name must be absolute.
15745 This command must occur exactly once.
15748 \begin_layout Subsection
15749 Preamble definitions
15752 \begin_layout Standard
15753 The external template configuration file may contain additional preamble
15754 definitions enclosed by
15755 \begin_inset Flex CharStyle:Code
15758 \begin_layout Plain Layout
15764 \SpecialChar \ldots{}
15766 \begin_inset Flex CharStyle:Code
15769 \begin_layout Plain Layout
15776 They can be used by the templates in the
15777 \begin_inset Flex CharStyle:Code
15780 \begin_layout Plain Layout
15789 \begin_layout Section
15790 The substitution mechanism
15793 \begin_layout Standard
15794 When the external material facility invokes an external program, it is done
15795 on the basis of a command defined in the template configuration file.
15796 These commands can contain various macros that are expanded before execution.
15797 Execution always take place in the directory of the containing document.
15800 \begin_layout Standard
15801 Also, whenever external material is to be displayed, the name will be produced
15802 by the substitution mechanism, and most other commands in the template
15803 definition support substitution as well.
15806 \begin_layout Standard
15807 The available macros are the following:
15810 \begin_layout Description
15811 \begin_inset Flex CharStyle:Code
15814 \begin_layout Plain Layout
15815 $$AbsOrRelPathMaster
15820 The file path, absolute or relative to the master LyX document.
15823 \begin_layout Description
15824 \begin_inset Flex CharStyle:Code
15827 \begin_layout Plain Layout
15828 $$AbsOrRelPathParent
15833 The file path, absolute or relative to the LyX document.
15836 \begin_layout Description
15837 \begin_inset Flex CharStyle:Code
15840 \begin_layout Plain Layout
15846 The absolute file path.
15849 \begin_layout Description
15850 \begin_inset Flex CharStyle:Code
15853 \begin_layout Plain Layout
15859 The filename without path and without the extension.
15862 \begin_layout Description
15863 \begin_inset Flex CharStyle:Code
15866 \begin_layout Plain Layout
15868 \begin_inset Quotes eld
15872 \begin_inset Quotes erd
15880 This macro will expand to the contents of the file with the name
15881 \begin_inset Flex CharStyle:Code
15884 \begin_layout Plain Layout
15893 \begin_layout Description
15894 \begin_inset Flex CharStyle:Code
15897 \begin_layout Plain Layout
15903 The file extension (including the dot).
15906 \begin_layout Description
15907 \begin_inset Flex CharStyle:Code
15910 \begin_layout Plain Layout
15916 The filename of the file specified in the external material dialog.
15917 This is either an absolute name, or it is relative to the LyX document.
15920 \begin_layout Description
15921 \begin_inset Flex CharStyle:Code
15924 \begin_layout Plain Layout
15931 \begin_inset Flex CharStyle:Code
15934 \begin_layout Plain Layout
15940 (absolute name or relative to the LyX document).
15943 \begin_layout Description
15944 \begin_inset Flex CharStyle:Code
15947 \begin_layout Plain Layout
15953 The file path, relative to the master LyX document.
15956 \begin_layout Description
15957 \begin_inset Flex CharStyle:Code
15960 \begin_layout Plain Layout
15966 The file path, relative to the LyX document.
15969 \begin_layout Description
15970 \begin_inset Flex CharStyle:Code
15973 \begin_layout Plain Layout
15979 This macro will expand to the absolute path of the system directory.
15980 This is typically used to point to the various helper scripts that are
15984 \begin_layout Description
15985 \begin_inset Flex CharStyle:Code
15988 \begin_layout Plain Layout
15994 A name and full path to a temporary file which will be automatically deleted
15995 whenever the containing document is closed, or the external material insertion
15999 \begin_layout Standard
16000 All path macros contain a trailing directory separator, so you can construct
16002 the absolute filename with
16003 \begin_inset Flex CharStyle:Code
16006 \begin_layout Plain Layout
16007 $$AbsPath$$Basename$$Extension
16015 \begin_layout Standard
16016 The macros above are substituted in all commands unless otherwise noted.
16018 \begin_inset Flex CharStyle:Code
16021 \begin_layout Plain Layout
16027 supports additionally the following substitutions if they are enabled by
16029 \begin_inset Flex CharStyle:Code
16032 \begin_layout Plain Layout
16039 \begin_inset Flex CharStyle:Code
16042 \begin_layout Plain Layout
16051 \begin_layout Description
16052 \begin_inset Flex CharStyle:Code
16055 \begin_layout Plain Layout
16061 The front part of the resize command.
16064 \begin_layout Description
16065 \begin_inset Flex CharStyle:Code
16068 \begin_layout Plain Layout
16074 The back part of the resize command.
16077 \begin_layout Description
16078 \begin_inset Flex CharStyle:Code
16081 \begin_layout Plain Layout
16087 The front part of the rotation command.
16090 \begin_layout Description
16091 \begin_inset Flex CharStyle:Code
16094 \begin_layout Plain Layout
16100 The back part of the rotation command.
16103 \begin_layout Standard
16104 The value string of the
16105 \begin_inset Flex CharStyle:Code
16108 \begin_layout Plain Layout
16114 command supports additionally the following substitutions if they are enabled
16116 \begin_inset Flex CharStyle:Code
16119 \begin_layout Plain Layout
16126 \begin_inset Flex CharStyle:Code
16129 \begin_layout Plain Layout
16138 \begin_layout Description
16139 \begin_inset Flex CharStyle:Code
16142 \begin_layout Plain Layout
16151 \begin_layout Description
16152 \begin_inset Flex CharStyle:Code
16155 \begin_layout Plain Layout
16164 \begin_layout Description
16165 \begin_inset Flex CharStyle:Code
16168 \begin_layout Plain Layout
16177 \begin_layout Description
16178 \begin_inset Flex CharStyle:Code
16181 \begin_layout Plain Layout
16187 The rotation option.
16190 \begin_layout Standard
16191 You may ask why there are so many path macros.
16192 There are mainly two reasons:
16195 \begin_layout Enumerate
16196 Relative and absolute file names should remain relative or absolute, respectivel
16198 Users may have reasons to prefer either form.
16199 Relative names are useful for portable documents that should work on different
16200 machines, for example.
16201 Absolute names may be required by some programs.
16204 \begin_layout Enumerate
16205 LaTeX treats relative file names differently than LyX and other programs
16206 in nested included files.
16207 For LyX, a relative file name is always relative to the document that contains
16209 For LaTeX, it is always relative to the master document.
16210 These two definitions are identical if you have only one document, but
16211 differ if you have a master document that includes part documents.
16212 That means that relative filenames must be transformed when presented to
16214 Fortunately LyX does this automatically for you if you choose the right
16218 \begin_layout Standard
16219 So which path macro should be used in new template definitions? The rule
16223 \begin_layout Itemize
16225 \begin_inset Flex CharStyle:Code
16228 \begin_layout Plain Layout
16234 if an absolute path is required.
16237 \begin_layout Itemize
16239 \begin_inset Flex CharStyle:Code
16242 \begin_layout Plain Layout
16243 $$AbsOrRelPathMaster
16248 if the substituted string is some kind of LaTeX input.
16251 \begin_layout Itemize
16253 \begin_inset Flex CharStyle:Code
16256 \begin_layout Plain Layout
16257 $$AbsOrRelPathParent
16262 in order to preserve the user's choice.
16265 \begin_layout Standard
16266 There are special cases where this rule does not work and e.g.
16267 \begin_inset space ~
16270 relative names are needed, but normally it will work just fine.
16271 One example for such a case is the command
16272 \begin_inset Flex CharStyle:Code
16275 \begin_layout Plain Layout
16276 ReferencedFile latex "$$AbsOrRelPathMaster$$Basename.pstex_t"
16281 in the XFig template above: We can't use the absolute name because the
16283 \begin_inset Flex CharStyle:Code
16286 \begin_layout Plain Layout
16292 files needs the relative name in order to rewrite the file content.
16295 \begin_layout Section
16296 \begin_inset CommandInset label
16298 name "sec:Security-discussion"
16302 Security discussion
16305 \begin_layout Standard
16306 \begin_inset Note Note
16309 \begin_layout Plain Layout
16310 This section is outdated
16315 The external material feature interfaces with a lot of external programs
16316 and does so automatically, so we have to consider the security implications
16318 In particular, since you have the option of including your own filenames
16319 and/or parameter strings and those are expanded into a command, it seems
16320 that it would be possible to create a malicious document which executes
16321 arbitrary commands when a user views or prints the document.
16322 This is something we definately want to avoid.
16325 \begin_layout Standard
16326 However, since the external program commands are specified in the template
16327 configuration file only, there are no security issues if LyX is properly
16328 configured with safe templates only.
16329 This is so because the external programs are invoked with the
16330 \begin_inset Flex CharStyle:Code
16333 \begin_layout Plain Layout
16339 -system call rather than the
16340 \begin_inset Flex CharStyle:Code
16343 \begin_layout Plain Layout
16349 system-call, so it's not possible to execute arbitrary commands from the
16350 filename or parameter section via the shell.
16353 \begin_layout Standard
16354 This also implies that you are restricted in what command strings you can
16355 use in the external material templates.
16356 In particular, pipes and redirection are not readily available.
16357 This has to be so if LyX should remain safe.
16358 If you want to use some of the shell features, you should write a safe
16359 script to do this in a controlled manner, and then invoke the script from
16360 the command string.
16362 \begin_inset Flex CharStyle:Code
16365 \begin_layout Plain Layout
16371 directory of the LyX installation, you can find a safe wrapper script
16372 \begin_inset Flex CharStyle:Code
16375 \begin_layout Plain Layout
16376 general_command_wrapper.py
16381 that supports redirection of input and output.
16382 That can serve as an example for how to write safe template scripts.
16383 For a more advanced example that uses
16384 \begin_inset Flex CharStyle:Code
16387 \begin_layout Plain Layout
16393 and friends, take a look at the
16394 \begin_inset Flex CharStyle:Code
16397 \begin_layout Plain Layout
16406 \begin_layout Standard
16407 It is possible to design a template that interacts directly with the shell,
16408 but since this would allow a malicious user to execute arbitrary commands
16409 by writing clever filenames and/or parameters, we generally recommend that
16410 you only use safe scripts that work with the
16411 \begin_inset Flex CharStyle:Code
16414 \begin_layout Plain Layout
16420 system call in a controlled manner.
16421 Of course, for use in a controlled environment, it can be tempting to just
16422 fall back to use ordinary shell scripts.
16423 If you do so, be aware that you
16427 provide an easily exploitable security hole in your system.
16428 Of course it stands to reason that such unsafe templates will never be
16429 included in the standard LyX distribution, although we do encourage people
16430 to submit new templates in the open source tradition.
16431 But LyX as shipped from the official distribution channels will never have
16435 \begin_layout Standard
16436 Including external material provides a lot of power, and you have to be
16437 careful not to introduce security hazards with this power.
16438 A subtle error in a single line in an innocent looking script can open
16439 the door to huge security problems.
16440 So if you do not fully understand the issues, we recommend that you consult
16441 a knowledgable security professional or the LyX development team if you
16442 have any questions about whether a given template is safe or not.
16443 And do this before you use it in an uncontrolled environment.
16446 \begin_layout Chapter
16450 \begin_layout Section
16454 \begin_layout Standard
16455 The LyX server is a method implemented in LyX that will enable other programs
16456 to talk to LyX, invoke LyX commands, and retrieve information about the
16457 LyX internal state.
16458 This is only intended for advanced users, but they should find it useful.
16459 Please note that, at present,
16461 the server does not work on Windows
16467 \begin_layout Plain Layout
16468 There is no principled reason it cannot do so.
16469 But none of the developers on Windows® have yet implemented this functionality
16478 \begin_layout Section
16479 Starting the LyX Server
16482 \begin_layout Standard
16483 The LyX server works through the use of a pair of named pipes.
16484 These are usually located in
16485 \begin_inset Flex CharStyle:Code
16488 \begin_layout Plain Layout
16495 \begin_inset Quotes eld
16499 \begin_inset Flex CharStyle:Code
16502 \begin_layout Plain Layout
16509 \begin_inset Quotes erd
16513 \begin_inset Quotes eld
16517 \begin_inset Flex CharStyle:Code
16520 \begin_layout Plain Layout
16527 \begin_inset Quotes erd
16531 External programs write into
16532 \begin_inset Flex CharStyle:Code
16535 \begin_layout Plain Layout
16541 and read back data from
16542 \begin_inset Flex CharStyle:Code
16545 \begin_layout Plain Layout
16552 The stem of the pipe names can be defined in the
16553 \begin_inset Flex CharStyle:MenuItem
16556 \begin_layout Plain Layout
16561 ools\SpecialChar \menuseparator
16571 dialog, for example
16572 \begin_inset Flex CharStyle:Code
16575 \begin_layout Plain Layout
16576 "/home/myhome/.lyxpipe"
16584 \begin_layout Standard
16586 \begin_inset Flex CharStyle:Code
16589 \begin_layout Plain Layout
16596 \begin_inset Flex CharStyle:Code
16599 \begin_layout Plain Layout
16605 ' to create the pipes.
16606 The above setting also has the effect of activating the LyX server.
16607 If one of the pipes already exists, LyX will assume that another LyX process
16608 is already running and will not start the server.
16609 To have several LyX processes with servers at the same time, you have to
16610 change the configuration between the start of the programs.
16613 \begin_layout Standard
16614 If you are developing a client program, you might find it useful to enable
16615 debugging information from the LyX server.
16616 Do this by starting LyX as lyx -dbg lyxserver.
16619 \begin_layout Standard
16620 Warning: if LyX crashes, it may not manage to remove the pipes; in this
16621 case you must remove them manually.
16622 If LyX starts and the pipes exist already, it will not start any server.
16625 \begin_layout Standard
16626 Other than this, there are a few points to consider:
16629 \begin_layout Itemize
16630 Both server and clients must run on UNIX or OS/2 machines.
16631 Communications between LyX on UNIX and clients on OS/2 or vice versa is
16632 not possible right now.
16635 \begin_layout Itemize
16636 On OS/2, only one client can connect to LyXServer at a time.
16639 \begin_layout Itemize
16640 On OS/2, clients must open inpipe with
16641 \begin_inset Flex CharStyle:Code
16644 \begin_layout Plain Layout
16653 \begin_layout Standard
16657 \begin_layout Standard
16658 You can find a complete example client written in C in the source distribution
16660 \begin_inset Flex CharStyle:Code
16663 \begin_layout Plain Layout
16664 development/lyxserver/server_monitor.c
16672 \begin_layout Section
16673 Normal communication
16676 \begin_layout Standard
16677 To issue a LyX call, the client writes a line of ASCII text into the input
16679 This line has the following format:
16682 \begin_layout Quote
16696 \begin_layout Description
16701 is a name that the client can choose arbitrarily.
16702 Its only use is that LyX will echo it if it sends an answer---so a client
16703 can dispatch results from different requesters.
16706 \begin_layout Description
16711 is the function you want LyX to perform.
16712 It is the same as the commands you'd use in the minibuffer.
16715 \begin_layout Description
16720 is an optional argument which is meaningful only to some functions (for
16722 \begin_inset Quotes eld
16726 \begin_inset Quotes erd
16729 which will insert the argument as text at the cursor position.)
16732 \begin_layout Standard
16733 The answer from LyX will arrive in the output pipe and be of the form
16736 \begin_layout Quote
16750 \begin_layout Standard
16759 are just echoed from the command request, while
16763 is more or less useful information filled according to how the command
16764 execution worked out.
16765 Some commands will return information about the internal state of LyX,
16767 \begin_inset Quotes eld
16771 \begin_inset Quotes erd
16774 , while other will return an empty data-response.
16775 This means that the command execution went fine.
16778 \begin_layout Standard
16779 In case of errors, the response from LyX will have this form
16782 \begin_layout Quote
16796 \begin_layout Standard
16801 should contain an explanation of why the command failed.
16804 \begin_layout Standard
16808 \begin_layout LyX-Code
16809 echo "LYXCMD:test:beginning-of-buffer:" >~/.lyxpipe.in
16812 \begin_layout LyX-Code
16813 echo "LYXCMD:test:get-xy:" >~/.lyxpipe.in
16814 \begin_inset Newline newline
16817 read a <~/.lyxpipe.out
16818 \begin_inset Newline newline
16824 \begin_layout Section
16828 \begin_layout Standard
16829 LyX can notify clients of events going on asynchronously.
16830 Currently it will only do this if the user binds a key sequence with the
16832 \begin_inset Quotes eld
16836 \begin_inset Quotes erd
16840 The format of the string LyX sends is as follows:
16843 \begin_layout Quote
16844 \begin_inset Flex CharStyle:Code
16847 \begin_layout Plain Layout
16858 \begin_layout Standard
16863 is the printed representation of the key sequence that was actually typed
16867 \begin_layout Standard
16868 This mechanism can be used to extend LyX's command set and implement macros:
16869 bind some key sequence to
16870 \begin_inset Quotes eld
16874 \begin_inset Quotes erd
16877 , start a client that listens on the out pipe, dispatches the command according
16878 to the sequence and starts a function that may use LyX calls and LyX requests
16879 to issue a command or a series of commands to LyX.
16882 \begin_layout Section
16883 The simple LyX Server Protocol
16886 \begin_layout Standard
16887 LyX implements a simple protocol that can be used for session management.
16888 All messages are of the form
16891 \begin_layout Quote
16901 \begin_layout Standard
16907 \begin_inset Quotes eld
16911 \begin_inset Quotes erd
16915 \begin_inset Quotes eld
16919 \begin_inset Quotes erd
16924 \begin_inset Quotes eld
16928 \begin_inset Quotes erd
16931 is received from a client, LyX will report back to inform the client that
16932 it's listening to it's messages, while
16933 \begin_inset Quotes eld
16937 \begin_inset Quotes erd
16940 sent from LyX will inform clients that LyX is closing.