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
40 \author "Richard Heck"
55 \begin_layout Standard
57 Principal maintainer of this file is
62 If you have comments or error corrections, please send them to the LyX
63 Documentation mailing list, <lyx-docs@lists.lyx.org>.
71 \begin_layout Standard
72 \begin_inset LatexCommand tableofcontents
83 \begin_layout Standard
88 manual, which you are now reading, is essentially Part II of the
90 User's Guide\SpecialChar \@.
93 The reason for splitting this document is simple: the
97 is already huge, and it contains all of the basic features one needs to
98 know in order to prepare most documents.
99 However, the LyX Team has a long-term goal of making LyX extensible through
100 various configuration files and external packages.
101 That means that if you want to support the Fizzwizzle LaTeX package, you
102 can create a layout file for it without having to alter LyX itself.
103 We've already had contributions of several new features this way.
104 This is the place where all of that gets documented.
107 \begin_layout Standard
108 This manual also documents some special features, like fax support, version
109 control, and SGML support, which require additional software to work properly.
110 Lastly, there's a chapter of LaTeX tools and tips, things you can use to
111 spruce up your documents by directly using the powerful features of LaTeX.
116 only WYSIWYM, and will only ever interface to certain LaTeX features.
119 \begin_layout Standard
120 Of course, with all of this extra documentation,
122 Extended LyX Features
124 may itself grow too big for its britches.
125 In that case, you can just call it the
126 \begin_inset Quotes eld
130 \begin_inset Quotes erd
136 \begin_layout Standard
137 If you haven't read the
141 yet, you are definitely in the wrong manual.
146 is the first place to go, since it will direct you to the correct manual,
147 and it also describes the notation and format of all of the manuals.
148 You should also be thoroughly familiar with the
152 and all of the basic features of LyX.
156 \begin_layout Standard
157 In this document, many sections are independent articles contributed by
158 an individual and are noted as such.
159 This person is generally whoever wrote the layout file for the new document
160 class or LaTeX package, or implemented the feature.
161 If there is no mention of an author to a chapter [or chapter sections],
162 that means it was written by the LyX Documentation Team.
165 \begin_layout Standard
166 Since all the topics in this manual depend heavily on LyX's interaction
167 with LaTeX, this first chapter covers the inner workings of LyX and how
168 to direct LyX to generate exactly the LaTeX code you want.
169 It is obviously for more seasoned LyX users.
172 \begin_layout Chapter
176 \begin_layout Section
180 \begin_layout Standard
181 \begin_inset LatexCommand label
182 name "sec:lyxandlatex"
186 This chapter is for both TeX-nicians and the LaTeX-curious.
187 In it, we'll explain how LyX and LaTeX work together to produce printable
189 This is the only place in any of the manuals where we assume you know something
193 \begin_layout Standard
194 At one time, we called LyX a
195 \begin_inset Quotes eld
198 WYSIWYM frontend to LaTeX,
199 \begin_inset Quotes erd
202 but that's no longer true.
203 There are frontends to LaTeX out there.
204 They are basically editors with the ability to run LaTeX and mark any errors
205 in the file you're editing.
214 run LaTeX, and it also marks errors in the file, it also does much, much
216 Thanks to the WYSIWYM concept, you don't need LaTeX to use LyX effectively.
217 LyX has also added a few extensions to LaTeX.
218 Try the following sometime: select
220 Export\SpecialChar \menuseparator
230 menu, then look at the preamble of the resulting
235 You'll notice a variety of new macros defined specifically by LyX.
236 These macros are defined automatically, according to the features you use
240 \begin_layout Standard
241 There are several commands that automatically invoke LaTeX.
245 \begin_layout Itemize
251 iew\SpecialChar \menuseparator
258 \begin_layout Itemize
264 iew\SpecialChar \menuseparator
269 pdate\SpecialChar \menuseparator
275 \begin_layout Itemize
283 \SpecialChar \menuseparator
289 \begin_layout Itemize
297 \SpecialChar \menuseparator
303 \begin_layout Standard
304 They will only invoke LaTeX if the file has changed since the last time
309 \begin_layout Standard
310 When you run LaTeX on the file you're editing, LyX performs these steps:
313 \begin_layout Enumerate
314 Convert the document to LaTeX and save to a file with the extension
325 \begin_layout Enumerate
330 file (maybe several times).
333 \begin_layout Enumerate
334 If there are any errors, insert error boxes in the document to mark where
336 These boxes are transient and are not saved along with the document.
339 \begin_layout Standard
340 If you've run LaTeX using
362 , LyX performs two more steps:
365 \begin_layout Itemize
370 to convert the DVI file to PostScript:
374 \begin_layout Itemize
380 , the output file has the extension
385 \begin_layout Itemize
394 , the output file has the extension
402 \begin_layout Itemize
407 or send the PostScript file to the printer.
410 \begin_layout Section
411 \begin_inset Quotes eld
414 Help! LyX generated an unreadable
419 \begin_inset Quotes erd
425 \begin_layout Standard
426 Die-hard LaTeX users will scream and howl this into the night, then declare
427 LyX useless, simply because they didn't RTFM.
430 \begin_layout Standard
431 We're going to set the record straight.
432 LyX produces two kinds of LaTeX files.
433 One is human readable.
434 The other is LyX readable.
435 Every time LyX executes LaTeX, it produces a LaTeX file that it can easily
441 file is not human readable.
442 Don't even try to read it.
447 file that you can send to a colleague, select
452 xport\SpecialChar \menuseparator
469 \begin_layout Section
470 Translating LaTeX files into LyX
473 \begin_layout Standard
474 You can import a LaTeX file into LyX by using the
479 ile\SpecialChar \menuseparator
484 mport\SpecialChar \menuseparator
492 This will call a program named
496 ---which will create a file
504 ---and then open that file.
507 \begin_layout Standard
512 will translate most legal LaTeX, but not everything.
513 It will leave things it doesn't understand in TeX mode, so after translating
518 , you can look for red text and hand-edit it to look right.
521 \begin_layout Standard
522 If you just want to put a piece of LaTeX code into a LyX file, see Section
523 \begin_inset LatexCommand ref
524 reference "sec:latexcodes"
531 \begin_layout Section
532 Inserting LaTeX Code into LyX Documents
533 \begin_inset LatexCommand label
534 name "sec:Inserting-LaTeX-Code"
541 \begin_layout Standard
542 \begin_inset LatexCommand label
543 name "sec:latexcodes"
547 This is a rather important point: You can always insert LaTeX code into
549 LyX simply cannot, and will probably never be able to, display every possible
551 If ever you need to insert LaTeX commands into your LyX document, you can
552 use the ERT box, which you can insert into your document with
557 nsert\SpecialChar \menuseparator
565 The ERT box comes in three forms: collapsed, open, and inlined.
566 The first two are used just like any other collapsible (foldable) box (such
567 as footnotes), and are useful for significant amounts of LaTeX commands.
569 \begin_inset Quotes eld
573 \begin_inset Quotes erd
576 ERT box displays its content as part of the button, and is useful for very
577 short sections of LaTeX commands.
582 \begin_layout Standard
592 \begin_layout Standard
593 You can switch between all three by right-clicking on the ERT.
594 Note that if you want more than one line of LaTeX commands, you cannot
595 use the inlined mode.
598 \begin_layout Standard
599 Here's an example of inserting LaTeX commands in a LyX document.
600 The code looks like this:
603 \begin_layout LyX-Code
612 This is an example for a minipage environment.
615 can put nearly everything in it, even (non-floating)
658 \begin_layout LyX-Code
662 \begin_layout Standard
663 The ERT box containing this text is directly after this paragraph.
664 Those of you reading the manual online will only see a bunch of funky text
666 Those reading a printed version of the manuals will see the actual results:
669 \begin_layout Standard
673 \begin_layout Standard
680 \begin_layout Standard
687 \begin_layout Standard
689 This is an example for a minipage environment.
690 You can put nearly everything in it, even (non-floating) figures and tables.
694 \begin_layout Standard
701 \begin_layout Standard
706 \begin_layout Standard
713 \begin_layout Standard
720 \begin_layout Standard
727 \begin_layout Standard
733 \begin_layout Standard
740 \begin_layout Standard
747 \begin_layout Standard
754 \begin_layout Standard
766 \begin_layout Standard
767 In addition to these two methods, you can also create a separate file containing
768 some complex LaTeX structure.
774 nsert\SpecialChar \menuseparator
782 to include your file (you should select the type
787 We recommend that you only do this if you have a
796 Otherwise, you'll have a big job tracking down LaTeX errors\SpecialChar \ldots{}
800 \begin_layout Standard
801 There are a few last notes to emphasize:
804 \begin_layout Itemize
805 Inside of LyX, LaTeX code appears
810 \begin_layout Itemize
815 check if your LaTeX code is correct.
818 \begin_layout Itemize
819 Beware reinventing the wheel.
822 \begin_layout Standard
823 That last note refers to two things.
824 First, LyX does have quite a few features tucked into it, and more are
826 Be sure to check the manuals to make sure that LyX doesn't have such-and-such
827 feature before you go off merrily coding LaTeX.
828 Second, there are numerous LaTeX packages out there to do all sorts of
829 things, from labels to envelopes to fancy multipage tables.
830 Check out a CTAN site for details (see Section
831 \begin_inset Quotes eld
835 \begin_inset Quotes erd
846 \begin_layout Standard
851 : I seem to do this an awful lot.
852 Sat down and merrily began coding something to print out labels, only to
853 learn that there were already 2 different LaTeX packages to do this.
854 Worse yet --- I had them already!
862 \begin_layout Standard
863 If you do need to do some wild and fancy things within your document, be
864 sure to check out a good LaTeX book for assistance.
865 There are a number of them listed in the bibliography of the
872 \begin_layout Standard
873 There are a number of LaTeX commands which have to be placed before the
874 beginning of the actual text.
875 They go into the preamble, and this is explained in the next section.
878 \begin_layout Section
879 LyX and the LaTeX Preamble
882 \begin_layout Subsection
883 About the LaTeX Preamble
886 \begin_layout Standard
887 \begin_inset LatexCommand label
892 If you already know LaTeX, there is no need to explain here what the preamble
894 If you don't, the following will give you some ideas --- we recommend again
895 that you consult a LaTeX book for further information.
896 In any case, you should read the points below, because they explain what
897 you can do and what you don't need to do in the LaTeX preamble of a LyX
901 \begin_layout Standard
902 The LaTeX preamble comes at the very beginning of a document,
910 \begin_layout Itemize
911 declare the document class.
912 LyX already does this for you.
916 \begin_layout Standard
917 If you're a seasoned LaTeX-nician, and you have some custom document class
918 you want to use, check out the
922 for information on how to make LyX interface to it.
923 Be sure to submit your efforts to the LyX Team for inclusion in future
928 \begin_layout Itemize
929 declare the usage of packages.
930 LaTeX packages provide special commands, which are only available within
931 a document when the package has been declared in the preamble.
932 For example, the package
936 forces all paragraphs to be indented.
937 There are other packages for labels, envelopes, margins, etc.
941 \begin_layout Itemize
942 set counters, variables, lengths and widths.
943 There are several LaTeX counters and variables which
947 be set globally from within the preamble in order to have the desired effect.
948 [There are other variables which you can set and reset inside the document,
949 too.] Margins are a good example of something which must be set in the preamble.
950 Another example is the label format for lists.
951 You can actually set these just about anywhere, but it's best to do it
952 just once, inside the preamble.
955 \begin_layout Itemize
956 declare user defined commands [with
968 ], mostly abbreviations for LaTeX commands which appear very often inside
970 Although the preamble is a good place to declare such commands, they
974 be declared anywhere else [but
978 they are used for the first time, of course\SpecialChar \ldots{}
980 This can be useful if there is a lot of raw LaTeX code in your document,
981 which normally should not be the case.
984 \begin_layout Standard
985 LyX adds its own set of definitions to the preamble of the
990 This makes LaTeX files generated by LyX portable.
993 \begin_layout Subsection
994 Changing the Preamble
997 \begin_layout Standard
998 The commands which LyX adds to the preamble of a LaTeX file are fixed; you
999 can't change them without patching LyX itself.
1000 You can, however, add your own stuff to the preamble.
1001 There are two ways to do this:
1004 \begin_layout Enumerate
1031 \SpecialChar \menuseparator
1039 dialog, depending on your frontend.
1040 Note that the LyX keybindings will not work in this dialog, alas.
1043 \begin_layout Enumerate
1044 Use the preamble contents you've added as your default template (see
1045 \begin_inset Quotes eld
1049 \begin_inset Quotes erd
1056 ), so that it will be the default preamble for any file you create.
1059 \begin_layout Standard
1060 LyX adds anything in the
1067 dialog to its own built-in preamble.
1068 Before adding your own declarations in the preamble, you should make sure
1069 that LyX doesn't already support what you want to do (remember what we
1070 said about reinventing the wheel?).
1073 make sure your preamble code is correct
1076 LyX doesn't check it.
1079 \begin_layout Subsection
1083 \begin_layout Standard
1084 Here are some examples of what you can add to a preamble, and what they
1088 \begin_layout Subsubsection
1092 \begin_layout Standard
1093 There are two variables under LaTeX that control page position:
1106 Their names should be self-explanatory.
1107 These variables are useful if you think for a moment about computer labels.
1108 Sometimes, the size of a print medium and the area of the medium that you
1109 can actually print on aren't the same.
1125 \begin_layout Standard
1126 The default values for
1138 are both 0 pt.,\InsetSpace ~
1141 the page isn't shifted.
1144 \begin_layout Standard
1145 Unfortunately, some DVI drivers always seem to shift the page.
1146 We have no idea why, or why the sysadmin hasn't fixed such behavior.
1147 If you're using LyX on a system that you don't personally maintain, and
1148 your sysadmin is a doofus,
1161 Suppose you're left and top margins are always 0.5 inches too big.
1162 You can add this to the preamble:
1165 \begin_layout LyX-Code
1173 \begin_layout LyX-Code
1181 \begin_layout Standard
1182 \SpecialChar \ldots{}
1183 and your margins should now be correct.
1186 \begin_layout Subsubsection
1190 \begin_layout Standard
1191 Speaking of labels, suppose you wanted to print out a bunch of address labels.
1192 There's a rather nice package, available at your nearest CTAN archive,
1193 for printing sheets of labels, called
1198 Now, your system may not have this package installed by default.
1199 We leave that up to you to check.
1200 You'll also want to read the documentation for it; we're not going to do
1202 Since this is an example, however, we'll give you an example of how you
1206 \begin_layout Standard
1207 First, make sure you're using the
1212 Next, you need to put the following in your preamble:
1215 \begin_layout LyX-Code
1221 \begin_layout LyX-Code
1227 \begin_layout LyX-Code
1233 \begin_layout LyX-Code
1239 \begin_layout LyX-Code
1245 \begin_layout LyX-Code
1251 \begin_layout LyX-Code
1257 \begin_layout Standard
1258 This sets things up for Avery® label sheets, stock #5360.
1259 You're now ready to print labels, but you'll need to insert LaTeX code,
1260 placing the commands
1272 around each label text.
1273 This and other special features of
1277 are explained in its documentation.
1280 \begin_layout Standard
1281 Someday, someone may write a LyX layout file to support this package directly.
1282 Maybe that someone is you.
1285 \begin_layout Subsubsection
1286 Example #3: Paragraph Indentation
1289 \begin_layout Standard
1290 Americans are trained to indent the first line of
1295 As with all of their other weird quirks, most Americans will whine and
1296 moan until they can have their way and indent the first line of all paragraphs.
1300 \begin_layout Standard
1305 : This was written by an American ---
1309 ! It's my perception of my fellow countrymen.
1310 Tough if you don't like it.
1319 \begin_layout Standard
1320 Of course, this behavior isn't standard typography.
1321 In books, you typically only indent the first line of a paragraph
1325 it follows another one.
1326 The idea behind indenting the first line of a paragraph is to distinguish
1327 neighboring paragraphs from one another.
1328 If there is no previous paragraph, for example, it follows a figure, or
1329 is the first paragraph in a section, then there is no special indentation.
1333 \begin_layout Standard
1334 If you're a typical American, though, you don't care about such esoteric
1335 things; you want your indentation! Add this to the preamble:
1338 \begin_layout LyX-Code
1341 usepackage{indentfirst}
1344 \begin_layout Standard
1345 If your TeX distribution isn't a braindead one, you'll have this package,
1346 and all of your paragraphs will get the indentation you think they deserve.
1349 \begin_layout Subsubsection
1350 Example #4: This Document
1353 \begin_layout Standard
1354 You can also check out the preamble of this document to get an idea of some
1355 of the advanced things you can do.
1356 You'll probably need to make the
1361 reamble\SpecialChar \ldots{}
1364 dialog full-screen to see most of it.
1365 Also, there are more examples and an assortment of LaTeX
1366 \begin_inset Quotes eld
1370 \begin_inset Quotes erd
1373 given in Chapter\InsetSpace ~
1375 \begin_inset LatexCommand ref
1376 reference "cha:secrets"
1384 \begin_layout Section
1385 LyX and LaTeX Errors
1388 \begin_layout Standard
1389 When LyX calls LaTeX, it tells LaTeX to blithely ignore any errors and keep
1391 It then uses the log-file from the LaTeX run to do a post-mortem.
1392 As we stated earlier in the chapter, LyX generates two kinds of
1396 files, one of which it uses to locate errors in the document.
1397 If there was an error someplace, LyX will put a box with the word
1398 \begin_inset Quotes eld
1402 \begin_inset Quotes erd
1405 at the appropriate place in the document.
1409 \begin_layout Standard
1410 LyX will occasionally misguess where the error was.
1411 This will typically happen with tables, figures, math, and the preamble.
1416 It will also display a message alerting you to the fact that there were
1420 \begin_layout Standard
1421 You can navigate through the errors by using
1437 \begin_inset Quotes eld
1441 \begin_inset Quotes erd
1444 the error-boxes and view the error message LaTeX produced by clicking on
1448 \begin_layout Standard
1449 Some folks also like to look at the log file directly, accessible from
1454 ocument\SpecialChar \menuseparator
1464 There are some fairly common error messages and warnings.
1465 We'll cover those here.
1466 You should look at a good LaTeX book for a complete listing.
1469 \begin_layout Itemize
1470 \begin_inset Quotes eld
1478 \begin_inset Quotes eld
1485 \begin_layout Standard
1486 Anything beginning with these word is a warning message for the purpose
1488 \begin_inset Quotes eld
1492 \begin_inset Quotes erd
1495 the LaTeX code itself.
1496 You'll get messages like this if you added or changed cross-references
1497 or bibliography entries, in which case, LaTeX is trying to tell you that
1498 you need to make another run.
1501 \begin_layout Standard
1502 You can by-and-large ignore these.
1506 \begin_layout Itemize
1507 \begin_inset Quotes eld
1515 \begin_inset Quotes erd
1522 \begin_layout Standard
1523 Another warning message, this time about fonts which LaTeX couldn't find.
1524 The rest of the message will often say something about a replacement font
1528 \begin_layout Standard
1529 You can safely ignore these.
1533 \begin_layout Itemize
1534 \begin_inset Quotes eld
1544 \begin_inset Quotes erd
1551 \begin_layout Standard
1557 They are warning you about lines that were too long and run past the right
1559 Almost always, this is unnoticeable in the final output.
1560 Or, only one or two characters extend past the margin.
1561 LaTeX seems to generate at least one of these messages for just about any
1565 \begin_layout Standard
1566 You can ignore these stupid messages.
1567 Your eyes will tell you if there's a problem with something that's too
1568 wide; just look at the output.
1572 \begin_layout Itemize
1573 \begin_inset Quotes eld
1583 \begin_inset Quotes erd
1590 \begin_layout Standard
1591 Not quite as common as its cousin.
1592 LaTeX seems to like to print lines that are a bit too wide as opposed to
1593 ones that are a bit too narrow.
1594 We have no idea why.
1597 \begin_layout Standard
1598 You can ignore these, too.
1602 \begin_layout Itemize
1603 \begin_inset Quotes eld
1613 \begin_inset Quotes erd
1617 \begin_inset Quotes eld
1627 \begin_inset Quotes erd
1634 \begin_layout Standard
1635 Warnings about troubles breaking the page.
1636 Once again, just look at the output.
1637 Your eyes will tell you where something has gone wrong.
1641 \begin_layout Itemize
1642 \begin_inset Quotes eld
1648 \begin_inset Quotes els
1652 \begin_inset Quotes ers
1658 \begin_inset Quotes erd
1665 \begin_layout Standard
1667 \begin_inset Quotes eld
1671 \begin_inset Quotes erd
1674 isn't installed on this system.
1675 This usually appears because some package your document needs isn't installed.
1676 If you didn't touch the preamble or didn't use the
1682 command, then one of the packages LyX tried to load is missing.
1688 elp\SpecialChar \menuseparator
1695 , to get a list of packages that LyX knows about.
1696 This file is updated whenever you reconfigure LyX (using
1703 \SpecialChar \menuseparator
1708 ) and tells you which packages have been detected and what they do.
1711 \begin_layout Standard
1722 command, and the package in question isn't installed, you'll need to install
1727 \begin_layout Itemize
1728 \begin_inset Quotes eld
1733 LaTeX Error: Unknown option
1736 \begin_inset Quotes erd
1743 \begin_layout Standard
1744 Error messages beginning with this are trying to tell you that you specified
1745 a bad or undefined option to a package.
1746 Check the package's documentation.
1750 \begin_layout Itemize
1751 \begin_inset Quotes eld
1756 Undefined control sequence
1759 \begin_inset Quotes erd
1766 \begin_layout Standard
1767 If you've inserted LaTeX code into your document, but made a typo, you'll
1769 You may have forgotten to load a package.
1770 In any case, this error message usually means that you used an undefined
1775 \begin_layout Standard
1776 There are other error and warning messages.
1777 Some are self-explanatory.
1778 These are usually LaTeX messages.
1779 Others are downright cryptic.
1780 These are actually TeX error messages, and we really have
1784 what they mean or how to decipher them.
1787 \begin_layout Standard
1788 There's a general sequence you should follow if you get error messages:
1791 \begin_layout Enumerate
1792 Look at the LaTeX code you inserted for typos.
1795 \begin_layout Enumerate
1796 If there are no typos, check and see that you used the command(s) correctly.
1799 \begin_layout Enumerate
1800 If you get a bunch of error boxes piled up at the very top of the document,
1801 it means that there are errors in the preamble.
1802 Start debugging your preamble.
1805 \begin_layout Enumerate
1806 If you didn't add anything to the preamble and didn't add any LaTeX code
1807 to the document, the first suspect is your LaTeX distribution itself.
1808 Check for missing packages and install them.
1811 \begin_layout Enumerate
1812 Okay, so there are no missing packages.
1813 Did you use any of the fine-tuning options in LyX? Specifically, did you
1818 any of them, like trying to manually insert lots of
1820 Protected\InsetSpace ~
1831 s? Did you try to kludge something together with these instead of using
1832 the appropriate paragraph environment?
1835 \begin_layout Enumerate
1836 All right, you didn't use any of the fine-tuning options, you played by
1838 Did you try to pull a fancy maneuver? Did you do something funky inside
1839 a table or an equation, like inserting a graphic into a table cell?
1842 \begin_layout Enumerate
1843 Do you have long sections of text where LaTeX cannot find a place to break
1844 a line? By default, LaTeX is rather strict about how much extra inter-word
1845 spacing it will add in order to break a line.
1846 Preferably, you should rework the paragraph to avoid the problem.
1847 If this isn't an option, you can wrap your text in
1853 to make LaTeX's line breaking more, well, sloppy.
1856 \begin_layout Enumerate
1857 Did you go overboard with the nesting? LyX (currently) doesn't check to
1858 make sure you're in the limits for nesting environments.
1859 If you nested a bunch of environments to the
1860 \begin_inset Formula $17^{\mathrm{th}}$
1863 level, that's the problem.
1866 \begin_layout Enumerate
1867 Okay, you didn't get any error messages, but your output looks whacked.
1868 If you have a table or figure that's too wide or long for the page, you
1873 \begin_layout Enumerate
1874 rescale the figure so it fits.
1877 \begin_layout Enumerate
1878 trim down the table so it fits.
1881 \begin_layout Standard
1882 If something else is wrong with the output, and you didn't try to pull anything
1883 fancy or kludge the fine-tuning options, we're not sure what's wrong.
1887 \begin_layout Standard
1888 If all this doesn't help --- well, then
1892 you might have found a bug in LyX\SpecialChar \ldots{}
1896 \begin_layout Chapter
1900 \begin_layout Section
1901 Preparing a Bibliography with BibTeX
1902 \begin_inset LatexCommand label
1903 name "sec:Preparing-a-Bibliography"
1910 \begin_layout Standard
1917 Jürgen Spitzmüller
1920 \begin_layout Standard
1921 \begin_inset VSpace bigskip
1927 \begin_layout Standard
1929 STOP! If you don't know what BibTeX is, or have a reasonably good idea of
1932 e.\InsetSpace \thinspace{}
1936 setting up your own bibliographic databases),
1940 , do not walk, to your nearest copy of the 2nd edition of Lamport's
1942 LaTeX: A Document Preparation System
1944 , particularly Appendix B.
1945 The rest of this discussion assumes you have created a correct bibliography
1946 file, that you have all relevant environment variables set correctly (esp.
1959 ), and that if sufficiently desperate, you could create and
1960 \begin_inset Quotes eld
1964 \begin_inset Quotes erd
1967 a LaTeX file with a BibTeX database.
1971 \begin_layout Standard
1972 For those who don't know what BibTeX is, it is a system for creating a large
1973 database of your most used journal references.
1974 For all future articles you write, you only need to include this standard
1975 database and reference the appropriate key to each reference.
1976 Even if you write only a few papers with handful of references each, it
1977 is well worth your time to examine BibTeX and decide whether it will be
1981 \begin_layout Standard
1982 To use BibTeX with LyX, first read the
1986 where it describes how to insert citations.
1987 The basic mechanism for inserting BibTeX references is the same.
1988 Then, at the very end of your document, select
1990 Insert\SpecialChar \menuseparator
1995 TOC\SpecialChar \menuseparator
1999 In the resulting dialog, fill out the dialog boxes as follows:
2002 \begin_layout Description
2003 Database: enter the name of your
2016 For searching multiple
2020 files, just enter them in the desired order, separated by commas.
2024 \begin_layout Description
2025 Style: enter the name of your BibTeX style file *without* the
2030 The default style is
2034 (which should be included in your LaTeX distribution, so you don't have
2035 to worry about creating it).
2038 \begin_layout Standard
2039 For each citation, assuming that the source is in the
2048 nsert\SpecialChar \menuseparator
2055 at the correct location in the text, and enter the appropriate reference
2057 Nothing else is required; when invoking
2062 iew\SpecialChar \menuseparator
2069 , for example, you should see that BibTeX and LaTeX are invoked as needed,
2070 including multiple invocations of LaTeX.
2074 \begin_layout Subsection
2075 Alternative Citation Styles
2078 \begin_layout Standard
2079 Standard BibTeX uses numbers (e.\InsetSpace \thinspace{}
2080 g.\InsetSpace \space{}
2082 \begin_inset Quotes eld
2086 \begin_inset Quotes erd
2089 ) to refer to a cited work.
2090 However, in many scientific disciplines, other citation styles are in use.
2091 The most common one is the author-year style (e.\InsetSpace \thinspace{}
2092 g.\InsetSpace \space{}
2094 \begin_inset Quotes eld
2098 \begin_inset Quotes erd
2102 LyX supports two packages that provide this style,
2111 Both packages have their own pros and cons, which cannot be listed in detail.
2112 If you only want to have simple author-year (or author-numerical) style
2113 or if you want to use one of the countless style files for natbib, than
2118 package is probably your choice.
2119 If you need special features like short title references, ibidem etc., you
2120 might consider the fairly new
2127 \begin_layout Standard
2128 The handling of both packages in LyX is basically the same.
2134 ocument\SpecialChar \menuseparator
2145 pane (with the xforms frontend: the
2159 With both packages, you will get some extra features in the citation dialog
2160 and you can select the style of the reference (
2161 \begin_inset Quotes eld
2165 \begin_inset Quotes erd
2169 \begin_inset Quotes eld
2173 \begin_inset Quotes erd
2177 \begin_inset Quotes eld
2181 \begin_inset Quotes erd
2185 \begin_inset Quotes eld
2189 \begin_inset Quotes erd
2193 Note that both packages need specifically designed style files (they both
2194 ship their own, while there are lots of additional style files and even
2195 an interactive style file builder
2199 \begin_layout Standard
2201 \begin_inset LatexCommand url
2202 target "ftp://ctan.tug.org/tex-archive/macros/latex/contrib/custom-bib/"
2218 \begin_layout Subsection
2219 Sectionated Bibliographies
2220 \begin_inset LatexCommand label
2221 name "sub:Sectionated-Bibliographies"
2228 \begin_layout Standard
2229 Sometimes you might need to divide your bibliography into several sections.
2230 If you are, for instance, a historian, the possibility to separate sources
2231 and scientific works is most likely a
2232 \begin_inset Quotes eld
2236 \begin_inset Quotes erd
2240 Unfortunately, BibTeX itself does not allow you to do this.
2241 The good news is, though: With the help of some LaTeX packages, BibTeX
2242 can be extended to fit your historical needs.
2245 \begin_layout Standard
2246 As of version 1.4, LyX provides native support for one of these packages,
2255 \begin_layout Standard
2257 \begin_inset LatexCommand url
2258 target "ftp://ctan.tug.org/tex-archive/macros/latex/contrib/bibtopic/"
2267 The advantage of this package (compared to other packages like
2271 ) is that you don't need to define new citation commands.
2272 Instead, you need to prepare different bibliographic databases which include
2273 the entries for the different sections of the bibliography.
2274 For example: If you want to divide your bibliography into the sections
2276 \begin_inset Quotes eld
2280 \begin_inset Quotes erd
2284 \begin_inset Quotes eld
2288 \begin_inset Quotes erd
2291 , you first need to create two bibliographic databases, e.\InsetSpace \thinspace{}
2292 g.\InsetSpace \space{}
2305 \begin_layout Standard
2311 ocument\SpecialChar \menuseparator
2322 pane (with the xforms frontend: the
2329 Sectionated\InsetSpace ~
2333 Now you can insert multiple BibTeX references (as described in section\InsetSpace ~
2335 \begin_inset LatexCommand ref
2336 reference "sec:Preparing-a-Bibliography"
2340 ), one for each section of your bibliography.
2341 Returning to our example: Insert a BibTeX reference for the database
2345 and a second one for the database
2350 You are free to use the same or different styles for each section.
2351 Additionally, you can chose if the bibliography section should contain
2353 \begin_inset Quotes eld
2356 all cited references
2357 \begin_inset Quotes erd
2360 of the specified database(s) (which is the default),
2361 \begin_inset Quotes eld
2364 all uncited references
2365 \begin_inset Quotes erd
2369 \begin_inset Quotes eld
2373 \begin_inset Quotes erd
2377 This might be useful if you would like to separate your bibliography into
2379 \begin_inset Quotes eld
2383 \begin_inset Quotes erd
2387 \begin_inset Quotes eld
2391 \begin_inset Quotes erd
2395 \begin_inset Quotes eld
2399 \begin_inset Quotes erd
2403 The titles for the sections can be added as ordinary sections or subsections.
2408 removes the bibliography title, you have manually re-add that, too (as
2409 a chapter* or section*, for instance).
2412 \begin_layout Subsection
2413 Multiple Bibliographies
2416 \begin_layout Standard
2417 Multiple bibliographies, e.\InsetSpace \thinspace{}
2418 g.\InsetSpace \space{}
2419 a bibliography for each section or chapter of
2420 the document, are not supported by BibTeX itself.
2425 package, which is used for the creation of sectionated bibliographies in
2426 LyX (cf.\InsetSpace ~
2427 section\InsetSpace ~
2429 \begin_inset LatexCommand ref
2430 reference "sub:Sectionated-Bibliographies"
2434 ), provides an easy way to solve this task, if you are willing to use some
2435 LaTeX-Code (ERT, cf.\InsetSpace ~
2436 section\InsetSpace ~
2438 \begin_inset LatexCommand ref
2439 reference "sec:Inserting-LaTeX-Code"
2447 \begin_layout Standard
2448 An alternative approach is to use the
2456 package, respectively.
2464 \begin_layout Standard
2470 ocument\SpecialChar \menuseparator
2481 pane (with the xforms frontend: the
2488 Sectionated\InsetSpace ~
2492 In the document, you have to enclose the sections, which shall contain
2493 their own bibliography (including the BibTeX reference itself), between
2506 (those commands have to be inserted as ERT).
2507 The bibliography will contain all references which have been cited in the
2509 N.\InsetSpace \thinspace{}
2510 B.: If you are using this approach, then
2514 citation reference has to be inside some btUnit.
2515 Also, the btUnits cannot be nested.
2518 \begin_layout Section
2522 \begin_layout Standard
2523 A good index is one of the hardest things to make in a lengthy document,
2524 but LyX helps make things a bit simpler by interfacing to the
2528 program which is found in most recent LaTeX distributions.
2532 \begin_layout Standard
2552 Outputs\SpecialChar \menuseparator
2553 LaT\SpecialChar \textcompwordmark{}
2562 section of the preferences dialog, however, you can customize the index
2563 command, if you prefer an alternative program like
2586 Inserting an index and marking words to include in it works much the same
2587 way as preparing a bibliography as mentioned in the last section.
2590 \begin_layout Standard
2591 First, go to the end of your file and select
2596 nsert\SpecialChar \menuseparator
2607 C\SpecialChar \menuseparator
2620 Then, for each word you would like to include in the index, go to the end
2621 of that word and click on
2626 nsert\SpecialChar \menuseparator
2639 This will insert a tag showing the word as it will appear in the index.
2640 That's all there is to it; LyX will automatically call
2644 for you and create the index itself.
2645 The text in the dialog available from right-clicking on the index button
2646 accepts LaTeX, so you'll need to be careful to avoid using any special
2648 On the positive side, you can use the advanced options - have a look at
2649 the documentation which comes with your LaTeX distribution to find out
2650 how to do things like
2651 \begin_inset Quotes eld
2655 \begin_inset Quotes erd
2661 \begin_layout Standard
2662 Be careful not to put spaces between the word in the text and the index
2663 marker; apparently the wrong page number can be produced if this happens.
2666 \begin_layout Section
2670 \begin_layout Standard
2673 Özgür Ug̃raş Baran
2676 \begin_layout Standard
2677 Sometimes you need to compile a list of symbols that are mentioned in your
2678 document with a brief explanation of them.
2679 A LaTeX package named
2683 provides an easy way of compiling such lists.
2688 is included in most standard Linux distributions.
2689 If your distribution doesn't contain it, you should download it from a
2690 CTAN mirror and install the package in order to use this feature of LyX.
2693 \begin_layout Standard
2694 A glossary entry is created if you place the cursor after a symbol entry
2695 and then use the menu
2697 Insert\SpecialChar \menuseparator
2698 Glossary\InsetSpace ~
2703 \begin_inset Quotes eld
2711 \begin_inset Quotes erd
2714 is inserted and a window pops up asking for the glossary entry.
2715 A glossary entry consists of two main entries.
2716 The first is the symbol that you want to refer to.
2717 You should enter a valid LaTeX code for the corresponding field in the
2719 The second is the description of the symbol.
2720 You should fill the corresponding field to complete the glossary entry.
2723 \begin_layout Subsection
2724 Sort Order of Glossary Entries
2727 \begin_layout Standard
2728 Suppose you have two glossary entries for the symbols
2729 \begin_inset Formula $a$
2733 \begin_inset Formula $\sigma$
2741 package automatically sorts these two entries considering the symbol entry,
2742 while printing the Glossary.
2743 However, this can lead to an undesired sort order.
2744 For the example given, the first entry appears as
2748 , while the second is
2755 Note that, in this case
2756 \begin_inset Formula $\sigma$
2759 is located in front of the
2760 \begin_inset Formula $a$
2763 , since the character
2764 \begin_inset Quotes eld
2770 \begin_inset Quotes erd
2773 is considered in sorting.
2774 In order to control the sort order, you can edit the
2779 field of the glossary dialog.
2780 For the given example, you can edit this field as
2789 Then, these entries will be effective in the sort ordering and
2790 \begin_inset Formula $a$
2793 will be located before
2794 \begin_inset Formula $\sigma$
2800 \begin_layout Standard
2801 This feature provides exciting ways of ordering the entries.
2802 For subgrouping and tips for using sort entries see the official nomencl
2806 \begin_layout Subsection
2810 \begin_layout Standard
2811 You can turn on referencing to the equations and pages in the glossary entries.
2812 For this purpose, you should add referencing options commands at the end
2813 of description field.
2814 There are six referencing options in nomencl package:
2817 \begin_layout Paragraph*
2823 \begin_layout Standard
2824 Adds reference to the equation by adding the phrase
2825 \begin_inset Quotes eld
2829 \begin_inset Quotes erd
2835 \begin_layout Paragraph*
2841 \begin_layout Standard
2842 Adds reference to the page by adding the phrase
2843 \begin_inset Quotes eld
2847 \begin_inset Quotes erd
2853 \begin_layout Paragraph*
2859 \begin_layout Standard
2860 Is the short notation of
2867 \begin_layout Paragraph*
2877 \begin_layout Standard
2878 Turns off corresponding referencing options if they are turned on globally
2879 (see reference documentation of nomencl).
2882 \begin_layout Subsection
2886 \begin_layout Standard
2887 You can insert the glossary with the menu
2889 Insert\SpecialChar \menuseparator
2891 &TOC\SpecialChar \menuseparator
2895 A light blue box labeled
2896 \begin_inset Quotes eld
2904 \begin_inset Quotes erd
2907 will show the place where the index is printed in the output.
2908 The index list box is not clickable like other LyX-boxes.
2909 In the printed output the title of the glossary appears as
2917 \begin_layout Standard
2918 This is translated to the document language for a small number of languages,
2919 amongst others French and German
2925 If you are not happy with the title, you can change it by re-defining the
2933 For example, in order to change the title
2941 add the following line to the preamble.
2944 \begin_layout LyX-Code
2949 nomname}{List of Symbols}
2952 \begin_layout Standard
2953 If you're unhappy with the amount of space for symbols, you can alter it
2954 by adding following line to the preamble.
2957 \begin_layout LyX-Code
2962 nomlabelwidth}{3.0cm}
2965 \begin_layout Section
2969 \begin_layout Subsection
2973 \begin_layout Standard
2974 When you are working on a large file with many sections, it is often convenient
2975 to break up the document into several files, or perhaps you have something
2976 where a table may change from time to time, but the preceding text does
2978 In these cases, you should seriously consider using multipart documents.
2979 For example, scientific papers often have five major sections: the introduction
2980 , observations, results, discussion, and conclusion.
2981 Each of these could be its own separate LyX file, with one
2982 \begin_inset Quotes eld
2986 \begin_inset Quotes erd
2989 file which contains the title, authors, abstract, references, etc., plus
2990 the five included files.
2991 It is important to note that each of these files is a full LyX file which
2992 can be formatted and printed on its own, as well as included in a master
2994 Each of these files must have the same document class, however--- don't
2995 attempt to mix book classes with article classes.
2996 You may also include LaTeX files; however, these files must not have their
3002 everything up to and including the
3014 line must be deleted) or else errors will be generated when you try to
3018 \begin_layout Standard
3019 LyX allows you to include files quite easily with
3024 nsert\SpecialChar \menuseparator
3033 When you click on this selection a small box is inserted into the file
3034 at the current cursor location.
3035 Clicking on the box raises a dialog which allows you to select the file
3036 to be included, and the method of its inclusion.
3040 \begin_layout Standard
3041 The file selection box should by now be obvious.
3042 The three inclusion methods are
3043 \begin_inset Quotes eld
3047 \begin_inset Quotes erd
3051 \begin_inset Quotes eld
3055 \begin_inset Quotes erd
3059 \begin_inset Quotes eld
3063 \begin_inset Quotes erd
3067 The difference between
3068 \begin_inset Quotes eld
3072 \begin_inset Quotes erd
3076 \begin_inset Quotes eld
3080 \begin_inset Quotes erd
3083 is really only meaningful to LaTeXperts, but the practical difference is
3084 that files which are
3085 \begin_inset Quotes eld
3089 \begin_inset Quotes erd
3092 are typeset beginning on a new page, while files which are
3093 \begin_inset Quotes eld
3097 \begin_inset Quotes erd
3100 are typeset starting on the current page.
3101 Perhaps the labeling in LyX will be changed someday to reflect this.
3104 \begin_layout Standard
3105 Generally, the master file is converted into a full LaTeX file before typesettin
3106 g, while the included files are converted to LaTeX files which do not have
3107 all the preamble information.
3117 button prevents this conversion.
3120 \begin_layout Standard
3122 \begin_inset Quotes eld
3126 \begin_inset Quotes erd
3129 included file allows you to include a file typeset exactly as it appears
3130 in the file, i.e.\InsetSpace ~
3131 verbatim mode, with the characters set in a fixed-width
3133 Normally, spaces in this file are invisible, though two consecutive spaces
3134 are conserved, unlike LyX's normal treatment of spaces.
3135 However, setting the
3145 checkbox typesets a mark to unambiguously define the presence of a space.
3149 \begin_layout Subsection
3150 Cross-References Between Files
3153 \begin_layout Standard
3154 It is possible to set up cross-references between the different files.
3155 First, open all the files in question: let's call them A and B in a two
3156 file example, where B is included in A.
3157 Let's say you insert a label in A, then want to reference it in B.
3158 Open the cross-reference dialog in whilst in document B, and you can select
3160 \begin_inset Quotes eld
3164 \begin_inset Quotes erd
3170 \begin_layout Section
3171 Fancy Headers and Footers
3174 \begin_layout Standard
3175 The default page layout is rather plain; for an article document class,
3176 all you get is a centered page number at the bottom of the page.
3177 This document is the book class, so it appears to be a bit fancier, but
3178 to really put on a show, you need to set the document page style to
3179 \begin_inset Quotes eld
3183 \begin_inset Quotes erd
3186 , as mentioned in the
3192 This section describes the LaTeX codes you need to insert in your LaTeX
3193 preamble or the text in order to get the desired effects.
3196 \begin_layout Standard
3197 The page header is divided into three fields, not surprisingly labeled
3198 \begin_inset Quotes eld
3202 \begin_inset Quotes erd
3206 \begin_inset Quotes eld
3210 \begin_inset Quotes erd
3214 \begin_inset Quotes eld
3218 \begin_inset Quotes erd
3222 The footer is also divided into these three fields.
3223 The LaTeX commands to set these fields in the simplest manner are
3248 Suppose you wish to put your name in the upper left hand corner of each
3250 Simply insert the following command in the preamble:
3253 \begin_layout Standard
3262 \begin_layout Standard
3263 You will now see your name in the upper left.
3264 If a field has a default entry that you would like to get rid of (often
3265 the page number appears in the central footer, simply include a command
3266 with a blank argument, e.\InsetSpace \thinspace{}
3270 \begin_layout Standard
3278 \begin_layout Standard
3279 Let's get really fancy: lets put the section number with the word
3280 \begin_inset Quotes eld
3284 \begin_inset Quotes erd
3287 (e.\InsetSpace \thinspace{}
3289 Section 3) in the upper left, the page number (e.\InsetSpace \thinspace{}
3291 Page 4) in the upper
3292 right, your name in the lower left, and the date in the lower right.
3293 The following commands should now appear in the preamble:
3296 \begin_layout Standard
3306 \begin_layout Standard
3314 \begin_layout Standard
3324 \begin_layout Standard
3333 \begin_layout Standard
3341 \begin_layout Standard
3351 \begin_layout Standard
3364 access LaTeX's section and page counters, and so print out the current
3365 section and page numbers.
3372 simply prints out today's date.
3375 \begin_layout Standard
3376 The thicknesses of the horizontal rules drawn beneath the header and above
3377 the footer can also be modified.
3378 If you don't want one of the headers, set its thickness to 0.
3379 The header rule has a default thickness of 0.4pt, the footer rule is 0pt.
3380 Use the commands, e.\InsetSpace \thinspace{}
3388 headrulewidth}{0.4pt}
3396 footrulewidth}{0.4pt}
3398 to set the thicknesses.
3401 \begin_layout Standard
3402 You can switch the header/footer settings on and off for individual pages
3407 thispagestyle{empty}
3413 thispagestyle{plain}
3419 thispagestyle{fancy}
3422 Simply insert them in the text on the page you want changed and mark them
3424 In fact, title pages are marked as plain by default, while following pages
3425 are marked fancy when using the global fancy setting.
3428 \begin_layout Standard
3429 There are more complex commands which will let you insert things in the
3430 upper left on odd numbered pages, etc., but I will refer you to the
3434 package documentation for more descriptions.
3435 For example, if you have a teTeX installation, look for
3437 /usr/share/texmf/doc/latex/fancyhdr/\SpecialChar \-
3443 \begin_layout Standard
3444 As a final example, it is possible to include an Encapsulated PostScript
3445 file in the header or footer.
3446 Suppose you want to put a company logo in the upper lefthand corner.
3447 You might try something like
3450 \begin_layout Standard
3459 includegraphics{logo.eps}}}
3462 \begin_layout Standard
3464 (you may need to preface this with
3468 usepackage{graphics}
3470 if you don't include EPS files elsewhere in your document).
3473 \begin_layout Section
3474 Itemize Bullet Selection
3475 \begin_inset LatexCommand label
3483 \begin_layout Standard
3489 \begin_layout Subsection
3493 \begin_layout Standard
3494 LyX provides 216 bullet shapes that can be accessed from a simple dialog.
3495 Using this dialog you can easily specify what bullet shape to use at each
3496 level of an itemized list.
3497 These settings are document-wide so you won't be able to specify different
3498 sets of bullets for different paragraphs
3502 \begin_layout Standard
3503 Well, actually you can but you'll have to do it by hand.
3511 \begin_layout Subsection
3515 \begin_layout Standard
3516 Open the dialog by selecting the
3521 ocument\SpecialChar \menuseparator
3528 menu item and then select the
3538 \begin_layout Standard
3539 The dialog provides you with a table of bullet shapes.
3540 A column of buttons on the left of the table provides access to the six
3541 different panels of bullet shapes.
3542 The row of buttons across the top is used to select which bullet depth
3544 A text entry under the table shows the currently selected bullet shape's
3545 LaTeX equivalent and this can be edited if desired.
3546 If you do modify the text you will also need to specify any needed packages
3547 in the LaTeX preamble.
3550 \begin_layout Standard
3551 The six panels are divided up by the packages they require.
3552 The following table shows the mappings from button name to LaTeX packages.
3555 \begin_layout Standard
3557 \begin_inset Tabular
3558 <lyxtabular version="3" rows="7" columns="2">
3560 <column alignment="center" valignment="top" leftline="true" width="0pt">
3561 <column alignment="center" valignment="top" leftline="true" rightline="true" width="0pt">
3562 <row topline="true" bottomline="true">
3563 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
3566 \begin_layout Standard
3581 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
3584 \begin_layout Standard
3600 <row topline="true">
3601 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
3604 \begin_layout Standard
3619 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
3622 \begin_layout Standard
3637 <row topline="true">
3638 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
3641 \begin_layout Standard
3656 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
3659 \begin_layout Standard
3675 <row topline="true">
3676 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
3679 \begin_layout Standard
3694 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
3697 \begin_layout Standard
3713 <row topline="true">
3714 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
3717 \begin_layout Standard
3732 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
3735 \begin_layout Standard
3751 <row topline="true">
3752 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
3755 \begin_layout Standard
3770 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
3773 \begin_layout Standard
3789 <row topline="true" bottomline="true">
3790 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
3793 \begin_layout Standard
3808 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
3811 \begin_layout Standard
3834 \begin_layout Standard
3835 LyX doesn't stop you using bullets from packages you don't have.
3836 If you get errors from LaTeX when you try to view or print the file then
3837 its likely you are missing a package.
3838 LyX doesn't restrict your use since you may be editing locally and exporting
3842 \begin_layout Subsection
3846 \begin_layout Standard
3847 Select which bullet depth you want to change then select the bullet shape
3849 Any changes will not be visible in LyX, but are visible when viewing the
3850 document using xdvi or ghostview.
3853 \begin_layout Standard
3854 You can reset a bullet shape to the default simply by clicking your right
3855 mouse button on the appropriate bullet depth button.
3858 \begin_layout Standard
3863 want to have multiple sets of paragraphs with different sets of bullets
3864 in each then you're going to have to get your hands dirty.
3865 The itemize bullet selection dialog can help though because it provides
3866 you with the LaTeX code for a wide range of bullet shapes.
3867 To make your own custom paragraphs you have the following options:
3870 \begin_layout Standard
3874 \begin_layout Standard
3890 \begin_layout Standard
3894 \begin_layout Standard
3916 \begin_layout Itemize
3917 Use the LaTeX command
3923 to specify a new bullet shape for a given depth.
3924 You'll also need to save the current bullet shape so you can restore it
3926 In this itemized list the following LaTeX code was used to change the bullet
3927 used for the first depth.
3959 Note that the itemize depth is specified in Roman numerals as part of the
3969 \begin_layout Itemize
3973 \begin_layout Standard
3986 Specify each individual entry by starting each item with the bullet shape
3987 enclosed in square brackets and set as TeX.
3988 For example, this item was started with
4001 \begin_layout Standard
4005 \begin_layout Standard
4021 \begin_layout Standard
4022 You'll also need to revert the labelitem back to its previous setting for
4023 the global bullet shape settings to remain in effect.
4024 The way used here was:
4037 \begin_layout Chapter
4038 Special Document Classes
4041 \begin_layout Section
4045 \begin_layout Standard
4051 \begin_layout Standard
4052 \begin_inset VSpace bigskip
4058 \begin_layout Standard
4060 The AMS LaTeX layouts are set up to conform to suggested styles for mathematical
4061 papers to be submitted to American Mathematical Society publications.
4062 The layouts are not tailored to a specific journal, but easily can be.
4063 You should refer to the AMS documentation for specific instructions for
4064 each journal (usually it will entail only changing a single line in the
4066 That documentation is available on the Web at
4067 \begin_inset LatexCommand url
4068 target "http://www.ams.org"
4073 \begin_inset LatexCommand url
4074 target "ftp://ftp.ams.org/pub/tex/amslatex/"
4078 .These layouts are appropriate, and useful, for any mathematical writing.
4079 There are currently 4 distinct AMS LaTeX layouts:
4082 \begin_layout Enumerate
4083 amsart: The standard AMS-article format.
4084 All results and similar statements are numbered as
4085 \begin_inset Formula $(n.m)$
4088 , where the first number refers to the section, and the second refers to
4089 the total number of results (Theorems, Corollaries, Propositions, Definitions
4090 and Remarks, etc.) in that section.
4091 There are also many (but not all) environments available unnumbered, which
4092 is occasionally needed.
4093 Unnumbered environments indicated by an asterisk at the end.
4096 \begin_layout Enumerate
4097 amsart-seq: Here, numbering for each type of statement is in its own sequence,
4098 with no reference to the section number.
4099 There are also many (but not all) environments available unnumbered, which
4100 is occasionally needed.
4101 Unnumbered environments indicated by an asterisk at the end.
4104 \begin_layout Enumerate
4105 amsart-plain: This one is even more terse, since all the environments are
4109 \begin_layout Enumerate
4110 amsbook: the standard AMS book (really, monograph) format.
4111 Numbering is similar to the amsart layout, except that all numbering is
4113 \begin_inset Formula $(n.m.p)$
4116 , where the first number refers to the chapter, the second to the section,
4117 and the third is the number of the results (Theorems, Corollaries, Propositions
4118 , Definitions and Remarks, etc.) in that section.
4119 There are also many (but not all) environments available unnumbered, which
4120 is occasionally needed.
4121 Unnumbered environments indicated by an asterisk at the end.
4124 \begin_layout Standard
4125 Any AMS LyX file can be converted to either of the numbering schemes by
4126 simply changing the document class in the
4131 ocument\SpecialChar \menuseparator
4142 \begin_layout Subsection
4143 What these layouts provide
4146 \begin_layout Standard
4147 There is a long list of included environments provided by these layouts.
4148 Most mathematical papers or books will set as special statements most of
4149 these environments, in AMS-LaTeX there is an opportunity to define an unlimited
4150 variety of such declarations.
4151 However, the AMS recommends the environments that are available in LyX.
4152 The list of environments (not counting the standard environments such as
4155 sections, bibliography, title, author, date
4160 \begin_layout Description
4161 Theorem This is typically used for the statements of major results.
4163 \begin_inset Quotes eld
4171 \begin_inset Quotes erd
4174 appears in bold type, along with an automatically-determined number (an
4179 , is also available).
4180 The text is italicized.
4183 \begin_layout Description
4184 Corollary This is used for statements which follow fairly directly from
4185 previous statements.
4186 Again, these can be major results.
4194 \begin_layout Description
4195 Lemma These are smaller results needed to prove other statements.
4198 \begin_layout Description
4199 Proposition These are less major results which (hopefully) add to the general
4200 theory being discussed.
4203 \begin_layout Description
4204 Conjecture These are statements provided without justification, which the
4205 author does not know how to prove, but which seem to be true (to the author,
4209 \begin_layout Description
4210 Criterion A required condition.
4213 \begin_layout Description
4214 Algorithm A general procedure to be used.
4217 \begin_layout Description
4218 Axiom This is a property or statement taken as true within the system being
4222 \begin_layout Description
4223 Definition Guess what this is for.
4224 The font, both on-screen and in the output, is different for this environment
4225 than for the previous ones.
4227 \begin_inset Quotes eld
4231 \begin_inset Quotes erd
4234 ) is still set in boldface, along with the number, if any, but the rest
4238 \begin_layout Description
4239 Example Typeset similarly to Definition.
4242 \begin_layout Description
4246 \begin_layout Description
4250 \begin_layout Description
4254 \begin_layout Description
4255 Remark This environment is also a new type of theorem.
4256 This is set with the word Remark in italics, and the rest upright.
4259 \begin_layout Description
4260 Note Set similarly to the Remark environment.
4263 \begin_layout Description
4267 \begin_layout Description
4271 \begin_layout Description
4275 \begin_layout Description
4279 \begin_layout Description
4280 Case Generally, these are used to break up long arguments, using specific
4281 instances of some condition.
4282 The numbering scheme for cases is on its own, not together with other numbered
4287 \begin_layout Description
4291 \begin_layout Description
4295 \begin_layout Description
4297 \begin_inset Quotes eld
4305 \begin_inset Quotes erd
4308 is set in italics, but the rest is set upright.
4309 At the end of this environment (other environments can be nested within
4310 this one, of course) a QED symbol (usually a square, but it can vary with
4311 different styles) is placed.
4314 \begin_layout Description
4315 Address This should be the author's permanent address.
4318 \begin_layout Description
4319 Current\InsetSpace ~
4320 Address This should be the author's temporary address at the time
4321 of submission, if different from the Address.
4324 \begin_layout Description
4325 Email Author's e-mail address
4328 \begin_layout Description
4329 URL Author's Web address, if desired.
4332 \begin_layout Description
4333 Keywords Key words or phrases used to identify specific topics discussed
4337 \begin_layout Description
4338 Subjectclass These refer to the AMS Subject Classifications, published and
4341 Mathematical Reviews
4344 These are also available online at the AMS cites listed above.
4347 \begin_layout Description
4351 \begin_layout Description
4355 \begin_layout Description
4359 \begin_layout Standard
4360 In addition, these environments automatically provide the AMS LaTeX and
4362 They need to be available on your system in order to use these environments.
4365 \begin_layout Section
4369 \begin_layout Standard
4374 can be used to type letters according to German conventions.
4375 A template file is included in
4377 .../lyx/share/templates
4379 for you to use as a starting point.
4382 \begin_layout Section
4386 \begin_layout Standard
4391 provides an alternative to the standard
4396 It provides similar functionality, but you might prefer this layout with
4397 sans serif sections, headings, and more.
4400 \begin_layout Section
4404 \begin_layout Standard
4410 \begin_layout Subsection
4414 \begin_layout Standard
4415 This section describes how LyX can be used to write articles for submission
4416 to the scientific journal
4418 Astronomy and Astrophysics
4421 \begin_inset LatexCommand url
4422 name "www.edpsciences.fr/aa/"
4423 target "http://www.edpsciences.fr/aa/"
4427 ) using Version 5.01 of the document class
4432 This package can be downloaded from the ftp site
4435 \begin_layout Standard
4436 \begin_inset VSpace medskip
4442 \begin_layout Standard
4444 \begin_inset LatexCommand url
4445 target "ftp://ftp.edpsciences.org/pub/aa/readme.html"
4452 \begin_layout Standard
4453 \begin_inset VSpace medskip
4459 \begin_layout Standard
4460 A manual comes together with that package, and this text is not meant to
4461 replace the original manual but merely a short guide how to realize the
4462 correct form of your paper.
4466 \begin_layout Standard
4467 Please note that the publisher of the journal was changed from Springer
4468 to EDP Sciences starting January 1, 2001.
4469 That change implicated also some slight changes of the style files, namely
4470 the removal of the thesaurus command.
4471 The LyX class aa supports the newest version of these style files, V 5.01.
4472 If you have an older version installed, please upgrade.
4473 For compatibility, the old (version 4) layout has been kept as
4478 Please refer to the comments in
4480 LyXDir/layouts/aapaper.layout
4485 \begin_layout Subsection
4489 \begin_layout Standard
4490 It is recommended you start from the example template distributed with LyX.
4491 If you are not using a template, note the following settings:
4494 \begin_layout Itemize
4504 ocument\SpecialChar \menuseparator
4511 dialog (OK, that one was obvious).
4514 \begin_layout Itemize
4515 Don't change the option
4525 The whole layout is done by the macros, you shouldn't change anything.
4528 \begin_layout Subsection
4532 \begin_layout Standard
4533 First thing to enter is the header information.
4534 It consists of seven entries, of which some are optional.
4538 \begin_layout Itemize
4546 \begin_layout Itemize
4554 \begin_layout Itemize
4562 \begin_layout Itemize
4570 \begin_layout Itemize
4575 : [optional] if more than one author: whom to contact for offprint requests.
4578 \begin_layout Itemize
4583 : [optional] mail address for contacts.
4586 \begin_layout Itemize
4594 Received: <date>; Accepted <date>
4597 \begin_layout Standard
4598 There is no need to issue the
4604 command, this is done automatically by LyX when the header is finished.
4605 Although the order of the single header entries doesn't matter it is advised
4606 to keep the above sequence, just to get the best optics and meets the layout
4607 of the real document.
4610 \begin_layout Standard
4611 If you want to place footnotes in the header block, e.\InsetSpace \thinspace{}
4616 \begin_layout Standard
4625 to state your present address, just use the standard footnote via
4630 nsert\SpecialChar \menuseparator
4638 LyX will automagically use the term
4647 \begin_layout Standard
4648 In addition to these topics, the macros use three additional LaTeX commands
4649 that have no counterpart in LyX:
4652 \begin_layout Itemize
4659 to separate different names for more than one author and institute, respectivel
4663 \begin_layout Itemize
4670 to mark corresponding author/institute pairs.
4671 The institutes are numbered sequentially as they appear in the
4675 field, so you have to put a marker to each author.
4678 \begin_layout Itemize
4685 to supply an email address for fast contact.
4688 \begin_layout Standard
4689 In all cases, the appropriate command has to be entered in LyX and marked
4695 \begin_layout Subsection
4699 \begin_layout Standard
4700 The abstract should immediately follow the header block.
4701 With version 5 the abstract environment was changed to a command, and there
4702 is now a resctriction to only one paragraph.
4703 In addition, it should contain an entry with the keywords.
4704 This is not yet implemented for LyX, therefore you have to enter the LaTeX
4711 by hand and mark it as LaTeX code.
4712 Refer to the example paper.
4715 \begin_layout Subsection
4716 Supported environments
4719 \begin_layout Standard
4720 The A&A paper layout supports the following environments for structuring
4724 \begin_layout Itemize
4730 \begin_layout Itemize
4736 \begin_layout Itemize
4742 \begin_layout Itemize
4748 \begin_layout Itemize
4754 \begin_layout Itemize
4760 \begin_layout Itemize
4766 \begin_layout Itemize
4772 \begin_layout Itemize
4778 \begin_layout Itemize
4784 \begin_layout Itemize
4790 \begin_layout Itemize
4796 \begin_layout Subsection
4797 Commands not supported by LyX
4800 \begin_layout Standard
4801 Some commands are not yet supported by the
4806 Some have already been mentioned.
4807 For the sake of completeness, they are listed all together here:
4810 \begin_layout Itemize
4818 \begin_layout Itemize
4826 \begin_layout Itemize
4834 \begin_layout Itemize
4842 \begin_layout Itemize
4850 \begin_layout Itemize
4858 \begin_layout Itemize
4866 \begin_layout Itemize
4874 \begin_layout Standard
4875 If you want to use any of these commands, you have to enter them yourself.
4878 Do not forget to mark them as LaTeX code!
4881 \begin_layout Subsection
4882 Figure and Table Floats
4885 \begin_layout Standard
4886 LyX provides support for the necessary float environments
4888 figure, figure*, table
4894 , therefore we won't tell much about it here.
4901 Just remember that tables should be left-aligned.
4902 For that, select the table and change the alignment in
4907 dit\SpecialChar \menuseparator
4912 aragraph\InsetSpace ~
4916 \begin_layout Standard
4917 There is only one special thing: the figures with caption besides the figure.
4918 To create such a figure, you have to do the following:
4921 \begin_layout Enumerate
4922 Create a wide figure float:
4927 nsert\SpecialChar \menuseparator
4932 t\SpecialChar \menuseparator
4935 , then right click in the figure and select
4946 \begin_layout Enumerate
4947 Enter your caption text.
4950 \begin_layout Enumerate
4955 to move the cursor above the caption.
4958 \begin_layout Enumerate
4962 \begin_layout Enumerate
4963 Position the cursor behind the figure and insert a horizontal fill:
4968 nsert\SpecialChar \menuseparator
4976 \SpecialChar \menuseparator
4979 orizontal\InsetSpace ~
4985 \begin_layout Enumerate
4986 Switch to LaTeX mode:
4994 \begin_layout Enumerate
5004 Do not close the brace!
5007 \begin_layout Enumerate
5008 Position the cursor behind the caption text, switch to LaTeX mode and insert
5021 \begin_layout Standard
5022 Also, refer to the figures in the example paper.
5025 \begin_layout Subsection
5029 \begin_layout Standard
5030 For submission, the paper has to be formated in a special double-spacing
5032 For this purpose, you have to give the option
5036 to the documentclass.
5037 This must be done using the extra class options field in the
5042 ocument\SpecialChar \menuseparator
5050 Just enter the string
5057 \begin_layout Subsection
5061 \begin_layout Standard
5066 directory contains an example paper written with LyX.
5067 It is the example paper from the original macro package, translated to
5069 Use it for inspiration, and compare the original LaTeX code with LyX way
5073 \begin_layout Section
5077 \begin_layout Standard
5083 \begin_layout Subsection
5087 \begin_layout Standard
5088 AASTeX is a set of macros produced by the American Astronomical Society
5089 to facilitate electronic manuscript submission to the three journals they
5090 publish: the Astrophysical Journal (including the Letters and Supplement),
5091 the Astronomical Journal, and the Publications of the Astronomical Society
5093 LyX has proven to be an excellent tool for generating these documents,
5094 especially given its equation, citation, and figure handling capabilities.
5095 LyX requires version 5.0 (or higher) of these macros; preferably 5.2, which
5096 is the version described here, or higher.
5097 Versions prior to 5.0 are intended for use with LaTeX2.09 and are fundamentally
5098 incompatible with LyX.
5099 The AASTeX package may be downloaded from the AASTeX Web site
5102 \begin_layout Standard
5103 \begin_inset VSpace medskip
5109 \begin_layout Standard
5111 \begin_inset LatexCommand url
5112 target "http://www.journals.uchicago.edu/AAS/AASTeX"
5119 \begin_layout Standard
5120 \begin_inset VSpace medskip
5126 \begin_layout Standard
5127 A complete user guide is contained in that package and you should familiarize
5128 yourself with it thoroughly before embarking on writing a paper in LyX.
5129 LyX will not reduce the need to figure out all the AASTeX commands, it
5130 will only reduce the drudgery of typing everything in.
5131 It is your responsibility to ensure that the final exported LaTeX document
5132 conforms completely to the requirements of the journal to which you are
5133 submitting your paper.
5136 \begin_layout Subsection
5137 Starting a New Paper
5140 \begin_layout Standard
5141 I strongly suggest that you start with the AASTeX template file.
5147 ile\SpecialChar \menuseparator
5157 , enter the new file name, then choose the
5162 This will show the most common fields found in a manuscript.
5163 Simply overwrite the existing text (including the brackets,
5167 ) with the correct information.
5168 Many of the AASTeX commands and environments can be implemented directly
5169 in LyX, but some cannot: most noticeably
5181 , which should stick out like a sore thumb if you actually just opened the
5183 For commands such as these, the LaTeX code must be entered directly and
5185 Such commands are referred to as ERT, or Evil Red Text.
5186 I tried to minimize the amount of ERT needed in an AASTeX document, but
5187 there is still a bit more required than any of us would like.
5190 \begin_layout Subsection
5191 Finishing Your Paper
5194 \begin_layout Standard
5195 When the paper is finished to your satisfaction and previews/prints correctly,
5197 \begin_inset Quotes eld
5201 \begin_inset Quotes erd
5204 actions which need to be done before you submit it to the journals.
5208 \begin_layout Enumerate
5209 Export your paper as a LaTeX file (
5214 ile\SpecialChar \menuseparator
5219 xport\SpecialChar \menuseparator
5230 \begin_layout Enumerate
5235 file with your favorite text editor
5239 \begin_layout Enumerate
5240 remove the comment lines before the
5249 \begin_layout Enumerate
5254 usepackage...{fontenc}
5256 line if it appears (usually just after
5271 \begin_layout Enumerate
5272 remove everything between (and including) the
5284 commands, except for any commands you specifically put into the LaTeX preamble
5285 (which should appear immediately after the
5286 \begin_inset Quotes eld
5289 User specified LaTeX commands
5290 \begin_inset Quotes erd
5301 \begin_layout Enumerate
5302 Run the resulting file through LaTeX to make sure it still processes correctly.
5305 \begin_layout Enumerate
5306 Reread the journal requirements to make sure your filenames and formats
5310 \begin_layout Enumerate
5314 \begin_layout Subsection
5315 Comments On Specific Commands
5318 \begin_layout Standard
5319 I will not describe the detailed usage of the individual AASTeX commands:
5320 the AASTeX User Guide (
5324 ) gives a good description of each.
5325 Thus it's probably easiest for me to go down the list as found in the guide
5326 and offer comments where necessary.
5327 So let's begin \SpecialChar \ldots{}
5331 \begin_layout Subsubsection
5332 Things that work as expected
5335 \begin_layout Standard
5339 \begin_layout Standard
5351 \begin_layout Standard
5352 Because they work as you might expect, I simply list them and the section
5453 begin{thebibliography}
5461 (2.13.2), all the cite commands and their variations (2.13.2), the generic
5462 graphicx figure commands (2.14.1),
5486 (2.15.4, amongst other places),
5513 \begin_layout Standard
5514 The following style options also work correctly:
5535 Simply put them in the
5541 Layout\SpecialChar \menuseparator
5547 \begin_layout Standard
5551 \begin_layout Standard
5563 \begin_layout Subsubsection
5564 Things that work, but require more comment
5567 \begin_layout Standard
5568 The following items work, but require a little more discussion:
5571 \begin_layout Itemize
5572 These items are reserved for use by the journal editors, but you can put
5573 them into the LaTeX preamble if you feel compelled to do so:
5606 \begin_layout Itemize
5607 These items may be placed in the LaTeX preamble, and are included as blanks
5608 in the template file:
5629 \begin_layout Itemize
5636 (2.3) -- can only be used
5637 \begin_inset Quotes eld
5641 \begin_inset Quotes erd
5644 , not in the middle of a paragraph.
5645 Use ERT if you need to embed it.
5648 \begin_layout Itemize
5655 (2.3) -- will have extra {} after it.
5656 This should not cause an error.
5659 \begin_layout Itemize
5666 (2.6) -- can only be used
5667 \begin_inset Quotes eld
5671 \begin_inset Quotes erd
5674 , not in the middle of a paragraph.
5675 Use ERT if you need to embed it.
5678 \begin_layout Itemize
5685 (2.8) -- can't insert a cross-reference tag, you must type the tag name
5689 \begin_layout Itemize
5696 (2.8) -- same as for
5703 \begin_layout Itemize
5710 (2.9) -- will have extra {} after it.
5711 This should not cause an error.
5714 \begin_layout Itemize
5721 (2.11) -- will have extra {} after it.
5722 This should not cause an error.
5725 \begin_layout Itemize
5732 (2.14.2) -- you can insert an optional filename argument by placing the cursor
5733 at the beginning of the text and selecting
5735 Insert\SpecialChar \menuseparator
5740 \begin_inset Quotes eld
5744 \begin_inset Quotes erd
5747 inserts an optional argument of the type needed by
5754 Hopefully it will be renamed someday.
5757 \begin_layout Itemize
5770 for the catalog ID optional parameter
5773 \begin_layout Itemize
5786 for the catalog ID optional parameter
5789 \begin_layout Subsubsection
5790 Things not implemented, use ERT
5793 \begin_layout Standard
5797 \begin_layout Standard
5809 \begin_layout Standard
5832 setcounter{equation}
5834 (2.12), Journal name abbreviations (2.13.4),
5870 (2.15.4, insert it as the first element in the lefthand cell after where
5872 Don't use any of LyX's rules in the table),
5884 (2.15.5), much of Misc (2.17, except
5935 \begin_layout Standard
5939 \begin_layout Standard
5951 \begin_layout Subsubsection
5952 Things that cannot be implemented
5955 \begin_layout Standard
5956 \SpecialChar \ldots{}
5957 at least in any meaningful sort of way, so I suggest ignoring them.
5958 They are the references environment (2.13.3), and the deluxetable environment
5960 If you really, really need to use deluxetable, I suggest editing it in
5961 a separate file with a text editor, then using
5966 nsert\SpecialChar \menuseparator
5974 to include it in your LyX document.
5979 file to see an example of this.
5982 \begin_layout Subsection
5983 FAQs, Tips, Tricks, and Other Ruminations
5986 \begin_layout Subsubsection
5987 Getting LyX and AASTeX to cooperate
5990 \begin_layout Standard
5991 It can be a bit tricky to get LyX to recognize a new layout and document
5993 When all else fails, do this:
5996 \begin_layout Enumerate
5997 Make certain that LaTeX can find AASTeX.
5998 Copy sample.tex (and perhaps table.tex) from the AASTeX distribution into
5999 a directory completely unrelated to LaTeX or AASTeX and run LaTeX on
6006 \begin_layout Enumerate
6013 /usr/.../share/lyx/layouts
6022 \begin_layout Enumerate
6028 ools\SpecialChar \menuseparator
6035 in LyX, then restart LyX.
6038 \begin_layout Enumerate
6039 Open a regular new file, not from a template.
6040 Does AASTeX appear in the class list in
6045 ocument\SpecialChar \menuseparator
6055 \begin_layout Standard
6056 If you get a warning from an existing AASTeX document about not being able
6057 to find the AASTeX layout or a message about
6058 \begin_inset Quotes eld
6061 You should not mix title layouts with normal ones
6062 \begin_inset Quotes erd
6065 , things haven't been installed correctly.
6068 \begin_layout Subsubsection
6069 LaTeX error processing a table
6072 \begin_layout Standard
6073 LyX, by default, attempts to center the table caption/title.
6074 This seems to produce a bad interaction in AASTeX so you should click somewhere
6075 in the caption/title, then select
6080 dit\SpecialChar \menuseparator
6085 aragraph\InsetSpace ~
6100 This took care of it for me.
6103 \begin_layout Subsubsection
6105 \begin_inset LatexCommand label
6113 \begin_layout Standard
6114 A couple of things: 1) I have noticed some funny spacing in the reference
6115 entries in the text.
6116 When you enter the bibliography item data, make sure their is
6120 space between the last author and the parenthesis setting off the year;
6123 e.\InsetSpace \thinspace{}
6136 2) Entering the references at all is not obvious.
6137 The easiest thing is to start typing your first reference at the end of
6138 the document, then mark it as type
6143 That will put a small gray box in front of what you just typed.
6144 Click on the box to fill in the rest of the information.
6145 For new references, go to the end of an existing reference and press return.
6146 That will create a new line with its own box, etc.
6149 \begin_layout Subsubsection
6153 \begin_layout Standard
6154 Even though AASTeX provides its own figure commands (
6160 , for example), I much prefer LaTeX's standard figure commands (with the
6169 commands as ERT into a Figure Float box if you desire, but I never
6170 have much luck getting the layout right.
6171 With the standard graphics, LyX will insert a
6175 usepackage{graphicx}
6177 command into the LaTeX preamble and handle the figures in the standard
6178 LaTeX2e way, interspersing the figures in the text.
6179 I believe ApJ accepts figures exactly this way now; AJ might still use
6181 \begin_inset Quotes eld
6184 stack everything at the end
6185 \begin_inset Quotes erd
6191 \begin_layout Subsubsection
6192 Things I could have done, but didn't
6195 \begin_layout Standard
6197 \begin_inset Quotes eld
6201 \begin_inset Quotes erd
6204 things I could have implemented, but chose not to.
6205 For instance, I saw no point in double-spacing the text in the LyX window,
6206 even though it is double-spaced in the paper manuscript.
6207 Also, I chose not to make separate layouts for the preprint and preprint2
6209 Since I assume you will spend most of your time in the plain manuscript
6210 mode anyway, I decided not to chew up more disk space with this.
6214 \begin_layout Subsection
6218 \begin_layout Standard
6219 Your mileage may vary.
6220 I've now had papers published by both ApJ and AJ that have had 98% of the
6221 effort done in LyX; the last 2% was the LaTeX post-processing and a few
6223 I have had no trouble with the submission process, and I'm sure the journals
6224 were never aware that there might be a difference.
6225 So, go forth and publish!
6228 \begin_layout Section
6232 \begin_layout Standard
6235 Panayotis Papasotiriou
6238 \begin_layout Subsection
6242 \begin_layout Standard
6243 The ijmpc package is a set of macros that facilitates electronic manuscript
6246 International Journal of Modern Physics C
6249 Similarly, the ijmpd package is for creating manuscripts to be submitted
6252 International Journal of Modern Physics D
6255 Both journals are published by World Scientific.
6256 The corresponding document classes are named
6265 These files, together with instructions for the authors, can be downloaded
6267 \begin_inset LatexCommand url
6268 target "http://www.worldscinet.com/ijmpc/mkt/guidelines.shtml"
6273 \begin_inset LatexCommand url
6274 target "http://www.worldscinet.com/ijmpd/mkt/guidelines.shtml"
6279 Both packages are modified versions of the standard
6280 \begin_inset Quotes eld
6284 \begin_inset Quotes erd
6287 package, and they are almost (but not exactly) identical.
6288 Most of their features are supported by LyX.
6289 I have used LyX successfully to write articles submitted to both journals
6290 without any problem.
6293 \begin_layout Subsection
6297 \begin_layout Standard
6298 As usual, the easiest way to write a paper is to start with a template.
6304 ile\SpecialChar \menuseparator
6323 This will give an (almost) empty document that includes the most common
6324 fields found in a manuscript.
6325 Simply overwrite the existing text (including the brackets,
6330 You should keep in mind the following remarks.
6333 \begin_layout Enumerate
6334 LyX won't let you change the font size and the page style of the document,
6335 because such modifications are not allowed by both packages.
6338 \begin_layout Enumerate
6339 The language of the document should not be changed.
6340 Before previewing your paper, be sure that the babel package is not used.
6341 To do this, click on
6346 ools\SpecialChar \menuseparator
6364 checkbox in the language settings, and click on
6375 , if you wish to make this change permanent).
6378 \begin_layout Enumerate
6380 \begin_inset Quotes eld
6384 \begin_inset Quotes erd
6387 style must be used to define keywords.
6390 \begin_layout Enumerate
6391 The ijmpc package provides a style named
6392 \begin_inset Quotes eld
6395 Classification Codes
6396 \begin_inset Quotes erd
6399 , which can be used to define classification codes, such as PACS numbers.
6400 Note that this facility is not supported by the ijmpd package.
6403 \begin_layout Enumerate
6404 Several new environments are available:
6405 \begin_inset Quotes eld
6409 \begin_inset Quotes erd
6413 \begin_inset Quotes eld
6417 \begin_inset Quotes erd
6421 \begin_inset Quotes eld
6425 \begin_inset Quotes erd
6429 \begin_inset Quotes eld
6433 \begin_inset Quotes erd
6437 \begin_inset Quotes eld
6441 \begin_inset Quotes erd
6445 \begin_inset Quotes eld
6449 \begin_inset Quotes erd
6453 \begin_inset Quotes eld
6457 \begin_inset Quotes erd
6461 \begin_inset Quotes eld
6465 \begin_inset Quotes erd
6469 \begin_inset Quotes eld
6473 \begin_inset Quotes erd
6477 \begin_inset Quotes eld
6481 \begin_inset Quotes erd
6485 \begin_inset Quotes eld
6489 \begin_inset Quotes erd
6493 \begin_inset Quotes eld
6497 \begin_inset Quotes erd
6501 \begin_inset Quotes eld
6505 \begin_inset Quotes erd
6509 \begin_inset Quotes eld
6513 \begin_inset Quotes erd
6517 Their use is more or less obvious.
6518 LyX supports all these environments; it will use the proper label, text
6519 style, and numbering scheme for each of them.
6522 \begin_layout Enumerate
6523 Both packages use basic citations; the natbib package should not be used.
6524 In LyX, citation references are shown as usual; in the output, citations
6525 are shown as superscripts.
6526 If you want to use a citation as normal text, you should use the
6530 command, e.\InsetSpace \thinspace{}
6532 \begin_inset Quotes eld
6535 See Ref.\InsetSpace ~
6543 \begin_inset Quotes erd
6549 \begin_layout Enumerate
6551 \begin_inset Quotes eld
6555 \begin_inset Quotes erd
6558 section in both packages.
6559 To put acknowledgments, just use the
6560 \begin_inset Quotes eld
6564 \begin_inset Quotes erd
6570 \begin_layout Enumerate
6571 Appendices may be added to the paper,
6575 the Acknowledgments and
6580 LyX provides a special environment, called
6581 \begin_inset Quotes eld
6585 \begin_inset Quotes erd
6588 which marks the beginning of the appendices.
6589 This environment should be left blank; it just sends a LaTeX command, but
6590 nothing is really printed.
6592 \begin_inset Quotes eld
6596 \begin_inset Quotes erd
6599 is printed with blue letters, as a signal that all sections after that
6600 point are appendices.
6601 To write an appendix, use the
6602 \begin_inset Quotes eld
6606 \begin_inset Quotes erd
6610 LyX will number each appendix with capital letters, as required by both
6613 \begin_inset Quotes eld
6617 \begin_inset Quotes erd
6624 be present before the first appendix; if not, all appendices will be numbered
6625 as normal sections in the output.
6628 \begin_layout Enumerate
6629 The ijmpc and the ijmpd packages use the
6633 command to implement table captions.
6634 As a result, a table created by LyX is printed correctly, but its caption
6636 However, you can use some ERT to overpass this problem, so that captions
6637 are printed as expected.
6638 To do so, create a float table as usual, remove the caption, and replace
6649 (sic); you must also the ERT
6653 immediately after the tabular material.
6654 Study the example table included in the template files to see how this
6655 trick is implemented.
6656 Alternatively, If you need table captions, you should implement the whole
6661 file, then include this file to the LyX document (
6666 nsert\SpecialChar \menuseparator
6671 \SpecialChar \menuseparator
6680 Details on how to create a table float can be found in the files
6688 , included in the corresponding packages.
6691 \begin_layout Subsection
6692 Preparing a paper for submission
6695 \begin_layout Standard
6696 Before you submit your paper you must export the LyX document as a LaTeX
6702 ile\SpecialChar \menuseparator
6707 xport\SpecialChar \menuseparator
6722 \begin_layout Standard
6723 Actually you have the choice between LaTeX (plain) and pdflatex.
6724 If you intend to use pdflatex to prepare the paper, you should use the
6725 pdflatex option so that included graphics are converted to PDF format,
6726 ready for use by pdflatex.
6731 , then make the following changes to the resulting
6738 \begin_layout Enumerate
6739 Remove the comment lines before the
6748 \begin_layout Enumerate
6749 Remove everything between (and including) the
6761 commands, except for any commands you specifically put into the LaTeX preamble.
6764 \begin_layout Standard
6769 file should be saved and processed through LaTeX as many times as necessary.
6770 You may also want to check the resulting
6777 \begin_layout Subsection
6781 \begin_layout Standard
6782 The use of ERT is reduced to two commands, which must be placed at the top
6784 If you started writing your paper by using the
6792 template, the ERT needed is already in its place; you usually don't need
6794 You may only modify the first ERT to specify the information printed to
6795 the top of odd and even pages (authors' names and short paper's title,
6797 This ERT must have the form
6801 markboth{Authors' Names}{Short Paper's Title}
6806 \begin_layout Section
6810 \begin_layout Standard
6813 Panayotis Papasotiriou
6816 \begin_layout Subsection
6820 \begin_layout Standard
6821 The Kluwer package is a set of macros produced by Kluwer Academic Publishers
6822 that facilitates electronic manuscript submission to the journals they
6824 Most known of them (at least in my domain of interest) are
6826 Astrophysics and Space Science
6832 , but there are many others (see a complete list at
6833 \begin_inset LatexCommand url
6834 target "http://www.wkap.nl/jrnllist.htm/JRNLHOME"
6839 The Kluwer package may be downloaded from the site
6840 \begin_inset LatexCommand url
6841 target "http://www.wkap.nl/kaphtml.htm/STYLEFILES"
6846 A complete user guide is contained in that package (but it can also be
6847 downloaded separately).
6850 \begin_layout Standard
6851 LyX supports many features of the package but not everything.
6852 However, the ERT needed is reduced to some
6853 \begin_inset Quotes eld
6857 \begin_inset Quotes erd
6860 commands of the package (see\InsetSpace ~
6862 \begin_inset LatexCommand ref
6863 reference "subsec:kluwer_peculiarities"
6868 I have recently used LyX to write an article submitted to the
6870 Astrophysics and Space Science
6872 without any problem.
6875 \begin_layout Subsection
6879 \begin_layout Standard
6880 The easiest way to write a paper is to start with the Kluwer template file.
6883 File\SpecialChar \menuseparator
6898 This will give an (almost) empty document that includes the most common
6899 fields found in a manuscript and a short description of their use.
6900 As in most templates, simply overwrite the existing text (including the
6905 ) with the correct information.
6908 \begin_layout Subsection
6909 Preparing a paper for submission
6912 \begin_layout Standard
6913 As in the AASTeX package, before you submit your paper to a journal you
6915 \begin_inset Quotes eld
6919 \begin_inset Quotes erd
6925 \begin_layout Enumerate
6926 Export your paper as a LaTeX file.
6927 To do this, click on
6932 ile\SpecialChar \menuseparator
6937 xport\SpecialChar \menuseparator
6948 \begin_layout Enumerate
6953 file with a text editor and make the following changes
6957 \begin_layout Enumerate
6958 remove the comment lines before the
6967 \begin_layout Enumerate
6968 remove everything between (and including) the
6980 commands, except for any commands you specifically put into the LaTeX preamble.
6983 \begin_layout Standard
6992 \begin_layout Enumerate
6997 file through LaTeX as many times as necessary (usually up to three).
7000 \begin_layout Enumerate
7005 document using, e.\InsetSpace \thinspace{}
7010 , and check if everything is OK (it should, if you didn't make any mistake).
7013 \begin_layout Subsection
7014 \begin_inset Quotes eld
7018 \begin_inset Quotes erd
7021 of the Kluwer package
7022 \begin_inset LatexCommand label
7023 name "subsec:kluwer_peculiarities"
7030 \begin_layout Standard
7031 The Kluwer package has the following
7032 \begin_inset Quotes eld
7036 \begin_inset Quotes erd
7042 \begin_layout Enumerate
7043 It is possible to write multiple articles in the same LaTeX file
7047 \begin_layout Standard
7048 I can't imagine any good reason to do this.
7054 Each article must be included in the environment
7055 \begin_inset Quotes eld
7059 \begin_inset Quotes erd
7063 Unfortunately, this environment cannot be omitted, even if you write just
7065 Therefore, each article starts with the command
7071 and, obviously, ends with the command
7078 Although this can be implemented in LyX, I didn't included it, since it
7079 looks ugly and can confuse the novice user.
7080 Therefore, you need to enter them directly and mark them as LaTeX code
7082 \begin_inset Quotes eld
7086 \begin_inset Quotes erd
7092 \begin_layout Enumerate
7093 Information given at the beginning of the article (i.e., title, subtitle,
7094 author, institution, running title, running author, abstract and keywords)
7095 must be included in an environment called
7096 \begin_inset Quotes eld
7100 \begin_inset Quotes erd
7104 This is not implemented in LyX, so you must enter title, subtitle etc.\InsetSpace ~
7121 \begin_layout Enumerate
7122 According to the user manual, the label of each bibliography item must be
7146 \begin_layout Standard
7151 template takes care of all these
7152 \begin_inset Quotes eld
7156 \begin_inset Quotes erd
7160 If you start a new paper using this template you don't need to do anything
7165 \begin_layout Enumerate
7166 don't delete the ERT included in the template, and
7169 \begin_layout Enumerate
7170 copy the example bibliography item included in the template and modify it
7171 as necessary to enter new bibliography items.
7174 \begin_layout Section
7178 \begin_layout Standard
7184 \begin_layout Subsection
7188 \begin_layout Standard
7189 The LyX document classes
7191 article (koma-script)
7195 report (koma-script)
7213 correspond to the LaTeX document classes
7229 , resp.\InsetSpace ~
7230 of the Koma-Script family.
7231 They are replacements for the standard document classes
7247 , resp., and fit better to European typography conventions in a number of
7251 \begin_layout Itemize
7252 Standard character size is 11pt in
7254 article (koma-script)
7258 report (koma-script)
7266 letter (koma-script)
7271 \begin_layout Itemize
7272 Headings, labels of the description environment, and a number of elements
7275 letter (koma-script)
7277 document class are set in a bold sans serif font.
7281 \begin_layout Standard
7282 There is a big difference between the bold sans serif old cm fonts and new
7283 ec fonts, especially in the appearance of headings.
7284 In comparison, the ec bold sans serif fonts look a bit thin.
7285 Here the LaTeX package
7293 helps to produce the
7294 \begin_inset Quotes eld
7298 \begin_inset Quotes erd
7301 appearance when using the ec fonts.
7306 The numbering of chapter headings is made in the same way as the numbering
7307 of section headings, that is without the extra line
7308 \begin_inset Quotes eld
7311 Chapter\SpecialChar \ldots{}
7313 \begin_inset Quotes erd
7317 In addition, the appearance of the headings can be modified by using a
7318 number of options (in LyX to be entered in the field
7332 ayout\SpecialChar \menuseparator
7340 A detailed German description of these options can be found in the Koma-Script
7348 \begin_layout Itemize
7349 The main means in the Koma-Script document classes to design the type area
7358 (in LyX to be entered in the extra class options field in the dialog
7363 ocument\SpecialChar \menuseparator
7371 They make a clearer modification of page margins possible as do the options
7377 ocument\SpecialChar \menuseparator
7385 A detailed German description of these and other type area options can
7386 be found in the Koma-Script documentation
7393 \begin_layout Itemize
7394 The LaTeX document classes of the Koma-Script family define a number of
7395 additional commands.
7396 Those part of it which makes sense in LyX is implemented in corresponding
7400 \begin_layout Standard
7401 A detailed German description of the LaTeX document classes of the Koma-Script
7402 family can be found in the Koma-Script documentation
7410 \begin_layout Standard
7411 There is an English translation
7415 , but it is not a complete one.
7420 The following sections describe only those aspects, which are relevant
7424 \begin_layout Subsection
7425 article (koma-script), report (koma-script), and book (koma-script)
7428 \begin_layout Standard
7429 The document classes
7431 article (koma-script)
7435 report (koma-script)
7445 are implemented in the layout files
7458 They contain all the paragraph types of the corresponding standard document
7471 , resp., partly modified, with the exception of the LyX specific
7475 -type, which is replaced by the new
7479 -type having the same functionality.
7484 -Type there is a number of new paragraph types added.
7491 letter (koma-script)
7496 \begin_layout Itemize
7505 : are equivalents to
7513 , resp., additionally inserting an entry in the table of contents.
7522 are not contained in
7524 article (koma-script)
7529 \begin_layout Itemize
7546 , resp., additionally clearing running heads.
7553 article (koma-script)
7559 \begin_layout Standard
7572 report (koma-script)
7574 , but since this is identical to
7578 , is has not been implemented in LyX.
7586 \begin_layout Itemize
7591 : generates a heading directly above the following paragraph in the standard
7592 character size without affecting the structure of the document.
7595 \begin_layout Itemize
7604 are special captions which respect the different space settings needed
7605 for captions placed above or below an element (if you follow strict typographic
7606 rules, you might want to place table captions always above the table).
7607 You can also use the class option
7624 You need at least Koma-Script version 2.8q to use this.
7627 \begin_layout Itemize
7632 : can be used to set a bonmot, e.
7636 \begin_layout Standard
7649 \begin_layout Standard
7658 at the beginning of a chapter.
7659 If you use the optional argument (
7664 nsert\SpecialChar \menuseparator
7668 ), you can insert the dictum's author there.
7669 Dictum and author are separated by a line.
7670 You need at least Koma-Script version 2.8q to use this.
7677 article (koma-script)
7682 \begin_layout Standard
7683 The following types, together with the standard types
7695 , form the title area of the document.
7696 They must be entered ahead of the first
7697 \begin_inset Quotes eld
7701 \begin_inset Quotes erd
7708 \begin_layout Standard
7709 The corresponding LaTeX commands must appear before the
7720 When such a type is used more than once, the latter usage overwrites the
7721 former one, that means, for every type only the latest usage is valid.
7722 The order of the different types however has, like
7734 , no effect on the appearance of the produced document.
7737 \begin_layout Itemize
7742 : produces a centered paragraph above the ordinary title (
7754 ) for the subject of the document.
7757 \begin_layout Itemize
7762 : produces a centered paragraph below the ordinary title (
7774 ) for the publishers' name.
7777 \begin_layout Itemize
7784 report (koma-script)
7790 produces a centered paragraph on its own page behind the title page, or
7793 article (koma-script)
7795 produces a centered paragraph below the ordinary title (
7814 \begin_layout Itemize
7819 : produces a left aligned paragraph above the ordinary title (
7835 ) for a document`s head.
7838 \begin_layout Itemize
7843 : produces in a double-sided print in
7845 report (koma-script)
7851 a left-aligned paragraph at the top of the title page`s back or has no
7852 effect in a single-sided print or in
7854 article (koma-script)
7859 \begin_layout Itemize
7864 : produces in a double-sided print in
7866 report (koma-script)
7872 a left-aligned paragraph at the bottom of the title page`s back or has
7873 no effect in a single-sided print or in
7875 article (koma-script)
7880 \begin_layout Itemize
7885 : produces a special
7886 \begin_inset Quotes eld
7890 \begin_inset Quotes erd
7893 page ahead of the actual document containing a paragraph without special
7897 \begin_layout Standard
7898 The layout files for the document classes
7900 article (koma-script)
7904 report (koma-script)
7915 This is thought of as a place to define your own types.
7920 in your personal layout directory and edit the file!
7923 \begin_layout Subsection
7924 letter (koma-script)
7927 \begin_layout Standard
7931 \begin_layout Standard
7943 \begin_layout Standard
7947 letter (koma-script)
7949 is implemented in the layout file
7954 It contains all the paragraph types of the corresponding standard document
7959 , partly modified, with the exception of the LyX specific types
7971 type, which is replaced by the new
7976 In addition, it contains, in contrast to the standard document class, the
7994 Furthermore, there are a number of new letter specific types.
7997 \begin_layout Standard
8001 \begin_layout Standard
8013 \begin_layout Standard
8014 The appearance of the letter produced by this document class can be controlled
8015 by a number of LaTeX commands, which you can put in the LaTeX preamble.
8019 \begin_layout Standard
8020 For example, the standard appearance of the letter`s heading, consisting
8021 of name and address, is quite self-willed.
8023 \begin_inset Quotes eld
8027 \begin_inset Quotes erd
8030 heading is produced by the following LaTeX commands in the preamble:
8033 \begin_layout LyX-Code
8043 \begin_layout LyX-Code
8059 \begin_layout LyX-Code
8069 \begin_layout LyX-Code
8089 A detailed German description of such LaTeX commands can be found in the
8090 Koma-Script documentation
8095 With it, the letter's author can produce his personal letter layout.
8098 \begin_layout Standard
8107 define the beginning of the letter and must be used in every letter.
8108 To emphasize them in the LyX document class, they are marked with the letter
8117 , resp.\InsetSpace ~
8119 It is possible to write any number of letters in one file.
8124 type produces a new letter using the same addressee and a
8128 type produces a new addressee.
8145 are ordinary paragraph types and can also be used several times in one
8146 and the same letter.
8149 \begin_layout Itemize
8154 : produces a paragraph for the addressee and implicitly defines the beginning
8158 \begin_layout Itemize
8163 : produces a paragraph for the form of address and implicitly produces a
8167 \begin_layout Itemize
8172 : produces a paragraph for a close.
8175 \begin_layout Itemize
8180 : produces a paragraph for a postscript.
8183 \begin_layout Itemize
8188 : produces a paragraph for a distribution list.
8191 \begin_layout Itemize
8196 : produces a paragraph for enclosures.
8199 \begin_layout Standard
8240 are input types provided with a label to enter information, which will
8241 be processed by the document class.
8245 \begin_layout Standard
8246 It could be seen as a matter of inconsequence, that the types
8254 described above are not such input types as well.
8255 Because of the special meaning of those types, however, I have implemented
8256 them as ordinary paragraph types with a one letter mark in the left margin.
8257 Moreover, it would affect my feeling of symmetry, if the
8265 type had such a serious different appearance.
8270 The types must be used ahead of the corresponding
8277 \begin_layout Standard
8278 An implementation of these types in a WYSIWYG fashion does not seem to make
8279 sense, because the real appearance of the produced letter does not only
8280 depend on the usage of the particular type, but also on other factors.
8281 For example, a signature entered in the
8285 type will in the standard behavior appear in the produced letter only,
8286 when in the same letter also a
8291 The entered value of the
8295 type will in the standard behavior not appear in the produced letter at
8297 The possibility to design the letter`s heading freely is already indicated
8298 in a footnote above.
8301 \begin_layout Standard
8302 The input types can also be used as empty paragraphs.
8303 This makes sense e.\InsetSpace \thinspace{}
8314 type is not used at all, in the standard behavior the value of the
8318 type is used as signature, whereas if an empty
8322 type is used, no signature value is defined.
8325 \begin_layout Standard
8326 By using the input types it is possible to write a letter template, containing
8327 filled input types with your personal dates (name, address, etc.) and empty
8328 input types for other dates you want to enter.
8331 \begin_layout Itemize
8336 : sender's name, in the standard behavior appears as a centered paragraph
8337 in small caps in the letter`s heading.
8340 \begin_layout Itemize
8345 : sender's signature, in the standard behavior appears below the
8354 type is used, the value of the
8358 type appears instead.
8361 \begin_layout Itemize
8366 : sender's address, in the standard behavior appears in a centered paragraph
8367 in the letter`s heading below the sender's name.
8370 \begin_layout Itemize
8375 : sender's telephone number, in the standard behavior only sets the LaTeX
8385 \begin_layout Itemize
8390 : place of the letter`s making.
8393 \begin_layout Itemize
8398 : date of the letter`s making.
8407 , in the standard behavior, produce the place and the date in a right-aligned
8408 line below the addressee's field.
8413 type is used, neither place nor date appear, independent of the value of
8423 type is used, the date of the letter `s production is used.
8426 \begin_layout Itemize
8431 : sender`s back address, in the standard behavior appears above the addressee's
8432 field in a small sans serif font.
8435 \begin_layout Itemize
8440 : special mail information, in the standard behavior appears underlined
8441 above the addressee's field below the back address.
8444 \begin_layout Itemize
8449 : additional information, in the standard behavior appears on right side
8450 below the addressee`s field.
8453 \begin_layout Itemize
8458 : the letter's title, in the standard behavior appears in a big, bold, sans
8459 serif font above the subject.
8462 \begin_layout Itemize
8467 : the letter's subject, in the standard behavior appears in a bold font
8475 \begin_layout Standard
8496 produce a business letter like line above the
8500 line containing the fields
8501 \begin_inset Quotes eld
8505 \begin_inset Quotes erd
8509 \begin_inset Quotes eld
8513 \begin_inset Quotes erd
8517 \begin_inset Quotes eld
8521 \begin_inset Quotes erd
8525 \begin_inset Quotes eld
8529 \begin_inset Quotes erd
8533 \begin_inset Quotes eld
8537 \begin_inset Quotes erd
8541 \begin_inset Quotes eld
8545 \begin_inset Quotes erd
8549 For the date field, the value of the
8555 \begin_inset Quotes eld
8558 business letter types
8559 \begin_inset Quotes erd
8562 is used, the value of the
8566 type however does not appear, but only the LaTeX variable
8573 The ordinary output of place and date in a right-aligned line below the
8574 addressee`s field is suppressed.
8575 The types are implemented as input types provided with a label and must
8576 be used ahead of the corresponding
8583 \begin_layout Itemize
8591 \begin_layout Itemize
8599 \begin_layout Itemize
8607 \begin_layout Itemize
8615 \begin_layout Itemize
8623 \begin_layout Subsection
8624 The new letter class: letter (koma-script v.2)
8627 \begin_layout Standard
8630 Jürgen Spitzmüller
8633 \begin_layout Standard
8634 \begin_inset VSpace medskip
8640 \begin_layout Standard
8642 Koma-Script version 2.8 has introduced a new letter class
8646 which supersedes the now unsupported
8651 It has --- on the LaTeX side --- a completely new interface and is not
8652 compatible with the old class.
8653 Therefore, LyX supports both, though it is recommended to use the new class.
8656 \begin_layout Standard
8657 This class covers the same functionality as
8659 letter (koma-script),
8666 (receiver's address, same as
8683 will start a new letter (i.
8687 \begin_layout Standard
8700 \begin_layout Standard
8709 you can write several letters per document).
8710 New elements are sender's
8726 and the possibility to use a
8735 nsert\SpecialChar \menuseparator
8745 \begin_layout Standard
8746 The biggest improvement is, though, that the letter's layout is configurable
8747 at almost any needs.
8748 This can be done via the preamble or with a special style file (Letter
8749 Class Option, extension
8753 ), that will be read in as a class option.
8757 \begin_layout Standard
8758 The KOMA package comes with some default
8763 There is, for instance, a
8767 file that follows german typesetting rules, or a
8771 that provides the default layout of the old
8776 The latter can be loaded with the class option
8785 ayout\SpecialChar \menuseparator
8790 ocument\SpecialChar \menuseparator
8802 template that is included in LyX for examples.
8803 A detailed description is to be found in the Koma-Script documentation
8811 \begin_layout Subsection
8815 \begin_layout Standard
8816 Visualizing the Koma-Script document classes in LyX, the LyX internals cause
8820 \begin_layout Itemize
8821 The chapter number of a
8825 type appears on a line of its own above the chapter heading instead of
8826 appearing in the same line ahead of it.
8827 The cause for that is the LyX internal behavior for the labeltype
8834 \begin_layout Itemize
8835 The headings of the types
8844 \begin_inset Quotes eld
8848 \begin_inset Quotes erd
8851 LaTeX table of contents, but not in the LyX table of contents (
8856 ocument\SpecialChar \menuseparator
8868 \begin_layout Itemize
8873 document class appear in a skip separation mode, not indented.
8874 This is the standard behavior, no special LaTeX commands are needed for
8881 ocument\SpecialChar \menuseparator
8888 dialog the corresponding radio button indicates
8904 value always has the effect that extra LaTeX commands are inserted in the
8905 document to produce the gap, which is not what is wanted in this case.
8908 \begin_layout Section
8916 \begin_layout Standard
8922 \begin_layout Subsection
8926 \begin_layout Standard
8927 These are the layout files for some of the journal formats used by Springer
8928 Verlag and listed on
8929 \begin_inset LatexCommand url
8930 target "http://www.springer.de/author/tex/help-journals.html"
8934 , where you should also go to fetch the class files (yes, these are LaTeX2e
8936 It is a modular system: the things common to all journals are implemented
8941 , which journal-specific layout files (such as, e.\InsetSpace \thinspace{}
8946 for Journal of Geodesy) can include.
8949 \begin_layout Standard
8950 This means that implementing support for any other Springer journal on this
8951 list is as simple as writing your own
8959 file following the outline given in
8967 \begin_layout Standard
8968 It is reasonably well tested only for the Journal of Geodesy.
8977 come with the standard LyX distribution.
8978 Install the relevant class file (downloaded from Springer) in a proper
8979 directory, reconfigure LaTeX (in the teTeX case by running
8983 , as root if necessary --- doesn't LyX take care of this?), reconfigure
8984 LyX and it should work.
8987 \begin_layout Subsection
8991 \begin_layout Standard
8992 A large number of theorem-like styles ---
8998 \SpecialChar \ldots{}
9004 \begin_layout Standard
9007 Headnote, Dedication, Subtitle, Running_LaTeX_Title, Author_Running, Institute,
9008 Mail, Offprints, Keywords, Acknowledgements, Acknowledgement
9011 See the Springer class file documentation for details.
9014 \begin_layout Subsection
9018 \begin_layout Itemize
9030 \begin_layout Itemize
9033 Probability Theory and Related Fields
9039 --- Jean-Marc Lasgouttes
9042 \begin_layout Standard
9043 Add your own, it isn't so hard!
9046 \begin_layout Subsection
9050 \begin_layout Standard
9051 These files are partly based on the older
9055 , which was again based on a tinkered-with version of an old LaTeX 2.09 style
9061 layout, are now defunct.
9062 Jean-Marc Lasgouttes helped out big in making me find my way around the
9063 LyX layout file mechanism.
9066 \begin_layout Subsection
9070 \begin_layout Standard
9072 But probably less than in the old hacked-LaTeX
9079 \begin_layout Standard
9080 Limitations e.\InsetSpace \thinspace{}
9081 g.: does not display the number for theorem-like layouts, just
9085 \begin_layout Section
9093 \begin_layout Standard
9099 \begin_layout Subsection
9103 \begin_layout Standard
9104 These are the layout files for some of the journals of the American Geophysical
9106 It is assumed that you have both the AGU's own class files and AGUplus
9107 installed (everything to be found at
9108 \begin_inset LatexCommand url
9109 target "ftp://ftp.agu.org/journals/latex/journals"
9116 \begin_layout Subsection
9120 \begin_layout Standard
9130 They are still called this in the LyX GUI, though their LaTeX equivalents
9131 in the AGU classes are
9142 \begin_layout Standard
9143 Newly defined styles are
9180 These are mostly manuscript attributes and defined in the AGU class documentati
9184 \begin_layout Standard
9185 I suspect this is still badly incomplete.
9188 \begin_layout Subsection
9192 \begin_layout Standard
9209 \begin_layout Subsection
9213 \begin_layout Itemize
9216 Journal of Geophysical Research
9225 \begin_layout Standard
9226 Add your own, it isn't so hard! Look at the
9237 \begin_layout Subsection
9238 Bugs and things to remember
9241 \begin_layout Standard
9242 In order to use the new layouts, you must remember to do the following for
9246 \begin_layout Enumerate
9252 This can be done in the
9254 layout\SpecialChar \menuseparator
9259 document\SpecialChar \menuseparator
9263 (AGU articles are always in English, right? So
9270 \begin_layout Enumerate
9280 (Yes, this is a bug.)
9283 \begin_layout Enumerate
9284 Make sure you use the
9288 bibliography style, by entering
9292 into the second field of the BibTeX inset.
9293 None of the standard styles will do.
9296 \begin_layout Section
9304 \begin_layout Standard
9310 \begin_layout Subsection
9314 \begin_layout Standard
9315 This is the layout file for the European Geophysical Society journals.
9320 can be downloaded from the web site of the EGS under
9321 \begin_inset LatexCommand url
9322 target "www.copernicus.org"
9329 \begin_layout Subsection
9333 \begin_layout Standard
9336 Right_address, Latex_Title, Affil, Journal, msnumber, FirstAuthor, Received,
9344 The current layout file is unfortunately very unmodular and would benefit
9345 from using the various
9352 \begin_layout Section
9358 \begin_inset LatexCommand label
9366 \begin_layout Standard
9374 \begin_layout Subsection
9378 \begin_layout Standard
9379 This section describes how to use LyX to make slides for overhead projectors.
9380 There are two document classes that can do this: the default slides class
9386 This section documents the former.
9389 \begin_layout Standard
9390 I'm going to say this again, nice and clear, so that there's no misunderstanding
9394 \begin_layout Standard
9395 \begin_inset VSpace bigskip
9401 \begin_layout Standard
9405 This section documents the class
9406 \begin_inset Quotes eld
9414 \begin_inset Quotes erd
9422 \begin_layout Standard
9423 \begin_inset VSpace bigskip
9429 \begin_layout Standard
9430 If you're looking for the documentation for
9431 \begin_inset Quotes eld
9439 \begin_inset Quotes erd
9442 , check out section\InsetSpace ~
9444 \begin_inset LatexCommand ref
9445 reference "sec:foiltex"
9455 \begin_inset Quotes eld
9463 \begin_inset Quotes erd
9466 ] is actually somewhat better than the default
9474 \begin_layout Standard
9475 \SpecialChar \ldots{}
9476 or so I've been told repeatedly by its advocates.
9477 Having never used it, I have no idea if this claim is true or not.
9482 which this section documents.
9485 \begin_layout Standard
9486 This class is the LaTeX2e improvement of the old
9491 Every LaTeX2e distribution includes this class [which I'll just refer to
9493 \begin_inset Quotes eld
9501 \begin_inset Quotes erd
9504 from now on], so you're bound to have it.
9505 As I noted earlier, there are other classes, such as
9509 , which also produce slides for overhead projectors and do a better job
9511 However, there are some things which
9515 can do which the others can't, such as generate overlays.
9516 Read on to learn more!
9519 \begin_layout Subsection
9521 \begin_inset LatexCommand label
9522 name "sec:slidesetup"
9529 \begin_layout Standard
9530 Obviously, to use this document class, you need to select
9531 \begin_inset Quotes eld
9539 \begin_inset Quotes erd
9542 from the class list in the
9547 ocument\SpecialChar \menuseparator
9555 There are some other special things you should know about this class:
9558 \begin_layout Itemize
9559 Don't bother changing the options
9564 They're not supported by the
9571 \begin_layout Itemize
9580 behaves a bit differently for this class.
9581 The possible choices and what they do are as follows:
9585 \begin_layout Description
9590 The final output contains page numbers in the lower right corner.
9593 \begin_layout Description
9602 , but also prints out any time markers you've put in.
9603 This is the default.
9606 \begin_layout Description
9611 The final output contains no page numbers, time markers, or alignment markers.
9615 \begin_layout Itemize
9620 class has an extra option:
9626 \begin_inset Quotes eld
9634 \begin_inset Quotes erd
9637 in the extra class options.
9641 \begin_layout Standard
9642 Using this options allows you to add time markers to
9647 See section\InsetSpace ~
9649 \begin_inset LatexCommand ref
9650 reference "sec:slideNote"
9658 \begin_layout Standard
9659 You can also use the template file
9660 \begin_inset Quotes eld
9668 \begin_inset Quotes erd
9671 to automatically set up a document to use the
9680 ile\SpecialChar \menuseparator
9689 to open your new document].
9690 The template file also contains some examples of the special paragraph
9691 environments used by this class.
9692 I'll describe those next.
9695 \begin_layout Subsection
9696 Paragraph Environments
9699 \begin_layout Subsubsection
9700 Supported Environments
9703 \begin_layout Standard
9704 The first thing you'll notice when you start up a new
9708 document is the font size and type: it's the equivalent of the size
9709 \begin_inset Quotes eld
9717 \begin_inset Quotes erd
9726 This is also what's used in the output.
9728 \begin_inset Quotes eld
9732 \begin_inset Quotes erd
9735 to remind you that this is a slide.
9736 Your final slides will use a larger font; ergo, you'll have less space.
9737 Of course, the larger default screen font isn't WYSIWYG, only a reminder.
9740 \begin_layout Standard
9741 The next thing that becomes obvious is the changes to the paragraph environment
9742 pull-down box [at the far-left end of the toolbar].
9743 Most of the paragraph environments you're used to seeing are missing.
9744 There are also five new ones.
9749 class itself only supports certain paragraph environments:
9752 \begin_layout Itemize
9758 \begin_layout Itemize
9764 \begin_layout Itemize
9770 \begin_layout Itemize
9776 \begin_layout Itemize
9782 \begin_layout Itemize
9788 \begin_layout Itemize
9794 \begin_layout Itemize
9800 \begin_layout Itemize
9806 \begin_layout Itemize
9812 \begin_layout Itemize
9818 \begin_layout Standard
9819 All of the other standard environments, including the section-heading environmen
9820 ts, aren't used in the
9827 \begin_layout Standard
9828 On the other hand, you'll notice the following new environments:
9831 \begin_layout Itemize
9837 \begin_layout Itemize
9843 \begin_layout Itemize
9849 \begin_layout Itemize
9855 \begin_layout Itemize
9861 \begin_layout Standard
9862 These five are kind of quirky, due to a
9863 \begin_inset Quotes eld
9867 \begin_inset Quotes erd
9871 You see, LyX doesn't permit you to nest any other paragraph environment
9872 into an empty environment.
9873 Now, that's fine and dandy, but it means that you wouldn't be able to start
9874 a slide with anything except plain text.
9875 To deal with this, I've performed a little
9876 \begin_inset Quotes eld
9880 \begin_inset Quotes erd
9886 \begin_layout Subsubsection
9887 Quirks of the New Environments
9888 \begin_inset LatexCommand label
9889 name "sec:slideQuirk"
9896 \begin_layout Standard
9897 All five of the new paragraph environments are somewhat quirky due to inherent
9898 limitiations in the current version of LyX.
9899 As I just mentioned, LyX forbids environments that begin with another environme
9901 To get around this, the
9905 environment isn't a paragraph environment as described in the
9913 \begin_layout Standard
9927 \begin_inset Quotes eld
9930 pseudo-environments.
9931 \begin_inset Quotes erd
9934 They look like a section heading or a
9935 \begin_inset Quotes eld
9943 \begin_inset Quotes erd
9946 but really begin a [and, if necessary, end the previous] paragraph environment.
9956 \begin_inset Quotes eld
9960 \begin_inset Quotes erd
9963 These two perform some action.
9966 \begin_layout Standard
9967 A common feature of all five environments,
9987 , is a rather long-ish label.
9988 The text following this label --- ordinarily the contents of the paragraph
9989 environment --- is utterly irrelevant for
10010 LyX completely ignores it.
10011 In fact, you can leave these five environments completely empty.
10015 \begin_layout Standard
10020 to put any text after the rather long-ish label, you might want to.
10021 This could be a short description of the contents of the
10026 In that case, enter in your descriptive comment and hit
10030 as you normally would.
10033 \begin_layout Standard
10034 If, on the other hand, you don't want to enter in any descriptive text,
10035 you'll hit another LyX quirk.
10036 LyX, like nature, abhors a vacuum, and will not let you start a new paragraph
10037 environment until you put something in the old one.
10041 \begin_layout Itemize
10042 Start entering the text that will
10070 \begin_layout Itemize
10071 Now move to the beginning of that paragraph.
10075 \begin_layout Itemize
10084 \begin_layout Itemize
10085 Finally, change this new, empty paragraph to a
10109 \begin_layout Standard
10110 Some future version of LyX will, hopefully, resolve this quirkiness\SpecialChar \ldots{}
10114 \begin_layout Subsection
10115 Making a Presentation with
10128 \begin_layout Subsubsection
10136 \begin_layout Standard
10137 If you're expecting this section to teach you how to actually make a presentatio
10138 n, you'll be sorely disappointed.
10139 Naturally, I'll describe all of the ways the
10143 class can assist you in preparing the materials for a presentation.
10144 Filling in the contents, however, is up to you.
10149 the LyX philosophy.]
10152 \begin_layout Standard
10157 environment [in the manner described in section\InsetSpace ~
10159 \begin_inset LatexCommand ref
10160 reference "sec:slideQuirk"
10164 ] tells LyX to begin a new slide [duh].
10165 The label for this environment/
10166 \begin_inset Quotes erd
10170 \begin_inset Quotes erd
10174 \begin_inset Quotes eld
10178 \begin_inset Quotes erd
10181 in cool blue, followed by the label,
10182 \begin_inset Quotes eld
10186 \begin_inset Quotes erd
10190 Any text or paragraph environments that follow this one go on the new slide.
10194 \begin_layout Standard
10195 Slides are probably the only time you'll need to forcibly end pages in LyX
10196 (this can be specified in the
10201 In fact, you'll want to, once you finish entering the contents of one slide.
10202 If you've entered more text than can physically fit on a slide, the extra
10203 overflows onto a new slide.
10204 I don't recommend doing this, however, since the overflow slide won't have
10205 any page number on it.
10206 Furthermore, it may interfere with any
10210 you've made to accompany the oversized
10217 \begin_layout Standard
10226 environments work the same way as the
10231 They both create an
10232 \begin_inset Quotes eld
10236 \begin_inset Quotes erd
10239 followed by a label [
10240 \begin_inset Quotes eld
10244 \begin_inset Quotes erd
10248 \begin_inset Quotes eld
10252 \begin_inset Quotes erd
10256 The color is a stunning magenta instead of blue, and the
10257 \begin_inset Quotes eld
10261 \begin_inset Quotes erd
10264 will look different, in style and in length.
10265 The label fonts of all three also differ from one another.
10268 \begin_layout Standard
10273 , if the contents of a
10281 exceed the physical size of a slide or sheet of paper, the extra will overflow
10283 Again, you should avoid this.
10284 It defeats the whole purpose of
10295 \begin_layout Subsubsection
10305 \begin_layout Standard
10310 is a slide that sits atop another slide.
10311 Perhaps you wish to discuss a figure on the main
10315 before displaying the text associated with it.
10316 One way to accomplish this is tape a flap of dark paper over the part of
10321 you want to display later.
10322 This method fails, however, if you wish to overlap one graph with another,
10324 You would then have to fumble while speaking to align the two separate,
10329 s to align the two graphs.
10334 environment in both cases makes life much easier.
10337 \begin_layout Standard
10342 receives the page number of its
10343 \begin_inset Quotes eld
10347 \begin_inset Quotes erd
10355 \begin_inset Quotes eld
10363 \begin_inset Quotes erd
10370 \begin_layout Standard
10371 Presumably, mutliple
10376 \begin_inset Quotes eld
10384 \begin_inset Quotes erd
10388 \begin_inset Quotes eld
10396 \begin_inset Quotes erd
10400 \begin_inset Quotes eld
10408 \begin_inset Quotes erd
10411 , etc.\InsetSpace ~
10412 appended to the page number of the parent
10422 Clearly, you want the contents of both the
10430 to each fit on a single physical slide! You should probably consider an
10436 \begin_inset Quotes eld
10440 \begin_inset Quotes erd
10452 class provides a visual cue for this: the label at the start of an
10456 is shorter than that at the start of a
10461 Lastly, when you generate printable output, you'll find alignment markers
10462 in all four corners of both the
10466 page and its parent
10471 These will assist you in lining up the two physical slides.
10474 \begin_layout Standard
10475 The major problem in overlaying two slides is aligning the contents of the
10476 two transparencies.
10477 How much space should you leave for that graph on the second slide? Worse
10478 still, what if you want a graph and a sentence on second slide, but there
10479 is text on the main transparency that goes in between them? You could try
10480 and insert vertical space of the right size.
10481 The better way is to use
10492 \begin_layout Standard
10493 As their names imply,
10501 are two command-like paragraph environments that make all subsequent text
10502 invisible and visible, respectively.
10503 Note from section\InsetSpace ~
10505 \begin_inset LatexCommand ref
10506 reference "sec:slideQuirk"
10510 that you don't place anything
10514 these two environments, however.
10519 , it inserts a centered, sky-blue label into the page reading
10520 \begin_inset Quotes eld
10523 <Invisible Text Follows>
10524 \begin_inset Quotes erd
10528 For paragraphs following this label, the parts of the
10536 ; it doesn't matter which] where they would be contain instead blank space.
10540 \begin_layout Standard
10545 , the corresponding centered label is
10546 \begin_inset Quotes eld
10549 <Visible Text Follows>
10550 \begin_inset Quotes erd
10554 Paragraphs following this label behave normally.
10555 Note that the beginning of a new
10567 automatically shuts off an
10572 It's therefore not necessary to use
10583 \begin_layout Standard
10584 By now, it should be obvious how to create overlay transparencies using
10585 the proper combination of
10604 \begin_layout Enumerate
10609 , including everything that will appear on it, whether on the main slide
10617 \begin_layout Enumerate
10618 Before each figure or paragraph that will appear only on the
10627 If necessary, insert a
10631 environment after the
10638 \begin_layout Enumerate
10643 immediately following the
10650 \begin_layout Enumerate
10651 Copy the contents of this
10662 \begin_layout Enumerate
10667 , change all of the
10678 \begin_layout Standard
10680 You've just made an
10687 \begin_layout Standard
10688 There's one problem with the way I've designed the LyX
10692 class: you can't make text in the middle of a paragraph invisible, nor
10693 make text in the middle of an invisible paragraph visible again.
10694 To accomplish this feat, you'll need to use some inlined LaTeX codes.
10698 \begin_layout Standard
10699 The commands of interest are:
10702 \begin_layout Itemize
10707 invisible \SpecialChar \ldots{}
10711 \begin_layout Itemize
10716 visible \SpecialChar \ldots{}
10720 \begin_layout Standard
10721 \SpecialChar \ldots{}
10722 and need to be marked as TeX.
10724 \begin_inset Quotes eld
10728 \begin_inset Quotes erd
10731 you wish to change goes in between the brackets [and after the
10744 If you don't know how to mark text as TeX, see the appropriate section
10757 \begin_layout Subsubsection
10767 \begin_inset LatexCommand label
10768 name "sec:slideNote"
10775 \begin_layout Standard
10784 is associated with a
10785 \begin_inset Quotes eld
10789 \begin_inset Quotes erd
10801 class provides visual cues.
10806 is shorter than that of a
10810 [yet longer than that of an
10814 ] and, like the label of an
10818 is shockingly magenta.
10819 Additionally, the printed
10823 has the page number of its
10824 \begin_inset Quotes eld
10828 \begin_inset Quotes erd
10836 \begin_inset Quotes eld
10844 \begin_inset Quotes erd
10848 \begin_inset Quotes eld
10856 \begin_inset Quotes erd
10860 \begin_inset Quotes eld
10868 \begin_inset Quotes erd
10872 You can have multiple
10876 s associated with a single
10888 , you'll probably want to break up long
10892 s so that they fit on a single sheet of paper.
10895 \begin_layout Standard
10900 is obvious: it contains anything additional you might want to say about
10906 It could also be used as a sheet of reminders for a particular
10911 In the case of the latter, you might want to make use of time markers.
10917 \begin_inset Quotes eld
10921 \begin_inset Quotes erd
10924 support for time markers, a
10929 So, you'll have to resort to using the LaTeX codes.
10932 \begin_layout Standard
10933 To use time markers, you'll need to specify the extra class option
10934 \begin_inset Quotes eld
10942 \begin_inset Quotes erd
10945 [see section\InsetSpace ~
10947 \begin_inset LatexCommand ref
10948 reference "sec:slidesetup"
10953 This option turns on timing marks, which will appear in the lower-left-hand
10959 To set what appears in the time marker, you use the LaTeX commands
10960 \begin_inset Quotes eld
10970 \begin_inset Quotes erd
10974 \begin_inset Quotes eld
10984 \begin_inset Quotes erd
10988 The arguments of both commands are time measured in seconds.
10990 \begin_inset Quotes eld
11000 \begin_inset Quotes erd
11003 sets the time marker to a given time.
11005 \begin_inset Quotes eld
11015 \begin_inset Quotes erd
11018 increments the time marker by the specified amount.
11019 Using time markers and
11023 s in this fashion, you can remind yourself how much time to spend on a particula
11031 \begin_layout Standard
11032 There's one last feature to describe.
11033 Clearly, you'd like to print out all of your
11041 s on transparencies while printing all of your
11058 with which it is associated.
11059 What's a person to do?
11062 \begin_layout Standard
11063 Luckily, there are two LaTeX commands that allow you to select what to print
11065 Both must be placed into the preamble of your document.
11067 \begin_inset Quotes eld
11079 \begin_inset Quotes erd
11082 will cause the output to contain only the
11091 Correspondingly, the command
11092 \begin_inset Quotes eld
11104 \begin_inset Quotes erd
11107 prevents the output of anything but
11112 I'd advise placing both commands in the preamble and initially comment
11114 You can then preview your entire presentation as you write.
11115 When you're done writing, you can then uncomment one of the two to select
11116 what you want to print.
11117 I like to uncomment
11118 \begin_inset Quotes eld
11130 \begin_inset Quotes erd
11133 , print to a file with
11134 \begin_inset Quotes eld
11142 \begin_inset Quotes erd
11145 in its name, comment it back out, then uncomment
11146 \begin_inset Quotes eld
11158 \begin_inset Quotes erd
11162 \begin_inset Quotes eld
11170 \begin_inset Quotes erd
11174 I can then send either file to a printer, loading transparencies or plain
11175 paper as appropriate.
11178 \begin_layout Standard
11179 You can also provide other arguments to the
11180 \begin_inset Quotes eld
11190 \begin_inset Quotes erd
11194 \begin_inset Quotes eld
11204 \begin_inset Quotes erd
11208 See a good LaTeX book for details.
11211 \begin_layout Subsection
11216 Class Template File
11219 \begin_layout Standard
11220 I have also provided a template file,
11221 \begin_inset Quotes eld
11229 \begin_inset Quotes erd
11237 To use it, begin your new presentation with
11242 ile\SpecialChar \menuseparator
11252 Your new LyX presentation file will contain an example
11273 additionally contain an example of the use of
11282 Lastly, the preamble will contain:
11285 \begin_layout LyX-Code
11286 % Uncomment to print out only slides and overlays
11289 \begin_layout LyX-Code
11293 \begin_layout LyX-Code
11303 \begin_layout LyX-Code
11304 % Uncomment to print out only notes
11307 \begin_layout LyX-Code
11311 \begin_layout LyX-Code
11319 \begin_layout Standard
11320 One final thing: I created this class to support the LaTeX2e
11321 \begin_inset Quotes eld
11329 \begin_inset Quotes erd
11332 class, one of the built-in LaTeX2e classes.
11333 Neither I nor the rest of the LyX Team endorse or oppose the use of this
11334 built-in slide class.
11335 It's here if you want it or need it.
11336 There exist other LaTeX2e classes for creating presentations, such as the
11341 class [see section\InsetSpace ~
11343 \begin_inset LatexCommand ref
11344 reference "sec:foiltex"
11349 \begin_inset Quotes eld
11357 \begin_inset Quotes erd
11360 package [present on some TeX distributions].
11361 The latter is not yet supported under LyX.
11365 \begin_layout Standard
11366 Perhaps you can take on the task\SpecialChar \ldots{}
11372 I know nothing about these other classes.
11373 Try them out to see what sort of alternative they provide.
11376 \begin_layout Section
11385 \begin_inset LatexCommand label
11393 \begin_layout Standard
11399 \begin_layout Subsection
11403 \begin_layout Standard
11404 This section describes how to use LyX to make slides for overhead projectors.
11405 There are two document classes that can do this: the default slides class
11411 This section documents the latter.
11414 \begin_layout Standard
11415 I'm going to say this again, nice and clear, so that there's no misunderstanding
11419 \begin_layout Standard
11420 \begin_inset VSpace bigskip
11426 \begin_layout Standard
11430 This section documents the class
11431 \begin_inset Quotes eld
11439 \begin_inset Quotes erd
11447 \begin_layout Standard
11448 \begin_inset VSpace bigskip
11454 \begin_layout Standard
11455 If you're looking for the documentation for
11456 \begin_inset Quotes eld
11464 \begin_inset Quotes erd
11467 , check out section\InsetSpace ~
11469 \begin_inset LatexCommand ref
11470 reference "sec:slitex"
11475 If your machine doesn't have the
11480 \begin_inset Quotes eld
11488 \begin_inset Quotes erd
11491 ] installed, you'll probably have to use the default
11495 class, which isn't quite as good as
11500 \begin_layout Standard
11505 class is designed for use with version 2.1 of the
11509 LaTeX class file which is now an integral part of LaTeX2e.
11512 \begin_layout Subsection
11516 \begin_layout Standard
11517 Obviously, to use this document class, you need to select
11518 \begin_inset Quotes eld
11526 \begin_inset Quotes erd
11538 Document\InsetSpace ~
11542 There are some settings in the
11544 Document\InsetSpace ~
11547 dialog that you should know about that are specific to this class:
11550 \begin_layout Itemize
11551 Don't change the options
11561 Document\InsetSpace ~
11565 They're ignored by the
11572 \begin_layout Itemize
11573 The default font size is 20pt with the other options being 17pt, 25pt and
11577 \begin_layout Itemize
11578 The default font is
11586 but all math equations are still typeset in the usual roman font.
11589 \begin_layout Itemize
11594 TeX supports A4 and Letter paper sizes as well as a special size for working
11596 It doesn't support A5, B5, legal or executive paper sizes.
11599 \begin_layout Itemize
11600 Don't bother changing the
11604 settings because they are ignored anyway.
11605 All floats appear where they are defined in the text.
11608 \begin_layout Itemize
11616 setting behaves a bit differently for this class.
11621 TeX provides extensive footer and header capabilities including a user-defined
11623 See section\InsetSpace ~
11625 \begin_inset LatexCommand ref
11626 reference "sec:foilfoot"
11631 The title page is treated differently to all other pages in the document
11640 has the logo centered at the bottom of the page (if one is defined).
11641 The possible page style choices and what they do are as follows:
11646 \labelwidthstring MMMMMMM
11653 The final output contains no page numbers, or other headers or footers
11654 (except footnotes of course).
11659 \labelwidthstring MMMMMMM
11666 The final output contains page numbers centered at the bottom of the page.
11667 No other headings or footers (other than footnotes).
11671 \labelwidthstring MMMMMMM
11676 Page numbers in lower right corner.
11677 Additional headers and footers are also shown.
11678 This is also the default.
11682 \labelwidthstring MMMMMMM
11687 Gives you access to the
11691 package although its use with
11695 TeX is discouraged by the writer of the
11699 TeX package because of some potential page layout clashes.
11703 \begin_layout Subsubsection
11707 \begin_layout Standard
11708 The following options may be used in the extra class options in the
11713 ocument\SpecialChar \menuseparator
11724 \labelwidthstring MMMMMMx
11729 This sets up the page layout for 7.33in by 11in paper, which is about the
11730 same aspect ratio as a 35mm slide, making it a bit easier to work with
11735 \labelwidthstring MMMMMMx
11740 Places a rule across the page below the header on every page except the
11745 \labelwidthstring MMMMMMx
11750 Places a rule across the page above the footer on every page except the
11755 \labelwidthstring MMMMMMx
11760 This is automatically set each time you create a new
11769 TeX to use the dvips driver to rotate those pages that are set as landscape
11774 \labelwidthstring MMMMMMx
11779 Simply changes the page dimensions to those of a landscape page but doesn't
11781 Thus if you use this option you need to use an external program to rotate
11782 each page or feed your paper through your printer as landscape.
11783 Note that this option effectively reverses the roles of the
11791 environments (don't worry these are described in the next section).
11795 \labelwidthstring MMMMMMx
11800 Equation numbers on the left.
11804 \labelwidthstring MMMMMMx
11809 Flush-left equations.
11812 \begin_layout Subsection
11813 Supported Environments
11816 \begin_layout Standard
11817 Most of the environments commonly supported in other classes are also supported
11823 There are several additional environments provided by
11827 TeX as well as a couple added by LyX.
11828 The following environments are shared with other classes:
11831 \begin_layout Standard
11835 \begin_layout Standard
11839 begin{multicols}{2}
11847 \begin_layout Itemize
11853 \begin_layout Itemize
11859 \begin_layout Itemize
11865 \begin_layout Itemize
11871 \begin_layout Itemize
11877 \begin_layout Itemize
11883 \begin_layout Itemize
11889 \begin_layout Itemize
11895 \begin_layout Itemize
11901 \begin_layout Itemize
11907 \begin_layout Itemize
11913 \begin_layout Itemize
11919 \begin_layout Itemize
11925 \begin_layout Itemize
11931 \begin_layout Itemize
11937 \begin_layout Itemize
11943 \begin_layout Itemize
11949 \begin_layout Itemize
11955 \begin_layout Standard
11959 \begin_layout Standard
11971 \begin_layout Standard
11972 That is, all the major environments apart from the sectioning environments.
11973 Since foils are essentially self-contained sections, with a title and body,
11978 TeX provides specific commands for starting new foils and these are:
11981 \begin_layout Itemize
11987 \begin_layout Itemize
11993 \begin_layout Standard
11994 LyX also provides slightly modified versions of these two environments called:
11997 \begin_layout Itemize
12003 \begin_layout Itemize
12006 ShortRotatefoilhead
12009 \begin_layout Standard
12010 and the differences will be explained in the next section.
12013 \begin_layout Standard
12014 Since foils are often used in presenting ideas or new theorems and such
12019 TeX also provides a comprehensive box of goodies for presenting them:
12022 \begin_layout Standard
12026 \begin_layout Standard
12030 begin{multicols}{2}
12038 \begin_layout Itemize
12044 \begin_layout Itemize
12050 \begin_layout Itemize
12056 \begin_layout Itemize
12062 \begin_layout Itemize
12068 \begin_layout Itemize
12074 \begin_layout Itemize
12080 \begin_layout Itemize
12086 \begin_layout Itemize
12092 \begin_layout Itemize
12098 \begin_layout Itemize
12104 \begin_layout Standard
12108 \begin_layout Standard
12120 \begin_layout Standard
12121 The starred versions are unnumbered while the unstarred versions are numbered.
12122 There are also two list environments added by LyX and these are:
12125 \begin_layout Itemize
12131 \begin_layout Itemize
12137 \begin_layout Standard
12142 TeX provides some powerful header and footer capabilities that are best
12143 set in the preamble although they may be set at any point in a document.
12144 If you want to change these settings in your document the best place to
12145 do so is at the very top of a foil,
12150 straight after the foilhead.
12153 \begin_layout Standard
12154 For this purpose, the following command styles are provided [
12161 \begin_layout Standard
12165 \begin_layout Standard
12169 begin{multicols}{2}
12177 \begin_layout Itemize
12184 \begin_layout Itemize
12190 \begin_layout Itemize
12197 \begin_layout Itemize
12204 \begin_layout Itemize
12212 \begin_layout Standard
12218 \begin_layout Standard
12222 \begin_layout Standard
12234 \begin_layout Standard
12235 There are also a few commands provided by
12239 TeX that aren't directly supported by LyX but I'll tell you what they do
12240 and how to use them in section\InsetSpace ~
12242 \begin_inset LatexCommand ref
12243 reference "sec:unsuppfoils"
12250 \begin_layout Subsection
12251 Building a Set of Foils
12254 \begin_layout Standard
12255 This section will give a simple introduction to using the different environments
12256 to build a set of foils.
12257 If you want to see an example set of foils take a look at the
12261 file accessible from the
12266 ile\SpecialChar \menuseparator
12271 pen\SpecialChar \ldots{}
12282 \begin_layout Subsubsection
12283 Give It a Title Page
12286 \begin_layout Standard
12287 Unlike other classes that provide
12307 creates the title on a page of its own.
12308 If you leave out the
12312 environment LaTeX will substitute the current date (every time you regenerate
12316 \begin_layout Subsubsection
12320 \begin_layout Standard
12321 As I mentioned earlier, there are four ways of starting a new foil.
12322 For portrait foils you should use
12331 The difference between these two environments is the amount of space between
12332 the title of the foil (the foilhead) and the body of the foil.
12335 \begin_layout Standard
12336 Landscape foils are generated using the
12342 ShortRotatefoilhead
12345 Again the only difference is the spacing between foilhead and body.
12346 Both of the short versions have 0.5 inches less separation between the foilhead
12351 \begin_layout Standard
12352 One problem with the support for landscape foils is the requirement that
12353 you have to use the
12357 driver to generate the PostScript output otherwise the foils won't be rotated.
12358 It is possible to get landscape foils even if you haven't got the
12362 driver provided you can feed your foils sideways through your printer ;-)
12365 \begin_layout Subsubsection
12366 Theorems, Lemmas, Proofs and more
12369 \begin_layout Standard
12370 Due to a small bug in LyX you can't have two of the same type of these environme
12371 nts directly following each other.
12372 They must be separated by something.
12373 If you try, you will just be extending the previous environment as if you
12374 had merged the two environments together.
12375 So, how do you get around this problem? The simplest option is to insert
12376 some text between the two environments or add a
12380 environment between the two with just a
12381 \begin_inset Quotes eld
12389 \begin_inset Quotes erd
12393 This will force LyX to produce two separate environments and hence the
12394 correct LaTeX output.
12395 An example is provided in the example file included with the LyX distribution.
12396 Remember, this problem only occurs if you are trying to place two of the
12397 same type of theorem-like environments one directly after the other.
12400 \begin_layout Subsubsection
12404 \begin_layout Standard
12405 You get all the commonly supported list styles found in other classes as
12406 well as two new ones.
12407 I'll only describe the new ones here.
12408 If you want to find out more about the other list environments check out
12414 If you intend to use itemized lists you might also want to read about the
12417 Itemize\InsetSpace ~
12418 Bullet\InsetSpace ~
12421 dialog described above in section\InsetSpace ~
12423 \begin_inset LatexCommand ref
12424 reference "sec:bullet"
12431 \begin_layout Standard
12432 The two new list styles,
12440 , are designed to make it easier for you to create lists of do's and don'ts
12441 or right and wrong by providing dedicated environments that use a tick
12442 or a cross as the label of the list.
12443 These lists are in fact dedicated variants of the
12448 They do however require that you have the
12452 packages installed.
12455 \begin_layout Subsubsection
12459 \begin_layout Standard
12464 TeX redefines the floating tables and figures so that they appear exactly
12465 where they are in the text rather than pushing them to the top of the page
12466 or to some user specified location.
12467 In fact if you change the float placement settings they are simply ignored.
12470 \begin_layout Subsubsection
12471 Page Headers and Footers
12472 \begin_inset LatexCommand label
12473 name "sec:foilfoot"
12480 \begin_layout Standard
12490 are two commands used to control the left-footer text string.
12491 The first is meant to allow you to include a graphic logo on your foils
12493 \begin_inset Quotes eld
12501 \begin_inset Quotes erd
12505 While the second is meant to provide a classification for the audience,
12508 e.\InsetSpace \thinspace{}
12513 It is empty by default.
12516 \begin_layout Standard
12517 The remaining page corners can be filled by
12522 (which defaults to page numbers),
12535 \begin_layout Subsection
12541 \begin_inset LatexCommand label
12542 name "sec:unsuppfoils"
12549 \begin_layout Standard
12550 All the commands mentioned below need to be set in a
12558 within another environment.
12561 \begin_layout Subsubsection
12565 \begin_layout Standard
12566 All lengths are adjusted using the
12589 should be replaced by the name given to the length you want to change and
12594 is the length value.
12595 All lengths should be specified in units of length such as inches (
12607 ) or relative to some document or font-based length such as
12617 \begin_layout Standard
12618 It's possible to change the spacing between a foilhead and the body of the
12619 foil by adjusting the length specified by
12626 For example, to make
12630 foilheads 0.5 inches closer to their bodies put the following in the preamble:
12637 foilheadskip}{-0.5in}
12640 \begin_layout Standard
12641 The spacings around floats can be adjusted by setting these lengths:
12645 \labelwidthstring MMMMMMMMMMM
12652 Separation between the text and the top of the float
12656 \labelwidthstring MMMMMMMMMMM
12663 Separation between the float and the caption
12667 \labelwidthstring MMMMMMMMMMM
12674 Separation between the caption and the following text
12678 \labelwidthstring MMMMMMMMMMM
12685 You can make the captions narrower than the surrounding text by adjusting
12687 Best done relative to
12696 \begin_layout Standard
12697 There are also several title page related lengths that you may find useful
12698 if you have a long title or several authors:
12702 \labelwidthstring MMMMMMMMMMM
12709 Separation from headers to
12715 \labelwidthstring MMMMMMMMMMM
12734 \labelwidthstring MMMMMMMMMMM
12749 \labelwidthstring MMMMMMMMMMM
12766 \labelwidthstring MMMMMMMMMMM
12782 \begin_layout Standard
12783 The last length related command affects all the list environments.
12794 a list environment then all the vertical spacing between the list items
12796 Note that this is a command not a length so it doesn't require
12802 like the stuff mentioned above.
12805 \begin_layout Subsubsection
12806 Headers and Footers
12809 \begin_layout Standard
12822 commands control whether the logo in the
12826 definition appear on a given page.
12833 in the preamble then none of the foils will have the logo on them.
12834 If you don't want the logo on a particular page place the
12840 directly after the foilhead of that page and the
12846 directly after the next foilhead.
12849 \begin_layout Standard
12850 If you decide to use the
12854 page style setting in the
12856 Document\InsetSpace ~
12859 dialog you should probably add
12869 to your preamble so headers and footers on landscape pages are correctly
12870 placed when rotated.
12871 This is due to some clashes between the page layouts provided by the
12882 \begin_layout Section
12883 Latex8 (IEEE Conference Papers)
12886 \begin_layout Standard
12892 \begin_layout Subsection
12896 \begin_layout Standard
12897 Since this class is specifically for writing submissions to IEEE sponsored
12898 conferences I strongly recommend that you get a copy of their Authors Kit.
12903 package and associated bibliography style file is included in the kit.
12904 The Authors Kit is usually sent out by email once your initial submission
12906 There is a lot of useful information in the Authors Kit explaining formatting
12907 restrictions and so on and I will assume you have read this since that
12908 means I don't have to repeat it all here.
12911 \begin_layout Subsection
12915 \begin_layout Standard
12916 [AR\SpecialChar \@.
12920 \begin_layout Subsection
12921 Supported Environments
12924 \begin_layout Itemize
12930 \begin_layout Itemize
12936 \begin_layout Itemize
12942 \begin_layout Itemize
12948 \begin_layout Itemize
12954 \begin_layout Itemize
12960 \begin_layout Itemize
12966 \begin_layout Itemize
12972 \begin_layout Itemize
12978 \begin_layout Subsection
12979 Differences Between Screen and Paper
12982 \begin_layout Standard
12983 There are slight differences in appearance mainly with the presentation
12984 of section counters.
12985 On screen the trailing period of the section counter is missing but it
12986 will appear in the output so don't let this worry you.
12989 \begin_layout Section
12990 Hollywood (Hollywood spec scripts)
12993 \begin_layout Standard
12999 \begin_layout Subsection
13003 \begin_layout Standard
13004 Getting the format of a Hollywood script right is a
13005 \begin_inset Quotes eld
13009 \begin_inset Quotes erd
13012 It is designed to make the readers focus on content and to be easy and
13013 familiar for the actors to read.
13014 Each page of a script should be one minute of film.
13015 Nothing goes in a script that you cannot see or hear on screen.
13016 The courier 12 pt font should be used throughout.
13020 \begin_layout Subsection
13024 \begin_layout Standard
13025 Speakers' lines should NEVER break in mid-sentence.
13026 If a speaker's lines continue over a page break, repeat the
13030 title followed by (Cont'd).
13033 \begin_layout Subsection
13037 \begin_layout Standard
13042 names as labels then cross-reference the label to insert the name.
13043 The cross-reference dialog will show the current cast of characters.
13044 You can use this to insert the speaker name in narratives also.
13047 \begin_layout Subsection
13048 Paper size and Margins
13051 \begin_layout Standard
13052 USLetter, left 1.6in, right 0.75in, top 0.5in, bottom 0.75in
13055 \begin_layout Subsection
13059 \begin_layout Standard
13060 The following environments are available.
13061 You can use hollywood.bind to get the bind keys shown at the right.
13064 \begin_layout Itemize
13071 Used where nothing else works.
13075 \begin_layout Itemize
13088 Usually followed by something like
13089 \begin_inset Quotes eld
13092 on Sally waking up.
13093 \begin_inset Quotes erd
13099 \begin_layout Itemize
13108 Introduces a new INTERIOR camera set-up.
13109 Always followed by DAY or NIGHT, or something similar to define the lighting
13111 Everthing on this line in CAPS.
13114 \begin_layout Itemize
13123 Introduces a new EXTERIOR camera set-up.
13124 Everthing on this line in CAPS.
13127 \begin_layout Itemize
13136 The character speaking.
13139 \begin_layout Itemize
13148 Instructions to the speaker.
13149 The () are automatically inserted, but only the ( will show in LyX.
13150 Both will be printed.
13153 \begin_layout Itemize
13169 \begin_layout Itemize
13178 Camera movement instruction.
13179 e.\InsetSpace \thinspace{}
13184 \begin_layout Itemize
13192 \begin_layout Itemize
13200 \begin_layout Itemize
13208 \begin_layout Itemize
13216 \begin_layout Subsection
13220 \begin_layout Itemize
13221 (O.S) --- off screen
13224 \begin_layout Itemize
13225 (V.0) --- voice over
13228 \begin_layout Itemize
13233 \begin_layout Itemize
13238 \begin_layout Itemize
13239 PAN --- camera movement
13242 \begin_layout Itemize
13243 INSERT --- cut to close-up of
13246 \begin_layout Section
13250 \begin_layout Standard
13256 \begin_layout Subsection
13260 \begin_layout Standard
13261 Broadway is for writing plays.
13262 The format is more decorative than Hollywood, and much less standardized.
13263 This format should be suitable for workshops.
13266 \begin_layout Subsection
13270 \begin_layout Standard
13271 The same as in Hollywood.
13274 \begin_layout Subsection
13278 \begin_layout Standard
13283 names as labels then cross-reference the label to insert the name.
13284 The cross-reference dialog will show the current cast of characters.
13287 \begin_layout Subsection
13288 Paper size and Margins
13291 \begin_layout Standard
13292 USLetter, left 1.6in, right 0.75in, top 0.5in, bottom 0.75in
13295 \begin_layout Subsection
13299 \begin_layout Standard
13300 The following environments are available.
13301 You can use broadway.bind to get the bind keys shown at the right.
13304 \begin_layout Itemize
13311 You should not have to use this, but it is here for anything that does not
13315 \begin_layout Itemize
13324 Used to describe stage setting and the action.
13325 First use of speaker names in all CAPs.
13328 \begin_layout Itemize
13337 Automatically numbered.
13338 On screen it will be arabic, but will print as Roman.
13341 \begin_layout Itemize
13355 It is just centered text.
13358 \begin_layout Itemize
13367 Not automatically numbered.
13368 You supply the number.
13369 This is because I couldn't figure out how.
13372 \begin_layout Itemize
13381 A special case of Narrative to describe the setting and action as the curtain
13385 \begin_layout Itemize
13394 The speaker's (actor's) title, centered in all CAPS.
13397 \begin_layout Itemize
13406 Instructions to the speaker.
13407 The parentheses are automatically inserted.
13408 The ( will appear on screen, but both will be in the printed play.
13409 This environment is only used within
13416 \begin_layout Itemize
13425 What the Speaker says.
13428 \begin_layout Itemize
13437 The curtain comes down.
13440 \begin_layout Itemize
13448 \begin_layout Itemize
13456 \begin_layout Itemize
13464 \begin_layout Standard
13468 \begin_layout Section
13472 \begin_layout Standard
13478 \begin_layout Standard
13479 \begin_inset VSpace bigskip
13485 \begin_layout Standard
13489 Revtex\InsetSpace ~
13492 textclass works with the American Physical Sociey's RevTeX 4.0 (the
13493 \begin_inset Formula $\beta$
13496 release of May, 1999) class.
13499 \begin_layout Standard
13504 textclass, which works with RevTeX 3.1.
13505 However, v3.1 is basically obsolete, as it works with LaTeX 2.09.
13506 That means that it doesn't interact very well with LyX, which requires
13507 LaTeX2e, although it has been kludged to work.
13508 Since RevTeX 4.0 has been designed to work much more cleanly with LaTeX2e,
13511 RevTeX\InsetSpace ~
13514 textclass should also be pretty easy to use.
13517 \begin_layout Standard
13518 These documents are supposed to be used in
13522 to the RevTeX 4.0 documents, so we don't describe any of the special RevTeX
13523 macros, and assume you'll know what to put in the preamble if necessary.
13526 \begin_layout Subsection
13530 \begin_layout Standard
13531 All you need to do is install RevTeX 4, as described in the package's README
13533 The package can be found at
13534 \begin_inset LatexCommand url
13535 name "The RevTeX 4 Web Site"
13536 target "http://publish.aps.org/revtex4/"
13541 Install it somewhere that LaTeX can see it.
13542 Test it by trying to LaTeX a short RevTeX 4 document in some random directory
13543 (i.e., not the directory where you installed the class file.) Then, if you
13544 reconfigure LyX, it will find the class file and let you use the RevTeX4
13548 \begin_layout Standard
13549 Probably the easiest way to get started is either to import a RevTeX 4 document
13556 Revtex\InsetSpace ~
13559 template, found in the templates directory.
13562 \begin_layout Subsection
13566 \begin_layout Standard
13567 Optional arguments to
13574 \begin_inset Quotes eld
13578 \begin_inset Quotes erd
13582 \begin_inset Quotes eld
13586 \begin_inset Quotes erd
13600 Document\InsetSpace ~
13604 Remember that in RevTeX, at least one optional argument is required!
13607 \begin_layout Standard
13608 Other preamble matter, like
13624 dialog, also as usual.
13627 \begin_layout Subsection
13631 \begin_layout Standard
13632 The layouts basically correspond to the commands in RevTeX4.0.
13633 For example, the Email layout corresponds to
13640 Note that (at least as of RevTeX 4.0 Beta), the
13648 layouts are exactly equivalent, so you shouldn't need to use both.
13652 \begin_layout Standard
13653 In case you're curious, both were included so that
13657 would be able to translate both
13677 \begin_layout Subsection
13681 \begin_layout Standard
13682 There are a couple of important unique aspects of RevTeX 4 which might cause
13683 bugs that will be even more confusing in LyX.
13686 \begin_layout Standard
13704 The LyX equivalent is that there is a separate Thanks layout.
13709 write footnotes in the
13713 layout, or weird things may happen.
13714 See the RevTeX 4 documentation for more details.
13717 \begin_layout Standard
13720 Author\InsetSpace ~
13725 Author\InsetSpace ~
13732 layouts must be placed
13740 layout and the corresponding
13757 , the LaTeX won't compile.
13760 \begin_layout Subsection
13764 \begin_layout Standard
13765 The main problem with this layout is that you can't use the optional arguments
13766 to layouts like Email and Title.
13767 (The problem is not unique to this layout; you can't use optional arguments
13768 to the Section layouts either.) This means that after you export that file
13769 to LaTeX (which you'll need to do eventually to send it in to APS), you'll
13770 need to edit the LaTeX file with a text editor to add the optional arguments
13771 to set, e.\InsetSpace \thinspace{}
13772 g., the running title for the page headers.
13773 Lacking these layouts makes the
13779 (and the equivalent
13785 ) useless, so the corresponding layouts don't exist, and will have to be
13790 \begin_layout Standard
13795 actually, LyX 1.3.0 supports some forms of optional arguments, but this layout
13796 has not been updated yet to take advantage of it.
13804 \begin_layout Section
13805 Article (mwart), book (mwbk) and report (mwrep)
13806 \begin_inset OptArg
13809 \begin_layout Standard
13822 \begin_layout Standard
13828 \begin_layout Standard
13829 The LyX document classes
13845 correspond to the LaTeX document classes
13858 They are replacements for the standard document classes
13870 , resp., and fit better to Polish typography conventions in a number of points.
13874 \begin_layout Standard
13878 \begin_layout Itemize
13879 Unnumbered titles (with star, eg.
13884 ) are added into table of contents,
13887 \begin_layout Itemize
13888 Additional page styles:
13892 \begin_layout Description
13893 uheadings header with separated lines,
13896 \begin_layout Description
13897 myheadings custom header, contents headers via commands:
13912 \begin_layout Description
13913 myuheadings custom header with separated lines,
13916 \begin_layout Description
13917 outer page number is placed on outer side of page
13921 \begin_layout Itemize
13926 \begin_layout Description
13927 rmheadings serif titles --- default,
13930 \begin_layout Description
13931 sfheadings sansserif titles,
13934 \begin_layout Description
13935 authortitle on title page first placed is author next title --- default,
13938 \begin_layout Description
13939 titleauthor on title page first placed is title next author,
13942 \begin_layout Description
13943 withmarginpar reserve place on page for margins.
13947 \begin_layout Section
13951 \begin_layout Standard
13957 \begin_layout Standard
13958 Elsevier Science Publishers B.V.
13959 provides a standard LaTeX document class (
13963 ) for submitting articles to their various journals.
13964 The style file can be downloaded directly from their web site:
13965 \begin_inset LatexCommand url
13966 target "http://authors.elsevier.com/"
13971 Instructions are supplied along with the class file, which details the
13972 requirements of the publishers.
13973 LyX includes package that allows for the use of this class, by a layout
13974 and a template file.
13975 Installation of the class file is the same as for any other LaTeX package;
13976 instructions are provided in the Elsevier documentation.
13979 \begin_layout Standard
13989 As the Elsevier class file is based mainly on the standard article class,
13990 most of the normal functionality is provided.
13991 The Elsevier class defines a number of mathematical environments, which
13992 are similar to the AMS environments.
13993 These commands are all described in the Elsevier documentation, and are
13997 \begin_layout Standard
13998 The easiest way to use the Elsevier style is to base documents on the included
14000 It is best not to use options such as fancy headings or the geometry package,
14001 as elements such as these are defined by Elsevier in their style file.
14002 Ideally, no extra packages except those mentioned in the Elsevier documentation
14004 Essentially, Elsevier require as
14005 \begin_inset Quotes eld
14009 \begin_inset Quotes erd
14016 \begin_layout Standard
14025 file as possible, as their intention is to take the supplied file and replace
14026 the class file with one for the particular journal to which the paper has
14028 This also means that not too much time should be spent on the formating
14030 When it comes to be published, this will change anyway.
14031 The rest of the usage for this layout is substantially the same as for
14032 the normal article class.
14033 For details of what Elsevier do and don't allow, refer to their documentation.
14036 \begin_layout Section
14040 \begin_layout Standard
14043 Jürgen Spitzmüller
14046 \begin_layout Subsection
14050 \begin_layout Standard
14051 Memoir is a very powerful and constantly evolving class.
14052 It has been designed with regard to fictional and non-fictional literature.
14053 Its aim is to let the user have maximum control over the typesetting of
14055 Memoir is based on the standard book class, but it can also emulate the
14056 article class (see below).
14059 \begin_layout Standard
14060 Peter Wilson, the developer of Memoir, is known as the author of lots of
14061 useful packages in the LaTeX world.
14062 Most of them have been merged with Memoir.
14063 Therefore, it is much easier to layout the table of contents, appendices,
14064 chapter designs and such.
14065 LyX, though, does not support all of these goodies natively.
14066 Some of them might be added to forthcoming releases
14070 \begin_layout Standard
14071 You are invited to send suggestions to
14072 \begin_inset LatexCommand url
14073 target "lyx-devel@lists.lyx.org"
14082 , lots will probably never, due to the limitations of LyX's framework.
14083 Of course you can still use all features with the help of some native LaTeX
14088 \begin_layout Standard
14093 \begin_layout Standard
14102 section\InsetSpace ~
14104 \begin_inset LatexCommand ref
14105 reference "sec:Inserting-LaTeX-Code"
14115 In this section, we can only list those features which are natively supported
14117 For detailed descriptions (and for the rest of features) we are recommending
14118 to have a look at the detailed manual of the Memoir class
14122 \begin_layout Standard
14127 \begin_layout Standard
14137 \begin_inset LatexCommand url
14138 target "CTAN:/macros/latex/memoir/memman.pdf"
14147 , which is not only a user guide for the class, but also both a comprehensive
14148 description on good typesetting and a superb example for good typesetting
14152 \begin_layout Subsection
14153 Basic features and restrictions
14156 \begin_layout Standard
14157 Memoir supports basically all features of the standard book classes.
14158 There are, however, some differences, as follows:
14161 \begin_layout Description
14163 sizes: Memoir has a broader range of font sizes: 9, 10, 11, 12, 14,
14167 \begin_layout Description
14169 style: The fancy page style is not supported, due to a command clash
14170 between Memoir and the fancyhdr package (they are both defining a command
14171 with the same name, which confuses LaTeX).
14172 Instead, Memoir comes with a bunch of own page styles (see
14174 Layout\SpecialChar \menuseparator
14175 Document\SpecialChar \menuseparator
14180 If you want to use these for the chapter pages, you have to use the command
14187 in the main text or in preamble (e.
14191 \begin_layout Standard
14204 \begin_layout Standard
14217 chapterstyle{companion}
14222 \begin_layout Description
14223 Sectioning: Sectionings (chapter, section, subsection etc.) are coming with
14224 an optional argument in the standard classes.
14225 With this, you can specify an alternative version of the title for the
14226 table of contents and the headers (for instance, if the title is too long).
14227 In LyX, you can do this via
14229 Insert\SpecialChar \menuseparator
14233 at the beginning of a chapter/section.
14234 Memoir features a second optional argument and thus separates the table
14235 of contents from the header.
14236 You can define three variants of a title with this: one for the main text,
14237 one for the table of contents, and one for the headers.
14238 Simply insert two optional arguments if you need this feature, the first
14239 one containing the short title for the Table of Contents, the second one
14240 containing an alternative short title for the headers.
14243 \begin_layout Description
14244 TOC/LOT/LOF: In the standard classes (and in many other classes), the table
14245 of contents, the list of figures and the list of table start a new page
14247 Memoir does not follow this route.
14248 You have to insert a page break yourself, if you want to have one.
14251 \begin_layout Description
14252 Titlepage: For some unknown reason, Memoir uses pagination on the title
14253 page (in the standard classes, title pages are
14254 \begin_inset Quotes eld
14258 \begin_inset Quotes erd
14265 \begin_layout Standard
14278 \begin_layout Standard
14288 If you want an empty title page, type
14292 aliaspagestyle{title}{empty}
14297 \begin_layout Description
14298 Article: With the class option
14304 Layout\SpecialChar \menuseparator
14305 Document\SpecialChar \menuseparator
14309 ), you can emulate article style.
14310 That is, counters (footnotes, figures, tables etc.) will not be reset on
14311 new chapters, chapters don't start a new page (but are---in contrary to
14313 \begin_inset Quotes eld
14317 \begin_inset Quotes erd
14320 article classes---still allowed), parts, though, use their own page, as
14324 \begin_layout Description
14325 Oldfontcommands: By default, Memoir does not allow the use of the deprecated
14326 font commands, which have been used in the old LaTeX version 2.09 (e.
14330 \begin_layout Standard
14343 \begin_layout Standard
14365 It produces an error and stops LaTeX whenever such a command appears.
14370 reallows the commands and spits out warnings instead (which does at least
14372 Since a lot of packages and particularly BibTeX style files are still using
14373 those commands, we have decided to use this option by default.
14376 \begin_layout Subsection
14380 \begin_layout Standard
14381 We will only describe the features supported by LyX (which is not much currently
14383 Please consult the Memoir manual
14387 \begin_layout Standard
14392 \begin_layout Standard
14402 \begin_inset LatexCommand url
14403 target "CTAN:/macros/latex/memoir/memman.pdf"
14415 \begin_layout Description
14416 Abstract: You may wonder why an abstract is an extra feature.
14417 Well, it is in book class.
14418 Usually books don't have abstracts.
14419 Memoir, however, has.
14420 You can use it wherever and how often you like.
14423 \begin_layout Description
14424 Chapterprecis: You may know this from belletristic: The contents of a chapter
14425 is shortly described below the title and also in the table of contents
14430 \begin_layout Standard
14443 \begin_layout Standard
14454 Our hero arrives in Troia; he loses some friends; he finds others
14457 Chapterprecis does exactly this.
14458 It is therefore only sensible below a chapter.
14461 \begin_layout Description
14462 Epigraph: An epigraph is a smart slogan or motto at the beginning of a chapter.
14463 The epigraph environment provides an elegant way of typesetting such a
14465 The motto itself (text) and its author (source) are divided by a short
14467 Unfortunately, we have to fool LyX a bit here again, since the environment
14468 needs two arguments (text and source).
14469 In this case, we have to use curly brackets (in TeX mode) between the two
14480 <author of the slogan>.
14483 \begin_layout Description
14484 Poemtitle: Memoir has lots of possibilities to typeset poetry (up to very
14485 complex figurative poems).
14486 LyX can only support a few of them.
14487 One is poemtitle, which is a centered title for poems, which will also
14488 be added to the table of contents (verse is the standard environment for
14490 Memoir has some enhanced versions of verse, but you need to use ERT, because
14491 they have to be nested inside regular verse environments, which is not
14492 possible with LyX).
14495 \begin_layout Description
14496 Poemtitle*: Same as poemtitle, but it adds no entry to the table of contents.
14499 \begin_layout Chapter
14500 Importing and Exporting Alternate File Formats
14501 \begin_inset OptArg
14504 \begin_layout Standard
14505 Importing and Exporting
14513 \begin_layout Section
14517 \begin_layout Standard
14518 Importing and exporting LyX documents from/to other formats has been touched
14524 Here we describe more of the gory details needed to understand just what
14525 is going on when you click on the
14530 ile\SpecialChar \menuseparator
14542 ile\SpecialChar \menuseparator
14553 \begin_layout Section
14554 Importing Other Formats
14557 \begin_layout Subsection
14561 \begin_layout Standard
14562 Translating from LaTeX into LyX is performed by a Perl script called reLyX.
14563 Although it is a standalone program which can be called from the command
14564 line, LyX will call it automatically when a LaTeX document is imported.
14565 See section\InsetSpace ~
14567 \begin_inset LatexCommand ref
14568 reference "sec:reLyX"
14572 for a complete description.
14573 There are no user tunable parameters for reLyX within LyX.
14576 \begin_layout Subsection
14580 \begin_layout Standard
14581 When importing plain ASCII text, there are two methods of reading the file.
14583 \begin_inset Quotes eld
14587 \begin_inset Quotes erd
14590 preserves all the linebreaks in the ASCII; to LyX, then, each line looks
14593 \begin_inset Quotes eld
14597 \begin_inset Quotes erd
14600 assumes that consecutive lines separated by only a single linebreak form
14601 a single paragraph.
14602 Successive linebreaks with no intervening text are thus assumed to be paragraph
14606 \begin_layout Subsection
14610 \begin_layout Standard
14613 [Editor's note: Needs to be written, obviously - any volunteers? --- mer]
14616 \begin_layout Section
14617 Exporting Other Formats
14620 \begin_layout Standard
14621 The output formats listed here in the following are also explained concerning
14622 possible graphics formats in the
14629 \begin_layout Subsection
14633 \begin_layout Standard
14634 LyX generates two types of LaTeX files: stripped down versions for the normal
14639 , etc.) which one normally never sees
14643 \begin_layout Standard
14644 The resulting file is a perfectly valid LaTeX file, though the preamble
14645 might look a bit strange since it includes some definitions used by LyX
14646 which wouldn't show up in most human-written files.
14651 , and human readable forms which are suitable for exchanging with your colleague
14653 The only settable option for the translation is the line length of the
14655 The default is 65 characters, but it can be set in
14662 \SpecialChar \menuseparator
14683 \begin_layout Subsection
14684 Device Independent Files
14687 \begin_layout Standard
14688 Device Independent files (DVI files) are produced by running LaTeX on your
14690 There are no user settable options.
14693 \begin_layout Subsection
14697 \begin_layout Standard
14698 The next step in the conversion chain is converting a DVI file into Postscript.
14706 \SpecialChar \menuseparator
14714 \SpecialChar \menuseparator
14723 or, if you need more control on the result,
14730 \SpecialChar \menuseparator
14739 If you use the later, note that it is possible to configure, in
14746 \SpecialChar \menuseparator
14754 , the options passed to the dvips program to achieve different effects.
14757 \begin_layout Subsection
14761 \begin_layout Standard
14762 Exporting as ASCII attempts to preserve the
14763 \begin_inset Quotes eld
14767 \begin_inset Quotes erd
14770 of the document as well as possible, but things like centering and indentation
14771 are thrown out; paragraphs are separated by blank lines.
14772 Section numbering and cross-references are done correctly, so the resulting
14773 text files is remarkably readable.
14774 The only changeable option is the length of lines, as for LaTeX output.
14777 \begin_layout Subsection
14781 \begin_layout Standard
14782 LyX documents can be converted to hypertext markup, usually by converting
14783 to LaTeX first, then converting that to HTML\SpecialChar \@.
14785 \begin_inset Formula $\rightarrow$
14788 HTML converters are currently known to LyX:
14805 Though they are autodetected, you can overide the selection in preferences.
14806 You can also include further command line options in this dialog.
14810 \begin_layout Subsection
14814 \begin_layout Standard
14822 \begin_layout Standard
14823 \begin_inset VSpace bigskip
14829 \begin_layout Standard
14830 The fastest way to generate a basic PDF file (no tags, links, etc.) with
14831 any version of LyX is to save the document as a Postscript file, then run
14837 Starting with version 1.1.6, the menu item
14841 will do all this for you.
14842 There are some issues with fonts that you need to pay attention to: see
14843 Section\InsetSpace ~
14845 \begin_inset LatexCommand ref
14846 reference "sec:badfonts"
14851 Also, as of version 1.1.6, there is a better method that will generate much
14852 more sophisticated files.
14855 \begin_layout Subsubsection
14859 \begin_layout Standard
14860 With pdfLaTeX you cannot use pstricks.
14861 On the other hand, with pdfLaTeX it is possible to insert directly images
14862 in JPEG, PDF or PNG format, use TrueType fonts, and more.
14865 \begin_layout Subsubsection
14866 Why does the text look so bad when viewed with Acrobat Reader?
14867 \begin_inset LatexCommand label
14868 name "sec:badfonts"
14873 \begin_inset OptArg
14876 \begin_layout Standard
14877 Bad Fonts in Acrobat Reader
14885 \begin_layout Standard
14886 The problem is that bitmap fonts are displayed poorly by Acrobat Reader.
14887 When creating a PDF from the LyX file, you need to use outline font instead
14888 of the default bitmap fonts (in fact, you should also use outline fonts
14889 for Postscript files).
14890 Recent LaTeX distributions come with Postscript Type 1 version of the standard
14891 (Computer Modern) fonts.
14892 pdfLaTeX uses these font by default.
14893 Dvips doesn't use these fonts by default, so to make it use them, add the
14894 following to lines to your
14901 \begin_layout LyX-Code
14905 \begin_layout LyX-Code
14909 \begin_layout Standard
14910 If the default LaTeX font encoding (OT1) is used, nothing else need to be
14912 However, if the T1 font encoding is used, then LaTeX uses the newer EC
14913 fonts, for which there are no Type1 version.
14914 The solution is to use the ae package which emulates T1 coded fonts using
14915 the standard CM fonts.
14916 This is done by adding
14920 usepackage{ae,aecompl}
14922 to the preamble of the LyX file.
14923 However, some glyphs are missing from the CM fonts (e.\InsetSpace \thinspace{}
14926 they are taken from the EC fonts.
14927 Therefore you get these glyphs as bitmaps.
14930 \begin_layout Standard
14931 Note: LyX uses by default the T1 font encoding.
14932 If you wish to use the default font encoding (this is not recommended,
14933 unless you only write English documents), clear the field
14941 in preferences (tabs
14953 \begin_layout Standard
14954 An alternate option is to use the standard Postscript fonts instead of the
14955 Computer Modern fonts.
14956 To do that, you need to select
14960 as the global font in the document layout dialog.
14961 When using the Postscript fonts, the result PDF file is smaller as the
14962 fonts are not saved into the file.
14963 Furthermore, the Postscript fonts include all T1 glyphs.
14964 On the other hand, the Postscript fonts have no bold symbol font, so poor
14965 man's bold must be used (see Section\InsetSpace ~
14967 \begin_inset LatexCommand ref
14968 reference "sec:pdfbold"
14973 The Postscript fonts also look different from the Computer Modern fonts.
14976 \begin_layout Standard
14977 To sum up, both the Computer Modern and the Postscript fonts gives good
14978 results (with few exceptions).
14979 The decision of which one to use is a matter of taste.
14982 \begin_layout Subsubsection
14985 boldsymbol{} command work when I use pslatex?
14986 \begin_inset LatexCommand label
14992 \begin_inset OptArg
14995 \begin_layout Standard
15012 \begin_layout Standard
15013 The Postscript fonts do not have a bold symbol font.
15014 The solution is to use the
15020 (poor man's bold) command.
15023 \begin_layout Standard
15024 It is possible to redefine the
15039 \begin_layout LyX-Code
15049 \begin_layout Standard
15053 \begin_layout Subsubsection
15054 Is it possible to do write LaTeX-code which is processed only when running
15056 \begin_inset OptArg
15059 \begin_layout Standard
15060 Conditionals with pdfLaTeX
15068 \begin_layout Standard
15069 Yes you can do this with the
15074 Here is an example:
15077 \begin_layout LyX-Code
15081 \begin_layout LyX-Code
15087 \begin_layout LyX-Code
15093 \begin_layout LyX-Code
15096 pdfinfo { /Author (your name and e-mail address)
15099 \begin_layout LyX-Code
15100 /Title (official title -- i.e., title element)
15103 \begin_layout LyX-Code
15104 /Subject (one line description of the document)
15107 \begin_layout LyX-Code
15111 \begin_layout LyX-Code
15114 pdfcatalog { /PageMode (/UseNone)
15117 \begin_layout LyX-Code
15118 % /OpenAction (fitbh)
15121 \begin_layout LyX-Code
15125 \begin_layout LyX-Code
15128 usepackage[pdftex]{hyperref}
15131 \begin_layout LyX-Code
15137 \begin_layout LyX-Code
15140 usepackage[ps2pdf]{hyperref}
15143 \begin_layout LyX-Code
15149 \begin_layout Subsubsection
15150 How can I make URLs clickable?
15153 \begin_layout Standard
15154 See the references here:
15157 \begin_layout Standard
15158 \begin_inset LatexCommand url
15159 target "http://wiki.lyx.org/pmwiki.php/FAQ/PDF"
15166 \begin_layout Subsection
15170 \begin_layout Standard
15171 Custom exports are possible if you have some particularly weird format you
15172 wish to convert to, assuming you have the relevant converter, of course.
15177 file can be chosen in the
15182 ile\SpecialChar \menuseparator
15187 xport\SpecialChar \menuseparator
15194 dialog; LyX will automatically convert the file to this point, then feed
15195 it to your custom converter.
15196 The possible values are all formats that LyX can produce from its own documents.
15200 \begin_layout Standard
15201 The converter command is also specified in the dialog.
15202 It should be a completely qualified command line which uses the variable
15207 to specify the name of the file.
15208 If this variable is not given, then the file will be sent to the standard
15209 input of your command.
15210 You may have to apply a bit of ingenuity to escape this sequence correctly
15211 so that it is compatible with your shell.
15215 \begin_layout Standard
15216 While it is not possible to save this command using the
15220 dialog, you can manually edit your
15227 \begin_layout LyX-Code
15230 custom_export_command "mycommand $$FName"
15233 \begin_layout Chapter
15234 LyX Features needing Extra Software
15237 \begin_layout Section
15238 Using LyX with SGML-Tools (aka LinuxDoc)
15241 \begin_layout Standard
15247 \begin_layout Subsection
15251 \begin_layout Standard
15252 LinuxDoc is a document class available in LyX if you have the
15257 You can use it to produce documents in the so-called Standardized General
15258 Mark-up Language (SGML) in the particular format used by the Linux Documentatio
15260 That is obviously helpful if you are contributing to that project.
15261 You can use the SGML format with the
15265 package of scripts and programs (to produce other formats, including LaTeX,
15266 HTML, plain text, man pages and\SpecialChar \ldots{}
15268 You may therefore prefer to use this document class if you want to write
15269 something that can be easily translated into other formats.
15272 \begin_layout Standard
15273 You will find that LinuxDoc has fewer layout options than the other text
15275 This is mainly so that the translations into other formats have a chance
15276 of making some sense.
15277 In this section we describe:
15280 \begin_layout Itemize
15281 how to setup and use a document in LinuxDoc
15284 \begin_layout Itemize
15285 how to use the tags in LinuxDoc to layout your document
15288 \begin_layout Itemize
15289 how to use the SGML packages to produce the various formats
15292 \begin_layout Itemize
15293 how to sort out some problems.
15296 \begin_layout Subsection
15297 Preparing and using a LinuxDoc document
15300 \begin_layout Subsubsection
15304 \begin_layout Standard
15305 You start by selecting the LinuxDoc class using the
15310 ocument\SpecialChar \menuseparator
15318 Then you will find that there are fewer paragraph environments than for
15319 most other classes.
15320 You can see them on the pull down box on the left of the tool bar.
15321 How to use them is described in section\InsetSpace ~
15323 \begin_inset LatexCommand ref
15324 reference "sec:sgmlparas"
15331 \begin_layout Standard
15336 enter a title for the document, followed by an author, marking each with
15337 the appropriate paragraph environment.
15338 If you don't do this, you will get errors when you try to print the file.
15339 You can then enter the date and an abstract.
15340 The document proper must start with a Section paragraph environment rather
15341 than any standard layout.
15344 \begin_layout Standard
15345 After that you can prepare a document as usual using the available range
15346 of paragraph environments.
15347 See section\InsetSpace ~
15349 \begin_inset LatexCommand ref
15350 reference "sec:sgmlparas"
15354 for the full list and their uses.
15357 \begin_layout Subsubsection
15358 Output from LinuxDoc
15361 \begin_layout Standard
15362 You can print and save these documents in the normal way.
15363 To use the other features of the SGML package you need to save your document
15364 as LinuxDoc; this is a version in which the document is translated into
15365 the basic sgml tags.
15371 ile\SpecialChar \menuseparator
15376 xport\SpecialChar \menuseparator
15384 You will get a file with the same name and a
15388 extension rather than a
15395 \begin_inset LatexCommand ref
15396 reference "sec:sgmloperate"
15400 on how you than make use of this file.
15403 \begin_layout Subsection
15404 Using the paragraph environments in LinuxDoc
15407 \begin_layout Subsubsection
15408 The Structure of a LinuxDoc Document
15411 \begin_layout Standard
15412 There is a formal structure for LinuxDoc which limits how you can place
15414 There are two parts to all documents:
15417 \begin_layout Description
15418 Header: this is everything up to the first time you insert a Section layout
15420 It can include title, author, date, abstract and ToC.
15421 You must include the first two.
15424 \begin_layout Description
15425 Body: from the beginning of the first section onwards.
15426 All other tags are allowed.
15430 \begin_layout Subsubsection
15431 The LinuxDoc Paragraph Environments
15434 \begin_layout Standard
15435 \begin_inset LatexCommand label
15436 name "sec:sgmlparas"
15440 Here is a list of all the tags you will find listed on the layout bar in
15441 the order they come there, with some comments where the purpose or use
15445 \begin_layout Itemize
15452 works as described in [cross reference]
15455 \begin_layout Itemize
15460 : This will appear at the top left of the document when printed, above a
15461 heavy horizontal rule, although you will not see this on the LyX screen.
15464 \begin_layout Itemize
15467 Section, Subsection, Subsubsection, Paragraph and Subparagraph:
15469 all do what you would expect and in the usual order.
15470 Whether they are numbered or not is controlled by the
15472 Section\InsetSpace ~
15473 number\InsetSpace ~
15477 You cannot get the equivalent number free versions in any other way; there
15485 \begin_layout Itemize
15490 As usual this produces a numbered and indented list as described in the
15498 \begin_layout Itemize
15505 Again much the same as in the other classes: see the
15515 \begin_layout Itemize
15520 : As explained in the
15525 Remember that if you want the bold element at the start of a description
15526 to be more than one word then you need to put protected spaces between
15531 \begin_layout Itemize
15539 \begin_layout Itemize
15542 Code: similar to the LyX-Code
15549 \begin_layout Itemize
15554 : Anything you mark with this will appear on the left of the heading of
15555 the document, under the heavy rule.
15558 \begin_layout Itemize
15563 Anything you mark with this will appear on the right of the heading under
15565 You do not have to make this a date.
15566 Any text can be entered, e.\InsetSpace ~
15571 \begin_layout Itemize
15576 : You can use this to produce a free standing paragraph after the author
15577 and date, and before the first section.
15578 You are only allowed one such paragraph.
15582 \begin_layout Standard
15588 This needs checking ---
15598 \begin_layout Itemize
15607 \begin_layout Standard
15612 I have not yet checked this ---
15622 \begin_layout Subsubsection
15623 Other document features
15626 \begin_layout Standard
15627 You can also use the
15631 menu to set fonts or to emphasis words.
15632 You can also use the table of contents as usual; see the corresponding
15638 Although you will find some some other features on the menus e.\InsetSpace ~
15640 inserting footnotes.
15641 There is some doubt about whether these will work correctly.
15645 \begin_layout Standard
15650 Again still checking to see whether this is my system
15660 \begin_layout Subsubsection
15661 Cross references and HTML
15664 \begin_layout Standard
15669 menu you will find two new options relating to the inclusion of URL addresses.
15670 If you use either option you will find some highlighted TeX code inserted
15671 into your document in three separate blocks with spaces available between.
15672 The blocks will be:
15675 \begin_layout Quote
15707 \begin_layout Standard
15708 You insert a full HTML tag between the first and second blocks.
15710 \begin_inset LatexCommand url
15711 target "http://any.address"
15715 or other valid tags such as
15716 \begin_inset LatexCommand url
15717 target "mailto:me@my.address"
15729 insert some description between the second and third blocks.
15730 The differences are:
15733 \begin_layout Itemize
15740 both the HTML tag and the description will appear in the document
15743 \begin_layout Itemize
15751 only the description appears in the printed version
15754 \begin_layout Subsection
15755 Using the LinuxDoc Sgml scripts
15756 \begin_inset Note Note
15759 \begin_layout Standard
15760 This section is completely outdated.
15768 \begin_layout Standard
15769 \begin_inset LatexCommand label
15770 name "sec:sgmloperate"
15774 You can use LinuxDoc as a text class without any additional scripts or programs,
15775 but there is not much point in doing this.
15776 All you will get is a document that looks like a
15778 Linux Documentation Project Howto
15784 To do the document translation you need to get and install the
15786 sgml-tools-1.0.x.tar.gz
15789 \begin_inset Formula $x\geq3$
15794 the SGML-Tools WWW Page
15799 \begin_layout LyX-Code
15802 \begin_inset LatexCommand url
15803 target "http://pobox.com/~cg/sgmltools"
15812 \begin_layout Standard
15813 Alternatively, you can go to the
15821 \begin_layout Standard
15822 Note that, at the time of this writing (01/1998), version 1.0.3 of sgml-tools
15823 has not yet been made available at
15835 \begin_layout LyX-Code
15838 \begin_inset LatexCommand url
15839 target "ftp://sunsite.unc.edu/pub/Linux/utils/text/sgml-tools-1.0.x.tar.gz"
15846 \begin_layout Standard
15853 sgml-tools-1.0.x.tar.gz
15855 contains everything that you need to write SGML documents and convert them
15856 to groff, LaTeX, HTML, GNU info, LyX, and RTF\SpecialChar \@.
15860 \begin_layout Standard
15861 This package was renamed from
15863 linuxdoc-sgml-1.5.tar.gz
15868 \begin_layout Standard
15869 Follow the instructions in that package on how to install it and how to
15871 All this has to be done outside of LyX, before you can use the
15876 ile\SpecialChar \menuseparator
15881 xport\SpecialChar \menuseparator
15890 \begin_layout Subsection
15891 Troubleshooting LinuxDoc
15894 \begin_layout Standard
15895 When you print or preview a LinuxDoc document some checking is done of the
15896 tags before LaTeX is run.
15897 Some errors are trapped here, especially those concerning the structure
15899 LyX may produce an error message, but not leave an error box in the document
15901 You may have to look at the files directly to discover what is wrong.
15902 Most problems seem to come from the use of options that are not fully available
15906 \begin_layout Section
15910 \begin_layout Standard
15916 \begin_layout Subsection
15920 \begin_layout Standard
15928 menu, you'll find a
15937 This feature requires you to have the
15941 program installed, and is grayed out if you don't have it.
15942 You can get it from your nearest CTAN mirror, or over the Web from
15943 \begin_inset LatexCommand url
15944 target "http://www.ifi.uio.no/~jensthi/chktex/"
15951 \begin_layout Standard
15956 package is a program that was written by
15961 in frustration because some constructs in LaTeX are sometimes non-intuitive,
15962 and easy to forget.
15963 The program runs over your LaTeX file and checks the integrity of the file,
15964 and flags some common errors.
15965 In other technical words, it is
15972 \begin_layout Standard
15973 Well, what is a syntax checker doing in LyX which is supposed to produce
15974 correct LaTeX anyways? The answer is simple: Just as
15978 not only checks the
15982 of C programs, but also does
15986 checks for type-errors,
15990 catches some common
15994 errors, in addition to the syntactical ones.
15999 is capable of detecting several common errors, such as
16002 \begin_layout Itemize
16003 Ellipsis detection:
16005 Use \SpecialChar \ldots{}
16009 \begin_layout Itemize
16010 No space in front of/after parenthesis:
16015 \begin_layout Itemize
16016 Enforcement of normal space after common abbreviations:
16020 is too wide spacing.
16023 \begin_layout Itemize
16024 Enforcement of end-of-sentence space when the last sentence ends with a
16028 And this is wrong spacing.
16031 \begin_layout Itemize
16032 Space in front of labels and similar commands:
16034 The label should stick right
16035 up to the text to avoid falling to a wrong page.
16037 \begin_inset LatexCommand label
16046 \begin_layout Standard
16047 This footnote is in danger of falling off to a wrong page
16052 The label is separated too much.
16055 \begin_layout Itemize
16056 Space in front of references, instead of hard spaces:
16058 In you are in bad luck,
16059 the text will break right between the referenced text and reference number,
16062 \begin_inset LatexCommand ref
16063 reference "sec:chktex"
16070 \begin_layout Itemize
16072 \begin_inset Quotes eld
16076 \begin_inset Quotes erd
16080 \begin_inset Formula $\times$
16085 2x2 looks cheap compared to
16086 \begin_inset Formula $2\times2$
16092 \begin_layout Standard
16093 and more \SpecialChar \ldots{}
16094 It is an invaluable tool when you are
16095 \begin_inset Quotes eld
16099 \begin_inset Quotes erd
16102 your document before printing, and you should run it right after the obligatory
16103 spelling check, and before you go fine tuning the typesetting.
16106 \begin_layout Subsection
16110 \begin_layout Standard
16111 If you have the program installed, usage is as simple as choosing
16116 ools\SpecialChar \menuseparator
16125 This will make LyX generate a LaTeX file of your document, start
16129 to check it, and then make LyX insert
16130 \begin_inset Quotes eld
16134 \begin_inset Quotes erd
16137 with the warnings from
16141 , if there were any.
16142 The warnings will be placed close to the point of the mistake, and you
16143 can quickly find them by using the
16148 avigate\SpecialChar \menuseparator
16155 menu item, or the shortcut key
16164 Open the error boxes by clicking on them with the mouse, or use the shortcut
16173 bindings, or the corresponding
16182 Read the warning and correct the mistake, if it is a mistake.
16183 If you have trouble understanding what the warning is about, you can safely
16185 Remember that there is a hidden layer between the document on screen and
16186 the technical details in invoking
16190 , and this gap can make some warnings seem arcane or just right down plain
16194 \begin_layout Standard
16195 This document is an excellent testing bed for the feature, and it should
16196 provide quite a few warnings for you to fiddle with.
16197 Since computers are only so smart, expect most of the warnings to be false
16201 \begin_layout Subsection
16202 How to fine tune it
16205 \begin_layout Standard
16206 Sometimes, you'll find that
16210 makes more noise than suits your mood.
16211 Then you can choose not to use it, wait until your mood changes, or try
16216 to get better along with you.
16217 Another choice in the most desperate situations is to use
16222 iew\SpecialChar \menuseparator
16232 , which will get rid of all warnings instantly.
16235 \begin_layout Standard
16244 very configurable and extensible, you shouldn't expect to solve all problems
16250 Since LyX has to generate a somewhat special LaTeX file to be able to match
16251 the line numbers from the
16259 \begin_layout Standard
16260 You can inspect the specific output from
16266 Edit\SpecialChar \menuseparator
16280 to the internal document structure, some of the warnings will not seen
16281 to appear correctly.
16282 There are two things you can do about this:
16285 \begin_layout Itemize
16290 invocation command line in
16306 installation configuration file (usually with the file
16308 /usr/local/share/chktexrc
16311 See below to learn what warnings can be enabled and disabled on the command
16316 \begin_layout Itemize
16317 Export your document as a raw LaTeX file using
16322 ile\SpecialChar \menuseparator
16327 xport\SpecialChar \menuseparator
16339 Invoked in this way, it can be a hassle to find the corresponding place
16340 in the document inside LyX, but with a little patience, you should be able
16344 \begin_layout Standard
16345 Here follows the warning messages that can be enabled and disabled in
16354 to disable a warning, and
16358 to enable a warning.
16359 The emphasized entries are disabled by default, because the default is
16362 chktex -n1 -n3 -n6 -n9 -n22 -n25 -n30 -n38
16367 \begin_layout Standard
16368 Notice that you should only use the options that enable and disable warnings,
16369 because LyX relies on some of the other command line parameters to be set
16370 in a specific way to have a chance to communicate with
16377 \begin_layout Enumerate
16381 Command terminated with space.
16384 \begin_layout Enumerate
16387 Non-breaking space (
16388 \begin_inset Quotes eld
16396 \begin_inset Quotes erd
16399 ) should have been used.
16402 \begin_layout Enumerate
16406 You should enclose the previous parenthesis with
16407 \begin_inset Quotes eld
16415 \begin_inset Quotes erd
16421 \begin_layout Enumerate
16424 Italic correction (
16425 \begin_inset Quotes eld
16435 \begin_inset Quotes erd
16438 ) found in non-italic buffer.
16441 \begin_layout Enumerate
16444 Italic correction (
16445 \begin_inset Quotes eld
16455 \begin_inset Quotes erd
16458 ) found more than once.
16461 \begin_layout Enumerate
16465 No italic correction (
16466 \begin_inset Quotes eld
16476 \begin_inset Quotes erd
16482 \begin_layout Enumerate
16486 \begin_inset Quotes eld
16494 \begin_inset Quotes erd
16498 \begin_inset Quotes eld
16506 \begin_inset Quotes erd
16512 \begin_layout Enumerate
16515 Wrong length of dash may have been used.
16518 \begin_layout Enumerate
16522 \begin_inset Quotes eld
16530 \begin_inset Quotes erd
16534 \begin_inset Quotes eld
16542 \begin_inset Quotes erd
16548 \begin_layout Enumerate
16552 \begin_inset Quotes eld
16560 \begin_inset Quotes erd
16566 \begin_layout Enumerate
16570 \begin_inset Quotes eld
16578 \begin_inset Quotes erd
16581 to achieve an ellipsis.
16584 \begin_layout Enumerate
16587 Inter-word spacing (
16588 \begin_inset Quotes eld
16598 \begin_inset Quotes eld
16601 ) should perhaps be used.
16604 \begin_layout Enumerate
16607 Inter-sentence spacing (
16608 \begin_inset Quotes eld
16618 \begin_inset Quotes erd
16621 ) should perhaps be used.
16624 \begin_layout Enumerate
16627 Could not find argument for command.
16630 \begin_layout Enumerate
16634 \begin_inset Quotes eld
16642 \begin_inset Quotes erd
16648 \begin_layout Enumerate
16651 Math mode still on at end of LaTeX file.
16654 \begin_layout Enumerate
16658 \begin_inset Quotes eld
16666 \begin_inset Quotes erd
16669 doesn't match the number of
16670 \begin_inset Quotes eld
16678 \begin_inset Quotes erd
16684 \begin_layout Enumerate
16687 You should use either
16690 \begin_inset Quotes eld
16698 \begin_inset Quotes erd
16703 as an alternative to
16704 \begin_inset Quotes eld
16712 \begin_inset Quotes erd
16718 \begin_layout Enumerate
16725 " (ASCII 39) instead of "
16732 \begin_layout Enumerate
16735 User-specified pattern found.
16738 \begin_layout Enumerate
16741 This command might not be intended.
16744 \begin_layout Enumerate
16751 \begin_layout Enumerate
16769 \begin_layout Enumerate
16772 Delete this space to maintain correct page references.
16775 \begin_layout Enumerate
16779 You might wish to put this between a pair of
16780 \begin_inset Quotes eld
16788 \begin_inset Quotes erd
16794 \begin_layout Enumerate
16797 You ought to remove spaces in front of punctuation.
16800 \begin_layout Enumerate
16803 Could not execute LaTeX command.
16806 \begin_layout Enumerate
16815 in front of small punctuation.
16818 \begin_layout Enumerate
16826 may look prettier here.
16829 \begin_layout Enumerate
16833 Multiple spaces detected in output.
16836 \begin_layout Enumerate
16839 This text may be ignored.
16842 \begin_layout Enumerate
16848 \begin_inset Quotes eld
16853 to begin quotation, not
16860 \begin_layout Enumerate
16867 to end quotation, not
16870 \begin_inset Quotes eld
16878 \begin_layout Enumerate
16884 \begin_layout Enumerate
16887 You should perhaps use
16888 \begin_inset Quotes eld
16896 \begin_inset Quotes erd
16902 \begin_layout Enumerate
16905 You should put a space in front of/after parenthesis.
16908 \begin_layout Enumerate
16911 You should avoid spaces in front of/after parenthesis.
16914 \begin_layout Enumerate
16918 You should not use punctuation in front of/after quotes.
16921 \begin_layout Enumerate
16924 Double space found.
16927 \begin_layout Enumerate
16930 You should put punctuation outside inner/inside display math mode.
16933 \begin_layout Enumerate
16936 You ought to not use primitive TeX in LaTeX code.
16939 \begin_layout Enumerate
16942 You should remove spaces in front of
16943 \begin_inset Quotes eld
16951 \begin_inset Quotes erd
16957 \begin_layout Enumerate
16960 \begin_inset Quotes eld
16968 \begin_inset Quotes erd
16971 is normally not followed by
16972 \begin_inset Quotes eld
16980 \begin_inset Quotes erd
16986 \begin_layout Standard
16987 In later versions of LyX, we hope to provide a more complete interface to
16988 this tool (and it's smaller cousin
16992 ) to exploit the full power of it.
16993 But it's not exactly useless as it is now: go try it on one of your existing
16994 documents of a certain length and be surprised.
16997 \begin_layout Section
16998 Version Control in LyX
17001 \begin_layout Standard
17004 Lars Gullik Bjønnes
17007 \begin_layout Subsection
17011 \begin_layout Standard
17012 A friend of mine wanted to try LyX for a group project.
17013 When he didn't find support for version control or file locking, he dropped
17015 This angered me a bit, so I thought that I should at least make support
17016 for RCS (with the possibility of CVS and/or SCCS as a future improvement.)
17017 This has now been done.
17018 LyX now supports some of the most basic RCS commands.
17019 If you need to something a bit more sophisticated you will have to do that
17020 manually in an xterm.
17023 \begin_layout Standard
17024 Before you begin to use the version control features in LyX, you should
17026 \begin_inset Quotes eld
17030 \begin_inset Quotes erd
17033 (a man file, read it with
17038 This file describes all the basic features of RCS.
17039 You should especially notice the comment about a RCS directory, and the
17040 notion of a master RCS file (the file ending in
17047 \begin_layout Standard
17048 The implementation in LyX assumes a recent version of the GNU RCS package---no
17049 guarantees are made for older versions.
17052 \begin_layout Subsection
17053 RCS commands in LyX
17056 \begin_layout Standard
17057 The following sections describe the RCS commands supported by LyX.
17058 You can find them in the
17063 ile\SpecialChar \menuseparator
17068 ersion\InsetSpace ~
17074 \begin_layout Subsubsection
17080 \begin_layout Standard
17081 If your document is not under revision control, this is the only item shown
17083 And if it is under revision control, the
17090 item is grayed out.
17094 \begin_layout Standard
17095 This command registers your document with RCS\SpecialChar \@.
17096 You are asked interactively
17097 to supply an initial description of the document.
17098 The document is now set in Read-Only mode and you have to
17105 , before making any changes to it.
17106 A document under revision control has a
17107 \begin_inset Quotes eld
17110 [RCS:<version> <locker>]
17111 \begin_inset Quotes erd
17114 item tagged to the filename in the minibuffer.
17117 \begin_layout Standard
17118 RCS command that is run:
17120 ci -q -u -i -t-"<initial description>" <file-name>
17123 \begin_layout Standard
17128 to understand the switches.
17132 \begin_layout Subsubsection
17138 \begin_layout Standard
17139 When you are finished editing a file, you check in your changes.
17140 When you do this, you are asked for a description of the changes.
17141 This is stored in the history log.
17142 The version number is bumped, your changes are applied to the master RCS
17143 file, the document is unlocked and set to Read-Only mode.
17147 \begin_layout Standard
17150 ci -q -u -m"<description>" <file-name>
17153 \begin_layout Subsubsection
17159 \begin_layout Standard
17160 By doing this you lock the document so that only you can edit it.
17161 This will also make the document Read-Write only for you.
17162 You will usually continue editing for a while and when you are finished
17163 you check in your changes.
17164 The status line is changed to reflect that you have locked the file.
17168 \begin_layout Standard
17171 co -q -l <file-name>
17174 \begin_layout Subsubsection
17177 Revert To Last Version
17180 \begin_layout Standard
17181 This will discard all changes made to the document since the last check
17183 You get a warning before changes are discarded.
17186 \begin_layout Standard
17189 co -f -u<version> <file-name>
17192 \begin_layout Subsubsection
17198 \begin_layout Standard
17199 This makes as if the last check in never happened.
17200 No changes are made to the document loaded into LyX, but the last version
17201 is removed from the master RCS file.
17205 \begin_layout Standard
17208 rcs -o<version> <file-name>
17211 \begin_layout Subsubsection
17217 \begin_layout Standard
17218 This show the complete history of the RCS document.
17223 is shown in a browser.
17231 \begin_layout Section
17232 Literate Programming
17235 \begin_layout Standard
17240 (kayvan@sylvan.com)
17244 original documentation written by
17246 Edmar Wienskoski Jr.
17249 (edmar-w-jr@technologist.com)
17252 \begin_layout Subsection
17256 \begin_layout Standard
17257 The main purpose of this documentation is to show you how to use LyX for
17258 literate programming.
17259 Where it is assumed that you are familiar with this programming technique,
17261 \begin_inset Quotes eld
17265 \begin_inset Quotes erd
17269 \begin_inset Quotes eld
17273 \begin_inset Quotes erd
17277 If that is not the case, please follow the web links provided in the following
17279 There is a lot of good documentation out there covering old development
17280 history to the latest tools tips.
17283 \begin_layout Standard
17284 It is also assumed that you are familiar with LyX itself to a point that
17285 you are comfortable changing your LyX preferences, and X resources file.
17286 If that is not the case please refer to other LyX documentation to cover
17287 your specific needs.
17290 \begin_layout Subsection
17291 Literate Programming
17294 \begin_layout Standard
17295 From the Literate Programming FAQ:
17298 \begin_layout Quotation
17299 Literate programming is the combination of documentation and source together
17300 in a fashion suited for reading by human beings.
17301 In fact, literate programs should be enjoyable reading, even inviting!
17302 (Sorry Bob, I couldn't resist!) In general, literate programs combine source
17303 and documentation in a single file.
17304 Literate programming tools then parse the file to produce either readable
17305 documentation or compilable source.
17306 The WEB style of literate programming was created by D.E.
17307 Knuth during the development of his TeX typesetting software.
17311 \begin_layout Standard
17312 Another excerpt says:
17315 \begin_layout Quotation
17318 How is literate programming different from verbose commenting?
17321 \begin_layout Quotation
17322 There are three distinguishing characteristics.
17323 In order of importance, they are:
17327 \begin_layout Itemize
17328 flexible order of elaboration
17331 \begin_layout Itemize
17332 automatic support for browsing
17335 \begin_layout Itemize
17336 typeset documentation, especially diagrams and mathematics
17340 \begin_layout Standard
17341 Now that I sparked your curiosity, take a look in the references.
17344 \begin_layout Subsubsection
17348 \begin_layout Standard
17349 The complete Literate Programming FAQ can be found at:
17352 \begin_layout Quote
17353 \begin_inset LatexCommand url
17354 name "Literate Programming FAQ"
17355 target "http://shelob.ce.ttu.edu/daves/lpfaq/faq.html"
17362 \begin_layout Standard
17363 The FAQ lists 23 (twenty three!) different literate programming tools.
17364 Where some are specialized or
17365 \begin_inset Quotes eld
17369 \begin_inset Quotes erd
17372 for particular programming languages, while other have general scope.
17377 for my own use for several reasons:
17380 \begin_layout Itemize
17381 It can generate the documentation either in LaTeX or HTML.
17384 \begin_layout Itemize
17385 It has a open architecture, i.e., it is easy to plug in new filters and to
17386 perform special processing that you may need.
17390 \begin_layout Itemize
17391 There is a good selection of filters available already (the HTML is one
17395 \begin_layout Itemize
17399 \begin_layout Standard
17400 The Noweb web page can be found at:
17403 \begin_layout Quote
17404 \begin_inset LatexCommand url
17405 name "Noweb home page"
17406 target "http://www.cs.virginia.edu/~nr/noweb/"
17413 \begin_layout Standard
17414 Starting from there you can reach many other interesting links and even
17415 some literate program examples.
17418 \begin_layout Subsection
17419 \begin_inset LatexCommand label
17420 name "sub:LyX-and-Literate"
17424 LyX and Literate Programming
17427 \begin_layout Standard
17428 The LyX support for Literate Programming is provided by using the generic
17429 LyX convertors mechanism.
17430 This support is provided in a
17431 \begin_inset Quotes eld
17435 \begin_inset Quotes erd
17438 way, i.e., you will be able to use this new LyX feature with some other literate
17439 programming tool of your choice by just changing your LyX preferences.
17442 \begin_layout Subsubsection
17443 Generating documents and code (weaving and tangling)
17446 \begin_layout Paragraph
17447 Selecting the document class
17450 \begin_layout Standard
17451 If you have installed Noweb and LyX successfully, whenever you open a new
17452 document or try to change the document class of an existing one, you will
17453 find that there are three new document classes available:
17456 \begin_layout Itemize
17460 \begin_layout Itemize
17464 \begin_layout Itemize
17468 \begin_layout Standard
17469 You must select one of them to create your literate documents from.
17473 \begin_layout Standard
17474 Note that literate documents are not limited to these three classes.
17475 New classes can be generated from other styles like letter or in combination
17476 with other class variations like Article (AMS).
17477 If you have special needs that cannot be covered by one of the existing
17478 classes, let the LyX developers list (lyx-devel@lists.lyx.org) know and we
17479 will arrange to insert a new entry, or teach you how to do it.
17483 \begin_layout Standard
17484 It is very simple, it involves the creation of a file with four lines, and
17485 re-running of the auto configuration.
17490 Moreover, if you use a literate tool other than Noweb you may need to create
17491 a new set of document classes for it.
17494 \begin_layout Paragraph
17498 \begin_layout Standard
17499 LyX enables you to write code with a layout named
17507 \begin_layout Standard
17508 The equivalent Noweb term is
17509 \begin_inset Quotes eld
17513 \begin_inset Quotes erd
17517 For historical reasons, I got used to the term
17518 \begin_inset Quotes eld
17522 \begin_inset Quotes erd
17525 introduced by other literate tool named Nuweb, which I used for many years
17526 before rendering myself to Noweb.
17531 Noweb delimits scraps like this:
17534 \begin_layout LyX-Code
17538 \begin_layout LyX-Code
17542 \begin_layout LyX-Code
17546 \begin_layout LyX-Code
17550 \begin_layout LyX-Code
17554 \begin_layout Standard
17555 The problem is that whatever is written in between the << and the
17559 must be taken literally, i.e., LyX should be prevented from making any special
17560 interpretation of what has been written.
17561 This is handled by a special layout named Scrap, that works like a normal
17562 paragraph but has a free spacing capability.
17565 \begin_layout Standard
17566 The down side of the Scrap paragraph layout is that consecutive paragraphs
17567 of code will be spaced with one empty line in the source code and also
17568 in the printed documentation.
17569 The work around is to enter each line of code within a single Scrap, with
17570 a newline (ctrl-return).
17571 The example above will look like this:
17575 \begin_layout Standard
17576 If you have a printed version of this document you will not see any difference
17577 between the previous example and this one.
17585 \begin_layout LyX-Code
17597 \begin_layout Standard
17598 This layout works fine.
17599 The only real inconvenience is that you have to type ctrl-return instead
17604 \begin_layout Standard
17605 It is in my list of
17606 \begin_inset Quotes eld
17610 \begin_inset Quotes erd
17621 \begin_layout Standard
17622 As a special note, you can also use the
17623 \begin_inset Quotes eld
17627 \begin_inset Quotes erd
17630 construct of Noweb in your scraps to add items to Noweb's identifier cross-refe
17634 \begin_layout LyX-Code
17637 def some_function(args):
17639 "This is the doc string for this
17642 print "My args: ", args
17645 \begin_layout LyX-Code
17646 @ %def some_function
17649 \begin_layout Standard
17650 For an example of this usage and the resulting cross-reference output, look
17651 at the Literate python program in
17653 LIBDIR/examples/listerrors.lyx
17655 which should make this all clear.
17658 \begin_layout Paragraph
17659 Generating the documentation
17662 \begin_layout Standard
17663 At this point you already have a new document file with a proper document
17664 class, and with some code and text on it.
17665 How do I print it? The answer is simple, you select
17670 iew\SpecialChar \menuseparator
17678 Just like you would do for a plain document.
17679 No special procedure is required.
17682 \begin_layout Standard
17683 To help orientate you, I will now explain what happens inside LyX:
17686 \begin_layout Enumerate
17692 pdate\SpecialChar \menuseparator
17699 menu option is chosen, a LaTeX file is generated.
17704 \begin_layout Standard
17705 If the document is of any literate class the generated file will be named
17706 with an extension name defined by the
17707 \begin_inset Quotes eld
17711 \begin_inset Quotes erd
17714 format (defined in the Preferences panel), otherwise the file will have
17723 \begin_layout Enumerate
17724 Note that the only difference so far is in the name of the file, no special
17725 processing is required by LyX.
17726 Given that you formatted the code using the Scrap layout that, by itself,
17727 takes care of the business.
17730 \begin_layout Enumerate
17731 If the document is of any literate class LyX will then use the internal
17732 LyX to Noweb converter, followed by the Noweb to LaTeX converter
17736 \begin_layout Standard
17737 The converters are defined in the
17742 ools\SpecialChar \menuseparator
17750 \begin_inset Quotes eld
17754 \begin_inset Quotes erd
17762 to generate the LaTeX file.
17766 \begin_layout Standard
17767 Otherwise it will just skip this step.
17771 \begin_layout Enumerate
17772 Finally, LaTeX is invoked and the regular post processing continues as in
17776 \begin_layout Standard
17777 Independence from a particular
17778 \begin_inset Quotes eld
17782 \begin_inset Quotes erd
17785 is easily achieved by changing the commands that are run by the various
17789 \begin_layout Paragraph
17790 Generating the code
17793 \begin_layout Standard
17794 When the build menu option is chosen or the corresponding button in the
17795 toolbar is pressed, a LaTeX file is generated just like step 1 above.
17796 Next, LyX invokes the
17801 Typically, this converter (like any other converter), has two parts:
17804 \begin_layout Enumerate
17805 The converter program itself.
17806 This program performs the conversion from the one format to the other (in
17807 this case, from the Noweb format to the Program pseudo-format).
17810 \begin_layout Enumerate
17811 The error log parser.
17812 This is a program whose sole purpose is to rewrite error messages in a
17813 format that LyX understands.
17814 This makes it possible for LyX to place error boxes in the right places
17815 in the file buffer.
17818 \begin_layout Standard
17819 The first part, the
17820 \begin_inset Quotes eld
17824 \begin_inset Quotes erd
17827 setting, should be set to
17828 \begin_inset Quotes eld
17836 \begin_inset Quotes erd
17840 This basically means that LyX will call
17841 \begin_inset Quotes eld
17845 \begin_inset Quotes erd
17848 (a program or script) with the name of the Noweb file (generally a file
17849 in the LyX temp directory).
17853 \begin_layout Standard
17854 This is an implementation of
17855 \begin_inset Quotes eld
17859 \begin_inset Quotes erd
17862 that you can place in a directory on your path:
17865 \begin_layout LyX-Code
17869 \begin_layout LyX-Code
17873 \begin_layout LyX-Code
17874 notangle -Rbuild-script $1 | env NOWEB_SOURCE=$1 sh
17877 \begin_layout Standard
17878 The next part of the converter setting is the
17879 \begin_inset Quotes eld
17883 \begin_inset Quotes erd
17886 which is to be set to
17887 \begin_inset Quotes eld
17892 originaldir,parselog=listerrors
17895 \begin_inset Quotes erd
17899 This will run any errors that are generated by the
17900 \begin_inset Quotes eld
17904 \begin_inset Quotes erd
17907 process through the
17908 \begin_inset Quotes eld
17912 \begin_inset Quotes erd
17918 \begin_layout Standard
17919 The converter code looks in
17927 then on the path for the
17928 \begin_inset Quotes eld
17932 \begin_inset Quotes erd
17938 \begin_layout Paragraph
17939 Build instructions in the document
17942 \begin_layout Standard
17943 The last piece of the integration between LyX and noweb is the
17944 \begin_inset Quotes eld
17948 \begin_inset Quotes erd
17952 Generally, the instructions for building your program should be embedded
17953 in a scrap of its own.
17955 \begin_inset Quotes eld
17959 \begin_inset Quotes erd
17962 above uses the notangle command to look for this scrap (called
17963 \begin_inset Quotes eld
17967 \begin_inset Quotes erd
17970 ) and runs its contents through
17971 \begin_inset Quotes eld
17975 \begin_inset Quotes erd
17981 \begin_layout Standard
17982 Typically, such a scrap would look something like this:
17985 \begin_layout LyX-Code
17992 if [ -z "${NOWEB_SOURCE}" ]
17996 NOWEB_SOURCE=myfile.nw
18002 code to extract files ...]
18005 code to compile files ...]
18010 \begin_layout Standard
18013 LIBDIR/examples/listerrors.lyx
18017 LIBDIR/examples/Literate.lyx
18019 which implement two versions of the
18020 \begin_inset Quotes eld
18024 \begin_inset Quotes erd
18027 program for some illustrations of how all of these pieces go together or
18030 LIBDIR/examples/noweb2lyx.lyx.
18033 Interestingly, these three files show off the language-indepence of the
18034 LyX literate programming support since they are written in Python, C and
18038 \begin_layout Subsubsection
18042 \begin_layout Standard
18043 All the Literate Programming support is configured by the
18048 ools\SpecialChar \menuseparator
18056 \begin_inset Quotes eld
18060 \begin_inset Quotes erd
18064 The important parts are:
18067 \begin_layout Description
18070 \begin_inset Quotes eld
18074 \begin_inset Quotes erd
18078 format Set up via the Formats tab, this is where the Noweb-specific pieces
18088 , the file extension is set to
18093 This tells LyX to create a file with a
18097 extension in the first step of the conversion process.
18100 \begin_layout Description
18107 format This is an empty format whose sole purpose is to be the endpoint
18108 of a conversion (which then allows us to set up a converter for it).
18111 \begin_layout Description
18120 This converter performs the
18121 \begin_inset Quotes eld
18125 \begin_inset Quotes erd
18128 of the literate document.
18129 For Noweb, it is set to
18130 \begin_inset Quotes eld
18135 noweave -delay -index $$i > $$o
18138 \begin_inset Quotes erd
18144 \begin_layout Description
18154 \begin_inset Quotes eld
18158 \begin_inset Quotes erd
18162 As stated above, the Converter is set to
18163 \begin_inset Quotes eld
18171 \begin_inset Quotes erd
18174 , with Flags set to
18175 \begin_inset Quotes eld
18180 originaldir,parselog=listerrors
18183 \begin_inset Quotes erd
18189 \begin_layout Subsubsection
18193 \begin_layout Standard
18194 There is also a new function implemented in the LyX server, the
18195 \begin_inset Quotes eld
18198 server-goto-file-row" function, to be used with ddd/gdb or other debugger.
18202 \begin_layout Standard
18203 When debugging code with ddd/gdb, it is possible to invoke a text editor
18204 at the current execution position with a single key stroke.
18205 The default ddd configuration for that is shift-ctrl-V.
18206 It happens that you can define the editor command line invocation in ddd
18212 dit\SpecialChar \menuseparator
18217 references\SpecialChar \menuseparator
18224 dialog and changing the "Edit Sources" entry.
18227 \begin_layout Standard
18228 I take advantage of the new created LyX server function and this ddd feature,
18230 \begin_inset Quotes eld
18234 \begin_inset Quotes erd
18240 \begin_layout LyX-Code
18241 echo "LYXCMD:monitor:server-goto-file-row:@FILE@ @LINE@" >~/.lyxpipe.in
18244 \begin_layout Standard
18245 With this, whenever you are using ddd and find a point in the program that
18246 you want to edit, you just press shift-ctrl-V (in the ddd window), and
18247 ddd you forward this information to LyX through the LyX server and then
18248 the LyX window will show the same file with the cursor at the same position
18249 ddd was pointing to.
18250 No more guessing or long scrolling to locate a point in the program back
18254 \begin_layout Standard
18255 Note however that you must enable the LyX server to get this feature working
18256 (it is disabled by default).
18257 You can enable it in
18269 ) by entering in the
18274 \begin_inset Quotes eld
18279 /home/<your-home-directory>/.lyx/lyxpipe
18282 \begin_inset Quotes erd
18288 \begin_layout Standard
18289 Read the LyX server documentation in the
18291 Customization Manual
18293 for further information.
18296 \begin_layout Subsubsection
18300 \begin_layout Standard
18301 There are six new buttons that can be added to your LyX toolbar.
18302 Five of these buttons are short cuts to layout styles:
18323 The last one is a short cut to the
18324 \begin_inset Quotes eld
18328 \begin_inset Quotes erd
18335 \begin_layout Standard
18336 LyX has a range of buttons that are available for tool bar customization.
18337 In my toolbar I like to combine the six short cuts above with two more:
18345 \SpecialChar \menuseparator
18353 \SpecialChar \menuseparator
18366 iew\SpecialChar \menuseparator
18374 Here is how it looks like:
18377 \begin_layout LyX-Code
18381 \begin_layout LyX-Code
18385 \begin_layout LyX-Code
18386 Icon "layout Standard"
18389 \begin_layout LyX-Code
18390 Icon "layout Section"
18393 \begin_layout LyX-Code
18394 Icon "layout LaTeX"
18397 \begin_layout LyX-Code
18398 Icon "layout LyX-Code"
18401 \begin_layout LyX-Code
18402 Icon "layout Scrap"
18405 \begin_layout LyX-Code
18409 \begin_layout LyX-Code
18413 \begin_layout LyX-Code
18414 Icon "buffer-typeset"
18417 \begin_layout LyX-Code
18418 Icon "build-program"
18421 \begin_layout LyX-Code
18425 \begin_layout LyX-Code
18429 \begin_layout LyX-Code
18433 \begin_layout LyX-Code
18437 \begin_layout LyX-Code
18441 \begin_layout Subsubsection
18442 Colors customization
18445 \begin_layout Standard
18446 There are a number of colors in LyX that can be customized in
18451 One of the things that bothers people is the LaTeX font color.
18452 The default color is red, since the scraps uses LaTeX font, and there is
18453 a lot of scraps in literate documents, you may get tired of seeing everything
18455 You can change it by going to the tabs
18464 \begin_layout Standard
18465 The next thing is the visible presence of the newline character in the screen.
18466 You can choose the color of this particular character and make it blend
18468 I recommend you choosing a color that is close to the background but not
18469 equal, that way you still can see it is there, but it is not bothering
18474 \begin_layout Chapter
18475 Secrets of the LaTeX Masters
18476 \begin_inset LatexCommand label
18484 \begin_layout Standard
18485 Though LyX is a powerful tool, it cannot hope to support everything that
18486 can be done with pure TeX/LaTeX.
18487 However, many familiar dirty TeX and LaTeX tricks can be done within LyX,
18488 as long as you are not afraid to use that
18489 \begin_inset Quotes eld
18493 \begin_inset Quotes erd
18496 button on the toolbar or add things to the LaTeX preamble.
18497 This section lists some tips, tricks, and otherwise cool ideas to give
18498 your document that extra little flair.
18501 Do try this at home
18503 , just start with something a little smaller and less important than your
18507 \begin_layout Standard
18508 Most ideas in this section require less common files in your LaTeX installation.
18509 If you have a system like teTeX, most will already be available.
18510 A few, however, will need to be downloaded from one of the CTAN archives.
18511 Often, there are several ways to do something, or several LaTeX style files
18512 which do the same thing.
18513 We do not endorse one choice over another, we simply claim that we have
18514 done a particular task with a particular file.
18515 Put on your wizard hat, keep an eye out for dragons, and let us begin.
18518 \begin_layout Section
18522 \begin_layout Standard
18525 Lars Gullik Bjønnes
18528 \begin_layout Subsection
18532 \begin_layout Standard
18533 The aim for this chapter
18537 \begin_layout Standard
18538 Editor's note: Lars' original chapter was a masterful description of how
18544 However, it was too long to flow smoothly in this document.
18545 I have therefore chosen to excerpt the most important sections here (sorry,
18546 Lars); you can read the original chapter (and more of the story!) in the
18549 examples/multicol.lyx
18557 is to show how the LaTeX package
18561 can be used in a LyX document.
18562 As LyX doesn't support the
18566 package natively yet, we have to use some small hacks.
18567 By reading this section it should be obvious how to do this.
18570 \begin_layout Subsection
18574 \begin_layout Standard
18579 package allows switching between one and multicolumn format on the same
18581 Footnotes are handled correctly (for the most part), but will be placed
18582 at the bottom of the page and not under each column.
18583 LaTeX's float mechanism, however, is partly disabled in the current implementat
18585 At the moment only page-wide floats can be used within the scope of the
18589 \begin_layout Subsection
18593 \begin_layout Subsubsection
18597 \begin_layout Standard
18598 If you want to have two columns in your text, you have use LaTeX mode to
18603 begin{multicols}{2}
18605 at the point where you want the two column layout to start, and then
18611 where you want it to end.
18615 \begin_layout Standard
18619 \begin_layout Standard
18623 begin{multicols}{2}
18631 \begin_layout Standard
18636 The Adventure of the Empty House
18642 Sir Arthur Conan Doyle
18645 \begin_layout Standard
18648 It was in the spring of the year 1894 that all London was interested, and
18649 the fashionable world dismayed, by the murder of the Honourable Ronald
18650 Adair under most unusual and inexplicable circumstances.
18651 The public has already learned those particulars of the crime which came
18652 out in the police investigation, but a good deal was suppressed upon that
18653 occasion, since the case for the prosecution was so overwhelmingly strong
18654 that it was not necessary to bring forward all the facts.
18655 Only now, at the end of nearly ten years, am I allowed to supply those
18656 missing links which make up the whole of that remarkable chain.
18657 The crime was of interest in itself, but that interest was as nothing to
18658 me compared to the inconceivable sequel, which afforded me the greatest
18659 shock and surprise of any event in my adventurous life.
18660 Even now, after this long interval, I find myself thrilling as I think
18661 of it, and feeling once more that sudden flood of joy, amazement, and increduli
18662 ty which utterly submerged my mind.
18663 Let me say to that public, which has shown some interest in those glimpses
18664 which I have occasionally given them of the thoughts and actions of a very
18665 remarkable man, that they are not to blame me if I have not shared my knowledge
18666 with them, for I should have considered it my first duty to do so, had
18667 I not been barred by a positive prohibition from his own lips, which was
18668 only withdrawn upon the third of last month.
18671 \begin_layout Standard
18675 \begin_layout Standard
18687 \begin_layout Subsubsection
18691 \begin_layout Standard
18692 The same pattern is used when you want more than two columns:
18695 \begin_layout Standard
18699 \begin_layout Standard
18703 begin{multicols}{3}
18711 \begin_layout Standard
18714 It can be imagined that my close intimacy with Sherlock Holmes had interested
18715 me deeply in crime, and that after his disappearance I never failed to
18716 read with care the various problems which came before the public.
18717 And I even attempted, more than once, for my own private satisfaction,
18718 to employ his methods in their solution, though with indifferent success.
18719 There was none, however, which appealed to me like this tragedy of Ronald
18721 As I read the evidence at the inquest, which led up to a verdict of willful
18722 murder against some person or persons unknown, I realized more clearly
18723 than I had ever done the loss which the community had sustained by the
18724 death of Sherlock Holmes.
18725 There were points about this strange business which would, I was sure,
18726 have specially appealed to him, and the efforts of the police would have
18727 been supplemented, or more probably anticipated, by the trained observation
18728 and the alert mind of the first criminal agent in Europe.
18729 All day, as I drove upon my round, I turned over the case in my mind and
18730 found no explanation which appeared to me to be adequate.
18731 At the risk of telling a twice-told tale, I will recapitulate the facts
18732 as they were known to the public at the conclusion of the inquest.
18735 \begin_layout Standard
18739 \begin_layout Standard
18751 \begin_layout Standard
18752 You can have more than 3 columns if you want to, but that might not be very
18753 pleasant for the eye.
18756 \begin_layout Subsubsection
18757 Columns inside columns
18760 \begin_layout Standard
18761 You can even have columns inside columns:
18764 \begin_layout Standard
18768 \begin_layout Standard
18772 begin{multicols}{2}
18780 \begin_layout Standard
18783 The Honourable Ronald Adair was the second son of the Earl of Maynooth,
18784 at that time governor of one of the Australian colonies.
18785 Adair's mother had returned from Australia to undergo the operation for
18786 cataract, and she, her son Ronald, and her daughter Hilda were living together
18790 \begin_layout Standard
18794 \begin_layout Standard
18798 begin{multicols}{2}
18806 \begin_layout Standard
18809 The youth moved in the best society--had, so far as was known, no enemies
18810 and no particular vices.
18811 He had been engaged to Miss Edith Woodley, of Carstairs, but the engagement
18812 had been broken off by mutual consent some months before, and there was
18813 no sign that it had left any very profound feeling behind it.
18814 For the rest {sic} the man's life moved in a narrow and conventional circle,
18815 for his habits were quiet and his nature unemotional.
18816 Yet it was upon this easy-going young aristocrat that death came, in most
18817 strange and unexpected form, between the hours of ten and eleven-twenty
18818 on the night of March 30, 1894.
18821 \begin_layout Standard
18825 \begin_layout Standard
18837 \begin_layout Standard
18840 Ronald Adair was fond of cards--playing continually, but never for such
18841 stakes as would hurt him.
18842 He was a member of the Baldwin, the Cavendish, and the Bagatelle card clubs.
18843 It was shown that, after dinner on the day of his death, he had played
18844 a rubber of whist at the latter club.
18845 He had also played there in the afternoon.
18850 The evidence of those who had played with him-- Mr.
18851 Murray, Sir John Hardy, and Colonel Moran--showed that the game was whist,
18852 and that there was a fairly equal fall of the cards.
18853 Adair might have lost five pounds, but not more.
18854 His fortune was a considerable one, and such a loss could not in any way
18856 He had played nearly every day at one club or other, but he was a cautious
18857 player, and usually rose a winner.
18858 It came out in evidence that, in partnership with Colonel Moran, he had
18859 actually won as much as four hundred and twenty pounds in a sitting, some
18860 weeks before, from Godfrey Milner and Lord Balmoral.
18861 So much for his recent history as it came out at the inquest.
18864 \begin_layout Standard
18868 \begin_layout Standard
18880 \begin_layout Standard
18881 Please do read the file
18883 examples/multicol.lyx
18885 for more advanced examples including column and header spacing, vertical
18886 separator lines, and more.
18889 \begin_layout Section
18894 Paragraph Environment
18895 \begin_inset OptArg
18898 \begin_layout Standard
18899 Numbering in Enumerate
18907 \begin_layout Standard
18913 \begin_layout Standard
18914 \begin_inset VSpace bigskip
18920 \begin_layout Standard
18922 The default numbering for the
18926 paragraph environment begins with Arabic numbers and ends with uppercase
18928 Suppose, however, you wanted a different type of numbering scheme.
18929 Here's a quickie example of how to change the numbering scheme:
18932 \begin_layout LyX-Code
18942 \begin_layout LyX-Code
18952 \begin_layout LyX-Code
18962 \begin_layout LyX-Code
18972 \begin_layout Standard
18973 \SpecialChar \ldots{}
18974 which changes the numbering scheme to uppercase Roman numerals, uppercase
18975 letters, Arabic numbers, and lowercase letter.
18978 \begin_layout Standard
18979 Additionally, the previous example also adds a little bit extra to the numbering
18981 For example, the first level label actually looks like:
18982 \begin_inset Quotes eld
18986 \begin_inset Quotes erd
18990 For ease of reading, we'll describe what the numbering schemes look like
18991 using a notation something like this: <
18992 \begin_inset Quotes eld
18996 \begin_inset Quotes erd
19001 \begin_inset Quotes erd
19005 \begin_inset Quotes erd
19010 \begin_inset Quotes erd
19014 \begin_inset Quotes erd
19019 \begin_inset Quotes eld
19023 \begin_inset Quotes erd
19030 \begin_layout Standard
19031 As you can see in the example, there is a label command for each nesting
19038 \SpecialChar \ldots{}
19045 , as well as a counter,
19049 \SpecialChar \ldots{}
19055 There are also five
19056 \begin_inset Quotes eld
19060 \begin_inset Quotes erd
19093 , each of which take one counter as an argument.
19094 You can add characters before or after these, but there's no need to add
19098 \begin_layout Standard
19099 You can get really fancy with these.
19103 \begin_layout LyX-Code
19117 \begin_layout LyX-Code
19129 \begin_layout LyX-Code
19139 \begin_layout LyX-Code
19149 \begin_layout Standard
19150 produces the somewhat out of hand numbering scheme: <
19151 \begin_inset Quotes eld
19155 \begin_inset Quotes erd
19160 \begin_inset Quotes erd
19164 \begin_inset Quotes erd
19169 \begin_inset Quotes erd
19173 \begin_inset Quotes erd
19178 \begin_inset Quotes eld
19182 \begin_inset Quotes erd
19189 \begin_layout Standard
19193 \begin_layout Section
19197 \begin_layout Standard
19203 \begin_layout Standard
19204 \begin_inset VSpace bigskip
19210 \begin_layout Standard
19215 \begin_layout Standard
19221 tmpfont}{cmr17 scaled 2500}{
19233 \begin_layout Standard
19238 \begin_layout Standard
19249 hose of you who like the style of old books probably also like
19250 \begin_inset Quotes eld
19254 \begin_inset Quotes erd
19257 ---those large capital letters which begin each new chapter or section.
19258 Implementing them with plain LyX/LaTeX is straightforward (assuming you
19259 know some plain TeX!) but does require a lot of work and many iterations,
19260 as you can see by all the ugly TeX-mode stuff at the beginning of this
19264 \begin_layout Standard
19268 \begin_layout Standard
19274 bigdrop{-1em}{3}{ptmri}{T}+
19279 here is a much easier way of doing this, of course.
19288 ) package from CTAN allows a simple way to add such letters to your documents.
19289 Since this package is not a standard part of teTeX, I can't demonstrate
19290 it within this document, but if you copy this paragraph to a new document,
19292 \begin_inset Quotes eld
19302 \begin_inset Quotes erd
19305 and the pluses from the TeX code at the beginning of the paragraph, and
19310 usepackage{dropcaps}
19312 to your LaTeX preamble, you will get a nice Times Roman Italic
19313 \begin_inset Quotes eld
19317 \begin_inset Quotes erd
19320 , whose height is three lines of text and which protrudes 1 em into the
19322 (Make certain you have copied
19323 \begin_inset Quotes eld
19331 \begin_inset Quotes erd
19334 into a directory where TeX can see it.) The first argument is the amount
19335 of indentation; in this case the negative sign moves it into the margin.
19336 The second argument is the height of the letter in number of lines of text.
19337 The third argument is the font name: virtually anything which has a tfm
19338 file should work (wade through the
19340 .../texmf/fonts/tfm
19342 directory for possibilities).
19343 My personal favorite is
19344 \begin_inset Quotes eld
19352 \begin_inset Quotes erd
19355 , a fancy German font specifically designed for dropped capitals.
19356 The fourth argument is the letter (or letters) to be dropped.
19361 package also offers the
19367 command, as well as a slightly simplified
19376 \begin_layout Section
19377 Non-standard Paragraph Shapes
19380 \begin_layout Standard
19386 \begin_layout Standard
19387 \begin_inset VSpace bigskip
19393 \begin_layout Standard
19397 \begin_layout Standard
19409 \begin_layout Standard
19413 \begin_layout Standard
19422 \begin_layout Standard
19436 \begin_layout Standard
19441 \begin_layout Standard
19452 \begin_layout Standard
19461 \begin_layout Standard
19470 \begin_layout Standard
19479 \begin_layout Standard
19488 \begin_layout Standard
19497 \begin_layout Standard
19506 \begin_layout Standard
19515 \begin_layout Standard
19524 \begin_layout Standard
19533 \begin_layout Standard
19542 \begin_layout Standard
19551 \begin_layout Standard
19560 \begin_layout Standard
19569 \begin_layout Standard
19578 \begin_layout Standard
19587 \begin_layout Standard
19596 \begin_layout Standard
19605 \begin_layout Standard
19614 \begin_layout Standard
19620 There are times when the tyranny of rectangular paragraphs must be overthrown.
19621 In such situations, a call to the delightful plain TeX command
19628 As you can see, completely arbitrary shapes can be laid out with a suitable
19629 set of linelength definitions.
19630 While this parshape may look a bit silly and useless, one could conceive
19631 of situations such as finely tuned dropped capitals, word wrapping around
19632 non-rectangular graphics, etc.
19633 which will benefit from such handcrafting.
19636 \begin_layout Standard
19637 \begin_inset VSpace bigskip
19643 \begin_layout Standard
19648 parshape numlines #1indent #1length #2indent #2length \SpecialChar \ldots{}
19655 is the number of lines of text which define the paragraph.
19656 If there turn out to be fewer lines, the shape is truncated; if there are
19657 more, the excess lines have the same dimensions as the last line of the
19667 entries specify the indentation of the line from the left margin, and the
19668 length of the line as measured from that point.
19669 The shape applies only to the current paragraph; everything is reset to
19670 normal for the next paragraph.
19673 \begin_layout Standard
19677 \begin_layout Standard
19689 \begin_layout Section
19693 \begin_layout Standard
19694 As you can see, the examples in this section range from the useful to the
19696 While I don't expect that anyone will ever need the paragraph shape demonstrate
19697 d in the last section, the important point is that you can do almost anything
19698 you want in LyX if you are willing to figure out how to do it in TeX and
19700 TeX is a fantastically powerful typesetting system and all that power is
19701 available to you since LyX uses it as its backend.