1 #LyX 1.4.0cvs created this file. For more info see http://www.lyx.org/
8 \newcommand{\extratablespace}[1]{\noalign{\vskip#1}}
14 \paperfontsize default
21 \paperorientation portrait
24 \paragraph_separation indent
26 \quotes_language english
29 \paperpagestyle headings
30 \tracking_changes false
45 \begin_layout Standard
47 Principal maintainer of this file is
52 If you have comments or error corrections, please send them to the LyX
53 Documentation mailing list, <lyx-docs@lists.lyx.org>.
61 \begin_layout Standard
62 \begin_inset LatexCommand \tableofcontents{}
73 \begin_layout Standard
78 manual, which you are now reading, is essentially Part II of the
80 User's Guide\SpecialChar \@.
83 The reason for splitting this document is simple: the
87 is already huge, and it contains all of the basic features one needs to
88 know in order to prepare most documents.
89 However, the LyX Team has a long-term goal of making LyX extensible through
90 various configuration files and external packages.
91 That means that if you want to support the Fizzwizzle LaTeX package, you
92 can create a layout file for it without having to alter LyX itself.
93 We've already had contributions of several new features this way.
94 This is the place where all of that gets documented.
97 \begin_layout Standard
98 This manual also documents some special features, like fax support, version
99 control, and SGML support, which require additional software to work properly.
100 Lastly, there's a chapter of LaTeX tools and tips, things you can use to
101 spruce up your documents by directly using the powerful features of LaTeX.
106 only WYSIWYM, and will only ever interface to certain LaTeX features.
109 \begin_layout Standard
110 Of course, with all of this extra documentation,
112 Extended LyX Features
114 may itself grow too big for its britches.
115 In that case, you can just call it the
116 \begin_inset Quotes eld
120 \begin_inset Quotes erd
126 \begin_layout Standard
127 If you haven't read the
131 yet, you are definitely in the wrong manual.
136 is the first place to go, since it will direct you to the correct manual,
137 and it also describes the notation and format of all of the manuals.
138 You should also be thoroughly familiar with the
142 and all of the basic features of LyX.
146 \begin_layout Standard
147 In this document, many sections are independent articles contributed by
148 an individual and are noted as such.
149 This person is generally whoever wrote the layout file for the new document
150 class or LaTeX package, or implemented the feature.
151 If there is no mention of an author to a chapter [or chapter sections],
152 that means it was written by the LyX Documentation Team.
155 \begin_layout Standard
156 Since all the topics in this manual depend heavily on LyX's interaction
157 with LaTeX, this first chapter covers
161 the inner workings of LyX and how to direct LyX to generate exactly the
163 It is obviously for more seasoned LyX users.
166 \begin_layout Chapter
170 \begin_layout Section
174 \begin_layout Standard
175 \begin_inset LatexCommand \label{sec:lyxandlatex}
179 This chapter is for both TeX-nicians and the LaTeX-curious.
180 In it, we'll explain how LyX and LaTeX work together to produce printable
182 This is the only place in any of the manuals where we assume you know something
186 \begin_layout Standard
187 At one time, we called LyX a
188 \begin_inset Quotes eld
191 WYSIWYM frontend to LaTeX,
192 \begin_inset Quotes erd
195 but that's no longer true.
196 There are frontends to LaTeX out there.
197 They are basically editors with the ability to run LaTeX and mark any errors
198 in the file you're editing.
207 run LaTeX, and it also marks errors in the file, it also does much, much
209 Thanks to the WYSIWYM concept, you don't need LaTeX to use LyX effectively.
210 LyX has also added a few extensions to LaTeX.
211 Try the following sometime: select
213 Export\SpecialChar \menuseparator
223 menu, then look at the preamble of the resulting
228 You'll notice a variety of new macros defined specifically by LyX.
229 These macros are defined automatically, according to the features you use
233 \begin_layout Standard
234 There are several commands that automatically invoke LaTeX.
238 \begin_layout Itemize
244 iew\SpecialChar \menuseparator
251 \begin_layout Itemize
257 iew\SpecialChar \menuseparator
262 pdate\SpecialChar \menuseparator
268 \begin_layout Itemize
276 \SpecialChar \menuseparator
282 \begin_layout Itemize
290 \SpecialChar \menuseparator
296 \begin_layout Standard
297 They will only invoke LaTeX if the file has changed since the last time
302 \begin_layout Standard
303 When you run LaTeX on the file you're editing, LyX performs these steps:
306 \begin_layout Enumerate
307 Convert the document to LaTeX and save to a file with the extension
318 \begin_layout Enumerate
323 file (maybe several times).
326 \begin_layout Enumerate
327 If there are any errors, insert error boxes in the document to mark where
329 These boxes are transient and are not saved along with the document.
332 \begin_layout Standard
333 If you've run LaTeX using
355 , LyX performs two more steps:
358 \begin_layout Itemize
363 to convert the Dvi file to PostScript®:
367 \begin_layout Itemize
373 , the output file has the extension
378 \begin_layout Itemize
387 , the output file has the extension
395 \begin_layout Itemize
400 or send the PostScript® file to the printer.
403 \begin_layout Section
404 \begin_inset Quotes eld
407 Help! LyX generated an unreadable
412 \begin_inset Quotes erd
418 \begin_layout Standard
419 Die-hard LaTeX users will scream and howl this into the night, then declare
420 LyX useless, simply because they didn't RTFM.
423 \begin_layout Standard
424 We're going to set the record straight.
425 LyX produces two kinds of LaTeX files.
426 One is human readable.
427 The other is LyX readable.
428 Every time LyX executes LaTeX, it produces a LaTeX file that it can easily
434 file is not human readable.
435 Don't even try to read it.
440 file that you can send to a colleague, select
445 xport\SpecialChar \menuseparator
462 \begin_layout Section
463 Translating LaTeX files into LyX
466 \begin_layout Standard
467 You can import a LaTeX file into LyX by using the
472 ile\SpecialChar \menuseparator
477 mport\SpecialChar \menuseparator
485 This will call a Perl script named
489 ---which will create a file
497 ---and then open that file.
498 If the translation doesn't work, you can try calling
502 from the command line, possibly using fancier options.
505 \begin_layout Standard
510 will translate most legal LaTeX, but not everything.
511 It will leave things it doesn't understand in TeX mode, so after translating
516 , you can look for red text and hand-edit it to look right.
519 \begin_layout Standard
524 has its own section in the
528 manual (as well as a Unix manpage equivalent), which you should read to
529 find out about what LaTeX isn't supported, bugs (and how to get around
530 them), and how to use the various options.
533 \begin_layout Standard
538 to work, or you just want to put a piece of LaTeX code into a LyX file,
540 \begin_inset LatexCommand \ref{sec:latexcodes}
547 \begin_layout Section
548 Inserting LaTeX Code into LyX Documents
549 \begin_inset LatexCommand \label{sec:Inserting-LaTeX-Code}
556 \begin_layout Standard
557 \begin_inset LatexCommand \label{sec:latexcodes}
561 This is a rather important point: You can always insert LaTeX code into
563 LyX simply cannot, and will probably never be able to, display every possible
565 If ever you need to insert LaTeX commands into your LyX document, you can
566 use the ERT box, which you can insert into your document with
571 nsert\SpecialChar \menuseparator
579 The ERT box comes in three forms: collapsed, open, and inlined.
580 The first two are used just like any other collapsable (foldable) box (such
581 as footnotes), and are useful for significant amounts of LaTeX commands.
583 \begin_inset Quotes eld
587 \begin_inset Quotes erd
590 ERT box displays its content as part of the button, and is useful for very
591 short sections of LaTeX commands.
596 \begin_layout Standard
605 \begin_layout Standard
606 You can switch between all three by right-clicking on the ERT.
607 Note that if you want more than one line of LaTeX commands, you cannot
608 use the inlined mode.
611 \begin_layout Standard
612 Here's an example of inserting LaTeX commands in a LyX document.
613 The code looks like this:
616 \begin_layout LyX-Code
625 This is an example for a minipage environment.
628 can put nearly everything in it, even (non-floating)
671 \begin_layout LyX-Code
675 \begin_layout Standard
676 The ERT box containing this text is directly after this paragraph.
677 Those of you reading the manual online will only see a bunch of funky text
679 Those reading a printed version of the manuals will see the actual results:
682 \begin_layout Standard
686 \begin_layout Standard
692 \begin_layout Standard
698 \begin_layout Standard
699 This is an example for a minipage environment.
700 You can put nearly everything in it, even (non-floating) figures and tables.
704 \begin_layout Standard
710 \begin_layout Standard
714 \begin_layout Standard
720 \begin_layout Standard
726 \begin_layout Standard
732 \begin_layout Standard
737 \begin_layout Standard
743 \begin_layout Standard
749 \begin_layout Standard
755 \begin_layout Standard
766 \begin_layout Standard
767 In addition to these two methods, you can also create a separate file containing
768 some complex LaTeX structure.
774 nsert\SpecialChar \menuseparator
782 to include your file (you should select the type
787 We recommend that you only do this if you have a
796 Otherwise, you'll have a big job tracking down LaTeX errors\SpecialChar \ldots{}
800 \begin_layout Standard
801 There are a few last notes to emphasize:
804 \begin_layout Itemize
805 Inside of LyX, LaTeX code appears
810 \begin_layout Itemize
815 check if your LaTeX code is correct.
818 \begin_layout Itemize
819 Beware reinventing the wheel.
822 \begin_layout Standard
823 That last note refers to two things.
824 First, LyX does have quite a few features tucked into it, and more are
826 Be sure to check the manuals to make sure that LyX doesn't have such-and-such
827 feature before you go off merrily coding LaTeX.
828 Second, there are numerous LaTeX packages out there to do all sorts of
829 things, from labels to envelopes to fancy multipage tables.
830 Check out a CTAN site for details (see Section
831 \begin_inset Quotes eld
835 \begin_inset Quotes erd
846 \begin_layout Standard
851 : I seem to do this an awful lot.
852 Sat down and merrily began coding something to print out labels, only to
853 learn that there were already 2 different LaTeX packages to do this.
854 Worse yet --- I had them already!
862 \begin_layout Standard
863 If you do need to do some wild and fancy things within your document, be
864 sure to check out a good LaTeX book for assistance.
865 There are a number of them listed in the bibliography of the
872 \begin_layout Standard
873 There are a number of LaTeX commands which have to be placed before the
874 beginning of the actual text.
875 They go into the preamble, and this is explained in the next section.
878 \begin_layout Section
879 LyX and the LaTeX Preamble
882 \begin_layout Subsection
883 About the LaTeX Preamble
886 \begin_layout Standard
887 \begin_inset LatexCommand \label{sec:preamble}
891 If you already know LaTeX, there is no need to explain here what the preamble
893 If you don't, the following will give you some ideas --- we recommend again
894 that you consult a LaTeX book for further information.
895 In any case, you should read the points below, because they explain what
896 you can do and what you don't need to do in the LaTeX preamble of a LyX
900 \begin_layout Standard
901 The LaTeX preamble comes at the very beginning of a document,
909 \begin_layout Itemize
910 declare the document class.
911 LyX already does this for you.
915 \begin_layout Standard
916 If you're a seasoned LaTeX-nician, and you have some custom document class
917 you want to use, check out the
921 for information on how to make LyX interface to it.
922 Be sure to submit your efforts to the LyX Team for inclusion in future
927 \begin_layout Itemize
928 declare the usage of packages.
929 LaTeX packages provide special commands, which are only available within
930 a document when the package has been declared in the preamble.
939 forces all paragraphs to be indented.
940 There are other packages for labels, envelopes, margins, etc.
944 \begin_layout Itemize
945 set counters, variables, lengths and widths.
946 There are several LaTeX counters and variables which
950 be set globally from within the preamble in order to have the desired effect.
951 [There are other variables which you can set and reset inside the document,
952 too.] Margins are a good example of something which must be set in the preamble.
953 Another example is the label format for lists.
954 You can actually set these just about anywhere, but it's best to do it
955 just once, inside the preamble.
958 \begin_layout Itemize
959 declare user defined commands [with
971 ], mostly abbreviations for LaTeX commands which appear very often inside
973 Although the preamble is a good place to declare such commands, they
977 be declared anywhere else [but
981 they are used for the first time, of course\SpecialChar \ldots{}
983 This can be useful if there is a lot of raw LaTeX code in your document,
984 which normally should not be the case.
987 \begin_layout Standard
988 LyX adds its own set of definitions to the preamble of the
993 This makes LaTeX files generated by LyX portable.
996 \begin_layout Subsection
997 Changing the Preamble
1000 \begin_layout Standard
1001 The commands which LyX adds to the preamble of a LaTeX file are fixed; you
1002 can't change them without patching LyX itself.
1003 You can, however, add your own stuff to the preamble.
1004 There are two ways to do this:
1007 \begin_layout Enumerate
1034 \SpecialChar \menuseparator
1042 dialog, depending on your frontend.
1043 Note that the LyX keybindings will not work in this dialog, alas.
1046 \begin_layout Enumerate
1047 Use the preamble contents you've added as your default template (see
1048 \begin_inset Quotes eld
1052 \begin_inset Quotes erd
1059 ), so that it will be the default preamble for any file you create.
1062 \begin_layout Standard
1063 LyX adds anything in the
1070 dialog to its own built-in preamble.
1071 Before adding your own declarations in the preamble, you should make sure
1072 that LyX doesn't already support what you want to do (remember what we
1073 said about reinventing the wheel?).
1076 make sure your preamble code is correct
1079 LyX doesn't check it.
1082 \begin_layout Subsection
1086 \begin_layout Standard
1087 Here are some examples of what you can add to a preamble, and what they
1091 \begin_layout Subsubsection
1095 \begin_layout Standard
1096 There are two variables under LaTeX that control page position:
1109 Their names should be self-explanatory.
1110 These variables are useful if you think for a moment about computer labels.
1111 Sometimes, the size of a print medium and the area of the medium that you
1112 can actually print on aren't the same.
1128 \begin_layout Standard
1129 The default values for
1141 are both 0 pt.,\InsetSpace ~
1144 the page isn't shifted.
1147 \begin_layout Standard
1148 Unfortunately, some DVI drivers always seem to shift the page.
1149 We have no idea why, or why the sysadmin hasn't fixed such behavior.
1150 If you're using LyX on a system that you don't personally maintain, and
1151 your sysadmin is a doofus,
1164 Suppose you're left and top margins are always 0.5 inches too big.
1165 You can add this to the preamble:
1168 \begin_layout LyX-Code
1176 \begin_layout LyX-Code
1184 \begin_layout Standard
1185 \SpecialChar \ldots{}
1186 and your margins should now be correct.
1189 \begin_layout Subsubsection
1193 \begin_layout Standard
1194 Speaking of labels, suppose you wanted to print out a bunch of address labels.
1195 There's a rather nice package, available at your nearest CTAN archive,
1196 for printing sheets of labels, called
1201 Now, your system may not have this package installed by default.
1202 We leave that up to you to check.
1203 You'll also want to read the documentation for it; we're not going to do
1205 Since this is an example, however, we'll give you an example of how you
1209 \begin_layout Standard
1210 First, make sure you're using the
1215 Next, you need to put the following in your preamble:
1218 \begin_layout LyX-Code
1224 \begin_layout LyX-Code
1230 \begin_layout LyX-Code
1236 \begin_layout LyX-Code
1242 \begin_layout LyX-Code
1248 \begin_layout LyX-Code
1254 \begin_layout LyX-Code
1260 \begin_layout Standard
1261 This sets things up for Avery® label sheets, stock #5360.
1262 You're now ready to print labels, but you'll need to insert LaTeX code,
1263 placing the commands
1275 around each label text.
1276 This and other special features of
1280 are explained in its documentation.
1283 \begin_layout Standard
1284 Someday, someone may write a LyX layout file to support this package directly.
1285 Maybe that someone is you.
1288 \begin_layout Subsubsection
1289 Example #3: Paragraph Indentation
1292 \begin_layout Standard
1293 Americans are trained to indent the first line of
1298 As with all of their other weird quirks, most Americans will whine and
1299 moan until they can have their way and indent the first line of all paragraphs.
1303 \begin_layout Standard
1308 : This was written by an American ---
1312 ! It's my perception of my fellow countrymen.
1313 Tough if you don't like it.
1322 \begin_layout Standard
1323 Of course, this behavior isn't standard typography.
1324 In books, you typically only indent the first line of a paragraph
1328 it follows another one.
1329 The idea behind indenting the first line of a paragraph is to distinguish
1330 neighboring paragraphs from one another.
1331 If there is no previous paragraph, for example, it follows a figure, or
1332 is the first paragraph in a section, then there is no special indentation.
1336 \begin_layout Standard
1337 If you're a typical American, though, you don't care about such esoteric
1338 things; you want your indentation! Add this to the preamble:
1341 \begin_layout LyX-Code
1344 usepackage{indentfirst}
1347 \begin_layout Standard
1348 If your TeX distribution isn't a braindead one, you'll have this package,
1349 and all of your paragraphs will get the indentation you think they deserve.
1352 \begin_layout Subsubsection
1353 Example #4: This Document
1356 \begin_layout Standard
1357 You can also check out the preamble of this document to get an idea of some
1358 of the advanced things you can do.
1359 You'll probably need to make the
1364 reamble\SpecialChar \ldots{}
1367 dialog full-screen to see most of it.
1368 Also, there are more examples and an assortment of LaTeX
1369 \begin_inset Quotes eld
1373 \begin_inset Quotes erd
1376 given in Chapter\InsetSpace ~
1378 \begin_inset LatexCommand \ref{cha:secrets}
1386 \begin_layout Section
1387 LyX and LaTeX Errors
1390 \begin_layout Standard
1391 When LyX calls LaTeX, it tells LaTeX to blithely ignore any errors and keep
1393 It then uses the log-file from the LaTeX run to do a post-mortem.
1394 As we stated earlier in the chapter, LyX generates two kinds of
1398 files, one of which it uses to locate errors in the document.
1399 If there was an error someplace, LyX will put a box with the word
1400 \begin_inset Quotes eld
1404 \begin_inset Quotes erd
1407 at the appropriate place in the document.
1411 \begin_layout Standard
1412 LyX will occasionally misguess where the error was.
1413 This will typically happen with tables, figures, math, and the preamble.
1418 It will also display a message alerting you to the fact that there were
1422 \begin_layout Standard
1423 You can navigate through the errors by using
1439 \begin_inset Quotes eld
1443 \begin_inset Quotes erd
1446 the error-boxes and view the error message LaTeX produced by clicking on
1450 \begin_layout Standard
1451 Some folks also like to look at the log file directly, accessible from
1457 ocument\SpecialChar \menuseparator
1467 There are some fairly common error messages and warnings.
1468 We'll cover those here.
1469 You should look at a good LaTeX book for a complete listing.
1472 \begin_layout Itemize
1473 \begin_inset Quotes eld
1481 \begin_inset Quotes eld
1488 \begin_layout Standard
1489 Anything beginning with these word is a warning message for the purpose
1491 \begin_inset Quotes eld
1495 \begin_inset Quotes erd
1498 the LaTeX code itself.
1499 You'll get messages like this if you added or changed cross-references
1500 or bibliography entries, in which case, LaTeX is trying to tell you that
1501 you need to make another run.
1504 \begin_layout Standard
1505 You can by-and-large ignore these.
1509 \begin_layout Itemize
1510 \begin_inset Quotes eld
1518 \begin_inset Quotes erd
1525 \begin_layout Standard
1526 Another warning message, this time about fonts which LaTeX couldn't find.
1527 The rest of the message will often say something about a replacement font
1531 \begin_layout Standard
1532 You can safely ignore these.
1536 \begin_layout Itemize
1537 \begin_inset Quotes eld
1547 \begin_inset Quotes erd
1554 \begin_layout Standard
1560 They are warning you about lines that were too long and run past the right
1562 Almost always, this is unnoticeable in the final output.
1563 Or, only one or two characters extend past the margin.
1564 LaTeX seems to generate at least one of these messages for just about any
1568 \begin_layout Standard
1569 You can ignore these stupid messages.
1570 Your eyes will tell you if there's a problem with something that's too
1571 wide; just look at the output.
1575 \begin_layout Itemize
1576 \begin_inset Quotes eld
1586 \begin_inset Quotes erd
1593 \begin_layout Standard
1594 Not quite as common as its cousin.
1595 LaTeX seems to like to print lines that are a bit too wide as opposed to
1596 ones that are a bit too narrow.
1597 We have no idea why.
1600 \begin_layout Standard
1601 You can ignore these, too.
1605 \begin_layout Itemize
1606 \begin_inset Quotes eld
1616 \begin_inset Quotes erd
1620 \begin_inset Quotes eld
1630 \begin_inset Quotes erd
1637 \begin_layout Standard
1638 Warnings about troubles breaking the page.
1639 Once again, just look at the output.
1640 Your eyes will tell you where something has gone wrong.
1644 \begin_layout Itemize
1645 \begin_inset Quotes eld
1651 \begin_inset Quotes els
1655 \begin_inset Quotes ers
1661 \begin_inset Quotes erd
1668 \begin_layout Standard
1670 \begin_inset Quotes eld
1674 \begin_inset Quotes erd
1677 isn't installed on this system.
1678 This usually appears because some package your document needs isn't installed.
1679 If you didn't touch the preamble or didn't use the
1685 command, then one of the packages LyX tried to load is missing.
1691 elp\SpecialChar \menuseparator
1698 , to get a list of packages that LyX knows about.
1699 This file is updated whenever you reconfigure LyX (using
1706 \SpecialChar \menuseparator
1711 ) and tells you which packages have been detected and what they do.
1714 \begin_layout Standard
1725 command, and the package in question isn't installed, you'll need to install
1730 \begin_layout Itemize
1731 \begin_inset Quotes eld
1736 LaTeX Error: Unknown option
1739 \begin_inset Quotes erd
1746 \begin_layout Standard
1747 Error messages beginning with this are trying to tell you that you specified
1748 a bad or undefined option to a package.
1749 Check the package's documentation.
1753 \begin_layout Itemize
1754 \begin_inset Quotes eld
1759 Undefined control sequence
1762 \begin_inset Quotes erd
1769 \begin_layout Standard
1770 If you've inserted LaTeX code into your document, but made a typo, you'll
1772 You may have forgotten to load a package.
1773 In any case, this error message usually means that you used an undefined
1778 \begin_layout Standard
1779 There are other error and warning messages.
1780 Some are self-explanatory.
1781 These are usually LaTeX messages.
1782 Others are downright cryptic.
1783 These are actually TeX error messages, and we really have
1787 what they mean or how to decipher them.
1790 \begin_layout Standard
1791 There's a general sequence you should follow if you get error messages:
1794 \begin_layout Enumerate
1795 Look at the LaTeX code you inserted for typos.
1798 \begin_layout Enumerate
1799 If there are no typos, check and see that you used the command(s) correctly.
1802 \begin_layout Enumerate
1803 If you get a bunch of error boxes piled up at the very top of the document,
1804 it means that there are errors in the preamble.
1805 Start debugging your preamble.
1808 \begin_layout Enumerate
1809 If you didn't add anything to the preamble and didn't add any LaTeX code
1810 to the document, the first suspect is your LaTeX distribution itself.
1811 Check for missing packages and install them.
1814 \begin_layout Enumerate
1815 Okay, so there are no missing packages.
1816 Did you use any of the fine-tuning options in LyX? Specifically, did you
1821 any of them, like trying to manually insert lots of
1823 Protected\InsetSpace ~
1834 s? Did you try to kludge something together with these instead of using
1835 the appropriate paragraph environment?
1838 \begin_layout Enumerate
1839 All right, you didn't use any of the fine-tuning options, you played by
1841 Did you try to pull a fancy maneuver? Did you do something funky inside
1842 a table or an equation, like inserting a graphic into a table cell?
1845 \begin_layout Enumerate
1846 Do you have long sections of text where LaTeX cannot find a place to break
1847 a line? By default, LaTeX is rather strict about how much extra inter-word
1848 spacing it will add in order to break a line.
1849 Preferrably, you should rework the paragraph to avoid the problem.
1850 If this isn't an option, you can wrap your text in
1856 to make LaTeX's line breaking more, well, sloppy.
1859 \begin_layout Enumerate
1860 Did you go overboard with the nesting? LyX (currently) doesn't check to
1861 make sure you're in the limits for nesting environments.
1862 If you nested a bunch of environments to the
1863 \begin_inset Formula $17^{\mathrm{th}}$
1866 level, that's the problem.
1869 \begin_layout Enumerate
1870 Okay, you didn't get any error messages, but your output looks whacked.
1871 If you have a table or figure that's too wide or long for the page, you
1876 \begin_layout Enumerate
1877 rescale the figure so it fits.
1880 \begin_layout Enumerate
1881 trim down the table so it fits.
1884 \begin_layout Standard
1885 If something else is wrong with the output, and you didn't try to pull anything
1886 fancy or kludge the fine-tuning options, we're not sure what's wrong.
1890 \begin_layout Standard
1891 If all this doesn't help --- well, then
1895 you might have found a bug in LyX\SpecialChar \ldots{}
1899 \begin_layout Chapter
1903 \begin_layout Section
1904 Preparing a Bibliography with BibTeX
1905 \begin_inset LatexCommand \label{sec:Preparing-a-Bibliography}
1912 \begin_layout Standard
1919 Jürgen Spitzmüller
1922 \begin_layout Standard
1923 \begin_inset VSpace bigskip
1929 \begin_layout Standard
1931 STOP! If you don't know what BibTeX is, or have a reasonably good idea of
1937 setting up your own bibliographic databases),
1941 , do not walk, to your nearest copy of the 2nd edition of Lamport's
1943 LaTeX: A Document Preparation System
1945 , particularly Appendix B.
1946 The rest of this discussion assumes you have created a correct bibliography
1947 file, that you have all relevant environment variables set correctly (esp.
1960 ), and that if sufficiently desperate, you could create and
1961 \begin_inset Quotes eld
1965 \begin_inset Quotes erd
1968 a LaTeX file with a BibTeX database.
1972 \begin_layout Standard
1973 For those who don't know what BibTeX is, it is a system for creating a large
1974 database of your most used journal references.
1975 For all future articles you write, you only need to include this standard
1976 database and reference the appropriate key to each reference.
1977 Even if you write only a few papers with handful of references each, it
1978 is well worth your time to examine BibTeX and decide whether it will be
1982 \begin_layout Standard
1983 To use BibTeX with LyX, first read the
1987 where it describes how to insert citations.
1988 The basic mechanism for inserting BibTeX references is the same.
1989 Then, at the very end of your document, select
1991 Insert\SpecialChar \menuseparator
1996 TOC\SpecialChar \menuseparator
2000 In the resulting dialog, fill out the dialog boxes as follows:
2003 \begin_layout Description
2004 Database: enter the name of your
2017 For searching multiple
2021 files, just enter them in the desired order, separated by commas.
2025 \begin_layout Description
2026 Style: enter the name of your BibTeX style file *without* the
2031 The default style is
2035 (which should be included in your LaTeX distribution, so you don't have
2036 to worry about creating it).
2039 \begin_layout Standard
2040 For each citation, assuming that the source is in the
2049 nsert\SpecialChar \menuseparator
2056 at the correct location in the text, and enter the appropriate reference
2058 Nothing else is required; when invoking
2063 iew\SpecialChar \menuseparator
2070 , for example, you should see that BibTex and LaTeX are invoked as needed,
2071 including multiple invocations of LaTeX.
2075 \begin_layout Subsection
2076 Alternative Citation Styles
2079 \begin_layout Standard
2080 Standard BibTeX uses numbers (e.\InsetSpace \thinspace{}
2081 g.\InsetSpace \space{}
2083 \begin_inset Quotes eld
2087 \begin_inset Quotes erd
2090 ) to refer to a cited work.
2091 However, in many scientific disciplines, other citation styles are in use.
2092 The most common one is the author-year style (e.\InsetSpace \thinspace{}
2093 g.\InsetSpace \space{}
2095 \begin_inset Quotes eld
2099 \begin_inset Quotes erd
2103 LyX supports two packages that provide this style,
2112 Both packages have their own pros and cons, which cannot be listed in detail.
2113 If you only want to have simple author-year (or author-numerical) style
2114 or if you want to use one of the countless style files for natbib, than
2119 package is probably your choice.
2120 If you need special features like short title references, ibidem etc., you
2121 might consider the fairly new
2128 \begin_layout Standard
2129 The handling of both packages in LyX is basically the same.
2135 ocument\SpecialChar \menuseparator
2146 pane (with the xforms frontend: the
2160 With both packages, you will get some extra features in the citation dialog
2161 and you can select the style of the reference (
2162 \begin_inset Quotes eld
2166 \begin_inset Quotes erd
2170 \begin_inset Quotes eld
2174 \begin_inset Quotes erd
2178 \begin_inset Quotes eld
2182 \begin_inset Quotes erd
2186 \begin_inset Quotes eld
2190 \begin_inset Quotes erd
2194 Note that both packages need specifically designed style files (they both
2195 ship their own, while there are lots of additional style files and even
2196 an interactive style file builder
2200 \begin_layout Standard
2202 \begin_inset LatexCommand \url{ftp://ctan.tug.org/tex-archive/macros/latex/contrib/custom-bib/}
2218 \begin_layout Subsection
2219 Sectionated Bibliographies
2220 \begin_inset LatexCommand \label{sub:Sectionated-Bibliographies}
2227 \begin_layout Standard
2228 Sometimes you might need to divide your bibliography into several sections.
2229 If you are, for instance, a historian, the possibility to separate sources
2230 and scientific works is most likely a
2231 \begin_inset Quotes eld
2235 \begin_inset Quotes erd
2239 Unfortunately, BibTeX itself does not allow you to do this.
2240 The good news is, though: With the help of some LaTeX packages, BibTeX
2241 can be extended to fit your historical needs.
2244 \begin_layout Standard
2245 As of version 1.4, LyX provides native support for one of these packages,
2254 \begin_layout Standard
2256 \begin_inset LatexCommand \url{ftp://ctan.tug.org/tex-archive/macros/latex/contrib/bibtopic/}
2265 The advantage of this package (compared to other packages like
2269 ) is that you don't need to define new citation commands.
2270 Instead, you need to prepare different bibliographic databases which include
2271 the entries for the different sections of the bibliography.
2272 For example: If you want to divide your bibliography into the sections
2274 \begin_inset Quotes eld
2278 \begin_inset Quotes erd
2282 \begin_inset Quotes eld
2286 \begin_inset Quotes erd
2289 , you first need to create two bibliographic databases, e.\InsetSpace \thinspace{}
2290 g.\InsetSpace \space{}
2303 \begin_layout Standard
2309 ocument\SpecialChar \menuseparator
2320 pane (with the xforms frontend: the
2327 Sectionated\InsetSpace ~
2331 Now you can insert multiple BibTeX references (as described in section\InsetSpace ~
2333 \begin_inset LatexCommand \ref{sec:Preparing-a-Bibliography}
2337 ), one for each section of your bibliography.
2338 Returning to our example: Insert a BibTeX reference for the database
2342 and a second one for the database
2347 You are free to use the same or different styles for each section.
2348 Additionally, you can chose if the bibliography section should contain
2350 \begin_inset Quotes eld
2353 all cited references
2354 \begin_inset Quotes erd
2357 of the specified database(s) (which is the default),
2358 \begin_inset Quotes eld
2361 all uncited references
2362 \begin_inset Quotes erd
2366 \begin_inset Quotes eld
2370 \begin_inset Quotes erd
2374 This might be useful if you would like to separate your bibliography into
2376 \begin_inset Quotes eld
2380 \begin_inset Quotes erd
2384 \begin_inset Quotes eld
2388 \begin_inset Quotes erd
2392 \begin_inset Quotes eld
2396 \begin_inset Quotes erd
2400 The titles for the sections can be added as ordinary sections or subsections.
2405 removes the bibliography title, you have manually re-add that, too (as
2406 a chapter* or section*, for instance).
2409 \begin_layout Subsection
2410 Multiple Bibliographies
2413 \begin_layout Standard
2414 Multiple bibliographies, e.\InsetSpace \thinspace{}
2415 g.\InsetSpace \space{}
2416 a bibliography for each section or chapter of
2417 the document, are not supported by BibTeX itself.
2422 package, which is used for the creation of sectionated bibliographies in
2423 LyX (cf.\InsetSpace ~
2424 section\InsetSpace ~
2426 \begin_inset LatexCommand \ref{sub:Sectionated-Bibliographies}
2430 ), provides an easy way to solve this task, if you are willing to use some
2431 LaTeX-Code (ERT, cf.\InsetSpace ~
2432 section\InsetSpace ~
2434 \begin_inset LatexCommand \ref{sec:Inserting-LaTeX-Code}
2442 \begin_layout Standard
2443 An alternative approach is to use the
2451 package, respectively.
2459 \begin_layout Standard
2465 ocument\SpecialChar \menuseparator
2476 pane (with the xforms frontend: the
2483 Sectionated\InsetSpace ~
2487 In the document, you have to enclose the sections, which shall contain
2488 their own bibliography (including the BibTeX reference itself), between
2501 (those commands have to be inserted as ERT).
2502 The bibliography will contain all references which have been cited in the
2504 N.\InsetSpace \thinspace{}
2505 B.: If you are using this approach, then
2509 citation reference has to be inside some btUnit.
2510 Also, the btUnits cannot be nested.
2513 \begin_layout Section
2517 \begin_layout Standard
2518 A good index is one of the hardest things to make in a lengthy document,
2519 but LyX helps make things a bit simpler by interfacing to the
2523 program which is found in most recent LaTeX distributions.
2527 \begin_layout Standard
2545 Outputs\SpecialChar \menuseparator
2546 LaT\SpecialChar \textcompwordmark{}
2555 section of the preferences dialog, however, you can customize the index
2556 command, if you prefer an alternative program like
2577 Inserting an index and marking words to include in it works much the same
2578 way as preparing a bibliography as mentioned in the last section.
2581 \begin_layout Standard
2582 First, go to the end of your file and select
2587 nsert\SpecialChar \menuseparator
2598 C\SpecialChar \menuseparator
2611 Then, for each word you would like to include in the index, go to the end
2612 of that word and click on
2617 nsert\SpecialChar \menuseparator
2630 This will insert a tag showing the word as it will appear in the index.
2631 That's all there is to it; LyX will automatically call
2635 for you and create the index itself.
2636 The text in the dialog available from right-clicking on the index button
2637 accepts LaTeX, so you'll need to be careful to avoid using any special
2639 On the positive side, you can use the advanced options - have a look at
2640 the documentation which comes with your LaTeX distribution to find out
2641 how to do things like
2642 \begin_inset Quotes eld
2646 \begin_inset Quotes erd
2652 \begin_layout Standard
2653 Be careful not to put spaces between the word in the text and the index
2654 marker; apparently the wrong page number can be produced if this happens.
2657 \begin_layout Section
2661 \begin_layout Subsection
2665 \begin_layout Standard
2666 When you are working on a large file with many sections, it is often convenient
2667 to break up the document into several files, or perhaps you have something
2668 where a table may change from time to time, but the preceding text does
2670 In these cases, you should seriously consider using multipart documents.
2671 For example, scientific papers often have five major sections: the introduction
2672 , observations, results, discussion, and conclusion.
2673 Each of these could be its own separate LyX file, with one
2674 \begin_inset Quotes eld
2678 \begin_inset Quotes erd
2681 file which contains the title, authors, abstract, references, etc., plus
2682 the five included files.
2683 It is important to note that each of these files is a full LyX file which
2684 can be formatted and printed on its own, as well as included in a master
2686 Each of these files must have the same document class, however--- don't
2687 attempt to mix book classes with article classes.
2688 You may also include LaTeX files; however, these files must not have their
2694 everything up to and including the
2706 line must be deleted) or else errors will be generated when you try to
2710 \begin_layout Standard
2711 LyX allows you to include files quite easily with
2716 nsert\SpecialChar \menuseparator
2725 When you click on this selection a small box is inserted into the file
2726 at the current cursor location.
2727 Clicking on the box raises a dialog which allows you to select the file
2728 to be included, and the method of its inclusion.
2732 \begin_layout Standard
2733 The file selection box should by now be obvious.
2734 The three inclusion methods are
2735 \begin_inset Quotes eld
2739 \begin_inset Quotes erd
2743 \begin_inset Quotes eld
2747 \begin_inset Quotes erd
2751 \begin_inset Quotes eld
2755 \begin_inset Quotes erd
2759 The difference between
2760 \begin_inset Quotes eld
2764 \begin_inset Quotes erd
2768 \begin_inset Quotes eld
2772 \begin_inset Quotes erd
2775 is really only meaningful to LaTeXperts, but the practical difference is
2776 that files which are
2777 \begin_inset Quotes eld
2781 \begin_inset Quotes erd
2784 are typeset beginning on a new page, while files which are
2785 \begin_inset Quotes eld
2789 \begin_inset Quotes erd
2792 are typeset starting on the current page.
2793 Perhaps the labeling in LyX will be changed someday to reflect this.
2796 \begin_layout Standard
2797 Generally, the master file is converted into a full LaTeX file before typesettin
2798 g, while the included files are converted to LaTeX files which do not have
2799 all the preamble information.
2809 button prevents this conversion.
2812 \begin_layout Standard
2814 \begin_inset Quotes eld
2818 \begin_inset Quotes erd
2821 included file allows you to include a file typeset exactly as it appears
2822 in the file, i.e.\InsetSpace ~
2823 verbatim mode, with the characters set in a fixed-width
2825 Normally, spaces in this file are invisible, though two consecutive spaces
2826 are conserved, unlike LyX's normal treatment of spaces.
2827 However, setting the
2837 checkbox typesets a mark to unambiguously define the presence of a space.
2843 \begin_layout Subsection
2844 Cross-References Between Files
2847 \begin_layout Standard
2848 It is possible to set up cross-references between the different files.
2849 First, open all the files in question: let's call them A and B in a two
2850 file example, where B is included in A.
2851 Let's say you insert a label in A, then want to reference it in B.
2852 Open the cross-reference dialog in whilst in document B, and you can select
2854 \begin_inset Quotes eld
2858 \begin_inset Quotes erd
2864 \begin_layout Section
2868 \begin_layout Standard
2873 is needed by LyX to be able to output algorithm floats.
2874 These are useful in placing short algorithms across page breaks and support
2875 an index of algorithms too.
2878 \begin_layout Section
2882 \begin_layout Standard
2887 is used by LyX when you select ``subfigure'' in the graphics dialog and
2888 enter the subfigure caption.
2889 Several figures marked in this way can be packed into a single float with
2890 individual sub-captions.
2893 \begin_layout Section
2894 Fancy Headers and Footers
2897 \begin_layout Standard
2898 The default page layout is rather plain; for an article document class,
2899 all you get is a centered page number at the bottom of the page.
2900 This document is the book class, so it appears to be a bit fancier, but
2901 to really put on a show, you need to set the document page style to
2902 \begin_inset Quotes eld
2906 \begin_inset Quotes erd
2909 , as mentioned in the
2915 This section describes the LaTeX codes you need to insert in your LaTeX
2916 preamble or the text in order to get the desired effects.
2919 \begin_layout Standard
2920 The page header is divided into three fields, not surprisingly labeled
2921 \begin_inset Quotes eld
2925 \begin_inset Quotes erd
2929 \begin_inset Quotes eld
2933 \begin_inset Quotes erd
2937 \begin_inset Quotes eld
2941 \begin_inset Quotes erd
2945 The footer is also divided into these three fields.
2946 The LaTeX commands to set these fields in the simplest manner are
2971 Suppose you wish to put your name in the upper left hand corner of each
2973 Simply insert the following command in the preamble:
2976 \begin_layout Standard
2985 \begin_layout Standard
2986 You will now see your name in the upper left.
2987 If a field has a default entry that you would like to get rid of (often
2988 the page number appears in the central footer, simply include a command
2989 with a blank argument, e.g.
2992 \begin_layout Standard
3000 \begin_layout Standard
3001 Let's get really fancy: lets put the section number with the word
3002 \begin_inset Quotes eld
3006 \begin_inset Quotes erd
3010 Section 3) in the upper left, the page number (e.g.
3011 Page 4) in the upper right, your name in the lower left, and the date in
3013 The following commands should now appear in the preamble:
3016 \begin_layout Standard
3026 \begin_layout Standard
3034 \begin_layout Standard
3044 \begin_layout Standard
3053 \begin_layout Standard
3061 \begin_layout Standard
3071 \begin_layout Standard
3084 access LaTeX's section and page counters, and so print out the current
3085 section and page numbers.
3092 simply prints out today's date.
3095 \begin_layout Standard
3096 The thicknesses of the horizontal rules drawn beneath the header and above
3097 the footer can also be modified.
3098 If you don't want one of the headers, set its thickness to 0.
3099 The header rule has a default thickness of 0.4pt, the footer rule is 0pt.
3100 Use the commands, e.g.
3107 headrulewidth}{0.4pt}
3115 footrulewidth}{0.4pt}
3117 to set the thicknesses.
3120 \begin_layout Standard
3121 You can switch the header/footer settings on and off for individual pages
3126 thispagestyle{empty}
3132 thispagestyle{plain}
3138 thispagestyle{fancy}
3141 Simply insert them in the text on the page you want changed and mark them
3143 In fact, title pages are marked as plain by default, while following pages
3144 are marked fancy when using the global fancy setting.
3147 \begin_layout Standard
3148 There are more complex commands which will let you insert things in the
3149 upper left on odd numbered pages, etc., but I will refer you to the
3153 package documentation for more descriptions.
3154 For example, if you have a teTeX installation, look for
3156 /usr/share/texmf/doc/latex/fancyhdr/\SpecialChar \-
3162 \begin_layout Standard
3163 As a final example, it is possible to include an Encapsulated PostScript®
3164 file in the header or footer.
3165 Suppose you want to put a company logo in the upper lefthand corner.
3166 You might try something like
3169 \begin_layout Standard
3178 includegraphics{logo.eps}}}
3181 \begin_layout Standard
3183 (you may need to preface this with
3187 usepackage{graphics}
3189 if you don't include EPS files elsewhere in your document).
3192 \begin_layout Section
3196 \begin_layout Standard
3197 LaTeX provides a mechanism to produce essentially a page within a page,
3199 Within a minipage, all the usual rules of indentation, line wrapping, etc.\InsetSpace ~
3201 LyX also provides some of the minipage capability.
3204 \begin_layout Standard
3205 Minipages in LyX have their own collapsable box; insert one via
3210 nsert\SpecialChar \menuseparator
3218 Right-clicking on the box allows you to alter the minipage's width and
3219 alignment within the page.
3220 Warning: if the minipage is too long to fit on a page, it is truncated,
3221 not wrapped onto the next page.
3224 \begin_layout Standard
3225 If you place two minipages side-by-side, you can use
3230 nsert\SpecialChar \menuseparator
3238 to insert a special instruction known in the LaTeX world as an
3242 to put a maximum amount of space between them; it forces one minipage to
3243 the left edge, the other to the right edge.
3244 The examples below show the difference.
3247 \begin_layout Standard
3248 \begin_inset Box Frameless
3257 height_special "totalheight"
3260 \begin_layout Standard
3261 This is a minipage which does not use hfill.
3262 This is the second sentence of a minipage which does not use hfill.
3270 \begin_layout Standard
3271 \begin_inset Box Frameless
3280 height_special "totalheight"
3283 \begin_layout Standard
3284 This is a second minipage which does not use hfill.
3285 This is the second sentence of a second minipage which does not use hfill.
3293 \begin_layout Standard
3294 \begin_inset VSpace medskip
3300 \begin_layout Standard
3301 Here is some normal text to separate the two examples.
3304 \begin_layout Standard
3305 \begin_inset VSpace medskip
3311 \begin_layout Standard
3312 \begin_inset Box Frameless
3321 height_special "totalheight"
3324 \begin_layout Standard
3325 This is a minipage which does use hfill.
3326 This is the second sentence of a minipage which does use hfill.
3334 \begin_inset Box Frameless
3343 height_special "totalheight"
3346 \begin_layout Standard
3347 This is a second minipage which does use hfill.
3348 This is the second sentence of a second minipage which does use hfill.
3356 \begin_layout Section
3357 Wrapping Text Around Figures
3358 \begin_inset LatexCommand \label{sec:floatflt}
3365 \begin_layout Standard
3366 \begin_inset Wrap figure
3371 \begin_layout Standard
3372 \begin_inset Graphics
3383 \begin_layout Caption
3384 This is a wrapped figure, and this is the brilliant caption that describes
3393 \begin_layout Standard
3394 A very frequently asked question is whether text can be made to
3395 \begin_inset Quotes eld
3399 \begin_inset Quotes erd
3402 around figures so that a figure occupies some fraction of the column width
3403 and text fills the rest.
3404 If you have the LaTeX package
3408 installed (you can find out about it in the
3412 manual) you can do this.
3415 \begin_layout Standard
3416 At the right is a figure of a mobius strip---you should have already seen
3422 To wrap the text like this insert a wrap box via
3427 nsert\SpecialChar \menuseparator
3432 ts\SpecialChar \menuseparator
3438 \begin_layout Standard
3439 Note: this package is very fragile! For example, having a figure too close
3440 to the bottom of the page will mess things up, as will having two figures
3442 Use this package sparingly and do read the documentation that came with
3443 it (which will also tell you how to wrap text around tables).
3446 \begin_layout Section
3450 \begin_layout Standard
3451 While the standard table layout will suffice in 99% of all tables you generate,
3452 occasionally you will run into one which requires a bit of extra tweaking.
3453 The table dialog which appears on a right-click of a table allows these
3455 It will give you access to some extra column alignment parameters.
3456 A little bit of LaTeX background is useful here: when you set up a table
3457 in LaTeX, each column is given an alignment type.
3458 For example, you would give it
3459 \begin_inset Quotes eld
3467 \begin_inset Quotes erd
3471 \begin_inset Quotes eld
3479 \begin_inset Quotes erd
3483 \begin_inset Quotes eld
3491 \begin_inset Quotes erd
3494 for left-aligned, centered, and right-aligned columns respectively (which
3495 appear as the left/center/right radio buttons in LyX).
3497 \begin_inset Quotes eld
3505 \begin_inset Quotes erd
3508 , which will make a column of a specified width (the width box in LyX),
3509 and will wrap text within that box.
3511 \begin_inset Quotes eld
3519 \begin_inset Quotes erd
3522 (vertical bar) which rather than making a column will make a vertical rule
3523 at that point; this manifests itself in LyX as the
3524 \begin_inset Quotes eld
3528 \begin_inset Quotes erd
3532 Finally, there is a type
3533 \begin_inset Quotes eld
3541 \begin_inset Quotes erd
3544 , which allows you to use whatever is enclosed in the accompanying braces
3545 as the column separator, including a null argument.
3546 The reasons for doing this may not be obvious, but they can be very powerful.
3547 They are best demonstrated by example.
3550 \begin_layout Subsection
3551 Removing Extra Column Space
3554 \begin_layout Standard
3555 Here is a standard table:
3558 \begin_layout Standard
3560 \begin_inset Tabular
3561 <lyxtabular version="3" rows="3" columns="2">
3563 <column alignment="left" valignment="top" width="0pt">
3564 <column alignment="left" valignment="top" leftline="true" width="0pt">
3565 <row bottomline="true">
3566 <cell alignment="left" valignment="top" topline="true" usebox="none">
3569 \begin_layout Standard
3584 <cell alignment="left" valignment="top" topline="true" leftline="true" usebox="none">
3587 \begin_layout Standard
3604 <cell alignment="left" valignment="top" topline="true" usebox="none">
3607 \begin_layout Standard
3622 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
3625 \begin_layout Standard
3642 <cell alignment="center" valignment="top" topline="true" usebox="none">
3645 \begin_layout Standard
3660 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
3663 \begin_layout Standard
3686 \begin_layout Standard
3687 Notice that the horizontal rule extends a bit past the text on both sides.
3688 If you wanted the line to end even with the text, we can put a null separator
3689 on the ends to get rid of the bit of extra space LaTeX adds by default.
3690 Here is the example:
3693 \begin_layout Standard
3695 \begin_inset Tabular
3696 <lyxtabular version="3" rows="3" columns="2">
3698 <column alignment="left" valignment="top" width="0pt" special="@{} l">
3699 <column alignment="left" valignment="top" leftline="true" width="0pt" special="l @{}">
3700 <row bottomline="true">
3701 <cell alignment="left" valignment="top" topline="true" usebox="none">
3704 \begin_layout Standard
3719 <cell alignment="left" valignment="top" topline="true" leftline="true" usebox="none">
3722 \begin_layout Standard
3739 <cell alignment="left" valignment="top" topline="true" usebox="none">
3742 \begin_layout Standard
3757 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
3760 \begin_layout Standard
3777 <cell alignment="center" valignment="top" topline="true" usebox="none">
3780 \begin_layout Standard
3795 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
3798 \begin_layout Standard
3821 \begin_layout Standard
3822 In this case, the column specifier for the left column was set to
3823 \begin_inset Quotes eld
3831 \begin_inset Quotes erd
3834 , while the right column was set to
3835 \begin_inset Quotes eld
3843 \begin_inset Quotes erd
3846 , in order to put the null characters on the edges.
3850 \begin_layout Subsection
3851 Changing the Column Separator Character
3854 \begin_layout Standard
3855 Now suppose you really wanted, for reasons that are completely opaque, to
3857 \begin_inset Formula $\sqrt{\pi}$
3860 with some space around it for the column separator.
3861 Simply turn off the vertical border, then set the right column specifier
3863 \begin_inset Quotes eld
3875 \begin_inset Quotes erd
3879 You could now make a table like this:
3882 \begin_layout Standard
3884 \begin_inset Tabular
3885 <lyxtabular version="3" rows="3" columns="2">
3887 <column alignment="left" valignment="top" width="0pt">
3888 <column alignment="left" valignment="top" width="0in" special="@{~$\sqrt{\pi}$~}l">
3889 <row bottomline="true">
3890 <cell alignment="left" valignment="top" topline="true" usebox="none">
3893 \begin_layout Standard
3908 <cell alignment="left" valignment="top" topline="true" usebox="none">
3911 \begin_layout Standard
3928 <cell alignment="left" valignment="top" topline="true" usebox="none">
3931 \begin_layout Standard
3946 <cell alignment="center" valignment="top" topline="true" usebox="none">
3949 \begin_layout Standard
3966 <cell alignment="center" valignment="top" topline="true" usebox="none">
3969 \begin_layout Standard
3984 <cell alignment="center" valignment="top" topline="true" usebox="none">
3987 \begin_layout Standard
4010 \begin_layout Subsection
4011 Making a Decimal Point Aligned Column
4014 \begin_layout Standard
4015 Okay, that last example was very silly, but here is one that is not.
4016 Suppose you want to make a table that has a column which is aligned on
4018 A standard LaTeX trick to do this is to set the whole number part in a
4019 right-aligned column, use a decimal point for the column separator, then
4020 set the fractional part as a left-aligned column.
4021 A variation on this is to include the decimal point explicitly with the
4022 whole part, then use just a null separator in between.
4023 The latter variation is demonstrated here:
4026 \begin_layout Standard
4028 \begin_inset Tabular
4029 <lyxtabular version="3" rows="5" columns="3">
4031 <column alignment="center" valignment="top" width="0pt">
4032 <column alignment="right" valignment="top" leftline="true" width="0pt">
4033 <column alignment="center" valignment="top" width="0pt" special="@{} l">
4034 <row bottomline="true">
4035 <cell alignment="center" valignment="top" topline="true" usebox="none">
4038 \begin_layout Standard
4053 <cell multicolumn="1" alignment="center" valignment="top" bottomline="true" leftline="true" usebox="none">
4056 \begin_layout Standard
4071 <cell multicolumn="2" alignment="center" valignment="top" topline="true" usebox="none">
4074 \begin_layout Standard
4082 <cell alignment="center" valignment="top" topline="true" usebox="none">
4085 \begin_layout Standard
4095 \begin_inset Formula $\pi$
4103 <cell alignment="right" valignment="top" topline="true" leftline="true" usebox="none">
4106 \begin_layout Standard
4121 <cell alignment="center" valignment="top" topline="true" usebox="none">
4124 \begin_layout Standard
4141 <cell alignment="center" valignment="top" topline="true" usebox="none">
4144 \begin_layout Standard
4154 \begin_inset Formula $\pi^{\pi}$
4162 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
4165 \begin_layout Standard
4180 <cell alignment="center" valignment="top" topline="true" usebox="none">
4183 \begin_layout Standard
4200 <cell alignment="center" valignment="top" topline="true" usebox="none">
4203 \begin_layout Standard
4213 \begin_inset Formula $(\pi^{\pi})^{\pi}$
4221 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
4224 \begin_layout Standard
4239 <cell alignment="center" valignment="top" topline="true" usebox="none">
4242 \begin_layout Standard
4250 <cell alignment="center" valignment="top" topline="true" usebox="none">
4253 \begin_layout Standard
4263 \begin_inset Formula $\pi^{\pi^{\pi}}$
4271 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
4274 \begin_layout Standard
4289 <cell alignment="center" valignment="top" topline="true" usebox="none">
4292 \begin_layout Standard
4303 \begin_inset Formula $\times10^{18}$
4319 \begin_layout Standard
4320 Though it appears a bit funny in LyX, on paper it will produce what appears
4321 to be a 2-column table in which the right column is aligned on the decimal
4322 point and the header appears to be centered over it.
4325 \begin_layout Standard
4326 Perhaps it is best if I described just what I did: first, create a 3
4327 \begin_inset Formula $\times$
4330 3 table and remove all the borders.
4331 Then re-add a bottom border to the top row, and a right border to the first
4333 Type in the values for the first column and set its alignment to
4355 and set that column's alignment to
4371 \begin_inset Formula $\times10^{18}$
4376 and set the extra column alignment to
4381 Finally type in the word
4385 in the middle column, highlight it and the blank entry to its right, and
4398 \begin_layout Subsection
4399 A Better Decimal-Alignment Solution
4402 \begin_layout Standard
4403 An alternative way to have decimal alignment in tables is through the
4408 Add the following to the LateX preamble:
4411 \begin_layout LyX-Code
4417 \begin_layout LyX-Code
4420 newcolumntype{d}[1]{D{.}{.}{#1}}
4423 \begin_layout Standard
4424 To have a column decimally aligned, enter in the
4426 Special Column Alignment
4432 dialog the following:
4435 \begin_layout LyX-Code
4436 d{number of decimals of the data}
4439 \begin_layout Standard
4440 To create extra column space just increase the number of decimals in
4445 Setting the multicolumn attribute for a single cell makes it insensitive
4446 to the decimal alignment which comes in handy as well.
4447 A drawback of this method is that math mode is not allowed in a column
4448 with decimal alignment except if the multicolumn attribute is set.
4451 \begin_layout Standard
4452 This method offers the same flexibility as the
4457 One could, for example, change the alignment separator, and have different
4458 alignment separators for different columns by defining multiple column
4459 types in the preamble.
4460 The syntax is as follows:
4463 \begin_layout LyX-Code
4464 D{inputsep}{outputsep}{decimal places}
4467 \begin_layout Standard
4468 The interested reader is directed towards the
4472 package documentation for more details.
4475 \begin_layout Section
4476 Itemize Bullet Selection
4477 \begin_inset LatexCommand \label{sec:bullet}
4484 \begin_layout Standard
4490 \begin_layout Subsection
4494 \begin_layout Standard
4495 LyX provides 216 bullet shapes that can be accessed from a simple dialog.
4496 Using this dialog you can easily specify what bullet shape to use at each
4497 level of an itemized list.
4498 These settings are document-wide so you won't be able to specify different
4499 sets of bullets for different paragraphs
4503 \begin_layout Standard
4504 Well, actually you can but you'll have to do it by hand.
4512 \begin_layout Subsection
4516 \begin_layout Standard
4517 Open the dialog by selecting the
4522 ocument\SpecialChar \menuseparator
4529 menu item and then select the
4539 \begin_layout Standard
4540 The dialog provides you with a table of bullet shapes.
4541 A column of buttons on the left of the table provides access to the six
4542 different panels of bullet shapes.
4543 The row of buttons across the top is used to select which bullet depth
4545 A text entry under the table shows the currently selected bullet shape's
4546 LaTeX equivalent and this can be edited if desired.
4547 If you do modify the text you will also need to specify any needed packages
4548 in the LaTeX preamble.
4551 \begin_layout Standard
4552 The six panels are divided up by the packages they require.
4553 The following table shows the mappings from button name to LaTeX packages.
4556 \begin_layout Standard
4558 \begin_inset Tabular
4559 <lyxtabular version="3" rows="7" columns="2">
4561 <column alignment="center" valignment="top" leftline="true" width="0pt">
4562 <column alignment="center" valignment="top" leftline="true" rightline="true" width="0pt">
4563 <row topline="true" bottomline="true">
4564 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
4567 \begin_layout Standard
4582 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
4585 \begin_layout Standard
4601 <row topline="true">
4602 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
4605 \begin_layout Standard
4620 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
4623 \begin_layout Standard
4638 <row topline="true">
4639 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
4642 \begin_layout Standard
4657 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
4660 \begin_layout Standard
4676 <row topline="true">
4677 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
4680 \begin_layout Standard
4695 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
4698 \begin_layout Standard
4714 <row topline="true">
4715 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
4718 \begin_layout Standard
4733 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
4736 \begin_layout Standard
4752 <row topline="true">
4753 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
4756 \begin_layout Standard
4771 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
4774 \begin_layout Standard
4790 <row topline="true" bottomline="true">
4791 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
4794 \begin_layout Standard
4809 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
4812 \begin_layout Standard
4835 \begin_layout Standard
4836 LyX doesn't stop you using bullets from packages you don't have.
4837 If you get errors from LaTeX when you try to view or print the file then
4838 its likely you are missing a package.
4839 LyX doesn't restrict your use since you may be editing locally and exporting
4843 \begin_layout Subsection
4847 \begin_layout Standard
4848 Select which bullet depth you want to change then select the bullet shape
4854 Any changes will not be visible in LyX, but are visible when viewing the
4855 document using xdvi or ghostview.
4858 \begin_layout Standard
4859 You can reset a bullet shape to the default simply by clicking your right
4860 mouse button on the appropriate bullet depth button.
4863 \begin_layout Standard
4868 want to have multiple sets of paragraphs with different sets of bullets
4869 in each then you're going to have to get your hands dirty.
4870 The itemize bullet selection dialog can help though because it provides
4871 you with the LaTeX code for a wide range of bullet shapes.
4872 To make your own custom paragraphs you have the following options:
4875 \begin_layout Standard
4879 \begin_layout Standard
4894 \begin_layout Standard
4898 \begin_layout Standard
4919 \begin_layout Itemize
4920 Use the LaTeX command
4926 to specify a new bullet shape for a given depth.
4927 You'll also need to save the current bullet shape so you can restore it
4929 In this itemized list the following LaTeX code was used to change the bullet
4930 used for the first depth.
4962 Note that the itemize depth is specified in Roman numerals as part of the
4972 \begin_layout Itemize
4976 \begin_layout Standard
4988 Specify each individual entry by starting each item with the bullet shape
4989 enclosed in square brackets and set as TeX.
4990 For example, this item was started with
5003 \begin_layout Standard
5007 \begin_layout Standard
5022 \begin_layout Standard
5023 You'll also need to revert the labelitem back to its previous setting for
5024 the global bullet shape settings to remain in effect.
5025 The way used here was:
5038 \begin_layout Chapter
5039 Special Document Classes
5042 \begin_layout Section
5046 \begin_layout Standard
5052 \begin_layout Standard
5053 \begin_inset VSpace bigskip
5059 \begin_layout Standard
5061 The AMS LaTeX layouts are set up to conform to suggested styles for mathematical
5062 papers to be submitted to American Mathematical Society publications.
5063 The layouts are not tailored to a specific journal, but easily can be.
5064 You should refer to the AMS documentation for specific instructions for
5065 each journal (usually it will entail only changing a single line in the
5067 That documentation is available on the Web at
5068 \begin_inset LatexCommand \url{http://www.ams.org}
5073 \begin_inset LatexCommand \url{ftp://ftp.ams.org/pub/tex/amslatex/}
5077 .These layouts are appropriate, and useful, for any mathematical writing.
5078 There are currently 4 distinct AMS LaTeX layouts:
5081 \begin_layout Enumerate
5082 amsart: The standard AMS-article format.
5083 All results and similar statements are numbered as
5084 \begin_inset Formula $(n.m)$
5087 , where the first number refers to the section, and the second refers to
5088 the total number of results (Theorems, Corollaries, Propositions, Definitions
5089 and Remarks, etc.) in that section.
5090 There are also many (but not all) environments available unnumbered, which
5091 is occasionally needed.
5092 Unnumbered environments indicated by an asterisk at the end.
5095 \begin_layout Enumerate
5096 amsart-seq: Here, numbering for each type of statement is in its own sequence,
5097 with no reference to the section number.
5098 There are also many (but not all) environments available unnumbered, which
5099 is occasionally needed.
5100 Unnumbered environments indicated by an asterisk at the end.
5103 \begin_layout Enumerate
5104 amsart-plain: This one is even more terse, since all the environments are
5108 \begin_layout Enumerate
5109 amsbook: the standard AMS book (really, monograph) format.
5110 Numbering is similar to the amsart layout, except that all numbering is
5112 \begin_inset Formula $(n.m.p)$
5115 , where the first number refers to the chapter, the second to the section,
5116 and the third is the number of the results (Theorems, Corollaries, Propositions
5117 , Definitions and Remarks, etc.) in that section.
5118 There are also many (but not all) environments available unnumbered, which
5119 is occasionally needed.
5120 Unnumbered environments indicated by an asterisk at the end.
5123 \begin_layout Standard
5124 Any AMS LyX file can be converted to either of the numbering schemes by
5125 simply changing the document class in the
5130 ocument\SpecialChar \menuseparator
5141 \begin_layout Subsection
5142 What these layouts provide
5145 \begin_layout Standard
5146 There is a long list of included environments provided by these layouts.
5147 Most mathematical papers or books will set as special statements most of
5148 these environments, in AMS-LaTeX there is an opportunity to define an unlimited
5149 variety of such declarations.
5150 However, the AMS recommends the environments that are available in LyX.
5151 The list of environments (not counting the standard environments such as
5154 sections, bibliography, title, author, date
5159 \begin_layout Description
5160 Theorem This is typically used for the statements of major results.
5162 \begin_inset Quotes eld
5170 \begin_inset Quotes erd
5173 appears in bold type, along with an automatically-determined number (an
5178 , is also available).
5179 The text is italicized.
5182 \begin_layout Description
5183 Corollary This is used for statements which follow fairly directly from
5184 previous statements.
5185 Again, these can be major results.
5193 \begin_layout Description
5194 Lemma These are smaller results needed to prove other statements.
5197 \begin_layout Description
5198 Proposition These are less major results which (hopefully) add to the general
5199 theory being discussed.
5202 \begin_layout Description
5203 Conjecture These are statements provided without justification, which the
5204 author does not know how to prove, but which seem to be true (to the author,
5208 \begin_layout Description
5209 Criterion A required condition.
5212 \begin_layout Description
5213 Algorithm A general procedure to be used.
5216 \begin_layout Description
5217 Axiom This is a property or statement taken as true within the system being
5221 \begin_layout Description
5222 Definition Guess what this is for.
5223 The font, both on-screen and in the output, is different for this environment
5224 than for the previous ones.
5226 \begin_inset Quotes eld
5230 \begin_inset Quotes erd
5233 ) is still set in boldface, along with the number, if any, but the rest
5237 \begin_layout Description
5238 Example Typeset similarly to Definition.
5241 \begin_layout Description
5245 \begin_layout Description
5249 \begin_layout Description
5253 \begin_layout Description
5254 Remark This environment is also a new type of theorem.
5255 This is set with the word Remark in italics, and the rest upright.
5258 \begin_layout Description
5259 Note Set similarly to the Remark environment.
5262 \begin_layout Description
5266 \begin_layout Description
5270 \begin_layout Description
5274 \begin_layout Description
5278 \begin_layout Description
5279 Case Generally, these are used to break up long arguments, using specific
5280 instances of some condition.
5281 The numbering scheme for cases is on its own, not together with other numbered
5286 \begin_layout Description
5290 \begin_layout Description
5294 \begin_layout Description
5296 \begin_inset Quotes eld
5304 \begin_inset Quotes erd
5307 is set in italics, but the rest is set upright.
5308 At the end of this environment (other environments can be nested within
5309 this one, of course) a QED symbol (usually a square, but it can vary with
5310 different styles) is placed.
5313 \begin_layout Description
5314 Address This should be the author's permanent address.
5317 \begin_layout Description
5318 Current\InsetSpace ~
5319 Address This should be the author's temporary address at the time
5320 of submission, if different from the Address.
5323 \begin_layout Description
5324 Email Author's e-mail address
5327 \begin_layout Description
5328 URL Author's Web address, if desired.
5331 \begin_layout Description
5332 Keywords Key words or phrases used to identify specific topics discussed
5336 \begin_layout Description
5337 Subjectclass These refer to the AMS Subject Classifications, published and
5340 Mathematical Reviews
5343 These are also available online at the AMS cites listed above.
5346 \begin_layout Description
5350 \begin_layout Description
5354 \begin_layout Description
5358 \begin_layout Standard
5359 In addition, these environments automatically provide the AMS LaTeX and
5361 They need to be available on your system in order to use these environments.
5364 \begin_layout Section
5368 \begin_layout Standard
5373 can be used to type letters according to German conventions.
5374 A template file is included in
5376 .../lyx/share/templates
5378 for you to use as a starting point.
5381 \begin_layout Section
5385 \begin_layout Standard
5390 provides an alternative to the standard
5395 It provides similar functionality, but you might prefer this layout with
5396 sans serif sections, headings, and more.
5399 \begin_layout Section
5403 \begin_layout Standard
5409 \begin_layout Subsection
5413 \begin_layout Standard
5414 This section describes how LyX can be used to write articles for submission
5415 to the scientific journal
5417 Astronomy and Astrophysics
5420 \begin_inset LatexCommand \url[www.edpsciences.fr/aa/]{http://www.edpsciences.fr/aa/}
5432 Version 5.01 of the document class
5437 This package can be downloaded from the ftp site
5440 \begin_layout Standard
5441 \begin_inset VSpace medskip
5447 \begin_layout Standard
5449 \begin_inset LatexCommand \url{ftp://ftp.edpsciences.org/pub/aa/readme.html}
5456 \begin_layout Standard
5457 \begin_inset VSpace medskip
5463 \begin_layout Standard
5464 A manual comes together with that package, and this text is not meant to
5465 replace the original manual but merely a short guide how to realize the
5466 correct form of your paper.
5470 \begin_layout Standard
5471 Please note that the publisher of the journal was changed from Springer
5472 to EDP Sciences starting January 1, 2001.
5473 That change implicated also some slight changes of the style files, namely
5474 the removal of the thesaurus command.
5475 The LyX class aa supports the newest version of these style files, V 5.01.
5476 If you have an older version installed, please upgrade.
5477 For compatibility, the old (version 4) layout has been kept as
5482 Please refer to the comments in
5484 LyXDir/layouts/aapaper.layout
5489 \begin_layout Subsection
5493 \begin_layout Standard
5494 It is recommended you start from the example template distributed with LyX.
5495 If you are not using a template, note the following settings:
5498 \begin_layout Itemize
5508 ocument\SpecialChar \menuseparator
5515 dialog (OK, that one was obvious).
5518 \begin_layout Itemize
5519 Don't change the option
5529 The whole layout is done by the macros, you shouldn't change anything.
5532 \begin_layout Subsection
5536 \begin_layout Standard
5537 First thing to enter is the header information.
5538 It consists of seven entries, of which some are optional.
5542 \begin_layout Itemize
5550 \begin_layout Itemize
5558 \begin_layout Itemize
5566 \begin_layout Itemize
5574 \begin_layout Itemize
5579 : [optional] if more than one author: whom to contact for offprint requests.
5582 \begin_layout Itemize
5587 : [optional] mail address for contacts.
5590 \begin_layout Itemize
5598 Received: <date>; Accepted <date>
5601 \begin_layout Standard
5602 There is no need to issue the
5608 command, this is done automatically by LyX when the header is finished.
5609 Although the order of the single header entries doesn't matter it is advised
5610 to keep the above sequence, just to get the best optics and meets the layout
5611 of the real document.
5614 \begin_layout Standard
5615 If you want to place footnotes in the header block, e.g.
5619 \begin_layout Standard
5627 to state your present address, just use the standard footnote via
5632 nsert\SpecialChar \menuseparator
5640 LyX will automagically use the term
5649 \begin_layout Standard
5650 In addition to these topics, the macros use three additional LaTeX commands
5651 that have no counterpart in LyX:
5654 \begin_layout Itemize
5661 to separate different names for more than one author and institute, respectivel
5665 \begin_layout Itemize
5672 to mark corresponding author/institute pairs.
5673 The institutes are numbered sequentially as they appear in the
5677 field, so you have to put a marker to each author.
5680 \begin_layout Itemize
5687 to supply an email address for fast contact.
5690 \begin_layout Standard
5691 In all cases, the appropriate command has to be entered in LyX an marked
5697 \begin_layout Subsection
5701 \begin_layout Standard
5702 The abstract should immediately follow the header block.
5703 With version 5 the abstract environment was changed to a command, and there
5704 is now a resctriction to only one paragraph.
5705 In addition, it should contain an entry with the keywords.
5706 This is not yet implemented for LyX, therefore you have to enter the LaTeX
5713 by hand and mark it as LaTeX code.
5714 Refer to the example paper.
5717 \begin_layout Subsection
5718 Supported environments
5721 \begin_layout Standard
5722 The A&A paper layout supports the following environments for structuring
5726 \begin_layout Itemize
5732 \begin_layout Itemize
5738 \begin_layout Itemize
5744 \begin_layout Itemize
5750 \begin_layout Itemize
5756 \begin_layout Itemize
5762 \begin_layout Itemize
5768 \begin_layout Itemize
5774 \begin_layout Itemize
5780 \begin_layout Itemize
5786 \begin_layout Itemize
5792 \begin_layout Itemize
5798 \begin_layout Subsection
5799 Commands not supported by LyX
5802 \begin_layout Standard
5803 Some commands are not yet supported by the
5808 Some have already been mentioned.
5809 For the sake of completeness, they are listed all together here:
5812 \begin_layout Itemize
5820 \begin_layout Itemize
5828 \begin_layout Itemize
5836 \begin_layout Itemize
5844 \begin_layout Itemize
5852 \begin_layout Itemize
5860 \begin_layout Itemize
5868 \begin_layout Itemize
5876 \begin_layout Standard
5877 If you want to use any of these commands, you have to enter them yourself.
5880 Do not forget to mark them as LaTeX code!
5883 \begin_layout Subsection
5884 Figure and Table Floats
5887 \begin_layout Standard
5888 LyX provides support for the necessary float environments
5890 figure, figure*, table
5896 , therefore we won't tell much about it here.
5903 Just remember that tables should be left-aligned.
5904 For that, select the table and change the alignment in
5909 dit\SpecialChar \menuseparator
5914 aragraph\InsetSpace ~
5918 \begin_layout Standard
5923 only one special thing: the figures with caption besides the figure.
5924 To create such a figure, you have to do the following:
5927 \begin_layout Enumerate
5928 Create a wide figure float:
5933 nsert\SpecialChar \menuseparator
5938 t\SpecialChar \menuseparator
5941 , then right click in the figure and select
5953 \begin_layout Enumerate
5954 Enter your caption text.
5957 \begin_layout Enumerate
5962 to move the cursor above the caption.
5965 \begin_layout Enumerate
5969 \begin_layout Enumerate
5970 Position the cursor behind the figure and insert a horizontal fill:
5975 nsert\SpecialChar \menuseparator
5983 \SpecialChar \menuseparator
5986 orizontal\InsetSpace ~
5992 \begin_layout Enumerate
5993 Switch to LaTeX mode:
6001 \begin_layout Enumerate
6011 Do not close the brace!
6014 \begin_layout Enumerate
6015 Position the cursor behind the caption text, switch to LaTeX mode and insert
6026 \begin_layout Standard
6027 Also, refer to the figures in the example paper.
6030 \begin_layout Subsection
6034 \begin_layout Standard
6035 For submission, the paper has to be formated in a special double-spacing
6037 For this purpose, you have to give the option
6041 to the documentclass.
6042 This must be done using the extra class options field in the
6047 ocument\SpecialChar \menuseparator
6055 Just enter the string
6062 \begin_layout Subsection
6066 \begin_layout Standard
6071 directory contains an example paper written with LyX.
6072 It is the example paper from the original macro package, translated to
6074 Use it for inspiration, and compare the original LaTeX code with LyX way
6078 \begin_layout Section
6082 \begin_layout Standard
6088 \begin_layout Subsection
6092 \begin_layout Standard
6093 AASTeX is a set of macros produced by the American Astronomical Society
6094 to facilitate electronic manuscript submission to the three journals they
6095 publish: the Astrophysical Journal (including the Letters and Supplement),
6096 the Astronomical Journal, and the Publications of the Astronomical Society
6098 LyX has proven to be an excellent tool for generating these documents,
6099 especially given its equation, citation, and figure handling capabilities.
6100 LyX requires version 5.0 (or higher) of these macros; preferably 5.2, which
6101 is the version described here, or higher.
6102 Versions prior to 5.0 are intended for use with LaTeX2.09 and are fundamentally
6103 incompatible with LyX.
6104 The AASTeX package may be downloaded from the AASTeX Web site
6107 \begin_layout Standard
6108 \begin_inset VSpace medskip
6114 \begin_layout Standard
6116 \begin_inset LatexCommand \url{http://www.journals.uchicago.edu/AAS/AASTeX}
6123 \begin_layout Standard
6124 \begin_inset VSpace medskip
6130 \begin_layout Standard
6131 A complete user guide is contained in that package and you should familiarize
6132 yourself with it thoroughly before embarking on writing a paper in LyX.
6133 LyX will not reduce the need to figure out all the AASTeX commands, it
6134 will only reduce the drudgery of typing everything in.
6135 It is your responsibility to ensure that the final exported LaTeX document
6136 conforms completely to the requirements of the journal to which you are
6137 submitting your paper.
6140 \begin_layout Subsection
6141 Starting a New Paper
6144 \begin_layout Standard
6145 I strongly suggest that you start with the AASTeX template file.
6151 ile\SpecialChar \menuseparator
6158 , enter the new file name, then choose the
6163 This will show the most common fields found in a manuscript.
6164 Simply overwrite the existing text (including the brackets,
6168 ) with the correct information.
6169 Many of the AASTeX commands and environments can be implemented directly
6170 in LyX, but some cannot: most noticeably
6182 , which should stick out like a sore thumb if you actually just opened the
6184 For commands such as these, the LaTeX code must be entered directly and
6186 Such commands are referred to as ERT, or Evil Red Text.
6187 I tried to minimize the amount of ERT needed in an AASTeX document, but
6188 there is still a bit more required than any of us would like.
6191 \begin_layout Subsection
6192 Finishing Your Paper
6195 \begin_layout Standard
6196 When the paper is finished to your satisfaction and previews/prints correctly,
6198 \begin_inset Quotes eld
6202 \begin_inset Quotes erd
6205 actions which need to be done before you submit it to the journals.
6209 \begin_layout Enumerate
6210 Export your paper as a LaTeX file (
6215 ile\SpecialChar \menuseparator
6220 xport\SpecialChar \menuseparator
6231 \begin_layout Enumerate
6236 file with your favorite text editor
6240 \begin_layout Enumerate
6241 remove the comment lines before the
6250 \begin_layout Enumerate
6255 usepackage...{fontenc}
6257 line if it appears (usually just after
6272 \begin_layout Enumerate
6273 remove everything between (and including) the
6285 commands, except for any commands you specifically put into the LaTeX preamble
6286 (which should appear immediately after the
6287 \begin_inset Quotes eld
6290 User specified LaTeX commands
6291 \begin_inset Quotes erd
6302 \begin_layout Enumerate
6303 Run the resulting file through LaTeX to make sure it still processes correctly.
6306 \begin_layout Enumerate
6307 Reread the journal requirements to make sure your filenames and formats
6311 \begin_layout Enumerate
6315 \begin_layout Subsection
6316 Comments On Specific Commands
6319 \begin_layout Standard
6320 I will not describe the detailed usage of the individual AASTeX commands:
6321 the AASTeX User Guide (
6325 ) gives a good description of each.
6326 Thus it's probably easiest for me to go down the list as found in the guide
6327 and offer comments where necessary.
6328 So let's begin \SpecialChar \ldots{}
6332 \begin_layout Subsubsection
6333 Things that work as expected
6336 \begin_layout Standard
6340 \begin_layout Standard
6351 \begin_layout Standard
6352 Because they work as you might expect, I simply list them and the section
6453 begin{thebibliography}
6461 (2.13.2), all the cite commands and their variations (2.13.2), the generic
6462 graphicx figure commands (2.14.1),
6486 (2.15.4, amongst other places),
6513 \begin_layout Standard
6514 The following style options also work correctly:
6535 Simply put them in the
6541 Layout\SpecialChar \menuseparator
6547 \begin_layout Standard
6551 \begin_layout Standard
6562 \begin_layout Subsubsection
6563 Things that work, but require more comment
6566 \begin_layout Standard
6567 The following items work, but require a little more discussion:
6570 \begin_layout Itemize
6571 These items are reserved for use by the journal editors, but you can put
6572 them into the LaTeX preamble if you feel compelled to do so:
6605 \begin_layout Itemize
6606 These items may be placed in the LaTeX preamble, and are included as blanks
6607 in the template file:
6628 \begin_layout Itemize
6635 (2.3) -- can only be used
6636 \begin_inset Quotes eld
6640 \begin_inset Quotes erd
6643 , not in the middle of a paragraph.
6644 Use ERT if you need to embed it.
6647 \begin_layout Itemize
6654 (2.3) -- will have extra {} after it.
6655 This should not cause an error.
6658 \begin_layout Itemize
6665 (2.6) -- can only be used
6666 \begin_inset Quotes eld
6670 \begin_inset Quotes erd
6673 , not in the middle of a paragraph.
6674 Use ERT if you need to embed it.
6677 \begin_layout Itemize
6684 (2.8) -- can't insert a cross-reference tag, you must type the tag name
6688 \begin_layout Itemize
6695 (2.8) -- same as for
6702 \begin_layout Itemize
6709 (2.9) -- will have extra {} after it.
6710 This should not cause an error.
6713 \begin_layout Itemize
6720 (2.11) -- will have extra {} after it.
6721 This should not cause an error.
6724 \begin_layout Itemize
6731 (2.14.2) -- you can insert an optional filename argument by placing the cursor
6732 at the beginning of the text and selecting
6734 Insert\SpecialChar \menuseparator
6739 \begin_inset Quotes eld
6743 \begin_inset Quotes erd
6746 inserts an optional argument of the type needed by
6753 Hopefully it will be renamed someday.
6756 \begin_layout Itemize
6769 for the catalog ID optional parameter
6772 \begin_layout Itemize
6785 for the catalog ID optional parameter
6788 \begin_layout Subsubsection
6789 Things not implemented, use ERT
6792 \begin_layout Standard
6796 \begin_layout Standard
6807 \begin_layout Standard
6830 setcounter{equation}
6832 (2.12), Journal name abbreviations (2.13.4),
6868 (2.15.4, insert it as the first element in the lefthand cell after where
6870 Don't use any of LyX's rules in the table),
6882 (2.15.5), much of Misc (2.17, except
6933 \begin_layout Standard
6937 \begin_layout Standard
6948 \begin_layout Subsubsection
6949 Things that cannot be implemented
6952 \begin_layout Standard
6953 \SpecialChar \ldots{}
6954 at least in any meaningful sort of way, so I suggest ignoring them.
6955 They are the references environment (2.13.3), and the deluxetable environment
6957 If you really, really need to use deluxetable, I suggest editing it in
6958 a separate file with a text editor, then using
6963 nsert\SpecialChar \menuseparator
6971 to include it in your LyX document.
6976 file to see an example of this.
6979 \begin_layout Subsection
6980 FAQs, Tips, Tricks, and Other Ruminations
6983 \begin_layout Subsubsection
6984 Getting LyX and AASTeX to cooperate
6987 \begin_layout Standard
6988 It can be a bit tricky to get LyX to recognize a new layout and document
6990 When all else fails, do this:
6993 \begin_layout Enumerate
6994 Make certain that LaTeX can find AASTeX.
6995 Copy sample.tex (and perhaps table.tex) from the AASTeX distribution into
6996 a directory completely unrelated to LaTeX or AASTeX and run LaTeX on
7003 \begin_layout Enumerate
7010 /usr/.../share/lyx/layouts
7019 \begin_layout Enumerate
7025 ools\SpecialChar \menuseparator
7032 in LyX, then restart LyX.
7035 \begin_layout Enumerate
7036 Open a regular new file, not from a template.
7037 Does AASTeX appear in the class list in
7042 ocument\SpecialChar \menuseparator
7052 \begin_layout Standard
7053 If you get a warning from an existing AASTeX document about not being able
7054 to find the AASTeX layout or a message about
7055 \begin_inset Quotes eld
7058 You should not mix title layouts with normal ones
7059 \begin_inset Quotes erd
7062 , things haven't been installed correctly.
7065 \begin_layout Subsubsection
7066 LaTeX error processing a table
7069 \begin_layout Standard
7070 LyX, by default, attempts to center the table caption/title.
7071 This seems to produce a bad interaction in AASTeX so you should click somewhere
7072 in the caption/title, then select
7077 dit\SpecialChar \menuseparator
7082 aragraph\InsetSpace ~
7097 This took care of it for me.
7100 \begin_layout Subsubsection
7102 \begin_inset LatexCommand \label{cite}
7109 \begin_layout Standard
7110 A couple of things: 1) I have noticed some funny spacing in the reference
7111 entries in the text.
7112 When you enter the bibliography item data, make sure their is
7116 space between the last author and the parenthesis setting off the year;
7131 2) Entering the references at all is not obvious.
7132 The easiest thing is to start typing your first reference at the end of
7133 the document, then mark it as type
7138 That will put a small gray box in front of what you just typed.
7139 Click on the box to fill in the rest of the information.
7140 For new references, go to the end of an existing reference and press return.
7141 That will create a new line with its own box, etc.
7144 \begin_layout Subsubsection
7148 \begin_layout Standard
7149 Even though AASTeX provides its own figure commands (
7155 , for example), I much prefer LaTeX's standard figure commands (with the
7164 commands as ERT into a Figure Float box if you desire, but I never
7165 have much luck getting the layout right.
7166 With the standard graphics, LyX will insert a
7170 usepackage{graphicx}
7172 command into the LaTeX preamble and handle the figures in the standard
7173 LaTeX2e way, interspersing the figures in the text.
7174 I believe ApJ accepts figures exactly this way now; AJ might still use
7176 \begin_inset Quotes eld
7179 stack everything at the end
7180 \begin_inset Quotes erd
7186 \begin_layout Subsubsection
7187 Things I could have done, but didn't
7190 \begin_layout Standard
7192 \begin_inset Quotes eld
7196 \begin_inset Quotes erd
7199 things I could have implemented, but chose not to.
7200 For instance, I saw no point in double-spacing the text in the LyX window,
7201 even though it is double-spaced in the paper manuscript.
7202 Also, I chose not to make separate layouts for the preprint and preprint2
7204 Since I assume you will spend most of your time in the plain manuscript
7205 mode anyway, I decided not to chew up more disk space with this.
7209 \begin_layout Subsection
7213 \begin_layout Standard
7214 Your mileage may vary.
7215 I've now had papers published by both ApJ and AJ that have had 98% of the
7216 effort done in LyX; the last 2% was the LaTeX post-processing and a few
7218 I have had no trouble with the submission process, and I'm sure the journals
7219 were never aware that there might be a difference.
7220 So, go forth and publish!
7223 \begin_layout Section
7227 \begin_layout Standard
7230 Panayotis Papasotiriou
7233 \begin_layout Subsection
7237 \begin_layout Standard
7238 The ijmpd package is a set of macros that facilitates electronic manuscript
7241 International Journal of Modern Physics D
7243 published by World Scientific.
7244 The name of the document class is
7249 This file, together with instructions for the authors, can be downloaded
7251 \begin_inset LatexCommand \url{http://www.worldscinet.com/ijmpd/mkt/guidelines.shtml}
7256 The ijmpd package is a modified version of the standard
7257 \begin_inset Quotes eld
7261 \begin_inset Quotes erd
7265 Most of its features are supported by LyX.
7266 I have recently used LyX successfully to write an article submitted to
7269 International Journal of Modern Physics D
7274 \begin_layout Subsection
7278 \begin_layout Standard
7279 As usual, the easiest way to write a paper is to start with a template.
7285 ile\SpecialChar \menuseparator
7297 This will give an (almost) empty document that includes the most common
7298 fields found in a manuscript.
7299 Simply overwrite the existing text (including the brackets,
7303 ) with the correct information.
7304 You should keep in mind the following remarks.
7307 \begin_layout Enumerate
7308 LyX won't let you change the font size and the page style of the document,
7309 because the ijmpd package does not allow such modifications.
7312 \begin_layout Enumerate
7313 The ijmpd package requires that the language of the document should not
7315 Before previewing your paper, be sure that the babel package is not used.
7316 To do this, click on
7321 ools\SpecialChar \menuseparator
7335 checkbox in the language settings, and click on
7346 , if you wish to make this change permanent).
7349 \begin_layout Enumerate
7350 Two new environments, named
7351 \begin_inset Quotes eld
7355 \begin_inset Quotes erd
7359 \begin_inset Quotes eld
7363 \begin_inset Quotes erd
7366 are available (their use is obvious).
7369 \begin_layout Enumerate
7370 Appendices may be added to the paper.
7371 LyX offers a special environment, called
7372 \begin_inset Quotes eld
7376 \begin_inset Quotes erd
7379 which marks the beginning of the appendix.
7380 An appendix can contain normal sections, subsections, or subsubsections.
7383 \begin_layout Enumerate
7384 The ijmpd package implements table captions quite differently than LyX does.
7385 As a result, a table created by LyX is printed correctly, but its caption
7387 If you need table captions, you should implement the whole table float
7392 file, then include this file to the LyX document (
7397 nsert\SpecialChar \menuseparator
7406 Details on how to create an ijmpd table float can be found in the file
7411 , which is included in the ijmpd package.
7414 \begin_layout Subsection
7415 Preparing a paper for submission
7418 \begin_layout Standard
7419 Before you submit your paper you must export the LyX document as a LaTeX
7425 ile\SpecialChar \menuseparator
7430 xport\SpecialChar \menuseparator
7437 ), then make the following changes to the resulting
7444 \begin_layout Enumerate
7445 Remove the comment lines before the
7454 \begin_layout Enumerate
7455 Remove everything between (and including) the
7467 commands, except for any commands you specifically put into the LaTeX preamble.
7470 \begin_layout Standard
7475 file should be saved and processed through LaTeX as many times as necessary.
7476 You may also want to check the resulting
7483 \begin_layout Subsection
7487 \begin_layout Standard
7488 The use of ERT is optional, and is reduced to three commands, which affect
7489 the look of the page.
7490 If you started writing your paper by using the
7494 template, the ERT needed is already in its place; you usually don't need
7496 You may only change the first ERT to specify the information printed to
7497 the top of odd and even pages (authors' names and short paper's title,
7499 This ERT must have the form
7503 markboth{Authors' Names}{Short Paper's Title}
7508 \begin_layout Section
7512 \begin_layout Standard
7515 Panayotis Papasotiriou
7518 \begin_layout Subsection
7522 \begin_layout Standard
7523 The Kluwer package is a set of macros produced by Kluwer Academic Publishers
7524 that facilitates electronic manuscript submission to the journals they
7526 Most known of them (at least in my domain of interest) are
7528 Astrophysics and Space Science
7534 , but there are many others (see a complete list at
7535 \begin_inset LatexCommand \url{http://www.wkap.nl/jrnllist.htm/JRNLHOME}
7540 The Kluwer package may be downloaded from the site
7541 \begin_inset LatexCommand \url{http://www.wkap.nl/kaphtml.htm/STYLEFILES}
7546 A complete user guide is contained in that package (but it can also be
7547 downloaded separately).
7550 \begin_layout Standard
7551 LyX supports many features of the package but not everything.
7552 However, the ERT needed is reduced to some
7553 \begin_inset Quotes eld
7557 \begin_inset Quotes erd
7560 commands of the package (see\InsetSpace ~
7562 \begin_inset LatexCommand \ref{subsec:kluwer_peculiarities}
7567 I have recently used LyX to write an article submitted to the
7569 Astrophysics and Space Science
7571 without any problem.
7574 \begin_layout Subsection
7578 \begin_layout Standard
7579 The easiest way to write a paper is to start with the Kluwer template file.
7582 File\SpecialChar \menuseparator
7594 This will give an (almost) empty document that includes the most common
7595 fields found in a manuscript and a short description of their use.
7596 As in most templates, simply overwrite the existing text (including the
7601 ) with the correct information.
7604 \begin_layout Subsection
7605 Preparing a paper for submission
7608 \begin_layout Standard
7609 As in the AASTeX package, before you submit your paper to a journal you
7611 \begin_inset Quotes eld
7615 \begin_inset Quotes erd
7621 \begin_layout Enumerate
7622 Export your paper as a LaTeX file.
7623 To do this, click on
7628 ile\SpecialChar \menuseparator
7633 xport\SpecialChar \menuseparator
7644 \begin_layout Enumerate
7649 file with a text editor and make the following changes
7653 \begin_layout Enumerate
7654 remove the comment lines before the
7663 \begin_layout Enumerate
7664 remove everything between (and including) the
7676 commands, except for any commands you specifically put into the LaTeX preamble.
7679 \begin_layout Standard
7688 \begin_layout Enumerate
7693 file through LaTeX as many times as necessary (usually up to three).
7696 \begin_layout Enumerate
7701 document using, e.g.,
7705 , and check if everything is ok (it should, if you didn't make any mistake).
7708 \begin_layout Subsection
7709 \begin_inset Quotes eld
7713 \begin_inset Quotes erd
7716 of the Kluwer package
7717 \begin_inset LatexCommand \label{subsec:kluwer_peculiarities}
7724 \begin_layout Standard
7725 The Kluwer package has the following
7726 \begin_inset Quotes eld
7730 \begin_inset Quotes erd
7736 \begin_layout Enumerate
7737 It is possible to write multiple articles in the same LaTeX file
7741 \begin_layout Standard
7742 I can't imagine any good reason to do this.
7748 Each article must be included in the environment
7749 \begin_inset Quotes eld
7753 \begin_inset Quotes erd
7757 Unfortunately, this environment cannot be omitted, even if you write just
7759 Therefore, each article starts with the command
7765 and, obviously, ends with the command
7772 Although this can be implemented in LyX, I didn't included it, since it
7773 looks ugly and can confuse the novice user.
7774 Therefore, you need to enter them directly and mark them as LaTeX code
7776 \begin_inset Quotes eld
7780 \begin_inset Quotes erd
7786 \begin_layout Enumerate
7787 Information given at the beginning of the article (i.e., title, subtitle,
7788 author, institution, running title, running author, abstract and keywords)
7789 must be included in an environment called
7790 \begin_inset Quotes eld
7794 \begin_inset Quotes erd
7798 This is not implemented in LyX, so you must enter title, subtitle etc.
7799 between two ERT lines (
7814 \begin_layout Enumerate
7815 According to the user manual, the label of each bibliography item must be
7839 \begin_layout Standard
7844 template takes care of all these
7845 \begin_inset Quotes eld
7849 \begin_inset Quotes erd
7853 If you start a new paper using this template you don't need to do anything
7858 \begin_layout Enumerate
7859 don't delete the ERT included in the template, and
7862 \begin_layout Enumerate
7863 copy the example bibliography item included in the template and modify it
7864 as necessary to enter new bibliography items.
7867 \begin_layout Section
7871 \begin_layout Standard
7877 \begin_layout Subsection
7881 \begin_layout Standard
7882 The LyX document classes
7884 article (koma-script)
7888 report (koma-script)
7906 correspond to the LaTeX document classes
7923 of the Koma-Script family.
7924 They are replacements for the standard document classes
7940 , resp., and fit better to European typography conventions in a number of
7944 \begin_layout Itemize
7945 Standard character size is 11pt in
7947 article (koma-script)
7951 report (koma-script)
7959 letter (koma-script)
7964 \begin_layout Itemize
7965 Headings, labels of the description environment, and a number of elements
7968 letter (koma-script)
7970 document class are set in a bold sans serif font.
7974 \begin_layout Standard
7975 There is a big difference between the bold sans serif old cm fonts and new
7976 ec fonts, especially in the appearance of headings.
7977 In comparison, the ec bold sans serif fonts look a bit thin.
7978 Here the LaTeX package
7985 helps to produce the
7986 \begin_inset Quotes eld
7990 \begin_inset Quotes erd
7993 appearance when using the ec fonts.
7998 The numbering of chapter headings is made in the same way as the numbering
7999 of section headings, that is without the extra line
8000 \begin_inset Quotes eld
8003 Chapter\SpecialChar \ldots{}
8005 \begin_inset Quotes erd
8009 In addition, the appearance of the headings can be modified by using a
8010 number of options (in LyX to be entered in the field
8024 ayout\SpecialChar \menuseparator
8032 A detailed German description of these options can be found in the Koma-Script
8040 \begin_layout Itemize
8041 The main means in the Koma-Script document classes to design the type area
8050 (in LyX to be entered in the extra class options field in the dialog
8055 ocument\SpecialChar \menuseparator
8063 They make a clearer modification of page margins possible as do the options
8069 ocument\SpecialChar \menuseparator
8077 A detailed German description of these and other type area options can
8078 be found in the Koma-Script documentation
8085 \begin_layout Itemize
8086 The LaTeX document classes of the Koma-Script family define a number of
8087 additional commands.
8088 Those part of it which makes sense in LyX is implemented in corresponding
8092 \begin_layout Standard
8093 A detailed German description of the LaTeX document classes of the Koma-Script
8094 family can be found in the Koma-Script documentation
8102 \begin_layout Standard
8103 There is an English translation
8107 , but it is not a complete one.
8112 The following sections describe only those aspects, which are relevant
8116 \begin_layout Subsection
8117 article (koma-script), report (koma-script), and book (koma-script)
8120 \begin_layout Standard
8121 The document classes
8123 article (koma-script)
8127 report (koma-script)
8137 are implemented in the layout files
8150 They contain all the paragraph types of the corresponding standard document
8163 , resp., partly modified, with the exception of the LyX specific
8167 -type, which is replaced by the new
8171 -type having the same functionality.
8176 -Type there is a number of new paragraph types added.
8183 letter (koma-script)
8188 \begin_layout Itemize
8197 : are equivalents to
8205 , resp., additionally inserting an entry in the table of contents.
8214 are not contained in
8216 article (koma-script)
8221 \begin_layout Itemize
8238 , resp., additionally clearing running heads.
8245 article (koma-script)
8251 \begin_layout Standard
8264 report (koma-script)
8266 , but since this is identical to
8270 , is has not been implemented in LyX.
8278 \begin_layout Itemize
8283 : generates a heading directly above the following paragraph in the standard
8284 character size without affecting the structure of the document.
8287 \begin_layout Itemize
8296 are special captions which respect the different space settings needed for
8297 captions placed above or below an element (if you follow strict typographic
8298 rules, you might want to place table captions always above the table).
8299 You can also use the class option
8316 You need at least Koma-Script version 2.8q to use this.
8319 \begin_layout Itemize
8324 : can be used to set a bonmot, e.
8328 \begin_layout Standard
8340 \begin_layout Standard
8348 at the beginning of a chapter.
8349 If you use the optional argument (
8354 nsert\SpecialChar \menuseparator
8358 ), you can insert the dictum's author there.
8359 Dictum and author are separated by a line.
8360 You need at least Koma-Script version 2.8q to use this.
8367 article (koma-script)
8372 \begin_layout Standard
8373 The following types, together with the standard types
8385 , form the title area of the document.
8386 They must be entered ahead of the first
8387 \begin_inset Quotes eld
8391 \begin_inset Quotes erd
8398 \begin_layout Standard
8399 The corresponding LaTeX commands must appear before the
8410 When such a type is used more than once, the latter usage overwrites the
8411 former one, that means, for every type only the latest usage is valid.
8412 The order of the different types however has, like
8424 , no effect on the appearance of the produced document.
8427 \begin_layout Itemize
8432 : produces a centered paragraph above the ordinary title (
8444 ) for the subject of the document.
8447 \begin_layout Itemize
8452 : produces a centered paragraph below the ordinary title (
8464 ) for the publishers' name.
8467 \begin_layout Itemize
8474 report (koma-script)
8480 produces a centered paragraph on its own page behind the title page, or
8483 article (koma-script)
8485 produces a centered paragraph below the ordinary title (
8504 \begin_layout Itemize
8509 : produces a left aligned paragraph above the ordinary title (
8525 ) for a document`s head.
8528 \begin_layout Itemize
8533 : produces in a double-sided print in
8535 report (koma-script)
8541 a left-aligned paragraph at the top of the title page`s back or has no
8542 effect in a single-sided print or in
8544 article (koma-script)
8549 \begin_layout Itemize
8554 : produces in a double-sided print in
8556 report (koma-script)
8562 a left-aligned paragraph at the bottom of the title page`s back or has
8563 no effect in a single-sided print or in
8565 article (koma-script)
8570 \begin_layout Itemize
8575 : produces a special
8576 \begin_inset Quotes eld
8580 \begin_inset Quotes erd
8583 page ahead of the actual document containing a paragraph without special
8587 \begin_layout Standard
8588 The layout files for the document classes
8590 article (koma-script)
8594 report (koma-script)
8605 This is thought of as a place to define your own types.
8610 in your personal layout directory and edit the file!
8613 \begin_layout Subsection
8614 letter (koma-script)
8617 \begin_layout Standard
8621 \begin_layout Standard
8632 \begin_layout Standard
8636 letter (koma-script)
8638 is implemented in the layout file
8643 It contains all the paragraph types of the corresponding standard document
8648 , partly modified, with the exception of the LyX specific types
8660 type, which is replaced by the new
8665 In addition, it contains, in contrast to the standard document class, the
8683 Furthermore, there are a number of new letter specific types.
8686 \begin_layout Standard
8690 \begin_layout Standard
8701 \begin_layout Standard
8702 The appearance of the letter produced by this document class can be controlled
8703 by a number of LaTeX commands, which you can put in the LaTeX preamble.
8707 \begin_layout Standard
8708 For example, the standard appearance of the letter`s heading, consisting
8709 of name and address, is quite self-willed.
8711 \begin_inset Quotes eld
8715 \begin_inset Quotes erd
8718 heading is produced by the following LaTeX commands in the preamble:
8721 \begin_layout LyX-Code
8731 \begin_layout LyX-Code
8747 \begin_layout LyX-Code
8757 \begin_layout LyX-Code
8777 A detailed German description of such LaTeX commands can be found in the
8778 Koma-Script documentation
8783 With it, the letter's author can produce his personal letter layout.
8786 \begin_layout Standard
8795 define the beginning of the letter and must be used in every letter.
8796 To emphasize them in the LyX document class, they are marked with the letter
8807 It is possible to write any number of letters in one file.
8812 type produces a new letter using the same addressee and a
8816 type produces a new addressee.
8833 are ordinary paragraph types and can also be used several times in one
8834 and the same letter.
8837 \begin_layout Itemize
8842 : produces a paragraph for the addressee and implicitly defines the beginning
8846 \begin_layout Itemize
8851 : produces a paragraph for the form of address and implicitly produces a
8855 \begin_layout Itemize
8860 : produces a paragraph for a close.
8863 \begin_layout Itemize
8868 : produces a paragraph for a postscript.
8871 \begin_layout Itemize
8876 : produces a paragraph for a distribution list.
8879 \begin_layout Itemize
8884 : produces a paragraph for enclosures.
8887 \begin_layout Standard
8928 are input types provided with a label to enter information, which will
8929 be processed by the document class.
8933 \begin_layout Standard
8934 It could be seen as a matter of inconsequence, that the types
8942 described above are not such input types as well.
8943 Because of the special meaning of those types, however, I have implemented
8944 them as ordinary paragraph types with a one letter mark in the left margin.
8945 Moreover, it would affect my feeling of symmetry, if the
8953 type had such a serious different appearance.
8958 The types must be used ahead of the corresponding
8965 \begin_layout Standard
8966 An implementation of these types in a WYSIWYG fashion does not seem to make
8967 sense, because the real appearance of the produced letter does not only
8968 depend on the usage of the particular type, but also on other factors.
8969 For example, a signature entered in the
8973 type will in the standard behavior appear in the produced letter only,
8974 when in the same letter also a
8979 The entered value of the
8983 type will in the standard behavior not appear in the produced letter at
8985 The possibility to design the letter`s heading freely is already indicated
8986 in a footnote above.
8989 \begin_layout Standard
8990 The input types can also be used as empty paragraphs.
8991 This makes sense e.\InsetSpace ~
9002 type is not used at all, in the standard behavior the value of the
9006 type is used as signature, whereas if an empty
9010 type is used, no signature value is defined.
9013 \begin_layout Standard
9014 By using the input types it is possible to write a letter template, containing
9015 filled input types with your personal dates (name, address, etc.) and empty
9016 input types for other dates you want to enter.
9019 \begin_layout Itemize
9024 : sender's name, in the standard behavior appears as a centered paragraph
9025 in small caps in the letter`s heading.
9028 \begin_layout Itemize
9033 : sender's signature, in the standard behavior appears below the
9042 type is used, the value of the
9046 type appears instead.
9049 \begin_layout Itemize
9054 : sender's address, in the standard behavior appears in a centered paragraph
9055 in the letter`s heading below the sender's name.
9058 \begin_layout Itemize
9063 : sender's telephone number, in the standard behavior only sets the LaTeX
9073 \begin_layout Itemize
9078 : place of the letter`s making.
9081 \begin_layout Itemize
9086 : date of the letter`s making.
9095 , in the standard behavior, produce the place and the date in a right-aligned
9096 line below the addressee's field.
9101 type is used, neither place nor date appear, independent of the value of
9111 type is used, the date of the letter `s production is used.
9114 \begin_layout Itemize
9119 : sender`s back address, in the standard behavior appears above the addressee's
9120 field in a small sans serif font.
9123 \begin_layout Itemize
9128 : special mail information, in the standard behavior appears underlined
9129 above the addressee's field below the back address.
9132 \begin_layout Itemize
9137 : additional information, in the standard behavior appears on right side
9138 below the addressee`s field.
9141 \begin_layout Itemize
9146 : the letter's title, in the standard behavior appears in a big, bold, sans
9147 serif font above the subject.
9150 \begin_layout Itemize
9155 : the letter's subject, in the standard behavior appears in a bold font
9163 \begin_layout Standard
9184 produce a business letter like line above the
9188 line containing the fields
9189 \begin_inset Quotes eld
9193 \begin_inset Quotes erd
9197 \begin_inset Quotes eld
9201 \begin_inset Quotes erd
9205 \begin_inset Quotes eld
9209 \begin_inset Quotes erd
9213 \begin_inset Quotes eld
9217 \begin_inset Quotes erd
9221 \begin_inset Quotes eld
9225 \begin_inset Quotes erd
9229 \begin_inset Quotes eld
9233 \begin_inset Quotes erd
9237 For the date field, the value of the
9243 \begin_inset Quotes eld
9246 business letter types
9247 \begin_inset Quotes erd
9250 is used, the value of the
9254 type however does not appear, but only the LaTeX variable
9261 The ordinary output of place and date in a right-aligned line below the
9262 addressee`s field is suppressed.
9263 The types are implemented as input types provided with a label and must
9264 be used ahead of the corresponding
9271 \begin_layout Itemize
9279 \begin_layout Itemize
9287 \begin_layout Itemize
9295 \begin_layout Itemize
9303 \begin_layout Itemize
9311 \begin_layout Subsection
9312 The new letter class: letter (koma-script v.2)
9315 \begin_layout Standard
9318 Jürgen Spitzmüller
9321 \begin_layout Standard
9322 \begin_inset VSpace medskip
9328 \begin_layout Standard
9330 Koma-Script version 2.8 has introduced a new letter class
9334 which superceeds the now unsupported
9339 It has --- on the LaTeX side --- a completely new interface and is not
9340 compatible with the old class.
9341 Therefore, LyX supports both, though it is recommended to use the new class.
9344 \begin_layout Standard
9345 This class covers the same functionality as
9347 letter (koma-script),
9354 (receiver's address, same as
9371 will start a new letter (i.
9375 \begin_layout Standard
9387 \begin_layout Standard
9395 you can write several letters per document).
9396 New elements are sender's
9412 and the possibility to use a
9421 nsert\SpecialChar \menuseparator
9431 \begin_layout Standard
9432 The biggest improvement is, though, that the letter's layout is configurable
9433 at almost any needs.
9434 This can be done via the preamble or with a special style file (Letter
9435 Class Option, extension
9439 ), that will be read in as a class option.
9443 \begin_layout Standard
9444 The KOMA package comes with some default
9449 There is, for instance, a
9453 file that follows german typesetting rules, or a
9457 that provides the default layout of the old
9462 The latter can be loaded with the class option
9471 ayout\SpecialChar \menuseparator
9476 ocument\SpecialChar \menuseparator
9488 template that is included in LyX for examples.
9489 A detailed description is to be found in the Koma-Script documentation
9497 \begin_layout Subsection
9501 \begin_layout Standard
9502 Visualizing the Koma-Script document classes in LyX, the LyX internals cause
9506 \begin_layout Itemize
9507 The chapter number of a
9511 type appears on a line of its own above the chapter heading instead of
9512 appearing in the same line ahead of it.
9513 The cause for that is the LyX internal behavior for the labeltype
9520 \begin_layout Itemize
9521 The headings of the types
9530 \begin_inset Quotes eld
9534 \begin_inset Quotes erd
9537 LaTeX table of contents, but not in the LyX table of contents (
9542 ocument\SpecialChar \menuseparator
9554 \begin_layout Itemize
9559 document class appear in a skip separation mode, not indented.
9560 This is the standard behavior, no special LaTeX commands are needed for
9567 ocument\SpecialChar \menuseparator
9574 dialog the corresponding radio button indicates
9590 value always has the effect that extra LaTeX commands are inserted in the
9591 document to produce the gap, which is not what is wanted in this case.
9594 \begin_layout Section
9602 \begin_layout Standard
9608 \begin_layout Subsection
9612 \begin_layout Standard
9613 These are the layout files for some of the journal formats used by Springer
9614 Verlag and listed on
9615 \begin_inset LatexCommand \url{http://www.springer.de/author/tex/help-journals.html}
9619 , where you should also go to fetch the class files (yes, these are LaTeX2e
9621 It is a modular system: the things common to all journals are implemented
9626 , which journal-specific layout files (such as, e.g.,
9630 for Journal of Geodesy) can include.
9633 \begin_layout Standard
9634 This means that implementing support for any other Springer journal on this
9635 list is as simple as writing your own
9643 file following the outline given in
9651 \begin_layout Standard
9652 It is reasonably well tested only for the Journal of Geodesy.
9661 come with the standard LyX distribution.
9662 Install the relevant class file (downloaded from Springer) in a proper
9663 directory, reconfigure LaTeX (in the teTeX case by running
9667 , as root if necessary --- doesn't LyX take care of this?), reconfigure
9668 LyX and it should work.
9671 \begin_layout Subsection
9675 \begin_layout Standard
9676 A large number of theorem-like styles ---
9682 \SpecialChar \ldots{}
9688 \begin_layout Standard
9691 Headnote, Dedication, Subtitle, Running_LaTeX_Title, Author_Running, Institute,
9692 Mail, Offprints, Keywords, Acknowledgements, Acknowledgement
9695 See the Springer class file documentation for details.
9698 \begin_layout Subsection
9702 \begin_layout Itemize
9714 \begin_layout Itemize
9717 Probability Theory and Related Fields
9723 --- Jean-Marc Lasgouttes
9726 \begin_layout Standard
9727 Add your own, it isn't so hard!
9730 \begin_layout Subsection
9734 \begin_layout Standard
9735 These files are partly based on the older
9739 , which was again based on a tinkered-with version of an old LaTeX 2.09 style
9745 layout, are now defunct.
9746 Jean-Marc Lasgouttes helped out big in making me find my way around the
9747 LyX layout file mechanism.
9750 \begin_layout Subsection
9754 \begin_layout Standard
9756 But probably less than in the old hacked-LaTeX
9763 \begin_layout Standard
9764 Limitations e.g.: does not display the number for theorem-like layouts, just
9768 \begin_layout Section
9776 \begin_layout Standard
9782 \begin_layout Subsection
9786 \begin_layout Standard
9787 These are the layout files for some of the journals of the American Geophysical
9789 It is assumed that you have both the AGU's own class files and AGUplus
9790 installed (everything to be found at
9791 \begin_inset LatexCommand \url{ftp://ftp.agu.org/journals/latex/journals}
9798 \begin_layout Subsection
9802 \begin_layout Standard
9812 They are still called this in the LyX GUI, though their LaTeX equivalents
9813 in the AGU classes are
9824 \begin_layout Standard
9825 Newly defined styles are
9862 These are mostly manuscript attributes and defined in the AGU class documentati
9866 \begin_layout Standard
9867 I suspect this is still badly incomplete.
9870 \begin_layout Subsection
9874 \begin_layout Standard
9891 \begin_layout Subsection
9895 \begin_layout Itemize
9898 Journal of Geophysical Research
9907 \begin_layout Standard
9908 Add your own, it isn't so hard! Look at the
9919 \begin_layout Subsection
9920 Bugs and things to remember
9923 \begin_layout Standard
9924 In order to use the new layouts, you must remember to do the following for
9928 \begin_layout Enumerate
9934 This can be done in the
9936 layout\SpecialChar \menuseparator
9941 document\SpecialChar \menuseparator
9945 (AGU articles are always in English, right? So
9952 \begin_layout Enumerate
9962 (Yes, this is a bug.)
9965 \begin_layout Enumerate
9966 Make sure you use the
9970 bibliography style, by entering
9974 into the second field of the BibTeX inset.
9975 None of the standard styles will do.
9978 \begin_layout Section
9986 \begin_layout Standard
9992 \begin_layout Subsection
9996 \begin_layout Standard
9997 This is the layout file for the European Geophysical Society journals.
10002 can be downloaded from the web site of the EGS under
10003 \begin_inset LatexCommand \url{www.copernicus.org}
10010 \begin_layout Subsection
10014 \begin_layout Standard
10017 Right_address, Latex_Title, Affil, Journal, msnumber, FirstAuthor, Received,
10025 The current layout file is unfortunately very unmodular and would benefit
10026 from using the various
10033 \begin_layout Section
10039 \begin_inset LatexCommand \label{sec:slitex}
10046 \begin_layout Standard
10054 \begin_layout Subsection
10058 \begin_layout Standard
10059 This section describes how to use LyX to make slides for overhead projectors.
10060 There are two document classes that can do this: the default slides class
10066 This section documents the former.
10069 \begin_layout Standard
10070 I'm going to say this again, nice and clear, so that there's no misunderstanding
10074 \begin_layout Standard
10075 \begin_inset VSpace bigskip
10081 \begin_layout Standard
10085 This section documents the class
10086 \begin_inset Quotes eld
10094 \begin_inset Quotes erd
10102 \begin_layout Standard
10103 \begin_inset VSpace bigskip
10109 \begin_layout Standard
10110 If you're looking for the documentation for
10111 \begin_inset Quotes eld
10119 \begin_inset Quotes erd
10122 , check out section\InsetSpace ~
10124 \begin_inset LatexCommand \ref{sec:foiltex}
10134 \begin_inset Quotes eld
10142 \begin_inset Quotes erd
10145 ] is actually somewhat better than the default
10153 \begin_layout Standard
10154 \SpecialChar \ldots{}
10155 or so I've been told repeatedly by its advocates.
10156 Having never used it, I have no idea if this claim is true or not.
10161 which this section documents.
10164 \begin_layout Standard
10165 This class is the LaTeX2e improvement of the old
10170 Every LaTeX2e distribution includes this class [which I'll just refer to
10172 \begin_inset Quotes eld
10180 \begin_inset Quotes erd
10183 from now on], so you're bound to have it.
10184 As I noted earlier, there are other classes, such as
10188 , which also produce slides for overhead projectors and do a better job
10190 However, there are some things which
10194 can do which the others can't, such as generate overlays.
10195 Read on to learn more!
10198 \begin_layout Subsection
10200 \begin_inset LatexCommand \label{sec:slidesetup}
10207 \begin_layout Standard
10208 Obviously, to use this document class, you need to select
10209 \begin_inset Quotes eld
10217 \begin_inset Quotes erd
10220 from the class list in the
10225 ocument\SpecialChar \menuseparator
10233 There are some other special things you should know about this class:
10236 \begin_layout Itemize
10237 Don't bother changing the options
10242 They're not supported by the
10249 \begin_layout Itemize
10258 behaves a bit differently for this class.
10259 The possible choices and what they do are as follows:
10263 \begin_layout Description
10268 The final output contains page numbers in the lower right corner.
10271 \begin_layout Description
10280 , but also prints out any time markers you've put in.
10281 This is the default.
10284 \begin_layout Description
10289 The final output contains no page numbers, time markers, or alignment markers.
10293 \begin_layout Itemize
10298 class has an extra option:
10304 \begin_inset Quotes eld
10312 \begin_inset Quotes erd
10315 in the extra class options.
10319 \begin_layout Standard
10320 Using this options allows you to add time markers to
10325 See section\InsetSpace ~
10327 \begin_inset LatexCommand \ref{sec:slideNote}
10335 \begin_layout Standard
10336 You can also use the template file
10337 \begin_inset Quotes eld
10345 \begin_inset Quotes erd
10348 to automatically set up a document to use the
10357 ile\SpecialChar \menuseparator
10366 to open your new document].
10367 The template file also contains some examples of the special paragraph
10368 environments used by this class.
10369 I'll describe those next.
10372 \begin_layout Subsection
10373 Paragraph Environments
10376 \begin_layout Subsubsection
10377 Supported Environments
10380 \begin_layout Standard
10381 The first thing you'll notice when you start up a new
10385 document is the font size and type: it's the equivalent of the size
10386 \begin_inset Quotes eld
10394 \begin_inset Quotes erd
10403 This is also what's used in the output.
10405 \begin_inset Quotes eld
10409 \begin_inset Quotes erd
10412 to remind you that this is a slide.
10413 Your final slides will use a larger font; ergo, you'll have less space.
10414 Of course, the larger default screen font isn't WYSIWYG, only a reminder.
10417 \begin_layout Standard
10418 The next thing that becomes obvious is the changes to the paragraph environment
10419 pull-down box [at the far-left end of the toolbar].
10420 Most of the paragraph environments you're used to seeing are missing.
10421 There are also five new ones.
10426 class itself only supports certain paragraph environments:
10429 \begin_layout Itemize
10435 \begin_layout Itemize
10441 \begin_layout Itemize
10447 \begin_layout Itemize
10453 \begin_layout Itemize
10459 \begin_layout Itemize
10465 \begin_layout Itemize
10471 \begin_layout Itemize
10477 \begin_layout Itemize
10483 \begin_layout Itemize
10489 \begin_layout Itemize
10495 \begin_layout Standard
10496 All of the other standard environments, including the section-heading environmen
10497 ts, aren't used in the
10504 \begin_layout Standard
10505 On the other hand, you'll notice the following new environments:
10508 \begin_layout Itemize
10514 \begin_layout Itemize
10520 \begin_layout Itemize
10526 \begin_layout Itemize
10532 \begin_layout Itemize
10538 \begin_layout Standard
10539 These five are kind of quirky, due to a
10540 \begin_inset Quotes eld
10544 \begin_inset Quotes erd
10548 You see, LyX doesn't permit you to nest any other paragraph environment
10549 into an empty environment.
10550 Now, that's fine and dandy, but it means that you wouldn't be able to start
10551 a slide with anything except plain text.
10552 To deal with this, I've performed a little
10553 \begin_inset Quotes eld
10557 \begin_inset Quotes erd
10563 \begin_layout Subsubsection
10564 Quirks of the New Environments
10565 \begin_inset LatexCommand \label{sec:slideQuirk}
10572 \begin_layout Standard
10573 All five of the new paragraph environments are somewhat quirky due to inherent
10574 limitiations in the current version of LyX.
10575 As I just mentioned, LyX forbids environments that begin with another environme
10577 To get around this, the
10581 environment isn't a paragraph environment as described in the
10589 \begin_layout Standard
10590 You should consider
10603 \begin_inset Quotes eld
10606 pseudo-environments.
10607 \begin_inset Quotes erd
10610 They look like a section heading or a
10611 \begin_inset Quotes eld
10619 \begin_inset Quotes erd
10622 but really begin a [and, if necessary, end the previous] paragraph environment.
10632 \begin_inset Quotes eld
10636 \begin_inset Quotes erd
10639 These two perform some action.
10642 \begin_layout Standard
10643 A common feature of all five environments,
10663 , is a rather long-ish label.
10664 The text following this label --- ordinarily the contents of the paragraph
10665 environment --- is utterly irrelevant for
10686 LyX completely ignores it.
10687 In fact, you can leave these five environments completely empty.
10691 \begin_layout Standard
10696 to put any text after the rather long-ish label, you might want to.
10697 This could be a short description of the contents of the
10702 In that case, enter in your descriptive comment and hit
10706 as you normally would.
10709 \begin_layout Standard
10710 If, on the other hand, you don't want to enter in any descriptive text,
10711 you'll hit another LyX quirk.
10712 LyX, like nature, abhors a vacuum, and will not let you start a new paragraph
10713 environment until you put something in the old one.
10717 \begin_layout Itemize
10718 Start entering the text that will
10746 \begin_layout Itemize
10747 Now move to the beginning of that paragraph.
10751 \begin_layout Itemize
10760 \begin_layout Itemize
10761 Finally, change this new, empty paragraph to a
10785 \begin_layout Standard
10786 Some future version of LyX will, hopefully, resolve this quirkiness\SpecialChar \ldots{}
10790 \begin_layout Subsection
10791 Making a Presentation with
10804 \begin_layout Subsubsection
10812 \begin_layout Standard
10813 If you're expecting this section to teach you how to actually make a presentatio
10814 n, you'll be sorely disappointed.
10815 Naturally, I'll describe all of the ways the
10819 class can assist you in preparing the materials for a presentation.
10820 Filling in the contents, however, is up to you.
10825 the LyX philosophy.]
10828 \begin_layout Standard
10833 environment [in the manner described in section\InsetSpace ~
10835 \begin_inset LatexCommand \ref{sec:slideQuirk}
10839 ] tells LyX to begin a new slide [duh].
10840 The label for this environment/
10841 \begin_inset Quotes erd
10845 \begin_inset Quotes erd
10849 \begin_inset Quotes eld
10853 \begin_inset Quotes erd
10856 in cool blue, followed by the label,
10857 \begin_inset Quotes eld
10861 \begin_inset Quotes erd
10865 Any text or paragraph environments that follow this one go on the new slide.
10869 \begin_layout Standard
10870 Slides are probably the only time you'll need to forcibly end pages in LyX
10871 (this can be specified in the
10876 In fact, you'll want to, once you finish entering the contents of one slide.
10877 If you've entered more text than can physically fit on a slide, the extra
10878 overflows onto a new slide.
10879 I don't recommend doing this, however, since the overflow slide won't have
10880 any page number on it.
10881 Furthermore, it may interfere with any
10885 you've made to accompany the oversized
10892 \begin_layout Standard
10901 environments work the same way as the
10906 They both create an
10907 \begin_inset Quotes eld
10911 \begin_inset Quotes erd
10914 followed by a label [
10915 \begin_inset Quotes eld
10919 \begin_inset Quotes erd
10923 \begin_inset Quotes eld
10927 \begin_inset Quotes erd
10931 The color is a stunning magenta instead of blue, and the
10932 \begin_inset Quotes eld
10936 \begin_inset Quotes erd
10939 will look different, in style and in length.
10940 The label fonts of all three also differ from one another.
10943 \begin_layout Standard
10948 , if the contents of a
10956 exceed the physical size of a slide or sheet of paper, the extra will overflow
10958 Again, you should avoid this.
10959 It defeats the whole purpose of
10970 \begin_layout Subsubsection
10980 \begin_layout Standard
10985 is a slide that sits atop another slide.
10986 Perhaps you wish to discuss a figure on the main
10990 before displaying the text associated with it.
10991 One way to accomplish this is tape a flap of dark paper over the part of
10996 you want to display later.
10997 This method fails, however, if you wish to overlap one graph with another,
10999 You would then have to fumble while speaking to align the two separate,
11004 s to align the two graphs.
11009 environment in both cases makes life much easier.
11012 \begin_layout Standard
11017 receives the page number of its
11018 \begin_inset Quotes eld
11022 \begin_inset Quotes erd
11030 \begin_inset Quotes eld
11038 \begin_inset Quotes erd
11045 \begin_layout Standard
11046 Presumably, mutliple
11051 \begin_inset Quotes eld
11059 \begin_inset Quotes erd
11063 \begin_inset Quotes eld
11071 \begin_inset Quotes erd
11075 \begin_inset Quotes eld
11083 \begin_inset Quotes erd
11086 , etc.\InsetSpace ~
11087 appended to the page number of the parent
11097 Clearly, you want the contents of both the
11105 to each fit on a single physical slide! You should probably consider an
11111 \begin_inset Quotes eld
11115 \begin_inset Quotes erd
11127 class provides a visual cue for this: the label at the start of an
11131 is shorter than that at the start of a
11136 Lastly, when you generate printable output, you'll find alignment markers
11137 in all four corners of both the
11141 page and its parent
11146 These will assist you in lining up the two physical slides.
11149 \begin_layout Standard
11150 The major problem in overlaying two slides is aligning the contents of the
11151 two transparencies.
11152 How much space should you leave for that graph on the second slide? Worse
11153 still, what if you want a graph and a sentence on second slide, but there
11154 is text on the main transparency that goes in between them? You could try
11155 and insert vertical space of the right size.
11156 The better way is to use
11167 \begin_layout Standard
11168 As their names imply,
11176 are two command-like paragraph environments that make all subsequent text
11177 invisible and visible, respectively.
11178 Note from section\InsetSpace ~
11180 \begin_inset LatexCommand \ref{sec:slideQuirk}
11184 that you don't place anything
11188 these two environments, however.
11193 , it inserts a centered, sky-blue label into the page reading
11194 \begin_inset Quotes eld
11197 <Invisible Text Follows>
11198 \begin_inset Quotes erd
11202 For paragraphs following this label, the parts of the
11210 ; it doesn't matter which] where they would be contain instead blank space.
11214 \begin_layout Standard
11219 , the corresponding centered label is
11220 \begin_inset Quotes eld
11223 <Visible Text Follows>
11224 \begin_inset Quotes erd
11228 Paragraphs following this label behave normally.
11229 Note that the beginning of a new
11241 automatically shuts off an
11246 It's therefore not necessary to use
11257 \begin_layout Standard
11258 By now, it should be obvious how to create overlay transparencies using
11259 the proper combination of
11278 \begin_layout Enumerate
11283 , including everything that will appear on it, whether on the main slide
11291 \begin_layout Enumerate
11292 Before each figure or paragraph that will appear only on the
11301 If necessary, insert a
11305 environment after the
11312 \begin_layout Enumerate
11317 immediately following the
11324 \begin_layout Enumerate
11325 Copy the contents of this
11336 \begin_layout Enumerate
11341 , change all of the
11352 \begin_layout Standard
11354 You've just made an
11361 \begin_layout Standard
11362 There's one problem with the way I've designed the LyX
11366 class: you can't make text in the middle of a paragraph invisible, nor
11367 make text in the middle of an invisible paragraph visible again.
11368 To accomplish this feat, you'll need to use some inlined LaTeX codes.
11372 \begin_layout Standard
11373 The commands of interest are:
11376 \begin_layout Itemize
11381 invisible \SpecialChar \ldots{}
11385 \begin_layout Itemize
11390 visible \SpecialChar \ldots{}
11394 \begin_layout Standard
11395 \SpecialChar \ldots{}
11396 and need to be marked as TeX.
11398 \begin_inset Quotes eld
11402 \begin_inset Quotes erd
11405 you wish to change goes in between the brackets [and after the
11418 If you don't know how to mark text as TeX, see the apprpriate section of
11431 \begin_layout Subsubsection
11441 \begin_inset LatexCommand \label{sec:slideNote}
11448 \begin_layout Standard
11457 is associated with a
11458 \begin_inset Quotes eld
11462 \begin_inset Quotes erd
11474 class provides visual cues.
11479 is shorter than that of a
11483 [yet longer than that of an
11487 ] and, like the label of an
11491 is shockingly magenta.
11492 Additionally, the printed
11496 has the page number of its
11497 \begin_inset Quotes eld
11501 \begin_inset Quotes erd
11509 \begin_inset Quotes eld
11517 \begin_inset Quotes erd
11521 \begin_inset Quotes eld
11529 \begin_inset Quotes erd
11533 \begin_inset Quotes eld
11541 \begin_inset Quotes erd
11545 You can have multiple
11549 s associated with a single
11561 , you'll probably want to break up long
11565 s so that they fit on a single sheet of paper.
11568 \begin_layout Standard
11573 is obvious: it contains anything additional you might want to say about
11579 It could also be used as a sheet of reminders for a particular
11584 In the case of the latter, you might want to make use of time markers.
11590 \begin_inset Quotes eld
11594 \begin_inset Quotes erd
11597 support for time markers, a
11602 So, you'll have to resort to using the LaTeX codes.
11605 \begin_layout Standard
11606 To use time markers, you'll need to specify the extra class option
11607 \begin_inset Quotes eld
11615 \begin_inset Quotes erd
11618 [see section\InsetSpace ~
11620 \begin_inset LatexCommand \ref{sec:slidesetup}
11625 This option turns on timing marks, which will appear in the lower-left-hand
11631 To set what appears in the time marker, you use the LaTeX commands
11632 \begin_inset Quotes eld
11642 \begin_inset Quotes erd
11646 \begin_inset Quotes eld
11656 \begin_inset Quotes erd
11660 The arguments of both commands are time measured in seconds.
11662 \begin_inset Quotes eld
11672 \begin_inset Quotes erd
11675 sets the time marker to a given time.
11677 \begin_inset Quotes eld
11687 \begin_inset Quotes erd
11690 increments the time marker by the specified amount.
11691 Using time markers and
11695 s in this fashion, you can remind yourself how much time to spend on a particula
11703 \begin_layout Standard
11704 There's one last feature to describe.
11705 Clearly, you'd like to print out all of your
11713 s on transparencies while printing all of your
11730 with which it is associated.
11731 What's a person to do?
11734 \begin_layout Standard
11735 Luckily, there are two LaTeX commands that allow you to select what to print
11737 Both must be placed into the preamble of your document.
11739 \begin_inset Quotes eld
11751 \begin_inset Quotes erd
11754 will cause the output to contain only the
11763 Correspondingly, the command
11764 \begin_inset Quotes eld
11776 \begin_inset Quotes erd
11779 prevents the output of anything but
11784 I'd advise placing both commands in the preamble and initially comment
11786 You can then preview your entire presentation as you write.
11787 When you're done writing, you can then uncomment one of the two to select
11788 what you want to print.
11789 I like to uncomment
11790 \begin_inset Quotes eld
11802 \begin_inset Quotes erd
11805 , print to a file with
11806 \begin_inset Quotes eld
11814 \begin_inset Quotes erd
11817 in its name, comment it back out, then uncomment
11818 \begin_inset Quotes eld
11830 \begin_inset Quotes erd
11834 \begin_inset Quotes eld
11842 \begin_inset Quotes erd
11846 I can then send either file to a printer, loading transparencies or plain
11847 paper as appropriate.
11850 \begin_layout Standard
11851 You can also provide other arguments to the
11852 \begin_inset Quotes eld
11862 \begin_inset Quotes erd
11866 \begin_inset Quotes eld
11876 \begin_inset Quotes erd
11880 See a good LaTeX book for details.
11883 \begin_layout Subsection
11888 Class Template File
11891 \begin_layout Standard
11892 I have also provided a template file,
11893 \begin_inset Quotes eld
11901 \begin_inset Quotes erd
11909 To use it, begin your new presentation with
11914 ile\SpecialChar \menuseparator
11924 Your new LyX presentation file will contain an example
11945 additionally contain an example of the use of
11954 Lastly, the preamble will contain:
11957 \begin_layout LyX-Code
11958 % Uncomment to print out only slides and overlays
11961 \begin_layout LyX-Code
11965 \begin_layout LyX-Code
11975 \begin_layout LyX-Code
11976 % Uncomment to print out only notes
11979 \begin_layout LyX-Code
11983 \begin_layout LyX-Code
11991 \begin_layout Standard
11992 One final thing: I created this class to support the LaTeX2e
11993 \begin_inset Quotes eld
12001 \begin_inset Quotes erd
12004 class, one of the built-in LaTeX2e classes.
12005 Neither I nor the rest of the LyX Team endorse or oppose the use of this
12006 built-in slide class.
12007 It's here if you want it or need it.
12008 There exist other LaTeX2e classes for creating presentations, such as the
12013 class [see section\InsetSpace ~
12015 \begin_inset LatexCommand \ref{sec:foiltex}
12020 \begin_inset Quotes eld
12028 \begin_inset Quotes erd
12031 package [present on some TeX distributions].
12032 The latter is not yet supported under LyX.
12036 \begin_layout Standard
12037 Perhaps you can take on the task\SpecialChar \ldots{}
12043 I know nothing about these other classes.
12044 Try them out to see what sort of alternative they provide.
12047 \begin_layout Section
12056 \begin_inset LatexCommand \label{sec:foiltex}
12063 \begin_layout Standard
12069 \begin_layout Subsection
12073 \begin_layout Standard
12074 This section describes how to use LyX to make slides for overhead projectors.
12075 There are two document classes that can do this: the default slides class
12081 This section documents the latter.
12084 \begin_layout Standard
12085 I'm going to say this again, nice and clear, so that there's no misunderstanding
12089 \begin_layout Standard
12090 \begin_inset VSpace bigskip
12096 \begin_layout Standard
12100 This section documents the class
12101 \begin_inset Quotes eld
12109 \begin_inset Quotes erd
12117 \begin_layout Standard
12118 \begin_inset VSpace bigskip
12124 \begin_layout Standard
12125 If you're looking for the documentation for
12126 \begin_inset Quotes eld
12134 \begin_inset Quotes erd
12137 , check out section\InsetSpace ~
12139 \begin_inset LatexCommand \ref{sec:slitex}
12144 If your machine doesn't have the
12149 \begin_inset Quotes eld
12157 \begin_inset Quotes erd
12160 ] installed, you'll probably have to use the default
12164 class, which isn't quite as good as
12169 \begin_layout Standard
12174 class is designed for use with version 2.1 of the
12178 LaTeX class file which is now an integral part of LaTeX2e.
12181 \begin_layout Subsection
12185 \begin_layout Standard
12186 Obviously, to use this document class, you need to select
12187 \begin_inset Quotes eld
12195 \begin_inset Quotes erd
12207 Document\InsetSpace ~
12211 There are some settings in the
12213 Document\InsetSpace ~
12216 dialog that you should know about that are specific to this class:
12219 \begin_layout Itemize
12220 Don't change the options
12230 Document\InsetSpace ~
12234 They're ignored by the
12241 \begin_layout Itemize
12242 The default font size is 20pt with the other options being 17pt, 25pt and
12246 \begin_layout Itemize
12247 The default font is
12255 but all math equations are still typeset in the usual roman font.
12258 \begin_layout Itemize
12263 TeX supports A4 and Letter paper sizes as well as a special size for working
12265 It doesn't support A5, B5, legal or executive paper sizes.
12268 \begin_layout Itemize
12269 Don't bother changing the
12273 settings because they are ignored anyway.
12274 All floats appear where they are defined in the text.
12277 \begin_layout Itemize
12285 setting behaves a bit differently for this class.
12290 TeX provides extensive footer and header capabilities including a user-defined
12292 See section\InsetSpace ~
12294 \begin_inset LatexCommand \ref{sec:foilfoot}
12299 The title page is treated differently to all other pages in the document
12308 has the logo centered at the bottom of the page (if one is defined).
12309 The possible page style choices and what they do are as follows:
12314 \labelwidthstring MMMMMMM
12321 The final output contains no page numbers, or other headers or footers
12322 (except footnotes of course).
12327 \labelwidthstring MMMMMMM
12334 The final output contains page numbers centered at the bottom of the page.
12335 No other headings or footers (other than footnotes).
12339 \labelwidthstring MMMMMMM
12344 Page numbers in lower right corner.
12345 Additional headers and footers are also shown.
12346 This is also the default.
12350 \labelwidthstring MMMMMMM
12355 Gives you access to the
12359 package although its use with
12363 TeX is discouraged by the writer of the
12367 TeX package because of some potential page layout clashes.
12371 \begin_layout Subsubsection
12375 \begin_layout Standard
12376 The following options may be used in the extra class options in the
12381 ocument\SpecialChar \menuseparator
12392 \labelwidthstring MMMMMMx
12397 This sets up the page layout for 7.33in by 11in paper, which is about the
12398 same aspect ratio as a 35mm slide, making it a bit easier to work with
12403 \labelwidthstring MMMMMMx
12408 Places a rule across the page below the header on every page except the
12413 \labelwidthstring MMMMMMx
12418 Places a rule across the page above the footer on every page except the
12423 \labelwidthstring MMMMMMx
12428 This is automatically set each time you create a new
12437 TeX to use the dvips driver to rotate those pages that are set as landscape
12442 \labelwidthstring MMMMMMx
12447 Simply changes the page dimensions to those of a landscape page but doesn't
12449 Thus if you use this option you need to use an external program to rotate
12450 each page or feed your paper through your printer as landscape.
12451 Note that this option effectively reverses the roles of the
12459 environments (don't worry these are described in the next section).
12463 \labelwidthstring MMMMMMx
12468 Equation numbers on the left.
12472 \labelwidthstring MMMMMMx
12477 Flush-left equations.
12480 \begin_layout Subsection
12481 Supported Environments
12484 \begin_layout Standard
12485 Most of the environments commonly supported in other classes are also supported
12491 There are several additional environments provided by
12495 TeX as well as a couple added by LyX.
12496 The following environments are shared with other classes:
12499 \begin_layout Standard
12503 \begin_layout Standard
12506 begin{multicols}{2}
12514 \begin_layout Itemize
12520 \begin_layout Itemize
12526 \begin_layout Itemize
12532 \begin_layout Itemize
12538 \begin_layout Itemize
12544 \begin_layout Itemize
12550 \begin_layout Itemize
12556 \begin_layout Itemize
12562 \begin_layout Itemize
12568 \begin_layout Itemize
12574 \begin_layout Itemize
12580 \begin_layout Itemize
12586 \begin_layout Itemize
12592 \begin_layout Itemize
12598 \begin_layout Itemize
12604 \begin_layout Itemize
12610 \begin_layout Itemize
12616 \begin_layout Itemize
12622 \begin_layout Standard
12626 \begin_layout Standard
12637 \begin_layout Standard
12638 That is, all the major environments apart from the sectioning environments.
12639 Since foils are essentially self-contained sections, with a title and body,
12644 TeX provides specific commands for starting new foils and these are:
12647 \begin_layout Itemize
12653 \begin_layout Itemize
12659 \begin_layout Standard
12660 LyX also provides slightly modified versions of these two environments called:
12663 \begin_layout Itemize
12669 \begin_layout Itemize
12672 ShortRotatefoilhead
12675 \begin_layout Standard
12676 and the differences will be explained in the next section.
12679 \begin_layout Standard
12680 Since foils are often used in presenting ideas or new theorems and such
12685 TeX also provides a comprehensive box of goodies for presenting them:
12688 \begin_layout Standard
12692 \begin_layout Standard
12695 begin{multicols}{2}
12703 \begin_layout Itemize
12709 \begin_layout Itemize
12715 \begin_layout Itemize
12721 \begin_layout Itemize
12727 \begin_layout Itemize
12733 \begin_layout Itemize
12739 \begin_layout Itemize
12745 \begin_layout Itemize
12751 \begin_layout Itemize
12757 \begin_layout Itemize
12763 \begin_layout Itemize
12769 \begin_layout Standard
12773 \begin_layout Standard
12784 \begin_layout Standard
12785 The starred versions are unnumbered while the unstarred versions are numbered.
12786 There are also two list environments added by LyX and these are:
12789 \begin_layout Itemize
12795 \begin_layout Itemize
12801 \begin_layout Standard
12806 TeX provides some powerful header and footer capabilities that are best
12807 set in the preamble although they may be set at any point in a document.
12808 If you want to change these settings in your document the best place to
12809 do so is at the very top of a foil,
12814 straight after the foilhead.
12817 \begin_layout Standard
12818 For this purpose, the following command styles are provided [
12825 \begin_layout Standard
12829 \begin_layout Standard
12832 begin{multicols}{2}
12840 \begin_layout Itemize
12847 \begin_layout Itemize
12853 \begin_layout Itemize
12860 \begin_layout Itemize
12867 \begin_layout Itemize
12875 \begin_layout Standard
12881 \begin_layout Standard
12885 \begin_layout Standard
12896 \begin_layout Standard
12897 There are also a few commands provided by
12901 TeX that aren't directly supported by LyX but I'll tell you what they do
12902 and how to use them in section\InsetSpace ~
12904 \begin_inset LatexCommand \ref{sec:unsuppfoils}
12911 \begin_layout Subsection
12912 Building a Set of Foils
12915 \begin_layout Standard
12916 This section will give a simple introduction to using the different environments
12917 to build a set of foils.
12918 If you want to see an example set of foils take a look at the
12922 file accessible from the
12927 ile\SpecialChar \menuseparator
12932 pen\SpecialChar \ldots{}
12943 \begin_layout Subsubsection
12944 Give It a Title Page
12947 \begin_layout Standard
12948 Unlike other classes that provide
12968 creates the title on a page of its own.
12969 If you leave out the
12973 environment LaTeX will substitute the current date (every time you regenerate
12977 \begin_layout Subsubsection
12981 \begin_layout Standard
12982 As I mentioned earlier, there are four ways of starting a new foil.
12983 For portrait foils you should use
12992 The difference between these two environments is the amount of space between
12993 the title of the foil (the foilhead) and the body of the foil.
12996 \begin_layout Standard
12997 Landscape foils are generated using the
13003 ShortRotatefoilhead
13006 Again the only difference is the spacing between foilhead and body.
13007 Both of the short versions have 0.5 inches less separation between the foilhead
13012 \begin_layout Standard
13013 One problem with the support for landscape foils is the requirement that
13014 you have to use the
13018 driver to generate the PostScript® output otherwise the foils won't be
13020 It is possible to get landscape foils even if you haven't got the
13024 driver provided you can feed your foils sideways through your printer ;-)
13027 \begin_layout Subsubsection
13028 Theorems, Lemmas, Proofs and more
13031 \begin_layout Standard
13032 Due to a small bug in LyX you can't have two of the same type of these environme
13033 nts directly following each other.
13034 They must be separated by something.
13035 If you try, you will just be extending the previous environment as if you
13036 had merged the two environments together.
13037 So, how do you get around this problem? The simplest option is to insert
13038 some text between the two environments or add a
13042 environment between the two with just a
13043 \begin_inset Quotes eld
13051 \begin_inset Quotes erd
13055 This will force LyX to produce two separate environments and hence the
13056 correct LaTeX output.
13057 An example is provided in the example file included with the LyX distribution.
13058 Remember, this problem only occurs if you are trying to place two of the
13059 same type of theorem-like environments one directly after the other.
13062 \begin_layout Subsubsection
13066 \begin_layout Standard
13067 You get all the commonly supported list styles found in other classes as
13068 well as two new ones.
13069 I'll only describe the new ones here.
13070 If you want to find out more about the other list environments check out
13076 If you intend to use itemized lists you might also want to read about the
13079 Itemize\InsetSpace ~
13080 Bullet\InsetSpace ~
13083 dialog described above in section\InsetSpace ~
13085 \begin_inset LatexCommand \ref{sec:bullet}
13092 \begin_layout Standard
13093 The two new list styles,
13101 , are designed to make it easier for you to create lists of do's and don'ts
13102 or right and wrong by providing dedicated environments that use a tick
13103 or a cross as the label of the list.
13104 These lists are in fact dedicated variants of the
13109 They do however require that you have the
13113 packages installed.
13116 \begin_layout Subsubsection
13120 \begin_layout Standard
13125 TeX redefines the floating tables and figures so that they appear exactly
13126 where they are in the text rather than pushing them to the top of the page
13127 or to some user specified location.
13128 In fact if you change the float placement settings they are simply ignored.
13131 \begin_layout Subsubsection
13132 Page Headers and Footers
13133 \begin_inset LatexCommand \label{sec:foilfoot}
13140 \begin_layout Standard
13150 are two commands used to control the left-footer text string.
13151 The first is meant to allow you to include a graphic logo on your foils
13153 \begin_inset Quotes eld
13161 \begin_inset Quotes erd
13165 While the second is meant to provide a classification for the audience,
13172 It is empty by default.
13175 \begin_layout Standard
13176 The remaining page corners can be filled by
13181 (which defaults to page numbers),
13194 \begin_layout Subsection
13200 \begin_inset LatexCommand \label{sec:unsuppfoils}
13207 \begin_layout Standard
13208 All the commands mentioned below need to be set in a
13216 within another environment.
13219 \begin_layout Subsubsection
13223 \begin_layout Standard
13224 All lengths are adjusted using the
13247 should be replaced by the name given to the length you want to change and
13252 is the length value.
13253 All lengths should be specified in units of length such as inches (
13265 ) or relative to some document or font-based length such as
13275 \begin_layout Standard
13276 It's possible to change the spacing between a foilhead and the body of the
13277 foil by adjusting the length specified by
13284 For example, to make
13288 foilheads 0.5 inches closer to their bodies put the following in the preamble:
13295 foilheadskip}{-0.5in}
13298 \begin_layout Standard
13299 The spacings around floats can be adjusted by setting these lengths:
13303 \labelwidthstring MMMMMMMMMMM
13310 Separation between the text and the top of the float
13314 \labelwidthstring MMMMMMMMMMM
13321 Separation between the float and the caption
13325 \labelwidthstring MMMMMMMMMMM
13332 Separation between the caption and the following text
13336 \labelwidthstring MMMMMMMMMMM
13343 You can make the captions narrower than the surrounding text by adjusting
13345 Best done relative to
13354 \begin_layout Standard
13355 There are also several title page related lengths that you may find useful
13356 if you have a long title or several authors:
13360 \labelwidthstring MMMMMMMMMMM
13367 Separation from headers to
13373 \labelwidthstring MMMMMMMMMMM
13392 \labelwidthstring MMMMMMMMMMM
13407 \labelwidthstring MMMMMMMMMMM
13424 \labelwidthstring MMMMMMMMMMM
13440 \begin_layout Standard
13441 The last length related command affects all the list environments.
13452 a list environment then all the vertical spacing between the list items
13454 Note that this is a command not a length so it doesn't require
13460 like the stuff mentioned above.
13463 \begin_layout Subsubsection
13464 Headers and Footers
13467 \begin_layout Standard
13480 commands control whether the logo in the
13484 definition appear on a given page.
13491 in the preamble then none of the foils will have the logo on them.
13492 If you don't want the logo on a particular page place the
13498 directly after the foilhead of that page and the
13504 directly after the next foilhead.
13507 \begin_layout Standard
13508 If you decide to use the
13512 page style setting in the
13514 Document\InsetSpace ~
13517 dialog you should probably add
13527 to your preamble so headers and footers on landscape pages are correctly
13528 placed when rotated.
13529 This is due to some clashes between the page layouts provided by the
13540 \begin_layout Section
13541 Latex8 (IEEE Conference Papers)
13544 \begin_layout Standard
13550 \begin_layout Subsection
13554 \begin_layout Standard
13555 Since this class is specifically for writing submissions to IEEE sponsored
13556 conferences I strongly recommend that you get a copy of their Authors Kit.
13561 package and associated bibliography style file is included in the kit.
13562 The Authors Kit is usually sent out by email once your initial submission
13564 There is a lot of useful information in the Authors Kit explaining formatting
13565 restrictions and so on and I will assume you have read this since that
13566 means I don't have to repeat it all here.
13569 \begin_layout Subsection
13573 \begin_layout Standard
13574 [AR\SpecialChar \@.
13578 \begin_layout Subsection
13579 Supported Environments
13582 \begin_layout Itemize
13588 \begin_layout Itemize
13594 \begin_layout Itemize
13600 \begin_layout Itemize
13606 \begin_layout Itemize
13612 \begin_layout Itemize
13618 \begin_layout Itemize
13624 \begin_layout Itemize
13630 \begin_layout Itemize
13636 \begin_layout Subsection
13637 Differences Between Screen and Paper
13640 \begin_layout Standard
13641 There are slight differences in appearance mainly with the presentation
13642 of section counters.
13643 On screen the trailing period of the section counter is missing but it
13644 will appear in the output so don't let this worry you.
13647 \begin_layout Section
13648 Hollywood (Hollywood spec scripts)
13651 \begin_layout Standard
13657 \begin_layout Subsection
13661 \begin_layout Standard
13662 Getting the format of a Hollywood script right is a
13663 \begin_inset Quotes eld
13667 \begin_inset Quotes erd
13670 It is designed to make the readers focus on content and to be easy and
13671 familiar for the actors to read.
13672 Each page of a script should be one minute of film.
13673 Nothing goes in a script that you cannot see or hear on screen.
13674 The courier 12 pt font should be used throughout.
13678 \begin_layout Subsection
13682 \begin_layout Standard
13683 Speakers' lines should NEVER break in mid-sentence.
13684 If a speaker's lines continue over a page break, repeat the
13688 title followed by (Cont'd).
13691 \begin_layout Subsection
13695 \begin_layout Standard
13700 names as labels then cross-reference the label to insert the name.
13701 The cross-reference dialog will show the current cast of characters.
13702 You can use this to insert the speaker name in narratives also.
13705 \begin_layout Subsection
13706 Paper size and Margins
13709 \begin_layout Standard
13710 USLetter, left 1.6in, right 0.75in, top 0.5in, bottom 0.75in
13713 \begin_layout Subsection
13717 \begin_layout Standard
13718 The following environments are available.
13719 You can use hollywood.bind to get the bind keys shown at the right.
13722 \begin_layout Itemize
13729 Used where nothing else works.
13733 \begin_layout Itemize
13746 Usually followed by something like
13747 \begin_inset Quotes eld
13750 on Sally waking up.
13751 \begin_inset Quotes erd
13757 \begin_layout Itemize
13766 Introduces a new INTERIOR camera set-up.
13767 Always followed by DAY or NIGHT, or something similar to define the lighting
13769 Everthing on this line in CAPS.
13772 \begin_layout Itemize
13781 Introduces a new EXTERIOR camera set-up.
13782 Everthing on this line in CAPS.
13785 \begin_layout Itemize
13794 The character speaking.
13797 \begin_layout Itemize
13806 Instructions to the speaker.
13807 The () are automatically inserted, but only the ( will show in LyX.
13808 Both will be printed.
13811 \begin_layout Itemize
13827 \begin_layout Itemize
13836 Camera movement instruction.
13841 \begin_layout Itemize
13849 \begin_layout Itemize
13857 \begin_layout Itemize
13865 \begin_layout Itemize
13873 \begin_layout Subsection
13877 \begin_layout Itemize
13878 (O.S) --- off screen
13881 \begin_layout Itemize
13882 (V.0) --- voice over
13885 \begin_layout Itemize
13890 \begin_layout Itemize
13895 \begin_layout Itemize
13896 PAN --- camera movement
13899 \begin_layout Itemize
13900 INSERT --- cut to close-up of
13903 \begin_layout Section
13907 \begin_layout Standard
13913 \begin_layout Subsection
13917 \begin_layout Standard
13918 Broadway is for writing plays.
13919 The format is more decorative than Hollywood, and much less standardized.
13920 This format should be suitable for workshops.
13923 \begin_layout Subsection
13927 \begin_layout Standard
13928 The same as in Hollywood.
13931 \begin_layout Subsection
13935 \begin_layout Standard
13940 names as labels then cross-reference the label to insert the name.
13941 The cross-reference dialog will show the current cast of characters.
13944 \begin_layout Subsection
13945 Paper size and Margins
13948 \begin_layout Standard
13949 USLetter, left 1.6in, right 0.75in, top 0.5in, bottom 0.75in
13952 \begin_layout Subsection
13956 \begin_layout Standard
13957 The following environments are available.
13958 You can use broadway.bind to get the bind keys shown at the right.
13961 \begin_layout Itemize
13968 You should not have to use this, but it is here for anything that does not
13972 \begin_layout Itemize
13981 Used to describe stage setting and the action.
13982 First use of speaker names in all CAPs.
13985 \begin_layout Itemize
13994 Automatically numbered.
13995 On screen it will be arabic, but will print as Roman.
13998 \begin_layout Itemize
14012 It is just centered text.
14015 \begin_layout Itemize
14024 Not automatically numbered.
14025 You supply the number.
14026 This is because I couldn't figure out how.
14029 \begin_layout Itemize
14038 A special case of Narrative to describe the setting and action as the curtain
14042 \begin_layout Itemize
14051 The speaker's (actor's) title, centered in all CAPS.
14054 \begin_layout Itemize
14063 Instructions to the speaker.
14064 The parentheses are automatically inserted.
14065 The ( will appear on screen, but both will be in the printed play.
14066 This environment is only used within
14073 \begin_layout Itemize
14082 What the Speaker says.
14085 \begin_layout Itemize
14094 The curtain comes down.
14097 \begin_layout Itemize
14105 \begin_layout Itemize
14113 \begin_layout Itemize
14121 \begin_layout Standard
14125 \begin_layout Section
14129 \begin_layout Standard
14135 \begin_layout Standard
14136 \begin_inset VSpace bigskip
14142 \begin_layout Standard
14146 Revtex\InsetSpace ~
14149 textclass works with the American Physical Sociey's RevTeX 4.0 (the
14150 \begin_inset Formula $\beta$
14153 release of May, 1999) class.
14156 \begin_layout Standard
14161 textclass, which works with RevTeX 3.1.
14162 However, v3.1 is basically obsolete, as it works with LaTeX 2.09.
14163 That means that it doesn't interact very well with LyX, which requires
14164 LaTeX2e, although it has been kludged to work.
14165 Since RevTeX 4.0 has been designed to work much more cleanly with LaTeX2e,
14168 RevTeX\InsetSpace ~
14171 textclass should also be pretty easy to use.
14174 \begin_layout Standard
14175 These documents are supposed to be used in
14179 to the RevTeX 4.0 documents, so we don't describe any of the special RevTeX
14180 macros, and assume you'll know what to put in the preamble if necessary.
14183 \begin_layout Subsection
14187 \begin_layout Standard
14188 All you need to do is install RevTeX 4, as described in the package's README
14190 the package can be found at
14191 \begin_inset LatexCommand \url[The RevTeX 4 Web Site]{http://publish.aps.org/revtex4/}
14196 Install it somewhere that LaTeX can see it.
14197 Test it by trying to LaTeX a short RevTeX 4 document in some random directory
14198 (i.e., not the directory where you installed the class file.) Then, if you
14199 reconfigure LyX, it will find the class file and let you use the RevTeX4
14203 \begin_layout Standard
14204 Probably the easiest way to get started is either to import a RevTeX 4 document
14211 Revtex\InsetSpace ~
14214 template, found in the templates directory.
14217 \begin_layout Subsection
14221 \begin_layout Standard
14222 Optional arguments to
14229 \begin_inset Quotes eld
14233 \begin_inset Quotes erd
14237 \begin_inset Quotes eld
14241 \begin_inset Quotes erd
14255 Document\InsetSpace ~
14259 Remember that in RevTeX, at least one optional argument is required!
14262 \begin_layout Standard
14263 Other preamble matter, like
14275 dialog, also as usual.
14278 \begin_layout Subsection
14282 \begin_layout Standard
14283 The layouts basically correspond to the commands in RevTeX4.0.
14284 For example, the Email layout corresponds to
14291 Note that (at least as of RevTeX 4.0 Beta), the
14299 layouts are exactly equivalent, so you shouldn't need to use both.
14303 \begin_layout Standard
14304 In case you're curious, both were included so that
14308 would be able to translate both
14328 \begin_layout Subsection
14332 \begin_layout Standard
14333 There are a couple of important unique aspects of RevTeX 4 which might cause
14334 bugs that will be even more confusing in LyX.
14337 \begin_layout Standard
14355 The LyX equivalent is that there is a separate Thanks layout.
14360 write footnotes in the
14364 layout, or weird things may happen.
14365 See the RevTeX 4 documentation for more details.
14368 \begin_layout Standard
14371 Author\InsetSpace ~
14376 Author\InsetSpace ~
14383 layouts must be placed
14391 layout and the corresponding
14408 , the LaTeX won't compile.
14411 \begin_layout Subsection
14415 \begin_layout Standard
14416 The main problem with this layout is that you can't use the optional arguments
14417 to layouts like Email and Title.
14418 (The problem is not unique to this layout; you can't use optional arguments
14419 to the Section layouts either.) This means that after you export that file
14420 to LaTeX (which you'll need to do eventually to send it in to APS), you'll
14421 need to edit the LaTeX file with a text editor to add the optional arguments
14422 to set, e.g., the running title for the page headers.
14423 Lacking these layouts makes the
14429 (and the equivalent
14435 ) useless, so the corresponding layouts don't exist, and will have to be
14440 \begin_layout Standard
14445 actually, LyX 1.3.0 supports some forms of optional arguments, but this layout
14446 has not been updated yet to take advantage of it.
14454 \begin_layout Section
14455 Article (mwart), book (mwbk) and report (mwrep)
14456 \begin_inset OptArg
14459 \begin_layout Standard
14472 \begin_layout Standard
14478 \begin_layout Standard
14479 The LyX document classes
14495 correspond to the LaTeX document classes
14508 They are replacements for the standard document classes
14520 , resp., and fit better to Polish typography conventions in a number of points.
14524 \begin_layout Standard
14528 \begin_layout Itemize
14529 Unnumbered titles (with star, eg.
14534 ) are added into table of contents,
14537 \begin_layout Itemize
14538 Additional page styles:
14542 \begin_layout Description
14543 uheadings header with separated lines,
14546 \begin_layout Description
14547 myheadings custom header, contents headers via commands:
14562 \begin_layout Description
14563 myuheadings custom header with separated lines,
14566 \begin_layout Description
14567 outer page number is placed on outer side of page
14571 \begin_layout Itemize
14576 \begin_layout Description
14577 rmheadings serif titles --- default,
14580 \begin_layout Description
14581 sfheadings sansserif titles,
14584 \begin_layout Description
14585 authortitle on title page first placed is author next title --- default,
14588 \begin_layout Description
14589 titleauthor on title page first placed is title next author,
14592 \begin_layout Description
14593 withmarginpar reserve place on page for margins.
14597 \begin_layout Section
14601 \begin_layout Standard
14607 \begin_layout Standard
14608 Elsevier Science Publishers B.V.
14609 provides a standard LaTeX document class (
14613 ) for submitting articles to their various journals.
14614 The style file can be downloaded directly from their web site:
14615 \begin_inset LatexCommand \url{http://authors.elsevier.com/}
14620 Instructions are supplied along with the class file, which details the
14621 requirements of the publishers.
14622 LyX includes package that allows for the use of this class, by a layout
14623 and a template file.
14624 Installation of the class file is the same as for any other LaTeX package;
14625 instructions are provided in the Elsevier documentation.
14628 \begin_layout Standard
14638 As the Elsevier class file is based mainly on the standard article class,
14639 most of the normal functionality is provided.
14640 The Elsevier class defines a number of mathematical environments, which
14641 are similar to the AMS environments.
14642 These commands are all described in the Elsevier documentation, and are
14646 \begin_layout Standard
14647 The easiest way to use the Elsevier style is to base documents on the included
14649 It is best not to use options such as fancy headings or the geometry package,
14650 as elements such as these are defined by Elsevier in their style file.
14651 Ideally, no extra packages except those mentioned in the Elsevier documentation
14653 Essentially, Elsevier require as
14654 \begin_inset Quotes eld
14658 \begin_inset Quotes erd
14665 \begin_layout Standard
14673 file as possible, as their intention is to take the supplied file and replace
14674 the class file with one for the particular journal to which the paper has
14676 This also means that not too much time should be spent on the formating
14678 When it comes to be published, this will change anyway.
14679 The rest of the usage for this layout is substantially the same as for
14680 the normal article class.
14681 For details of what Elsevier do and don't allow, refer to their documentation.
14684 \begin_layout Section
14688 \begin_layout Standard
14691 Jürgen Spitzmüller
14694 \begin_layout Subsection
14698 \begin_layout Standard
14699 Memoir is a very powerful and constantly evolving class.
14700 It has been designed with regard to fictional and non-fictional literature.
14701 Its aim is to let the user have maximum control over the typesetting of
14703 Memoir is based on the standard book class, but it can also emulate the
14704 article class (see below).
14707 \begin_layout Standard
14708 Peter Wilson, the developer of Memoir, is known as the author of lots of
14709 useful packages in the LaTeX world.
14710 Most of them have been merged with Memoir.
14711 Therefore, it is much easier to layout the table of contents, appendices,
14712 chapter designs and such.
14713 LyX, though, does not support all of these goodies natively.
14714 Some of them might be added to forthcoming releases
14718 \begin_layout Standard
14719 You are invited to send suggestions to
14720 \begin_inset LatexCommand \url{lyx-devel@lists.lyx.org}
14729 , lots will probably never, due to the limitations of LyX's framework.
14730 Of course you can still use all features with the help of some native LaTeX
14735 \begin_layout Standard
14740 \begin_layout Standard
14748 section\InsetSpace ~
14750 \begin_inset LatexCommand \ref{sec:Inserting-LaTeX-Code}
14760 In this section, we can only list those features which are natively supported
14762 For detailed descriptions (and for the rest of features) we are recommending
14763 to have a look at the detailed manual of the Memoir class
14767 \begin_layout Standard
14772 \begin_layout Standard
14781 \begin_inset LatexCommand \url{CTAN:/macros/latex/memoir/memman.pdf}
14790 , which is not only a user guide for the class, but also both a comprehensive
14791 description on good typesetting and a superb example for good typesetting
14795 \begin_layout Subsection
14796 Basic features and restrictions
14799 \begin_layout Standard
14800 Memoir supports basically all features of the standard book classes.
14801 There are, however, some differences, as follows:
14804 \begin_layout Description
14806 sizes: Memoir has a broader range of font sizes: 9, 10, 11, 12, 14,
14810 \begin_layout Description
14812 style: The fancy page style is not supported, due to a command clash
14813 between Memoir and the fancyhdr package (they are both defining a command
14814 with the same name, which confuses LaTeX).
14815 Instead, Memoir comes with a bunch of own page styles (see
14817 Layout\SpecialChar \menuseparator
14818 Document\SpecialChar \menuseparator
14823 If you want to use these for the chapter pages, you have to use the command
14830 in the main text or in preamble (e.
14834 \begin_layout Standard
14846 \begin_layout Standard
14858 chapterstyle{companion}
14863 \begin_layout Description
14864 Sectioning: Sectionings (chapter, section, subsection etc.) are coming with
14865 an optional argument in the standard classes.
14866 With this, you can specify an alternative version of the title for the
14867 table of contents and the headers (for instance, if the title is too long).
14868 In LyX, you can do this via
14870 Insert\SpecialChar \menuseparator
14874 at the beginning of a chapter/section.
14875 Memoir features a second optional argument and thus separates the table
14876 of contents from the header.
14877 You can define three variants of a title with this: one for the main text,
14878 one for the table of contents, and one for the headers.
14879 Simply insert two optional arguments if you need this feature, the first
14880 one containing the short title for the Table of Contents, the second one
14881 containing an alternative short title for the headers.
14884 \begin_layout Description
14885 TOC/LOT/LOF: In the standard classes (and in many other classes), the table
14886 of contents, the list of figures and the list of table start a new page
14888 Memoir does not follow this route.
14889 You have to insert a page break yourself, if you want to have one.
14892 \begin_layout Description
14893 Titlepage: For some unknown reason, Memoir uses pagination on the title
14894 page (in the standard classes, title pages are
14895 \begin_inset Quotes eld
14899 \begin_inset Quotes erd
14906 \begin_layout Standard
14918 \begin_layout Standard
14927 If you want an empty title page, type
14931 aliaspagestyle{title}{empty}
14936 \begin_layout Description
14937 Article: With the class option
14943 Layout\SpecialChar \menuseparator
14944 Document\SpecialChar \menuseparator
14948 ), you can emulate article style.
14949 That is, counters (footnotes, figures, tables etc.) will not be reset on
14950 new chapters, chapters don't start a new page (but are---in contrary to
14952 \begin_inset Quotes eld
14956 \begin_inset Quotes erd
14959 article classes---still allowed), parts, though, use their own page, as
14963 \begin_layout Description
14964 Oldfontcommands: By default, Memoir does not allow the use of the deprecated
14965 font commands, which have been used in the old LaTeX version 2.09 (e.
14969 \begin_layout Standard
14981 \begin_layout Standard
15002 It produces an error and stops LaTeX whenever such a command appears.
15007 reallows the commands and spits out warnings instead (which does at least
15009 Since a lot of packages and particularly BibTeX style files are still using
15010 those commands, we have decided to use this option by default.
15013 \begin_layout Subsection
15017 \begin_layout Standard
15018 We will only describe the features supported by LyX (which is not much currently
15020 Please consult the Memoir manual
15024 \begin_layout Standard
15029 \begin_layout Standard
15038 \begin_inset LatexCommand \url{CTAN:/macros/latex/memoir/memman.pdf}
15050 \begin_layout Description
15051 Abstract: You may wonder why an abstract is an extra feature.
15052 Well, it is in book class.
15053 Usually books don't have abstracts.
15054 Memoir, however, has.
15055 You can use it whereever and how often you like.
15058 \begin_layout Description
15059 Chapterprecis: You may know this from belletristic: The contents of a chapter
15060 is shortly described below the title and also in the table of contents
15065 \begin_layout Standard
15077 \begin_layout Standard
15087 Our hero arrives in Troia; he loses some friends; he finds others
15090 Chapterprecis does exactly this.
15091 It is therefore only sensible below a chapter.
15094 \begin_layout Description
15095 Epigraph: An epigraph is a smart slogan or motto at the beginning of a chapter.
15096 The epigraph environment provides an elegant way of typesetting such a
15098 The motto itself (text) and its author (source) are divided by a short
15100 Unfortunately, we have to fool LyX a bit here again, since the environment
15101 needs two arguments (text and source).
15102 In this case, we have to use curly brackets (in TeX mode) between the two
15113 <author of the slogan>.
15116 \begin_layout Description
15117 Poemtitle: Memoir has lots of possibilities to typeset poetry (up to very
15118 complex figurative poems).
15119 Lyx can only support a few of them.
15120 One is poemtitle, which is a centered title for poems, which will also
15121 be added to the table of contents (verse is the standard environment for
15123 Memoir has some enhanced versions of verse, but you need to use ERT, because
15124 they have to be nested inside regular verse environments, which is not
15125 possible with LyX).
15128 \begin_layout Description
15129 Poemtitle*: Same as poemtitle, but it adds no entry to the table of contents.
15132 \begin_layout Chapter
15133 Importing and Exporting Alternate File Formats
15134 \begin_inset OptArg
15137 \begin_layout Standard
15138 Importing and Exporting
15146 \begin_layout Section
15150 \begin_layout Standard
15151 Importing and exporting LyX documents from/to other formats has been touched
15157 Here we describe more of the gory details needed to understand just what
15158 is going on when you click on the
15163 ile\SpecialChar \menuseparator
15175 ile\SpecialChar \menuseparator
15186 \begin_layout Section
15187 Importing Other Formats
15190 \begin_layout Subsection
15194 \begin_layout Standard
15195 Translating from LaTeX into LyX is performed by a Perl script called reLyX.
15196 Although it is a standalone program which can be called from the command
15197 line, LyX will call it automatically when a LaTeX document is imported.
15198 See section\InsetSpace ~
15200 \begin_inset LatexCommand \ref{sec:reLyX}
15204 for a complete description.
15205 There are no user tunable parameters for reLyX within LyX.
15208 \begin_layout Subsection
15212 \begin_layout Standard
15213 When importing plain ASCII text, there are two methods of reading the file.
15215 \begin_inset Quotes eld
15219 \begin_inset Quotes erd
15222 preserves all the linebreaks in the ASCII; to LyX, then, each line looks
15225 \begin_inset Quotes eld
15229 \begin_inset Quotes erd
15232 assumes that consecutive lines separated by only a single linebreak form
15233 a single paragraph.
15234 Successive linebreaks with no intervening text are thus assumed to be paragraph
15238 \begin_layout Subsection
15242 \begin_layout Standard
15245 [Editor's note: Needs to be written, obviously - any volunteers? --- mer]
15248 \begin_layout Section
15249 Exporting Other Formats
15252 \begin_layout Subsection
15256 \begin_layout Standard
15257 LyX generates two types of LaTeX files: stripped down versions for the normal
15262 , etc.) which one normally never sees
15266 \begin_layout Standard
15267 The resulting file is a perfectly valid LaTeX file, though the preamble
15268 might look a bit strange since it includes some definitions used by LyX
15269 which wouldn't show up in most human-written files.
15274 , and human readable forms which are suitable for exchanging with your colleague
15276 The only settable option for the translation is the line length of the
15278 The default is 65 characters, but it can be set in
15285 \SpecialChar \menuseparator
15306 \begin_layout Subsection
15307 Device Independent Files
15310 \begin_layout Standard
15311 Device Independent files (DVI files) are produced by running LaTeX on your
15313 There are no user settable options.
15316 \begin_layout Subsection
15320 \begin_layout Standard
15321 The next step in the conversion chain is converting a DVI file into Postscript®.
15329 \SpecialChar \menuseparator
15337 \SpecialChar \menuseparator
15346 or, if you need more control on the result,
15353 \SpecialChar \menuseparator
15362 If you use the later, note that it is possible to configure, in
15369 \SpecialChar \menuseparator
15377 , the options passed to the dvips program to achieve different effects.
15380 \begin_layout Subsection
15384 \begin_layout Standard
15385 Exporting as ASCII attempts to preserve the
15386 \begin_inset Quotes eld
15390 \begin_inset Quotes erd
15393 of the document as well as possible, but things like centering and indentation
15394 are thrown out; paragraphs are separated by blank lines.
15395 Section numbering and cross-references are done correctly, so the resulting
15396 text files is remarkably readable.
15397 The only changeable option is the length of lines, as for LaTeX output.
15400 \begin_layout Subsection
15404 \begin_layout Standard
15405 LyX documents can be converted to hypertext markup, usually by converting
15406 to LaTeX first, then converting that to HTML\SpecialChar \@.
15408 \begin_inset Formula $\rightarrow$
15411 HTML converters are currently known to LyX:
15424 Though they are autodetected, you can overide the selection in preferences.
15425 You can also include further command line options in this dialog.
15429 \begin_layout Subsection
15433 \begin_layout Standard
15441 \begin_layout Standard
15442 \begin_inset VSpace bigskip
15448 \begin_layout Standard
15449 The fastest way to generate a basic PDF file (no tags, links, etc.) with
15450 any version of LyX is to save the document as a Postscript® file, then
15456 Starting with version 1.1.6, the menu item
15460 will do all this for you.
15461 There are some issues with fonts that you need to pay attention to: see
15462 Section\InsetSpace ~
15464 \begin_inset LatexCommand \ref{sec:badfonts}
15469 Also, as of version 1.1.6, there is a better method that will generate much
15470 more sophisticated files.
15473 \begin_layout Subsubsection
15477 \begin_layout Standard
15478 With pdfLaTeX you need to convert your eps figures to PDF (see Section\InsetSpace ~
15480 \begin_inset LatexCommand \ref{sec:pdfeps}
15484 ), and you cannot use pstricks.
15485 On the other hand, with pdfLaTeX it is possible to insert directly images
15486 in JPEG or PNG format, use TrueType fonts, and more.
15489 \begin_layout Subsubsection
15490 Why does the text look so bad when viewed with Acrobat Reader?
15491 \begin_inset LatexCommand \label{sec:badfonts}
15496 \begin_inset OptArg
15499 \begin_layout Standard
15500 Bad Fonts in Acrobat Reader
15508 \begin_layout Standard
15509 The problem is that bitmap fonts are displayed poorly by Acrobat Reader.
15510 When creating a PDF from the LyX file, you need to use outline font instead
15511 of the default bitmap fonts (in fact, you should also use outline fonts
15512 for Postscript files).
15513 Recent LaTeX distributions come with Postscript® Type 1 version of the
15514 standard (Computer Modern) fonts.
15515 pdfLaTeX uses these font by default.
15516 Dvips doesn't use these fonts by default, so to make it use them, add the
15517 following to lines to your
15524 \begin_layout LyX-Code
15528 \begin_layout LyX-Code
15532 \begin_layout Standard
15533 If the default LaTeX font encoding (OT1) is used, nothing else need to be
15535 However, if the T1 font encoding is used, then LaTeX uses the newer EC
15536 fonts, for which there are no Type1 version.
15537 The solution is to use the ae package which emulates T1 coded fonts using
15538 the standard CM fonts.
15539 This is done by adding
15543 usepackage{ae,aecompl}
15545 to the preamble of the LyX file.
15546 However, some glyphs are missing from the CM fonts (e.g.
15547 eth, thorn), and they are taken from the EC fonts.
15548 Therefore you get these glyphs as bitmaps.
15551 \begin_layout Standard
15552 Note: LyX uses by default the T1 font encoding.
15553 If you wish to use the default font encoding (this is not recommended,
15554 unless you only write English documents), clear the field
15562 in preferences (tabs
15574 \begin_layout Standard
15575 An alternate option is to use the standard Postscript® fonts instead of
15576 the Computer Modern fonts.
15577 To do that, you need to select
15581 as the global font in the document layout dialog.
15582 When using the Postscript® fonts, the result PDF file is smaller as the
15583 fonts are not saved into the file.
15584 Furthermore, the Postscript® fonts include all T1 glyphs.
15585 On the other hand, the Postscript® fonts have no bold symbol font, so poor
15586 man's bold must be used (see Section\InsetSpace ~
15588 \begin_inset LatexCommand \ref{sec:pdfbold}
15593 The Postscript® fonts also look different from the Computer Modern fonts.
15596 \begin_layout Standard
15597 To sum up, both the Computer Modern and the Postscript® fonts gives good
15598 results (with few exceptions).
15599 The decision of which one to use is a matter of taste.
15602 \begin_layout Subsubsection
15605 boldsymbol{} command work when I use pslatex?
15606 \begin_inset LatexCommand \label{sec:pdfbold}
15611 \begin_inset OptArg
15614 \begin_layout Standard
15631 \begin_layout Standard
15632 The Postscript® fonts do not have a bold symbol font.
15633 The solution is to use the
15639 (poor man's bold) command.
15642 \begin_layout Standard
15643 It is possible to redefine the
15658 \begin_layout LyX-Code
15668 \begin_layout Standard
15672 \begin_layout Subsubsection
15673 Is it possible to do write latex code which is processed only when running
15675 \begin_inset OptArg
15678 \begin_layout Standard
15679 Conditionals with pdfLaTeX
15687 \begin_layout Standard
15689 Here is an example:
15692 \begin_layout LyX-Code
15700 \begin_layout LyX-Code
15710 \begin_layout LyX-Code
15716 \begin_layout LyX-Code
15722 \begin_layout LyX-Code
15728 \begin_layout LyX-Code
15734 \begin_layout LyX-Code
15738 \begin_layout LyX-Code
15744 \begin_layout LyX-Code
15747 pdfinfo { /Author (your name and e-mail address)
15750 \begin_layout LyX-Code
15751 /Title (official title -- i.e., title element)
15754 \begin_layout LyX-Code
15755 /Subject (one line description of the document)
15758 \begin_layout LyX-Code
15762 \begin_layout LyX-Code
15765 pdfcatalog { /PageMode (/UseNone)
15768 \begin_layout LyX-Code
15769 % /OpenAction (fitbh)
15772 \begin_layout LyX-Code
15776 \begin_layout LyX-Code
15779 usepackage[pdftex]{hyperref}
15782 \begin_layout LyX-Code
15788 \begin_layout LyX-Code
15791 usepackage[ps2pdf]{hyperref}
15794 \begin_layout LyX-Code
15800 \begin_layout Subsubsection
15801 How can I make URLs clickable ?
15804 \begin_layout Standard
15805 See the references here :
15808 \begin_layout Standard
15809 \begin_inset LatexCommand \url{http://wiki.lyx.org/pmwiki.php/FAQ/PDF}
15816 \begin_layout Subsection
15820 \begin_layout Standard
15821 Custom exports are possible if you have some particularly weird format you
15822 wish to convert to, assuming you have the relevant converter, of course.
15827 file can be chosen in the
15832 ile\SpecialChar \menuseparator
15837 xport\SpecialChar \menuseparator
15844 dialog; LyX will automatically convert the file to this point, then feed
15845 it to your custom converter.
15846 The possible values are all formats that LyX can produce from its own documents.
15850 \begin_layout Standard
15851 The converter command is also specified in the dialog.It should be a completely
15852 qualified command line which uses the variable
15856 to specify the name of the file.
15857 If this variable is not given, then the file will be sent to the standard
15858 input of your command.
15859 You may have to apply a bit of ingenuity to escape this sequence correctly
15860 so that it is compatible with your shell.
15864 \begin_layout Standard
15865 While it is not possible to save this command using the
15869 dialog, you can manually edit your
15876 \begin_layout LyX-Code
15879 custom_export_command "mycommand $$FName"
15882 \begin_layout Section
15883 The Complete reLyX Description
15884 \begin_inset LatexCommand \label{sec:reLyX}
15891 \begin_layout Subsection
15895 \begin_layout Standard
15896 The simplest way to use reLyX is via the
15901 ile\SpecialChar \menuseparator
15909 That runs reLyX on the given file and loads the resulting file into LyX.
15910 You should try that first, and call it from the command line only if you
15911 need to use more complicated options.
15914 \begin_layout Standard
15966 \begin_layout Standard
16022 \begin_layout Standard
16032 \begin_layout Subsection
16036 \begin_layout Description
16042 By default, when reLyX sees a
16048 command, it creates a file of textclass
16049 \begin_inset Quotes eld
16053 \begin_inset Quotes erd
16056 and reads the LyX layout file for that class.
16061 to declare a different textclass (and read a different layout file).
16064 \begin_layout Description
16070 By default, reLyX gives sparse output and deletes the temporary files which
16071 were created during translation.
16076 flag will create much more output (both to stdout and stderr) and leave
16077 the temporary files around.
16080 \begin_layout Description
16086 reLyX will not run if the
16090 file it would generate already exists Use the
16094 option (carefully) to clobber any existing files.
16097 \begin_layout Description
16103 Print out usage information and quit
16106 \begin_layout Description
16112 With this option, all temporary files and LyX output files (for the given
16113 input file, for any included files, or for any file fragments given with
16118 option) will be put into
16123 Otherwise, for each file
16127 , the temporary files and the LyX output file will be created in
16132 This can be useful if a file includes files from other directories which
16133 you want to consolidate in one directory, or if you don't have write permission
16134 on the directory the LaTeX files are in.
16137 \begin_layout Description
16143 The input files are LaTeX fragments, with no preamble matter or
16150 This option requires the
16154 option, since there are no
16160 commands in the files reLyX is translating.
16161 When using this option, you can translate more than one file, as long as
16162 all files are the same class.
16163 The LyX file created by reLyX can be included in an existing LyX file using
16169 nsert\SpecialChar \menuseparator
16174 \SpecialChar \menuseparator
16185 \begin_layout Description
16190 Regular environments (see the Section\InsetSpace ~
16192 \begin_inset LatexCommand \ref{sub:relyx-syntax}
16197 If you give more than one environment, separate them with commas (not
16199 You'll probably need to quote the environment list, especially if it has
16200 asterisk environments (foo*) in it.
16201 If you use this command often, considering creating a personal syntax file.
16204 \begin_layout Description
16210 Input (one or more quoted, comma-separated) syntax files to read in addition
16212 (see the section Section\InsetSpace ~
16214 \begin_inset LatexCommand \ref{sub:relyx-syntax}
16221 \begin_layout Subsection
16225 \begin_layout Subsubsection
16229 \begin_layout Standard
16230 reLyX will create a LyX file
16234 from the LaTeX file
16245 \begin_layout Standard
16263 does not exist and does not have one of these suffixes, reLyX will try
16269 (This is similar to the behavior of LaTeX.)
16272 \begin_layout Standard
16273 The purpose of reLyX is to translate
16278 If your LaTeX file doesn't compile---or if you do weird things, like redefining
16279 standard LaTeX commands---it may choke.
16280 LaTeX209 will often be translated correctly, but it's not guaranteed.
16283 \begin_layout Standard
16284 reLyX has some bugs and lacks a few features.
16285 However, its main goals are:
16288 \begin_layout Itemize
16289 Get through a well-behaved LaTeX2e file without crashing
16292 \begin_layout Itemize
16293 Translate a lot of that file.
16296 \begin_layout Itemize
16297 Localize the parts that can't be translated and copy them in TeX mode
16300 \begin_layout Standard
16301 It achieves these main goals pretty well on most files.
16304 \begin_layout Standard
16305 There are many improvements that can and will be made to reLyX in the future.
16306 However, we wanted to get reLyX out there early on, to make it easier for
16307 new LyX users to read in their existing LaTeX files.
16310 \begin_layout Subsubsection
16314 \begin_layout Standard
16315 Here's a more lengthy description of what you should do to translate a LaTeX
16319 \begin_layout Itemize
16324 \begin_layout Standard
16325 reLyX will inform you of its progress and give any warnings to stderr, so
16326 if you don't want any output at all, try (in csh)
16327 \begin_inset Quotes eld
16332 reLyX foo.tex >& /dev/null
16335 \begin_inset Quotes erd
16339 \begin_inset Quotes eld
16351 \begin_inset Quotes erd
16355 You should NOT redirect standard output to
16364 \begin_layout Itemize
16365 Run LyX on the resulting .lyx file.
16369 \begin_layout Standard
16370 In theory, most of the file will have been translated, and anything that's
16371 untranslatable will be highlighted in red (TeX mode).
16372 In theory, LyX will be able to read in the file, and to create printed
16373 documents from it, because all that untranslated red stuff will be passed
16374 directly back to LaTeX, which LyX uses as a backend.
16375 Unfortunately, reality doesn't always reflect theory.
16376 If reLyX crashes, or LyX cannot read the generated LyX file, see Section\InsetSpace ~
16378 \begin_inset LatexCommand \ref{sub:relyx-bugs}
16390 \begin_layout Itemize
16391 Change things that are in ERT boxes (TeX code) by hand in LyX.
16395 \begin_layout Standard
16396 As mentioned above, you should be able to print out the LyX file even without
16398 However, changing a command in TeX mode to the corresponding LyX object
16399 will allow you to take advantage of LyX's WYSIWYM editing.
16402 \begin_layout Standard
16403 reLyX is not guaranteed to create a LyX file which generates exactly the
16404 same output as the LaTeX file, but it should come close.
16405 reLyX will generally err on the side of translating less to ensure that
16406 dvi or ps files are accurate, even though this leads to more
16407 \begin_inset Quotes eld
16411 \begin_inset Quotes erd
16418 \begin_layout Itemize
16419 PROOFREAD THE DOCUMENT!!
16423 \begin_layout Standard
16424 I'm sure you were planning on doing this anyway, but it's particularly important
16425 after translating a LaTeX document.
16426 reLyX is, at least now, better at
16427 \begin_inset Quotes eld
16431 \begin_inset Quotes erd
16434 (translating the whole document) than
16435 \begin_inset Quotes eld
16439 \begin_inset Quotes erd
16442 (translating every little detail).
16443 For example, you may see extra spaces or deleted spaces.
16444 Space handling has improved, but it's not perfect.
16448 \begin_layout Subsubsection
16449 What reLyX Can Handle
16452 \begin_layout Standard
16453 reLyX understands many LaTeX commands.
16457 \begin_layout Itemize
16458 regular text, including mini-commands like ~, '',
16470 , as well as accented characters like
16476 , and the special cases ?` and !`
16479 \begin_layout Itemize
16480 title commands like
16504 and the abstract environment
16507 \begin_layout Itemize
16508 heading commands like
16514 including starred commands (
16523 \begin_layout Itemize
16549 \begin_layout Itemize
16562 environments, and their
16569 Also, well-behaved nested lists
16572 \begin_layout Itemize
16573 cross-referencing commands:
16598 \begin_layout Itemize
16612 \begin_layout Itemize
16613 font-changing commands including
16631 , and corresponding commands to change family, size, series, and shape
16634 \begin_layout Itemize
16661 \begin_inset Quotes erd
16671 \begin_inset Quotes erd
16677 \begin_layout Itemize
16682 environment, and commands that go inside it like
16703 \begin_layout Itemize
16718 commands within them
16721 \begin_layout Itemize
16732 command, as well as BibTeX's
16747 \begin_layout Itemize
16748 miscellaneous commands:
16777 \begin_layout Itemize
16778 documentclass-specific environments (and some commands) which can be translated
16782 \begin_layout Itemize
16783 arguments to certain untranslatable commands (e.g.
16793 \begin_layout Standard
16794 Some of this support may not be 100% yet.
16795 See below for details
16798 \begin_layout Standard
16799 reLyX copies math (almost) verbatim from your LaTeX file.
16800 Luckily, LyX reads in LaTeX math, so (almost) any math which is supported
16801 by LyX should work just fine.
16802 A few math commands which are not supported by LyX will be replaced with
16803 their equivalents, e.g.,
16823 \begin_layout Standard
16824 reLyX will also copy any preamble commands (i.e., anything before
16830 ) verbatim, so fancy stuff you've got in your preamble should be conserved
16831 in dvi and printed documents, although it will not of course show up in
16833 Check the preamble to make sure.
16836 \begin_layout Subsubsection
16837 What reLyX Can't Handle --- But it's OK
16840 \begin_layout Itemize
16848 \begin_layout Itemize
16852 \begin_layout Itemize
16874 \begin_layout Itemize
16894 \begin_layout Itemize
16906 reLyX is careful to copy
16910 in this case, including comments and whitespace.
16913 \begin_layout Itemize
16914 some unknown (e.g., user-defined) environments and commands
16917 \begin_layout Standard
16918 reLyX copies unknown commands, along with their arguments, verbatim into
16926 where it doesn't recognize the
16927 \begin_inset Quotes eld
16931 \begin_inset Quotes erd
16934 environment, it will copy verbatim until it sees
16940 (unless you use the
16945 Hopefully, then, most of these unknown commands won't cause reLyX to break;
16946 they'll merely require you to do some editing once you've loaded the file
16948 That should be less painful than editing either the
16956 file using a text editor.
16959 \begin_layout Subsubsection
16960 What reLyX Handles Badly --- a.\InsetSpace ~
16964 \begin_inset LatexCommand \label{sub:relyx-bugs}
16971 \begin_layout Standard
16972 Since reLyX is relatively new, it's got a number of problems.
16973 As it matures, these bugs will be squished.
16974 A number of bugs and missing features can be found listed on the LyX bug
16976 \begin_inset LatexCommand \url[LyX Bugzilla]{http://bugzilla.lyx.org/}
16983 \begin_layout Standard
16984 If reLyX is choking on something, or LyX can't read it after reLyX translates
16985 it, the best thing to do is to put
16991 before the offending text, and
16999 \begin_inset Quotes eld
17003 \begin_inset Quotes erd
17007 reLyX will copy this block exactly, in TeX mode.
17008 Then edit the resulting LyX file, and translate the unknown stuff by hand.
17013 environment is magical; the
17025 commands will not be put into the LyX file.
17028 \begin_layout Itemize
17029 \begin_inset Quotes eld
17033 \begin_inset Quotes erd
17036 copying of unknown environments and commands isn't quite exact.
17037 Specifically, newlines and comments may be lost.
17038 This will yield ugly LyX, but in almost all cases the output will be the
17040 However, certain parts of the file will be copied perfectly, including
17041 whitespace and comments.
17042 This includes: the LaTeX preamble,
17052 commands, and skip blocks.
17055 \begin_layout Itemize
17056 reLyX translates only a few options to the
17063 (Specifically 1[012]pt, [letter|legal|executive|a4|a5|b5]paper, [one|two]side,
17064 landscape, and [one|two]column.) Other options are placed in the extra class
17065 options field in the
17070 ocument\SpecialChar \menuseparator
17081 \begin_layout Standard
17082 More importantly, reLyX doesn't translate
17088 commands, margin commands,
17094 s, or, in fact, anything else from the preamble.
17095 It simply copies them into the LaTeX preamble.
17096 If you have margin commands in your preamble, then the LyX file will generate
17098 However, these margins will override any margins you set in the LyX
17105 \SpecialChar \menuseparator
17111 So you should remove the options from the preamble to be safe.
17112 The same goes for setting your language with babel,
17128 \begin_layout Itemize
17129 The foil class has a couple bugs.
17130 reLyX may do weird things with optional arguments to
17137 Also, it may handle
17143 incorrectly (although the stuff in the environment should translate normally).
17146 \begin_layout Standard
17147 reLyX is hopefully rather robust.
17148 As mentioned above, it may not translate your file perfectly, but it shouldn't
17150 If it does crash---and the problem is not one of those mentioned above
17155 file---see Section\InsetSpace ~
17157 \begin_inset LatexCommand \ref{sub:relyx-bug-reports}
17164 \begin_layout Subsubsection
17165 What LyX Can't Handle
17168 \begin_layout Standard
17169 LyX itself is missing a couple features, such that even if reLyX translates
17170 things perfectly, LyX may still have trouble reading it.
17171 If you really need these features, you can export your final document as
17172 LaTeX, and put them back in.
17177 for more details on these bugs.
17180 \begin_layout Itemize
17181 For a number of commands, LyX does not support the optional argument.
17194 (and other sectioning commands), and
17203 reLyX will automatically discard the optional arguments with a warning
17205 LyX also ignores the width argument for the
17212 \begin_layout Itemize
17213 Centering (or right or left justifying) works on full paragraphs.
17216 \begin_layout Itemize
17217 LyX support for tables isn't perfect.
17218 For complicated tables, use a
17219 \begin_inset Quotes eld
17223 \begin_inset Quotes erd
17226 block, so that they will be copied in TeX mode.
17229 \begin_layout Itemize
17230 The LyX math editor can't handle the AMS-LaTeX math environments align,
17232 So those environments will be copied in TeX mode.
17237 environments to the exactly equivalent displaymath, and then they will
17238 be translated correctly.
17241 \begin_layout Subsection
17245 \begin_layout Standard
17249 \begin_inset Quotes eld
17253 \begin_inset Quotes erd
17257 \begin_inset Quotes eld
17261 \begin_inset Quotes erd
17264 foo.tex > foo.debug
17267 \begin_layout Standard
17268 The above will create a file my/dir/foo.lyx from foo.tex, overwriting if necessary.
17278 block, it will translate the stuff within the block, but copy the
17290 commands in TeX mode.
17291 Finally, I'm going to keep the temporary files around (they will also
17292 be in my/dir/) and output lots of debugging information into the file foo.debug.
17295 \begin_layout Subsection
17299 \begin_layout Subsubsection
17301 \begin_inset LatexCommand \label{sub:relyx-bug-reports}
17308 \begin_layout Standard
17309 If reLyX is crashing or otherwise acting strangely---in ways other than
17310 those described in Section\InsetSpace ~
17312 \begin_inset LatexCommand \ref{sub:relyx-bugs}
17316 or the bug tracker---then please run reLyX
17321 That will allow you to figure out where in the reLyXing process it crashed.
17322 That, in turn, will allow you to write a better bug report, which will
17323 allow the developers to fix it more quickly and easily.
17326 \begin_layout Standard
17327 Bug reports should be sent to the LyX developers' mailing list.
17328 Its address is currently
17330 lyx-devel@lists.lyx.org
17333 If you are running reLyX on a huge file, please do not send all of the
17334 output in your bug report.
17335 Just include the last ten or twenty lines of output, along with the piece
17336 of the LaTeX file it crashed on.
17337 Or, even better, attach a small but complete file which causes the same
17338 problem as your original file.
17341 \begin_layout Subsubsection
17342 Implementation Details:
17345 \begin_layout Standard
17346 reLyX makes several
17347 \begin_inset Quotes eld
17351 \begin_inset Quotes erd
17354 in order to translate a TeX file.
17355 On each pass, it creates one or two files.
17358 \begin_layout Description
17363 Before doing anything, read the syntax file (or files).
17366 \begin_layout Description
17371 Split preamble (anything before a
17377 command) off the rest of the file.
17378 It saves the two pieces in separate files.
17379 This is necessary because there may be very strange stuff in a preamble.
17380 It also ignores anything after the
17386 , on the assumption that it isn't LaTeX.
17389 \begin_layout Description
17394 Translate the preamble.
17395 Currently, that just means translating the
17401 command and copying the rest exactly into the LyX preamble.
17405 \begin_layout Standard
17406 Once you know what class the document is, read the LyX layout file for that
17411 \begin_layout Description
17417 \begin_inset Quotes eld
17421 \begin_inset Quotes erd
17424 the TeX file, generating slightly stricter LaTeX.
17429 \begin_layout Itemize
17434 to the equivalent but clearer
17439 \begin_layout Itemize
17440 Removing optional arguments that LyX can't handle (e.g., from
17449 \begin_layout Itemize
17463 This is necessary because LyX always writes out the non-local forms anyway.
17464 This should very rarely make a difference.
17468 \begin_layout Description
17473 Translate LaTeX text, commands, and environments to LyX.
17476 \begin_layout Description
17481 Put the two pieces back together, and do some final tweaking, to generate
17485 \begin_layout Standard
17498 commands, reLyX will loop back to the beginning and translate those.
17499 It assumes that the included files are the same class as the main file,
17500 and that they have no preamble matter.
17507 command in the preamble of a file, the command will be copied exactly into
17508 the LaTeX preamble portion of the LyX file, so the included file won't
17509 be translated.) So when translating included files, it skips passes 0 and
17513 \begin_layout Standard
17514 If reLyX doesn't find a file you wanted to include, it will give a warning,
17515 but will continue to translate any files it does find.
17518 \begin_layout Subsubsection
17522 \begin_layout Standard
17523 reLyX reads a LyX layout file to know how to handle LaTeX environments and
17524 commands which get translated to LyX layouts.
17525 This file will include all
17526 \begin_inset Quotes eld
17530 \begin_inset Quotes erd
17533 non-math environments (i.e., including quote and itemize, but not tabular,
17534 minipage, and some other fancy environments), and commands like
17547 If you want to reLyX a class that doesn't have an existing layout file,
17548 then you'll have to create a layout file.
17549 But you have to do this anyway, in order to LyX the file, since LyX depends
17550 on layout files to know how to display and process its files.
17551 Check the LyX documentation for help with this task (which can be hard
17552 or easy, depending on the class you want to create a layout file for.) If
17553 your class is quite similar to a class that has a layout file, then consider
17561 \begin_layout Subsubsection
17563 \begin_inset LatexCommand \label{sub:relyx-syntax}
17570 \begin_layout Standard
17571 reLyX always reads at least one syntax file, called the default syntax file.
17572 reLyX will read your personal syntax file if it exists; otherwise it will
17573 read the system-wide file.
17574 reLyX will read additional syntax files if you specify them with the
17579 (These extra files should have the same format as the default file, but
17580 will tend to be shorter, since they only have to specify extra commands
17581 not found in the default file.) A syntax file tells reLyX a few things.
17584 \begin_layout Standard
17585 First, it describes the syntax of each command, that is, how many required
17586 arguments and how many optional arguments the command takes.
17587 Knowing this makes it easier for reLyX to copy (in TeX mode) commands that
17588 it doesn't know how to translate.
17589 The syntax file simply has a command, followed by braces or brackets describing
17590 its arguments in the correct order.
17591 For example, a syntax file entry
17603 command takes an optional argument followed by a required one, while the
17616 command takes no arguments at all.
17617 When reLyX encounters a token that it doesn't know how to translate into
17618 LyX, it will copy the token---along with the correct number of arguments---exac
17620 If the token is not in the syntax file, then reLyX just copies as many
17621 arguments as it finds.
17622 This means that it may copy too much.
17623 But since the user can specify additional syntax files, that shouldn't
17627 \begin_layout Standard
17628 Some commands that cannot be translated to LyX, like
17634 , have as one of their arguments regular LaTeX text.
17636 \begin_inset Quotes eld
17640 \begin_inset Quotes erd
17643 is put into an argument of an (untranslatable) command in the syntax file,
17644 then reLyX will translate that argument instead of copying it verbatim.
17645 So, for example, the default syntax file has
17649 raisebox{}[][]{translate}
17652 This means that the
17658 command and the first argument (and optional arguments if they exist) are
17659 copied in TeX mode, but the last argument (which may contain math, complicated
17660 LaTeX, other untranslatable commands, etc.) will be translated into LyX.
17662 \begin_inset Quotes eld
17666 \begin_inset Quotes erd
17669 on optional arguments.
17672 \begin_layout Standard
17673 User-defined syntax files are allowed to define new commands and their syntax,
17674 or override the number of arguments for a command given in the default
17676 (E.g., if you're using a style that gives an extra argument to some command...)
17677 However, this will only be useful for commands copied in TeX mode.
17678 Commands which are actually translated by reLyX (like
17684 ) have their argument syntax hard-coded.
17685 The hard-coded commands are identified in the default syntax file.
17688 \begin_layout Standard
17689 Second, the syntax file describes any
17690 \begin_inset Quotes eld
17693 regular environments
17694 \begin_inset Quotes erd
17698 Usually, an entire unknown environment will be copied in TeX mode.
17699 If you define a regular environment
17700 \begin_inset Quotes eld
17704 \begin_inset Quotes erd
17707 , though, then only the
17719 commands will be copied in TeX mode; the text within the environment will
17720 be treated (i.e., translated) by reLyX as regular LaTeX, rather than being
17721 copied into TeX mode.
17722 Don't try to declare
17730 as regular environments, as the text within those environments will confuse
17731 reLyX; use this capability for new environments you create that have plain
17732 text or math or simple commands in them.
17733 You also can't declare unknown math environments (like
17737 ) as regular environments, either, since the LyX math editor won't understand
17739 The names of regular environments appear, whitespace-separated, between
17752 statements in the syntax file.
17753 (If you have a regular environment which you won't use very often, you
17758 option rather than writing a syntax file.)
17761 \begin_layout Standard
17762 Third, the syntax file describes a math translation table.
17763 The LyX math editor doesn't support a few commands.
17768 is supported, but the equivalent
17775 Put any commands you'd like translate between
17789 \begin_inset Quotes eld
17801 \begin_inset Quotes erd
17810 in math mode will be converted to
17811 \begin_inset Quotes eld
17821 \begin_inset Quotes erd
17828 (in cases where a token made up of a backslash and a non-letter is translated
17829 to something with letters at the end, a space is added by reLyX.
17831 \begin_inset Quotes eld
17841 \begin_inset Quotes erd
17844 is correctly translated to
17845 \begin_inset Quotes eld
17855 \begin_inset Quotes erd
17861 \begin_layout Subsubsection
17865 \begin_layout Standard
17866 You need Perl version 5.002 or later to run reLyX.
17867 <plug> If you don't have Perl, you should get it anyway (at
17868 \begin_inset LatexCommand \url[Perl]{http://www.perl.com/}
17872 ), because it's a really useful tool for pretty much anything.
17876 \begin_layout Subsection
17880 \begin_layout Standard
17881 reLyX should always explain why it crashes, if it crashes.
17882 Some diagnostics may be very technical, though, if they come from the guts
17884 reLyX gives much more information while running if you use the
17888 option, but you shouldn't need that unless something goes wrong.
17891 \begin_layout Standard
17892 When it's finished, reLyX will tell you if it finished successfully or died
17896 \begin_layout Subsection
17900 \begin_layout Standard
17901 Always keep a copy of your original LaTeX files either under a different
17902 name or in a different directory.
17903 There are a couple ways in which using LyX could lead to overwriting the
17904 original LaTeX file.
17907 \begin_layout Standard
17920 and want to re-export it, note that it will overwrite the original
17929 ask you if you want to overwrite it.)
17932 \begin_layout Standard
17933 If you have chosen not to use a temporary directory in the preferences,
17934 then LyX will create its temporary files in your current directory, which
17935 means your LaTeX original may be overwritten (without a warning from LyX)
17937 \begin_inset Quotes eld
17941 \begin_inset Quotes erd
17944 or print the LyX document.
17947 \begin_layout Subsection
17951 \begin_layout Description
17955 MY_LYXDIR/layouts/*.layout
17961 User's personal layout files for document classes
17964 \begin_layout Description
17968 MY_LYXDIR/reLyX/syntax.default
17974 User's personal syntax file
17977 \begin_layout Description
17981 LIBDIR/layouts/*.layout
17987 System-wide layout files for document classes
17990 \begin_layout Description
17994 LIBDIR/reLyX/syntax.default
18000 System-wide LaTeX syntax file
18003 \begin_layout Standard
18008 is the system-wide LyX directory, usually something like
18010 /usr/local/share/lyx/
18017 is your personal LyX directory, something like
18021 in your home directory.
18022 You can see their actual values in the
18027 elp\SpecialChar \menuseparator
18037 \begin_layout Subsection
18041 \begin_layout Standard
18053 \begin_layout Subsection
18057 \begin_layout Standard
18058 Copyright (c) 1998--9
18064 karger@voth.chem.utah.edu
18069 \begin_layout Standard
18073 \begin_layout Itemize
18078 wrote the original CleanTeX pass.
18081 \begin_layout Itemize
18087 \begin_layout Itemize
18095 \begin_layout Itemize
18098 David Suarez de Lis
18101 \begin_layout Standard
18102 Other contributors:
18105 \begin_layout Itemize
18108 Jean-Marc Lasgouttes
18110 worked on the wrapper script and offered lots of bug reports, advice, and
18111 feature suggestions.
18114 \begin_layout Itemize
18127 \begin_layout Itemize
18128 Various members of the LyX developers' and users' lists provided bug reports
18129 and feature suggestions.
18132 \begin_layout Standard
18133 reLyX uses a modified version the Perl TeX parser
18143 ilya@math.ohio-state.edu
18145 ), available on CPAN.
18148 \begin_layout Chapter
18149 LyX Features needing Extra Software
18152 \begin_layout Section
18153 Using LyX with SGML-Tools (aka LinuxDoc)
18156 \begin_layout Standard
18162 \begin_layout Subsection
18166 \begin_layout Standard
18167 LinuxDoc is a document class available in LyX if you have the
18172 You can use it to produce documents in the so-called Standardized General
18173 Mark-up Language (SGML) in the particular format used by the Linux Documentatio
18175 That is obviously helpful if you are contributing to that project.
18176 You can use the SGML format with the
18180 package of scripts and programs (to produce other formats, including Latex,
18181 HTML, plain text, man pages and\SpecialChar \ldots{}
18183 You may therefore prefer to use this document class if you want to write
18184 something that can be easily translated into other formats.
18187 \begin_layout Standard
18188 You will find that LinuxDoc has fewer layout options than the other text
18190 This is mainly so that the translations into other formats have a chance
18191 of making some sense.
18192 In this section we describe:
18195 \begin_layout Itemize
18196 how to setup and use a document in LinuxDoc
18199 \begin_layout Itemize
18200 how to use the tags in LinuxDoc to layout your document
18203 \begin_layout Itemize
18204 how to use the SGML packages to produce the various formats
18207 \begin_layout Itemize
18208 how to sort out some problems.
18211 \begin_layout Subsection
18212 Preparing and using a LinuxDoc document
18215 \begin_layout Subsubsection
18219 \begin_layout Standard
18220 You start by selecting the LinuxDoc class using the
18225 ocument\SpecialChar \menuseparator
18237 Then you will find that there are fewer paragraph environments than for
18238 most other classes.
18239 You can see them on the pull down box on the left of the tool bar.
18240 How to use them is described in section\InsetSpace ~
18242 \begin_inset LatexCommand \ref{sec:sgmlparas}
18249 \begin_layout Standard
18254 enter a title for the document, followed by an author, marking each with
18255 the appropriate paragraph environment.
18256 If you don't do this, you will get errors when you try to print the file.
18257 You can then enter the date and an abstract.
18258 The document proper must start with a Section paragraph environment rather
18259 than any standard layout.
18262 \begin_layout Standard
18263 After that you can prepare a document as usual using the available range
18264 of paragraph environments.
18265 See section\InsetSpace ~
18267 \begin_inset LatexCommand \ref{sec:sgmlparas}
18271 for the full list and their uses.
18274 \begin_layout Subsubsection
18275 Output from LinuxDoc
18278 \begin_layout Standard
18279 You can print and save these documents in the normal way.
18280 To use the other features of the SGML package you need to save your document
18281 as LinuxDoc; this is a version in which the document is translated into
18282 the basic sgml tags.
18289 ile\SpecialChar \menuseparator
18294 xport\SpecialChar \menuseparator
18302 You will get a file with the same name and a
18306 extension rather than a
18313 \begin_inset LatexCommand \ref{sec:sgmloperate}
18317 on how you than make use of this file.
18320 \begin_layout Subsection
18321 Using the paragraph environments in LinuxDoc
18324 \begin_layout Subsubsection
18325 The Structure of a LinuxDoc Document
18328 \begin_layout Standard
18329 There is a formal structure for LinuxDoc which limits how you can place
18331 There are two parts to all documents:
18334 \begin_layout Description
18335 Header: this is everything up to the first time you insert a Section layout
18337 It can include title, author, date, abstract and ToC.
18338 You must include the first two.
18341 \begin_layout Description
18342 Body: from the beginning of the first section onwards.
18343 All other tags are allowed.
18347 \begin_layout Subsubsection
18348 The LinuxDoc Paragraph Environments
18351 \begin_layout Standard
18352 \begin_inset LatexCommand \label{sec:sgmlparas}
18356 Here is a list of all the tags you will find listed on the layout bar in
18357 the order they come there, with some comments where the purpose or use
18361 \begin_layout Itemize
18366 works as described in [cross reference]
18369 \begin_layout Itemize
18374 : This will appear at the top left of the document when printed, above a
18375 heavy horizontal rule, although you will not see this on the LyX screen.
18378 \begin_layout Itemize
18381 Section, Subsection, Subsubsection, Paragraph and Subparagraph:
18383 all do what you would expect and in the usual order.
18384 Whether they are numbered or not is controlled by the
18386 Section\InsetSpace ~
18387 number\InsetSpace ~
18391 You cannot get the equivalent number free versions in any other way; there
18399 \begin_layout Itemize
18404 As usual this produces a numbered and indented list as described in the
18412 \begin_layout Itemize
18417 Again much the same as in the other classes: see the
18424 \begin_layout Itemize
18429 : As explained in the
18434 Remember that if you want the bold element at the start of a description
18435 to be more than one word then you need to put protected spaces between
18440 \begin_layout Itemize
18448 \begin_layout Itemize
18451 Code: similar to the Lyx-Code
18456 \begin_layout Itemize
18461 : Anything you mark with this will appear on the left of the heading of
18462 the document, under the heavy rule.
18465 \begin_layout Itemize
18470 Anything you mark with this will appear on the right of the heading under
18472 You do not have to make this a date.
18473 Any text can be entered, e.\InsetSpace ~
18478 \begin_layout Itemize
18483 : You can use this to produce a free standing paragraph after the author
18484 and date, and before the first section.
18485 You are only allowed one such paragraph.
18489 \begin_layout Standard
18495 This needs checking ---
18505 \begin_layout Itemize
18514 \begin_layout Standard
18519 I have not yet checked this ---
18529 \begin_layout Subsubsection
18530 Other document features
18533 \begin_layout Standard
18534 You can also use the
18538 menu to set fonts or to emphasis words.
18539 You can also use the table of contents as usual; see the corresponding
18545 Although you will find some some other features on the menus e.\InsetSpace ~
18547 inserting footnotes.
18548 There is some doubt about whether these will work correctly.
18552 \begin_layout Standard
18557 Again still checking to see whether this is my system
18567 \begin_layout Subsubsection
18568 Cross references and HTML
18571 \begin_layout Standard
18576 menu you will find two new options relating to the inclusion of URL addresses.
18577 If you use either option you will find some highlighted TeX code inserted
18578 into your document in three separate blocks with spaces available between.
18579 The blocks will be:
18582 \begin_layout Quote
18614 \begin_layout Standard
18615 You insert a full HTML tag between the first and second blocks.
18617 \begin_inset LatexCommand \url{http://any.address}
18621 or other valid tags such as
18622 \begin_inset LatexCommand \url{mailto:me@my.address}
18634 insert some description between the second and third blocks.
18635 The differences are:
18638 \begin_layout Itemize
18643 both the HTML tag and the description will appear in the document
18646 \begin_layout Itemize
18652 only the description appears in the printed version
18655 \begin_layout Subsection
18656 Using the LinuxDoc Sgml scripts
18657 \begin_inset Note Note
18660 \begin_layout Standard
18661 This section is completely outdated.
18669 \begin_layout Standard
18670 \begin_inset LatexCommand \label{sec:sgmloperate}
18674 You can use LinuxDoc as a text class without any additional scripts or programs,
18675 but there is not much point in doing this.
18676 All you will get is a document that looks like a
18678 Linux Documentation Project Howto
18684 To do the document translation you need to get and install the
18686 sgml-tools-1.0.x.tar.gz
18689 \begin_inset Formula $x\geq3$
18694 the SGML-Tools WWW Page
18699 \begin_layout LyX-Code
18702 \begin_inset LatexCommand \url{http://pobox.com/~cg/sgmltools}
18711 \begin_layout Standard
18712 Alternatively, you can go to the
18720 \begin_layout Standard
18721 Note that, at the time of this writing (01/1998), version 1.0.3 of sgml-tools
18722 has not yet been made available at
18734 \begin_layout LyX-Code
18737 \begin_inset LatexCommand \url{ftp://sunsite.unc.edu/pub/Linux/utils/text/sgml-tools-1.0.x.tar.gz}
18744 \begin_layout Standard
18751 sgml-tools-1.0.x.tar.gz
18753 contains everything that you need to write SGML documents and convert them
18754 to groff, LaTeX, HTML, GNU info, LyX, and RTF\SpecialChar \@.
18758 \begin_layout Standard
18759 This package was renamed from
18761 linuxdoc-sgml-1.5.tar.gz
18766 \begin_layout Standard
18767 Follow the instructions in that package on how to install it and how to
18769 All this has to be done outside of LyX, before you can use the
18774 ile\SpecialChar \menuseparator
18779 xport\SpecialChar \menuseparator
18786 \begin_layout Subsection
18787 Troubleshooting LinuxDoc
18790 \begin_layout Standard
18791 When you print or preview a LinuxDoc document some checking is done of the
18792 tags before LaTeX is run.
18793 Some errors are trapped here, especially those concerning the structure
18795 LyX may produce an error message, but not leave an error box in the document
18797 You may have to look at the files directly to discover what is wrong.
18798 Most problems seem to come from the use of options that are not fully available
18802 \begin_layout Section
18806 \begin_layout Standard
18812 \begin_layout Subsection
18816 \begin_layout Standard
18824 menu, you'll find a
18833 This feature requires you to have the
18837 program installed, and is grayed out if you don't have it.
18838 You can get it from your nearest CTAN mirror, or over the Web from
18839 \begin_inset LatexCommand \url{http://www.ifi.uio.no/~jensthi/chktex/}
18846 \begin_layout Standard
18851 package is a program that was written by
18856 in frustration because some constructs in LaTeX are sometimes non-intuitive,
18857 and easy to forget.
18858 The program runs over your LaTeX file and checks the integrity of the file,
18859 and flags some common errors.
18860 In other technical words, it is
18867 \begin_layout Standard
18868 Well, what is a syntax checker doing in LyX which is supposed to produce
18869 correct LaTeX anyways? The answer is simple: Just as
18873 not only checks the
18877 of C programs, but also does
18881 checks for type-errors,
18885 catches some common
18889 errors, in addition to the syntactical ones.
18894 is capable of detecting several common errors, such as
18897 \begin_layout Itemize
18898 Ellipsis detection:
18900 Use \SpecialChar \ldots{}
18904 \begin_layout Itemize
18905 No space in front of/after parenthesis:
18910 \begin_layout Itemize
18911 Enforcement of normal space after common abbreviations:
18915 is too wide spacing.
18918 \begin_layout Itemize
18919 Enforcement of end-of-sentence space when the last sentence ends with a
18923 And this is wrong spacing.
18926 \begin_layout Itemize
18927 Space in front of labels and similar commands:
18929 The label should stick right
18930 up to the text to avoid falling to a wrong page.
18932 \begin_inset LatexCommand \label{sec:chktex}
18940 \begin_layout Standard
18941 This footnote is in danger of falling off to a wrong page
18946 The label is separated too much.
18949 \begin_layout Itemize
18950 Space in front of references, instead of hard spaces:
18952 In you are in bad luck,
18953 the text will break right between the referenced text and reference number,
18956 \begin_inset LatexCommand \ref{sec:chktex}
18963 \begin_layout Itemize
18965 \begin_inset Quotes eld
18969 \begin_inset Quotes erd
18973 \begin_inset Formula $\times$
18978 2x2 looks cheap compared to
18979 \begin_inset Formula $2\times2$
18985 \begin_layout Standard
18986 and more \SpecialChar \ldots{}
18987 It is an invaluable tool when you are
18988 \begin_inset Quotes eld
18992 \begin_inset Quotes erd
18995 your document before printing, and you should run it right after the obligatory
18996 spelling check, and before you go fine tuning the typesetting.
18999 \begin_layout Subsection
19003 \begin_layout Standard
19004 If you have the program installed, usage is as simple as choosing
19009 ools\SpecialChar \menuseparator
19018 This will make LyX generate a LaTeX file of your document, start
19022 to check it, and then make LyX insert
19023 \begin_inset Quotes eld
19027 \begin_inset Quotes erd
19030 with the warnings from
19034 , if there were any.
19035 The warnings will be placed close to the point of the mistake, and you
19036 can quickly find them by using the
19041 avigate\SpecialChar \menuseparator
19048 menu item, or the shortcut key
19057 Open the error boxes by clicking on them with the mouse, or use the shortcut
19066 bindings, or the corresponding
19075 Read the warning and correct the mistake, if it is a mistake.
19076 If you have trouble understanding what the warning is about, you can safely
19078 Remember that there is a hidden layer between the document on screen and
19079 the technical details in invoking
19083 , and this gap can make some warnings seem arcane or just right down plain
19087 \begin_layout Standard
19088 This document is an excellent testing bed for the feature, and it should
19089 provide quite a few warnings for you to fiddle with.
19090 Since computers are only so smart, expect most of the warnings to be false
19094 \begin_layout Subsection
19095 How to fine tune it
19098 \begin_layout Standard
19099 Sometimes, you'll find that
19103 makes more noise than suits your mood.
19104 Then you can choose not to use it, wait until your mood changes, or try
19109 to get better along with you.
19110 Another choice in the most desperate situations is to use
19115 iew\SpecialChar \menuseparator
19125 , which will get rid of all warnings instantly.
19128 \begin_layout Standard
19137 very configurable and extensible, you shouldn't expect to solve all problems
19143 Since LyX has to generate a somewhat special LaTeX file to be able to match
19144 the line numbers from the
19152 \begin_layout Standard
19153 You can inspect the specific output from
19159 Edit\SpecialChar \menuseparator
19173 to the internal document structure, some of the warnings will not seen
19174 to appear correctly.
19175 There are two things you can do about this:
19178 \begin_layout Itemize
19183 invocation command line in
19199 installation configuration file (usually with the file
19201 /usr/local/share/chktexrc
19204 See below to learn what warnings can be enabled and disabled on the command
19209 \begin_layout Itemize
19210 Export your document as a raw LaTeX file using
19215 ile\SpecialChar \menuseparator
19220 xport\SpecialChar \menuseparator
19232 Invoked in this way, it can be a hassle to find the corresponding place
19233 in the document inside LyX, but with a little patience, you should be able
19237 \begin_layout Standard
19238 Here follows the warning messages that can be enabled and disabled in
19247 to disable a warning, and
19251 to enable a warning.
19252 The emphasized entries are disabled by default, because the default is
19255 chktex -n1 -n3 -n6 -n9 -n22 -n25 -n30 -n38
19260 \begin_layout Standard
19261 Notice that you should only use the options that enable and disable warnings,
19262 because LyX relies on some of the other command line parameters to be set
19263 in a specific way to have a chance to communicate with
19270 \begin_layout Enumerate
19274 Command terminated with space.
19277 \begin_layout Enumerate
19280 Non-breaking space (
19281 \begin_inset Quotes eld
19289 \begin_inset Quotes erd
19292 ) should have been used.
19295 \begin_layout Enumerate
19299 You should enclose the previous parenthesis with
19300 \begin_inset Quotes eld
19308 \begin_inset Quotes erd
19314 \begin_layout Enumerate
19317 Italic correction (
19318 \begin_inset Quotes eld
19328 \begin_inset Quotes erd
19331 ) found in non-italic buffer.
19334 \begin_layout Enumerate
19337 Italic correction (
19338 \begin_inset Quotes eld
19348 \begin_inset Quotes erd
19351 ) found more than once.
19354 \begin_layout Enumerate
19358 No italic correction (
19359 \begin_inset Quotes eld
19369 \begin_inset Quotes erd
19375 \begin_layout Enumerate
19379 \begin_inset Quotes eld
19387 \begin_inset Quotes erd
19391 \begin_inset Quotes eld
19399 \begin_inset Quotes erd
19405 \begin_layout Enumerate
19408 Wrong length of dash may have been used.
19411 \begin_layout Enumerate
19415 \begin_inset Quotes eld
19423 \begin_inset Quotes erd
19427 \begin_inset Quotes eld
19435 \begin_inset Quotes erd
19441 \begin_layout Enumerate
19445 \begin_inset Quotes eld
19453 \begin_inset Quotes erd
19459 \begin_layout Enumerate
19463 \begin_inset Quotes eld
19471 \begin_inset Quotes erd
19474 to achieve an ellipsis.
19477 \begin_layout Enumerate
19480 Inter-word spacing (
19481 \begin_inset Quotes eld
19491 \begin_inset Quotes eld
19494 ) should perhaps be used.
19497 \begin_layout Enumerate
19500 Inter-sentence spacing (
19501 \begin_inset Quotes eld
19511 \begin_inset Quotes erd
19514 ) should perhaps be used.
19517 \begin_layout Enumerate
19520 Could not find argument for command.
19523 \begin_layout Enumerate
19527 \begin_inset Quotes eld
19535 \begin_inset Quotes erd
19541 \begin_layout Enumerate
19544 Math mode still on at end of LaTeX file.
19547 \begin_layout Enumerate
19551 \begin_inset Quotes eld
19559 \begin_inset Quotes erd
19562 doesn't match the number of
19563 \begin_inset Quotes eld
19571 \begin_inset Quotes erd
19577 \begin_layout Enumerate
19580 You should use either
19583 \begin_inset Quotes eld
19591 \begin_inset Quotes erd
19596 as an alternative to
19597 \begin_inset Quotes eld
19605 \begin_inset Quotes erd
19611 \begin_layout Enumerate
19618 " (ASCII 39) instead of "
19625 \begin_layout Enumerate
19628 User-specified pattern found.
19631 \begin_layout Enumerate
19634 This command might not be intended.
19637 \begin_layout Enumerate
19644 \begin_layout Enumerate
19662 \begin_layout Enumerate
19665 Delete this space to maintain correct page references.
19668 \begin_layout Enumerate
19672 You might wish to put this between a pair of
19673 \begin_inset Quotes eld
19681 \begin_inset Quotes erd
19687 \begin_layout Enumerate
19690 You ought to remove spaces in front of punctuation.
19693 \begin_layout Enumerate
19696 Could not execute LaTeX command.
19699 \begin_layout Enumerate
19708 in front of small punctuation.
19711 \begin_layout Enumerate
19719 may look prettier here.
19722 \begin_layout Enumerate
19726 Multiple spaces detected in output.
19729 \begin_layout Enumerate
19732 This text may be ignored.
19735 \begin_layout Enumerate
19741 \begin_inset Quotes eld
19746 to begin quotation, not
19753 \begin_layout Enumerate
19760 to end quotation, not
19763 \begin_inset Quotes eld
19771 \begin_layout Enumerate
19777 \begin_layout Enumerate
19780 You should perhaps use
19781 \begin_inset Quotes eld
19789 \begin_inset Quotes erd
19795 \begin_layout Enumerate
19798 You should put a space in front of/after parenthesis.
19801 \begin_layout Enumerate
19804 You should avoid spaces in front of/after parenthesis.
19807 \begin_layout Enumerate
19811 You should not use punctuation in front of/after quotes.
19814 \begin_layout Enumerate
19817 Double space found.
19820 \begin_layout Enumerate
19823 You should put punctuation outside inner/inside display math mode.
19826 \begin_layout Enumerate
19829 You ought to not use primitive TeX in LaTeX code.
19832 \begin_layout Enumerate
19835 You should remove spaces in front of
19836 \begin_inset Quotes eld
19844 \begin_inset Quotes erd
19850 \begin_layout Enumerate
19853 \begin_inset Quotes eld
19861 \begin_inset Quotes erd
19864 is normally not followed by
19865 \begin_inset Quotes eld
19873 \begin_inset Quotes erd
19879 \begin_layout Standard
19880 In later versions of LyX, we hope to provide a more complete interface to
19881 this tool (and it's smaller cousin
19885 ) to exploit the full power of it.
19886 But it's not exactly useless as it is now: go try it on one of your existing
19887 documents of a certain length and be surprised.
19890 \begin_layout Section
19891 Version Control in LyX
19894 \begin_layout Standard
19897 Lars Gullik Bjønnes
19900 \begin_layout Subsection
19904 \begin_layout Standard
19905 A friend of mine wanted to try LyX for a group project.
19906 When he didn't find support for version control or file locking, he dropped
19908 This angered me a bit, so I thought that I should at least make support
19909 for RCS (with the possibility of CVS and/or SCCS as a future improvement.)
19910 This has now been done.
19911 LyX now supports some of the most basic RCS commands.
19912 If you need to something a bit more sophisticated you will have to do that
19913 manually in an xterm.
19916 \begin_layout Standard
19917 Before you begin to use the version control features in LyX, you should
19919 \begin_inset Quotes eld
19923 \begin_inset Quotes erd
19926 (a man file, read it with
19931 This file describes all the basic features of RCS.
19932 You should especially notice the comment about a RCS directory, and the
19933 notion of a master RCS file (the file ending in
19940 \begin_layout Standard
19941 The implementation in LyX assumes a recent version of the GNU RCS package---no
19942 guarantees are made for older versions.
19945 \begin_layout Subsection
19946 RCS commands in LyX
19949 \begin_layout Standard
19950 The following sections describe the RCS commands supported by LyX.
19951 You can find them in the
19956 ile\SpecialChar \menuseparator
19961 ersion\InsetSpace ~
19967 \begin_layout Subsubsection
19973 \begin_layout Standard
19974 If your document is not under revision control, this is the only item shown
19976 And if it is under revision control, the
19983 item is grayed out.
19987 \begin_layout Standard
19988 This command registers your document with RCS\SpecialChar \@.
19989 You are asked interactively
19990 to supply an initial description of the document.
19991 The document is now set in Read-Only mode and you have to
19998 , before making any changes to it.
19999 A document under revision control has a
20000 \begin_inset Quotes eld
20003 [RCS:<version> <locker>]
20004 \begin_inset Quotes erd
20007 item tagged to the filename in the minibuffer.
20010 \begin_layout Standard
20011 RCS command that is run:
20013 ci -q -u -i -t-"<initial description>" <file-name>
20016 \begin_layout Standard
20021 to understand the switches.
20025 \begin_layout Subsubsection
20031 \begin_layout Standard
20032 When you are finished editing a file, you check in your changes.
20033 When you do this, you are asked for a description of the changes.
20034 This is stored in the history log.
20035 The version number is bumped, your changes are applied to the master RCS
20036 file, the document is unlocked and set to Read-Only mode.
20040 \begin_layout Standard
20043 ci -q -u -m"<description>" <file-name>
20046 \begin_layout Subsubsection
20052 \begin_layout Standard
20053 By doing this you lock the document so that only you can edit it.
20054 This will also make the document Read-Write only for you.
20055 You will usually continue editing for a while and when you are finished
20056 you check in your changes.
20057 The status line is changed to reflect that you have locked the file.
20061 \begin_layout Standard
20064 co -q -l <file-name>
20067 \begin_layout Subsubsection
20070 Revert To Last Version
20073 \begin_layout Standard
20074 This will discard all changes made to the document since the last check
20076 You get a warning before changes are discarded.
20079 \begin_layout Standard
20082 co -f -u<version> <file-name>
20085 \begin_layout Subsubsection
20091 \begin_layout Standard
20092 This makes as if the last check in never happened.
20093 No changes are made to the document loaded into LyX, but the last version
20094 is removed from the master RCS file.
20098 \begin_layout Standard
20101 rcs -o<version> <file-name>
20104 \begin_layout Subsubsection
20110 \begin_layout Standard
20111 This show the complete history of the RCS document.
20116 is shown in a browser.
20124 \begin_layout Section
20125 Literate Programming
20128 \begin_layout Standard
20133 (kayvan@sylvan.com)
20137 original documentation written by
20139 Edmar Wienskoski Jr.
20142 (edmar-w-jr@technologist.com)
20145 \begin_layout Subsection
20149 \begin_layout Standard
20150 The main purpose of this documentation is to show you how to use LyX for
20151 literate programming.
20152 Where it is assumed that you are familiar with this programming technique,
20154 \begin_inset Quotes eld
20158 \begin_inset Quotes erd
20162 \begin_inset Quotes eld
20166 \begin_inset Quotes erd
20170 If that is not the case, please follow the web links provided in the following
20172 There is a lot of good documentation out there covering old development
20173 history to the latest tools tips.
20176 \begin_layout Standard
20177 It is also assumed that you are familiar with LyX itself to a point that
20178 you are comfortable changing your LyX preferences, and X resources file.
20179 If that is not the case please refer to other LyX documentation to cover
20180 your specific needs.
20183 \begin_layout Subsection
20184 Literate Programming
20187 \begin_layout Standard
20188 From the Literate Programming FAQ:
20191 \begin_layout Quotation
20192 Literate programming is the combination of documentation and source together
20193 in a fashion suited for reading by human beings.
20194 In fact, literate programs should be enjoyable reading, even inviting!
20195 (Sorry Bob, I couldn't resist!) In general, literate programs combine source
20196 and documentation in a single file.
20197 Literate programming tools then parse the file to produce either readable
20198 documentation or compilable source.
20199 The WEB style of literate programming was created by D.E.
20200 Knuth during the development of his TeX typesetting software.
20204 \begin_layout Standard
20205 Another excerpt says:
20208 \begin_layout Quotation
20211 How is literate programming different from verbose commenting?
20214 \begin_layout Quotation
20215 There are three distinguishing characteristics.
20216 In order of importance, they are:
20220 \begin_layout Itemize
20221 flexible order of elaboration
20224 \begin_layout Itemize
20225 automatic support for browsing
20228 \begin_layout Itemize
20229 typeset documentation, especially diagrams and mathematics
20233 \begin_layout Standard
20234 Now that I sparked your curiosity, take a look in the references.
20237 \begin_layout Subsubsection
20241 \begin_layout Standard
20242 The complete Literate Programming FAQ can be found at:
20245 \begin_layout Quote
20246 \begin_inset LatexCommand \url[Literate Programming FAQ]{http://shelob.ce.ttu.edu/daves/lpfaq/faq.html}
20253 \begin_layout Standard
20254 The FAQ lists 23 (twenty three!) different literate programming tools.
20255 Where some are specialized or
20256 \begin_inset Quotes eld
20260 \begin_inset Quotes erd
20263 for particular programming languages, while other have general scope.
20268 for my own use for several reasons:
20271 \begin_layout Itemize
20272 It can generate the documentation either in latex or html.
20275 \begin_layout Itemize
20276 It has a open architecture, i.e., it is easy to plug in new filters and to
20277 perform special processing that you may need.
20281 \begin_layout Itemize
20282 There is a good selection of filters available already (the html is one
20286 \begin_layout Itemize
20290 \begin_layout Standard
20291 The Noweb web page can be found at:
20294 \begin_layout Quote
20295 \begin_inset LatexCommand \url[Noweb home page]{http://www.cs.virginia.edu/~nr/noweb/}
20302 \begin_layout Standard
20303 Starting from there you can reach many other interesting links and even
20304 some literate program examples.
20307 \begin_layout Subsection
20308 LyX and Literate Programming
20311 \begin_layout Standard
20312 The LyX support for Literate Programming is provided by using the generic
20313 LyX convertors mechanism.
20314 This support is provided in a
20315 \begin_inset Quotes eld
20319 \begin_inset Quotes erd
20322 way, i.e., you will be able to use this new LyX feature with some other literate
20323 programming tool of your choice by just changing your LyX preferences.
20326 \begin_layout Subsubsection
20327 Generating documents and code (weaving and tangling)
20330 \begin_layout Paragraph
20331 Selecting the document class
20334 \begin_layout Standard
20335 If you have installed Noweb and LyX successfully, whenever you open a new
20336 document or try to change the document class of an existing one, you will
20337 find that there are three new document classes available:
20340 \begin_layout Itemize
20344 \begin_layout Itemize
20348 \begin_layout Itemize
20352 \begin_layout Standard
20353 You must select one of them to create your literate documents from.
20357 \begin_layout Standard
20358 Note that literate documents are not limited to these three classes.
20359 New classes can be generated from other styles like letter or in combination
20360 with other class variations like Article (AMS).
20361 If you have special needs that cannot be covered by one of the existing
20362 classes, let the LyX developers list (lyx-devel@lists.lyx.org) know and we
20363 will arrange to insert a new entry, or teach you how to do it.
20367 \begin_layout Standard
20368 It is very simple, it involves the creation of a file with four lines, and
20369 re-running of the auto configuration.
20374 Moreover, if you use a literate tool other than Noweb you may need to create
20375 a new set of document classes for it.
20378 \begin_layout Paragraph
20382 \begin_layout Standard
20383 LyX enables you to write code with a layout named
20391 \begin_layout Standard
20392 The equivalent Noweb term is
20393 \begin_inset Quotes eld
20397 \begin_inset Quotes erd
20401 For historical reasons, I got used to the term
20402 \begin_inset Quotes eld
20406 \begin_inset Quotes erd
20409 introduced by other literate tool named Nuweb, which I used for many years
20410 before rendering myself to Noweb.
20415 Noweb delimits scraps like this:
20418 \begin_layout LyX-Code
20422 \begin_layout LyX-Code
20426 \begin_layout LyX-Code
20430 \begin_layout LyX-Code
20434 \begin_layout LyX-Code
20438 \begin_layout Standard
20439 The problem is that whatever is written in between the << and the
20443 must be taken literally, i.e., LyX should be prevented from making any special
20444 interpretation of what has been written.
20445 This is handled by a special layout named Scrap, that works like a normal
20446 paragraph but has a free spacing capability.
20449 \begin_layout Standard
20450 The down side of the Scrap paragraph layout is that consecutive paragraphs
20451 of code will be spaced with one empty line in the source code and also
20452 in the printed documentation.
20453 The work around is to enter each line of code within a single Scrap, with
20454 a newline (ctrl-return).
20455 The example above will look like this:
20459 \begin_layout Standard
20460 If you have a printed version of this document you will not see any difference
20461 between the previous example and this one.
20469 \begin_layout LyX-Code
20481 \begin_layout Standard
20482 This layout works fine.
20483 The only real inconvenience is that you have to type ctrl-return instead
20488 \begin_layout Standard
20489 It is in my list of
20490 \begin_inset Quotes eld
20494 \begin_inset Quotes erd
20505 \begin_layout Standard
20506 As a special note, you can also use the
20507 \begin_inset Quotes eld
20511 \begin_inset Quotes erd
20514 construct of Noweb in your scraps to add items to Noweb's identifier cross-refe
20518 \begin_layout LyX-Code
20521 def some_function(args):
20523 "This is the doc string for this
20526 print "My args: ", args
20529 \begin_layout LyX-Code
20530 @ %def some_function
20533 \begin_layout Standard
20534 For an example of this usage and the resulting cross-reference output, look
20535 at the Literate python program in
20537 LIBDIR/examples/listerrors.lyx
20539 which should make this all clear.
20542 \begin_layout Paragraph
20543 Generating the documentation
20546 \begin_layout Standard
20547 At this point you already have a new document file with a proper document
20548 class, and with some code and text on it.
20549 How do I print it? The answer is simple, you select
20554 iew\SpecialChar \menuseparator
20562 Just like you would do for a plain document.
20563 No special procedure is required.
20566 \begin_layout Standard
20567 To help orientate you, I will now explain what happens inside LyX:
20570 \begin_layout Enumerate
20576 pdate\SpecialChar \menuseparator
20583 menu option is chosen, a latex file is generated.
20588 \begin_layout Standard
20589 If the document is of any literate class the generated file will be named
20590 with an extension name defined by the
20591 \begin_inset Quotes eld
20595 \begin_inset Quotes erd
20598 format (defined in the Preferences panel), otherwise the file will have
20607 \begin_layout Enumerate
20608 Note that the only difference so far is in the name of the file, no special
20609 processing is required by LyX.
20610 Given that you formatted the code using the Scrap layout that, by itself,
20611 takes care of the business.
20614 \begin_layout Enumerate
20615 If the document is of any literate class LyX will then use the internal
20616 LyX to Noweb converter, followed by the Noweb to LaTeX converter
20620 \begin_layout Standard
20621 The converters are defined in the
20626 ools\SpecialChar \menuseparator
20634 \begin_inset Quotes eld
20638 \begin_inset Quotes erd
20646 to generate the LaTeX file.
20650 \begin_layout Standard
20651 Otherwise it will just skip this step.
20655 \begin_layout Enumerate
20656 Finally, LaTeX is invoked and the regular post processing continues as in
20660 \begin_layout Standard
20661 Independence from a particular
20662 \begin_inset Quotes eld
20666 \begin_inset Quotes erd
20669 is easily achieved by changing the commands that are run by the various
20673 \begin_layout Paragraph
20674 Generating the code
20677 \begin_layout Standard
20678 When the build menu option is chosen or the corresponding button in the
20679 toolbar is pressed, a latex file is generated just like step 1 above.
20680 Next, LyX invokes the
20685 Typically, this converter (like any other converter), has two parts:
20688 \begin_layout Enumerate
20689 The converter program itself.
20690 This program performs the conversion from the one format to the other (in
20691 this case, from the Noweb format to the Program pseudo-format).
20694 \begin_layout Enumerate
20695 The error log parser.
20696 This is a program whose sole purpose is to rewrite error messages in a
20697 format that LyX understands.
20698 This makes it possible for LyX to place error boxes in the right places
20699 in the file buffer.
20702 \begin_layout Standard
20703 The first part, the
20704 \begin_inset Quotes eld
20708 \begin_inset Quotes erd
20711 setting, should be set to
20712 \begin_inset Quotes eld
20720 \begin_inset Quotes erd
20724 This basically means that LyX will call
20725 \begin_inset Quotes eld
20729 \begin_inset Quotes erd
20732 (a program or script) with the name of the Noweb file (generally a file
20733 in the LyX temp directory).
20737 \begin_layout Standard
20738 This is an implementation of
20739 \begin_inset Quotes eld
20743 \begin_inset Quotes erd
20746 that you can place in a directory on your path:
20749 \begin_layout LyX-Code
20753 \begin_layout LyX-Code
20757 \begin_layout LyX-Code
20758 notangle -Rbuild-script $1 | env NOWEB_SOURCE=$1 sh
20761 \begin_layout Standard
20762 The next part of the converter setting is the
20763 \begin_inset Quotes eld
20767 \begin_inset Quotes erd
20770 which is to be set to
20771 \begin_inset Quotes eld
20776 originaldir,parselog=listerrors
20779 \begin_inset Quotes erd
20783 This will run any errors that are generated by the
20784 \begin_inset Quotes eld
20788 \begin_inset Quotes erd
20791 process through the
20792 \begin_inset Quotes eld
20796 \begin_inset Quotes erd
20802 \begin_layout Standard
20803 The converter code looks in
20811 then on the path for the
20812 \begin_inset Quotes eld
20816 \begin_inset Quotes erd
20822 \begin_layout Paragraph
20823 Build instructions in the document
20826 \begin_layout Standard
20827 The last piece of the integration between LyX and noweb is the
20828 \begin_inset Quotes eld
20832 \begin_inset Quotes erd
20836 Generally, the instructions for building your program should be embedded
20837 in a scrap of its own.
20839 \begin_inset Quotes eld
20843 \begin_inset Quotes erd
20846 above uses the notangle command to look for this scrap (called
20847 \begin_inset Quotes eld
20851 \begin_inset Quotes erd
20854 ) and runs its contents through
20855 \begin_inset Quotes eld
20859 \begin_inset Quotes erd
20865 \begin_layout Standard
20866 Typically, such a scrap would look something like this:
20869 \begin_layout LyX-Code
20876 if [ -z "${NOWEB_SOURCE}" ]
20880 NOWEB_SOURCE=myfile.nw
20886 code to extract files ...]
20889 code to compile files ...]
20894 \begin_layout Standard
20897 LIBDIR/examples/listerrors.lyx
20901 LIBDIR/examples/Literate.lyx
20903 which implement two versions of the
20904 \begin_inset Quotes eld
20908 \begin_inset Quotes erd
20911 program for some illustrations of how all of these pieces go together or
20914 LIBDIR/examples/noweb2lyx.lyx.
20917 Interestingly, these three files show off the language-indepence of the
20918 LyX literate programming support since they are written in Python, C and
20922 \begin_layout Subsubsection
20926 \begin_layout Standard
20927 All the Literate Programming support is configured by the
20932 ools\SpecialChar \menuseparator
20940 \begin_inset Quotes eld
20944 \begin_inset Quotes erd
20948 The important parts are:
20951 \begin_layout Description
20954 \begin_inset Quotes eld
20958 \begin_inset Quotes erd
20962 format Set up via the Formats tab, this is where the Noweb-specific pieces
20972 , the file extension is set to
20977 This tells LyX to create a file with a
20981 extension in the first step of the conversion process.
20984 \begin_layout Description
20991 format This is an empty format whose sole purpose is to be the endpoint
20992 of a conversion (which then allows us to set up a converter for it).
20995 \begin_layout Description
21004 This converter performs the
21005 \begin_inset Quotes eld
21009 \begin_inset Quotes erd
21012 of the literate document.
21013 For Noweb, it is set to
21014 \begin_inset Quotes eld
21019 noweave -delay -index $$i > $$o
21022 \begin_inset Quotes erd
21028 \begin_layout Description
21038 \begin_inset Quotes eld
21042 \begin_inset Quotes erd
21046 As stated above, the Converter is set to
21047 \begin_inset Quotes eld
21055 \begin_inset Quotes erd
21058 , with Flags set to
21059 \begin_inset Quotes eld
21064 originaldir,parselog=listerrors
21067 \begin_inset Quotes erd
21073 \begin_layout Subsubsection
21077 \begin_layout Standard
21078 There is also a new function implemented in the LyX server, the
21079 \begin_inset Quotes eld
21082 server-goto-file-row" function, to be used with ddd/gdb or other debugger.
21086 \begin_layout Standard
21087 When debugging code with ddd/gdb, it is possible to invoke a text editor
21088 at the current execution position with a single key stroke.
21089 The default ddd configuration for that is shift-ctrl-V.
21090 It happens that you can define the editor command line invocation in ddd
21097 dit\SpecialChar \menuseparator
21102 references\SpecialChar \menuseparator
21109 dialog and changing the "Edit Sources" entry.
21112 \begin_layout Standard
21113 I take advantage of the new created LyX server function and this ddd feature,
21115 \begin_inset Quotes eld
21119 \begin_inset Quotes erd
21125 \begin_layout LyX-Code
21126 echo "LYXCMD:monitor:server-goto-file-row:@FILE@ @LINE@" >~/.lyxpipe.in
21129 \begin_layout Standard
21130 With this, whenever you are using ddd and find a point in the program that
21131 you want to edit, you just press shift-ctrl-V (in the ddd window), and
21132 ddd you forward this information to LyX through the LyX server and then
21133 the LyX window will show the same file with the cursor at the same position
21134 ddd was pointing to.
21135 No more guessing or long scrolling to locate a point in the program back
21139 \begin_layout Standard
21140 Note however that you must enable the LyX server to get this feature working
21141 (it is disabled by default).
21142 You can enable it in
21154 ) by entering in the
21159 \begin_inset Quotes eld
21164 /home/<your-home-directory>/.lyx/lyxpipe
21167 \begin_inset Quotes erd
21173 \begin_layout Standard
21174 Read the LyX server documentation in the
21176 Customization Manual
21178 for further information.
21181 \begin_layout Subsubsection
21185 \begin_layout Standard
21186 There are six new buttons that can be added to your LyX toolbar.
21187 Five of these buttons are short cuts to layout styles:
21208 The last one is a short cut to the
21209 \begin_inset Quotes eld
21213 \begin_inset Quotes erd
21220 \begin_layout Standard
21221 LyX has a range of buttons that are available for tool bar customization.
21222 In my toolbar I like to combine the six short cuts above with two more:
21230 \SpecialChar \menuseparator
21238 \SpecialChar \menuseparator
21251 iew\SpecialChar \menuseparator
21259 Here is how it looks like:
21262 \begin_layout LyX-Code
21266 \begin_layout LyX-Code
21270 \begin_layout LyX-Code
21271 Icon "layout Standard"
21274 \begin_layout LyX-Code
21275 Icon "layout Section"
21278 \begin_layout LyX-Code
21279 Icon "layout LaTeX"
21282 \begin_layout LyX-Code
21283 Icon "layout LyX-Code"
21286 \begin_layout LyX-Code
21287 Icon "layout Scrap"
21290 \begin_layout LyX-Code
21294 \begin_layout LyX-Code
21298 \begin_layout LyX-Code
21299 Icon "buffer-typeset"
21302 \begin_layout LyX-Code
21303 Icon "build-program"
21306 \begin_layout LyX-Code
21310 \begin_layout LyX-Code
21314 \begin_layout LyX-Code
21318 \begin_layout LyX-Code
21322 \begin_layout LyX-Code
21326 \begin_layout Subsubsection
21327 Colors customization
21330 \begin_layout Standard
21331 There are a number of colors in LyX that can be customized in
21336 One of the things that bothers people is the LaTeX font color.
21337 The default color is red, since the scraps uses LaTeX font, and there is
21338 a lot of scraps in literate documents, you may get tired of seeing everything
21340 You can change it by going to the tabs
21349 \begin_layout Standard
21350 The next thing is the visible presence of the newline character in the screen.
21351 You can choose the color of this particular character and make it blend
21353 I recommend you choosing a color that is close to the background but not
21354 equal, that way you still can see it is there, but it is not bothering
21359 \begin_layout Chapter
21360 Secrets of the LaTeX Masters
21361 \begin_inset LatexCommand \label{cha:secrets}
21368 \begin_layout Standard
21369 Though LyX is a powerful tool, it cannot hope to support everything that
21370 can be done with pure TeX/LaTeX.
21371 However, many familiar dirty TeX and LaTeX tricks can be done within LyX,
21372 as long as you are not afraid to use that
21373 \begin_inset Quotes eld
21377 \begin_inset Quotes erd
21380 button on the toolbar or add things to the LaTeX preamble.
21381 This section lists some tips, tricks, and otherwise cool ideas to give
21382 your document that extra little flair.
21385 Do try this at home
21387 , just start with something a little smaller and less important than your
21391 \begin_layout Standard
21392 Most ideas in this section require less common files in your LaTeX installation.
21393 If you have a system like teTeX, most will already be available.
21394 A few, however, will need to be downloaded from one of the CTAN archives.
21395 Often, there are several ways to do something, or several LaTeX style files
21396 which do the same thing.
21397 We do not endorse one choice over another, we simply claim that we have
21398 done a particular task with a particular file.
21399 Put on your wizard hat, keep an eye out for dragons, and let us begin.
21402 \begin_layout Section
21403 Tricks for Footnotes and Margin Notes
21406 \begin_layout Standard
21412 \begin_layout Subsection
21416 \begin_layout Standard
21417 LyX cannot yet take care of setting the footnote numbering back to 1 after
21418 each section in the
21419 \begin_inset Quotes eld
21427 \begin_inset Quotes erd
21432 document class or changing the counter style.
21433 You'll need to insert LaTeX commands like the following to achieve that:
21436 \begin_layout Standard
21440 \begin_layout Standard
21443 setcounter{footnote}{0}
21452 setcounter{footnote}{0}
21454 will set the counter back to 1
21458 \begin_layout Standard
21459 The counter has been set back to 1.
21467 \begin_layout Standard
21468 The following command will change the numbering to small letters.
21469 Take a look at the next footnote in your xdvi or ghostview
21473 \begin_layout Standard
21489 \begin_layout Standard
21490 This is an example for a footnote with alphabetic numbering.
21510 \begin_layout Standard
21511 The next command sets the counter style back to default, i.e.
21522 \begin_layout Standard
21533 to set the counter--style back to LyX's default, i.e.
21542 \begin_layout Standard
21562 \begin_layout Standard
21593 and others as counter styles.
21594 Just replace the LaTeX command in the above example and rerun TeX to see
21595 what those styles can do.
21599 \begin_layout Subsection
21603 \begin_layout Standard
21604 Here are two examples of neat things you can do to margin notes using LaTeX
21608 \begin_layout Standard
21609 The following command will make a vertical line appear alongside your text---gre
21611 \begin_inset Quotes eld
21615 \begin_inset Quotes erd
21624 rule[-10mm]{30mm}{5mm}}
21632 \begin_layout Standard
21637 rule[-10mm]{30mm}{5mm}}
21645 \begin_layout Standard
21646 Check your dvi- or ghostview-output to see what the
21652 command does to the following margin note.
21655 \begin_layout Standard
21659 \begin_layout Standard
21668 \begin_inset Marginal
21671 \begin_layout Standard
21682 \begin_layout Section
21686 \begin_layout Standard
21689 Lars Gullik Bjønnes
21692 \begin_layout Subsection
21696 \begin_layout Standard
21697 The aim for this chapter
21701 \begin_layout Standard
21702 Editor's note: Lars' original chapter was a masterful description of how
21708 However, it was too long to flow smoothly in this document.
21709 I have therefore chosen to excerpt the most important sections here (sorry,
21710 Lars); you can read the original chapter (and more of the story!) in the
21713 examples/multicol.lyx
21721 is to show how the LaTeX package
21725 can be used in a LyX document.
21726 As LyX doesn't support the
21730 package natively yet, we have to use some small hacks.
21731 By reading this section it should be obvious how to do this.
21734 \begin_layout Subsection
21738 \begin_layout Standard
21743 package allows switching between one and multicolumn format on the same
21745 Footnotes are handled correctly (for the most part), but will be placed
21746 at the bottom of the page and not under each column.
21747 LaTeX's float mechanism, however, is partly disabled in the current implementat
21749 At the moment only page-wide floats can be used within the scope of the
21753 \begin_layout Subsection
21757 \begin_layout Subsubsection
21761 \begin_layout Standard
21762 If you want to have two columns in your text, you have use LaTeX mode to
21767 begin{multicols}{2}
21769 at the point where you want the two column layout to start, and then
21775 where you want it to end.
21779 \begin_layout Standard
21783 \begin_layout Standard
21786 begin{multicols}{2}
21794 \begin_layout Standard
21799 The Adventure of the Empty House
21805 Sir Arthur Conan Doyle
21808 \begin_layout Standard
21811 It was in the spring of the year 1894 that all London was interested, and
21812 the fashionable world dismayed, by the murder of the Honourable Ronald
21813 Adair under most unusual and inexplicable circumstances.
21814 The public has already learned those particulars of the crime which came
21815 out in the police investigation, but a good deal was suppressed upon that
21816 occasion, since the case for the prosecution was so overwhelmingly strong
21817 that it was not necessary to bring forward all the facts.
21818 Only now, at the end of nearly ten years, am I allowed to supply those
21819 missing links which make up the whole of that remarkable chain.
21820 The crime was of interest in itself, but that interest was as nothing to
21821 me compared to the inconceivable sequel, which afforded me the greatest
21822 shock and surprise of any event in my adventurous life.
21823 Even now, after this long interval, I find myself thrilling as I think
21824 of it, and feeling once more that sudden flood of joy, amazement, and increduli
21825 ty which utterly submerged my mind.
21826 Let me say to that public, which has shown some interest in those glimpses
21827 which I have occasionally given them of the thoughts and actions of a very
21828 remarkable man, that they are not to blame me if I have not shared my knowledge
21829 with them, for I should have considered it my first duty to do so, had
21830 I not been barred by a positive prohibition from his own lips, which was
21831 only withdrawn upon the third of last month.
21834 \begin_layout Standard
21838 \begin_layout Standard
21849 \begin_layout Subsubsection
21853 \begin_layout Standard
21854 The same pattern is used when you want more than two columns:
21857 \begin_layout Standard
21861 \begin_layout Standard
21864 begin{multicols}{3}
21872 \begin_layout Standard
21875 It can be imagined that my close intimacy with Sherlock Holmes had interested
21876 me deeply in crime, and that after his disappearance I never failed to
21877 read with care the various problems which came before the public.
21878 And I even attempted, more than once, for my own private satisfaction,
21879 to employ his methods in their solution, though with indifferent success.
21880 There was none, however, which appealed to me like this tragedy of Ronald
21882 As I read the evidence at the inquest, which led up to a verdict of willful
21883 murder against some person or persons unknown, I realized more clearly
21884 than I had ever done the loss which the community had sustained by the
21885 death of Sherlock Holmes.
21886 There were points about this strange business which would, I was sure,
21887 have specially appealed to him, and the efforts of the police would have
21888 been supplemented, or more probably anticipated, by the trained observation
21889 and the alert mind of the first criminal agent in Europe.
21890 All day, as I drove upon my round, I turned over the case in my mind and
21891 found no explanation which appeared to me to be adequate.
21892 At the risk of telling a twice-told tale, I will recapitulate the facts
21893 as they were known to the public at the conclusion of the inquest.
21896 \begin_layout Standard
21900 \begin_layout Standard
21911 \begin_layout Standard
21912 You can have have more than 3 columns if you want to, but that might not
21913 be very pleasant for the eye.
21916 \begin_layout Subsubsection
21917 Columns inside columns
21920 \begin_layout Standard
21921 You can even have columns inside columns:
21924 \begin_layout Standard
21928 \begin_layout Standard
21931 begin{multicols}{2}
21939 \begin_layout Standard
21942 The Honourable Ronald Adair was the second son of the Earl of Maynooth,
21943 at that time governor of one of the Australian colonies.
21944 Adair's mother had returned from Australia to undergo the operation for
21945 cataract, and she, her son Ronald, and her daughter Hilda were living together
21949 \begin_layout Standard
21953 \begin_layout Standard
21956 begin{multicols}{2}
21964 \begin_layout Standard
21967 The youth moved in the best society--had, so far as was known, no enemies
21968 and no particular vices.
21969 He had been engaged to Miss Edith Woodley, of Carstairs, but the engagement
21970 had been broken off by mutual consent some months before, and there was
21971 no sign that it had left any very profound feeling behind it.
21972 For the rest {sic} the man's life moved in a narrow and conventional circle,
21973 for his habits were quiet and his nature unemotional.
21974 Yet it was upon this easy-going young aristocrat that death came, in most
21975 strange and unexpected form, between the hours of ten and eleven-twenty
21976 on the night of March 30, 1894.
21979 \begin_layout Standard
21983 \begin_layout Standard
21994 \begin_layout Standard
21997 Ronald Adair was fond of cards--playing continually, but never for such
21998 stakes as would hurt him.
21999 He was a member of the Baldwin, the Cavendish, and the Bagatelle card clubs.
22000 It was shown that, after dinner on the day of his death, he had played
22001 a rubber of whist at the latter club.
22002 He had also played there in the afternoon.
22007 The evidence of those who had played with him-- Mr.
22008 Murray, Sir John Hardy, and Colonel Moran--showed that the game was whist,
22009 and that there was a fairly equal fall of the cards.
22010 Adair might have lost five pounds, but not more.
22011 His fortune was a considerable one, and such a loss could not in any way
22013 He had played nearly every day at one club or other, but he was a cautious
22014 player, and usually rose a winner.
22015 It came out in evidence that, in partnership with Colonel Moran, he had
22016 actually won as much as four hundred and twenty pounds in a sitting, some
22017 weeks before, from Godfrey Milner and Lord Balmoral.
22018 So much for his recent history as it came out at the inquest.
22021 \begin_layout Standard
22025 \begin_layout Standard
22036 \begin_layout Standard
22037 Please do read the file
22039 examples/multicol.lyx
22041 for more advanced examples including column and header spacing, vertical
22042 separator lines, and more.
22045 \begin_layout Section
22050 Paragraph Environment
22051 \begin_inset OptArg
22054 \begin_layout Standard
22055 Numbering in Enumerate
22063 \begin_layout Standard
22069 \begin_layout Standard
22070 \begin_inset VSpace bigskip
22076 \begin_layout Standard
22078 The default numbering for the
22082 paragraph environment begins with Arabic numbers and ends with uppercase
22084 Suppose, however, you wanted a different type of numbering scheme.
22085 Here's a quickie example of how to change the numbering scheme:
22088 \begin_layout LyX-Code
22098 \begin_layout LyX-Code
22108 \begin_layout LyX-Code
22118 \begin_layout LyX-Code
22128 \begin_layout Standard
22129 \SpecialChar \ldots{}
22130 which changes the numbering scheme to uppercase Roman numerals, uppercase
22131 letters, Arabic numbers, and lowercase letter.
22134 \begin_layout Standard
22135 Additionally, the previous example also adds a little bit extra to the numbering
22137 For example, the first level label actually looks like:
22138 \begin_inset Quotes eld
22142 \begin_inset Quotes erd
22146 For ease of reading, we'll describe what the numbering schemes look like
22147 using a notation something like this: <
22148 \begin_inset Quotes eld
22152 \begin_inset Quotes erd
22157 \begin_inset Quotes erd
22161 \begin_inset Quotes erd
22166 \begin_inset Quotes erd
22170 \begin_inset Quotes erd
22175 \begin_inset Quotes eld
22179 \begin_inset Quotes erd
22186 \begin_layout Standard
22187 As you can see in the example, there is a label command for each nesting
22194 \SpecialChar \ldots{}
22201 , as well as a counter,
22205 \SpecialChar \ldots{}
22211 There are also five
22212 \begin_inset Quotes eld
22216 \begin_inset Quotes erd
22249 , each of which take one counter as an argument.
22250 You can add characters before or after these, but there's no need to add
22254 \begin_layout Standard
22255 You can get really fancy with these.
22259 \begin_layout LyX-Code
22273 \begin_layout LyX-Code
22285 \begin_layout LyX-Code
22295 \begin_layout LyX-Code
22305 \begin_layout Standard
22306 produces the somewhat out of hand numbering scheme: <
22307 \begin_inset Quotes eld
22311 \begin_inset Quotes erd
22316 \begin_inset Quotes erd
22320 \begin_inset Quotes erd
22325 \begin_inset Quotes erd
22329 \begin_inset Quotes erd
22334 \begin_inset Quotes eld
22338 \begin_inset Quotes erd
22345 \begin_layout Section
22346 Extra Space Between Table Rows
22349 \begin_layout Standard
22355 \begin_layout Standard
22356 \begin_inset VSpace bigskip
22362 \begin_layout Standard
22364 LaTeX allows you to put a bit of extra space between rows in a table by
22365 giving an optional argument to the end-of-row specifier (
22374 LyX has not yet implemented this in a formal way, so here are two dirty
22375 little tricks to do the same job.
22379 \begin_layout Standard
22380 The first is the more formal, but longwinded way to do it.
22381 In the LaTeX preamble, add the following command definition:
22384 \begin_layout Standard
22391 extratablespace}[1]{
22395 This command takes a single argument---the amount of space you would like
22397 Insert the command in the first column of the row
22401 where you would like the space to appear.
22402 Here is an example (I've removed all the borders using
22407 ayout\SpecialChar \menuseparator
22416 \begin_layout Standard
22418 \begin_inset Tabular
22419 <lyxtabular version="3" rows="4" columns="3">
22421 <column alignment="center" valignment="top" width="0pt">
22422 <column alignment="center" valignment="top" width="0pt">
22423 <column alignment="center" valignment="top" width="0pt">
22425 <cell alignment="center" valignment="top" topline="true" usebox="none">
22428 \begin_layout Standard
22443 <cell alignment="center" valignment="top" topline="true" usebox="none">
22446 \begin_layout Standard
22461 <cell alignment="center" valignment="top" topline="true" usebox="none">
22464 \begin_layout Standard
22481 <cell alignment="center" valignment="top" topline="true" usebox="none">
22484 \begin_layout Standard
22490 <cell alignment="center" valignment="top" topline="true" usebox="none">
22493 \begin_layout Standard
22508 <cell alignment="center" valignment="top" topline="true" usebox="none">
22511 \begin_layout Standard
22528 <cell alignment="center" valignment="top" topline="true" usebox="none">
22531 \begin_layout Standard
22544 \begin_layout Standard
22547 extratablespace{2ex}
22557 <cell alignment="center" valignment="top" topline="true" usebox="none">
22560 \begin_layout Standard
22575 <cell alignment="center" valignment="top" topline="true" usebox="none">
22578 \begin_layout Standard
22595 <cell alignment="center" valignment="top" topline="true" usebox="none">
22598 \begin_layout Standard
22604 <cell alignment="center" valignment="top" topline="true" usebox="none">
22607 \begin_layout Standard
22622 <cell alignment="center" valignment="top" topline="true" usebox="none">
22625 \begin_layout Standard
22648 \begin_layout Standard
22649 The second method is faster, but will make typographers and TeXperts all
22650 over the world groan.
22651 Simply put an end of row specifier with optional argument at the same spot.
22652 No fancy definitions are needed as in the above example, but there will
22653 be more space inserted than you specified because you essentially added
22654 a blank row plus the extra space.
22655 If the space added is too much, simply use a negative number, like so:
22658 \begin_layout Standard
22660 \begin_inset Tabular
22661 <lyxtabular version="3" rows="4" columns="3">
22663 <column alignment="center" valignment="top" width="0pt">
22664 <column alignment="center" valignment="top" width="0pt">
22665 <column alignment="center" valignment="top" width="0pt">
22667 <cell alignment="center" valignment="top" topline="true" usebox="none">
22670 \begin_layout Standard
22685 <cell alignment="center" valignment="top" topline="true" usebox="none">
22688 \begin_layout Standard
22703 <cell alignment="center" valignment="top" topline="true" usebox="none">
22706 \begin_layout Standard
22723 <cell alignment="center" valignment="top" topline="true" usebox="none">
22726 \begin_layout Standard
22732 <cell alignment="center" valignment="top" topline="true" usebox="none">
22735 \begin_layout Standard
22750 <cell alignment="center" valignment="top" topline="true" usebox="none">
22753 \begin_layout Standard
22770 <cell alignment="center" valignment="top" topline="true" usebox="none">
22773 \begin_layout Standard
22786 \begin_layout Standard
22801 <cell alignment="center" valignment="top" topline="true" usebox="none">
22804 \begin_layout Standard
22819 <cell alignment="center" valignment="top" topline="true" usebox="none">
22822 \begin_layout Standard
22839 <cell alignment="center" valignment="top" topline="true" usebox="none">
22842 \begin_layout Standard
22848 <cell alignment="center" valignment="top" topline="true" usebox="none">
22851 \begin_layout Standard
22866 <cell alignment="center" valignment="top" topline="true" usebox="none">
22869 \begin_layout Standard
22892 \begin_layout Standard
22893 It's short, sweet, and gets the job done quickly, even if it is really ugly.
22894 You may put away the rotten vegetables now! I promise I won't suggest anything
22898 \begin_layout Section
22902 \begin_layout Standard
22908 \begin_layout Standard
22909 \begin_inset VSpace bigskip
22915 \begin_layout Standard
22920 \begin_layout Standard
22925 tmpfont}{cmr17 scaled 2500}{
22937 \begin_layout Standard
22942 \begin_layout Standard
22952 hose of you who like the style of old books probably also like
22953 \begin_inset Quotes eld
22957 \begin_inset Quotes erd
22960 ---those large capital letters which begin each new chapter or section.
22961 Implementing them with plain LyX/LaTeX is straightforward (assuming you
22962 know some plain TeX!) but does require a lot of work and many iterations,
22963 as you can see by all the ugly TeX-mode stuff at the beginning of this
22967 \begin_layout Standard
22971 \begin_layout Standard
22976 bigdrop{-1em}{3}{ptmri}{T}+
22981 here is a much easier way of doing this, of course.
22990 ) package from CTAN allows a simple way to add such letters to your documents.
22991 Since this package is not a standard part of teTeX, I can't demonstrate
22992 it within this document, but if you copy this paragraph to a new document,
22994 \begin_inset Quotes eld
23004 \begin_inset Quotes erd
23007 and the pluses from the TeX code at the beginning of the paragraph, and
23012 usepackage{dropcaps}
23014 to your LaTeX preamble, you will get a nice Times Roman Italic
23015 \begin_inset Quotes eld
23019 \begin_inset Quotes erd
23022 , whose height is three lines of text and which protrudes 1 em into the
23024 (Make certain you have copied
23025 \begin_inset Quotes eld
23033 \begin_inset Quotes erd
23036 into a directory where TeX can see it.) The first argument is the amount
23037 of indentation; in this case the negative sign moves it into the margin.
23038 The second argument is the height of the letter in number of lines of text.
23039 The third argument is the font name: virtually anything which has a tfm
23040 file should work (wade through the
23042 .../texmf/fonts/tfm
23044 directory for possibilities).
23045 My personal favorite is
23046 \begin_inset Quotes eld
23054 \begin_inset Quotes erd
23057 , a fancy German font specifically designed for dropped capitals.
23058 The fourth argument is the letter (or letters) to be dropped.
23063 package also offers the
23069 command, as well as a slightly simplified
23078 \begin_layout Section
23079 Non-standard Paragraph Shapes
23082 \begin_layout Standard
23088 \begin_layout Standard
23089 \begin_inset VSpace bigskip
23095 \begin_layout Standard
23099 \begin_layout Standard
23110 \begin_layout Standard
23114 \begin_layout Standard
23122 \begin_layout Standard
23135 \begin_layout Standard
23140 \begin_layout Standard
23150 \begin_layout Standard
23158 \begin_layout Standard
23166 \begin_layout Standard
23174 \begin_layout Standard
23182 \begin_layout Standard
23190 \begin_layout Standard
23198 \begin_layout Standard
23206 \begin_layout Standard
23214 \begin_layout Standard
23222 \begin_layout Standard
23230 \begin_layout Standard
23238 \begin_layout Standard
23246 \begin_layout Standard
23254 \begin_layout Standard
23262 \begin_layout Standard
23270 \begin_layout Standard
23278 \begin_layout Standard
23286 \begin_layout Standard
23294 \begin_layout Standard
23300 There are times when the tyranny of rectangular paragraphs must be overthrown.
23301 In such situations, a call to the delightful plain TeX command
23308 As you can see, completely arbitrary shapes can be laid out with a suitable
23309 set of linelength definitions.
23310 While this parshape may look a bit silly and useless, one could conceive
23311 of situations such as finely tuned dropped capitals, word wrapping around
23312 non-rectangular graphics, etc.
23313 which will benefit from such handcrafting.
23316 \begin_layout Standard
23317 \begin_inset VSpace bigskip
23323 \begin_layout Standard
23328 parshape numlines #1indent #1length #2indent #2length \SpecialChar \ldots{}
23335 is the number of lines of text which define the paragraph.
23336 If there turn out to be fewer lines, the shape is truncated; if there are
23337 more, the excess lines have the same dimensions as the last line of the
23347 entries specify the indentation of the line from the left margin, and the
23348 length of the line as measured from that point.
23349 The shape applies only to the current paragraph; everything is reset to
23350 normal for the next paragraph.
23353 \begin_layout Standard
23357 \begin_layout Standard
23368 \begin_layout Section
23372 \begin_layout Standard
23373 As you can see, the examples in this section range from the useful to the
23375 While I don't expect that anyone will ever need the paragraph shape demonstrate
23376 d in the last section, the important point is that you can do almost anything
23377 you want in LyX if you are willing to figure out how to do it in TeX and
23379 TeX is a fantastically powerful typesetting system and all that power is
23380 available to you since LyX uses it as its backend.