1 #LyX 1.6.0svn created this file. For more info see http://www.lyx.org/
8 \IfFileExists{isolatin.def}
9 {\usepackage[isolatin]{inputenc}}
10 {\usepackage[latin1]{inputenc}}
13 \inputencoding default
16 \font_typewriter default
17 \font_default_family default
23 \paperfontsize default
31 \paperorientation portrait
34 \paragraph_separation indent
36 \quotes_language english
39 \paperpagestyle headings
40 \tracking_changes false
49 Customizing LyX: Features for the Advanced User
57 \begin_layout Standard
59 Principal maintainer of this file is
64 If you have comments or error corrections, please send them to the LyX
65 Documentation mailing list, <lyx-docs@lists.lyx.org>.
73 \begin_layout Standard
74 \begin_inset LatexCommand tableofcontents
85 \begin_layout Standard
86 This manual covers the customization features present in LyX.
87 In it, we discuss issues like keyboard shortcuts, screen previewing options,
88 printer options, sending commands to LyX via the LyX Server, internationalizati
89 on, installing new LaTeX classes and LyX layouts, etc.
90 We can't possibly hope to touch on everything you can change---our developers
91 add new features faster than we can document them---but we will explain
92 the most common customizations and hopefully point you in the right direction
93 for some of the more obscure ones.
97 LyX configuration files
100 \begin_layout Standard
101 \begin_inset LatexCommand label
106 This chapter aims to help you to find your way through the LyX configuration
108 Before continuing to read this chapter, you should find out where your
109 LyX library directory is by using
114 elp\SpecialChar \menuseparator
122 This directory is the place where LyX places its system-wide configuration
123 files, and we will simply name it
127 in the remainder of this document.
131 \begin_layout Section
139 \begin_layout Standard
144 and its sub-directories contain a number of files and that can be used
145 to customise LyX's behaviour.
146 You can change many of these files from within LyX itself through the
151 ools\SpecialChar \menuseparator
159 Most customization that you might want to do to LyX is possible through
161 However, many other inner aspects of LyX can be customized by modifying
167 They fall in different categories, described in the following subsections.
170 \begin_layout Subsection
171 Automatically generated files
174 \begin_layout Standard
175 These files are generated when you configure LyX.
176 They contain various default values that are guessed by inspection.
177 In general, it is not a good idea to modify them, since they might be overwritt
182 \labelwidthstring 00.00.0000
189 contains defaults for various commands.
193 \labelwidthstring 00.00.0000
200 contains the list of packages that have been recognized by LyX.
201 It is currently unused by the LyX program itself, but the information extracted
202 , and more, is made available with
207 elp\SpecialChar \menuseparator
219 \labelwidthstring 00.00.0000
226 is the list of text classes that have been found in your
230 directory, along with the associated LaTeX document class and their description.
234 \labelwidthstring 00.00.0000
239 is automatically generated during configuration from the file
246 \begin_layout Subsection
251 \labelwidthstring 00.00.0000
258 this directory contains files with the extension
262 that define the keybindings used in LyX (see section\InsetSpace ~
264 \begin_inset LatexCommand ref
265 reference "sec:bindings"
270 If there exists an internationalized version of the bind file named
274 , that will be used first.
275 See Chapter\InsetSpace ~
277 \begin_inset LatexCommand ref
278 reference "chap:i18n"
283 \begin_inset LatexCommand ref
284 reference "sec:bindings"
292 \labelwidthstring 00.00.0000
299 contains graphics files that can be included in documents.
304 \labelwidthstring 00.00.0000
311 contains LyX documentation files (including the one you are currently reading).
316 deserves special attention, as noted above.
317 If there exists an internationalized version of the help-document with
322 prepended to the name, that will be used first.
323 See Chapter\InsetSpace ~
325 \begin_inset LatexCommand ref
326 reference "chap:i18n"
334 \labelwidthstring 00.00.0000
341 contains example files that explain how to use some features.
342 In the file browser, press the
350 \labelwidthstring 00.00.0000
355 contains image files that are used by the
360 In addition, it also contains the individual icons used in the toolbar
361 and the banners that can be shown when LyX is launched.
365 \labelwidthstring 00.00.0000
372 contains keyboard keymapping files.
373 See Chapter\InsetSpace ~
375 \begin_inset LatexCommand ref
376 reference "sec:keymap"
384 \labelwidthstring 00.00.0000
391 contains the text class files described in Chapter\InsetSpace ~
393 \begin_inset LatexCommand ref
394 reference "chap:textclass"
402 \labelwidthstring 00.00.0000
407 contains some files that demonstrate the capabilities of the
409 External\InsetSpace ~
416 \labelwidthstring 00.00.0000
421 contains the standard LyX template files described in Chapter\InsetSpace ~
423 \begin_inset LatexCommand ref
424 reference "sec:templates"
432 \labelwidthstring 00.00.0000
437 contains some LaTeX cls files distributed with LyX.
441 \labelwidthstring 00.00.0000
446 contains files with the extension
450 that define the user interface to LyX.
451 That is, the files define which items appear in which menus and the items
452 appearing on the toolbar.
453 See Chapter\InsetSpace ~
455 \begin_inset LatexCommand ref
463 \begin_layout Subsection
464 Files you don't want to modify
467 \begin_layout Standard
468 These files are used internally by LyX and you generally do not need to
469 modify them unless you are a developer.
473 \labelwidthstring 00.00.0000
480 this file contains the list of LyX developers.
481 The contents are displayed with the menu entry
486 elp\SpecialChar \menuseparator
494 \labelwidthstring 00.00.0000
501 this is a LaTeX script used during the configuration process.
506 \labelwidthstring 00.00.0000
513 this is the script that is used to re-configure LyX.
514 It creates configuration files in the directory it was run from.
517 \begin_layout Subsection
518 Other files needing a line or two...
522 \labelwidthstring 00.00.0000
527 this contains tables describing how different character encodings can be
532 \labelwidthstring 00.00.0000
537 this file contains the templates available to the new
539 External\InsetSpace ~
546 \labelwidthstring 00.00.0000
551 this file contains a list of all the languages currently supported by LyX.
554 \begin_layout Section
555 Your local configuration directory
558 \begin_layout Standard
559 Even if you are using LyX as an unprivileged user, you might want to change
560 LyX configuration for your own use.
565 directory contains all your personal configuration files.
566 This is the directory described as
567 \begin_inset Quotes eld
571 \begin_inset Quotes erd
579 elp\SpecialChar \menuseparator
584 This directory is used as a mirror of
588 , which means that every file in
592 is a replacement for the corresponding file in
597 Any configuration file described in the above sections can be placed either
598 in the system-wide directory, in which case it will affect all users, or
599 in your local directory for your own use.
602 \begin_layout Standard
603 To make things clearer, let's provide a few examples:
606 \begin_layout Itemize
607 The preferences set in the
612 ools\SpecialChar \menuseparator
619 dialog are saved to a file
630 \begin_layout Itemize
631 When you reconfigure using
636 ools\SpecialChar \menuseparator
647 and the resulting files are written in your local configuration directory
648 (see section\InsetSpace ~
650 \begin_inset LatexCommand ref
651 reference "sec:autodetected"
655 to have a list of the
659 settings affected by this section).
660 This means that any additional text class file that you might have added
665 will be added to the list of classes in the
670 ayout\SpecialChar \menuseparator
680 \begin_layout Itemize
681 Similarly, if you have installed some LaTeX document classes in your home
682 directory, that LaTeX can find with your
686 path, they will show up in your list of text classes.
690 \begin_layout Standard
691 as long as LyX or yourself have a
695 file for it, of course.
703 \begin_layout Itemize
704 If you get some updated documentation from LyX ftp site and cannot install
705 it because you do not have sysadmin rights on your system, you can just
720 \begin_layout Section
721 Running LyX with multiple configurations
724 \begin_layout Standard
725 The configuration freedom of the local configuration directory may not suffice
726 if you want to have more than one configuration at your disposal.
727 For example, you may want to be use different key bindings or printer settings
729 You can achieve this by having several such directories.
730 You then specify which directory to use at run-time.
733 \begin_layout Standard
734 Invoking LyX with the command line switch
742 instructs the program to read the configuration from that directory, and
743 not from the default directory (you can determine the default directory
744 by running LyX without this switch as described above).
745 If this directory does not exist, LyX offers to create it for you, just
746 like it does for the default directory on the first time you run the program.
747 You can modify the configuration options in this additional
751 exactly as you would for the default directory.
752 These directories are completely independent (but read on).
753 Note that setting the environment variable
757 to some value has exactly the same effect
762 \begin_layout Standard
763 Having several configurations also requires more maintenance: if you want
764 to add a new layout to
768 which you want available from all your configurations, you must add it
769 to each directory separately.
770 You can avoid this with the following trick: after LyX creates the additional
771 directory, most of the subdirectories (see above) are empty.
772 If you want the new configuration to mirror an existing one, replace the
773 empty subdirectory with a symbolic link to the matching subdirectory in
774 the existing configuration.
781 subirectory, however, since it contains a file written by the configuration
782 script (also accessible through
787 ools\SpecialChar \menuseparator
793 \begin_inset LatexCommand ref
794 reference "sec:autodetected"
800 which is configuration-specific.
803 \begin_layout Chapter
814 \begin_layout Section
815 Using the dialog for the first time
818 \begin_layout Standard
823 file will contain only changes that you have made to the default behaviour,
824 some of which is hard-coded into LyX and some of which is contained in
827 LyXDir/lyxrc.defaults
830 Note that in both files lines beginning with a
831 \begin_inset Quotes eld
839 \begin_inset Quotes erd
842 are just comments and not interpreted.
843 However, only system administrators should edit
853 ools\SpecialChar \menuseparator
860 dialog to create and modify their own
867 \begin_layout Standard
873 ools\SpecialChar \menuseparator
880 dialog will be largely self-explanatory.
881 Almost all the commands have an associated comment, so you shouldn't have
882 too much trouble modifying it to taste.
883 Before we highlight a few of the more important commands below, however,
888 ing some of your changes (e.g., screen fonts) will have an instant effect.
890 changing the bind file) will not.
891 If nothing appears to have changed, just
895 the changes and restart LyX.
898 \begin_layout Section
902 \begin_layout Standard
903 The font used to display your documents on the LyX screen is very important,
904 since you'll be reading all your documents with this font.
905 Therefore it is important that the font is as readable and good-looking
907 The LyX team tried to provide the best possible default font for you, but
908 since practically all X11 systems are different, it's likely that the default
909 fonts will be sub-optimal on your system.
910 Fortunately, you can do something about this.
911 Before we explain how to do this, you should learn a bit more about fonts
912 so that you are better prepared for choosing your fonts, because it is
913 a trade-off that is specific to your preferences and the capabilities of
917 \begin_layout Standard
918 Notice that this section only deals with the fonts on the
922 inside the LyX window.
923 The fonts that appear on the
931 are independent from these fonts, and are determined by the document class.
936 to learn how to change the font of the printed version of your document.
939 \begin_layout Standard
940 Basically, screen fonts come in two different kinds: scalable outline fonts
941 and non-scalable bitmap fonts.
942 This distinction seems a bit arbitrary, since non-scalable fonts are actually
943 scalable in most modern font renderers.
944 The difference lies in the
948 of the scaling, and the
953 The most important decision is thus whether you should use non-scalable
954 bitmap fonts or scalable outline fonts.
957 \begin_layout Standard
958 The scalable fonts are built from
962 of the single glyphs (i.e.
963 characters) in the font.
964 This means that each glyph is defined using mathematical curves that are
965 well suited for scaling to any requested size.
966 This mathematical definition is interpreted by the font renderer and turned
967 into a small picture composed of pixels according to which size and glyph,
968 the programmer requests.
969 This means that scalable fonts will look pretty good in all sizes.
970 Well, almost all sizes.
971 Since scalable fonts are defined in an abstract way, it can be hard to
972 provide a good rendering at small sizes, where each pixel has to be very
973 carefully computed to provide a good image.
974 Technically it is possible to do this from the mathematical definition,
975 but in order to keep the rendering reasonably fast, tradeoffs have to be
976 made, and the result is that scalable fonts can be difficult to read at
980 \begin_layout Standard
981 Bitmap fonts on the other hand, are defined by bitmap graphics from the
982 start, so they will look good at all the sizes they are meant for.
983 However, they don't scale well, because in order to scale a glyph, each
984 pixel is enlarged into several pixels.
985 It is the same effect that happens if you try to enlarge a picture in
989 or any other picture manipulation program.
990 In order to relieve this effect, bitmap fonts are typically provided in
991 several fixed sizes typically from around 8 pixels high up to 34 pixels
992 or so high in steps according to what is believed to be useful.
993 The advantage of bitmap fonts is that no complicated computations are necessary
994 to display each glyph, so bitmap fonts are thus faster displayed than scalable
996 The disadvantage is that sizes that don't exists as fixed versions have
997 to be scaled by doubling pixels, and thus look bad.
1000 \begin_layout Standard
1001 The net result of all this, is that bitmap fonts are generally best for
1002 the small sizes, where they are available, while scalable fonts are generally
1003 best for large sizes.
1004 The logical conclusion would thus be to use bitmap fonts for the small
1005 sizes, and scalable fonts for the large sizes.
1006 Unfortunately, this is not a good idea, since bitmap fonts and scalable
1007 fonts are not designed to be used together, so the overall look of such
1008 a scheme would be bad.
1009 The best you can do is thus to try both schemes and decide for yourself
1013 \begin_layout Standard
1014 By default, LyX uses non-scalable bitmap fonts (when using the XForms frontend).
1019 is used, for sans serif fonts,
1027 is used as the monospaced/typewriter font.
1030 \begin_layout Standard
1031 In the following, we will describe what to do if the text does not look
1033 We'll start with the most important parameters: DPI and font zoom.
1036 \begin_layout Subsection
1037 DPI setting and Font Zoom
1040 \begin_layout Standard
1041 LyX automatically tries to scale the fonts to look as close as the paper
1042 output size as possible, except for the so-called font zoom factor.
1045 \begin_layout Standard
1046 In order for this to work on all systems, it relies on the screen DPI (dots
1047 per inch) setting to be correct.
1048 The DPI setting for your system is autodetected by LyX using the information
1049 the X server can provide.
1050 You can check what LyX autodetects the DPI setting to, by running LyX as
1058 \begin_layout Standard
1059 On many systems, X is not set up correctly, so you should check that it
1062 \begin_inset Quotes eld
1070 \begin_inset Quotes erd
1073 and write down what the DPI is for the resolution you use (this will be
1074 close to the value LyX detects).
1075 It is the number mentioned as
1076 \begin_inset Quotes eld
1080 \begin_inset Quotes erd
1084 Also write down the number of pixels you have in the width (the first number
1086 \begin_inset Quotes eld
1090 \begin_inset Quotes erd
1096 \begin_layout Standard
1097 Then get the good old ruler out of the closet, and measure the width of
1098 the visible screen-image on your monitor.
1099 Convert this measurement to inches if you used a centimeter ruler by dividing
1101 Now you can determine the correct DPI setting for your screen by dividing
1102 the number of pixels in the width by the width of the screen-image on the
1104 If this number is more than, say, 5 DPI from the detected value, you should
1105 either fix the X setup, or at least tell LyX that the DPI is different
1106 than the detected value.
1109 \begin_layout Standard
1110 If you can't fix the X setup (which of course is best since other programs
1111 than LyX will benefit from this as well), you can tell LyX the correct
1119 \begin_layout Standard
1120 If the text is too small or too big for your taste, you should fiddle with
1121 the font zoom setting.
1122 This setting is used to scale the point size of the text.
1123 If your DPI setting is correct, and the font zoom setting is set to 100,
1124 this means that LyX will try to display the text exactly the same size
1125 as it will appear on the paper-output.
1126 If you set the zoom factor to 200, the text will try to be 2 times as big
1128 Of course, this will only happen if LyX can find a font that has the appropriat
1129 e size, which you can't count on.
1130 Since LyX is a WYSIWYM system anyways, this limitation isn't much of an
1134 \begin_layout Standard
1135 The default font zoom setting is 150, since a monitor is typically wider
1136 than a piece of paper, but you should try to fiddle with it through the
1150 dialog to find a size that you like.
1151 When you've found a setting that seems to work nicely for you (tip: use
1159 button to keep the dialog open while you experiment), you can make this
1160 setting the default by using the
1170 \begin_layout Standard
1171 While it is often possible to find a suitable size for the text on the screen,
1172 this doesn't necessarily mean that the fonts are the best ones available
1174 In order to help you get the most out of your system, you can use the font
1175 definition commands to fine-tune the look of the text in greater detail
1179 \begin_layout Subsection
1180 Font definition commands
1183 \begin_layout Standard
1184 As mentioned, LyX uses non-scalable bitmap fonts by default with the XForms
1190 is used, for sans serif fonts,
1198 is used as the monospaced/typewriter font.
1201 \begin_layout Standard
1202 You can change all of these from within the
1207 The number of fonts that are available on different systems vary, but the
1212 should be available everywhere.
1213 Use that program to find candidate fonts.
1214 When you've found a font that you like, try to insert the first two elements
1216 \begin_inset Quotes eld
1220 \begin_inset Quotes erd
1224 \begin_inset Quotes eld
1228 \begin_inset Quotes erd
1235 ) in the appropriate field in the
1247 LyX will then reformat your document using the new font, and if you like
1248 the font, you should
1256 One place to start for a new font is to see if the scalable font
1257 \begin_inset Quotes eld
1261 \begin_inset Quotes erd
1265 Tip: You can see whether a font is a bitmap font or a scalable font by
1267 \begin_inset Quotes eld
1271 \begin_inset Quotes erd
1275 \begin_inset Quotes eld
1279 \begin_inset Quotes erd
1287 If the value 0 is available, the font is scalable.
1288 If the value 0 isn't available, the font is a bitmap font.
1291 \begin_layout Standard
1292 Before you go about scrapping a bitmap font because the larger sizes look
1294 \begin_inset Quotes eld
1298 \begin_inset Quotes erd
1301 , you should toggle the
1302 \begin_inset Quotes eld
1306 \begin_inset Quotes erd
1310 This is only useful if you use bitmap fonts, because only these don't scale
1312 If you define this flag, LyX will only use the fixed font sizes that are
1313 available, and this guarantees that all bitmap fonts look well.
1314 (You can see which individual font sizes are available with the
1323 .) However, the prize is that the difference between the size of the fonts
1324 on screen and the size of fonts on paper will be larger because LyX will
1325 have to be satisfied with the closest available size, and not try to scale
1327 Also, you can risk that some logically different sizes, such as
1335 , will be mapped to the same screen font, making it hard for you to see
1336 the difference on screen.
1337 We've decided not to use scalable fonts by default because of these artifacts,
1338 but since LyX is a WYSIWYM system, many people like to use the flag anyways,
1339 well-knowing that the font size on the screen can't be trusted.
1340 But remember that this flag only makes a difference when you use bitmap
1342 Scalable fonts won't be affected for reasons you should understand by now.
1345 \begin_layout Standard
1346 One final note regarding this flag: you should know that there is nothing
1347 wrong with using bitmap and scalable fonts at the same time for different
1349 For instance, it's common to use the scalable
1350 \begin_inset Quotes eld
1354 \begin_inset Quotes erd
1357 for the serif text together with a bitmap version of
1358 \begin_inset Quotes eld
1362 \begin_inset Quotes erd
1366 And you can safely select the
1367 \begin_inset Quotes eld
1371 \begin_inset Quotes erd
1374 button without worries: It will only apply to the Helvetica font.
1377 \begin_layout Standard
1378 Sometimes the artifacts introduced by use of the flag can be relieved by
1379 using the fine-detail screen font sizes which defines which point sizes
1380 the different logical font sizes correspond to.
1385 to see exactly what concrete fonts the logical sizes map to, and try adjusting
1386 the corresponding entries in the
1390 dialog until you've managed to hit the nail and get the fonts you want.
1391 This can be hard to do, because LyX uses the DPI setting and the font zoom
1392 settings to calculate which exact screen font size to ask the X server
1393 for, thus obfuscating the mapping.
1394 If you can't make it by trial-and-error, you can make the process more
1395 transparent if you set both the DPI setting and font zoom settings to 100---eve
1396 n when this is known to be wrong.
1397 This will of course make your scalable fonts look weird, so use with care.
1400 \begin_layout Subsection
1404 \begin_layout Standard
1405 By default, LyX will use fonts meant to write Western European text, including
1406 all kinds of English.
1407 This is defined through the so-called
1416 If you want to use LyX to write for instance Eastern European text, Cyrillic
1417 or any other language not covered by the ISO-8859-1 font encoding, you
1418 can define a different one with the encoding setting.
1419 This requires you to have special fonts installed.
1424 to see whether this is the case: check the
1425 \begin_inset Quotes eld
1429 \begin_inset Quotes erd
1433 \begin_inset Quotes eld
1437 \begin_inset Quotes erd
1440 fields for ISO-8859-X values different from ISO-8859-1, and search for
1441 one that contains the national characters of your language.
1442 If you find any, enter this encoding in the dialog.
1443 If not, go searching the Web for appropriate fonts.
1444 For the Qt frontend, it's recommended you use an iso646 font set.
1447 \begin_layout Standard
1448 When you've set LyX up to use a different font encoding, you should also
1449 consider changing the font used by dialog windows in LyX.
1456 dialog will not be understandable unless you tell LyX to use a different
1458 By default the menu font is set to
1460 -*-helvetica-medium-r
1462 , but often Helvetica is not available in the font encoding you need, so
1463 the dialog allows this to be changed.
1466 \begin_layout Standard
1467 As you can see, there are quite a few options that can be used to fine tune
1468 the look of your fonts.
1469 This should not scare you from fiddling with the settings, because after
1470 all, you will hopefully be using LyX for many hours in the future.
1471 And contrary to real WYSIWYG word processors where you are tied to using
1472 fonts that have to look good both on paper and on screen, LyX gives you
1473 the possibility of using fonts that are designed to look good on the screen
1474 while using a different set of fonts to look good on paper.
1477 \begin_layout Section
1479 \begin_inset LatexCommand label
1487 \begin_layout Standard
1488 Bindings are used to, well, bind a function to a key.
1489 Several prepackaged binding files are available: a CUA set of bindings
1490 (familiar as the typical set of PC and CDE set of keyboard shortcuts),
1491 an Emacs set of bindings, for those of us who follow the One True Way and
1492 refuse to lower our standards,
1496 \begin_layout Standard
1497 I'm kidding here, of course!
1502 as well as specialty bindings (broadway and hollywood) and other languages
1503 (French, German, etc.).
1506 \begin_layout Standard
1507 If, however, you'd like to customise the keybindings to your own exacting
1508 tastes, then copy the best-fit file in
1517 Don't forget to load this new file into LyX using the
1522 (For the moment you'll have to restart LyX for these changes to take effect.)
1525 \begin_layout Standard
1526 LyX supports internationalization of the user interface (see Chapter\InsetSpace ~
1528 \begin_inset LatexCommand ref
1529 reference "chap:i18n"
1538 is set, with the environment variable
1542 , LyX will try to use bindfiles by prepending
1547 For example, you can put a translated copy of some standard bind file in
1552 directory, and LyX will use it automatically.
1555 \begin_layout Standard
1560 files is straightforward:
1563 \begin_layout Standard
1568 bind <key combination> <lyx-function>
1571 \begin_layout Standard
1572 Both key combination and lyx-function (including any arguments) must be
1573 enclosed in "double quotes".
1574 All the LyX functions are listed in the
1581 \begin_layout Section
1583 \begin_inset LatexCommand label
1591 \begin_layout Standard
1592 The appearance of both the menu and toolbar may both be changed using the
1607 For the moment, only one file exists,
1611 , but feel free to experiment.
1612 Just copy the file to the
1616 directory and play! Note that, for the moment, you'll have to restart LyX
1617 for these changes to take effect.
1620 \begin_layout Standard
1625 files is straightforward: have a look at
1638 entries must be ended with an explicit
1663 s and in the case of the
1664 \begin_inset Quotes eld
1668 \begin_inset Quotes erd
1676 One small word of warning.
1681 s may be inserted in a
1689 , but they are defined as
1700 \begin_layout Section
1701 \begin_inset LatexCommand label
1702 name "sec:converters-etc"
1706 Converters, Formats, and Copiers
1709 \begin_layout Standard
1710 LyX has a powerful mechanism to convert to and from any file format using
1715 \begin_layout Subsection
1719 \begin_layout Standard
1720 The first step is to define your file formats, e.g.
1721 PDF, if they are not already defined.
1727 ools\SpecialChar \menuseparator
1732 references:Converters
1735 Enter a new format name; a new GUI name (used in, e.g., the View and Export
1736 menus); and a file extension.
1741 \begin_layout Standard
1742 There are also two flags that can be set using the checkboxes in the dialog.
1747 flag tells LyX that a format is suitable for document export.
1748 If this flag is set for a format, and if a suitable conversion route exists,
1749 then the format will appear in the
1754 ile\SpecialChar \menuseparator
1762 The format will also appear in the
1769 menu if it has a viewer associated with it.
1770 (See below.) Pure image formats (e.g.\InsetSpace ~
1775 ) should not have this flag set; formats that can both represent vector
1776 graphics and documents (e.g.\InsetSpace ~
1781 ) should have it set.
1784 \begin_layout Standard
1789 flag tells LyX whether a format can contain vector graphics.
1790 This information is used to determine the target format of included graphics
1796 Included graphics may need to be converted to either
1812 cannot handle other image formats.
1813 If an included graphic is not already in
1825 format, it is converted to
1833 flag of the format is set, and otherwise to
1840 \begin_layout Standard
1841 A Format can have a Viewer associated with it.
1842 For example, you might want to use
1846 to look at PostScript® files, or
1850 to preview the LaTeX output.
1851 You can enter the program to use as a viewer (and what options to pass
1852 to it) in the Viewer field.
1853 You can also modify the viewer associated with a pre-defined format simply
1854 by changing what you find in this field, clicking the
1858 button, and then (if you're sure you want to do this) clicking the
1870 \begin_layout Standard
1871 Changes to the formats are kept in the
1875 file in you local LyX directory (for example,
1880 If you want to restore the defaults, edit this file and delete the lines
1881 in the Formats and Converters sections.
1886 For example, to change the
1894 format in the dialog, change the viewer to be
1898 (or whatever), and hit
1908 \begin_layout Standard
1909 If the operating system has a default viewer associated to a format, this
1910 viewer is used instead of the one defined here in the Windows® and OS X
1912 (It is planned to implement this feature on other platforms.)
1915 \begin_layout Standard
1916 Editors are like viewers: Each Format can have an Editor associated to it,
1917 entered in the Editor field, and the editor associated with a format can
1923 ools\SpecialChar \menuseparator
1928 references:Converters
1931 LyX will launch the associated editor whenever an included file
1935 \begin_layout Standard
1936 This can be an included
1940 file, a verbatim included text file, external material or an included graphics
1949 \begin_layout Subsection
1953 \begin_layout Standard
1954 Each Format can have a Copier associated with it.
1955 These are defined in the
1960 ools\SpecialChar \menuseparator
1968 Since all conversions from one Format to another take place in LyX's temporary
1969 directory, it is sometimes necessary to modify a file before copying it
1970 to the temporary directory in order that the conversion may be performed.
1974 \begin_layout Standard
1975 For example, the file may refer to other files---images, for example---using
1976 relative filenames, and these may become invalid when the file is copied
1977 to the temporary directory.
1982 This is done by the Copier: It copies a file to (or from) the temporary
1983 directory and may modify it in the process.
1987 \begin_layout Standard
1988 Copiers may also be used for other purposes.
1989 For example, if appropriate converters are found, LyX will automatically
1990 install copiers for the html and wordhtml formats.
1991 When these formats are exported, the copier sees to it that not just the
1992 main HTML file but various associated files (style files, images, and the
1993 like) are also copied, and all these files are written to a subdirectory
1994 of the directory in which the original LyX file was found.
1995 The copier may of course be customized.
1996 The optional -e argument takes a comma-separated list of extensions to
1997 be copied; if it is omitted, all files will be copied.
1998 The -t argument determines the extension added to the generated directory.
2000 \begin_inset Quotes eld
2004 \begin_inset Quotes erd
2007 , so HTML generated from
2009 /path/to/filename.lyx
2013 /path/to/filename.html.LyXconv
2019 \begin_layout Standard
2020 The definitions of the copiers may use four variables:
2024 \labelwidthstring 00.00.0000
2025 $$s The LyX system directory (e.g.,
2033 \labelwidthstring 00.00.0000
2038 \labelwidthstring 00.00.0000
2043 \labelwidthstring 00.00.0000
2044 $$l The `LaTeX name'
2047 \begin_layout Standard
2048 The latter is to be given in a form suitable for inclusion in a LaTeX
2054 command and is relevant only when exporting files suitable for such inclusion.
2057 \begin_layout Subsection
2061 \begin_layout Standard
2062 To define a converter from one format to another---e.g., LaTeX to PDF---select
2063 the Converters panel.
2064 Choose the `From' and `To' formats, and then enter the program to be used
2065 in the conversion in the Converter field.
2069 \begin_layout Standard
2070 You do not have to define converters between all the Formats between which
2071 you want to convert.
2072 For example, you will note that there is no `LyX to PostScript®' converter,
2073 but LyX will export PostScript®.
2074 It does so by first creating a LaTeX file (no converter needs to be defined
2075 for this) which it then converts to DVI using the `LaTeX to DVI' converter,
2076 and then it converts the resulting DVI file to PostScript®.
2077 LyX finds such `chains' of converters automatically, and it will always
2078 choose the shortest chain possible.
2079 You can, though, still define multiple conversion methods between file
2081 For example, the standard LyX configuration provides three ways to convert
2082 LaTeX to PDF: Directly, using pdflatex; via (DVI and) PostScript®, using
2083 ps2pdf; or via DVI, using dvipdfm.
2084 To define such alternate chains, you must define multiple target `file
2086 In the standard configuration, for example, formats named `pdf', `pdf2',
2087 and `pdf3' are defined, all of which share the extension `pdf'.
2091 \begin_layout Standard
2092 Several variables can be used in the definition of converters:
2096 \labelwidthstring 00.00.0000
2097 $$s The LyX system directory (e.g.,
2105 \labelwidthstring 00.00.0000
2110 \labelwidthstring 00.00.0000
2115 \labelwidthstring 00.00.0000
2116 $$b The base filename of the input file
2120 \labelwidthstring 00.00.0000
2121 $$p The path to the input file
2124 \begin_layout Standard
2125 In the `Extra Flag' field you can enter as many of the following flags as
2126 you wish, separated by commas:
2130 \labelwidthstring 00.00.0000
2131 latex This converter runs some form of LaTeX.
2132 (This will make LyX's LaTeX error logs available.)
2136 \labelwidthstring 00.00.0000
2137 needaux Needs the LaTeX .aux file for the conversion.
2141 \labelwidthstring 00.00.0000
2145 \begin_layout Standard
2146 The following three variables are not really flags at all but take an argument
2156 \labelwidthstring 00.00.0000
2157 parselog If set, the converter's standard error will be redirected to a
2162 , and the script given as argument will be run as:
2164 script <infile.out >infile.log
2167 The argument may contain $$s.
2171 \labelwidthstring 00.00.0000
2172 resultdir The name of the directory in which the
2176 will dump the generated files.
2177 LyX will not create this directory, and it does not copy anything into
2178 it, though it will copy this directory to the destination.
2179 The argument may contain $$b, which will be replaced by the basename of
2180 the input and output files, respectively, when the directory is copied.
2183 that resultdir and usetempdir make no sense together.
2184 The latter will be ignored if the former is given.
2188 \labelwidthstring 00.00.0000
2189 resultfile Determines the output filename and may, again, contain $$b.
2190 Sensible only with resultdir, and optional even then; if not given, it
2191 defaults to `index'.
2195 \begin_layout Standard
2196 None of these last three are presently used in any of the converters that
2197 are installed with LyX.
2199 \begin_inset LatexCommand ref
2200 reference "sub:LyX-and-Literate"
2204 of the Extended Features guide for some examples of how you might use parselog.
2207 \begin_layout Section
2208 BibTeX and makeindex
2211 \begin_layout Standard
2212 Both the bibliography generating command (default
2216 ) and the index generating command (default
2229 As an alternative for
2241 \begin_layout Standard
2242 The command to enter is
2248 makeindex.sh -m $$lang
2251 \begin_layout Standard
2252 where the placeholder
2256 will be replaced by the chosen document (babel) language.
2260 \begin_layout Standard
2261 have installed the packages
2278 at a shell prompt for a help page.
2281 \begin_layout Section
2282 Plain text export options
2285 \begin_layout Standard
2286 \begin_inset VSpace bigskip
2292 \begin_layout Standard
2294 There are a couple of commands that can be used to
2295 \begin_inset Quotes eld
2299 \begin_inset Quotes erd
2302 exported plain text files.
2303 Note that LyX automatically detects and uses the best settings for your
2304 system at installation time, but you can modify them if you disagree with
2308 \begin_layout Description
2312 Plain text\InsetSpace ~
2316 This option defines the command used to produce better plain text tables
2321 UNIX-commands (refer to their manpages for more information about them).
2322 Setting this as empty tells LyX to use the internal (inferior) formatter.
2325 \begin_layout Description
2329 Plain text\InsetSpace ~
2334 With this command you can set the default line length of the plain text
2336 Setting it to 0 means endless lines.
2339 \begin_layout Section
2343 \begin_layout Standard
2344 There are a bunch of configuration options that are used for interaction
2345 with the external print command from LyX.
2346 Normally the defaults are fine: if, however, your print command takes different
2347 option names, you can modify them here.
2350 \begin_layout Subsection
2354 \begin_layout Standard
2355 You can change the colors used by LyX on-screen using the new
2360 Alternatively, if you're feeling particularly perverse you could use the
2365 bindable function (see the
2370 Input would have the format:
2373 \begin_layout Standard
2376 set-color LyXName X11Color
2379 \begin_layout Standard
2380 Here is a (partial) list of the functions and default colors:
2383 \begin_layout Standard
2385 \begin_inset Tabular
2386 <lyxtabular version="3" rows="10" columns="3">
2388 <column alignment="left" valignment="top" leftline="true" width="0pt">
2389 <column alignment="left" valignment="top" leftline="true" width="0pt">
2390 <column alignment="center" valignment="top" leftline="true" rightline="true" width="0pt">
2391 <row topline="true" bottomline="true">
2392 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
2395 \begin_layout Standard
2410 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
2413 \begin_layout Standard
2428 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
2431 \begin_layout Standard
2447 <row topline="true">
2448 <cell alignment="left" valignment="top" topline="true" leftline="true" usebox="none">
2451 \begin_layout Standard
2466 <cell alignment="left" valignment="top" topline="true" leftline="true" usebox="none">
2469 \begin_layout Standard
2484 <cell alignment="left" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
2487 \begin_layout Standard
2503 <row topline="true">
2504 <cell alignment="left" valignment="top" topline="true" leftline="true" usebox="none">
2507 \begin_layout Standard
2522 <cell alignment="left" valignment="top" topline="true" leftline="true" usebox="none">
2525 \begin_layout Standard
2540 <cell alignment="left" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
2543 \begin_layout Standard
2559 <row topline="true">
2560 <cell alignment="left" valignment="top" topline="true" leftline="true" usebox="none">
2563 \begin_layout Standard
2578 <cell alignment="left" valignment="top" topline="true" leftline="true" usebox="none">
2581 \begin_layout Standard
2596 <cell alignment="left" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
2599 \begin_layout Standard
2615 <row topline="true">
2616 <cell alignment="left" valignment="top" topline="true" leftline="true" usebox="none">
2619 \begin_layout Standard
2634 <cell alignment="left" valignment="top" topline="true" leftline="true" usebox="none">
2637 \begin_layout Standard
2652 <cell alignment="left" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
2655 \begin_layout Standard
2671 <row topline="true">
2672 <cell alignment="left" valignment="top" topline="true" leftline="true" usebox="none">
2675 \begin_layout Standard
2690 <cell alignment="left" valignment="top" topline="true" leftline="true" usebox="none">
2693 \begin_layout Standard
2703 fraction Lines, brackets, etc.
2708 <cell alignment="left" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
2711 \begin_layout Standard
2727 <row topline="true">
2728 <cell alignment="left" valignment="top" topline="true" leftline="true" usebox="none">
2731 \begin_layout Standard
2746 <cell alignment="left" valignment="top" topline="true" leftline="true" usebox="none">
2749 \begin_layout Standard
2755 <cell alignment="left" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
2758 \begin_layout Standard
2774 <row topline="true">
2775 <cell alignment="left" valignment="top" topline="true" leftline="true" usebox="none">
2778 \begin_layout Standard
2793 <cell alignment="left" valignment="top" topline="true" leftline="true" usebox="none">
2796 \begin_layout Standard
2802 <cell alignment="left" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
2805 \begin_layout Standard
2821 <row topline="true">
2822 <cell alignment="left" valignment="top" topline="true" leftline="true" usebox="none">
2825 \begin_layout Standard
2840 <cell alignment="left" valignment="top" topline="true" leftline="true" usebox="none">
2843 \begin_layout Standard
2849 <cell alignment="left" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
2852 \begin_layout Standard
2868 <row topline="true" bottomline="true">
2869 <cell alignment="left" valignment="top" topline="true" leftline="true" usebox="none">
2872 \begin_layout Standard
2887 <cell alignment="left" valignment="top" topline="true" leftline="true" usebox="none">
2890 \begin_layout Standard
2900 selection background
2905 <cell alignment="left" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
2908 \begin_layout Standard
2931 \begin_layout Section
2932 The autodetected settings
2935 \begin_layout Standard
2936 \begin_inset LatexCommand label
2937 name "sec:autodetected"
2941 There are several items that are detected for you when you run
2948 \SpecialChar \menuseparator
2954 In this section, we list those which pertain to the user preferences.
2957 \begin_layout Description
2963 plaintext_roff_command
2978 , depending on what is available.
2981 \begin_layout Description
2994 plus a bunch of options.
2997 \begin_layout Description
3010 on systems (so-called System V) who have this command, and
3014 otherwise (BSD systems).
3017 \begin_layout Description
3023 print_spool_printerprefix
3034 , depending on whether
3045 \begin_layout Description
3062 fonts are found and LaTeX has support for these fonts built-in.
3063 You can set it manually if you only have the so-called
3070 \begin_layout Section
3074 \begin_layout Standard
3075 There are many other configuration options that can be used to customize
3077 We still need to document them here, but again, most should be fairly obvious.
3078 Please ask on the mailing lists if you need some more information; it may
3079 even prompt us to expand this section.
3082 \begin_layout Chapter
3083 Internationalizing LyX
3084 \begin_inset LatexCommand label
3092 \begin_layout Standard
3093 LyX supports using a translated interface.
3094 Last time we checked, LyX provided text in 14 languages together with the
3095 default English text.
3096 The language of choice is called your
3101 (For further reading on locale settings, see also the documentation for
3102 locale that comes with your operating system.
3103 For Linux, the manual page for locale(5) could be a good place to start).
3106 \begin_layout Standard
3107 Notice that these translations will work, but do contain a few flaws.
3108 In particular, all dialogs have been designed with the English text in
3109 mind, which means that some of the translated text will be too large to
3110 fit within the space allocated.
3111 This is only a display problem and will not cause any harm.
3112 Also, you will find that some of the translations do not define short-cut
3113 keys for everything.
3114 Sometimes, there are simply not enough free letters to do it.
3115 Other times, the translator just hasn't got around to doing it yet.
3116 Our localization team -- which you may wish to join -- will try to fix
3117 these shortcomings in future versions of LyX.
3120 \begin_layout Section
3121 Selecting an alternative language for the user interface
3124 \begin_layout Standard
3125 This feature is disabled by default, meaning that system default language
3127 To enable an alternative language, you have to set an appropriate environment
3135 for csh class shells
3150 with the two letter code (or four letter code, like
3154 for British English) for the language you want.
3160 Besides the user interface texts being translated, also the appropriate
3161 manuals will be presented under the Help menu -- if available.
3164 \begin_layout Standard
3165 On some systems, you may have to redefine
3177 , to override the system settings; their preference is in this order
3181 \begin_layout Standard
3182 The shell variable LANGUAGE has been disabled in LyX for technical reasons.
3188 , which corresponds to the way GNU
3193 Consult your system documentation.
3194 Normally, you'll want to put the appropriate line in a shell script run
3195 on start-up, so that the translation is on by default.
3196 Remember that this affects
3200 localized packages, not only LyX!
3203 \begin_layout Standard
3204 If LyX is configured and compiled with
3205 \begin_inset Quotes eld
3213 \begin_inset Quotes erd
3216 , this mechanism will not work.
3219 \begin_layout Section
3223 \begin_layout Subsection
3224 Translating the graphical user interface (text messages).
3227 \begin_layout Standard
3232 library to handle the internationalization of the interface.
3233 To have LyX speak your favorite language in all menus and dialogs, you
3238 -file for that language.
3239 When this is available, you'll have to generate a mo-file from it and install
3245 The process of doing all of this is explained in the documentation for
3250 , but in short, this is what you do (
3254 denotes the language code):
3257 \begin_layout Standard
3261 \begin_layout Standard
3273 \begin_layout Itemize
3276 LYX-SOURCE-DIR/po/lyx.pot
3289 doesn't exist, it can be remade with
3293 in that directory, or you can use an existing po-file for some other language
3297 \begin_layout Itemize
3304 \begin_layout Standard
3305 We recommend that you use Emacs to do this, since the
3309 distribution includes a nice mode that supports you in doing this.
3317 For some menu- and widget-labels, there are also shortcut keys that should
3319 Those keys are marked after a `|', and should be translated according to
3320 the words and phrases of the
3325 There is a tool named
3329 written in Prolog in
3331 LYX-SOURCE-DIR/development/tools/
3333 that may be useful to help determine short-cut keys.
3334 Note that XForms (version 0.86 at least) can't handle anything but 7-bit
3335 characters as shortcut keys.
3336 You should also fill also out the information at the beginning of the new
3341 -file with your email-address, etc., so people know where to reach you with
3342 suggestions and entertaining flames.
3345 \begin_layout Itemize
3354 This can be done with
3375 \begin_layout Itemize
3380 -file to your locale-tree, at the correct directory for application messages
3385 , and under the name
3394 /usr/local/share/locale/
3405 \begin_layout Standard
3409 \begin_layout Standard
3421 \begin_layout Standard
3422 Adding a new po-file to the
3426 of LyX involves altering the configure scripts and more, but the way
3430 works, you don't actually need the source-code of LyX to translate it---having
3446 \begin_layout Standard
3447 If you've written a translation file for a language that LyX does not currently
3448 support, feel free to submit it for inclusion by sending a patch.
3449 In this case, we recommend that you read the
3457 directory for more instructions.
3460 \begin_layout Subsubsection
3464 \begin_layout Standard
3465 Sometimes it turns out that one english message needs to be translated into
3466 different messages in the target language.
3467 One example is the message
3471 which has the german translation
3488 does not handle such ambigous translations.
3489 Therefore you have to add some context information to the message: Instead
3496 To[[as in 'From format x to format y']]
3500 To[[as in 'From page x to page y']].
3503 Now the two occurences of
3511 and can be translated correctly to
3526 \begin_layout Standard
3527 Of course the context information needs to be stripped off the original
3528 message when no translation is used.
3529 Therefore you have to put it in double square brackets at the end of the
3530 message (see the example above).
3531 The translation mechanism of LyX ensures that everything in double square
3532 brackets at the end of messages is removed before displaying the message.
3535 \begin_layout Subsection
3536 Translating the documentation.
3539 \begin_layout Standard
3540 The online documentation (in the
3547 -menu) can (and should!) be translated.
3548 If there are translated versions of the documentation available
3552 \begin_layout Standard
3553 As of February 2003, almost all of the docs have been translated into German
3559 has been translated into at least 12 other languages, with other translations
3561 The library of translated documents is growing rapidly.
3566 , and the locale is set accordingly, these will be used automagically by
3568 LyX looks for translated versions as
3582 denotes the language as set by the environmental variable
3587 If there are none, the default English versions will be displayed.
3588 Note that the translated versions must have the same filenames (
3592 above) as the original.
3593 If you feel up to translating the documentation (an excellent way to proof-read
3594 the original documentation BTW!), there are a few things you should do
3598 \begin_layout Itemize
3603 , the guide to writing LyX documentation.
3604 Pay special attention to the translator's section.
3607 \begin_layout Itemize
3608 Check out the documentation translation web page at
3609 \begin_inset LatexCommand url
3610 name "The LyX Developer's Web Site"
3611 target "http://www.devel.lyx.org"
3616 That way, you can find out which (if any) documents have already been translate
3617 d into your language.
3618 You can also find out who (if anyone) is organizing the effort to translate
3619 the documentation into your language.
3620 If no one is organizing the effort, please let us know that you're interested.
3623 \begin_layout Standard
3624 Once you get to actually translating, here's a few hints for you that may
3628 \begin_layout Itemize
3629 Join the documentation team! There is information on how to do that in
3638 elp\SpecialChar \menuseparator
3645 ), which by the way is the first document you should translate.
3648 \begin_layout Itemize
3649 Learn the typographic conventions for the language you are translating to.
3650 Typography is an ancient art and over the centuries, a great variety of
3651 conventions have developed throughout different parts of the world.
3652 Also study the professional terminology amongst typographers in your country.
3653 Inventing your own terminology will only confuse the users.
3656 (Warning! Typography is addictive!)
3659 \begin_layout Itemize
3660 Make a copy of the document.
3661 This will be your working copy.
3662 You can use this as your personal translated help-file by placing it in
3670 \begin_layout Itemize
3671 Sometimes the original document (from the LyX-team) will be updated.
3672 Use the ViewCVS tool available at
3673 \begin_inset LatexCommand htmlurl
3674 target "http://www.lyx.org/viewcvs.cgi/lyxdoc/"
3678 to see what has been changed
3682 \begin_layout Standard
3683 Alternatively, you can keep a copy of the latest version of the English
3684 document which you've translated.
3690 That way you can easily see which parts of the translated document need
3694 \begin_layout Itemize
3695 If you ever find an error in the original document, fix it and notify the
3696 rest of the documentation team of the changes! (You didn't forget to join
3697 the documentation team did you?)
3700 \begin_layout Section
3701 International Keyboard Support
3704 \begin_layout Standard
3707 [Editor's Note: The following section is by
3715 It needs to be fixed to conform to the new Documentation Style sheet and
3716 to make use of the new v1.0 features.
3717 The whole thing also needs to be merged with the section following it.-jw]
3720 \begin_layout Subsection
3721 Defining Own Keymaps: Keymap File Format
3724 \begin_layout Standard
3725 Let's look at a keyboard definition file a little closer.
3726 It is a plain text file defining
3729 \begin_layout Itemize
3730 key-to-key or key-to-string translations
3733 \begin_layout Itemize
3737 \begin_layout Itemize
3738 dead keys exceptions
3741 \begin_layout Standard
3742 To define key-to-key or key-to-string translation, use this command:
3745 \begin_layout Quotation
3761 \begin_layout Standard
3766 is the key to be translated and
3770 is the string to be inserted into the document.
3771 To define dead keys, use:
3774 \begin_layout Quotation
3790 \begin_layout Standard
3800 The following dead keys are supported (shortcut name is in parentheses):
3803 \begin_layout Quotation
3811 \begin_layout Quotation
3817 \begin_layout Quotation
3823 \begin_layout Quotation
3829 \begin_layout Quotation
3835 \begin_layout Quotation
3842 \begin_layout Standard
3854 \begin_layout Quotation
3860 \begin_layout Quotation
3867 \begin_layout Standard
3879 \begin_layout Quotation
3885 \begin_layout Quotation
3891 \begin_layout Quotation
3898 \begin_layout Standard
3910 \begin_layout Quotation
3917 \begin_layout Standard
3929 \begin_layout Quotation
3935 \begin_layout Quotation
3936 hungarian umlaut (hug)
3941 \begin_layout Quotation
3947 \begin_layout Quotation
3954 \begin_layout Standard
3966 \begin_layout Standard
3967 Since in many international keyboards there are exceptions to what some
3968 dead keys should do, you can define them using
3971 \begin_layout Quotation
3980 deadkey key outstring
3983 \begin_layout Standard
3984 For example, on Slovak keyboard, if you enter caron-o, it generates circumflex-o
3988 \begin_layout Quotation
4002 \begin_layout Standard
4003 to make it work correctly.
4004 Also, you have to define as exceptions dead keys over i and j, to remove
4005 the dot from them before inserting an accent mark.
4006 I will change this when the time comes, but so far I haven't had time.
4009 \begin_layout Standard
4010 Oh, and about characters: backslash is escaped, so to enter it, you'll need
4016 have different meaning.
4021 marks comments, quotes start and end LaTeX-style commands.
4022 To enter quote, you'll need to use
4041 \begin_layout Standard
4042 If you make a keyboard description file that works for your language, please
4043 mail it to me, so I can include it in the next keymap distribution.
4046 \begin_layout Standard
4047 More keywords will be supported in keymap configuration file in future,
4051 \begin_layout Itemize
4069 \begin_layout Itemize
4084 an external keymap translation program
4087 \begin_layout Standard
4088 Also, it should look into
4092 file for defaults, too (for example, a
4098 option to include default keyboard).
4101 \begin_layout Section
4102 International Keymap Stuff
4103 \begin_inset LatexCommand label
4111 \begin_layout Standard
4112 The next two sections describe the
4124 file syntax in detail.
4125 These sections should help you design your own key map if the ones provided
4126 do not meet your needs.
4129 \begin_layout Subsection
4133 \begin_layout Standard
4142 file maps keystrokes to characters or strings.
4143 As the name suggests it sets a keyboard mapping.
4168 are described in this section.
4172 \labelwidthstring 00.00.0000
4179 Map a character to a string
4182 \begin_layout LyX-Code
4197 \begin_layout Standard
4230 the double-quote (")
4247 must be escaped with a preceding backslash (
4258 \begin_layout Standard
4265 statement to cause the symbol
4271 to be output for the keystroke
4280 \begin_layout LyX-Code
4287 \labelwidthstring 00.00.0000
4294 Specify an accent character
4297 \begin_layout LyX-Code
4306 \begin_layout Standard
4307 This will make the cha
4345 This is the dead key
4349 \begin_layout Standard
4356 refers to a key that does not produce a character by itself, but when followed
4357 with another key, produces the desired accent character.
4358 For example, a German characte
4360 r with an umlaut like
4370 can be produced in this manner.
4379 \begin_layout Standard
4392 and then another key not in
4409 followed by the other, unallowed key, as output.
4418 cancels a dead key, so if
4435 , the cursor will not go one position backwards but will instead cancel
4452 might have had on the next keystroke.
4456 \begin_layout Standard
4457 The following example specifies that the character ' is to be an acute accent,
4458 allowed on the characters a, e, i, o, u, A, E, I, O, and U:
4461 \begin_layout LyX-Code
4464 kmod ' acute aeiouAEIOU
4468 \labelwidthstring 00.00.0000
4473 Specify an exception to the accent character
4476 \begin_layout LyX-Code
4485 \begin_layout Standard
4486 This defines an exce
4527 have been assigned a keystroke with a previous
4550 must not belong in the
4602 If such a declaration does not exist in
4658 \begin_layout Standard
4659 The following command produces causes äi to be produced when you enter acute-i
4663 \begin_layout LyX-Code
4678 \labelwidthstring 00.00.0000
4683 Combine two accent characters
4686 \begin_layout LyX-Code
4692 accent1 accent2 allowed
4695 \begin_layout Standard
4696 This one is getting pretty esoteric.
4697 It allows you to combine the effect
4778 \begin_layout Standard
4779 Consider this example from the
4788 \begin_layout LyX-Code
4791 kmod ; acute aeioyvhAEIOYVH
4795 kcomb acute umlaut iyIY
4798 \begin_layout Standard
4799 This allows you to press
4805 and get the effect of
4822 in this case cancels the last dead key, so if you press
4839 \begin_layout Subsection
4843 \begin_layout Standard
4850 mapping is performed, a
4857 file maps the strings that the symbols generate to characters in the current
4859 The LyX distribution currently includes at least the
4874 \begin_layout Standard
4881 file is a sequence of declarations of the form
4884 \begin_layout LyX-Code
4897 \begin_layout Standard
4898 For example, in order to map
4906 to the corresponding character in the iso-8859-1 set (233), the following
4910 \begin_layout LyX-Code
4918 \begin_layout Standard
4941 the same character can apply to more than one string.
4952 \begin_layout LyX-Code
4978 \begin_layout Standard
4979 If LyX cannot find a mapping for the string produced by the keystroke or
4980 a deadkey sequence, it will check if it looks like an accented char and
4981 try to draw an accent over the character on screen.
4984 \begin_layout Subsection
4988 \begin_layout Standard
4989 There is a second way to add support for international characters through
4990 so-called dead-keys.
4991 A dead-key works in combination with a letter to produce an accented character.
4992 Here, we'll explain how to create a really simple dead-key to illustrate
4996 \begin_layout Standard
4997 Suppose you happen to need the circumflex character,
4998 \begin_inset Quotes eld
5002 \begin_inset Quotes erd
5010 -key [a.k.a.\InsetSpace ~
5015 ] to the LyX command
5024 Now, whenever you type the
5028 -key followed by a letter, that letter will have a circumflex accent on
5030 For example, the sequence
5031 \begin_inset Quotes eld
5039 \begin_inset Quotes erd
5042 produces the letter:
5043 \begin_inset Quotes eld
5047 \begin_inset Quotes erd
5051 If you tried to type
5052 \begin_inset Quotes eld
5060 \begin_inset Quotes erd
5063 , however, LyX will complain with a beep, since a
5064 \begin_inset Quotes eld
5072 \begin_inset Quotes erd
5075 never takes a circumflex accent.
5080 after a dead-key produces the bare-accent.
5081 Please note this last point! If you bind a key to a dead-key, you'll need
5082 to rebind the character on that key to yet another key.
5087 to a cedilla is a bad idea, since you'll only get cedillas instead of commas.
5090 \begin_layout Standard
5091 One common way to bind dead-keys is to use
5103 in combination with an accent, like
5104 \begin_inset Quotes eld
5112 \begin_inset Quotes erd
5116 \begin_inset Quotes eld
5124 \begin_inset Quotes erd
5128 \begin_inset Quotes eld
5136 \begin_inset Quotes erd
5140 Another way involves using
5148 [remember them from section?] to set up the special
5157 acts in some ways just like
5161 and permits you to bind keys to accented characters.
5162 You can also turn keys into dead-keys by binding them to something like
5167 and then binding this symbolic key to the corresponding LyX command.
5171 \begin_layout Standard
5176 : This is exactly what I do in my
5194 and a bunch of these
5195 \begin_inset Quotes eld
5203 \begin_inset Quotes erd
5206 symbolic keys bound such things as
5217 This is how I produce my accented characters.
5222 You can make just about anything into the
5230 keys, a spare function key, etc.
5231 As for the LyX commands that produce accents, check the entry for
5240 You'll find the complete list there.
5243 \begin_layout Subsection
5244 Saving your Language Configuration
5247 \begin_layout Standard
5248 \begin_inset LatexCommand label
5253 You can edit your preferences so that your desired language environment
5254 is automatically configured when LyX starts up, via the
5259 dit\SpecialChar \menuseparator
5269 \begin_layout Chapter
5270 Installing New Document Classes, Layouts, and Templates
5271 \begin_inset LatexCommand label
5272 name "chap:textclass"
5280 \begin_layout Standard
5281 Installing New Document Classes
5289 \begin_layout Standard
5290 In this chapter, we describe the procedures for creating and installing
5291 new LyX layout and template files, as well as offer a refresher on correctly
5292 installing new LaTeX document classes.
5293 Some definitions: a document class is a LaTeX file (usually ending in
5301 ) which describes the format of a document such as an article, report, journal
5303 and all the commands needed to realize that format.
5304 A layout file is a LyX file which corresponds to a LaTeX document class
5305 and which tells LyX how to
5306 \begin_inset Quotes eld
5310 \begin_inset Quotes erd
5313 things on the screen to make the display look something like the final
5315 More precisely, a layout file describes a
5316 \begin_inset Quotes eld
5320 \begin_inset Quotes erd
5323 which is the internal construct LyX uses to render the screen display.
5325 \begin_inset Quotes eld
5329 \begin_inset Quotes erd
5333 \begin_inset Quotes eld
5337 \begin_inset Quotes erd
5340 can be used somewhat interchangeably, but it is better to refer to the
5341 file as the layout, and the thing living in LyX's memory as the text class.
5342 A template file is simply a LyX document which contains a set of predefined
5343 entries for a given document class which are generally required for that
5345 Templates are especially useful for things like journal manuscripts which
5346 are to be submitted electronically.
5349 \begin_layout Section
5350 Installing a new LaTeX package
5353 \begin_layout Standard
5354 Some installations may not include a LaTeX package that you would like to
5356 For example, you might need FoilTeX, a common (and very powerful) package
5357 for preparing slides or viewgraphs for overhead projectors.
5358 Here are the formal steps involved in getting the package up and running
5359 if you are using teTeX or some other web2c based distribution.
5363 \begin_layout Enumerate
5364 Get the package from CTAN or wherever.
5368 \begin_layout Standard
5371 Inventory of your LaTeX configuration
5373 manual for details of what CTAN is and where supported document classes
5382 \begin_layout Enumerate
5387 (this usually lives in the directory
5391 , though you can run
5396 It describes how to add a local
5400 directory; follow the instructions.
5401 You need to insert the name of your local
5414 is a logical place to install software that did not come with your distribution
5420 Usually, you will have to modify only two things:
5424 \begin_layout Enumerate
5429 to the directory you chose; e.g.
5434 TEXMFLOCAL = /usr/local/texmf
5437 \begin_layout Enumerate
5451 TEXMF = {$HOMETEXMF,!!$TEXMFLOCAL,!!$TEXMFMAIN}
5455 \begin_layout Enumerate
5466 You must follow the directory structure of your existing
5470 directory (for example, latex packages should go under
5472 /usr/local/texmf/tex/latex/
5477 \begin_layout Enumerate
5478 Install the package.
5479 For example, you would unpack the FoilTeX tarball and create
5481 /usr/local/texmf/tex/latex/foiltex
5488 directory contains various files.
5491 \begin_layout Enumerate
5499 /usr/local/texmf/ls-R
5504 \begin_layout Enumerate
5505 From within LyX, do:
5510 ools\SpecialChar \menuseparator
5521 \begin_layout Standard
5522 Now you should see your new package---for example
5531 ayout\SpecialChar \menuseparator
5546 Note that there are simpler ways of installing packages: you can add a
5547 link to the new package directory in the system LaTeX directory (
5551 , don't forget to then run
5555 ), or sometimes simply set the
5559 environment variable to include the new package.
5560 However, the formal procedure described in
5564 is guaranteed to work, so you should follow it unless circumstances absolutely
5565 prevent it: such as, when you don't have superuser access.
5568 \begin_layout Section
5572 \begin_layout Standard
5573 This section describes how to write and install your own LyX layout files
5574 (also known as text classes) and walks through the
5578 text class format as an example.
5583 files describe what paragraph styles are available for a given document
5584 class and how LyX should display them.
5585 We try to provide a thorough description of the process here; however,
5586 there are so many different types of documents supported by LaTeX classes
5587 we can't hope to cover every different possibility or problem you might
5592 \begin_layout Standard
5593 When you plan to write a new layout, it is extremely helpful to look at
5594 the example layouts distributed with LyX.
5595 If you use a nice LaTeX document class that might be of interest for others,
5596 too, and have a nice corresponding LyX layout, feel free to contribute
5597 the stuff to us, so we may put it into the distribution.
5600 \begin_layout Standard
5601 All the tags described in this chapter are case-insensitive; this means
5614 are really the same command.
5615 The possible values are printed in brackets after the feature's name.
5616 The default value if a feature isn't specified inside a text class-description
5624 If the argument has a datatype like
5625 \begin_inset Quotes eld
5629 \begin_inset Quotes erd
5633 \begin_inset Quotes eld
5637 \begin_inset Quotes erd
5640 , the default is shown like this:
5650 \begin_layout Subsection
5651 Supporting new document classes
5654 \begin_layout Standard
5655 There are two situations you are likely to encounter when wanting to support
5656 a new LaTeX document class, involving LaTeX2e class (
5667 \begin_layout Subsection
5675 \begin_layout Standard
5676 If your new document class is provided as a style file that is used in conjuncti
5677 on with an existing, supported document class, start by copying the existing
5678 class's layout file into your local directory.
5679 For the sake of example we'll assume that the style file is called
5683 and it is meant to be used with
5687 which is a standard class.
5690 \begin_layout LyX-Code
5691 cp report.layout ~/.lyx/layouts/myclass.layout
5694 \begin_layout Standard
5699 and change the line:
5702 \begin_layout LyX-Code
5705 DeclareLaTeXClass{report}
5708 \begin_layout Standard
5712 \begin_layout LyX-Code
5715 DeclareLaTeXClass[report, myclass.sty]{report (myclass)}
5718 \begin_layout Standard
5722 \begin_layout LyX-Code
5732 \begin_layout Standard
5733 near the top of the file.
5736 \begin_layout Standard
5737 Start LyX and select
5742 ools\SpecialChar \menuseparator
5750 Restart LyX and try creating a new document.
5755 " as a document class option in the
5760 ocument\SpecialChar \menuseparator
5768 It is likely that some of the sectioning commands and such will differ
5769 from how the base class
5773 \begin_layout Standard
5783 works, so you can fiddle around with the settings for the different sections
5785 See below for more discussion on this.
5788 \begin_layout Subsection
5796 \begin_layout Standard
5797 In this case, you will probably have to
5798 \begin_inset Quotes eld
5802 \begin_inset Quotes erd
5806 We strongly suggest copying an existing layout file which uses a similar
5807 LaTeX class and modifying it if at all possible.
5808 At least use an existing file as a starting point so you can find out what
5809 items you need to worry about.
5810 Again, the specifics are covered below.
5813 \begin_layout Section
5814 Declaring a new text class
5817 \begin_layout Standard
5818 When it's finally time to get your hands dirty and create or edit your own
5819 layout file, the following sections describe what you're up against.
5820 Our advice is to go slowly, save and test often, listen to soothing music,
5821 and enjoy one or two of your favorite adult beverages; more if you are
5822 getting particularly stuck.
5823 It's really not that hard, except that the multitude of options can become
5824 overwhelming if you try to do to much in one sitting.
5825 Go have another adult beverage, just for good measure.
5828 \begin_layout Standard
5832 \begin_layout Standard
5833 Lines in a layout file which begin with a
5838 There is one exception to this rule: all layouts should begin with lines
5842 \begin_layout LyX-Code
5845 #% Do not delete the line below; configure depends on this
5848 \begin_layout LyX-Code
5853 DeclareLaTeXClass{article}
5856 \begin_layout Standard
5857 The second line is used when you configure LyX.
5858 The layout file is read by the LaTeX script
5862 , in a special mode where
5867 The first line is just a LaTeX comment, and the second one contains the
5868 declaration of the text class.
5869 If these lines appear in a file named
5873 , then they define a text class of name
5877 (the name of the layout file) which uses the LaTeX document class
5881 (the default is to use the same name as the layout).
5883 \begin_inset Quotes eld
5887 \begin_inset Quotes erd
5890 that appears above is used as a description of the text class in the
5895 ocument\SpecialChar \menuseparator
5905 \begin_layout Standard
5906 Let's assume that you wrote your own text class that uses the
5910 documentclass, but where you changed the appearance of the section headings.
5911 If you put it in a file
5915 , the header of this file should be:
5918 \begin_layout LyX-Code
5921 #% Do not delete the line below; configure depends on this
5924 \begin_layout LyX-Code
5929 DeclareLaTeXClass[article]{article (with my own headings)}
5932 \begin_layout Standard
5933 This declares a text class
5937 , associated with the LaTeX document class
5942 \begin_inset Quotes eld
5945 article (with my own headings)
5946 \begin_inset Quotes erd
5950 If your text class depends on several packages, you can declare it as:
5953 \begin_layout LyX-Code
5956 #% Do not delete the line below; configure depends on this
5959 \begin_layout LyX-Code
5964 DeclareLaTeXClass[article,foo.sty]{article (with my own headings)}
5967 \begin_layout Standard
5968 This indicates that your text class uses the foo.sty package.
5969 Finally, it is also possible to declare classes for DocBook code.
5970 Typical declarations will look like
5973 \begin_layout LyX-Code
5976 #% Do not delete the line below; configure depends on this
5979 \begin_layout LyX-Code
5984 DeclareDocBookClass[article]{SGML (DocBook article)}
5987 \begin_layout Standard
5988 Note that these declarations can also be given an optional parameter declaring
5989 the name of the document class (but not a list).
5992 \begin_layout Standard
5993 When the text class has been modified to your taste, all you have to do
5994 is to copy it either in
6007 ools\SpecialChar \menuseparator
6015 Exit LyX and restart it; then your new text class should be available along
6019 \begin_layout Subsection
6023 \begin_layout Standard
6024 The first non-comment line must contain the file format number:
6027 \begin_layout Description
6038 ] This tag was introduced with LyX 1.4.0 (layout files of LyX 1.3.x and earlier
6039 don't have an explicit file format).
6040 The file format that is documented here is
6047 \begin_layout Subsection
6048 General text class parameters
6051 \begin_layout Standard
6052 These are the general parameters which describe the form of the entire document:
6055 \begin_layout Standard
6059 \begin_layout Standard
6071 \begin_layout Description
6085 ] Whether the class-default should have one or two columns.
6086 Can be changed in the
6091 ocument\SpecialChar \menuseparator
6099 This setting (same goes for
6103 , too) is important: if your text class has two columns by default but you
6104 forget to set it correctly, the
6112 be output when you select
6121 ocument\SpecialChar \menuseparator
6129 \begin_layout Description
6143 ] Whether the class-default should be printing on one or both sides of the
6145 Can be changed in the
6150 ocument\SpecialChar \menuseparator
6160 \begin_layout Description
6174 ] The class default pagestyle.
6175 Can be changed in the
6180 ocument\SpecialChar \menuseparator
6190 \begin_layout Description
6194 ClassOptions\SpecialChar \ldots{}
6198 This section describes various global options supported by the document
6200 See Section\InsetSpace ~
6202 \begin_inset LatexCommand ref
6203 reference "sec:classoptions"
6210 \begin_layout Description
6228 ] Whether the class already provides the feature
6233 A feature is in general the name of a package (amsmath, makeidx, \SpecialChar \ldots{}
6235 macro (url, boldsymbol,\SpecialChar \ldots{}
6236 ); the complete list of supported features is unfortunat
6240 \begin_layout Description
6247 This is used to describe the default font of the document.
6248 See Section\InsetSpace ~
6250 \begin_inset LatexCommand ref
6251 reference "sec:fonts"
6258 \begin_layout Description
6269 ] This is the style that will be assigned to new paragraphs, usually
6274 This will default to the first defined style if not given, but you are
6275 highly encouraged to use this directive.
6278 \begin_layout Description
6295 ] Indicates what kind of markup is used to define the title of a document.
6300 means that the macro with name
6304 will be inserted after the last layout which has
6305 \begin_inset Quotes eld
6313 \begin_inset Quotes erd
6321 corresponds to the case where the block of paragraphs which have
6322 \begin_inset Quotes eld
6330 \begin_inset Quotes erd
6333 should be enclosed into the
6342 \begin_layout Description
6353 ] The name of the command/environment mentionned above.
6356 \begin_layout Description
6360 Preamble\SpecialChar \ldots{}
6364 A set of macro definitions that will be output at the beginning of the
6366 Use this for global definitions.
6369 \begin_layout Description
6376 As its name implies, this command allows you to include another layout
6377 definition file within yours to avoid duplicating commands.
6378 Common examples are the standard layout files, for example,
6382 , which contains most of the basic layouts.
6385 \begin_layout Description
6389 Style\SpecialChar \ldots{}
6393 This sequence defines a new style.
6394 If the style already exists, it will redefine some of its parameters instead.
6395 See Section\InsetSpace ~
6397 \begin_inset LatexCommand ref
6398 reference "sec:style"
6405 \begin_layout Description
6412 This command deletes an existing style.
6413 This is particularly useful when you want to suppress a style that has
6414 be defined in an input file.
6417 \begin_layout Description
6421 Float\SpecialChar \ldots{}
6425 This sequence defines a new float.
6426 See Section\InsetSpace ~
6428 \begin_inset LatexCommand ref
6429 reference "sec:floats"
6436 \begin_layout Description
6443 This command deletes an existing float.
6444 This is particularly useful when you want to suppress a float that has
6445 be defined in an input file.
6448 \begin_layout Description
6452 CharStyle\SpecialChar \ldots{}
6456 This section defines a new character style.
6457 See Section\InsetSpace ~
6459 \begin_inset LatexCommand ref
6460 reference "sec:charstyle"
6467 \begin_layout Description
6471 Counter\SpecialChar \ldots{}
6475 This sequence defines a new counter.
6476 See Section\InsetSpace ~
6478 \begin_inset LatexCommand ref
6479 reference "sec:counter"
6486 \begin_layout Standard
6490 \begin_layout Standard
6502 \begin_layout Subsection
6510 \begin_layout Standard
6511 \begin_inset LatexCommand label
6512 name "sec:classoptions"
6520 section can contain the following entries:
6523 \begin_layout Description
6534 ] The list of available font sizes for the document's main font, separated
6536 \begin_inset Quotes eld
6544 \begin_inset Quotes erd
6550 \begin_layout Description
6559 string="empty|plain|headings|fancy"
6561 ] The list of available page styles, separated by
6562 \begin_inset Quotes eld
6570 \begin_inset Quotes erd
6576 \begin_layout Description
6587 ] Some document class options, separated by a comma, that will be added
6588 to the optional part of the
6597 \begin_layout Subsection
6598 Specific Paragraph Layouts
6601 \begin_layout Standard
6602 \begin_inset LatexCommand label
6607 A paragraph layout description looks like this
6611 \begin_layout Standard
6612 Note that this will either define a new layout or modify an existing one.
6620 \begin_layout LyX-Code
6627 \begin_layout LyX-Code
6631 \begin_layout LyX-Code
6635 \begin_layout Standard
6636 where the following commands are allowed:
6639 \begin_layout Standard
6643 \begin_layout Standard
6655 \begin_layout Description
6666 This is used to copy all the features of an existing layout into the current
6671 \begin_layout Description
6683 , Command, Environment, Item_Environment,
6689 ] How the layout should be translated into LaTeX.
6694 means nothing special.
6707 {\SpecialChar \ldots{}
6722 }\SpecialChar \ldots{}
6746 is generated for each paragraph of this environment.
6759 is passed as an argument to the environment.
6764 can be defined in the
6769 ayout\SpecialChar \menuseparator
6783 is perhaps a bit misleading, since these rules apply to SGML classes, too.
6784 Visit the SGML class files for specific examples.
6787 \begin_layout Description
6798 If 1, marks the layout as being part of a title block (see also the
6809 \begin_layout Description
6816 The name of the corresponding LaTeX stuff.
6817 Either the environment or command name.
6820 \begin_layout Description
6827 The optional parameter for the corresponding
6834 This parameter cannot be changed from within LyX.
6837 \begin_layout Description
6848 ] The number of optional arguments that can be used with this layout.
6849 This is useful for things like section headings, and only makes sense with
6853 \begin_layout Description
6865 , Manual, Dynamic, First_Dynamic, Right_Address_Box
6869 The kind of margin that the layout has on the left side.
6874 just means a fixed margin.
6879 means that the left margin depends on the string entered in the
6884 dit\SpecialChar \menuseparator
6889 aragraph\InsetSpace ~
6893 This is used to typeset nice lists without tabulators.
6898 means that the margin depends on the size of the label.
6899 This is used for automatic enumerated headlines.
6900 It is obvious that the headline
6901 \begin_inset Quotes eld
6904 5.4.3.2.1 Very long headline
6905 \begin_inset Quotes erd
6908 must have a wider left margin (as wide as
6909 \begin_inset Quotes eld
6913 \begin_inset Quotes erd
6916 plus the space) than
6917 \begin_inset Quotes eld
6920 3.2 Very long headline
6921 \begin_inset Quotes erd
6924 , even if other word processors are not able to do this.
6929 is similar, but only the very first row of the paragraph is dynamic, while
6930 the others are static; this is used, for example, for descriptions.
6935 means the margin is chosen in a way that the longest row of this paragraph
6936 fits to the right margin.
6937 This is used to typeset an address on the right edge of the page.
6940 \begin_layout Description
6957 ] Whether the following Paragraph is allowed to indent its very first row.
6962 means that it is not allowed to do so,
6966 means it could do so if it wants to.
6969 \begin_layout Description
6980 ] The indent of the very first line of a paragraph.
6981 The argument is passed as a string.
6986 means that the paragraph is indented with the width of
6995 You can get a negative width by prefixing the string with
7000 This way was chosen so that the look is the same with each used screen
7006 will be fixed for a certain layout.
7007 The exception is Standard layout, since the indentation of a Standard layout
7008 paragraph can be prohibited with
7013 Also, Standard layout paragraphs inside environments use the
7017 of the environment, not their native one.
7018 For example, Standard paragraphs inside an enumeration are not indented.
7021 \begin_layout Description
7032 ] LyX allows to choose either
7033 \begin_inset Quotes eld
7037 \begin_inset Quotes erd
7041 \begin_inset Quotes eld
7045 \begin_inset Quotes erd
7048 to typeset a document.
7050 \begin_inset Quotes eld
7054 \begin_inset Quotes erd
7057 is chosen, this value is completely ignored.
7059 \begin_inset Quotes eld
7063 \begin_inset Quotes erd
7066 is chosen, the parindent of a LaTeXtype
7067 \begin_inset Quotes eld
7071 \begin_inset Quotes erd
7074 layout is ignored and all paragraphs are additionally separated by this
7076 The vertical space is calculated with
7078 value*DefaultHeight()
7084 is the height of a row with the normal font.
7085 This way, the look stays the same with different screen fonts.
7088 \begin_layout Description
7099 ] The vertical space with which the very first of a chain of paragraphs
7100 with this layout is separated from the previous paragraph.
7101 If the previous paragraph has another layout, the separations are not simply
7102 added, but the maximum is taken.
7105 \begin_layout Description
7120 for the very last paragraph.
7123 \begin_layout Description
7134 ] The vertical space between two paragraphs of this layout.
7137 \begin_layout Description
7148 ] This is an extra space between the paragraphs of an environment layout.
7149 If you put other layouts into an environment, each is separated with the
7155 But the whole items of the environment are additionally separated with
7164 \begin_layout Description
7175 ] If you put layouts into environments, the leftmargins are not simply added,
7176 but added with a factor
7177 \begin_inset Formula $\frac{4}{depth+4}$
7181 Note that this parameter is also used when the border is defined as
7190 Then it is added to the manual or dynamic border.
7191 This string has the same meaning as for
7198 \begin_layout Description
7216 \begin_layout Description
7228 , Manual, Static, Top_Environment,
7230 Centered_Top_Environment, Sensitive,
7239 means the label is the very first word (up to the first real blank).
7244 means it is defined in the layout (see
7255 Centered_Top_Environment
7257 are special cases of
7262 The label will be printed above the paragraph, but only at the top of an
7263 environment or the top of a chain of paragraphs with this layout.
7264 Usage is for example the
7273 This is also the case for
7277 labels with latex type
7281 , in order to make layouts for theorems work correctly.
7286 is a special case for the caption-labels
7287 \begin_inset Quotes eld
7291 \begin_inset Quotes erd
7295 \begin_inset Quotes eld
7299 \begin_inset Quotes erd
7307 means the (hardcoded) label string depends on the kind of float.
7312 label type defines automatically numbered labels.
7315 \begin_layout Description
7328 The name of the counter for automatic numbering (see Section\InsetSpace ~
7330 \begin_inset LatexCommand ref
7331 reference "sec:counter"
7336 This must be given if
7349 \begin_layout Description
7360 ] The horizontal space between the label and the text body.
7361 Only used for labels that are not above the text body.
7364 \begin_layout Description
7371 [float=0] The vertical space between the label and the text body.
7372 Only used for labels that are above the text body (
7378 Centered_Top_Environment
7383 \begin_layout Description
7394 ] The string used for a label with a
7403 this string is also used as a suggestion for the
7407 that can be set in the
7412 dit\SpecialChar \menuseparator
7417 aragraph\InsetSpace ~
7427 is set, this string can be contain the special formatting commands described
7428 in Section\InsetSpace ~
7430 \begin_inset LatexCommand ref
7431 reference "sec:counter"
7436 For the sake of backwards compatibility, the string
7444 will be replaced by the expanded
7455 This feature is now obsolete and should be replaced by the mechanisms of
7456 Section\InsetSpace ~
7458 \begin_inset LatexCommand ref
7459 reference "sec:counter"
7466 \begin_layout Description
7477 ] This is used inside the appendix instead of
7498 \begin_layout Description
7505 The level of the style in the table of contents.
7506 This is used for automatic numbering of section headings.
7509 \begin_layout Description
7521 , Box, Filled_Box, Static
7523 ] The type of label that stands at the end of the paragraph (or sequence
7546 \begin_inset Quotes eld
7550 \begin_inset Quotes erd
7562 ) is a white (resp.\InsetSpace ~
7563 black) square suitable for end of proof markers,
7567 is an explicit text string.
7570 \begin_layout Description
7581 ] The string used for a label with a
7593 \begin_layout Description
7605 , left, right, center
7607 ] Paragraph alignment.
7610 \begin_layout Description
7622 , left, right, center
7629 Some LaTeX styles prohibit certain alignments, since those wouldn't make
7631 For example a right-aligned or centered enumeration isn't possible.
7634 \begin_layout Description
7648 ] With this parameter the
7653 \begin_inset Quotes eld
7656 Vertical space above
7657 \begin_inset Quotes erd
7665 dit\SpecialChar \menuseparator
7670 aragraph\InsetSpace ~
7673 dialog can be set when initializing a paragraph with this layout
7677 \begin_layout Standard
7680 Note from Jean-Marc:
7682 I'm not sure that this setting has much use, and it should probably be
7683 removed in later versions.
7692 \begin_layout Description
7713 \begin_layout Description
7727 ] Whether fragile commands in this layout should be
7736 \begin_layout Description
7753 ] Whether newlines are translated into LaTeX newlines (
7762 The translation can be switched off to allow more comfortable LaTeX editing
7766 \begin_layout Description
7780 ] Whether the contents of this paragraph should be output in raw form, meaning
7781 without special translations that LaTeX would require.
7782 This somehow replaces the older
7789 \begin_layout Description
7803 ] Usually LyX doesn't allow you to insert more than one space between words,
7804 since a space is considered as the separation between two words, not a
7805 character or symbol of its own.
7806 This is a very fine thing but sometimes annoying, for example when typing
7807 program code or plain LaTeX code.
7813 Note that LyX will create protected blanks for the additional blanks when
7814 in another mode than LaTeX-mode.
7817 \begin_layout Description
7831 ] Usually LyX does not allow you to leave a paragraph empty, since it would
7832 lead to empty LaTeX output.
7833 There are some cases where this could be desirable however: in a letter
7834 template, the required fields can be provided as empty fields, so that
7835 people do not forget them; in some special classes, a layout can be used
7836 as some kind of break, which does not contain actual text.
7839 \begin_layout Description
7851 , onehalf, double, other
7857 ] This defines what the default spacing should be in the layout.
7870 correspond respectively to a multiplier value of 1, 1.25 and 1.667.
7871 If you specify the argument
7875 , then you should also provide a numerical argument which will be the actual
7877 Note that, contrary to other parameters,
7881 implies the generation of specific LaTeX code, using the package
7888 \begin_layout Description
7895 The font used for both the text body
7900 See section\InsetSpace ~
7902 \begin_inset LatexCommand ref
7903 reference "sec:fonts"
7908 Note that defining this font automatically defines the
7915 \begin_layout Description
7922 The font used for the text body .
7923 See section\InsetSpace ~
7925 \begin_inset LatexCommand ref
7926 reference "sec:fonts"
7933 \begin_layout Description
7940 The font used for the label.
7941 See section\InsetSpace ~
7943 \begin_inset LatexCommand ref
7944 reference "sec:fonts"
7951 \begin_layout Description
7955 Preamble\SpecialChar \ldots{}
7959 A set of macro definitions that will be output at the beginning of the
7960 LaTeX files when the layout is used.
7961 Use this to define the macros needed by this particular layout.
7964 \begin_layout Description
7971 the name of a style which preamble should be output
7975 the one mentionned above.
7976 This allows to ensure some ordering of the preamble snippets when macros
7977 definitions depend on one another
7981 \begin_layout Standard
7982 Note that, besides that functionality, there is no way to ensure any ordering
7984 The ordering that you see in a given version of LyX may change without
7985 warning in later versions.
7993 \begin_layout Standard
7997 \begin_layout Standard
8009 \begin_layout Subsection
8013 \begin_layout Standard
8014 \begin_inset LatexCommand label
8019 Since version 1.3.0 of LyX, it is necessary to define the floats (
8027 , \SpecialChar \ldots{}
8028 ) in the text class itself.
8029 If you are looking here to learn how to upgrade an existing text class,
8030 it will probably turn out that all you have to do is to add
8033 \begin_layout LyX-Code
8037 \begin_layout Standard
8038 at a reasonable location of the text class.
8042 \begin_layout Standard
8043 Don't forget to also have a look at counters in next section.
8048 If you want to implement a text class that proposes some other float types
8049 (like the AGU class bundled with LyX), the information below will hopefully
8053 \begin_layout Description
8065 \begin_inset Quotes erd
8069 \begin_inset Quotes erd
8073 \begin_inset Quotes eld
8077 \begin_inset Quotes erd
8080 of the new class of floats, like program or algorithm.
8081 After the appropriate
8102 \begin_layout Description
8114 \begin_inset Quotes erd
8118 \begin_inset Quotes erd
8121 ] The string that will be used in the menus and also for the caption.
8124 \begin_layout Description
8145 if the float is already defined by the documentclass.
8150 , the float will be defined using the LaTeX package
8157 \begin_layout Description
8169 \begin_inset Quotes erd
8173 \begin_inset Quotes erd
8176 ] This (optional) argument determines whether floats of this class will
8177 be numbered within some sectional unit of the document.
8178 For example, if within is equal to
8182 , the floats will be numbered within chapters.
8186 \begin_layout Description
8198 \begin_inset Quotes erd
8202 \begin_inset Quotes erd
8205 ] The style used when defining the float using
8214 \begin_layout Description
8226 \begin_inset Quotes erd
8230 \begin_inset Quotes erd
8233 ] The default placement for the given class of floats.
8234 They are like in standard LaTeX:
8250 for top, bottom, page, and here, respectively.
8254 \begin_layout Standard
8255 Note that the order of these letters in the string is irrelevant, like in
8261 On top of that there is a new type,
8265 , which does not really correspond to a float, since it means: put it
8266 \begin_inset Quotes eld
8270 \begin_inset Quotes erd
8274 Note, however that the
8278 specifier is special and, because of implementation details cannot be used
8279 in non-builtin float types.
8280 If you do not understand what this means, just use
8287 \begin_layout Description
8299 \begin_inset Quotes erd
8303 \begin_inset Quotes erd
8306 ] The file name extension of an auxiliary file for the list of figures (or
8308 LaTeX writes the captions to this file.
8311 \begin_layout Description
8323 \begin_inset Quotes erd
8327 \begin_inset Quotes erd
8330 ] The heading used for the list of floats.
8333 \begin_layout Standard
8334 Note that defining a float with type
8340 automatically defines the corresponding counter with name
8349 \begin_layout Subsection
8353 \begin_layout Standard
8354 \begin_inset LatexCommand label
8355 name "sec:charstyle"
8359 You can define character styles since version 1.4.0 of LyX.
8364 section can contain the following entries:
8367 \begin_layout Description
8374 The font used for both the text body
8379 See section\InsetSpace ~
8381 \begin_inset LatexCommand ref
8382 reference "sec:fonts"
8387 Note that defining this font automatically defines the
8394 \begin_layout Description
8401 The font used for the label.
8402 See section\InsetSpace ~
8404 \begin_inset LatexCommand ref
8405 reference "sec:fonts"
8412 \begin_layout Description
8419 The name of the corresponding LaTeX stuff.
8420 Either the environment or command name.
8423 \begin_layout Description
8430 The optional parameter for the corresponding
8437 This parameter cannot be changed from within LyX.
8440 \begin_layout Description
8447 See section\InsetSpace ~
8449 \begin_inset LatexCommand ref
8450 reference "sec:style"
8457 \begin_layout Description
8461 Preamble\SpecialChar \ldots{}
8465 See section\InsetSpace ~
8467 \begin_inset LatexCommand ref
8468 reference "sec:style"
8475 \begin_layout Subsection
8479 \begin_layout Standard
8480 \begin_inset LatexCommand label
8485 Since version 1.3.0 of LyX, it is necessary to define the counters (
8493 , \SpecialChar \ldots{}
8494 ) in the text class itself.
8495 If you are looking here to learn how to upgrade an existing text class,
8496 it will probably turn out that all you have to do is to add
8499 \begin_layout LyX-Code
8500 Input stdcounters.inc
8503 \begin_layout Standard
8504 The following parameters can be used:
8507 \begin_layout Description
8519 \begin_inset Quotes erd
8523 \begin_inset Quotes erd
8526 ] The name of the counter.
8529 \begin_layout Description
8541 \begin_inset Quotes erd
8545 \begin_inset Quotes erd
8548 ] If this is set to the name of another counter, the present counter will
8549 be reset everytime the other one is increased.
8561 \begin_layout Description
8565 LabelString [string=""]
8568 when this is defined, this string defines how the counter is displayed.
8569 Setting this value resets
8574 The following special constructs can be used in the string:
8578 \begin_layout Itemize
8585 will be replaced by the expansion of the
8598 If these are empty, a default value is constructed as follows: if the counter
8599 has a master counter
8611 is used; otherwise the string
8620 \begin_layout Itemize
8621 counter values can be expressed using LaTeX-like macros
8645 \begin_layout Description
8656 to arabic numerals, like 1, 2, 3\SpecialChar \ldots{}
8661 \begin_layout Standard
8671 Actually, the situation is a bit more complicated than that: any
8690 other than those descibed below will produce arabic numerals.
8691 It would not be surprising to see this change in the future.
8699 \begin_layout Description
8706 for lower-case letters: a, b, c, \SpecialChar \ldots{}
8710 \begin_layout Description
8717 for upper-case letters: A, B, C, \SpecialChar \ldots{}
8721 \begin_layout Description
8728 for lower-case roman numerals: i, ii, iii, \SpecialChar \ldots{}
8732 \begin_layout Description
8739 for upper-case roman numerals: I, II, III\SpecialChar \ldots{}
8743 \begin_layout Description
8750 for hebrew numerals.
8755 \begin_layout Description
8759 LabelStringAppendix [string=""]
8766 , for use in appendix.
8769 \begin_layout Subsection
8773 \begin_layout Standard
8774 \begin_inset LatexCommand label
8779 A font description looks like that:
8782 \begin_layout LyX-Code
8792 \begin_layout LyX-Code
8796 \begin_layout LyX-Code
8800 \begin_layout Standard
8801 and the following commands are available:
8804 \begin_layout Description
8821 \begin_layout Description
8838 \begin_layout Description
8850 , Italic, SmallCaps, Slanted
8855 \begin_layout Description
8871 , large, larger, largest, huge, giant
8876 \begin_layout Description
8888 , black, white, red, green, blue, cyan, magenta, yellow
8893 \begin_layout Subsection
8894 Upgrading old layout files
8897 \begin_layout Standard
8898 The file format of layout files changes from time to time, so old layout
8899 files need to be converted.
8900 This process has been automated in LyX 1.4.0: If LyX reads an old format
8901 layout file it will call the conversion tool
8903 $LyXDir/scripts/layout2layout.py
8905 and convert it to a temporary file in current format.
8906 The original file is left untouched, so that you can still use it with
8908 If you want to convert the layout file permanently, just call the converter
8912 \begin_layout LyX-Code
8913 python $LyXDir/scripts/layout2layout.py myclass.layout myclassnew.layout
8916 \begin_layout Standard
8928 \begin_layout Standard
8929 The automatic conversion does only handle syntax changes.
8930 It cannot handle the case where the contents of included files was changed.
8931 For example, layout files based on
8944 If you get error messages about undefined counters, try to convert your
8964 \begin_layout Section
8966 \begin_inset LatexCommand label
8967 name "sec:templates"
8974 \begin_layout Standard
8975 Templates are created just like usual documents.
8976 The only difference is that usual documents contain all possible settings,
8977 including the fontscheme and the papersize.
8978 Usually a user doesn't want a template to overwrite his defaults in these
8980 For that reason, the designer of a template should remove the corresponding
8993 from the template LyX file.
8994 This can be done with any simple text-editor, for example
9006 \begin_layout Standard
9007 Put the edited template files you create in
9011 , copy the ones you use from the global template directory in
9015 to the same place, and redefine the template path in the
9020 dit\SpecialChar \menuseparator
9039 \begin_layout Standard
9040 Note that there is a template which has a particular meaning:
9045 This template is loaded everytime you create a new document with
9052 \SpecialChar \menuseparator
9060 in order to provide useful defaults.
9061 To create this template from inside LyX, all you have to do is to open
9062 a document with the correct settings, and use the
9068 e as Document Defaults
9073 \begin_layout Chapter
9074 Including External Material
9077 \begin_layout Section
9081 \begin_layout Standard
9082 \begin_inset Note Note
9085 \begin_layout Standard
9086 This section is completely outdated.
9091 One often requested feature from LyX users is to be able to interface LyX
9092 with Xfig, Dia, or other similar applications that specialize in producing
9093 a certain kind of diagram, figure, schematic or whatever material might
9094 be relevant to include in your document.
9095 Previously, it was only possible to include boring, static, fixed images
9096 in LyX documents with the graphics feature, but there are several limitations
9097 attached to this approach:
9100 \begin_layout Itemize
9101 If you want to change the figure, you have to invoke an external program
9105 \begin_layout Itemize
9106 LyX does not notice that the referenced files change, so the on-screen display
9107 can fast become obsolete, and this is aggravated by the lack of a means
9108 of updating the display
9111 \begin_layout Itemize
9112 The graphics stuff does not provide any mechanisms for coping with different
9113 exported formats such as DocBook, HTML or plain text
9116 \begin_layout Standard
9117 The external material facility attempts to solve all of these problems
9121 \begin_layout Standard
9122 Even if the graphics facility can't solve all problems, it is still valuable
9123 because it does provide in-line preview of the graphics, and supports advanced
9124 geometric transformations with a comfortable user interface.
9130 It does this by offering a general method to interface LyX to external
9132 Instead of introducing a long list of different constructs tailored for
9133 each specific application, we chose to sacrifice the in-line displaying
9134 of the included material in order to provide a general construct to cover
9135 a wide range of applications.
9136 The result is the external material construct.
9137 External material presents itself in the document simply as a button, but
9138 don't let this fool you.
9139 When you click on it, a dialog will appear that allows you to chose exactly
9140 what material to include, and in the following sections you will learn
9141 that this is indeed a powerful mechanism that can solve all of the above
9145 \begin_layout Section
9149 \begin_layout Standard
9150 The external material feature is based on the concept of a
9155 A template is a specification of how LyX should interface with a certain
9157 As bundled, LyX comes with predefined templates for Xfig figures, Dia diagrams,
9158 various raster format images, gnuplot, and more.
9159 You can check the actual list by using the menu
9161 Insert\SpecialChar \menuseparator
9162 File\SpecialChar \menuseparator
9171 Furthermore, it is possible to roll your own template to support a specific
9173 Later we'll describe in more detail what is involved, and hopefully you
9174 will submit all the templates you create so we can include them in a later
9178 \begin_layout Standard
9179 Another basic idea of the external material feature is to distinguish between
9180 the original file that serves as a base for final material and the produced
9181 file that is included in your exported or printed document.
9182 For example, consider the case of a figure produced with
9187 The Xfig application itself works on an original file with the
9192 Within XFig, you create and change your figure, and when you are done,
9198 When you want to include the figure in your document, you invoke
9202 in order to create a PostScript file that can readily be included in your
9208 file is the original file, and the PostScript file is the produced file.
9211 \begin_layout Standard
9212 This distinction is important in order to allow updating of the material
9213 while you are in the process of writing the document.
9214 Furthermore, it provides us with the flexibility that is needed to support
9215 multiple export formats.
9216 For instance, in the case of a plain text file, it is not exactly an award-winn
9217 ing idea to include the figure as raw PostScript.
9218 Instead, you'd either prefer to just include a reference to the figure,
9219 or try to invoke some graphics to Ascii converter to make the final result
9220 look similar to the real graphics.
9221 The external material management allows you to do this, because it is parameter
9222 ized on the different export formats that LyX supports.
9225 \begin_layout Standard
9226 Besides supporting the production of different products according to the
9227 exported format, it supports tight integration with editing and viewing
9229 In the case of an XFig figure, you are able to invoke
9233 on the original file with a single click from within the external material
9234 dialog in LyX, and also preview the produced PostScript file with
9239 No more fiddling around with the command line and/or file browsers to locate
9240 and manipulate the original or produced files.
9241 In this way, you are finally able to take full advantage of the many different
9242 applications that are relevant to use when you write your documents, and
9243 ultimately be more productive.
9246 \begin_layout Section
9247 External material dialog
9250 \begin_layout Standard
9255 dialog is described in the
9264 \begin_layout Section
9268 \begin_layout Standard
9269 In this section, we should include some examples of use of the external
9271 Those examples could include:
9274 \begin_layout Itemize
9275 External raster images
9278 \begin_layout Itemize
9279 External XFig figures
9282 \begin_layout Itemize
9286 \begin_layout Itemize
9290 \begin_layout Itemize
9291 The use of makefiles
9294 \begin_layout Itemize
9295 Recursive external LyX templates
9298 \begin_layout Section
9299 The external template configuration file
9302 \begin_layout Standard
9303 It is relatively easy to add custom external template definitions to LyX.
9304 However, be aware this doing this in an careless manner most probably
9308 introduce an easily exploitable security hole.
9309 So before you do this, please read the discussion about security which
9313 \begin_layout Standard
9314 Having said that, we encourage you to submit any interesting templates that
9319 \begin_layout Standard
9320 The external templates are defined in the
9322 lib/external_templates
9325 You can place your own version in
9327 .lyx/external_templates
9332 \begin_layout Standard
9333 A typical template looks like this:
9336 \begin_layout LyX-Code
9340 \begin_layout LyX-Code
9341 GuiName "XFig: $$AbsOrRelPathParent$$Basename"
9344 \begin_layout LyX-Code
9348 \begin_layout LyX-Code
9352 \begin_layout LyX-Code
9356 \begin_layout LyX-Code
9360 \begin_layout LyX-Code
9364 \begin_layout LyX-Code
9365 AutomaticProduction true
9368 \begin_layout LyX-Code
9372 \begin_layout LyX-Code
9376 \begin_layout LyX-Code
9380 \begin_layout LyX-Code
9381 TransformCommand Rotate RotationLatexCommand
9384 \begin_layout LyX-Code
9385 TransformCommand Resize ResizeLatexCommand
9388 \begin_layout LyX-Code
9389 Product "$$RotateFront$$ResizeFront
9392 \begin_layout LyX-Code
9397 input{$$AbsOrRelPathMaster$$Basename.pstex_t}
9400 \begin_layout LyX-Code
9401 $$ResizeBack$$RotateBack"
9404 \begin_layout LyX-Code
9408 \begin_layout LyX-Code
9409 UpdateResult "$$AbsPath$$Basename.pstex_t"
9412 \begin_layout LyX-Code
9413 Requirement "graphicx"
9416 \begin_layout LyX-Code
9417 ReferencedFile latex "$$AbsOrRelPathMaster$$Basename.pstex_t"
9420 \begin_layout LyX-Code
9421 ReferencedFile latex "$$AbsPath$$Basename.eps"
9424 \begin_layout LyX-Code
9425 ReferencedFile dvi "$$AbsPath$$Basename.eps"
9428 \begin_layout LyX-Code
9432 \begin_layout LyX-Code
9436 \begin_layout LyX-Code
9437 TransformCommand Rotate RotationLatexCommand
9440 \begin_layout LyX-Code
9441 TransformCommand Resize ResizeLatexCommand
9444 \begin_layout LyX-Code
9445 Product "$$RotateFront$$ResizeFront
9448 \begin_layout LyX-Code
9453 input{$$AbsOrRelPathMaster$$Basename.pdftex_t}
9456 \begin_layout LyX-Code
9457 $$ResizeBack$$RotateBack"
9460 \begin_layout LyX-Code
9464 \begin_layout LyX-Code
9465 UpdateResult "$$AbsPath$$Basename.pdftex_t"
9468 \begin_layout LyX-Code
9469 Requirement "graphicx"
9472 \begin_layout LyX-Code
9473 ReferencedFile latex "$$AbsOrRelPathMaster$$Basename.pdftex_t"
9476 \begin_layout LyX-Code
9477 ReferencedFile latex "$$AbsPath$$Basename.pdf"
9480 \begin_layout LyX-Code
9484 \begin_layout LyX-Code
9488 \begin_layout LyX-Code
9489 Product "$$Contents(
9491 "$$AbsPath$$Basename.asc
9496 \begin_layout LyX-Code
9497 UpdateFormat asciixfig
9500 \begin_layout LyX-Code
9501 UpdateResult "$$AbsPath$$Basename.asc"
9504 \begin_layout LyX-Code
9508 \begin_layout LyX-Code
9512 \begin_layout LyX-Code
9513 Product "<graphic fileref=
9515 "$$AbsOrRelPathMaster$$Basename.eps
9520 \begin_layout LyX-Code
9524 \begin_layout LyX-Code
9528 \begin_layout LyX-Code
9529 UpdateResult "$$AbsPath$$Basename.eps"
9532 \begin_layout LyX-Code
9533 ReferencedFile docbook "$$AbsPath$$Basename.eps"
9536 \begin_layout LyX-Code
9537 ReferencedFile docbook-xml "$$AbsPath$$Basename.eps"
9540 \begin_layout LyX-Code
9544 \begin_layout LyX-Code
9545 Product "[XFig: $$FName]"
9548 \begin_layout LyX-Code
9552 \begin_layout LyX-Code
9556 \begin_layout Standard
9557 As you can see, the template is enclosed in
9561 \SpecialChar \ldots{}
9567 It contains a header specifying some general settings, and for each supported
9568 primary document file format a section
9572 \SpecialChar \ldots{}
9580 \begin_layout Subsection
9584 \begin_layout Description
9588 Template\InsetSpace ~
9592 A unique name for the template.
9593 It must not contain substitution macros (see below).
9596 \begin_layout Description
9600 GuiName\InsetSpace ~
9604 The text that is displayed on the button.
9605 This command must occur exactly once.
9608 \begin_layout Description
9612 HelpText\InsetSpace ~
9617 The help text that is used in the External dialog.
9618 Provide enough information to explain to the user just what the template
9619 can provide him with.
9620 This command must occur exactly once.
9623 \begin_layout Description
9627 InputFormat\InsetSpace ~
9631 The file format of the original file.
9632 This must be the name of a format that is known to LyX (see the
9637 ools\SpecialChar \menuseparator
9642 references:Conversion
9649 if the template can handle original files of more than one format.
9650 LyX will attempt to interrogate the file itself in order to deduce its
9651 format in this case.
9652 This command must occur exactly once.
9655 \begin_layout Description
9659 FileFilter\InsetSpace ~
9663 A glob pattern that is used in the file dialog to filter out the desired
9665 If there is more than one possible file extension (e.g.\InsetSpace ~
9674 ), use something like
9679 This command must occur exactly once.
9682 \begin_layout Description
9686 AutomaticProduction\InsetSpace ~
9690 Wether the file represented by the template must be generated by LyX.
9691 This command must occur exactly once.
9694 \begin_layout Description
9698 Transform\InsetSpace ~
9699 Rotate|Resize|Clip|Extra
9702 This command specifies which transformations are supported by this template.
9703 It may occur zero or more times.
9704 This command enables the corresponding tabs in the external dialog.
9709 command must have either a corresponding
9722 Otherwise the transformation will not be supported by that format.
9725 \begin_layout Subsection
9729 \begin_layout Description
9734 LaTeX|PDFLaTeX|PlainText|DocBook
9737 The primary document file format that this format definition is for.
9738 Not every template has a sensible representation in all document file formats.
9739 Please define nevertheless a
9743 section for all formats.
9744 Use a dummy text when no representation is available.
9745 Then you can at least see a reference to the external material in the exported
9749 \begin_layout Description
9753 TransformCommand\InsetSpace ~
9755 RotationLatexCommand
9758 This command specifies that the built in LaTeX command should be used for
9760 This command may occur once or not at all.
9763 \begin_layout Description
9767 TransformCommand\InsetSpace ~
9772 This command specifies that the built in LaTeX command should be used for
9774 This command may occur once or not at all.
9777 \begin_layout Description
9781 TransformOption\InsetSpace ~
9786 This command specifies that rotation is done via an optional argument.
9787 This command may occur once or not at all.
9790 \begin_layout Description
9794 TransformOption\InsetSpace ~
9799 This command specifies that resizing is done via an optional argument.
9800 This command may occur once or not at all.
9803 \begin_layout Description
9807 TransformOption\InsetSpace ~
9812 This command specifies that clipping is done via an optional argument.
9813 This command may occur once or not at all.
9816 \begin_layout Description
9820 TransformOption\InsetSpace ~
9825 This command specifies that an extra optional argument is used.
9826 This command may occur once or not at all.
9829 \begin_layout Description
9833 Product\InsetSpace ~
9837 The text that is inserted in the exported document.
9838 This is actually the most important command and can be quite complex.
9839 This command must occur exactly once.
9842 \begin_layout Description
9846 UpdateFormat\InsetSpace ~
9850 The file format of the converted file.
9851 This must be the name of a format that is known to LyX (see the
9856 ools\SpecialChar \menuseparator
9861 references:Conversion
9864 This command must occur exactly once.
9867 \begin_layout Description
9871 UpdateResult\InsetSpace ~
9875 The file name of the converted file.
9876 The file name must be absolute.
9877 This command must occur exactly once.
9880 \begin_layout Description
9884 ReferencedFile\InsetSpace ~
9885 <format>\InsetSpace ~
9889 This command denotes files that are created by the conversion process and
9890 are needed for a particular export format.
9891 If the filename is relative, it is interpreted relative to the master document.
9892 This command may be given zero or more times.
9895 \begin_layout Description
9899 Requirement\InsetSpace ~
9903 The name of a required LaTeX package.
9904 The package is included via
9910 in the LaTeX preamble.
9911 This command may occur zero or more times.
9914 \begin_layout Description
9918 Preamble\InsetSpace ~
9922 This command specifies a preamble snippet that will be included in the
9924 It has to be defined using
9928 \SpecialChar \ldots{}
9934 This command may occur zero or more times.
9937 \begin_layout Description
9946 This command defines an additional macro
9959 itself may contain substitution macros.
9960 The advantage over using
9968 is that the substituted value of
9972 is sanitized so that it is a valid optional argument in the document format.
9973 This command may occur zero or more times.
9976 \begin_layout Subsection
9977 Preamble definitions
9980 \begin_layout Standard
9981 The external template configuration file may contain additional preamble
9982 definitions enclosed by
9986 \SpecialChar \ldots{}
9992 They can be used by the templates in the
9999 \begin_layout Section
10000 The substitution mechanism
10003 \begin_layout Standard
10004 When the external material facility invokes an external program, it is done
10005 on the basis of a command defined in the template configuration file.
10006 These commands can contain various macros that are expanded before execution.
10007 Execution always take place in the directory of the containing document.
10010 \begin_layout Standard
10011 Also, whenever external material is to be displayed, the name will be produced
10012 by the substitution mechanism, and most other commands in the template
10013 definition support substitution as well.
10016 \begin_layout Standard
10017 The available macros are the following:
10020 \begin_layout Description
10021 $$FName The filename of the file specified in the external material dialog.
10022 This is either an absolute name, or it is relative to the LyX document.
10025 \begin_layout Description
10026 $$Basename The filename without path and without the extension.
10029 \begin_layout Description
10030 $$Extension The file extension (including the dot).
10033 \begin_layout Description
10034 $$FPath The path part of
10038 (absolute name or relative to the LyX document).
10041 \begin_layout Description
10042 $$AbsPath The absolute file path.
10045 \begin_layout Description
10046 $$RelPathMaster The file path, relative to the master LyX document.
10049 \begin_layout Description
10050 $$RelPathParent The file path, relative to the LyX document.
10053 \begin_layout Description
10054 $$AbsOrRelPathMaster The file path, absolute or relative to the master LyX
10058 \begin_layout Description
10059 $$AbsOrRelPathParent The file path, absolute or relative to the LyX document.
10062 \begin_layout Description
10063 $$Tempname A name and full path to a temporary file which will be automatically
10064 deleted whenever the containing document is closed, or the external material
10068 \begin_layout Description
10070 \begin_inset Quotes eld
10074 \begin_inset Quotes erd
10077 ) This macro will expand to the contents of the file with the name
10084 \begin_layout Description
10085 $$Sysdir This macro will expand to the absolute path of the system directory.
10086 This is typically used to point to the various helper scripts that are
10090 \begin_layout Standard
10091 All path macros contain a trailing directory separator, so you can construct
10093 the absolute filename with
10095 $$AbsPath$$Basename$$Extension
10100 \begin_layout Standard
10101 The macros above are substituted in all commands unless otherwise noted.
10106 supports additionally the following substitutions if they are enabled by
10118 \begin_layout Description
10119 $$ResizeFront The front part of the resize command.
10122 \begin_layout Description
10123 $$ResizeBack The back part of the resize command.
10126 \begin_layout Description
10127 $$RotateFront The front part of the rotation command.
10130 \begin_layout Description
10131 $$RotateBack The back part of the rotation command.
10134 \begin_layout Standard
10135 The value string of the
10139 command supports additionally the following substitutions if they are enabled
10151 \begin_layout Description
10152 $$Clip The clip option.
10155 \begin_layout Description
10156 $$Extra The extra option.
10159 \begin_layout Description
10160 $$Resize The resize option.
10163 \begin_layout Description
10164 $$Rotate The rotation option.
10167 \begin_layout Standard
10168 You may ask why there are so many path macros.
10169 There are mainly two reasons:
10172 \begin_layout Standard
10173 First, relative and absolute file names should remain relative or absolute,
10175 Users may have reasons to prefer either form.
10176 Relative names are useful for portable documents that should work on different
10177 machines, for example.
10178 Absolute names may be required by some programs.
10181 \begin_layout Standard
10182 Second, LaTeX treats relative file names differently than LyX and other
10183 programs in nested included files.
10184 For LyX, a relative file name is always relative to the document that contains
10186 For LaTeX, it is always relative to the master document.
10187 These two definitions are identical if you have only one document, but
10188 differ if you have a master document that includes part documents.
10189 That means that relative filenames must be transformed when presented to
10191 Fortunately LyX does this automatically for you if you choose the right
10195 \begin_layout Standard
10196 So which path macro should be used in new template definitions? The rule
10200 \begin_layout Itemize
10205 if an absolute path is required.
10208 \begin_layout Itemize
10211 $$AbsOrRelPathMaster
10213 if the substituted string is some kind of LaTeX input.
10216 \begin_layout Itemize
10219 $$AbsOrRelPathParent
10221 in order to preserve the user's choice.
10224 \begin_layout Standard
10225 There are special cases where this rule does not work and e.g.\InsetSpace ~
10227 are needed, but normally it will work just fine.
10228 One example for such a case is the command
10230 ReferencedFile latex "$$AbsOrRelPathMaster$$Basename.pstex_t"
10232 in the XFig template above: We can't use the absolute name because the
10237 files needs the relative name in order to rewrite the file content.
10240 \begin_layout Section
10241 Security discussion
10244 \begin_layout Standard
10245 \begin_inset Note Note
10248 \begin_layout Standard
10249 This section is outdated
10254 The external material feature interfaces with a lot of external programs
10255 and does so automatically, so we have to consider the security implications
10257 In particular, since you have the option of including your own filenames
10258 and/or parameter strings and those are expanded into a command, it seems
10259 that it would be possible to create a malicious document which executes
10260 arbitrary commands when a user views or prints the document.
10261 This is something we definately want to avoid.
10264 \begin_layout Standard
10265 However, since the external program commands are specified in the template
10266 configuration file only, there are no security issues if LyX is properly
10267 configured with safe templates only.
10268 This is so because the external programs are invoked with the
10272 -system call rather than the
10276 system-call, so it's not possible to execute arbitrary commands from the
10277 filename or parameter section via the shell.
10280 \begin_layout Standard
10281 This also implies that you are restricted in what command strings you can
10282 use in the external material templates.
10283 In particular, pipes and redirection are not readily available.
10284 This has to be so if LyX should remain safe.
10285 If you want to use some of the shell features, you should write a safe
10286 script to do this in a controlled manner, and then invoke the script from
10287 the command string.
10292 directory of the LyX installation, you can find a safe wrapper script
10294 general_command_wrapper.py
10296 that supports redirection of input and output.
10297 That can serve as an example for how to write safe template scripts.
10298 For a more advanced example that uses
10302 and friends, take a look at the
10309 \begin_layout Standard
10310 It is possible to design a template that interacts directly with the shell,
10311 but since this would allow a malicious user to execute arbitrary commands
10312 by writing clever filenames and/or parameters, we generally recommend that
10313 you only use safe scripts that work with the
10317 system call in a controlled manner.
10318 Of course, for use in a controlled environment, it can be tempting to just
10319 fall back to use ordinary shell scripts.
10320 If you do so, be aware that you
10324 provide an easily exploitable security hole in your system.
10325 Of course it stands to reason that such unsafe templates will never be
10326 included in the standard LyX distribution, although we do encourage people
10327 to submit new templates in the open source tradition.
10328 But LyX as shipped from the official distribution channels will never have
10332 \begin_layout Standard
10333 Including external material provides a lot of power, and you have to be
10334 careful not to introduce security hazards with this power.
10335 A subtle error in a single line in an innocent looking script can open
10336 the door to huge security problems.
10337 So if you do not fully understand the issues, we recommend that you consult
10338 a knowledgable security professional or the LyX development team if you
10339 have any questions about whether a given template is safe or not.
10340 And do this before you use it in an uncontrolled environment.
10343 \begin_layout Chapter
10347 \begin_layout Section
10351 \begin_layout Standard
10352 The LyX server is a method implemented in LyX that will enable other programs
10353 to talk to LyX, invoke LyX commands, and retrieve information about the
10354 LyX internal state.
10355 This is only intended for advanced users, but they should find it useful.
10358 \begin_layout Section
10359 Starting the LyX Server
10362 \begin_layout Standard
10363 The LyX server works through the use of a pair of named pipes.
10364 These are usually located in your home directory and have the names
10365 \begin_inset Quotes eld
10373 \begin_inset Quotes erd
10377 \begin_inset Quotes eld
10385 \begin_inset Quotes erd
10389 External programs write into
10393 and read back data from
10398 The stem of the pipe names can be defined in the
10403 ools\SpecialChar \menuseparator
10410 dialog, for example
10412 "/home/myhome/.lyxpipe"
10417 \begin_layout Standard
10426 ' to create the pipes.
10427 The above setting also has the effect of activating the LyX server.
10428 If one of the pipes already exists, LyX will assume that another LyX process
10429 is already running and will not start the server.
10430 To have several LyX processes with servers at the same time, you have to
10431 change the configuration between the start of the programs.
10434 \begin_layout Standard
10435 If you are developing a client program, you might find it useful to enable
10436 debugging information from the LyX server.
10437 Do this by starting LyX as
10439 lyx -dbg lyxserver.
10442 \begin_layout Standard
10443 Warning: if LyX crashes, it may not manage to remove the pipes; in this
10444 case you must remove them manually.
10445 If LyX starts and the pipes exist already, it will not start any server.
10448 \begin_layout Standard
10449 Other than this, there are a few points to consider:
10452 \begin_layout Itemize
10453 Both server and clients must run on UNIX or OS/2 machines.
10454 Communications between LyX on UNIX and clients on OS/2 or vice versa is
10455 not possible right now.
10458 \begin_layout Itemize
10459 On OS/2, only one client can connect to LyXServer at a time.
10462 \begin_layout Itemize
10463 On OS/2, clients must open inpipe with
10470 \begin_layout Standard
10471 You can find a complete example client written in C in the source distribution
10474 development/server_monitor.c
10479 \begin_layout Section
10480 Normal communication
10483 \begin_layout Standard
10484 To issue a LyX call, the client writes a line of ASCII text into the input
10486 This line has the following format:
10489 \begin_layout Quote
10503 \begin_layout Standard
10508 is a name that the client can choose arbitrarily.
10509 Its only use is that LyX will echo it if it sends an answer - so a client
10510 can dispatch results from different requesters.
10513 \begin_layout Standard
10518 is the function you want LyX to perform.
10519 It is the same as the commands you'd use in the minibuffer.
10522 \begin_layout Standard
10527 is an optional argument which is meaningful only to some functions (for
10529 \begin_inset Quotes eld
10533 \begin_inset Quotes erd
10536 which will insert the argument as text at the cursor position.)
10539 \begin_layout Standard
10540 The answer from LyX will arrive in the output pipe and be of the form
10543 \begin_layout Quote
10557 \begin_layout Standard
10566 are just echoed from the command request, while
10570 is more or less useful information filled according to how the command
10571 execution worked out.
10572 Some commands will return information about the internal state of LyX,
10574 \begin_inset Quotes eld
10578 \begin_inset Quotes erd
10581 , while other will return an empty data-response.
10582 This means that the command execution went fine.
10585 \begin_layout Standard
10586 In case of errors, the response from LyX will have this form
10589 \begin_layout Quote
10603 \begin_layout Standard
10608 should contain an explanation of why the command failed.
10611 \begin_layout Standard
10615 \begin_layout LyX-Code
10616 echo "LYXCMD:test:beginning-of-buffer:" >~/.lyxpipe.in
10619 \begin_layout LyX-Code
10620 echo "LYXCMD:test:get-xy:" >~/.lyxpipe.in
10622 read a <~/.lyxpipe.out
10627 \begin_layout Section
10631 \begin_layout Standard
10632 LyX can notify clients of events going on asynchronously.
10633 Currently it will only do this if the user binds a key sequence with the
10635 \begin_inset Quotes eld
10639 \begin_inset Quotes erd
10643 The format of the string LyX sends is as follows:
10646 \begin_layout Quote
10655 \begin_layout Standard
10660 is the printed representation of the key sequence that was actually typed
10664 \begin_layout Standard
10665 This mechanism can be used to extend LyX's command set and implement macros:
10666 bind some key sequence to
10667 \begin_inset Quotes eld
10671 \begin_inset Quotes erd
10674 , start a client that listens on the out pipe, dispatches the command according
10675 to the sequence and starts a function that may use LyX calls and LyX requests
10676 to issue a command or a series of commands to LyX.
10679 \begin_layout Section
10680 The simple LyX Server Protocol
10683 \begin_layout Standard
10684 LyX implements a simple protocol that can be used for session management.
10685 All messages are of the form
10688 \begin_layout Quote
10698 \begin_layout Standard
10704 \begin_inset Quotes eld
10708 \begin_inset Quotes erd
10712 \begin_inset Quotes eld
10716 \begin_inset Quotes erd
10721 \begin_inset Quotes eld
10725 \begin_inset Quotes erd
10728 is received from a client, LyX will report back to inform the client that
10729 it's listening to it's messages, while
10730 \begin_inset Quotes eld
10734 \begin_inset Quotes erd
10737 sent from LyX will inform clients that LyX is closing.
10740 \begin_layout Chapter
10745 \begin_layout Standard
10746 This appendix is a huge cross-reference to all the English language keybindings.
10747 Originally, we simply wanted to list all of the key bindings followed by
10748 the function it's bound to.
10749 That way, a user can look up a key to find out what it does.
10750 We then decided, what the hey, why not include the default toolbar and
10751 menu bindings, too.
10752 Please note this section is likely to be very out of date.
10755 \begin_layout Standard
10756 The form is really self-explanatory, but here are a few tips: all entries
10757 are arranged roughly alphabetically for a given modifier (
10766 For the general keyboard layout, simpler prefixes precede the more complex
10776 All entries were gleaned from the default user interface and binding files
10777 located in the directories
10779 \SpecialChar \ldots{}
10784 \SpecialChar \ldots{}
10787 ; they should be treated as the final word on the bindings.
10790 \begin_layout Standard
10791 As a final note, be aware that some window managers (such as FVWM) take
10792 control of some of the function keys or motion keys.
10797 is listed here as generating
10801 , but FVWM grabs it and uses it to change virtual desktops instead.
10802 Very annoying unless you instruct your window manager to stop intercepting
10806 \begin_layout Section
10810 \begin_layout LyX-Code
10814 \begin_layout LyX-Code
10818 \begin_layout LyX-Code
10822 \begin_layout LyX-Code
10823 Icon "buffer-write"
10826 \begin_layout LyX-Code
10827 Icon "buffer-print"
10830 \begin_layout LyX-Code
10834 \begin_layout LyX-Code
10838 \begin_layout LyX-Code
10842 \begin_layout LyX-Code
10846 \begin_layout LyX-Code
10850 \begin_layout LyX-Code
10854 \begin_layout LyX-Code
10858 \begin_layout LyX-Code
10862 \begin_layout LyX-Code
10866 \begin_layout LyX-Code
10870 \begin_layout LyX-Code
10874 \begin_layout LyX-Code
10878 \begin_layout LyX-Code
10879 Icon "footnote-insert"
10882 \begin_layout LyX-Code
10883 Icon "marginpar-insert"
10886 \begin_layout LyX-Code
10890 \begin_layout LyX-Code
10894 \begin_layout LyX-Code
10895 Icon "figure-insert"
10898 \begin_layout LyX-Code
10899 Icon "dialog-tabular-insert"
10902 \begin_layout LyX-Code
10906 \begin_layout Section
10910 \begin_layout Standard
10911 Note that the following bindings are for LyX with English menus.
10912 The second character of the binding depends on the menu language.
10914 \begin_inset Quotes eld
10922 \begin_inset Quotes erd
10925 is with German menus
10926 \begin_inset Quotes eld
10934 \begin_inset Quotes erd
10938 To find out the shortcuts of your language press the Meta (Alt)-key and
10939 press then the keys of the underlined characters of the menu names.
10942 \begin_layout Subsection
10947 \labelwidthstring 00.00.0000
10959 \labelwidthstring 00.00.0000
10971 \labelwidthstring 00.00.0000
10983 \labelwidthstring 00.00.0000
10997 \labelwidthstring 00.00.0000
11009 \labelwidthstring 00.00.0000
11023 \labelwidthstring 00.00.0000
11035 \labelwidthstring 00.00.0000
11047 \labelwidthstring 00.00.0000
11059 \labelwidthstring 00.00.0000
11071 \labelwidthstring 00.00.0000
11079 buffer-new-template
11083 \labelwidthstring 00.00.0000
11098 \labelwidthstring 00.00.0000
11109 \labelwidthstring 00.00.0000
11120 \labelwidthstring 00.00.0000
11131 \labelwidthstring 00.00.0000
11142 \labelwidthstring 00.00.0000
11153 \labelwidthstring 00.00.0000
11165 \labelwidthstring 00.00.0000
11176 \begin_layout Subsection
11181 \labelwidthstring 00.00.0000
11193 \labelwidthstring 00.00.0000
11205 \labelwidthstring 00.00.0000
11217 \labelwidthstring 00.00.0000
11229 \labelwidthstring 00.00.0000
11241 \labelwidthstring 00.00.0000
11253 \labelwidthstring 00.00.0000
11268 \labelwidthstring 00.00.0000
11275 tabular-feature append-row
11279 \labelwidthstring 00.00.0000
11286 tabular-feature toggle-line-bottom
11290 \labelwidthstring 00.00.0000
11297 tabular-feature align-center
11301 \labelwidthstring 00.00.0000
11308 tabular-feature delete-column
11312 \labelwidthstring 00.00.0000
11319 tabular-feature align-left
11323 \labelwidthstring 00.00.0000
11330 tabular-feature align-right
11334 \labelwidthstring 00.00.0000
11341 tabular-feature toggle-line-left
11345 \labelwidthstring 00.00.0000
11352 tabular-feature multicolumn
11356 \labelwidthstring 00.00.0000
11363 tabular-feature valign-center
11367 \labelwidthstring 00.00.0000
11374 tabular-feature valign-top
11378 \labelwidthstring 00.00.0000
11385 tabular-feature toggle-line-right
11389 \labelwidthstring 00.00.0000
11396 tabular-feature toggle-line-top
11400 \labelwidthstring 00.00.0000
11407 tabular-feature append-column
11411 \labelwidthstring 00.00.0000
11418 tabular-feature valign-bottom
11422 \labelwidthstring 00.00.0000
11429 tabular-feature delete-row
11434 \labelwidthstring 00.00.0000
11447 \labelwidthstring 00.00.0000
11454 floats-operate openfoot
11458 \labelwidthstring 00.00.0000
11465 floats-operate closefoot
11469 \labelwidthstring 00.00.0000
11476 floats-operate openfig
11480 \labelwidthstring 00.00.0000
11491 \labelwidthstring 00.00.0000
11502 \labelwidthstring 00.00.0000
11509 floats-operate closefig
11514 \labelwidthstring 00.00.0000
11526 \labelwidthstring 00.00.0000
11540 \labelwidthstring 00.00.0000
11552 \labelwidthstring 00.00.0000
11564 \labelwidthstring 00.00.0000
11578 \labelwidthstring 00.00.0000
11590 \labelwidthstring 00.00.0000
11605 \labelwidthstring 00.00.0000
11612 primary-selection-paste
11616 \labelwidthstring 00.00.0000
11623 primary-selection-paste paragraph
11627 \begin_layout Subsection
11632 \labelwidthstring 00.00.0000
11647 \labelwidthstring 00.00.0000
11654 buffer-float-insert algorithm
11658 \labelwidthstring 00.00.0000
11665 buffer-float-insert wide-tab
11669 \labelwidthstring 00.00.0000
11676 buffer-float-insert figure
11680 \labelwidthstring 00.00.0000
11687 buffer-float-insert table
11691 \labelwidthstring 00.00.0000
11698 buffer-float-insert wide-fig
11703 \labelwidthstring 00.00.0000
11711 dialog-tabular-insert
11715 \labelwidthstring 00.00.0000
11727 \labelwidthstring 00.00.0000
11739 \labelwidthstring 00.00.0000
11747 buffer-child-insert
11751 \labelwidthstring 00.00.0000
11763 \labelwidthstring 00.00.0000
11775 \labelwidthstring 00.00.0000
11787 \labelwidthstring 00.00.0000
11799 \labelwidthstring 00.00.0000
11811 \labelwidthstring 00.00.0000
11823 \labelwidthstring 00.00.0000
11835 \labelwidthstring 00.00.0000
11850 \labelwidthstring 00.00.0000
11861 \labelwidthstring 00.00.0000
11872 \labelwidthstring 00.00.0000
11883 \labelwidthstring 00.00.0000
11894 \labelwidthstring 00.00.0000
11905 \labelwidthstring 00.00.0000
11917 \labelwidthstring 00.00.0000
11929 \labelwidthstring 00.00.0000
11944 \labelwidthstring 00.00.0000
11951 protected-space-insert
11955 \labelwidthstring 00.00.0000
11962 end-of-sentence-period-insert
11966 \labelwidthstring 00.00.0000
11977 \labelwidthstring 00.00.0000
11988 \labelwidthstring 00.00.0000
11999 \labelwidthstring 00.00.0000
12006 menu-separator-insert
12010 \labelwidthstring 00.00.0000
12017 hyphenation-point-insert
12021 \labelwidthstring 00.00.0000
12032 \labelwidthstring 00.00.0000
12039 command-sequence math-insert ^;math-mode;
12043 \labelwidthstring 00.00.0000
12050 command-sequence math-insert _;math-mode;
12055 \labelwidthstring 00.00.0000
12070 \labelwidthstring 00.00.0000
12077 file-insert-plaintext lines
12081 \labelwidthstring 00.00.0000
12088 file-insert-plaintext paragraphs
12092 \labelwidthstring 00.00.0000
12104 \labelwidthstring 00.00.0000
12116 \labelwidthstring 00.00.0000
12128 \labelwidthstring 00.00.0000
12139 \begin_layout Subsection
12144 \labelwidthstring 00.00.0000
12156 \labelwidthstring 00.00.0000
12168 \labelwidthstring 00.00.0000
12180 \labelwidthstring 00.00.0000
12192 \labelwidthstring 00.00.0000
12204 \labelwidthstring 00.00.0000
12216 \labelwidthstring 00.00.0000
12228 \labelwidthstring 00.00.0000
12240 \labelwidthstring 00.00.0000
12248 layout-save-default
12252 \labelwidthstring 00.00.0000
12264 \labelwidthstring 00.00.0000
12276 \labelwidthstring 00.00.0000
12287 \begin_layout Subsubsection
12290 Layout\SpecialChar \menuseparator
12297 \labelwidthstring 00.00.0000
12309 \labelwidthstring 00.00.0000
12321 \labelwidthstring 00.00.0000
12333 \labelwidthstring 00.00.0000
12345 \labelwidthstring 00.00.0000
12357 \labelwidthstring 00.00.0000
12369 \labelwidthstring 00.00.0000
12381 \labelwidthstring 00.00.0000
12393 \labelwidthstring 00.00.0000
12405 \labelwidthstring 00.00.0000
12417 \labelwidthstring 00.00.0000
12429 \labelwidthstring 00.00.0000
12441 \labelwidthstring 00.00.0000
12453 \labelwidthstring 00.00.0000
12465 \labelwidthstring 00.00.0000
12477 \labelwidthstring 00.00.0000
12489 \labelwidthstring 00.00.0000
12501 \labelwidthstring 00.00.0000
12513 \labelwidthstring 00.00.0000
12525 \labelwidthstring 00.00.0000
12537 \labelwidthstring 00.00.0000
12549 \labelwidthstring 00.00.0000
12561 \labelwidthstring 00.00.0000
12573 \labelwidthstring 00.00.0000
12585 \labelwidthstring 00.00.0000
12597 \labelwidthstring 00.00.0000
12609 \labelwidthstring 00.00.0000
12621 \labelwidthstring 00.00.0000
12633 \labelwidthstring 00.00.0000
12645 \labelwidthstring 00.00.0000
12657 \labelwidthstring 00.00.0000
12669 \labelwidthstring 00.00.0000
12680 \begin_layout Subsection
12684 \begin_layout Subsection
12688 \begin_layout Subsection
12692 \begin_layout Subsection
12697 \labelwidthstring 00.00.0000
12709 \labelwidthstring 00.00.0000
12721 \labelwidthstring 00.00.0000
12733 \labelwidthstring 00.00.0000
12745 \labelwidthstring 00.00.0000
12757 \labelwidthstring 00.00.0000
12765 layout ShortFoilhead
12769 \labelwidthstring 00.00.0000
12781 \labelwidthstring 00.00.0000
12793 \labelwidthstring 00.00.0000
12805 \labelwidthstring 00.00.0000
12817 \labelwidthstring 00.00.0000
12825 layout ShortRotatefoilhead
12829 \labelwidthstring 00.00.0000
12841 \labelwidthstring 00.00.0000
12853 \labelwidthstring 00.00.0000
12865 \labelwidthstring 00.00.0000
12873 drop-layouts-choice
12877 \labelwidthstring 00.00.0000
12892 \labelwidthstring 00.00.0000
12907 \labelwidthstring 00.00.0000
12919 \labelwidthstring 00.00.0000
12931 \labelwidthstring 00.00.0000
12939 layout Subsubsection
12943 \labelwidthstring 00.00.0000
12955 \labelwidthstring 00.00.0000
12963 layout Subparagraph
12967 \labelwidthstring 00.00.0000
12971 asterisk\InsetSpace ~
12980 \labelwidthstring 00.00.0000
12984 asterisk\InsetSpace ~
12993 \labelwidthstring 00.00.0000
12997 asterisk\InsetSpace ~
13006 \labelwidthstring 00.00.0000
13010 asterisk\InsetSpace ~
13019 \labelwidthstring 00.00.0000
13023 asterisk\InsetSpace ~
13028 layout Subsubsection*
13032 \labelwidthstring 00.00.0000
13036 asterisk\InsetSpace ~
13045 \labelwidthstring 00.00.0000
13049 asterisk\InsetSpace ~
13054 layout Subparagraph*
13058 \labelwidthstring 00.00.0000
13070 \labelwidthstring 00.00.0000
13078 layout Bibliography
13082 \labelwidthstring 00.00.0000
13094 \labelwidthstring 00.00.0000
13106 \labelwidthstring 00.00.0000
13118 \labelwidthstring 00.00.0000
13130 \labelwidthstring 00.00.0000
13142 \labelwidthstring 00.00.0000
13150 layout Rotatefoilhead
13154 \labelwidthstring 00.00.0000
13162 layout RightAddress
13166 \labelwidthstring 00.00.0000
13178 \labelwidthstring 00.00.0000
13190 \labelwidthstring 00.00.0000
13202 \labelwidthstring 00.00.0000
13213 \begin_layout Standard
13214 These ones are kept for backwards compatibility, but only make sense on
13219 \labelwidthstring 00.00.0000
13231 \labelwidthstring 00.00.0000
13239 layout Subsubsection*
13243 \labelwidthstring 00.00.0000
13254 \begin_layout Section
13258 \begin_layout Subsection
13265 \labelwidthstring 00.00.0000
13276 \labelwidthstring 00.00.0000
13287 \labelwidthstring 00.00.0000
13298 \labelwidthstring 00.00.0000
13309 \labelwidthstring 00.00.0000
13320 \labelwidthstring 00.00.0000
13331 \labelwidthstring 00.00.0000
13338 hyphenation-point-insert
13342 \labelwidthstring 00.00.0000
13353 \labelwidthstring 00.00.0000
13360 line-delete-forward
13364 \labelwidthstring 00.00.0000
13375 \labelwidthstring 00.00.0000
13386 \labelwidthstring 00.00.0000
13397 \labelwidthstring 00.00.0000
13408 \labelwidthstring 00.00.0000
13419 \labelwidthstring 00.00.0000
13430 \labelwidthstring 00.00.0000
13441 \labelwidthstring 00.00.0000
13452 \labelwidthstring 00.00.0000
13463 \labelwidthstring 00.00.0000
13474 \labelwidthstring 00.00.0000
13485 \labelwidthstring 00.00.0000
13496 \labelwidthstring 00.00.0000
13508 \labelwidthstring 00.00.0000
13520 \labelwidthstring 00.00.0000
13532 \labelwidthstring 00.00.0000
13544 \labelwidthstring 00.00.0000
13557 \labelwidthstring 00.00.0000
13569 \labelwidthstring 00.00.0000
13581 \labelwidthstring 00.00.0000
13593 \labelwidthstring 00.00.0000
13605 \labelwidthstring 00.00.0000
13618 \labelwidthstring 00.00.0000
13630 \labelwidthstring 00.00.0000
13642 \labelwidthstring 00.00.0000
13655 \labelwidthstring 00.00.0000
13668 \labelwidthstring 00.00.0000
13681 \labelwidthstring 00.00.0000
13694 \labelwidthstring 00.00.0000
13707 \labelwidthstring 00.00.0000
13720 \labelwidthstring 00.00.0000
13732 \labelwidthstring 00.00.0000
13744 \labelwidthstring 00.00.0000
13756 \labelwidthstring 00.00.0000
13764 menu-open Documents
13768 \labelwidthstring 00.00.0000
13780 \labelwidthstring 00.00.0000
13792 \labelwidthstring 00.00.0000
13804 \labelwidthstring 00.00.0000
13816 \labelwidthstring 00.00.0000
13828 \labelwidthstring 00.00.0000
13836 buffer-toggle-read-only
13840 \labelwidthstring 00.00.0000
13852 \labelwidthstring 00.00.0000
13864 \labelwidthstring 00.00.0000
13876 \labelwidthstring 00.00.0000
13887 \labelwidthstring 00.00.0000
13898 \labelwidthstring 00.00.0000
13909 \labelwidthstring 00.00.0000
13920 \labelwidthstring 00.00.0000
13931 \labelwidthstring 00.00.0000
13942 \labelwidthstring 00.00.0000
13953 \labelwidthstring 00.00.0000
13964 \labelwidthstring 00.00.0000
13975 \labelwidthstring 00.00.0000
13986 \labelwidthstring 00.00.0000
13997 \labelwidthstring 00.00.0000
14008 \labelwidthstring 00.00.0000
14019 \labelwidthstring 00.00.0000
14030 \labelwidthstring 00.00.0000
14037 word-delete-forward
14041 \labelwidthstring 00.00.0000
14048 word-delete-backward
14052 \labelwidthstring 00.00.0000
14063 \labelwidthstring 00.00.0000
14070 end-of-sentence-period-insert
14074 \labelwidthstring 00.00.0000
14081 protected-space-insert
14085 \labelwidthstring 00.00.0000
14096 \labelwidthstring 00.00.0000
14107 \labelwidthstring 00.00.0000
14118 \labelwidthstring 00.00.0000
14129 \labelwidthstring 00.00.0000
14140 \labelwidthstring 00.00.0000
14151 \labelwidthstring 00.00.0000
14158 buffer-begin-select
14162 \labelwidthstring 00.00.0000
14173 \labelwidthstring 00.00.0000
14180 paragraph-up-select
14184 \labelwidthstring 00.00.0000
14191 paragraph-down-select
14195 \labelwidthstring 00.00.0000
14202 word-backward-select
14206 \labelwidthstring 00.00.0000
14213 word-forward-select
14217 \labelwidthstring 00.00.0000
14228 \labelwidthstring 00.00.0000
14235 word-delete-forward
14239 \labelwidthstring 00.00.0000
14250 \labelwidthstring 00.00.0000
14261 \labelwidthstring 00.00.0000
14272 \labelwidthstring 00.00.0000
14283 \labelwidthstring 00.00.0000
14290 break-paragraph-keep-layout
14294 \labelwidthstring 00.00.0000
14304 \begin_layout Subsection
14311 \labelwidthstring 00.00.0000
14322 \labelwidthstring 00.00.0000
14333 \labelwidthstring 00.00.0000
14344 \labelwidthstring 00.00.0000
14355 \labelwidthstring 00.00.0000
14366 \labelwidthstring 00.00.0000
14377 \labelwidthstring 00.00.0000
14388 \labelwidthstring 00.00.0000
14399 \labelwidthstring 00.00.0000
14410 \labelwidthstring 00.00.0000
14421 \labelwidthstring 00.00.0000
14432 \labelwidthstring 00.00.0000
14443 \labelwidthstring 00.00.0000
14454 \labelwidthstring 00.00.0000
14465 \labelwidthstring 00.00.0000
14476 \labelwidthstring 00.00.0000
14487 \labelwidthstring 00.00.0000
14498 \labelwidthstring 00.00.0000
14509 \labelwidthstring 00.00.0000
14520 \labelwidthstring 00.00.0000
14531 \labelwidthstring 00.00.0000
14542 \labelwidthstring 00.00.0000
14553 \labelwidthstring 00.00.0000
14560 protected-space-insert
14564 \labelwidthstring 00.00.0000
14575 \labelwidthstring 00.00.0000
14586 \labelwidthstring 00.00.0000
14597 \labelwidthstring 00.00.0000
14604 buffer-new-template
14608 \labelwidthstring 00.00.0000
14619 \labelwidthstring 00.00.0000
14630 \labelwidthstring 00.00.0000
14641 \labelwidthstring 00.00.0000
14652 \labelwidthstring 00.00.0000
14663 \labelwidthstring 00.00.0000
14674 \labelwidthstring 00.00.0000
14685 \labelwidthstring 00.00.0000
14692 end-of-sentence-period-insert
14696 \labelwidthstring 00.00.0000
14707 \labelwidthstring 00.00.0000
14718 \labelwidthstring 00.00.0000
14725 hyphenation-point-insert
14729 \labelwidthstring 00.00.0000
14740 \labelwidthstring 00.00.0000
14747 protected-space-insert
14751 \labelwidthstring 00.00.0000
14762 \labelwidthstring 00.00.0000
14773 \labelwidthstring 00.00.0000
14784 \labelwidthstring 00.00.0000
14795 \labelwidthstring 00.00.0000
14806 \labelwidthstring 00.00.0000
14817 \labelwidthstring 00.00.0000
14828 \labelwidthstring 00.00.0000
14839 \labelwidthstring 00.00.0000
14850 \labelwidthstring 00.00.0000
14861 \labelwidthstring 00.00.0000
14872 \labelwidthstring 00.00.0000
14883 \labelwidthstring 00.00.0000
14894 \labelwidthstring 00.00.0000
14905 \labelwidthstring 00.00.0000
14916 \labelwidthstring 00.00.0000
14923 word-delete-forward
14927 \labelwidthstring 00.00.0000
14934 word-delete-backward
14938 \labelwidthstring 00.00.0000
14949 \labelwidthstring 00.00.0000
14960 \labelwidthstring 00.00.0000
14971 \labelwidthstring 00.00.0000
14982 \labelwidthstring 00.00.0000
14989 paragraph-down-select
14993 \labelwidthstring 00.00.0000
15004 \labelwidthstring 00.00.0000
15011 buffer-begin-select
15015 \labelwidthstring 00.00.0000
15022 word-backward-select
15026 \labelwidthstring 00.00.0000
15033 word-forward-select
15037 \labelwidthstring 00.00.0000
15044 paragraph-up-select
15048 \labelwidthstring 00.00.0000
15059 \labelwidthstring 00.00.0000
15066 break-paragraph-keep-layout
15070 \labelwidthstring 00.00.0000
15081 \labelwidthstring 00.00.0000
15092 \labelwidthstring 00.00.0000
15103 \labelwidthstring 00.00.0000
15114 \labelwidthstring 00.00.0000
15125 \labelwidthstring 00.00.0000
15136 \labelwidthstring 00.00.0000
15147 \labelwidthstring 00.00.0000
15158 \labelwidthstring 00.00.0000
15169 \labelwidthstring 00.00.0000
15180 \labelwidthstring 00.00.0000
15190 \begin_layout Subsection
15196 \begin_layout Standard
15197 These are LyX keyboard definitions for mathematics, similar to those of
15201 \begin_layout Standard
15202 The bindings file and the present documentation were prepared by Serge Winitzki
15203 with assistance from Jean-Marc Lasgouttes.
15204 Version 1.3, for LyX 1.2.x and 1.3.x.
15207 \begin_layout Standard
15208 These definitions make it a lot easier to type equations without using the
15209 mouse, especially for people familiar with Scientific Word.
15210 The standard LyX bindings such as
15221 \begin_layout Standard
15222 Tip: to find the "LyX bind name" for a key, look at the status bar after
15223 typing some non-existent key combination.
15225 to find how "Ctrl-&" is referenced, press Ctrl-S and then Ctrl-&: the status
15226 bar shows "C-s S-C-ampersand." (This does not work in LyX 1.3.0!)
15230 \labelwidthstring 00.00.0000
15239 -- Copy, cut, paste is as in Sciword,
15255 \labelwidthstring 00.00.0000
15264 -- Display equation toggle: type
15268 to insert a displayed formula (
15273 \begin_inset Quotes eld
15277 \begin_inset Quotes erd
15285 in a displayed formula to convert it back to an inline formula.
15289 \labelwidthstring 00.00.0000
15304 to insert a fraction (
15309 \begin_inset Quotes eld
15313 \begin_inset Quotes erd
15317 You can also select an expression and type
15321 to convert it to the numerator of a fraction.
15330 end of the denominator will delete the numerator and convert the denominator
15335 \labelwidthstring 00.00.0000
15347 \begin_inset Formula $\int$
15355 \begin_inset Quotes eld
15359 \begin_inset Quotes erd
15366 \labelwidthstring 00.00.0000
15373 line-delete-forward
15375 -- Emacs-like binding: delete forward of cursor to end of line.
15379 \labelwidthstring 00.00.0000
15388 -- A text/math toggle (
15393 \begin_inset Quotes eld
15397 \begin_inset Quotes erd
15400 ): switches to math in text mode, and also inserts roman text in math mode.
15410 \begin_inset Quotes eld
15414 \begin_inset Quotes erd
15421 \labelwidthstring 00.00.0000
15430 -- Add/remove numbering in a single equation.
15434 \labelwidthstring 00.00.0000
15443 -- Add/remove numbering at a line in equation arrays.
15446 \begin_layout Standard
15447 The above commands are toggles that control the numbering of equations (
15452 \begin_inset Quotes eld
15456 \begin_inset Quotes erd
15460 Note: when deleting a number in a labeled eqnarray, the label is not really
15461 removed (the TeX code becomes
15462 \begin_inset Quotes eld
15474 \begin_inset Quotes erd
15477 ) and this generates a (harmless) LaTeX warning.
15481 \labelwidthstring 00.00.0000
15490 -- Open a new document.
15495 \labelwidthstring 00.00.0000
15504 -- Insert a quote character " (
15509 \begin_inset Quotes eld
15513 \begin_inset Quotes erd
15518 \begin_inset Quotes eld
15522 \begin_inset Quotes erd
15525 double quote character that you get by default.
15529 \labelwidthstring 00.00.0000
15540 -- Square root sign
15541 \begin_inset Formula $\sqrt{x}$
15549 \begin_inset Quotes eld
15553 \begin_inset Quotes erd
15560 \labelwidthstring 00.00.0000
15572 \begin_inset Formula $\sqrt[n]{x}$
15579 \labelwidthstring 00.00.0000
15588 -- Another binding for a switch between the text and the math mode (
15593 \begin_inset Quotes eld
15597 \begin_inset Quotes erd
15601 Note that the roman text inserted in math mode is special.
15605 \labelwidthstring 00.00.0000
15618 the selected text (text mode only, use things like
15634 \labelwidthstring 00.00.0000
15643 -- W*ndows heritage.
15647 \labelwidthstring 00.00.0000
15656 -- Close the current document (again, a W*ndows heritage).
15660 \labelwidthstring 00.00.0000
15671 \labelwidthstring 00.00.0000
15682 \labelwidthstring 00.00.0000
15692 \begin_inset Quotes eld
15696 \begin_inset Quotes erd
15700 \begin_inset Quotes eld
15704 \begin_inset Quotes erd
15710 \begin_layout Standard
15711 Bracket delimiters: press
15715 -<bracket key> to insert a matching pair of delimiters.
15720 inserts a pair of parentheses
15721 \begin_inset Formula $\left[\right]$
15729 does the same thing.) It will switch to math mode if needed.
15730 The supported characters are ( [ { < |.
15731 It is the same to press the right or the left bracket.
15732 The corresponding delimiters are
15733 \begin_inset Formula $\left(\right)$
15737 \begin_inset Formula $\left[\right]$
15741 \begin_inset Formula $\left\{ \right\} $
15745 \begin_inset Formula $\left\langle \right\rangle $
15749 \begin_inset Formula $\left|\right|$
15754 \begin_inset Quotes eld
15758 \begin_inset Quotes erd
15761 and resize with their contents.
15762 Use Math Panel to get other or non-matching delimiters.
15763 Press backspace on the
15767 delimiter to remove both
15768 \begin_inset Quotes eld
15772 \begin_inset Quotes erd
15775 delimiters without removing their contents.
15779 \labelwidthstring 00.00.0000
15788 -- for convenience, pressing
15802 \labelwidthstring 00.00.0000
15813 \labelwidthstring 00.00.0000
15824 \labelwidthstring 00.00.0000
15835 \labelwidthstring 00.00.0000
15846 \labelwidthstring 00.00.0000
15857 \labelwidthstring 00.00.0000
15864 math-delim langle rangle
15866 -- angular delimiters
15867 \begin_inset Formula $\left\langle \right\rangle $
15870 , not to confuse with ordinary < > signs.
15874 \labelwidthstring 00.00.0000
15881 math-delim langle rangle
15884 \begin_layout Standard
15885 The bar bracket: on some keyboards (e.g.\InsetSpace ~
15886 some British ones), the bar character
15891 -something and on some wayward Unices to "brokenbar".
15892 So we define all of these keys as well.
15896 \labelwidthstring 00.00.0000
15907 \labelwidthstring 00.00.0000
15918 \labelwidthstring 00.00.0000
15929 \labelwidthstring 00.00.0000
15940 \labelwidthstring 00.00.0000
15950 \begin_layout Standard
15951 Accents are in most cases
15955 -<accent key>, e.g.\InsetSpace ~
15969 for tilde (you also need to press
15975 \begin_inset Quotes eld
15987 \begin_inset Quotes erd
15991 Some accents work only in math mode and others only in text mode.
15995 \labelwidthstring 00.00.0000
16004 -- overdot accent, ȧ (text mode only).
16008 \labelwidthstring 00.00.0000
16020 \begin_inset Formula $\dot{a}$
16023 (math mode only -- in physics this denotes a first derivative).
16027 \labelwidthstring 00.00.0000
16038 -- Vector accent over math
16039 \begin_inset Formula $\overrightarrow{x}$
16046 \labelwidthstring 00.00.0000
16055 -- umlaut accent, ä (text mode only)
16059 \labelwidthstring 00.00.0000
16070 -- double dot accent,
16071 \begin_inset Formula $\ddot{a}$
16074 (math mode only -- in physics this denotes a second derivative).
16075 To get a triple dot in math mode, use
16083 \labelwidthstring 00.00.0000
16092 -- grave accent à (text mode only, use
16102 \labelwidthstring 00.00.0000
16111 -- tilde accent ã (text mode only, use
16121 \labelwidthstring 00.00.0000
16130 -- acute accent á (text mode only, use
16140 \labelwidthstring 00.00.0000
16149 -- circumflex (caret) accent â (text mode only, use
16158 \begin_layout Standard
16160 The new key S-F2 for creating a LaTeX file seems handy.
16164 \labelwidthstring 00.00.0000
16173 -- Save current document.
16177 \labelwidthstring 00.00.0000
16184 buffer-export latex
16186 -- Write a LaTeX file for the current document.
16190 \labelwidthstring 00.00.0000
16199 -- Find and replace dialog.
16203 \labelwidthstring 00.00.0000
16220 \labelwidthstring 00.00.0000
16233 to quit LyX is the W*ndows w*ndow manager's mnemonic.
16236 \begin_layout Standard
16245 are used to switch fonts.
16250 to switch back to the normal font.
16251 The non-default font switches
16259 all work as toggles.
16260 They also work on the whole word if you put the cursor in the middle of
16261 the word, or if you select some text.
16265 \labelwidthstring 00.00.0000
16274 -- stop using any special font
16278 \labelwidthstring 00.00.0000
16295 \labelwidthstring 00.00.0000
16312 \labelwidthstring 00.00.0000
16329 \labelwidthstring 00.00.0000
16343 (Used sometimes for people's names.)
16346 \begin_layout Standard
16352 \begin_inset Quotes eld
16356 \begin_inset Quotes erd
16363 key (useful e.g.\InsetSpace ~
16364 if the keyboard has no working
16371 \begin_layout Standard
16372 Here are some Sciword-inspired mnemonics for frequently used math symbols.
16373 Many symbols start with a
16382 cannot be itself bound to anything.
16386 \labelwidthstring 00.00.0000
16398 \begin_inset Quotes eld
16402 \begin_inset Quotes erd
16406 \begin_inset Formula $\prime$
16410 This is frequently unnecessary: in most cases the normal apostrophe works
16413 \begin_inset Formula $x'+2x=0$
16416 , but in some cases this would generate a double superscript error in LaTeX.
16418 \begin_inset Formula $x^{\prime2}$
16422 \begin_inset Formula $x$
16425 prime squared) must be entered with the prime character.
16429 \labelwidthstring 00.00.0000
16437 command-sequence math-superscript; math-insert
16441 -- Insert a prime as a superscript (see example above).
16445 \labelwidthstring 00.00.0000
16454 -- Insert an upper index.
16461 \labelwidthstring 00.00.0000
16470 -- Insert a lower index.
16477 \labelwidthstring 00.00.0000
16489 -- Partial derivative symbol
16490 \begin_inset Formula $\partial$
16497 \labelwidthstring 00.00.0000
16509 -- Summation symbol
16510 \begin_inset Formula $\sum$
16513 (not the same as the Greek letter uppercase Sigma
16514 \begin_inset Formula $\Sigma$
16517 because it can resize and allows smart upper/lower limits).
16521 \labelwidthstring 00.00.0000
16534 \begin_inset Formula $\prod$
16537 (not the same as the Greek letter uppercase Pi,
16538 \begin_inset Formula $\Pi$
16545 \labelwidthstring 00.00.0000
16558 \begin_inset Formula $\infty$
16565 \labelwidthstring 00.00.0000
16578 \begin_inset Formula $\times$
16585 \labelwidthstring 00.00.0000
16595 -- Insert a stacked array
16596 \begin_inset Formula $\begin{array}{c}
16598 \end{array}\end{array}$
16602 (Frequently useful in formulae.)
16606 \labelwidthstring 00.00.0000
16617 \begin_inset Formula $\times$
16621 \begin_inset Formula $\begin{array}{ccc}
16626 (Then you can modify its size using the
16628 Edit\SpecialChar \menuseparator
16635 \labelwidthstring 00.00.0000
16648 \begin_inset Quotes eld
16652 \begin_inset Quotes erd
16656 \begin_inset Formula $\dagger$
16663 \labelwidthstring 00.00.0000
16676 \begin_inset Quotes eld
16680 \begin_inset Quotes erd
16684 \begin_inset Formula $\equiv$
16691 \labelwidthstring 00.00.0000
16703 \begin_inset Quotes eld
16706 Approximate equality
16707 \begin_inset Quotes erd
16711 \begin_inset Formula $\approx$
16718 \labelwidthstring 00.00.0000
16730 \begin_inset Quotes eld
16734 \begin_inset Quotes erd
16738 \begin_inset Formula $\sim$
16745 \labelwidthstring 00.00.0000
16757 \begin_inset Formula $\rightarrow$
16761 \begin_inset Formula $\lim_{x\rightarrow0}$
16768 \labelwidthstring 00.00.0000
16780 \begin_inset Formula $\leq$
16787 \labelwidthstring 00.00.0000
16798 -- Greater-or-equal
16799 \begin_inset Formula $\geq$
16806 \labelwidthstring 00.00.0000
16819 \begin_inset Quotes eld
16823 \begin_inset Quotes erd
16827 \begin_inset Formula $\ll$
16830 (useful in physics)
16834 \labelwidthstring 00.00.0000
16847 \begin_inset Quotes eld
16851 \begin_inset Quotes erd
16855 \begin_inset Formula $\gg$
16861 \begin_layout Subsection
16862 Standard math bindings
16866 \labelwidthstring 00.00.0000
16880 \labelwidthstring 00.00.0000
16892 \labelwidthstring 00.00.0000
16904 \labelwidthstring 00.00.0000
16918 \labelwidthstring 00.00.0000
16930 \labelwidthstring 00.00.0000
16942 \labelwidthstring 00.00.0000
16956 \labelwidthstring 00.00.0000
16968 \labelwidthstring 00.00.0000
16980 \labelwidthstring 00.00.0000
16992 \labelwidthstring 00.00.0000
17006 \labelwidthstring 00.00.0000
17020 \labelwidthstring 00.00.0000
17034 \labelwidthstring 00.00.0000
17048 \labelwidthstring 00.00.0000
17062 \labelwidthstring 00.00.0000
17076 \labelwidthstring 00.00.0000
17088 \labelwidthstring 00.00.0000
17102 \labelwidthstring 00.00.0000
17114 \labelwidthstring 00.00.0000
17126 \labelwidthstring 00.00.0000
17138 \labelwidthstring 00.00.0000
17150 \labelwidthstring 00.00.0000
17164 \labelwidthstring 00.00.0000
17176 \labelwidthstring 00.00.0000
17188 \labelwidthstring 00.00.0000
17200 \labelwidthstring 00.00.0000
17208 math-delim langle rangle
17212 \labelwidthstring 00.00.0000
17220 math-delim rangle langle
17224 \labelwidthstring 00.00.0000
17236 \labelwidthstring 00.00.0000
17250 \labelwidthstring 00.00.0000
17263 \begin_layout Subsection
17268 \labelwidthstring 00.00.0000
17280 \labelwidthstring 00.00.0000
17292 \labelwidthstring 00.00.0000
17304 \labelwidthstring 00.00.0000
17316 \labelwidthstring 00.00.0000