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
30 \paperpagestyle headings
31 \tracking_changes false
46 \begin_layout Standard
48 Principal maintainer of this file is
53 If you have comments or error corrections, please send them to the LyX
54 Documentation mailing list, <lyx-docs@lists.lyx.org>.
62 \begin_layout Standard
63 \begin_inset LatexCommand \tableofcontents{}
74 \begin_layout Standard
79 manual, which you are now reading, is essentially Part II of the
81 User's Guide\SpecialChar \@.
84 The reason for splitting this document is simple: the
88 is already huge, and it contains all of the basic features one needs to
89 know in order to prepare most documents.
90 However, the LyX Team has a long-term goal of making LyX extensible through
91 various configuration files and external packages.
92 That means that if you want to support the Fizzwizzle LaTeX package, you
93 can create a layout file for it without having to alter LyX itself.
94 We've already had contributions of several new features this way.
95 This is the place where all of that gets documented.
98 \begin_layout Standard
99 This manual also documents some special features, like fax support, version
100 control, and SGML support, which require additional software to work properly.
101 Lastly, there's a chapter of LaTeX tools and tips, things you can use to
102 spruce up your documents by directly using the powerful features of LaTeX.
107 only WYSIWYM, and will only ever interface to certain LaTeX features.
110 \begin_layout Standard
111 Of course, with all of this extra documentation,
113 Extended LyX Features
115 may itself grow too big for its britches.
116 In that case, you can just call it the
117 \begin_inset Quotes eld
121 \begin_inset Quotes erd
127 \begin_layout Standard
128 If you haven't read the
132 yet, you are definitely in the wrong manual.
137 is the first place to go, since it will direct you to the correct manual,
138 and it also describes the notation and format of all of the manuals.
139 You should also be thoroughly familiar with the
143 and all of the basic features of LyX.
147 \begin_layout Standard
148 In this document, many sections are independent articles contributed by
149 an individual and are noted as such.
150 This person is generally whoever wrote the layout file for the new document
151 class or LaTeX package, or implemented the feature.
152 If there is no mention of an author to a chapter [or chapter sections],
153 that means it was written by the LyX Documentation Team.
156 \begin_layout Standard
157 Since all the topics in this manual depend heavily on LyX's interaction
158 with LaTeX, this first chapter covers
162 the inner workings of LyX and how to direct LyX to generate exactly the
164 It is obviously for more seasoned LyX users.
167 \begin_layout Chapter
171 \begin_layout Section
175 \begin_layout Standard
176 \begin_inset LatexCommand \label{sec:lyxandlatex}
180 This chapter is for both TeX-nicians and the LaTeX-curious.
181 In it, we'll explain how LyX and LaTeX work together to produce printable
183 This is the only place in any of the manuals where we assume you know something
187 \begin_layout Standard
188 At one time, we called LyX a
189 \begin_inset Quotes eld
192 WYSIWYM frontend to LaTeX,
193 \begin_inset Quotes erd
196 but that's no longer true.
197 There are frontends to LaTeX out there.
198 They are basically editors with the ability to run LaTeX and mark any errors
199 in the file you're editing.
208 run LaTeX, and it also marks errors in the file, it also does much, much
210 Thanks to the WYSIWYM concept, you don't need LaTeX to use LyX effectively.
211 LyX has also added a few extensions to LaTeX.
212 Try the following sometime: select
214 Export\SpecialChar \menuseparator
224 menu, then look at the preamble of the resulting
229 You'll notice a variety of new macros defined specifically by LyX.
230 These macros are defined automatically, according to the features you use
234 \begin_layout Standard
235 There are several commands that automatically invoke LaTeX.
239 \begin_layout Itemize
245 iew\SpecialChar \menuseparator
252 \begin_layout Itemize
258 iew\SpecialChar \menuseparator
263 pdate\SpecialChar \menuseparator
269 \begin_layout Itemize
277 \SpecialChar \menuseparator
283 \begin_layout Itemize
291 \SpecialChar \menuseparator
297 \begin_layout Standard
298 They will only invoke LaTeX if the file has changed since the last time
303 \begin_layout Standard
304 When you run LaTeX on the file you're editing, LyX performs these steps:
307 \begin_layout Enumerate
308 Convert the document to LaTeX and save to a file with the extension
319 \begin_layout Enumerate
324 file (maybe several times).
327 \begin_layout Enumerate
328 If there are any errors, insert error boxes in the document to mark where
330 These boxes are transient and are not saved along with the document.
333 \begin_layout Standard
334 If you've run LaTeX using
356 , LyX performs two more steps:
359 \begin_layout Itemize
364 to convert the Dvi file to PostScript®:
368 \begin_layout Itemize
374 , the output file has the extension
379 \begin_layout Itemize
388 , the output file has the extension
396 \begin_layout Itemize
401 or send the PostScript® file to the printer.
404 \begin_layout Section
405 \begin_inset Quotes eld
408 Help! LyX generated an unreadable
413 \begin_inset Quotes erd
419 \begin_layout Standard
420 Die-hard LaTeX users will scream and howl this into the night, then declare
421 LyX useless, simply because they didn't RTFM.
424 \begin_layout Standard
425 We're going to set the record straight.
426 LyX produces two kinds of LaTeX files.
427 One is human readable.
428 The other is LyX readable.
429 Every time LyX executes LaTeX, it produces a LaTeX file that it can easily
435 file is not human readable.
436 Don't even try to read it.
441 file that you can send to a colleague, select
446 xport\SpecialChar \menuseparator
463 \begin_layout Section
464 Translating LaTeX files into LyX
467 \begin_layout Standard
468 You can import a LaTeX file into LyX by using the
473 ile\SpecialChar \menuseparator
478 mport\SpecialChar \menuseparator
486 This will call a Perl script named
490 ---which will create a file
498 ---and then open that file.
499 If the translation doesn't work, you can try calling
503 from the command line, possibly using fancier options.
506 \begin_layout Standard
511 will translate most legal LaTeX, but not everything.
512 It will leave things it doesn't understand in TeX mode, so after translating
517 , you can look for red text and hand-edit it to look right.
520 \begin_layout Standard
525 has its own section in the
529 manual (as well as a Unix manpage equivalent), which you should read to
530 find out about what LaTeX isn't supported, bugs (and how to get around
531 them), and how to use the various options.
534 \begin_layout Standard
539 to work, or you just want to put a piece of LaTeX code into a LyX file,
541 \begin_inset LatexCommand \ref{sec:latexcodes}
548 \begin_layout Section
549 Inserting LaTeX Code into LyX Documents
550 \begin_inset LatexCommand \label{sec:Inserting-LaTeX-Code}
557 \begin_layout Standard
558 \begin_inset LatexCommand \label{sec:latexcodes}
562 This is a rather important point: You can always insert LaTeX code into
564 LyX simply cannot, and will probably never be able to, display every possible
566 If ever you need to insert LaTeX commands into your LyX document, you can
567 use the ERT box, which you can insert into your document with
572 nsert\SpecialChar \menuseparator
580 The ERT box comes in three forms: collapsed, open, and inlined.
581 The first two are used just like any other collapsable (foldable) box (such
582 as footnotes), and are useful for significant amounts of LaTeX commands.
584 \begin_inset Quotes eld
588 \begin_inset Quotes erd
591 ERT box displays its content as part of the button, and is useful for very
592 short sections of LaTeX commands.
597 \begin_layout Standard
606 \begin_layout Standard
607 You can switch between all three by right-clicking on the ERT.
608 Note that if you want more than one line of LaTeX commands, you cannot
609 use the inlined mode.
612 \begin_layout Standard
613 Here's an example of inserting LaTeX commands in a LyX document.
614 The code looks like this:
617 \begin_layout LyX-Code
626 This is an example for a minipage environment.
629 can put nearly everything in it, even (non-floating)
672 \begin_layout LyX-Code
676 \begin_layout Standard
677 The ERT box containing this text is directly after this paragraph.
678 Those of you reading the manual online will only see a bunch of funky text
680 Those reading a printed version of the manuals will see the actual results:
683 \begin_layout Standard
687 \begin_layout Standard
693 \begin_layout Standard
699 \begin_layout Standard
700 This is an example for a minipage environment.
701 You can put nearly everything in it, even (non-floating) figures and tables.
705 \begin_layout Standard
711 \begin_layout Standard
715 \begin_layout Standard
721 \begin_layout Standard
727 \begin_layout Standard
733 \begin_layout Standard
738 \begin_layout Standard
744 \begin_layout Standard
750 \begin_layout Standard
756 \begin_layout Standard
767 \begin_layout Standard
768 In addition to these two methods, you can also create a separate file containing
769 some complex LaTeX structure.
775 nsert\SpecialChar \menuseparator
783 to include your file (you should select the type
788 We recommend that you only do this if you have a
797 Otherwise, you'll have a big job tracking down LaTeX errors\SpecialChar \ldots{}
801 \begin_layout Standard
802 There are a few last notes to emphasize:
805 \begin_layout Itemize
806 Inside of LyX, LaTeX code appears
811 \begin_layout Itemize
816 check if your LaTeX code is correct.
819 \begin_layout Itemize
820 Beware reinventing the wheel.
823 \begin_layout Standard
824 That last note refers to two things.
825 First, LyX does have quite a few features tucked into it, and more are
827 Be sure to check the manuals to make sure that LyX doesn't have such-and-such
828 feature before you go off merrily coding LaTeX.
829 Second, there are numerous LaTeX packages out there to do all sorts of
830 things, from labels to envelopes to fancy multipage tables.
831 Check out a CTAN site for details (see Section
832 \begin_inset Quotes eld
836 \begin_inset Quotes erd
847 \begin_layout Standard
852 : I seem to do this an awful lot.
853 Sat down and merrily began coding something to print out labels, only to
854 learn that there were already 2 different LaTeX packages to do this.
855 Worse yet --- I had them already!
863 \begin_layout Standard
864 If you do need to do some wild and fancy things within your document, be
865 sure to check out a good LaTeX book for assistance.
866 There are a number of them listed in the bibliography of the
873 \begin_layout Standard
874 There are a number of LaTeX commands which have to be placed before the
875 beginning of the actual text.
876 They go into the preamble, and this is explained in the next section.
879 \begin_layout Section
880 LyX and the LaTeX Preamble
883 \begin_layout Subsection
884 About the LaTeX Preamble
887 \begin_layout Standard
888 \begin_inset LatexCommand \label{sec:preamble}
892 If you already know LaTeX, there is no need to explain here what the preamble
894 If you don't, the following will give you some ideas --- we recommend again
895 that you consult a LaTeX book for further information.
896 In any case, you should read the points below, because they explain what
897 you can do and what you don't need to do in the LaTeX preamble of a LyX
901 \begin_layout Standard
902 The LaTeX preamble comes at the very beginning of a document,
910 \begin_layout Itemize
911 declare the document class.
912 LyX already does this for you.
916 \begin_layout Standard
917 If you're a seasoned LaTeX-nician, and you have some custom document class
918 you want to use, check out the
922 for information on how to make LyX interface to it.
923 Be sure to submit your efforts to the LyX Team for inclusion in future
928 \begin_layout Itemize
929 declare the usage of packages.
930 LaTeX packages provide special commands, which are only available within
931 a document when the package has been declared in the preamble.
940 forces all paragraphs to be indented.
941 There are other packages for labels, envelopes, margins, etc.
945 \begin_layout Itemize
946 set counters, variables, lengths and widths.
947 There are several LaTeX counters and variables which
951 be set globally from within the preamble in order to have the desired effect.
952 [There are other variables which you can set and reset inside the document,
953 too.] Margins are a good example of something which must be set in the preamble.
954 Another example is the label format for lists.
955 You can actually set these just about anywhere, but it's best to do it
956 just once, inside the preamble.
959 \begin_layout Itemize
960 declare user defined commands [with
972 ], mostly abbreviations for LaTeX commands which appear very often inside
974 Although the preamble is a good place to declare such commands, they
978 be declared anywhere else [but
982 they are used for the first time, of course\SpecialChar \ldots{}
984 This can be useful if there is a lot of raw LaTeX code in your document,
985 which normally should not be the case.
988 \begin_layout Standard
989 LyX adds its own set of definitions to the preamble of the
994 This makes LaTeX files generated by LyX portable.
997 \begin_layout Subsection
998 Changing the Preamble
1001 \begin_layout Standard
1002 The commands which LyX adds to the preamble of a LaTeX file are fixed; you
1003 can't change them without patching LyX itself.
1004 You can, however, add your own stuff to the preamble.
1005 There are two ways to do this:
1008 \begin_layout Enumerate
1035 \SpecialChar \menuseparator
1043 dialog, depending on your frontend.
1044 Note that the LyX keybindings will not work in this dialog, alas.
1047 \begin_layout Enumerate
1048 Use the preamble contents you've added as your default template (see
1049 \begin_inset Quotes eld
1053 \begin_inset Quotes erd
1060 ), so that it will be the default preamble for any file you create.
1063 \begin_layout Standard
1064 LyX adds anything in the
1071 dialog to its own built-in preamble.
1072 Before adding your own declarations in the preamble, you should make sure
1073 that LyX doesn't already support what you want to do (remember what we
1074 said about reinventing the wheel?).
1077 make sure your preamble code is correct
1080 LyX doesn't check it.
1083 \begin_layout Subsection
1087 \begin_layout Standard
1088 Here are some examples of what you can add to a preamble, and what they
1092 \begin_layout Subsubsection
1096 \begin_layout Standard
1097 There are two variables under LaTeX that control page position:
1110 Their names should be self-explanatory.
1111 These variables are useful if you think for a moment about computer labels.
1112 Sometimes, the size of a print medium and the area of the medium that you
1113 can actually print on aren't the same.
1129 \begin_layout Standard
1130 The default values for
1142 are both 0 pt.,\InsetSpace ~
1145 the page isn't shifted.
1148 \begin_layout Standard
1149 Unfortunately, some DVI drivers always seem to shift the page.
1150 We have no idea why, or why the sysadmin hasn't fixed such behavior.
1151 If you're using LyX on a system that you don't personally maintain, and
1152 your sysadmin is a doofus,
1165 Suppose you're left and top margins are always 0.5 inches too big.
1166 You can add this to the preamble:
1169 \begin_layout LyX-Code
1177 \begin_layout LyX-Code
1185 \begin_layout Standard
1186 \SpecialChar \ldots{}
1187 and your margins should now be correct.
1190 \begin_layout Subsubsection
1194 \begin_layout Standard
1195 Speaking of labels, suppose you wanted to print out a bunch of address labels.
1196 There's a rather nice package, available at your nearest CTAN archive,
1197 for printing sheets of labels, called
1202 Now, your system may not have this package installed by default.
1203 We leave that up to you to check.
1204 You'll also want to read the documentation for it; we're not going to do
1206 Since this is an example, however, we'll give you an example of how you
1210 \begin_layout Standard
1211 First, make sure you're using the
1216 Next, you need to put the following in your preamble:
1219 \begin_layout LyX-Code
1225 \begin_layout LyX-Code
1231 \begin_layout LyX-Code
1237 \begin_layout LyX-Code
1243 \begin_layout LyX-Code
1249 \begin_layout LyX-Code
1255 \begin_layout LyX-Code
1261 \begin_layout Standard
1262 This sets things up for Avery® label sheets, stock #5360.
1263 You're now ready to print labels, but you'll need to insert LaTeX code,
1264 placing the commands
1276 around each label text.
1277 This and other special features of
1281 are explained in its documentation.
1284 \begin_layout Standard
1285 Someday, someone may write a LyX layout file to support this package directly.
1286 Maybe that someone is you.
1289 \begin_layout Subsubsection
1290 Example #3: Paragraph Indentation
1293 \begin_layout Standard
1294 Americans are trained to indent the first line of
1299 As with all of their other weird quirks, most Americans will whine and
1300 moan until they can have their way and indent the first line of all paragraphs.
1304 \begin_layout Standard
1309 : This was written by an American ---
1313 ! It's my perception of my fellow countrymen.
1314 Tough if you don't like it.
1323 \begin_layout Standard
1324 Of course, this behavior isn't standard typography.
1325 In books, you typically only indent the first line of a paragraph
1329 it follows another one.
1330 The idea behind indenting the first line of a paragraph is to distinguish
1331 neighboring paragraphs from one another.
1332 If there is no previous paragraph, for example, it follows a figure, or
1333 is the first paragraph in a section, then there is no special indentation.
1337 \begin_layout Standard
1338 If you're a typical American, though, you don't care about such esoteric
1339 things; you want your indentation! Add this to the preamble:
1342 \begin_layout LyX-Code
1345 usepackage{indentfirst}
1348 \begin_layout Standard
1349 If your TeX distribution isn't a braindead one, you'll have this package,
1350 and all of your paragraphs will get the indentation you think they deserve.
1353 \begin_layout Subsubsection
1354 Example #4: This Document
1357 \begin_layout Standard
1358 You can also check out the preamble of this document to get an idea of some
1359 of the advanced things you can do.
1360 You'll probably need to make the
1365 reamble\SpecialChar \ldots{}
1368 dialog full-screen to see most of it.
1369 Also, there are more examples and an assortment of LaTeX
1370 \begin_inset Quotes eld
1374 \begin_inset Quotes erd
1377 given in Chapter\InsetSpace ~
1379 \begin_inset LatexCommand \ref{cha:secrets}
1387 \begin_layout Section
1388 LyX and LaTeX Errors
1391 \begin_layout Standard
1392 When LyX calls LaTeX, it tells LaTeX to blithely ignore any errors and keep
1394 It then uses the log-file from the LaTeX run to do a post-mortem.
1395 As we stated earlier in the chapter, LyX generates two kinds of
1399 files, one of which it uses to locate errors in the document.
1400 If there was an error someplace, LyX will put a box with the word
1401 \begin_inset Quotes eld
1405 \begin_inset Quotes erd
1408 at the appropriate place in the document.
1412 \begin_layout Standard
1413 LyX will occasionally misguess where the error was.
1414 This will typically happen with tables, figures, math, and the preamble.
1419 It will also display a message alerting you to the fact that there were
1423 \begin_layout Standard
1424 You can navigate through the errors by using
1440 \begin_inset Quotes eld
1444 \begin_inset Quotes erd
1447 the error-boxes and view the error message LaTeX produced by clicking on
1451 \begin_layout Standard
1452 Some folks also like to look at the log file directly, accessible from
1458 ocument\SpecialChar \menuseparator
1468 There are some fairly common error messages and warnings.
1469 We'll cover those here.
1470 You should look at a good LaTeX book for a complete listing.
1473 \begin_layout Itemize
1474 \begin_inset Quotes eld
1482 \begin_inset Quotes eld
1489 \begin_layout Standard
1490 Anything beginning with these word is a warning message for the purpose
1492 \begin_inset Quotes eld
1496 \begin_inset Quotes erd
1499 the LaTeX code itself.
1500 You'll get messages like this if you added or changed cross-references
1501 or bibliography entries, in which case, LaTeX is trying to tell you that
1502 you need to make another run.
1505 \begin_layout Standard
1506 You can by-and-large ignore these.
1510 \begin_layout Itemize
1511 \begin_inset Quotes eld
1519 \begin_inset Quotes erd
1526 \begin_layout Standard
1527 Another warning message, this time about fonts which LaTeX couldn't find.
1528 The rest of the message will often say something about a replacement font
1532 \begin_layout Standard
1533 You can safely ignore these.
1537 \begin_layout Itemize
1538 \begin_inset Quotes eld
1548 \begin_inset Quotes erd
1555 \begin_layout Standard
1561 They are warning you about lines that were too long and run past the right
1563 Almost always, this is unnoticeable in the final output.
1564 Or, only one or two characters extend past the margin.
1565 LaTeX seems to generate at least one of these messages for just about any
1569 \begin_layout Standard
1570 You can ignore these stupid messages.
1571 Your eyes will tell you if there's a problem with something that's too
1572 wide; just look at the output.
1576 \begin_layout Itemize
1577 \begin_inset Quotes eld
1587 \begin_inset Quotes erd
1594 \begin_layout Standard
1595 Not quite as common as its cousin.
1596 LaTeX seems to like to print lines that are a bit too wide as opposed to
1597 ones that are a bit too narrow.
1598 We have no idea why.
1601 \begin_layout Standard
1602 You can ignore these, too.
1606 \begin_layout Itemize
1607 \begin_inset Quotes eld
1617 \begin_inset Quotes erd
1621 \begin_inset Quotes eld
1631 \begin_inset Quotes erd
1638 \begin_layout Standard
1639 Warnings about troubles breaking the page.
1640 Once again, just look at the output.
1641 Your eyes will tell you where something has gone wrong.
1645 \begin_layout Itemize
1646 \begin_inset Quotes eld
1652 \begin_inset Quotes els
1656 \begin_inset Quotes ers
1662 \begin_inset Quotes erd
1669 \begin_layout Standard
1671 \begin_inset Quotes eld
1675 \begin_inset Quotes erd
1678 isn't installed on this system.
1679 This usually appears because some package your document needs isn't installed.
1680 If you didn't touch the preamble or didn't use the
1686 command, then one of the packages LyX tried to load is missing.
1692 elp\SpecialChar \menuseparator
1699 , to get a list of packages that LyX knows about.
1700 This file is updated whenever you reconfigure LyX (using
1707 \SpecialChar \menuseparator
1712 ) and tells you which packages have been detected and what they do.
1715 \begin_layout Standard
1726 command, and the package in question isn't installed, you'll need to install
1731 \begin_layout Itemize
1732 \begin_inset Quotes eld
1737 LaTeX Error: Unknown option
1740 \begin_inset Quotes erd
1747 \begin_layout Standard
1748 Error messages beginning with this are trying to tell you that you specified
1749 a bad or undefined option to a package.
1750 Check the package's documentation.
1754 \begin_layout Itemize
1755 \begin_inset Quotes eld
1760 Undefined control sequence
1763 \begin_inset Quotes erd
1770 \begin_layout Standard
1771 If you've inserted LaTeX code into your document, but made a typo, you'll
1773 You may have forgotten to load a package.
1774 In any case, this error message usually means that you used an undefined
1779 \begin_layout Standard
1780 There are other error and warning messages.
1781 Some are self-explanatory.
1782 These are usually LaTeX messages.
1783 Others are downright cryptic.
1784 These are actually TeX error messages, and we really have
1788 what they mean or how to decipher them.
1791 \begin_layout Standard
1792 There's a general sequence you should follow if you get error messages:
1795 \begin_layout Enumerate
1796 Look at the LaTeX code you inserted for typos.
1799 \begin_layout Enumerate
1800 If there are no typos, check and see that you used the command(s) correctly.
1803 \begin_layout Enumerate
1804 If you get a bunch of error boxes piled up at the very top of the document,
1805 it means that there are errors in the preamble.
1806 Start debugging your preamble.
1809 \begin_layout Enumerate
1810 If you didn't add anything to the preamble and didn't add any LaTeX code
1811 to the document, the first suspect is your LaTeX distribution itself.
1812 Check for missing packages and install them.
1815 \begin_layout Enumerate
1816 Okay, so there are no missing packages.
1817 Did you use any of the fine-tuning options in LyX? Specifically, did you
1822 any of them, like trying to manually insert lots of
1824 Protected\InsetSpace ~
1835 s? Did you try to kludge something together with these instead of using
1836 the appropriate paragraph environment?
1839 \begin_layout Enumerate
1840 All right, you didn't use any of the fine-tuning options, you played by
1842 Did you try to pull a fancy maneuver? Did you do something funky inside
1843 a table or an equation, like inserting a graphic into a table cell?
1846 \begin_layout Enumerate
1847 Do you have long sections of text where LaTeX cannot find a place to break
1848 a line? By default, LaTeX is rather strict about how much extra inter-word
1849 spacing it will add in order to break a line.
1850 Preferrably, you should rework the paragraph to avoid the problem.
1851 If this isn't an option, you can wrap your text in
1857 to make LaTeX's line breaking more, well, sloppy.
1860 \begin_layout Enumerate
1861 Did you go overboard with the nesting? LyX (currently) doesn't check to
1862 make sure you're in the limits for nesting environments.
1863 If you nested a bunch of environments to the
1864 \begin_inset Formula $17^{\mathrm{th}}$
1867 level, that's the problem.
1870 \begin_layout Enumerate
1871 Okay, you didn't get any error messages, but your output looks whacked.
1872 If you have a table or figure that's too wide or long for the page, you
1877 \begin_layout Enumerate
1878 rescale the figure so it fits.
1881 \begin_layout Enumerate
1882 trim down the table so it fits.
1885 \begin_layout Standard
1886 If something else is wrong with the output, and you didn't try to pull anything
1887 fancy or kludge the fine-tuning options, we're not sure what's wrong.
1891 \begin_layout Standard
1892 If all this doesn't help --- well, then
1896 you might have found a bug in LyX\SpecialChar \ldots{}
1900 \begin_layout Chapter
1904 \begin_layout Section
1905 Preparing a Bibliography with BibTeX
1906 \begin_inset LatexCommand \label{sec:Preparing-a-Bibliography}
1913 \begin_layout Standard
1920 Jürgen Spitzmüller
1923 \begin_layout Standard
1924 \begin_inset VSpace bigskip
1930 \begin_layout Standard
1932 STOP! If you don't know what BibTeX is, or have a reasonably good idea of
1938 setting up your own bibliographic databases),
1942 , do not walk, to your nearest copy of the 2nd edition of Lamport's
1944 LaTeX: A Document Preparation System
1946 , particularly Appendix B.
1947 The rest of this discussion assumes you have created a correct bibliography
1948 file, that you have all relevant environment variables set correctly (esp.
1961 ), and that if sufficiently desperate, you could create and
1962 \begin_inset Quotes eld
1966 \begin_inset Quotes erd
1969 a LaTeX file with a BibTeX database.
1973 \begin_layout Standard
1974 For those who don't know what BibTeX is, it is a system for creating a large
1975 database of your most used journal references.
1976 For all future articles you write, you only need to include this standard
1977 database and reference the appropriate key to each reference.
1978 Even if you write only a few papers with handful of references each, it
1979 is well worth your time to examine BibTeX and decide whether it will be
1983 \begin_layout Standard
1984 To use BibTeX with LyX, first read the
1988 where it describes how to insert citations.
1989 The basic mechanism for inserting BibTeX references is the same.
1990 Then, at the very end of your document, select
1992 Insert\SpecialChar \menuseparator
1997 TOC\SpecialChar \menuseparator
2001 In the resulting dialog, fill out the dialog boxes as follows:
2004 \begin_layout Description
2005 Database: enter the name of your
2018 For searching multiple
2022 files, just enter them in the desired order, separated by commas.
2026 \begin_layout Description
2027 Style: enter the name of your BibTeX style file *without* the
2032 The default style is
2036 (which should be included in your LaTeX distribution, so you don't have
2037 to worry about creating it).
2040 \begin_layout Standard
2041 For each citation, assuming that the source is in the
2050 nsert\SpecialChar \menuseparator
2057 at the correct location in the text, and enter the appropriate reference
2059 Nothing else is required; when invoking
2064 iew\SpecialChar \menuseparator
2071 , for example, you should see that BibTex and LaTeX are invoked as needed,
2072 including multiple invocations of LaTeX.
2076 \begin_layout Subsection
2077 Alternative Citation Styles
2080 \begin_layout Standard
2081 Standard BibTeX uses numbers (e.\InsetSpace \thinspace{}
2082 g.\InsetSpace \space{}
2084 \begin_inset Quotes eld
2088 \begin_inset Quotes erd
2091 ) to refer to a cited work.
2092 However, in many scientific disciplines, other citation styles are in use.
2093 The most common one is the author-year style (e.\InsetSpace \thinspace{}
2094 g.\InsetSpace \space{}
2096 \begin_inset Quotes eld
2100 \begin_inset Quotes erd
2104 LyX supports two packages that provide this style,
2113 Both packages have their own pros and cons, which cannot be listed in detail.
2114 If you only want to have simple author-year (or author-numerical) style
2115 or if you want to use one of the countless style files for natbib, than
2120 package is probably your choice.
2121 If you need special features like short title references, ibidem etc., you
2122 might consider the fairly new
2129 \begin_layout Standard
2130 The handling of both packages in LyX is basically the same.
2136 ocument\SpecialChar \menuseparator
2147 pane (with the xforms frontend: the
2161 With both packages, you will get some extra features in the citation dialog
2162 and you can select the style of the reference (
2163 \begin_inset Quotes eld
2167 \begin_inset Quotes erd
2171 \begin_inset Quotes eld
2175 \begin_inset Quotes erd
2179 \begin_inset Quotes eld
2183 \begin_inset Quotes erd
2187 \begin_inset Quotes eld
2191 \begin_inset Quotes erd
2195 Note that both packages need specifically designed style files (they both
2196 ship their own, while there are lots of additional style files and even
2197 an interactive style file builder
2201 \begin_layout Standard
2203 \begin_inset LatexCommand \url{ftp://ctan.tug.org/tex-archive/macros/latex/contrib/custom-bib/}
2219 \begin_layout Subsection
2220 Sectionated Bibliographies
2221 \begin_inset LatexCommand \label{sub:Sectionated-Bibliographies}
2228 \begin_layout Standard
2229 Sometimes you might need to divide your bibliography into several sections.
2230 If you are, for instance, a historian, the possibility to separate sources
2231 and scientific works is most likely a
2232 \begin_inset Quotes eld
2236 \begin_inset Quotes erd
2240 Unfortunately, BibTeX itself does not allow you to do this.
2241 The good news is, though: With the help of some LaTeX packages, BibTeX
2242 can be extended to fit your historical needs.
2245 \begin_layout Standard
2246 As of version 1.4, LyX provides native support for one of these packages,
2255 \begin_layout Standard
2257 \begin_inset LatexCommand \url{ftp://ctan.tug.org/tex-archive/macros/latex/contrib/bibtopic/}
2266 The advantage of this package (compared to other packages like
2270 ) is that you don't need to define new citation commands.
2271 Instead, you need to prepare different bibliographic databases which include
2272 the entries for the different sections of the bibliography.
2273 For example: If you want to divide your bibliography into the sections
2275 \begin_inset Quotes eld
2279 \begin_inset Quotes erd
2283 \begin_inset Quotes eld
2287 \begin_inset Quotes erd
2290 , you first need to create two bibliographic databases, e.\InsetSpace \thinspace{}
2291 g.\InsetSpace \space{}
2304 \begin_layout Standard
2310 ocument\SpecialChar \menuseparator
2321 pane (with the xforms frontend: the
2328 Sectionated\InsetSpace ~
2332 Now you can insert multiple BibTeX references (as described in section\InsetSpace ~
2334 \begin_inset LatexCommand \ref{sec:Preparing-a-Bibliography}
2338 ), one for each section of your bibliography.
2339 Returning to our example: Insert a BibTeX reference for the database
2343 and a second one for the database
2348 You are free to use the same or different styles for each section.
2349 Additionally, you can chose if the bibliography section should contain
2351 \begin_inset Quotes eld
2354 all cited references
2355 \begin_inset Quotes erd
2358 of the specified database(s) (which is the default),
2359 \begin_inset Quotes eld
2362 all uncited references
2363 \begin_inset Quotes erd
2367 \begin_inset Quotes eld
2371 \begin_inset Quotes erd
2375 This might be useful if you would like to separate your bibliography into
2377 \begin_inset Quotes eld
2381 \begin_inset Quotes erd
2385 \begin_inset Quotes eld
2389 \begin_inset Quotes erd
2393 \begin_inset Quotes eld
2397 \begin_inset Quotes erd
2401 The titles for the sections can be added as ordinary sections or subsections.
2406 removes the bibliography title, you have manually re-add that, too (as
2407 a chapter* or section*, for instance).
2410 \begin_layout Subsection
2411 Multiple Bibliographies
2414 \begin_layout Standard
2415 Multiple bibliographies, e.\InsetSpace \thinspace{}
2416 g.\InsetSpace \space{}
2417 a bibliography for each section or chapter of
2418 the document, are not supported by BibTeX itself.
2423 package, which is used for the creation of sectionated bibliographies in
2424 LyX (cf.\InsetSpace ~
2425 section\InsetSpace ~
2427 \begin_inset LatexCommand \ref{sub:Sectionated-Bibliographies}
2431 ), provides an easy way to solve this task, if you are willing to use some
2432 LaTeX-Code (ERT, cf.\InsetSpace ~
2433 section\InsetSpace ~
2435 \begin_inset LatexCommand \ref{sec:Inserting-LaTeX-Code}
2443 \begin_layout Standard
2444 An alternative approach is to use the
2452 package, respectively.
2460 \begin_layout Standard
2466 ocument\SpecialChar \menuseparator
2477 pane (with the xforms frontend: the
2484 Sectionated\InsetSpace ~
2488 In the document, you have to enclose the sections, which shall contain
2489 their own bibliography (including the BibTeX reference itself), between
2502 (those commands have to be inserted as ERT).
2503 The bibliography will contain all references which have been cited in the
2505 N.\InsetSpace \thinspace{}
2506 B.: If you are using this approach, then
2510 citation reference has to be inside some btUnit.
2511 Also, the btUnits cannot be nested.
2514 \begin_layout Section
2518 \begin_layout Standard
2519 A good index is one of the hardest things to make in a lengthy document,
2520 but LyX helps make things a bit simpler by interfacing to the
2524 program which is found in most recent LaTeX distributions.
2528 \begin_layout Standard
2546 Outputs\SpecialChar \menuseparator
2547 LaT\SpecialChar \textcompwordmark{}
2556 section of the preferences dialog, however, you can customize the index
2557 command, if you prefer an alternative program like
2580 Inserting an index and marking words to include in it works much the same
2581 way as preparing a bibliography as mentioned in the last section.
2584 \begin_layout Standard
2585 First, go to the end of your file and select
2590 nsert\SpecialChar \menuseparator
2601 C\SpecialChar \menuseparator
2614 Then, for each word you would like to include in the index, go to the end
2615 of that word and click on
2620 nsert\SpecialChar \menuseparator
2633 This will insert a tag showing the word as it will appear in the index.
2634 That's all there is to it; LyX will automatically call
2638 for you and create the index itself.
2639 The text in the dialog available from right-clicking on the index button
2640 accepts LaTeX, so you'll need to be careful to avoid using any special
2642 On the positive side, you can use the advanced options - have a look at
2643 the documentation which comes with your LaTeX distribution to find out
2644 how to do things like
2645 \begin_inset Quotes eld
2649 \begin_inset Quotes erd
2655 \begin_layout Standard
2656 Be careful not to put spaces between the word in the text and the index
2657 marker; apparently the wrong page number can be produced if this happens.
2660 \begin_layout Section
2664 \begin_layout Subsection
2668 \begin_layout Standard
2669 When you are working on a large file with many sections, it is often convenient
2670 to break up the document into several files, or perhaps you have something
2671 where a table may change from time to time, but the preceding text does
2673 In these cases, you should seriously consider using multipart documents.
2674 For example, scientific papers often have five major sections: the introduction
2675 , observations, results, discussion, and conclusion.
2676 Each of these could be its own separate LyX file, with one
2677 \begin_inset Quotes eld
2681 \begin_inset Quotes erd
2684 file which contains the title, authors, abstract, references, etc., plus
2685 the five included files.
2686 It is important to note that each of these files is a full LyX file which
2687 can be formatted and printed on its own, as well as included in a master
2689 Each of these files must have the same document class, however--- don't
2690 attempt to mix book classes with article classes.
2691 You may also include LaTeX files; however, these files must not have their
2697 everything up to and including the
2709 line must be deleted) or else errors will be generated when you try to
2713 \begin_layout Standard
2714 LyX allows you to include files quite easily with
2719 nsert\SpecialChar \menuseparator
2728 When you click on this selection a small box is inserted into the file
2729 at the current cursor location.
2730 Clicking on the box raises a dialog which allows you to select the file
2731 to be included, and the method of its inclusion.
2735 \begin_layout Standard
2736 The file selection box should by now be obvious.
2737 The three inclusion methods are
2738 \begin_inset Quotes eld
2742 \begin_inset Quotes erd
2746 \begin_inset Quotes eld
2750 \begin_inset Quotes erd
2754 \begin_inset Quotes eld
2758 \begin_inset Quotes erd
2762 The difference between
2763 \begin_inset Quotes eld
2767 \begin_inset Quotes erd
2771 \begin_inset Quotes eld
2775 \begin_inset Quotes erd
2778 is really only meaningful to LaTeXperts, but the practical difference is
2779 that files which are
2780 \begin_inset Quotes eld
2784 \begin_inset Quotes erd
2787 are typeset beginning on a new page, while files which are
2788 \begin_inset Quotes eld
2792 \begin_inset Quotes erd
2795 are typeset starting on the current page.
2796 Perhaps the labeling in LyX will be changed someday to reflect this.
2799 \begin_layout Standard
2800 Generally, the master file is converted into a full LaTeX file before typesettin
2801 g, while the included files are converted to LaTeX files which do not have
2802 all the preamble information.
2812 button prevents this conversion.
2815 \begin_layout Standard
2817 \begin_inset Quotes eld
2821 \begin_inset Quotes erd
2824 included file allows you to include a file typeset exactly as it appears
2825 in the file, i.e.\InsetSpace ~
2826 verbatim mode, with the characters set in a fixed-width
2828 Normally, spaces in this file are invisible, though two consecutive spaces
2829 are conserved, unlike LyX's normal treatment of spaces.
2830 However, setting the
2840 checkbox typesets a mark to unambiguously define the presence of a space.
2846 \begin_layout Subsection
2847 Cross-References Between Files
2850 \begin_layout Standard
2851 It is possible to set up cross-references between the different files.
2852 First, open all the files in question: let's call them A and B in a two
2853 file example, where B is included in A.
2854 Let's say you insert a label in A, then want to reference it in B.
2855 Open the cross-reference dialog in whilst in document B, and you can select
2857 \begin_inset Quotes eld
2861 \begin_inset Quotes erd
2867 \begin_layout Section
2871 \begin_layout Standard
2876 is needed by LyX to be able to output algorithm floats.
2877 These are useful in placing short algorithms across page breaks and support
2878 an index of algorithms too.
2881 \begin_layout Section
2885 \begin_layout Standard
2890 is used by LyX when you select ``subfigure'' in the graphics dialog and
2891 enter the subfigure caption.
2892 Several figures marked in this way can be packed into a single float with
2893 individual sub-captions.
2896 \begin_layout Section
2897 Fancy Headers and Footers
2900 \begin_layout Standard
2901 The default page layout is rather plain; for an article document class,
2902 all you get is a centered page number at the bottom of the page.
2903 This document is the book class, so it appears to be a bit fancier, but
2904 to really put on a show, you need to set the document page style to
2905 \begin_inset Quotes eld
2909 \begin_inset Quotes erd
2912 , as mentioned in the
2918 This section describes the LaTeX codes you need to insert in your LaTeX
2919 preamble or the text in order to get the desired effects.
2922 \begin_layout Standard
2923 The page header is divided into three fields, not surprisingly labeled
2924 \begin_inset Quotes eld
2928 \begin_inset Quotes erd
2932 \begin_inset Quotes eld
2936 \begin_inset Quotes erd
2940 \begin_inset Quotes eld
2944 \begin_inset Quotes erd
2948 The footer is also divided into these three fields.
2949 The LaTeX commands to set these fields in the simplest manner are
2974 Suppose you wish to put your name in the upper left hand corner of each
2976 Simply insert the following command in the preamble:
2979 \begin_layout Standard
2988 \begin_layout Standard
2989 You will now see your name in the upper left.
2990 If a field has a default entry that you would like to get rid of (often
2991 the page number appears in the central footer, simply include a command
2992 with a blank argument, e.g.
2995 \begin_layout Standard
3003 \begin_layout Standard
3004 Let's get really fancy: lets put the section number with the word
3005 \begin_inset Quotes eld
3009 \begin_inset Quotes erd
3013 Section 3) in the upper left, the page number (e.g.
3014 Page 4) in the upper right, your name in the lower left, and the date in
3016 The following commands should now appear in the preamble:
3019 \begin_layout Standard
3029 \begin_layout Standard
3037 \begin_layout Standard
3047 \begin_layout Standard
3056 \begin_layout Standard
3064 \begin_layout Standard
3074 \begin_layout Standard
3087 access LaTeX's section and page counters, and so print out the current
3088 section and page numbers.
3095 simply prints out today's date.
3098 \begin_layout Standard
3099 The thicknesses of the horizontal rules drawn beneath the header and above
3100 the footer can also be modified.
3101 If you don't want one of the headers, set its thickness to 0.
3102 The header rule has a default thickness of 0.4pt, the footer rule is 0pt.
3103 Use the commands, e.g.
3110 headrulewidth}{0.4pt}
3118 footrulewidth}{0.4pt}
3120 to set the thicknesses.
3123 \begin_layout Standard
3124 You can switch the header/footer settings on and off for individual pages
3129 thispagestyle{empty}
3135 thispagestyle{plain}
3141 thispagestyle{fancy}
3144 Simply insert them in the text on the page you want changed and mark them
3146 In fact, title pages are marked as plain by default, while following pages
3147 are marked fancy when using the global fancy setting.
3150 \begin_layout Standard
3151 There are more complex commands which will let you insert things in the
3152 upper left on odd numbered pages, etc., but I will refer you to the
3156 package documentation for more descriptions.
3157 For example, if you have a teTeX installation, look for
3159 /usr/share/texmf/doc/latex/fancyhdr/\SpecialChar \-
3165 \begin_layout Standard
3166 As a final example, it is possible to include an Encapsulated PostScript®
3167 file in the header or footer.
3168 Suppose you want to put a company logo in the upper lefthand corner.
3169 You might try something like
3172 \begin_layout Standard
3181 includegraphics{logo.eps}}}
3184 \begin_layout Standard
3186 (you may need to preface this with
3190 usepackage{graphics}
3192 if you don't include EPS files elsewhere in your document).
3195 \begin_layout Section
3199 \begin_layout Standard
3200 LaTeX provides a mechanism to produce essentially a page within a page,
3202 Within a minipage, all the usual rules of indentation, line wrapping, etc.\InsetSpace ~
3204 LyX also provides some of the minipage capability.
3207 \begin_layout Standard
3208 Minipages in LyX have their own collapsable box; insert one via
3213 nsert\SpecialChar \menuseparator
3221 Right-clicking on the box allows you to alter the minipage's width and
3222 alignment within the page.
3223 Warning: if the minipage is too long to fit on a page, it is truncated,
3224 not wrapped onto the next page.
3227 \begin_layout Standard
3228 If you place two minipages side-by-side, you can use
3233 nsert\SpecialChar \menuseparator
3241 to insert a special instruction known in the LaTeX world as an
3245 to put a maximum amount of space between them; it forces one minipage to
3246 the left edge, the other to the right edge.
3247 The examples below show the difference.
3250 \begin_layout Standard
3251 \begin_inset Box Frameless
3260 height_special "totalheight"
3263 \begin_layout Standard
3264 This is a minipage which does not use hfill.
3265 This is the second sentence of a minipage which does not use hfill.
3273 \begin_layout Standard
3274 \begin_inset Box Frameless
3283 height_special "totalheight"
3286 \begin_layout Standard
3287 This is a second minipage which does not use hfill.
3288 This is the second sentence of a second minipage which does not use hfill.
3296 \begin_layout Standard
3297 \begin_inset VSpace medskip
3303 \begin_layout Standard
3304 Here is some normal text to separate the two examples.
3307 \begin_layout Standard
3308 \begin_inset VSpace medskip
3314 \begin_layout Standard
3315 \begin_inset Box Frameless
3324 height_special "totalheight"
3327 \begin_layout Standard
3328 This is a minipage which does use hfill.
3329 This is the second sentence of a minipage which does use hfill.
3337 \begin_inset Box Frameless
3346 height_special "totalheight"
3349 \begin_layout Standard
3350 This is a second minipage which does use hfill.
3351 This is the second sentence of a second minipage which does use hfill.
3359 \begin_layout Section
3360 Wrapping Text Around Figures
3361 \begin_inset LatexCommand \label{sec:floatflt}
3368 \begin_layout Standard
3369 \begin_inset Wrap figure
3374 \begin_layout Standard
3375 \begin_inset Graphics
3386 \begin_layout Caption
3387 This is a wrapped figure, and this is the brilliant caption that describes
3396 \begin_layout Standard
3397 A very frequently asked question is whether text can be made to
3398 \begin_inset Quotes eld
3402 \begin_inset Quotes erd
3405 around figures so that a figure occupies some fraction of the column width
3406 and text fills the rest.
3407 If you have the LaTeX package
3411 installed (you can find out about it in the
3415 manual) you can do this.
3418 \begin_layout Standard
3419 At the right is a figure of a mobius strip---you should have already seen
3425 To wrap the text like this insert a wrap box via
3430 nsert\SpecialChar \menuseparator
3435 ts\SpecialChar \menuseparator
3441 \begin_layout Standard
3442 Note: this package is very fragile! For example, having a figure too close
3443 to the bottom of the page will mess things up, as will having two figures
3445 Use this package sparingly and do read the documentation that came with
3446 it (which will also tell you how to wrap text around tables).
3449 \begin_layout Section
3453 \begin_layout Standard
3454 While the standard table layout will suffice in 99% of all tables you generate,
3455 occasionally you will run into one which requires a bit of extra tweaking.
3456 The table dialog which appears on a right-click of a table allows these
3458 It will give you access to some extra column alignment parameters.
3459 A little bit of LaTeX background is useful here: when you set up a table
3460 in LaTeX, each column is given an alignment type.
3461 For example, you would give it
3462 \begin_inset Quotes eld
3470 \begin_inset Quotes erd
3474 \begin_inset Quotes eld
3482 \begin_inset Quotes erd
3486 \begin_inset Quotes eld
3494 \begin_inset Quotes erd
3497 for left-aligned, centered, and right-aligned columns respectively (which
3498 appear as the left/center/right radio buttons in LyX).
3500 \begin_inset Quotes eld
3508 \begin_inset Quotes erd
3511 , which will make a column of a specified width (the width box in LyX),
3512 and will wrap text within that box.
3514 \begin_inset Quotes eld
3522 \begin_inset Quotes erd
3525 (vertical bar) which rather than making a column will make a vertical rule
3526 at that point; this manifests itself in LyX as the
3527 \begin_inset Quotes eld
3531 \begin_inset Quotes erd
3535 Finally, there is a type
3536 \begin_inset Quotes eld
3544 \begin_inset Quotes erd
3547 , which allows you to use whatever is enclosed in the accompanying braces
3548 as the column separator, including a null argument.
3549 The reasons for doing this may not be obvious, but they can be very powerful.
3550 They are best demonstrated by example.
3553 \begin_layout Subsection
3554 Removing Extra Column Space
3557 \begin_layout Standard
3558 Here is a standard table:
3561 \begin_layout Standard
3563 \begin_inset Tabular
3564 <lyxtabular version="3" rows="3" columns="2">
3566 <column alignment="left" valignment="top" width="0pt">
3567 <column alignment="left" valignment="top" leftline="true" width="0pt">
3568 <row bottomline="true">
3569 <cell alignment="left" valignment="top" topline="true" usebox="none">
3572 \begin_layout Standard
3587 <cell alignment="left" valignment="top" topline="true" leftline="true" usebox="none">
3590 \begin_layout Standard
3607 <cell alignment="left" valignment="top" topline="true" usebox="none">
3610 \begin_layout Standard
3625 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
3628 \begin_layout Standard
3645 <cell alignment="center" valignment="top" topline="true" usebox="none">
3648 \begin_layout Standard
3663 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
3666 \begin_layout Standard
3689 \begin_layout Standard
3690 Notice that the horizontal rule extends a bit past the text on both sides.
3691 If you wanted the line to end even with the text, we can put a null separator
3692 on the ends to get rid of the bit of extra space LaTeX adds by default.
3693 Here is the example:
3696 \begin_layout Standard
3698 \begin_inset Tabular
3699 <lyxtabular version="3" rows="3" columns="2">
3701 <column alignment="left" valignment="top" width="0pt" special="@{} l">
3702 <column alignment="left" valignment="top" leftline="true" width="0pt" special="l @{}">
3703 <row bottomline="true">
3704 <cell alignment="left" valignment="top" topline="true" usebox="none">
3707 \begin_layout Standard
3722 <cell alignment="left" valignment="top" topline="true" leftline="true" usebox="none">
3725 \begin_layout Standard
3742 <cell alignment="left" valignment="top" topline="true" usebox="none">
3745 \begin_layout Standard
3760 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
3763 \begin_layout Standard
3780 <cell alignment="center" valignment="top" topline="true" usebox="none">
3783 \begin_layout Standard
3798 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
3801 \begin_layout Standard
3824 \begin_layout Standard
3825 In this case, the column specifier for the left column was set to
3826 \begin_inset Quotes eld
3834 \begin_inset Quotes erd
3837 , while the right column was set to
3838 \begin_inset Quotes eld
3846 \begin_inset Quotes erd
3849 , in order to put the null characters on the edges.
3853 \begin_layout Subsection
3854 Changing the Column Separator Character
3857 \begin_layout Standard
3858 Now suppose you really wanted, for reasons that are completely opaque, to
3860 \begin_inset Formula $\sqrt{\pi}$
3863 with some space around it for the column separator.
3864 Simply turn off the vertical border, then set the right column specifier
3866 \begin_inset Quotes eld
3878 \begin_inset Quotes erd
3882 You could now make a table like this:
3885 \begin_layout Standard
3887 \begin_inset Tabular
3888 <lyxtabular version="3" rows="3" columns="2">
3890 <column alignment="left" valignment="top" width="0pt">
3891 <column alignment="left" valignment="top" width="0in" special="@{~$\sqrt{\pi}$~}l">
3892 <row bottomline="true">
3893 <cell alignment="left" valignment="top" topline="true" usebox="none">
3896 \begin_layout Standard
3911 <cell alignment="left" valignment="top" topline="true" usebox="none">
3914 \begin_layout Standard
3931 <cell alignment="left" valignment="top" topline="true" usebox="none">
3934 \begin_layout Standard
3949 <cell alignment="center" valignment="top" topline="true" usebox="none">
3952 \begin_layout Standard
3969 <cell alignment="center" valignment="top" topline="true" usebox="none">
3972 \begin_layout Standard
3987 <cell alignment="center" valignment="top" topline="true" usebox="none">
3990 \begin_layout Standard
4013 \begin_layout Subsection
4014 Making a Decimal Point Aligned Column
4017 \begin_layout Standard
4018 Okay, that last example was very silly, but here is one that is not.
4019 Suppose you want to make a table that has a column which is aligned on
4021 A standard LaTeX trick to do this is to set the whole number part in a
4022 right-aligned column, use a decimal point for the column separator, then
4023 set the fractional part as a left-aligned column.
4024 A variation on this is to include the decimal point explicitly with the
4025 whole part, then use just a null separator in between.
4026 The latter variation is demonstrated here:
4029 \begin_layout Standard
4031 \begin_inset Tabular
4032 <lyxtabular version="3" rows="5" columns="3">
4034 <column alignment="center" valignment="top" width="0pt">
4035 <column alignment="right" valignment="top" leftline="true" width="0pt">
4036 <column alignment="center" valignment="top" width="0pt" special="@{} l">
4037 <row bottomline="true">
4038 <cell alignment="center" valignment="top" topline="true" usebox="none">
4041 \begin_layout Standard
4056 <cell multicolumn="1" alignment="center" valignment="top" bottomline="true" leftline="true" usebox="none">
4059 \begin_layout Standard
4074 <cell multicolumn="2" alignment="center" valignment="top" topline="true" usebox="none">
4077 \begin_layout Standard
4085 <cell alignment="center" valignment="top" topline="true" usebox="none">
4088 \begin_layout Standard
4098 \begin_inset Formula $\pi$
4106 <cell alignment="right" valignment="top" topline="true" leftline="true" usebox="none">
4109 \begin_layout Standard
4124 <cell alignment="center" valignment="top" topline="true" usebox="none">
4127 \begin_layout Standard
4144 <cell alignment="center" valignment="top" topline="true" usebox="none">
4147 \begin_layout Standard
4157 \begin_inset Formula $\pi^{\pi}$
4165 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
4168 \begin_layout Standard
4183 <cell alignment="center" valignment="top" topline="true" usebox="none">
4186 \begin_layout Standard
4203 <cell alignment="center" valignment="top" topline="true" usebox="none">
4206 \begin_layout Standard
4216 \begin_inset Formula $(\pi^{\pi})^{\pi}$
4224 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
4227 \begin_layout Standard
4242 <cell alignment="center" valignment="top" topline="true" usebox="none">
4245 \begin_layout Standard
4253 <cell alignment="center" valignment="top" topline="true" usebox="none">
4256 \begin_layout Standard
4266 \begin_inset Formula $\pi^{\pi^{\pi}}$
4274 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
4277 \begin_layout Standard
4292 <cell alignment="center" valignment="top" topline="true" usebox="none">
4295 \begin_layout Standard
4306 \begin_inset Formula $\times10^{18}$
4322 \begin_layout Standard
4323 Though it appears a bit funny in LyX, on paper it will produce what appears
4324 to be a 2-column table in which the right column is aligned on the decimal
4325 point and the header appears to be centered over it.
4328 \begin_layout Standard
4329 Perhaps it is best if I described just what I did: first, create a 3
4330 \begin_inset Formula $\times$
4333 3 table and remove all the borders.
4334 Then re-add a bottom border to the top row, and a right border to the first
4336 Type in the values for the first column and set its alignment to
4358 and set that column's alignment to
4374 \begin_inset Formula $\times10^{18}$
4379 and set the extra column alignment to
4384 Finally type in the word
4388 in the middle column, highlight it and the blank entry to its right, and
4401 \begin_layout Subsection
4402 A Better Decimal-Alignment Solution
4405 \begin_layout Standard
4406 An alternative way to have decimal alignment in tables is through the
4411 Add the following to the LateX preamble:
4414 \begin_layout LyX-Code
4420 \begin_layout LyX-Code
4423 newcolumntype{d}[1]{D{.}{.}{#1}}
4426 \begin_layout Standard
4427 To have a column decimally aligned, enter in the
4429 Special Column Alignment
4435 dialog the following:
4438 \begin_layout LyX-Code
4439 d{number of decimals of the data}
4442 \begin_layout Standard
4443 To create extra column space just increase the number of decimals in
4448 Setting the multicolumn attribute for a single cell makes it insensitive
4449 to the decimal alignment which comes in handy as well.
4450 A drawback of this method is that math mode is not allowed in a column
4451 with decimal alignment except if the multicolumn attribute is set.
4454 \begin_layout Standard
4455 This method offers the same flexibility as the
4460 One could, for example, change the alignment separator, and have different
4461 alignment separators for different columns by defining multiple column
4462 types in the preamble.
4463 The syntax is as follows:
4466 \begin_layout LyX-Code
4467 D{inputsep}{outputsep}{decimal places}
4470 \begin_layout Standard
4471 The interested reader is directed towards the
4475 package documentation for more details.
4478 \begin_layout Section
4479 Itemize Bullet Selection
4480 \begin_inset LatexCommand \label{sec:bullet}
4487 \begin_layout Standard
4493 \begin_layout Subsection
4497 \begin_layout Standard
4498 LyX provides 216 bullet shapes that can be accessed from a simple dialog.
4499 Using this dialog you can easily specify what bullet shape to use at each
4500 level of an itemized list.
4501 These settings are document-wide so you won't be able to specify different
4502 sets of bullets for different paragraphs
4506 \begin_layout Standard
4507 Well, actually you can but you'll have to do it by hand.
4515 \begin_layout Subsection
4519 \begin_layout Standard
4520 Open the dialog by selecting the
4525 ocument\SpecialChar \menuseparator
4532 menu item and then select the
4542 \begin_layout Standard
4543 The dialog provides you with a table of bullet shapes.
4544 A column of buttons on the left of the table provides access to the six
4545 different panels of bullet shapes.
4546 The row of buttons across the top is used to select which bullet depth
4548 A text entry under the table shows the currently selected bullet shape's
4549 LaTeX equivalent and this can be edited if desired.
4550 If you do modify the text you will also need to specify any needed packages
4551 in the LaTeX preamble.
4554 \begin_layout Standard
4555 The six panels are divided up by the packages they require.
4556 The following table shows the mappings from button name to LaTeX packages.
4559 \begin_layout Standard
4561 \begin_inset Tabular
4562 <lyxtabular version="3" rows="7" columns="2">
4564 <column alignment="center" valignment="top" leftline="true" width="0pt">
4565 <column alignment="center" valignment="top" leftline="true" rightline="true" width="0pt">
4566 <row topline="true" bottomline="true">
4567 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
4570 \begin_layout Standard
4585 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
4588 \begin_layout Standard
4604 <row topline="true">
4605 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
4608 \begin_layout Standard
4623 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
4626 \begin_layout Standard
4641 <row topline="true">
4642 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
4645 \begin_layout Standard
4660 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
4663 \begin_layout Standard
4679 <row topline="true">
4680 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
4683 \begin_layout Standard
4698 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
4701 \begin_layout Standard
4717 <row topline="true">
4718 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
4721 \begin_layout Standard
4736 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
4739 \begin_layout Standard
4755 <row topline="true">
4756 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
4759 \begin_layout Standard
4774 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
4777 \begin_layout Standard
4793 <row topline="true" bottomline="true">
4794 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
4797 \begin_layout Standard
4812 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
4815 \begin_layout Standard
4838 \begin_layout Standard
4839 LyX doesn't stop you using bullets from packages you don't have.
4840 If you get errors from LaTeX when you try to view or print the file then
4841 its likely you are missing a package.
4842 LyX doesn't restrict your use since you may be editing locally and exporting
4846 \begin_layout Subsection
4850 \begin_layout Standard
4851 Select which bullet depth you want to change then select the bullet shape
4857 Any changes will not be visible in LyX, but are visible when viewing the
4858 document using xdvi or ghostview.
4861 \begin_layout Standard
4862 You can reset a bullet shape to the default simply by clicking your right
4863 mouse button on the appropriate bullet depth button.
4866 \begin_layout Standard
4871 want to have multiple sets of paragraphs with different sets of bullets
4872 in each then you're going to have to get your hands dirty.
4873 The itemize bullet selection dialog can help though because it provides
4874 you with the LaTeX code for a wide range of bullet shapes.
4875 To make your own custom paragraphs you have the following options:
4878 \begin_layout Standard
4882 \begin_layout Standard
4897 \begin_layout Standard
4901 \begin_layout Standard
4922 \begin_layout Itemize
4923 Use the LaTeX command
4929 to specify a new bullet shape for a given depth.
4930 You'll also need to save the current bullet shape so you can restore it
4932 In this itemized list the following LaTeX code was used to change the bullet
4933 used for the first depth.
4965 Note that the itemize depth is specified in Roman numerals as part of the
4975 \begin_layout Itemize
4979 \begin_layout Standard
4991 Specify each individual entry by starting each item with the bullet shape
4992 enclosed in square brackets and set as TeX.
4993 For example, this item was started with
5006 \begin_layout Standard
5010 \begin_layout Standard
5025 \begin_layout Standard
5026 You'll also need to revert the labelitem back to its previous setting for
5027 the global bullet shape settings to remain in effect.
5028 The way used here was:
5041 \begin_layout Chapter
5042 Special Document Classes
5045 \begin_layout Section
5049 \begin_layout Standard
5055 \begin_layout Standard
5056 \begin_inset VSpace bigskip
5062 \begin_layout Standard
5064 The AMS LaTeX layouts are set up to conform to suggested styles for mathematical
5065 papers to be submitted to American Mathematical Society publications.
5066 The layouts are not tailored to a specific journal, but easily can be.
5067 You should refer to the AMS documentation for specific instructions for
5068 each journal (usually it will entail only changing a single line in the
5070 That documentation is available on the Web at
5071 \begin_inset LatexCommand \url{http://www.ams.org}
5076 \begin_inset LatexCommand \url{ftp://ftp.ams.org/pub/tex/amslatex/}
5080 .These layouts are appropriate, and useful, for any mathematical writing.
5081 There are currently 4 distinct AMS LaTeX layouts:
5084 \begin_layout Enumerate
5085 amsart: The standard AMS-article format.
5086 All results and similar statements are numbered as
5087 \begin_inset Formula $(n.m)$
5090 , where the first number refers to the section, and the second refers to
5091 the total number of results (Theorems, Corollaries, Propositions, Definitions
5092 and Remarks, etc.) in that section.
5093 There are also many (but not all) environments available unnumbered, which
5094 is occasionally needed.
5095 Unnumbered environments indicated by an asterisk at the end.
5098 \begin_layout Enumerate
5099 amsart-seq: Here, numbering for each type of statement is in its own sequence,
5100 with no reference to the section number.
5101 There are also many (but not all) environments available unnumbered, which
5102 is occasionally needed.
5103 Unnumbered environments indicated by an asterisk at the end.
5106 \begin_layout Enumerate
5107 amsart-plain: This one is even more terse, since all the environments are
5111 \begin_layout Enumerate
5112 amsbook: the standard AMS book (really, monograph) format.
5113 Numbering is similar to the amsart layout, except that all numbering is
5115 \begin_inset Formula $(n.m.p)$
5118 , where the first number refers to the chapter, the second to the section,
5119 and the third is the number of the results (Theorems, Corollaries, Propositions
5120 , Definitions and Remarks, etc.) in that section.
5121 There are also many (but not all) environments available unnumbered, which
5122 is occasionally needed.
5123 Unnumbered environments indicated by an asterisk at the end.
5126 \begin_layout Standard
5127 Any AMS LyX file can be converted to either of the numbering schemes by
5128 simply changing the document class in the
5133 ocument\SpecialChar \menuseparator
5144 \begin_layout Subsection
5145 What these layouts provide
5148 \begin_layout Standard
5149 There is a long list of included environments provided by these layouts.
5150 Most mathematical papers or books will set as special statements most of
5151 these environments, in AMS-LaTeX there is an opportunity to define an unlimited
5152 variety of such declarations.
5153 However, the AMS recommends the environments that are available in LyX.
5154 The list of environments (not counting the standard environments such as
5157 sections, bibliography, title, author, date
5162 \begin_layout Description
5163 Theorem This is typically used for the statements of major results.
5165 \begin_inset Quotes eld
5173 \begin_inset Quotes erd
5176 appears in bold type, along with an automatically-determined number (an
5181 , is also available).
5182 The text is italicized.
5185 \begin_layout Description
5186 Corollary This is used for statements which follow fairly directly from
5187 previous statements.
5188 Again, these can be major results.
5196 \begin_layout Description
5197 Lemma These are smaller results needed to prove other statements.
5200 \begin_layout Description
5201 Proposition These are less major results which (hopefully) add to the general
5202 theory being discussed.
5205 \begin_layout Description
5206 Conjecture These are statements provided without justification, which the
5207 author does not know how to prove, but which seem to be true (to the author,
5211 \begin_layout Description
5212 Criterion A required condition.
5215 \begin_layout Description
5216 Algorithm A general procedure to be used.
5219 \begin_layout Description
5220 Axiom This is a property or statement taken as true within the system being
5224 \begin_layout Description
5225 Definition Guess what this is for.
5226 The font, both on-screen and in the output, is different for this environment
5227 than for the previous ones.
5229 \begin_inset Quotes eld
5233 \begin_inset Quotes erd
5236 ) is still set in boldface, along with the number, if any, but the rest
5240 \begin_layout Description
5241 Example Typeset similarly to Definition.
5244 \begin_layout Description
5248 \begin_layout Description
5252 \begin_layout Description
5256 \begin_layout Description
5257 Remark This environment is also a new type of theorem.
5258 This is set with the word Remark in italics, and the rest upright.
5261 \begin_layout Description
5262 Note Set similarly to the Remark environment.
5265 \begin_layout Description
5269 \begin_layout Description
5273 \begin_layout Description
5277 \begin_layout Description
5281 \begin_layout Description
5282 Case Generally, these are used to break up long arguments, using specific
5283 instances of some condition.
5284 The numbering scheme for cases is on its own, not together with other numbered
5289 \begin_layout Description
5293 \begin_layout Description
5297 \begin_layout Description
5299 \begin_inset Quotes eld
5307 \begin_inset Quotes erd
5310 is set in italics, but the rest is set upright.
5311 At the end of this environment (other environments can be nested within
5312 this one, of course) a QED symbol (usually a square, but it can vary with
5313 different styles) is placed.
5316 \begin_layout Description
5317 Address This should be the author's permanent address.
5320 \begin_layout Description
5321 Current\InsetSpace ~
5322 Address This should be the author's temporary address at the time
5323 of submission, if different from the Address.
5326 \begin_layout Description
5327 Email Author's e-mail address
5330 \begin_layout Description
5331 URL Author's Web address, if desired.
5334 \begin_layout Description
5335 Keywords Key words or phrases used to identify specific topics discussed
5339 \begin_layout Description
5340 Subjectclass These refer to the AMS Subject Classifications, published and
5343 Mathematical Reviews
5346 These are also available online at the AMS cites listed above.
5349 \begin_layout Description
5353 \begin_layout Description
5357 \begin_layout Description
5361 \begin_layout Standard
5362 In addition, these environments automatically provide the AMS LaTeX and
5364 They need to be available on your system in order to use these environments.
5367 \begin_layout Section
5371 \begin_layout Standard
5376 can be used to type letters according to German conventions.
5377 A template file is included in
5379 .../lyx/share/templates
5381 for you to use as a starting point.
5384 \begin_layout Section
5388 \begin_layout Standard
5393 provides an alternative to the standard
5398 It provides similar functionality, but you might prefer this layout with
5399 sans serif sections, headings, and more.
5402 \begin_layout Section
5406 \begin_layout Standard
5412 \begin_layout Subsection
5416 \begin_layout Standard
5417 This section describes how LyX can be used to write articles for submission
5418 to the scientific journal
5420 Astronomy and Astrophysics
5423 \begin_inset LatexCommand \url[www.edpsciences.fr/aa/]{http://www.edpsciences.fr/aa/}
5435 Version 5.01 of the document class
5440 This package can be downloaded from the ftp site
5443 \begin_layout Standard
5444 \begin_inset VSpace medskip
5450 \begin_layout Standard
5452 \begin_inset LatexCommand \url{ftp://ftp.edpsciences.org/pub/aa/readme.html}
5459 \begin_layout Standard
5460 \begin_inset VSpace medskip
5466 \begin_layout Standard
5467 A manual comes together with that package, and this text is not meant to
5468 replace the original manual but merely a short guide how to realize the
5469 correct form of your paper.
5473 \begin_layout Standard
5474 Please note that the publisher of the journal was changed from Springer
5475 to EDP Sciences starting January 1, 2001.
5476 That change implicated also some slight changes of the style files, namely
5477 the removal of the thesaurus command.
5478 The LyX class aa supports the newest version of these style files, V 5.01.
5479 If you have an older version installed, please upgrade.
5480 For compatibility, the old (version 4) layout has been kept as
5485 Please refer to the comments in
5487 LyXDir/layouts/aapaper.layout
5492 \begin_layout Subsection
5496 \begin_layout Standard
5497 It is recommended you start from the example template distributed with LyX.
5498 If you are not using a template, note the following settings:
5501 \begin_layout Itemize
5511 ocument\SpecialChar \menuseparator
5518 dialog (OK, that one was obvious).
5521 \begin_layout Itemize
5522 Don't change the option
5532 The whole layout is done by the macros, you shouldn't change anything.
5535 \begin_layout Subsection
5539 \begin_layout Standard
5540 First thing to enter is the header information.
5541 It consists of seven entries, of which some are optional.
5545 \begin_layout Itemize
5553 \begin_layout Itemize
5561 \begin_layout Itemize
5569 \begin_layout Itemize
5577 \begin_layout Itemize
5582 : [optional] if more than one author: whom to contact for offprint requests.
5585 \begin_layout Itemize
5590 : [optional] mail address for contacts.
5593 \begin_layout Itemize
5601 Received: <date>; Accepted <date>
5604 \begin_layout Standard
5605 There is no need to issue the
5611 command, this is done automatically by LyX when the header is finished.
5612 Although the order of the single header entries doesn't matter it is advised
5613 to keep the above sequence, just to get the best optics and meets the layout
5614 of the real document.
5617 \begin_layout Standard
5618 If you want to place footnotes in the header block, e.g.
5622 \begin_layout Standard
5630 to state your present address, just use the standard footnote via
5635 nsert\SpecialChar \menuseparator
5643 LyX will automagically use the term
5652 \begin_layout Standard
5653 In addition to these topics, the macros use three additional LaTeX commands
5654 that have no counterpart in LyX:
5657 \begin_layout Itemize
5664 to separate different names for more than one author and institute, respectivel
5668 \begin_layout Itemize
5675 to mark corresponding author/institute pairs.
5676 The institutes are numbered sequentially as they appear in the
5680 field, so you have to put a marker to each author.
5683 \begin_layout Itemize
5690 to supply an email address for fast contact.
5693 \begin_layout Standard
5694 In all cases, the appropriate command has to be entered in LyX an marked
5700 \begin_layout Subsection
5704 \begin_layout Standard
5705 The abstract should immediately follow the header block.
5706 With version 5 the abstract environment was changed to a command, and there
5707 is now a resctriction to only one paragraph.
5708 In addition, it should contain an entry with the keywords.
5709 This is not yet implemented for LyX, therefore you have to enter the LaTeX
5716 by hand and mark it as LaTeX code.
5717 Refer to the example paper.
5720 \begin_layout Subsection
5721 Supported environments
5724 \begin_layout Standard
5725 The A&A paper layout supports the following environments for structuring
5729 \begin_layout Itemize
5735 \begin_layout Itemize
5741 \begin_layout Itemize
5747 \begin_layout Itemize
5753 \begin_layout Itemize
5759 \begin_layout Itemize
5765 \begin_layout Itemize
5771 \begin_layout Itemize
5777 \begin_layout Itemize
5783 \begin_layout Itemize
5789 \begin_layout Itemize
5795 \begin_layout Itemize
5801 \begin_layout Subsection
5802 Commands not supported by LyX
5805 \begin_layout Standard
5806 Some commands are not yet supported by the
5811 Some have already been mentioned.
5812 For the sake of completeness, they are listed all together here:
5815 \begin_layout Itemize
5823 \begin_layout Itemize
5831 \begin_layout Itemize
5839 \begin_layout Itemize
5847 \begin_layout Itemize
5855 \begin_layout Itemize
5863 \begin_layout Itemize
5871 \begin_layout Itemize
5879 \begin_layout Standard
5880 If you want to use any of these commands, you have to enter them yourself.
5883 Do not forget to mark them as LaTeX code!
5886 \begin_layout Subsection
5887 Figure and Table Floats
5890 \begin_layout Standard
5891 LyX provides support for the necessary float environments
5893 figure, figure*, table
5899 , therefore we won't tell much about it here.
5906 Just remember that tables should be left-aligned.
5907 For that, select the table and change the alignment in
5912 dit\SpecialChar \menuseparator
5917 aragraph\InsetSpace ~
5921 \begin_layout Standard
5926 only one special thing: the figures with caption besides the figure.
5927 To create such a figure, you have to do the following:
5930 \begin_layout Enumerate
5931 Create a wide figure float:
5936 nsert\SpecialChar \menuseparator
5941 t\SpecialChar \menuseparator
5944 , then right click in the figure and select
5956 \begin_layout Enumerate
5957 Enter your caption text.
5960 \begin_layout Enumerate
5965 to move the cursor above the caption.
5968 \begin_layout Enumerate
5972 \begin_layout Enumerate
5973 Position the cursor behind the figure and insert a horizontal fill:
5978 nsert\SpecialChar \menuseparator
5986 \SpecialChar \menuseparator
5989 orizontal\InsetSpace ~
5995 \begin_layout Enumerate
5996 Switch to LaTeX mode:
6004 \begin_layout Enumerate
6014 Do not close the brace!
6017 \begin_layout Enumerate
6018 Position the cursor behind the caption text, switch to LaTeX mode and insert
6029 \begin_layout Standard
6030 Also, refer to the figures in the example paper.
6033 \begin_layout Subsection
6037 \begin_layout Standard
6038 For submission, the paper has to be formated in a special double-spacing
6040 For this purpose, you have to give the option
6044 to the documentclass.
6045 This must be done using the extra class options field in the
6050 ocument\SpecialChar \menuseparator
6058 Just enter the string
6065 \begin_layout Subsection
6069 \begin_layout Standard
6074 directory contains an example paper written with LyX.
6075 It is the example paper from the original macro package, translated to
6077 Use it for inspiration, and compare the original LaTeX code with LyX way
6081 \begin_layout Section
6085 \begin_layout Standard
6091 \begin_layout Subsection
6095 \begin_layout Standard
6096 AASTeX is a set of macros produced by the American Astronomical Society
6097 to facilitate electronic manuscript submission to the three journals they
6098 publish: the Astrophysical Journal (including the Letters and Supplement),
6099 the Astronomical Journal, and the Publications of the Astronomical Society
6101 LyX has proven to be an excellent tool for generating these documents,
6102 especially given its equation, citation, and figure handling capabilities.
6103 LyX requires version 5.0 (or higher) of these macros; preferably 5.2, which
6104 is the version described here, or higher.
6105 Versions prior to 5.0 are intended for use with LaTeX2.09 and are fundamentally
6106 incompatible with LyX.
6107 The AASTeX package may be downloaded from the AASTeX Web site
6110 \begin_layout Standard
6111 \begin_inset VSpace medskip
6117 \begin_layout Standard
6119 \begin_inset LatexCommand \url{http://www.journals.uchicago.edu/AAS/AASTeX}
6126 \begin_layout Standard
6127 \begin_inset VSpace medskip
6133 \begin_layout Standard
6134 A complete user guide is contained in that package and you should familiarize
6135 yourself with it thoroughly before embarking on writing a paper in LyX.
6136 LyX will not reduce the need to figure out all the AASTeX commands, it
6137 will only reduce the drudgery of typing everything in.
6138 It is your responsibility to ensure that the final exported LaTeX document
6139 conforms completely to the requirements of the journal to which you are
6140 submitting your paper.
6143 \begin_layout Subsection
6144 Starting a New Paper
6147 \begin_layout Standard
6148 I strongly suggest that you start with the AASTeX template file.
6154 ile\SpecialChar \menuseparator
6161 , enter the new file name, then choose the
6166 This will show the most common fields found in a manuscript.
6167 Simply overwrite the existing text (including the brackets,
6171 ) with the correct information.
6172 Many of the AASTeX commands and environments can be implemented directly
6173 in LyX, but some cannot: most noticeably
6185 , which should stick out like a sore thumb if you actually just opened the
6187 For commands such as these, the LaTeX code must be entered directly and
6189 Such commands are referred to as ERT, or Evil Red Text.
6190 I tried to minimize the amount of ERT needed in an AASTeX document, but
6191 there is still a bit more required than any of us would like.
6194 \begin_layout Subsection
6195 Finishing Your Paper
6198 \begin_layout Standard
6199 When the paper is finished to your satisfaction and previews/prints correctly,
6201 \begin_inset Quotes eld
6205 \begin_inset Quotes erd
6208 actions which need to be done before you submit it to the journals.
6212 \begin_layout Enumerate
6213 Export your paper as a LaTeX file (
6218 ile\SpecialChar \menuseparator
6223 xport\SpecialChar \menuseparator
6234 \begin_layout Enumerate
6239 file with your favorite text editor
6243 \begin_layout Enumerate
6244 remove the comment lines before the
6253 \begin_layout Enumerate
6258 usepackage...{fontenc}
6260 line if it appears (usually just after
6275 \begin_layout Enumerate
6276 remove everything between (and including) the
6288 commands, except for any commands you specifically put into the LaTeX preamble
6289 (which should appear immediately after the
6290 \begin_inset Quotes eld
6293 User specified LaTeX commands
6294 \begin_inset Quotes erd
6305 \begin_layout Enumerate
6306 Run the resulting file through LaTeX to make sure it still processes correctly.
6309 \begin_layout Enumerate
6310 Reread the journal requirements to make sure your filenames and formats
6314 \begin_layout Enumerate
6318 \begin_layout Subsection
6319 Comments On Specific Commands
6322 \begin_layout Standard
6323 I will not describe the detailed usage of the individual AASTeX commands:
6324 the AASTeX User Guide (
6328 ) gives a good description of each.
6329 Thus it's probably easiest for me to go down the list as found in the guide
6330 and offer comments where necessary.
6331 So let's begin \SpecialChar \ldots{}
6335 \begin_layout Subsubsection
6336 Things that work as expected
6339 \begin_layout Standard
6343 \begin_layout Standard
6354 \begin_layout Standard
6355 Because they work as you might expect, I simply list them and the section
6456 begin{thebibliography}
6464 (2.13.2), all the cite commands and their variations (2.13.2), the generic
6465 graphicx figure commands (2.14.1),
6489 (2.15.4, amongst other places),
6516 \begin_layout Standard
6517 The following style options also work correctly:
6538 Simply put them in the
6544 Layout\SpecialChar \menuseparator
6550 \begin_layout Standard
6554 \begin_layout Standard
6565 \begin_layout Subsubsection
6566 Things that work, but require more comment
6569 \begin_layout Standard
6570 The following items work, but require a little more discussion:
6573 \begin_layout Itemize
6574 These items are reserved for use by the journal editors, but you can put
6575 them into the LaTeX preamble if you feel compelled to do so:
6608 \begin_layout Itemize
6609 These items may be placed in the LaTeX preamble, and are included as blanks
6610 in the template file:
6631 \begin_layout Itemize
6638 (2.3) -- can only be used
6639 \begin_inset Quotes eld
6643 \begin_inset Quotes erd
6646 , not in the middle of a paragraph.
6647 Use ERT if you need to embed it.
6650 \begin_layout Itemize
6657 (2.3) -- will have extra {} after it.
6658 This should not cause an error.
6661 \begin_layout Itemize
6668 (2.6) -- can only be used
6669 \begin_inset Quotes eld
6673 \begin_inset Quotes erd
6676 , not in the middle of a paragraph.
6677 Use ERT if you need to embed it.
6680 \begin_layout Itemize
6687 (2.8) -- can't insert a cross-reference tag, you must type the tag name
6691 \begin_layout Itemize
6698 (2.8) -- same as for
6705 \begin_layout Itemize
6712 (2.9) -- will have extra {} after it.
6713 This should not cause an error.
6716 \begin_layout Itemize
6723 (2.11) -- will have extra {} after it.
6724 This should not cause an error.
6727 \begin_layout Itemize
6734 (2.14.2) -- you can insert an optional filename argument by placing the cursor
6735 at the beginning of the text and selecting
6737 Insert\SpecialChar \menuseparator
6742 \begin_inset Quotes eld
6746 \begin_inset Quotes erd
6749 inserts an optional argument of the type needed by
6756 Hopefully it will be renamed someday.
6759 \begin_layout Itemize
6772 for the catalog ID optional parameter
6775 \begin_layout Itemize
6788 for the catalog ID optional parameter
6791 \begin_layout Subsubsection
6792 Things not implemented, use ERT
6795 \begin_layout Standard
6799 \begin_layout Standard
6810 \begin_layout Standard
6833 setcounter{equation}
6835 (2.12), Journal name abbreviations (2.13.4),
6871 (2.15.4, insert it as the first element in the lefthand cell after where
6873 Don't use any of LyX's rules in the table),
6885 (2.15.5), much of Misc (2.17, except
6936 \begin_layout Standard
6940 \begin_layout Standard
6951 \begin_layout Subsubsection
6952 Things that cannot be implemented
6955 \begin_layout Standard
6956 \SpecialChar \ldots{}
6957 at least in any meaningful sort of way, so I suggest ignoring them.
6958 They are the references environment (2.13.3), and the deluxetable environment
6960 If you really, really need to use deluxetable, I suggest editing it in
6961 a separate file with a text editor, then using
6966 nsert\SpecialChar \menuseparator
6974 to include it in your LyX document.
6979 file to see an example of this.
6982 \begin_layout Subsection
6983 FAQs, Tips, Tricks, and Other Ruminations
6986 \begin_layout Subsubsection
6987 Getting LyX and AASTeX to cooperate
6990 \begin_layout Standard
6991 It can be a bit tricky to get LyX to recognize a new layout and document
6993 When all else fails, do this:
6996 \begin_layout Enumerate
6997 Make certain that LaTeX can find AASTeX.
6998 Copy sample.tex (and perhaps table.tex) from the AASTeX distribution into
6999 a directory completely unrelated to LaTeX or AASTeX and run LaTeX on
7006 \begin_layout Enumerate
7013 /usr/.../share/lyx/layouts
7022 \begin_layout Enumerate
7028 ools\SpecialChar \menuseparator
7035 in LyX, then restart LyX.
7038 \begin_layout Enumerate
7039 Open a regular new file, not from a template.
7040 Does AASTeX appear in the class list in
7045 ocument\SpecialChar \menuseparator
7055 \begin_layout Standard
7056 If you get a warning from an existing AASTeX document about not being able
7057 to find the AASTeX layout or a message about
7058 \begin_inset Quotes eld
7061 You should not mix title layouts with normal ones
7062 \begin_inset Quotes erd
7065 , things haven't been installed correctly.
7068 \begin_layout Subsubsection
7069 LaTeX error processing a table
7072 \begin_layout Standard
7073 LyX, by default, attempts to center the table caption/title.
7074 This seems to produce a bad interaction in AASTeX so you should click somewhere
7075 in the caption/title, then select
7080 dit\SpecialChar \menuseparator
7085 aragraph\InsetSpace ~
7100 This took care of it for me.
7103 \begin_layout Subsubsection
7105 \begin_inset LatexCommand \label{cite}
7112 \begin_layout Standard
7113 A couple of things: 1) I have noticed some funny spacing in the reference
7114 entries in the text.
7115 When you enter the bibliography item data, make sure their is
7119 space between the last author and the parenthesis setting off the year;
7134 2) Entering the references at all is not obvious.
7135 The easiest thing is to start typing your first reference at the end of
7136 the document, then mark it as type
7141 That will put a small gray box in front of what you just typed.
7142 Click on the box to fill in the rest of the information.
7143 For new references, go to the end of an existing reference and press return.
7144 That will create a new line with its own box, etc.
7147 \begin_layout Subsubsection
7151 \begin_layout Standard
7152 Even though AASTeX provides its own figure commands (
7158 , for example), I much prefer LaTeX's standard figure commands (with the
7167 commands as ERT into a Figure Float box if you desire, but I never
7168 have much luck getting the layout right.
7169 With the standard graphics, LyX will insert a
7173 usepackage{graphicx}
7175 command into the LaTeX preamble and handle the figures in the standard
7176 LaTeX2e way, interspersing the figures in the text.
7177 I believe ApJ accepts figures exactly this way now; AJ might still use
7179 \begin_inset Quotes eld
7182 stack everything at the end
7183 \begin_inset Quotes erd
7189 \begin_layout Subsubsection
7190 Things I could have done, but didn't
7193 \begin_layout Standard
7195 \begin_inset Quotes eld
7199 \begin_inset Quotes erd
7202 things I could have implemented, but chose not to.
7203 For instance, I saw no point in double-spacing the text in the LyX window,
7204 even though it is double-spaced in the paper manuscript.
7205 Also, I chose not to make separate layouts for the preprint and preprint2
7207 Since I assume you will spend most of your time in the plain manuscript
7208 mode anyway, I decided not to chew up more disk space with this.
7212 \begin_layout Subsection
7216 \begin_layout Standard
7217 Your mileage may vary.
7218 I've now had papers published by both ApJ and AJ that have had 98% of the
7219 effort done in LyX; the last 2% was the LaTeX post-processing and a few
7221 I have had no trouble with the submission process, and I'm sure the journals
7222 were never aware that there might be a difference.
7223 So, go forth and publish!
7226 \begin_layout Section
7230 \begin_layout Standard
7233 Panayotis Papasotiriou
7236 \begin_layout Subsection
7240 \begin_layout Standard
7241 The ijmpd package is a set of macros that facilitates electronic manuscript
7244 International Journal of Modern Physics D
7246 published by World Scientific.
7247 The name of the document class is
7252 This file, together with instructions for the authors, can be downloaded
7254 \begin_inset LatexCommand \url{http://www.worldscinet.com/ijmpd/mkt/guidelines.shtml}
7259 The ijmpd package is a modified version of the standard
7260 \begin_inset Quotes eld
7264 \begin_inset Quotes erd
7268 Most of its features are supported by LyX.
7269 I have recently used LyX successfully to write an article submitted to
7272 International Journal of Modern Physics D
7277 \begin_layout Subsection
7281 \begin_layout Standard
7282 As usual, the easiest way to write a paper is to start with a template.
7288 ile\SpecialChar \menuseparator
7300 This will give an (almost) empty document that includes the most common
7301 fields found in a manuscript.
7302 Simply overwrite the existing text (including the brackets,
7306 ) with the correct information.
7307 You should keep in mind the following remarks.
7310 \begin_layout Enumerate
7311 LyX won't let you change the font size and the page style of the document,
7312 because the ijmpd package does not allow such modifications.
7315 \begin_layout Enumerate
7316 The ijmpd package requires that the language of the document should not
7318 Before previewing your paper, be sure that the babel package is not used.
7319 To do this, click on
7324 ools\SpecialChar \menuseparator
7338 checkbox in the language settings, and click on
7349 , if you wish to make this change permanent).
7352 \begin_layout Enumerate
7353 Two new environments, named
7354 \begin_inset Quotes eld
7358 \begin_inset Quotes erd
7362 \begin_inset Quotes eld
7366 \begin_inset Quotes erd
7369 are available (their use is obvious).
7372 \begin_layout Enumerate
7373 Appendices may be added to the paper.
7374 LyX offers a special environment, called
7375 \begin_inset Quotes eld
7379 \begin_inset Quotes erd
7382 which marks the beginning of the appendix.
7383 An appendix can contain normal sections, subsections, or subsubsections.
7386 \begin_layout Enumerate
7387 The ijmpd package implements table captions quite differently than LyX does.
7388 As a result, a table created by LyX is printed correctly, but its caption
7390 If you need table captions, you should implement the whole table float
7395 file, then include this file to the LyX document (
7400 nsert\SpecialChar \menuseparator
7409 Details on how to create an ijmpd table float can be found in the file
7414 , which is included in the ijmpd package.
7417 \begin_layout Subsection
7418 Preparing a paper for submission
7421 \begin_layout Standard
7422 Before you submit your paper you must export the LyX document as a LaTeX
7428 ile\SpecialChar \menuseparator
7433 xport\SpecialChar \menuseparator
7440 ), then make the following changes to the resulting
7447 \begin_layout Enumerate
7448 Remove the comment lines before the
7457 \begin_layout Enumerate
7458 Remove everything between (and including) the
7470 commands, except for any commands you specifically put into the LaTeX preamble.
7473 \begin_layout Standard
7478 file should be saved and processed through LaTeX as many times as necessary.
7479 You may also want to check the resulting
7486 \begin_layout Subsection
7490 \begin_layout Standard
7491 The use of ERT is optional, and is reduced to three commands, which affect
7492 the look of the page.
7493 If you started writing your paper by using the
7497 template, the ERT needed is already in its place; you usually don't need
7499 You may only change the first ERT to specify the information printed to
7500 the top of odd and even pages (authors' names and short paper's title,
7502 This ERT must have the form
7506 markboth{Authors' Names}{Short Paper's Title}
7511 \begin_layout Section
7515 \begin_layout Standard
7518 Panayotis Papasotiriou
7521 \begin_layout Subsection
7525 \begin_layout Standard
7526 The Kluwer package is a set of macros produced by Kluwer Academic Publishers
7527 that facilitates electronic manuscript submission to the journals they
7529 Most known of them (at least in my domain of interest) are
7531 Astrophysics and Space Science
7537 , but there are many others (see a complete list at
7538 \begin_inset LatexCommand \url{http://www.wkap.nl/jrnllist.htm/JRNLHOME}
7543 The Kluwer package may be downloaded from the site
7544 \begin_inset LatexCommand \url{http://www.wkap.nl/kaphtml.htm/STYLEFILES}
7549 A complete user guide is contained in that package (but it can also be
7550 downloaded separately).
7553 \begin_layout Standard
7554 LyX supports many features of the package but not everything.
7555 However, the ERT needed is reduced to some
7556 \begin_inset Quotes eld
7560 \begin_inset Quotes erd
7563 commands of the package (see\InsetSpace ~
7565 \begin_inset LatexCommand \ref{subsec:kluwer_peculiarities}
7570 I have recently used LyX to write an article submitted to the
7572 Astrophysics and Space Science
7574 without any problem.
7577 \begin_layout Subsection
7581 \begin_layout Standard
7582 The easiest way to write a paper is to start with the Kluwer template file.
7585 File\SpecialChar \menuseparator
7597 This will give an (almost) empty document that includes the most common
7598 fields found in a manuscript and a short description of their use.
7599 As in most templates, simply overwrite the existing text (including the
7604 ) with the correct information.
7607 \begin_layout Subsection
7608 Preparing a paper for submission
7611 \begin_layout Standard
7612 As in the AASTeX package, before you submit your paper to a journal you
7614 \begin_inset Quotes eld
7618 \begin_inset Quotes erd
7624 \begin_layout Enumerate
7625 Export your paper as a LaTeX file.
7626 To do this, click on
7631 ile\SpecialChar \menuseparator
7636 xport\SpecialChar \menuseparator
7647 \begin_layout Enumerate
7652 file with a text editor and make the following changes
7656 \begin_layout Enumerate
7657 remove the comment lines before the
7666 \begin_layout Enumerate
7667 remove everything between (and including) the
7679 commands, except for any commands you specifically put into the LaTeX preamble.
7682 \begin_layout Standard
7691 \begin_layout Enumerate
7696 file through LaTeX as many times as necessary (usually up to three).
7699 \begin_layout Enumerate
7704 document using, e.g.,
7708 , and check if everything is ok (it should, if you didn't make any mistake).
7711 \begin_layout Subsection
7712 \begin_inset Quotes eld
7716 \begin_inset Quotes erd
7719 of the Kluwer package
7720 \begin_inset LatexCommand \label{subsec:kluwer_peculiarities}
7727 \begin_layout Standard
7728 The Kluwer package has the following
7729 \begin_inset Quotes eld
7733 \begin_inset Quotes erd
7739 \begin_layout Enumerate
7740 It is possible to write multiple articles in the same LaTeX file
7744 \begin_layout Standard
7745 I can't imagine any good reason to do this.
7751 Each article must be included in the environment
7752 \begin_inset Quotes eld
7756 \begin_inset Quotes erd
7760 Unfortunately, this environment cannot be omitted, even if you write just
7762 Therefore, each article starts with the command
7768 and, obviously, ends with the command
7775 Although this can be implemented in LyX, I didn't included it, since it
7776 looks ugly and can confuse the novice user.
7777 Therefore, you need to enter them directly and mark them as LaTeX code
7779 \begin_inset Quotes eld
7783 \begin_inset Quotes erd
7789 \begin_layout Enumerate
7790 Information given at the beginning of the article (i.e., title, subtitle,
7791 author, institution, running title, running author, abstract and keywords)
7792 must be included in an environment called
7793 \begin_inset Quotes eld
7797 \begin_inset Quotes erd
7801 This is not implemented in LyX, so you must enter title, subtitle etc.
7802 between two ERT lines (
7817 \begin_layout Enumerate
7818 According to the user manual, the label of each bibliography item must be
7842 \begin_layout Standard
7847 template takes care of all these
7848 \begin_inset Quotes eld
7852 \begin_inset Quotes erd
7856 If you start a new paper using this template you don't need to do anything
7861 \begin_layout Enumerate
7862 don't delete the ERT included in the template, and
7865 \begin_layout Enumerate
7866 copy the example bibliography item included in the template and modify it
7867 as necessary to enter new bibliography items.
7870 \begin_layout Section
7874 \begin_layout Standard
7880 \begin_layout Subsection
7884 \begin_layout Standard
7885 The LyX document classes
7887 article (koma-script)
7891 report (koma-script)
7909 correspond to the LaTeX document classes
7926 of the Koma-Script family.
7927 They are replacements for the standard document classes
7943 , resp., and fit better to European typography conventions in a number of
7947 \begin_layout Itemize
7948 Standard character size is 11pt in
7950 article (koma-script)
7954 report (koma-script)
7962 letter (koma-script)
7967 \begin_layout Itemize
7968 Headings, labels of the description environment, and a number of elements
7971 letter (koma-script)
7973 document class are set in a bold sans serif font.
7977 \begin_layout Standard
7978 There is a big difference between the bold sans serif old cm fonts and new
7979 ec fonts, especially in the appearance of headings.
7980 In comparison, the ec bold sans serif fonts look a bit thin.
7981 Here the LaTeX package
7988 helps to produce the
7989 \begin_inset Quotes eld
7993 \begin_inset Quotes erd
7996 appearance when using the ec fonts.
8001 The numbering of chapter headings is made in the same way as the numbering
8002 of section headings, that is without the extra line
8003 \begin_inset Quotes eld
8006 Chapter\SpecialChar \ldots{}
8008 \begin_inset Quotes erd
8012 In addition, the appearance of the headings can be modified by using a
8013 number of options (in LyX to be entered in the field
8027 ayout\SpecialChar \menuseparator
8035 A detailed German description of these options can be found in the Koma-Script
8043 \begin_layout Itemize
8044 The main means in the Koma-Script document classes to design the type area
8053 (in LyX to be entered in the extra class options field in the dialog
8058 ocument\SpecialChar \menuseparator
8066 They make a clearer modification of page margins possible as do the options
8072 ocument\SpecialChar \menuseparator
8080 A detailed German description of these and other type area options can
8081 be found in the Koma-Script documentation
8088 \begin_layout Itemize
8089 The LaTeX document classes of the Koma-Script family define a number of
8090 additional commands.
8091 Those part of it which makes sense in LyX is implemented in corresponding
8095 \begin_layout Standard
8096 A detailed German description of the LaTeX document classes of the Koma-Script
8097 family can be found in the Koma-Script documentation
8105 \begin_layout Standard
8106 There is an English translation
8110 , but it is not a complete one.
8115 The following sections describe only those aspects, which are relevant
8119 \begin_layout Subsection
8120 article (koma-script), report (koma-script), and book (koma-script)
8123 \begin_layout Standard
8124 The document classes
8126 article (koma-script)
8130 report (koma-script)
8140 are implemented in the layout files
8153 They contain all the paragraph types of the corresponding standard document
8166 , resp., partly modified, with the exception of the LyX specific
8170 -type, which is replaced by the new
8174 -type having the same functionality.
8179 -Type there is a number of new paragraph types added.
8186 letter (koma-script)
8191 \begin_layout Itemize
8200 : are equivalents to
8208 , resp., additionally inserting an entry in the table of contents.
8217 are not contained in
8219 article (koma-script)
8224 \begin_layout Itemize
8241 , resp., additionally clearing running heads.
8248 article (koma-script)
8254 \begin_layout Standard
8267 report (koma-script)
8269 , but since this is identical to
8273 , is has not been implemented in LyX.
8281 \begin_layout Itemize
8286 : generates a heading directly above the following paragraph in the standard
8287 character size without affecting the structure of the document.
8290 \begin_layout Itemize
8299 are special captions which respect the different space settings needed for
8300 captions placed above or below an element (if you follow strict typographic
8301 rules, you might want to place table captions always above the table).
8302 You can also use the class option
8319 You need at least Koma-Script version 2.8q to use this.
8322 \begin_layout Itemize
8327 : can be used to set a bonmot, e.
8331 \begin_layout Standard
8343 \begin_layout Standard
8351 at the beginning of a chapter.
8352 If you use the optional argument (
8357 nsert\SpecialChar \menuseparator
8361 ), you can insert the dictum's author there.
8362 Dictum and author are separated by a line.
8363 You need at least Koma-Script version 2.8q to use this.
8370 article (koma-script)
8375 \begin_layout Standard
8376 The following types, together with the standard types
8388 , form the title area of the document.
8389 They must be entered ahead of the first
8390 \begin_inset Quotes eld
8394 \begin_inset Quotes erd
8401 \begin_layout Standard
8402 The corresponding LaTeX commands must appear before the
8413 When such a type is used more than once, the latter usage overwrites the
8414 former one, that means, for every type only the latest usage is valid.
8415 The order of the different types however has, like
8427 , no effect on the appearance of the produced document.
8430 \begin_layout Itemize
8435 : produces a centered paragraph above the ordinary title (
8447 ) for the subject of the document.
8450 \begin_layout Itemize
8455 : produces a centered paragraph below the ordinary title (
8467 ) for the publishers' name.
8470 \begin_layout Itemize
8477 report (koma-script)
8483 produces a centered paragraph on its own page behind the title page, or
8486 article (koma-script)
8488 produces a centered paragraph below the ordinary title (
8507 \begin_layout Itemize
8512 : produces a left aligned paragraph above the ordinary title (
8528 ) for a document`s head.
8531 \begin_layout Itemize
8536 : produces in a double-sided print in
8538 report (koma-script)
8544 a left-aligned paragraph at the top of the title page`s back or has no
8545 effect in a single-sided print or in
8547 article (koma-script)
8552 \begin_layout Itemize
8557 : produces in a double-sided print in
8559 report (koma-script)
8565 a left-aligned paragraph at the bottom of the title page`s back or has
8566 no effect in a single-sided print or in
8568 article (koma-script)
8573 \begin_layout Itemize
8578 : produces a special
8579 \begin_inset Quotes eld
8583 \begin_inset Quotes erd
8586 page ahead of the actual document containing a paragraph without special
8590 \begin_layout Standard
8591 The layout files for the document classes
8593 article (koma-script)
8597 report (koma-script)
8608 This is thought of as a place to define your own types.
8613 in your personal layout directory and edit the file!
8616 \begin_layout Subsection
8617 letter (koma-script)
8620 \begin_layout Standard
8624 \begin_layout Standard
8635 \begin_layout Standard
8639 letter (koma-script)
8641 is implemented in the layout file
8646 It contains all the paragraph types of the corresponding standard document
8651 , partly modified, with the exception of the LyX specific types
8663 type, which is replaced by the new
8668 In addition, it contains, in contrast to the standard document class, the
8686 Furthermore, there are a number of new letter specific types.
8689 \begin_layout Standard
8693 \begin_layout Standard
8704 \begin_layout Standard
8705 The appearance of the letter produced by this document class can be controlled
8706 by a number of LaTeX commands, which you can put in the LaTeX preamble.
8710 \begin_layout Standard
8711 For example, the standard appearance of the letter`s heading, consisting
8712 of name and address, is quite self-willed.
8714 \begin_inset Quotes eld
8718 \begin_inset Quotes erd
8721 heading is produced by the following LaTeX commands in the preamble:
8724 \begin_layout LyX-Code
8734 \begin_layout LyX-Code
8750 \begin_layout LyX-Code
8760 \begin_layout LyX-Code
8780 A detailed German description of such LaTeX commands can be found in the
8781 Koma-Script documentation
8786 With it, the letter's author can produce his personal letter layout.
8789 \begin_layout Standard
8798 define the beginning of the letter and must be used in every letter.
8799 To emphasize them in the LyX document class, they are marked with the letter
8810 It is possible to write any number of letters in one file.
8815 type produces a new letter using the same addressee and a
8819 type produces a new addressee.
8836 are ordinary paragraph types and can also be used several times in one
8837 and the same letter.
8840 \begin_layout Itemize
8845 : produces a paragraph for the addressee and implicitly defines the beginning
8849 \begin_layout Itemize
8854 : produces a paragraph for the form of address and implicitly produces a
8858 \begin_layout Itemize
8863 : produces a paragraph for a close.
8866 \begin_layout Itemize
8871 : produces a paragraph for a postscript.
8874 \begin_layout Itemize
8879 : produces a paragraph for a distribution list.
8882 \begin_layout Itemize
8887 : produces a paragraph for enclosures.
8890 \begin_layout Standard
8931 are input types provided with a label to enter information, which will
8932 be processed by the document class.
8936 \begin_layout Standard
8937 It could be seen as a matter of inconsequence, that the types
8945 described above are not such input types as well.
8946 Because of the special meaning of those types, however, I have implemented
8947 them as ordinary paragraph types with a one letter mark in the left margin.
8948 Moreover, it would affect my feeling of symmetry, if the
8956 type had such a serious different appearance.
8961 The types must be used ahead of the corresponding
8968 \begin_layout Standard
8969 An implementation of these types in a WYSIWYG fashion does not seem to make
8970 sense, because the real appearance of the produced letter does not only
8971 depend on the usage of the particular type, but also on other factors.
8972 For example, a signature entered in the
8976 type will in the standard behavior appear in the produced letter only,
8977 when in the same letter also a
8982 The entered value of the
8986 type will in the standard behavior not appear in the produced letter at
8988 The possibility to design the letter`s heading freely is already indicated
8989 in a footnote above.
8992 \begin_layout Standard
8993 The input types can also be used as empty paragraphs.
8994 This makes sense e.\InsetSpace ~
9005 type is not used at all, in the standard behavior the value of the
9009 type is used as signature, whereas if an empty
9013 type is used, no signature value is defined.
9016 \begin_layout Standard
9017 By using the input types it is possible to write a letter template, containing
9018 filled input types with your personal dates (name, address, etc.) and empty
9019 input types for other dates you want to enter.
9022 \begin_layout Itemize
9027 : sender's name, in the standard behavior appears as a centered paragraph
9028 in small caps in the letter`s heading.
9031 \begin_layout Itemize
9036 : sender's signature, in the standard behavior appears below the
9045 type is used, the value of the
9049 type appears instead.
9052 \begin_layout Itemize
9057 : sender's address, in the standard behavior appears in a centered paragraph
9058 in the letter`s heading below the sender's name.
9061 \begin_layout Itemize
9066 : sender's telephone number, in the standard behavior only sets the LaTeX
9076 \begin_layout Itemize
9081 : place of the letter`s making.
9084 \begin_layout Itemize
9089 : date of the letter`s making.
9098 , in the standard behavior, produce the place and the date in a right-aligned
9099 line below the addressee's field.
9104 type is used, neither place nor date appear, independent of the value of
9114 type is used, the date of the letter `s production is used.
9117 \begin_layout Itemize
9122 : sender`s back address, in the standard behavior appears above the addressee's
9123 field in a small sans serif font.
9126 \begin_layout Itemize
9131 : special mail information, in the standard behavior appears underlined
9132 above the addressee's field below the back address.
9135 \begin_layout Itemize
9140 : additional information, in the standard behavior appears on right side
9141 below the addressee`s field.
9144 \begin_layout Itemize
9149 : the letter's title, in the standard behavior appears in a big, bold, sans
9150 serif font above the subject.
9153 \begin_layout Itemize
9158 : the letter's subject, in the standard behavior appears in a bold font
9166 \begin_layout Standard
9187 produce a business letter like line above the
9191 line containing the fields
9192 \begin_inset Quotes eld
9196 \begin_inset Quotes erd
9200 \begin_inset Quotes eld
9204 \begin_inset Quotes erd
9208 \begin_inset Quotes eld
9212 \begin_inset Quotes erd
9216 \begin_inset Quotes eld
9220 \begin_inset Quotes erd
9224 \begin_inset Quotes eld
9228 \begin_inset Quotes erd
9232 \begin_inset Quotes eld
9236 \begin_inset Quotes erd
9240 For the date field, the value of the
9246 \begin_inset Quotes eld
9249 business letter types
9250 \begin_inset Quotes erd
9253 is used, the value of the
9257 type however does not appear, but only the LaTeX variable
9264 The ordinary output of place and date in a right-aligned line below the
9265 addressee`s field is suppressed.
9266 The types are implemented as input types provided with a label and must
9267 be used ahead of the corresponding
9274 \begin_layout Itemize
9282 \begin_layout Itemize
9290 \begin_layout Itemize
9298 \begin_layout Itemize
9306 \begin_layout Itemize
9314 \begin_layout Subsection
9315 The new letter class: letter (koma-script v.2)
9318 \begin_layout Standard
9321 Jürgen Spitzmüller
9324 \begin_layout Standard
9325 \begin_inset VSpace medskip
9331 \begin_layout Standard
9333 Koma-Script version 2.8 has introduced a new letter class
9337 which superceeds the now unsupported
9342 It has --- on the LaTeX side --- a completely new interface and is not
9343 compatible with the old class.
9344 Therefore, LyX supports both, though it is recommended to use the new class.
9347 \begin_layout Standard
9348 This class covers the same functionality as
9350 letter (koma-script),
9357 (receiver's address, same as
9374 will start a new letter (i.
9378 \begin_layout Standard
9390 \begin_layout Standard
9398 you can write several letters per document).
9399 New elements are sender's
9415 and the possibility to use a
9424 nsert\SpecialChar \menuseparator
9434 \begin_layout Standard
9435 The biggest improvement is, though, that the letter's layout is configurable
9436 at almost any needs.
9437 This can be done via the preamble or with a special style file (Letter
9438 Class Option, extension
9442 ), that will be read in as a class option.
9446 \begin_layout Standard
9447 The KOMA package comes with some default
9452 There is, for instance, a
9456 file that follows german typesetting rules, or a
9460 that provides the default layout of the old
9465 The latter can be loaded with the class option
9474 ayout\SpecialChar \menuseparator
9479 ocument\SpecialChar \menuseparator
9491 template that is included in LyX for examples.
9492 A detailed description is to be found in the Koma-Script documentation
9500 \begin_layout Subsection
9504 \begin_layout Standard
9505 Visualizing the Koma-Script document classes in LyX, the LyX internals cause
9509 \begin_layout Itemize
9510 The chapter number of a
9514 type appears on a line of its own above the chapter heading instead of
9515 appearing in the same line ahead of it.
9516 The cause for that is the LyX internal behavior for the labeltype
9523 \begin_layout Itemize
9524 The headings of the types
9533 \begin_inset Quotes eld
9537 \begin_inset Quotes erd
9540 LaTeX table of contents, but not in the LyX table of contents (
9545 ocument\SpecialChar \menuseparator
9557 \begin_layout Itemize
9562 document class appear in a skip separation mode, not indented.
9563 This is the standard behavior, no special LaTeX commands are needed for
9570 ocument\SpecialChar \menuseparator
9577 dialog the corresponding radio button indicates
9593 value always has the effect that extra LaTeX commands are inserted in the
9594 document to produce the gap, which is not what is wanted in this case.
9597 \begin_layout Section
9605 \begin_layout Standard
9611 \begin_layout Subsection
9615 \begin_layout Standard
9616 These are the layout files for some of the journal formats used by Springer
9617 Verlag and listed on
9618 \begin_inset LatexCommand \url{http://www.springer.de/author/tex/help-journals.html}
9622 , where you should also go to fetch the class files (yes, these are LaTeX2e
9624 It is a modular system: the things common to all journals are implemented
9629 , which journal-specific layout files (such as, e.g.,
9633 for Journal of Geodesy) can include.
9636 \begin_layout Standard
9637 This means that implementing support for any other Springer journal on this
9638 list is as simple as writing your own
9646 file following the outline given in
9654 \begin_layout Standard
9655 It is reasonably well tested only for the Journal of Geodesy.
9664 come with the standard LyX distribution.
9665 Install the relevant class file (downloaded from Springer) in a proper
9666 directory, reconfigure LaTeX (in the teTeX case by running
9670 , as root if necessary --- doesn't LyX take care of this?), reconfigure
9671 LyX and it should work.
9674 \begin_layout Subsection
9678 \begin_layout Standard
9679 A large number of theorem-like styles ---
9685 \SpecialChar \ldots{}
9691 \begin_layout Standard
9694 Headnote, Dedication, Subtitle, Running_LaTeX_Title, Author_Running, Institute,
9695 Mail, Offprints, Keywords, Acknowledgements, Acknowledgement
9698 See the Springer class file documentation for details.
9701 \begin_layout Subsection
9705 \begin_layout Itemize
9717 \begin_layout Itemize
9720 Probability Theory and Related Fields
9726 --- Jean-Marc Lasgouttes
9729 \begin_layout Standard
9730 Add your own, it isn't so hard!
9733 \begin_layout Subsection
9737 \begin_layout Standard
9738 These files are partly based on the older
9742 , which was again based on a tinkered-with version of an old LaTeX 2.09 style
9748 layout, are now defunct.
9749 Jean-Marc Lasgouttes helped out big in making me find my way around the
9750 LyX layout file mechanism.
9753 \begin_layout Subsection
9757 \begin_layout Standard
9759 But probably less than in the old hacked-LaTeX
9766 \begin_layout Standard
9767 Limitations e.g.: does not display the number for theorem-like layouts, just
9771 \begin_layout Section
9779 \begin_layout Standard
9785 \begin_layout Subsection
9789 \begin_layout Standard
9790 These are the layout files for some of the journals of the American Geophysical
9792 It is assumed that you have both the AGU's own class files and AGUplus
9793 installed (everything to be found at
9794 \begin_inset LatexCommand \url{ftp://ftp.agu.org/journals/latex/journals}
9801 \begin_layout Subsection
9805 \begin_layout Standard
9815 They are still called this in the LyX GUI, though their LaTeX equivalents
9816 in the AGU classes are
9827 \begin_layout Standard
9828 Newly defined styles are
9865 These are mostly manuscript attributes and defined in the AGU class documentati
9869 \begin_layout Standard
9870 I suspect this is still badly incomplete.
9873 \begin_layout Subsection
9877 \begin_layout Standard
9894 \begin_layout Subsection
9898 \begin_layout Itemize
9901 Journal of Geophysical Research
9910 \begin_layout Standard
9911 Add your own, it isn't so hard! Look at the
9922 \begin_layout Subsection
9923 Bugs and things to remember
9926 \begin_layout Standard
9927 In order to use the new layouts, you must remember to do the following for
9931 \begin_layout Enumerate
9937 This can be done in the
9939 layout\SpecialChar \menuseparator
9944 document\SpecialChar \menuseparator
9948 (AGU articles are always in English, right? So
9955 \begin_layout Enumerate
9965 (Yes, this is a bug.)
9968 \begin_layout Enumerate
9969 Make sure you use the
9973 bibliography style, by entering
9977 into the second field of the BibTeX inset.
9978 None of the standard styles will do.
9981 \begin_layout Section
9989 \begin_layout Standard
9995 \begin_layout Subsection
9999 \begin_layout Standard
10000 This is the layout file for the European Geophysical Society journals.
10005 can be downloaded from the web site of the EGS under
10006 \begin_inset LatexCommand \url{www.copernicus.org}
10013 \begin_layout Subsection
10017 \begin_layout Standard
10020 Right_address, Latex_Title, Affil, Journal, msnumber, FirstAuthor, Received,
10028 The current layout file is unfortunately very unmodular and would benefit
10029 from using the various
10036 \begin_layout Section
10042 \begin_inset LatexCommand \label{sec:slitex}
10049 \begin_layout Standard
10057 \begin_layout Subsection
10061 \begin_layout Standard
10062 This section describes how to use LyX to make slides for overhead projectors.
10063 There are two document classes that can do this: the default slides class
10069 This section documents the former.
10072 \begin_layout Standard
10073 I'm going to say this again, nice and clear, so that there's no misunderstanding
10077 \begin_layout Standard
10078 \begin_inset VSpace bigskip
10084 \begin_layout Standard
10088 This section documents the class
10089 \begin_inset Quotes eld
10097 \begin_inset Quotes erd
10105 \begin_layout Standard
10106 \begin_inset VSpace bigskip
10112 \begin_layout Standard
10113 If you're looking for the documentation for
10114 \begin_inset Quotes eld
10122 \begin_inset Quotes erd
10125 , check out section\InsetSpace ~
10127 \begin_inset LatexCommand \ref{sec:foiltex}
10137 \begin_inset Quotes eld
10145 \begin_inset Quotes erd
10148 ] is actually somewhat better than the default
10156 \begin_layout Standard
10157 \SpecialChar \ldots{}
10158 or so I've been told repeatedly by its advocates.
10159 Having never used it, I have no idea if this claim is true or not.
10164 which this section documents.
10167 \begin_layout Standard
10168 This class is the LaTeX2e improvement of the old
10173 Every LaTeX2e distribution includes this class [which I'll just refer to
10175 \begin_inset Quotes eld
10183 \begin_inset Quotes erd
10186 from now on], so you're bound to have it.
10187 As I noted earlier, there are other classes, such as
10191 , which also produce slides for overhead projectors and do a better job
10193 However, there are some things which
10197 can do which the others can't, such as generate overlays.
10198 Read on to learn more!
10201 \begin_layout Subsection
10203 \begin_inset LatexCommand \label{sec:slidesetup}
10210 \begin_layout Standard
10211 Obviously, to use this document class, you need to select
10212 \begin_inset Quotes eld
10220 \begin_inset Quotes erd
10223 from the class list in the
10228 ocument\SpecialChar \menuseparator
10236 There are some other special things you should know about this class:
10239 \begin_layout Itemize
10240 Don't bother changing the options
10245 They're not supported by the
10252 \begin_layout Itemize
10261 behaves a bit differently for this class.
10262 The possible choices and what they do are as follows:
10266 \begin_layout Description
10271 The final output contains page numbers in the lower right corner.
10274 \begin_layout Description
10283 , but also prints out any time markers you've put in.
10284 This is the default.
10287 \begin_layout Description
10292 The final output contains no page numbers, time markers, or alignment markers.
10296 \begin_layout Itemize
10301 class has an extra option:
10307 \begin_inset Quotes eld
10315 \begin_inset Quotes erd
10318 in the extra class options.
10322 \begin_layout Standard
10323 Using this options allows you to add time markers to
10328 See section\InsetSpace ~
10330 \begin_inset LatexCommand \ref{sec:slideNote}
10338 \begin_layout Standard
10339 You can also use the template file
10340 \begin_inset Quotes eld
10348 \begin_inset Quotes erd
10351 to automatically set up a document to use the
10360 ile\SpecialChar \menuseparator
10369 to open your new document].
10370 The template file also contains some examples of the special paragraph
10371 environments used by this class.
10372 I'll describe those next.
10375 \begin_layout Subsection
10376 Paragraph Environments
10379 \begin_layout Subsubsection
10380 Supported Environments
10383 \begin_layout Standard
10384 The first thing you'll notice when you start up a new
10388 document is the font size and type: it's the equivalent of the size
10389 \begin_inset Quotes eld
10397 \begin_inset Quotes erd
10406 This is also what's used in the output.
10408 \begin_inset Quotes eld
10412 \begin_inset Quotes erd
10415 to remind you that this is a slide.
10416 Your final slides will use a larger font; ergo, you'll have less space.
10417 Of course, the larger default screen font isn't WYSIWYG, only a reminder.
10420 \begin_layout Standard
10421 The next thing that becomes obvious is the changes to the paragraph environment
10422 pull-down box [at the far-left end of the toolbar].
10423 Most of the paragraph environments you're used to seeing are missing.
10424 There are also five new ones.
10429 class itself only supports certain paragraph environments:
10432 \begin_layout Itemize
10438 \begin_layout Itemize
10444 \begin_layout Itemize
10450 \begin_layout Itemize
10456 \begin_layout Itemize
10462 \begin_layout Itemize
10468 \begin_layout Itemize
10474 \begin_layout Itemize
10480 \begin_layout Itemize
10486 \begin_layout Itemize
10492 \begin_layout Itemize
10498 \begin_layout Standard
10499 All of the other standard environments, including the section-heading environmen
10500 ts, aren't used in the
10507 \begin_layout Standard
10508 On the other hand, you'll notice the following new environments:
10511 \begin_layout Itemize
10517 \begin_layout Itemize
10523 \begin_layout Itemize
10529 \begin_layout Itemize
10535 \begin_layout Itemize
10541 \begin_layout Standard
10542 These five are kind of quirky, due to a
10543 \begin_inset Quotes eld
10547 \begin_inset Quotes erd
10551 You see, LyX doesn't permit you to nest any other paragraph environment
10552 into an empty environment.
10553 Now, that's fine and dandy, but it means that you wouldn't be able to start
10554 a slide with anything except plain text.
10555 To deal with this, I've performed a little
10556 \begin_inset Quotes eld
10560 \begin_inset Quotes erd
10566 \begin_layout Subsubsection
10567 Quirks of the New Environments
10568 \begin_inset LatexCommand \label{sec:slideQuirk}
10575 \begin_layout Standard
10576 All five of the new paragraph environments are somewhat quirky due to inherent
10577 limitiations in the current version of LyX.
10578 As I just mentioned, LyX forbids environments that begin with another environme
10580 To get around this, the
10584 environment isn't a paragraph environment as described in the
10592 \begin_layout Standard
10593 You should consider
10606 \begin_inset Quotes eld
10609 pseudo-environments.
10610 \begin_inset Quotes erd
10613 They look like a section heading or a
10614 \begin_inset Quotes eld
10622 \begin_inset Quotes erd
10625 but really begin a [and, if necessary, end the previous] paragraph environment.
10635 \begin_inset Quotes eld
10639 \begin_inset Quotes erd
10642 These two perform some action.
10645 \begin_layout Standard
10646 A common feature of all five environments,
10666 , is a rather long-ish label.
10667 The text following this label --- ordinarily the contents of the paragraph
10668 environment --- is utterly irrelevant for
10689 LyX completely ignores it.
10690 In fact, you can leave these five environments completely empty.
10694 \begin_layout Standard
10699 to put any text after the rather long-ish label, you might want to.
10700 This could be a short description of the contents of the
10705 In that case, enter in your descriptive comment and hit
10709 as you normally would.
10712 \begin_layout Standard
10713 If, on the other hand, you don't want to enter in any descriptive text,
10714 you'll hit another LyX quirk.
10715 LyX, like nature, abhors a vacuum, and will not let you start a new paragraph
10716 environment until you put something in the old one.
10720 \begin_layout Itemize
10721 Start entering the text that will
10749 \begin_layout Itemize
10750 Now move to the beginning of that paragraph.
10754 \begin_layout Itemize
10763 \begin_layout Itemize
10764 Finally, change this new, empty paragraph to a
10788 \begin_layout Standard
10789 Some future version of LyX will, hopefully, resolve this quirkiness\SpecialChar \ldots{}
10793 \begin_layout Subsection
10794 Making a Presentation with
10807 \begin_layout Subsubsection
10815 \begin_layout Standard
10816 If you're expecting this section to teach you how to actually make a presentatio
10817 n, you'll be sorely disappointed.
10818 Naturally, I'll describe all of the ways the
10822 class can assist you in preparing the materials for a presentation.
10823 Filling in the contents, however, is up to you.
10828 the LyX philosophy.]
10831 \begin_layout Standard
10836 environment [in the manner described in section\InsetSpace ~
10838 \begin_inset LatexCommand \ref{sec:slideQuirk}
10842 ] tells LyX to begin a new slide [duh].
10843 The label for this environment/
10844 \begin_inset Quotes erd
10848 \begin_inset Quotes erd
10852 \begin_inset Quotes eld
10856 \begin_inset Quotes erd
10859 in cool blue, followed by the label,
10860 \begin_inset Quotes eld
10864 \begin_inset Quotes erd
10868 Any text or paragraph environments that follow this one go on the new slide.
10872 \begin_layout Standard
10873 Slides are probably the only time you'll need to forcibly end pages in LyX
10874 (this can be specified in the
10879 In fact, you'll want to, once you finish entering the contents of one slide.
10880 If you've entered more text than can physically fit on a slide, the extra
10881 overflows onto a new slide.
10882 I don't recommend doing this, however, since the overflow slide won't have
10883 any page number on it.
10884 Furthermore, it may interfere with any
10888 you've made to accompany the oversized
10895 \begin_layout Standard
10904 environments work the same way as the
10909 They both create an
10910 \begin_inset Quotes eld
10914 \begin_inset Quotes erd
10917 followed by a label [
10918 \begin_inset Quotes eld
10922 \begin_inset Quotes erd
10926 \begin_inset Quotes eld
10930 \begin_inset Quotes erd
10934 The color is a stunning magenta instead of blue, and the
10935 \begin_inset Quotes eld
10939 \begin_inset Quotes erd
10942 will look different, in style and in length.
10943 The label fonts of all three also differ from one another.
10946 \begin_layout Standard
10951 , if the contents of a
10959 exceed the physical size of a slide or sheet of paper, the extra will overflow
10961 Again, you should avoid this.
10962 It defeats the whole purpose of
10973 \begin_layout Subsubsection
10983 \begin_layout Standard
10988 is a slide that sits atop another slide.
10989 Perhaps you wish to discuss a figure on the main
10993 before displaying the text associated with it.
10994 One way to accomplish this is tape a flap of dark paper over the part of
10999 you want to display later.
11000 This method fails, however, if you wish to overlap one graph with another,
11002 You would then have to fumble while speaking to align the two separate,
11007 s to align the two graphs.
11012 environment in both cases makes life much easier.
11015 \begin_layout Standard
11020 receives the page number of its
11021 \begin_inset Quotes eld
11025 \begin_inset Quotes erd
11033 \begin_inset Quotes eld
11041 \begin_inset Quotes erd
11048 \begin_layout Standard
11049 Presumably, mutliple
11054 \begin_inset Quotes eld
11062 \begin_inset Quotes erd
11066 \begin_inset Quotes eld
11074 \begin_inset Quotes erd
11078 \begin_inset Quotes eld
11086 \begin_inset Quotes erd
11089 , etc.\InsetSpace ~
11090 appended to the page number of the parent
11100 Clearly, you want the contents of both the
11108 to each fit on a single physical slide! You should probably consider an
11114 \begin_inset Quotes eld
11118 \begin_inset Quotes erd
11130 class provides a visual cue for this: the label at the start of an
11134 is shorter than that at the start of a
11139 Lastly, when you generate printable output, you'll find alignment markers
11140 in all four corners of both the
11144 page and its parent
11149 These will assist you in lining up the two physical slides.
11152 \begin_layout Standard
11153 The major problem in overlaying two slides is aligning the contents of the
11154 two transparencies.
11155 How much space should you leave for that graph on the second slide? Worse
11156 still, what if you want a graph and a sentence on second slide, but there
11157 is text on the main transparency that goes in between them? You could try
11158 and insert vertical space of the right size.
11159 The better way is to use
11170 \begin_layout Standard
11171 As their names imply,
11179 are two command-like paragraph environments that make all subsequent text
11180 invisible and visible, respectively.
11181 Note from section\InsetSpace ~
11183 \begin_inset LatexCommand \ref{sec:slideQuirk}
11187 that you don't place anything
11191 these two environments, however.
11196 , it inserts a centered, sky-blue label into the page reading
11197 \begin_inset Quotes eld
11200 <Invisible Text Follows>
11201 \begin_inset Quotes erd
11205 For paragraphs following this label, the parts of the
11213 ; it doesn't matter which] where they would be contain instead blank space.
11217 \begin_layout Standard
11222 , the corresponding centered label is
11223 \begin_inset Quotes eld
11226 <Visible Text Follows>
11227 \begin_inset Quotes erd
11231 Paragraphs following this label behave normally.
11232 Note that the beginning of a new
11244 automatically shuts off an
11249 It's therefore not necessary to use
11260 \begin_layout Standard
11261 By now, it should be obvious how to create overlay transparencies using
11262 the proper combination of
11281 \begin_layout Enumerate
11286 , including everything that will appear on it, whether on the main slide
11294 \begin_layout Enumerate
11295 Before each figure or paragraph that will appear only on the
11304 If necessary, insert a
11308 environment after the
11315 \begin_layout Enumerate
11320 immediately following the
11327 \begin_layout Enumerate
11328 Copy the contents of this
11339 \begin_layout Enumerate
11344 , change all of the
11355 \begin_layout Standard
11357 You've just made an
11364 \begin_layout Standard
11365 There's one problem with the way I've designed the LyX
11369 class: you can't make text in the middle of a paragraph invisible, nor
11370 make text in the middle of an invisible paragraph visible again.
11371 To accomplish this feat, you'll need to use some inlined LaTeX codes.
11375 \begin_layout Standard
11376 The commands of interest are:
11379 \begin_layout Itemize
11384 invisible \SpecialChar \ldots{}
11388 \begin_layout Itemize
11393 visible \SpecialChar \ldots{}
11397 \begin_layout Standard
11398 \SpecialChar \ldots{}
11399 and need to be marked as TeX.
11401 \begin_inset Quotes eld
11405 \begin_inset Quotes erd
11408 you wish to change goes in between the brackets [and after the
11421 If you don't know how to mark text as TeX, see the apprpriate section of
11434 \begin_layout Subsubsection
11444 \begin_inset LatexCommand \label{sec:slideNote}
11451 \begin_layout Standard
11460 is associated with a
11461 \begin_inset Quotes eld
11465 \begin_inset Quotes erd
11477 class provides visual cues.
11482 is shorter than that of a
11486 [yet longer than that of an
11490 ] and, like the label of an
11494 is shockingly magenta.
11495 Additionally, the printed
11499 has the page number of its
11500 \begin_inset Quotes eld
11504 \begin_inset Quotes erd
11512 \begin_inset Quotes eld
11520 \begin_inset Quotes erd
11524 \begin_inset Quotes eld
11532 \begin_inset Quotes erd
11536 \begin_inset Quotes eld
11544 \begin_inset Quotes erd
11548 You can have multiple
11552 s associated with a single
11564 , you'll probably want to break up long
11568 s so that they fit on a single sheet of paper.
11571 \begin_layout Standard
11576 is obvious: it contains anything additional you might want to say about
11582 It could also be used as a sheet of reminders for a particular
11587 In the case of the latter, you might want to make use of time markers.
11593 \begin_inset Quotes eld
11597 \begin_inset Quotes erd
11600 support for time markers, a
11605 So, you'll have to resort to using the LaTeX codes.
11608 \begin_layout Standard
11609 To use time markers, you'll need to specify the extra class option
11610 \begin_inset Quotes eld
11618 \begin_inset Quotes erd
11621 [see section\InsetSpace ~
11623 \begin_inset LatexCommand \ref{sec:slidesetup}
11628 This option turns on timing marks, which will appear in the lower-left-hand
11634 To set what appears in the time marker, you use the LaTeX commands
11635 \begin_inset Quotes eld
11645 \begin_inset Quotes erd
11649 \begin_inset Quotes eld
11659 \begin_inset Quotes erd
11663 The arguments of both commands are time measured in seconds.
11665 \begin_inset Quotes eld
11675 \begin_inset Quotes erd
11678 sets the time marker to a given time.
11680 \begin_inset Quotes eld
11690 \begin_inset Quotes erd
11693 increments the time marker by the specified amount.
11694 Using time markers and
11698 s in this fashion, you can remind yourself how much time to spend on a particula
11706 \begin_layout Standard
11707 There's one last feature to describe.
11708 Clearly, you'd like to print out all of your
11716 s on transparencies while printing all of your
11733 with which it is associated.
11734 What's a person to do?
11737 \begin_layout Standard
11738 Luckily, there are two LaTeX commands that allow you to select what to print
11740 Both must be placed into the preamble of your document.
11742 \begin_inset Quotes eld
11754 \begin_inset Quotes erd
11757 will cause the output to contain only the
11766 Correspondingly, the command
11767 \begin_inset Quotes eld
11779 \begin_inset Quotes erd
11782 prevents the output of anything but
11787 I'd advise placing both commands in the preamble and initially comment
11789 You can then preview your entire presentation as you write.
11790 When you're done writing, you can then uncomment one of the two to select
11791 what you want to print.
11792 I like to uncomment
11793 \begin_inset Quotes eld
11805 \begin_inset Quotes erd
11808 , print to a file with
11809 \begin_inset Quotes eld
11817 \begin_inset Quotes erd
11820 in its name, comment it back out, then uncomment
11821 \begin_inset Quotes eld
11833 \begin_inset Quotes erd
11837 \begin_inset Quotes eld
11845 \begin_inset Quotes erd
11849 I can then send either file to a printer, loading transparencies or plain
11850 paper as appropriate.
11853 \begin_layout Standard
11854 You can also provide other arguments to the
11855 \begin_inset Quotes eld
11865 \begin_inset Quotes erd
11869 \begin_inset Quotes eld
11879 \begin_inset Quotes erd
11883 See a good LaTeX book for details.
11886 \begin_layout Subsection
11891 Class Template File
11894 \begin_layout Standard
11895 I have also provided a template file,
11896 \begin_inset Quotes eld
11904 \begin_inset Quotes erd
11912 To use it, begin your new presentation with
11917 ile\SpecialChar \menuseparator
11927 Your new LyX presentation file will contain an example
11948 additionally contain an example of the use of
11957 Lastly, the preamble will contain:
11960 \begin_layout LyX-Code
11961 % Uncomment to print out only slides and overlays
11964 \begin_layout LyX-Code
11968 \begin_layout LyX-Code
11978 \begin_layout LyX-Code
11979 % Uncomment to print out only notes
11982 \begin_layout LyX-Code
11986 \begin_layout LyX-Code
11994 \begin_layout Standard
11995 One final thing: I created this class to support the LaTeX2e
11996 \begin_inset Quotes eld
12004 \begin_inset Quotes erd
12007 class, one of the built-in LaTeX2e classes.
12008 Neither I nor the rest of the LyX Team endorse or oppose the use of this
12009 built-in slide class.
12010 It's here if you want it or need it.
12011 There exist other LaTeX2e classes for creating presentations, such as the
12016 class [see section\InsetSpace ~
12018 \begin_inset LatexCommand \ref{sec:foiltex}
12023 \begin_inset Quotes eld
12031 \begin_inset Quotes erd
12034 package [present on some TeX distributions].
12035 The latter is not yet supported under LyX.
12039 \begin_layout Standard
12040 Perhaps you can take on the task\SpecialChar \ldots{}
12046 I know nothing about these other classes.
12047 Try them out to see what sort of alternative they provide.
12050 \begin_layout Section
12059 \begin_inset LatexCommand \label{sec:foiltex}
12066 \begin_layout Standard
12072 \begin_layout Subsection
12076 \begin_layout Standard
12077 This section describes how to use LyX to make slides for overhead projectors.
12078 There are two document classes that can do this: the default slides class
12084 This section documents the latter.
12087 \begin_layout Standard
12088 I'm going to say this again, nice and clear, so that there's no misunderstanding
12092 \begin_layout Standard
12093 \begin_inset VSpace bigskip
12099 \begin_layout Standard
12103 This section documents the class
12104 \begin_inset Quotes eld
12112 \begin_inset Quotes erd
12120 \begin_layout Standard
12121 \begin_inset VSpace bigskip
12127 \begin_layout Standard
12128 If you're looking for the documentation for
12129 \begin_inset Quotes eld
12137 \begin_inset Quotes erd
12140 , check out section\InsetSpace ~
12142 \begin_inset LatexCommand \ref{sec:slitex}
12147 If your machine doesn't have the
12152 \begin_inset Quotes eld
12160 \begin_inset Quotes erd
12163 ] installed, you'll probably have to use the default
12167 class, which isn't quite as good as
12172 \begin_layout Standard
12177 class is designed for use with version 2.1 of the
12181 LaTeX class file which is now an integral part of LaTeX2e.
12184 \begin_layout Subsection
12188 \begin_layout Standard
12189 Obviously, to use this document class, you need to select
12190 \begin_inset Quotes eld
12198 \begin_inset Quotes erd
12210 Document\InsetSpace ~
12214 There are some settings in the
12216 Document\InsetSpace ~
12219 dialog that you should know about that are specific to this class:
12222 \begin_layout Itemize
12223 Don't change the options
12233 Document\InsetSpace ~
12237 They're ignored by the
12244 \begin_layout Itemize
12245 The default font size is 20pt with the other options being 17pt, 25pt and
12249 \begin_layout Itemize
12250 The default font is
12258 but all math equations are still typeset in the usual roman font.
12261 \begin_layout Itemize
12266 TeX supports A4 and Letter paper sizes as well as a special size for working
12268 It doesn't support A5, B5, legal or executive paper sizes.
12271 \begin_layout Itemize
12272 Don't bother changing the
12276 settings because they are ignored anyway.
12277 All floats appear where they are defined in the text.
12280 \begin_layout Itemize
12288 setting behaves a bit differently for this class.
12293 TeX provides extensive footer and header capabilities including a user-defined
12295 See section\InsetSpace ~
12297 \begin_inset LatexCommand \ref{sec:foilfoot}
12302 The title page is treated differently to all other pages in the document
12311 has the logo centered at the bottom of the page (if one is defined).
12312 The possible page style choices and what they do are as follows:
12317 \labelwidthstring MMMMMMM
12324 The final output contains no page numbers, or other headers or footers
12325 (except footnotes of course).
12330 \labelwidthstring MMMMMMM
12337 The final output contains page numbers centered at the bottom of the page.
12338 No other headings or footers (other than footnotes).
12342 \labelwidthstring MMMMMMM
12347 Page numbers in lower right corner.
12348 Additional headers and footers are also shown.
12349 This is also the default.
12353 \labelwidthstring MMMMMMM
12358 Gives you access to the
12362 package although its use with
12366 TeX is discouraged by the writer of the
12370 TeX package because of some potential page layout clashes.
12374 \begin_layout Subsubsection
12378 \begin_layout Standard
12379 The following options may be used in the extra class options in the
12384 ocument\SpecialChar \menuseparator
12395 \labelwidthstring MMMMMMx
12400 This sets up the page layout for 7.33in by 11in paper, which is about the
12401 same aspect ratio as a 35mm slide, making it a bit easier to work with
12406 \labelwidthstring MMMMMMx
12411 Places a rule across the page below the header on every page except the
12416 \labelwidthstring MMMMMMx
12421 Places a rule across the page above the footer on every page except the
12426 \labelwidthstring MMMMMMx
12431 This is automatically set each time you create a new
12440 TeX to use the dvips driver to rotate those pages that are set as landscape
12445 \labelwidthstring MMMMMMx
12450 Simply changes the page dimensions to those of a landscape page but doesn't
12452 Thus if you use this option you need to use an external program to rotate
12453 each page or feed your paper through your printer as landscape.
12454 Note that this option effectively reverses the roles of the
12462 environments (don't worry these are described in the next section).
12466 \labelwidthstring MMMMMMx
12471 Equation numbers on the left.
12475 \labelwidthstring MMMMMMx
12480 Flush-left equations.
12483 \begin_layout Subsection
12484 Supported Environments
12487 \begin_layout Standard
12488 Most of the environments commonly supported in other classes are also supported
12494 There are several additional environments provided by
12498 TeX as well as a couple added by LyX.
12499 The following environments are shared with other classes:
12502 \begin_layout Standard
12506 \begin_layout Standard
12509 begin{multicols}{2}
12517 \begin_layout Itemize
12523 \begin_layout Itemize
12529 \begin_layout Itemize
12535 \begin_layout Itemize
12541 \begin_layout Itemize
12547 \begin_layout Itemize
12553 \begin_layout Itemize
12559 \begin_layout Itemize
12565 \begin_layout Itemize
12571 \begin_layout Itemize
12577 \begin_layout Itemize
12583 \begin_layout Itemize
12589 \begin_layout Itemize
12595 \begin_layout Itemize
12601 \begin_layout Itemize
12607 \begin_layout Itemize
12613 \begin_layout Itemize
12619 \begin_layout Itemize
12625 \begin_layout Standard
12629 \begin_layout Standard
12640 \begin_layout Standard
12641 That is, all the major environments apart from the sectioning environments.
12642 Since foils are essentially self-contained sections, with a title and body,
12647 TeX provides specific commands for starting new foils and these are:
12650 \begin_layout Itemize
12656 \begin_layout Itemize
12662 \begin_layout Standard
12663 LyX also provides slightly modified versions of these two environments called:
12666 \begin_layout Itemize
12672 \begin_layout Itemize
12675 ShortRotatefoilhead
12678 \begin_layout Standard
12679 and the differences will be explained in the next section.
12682 \begin_layout Standard
12683 Since foils are often used in presenting ideas or new theorems and such
12688 TeX also provides a comprehensive box of goodies for presenting them:
12691 \begin_layout Standard
12695 \begin_layout Standard
12698 begin{multicols}{2}
12706 \begin_layout Itemize
12712 \begin_layout Itemize
12718 \begin_layout Itemize
12724 \begin_layout Itemize
12730 \begin_layout Itemize
12736 \begin_layout Itemize
12742 \begin_layout Itemize
12748 \begin_layout Itemize
12754 \begin_layout Itemize
12760 \begin_layout Itemize
12766 \begin_layout Itemize
12772 \begin_layout Standard
12776 \begin_layout Standard
12787 \begin_layout Standard
12788 The starred versions are unnumbered while the unstarred versions are numbered.
12789 There are also two list environments added by LyX and these are:
12792 \begin_layout Itemize
12798 \begin_layout Itemize
12804 \begin_layout Standard
12809 TeX provides some powerful header and footer capabilities that are best
12810 set in the preamble although they may be set at any point in a document.
12811 If you want to change these settings in your document the best place to
12812 do so is at the very top of a foil,
12817 straight after the foilhead.
12820 \begin_layout Standard
12821 For this purpose, the following command styles are provided [
12828 \begin_layout Standard
12832 \begin_layout Standard
12835 begin{multicols}{2}
12843 \begin_layout Itemize
12850 \begin_layout Itemize
12856 \begin_layout Itemize
12863 \begin_layout Itemize
12870 \begin_layout Itemize
12878 \begin_layout Standard
12884 \begin_layout Standard
12888 \begin_layout Standard
12899 \begin_layout Standard
12900 There are also a few commands provided by
12904 TeX that aren't directly supported by LyX but I'll tell you what they do
12905 and how to use them in section\InsetSpace ~
12907 \begin_inset LatexCommand \ref{sec:unsuppfoils}
12914 \begin_layout Subsection
12915 Building a Set of Foils
12918 \begin_layout Standard
12919 This section will give a simple introduction to using the different environments
12920 to build a set of foils.
12921 If you want to see an example set of foils take a look at the
12925 file accessible from the
12930 ile\SpecialChar \menuseparator
12935 pen\SpecialChar \ldots{}
12946 \begin_layout Subsubsection
12947 Give It a Title Page
12950 \begin_layout Standard
12951 Unlike other classes that provide
12971 creates the title on a page of its own.
12972 If you leave out the
12976 environment LaTeX will substitute the current date (every time you regenerate
12980 \begin_layout Subsubsection
12984 \begin_layout Standard
12985 As I mentioned earlier, there are four ways of starting a new foil.
12986 For portrait foils you should use
12995 The difference between these two environments is the amount of space between
12996 the title of the foil (the foilhead) and the body of the foil.
12999 \begin_layout Standard
13000 Landscape foils are generated using the
13006 ShortRotatefoilhead
13009 Again the only difference is the spacing between foilhead and body.
13010 Both of the short versions have 0.5 inches less separation between the foilhead
13015 \begin_layout Standard
13016 One problem with the support for landscape foils is the requirement that
13017 you have to use the
13021 driver to generate the PostScript® output otherwise the foils won't be
13023 It is possible to get landscape foils even if you haven't got the
13027 driver provided you can feed your foils sideways through your printer ;-)
13030 \begin_layout Subsubsection
13031 Theorems, Lemmas, Proofs and more
13034 \begin_layout Standard
13035 Due to a small bug in LyX you can't have two of the same type of these environme
13036 nts directly following each other.
13037 They must be separated by something.
13038 If you try, you will just be extending the previous environment as if you
13039 had merged the two environments together.
13040 So, how do you get around this problem? The simplest option is to insert
13041 some text between the two environments or add a
13045 environment between the two with just a
13046 \begin_inset Quotes eld
13054 \begin_inset Quotes erd
13058 This will force LyX to produce two separate environments and hence the
13059 correct LaTeX output.
13060 An example is provided in the example file included with the LyX distribution.
13061 Remember, this problem only occurs if you are trying to place two of the
13062 same type of theorem-like environments one directly after the other.
13065 \begin_layout Subsubsection
13069 \begin_layout Standard
13070 You get all the commonly supported list styles found in other classes as
13071 well as two new ones.
13072 I'll only describe the new ones here.
13073 If you want to find out more about the other list environments check out
13079 If you intend to use itemized lists you might also want to read about the
13082 Itemize\InsetSpace ~
13083 Bullet\InsetSpace ~
13086 dialog described above in section\InsetSpace ~
13088 \begin_inset LatexCommand \ref{sec:bullet}
13095 \begin_layout Standard
13096 The two new list styles,
13104 , are designed to make it easier for you to create lists of do's and don'ts
13105 or right and wrong by providing dedicated environments that use a tick
13106 or a cross as the label of the list.
13107 These lists are in fact dedicated variants of the
13112 They do however require that you have the
13116 packages installed.
13119 \begin_layout Subsubsection
13123 \begin_layout Standard
13128 TeX redefines the floating tables and figures so that they appear exactly
13129 where they are in the text rather than pushing them to the top of the page
13130 or to some user specified location.
13131 In fact if you change the float placement settings they are simply ignored.
13134 \begin_layout Subsubsection
13135 Page Headers and Footers
13136 \begin_inset LatexCommand \label{sec:foilfoot}
13143 \begin_layout Standard
13153 are two commands used to control the left-footer text string.
13154 The first is meant to allow you to include a graphic logo on your foils
13156 \begin_inset Quotes eld
13164 \begin_inset Quotes erd
13168 While the second is meant to provide a classification for the audience,
13175 It is empty by default.
13178 \begin_layout Standard
13179 The remaining page corners can be filled by
13184 (which defaults to page numbers),
13197 \begin_layout Subsection
13203 \begin_inset LatexCommand \label{sec:unsuppfoils}
13210 \begin_layout Standard
13211 All the commands mentioned below need to be set in a
13219 within another environment.
13222 \begin_layout Subsubsection
13226 \begin_layout Standard
13227 All lengths are adjusted using the
13250 should be replaced by the name given to the length you want to change and
13255 is the length value.
13256 All lengths should be specified in units of length such as inches (
13268 ) or relative to some document or font-based length such as
13278 \begin_layout Standard
13279 It's possible to change the spacing between a foilhead and the body of the
13280 foil by adjusting the length specified by
13287 For example, to make
13291 foilheads 0.5 inches closer to their bodies put the following in the preamble:
13298 foilheadskip}{-0.5in}
13301 \begin_layout Standard
13302 The spacings around floats can be adjusted by setting these lengths:
13306 \labelwidthstring MMMMMMMMMMM
13313 Separation between the text and the top of the float
13317 \labelwidthstring MMMMMMMMMMM
13324 Separation between the float and the caption
13328 \labelwidthstring MMMMMMMMMMM
13335 Separation between the caption and the following text
13339 \labelwidthstring MMMMMMMMMMM
13346 You can make the captions narrower than the surrounding text by adjusting
13348 Best done relative to
13357 \begin_layout Standard
13358 There are also several title page related lengths that you may find useful
13359 if you have a long title or several authors:
13363 \labelwidthstring MMMMMMMMMMM
13370 Separation from headers to
13376 \labelwidthstring MMMMMMMMMMM
13395 \labelwidthstring MMMMMMMMMMM
13410 \labelwidthstring MMMMMMMMMMM
13427 \labelwidthstring MMMMMMMMMMM
13443 \begin_layout Standard
13444 The last length related command affects all the list environments.
13455 a list environment then all the vertical spacing between the list items
13457 Note that this is a command not a length so it doesn't require
13463 like the stuff mentioned above.
13466 \begin_layout Subsubsection
13467 Headers and Footers
13470 \begin_layout Standard
13483 commands control whether the logo in the
13487 definition appear on a given page.
13494 in the preamble then none of the foils will have the logo on them.
13495 If you don't want the logo on a particular page place the
13501 directly after the foilhead of that page and the
13507 directly after the next foilhead.
13510 \begin_layout Standard
13511 If you decide to use the
13515 page style setting in the
13517 Document\InsetSpace ~
13520 dialog you should probably add
13530 to your preamble so headers and footers on landscape pages are correctly
13531 placed when rotated.
13532 This is due to some clashes between the page layouts provided by the
13543 \begin_layout Section
13544 Latex8 (IEEE Conference Papers)
13547 \begin_layout Standard
13553 \begin_layout Subsection
13557 \begin_layout Standard
13558 Since this class is specifically for writing submissions to IEEE sponsored
13559 conferences I strongly recommend that you get a copy of their Authors Kit.
13564 package and associated bibliography style file is included in the kit.
13565 The Authors Kit is usually sent out by email once your initial submission
13567 There is a lot of useful information in the Authors Kit explaining formatting
13568 restrictions and so on and I will assume you have read this since that
13569 means I don't have to repeat it all here.
13572 \begin_layout Subsection
13576 \begin_layout Standard
13577 [AR\SpecialChar \@.
13581 \begin_layout Subsection
13582 Supported Environments
13585 \begin_layout Itemize
13591 \begin_layout Itemize
13597 \begin_layout Itemize
13603 \begin_layout Itemize
13609 \begin_layout Itemize
13615 \begin_layout Itemize
13621 \begin_layout Itemize
13627 \begin_layout Itemize
13633 \begin_layout Itemize
13639 \begin_layout Subsection
13640 Differences Between Screen and Paper
13643 \begin_layout Standard
13644 There are slight differences in appearance mainly with the presentation
13645 of section counters.
13646 On screen the trailing period of the section counter is missing but it
13647 will appear in the output so don't let this worry you.
13650 \begin_layout Section
13651 Hollywood (Hollywood spec scripts)
13654 \begin_layout Standard
13660 \begin_layout Subsection
13664 \begin_layout Standard
13665 Getting the format of a Hollywood script right is a
13666 \begin_inset Quotes eld
13670 \begin_inset Quotes erd
13673 It is designed to make the readers focus on content and to be easy and
13674 familiar for the actors to read.
13675 Each page of a script should be one minute of film.
13676 Nothing goes in a script that you cannot see or hear on screen.
13677 The courier 12 pt font should be used throughout.
13681 \begin_layout Subsection
13685 \begin_layout Standard
13686 Speakers' lines should NEVER break in mid-sentence.
13687 If a speaker's lines continue over a page break, repeat the
13691 title followed by (Cont'd).
13694 \begin_layout Subsection
13698 \begin_layout Standard
13703 names as labels then cross-reference the label to insert the name.
13704 The cross-reference dialog will show the current cast of characters.
13705 You can use this to insert the speaker name in narratives also.
13708 \begin_layout Subsection
13709 Paper size and Margins
13712 \begin_layout Standard
13713 USLetter, left 1.6in, right 0.75in, top 0.5in, bottom 0.75in
13716 \begin_layout Subsection
13720 \begin_layout Standard
13721 The following environments are available.
13722 You can use hollywood.bind to get the bind keys shown at the right.
13725 \begin_layout Itemize
13732 Used where nothing else works.
13736 \begin_layout Itemize
13749 Usually followed by something like
13750 \begin_inset Quotes eld
13753 on Sally waking up.
13754 \begin_inset Quotes erd
13760 \begin_layout Itemize
13769 Introduces a new INTERIOR camera set-up.
13770 Always followed by DAY or NIGHT, or something similar to define the lighting
13772 Everthing on this line in CAPS.
13775 \begin_layout Itemize
13784 Introduces a new EXTERIOR camera set-up.
13785 Everthing on this line in CAPS.
13788 \begin_layout Itemize
13797 The character speaking.
13800 \begin_layout Itemize
13809 Instructions to the speaker.
13810 The () are automatically inserted, but only the ( will show in LyX.
13811 Both will be printed.
13814 \begin_layout Itemize
13830 \begin_layout Itemize
13839 Camera movement instruction.
13844 \begin_layout Itemize
13852 \begin_layout Itemize
13860 \begin_layout Itemize
13868 \begin_layout Itemize
13876 \begin_layout Subsection
13880 \begin_layout Itemize
13881 (O.S) --- off screen
13884 \begin_layout Itemize
13885 (V.0) --- voice over
13888 \begin_layout Itemize
13893 \begin_layout Itemize
13898 \begin_layout Itemize
13899 PAN --- camera movement
13902 \begin_layout Itemize
13903 INSERT --- cut to close-up of
13906 \begin_layout Section
13910 \begin_layout Standard
13916 \begin_layout Subsection
13920 \begin_layout Standard
13921 Broadway is for writing plays.
13922 The format is more decorative than Hollywood, and much less standardized.
13923 This format should be suitable for workshops.
13926 \begin_layout Subsection
13930 \begin_layout Standard
13931 The same as in Hollywood.
13934 \begin_layout Subsection
13938 \begin_layout Standard
13943 names as labels then cross-reference the label to insert the name.
13944 The cross-reference dialog will show the current cast of characters.
13947 \begin_layout Subsection
13948 Paper size and Margins
13951 \begin_layout Standard
13952 USLetter, left 1.6in, right 0.75in, top 0.5in, bottom 0.75in
13955 \begin_layout Subsection
13959 \begin_layout Standard
13960 The following environments are available.
13961 You can use broadway.bind to get the bind keys shown at the right.
13964 \begin_layout Itemize
13971 You should not have to use this, but it is here for anything that does not
13975 \begin_layout Itemize
13984 Used to describe stage setting and the action.
13985 First use of speaker names in all CAPs.
13988 \begin_layout Itemize
13997 Automatically numbered.
13998 On screen it will be arabic, but will print as Roman.
14001 \begin_layout Itemize
14015 It is just centered text.
14018 \begin_layout Itemize
14027 Not automatically numbered.
14028 You supply the number.
14029 This is because I couldn't figure out how.
14032 \begin_layout Itemize
14041 A special case of Narrative to describe the setting and action as the curtain
14045 \begin_layout Itemize
14054 The speaker's (actor's) title, centered in all CAPS.
14057 \begin_layout Itemize
14066 Instructions to the speaker.
14067 The parentheses are automatically inserted.
14068 The ( will appear on screen, but both will be in the printed play.
14069 This environment is only used within
14076 \begin_layout Itemize
14085 What the Speaker says.
14088 \begin_layout Itemize
14097 The curtain comes down.
14100 \begin_layout Itemize
14108 \begin_layout Itemize
14116 \begin_layout Itemize
14124 \begin_layout Standard
14128 \begin_layout Section
14132 \begin_layout Standard
14138 \begin_layout Standard
14139 \begin_inset VSpace bigskip
14145 \begin_layout Standard
14149 Revtex\InsetSpace ~
14152 textclass works with the American Physical Sociey's RevTeX 4.0 (the
14153 \begin_inset Formula $\beta$
14156 release of May, 1999) class.
14159 \begin_layout Standard
14164 textclass, which works with RevTeX 3.1.
14165 However, v3.1 is basically obsolete, as it works with LaTeX 2.09.
14166 That means that it doesn't interact very well with LyX, which requires
14167 LaTeX2e, although it has been kludged to work.
14168 Since RevTeX 4.0 has been designed to work much more cleanly with LaTeX2e,
14171 RevTeX\InsetSpace ~
14174 textclass should also be pretty easy to use.
14177 \begin_layout Standard
14178 These documents are supposed to be used in
14182 to the RevTeX 4.0 documents, so we don't describe any of the special RevTeX
14183 macros, and assume you'll know what to put in the preamble if necessary.
14186 \begin_layout Subsection
14190 \begin_layout Standard
14191 All you need to do is install RevTeX 4, as described in the package's README
14193 the package can be found at
14194 \begin_inset LatexCommand \url[The RevTeX 4 Web Site]{http://publish.aps.org/revtex4/}
14199 Install it somewhere that LaTeX can see it.
14200 Test it by trying to LaTeX a short RevTeX 4 document in some random directory
14201 (i.e., not the directory where you installed the class file.) Then, if you
14202 reconfigure LyX, it will find the class file and let you use the RevTeX4
14206 \begin_layout Standard
14207 Probably the easiest way to get started is either to import a RevTeX 4 document
14214 Revtex\InsetSpace ~
14217 template, found in the templates directory.
14220 \begin_layout Subsection
14224 \begin_layout Standard
14225 Optional arguments to
14232 \begin_inset Quotes eld
14236 \begin_inset Quotes erd
14240 \begin_inset Quotes eld
14244 \begin_inset Quotes erd
14258 Document\InsetSpace ~
14262 Remember that in RevTeX, at least one optional argument is required!
14265 \begin_layout Standard
14266 Other preamble matter, like
14278 dialog, also as usual.
14281 \begin_layout Subsection
14285 \begin_layout Standard
14286 The layouts basically correspond to the commands in RevTeX4.0.
14287 For example, the Email layout corresponds to
14294 Note that (at least as of RevTeX 4.0 Beta), the
14302 layouts are exactly equivalent, so you shouldn't need to use both.
14306 \begin_layout Standard
14307 In case you're curious, both were included so that
14311 would be able to translate both
14331 \begin_layout Subsection
14335 \begin_layout Standard
14336 There are a couple of important unique aspects of RevTeX 4 which might cause
14337 bugs that will be even more confusing in LyX.
14340 \begin_layout Standard
14358 The LyX equivalent is that there is a separate Thanks layout.
14363 write footnotes in the
14367 layout, or weird things may happen.
14368 See the RevTeX 4 documentation for more details.
14371 \begin_layout Standard
14374 Author\InsetSpace ~
14379 Author\InsetSpace ~
14386 layouts must be placed
14394 layout and the corresponding
14411 , the LaTeX won't compile.
14414 \begin_layout Subsection
14418 \begin_layout Standard
14419 The main problem with this layout is that you can't use the optional arguments
14420 to layouts like Email and Title.
14421 (The problem is not unique to this layout; you can't use optional arguments
14422 to the Section layouts either.) This means that after you export that file
14423 to LaTeX (which you'll need to do eventually to send it in to APS), you'll
14424 need to edit the LaTeX file with a text editor to add the optional arguments
14425 to set, e.g., the running title for the page headers.
14426 Lacking these layouts makes the
14432 (and the equivalent
14438 ) useless, so the corresponding layouts don't exist, and will have to be
14443 \begin_layout Standard
14448 actually, LyX 1.3.0 supports some forms of optional arguments, but this layout
14449 has not been updated yet to take advantage of it.
14457 \begin_layout Section
14458 Article (mwart), book (mwbk) and report (mwrep)
14459 \begin_inset OptArg
14462 \begin_layout Standard
14475 \begin_layout Standard
14481 \begin_layout Standard
14482 The LyX document classes
14498 correspond to the LaTeX document classes
14511 They are replacements for the standard document classes
14523 , resp., and fit better to Polish typography conventions in a number of points.
14527 \begin_layout Standard
14531 \begin_layout Itemize
14532 Unnumbered titles (with star, eg.
14537 ) are added into table of contents,
14540 \begin_layout Itemize
14541 Additional page styles:
14545 \begin_layout Description
14546 uheadings header with separated lines,
14549 \begin_layout Description
14550 myheadings custom header, contents headers via commands:
14565 \begin_layout Description
14566 myuheadings custom header with separated lines,
14569 \begin_layout Description
14570 outer page number is placed on outer side of page
14574 \begin_layout Itemize
14579 \begin_layout Description
14580 rmheadings serif titles --- default,
14583 \begin_layout Description
14584 sfheadings sansserif titles,
14587 \begin_layout Description
14588 authortitle on title page first placed is author next title --- default,
14591 \begin_layout Description
14592 titleauthor on title page first placed is title next author,
14595 \begin_layout Description
14596 withmarginpar reserve place on page for margins.
14600 \begin_layout Section
14604 \begin_layout Standard
14610 \begin_layout Standard
14611 Elsevier Science Publishers B.V.
14612 provides a standard LaTeX document class (
14616 ) for submitting articles to their various journals.
14617 The style file can be downloaded directly from their web site:
14618 \begin_inset LatexCommand \url{http://authors.elsevier.com/}
14623 Instructions are supplied along with the class file, which details the
14624 requirements of the publishers.
14625 LyX includes package that allows for the use of this class, by a layout
14626 and a template file.
14627 Installation of the class file is the same as for any other LaTeX package;
14628 instructions are provided in the Elsevier documentation.
14631 \begin_layout Standard
14641 As the Elsevier class file is based mainly on the standard article class,
14642 most of the normal functionality is provided.
14643 The Elsevier class defines a number of mathematical environments, which
14644 are similar to the AMS environments.
14645 These commands are all described in the Elsevier documentation, and are
14649 \begin_layout Standard
14650 The easiest way to use the Elsevier style is to base documents on the included
14652 It is best not to use options such as fancy headings or the geometry package,
14653 as elements such as these are defined by Elsevier in their style file.
14654 Ideally, no extra packages except those mentioned in the Elsevier documentation
14656 Essentially, Elsevier require as
14657 \begin_inset Quotes eld
14661 \begin_inset Quotes erd
14668 \begin_layout Standard
14676 file as possible, as their intention is to take the supplied file and replace
14677 the class file with one for the particular journal to which the paper has
14679 This also means that not too much time should be spent on the formating
14681 When it comes to be published, this will change anyway.
14682 The rest of the usage for this layout is substantially the same as for
14683 the normal article class.
14684 For details of what Elsevier do and don't allow, refer to their documentation.
14687 \begin_layout Section
14691 \begin_layout Standard
14694 Jürgen Spitzmüller
14697 \begin_layout Subsection
14701 \begin_layout Standard
14702 Memoir is a very powerful and constantly evolving class.
14703 It has been designed with regard to fictional and non-fictional literature.
14704 Its aim is to let the user have maximum control over the typesetting of
14706 Memoir is based on the standard book class, but it can also emulate the
14707 article class (see below).
14710 \begin_layout Standard
14711 Peter Wilson, the developer of Memoir, is known as the author of lots of
14712 useful packages in the LaTeX world.
14713 Most of them have been merged with Memoir.
14714 Therefore, it is much easier to layout the table of contents, appendices,
14715 chapter designs and such.
14716 LyX, though, does not support all of these goodies natively.
14717 Some of them might be added to forthcoming releases
14721 \begin_layout Standard
14722 You are invited to send suggestions to
14723 \begin_inset LatexCommand \url{lyx-devel@lists.lyx.org}
14732 , lots will probably never, due to the limitations of LyX's framework.
14733 Of course you can still use all features with the help of some native LaTeX
14738 \begin_layout Standard
14743 \begin_layout Standard
14751 section\InsetSpace ~
14753 \begin_inset LatexCommand \ref{sec:Inserting-LaTeX-Code}
14763 In this section, we can only list those features which are natively supported
14765 For detailed descriptions (and for the rest of features) we are recommending
14766 to have a look at the detailed manual of the Memoir class
14770 \begin_layout Standard
14775 \begin_layout Standard
14784 \begin_inset LatexCommand \url{CTAN:/macros/latex/memoir/memman.pdf}
14793 , which is not only a user guide for the class, but also both a comprehensive
14794 description on good typesetting and a superb example for good typesetting
14798 \begin_layout Subsection
14799 Basic features and restrictions
14802 \begin_layout Standard
14803 Memoir supports basically all features of the standard book classes.
14804 There are, however, some differences, as follows:
14807 \begin_layout Description
14809 sizes: Memoir has a broader range of font sizes: 9, 10, 11, 12, 14,
14813 \begin_layout Description
14815 style: The fancy page style is not supported, due to a command clash
14816 between Memoir and the fancyhdr package (they are both defining a command
14817 with the same name, which confuses LaTeX).
14818 Instead, Memoir comes with a bunch of own page styles (see
14820 Layout\SpecialChar \menuseparator
14821 Document\SpecialChar \menuseparator
14826 If you want to use these for the chapter pages, you have to use the command
14833 in the main text or in preamble (e.
14837 \begin_layout Standard
14849 \begin_layout Standard
14861 chapterstyle{companion}
14866 \begin_layout Description
14867 Sectioning: Sectionings (chapter, section, subsection etc.) are coming with
14868 an optional argument in the standard classes.
14869 With this, you can specify an alternative version of the title for the
14870 table of contents and the headers (for instance, if the title is too long).
14871 In LyX, you can do this via
14873 Insert\SpecialChar \menuseparator
14877 at the beginning of a chapter/section.
14878 Memoir features a second optional argument and thus separates the table
14879 of contents from the header.
14880 You can define three variants of a title with this: one for the main text,
14881 one for the table of contents, and one for the headers.
14882 Simply insert two optional arguments if you need this feature, the first
14883 one containing the short title for the Table of Contents, the second one
14884 containing an alternative short title for the headers.
14887 \begin_layout Description
14888 TOC/LOT/LOF: In the standard classes (and in many other classes), the table
14889 of contents, the list of figures and the list of table start a new page
14891 Memoir does not follow this route.
14892 You have to insert a page break yourself, if you want to have one.
14895 \begin_layout Description
14896 Titlepage: For some unknown reason, Memoir uses pagination on the title
14897 page (in the standard classes, title pages are
14898 \begin_inset Quotes eld
14902 \begin_inset Quotes erd
14909 \begin_layout Standard
14921 \begin_layout Standard
14930 If you want an empty title page, type
14934 aliaspagestyle{title}{empty}
14939 \begin_layout Description
14940 Article: With the class option
14946 Layout\SpecialChar \menuseparator
14947 Document\SpecialChar \menuseparator
14951 ), you can emulate article style.
14952 That is, counters (footnotes, figures, tables etc.) will not be reset on
14953 new chapters, chapters don't start a new page (but are---in contrary to
14955 \begin_inset Quotes eld
14959 \begin_inset Quotes erd
14962 article classes---still allowed), parts, though, use their own page, as
14966 \begin_layout Description
14967 Oldfontcommands: By default, Memoir does not allow the use of the deprecated
14968 font commands, which have been used in the old LaTeX version 2.09 (e.
14972 \begin_layout Standard
14984 \begin_layout Standard
15005 It produces an error and stops LaTeX whenever such a command appears.
15010 reallows the commands and spits out warnings instead (which does at least
15012 Since a lot of packages and particularly BibTeX style files are still using
15013 those commands, we have decided to use this option by default.
15016 \begin_layout Subsection
15020 \begin_layout Standard
15021 We will only describe the features supported by LyX (which is not much currently
15023 Please consult the Memoir manual
15027 \begin_layout Standard
15032 \begin_layout Standard
15041 \begin_inset LatexCommand \url{CTAN:/macros/latex/memoir/memman.pdf}
15053 \begin_layout Description
15054 Abstract: You may wonder why an abstract is an extra feature.
15055 Well, it is in book class.
15056 Usually books don't have abstracts.
15057 Memoir, however, has.
15058 You can use it whereever and how often you like.
15061 \begin_layout Description
15062 Chapterprecis: You may know this from belletristic: The contents of a chapter
15063 is shortly described below the title and also in the table of contents
15068 \begin_layout Standard
15080 \begin_layout Standard
15090 Our hero arrives in Troia; he loses some friends; he finds others
15093 Chapterprecis does exactly this.
15094 It is therefore only sensible below a chapter.
15097 \begin_layout Description
15098 Epigraph: An epigraph is a smart slogan or motto at the beginning of a chapter.
15099 The epigraph environment provides an elegant way of typesetting such a
15101 The motto itself (text) and its author (source) are divided by a short
15103 Unfortunately, we have to fool LyX a bit here again, since the environment
15104 needs two arguments (text and source).
15105 In this case, we have to use curly brackets (in TeX mode) between the two
15116 <author of the slogan>.
15119 \begin_layout Description
15120 Poemtitle: Memoir has lots of possibilities to typeset poetry (up to very
15121 complex figurative poems).
15122 Lyx can only support a few of them.
15123 One is poemtitle, which is a centered title for poems, which will also
15124 be added to the table of contents (verse is the standard environment for
15126 Memoir has some enhanced versions of verse, but you need to use ERT, because
15127 they have to be nested inside regular verse environments, which is not
15128 possible with LyX).
15131 \begin_layout Description
15132 Poemtitle*: Same as poemtitle, but it adds no entry to the table of contents.
15135 \begin_layout Chapter
15136 Importing and Exporting Alternate File Formats
15137 \begin_inset OptArg
15140 \begin_layout Standard
15141 Importing and Exporting
15149 \begin_layout Section
15153 \begin_layout Standard
15154 Importing and exporting LyX documents from/to other formats has been touched
15160 Here we describe more of the gory details needed to understand just what
15161 is going on when you click on the
15166 ile\SpecialChar \menuseparator
15178 ile\SpecialChar \menuseparator
15189 \begin_layout Section
15190 Importing Other Formats
15193 \begin_layout Subsection
15197 \begin_layout Standard
15198 Translating from LaTeX into LyX is performed by a Perl script called reLyX.
15199 Although it is a standalone program which can be called from the command
15200 line, LyX will call it automatically when a LaTeX document is imported.
15201 See section\InsetSpace ~
15203 \begin_inset LatexCommand \ref{sec:reLyX}
15207 for a complete description.
15208 There are no user tunable parameters for reLyX within LyX.
15211 \begin_layout Subsection
15215 \begin_layout Standard
15216 When importing plain ASCII text, there are two methods of reading the file.
15218 \begin_inset Quotes eld
15222 \begin_inset Quotes erd
15225 preserves all the linebreaks in the ASCII; to LyX, then, each line looks
15228 \begin_inset Quotes eld
15232 \begin_inset Quotes erd
15235 assumes that consecutive lines separated by only a single linebreak form
15236 a single paragraph.
15237 Successive linebreaks with no intervening text are thus assumed to be paragraph
15241 \begin_layout Subsection
15245 \begin_layout Standard
15248 [Editor's note: Needs to be written, obviously - any volunteers? --- mer]
15251 \begin_layout Section
15252 Exporting Other Formats
15255 \begin_layout Subsection
15259 \begin_layout Standard
15260 LyX generates two types of LaTeX files: stripped down versions for the normal
15265 , etc.) which one normally never sees
15269 \begin_layout Standard
15270 The resulting file is a perfectly valid LaTeX file, though the preamble
15271 might look a bit strange since it includes some definitions used by LyX
15272 which wouldn't show up in most human-written files.
15277 , and human readable forms which are suitable for exchanging with your colleague
15279 The only settable option for the translation is the line length of the
15281 The default is 65 characters, but it can be set in
15288 \SpecialChar \menuseparator
15309 \begin_layout Subsection
15310 Device Independent Files
15313 \begin_layout Standard
15314 Device Independent files (DVI files) are produced by running LaTeX on your
15316 There are no user settable options.
15319 \begin_layout Subsection
15323 \begin_layout Standard
15324 The next step in the conversion chain is converting a DVI file into Postscript®.
15332 \SpecialChar \menuseparator
15340 \SpecialChar \menuseparator
15349 or, if you need more control on the result,
15356 \SpecialChar \menuseparator
15365 If you use the later, note that it is possible to configure, in
15372 \SpecialChar \menuseparator
15380 , the options passed to the dvips program to achieve different effects.
15383 \begin_layout Subsection
15387 \begin_layout Standard
15388 Exporting as ASCII attempts to preserve the
15389 \begin_inset Quotes eld
15393 \begin_inset Quotes erd
15396 of the document as well as possible, but things like centering and indentation
15397 are thrown out; paragraphs are separated by blank lines.
15398 Section numbering and cross-references are done correctly, so the resulting
15399 text files is remarkably readable.
15400 The only changeable option is the length of lines, as for LaTeX output.
15403 \begin_layout Subsection
15407 \begin_layout Standard
15408 LyX documents can be converted to hypertext markup, usually by converting
15409 to LaTeX first, then converting that to HTML\SpecialChar \@.
15411 \begin_inset Formula $\rightarrow$
15414 HTML converters are currently known to LyX:
15427 Though they are autodetected, you can overide the selection in preferences.
15428 You can also include further command line options in this dialog.
15432 \begin_layout Subsection
15436 \begin_layout Standard
15444 \begin_layout Standard
15445 \begin_inset VSpace bigskip
15451 \begin_layout Standard
15452 The fastest way to generate a basic PDF file (no tags, links, etc.) with
15453 any version of LyX is to save the document as a Postscript® file, then
15459 Starting with version 1.1.6, the menu item
15463 will do all this for you.
15464 There are some issues with fonts that you need to pay attention to: see
15465 Section\InsetSpace ~
15467 \begin_inset LatexCommand \ref{sec:badfonts}
15472 Also, as of version 1.1.6, there is a better method that will generate much
15473 more sophisticated files.
15476 \begin_layout Subsubsection
15480 \begin_layout Standard
15481 With pdfLaTeX you need to convert your eps figures to PDF (see Section\InsetSpace ~
15483 \begin_inset LatexCommand \ref{sec:pdfeps}
15487 ), and you cannot use pstricks.
15488 On the other hand, with pdfLaTeX it is possible to insert directly images
15489 in JPEG or PNG format, use TrueType fonts, and more.
15492 \begin_layout Subsubsection
15493 Why does the text look so bad when viewed with Acrobat Reader?
15494 \begin_inset LatexCommand \label{sec:badfonts}
15499 \begin_inset OptArg
15502 \begin_layout Standard
15503 Bad Fonts in Acrobat Reader
15511 \begin_layout Standard
15512 The problem is that bitmap fonts are displayed poorly by Acrobat Reader.
15513 When creating a PDF from the LyX file, you need to use outline font instead
15514 of the default bitmap fonts (in fact, you should also use outline fonts
15515 for Postscript files).
15516 Recent LaTeX distributions come with Postscript® Type 1 version of the
15517 standard (Computer Modern) fonts.
15518 pdfLaTeX uses these font by default.
15519 Dvips doesn't use these fonts by default, so to make it use them, add the
15520 following to lines to your
15527 \begin_layout LyX-Code
15531 \begin_layout LyX-Code
15535 \begin_layout Standard
15536 If the default LaTeX font encoding (OT1) is used, nothing else need to be
15538 However, if the T1 font encoding is used, then LaTeX uses the newer EC
15539 fonts, for which there are no Type1 version.
15540 The solution is to use the ae package which emulates T1 coded fonts using
15541 the standard CM fonts.
15542 This is done by adding
15546 usepackage{ae,aecompl}
15548 to the preamble of the LyX file.
15549 However, some glyphs are missing from the CM fonts (e.g.
15550 eth, thorn), and they are taken from the EC fonts.
15551 Therefore you get these glyphs as bitmaps.
15554 \begin_layout Standard
15555 Note: LyX uses by default the T1 font encoding.
15556 If you wish to use the default font encoding (this is not recommended,
15557 unless you only write English documents), clear the field
15565 in preferences (tabs
15577 \begin_layout Standard
15578 An alternate option is to use the standard Postscript® fonts instead of
15579 the Computer Modern fonts.
15580 To do that, you need to select
15584 as the global font in the document layout dialog.
15585 When using the Postscript® fonts, the result PDF file is smaller as the
15586 fonts are not saved into the file.
15587 Furthermore, the Postscript® fonts include all T1 glyphs.
15588 On the other hand, the Postscript® fonts have no bold symbol font, so poor
15589 man's bold must be used (see Section\InsetSpace ~
15591 \begin_inset LatexCommand \ref{sec:pdfbold}
15596 The Postscript® fonts also look different from the Computer Modern fonts.
15599 \begin_layout Standard
15600 To sum up, both the Computer Modern and the Postscript® fonts gives good
15601 results (with few exceptions).
15602 The decision of which one to use is a matter of taste.
15605 \begin_layout Subsubsection
15608 boldsymbol{} command work when I use pslatex?
15609 \begin_inset LatexCommand \label{sec:pdfbold}
15614 \begin_inset OptArg
15617 \begin_layout Standard
15634 \begin_layout Standard
15635 The Postscript® fonts do not have a bold symbol font.
15636 The solution is to use the
15642 (poor man's bold) command.
15645 \begin_layout Standard
15646 It is possible to redefine the
15661 \begin_layout LyX-Code
15671 \begin_layout Standard
15675 \begin_layout Subsubsection
15676 Is it possible to do write latex code which is processed only when running
15678 \begin_inset OptArg
15681 \begin_layout Standard
15682 Conditionals with pdfLaTeX
15690 \begin_layout Standard
15692 Here is an example:
15695 \begin_layout LyX-Code
15703 \begin_layout LyX-Code
15713 \begin_layout LyX-Code
15719 \begin_layout LyX-Code
15725 \begin_layout LyX-Code
15731 \begin_layout LyX-Code
15737 \begin_layout LyX-Code
15741 \begin_layout LyX-Code
15747 \begin_layout LyX-Code
15750 pdfinfo { /Author (your name and e-mail address)
15753 \begin_layout LyX-Code
15754 /Title (official title -- i.e., title element)
15757 \begin_layout LyX-Code
15758 /Subject (one line description of the document)
15761 \begin_layout LyX-Code
15765 \begin_layout LyX-Code
15768 pdfcatalog { /PageMode (/UseNone)
15771 \begin_layout LyX-Code
15772 % /OpenAction (fitbh)
15775 \begin_layout LyX-Code
15779 \begin_layout LyX-Code
15782 usepackage[pdftex]{hyperref}
15785 \begin_layout LyX-Code
15791 \begin_layout LyX-Code
15794 usepackage[ps2pdf]{hyperref}
15797 \begin_layout LyX-Code
15803 \begin_layout Subsubsection
15804 How can I make URLs clickable ?
15807 \begin_layout Standard
15808 See the references here :
15811 \begin_layout Standard
15812 \begin_inset LatexCommand \url{http://wiki.lyx.org/pmwiki.php/FAQ/PDF}
15819 \begin_layout Subsection
15823 \begin_layout Standard
15824 Custom exports are possible if you have some particularly weird format you
15825 wish to convert to, assuming you have the relevant converter, of course.
15830 file can be chosen in the
15835 ile\SpecialChar \menuseparator
15840 xport\SpecialChar \menuseparator
15847 dialog; LyX will automatically convert the file to this point, then feed
15848 it to your custom converter.
15849 The possible values are all formats that LyX can produce from its own documents.
15853 \begin_layout Standard
15854 The converter command is also specified in the dialog.It should be a completely
15855 qualified command line which uses the variable
15859 to specify the name of the file.
15860 If this variable is not given, then the file will be sent to the standard
15861 input of your command.
15862 You may have to apply a bit of ingenuity to escape this sequence correctly
15863 so that it is compatible with your shell.
15867 \begin_layout Standard
15868 While it is not possible to save this command using the
15872 dialog, you can manually edit your
15879 \begin_layout LyX-Code
15882 custom_export_command "mycommand $$FName"
15885 \begin_layout Section
15886 The Complete reLyX Description
15887 \begin_inset LatexCommand \label{sec:reLyX}
15894 \begin_layout Subsection
15898 \begin_layout Standard
15899 The simplest way to use reLyX is via the
15904 ile\SpecialChar \menuseparator
15912 That runs reLyX on the given file and loads the resulting file into LyX.
15913 You should try that first, and call it from the command line only if you
15914 need to use more complicated options.
15917 \begin_layout Standard
15969 \begin_layout Standard
16025 \begin_layout Standard
16035 \begin_layout Subsection
16039 \begin_layout Description
16045 By default, when reLyX sees a
16051 command, it creates a file of textclass
16052 \begin_inset Quotes eld
16056 \begin_inset Quotes erd
16059 and reads the LyX layout file for that class.
16064 to declare a different textclass (and read a different layout file).
16067 \begin_layout Description
16073 By default, reLyX gives sparse output and deletes the temporary files which
16074 were created during translation.
16079 flag will create much more output (both to stdout and stderr) and leave
16080 the temporary files around.
16083 \begin_layout Description
16089 reLyX will not run if the
16093 file it would generate already exists Use the
16097 option (carefully) to clobber any existing files.
16100 \begin_layout Description
16106 Print out usage information and quit
16109 \begin_layout Description
16115 With this option, all temporary files and LyX output files (for the given
16116 input file, for any included files, or for any file fragments given with
16121 option) will be put into
16126 Otherwise, for each file
16130 , the temporary files and the LyX output file will be created in
16135 This can be useful if a file includes files from other directories which
16136 you want to consolidate in one directory, or if you don't have write permission
16137 on the directory the LaTeX files are in.
16140 \begin_layout Description
16146 The input files are LaTeX fragments, with no preamble matter or
16153 This option requires the
16157 option, since there are no
16163 commands in the files reLyX is translating.
16164 When using this option, you can translate more than one file, as long as
16165 all files are the same class.
16166 The LyX file created by reLyX can be included in an existing LyX file using
16172 nsert\SpecialChar \menuseparator
16177 \SpecialChar \menuseparator
16188 \begin_layout Description
16193 Regular environments (see the Section\InsetSpace ~
16195 \begin_inset LatexCommand \ref{sub:relyx-syntax}
16200 If you give more than one environment, separate them with commas (not
16202 You'll probably need to quote the environment list, especially if it has
16203 asterisk environments (foo*) in it.
16204 If you use this command often, considering creating a personal syntax file.
16207 \begin_layout Description
16213 Input (one or more quoted, comma-separated) syntax files to read in addition
16215 (see the section Section\InsetSpace ~
16217 \begin_inset LatexCommand \ref{sub:relyx-syntax}
16224 \begin_layout Subsection
16228 \begin_layout Subsubsection
16232 \begin_layout Standard
16233 reLyX will create a LyX file
16237 from the LaTeX file
16248 \begin_layout Standard
16266 does not exist and does not have one of these suffixes, reLyX will try
16272 (This is similar to the behavior of LaTeX.)
16275 \begin_layout Standard
16276 The purpose of reLyX is to translate
16281 If your LaTeX file doesn't compile---or if you do weird things, like redefining
16282 standard LaTeX commands---it may choke.
16283 LaTeX209 will often be translated correctly, but it's not guaranteed.
16286 \begin_layout Standard
16287 reLyX has some bugs and lacks a few features.
16288 However, its main goals are:
16291 \begin_layout Itemize
16292 Get through a well-behaved LaTeX2e file without crashing
16295 \begin_layout Itemize
16296 Translate a lot of that file.
16299 \begin_layout Itemize
16300 Localize the parts that can't be translated and copy them in TeX mode
16303 \begin_layout Standard
16304 It achieves these main goals pretty well on most files.
16307 \begin_layout Standard
16308 There are many improvements that can and will be made to reLyX in the future.
16309 However, we wanted to get reLyX out there early on, to make it easier for
16310 new LyX users to read in their existing LaTeX files.
16313 \begin_layout Subsubsection
16317 \begin_layout Standard
16318 Here's a more lengthy description of what you should do to translate a LaTeX
16322 \begin_layout Itemize
16327 \begin_layout Standard
16328 reLyX will inform you of its progress and give any warnings to stderr, so
16329 if you don't want any output at all, try (in csh)
16330 \begin_inset Quotes eld
16335 reLyX foo.tex >& /dev/null
16338 \begin_inset Quotes erd
16342 \begin_inset Quotes eld
16354 \begin_inset Quotes erd
16358 You should NOT redirect standard output to
16367 \begin_layout Itemize
16368 Run LyX on the resulting .lyx file.
16372 \begin_layout Standard
16373 In theory, most of the file will have been translated, and anything that's
16374 untranslatable will be highlighted in red (TeX mode).
16375 In theory, LyX will be able to read in the file, and to create printed
16376 documents from it, because all that untranslated red stuff will be passed
16377 directly back to LaTeX, which LyX uses as a backend.
16378 Unfortunately, reality doesn't always reflect theory.
16379 If reLyX crashes, or LyX cannot read the generated LyX file, see Section\InsetSpace ~
16381 \begin_inset LatexCommand \ref{sub:relyx-bugs}
16393 \begin_layout Itemize
16394 Change things that are in ERT boxes (TeX code) by hand in LyX.
16398 \begin_layout Standard
16399 As mentioned above, you should be able to print out the LyX file even without
16401 However, changing a command in TeX mode to the corresponding LyX object
16402 will allow you to take advantage of LyX's WYSIWYM editing.
16405 \begin_layout Standard
16406 reLyX is not guaranteed to create a LyX file which generates exactly the
16407 same output as the LaTeX file, but it should come close.
16408 reLyX will generally err on the side of translating less to ensure that
16409 dvi or ps files are accurate, even though this leads to more
16410 \begin_inset Quotes eld
16414 \begin_inset Quotes erd
16421 \begin_layout Itemize
16422 PROOFREAD THE DOCUMENT!!
16426 \begin_layout Standard
16427 I'm sure you were planning on doing this anyway, but it's particularly important
16428 after translating a LaTeX document.
16429 reLyX is, at least now, better at
16430 \begin_inset Quotes eld
16434 \begin_inset Quotes erd
16437 (translating the whole document) than
16438 \begin_inset Quotes eld
16442 \begin_inset Quotes erd
16445 (translating every little detail).
16446 For example, you may see extra spaces or deleted spaces.
16447 Space handling has improved, but it's not perfect.
16451 \begin_layout Subsubsection
16452 What reLyX Can Handle
16455 \begin_layout Standard
16456 reLyX understands many LaTeX commands.
16460 \begin_layout Itemize
16461 regular text, including mini-commands like ~, '',
16473 , as well as accented characters like
16479 , and the special cases ?` and !`
16482 \begin_layout Itemize
16483 title commands like
16507 and the abstract environment
16510 \begin_layout Itemize
16511 heading commands like
16517 including starred commands (
16526 \begin_layout Itemize
16552 \begin_layout Itemize
16565 environments, and their
16572 Also, well-behaved nested lists
16575 \begin_layout Itemize
16576 cross-referencing commands:
16601 \begin_layout Itemize
16615 \begin_layout Itemize
16616 font-changing commands including
16634 , and corresponding commands to change family, size, series, and shape
16637 \begin_layout Itemize
16664 \begin_inset Quotes erd
16674 \begin_inset Quotes erd
16680 \begin_layout Itemize
16685 environment, and commands that go inside it like
16706 \begin_layout Itemize
16721 commands within them
16724 \begin_layout Itemize
16735 command, as well as BibTeX's
16750 \begin_layout Itemize
16751 miscellaneous commands:
16780 \begin_layout Itemize
16781 documentclass-specific environments (and some commands) which can be translated
16785 \begin_layout Itemize
16786 arguments to certain untranslatable commands (e.g.
16796 \begin_layout Standard
16797 Some of this support may not be 100% yet.
16798 See below for details
16801 \begin_layout Standard
16802 reLyX copies math (almost) verbatim from your LaTeX file.
16803 Luckily, LyX reads in LaTeX math, so (almost) any math which is supported
16804 by LyX should work just fine.
16805 A few math commands which are not supported by LyX will be replaced with
16806 their equivalents, e.g.,
16826 \begin_layout Standard
16827 reLyX will also copy any preamble commands (i.e., anything before
16833 ) verbatim, so fancy stuff you've got in your preamble should be conserved
16834 in dvi and printed documents, although it will not of course show up in
16836 Check the preamble to make sure.
16839 \begin_layout Subsubsection
16840 What reLyX Can't Handle --- But it's OK
16843 \begin_layout Itemize
16851 \begin_layout Itemize
16855 \begin_layout Itemize
16877 \begin_layout Itemize
16897 \begin_layout Itemize
16909 reLyX is careful to copy
16913 in this case, including comments and whitespace.
16916 \begin_layout Itemize
16917 some unknown (e.g., user-defined) environments and commands
16920 \begin_layout Standard
16921 reLyX copies unknown commands, along with their arguments, verbatim into
16929 where it doesn't recognize the
16930 \begin_inset Quotes eld
16934 \begin_inset Quotes erd
16937 environment, it will copy verbatim until it sees
16943 (unless you use the
16948 Hopefully, then, most of these unknown commands won't cause reLyX to break;
16949 they'll merely require you to do some editing once you've loaded the file
16951 That should be less painful than editing either the
16959 file using a text editor.
16962 \begin_layout Subsubsection
16963 What reLyX Handles Badly --- a.\InsetSpace ~
16967 \begin_inset LatexCommand \label{sub:relyx-bugs}
16974 \begin_layout Standard
16975 Since reLyX is relatively new, it's got a number of problems.
16976 As it matures, these bugs will be squished.
16977 A number of bugs and missing features can be found listed on the LyX bug
16979 \begin_inset LatexCommand \url[LyX Bugzilla]{http://bugzilla.lyx.org/}
16986 \begin_layout Standard
16987 If reLyX is choking on something, or LyX can't read it after reLyX translates
16988 it, the best thing to do is to put
16994 before the offending text, and
17002 \begin_inset Quotes eld
17006 \begin_inset Quotes erd
17010 reLyX will copy this block exactly, in TeX mode.
17011 Then edit the resulting LyX file, and translate the unknown stuff by hand.
17016 environment is magical; the
17028 commands will not be put into the LyX file.
17031 \begin_layout Itemize
17032 \begin_inset Quotes eld
17036 \begin_inset Quotes erd
17039 copying of unknown environments and commands isn't quite exact.
17040 Specifically, newlines and comments may be lost.
17041 This will yield ugly LyX, but in almost all cases the output will be the
17043 However, certain parts of the file will be copied perfectly, including
17044 whitespace and comments.
17045 This includes: the LaTeX preamble,
17055 commands, and skip blocks.
17058 \begin_layout Itemize
17059 reLyX translates only a few options to the
17066 (Specifically 1[012]pt, [letter|legal|executive|a4|a5|b5]paper, [one|two]side,
17067 landscape, and [one|two]column.) Other options are placed in the extra class
17068 options field in the
17073 ocument\SpecialChar \menuseparator
17084 \begin_layout Standard
17085 More importantly, reLyX doesn't translate
17091 commands, margin commands,
17097 s, or, in fact, anything else from the preamble.
17098 It simply copies them into the LaTeX preamble.
17099 If you have margin commands in your preamble, then the LyX file will generate
17101 However, these margins will override any margins you set in the LyX
17108 \SpecialChar \menuseparator
17114 So you should remove the options from the preamble to be safe.
17115 The same goes for setting your language with babel,
17131 \begin_layout Itemize
17132 The foil class has a couple bugs.
17133 reLyX may do weird things with optional arguments to
17140 Also, it may handle
17146 incorrectly (although the stuff in the environment should translate normally).
17149 \begin_layout Standard
17150 reLyX is hopefully rather robust.
17151 As mentioned above, it may not translate your file perfectly, but it shouldn't
17153 If it does crash---and the problem is not one of those mentioned above
17158 file---see Section\InsetSpace ~
17160 \begin_inset LatexCommand \ref{sub:relyx-bug-reports}
17167 \begin_layout Subsubsection
17168 What LyX Can't Handle
17171 \begin_layout Standard
17172 LyX itself is missing a couple features, such that even if reLyX translates
17173 things perfectly, LyX may still have trouble reading it.
17174 If you really need these features, you can export your final document as
17175 LaTeX, and put them back in.
17180 for more details on these bugs.
17183 \begin_layout Itemize
17184 For a number of commands, LyX does not support the optional argument.
17197 (and other sectioning commands), and
17206 reLyX will automatically discard the optional arguments with a warning
17208 LyX also ignores the width argument for the
17215 \begin_layout Itemize
17216 Centering (or right or left justifying) works on full paragraphs.
17219 \begin_layout Itemize
17220 LyX support for tables isn't perfect.
17221 For complicated tables, use a
17222 \begin_inset Quotes eld
17226 \begin_inset Quotes erd
17229 block, so that they will be copied in TeX mode.
17232 \begin_layout Itemize
17233 The LyX math editor can't handle the AMS-LaTeX math environments align,
17235 So those environments will be copied in TeX mode.
17240 environments to the exactly equivalent displaymath, and then they will
17241 be translated correctly.
17244 \begin_layout Subsection
17248 \begin_layout Standard
17252 \begin_inset Quotes eld
17256 \begin_inset Quotes erd
17260 \begin_inset Quotes eld
17264 \begin_inset Quotes erd
17267 foo.tex > foo.debug
17270 \begin_layout Standard
17271 The above will create a file my/dir/foo.lyx from foo.tex, overwriting if necessary.
17281 block, it will translate the stuff within the block, but copy the
17293 commands in TeX mode.
17294 Finally, I'm going to keep the temporary files around (they will also
17295 be in my/dir/) and output lots of debugging information into the file foo.debug.
17298 \begin_layout Subsection
17302 \begin_layout Subsubsection
17304 \begin_inset LatexCommand \label{sub:relyx-bug-reports}
17311 \begin_layout Standard
17312 If reLyX is crashing or otherwise acting strangely---in ways other than
17313 those described in Section\InsetSpace ~
17315 \begin_inset LatexCommand \ref{sub:relyx-bugs}
17319 or the bug tracker---then please run reLyX
17324 That will allow you to figure out where in the reLyXing process it crashed.
17325 That, in turn, will allow you to write a better bug report, which will
17326 allow the developers to fix it more quickly and easily.
17329 \begin_layout Standard
17330 Bug reports should be sent to the LyX developers' mailing list.
17331 Its address is currently
17333 lyx-devel@lists.lyx.org
17336 If you are running reLyX on a huge file, please do not send all of the
17337 output in your bug report.
17338 Just include the last ten or twenty lines of output, along with the piece
17339 of the LaTeX file it crashed on.
17340 Or, even better, attach a small but complete file which causes the same
17341 problem as your original file.
17344 \begin_layout Subsubsection
17345 Implementation Details:
17348 \begin_layout Standard
17349 reLyX makes several
17350 \begin_inset Quotes eld
17354 \begin_inset Quotes erd
17357 in order to translate a TeX file.
17358 On each pass, it creates one or two files.
17361 \begin_layout Description
17366 Before doing anything, read the syntax file (or files).
17369 \begin_layout Description
17374 Split preamble (anything before a
17380 command) off the rest of the file.
17381 It saves the two pieces in separate files.
17382 This is necessary because there may be very strange stuff in a preamble.
17383 It also ignores anything after the
17389 , on the assumption that it isn't LaTeX.
17392 \begin_layout Description
17397 Translate the preamble.
17398 Currently, that just means translating the
17404 command and copying the rest exactly into the LyX preamble.
17408 \begin_layout Standard
17409 Once you know what class the document is, read the LyX layout file for that
17414 \begin_layout Description
17420 \begin_inset Quotes eld
17424 \begin_inset Quotes erd
17427 the TeX file, generating slightly stricter LaTeX.
17432 \begin_layout Itemize
17437 to the equivalent but clearer
17442 \begin_layout Itemize
17443 Removing optional arguments that LyX can't handle (e.g., from
17452 \begin_layout Itemize
17466 This is necessary because LyX always writes out the non-local forms anyway.
17467 This should very rarely make a difference.
17471 \begin_layout Description
17476 Translate LaTeX text, commands, and environments to LyX.
17479 \begin_layout Description
17484 Put the two pieces back together, and do some final tweaking, to generate
17488 \begin_layout Standard
17501 commands, reLyX will loop back to the beginning and translate those.
17502 It assumes that the included files are the same class as the main file,
17503 and that they have no preamble matter.
17510 command in the preamble of a file, the command will be copied exactly into
17511 the LaTeX preamble portion of the LyX file, so the included file won't
17512 be translated.) So when translating included files, it skips passes 0 and
17516 \begin_layout Standard
17517 If reLyX doesn't find a file you wanted to include, it will give a warning,
17518 but will continue to translate any files it does find.
17521 \begin_layout Subsubsection
17525 \begin_layout Standard
17526 reLyX reads a LyX layout file to know how to handle LaTeX environments and
17527 commands which get translated to LyX layouts.
17528 This file will include all
17529 \begin_inset Quotes eld
17533 \begin_inset Quotes erd
17536 non-math environments (i.e., including quote and itemize, but not tabular,
17537 minipage, and some other fancy environments), and commands like
17550 If you want to reLyX a class that doesn't have an existing layout file,
17551 then you'll have to create a layout file.
17552 But you have to do this anyway, in order to LyX the file, since LyX depends
17553 on layout files to know how to display and process its files.
17554 Check the LyX documentation for help with this task (which can be hard
17555 or easy, depending on the class you want to create a layout file for.) If
17556 your class is quite similar to a class that has a layout file, then consider
17564 \begin_layout Subsubsection
17566 \begin_inset LatexCommand \label{sub:relyx-syntax}
17573 \begin_layout Standard
17574 reLyX always reads at least one syntax file, called the default syntax file.
17575 reLyX will read your personal syntax file if it exists; otherwise it will
17576 read the system-wide file.
17577 reLyX will read additional syntax files if you specify them with the
17582 (These extra files should have the same format as the default file, but
17583 will tend to be shorter, since they only have to specify extra commands
17584 not found in the default file.) A syntax file tells reLyX a few things.
17587 \begin_layout Standard
17588 First, it describes the syntax of each command, that is, how many required
17589 arguments and how many optional arguments the command takes.
17590 Knowing this makes it easier for reLyX to copy (in TeX mode) commands that
17591 it doesn't know how to translate.
17592 The syntax file simply has a command, followed by braces or brackets describing
17593 its arguments in the correct order.
17594 For example, a syntax file entry
17606 command takes an optional argument followed by a required one, while the
17619 command takes no arguments at all.
17620 When reLyX encounters a token that it doesn't know how to translate into
17621 LyX, it will copy the token---along with the correct number of arguments---exac
17623 If the token is not in the syntax file, then reLyX just copies as many
17624 arguments as it finds.
17625 This means that it may copy too much.
17626 But since the user can specify additional syntax files, that shouldn't
17630 \begin_layout Standard
17631 Some commands that cannot be translated to LyX, like
17637 , have as one of their arguments regular LaTeX text.
17639 \begin_inset Quotes eld
17643 \begin_inset Quotes erd
17646 is put into an argument of an (untranslatable) command in the syntax file,
17647 then reLyX will translate that argument instead of copying it verbatim.
17648 So, for example, the default syntax file has
17652 raisebox{}[][]{translate}
17655 This means that the
17661 command and the first argument (and optional arguments if they exist) are
17662 copied in TeX mode, but the last argument (which may contain math, complicated
17663 LaTeX, other untranslatable commands, etc.) will be translated into LyX.
17665 \begin_inset Quotes eld
17669 \begin_inset Quotes erd
17672 on optional arguments.
17675 \begin_layout Standard
17676 User-defined syntax files are allowed to define new commands and their syntax,
17677 or override the number of arguments for a command given in the default
17679 (E.g., if you're using a style that gives an extra argument to some command...)
17680 However, this will only be useful for commands copied in TeX mode.
17681 Commands which are actually translated by reLyX (like
17687 ) have their argument syntax hard-coded.
17688 The hard-coded commands are identified in the default syntax file.
17691 \begin_layout Standard
17692 Second, the syntax file describes any
17693 \begin_inset Quotes eld
17696 regular environments
17697 \begin_inset Quotes erd
17701 Usually, an entire unknown environment will be copied in TeX mode.
17702 If you define a regular environment
17703 \begin_inset Quotes eld
17707 \begin_inset Quotes erd
17710 , though, then only the
17722 commands will be copied in TeX mode; the text within the environment will
17723 be treated (i.e., translated) by reLyX as regular LaTeX, rather than being
17724 copied into TeX mode.
17725 Don't try to declare
17733 as regular environments, as the text within those environments will confuse
17734 reLyX; use this capability for new environments you create that have plain
17735 text or math or simple commands in them.
17736 You also can't declare unknown math environments (like
17740 ) as regular environments, either, since the LyX math editor won't understand
17742 The names of regular environments appear, whitespace-separated, between
17755 statements in the syntax file.
17756 (If you have a regular environment which you won't use very often, you
17761 option rather than writing a syntax file.)
17764 \begin_layout Standard
17765 Third, the syntax file describes a math translation table.
17766 The LyX math editor doesn't support a few commands.
17771 is supported, but the equivalent
17778 Put any commands you'd like translate between
17792 \begin_inset Quotes eld
17804 \begin_inset Quotes erd
17813 in math mode will be converted to
17814 \begin_inset Quotes eld
17824 \begin_inset Quotes erd
17831 (in cases where a token made up of a backslash and a non-letter is translated
17832 to something with letters at the end, a space is added by reLyX.
17834 \begin_inset Quotes eld
17844 \begin_inset Quotes erd
17847 is correctly translated to
17848 \begin_inset Quotes eld
17858 \begin_inset Quotes erd
17864 \begin_layout Subsubsection
17868 \begin_layout Standard
17869 You need Perl version 5.002 or later to run reLyX.
17870 <plug> If you don't have Perl, you should get it anyway (at
17871 \begin_inset LatexCommand \url[Perl]{http://www.perl.com/}
17875 ), because it's a really useful tool for pretty much anything.
17879 \begin_layout Subsection
17883 \begin_layout Standard
17884 reLyX should always explain why it crashes, if it crashes.
17885 Some diagnostics may be very technical, though, if they come from the guts
17887 reLyX gives much more information while running if you use the
17891 option, but you shouldn't need that unless something goes wrong.
17894 \begin_layout Standard
17895 When it's finished, reLyX will tell you if it finished successfully or died
17899 \begin_layout Subsection
17903 \begin_layout Standard
17904 Always keep a copy of your original LaTeX files either under a different
17905 name or in a different directory.
17906 There are a couple ways in which using LyX could lead to overwriting the
17907 original LaTeX file.
17910 \begin_layout Standard
17923 and want to re-export it, note that it will overwrite the original
17932 ask you if you want to overwrite it.)
17935 \begin_layout Standard
17936 If you have chosen not to use a temporary directory in the preferences,
17937 then LyX will create its temporary files in your current directory, which
17938 means your LaTeX original may be overwritten (without a warning from LyX)
17940 \begin_inset Quotes eld
17944 \begin_inset Quotes erd
17947 or print the LyX document.
17950 \begin_layout Subsection
17954 \begin_layout Description
17958 MY_LYXDIR/layouts/*.layout
17964 User's personal layout files for document classes
17967 \begin_layout Description
17971 MY_LYXDIR/reLyX/syntax.default
17977 User's personal syntax file
17980 \begin_layout Description
17984 LIBDIR/layouts/*.layout
17990 System-wide layout files for document classes
17993 \begin_layout Description
17997 LIBDIR/reLyX/syntax.default
18003 System-wide LaTeX syntax file
18006 \begin_layout Standard
18011 is the system-wide LyX directory, usually something like
18013 /usr/local/share/lyx/
18020 is your personal LyX directory, something like
18024 in your home directory.
18025 You can see their actual values in the
18030 elp\SpecialChar \menuseparator
18040 \begin_layout Subsection
18044 \begin_layout Standard
18056 \begin_layout Subsection
18060 \begin_layout Standard
18061 Copyright (c) 1998--9
18067 karger@voth.chem.utah.edu
18072 \begin_layout Standard
18076 \begin_layout Itemize
18081 wrote the original CleanTeX pass.
18084 \begin_layout Itemize
18090 \begin_layout Itemize
18098 \begin_layout Itemize
18101 David Suarez de Lis
18104 \begin_layout Standard
18105 Other contributors:
18108 \begin_layout Itemize
18111 Jean-Marc Lasgouttes
18113 worked on the wrapper script and offered lots of bug reports, advice, and
18114 feature suggestions.
18117 \begin_layout Itemize
18130 \begin_layout Itemize
18131 Various members of the LyX developers' and users' lists provided bug reports
18132 and feature suggestions.
18135 \begin_layout Standard
18136 reLyX uses a modified version the Perl TeX parser
18146 ilya@math.ohio-state.edu
18148 ), available on CPAN.
18151 \begin_layout Chapter
18152 LyX Features needing Extra Software
18155 \begin_layout Section
18156 Using LyX with SGML-Tools (aka LinuxDoc)
18159 \begin_layout Standard
18165 \begin_layout Subsection
18169 \begin_layout Standard
18170 LinuxDoc is a document class available in LyX if you have the
18175 You can use it to produce documents in the so-called Standardized General
18176 Mark-up Language (SGML) in the particular format used by the Linux Documentatio
18178 That is obviously helpful if you are contributing to that project.
18179 You can use the SGML format with the
18183 package of scripts and programs (to produce other formats, including Latex,
18184 HTML, plain text, man pages and\SpecialChar \ldots{}
18186 You may therefore prefer to use this document class if you want to write
18187 something that can be easily translated into other formats.
18190 \begin_layout Standard
18191 You will find that LinuxDoc has fewer layout options than the other text
18193 This is mainly so that the translations into other formats have a chance
18194 of making some sense.
18195 In this section we describe:
18198 \begin_layout Itemize
18199 how to setup and use a document in LinuxDoc
18202 \begin_layout Itemize
18203 how to use the tags in LinuxDoc to layout your document
18206 \begin_layout Itemize
18207 how to use the SGML packages to produce the various formats
18210 \begin_layout Itemize
18211 how to sort out some problems.
18214 \begin_layout Subsection
18215 Preparing and using a LinuxDoc document
18218 \begin_layout Subsubsection
18222 \begin_layout Standard
18223 You start by selecting the LinuxDoc class using the
18228 ocument\SpecialChar \menuseparator
18240 Then you will find that there are fewer paragraph environments than for
18241 most other classes.
18242 You can see them on the pull down box on the left of the tool bar.
18243 How to use them is described in section\InsetSpace ~
18245 \begin_inset LatexCommand \ref{sec:sgmlparas}
18252 \begin_layout Standard
18257 enter a title for the document, followed by an author, marking each with
18258 the appropriate paragraph environment.
18259 If you don't do this, you will get errors when you try to print the file.
18260 You can then enter the date and an abstract.
18261 The document proper must start with a Section paragraph environment rather
18262 than any standard layout.
18265 \begin_layout Standard
18266 After that you can prepare a document as usual using the available range
18267 of paragraph environments.
18268 See section\InsetSpace ~
18270 \begin_inset LatexCommand \ref{sec:sgmlparas}
18274 for the full list and their uses.
18277 \begin_layout Subsubsection
18278 Output from LinuxDoc
18281 \begin_layout Standard
18282 You can print and save these documents in the normal way.
18283 To use the other features of the SGML package you need to save your document
18284 as LinuxDoc; this is a version in which the document is translated into
18285 the basic sgml tags.
18292 ile\SpecialChar \menuseparator
18297 xport\SpecialChar \menuseparator
18305 You will get a file with the same name and a
18309 extension rather than a
18316 \begin_inset LatexCommand \ref{sec:sgmloperate}
18320 on how you than make use of this file.
18323 \begin_layout Subsection
18324 Using the paragraph environments in LinuxDoc
18327 \begin_layout Subsubsection
18328 The Structure of a LinuxDoc Document
18331 \begin_layout Standard
18332 There is a formal structure for LinuxDoc which limits how you can place
18334 There are two parts to all documents:
18337 \begin_layout Description
18338 Header: this is everything up to the first time you insert a Section layout
18340 It can include title, author, date, abstract and ToC.
18341 You must include the first two.
18344 \begin_layout Description
18345 Body: from the beginning of the first section onwards.
18346 All other tags are allowed.
18350 \begin_layout Subsubsection
18351 The LinuxDoc Paragraph Environments
18354 \begin_layout Standard
18355 \begin_inset LatexCommand \label{sec:sgmlparas}
18359 Here is a list of all the tags you will find listed on the layout bar in
18360 the order they come there, with some comments where the purpose or use
18364 \begin_layout Itemize
18369 works as described in [cross reference]
18372 \begin_layout Itemize
18377 : This will appear at the top left of the document when printed, above a
18378 heavy horizontal rule, although you will not see this on the LyX screen.
18381 \begin_layout Itemize
18384 Section, Subsection, Subsubsection, Paragraph and Subparagraph:
18386 all do what you would expect and in the usual order.
18387 Whether they are numbered or not is controlled by the
18389 Section\InsetSpace ~
18390 number\InsetSpace ~
18394 You cannot get the equivalent number free versions in any other way; there
18402 \begin_layout Itemize
18407 As usual this produces a numbered and indented list as described in the
18415 \begin_layout Itemize
18420 Again much the same as in the other classes: see the
18427 \begin_layout Itemize
18432 : As explained in the
18437 Remember that if you want the bold element at the start of a description
18438 to be more than one word then you need to put protected spaces between
18443 \begin_layout Itemize
18451 \begin_layout Itemize
18454 Code: similar to the Lyx-Code
18459 \begin_layout Itemize
18464 : Anything you mark with this will appear on the left of the heading of
18465 the document, under the heavy rule.
18468 \begin_layout Itemize
18473 Anything you mark with this will appear on the right of the heading under
18475 You do not have to make this a date.
18476 Any text can be entered, e.\InsetSpace ~
18481 \begin_layout Itemize
18486 : You can use this to produce a free standing paragraph after the author
18487 and date, and before the first section.
18488 You are only allowed one such paragraph.
18492 \begin_layout Standard
18498 This needs checking ---
18508 \begin_layout Itemize
18517 \begin_layout Standard
18522 I have not yet checked this ---
18532 \begin_layout Subsubsection
18533 Other document features
18536 \begin_layout Standard
18537 You can also use the
18541 menu to set fonts or to emphasis words.
18542 You can also use the table of contents as usual; see the corresponding
18548 Although you will find some some other features on the menus e.\InsetSpace ~
18550 inserting footnotes.
18551 There is some doubt about whether these will work correctly.
18555 \begin_layout Standard
18560 Again still checking to see whether this is my system
18570 \begin_layout Subsubsection
18571 Cross references and HTML
18574 \begin_layout Standard
18579 menu you will find two new options relating to the inclusion of URL addresses.
18580 If you use either option you will find some highlighted TeX code inserted
18581 into your document in three separate blocks with spaces available between.
18582 The blocks will be:
18585 \begin_layout Quote
18617 \begin_layout Standard
18618 You insert a full HTML tag between the first and second blocks.
18620 \begin_inset LatexCommand \url{http://any.address}
18624 or other valid tags such as
18625 \begin_inset LatexCommand \url{mailto:me@my.address}
18637 insert some description between the second and third blocks.
18638 The differences are:
18641 \begin_layout Itemize
18646 both the HTML tag and the description will appear in the document
18649 \begin_layout Itemize
18655 only the description appears in the printed version
18658 \begin_layout Subsection
18659 Using the LinuxDoc Sgml scripts
18660 \begin_inset Note Note
18663 \begin_layout Standard
18664 This section is completely outdated.
18672 \begin_layout Standard
18673 \begin_inset LatexCommand \label{sec:sgmloperate}
18677 You can use LinuxDoc as a text class without any additional scripts or programs,
18678 but there is not much point in doing this.
18679 All you will get is a document that looks like a
18681 Linux Documentation Project Howto
18687 To do the document translation you need to get and install the
18689 sgml-tools-1.0.x.tar.gz
18692 \begin_inset Formula $x\geq3$
18697 the SGML-Tools WWW Page
18702 \begin_layout LyX-Code
18705 \begin_inset LatexCommand \url{http://pobox.com/~cg/sgmltools}
18714 \begin_layout Standard
18715 Alternatively, you can go to the
18723 \begin_layout Standard
18724 Note that, at the time of this writing (01/1998), version 1.0.3 of sgml-tools
18725 has not yet been made available at
18737 \begin_layout LyX-Code
18740 \begin_inset LatexCommand \url{ftp://sunsite.unc.edu/pub/Linux/utils/text/sgml-tools-1.0.x.tar.gz}
18747 \begin_layout Standard
18754 sgml-tools-1.0.x.tar.gz
18756 contains everything that you need to write SGML documents and convert them
18757 to groff, LaTeX, HTML, GNU info, LyX, and RTF\SpecialChar \@.
18761 \begin_layout Standard
18762 This package was renamed from
18764 linuxdoc-sgml-1.5.tar.gz
18769 \begin_layout Standard
18770 Follow the instructions in that package on how to install it and how to
18772 All this has to be done outside of LyX, before you can use the
18777 ile\SpecialChar \menuseparator
18782 xport\SpecialChar \menuseparator
18789 \begin_layout Subsection
18790 Troubleshooting LinuxDoc
18793 \begin_layout Standard
18794 When you print or preview a LinuxDoc document some checking is done of the
18795 tags before LaTeX is run.
18796 Some errors are trapped here, especially those concerning the structure
18798 LyX may produce an error message, but not leave an error box in the document
18800 You may have to look at the files directly to discover what is wrong.
18801 Most problems seem to come from the use of options that are not fully available
18805 \begin_layout Section
18809 \begin_layout Standard
18815 \begin_layout Subsection
18819 \begin_layout Standard
18827 menu, you'll find a
18836 This feature requires you to have the
18840 program installed, and is grayed out if you don't have it.
18841 You can get it from your nearest CTAN mirror, or over the Web from
18842 \begin_inset LatexCommand \url{http://www.ifi.uio.no/~jensthi/chktex/}
18849 \begin_layout Standard
18854 package is a program that was written by
18859 in frustration because some constructs in LaTeX are sometimes non-intuitive,
18860 and easy to forget.
18861 The program runs over your LaTeX file and checks the integrity of the file,
18862 and flags some common errors.
18863 In other technical words, it is
18870 \begin_layout Standard
18871 Well, what is a syntax checker doing in LyX which is supposed to produce
18872 correct LaTeX anyways? The answer is simple: Just as
18876 not only checks the
18880 of C programs, but also does
18884 checks for type-errors,
18888 catches some common
18892 errors, in addition to the syntactical ones.
18897 is capable of detecting several common errors, such as
18900 \begin_layout Itemize
18901 Ellipsis detection:
18903 Use \SpecialChar \ldots{}
18907 \begin_layout Itemize
18908 No space in front of/after parenthesis:
18913 \begin_layout Itemize
18914 Enforcement of normal space after common abbreviations:
18918 is too wide spacing.
18921 \begin_layout Itemize
18922 Enforcement of end-of-sentence space when the last sentence ends with a
18926 And this is wrong spacing.
18929 \begin_layout Itemize
18930 Space in front of labels and similar commands:
18932 The label should stick right
18933 up to the text to avoid falling to a wrong page.
18935 \begin_inset LatexCommand \label{sec:chktex}
18943 \begin_layout Standard
18944 This footnote is in danger of falling off to a wrong page
18949 The label is separated too much.
18952 \begin_layout Itemize
18953 Space in front of references, instead of hard spaces:
18955 In you are in bad luck,
18956 the text will break right between the referenced text and reference number,
18959 \begin_inset LatexCommand \ref{sec:chktex}
18966 \begin_layout Itemize
18968 \begin_inset Quotes eld
18972 \begin_inset Quotes erd
18976 \begin_inset Formula $\times$
18981 2x2 looks cheap compared to
18982 \begin_inset Formula $2\times2$
18988 \begin_layout Standard
18989 and more \SpecialChar \ldots{}
18990 It is an invaluable tool when you are
18991 \begin_inset Quotes eld
18995 \begin_inset Quotes erd
18998 your document before printing, and you should run it right after the obligatory
18999 spelling check, and before you go fine tuning the typesetting.
19002 \begin_layout Subsection
19006 \begin_layout Standard
19007 If you have the program installed, usage is as simple as choosing
19012 ools\SpecialChar \menuseparator
19021 This will make LyX generate a LaTeX file of your document, start
19025 to check it, and then make LyX insert
19026 \begin_inset Quotes eld
19030 \begin_inset Quotes erd
19033 with the warnings from
19037 , if there were any.
19038 The warnings will be placed close to the point of the mistake, and you
19039 can quickly find them by using the
19044 avigate\SpecialChar \menuseparator
19051 menu item, or the shortcut key
19060 Open the error boxes by clicking on them with the mouse, or use the shortcut
19069 bindings, or the corresponding
19078 Read the warning and correct the mistake, if it is a mistake.
19079 If you have trouble understanding what the warning is about, you can safely
19081 Remember that there is a hidden layer between the document on screen and
19082 the technical details in invoking
19086 , and this gap can make some warnings seem arcane or just right down plain
19090 \begin_layout Standard
19091 This document is an excellent testing bed for the feature, and it should
19092 provide quite a few warnings for you to fiddle with.
19093 Since computers are only so smart, expect most of the warnings to be false
19097 \begin_layout Subsection
19098 How to fine tune it
19101 \begin_layout Standard
19102 Sometimes, you'll find that
19106 makes more noise than suits your mood.
19107 Then you can choose not to use it, wait until your mood changes, or try
19112 to get better along with you.
19113 Another choice in the most desperate situations is to use
19118 iew\SpecialChar \menuseparator
19128 , which will get rid of all warnings instantly.
19131 \begin_layout Standard
19140 very configurable and extensible, you shouldn't expect to solve all problems
19146 Since LyX has to generate a somewhat special LaTeX file to be able to match
19147 the line numbers from the
19155 \begin_layout Standard
19156 You can inspect the specific output from
19162 Edit\SpecialChar \menuseparator
19176 to the internal document structure, some of the warnings will not seen
19177 to appear correctly.
19178 There are two things you can do about this:
19181 \begin_layout Itemize
19186 invocation command line in
19202 installation configuration file (usually with the file
19204 /usr/local/share/chktexrc
19207 See below to learn what warnings can be enabled and disabled on the command
19212 \begin_layout Itemize
19213 Export your document as a raw LaTeX file using
19218 ile\SpecialChar \menuseparator
19223 xport\SpecialChar \menuseparator
19235 Invoked in this way, it can be a hassle to find the corresponding place
19236 in the document inside LyX, but with a little patience, you should be able
19240 \begin_layout Standard
19241 Here follows the warning messages that can be enabled and disabled in
19250 to disable a warning, and
19254 to enable a warning.
19255 The emphasized entries are disabled by default, because the default is
19258 chktex -n1 -n3 -n6 -n9 -n22 -n25 -n30 -n38
19263 \begin_layout Standard
19264 Notice that you should only use the options that enable and disable warnings,
19265 because LyX relies on some of the other command line parameters to be set
19266 in a specific way to have a chance to communicate with
19273 \begin_layout Enumerate
19277 Command terminated with space.
19280 \begin_layout Enumerate
19283 Non-breaking space (
19284 \begin_inset Quotes eld
19292 \begin_inset Quotes erd
19295 ) should have been used.
19298 \begin_layout Enumerate
19302 You should enclose the previous parenthesis with
19303 \begin_inset Quotes eld
19311 \begin_inset Quotes erd
19317 \begin_layout Enumerate
19320 Italic correction (
19321 \begin_inset Quotes eld
19331 \begin_inset Quotes erd
19334 ) found in non-italic buffer.
19337 \begin_layout Enumerate
19340 Italic correction (
19341 \begin_inset Quotes eld
19351 \begin_inset Quotes erd
19354 ) found more than once.
19357 \begin_layout Enumerate
19361 No italic correction (
19362 \begin_inset Quotes eld
19372 \begin_inset Quotes erd
19378 \begin_layout Enumerate
19382 \begin_inset Quotes eld
19390 \begin_inset Quotes erd
19394 \begin_inset Quotes eld
19402 \begin_inset Quotes erd
19408 \begin_layout Enumerate
19411 Wrong length of dash may have been used.
19414 \begin_layout Enumerate
19418 \begin_inset Quotes eld
19426 \begin_inset Quotes erd
19430 \begin_inset Quotes eld
19438 \begin_inset Quotes erd
19444 \begin_layout Enumerate
19448 \begin_inset Quotes eld
19456 \begin_inset Quotes erd
19462 \begin_layout Enumerate
19466 \begin_inset Quotes eld
19474 \begin_inset Quotes erd
19477 to achieve an ellipsis.
19480 \begin_layout Enumerate
19483 Inter-word spacing (
19484 \begin_inset Quotes eld
19494 \begin_inset Quotes eld
19497 ) should perhaps be used.
19500 \begin_layout Enumerate
19503 Inter-sentence spacing (
19504 \begin_inset Quotes eld
19514 \begin_inset Quotes erd
19517 ) should perhaps be used.
19520 \begin_layout Enumerate
19523 Could not find argument for command.
19526 \begin_layout Enumerate
19530 \begin_inset Quotes eld
19538 \begin_inset Quotes erd
19544 \begin_layout Enumerate
19547 Math mode still on at end of LaTeX file.
19550 \begin_layout Enumerate
19554 \begin_inset Quotes eld
19562 \begin_inset Quotes erd
19565 doesn't match the number of
19566 \begin_inset Quotes eld
19574 \begin_inset Quotes erd
19580 \begin_layout Enumerate
19583 You should use either
19586 \begin_inset Quotes eld
19594 \begin_inset Quotes erd
19599 as an alternative to
19600 \begin_inset Quotes eld
19608 \begin_inset Quotes erd
19614 \begin_layout Enumerate
19621 " (ASCII 39) instead of "
19628 \begin_layout Enumerate
19631 User-specified pattern found.
19634 \begin_layout Enumerate
19637 This command might not be intended.
19640 \begin_layout Enumerate
19647 \begin_layout Enumerate
19665 \begin_layout Enumerate
19668 Delete this space to maintain correct page references.
19671 \begin_layout Enumerate
19675 You might wish to put this between a pair of
19676 \begin_inset Quotes eld
19684 \begin_inset Quotes erd
19690 \begin_layout Enumerate
19693 You ought to remove spaces in front of punctuation.
19696 \begin_layout Enumerate
19699 Could not execute LaTeX command.
19702 \begin_layout Enumerate
19711 in front of small punctuation.
19714 \begin_layout Enumerate
19722 may look prettier here.
19725 \begin_layout Enumerate
19729 Multiple spaces detected in output.
19732 \begin_layout Enumerate
19735 This text may be ignored.
19738 \begin_layout Enumerate
19744 \begin_inset Quotes eld
19749 to begin quotation, not
19756 \begin_layout Enumerate
19763 to end quotation, not
19766 \begin_inset Quotes eld
19774 \begin_layout Enumerate
19780 \begin_layout Enumerate
19783 You should perhaps use
19784 \begin_inset Quotes eld
19792 \begin_inset Quotes erd
19798 \begin_layout Enumerate
19801 You should put a space in front of/after parenthesis.
19804 \begin_layout Enumerate
19807 You should avoid spaces in front of/after parenthesis.
19810 \begin_layout Enumerate
19814 You should not use punctuation in front of/after quotes.
19817 \begin_layout Enumerate
19820 Double space found.
19823 \begin_layout Enumerate
19826 You should put punctuation outside inner/inside display math mode.
19829 \begin_layout Enumerate
19832 You ought to not use primitive TeX in LaTeX code.
19835 \begin_layout Enumerate
19838 You should remove spaces in front of
19839 \begin_inset Quotes eld
19847 \begin_inset Quotes erd
19853 \begin_layout Enumerate
19856 \begin_inset Quotes eld
19864 \begin_inset Quotes erd
19867 is normally not followed by
19868 \begin_inset Quotes eld
19876 \begin_inset Quotes erd
19882 \begin_layout Standard
19883 In later versions of LyX, we hope to provide a more complete interface to
19884 this tool (and it's smaller cousin
19888 ) to exploit the full power of it.
19889 But it's not exactly useless as it is now: go try it on one of your existing
19890 documents of a certain length and be surprised.
19893 \begin_layout Section
19894 Version Control in LyX
19897 \begin_layout Standard
19900 Lars Gullik Bjønnes
19903 \begin_layout Subsection
19907 \begin_layout Standard
19908 A friend of mine wanted to try LyX for a group project.
19909 When he didn't find support for version control or file locking, he dropped
19911 This angered me a bit, so I thought that I should at least make support
19912 for RCS (with the possibility of CVS and/or SCCS as a future improvement.)
19913 This has now been done.
19914 LyX now supports some of the most basic RCS commands.
19915 If you need to something a bit more sophisticated you will have to do that
19916 manually in an xterm.
19919 \begin_layout Standard
19920 Before you begin to use the version control features in LyX, you should
19922 \begin_inset Quotes eld
19926 \begin_inset Quotes erd
19929 (a man file, read it with
19934 This file describes all the basic features of RCS.
19935 You should especially notice the comment about a RCS directory, and the
19936 notion of a master RCS file (the file ending in
19943 \begin_layout Standard
19944 The implementation in LyX assumes a recent version of the GNU RCS package---no
19945 guarantees are made for older versions.
19948 \begin_layout Subsection
19949 RCS commands in LyX
19952 \begin_layout Standard
19953 The following sections describe the RCS commands supported by LyX.
19954 You can find them in the
19959 ile\SpecialChar \menuseparator
19964 ersion\InsetSpace ~
19970 \begin_layout Subsubsection
19976 \begin_layout Standard
19977 If your document is not under revision control, this is the only item shown
19979 And if it is under revision control, the
19986 item is grayed out.
19990 \begin_layout Standard
19991 This command registers your document with RCS\SpecialChar \@.
19992 You are asked interactively
19993 to supply an initial description of the document.
19994 The document is now set in Read-Only mode and you have to
20001 , before making any changes to it.
20002 A document under revision control has a
20003 \begin_inset Quotes eld
20006 [RCS:<version> <locker>]
20007 \begin_inset Quotes erd
20010 item tagged to the filename in the minibuffer.
20013 \begin_layout Standard
20014 RCS command that is run:
20016 ci -q -u -i -t-"<initial description>" <file-name>
20019 \begin_layout Standard
20024 to understand the switches.
20028 \begin_layout Subsubsection
20034 \begin_layout Standard
20035 When you are finished editing a file, you check in your changes.
20036 When you do this, you are asked for a description of the changes.
20037 This is stored in the history log.
20038 The version number is bumped, your changes are applied to the master RCS
20039 file, the document is unlocked and set to Read-Only mode.
20043 \begin_layout Standard
20046 ci -q -u -m"<description>" <file-name>
20049 \begin_layout Subsubsection
20055 \begin_layout Standard
20056 By doing this you lock the document so that only you can edit it.
20057 This will also make the document Read-Write only for you.
20058 You will usually continue editing for a while and when you are finished
20059 you check in your changes.
20060 The status line is changed to reflect that you have locked the file.
20064 \begin_layout Standard
20067 co -q -l <file-name>
20070 \begin_layout Subsubsection
20073 Revert To Last Version
20076 \begin_layout Standard
20077 This will discard all changes made to the document since the last check
20079 You get a warning before changes are discarded.
20082 \begin_layout Standard
20085 co -f -u<version> <file-name>
20088 \begin_layout Subsubsection
20094 \begin_layout Standard
20095 This makes as if the last check in never happened.
20096 No changes are made to the document loaded into LyX, but the last version
20097 is removed from the master RCS file.
20101 \begin_layout Standard
20104 rcs -o<version> <file-name>
20107 \begin_layout Subsubsection
20113 \begin_layout Standard
20114 This show the complete history of the RCS document.
20119 is shown in a browser.
20127 \begin_layout Section
20128 Literate Programming
20131 \begin_layout Standard
20136 (kayvan@sylvan.com)
20140 original documentation written by
20142 Edmar Wienskoski Jr.
20145 (edmar-w-jr@technologist.com)
20148 \begin_layout Subsection
20152 \begin_layout Standard
20153 The main purpose of this documentation is to show you how to use LyX for
20154 literate programming.
20155 Where it is assumed that you are familiar with this programming technique,
20157 \begin_inset Quotes eld
20161 \begin_inset Quotes erd
20165 \begin_inset Quotes eld
20169 \begin_inset Quotes erd
20173 If that is not the case, please follow the web links provided in the following
20175 There is a lot of good documentation out there covering old development
20176 history to the latest tools tips.
20179 \begin_layout Standard
20180 It is also assumed that you are familiar with LyX itself to a point that
20181 you are comfortable changing your LyX preferences, and X resources file.
20182 If that is not the case please refer to other LyX documentation to cover
20183 your specific needs.
20186 \begin_layout Subsection
20187 Literate Programming
20190 \begin_layout Standard
20191 From the Literate Programming FAQ:
20194 \begin_layout Quotation
20195 Literate programming is the combination of documentation and source together
20196 in a fashion suited for reading by human beings.
20197 In fact, literate programs should be enjoyable reading, even inviting!
20198 (Sorry Bob, I couldn't resist!) In general, literate programs combine source
20199 and documentation in a single file.
20200 Literate programming tools then parse the file to produce either readable
20201 documentation or compilable source.
20202 The WEB style of literate programming was created by D.E.
20203 Knuth during the development of his TeX typesetting software.
20207 \begin_layout Standard
20208 Another excerpt says:
20211 \begin_layout Quotation
20214 How is literate programming different from verbose commenting?
20217 \begin_layout Quotation
20218 There are three distinguishing characteristics.
20219 In order of importance, they are:
20223 \begin_layout Itemize
20224 flexible order of elaboration
20227 \begin_layout Itemize
20228 automatic support for browsing
20231 \begin_layout Itemize
20232 typeset documentation, especially diagrams and mathematics
20236 \begin_layout Standard
20237 Now that I sparked your curiosity, take a look in the references.
20240 \begin_layout Subsubsection
20244 \begin_layout Standard
20245 The complete Literate Programming FAQ can be found at:
20248 \begin_layout Quote
20249 \begin_inset LatexCommand \url[Literate Programming FAQ]{http://shelob.ce.ttu.edu/daves/lpfaq/faq.html}
20256 \begin_layout Standard
20257 The FAQ lists 23 (twenty three!) different literate programming tools.
20258 Where some are specialized or
20259 \begin_inset Quotes eld
20263 \begin_inset Quotes erd
20266 for particular programming languages, while other have general scope.
20271 for my own use for several reasons:
20274 \begin_layout Itemize
20275 It can generate the documentation either in latex or html.
20278 \begin_layout Itemize
20279 It has a open architecture, i.e., it is easy to plug in new filters and to
20280 perform special processing that you may need.
20284 \begin_layout Itemize
20285 There is a good selection of filters available already (the html is one
20289 \begin_layout Itemize
20293 \begin_layout Standard
20294 The Noweb web page can be found at:
20297 \begin_layout Quote
20298 \begin_inset LatexCommand \url[Noweb home page]{http://www.cs.virginia.edu/~nr/noweb/}
20305 \begin_layout Standard
20306 Starting from there you can reach many other interesting links and even
20307 some literate program examples.
20310 \begin_layout Subsection
20311 LyX and Literate Programming
20314 \begin_layout Standard
20315 The LyX support for Literate Programming is provided by using the generic
20316 LyX convertors mechanism.
20317 This support is provided in a
20318 \begin_inset Quotes eld
20322 \begin_inset Quotes erd
20325 way, i.e., you will be able to use this new LyX feature with some other literate
20326 programming tool of your choice by just changing your LyX preferences.
20329 \begin_layout Subsubsection
20330 Generating documents and code (weaving and tangling)
20333 \begin_layout Paragraph
20334 Selecting the document class
20337 \begin_layout Standard
20338 If you have installed Noweb and LyX successfully, whenever you open a new
20339 document or try to change the document class of an existing one, you will
20340 find that there are three new document classes available:
20343 \begin_layout Itemize
20347 \begin_layout Itemize
20351 \begin_layout Itemize
20355 \begin_layout Standard
20356 You must select one of them to create your literate documents from.
20360 \begin_layout Standard
20361 Note that literate documents are not limited to these three classes.
20362 New classes can be generated from other styles like letter or in combination
20363 with other class variations like Article (AMS).
20364 If you have special needs that cannot be covered by one of the existing
20365 classes, let the LyX developers list (lyx-devel@lists.lyx.org) know and we
20366 will arrange to insert a new entry, or teach you how to do it.
20370 \begin_layout Standard
20371 It is very simple, it involves the creation of a file with four lines, and
20372 re-running of the auto configuration.
20377 Moreover, if you use a literate tool other than Noweb you may need to create
20378 a new set of document classes for it.
20381 \begin_layout Paragraph
20385 \begin_layout Standard
20386 LyX enables you to write code with a layout named
20394 \begin_layout Standard
20395 The equivalent Noweb term is
20396 \begin_inset Quotes eld
20400 \begin_inset Quotes erd
20404 For historical reasons, I got used to the term
20405 \begin_inset Quotes eld
20409 \begin_inset Quotes erd
20412 introduced by other literate tool named Nuweb, which I used for many years
20413 before rendering myself to Noweb.
20418 Noweb delimits scraps like this:
20421 \begin_layout LyX-Code
20425 \begin_layout LyX-Code
20429 \begin_layout LyX-Code
20433 \begin_layout LyX-Code
20437 \begin_layout LyX-Code
20441 \begin_layout Standard
20442 The problem is that whatever is written in between the << and the
20446 must be taken literally, i.e., LyX should be prevented from making any special
20447 interpretation of what has been written.
20448 This is handled by a special layout named Scrap, that works like a normal
20449 paragraph but has a free spacing capability.
20452 \begin_layout Standard
20453 The down side of the Scrap paragraph layout is that consecutive paragraphs
20454 of code will be spaced with one empty line in the source code and also
20455 in the printed documentation.
20456 The work around is to enter each line of code within a single Scrap, with
20457 a newline (ctrl-return).
20458 The example above will look like this:
20462 \begin_layout Standard
20463 If you have a printed version of this document you will not see any difference
20464 between the previous example and this one.
20472 \begin_layout LyX-Code
20484 \begin_layout Standard
20485 This layout works fine.
20486 The only real inconvenience is that you have to type ctrl-return instead
20491 \begin_layout Standard
20492 It is in my list of
20493 \begin_inset Quotes eld
20497 \begin_inset Quotes erd
20508 \begin_layout Standard
20509 As a special note, you can also use the
20510 \begin_inset Quotes eld
20514 \begin_inset Quotes erd
20517 construct of Noweb in your scraps to add items to Noweb's identifier cross-refe
20521 \begin_layout LyX-Code
20524 def some_function(args):
20526 "This is the doc string for this
20529 print "My args: ", args
20532 \begin_layout LyX-Code
20533 @ %def some_function
20536 \begin_layout Standard
20537 For an example of this usage and the resulting cross-reference output, look
20538 at the Literate python program in
20540 LIBDIR/examples/listerrors.lyx
20542 which should make this all clear.
20545 \begin_layout Paragraph
20546 Generating the documentation
20549 \begin_layout Standard
20550 At this point you already have a new document file with a proper document
20551 class, and with some code and text on it.
20552 How do I print it? The answer is simple, you select
20557 iew\SpecialChar \menuseparator
20565 Just like you would do for a plain document.
20566 No special procedure is required.
20569 \begin_layout Standard
20570 To help orientate you, I will now explain what happens inside LyX:
20573 \begin_layout Enumerate
20579 pdate\SpecialChar \menuseparator
20586 menu option is chosen, a latex file is generated.
20591 \begin_layout Standard
20592 If the document is of any literate class the generated file will be named
20593 with an extension name defined by the
20594 \begin_inset Quotes eld
20598 \begin_inset Quotes erd
20601 format (defined in the Preferences panel), otherwise the file will have
20610 \begin_layout Enumerate
20611 Note that the only difference so far is in the name of the file, no special
20612 processing is required by LyX.
20613 Given that you formatted the code using the Scrap layout that, by itself,
20614 takes care of the business.
20617 \begin_layout Enumerate
20618 If the document is of any literate class LyX will then use the internal
20619 LyX to Noweb converter, followed by the Noweb to LaTeX converter
20623 \begin_layout Standard
20624 The converters are defined in the
20629 ools\SpecialChar \menuseparator
20637 \begin_inset Quotes eld
20641 \begin_inset Quotes erd
20649 to generate the LaTeX file.
20653 \begin_layout Standard
20654 Otherwise it will just skip this step.
20658 \begin_layout Enumerate
20659 Finally, LaTeX is invoked and the regular post processing continues as in
20663 \begin_layout Standard
20664 Independence from a particular
20665 \begin_inset Quotes eld
20669 \begin_inset Quotes erd
20672 is easily achieved by changing the commands that are run by the various
20676 \begin_layout Paragraph
20677 Generating the code
20680 \begin_layout Standard
20681 When the build menu option is chosen or the corresponding button in the
20682 toolbar is pressed, a latex file is generated just like step 1 above.
20683 Next, LyX invokes the
20688 Typically, this converter (like any other converter), has two parts:
20691 \begin_layout Enumerate
20692 The converter program itself.
20693 This program performs the conversion from the one format to the other (in
20694 this case, from the Noweb format to the Program pseudo-format).
20697 \begin_layout Enumerate
20698 The error log parser.
20699 This is a program whose sole purpose is to rewrite error messages in a
20700 format that LyX understands.
20701 This makes it possible for LyX to place error boxes in the right places
20702 in the file buffer.
20705 \begin_layout Standard
20706 The first part, the
20707 \begin_inset Quotes eld
20711 \begin_inset Quotes erd
20714 setting, should be set to
20715 \begin_inset Quotes eld
20723 \begin_inset Quotes erd
20727 This basically means that LyX will call
20728 \begin_inset Quotes eld
20732 \begin_inset Quotes erd
20735 (a program or script) with the name of the Noweb file (generally a file
20736 in the LyX temp directory).
20740 \begin_layout Standard
20741 This is an implementation of
20742 \begin_inset Quotes eld
20746 \begin_inset Quotes erd
20749 that you can place in a directory on your path:
20752 \begin_layout LyX-Code
20756 \begin_layout LyX-Code
20760 \begin_layout LyX-Code
20761 notangle -Rbuild-script $1 | env NOWEB_SOURCE=$1 sh
20764 \begin_layout Standard
20765 The next part of the converter setting is the
20766 \begin_inset Quotes eld
20770 \begin_inset Quotes erd
20773 which is to be set to
20774 \begin_inset Quotes eld
20779 originaldir,parselog=listerrors
20782 \begin_inset Quotes erd
20786 This will run any errors that are generated by the
20787 \begin_inset Quotes eld
20791 \begin_inset Quotes erd
20794 process through the
20795 \begin_inset Quotes eld
20799 \begin_inset Quotes erd
20805 \begin_layout Standard
20806 The converter code looks in
20814 then on the path for the
20815 \begin_inset Quotes eld
20819 \begin_inset Quotes erd
20825 \begin_layout Paragraph
20826 Build instructions in the document
20829 \begin_layout Standard
20830 The last piece of the integration between LyX and noweb is the
20831 \begin_inset Quotes eld
20835 \begin_inset Quotes erd
20839 Generally, the instructions for building your program should be embedded
20840 in a scrap of its own.
20842 \begin_inset Quotes eld
20846 \begin_inset Quotes erd
20849 above uses the notangle command to look for this scrap (called
20850 \begin_inset Quotes eld
20854 \begin_inset Quotes erd
20857 ) and runs its contents through
20858 \begin_inset Quotes eld
20862 \begin_inset Quotes erd
20868 \begin_layout Standard
20869 Typically, such a scrap would look something like this:
20872 \begin_layout LyX-Code
20879 if [ -z "${NOWEB_SOURCE}" ]
20883 NOWEB_SOURCE=myfile.nw
20889 code to extract files ...]
20892 code to compile files ...]
20897 \begin_layout Standard
20900 LIBDIR/examples/listerrors.lyx
20904 LIBDIR/examples/Literate.lyx
20906 which implement two versions of the
20907 \begin_inset Quotes eld
20911 \begin_inset Quotes erd
20914 program for some illustrations of how all of these pieces go together or
20917 LIBDIR/examples/noweb2lyx.lyx.
20920 Interestingly, these three files show off the language-indepence of the
20921 LyX literate programming support since they are written in Python, C and
20925 \begin_layout Subsubsection
20929 \begin_layout Standard
20930 All the Literate Programming support is configured by the
20935 ools\SpecialChar \menuseparator
20943 \begin_inset Quotes eld
20947 \begin_inset Quotes erd
20951 The important parts are:
20954 \begin_layout Description
20957 \begin_inset Quotes eld
20961 \begin_inset Quotes erd
20965 format Set up via the Formats tab, this is where the Noweb-specific pieces
20975 , the file extension is set to
20980 This tells LyX to create a file with a
20984 extension in the first step of the conversion process.
20987 \begin_layout Description
20994 format This is an empty format whose sole purpose is to be the endpoint
20995 of a conversion (which then allows us to set up a converter for it).
20998 \begin_layout Description
21007 This converter performs the
21008 \begin_inset Quotes eld
21012 \begin_inset Quotes erd
21015 of the literate document.
21016 For Noweb, it is set to
21017 \begin_inset Quotes eld
21022 noweave -delay -index $$i > $$o
21025 \begin_inset Quotes erd
21031 \begin_layout Description
21041 \begin_inset Quotes eld
21045 \begin_inset Quotes erd
21049 As stated above, the Converter is set to
21050 \begin_inset Quotes eld
21058 \begin_inset Quotes erd
21061 , with Flags set to
21062 \begin_inset Quotes eld
21067 originaldir,parselog=listerrors
21070 \begin_inset Quotes erd
21076 \begin_layout Subsubsection
21080 \begin_layout Standard
21081 There is also a new function implemented in the LyX server, the
21082 \begin_inset Quotes eld
21085 server-goto-file-row" function, to be used with ddd/gdb or other debugger.
21089 \begin_layout Standard
21090 When debugging code with ddd/gdb, it is possible to invoke a text editor
21091 at the current execution position with a single key stroke.
21092 The default ddd configuration for that is shift-ctrl-V.
21093 It happens that you can define the editor command line invocation in ddd
21100 dit\SpecialChar \menuseparator
21105 references\SpecialChar \menuseparator
21112 dialog and changing the "Edit Sources" entry.
21115 \begin_layout Standard
21116 I take advantage of the new created LyX server function and this ddd feature,
21118 \begin_inset Quotes eld
21122 \begin_inset Quotes erd
21128 \begin_layout LyX-Code
21129 echo "LYXCMD:monitor:server-goto-file-row:@FILE@ @LINE@" >~/.lyxpipe.in
21132 \begin_layout Standard
21133 With this, whenever you are using ddd and find a point in the program that
21134 you want to edit, you just press shift-ctrl-V (in the ddd window), and
21135 ddd you forward this information to LyX through the LyX server and then
21136 the LyX window will show the same file with the cursor at the same position
21137 ddd was pointing to.
21138 No more guessing or long scrolling to locate a point in the program back
21142 \begin_layout Standard
21143 Note however that you must enable the LyX server to get this feature working
21144 (it is disabled by default).
21145 You can enable it in
21157 ) by entering in the
21162 \begin_inset Quotes eld
21167 /home/<your-home-directory>/.lyx/lyxpipe
21170 \begin_inset Quotes erd
21176 \begin_layout Standard
21177 Read the LyX server documentation in the
21179 Customization Manual
21181 for further information.
21184 \begin_layout Subsubsection
21188 \begin_layout Standard
21189 There are six new buttons that can be added to your LyX toolbar.
21190 Five of these buttons are short cuts to layout styles:
21211 The last one is a short cut to the
21212 \begin_inset Quotes eld
21216 \begin_inset Quotes erd
21223 \begin_layout Standard
21224 LyX has a range of buttons that are available for tool bar customization.
21225 In my toolbar I like to combine the six short cuts above with two more:
21233 \SpecialChar \menuseparator
21241 \SpecialChar \menuseparator
21254 iew\SpecialChar \menuseparator
21262 Here is how it looks like:
21265 \begin_layout LyX-Code
21269 \begin_layout LyX-Code
21273 \begin_layout LyX-Code
21274 Icon "layout Standard"
21277 \begin_layout LyX-Code
21278 Icon "layout Section"
21281 \begin_layout LyX-Code
21282 Icon "layout LaTeX"
21285 \begin_layout LyX-Code
21286 Icon "layout LyX-Code"
21289 \begin_layout LyX-Code
21290 Icon "layout Scrap"
21293 \begin_layout LyX-Code
21297 \begin_layout LyX-Code
21301 \begin_layout LyX-Code
21302 Icon "buffer-typeset"
21305 \begin_layout LyX-Code
21306 Icon "build-program"
21309 \begin_layout LyX-Code
21313 \begin_layout LyX-Code
21317 \begin_layout LyX-Code
21321 \begin_layout LyX-Code
21325 \begin_layout LyX-Code
21329 \begin_layout Subsubsection
21330 Colors customization
21333 \begin_layout Standard
21334 There are a number of colors in LyX that can be customized in
21339 One of the things that bothers people is the LaTeX font color.
21340 The default color is red, since the scraps uses LaTeX font, and there is
21341 a lot of scraps in literate documents, you may get tired of seeing everything
21343 You can change it by going to the tabs
21352 \begin_layout Standard
21353 The next thing is the visible presence of the newline character in the screen.
21354 You can choose the color of this particular character and make it blend
21356 I recommend you choosing a color that is close to the background but not
21357 equal, that way you still can see it is there, but it is not bothering
21362 \begin_layout Chapter
21363 Secrets of the LaTeX Masters
21364 \begin_inset LatexCommand \label{cha:secrets}
21371 \begin_layout Standard
21372 Though LyX is a powerful tool, it cannot hope to support everything that
21373 can be done with pure TeX/LaTeX.
21374 However, many familiar dirty TeX and LaTeX tricks can be done within LyX,
21375 as long as you are not afraid to use that
21376 \begin_inset Quotes eld
21380 \begin_inset Quotes erd
21383 button on the toolbar or add things to the LaTeX preamble.
21384 This section lists some tips, tricks, and otherwise cool ideas to give
21385 your document that extra little flair.
21388 Do try this at home
21390 , just start with something a little smaller and less important than your
21394 \begin_layout Standard
21395 Most ideas in this section require less common files in your LaTeX installation.
21396 If you have a system like teTeX, most will already be available.
21397 A few, however, will need to be downloaded from one of the CTAN archives.
21398 Often, there are several ways to do something, or several LaTeX style files
21399 which do the same thing.
21400 We do not endorse one choice over another, we simply claim that we have
21401 done a particular task with a particular file.
21402 Put on your wizard hat, keep an eye out for dragons, and let us begin.
21405 \begin_layout Section
21406 Tricks for Footnotes and Margin Notes
21409 \begin_layout Standard
21415 \begin_layout Subsection
21419 \begin_layout Standard
21420 LyX cannot yet take care of setting the footnote numbering back to 1 after
21421 each section in the
21422 \begin_inset Quotes eld
21430 \begin_inset Quotes erd
21435 document class or changing the counter style.
21436 You'll need to insert LaTeX commands like the following to achieve that:
21439 \begin_layout Standard
21443 \begin_layout Standard
21446 setcounter{footnote}{0}
21455 setcounter{footnote}{0}
21457 will set the counter back to 1
21461 \begin_layout Standard
21462 The counter has been set back to 1.
21470 \begin_layout Standard
21471 The following command will change the numbering to small letters.
21472 Take a look at the next footnote in your xdvi or ghostview
21476 \begin_layout Standard
21492 \begin_layout Standard
21493 This is an example for a footnote with alphabetic numbering.
21513 \begin_layout Standard
21514 The next command sets the counter style back to default, i.e.
21525 \begin_layout Standard
21536 to set the counter--style back to LyX's default, i.e.
21545 \begin_layout Standard
21565 \begin_layout Standard
21596 and others as counter styles.
21597 Just replace the LaTeX command in the above example and rerun TeX to see
21598 what those styles can do.
21602 \begin_layout Subsection
21606 \begin_layout Standard
21607 Here are two examples of neat things you can do to margin notes using LaTeX
21611 \begin_layout Standard
21612 The following command will make a vertical line appear alongside your text---gre
21614 \begin_inset Quotes eld
21618 \begin_inset Quotes erd
21627 rule[-10mm]{30mm}{5mm}}
21635 \begin_layout Standard
21640 rule[-10mm]{30mm}{5mm}}
21648 \begin_layout Standard
21649 Check your dvi- or ghostview-output to see what the
21655 command does to the following margin note.
21658 \begin_layout Standard
21662 \begin_layout Standard
21671 \begin_inset Marginal
21674 \begin_layout Standard
21685 \begin_layout Section
21689 \begin_layout Standard
21692 Lars Gullik Bjønnes
21695 \begin_layout Subsection
21699 \begin_layout Standard
21700 The aim for this chapter
21704 \begin_layout Standard
21705 Editor's note: Lars' original chapter was a masterful description of how
21711 However, it was too long to flow smoothly in this document.
21712 I have therefore chosen to excerpt the most important sections here (sorry,
21713 Lars); you can read the original chapter (and more of the story!) in the
21716 examples/multicol.lyx
21724 is to show how the LaTeX package
21728 can be used in a LyX document.
21729 As LyX doesn't support the
21733 package natively yet, we have to use some small hacks.
21734 By reading this section it should be obvious how to do this.
21737 \begin_layout Subsection
21741 \begin_layout Standard
21746 package allows switching between one and multicolumn format on the same
21748 Footnotes are handled correctly (for the most part), but will be placed
21749 at the bottom of the page and not under each column.
21750 LaTeX's float mechanism, however, is partly disabled in the current implementat
21752 At the moment only page-wide floats can be used within the scope of the
21756 \begin_layout Subsection
21760 \begin_layout Subsubsection
21764 \begin_layout Standard
21765 If you want to have two columns in your text, you have use LaTeX mode to
21770 begin{multicols}{2}
21772 at the point where you want the two column layout to start, and then
21778 where you want it to end.
21782 \begin_layout Standard
21786 \begin_layout Standard
21789 begin{multicols}{2}
21797 \begin_layout Standard
21802 The Adventure of the Empty House
21808 Sir Arthur Conan Doyle
21811 \begin_layout Standard
21814 It was in the spring of the year 1894 that all London was interested, and
21815 the fashionable world dismayed, by the murder of the Honourable Ronald
21816 Adair under most unusual and inexplicable circumstances.
21817 The public has already learned those particulars of the crime which came
21818 out in the police investigation, but a good deal was suppressed upon that
21819 occasion, since the case for the prosecution was so overwhelmingly strong
21820 that it was not necessary to bring forward all the facts.
21821 Only now, at the end of nearly ten years, am I allowed to supply those
21822 missing links which make up the whole of that remarkable chain.
21823 The crime was of interest in itself, but that interest was as nothing to
21824 me compared to the inconceivable sequel, which afforded me the greatest
21825 shock and surprise of any event in my adventurous life.
21826 Even now, after this long interval, I find myself thrilling as I think
21827 of it, and feeling once more that sudden flood of joy, amazement, and increduli
21828 ty which utterly submerged my mind.
21829 Let me say to that public, which has shown some interest in those glimpses
21830 which I have occasionally given them of the thoughts and actions of a very
21831 remarkable man, that they are not to blame me if I have not shared my knowledge
21832 with them, for I should have considered it my first duty to do so, had
21833 I not been barred by a positive prohibition from his own lips, which was
21834 only withdrawn upon the third of last month.
21837 \begin_layout Standard
21841 \begin_layout Standard
21852 \begin_layout Subsubsection
21856 \begin_layout Standard
21857 The same pattern is used when you want more than two columns:
21860 \begin_layout Standard
21864 \begin_layout Standard
21867 begin{multicols}{3}
21875 \begin_layout Standard
21878 It can be imagined that my close intimacy with Sherlock Holmes had interested
21879 me deeply in crime, and that after his disappearance I never failed to
21880 read with care the various problems which came before the public.
21881 And I even attempted, more than once, for my own private satisfaction,
21882 to employ his methods in their solution, though with indifferent success.
21883 There was none, however, which appealed to me like this tragedy of Ronald
21885 As I read the evidence at the inquest, which led up to a verdict of willful
21886 murder against some person or persons unknown, I realized more clearly
21887 than I had ever done the loss which the community had sustained by the
21888 death of Sherlock Holmes.
21889 There were points about this strange business which would, I was sure,
21890 have specially appealed to him, and the efforts of the police would have
21891 been supplemented, or more probably anticipated, by the trained observation
21892 and the alert mind of the first criminal agent in Europe.
21893 All day, as I drove upon my round, I turned over the case in my mind and
21894 found no explanation which appeared to me to be adequate.
21895 At the risk of telling a twice-told tale, I will recapitulate the facts
21896 as they were known to the public at the conclusion of the inquest.
21899 \begin_layout Standard
21903 \begin_layout Standard
21914 \begin_layout Standard
21915 You can have have more than 3 columns if you want to, but that might not
21916 be very pleasant for the eye.
21919 \begin_layout Subsubsection
21920 Columns inside columns
21923 \begin_layout Standard
21924 You can even have columns inside columns:
21927 \begin_layout Standard
21931 \begin_layout Standard
21934 begin{multicols}{2}
21942 \begin_layout Standard
21945 The Honourable Ronald Adair was the second son of the Earl of Maynooth,
21946 at that time governor of one of the Australian colonies.
21947 Adair's mother had returned from Australia to undergo the operation for
21948 cataract, and she, her son Ronald, and her daughter Hilda were living together
21952 \begin_layout Standard
21956 \begin_layout Standard
21959 begin{multicols}{2}
21967 \begin_layout Standard
21970 The youth moved in the best society--had, so far as was known, no enemies
21971 and no particular vices.
21972 He had been engaged to Miss Edith Woodley, of Carstairs, but the engagement
21973 had been broken off by mutual consent some months before, and there was
21974 no sign that it had left any very profound feeling behind it.
21975 For the rest {sic} the man's life moved in a narrow and conventional circle,
21976 for his habits were quiet and his nature unemotional.
21977 Yet it was upon this easy-going young aristocrat that death came, in most
21978 strange and unexpected form, between the hours of ten and eleven-twenty
21979 on the night of March 30, 1894.
21982 \begin_layout Standard
21986 \begin_layout Standard
21997 \begin_layout Standard
22000 Ronald Adair was fond of cards--playing continually, but never for such
22001 stakes as would hurt him.
22002 He was a member of the Baldwin, the Cavendish, and the Bagatelle card clubs.
22003 It was shown that, after dinner on the day of his death, he had played
22004 a rubber of whist at the latter club.
22005 He had also played there in the afternoon.
22010 The evidence of those who had played with him-- Mr.
22011 Murray, Sir John Hardy, and Colonel Moran--showed that the game was whist,
22012 and that there was a fairly equal fall of the cards.
22013 Adair might have lost five pounds, but not more.
22014 His fortune was a considerable one, and such a loss could not in any way
22016 He had played nearly every day at one club or other, but he was a cautious
22017 player, and usually rose a winner.
22018 It came out in evidence that, in partnership with Colonel Moran, he had
22019 actually won as much as four hundred and twenty pounds in a sitting, some
22020 weeks before, from Godfrey Milner and Lord Balmoral.
22021 So much for his recent history as it came out at the inquest.
22024 \begin_layout Standard
22028 \begin_layout Standard
22039 \begin_layout Standard
22040 Please do read the file
22042 examples/multicol.lyx
22044 for more advanced examples including column and header spacing, vertical
22045 separator lines, and more.
22048 \begin_layout Section
22053 Paragraph Environment
22054 \begin_inset OptArg
22057 \begin_layout Standard
22058 Numbering in Enumerate
22066 \begin_layout Standard
22072 \begin_layout Standard
22073 \begin_inset VSpace bigskip
22079 \begin_layout Standard
22081 The default numbering for the
22085 paragraph environment begins with Arabic numbers and ends with uppercase
22087 Suppose, however, you wanted a different type of numbering scheme.
22088 Here's a quickie example of how to change the numbering scheme:
22091 \begin_layout LyX-Code
22101 \begin_layout LyX-Code
22111 \begin_layout LyX-Code
22121 \begin_layout LyX-Code
22131 \begin_layout Standard
22132 \SpecialChar \ldots{}
22133 which changes the numbering scheme to uppercase Roman numerals, uppercase
22134 letters, Arabic numbers, and lowercase letter.
22137 \begin_layout Standard
22138 Additionally, the previous example also adds a little bit extra to the numbering
22140 For example, the first level label actually looks like:
22141 \begin_inset Quotes eld
22145 \begin_inset Quotes erd
22149 For ease of reading, we'll describe what the numbering schemes look like
22150 using a notation something like this: <
22151 \begin_inset Quotes eld
22155 \begin_inset Quotes erd
22160 \begin_inset Quotes erd
22164 \begin_inset Quotes erd
22169 \begin_inset Quotes erd
22173 \begin_inset Quotes erd
22178 \begin_inset Quotes eld
22182 \begin_inset Quotes erd
22189 \begin_layout Standard
22190 As you can see in the example, there is a label command for each nesting
22197 \SpecialChar \ldots{}
22204 , as well as a counter,
22208 \SpecialChar \ldots{}
22214 There are also five
22215 \begin_inset Quotes eld
22219 \begin_inset Quotes erd
22252 , each of which take one counter as an argument.
22253 You can add characters before or after these, but there's no need to add
22257 \begin_layout Standard
22258 You can get really fancy with these.
22262 \begin_layout LyX-Code
22276 \begin_layout LyX-Code
22288 \begin_layout LyX-Code
22298 \begin_layout LyX-Code
22308 \begin_layout Standard
22309 produces the somewhat out of hand numbering scheme: <
22310 \begin_inset Quotes eld
22314 \begin_inset Quotes erd
22319 \begin_inset Quotes erd
22323 \begin_inset Quotes erd
22328 \begin_inset Quotes erd
22332 \begin_inset Quotes erd
22337 \begin_inset Quotes eld
22341 \begin_inset Quotes erd
22348 \begin_layout Section
22349 Extra Space Between Table Rows
22352 \begin_layout Standard
22358 \begin_layout Standard
22359 \begin_inset VSpace bigskip
22365 \begin_layout Standard
22367 LaTeX allows you to put a bit of extra space between rows in a table by
22368 giving an optional argument to the end-of-row specifier (
22377 LyX has not yet implemented this in a formal way, so here are two dirty
22378 little tricks to do the same job.
22382 \begin_layout Standard
22383 The first is the more formal, but longwinded way to do it.
22384 In the LaTeX preamble, add the following command definition:
22387 \begin_layout Standard
22394 extratablespace}[1]{
22398 This command takes a single argument---the amount of space you would like
22400 Insert the command in the first column of the row
22404 where you would like the space to appear.
22405 Here is an example (I've removed all the borders using
22410 ayout\SpecialChar \menuseparator
22419 \begin_layout Standard
22421 \begin_inset Tabular
22422 <lyxtabular version="3" rows="4" columns="3">
22424 <column alignment="center" valignment="top" width="0pt">
22425 <column alignment="center" valignment="top" width="0pt">
22426 <column alignment="center" valignment="top" width="0pt">
22428 <cell alignment="center" valignment="top" topline="true" usebox="none">
22431 \begin_layout Standard
22446 <cell alignment="center" valignment="top" topline="true" usebox="none">
22449 \begin_layout Standard
22464 <cell alignment="center" valignment="top" topline="true" usebox="none">
22467 \begin_layout Standard
22484 <cell alignment="center" valignment="top" topline="true" usebox="none">
22487 \begin_layout Standard
22493 <cell alignment="center" valignment="top" topline="true" usebox="none">
22496 \begin_layout Standard
22511 <cell alignment="center" valignment="top" topline="true" usebox="none">
22514 \begin_layout Standard
22531 <cell alignment="center" valignment="top" topline="true" usebox="none">
22534 \begin_layout Standard
22547 \begin_layout Standard
22550 extratablespace{2ex}
22560 <cell alignment="center" valignment="top" topline="true" usebox="none">
22563 \begin_layout Standard
22578 <cell alignment="center" valignment="top" topline="true" usebox="none">
22581 \begin_layout Standard
22598 <cell alignment="center" valignment="top" topline="true" usebox="none">
22601 \begin_layout Standard
22607 <cell alignment="center" valignment="top" topline="true" usebox="none">
22610 \begin_layout Standard
22625 <cell alignment="center" valignment="top" topline="true" usebox="none">
22628 \begin_layout Standard
22651 \begin_layout Standard
22652 The second method is faster, but will make typographers and TeXperts all
22653 over the world groan.
22654 Simply put an end of row specifier with optional argument at the same spot.
22655 No fancy definitions are needed as in the above example, but there will
22656 be more space inserted than you specified because you essentially added
22657 a blank row plus the extra space.
22658 If the space added is too much, simply use a negative number, like so:
22661 \begin_layout Standard
22663 \begin_inset Tabular
22664 <lyxtabular version="3" rows="4" columns="3">
22666 <column alignment="center" valignment="top" width="0pt">
22667 <column alignment="center" valignment="top" width="0pt">
22668 <column alignment="center" valignment="top" width="0pt">
22670 <cell alignment="center" valignment="top" topline="true" usebox="none">
22673 \begin_layout Standard
22688 <cell alignment="center" valignment="top" topline="true" usebox="none">
22691 \begin_layout Standard
22706 <cell alignment="center" valignment="top" topline="true" usebox="none">
22709 \begin_layout Standard
22726 <cell alignment="center" valignment="top" topline="true" usebox="none">
22729 \begin_layout Standard
22735 <cell alignment="center" valignment="top" topline="true" usebox="none">
22738 \begin_layout Standard
22753 <cell alignment="center" valignment="top" topline="true" usebox="none">
22756 \begin_layout Standard
22773 <cell alignment="center" valignment="top" topline="true" usebox="none">
22776 \begin_layout Standard
22789 \begin_layout Standard
22804 <cell alignment="center" valignment="top" topline="true" usebox="none">
22807 \begin_layout Standard
22822 <cell alignment="center" valignment="top" topline="true" usebox="none">
22825 \begin_layout Standard
22842 <cell alignment="center" valignment="top" topline="true" usebox="none">
22845 \begin_layout Standard
22851 <cell alignment="center" valignment="top" topline="true" usebox="none">
22854 \begin_layout Standard
22869 <cell alignment="center" valignment="top" topline="true" usebox="none">
22872 \begin_layout Standard
22895 \begin_layout Standard
22896 It's short, sweet, and gets the job done quickly, even if it is really ugly.
22897 You may put away the rotten vegetables now! I promise I won't suggest anything
22901 \begin_layout Section
22905 \begin_layout Standard
22911 \begin_layout Standard
22912 \begin_inset VSpace bigskip
22918 \begin_layout Standard
22923 \begin_layout Standard
22928 tmpfont}{cmr17 scaled 2500}{
22940 \begin_layout Standard
22945 \begin_layout Standard
22955 hose of you who like the style of old books probably also like
22956 \begin_inset Quotes eld
22960 \begin_inset Quotes erd
22963 ---those large capital letters which begin each new chapter or section.
22964 Implementing them with plain LyX/LaTeX is straightforward (assuming you
22965 know some plain TeX!) but does require a lot of work and many iterations,
22966 as you can see by all the ugly TeX-mode stuff at the beginning of this
22970 \begin_layout Standard
22974 \begin_layout Standard
22979 bigdrop{-1em}{3}{ptmri}{T}+
22984 here is a much easier way of doing this, of course.
22993 ) package from CTAN allows a simple way to add such letters to your documents.
22994 Since this package is not a standard part of teTeX, I can't demonstrate
22995 it within this document, but if you copy this paragraph to a new document,
22997 \begin_inset Quotes eld
23007 \begin_inset Quotes erd
23010 and the pluses from the TeX code at the beginning of the paragraph, and
23015 usepackage{dropcaps}
23017 to your LaTeX preamble, you will get a nice Times Roman Italic
23018 \begin_inset Quotes eld
23022 \begin_inset Quotes erd
23025 , whose height is three lines of text and which protrudes 1 em into the
23027 (Make certain you have copied
23028 \begin_inset Quotes eld
23036 \begin_inset Quotes erd
23039 into a directory where TeX can see it.) The first argument is the amount
23040 of indentation; in this case the negative sign moves it into the margin.
23041 The second argument is the height of the letter in number of lines of text.
23042 The third argument is the font name: virtually anything which has a tfm
23043 file should work (wade through the
23045 .../texmf/fonts/tfm
23047 directory for possibilities).
23048 My personal favorite is
23049 \begin_inset Quotes eld
23057 \begin_inset Quotes erd
23060 , a fancy German font specifically designed for dropped capitals.
23061 The fourth argument is the letter (or letters) to be dropped.
23066 package also offers the
23072 command, as well as a slightly simplified
23081 \begin_layout Section
23082 Non-standard Paragraph Shapes
23085 \begin_layout Standard
23091 \begin_layout Standard
23092 \begin_inset VSpace bigskip
23098 \begin_layout Standard
23102 \begin_layout Standard
23113 \begin_layout Standard
23117 \begin_layout Standard
23125 \begin_layout Standard
23138 \begin_layout Standard
23143 \begin_layout Standard
23153 \begin_layout Standard
23161 \begin_layout Standard
23169 \begin_layout Standard
23177 \begin_layout Standard
23185 \begin_layout Standard
23193 \begin_layout Standard
23201 \begin_layout Standard
23209 \begin_layout Standard
23217 \begin_layout Standard
23225 \begin_layout Standard
23233 \begin_layout Standard
23241 \begin_layout Standard
23249 \begin_layout Standard
23257 \begin_layout Standard
23265 \begin_layout Standard
23273 \begin_layout Standard
23281 \begin_layout Standard
23289 \begin_layout Standard
23297 \begin_layout Standard
23303 There are times when the tyranny of rectangular paragraphs must be overthrown.
23304 In such situations, a call to the delightful plain TeX command
23311 As you can see, completely arbitrary shapes can be laid out with a suitable
23312 set of linelength definitions.
23313 While this parshape may look a bit silly and useless, one could conceive
23314 of situations such as finely tuned dropped capitals, word wrapping around
23315 non-rectangular graphics, etc.
23316 which will benefit from such handcrafting.
23319 \begin_layout Standard
23320 \begin_inset VSpace bigskip
23326 \begin_layout Standard
23331 parshape numlines #1indent #1length #2indent #2length \SpecialChar \ldots{}
23338 is the number of lines of text which define the paragraph.
23339 If there turn out to be fewer lines, the shape is truncated; if there are
23340 more, the excess lines have the same dimensions as the last line of the
23350 entries specify the indentation of the line from the left margin, and the
23351 length of the line as measured from that point.
23352 The shape applies only to the current paragraph; everything is reset to
23353 normal for the next paragraph.
23356 \begin_layout Standard
23360 \begin_layout Standard
23371 \begin_layout Section
23375 \begin_layout Standard
23376 As you can see, the examples in this section range from the useful to the
23378 While I don't expect that anyone will ever need the paragraph shape demonstrate
23379 d in the last section, the important point is that you can do almost anything
23380 you want in LyX if you are willing to figure out how to do it in TeX and
23382 TeX is a fantastically powerful typesetting system and all that power is
23383 available to you since LyX uses it as its backend.