1 #LyX 1.5.0svn created this file. For more info see http://www.lyx.org/
8 \newcommand{\extratablespace}[1]{\noalign{\vskip#1}}
14 \font_typewriter default
15 \font_default_family default
21 \paperfontsize default
29 \paperorientation portrait
32 \paragraph_separation indent
34 \quotes_language english
37 \paperpagestyle headings
38 \tracking_changes false
54 \begin_layout Standard
56 Principal maintainer of this file is
61 If you have comments or error corrections, please send them to the LyX
62 Documentation mailing list, <lyx-docs@lists.lyx.org>.
70 \begin_layout Standard
71 \begin_inset LatexCommand tableofcontents
82 \begin_layout Standard
87 manual, which you are now reading, is essentially Part II of the
89 User's Guide\SpecialChar \@.
92 The reason for splitting this document is simple: the
96 is already huge, and it contains all of the basic features one needs to
97 know in order to prepare most documents.
98 However, the LyX Team has a long-term goal of making LyX extensible through
99 various configuration files and external packages.
100 That means that if you want to support the Fizzwizzle LaTeX package, you
101 can create a layout file for it without having to alter LyX itself.
102 We've already had contributions of several new features this way.
103 This is the place where all of that gets documented.
106 \begin_layout Standard
107 This manual also documents some special features, like fax support, version
108 control, and SGML support, which require additional software to work properly.
109 Lastly, there's a chapter of LaTeX tools and tips, things you can use to
110 spruce up your documents by directly using the powerful features of LaTeX.
115 only WYSIWYM, and will only ever interface to certain LaTeX features.
118 \begin_layout Standard
119 Of course, with all of this extra documentation,
121 Extended LyX Features
123 may itself grow too big for its britches.
124 In that case, you can just call it the
125 \begin_inset Quotes eld
129 \begin_inset Quotes erd
135 \begin_layout Standard
136 If you haven't read the
140 yet, you are definitely in the wrong manual.
145 is the first place to go, since it will direct you to the correct manual,
146 and it also describes the notation and format of all of the manuals.
147 You should also be thoroughly familiar with the
151 and all of the basic features of LyX.
155 \begin_layout Standard
156 In this document, many sections are independent articles contributed by
157 an individual and are noted as such.
158 This person is generally whoever wrote the layout file for the new document
159 class or LaTeX package, or implemented the feature.
160 If there is no mention of an author to a chapter [or chapter sections],
161 that means it was written by the LyX Documentation Team.
164 \begin_layout Standard
165 Since all the topics in this manual depend heavily on LyX's interaction
166 with LaTeX, this first chapter covers the inner workings of LyX and how
167 to direct LyX to generate exactly the LaTeX code you want.
168 It is obviously for more seasoned LyX users.
171 \begin_layout Chapter
175 \begin_layout Section
179 \begin_layout Standard
180 \begin_inset LatexCommand label
181 name "sec:lyxandlatex"
185 This chapter is for both TeX-nicians and the LaTeX-curious.
186 In it, we'll explain how LyX and LaTeX work together to produce printable
188 This is the only place in any of the manuals where we assume you know something
192 \begin_layout Standard
193 At one time, we called LyX a
194 \begin_inset Quotes eld
197 WYSIWYM frontend to LaTeX,
198 \begin_inset Quotes erd
201 but that's no longer true.
202 There are frontends to LaTeX out there.
203 They are basically editors with the ability to run LaTeX and mark any errors
204 in the file you're editing.
213 run LaTeX, and it also marks errors in the file, it also does much, much
215 Thanks to the WYSIWYM concept, you don't need LaTeX to use LyX effectively.
216 LyX has also added a few extensions to LaTeX.
217 Try the following sometime: select
219 Export\SpecialChar \menuseparator
229 menu, then look at the preamble of the resulting
234 You'll notice a variety of new macros defined specifically by LyX.
235 These macros are defined automatically, according to the features you use
239 \begin_layout Standard
240 There are several commands that automatically invoke LaTeX.
244 \begin_layout Itemize
250 iew\SpecialChar \menuseparator
257 \begin_layout Itemize
263 iew\SpecialChar \menuseparator
268 pdate\SpecialChar \menuseparator
274 \begin_layout Itemize
282 \SpecialChar \menuseparator
288 \begin_layout Itemize
296 \SpecialChar \menuseparator
302 \begin_layout Standard
303 They will only invoke LaTeX if the file has changed since the last time
308 \begin_layout Standard
309 When you run LaTeX on the file you're editing, LyX performs these steps:
312 \begin_layout Enumerate
313 Convert the document to LaTeX and save to a file with the extension
324 \begin_layout Enumerate
329 file (maybe several times).
332 \begin_layout Enumerate
333 If there are any errors, insert error boxes in the document to mark where
335 These boxes are transient and are not saved along with the document.
338 \begin_layout Standard
339 If you've run LaTeX using
361 , LyX performs two more steps:
364 \begin_layout Itemize
369 to convert the DVI file to PostScript:
373 \begin_layout Itemize
379 , the output file has the extension
384 \begin_layout Itemize
393 , the output file has the extension
401 \begin_layout Itemize
406 or send the PostScript file to the printer.
409 \begin_layout Section
410 \begin_inset Quotes eld
413 Help! LyX generated an unreadable
418 \begin_inset Quotes erd
424 \begin_layout Standard
425 Die-hard LaTeX users will scream and howl this into the night, then declare
426 LyX useless, simply because they didn't RTFM.
429 \begin_layout Standard
430 We're going to set the record straight.
431 LyX produces two kinds of LaTeX files.
432 One is human readable.
433 The other is LyX readable.
434 Every time LyX executes LaTeX, it produces a LaTeX file that it can easily
440 file is not human readable.
441 Don't even try to read it.
446 file that you can send to a colleague, select
451 xport\SpecialChar \menuseparator
468 \begin_layout Section
469 Translating LaTeX files into LyX
472 \begin_layout Standard
473 You can import a LaTeX file into LyX by using the
478 ile\SpecialChar \menuseparator
483 mport\SpecialChar \menuseparator
491 This will call a program named
495 ---which will create a file
503 ---and then open that file.
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
521 If you just want to put a piece of LaTeX code into a LyX file, see Section
522 \begin_inset LatexCommand ref
523 reference "sec:latexcodes"
530 \begin_layout Section
531 Inserting LaTeX Code into LyX Documents
532 \begin_inset LatexCommand label
533 name "sec:Inserting-LaTeX-Code"
540 \begin_layout Standard
541 \begin_inset LatexCommand label
542 name "sec:latexcodes"
546 This is a rather important point: You can always insert LaTeX code into
548 LyX simply cannot, and will probably never be able to, display every possible
550 If ever you need to insert LaTeX commands into your LyX document, you can
551 use the ERT box, which you can insert into your document with
556 nsert\SpecialChar \menuseparator
564 The ERT box comes in three forms: collapsed, open, and inlined.
565 The first two are used just like any other collapsible (foldable) box (such
566 as footnotes), and are useful for significant amounts of LaTeX commands.
568 \begin_inset Quotes eld
572 \begin_inset Quotes erd
575 ERT box displays its content as part of the button, and is useful for very
576 short sections of LaTeX commands.
581 \begin_layout Standard
591 \begin_layout Standard
592 You can switch between all three by right-clicking on the ERT.
593 Note that if you want more than one line of LaTeX commands, you cannot
594 use the inlined mode.
597 \begin_layout Standard
598 Here's an example of inserting LaTeX commands in a LyX document.
599 The code looks like this:
602 \begin_layout LyX-Code
611 This is an example for a minipage environment.
614 can put nearly everything in it, even (non-floating)
657 \begin_layout LyX-Code
661 \begin_layout Standard
662 The ERT box containing this text is directly after this paragraph.
663 Those of you reading the manual online will only see a bunch of funky text
665 Those reading a printed version of the manuals will see the actual results:
668 \begin_layout Standard
672 \begin_layout Standard
679 \begin_layout Standard
686 \begin_layout Standard
688 This is an example for a minipage environment.
689 You can put nearly everything in it, even (non-floating) figures and tables.
693 \begin_layout Standard
700 \begin_layout Standard
705 \begin_layout Standard
712 \begin_layout Standard
719 \begin_layout Standard
726 \begin_layout Standard
732 \begin_layout Standard
739 \begin_layout Standard
746 \begin_layout Standard
753 \begin_layout Standard
765 \begin_layout Standard
766 In addition to these two methods, you can also create a separate file containing
767 some complex LaTeX structure.
773 nsert\SpecialChar \menuseparator
781 to include your file (you should select the type
786 We recommend that you only do this if you have a
795 Otherwise, you'll have a big job tracking down LaTeX errors\SpecialChar \ldots{}
799 \begin_layout Standard
800 There are a few last notes to emphasize:
803 \begin_layout Itemize
804 Inside of LyX, LaTeX code appears
809 \begin_layout Itemize
814 check if your LaTeX code is correct.
817 \begin_layout Itemize
818 Beware reinventing the wheel.
821 \begin_layout Standard
822 That last note refers to two things.
823 First, LyX does have quite a few features tucked into it, and more are
825 Be sure to check the manuals to make sure that LyX doesn't have such-and-such
826 feature before you go off merrily coding LaTeX.
827 Second, there are numerous LaTeX packages out there to do all sorts of
828 things, from labels to envelopes to fancy multipage tables.
829 Check out a CTAN site for details (see Section
830 \begin_inset Quotes eld
834 \begin_inset Quotes erd
845 \begin_layout Standard
850 : I seem to do this an awful lot.
851 Sat down and merrily began coding something to print out labels, only to
852 learn that there were already 2 different LaTeX packages to do this.
853 Worse yet --- I had them already!
861 \begin_layout Standard
862 If you do need to do some wild and fancy things within your document, be
863 sure to check out a good LaTeX book for assistance.
864 There are a number of them listed in the bibliography of the
871 \begin_layout Standard
872 There are a number of LaTeX commands which have to be placed before the
873 beginning of the actual text.
874 They go into the preamble, and this is explained in the next section.
877 \begin_layout Section
878 LyX and the LaTeX Preamble
881 \begin_layout Subsection
882 About the LaTeX Preamble
885 \begin_layout Standard
886 \begin_inset LatexCommand label
891 If you already know LaTeX, there is no need to explain here what the preamble
893 If you don't, the following will give you some ideas --- we recommend again
894 that you consult a LaTeX book for further information.
895 In any case, you should read the points below, because they explain what
896 you can do and what you don't need to do in the LaTeX preamble of a LyX
900 \begin_layout Standard
901 The LaTeX preamble comes at the very beginning of a document,
909 \begin_layout Itemize
910 declare the document class.
911 LyX already does this for you.
915 \begin_layout Standard
916 If you're a seasoned LaTeX-nician, and you have some custom document class
917 you want to use, check out the
921 for information on how to make LyX interface to it.
922 Be sure to submit your efforts to the LyX Team for inclusion in future
927 \begin_layout Itemize
928 declare the usage of packages.
929 LaTeX packages provide special commands, which are only available within
930 a document when the package has been declared in the preamble.
931 For example, the package
935 forces all paragraphs to be indented.
936 There are other packages for labels, envelopes, margins, etc.
940 \begin_layout Itemize
941 set counters, variables, lengths and widths.
942 There are several LaTeX counters and variables which
946 be set globally from within the preamble in order to have the desired effect.
947 [There are other variables which you can set and reset inside the document,
948 too.] Margins are a good example of something which must be set in the preamble.
949 Another example is the label format for lists.
950 You can actually set these just about anywhere, but it's best to do it
951 just once, inside the preamble.
954 \begin_layout Itemize
955 declare user defined commands [with
967 ], mostly abbreviations for LaTeX commands which appear very often inside
969 Although the preamble is a good place to declare such commands, they
973 be declared anywhere else [but
977 they are used for the first time, of course\SpecialChar \ldots{}
979 This can be useful if there is a lot of raw LaTeX code in your document,
980 which normally should not be the case.
983 \begin_layout Standard
984 LyX adds its own set of definitions to the preamble of the
989 This makes LaTeX files generated by LyX portable.
992 \begin_layout Subsection
993 Changing the Preamble
996 \begin_layout Standard
997 The commands which LyX adds to the preamble of a LaTeX file are fixed; you
998 can't change them without patching LyX itself.
999 You can, however, add your own stuff to the preamble.
1000 There are two ways to do this:
1003 \begin_layout Enumerate
1030 \SpecialChar \menuseparator
1038 dialog, depending on your frontend.
1039 Note that the LyX keybindings will not work in this dialog, alas.
1042 \begin_layout Enumerate
1043 Use the preamble contents you've added as your default template (see
1044 \begin_inset Quotes eld
1048 \begin_inset Quotes erd
1055 ), so that it will be the default preamble for any file you create.
1058 \begin_layout Standard
1059 LyX adds anything in the
1066 dialog to its own built-in preamble.
1067 Before adding your own declarations in the preamble, you should make sure
1068 that LyX doesn't already support what you want to do (remember what we
1069 said about reinventing the wheel?).
1072 make sure your preamble code is correct
1075 LyX doesn't check it.
1078 \begin_layout Subsection
1082 \begin_layout Standard
1083 Here are some examples of what you can add to a preamble, and what they
1087 \begin_layout Subsubsection
1091 \begin_layout Standard
1092 There are two variables under LaTeX that control page position:
1105 Their names should be self-explanatory.
1106 These variables are useful if you think for a moment about computer labels.
1107 Sometimes, the size of a print medium and the area of the medium that you
1108 can actually print on aren't the same.
1124 \begin_layout Standard
1125 The default values for
1137 are both 0 pt.,\InsetSpace ~
1140 the page isn't shifted.
1143 \begin_layout Standard
1144 Unfortunately, some DVI drivers always seem to shift the page.
1145 We have no idea why, or why the sysadmin hasn't fixed such behavior.
1146 If you're using LyX on a system that you don't personally maintain, and
1147 your sysadmin is a doofus,
1160 Suppose you're left and top margins are always 0.5 inches too big.
1161 You can add this to the preamble:
1164 \begin_layout LyX-Code
1172 \begin_layout LyX-Code
1180 \begin_layout Standard
1181 \SpecialChar \ldots{}
1182 and your margins should now be correct.
1185 \begin_layout Subsubsection
1189 \begin_layout Standard
1190 Speaking of labels, suppose you wanted to print out a bunch of address labels.
1191 There's a rather nice package, available at your nearest CTAN archive,
1192 for printing sheets of labels, called
1197 Now, your system may not have this package installed by default.
1198 We leave that up to you to check.
1199 You'll also want to read the documentation for it; we're not going to do
1201 Since this is an example, however, we'll give you an example of how you
1205 \begin_layout Standard
1206 First, make sure you're using the
1211 Next, you need to put the following in your preamble:
1214 \begin_layout LyX-Code
1220 \begin_layout LyX-Code
1226 \begin_layout LyX-Code
1232 \begin_layout LyX-Code
1238 \begin_layout LyX-Code
1244 \begin_layout LyX-Code
1250 \begin_layout LyX-Code
1256 \begin_layout Standard
1257 This sets things up for Avery® label sheets, stock #5360.
1258 You're now ready to print labels, but you'll need to insert LaTeX code,
1259 placing the commands
1271 around each label text.
1272 This and other special features of
1276 are explained in its documentation.
1279 \begin_layout Standard
1280 Someday, someone may write a LyX layout file to support this package directly.
1281 Maybe that someone is you.
1284 \begin_layout Subsubsection
1285 Example #3: Paragraph Indentation
1288 \begin_layout Standard
1289 Americans are trained to indent the first line of
1294 As with all of their other weird quirks, most Americans will whine and
1295 moan until they can have their way and indent the first line of all paragraphs.
1299 \begin_layout Standard
1304 : This was written by an American ---
1308 ! It's my perception of my fellow countrymen.
1309 Tough if you don't like it.
1318 \begin_layout Standard
1319 Of course, this behavior isn't standard typography.
1320 In books, you typically only indent the first line of a paragraph
1324 it follows another one.
1325 The idea behind indenting the first line of a paragraph is to distinguish
1326 neighboring paragraphs from one another.
1327 If there is no previous paragraph, for example, it follows a figure, or
1328 is the first paragraph in a section, then there is no special indentation.
1332 \begin_layout Standard
1333 If you're a typical American, though, you don't care about such esoteric
1334 things; you want your indentation! Add this to the preamble:
1337 \begin_layout LyX-Code
1340 usepackage{indentfirst}
1343 \begin_layout Standard
1344 If your TeX distribution isn't a braindead one, you'll have this package,
1345 and all of your paragraphs will get the indentation you think they deserve.
1348 \begin_layout Subsubsection
1349 Example #4: This Document
1352 \begin_layout Standard
1353 You can also check out the preamble of this document to get an idea of some
1354 of the advanced things you can do.
1355 You'll probably need to make the
1360 reamble\SpecialChar \ldots{}
1363 dialog full-screen to see most of it.
1364 Also, there are more examples and an assortment of LaTeX
1365 \begin_inset Quotes eld
1369 \begin_inset Quotes erd
1372 given in Chapter\InsetSpace ~
1374 \begin_inset LatexCommand ref
1375 reference "cha:secrets"
1383 \begin_layout Section
1384 LyX and LaTeX Errors
1387 \begin_layout Standard
1388 When LyX calls LaTeX, it tells LaTeX to blithely ignore any errors and keep
1390 It then uses the log-file from the LaTeX run to do a post-mortem.
1391 As we stated earlier in the chapter, LyX generates two kinds of
1395 files, one of which it uses to locate errors in the document.
1396 If there was an error someplace, LyX will put a box with the word
1397 \begin_inset Quotes eld
1401 \begin_inset Quotes erd
1404 at the appropriate place in the document.
1408 \begin_layout Standard
1409 LyX will occasionally misguess where the error was.
1410 This will typically happen with tables, figures, math, and the preamble.
1415 It will also display a message alerting you to the fact that there were
1419 \begin_layout Standard
1420 You can navigate through the errors by using
1436 \begin_inset Quotes eld
1440 \begin_inset Quotes erd
1443 the error-boxes and view the error message LaTeX produced by clicking on
1447 \begin_layout Standard
1448 Some folks also like to look at the log file directly, accessible from
1453 ocument\SpecialChar \menuseparator
1463 There are some fairly common error messages and warnings.
1464 We'll cover those here.
1465 You should look at a good LaTeX book for a complete listing.
1468 \begin_layout Itemize
1469 \begin_inset Quotes eld
1477 \begin_inset Quotes eld
1484 \begin_layout Standard
1485 Anything beginning with these word is a warning message for the purpose
1487 \begin_inset Quotes eld
1491 \begin_inset Quotes erd
1494 the LaTeX code itself.
1495 You'll get messages like this if you added or changed cross-references
1496 or bibliography entries, in which case, LaTeX is trying to tell you that
1497 you need to make another run.
1500 \begin_layout Standard
1501 You can by-and-large ignore these.
1505 \begin_layout Itemize
1506 \begin_inset Quotes eld
1514 \begin_inset Quotes erd
1521 \begin_layout Standard
1522 Another warning message, this time about fonts which LaTeX couldn't find.
1523 The rest of the message will often say something about a replacement font
1527 \begin_layout Standard
1528 You can safely ignore these.
1532 \begin_layout Itemize
1533 \begin_inset Quotes eld
1543 \begin_inset Quotes erd
1550 \begin_layout Standard
1556 They are warning you about lines that were too long and run past the right
1558 Almost always, this is unnoticeable in the final output.
1559 Or, only one or two characters extend past the margin.
1560 LaTeX seems to generate at least one of these messages for just about any
1564 \begin_layout Standard
1565 You can ignore these stupid messages.
1566 Your eyes will tell you if there's a problem with something that's too
1567 wide; just look at the output.
1571 \begin_layout Itemize
1572 \begin_inset Quotes eld
1582 \begin_inset Quotes erd
1589 \begin_layout Standard
1590 Not quite as common as its cousin.
1591 LaTeX seems to like to print lines that are a bit too wide as opposed to
1592 ones that are a bit too narrow.
1593 We have no idea why.
1596 \begin_layout Standard
1597 You can ignore these, too.
1601 \begin_layout Itemize
1602 \begin_inset Quotes eld
1612 \begin_inset Quotes erd
1616 \begin_inset Quotes eld
1626 \begin_inset Quotes erd
1633 \begin_layout Standard
1634 Warnings about troubles breaking the page.
1635 Once again, just look at the output.
1636 Your eyes will tell you where something has gone wrong.
1640 \begin_layout Itemize
1641 \begin_inset Quotes eld
1647 \begin_inset Quotes els
1651 \begin_inset Quotes ers
1657 \begin_inset Quotes erd
1664 \begin_layout Standard
1666 \begin_inset Quotes eld
1670 \begin_inset Quotes erd
1673 isn't installed on this system.
1674 This usually appears because some package your document needs isn't installed.
1675 If you didn't touch the preamble or didn't use the
1681 command, then one of the packages LyX tried to load is missing.
1687 elp\SpecialChar \menuseparator
1694 , to get a list of packages that LyX knows about.
1695 This file is updated whenever you reconfigure LyX (using
1702 \SpecialChar \menuseparator
1707 ) and tells you which packages have been detected and what they do.
1710 \begin_layout Standard
1721 command, and the package in question isn't installed, you'll need to install
1726 \begin_layout Itemize
1727 \begin_inset Quotes eld
1732 LaTeX Error: Unknown option
1735 \begin_inset Quotes erd
1742 \begin_layout Standard
1743 Error messages beginning with this are trying to tell you that you specified
1744 a bad or undefined option to a package.
1745 Check the package's documentation.
1749 \begin_layout Itemize
1750 \begin_inset Quotes eld
1755 Undefined control sequence
1758 \begin_inset Quotes erd
1765 \begin_layout Standard
1766 If you've inserted LaTeX code into your document, but made a typo, you'll
1768 You may have forgotten to load a package.
1769 In any case, this error message usually means that you used an undefined
1774 \begin_layout Standard
1775 There are other error and warning messages.
1776 Some are self-explanatory.
1777 These are usually LaTeX messages.
1778 Others are downright cryptic.
1779 These are actually TeX error messages, and we really have
1783 what they mean or how to decipher them.
1786 \begin_layout Standard
1787 There's a general sequence you should follow if you get error messages:
1790 \begin_layout Enumerate
1791 Look at the LaTeX code you inserted for typos.
1794 \begin_layout Enumerate
1795 If there are no typos, check and see that you used the command(s) correctly.
1798 \begin_layout Enumerate
1799 If you get a bunch of error boxes piled up at the very top of the document,
1800 it means that there are errors in the preamble.
1801 Start debugging your preamble.
1804 \begin_layout Enumerate
1805 If you didn't add anything to the preamble and didn't add any LaTeX code
1806 to the document, the first suspect is your LaTeX distribution itself.
1807 Check for missing packages and install them.
1810 \begin_layout Enumerate
1811 Okay, so there are no missing packages.
1812 Did you use any of the fine-tuning options in LyX? Specifically, did you
1817 any of them, like trying to manually insert lots of
1819 Protected\InsetSpace ~
1830 s? Did you try to kludge something together with these instead of using
1831 the appropriate paragraph environment?
1834 \begin_layout Enumerate
1835 All right, you didn't use any of the fine-tuning options, you played by
1837 Did you try to pull a fancy maneuver? Did you do something funky inside
1838 a table or an equation, like inserting a graphic into a table cell?
1841 \begin_layout Enumerate
1842 Do you have long sections of text where LaTeX cannot find a place to break
1843 a line? By default, LaTeX is rather strict about how much extra inter-word
1844 spacing it will add in order to break a line.
1845 Preferably, you should rework the paragraph to avoid the problem.
1846 If this isn't an option, you can wrap your text in
1852 to make LaTeX's line breaking more, well, sloppy.
1855 \begin_layout Enumerate
1856 Did you go overboard with the nesting? LyX (currently) doesn't check to
1857 make sure you're in the limits for nesting environments.
1858 If you nested a bunch of environments to the
1859 \begin_inset Formula $17^{\mathrm{th}}$
1862 level, that's the problem.
1865 \begin_layout Enumerate
1866 Okay, you didn't get any error messages, but your output looks whacked.
1867 If you have a table or figure that's too wide or long for the page, you
1872 \begin_layout Enumerate
1873 rescale the figure so it fits.
1876 \begin_layout Enumerate
1877 trim down the table so it fits.
1880 \begin_layout Standard
1881 If something else is wrong with the output, and you didn't try to pull anything
1882 fancy or kludge the fine-tuning options, we're not sure what's wrong.
1886 \begin_layout Standard
1887 If all this doesn't help --- well, then
1891 you might have found a bug in LyX\SpecialChar \ldots{}
1895 \begin_layout Chapter
1899 \begin_layout Section
1900 Preparing a Bibliography with BibTeX
1901 \begin_inset LatexCommand label
1902 name "sec:Preparing-a-Bibliography"
1909 \begin_layout Standard
1916 Jürgen Spitzmüller
1919 \begin_layout Standard
1920 \begin_inset VSpace bigskip
1926 \begin_layout Standard
1928 STOP! If you don't know what BibTeX is, or have a reasonably good idea of
1931 e.\InsetSpace \thinspace{}
1935 setting up your own bibliographic databases),
1939 , do not walk, to your nearest copy of the 2nd edition of Lamport's
1941 LaTeX: A Document Preparation System
1943 , particularly Appendix B.
1944 The rest of this discussion assumes you have created a correct bibliography
1945 file, that you have all relevant environment variables set correctly (esp.
1958 ), and that if sufficiently desperate, you could create and
1959 \begin_inset Quotes eld
1963 \begin_inset Quotes erd
1966 a LaTeX file with a BibTeX database.
1970 \begin_layout Standard
1971 For those who don't know what BibTeX is, it is a system for creating a large
1972 database of your most used journal references.
1973 For all future articles you write, you only need to include this standard
1974 database and reference the appropriate key to each reference.
1975 Even if you write only a few papers with handful of references each, it
1976 is well worth your time to examine BibTeX and decide whether it will be
1980 \begin_layout Standard
1981 To use BibTeX with LyX, first read the
1985 where it describes how to insert citations.
1986 The basic mechanism for inserting BibTeX references is the same.
1987 Then, at the very end of your document, select
1989 Insert\SpecialChar \menuseparator
1994 TOC\SpecialChar \menuseparator
1998 In the resulting dialog, fill out the dialog boxes as follows:
2001 \begin_layout Description
2002 Database: enter the name of your
2015 For searching multiple
2019 files, just enter them in the desired order, separated by commas.
2023 \begin_layout Description
2024 Style: enter the name of your BibTeX style file *without* the
2029 The default style is
2033 (which should be included in your LaTeX distribution, so you don't have
2034 to worry about creating it).
2037 \begin_layout Standard
2038 For each citation, assuming that the source is in the
2047 nsert\SpecialChar \menuseparator
2054 at the correct location in the text, and enter the appropriate reference
2056 Nothing else is required; when invoking
2061 iew\SpecialChar \menuseparator
2068 , for example, you should see that BibTeX and LaTeX are invoked as needed,
2069 including multiple invocations of LaTeX.
2073 \begin_layout Subsection
2074 Alternative Citation Styles
2077 \begin_layout Standard
2078 Standard BibTeX uses numbers (e.\InsetSpace \thinspace{}
2079 g.\InsetSpace \space{}
2081 \begin_inset Quotes eld
2085 \begin_inset Quotes erd
2088 ) to refer to a cited work.
2089 However, in many scientific disciplines, other citation styles are in use.
2090 The most common one is the author-year style (e.\InsetSpace \thinspace{}
2091 g.\InsetSpace \space{}
2093 \begin_inset Quotes eld
2097 \begin_inset Quotes erd
2101 LyX supports two packages that provide this style,
2110 Both packages have their own pros and cons, which cannot be listed in detail.
2111 If you only want to have simple author-year (or author-numerical) style
2112 or if you want to use one of the countless style files for natbib, than
2117 package is probably your choice.
2118 If you need special features like short title references, ibidem etc., you
2119 might consider the fairly new
2126 \begin_layout Standard
2127 The handling of both packages in LyX is basically the same.
2133 ocument\SpecialChar \menuseparator
2144 pane (with the xforms frontend: the
2158 With both packages, you will get some extra features in the citation dialog
2159 and you can select the style of the reference (
2160 \begin_inset Quotes eld
2164 \begin_inset Quotes erd
2168 \begin_inset Quotes eld
2172 \begin_inset Quotes erd
2176 \begin_inset Quotes eld
2180 \begin_inset Quotes erd
2184 \begin_inset Quotes eld
2188 \begin_inset Quotes erd
2192 Note that both packages need specifically designed style files (they both
2193 ship their own, while there are lots of additional style files and even
2194 an interactive style file builder
2198 \begin_layout Standard
2200 \begin_inset LatexCommand url
2201 target "ftp://ctan.tug.org/tex-archive/macros/latex/contrib/custom-bib/"
2217 \begin_layout Subsection
2218 Sectionated Bibliographies
2219 \begin_inset LatexCommand label
2220 name "sub:Sectionated-Bibliographies"
2227 \begin_layout Standard
2228 Sometimes you might need to divide your bibliography into several sections.
2229 If you are, for instance, a historian, the possibility to separate sources
2230 and scientific works is most likely a
2231 \begin_inset Quotes eld
2235 \begin_inset Quotes erd
2239 Unfortunately, BibTeX itself does not allow you to do this.
2240 The good news is, though: With the help of some LaTeX packages, BibTeX
2241 can be extended to fit your historical needs.
2244 \begin_layout Standard
2245 As of version 1.4, LyX provides native support for one of these packages,
2254 \begin_layout Standard
2256 \begin_inset LatexCommand url
2257 target "ftp://ctan.tug.org/tex-archive/macros/latex/contrib/bibtopic/"
2266 The advantage of this package (compared to other packages like
2270 ) is that you don't need to define new citation commands.
2271 Instead, you need to prepare different bibliographic databases which include
2272 the entries for the different sections of the bibliography.
2273 For example: If you want to divide your bibliography into the sections
2275 \begin_inset Quotes eld
2279 \begin_inset Quotes erd
2283 \begin_inset Quotes eld
2287 \begin_inset Quotes erd
2290 , you first need to create two bibliographic databases, e.\InsetSpace \thinspace{}
2291 g.\InsetSpace \space{}
2304 \begin_layout Standard
2310 ocument\SpecialChar \menuseparator
2321 pane (with the xforms frontend: the
2328 Sectionated\InsetSpace ~
2332 Now you can insert multiple BibTeX references (as described in section\InsetSpace ~
2334 \begin_inset LatexCommand ref
2335 reference "sec:Preparing-a-Bibliography"
2339 ), one for each section of your bibliography.
2340 Returning to our example: Insert a BibTeX reference for the database
2344 and a second one for the database
2349 You are free to use the same or different styles for each section.
2350 Additionally, you can chose if the bibliography section should contain
2352 \begin_inset Quotes eld
2355 all cited references
2356 \begin_inset Quotes erd
2359 of the specified database(s) (which is the default),
2360 \begin_inset Quotes eld
2363 all uncited references
2364 \begin_inset Quotes erd
2368 \begin_inset Quotes eld
2372 \begin_inset Quotes erd
2376 This might be useful if you would like to separate your bibliography into
2378 \begin_inset Quotes eld
2382 \begin_inset Quotes erd
2386 \begin_inset Quotes eld
2390 \begin_inset Quotes erd
2394 \begin_inset Quotes eld
2398 \begin_inset Quotes erd
2402 The titles for the sections can be added as ordinary sections or subsections.
2407 removes the bibliography title, you have manually re-add that, too (as
2408 a chapter* or section*, for instance).
2411 \begin_layout Subsection
2412 Multiple Bibliographies
2415 \begin_layout Standard
2416 Multiple bibliographies, e.\InsetSpace \thinspace{}
2417 g.\InsetSpace \space{}
2418 a bibliography for each section or chapter of
2419 the document, are not supported by BibTeX itself.
2424 package, which is used for the creation of sectionated bibliographies in
2425 LyX (cf.\InsetSpace ~
2426 section\InsetSpace ~
2428 \begin_inset LatexCommand ref
2429 reference "sub:Sectionated-Bibliographies"
2433 ), provides an easy way to solve this task, if you are willing to use some
2434 LaTeX-Code (ERT, cf.\InsetSpace ~
2435 section\InsetSpace ~
2437 \begin_inset LatexCommand ref
2438 reference "sec:Inserting-LaTeX-Code"
2446 \begin_layout Standard
2447 An alternative approach is to use the
2455 package, respectively.
2463 \begin_layout Standard
2469 ocument\SpecialChar \menuseparator
2480 pane (with the xforms frontend: the
2487 Sectionated\InsetSpace ~
2491 In the document, you have to enclose the sections, which shall contain
2492 their own bibliography (including the BibTeX reference itself), between
2505 (those commands have to be inserted as ERT).
2506 The bibliography will contain all references which have been cited in the
2508 N.\InsetSpace \thinspace{}
2509 B.: If you are using this approach, then
2513 citation reference has to be inside some btUnit.
2514 Also, the btUnits cannot be nested.
2517 \begin_layout Section
2521 \begin_layout Standard
2522 A good index is one of the hardest things to make in a lengthy document,
2523 but LyX helps make things a bit simpler by interfacing to the
2527 program which is found in most recent LaTeX distributions.
2531 \begin_layout Standard
2551 Outputs\SpecialChar \menuseparator
2552 LaT\SpecialChar \textcompwordmark{}
2561 section of the preferences dialog, however, you can customize the index
2562 command, if you prefer an alternative program like
2585 Inserting an index and marking words to include in it works much the same
2586 way as preparing a bibliography as mentioned in the last section.
2589 \begin_layout Standard
2590 First, go to the end of your file and select
2595 nsert\SpecialChar \menuseparator
2606 C\SpecialChar \menuseparator
2619 Then, for each word you would like to include in the index, go to the end
2620 of that word and click on
2625 nsert\SpecialChar \menuseparator
2638 This will insert a tag showing the word as it will appear in the index.
2639 That's all there is to it; LyX will automatically call
2643 for you and create the index itself.
2644 The text in the dialog available from right-clicking on the index button
2645 accepts LaTeX, so you'll need to be careful to avoid using any special
2647 On the positive side, you can use the advanced options - have a look at
2648 the documentation which comes with your LaTeX distribution to find out
2649 how to do things like
2650 \begin_inset Quotes eld
2654 \begin_inset Quotes erd
2660 \begin_layout Standard
2661 Be careful not to put spaces between the word in the text and the index
2662 marker; apparently the wrong page number can be produced if this happens.
2665 \begin_layout Section
2669 \begin_layout Standard
2672 Özgür Ug̃raş Baran
2675 \begin_layout Standard
2676 Sometimes you need to compile a list of symbols that are mentioned in your
2677 document with a brief explanation of them.
2678 A LaTeX package named
2682 provides an easy way of compiling such lists.
2687 is included in most standard Linux distributions.
2688 If your distribution doesn't contain it, you should download it from a
2689 CTAN mirror and install the package in order to use this feature of LyX.
2692 \begin_layout Standard
2693 A glossary entry is created if you place the cursor after a symbol entry
2694 and then use the menu
2696 Insert\SpecialChar \menuseparator
2697 Glossary\InsetSpace ~
2702 \begin_inset Quotes eld
2710 \begin_inset Quotes erd
2713 is inserted and a window pops up asking for the glossary entry.
2714 A glossary entry consists of two main entries.
2715 The first is the symbol that you want to refer to.
2716 You should enter a valid LaTeX code for the corresponding field in the
2718 The second is the description of the symbol.
2719 You should fill the corresponding field to complete the glossary entry.
2722 \begin_layout Subsection
2723 Sort Order of Glossary Entries
2726 \begin_layout Standard
2727 Suppose you have two glossary entries for the symbols
2728 \begin_inset Formula $a$
2732 \begin_inset Formula $\sigma$
2740 package automatically sorts these two entries considering the symbol entry,
2741 while printing the Glossary.
2742 However, this can lead to an undesired sort order.
2743 For the example given, the first entry appears as
2747 , while the second is
2754 Note that, in this case
2755 \begin_inset Formula $\sigma$
2758 is located in front of the
2759 \begin_inset Formula $a$
2762 , since the character
2763 \begin_inset Quotes eld
2769 \begin_inset Quotes erd
2772 is considered in sorting.
2773 In order to control the sort order, you can edit the
2778 field of the glossary dialog.
2779 For the given example, you can edit this field as
2788 Then, these entries will be effective in the sort ordering and
2789 \begin_inset Formula $a$
2792 will be located before
2793 \begin_inset Formula $\sigma$
2799 \begin_layout Standard
2800 This feature provides exciting ways of ordering the entries.
2801 For subgrouping and tips for using sort entries see the official nomencl
2805 \begin_layout Subsection
2809 \begin_layout Standard
2810 You can turn on referencing to the equations and pages in the glossary entries.
2811 For this purpose, you should add referencing options commands at the end
2812 of description field.
2813 There are six referencing options in nomencl package:
2816 \begin_layout Paragraph*
2822 \begin_layout Standard
2823 Adds reference to the equation by adding the phrase
2824 \begin_inset Quotes eld
2828 \begin_inset Quotes erd
2834 \begin_layout Paragraph*
2840 \begin_layout Standard
2841 Adds reference to the page by adding the phrase
2842 \begin_inset Quotes eld
2846 \begin_inset Quotes erd
2852 \begin_layout Paragraph*
2858 \begin_layout Standard
2859 Is the short notation of
2866 \begin_layout Paragraph*
2876 \begin_layout Standard
2877 Turns off corresponding referencing options if they are turned on globally
2878 (see reference documentation of nomencl).
2881 \begin_layout Subsection
2885 \begin_layout Standard
2886 You can insert the glossary with the menu
2888 Insert\SpecialChar \menuseparator
2890 &TOC\SpecialChar \menuseparator
2894 A light blue box labeled
2895 \begin_inset Quotes eld
2903 \begin_inset Quotes erd
2906 will show the place where the index is printed in the output.
2907 The index list box is not clickable like other LyX-boxes.
2908 In the printed output the title of the glossary appears as
2916 \begin_layout Standard
2917 This is translated to the document language for a small number of languages,
2918 amongst others French and German
2924 If you are not happy with the title, you can change it by re-defining the
2932 For example, in order to change the title
2940 add the following line to the preamble.
2943 \begin_layout LyX-Code
2948 nomname}{List of Symbols}
2951 \begin_layout Standard
2952 If you're unhappy with the amount of space for symbols, you can alter it
2953 by adding following line to the preamble.
2956 \begin_layout LyX-Code
2961 nomlabelwidth}{3.0cm}
2964 \begin_layout Section
2968 \begin_layout Subsection
2972 \begin_layout Standard
2973 When you are working on a large file with many sections, it is often convenient
2974 to break up the document into several files, or perhaps you have something
2975 where a table may change from time to time, but the preceding text does
2977 In these cases, you should seriously consider using multipart documents.
2978 For example, scientific papers often have five major sections: the introduction
2979 , observations, results, discussion, and conclusion.
2980 Each of these could be its own separate LyX file, with one
2981 \begin_inset Quotes eld
2985 \begin_inset Quotes erd
2988 file which contains the title, authors, abstract, references, etc., plus
2989 the five included files.
2990 It is important to note that each of these files is a full LyX file which
2991 can be formatted and printed on its own, as well as included in a master
2993 Each of these files must have the same document class, however--- don't
2994 attempt to mix book classes with article classes.
2995 You may also include LaTeX files; however, these files must not have their
3001 everything up to and including the
3013 line must be deleted) or else errors will be generated when you try to
3017 \begin_layout Standard
3018 LyX allows you to include files quite easily with
3023 nsert\SpecialChar \menuseparator
3032 When you click on this selection a small box is inserted into the file
3033 at the current cursor location.
3034 Clicking on the box raises a dialog which allows you to select the file
3035 to be included, and the method of its inclusion.
3039 \begin_layout Standard
3040 The file selection box should by now be obvious.
3041 The three inclusion methods are
3042 \begin_inset Quotes eld
3046 \begin_inset Quotes erd
3050 \begin_inset Quotes eld
3054 \begin_inset Quotes erd
3058 \begin_inset Quotes eld
3062 \begin_inset Quotes erd
3066 The difference between
3067 \begin_inset Quotes eld
3071 \begin_inset Quotes erd
3075 \begin_inset Quotes eld
3079 \begin_inset Quotes erd
3082 is really only meaningful to LaTeXperts, but the practical difference is
3083 that files which are
3084 \begin_inset Quotes eld
3088 \begin_inset Quotes erd
3091 are typeset beginning on a new page, while files which are
3092 \begin_inset Quotes eld
3096 \begin_inset Quotes erd
3099 are typeset starting on the current page.
3100 Perhaps the labeling in LyX will be changed someday to reflect this.
3103 \begin_layout Standard
3104 Generally, the master file is converted into a full LaTeX file before typesettin
3105 g, while the included files are converted to LaTeX files which do not have
3106 all the preamble information.
3116 button prevents this conversion.
3119 \begin_layout Standard
3121 \begin_inset Quotes eld
3125 \begin_inset Quotes erd
3128 included file allows you to include a file typeset exactly as it appears
3129 in the file, i.e.\InsetSpace ~
3130 verbatim mode, with the characters set in a fixed-width
3132 Normally, spaces in this file are invisible, though two consecutive spaces
3133 are conserved, unlike LyX's normal treatment of spaces.
3134 However, setting the
3144 checkbox typesets a mark to unambiguously define the presence of a space.
3148 \begin_layout Subsection
3149 Cross-References Between Files
3152 \begin_layout Standard
3153 It is possible to set up cross-references between the different files.
3154 First, open all the files in question: let's call them A and B in a two
3155 file example, where B is included in A.
3156 Let's say you insert a label in A, then want to reference it in B.
3157 Open the cross-reference dialog in whilst in document B, and you can select
3159 \begin_inset Quotes eld
3163 \begin_inset Quotes erd
3169 \begin_layout Section
3170 Fancy Headers and Footers
3173 \begin_layout Standard
3174 The default page layout is rather plain; for an article document class,
3175 all you get is a centered page number at the bottom of the page.
3176 This document is the book class, so it appears to be a bit fancier, but
3177 to really put on a show, you need to set the document page style to
3178 \begin_inset Quotes eld
3182 \begin_inset Quotes erd
3185 , as mentioned in the
3191 This section describes the LaTeX codes you need to insert in your LaTeX
3192 preamble or the text in order to get the desired effects.
3195 \begin_layout Standard
3196 The page header is divided into three fields, not surprisingly labeled
3197 \begin_inset Quotes eld
3201 \begin_inset Quotes erd
3205 \begin_inset Quotes eld
3209 \begin_inset Quotes erd
3213 \begin_inset Quotes eld
3217 \begin_inset Quotes erd
3221 The footer is also divided into these three fields.
3222 The LaTeX commands to set these fields in the simplest manner are
3247 Suppose you wish to put your name in the upper left hand corner of each
3249 Simply insert the following command in the preamble:
3252 \begin_layout Standard
3261 \begin_layout Standard
3262 You will now see your name in the upper left.
3263 If a field has a default entry that you would like to get rid of (often
3264 the page number appears in the central footer, simply include a command
3265 with a blank argument, e.\InsetSpace \thinspace{}
3269 \begin_layout Standard
3277 \begin_layout Standard
3278 Let's get really fancy: lets put the section number with the word
3279 \begin_inset Quotes eld
3283 \begin_inset Quotes erd
3286 (e.\InsetSpace \thinspace{}
3288 Section 3) in the upper left, the page number (e.\InsetSpace \thinspace{}
3290 Page 4) in the upper
3291 right, your name in the lower left, and the date in the lower right.
3292 The following commands should now appear in the preamble:
3295 \begin_layout Standard
3305 \begin_layout Standard
3313 \begin_layout Standard
3323 \begin_layout Standard
3332 \begin_layout Standard
3340 \begin_layout Standard
3350 \begin_layout Standard
3363 access LaTeX's section and page counters, and so print out the current
3364 section and page numbers.
3371 simply prints out today's date.
3374 \begin_layout Standard
3375 The thicknesses of the horizontal rules drawn beneath the header and above
3376 the footer can also be modified.
3377 If you don't want one of the headers, set its thickness to 0.
3378 The header rule has a default thickness of 0.4pt, the footer rule is 0pt.
3379 Use the commands, e.\InsetSpace \thinspace{}
3387 headrulewidth}{0.4pt}
3395 footrulewidth}{0.4pt}
3397 to set the thicknesses.
3400 \begin_layout Standard
3401 You can switch the header/footer settings on and off for individual pages
3406 thispagestyle{empty}
3412 thispagestyle{plain}
3418 thispagestyle{fancy}
3421 Simply insert them in the text on the page you want changed and mark them
3423 In fact, title pages are marked as plain by default, while following pages
3424 are marked fancy when using the global fancy setting.
3427 \begin_layout Standard
3428 There are more complex commands which will let you insert things in the
3429 upper left on odd numbered pages, etc., but I will refer you to the
3433 package documentation for more descriptions.
3434 For example, if you have a teTeX installation, look for
3436 /usr/share/texmf/doc/latex/fancyhdr/\SpecialChar \-
3442 \begin_layout Standard
3443 As a final example, it is possible to include an Encapsulated PostScript
3444 file in the header or footer.
3445 Suppose you want to put a company logo in the upper lefthand corner.
3446 You might try something like
3449 \begin_layout Standard
3458 includegraphics{logo.eps}}}
3461 \begin_layout Standard
3463 (you may need to preface this with
3467 usepackage{graphics}
3469 if you don't include EPS files elsewhere in your document).
3472 \begin_layout Section
3473 Itemize Bullet Selection
3474 \begin_inset LatexCommand label
3482 \begin_layout Standard
3488 \begin_layout Subsection
3492 \begin_layout Standard
3493 LyX provides 216 bullet shapes that can be accessed from a simple dialog.
3494 Using this dialog you can easily specify what bullet shape to use at each
3495 level of an itemized list.
3496 These settings are document-wide so you won't be able to specify different
3497 sets of bullets for different paragraphs
3501 \begin_layout Standard
3502 Well, actually you can but you'll have to do it by hand.
3510 \begin_layout Subsection
3514 \begin_layout Standard
3515 Open the dialog by selecting the
3520 ocument\SpecialChar \menuseparator
3527 menu item and then select the
3537 \begin_layout Standard
3538 The dialog provides you with a table of bullet shapes.
3539 A column of buttons on the left of the table provides access to the six
3540 different panels of bullet shapes.
3541 The row of buttons across the top is used to select which bullet depth
3543 A text entry under the table shows the currently selected bullet shape's
3544 LaTeX equivalent and this can be edited if desired.
3545 If you do modify the text you will also need to specify any needed packages
3546 in the LaTeX preamble.
3549 \begin_layout Standard
3550 The six panels are divided up by the packages they require.
3551 The following table shows the mappings from button name to LaTeX packages.
3554 \begin_layout Standard
3556 \begin_inset Tabular
3557 <lyxtabular version="3" rows="7" columns="2">
3559 <column alignment="center" valignment="top" leftline="true" width="0pt">
3560 <column alignment="center" valignment="top" leftline="true" rightline="true" width="0pt">
3561 <row topline="true" bottomline="true">
3562 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
3565 \begin_layout Standard
3580 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
3583 \begin_layout Standard
3599 <row topline="true">
3600 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
3603 \begin_layout Standard
3618 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
3621 \begin_layout Standard
3636 <row topline="true">
3637 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
3640 \begin_layout Standard
3655 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
3658 \begin_layout Standard
3674 <row topline="true">
3675 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
3678 \begin_layout Standard
3693 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
3696 \begin_layout Standard
3712 <row topline="true">
3713 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
3716 \begin_layout Standard
3731 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
3734 \begin_layout Standard
3750 <row topline="true">
3751 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
3754 \begin_layout Standard
3769 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
3772 \begin_layout Standard
3788 <row topline="true" bottomline="true">
3789 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
3792 \begin_layout Standard
3807 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
3810 \begin_layout Standard
3833 \begin_layout Standard
3834 LyX doesn't stop you using bullets from packages you don't have.
3835 If you get errors from LaTeX when you try to view or print the file then
3836 its likely you are missing a package.
3837 LyX doesn't restrict your use since you may be editing locally and exporting
3841 \begin_layout Subsection
3845 \begin_layout Standard
3846 Select which bullet depth you want to change then select the bullet shape
3848 Any changes will not be visible in LyX, but are visible when viewing the
3849 document using xdvi or ghostview.
3852 \begin_layout Standard
3853 You can reset a bullet shape to the default simply by clicking your right
3854 mouse button on the appropriate bullet depth button.
3857 \begin_layout Standard
3862 want to have multiple sets of paragraphs with different sets of bullets
3863 in each then you're going to have to get your hands dirty.
3864 The itemize bullet selection dialog can help though because it provides
3865 you with the LaTeX code for a wide range of bullet shapes.
3866 To make your own custom paragraphs you have the following options:
3869 \begin_layout Standard
3873 \begin_layout Standard
3889 \begin_layout Standard
3893 \begin_layout Standard
3915 \begin_layout Itemize
3916 Use the LaTeX command
3922 to specify a new bullet shape for a given depth.
3923 You'll also need to save the current bullet shape so you can restore it
3925 In this itemized list the following LaTeX code was used to change the bullet
3926 used for the first depth.
3958 Note that the itemize depth is specified in Roman numerals as part of the
3968 \begin_layout Itemize
3972 \begin_layout Standard
3985 Specify each individual entry by starting each item with the bullet shape
3986 enclosed in square brackets and set as TeX.
3987 For example, this item was started with
4000 \begin_layout Standard
4004 \begin_layout Standard
4020 \begin_layout Standard
4021 You'll also need to revert the labelitem back to its previous setting for
4022 the global bullet shape settings to remain in effect.
4023 The way used here was:
4036 \begin_layout Chapter
4037 Special Document Classes
4040 \begin_layout Section
4044 \begin_layout Standard
4050 \begin_layout Standard
4051 \begin_inset VSpace bigskip
4057 \begin_layout Standard
4059 The AMS LaTeX layouts are set up to conform to suggested styles for mathematical
4060 papers to be submitted to American Mathematical Society publications.
4061 The layouts are not tailored to a specific journal, but easily can be.
4062 You should refer to the AMS documentation for specific instructions for
4063 each journal (usually it will entail only changing a single line in the
4065 That documentation is available on the Web at
4066 \begin_inset LatexCommand url
4067 target "http://www.ams.org"
4072 \begin_inset LatexCommand url
4073 target "ftp://ftp.ams.org/pub/tex/amslatex/"
4077 .These layouts are appropriate, and useful, for any mathematical writing.
4078 There are currently 4 distinct AMS LaTeX layouts:
4081 \begin_layout Enumerate
4082 amsart: The standard AMS-article format.
4083 All results and similar statements are numbered as
4084 \begin_inset Formula $(n.m)$
4087 , where the first number refers to the section, and the second refers to
4088 the total number of results (Theorems, Corollaries, Propositions, Definitions
4089 and Remarks, etc.) in that section.
4090 There are also many (but not all) environments available unnumbered, which
4091 is occasionally needed.
4092 Unnumbered environments indicated by an asterisk at the end.
4095 \begin_layout Enumerate
4096 amsart-seq: Here, numbering for each type of statement is in its own sequence,
4097 with no reference to the section number.
4098 There are also many (but not all) environments available unnumbered, which
4099 is occasionally needed.
4100 Unnumbered environments indicated by an asterisk at the end.
4103 \begin_layout Enumerate
4104 amsart-plain: This one is even more terse, since all the environments are
4108 \begin_layout Enumerate
4109 amsbook: the standard AMS book (really, monograph) format.
4110 Numbering is similar to the amsart layout, except that all numbering is
4112 \begin_inset Formula $(n.m.p)$
4115 , where the first number refers to the chapter, the second to the section,
4116 and the third is the number of the results (Theorems, Corollaries, Propositions
4117 , Definitions and Remarks, etc.) in that section.
4118 There are also many (but not all) environments available unnumbered, which
4119 is occasionally needed.
4120 Unnumbered environments indicated by an asterisk at the end.
4123 \begin_layout Standard
4124 Any AMS LyX file can be converted to either of the numbering schemes by
4125 simply changing the document class in the
4130 ocument\SpecialChar \menuseparator
4141 \begin_layout Subsection
4142 What these layouts provide
4145 \begin_layout Standard
4146 There is a long list of included environments provided by these layouts.
4147 Most mathematical papers or books will set as special statements most of
4148 these environments, in AMS-LaTeX there is an opportunity to define an unlimited
4149 variety of such declarations.
4150 However, the AMS recommends the environments that are available in LyX.
4151 The list of environments (not counting the standard environments such as
4154 sections, bibliography, title, author, date
4159 \begin_layout Description
4160 Theorem This is typically used for the statements of major results.
4162 \begin_inset Quotes eld
4170 \begin_inset Quotes erd
4173 appears in bold type, along with an automatically-determined number (an
4178 , is also available).
4179 The text is italicized.
4182 \begin_layout Description
4183 Corollary This is used for statements which follow fairly directly from
4184 previous statements.
4185 Again, these can be major results.
4193 \begin_layout Description
4194 Lemma These are smaller results needed to prove other statements.
4197 \begin_layout Description
4198 Proposition These are less major results which (hopefully) add to the general
4199 theory being discussed.
4202 \begin_layout Description
4203 Conjecture These are statements provided without justification, which the
4204 author does not know how to prove, but which seem to be true (to the author,
4208 \begin_layout Description
4209 Criterion A required condition.
4212 \begin_layout Description
4213 Algorithm A general procedure to be used.
4216 \begin_layout Description
4217 Axiom This is a property or statement taken as true within the system being
4221 \begin_layout Description
4222 Definition Guess what this is for.
4223 The font, both on-screen and in the output, is different for this environment
4224 than for the previous ones.
4226 \begin_inset Quotes eld
4230 \begin_inset Quotes erd
4233 ) is still set in boldface, along with the number, if any, but the rest
4237 \begin_layout Description
4238 Example Typeset similarly to Definition.
4241 \begin_layout Description
4245 \begin_layout Description
4249 \begin_layout Description
4253 \begin_layout Description
4254 Remark This environment is also a new type of theorem.
4255 This is set with the word Remark in italics, and the rest upright.
4258 \begin_layout Description
4259 Note Set similarly to the Remark environment.
4262 \begin_layout Description
4266 \begin_layout Description
4270 \begin_layout Description
4274 \begin_layout Description
4278 \begin_layout Description
4279 Case Generally, these are used to break up long arguments, using specific
4280 instances of some condition.
4281 The numbering scheme for cases is on its own, not together with other numbered
4286 \begin_layout Description
4290 \begin_layout Description
4294 \begin_layout Description
4296 \begin_inset Quotes eld
4304 \begin_inset Quotes erd
4307 is set in italics, but the rest is set upright.
4308 At the end of this environment (other environments can be nested within
4309 this one, of course) a QED symbol (usually a square, but it can vary with
4310 different styles) is placed.
4313 \begin_layout Description
4314 Address This should be the author's permanent address.
4317 \begin_layout Description
4318 Current\InsetSpace ~
4319 Address This should be the author's temporary address at the time
4320 of submission, if different from the Address.
4323 \begin_layout Description
4324 Email Author's e-mail address
4327 \begin_layout Description
4328 URL Author's Web address, if desired.
4331 \begin_layout Description
4332 Keywords Key words or phrases used to identify specific topics discussed
4336 \begin_layout Description
4337 Subjectclass These refer to the AMS Subject Classifications, published and
4340 Mathematical Reviews
4343 These are also available online at the AMS cites listed above.
4346 \begin_layout Description
4350 \begin_layout Description
4354 \begin_layout Description
4358 \begin_layout Standard
4359 In addition, these environments automatically provide the AMS LaTeX and
4361 They need to be available on your system in order to use these environments.
4364 \begin_layout Section
4368 \begin_layout Standard
4373 can be used to type letters according to German conventions.
4374 A template file is included in
4376 .../lyx/share/templates
4378 for you to use as a starting point.
4381 \begin_layout Section
4385 \begin_layout Standard
4390 provides an alternative to the standard
4395 It provides similar functionality, but you might prefer this layout with
4396 sans serif sections, headings, and more.
4399 \begin_layout Section
4403 \begin_layout Standard
4409 \begin_layout Subsection
4413 \begin_layout Standard
4414 This section describes how LyX can be used to write articles for submission
4415 to the scientific journal
4417 Astronomy and Astrophysics
4420 \begin_inset LatexCommand url
4421 name "www.edpsciences.fr/aa/"
4422 target "http://www.edpsciences.fr/aa/"
4426 ) using Version 5.01 of the document class
4431 This package can be downloaded from the ftp site
4434 \begin_layout Standard
4435 \begin_inset VSpace medskip
4441 \begin_layout Standard
4443 \begin_inset LatexCommand url
4444 target "ftp://ftp.edpsciences.org/pub/aa/readme.html"
4451 \begin_layout Standard
4452 \begin_inset VSpace medskip
4458 \begin_layout Standard
4459 A manual comes together with that package, and this text is not meant to
4460 replace the original manual but merely a short guide how to realize the
4461 correct form of your paper.
4465 \begin_layout Standard
4466 Please note that the publisher of the journal was changed from Springer
4467 to EDP Sciences starting January 1, 2001.
4468 That change implicated also some slight changes of the style files, namely
4469 the removal of the thesaurus command.
4470 The LyX class aa supports the newest version of these style files, V 5.01.
4471 If you have an older version installed, please upgrade.
4472 For compatibility, the old (version 4) layout has been kept as
4477 Please refer to the comments in
4479 LyXDir/layouts/aapaper.layout
4484 \begin_layout Subsection
4488 \begin_layout Standard
4489 It is recommended you start from the example template distributed with LyX.
4490 If you are not using a template, note the following settings:
4493 \begin_layout Itemize
4503 ocument\SpecialChar \menuseparator
4510 dialog (OK, that one was obvious).
4513 \begin_layout Itemize
4514 Don't change the option
4524 The whole layout is done by the macros, you shouldn't change anything.
4527 \begin_layout Subsection
4531 \begin_layout Standard
4532 First thing to enter is the header information.
4533 It consists of seven entries, of which some are optional.
4537 \begin_layout Itemize
4545 \begin_layout Itemize
4553 \begin_layout Itemize
4561 \begin_layout Itemize
4569 \begin_layout Itemize
4574 : [optional] if more than one author: whom to contact for offprint requests.
4577 \begin_layout Itemize
4582 : [optional] mail address for contacts.
4585 \begin_layout Itemize
4593 Received: <date>; Accepted <date>
4596 \begin_layout Standard
4597 There is no need to issue the
4603 command, this is done automatically by LyX when the header is finished.
4604 Although the order of the single header entries doesn't matter it is advised
4605 to keep the above sequence, just to get the best optics and meets the layout
4606 of the real document.
4609 \begin_layout Standard
4610 If you want to place footnotes in the header block, e.\InsetSpace \thinspace{}
4615 \begin_layout Standard
4624 to state your present address, just use the standard footnote via
4629 nsert\SpecialChar \menuseparator
4637 LyX will automagically use the term
4646 \begin_layout Standard
4647 In addition to these topics, the macros use three additional LaTeX commands
4648 that have no counterpart in LyX:
4651 \begin_layout Itemize
4658 to separate different names for more than one author and institute, respectivel
4662 \begin_layout Itemize
4669 to mark corresponding author/institute pairs.
4670 The institutes are numbered sequentially as they appear in the
4674 field, so you have to put a marker to each author.
4677 \begin_layout Itemize
4684 to supply an email address for fast contact.
4687 \begin_layout Standard
4688 In all cases, the appropriate command has to be entered in LyX and marked
4694 \begin_layout Subsection
4698 \begin_layout Standard
4699 The abstract should immediately follow the header block.
4700 With version 5 the abstract environment was changed to a command, and there
4701 is now a resctriction to only one paragraph.
4702 In addition, it should contain an entry with the keywords.
4703 This is not yet implemented for LyX, therefore you have to enter the LaTeX
4710 by hand and mark it as LaTeX code.
4711 Refer to the example paper.
4714 \begin_layout Subsection
4715 Supported environments
4718 \begin_layout Standard
4719 The A&A paper layout supports the following environments for structuring
4723 \begin_layout Itemize
4729 \begin_layout Itemize
4735 \begin_layout Itemize
4741 \begin_layout Itemize
4747 \begin_layout Itemize
4753 \begin_layout Itemize
4759 \begin_layout Itemize
4765 \begin_layout Itemize
4771 \begin_layout Itemize
4777 \begin_layout Itemize
4783 \begin_layout Itemize
4789 \begin_layout Itemize
4795 \begin_layout Subsection
4796 Commands not supported by LyX
4799 \begin_layout Standard
4800 Some commands are not yet supported by the
4805 Some have already been mentioned.
4806 For the sake of completeness, they are listed all together here:
4809 \begin_layout Itemize
4817 \begin_layout Itemize
4825 \begin_layout Itemize
4833 \begin_layout Itemize
4841 \begin_layout Itemize
4849 \begin_layout Itemize
4857 \begin_layout Itemize
4865 \begin_layout Itemize
4873 \begin_layout Standard
4874 If you want to use any of these commands, you have to enter them yourself.
4877 Do not forget to mark them as LaTeX code!
4880 \begin_layout Subsection
4881 Figure and Table Floats
4884 \begin_layout Standard
4885 LyX provides support for the necessary float environments
4887 figure, figure*, table
4893 , therefore we won't tell much about it here.
4900 Just remember that tables should be left-aligned.
4901 For that, select the table and change the alignment in
4906 dit\SpecialChar \menuseparator
4911 aragraph\InsetSpace ~
4915 \begin_layout Standard
4916 There is only one special thing: the figures with caption besides the figure.
4917 To create such a figure, you have to do the following:
4920 \begin_layout Enumerate
4921 Create a wide figure float:
4926 nsert\SpecialChar \menuseparator
4931 t\SpecialChar \menuseparator
4934 , then right click in the figure and select
4945 \begin_layout Enumerate
4946 Enter your caption text.
4949 \begin_layout Enumerate
4954 to move the cursor above the caption.
4957 \begin_layout Enumerate
4961 \begin_layout Enumerate
4962 Position the cursor behind the figure and insert a horizontal fill:
4967 nsert\SpecialChar \menuseparator
4975 \SpecialChar \menuseparator
4978 orizontal\InsetSpace ~
4984 \begin_layout Enumerate
4985 Switch to LaTeX mode:
4993 \begin_layout Enumerate
5003 Do not close the brace!
5006 \begin_layout Enumerate
5007 Position the cursor behind the caption text, switch to LaTeX mode and insert
5020 \begin_layout Standard
5021 Also, refer to the figures in the example paper.
5024 \begin_layout Subsection
5028 \begin_layout Standard
5029 For submission, the paper has to be formated in a special double-spacing
5031 For this purpose, you have to give the option
5035 to the documentclass.
5036 This must be done using the extra class options field in the
5041 ocument\SpecialChar \menuseparator
5049 Just enter the string
5056 \begin_layout Subsection
5060 \begin_layout Standard
5065 directory contains an example paper written with LyX.
5066 It is the example paper from the original macro package, translated to
5068 Use it for inspiration, and compare the original LaTeX code with LyX way
5072 \begin_layout Section
5076 \begin_layout Standard
5082 \begin_layout Subsection
5086 \begin_layout Standard
5087 AASTeX is a set of macros produced by the American Astronomical Society
5088 to facilitate electronic manuscript submission to the three journals they
5089 publish: the Astrophysical Journal (including the Letters and Supplement),
5090 the Astronomical Journal, and the Publications of the Astronomical Society
5092 LyX has proven to be an excellent tool for generating these documents,
5093 especially given its equation, citation, and figure handling capabilities.
5094 LyX requires version 5.0 (or higher) of these macros; preferably 5.2, which
5095 is the version described here, or higher.
5096 Versions prior to 5.0 are intended for use with LaTeX2.09 and are fundamentally
5097 incompatible with LyX.
5098 The AASTeX package may be downloaded from the AASTeX Web site
5101 \begin_layout Standard
5102 \begin_inset VSpace medskip
5108 \begin_layout Standard
5110 \begin_inset LatexCommand url
5111 target "http://www.journals.uchicago.edu/AAS/AASTeX"
5118 \begin_layout Standard
5119 \begin_inset VSpace medskip
5125 \begin_layout Standard
5126 A complete user guide is contained in that package and you should familiarize
5127 yourself with it thoroughly before embarking on writing a paper in LyX.
5128 LyX will not reduce the need to figure out all the AASTeX commands, it
5129 will only reduce the drudgery of typing everything in.
5130 It is your responsibility to ensure that the final exported LaTeX document
5131 conforms completely to the requirements of the journal to which you are
5132 submitting your paper.
5135 \begin_layout Subsection
5136 Starting a New Paper
5139 \begin_layout Standard
5140 I strongly suggest that you start with the AASTeX template file.
5146 ile\SpecialChar \menuseparator
5156 , enter the new file name, then choose the
5161 This will show the most common fields found in a manuscript.
5162 Simply overwrite the existing text (including the brackets,
5166 ) with the correct information.
5167 Many of the AASTeX commands and environments can be implemented directly
5168 in LyX, but some cannot: most noticeably
5180 , which should stick out like a sore thumb if you actually just opened the
5182 For commands such as these, the LaTeX code must be entered directly and
5184 Such commands are referred to as ERT, or Evil Red Text.
5185 I tried to minimize the amount of ERT needed in an AASTeX document, but
5186 there is still a bit more required than any of us would like.
5189 \begin_layout Subsection
5190 Finishing Your Paper
5193 \begin_layout Standard
5194 When the paper is finished to your satisfaction and previews/prints correctly,
5196 \begin_inset Quotes eld
5200 \begin_inset Quotes erd
5203 actions which need to be done before you submit it to the journals.
5207 \begin_layout Enumerate
5208 Export your paper as a LaTeX file (
5213 ile\SpecialChar \menuseparator
5218 xport\SpecialChar \menuseparator
5229 \begin_layout Enumerate
5234 file with your favorite text editor
5238 \begin_layout Enumerate
5239 remove the comment lines before the
5248 \begin_layout Enumerate
5253 usepackage...{fontenc}
5255 line if it appears (usually just after
5270 \begin_layout Enumerate
5271 remove everything between (and including) the
5283 commands, except for any commands you specifically put into the LaTeX preamble
5284 (which should appear immediately after the
5285 \begin_inset Quotes eld
5288 User specified LaTeX commands
5289 \begin_inset Quotes erd
5300 \begin_layout Enumerate
5301 Run the resulting file through LaTeX to make sure it still processes correctly.
5304 \begin_layout Enumerate
5305 Reread the journal requirements to make sure your filenames and formats
5309 \begin_layout Enumerate
5313 \begin_layout Subsection
5314 Comments On Specific Commands
5317 \begin_layout Standard
5318 I will not describe the detailed usage of the individual AASTeX commands:
5319 the AASTeX User Guide (
5323 ) gives a good description of each.
5324 Thus it's probably easiest for me to go down the list as found in the guide
5325 and offer comments where necessary.
5326 So let's begin \SpecialChar \ldots{}
5330 \begin_layout Subsubsection
5331 Things that work as expected
5334 \begin_layout Standard
5338 \begin_layout Standard
5350 \begin_layout Standard
5351 Because they work as you might expect, I simply list them and the section
5452 begin{thebibliography}
5460 (2.13.2), all the cite commands and their variations (2.13.2), the generic
5461 graphicx figure commands (2.14.1),
5485 (2.15.4, amongst other places),
5512 \begin_layout Standard
5513 The following style options also work correctly:
5534 Simply put them in the
5540 Layout\SpecialChar \menuseparator
5546 \begin_layout Standard
5550 \begin_layout Standard
5562 \begin_layout Subsubsection
5563 Things that work, but require more comment
5566 \begin_layout Standard
5567 The following items work, but require a little more discussion:
5570 \begin_layout Itemize
5571 These items are reserved for use by the journal editors, but you can put
5572 them into the LaTeX preamble if you feel compelled to do so:
5605 \begin_layout Itemize
5606 These items may be placed in the LaTeX preamble, and are included as blanks
5607 in the template file:
5628 \begin_layout Itemize
5635 (2.3) -- can only be used
5636 \begin_inset Quotes eld
5640 \begin_inset Quotes erd
5643 , not in the middle of a paragraph.
5644 Use ERT if you need to embed it.
5647 \begin_layout Itemize
5654 (2.3) -- will have extra {} after it.
5655 This should not cause an error.
5658 \begin_layout Itemize
5665 (2.6) -- can only be used
5666 \begin_inset Quotes eld
5670 \begin_inset Quotes erd
5673 , not in the middle of a paragraph.
5674 Use ERT if you need to embed it.
5677 \begin_layout Itemize
5684 (2.8) -- can't insert a cross-reference tag, you must type the tag name
5688 \begin_layout Itemize
5695 (2.8) -- same as for
5702 \begin_layout Itemize
5709 (2.9) -- will have extra {} after it.
5710 This should not cause an error.
5713 \begin_layout Itemize
5720 (2.11) -- will have extra {} after it.
5721 This should not cause an error.
5724 \begin_layout Itemize
5731 (2.14.2) -- you can insert an optional filename argument by placing the cursor
5732 at the beginning of the text and selecting
5734 Insert\SpecialChar \menuseparator
5739 \begin_inset Quotes eld
5743 \begin_inset Quotes erd
5746 inserts an optional argument of the type needed by
5753 Hopefully it will be renamed someday.
5756 \begin_layout Itemize
5769 for the catalog ID optional parameter
5772 \begin_layout Itemize
5785 for the catalog ID optional parameter
5788 \begin_layout Subsubsection
5789 Things not implemented, use ERT
5792 \begin_layout Standard
5796 \begin_layout Standard
5808 \begin_layout Standard
5831 setcounter{equation}
5833 (2.12), Journal name abbreviations (2.13.4),
5869 (2.15.4, insert it as the first element in the lefthand cell after where
5871 Don't use any of LyX's rules in the table),
5883 (2.15.5), much of Misc (2.17, except
5934 \begin_layout Standard
5938 \begin_layout Standard
5950 \begin_layout Subsubsection
5951 Things that cannot be implemented
5954 \begin_layout Standard
5955 \SpecialChar \ldots{}
5956 at least in any meaningful sort of way, so I suggest ignoring them.
5957 They are the references environment (2.13.3), and the deluxetable environment
5959 If you really, really need to use deluxetable, I suggest editing it in
5960 a separate file with a text editor, then using
5965 nsert\SpecialChar \menuseparator
5973 to include it in your LyX document.
5978 file to see an example of this.
5981 \begin_layout Subsection
5982 FAQs, Tips, Tricks, and Other Ruminations
5985 \begin_layout Subsubsection
5986 Getting LyX and AASTeX to cooperate
5989 \begin_layout Standard
5990 It can be a bit tricky to get LyX to recognize a new layout and document
5992 When all else fails, do this:
5995 \begin_layout Enumerate
5996 Make certain that LaTeX can find AASTeX.
5997 Copy sample.tex (and perhaps table.tex) from the AASTeX distribution into
5998 a directory completely unrelated to LaTeX or AASTeX and run LaTeX on
6005 \begin_layout Enumerate
6012 /usr/.../share/lyx/layouts
6021 \begin_layout Enumerate
6027 ools\SpecialChar \menuseparator
6034 in LyX, then restart LyX.
6037 \begin_layout Enumerate
6038 Open a regular new file, not from a template.
6039 Does AASTeX appear in the class list in
6044 ocument\SpecialChar \menuseparator
6054 \begin_layout Standard
6055 If you get a warning from an existing AASTeX document about not being able
6056 to find the AASTeX layout or a message about
6057 \begin_inset Quotes eld
6060 You should not mix title layouts with normal ones
6061 \begin_inset Quotes erd
6064 , things haven't been installed correctly.
6067 \begin_layout Subsubsection
6068 LaTeX error processing a table
6071 \begin_layout Standard
6072 LyX, by default, attempts to center the table caption/title.
6073 This seems to produce a bad interaction in AASTeX so you should click somewhere
6074 in the caption/title, then select
6079 dit\SpecialChar \menuseparator
6084 aragraph\InsetSpace ~
6099 This took care of it for me.
6102 \begin_layout Subsubsection
6104 \begin_inset LatexCommand label
6112 \begin_layout Standard
6113 A couple of things: 1) I have noticed some funny spacing in the reference
6114 entries in the text.
6115 When you enter the bibliography item data, make sure their is
6119 space between the last author and the parenthesis setting off the year;
6122 e.\InsetSpace \thinspace{}
6135 2) Entering the references at all is not obvious.
6136 The easiest thing is to start typing your first reference at the end of
6137 the document, then mark it as type
6142 That will put a small gray box in front of what you just typed.
6143 Click on the box to fill in the rest of the information.
6144 For new references, go to the end of an existing reference and press return.
6145 That will create a new line with its own box, etc.
6148 \begin_layout Subsubsection
6152 \begin_layout Standard
6153 Even though AASTeX provides its own figure commands (
6159 , for example), I much prefer LaTeX's standard figure commands (with the
6168 commands as ERT into a Figure Float box if you desire, but I never
6169 have much luck getting the layout right.
6170 With the standard graphics, LyX will insert a
6174 usepackage{graphicx}
6176 command into the LaTeX preamble and handle the figures in the standard
6177 LaTeX2e way, interspersing the figures in the text.
6178 I believe ApJ accepts figures exactly this way now; AJ might still use
6180 \begin_inset Quotes eld
6183 stack everything at the end
6184 \begin_inset Quotes erd
6190 \begin_layout Subsubsection
6191 Things I could have done, but didn't
6194 \begin_layout Standard
6196 \begin_inset Quotes eld
6200 \begin_inset Quotes erd
6203 things I could have implemented, but chose not to.
6204 For instance, I saw no point in double-spacing the text in the LyX window,
6205 even though it is double-spaced in the paper manuscript.
6206 Also, I chose not to make separate layouts for the preprint and preprint2
6208 Since I assume you will spend most of your time in the plain manuscript
6209 mode anyway, I decided not to chew up more disk space with this.
6213 \begin_layout Subsection
6217 \begin_layout Standard
6218 Your mileage may vary.
6219 I've now had papers published by both ApJ and AJ that have had 98% of the
6220 effort done in LyX; the last 2% was the LaTeX post-processing and a few
6222 I have had no trouble with the submission process, and I'm sure the journals
6223 were never aware that there might be a difference.
6224 So, go forth and publish!
6227 \begin_layout Section
6231 \begin_layout Standard
6234 Panayotis Papasotiriou
6237 \begin_layout Subsection
6241 \begin_layout Standard
6242 The ijmpc package is a set of macros that facilitates electronic manuscript
6245 International Journal of Modern Physics C
6248 Similarly, the ijmpd package is for creating manuscripts to be submitted
6251 International Journal of Modern Physics D
6254 Both journals are published by World Scientific.
6255 The corresponding document classes are named
6264 These files, together with instructions for the authors, can be downloaded
6266 \begin_inset LatexCommand url
6267 target "http://www.worldscinet.com/ijmpc/mkt/guidelines.shtml"
6272 \begin_inset LatexCommand url
6273 target "http://www.worldscinet.com/ijmpd/mkt/guidelines.shtml"
6278 Both packages are modified versions of the standard
6279 \begin_inset Quotes eld
6283 \begin_inset Quotes erd
6286 package, and they are almost (but not exactly) identical.
6287 Most of their features are supported by LyX.
6288 I have used LyX successfully to write articles submitted to both journals
6289 without any problem.
6292 \begin_layout Subsection
6296 \begin_layout Standard
6297 As usual, the easiest way to write a paper is to start with a template.
6303 ile\SpecialChar \menuseparator
6322 This will give an (almost) empty document that includes the most common
6323 fields found in a manuscript.
6324 Simply overwrite the existing text (including the brackets,
6329 You should keep in mind the following remarks.
6332 \begin_layout Enumerate
6333 LyX won't let you change the font size and the page style of the document,
6334 because such modifications are not allowed by both packages.
6337 \begin_layout Enumerate
6338 The language of the document should not be changed.
6339 Before previewing your paper, be sure that the babel package is not used.
6340 To do this, click on
6345 ools\SpecialChar \menuseparator
6363 checkbox in the language settings, and click on
6374 , if you wish to make this change permanent).
6377 \begin_layout Enumerate
6379 \begin_inset Quotes eld
6383 \begin_inset Quotes erd
6386 style must be used to define keywords.
6389 \begin_layout Enumerate
6390 The ijmpc package provides a style named
6391 \begin_inset Quotes eld
6394 Classification Codes
6395 \begin_inset Quotes erd
6398 , which can be used to define classification codes, such as PACS numbers.
6399 Note that this facility is not supported by the ijmpd package.
6402 \begin_layout Enumerate
6403 Several new environments are available:
6404 \begin_inset Quotes eld
6408 \begin_inset Quotes erd
6412 \begin_inset Quotes eld
6416 \begin_inset Quotes erd
6420 \begin_inset Quotes eld
6424 \begin_inset Quotes erd
6428 \begin_inset Quotes eld
6432 \begin_inset Quotes erd
6436 \begin_inset Quotes eld
6440 \begin_inset Quotes erd
6444 \begin_inset Quotes eld
6448 \begin_inset Quotes erd
6452 \begin_inset Quotes eld
6456 \begin_inset Quotes erd
6460 \begin_inset Quotes eld
6464 \begin_inset Quotes erd
6468 \begin_inset Quotes eld
6472 \begin_inset Quotes erd
6476 \begin_inset Quotes eld
6480 \begin_inset Quotes erd
6484 \begin_inset Quotes eld
6488 \begin_inset Quotes erd
6492 \begin_inset Quotes eld
6496 \begin_inset Quotes erd
6500 \begin_inset Quotes eld
6504 \begin_inset Quotes erd
6508 \begin_inset Quotes eld
6512 \begin_inset Quotes erd
6516 Their use is more or less obvious.
6517 LyX supports all these environments; it will use the proper label, text
6518 style, and numbering scheme for each of them.
6521 \begin_layout Enumerate
6522 Both packages use basic citations; the natbib package should not be used.
6523 In LyX, citation references are shown as usual; in the output, citations
6524 are shown as superscripts.
6525 If you want to use a citation as normal text, you should use the
6529 command, e.\InsetSpace \thinspace{}
6531 \begin_inset Quotes eld
6534 See Ref.\InsetSpace ~
6542 \begin_inset Quotes erd
6548 \begin_layout Enumerate
6550 \begin_inset Quotes eld
6554 \begin_inset Quotes erd
6557 section in both packages.
6558 To put acknowledgments, just use the
6559 \begin_inset Quotes eld
6563 \begin_inset Quotes erd
6569 \begin_layout Enumerate
6570 Appendices may be added to the paper,
6574 the Acknowledgments and
6579 LyX provides a special environment, called
6580 \begin_inset Quotes eld
6584 \begin_inset Quotes erd
6587 which marks the beginning of the appendices.
6588 This environment should be left blank; it just sends a LaTeX command, but
6589 nothing is really printed.
6591 \begin_inset Quotes eld
6595 \begin_inset Quotes erd
6598 is printed with blue letters, as a signal that all sections after that
6599 point are appendices.
6600 To write an appendix, use the
6601 \begin_inset Quotes eld
6605 \begin_inset Quotes erd
6609 LyX will number each appendix with capital letters, as required by both
6612 \begin_inset Quotes eld
6616 \begin_inset Quotes erd
6623 be present before the first appendix; if not, all appendices will be numbered
6624 as normal sections in the output.
6627 \begin_layout Enumerate
6628 The ijmpc and the ijmpd packages use the
6632 command to implement table captions.
6633 As a result, a table created by LyX is printed correctly, but its caption
6635 However, you can use some ERT to overpass this problem, so that captions
6636 are printed as expected.
6637 To do so, create a float table as usual, remove the caption, and replace
6648 (sic); you must also the ERT
6652 immediately after the tabular material.
6653 Study the example table included in the template files to see how this
6654 trick is implemented.
6655 Alternatively, If you need table captions, you should implement the whole
6660 file, then include this file to the LyX document (
6665 nsert\SpecialChar \menuseparator
6670 \SpecialChar \menuseparator
6679 Details on how to create a table float can be found in the files
6687 , included in the corresponding packages.
6690 \begin_layout Subsection
6691 Preparing a paper for submission
6694 \begin_layout Standard
6695 Before you submit your paper you must export the LyX document as a LaTeX
6701 ile\SpecialChar \menuseparator
6706 xport\SpecialChar \menuseparator
6721 \begin_layout Standard
6722 Actually you have the choice between LaTeX (plain) and pdflatex.
6723 If you intend to use pdflatex to prepare the paper, you should use the
6724 pdflatex option so that included graphics are converted to PDF format,
6725 ready for use by pdflatex.
6730 , then make the following changes to the resulting
6737 \begin_layout Enumerate
6738 Remove the comment lines before the
6747 \begin_layout Enumerate
6748 Remove everything between (and including) the
6760 commands, except for any commands you specifically put into the LaTeX preamble.
6763 \begin_layout Standard
6768 file should be saved and processed through LaTeX as many times as necessary.
6769 You may also want to check the resulting
6776 \begin_layout Subsection
6780 \begin_layout Standard
6781 The use of ERT is reduced to two commands, which must be placed at the top
6783 If you started writing your paper by using the
6791 template, the ERT needed is already in its place; you usually don't need
6793 You may only modify the first ERT to specify the information printed to
6794 the top of odd and even pages (authors' names and short paper's title,
6796 This ERT must have the form
6800 markboth{Authors' Names}{Short Paper's Title}
6805 \begin_layout Section
6809 \begin_layout Standard
6815 \begin_layout Subsection
6819 \begin_layout Standard
6820 The iopart package provides a document class to create electronic manuscript
6821 submission to the journals published by the Institute of Physics.
6822 Instructions for the authors how to create a paper using the iopart class
6823 can be downloaded together with the iopart package from the site
6824 \begin_inset LatexCommand url
6825 target "ftp://ftp.iop.org/pub/journals/latex2e"
6832 \begin_layout Subsection
6836 \begin_layout Standard
6837 The easiest way to write a paper is to start with the file
6841 that is available in LyX's examples files folder.
6842 Open this file, save it under a new name, and start writing.
6843 The example file explains how to use the special text environments.
6844 Here are the most important advices:
6847 \begin_layout Itemize
6848 To be able to compile your document to a PDF, PS, or DVI, assure that the
6851 Use AMS math package
6853 in the document settings under
6860 \begin_layout Itemize
6863 The title environment defines the kind of your paper.
6864 So use one of the following environments for the title:
6868 \begin_layout Itemize
6877 \begin_layout Itemize
6886 \begin_layout Itemize
6892 for a Topical review
6895 \begin_layout Itemize
6904 \begin_layout Itemize
6913 \begin_layout Itemize
6919 for a Paper (same as Title)
6922 \begin_layout Itemize
6928 for a Preliminary communication
6931 \begin_layout Itemize
6937 for a Rapid communication
6940 \begin_layout Itemize
6946 for a Letter to the editor
6950 \begin_layout Itemize
6953 All title environments except of
6957 can have an optional short title.
6960 \begin_layout Itemize
6961 There is a general title environment
6965 which is not directly supported by the LyX.
6966 This can be used as ERT when your document doesn't fit into one of the
6970 \begin_layout Standard
6971 For more informations like hints for special table and formula formatting,
6972 look at the IOP author guidelines.
6975 \begin_layout Section
6979 \begin_layout Standard
6982 Panayotis Papasotiriou
6985 \begin_layout Subsection
6989 \begin_layout Standard
6990 The Kluwer package is a set of macros produced by Kluwer Academic Publishers
6991 that facilitates electronic manuscript submission to the journals they
6993 Most known of them (at least in my domain of interest) are
6995 Astrophysics and Space Science
7001 , but there are many others (see a complete list at
7002 \begin_inset LatexCommand url
7003 target "http://www.wkap.nl/jrnllist.htm/JRNLHOME"
7008 The Kluwer package may be downloaded from the site
7009 \begin_inset LatexCommand url
7010 target "http://www.wkap.nl/kaphtml.htm/STYLEFILES"
7015 A complete user guide is contained in that package (but it can also be
7016 downloaded separately).
7019 \begin_layout Standard
7020 LyX supports many features of the package but not everything.
7021 However, the ERT needed is reduced to some
7022 \begin_inset Quotes eld
7026 \begin_inset Quotes erd
7029 commands of the package (see\InsetSpace ~
7031 \begin_inset LatexCommand ref
7032 reference "subsec:kluwer_peculiarities"
7037 I have recently used LyX to write an article submitted to the
7039 Astrophysics and Space Science
7041 without any problem.
7044 \begin_layout Subsection
7048 \begin_layout Standard
7049 The easiest way to write a paper is to start with the Kluwer template file.
7052 File\SpecialChar \menuseparator
7067 This will give an (almost) empty document that includes the most common
7068 fields found in a manuscript and a short description of their use.
7069 As in most templates, simply overwrite the existing text (including the
7074 ) with the correct information.
7077 \begin_layout Subsection
7078 Preparing a paper for submission
7081 \begin_layout Standard
7082 As in the AASTeX package, before you submit your paper to a journal you
7084 \begin_inset Quotes eld
7088 \begin_inset Quotes erd
7094 \begin_layout Enumerate
7095 Export your paper as a LaTeX file.
7096 To do this, click on
7101 ile\SpecialChar \menuseparator
7106 xport\SpecialChar \menuseparator
7117 \begin_layout Enumerate
7122 file with a text editor and make the following changes
7126 \begin_layout Enumerate
7127 remove the comment lines before the
7136 \begin_layout Enumerate
7137 remove everything between (and including) the
7149 commands, except for any commands you specifically put into the LaTeX preamble.
7152 \begin_layout Standard
7161 \begin_layout Enumerate
7166 file through LaTeX as many times as necessary (usually up to three).
7169 \begin_layout Enumerate
7174 document using, e.\InsetSpace \thinspace{}
7179 , and check if everything is OK (it should, if you didn't make any mistake).
7182 \begin_layout Subsection
7183 \begin_inset Quotes eld
7187 \begin_inset Quotes erd
7190 of the Kluwer package
7191 \begin_inset LatexCommand label
7192 name "subsec:kluwer_peculiarities"
7199 \begin_layout Standard
7200 The Kluwer package has the following
7201 \begin_inset Quotes eld
7205 \begin_inset Quotes erd
7211 \begin_layout Enumerate
7212 It is possible to write multiple articles in the same LaTeX file
7216 \begin_layout Standard
7217 I can't imagine any good reason to do this.
7223 Each article must be included in the environment
7224 \begin_inset Quotes eld
7228 \begin_inset Quotes erd
7232 Unfortunately, this environment cannot be omitted, even if you write just
7234 Therefore, each article starts with the command
7240 and, obviously, ends with the command
7247 Although this can be implemented in LyX, I didn't included it, since it
7248 looks ugly and can confuse the novice user.
7249 Therefore, you need to enter them directly and mark them as LaTeX code
7251 \begin_inset Quotes eld
7255 \begin_inset Quotes erd
7261 \begin_layout Enumerate
7262 Information given at the beginning of the article (i.e., title, subtitle,
7263 author, institution, running title, running author, abstract and keywords)
7264 must be included in an environment called
7265 \begin_inset Quotes eld
7269 \begin_inset Quotes erd
7273 This is not implemented in LyX, so you must enter title, subtitle etc.\InsetSpace ~
7290 \begin_layout Enumerate
7291 According to the user manual, the label of each bibliography item must be
7315 \begin_layout Standard
7320 template takes care of all these
7321 \begin_inset Quotes eld
7325 \begin_inset Quotes erd
7329 If you start a new paper using this template you don't need to do anything
7334 \begin_layout Enumerate
7335 don't delete the ERT included in the template, and
7338 \begin_layout Enumerate
7339 copy the example bibliography item included in the template and modify it
7340 as necessary to enter new bibliography items.
7343 \begin_layout Section
7347 \begin_layout Standard
7353 \begin_layout Subsection
7357 \begin_layout Standard
7358 The LyX document classes
7360 article (koma-script)
7364 report (koma-script)
7382 correspond to the LaTeX document classes
7398 , resp.\InsetSpace ~
7399 of the Koma-Script family.
7400 They are replacements for the standard document classes
7416 , resp., and fit better to European typography conventions in a number of
7420 \begin_layout Itemize
7421 Standard character size is 11pt in
7423 article (koma-script)
7427 report (koma-script)
7435 letter (koma-script)
7440 \begin_layout Itemize
7441 Headings, labels of the description environment, and a number of elements
7444 letter (koma-script)
7446 document class are set in a bold sans serif font.
7450 \begin_layout Standard
7451 There is a big difference between the bold sans serif old cm fonts and new
7452 ec fonts, especially in the appearance of headings.
7453 In comparison, the ec bold sans serif fonts look a bit thin.
7454 Here the LaTeX package
7462 helps to produce the
7463 \begin_inset Quotes eld
7467 \begin_inset Quotes erd
7470 appearance when using the ec fonts.
7475 The numbering of chapter headings is made in the same way as the numbering
7476 of section headings, that is without the extra line
7477 \begin_inset Quotes eld
7480 Chapter\SpecialChar \ldots{}
7482 \begin_inset Quotes erd
7486 In addition, the appearance of the headings can be modified by using a
7487 number of options (in LyX to be entered in the field
7501 ayout\SpecialChar \menuseparator
7509 A detailed German description of these options can be found in the Koma-Script
7517 \begin_layout Itemize
7518 The main means in the Koma-Script document classes to design the type area
7527 (in LyX to be entered in the extra class options field in the dialog
7532 ocument\SpecialChar \menuseparator
7540 They make a clearer modification of page margins possible as do the options
7546 ocument\SpecialChar \menuseparator
7554 A detailed German description of these and other type area options can
7555 be found in the Koma-Script documentation
7562 \begin_layout Itemize
7563 The LaTeX document classes of the Koma-Script family define a number of
7564 additional commands.
7565 Those part of it which makes sense in LyX is implemented in corresponding
7569 \begin_layout Standard
7570 A detailed German description of the LaTeX document classes of the Koma-Script
7571 family can be found in the Koma-Script documentation
7579 \begin_layout Standard
7580 There is an English translation
7584 , but it is not a complete one.
7589 The following sections describe only those aspects, which are relevant
7593 \begin_layout Subsection
7594 article (koma-script), report (koma-script), and book (koma-script)
7597 \begin_layout Standard
7598 The document classes
7600 article (koma-script)
7604 report (koma-script)
7614 are implemented in the layout files
7627 They contain all the paragraph types of the corresponding standard document
7640 , resp., partly modified, with the exception of the LyX specific
7644 -type, which is replaced by the new
7648 -type having the same functionality.
7653 -Type there is a number of new paragraph types added.
7660 letter (koma-script)
7665 \begin_layout Itemize
7674 : are equivalents to
7682 , resp., additionally inserting an entry in the table of contents.
7691 are not contained in
7693 article (koma-script)
7698 \begin_layout Itemize
7715 , resp., additionally clearing running heads.
7722 article (koma-script)
7728 \begin_layout Standard
7741 report (koma-script)
7743 , but since this is identical to
7747 , is has not been implemented in LyX.
7755 \begin_layout Itemize
7760 : generates a heading directly above the following paragraph in the standard
7761 character size without affecting the structure of the document.
7764 \begin_layout Itemize
7773 are special captions which respect the different space settings needed
7774 for captions placed above or below an element (if you follow strict typographic
7775 rules, you might want to place table captions always above the table).
7776 You can also use the class option
7793 You need at least Koma-Script version 2.8q to use this.
7796 \begin_layout Itemize
7801 : can be used to set a bonmot, e.
7805 \begin_layout Standard
7818 \begin_layout Standard
7827 at the beginning of a chapter.
7828 If you use the optional argument (
7833 nsert\SpecialChar \menuseparator
7837 ), you can insert the dictum's author there.
7838 Dictum and author are separated by a line.
7839 You need at least Koma-Script version 2.8q to use this.
7846 article (koma-script)
7851 \begin_layout Standard
7852 The following types, together with the standard types
7864 , form the title area of the document.
7865 They must be entered ahead of the first
7866 \begin_inset Quotes eld
7870 \begin_inset Quotes erd
7877 \begin_layout Standard
7878 The corresponding LaTeX commands must appear before the
7889 When such a type is used more than once, the latter usage overwrites the
7890 former one, that means, for every type only the latest usage is valid.
7891 The order of the different types however has, like
7903 , no effect on the appearance of the produced document.
7906 \begin_layout Itemize
7911 : produces a centered paragraph above the ordinary title (
7923 ) for the subject of the document.
7926 \begin_layout Itemize
7931 : produces a centered paragraph below the ordinary title (
7943 ) for the publishers' name.
7946 \begin_layout Itemize
7953 report (koma-script)
7959 produces a centered paragraph on its own page behind the title page, or
7962 article (koma-script)
7964 produces a centered paragraph below the ordinary title (
7983 \begin_layout Itemize
7988 : produces a left aligned paragraph above the ordinary title (
8004 ) for a document`s head.
8007 \begin_layout Itemize
8012 : produces in a double-sided print in
8014 report (koma-script)
8020 a left-aligned paragraph at the top of the title page`s back or has no
8021 effect in a single-sided print or in
8023 article (koma-script)
8028 \begin_layout Itemize
8033 : produces in a double-sided print in
8035 report (koma-script)
8041 a left-aligned paragraph at the bottom of the title page`s back or has
8042 no effect in a single-sided print or in
8044 article (koma-script)
8049 \begin_layout Itemize
8054 : produces a special
8055 \begin_inset Quotes eld
8059 \begin_inset Quotes erd
8062 page ahead of the actual document containing a paragraph without special
8066 \begin_layout Standard
8067 The layout files for the document classes
8069 article (koma-script)
8073 report (koma-script)
8084 This is thought of as a place to define your own types.
8089 in your personal layout directory and edit the file!
8092 \begin_layout Subsection
8093 letter (koma-script)
8096 \begin_layout Standard
8100 \begin_layout Standard
8112 \begin_layout Standard
8116 letter (koma-script)
8118 is implemented in the layout file
8123 It contains all the paragraph types of the corresponding standard document
8128 , partly modified, with the exception of the LyX specific types
8140 type, which is replaced by the new
8145 In addition, it contains, in contrast to the standard document class, the
8163 Furthermore, there are a number of new letter specific types.
8166 \begin_layout Standard
8170 \begin_layout Standard
8182 \begin_layout Standard
8183 The appearance of the letter produced by this document class can be controlled
8184 by a number of LaTeX commands, which you can put in the LaTeX preamble.
8188 \begin_layout Standard
8189 For example, the standard appearance of the letter`s heading, consisting
8190 of name and address, is quite self-willed.
8192 \begin_inset Quotes eld
8196 \begin_inset Quotes erd
8199 heading is produced by the following LaTeX commands in the preamble:
8202 \begin_layout LyX-Code
8212 \begin_layout LyX-Code
8228 \begin_layout LyX-Code
8238 \begin_layout LyX-Code
8258 A detailed German description of such LaTeX commands can be found in the
8259 Koma-Script documentation
8264 With it, the letter's author can produce his personal letter layout.
8267 \begin_layout Standard
8276 define the beginning of the letter and must be used in every letter.
8277 To emphasize them in the LyX document class, they are marked with the letter
8286 , resp.\InsetSpace ~
8288 It is possible to write any number of letters in one file.
8293 type produces a new letter using the same addressee and a
8297 type produces a new addressee.
8314 are ordinary paragraph types and can also be used several times in one
8315 and the same letter.
8318 \begin_layout Itemize
8323 : produces a paragraph for the addressee and implicitly defines the beginning
8327 \begin_layout Itemize
8332 : produces a paragraph for the form of address and implicitly produces a
8336 \begin_layout Itemize
8341 : produces a paragraph for a close.
8344 \begin_layout Itemize
8349 : produces a paragraph for a postscript.
8352 \begin_layout Itemize
8357 : produces a paragraph for a distribution list.
8360 \begin_layout Itemize
8365 : produces a paragraph for enclosures.
8368 \begin_layout Standard
8409 are input types provided with a label to enter information, which will
8410 be processed by the document class.
8414 \begin_layout Standard
8415 It could be seen as a matter of inconsequence, that the types
8423 described above are not such input types as well.
8424 Because of the special meaning of those types, however, I have implemented
8425 them as ordinary paragraph types with a one letter mark in the left margin.
8426 Moreover, it would affect my feeling of symmetry, if the
8434 type had such a serious different appearance.
8439 The types must be used ahead of the corresponding
8446 \begin_layout Standard
8447 An implementation of these types in a WYSIWYG fashion does not seem to make
8448 sense, because the real appearance of the produced letter does not only
8449 depend on the usage of the particular type, but also on other factors.
8450 For example, a signature entered in the
8454 type will in the standard behavior appear in the produced letter only,
8455 when in the same letter also a
8460 The entered value of the
8464 type will in the standard behavior not appear in the produced letter at
8466 The possibility to design the letter`s heading freely is already indicated
8467 in a footnote above.
8470 \begin_layout Standard
8471 The input types can also be used as empty paragraphs.
8472 This makes sense e.\InsetSpace \thinspace{}
8483 type is not used at all, in the standard behavior the value of the
8487 type is used as signature, whereas if an empty
8491 type is used, no signature value is defined.
8494 \begin_layout Standard
8495 By using the input types it is possible to write a letter template, containing
8496 filled input types with your personal dates (name, address, etc.) and empty
8497 input types for other dates you want to enter.
8500 \begin_layout Itemize
8505 : sender's name, in the standard behavior appears as a centered paragraph
8506 in small caps in the letter`s heading.
8509 \begin_layout Itemize
8514 : sender's signature, in the standard behavior appears below the
8523 type is used, the value of the
8527 type appears instead.
8530 \begin_layout Itemize
8535 : sender's address, in the standard behavior appears in a centered paragraph
8536 in the letter`s heading below the sender's name.
8539 \begin_layout Itemize
8544 : sender's telephone number, in the standard behavior only sets the LaTeX
8554 \begin_layout Itemize
8559 : place of the letter`s making.
8562 \begin_layout Itemize
8567 : date of the letter`s making.
8576 , in the standard behavior, produce the place and the date in a right-aligned
8577 line below the addressee's field.
8582 type is used, neither place nor date appear, independent of the value of
8592 type is used, the date of the letter `s production is used.
8595 \begin_layout Itemize
8600 : sender`s back address, in the standard behavior appears above the addressee's
8601 field in a small sans serif font.
8604 \begin_layout Itemize
8609 : special mail information, in the standard behavior appears underlined
8610 above the addressee's field below the back address.
8613 \begin_layout Itemize
8618 : additional information, in the standard behavior appears on right side
8619 below the addressee`s field.
8622 \begin_layout Itemize
8627 : the letter's title, in the standard behavior appears in a big, bold, sans
8628 serif font above the subject.
8631 \begin_layout Itemize
8636 : the letter's subject, in the standard behavior appears in a bold font
8644 \begin_layout Standard
8665 produce a business letter like line above the
8669 line containing the fields
8670 \begin_inset Quotes eld
8674 \begin_inset Quotes erd
8678 \begin_inset Quotes eld
8682 \begin_inset Quotes erd
8686 \begin_inset Quotes eld
8690 \begin_inset Quotes erd
8694 \begin_inset Quotes eld
8698 \begin_inset Quotes erd
8702 \begin_inset Quotes eld
8706 \begin_inset Quotes erd
8710 \begin_inset Quotes eld
8714 \begin_inset Quotes erd
8718 For the date field, the value of the
8724 \begin_inset Quotes eld
8727 business letter types
8728 \begin_inset Quotes erd
8731 is used, the value of the
8735 type however does not appear, but only the LaTeX variable
8742 The ordinary output of place and date in a right-aligned line below the
8743 addressee`s field is suppressed.
8744 The types are implemented as input types provided with a label and must
8745 be used ahead of the corresponding
8752 \begin_layout Itemize
8760 \begin_layout Itemize
8768 \begin_layout Itemize
8776 \begin_layout Itemize
8784 \begin_layout Itemize
8792 \begin_layout Subsection
8793 The new letter class: letter (koma-script v.2)
8796 \begin_layout Standard
8799 Jürgen Spitzmüller
8802 \begin_layout Standard
8803 \begin_inset VSpace medskip
8809 \begin_layout Standard
8811 Koma-Script version 2.8 has introduced a new letter class
8815 which supersedes the now unsupported
8820 It has --- on the LaTeX side --- a completely new interface and is not
8821 compatible with the old class.
8822 Therefore, LyX supports both, though it is recommended to use the new class.
8825 \begin_layout Standard
8826 This class covers the same functionality as
8828 letter (koma-script),
8835 (receiver's address, same as
8852 will start a new letter (i.
8856 \begin_layout Standard
8869 \begin_layout Standard
8878 you can write several letters per document).
8879 New elements are sender's
8895 and the possibility to use a
8904 nsert\SpecialChar \menuseparator
8914 \begin_layout Standard
8915 The biggest improvement is, though, that the letter's layout is configurable
8916 at almost any needs.
8917 This can be done via the preamble or with a special style file (Letter
8918 Class Option, extension
8922 ), that will be read in as a class option.
8926 \begin_layout Standard
8927 The KOMA package comes with some default
8932 There is, for instance, a
8936 file that follows german typesetting rules, or a
8940 that provides the default layout of the old
8945 The latter can be loaded with the class option
8954 ayout\SpecialChar \menuseparator
8959 ocument\SpecialChar \menuseparator
8971 template that is included in LyX for examples.
8972 A detailed description is to be found in the Koma-Script documentation
8980 \begin_layout Subsection
8984 \begin_layout Standard
8985 Visualizing the Koma-Script document classes in LyX, the LyX internals cause
8989 \begin_layout Itemize
8990 The chapter number of a
8994 type appears on a line of its own above the chapter heading instead of
8995 appearing in the same line ahead of it.
8996 The cause for that is the LyX internal behavior for the labeltype
9003 \begin_layout Itemize
9004 The headings of the types
9013 \begin_inset Quotes eld
9017 \begin_inset Quotes erd
9020 LaTeX table of contents, but not in the LyX table of contents (
9025 ocument\SpecialChar \menuseparator
9037 \begin_layout Itemize
9042 document class appear in a skip separation mode, not indented.
9043 This is the standard behavior, no special LaTeX commands are needed for
9050 ocument\SpecialChar \menuseparator
9057 dialog the corresponding radio button indicates
9073 value always has the effect that extra LaTeX commands are inserted in the
9074 document to produce the gap, which is not what is wanted in this case.
9077 \begin_layout Section
9085 \begin_layout Standard
9091 \begin_layout Subsection
9095 \begin_layout Standard
9096 These are the layout files for some of the journal formats used by Springer
9097 Verlag and listed on
9098 \begin_inset LatexCommand url
9099 target "http://www.springer.de/author/tex/help-journals.html"
9103 , where you should also go to fetch the class files (yes, these are LaTeX2e
9105 It is a modular system: the things common to all journals are implemented
9110 , which journal-specific layout files (such as, e.\InsetSpace \thinspace{}
9115 for Journal of Geodesy) can include.
9118 \begin_layout Standard
9119 This means that implementing support for any other Springer journal on this
9120 list is as simple as writing your own
9128 file following the outline given in
9136 \begin_layout Standard
9137 It is reasonably well tested only for the Journal of Geodesy.
9146 come with the standard LyX distribution.
9147 Install the relevant class file (downloaded from Springer) in a proper
9148 directory, reconfigure LaTeX (in the teTeX case by running
9152 , as root if necessary --- doesn't LyX take care of this?), reconfigure
9153 LyX and it should work.
9156 \begin_layout Subsection
9160 \begin_layout Standard
9161 A large number of theorem-like styles ---
9167 \SpecialChar \ldots{}
9173 \begin_layout Standard
9176 Headnote, Dedication, Subtitle, Running_LaTeX_Title, Author_Running, Institute,
9177 Mail, Offprints, Keywords, Acknowledgements, Acknowledgement
9180 See the Springer class file documentation for details.
9183 \begin_layout Subsection
9187 \begin_layout Itemize
9199 \begin_layout Itemize
9202 Probability Theory and Related Fields
9208 --- Jean-Marc Lasgouttes
9211 \begin_layout Standard
9212 Add your own, it isn't so hard!
9215 \begin_layout Subsection
9219 \begin_layout Standard
9220 These files are partly based on the older
9224 , which was again based on a tinkered-with version of an old LaTeX 2.09 style
9230 layout, are now defunct.
9231 Jean-Marc Lasgouttes helped out big in making me find my way around the
9232 LyX layout file mechanism.
9235 \begin_layout Subsection
9239 \begin_layout Standard
9241 But probably less than in the old hacked-LaTeX
9248 \begin_layout Standard
9249 Limitations e.\InsetSpace \thinspace{}
9250 g.: does not display the number for theorem-like layouts, just
9254 \begin_layout Section
9262 \begin_layout Standard
9268 \begin_layout Subsection
9272 \begin_layout Standard
9273 These are the layout files for some of the journals of the American Geophysical
9275 It is assumed that you have both the AGU's own class files and AGUplus
9276 installed (everything to be found at
9277 \begin_inset LatexCommand url
9278 target "ftp://ftp.agu.org/journals/latex/journals"
9285 \begin_layout Subsection
9289 \begin_layout Standard
9299 They are still called this in the LyX GUI, though their LaTeX equivalents
9300 in the AGU classes are
9311 \begin_layout Standard
9312 Newly defined styles are
9349 These are mostly manuscript attributes and defined in the AGU class documentati
9353 \begin_layout Standard
9354 I suspect this is still badly incomplete.
9357 \begin_layout Subsection
9361 \begin_layout Standard
9378 \begin_layout Subsection
9382 \begin_layout Itemize
9385 Journal of Geophysical Research
9394 \begin_layout Standard
9395 Add your own, it isn't so hard! Look at the
9406 \begin_layout Subsection
9407 Bugs and things to remember
9410 \begin_layout Standard
9411 In order to use the new layouts, you must remember to do the following for
9415 \begin_layout Enumerate
9421 This can be done in the
9423 layout\SpecialChar \menuseparator
9428 document\SpecialChar \menuseparator
9432 (AGU articles are always in English, right? So
9439 \begin_layout Enumerate
9449 (Yes, this is a bug.)
9452 \begin_layout Enumerate
9453 Make sure you use the
9457 bibliography style, by entering
9461 into the second field of the BibTeX inset.
9462 None of the standard styles will do.
9465 \begin_layout Section
9473 \begin_layout Standard
9479 \begin_layout Subsection
9483 \begin_layout Standard
9484 This is the layout file for the European Geophysical Society journals.
9489 can be downloaded from the web site of the EGS under
9490 \begin_inset LatexCommand url
9491 target "www.copernicus.org"
9498 \begin_layout Subsection
9502 \begin_layout Standard
9505 Right_address, Latex_Title, Affil, Journal, msnumber, FirstAuthor, Received,
9513 The current layout file is unfortunately very unmodular and would benefit
9514 from using the various
9521 \begin_layout Section
9527 \begin_inset LatexCommand label
9535 \begin_layout Standard
9543 \begin_layout Subsection
9547 \begin_layout Standard
9548 This section describes how to use LyX to make slides for overhead projectors.
9549 There are two document classes that can do this: the default slides class
9555 This section documents the former.
9558 \begin_layout Standard
9559 I'm going to say this again, nice and clear, so that there's no misunderstanding
9563 \begin_layout Standard
9564 \begin_inset VSpace bigskip
9570 \begin_layout Standard
9574 This section documents the class
9575 \begin_inset Quotes eld
9583 \begin_inset Quotes erd
9591 \begin_layout Standard
9592 \begin_inset VSpace bigskip
9598 \begin_layout Standard
9599 If you're looking for the documentation for
9600 \begin_inset Quotes eld
9608 \begin_inset Quotes erd
9611 , check out section\InsetSpace ~
9613 \begin_inset LatexCommand ref
9614 reference "sec:foiltex"
9624 \begin_inset Quotes eld
9632 \begin_inset Quotes erd
9635 ] is actually somewhat better than the default
9643 \begin_layout Standard
9644 \SpecialChar \ldots{}
9645 or so I've been told repeatedly by its advocates.
9646 Having never used it, I have no idea if this claim is true or not.
9651 which this section documents.
9654 \begin_layout Standard
9655 This class is the LaTeX2e improvement of the old
9660 Every LaTeX2e distribution includes this class [which I'll just refer to
9662 \begin_inset Quotes eld
9670 \begin_inset Quotes erd
9673 from now on], so you're bound to have it.
9674 As I noted earlier, there are other classes, such as
9678 , which also produce slides for overhead projectors and do a better job
9680 However, there are some things which
9684 can do which the others can't, such as generate overlays.
9685 Read on to learn more!
9688 \begin_layout Subsection
9690 \begin_inset LatexCommand label
9691 name "sec:slidesetup"
9698 \begin_layout Standard
9699 Obviously, to use this document class, you need to select
9700 \begin_inset Quotes eld
9708 \begin_inset Quotes erd
9711 from the class list in the
9716 ocument\SpecialChar \menuseparator
9724 There are some other special things you should know about this class:
9727 \begin_layout Itemize
9728 Don't bother changing the options
9733 They're not supported by the
9740 \begin_layout Itemize
9749 behaves a bit differently for this class.
9750 The possible choices and what they do are as follows:
9754 \begin_layout Description
9759 The final output contains page numbers in the lower right corner.
9762 \begin_layout Description
9771 , but also prints out any time markers you've put in.
9772 This is the default.
9775 \begin_layout Description
9780 The final output contains no page numbers, time markers, or alignment markers.
9784 \begin_layout Itemize
9789 class has an extra option:
9795 \begin_inset Quotes eld
9803 \begin_inset Quotes erd
9806 in the extra class options.
9810 \begin_layout Standard
9811 Using this options allows you to add time markers to
9816 See section\InsetSpace ~
9818 \begin_inset LatexCommand ref
9819 reference "sec:slideNote"
9827 \begin_layout Standard
9828 You can also use the template file
9829 \begin_inset Quotes eld
9837 \begin_inset Quotes erd
9840 to automatically set up a document to use the
9849 ile\SpecialChar \menuseparator
9858 to open your new document].
9859 The template file also contains some examples of the special paragraph
9860 environments used by this class.
9861 I'll describe those next.
9864 \begin_layout Subsection
9865 Paragraph Environments
9868 \begin_layout Subsubsection
9869 Supported Environments
9872 \begin_layout Standard
9873 The first thing you'll notice when you start up a new
9877 document is the font size and type: it's the equivalent of the size
9878 \begin_inset Quotes eld
9886 \begin_inset Quotes erd
9895 This is also what's used in the output.
9897 \begin_inset Quotes eld
9901 \begin_inset Quotes erd
9904 to remind you that this is a slide.
9905 Your final slides will use a larger font; ergo, you'll have less space.
9906 Of course, the larger default screen font isn't WYSIWYG, only a reminder.
9909 \begin_layout Standard
9910 The next thing that becomes obvious is the changes to the paragraph environment
9911 pull-down box [at the far-left end of the toolbar].
9912 Most of the paragraph environments you're used to seeing are missing.
9913 There are also five new ones.
9918 class itself only supports certain paragraph environments:
9921 \begin_layout Itemize
9927 \begin_layout Itemize
9933 \begin_layout Itemize
9939 \begin_layout Itemize
9945 \begin_layout Itemize
9951 \begin_layout Itemize
9957 \begin_layout Itemize
9963 \begin_layout Itemize
9969 \begin_layout Itemize
9975 \begin_layout Itemize
9981 \begin_layout Itemize
9987 \begin_layout Standard
9988 All of the other standard environments, including the section-heading environmen
9989 ts, aren't used in the
9996 \begin_layout Standard
9997 On the other hand, you'll notice the following new environments:
10000 \begin_layout Itemize
10006 \begin_layout Itemize
10012 \begin_layout Itemize
10018 \begin_layout Itemize
10024 \begin_layout Itemize
10030 \begin_layout Standard
10031 These five are kind of quirky, due to a
10032 \begin_inset Quotes eld
10036 \begin_inset Quotes erd
10040 You see, LyX doesn't permit you to nest any other paragraph environment
10041 into an empty environment.
10042 Now, that's fine and dandy, but it means that you wouldn't be able to start
10043 a slide with anything except plain text.
10044 To deal with this, I've performed a little
10045 \begin_inset Quotes eld
10049 \begin_inset Quotes erd
10055 \begin_layout Subsubsection
10056 Quirks of the New Environments
10057 \begin_inset LatexCommand label
10058 name "sec:slideQuirk"
10065 \begin_layout Standard
10066 All five of the new paragraph environments are somewhat quirky due to inherent
10067 limitiations in the current version of LyX.
10068 As I just mentioned, LyX forbids environments that begin with another environme
10070 To get around this, the
10074 environment isn't a paragraph environment as described in the
10082 \begin_layout Standard
10083 You should consider
10096 \begin_inset Quotes eld
10099 pseudo-environments.
10100 \begin_inset Quotes erd
10103 They look like a section heading or a
10104 \begin_inset Quotes eld
10112 \begin_inset Quotes erd
10115 but really begin a [and, if necessary, end the previous] paragraph environment.
10125 \begin_inset Quotes eld
10129 \begin_inset Quotes erd
10132 These two perform some action.
10135 \begin_layout Standard
10136 A common feature of all five environments,
10156 , is a rather long-ish label.
10157 The text following this label --- ordinarily the contents of the paragraph
10158 environment --- is utterly irrelevant for
10179 LyX completely ignores it.
10180 In fact, you can leave these five environments completely empty.
10184 \begin_layout Standard
10189 to put any text after the rather long-ish label, you might want to.
10190 This could be a short description of the contents of the
10195 In that case, enter in your descriptive comment and hit
10199 as you normally would.
10202 \begin_layout Standard
10203 If, on the other hand, you don't want to enter in any descriptive text,
10204 you'll hit another LyX quirk.
10205 LyX, like nature, abhors a vacuum, and will not let you start a new paragraph
10206 environment until you put something in the old one.
10210 \begin_layout Itemize
10211 Start entering the text that will
10239 \begin_layout Itemize
10240 Now move to the beginning of that paragraph.
10244 \begin_layout Itemize
10253 \begin_layout Itemize
10254 Finally, change this new, empty paragraph to a
10278 \begin_layout Standard
10279 Some future version of LyX will, hopefully, resolve this quirkiness\SpecialChar \ldots{}
10283 \begin_layout Subsection
10284 Making a Presentation with
10297 \begin_layout Subsubsection
10305 \begin_layout Standard
10306 If you're expecting this section to teach you how to actually make a presentatio
10307 n, you'll be sorely disappointed.
10308 Naturally, I'll describe all of the ways the
10312 class can assist you in preparing the materials for a presentation.
10313 Filling in the contents, however, is up to you.
10318 the LyX philosophy.]
10321 \begin_layout Standard
10326 environment [in the manner described in section\InsetSpace ~
10328 \begin_inset LatexCommand ref
10329 reference "sec:slideQuirk"
10333 ] tells LyX to begin a new slide [duh].
10334 The label for this environment/
10335 \begin_inset Quotes erd
10339 \begin_inset Quotes erd
10343 \begin_inset Quotes eld
10347 \begin_inset Quotes erd
10350 in cool blue, followed by the label,
10351 \begin_inset Quotes eld
10355 \begin_inset Quotes erd
10359 Any text or paragraph environments that follow this one go on the new slide.
10363 \begin_layout Standard
10364 Slides are probably the only time you'll need to forcibly end pages in LyX
10365 (this can be specified in the
10370 In fact, you'll want to, once you finish entering the contents of one slide.
10371 If you've entered more text than can physically fit on a slide, the extra
10372 overflows onto a new slide.
10373 I don't recommend doing this, however, since the overflow slide won't have
10374 any page number on it.
10375 Furthermore, it may interfere with any
10379 you've made to accompany the oversized
10386 \begin_layout Standard
10395 environments work the same way as the
10400 They both create an
10401 \begin_inset Quotes eld
10405 \begin_inset Quotes erd
10408 followed by a label [
10409 \begin_inset Quotes eld
10413 \begin_inset Quotes erd
10417 \begin_inset Quotes eld
10421 \begin_inset Quotes erd
10425 The color is a stunning magenta instead of blue, and the
10426 \begin_inset Quotes eld
10430 \begin_inset Quotes erd
10433 will look different, in style and in length.
10434 The label fonts of all three also differ from one another.
10437 \begin_layout Standard
10442 , if the contents of a
10450 exceed the physical size of a slide or sheet of paper, the extra will overflow
10452 Again, you should avoid this.
10453 It defeats the whole purpose of
10464 \begin_layout Subsubsection
10474 \begin_layout Standard
10479 is a slide that sits atop another slide.
10480 Perhaps you wish to discuss a figure on the main
10484 before displaying the text associated with it.
10485 One way to accomplish this is tape a flap of dark paper over the part of
10490 you want to display later.
10491 This method fails, however, if you wish to overlap one graph with another,
10493 You would then have to fumble while speaking to align the two separate,
10498 s to align the two graphs.
10503 environment in both cases makes life much easier.
10506 \begin_layout Standard
10511 receives the page number of its
10512 \begin_inset Quotes eld
10516 \begin_inset Quotes erd
10524 \begin_inset Quotes eld
10532 \begin_inset Quotes erd
10539 \begin_layout Standard
10540 Presumably, mutliple
10545 \begin_inset Quotes eld
10553 \begin_inset Quotes erd
10557 \begin_inset Quotes eld
10565 \begin_inset Quotes erd
10569 \begin_inset Quotes eld
10577 \begin_inset Quotes erd
10580 , etc.\InsetSpace ~
10581 appended to the page number of the parent
10591 Clearly, you want the contents of both the
10599 to each fit on a single physical slide! You should probably consider an
10605 \begin_inset Quotes eld
10609 \begin_inset Quotes erd
10621 class provides a visual cue for this: the label at the start of an
10625 is shorter than that at the start of a
10630 Lastly, when you generate printable output, you'll find alignment markers
10631 in all four corners of both the
10635 page and its parent
10640 These will assist you in lining up the two physical slides.
10643 \begin_layout Standard
10644 The major problem in overlaying two slides is aligning the contents of the
10645 two transparencies.
10646 How much space should you leave for that graph on the second slide? Worse
10647 still, what if you want a graph and a sentence on second slide, but there
10648 is text on the main transparency that goes in between them? You could try
10649 and insert vertical space of the right size.
10650 The better way is to use
10661 \begin_layout Standard
10662 As their names imply,
10670 are two command-like paragraph environments that make all subsequent text
10671 invisible and visible, respectively.
10672 Note from section\InsetSpace ~
10674 \begin_inset LatexCommand ref
10675 reference "sec:slideQuirk"
10679 that you don't place anything
10683 these two environments, however.
10688 , it inserts a centered, sky-blue label into the page reading
10689 \begin_inset Quotes eld
10692 <Invisible Text Follows>
10693 \begin_inset Quotes erd
10697 For paragraphs following this label, the parts of the
10705 ; it doesn't matter which] where they would be contain instead blank space.
10709 \begin_layout Standard
10714 , the corresponding centered label is
10715 \begin_inset Quotes eld
10718 <Visible Text Follows>
10719 \begin_inset Quotes erd
10723 Paragraphs following this label behave normally.
10724 Note that the beginning of a new
10736 automatically shuts off an
10741 It's therefore not necessary to use
10752 \begin_layout Standard
10753 By now, it should be obvious how to create overlay transparencies using
10754 the proper combination of
10773 \begin_layout Enumerate
10778 , including everything that will appear on it, whether on the main slide
10786 \begin_layout Enumerate
10787 Before each figure or paragraph that will appear only on the
10796 If necessary, insert a
10800 environment after the
10807 \begin_layout Enumerate
10812 immediately following the
10819 \begin_layout Enumerate
10820 Copy the contents of this
10831 \begin_layout Enumerate
10836 , change all of the
10847 \begin_layout Standard
10849 You've just made an
10856 \begin_layout Standard
10857 There's one problem with the way I've designed the LyX
10861 class: you can't make text in the middle of a paragraph invisible, nor
10862 make text in the middle of an invisible paragraph visible again.
10863 To accomplish this feat, you'll need to use some inlined LaTeX codes.
10867 \begin_layout Standard
10868 The commands of interest are:
10871 \begin_layout Itemize
10876 invisible \SpecialChar \ldots{}
10880 \begin_layout Itemize
10885 visible \SpecialChar \ldots{}
10889 \begin_layout Standard
10890 \SpecialChar \ldots{}
10891 and need to be marked as TeX.
10893 \begin_inset Quotes eld
10897 \begin_inset Quotes erd
10900 you wish to change goes in between the brackets [and after the
10913 If you don't know how to mark text as TeX, see the appropriate section
10926 \begin_layout Subsubsection
10936 \begin_inset LatexCommand label
10937 name "sec:slideNote"
10944 \begin_layout Standard
10953 is associated with a
10954 \begin_inset Quotes eld
10958 \begin_inset Quotes erd
10970 class provides visual cues.
10975 is shorter than that of a
10979 [yet longer than that of an
10983 ] and, like the label of an
10987 is shockingly magenta.
10988 Additionally, the printed
10992 has the page number of its
10993 \begin_inset Quotes eld
10997 \begin_inset Quotes erd
11005 \begin_inset Quotes eld
11013 \begin_inset Quotes erd
11017 \begin_inset Quotes eld
11025 \begin_inset Quotes erd
11029 \begin_inset Quotes eld
11037 \begin_inset Quotes erd
11041 You can have multiple
11045 s associated with a single
11057 , you'll probably want to break up long
11061 s so that they fit on a single sheet of paper.
11064 \begin_layout Standard
11069 is obvious: it contains anything additional you might want to say about
11075 It could also be used as a sheet of reminders for a particular
11080 In the case of the latter, you might want to make use of time markers.
11086 \begin_inset Quotes eld
11090 \begin_inset Quotes erd
11093 support for time markers, a
11098 So, you'll have to resort to using the LaTeX codes.
11101 \begin_layout Standard
11102 To use time markers, you'll need to specify the extra class option
11103 \begin_inset Quotes eld
11111 \begin_inset Quotes erd
11114 [see section\InsetSpace ~
11116 \begin_inset LatexCommand ref
11117 reference "sec:slidesetup"
11122 This option turns on timing marks, which will appear in the lower-left-hand
11128 To set what appears in the time marker, you use the LaTeX commands
11129 \begin_inset Quotes eld
11139 \begin_inset Quotes erd
11143 \begin_inset Quotes eld
11153 \begin_inset Quotes erd
11157 The arguments of both commands are time measured in seconds.
11159 \begin_inset Quotes eld
11169 \begin_inset Quotes erd
11172 sets the time marker to a given time.
11174 \begin_inset Quotes eld
11184 \begin_inset Quotes erd
11187 increments the time marker by the specified amount.
11188 Using time markers and
11192 s in this fashion, you can remind yourself how much time to spend on a particula
11200 \begin_layout Standard
11201 There's one last feature to describe.
11202 Clearly, you'd like to print out all of your
11210 s on transparencies while printing all of your
11227 with which it is associated.
11228 What's a person to do?
11231 \begin_layout Standard
11232 Luckily, there are two LaTeX commands that allow you to select what to print
11234 Both must be placed into the preamble of your document.
11236 \begin_inset Quotes eld
11248 \begin_inset Quotes erd
11251 will cause the output to contain only the
11260 Correspondingly, the command
11261 \begin_inset Quotes eld
11273 \begin_inset Quotes erd
11276 prevents the output of anything but
11281 I'd advise placing both commands in the preamble and initially comment
11283 You can then preview your entire presentation as you write.
11284 When you're done writing, you can then uncomment one of the two to select
11285 what you want to print.
11286 I like to uncomment
11287 \begin_inset Quotes eld
11299 \begin_inset Quotes erd
11302 , print to a file with
11303 \begin_inset Quotes eld
11311 \begin_inset Quotes erd
11314 in its name, comment it back out, then uncomment
11315 \begin_inset Quotes eld
11327 \begin_inset Quotes erd
11331 \begin_inset Quotes eld
11339 \begin_inset Quotes erd
11343 I can then send either file to a printer, loading transparencies or plain
11344 paper as appropriate.
11347 \begin_layout Standard
11348 You can also provide other arguments to the
11349 \begin_inset Quotes eld
11359 \begin_inset Quotes erd
11363 \begin_inset Quotes eld
11373 \begin_inset Quotes erd
11377 See a good LaTeX book for details.
11380 \begin_layout Subsection
11385 Class Template File
11388 \begin_layout Standard
11389 I have also provided a template file,
11390 \begin_inset Quotes eld
11398 \begin_inset Quotes erd
11406 To use it, begin your new presentation with
11411 ile\SpecialChar \menuseparator
11421 Your new LyX presentation file will contain an example
11442 additionally contain an example of the use of
11451 Lastly, the preamble will contain:
11454 \begin_layout LyX-Code
11455 % Uncomment to print out only slides and overlays
11458 \begin_layout LyX-Code
11462 \begin_layout LyX-Code
11472 \begin_layout LyX-Code
11473 % Uncomment to print out only notes
11476 \begin_layout LyX-Code
11480 \begin_layout LyX-Code
11488 \begin_layout Standard
11489 One final thing: I created this class to support the LaTeX2e
11490 \begin_inset Quotes eld
11498 \begin_inset Quotes erd
11501 class, one of the built-in LaTeX2e classes.
11502 Neither I nor the rest of the LyX Team endorse or oppose the use of this
11503 built-in slide class.
11504 It's here if you want it or need it.
11505 There exist other LaTeX2e classes for creating presentations, such as the
11510 class [see section\InsetSpace ~
11512 \begin_inset LatexCommand ref
11513 reference "sec:foiltex"
11518 \begin_inset Quotes eld
11526 \begin_inset Quotes erd
11529 package [present on some TeX distributions].
11530 The latter is not yet supported under LyX.
11534 \begin_layout Standard
11535 Perhaps you can take on the task\SpecialChar \ldots{}
11541 I know nothing about these other classes.
11542 Try them out to see what sort of alternative they provide.
11545 \begin_layout Section
11554 \begin_inset LatexCommand label
11562 \begin_layout Standard
11568 \begin_layout Subsection
11572 \begin_layout Standard
11573 This section describes how to use LyX to make slides for overhead projectors.
11574 There are two document classes that can do this: the default slides class
11580 This section documents the latter.
11583 \begin_layout Standard
11584 I'm going to say this again, nice and clear, so that there's no misunderstanding
11588 \begin_layout Standard
11589 \begin_inset VSpace bigskip
11595 \begin_layout Standard
11599 This section documents the class
11600 \begin_inset Quotes eld
11608 \begin_inset Quotes erd
11616 \begin_layout Standard
11617 \begin_inset VSpace bigskip
11623 \begin_layout Standard
11624 If you're looking for the documentation for
11625 \begin_inset Quotes eld
11633 \begin_inset Quotes erd
11636 , check out section\InsetSpace ~
11638 \begin_inset LatexCommand ref
11639 reference "sec:slitex"
11644 If your machine doesn't have the
11649 \begin_inset Quotes eld
11657 \begin_inset Quotes erd
11660 ] installed, you'll probably have to use the default
11664 class, which isn't quite as good as
11669 \begin_layout Standard
11674 class is designed for use with version 2.1 of the
11678 LaTeX class file which is now an integral part of LaTeX2e.
11681 \begin_layout Subsection
11685 \begin_layout Standard
11686 Obviously, to use this document class, you need to select
11687 \begin_inset Quotes eld
11695 \begin_inset Quotes erd
11707 Document\InsetSpace ~
11711 There are some settings in the
11713 Document\InsetSpace ~
11716 dialog that you should know about that are specific to this class:
11719 \begin_layout Itemize
11720 Don't change the options
11730 Document\InsetSpace ~
11734 They're ignored by the
11741 \begin_layout Itemize
11742 The default font size is 20pt with the other options being 17pt, 25pt and
11746 \begin_layout Itemize
11747 The default font is
11755 but all math equations are still typeset in the usual roman font.
11758 \begin_layout Itemize
11763 TeX supports A4 and Letter paper sizes as well as a special size for working
11765 It doesn't support A5, B5, legal or executive paper sizes.
11768 \begin_layout Itemize
11769 Don't bother changing the
11773 settings because they are ignored anyway.
11774 All floats appear where they are defined in the text.
11777 \begin_layout Itemize
11785 setting behaves a bit differently for this class.
11790 TeX provides extensive footer and header capabilities including a user-defined
11792 See section\InsetSpace ~
11794 \begin_inset LatexCommand ref
11795 reference "sec:foilfoot"
11800 The title page is treated differently to all other pages in the document
11809 has the logo centered at the bottom of the page (if one is defined).
11810 The possible page style choices and what they do are as follows:
11815 \labelwidthstring MMMMMMM
11822 The final output contains no page numbers, or other headers or footers
11823 (except footnotes of course).
11828 \labelwidthstring MMMMMMM
11835 The final output contains page numbers centered at the bottom of the page.
11836 No other headings or footers (other than footnotes).
11840 \labelwidthstring MMMMMMM
11845 Page numbers in lower right corner.
11846 Additional headers and footers are also shown.
11847 This is also the default.
11851 \labelwidthstring MMMMMMM
11856 Gives you access to the
11860 package although its use with
11864 TeX is discouraged by the writer of the
11868 TeX package because of some potential page layout clashes.
11872 \begin_layout Subsubsection
11876 \begin_layout Standard
11877 The following options may be used in the extra class options in the
11882 ocument\SpecialChar \menuseparator
11893 \labelwidthstring MMMMMMx
11898 This sets up the page layout for 7.33in by 11in paper, which is about the
11899 same aspect ratio as a 35mm slide, making it a bit easier to work with
11904 \labelwidthstring MMMMMMx
11909 Places a rule across the page below the header on every page except the
11914 \labelwidthstring MMMMMMx
11919 Places a rule across the page above the footer on every page except the
11924 \labelwidthstring MMMMMMx
11929 This is automatically set each time you create a new
11938 TeX to use the dvips driver to rotate those pages that are set as landscape
11943 \labelwidthstring MMMMMMx
11948 Simply changes the page dimensions to those of a landscape page but doesn't
11950 Thus if you use this option you need to use an external program to rotate
11951 each page or feed your paper through your printer as landscape.
11952 Note that this option effectively reverses the roles of the
11960 environments (don't worry these are described in the next section).
11964 \labelwidthstring MMMMMMx
11969 Equation numbers on the left.
11973 \labelwidthstring MMMMMMx
11978 Flush-left equations.
11981 \begin_layout Subsection
11982 Supported Environments
11985 \begin_layout Standard
11986 Most of the environments commonly supported in other classes are also supported
11992 There are several additional environments provided by
11996 TeX as well as a couple added by LyX.
11997 The following environments are shared with other classes:
12000 \begin_layout Standard
12004 \begin_layout Standard
12008 begin{multicols}{2}
12016 \begin_layout Itemize
12022 \begin_layout Itemize
12028 \begin_layout Itemize
12034 \begin_layout Itemize
12040 \begin_layout Itemize
12046 \begin_layout Itemize
12052 \begin_layout Itemize
12058 \begin_layout Itemize
12064 \begin_layout Itemize
12070 \begin_layout Itemize
12076 \begin_layout Itemize
12082 \begin_layout Itemize
12088 \begin_layout Itemize
12094 \begin_layout Itemize
12100 \begin_layout Itemize
12106 \begin_layout Itemize
12112 \begin_layout Itemize
12118 \begin_layout Itemize
12124 \begin_layout Standard
12128 \begin_layout Standard
12140 \begin_layout Standard
12141 That is, all the major environments apart from the sectioning environments.
12142 Since foils are essentially self-contained sections, with a title and body,
12147 TeX provides specific commands for starting new foils and these are:
12150 \begin_layout Itemize
12156 \begin_layout Itemize
12162 \begin_layout Standard
12163 LyX also provides slightly modified versions of these two environments called:
12166 \begin_layout Itemize
12172 \begin_layout Itemize
12175 ShortRotatefoilhead
12178 \begin_layout Standard
12179 and the differences will be explained in the next section.
12182 \begin_layout Standard
12183 Since foils are often used in presenting ideas or new theorems and such
12188 TeX also provides a comprehensive box of goodies for presenting them:
12191 \begin_layout Standard
12195 \begin_layout Standard
12199 begin{multicols}{2}
12207 \begin_layout Itemize
12213 \begin_layout Itemize
12219 \begin_layout Itemize
12225 \begin_layout Itemize
12231 \begin_layout Itemize
12237 \begin_layout Itemize
12243 \begin_layout Itemize
12249 \begin_layout Itemize
12255 \begin_layout Itemize
12261 \begin_layout Itemize
12267 \begin_layout Itemize
12273 \begin_layout Standard
12277 \begin_layout Standard
12289 \begin_layout Standard
12290 The starred versions are unnumbered while the unstarred versions are numbered.
12291 There are also two list environments added by LyX and these are:
12294 \begin_layout Itemize
12300 \begin_layout Itemize
12306 \begin_layout Standard
12311 TeX provides some powerful header and footer capabilities that are best
12312 set in the preamble although they may be set at any point in a document.
12313 If you want to change these settings in your document the best place to
12314 do so is at the very top of a foil,
12319 straight after the foilhead.
12322 \begin_layout Standard
12323 For this purpose, the following command styles are provided [
12330 \begin_layout Standard
12334 \begin_layout Standard
12338 begin{multicols}{2}
12346 \begin_layout Itemize
12353 \begin_layout Itemize
12359 \begin_layout Itemize
12366 \begin_layout Itemize
12373 \begin_layout Itemize
12381 \begin_layout Standard
12387 \begin_layout Standard
12391 \begin_layout Standard
12403 \begin_layout Standard
12404 There are also a few commands provided by
12408 TeX that aren't directly supported by LyX but I'll tell you what they do
12409 and how to use them in section\InsetSpace ~
12411 \begin_inset LatexCommand ref
12412 reference "sec:unsuppfoils"
12419 \begin_layout Subsection
12420 Building a Set of Foils
12423 \begin_layout Standard
12424 This section will give a simple introduction to using the different environments
12425 to build a set of foils.
12426 If you want to see an example set of foils take a look at the
12430 file accessible from the
12435 ile\SpecialChar \menuseparator
12440 pen\SpecialChar \ldots{}
12451 \begin_layout Subsubsection
12452 Give It a Title Page
12455 \begin_layout Standard
12456 Unlike other classes that provide
12476 creates the title on a page of its own.
12477 If you leave out the
12481 environment LaTeX will substitute the current date (every time you regenerate
12485 \begin_layout Subsubsection
12489 \begin_layout Standard
12490 As I mentioned earlier, there are four ways of starting a new foil.
12491 For portrait foils you should use
12500 The difference between these two environments is the amount of space between
12501 the title of the foil (the foilhead) and the body of the foil.
12504 \begin_layout Standard
12505 Landscape foils are generated using the
12511 ShortRotatefoilhead
12514 Again the only difference is the spacing between foilhead and body.
12515 Both of the short versions have 0.5 inches less separation between the foilhead
12520 \begin_layout Standard
12521 One problem with the support for landscape foils is the requirement that
12522 you have to use the
12526 driver to generate the PostScript output otherwise the foils won't be rotated.
12527 It is possible to get landscape foils even if you haven't got the
12531 driver provided you can feed your foils sideways through your printer ;-)
12534 \begin_layout Subsubsection
12535 Theorems, Lemmas, Proofs and more
12538 \begin_layout Standard
12539 Due to a small bug in LyX you can't have two of the same type of these environme
12540 nts directly following each other.
12541 They must be separated by something.
12542 If you try, you will just be extending the previous environment as if you
12543 had merged the two environments together.
12544 So, how do you get around this problem? The simplest option is to insert
12545 some text between the two environments or add a
12549 environment between the two with just a
12550 \begin_inset Quotes eld
12558 \begin_inset Quotes erd
12562 This will force LyX to produce two separate environments and hence the
12563 correct LaTeX output.
12564 An example is provided in the example file included with the LyX distribution.
12565 Remember, this problem only occurs if you are trying to place two of the
12566 same type of theorem-like environments one directly after the other.
12569 \begin_layout Subsubsection
12573 \begin_layout Standard
12574 You get all the commonly supported list styles found in other classes as
12575 well as two new ones.
12576 I'll only describe the new ones here.
12577 If you want to find out more about the other list environments check out
12583 If you intend to use itemized lists you might also want to read about the
12586 Itemize\InsetSpace ~
12587 Bullet\InsetSpace ~
12590 dialog described above in section\InsetSpace ~
12592 \begin_inset LatexCommand ref
12593 reference "sec:bullet"
12600 \begin_layout Standard
12601 The two new list styles,
12609 , are designed to make it easier for you to create lists of do's and don'ts
12610 or right and wrong by providing dedicated environments that use a tick
12611 or a cross as the label of the list.
12612 These lists are in fact dedicated variants of the
12617 They do however require that you have the
12621 packages installed.
12624 \begin_layout Subsubsection
12628 \begin_layout Standard
12633 TeX redefines the floating tables and figures so that they appear exactly
12634 where they are in the text rather than pushing them to the top of the page
12635 or to some user specified location.
12636 In fact if you change the float placement settings they are simply ignored.
12639 \begin_layout Subsubsection
12640 Page Headers and Footers
12641 \begin_inset LatexCommand label
12642 name "sec:foilfoot"
12649 \begin_layout Standard
12659 are two commands used to control the left-footer text string.
12660 The first is meant to allow you to include a graphic logo on your foils
12662 \begin_inset Quotes eld
12670 \begin_inset Quotes erd
12674 While the second is meant to provide a classification for the audience,
12677 e.\InsetSpace \thinspace{}
12682 It is empty by default.
12685 \begin_layout Standard
12686 The remaining page corners can be filled by
12691 (which defaults to page numbers),
12704 \begin_layout Subsection
12710 \begin_inset LatexCommand label
12711 name "sec:unsuppfoils"
12718 \begin_layout Standard
12719 All the commands mentioned below need to be set in a
12727 within another environment.
12730 \begin_layout Subsubsection
12734 \begin_layout Standard
12735 All lengths are adjusted using the
12758 should be replaced by the name given to the length you want to change and
12763 is the length value.
12764 All lengths should be specified in units of length such as inches (
12776 ) or relative to some document or font-based length such as
12786 \begin_layout Standard
12787 It's possible to change the spacing between a foilhead and the body of the
12788 foil by adjusting the length specified by
12795 For example, to make
12799 foilheads 0.5 inches closer to their bodies put the following in the preamble:
12806 foilheadskip}{-0.5in}
12809 \begin_layout Standard
12810 The spacings around floats can be adjusted by setting these lengths:
12814 \labelwidthstring MMMMMMMMMMM
12821 Separation between the text and the top of the float
12825 \labelwidthstring MMMMMMMMMMM
12832 Separation between the float and the caption
12836 \labelwidthstring MMMMMMMMMMM
12843 Separation between the caption and the following text
12847 \labelwidthstring MMMMMMMMMMM
12854 You can make the captions narrower than the surrounding text by adjusting
12856 Best done relative to
12865 \begin_layout Standard
12866 There are also several title page related lengths that you may find useful
12867 if you have a long title or several authors:
12871 \labelwidthstring MMMMMMMMMMM
12878 Separation from headers to
12884 \labelwidthstring MMMMMMMMMMM
12903 \labelwidthstring MMMMMMMMMMM
12918 \labelwidthstring MMMMMMMMMMM
12935 \labelwidthstring MMMMMMMMMMM
12951 \begin_layout Standard
12952 The last length related command affects all the list environments.
12963 a list environment then all the vertical spacing between the list items
12965 Note that this is a command not a length so it doesn't require
12971 like the stuff mentioned above.
12974 \begin_layout Subsubsection
12975 Headers and Footers
12978 \begin_layout Standard
12991 commands control whether the logo in the
12995 definition appear on a given page.
13002 in the preamble then none of the foils will have the logo on them.
13003 If you don't want the logo on a particular page place the
13009 directly after the foilhead of that page and the
13015 directly after the next foilhead.
13018 \begin_layout Standard
13019 If you decide to use the
13023 page style setting in the
13025 Document\InsetSpace ~
13028 dialog you should probably add
13038 to your preamble so headers and footers on landscape pages are correctly
13039 placed when rotated.
13040 This is due to some clashes between the page layouts provided by the
13051 \begin_layout Section
13052 Latex8 (IEEE Conference Papers)
13055 \begin_layout Standard
13061 \begin_layout Subsection
13065 \begin_layout Standard
13066 Since this class is specifically for writing submissions to IEEE sponsored
13067 conferences I strongly recommend that you get a copy of their Authors Kit.
13072 package and associated bibliography style file is included in the kit.
13073 The Authors Kit is usually sent out by email once your initial submission
13075 There is a lot of useful information in the Authors Kit explaining formatting
13076 restrictions and so on and I will assume you have read this since that
13077 means I don't have to repeat it all here.
13080 \begin_layout Subsection
13084 \begin_layout Standard
13085 [AR\SpecialChar \@.
13089 \begin_layout Subsection
13090 Supported Environments
13093 \begin_layout Itemize
13099 \begin_layout Itemize
13105 \begin_layout Itemize
13111 \begin_layout Itemize
13117 \begin_layout Itemize
13123 \begin_layout Itemize
13129 \begin_layout Itemize
13135 \begin_layout Itemize
13141 \begin_layout Itemize
13147 \begin_layout Subsection
13148 Differences Between Screen and Paper
13151 \begin_layout Standard
13152 There are slight differences in appearance mainly with the presentation
13153 of section counters.
13154 On screen the trailing period of the section counter is missing but it
13155 will appear in the output so don't let this worry you.
13158 \begin_layout Section
13159 Hollywood (Hollywood spec scripts)
13162 \begin_layout Standard
13168 \begin_layout Subsection
13172 \begin_layout Standard
13173 Getting the format of a Hollywood script right is a
13174 \begin_inset Quotes eld
13178 \begin_inset Quotes erd
13181 It is designed to make the readers focus on content and to be easy and
13182 familiar for the actors to read.
13183 Each page of a script should be one minute of film.
13184 Nothing goes in a script that you cannot see or hear on screen.
13185 The courier 12 pt font should be used throughout.
13189 \begin_layout Subsection
13193 \begin_layout Standard
13194 Speakers' lines should NEVER break in mid-sentence.
13195 If a speaker's lines continue over a page break, repeat the
13199 title followed by (Cont'd).
13202 \begin_layout Subsection
13206 \begin_layout Standard
13211 names as labels then cross-reference the label to insert the name.
13212 The cross-reference dialog will show the current cast of characters.
13213 You can use this to insert the speaker name in narratives also.
13216 \begin_layout Subsection
13217 Paper size and Margins
13220 \begin_layout Standard
13221 USLetter, left 1.6in, right 0.75in, top 0.5in, bottom 0.75in
13224 \begin_layout Subsection
13228 \begin_layout Standard
13229 The following environments are available.
13230 You can use hollywood.bind to get the bind keys shown at the right.
13233 \begin_layout Itemize
13240 Used where nothing else works.
13244 \begin_layout Itemize
13257 Usually followed by something like
13258 \begin_inset Quotes eld
13261 on Sally waking up.
13262 \begin_inset Quotes erd
13268 \begin_layout Itemize
13277 Introduces a new INTERIOR camera set-up.
13278 Always followed by DAY or NIGHT, or something similar to define the lighting
13280 Everthing on this line in CAPS.
13283 \begin_layout Itemize
13292 Introduces a new EXTERIOR camera set-up.
13293 Everthing on this line in CAPS.
13296 \begin_layout Itemize
13305 The character speaking.
13308 \begin_layout Itemize
13317 Instructions to the speaker.
13318 The () are automatically inserted, but only the ( will show in LyX.
13319 Both will be printed.
13322 \begin_layout Itemize
13338 \begin_layout Itemize
13347 Camera movement instruction.
13348 e.\InsetSpace \thinspace{}
13353 \begin_layout Itemize
13361 \begin_layout Itemize
13369 \begin_layout Itemize
13377 \begin_layout Itemize
13385 \begin_layout Subsection
13389 \begin_layout Itemize
13390 (O.S) --- off screen
13393 \begin_layout Itemize
13394 (V.0) --- voice over
13397 \begin_layout Itemize
13402 \begin_layout Itemize
13407 \begin_layout Itemize
13408 PAN --- camera movement
13411 \begin_layout Itemize
13412 INSERT --- cut to close-up of
13415 \begin_layout Section
13419 \begin_layout Standard
13425 \begin_layout Subsection
13429 \begin_layout Standard
13430 Broadway is for writing plays.
13431 The format is more decorative than Hollywood, and much less standardized.
13432 This format should be suitable for workshops.
13435 \begin_layout Subsection
13439 \begin_layout Standard
13440 The same as in Hollywood.
13443 \begin_layout Subsection
13447 \begin_layout Standard
13452 names as labels then cross-reference the label to insert the name.
13453 The cross-reference dialog will show the current cast of characters.
13456 \begin_layout Subsection
13457 Paper size and Margins
13460 \begin_layout Standard
13461 USLetter, left 1.6in, right 0.75in, top 0.5in, bottom 0.75in
13464 \begin_layout Subsection
13468 \begin_layout Standard
13469 The following environments are available.
13470 You can use broadway.bind to get the bind keys shown at the right.
13473 \begin_layout Itemize
13480 You should not have to use this, but it is here for anything that does not
13484 \begin_layout Itemize
13493 Used to describe stage setting and the action.
13494 First use of speaker names in all CAPs.
13497 \begin_layout Itemize
13506 Automatically numbered.
13507 On screen it will be arabic, but will print as Roman.
13510 \begin_layout Itemize
13524 It is just centered text.
13527 \begin_layout Itemize
13536 Not automatically numbered.
13537 You supply the number.
13538 This is because I couldn't figure out how.
13541 \begin_layout Itemize
13550 A special case of Narrative to describe the setting and action as the curtain
13554 \begin_layout Itemize
13563 The speaker's (actor's) title, centered in all CAPS.
13566 \begin_layout Itemize
13575 Instructions to the speaker.
13576 The parentheses are automatically inserted.
13577 The ( will appear on screen, but both will be in the printed play.
13578 This environment is only used within
13585 \begin_layout Itemize
13594 What the Speaker says.
13597 \begin_layout Itemize
13606 The curtain comes down.
13609 \begin_layout Itemize
13617 \begin_layout Itemize
13625 \begin_layout Itemize
13633 \begin_layout Standard
13637 \begin_layout Section
13641 \begin_layout Standard
13647 \begin_layout Standard
13648 \begin_inset VSpace bigskip
13654 \begin_layout Standard
13658 Revtex\InsetSpace ~
13661 textclass works with the American Physical Sociey's RevTeX 4.0 (the
13662 \begin_inset Formula $\beta$
13665 release of May, 1999) class.
13668 \begin_layout Standard
13673 textclass, which works with RevTeX 3.1.
13674 However, v3.1 is basically obsolete, as it works with LaTeX 2.09.
13675 That means that it doesn't interact very well with LyX, which requires
13676 LaTeX2e, although it has been kludged to work.
13677 Since RevTeX 4.0 has been designed to work much more cleanly with LaTeX2e,
13680 RevTeX\InsetSpace ~
13683 textclass should also be pretty easy to use.
13686 \begin_layout Standard
13687 These documents are supposed to be used in
13691 to the RevTeX 4.0 documents, so we don't describe any of the special RevTeX
13692 macros, and assume you'll know what to put in the preamble if necessary.
13695 \begin_layout Subsection
13699 \begin_layout Standard
13700 All you need to do is install RevTeX 4, as described in the package's README
13702 The package can be found at
13703 \begin_inset LatexCommand url
13704 name "The RevTeX 4 Web Site"
13705 target "http://publish.aps.org/revtex4/"
13710 Install it somewhere that LaTeX can see it.
13711 Test it by trying to LaTeX a short RevTeX 4 document in some random directory
13712 (i.e., not the directory where you installed the class file.) Then, if you
13713 reconfigure LyX, it will find the class file and let you use the RevTeX4
13717 \begin_layout Standard
13718 Probably the easiest way to get started is either to import a RevTeX 4 document
13725 Revtex\InsetSpace ~
13728 template, found in the templates directory.
13731 \begin_layout Subsection
13735 \begin_layout Standard
13736 Optional arguments to
13743 \begin_inset Quotes eld
13747 \begin_inset Quotes erd
13751 \begin_inset Quotes eld
13755 \begin_inset Quotes erd
13769 Document\InsetSpace ~
13773 Remember that in RevTeX, at least one optional argument is required!
13776 \begin_layout Standard
13777 Other preamble matter, like
13793 dialog, also as usual.
13796 \begin_layout Subsection
13800 \begin_layout Standard
13801 The layouts basically correspond to the commands in RevTeX4.0.
13802 For example, the Email layout corresponds to
13809 Note that (at least as of RevTeX 4.0 Beta), the
13817 layouts are exactly equivalent, so you shouldn't need to use both.
13821 \begin_layout Standard
13822 In case you're curious, both were included so that
13826 would be able to translate both
13846 \begin_layout Subsection
13850 \begin_layout Standard
13851 There are a couple of important unique aspects of RevTeX 4 which might cause
13852 bugs that will be even more confusing in LyX.
13855 \begin_layout Standard
13873 The LyX equivalent is that there is a separate Thanks layout.
13878 write footnotes in the
13882 layout, or weird things may happen.
13883 See the RevTeX 4 documentation for more details.
13886 \begin_layout Standard
13889 Author\InsetSpace ~
13894 Author\InsetSpace ~
13901 layouts must be placed
13909 layout and the corresponding
13926 , the LaTeX won't compile.
13929 \begin_layout Subsection
13933 \begin_layout Standard
13934 The main problem with this layout is that you can't use the optional arguments
13935 to layouts like Email and Title.
13936 (The problem is not unique to this layout; you can't use optional arguments
13937 to the Section layouts either.) This means that after you export that file
13938 to LaTeX (which you'll need to do eventually to send it in to APS), you'll
13939 need to edit the LaTeX file with a text editor to add the optional arguments
13940 to set, e.\InsetSpace \thinspace{}
13941 g., the running title for the page headers.
13942 Lacking these layouts makes the
13948 (and the equivalent
13954 ) useless, so the corresponding layouts don't exist, and will have to be
13959 \begin_layout Standard
13964 actually, LyX 1.3.0 supports some forms of optional arguments, but this layout
13965 has not been updated yet to take advantage of it.
13973 \begin_layout Section
13974 Article (mwart), book (mwbk) and report (mwrep)
13975 \begin_inset OptArg
13978 \begin_layout Standard
13991 \begin_layout Standard
13997 \begin_layout Standard
13998 The LyX document classes
14014 correspond to the LaTeX document classes
14027 They are replacements for the standard document classes
14039 , resp., and fit better to Polish typography conventions in a number of points.
14043 \begin_layout Standard
14047 \begin_layout Itemize
14048 Unnumbered titles (with star, eg.
14053 ) are added into table of contents,
14056 \begin_layout Itemize
14057 Additional page styles:
14061 \begin_layout Description
14062 uheadings header with separated lines,
14065 \begin_layout Description
14066 myheadings custom header, contents headers via commands:
14081 \begin_layout Description
14082 myuheadings custom header with separated lines,
14085 \begin_layout Description
14086 outer page number is placed on outer side of page
14090 \begin_layout Itemize
14095 \begin_layout Description
14096 rmheadings serif titles --- default,
14099 \begin_layout Description
14100 sfheadings sansserif titles,
14103 \begin_layout Description
14104 authortitle on title page first placed is author next title --- default,
14107 \begin_layout Description
14108 titleauthor on title page first placed is title next author,
14111 \begin_layout Description
14112 withmarginpar reserve place on page for margins.
14116 \begin_layout Section
14120 \begin_layout Standard
14126 \begin_layout Standard
14127 Elsevier Science Publishers B.V.
14128 provides a standard LaTeX document class (
14132 ) for submitting articles to their various journals.
14133 The style file can be downloaded directly from their web site:
14134 \begin_inset LatexCommand url
14135 target "http://authors.elsevier.com/"
14140 Instructions are supplied along with the class file, which details the
14141 requirements of the publishers.
14142 LyX includes package that allows for the use of this class, by a layout
14143 and a template file.
14144 Installation of the class file is the same as for any other LaTeX package;
14145 instructions are provided in the Elsevier documentation.
14148 \begin_layout Standard
14158 As the Elsevier class file is based mainly on the standard article class,
14159 most of the normal functionality is provided.
14160 The Elsevier class defines a number of mathematical environments, which
14161 are similar to the AMS environments.
14162 These commands are all described in the Elsevier documentation, and are
14166 \begin_layout Standard
14167 The easiest way to use the Elsevier style is to base documents on the included
14169 It is best not to use options such as fancy headings or the geometry package,
14170 as elements such as these are defined by Elsevier in their style file.
14171 Ideally, no extra packages except those mentioned in the Elsevier documentation
14173 Essentially, Elsevier require as
14174 \begin_inset Quotes eld
14178 \begin_inset Quotes erd
14185 \begin_layout Standard
14194 file as possible, as their intention is to take the supplied file and replace
14195 the class file with one for the particular journal to which the paper has
14197 This also means that not too much time should be spent on the formating
14199 When it comes to be published, this will change anyway.
14200 The rest of the usage for this layout is substantially the same as for
14201 the normal article class.
14202 For details of what Elsevier do and don't allow, refer to their documentation.
14205 \begin_layout Section
14209 \begin_layout Standard
14212 Jürgen Spitzmüller
14215 \begin_layout Subsection
14219 \begin_layout Standard
14220 Memoir is a very powerful and constantly evolving class.
14221 It has been designed with regard to fictional and non-fictional literature.
14222 Its aim is to let the user have maximum control over the typesetting of
14224 Memoir is based on the standard book class, but it can also emulate the
14225 article class (see below).
14228 \begin_layout Standard
14229 Peter Wilson, the developer of Memoir, is known as the author of lots of
14230 useful packages in the LaTeX world.
14231 Most of them have been merged with Memoir.
14232 Therefore, it is much easier to layout the table of contents, appendices,
14233 chapter designs and such.
14234 LyX, though, does not support all of these goodies natively.
14235 Some of them might be added to forthcoming releases
14239 \begin_layout Standard
14240 You are invited to send suggestions to
14241 \begin_inset LatexCommand url
14242 target "lyx-devel@lists.lyx.org"
14251 , lots will probably never, due to the limitations of LyX's framework.
14252 Of course you can still use all features with the help of some native LaTeX
14257 \begin_layout Standard
14262 \begin_layout Standard
14271 section\InsetSpace ~
14273 \begin_inset LatexCommand ref
14274 reference "sec:Inserting-LaTeX-Code"
14284 In this section, we can only list those features which are natively supported
14286 For detailed descriptions (and for the rest of features) we are recommending
14287 to have a look at the detailed manual of the Memoir class
14291 \begin_layout Standard
14296 \begin_layout Standard
14306 \begin_inset LatexCommand url
14307 target "CTAN:/macros/latex/memoir/memman.pdf"
14316 , which is not only a user guide for the class, but also both a comprehensive
14317 description on good typesetting and a superb example for good typesetting
14321 \begin_layout Subsection
14322 Basic features and restrictions
14325 \begin_layout Standard
14326 Memoir supports basically all features of the standard book classes.
14327 There are, however, some differences, as follows:
14330 \begin_layout Description
14332 sizes: Memoir has a broader range of font sizes: 9, 10, 11, 12, 14,
14336 \begin_layout Description
14338 style: The fancy page style is not supported, due to a command clash
14339 between Memoir and the fancyhdr package (they are both defining a command
14340 with the same name, which confuses LaTeX).
14341 Instead, Memoir comes with a bunch of own page styles (see
14343 Layout\SpecialChar \menuseparator
14344 Document\SpecialChar \menuseparator
14349 If you want to use these for the chapter pages, you have to use the command
14356 in the main text or in preamble (e.
14360 \begin_layout Standard
14373 \begin_layout Standard
14386 chapterstyle{companion}
14391 \begin_layout Description
14392 Sectioning: Sectionings (chapter, section, subsection etc.) are coming with
14393 an optional argument in the standard classes.
14394 With this, you can specify an alternative version of the title for the
14395 table of contents and the headers (for instance, if the title is too long).
14396 In LyX, you can do this via
14398 Insert\SpecialChar \menuseparator
14402 at the beginning of a chapter/section.
14403 Memoir features a second optional argument and thus separates the table
14404 of contents from the header.
14405 You can define three variants of a title with this: one for the main text,
14406 one for the table of contents, and one for the headers.
14407 Simply insert two optional arguments if you need this feature, the first
14408 one containing the short title for the Table of Contents, the second one
14409 containing an alternative short title for the headers.
14412 \begin_layout Description
14413 TOC/LOT/LOF: In the standard classes (and in many other classes), the table
14414 of contents, the list of figures and the list of table start a new page
14416 Memoir does not follow this route.
14417 You have to insert a page break yourself, if you want to have one.
14420 \begin_layout Description
14421 Titlepage: For some unknown reason, Memoir uses pagination on the title
14422 page (in the standard classes, title pages are
14423 \begin_inset Quotes eld
14427 \begin_inset Quotes erd
14434 \begin_layout Standard
14447 \begin_layout Standard
14457 If you want an empty title page, type
14461 aliaspagestyle{title}{empty}
14466 \begin_layout Description
14467 Article: With the class option
14473 Layout\SpecialChar \menuseparator
14474 Document\SpecialChar \menuseparator
14478 ), you can emulate article style.
14479 That is, counters (footnotes, figures, tables etc.) will not be reset on
14480 new chapters, chapters don't start a new page (but are---in contrary to
14482 \begin_inset Quotes eld
14486 \begin_inset Quotes erd
14489 article classes---still allowed), parts, though, use their own page, as
14493 \begin_layout Description
14494 Oldfontcommands: By default, Memoir does not allow the use of the deprecated
14495 font commands, which have been used in the old LaTeX version 2.09 (e.
14499 \begin_layout Standard
14512 \begin_layout Standard
14534 It produces an error and stops LaTeX whenever such a command appears.
14539 reallows the commands and spits out warnings instead (which does at least
14541 Since a lot of packages and particularly BibTeX style files are still using
14542 those commands, we have decided to use this option by default.
14545 \begin_layout Subsection
14549 \begin_layout Standard
14550 We will only describe the features supported by LyX (which is not much currently
14552 Please consult the Memoir manual
14556 \begin_layout Standard
14561 \begin_layout Standard
14571 \begin_inset LatexCommand url
14572 target "CTAN:/macros/latex/memoir/memman.pdf"
14584 \begin_layout Description
14585 Abstract: You may wonder why an abstract is an extra feature.
14586 Well, it is in book class.
14587 Usually books don't have abstracts.
14588 Memoir, however, has.
14589 You can use it wherever and how often you like.
14592 \begin_layout Description
14593 Chapterprecis: You may know this from belletristic: The contents of a chapter
14594 is shortly described below the title and also in the table of contents
14599 \begin_layout Standard
14612 \begin_layout Standard
14623 Our hero arrives in Troia; he loses some friends; he finds others
14626 Chapterprecis does exactly this.
14627 It is therefore only sensible below a chapter.
14630 \begin_layout Description
14631 Epigraph: An epigraph is a smart slogan or motto at the beginning of a chapter.
14632 The epigraph environment provides an elegant way of typesetting such a
14634 The motto itself (text) and its author (source) are divided by a short
14636 Unfortunately, we have to fool LyX a bit here again, since the environment
14637 needs two arguments (text and source).
14638 In this case, we have to use curly brackets (in TeX mode) between the two
14649 <author of the slogan>.
14652 \begin_layout Description
14653 Poemtitle: Memoir has lots of possibilities to typeset poetry (up to very
14654 complex figurative poems).
14655 LyX can only support a few of them.
14656 One is poemtitle, which is a centered title for poems, which will also
14657 be added to the table of contents (verse is the standard environment for
14659 Memoir has some enhanced versions of verse, but you need to use ERT, because
14660 they have to be nested inside regular verse environments, which is not
14661 possible with LyX).
14664 \begin_layout Description
14665 Poemtitle*: Same as poemtitle, but it adds no entry to the table of contents.
14668 \begin_layout Chapter
14669 Importing and Exporting Alternate File Formats
14670 \begin_inset OptArg
14673 \begin_layout Standard
14674 Importing and Exporting
14682 \begin_layout Section
14686 \begin_layout Standard
14687 Importing and exporting LyX documents from/to other formats has been touched
14693 Here we describe more of the gory details needed to understand just what
14694 is going on when you click on the
14699 ile\SpecialChar \menuseparator
14711 ile\SpecialChar \menuseparator
14722 \begin_layout Section
14723 Importing Other Formats
14726 \begin_layout Subsection
14730 \begin_layout Standard
14731 Translating from LaTeX into LyX is performed by a Perl script called reLyX.
14732 Although it is a standalone program which can be called from the command
14733 line, LyX will call it automatically when a LaTeX document is imported.
14734 See section\InsetSpace ~
14736 \begin_inset LatexCommand ref
14737 reference "sec:reLyX"
14741 for a complete description.
14742 There are no user tunable parameters for reLyX within LyX.
14745 \begin_layout Subsection
14749 \begin_layout Standard
14750 When importing plain ASCII text, there are two methods of reading the file.
14752 \begin_inset Quotes eld
14756 \begin_inset Quotes erd
14759 preserves all the linebreaks in the ASCII; to LyX, then, each line looks
14762 \begin_inset Quotes eld
14766 \begin_inset Quotes erd
14769 assumes that consecutive lines separated by only a single linebreak form
14770 a single paragraph.
14771 Successive linebreaks with no intervening text are thus assumed to be paragraph
14775 \begin_layout Subsection
14779 \begin_layout Standard
14782 [Editor's note: Needs to be written, obviously - any volunteers? --- mer]
14785 \begin_layout Section
14786 Exporting Other Formats
14789 \begin_layout Standard
14790 The output formats listed here in the following are also explained concerning
14791 possible graphics formats in the
14798 \begin_layout Subsection
14802 \begin_layout Standard
14803 LyX generates two types of LaTeX files: stripped down versions for the normal
14808 , etc.) which one normally never sees
14812 \begin_layout Standard
14813 The resulting file is a perfectly valid LaTeX file, though the preamble
14814 might look a bit strange since it includes some definitions used by LyX
14815 which wouldn't show up in most human-written files.
14820 , and human readable forms which are suitable for exchanging with your colleague
14822 The only settable option for the translation is the line length of the
14824 The default is 65 characters, but it can be set in
14831 \SpecialChar \menuseparator
14852 \begin_layout Subsection
14853 Device Independent Files
14856 \begin_layout Standard
14857 Device Independent files (DVI files) are produced by running LaTeX on your
14859 There are no user settable options.
14862 \begin_layout Subsection
14866 \begin_layout Standard
14867 The next step in the conversion chain is converting a DVI file into Postscript.
14875 \SpecialChar \menuseparator
14883 \SpecialChar \menuseparator
14892 or, if you need more control on the result,
14899 \SpecialChar \menuseparator
14908 If you use the later, note that it is possible to configure, in
14915 \SpecialChar \menuseparator
14923 , the options passed to the dvips program to achieve different effects.
14926 \begin_layout Subsection
14930 \begin_layout Standard
14931 Exporting as ASCII attempts to preserve the
14932 \begin_inset Quotes eld
14936 \begin_inset Quotes erd
14939 of the document as well as possible, but things like centering and indentation
14940 are thrown out; paragraphs are separated by blank lines.
14941 Section numbering and cross-references are done correctly, so the resulting
14942 text files is remarkably readable.
14943 The only changeable option is the length of lines, as for LaTeX output.
14946 \begin_layout Subsection
14950 \begin_layout Standard
14951 LyX documents can be converted to hypertext markup, usually by converting
14952 to LaTeX first, then converting that to HTML\SpecialChar \@.
14954 \begin_inset Formula $\rightarrow$
14957 HTML converters are currently known to LyX:
14974 Though they are autodetected, you can overide the selection in preferences.
14975 You can also include further command line options in this dialog.
14979 \begin_layout Subsection
14983 \begin_layout Standard
14991 \begin_layout Standard
14992 \begin_inset VSpace bigskip
14998 \begin_layout Standard
14999 The fastest way to generate a basic PDF file (no tags, links, etc.) with
15000 any version of LyX is to save the document as a Postscript file, then run
15006 Starting with version 1.1.6, the menu item
15010 will do all this for you.
15011 There are some issues with fonts that you need to pay attention to: see
15012 Section\InsetSpace ~
15014 \begin_inset LatexCommand ref
15015 reference "sec:badfonts"
15020 Also, as of version 1.1.6, there is a better method that will generate much
15021 more sophisticated files.
15024 \begin_layout Subsubsection
15028 \begin_layout Standard
15029 With pdfLaTeX you cannot use pstricks.
15030 On the other hand, with pdfLaTeX it is possible to insert directly images
15031 in JPEG, PDF or PNG format, use TrueType fonts, and more.
15034 \begin_layout Subsubsection
15035 Why does the text look so bad when viewed with Acrobat Reader?
15036 \begin_inset LatexCommand label
15037 name "sec:badfonts"
15042 \begin_inset OptArg
15045 \begin_layout Standard
15046 Bad Fonts in Acrobat Reader
15054 \begin_layout Standard
15055 The problem is that bitmap fonts are displayed poorly by Acrobat Reader.
15056 When creating a PDF from the LyX file, you need to use outline font instead
15057 of the default bitmap fonts (in fact, you should also use outline fonts
15058 for Postscript files).
15059 Recent LaTeX distributions come with Postscript Type 1 version of the standard
15060 (Computer Modern) fonts.
15061 pdfLaTeX uses these font by default.
15062 Dvips doesn't use these fonts by default, so to make it use them, add the
15063 following to lines to your
15070 \begin_layout LyX-Code
15074 \begin_layout LyX-Code
15078 \begin_layout Standard
15079 If the default LaTeX font encoding (OT1) is used, nothing else need to be
15081 However, if the T1 font encoding is used, then LaTeX uses the newer EC
15082 fonts, for which there are no Type1 version.
15083 The solution is to use the ae package which emulates T1 coded fonts using
15084 the standard CM fonts.
15085 This is done by adding
15089 usepackage{ae,aecompl}
15091 to the preamble of the LyX file.
15092 However, some glyphs are missing from the CM fonts (e.\InsetSpace \thinspace{}
15095 they are taken from the EC fonts.
15096 Therefore you get these glyphs as bitmaps.
15099 \begin_layout Standard
15100 Note: LyX uses by default the T1 font encoding.
15101 If you wish to use the default font encoding (this is not recommended,
15102 unless you only write English documents), clear the field
15110 in preferences (tabs
15122 \begin_layout Standard
15123 An alternate option is to use the standard Postscript fonts instead of the
15124 Computer Modern fonts.
15125 To do that, you need to select
15129 as the global font in the document layout dialog.
15130 When using the Postscript fonts, the result PDF file is smaller as the
15131 fonts are not saved into the file.
15132 Furthermore, the Postscript fonts include all T1 glyphs.
15133 On the other hand, the Postscript fonts have no bold symbol font, so poor
15134 man's bold must be used (see Section\InsetSpace ~
15136 \begin_inset LatexCommand ref
15137 reference "sec:pdfbold"
15142 The Postscript fonts also look different from the Computer Modern fonts.
15145 \begin_layout Standard
15146 To sum up, both the Computer Modern and the Postscript fonts gives good
15147 results (with few exceptions).
15148 The decision of which one to use is a matter of taste.
15151 \begin_layout Subsubsection
15154 boldsymbol{} command work when I use pslatex?
15155 \begin_inset LatexCommand label
15161 \begin_inset OptArg
15164 \begin_layout Standard
15181 \begin_layout Standard
15182 The Postscript fonts do not have a bold symbol font.
15183 The solution is to use the
15189 (poor man's bold) command.
15192 \begin_layout Standard
15193 It is possible to redefine the
15208 \begin_layout LyX-Code
15218 \begin_layout Standard
15222 \begin_layout Subsubsection
15223 Is it possible to do write LaTeX-code which is processed only when running
15225 \begin_inset OptArg
15228 \begin_layout Standard
15229 Conditionals with pdfLaTeX
15237 \begin_layout Standard
15238 Yes you can do this with the
15243 Here is an example:
15246 \begin_layout LyX-Code
15250 \begin_layout LyX-Code
15256 \begin_layout LyX-Code
15262 \begin_layout LyX-Code
15265 pdfinfo { /Author (your name and e-mail address)
15268 \begin_layout LyX-Code
15269 /Title (official title -- i.e., title element)
15272 \begin_layout LyX-Code
15273 /Subject (one line description of the document)
15276 \begin_layout LyX-Code
15280 \begin_layout LyX-Code
15283 pdfcatalog { /PageMode (/UseNone)
15286 \begin_layout LyX-Code
15287 % /OpenAction (fitbh)
15290 \begin_layout LyX-Code
15294 \begin_layout LyX-Code
15297 usepackage[pdftex]{hyperref}
15300 \begin_layout LyX-Code
15306 \begin_layout LyX-Code
15309 usepackage[ps2pdf]{hyperref}
15312 \begin_layout LyX-Code
15318 \begin_layout Subsubsection
15319 How can I make URLs clickable?
15322 \begin_layout Standard
15323 See the references here:
15326 \begin_layout Standard
15327 \begin_inset LatexCommand url
15328 target "http://wiki.lyx.org/pmwiki.php/FAQ/PDF"
15335 \begin_layout Subsection
15339 \begin_layout Standard
15340 Custom exports are possible if you have some particularly weird format you
15341 wish to convert to, assuming you have the relevant converter, of course.
15346 file can be chosen in the
15351 ile\SpecialChar \menuseparator
15356 xport\SpecialChar \menuseparator
15363 dialog; LyX will automatically convert the file to this point, then feed
15364 it to your custom converter.
15365 The possible values are all formats that LyX can produce from its own documents.
15369 \begin_layout Standard
15370 The converter command is also specified in the dialog.
15371 It should be a completely qualified command line which uses the variable
15376 to specify the name of the file.
15377 If this variable is not given, then the file will be sent to the standard
15378 input of your command.
15379 You may have to apply a bit of ingenuity to escape this sequence correctly
15380 so that it is compatible with your shell.
15384 \begin_layout Standard
15385 While it is not possible to save this command using the
15389 dialog, you can manually edit your
15396 \begin_layout LyX-Code
15399 custom_export_command "mycommand $$FName"
15402 \begin_layout Chapter
15403 LyX Features needing Extra Software
15406 \begin_layout Section
15407 Using LyX with SGML-Tools (aka LinuxDoc)
15410 \begin_layout Standard
15416 \begin_layout Subsection
15420 \begin_layout Standard
15421 LinuxDoc is a document class available in LyX if you have the
15426 You can use it to produce documents in the so-called Standardized General
15427 Mark-up Language (SGML) in the particular format used by the Linux Documentatio
15429 That is obviously helpful if you are contributing to that project.
15430 You can use the SGML format with the
15434 package of scripts and programs (to produce other formats, including LaTeX,
15435 HTML, plain text, man pages and\SpecialChar \ldots{}
15437 You may therefore prefer to use this document class if you want to write
15438 something that can be easily translated into other formats.
15441 \begin_layout Standard
15442 You will find that LinuxDoc has fewer layout options than the other text
15444 This is mainly so that the translations into other formats have a chance
15445 of making some sense.
15446 In this section we describe:
15449 \begin_layout Itemize
15450 how to setup and use a document in LinuxDoc
15453 \begin_layout Itemize
15454 how to use the tags in LinuxDoc to layout your document
15457 \begin_layout Itemize
15458 how to use the SGML packages to produce the various formats
15461 \begin_layout Itemize
15462 how to sort out some problems.
15465 \begin_layout Subsection
15466 Preparing and using a LinuxDoc document
15469 \begin_layout Subsubsection
15473 \begin_layout Standard
15474 You start by selecting the LinuxDoc class using the
15479 ocument\SpecialChar \menuseparator
15487 Then you will find that there are fewer paragraph environments than for
15488 most other classes.
15489 You can see them on the pull down box on the left of the tool bar.
15490 How to use them is described in section\InsetSpace ~
15492 \begin_inset LatexCommand ref
15493 reference "sec:sgmlparas"
15500 \begin_layout Standard
15505 enter a title for the document, followed by an author, marking each with
15506 the appropriate paragraph environment.
15507 If you don't do this, you will get errors when you try to print the file.
15508 You can then enter the date and an abstract.
15509 The document proper must start with a Section paragraph environment rather
15510 than any standard layout.
15513 \begin_layout Standard
15514 After that you can prepare a document as usual using the available range
15515 of paragraph environments.
15516 See section\InsetSpace ~
15518 \begin_inset LatexCommand ref
15519 reference "sec:sgmlparas"
15523 for the full list and their uses.
15526 \begin_layout Subsubsection
15527 Output from LinuxDoc
15530 \begin_layout Standard
15531 You can print and save these documents in the normal way.
15532 To use the other features of the SGML package you need to save your document
15533 as LinuxDoc; this is a version in which the document is translated into
15534 the basic sgml tags.
15540 ile\SpecialChar \menuseparator
15545 xport\SpecialChar \menuseparator
15553 You will get a file with the same name and a
15557 extension rather than a
15564 \begin_inset LatexCommand ref
15565 reference "sec:sgmloperate"
15569 on how you than make use of this file.
15572 \begin_layout Subsection
15573 Using the paragraph environments in LinuxDoc
15576 \begin_layout Subsubsection
15577 The Structure of a LinuxDoc Document
15580 \begin_layout Standard
15581 There is a formal structure for LinuxDoc which limits how you can place
15583 There are two parts to all documents:
15586 \begin_layout Description
15587 Header: this is everything up to the first time you insert a Section layout
15589 It can include title, author, date, abstract and ToC.
15590 You must include the first two.
15593 \begin_layout Description
15594 Body: from the beginning of the first section onwards.
15595 All other tags are allowed.
15599 \begin_layout Subsubsection
15600 The LinuxDoc Paragraph Environments
15603 \begin_layout Standard
15604 \begin_inset LatexCommand label
15605 name "sec:sgmlparas"
15609 Here is a list of all the tags you will find listed on the layout bar in
15610 the order they come there, with some comments where the purpose or use
15614 \begin_layout Itemize
15621 works as described in [cross reference]
15624 \begin_layout Itemize
15629 : This will appear at the top left of the document when printed, above a
15630 heavy horizontal rule, although you will not see this on the LyX screen.
15633 \begin_layout Itemize
15636 Section, Subsection, Subsubsection, Paragraph and Subparagraph:
15638 all do what you would expect and in the usual order.
15639 Whether they are numbered or not is controlled by the
15641 Section\InsetSpace ~
15642 number\InsetSpace ~
15646 You cannot get the equivalent number free versions in any other way; there
15654 \begin_layout Itemize
15659 As usual this produces a numbered and indented list as described in the
15667 \begin_layout Itemize
15674 Again much the same as in the other classes: see the
15684 \begin_layout Itemize
15689 : As explained in the
15694 Remember that if you want the bold element at the start of a description
15695 to be more than one word then you need to put protected spaces between
15700 \begin_layout Itemize
15708 \begin_layout Itemize
15711 Code: similar to the LyX-Code
15718 \begin_layout Itemize
15723 : Anything you mark with this will appear on the left of the heading of
15724 the document, under the heavy rule.
15727 \begin_layout Itemize
15732 Anything you mark with this will appear on the right of the heading under
15734 You do not have to make this a date.
15735 Any text can be entered, e.\InsetSpace ~
15740 \begin_layout Itemize
15745 : You can use this to produce a free standing paragraph after the author
15746 and date, and before the first section.
15747 You are only allowed one such paragraph.
15751 \begin_layout Standard
15757 This needs checking ---
15767 \begin_layout Itemize
15776 \begin_layout Standard
15781 I have not yet checked this ---
15791 \begin_layout Subsubsection
15792 Other document features
15795 \begin_layout Standard
15796 You can also use the
15800 menu to set fonts or to emphasis words.
15801 You can also use the table of contents as usual; see the corresponding
15807 Although you will find some some other features on the menus e.\InsetSpace ~
15809 inserting footnotes.
15810 There is some doubt about whether these will work correctly.
15814 \begin_layout Standard
15819 Again still checking to see whether this is my system
15829 \begin_layout Subsubsection
15830 Cross references and HTML
15833 \begin_layout Standard
15838 menu you will find two new options relating to the inclusion of URL addresses.
15839 If you use either option you will find some highlighted TeX code inserted
15840 into your document in three separate blocks with spaces available between.
15841 The blocks will be:
15844 \begin_layout Quote
15876 \begin_layout Standard
15877 You insert a full HTML tag between the first and second blocks.
15879 \begin_inset LatexCommand url
15880 target "http://any.address"
15884 or other valid tags such as
15885 \begin_inset LatexCommand url
15886 target "mailto:me@my.address"
15898 insert some description between the second and third blocks.
15899 The differences are:
15902 \begin_layout Itemize
15909 both the HTML tag and the description will appear in the document
15912 \begin_layout Itemize
15920 only the description appears in the printed version
15923 \begin_layout Subsection
15924 Using the LinuxDoc Sgml scripts
15925 \begin_inset Note Note
15928 \begin_layout Standard
15929 This section is completely outdated.
15937 \begin_layout Standard
15938 \begin_inset LatexCommand label
15939 name "sec:sgmloperate"
15943 You can use LinuxDoc as a text class without any additional scripts or programs,
15944 but there is not much point in doing this.
15945 All you will get is a document that looks like a
15947 Linux Documentation Project Howto
15953 To do the document translation you need to get and install the
15955 sgml-tools-1.0.x.tar.gz
15958 \begin_inset Formula $x\geq3$
15963 the SGML-Tools WWW Page
15968 \begin_layout LyX-Code
15971 \begin_inset LatexCommand url
15972 target "http://pobox.com/~cg/sgmltools"
15981 \begin_layout Standard
15982 Alternatively, you can go to the
15990 \begin_layout Standard
15991 Note that, at the time of this writing (01/1998), version 1.0.3 of sgml-tools
15992 has not yet been made available at
16004 \begin_layout LyX-Code
16007 \begin_inset LatexCommand url
16008 target "ftp://sunsite.unc.edu/pub/Linux/utils/text/sgml-tools-1.0.x.tar.gz"
16015 \begin_layout Standard
16022 sgml-tools-1.0.x.tar.gz
16024 contains everything that you need to write SGML documents and convert them
16025 to groff, LaTeX, HTML, GNU info, LyX, and RTF\SpecialChar \@.
16029 \begin_layout Standard
16030 This package was renamed from
16032 linuxdoc-sgml-1.5.tar.gz
16037 \begin_layout Standard
16038 Follow the instructions in that package on how to install it and how to
16040 All this has to be done outside of LyX, before you can use the
16045 ile\SpecialChar \menuseparator
16050 xport\SpecialChar \menuseparator
16059 \begin_layout Subsection
16060 Troubleshooting LinuxDoc
16063 \begin_layout Standard
16064 When you print or preview a LinuxDoc document some checking is done of the
16065 tags before LaTeX is run.
16066 Some errors are trapped here, especially those concerning the structure
16068 LyX may produce an error message, but not leave an error box in the document
16070 You may have to look at the files directly to discover what is wrong.
16071 Most problems seem to come from the use of options that are not fully available
16075 \begin_layout Section
16079 \begin_layout Standard
16085 \begin_layout Subsection
16089 \begin_layout Standard
16097 menu, you'll find a
16106 This feature requires you to have the
16110 program installed, and is grayed out if you don't have it.
16111 You can get it from your nearest CTAN mirror, or over the Web from
16112 \begin_inset LatexCommand url
16113 target "http://www.ifi.uio.no/~jensthi/chktex/"
16120 \begin_layout Standard
16125 package is a program that was written by
16130 in frustration because some constructs in LaTeX are sometimes non-intuitive,
16131 and easy to forget.
16132 The program runs over your LaTeX file and checks the integrity of the file,
16133 and flags some common errors.
16134 In other technical words, it is
16141 \begin_layout Standard
16142 Well, what is a syntax checker doing in LyX which is supposed to produce
16143 correct LaTeX anyways? The answer is simple: Just as
16147 not only checks the
16151 of C programs, but also does
16155 checks for type-errors,
16159 catches some common
16163 errors, in addition to the syntactical ones.
16168 is capable of detecting several common errors, such as
16171 \begin_layout Itemize
16172 Ellipsis detection:
16174 Use \SpecialChar \ldots{}
16178 \begin_layout Itemize
16179 No space in front of/after parenthesis:
16184 \begin_layout Itemize
16185 Enforcement of normal space after common abbreviations:
16189 is too wide spacing.
16192 \begin_layout Itemize
16193 Enforcement of end-of-sentence space when the last sentence ends with a
16197 And this is wrong spacing.
16200 \begin_layout Itemize
16201 Space in front of labels and similar commands:
16203 The label should stick right
16204 up to the text to avoid falling to a wrong page.
16206 \begin_inset LatexCommand label
16215 \begin_layout Standard
16216 This footnote is in danger of falling off to a wrong page
16221 The label is separated too much.
16224 \begin_layout Itemize
16225 Space in front of references, instead of hard spaces:
16227 In you are in bad luck,
16228 the text will break right between the referenced text and reference number,
16231 \begin_inset LatexCommand ref
16232 reference "sec:chktex"
16239 \begin_layout Itemize
16241 \begin_inset Quotes eld
16245 \begin_inset Quotes erd
16249 \begin_inset Formula $\times$
16254 2x2 looks cheap compared to
16255 \begin_inset Formula $2\times2$
16261 \begin_layout Standard
16262 and more \SpecialChar \ldots{}
16263 It is an invaluable tool when you are
16264 \begin_inset Quotes eld
16268 \begin_inset Quotes erd
16271 your document before printing, and you should run it right after the obligatory
16272 spelling check, and before you go fine tuning the typesetting.
16275 \begin_layout Subsection
16279 \begin_layout Standard
16280 If you have the program installed, usage is as simple as choosing
16285 ools\SpecialChar \menuseparator
16294 This will make LyX generate a LaTeX file of your document, start
16298 to check it, and then make LyX insert
16299 \begin_inset Quotes eld
16303 \begin_inset Quotes erd
16306 with the warnings from
16310 , if there were any.
16311 The warnings will be placed close to the point of the mistake, and you
16312 can quickly find them by using the
16317 avigate\SpecialChar \menuseparator
16324 menu item, or the shortcut key
16333 Open the error boxes by clicking on them with the mouse, or use the shortcut
16342 bindings, or the corresponding
16351 Read the warning and correct the mistake, if it is a mistake.
16352 If you have trouble understanding what the warning is about, you can safely
16354 Remember that there is a hidden layer between the document on screen and
16355 the technical details in invoking
16359 , and this gap can make some warnings seem arcane or just right down plain
16363 \begin_layout Standard
16364 This document is an excellent testing bed for the feature, and it should
16365 provide quite a few warnings for you to fiddle with.
16366 Since computers are only so smart, expect most of the warnings to be false
16370 \begin_layout Subsection
16371 How to fine tune it
16374 \begin_layout Standard
16375 Sometimes, you'll find that
16379 makes more noise than suits your mood.
16380 Then you can choose not to use it, wait until your mood changes, or try
16385 to get better along with you.
16386 Another choice in the most desperate situations is to use
16391 iew\SpecialChar \menuseparator
16401 , which will get rid of all warnings instantly.
16404 \begin_layout Standard
16413 very configurable and extensible, you shouldn't expect to solve all problems
16419 Since LyX has to generate a somewhat special LaTeX file to be able to match
16420 the line numbers from the
16428 \begin_layout Standard
16429 You can inspect the specific output from
16435 Edit\SpecialChar \menuseparator
16449 to the internal document structure, some of the warnings will not seen
16450 to appear correctly.
16451 There are two things you can do about this:
16454 \begin_layout Itemize
16459 invocation command line in
16475 installation configuration file (usually with the file
16477 /usr/local/share/chktexrc
16480 See below to learn what warnings can be enabled and disabled on the command
16485 \begin_layout Itemize
16486 Export your document as a raw LaTeX file using
16491 ile\SpecialChar \menuseparator
16496 xport\SpecialChar \menuseparator
16508 Invoked in this way, it can be a hassle to find the corresponding place
16509 in the document inside LyX, but with a little patience, you should be able
16513 \begin_layout Standard
16514 Here follows the warning messages that can be enabled and disabled in
16523 to disable a warning, and
16527 to enable a warning.
16528 The emphasized entries are disabled by default, because the default is
16531 chktex -n1 -n3 -n6 -n9 -n22 -n25 -n30 -n38
16536 \begin_layout Standard
16537 Notice that you should only use the options that enable and disable warnings,
16538 because LyX relies on some of the other command line parameters to be set
16539 in a specific way to have a chance to communicate with
16546 \begin_layout Enumerate
16550 Command terminated with space.
16553 \begin_layout Enumerate
16556 Non-breaking space (
16557 \begin_inset Quotes eld
16565 \begin_inset Quotes erd
16568 ) should have been used.
16571 \begin_layout Enumerate
16575 You should enclose the previous parenthesis with
16576 \begin_inset Quotes eld
16584 \begin_inset Quotes erd
16590 \begin_layout Enumerate
16593 Italic correction (
16594 \begin_inset Quotes eld
16604 \begin_inset Quotes erd
16607 ) found in non-italic buffer.
16610 \begin_layout Enumerate
16613 Italic correction (
16614 \begin_inset Quotes eld
16624 \begin_inset Quotes erd
16627 ) found more than once.
16630 \begin_layout Enumerate
16634 No italic correction (
16635 \begin_inset Quotes eld
16645 \begin_inset Quotes erd
16651 \begin_layout Enumerate
16655 \begin_inset Quotes eld
16663 \begin_inset Quotes erd
16667 \begin_inset Quotes eld
16675 \begin_inset Quotes erd
16681 \begin_layout Enumerate
16684 Wrong length of dash may have been used.
16687 \begin_layout Enumerate
16691 \begin_inset Quotes eld
16699 \begin_inset Quotes erd
16703 \begin_inset Quotes eld
16711 \begin_inset Quotes erd
16717 \begin_layout Enumerate
16721 \begin_inset Quotes eld
16729 \begin_inset Quotes erd
16735 \begin_layout Enumerate
16739 \begin_inset Quotes eld
16747 \begin_inset Quotes erd
16750 to achieve an ellipsis.
16753 \begin_layout Enumerate
16756 Inter-word spacing (
16757 \begin_inset Quotes eld
16767 \begin_inset Quotes eld
16770 ) should perhaps be used.
16773 \begin_layout Enumerate
16776 Inter-sentence spacing (
16777 \begin_inset Quotes eld
16787 \begin_inset Quotes erd
16790 ) should perhaps be used.
16793 \begin_layout Enumerate
16796 Could not find argument for command.
16799 \begin_layout Enumerate
16803 \begin_inset Quotes eld
16811 \begin_inset Quotes erd
16817 \begin_layout Enumerate
16820 Math mode still on at end of LaTeX file.
16823 \begin_layout Enumerate
16827 \begin_inset Quotes eld
16835 \begin_inset Quotes erd
16838 doesn't match the number of
16839 \begin_inset Quotes eld
16847 \begin_inset Quotes erd
16853 \begin_layout Enumerate
16856 You should use either
16859 \begin_inset Quotes eld
16867 \begin_inset Quotes erd
16872 as an alternative to
16873 \begin_inset Quotes eld
16881 \begin_inset Quotes erd
16887 \begin_layout Enumerate
16894 " (ASCII 39) instead of "
16901 \begin_layout Enumerate
16904 User-specified pattern found.
16907 \begin_layout Enumerate
16910 This command might not be intended.
16913 \begin_layout Enumerate
16920 \begin_layout Enumerate
16938 \begin_layout Enumerate
16941 Delete this space to maintain correct page references.
16944 \begin_layout Enumerate
16948 You might wish to put this between a pair of
16949 \begin_inset Quotes eld
16957 \begin_inset Quotes erd
16963 \begin_layout Enumerate
16966 You ought to remove spaces in front of punctuation.
16969 \begin_layout Enumerate
16972 Could not execute LaTeX command.
16975 \begin_layout Enumerate
16984 in front of small punctuation.
16987 \begin_layout Enumerate
16995 may look prettier here.
16998 \begin_layout Enumerate
17002 Multiple spaces detected in output.
17005 \begin_layout Enumerate
17008 This text may be ignored.
17011 \begin_layout Enumerate
17017 \begin_inset Quotes eld
17022 to begin quotation, not
17029 \begin_layout Enumerate
17036 to end quotation, not
17039 \begin_inset Quotes eld
17047 \begin_layout Enumerate
17053 \begin_layout Enumerate
17056 You should perhaps use
17057 \begin_inset Quotes eld
17065 \begin_inset Quotes erd
17071 \begin_layout Enumerate
17074 You should put a space in front of/after parenthesis.
17077 \begin_layout Enumerate
17080 You should avoid spaces in front of/after parenthesis.
17083 \begin_layout Enumerate
17087 You should not use punctuation in front of/after quotes.
17090 \begin_layout Enumerate
17093 Double space found.
17096 \begin_layout Enumerate
17099 You should put punctuation outside inner/inside display math mode.
17102 \begin_layout Enumerate
17105 You ought to not use primitive TeX in LaTeX code.
17108 \begin_layout Enumerate
17111 You should remove spaces in front of
17112 \begin_inset Quotes eld
17120 \begin_inset Quotes erd
17126 \begin_layout Enumerate
17129 \begin_inset Quotes eld
17137 \begin_inset Quotes erd
17140 is normally not followed by
17141 \begin_inset Quotes eld
17149 \begin_inset Quotes erd
17155 \begin_layout Standard
17156 In later versions of LyX, we hope to provide a more complete interface to
17157 this tool (and it's smaller cousin
17161 ) to exploit the full power of it.
17162 But it's not exactly useless as it is now: go try it on one of your existing
17163 documents of a certain length and be surprised.
17166 \begin_layout Section
17167 Version Control in LyX
17170 \begin_layout Standard
17173 Lars Gullik Bjønnes
17176 \begin_layout Subsection
17180 \begin_layout Standard
17181 A friend of mine wanted to try LyX for a group project.
17182 When he didn't find support for version control or file locking, he dropped
17184 This angered me a bit, so I thought that I should at least make support
17185 for RCS (with the possibility of CVS and/or SCCS as a future improvement.)
17186 This has now been done.
17187 LyX now supports some of the most basic RCS commands.
17188 If you need to something a bit more sophisticated you will have to do that
17189 manually in an xterm.
17192 \begin_layout Standard
17193 Before you begin to use the version control features in LyX, you should
17195 \begin_inset Quotes eld
17199 \begin_inset Quotes erd
17202 (a man file, read it with
17207 This file describes all the basic features of RCS.
17208 You should especially notice the comment about a RCS directory, and the
17209 notion of a master RCS file (the file ending in
17216 \begin_layout Standard
17217 The implementation in LyX assumes a recent version of the GNU RCS package---no
17218 guarantees are made for older versions.
17221 \begin_layout Subsection
17222 RCS commands in LyX
17225 \begin_layout Standard
17226 The following sections describe the RCS commands supported by LyX.
17227 You can find them in the
17232 ile\SpecialChar \menuseparator
17237 ersion\InsetSpace ~
17243 \begin_layout Subsubsection
17249 \begin_layout Standard
17250 If your document is not under revision control, this is the only item shown
17252 And if it is under revision control, the
17259 item is grayed out.
17263 \begin_layout Standard
17264 This command registers your document with RCS\SpecialChar \@.
17265 You are asked interactively
17266 to supply an initial description of the document.
17267 The document is now set in Read-Only mode and you have to
17274 , before making any changes to it.
17275 A document under revision control has a
17276 \begin_inset Quotes eld
17279 [RCS:<version> <locker>]
17280 \begin_inset Quotes erd
17283 item tagged to the filename in the minibuffer.
17286 \begin_layout Standard
17287 RCS command that is run:
17289 ci -q -u -i -t-"<initial description>" <file-name>
17292 \begin_layout Standard
17297 to understand the switches.
17301 \begin_layout Subsubsection
17307 \begin_layout Standard
17308 When you are finished editing a file, you check in your changes.
17309 When you do this, you are asked for a description of the changes.
17310 This is stored in the history log.
17311 The version number is bumped, your changes are applied to the master RCS
17312 file, the document is unlocked and set to Read-Only mode.
17316 \begin_layout Standard
17319 ci -q -u -m"<description>" <file-name>
17322 \begin_layout Subsubsection
17328 \begin_layout Standard
17329 By doing this you lock the document so that only you can edit it.
17330 This will also make the document Read-Write only for you.
17331 You will usually continue editing for a while and when you are finished
17332 you check in your changes.
17333 The status line is changed to reflect that you have locked the file.
17337 \begin_layout Standard
17340 co -q -l <file-name>
17343 \begin_layout Subsubsection
17346 Revert To Last Version
17349 \begin_layout Standard
17350 This will discard all changes made to the document since the last check
17352 You get a warning before changes are discarded.
17355 \begin_layout Standard
17358 co -f -u<version> <file-name>
17361 \begin_layout Subsubsection
17367 \begin_layout Standard
17368 This makes as if the last check in never happened.
17369 No changes are made to the document loaded into LyX, but the last version
17370 is removed from the master RCS file.
17374 \begin_layout Standard
17377 rcs -o<version> <file-name>
17380 \begin_layout Subsubsection
17386 \begin_layout Standard
17387 This show the complete history of the RCS document.
17392 is shown in a browser.
17400 \begin_layout Section
17401 Literate Programming
17404 \begin_layout Standard
17409 (kayvan@sylvan.com)
17413 original documentation written by
17415 Edmar Wienskoski Jr.
17418 (edmar-w-jr@technologist.com)
17421 \begin_layout Subsection
17425 \begin_layout Standard
17426 The main purpose of this documentation is to show you how to use LyX for
17427 literate programming.
17428 Where it is assumed that you are familiar with this programming technique,
17430 \begin_inset Quotes eld
17434 \begin_inset Quotes erd
17438 \begin_inset Quotes eld
17442 \begin_inset Quotes erd
17446 If that is not the case, please follow the web links provided in the following
17448 There is a lot of good documentation out there covering old development
17449 history to the latest tools tips.
17452 \begin_layout Standard
17453 It is also assumed that you are familiar with LyX itself to a point that
17454 you are comfortable changing your LyX preferences, and X resources file.
17455 If that is not the case please refer to other LyX documentation to cover
17456 your specific needs.
17459 \begin_layout Subsection
17460 Literate Programming
17463 \begin_layout Standard
17464 From the Literate Programming FAQ:
17467 \begin_layout Quotation
17468 Literate programming is the combination of documentation and source together
17469 in a fashion suited for reading by human beings.
17470 In fact, literate programs should be enjoyable reading, even inviting!
17471 (Sorry Bob, I couldn't resist!) In general, literate programs combine source
17472 and documentation in a single file.
17473 Literate programming tools then parse the file to produce either readable
17474 documentation or compilable source.
17475 The WEB style of literate programming was created by D.E.
17476 Knuth during the development of his TeX typesetting software.
17480 \begin_layout Standard
17481 Another excerpt says:
17484 \begin_layout Quotation
17487 How is literate programming different from verbose commenting?
17490 \begin_layout Quotation
17491 There are three distinguishing characteristics.
17492 In order of importance, they are:
17496 \begin_layout Itemize
17497 flexible order of elaboration
17500 \begin_layout Itemize
17501 automatic support for browsing
17504 \begin_layout Itemize
17505 typeset documentation, especially diagrams and mathematics
17509 \begin_layout Standard
17510 Now that I sparked your curiosity, take a look in the references.
17513 \begin_layout Subsubsection
17517 \begin_layout Standard
17518 The complete Literate Programming FAQ can be found at:
17521 \begin_layout Quote
17522 \begin_inset LatexCommand url
17523 name "Literate Programming FAQ"
17524 target "http://shelob.ce.ttu.edu/daves/lpfaq/faq.html"
17531 \begin_layout Standard
17532 The FAQ lists 23 (twenty three!) different literate programming tools.
17533 Where some are specialized or
17534 \begin_inset Quotes eld
17538 \begin_inset Quotes erd
17541 for particular programming languages, while other have general scope.
17546 for my own use for several reasons:
17549 \begin_layout Itemize
17550 It can generate the documentation either in LaTeX or HTML.
17553 \begin_layout Itemize
17554 It has a open architecture, i.e., it is easy to plug in new filters and to
17555 perform special processing that you may need.
17559 \begin_layout Itemize
17560 There is a good selection of filters available already (the HTML is one
17564 \begin_layout Itemize
17568 \begin_layout Standard
17569 The Noweb web page can be found at:
17572 \begin_layout Quote
17573 \begin_inset LatexCommand url
17574 name "Noweb home page"
17575 target "http://www.cs.virginia.edu/~nr/noweb/"
17582 \begin_layout Standard
17583 Starting from there you can reach many other interesting links and even
17584 some literate program examples.
17587 \begin_layout Subsection
17588 \begin_inset LatexCommand label
17589 name "sub:LyX-and-Literate"
17593 LyX and Literate Programming
17596 \begin_layout Standard
17597 The LyX support for Literate Programming is provided by using the generic
17598 LyX convertors mechanism.
17599 This support is provided in a
17600 \begin_inset Quotes eld
17604 \begin_inset Quotes erd
17607 way, i.e., you will be able to use this new LyX feature with some other literate
17608 programming tool of your choice by just changing your LyX preferences.
17611 \begin_layout Subsubsection
17612 Generating documents and code (weaving and tangling)
17615 \begin_layout Paragraph
17616 Selecting the document class
17619 \begin_layout Standard
17620 If you have installed Noweb and LyX successfully, whenever you open a new
17621 document or try to change the document class of an existing one, you will
17622 find that there are three new document classes available:
17625 \begin_layout Itemize
17629 \begin_layout Itemize
17633 \begin_layout Itemize
17637 \begin_layout Standard
17638 You must select one of them to create your literate documents from.
17642 \begin_layout Standard
17643 Note that literate documents are not limited to these three classes.
17644 New classes can be generated from other styles like letter or in combination
17645 with other class variations like Article (AMS).
17646 If you have special needs that cannot be covered by one of the existing
17647 classes, let the LyX developers list (lyx-devel@lists.lyx.org) know and we
17648 will arrange to insert a new entry, or teach you how to do it.
17652 \begin_layout Standard
17653 It is very simple, it involves the creation of a file with four lines, and
17654 re-running of the auto configuration.
17659 Moreover, if you use a literate tool other than Noweb you may need to create
17660 a new set of document classes for it.
17663 \begin_layout Paragraph
17667 \begin_layout Standard
17668 LyX enables you to write code with a layout named
17676 \begin_layout Standard
17677 The equivalent Noweb term is
17678 \begin_inset Quotes eld
17682 \begin_inset Quotes erd
17686 For historical reasons, I got used to the term
17687 \begin_inset Quotes eld
17691 \begin_inset Quotes erd
17694 introduced by other literate tool named Nuweb, which I used for many years
17695 before rendering myself to Noweb.
17700 Noweb delimits scraps like this:
17703 \begin_layout LyX-Code
17707 \begin_layout LyX-Code
17711 \begin_layout LyX-Code
17715 \begin_layout LyX-Code
17719 \begin_layout LyX-Code
17723 \begin_layout Standard
17724 The problem is that whatever is written in between the << and the
17728 must be taken literally, i.e., LyX should be prevented from making any special
17729 interpretation of what has been written.
17730 This is handled by a special layout named Scrap, that works like a normal
17731 paragraph but has a free spacing capability.
17734 \begin_layout Standard
17735 The down side of the Scrap paragraph layout is that consecutive paragraphs
17736 of code will be spaced with one empty line in the source code and also
17737 in the printed documentation.
17738 The work around is to enter each line of code within a single Scrap, with
17739 a newline (ctrl-return).
17740 The example above will look like this:
17744 \begin_layout Standard
17745 If you have a printed version of this document you will not see any difference
17746 between the previous example and this one.
17754 \begin_layout LyX-Code
17766 \begin_layout Standard
17767 This layout works fine.
17768 The only real inconvenience is that you have to type ctrl-return instead
17773 \begin_layout Standard
17774 It is in my list of
17775 \begin_inset Quotes eld
17779 \begin_inset Quotes erd
17790 \begin_layout Standard
17791 As a special note, you can also use the
17792 \begin_inset Quotes eld
17796 \begin_inset Quotes erd
17799 construct of Noweb in your scraps to add items to Noweb's identifier cross-refe
17803 \begin_layout LyX-Code
17806 def some_function(args):
17808 "This is the doc string for this
17811 print "My args: ", args
17814 \begin_layout LyX-Code
17815 @ %def some_function
17818 \begin_layout Standard
17819 For an example of this usage and the resulting cross-reference output, look
17820 at the Literate python program in
17822 LIBDIR/examples/listerrors.lyx
17824 which should make this all clear.
17827 \begin_layout Paragraph
17828 Generating the documentation
17831 \begin_layout Standard
17832 At this point you already have a new document file with a proper document
17833 class, and with some code and text on it.
17834 How do I print it? The answer is simple, you select
17839 iew\SpecialChar \menuseparator
17847 Just like you would do for a plain document.
17848 No special procedure is required.
17851 \begin_layout Standard
17852 To help orientate you, I will now explain what happens inside LyX:
17855 \begin_layout Enumerate
17861 pdate\SpecialChar \menuseparator
17868 menu option is chosen, a LaTeX file is generated.
17873 \begin_layout Standard
17874 If the document is of any literate class the generated file will be named
17875 with an extension name defined by the
17876 \begin_inset Quotes eld
17880 \begin_inset Quotes erd
17883 format (defined in the Preferences panel), otherwise the file will have
17892 \begin_layout Enumerate
17893 Note that the only difference so far is in the name of the file, no special
17894 processing is required by LyX.
17895 Given that you formatted the code using the Scrap layout that, by itself,
17896 takes care of the business.
17899 \begin_layout Enumerate
17900 If the document is of any literate class LyX will then use the internal
17901 LyX to Noweb converter, followed by the Noweb to LaTeX converter
17905 \begin_layout Standard
17906 The converters are defined in the
17911 ools\SpecialChar \menuseparator
17919 \begin_inset Quotes eld
17923 \begin_inset Quotes erd
17928 \begin_inset LatexCommand ref
17929 reference "sub:converters"
17937 manual for general information about converters.
17942 to generate the LaTeX file.
17946 \begin_layout Standard
17947 Otherwise it will just skip this step.
17951 \begin_layout Enumerate
17952 Finally, LaTeX is invoked and the regular post processing continues as in
17956 \begin_layout Standard
17957 Independence from a particular
17958 \begin_inset Quotes eld
17962 \begin_inset Quotes erd
17965 is easily achieved by changing the commands that are run by the various
17969 \begin_layout Paragraph
17970 Generating the code
17973 \begin_layout Standard
17974 When the build menu option is chosen or the corresponding button in the
17975 toolbar is pressed, a LaTeX file is generated just like step 1 above.
17976 Next, LyX invokes the
17981 This converter needs to be defined by the user and is not installed by
17982 default, though the Program format is.
17983 This converter (like any other converter) will have two parts:
17986 \begin_layout Enumerate
17987 The converter program itself.
17988 This program performs the conversion from the one format to the other (in
17989 this case, from the Noweb format to the Program pseudo-format).
17992 \begin_layout Enumerate
17993 The error log parser.
17994 This is a program whose sole purpose is to rewrite error messages in a
17995 format that LyX understands.
17996 This makes it possible for LyX to place error boxes in the right places
17997 in the file buffer.
18000 \begin_layout Standard
18001 The first part, the
18002 \begin_inset Quotes eld
18006 \begin_inset Quotes erd
18009 setting, should be set to
18010 \begin_inset Quotes eld
18018 \begin_inset Quotes erd
18022 This basically means that LyX will call
18023 \begin_inset Quotes eld
18027 \begin_inset Quotes erd
18030 (a program or script) with the name of the Noweb file (normally a file
18031 in the LyX temp directory).
18035 \begin_layout Standard
18036 This is an implementation of
18037 \begin_inset Quotes eld
18041 \begin_inset Quotes erd
18044 that you can place in a directory on your path:
18047 \begin_layout LyX-Code
18051 \begin_layout LyX-Code
18055 \begin_layout LyX-Code
18056 notangle -Rbuild-script $1 | env NOWEB_SOURCE=$1 sh
18059 \begin_layout Standard
18060 The next part of the converter setting is the
18061 \begin_inset Quotes eld
18065 \begin_inset Quotes erd
18068 which is to be set to
18069 \begin_inset Quotes eld
18074 parselog=listerrors
18077 \begin_inset Quotes erd
18081 This will run any errors that are generated by the
18082 \begin_inset Quotes eld
18086 \begin_inset Quotes erd
18089 process through the
18090 \begin_inset Quotes eld
18094 \begin_inset Quotes erd
18100 \begin_layout Standard
18101 The converter code looks in
18109 then on the path for the
18110 \begin_inset Quotes eld
18114 \begin_inset Quotes erd
18120 \begin_layout Standard
18121 The build will normally take place in LyX's temporary directory, so the
18122 files produced by the conversion will be in that directory.
18123 LyX will copy out what it regards as the `main' file, but the
18127 conversion may produce several files, and so most of these would then be
18128 deleted when LyX was closed.
18129 The present solution is to use a `copier',
18133 \begin_layout Standard
18135 \begin_inset LatexCommand ref
18136 reference "sec:converters-etc"
18144 manual for information on these.
18153 script in its default mode, so that the entire contents of the temporary
18154 directory is copied.
18155 More will get copied than is needed, to be sure, but nothing will be lost.
18156 If, however, you know what extensions the generated files will have, this
18157 can be improved by using the
18166 This option takes a comma-separated list of extensions to copy.
18167 So, for example, if the conversion will generate only files with the extensions
18176 , then the correct definition would be:
18179 \begin_layout LyX-Code
18180 python -tt $$s/scripts/ext_copy.py -e c,h $$i $$o
18183 \begin_layout Standard
18184 The result will be that only files with these two extensions will be copied
18188 \begin_layout Paragraph
18189 Build instructions in the document
18192 \begin_layout Standard
18193 The last piece of the integration between LyX and noweb is the
18194 \begin_inset Quotes eld
18198 \begin_inset Quotes erd
18202 Generally, the instructions for building your program should be embedded
18203 in a scrap of its own.
18205 \begin_inset Quotes eld
18209 \begin_inset Quotes erd
18212 above uses the notangle command to look for this scrap (called
18213 \begin_inset Quotes eld
18217 \begin_inset Quotes erd
18220 ) and runs its contents through
18221 \begin_inset Quotes eld
18225 \begin_inset Quotes erd
18231 \begin_layout Standard
18232 Typically, such a scrap would look something like this:
18235 \begin_layout LyX-Code
18242 if [ -z "${NOWEB_SOURCE}" ]
18246 NOWEB_SOURCE=myfile.nw
18252 code to extract files ...]
18255 code to compile files ...]
18260 \begin_layout Standard
18263 LIBDIR/examples/listerrors.lyx
18267 LIBDIR/examples/Literate.lyx
18269 which implement two versions of the
18270 \begin_inset Quotes eld
18274 \begin_inset Quotes erd
18277 program for some illustrations of how all of these pieces go together or
18280 LIBDIR/examples/noweb2lyx.lyx.
18283 Interestingly, these three files show off the language-indepence of the
18284 LyX literate programming support since they are written in Python, C and
18288 \begin_layout Subsubsection
18292 \begin_layout Standard
18293 All the Literate Programming support is configured by the
18298 ools\SpecialChar \menuseparator
18306 \begin_inset Quotes eld
18310 \begin_inset Quotes erd
18314 The important parts are:
18317 \begin_layout Description
18320 \begin_inset Quotes eld
18324 \begin_inset Quotes erd
18328 format Set up via the Formats tab, this is where the Noweb-specific pieces
18338 , the file extension is set to
18343 This tells LyX to create a file with a
18347 extension in the first step of the conversion process.
18350 \begin_layout Description
18357 format This is an empty format whose sole purpose is to be the endpoint
18358 of a conversion (which then allows us to set up a converter for it).
18361 \begin_layout Description
18370 This converter performs the
18371 \begin_inset Quotes eld
18375 \begin_inset Quotes erd
18378 of the literate document.
18379 For Noweb, it is set to
18380 \begin_inset Quotes eld
18385 noweave -delay -index $$i > $$o
18388 \begin_inset Quotes erd
18394 \begin_layout Description
18404 \begin_inset Quotes eld
18408 \begin_inset Quotes erd
18412 As stated above, the Converter is set to
18413 \begin_inset Quotes eld
18421 \begin_inset Quotes erd
18424 , with Flags set to
18425 \begin_inset Quotes eld
18430 originaldir,parselog=listerrors
18433 \begin_inset Quotes erd
18439 \begin_layout Subsubsection
18443 \begin_layout Standard
18444 There is also a new function implemented in the LyX server, the
18445 \begin_inset Quotes eld
18448 server-goto-file-row" function, to be used with ddd/gdb or other debugger.
18452 \begin_layout Standard
18453 When debugging code with ddd/gdb, it is possible to invoke a text editor
18454 at the current execution position with a single key stroke.
18455 The default ddd configuration for that is shift-ctrl-V.
18456 It happens that you can define the editor command line invocation in ddd
18462 dit\SpecialChar \menuseparator
18467 references\SpecialChar \menuseparator
18474 dialog and changing the "Edit Sources" entry.
18477 \begin_layout Standard
18478 I take advantage of the new created LyX server function and this ddd feature,
18480 \begin_inset Quotes eld
18484 \begin_inset Quotes erd
18490 \begin_layout LyX-Code
18491 echo "LYXCMD:monitor:server-goto-file-row:@FILE@ @LINE@" >~/.lyxpipe.in
18494 \begin_layout Standard
18495 With this, whenever you are using ddd and find a point in the program that
18496 you want to edit, you just press shift-ctrl-V (in the ddd window), and
18497 ddd you forward this information to LyX through the LyX server and then
18498 the LyX window will show the same file with the cursor at the same position
18499 ddd was pointing to.
18500 No more guessing or long scrolling to locate a point in the program back
18504 \begin_layout Standard
18505 Note however that you must enable the LyX server to get this feature working
18506 (it is disabled by default).
18507 You can enable it in
18519 ) by entering in the
18524 \begin_inset Quotes eld
18529 /home/<your-home-directory>/.lyx/lyxpipe
18532 \begin_inset Quotes erd
18538 \begin_layout Standard
18539 Read the LyX server documentation in the
18541 Customization Manual
18543 for further information.
18546 \begin_layout Subsubsection
18550 \begin_layout Standard
18551 There are six new buttons that can be added to your LyX toolbar.
18552 Five of these buttons are short cuts to layout styles:
18573 The last one is a short cut to the
18574 \begin_inset Quotes eld
18578 \begin_inset Quotes erd
18585 \begin_layout Standard
18586 LyX has a range of buttons that are available for tool bar customization.
18587 In my toolbar I like to combine the six short cuts above with two more:
18595 \SpecialChar \menuseparator
18603 \SpecialChar \menuseparator
18616 iew\SpecialChar \menuseparator
18624 Here is how it looks like:
18627 \begin_layout LyX-Code
18631 \begin_layout LyX-Code
18635 \begin_layout LyX-Code
18636 Icon "layout Standard"
18639 \begin_layout LyX-Code
18640 Icon "layout Section"
18643 \begin_layout LyX-Code
18644 Icon "layout LaTeX"
18647 \begin_layout LyX-Code
18648 Icon "layout LyX-Code"
18651 \begin_layout LyX-Code
18652 Icon "layout Scrap"
18655 \begin_layout LyX-Code
18659 \begin_layout LyX-Code
18663 \begin_layout LyX-Code
18664 Icon "buffer-typeset"
18667 \begin_layout LyX-Code
18668 Icon "build-program"
18671 \begin_layout LyX-Code
18675 \begin_layout LyX-Code
18679 \begin_layout LyX-Code
18683 \begin_layout LyX-Code
18687 \begin_layout LyX-Code
18691 \begin_layout Subsubsection
18692 Colors customization
18695 \begin_layout Standard
18696 There are a number of colors in LyX that can be customized in
18701 One of the things that bothers people is the LaTeX font color.
18702 The default color is red, since the scraps uses LaTeX font, and there is
18703 a lot of scraps in literate documents, you may get tired of seeing everything
18705 You can change it by going to the tabs
18714 \begin_layout Standard
18715 The next thing is the visible presence of the newline character in the screen.
18716 You can choose the color of this particular character and make it blend
18718 I recommend you choosing a color that is close to the background but not
18719 equal, that way you still can see it is there, but it is not bothering
18724 \begin_layout Chapter
18725 Secrets of the LaTeX Masters
18726 \begin_inset LatexCommand label
18734 \begin_layout Standard
18735 Though LyX is a powerful tool, it cannot hope to support everything that
18736 can be done with pure TeX/LaTeX.
18737 However, many familiar dirty TeX and LaTeX tricks can be done within LyX,
18738 as long as you are not afraid to use that
18739 \begin_inset Quotes eld
18743 \begin_inset Quotes erd
18746 button on the toolbar or add things to the LaTeX preamble.
18747 This section lists some tips, tricks, and otherwise cool ideas to give
18748 your document that extra little flair.
18751 Do try this at home
18753 , just start with something a little smaller and less important than your
18757 \begin_layout Standard
18758 Most ideas in this section require less common files in your LaTeX installation.
18759 If you have a system like teTeX, most will already be available.
18760 A few, however, will need to be downloaded from one of the CTAN archives.
18761 Often, there are several ways to do something, or several LaTeX style files
18762 which do the same thing.
18763 We do not endorse one choice over another, we simply claim that we have
18764 done a particular task with a particular file.
18765 Put on your wizard hat, keep an eye out for dragons, and let us begin.
18768 \begin_layout Section
18772 \begin_layout Standard
18775 Lars Gullik Bjønnes
18778 \begin_layout Subsection
18782 \begin_layout Standard
18783 The aim for this chapter
18787 \begin_layout Standard
18788 Editor's note: Lars' original chapter was a masterful description of how
18794 However, it was too long to flow smoothly in this document.
18795 I have therefore chosen to excerpt the most important sections here (sorry,
18796 Lars); you can read the original chapter (and more of the story!) in the
18799 examples/multicol.lyx
18807 is to show how the LaTeX package
18811 can be used in a LyX document.
18812 As LyX doesn't support the
18816 package natively yet, we have to use some small hacks.
18817 By reading this section it should be obvious how to do this.
18820 \begin_layout Subsection
18824 \begin_layout Standard
18829 package allows switching between one and multicolumn format on the same
18831 Footnotes are handled correctly (for the most part), but will be placed
18832 at the bottom of the page and not under each column.
18833 LaTeX's float mechanism, however, is partly disabled in the current implementat
18835 At the moment only page-wide floats can be used within the scope of the
18839 \begin_layout Subsection
18843 \begin_layout Subsubsection
18847 \begin_layout Standard
18848 If you want to have two columns in your text, you have use LaTeX mode to
18853 begin{multicols}{2}
18855 at the point where you want the two column layout to start, and then
18861 where you want it to end.
18865 \begin_layout Standard
18869 \begin_layout Standard
18873 begin{multicols}{2}
18881 \begin_layout Standard
18886 The Adventure of the Empty House
18892 Sir Arthur Conan Doyle
18895 \begin_layout Standard
18898 It was in the spring of the year 1894 that all London was interested, and
18899 the fashionable world dismayed, by the murder of the Honourable Ronald
18900 Adair under most unusual and inexplicable circumstances.
18901 The public has already learned those particulars of the crime which came
18902 out in the police investigation, but a good deal was suppressed upon that
18903 occasion, since the case for the prosecution was so overwhelmingly strong
18904 that it was not necessary to bring forward all the facts.
18905 Only now, at the end of nearly ten years, am I allowed to supply those
18906 missing links which make up the whole of that remarkable chain.
18907 The crime was of interest in itself, but that interest was as nothing to
18908 me compared to the inconceivable sequel, which afforded me the greatest
18909 shock and surprise of any event in my adventurous life.
18910 Even now, after this long interval, I find myself thrilling as I think
18911 of it, and feeling once more that sudden flood of joy, amazement, and increduli
18912 ty which utterly submerged my mind.
18913 Let me say to that public, which has shown some interest in those glimpses
18914 which I have occasionally given them of the thoughts and actions of a very
18915 remarkable man, that they are not to blame me if I have not shared my knowledge
18916 with them, for I should have considered it my first duty to do so, had
18917 I not been barred by a positive prohibition from his own lips, which was
18918 only withdrawn upon the third of last month.
18921 \begin_layout Standard
18925 \begin_layout Standard
18937 \begin_layout Subsubsection
18941 \begin_layout Standard
18942 The same pattern is used when you want more than two columns:
18945 \begin_layout Standard
18949 \begin_layout Standard
18953 begin{multicols}{3}
18961 \begin_layout Standard
18964 It can be imagined that my close intimacy with Sherlock Holmes had interested
18965 me deeply in crime, and that after his disappearance I never failed to
18966 read with care the various problems which came before the public.
18967 And I even attempted, more than once, for my own private satisfaction,
18968 to employ his methods in their solution, though with indifferent success.
18969 There was none, however, which appealed to me like this tragedy of Ronald
18971 As I read the evidence at the inquest, which led up to a verdict of willful
18972 murder against some person or persons unknown, I realized more clearly
18973 than I had ever done the loss which the community had sustained by the
18974 death of Sherlock Holmes.
18975 There were points about this strange business which would, I was sure,
18976 have specially appealed to him, and the efforts of the police would have
18977 been supplemented, or more probably anticipated, by the trained observation
18978 and the alert mind of the first criminal agent in Europe.
18979 All day, as I drove upon my round, I turned over the case in my mind and
18980 found no explanation which appeared to me to be adequate.
18981 At the risk of telling a twice-told tale, I will recapitulate the facts
18982 as they were known to the public at the conclusion of the inquest.
18985 \begin_layout Standard
18989 \begin_layout Standard
19001 \begin_layout Standard
19002 You can have more than 3 columns if you want to, but that might not be very
19003 pleasant for the eye.
19006 \begin_layout Subsubsection
19007 Columns inside columns
19010 \begin_layout Standard
19011 You can even have columns inside columns:
19014 \begin_layout Standard
19018 \begin_layout Standard
19022 begin{multicols}{2}
19030 \begin_layout Standard
19033 The Honourable Ronald Adair was the second son of the Earl of Maynooth,
19034 at that time governor of one of the Australian colonies.
19035 Adair's mother had returned from Australia to undergo the operation for
19036 cataract, and she, her son Ronald, and her daughter Hilda were living together
19040 \begin_layout Standard
19044 \begin_layout Standard
19048 begin{multicols}{2}
19056 \begin_layout Standard
19059 The youth moved in the best society--had, so far as was known, no enemies
19060 and no particular vices.
19061 He had been engaged to Miss Edith Woodley, of Carstairs, but the engagement
19062 had been broken off by mutual consent some months before, and there was
19063 no sign that it had left any very profound feeling behind it.
19064 For the rest {sic} the man's life moved in a narrow and conventional circle,
19065 for his habits were quiet and his nature unemotional.
19066 Yet it was upon this easy-going young aristocrat that death came, in most
19067 strange and unexpected form, between the hours of ten and eleven-twenty
19068 on the night of March 30, 1894.
19071 \begin_layout Standard
19075 \begin_layout Standard
19087 \begin_layout Standard
19090 Ronald Adair was fond of cards--playing continually, but never for such
19091 stakes as would hurt him.
19092 He was a member of the Baldwin, the Cavendish, and the Bagatelle card clubs.
19093 It was shown that, after dinner on the day of his death, he had played
19094 a rubber of whist at the latter club.
19095 He had also played there in the afternoon.
19100 The evidence of those who had played with him-- Mr.
19101 Murray, Sir John Hardy, and Colonel Moran--showed that the game was whist,
19102 and that there was a fairly equal fall of the cards.
19103 Adair might have lost five pounds, but not more.
19104 His fortune was a considerable one, and such a loss could not in any way
19106 He had played nearly every day at one club or other, but he was a cautious
19107 player, and usually rose a winner.
19108 It came out in evidence that, in partnership with Colonel Moran, he had
19109 actually won as much as four hundred and twenty pounds in a sitting, some
19110 weeks before, from Godfrey Milner and Lord Balmoral.
19111 So much for his recent history as it came out at the inquest.
19114 \begin_layout Standard
19118 \begin_layout Standard
19130 \begin_layout Standard
19131 Please do read the file
19133 examples/multicol.lyx
19135 for more advanced examples including column and header spacing, vertical
19136 separator lines, and more.
19139 \begin_layout Section
19144 Paragraph Environment
19145 \begin_inset OptArg
19148 \begin_layout Standard
19149 Numbering in Enumerate
19157 \begin_layout Standard
19163 \begin_layout Standard
19164 \begin_inset VSpace bigskip
19170 \begin_layout Standard
19172 The default numbering for the
19176 paragraph environment begins with Arabic numbers and ends with uppercase
19178 Suppose, however, you wanted a different type of numbering scheme.
19179 Here's a quickie example of how to change the numbering scheme:
19182 \begin_layout LyX-Code
19192 \begin_layout LyX-Code
19202 \begin_layout LyX-Code
19212 \begin_layout LyX-Code
19222 \begin_layout Standard
19223 \SpecialChar \ldots{}
19224 which changes the numbering scheme to uppercase Roman numerals, uppercase
19225 letters, Arabic numbers, and lowercase letter.
19228 \begin_layout Standard
19229 Additionally, the previous example also adds a little bit extra to the numbering
19231 For example, the first level label actually looks like:
19232 \begin_inset Quotes eld
19236 \begin_inset Quotes erd
19240 For ease of reading, we'll describe what the numbering schemes look like
19241 using a notation something like this: <
19242 \begin_inset Quotes eld
19246 \begin_inset Quotes erd
19251 \begin_inset Quotes erd
19255 \begin_inset Quotes erd
19260 \begin_inset Quotes erd
19264 \begin_inset Quotes erd
19269 \begin_inset Quotes eld
19273 \begin_inset Quotes erd
19280 \begin_layout Standard
19281 As you can see in the example, there is a label command for each nesting
19288 \SpecialChar \ldots{}
19295 , as well as a counter,
19299 \SpecialChar \ldots{}
19305 There are also five
19306 \begin_inset Quotes eld
19310 \begin_inset Quotes erd
19343 , each of which take one counter as an argument.
19344 You can add characters before or after these, but there's no need to add
19348 \begin_layout Standard
19349 You can get really fancy with these.
19353 \begin_layout LyX-Code
19367 \begin_layout LyX-Code
19379 \begin_layout LyX-Code
19389 \begin_layout LyX-Code
19399 \begin_layout Standard
19400 produces the somewhat out of hand numbering scheme: <
19401 \begin_inset Quotes eld
19405 \begin_inset Quotes erd
19410 \begin_inset Quotes erd
19414 \begin_inset Quotes erd
19419 \begin_inset Quotes erd
19423 \begin_inset Quotes erd
19428 \begin_inset Quotes eld
19432 \begin_inset Quotes erd
19439 \begin_layout Standard
19443 \begin_layout Section
19447 \begin_layout Standard
19453 \begin_layout Standard
19454 \begin_inset VSpace bigskip
19460 \begin_layout Standard
19465 \begin_layout Standard
19471 tmpfont}{cmr17 scaled 2500}{
19483 \begin_layout Standard
19488 \begin_layout Standard
19499 hose of you who like the style of old books probably also like
19500 \begin_inset Quotes eld
19504 \begin_inset Quotes erd
19507 ---those large capital letters which begin each new chapter or section.
19508 Implementing them with plain LyX/LaTeX is straightforward (assuming you
19509 know some plain TeX!) but does require a lot of work and many iterations,
19510 as you can see by all the ugly TeX-mode stuff at the beginning of this
19514 \begin_layout Standard
19518 \begin_layout Standard
19524 bigdrop{-1em}{3}{ptmri}{T}+
19529 here is a much easier way of doing this, of course.
19538 ) package from CTAN allows a simple way to add such letters to your documents.
19539 Since this package is not a standard part of teTeX, I can't demonstrate
19540 it within this document, but if you copy this paragraph to a new document,
19542 \begin_inset Quotes eld
19552 \begin_inset Quotes erd
19555 and the pluses from the TeX code at the beginning of the paragraph, and
19560 usepackage{dropcaps}
19562 to your LaTeX preamble, you will get a nice Times Roman Italic
19563 \begin_inset Quotes eld
19567 \begin_inset Quotes erd
19570 , whose height is three lines of text and which protrudes 1 em into the
19572 (Make certain you have copied
19573 \begin_inset Quotes eld
19581 \begin_inset Quotes erd
19584 into a directory where TeX can see it.) The first argument is the amount
19585 of indentation; in this case the negative sign moves it into the margin.
19586 The second argument is the height of the letter in number of lines of text.
19587 The third argument is the font name: virtually anything which has a tfm
19588 file should work (wade through the
19590 .../texmf/fonts/tfm
19592 directory for possibilities).
19593 My personal favorite is
19594 \begin_inset Quotes eld
19602 \begin_inset Quotes erd
19605 , a fancy German font specifically designed for dropped capitals.
19606 The fourth argument is the letter (or letters) to be dropped.
19611 package also offers the
19617 command, as well as a slightly simplified
19626 \begin_layout Section
19627 Non-standard Paragraph Shapes
19630 \begin_layout Standard
19636 \begin_layout Standard
19637 \begin_inset VSpace bigskip
19643 \begin_layout Standard
19647 \begin_layout Standard
19659 \begin_layout Standard
19663 \begin_layout Standard
19672 \begin_layout Standard
19686 \begin_layout Standard
19691 \begin_layout Standard
19702 \begin_layout Standard
19711 \begin_layout Standard
19720 \begin_layout Standard
19729 \begin_layout Standard
19738 \begin_layout Standard
19747 \begin_layout Standard
19756 \begin_layout Standard
19765 \begin_layout Standard
19774 \begin_layout Standard
19783 \begin_layout Standard
19792 \begin_layout Standard
19801 \begin_layout Standard
19810 \begin_layout Standard
19819 \begin_layout Standard
19828 \begin_layout Standard
19837 \begin_layout Standard
19846 \begin_layout Standard
19855 \begin_layout Standard
19864 \begin_layout Standard
19870 There are times when the tyranny of rectangular paragraphs must be overthrown.
19871 In such situations, a call to the delightful plain TeX command
19878 As you can see, completely arbitrary shapes can be laid out with a suitable
19879 set of linelength definitions.
19880 While this parshape may look a bit silly and useless, one could conceive
19881 of situations such as finely tuned dropped capitals, word wrapping around
19882 non-rectangular graphics, etc.
19883 which will benefit from such handcrafting.
19886 \begin_layout Standard
19887 \begin_inset VSpace bigskip
19893 \begin_layout Standard
19898 parshape numlines #1indent #1length #2indent #2length \SpecialChar \ldots{}
19905 is the number of lines of text which define the paragraph.
19906 If there turn out to be fewer lines, the shape is truncated; if there are
19907 more, the excess lines have the same dimensions as the last line of the
19917 entries specify the indentation of the line from the left margin, and the
19918 length of the line as measured from that point.
19919 The shape applies only to the current paragraph; everything is reset to
19920 normal for the next paragraph.
19923 \begin_layout Standard
19927 \begin_layout Standard
19939 \begin_layout Section
19943 \begin_layout Standard
19944 As you can see, the examples in this section range from the useful to the
19946 While I don't expect that anyone will ever need the paragraph shape demonstrate
19947 d in the last section, the important point is that you can do almost anything
19948 you want in LyX if you are willing to figure out how to do it in TeX and
19950 TeX is a fantastically powerful typesetting system and all that power is
19951 available to you since LyX uses it as its backend.