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 \,
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 \,
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 \,
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 \,
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
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
2547 Outputs\SpecialChar \menuseparator
2548 LaT\SpecialChar \textcompwordmark{}
2558 section of the preferences dialog, however, you can customize the index
2559 command, if you prefer an alternative program like
2582 Inserting an index and marking words to include in it works much the same
2583 way as preparing a bibliography as mentioned in the last section.
2586 \begin_layout Standard
2587 First, go to the end of your file and select
2592 nsert\SpecialChar \menuseparator
2603 C\SpecialChar \menuseparator
2616 Then, for each word you would like to include in the index, go to the end
2617 of that word and click on
2622 nsert\SpecialChar \menuseparator
2635 This will insert a tag showing the word as it will appear in the index.
2636 That's all there is to it; LyX will automatically call
2640 for you and create the index itself.
2641 The text in the dialog available from right-clicking on the index button
2642 accepts LaTeX, so you'll need to be careful to avoid using any special
2644 On the positive side, you can use the advanced options - have a look at
2645 the documentation which comes with your LaTeX distribution to find out
2646 how to do things like
2647 \begin_inset Quotes eld
2651 \begin_inset Quotes erd
2657 \begin_layout Standard
2658 Be careful not to put spaces between the word in the text and the index
2659 marker; apparently the wrong page number can be produced if this happens.
2662 \begin_layout Section
2666 \begin_layout Subsection
2670 \begin_layout Standard
2671 When you are working on a large file with many sections, it is often convenient
2672 to break up the document into several files, or perhaps you have something
2673 where a table may change from time to time, but the preceding text does
2675 In these cases, you should seriously consider using multipart documents.
2676 For example, scientific papers often have five major sections: the introduction
2677 , observations, results, discussion, and conclusion.
2678 Each of these could be its own separate LyX file, with one
2679 \begin_inset Quotes eld
2683 \begin_inset Quotes erd
2686 file which contains the title, authors, abstract, references, etc., plus
2687 the five included files.
2688 It is important to note that each of these files is a full LyX file which
2689 can be formatted and printed on its own, as well as included in a master
2691 Each of these files must have the same document class, however--- don't
2692 attempt to mix book classes with article classes.
2693 You may also include LaTeX files; however, these files must not have their
2699 everything up to and including the
2711 line must be deleted) or else errors will be generated when you try to
2715 \begin_layout Standard
2716 LyX allows you to include files quite easily with
2721 nsert\SpecialChar \menuseparator
2730 When you click on this selection a small box is inserted into the file
2731 at the current cursor location.
2732 Clicking on the box raises a dialog which allows you to select the file
2733 to be included, and the method of its inclusion.
2737 \begin_layout Standard
2738 The file selection box should by now be obvious.
2739 The three inclusion methods are
2740 \begin_inset Quotes eld
2744 \begin_inset Quotes erd
2748 \begin_inset Quotes eld
2752 \begin_inset Quotes erd
2756 \begin_inset Quotes eld
2760 \begin_inset Quotes erd
2764 The difference between
2765 \begin_inset Quotes eld
2769 \begin_inset Quotes erd
2773 \begin_inset Quotes eld
2777 \begin_inset Quotes erd
2780 is really only meaningful to LaTeXperts, but the practical difference is
2781 that files which are
2782 \begin_inset Quotes eld
2786 \begin_inset Quotes erd
2789 are typeset beginning on a new page, while files which are
2790 \begin_inset Quotes eld
2794 \begin_inset Quotes erd
2797 are typeset starting on the current page.
2798 Perhaps the labeling in LyX will be changed someday to reflect this.
2801 \begin_layout Standard
2802 Generally, the master file is converted into a full LaTeX file before typesettin
2803 g, while the included files are converted to LaTeX files which do not have
2804 all the preamble information.
2814 button prevents this conversion.
2817 \begin_layout Standard
2819 \begin_inset Quotes eld
2823 \begin_inset Quotes erd
2826 included file allows you to include a file typeset exactly as it appears
2827 in the file, i.e.\InsetSpace ~
2828 verbatim mode, with the characters set in a fixed-width
2830 Normally, spaces in this file are invisible, though two consecutive spaces
2831 are conserved, unlike LyX's normal treatment of spaces.
2832 However, setting the
2842 checkbox typesets a mark to unambiguously define the presence of a space.
2848 \begin_layout Subsection
2849 Cross-References Between Files
2852 \begin_layout Standard
2853 It is possible to set up cross-references between the different files.
2854 First, open all the files in question: let's call them A and B in a two
2855 file example, where B is included in A.
2856 Let's say you insert a label in A, then want to reference it in B.
2857 Open the cross-reference dialog in whilst in document B, and you can select
2859 \begin_inset Quotes eld
2863 \begin_inset Quotes erd
2869 \begin_layout Section
2873 \begin_layout Standard
2878 is needed by LyX to be able to output algorithm floats.
2879 These are useful in placing short algorithms across page breaks and support
2880 an index of algorithms too.
2883 \begin_layout Section
2887 \begin_layout Standard
2892 is used by LyX when you select ``subfigure'' in the graphics dialog and
2893 enter the subfigure caption.
2894 Several figures marked in this way can be packed into a single float with
2895 individual sub-captions.
2898 \begin_layout Section
2899 Fancy Headers and Footers
2902 \begin_layout Standard
2903 The default page layout is rather plain; for an article document class,
2904 all you get is a centered page number at the bottom of the page.
2905 This document is the book class, so it appears to be a bit fancier, but
2906 to really put on a show, you need to set the document page style to
2907 \begin_inset Quotes eld
2911 \begin_inset Quotes erd
2914 , as mentioned in the
2920 This section describes the LaTeX codes you need to insert in your LaTeX
2921 preamble or the text in order to get the desired effects.
2924 \begin_layout Standard
2925 The page header is divided into three fields, not surprisingly labeled
2926 \begin_inset Quotes eld
2930 \begin_inset Quotes erd
2934 \begin_inset Quotes eld
2938 \begin_inset Quotes erd
2942 \begin_inset Quotes eld
2946 \begin_inset Quotes erd
2950 The footer is also divided into these three fields.
2951 The LaTeX commands to set these fields in the simplest manner are
2976 Suppose you wish to put your name in the upper left hand corner of each
2978 Simply insert the following command in the preamble:
2981 \begin_layout Standard
2990 \begin_layout Standard
2991 You will now see your name in the upper left.
2992 If a field has a default entry that you would like to get rid of (often
2993 the page number appears in the central footer, simply include a command
2994 with a blank argument, e.g.
2997 \begin_layout Standard
3005 \begin_layout Standard
3006 Let's get really fancy: lets put the section number with the word
3007 \begin_inset Quotes eld
3011 \begin_inset Quotes erd
3015 Section 3) in the upper left, the page number (e.g.
3016 Page 4) in the upper right, your name in the lower left, and the date in
3018 The following commands should now appear in the preamble:
3021 \begin_layout Standard
3031 \begin_layout Standard
3039 \begin_layout Standard
3049 \begin_layout Standard
3058 \begin_layout Standard
3066 \begin_layout Standard
3076 \begin_layout Standard
3089 access LaTeX's section and page counters, and so print out the current
3090 section and page numbers.
3097 simply prints out today's date.
3100 \begin_layout Standard
3101 The thicknesses of the horizontal rules drawn beneath the header and above
3102 the footer can also be modified.
3103 If you don't want one of the headers, set its thickness to 0.
3104 The header rule has a default thickness of 0.4pt, the footer rule is 0pt.
3105 Use the commands, e.g.
3112 headrulewidth}{0.4pt}
3120 footrulewidth}{0.4pt}
3122 to set the thicknesses.
3125 \begin_layout Standard
3126 You can switch the header/footer settings on and off for individual pages
3131 thispagestyle{empty}
3137 thispagestyle{plain}
3143 thispagestyle{fancy}
3146 Simply insert them in the text on the page you want changed and mark them
3148 In fact, title pages are marked as plain by default, while following pages
3149 are marked fancy when using the global fancy setting.
3152 \begin_layout Standard
3153 There are more complex commands which will let you insert things in the
3154 upper left on odd numbered pages, etc., but I will refer you to the
3158 package documentation for more descriptions.
3159 For example, if you have a teTeX installation, look for
3161 /usr/share/texmf/doc/latex/fancyhdr/\SpecialChar \-
3167 \begin_layout Standard
3168 As a final example, it is possible to include an Encapsulated PostScript®
3169 file in the header or footer.
3170 Suppose you want to put a company logo in the upper lefthand corner.
3171 You might try something like
3174 \begin_layout Standard
3183 includegraphics{logo.eps}}}
3186 \begin_layout Standard
3188 (you may need to preface this with
3192 usepackage{graphics}
3194 if you don't include EPS files elsewhere in your document).
3197 \begin_layout Section
3201 \begin_layout Standard
3202 LaTeX provides a mechanism to produce essentially a page within a page,
3204 Within a minipage, all the usual rules of indentation, line wrapping, etc.\InsetSpace ~
3206 LyX also provides some of the minipage capability.
3209 \begin_layout Standard
3210 Minipages in LyX have their own collapsable box; insert one via
3215 nsert\SpecialChar \menuseparator
3223 Right-clicking on the box allows you to alter the minipage's width and
3224 alignment within the page.
3225 Warning: if the minipage is too long to fit on a page, it is truncated,
3226 not wrapped onto the next page.
3229 \begin_layout Standard
3230 If you place two minipages side-by-side, you can use
3235 nsert\SpecialChar \menuseparator
3243 to insert a special instruction known in the LaTeX world as an
3247 to put a maximum amount of space between them; it forces one minipage to
3248 the left edge, the other to the right edge.
3249 The examples below show the difference.
3252 \begin_layout Standard
3253 \begin_inset Box Frameless
3262 height_special "totalheight"
3265 \begin_layout Standard
3266 This is a minipage which does not use hfill.
3267 This is the second sentence of a minipage which does not use hfill.
3275 \begin_layout Standard
3276 \begin_inset Box Frameless
3285 height_special "totalheight"
3288 \begin_layout Standard
3289 This is a second minipage which does not use hfill.
3290 This is the second sentence of a second minipage which does not use hfill.
3298 \begin_layout Standard
3299 \begin_inset VSpace medskip
3305 \begin_layout Standard
3306 Here is some normal text to separate the two examples.
3309 \begin_layout Standard
3310 \begin_inset VSpace medskip
3316 \begin_layout Standard
3317 \begin_inset Box Frameless
3326 height_special "totalheight"
3329 \begin_layout Standard
3330 This is a minipage which does use hfill.
3331 This is the second sentence of a minipage which does use hfill.
3339 \begin_inset Box Frameless
3348 height_special "totalheight"
3351 \begin_layout Standard
3352 This is a second minipage which does use hfill.
3353 This is the second sentence of a second minipage which does use hfill.
3361 \begin_layout Section
3362 Wrapping Text Around Figures
3363 \begin_inset LatexCommand \label{sec:floatflt}
3370 \begin_layout Standard
3371 \begin_inset Wrap figure
3376 \begin_layout Standard
3377 \begin_inset Graphics
3388 \begin_layout Caption
3389 This is a wrapped figure, and this is the brilliant caption that describes
3398 \begin_layout Standard
3399 A very frequently asked question is whether text can be made to
3400 \begin_inset Quotes eld
3404 \begin_inset Quotes erd
3407 around figures so that a figure occupies some fraction of the column width
3408 and text fills the rest.
3409 If you have the LaTeX package
3413 installed (you can find out about it in the
3417 manual) you can do this.
3420 \begin_layout Standard
3421 At the right is a figure of a mobius strip---you should have already seen
3427 To wrap the text like this insert a wrap box via
3432 nsert\SpecialChar \menuseparator
3437 ts\SpecialChar \menuseparator
3443 \begin_layout Standard
3444 Note: this package is very fragile! For example, having a figure too close
3445 to the bottom of the page will mess things up, as will having two figures
3447 Use this package sparingly and do read the documentation that came with
3448 it (which will also tell you how to wrap text around tables).
3451 \begin_layout Section
3455 \begin_layout Standard
3456 While the standard table layout will suffice in 99% of all tables you generate,
3457 occasionally you will run into one which requires a bit of extra tweaking.
3458 The table dialog which appears on a right-click of a table allows these
3460 It will give you access to some extra column alignment parameters.
3461 A little bit of LaTeX background is useful here: when you set up a table
3462 in LaTeX, each column is given an alignment type.
3463 For example, you would give it
3464 \begin_inset Quotes eld
3472 \begin_inset Quotes erd
3476 \begin_inset Quotes eld
3484 \begin_inset Quotes erd
3488 \begin_inset Quotes eld
3496 \begin_inset Quotes erd
3499 for left-aligned, centered, and right-aligned columns respectively (which
3500 appear as the left/center/right radio buttons in LyX).
3502 \begin_inset Quotes eld
3510 \begin_inset Quotes erd
3513 , which will make a column of a specified width (the width box in LyX),
3514 and will wrap text within that box.
3516 \begin_inset Quotes eld
3524 \begin_inset Quotes erd
3527 (vertical bar) which rather than making a column will make a vertical rule
3528 at that point; this manifests itself in LyX as the
3529 \begin_inset Quotes eld
3533 \begin_inset Quotes erd
3537 Finally, there is a type
3538 \begin_inset Quotes eld
3546 \begin_inset Quotes erd
3549 , which allows you to use whatever is enclosed in the accompanying braces
3550 as the column separator, including a null argument.
3551 The reasons for doing this may not be obvious, but they can be very powerful.
3552 They are best demonstrated by example.
3555 \begin_layout Subsection
3556 Removing Extra Column Space
3559 \begin_layout Standard
3560 Here is a standard table:
3563 \begin_layout Standard
3565 \begin_inset Tabular
3566 <lyxtabular version="3" rows="3" columns="2">
3568 <column alignment="left" valignment="top" width="0pt">
3569 <column alignment="left" valignment="top" leftline="true" width="0pt">
3570 <row bottomline="true">
3571 <cell alignment="left" valignment="top" topline="true" usebox="none">
3574 \begin_layout Standard
3589 <cell alignment="left" valignment="top" topline="true" leftline="true" usebox="none">
3592 \begin_layout Standard
3609 <cell alignment="left" valignment="top" topline="true" usebox="none">
3612 \begin_layout Standard
3627 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
3630 \begin_layout Standard
3647 <cell alignment="center" valignment="top" topline="true" usebox="none">
3650 \begin_layout Standard
3665 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
3668 \begin_layout Standard
3691 \begin_layout Standard
3692 Notice that the horizontal rule extends a bit past the text on both sides.
3693 If you wanted the line to end even with the text, we can put a null separator
3694 on the ends to get rid of the bit of extra space LaTeX adds by default.
3695 Here is the example:
3698 \begin_layout Standard
3700 \begin_inset Tabular
3701 <lyxtabular version="3" rows="3" columns="2">
3703 <column alignment="left" valignment="top" width="0pt" special="@{} l">
3704 <column alignment="left" valignment="top" leftline="true" width="0pt" special="l @{}">
3705 <row bottomline="true">
3706 <cell alignment="left" valignment="top" topline="true" usebox="none">
3709 \begin_layout Standard
3724 <cell alignment="left" valignment="top" topline="true" leftline="true" usebox="none">
3727 \begin_layout Standard
3744 <cell alignment="left" valignment="top" topline="true" usebox="none">
3747 \begin_layout Standard
3762 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
3765 \begin_layout Standard
3782 <cell alignment="center" valignment="top" topline="true" usebox="none">
3785 \begin_layout Standard
3800 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
3803 \begin_layout Standard
3826 \begin_layout Standard
3827 In this case, the column specifier for the left column was set to
3828 \begin_inset Quotes eld
3836 \begin_inset Quotes erd
3839 , while the right column was set to
3840 \begin_inset Quotes eld
3848 \begin_inset Quotes erd
3851 , in order to put the null characters on the edges.
3855 \begin_layout Subsection
3856 Changing the Column Separator Character
3859 \begin_layout Standard
3860 Now suppose you really wanted, for reasons that are completely opaque, to
3862 \begin_inset Formula $\sqrt{\pi}$
3865 with some space around it for the column separator.
3866 Simply turn off the vertical border, then set the right column specifier
3868 \begin_inset Quotes eld
3880 \begin_inset Quotes erd
3884 You could now make a table like this:
3887 \begin_layout Standard
3889 \begin_inset Tabular
3890 <lyxtabular version="3" rows="3" columns="2">
3892 <column alignment="left" valignment="top" width="0pt">
3893 <column alignment="left" valignment="top" width="0in" special="@{~$\sqrt{\pi}$~}l">
3894 <row bottomline="true">
3895 <cell alignment="left" valignment="top" topline="true" usebox="none">
3898 \begin_layout Standard
3913 <cell alignment="left" valignment="top" topline="true" usebox="none">
3916 \begin_layout Standard
3933 <cell alignment="left" valignment="top" topline="true" usebox="none">
3936 \begin_layout Standard
3951 <cell alignment="center" valignment="top" topline="true" usebox="none">
3954 \begin_layout Standard
3971 <cell alignment="center" valignment="top" topline="true" usebox="none">
3974 \begin_layout Standard
3989 <cell alignment="center" valignment="top" topline="true" usebox="none">
3992 \begin_layout Standard
4015 \begin_layout Subsection
4016 Making a Decimal Point Aligned Column
4019 \begin_layout Standard
4020 Okay, that last example was very silly, but here is one that is not.
4021 Suppose you want to make a table that has a column which is aligned on
4023 A standard LaTeX trick to do this is to set the whole number part in a
4024 right-aligned column, use a decimal point for the column separator, then
4025 set the fractional part as a left-aligned column.
4026 A variation on this is to include the decimal point explicitly with the
4027 whole part, then use just a null separator in between.
4028 The latter variation is demonstrated here:
4031 \begin_layout Standard
4033 \begin_inset Tabular
4034 <lyxtabular version="3" rows="5" columns="3">
4036 <column alignment="center" valignment="top" width="0pt">
4037 <column alignment="right" valignment="top" leftline="true" width="0pt">
4038 <column alignment="center" valignment="top" width="0pt" special="@{} l">
4039 <row bottomline="true">
4040 <cell alignment="center" valignment="top" topline="true" usebox="none">
4043 \begin_layout Standard
4058 <cell multicolumn="1" alignment="center" valignment="top" bottomline="true" leftline="true" usebox="none">
4061 \begin_layout Standard
4076 <cell multicolumn="2" alignment="center" valignment="top" topline="true" usebox="none">
4079 \begin_layout Standard
4087 <cell alignment="center" valignment="top" topline="true" usebox="none">
4090 \begin_layout Standard
4100 \begin_inset Formula $\pi$
4108 <cell alignment="right" valignment="top" topline="true" leftline="true" usebox="none">
4111 \begin_layout Standard
4126 <cell alignment="center" valignment="top" topline="true" usebox="none">
4129 \begin_layout Standard
4146 <cell alignment="center" valignment="top" topline="true" usebox="none">
4149 \begin_layout Standard
4159 \begin_inset Formula $\pi^{\pi}$
4167 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
4170 \begin_layout Standard
4185 <cell alignment="center" valignment="top" topline="true" usebox="none">
4188 \begin_layout Standard
4205 <cell alignment="center" valignment="top" topline="true" usebox="none">
4208 \begin_layout Standard
4218 \begin_inset Formula $(\pi^{\pi})^{\pi}$
4226 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
4229 \begin_layout Standard
4244 <cell alignment="center" valignment="top" topline="true" usebox="none">
4247 \begin_layout Standard
4255 <cell alignment="center" valignment="top" topline="true" usebox="none">
4258 \begin_layout Standard
4268 \begin_inset Formula $\pi^{\pi^{\pi}}$
4276 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
4279 \begin_layout Standard
4294 <cell alignment="center" valignment="top" topline="true" usebox="none">
4297 \begin_layout Standard
4308 \begin_inset Formula $\times10^{18}$
4324 \begin_layout Standard
4325 Though it appears a bit funny in LyX, on paper it will produce what appears
4326 to be a 2-column table in which the right column is aligned on the decimal
4327 point and the header appears to be centered over it.
4330 \begin_layout Standard
4331 Perhaps it is best if I described just what I did: first, create a 3
4332 \begin_inset Formula $\times$
4335 3 table and remove all the borders.
4336 Then re-add a bottom border to the top row, and a right border to the first
4338 Type in the values for the first column and set its alignment to
4360 and set that column's alignment to
4376 \begin_inset Formula $\times10^{18}$
4381 and set the extra column alignment to
4386 Finally type in the word
4390 in the middle column, highlight it and the blank entry to its right, and
4403 \begin_layout Subsection
4404 A Better Decimal-Alignment Solution
4407 \begin_layout Standard
4408 An alternative way to have decimal alignment in tables is through the
4413 Add the following to the LateX preamble:
4416 \begin_layout LyX-Code
4422 \begin_layout LyX-Code
4425 newcolumntype{d}[1]{D{.}{.}{#1}}
4428 \begin_layout Standard
4429 To have a column decimally aligned, enter in the
4431 Special Column Alignment
4437 dialog the following:
4440 \begin_layout LyX-Code
4441 d{number of decimals of the data}
4444 \begin_layout Standard
4445 To create extra column space just increase the number of decimals in
4450 Setting the multicolumn attribute for a single cell makes it insensitive
4451 to the decimal alignment which comes in handy as well.
4452 A drawback of this method is that math mode is not allowed in a column
4453 with decimal alignment except if the multicolumn attribute is set.
4456 \begin_layout Standard
4457 This method offers the same flexibility as the
4462 One could, for example, change the alignment separator, and have different
4463 alignment separators for different columns by defining multiple column
4464 types in the preamble.
4465 The syntax is as follows:
4468 \begin_layout LyX-Code
4469 D{inputsep}{outputsep}{decimal places}
4472 \begin_layout Standard
4473 The interested reader is directed towards the
4477 package documentation for more details.
4480 \begin_layout Section
4481 Itemize Bullet Selection
4482 \begin_inset LatexCommand \label{sec:bullet}
4489 \begin_layout Standard
4495 \begin_layout Subsection
4499 \begin_layout Standard
4500 LyX provides 216 bullet shapes that can be accessed from a simple dialog.
4501 Using this dialog you can easily specify what bullet shape to use at each
4502 level of an itemized list.
4503 These settings are document-wide so you won't be able to specify different
4504 sets of bullets for different paragraphs
4508 \begin_layout Standard
4509 Well, actually you can but you'll have to do it by hand.
4517 \begin_layout Subsection
4521 \begin_layout Standard
4522 Open the dialog by selecting the
4527 ocument\SpecialChar \menuseparator
4534 menu item and then select the
4544 \begin_layout Standard
4545 The dialog provides you with a table of bullet shapes.
4546 A column of buttons on the left of the table provides access to the six
4547 different panels of bullet shapes.
4548 The row of buttons across the top is used to select which bullet depth
4550 A text entry under the table shows the currently selected bullet shape's
4551 LaTeX equivalent and this can be edited if desired.
4552 If you do modify the text you will also need to specify any needed packages
4553 in the LaTeX preamble.
4556 \begin_layout Standard
4557 The six panels are divided up by the packages they require.
4558 The following table shows the mappings from button name to LaTeX packages.
4561 \begin_layout Standard
4563 \begin_inset Tabular
4564 <lyxtabular version="3" rows="7" columns="2">
4566 <column alignment="center" valignment="top" leftline="true" width="0pt">
4567 <column alignment="center" valignment="top" leftline="true" rightline="true" width="0pt">
4568 <row topline="true" bottomline="true">
4569 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
4572 \begin_layout Standard
4587 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
4590 \begin_layout Standard
4606 <row topline="true">
4607 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
4610 \begin_layout Standard
4625 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
4628 \begin_layout Standard
4643 <row topline="true">
4644 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
4647 \begin_layout Standard
4662 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
4665 \begin_layout Standard
4681 <row topline="true">
4682 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
4685 \begin_layout Standard
4700 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
4703 \begin_layout Standard
4719 <row topline="true">
4720 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
4723 \begin_layout Standard
4738 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
4741 \begin_layout Standard
4757 <row topline="true">
4758 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
4761 \begin_layout Standard
4776 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
4779 \begin_layout Standard
4795 <row topline="true" bottomline="true">
4796 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
4799 \begin_layout Standard
4814 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
4817 \begin_layout Standard
4840 \begin_layout Standard
4841 LyX doesn't stop you using bullets from packages you don't have.
4842 If you get errors from LaTeX when you try to view or print the file then
4843 its likely you are missing a package.
4844 LyX doesn't restrict your use since you may be editing locally and exporting
4848 \begin_layout Subsection
4852 \begin_layout Standard
4853 Select which bullet depth you want to change then select the bullet shape
4859 Any changes will not be visible in LyX, but are visible when viewing the
4860 document using xdvi or ghostview.
4863 \begin_layout Standard
4864 You can reset a bullet shape to the default simply by clicking your right
4865 mouse button on the appropriate bullet depth button.
4868 \begin_layout Standard
4873 want to have multiple sets of paragraphs with different sets of bullets
4874 in each then you're going to have to get your hands dirty.
4875 The itemize bullet selection dialog can help though because it provides
4876 you with the LaTeX code for a wide range of bullet shapes.
4877 To make your own custom paragraphs you have the following options:
4880 \begin_layout Standard
4884 \begin_layout Standard
4899 \begin_layout Standard
4903 \begin_layout Standard
4924 \begin_layout Itemize
4925 Use the LaTeX command
4931 to specify a new bullet shape for a given depth.
4932 You'll also need to save the current bullet shape so you can restore it
4934 In this itemized list the following LaTeX code was used to change the bullet
4935 used for the first depth.
4967 Note that the itemize depth is specified in Roman numerals as part of the
4977 \begin_layout Itemize
4981 \begin_layout Standard
4993 Specify each individual entry by starting each item with the bullet shape
4994 enclosed in square brackets and set as TeX.
4995 For example, this item was started with
5008 \begin_layout Standard
5012 \begin_layout Standard
5027 \begin_layout Standard
5028 You'll also need to revert the labelitem back to its previous setting for
5029 the global bullet shape settings to remain in effect.
5030 The way used here was:
5043 \begin_layout Chapter
5044 Special Document Classes
5047 \begin_layout Section
5051 \begin_layout Standard
5057 \begin_layout Standard
5058 \begin_inset VSpace bigskip
5064 \begin_layout Standard
5066 The AMS LaTeX layouts are set up to conform to suggested styles for mathematical
5067 papers to be submitted to American Mathematical Society publications.
5068 The layouts are not tailored to a specific journal, but easily can be.
5069 You should refer to the AMS documentation for specific instructions for
5070 each journal (usually it will entail only changing a single line in the
5072 That documentation is available on the Web at
5073 \begin_inset LatexCommand \url{http://www.ams.org}
5078 \begin_inset LatexCommand \url{ftp://ftp.ams.org/pub/tex/amslatex/}
5082 .These layouts are appropriate, and useful, for any mathematical writing.
5083 There are currently 4 distinct AMS LaTeX layouts:
5086 \begin_layout Enumerate
5087 amsart: The standard AMS-article format.
5088 All results and similar statements are numbered as
5089 \begin_inset Formula $(n.m)$
5092 , where the first number refers to the section, and the second refers to
5093 the total number of results (Theorems, Corollaries, Propositions, Definitions
5094 and Remarks, etc.) in that section.
5095 There are also many (but not all) environments available unnumbered, which
5096 is occasionally needed.
5097 Unnumbered environments indicated by an asterisk at the end.
5100 \begin_layout Enumerate
5101 amsart-seq: Here, numbering for each type of statement is in its own sequence,
5102 with no reference to the section number.
5103 There are also many (but not all) environments available unnumbered, which
5104 is occasionally needed.
5105 Unnumbered environments indicated by an asterisk at the end.
5108 \begin_layout Enumerate
5109 amsart-plain: This one is even more terse, since all the environments are
5113 \begin_layout Enumerate
5114 amsbook: the standard AMS book (really, monograph) format.
5115 Numbering is similar to the amsart layout, except that all numbering is
5117 \begin_inset Formula $(n.m.p)$
5120 , where the first number refers to the chapter, the second to the section,
5121 and the third is the number of the results (Theorems, Corollaries, Propositions
5122 , Definitions and Remarks, etc.) in that section.
5123 There are also many (but not all) environments available unnumbered, which
5124 is occasionally needed.
5125 Unnumbered environments indicated by an asterisk at the end.
5128 \begin_layout Standard
5129 Any AMS LyX file can be converted to either of the numbering schemes by
5130 simply changing the document class in the
5135 ocument\SpecialChar \menuseparator
5146 \begin_layout Subsection
5147 What these layouts provide
5150 \begin_layout Standard
5151 There is a long list of included environments provided by these layouts.
5152 Most mathematical papers or books will set as special statements most of
5153 these environments, in AMS-LaTeX there is an opportunity to define an unlimited
5154 variety of such declarations.
5155 However, the AMS recommends the environments that are available in LyX.
5156 The list of environments (not counting the standard environments such as
5159 sections, bibliography, title, author, date
5164 \begin_layout Description
5165 Theorem This is typically used for the statements of major results.
5167 \begin_inset Quotes eld
5175 \begin_inset Quotes erd
5178 appears in bold type, along with an automatically-determined number (an
5183 , is also available).
5184 The text is italicized.
5187 \begin_layout Description
5188 Corollary This is used for statements which follow fairly directly from
5189 previous statements.
5190 Again, these can be major results.
5198 \begin_layout Description
5199 Lemma These are smaller results needed to prove other statements.
5202 \begin_layout Description
5203 Proposition These are less major results which (hopefully) add to the general
5204 theory being discussed.
5207 \begin_layout Description
5208 Conjecture These are statements provided without justification, which the
5209 author does not know how to prove, but which seem to be true (to the author,
5213 \begin_layout Description
5214 Criterion A required condition.
5217 \begin_layout Description
5218 Algorithm A general procedure to be used.
5221 \begin_layout Description
5222 Axiom This is a property or statement taken as true within the system being
5226 \begin_layout Description
5227 Definition Guess what this is for.
5228 The font, both on-screen and in the output, is different for this environment
5229 than for the previous ones.
5231 \begin_inset Quotes eld
5235 \begin_inset Quotes erd
5238 ) is still set in boldface, along with the number, if any, but the rest
5242 \begin_layout Description
5243 Example Typeset similarly to Definition.
5246 \begin_layout Description
5250 \begin_layout Description
5254 \begin_layout Description
5258 \begin_layout Description
5259 Remark This environment is also a new type of theorem.
5260 This is set with the word Remark in italics, and the rest upright.
5263 \begin_layout Description
5264 Note Set similarly to the Remark environment.
5267 \begin_layout Description
5271 \begin_layout Description
5275 \begin_layout Description
5279 \begin_layout Description
5283 \begin_layout Description
5284 Case Generally, these are used to break up long arguments, using specific
5285 instances of some condition.
5286 The numbering scheme for cases is on its own, not together with other numbered
5291 \begin_layout Description
5295 \begin_layout Description
5299 \begin_layout Description
5301 \begin_inset Quotes eld
5309 \begin_inset Quotes erd
5312 is set in italics, but the rest is set upright.
5313 At the end of this environment (other environments can be nested within
5314 this one, of course) a QED symbol (usually a square, but it can vary with
5315 different styles) is placed.
5318 \begin_layout Description
5319 Address This should be the author's permanent address.
5322 \begin_layout Description
5323 Current\InsetSpace ~
5324 Address This should be the author's temporary address at the time
5325 of submission, if different from the Address.
5328 \begin_layout Description
5329 Email Author's e-mail address
5332 \begin_layout Description
5333 URL Author's Web address, if desired.
5336 \begin_layout Description
5337 Keywords Key words or phrases used to identify specific topics discussed
5341 \begin_layout Description
5342 Subjectclass These refer to the AMS Subject Classifications, published and
5345 Mathematical Reviews
5348 These are also available online at the AMS cites listed above.
5351 \begin_layout Description
5355 \begin_layout Description
5359 \begin_layout Description
5363 \begin_layout Standard
5364 In addition, these environments automatically provide the AMS LaTeX and
5366 They need to be available on your system in order to use these environments.
5369 \begin_layout Section
5373 \begin_layout Standard
5378 can be used to type letters according to German conventions.
5379 A template file is included in
5381 .../lyx/share/templates
5383 for you to use as a starting point.
5386 \begin_layout Section
5390 \begin_layout Standard
5395 provides an alternative to the standard
5400 It provides similar functionality, but you might prefer this layout with
5401 sans serif sections, headings, and more.
5404 \begin_layout Section
5408 \begin_layout Standard
5414 \begin_layout Subsection
5418 \begin_layout Standard
5419 This section describes how LyX can be used to write articles for submission
5420 to the scientific journal
5422 Astronomy and Astrophysics
5425 \begin_inset LatexCommand \url[www.edpsciences.fr/aa/]{http://www.edpsciences.fr/aa/}
5437 Version 5.01 of the document class
5442 This package can be downloaded from the ftp site
5445 \begin_layout Standard
5446 \begin_inset VSpace medskip
5452 \begin_layout Standard
5454 \begin_inset LatexCommand \url{ftp://ftp.edpsciences.org/pub/aa/readme.html}
5461 \begin_layout Standard
5462 \begin_inset VSpace medskip
5468 \begin_layout Standard
5469 A manual comes together with that package, and this text is not meant to
5470 replace the original manual but merely a short guide how to realize the
5471 correct form of your paper.
5475 \begin_layout Standard
5476 Please note that the publisher of the journal was changed from Springer
5477 to EDP Sciences starting January 1, 2001.
5478 That change implicated also some slight changes of the style files, namely
5479 the removal of the thesaurus command.
5480 The LyX class aa supports the newest version of these style files, V 5.01.
5481 If you have an older version installed, please upgrade.
5482 For compatibility, the old (version 4) layout has been kept as
5487 Please refer to the comments in
5489 LyXDir/layouts/aapaper.layout
5494 \begin_layout Subsection
5498 \begin_layout Standard
5499 It is recommended you start from the example template distributed with LyX.
5500 If you are not using a template, note the following settings:
5503 \begin_layout Itemize
5513 ocument\SpecialChar \menuseparator
5520 dialog (OK, that one was obvious).
5523 \begin_layout Itemize
5524 Don't change the option
5534 The whole layout is done by the macros, you shouldn't change anything.
5537 \begin_layout Subsection
5541 \begin_layout Standard
5542 First thing to enter is the header information.
5543 It consists of seven entries, of which some are optional.
5547 \begin_layout Itemize
5555 \begin_layout Itemize
5563 \begin_layout Itemize
5571 \begin_layout Itemize
5579 \begin_layout Itemize
5584 : [optional] if more than one author: whom to contact for offprint requests.
5587 \begin_layout Itemize
5592 : [optional] mail address for contacts.
5595 \begin_layout Itemize
5603 Received: <date>; Accepted <date>
5606 \begin_layout Standard
5607 There is no need to issue the
5613 command, this is done automatically by LyX when the header is finished.
5614 Although the order of the single header entries doesn't matter it is advised
5615 to keep the above sequence, just to get the best optics and meets the layout
5616 of the real document.
5619 \begin_layout Standard
5620 If you want to place footnotes in the header block, e.g.
5624 \begin_layout Standard
5632 to state your present address, just use the standard footnote via
5637 nsert\SpecialChar \menuseparator
5645 LyX will automagically use the term
5654 \begin_layout Standard
5655 In addition to these topics, the macros use three additional LaTeX commands
5656 that have no counterpart in LyX:
5659 \begin_layout Itemize
5666 to separate different names for more than one author and institute, respectivel
5670 \begin_layout Itemize
5677 to mark corresponding author/institute pairs.
5678 The institutes are numbered sequentially as they appear in the
5682 field, so you have to put a marker to each author.
5685 \begin_layout Itemize
5692 to supply an email address for fast contact.
5695 \begin_layout Standard
5696 In all cases, the appropriate command has to be entered in LyX an marked
5702 \begin_layout Subsection
5706 \begin_layout Standard
5707 The abstract should immediately follow the header block.
5708 With version 5 the abstract environment was changed to a command, and there
5709 is now a resctriction to only one paragraph.
5710 In addition, it should contain an entry with the keywords.
5711 This is not yet implemented for LyX, therefore you have to enter the LaTeX
5718 by hand and mark it as LaTeX code.
5719 Refer to the example paper.
5722 \begin_layout Subsection
5723 Supported environments
5726 \begin_layout Standard
5727 The A&A paper layout supports the following environments for structuring
5731 \begin_layout Itemize
5737 \begin_layout Itemize
5743 \begin_layout Itemize
5749 \begin_layout Itemize
5755 \begin_layout Itemize
5761 \begin_layout Itemize
5767 \begin_layout Itemize
5773 \begin_layout Itemize
5779 \begin_layout Itemize
5785 \begin_layout Itemize
5791 \begin_layout Itemize
5797 \begin_layout Itemize
5803 \begin_layout Subsection
5804 Commands not supported by LyX
5807 \begin_layout Standard
5808 Some commands are not yet supported by the
5813 Some have already been mentioned.
5814 For the sake of completeness, they are listed all together here:
5817 \begin_layout Itemize
5825 \begin_layout Itemize
5833 \begin_layout Itemize
5841 \begin_layout Itemize
5849 \begin_layout Itemize
5857 \begin_layout Itemize
5865 \begin_layout Itemize
5873 \begin_layout Itemize
5881 \begin_layout Standard
5882 If you want to use any of these commands, you have to enter them yourself.
5885 Do not forget to mark them as LaTeX code!
5888 \begin_layout Subsection
5889 Figure and Table Floats
5892 \begin_layout Standard
5893 LyX provides support for the necessary float environments
5895 figure, figure*, table
5901 , therefore we won't tell much about it here.
5908 Just remember that tables should be left-aligned.
5909 For that, select the table and change the alignment in
5914 dit\SpecialChar \menuseparator
5919 aragraph\InsetSpace ~
5923 \begin_layout Standard
5928 only one special thing: the figures with caption besides the figure.
5929 To create such a figure, you have to do the following:
5932 \begin_layout Enumerate
5933 Create a wide figure float:
5938 nsert\SpecialChar \menuseparator
5943 t\SpecialChar \menuseparator
5946 , then right click in the figure and select
5958 \begin_layout Enumerate
5959 Enter your caption text.
5962 \begin_layout Enumerate
5967 to move the cursor above the caption.
5970 \begin_layout Enumerate
5974 \begin_layout Enumerate
5975 Position the cursor behind the figure and insert a horizontal fill:
5980 nsert\SpecialChar \menuseparator
5988 \SpecialChar \menuseparator
5991 orizontal\InsetSpace ~
5997 \begin_layout Enumerate
5998 Switch to LaTeX mode:
6006 \begin_layout Enumerate
6016 Do not close the brace!
6019 \begin_layout Enumerate
6020 Position the cursor behind the caption text, switch to LaTeX mode and insert
6031 \begin_layout Standard
6032 Also, refer to the figures in the example paper.
6035 \begin_layout Subsection
6039 \begin_layout Standard
6040 For submission, the paper has to be formated in a special double-spacing
6042 For this purpose, you have to give the option
6046 to the documentclass.
6047 This must be done using the extra class options field in the
6052 ocument\SpecialChar \menuseparator
6060 Just enter the string
6067 \begin_layout Subsection
6071 \begin_layout Standard
6076 directory contains an example paper written with LyX.
6077 It is the example paper from the original macro package, translated to
6079 Use it for inspiration, and compare the original LaTeX code with LyX way
6083 \begin_layout Section
6087 \begin_layout Standard
6093 \begin_layout Subsection
6097 \begin_layout Standard
6098 AASTeX is a set of macros produced by the American Astronomical Society
6099 to facilitate electronic manuscript submission to the three journals they
6100 publish: the Astrophysical Journal (including the Letters and Supplement),
6101 the Astronomical Journal, and the Publications of the Astronomical Society
6103 LyX has proven to be an excellent tool for generating these documents,
6104 especially given its equation, citation, and figure handling capabilities.
6105 LyX requires version 5.0 (or higher) of these macros; preferably 5.2, which
6106 is the version described here, or higher.
6107 Versions prior to 5.0 are intended for use with LaTeX2.09 and are fundamentally
6108 incompatible with LyX.
6109 The AASTeX package may be downloaded from the AASTeX Web site
6112 \begin_layout Standard
6113 \begin_inset VSpace medskip
6119 \begin_layout Standard
6121 \begin_inset LatexCommand \url{http://www.journals.uchicago.edu/AAS/AASTeX}
6128 \begin_layout Standard
6129 \begin_inset VSpace medskip
6135 \begin_layout Standard
6136 A complete user guide is contained in that package and you should familiarize
6137 yourself with it thoroughly before embarking on writing a paper in LyX.
6138 LyX will not reduce the need to figure out all the AASTeX commands, it
6139 will only reduce the drudgery of typing everything in.
6140 It is your responsibility to ensure that the final exported LaTeX document
6141 conforms completely to the requirements of the journal to which you are
6142 submitting your paper.
6145 \begin_layout Subsection
6146 Starting a New Paper
6149 \begin_layout Standard
6150 I strongly suggest that you start with the AASTeX template file.
6156 ile\SpecialChar \menuseparator
6163 , enter the new file name, then choose the
6168 This will show the most common fields found in a manuscript.
6169 Simply overwrite the existing text (including the brackets,
6173 ) with the correct information.
6174 Many of the AASTeX commands and environments can be implemented directly
6175 in LyX, but some cannot: most noticeably
6187 , which should stick out like a sore thumb if you actually just opened the
6189 For commands such as these, the LaTeX code must be entered directly and
6191 Such commands are referred to as ERT, or Evil Red Text.
6192 I tried to minimize the amount of ERT needed in an AASTeX document, but
6193 there is still a bit more required than any of us would like.
6196 \begin_layout Subsection
6197 Finishing Your Paper
6200 \begin_layout Standard
6201 When the paper is finished to your satisfaction and previews/prints correctly,
6203 \begin_inset Quotes eld
6207 \begin_inset Quotes erd
6210 actions which need to be done before you submit it to the journals.
6214 \begin_layout Enumerate
6215 Export your paper as a LaTeX file (
6220 ile\SpecialChar \menuseparator
6225 xport\SpecialChar \menuseparator
6236 \begin_layout Enumerate
6241 file with your favorite text editor
6245 \begin_layout Enumerate
6246 remove the comment lines before the
6255 \begin_layout Enumerate
6260 usepackage...{fontenc}
6262 line if it appears (usually just after
6277 \begin_layout Enumerate
6278 remove everything between (and including) the
6290 commands, except for any commands you specifically put into the LaTeX preamble
6291 (which should appear immediately after the
6292 \begin_inset Quotes eld
6295 User specified LaTeX commands
6296 \begin_inset Quotes erd
6307 \begin_layout Enumerate
6308 Run the resulting file through LaTeX to make sure it still processes correctly.
6311 \begin_layout Enumerate
6312 Reread the journal requirements to make sure your filenames and formats
6316 \begin_layout Enumerate
6320 \begin_layout Subsection
6321 Comments On Specific Commands
6324 \begin_layout Standard
6325 I will not describe the detailed usage of the individual AASTeX commands:
6326 the AASTeX User Guide (
6330 ) gives a good description of each.
6331 Thus it's probably easiest for me to go down the list as found in the guide
6332 and offer comments where necessary.
6333 So let's begin \SpecialChar \ldots{}
6337 \begin_layout Subsubsection
6338 Things that work as expected
6341 \begin_layout Standard
6345 \begin_layout Standard
6356 \begin_layout Standard
6357 Because they work as you might expect, I simply list them and the section
6458 begin{thebibliography}
6466 (2.13.2), all the cite commands and their variations (2.13.2), the generic
6467 graphicx figure commands (2.14.1),
6491 (2.15.4, amongst other places),
6518 \begin_layout Standard
6519 The following style options also work correctly:
6540 Simply put them in the
6546 Layout\SpecialChar \menuseparator
6552 \begin_layout Standard
6556 \begin_layout Standard
6567 \begin_layout Subsubsection
6568 Things that work, but require more comment
6571 \begin_layout Standard
6572 The following items work, but require a little more discussion:
6575 \begin_layout Itemize
6576 These items are reserved for use by the journal editors, but you can put
6577 them into the LaTeX preamble if you feel compelled to do so:
6610 \begin_layout Itemize
6611 These items may be placed in the LaTeX preamble, and are included as blanks
6612 in the template file:
6633 \begin_layout Itemize
6640 (2.3) -- can only be used
6641 \begin_inset Quotes eld
6645 \begin_inset Quotes erd
6648 , not in the middle of a paragraph.
6649 Use ERT if you need to embed it.
6652 \begin_layout Itemize
6659 (2.3) -- will have extra {} after it.
6660 This should not cause an error.
6663 \begin_layout Itemize
6670 (2.6) -- can only be used
6671 \begin_inset Quotes eld
6675 \begin_inset Quotes erd
6678 , not in the middle of a paragraph.
6679 Use ERT if you need to embed it.
6682 \begin_layout Itemize
6689 (2.8) -- can't insert a cross-reference tag, you must type the tag name
6693 \begin_layout Itemize
6700 (2.8) -- same as for
6707 \begin_layout Itemize
6714 (2.9) -- will have extra {} after it.
6715 This should not cause an error.
6718 \begin_layout Itemize
6725 (2.11) -- will have extra {} after it.
6726 This should not cause an error.
6729 \begin_layout Itemize
6736 (2.14.2) -- you can insert an optional filename argument by placing the cursor
6737 at the beginning of the text and selecting
6739 Insert\SpecialChar \menuseparator
6744 \begin_inset Quotes eld
6748 \begin_inset Quotes erd
6751 inserts an optional argument of the type needed by
6758 Hopefully it will be renamed someday.
6761 \begin_layout Itemize
6774 for the catalog ID optional parameter
6777 \begin_layout Itemize
6790 for the catalog ID optional parameter
6793 \begin_layout Subsubsection
6794 Things not implemented, use ERT
6797 \begin_layout Standard
6801 \begin_layout Standard
6812 \begin_layout Standard
6835 setcounter{equation}
6837 (2.12), Journal name abbreviations (2.13.4),
6873 (2.15.4, insert it as the first element in the lefthand cell after where
6875 Don't use any of LyX's rules in the table),
6887 (2.15.5), much of Misc (2.17, except
6938 \begin_layout Standard
6942 \begin_layout Standard
6953 \begin_layout Subsubsection
6954 Things that cannot be implemented
6957 \begin_layout Standard
6958 \SpecialChar \ldots{}
6959 at least in any meaningful sort of way, so I suggest ignoring them.
6960 They are the references environment (2.13.3), and the deluxetable environment
6962 If you really, really need to use deluxetable, I suggest editing it in
6963 a separate file with a text editor, then using
6968 nsert\SpecialChar \menuseparator
6976 to include it in your LyX document.
6981 file to see an example of this.
6984 \begin_layout Subsection
6985 FAQs, Tips, Tricks, and Other Ruminations
6988 \begin_layout Subsubsection
6989 Getting LyX and AASTeX to cooperate
6992 \begin_layout Standard
6993 It can be a bit tricky to get LyX to recognize a new layout and document
6995 When all else fails, do this:
6998 \begin_layout Enumerate
6999 Make certain that LaTeX can find AASTeX.
7000 Copy sample.tex (and perhaps table.tex) from the AASTeX distribution into
7001 a directory completely unrelated to LaTeX or AASTeX and run LaTeX on
7008 \begin_layout Enumerate
7015 /usr/.../share/lyx/layouts
7024 \begin_layout Enumerate
7030 ools\SpecialChar \menuseparator
7037 in LyX, then restart LyX.
7040 \begin_layout Enumerate
7041 Open a regular new file, not from a template.
7042 Does AASTeX appear in the class list in
7047 ocument\SpecialChar \menuseparator
7057 \begin_layout Standard
7058 If you get a warning from an existing AASTeX document about not being able
7059 to find the AASTeX layout or a message about
7060 \begin_inset Quotes eld
7063 You should not mix title layouts with normal ones
7064 \begin_inset Quotes erd
7067 , things haven't been installed correctly.
7070 \begin_layout Subsubsection
7071 LaTeX error processing a table
7074 \begin_layout Standard
7075 LyX, by default, attempts to center the table caption/title.
7076 This seems to produce a bad interaction in AASTeX so you should click somewhere
7077 in the caption/title, then select
7082 dit\SpecialChar \menuseparator
7087 aragraph\InsetSpace ~
7102 This took care of it for me.
7105 \begin_layout Subsubsection
7107 \begin_inset LatexCommand \label{cite}
7114 \begin_layout Standard
7115 A couple of things: 1) I have noticed some funny spacing in the reference
7116 entries in the text.
7117 When you enter the bibliography item data, make sure their is
7121 space between the last author and the parenthesis setting off the year;
7136 2) Entering the references at all is not obvious.
7137 The easiest thing is to start typing your first reference at the end of
7138 the document, then mark it as type
7143 That will put a small gray box in front of what you just typed.
7144 Click on the box to fill in the rest of the information.
7145 For new references, go to the end of an existing reference and press return.
7146 That will create a new line with its own box, etc.
7149 \begin_layout Subsubsection
7153 \begin_layout Standard
7154 Even though AASTeX provides its own figure commands (
7160 , for example), I much prefer LaTeX's standard figure commands (with the
7169 commands as ERT into a Figure Float box if you desire, but I never
7170 have much luck getting the layout right.
7171 With the standard graphics, LyX will insert a
7175 usepackage{graphicx}
7177 command into the LaTeX preamble and handle the figures in the standard
7178 LaTeX2e way, interspersing the figures in the text.
7179 I believe ApJ accepts figures exactly this way now; AJ might still use
7181 \begin_inset Quotes eld
7184 stack everything at the end
7185 \begin_inset Quotes erd
7191 \begin_layout Subsubsection
7192 Things I could have done, but didn't
7195 \begin_layout Standard
7197 \begin_inset Quotes eld
7201 \begin_inset Quotes erd
7204 things I could have implemented, but chose not to.
7205 For instance, I saw no point in double-spacing the text in the LyX window,
7206 even though it is double-spaced in the paper manuscript.
7207 Also, I chose not to make separate layouts for the preprint and preprint2
7209 Since I assume you will spend most of your time in the plain manuscript
7210 mode anyway, I decided not to chew up more disk space with this.
7214 \begin_layout Subsection
7218 \begin_layout Standard
7219 Your mileage may vary.
7220 I've now had papers published by both ApJ and AJ that have had 98% of the
7221 effort done in LyX; the last 2% was the LaTeX post-processing and a few
7223 I have had no trouble with the submission process, and I'm sure the journals
7224 were never aware that there might be a difference.
7225 So, go forth and publish!
7228 \begin_layout Section
7232 \begin_layout Standard
7235 Panayotis Papasotiriou
7238 \begin_layout Subsection
7242 \begin_layout Standard
7243 The ijmpd package is a set of macros that facilitates electronic manuscript
7246 International Journal of Modern Physics D
7248 published by World Scientific.
7249 The name of the document class is
7254 This file, together with instructions for the authors, can be downloaded
7256 \begin_inset LatexCommand \url{http://www.worldscinet.com/ijmpd/mkt/guidelines.shtml}
7261 The ijmpd package is a modified version of the standard
7262 \begin_inset Quotes eld
7266 \begin_inset Quotes erd
7270 Most of its features are supported by LyX.
7271 I have recently used LyX successfully to write an article submitted to
7274 International Journal of Modern Physics D
7279 \begin_layout Subsection
7283 \begin_layout Standard
7284 As usual, the easiest way to write a paper is to start with a template.
7290 ile\SpecialChar \menuseparator
7302 This will give an (almost) empty document that includes the most common
7303 fields found in a manuscript.
7304 Simply overwrite the existing text (including the brackets,
7308 ) with the correct information.
7309 You should keep in mind the following remarks.
7312 \begin_layout Enumerate
7313 LyX won't let you change the font size and the page style of the document,
7314 because the ijmpd package does not allow such modifications.
7317 \begin_layout Enumerate
7318 The ijmpd package requires that the language of the document should not
7320 Before previewing your paper, be sure that the babel package is not used.
7321 To do this, click on
7326 ools\SpecialChar \menuseparator
7340 checkbox in the language settings, and click on
7351 , if you wish to make this change permanent).
7354 \begin_layout Enumerate
7355 Two new environments, named
7356 \begin_inset Quotes eld
7360 \begin_inset Quotes erd
7364 \begin_inset Quotes eld
7368 \begin_inset Quotes erd
7371 are available (their use is obvious).
7374 \begin_layout Enumerate
7375 Appendices may be added to the paper.
7376 LyX offers a special environment, called
7377 \begin_inset Quotes eld
7381 \begin_inset Quotes erd
7384 which marks the beginning of the appendix.
7385 An appendix can contain normal sections, subsections, or subsubsections.
7388 \begin_layout Enumerate
7389 The ijmpd package implements table captions quite differently than LyX does.
7390 As a result, a table created by LyX is printed correctly, but its caption
7392 If you need table captions, you should implement the whole table float
7397 file, then include this file to the LyX document (
7402 nsert\SpecialChar \menuseparator
7411 Details on how to create an ijmpd table float can be found in the file
7416 , which is included in the ijmpd package.
7419 \begin_layout Subsection
7420 Preparing a paper for submission
7423 \begin_layout Standard
7424 Before you submit your paper you must export the LyX document as a LaTeX
7430 ile\SpecialChar \menuseparator
7435 xport\SpecialChar \menuseparator
7442 ), then make the following changes to the resulting
7449 \begin_layout Enumerate
7450 Remove the comment lines before the
7459 \begin_layout Enumerate
7460 Remove everything between (and including) the
7472 commands, except for any commands you specifically put into the LaTeX preamble.
7475 \begin_layout Standard
7480 file should be saved and processed through LaTeX as many times as necessary.
7481 You may also want to check the resulting
7488 \begin_layout Subsection
7492 \begin_layout Standard
7493 The use of ERT is optional, and is reduced to three commands, which affect
7494 the look of the page.
7495 If you started writing your paper by using the
7499 template, the ERT needed is already in its place; you usually don't need
7501 You may only change the first ERT to specify the information printed to
7502 the top of odd and even pages (authors' names and short paper's title,
7504 This ERT must have the form
7508 markboth{Authors' Names}{Short Paper's Title}
7513 \begin_layout Section
7517 \begin_layout Standard
7520 Panayotis Papasotiriou
7523 \begin_layout Subsection
7527 \begin_layout Standard
7528 The Kluwer package is a set of macros produced by Kluwer Academic Publishers
7529 that facilitates electronic manuscript submission to the journals they
7531 Most known of them (at least in my domain of interest) are
7533 Astrophysics and Space Science
7539 , but there are many others (see a complete list at
7540 \begin_inset LatexCommand \url{http://www.wkap.nl/jrnllist.htm/JRNLHOME}
7545 The Kluwer package may be downloaded from the site
7546 \begin_inset LatexCommand \url{http://www.wkap.nl/kaphtml.htm/STYLEFILES}
7551 A complete user guide is contained in that package (but it can also be
7552 downloaded separately).
7555 \begin_layout Standard
7556 LyX supports many features of the package but not everything.
7557 However, the ERT needed is reduced to some
7558 \begin_inset Quotes eld
7562 \begin_inset Quotes erd
7565 commands of the package (see\InsetSpace ~
7567 \begin_inset LatexCommand \ref{subsec:kluwer_peculiarities}
7572 I have recently used LyX to write an article submitted to the
7574 Astrophysics and Space Science
7576 without any problem.
7579 \begin_layout Subsection
7583 \begin_layout Standard
7584 The easiest way to write a paper is to start with the Kluwer template file.
7587 File\SpecialChar \menuseparator
7599 This will give an (almost) empty document that includes the most common
7600 fields found in a manuscript and a short description of their use.
7601 As in most templates, simply overwrite the existing text (including the
7606 ) with the correct information.
7609 \begin_layout Subsection
7610 Preparing a paper for submission
7613 \begin_layout Standard
7614 As in the AASTeX package, before you submit your paper to a journal you
7616 \begin_inset Quotes eld
7620 \begin_inset Quotes erd
7626 \begin_layout Enumerate
7627 Export your paper as a LaTeX file.
7628 To do this, click on
7633 ile\SpecialChar \menuseparator
7638 xport\SpecialChar \menuseparator
7649 \begin_layout Enumerate
7654 file with a text editor and make the following changes
7658 \begin_layout Enumerate
7659 remove the comment lines before the
7668 \begin_layout Enumerate
7669 remove everything between (and including) the
7681 commands, except for any commands you specifically put into the LaTeX preamble.
7684 \begin_layout Standard
7693 \begin_layout Enumerate
7698 file through LaTeX as many times as necessary (usually up to three).
7701 \begin_layout Enumerate
7706 document using, e.g.,
7710 , and check if everything is ok (it should, if you didn't make any mistake).
7713 \begin_layout Subsection
7714 \begin_inset Quotes eld
7718 \begin_inset Quotes erd
7721 of the Kluwer package
7722 \begin_inset LatexCommand \label{subsec:kluwer_peculiarities}
7729 \begin_layout Standard
7730 The Kluwer package has the following
7731 \begin_inset Quotes eld
7735 \begin_inset Quotes erd
7741 \begin_layout Enumerate
7742 It is possible to write multiple articles in the same LaTeX file
7746 \begin_layout Standard
7747 I can't imagine any good reason to do this.
7753 Each article must be included in the environment
7754 \begin_inset Quotes eld
7758 \begin_inset Quotes erd
7762 Unfortunately, this environment cannot be omitted, even if you write just
7764 Therefore, each article starts with the command
7770 and, obviously, ends with the command
7777 Although this can be implemented in LyX, I didn't included it, since it
7778 looks ugly and can confuse the novice user.
7779 Therefore, you need to enter them directly and mark them as LaTeX code
7781 \begin_inset Quotes eld
7785 \begin_inset Quotes erd
7791 \begin_layout Enumerate
7792 Information given at the beginning of the article (i.e., title, subtitle,
7793 author, institution, running title, running author, abstract and keywords)
7794 must be included in an environment called
7795 \begin_inset Quotes eld
7799 \begin_inset Quotes erd
7803 This is not implemented in LyX, so you must enter title, subtitle etc.
7804 between two ERT lines (
7819 \begin_layout Enumerate
7820 According to the user manual, the label of each bibliography item must be
7844 \begin_layout Standard
7849 template takes care of all these
7850 \begin_inset Quotes eld
7854 \begin_inset Quotes erd
7858 If you start a new paper using this template you don't need to do anything
7863 \begin_layout Enumerate
7864 don't delete the ERT included in the template, and
7867 \begin_layout Enumerate
7868 copy the example bibliography item included in the template and modify it
7869 as necessary to enter new bibliography items.
7872 \begin_layout Section
7876 \begin_layout Standard
7882 \begin_layout Subsection
7886 \begin_layout Standard
7887 The LyX document classes
7889 article (koma-script)
7893 report (koma-script)
7911 correspond to the LaTeX document classes
7928 of the Koma-Script family.
7929 They are replacements for the standard document classes
7945 , resp., and fit better to European typography conventions in a number of
7949 \begin_layout Itemize
7950 Standard character size is 11pt in
7952 article (koma-script)
7956 report (koma-script)
7964 letter (koma-script)
7969 \begin_layout Itemize
7970 Headings, labels of the description environment, and a number of elements
7973 letter (koma-script)
7975 document class are set in a bold sans serif font.
7979 \begin_layout Standard
7980 There is a big difference between the bold sans serif old cm fonts and new
7981 ec fonts, especially in the appearance of headings.
7982 In comparison, the ec bold sans serif fonts look a bit thin.
7983 Here the LaTeX package
7990 helps to produce the
7991 \begin_inset Quotes eld
7995 \begin_inset Quotes erd
7998 appearance when using the ec fonts.
8003 The numbering of chapter headings is made in the same way as the numbering
8004 of section headings, that is without the extra line
8005 \begin_inset Quotes eld
8008 Chapter\SpecialChar \ldots{}
8010 \begin_inset Quotes erd
8014 In addition, the appearance of the headings can be modified by using a
8015 number of options (in LyX to be entered in the field
8029 ayout\SpecialChar \menuseparator
8037 A detailed German description of these options can be found in the Koma-Script
8045 \begin_layout Itemize
8046 The main means in the Koma-Script document classes to design the type area
8055 (in LyX to be entered in the extra class options field in the dialog
8060 ocument\SpecialChar \menuseparator
8068 They make a clearer modification of page margins possible as do the options
8074 ocument\SpecialChar \menuseparator
8082 A detailed German description of these and other type area options can
8083 be found in the Koma-Script documentation
8090 \begin_layout Itemize
8091 The LaTeX document classes of the Koma-Script family define a number of
8092 additional commands.
8093 Those part of it which makes sense in LyX is implemented in corresponding
8097 \begin_layout Standard
8098 A detailed German description of the LaTeX document classes of the Koma-Script
8099 family can be found in the Koma-Script documentation
8107 \begin_layout Standard
8108 There is an English translation
8112 , but it is not a complete one.
8117 The following sections describe only those aspects, which are relevant
8121 \begin_layout Subsection
8122 article (koma-script), report (koma-script), and book (koma-script)
8125 \begin_layout Standard
8126 The document classes
8128 article (koma-script)
8132 report (koma-script)
8142 are implemented in the layout files
8155 They contain all the paragraph types of the corresponding standard document
8168 , resp., partly modified, with the exception of the LyX specific
8172 -type, which is replaced by the new
8176 -type having the same functionality.
8181 -Type there is a number of new paragraph types added.
8188 letter (koma-script)
8193 \begin_layout Itemize
8202 : are equivalents to
8210 , resp., additionally inserting an entry in the table of contents.
8219 are not contained in
8221 article (koma-script)
8226 \begin_layout Itemize
8243 , resp., additionally clearing running heads.
8250 article (koma-script)
8256 \begin_layout Standard
8269 report (koma-script)
8271 , but since this is identical to
8275 , is has not been implemented in LyX.
8283 \begin_layout Itemize
8288 : generates a heading directly above the following paragraph in the standard
8289 character size without affecting the structure of the document.
8292 \begin_layout Itemize
8301 are special captions which respect the different space settings needed for
8302 captions placed above or below an element (if you follow strict typographic
8303 rules, you might want to place table captions always above the table).
8304 You can also use the class option
8321 You need at least Koma-Script version 2.8q to use this.
8324 \begin_layout Itemize
8329 : can be used to set a bonmot, e.
8333 \begin_layout Standard
8345 \begin_layout Standard
8353 at the beginning of a chapter.
8354 If you use the optional argument (
8359 nsert\SpecialChar \menuseparator
8363 ), you can insert the dictum's author there.
8364 Dictum and author are separated by a line.
8365 You need at least Koma-Script version 2.8q to use this.
8372 article (koma-script)
8377 \begin_layout Standard
8378 The following types, together with the standard types
8390 , form the title area of the document.
8391 They must be entered ahead of the first
8392 \begin_inset Quotes eld
8396 \begin_inset Quotes erd
8403 \begin_layout Standard
8404 The corresponding LaTeX commands must appear before the
8415 When such a type is used more than once, the latter usage overwrites the
8416 former one, that means, for every type only the latest usage is valid.
8417 The order of the different types however has, like
8429 , no effect on the appearance of the produced document.
8432 \begin_layout Itemize
8437 : produces a centered paragraph above the ordinary title (
8449 ) for the subject of the document.
8452 \begin_layout Itemize
8457 : produces a centered paragraph below the ordinary title (
8469 ) for the publishers' name.
8472 \begin_layout Itemize
8479 report (koma-script)
8485 produces a centered paragraph on its own page behind the title page, or
8488 article (koma-script)
8490 produces a centered paragraph below the ordinary title (
8509 \begin_layout Itemize
8514 : produces a left aligned paragraph above the ordinary title (
8530 ) for a document`s head.
8533 \begin_layout Itemize
8538 : produces in a double-sided print in
8540 report (koma-script)
8546 a left-aligned paragraph at the top of the title page`s back or has no
8547 effect in a single-sided print or in
8549 article (koma-script)
8554 \begin_layout Itemize
8559 : produces in a double-sided print in
8561 report (koma-script)
8567 a left-aligned paragraph at the bottom of the title page`s back or has
8568 no effect in a single-sided print or in
8570 article (koma-script)
8575 \begin_layout Itemize
8580 : produces a special
8581 \begin_inset Quotes eld
8585 \begin_inset Quotes erd
8588 page ahead of the actual document containing a paragraph without special
8592 \begin_layout Standard
8593 The layout files for the document classes
8595 article (koma-script)
8599 report (koma-script)
8610 This is thought of as a place to define your own types.
8615 in your personal layout directory and edit the file!
8618 \begin_layout Subsection
8619 letter (koma-script)
8622 \begin_layout Standard
8626 \begin_layout Standard
8637 \begin_layout Standard
8641 letter (koma-script)
8643 is implemented in the layout file
8648 It contains all the paragraph types of the corresponding standard document
8653 , partly modified, with the exception of the LyX specific types
8665 type, which is replaced by the new
8670 In addition, it contains, in contrast to the standard document class, the
8688 Furthermore, there are a number of new letter specific types.
8691 \begin_layout Standard
8695 \begin_layout Standard
8706 \begin_layout Standard
8707 The appearance of the letter produced by this document class can be controlled
8708 by a number of LaTeX commands, which you can put in the LaTeX preamble.
8712 \begin_layout Standard
8713 For example, the standard appearance of the letter`s heading, consisting
8714 of name and address, is quite self-willed.
8716 \begin_inset Quotes eld
8720 \begin_inset Quotes erd
8723 heading is produced by the following LaTeX commands in the preamble:
8726 \begin_layout LyX-Code
8736 \begin_layout LyX-Code
8752 \begin_layout LyX-Code
8762 \begin_layout LyX-Code
8782 A detailed German description of such LaTeX commands can be found in the
8783 Koma-Script documentation
8788 With it, the letter's author can produce his personal letter layout.
8791 \begin_layout Standard
8800 define the beginning of the letter and must be used in every letter.
8801 To emphasize them in the LyX document class, they are marked with the letter
8812 It is possible to write any number of letters in one file.
8817 type produces a new letter using the same addressee and a
8821 type produces a new addressee.
8838 are ordinary paragraph types and can also be used several times in one
8839 and the same letter.
8842 \begin_layout Itemize
8847 : produces a paragraph for the addressee and implicitly defines the beginning
8851 \begin_layout Itemize
8856 : produces a paragraph for the form of address and implicitly produces a
8860 \begin_layout Itemize
8865 : produces a paragraph for a close.
8868 \begin_layout Itemize
8873 : produces a paragraph for a postscript.
8876 \begin_layout Itemize
8881 : produces a paragraph for a distribution list.
8884 \begin_layout Itemize
8889 : produces a paragraph for enclosures.
8892 \begin_layout Standard
8933 are input types provided with a label to enter information, which will
8934 be processed by the document class.
8938 \begin_layout Standard
8939 It could be seen as a matter of inconsequence, that the types
8947 described above are not such input types as well.
8948 Because of the special meaning of those types, however, I have implemented
8949 them as ordinary paragraph types with a one letter mark in the left margin.
8950 Moreover, it would affect my feeling of symmetry, if the
8958 type had such a serious different appearance.
8963 The types must be used ahead of the corresponding
8970 \begin_layout Standard
8971 An implementation of these types in a WYSIWYG fashion does not seem to make
8972 sense, because the real appearance of the produced letter does not only
8973 depend on the usage of the particular type, but also on other factors.
8974 For example, a signature entered in the
8978 type will in the standard behavior appear in the produced letter only,
8979 when in the same letter also a
8984 The entered value of the
8988 type will in the standard behavior not appear in the produced letter at
8990 The possibility to design the letter`s heading freely is already indicated
8991 in a footnote above.
8994 \begin_layout Standard
8995 The input types can also be used as empty paragraphs.
8996 This makes sense e.\InsetSpace ~
9007 type is not used at all, in the standard behavior the value of the
9011 type is used as signature, whereas if an empty
9015 type is used, no signature value is defined.
9018 \begin_layout Standard
9019 By using the input types it is possible to write a letter template, containing
9020 filled input types with your personal dates (name, address, etc.) and empty
9021 input types for other dates you want to enter.
9024 \begin_layout Itemize
9029 : sender's name, in the standard behavior appears as a centered paragraph
9030 in small caps in the letter`s heading.
9033 \begin_layout Itemize
9038 : sender's signature, in the standard behavior appears below the
9047 type is used, the value of the
9051 type appears instead.
9054 \begin_layout Itemize
9059 : sender's address, in the standard behavior appears in a centered paragraph
9060 in the letter`s heading below the sender's name.
9063 \begin_layout Itemize
9068 : sender's telephone number, in the standard behavior only sets the LaTeX
9078 \begin_layout Itemize
9083 : place of the letter`s making.
9086 \begin_layout Itemize
9091 : date of the letter`s making.
9100 , in the standard behavior, produce the place and the date in a right-aligned
9101 line below the addressee's field.
9106 type is used, neither place nor date appear, independent of the value of
9116 type is used, the date of the letter `s production is used.
9119 \begin_layout Itemize
9124 : sender`s back address, in the standard behavior appears above the addressee's
9125 field in a small sans serif font.
9128 \begin_layout Itemize
9133 : special mail information, in the standard behavior appears underlined
9134 above the addressee's field below the back address.
9137 \begin_layout Itemize
9142 : additional information, in the standard behavior appears on right side
9143 below the addressee`s field.
9146 \begin_layout Itemize
9151 : the letter's title, in the standard behavior appears in a big, bold, sans
9152 serif font above the subject.
9155 \begin_layout Itemize
9160 : the letter's subject, in the standard behavior appears in a bold font
9168 \begin_layout Standard
9189 produce a business letter like line above the
9193 line containing the fields
9194 \begin_inset Quotes eld
9198 \begin_inset Quotes erd
9202 \begin_inset Quotes eld
9206 \begin_inset Quotes erd
9210 \begin_inset Quotes eld
9214 \begin_inset Quotes erd
9218 \begin_inset Quotes eld
9222 \begin_inset Quotes erd
9226 \begin_inset Quotes eld
9230 \begin_inset Quotes erd
9234 \begin_inset Quotes eld
9238 \begin_inset Quotes erd
9242 For the date field, the value of the
9248 \begin_inset Quotes eld
9251 business letter types
9252 \begin_inset Quotes erd
9255 is used, the value of the
9259 type however does not appear, but only the LaTeX variable
9266 The ordinary output of place and date in a right-aligned line below the
9267 addressee`s field is suppressed.
9268 The types are implemented as input types provided with a label and must
9269 be used ahead of the corresponding
9276 \begin_layout Itemize
9284 \begin_layout Itemize
9292 \begin_layout Itemize
9300 \begin_layout Itemize
9308 \begin_layout Itemize
9316 \begin_layout Subsection
9317 The new letter class: letter (koma-script v.2)
9320 \begin_layout Standard
9323 Jürgen Spitzmüller
9326 \begin_layout Standard
9327 \begin_inset VSpace medskip
9333 \begin_layout Standard
9335 Koma-Script version 2.8 has introduced a new letter class
9339 which superceeds the now unsupported
9344 It has --- on the LaTeX side --- a completely new interface and is not
9345 compatible with the old class.
9346 Therefore, LyX supports both, though it is recommended to use the new class.
9349 \begin_layout Standard
9350 This class covers the same functionality as
9352 letter (koma-script),
9359 (receiver's address, same as
9376 will start a new letter (i.
9380 \begin_layout Standard
9392 \begin_layout Standard
9400 you can write several letters per document).
9401 New elements are sender's
9417 and the possibility to use a
9426 nsert\SpecialChar \menuseparator
9436 \begin_layout Standard
9437 The biggest improvement is, though, that the letter's layout is configurable
9438 at almost any needs.
9439 This can be done via the preamble or with a special style file (Letter
9440 Class Option, extension
9444 ), that will be read in as a class option.
9448 \begin_layout Standard
9449 The KOMA package comes with some default
9454 There is, for instance, a
9458 file that follows german typesetting rules, or a
9462 that provides the default layout of the old
9467 The latter can be loaded with the class option
9476 ayout\SpecialChar \menuseparator
9481 ocument\SpecialChar \menuseparator
9493 template that is included in LyX for examples.
9494 A detailed description is to be found in the Koma-Script documentation
9502 \begin_layout Subsection
9506 \begin_layout Standard
9507 Visualizing the Koma-Script document classes in LyX, the LyX internals cause
9511 \begin_layout Itemize
9512 The chapter number of a
9516 type appears on a line of its own above the chapter heading instead of
9517 appearing in the same line ahead of it.
9518 The cause for that is the LyX internal behavior for the labeltype
9525 \begin_layout Itemize
9526 The headings of the types
9535 \begin_inset Quotes eld
9539 \begin_inset Quotes erd
9542 LaTeX table of contents, but not in the LyX table of contents (
9547 ocument\SpecialChar \menuseparator
9559 \begin_layout Itemize
9564 document class appear in a skip separation mode, not indented.
9565 This is the standard behavior, no special LaTeX commands are needed for
9572 ocument\SpecialChar \menuseparator
9579 dialog the corresponding radio button indicates
9595 value always has the effect that extra LaTeX commands are inserted in the
9596 document to produce the gap, which is not what is wanted in this case.
9599 \begin_layout Section
9607 \begin_layout Standard
9613 \begin_layout Subsection
9617 \begin_layout Standard
9618 These are the layout files for some of the journal formats used by Springer
9619 Verlag and listed on
9620 \begin_inset LatexCommand \url{http://www.springer.de/author/tex/help-journals.html}
9624 , where you should also go to fetch the class files (yes, these are LaTeX2e
9626 It is a modular system: the things common to all journals are implemented
9631 , which journal-specific layout files (such as, e.g.,
9635 for Journal of Geodesy) can include.
9638 \begin_layout Standard
9639 This means that implementing support for any other Springer journal on this
9640 list is as simple as writing your own
9648 file following the outline given in
9656 \begin_layout Standard
9657 It is reasonably well tested only for the Journal of Geodesy.
9666 come with the standard LyX distribution.
9667 Install the relevant class file (downloaded from Springer) in a proper
9668 directory, reconfigure LaTeX (in the teTeX case by running
9672 , as root if necessary --- doesn't LyX take care of this?), reconfigure
9673 LyX and it should work.
9676 \begin_layout Subsection
9680 \begin_layout Standard
9681 A large number of theorem-like styles ---
9687 \SpecialChar \ldots{}
9693 \begin_layout Standard
9696 Headnote, Dedication, Subtitle, Running_LaTeX_Title, Author_Running, Institute,
9697 Mail, Offprints, Keywords, Acknowledgements, Acknowledgement
9700 See the Springer class file documentation for details.
9703 \begin_layout Subsection
9707 \begin_layout Itemize
9719 \begin_layout Itemize
9722 Probability Theory and Related Fields
9728 --- Jean-Marc Lasgouttes
9731 \begin_layout Standard
9732 Add your own, it isn't so hard!
9735 \begin_layout Subsection
9739 \begin_layout Standard
9740 These files are partly based on the older
9744 , which was again based on a tinkered-with version of an old LaTeX 2.09 style
9750 layout, are now defunct.
9751 Jean-Marc Lasgouttes helped out big in making me find my way around the
9752 LyX layout file mechanism.
9755 \begin_layout Subsection
9759 \begin_layout Standard
9761 But probably less than in the old hacked-LaTeX
9768 \begin_layout Standard
9769 Limitations e.g.: does not display the number for theorem-like layouts, just
9773 \begin_layout Section
9781 \begin_layout Standard
9787 \begin_layout Subsection
9791 \begin_layout Standard
9792 These are the layout files for some of the journals of the American Geophysical
9794 It is assumed that you have both the AGU's own class files and AGUplus
9795 installed (everything to be found at
9796 \begin_inset LatexCommand \url{ftp://ftp.agu.org/journals/latex/journals}
9803 \begin_layout Subsection
9807 \begin_layout Standard
9817 They are still called this in the LyX GUI, though their LaTeX equivalents
9818 in the AGU classes are
9829 \begin_layout Standard
9830 Newly defined styles are
9867 These are mostly manuscript attributes and defined in the AGU class documentati
9871 \begin_layout Standard
9872 I suspect this is still badly incomplete.
9875 \begin_layout Subsection
9879 \begin_layout Standard
9896 \begin_layout Subsection
9900 \begin_layout Itemize
9903 Journal of Geophysical Research
9912 \begin_layout Standard
9913 Add your own, it isn't so hard! Look at the
9924 \begin_layout Subsection
9925 Bugs and things to remember
9928 \begin_layout Standard
9929 In order to use the new layouts, you must remember to do the following for
9933 \begin_layout Enumerate
9939 This can be done in the
9941 layout\SpecialChar \menuseparator
9946 document\SpecialChar \menuseparator
9950 (AGU articles are always in English, right? So
9957 \begin_layout Enumerate
9967 (Yes, this is a bug.)
9970 \begin_layout Enumerate
9971 Make sure you use the
9975 bibliography style, by entering
9979 into the second field of the BibTeX inset.
9980 None of the standard styles will do.
9983 \begin_layout Section
9991 \begin_layout Standard
9997 \begin_layout Subsection
10001 \begin_layout Standard
10002 This is the layout file for the European Geophysical Society journals.
10007 can be downloaded from the web site of the EGS under
10008 \begin_inset LatexCommand \url{www.copernicus.org}
10015 \begin_layout Subsection
10019 \begin_layout Standard
10022 Right_address, Latex_Title, Affil, Journal, msnumber, FirstAuthor, Received,
10030 The current layout file is unfortunately very unmodular and would benefit
10031 from using the various
10038 \begin_layout Section
10044 \begin_inset LatexCommand \label{sec:slitex}
10051 \begin_layout Standard
10059 \begin_layout Subsection
10063 \begin_layout Standard
10064 This section describes how to use LyX to make slides for overhead projectors.
10065 There are two document classes that can do this: the default slides class
10071 This section documents the former.
10074 \begin_layout Standard
10075 I'm going to say this again, nice and clear, so that there's no misunderstanding
10079 \begin_layout Standard
10080 \begin_inset VSpace bigskip
10086 \begin_layout Standard
10090 This section documents the class
10091 \begin_inset Quotes eld
10099 \begin_inset Quotes erd
10107 \begin_layout Standard
10108 \begin_inset VSpace bigskip
10114 \begin_layout Standard
10115 If you're looking for the documentation for
10116 \begin_inset Quotes eld
10124 \begin_inset Quotes erd
10127 , check out section\InsetSpace ~
10129 \begin_inset LatexCommand \ref{sec:foiltex}
10139 \begin_inset Quotes eld
10147 \begin_inset Quotes erd
10150 ] is actually somewhat better than the default
10158 \begin_layout Standard
10159 \SpecialChar \ldots{}
10160 or so I've been told repeatedly by its advocates.
10161 Having never used it, I have no idea if this claim is true or not.
10166 which this section documents.
10169 \begin_layout Standard
10170 This class is the LaTeX2e improvement of the old
10175 Every LaTeX2e distribution includes this class [which I'll just refer to
10177 \begin_inset Quotes eld
10185 \begin_inset Quotes erd
10188 from now on], so you're bound to have it.
10189 As I noted earlier, there are other classes, such as
10193 , which also produce slides for overhead projectors and do a better job
10195 However, there are some things which
10199 can do which the others can't, such as generate overlays.
10200 Read on to learn more!
10203 \begin_layout Subsection
10205 \begin_inset LatexCommand \label{sec:slidesetup}
10212 \begin_layout Standard
10213 Obviously, to use this document class, you need to select
10214 \begin_inset Quotes eld
10222 \begin_inset Quotes erd
10225 from the class list in the
10230 ocument\SpecialChar \menuseparator
10238 There are some other special things you should know about this class:
10241 \begin_layout Itemize
10242 Don't bother changing the options
10247 They're not supported by the
10254 \begin_layout Itemize
10263 behaves a bit differently for this class.
10264 The possible choices and what they do are as follows:
10268 \begin_layout Description
10273 The final output contains page numbers in the lower right corner.
10276 \begin_layout Description
10285 , but also prints out any time markers you've put in.
10286 This is the default.
10289 \begin_layout Description
10294 The final output contains no page numbers, time markers, or alignment markers.
10298 \begin_layout Itemize
10303 class has an extra option:
10309 \begin_inset Quotes eld
10317 \begin_inset Quotes erd
10320 in the extra class options.
10324 \begin_layout Standard
10325 Using this options allows you to add time markers to
10330 See section\InsetSpace ~
10332 \begin_inset LatexCommand \ref{sec:slideNote}
10340 \begin_layout Standard
10341 You can also use the template file
10342 \begin_inset Quotes eld
10350 \begin_inset Quotes erd
10353 to automatically set up a document to use the
10362 ile\SpecialChar \menuseparator
10371 to open your new document].
10372 The template file also contains some examples of the special paragraph
10373 environments used by this class.
10374 I'll describe those next.
10377 \begin_layout Subsection
10378 Paragraph Environments
10381 \begin_layout Subsubsection
10382 Supported Environments
10385 \begin_layout Standard
10386 The first thing you'll notice when you start up a new
10390 document is the font size and type: it's the equivalent of the size
10391 \begin_inset Quotes eld
10399 \begin_inset Quotes erd
10408 This is also what's used in the output.
10410 \begin_inset Quotes eld
10414 \begin_inset Quotes erd
10417 to remind you that this is a slide.
10418 Your final slides will use a larger font; ergo, you'll have less space.
10419 Of course, the larger default screen font isn't WYSIWYG, only a reminder.
10422 \begin_layout Standard
10423 The next thing that becomes obvious is the changes to the paragraph environment
10424 pull-down box [at the far-left end of the toolbar].
10425 Most of the paragraph environments you're used to seeing are missing.
10426 There are also five new ones.
10431 class itself only supports certain paragraph environments:
10434 \begin_layout Itemize
10440 \begin_layout Itemize
10446 \begin_layout Itemize
10452 \begin_layout Itemize
10458 \begin_layout Itemize
10464 \begin_layout Itemize
10470 \begin_layout Itemize
10476 \begin_layout Itemize
10482 \begin_layout Itemize
10488 \begin_layout Itemize
10494 \begin_layout Itemize
10500 \begin_layout Standard
10501 All of the other standard environments, including the section-heading environmen
10502 ts, aren't used in the
10509 \begin_layout Standard
10510 On the other hand, you'll notice the following new environments:
10513 \begin_layout Itemize
10519 \begin_layout Itemize
10525 \begin_layout Itemize
10531 \begin_layout Itemize
10537 \begin_layout Itemize
10543 \begin_layout Standard
10544 These five are kind of quirky, due to a
10545 \begin_inset Quotes eld
10549 \begin_inset Quotes erd
10553 You see, LyX doesn't permit you to nest any other paragraph environment
10554 into an empty environment.
10555 Now, that's fine and dandy, but it means that you wouldn't be able to start
10556 a slide with anything except plain text.
10557 To deal with this, I've performed a little
10558 \begin_inset Quotes eld
10562 \begin_inset Quotes erd
10568 \begin_layout Subsubsection
10569 Quirks of the New Environments
10570 \begin_inset LatexCommand \label{sec:slideQuirk}
10577 \begin_layout Standard
10578 All five of the new paragraph environments are somewhat quirky due to inherent
10579 limitiations in the current version of LyX.
10580 As I just mentioned, LyX forbids environments that begin with another environme
10582 To get around this, the
10586 environment isn't a paragraph environment as described in the
10594 \begin_layout Standard
10595 You should consider
10608 \begin_inset Quotes eld
10611 pseudo-environments.
10612 \begin_inset Quotes erd
10615 They look like a section heading or a
10616 \begin_inset Quotes eld
10624 \begin_inset Quotes erd
10627 but really begin a [and, if necessary, end the previous] paragraph environment.
10637 \begin_inset Quotes eld
10641 \begin_inset Quotes erd
10644 These two perform some action.
10647 \begin_layout Standard
10648 A common feature of all five environments,
10668 , is a rather long-ish label.
10669 The text following this label --- ordinarily the contents of the paragraph
10670 environment --- is utterly irrelevant for
10691 LyX completely ignores it.
10692 In fact, you can leave these five environments completely empty.
10696 \begin_layout Standard
10701 to put any text after the rather long-ish label, you might want to.
10702 This could be a short description of the contents of the
10707 In that case, enter in your descriptive comment and hit
10711 as you normally would.
10714 \begin_layout Standard
10715 If, on the other hand, you don't want to enter in any descriptive text,
10716 you'll hit another LyX quirk.
10717 LyX, like nature, abhors a vacuum, and will not let you start a new paragraph
10718 environment until you put something in the old one.
10722 \begin_layout Itemize
10723 Start entering the text that will
10751 \begin_layout Itemize
10752 Now move to the beginning of that paragraph.
10756 \begin_layout Itemize
10765 \begin_layout Itemize
10766 Finally, change this new, empty paragraph to a
10790 \begin_layout Standard
10791 Some future version of LyX will, hopefully, resolve this quirkiness\SpecialChar \ldots{}
10795 \begin_layout Subsection
10796 Making a Presentation with
10809 \begin_layout Subsubsection
10817 \begin_layout Standard
10818 If you're expecting this section to teach you how to actually make a presentatio
10819 n, you'll be sorely disappointed.
10820 Naturally, I'll describe all of the ways the
10824 class can assist you in preparing the materials for a presentation.
10825 Filling in the contents, however, is up to you.
10830 the LyX philosophy.]
10833 \begin_layout Standard
10838 environment [in the manner described in section\InsetSpace ~
10840 \begin_inset LatexCommand \ref{sec:slideQuirk}
10844 ] tells LyX to begin a new slide [duh].
10845 The label for this environment/
10846 \begin_inset Quotes erd
10850 \begin_inset Quotes erd
10854 \begin_inset Quotes eld
10858 \begin_inset Quotes erd
10861 in cool blue, followed by the label,
10862 \begin_inset Quotes eld
10866 \begin_inset Quotes erd
10870 Any text or paragraph environments that follow this one go on the new slide.
10874 \begin_layout Standard
10875 Slides are probably the only time you'll need to forcibly end pages in LyX
10876 (this can be specified in the
10881 In fact, you'll want to, once you finish entering the contents of one slide.
10882 If you've entered more text than can physically fit on a slide, the extra
10883 overflows onto a new slide.
10884 I don't recommend doing this, however, since the overflow slide won't have
10885 any page number on it.
10886 Furthermore, it may interfere with any
10890 you've made to accompany the oversized
10897 \begin_layout Standard
10906 environments work the same way as the
10911 They both create an
10912 \begin_inset Quotes eld
10916 \begin_inset Quotes erd
10919 followed by a label [
10920 \begin_inset Quotes eld
10924 \begin_inset Quotes erd
10928 \begin_inset Quotes eld
10932 \begin_inset Quotes erd
10936 The color is a stunning magenta instead of blue, and the
10937 \begin_inset Quotes eld
10941 \begin_inset Quotes erd
10944 will look different, in style and in length.
10945 The label fonts of all three also differ from one another.
10948 \begin_layout Standard
10953 , if the contents of a
10961 exceed the physical size of a slide or sheet of paper, the extra will overflow
10963 Again, you should avoid this.
10964 It defeats the whole purpose of
10975 \begin_layout Subsubsection
10985 \begin_layout Standard
10990 is a slide that sits atop another slide.
10991 Perhaps you wish to discuss a figure on the main
10995 before displaying the text associated with it.
10996 One way to accomplish this is tape a flap of dark paper over the part of
11001 you want to display later.
11002 This method fails, however, if you wish to overlap one graph with another,
11004 You would then have to fumble while speaking to align the two separate,
11009 s to align the two graphs.
11014 environment in both cases makes life much easier.
11017 \begin_layout Standard
11022 receives the page number of its
11023 \begin_inset Quotes eld
11027 \begin_inset Quotes erd
11035 \begin_inset Quotes eld
11043 \begin_inset Quotes erd
11050 \begin_layout Standard
11051 Presumably, mutliple
11056 \begin_inset Quotes eld
11064 \begin_inset Quotes erd
11068 \begin_inset Quotes eld
11076 \begin_inset Quotes erd
11080 \begin_inset Quotes eld
11088 \begin_inset Quotes erd
11091 , etc.\InsetSpace ~
11092 appended to the page number of the parent
11102 Clearly, you want the contents of both the
11110 to each fit on a single physical slide! You should probably consider an
11116 \begin_inset Quotes eld
11120 \begin_inset Quotes erd
11132 class provides a visual cue for this: the label at the start of an
11136 is shorter than that at the start of a
11141 Lastly, when you generate printable output, you'll find alignment markers
11142 in all four corners of both the
11146 page and its parent
11151 These will assist you in lining up the two physical slides.
11154 \begin_layout Standard
11155 The major problem in overlaying two slides is aligning the contents of the
11156 two transparencies.
11157 How much space should you leave for that graph on the second slide? Worse
11158 still, what if you want a graph and a sentence on second slide, but there
11159 is text on the main transparency that goes in between them? You could try
11160 and insert vertical space of the right size.
11161 The better way is to use
11172 \begin_layout Standard
11173 As their names imply,
11181 are two command-like paragraph environments that make all subsequent text
11182 invisible and visible, respectively.
11183 Note from section\InsetSpace ~
11185 \begin_inset LatexCommand \ref{sec:slideQuirk}
11189 that you don't place anything
11193 these two environments, however.
11198 , it inserts a centered, sky-blue label into the page reading
11199 \begin_inset Quotes eld
11202 <Invisible Text Follows>
11203 \begin_inset Quotes erd
11207 For paragraphs following this label, the parts of the
11215 ; it doesn't matter which] where they would be contain instead blank space.
11219 \begin_layout Standard
11224 , the corresponding centered label is
11225 \begin_inset Quotes eld
11228 <Visible Text Follows>
11229 \begin_inset Quotes erd
11233 Paragraphs following this label behave normally.
11234 Note that the beginning of a new
11246 automatically shuts off an
11251 It's therefore not necessary to use
11262 \begin_layout Standard
11263 By now, it should be obvious how to create overlay transparencies using
11264 the proper combination of
11283 \begin_layout Enumerate
11288 , including everything that will appear on it, whether on the main slide
11296 \begin_layout Enumerate
11297 Before each figure or paragraph that will appear only on the
11306 If necessary, insert a
11310 environment after the
11317 \begin_layout Enumerate
11322 immediately following the
11329 \begin_layout Enumerate
11330 Copy the contents of this
11341 \begin_layout Enumerate
11346 , change all of the
11357 \begin_layout Standard
11359 You've just made an
11366 \begin_layout Standard
11367 There's one problem with the way I've designed the LyX
11371 class: you can't make text in the middle of a paragraph invisible, nor
11372 make text in the middle of an invisible paragraph visible again.
11373 To accomplish this feat, you'll need to use some inlined LaTeX codes.
11377 \begin_layout Standard
11378 The commands of interest are:
11381 \begin_layout Itemize
11386 invisible \SpecialChar \ldots{}
11390 \begin_layout Itemize
11395 visible \SpecialChar \ldots{}
11399 \begin_layout Standard
11400 \SpecialChar \ldots{}
11401 and need to be marked as TeX.
11403 \begin_inset Quotes eld
11407 \begin_inset Quotes erd
11410 you wish to change goes in between the brackets [and after the
11423 If you don't know how to mark text as TeX, see the apprpriate section of
11436 \begin_layout Subsubsection
11446 \begin_inset LatexCommand \label{sec:slideNote}
11453 \begin_layout Standard
11462 is associated with a
11463 \begin_inset Quotes eld
11467 \begin_inset Quotes erd
11479 class provides visual cues.
11484 is shorter than that of a
11488 [yet longer than that of an
11492 ] and, like the label of an
11496 is shockingly magenta.
11497 Additionally, the printed
11501 has the page number of its
11502 \begin_inset Quotes eld
11506 \begin_inset Quotes erd
11514 \begin_inset Quotes eld
11522 \begin_inset Quotes erd
11526 \begin_inset Quotes eld
11534 \begin_inset Quotes erd
11538 \begin_inset Quotes eld
11546 \begin_inset Quotes erd
11550 You can have multiple
11554 s associated with a single
11566 , you'll probably want to break up long
11570 s so that they fit on a single sheet of paper.
11573 \begin_layout Standard
11578 is obvious: it contains anything additional you might want to say about
11584 It could also be used as a sheet of reminders for a particular
11589 In the case of the latter, you might want to make use of time markers.
11595 \begin_inset Quotes eld
11599 \begin_inset Quotes erd
11602 support for time markers, a
11607 So, you'll have to resort to using the LaTeX codes.
11610 \begin_layout Standard
11611 To use time markers, you'll need to specify the extra class option
11612 \begin_inset Quotes eld
11620 \begin_inset Quotes erd
11623 [see section\InsetSpace ~
11625 \begin_inset LatexCommand \ref{sec:slidesetup}
11630 This option turns on timing marks, which will appear in the lower-left-hand
11636 To set what appears in the time marker, you use the LaTeX commands
11637 \begin_inset Quotes eld
11647 \begin_inset Quotes erd
11651 \begin_inset Quotes eld
11661 \begin_inset Quotes erd
11665 The arguments of both commands are time measured in seconds.
11667 \begin_inset Quotes eld
11677 \begin_inset Quotes erd
11680 sets the time marker to a given time.
11682 \begin_inset Quotes eld
11692 \begin_inset Quotes erd
11695 increments the time marker by the specified amount.
11696 Using time markers and
11700 s in this fashion, you can remind yourself how much time to spend on a particula
11708 \begin_layout Standard
11709 There's one last feature to describe.
11710 Clearly, you'd like to print out all of your
11718 s on transparencies while printing all of your
11735 with which it is associated.
11736 What's a person to do?
11739 \begin_layout Standard
11740 Luckily, there are two LaTeX commands that allow you to select what to print
11742 Both must be placed into the preamble of your document.
11744 \begin_inset Quotes eld
11756 \begin_inset Quotes erd
11759 will cause the output to contain only the
11768 Correspondingly, the command
11769 \begin_inset Quotes eld
11781 \begin_inset Quotes erd
11784 prevents the output of anything but
11789 I'd advise placing both commands in the preamble and initially comment
11791 You can then preview your entire presentation as you write.
11792 When you're done writing, you can then uncomment one of the two to select
11793 what you want to print.
11794 I like to uncomment
11795 \begin_inset Quotes eld
11807 \begin_inset Quotes erd
11810 , print to a file with
11811 \begin_inset Quotes eld
11819 \begin_inset Quotes erd
11822 in its name, comment it back out, then uncomment
11823 \begin_inset Quotes eld
11835 \begin_inset Quotes erd
11839 \begin_inset Quotes eld
11847 \begin_inset Quotes erd
11851 I can then send either file to a printer, loading transparencies or plain
11852 paper as appropriate.
11855 \begin_layout Standard
11856 You can also provide other arguments to the
11857 \begin_inset Quotes eld
11867 \begin_inset Quotes erd
11871 \begin_inset Quotes eld
11881 \begin_inset Quotes erd
11885 See a good LaTeX book for details.
11888 \begin_layout Subsection
11893 Class Template File
11896 \begin_layout Standard
11897 I have also provided a template file,
11898 \begin_inset Quotes eld
11906 \begin_inset Quotes erd
11914 To use it, begin your new presentation with
11919 ile\SpecialChar \menuseparator
11929 Your new LyX presentation file will contain an example
11950 additionally contain an example of the use of
11959 Lastly, the preamble will contain:
11962 \begin_layout LyX-Code
11963 % Uncomment to print out only slides and overlays
11966 \begin_layout LyX-Code
11970 \begin_layout LyX-Code
11980 \begin_layout LyX-Code
11981 % Uncomment to print out only notes
11984 \begin_layout LyX-Code
11988 \begin_layout LyX-Code
11996 \begin_layout Standard
11997 One final thing: I created this class to support the LaTeX2e
11998 \begin_inset Quotes eld
12006 \begin_inset Quotes erd
12009 class, one of the built-in LaTeX2e classes.
12010 Neither I nor the rest of the LyX Team endorse or oppose the use of this
12011 built-in slide class.
12012 It's here if you want it or need it.
12013 There exist other LaTeX2e classes for creating presentations, such as the
12018 class [see section\InsetSpace ~
12020 \begin_inset LatexCommand \ref{sec:foiltex}
12025 \begin_inset Quotes eld
12033 \begin_inset Quotes erd
12036 package [present on some TeX distributions].
12037 The latter is not yet supported under LyX.
12041 \begin_layout Standard
12042 Perhaps you can take on the task\SpecialChar \ldots{}
12048 I know nothing about these other classes.
12049 Try them out to see what sort of alternative they provide.
12052 \begin_layout Section
12061 \begin_inset LatexCommand \label{sec:foiltex}
12068 \begin_layout Standard
12074 \begin_layout Subsection
12078 \begin_layout Standard
12079 This section describes how to use LyX to make slides for overhead projectors.
12080 There are two document classes that can do this: the default slides class
12086 This section documents the latter.
12089 \begin_layout Standard
12090 I'm going to say this again, nice and clear, so that there's no misunderstanding
12094 \begin_layout Standard
12095 \begin_inset VSpace bigskip
12101 \begin_layout Standard
12105 This section documents the class
12106 \begin_inset Quotes eld
12114 \begin_inset Quotes erd
12122 \begin_layout Standard
12123 \begin_inset VSpace bigskip
12129 \begin_layout Standard
12130 If you're looking for the documentation for
12131 \begin_inset Quotes eld
12139 \begin_inset Quotes erd
12142 , check out section\InsetSpace ~
12144 \begin_inset LatexCommand \ref{sec:slitex}
12149 If your machine doesn't have the
12154 \begin_inset Quotes eld
12162 \begin_inset Quotes erd
12165 ] installed, you'll probably have to use the default
12169 class, which isn't quite as good as
12174 \begin_layout Standard
12179 class is designed for use with version 2.1 of the
12183 LaTeX class file which is now an integral part of LaTeX2e.
12186 \begin_layout Subsection
12190 \begin_layout Standard
12191 Obviously, to use this document class, you need to select
12192 \begin_inset Quotes eld
12200 \begin_inset Quotes erd
12212 Document\InsetSpace ~
12216 There are some settings in the
12218 Document\InsetSpace ~
12221 dialog that you should know about that are specific to this class:
12224 \begin_layout Itemize
12225 Don't change the options
12235 Document\InsetSpace ~
12239 They're ignored by the
12246 \begin_layout Itemize
12247 The default font size is 20pt with the other options being 17pt, 25pt and
12251 \begin_layout Itemize
12252 The default font is
12260 but all math equations are still typeset in the usual roman font.
12263 \begin_layout Itemize
12268 TeX supports A4 and Letter paper sizes as well as a special size for working
12270 It doesn't support A5, B5, legal or executive paper sizes.
12273 \begin_layout Itemize
12274 Don't bother changing the
12278 settings because they are ignored anyway.
12279 All floats appear where they are defined in the text.
12282 \begin_layout Itemize
12290 setting behaves a bit differently for this class.
12295 TeX provides extensive footer and header capabilities including a user-defined
12297 See section\InsetSpace ~
12299 \begin_inset LatexCommand \ref{sec:foilfoot}
12304 The title page is treated differently to all other pages in the document
12313 has the logo centered at the bottom of the page (if one is defined).
12314 The possible page style choices and what they do are as follows:
12319 \labelwidthstring MMMMMMM
12326 The final output contains no page numbers, or other headers or footers
12327 (except footnotes of course).
12332 \labelwidthstring MMMMMMM
12339 The final output contains page numbers centered at the bottom of the page.
12340 No other headings or footers (other than footnotes).
12344 \labelwidthstring MMMMMMM
12349 Page numbers in lower right corner.
12350 Additional headers and footers are also shown.
12351 This is also the default.
12355 \labelwidthstring MMMMMMM
12360 Gives you access to the
12364 package although its use with
12368 TeX is discouraged by the writer of the
12372 TeX package because of some potential page layout clashes.
12376 \begin_layout Subsubsection
12380 \begin_layout Standard
12381 The following options may be used in the extra class options in the
12386 ocument\SpecialChar \menuseparator
12397 \labelwidthstring MMMMMMx
12402 This sets up the page layout for 7.33in by 11in paper, which is about the
12403 same aspect ratio as a 35mm slide, making it a bit easier to work with
12408 \labelwidthstring MMMMMMx
12413 Places a rule across the page below the header on every page except the
12418 \labelwidthstring MMMMMMx
12423 Places a rule across the page above the footer on every page except the
12428 \labelwidthstring MMMMMMx
12433 This is automatically set each time you create a new
12442 TeX to use the dvips driver to rotate those pages that are set as landscape
12447 \labelwidthstring MMMMMMx
12452 Simply changes the page dimensions to those of a landscape page but doesn't
12454 Thus if you use this option you need to use an external program to rotate
12455 each page or feed your paper through your printer as landscape.
12456 Note that this option effectively reverses the roles of the
12464 environments (don't worry these are described in the next section).
12468 \labelwidthstring MMMMMMx
12473 Equation numbers on the left.
12477 \labelwidthstring MMMMMMx
12482 Flush-left equations.
12485 \begin_layout Subsection
12486 Supported Environments
12489 \begin_layout Standard
12490 Most of the environments commonly supported in other classes are also supported
12496 There are several additional environments provided by
12500 TeX as well as a couple added by LyX.
12501 The following environments are shared with other classes:
12504 \begin_layout Standard
12508 \begin_layout Standard
12511 begin{multicols}{2}
12519 \begin_layout Itemize
12525 \begin_layout Itemize
12531 \begin_layout Itemize
12537 \begin_layout Itemize
12543 \begin_layout Itemize
12549 \begin_layout Itemize
12555 \begin_layout Itemize
12561 \begin_layout Itemize
12567 \begin_layout Itemize
12573 \begin_layout Itemize
12579 \begin_layout Itemize
12585 \begin_layout Itemize
12591 \begin_layout Itemize
12597 \begin_layout Itemize
12603 \begin_layout Itemize
12609 \begin_layout Itemize
12615 \begin_layout Itemize
12621 \begin_layout Itemize
12627 \begin_layout Standard
12631 \begin_layout Standard
12642 \begin_layout Standard
12643 That is, all the major environments apart from the sectioning environments.
12644 Since foils are essentially self-contained sections, with a title and body,
12649 TeX provides specific commands for starting new foils and these are:
12652 \begin_layout Itemize
12658 \begin_layout Itemize
12664 \begin_layout Standard
12665 LyX also provides slightly modified versions of these two environments called:
12668 \begin_layout Itemize
12674 \begin_layout Itemize
12677 ShortRotatefoilhead
12680 \begin_layout Standard
12681 and the differences will be explained in the next section.
12684 \begin_layout Standard
12685 Since foils are often used in presenting ideas or new theorems and such
12690 TeX also provides a comprehensive box of goodies for presenting them:
12693 \begin_layout Standard
12697 \begin_layout Standard
12700 begin{multicols}{2}
12708 \begin_layout Itemize
12714 \begin_layout Itemize
12720 \begin_layout Itemize
12726 \begin_layout Itemize
12732 \begin_layout Itemize
12738 \begin_layout Itemize
12744 \begin_layout Itemize
12750 \begin_layout Itemize
12756 \begin_layout Itemize
12762 \begin_layout Itemize
12768 \begin_layout Itemize
12774 \begin_layout Standard
12778 \begin_layout Standard
12789 \begin_layout Standard
12790 The starred versions are unnumbered while the unstarred versions are numbered.
12791 There are also two list environments added by LyX and these are:
12794 \begin_layout Itemize
12800 \begin_layout Itemize
12806 \begin_layout Standard
12811 TeX provides some powerful header and footer capabilities that are best
12812 set in the preamble although they may be set at any point in a document.
12813 If you want to change these settings in your document the best place to
12814 do so is at the very top of a foil,
12819 straight after the foilhead.
12822 \begin_layout Standard
12823 For this purpose, the following command styles are provided [
12830 \begin_layout Standard
12834 \begin_layout Standard
12837 begin{multicols}{2}
12845 \begin_layout Itemize
12852 \begin_layout Itemize
12858 \begin_layout Itemize
12865 \begin_layout Itemize
12872 \begin_layout Itemize
12880 \begin_layout Standard
12886 \begin_layout Standard
12890 \begin_layout Standard
12901 \begin_layout Standard
12902 There are also a few commands provided by
12906 TeX that aren't directly supported by LyX but I'll tell you what they do
12907 and how to use them in section\InsetSpace ~
12909 \begin_inset LatexCommand \ref{sec:unsuppfoils}
12916 \begin_layout Subsection
12917 Building a Set of Foils
12920 \begin_layout Standard
12921 This section will give a simple introduction to using the different environments
12922 to build a set of foils.
12923 If you want to see an example set of foils take a look at the
12927 file accessible from the
12932 ile\SpecialChar \menuseparator
12937 pen\SpecialChar \ldots{}
12948 \begin_layout Subsubsection
12949 Give It a Title Page
12952 \begin_layout Standard
12953 Unlike other classes that provide
12973 creates the title on a page of its own.
12974 If you leave out the
12978 environment LaTeX will substitute the current date (every time you regenerate
12982 \begin_layout Subsubsection
12986 \begin_layout Standard
12987 As I mentioned earlier, there are four ways of starting a new foil.
12988 For portrait foils you should use
12997 The difference between these two environments is the amount of space between
12998 the title of the foil (the foilhead) and the body of the foil.
13001 \begin_layout Standard
13002 Landscape foils are generated using the
13008 ShortRotatefoilhead
13011 Again the only difference is the spacing between foilhead and body.
13012 Both of the short versions have 0.5 inches less separation between the foilhead
13017 \begin_layout Standard
13018 One problem with the support for landscape foils is the requirement that
13019 you have to use the
13023 driver to generate the PostScript® output otherwise the foils won't be
13025 It is possible to get landscape foils even if you haven't got the
13029 driver provided you can feed your foils sideways through your printer ;-)
13032 \begin_layout Subsubsection
13033 Theorems, Lemmas, Proofs and more
13036 \begin_layout Standard
13037 Due to a small bug in LyX you can't have two of the same type of these environme
13038 nts directly following each other.
13039 They must be separated by something.
13040 If you try, you will just be extending the previous environment as if you
13041 had merged the two environments together.
13042 So, how do you get around this problem? The simplest option is to insert
13043 some text between the two environments or add a
13047 environment between the two with just a
13048 \begin_inset Quotes eld
13056 \begin_inset Quotes erd
13060 This will force LyX to produce two separate environments and hence the
13061 correct LaTeX output.
13062 An example is provided in the example file included with the LyX distribution.
13063 Remember, this problem only occurs if you are trying to place two of the
13064 same type of theorem-like environments one directly after the other.
13067 \begin_layout Subsubsection
13071 \begin_layout Standard
13072 You get all the commonly supported list styles found in other classes as
13073 well as two new ones.
13074 I'll only describe the new ones here.
13075 If you want to find out more about the other list environments check out
13081 If you intend to use itemized lists you might also want to read about the
13084 Itemize\InsetSpace ~
13085 Bullet\InsetSpace ~
13088 dialog described above in section\InsetSpace ~
13090 \begin_inset LatexCommand \ref{sec:bullet}
13097 \begin_layout Standard
13098 The two new list styles,
13106 , are designed to make it easier for you to create lists of do's and don'ts
13107 or right and wrong by providing dedicated environments that use a tick
13108 or a cross as the label of the list.
13109 These lists are in fact dedicated variants of the
13114 They do however require that you have the
13118 packages installed.
13121 \begin_layout Subsubsection
13125 \begin_layout Standard
13130 TeX redefines the floating tables and figures so that they appear exactly
13131 where they are in the text rather than pushing them to the top of the page
13132 or to some user specified location.
13133 In fact if you change the float placement settings they are simply ignored.
13136 \begin_layout Subsubsection
13137 Page Headers and Footers
13138 \begin_inset LatexCommand \label{sec:foilfoot}
13145 \begin_layout Standard
13155 are two commands used to control the left-footer text string.
13156 The first is meant to allow you to include a graphic logo on your foils
13158 \begin_inset Quotes eld
13166 \begin_inset Quotes erd
13170 While the second is meant to provide a classification for the audience,
13177 It is empty by default.
13180 \begin_layout Standard
13181 The remaining page corners can be filled by
13186 (which defaults to page numbers),
13199 \begin_layout Subsection
13205 \begin_inset LatexCommand \label{sec:unsuppfoils}
13212 \begin_layout Standard
13213 All the commands mentioned below need to be set in a
13221 within another environment.
13224 \begin_layout Subsubsection
13228 \begin_layout Standard
13229 All lengths are adjusted using the
13252 should be replaced by the name given to the length you want to change and
13257 is the length value.
13258 All lengths should be specified in units of length such as inches (
13270 ) or relative to some document or font-based length such as
13280 \begin_layout Standard
13281 It's possible to change the spacing between a foilhead and the body of the
13282 foil by adjusting the length specified by
13289 For example, to make
13293 foilheads 0.5 inches closer to their bodies put the following in the preamble:
13300 foilheadskip}{-0.5in}
13303 \begin_layout Standard
13304 The spacings around floats can be adjusted by setting these lengths:
13308 \labelwidthstring MMMMMMMMMMM
13315 Separation between the text and the top of the float
13319 \labelwidthstring MMMMMMMMMMM
13326 Separation between the float and the caption
13330 \labelwidthstring MMMMMMMMMMM
13337 Separation between the caption and the following text
13341 \labelwidthstring MMMMMMMMMMM
13348 You can make the captions narrower than the surrounding text by adjusting
13350 Best done relative to
13359 \begin_layout Standard
13360 There are also several title page related lengths that you may find useful
13361 if you have a long title or several authors:
13365 \labelwidthstring MMMMMMMMMMM
13372 Separation from headers to
13378 \labelwidthstring MMMMMMMMMMM
13397 \labelwidthstring MMMMMMMMMMM
13412 \labelwidthstring MMMMMMMMMMM
13429 \labelwidthstring MMMMMMMMMMM
13445 \begin_layout Standard
13446 The last length related command affects all the list environments.
13457 a list environment then all the vertical spacing between the list items
13459 Note that this is a command not a length so it doesn't require
13465 like the stuff mentioned above.
13468 \begin_layout Subsubsection
13469 Headers and Footers
13472 \begin_layout Standard
13485 commands control whether the logo in the
13489 definition appear on a given page.
13496 in the preamble then none of the foils will have the logo on them.
13497 If you don't want the logo on a particular page place the
13503 directly after the foilhead of that page and the
13509 directly after the next foilhead.
13512 \begin_layout Standard
13513 If you decide to use the
13517 page style setting in the
13519 Document\InsetSpace ~
13522 dialog you should probably add
13532 to your preamble so headers and footers on landscape pages are correctly
13533 placed when rotated.
13534 This is due to some clashes between the page layouts provided by the
13545 \begin_layout Section
13546 Latex8 (IEEE Conference Papers)
13549 \begin_layout Standard
13555 \begin_layout Subsection
13559 \begin_layout Standard
13560 Since this class is specifically for writing submissions to IEEE sponsored
13561 conferences I strongly recommend that you get a copy of their Authors Kit.
13566 package and associated bibliography style file is included in the kit.
13567 The Authors Kit is usually sent out by email once your initial submission
13569 There is a lot of useful information in the Authors Kit explaining formatting
13570 restrictions and so on and I will assume you have read this since that
13571 means I don't have to repeat it all here.
13574 \begin_layout Subsection
13578 \begin_layout Standard
13579 [AR\SpecialChar \@.
13583 \begin_layout Subsection
13584 Supported Environments
13587 \begin_layout Itemize
13593 \begin_layout Itemize
13599 \begin_layout Itemize
13605 \begin_layout Itemize
13611 \begin_layout Itemize
13617 \begin_layout Itemize
13623 \begin_layout Itemize
13629 \begin_layout Itemize
13635 \begin_layout Itemize
13641 \begin_layout Subsection
13642 Differences Between Screen and Paper
13645 \begin_layout Standard
13646 There are slight differences in appearance mainly with the presentation
13647 of section counters.
13648 On screen the trailing period of the section counter is missing but it
13649 will appear in the output so don't let this worry you.
13652 \begin_layout Section
13653 Hollywood (Hollywood spec scripts)
13656 \begin_layout Standard
13662 \begin_layout Subsection
13666 \begin_layout Standard
13667 Getting the format of a Hollywood script right is a
13668 \begin_inset Quotes eld
13672 \begin_inset Quotes erd
13675 It is designed to make the readers focus on content and to be easy and
13676 familiar for the actors to read.
13677 Each page of a script should be one minute of film.
13678 Nothing goes in a script that you cannot see or hear on screen.
13679 The courier 12 pt font should be used throughout.
13683 \begin_layout Subsection
13687 \begin_layout Standard
13688 Speakers' lines should NEVER break in mid-sentence.
13689 If a speaker's lines continue over a page break, repeat the
13693 title followed by (Cont'd).
13696 \begin_layout Subsection
13700 \begin_layout Standard
13705 names as labels then cross-reference the label to insert the name.
13706 The cross-reference dialog will show the current cast of characters.
13707 You can use this to insert the speaker name in narratives also.
13710 \begin_layout Subsection
13711 Paper size and Margins
13714 \begin_layout Standard
13715 USLetter, left 1.6in, right 0.75in, top 0.5in, bottom 0.75in
13718 \begin_layout Subsection
13722 \begin_layout Standard
13723 The following environments are available.
13724 You can use hollywood.bind to get the bind keys shown at the right.
13727 \begin_layout Itemize
13734 Used where nothing else works.
13738 \begin_layout Itemize
13751 Usually followed by something like
13752 \begin_inset Quotes eld
13755 on Sally waking up.
13756 \begin_inset Quotes erd
13762 \begin_layout Itemize
13771 Introduces a new INTERIOR camera set-up.
13772 Always followed by DAY or NIGHT, or something similar to define the lighting
13774 Everthing on this line in CAPS.
13777 \begin_layout Itemize
13786 Introduces a new EXTERIOR camera set-up.
13787 Everthing on this line in CAPS.
13790 \begin_layout Itemize
13799 The character speaking.
13802 \begin_layout Itemize
13811 Instructions to the speaker.
13812 The () are automatically inserted, but only the ( will show in LyX.
13813 Both will be printed.
13816 \begin_layout Itemize
13832 \begin_layout Itemize
13841 Camera movement instruction.
13846 \begin_layout Itemize
13854 \begin_layout Itemize
13862 \begin_layout Itemize
13870 \begin_layout Itemize
13878 \begin_layout Subsection
13882 \begin_layout Itemize
13883 (O.S) --- off screen
13886 \begin_layout Itemize
13887 (V.0) --- voice over
13890 \begin_layout Itemize
13895 \begin_layout Itemize
13900 \begin_layout Itemize
13901 PAN --- camera movement
13904 \begin_layout Itemize
13905 INSERT --- cut to close-up of
13908 \begin_layout Section
13912 \begin_layout Standard
13918 \begin_layout Subsection
13922 \begin_layout Standard
13923 Broadway is for writing plays.
13924 The format is more decorative than Hollywood, and much less standardized.
13925 This format should be suitable for workshops.
13928 \begin_layout Subsection
13932 \begin_layout Standard
13933 The same as in Hollywood.
13936 \begin_layout Subsection
13940 \begin_layout Standard
13945 names as labels then cross-reference the label to insert the name.
13946 The cross-reference dialog will show the current cast of characters.
13949 \begin_layout Subsection
13950 Paper size and Margins
13953 \begin_layout Standard
13954 USLetter, left 1.6in, right 0.75in, top 0.5in, bottom 0.75in
13957 \begin_layout Subsection
13961 \begin_layout Standard
13962 The following environments are available.
13963 You can use broadway.bind to get the bind keys shown at the right.
13966 \begin_layout Itemize
13973 You should not have to use this, but it is here for anything that does not
13977 \begin_layout Itemize
13986 Used to describe stage setting and the action.
13987 First use of speaker names in all CAPs.
13990 \begin_layout Itemize
13999 Automatically numbered.
14000 On screen it will be arabic, but will print as Roman.
14003 \begin_layout Itemize
14017 It is just centered text.
14020 \begin_layout Itemize
14029 Not automatically numbered.
14030 You supply the number.
14031 This is because I couldn't figure out how.
14034 \begin_layout Itemize
14043 A special case of Narrative to describe the setting and action as the curtain
14047 \begin_layout Itemize
14056 The speaker's (actor's) title, centered in all CAPS.
14059 \begin_layout Itemize
14068 Instructions to the speaker.
14069 The parentheses are automatically inserted.
14070 The ( will appear on screen, but both will be in the printed play.
14071 This environment is only used within
14078 \begin_layout Itemize
14087 What the Speaker says.
14090 \begin_layout Itemize
14099 The curtain comes down.
14102 \begin_layout Itemize
14110 \begin_layout Itemize
14118 \begin_layout Itemize
14126 \begin_layout Standard
14130 \begin_layout Section
14134 \begin_layout Standard
14140 \begin_layout Standard
14141 \begin_inset VSpace bigskip
14147 \begin_layout Standard
14151 Revtex\InsetSpace ~
14154 textclass works with the American Physical Sociey's RevTeX 4.0 (the
14155 \begin_inset Formula $\beta$
14158 release of May, 1999) class.
14161 \begin_layout Standard
14166 textclass, which works with RevTeX 3.1.
14167 However, v3.1 is basically obsolete, as it works with LaTeX 2.09.
14168 That means that it doesn't interact very well with LyX, which requires
14169 LaTeX2e, although it has been kludged to work.
14170 Since RevTeX 4.0 has been designed to work much more cleanly with LaTeX2e,
14173 RevTeX\InsetSpace ~
14176 textclass should also be pretty easy to use.
14179 \begin_layout Standard
14180 These documents are supposed to be used in
14184 to the RevTeX 4.0 documents, so we don't describe any of the special RevTeX
14185 macros, and assume you'll know what to put in the preamble if necessary.
14188 \begin_layout Subsection
14192 \begin_layout Standard
14193 All you need to do is install RevTeX 4, as described in the package's README
14195 the package can be found at
14196 \begin_inset LatexCommand \url[The RevTeX 4 Web Site]{http://publish.aps.org/revtex4/}
14201 Install it somewhere that LaTeX can see it.
14202 Test it by trying to LaTeX a short RevTeX 4 document in some random directory
14203 (i.e., not the directory where you installed the class file.) Then, if you
14204 reconfigure LyX, it will find the class file and let you use the RevTeX4
14208 \begin_layout Standard
14209 Probably the easiest way to get started is either to import a RevTeX 4 document
14216 Revtex\InsetSpace ~
14219 template, found in the templates directory.
14222 \begin_layout Subsection
14226 \begin_layout Standard
14227 Optional arguments to
14234 \begin_inset Quotes eld
14238 \begin_inset Quotes erd
14242 \begin_inset Quotes eld
14246 \begin_inset Quotes erd
14260 Document\InsetSpace ~
14264 Remember that in RevTeX, at least one optional argument is required!
14267 \begin_layout Standard
14268 Other preamble matter, like
14280 dialog, also as usual.
14283 \begin_layout Subsection
14287 \begin_layout Standard
14288 The layouts basically correspond to the commands in RevTeX4.0.
14289 For example, the Email layout corresponds to
14296 Note that (at least as of RevTeX 4.0 Beta), the
14304 layouts are exactly equivalent, so you shouldn't need to use both.
14308 \begin_layout Standard
14309 In case you're curious, both were included so that
14313 would be able to translate both
14333 \begin_layout Subsection
14337 \begin_layout Standard
14338 There are a couple of important unique aspects of RevTeX 4 which might cause
14339 bugs that will be even more confusing in LyX.
14342 \begin_layout Standard
14360 The LyX equivalent is that there is a separate Thanks layout.
14365 write footnotes in the
14369 layout, or weird things may happen.
14370 See the RevTeX 4 documentation for more details.
14373 \begin_layout Standard
14376 Author\InsetSpace ~
14381 Author\InsetSpace ~
14388 layouts must be placed
14396 layout and the corresponding
14413 , the LaTeX won't compile.
14416 \begin_layout Subsection
14420 \begin_layout Standard
14421 The main problem with this layout is that you can't use the optional arguments
14422 to layouts like Email and Title.
14423 (The problem is not unique to this layout; you can't use optional arguments
14424 to the Section layouts either.) This means that after you export that file
14425 to LaTeX (which you'll need to do eventually to send it in to APS), you'll
14426 need to edit the LaTeX file with a text editor to add the optional arguments
14427 to set, e.g., the running title for the page headers.
14428 Lacking these layouts makes the
14434 (and the equivalent
14440 ) useless, so the corresponding layouts don't exist, and will have to be
14445 \begin_layout Standard
14450 actually, LyX 1.3.0 supports some forms of optional arguments, but this layout
14451 has not been updated yet to take advantage of it.
14459 \begin_layout Section
14460 Article (mwart), book (mwbk) and report (mwrep)
14461 \begin_inset OptArg
14464 \begin_layout Standard
14477 \begin_layout Standard
14483 \begin_layout Standard
14484 The LyX document classes
14500 correspond to the LaTeX document classes
14513 They are replacements for the standard document classes
14525 , resp., and fit better to Polish typography conventions in a number of points.
14529 \begin_layout Standard
14533 \begin_layout Itemize
14534 Unnumbered titles (with star, eg.
14539 ) are added into table of contents,
14542 \begin_layout Itemize
14543 Additional page styles:
14547 \begin_layout Description
14548 uheadings header with separated lines,
14551 \begin_layout Description
14552 myheadings custom header, contents headers via commands:
14567 \begin_layout Description
14568 myuheadings custom header with separated lines,
14571 \begin_layout Description
14572 outer page number is placed on outer side of page
14576 \begin_layout Itemize
14581 \begin_layout Description
14582 rmheadings serif titles --- default,
14585 \begin_layout Description
14586 sfheadings sansserif titles,
14589 \begin_layout Description
14590 authortitle on title page first placed is author next title --- default,
14593 \begin_layout Description
14594 titleauthor on title page first placed is title next author,
14597 \begin_layout Description
14598 withmarginpar reserve place on page for margins.
14602 \begin_layout Section
14606 \begin_layout Standard
14612 \begin_layout Standard
14613 Elsevier Science Publishers B.V.
14614 provides a standard LaTeX document class (
14618 ) for submitting articles to their various journals.
14619 The style file can be downloaded directly from their web site:
14620 \begin_inset LatexCommand \url{http://authors.elsevier.com/}
14625 Instructions are supplied along with the class file, which details the
14626 requirements of the publishers.
14627 LyX includes package that allows for the use of this class, by a layout
14628 and a template file.
14629 Installation of the class file is the same as for any other LaTeX package;
14630 instructions are provided in the Elsevier documentation.
14633 \begin_layout Standard
14643 As the Elsevier class file is based mainly on the standard article class,
14644 most of the normal functionality is provided.
14645 The Elsevier class defines a number of mathematical environments, which
14646 are similar to the AMS environments.
14647 These commands are all described in the Elsevier documentation, and are
14651 \begin_layout Standard
14652 The easiest way to use the Elsevier style is to base documents on the included
14654 It is best not to use options such as fancy headings or the geometry package,
14655 as elements such as these are defined by Elsevier in their style file.
14656 Ideally, no extra packages except those mentioned in the Elsevier documentation
14658 Essentially, Elsevier require as
14659 \begin_inset Quotes eld
14663 \begin_inset Quotes erd
14670 \begin_layout Standard
14678 file as possible, as their intention is to take the supplied file and replace
14679 the class file with one for the particular journal to which the paper has
14681 This also means that not too much time should be spent on the formating
14683 When it comes to be published, this will change anyway.
14684 The rest of the usage for this layout is substantially the same as for
14685 the normal article class.
14686 For details of what Elsevier do and don't allow, refer to their documentation.
14689 \begin_layout Section
14693 \begin_layout Standard
14696 Jürgen Spitzmüller
14699 \begin_layout Subsection
14703 \begin_layout Standard
14704 Memoir is a very powerful and constantly evolving class.
14705 It has been designed with regard to fictional and non-fictional literature.
14706 Its aim is to let the user have maximum control over the typesetting of
14708 Memoir is based on the standard book class, but it can also emulate the
14709 article class (see below).
14712 \begin_layout Standard
14713 Peter Wilson, the developer of Memoir, is known as the author of lots of
14714 useful packages in the LaTeX world.
14715 Most of them have been merged with Memoir.
14716 Therefore, it is much easier to layout the table of contents, appendices,
14717 chapter designs and such.
14718 LyX, though, does not support all of these goodies natively.
14719 Some of them might be added to forthcoming releases
14723 \begin_layout Standard
14724 You are invited to send suggestions to
14725 \begin_inset LatexCommand \url{lyx-devel@lists.lyx.org}
14734 , lots will probably never, due to the limitations of LyX's framework.
14735 Of course you can still use all features with the help of some native LaTeX
14740 \begin_layout Standard
14745 \begin_layout Standard
14753 section\InsetSpace ~
14755 \begin_inset LatexCommand \ref{sec:Inserting-LaTeX-Code}
14765 In this section, we can only list those features which are natively supported
14767 For detailed descriptions (and for the rest of features) we are recommending
14768 to have a look at the detailed manual of the Memoir class
14772 \begin_layout Standard
14777 \begin_layout Standard
14786 \begin_inset LatexCommand \url{CTAN:/macros/latex/memoir/memman.pdf}
14795 , which is not only a user guide for the class, but also both a comprehensive
14796 description on good typesetting and a superb example for good typesetting
14800 \begin_layout Subsection
14801 Basic features and restrictions
14804 \begin_layout Standard
14805 Memoir supports basically all features of the standard book classes.
14806 There are, however, some differences, as follows:
14809 \begin_layout Description
14811 sizes: Memoir has a broader range of font sizes: 9, 10, 11, 12, 14,
14815 \begin_layout Description
14817 style: The fancy page style is not supported, due to a command clash
14818 between Memoir and the fancyhdr package (they are both defining a command
14819 with the same name, which confuses LaTeX).
14820 Instead, Memoir comes with a bunch of own page styles (see
14822 Layout\SpecialChar \menuseparator
14823 Document\SpecialChar \menuseparator
14828 If you want to use these for the chapter pages, you have to use the command
14835 in the main text or in preamble (e.
14839 \begin_layout Standard
14851 \begin_layout Standard
14863 chapterstyle{companion}
14868 \begin_layout Description
14869 Sectioning: Sectionings (chapter, section, subsection etc.) are coming with
14870 an optional argument in the standard classes.
14871 With this, you can specify an alternative version of the title for the
14872 table of contents and the headers (for instance, if the title is too long).
14873 In LyX, you can do this via
14875 Insert\SpecialChar \menuseparator
14879 at the beginning of a chapter/section.
14880 Memoir features a second optional argument and thus separates the table
14881 of contents from the header.
14882 You can define three variants of a title with this: one for the main text,
14883 one for the table of contents, and one for the headers.
14884 Simply insert two optional arguments if you need this feature, the first
14885 one containing the short title for the Table of Contents, the second one
14886 containing an alternative short title for the headers.
14889 \begin_layout Description
14890 TOC/LOT/LOF: In the standard classes (and in many other classes), the table
14891 of contents, the list of figures and the list of table start a new page
14893 Memoir does not follow this route.
14894 You have to insert a page break yourself, if you want to have one.
14897 \begin_layout Description
14898 Titlepage: For some unknown reason, Memoir uses pagination on the title
14899 page (in the standard classes, title pages are
14900 \begin_inset Quotes eld
14904 \begin_inset Quotes erd
14911 \begin_layout Standard
14923 \begin_layout Standard
14932 If you want an empty title page, type
14936 aliaspagestyle{title}{empty}
14941 \begin_layout Description
14942 Article: With the class option
14948 Layout\SpecialChar \menuseparator
14949 Document\SpecialChar \menuseparator
14953 ), you can emulate article style.
14954 That is, counters (footnotes, figures, tables etc.) will not be reset on
14955 new chapters, chapters don't start a new page (but are---in contrary to
14957 \begin_inset Quotes eld
14961 \begin_inset Quotes erd
14964 article classes---still allowed), parts, though, use their own page, as
14968 \begin_layout Description
14969 Oldfontcommands: By default, Memoir does not allow the use of the deprecated
14970 font commands, which have been used in the old LaTeX version 2.09 (e.
14974 \begin_layout Standard
14986 \begin_layout Standard
15007 It produces an error and stops LaTeX whenever such a command appears.
15012 reallows the commands and spits out warnings instead (which does at least
15014 Since a lot of packages and particularly BibTeX style files are still using
15015 those commands, we have decided to use this option by default.
15018 \begin_layout Subsection
15022 \begin_layout Standard
15023 We will only describe the features supported by LyX (which is not much currently
15025 Please consult the Memoir manual
15029 \begin_layout Standard
15034 \begin_layout Standard
15043 \begin_inset LatexCommand \url{CTAN:/macros/latex/memoir/memman.pdf}
15055 \begin_layout Description
15056 Abstract: You may wonder why an abstract is an extra feature.
15057 Well, it is in book class.
15058 Usually books don't have abstracts.
15059 Memoir, however, has.
15060 You can use it whereever and how often you like.
15063 \begin_layout Description
15064 Chapterprecis: You may know this from belletristic: The contents of a chapter
15065 is shortly described below the title and also in the table of contents
15070 \begin_layout Standard
15082 \begin_layout Standard
15092 Our hero arrives in Troia; he loses some friends; he finds others
15095 Chapterprecis does exactly this.
15096 It is therefore only sensible below a chapter.
15099 \begin_layout Description
15100 Epigraph: An epigraph is a smart slogan or motto at the beginning of a chapter.
15101 The epigraph environment provides an elegant way of typesetting such a
15103 The motto itself (text) and its author (source) are divided by a short
15105 Unfortunately, we have to fool LyX a bit here again, since the environment
15106 needs two arguments (text and source).
15107 In this case, we have to use curly brackets (in TeX mode) between the two
15118 <author of the slogan>.
15121 \begin_layout Description
15122 Poemtitle: Memoir has lots of possibilities to typeset poetry (up to very
15123 complex figurative poems).
15124 Lyx can only support a few of them.
15125 One is poemtitle, which is a centered title for poems, which will also
15126 be added to the table of contents (verse is the standard environment for
15128 Memoir has some enhanced versions of verse, but you need to use ERT, because
15129 they have to be nested inside regular verse environments, which is not
15130 possible with LyX).
15133 \begin_layout Description
15134 Poemtitle*: Same as poemtitle, but it adds no entry to the table of contents.
15137 \begin_layout Chapter
15138 Importing and Exporting Alternate File Formats
15139 \begin_inset OptArg
15142 \begin_layout Standard
15143 Importing and Exporting
15151 \begin_layout Section
15155 \begin_layout Standard
15156 Importing and exporting LyX documents from/to other formats has been touched
15162 Here we describe more of the gory details needed to understand just what
15163 is going on when you click on the
15168 ile\SpecialChar \menuseparator
15180 ile\SpecialChar \menuseparator
15191 \begin_layout Section
15192 Importing Other Formats
15195 \begin_layout Subsection
15199 \begin_layout Standard
15200 Translating from LaTeX into LyX is performed by a Perl script called reLyX.
15201 Although it is a standalone program which can be called from the command
15202 line, LyX will call it automatically when a LaTeX document is imported.
15203 See section\InsetSpace ~
15205 \begin_inset LatexCommand \ref{sec:reLyX}
15209 for a complete description.
15210 There are no user tunable parameters for reLyX within LyX.
15213 \begin_layout Subsection
15217 \begin_layout Standard
15218 When importing plain ASCII text, there are two methods of reading the file.
15220 \begin_inset Quotes eld
15224 \begin_inset Quotes erd
15227 preserves all the linebreaks in the ASCII; to LyX, then, each line looks
15230 \begin_inset Quotes eld
15234 \begin_inset Quotes erd
15237 assumes that consecutive lines separated by only a single linebreak form
15238 a single paragraph.
15239 Successive linebreaks with no intervening text are thus assumed to be paragraph
15243 \begin_layout Subsection
15247 \begin_layout Standard
15250 [Editor's note: Needs to be written, obviously - any volunteers? --- mer]
15253 \begin_layout Section
15254 Exporting Other Formats
15257 \begin_layout Subsection
15261 \begin_layout Standard
15262 LyX generates two types of LaTeX files: stripped down versions for the normal
15267 , etc.) which one normally never sees
15271 \begin_layout Standard
15272 The resulting file is a perfectly valid LaTeX file, though the preamble
15273 might look a bit strange since it includes some definitions used by LyX
15274 which wouldn't show up in most human-written files.
15279 , and human readable forms which are suitable for exchanging with your colleague
15281 The only settable option for the translation is the line length of the
15283 The default is 65 characters, but it can be set in
15290 \SpecialChar \menuseparator
15311 \begin_layout Subsection
15312 Device Independent Files
15315 \begin_layout Standard
15316 Device Independent files (DVI files) are produced by running LaTeX on your
15318 There are no user settable options.
15321 \begin_layout Subsection
15325 \begin_layout Standard
15326 The next step in the conversion chain is converting a DVI file into Postscript®.
15334 \SpecialChar \menuseparator
15342 \SpecialChar \menuseparator
15351 or, if you need more control on the result,
15358 \SpecialChar \menuseparator
15367 If you use the later, note that it is possible to configure, in
15374 \SpecialChar \menuseparator
15382 , the options passed to the dvips program to achieve different effects.
15385 \begin_layout Subsection
15389 \begin_layout Standard
15390 Exporting as ASCII attempts to preserve the
15391 \begin_inset Quotes eld
15395 \begin_inset Quotes erd
15398 of the document as well as possible, but things like centering and indentation
15399 are thrown out; paragraphs are separated by blank lines.
15400 Section numbering and cross-references are done correctly, so the resulting
15401 text files is remarkably readable.
15402 The only changeable option is the length of lines, as for LaTeX output.
15405 \begin_layout Subsection
15409 \begin_layout Standard
15410 LyX documents can be converted to hypertext markup, usually by converting
15411 to LaTeX first, then converting that to HTML\SpecialChar \@.
15413 \begin_inset Formula $\rightarrow$
15416 HTML converters are currently known to LyX:
15429 Though they are autodetected, you can overide the selection in preferences.
15430 You can also include further command line options in this dialog.
15434 \begin_layout Subsection
15438 \begin_layout Standard
15446 \begin_layout Standard
15447 \begin_inset VSpace bigskip
15453 \begin_layout Standard
15454 The fastest way to generate a basic PDF file (no tags, links, etc.) with
15455 any version of LyX is to save the document as a Postscript® file, then
15461 Starting with version 1.1.6, the menu item
15465 will do all this for you.
15466 There are some issues with fonts that you need to pay attention to: see
15467 Section\InsetSpace ~
15469 \begin_inset LatexCommand \ref{sec:badfonts}
15474 Also, as of version 1.1.6, there is a better method that will generate much
15475 more sophisticated files.
15478 \begin_layout Subsubsection
15482 \begin_layout Standard
15483 With pdfLaTeX you need to convert your eps figures to PDF (see Section\InsetSpace ~
15485 \begin_inset LatexCommand \ref{sec:pdfeps}
15489 ), and you cannot use pstricks.
15490 On the other hand, with pdfLaTeX it is possible to insert directly images
15491 in JPEG or PNG format, use TrueType fonts, and more.
15494 \begin_layout Subsubsection
15495 Why does the text look so bad when viewed with Acrobat Reader?
15496 \begin_inset LatexCommand \label{sec:badfonts}
15501 \begin_inset OptArg
15504 \begin_layout Standard
15505 Bad Fonts in Acrobat Reader
15513 \begin_layout Standard
15514 The problem is that bitmap fonts are displayed poorly by Acrobat Reader.
15515 When creating a PDF from the LyX file, you need to use outline font instead
15516 of the default bitmap fonts (in fact, you should also use outline fonts
15517 for Postscript files).
15518 Recent LaTeX distributions come with Postscript® Type 1 version of the
15519 standard (Computer Modern) fonts.
15520 pdfLaTeX uses these font by default.
15521 Dvips doesn't use these fonts by default, so to make it use them, add the
15522 following to lines to your
15529 \begin_layout LyX-Code
15533 \begin_layout LyX-Code
15537 \begin_layout Standard
15538 If the default LaTeX font encoding (OT1) is used, nothing else need to be
15540 However, if the T1 font encoding is used, then LaTeX uses the newer EC
15541 fonts, for which there are no Type1 version.
15542 The solution is to use the ae package which emulates T1 coded fonts using
15543 the standard CM fonts.
15544 This is done by adding
15548 usepackage{ae,aecompl}
15550 to the preamble of the LyX file.
15551 However, some glyphs are missing from the CM fonts (e.g.
15552 eth, thorn), and they are taken from the EC fonts.
15553 Therefore you get these glyphs as bitmaps.
15556 \begin_layout Standard
15557 Note: LyX uses by default the T1 font encoding.
15558 If you wish to use the default font encoding (this is not recommended,
15559 unless you only write English documents), clear the field
15567 in preferences (tabs
15579 \begin_layout Standard
15580 An alternate option is to use the standard Postscript® fonts instead of
15581 the Computer Modern fonts.
15582 To do that, you need to select
15586 as the global font in the document layout dialog.
15587 When using the Postscript® fonts, the result PDF file is smaller as the
15588 fonts are not saved into the file.
15589 Furthermore, the Postscript® fonts include all T1 glyphs.
15590 On the other hand, the Postscript® fonts have no bold symbol font, so poor
15591 man's bold must be used (see Section\InsetSpace ~
15593 \begin_inset LatexCommand \ref{sec:pdfbold}
15598 The Postscript® fonts also look different from the Computer Modern fonts.
15601 \begin_layout Standard
15602 To sum up, both the Computer Modern and the Postscript® fonts gives good
15603 results (with few exceptions).
15604 The decision of which one to use is a matter of taste.
15607 \begin_layout Subsubsection
15610 boldsymbol{} command work when I use pslatex?
15611 \begin_inset LatexCommand \label{sec:pdfbold}
15616 \begin_inset OptArg
15619 \begin_layout Standard
15636 \begin_layout Standard
15637 The Postscript® fonts do not have a bold symbol font.
15638 The solution is to use the
15644 (poor man's bold) command.
15647 \begin_layout Standard
15648 It is possible to redefine the
15663 \begin_layout LyX-Code
15673 \begin_layout Standard
15677 \begin_layout Subsubsection
15678 Is it possible to do write latex code which is processed only when running
15680 \begin_inset OptArg
15683 \begin_layout Standard
15684 Conditionals with pdfLaTeX
15692 \begin_layout Standard
15694 Here is an example:
15697 \begin_layout LyX-Code
15705 \begin_layout LyX-Code
15715 \begin_layout LyX-Code
15721 \begin_layout LyX-Code
15727 \begin_layout LyX-Code
15733 \begin_layout LyX-Code
15739 \begin_layout LyX-Code
15743 \begin_layout LyX-Code
15749 \begin_layout LyX-Code
15752 pdfinfo { /Author (your name and e-mail address)
15755 \begin_layout LyX-Code
15756 /Title (official title -- i.e., title element)
15759 \begin_layout LyX-Code
15760 /Subject (one line description of the document)
15763 \begin_layout LyX-Code
15767 \begin_layout LyX-Code
15770 pdfcatalog { /PageMode (/UseNone)
15773 \begin_layout LyX-Code
15774 % /OpenAction (fitbh)
15777 \begin_layout LyX-Code
15781 \begin_layout LyX-Code
15784 usepackage[pdftex]{hyperref}
15787 \begin_layout LyX-Code
15793 \begin_layout LyX-Code
15796 usepackage[ps2pdf]{hyperref}
15799 \begin_layout LyX-Code
15805 \begin_layout Subsubsection
15806 How can I make URLs clickable ?
15809 \begin_layout Standard
15810 See the references here :
15813 \begin_layout Standard
15814 \begin_inset LatexCommand \url{http://wiki.lyx.org/pmwiki.php/FAQ/PDF}
15821 \begin_layout Subsection
15825 \begin_layout Standard
15826 Custom exports are possible if you have some particularly weird format you
15827 wish to convert to, assuming you have the relevant converter, of course.
15832 file can be chosen in the
15837 ile\SpecialChar \menuseparator
15842 xport\SpecialChar \menuseparator
15849 dialog; LyX will automatically convert the file to this point, then feed
15850 it to your custom converter.
15851 The possible values are all formats that LyX can produce from its own documents.
15855 \begin_layout Standard
15856 The converter command is also specified in the dialog.It should be a completely
15857 qualified command line which uses the variable
15861 to specify the name of the file.
15862 If this variable is not given, then the file will be sent to the standard
15863 input of your command.
15864 You may have to apply a bit of ingenuity to escape this sequence correctly
15865 so that it is compatible with your shell.
15869 \begin_layout Standard
15870 While it is not possible to save this command using the
15874 dialog, you can manually edit your
15881 \begin_layout LyX-Code
15884 custom_export_command "mycommand $$FName"
15887 \begin_layout Section
15888 The Complete reLyX Description
15889 \begin_inset LatexCommand \label{sec:reLyX}
15896 \begin_layout Subsection
15900 \begin_layout Standard
15901 The simplest way to use reLyX is via the
15906 ile\SpecialChar \menuseparator
15914 That runs reLyX on the given file and loads the resulting file into LyX.
15915 You should try that first, and call it from the command line only if you
15916 need to use more complicated options.
15919 \begin_layout Standard
15971 \begin_layout Standard
16027 \begin_layout Standard
16037 \begin_layout Subsection
16041 \begin_layout Description
16047 By default, when reLyX sees a
16053 command, it creates a file of textclass
16054 \begin_inset Quotes eld
16058 \begin_inset Quotes erd
16061 and reads the LyX layout file for that class.
16066 to declare a different textclass (and read a different layout file).
16069 \begin_layout Description
16075 By default, reLyX gives sparse output and deletes the temporary files which
16076 were created during translation.
16081 flag will create much more output (both to stdout and stderr) and leave
16082 the temporary files around.
16085 \begin_layout Description
16091 reLyX will not run if the
16095 file it would generate already exists Use the
16099 option (carefully) to clobber any existing files.
16102 \begin_layout Description
16108 Print out usage information and quit
16111 \begin_layout Description
16117 With this option, all temporary files and LyX output files (for the given
16118 input file, for any included files, or for any file fragments given with
16123 option) will be put into
16128 Otherwise, for each file
16132 , the temporary files and the LyX output file will be created in
16137 This can be useful if a file includes files from other directories which
16138 you want to consolidate in one directory, or if you don't have write permission
16139 on the directory the LaTeX files are in.
16142 \begin_layout Description
16148 The input files are LaTeX fragments, with no preamble matter or
16155 This option requires the
16159 option, since there are no
16165 commands in the files reLyX is translating.
16166 When using this option, you can translate more than one file, as long as
16167 all files are the same class.
16168 The LyX file created by reLyX can be included in an existing LyX file using
16174 nsert\SpecialChar \menuseparator
16179 \SpecialChar \menuseparator
16190 \begin_layout Description
16195 Regular environments (see the Section\InsetSpace ~
16197 \begin_inset LatexCommand \ref{sub:relyx-syntax}
16202 If you give more than one environment, separate them with commas (not
16204 You'll probably need to quote the environment list, especially if it has
16205 asterisk environments (foo*) in it.
16206 If you use this command often, considering creating a personal syntax file.
16209 \begin_layout Description
16215 Input (one or more quoted, comma-separated) syntax files to read in addition
16217 (see the section Section\InsetSpace ~
16219 \begin_inset LatexCommand \ref{sub:relyx-syntax}
16226 \begin_layout Subsection
16230 \begin_layout Subsubsection
16234 \begin_layout Standard
16235 reLyX will create a LyX file
16239 from the LaTeX file
16250 \begin_layout Standard
16268 does not exist and does not have one of these suffixes, reLyX will try
16274 (This is similar to the behavior of LaTeX.)
16277 \begin_layout Standard
16278 The purpose of reLyX is to translate
16283 If your LaTeX file doesn't compile---or if you do weird things, like redefining
16284 standard LaTeX commands---it may choke.
16285 LaTeX209 will often be translated correctly, but it's not guaranteed.
16288 \begin_layout Standard
16289 reLyX has some bugs and lacks a few features.
16290 However, its main goals are:
16293 \begin_layout Itemize
16294 Get through a well-behaved LaTeX2e file without crashing
16297 \begin_layout Itemize
16298 Translate a lot of that file.
16301 \begin_layout Itemize
16302 Localize the parts that can't be translated and copy them in TeX mode
16305 \begin_layout Standard
16306 It achieves these main goals pretty well on most files.
16309 \begin_layout Standard
16310 There are many improvements that can and will be made to reLyX in the future.
16311 However, we wanted to get reLyX out there early on, to make it easier for
16312 new LyX users to read in their existing LaTeX files.
16315 \begin_layout Subsubsection
16319 \begin_layout Standard
16320 Here's a more lengthy description of what you should do to translate a LaTeX
16324 \begin_layout Itemize
16329 \begin_layout Standard
16330 reLyX will inform you of its progress and give any warnings to stderr, so
16331 if you don't want any output at all, try (in csh)
16332 \begin_inset Quotes eld
16337 reLyX foo.tex >& /dev/null
16340 \begin_inset Quotes erd
16344 \begin_inset Quotes eld
16356 \begin_inset Quotes erd
16360 You should NOT redirect standard output to
16369 \begin_layout Itemize
16370 Run LyX on the resulting .lyx file.
16374 \begin_layout Standard
16375 In theory, most of the file will have been translated, and anything that's
16376 untranslatable will be highlighted in red (TeX mode).
16377 In theory, LyX will be able to read in the file, and to create printed
16378 documents from it, because all that untranslated red stuff will be passed
16379 directly back to LaTeX, which LyX uses as a backend.
16380 Unfortunately, reality doesn't always reflect theory.
16381 If reLyX crashes, or LyX cannot read the generated LyX file, see Section\InsetSpace ~
16383 \begin_inset LatexCommand \ref{sub:relyx-bugs}
16395 \begin_layout Itemize
16396 Change things that are in ERT boxes (TeX code) by hand in LyX.
16400 \begin_layout Standard
16401 As mentioned above, you should be able to print out the LyX file even without
16403 However, changing a command in TeX mode to the corresponding LyX object
16404 will allow you to take advantage of LyX's WYSIWYM editing.
16407 \begin_layout Standard
16408 reLyX is not guaranteed to create a LyX file which generates exactly the
16409 same output as the LaTeX file, but it should come close.
16410 reLyX will generally err on the side of translating less to ensure that
16411 dvi or ps files are accurate, even though this leads to more
16412 \begin_inset Quotes eld
16416 \begin_inset Quotes erd
16423 \begin_layout Itemize
16424 PROOFREAD THE DOCUMENT!!
16428 \begin_layout Standard
16429 I'm sure you were planning on doing this anyway, but it's particularly important
16430 after translating a LaTeX document.
16431 reLyX is, at least now, better at
16432 \begin_inset Quotes eld
16436 \begin_inset Quotes erd
16439 (translating the whole document) than
16440 \begin_inset Quotes eld
16444 \begin_inset Quotes erd
16447 (translating every little detail).
16448 For example, you may see extra spaces or deleted spaces.
16449 Space handling has improved, but it's not perfect.
16453 \begin_layout Subsubsection
16454 What reLyX Can Handle
16457 \begin_layout Standard
16458 reLyX understands many LaTeX commands.
16462 \begin_layout Itemize
16463 regular text, including mini-commands like ~, '',
16475 , as well as accented characters like
16481 , and the special cases ?` and !`
16484 \begin_layout Itemize
16485 title commands like
16509 and the abstract environment
16512 \begin_layout Itemize
16513 heading commands like
16519 including starred commands (
16528 \begin_layout Itemize
16554 \begin_layout Itemize
16567 environments, and their
16574 Also, well-behaved nested lists
16577 \begin_layout Itemize
16578 cross-referencing commands:
16603 \begin_layout Itemize
16617 \begin_layout Itemize
16618 font-changing commands including
16636 , and corresponding commands to change family, size, series, and shape
16639 \begin_layout Itemize
16666 \begin_inset Quotes erd
16676 \begin_inset Quotes erd
16682 \begin_layout Itemize
16687 environment, and commands that go inside it like
16708 \begin_layout Itemize
16723 commands within them
16726 \begin_layout Itemize
16737 command, as well as BibTeX's
16752 \begin_layout Itemize
16753 miscellaneous commands:
16782 \begin_layout Itemize
16783 documentclass-specific environments (and some commands) which can be translated
16787 \begin_layout Itemize
16788 arguments to certain untranslatable commands (e.g.
16798 \begin_layout Standard
16799 Some of this support may not be 100% yet.
16800 See below for details
16803 \begin_layout Standard
16804 reLyX copies math (almost) verbatim from your LaTeX file.
16805 Luckily, LyX reads in LaTeX math, so (almost) any math which is supported
16806 by LyX should work just fine.
16807 A few math commands which are not supported by LyX will be replaced with
16808 their equivalents, e.g.,
16828 \begin_layout Standard
16829 reLyX will also copy any preamble commands (i.e., anything before
16835 ) verbatim, so fancy stuff you've got in your preamble should be conserved
16836 in dvi and printed documents, although it will not of course show up in
16838 Check the preamble to make sure.
16841 \begin_layout Subsubsection
16842 What reLyX Can't Handle --- But it's OK
16845 \begin_layout Itemize
16853 \begin_layout Itemize
16857 \begin_layout Itemize
16879 \begin_layout Itemize
16899 \begin_layout Itemize
16911 reLyX is careful to copy
16915 in this case, including comments and whitespace.
16918 \begin_layout Itemize
16919 some unknown (e.g., user-defined) environments and commands
16922 \begin_layout Standard
16923 reLyX copies unknown commands, along with their arguments, verbatim into
16931 where it doesn't recognize the
16932 \begin_inset Quotes eld
16936 \begin_inset Quotes erd
16939 environment, it will copy verbatim until it sees
16945 (unless you use the
16950 Hopefully, then, most of these unknown commands won't cause reLyX to break;
16951 they'll merely require you to do some editing once you've loaded the file
16953 That should be less painful than editing either the
16961 file using a text editor.
16964 \begin_layout Subsubsection
16965 What reLyX Handles Badly --- a.\InsetSpace ~
16969 \begin_inset LatexCommand \label{sub:relyx-bugs}
16976 \begin_layout Standard
16977 Since reLyX is relatively new, it's got a number of problems.
16978 As it matures, these bugs will be squished.
16979 A number of bugs and missing features can be found listed on the LyX bug
16981 \begin_inset LatexCommand \url[LyX Bugzilla]{http://bugzilla.lyx.org/}
16988 \begin_layout Standard
16989 If reLyX is choking on something, or LyX can't read it after reLyX translates
16990 it, the best thing to do is to put
16996 before the offending text, and
17004 \begin_inset Quotes eld
17008 \begin_inset Quotes erd
17012 reLyX will copy this block exactly, in TeX mode.
17013 Then edit the resulting LyX file, and translate the unknown stuff by hand.
17018 environment is magical; the
17030 commands will not be put into the LyX file.
17033 \begin_layout Itemize
17034 \begin_inset Quotes eld
17038 \begin_inset Quotes erd
17041 copying of unknown environments and commands isn't quite exact.
17042 Specifically, newlines and comments may be lost.
17043 This will yield ugly LyX, but in almost all cases the output will be the
17045 However, certain parts of the file will be copied perfectly, including
17046 whitespace and comments.
17047 This includes: the LaTeX preamble,
17057 commands, and skip blocks.
17060 \begin_layout Itemize
17061 reLyX translates only a few options to the
17068 (Specifically 1[012]pt, [letter|legal|executive|a4|a5|b5]paper, [one|two]side,
17069 landscape, and [one|two]column.) Other options are placed in the extra class
17070 options field in the
17075 ocument\SpecialChar \menuseparator
17086 \begin_layout Standard
17087 More importantly, reLyX doesn't translate
17093 commands, margin commands,
17099 s, or, in fact, anything else from the preamble.
17100 It simply copies them into the LaTeX preamble.
17101 If you have margin commands in your preamble, then the LyX file will generate
17103 However, these margins will override any margins you set in the LyX
17110 \SpecialChar \menuseparator
17116 So you should remove the options from the preamble to be safe.
17117 The same goes for setting your language with babel,
17133 \begin_layout Itemize
17134 The foil class has a couple bugs.
17135 reLyX may do weird things with optional arguments to
17142 Also, it may handle
17148 incorrectly (although the stuff in the environment should translate normally).
17151 \begin_layout Standard
17152 reLyX is hopefully rather robust.
17153 As mentioned above, it may not translate your file perfectly, but it shouldn't
17155 If it does crash---and the problem is not one of those mentioned above
17160 file---see Section\InsetSpace ~
17162 \begin_inset LatexCommand \ref{sub:relyx-bug-reports}
17169 \begin_layout Subsubsection
17170 What LyX Can't Handle
17173 \begin_layout Standard
17174 LyX itself is missing a couple features, such that even if reLyX translates
17175 things perfectly, LyX may still have trouble reading it.
17176 If you really need these features, you can export your final document as
17177 LaTeX, and put them back in.
17182 for more details on these bugs.
17185 \begin_layout Itemize
17186 For a number of commands, LyX does not support the optional argument.
17199 (and other sectioning commands), and
17208 reLyX will automatically discard the optional arguments with a warning
17210 LyX also ignores the width argument for the
17217 \begin_layout Itemize
17218 Centering (or right or left justifying) works on full paragraphs.
17221 \begin_layout Itemize
17222 LyX support for tables isn't perfect.
17223 For complicated tables, use a
17224 \begin_inset Quotes eld
17228 \begin_inset Quotes erd
17231 block, so that they will be copied in TeX mode.
17234 \begin_layout Itemize
17235 The LyX math editor can't handle the AMS-LaTeX math environments align,
17237 So those environments will be copied in TeX mode.
17242 environments to the exactly equivalent displaymath, and then they will
17243 be translated correctly.
17246 \begin_layout Subsection
17250 \begin_layout Standard
17254 \begin_inset Quotes eld
17258 \begin_inset Quotes erd
17262 \begin_inset Quotes eld
17266 \begin_inset Quotes erd
17269 foo.tex > foo.debug
17272 \begin_layout Standard
17273 The above will create a file my/dir/foo.lyx from foo.tex, overwriting if necessary.
17283 block, it will translate the stuff within the block, but copy the
17295 commands in TeX mode.
17296 Finally, I'm going to keep the temporary files around (they will also
17297 be in my/dir/) and output lots of debugging information into the file foo.debug.
17300 \begin_layout Subsection
17304 \begin_layout Subsubsection
17306 \begin_inset LatexCommand \label{sub:relyx-bug-reports}
17313 \begin_layout Standard
17314 If reLyX is crashing or otherwise acting strangely---in ways other than
17315 those described in Section\InsetSpace ~
17317 \begin_inset LatexCommand \ref{sub:relyx-bugs}
17321 or the bug tracker---then please run reLyX
17326 That will allow you to figure out where in the reLyXing process it crashed.
17327 That, in turn, will allow you to write a better bug report, which will
17328 allow the developers to fix it more quickly and easily.
17331 \begin_layout Standard
17332 Bug reports should be sent to the LyX developers' mailing list.
17333 Its address is currently
17335 lyx-devel@lists.lyx.org
17338 If you are running reLyX on a huge file, please do not send all of the
17339 output in your bug report.
17340 Just include the last ten or twenty lines of output, along with the piece
17341 of the LaTeX file it crashed on.
17342 Or, even better, attach a small but complete file which causes the same
17343 problem as your original file.
17346 \begin_layout Subsubsection
17347 Implementation Details:
17350 \begin_layout Standard
17351 reLyX makes several
17352 \begin_inset Quotes eld
17356 \begin_inset Quotes erd
17359 in order to translate a TeX file.
17360 On each pass, it creates one or two files.
17363 \begin_layout Description
17368 Before doing anything, read the syntax file (or files).
17371 \begin_layout Description
17376 Split preamble (anything before a
17382 command) off the rest of the file.
17383 It saves the two pieces in separate files.
17384 This is necessary because there may be very strange stuff in a preamble.
17385 It also ignores anything after the
17391 , on the assumption that it isn't LaTeX.
17394 \begin_layout Description
17399 Translate the preamble.
17400 Currently, that just means translating the
17406 command and copying the rest exactly into the LyX preamble.
17410 \begin_layout Standard
17411 Once you know what class the document is, read the LyX layout file for that
17416 \begin_layout Description
17422 \begin_inset Quotes eld
17426 \begin_inset Quotes erd
17429 the TeX file, generating slightly stricter LaTeX.
17434 \begin_layout Itemize
17439 to the equivalent but clearer
17444 \begin_layout Itemize
17445 Removing optional arguments that LyX can't handle (e.g., from
17454 \begin_layout Itemize
17468 This is necessary because LyX always writes out the non-local forms anyway.
17469 This should very rarely make a difference.
17473 \begin_layout Description
17478 Translate LaTeX text, commands, and environments to LyX.
17481 \begin_layout Description
17486 Put the two pieces back together, and do some final tweaking, to generate
17490 \begin_layout Standard
17503 commands, reLyX will loop back to the beginning and translate those.
17504 It assumes that the included files are the same class as the main file,
17505 and that they have no preamble matter.
17512 command in the preamble of a file, the command will be copied exactly into
17513 the LaTeX preamble portion of the LyX file, so the included file won't
17514 be translated.) So when translating included files, it skips passes 0 and
17518 \begin_layout Standard
17519 If reLyX doesn't find a file you wanted to include, it will give a warning,
17520 but will continue to translate any files it does find.
17523 \begin_layout Subsubsection
17527 \begin_layout Standard
17528 reLyX reads a LyX layout file to know how to handle LaTeX environments and
17529 commands which get translated to LyX layouts.
17530 This file will include all
17531 \begin_inset Quotes eld
17535 \begin_inset Quotes erd
17538 non-math environments (i.e., including quote and itemize, but not tabular,
17539 minipage, and some other fancy environments), and commands like
17552 If you want to reLyX a class that doesn't have an existing layout file,
17553 then you'll have to create a layout file.
17554 But you have to do this anyway, in order to LyX the file, since LyX depends
17555 on layout files to know how to display and process its files.
17556 Check the LyX documentation for help with this task (which can be hard
17557 or easy, depending on the class you want to create a layout file for.) If
17558 your class is quite similar to a class that has a layout file, then consider
17566 \begin_layout Subsubsection
17568 \begin_inset LatexCommand \label{sub:relyx-syntax}
17575 \begin_layout Standard
17576 reLyX always reads at least one syntax file, called the default syntax file.
17577 reLyX will read your personal syntax file if it exists; otherwise it will
17578 read the system-wide file.
17579 reLyX will read additional syntax files if you specify them with the
17584 (These extra files should have the same format as the default file, but
17585 will tend to be shorter, since they only have to specify extra commands
17586 not found in the default file.) A syntax file tells reLyX a few things.
17589 \begin_layout Standard
17590 First, it describes the syntax of each command, that is, how many required
17591 arguments and how many optional arguments the command takes.
17592 Knowing this makes it easier for reLyX to copy (in TeX mode) commands that
17593 it doesn't know how to translate.
17594 The syntax file simply has a command, followed by braces or brackets describing
17595 its arguments in the correct order.
17596 For example, a syntax file entry
17608 command takes an optional argument followed by a required one, while the
17621 command takes no arguments at all.
17622 When reLyX encounters a token that it doesn't know how to translate into
17623 LyX, it will copy the token---along with the correct number of arguments---exac
17625 If the token is not in the syntax file, then reLyX just copies as many
17626 arguments as it finds.
17627 This means that it may copy too much.
17628 But since the user can specify additional syntax files, that shouldn't
17632 \begin_layout Standard
17633 Some commands that cannot be translated to LyX, like
17639 , have as one of their arguments regular LaTeX text.
17641 \begin_inset Quotes eld
17645 \begin_inset Quotes erd
17648 is put into an argument of an (untranslatable) command in the syntax file,
17649 then reLyX will translate that argument instead of copying it verbatim.
17650 So, for example, the default syntax file has
17654 raisebox{}[][]{translate}
17657 This means that the
17663 command and the first argument (and optional arguments if they exist) are
17664 copied in TeX mode, but the last argument (which may contain math, complicated
17665 LaTeX, other untranslatable commands, etc.) will be translated into LyX.
17667 \begin_inset Quotes eld
17671 \begin_inset Quotes erd
17674 on optional arguments.
17677 \begin_layout Standard
17678 User-defined syntax files are allowed to define new commands and their syntax,
17679 or override the number of arguments for a command given in the default
17681 (E.g., if you're using a style that gives an extra argument to some command...)
17682 However, this will only be useful for commands copied in TeX mode.
17683 Commands which are actually translated by reLyX (like
17689 ) have their argument syntax hard-coded.
17690 The hard-coded commands are identified in the default syntax file.
17693 \begin_layout Standard
17694 Second, the syntax file describes any
17695 \begin_inset Quotes eld
17698 regular environments
17699 \begin_inset Quotes erd
17703 Usually, an entire unknown environment will be copied in TeX mode.
17704 If you define a regular environment
17705 \begin_inset Quotes eld
17709 \begin_inset Quotes erd
17712 , though, then only the
17724 commands will be copied in TeX mode; the text within the environment will
17725 be treated (i.e., translated) by reLyX as regular LaTeX, rather than being
17726 copied into TeX mode.
17727 Don't try to declare
17735 as regular environments, as the text within those environments will confuse
17736 reLyX; use this capability for new environments you create that have plain
17737 text or math or simple commands in them.
17738 You also can't declare unknown math environments (like
17742 ) as regular environments, either, since the LyX math editor won't understand
17744 The names of regular environments appear, whitespace-separated, between
17757 statements in the syntax file.
17758 (If you have a regular environment which you won't use very often, you
17763 option rather than writing a syntax file.)
17766 \begin_layout Standard
17767 Third, the syntax file describes a math translation table.
17768 The LyX math editor doesn't support a few commands.
17773 is supported, but the equivalent
17780 Put any commands you'd like translate between
17794 \begin_inset Quotes eld
17806 \begin_inset Quotes erd
17815 in math mode will be converted to
17816 \begin_inset Quotes eld
17826 \begin_inset Quotes erd
17833 (in cases where a token made up of a backslash and a non-letter is translated
17834 to something with letters at the end, a space is added by reLyX.
17836 \begin_inset Quotes eld
17846 \begin_inset Quotes erd
17849 is correctly translated to
17850 \begin_inset Quotes eld
17860 \begin_inset Quotes erd
17866 \begin_layout Subsubsection
17870 \begin_layout Standard
17871 You need Perl version 5.002 or later to run reLyX.
17872 <plug> If you don't have Perl, you should get it anyway (at
17873 \begin_inset LatexCommand \url[Perl]{http://www.perl.com/}
17877 ), because it's a really useful tool for pretty much anything.
17881 \begin_layout Subsection
17885 \begin_layout Standard
17886 reLyX should always explain why it crashes, if it crashes.
17887 Some diagnostics may be very technical, though, if they come from the guts
17889 reLyX gives much more information while running if you use the
17893 option, but you shouldn't need that unless something goes wrong.
17896 \begin_layout Standard
17897 When it's finished, reLyX will tell you if it finished successfully or died
17901 \begin_layout Subsection
17905 \begin_layout Standard
17906 Always keep a copy of your original LaTeX files either under a different
17907 name or in a different directory.
17908 There are a couple ways in which using LyX could lead to overwriting the
17909 original LaTeX file.
17912 \begin_layout Standard
17925 and want to re-export it, note that it will overwrite the original
17934 ask you if you want to overwrite it.)
17937 \begin_layout Standard
17938 If you have chosen not to use a temporary directory in the preferences,
17939 then LyX will create its temporary files in your current directory, which
17940 means your LaTeX original may be overwritten (without a warning from LyX)
17942 \begin_inset Quotes eld
17946 \begin_inset Quotes erd
17949 or print the LyX document.
17952 \begin_layout Subsection
17956 \begin_layout Description
17960 MY_LYXDIR/layouts/*.layout
17966 User's personal layout files for document classes
17969 \begin_layout Description
17973 MY_LYXDIR/reLyX/syntax.default
17979 User's personal syntax file
17982 \begin_layout Description
17986 LIBDIR/layouts/*.layout
17992 System-wide layout files for document classes
17995 \begin_layout Description
17999 LIBDIR/reLyX/syntax.default
18005 System-wide LaTeX syntax file
18008 \begin_layout Standard
18013 is the system-wide LyX directory, usually something like
18015 /usr/local/share/lyx/
18022 is your personal LyX directory, something like
18026 in your home directory.
18027 You can see their actual values in the
18032 elp\SpecialChar \menuseparator
18042 \begin_layout Subsection
18046 \begin_layout Standard
18058 \begin_layout Subsection
18062 \begin_layout Standard
18063 Copyright (c) 1998--9
18069 karger@voth.chem.utah.edu
18074 \begin_layout Standard
18078 \begin_layout Itemize
18083 wrote the original CleanTeX pass.
18086 \begin_layout Itemize
18092 \begin_layout Itemize
18100 \begin_layout Itemize
18103 David Suarez de Lis
18106 \begin_layout Standard
18107 Other contributors:
18110 \begin_layout Itemize
18113 Jean-Marc Lasgouttes
18115 worked on the wrapper script and offered lots of bug reports, advice, and
18116 feature suggestions.
18119 \begin_layout Itemize
18132 \begin_layout Itemize
18133 Various members of the LyX developers' and users' lists provided bug reports
18134 and feature suggestions.
18137 \begin_layout Standard
18138 reLyX uses a modified version the Perl TeX parser
18148 ilya@math.ohio-state.edu
18150 ), available on CPAN.
18153 \begin_layout Chapter
18154 LyX Features needing Extra Software
18157 \begin_layout Section
18158 Using LyX with SGML-Tools (aka LinuxDoc)
18161 \begin_layout Standard
18167 \begin_layout Subsection
18171 \begin_layout Standard
18172 LinuxDoc is a document class available in LyX if you have the
18177 You can use it to produce documents in the so-called Standardized General
18178 Mark-up Language (SGML) in the particular format used by the Linux Documentatio
18180 That is obviously helpful if you are contributing to that project.
18181 You can use the SGML format with the
18185 package of scripts and programs (to produce other formats, including Latex,
18186 HTML, plain text, man pages and\SpecialChar \ldots{}
18188 You may therefore prefer to use this document class if you want to write
18189 something that can be easily translated into other formats.
18192 \begin_layout Standard
18193 You will find that LinuxDoc has fewer layout options than the other text
18195 This is mainly so that the translations into other formats have a chance
18196 of making some sense.
18197 In this section we describe:
18200 \begin_layout Itemize
18201 how to setup and use a document in LinuxDoc
18204 \begin_layout Itemize
18205 how to use the tags in LinuxDoc to layout your document
18208 \begin_layout Itemize
18209 how to use the SGML packages to produce the various formats
18212 \begin_layout Itemize
18213 how to sort out some problems.
18216 \begin_layout Subsection
18217 Preparing and using a LinuxDoc document
18220 \begin_layout Subsubsection
18224 \begin_layout Standard
18225 You start by selecting the LinuxDoc class using the
18230 ocument\SpecialChar \menuseparator
18242 Then you will find that there are fewer paragraph environments than for
18243 most other classes.
18244 You can see them on the pull down box on the left of the tool bar.
18245 How to use them is described in section\InsetSpace ~
18247 \begin_inset LatexCommand \ref{sec:sgmlparas}
18254 \begin_layout Standard
18259 enter a title for the document, followed by an author, marking each with
18260 the appropriate paragraph environment.
18261 If you don't do this, you will get errors when you try to print the file.
18262 You can then enter the date and an abstract.
18263 The document proper must start with a Section paragraph environment rather
18264 than any standard layout.
18267 \begin_layout Standard
18268 After that you can prepare a document as usual using the available range
18269 of paragraph environments.
18270 See section\InsetSpace ~
18272 \begin_inset LatexCommand \ref{sec:sgmlparas}
18276 for the full list and their uses.
18279 \begin_layout Subsubsection
18280 Output from LinuxDoc
18283 \begin_layout Standard
18284 You can print and save these documents in the normal way.
18285 To use the other features of the SGML package you need to save your document
18286 as LinuxDoc; this is a version in which the document is translated into
18287 the basic sgml tags.
18294 ile\SpecialChar \menuseparator
18299 xport\SpecialChar \menuseparator
18307 You will get a file with the same name and a
18311 extension rather than a
18318 \begin_inset LatexCommand \ref{sec:sgmloperate}
18322 on how you than make use of this file.
18325 \begin_layout Subsection
18326 Using the paragraph environments in LinuxDoc
18329 \begin_layout Subsubsection
18330 The Structure of a LinuxDoc Document
18333 \begin_layout Standard
18334 There is a formal structure for LinuxDoc which limits how you can place
18336 There are two parts to all documents:
18339 \begin_layout Description
18340 Header: this is everything up to the first time you insert a Section layout
18342 It can include title, author, date, abstract and ToC.
18343 You must include the first two.
18346 \begin_layout Description
18347 Body: from the beginning of the first section onwards.
18348 All other tags are allowed.
18352 \begin_layout Subsubsection
18353 The LinuxDoc Paragraph Environments
18356 \begin_layout Standard
18357 \begin_inset LatexCommand \label{sec:sgmlparas}
18361 Here is a list of all the tags you will find listed on the layout bar in
18362 the order they come there, with some comments where the purpose or use
18366 \begin_layout Itemize
18371 works as described in [cross reference]
18374 \begin_layout Itemize
18379 : This will appear at the top left of the document when printed, above a
18380 heavy horizontal rule, although you will not see this on the LyX screen.
18383 \begin_layout Itemize
18386 Section, Subsection, Subsubsection, Paragraph and Subparagraph:
18388 all do what you would expect and in the usual order.
18389 Whether they are numbered or not is controlled by the
18391 Section\InsetSpace ~
18392 number\InsetSpace ~
18396 You cannot get the equivalent number free versions in any other way; there
18404 \begin_layout Itemize
18409 As usual this produces a numbered and indented list as described in the
18417 \begin_layout Itemize
18422 Again much the same as in the other classes: see the
18429 \begin_layout Itemize
18434 : As explained in the
18439 Remember that if you want the bold element at the start of a description
18440 to be more than one word then you need to put protected spaces between
18445 \begin_layout Itemize
18453 \begin_layout Itemize
18456 Code: similar to the Lyx-Code
18461 \begin_layout Itemize
18466 : Anything you mark with this will appear on the left of the heading of
18467 the document, under the heavy rule.
18470 \begin_layout Itemize
18475 Anything you mark with this will appear on the right of the heading under
18477 You do not have to make this a date.
18478 Any text can be entered, e.\InsetSpace ~
18483 \begin_layout Itemize
18488 : You can use this to produce a free standing paragraph after the author
18489 and date, and before the first section.
18490 You are only allowed one such paragraph.
18494 \begin_layout Standard
18500 This needs checking ---
18510 \begin_layout Itemize
18519 \begin_layout Standard
18524 I have not yet checked this ---
18534 \begin_layout Subsubsection
18535 Other document features
18538 \begin_layout Standard
18539 You can also use the
18543 menu to set fonts or to emphasis words.
18544 You can also use the table of contents as usual; see the corresponding
18550 Although you will find some some other features on the menus e.\InsetSpace ~
18552 inserting footnotes.
18553 There is some doubt about whether these will work correctly.
18557 \begin_layout Standard
18562 Again still checking to see whether this is my system
18572 \begin_layout Subsubsection
18573 Cross references and HTML
18576 \begin_layout Standard
18581 menu you will find two new options relating to the inclusion of URL addresses.
18582 If you use either option you will find some highlighted TeX code inserted
18583 into your document in three separate blocks with spaces available between.
18584 The blocks will be:
18587 \begin_layout Quote
18619 \begin_layout Standard
18620 You insert a full HTML tag between the first and second blocks.
18622 \begin_inset LatexCommand \url{http://any.address}
18626 or other valid tags such as
18627 \begin_inset LatexCommand \url{mailto:me@my.address}
18639 insert some description between the second and third blocks.
18640 The differences are:
18643 \begin_layout Itemize
18648 both the HTML tag and the description will appear in the document
18651 \begin_layout Itemize
18657 only the description appears in the printed version
18660 \begin_layout Subsection
18661 Using the LinuxDoc Sgml scripts
18662 \begin_inset Note Note
18665 \begin_layout Standard
18666 This section is completely outdated.
18674 \begin_layout Standard
18675 \begin_inset LatexCommand \label{sec:sgmloperate}
18679 You can use LinuxDoc as a text class without any additional scripts or programs,
18680 but there is not much point in doing this.
18681 All you will get is a document that looks like a
18683 Linux Documentation Project Howto
18689 To do the document translation you need to get and install the
18691 sgml-tools-1.0.x.tar.gz
18694 \begin_inset Formula $x\geq3$
18699 the SGML-Tools WWW Page
18704 \begin_layout LyX-Code
18707 \begin_inset LatexCommand \url{http://pobox.com/~cg/sgmltools}
18716 \begin_layout Standard
18717 Alternatively, you can go to the
18725 \begin_layout Standard
18726 Note that, at the time of this writing (01/1998), version 1.0.3 of sgml-tools
18727 has not yet been made available at
18739 \begin_layout LyX-Code
18742 \begin_inset LatexCommand \url{ftp://sunsite.unc.edu/pub/Linux/utils/text/sgml-tools-1.0.x.tar.gz}
18749 \begin_layout Standard
18756 sgml-tools-1.0.x.tar.gz
18758 contains everything that you need to write SGML documents and convert them
18759 to groff, LaTeX, HTML, GNU info, LyX, and RTF\SpecialChar \@.
18763 \begin_layout Standard
18764 This package was renamed from
18766 linuxdoc-sgml-1.5.tar.gz
18771 \begin_layout Standard
18772 Follow the instructions in that package on how to install it and how to
18774 All this has to be done outside of LyX, before you can use the
18779 ile\SpecialChar \menuseparator
18784 xport\SpecialChar \menuseparator
18791 \begin_layout Subsection
18792 Troubleshooting LinuxDoc
18795 \begin_layout Standard
18796 When you print or preview a LinuxDoc document some checking is done of the
18797 tags before LaTeX is run.
18798 Some errors are trapped here, especially those concerning the structure
18800 LyX may produce an error message, but not leave an error box in the document
18802 You may have to look at the files directly to discover what is wrong.
18803 Most problems seem to come from the use of options that are not fully available
18807 \begin_layout Section
18811 \begin_layout Standard
18817 \begin_layout Subsection
18821 \begin_layout Standard
18829 menu, you'll find a
18838 This feature requires you to have the
18842 program installed, and is grayed out if you don't have it.
18843 You can get it from your nearest CTAN mirror, or over the Web from
18844 \begin_inset LatexCommand \url{http://www.ifi.uio.no/~jensthi/chktex/}
18851 \begin_layout Standard
18856 package is a program that was written by
18861 in frustration because some constructs in LaTeX are sometimes non-intuitive,
18862 and easy to forget.
18863 The program runs over your LaTeX file and checks the integrity of the file,
18864 and flags some common errors.
18865 In other technical words, it is
18872 \begin_layout Standard
18873 Well, what is a syntax checker doing in LyX which is supposed to produce
18874 correct LaTeX anyways? The answer is simple: Just as
18878 not only checks the
18882 of C programs, but also does
18886 checks for type-errors,
18890 catches some common
18894 errors, in addition to the syntactical ones.
18899 is capable of detecting several common errors, such as
18902 \begin_layout Itemize
18903 Ellipsis detection:
18905 Use \SpecialChar \ldots{}
18909 \begin_layout Itemize
18910 No space in front of/after parenthesis:
18915 \begin_layout Itemize
18916 Enforcement of normal space after common abbreviations:
18920 is too wide spacing.
18923 \begin_layout Itemize
18924 Enforcement of end-of-sentence space when the last sentence ends with a
18928 And this is wrong spacing.
18931 \begin_layout Itemize
18932 Space in front of labels and similar commands:
18934 The label should stick right
18935 up to the text to avoid falling to a wrong page.
18937 \begin_inset LatexCommand \label{sec:chktex}
18945 \begin_layout Standard
18946 This footnote is in danger of falling off to a wrong page
18951 The label is separated too much.
18954 \begin_layout Itemize
18955 Space in front of references, instead of hard spaces:
18957 In you are in bad luck,
18958 the text will break right between the referenced text and reference number,
18961 \begin_inset LatexCommand \ref{sec:chktex}
18968 \begin_layout Itemize
18970 \begin_inset Quotes eld
18974 \begin_inset Quotes erd
18978 \begin_inset Formula $\times$
18983 2x2 looks cheap compared to
18984 \begin_inset Formula $2\times2$
18990 \begin_layout Standard
18991 and more \SpecialChar \ldots{}
18992 It is an invaluable tool when you are
18993 \begin_inset Quotes eld
18997 \begin_inset Quotes erd
19000 your document before printing, and you should run it right after the obligatory
19001 spelling check, and before you go fine tuning the typesetting.
19004 \begin_layout Subsection
19008 \begin_layout Standard
19009 If you have the program installed, usage is as simple as choosing
19014 ools\SpecialChar \menuseparator
19023 This will make LyX generate a LaTeX file of your document, start
19027 to check it, and then make LyX insert
19028 \begin_inset Quotes eld
19032 \begin_inset Quotes erd
19035 with the warnings from
19039 , if there were any.
19040 The warnings will be placed close to the point of the mistake, and you
19041 can quickly find them by using the
19046 avigate\SpecialChar \menuseparator
19053 menu item, or the shortcut key
19062 Open the error boxes by clicking on them with the mouse, or use the shortcut
19071 bindings, or the corresponding
19080 Read the warning and correct the mistake, if it is a mistake.
19081 If you have trouble understanding what the warning is about, you can safely
19083 Remember that there is a hidden layer between the document on screen and
19084 the technical details in invoking
19088 , and this gap can make some warnings seem arcane or just right down plain
19092 \begin_layout Standard
19093 This document is an excellent testing bed for the feature, and it should
19094 provide quite a few warnings for you to fiddle with.
19095 Since computers are only so smart, expect most of the warnings to be false
19099 \begin_layout Subsection
19100 How to fine tune it
19103 \begin_layout Standard
19104 Sometimes, you'll find that
19108 makes more noise than suits your mood.
19109 Then you can choose not to use it, wait until your mood changes, or try
19114 to get better along with you.
19115 Another choice in the most desperate situations is to use
19120 iew\SpecialChar \menuseparator
19130 , which will get rid of all warnings instantly.
19133 \begin_layout Standard
19142 very configurable and extensible, you shouldn't expect to solve all problems
19148 Since LyX has to generate a somewhat special LaTeX file to be able to match
19149 the line numbers from the
19157 \begin_layout Standard
19158 You can inspect the specific output from
19164 Edit\SpecialChar \menuseparator
19178 to the internal document structure, some of the warnings will not seen
19179 to appear correctly.
19180 There are two things you can do about this:
19183 \begin_layout Itemize
19188 invocation command line in
19204 installation configuration file (usually with the file
19206 /usr/local/share/chktexrc
19209 See below to learn what warnings can be enabled and disabled on the command
19214 \begin_layout Itemize
19215 Export your document as a raw LaTeX file using
19220 ile\SpecialChar \menuseparator
19225 xport\SpecialChar \menuseparator
19237 Invoked in this way, it can be a hassle to find the corresponding place
19238 in the document inside LyX, but with a little patience, you should be able
19242 \begin_layout Standard
19243 Here follows the warning messages that can be enabled and disabled in
19252 to disable a warning, and
19256 to enable a warning.
19257 The emphasized entries are disabled by default, because the default is
19260 chktex -n1 -n3 -n6 -n9 -n22 -n25 -n30 -n38
19265 \begin_layout Standard
19266 Notice that you should only use the options that enable and disable warnings,
19267 because LyX relies on some of the other command line parameters to be set
19268 in a specific way to have a chance to communicate with
19275 \begin_layout Enumerate
19279 Command terminated with space.
19282 \begin_layout Enumerate
19285 Non-breaking space (
19286 \begin_inset Quotes eld
19294 \begin_inset Quotes erd
19297 ) should have been used.
19300 \begin_layout Enumerate
19304 You should enclose the previous parenthesis with
19305 \begin_inset Quotes eld
19313 \begin_inset Quotes erd
19319 \begin_layout Enumerate
19322 Italic correction (
19323 \begin_inset Quotes eld
19333 \begin_inset Quotes erd
19336 ) found in non-italic buffer.
19339 \begin_layout Enumerate
19342 Italic correction (
19343 \begin_inset Quotes eld
19353 \begin_inset Quotes erd
19356 ) found more than once.
19359 \begin_layout Enumerate
19363 No italic correction (
19364 \begin_inset Quotes eld
19374 \begin_inset Quotes erd
19380 \begin_layout Enumerate
19384 \begin_inset Quotes eld
19392 \begin_inset Quotes erd
19396 \begin_inset Quotes eld
19404 \begin_inset Quotes erd
19410 \begin_layout Enumerate
19413 Wrong length of dash may have been used.
19416 \begin_layout Enumerate
19420 \begin_inset Quotes eld
19428 \begin_inset Quotes erd
19432 \begin_inset Quotes eld
19440 \begin_inset Quotes erd
19446 \begin_layout Enumerate
19450 \begin_inset Quotes eld
19458 \begin_inset Quotes erd
19464 \begin_layout Enumerate
19468 \begin_inset Quotes eld
19476 \begin_inset Quotes erd
19479 to achieve an ellipsis.
19482 \begin_layout Enumerate
19485 Inter-word spacing (
19486 \begin_inset Quotes eld
19496 \begin_inset Quotes eld
19499 ) should perhaps be used.
19502 \begin_layout Enumerate
19505 Inter-sentence spacing (
19506 \begin_inset Quotes eld
19516 \begin_inset Quotes erd
19519 ) should perhaps be used.
19522 \begin_layout Enumerate
19525 Could not find argument for command.
19528 \begin_layout Enumerate
19532 \begin_inset Quotes eld
19540 \begin_inset Quotes erd
19546 \begin_layout Enumerate
19549 Math mode still on at end of LaTeX file.
19552 \begin_layout Enumerate
19556 \begin_inset Quotes eld
19564 \begin_inset Quotes erd
19567 doesn't match the number of
19568 \begin_inset Quotes eld
19576 \begin_inset Quotes erd
19582 \begin_layout Enumerate
19585 You should use either
19588 \begin_inset Quotes eld
19596 \begin_inset Quotes erd
19601 as an alternative to
19602 \begin_inset Quotes eld
19610 \begin_inset Quotes erd
19616 \begin_layout Enumerate
19623 " (ASCII 39) instead of "
19630 \begin_layout Enumerate
19633 User-specified pattern found.
19636 \begin_layout Enumerate
19639 This command might not be intended.
19642 \begin_layout Enumerate
19649 \begin_layout Enumerate
19667 \begin_layout Enumerate
19670 Delete this space to maintain correct page references.
19673 \begin_layout Enumerate
19677 You might wish to put this between a pair of
19678 \begin_inset Quotes eld
19686 \begin_inset Quotes erd
19692 \begin_layout Enumerate
19695 You ought to remove spaces in front of punctuation.
19698 \begin_layout Enumerate
19701 Could not execute LaTeX command.
19704 \begin_layout Enumerate
19713 in front of small punctuation.
19716 \begin_layout Enumerate
19724 may look prettier here.
19727 \begin_layout Enumerate
19731 Multiple spaces detected in output.
19734 \begin_layout Enumerate
19737 This text may be ignored.
19740 \begin_layout Enumerate
19746 \begin_inset Quotes eld
19751 to begin quotation, not
19758 \begin_layout Enumerate
19765 to end quotation, not
19768 \begin_inset Quotes eld
19776 \begin_layout Enumerate
19782 \begin_layout Enumerate
19785 You should perhaps use
19786 \begin_inset Quotes eld
19794 \begin_inset Quotes erd
19800 \begin_layout Enumerate
19803 You should put a space in front of/after parenthesis.
19806 \begin_layout Enumerate
19809 You should avoid spaces in front of/after parenthesis.
19812 \begin_layout Enumerate
19816 You should not use punctuation in front of/after quotes.
19819 \begin_layout Enumerate
19822 Double space found.
19825 \begin_layout Enumerate
19828 You should put punctuation outside inner/inside display math mode.
19831 \begin_layout Enumerate
19834 You ought to not use primitive TeX in LaTeX code.
19837 \begin_layout Enumerate
19840 You should remove spaces in front of
19841 \begin_inset Quotes eld
19849 \begin_inset Quotes erd
19855 \begin_layout Enumerate
19858 \begin_inset Quotes eld
19866 \begin_inset Quotes erd
19869 is normally not followed by
19870 \begin_inset Quotes eld
19878 \begin_inset Quotes erd
19884 \begin_layout Standard
19885 In later versions of LyX, we hope to provide a more complete interface to
19886 this tool (and it's smaller cousin
19890 ) to exploit the full power of it.
19891 But it's not exactly useless as it is now: go try it on one of your existing
19892 documents of a certain length and be surprised.
19895 \begin_layout Section
19896 Version Control in LyX
19899 \begin_layout Standard
19902 Lars Gullik Bjønnes
19905 \begin_layout Subsection
19909 \begin_layout Standard
19910 A friend of mine wanted to try LyX for a group project.
19911 When he didn't find support for version control or file locking, he dropped
19913 This angered me a bit, so I thought that I should at least make support
19914 for RCS (with the possibility of CVS and/or SCCS as a future improvement.)
19915 This has now been done.
19916 LyX now supports some of the most basic RCS commands.
19917 If you need to something a bit more sophisticated you will have to do that
19918 manually in an xterm.
19921 \begin_layout Standard
19922 Before you begin to use the version control features in LyX, you should
19924 \begin_inset Quotes eld
19928 \begin_inset Quotes erd
19931 (a man file, read it with
19936 This file describes all the basic features of RCS.
19937 You should especially notice the comment about a RCS directory, and the
19938 notion of a master RCS file (the file ending in
19945 \begin_layout Standard
19946 The implementation in LyX assumes a recent version of the GNU RCS package---no
19947 guarantees are made for older versions.
19950 \begin_layout Subsection
19951 RCS commands in LyX
19954 \begin_layout Standard
19955 The following sections describe the RCS commands supported by LyX.
19956 You can find them in the
19961 ile\SpecialChar \menuseparator
19966 ersion\InsetSpace ~
19972 \begin_layout Subsubsection
19978 \begin_layout Standard
19979 If your document is not under revision control, this is the only item shown
19981 And if it is under revision control, the
19988 item is grayed out.
19992 \begin_layout Standard
19993 This command registers your document with RCS\SpecialChar \@.
19994 You are asked interactively
19995 to supply an initial description of the document.
19996 The document is now set in Read-Only mode and you have to
20003 , before making any changes to it.
20004 A document under revision control has a
20005 \begin_inset Quotes eld
20008 [RCS:<version> <locker>]
20009 \begin_inset Quotes erd
20012 item tagged to the filename in the minibuffer.
20015 \begin_layout Standard
20016 RCS command that is run:
20018 ci -q -u -i -t-"<initial description>" <file-name>
20021 \begin_layout Standard
20026 to understand the switches.
20030 \begin_layout Subsubsection
20036 \begin_layout Standard
20037 When you are finished editing a file, you check in your changes.
20038 When you do this, you are asked for a description of the changes.
20039 This is stored in the history log.
20040 The version number is bumped, your changes are applied to the master RCS
20041 file, the document is unlocked and set to Read-Only mode.
20045 \begin_layout Standard
20048 ci -q -u -m"<description>" <file-name>
20051 \begin_layout Subsubsection
20057 \begin_layout Standard
20058 By doing this you lock the document so that only you can edit it.
20059 This will also make the document Read-Write only for you.
20060 You will usually continue editing for a while and when you are finished
20061 you check in your changes.
20062 The status line is changed to reflect that you have locked the file.
20066 \begin_layout Standard
20069 co -q -l <file-name>
20072 \begin_layout Subsubsection
20075 Revert To Last Version
20078 \begin_layout Standard
20079 This will discard all changes made to the document since the last check
20081 You get a warning before changes are discarded.
20084 \begin_layout Standard
20087 co -f -u<version> <file-name>
20090 \begin_layout Subsubsection
20096 \begin_layout Standard
20097 This makes as if the last check in never happened.
20098 No changes are made to the document loaded into LyX, but the last version
20099 is removed from the master RCS file.
20103 \begin_layout Standard
20106 rcs -o<version> <file-name>
20109 \begin_layout Subsubsection
20115 \begin_layout Standard
20116 This show the complete history of the RCS document.
20121 is shown in a browser.
20129 \begin_layout Section
20130 Literate Programming
20133 \begin_layout Standard
20138 (kayvan@sylvan.com)
20142 original documentation written by
20144 Edmar Wienskoski Jr.
20147 (edmar-w-jr@technologist.com)
20150 \begin_layout Subsection
20154 \begin_layout Standard
20155 The main purpose of this documentation is to show you how to use LyX for
20156 literate programming.
20157 Where it is assumed that you are familiar with this programming technique,
20159 \begin_inset Quotes eld
20163 \begin_inset Quotes erd
20167 \begin_inset Quotes eld
20171 \begin_inset Quotes erd
20175 If that is not the case, please follow the web links provided in the following
20177 There is a lot of good documentation out there covering old development
20178 history to the latest tools tips.
20181 \begin_layout Standard
20182 It is also assumed that you are familiar with LyX itself to a point that
20183 you are comfortable changing your LyX preferences, and X resources file.
20184 If that is not the case please refer to other LyX documentation to cover
20185 your specific needs.
20188 \begin_layout Subsection
20189 Literate Programming
20192 \begin_layout Standard
20193 From the Literate Programming FAQ:
20196 \begin_layout Quotation
20197 Literate programming is the combination of documentation and source together
20198 in a fashion suited for reading by human beings.
20199 In fact, literate programs should be enjoyable reading, even inviting!
20200 (Sorry Bob, I couldn't resist!) In general, literate programs combine source
20201 and documentation in a single file.
20202 Literate programming tools then parse the file to produce either readable
20203 documentation or compilable source.
20204 The WEB style of literate programming was created by D.E.
20205 Knuth during the development of his TeX typesetting software.
20209 \begin_layout Standard
20210 Another excerpt says:
20213 \begin_layout Quotation
20216 How is literate programming different from verbose commenting?
20219 \begin_layout Quotation
20220 There are three distinguishing characteristics.
20221 In order of importance, they are:
20225 \begin_layout Itemize
20226 flexible order of elaboration
20229 \begin_layout Itemize
20230 automatic support for browsing
20233 \begin_layout Itemize
20234 typeset documentation, especially diagrams and mathematics
20238 \begin_layout Standard
20239 Now that I sparked your curiosity, take a look in the references.
20242 \begin_layout Subsubsection
20246 \begin_layout Standard
20247 The complete Literate Programming FAQ can be found at:
20250 \begin_layout Quote
20251 \begin_inset LatexCommand \url[Literate Programming FAQ]{http://shelob.ce.ttu.edu/daves/lpfaq/faq.html}
20258 \begin_layout Standard
20259 The FAQ lists 23 (twenty three!) different literate programming tools.
20260 Where some are specialized or
20261 \begin_inset Quotes eld
20265 \begin_inset Quotes erd
20268 for particular programming languages, while other have general scope.
20273 for my own use for several reasons:
20276 \begin_layout Itemize
20277 It can generate the documentation either in latex or html.
20280 \begin_layout Itemize
20281 It has a open architecture, i.e., it is easy to plug in new filters and to
20282 perform special processing that you may need.
20286 \begin_layout Itemize
20287 There is a good selection of filters available already (the html is one
20291 \begin_layout Itemize
20295 \begin_layout Standard
20296 The Noweb web page can be found at:
20299 \begin_layout Quote
20300 \begin_inset LatexCommand \url[Noweb home page]{http://www.cs.virginia.edu/~nr/noweb/}
20307 \begin_layout Standard
20308 Starting from there you can reach many other interesting links and even
20309 some literate program examples.
20312 \begin_layout Subsection
20313 LyX and Literate Programming
20316 \begin_layout Standard
20317 The LyX support for Literate Programming is provided by using the generic
20318 LyX convertors mechanism.
20319 This support is provided in a
20320 \begin_inset Quotes eld
20324 \begin_inset Quotes erd
20327 way, i.e., you will be able to use this new LyX feature with some other literate
20328 programming tool of your choice by just changing your LyX preferences.
20331 \begin_layout Subsubsection
20332 Generating documents and code (weaving and tangling)
20335 \begin_layout Paragraph
20336 Selecting the document class
20339 \begin_layout Standard
20340 If you have installed Noweb and LyX successfully, whenever you open a new
20341 document or try to change the document class of an existing one, you will
20342 find that there are three new document classes available:
20345 \begin_layout Itemize
20349 \begin_layout Itemize
20353 \begin_layout Itemize
20357 \begin_layout Standard
20358 You must select one of them to create your literate documents from.
20362 \begin_layout Standard
20363 Note that literate documents are not limited to these three classes.
20364 New classes can be generated from other styles like letter or in combination
20365 with other class variations like Article (AMS).
20366 If you have special needs that cannot be covered by one of the existing
20367 classes, let the LyX developers list (lyx-devel@lists.lyx.org) know and we
20368 will arrange to insert a new entry, or teach you how to do it.
20372 \begin_layout Standard
20373 It is very simple, it involves the creation of a file with four lines, and
20374 re-running of the auto configuration.
20379 Moreover, if you use a literate tool other than Noweb you may need to create
20380 a new set of document classes for it.
20383 \begin_layout Paragraph
20387 \begin_layout Standard
20388 LyX enables you to write code with a layout named
20396 \begin_layout Standard
20397 The equivalent Noweb term is
20398 \begin_inset Quotes eld
20402 \begin_inset Quotes erd
20406 For historical reasons, I got used to the term
20407 \begin_inset Quotes eld
20411 \begin_inset Quotes erd
20414 introduced by other literate tool named Nuweb, which I used for many years
20415 before rendering myself to Noweb.
20420 Noweb delimits scraps like this:
20423 \begin_layout LyX-Code
20427 \begin_layout LyX-Code
20431 \begin_layout LyX-Code
20435 \begin_layout LyX-Code
20439 \begin_layout LyX-Code
20443 \begin_layout Standard
20444 The problem is that whatever is written in between the << and the
20448 must be taken literally, i.e., LyX should be prevented from making any special
20449 interpretation of what has been written.
20450 This is handled by a special layout named Scrap, that works like a normal
20451 paragraph but has a free spacing capability.
20454 \begin_layout Standard
20455 The down side of the Scrap paragraph layout is that consecutive paragraphs
20456 of code will be spaced with one empty line in the source code and also
20457 in the printed documentation.
20458 The work around is to enter each line of code within a single Scrap, with
20459 a newline (ctrl-return).
20460 The example above will look like this:
20464 \begin_layout Standard
20465 If you have a printed version of this document you will not see any difference
20466 between the previous example and this one.
20474 \begin_layout LyX-Code
20486 \begin_layout Standard
20487 This layout works fine.
20488 The only real inconvenience is that you have to type ctrl-return instead
20493 \begin_layout Standard
20494 It is in my list of
20495 \begin_inset Quotes eld
20499 \begin_inset Quotes erd
20510 \begin_layout Standard
20511 As a special note, you can also use the
20512 \begin_inset Quotes eld
20516 \begin_inset Quotes erd
20519 construct of Noweb in your scraps to add items to Noweb's identifier cross-refe
20523 \begin_layout LyX-Code
20526 def some_function(args):
20528 "This is the doc string for this
20531 print "My args: ", args
20534 \begin_layout LyX-Code
20535 @ %def some_function
20538 \begin_layout Standard
20539 For an example of this usage and the resulting cross-reference output, look
20540 at the Literate python program in
20542 LIBDIR/examples/listerrors.lyx
20544 which should make this all clear.
20547 \begin_layout Paragraph
20548 Generating the documentation
20551 \begin_layout Standard
20552 At this point you already have a new document file with a proper document
20553 class, and with some code and text on it.
20554 How do I print it? The answer is simple, you select
20559 iew\SpecialChar \menuseparator
20567 Just like you would do for a plain document.
20568 No special procedure is required.
20571 \begin_layout Standard
20572 To help orientate you, I will now explain what happens inside LyX:
20575 \begin_layout Enumerate
20581 pdate\SpecialChar \menuseparator
20588 menu option is chosen, a latex file is generated.
20593 \begin_layout Standard
20594 If the document is of any literate class the generated file will be named
20595 with an extension name defined by the
20596 \begin_inset Quotes eld
20600 \begin_inset Quotes erd
20603 format (defined in the Preferences panel), otherwise the file will have
20612 \begin_layout Enumerate
20613 Note that the only difference so far is in the name of the file, no special
20614 processing is required by LyX.
20615 Given that you formatted the code using the Scrap layout that, by itself,
20616 takes care of the business.
20619 \begin_layout Enumerate
20620 If the document is of any literate class LyX will then use the internal
20621 LyX to Noweb converter, followed by the Noweb to LaTeX converter
20625 \begin_layout Standard
20626 The converters are defined in the
20631 ools\SpecialChar \menuseparator
20639 \begin_inset Quotes eld
20643 \begin_inset Quotes erd
20651 to generate the LaTeX file.
20655 \begin_layout Standard
20656 Otherwise it will just skip this step.
20660 \begin_layout Enumerate
20661 Finally, LaTeX is invoked and the regular post processing continues as in
20665 \begin_layout Standard
20666 Independence from a particular
20667 \begin_inset Quotes eld
20671 \begin_inset Quotes erd
20674 is easily achieved by changing the commands that are run by the various
20678 \begin_layout Paragraph
20679 Generating the code
20682 \begin_layout Standard
20683 When the build menu option is chosen or the corresponding button in the
20684 toolbar is pressed, a latex file is generated just like step 1 above.
20685 Next, LyX invokes the
20690 Typically, this converter (like any other converter), has two parts:
20693 \begin_layout Enumerate
20694 The converter program itself.
20695 This program performs the conversion from the one format to the other (in
20696 this case, from the Noweb format to the Program pseudo-format).
20699 \begin_layout Enumerate
20700 The error log parser.
20701 This is a program whose sole purpose is to rewrite error messages in a
20702 format that LyX understands.
20703 This makes it possible for LyX to place error boxes in the right places
20704 in the file buffer.
20707 \begin_layout Standard
20708 The first part, the
20709 \begin_inset Quotes eld
20713 \begin_inset Quotes erd
20716 setting, should be set to
20717 \begin_inset Quotes eld
20725 \begin_inset Quotes erd
20729 This basically means that LyX will call
20730 \begin_inset Quotes eld
20734 \begin_inset Quotes erd
20737 (a program or script) with the name of the Noweb file (generally a file
20738 in the LyX temp directory).
20742 \begin_layout Standard
20743 This is an implementation of
20744 \begin_inset Quotes eld
20748 \begin_inset Quotes erd
20751 that you can place in a directory on your path:
20754 \begin_layout LyX-Code
20758 \begin_layout LyX-Code
20762 \begin_layout LyX-Code
20763 notangle -Rbuild-script $1 | env NOWEB_SOURCE=$1 sh
20766 \begin_layout Standard
20767 The next part of the converter setting is the
20768 \begin_inset Quotes eld
20772 \begin_inset Quotes erd
20775 which is to be set to
20776 \begin_inset Quotes eld
20781 originaldir,parselog=listerrors
20784 \begin_inset Quotes erd
20788 This will run any errors that are generated by the
20789 \begin_inset Quotes eld
20793 \begin_inset Quotes erd
20796 process through the
20797 \begin_inset Quotes eld
20801 \begin_inset Quotes erd
20807 \begin_layout Standard
20808 The converter code looks in
20816 then on the path for the
20817 \begin_inset Quotes eld
20821 \begin_inset Quotes erd
20827 \begin_layout Paragraph
20828 Build instructions in the document
20831 \begin_layout Standard
20832 The last piece of the integration between LyX and noweb is the
20833 \begin_inset Quotes eld
20837 \begin_inset Quotes erd
20841 Generally, the instructions for building your program should be embedded
20842 in a scrap of its own.
20844 \begin_inset Quotes eld
20848 \begin_inset Quotes erd
20851 above uses the notangle command to look for this scrap (called
20852 \begin_inset Quotes eld
20856 \begin_inset Quotes erd
20859 ) and runs its contents through
20860 \begin_inset Quotes eld
20864 \begin_inset Quotes erd
20870 \begin_layout Standard
20871 Typically, such a scrap would look something like this:
20874 \begin_layout LyX-Code
20881 if [ -z "${NOWEB_SOURCE}" ]
20885 NOWEB_SOURCE=myfile.nw
20891 code to extract files ...]
20894 code to compile files ...]
20899 \begin_layout Standard
20902 LIBDIR/examples/listerrors.lyx
20906 LIBDIR/examples/Literate.lyx
20908 which implement two versions of the
20909 \begin_inset Quotes eld
20913 \begin_inset Quotes erd
20916 program for some illustrations of how all of these pieces go together or
20919 LIBDIR/examples/noweb2lyx.lyx.
20922 Interestingly, these three files show off the language-indepence of the
20923 LyX literate programming support since they are written in Python, C and
20927 \begin_layout Subsubsection
20931 \begin_layout Standard
20932 All the Literate Programming support is configured by the
20937 ools\SpecialChar \menuseparator
20945 \begin_inset Quotes eld
20949 \begin_inset Quotes erd
20953 The important parts are:
20956 \begin_layout Description
20959 \begin_inset Quotes eld
20963 \begin_inset Quotes erd
20967 format Set up via the Formats tab, this is where the Noweb-specific pieces
20977 , the file extension is set to
20982 This tells LyX to create a file with a
20986 extension in the first step of the conversion process.
20989 \begin_layout Description
20996 format This is an empty format whose sole purpose is to be the endpoint
20997 of a conversion (which then allows us to set up a converter for it).
21000 \begin_layout Description
21009 This converter performs the
21010 \begin_inset Quotes eld
21014 \begin_inset Quotes erd
21017 of the literate document.
21018 For Noweb, it is set to
21019 \begin_inset Quotes eld
21024 noweave -delay -index $$i > $$o
21027 \begin_inset Quotes erd
21033 \begin_layout Description
21043 \begin_inset Quotes eld
21047 \begin_inset Quotes erd
21051 As stated above, the Converter is set to
21052 \begin_inset Quotes eld
21060 \begin_inset Quotes erd
21063 , with Flags set to
21064 \begin_inset Quotes eld
21069 originaldir,parselog=listerrors
21072 \begin_inset Quotes erd
21078 \begin_layout Subsubsection
21082 \begin_layout Standard
21083 There is also a new function implemented in the LyX server, the
21084 \begin_inset Quotes eld
21087 server-goto-file-row" function, to be used with ddd/gdb or other debugger.
21091 \begin_layout Standard
21092 When debugging code with ddd/gdb, it is possible to invoke a text editor
21093 at the current execution position with a single key stroke.
21094 The default ddd configuration for that is shift-ctrl-V.
21095 It happens that you can define the editor command line invocation in ddd
21102 dit\SpecialChar \menuseparator
21107 references\SpecialChar \menuseparator
21114 dialog and changing the "Edit Sources" entry.
21117 \begin_layout Standard
21118 I take advantage of the new created LyX server function and this ddd feature,
21120 \begin_inset Quotes eld
21124 \begin_inset Quotes erd
21130 \begin_layout LyX-Code
21131 echo "LYXCMD:monitor:server-goto-file-row:@FILE@ @LINE@" >~/.lyxpipe.in
21134 \begin_layout Standard
21135 With this, whenever you are using ddd and find a point in the program that
21136 you want to edit, you just press shift-ctrl-V (in the ddd window), and
21137 ddd you forward this information to LyX through the LyX server and then
21138 the LyX window will show the same file with the cursor at the same position
21139 ddd was pointing to.
21140 No more guessing or long scrolling to locate a point in the program back
21144 \begin_layout Standard
21145 Note however that you must enable the LyX server to get this feature working
21146 (it is disabled by default).
21147 You can enable it in
21159 ) by entering in the
21164 \begin_inset Quotes eld
21169 /home/<your-home-directory>/.lyx/lyxpipe
21172 \begin_inset Quotes erd
21178 \begin_layout Standard
21179 Read the LyX server documentation in the
21181 Customization Manual
21183 for further information.
21186 \begin_layout Subsubsection
21190 \begin_layout Standard
21191 There are six new buttons that can be added to your LyX toolbar.
21192 Five of these buttons are short cuts to layout styles:
21213 The last one is a short cut to the
21214 \begin_inset Quotes eld
21218 \begin_inset Quotes erd
21225 \begin_layout Standard
21226 LyX has a range of buttons that are available for tool bar customization.
21227 In my toolbar I like to combine the six short cuts above with two more:
21235 \SpecialChar \menuseparator
21243 \SpecialChar \menuseparator
21256 iew\SpecialChar \menuseparator
21264 Here is how it looks like:
21267 \begin_layout LyX-Code
21271 \begin_layout LyX-Code
21275 \begin_layout LyX-Code
21276 Icon "layout Standard"
21279 \begin_layout LyX-Code
21280 Icon "layout Section"
21283 \begin_layout LyX-Code
21284 Icon "layout LaTeX"
21287 \begin_layout LyX-Code
21288 Icon "layout LyX-Code"
21291 \begin_layout LyX-Code
21292 Icon "layout Scrap"
21295 \begin_layout LyX-Code
21299 \begin_layout LyX-Code
21303 \begin_layout LyX-Code
21304 Icon "buffer-typeset"
21307 \begin_layout LyX-Code
21308 Icon "build-program"
21311 \begin_layout LyX-Code
21315 \begin_layout LyX-Code
21319 \begin_layout LyX-Code
21323 \begin_layout LyX-Code
21327 \begin_layout LyX-Code
21331 \begin_layout Subsubsection
21332 Colors customization
21335 \begin_layout Standard
21336 There are a number of colors in LyX that can be customized in
21341 One of the things that bothers people is the LaTeX font color.
21342 The default color is red, since the scraps uses LaTeX font, and there is
21343 a lot of scraps in literate documents, you may get tired of seeing everything
21345 You can change it by going to the tabs
21354 \begin_layout Standard
21355 The next thing is the visible presence of the newline character in the screen.
21356 You can choose the color of this particular character and make it blend
21358 I recommend you choosing a color that is close to the background but not
21359 equal, that way you still can see it is there, but it is not bothering
21364 \begin_layout Chapter
21365 Secrets of the LaTeX Masters
21366 \begin_inset LatexCommand \label{cha:secrets}
21373 \begin_layout Standard
21374 Though LyX is a powerful tool, it cannot hope to support everything that
21375 can be done with pure TeX/LaTeX.
21376 However, many familiar dirty TeX and LaTeX tricks can be done within LyX,
21377 as long as you are not afraid to use that
21378 \begin_inset Quotes eld
21382 \begin_inset Quotes erd
21385 button on the toolbar or add things to the LaTeX preamble.
21386 This section lists some tips, tricks, and otherwise cool ideas to give
21387 your document that extra little flair.
21390 Do try this at home
21392 , just start with something a little smaller and less important than your
21396 \begin_layout Standard
21397 Most ideas in this section require less common files in your LaTeX installation.
21398 If you have a system like teTeX, most will already be available.
21399 A few, however, will need to be downloaded from one of the CTAN archives.
21400 Often, there are several ways to do something, or several LaTeX style files
21401 which do the same thing.
21402 We do not endorse one choice over another, we simply claim that we have
21403 done a particular task with a particular file.
21404 Put on your wizard hat, keep an eye out for dragons, and let us begin.
21407 \begin_layout Section
21408 Tricks for Footnotes and Margin Notes
21411 \begin_layout Standard
21417 \begin_layout Subsection
21421 \begin_layout Standard
21422 LyX cannot yet take care of setting the footnote numbering back to 1 after
21423 each section in the
21424 \begin_inset Quotes eld
21432 \begin_inset Quotes erd
21437 document class or changing the counter style.
21438 You'll need to insert LaTeX commands like the following to achieve that:
21441 \begin_layout Standard
21445 \begin_layout Standard
21448 setcounter{footnote}{0}
21457 setcounter{footnote}{0}
21459 will set the counter back to 1
21463 \begin_layout Standard
21464 The counter has been set back to 1.
21472 \begin_layout Standard
21473 The following command will change the numbering to small letters.
21474 Take a look at the next footnote in your xdvi or ghostview
21478 \begin_layout Standard
21494 \begin_layout Standard
21495 This is an example for a footnote with alphabetic numbering.
21515 \begin_layout Standard
21516 The next command sets the counter style back to default, i.e.
21527 \begin_layout Standard
21538 to set the counter--style back to LyX's default, i.e.
21547 \begin_layout Standard
21567 \begin_layout Standard
21598 and others as counter styles.
21599 Just replace the LaTeX command in the above example and rerun TeX to see
21600 what those styles can do.
21604 \begin_layout Subsection
21608 \begin_layout Standard
21609 Here are two examples of neat things you can do to margin notes using LaTeX
21613 \begin_layout Standard
21614 The following command will make a vertical line appear alongside your text---gre
21616 \begin_inset Quotes eld
21620 \begin_inset Quotes erd
21629 rule[-10mm]{30mm}{5mm}}
21637 \begin_layout Standard
21642 rule[-10mm]{30mm}{5mm}}
21650 \begin_layout Standard
21651 Check your dvi- or ghostview-output to see what the
21657 command does to the following margin note.
21660 \begin_layout Standard
21664 \begin_layout Standard
21673 \begin_inset Marginal
21676 \begin_layout Standard
21687 \begin_layout Section
21691 \begin_layout Standard
21694 Lars Gullik Bjønnes
21697 \begin_layout Subsection
21701 \begin_layout Standard
21702 The aim for this chapter
21706 \begin_layout Standard
21707 Editor's note: Lars' original chapter was a masterful description of how
21713 However, it was too long to flow smoothly in this document.
21714 I have therefore chosen to excerpt the most important sections here (sorry,
21715 Lars); you can read the original chapter (and more of the story!) in the
21718 examples/multicol.lyx
21726 is to show how the LaTeX package
21730 can be used in a LyX document.
21731 As LyX doesn't support the
21735 package natively yet, we have to use some small hacks.
21736 By reading this section it should be obvious how to do this.
21739 \begin_layout Subsection
21743 \begin_layout Standard
21748 package allows switching between one and multicolumn format on the same
21750 Footnotes are handled correctly (for the most part), but will be placed
21751 at the bottom of the page and not under each column.
21752 LaTeX's float mechanism, however, is partly disabled in the current implementat
21754 At the moment only page-wide floats can be used within the scope of the
21758 \begin_layout Subsection
21762 \begin_layout Subsubsection
21766 \begin_layout Standard
21767 If you want to have two columns in your text, you have use LaTeX mode to
21772 begin{multicols}{2}
21774 at the point where you want the two column layout to start, and then
21780 where you want it to end.
21784 \begin_layout Standard
21788 \begin_layout Standard
21791 begin{multicols}{2}
21799 \begin_layout Standard
21804 The Adventure of the Empty House
21810 Sir Arthur Conan Doyle
21813 \begin_layout Standard
21816 It was in the spring of the year 1894 that all London was interested, and
21817 the fashionable world dismayed, by the murder of the Honourable Ronald
21818 Adair under most unusual and inexplicable circumstances.
21819 The public has already learned those particulars of the crime which came
21820 out in the police investigation, but a good deal was suppressed upon that
21821 occasion, since the case for the prosecution was so overwhelmingly strong
21822 that it was not necessary to bring forward all the facts.
21823 Only now, at the end of nearly ten years, am I allowed to supply those
21824 missing links which make up the whole of that remarkable chain.
21825 The crime was of interest in itself, but that interest was as nothing to
21826 me compared to the inconceivable sequel, which afforded me the greatest
21827 shock and surprise of any event in my adventurous life.
21828 Even now, after this long interval, I find myself thrilling as I think
21829 of it, and feeling once more that sudden flood of joy, amazement, and increduli
21830 ty which utterly submerged my mind.
21831 Let me say to that public, which has shown some interest in those glimpses
21832 which I have occasionally given them of the thoughts and actions of a very
21833 remarkable man, that they are not to blame me if I have not shared my knowledge
21834 with them, for I should have considered it my first duty to do so, had
21835 I not been barred by a positive prohibition from his own lips, which was
21836 only withdrawn upon the third of last month.
21839 \begin_layout Standard
21843 \begin_layout Standard
21854 \begin_layout Subsubsection
21858 \begin_layout Standard
21859 The same pattern is used when you want more than two columns:
21862 \begin_layout Standard
21866 \begin_layout Standard
21869 begin{multicols}{3}
21877 \begin_layout Standard
21880 It can be imagined that my close intimacy with Sherlock Holmes had interested
21881 me deeply in crime, and that after his disappearance I never failed to
21882 read with care the various problems which came before the public.
21883 And I even attempted, more than once, for my own private satisfaction,
21884 to employ his methods in their solution, though with indifferent success.
21885 There was none, however, which appealed to me like this tragedy of Ronald
21887 As I read the evidence at the inquest, which led up to a verdict of willful
21888 murder against some person or persons unknown, I realized more clearly
21889 than I had ever done the loss which the community had sustained by the
21890 death of Sherlock Holmes.
21891 There were points about this strange business which would, I was sure,
21892 have specially appealed to him, and the efforts of the police would have
21893 been supplemented, or more probably anticipated, by the trained observation
21894 and the alert mind of the first criminal agent in Europe.
21895 All day, as I drove upon my round, I turned over the case in my mind and
21896 found no explanation which appeared to me to be adequate.
21897 At the risk of telling a twice-told tale, I will recapitulate the facts
21898 as they were known to the public at the conclusion of the inquest.
21901 \begin_layout Standard
21905 \begin_layout Standard
21916 \begin_layout Standard
21917 You can have have more than 3 columns if you want to, but that might not
21918 be very pleasant for the eye.
21921 \begin_layout Subsubsection
21922 Columns inside columns
21925 \begin_layout Standard
21926 You can even have columns inside columns:
21929 \begin_layout Standard
21933 \begin_layout Standard
21936 begin{multicols}{2}
21944 \begin_layout Standard
21947 The Honourable Ronald Adair was the second son of the Earl of Maynooth,
21948 at that time governor of one of the Australian colonies.
21949 Adair's mother had returned from Australia to undergo the operation for
21950 cataract, and she, her son Ronald, and her daughter Hilda were living together
21954 \begin_layout Standard
21958 \begin_layout Standard
21961 begin{multicols}{2}
21969 \begin_layout Standard
21972 The youth moved in the best society--had, so far as was known, no enemies
21973 and no particular vices.
21974 He had been engaged to Miss Edith Woodley, of Carstairs, but the engagement
21975 had been broken off by mutual consent some months before, and there was
21976 no sign that it had left any very profound feeling behind it.
21977 For the rest {sic} the man's life moved in a narrow and conventional circle,
21978 for his habits were quiet and his nature unemotional.
21979 Yet it was upon this easy-going young aristocrat that death came, in most
21980 strange and unexpected form, between the hours of ten and eleven-twenty
21981 on the night of March 30, 1894.
21984 \begin_layout Standard
21988 \begin_layout Standard
21999 \begin_layout Standard
22002 Ronald Adair was fond of cards--playing continually, but never for such
22003 stakes as would hurt him.
22004 He was a member of the Baldwin, the Cavendish, and the Bagatelle card clubs.
22005 It was shown that, after dinner on the day of his death, he had played
22006 a rubber of whist at the latter club.
22007 He had also played there in the afternoon.
22012 The evidence of those who had played with him-- Mr.
22013 Murray, Sir John Hardy, and Colonel Moran--showed that the game was whist,
22014 and that there was a fairly equal fall of the cards.
22015 Adair might have lost five pounds, but not more.
22016 His fortune was a considerable one, and such a loss could not in any way
22018 He had played nearly every day at one club or other, but he was a cautious
22019 player, and usually rose a winner.
22020 It came out in evidence that, in partnership with Colonel Moran, he had
22021 actually won as much as four hundred and twenty pounds in a sitting, some
22022 weeks before, from Godfrey Milner and Lord Balmoral.
22023 So much for his recent history as it came out at the inquest.
22026 \begin_layout Standard
22030 \begin_layout Standard
22041 \begin_layout Standard
22042 Please do read the file
22044 examples/multicol.lyx
22046 for more advanced examples including column and header spacing, vertical
22047 separator lines, and more.
22050 \begin_layout Section
22055 Paragraph Environment
22056 \begin_inset OptArg
22059 \begin_layout Standard
22060 Numbering in Enumerate
22068 \begin_layout Standard
22074 \begin_layout Standard
22075 \begin_inset VSpace bigskip
22081 \begin_layout Standard
22083 The default numbering for the
22087 paragraph environment begins with Arabic numbers and ends with uppercase
22089 Suppose, however, you wanted a different type of numbering scheme.
22090 Here's a quickie example of how to change the numbering scheme:
22093 \begin_layout LyX-Code
22103 \begin_layout LyX-Code
22113 \begin_layout LyX-Code
22123 \begin_layout LyX-Code
22133 \begin_layout Standard
22134 \SpecialChar \ldots{}
22135 which changes the numbering scheme to uppercase Roman numerals, uppercase
22136 letters, Arabic numbers, and lowercase letter.
22139 \begin_layout Standard
22140 Additionally, the previous example also adds a little bit extra to the numbering
22142 For example, the first level label actually looks like:
22143 \begin_inset Quotes eld
22147 \begin_inset Quotes erd
22151 For ease of reading, we'll describe what the numbering schemes look like
22152 using a notation something like this: <
22153 \begin_inset Quotes eld
22157 \begin_inset Quotes erd
22162 \begin_inset Quotes erd
22166 \begin_inset Quotes erd
22171 \begin_inset Quotes erd
22175 \begin_inset Quotes erd
22180 \begin_inset Quotes eld
22184 \begin_inset Quotes erd
22191 \begin_layout Standard
22192 As you can see in the example, there is a label command for each nesting
22199 \SpecialChar \ldots{}
22206 , as well as a counter,
22210 \SpecialChar \ldots{}
22216 There are also five
22217 \begin_inset Quotes eld
22221 \begin_inset Quotes erd
22254 , each of which take one counter as an argument.
22255 You can add characters before or after these, but there's no need to add
22259 \begin_layout Standard
22260 You can get really fancy with these.
22264 \begin_layout LyX-Code
22278 \begin_layout LyX-Code
22290 \begin_layout LyX-Code
22300 \begin_layout LyX-Code
22310 \begin_layout Standard
22311 produces the somewhat out of hand numbering scheme: <
22312 \begin_inset Quotes eld
22316 \begin_inset Quotes erd
22321 \begin_inset Quotes erd
22325 \begin_inset Quotes erd
22330 \begin_inset Quotes erd
22334 \begin_inset Quotes erd
22339 \begin_inset Quotes eld
22343 \begin_inset Quotes erd
22350 \begin_layout Section
22351 Extra Space Between Table Rows
22354 \begin_layout Standard
22360 \begin_layout Standard
22361 \begin_inset VSpace bigskip
22367 \begin_layout Standard
22369 LaTeX allows you to put a bit of extra space between rows in a table by
22370 giving an optional argument to the end-of-row specifier (
22379 LyX has not yet implemented this in a formal way, so here are two dirty
22380 little tricks to do the same job.
22384 \begin_layout Standard
22385 The first is the more formal, but longwinded way to do it.
22386 In the LaTeX preamble, add the following command definition:
22389 \begin_layout Standard
22396 extratablespace}[1]{
22400 This command takes a single argument---the amount of space you would like
22402 Insert the command in the first column of the row
22406 where you would like the space to appear.
22407 Here is an example (I've removed all the borders using
22412 ayout\SpecialChar \menuseparator
22421 \begin_layout Standard
22423 \begin_inset Tabular
22424 <lyxtabular version="3" rows="4" columns="3">
22426 <column alignment="center" valignment="top" width="0pt">
22427 <column alignment="center" valignment="top" width="0pt">
22428 <column alignment="center" valignment="top" width="0pt">
22430 <cell alignment="center" valignment="top" topline="true" usebox="none">
22433 \begin_layout Standard
22448 <cell alignment="center" valignment="top" topline="true" usebox="none">
22451 \begin_layout Standard
22466 <cell alignment="center" valignment="top" topline="true" usebox="none">
22469 \begin_layout Standard
22486 <cell alignment="center" valignment="top" topline="true" usebox="none">
22489 \begin_layout Standard
22495 <cell alignment="center" valignment="top" topline="true" usebox="none">
22498 \begin_layout Standard
22513 <cell alignment="center" valignment="top" topline="true" usebox="none">
22516 \begin_layout Standard
22533 <cell alignment="center" valignment="top" topline="true" usebox="none">
22536 \begin_layout Standard
22549 \begin_layout Standard
22552 extratablespace{2ex}
22562 <cell alignment="center" valignment="top" topline="true" usebox="none">
22565 \begin_layout Standard
22580 <cell alignment="center" valignment="top" topline="true" usebox="none">
22583 \begin_layout Standard
22600 <cell alignment="center" valignment="top" topline="true" usebox="none">
22603 \begin_layout Standard
22609 <cell alignment="center" valignment="top" topline="true" usebox="none">
22612 \begin_layout Standard
22627 <cell alignment="center" valignment="top" topline="true" usebox="none">
22630 \begin_layout Standard
22653 \begin_layout Standard
22654 The second method is faster, but will make typographers and TeXperts all
22655 over the world groan.
22656 Simply put an end of row specifier with optional argument at the same spot.
22657 No fancy definitions are needed as in the above example, but there will
22658 be more space inserted than you specified because you essentially added
22659 a blank row plus the extra space.
22660 If the space added is too much, simply use a negative number, like so:
22663 \begin_layout Standard
22665 \begin_inset Tabular
22666 <lyxtabular version="3" rows="4" columns="3">
22668 <column alignment="center" valignment="top" width="0pt">
22669 <column alignment="center" valignment="top" width="0pt">
22670 <column alignment="center" valignment="top" width="0pt">
22672 <cell alignment="center" valignment="top" topline="true" usebox="none">
22675 \begin_layout Standard
22690 <cell alignment="center" valignment="top" topline="true" usebox="none">
22693 \begin_layout Standard
22708 <cell alignment="center" valignment="top" topline="true" usebox="none">
22711 \begin_layout Standard
22728 <cell alignment="center" valignment="top" topline="true" usebox="none">
22731 \begin_layout Standard
22737 <cell alignment="center" valignment="top" topline="true" usebox="none">
22740 \begin_layout Standard
22755 <cell alignment="center" valignment="top" topline="true" usebox="none">
22758 \begin_layout Standard
22775 <cell alignment="center" valignment="top" topline="true" usebox="none">
22778 \begin_layout Standard
22791 \begin_layout Standard
22806 <cell alignment="center" valignment="top" topline="true" usebox="none">
22809 \begin_layout Standard
22824 <cell alignment="center" valignment="top" topline="true" usebox="none">
22827 \begin_layout Standard
22844 <cell alignment="center" valignment="top" topline="true" usebox="none">
22847 \begin_layout Standard
22853 <cell alignment="center" valignment="top" topline="true" usebox="none">
22856 \begin_layout Standard
22871 <cell alignment="center" valignment="top" topline="true" usebox="none">
22874 \begin_layout Standard
22897 \begin_layout Standard
22898 It's short, sweet, and gets the job done quickly, even if it is really ugly.
22899 You may put away the rotten vegetables now! I promise I won't suggest anything
22903 \begin_layout Section
22907 \begin_layout Standard
22913 \begin_layout Standard
22914 \begin_inset VSpace bigskip
22920 \begin_layout Standard
22925 \begin_layout Standard
22930 tmpfont}{cmr17 scaled 2500}{
22942 \begin_layout Standard
22947 \begin_layout Standard
22957 hose of you who like the style of old books probably also like
22958 \begin_inset Quotes eld
22962 \begin_inset Quotes erd
22965 ---those large capital letters which begin each new chapter or section.
22966 Implementing them with plain LyX/LaTeX is straightforward (assuming you
22967 know some plain TeX!) but does require a lot of work and many iterations,
22968 as you can see by all the ugly TeX-mode stuff at the beginning of this
22972 \begin_layout Standard
22976 \begin_layout Standard
22981 bigdrop{-1em}{3}{ptmri}{T}+
22986 here is a much easier way of doing this, of course.
22995 ) package from CTAN allows a simple way to add such letters to your documents.
22996 Since this package is not a standard part of teTeX, I can't demonstrate
22997 it within this document, but if you copy this paragraph to a new document,
22999 \begin_inset Quotes eld
23009 \begin_inset Quotes erd
23012 and the pluses from the TeX code at the beginning of the paragraph, and
23017 usepackage{dropcaps}
23019 to your LaTeX preamble, you will get a nice Times Roman Italic
23020 \begin_inset Quotes eld
23024 \begin_inset Quotes erd
23027 , whose height is three lines of text and which protrudes 1 em into the
23029 (Make certain you have copied
23030 \begin_inset Quotes eld
23038 \begin_inset Quotes erd
23041 into a directory where TeX can see it.) The first argument is the amount
23042 of indentation; in this case the negative sign moves it into the margin.
23043 The second argument is the height of the letter in number of lines of text.
23044 The third argument is the font name: virtually anything which has a tfm
23045 file should work (wade through the
23047 .../texmf/fonts/tfm
23049 directory for possibilities).
23050 My personal favorite is
23051 \begin_inset Quotes eld
23059 \begin_inset Quotes erd
23062 , a fancy German font specifically designed for dropped capitals.
23063 The fourth argument is the letter (or letters) to be dropped.
23068 package also offers the
23074 command, as well as a slightly simplified
23083 \begin_layout Section
23084 Non-standard Paragraph Shapes
23087 \begin_layout Standard
23093 \begin_layout Standard
23094 \begin_inset VSpace bigskip
23100 \begin_layout Standard
23104 \begin_layout Standard
23115 \begin_layout Standard
23119 \begin_layout Standard
23127 \begin_layout Standard
23140 \begin_layout Standard
23145 \begin_layout Standard
23155 \begin_layout Standard
23163 \begin_layout Standard
23171 \begin_layout Standard
23179 \begin_layout Standard
23187 \begin_layout Standard
23195 \begin_layout Standard
23203 \begin_layout Standard
23211 \begin_layout Standard
23219 \begin_layout Standard
23227 \begin_layout Standard
23235 \begin_layout Standard
23243 \begin_layout Standard
23251 \begin_layout Standard
23259 \begin_layout Standard
23267 \begin_layout Standard
23275 \begin_layout Standard
23283 \begin_layout Standard
23291 \begin_layout Standard
23299 \begin_layout Standard
23305 There are times when the tyranny of rectangular paragraphs must be overthrown.
23306 In such situations, a call to the delightful plain TeX command
23313 As you can see, completely arbitrary shapes can be laid out with a suitable
23314 set of linelength definitions.
23315 While this parshape may look a bit silly and useless, one could conceive
23316 of situations such as finely tuned dropped capitals, word wrapping around
23317 non-rectangular graphics, etc.
23318 which will benefit from such handcrafting.
23321 \begin_layout Standard
23322 \begin_inset VSpace bigskip
23328 \begin_layout Standard
23333 parshape numlines #1indent #1length #2indent #2length \SpecialChar \ldots{}
23340 is the number of lines of text which define the paragraph.
23341 If there turn out to be fewer lines, the shape is truncated; if there are
23342 more, the excess lines have the same dimensions as the last line of the
23352 entries specify the indentation of the line from the left margin, and the
23353 length of the line as measured from that point.
23354 The shape applies only to the current paragraph; everything is reset to
23355 normal for the next paragraph.
23358 \begin_layout Standard
23362 \begin_layout Standard
23373 \begin_layout Section
23377 \begin_layout Standard
23378 As you can see, the examples in this section range from the useful to the
23380 While I don't expect that anyone will ever need the paragraph shape demonstrate
23381 d in the last section, the important point is that you can do almost anything
23382 you want in LyX if you are willing to figure out how to do it in TeX and
23384 TeX is a fantastically powerful typesetting system and all that power is
23385 available to you since LyX uses it as its backend.