1 #LyX 1.5.0svn created this file. For more info see http://www.lyx.org/
8 \newcommand{\extratablespace}[1]{\noalign{\vskip#1}}
14 \font_typewriter default
15 \font_default_family default
21 \paperfontsize default
29 \paperorientation portrait
32 \paragraph_separation indent
34 \quotes_language english
37 \paperpagestyle headings
38 \tracking_changes false
54 \begin_layout Standard
56 Principal maintainer of this file is
61 If you have comments or error corrections, please send them to the LyX
62 Documentation mailing list, <lyx-docs@lists.lyx.org>.
70 \begin_layout Standard
71 \begin_inset LatexCommand tableofcontents
82 \begin_layout Standard
87 manual, which you are now reading, is essentially Part II of the
89 User's Guide\SpecialChar \@.
92 The reason for splitting this document is simple: the
96 is already huge, and it contains all of the basic features one needs to
97 know in order to prepare most documents.
98 However, the LyX Team has a long-term goal of making LyX extensible through
99 various configuration files and external packages.
100 That means that if you want to support the Fizzwizzle LaTeX package, you
101 can create a layout file for it without having to alter LyX itself.
102 We've already had contributions of several new features this way.
103 This is the place where all of that gets documented.
106 \begin_layout Standard
107 This manual also documents some special features, like fax support, version
108 control, and SGML support, which require additional software to work properly.
109 Lastly, there's a chapter of LaTeX tools and tips, things you can use to
110 spruce up your documents by directly using the powerful features of LaTeX.
115 only WYSIWYM, and will only ever interface to certain LaTeX features.
118 \begin_layout Standard
119 Of course, with all of this extra documentation,
121 Extended LyX Features
123 may itself grow too big for its britches.
124 In that case, you can just call it the
125 \begin_inset Quotes eld
129 \begin_inset Quotes erd
135 \begin_layout Standard
136 If you haven't read the
140 yet, you are definitely in the wrong manual.
145 is the first place to go, since it will direct you to the correct manual,
146 and it also describes the notation and format of all of the manuals.
147 You should also be thoroughly familiar with the
151 and all of the basic features of LyX.
155 \begin_layout Standard
156 In this document, many sections are independent articles contributed by
157 an individual and are noted as such.
158 This person is generally whoever wrote the layout file for the new document
159 class or LaTeX package, or implemented the feature.
160 If there is no mention of an author to a chapter [or chapter sections],
161 that means it was written by the LyX Documentation Team.
164 \begin_layout Standard
165 Since all the topics in this manual depend heavily on LyX's interaction
166 with LaTeX, this first chapter covers
170 the inner workings of LyX and how to direct LyX to generate exactly the
172 It is obviously for more seasoned LyX users.
175 \begin_layout Chapter
179 \begin_layout Section
183 \begin_layout Standard
184 \begin_inset LatexCommand label
185 name "sec:lyxandlatex"
189 This chapter is for both TeX-nicians and the LaTeX-curious.
190 In it, we'll explain how LyX and LaTeX work together to produce printable
192 This is the only place in any of the manuals where we assume you know something
196 \begin_layout Standard
197 At one time, we called LyX a
198 \begin_inset Quotes eld
201 WYSIWYM frontend to LaTeX,
202 \begin_inset Quotes erd
205 but that's no longer true.
206 There are frontends to LaTeX out there.
207 They are basically editors with the ability to run LaTeX and mark any errors
208 in the file you're editing.
217 run LaTeX, and it also marks errors in the file, it also does much, much
219 Thanks to the WYSIWYM concept, you don't need LaTeX to use LyX effectively.
220 LyX has also added a few extensions to LaTeX.
221 Try the following sometime: select
223 Export\SpecialChar \menuseparator
233 menu, then look at the preamble of the resulting
238 You'll notice a variety of new macros defined specifically by LyX.
239 These macros are defined automatically, according to the features you use
243 \begin_layout Standard
244 There are several commands that automatically invoke LaTeX.
248 \begin_layout Itemize
254 iew\SpecialChar \menuseparator
261 \begin_layout Itemize
267 iew\SpecialChar \menuseparator
272 pdate\SpecialChar \menuseparator
278 \begin_layout Itemize
286 \SpecialChar \menuseparator
292 \begin_layout Itemize
300 \SpecialChar \menuseparator
306 \begin_layout Standard
307 They will only invoke LaTeX if the file has changed since the last time
312 \begin_layout Standard
313 When you run LaTeX on the file you're editing, LyX performs these steps:
316 \begin_layout Enumerate
317 Convert the document to LaTeX and save to a file with the extension
328 \begin_layout Enumerate
333 file (maybe several times).
336 \begin_layout Enumerate
337 If there are any errors, insert error boxes in the document to mark where
339 These boxes are transient and are not saved along with the document.
342 \begin_layout Standard
343 If you've run LaTeX using
365 , LyX performs two more steps:
368 \begin_layout Itemize
373 to convert the DVI file to PostScript:
377 \begin_layout Itemize
383 , the output file has the extension
388 \begin_layout Itemize
397 , the output file has the extension
405 \begin_layout Itemize
410 or send the PostScript file to the printer.
413 \begin_layout Section
414 \begin_inset Quotes eld
417 Help! LyX generated an unreadable
422 \begin_inset Quotes erd
428 \begin_layout Standard
429 Die-hard LaTeX users will scream and howl this into the night, then declare
430 LyX useless, simply because they didn't RTFM.
433 \begin_layout Standard
434 We're going to set the record straight.
435 LyX produces two kinds of LaTeX files.
436 One is human readable.
437 The other is LyX readable.
438 Every time LyX executes LaTeX, it produces a LaTeX file that it can easily
444 file is not human readable.
445 Don't even try to read it.
450 file that you can send to a colleague, select
455 xport\SpecialChar \menuseparator
472 \begin_layout Section
473 Translating LaTeX files into LyX
476 \begin_layout Standard
477 You can import a LaTeX file into LyX by using the
482 ile\SpecialChar \menuseparator
487 mport\SpecialChar \menuseparator
495 This will call a program named
499 ---which will create a file
507 ---and then open that file.
510 \begin_layout Standard
515 will translate most legal LaTeX, but not everything.
516 It will leave things it doesn't understand in TeX mode, so after translating
521 , you can look for red text and hand-edit it to look right.
524 \begin_layout Standard
525 If you just want to put a piece of LaTeX code into a LyX file, see Section
526 \begin_inset LatexCommand ref
527 reference "sec:latexcodes"
534 \begin_layout Section
535 Inserting LaTeX Code into LyX Documents
536 \begin_inset LatexCommand label
537 name "sec:Inserting-LaTeX-Code"
544 \begin_layout Standard
545 \begin_inset LatexCommand label
546 name "sec:latexcodes"
550 This is a rather important point: You can always insert LaTeX code into
552 LyX simply cannot, and will probably never be able to, display every possible
554 If ever you need to insert LaTeX commands into your LyX document, you can
555 use the ERT box, which you can insert into your document with
560 nsert\SpecialChar \menuseparator
568 The ERT box comes in three forms: collapsed, open, and inlined.
569 The first two are used just like any other collapsible (foldable) box (such
570 as footnotes), and are useful for significant amounts of LaTeX commands.
572 \begin_inset Quotes eld
576 \begin_inset Quotes erd
579 ERT box displays its content as part of the button, and is useful for very
580 short sections of LaTeX commands.
585 \begin_layout Standard
595 \begin_layout Standard
596 You can switch between all three by right-clicking on the ERT.
597 Note that if you want more than one line of LaTeX commands, you cannot
598 use the inlined mode.
601 \begin_layout Standard
602 Here's an example of inserting LaTeX commands in a LyX document.
603 The code looks like this:
606 \begin_layout LyX-Code
615 This is an example for a minipage environment.
618 can put nearly everything in it, even (non-floating)
661 \begin_layout LyX-Code
665 \begin_layout Standard
666 The ERT box containing this text is directly after this paragraph.
667 Those of you reading the manual online will only see a bunch of funky text
669 Those reading a printed version of the manuals will see the actual results:
672 \begin_layout Standard
676 \begin_layout Standard
683 \begin_layout Standard
690 \begin_layout Standard
692 This is an example for a minipage environment.
693 You can put nearly everything in it, even (non-floating) figures and tables.
697 \begin_layout Standard
704 \begin_layout Standard
709 \begin_layout Standard
716 \begin_layout Standard
723 \begin_layout Standard
730 \begin_layout Standard
736 \begin_layout Standard
743 \begin_layout Standard
750 \begin_layout Standard
757 \begin_layout Standard
769 \begin_layout Standard
770 In addition to these two methods, you can also create a separate file containing
771 some complex LaTeX structure.
777 nsert\SpecialChar \menuseparator
785 to include your file (you should select the type
790 We recommend that you only do this if you have a
799 Otherwise, you'll have a big job tracking down LaTeX errors\SpecialChar \ldots{}
803 \begin_layout Standard
804 There are a few last notes to emphasize:
807 \begin_layout Itemize
808 Inside of LyX, LaTeX code appears
813 \begin_layout Itemize
818 check if your LaTeX code is correct.
821 \begin_layout Itemize
822 Beware reinventing the wheel.
825 \begin_layout Standard
826 That last note refers to two things.
827 First, LyX does have quite a few features tucked into it, and more are
829 Be sure to check the manuals to make sure that LyX doesn't have such-and-such
830 feature before you go off merrily coding LaTeX.
831 Second, there are numerous LaTeX packages out there to do all sorts of
832 things, from labels to envelopes to fancy multipage tables.
833 Check out a CTAN site for details (see Section
834 \begin_inset Quotes eld
838 \begin_inset Quotes erd
849 \begin_layout Standard
854 : I seem to do this an awful lot.
855 Sat down and merrily began coding something to print out labels, only to
856 learn that there were already 2 different LaTeX packages to do this.
857 Worse yet --- I had them already!
865 \begin_layout Standard
866 If you do need to do some wild and fancy things within your document, be
867 sure to check out a good LaTeX book for assistance.
868 There are a number of them listed in the bibliography of the
875 \begin_layout Standard
876 There are a number of LaTeX commands which have to be placed before the
877 beginning of the actual text.
878 They go into the preamble, and this is explained in the next section.
881 \begin_layout Section
882 LyX and the LaTeX Preamble
885 \begin_layout Subsection
886 About the LaTeX Preamble
889 \begin_layout Standard
890 \begin_inset LatexCommand label
895 If you already know LaTeX, there is no need to explain here what the preamble
897 If you don't, the following will give you some ideas --- we recommend again
898 that you consult a LaTeX book for further information.
899 In any case, you should read the points below, because they explain what
900 you can do and what you don't need to do in the LaTeX preamble of a LyX
904 \begin_layout Standard
905 The LaTeX preamble comes at the very beginning of a document,
913 \begin_layout Itemize
914 declare the document class.
915 LyX already does this for you.
919 \begin_layout Standard
920 If you're a seasoned LaTeX-nician, and you have some custom document class
921 you want to use, check out the
925 for information on how to make LyX interface to it.
926 Be sure to submit your efforts to the LyX Team for inclusion in future
931 \begin_layout Itemize
932 declare the usage of packages.
933 LaTeX packages provide special commands, which are only available within
934 a document when the package has been declared in the preamble.
943 forces all paragraphs to be indented.
944 There are other packages for labels, envelopes, margins, etc.
948 \begin_layout Itemize
949 set counters, variables, lengths and widths.
950 There are several LaTeX counters and variables which
954 be set globally from within the preamble in order to have the desired effect.
955 [There are other variables which you can set and reset inside the document,
956 too.] Margins are a good example of something which must be set in the preamble.
957 Another example is the label format for lists.
958 You can actually set these just about anywhere, but it's best to do it
959 just once, inside the preamble.
962 \begin_layout Itemize
963 declare user defined commands [with
975 ], mostly abbreviations for LaTeX commands which appear very often inside
977 Although the preamble is a good place to declare such commands, they
981 be declared anywhere else [but
985 they are used for the first time, of course\SpecialChar \ldots{}
987 This can be useful if there is a lot of raw LaTeX code in your document,
988 which normally should not be the case.
991 \begin_layout Standard
992 LyX adds its own set of definitions to the preamble of the
997 This makes LaTeX files generated by LyX portable.
1000 \begin_layout Subsection
1001 Changing the Preamble
1004 \begin_layout Standard
1005 The commands which LyX adds to the preamble of a LaTeX file are fixed; you
1006 can't change them without patching LyX itself.
1007 You can, however, add your own stuff to the preamble.
1008 There are two ways to do this:
1011 \begin_layout Enumerate
1038 \SpecialChar \menuseparator
1046 dialog, depending on your frontend.
1047 Note that the LyX keybindings will not work in this dialog, alas.
1050 \begin_layout Enumerate
1051 Use the preamble contents you've added as your default template (see
1052 \begin_inset Quotes eld
1056 \begin_inset Quotes erd
1063 ), so that it will be the default preamble for any file you create.
1066 \begin_layout Standard
1067 LyX adds anything in the
1074 dialog to its own built-in preamble.
1075 Before adding your own declarations in the preamble, you should make sure
1076 that LyX doesn't already support what you want to do (remember what we
1077 said about reinventing the wheel?).
1080 make sure your preamble code is correct
1083 LyX doesn't check it.
1086 \begin_layout Subsection
1090 \begin_layout Standard
1091 Here are some examples of what you can add to a preamble, and what they
1095 \begin_layout Subsubsection
1099 \begin_layout Standard
1100 There are two variables under LaTeX that control page position:
1113 Their names should be self-explanatory.
1114 These variables are useful if you think for a moment about computer labels.
1115 Sometimes, the size of a print medium and the area of the medium that you
1116 can actually print on aren't the same.
1132 \begin_layout Standard
1133 The default values for
1145 are both 0 pt.,\InsetSpace ~
1148 the page isn't shifted.
1151 \begin_layout Standard
1152 Unfortunately, some DVI drivers always seem to shift the page.
1153 We have no idea why, or why the sysadmin hasn't fixed such behavior.
1154 If you're using LyX on a system that you don't personally maintain, and
1155 your sysadmin is a doofus,
1168 Suppose you're left and top margins are always 0.5 inches too big.
1169 You can add this to the preamble:
1172 \begin_layout LyX-Code
1180 \begin_layout LyX-Code
1188 \begin_layout Standard
1189 \SpecialChar \ldots{}
1190 and your margins should now be correct.
1193 \begin_layout Subsubsection
1197 \begin_layout Standard
1198 Speaking of labels, suppose you wanted to print out a bunch of address labels.
1199 There's a rather nice package, available at your nearest CTAN archive,
1200 for printing sheets of labels, called
1205 Now, your system may not have this package installed by default.
1206 We leave that up to you to check.
1207 You'll also want to read the documentation for it; we're not going to do
1209 Since this is an example, however, we'll give you an example of how you
1213 \begin_layout Standard
1214 First, make sure you're using the
1219 Next, you need to put the following in your preamble:
1222 \begin_layout LyX-Code
1228 \begin_layout LyX-Code
1234 \begin_layout LyX-Code
1240 \begin_layout LyX-Code
1246 \begin_layout LyX-Code
1252 \begin_layout LyX-Code
1258 \begin_layout LyX-Code
1264 \begin_layout Standard
1265 This sets things up for Avery® label sheets, stock #5360.
1266 You're now ready to print labels, but you'll need to insert LaTeX code,
1267 placing the commands
1279 around each label text.
1280 This and other special features of
1284 are explained in its documentation.
1287 \begin_layout Standard
1288 Someday, someone may write a LyX layout file to support this package directly.
1289 Maybe that someone is you.
1292 \begin_layout Subsubsection
1293 Example #3: Paragraph Indentation
1296 \begin_layout Standard
1297 Americans are trained to indent the first line of
1302 As with all of their other weird quirks, most Americans will whine and
1303 moan until they can have their way and indent the first line of all paragraphs.
1307 \begin_layout Standard
1312 : This was written by an American ---
1316 ! It's my perception of my fellow countrymen.
1317 Tough if you don't like it.
1326 \begin_layout Standard
1327 Of course, this behavior isn't standard typography.
1328 In books, you typically only indent the first line of a paragraph
1332 it follows another one.
1333 The idea behind indenting the first line of a paragraph is to distinguish
1334 neighboring paragraphs from one another.
1335 If there is no previous paragraph, for example, it follows a figure, or
1336 is the first paragraph in a section, then there is no special indentation.
1340 \begin_layout Standard
1341 If you're a typical American, though, you don't care about such esoteric
1342 things; you want your indentation! Add this to the preamble:
1345 \begin_layout LyX-Code
1348 usepackage{indentfirst}
1351 \begin_layout Standard
1352 If your TeX distribution isn't a braindead one, you'll have this package,
1353 and all of your paragraphs will get the indentation you think they deserve.
1356 \begin_layout Subsubsection
1357 Example #4: This Document
1360 \begin_layout Standard
1361 You can also check out the preamble of this document to get an idea of some
1362 of the advanced things you can do.
1363 You'll probably need to make the
1368 reamble\SpecialChar \ldots{}
1371 dialog full-screen to see most of it.
1372 Also, there are more examples and an assortment of LaTeX
1373 \begin_inset Quotes eld
1377 \begin_inset Quotes erd
1380 given in Chapter\InsetSpace ~
1382 \begin_inset LatexCommand ref
1383 reference "cha:secrets"
1391 \begin_layout Section
1392 LyX and LaTeX Errors
1395 \begin_layout Standard
1396 When LyX calls LaTeX, it tells LaTeX to blithely ignore any errors and keep
1398 It then uses the log-file from the LaTeX run to do a post-mortem.
1399 As we stated earlier in the chapter, LyX generates two kinds of
1403 files, one of which it uses to locate errors in the document.
1404 If there was an error someplace, LyX will put a box with the word
1405 \begin_inset Quotes eld
1409 \begin_inset Quotes erd
1412 at the appropriate place in the document.
1416 \begin_layout Standard
1417 LyX will occasionally misguess where the error was.
1418 This will typically happen with tables, figures, math, and the preamble.
1423 It will also display a message alerting you to the fact that there were
1427 \begin_layout Standard
1428 You can navigate through the errors by using
1444 \begin_inset Quotes eld
1448 \begin_inset Quotes erd
1451 the error-boxes and view the error message LaTeX produced by clicking on
1455 \begin_layout Standard
1456 Some folks also like to look at the log file directly, accessible from
1462 ocument\SpecialChar \menuseparator
1472 There are some fairly common error messages and warnings.
1473 We'll cover those here.
1474 You should look at a good LaTeX book for a complete listing.
1477 \begin_layout Itemize
1478 \begin_inset Quotes eld
1486 \begin_inset Quotes eld
1493 \begin_layout Standard
1494 Anything beginning with these word is a warning message for the purpose
1496 \begin_inset Quotes eld
1500 \begin_inset Quotes erd
1503 the LaTeX code itself.
1504 You'll get messages like this if you added or changed cross-references
1505 or bibliography entries, in which case, LaTeX is trying to tell you that
1506 you need to make another run.
1509 \begin_layout Standard
1510 You can by-and-large ignore these.
1514 \begin_layout Itemize
1515 \begin_inset Quotes eld
1523 \begin_inset Quotes erd
1530 \begin_layout Standard
1531 Another warning message, this time about fonts which LaTeX couldn't find.
1532 The rest of the message will often say something about a replacement font
1536 \begin_layout Standard
1537 You can safely ignore these.
1541 \begin_layout Itemize
1542 \begin_inset Quotes eld
1552 \begin_inset Quotes erd
1559 \begin_layout Standard
1565 They are warning you about lines that were too long and run past the right
1567 Almost always, this is unnoticeable in the final output.
1568 Or, only one or two characters extend past the margin.
1569 LaTeX seems to generate at least one of these messages for just about any
1573 \begin_layout Standard
1574 You can ignore these stupid messages.
1575 Your eyes will tell you if there's a problem with something that's too
1576 wide; just look at the output.
1580 \begin_layout Itemize
1581 \begin_inset Quotes eld
1591 \begin_inset Quotes erd
1598 \begin_layout Standard
1599 Not quite as common as its cousin.
1600 LaTeX seems to like to print lines that are a bit too wide as opposed to
1601 ones that are a bit too narrow.
1602 We have no idea why.
1605 \begin_layout Standard
1606 You can ignore these, too.
1610 \begin_layout Itemize
1611 \begin_inset Quotes eld
1621 \begin_inset Quotes erd
1625 \begin_inset Quotes eld
1635 \begin_inset Quotes erd
1642 \begin_layout Standard
1643 Warnings about troubles breaking the page.
1644 Once again, just look at the output.
1645 Your eyes will tell you where something has gone wrong.
1649 \begin_layout Itemize
1650 \begin_inset Quotes eld
1656 \begin_inset Quotes els
1660 \begin_inset Quotes ers
1666 \begin_inset Quotes erd
1673 \begin_layout Standard
1675 \begin_inset Quotes eld
1679 \begin_inset Quotes erd
1682 isn't installed on this system.
1683 This usually appears because some package your document needs isn't installed.
1684 If you didn't touch the preamble or didn't use the
1690 command, then one of the packages LyX tried to load is missing.
1696 elp\SpecialChar \menuseparator
1703 , to get a list of packages that LyX knows about.
1704 This file is updated whenever you reconfigure LyX (using
1711 \SpecialChar \menuseparator
1716 ) and tells you which packages have been detected and what they do.
1719 \begin_layout Standard
1730 command, and the package in question isn't installed, you'll need to install
1735 \begin_layout Itemize
1736 \begin_inset Quotes eld
1741 LaTeX Error: Unknown option
1744 \begin_inset Quotes erd
1751 \begin_layout Standard
1752 Error messages beginning with this are trying to tell you that you specified
1753 a bad or undefined option to a package.
1754 Check the package's documentation.
1758 \begin_layout Itemize
1759 \begin_inset Quotes eld
1764 Undefined control sequence
1767 \begin_inset Quotes erd
1774 \begin_layout Standard
1775 If you've inserted LaTeX code into your document, but made a typo, you'll
1777 You may have forgotten to load a package.
1778 In any case, this error message usually means that you used an undefined
1783 \begin_layout Standard
1784 There are other error and warning messages.
1785 Some are self-explanatory.
1786 These are usually LaTeX messages.
1787 Others are downright cryptic.
1788 These are actually TeX error messages, and we really have
1792 what they mean or how to decipher them.
1795 \begin_layout Standard
1796 There's a general sequence you should follow if you get error messages:
1799 \begin_layout Enumerate
1800 Look at the LaTeX code you inserted for typos.
1803 \begin_layout Enumerate
1804 If there are no typos, check and see that you used the command(s) correctly.
1807 \begin_layout Enumerate
1808 If you get a bunch of error boxes piled up at the very top of the document,
1809 it means that there are errors in the preamble.
1810 Start debugging your preamble.
1813 \begin_layout Enumerate
1814 If you didn't add anything to the preamble and didn't add any LaTeX code
1815 to the document, the first suspect is your LaTeX distribution itself.
1816 Check for missing packages and install them.
1819 \begin_layout Enumerate
1820 Okay, so there are no missing packages.
1821 Did you use any of the fine-tuning options in LyX? Specifically, did you
1826 any of them, like trying to manually insert lots of
1828 Protected\InsetSpace ~
1839 s? Did you try to kludge something together with these instead of using
1840 the appropriate paragraph environment?
1843 \begin_layout Enumerate
1844 All right, you didn't use any of the fine-tuning options, you played by
1846 Did you try to pull a fancy maneuver? Did you do something funky inside
1847 a table or an equation, like inserting a graphic into a table cell?
1850 \begin_layout Enumerate
1851 Do you have long sections of text where LaTeX cannot find a place to break
1852 a line? By default, LaTeX is rather strict about how much extra inter-word
1853 spacing it will add in order to break a line.
1854 Preferably, you should rework the paragraph to avoid the problem.
1855 If this isn't an option, you can wrap your text in
1861 to make LaTeX's line breaking more, well, sloppy.
1864 \begin_layout Enumerate
1865 Did you go overboard with the nesting? LyX (currently) doesn't check to
1866 make sure you're in the limits for nesting environments.
1867 If you nested a bunch of environments to the
1868 \begin_inset Formula $17^{\mathrm{th}}$
1871 level, that's the problem.
1874 \begin_layout Enumerate
1875 Okay, you didn't get any error messages, but your output looks whacked.
1876 If you have a table or figure that's too wide or long for the page, you
1881 \begin_layout Enumerate
1882 rescale the figure so it fits.
1885 \begin_layout Enumerate
1886 trim down the table so it fits.
1889 \begin_layout Standard
1890 If something else is wrong with the output, and you didn't try to pull anything
1891 fancy or kludge the fine-tuning options, we're not sure what's wrong.
1895 \begin_layout Standard
1896 If all this doesn't help --- well, then
1900 you might have found a bug in LyX\SpecialChar \ldots{}
1904 \begin_layout Chapter
1908 \begin_layout Section
1909 Preparing a Bibliography with BibTeX
1910 \begin_inset LatexCommand label
1911 name "sec:Preparing-a-Bibliography"
1918 \begin_layout Standard
1925 Jürgen Spitzmüller
1928 \begin_layout Standard
1929 \begin_inset VSpace bigskip
1935 \begin_layout Standard
1937 STOP! If you don't know what BibTeX is, or have a reasonably good idea of
1940 e.\InsetSpace \thinspace{}
1944 setting up your own bibliographic databases),
1948 , do not walk, to your nearest copy of the 2nd edition of Lamport's
1950 LaTeX: A Document Preparation System
1952 , particularly Appendix B.
1953 The rest of this discussion assumes you have created a correct bibliography
1954 file, that you have all relevant environment variables set correctly (esp.
1967 ), and that if sufficiently desperate, you could create and
1968 \begin_inset Quotes eld
1972 \begin_inset Quotes erd
1975 a LaTeX file with a BibTeX database.
1979 \begin_layout Standard
1980 For those who don't know what BibTeX is, it is a system for creating a large
1981 database of your most used journal references.
1982 For all future articles you write, you only need to include this standard
1983 database and reference the appropriate key to each reference.
1984 Even if you write only a few papers with handful of references each, it
1985 is well worth your time to examine BibTeX and decide whether it will be
1989 \begin_layout Standard
1990 To use BibTeX with LyX, first read the
1994 where it describes how to insert citations.
1995 The basic mechanism for inserting BibTeX references is the same.
1996 Then, at the very end of your document, select
1998 Insert\SpecialChar \menuseparator
2003 TOC\SpecialChar \menuseparator
2007 In the resulting dialog, fill out the dialog boxes as follows:
2010 \begin_layout Description
2011 Database: enter the name of your
2024 For searching multiple
2028 files, just enter them in the desired order, separated by commas.
2032 \begin_layout Description
2033 Style: enter the name of your BibTeX style file *without* the
2038 The default style is
2042 (which should be included in your LaTeX distribution, so you don't have
2043 to worry about creating it).
2046 \begin_layout Standard
2047 For each citation, assuming that the source is in the
2056 nsert\SpecialChar \menuseparator
2063 at the correct location in the text, and enter the appropriate reference
2065 Nothing else is required; when invoking
2070 iew\SpecialChar \menuseparator
2077 , for example, you should see that BibTeX and LaTeX are invoked as needed,
2078 including multiple invocations of LaTeX.
2082 \begin_layout Subsection
2083 Alternative Citation Styles
2086 \begin_layout Standard
2087 Standard BibTeX uses numbers (e.\InsetSpace \thinspace{}
2088 g.\InsetSpace \space{}
2090 \begin_inset Quotes eld
2094 \begin_inset Quotes erd
2097 ) to refer to a cited work.
2098 However, in many scientific disciplines, other citation styles are in use.
2099 The most common one is the author-year style (e.\InsetSpace \thinspace{}
2100 g.\InsetSpace \space{}
2102 \begin_inset Quotes eld
2106 \begin_inset Quotes erd
2110 LyX supports two packages that provide this style,
2119 Both packages have their own pros and cons, which cannot be listed in detail.
2120 If you only want to have simple author-year (or author-numerical) style
2121 or if you want to use one of the countless style files for natbib, than
2126 package is probably your choice.
2127 If you need special features like short title references, ibidem etc., you
2128 might consider the fairly new
2135 \begin_layout Standard
2136 The handling of both packages in LyX is basically the same.
2142 ocument\SpecialChar \menuseparator
2153 pane (with the xforms frontend: the
2167 With both packages, you will get some extra features in the citation dialog
2168 and you can select the style of the reference (
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 \begin_inset Quotes eld
2197 \begin_inset Quotes erd
2201 Note that both packages need specifically designed style files (they both
2202 ship their own, while there are lots of additional style files and even
2203 an interactive style file builder
2207 \begin_layout Standard
2209 \begin_inset LatexCommand url
2210 target "ftp://ctan.tug.org/tex-archive/macros/latex/contrib/custom-bib/"
2226 \begin_layout Subsection
2227 Sectionated Bibliographies
2228 \begin_inset LatexCommand label
2229 name "sub:Sectionated-Bibliographies"
2236 \begin_layout Standard
2237 Sometimes you might need to divide your bibliography into several sections.
2238 If you are, for instance, a historian, the possibility to separate sources
2239 and scientific works is most likely a
2240 \begin_inset Quotes eld
2244 \begin_inset Quotes erd
2248 Unfortunately, BibTeX itself does not allow you to do this.
2249 The good news is, though: With the help of some LaTeX packages, BibTeX
2250 can be extended to fit your historical needs.
2253 \begin_layout Standard
2254 As of version 1.4, LyX provides native support for one of these packages,
2263 \begin_layout Standard
2265 \begin_inset LatexCommand url
2266 target "ftp://ctan.tug.org/tex-archive/macros/latex/contrib/bibtopic/"
2275 The advantage of this package (compared to other packages like
2279 ) is that you don't need to define new citation commands.
2280 Instead, you need to prepare different bibliographic databases which include
2281 the entries for the different sections of the bibliography.
2282 For example: If you want to divide your bibliography into the sections
2284 \begin_inset Quotes eld
2288 \begin_inset Quotes erd
2292 \begin_inset Quotes eld
2296 \begin_inset Quotes erd
2299 , you first need to create two bibliographic databases, e.\InsetSpace \thinspace{}
2300 g.\InsetSpace \space{}
2313 \begin_layout Standard
2319 ocument\SpecialChar \menuseparator
2330 pane (with the xforms frontend: the
2337 Sectionated\InsetSpace ~
2341 Now you can insert multiple BibTeX references (as described in section\InsetSpace ~
2343 \begin_inset LatexCommand ref
2344 reference "sec:Preparing-a-Bibliography"
2348 ), one for each section of your bibliography.
2349 Returning to our example: Insert a BibTeX reference for the database
2353 and a second one for the database
2358 You are free to use the same or different styles for each section.
2359 Additionally, you can chose if the bibliography section should contain
2361 \begin_inset Quotes eld
2364 all cited references
2365 \begin_inset Quotes erd
2368 of the specified database(s) (which is the default),
2369 \begin_inset Quotes eld
2372 all uncited references
2373 \begin_inset Quotes erd
2377 \begin_inset Quotes eld
2381 \begin_inset Quotes erd
2385 This might be useful if you would like to separate your bibliography into
2387 \begin_inset Quotes eld
2391 \begin_inset Quotes erd
2395 \begin_inset Quotes eld
2399 \begin_inset Quotes erd
2403 \begin_inset Quotes eld
2407 \begin_inset Quotes erd
2411 The titles for the sections can be added as ordinary sections or subsections.
2416 removes the bibliography title, you have manually re-add that, too (as
2417 a chapter* or section*, for instance).
2420 \begin_layout Subsection
2421 Multiple Bibliographies
2424 \begin_layout Standard
2425 Multiple bibliographies, e.\InsetSpace \thinspace{}
2426 g.\InsetSpace \space{}
2427 a bibliography for each section or chapter of
2428 the document, are not supported by BibTeX itself.
2433 package, which is used for the creation of sectionated bibliographies in
2434 LyX (cf.\InsetSpace ~
2435 section\InsetSpace ~
2437 \begin_inset LatexCommand ref
2438 reference "sub:Sectionated-Bibliographies"
2442 ), provides an easy way to solve this task, if you are willing to use some
2443 LaTeX-Code (ERT, cf.\InsetSpace ~
2444 section\InsetSpace ~
2446 \begin_inset LatexCommand ref
2447 reference "sec:Inserting-LaTeX-Code"
2455 \begin_layout Standard
2456 An alternative approach is to use the
2464 package, respectively.
2472 \begin_layout Standard
2478 ocument\SpecialChar \menuseparator
2489 pane (with the xforms frontend: the
2496 Sectionated\InsetSpace ~
2500 In the document, you have to enclose the sections, which shall contain
2501 their own bibliography (including the BibTeX reference itself), between
2514 (those commands have to be inserted as ERT).
2515 The bibliography will contain all references which have been cited in the
2517 N.\InsetSpace \thinspace{}
2518 B.: If you are using this approach, then
2522 citation reference has to be inside some btUnit.
2523 Also, the btUnits cannot be nested.
2526 \begin_layout Section
2530 \begin_layout Standard
2531 A good index is one of the hardest things to make in a lengthy document,
2532 but LyX helps make things a bit simpler by interfacing to the
2536 program which is found in most recent LaTeX distributions.
2540 \begin_layout Standard
2558 Outputs\SpecialChar \menuseparator
2559 LaT\SpecialChar \textcompwordmark{}
2568 section of the preferences dialog, however, you can customize the index
2569 command, if you prefer an alternative program like
2590 Inserting an index and marking words to include in it works much the same
2591 way as preparing a bibliography as mentioned in the last section.
2594 \begin_layout Standard
2595 First, go to the end of your file and select
2600 nsert\SpecialChar \menuseparator
2611 C\SpecialChar \menuseparator
2624 Then, for each word you would like to include in the index, go to the end
2625 of that word and click on
2630 nsert\SpecialChar \menuseparator
2643 This will insert a tag showing the word as it will appear in the index.
2644 That's all there is to it; LyX will automatically call
2648 for you and create the index itself.
2649 The text in the dialog available from right-clicking on the index button
2650 accepts LaTeX, so you'll need to be careful to avoid using any special
2652 On the positive side, you can use the advanced options - have a look at
2653 the documentation which comes with your LaTeX distribution to find out
2654 how to do things like
2655 \begin_inset Quotes eld
2659 \begin_inset Quotes erd
2665 \begin_layout Standard
2666 Be careful not to put spaces between the word in the text and the index
2667 marker; apparently the wrong page number can be produced if this happens.
2670 \begin_layout Section
2674 \begin_layout Standard
2682 \begin_layout Standard
2683 Sometimes you need to compile a list of symbols that are mentioned in your
2684 document with a brief explanation of them.
2685 A LaTeX package named
2689 provides an easy way of compiling such lists.
2694 is included in most standard Linux distributions.
2695 If your distribution doesn't contain it, you should download it from a
2696 CTAN mirror and install the package in order to use this feature of LyX.
2699 \begin_layout Standard
2700 A glossary entry is created if you place the cursor after a symbol entry
2701 and then use the menu
2703 Insert\SpecialChar \menuseparator
2704 Glossary\InsetSpace ~
2709 \begin_inset Quotes eld
2717 \begin_inset Quotes erd
2720 is inserted and a window pops up asking for the glossary entry.
2721 A glossary entry consists of two main entries.
2722 The first is the symbol that you want to refer to.
2723 You should enter a valid LaTeX code for the corresponding field in the
2725 The second is the description of the symbol.
2726 You should fill the corresponding field to complete the glossary entry.
2729 \begin_layout Subsection
2730 Sort Order of Glossary Entries
2733 \begin_layout Standard
2734 Suppose you have two glossary entries for the symbols
2735 \begin_inset Formula $a$
2739 \begin_inset Formula $\sigma$
2747 package automatically sorts these two entries considering the symbol entry,
2748 while printing the Glossary.
2749 However, this can lead to an undesired sort order.
2750 For the example given, the first entry appears as
2754 , while the second is
2761 Note that, in this case
2762 \begin_inset Formula $\sigma$
2765 is located in front of the
2766 \begin_inset Formula $a$
2769 , since the character
2770 \begin_inset Quotes eld
2776 \begin_inset Quotes erd
2779 is considered in sorting.
2780 In order to control the sort order, you can edit the
2785 field of the glossary dialog.
2786 For the given example, you can edit this field as
2795 Then, these entries will be effective in the sort ordering and
2796 \begin_inset Formula $a$
2799 will be located before
2800 \begin_inset Formula $\sigma$
2806 \begin_layout Standard
2807 This feature provides exciting ways of ordering the entries.
2808 For subgrouping and tips for using sort entries see the official nomencl
2812 \begin_layout Subsection
2816 \begin_layout Standard
2817 You can turn on referencing to the equations and pages in the glossary entries.
2818 For this purpose, you should add referencing options commands at the end
2819 of description field.
2820 There are six referencing options in nomencl package:
2823 \begin_layout Paragraph*
2829 \begin_layout Standard
2830 Adds reference to the equation by adding the phrase
2831 \begin_inset Quotes eld
2835 \begin_inset Quotes erd
2841 \begin_layout Paragraph*
2847 \begin_layout Standard
2848 Adds reference to the page by adding the phrase
2849 \begin_inset Quotes eld
2853 \begin_inset Quotes erd
2859 \begin_layout Paragraph*
2865 \begin_layout Standard
2866 Is the short notation of
2873 \begin_layout Paragraph*
2883 \begin_layout Standard
2884 Turns off corresponding referencing options if they are turned on globally
2885 (see reference documentation of nomencl).
2888 \begin_layout Subsection
2892 \begin_layout Standard
2893 You can insert the glossary with the menu
2895 Insert\SpecialChar \menuseparator
2897 &TOC\SpecialChar \menuseparator
2901 A light blue box labeled
2902 \begin_inset Quotes eld
2910 \begin_inset Quotes erd
2913 will show the place where the index is printed in the output.
2914 The index list box is not clickable like other LyX-boxes.
2915 In the printed output the title of the glossary appears as
2923 \begin_layout Standard
2924 This is translated to the document language for a small number of languages,
2925 amongst others French and German
2931 If you are not happy with the title, you can change it by re-defining the
2939 For example, in order to change the title
2947 add the following line to the preamble.
2950 \begin_layout LyX-Code
2955 nomname}{List of Symbols}
2958 \begin_layout Standard
2959 If you're unhappy with the amount of space for symbols, you can alter it
2960 by adding following line to the preamble.
2963 \begin_layout LyX-Code
2968 nomlabelwidth}{3.0cm}
2971 \begin_layout Section
2975 \begin_layout Subsection
2979 \begin_layout Standard
2980 When you are working on a large file with many sections, it is often convenient
2981 to break up the document into several files, or perhaps you have something
2982 where a table may change from time to time, but the preceding text does
2984 In these cases, you should seriously consider using multipart documents.
2985 For example, scientific papers often have five major sections: the introduction
2986 , observations, results, discussion, and conclusion.
2987 Each of these could be its own separate LyX file, with one
2988 \begin_inset Quotes eld
2992 \begin_inset Quotes erd
2995 file which contains the title, authors, abstract, references, etc., plus
2996 the five included files.
2997 It is important to note that each of these files is a full LyX file which
2998 can be formatted and printed on its own, as well as included in a master
3000 Each of these files must have the same document class, however--- don't
3001 attempt to mix book classes with article classes.
3002 You may also include LaTeX files; however, these files must not have their
3008 everything up to and including the
3020 line must be deleted) or else errors will be generated when you try to
3024 \begin_layout Standard
3025 LyX allows you to include files quite easily with
3030 nsert\SpecialChar \menuseparator
3039 When you click on this selection a small box is inserted into the file
3040 at the current cursor location.
3041 Clicking on the box raises a dialog which allows you to select the file
3042 to be included, and the method of its inclusion.
3046 \begin_layout Standard
3047 The file selection box should by now be obvious.
3048 The three inclusion methods are
3049 \begin_inset Quotes eld
3053 \begin_inset Quotes erd
3057 \begin_inset Quotes eld
3061 \begin_inset Quotes erd
3065 \begin_inset Quotes eld
3069 \begin_inset Quotes erd
3073 The difference between
3074 \begin_inset Quotes eld
3078 \begin_inset Quotes erd
3082 \begin_inset Quotes eld
3086 \begin_inset Quotes erd
3089 is really only meaningful to LaTeXperts, but the practical difference is
3090 that files which are
3091 \begin_inset Quotes eld
3095 \begin_inset Quotes erd
3098 are typeset beginning on a new page, while files which are
3099 \begin_inset Quotes eld
3103 \begin_inset Quotes erd
3106 are typeset starting on the current page.
3107 Perhaps the labeling in LyX will be changed someday to reflect this.
3110 \begin_layout Standard
3111 Generally, the master file is converted into a full LaTeX file before typesettin
3112 g, while the included files are converted to LaTeX files which do not have
3113 all the preamble information.
3123 button prevents this conversion.
3126 \begin_layout Standard
3128 \begin_inset Quotes eld
3132 \begin_inset Quotes erd
3135 included file allows you to include a file typeset exactly as it appears
3136 in the file, i.e.\InsetSpace ~
3137 verbatim mode, with the characters set in a fixed-width
3139 Normally, spaces in this file are invisible, though two consecutive spaces
3140 are conserved, unlike LyX's normal treatment of spaces.
3141 However, setting the
3151 checkbox typesets a mark to unambiguously define the presence of a space.
3157 \begin_layout Subsection
3158 Cross-References Between Files
3161 \begin_layout Standard
3162 It is possible to set up cross-references between the different files.
3163 First, open all the files in question: let's call them A and B in a two
3164 file example, where B is included in A.
3165 Let's say you insert a label in A, then want to reference it in B.
3166 Open the cross-reference dialog in whilst in document B, and you can select
3168 \begin_inset Quotes eld
3172 \begin_inset Quotes erd
3178 \begin_layout Section
3179 Fancy Headers and Footers
3182 \begin_layout Standard
3183 The default page layout is rather plain; for an article document class,
3184 all you get is a centered page number at the bottom of the page.
3185 This document is the book class, so it appears to be a bit fancier, but
3186 to really put on a show, you need to set the document page style to
3187 \begin_inset Quotes eld
3191 \begin_inset Quotes erd
3194 , as mentioned in the
3200 This section describes the LaTeX codes you need to insert in your LaTeX
3201 preamble or the text in order to get the desired effects.
3204 \begin_layout Standard
3205 The page header is divided into three fields, not surprisingly labeled
3206 \begin_inset Quotes eld
3210 \begin_inset Quotes erd
3214 \begin_inset Quotes eld
3218 \begin_inset Quotes erd
3222 \begin_inset Quotes eld
3226 \begin_inset Quotes erd
3230 The footer is also divided into these three fields.
3231 The LaTeX commands to set these fields in the simplest manner are
3256 Suppose you wish to put your name in the upper left hand corner of each
3258 Simply insert the following command in the preamble:
3261 \begin_layout Standard
3270 \begin_layout Standard
3271 You will now see your name in the upper left.
3272 If a field has a default entry that you would like to get rid of (often
3273 the page number appears in the central footer, simply include a command
3274 with a blank argument, e.\InsetSpace \thinspace{}
3278 \begin_layout Standard
3286 \begin_layout Standard
3287 Let's get really fancy: lets put the section number with the word
3288 \begin_inset Quotes eld
3292 \begin_inset Quotes erd
3295 (e.\InsetSpace \thinspace{}
3297 Section 3) in the upper left, the page number (e.\InsetSpace \thinspace{}
3299 Page 4) in the upper
3300 right, your name in the lower left, and the date in the lower right.
3301 The following commands should now appear in the preamble:
3304 \begin_layout Standard
3314 \begin_layout Standard
3322 \begin_layout Standard
3332 \begin_layout Standard
3341 \begin_layout Standard
3349 \begin_layout Standard
3359 \begin_layout Standard
3372 access LaTeX's section and page counters, and so print out the current
3373 section and page numbers.
3380 simply prints out today's date.
3383 \begin_layout Standard
3384 The thicknesses of the horizontal rules drawn beneath the header and above
3385 the footer can also be modified.
3386 If you don't want one of the headers, set its thickness to 0.
3387 The header rule has a default thickness of 0.4pt, the footer rule is 0pt.
3388 Use the commands, e.\InsetSpace \thinspace{}
3396 headrulewidth}{0.4pt}
3404 footrulewidth}{0.4pt}
3406 to set the thicknesses.
3409 \begin_layout Standard
3410 You can switch the header/footer settings on and off for individual pages
3415 thispagestyle{empty}
3421 thispagestyle{plain}
3427 thispagestyle{fancy}
3430 Simply insert them in the text on the page you want changed and mark them
3432 In fact, title pages are marked as plain by default, while following pages
3433 are marked fancy when using the global fancy setting.
3436 \begin_layout Standard
3437 There are more complex commands which will let you insert things in the
3438 upper left on odd numbered pages, etc., but I will refer you to the
3442 package documentation for more descriptions.
3443 For example, if you have a teTeX installation, look for
3445 /usr/share/texmf/doc/latex/fancyhdr/\SpecialChar \-
3451 \begin_layout Standard
3452 As a final example, it is possible to include an Encapsulated PostScript
3453 file in the header or footer.
3454 Suppose you want to put a company logo in the upper lefthand corner.
3455 You might try something like
3458 \begin_layout Standard
3467 includegraphics{logo.eps}}}
3470 \begin_layout Standard
3472 (you may need to preface this with
3476 usepackage{graphics}
3478 if you don't include EPS files elsewhere in your document).
3481 \begin_layout Section
3482 Itemize Bullet Selection
3483 \begin_inset LatexCommand label
3491 \begin_layout Standard
3497 \begin_layout Subsection
3501 \begin_layout Standard
3502 LyX provides 216 bullet shapes that can be accessed from a simple dialog.
3503 Using this dialog you can easily specify what bullet shape to use at each
3504 level of an itemized list.
3505 These settings are document-wide so you won't be able to specify different
3506 sets of bullets for different paragraphs
3510 \begin_layout Standard
3511 Well, actually you can but you'll have to do it by hand.
3519 \begin_layout Subsection
3523 \begin_layout Standard
3524 Open the dialog by selecting the
3529 ocument\SpecialChar \menuseparator
3536 menu item and then select the
3546 \begin_layout Standard
3547 The dialog provides you with a table of bullet shapes.
3548 A column of buttons on the left of the table provides access to the six
3549 different panels of bullet shapes.
3550 The row of buttons across the top is used to select which bullet depth
3552 A text entry under the table shows the currently selected bullet shape's
3553 LaTeX equivalent and this can be edited if desired.
3554 If you do modify the text you will also need to specify any needed packages
3555 in the LaTeX preamble.
3558 \begin_layout Standard
3559 The six panels are divided up by the packages they require.
3560 The following table shows the mappings from button name to LaTeX packages.
3563 \begin_layout Standard
3565 \begin_inset Tabular
3566 <lyxtabular version="3" rows="7" columns="2">
3568 <column alignment="center" valignment="top" leftline="true" width="0pt">
3569 <column alignment="center" valignment="top" leftline="true" rightline="true" width="0pt">
3570 <row topline="true" bottomline="true">
3571 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
3574 \begin_layout Standard
3589 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
3592 \begin_layout Standard
3608 <row topline="true">
3609 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
3612 \begin_layout Standard
3627 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
3630 \begin_layout Standard
3645 <row topline="true">
3646 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
3649 \begin_layout Standard
3664 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
3667 \begin_layout Standard
3683 <row topline="true">
3684 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
3687 \begin_layout Standard
3702 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
3705 \begin_layout Standard
3721 <row topline="true">
3722 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
3725 \begin_layout Standard
3740 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
3743 \begin_layout Standard
3759 <row topline="true">
3760 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
3763 \begin_layout Standard
3778 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
3781 \begin_layout Standard
3797 <row topline="true" bottomline="true">
3798 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
3801 \begin_layout Standard
3816 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
3819 \begin_layout Standard
3842 \begin_layout Standard
3843 LyX doesn't stop you using bullets from packages you don't have.
3844 If you get errors from LaTeX when you try to view or print the file then
3845 its likely you are missing a package.
3846 LyX doesn't restrict your use since you may be editing locally and exporting
3850 \begin_layout Subsection
3854 \begin_layout Standard
3855 Select which bullet depth you want to change then select the bullet shape
3861 Any changes will not be visible in LyX, but are visible when viewing the
3862 document using xdvi or ghostview.
3865 \begin_layout Standard
3866 You can reset a bullet shape to the default simply by clicking your right
3867 mouse button on the appropriate bullet depth button.
3870 \begin_layout Standard
3875 want to have multiple sets of paragraphs with different sets of bullets
3876 in each then you're going to have to get your hands dirty.
3877 The itemize bullet selection dialog can help though because it provides
3878 you with the LaTeX code for a wide range of bullet shapes.
3879 To make your own custom paragraphs you have the following options:
3882 \begin_layout Standard
3886 \begin_layout Standard
3902 \begin_layout Standard
3906 \begin_layout Standard
3928 \begin_layout Itemize
3929 Use the LaTeX command
3935 to specify a new bullet shape for a given depth.
3936 You'll also need to save the current bullet shape so you can restore it
3938 In this itemized list the following LaTeX code was used to change the bullet
3939 used for the first depth.
3971 Note that the itemize depth is specified in Roman numerals as part of the
3981 \begin_layout Itemize
3985 \begin_layout Standard
3998 Specify each individual entry by starting each item with the bullet shape
3999 enclosed in square brackets and set as TeX.
4000 For example, this item was started with
4013 \begin_layout Standard
4017 \begin_layout Standard
4033 \begin_layout Standard
4034 You'll also need to revert the labelitem back to its previous setting for
4035 the global bullet shape settings to remain in effect.
4036 The way used here was:
4049 \begin_layout Chapter
4050 Special Document Classes
4053 \begin_layout Section
4057 \begin_layout Standard
4063 \begin_layout Standard
4064 \begin_inset VSpace bigskip
4070 \begin_layout Standard
4072 The AMS LaTeX layouts are set up to conform to suggested styles for mathematical
4073 papers to be submitted to American Mathematical Society publications.
4074 The layouts are not tailored to a specific journal, but easily can be.
4075 You should refer to the AMS documentation for specific instructions for
4076 each journal (usually it will entail only changing a single line in the
4078 That documentation is available on the Web at
4079 \begin_inset LatexCommand url
4080 target "http://www.ams.org"
4085 \begin_inset LatexCommand url
4086 target "ftp://ftp.ams.org/pub/tex/amslatex/"
4090 .These layouts are appropriate, and useful, for any mathematical writing.
4091 There are currently 4 distinct AMS LaTeX layouts:
4094 \begin_layout Enumerate
4095 amsart: The standard AMS-article format.
4096 All results and similar statements are numbered as
4097 \begin_inset Formula $(n.m)$
4100 , where the first number refers to the section, and the second refers to
4101 the total number of results (Theorems, Corollaries, Propositions, Definitions
4102 and Remarks, etc.) in that section.
4103 There are also many (but not all) environments available unnumbered, which
4104 is occasionally needed.
4105 Unnumbered environments indicated by an asterisk at the end.
4108 \begin_layout Enumerate
4109 amsart-seq: Here, numbering for each type of statement is in its own sequence,
4110 with no reference to the section number.
4111 There are also many (but not all) environments available unnumbered, which
4112 is occasionally needed.
4113 Unnumbered environments indicated by an asterisk at the end.
4116 \begin_layout Enumerate
4117 amsart-plain: This one is even more terse, since all the environments are
4121 \begin_layout Enumerate
4122 amsbook: the standard AMS book (really, monograph) format.
4123 Numbering is similar to the amsart layout, except that all numbering is
4125 \begin_inset Formula $(n.m.p)$
4128 , where the first number refers to the chapter, the second to the section,
4129 and the third is the number of the results (Theorems, Corollaries, Propositions
4130 , Definitions and Remarks, etc.) in that section.
4131 There are also many (but not all) environments available unnumbered, which
4132 is occasionally needed.
4133 Unnumbered environments indicated by an asterisk at the end.
4136 \begin_layout Standard
4137 Any AMS LyX file can be converted to either of the numbering schemes by
4138 simply changing the document class in the
4143 ocument\SpecialChar \menuseparator
4154 \begin_layout Subsection
4155 What these layouts provide
4158 \begin_layout Standard
4159 There is a long list of included environments provided by these layouts.
4160 Most mathematical papers or books will set as special statements most of
4161 these environments, in AMS-LaTeX there is an opportunity to define an unlimited
4162 variety of such declarations.
4163 However, the AMS recommends the environments that are available in LyX.
4164 The list of environments (not counting the standard environments such as
4167 sections, bibliography, title, author, date
4172 \begin_layout Description
4173 Theorem This is typically used for the statements of major results.
4175 \begin_inset Quotes eld
4183 \begin_inset Quotes erd
4186 appears in bold type, along with an automatically-determined number (an
4191 , is also available).
4192 The text is italicized.
4195 \begin_layout Description
4196 Corollary This is used for statements which follow fairly directly from
4197 previous statements.
4198 Again, these can be major results.
4206 \begin_layout Description
4207 Lemma These are smaller results needed to prove other statements.
4210 \begin_layout Description
4211 Proposition These are less major results which (hopefully) add to the general
4212 theory being discussed.
4215 \begin_layout Description
4216 Conjecture These are statements provided without justification, which the
4217 author does not know how to prove, but which seem to be true (to the author,
4221 \begin_layout Description
4222 Criterion A required condition.
4225 \begin_layout Description
4226 Algorithm A general procedure to be used.
4229 \begin_layout Description
4230 Axiom This is a property or statement taken as true within the system being
4234 \begin_layout Description
4235 Definition Guess what this is for.
4236 The font, both on-screen and in the output, is different for this environment
4237 than for the previous ones.
4239 \begin_inset Quotes eld
4243 \begin_inset Quotes erd
4246 ) is still set in boldface, along with the number, if any, but the rest
4250 \begin_layout Description
4251 Example Typeset similarly to Definition.
4254 \begin_layout Description
4258 \begin_layout Description
4262 \begin_layout Description
4266 \begin_layout Description
4267 Remark This environment is also a new type of theorem.
4268 This is set with the word Remark in italics, and the rest upright.
4271 \begin_layout Description
4272 Note Set similarly to the Remark environment.
4275 \begin_layout Description
4279 \begin_layout Description
4283 \begin_layout Description
4287 \begin_layout Description
4291 \begin_layout Description
4292 Case Generally, these are used to break up long arguments, using specific
4293 instances of some condition.
4294 The numbering scheme for cases is on its own, not together with other numbered
4299 \begin_layout Description
4303 \begin_layout Description
4307 \begin_layout Description
4309 \begin_inset Quotes eld
4317 \begin_inset Quotes erd
4320 is set in italics, but the rest is set upright.
4321 At the end of this environment (other environments can be nested within
4322 this one, of course) a QED symbol (usually a square, but it can vary with
4323 different styles) is placed.
4326 \begin_layout Description
4327 Address This should be the author's permanent address.
4330 \begin_layout Description
4331 Current\InsetSpace ~
4332 Address This should be the author's temporary address at the time
4333 of submission, if different from the Address.
4336 \begin_layout Description
4337 Email Author's e-mail address
4340 \begin_layout Description
4341 URL Author's Web address, if desired.
4344 \begin_layout Description
4345 Keywords Key words or phrases used to identify specific topics discussed
4349 \begin_layout Description
4350 Subjectclass These refer to the AMS Subject Classifications, published and
4353 Mathematical Reviews
4356 These are also available online at the AMS cites listed above.
4359 \begin_layout Description
4363 \begin_layout Description
4367 \begin_layout Description
4371 \begin_layout Standard
4372 In addition, these environments automatically provide the AMS LaTeX and
4374 They need to be available on your system in order to use these environments.
4377 \begin_layout Section
4381 \begin_layout Standard
4386 can be used to type letters according to German conventions.
4387 A template file is included in
4389 .../lyx/share/templates
4391 for you to use as a starting point.
4394 \begin_layout Section
4398 \begin_layout Standard
4403 provides an alternative to the standard
4408 It provides similar functionality, but you might prefer this layout with
4409 sans serif sections, headings, and more.
4412 \begin_layout Section
4416 \begin_layout Standard
4422 \begin_layout Subsection
4426 \begin_layout Standard
4427 This section describes how LyX can be used to write articles for submission
4428 to the scientific journal
4430 Astronomy and Astrophysics
4433 \begin_inset LatexCommand url
4434 name "www.edpsciences.fr/aa/"
4435 target "http://www.edpsciences.fr/aa/"
4447 Version 5.01 of the document class
4452 This package can be downloaded from the ftp site
4455 \begin_layout Standard
4456 \begin_inset VSpace medskip
4462 \begin_layout Standard
4464 \begin_inset LatexCommand url
4465 target "ftp://ftp.edpsciences.org/pub/aa/readme.html"
4472 \begin_layout Standard
4473 \begin_inset VSpace medskip
4479 \begin_layout Standard
4480 A manual comes together with that package, and this text is not meant to
4481 replace the original manual but merely a short guide how to realize the
4482 correct form of your paper.
4486 \begin_layout Standard
4487 Please note that the publisher of the journal was changed from Springer
4488 to EDP Sciences starting January 1, 2001.
4489 That change implicated also some slight changes of the style files, namely
4490 the removal of the thesaurus command.
4491 The LyX class aa supports the newest version of these style files, V 5.01.
4492 If you have an older version installed, please upgrade.
4493 For compatibility, the old (version 4) layout has been kept as
4498 Please refer to the comments in
4500 LyXDir/layouts/aapaper.layout
4505 \begin_layout Subsection
4509 \begin_layout Standard
4510 It is recommended you start from the example template distributed with LyX.
4511 If you are not using a template, note the following settings:
4514 \begin_layout Itemize
4524 ocument\SpecialChar \menuseparator
4531 dialog (OK, that one was obvious).
4534 \begin_layout Itemize
4535 Don't change the option
4545 The whole layout is done by the macros, you shouldn't change anything.
4548 \begin_layout Subsection
4552 \begin_layout Standard
4553 First thing to enter is the header information.
4554 It consists of seven entries, of which some are optional.
4558 \begin_layout Itemize
4566 \begin_layout Itemize
4574 \begin_layout Itemize
4582 \begin_layout Itemize
4590 \begin_layout Itemize
4595 : [optional] if more than one author: whom to contact for offprint requests.
4598 \begin_layout Itemize
4603 : [optional] mail address for contacts.
4606 \begin_layout Itemize
4614 Received: <date>; Accepted <date>
4617 \begin_layout Standard
4618 There is no need to issue the
4624 command, this is done automatically by LyX when the header is finished.
4625 Although the order of the single header entries doesn't matter it is advised
4626 to keep the above sequence, just to get the best optics and meets the layout
4627 of the real document.
4630 \begin_layout Standard
4631 If you want to place footnotes in the header block, e.\InsetSpace \thinspace{}
4636 \begin_layout Standard
4645 to state your present address, just use the standard footnote via
4650 nsert\SpecialChar \menuseparator
4658 LyX will automagically use the term
4667 \begin_layout Standard
4668 In addition to these topics, the macros use three additional LaTeX commands
4669 that have no counterpart in LyX:
4672 \begin_layout Itemize
4679 to separate different names for more than one author and institute, respectivel
4683 \begin_layout Itemize
4690 to mark corresponding author/institute pairs.
4691 The institutes are numbered sequentially as they appear in the
4695 field, so you have to put a marker to each author.
4698 \begin_layout Itemize
4705 to supply an email address for fast contact.
4708 \begin_layout Standard
4709 In all cases, the appropriate command has to be entered in LyX and marked
4715 \begin_layout Subsection
4719 \begin_layout Standard
4720 The abstract should immediately follow the header block.
4721 With version 5 the abstract environment was changed to a command, and there
4722 is now a resctriction to only one paragraph.
4723 In addition, it should contain an entry with the keywords.
4724 This is not yet implemented for LyX, therefore you have to enter the LaTeX
4731 by hand and mark it as LaTeX code.
4732 Refer to the example paper.
4735 \begin_layout Subsection
4736 Supported environments
4739 \begin_layout Standard
4740 The A&A paper layout supports the following environments for structuring
4744 \begin_layout Itemize
4750 \begin_layout Itemize
4756 \begin_layout Itemize
4762 \begin_layout Itemize
4768 \begin_layout Itemize
4774 \begin_layout Itemize
4780 \begin_layout Itemize
4786 \begin_layout Itemize
4792 \begin_layout Itemize
4798 \begin_layout Itemize
4804 \begin_layout Itemize
4810 \begin_layout Itemize
4816 \begin_layout Subsection
4817 Commands not supported by LyX
4820 \begin_layout Standard
4821 Some commands are not yet supported by the
4826 Some have already been mentioned.
4827 For the sake of completeness, they are listed all together here:
4830 \begin_layout Itemize
4838 \begin_layout Itemize
4846 \begin_layout Itemize
4854 \begin_layout Itemize
4862 \begin_layout Itemize
4870 \begin_layout Itemize
4878 \begin_layout Itemize
4886 \begin_layout Itemize
4894 \begin_layout Standard
4895 If you want to use any of these commands, you have to enter them yourself.
4898 Do not forget to mark them as LaTeX code!
4901 \begin_layout Subsection
4902 Figure and Table Floats
4905 \begin_layout Standard
4906 LyX provides support for the necessary float environments
4908 figure, figure*, table
4914 , therefore we won't tell much about it here.
4921 Just remember that tables should be left-aligned.
4922 For that, select the table and change the alignment in
4927 dit\SpecialChar \menuseparator
4932 aragraph\InsetSpace ~
4936 \begin_layout Standard
4941 only one special thing: the figures with caption besides the figure.
4942 To create such a figure, you have to do the following:
4945 \begin_layout Enumerate
4946 Create a wide figure float:
4951 nsert\SpecialChar \menuseparator
4956 t\SpecialChar \menuseparator
4959 , then right click in the figure and select
4971 \begin_layout Enumerate
4972 Enter your caption text.
4975 \begin_layout Enumerate
4980 to move the cursor above the caption.
4983 \begin_layout Enumerate
4987 \begin_layout Enumerate
4988 Position the cursor behind the figure and insert a horizontal fill:
4993 nsert\SpecialChar \menuseparator
5001 \SpecialChar \menuseparator
5004 orizontal\InsetSpace ~
5010 \begin_layout Enumerate
5011 Switch to LaTeX mode:
5019 \begin_layout Enumerate
5029 Do not close the brace!
5032 \begin_layout Enumerate
5033 Position the cursor behind the caption text, switch to LaTeX mode and insert
5044 \begin_layout Standard
5045 Also, refer to the figures in the example paper.
5048 \begin_layout Subsection
5052 \begin_layout Standard
5053 For submission, the paper has to be formated in a special double-spacing
5055 For this purpose, you have to give the option
5059 to the documentclass.
5060 This must be done using the extra class options field in the
5065 ocument\SpecialChar \menuseparator
5073 Just enter the string
5080 \begin_layout Subsection
5084 \begin_layout Standard
5089 directory contains an example paper written with LyX.
5090 It is the example paper from the original macro package, translated to
5092 Use it for inspiration, and compare the original LaTeX code with LyX way
5096 \begin_layout Section
5100 \begin_layout Standard
5106 \begin_layout Subsection
5110 \begin_layout Standard
5111 AASTeX is a set of macros produced by the American Astronomical Society
5112 to facilitate electronic manuscript submission to the three journals they
5113 publish: the Astrophysical Journal (including the Letters and Supplement),
5114 the Astronomical Journal, and the Publications of the Astronomical Society
5116 LyX has proven to be an excellent tool for generating these documents,
5117 especially given its equation, citation, and figure handling capabilities.
5118 LyX requires version 5.0 (or higher) of these macros; preferably 5.2, which
5119 is the version described here, or higher.
5120 Versions prior to 5.0 are intended for use with LaTeX2.09 and are fundamentally
5121 incompatible with LyX.
5122 The AASTeX package may be downloaded from the AASTeX Web site
5125 \begin_layout Standard
5126 \begin_inset VSpace medskip
5132 \begin_layout Standard
5134 \begin_inset LatexCommand url
5135 target "http://www.journals.uchicago.edu/AAS/AASTeX"
5142 \begin_layout Standard
5143 \begin_inset VSpace medskip
5149 \begin_layout Standard
5150 A complete user guide is contained in that package and you should familiarize
5151 yourself with it thoroughly before embarking on writing a paper in LyX.
5152 LyX will not reduce the need to figure out all the AASTeX commands, it
5153 will only reduce the drudgery of typing everything in.
5154 It is your responsibility to ensure that the final exported LaTeX document
5155 conforms completely to the requirements of the journal to which you are
5156 submitting your paper.
5159 \begin_layout Subsection
5160 Starting a New Paper
5163 \begin_layout Standard
5164 I strongly suggest that you start with the AASTeX template file.
5170 ile\SpecialChar \menuseparator
5177 , enter the new file name, then choose the
5182 This will show the most common fields found in a manuscript.
5183 Simply overwrite the existing text (including the brackets,
5187 ) with the correct information.
5188 Many of the AASTeX commands and environments can be implemented directly
5189 in LyX, but some cannot: most noticeably
5201 , which should stick out like a sore thumb if you actually just opened the
5203 For commands such as these, the LaTeX code must be entered directly and
5205 Such commands are referred to as ERT, or Evil Red Text.
5206 I tried to minimize the amount of ERT needed in an AASTeX document, but
5207 there is still a bit more required than any of us would like.
5210 \begin_layout Subsection
5211 Finishing Your Paper
5214 \begin_layout Standard
5215 When the paper is finished to your satisfaction and previews/prints correctly,
5217 \begin_inset Quotes eld
5221 \begin_inset Quotes erd
5224 actions which need to be done before you submit it to the journals.
5228 \begin_layout Enumerate
5229 Export your paper as a LaTeX file (
5234 ile\SpecialChar \menuseparator
5239 xport\SpecialChar \menuseparator
5250 \begin_layout Enumerate
5255 file with your favorite text editor
5259 \begin_layout Enumerate
5260 remove the comment lines before the
5269 \begin_layout Enumerate
5274 usepackage...{fontenc}
5276 line if it appears (usually just after
5291 \begin_layout Enumerate
5292 remove everything between (and including) the
5304 commands, except for any commands you specifically put into the LaTeX preamble
5305 (which should appear immediately after the
5306 \begin_inset Quotes eld
5309 User specified LaTeX commands
5310 \begin_inset Quotes erd
5321 \begin_layout Enumerate
5322 Run the resulting file through LaTeX to make sure it still processes correctly.
5325 \begin_layout Enumerate
5326 Reread the journal requirements to make sure your filenames and formats
5330 \begin_layout Enumerate
5334 \begin_layout Subsection
5335 Comments On Specific Commands
5338 \begin_layout Standard
5339 I will not describe the detailed usage of the individual AASTeX commands:
5340 the AASTeX User Guide (
5344 ) gives a good description of each.
5345 Thus it's probably easiest for me to go down the list as found in the guide
5346 and offer comments where necessary.
5347 So let's begin \SpecialChar \ldots{}
5351 \begin_layout Subsubsection
5352 Things that work as expected
5355 \begin_layout Standard
5359 \begin_layout Standard
5371 \begin_layout Standard
5372 Because they work as you might expect, I simply list them and the section
5473 begin{thebibliography}
5481 (2.13.2), all the cite commands and their variations (2.13.2), the generic
5482 graphicx figure commands (2.14.1),
5506 (2.15.4, amongst other places),
5533 \begin_layout Standard
5534 The following style options also work correctly:
5555 Simply put them in the
5561 Layout\SpecialChar \menuseparator
5567 \begin_layout Standard
5571 \begin_layout Standard
5583 \begin_layout Subsubsection
5584 Things that work, but require more comment
5587 \begin_layout Standard
5588 The following items work, but require a little more discussion:
5591 \begin_layout Itemize
5592 These items are reserved for use by the journal editors, but you can put
5593 them into the LaTeX preamble if you feel compelled to do so:
5626 \begin_layout Itemize
5627 These items may be placed in the LaTeX preamble, and are included as blanks
5628 in the template file:
5649 \begin_layout Itemize
5656 (2.3) -- can only be used
5657 \begin_inset Quotes eld
5661 \begin_inset Quotes erd
5664 , not in the middle of a paragraph.
5665 Use ERT if you need to embed it.
5668 \begin_layout Itemize
5675 (2.3) -- will have extra {} after it.
5676 This should not cause an error.
5679 \begin_layout Itemize
5686 (2.6) -- can only be used
5687 \begin_inset Quotes eld
5691 \begin_inset Quotes erd
5694 , not in the middle of a paragraph.
5695 Use ERT if you need to embed it.
5698 \begin_layout Itemize
5705 (2.8) -- can't insert a cross-reference tag, you must type the tag name
5709 \begin_layout Itemize
5716 (2.8) -- same as for
5723 \begin_layout Itemize
5730 (2.9) -- will have extra {} after it.
5731 This should not cause an error.
5734 \begin_layout Itemize
5741 (2.11) -- will have extra {} after it.
5742 This should not cause an error.
5745 \begin_layout Itemize
5752 (2.14.2) -- you can insert an optional filename argument by placing the cursor
5753 at the beginning of the text and selecting
5755 Insert\SpecialChar \menuseparator
5760 \begin_inset Quotes eld
5764 \begin_inset Quotes erd
5767 inserts an optional argument of the type needed by
5774 Hopefully it will be renamed someday.
5777 \begin_layout Itemize
5790 for the catalog ID optional parameter
5793 \begin_layout Itemize
5806 for the catalog ID optional parameter
5809 \begin_layout Subsubsection
5810 Things not implemented, use ERT
5813 \begin_layout Standard
5817 \begin_layout Standard
5829 \begin_layout Standard
5852 setcounter{equation}
5854 (2.12), Journal name abbreviations (2.13.4),
5890 (2.15.4, insert it as the first element in the lefthand cell after where
5892 Don't use any of LyX's rules in the table),
5904 (2.15.5), much of Misc (2.17, except
5955 \begin_layout Standard
5959 \begin_layout Standard
5971 \begin_layout Subsubsection
5972 Things that cannot be implemented
5975 \begin_layout Standard
5976 \SpecialChar \ldots{}
5977 at least in any meaningful sort of way, so I suggest ignoring them.
5978 They are the references environment (2.13.3), and the deluxetable environment
5980 If you really, really need to use deluxetable, I suggest editing it in
5981 a separate file with a text editor, then using
5986 nsert\SpecialChar \menuseparator
5994 to include it in your LyX document.
5999 file to see an example of this.
6002 \begin_layout Subsection
6003 FAQs, Tips, Tricks, and Other Ruminations
6006 \begin_layout Subsubsection
6007 Getting LyX and AASTeX to cooperate
6010 \begin_layout Standard
6011 It can be a bit tricky to get LyX to recognize a new layout and document
6013 When all else fails, do this:
6016 \begin_layout Enumerate
6017 Make certain that LaTeX can find AASTeX.
6018 Copy sample.tex (and perhaps table.tex) from the AASTeX distribution into
6019 a directory completely unrelated to LaTeX or AASTeX and run LaTeX on
6026 \begin_layout Enumerate
6033 /usr/.../share/lyx/layouts
6042 \begin_layout Enumerate
6048 ools\SpecialChar \menuseparator
6055 in LyX, then restart LyX.
6058 \begin_layout Enumerate
6059 Open a regular new file, not from a template.
6060 Does AASTeX appear in the class list in
6065 ocument\SpecialChar \menuseparator
6075 \begin_layout Standard
6076 If you get a warning from an existing AASTeX document about not being able
6077 to find the AASTeX layout or a message about
6078 \begin_inset Quotes eld
6081 You should not mix title layouts with normal ones
6082 \begin_inset Quotes erd
6085 , things haven't been installed correctly.
6088 \begin_layout Subsubsection
6089 LaTeX error processing a table
6092 \begin_layout Standard
6093 LyX, by default, attempts to center the table caption/title.
6094 This seems to produce a bad interaction in AASTeX so you should click somewhere
6095 in the caption/title, then select
6100 dit\SpecialChar \menuseparator
6105 aragraph\InsetSpace ~
6120 This took care of it for me.
6123 \begin_layout Subsubsection
6125 \begin_inset LatexCommand label
6133 \begin_layout Standard
6134 A couple of things: 1) I have noticed some funny spacing in the reference
6135 entries in the text.
6136 When you enter the bibliography item data, make sure their is
6140 space between the last author and the parenthesis setting off the year;
6143 e.\InsetSpace \thinspace{}
6156 2) Entering the references at all is not obvious.
6157 The easiest thing is to start typing your first reference at the end of
6158 the document, then mark it as type
6163 That will put a small gray box in front of what you just typed.
6164 Click on the box to fill in the rest of the information.
6165 For new references, go to the end of an existing reference and press return.
6166 That will create a new line with its own box, etc.
6169 \begin_layout Subsubsection
6173 \begin_layout Standard
6174 Even though AASTeX provides its own figure commands (
6180 , for example), I much prefer LaTeX's standard figure commands (with the
6189 commands as ERT into a Figure Float box if you desire, but I never
6190 have much luck getting the layout right.
6191 With the standard graphics, LyX will insert a
6195 usepackage{graphicx}
6197 command into the LaTeX preamble and handle the figures in the standard
6198 LaTeX2e way, interspersing the figures in the text.
6199 I believe ApJ accepts figures exactly this way now; AJ might still use
6201 \begin_inset Quotes eld
6204 stack everything at the end
6205 \begin_inset Quotes erd
6211 \begin_layout Subsubsection
6212 Things I could have done, but didn't
6215 \begin_layout Standard
6217 \begin_inset Quotes eld
6221 \begin_inset Quotes erd
6224 things I could have implemented, but chose not to.
6225 For instance, I saw no point in double-spacing the text in the LyX window,
6226 even though it is double-spaced in the paper manuscript.
6227 Also, I chose not to make separate layouts for the preprint and preprint2
6229 Since I assume you will spend most of your time in the plain manuscript
6230 mode anyway, I decided not to chew up more disk space with this.
6234 \begin_layout Subsection
6238 \begin_layout Standard
6239 Your mileage may vary.
6240 I've now had papers published by both ApJ and AJ that have had 98% of the
6241 effort done in LyX; the last 2% was the LaTeX post-processing and a few
6243 I have had no trouble with the submission process, and I'm sure the journals
6244 were never aware that there might be a difference.
6245 So, go forth and publish!
6248 \begin_layout Section
6252 \begin_layout Standard
6255 Panayotis Papasotiriou
6258 \begin_layout Subsection
6262 \begin_layout Standard
6263 The ijmpc package is a set of macros that facilitates electronic manuscript
6266 International Journal of Modern Physics C
6269 Similarly, the ijmpd package is for creating manuscripts to be submitted
6272 International Journal of Modern Physics D
6275 Both journals are published by World Scientific.
6276 The corresponding document classes are named
6285 These files, together with instructions for the authors, can be downloaded
6287 \begin_inset LatexCommand url
6288 target "http://www.worldscinet.com/ijmpc/mkt/guidelines.shtml"
6293 \begin_inset LatexCommand url
6294 target "http://www.worldscinet.com/ijmpd/mkt/guidelines.shtml"
6299 Both packages are modified versions of the standard
6300 \begin_inset Quotes eld
6304 \begin_inset Quotes erd
6307 package, and they are almost (but not exactly) identical.
6308 Most of their features are supported by LyX.
6309 I have used LyX successfully to write articles submitted to both journals
6310 without any problem.
6313 \begin_layout Subsection
6317 \begin_layout Standard
6318 As usual, the easiest way to write a paper is to start with a template.
6324 ile\SpecialChar \menuseparator
6340 This will give an (almost) empty document that includes the most common
6341 fields found in a manuscript.
6342 Simply overwrite the existing text (including the brackets,
6347 You should keep in mind the following remarks.
6350 \begin_layout Enumerate
6351 LyX won't let you change the font size and the page style of the document,
6352 because such modifications are not allowed by both packages.
6355 \begin_layout Enumerate
6356 The language of the document should not be changed.
6357 Before previewing your paper, be sure that the babel package is not used.
6358 To do this, click on
6363 ools\SpecialChar \menuseparator
6381 checkbox in the language settings, and click on
6392 , if you wish to make this change permanent).
6395 \begin_layout Enumerate
6397 \begin_inset Quotes eld
6401 \begin_inset Quotes erd
6404 style must be used to define keywords.
6407 \begin_layout Enumerate
6408 The ijmpc package provides a style named
6409 \begin_inset Quotes eld
6412 Classification Codes
6413 \begin_inset Quotes erd
6416 , which can be used to define classification codes, such as PACS numbers.
6417 Note that this facility is not supported by the ijmpd package.
6420 \begin_layout Enumerate
6421 Several new environments are available:
6422 \begin_inset Quotes eld
6426 \begin_inset Quotes erd
6430 \begin_inset Quotes eld
6434 \begin_inset Quotes erd
6438 \begin_inset Quotes eld
6442 \begin_inset Quotes erd
6446 \begin_inset Quotes eld
6450 \begin_inset Quotes erd
6454 \begin_inset Quotes eld
6458 \begin_inset Quotes erd
6462 \begin_inset Quotes eld
6466 \begin_inset Quotes erd
6470 \begin_inset Quotes eld
6474 \begin_inset Quotes erd
6478 \begin_inset Quotes eld
6482 \begin_inset Quotes erd
6486 \begin_inset Quotes eld
6490 \begin_inset Quotes erd
6494 \begin_inset Quotes eld
6498 \begin_inset Quotes erd
6502 \begin_inset Quotes eld
6506 \begin_inset Quotes erd
6510 \begin_inset Quotes eld
6514 \begin_inset Quotes erd
6518 \begin_inset Quotes eld
6522 \begin_inset Quotes erd
6526 \begin_inset Quotes eld
6530 \begin_inset Quotes erd
6534 Their use is more or less obvious.
6535 LyX supports all these environments; it will use the proper label, text
6536 style, and numbering scheme for each of them.
6539 \begin_layout Enumerate
6540 Both packages use basic citations; the natbib package should not be used.
6541 In LyX, citation references are shown as usual; in the output, citations
6542 are shown as superscripts.
6543 If you want to use a citation as normal text, you should use the
6547 command, e.\InsetSpace \thinspace{}
6549 \begin_inset Quotes eld
6552 See Ref.\InsetSpace ~
6560 \begin_inset Quotes erd
6566 \begin_layout Enumerate
6568 \begin_inset Quotes eld
6572 \begin_inset Quotes erd
6575 section in both packages.
6576 To put acknowledgments, just use the
6577 \begin_inset Quotes eld
6581 \begin_inset Quotes erd
6587 \begin_layout Enumerate
6588 Appendices may be added to the paper,
6592 the Acknowledgments and
6597 LyX provides a special environment, called
6598 \begin_inset Quotes eld
6602 \begin_inset Quotes erd
6605 which marks the beginning of the appendices.
6606 This environment should be left blank; it just sends a LaTeX command, but
6607 nothing is really printed.
6609 \begin_inset Quotes eld
6613 \begin_inset Quotes erd
6616 is printed with blue letters, as a signal that all sections after that
6617 point are appendices.
6618 To write an appendix, use the
6619 \begin_inset Quotes eld
6623 \begin_inset Quotes erd
6627 LyX will number each appendix with capital letters, as required by both
6630 \begin_inset Quotes eld
6634 \begin_inset Quotes erd
6641 be present before the first appendix; if not, all appendices will be numbered
6642 as normal sections in the output.
6645 \begin_layout Enumerate
6646 The ijmpc and the ijmpd packages use the
6650 command to implement table captions.
6651 As a result, a table created by LyX is printed correctly, but its caption
6653 However, you can use some ERT to overpass this problem, so that captions
6654 are printed as expected.
6655 To do so, create a float table as usual, remove the caption, and replace
6666 (sic); you must also the ERT
6670 immediately after the tabular material.
6671 Study the example table included in the template files to see how this
6672 trick is implemented.
6673 Alternatively, If you need table captions, you should implement the whole
6678 file, then include this file to the LyX document (
6683 nsert\SpecialChar \menuseparator
6688 \SpecialChar \menuseparator
6697 Details on how to create a table float can be found in the files
6705 , included in the corresponding packages.
6708 \begin_layout Subsection
6709 Preparing a paper for submission
6712 \begin_layout Standard
6713 Before you submit your paper you must export the LyX document as a LaTeX
6719 ile\SpecialChar \menuseparator
6724 xport\SpecialChar \menuseparator
6739 \begin_layout Standard
6740 Actually you have the choice between LaTeX (plain) and pdflatex.
6741 If you intend to use pdflatex to prepare the paper, you should use the
6742 pdflatex option so that included graphics are converted to PDF format,
6743 ready for use by pdflatex.
6748 , then make the following changes to the resulting
6755 \begin_layout Enumerate
6756 Remove the comment lines before the
6765 \begin_layout Enumerate
6766 Remove everything between (and including) the
6778 commands, except for any commands you specifically put into the LaTeX preamble.
6781 \begin_layout Standard
6786 file should be saved and processed through LaTeX as many times as necessary.
6787 You may also want to check the resulting
6794 \begin_layout Subsection
6798 \begin_layout Standard
6799 The use of ERT is reduced to two commands, which must be placed at the top
6801 If you started writing your paper by using the
6809 template, the ERT needed is already in its place; you usually don't need
6811 You may only modify the first ERT to specify the information printed to
6812 the top of odd and even pages (authors' names and short paper's title,
6814 This ERT must have the form
6818 markboth{Authors' Names}{Short Paper's Title}
6823 \begin_layout Section
6827 \begin_layout Standard
6830 Panayotis Papasotiriou
6833 \begin_layout Subsection
6837 \begin_layout Standard
6838 The Kluwer package is a set of macros produced by Kluwer Academic Publishers
6839 that facilitates electronic manuscript submission to the journals they
6841 Most known of them (at least in my domain of interest) are
6843 Astrophysics and Space Science
6849 , but there are many others (see a complete list at
6850 \begin_inset LatexCommand url
6851 target "http://www.wkap.nl/jrnllist.htm/JRNLHOME"
6856 The Kluwer package may be downloaded from the site
6857 \begin_inset LatexCommand url
6858 target "http://www.wkap.nl/kaphtml.htm/STYLEFILES"
6863 A complete user guide is contained in that package (but it can also be
6864 downloaded separately).
6867 \begin_layout Standard
6868 LyX supports many features of the package but not everything.
6869 However, the ERT needed is reduced to some
6870 \begin_inset Quotes eld
6874 \begin_inset Quotes erd
6877 commands of the package (see\InsetSpace ~
6879 \begin_inset LatexCommand ref
6880 reference "subsec:kluwer_peculiarities"
6885 I have recently used LyX to write an article submitted to the
6887 Astrophysics and Space Science
6889 without any problem.
6892 \begin_layout Subsection
6896 \begin_layout Standard
6897 The easiest way to write a paper is to start with the Kluwer template file.
6900 File\SpecialChar \menuseparator
6912 This will give an (almost) empty document that includes the most common
6913 fields found in a manuscript and a short description of their use.
6914 As in most templates, simply overwrite the existing text (including the
6919 ) with the correct information.
6922 \begin_layout Subsection
6923 Preparing a paper for submission
6926 \begin_layout Standard
6927 As in the AASTeX package, before you submit your paper to a journal you
6929 \begin_inset Quotes eld
6933 \begin_inset Quotes erd
6939 \begin_layout Enumerate
6940 Export your paper as a LaTeX file.
6941 To do this, click on
6946 ile\SpecialChar \menuseparator
6951 xport\SpecialChar \menuseparator
6962 \begin_layout Enumerate
6967 file with a text editor and make the following changes
6971 \begin_layout Enumerate
6972 remove the comment lines before the
6981 \begin_layout Enumerate
6982 remove everything between (and including) the
6994 commands, except for any commands you specifically put into the LaTeX preamble.
6997 \begin_layout Standard
7006 \begin_layout Enumerate
7011 file through LaTeX as many times as necessary (usually up to three).
7014 \begin_layout Enumerate
7019 document using, e.\InsetSpace \thinspace{}
7024 , and check if everything is OK (it should, if you didn't make any mistake).
7027 \begin_layout Subsection
7028 \begin_inset Quotes eld
7032 \begin_inset Quotes erd
7035 of the Kluwer package
7036 \begin_inset LatexCommand label
7037 name "subsec:kluwer_peculiarities"
7044 \begin_layout Standard
7045 The Kluwer package has the following
7046 \begin_inset Quotes eld
7050 \begin_inset Quotes erd
7056 \begin_layout Enumerate
7057 It is possible to write multiple articles in the same LaTeX file
7061 \begin_layout Standard
7062 I can't imagine any good reason to do this.
7068 Each article must be included in the environment
7069 \begin_inset Quotes eld
7073 \begin_inset Quotes erd
7077 Unfortunately, this environment cannot be omitted, even if you write just
7079 Therefore, each article starts with the command
7085 and, obviously, ends with the command
7092 Although this can be implemented in LyX, I didn't included it, since it
7093 looks ugly and can confuse the novice user.
7094 Therefore, you need to enter them directly and mark them as LaTeX code
7096 \begin_inset Quotes eld
7100 \begin_inset Quotes erd
7106 \begin_layout Enumerate
7107 Information given at the beginning of the article (i.e., title, subtitle,
7108 author, institution, running title, running author, abstract and keywords)
7109 must be included in an environment called
7110 \begin_inset Quotes eld
7114 \begin_inset Quotes erd
7118 This is not implemented in LyX, so you must enter title, subtitle etc.\InsetSpace ~
7135 \begin_layout Enumerate
7136 According to the user manual, the label of each bibliography item must be
7160 \begin_layout Standard
7165 template takes care of all these
7166 \begin_inset Quotes eld
7170 \begin_inset Quotes erd
7174 If you start a new paper using this template you don't need to do anything
7179 \begin_layout Enumerate
7180 don't delete the ERT included in the template, and
7183 \begin_layout Enumerate
7184 copy the example bibliography item included in the template and modify it
7185 as necessary to enter new bibliography items.
7188 \begin_layout Section
7192 \begin_layout Standard
7198 \begin_layout Subsection
7202 \begin_layout Standard
7203 The LyX document classes
7205 article (koma-script)
7209 report (koma-script)
7227 correspond to the LaTeX document classes
7243 , resp.\InsetSpace ~
7244 of the Koma-Script family.
7245 They are replacements for the standard document classes
7261 , resp., and fit better to European typography conventions in a number of
7265 \begin_layout Itemize
7266 Standard character size is 11pt in
7268 article (koma-script)
7272 report (koma-script)
7280 letter (koma-script)
7285 \begin_layout Itemize
7286 Headings, labels of the description environment, and a number of elements
7289 letter (koma-script)
7291 document class are set in a bold sans serif font.
7295 \begin_layout Standard
7296 There is a big difference between the bold sans serif old cm fonts and new
7297 ec fonts, especially in the appearance of headings.
7298 In comparison, the ec bold sans serif fonts look a bit thin.
7299 Here the LaTeX package
7306 helps to produce the
7307 \begin_inset Quotes eld
7311 \begin_inset Quotes erd
7314 appearance when using the ec fonts.
7319 The numbering of chapter headings is made in the same way as the numbering
7320 of section headings, that is without the extra line
7321 \begin_inset Quotes eld
7324 Chapter\SpecialChar \ldots{}
7326 \begin_inset Quotes erd
7330 In addition, the appearance of the headings can be modified by using a
7331 number of options (in LyX to be entered in the field
7345 ayout\SpecialChar \menuseparator
7353 A detailed German description of these options can be found in the Koma-Script
7361 \begin_layout Itemize
7362 The main means in the Koma-Script document classes to design the type area
7371 (in LyX to be entered in the extra class options field in the dialog
7376 ocument\SpecialChar \menuseparator
7384 They make a clearer modification of page margins possible as do the options
7390 ocument\SpecialChar \menuseparator
7398 A detailed German description of these and other type area options can
7399 be found in the Koma-Script documentation
7406 \begin_layout Itemize
7407 The LaTeX document classes of the Koma-Script family define a number of
7408 additional commands.
7409 Those part of it which makes sense in LyX is implemented in corresponding
7413 \begin_layout Standard
7414 A detailed German description of the LaTeX document classes of the Koma-Script
7415 family can be found in the Koma-Script documentation
7423 \begin_layout Standard
7424 There is an English translation
7428 , but it is not a complete one.
7433 The following sections describe only those aspects, which are relevant
7437 \begin_layout Subsection
7438 article (koma-script), report (koma-script), and book (koma-script)
7441 \begin_layout Standard
7442 The document classes
7444 article (koma-script)
7448 report (koma-script)
7458 are implemented in the layout files
7471 They contain all the paragraph types of the corresponding standard document
7484 , resp., partly modified, with the exception of the LyX specific
7488 -type, which is replaced by the new
7492 -type having the same functionality.
7497 -Type there is a number of new paragraph types added.
7504 letter (koma-script)
7509 \begin_layout Itemize
7518 : are equivalents to
7526 , resp., additionally inserting an entry in the table of contents.
7535 are not contained in
7537 article (koma-script)
7542 \begin_layout Itemize
7559 , resp., additionally clearing running heads.
7566 article (koma-script)
7572 \begin_layout Standard
7585 report (koma-script)
7587 , but since this is identical to
7591 , is has not been implemented in LyX.
7599 \begin_layout Itemize
7604 : generates a heading directly above the following paragraph in the standard
7605 character size without affecting the structure of the document.
7608 \begin_layout Itemize
7617 are special captions which respect the different space settings needed for
7618 captions placed above or below an element (if you follow strict typographic
7619 rules, you might want to place table captions always above the table).
7620 You can also use the class option
7637 You need at least Koma-Script version 2.8q to use this.
7640 \begin_layout Itemize
7645 : can be used to set a bonmot, e.
7649 \begin_layout Standard
7662 \begin_layout Standard
7671 at the beginning of a chapter.
7672 If you use the optional argument (
7677 nsert\SpecialChar \menuseparator
7681 ), you can insert the dictum's author there.
7682 Dictum and author are separated by a line.
7683 You need at least Koma-Script version 2.8q to use this.
7690 article (koma-script)
7695 \begin_layout Standard
7696 The following types, together with the standard types
7708 , form the title area of the document.
7709 They must be entered ahead of the first
7710 \begin_inset Quotes eld
7714 \begin_inset Quotes erd
7721 \begin_layout Standard
7722 The corresponding LaTeX commands must appear before the
7733 When such a type is used more than once, the latter usage overwrites the
7734 former one, that means, for every type only the latest usage is valid.
7735 The order of the different types however has, like
7747 , no effect on the appearance of the produced document.
7750 \begin_layout Itemize
7755 : produces a centered paragraph above the ordinary title (
7767 ) for the subject of the document.
7770 \begin_layout Itemize
7775 : produces a centered paragraph below the ordinary title (
7787 ) for the publishers' name.
7790 \begin_layout Itemize
7797 report (koma-script)
7803 produces a centered paragraph on its own page behind the title page, or
7806 article (koma-script)
7808 produces a centered paragraph below the ordinary title (
7827 \begin_layout Itemize
7832 : produces a left aligned paragraph above the ordinary title (
7848 ) for a document`s head.
7851 \begin_layout Itemize
7856 : produces in a double-sided print in
7858 report (koma-script)
7864 a left-aligned paragraph at the top of the title page`s back or has no
7865 effect in a single-sided print or in
7867 article (koma-script)
7872 \begin_layout Itemize
7877 : produces in a double-sided print in
7879 report (koma-script)
7885 a left-aligned paragraph at the bottom of the title page`s back or has
7886 no effect in a single-sided print or in
7888 article (koma-script)
7893 \begin_layout Itemize
7898 : produces a special
7899 \begin_inset Quotes eld
7903 \begin_inset Quotes erd
7906 page ahead of the actual document containing a paragraph without special
7910 \begin_layout Standard
7911 The layout files for the document classes
7913 article (koma-script)
7917 report (koma-script)
7928 This is thought of as a place to define your own types.
7933 in your personal layout directory and edit the file!
7936 \begin_layout Subsection
7937 letter (koma-script)
7940 \begin_layout Standard
7944 \begin_layout Standard
7956 \begin_layout Standard
7960 letter (koma-script)
7962 is implemented in the layout file
7967 It contains all the paragraph types of the corresponding standard document
7972 , partly modified, with the exception of the LyX specific types
7984 type, which is replaced by the new
7989 In addition, it contains, in contrast to the standard document class, the
8007 Furthermore, there are a number of new letter specific types.
8010 \begin_layout Standard
8014 \begin_layout Standard
8026 \begin_layout Standard
8027 The appearance of the letter produced by this document class can be controlled
8028 by a number of LaTeX commands, which you can put in the LaTeX preamble.
8032 \begin_layout Standard
8033 For example, the standard appearance of the letter`s heading, consisting
8034 of name and address, is quite self-willed.
8036 \begin_inset Quotes eld
8040 \begin_inset Quotes erd
8043 heading is produced by the following LaTeX commands in the preamble:
8046 \begin_layout LyX-Code
8056 \begin_layout LyX-Code
8072 \begin_layout LyX-Code
8082 \begin_layout LyX-Code
8102 A detailed German description of such LaTeX commands can be found in the
8103 Koma-Script documentation
8108 With it, the letter's author can produce his personal letter layout.
8111 \begin_layout Standard
8120 define the beginning of the letter and must be used in every letter.
8121 To emphasize them in the LyX document class, they are marked with the letter
8130 , resp.\InsetSpace ~
8132 It is possible to write any number of letters in one file.
8137 type produces a new letter using the same addressee and a
8141 type produces a new addressee.
8158 are ordinary paragraph types and can also be used several times in one
8159 and the same letter.
8162 \begin_layout Itemize
8167 : produces a paragraph for the addressee and implicitly defines the beginning
8171 \begin_layout Itemize
8176 : produces a paragraph for the form of address and implicitly produces a
8180 \begin_layout Itemize
8185 : produces a paragraph for a close.
8188 \begin_layout Itemize
8193 : produces a paragraph for a postscript.
8196 \begin_layout Itemize
8201 : produces a paragraph for a distribution list.
8204 \begin_layout Itemize
8209 : produces a paragraph for enclosures.
8212 \begin_layout Standard
8253 are input types provided with a label to enter information, which will
8254 be processed by the document class.
8258 \begin_layout Standard
8259 It could be seen as a matter of inconsequence, that the types
8267 described above are not such input types as well.
8268 Because of the special meaning of those types, however, I have implemented
8269 them as ordinary paragraph types with a one letter mark in the left margin.
8270 Moreover, it would affect my feeling of symmetry, if the
8278 type had such a serious different appearance.
8283 The types must be used ahead of the corresponding
8290 \begin_layout Standard
8291 An implementation of these types in a WYSIWYG fashion does not seem to make
8292 sense, because the real appearance of the produced letter does not only
8293 depend on the usage of the particular type, but also on other factors.
8294 For example, a signature entered in the
8298 type will in the standard behavior appear in the produced letter only,
8299 when in the same letter also a
8304 The entered value of the
8308 type will in the standard behavior not appear in the produced letter at
8310 The possibility to design the letter`s heading freely is already indicated
8311 in a footnote above.
8314 \begin_layout Standard
8315 The input types can also be used as empty paragraphs.
8316 This makes sense e.\InsetSpace \thinspace{}
8327 type is not used at all, in the standard behavior the value of the
8331 type is used as signature, whereas if an empty
8335 type is used, no signature value is defined.
8338 \begin_layout Standard
8339 By using the input types it is possible to write a letter template, containing
8340 filled input types with your personal dates (name, address, etc.) and empty
8341 input types for other dates you want to enter.
8344 \begin_layout Itemize
8349 : sender's name, in the standard behavior appears as a centered paragraph
8350 in small caps in the letter`s heading.
8353 \begin_layout Itemize
8358 : sender's signature, in the standard behavior appears below the
8367 type is used, the value of the
8371 type appears instead.
8374 \begin_layout Itemize
8379 : sender's address, in the standard behavior appears in a centered paragraph
8380 in the letter`s heading below the sender's name.
8383 \begin_layout Itemize
8388 : sender's telephone number, in the standard behavior only sets the LaTeX
8398 \begin_layout Itemize
8403 : place of the letter`s making.
8406 \begin_layout Itemize
8411 : date of the letter`s making.
8420 , in the standard behavior, produce the place and the date in a right-aligned
8421 line below the addressee's field.
8426 type is used, neither place nor date appear, independent of the value of
8436 type is used, the date of the letter `s production is used.
8439 \begin_layout Itemize
8444 : sender`s back address, in the standard behavior appears above the addressee's
8445 field in a small sans serif font.
8448 \begin_layout Itemize
8453 : special mail information, in the standard behavior appears underlined
8454 above the addressee's field below the back address.
8457 \begin_layout Itemize
8462 : additional information, in the standard behavior appears on right side
8463 below the addressee`s field.
8466 \begin_layout Itemize
8471 : the letter's title, in the standard behavior appears in a big, bold, sans
8472 serif font above the subject.
8475 \begin_layout Itemize
8480 : the letter's subject, in the standard behavior appears in a bold font
8488 \begin_layout Standard
8509 produce a business letter like line above the
8513 line containing the fields
8514 \begin_inset Quotes eld
8518 \begin_inset Quotes erd
8522 \begin_inset Quotes eld
8526 \begin_inset Quotes erd
8530 \begin_inset Quotes eld
8534 \begin_inset Quotes erd
8538 \begin_inset Quotes eld
8542 \begin_inset Quotes erd
8546 \begin_inset Quotes eld
8550 \begin_inset Quotes erd
8554 \begin_inset Quotes eld
8558 \begin_inset Quotes erd
8562 For the date field, the value of the
8568 \begin_inset Quotes eld
8571 business letter types
8572 \begin_inset Quotes erd
8575 is used, the value of the
8579 type however does not appear, but only the LaTeX variable
8586 The ordinary output of place and date in a right-aligned line below the
8587 addressee`s field is suppressed.
8588 The types are implemented as input types provided with a label and must
8589 be used ahead of the corresponding
8596 \begin_layout Itemize
8604 \begin_layout Itemize
8612 \begin_layout Itemize
8620 \begin_layout Itemize
8628 \begin_layout Itemize
8636 \begin_layout Subsection
8637 The new letter class: letter (koma-script v.2)
8640 \begin_layout Standard
8643 Jürgen Spitzmüller
8646 \begin_layout Standard
8647 \begin_inset VSpace medskip
8653 \begin_layout Standard
8655 Koma-Script version 2.8 has introduced a new letter class
8659 which supersedes the now unsupported
8664 It has --- on the LaTeX side --- a completely new interface and is not
8665 compatible with the old class.
8666 Therefore, LyX supports both, though it is recommended to use the new class.
8669 \begin_layout Standard
8670 This class covers the same functionality as
8672 letter (koma-script),
8679 (receiver's address, same as
8696 will start a new letter (i.
8700 \begin_layout Standard
8713 \begin_layout Standard
8722 you can write several letters per document).
8723 New elements are sender's
8739 and the possibility to use a
8748 nsert\SpecialChar \menuseparator
8758 \begin_layout Standard
8759 The biggest improvement is, though, that the letter's layout is configurable
8760 at almost any needs.
8761 This can be done via the preamble or with a special style file (Letter
8762 Class Option, extension
8766 ), that will be read in as a class option.
8770 \begin_layout Standard
8771 The KOMA package comes with some default
8776 There is, for instance, a
8780 file that follows german typesetting rules, or a
8784 that provides the default layout of the old
8789 The latter can be loaded with the class option
8798 ayout\SpecialChar \menuseparator
8803 ocument\SpecialChar \menuseparator
8815 template that is included in LyX for examples.
8816 A detailed description is to be found in the Koma-Script documentation
8824 \begin_layout Subsection
8828 \begin_layout Standard
8829 Visualizing the Koma-Script document classes in LyX, the LyX internals cause
8833 \begin_layout Itemize
8834 The chapter number of a
8838 type appears on a line of its own above the chapter heading instead of
8839 appearing in the same line ahead of it.
8840 The cause for that is the LyX internal behavior for the labeltype
8847 \begin_layout Itemize
8848 The headings of the types
8857 \begin_inset Quotes eld
8861 \begin_inset Quotes erd
8864 LaTeX table of contents, but not in the LyX table of contents (
8869 ocument\SpecialChar \menuseparator
8881 \begin_layout Itemize
8886 document class appear in a skip separation mode, not indented.
8887 This is the standard behavior, no special LaTeX commands are needed for
8894 ocument\SpecialChar \menuseparator
8901 dialog the corresponding radio button indicates
8917 value always has the effect that extra LaTeX commands are inserted in the
8918 document to produce the gap, which is not what is wanted in this case.
8921 \begin_layout Section
8929 \begin_layout Standard
8935 \begin_layout Subsection
8939 \begin_layout Standard
8940 These are the layout files for some of the journal formats used by Springer
8941 Verlag and listed on
8942 \begin_inset LatexCommand url
8943 target "http://www.springer.de/author/tex/help-journals.html"
8947 , where you should also go to fetch the class files (yes, these are LaTeX2e
8949 It is a modular system: the things common to all journals are implemented
8954 , which journal-specific layout files (such as, e.\InsetSpace \thinspace{}
8959 for Journal of Geodesy) can include.
8962 \begin_layout Standard
8963 This means that implementing support for any other Springer journal on this
8964 list is as simple as writing your own
8972 file following the outline given in
8980 \begin_layout Standard
8981 It is reasonably well tested only for the Journal of Geodesy.
8990 come with the standard LyX distribution.
8991 Install the relevant class file (downloaded from Springer) in a proper
8992 directory, reconfigure LaTeX (in the teTeX case by running
8996 , as root if necessary --- doesn't LyX take care of this?), reconfigure
8997 LyX and it should work.
9000 \begin_layout Subsection
9004 \begin_layout Standard
9005 A large number of theorem-like styles ---
9011 \SpecialChar \ldots{}
9017 \begin_layout Standard
9020 Headnote, Dedication, Subtitle, Running_LaTeX_Title, Author_Running, Institute,
9021 Mail, Offprints, Keywords, Acknowledgements, Acknowledgement
9024 See the Springer class file documentation for details.
9027 \begin_layout Subsection
9031 \begin_layout Itemize
9043 \begin_layout Itemize
9046 Probability Theory and Related Fields
9052 --- Jean-Marc Lasgouttes
9055 \begin_layout Standard
9056 Add your own, it isn't so hard!
9059 \begin_layout Subsection
9063 \begin_layout Standard
9064 These files are partly based on the older
9068 , which was again based on a tinkered-with version of an old LaTeX 2.09 style
9074 layout, are now defunct.
9075 Jean-Marc Lasgouttes helped out big in making me find my way around the
9076 LyX layout file mechanism.
9079 \begin_layout Subsection
9083 \begin_layout Standard
9085 But probably less than in the old hacked-LaTeX
9092 \begin_layout Standard
9093 Limitations e.\InsetSpace \thinspace{}
9094 g.: does not display the number for theorem-like layouts, just
9098 \begin_layout Section
9106 \begin_layout Standard
9112 \begin_layout Subsection
9116 \begin_layout Standard
9117 These are the layout files for some of the journals of the American Geophysical
9119 It is assumed that you have both the AGU's own class files and AGUplus
9120 installed (everything to be found at
9121 \begin_inset LatexCommand url
9122 target "ftp://ftp.agu.org/journals/latex/journals"
9129 \begin_layout Subsection
9133 \begin_layout Standard
9143 They are still called this in the LyX GUI, though their LaTeX equivalents
9144 in the AGU classes are
9155 \begin_layout Standard
9156 Newly defined styles are
9193 These are mostly manuscript attributes and defined in the AGU class documentati
9197 \begin_layout Standard
9198 I suspect this is still badly incomplete.
9201 \begin_layout Subsection
9205 \begin_layout Standard
9222 \begin_layout Subsection
9226 \begin_layout Itemize
9229 Journal of Geophysical Research
9238 \begin_layout Standard
9239 Add your own, it isn't so hard! Look at the
9250 \begin_layout Subsection
9251 Bugs and things to remember
9254 \begin_layout Standard
9255 In order to use the new layouts, you must remember to do the following for
9259 \begin_layout Enumerate
9265 This can be done in the
9267 layout\SpecialChar \menuseparator
9272 document\SpecialChar \menuseparator
9276 (AGU articles are always in English, right? So
9283 \begin_layout Enumerate
9293 (Yes, this is a bug.)
9296 \begin_layout Enumerate
9297 Make sure you use the
9301 bibliography style, by entering
9305 into the second field of the BibTeX inset.
9306 None of the standard styles will do.
9309 \begin_layout Section
9317 \begin_layout Standard
9323 \begin_layout Subsection
9327 \begin_layout Standard
9328 This is the layout file for the European Geophysical Society journals.
9333 can be downloaded from the web site of the EGS under
9334 \begin_inset LatexCommand url
9335 target "www.copernicus.org"
9342 \begin_layout Subsection
9346 \begin_layout Standard
9349 Right_address, Latex_Title, Affil, Journal, msnumber, FirstAuthor, Received,
9357 The current layout file is unfortunately very unmodular and would benefit
9358 from using the various
9365 \begin_layout Section
9371 \begin_inset LatexCommand label
9379 \begin_layout Standard
9387 \begin_layout Subsection
9391 \begin_layout Standard
9392 This section describes how to use LyX to make slides for overhead projectors.
9393 There are two document classes that can do this: the default slides class
9399 This section documents the former.
9402 \begin_layout Standard
9403 I'm going to say this again, nice and clear, so that there's no misunderstanding
9407 \begin_layout Standard
9408 \begin_inset VSpace bigskip
9414 \begin_layout Standard
9418 This section documents the class
9419 \begin_inset Quotes eld
9427 \begin_inset Quotes erd
9435 \begin_layout Standard
9436 \begin_inset VSpace bigskip
9442 \begin_layout Standard
9443 If you're looking for the documentation for
9444 \begin_inset Quotes eld
9452 \begin_inset Quotes erd
9455 , check out section\InsetSpace ~
9457 \begin_inset LatexCommand ref
9458 reference "sec:foiltex"
9468 \begin_inset Quotes eld
9476 \begin_inset Quotes erd
9479 ] is actually somewhat better than the default
9487 \begin_layout Standard
9488 \SpecialChar \ldots{}
9489 or so I've been told repeatedly by its advocates.
9490 Having never used it, I have no idea if this claim is true or not.
9495 which this section documents.
9498 \begin_layout Standard
9499 This class is the LaTeX2e improvement of the old
9504 Every LaTeX2e distribution includes this class [which I'll just refer to
9506 \begin_inset Quotes eld
9514 \begin_inset Quotes erd
9517 from now on], so you're bound to have it.
9518 As I noted earlier, there are other classes, such as
9522 , which also produce slides for overhead projectors and do a better job
9524 However, there are some things which
9528 can do which the others can't, such as generate overlays.
9529 Read on to learn more!
9532 \begin_layout Subsection
9534 \begin_inset LatexCommand label
9535 name "sec:slidesetup"
9542 \begin_layout Standard
9543 Obviously, to use this document class, you need to select
9544 \begin_inset Quotes eld
9552 \begin_inset Quotes erd
9555 from the class list in the
9560 ocument\SpecialChar \menuseparator
9568 There are some other special things you should know about this class:
9571 \begin_layout Itemize
9572 Don't bother changing the options
9577 They're not supported by the
9584 \begin_layout Itemize
9593 behaves a bit differently for this class.
9594 The possible choices and what they do are as follows:
9598 \begin_layout Description
9603 The final output contains page numbers in the lower right corner.
9606 \begin_layout Description
9615 , but also prints out any time markers you've put in.
9616 This is the default.
9619 \begin_layout Description
9624 The final output contains no page numbers, time markers, or alignment markers.
9628 \begin_layout Itemize
9633 class has an extra option:
9639 \begin_inset Quotes eld
9647 \begin_inset Quotes erd
9650 in the extra class options.
9654 \begin_layout Standard
9655 Using this options allows you to add time markers to
9660 See section\InsetSpace ~
9662 \begin_inset LatexCommand ref
9663 reference "sec:slideNote"
9671 \begin_layout Standard
9672 You can also use the template file
9673 \begin_inset Quotes eld
9681 \begin_inset Quotes erd
9684 to automatically set up a document to use the
9693 ile\SpecialChar \menuseparator
9702 to open your new document].
9703 The template file also contains some examples of the special paragraph
9704 environments used by this class.
9705 I'll describe those next.
9708 \begin_layout Subsection
9709 Paragraph Environments
9712 \begin_layout Subsubsection
9713 Supported Environments
9716 \begin_layout Standard
9717 The first thing you'll notice when you start up a new
9721 document is the font size and type: it's the equivalent of the size
9722 \begin_inset Quotes eld
9730 \begin_inset Quotes erd
9739 This is also what's used in the output.
9741 \begin_inset Quotes eld
9745 \begin_inset Quotes erd
9748 to remind you that this is a slide.
9749 Your final slides will use a larger font; ergo, you'll have less space.
9750 Of course, the larger default screen font isn't WYSIWYG, only a reminder.
9753 \begin_layout Standard
9754 The next thing that becomes obvious is the changes to the paragraph environment
9755 pull-down box [at the far-left end of the toolbar].
9756 Most of the paragraph environments you're used to seeing are missing.
9757 There are also five new ones.
9762 class itself only supports certain paragraph environments:
9765 \begin_layout Itemize
9771 \begin_layout Itemize
9777 \begin_layout Itemize
9783 \begin_layout Itemize
9789 \begin_layout Itemize
9795 \begin_layout Itemize
9801 \begin_layout Itemize
9807 \begin_layout Itemize
9813 \begin_layout Itemize
9819 \begin_layout Itemize
9825 \begin_layout Itemize
9831 \begin_layout Standard
9832 All of the other standard environments, including the section-heading environmen
9833 ts, aren't used in the
9840 \begin_layout Standard
9841 On the other hand, you'll notice the following new environments:
9844 \begin_layout Itemize
9850 \begin_layout Itemize
9856 \begin_layout Itemize
9862 \begin_layout Itemize
9868 \begin_layout Itemize
9874 \begin_layout Standard
9875 These five are kind of quirky, due to a
9876 \begin_inset Quotes eld
9880 \begin_inset Quotes erd
9884 You see, LyX doesn't permit you to nest any other paragraph environment
9885 into an empty environment.
9886 Now, that's fine and dandy, but it means that you wouldn't be able to start
9887 a slide with anything except plain text.
9888 To deal with this, I've performed a little
9889 \begin_inset Quotes eld
9893 \begin_inset Quotes erd
9899 \begin_layout Subsubsection
9900 Quirks of the New Environments
9901 \begin_inset LatexCommand label
9902 name "sec:slideQuirk"
9909 \begin_layout Standard
9910 All five of the new paragraph environments are somewhat quirky due to inherent
9911 limitiations in the current version of LyX.
9912 As I just mentioned, LyX forbids environments that begin with another environme
9914 To get around this, the
9918 environment isn't a paragraph environment as described in the
9926 \begin_layout Standard
9940 \begin_inset Quotes eld
9943 pseudo-environments.
9944 \begin_inset Quotes erd
9947 They look like a section heading or a
9948 \begin_inset Quotes eld
9956 \begin_inset Quotes erd
9959 but really begin a [and, if necessary, end the previous] paragraph environment.
9969 \begin_inset Quotes eld
9973 \begin_inset Quotes erd
9976 These two perform some action.
9979 \begin_layout Standard
9980 A common feature of all five environments,
10000 , is a rather long-ish label.
10001 The text following this label --- ordinarily the contents of the paragraph
10002 environment --- is utterly irrelevant for
10023 LyX completely ignores it.
10024 In fact, you can leave these five environments completely empty.
10028 \begin_layout Standard
10033 to put any text after the rather long-ish label, you might want to.
10034 This could be a short description of the contents of the
10039 In that case, enter in your descriptive comment and hit
10043 as you normally would.
10046 \begin_layout Standard
10047 If, on the other hand, you don't want to enter in any descriptive text,
10048 you'll hit another LyX quirk.
10049 LyX, like nature, abhors a vacuum, and will not let you start a new paragraph
10050 environment until you put something in the old one.
10054 \begin_layout Itemize
10055 Start entering the text that will
10083 \begin_layout Itemize
10084 Now move to the beginning of that paragraph.
10088 \begin_layout Itemize
10097 \begin_layout Itemize
10098 Finally, change this new, empty paragraph to a
10122 \begin_layout Standard
10123 Some future version of LyX will, hopefully, resolve this quirkiness\SpecialChar \ldots{}
10127 \begin_layout Subsection
10128 Making a Presentation with
10141 \begin_layout Subsubsection
10149 \begin_layout Standard
10150 If you're expecting this section to teach you how to actually make a presentatio
10151 n, you'll be sorely disappointed.
10152 Naturally, I'll describe all of the ways the
10156 class can assist you in preparing the materials for a presentation.
10157 Filling in the contents, however, is up to you.
10162 the LyX philosophy.]
10165 \begin_layout Standard
10170 environment [in the manner described in section\InsetSpace ~
10172 \begin_inset LatexCommand ref
10173 reference "sec:slideQuirk"
10177 ] tells LyX to begin a new slide [duh].
10178 The label for this environment/
10179 \begin_inset Quotes erd
10183 \begin_inset Quotes erd
10187 \begin_inset Quotes eld
10191 \begin_inset Quotes erd
10194 in cool blue, followed by the label,
10195 \begin_inset Quotes eld
10199 \begin_inset Quotes erd
10203 Any text or paragraph environments that follow this one go on the new slide.
10207 \begin_layout Standard
10208 Slides are probably the only time you'll need to forcibly end pages in LyX
10209 (this can be specified in the
10214 In fact, you'll want to, once you finish entering the contents of one slide.
10215 If you've entered more text than can physically fit on a slide, the extra
10216 overflows onto a new slide.
10217 I don't recommend doing this, however, since the overflow slide won't have
10218 any page number on it.
10219 Furthermore, it may interfere with any
10223 you've made to accompany the oversized
10230 \begin_layout Standard
10239 environments work the same way as the
10244 They both create an
10245 \begin_inset Quotes eld
10249 \begin_inset Quotes erd
10252 followed by a label [
10253 \begin_inset Quotes eld
10257 \begin_inset Quotes erd
10261 \begin_inset Quotes eld
10265 \begin_inset Quotes erd
10269 The color is a stunning magenta instead of blue, and the
10270 \begin_inset Quotes eld
10274 \begin_inset Quotes erd
10277 will look different, in style and in length.
10278 The label fonts of all three also differ from one another.
10281 \begin_layout Standard
10286 , if the contents of a
10294 exceed the physical size of a slide or sheet of paper, the extra will overflow
10296 Again, you should avoid this.
10297 It defeats the whole purpose of
10308 \begin_layout Subsubsection
10318 \begin_layout Standard
10323 is a slide that sits atop another slide.
10324 Perhaps you wish to discuss a figure on the main
10328 before displaying the text associated with it.
10329 One way to accomplish this is tape a flap of dark paper over the part of
10334 you want to display later.
10335 This method fails, however, if you wish to overlap one graph with another,
10337 You would then have to fumble while speaking to align the two separate,
10342 s to align the two graphs.
10347 environment in both cases makes life much easier.
10350 \begin_layout Standard
10355 receives the page number of its
10356 \begin_inset Quotes eld
10360 \begin_inset Quotes erd
10368 \begin_inset Quotes eld
10376 \begin_inset Quotes erd
10383 \begin_layout Standard
10384 Presumably, mutliple
10389 \begin_inset Quotes eld
10397 \begin_inset Quotes erd
10401 \begin_inset Quotes eld
10409 \begin_inset Quotes erd
10413 \begin_inset Quotes eld
10421 \begin_inset Quotes erd
10424 , etc.\InsetSpace ~
10425 appended to the page number of the parent
10435 Clearly, you want the contents of both the
10443 to each fit on a single physical slide! You should probably consider an
10449 \begin_inset Quotes eld
10453 \begin_inset Quotes erd
10465 class provides a visual cue for this: the label at the start of an
10469 is shorter than that at the start of a
10474 Lastly, when you generate printable output, you'll find alignment markers
10475 in all four corners of both the
10479 page and its parent
10484 These will assist you in lining up the two physical slides.
10487 \begin_layout Standard
10488 The major problem in overlaying two slides is aligning the contents of the
10489 two transparencies.
10490 How much space should you leave for that graph on the second slide? Worse
10491 still, what if you want a graph and a sentence on second slide, but there
10492 is text on the main transparency that goes in between them? You could try
10493 and insert vertical space of the right size.
10494 The better way is to use
10505 \begin_layout Standard
10506 As their names imply,
10514 are two command-like paragraph environments that make all subsequent text
10515 invisible and visible, respectively.
10516 Note from section\InsetSpace ~
10518 \begin_inset LatexCommand ref
10519 reference "sec:slideQuirk"
10523 that you don't place anything
10527 these two environments, however.
10532 , it inserts a centered, sky-blue label into the page reading
10533 \begin_inset Quotes eld
10536 <Invisible Text Follows>
10537 \begin_inset Quotes erd
10541 For paragraphs following this label, the parts of the
10549 ; it doesn't matter which] where they would be contain instead blank space.
10553 \begin_layout Standard
10558 , the corresponding centered label is
10559 \begin_inset Quotes eld
10562 <Visible Text Follows>
10563 \begin_inset Quotes erd
10567 Paragraphs following this label behave normally.
10568 Note that the beginning of a new
10580 automatically shuts off an
10585 It's therefore not necessary to use
10596 \begin_layout Standard
10597 By now, it should be obvious how to create overlay transparencies using
10598 the proper combination of
10617 \begin_layout Enumerate
10622 , including everything that will appear on it, whether on the main slide
10630 \begin_layout Enumerate
10631 Before each figure or paragraph that will appear only on the
10640 If necessary, insert a
10644 environment after the
10651 \begin_layout Enumerate
10656 immediately following the
10663 \begin_layout Enumerate
10664 Copy the contents of this
10675 \begin_layout Enumerate
10680 , change all of the
10691 \begin_layout Standard
10693 You've just made an
10700 \begin_layout Standard
10701 There's one problem with the way I've designed the LyX
10705 class: you can't make text in the middle of a paragraph invisible, nor
10706 make text in the middle of an invisible paragraph visible again.
10707 To accomplish this feat, you'll need to use some inlined LaTeX codes.
10711 \begin_layout Standard
10712 The commands of interest are:
10715 \begin_layout Itemize
10720 invisible \SpecialChar \ldots{}
10724 \begin_layout Itemize
10729 visible \SpecialChar \ldots{}
10733 \begin_layout Standard
10734 \SpecialChar \ldots{}
10735 and need to be marked as TeX.
10737 \begin_inset Quotes eld
10741 \begin_inset Quotes erd
10744 you wish to change goes in between the brackets [and after the
10757 If you don't know how to mark text as TeX, see the appropriate section
10770 \begin_layout Subsubsection
10780 \begin_inset LatexCommand label
10781 name "sec:slideNote"
10788 \begin_layout Standard
10797 is associated with a
10798 \begin_inset Quotes eld
10802 \begin_inset Quotes erd
10814 class provides visual cues.
10819 is shorter than that of a
10823 [yet longer than that of an
10827 ] and, like the label of an
10831 is shockingly magenta.
10832 Additionally, the printed
10836 has the page number of its
10837 \begin_inset Quotes eld
10841 \begin_inset Quotes erd
10849 \begin_inset Quotes eld
10857 \begin_inset Quotes erd
10861 \begin_inset Quotes eld
10869 \begin_inset Quotes erd
10873 \begin_inset Quotes eld
10881 \begin_inset Quotes erd
10885 You can have multiple
10889 s associated with a single
10901 , you'll probably want to break up long
10905 s so that they fit on a single sheet of paper.
10908 \begin_layout Standard
10913 is obvious: it contains anything additional you might want to say about
10919 It could also be used as a sheet of reminders for a particular
10924 In the case of the latter, you might want to make use of time markers.
10930 \begin_inset Quotes eld
10934 \begin_inset Quotes erd
10937 support for time markers, a
10942 So, you'll have to resort to using the LaTeX codes.
10945 \begin_layout Standard
10946 To use time markers, you'll need to specify the extra class option
10947 \begin_inset Quotes eld
10955 \begin_inset Quotes erd
10958 [see section\InsetSpace ~
10960 \begin_inset LatexCommand ref
10961 reference "sec:slidesetup"
10966 This option turns on timing marks, which will appear in the lower-left-hand
10972 To set what appears in the time marker, you use the LaTeX commands
10973 \begin_inset Quotes eld
10983 \begin_inset Quotes erd
10987 \begin_inset Quotes eld
10997 \begin_inset Quotes erd
11001 The arguments of both commands are time measured in seconds.
11003 \begin_inset Quotes eld
11013 \begin_inset Quotes erd
11016 sets the time marker to a given time.
11018 \begin_inset Quotes eld
11028 \begin_inset Quotes erd
11031 increments the time marker by the specified amount.
11032 Using time markers and
11036 s in this fashion, you can remind yourself how much time to spend on a particula
11044 \begin_layout Standard
11045 There's one last feature to describe.
11046 Clearly, you'd like to print out all of your
11054 s on transparencies while printing all of your
11071 with which it is associated.
11072 What's a person to do?
11075 \begin_layout Standard
11076 Luckily, there are two LaTeX commands that allow you to select what to print
11078 Both must be placed into the preamble of your document.
11080 \begin_inset Quotes eld
11092 \begin_inset Quotes erd
11095 will cause the output to contain only the
11104 Correspondingly, the command
11105 \begin_inset Quotes eld
11117 \begin_inset Quotes erd
11120 prevents the output of anything but
11125 I'd advise placing both commands in the preamble and initially comment
11127 You can then preview your entire presentation as you write.
11128 When you're done writing, you can then uncomment one of the two to select
11129 what you want to print.
11130 I like to uncomment
11131 \begin_inset Quotes eld
11143 \begin_inset Quotes erd
11146 , print to a file with
11147 \begin_inset Quotes eld
11155 \begin_inset Quotes erd
11158 in its name, comment it back out, then uncomment
11159 \begin_inset Quotes eld
11171 \begin_inset Quotes erd
11175 \begin_inset Quotes eld
11183 \begin_inset Quotes erd
11187 I can then send either file to a printer, loading transparencies or plain
11188 paper as appropriate.
11191 \begin_layout Standard
11192 You can also provide other arguments to the
11193 \begin_inset Quotes eld
11203 \begin_inset Quotes erd
11207 \begin_inset Quotes eld
11217 \begin_inset Quotes erd
11221 See a good LaTeX book for details.
11224 \begin_layout Subsection
11229 Class Template File
11232 \begin_layout Standard
11233 I have also provided a template file,
11234 \begin_inset Quotes eld
11242 \begin_inset Quotes erd
11250 To use it, begin your new presentation with
11255 ile\SpecialChar \menuseparator
11265 Your new LyX presentation file will contain an example
11286 additionally contain an example of the use of
11295 Lastly, the preamble will contain:
11298 \begin_layout LyX-Code
11299 % Uncomment to print out only slides and overlays
11302 \begin_layout LyX-Code
11306 \begin_layout LyX-Code
11316 \begin_layout LyX-Code
11317 % Uncomment to print out only notes
11320 \begin_layout LyX-Code
11324 \begin_layout LyX-Code
11332 \begin_layout Standard
11333 One final thing: I created this class to support the LaTeX2e
11334 \begin_inset Quotes eld
11342 \begin_inset Quotes erd
11345 class, one of the built-in LaTeX2e classes.
11346 Neither I nor the rest of the LyX Team endorse or oppose the use of this
11347 built-in slide class.
11348 It's here if you want it or need it.
11349 There exist other LaTeX2e classes for creating presentations, such as the
11354 class [see section\InsetSpace ~
11356 \begin_inset LatexCommand ref
11357 reference "sec:foiltex"
11362 \begin_inset Quotes eld
11370 \begin_inset Quotes erd
11373 package [present on some TeX distributions].
11374 The latter is not yet supported under LyX.
11378 \begin_layout Standard
11379 Perhaps you can take on the task\SpecialChar \ldots{}
11385 I know nothing about these other classes.
11386 Try them out to see what sort of alternative they provide.
11389 \begin_layout Section
11398 \begin_inset LatexCommand label
11406 \begin_layout Standard
11412 \begin_layout Subsection
11416 \begin_layout Standard
11417 This section describes how to use LyX to make slides for overhead projectors.
11418 There are two document classes that can do this: the default slides class
11424 This section documents the latter.
11427 \begin_layout Standard
11428 I'm going to say this again, nice and clear, so that there's no misunderstanding
11432 \begin_layout Standard
11433 \begin_inset VSpace bigskip
11439 \begin_layout Standard
11443 This section documents the class
11444 \begin_inset Quotes eld
11452 \begin_inset Quotes erd
11460 \begin_layout Standard
11461 \begin_inset VSpace bigskip
11467 \begin_layout Standard
11468 If you're looking for the documentation for
11469 \begin_inset Quotes eld
11477 \begin_inset Quotes erd
11480 , check out section\InsetSpace ~
11482 \begin_inset LatexCommand ref
11483 reference "sec:slitex"
11488 If your machine doesn't have the
11493 \begin_inset Quotes eld
11501 \begin_inset Quotes erd
11504 ] installed, you'll probably have to use the default
11508 class, which isn't quite as good as
11513 \begin_layout Standard
11518 class is designed for use with version 2.1 of the
11522 LaTeX class file which is now an integral part of LaTeX2e.
11525 \begin_layout Subsection
11529 \begin_layout Standard
11530 Obviously, to use this document class, you need to select
11531 \begin_inset Quotes eld
11539 \begin_inset Quotes erd
11551 Document\InsetSpace ~
11555 There are some settings in the
11557 Document\InsetSpace ~
11560 dialog that you should know about that are specific to this class:
11563 \begin_layout Itemize
11564 Don't change the options
11574 Document\InsetSpace ~
11578 They're ignored by the
11585 \begin_layout Itemize
11586 The default font size is 20pt with the other options being 17pt, 25pt and
11590 \begin_layout Itemize
11591 The default font is
11599 but all math equations are still typeset in the usual roman font.
11602 \begin_layout Itemize
11607 TeX supports A4 and Letter paper sizes as well as a special size for working
11609 It doesn't support A5, B5, legal or executive paper sizes.
11612 \begin_layout Itemize
11613 Don't bother changing the
11617 settings because they are ignored anyway.
11618 All floats appear where they are defined in the text.
11621 \begin_layout Itemize
11629 setting behaves a bit differently for this class.
11634 TeX provides extensive footer and header capabilities including a user-defined
11636 See section\InsetSpace ~
11638 \begin_inset LatexCommand ref
11639 reference "sec:foilfoot"
11644 The title page is treated differently to all other pages in the document
11653 has the logo centered at the bottom of the page (if one is defined).
11654 The possible page style choices and what they do are as follows:
11659 \labelwidthstring MMMMMMM
11666 The final output contains no page numbers, or other headers or footers
11667 (except footnotes of course).
11672 \labelwidthstring MMMMMMM
11679 The final output contains page numbers centered at the bottom of the page.
11680 No other headings or footers (other than footnotes).
11684 \labelwidthstring MMMMMMM
11689 Page numbers in lower right corner.
11690 Additional headers and footers are also shown.
11691 This is also the default.
11695 \labelwidthstring MMMMMMM
11700 Gives you access to the
11704 package although its use with
11708 TeX is discouraged by the writer of the
11712 TeX package because of some potential page layout clashes.
11716 \begin_layout Subsubsection
11720 \begin_layout Standard
11721 The following options may be used in the extra class options in the
11726 ocument\SpecialChar \menuseparator
11737 \labelwidthstring MMMMMMx
11742 This sets up the page layout for 7.33in by 11in paper, which is about the
11743 same aspect ratio as a 35mm slide, making it a bit easier to work with
11748 \labelwidthstring MMMMMMx
11753 Places a rule across the page below the header on every page except the
11758 \labelwidthstring MMMMMMx
11763 Places a rule across the page above the footer on every page except the
11768 \labelwidthstring MMMMMMx
11773 This is automatically set each time you create a new
11782 TeX to use the dvips driver to rotate those pages that are set as landscape
11787 \labelwidthstring MMMMMMx
11792 Simply changes the page dimensions to those of a landscape page but doesn't
11794 Thus if you use this option you need to use an external program to rotate
11795 each page or feed your paper through your printer as landscape.
11796 Note that this option effectively reverses the roles of the
11804 environments (don't worry these are described in the next section).
11808 \labelwidthstring MMMMMMx
11813 Equation numbers on the left.
11817 \labelwidthstring MMMMMMx
11822 Flush-left equations.
11825 \begin_layout Subsection
11826 Supported Environments
11829 \begin_layout Standard
11830 Most of the environments commonly supported in other classes are also supported
11836 There are several additional environments provided by
11840 TeX as well as a couple added by LyX.
11841 The following environments are shared with other classes:
11844 \begin_layout Standard
11848 \begin_layout Standard
11852 begin{multicols}{2}
11860 \begin_layout Itemize
11866 \begin_layout Itemize
11872 \begin_layout Itemize
11878 \begin_layout Itemize
11884 \begin_layout Itemize
11890 \begin_layout Itemize
11896 \begin_layout Itemize
11902 \begin_layout Itemize
11908 \begin_layout Itemize
11914 \begin_layout Itemize
11920 \begin_layout Itemize
11926 \begin_layout Itemize
11932 \begin_layout Itemize
11938 \begin_layout Itemize
11944 \begin_layout Itemize
11950 \begin_layout Itemize
11956 \begin_layout Itemize
11962 \begin_layout Itemize
11968 \begin_layout Standard
11972 \begin_layout Standard
11984 \begin_layout Standard
11985 That is, all the major environments apart from the sectioning environments.
11986 Since foils are essentially self-contained sections, with a title and body,
11991 TeX provides specific commands for starting new foils and these are:
11994 \begin_layout Itemize
12000 \begin_layout Itemize
12006 \begin_layout Standard
12007 LyX also provides slightly modified versions of these two environments called:
12010 \begin_layout Itemize
12016 \begin_layout Itemize
12019 ShortRotatefoilhead
12022 \begin_layout Standard
12023 and the differences will be explained in the next section.
12026 \begin_layout Standard
12027 Since foils are often used in presenting ideas or new theorems and such
12032 TeX also provides a comprehensive box of goodies for presenting them:
12035 \begin_layout Standard
12039 \begin_layout Standard
12043 begin{multicols}{2}
12051 \begin_layout Itemize
12057 \begin_layout Itemize
12063 \begin_layout Itemize
12069 \begin_layout Itemize
12075 \begin_layout Itemize
12081 \begin_layout Itemize
12087 \begin_layout Itemize
12093 \begin_layout Itemize
12099 \begin_layout Itemize
12105 \begin_layout Itemize
12111 \begin_layout Itemize
12117 \begin_layout Standard
12121 \begin_layout Standard
12133 \begin_layout Standard
12134 The starred versions are unnumbered while the unstarred versions are numbered.
12135 There are also two list environments added by LyX and these are:
12138 \begin_layout Itemize
12144 \begin_layout Itemize
12150 \begin_layout Standard
12155 TeX provides some powerful header and footer capabilities that are best
12156 set in the preamble although they may be set at any point in a document.
12157 If you want to change these settings in your document the best place to
12158 do so is at the very top of a foil,
12163 straight after the foilhead.
12166 \begin_layout Standard
12167 For this purpose, the following command styles are provided [
12174 \begin_layout Standard
12178 \begin_layout Standard
12182 begin{multicols}{2}
12190 \begin_layout Itemize
12197 \begin_layout Itemize
12203 \begin_layout Itemize
12210 \begin_layout Itemize
12217 \begin_layout Itemize
12225 \begin_layout Standard
12231 \begin_layout Standard
12235 \begin_layout Standard
12247 \begin_layout Standard
12248 There are also a few commands provided by
12252 TeX that aren't directly supported by LyX but I'll tell you what they do
12253 and how to use them in section\InsetSpace ~
12255 \begin_inset LatexCommand ref
12256 reference "sec:unsuppfoils"
12263 \begin_layout Subsection
12264 Building a Set of Foils
12267 \begin_layout Standard
12268 This section will give a simple introduction to using the different environments
12269 to build a set of foils.
12270 If you want to see an example set of foils take a look at the
12274 file accessible from the
12279 ile\SpecialChar \menuseparator
12284 pen\SpecialChar \ldots{}
12295 \begin_layout Subsubsection
12296 Give It a Title Page
12299 \begin_layout Standard
12300 Unlike other classes that provide
12320 creates the title on a page of its own.
12321 If you leave out the
12325 environment LaTeX will substitute the current date (every time you regenerate
12329 \begin_layout Subsubsection
12333 \begin_layout Standard
12334 As I mentioned earlier, there are four ways of starting a new foil.
12335 For portrait foils you should use
12344 The difference between these two environments is the amount of space between
12345 the title of the foil (the foilhead) and the body of the foil.
12348 \begin_layout Standard
12349 Landscape foils are generated using the
12355 ShortRotatefoilhead
12358 Again the only difference is the spacing between foilhead and body.
12359 Both of the short versions have 0.5 inches less separation between the foilhead
12364 \begin_layout Standard
12365 One problem with the support for landscape foils is the requirement that
12366 you have to use the
12370 driver to generate the PostScript output otherwise the foils won't be rotated.
12371 It is possible to get landscape foils even if you haven't got the
12375 driver provided you can feed your foils sideways through your printer ;-)
12378 \begin_layout Subsubsection
12379 Theorems, Lemmas, Proofs and more
12382 \begin_layout Standard
12383 Due to a small bug in LyX you can't have two of the same type of these environme
12384 nts directly following each other.
12385 They must be separated by something.
12386 If you try, you will just be extending the previous environment as if you
12387 had merged the two environments together.
12388 So, how do you get around this problem? The simplest option is to insert
12389 some text between the two environments or add a
12393 environment between the two with just a
12394 \begin_inset Quotes eld
12402 \begin_inset Quotes erd
12406 This will force LyX to produce two separate environments and hence the
12407 correct LaTeX output.
12408 An example is provided in the example file included with the LyX distribution.
12409 Remember, this problem only occurs if you are trying to place two of the
12410 same type of theorem-like environments one directly after the other.
12413 \begin_layout Subsubsection
12417 \begin_layout Standard
12418 You get all the commonly supported list styles found in other classes as
12419 well as two new ones.
12420 I'll only describe the new ones here.
12421 If you want to find out more about the other list environments check out
12427 If you intend to use itemized lists you might also want to read about the
12430 Itemize\InsetSpace ~
12431 Bullet\InsetSpace ~
12434 dialog described above in section\InsetSpace ~
12436 \begin_inset LatexCommand ref
12437 reference "sec:bullet"
12444 \begin_layout Standard
12445 The two new list styles,
12453 , are designed to make it easier for you to create lists of do's and don'ts
12454 or right and wrong by providing dedicated environments that use a tick
12455 or a cross as the label of the list.
12456 These lists are in fact dedicated variants of the
12461 They do however require that you have the
12465 packages installed.
12468 \begin_layout Subsubsection
12472 \begin_layout Standard
12477 TeX redefines the floating tables and figures so that they appear exactly
12478 where they are in the text rather than pushing them to the top of the page
12479 or to some user specified location.
12480 In fact if you change the float placement settings they are simply ignored.
12483 \begin_layout Subsubsection
12484 Page Headers and Footers
12485 \begin_inset LatexCommand label
12486 name "sec:foilfoot"
12493 \begin_layout Standard
12503 are two commands used to control the left-footer text string.
12504 The first is meant to allow you to include a graphic logo on your foils
12506 \begin_inset Quotes eld
12514 \begin_inset Quotes erd
12518 While the second is meant to provide a classification for the audience,
12521 e.\InsetSpace \thinspace{}
12526 It is empty by default.
12529 \begin_layout Standard
12530 The remaining page corners can be filled by
12535 (which defaults to page numbers),
12548 \begin_layout Subsection
12554 \begin_inset LatexCommand label
12555 name "sec:unsuppfoils"
12562 \begin_layout Standard
12563 All the commands mentioned below need to be set in a
12571 within another environment.
12574 \begin_layout Subsubsection
12578 \begin_layout Standard
12579 All lengths are adjusted using the
12602 should be replaced by the name given to the length you want to change and
12607 is the length value.
12608 All lengths should be specified in units of length such as inches (
12620 ) or relative to some document or font-based length such as
12630 \begin_layout Standard
12631 It's possible to change the spacing between a foilhead and the body of the
12632 foil by adjusting the length specified by
12639 For example, to make
12643 foilheads 0.5 inches closer to their bodies put the following in the preamble:
12650 foilheadskip}{-0.5in}
12653 \begin_layout Standard
12654 The spacings around floats can be adjusted by setting these lengths:
12658 \labelwidthstring MMMMMMMMMMM
12665 Separation between the text and the top of the float
12669 \labelwidthstring MMMMMMMMMMM
12676 Separation between the float and the caption
12680 \labelwidthstring MMMMMMMMMMM
12687 Separation between the caption and the following text
12691 \labelwidthstring MMMMMMMMMMM
12698 You can make the captions narrower than the surrounding text by adjusting
12700 Best done relative to
12709 \begin_layout Standard
12710 There are also several title page related lengths that you may find useful
12711 if you have a long title or several authors:
12715 \labelwidthstring MMMMMMMMMMM
12722 Separation from headers to
12728 \labelwidthstring MMMMMMMMMMM
12747 \labelwidthstring MMMMMMMMMMM
12762 \labelwidthstring MMMMMMMMMMM
12779 \labelwidthstring MMMMMMMMMMM
12795 \begin_layout Standard
12796 The last length related command affects all the list environments.
12807 a list environment then all the vertical spacing between the list items
12809 Note that this is a command not a length so it doesn't require
12815 like the stuff mentioned above.
12818 \begin_layout Subsubsection
12819 Headers and Footers
12822 \begin_layout Standard
12835 commands control whether the logo in the
12839 definition appear on a given page.
12846 in the preamble then none of the foils will have the logo on them.
12847 If you don't want the logo on a particular page place the
12853 directly after the foilhead of that page and the
12859 directly after the next foilhead.
12862 \begin_layout Standard
12863 If you decide to use the
12867 page style setting in the
12869 Document\InsetSpace ~
12872 dialog you should probably add
12882 to your preamble so headers and footers on landscape pages are correctly
12883 placed when rotated.
12884 This is due to some clashes between the page layouts provided by the
12895 \begin_layout Section
12896 Latex8 (IEEE Conference Papers)
12899 \begin_layout Standard
12905 \begin_layout Subsection
12909 \begin_layout Standard
12910 Since this class is specifically for writing submissions to IEEE sponsored
12911 conferences I strongly recommend that you get a copy of their Authors Kit.
12916 package and associated bibliography style file is included in the kit.
12917 The Authors Kit is usually sent out by email once your initial submission
12919 There is a lot of useful information in the Authors Kit explaining formatting
12920 restrictions and so on and I will assume you have read this since that
12921 means I don't have to repeat it all here.
12924 \begin_layout Subsection
12928 \begin_layout Standard
12929 [AR\SpecialChar \@.
12933 \begin_layout Subsection
12934 Supported Environments
12937 \begin_layout Itemize
12943 \begin_layout Itemize
12949 \begin_layout Itemize
12955 \begin_layout Itemize
12961 \begin_layout Itemize
12967 \begin_layout Itemize
12973 \begin_layout Itemize
12979 \begin_layout Itemize
12985 \begin_layout Itemize
12991 \begin_layout Subsection
12992 Differences Between Screen and Paper
12995 \begin_layout Standard
12996 There are slight differences in appearance mainly with the presentation
12997 of section counters.
12998 On screen the trailing period of the section counter is missing but it
12999 will appear in the output so don't let this worry you.
13002 \begin_layout Section
13003 Hollywood (Hollywood spec scripts)
13006 \begin_layout Standard
13012 \begin_layout Subsection
13016 \begin_layout Standard
13017 Getting the format of a Hollywood script right is a
13018 \begin_inset Quotes eld
13022 \begin_inset Quotes erd
13025 It is designed to make the readers focus on content and to be easy and
13026 familiar for the actors to read.
13027 Each page of a script should be one minute of film.
13028 Nothing goes in a script that you cannot see or hear on screen.
13029 The courier 12 pt font should be used throughout.
13033 \begin_layout Subsection
13037 \begin_layout Standard
13038 Speakers' lines should NEVER break in mid-sentence.
13039 If a speaker's lines continue over a page break, repeat the
13043 title followed by (Cont'd).
13046 \begin_layout Subsection
13050 \begin_layout Standard
13055 names as labels then cross-reference the label to insert the name.
13056 The cross-reference dialog will show the current cast of characters.
13057 You can use this to insert the speaker name in narratives also.
13060 \begin_layout Subsection
13061 Paper size and Margins
13064 \begin_layout Standard
13065 USLetter, left 1.6in, right 0.75in, top 0.5in, bottom 0.75in
13068 \begin_layout Subsection
13072 \begin_layout Standard
13073 The following environments are available.
13074 You can use hollywood.bind to get the bind keys shown at the right.
13077 \begin_layout Itemize
13084 Used where nothing else works.
13088 \begin_layout Itemize
13101 Usually followed by something like
13102 \begin_inset Quotes eld
13105 on Sally waking up.
13106 \begin_inset Quotes erd
13112 \begin_layout Itemize
13121 Introduces a new INTERIOR camera set-up.
13122 Always followed by DAY or NIGHT, or something similar to define the lighting
13124 Everthing on this line in CAPS.
13127 \begin_layout Itemize
13136 Introduces a new EXTERIOR camera set-up.
13137 Everthing on this line in CAPS.
13140 \begin_layout Itemize
13149 The character speaking.
13152 \begin_layout Itemize
13161 Instructions to the speaker.
13162 The () are automatically inserted, but only the ( will show in LyX.
13163 Both will be printed.
13166 \begin_layout Itemize
13182 \begin_layout Itemize
13191 Camera movement instruction.
13192 e.\InsetSpace \thinspace{}
13197 \begin_layout Itemize
13205 \begin_layout Itemize
13213 \begin_layout Itemize
13221 \begin_layout Itemize
13229 \begin_layout Subsection
13233 \begin_layout Itemize
13234 (O.S) --- off screen
13237 \begin_layout Itemize
13238 (V.0) --- voice over
13241 \begin_layout Itemize
13246 \begin_layout Itemize
13251 \begin_layout Itemize
13252 PAN --- camera movement
13255 \begin_layout Itemize
13256 INSERT --- cut to close-up of
13259 \begin_layout Section
13263 \begin_layout Standard
13269 \begin_layout Subsection
13273 \begin_layout Standard
13274 Broadway is for writing plays.
13275 The format is more decorative than Hollywood, and much less standardized.
13276 This format should be suitable for workshops.
13279 \begin_layout Subsection
13283 \begin_layout Standard
13284 The same as in Hollywood.
13287 \begin_layout Subsection
13291 \begin_layout Standard
13296 names as labels then cross-reference the label to insert the name.
13297 The cross-reference dialog will show the current cast of characters.
13300 \begin_layout Subsection
13301 Paper size and Margins
13304 \begin_layout Standard
13305 USLetter, left 1.6in, right 0.75in, top 0.5in, bottom 0.75in
13308 \begin_layout Subsection
13312 \begin_layout Standard
13313 The following environments are available.
13314 You can use broadway.bind to get the bind keys shown at the right.
13317 \begin_layout Itemize
13324 You should not have to use this, but it is here for anything that does not
13328 \begin_layout Itemize
13337 Used to describe stage setting and the action.
13338 First use of speaker names in all CAPs.
13341 \begin_layout Itemize
13350 Automatically numbered.
13351 On screen it will be arabic, but will print as Roman.
13354 \begin_layout Itemize
13368 It is just centered text.
13371 \begin_layout Itemize
13380 Not automatically numbered.
13381 You supply the number.
13382 This is because I couldn't figure out how.
13385 \begin_layout Itemize
13394 A special case of Narrative to describe the setting and action as the curtain
13398 \begin_layout Itemize
13407 The speaker's (actor's) title, centered in all CAPS.
13410 \begin_layout Itemize
13419 Instructions to the speaker.
13420 The parentheses are automatically inserted.
13421 The ( will appear on screen, but both will be in the printed play.
13422 This environment is only used within
13429 \begin_layout Itemize
13438 What the Speaker says.
13441 \begin_layout Itemize
13450 The curtain comes down.
13453 \begin_layout Itemize
13461 \begin_layout Itemize
13469 \begin_layout Itemize
13477 \begin_layout Standard
13481 \begin_layout Section
13485 \begin_layout Standard
13491 \begin_layout Standard
13492 \begin_inset VSpace bigskip
13498 \begin_layout Standard
13502 Revtex\InsetSpace ~
13505 textclass works with the American Physical Sociey's RevTeX 4.0 (the
13506 \begin_inset Formula $\beta$
13509 release of May, 1999) class.
13512 \begin_layout Standard
13517 textclass, which works with RevTeX 3.1.
13518 However, v3.1 is basically obsolete, as it works with LaTeX 2.09.
13519 That means that it doesn't interact very well with LyX, which requires
13520 LaTeX2e, although it has been kludged to work.
13521 Since RevTeX 4.0 has been designed to work much more cleanly with LaTeX2e,
13524 RevTeX\InsetSpace ~
13527 textclass should also be pretty easy to use.
13530 \begin_layout Standard
13531 These documents are supposed to be used in
13535 to the RevTeX 4.0 documents, so we don't describe any of the special RevTeX
13536 macros, and assume you'll know what to put in the preamble if necessary.
13539 \begin_layout Subsection
13543 \begin_layout Standard
13544 All you need to do is install RevTeX 4, as described in the package's README
13546 The package can be found at
13547 \begin_inset LatexCommand url
13548 name "The RevTeX 4 Web Site"
13549 target "http://publish.aps.org/revtex4/"
13554 Install it somewhere that LaTeX can see it.
13555 Test it by trying to LaTeX a short RevTeX 4 document in some random directory
13556 (i.e., not the directory where you installed the class file.) Then, if you
13557 reconfigure LyX, it will find the class file and let you use the RevTeX4
13561 \begin_layout Standard
13562 Probably the easiest way to get started is either to import a RevTeX 4 document
13569 Revtex\InsetSpace ~
13572 template, found in the templates directory.
13575 \begin_layout Subsection
13579 \begin_layout Standard
13580 Optional arguments to
13587 \begin_inset Quotes eld
13591 \begin_inset Quotes erd
13595 \begin_inset Quotes eld
13599 \begin_inset Quotes erd
13613 Document\InsetSpace ~
13617 Remember that in RevTeX, at least one optional argument is required!
13620 \begin_layout Standard
13621 Other preamble matter, like
13637 dialog, also as usual.
13640 \begin_layout Subsection
13644 \begin_layout Standard
13645 The layouts basically correspond to the commands in RevTeX4.0.
13646 For example, the Email layout corresponds to
13653 Note that (at least as of RevTeX 4.0 Beta), the
13661 layouts are exactly equivalent, so you shouldn't need to use both.
13665 \begin_layout Standard
13666 In case you're curious, both were included so that
13670 would be able to translate both
13690 \begin_layout Subsection
13694 \begin_layout Standard
13695 There are a couple of important unique aspects of RevTeX 4 which might cause
13696 bugs that will be even more confusing in LyX.
13699 \begin_layout Standard
13717 The LyX equivalent is that there is a separate Thanks layout.
13722 write footnotes in the
13726 layout, or weird things may happen.
13727 See the RevTeX 4 documentation for more details.
13730 \begin_layout Standard
13733 Author\InsetSpace ~
13738 Author\InsetSpace ~
13745 layouts must be placed
13753 layout and the corresponding
13770 , the LaTeX won't compile.
13773 \begin_layout Subsection
13777 \begin_layout Standard
13778 The main problem with this layout is that you can't use the optional arguments
13779 to layouts like Email and Title.
13780 (The problem is not unique to this layout; you can't use optional arguments
13781 to the Section layouts either.) This means that after you export that file
13782 to LaTeX (which you'll need to do eventually to send it in to APS), you'll
13783 need to edit the LaTeX file with a text editor to add the optional arguments
13784 to set, e.\InsetSpace \thinspace{}
13785 g., the running title for the page headers.
13786 Lacking these layouts makes the
13792 (and the equivalent
13798 ) useless, so the corresponding layouts don't exist, and will have to be
13803 \begin_layout Standard
13808 actually, LyX 1.3.0 supports some forms of optional arguments, but this layout
13809 has not been updated yet to take advantage of it.
13817 \begin_layout Section
13818 Article (mwart), book (mwbk) and report (mwrep)
13819 \begin_inset OptArg
13822 \begin_layout Standard
13835 \begin_layout Standard
13841 \begin_layout Standard
13842 The LyX document classes
13858 correspond to the LaTeX document classes
13871 They are replacements for the standard document classes
13883 , resp., and fit better to Polish typography conventions in a number of points.
13887 \begin_layout Standard
13891 \begin_layout Itemize
13892 Unnumbered titles (with star, eg.
13897 ) are added into table of contents,
13900 \begin_layout Itemize
13901 Additional page styles:
13905 \begin_layout Description
13906 uheadings header with separated lines,
13909 \begin_layout Description
13910 myheadings custom header, contents headers via commands:
13925 \begin_layout Description
13926 myuheadings custom header with separated lines,
13929 \begin_layout Description
13930 outer page number is placed on outer side of page
13934 \begin_layout Itemize
13939 \begin_layout Description
13940 rmheadings serif titles --- default,
13943 \begin_layout Description
13944 sfheadings sansserif titles,
13947 \begin_layout Description
13948 authortitle on title page first placed is author next title --- default,
13951 \begin_layout Description
13952 titleauthor on title page first placed is title next author,
13955 \begin_layout Description
13956 withmarginpar reserve place on page for margins.
13960 \begin_layout Section
13964 \begin_layout Standard
13970 \begin_layout Standard
13971 Elsevier Science Publishers B.V.
13972 provides a standard LaTeX document class (
13976 ) for submitting articles to their various journals.
13977 The style file can be downloaded directly from their web site:
13978 \begin_inset LatexCommand url
13979 target "http://authors.elsevier.com/"
13984 Instructions are supplied along with the class file, which details the
13985 requirements of the publishers.
13986 LyX includes package that allows for the use of this class, by a layout
13987 and a template file.
13988 Installation of the class file is the same as for any other LaTeX package;
13989 instructions are provided in the Elsevier documentation.
13992 \begin_layout Standard
14002 As the Elsevier class file is based mainly on the standard article class,
14003 most of the normal functionality is provided.
14004 The Elsevier class defines a number of mathematical environments, which
14005 are similar to the AMS environments.
14006 These commands are all described in the Elsevier documentation, and are
14010 \begin_layout Standard
14011 The easiest way to use the Elsevier style is to base documents on the included
14013 It is best not to use options such as fancy headings or the geometry package,
14014 as elements such as these are defined by Elsevier in their style file.
14015 Ideally, no extra packages except those mentioned in the Elsevier documentation
14017 Essentially, Elsevier require as
14018 \begin_inset Quotes eld
14022 \begin_inset Quotes erd
14029 \begin_layout Standard
14038 file as possible, as their intention is to take the supplied file and replace
14039 the class file with one for the particular journal to which the paper has
14041 This also means that not too much time should be spent on the formating
14043 When it comes to be published, this will change anyway.
14044 The rest of the usage for this layout is substantially the same as for
14045 the normal article class.
14046 For details of what Elsevier do and don't allow, refer to their documentation.
14049 \begin_layout Section
14053 \begin_layout Standard
14056 Jürgen Spitzmüller
14059 \begin_layout Subsection
14063 \begin_layout Standard
14064 Memoir is a very powerful and constantly evolving class.
14065 It has been designed with regard to fictional and non-fictional literature.
14066 Its aim is to let the user have maximum control over the typesetting of
14068 Memoir is based on the standard book class, but it can also emulate the
14069 article class (see below).
14072 \begin_layout Standard
14073 Peter Wilson, the developer of Memoir, is known as the author of lots of
14074 useful packages in the LaTeX world.
14075 Most of them have been merged with Memoir.
14076 Therefore, it is much easier to layout the table of contents, appendices,
14077 chapter designs and such.
14078 LyX, though, does not support all of these goodies natively.
14079 Some of them might be added to forthcoming releases
14083 \begin_layout Standard
14084 You are invited to send suggestions to
14085 \begin_inset LatexCommand url
14086 target "lyx-devel@lists.lyx.org"
14095 , lots will probably never, due to the limitations of LyX's framework.
14096 Of course you can still use all features with the help of some native LaTeX
14101 \begin_layout Standard
14106 \begin_layout Standard
14115 section\InsetSpace ~
14117 \begin_inset LatexCommand ref
14118 reference "sec:Inserting-LaTeX-Code"
14128 In this section, we can only list those features which are natively supported
14130 For detailed descriptions (and for the rest of features) we are recommending
14131 to have a look at the detailed manual of the Memoir class
14135 \begin_layout Standard
14140 \begin_layout Standard
14150 \begin_inset LatexCommand url
14151 target "CTAN:/macros/latex/memoir/memman.pdf"
14160 , which is not only a user guide for the class, but also both a comprehensive
14161 description on good typesetting and a superb example for good typesetting
14165 \begin_layout Subsection
14166 Basic features and restrictions
14169 \begin_layout Standard
14170 Memoir supports basically all features of the standard book classes.
14171 There are, however, some differences, as follows:
14174 \begin_layout Description
14176 sizes: Memoir has a broader range of font sizes: 9, 10, 11, 12, 14,
14180 \begin_layout Description
14182 style: The fancy page style is not supported, due to a command clash
14183 between Memoir and the fancyhdr package (they are both defining a command
14184 with the same name, which confuses LaTeX).
14185 Instead, Memoir comes with a bunch of own page styles (see
14187 Layout\SpecialChar \menuseparator
14188 Document\SpecialChar \menuseparator
14193 If you want to use these for the chapter pages, you have to use the command
14200 in the main text or in preamble (e.
14204 \begin_layout Standard
14217 \begin_layout Standard
14230 chapterstyle{companion}
14235 \begin_layout Description
14236 Sectioning: Sectionings (chapter, section, subsection etc.) are coming with
14237 an optional argument in the standard classes.
14238 With this, you can specify an alternative version of the title for the
14239 table of contents and the headers (for instance, if the title is too long).
14240 In LyX, you can do this via
14242 Insert\SpecialChar \menuseparator
14246 at the beginning of a chapter/section.
14247 Memoir features a second optional argument and thus separates the table
14248 of contents from the header.
14249 You can define three variants of a title with this: one for the main text,
14250 one for the table of contents, and one for the headers.
14251 Simply insert two optional arguments if you need this feature, the first
14252 one containing the short title for the Table of Contents, the second one
14253 containing an alternative short title for the headers.
14256 \begin_layout Description
14257 TOC/LOT/LOF: In the standard classes (and in many other classes), the table
14258 of contents, the list of figures and the list of table start a new page
14260 Memoir does not follow this route.
14261 You have to insert a page break yourself, if you want to have one.
14264 \begin_layout Description
14265 Titlepage: For some unknown reason, Memoir uses pagination on the title
14266 page (in the standard classes, title pages are
14267 \begin_inset Quotes eld
14271 \begin_inset Quotes erd
14278 \begin_layout Standard
14291 \begin_layout Standard
14301 If you want an empty title page, type
14305 aliaspagestyle{title}{empty}
14310 \begin_layout Description
14311 Article: With the class option
14317 Layout\SpecialChar \menuseparator
14318 Document\SpecialChar \menuseparator
14322 ), you can emulate article style.
14323 That is, counters (footnotes, figures, tables etc.) will not be reset on
14324 new chapters, chapters don't start a new page (but are---in contrary to
14326 \begin_inset Quotes eld
14330 \begin_inset Quotes erd
14333 article classes---still allowed), parts, though, use their own page, as
14337 \begin_layout Description
14338 Oldfontcommands: By default, Memoir does not allow the use of the deprecated
14339 font commands, which have been used in the old LaTeX version 2.09 (e.
14343 \begin_layout Standard
14356 \begin_layout Standard
14378 It produces an error and stops LaTeX whenever such a command appears.
14383 reallows the commands and spits out warnings instead (which does at least
14385 Since a lot of packages and particularly BibTeX style files are still using
14386 those commands, we have decided to use this option by default.
14389 \begin_layout Subsection
14393 \begin_layout Standard
14394 We will only describe the features supported by LyX (which is not much currently
14396 Please consult the Memoir manual
14400 \begin_layout Standard
14405 \begin_layout Standard
14415 \begin_inset LatexCommand url
14416 target "CTAN:/macros/latex/memoir/memman.pdf"
14428 \begin_layout Description
14429 Abstract: You may wonder why an abstract is an extra feature.
14430 Well, it is in book class.
14431 Usually books don't have abstracts.
14432 Memoir, however, has.
14433 You can use it wherever and how often you like.
14436 \begin_layout Description
14437 Chapterprecis: You may know this from belletristic: The contents of a chapter
14438 is shortly described below the title and also in the table of contents
14443 \begin_layout Standard
14456 \begin_layout Standard
14467 Our hero arrives in Troia; he loses some friends; he finds others
14470 Chapterprecis does exactly this.
14471 It is therefore only sensible below a chapter.
14474 \begin_layout Description
14475 Epigraph: An epigraph is a smart slogan or motto at the beginning of a chapter.
14476 The epigraph environment provides an elegant way of typesetting such a
14478 The motto itself (text) and its author (source) are divided by a short
14480 Unfortunately, we have to fool LyX a bit here again, since the environment
14481 needs two arguments (text and source).
14482 In this case, we have to use curly brackets (in TeX mode) between the two
14493 <author of the slogan>.
14496 \begin_layout Description
14497 Poemtitle: Memoir has lots of possibilities to typeset poetry (up to very
14498 complex figurative poems).
14499 LyX can only support a few of them.
14500 One is poemtitle, which is a centered title for poems, which will also
14501 be added to the table of contents (verse is the standard environment for
14503 Memoir has some enhanced versions of verse, but you need to use ERT, because
14504 they have to be nested inside regular verse environments, which is not
14505 possible with LyX).
14508 \begin_layout Description
14509 Poemtitle*: Same as poemtitle, but it adds no entry to the table of contents.
14512 \begin_layout Chapter
14513 Importing and Exporting Alternate File Formats
14514 \begin_inset OptArg
14517 \begin_layout Standard
14518 Importing and Exporting
14526 \begin_layout Section
14530 \begin_layout Standard
14531 Importing and exporting LyX documents from/to other formats has been touched
14537 Here we describe more of the gory details needed to understand just what
14538 is going on when you click on the
14543 ile\SpecialChar \menuseparator
14555 ile\SpecialChar \menuseparator
14566 \begin_layout Section
14567 Importing Other Formats
14570 \begin_layout Subsection
14574 \begin_layout Standard
14575 Translating from LaTeX into LyX is performed by a Perl script called reLyX.
14576 Although it is a standalone program which can be called from the command
14577 line, LyX will call it automatically when a LaTeX document is imported.
14578 See section\InsetSpace ~
14580 \begin_inset LatexCommand ref
14581 reference "sec:reLyX"
14585 for a complete description.
14586 There are no user tunable parameters for reLyX within LyX.
14589 \begin_layout Subsection
14593 \begin_layout Standard
14594 When importing plain ASCII text, there are two methods of reading the file.
14596 \begin_inset Quotes eld
14600 \begin_inset Quotes erd
14603 preserves all the linebreaks in the ASCII; to LyX, then, each line looks
14606 \begin_inset Quotes eld
14610 \begin_inset Quotes erd
14613 assumes that consecutive lines separated by only a single linebreak form
14614 a single paragraph.
14615 Successive linebreaks with no intervening text are thus assumed to be paragraph
14619 \begin_layout Subsection
14623 \begin_layout Standard
14626 [Editor's note: Needs to be written, obviously - any volunteers? --- mer]
14629 \begin_layout Section
14630 Exporting Other Formats
14633 \begin_layout Standard
14634 The output formats listed here in the following are also explained concerning
14635 possible graphics formats in the
14642 \begin_layout Subsection
14646 \begin_layout Standard
14647 LyX generates two types of LaTeX files: stripped down versions for the normal
14652 , etc.) which one normally never sees
14656 \begin_layout Standard
14657 The resulting file is a perfectly valid LaTeX file, though the preamble
14658 might look a bit strange since it includes some definitions used by LyX
14659 which wouldn't show up in most human-written files.
14664 , and human readable forms which are suitable for exchanging with your colleague
14666 The only settable option for the translation is the line length of the
14668 The default is 65 characters, but it can be set in
14675 \SpecialChar \menuseparator
14696 \begin_layout Subsection
14697 Device Independent Files
14700 \begin_layout Standard
14701 Device Independent files (DVI files) are produced by running LaTeX on your
14703 There are no user settable options.
14706 \begin_layout Subsection
14710 \begin_layout Standard
14711 The next step in the conversion chain is converting a DVI file into Postscript.
14719 \SpecialChar \menuseparator
14727 \SpecialChar \menuseparator
14736 or, if you need more control on the result,
14743 \SpecialChar \menuseparator
14752 If you use the later, note that it is possible to configure, in
14759 \SpecialChar \menuseparator
14767 , the options passed to the dvips program to achieve different effects.
14770 \begin_layout Subsection
14774 \begin_layout Standard
14775 Exporting as ASCII attempts to preserve the
14776 \begin_inset Quotes eld
14780 \begin_inset Quotes erd
14783 of the document as well as possible, but things like centering and indentation
14784 are thrown out; paragraphs are separated by blank lines.
14785 Section numbering and cross-references are done correctly, so the resulting
14786 text files is remarkably readable.
14787 The only changeable option is the length of lines, as for LaTeX output.
14790 \begin_layout Subsection
14794 \begin_layout Standard
14795 LyX documents can be converted to hypertext markup, usually by converting
14796 to LaTeX first, then converting that to HTML\SpecialChar \@.
14798 \begin_inset Formula $\rightarrow$
14801 HTML converters are currently known to LyX:
14818 Though they are autodetected, you can overide the selection in preferences.
14819 You can also include further command line options in this dialog.
14823 \begin_layout Subsection
14827 \begin_layout Standard
14835 \begin_layout Standard
14836 \begin_inset VSpace bigskip
14842 \begin_layout Standard
14843 The fastest way to generate a basic PDF file (no tags, links, etc.) with
14844 any version of LyX is to save the document as a Postscript file, then run
14850 Starting with version 1.1.6, the menu item
14854 will do all this for you.
14855 There are some issues with fonts that you need to pay attention to: see
14856 Section\InsetSpace ~
14858 \begin_inset LatexCommand ref
14859 reference "sec:badfonts"
14864 Also, as of version 1.1.6, there is a better method that will generate much
14865 more sophisticated files.
14868 \begin_layout Subsubsection
14872 \begin_layout Standard
14873 With pdfLaTeX you cannot use pstricks.
14874 On the other hand, with pdfLaTeX it is possible to insert directly images
14875 in JPEG, PDF or PNG format, use TrueType fonts, and more.
14878 \begin_layout Subsubsection
14879 Why does the text look so bad when viewed with Acrobat Reader?
14880 \begin_inset LatexCommand label
14881 name "sec:badfonts"
14886 \begin_inset OptArg
14889 \begin_layout Standard
14890 Bad Fonts in Acrobat Reader
14898 \begin_layout Standard
14899 The problem is that bitmap fonts are displayed poorly by Acrobat Reader.
14900 When creating a PDF from the LyX file, you need to use outline font instead
14901 of the default bitmap fonts (in fact, you should also use outline fonts
14902 for Postscript files).
14903 Recent LaTeX distributions come with Postscript Type 1 version of the standard
14904 (Computer Modern) fonts.
14905 pdfLaTeX uses these font by default.
14906 Dvips doesn't use these fonts by default, so to make it use them, add the
14907 following to lines to your
14914 \begin_layout LyX-Code
14918 \begin_layout LyX-Code
14922 \begin_layout Standard
14923 If the default LaTeX font encoding (OT1) is used, nothing else need to be
14925 However, if the T1 font encoding is used, then LaTeX uses the newer EC
14926 fonts, for which there are no Type1 version.
14927 The solution is to use the ae package which emulates T1 coded fonts using
14928 the standard CM fonts.
14929 This is done by adding
14933 usepackage{ae,aecompl}
14935 to the preamble of the LyX file.
14936 However, some glyphs are missing from the CM fonts (e.\InsetSpace \thinspace{}
14939 they are taken from the EC fonts.
14940 Therefore you get these glyphs as bitmaps.
14943 \begin_layout Standard
14944 Note: LyX uses by default the T1 font encoding.
14945 If you wish to use the default font encoding (this is not recommended,
14946 unless you only write English documents), clear the field
14954 in preferences (tabs
14966 \begin_layout Standard
14967 An alternate option is to use the standard Postscript fonts instead of the
14968 Computer Modern fonts.
14969 To do that, you need to select
14973 as the global font in the document layout dialog.
14974 When using the Postscript fonts, the result PDF file is smaller as the
14975 fonts are not saved into the file.
14976 Furthermore, the Postscript fonts include all T1 glyphs.
14977 On the other hand, the Postscript fonts have no bold symbol font, so poor
14978 man's bold must be used (see Section\InsetSpace ~
14980 \begin_inset LatexCommand ref
14981 reference "sec:pdfbold"
14986 The Postscript fonts also look different from the Computer Modern fonts.
14989 \begin_layout Standard
14990 To sum up, both the Computer Modern and the Postscript fonts gives good
14991 results (with few exceptions).
14992 The decision of which one to use is a matter of taste.
14995 \begin_layout Subsubsection
14998 boldsymbol{} command work when I use pslatex?
14999 \begin_inset LatexCommand label
15005 \begin_inset OptArg
15008 \begin_layout Standard
15025 \begin_layout Standard
15026 The Postscript fonts do not have a bold symbol font.
15027 The solution is to use the
15033 (poor man's bold) command.
15036 \begin_layout Standard
15037 It is possible to redefine the
15052 \begin_layout LyX-Code
15062 \begin_layout Standard
15066 \begin_layout Subsubsection
15067 Is it possible to do write LaTeX-code which is processed only when running
15069 \begin_inset OptArg
15072 \begin_layout Standard
15073 Conditionals with pdfLaTeX
15081 \begin_layout Standard
15082 Yes you can do this with the
15087 Here is an example:
15090 \begin_layout LyX-Code
15094 \begin_layout LyX-Code
15100 \begin_layout LyX-Code
15106 \begin_layout LyX-Code
15109 pdfinfo { /Author (your name and e-mail address)
15112 \begin_layout LyX-Code
15113 /Title (official title -- i.e., title element)
15116 \begin_layout LyX-Code
15117 /Subject (one line description of the document)
15120 \begin_layout LyX-Code
15124 \begin_layout LyX-Code
15127 pdfcatalog { /PageMode (/UseNone)
15130 \begin_layout LyX-Code
15131 % /OpenAction (fitbh)
15134 \begin_layout LyX-Code
15138 \begin_layout LyX-Code
15141 usepackage[pdftex]{hyperref}
15144 \begin_layout LyX-Code
15150 \begin_layout LyX-Code
15153 usepackage[ps2pdf]{hyperref}
15156 \begin_layout LyX-Code
15162 \begin_layout Subsubsection
15163 How can I make URLs clickable?
15166 \begin_layout Standard
15167 See the references here:
15170 \begin_layout Standard
15171 \begin_inset LatexCommand url
15172 target "http://wiki.lyx.org/pmwiki.php/FAQ/PDF"
15179 \begin_layout Subsection
15183 \begin_layout Standard
15184 Custom exports are possible if you have some particularly weird format you
15185 wish to convert to, assuming you have the relevant converter, of course.
15190 file can be chosen in the
15195 ile\SpecialChar \menuseparator
15200 xport\SpecialChar \menuseparator
15207 dialog; LyX will automatically convert the file to this point, then feed
15208 it to your custom converter.
15209 The possible values are all formats that LyX can produce from its own documents.
15213 \begin_layout Standard
15214 The converter command is also specified in the dialog.
15215 It should be a completely qualified command line which uses the variable
15220 to specify the name of the file.
15221 If this variable is not given, then the file will be sent to the standard
15222 input of your command.
15223 You may have to apply a bit of ingenuity to escape this sequence correctly
15224 so that it is compatible with your shell.
15228 \begin_layout Standard
15229 While it is not possible to save this command using the
15233 dialog, you can manually edit your
15240 \begin_layout LyX-Code
15243 custom_export_command "mycommand $$FName"
15246 \begin_layout Chapter
15247 LyX Features needing Extra Software
15250 \begin_layout Section
15251 Using LyX with SGML-Tools (aka LinuxDoc)
15254 \begin_layout Standard
15260 \begin_layout Subsection
15264 \begin_layout Standard
15265 LinuxDoc is a document class available in LyX if you have the
15270 You can use it to produce documents in the so-called Standardized General
15271 Mark-up Language (SGML) in the particular format used by the Linux Documentatio
15273 That is obviously helpful if you are contributing to that project.
15274 You can use the SGML format with the
15278 package of scripts and programs (to produce other formats, including LaTeX,
15279 HTML, plain text, man pages and\SpecialChar \ldots{}
15281 You may therefore prefer to use this document class if you want to write
15282 something that can be easily translated into other formats.
15285 \begin_layout Standard
15286 You will find that LinuxDoc has fewer layout options than the other text
15288 This is mainly so that the translations into other formats have a chance
15289 of making some sense.
15290 In this section we describe:
15293 \begin_layout Itemize
15294 how to setup and use a document in LinuxDoc
15297 \begin_layout Itemize
15298 how to use the tags in LinuxDoc to layout your document
15301 \begin_layout Itemize
15302 how to use the SGML packages to produce the various formats
15305 \begin_layout Itemize
15306 how to sort out some problems.
15309 \begin_layout Subsection
15310 Preparing and using a LinuxDoc document
15313 \begin_layout Subsubsection
15317 \begin_layout Standard
15318 You start by selecting the LinuxDoc class using the
15323 ocument\SpecialChar \menuseparator
15335 Then you will find that there are fewer paragraph environments than for
15336 most other classes.
15337 You can see them on the pull down box on the left of the tool bar.
15338 How to use them is described in section\InsetSpace ~
15340 \begin_inset LatexCommand ref
15341 reference "sec:sgmlparas"
15348 \begin_layout Standard
15353 enter a title for the document, followed by an author, marking each with
15354 the appropriate paragraph environment.
15355 If you don't do this, you will get errors when you try to print the file.
15356 You can then enter the date and an abstract.
15357 The document proper must start with a Section paragraph environment rather
15358 than any standard layout.
15361 \begin_layout Standard
15362 After that you can prepare a document as usual using the available range
15363 of paragraph environments.
15364 See section\InsetSpace ~
15366 \begin_inset LatexCommand ref
15367 reference "sec:sgmlparas"
15371 for the full list and their uses.
15374 \begin_layout Subsubsection
15375 Output from LinuxDoc
15378 \begin_layout Standard
15379 You can print and save these documents in the normal way.
15380 To use the other features of the SGML package you need to save your document
15381 as LinuxDoc; this is a version in which the document is translated into
15382 the basic sgml tags.
15389 ile\SpecialChar \menuseparator
15394 xport\SpecialChar \menuseparator
15402 You will get a file with the same name and a
15406 extension rather than a
15413 \begin_inset LatexCommand ref
15414 reference "sec:sgmloperate"
15418 on how you than make use of this file.
15421 \begin_layout Subsection
15422 Using the paragraph environments in LinuxDoc
15425 \begin_layout Subsubsection
15426 The Structure of a LinuxDoc Document
15429 \begin_layout Standard
15430 There is a formal structure for LinuxDoc which limits how you can place
15432 There are two parts to all documents:
15435 \begin_layout Description
15436 Header: this is everything up to the first time you insert a Section layout
15438 It can include title, author, date, abstract and ToC.
15439 You must include the first two.
15442 \begin_layout Description
15443 Body: from the beginning of the first section onwards.
15444 All other tags are allowed.
15448 \begin_layout Subsubsection
15449 The LinuxDoc Paragraph Environments
15452 \begin_layout Standard
15453 \begin_inset LatexCommand label
15454 name "sec:sgmlparas"
15458 Here is a list of all the tags you will find listed on the layout bar in
15459 the order they come there, with some comments where the purpose or use
15463 \begin_layout Itemize
15468 works as described in [cross reference]
15471 \begin_layout Itemize
15476 : This will appear at the top left of the document when printed, above a
15477 heavy horizontal rule, although you will not see this on the LyX screen.
15480 \begin_layout Itemize
15483 Section, Subsection, Subsubsection, Paragraph and Subparagraph:
15485 all do what you would expect and in the usual order.
15486 Whether they are numbered or not is controlled by the
15488 Section\InsetSpace ~
15489 number\InsetSpace ~
15493 You cannot get the equivalent number free versions in any other way; there
15501 \begin_layout Itemize
15506 As usual this produces a numbered and indented list as described in the
15514 \begin_layout Itemize
15519 Again much the same as in the other classes: see the
15526 \begin_layout Itemize
15531 : As explained in the
15536 Remember that if you want the bold element at the start of a description
15537 to be more than one word then you need to put protected spaces between
15542 \begin_layout Itemize
15550 \begin_layout Itemize
15553 Code: similar to the LyX-Code
15558 \begin_layout Itemize
15563 : Anything you mark with this will appear on the left of the heading of
15564 the document, under the heavy rule.
15567 \begin_layout Itemize
15572 Anything you mark with this will appear on the right of the heading under
15574 You do not have to make this a date.
15575 Any text can be entered, e.\InsetSpace ~
15580 \begin_layout Itemize
15585 : You can use this to produce a free standing paragraph after the author
15586 and date, and before the first section.
15587 You are only allowed one such paragraph.
15591 \begin_layout Standard
15597 This needs checking ---
15607 \begin_layout Itemize
15616 \begin_layout Standard
15621 I have not yet checked this ---
15631 \begin_layout Subsubsection
15632 Other document features
15635 \begin_layout Standard
15636 You can also use the
15640 menu to set fonts or to emphasis words.
15641 You can also use the table of contents as usual; see the corresponding
15647 Although you will find some some other features on the menus e.\InsetSpace ~
15649 inserting footnotes.
15650 There is some doubt about whether these will work correctly.
15654 \begin_layout Standard
15659 Again still checking to see whether this is my system
15669 \begin_layout Subsubsection
15670 Cross references and HTML
15673 \begin_layout Standard
15678 menu you will find two new options relating to the inclusion of URL addresses.
15679 If you use either option you will find some highlighted TeX code inserted
15680 into your document in three separate blocks with spaces available between.
15681 The blocks will be:
15684 \begin_layout Quote
15716 \begin_layout Standard
15717 You insert a full HTML tag between the first and second blocks.
15719 \begin_inset LatexCommand url
15720 target "http://any.address"
15724 or other valid tags such as
15725 \begin_inset LatexCommand url
15726 target "mailto:me@my.address"
15738 insert some description between the second and third blocks.
15739 The differences are:
15742 \begin_layout Itemize
15747 both the HTML tag and the description will appear in the document
15750 \begin_layout Itemize
15756 only the description appears in the printed version
15759 \begin_layout Subsection
15760 Using the LinuxDoc Sgml scripts
15761 \begin_inset Note Note
15764 \begin_layout Standard
15765 This section is completely outdated.
15773 \begin_layout Standard
15774 \begin_inset LatexCommand label
15775 name "sec:sgmloperate"
15779 You can use LinuxDoc as a text class without any additional scripts or programs,
15780 but there is not much point in doing this.
15781 All you will get is a document that looks like a
15783 Linux Documentation Project Howto
15789 To do the document translation you need to get and install the
15791 sgml-tools-1.0.x.tar.gz
15794 \begin_inset Formula $x\geq3$
15799 the SGML-Tools WWW Page
15804 \begin_layout LyX-Code
15807 \begin_inset LatexCommand url
15808 target "http://pobox.com/~cg/sgmltools"
15817 \begin_layout Standard
15818 Alternatively, you can go to the
15826 \begin_layout Standard
15827 Note that, at the time of this writing (01/1998), version 1.0.3 of sgml-tools
15828 has not yet been made available at
15840 \begin_layout LyX-Code
15843 \begin_inset LatexCommand url
15844 target "ftp://sunsite.unc.edu/pub/Linux/utils/text/sgml-tools-1.0.x.tar.gz"
15851 \begin_layout Standard
15858 sgml-tools-1.0.x.tar.gz
15860 contains everything that you need to write SGML documents and convert them
15861 to groff, LaTeX, HTML, GNU info, LyX, and RTF\SpecialChar \@.
15865 \begin_layout Standard
15866 This package was renamed from
15868 linuxdoc-sgml-1.5.tar.gz
15873 \begin_layout Standard
15874 Follow the instructions in that package on how to install it and how to
15876 All this has to be done outside of LyX, before you can use the
15881 ile\SpecialChar \menuseparator
15886 xport\SpecialChar \menuseparator
15893 \begin_layout Subsection
15894 Troubleshooting LinuxDoc
15897 \begin_layout Standard
15898 When you print or preview a LinuxDoc document some checking is done of the
15899 tags before LaTeX is run.
15900 Some errors are trapped here, especially those concerning the structure
15902 LyX may produce an error message, but not leave an error box in the document
15904 You may have to look at the files directly to discover what is wrong.
15905 Most problems seem to come from the use of options that are not fully available
15909 \begin_layout Section
15913 \begin_layout Standard
15919 \begin_layout Subsection
15923 \begin_layout Standard
15931 menu, you'll find a
15940 This feature requires you to have the
15944 program installed, and is grayed out if you don't have it.
15945 You can get it from your nearest CTAN mirror, or over the Web from
15946 \begin_inset LatexCommand url
15947 target "http://www.ifi.uio.no/~jensthi/chktex/"
15954 \begin_layout Standard
15959 package is a program that was written by
15964 in frustration because some constructs in LaTeX are sometimes non-intuitive,
15965 and easy to forget.
15966 The program runs over your LaTeX file and checks the integrity of the file,
15967 and flags some common errors.
15968 In other technical words, it is
15975 \begin_layout Standard
15976 Well, what is a syntax checker doing in LyX which is supposed to produce
15977 correct LaTeX anyways? The answer is simple: Just as
15981 not only checks the
15985 of C programs, but also does
15989 checks for type-errors,
15993 catches some common
15997 errors, in addition to the syntactical ones.
16002 is capable of detecting several common errors, such as
16005 \begin_layout Itemize
16006 Ellipsis detection:
16008 Use \SpecialChar \ldots{}
16012 \begin_layout Itemize
16013 No space in front of/after parenthesis:
16018 \begin_layout Itemize
16019 Enforcement of normal space after common abbreviations:
16023 is too wide spacing.
16026 \begin_layout Itemize
16027 Enforcement of end-of-sentence space when the last sentence ends with a
16031 And this is wrong spacing.
16034 \begin_layout Itemize
16035 Space in front of labels and similar commands:
16037 The label should stick right
16038 up to the text to avoid falling to a wrong page.
16040 \begin_inset LatexCommand label
16049 \begin_layout Standard
16050 This footnote is in danger of falling off to a wrong page
16055 The label is separated too much.
16058 \begin_layout Itemize
16059 Space in front of references, instead of hard spaces:
16061 In you are in bad luck,
16062 the text will break right between the referenced text and reference number,
16065 \begin_inset LatexCommand ref
16066 reference "sec:chktex"
16073 \begin_layout Itemize
16075 \begin_inset Quotes eld
16079 \begin_inset Quotes erd
16083 \begin_inset Formula $\times$
16088 2x2 looks cheap compared to
16089 \begin_inset Formula $2\times2$
16095 \begin_layout Standard
16096 and more \SpecialChar \ldots{}
16097 It is an invaluable tool when you are
16098 \begin_inset Quotes eld
16102 \begin_inset Quotes erd
16105 your document before printing, and you should run it right after the obligatory
16106 spelling check, and before you go fine tuning the typesetting.
16109 \begin_layout Subsection
16113 \begin_layout Standard
16114 If you have the program installed, usage is as simple as choosing
16119 ools\SpecialChar \menuseparator
16128 This will make LyX generate a LaTeX file of your document, start
16132 to check it, and then make LyX insert
16133 \begin_inset Quotes eld
16137 \begin_inset Quotes erd
16140 with the warnings from
16144 , if there were any.
16145 The warnings will be placed close to the point of the mistake, and you
16146 can quickly find them by using the
16151 avigate\SpecialChar \menuseparator
16158 menu item, or the shortcut key
16167 Open the error boxes by clicking on them with the mouse, or use the shortcut
16176 bindings, or the corresponding
16185 Read the warning and correct the mistake, if it is a mistake.
16186 If you have trouble understanding what the warning is about, you can safely
16188 Remember that there is a hidden layer between the document on screen and
16189 the technical details in invoking
16193 , and this gap can make some warnings seem arcane or just right down plain
16197 \begin_layout Standard
16198 This document is an excellent testing bed for the feature, and it should
16199 provide quite a few warnings for you to fiddle with.
16200 Since computers are only so smart, expect most of the warnings to be false
16204 \begin_layout Subsection
16205 How to fine tune it
16208 \begin_layout Standard
16209 Sometimes, you'll find that
16213 makes more noise than suits your mood.
16214 Then you can choose not to use it, wait until your mood changes, or try
16219 to get better along with you.
16220 Another choice in the most desperate situations is to use
16225 iew\SpecialChar \menuseparator
16235 , which will get rid of all warnings instantly.
16238 \begin_layout Standard
16247 very configurable and extensible, you shouldn't expect to solve all problems
16253 Since LyX has to generate a somewhat special LaTeX file to be able to match
16254 the line numbers from the
16262 \begin_layout Standard
16263 You can inspect the specific output from
16269 Edit\SpecialChar \menuseparator
16283 to the internal document structure, some of the warnings will not seen
16284 to appear correctly.
16285 There are two things you can do about this:
16288 \begin_layout Itemize
16293 invocation command line in
16309 installation configuration file (usually with the file
16311 /usr/local/share/chktexrc
16314 See below to learn what warnings can be enabled and disabled on the command
16319 \begin_layout Itemize
16320 Export your document as a raw LaTeX file using
16325 ile\SpecialChar \menuseparator
16330 xport\SpecialChar \menuseparator
16342 Invoked in this way, it can be a hassle to find the corresponding place
16343 in the document inside LyX, but with a little patience, you should be able
16347 \begin_layout Standard
16348 Here follows the warning messages that can be enabled and disabled in
16357 to disable a warning, and
16361 to enable a warning.
16362 The emphasized entries are disabled by default, because the default is
16365 chktex -n1 -n3 -n6 -n9 -n22 -n25 -n30 -n38
16370 \begin_layout Standard
16371 Notice that you should only use the options that enable and disable warnings,
16372 because LyX relies on some of the other command line parameters to be set
16373 in a specific way to have a chance to communicate with
16380 \begin_layout Enumerate
16384 Command terminated with space.
16387 \begin_layout Enumerate
16390 Non-breaking space (
16391 \begin_inset Quotes eld
16399 \begin_inset Quotes erd
16402 ) should have been used.
16405 \begin_layout Enumerate
16409 You should enclose the previous parenthesis with
16410 \begin_inset Quotes eld
16418 \begin_inset Quotes erd
16424 \begin_layout Enumerate
16427 Italic correction (
16428 \begin_inset Quotes eld
16438 \begin_inset Quotes erd
16441 ) found in non-italic buffer.
16444 \begin_layout Enumerate
16447 Italic correction (
16448 \begin_inset Quotes eld
16458 \begin_inset Quotes erd
16461 ) found more than once.
16464 \begin_layout Enumerate
16468 No italic correction (
16469 \begin_inset Quotes eld
16479 \begin_inset Quotes erd
16485 \begin_layout Enumerate
16489 \begin_inset Quotes eld
16497 \begin_inset Quotes erd
16501 \begin_inset Quotes eld
16509 \begin_inset Quotes erd
16515 \begin_layout Enumerate
16518 Wrong length of dash may have been used.
16521 \begin_layout Enumerate
16525 \begin_inset Quotes eld
16533 \begin_inset Quotes erd
16537 \begin_inset Quotes eld
16545 \begin_inset Quotes erd
16551 \begin_layout Enumerate
16555 \begin_inset Quotes eld
16563 \begin_inset Quotes erd
16569 \begin_layout Enumerate
16573 \begin_inset Quotes eld
16581 \begin_inset Quotes erd
16584 to achieve an ellipsis.
16587 \begin_layout Enumerate
16590 Inter-word spacing (
16591 \begin_inset Quotes eld
16601 \begin_inset Quotes eld
16604 ) should perhaps be used.
16607 \begin_layout Enumerate
16610 Inter-sentence spacing (
16611 \begin_inset Quotes eld
16621 \begin_inset Quotes erd
16624 ) should perhaps be used.
16627 \begin_layout Enumerate
16630 Could not find argument for command.
16633 \begin_layout Enumerate
16637 \begin_inset Quotes eld
16645 \begin_inset Quotes erd
16651 \begin_layout Enumerate
16654 Math mode still on at end of LaTeX file.
16657 \begin_layout Enumerate
16661 \begin_inset Quotes eld
16669 \begin_inset Quotes erd
16672 doesn't match the number of
16673 \begin_inset Quotes eld
16681 \begin_inset Quotes erd
16687 \begin_layout Enumerate
16690 You should use either
16693 \begin_inset Quotes eld
16701 \begin_inset Quotes erd
16706 as an alternative to
16707 \begin_inset Quotes eld
16715 \begin_inset Quotes erd
16721 \begin_layout Enumerate
16728 " (ASCII 39) instead of "
16735 \begin_layout Enumerate
16738 User-specified pattern found.
16741 \begin_layout Enumerate
16744 This command might not be intended.
16747 \begin_layout Enumerate
16754 \begin_layout Enumerate
16772 \begin_layout Enumerate
16775 Delete this space to maintain correct page references.
16778 \begin_layout Enumerate
16782 You might wish to put this between a pair of
16783 \begin_inset Quotes eld
16791 \begin_inset Quotes erd
16797 \begin_layout Enumerate
16800 You ought to remove spaces in front of punctuation.
16803 \begin_layout Enumerate
16806 Could not execute LaTeX command.
16809 \begin_layout Enumerate
16818 in front of small punctuation.
16821 \begin_layout Enumerate
16829 may look prettier here.
16832 \begin_layout Enumerate
16836 Multiple spaces detected in output.
16839 \begin_layout Enumerate
16842 This text may be ignored.
16845 \begin_layout Enumerate
16851 \begin_inset Quotes eld
16856 to begin quotation, not
16863 \begin_layout Enumerate
16870 to end quotation, not
16873 \begin_inset Quotes eld
16881 \begin_layout Enumerate
16887 \begin_layout Enumerate
16890 You should perhaps use
16891 \begin_inset Quotes eld
16899 \begin_inset Quotes erd
16905 \begin_layout Enumerate
16908 You should put a space in front of/after parenthesis.
16911 \begin_layout Enumerate
16914 You should avoid spaces in front of/after parenthesis.
16917 \begin_layout Enumerate
16921 You should not use punctuation in front of/after quotes.
16924 \begin_layout Enumerate
16927 Double space found.
16930 \begin_layout Enumerate
16933 You should put punctuation outside inner/inside display math mode.
16936 \begin_layout Enumerate
16939 You ought to not use primitive TeX in LaTeX code.
16942 \begin_layout Enumerate
16945 You should remove spaces in front of
16946 \begin_inset Quotes eld
16954 \begin_inset Quotes erd
16960 \begin_layout Enumerate
16963 \begin_inset Quotes eld
16971 \begin_inset Quotes erd
16974 is normally not followed by
16975 \begin_inset Quotes eld
16983 \begin_inset Quotes erd
16989 \begin_layout Standard
16990 In later versions of LyX, we hope to provide a more complete interface to
16991 this tool (and it's smaller cousin
16995 ) to exploit the full power of it.
16996 But it's not exactly useless as it is now: go try it on one of your existing
16997 documents of a certain length and be surprised.
17000 \begin_layout Section
17001 Version Control in LyX
17004 \begin_layout Standard
17007 Lars Gullik Bjønnes
17010 \begin_layout Subsection
17014 \begin_layout Standard
17015 A friend of mine wanted to try LyX for a group project.
17016 When he didn't find support for version control or file locking, he dropped
17018 This angered me a bit, so I thought that I should at least make support
17019 for RCS (with the possibility of CVS and/or SCCS as a future improvement.)
17020 This has now been done.
17021 LyX now supports some of the most basic RCS commands.
17022 If you need to something a bit more sophisticated you will have to do that
17023 manually in an xterm.
17026 \begin_layout Standard
17027 Before you begin to use the version control features in LyX, you should
17029 \begin_inset Quotes eld
17033 \begin_inset Quotes erd
17036 (a man file, read it with
17041 This file describes all the basic features of RCS.
17042 You should especially notice the comment about a RCS directory, and the
17043 notion of a master RCS file (the file ending in
17050 \begin_layout Standard
17051 The implementation in LyX assumes a recent version of the GNU RCS package---no
17052 guarantees are made for older versions.
17055 \begin_layout Subsection
17056 RCS commands in LyX
17059 \begin_layout Standard
17060 The following sections describe the RCS commands supported by LyX.
17061 You can find them in the
17066 ile\SpecialChar \menuseparator
17071 ersion\InsetSpace ~
17077 \begin_layout Subsubsection
17083 \begin_layout Standard
17084 If your document is not under revision control, this is the only item shown
17086 And if it is under revision control, the
17093 item is grayed out.
17097 \begin_layout Standard
17098 This command registers your document with RCS\SpecialChar \@.
17099 You are asked interactively
17100 to supply an initial description of the document.
17101 The document is now set in Read-Only mode and you have to
17108 , before making any changes to it.
17109 A document under revision control has a
17110 \begin_inset Quotes eld
17113 [RCS:<version> <locker>]
17114 \begin_inset Quotes erd
17117 item tagged to the filename in the minibuffer.
17120 \begin_layout Standard
17121 RCS command that is run:
17123 ci -q -u -i -t-"<initial description>" <file-name>
17126 \begin_layout Standard
17131 to understand the switches.
17135 \begin_layout Subsubsection
17141 \begin_layout Standard
17142 When you are finished editing a file, you check in your changes.
17143 When you do this, you are asked for a description of the changes.
17144 This is stored in the history log.
17145 The version number is bumped, your changes are applied to the master RCS
17146 file, the document is unlocked and set to Read-Only mode.
17150 \begin_layout Standard
17153 ci -q -u -m"<description>" <file-name>
17156 \begin_layout Subsubsection
17162 \begin_layout Standard
17163 By doing this you lock the document so that only you can edit it.
17164 This will also make the document Read-Write only for you.
17165 You will usually continue editing for a while and when you are finished
17166 you check in your changes.
17167 The status line is changed to reflect that you have locked the file.
17171 \begin_layout Standard
17174 co -q -l <file-name>
17177 \begin_layout Subsubsection
17180 Revert To Last Version
17183 \begin_layout Standard
17184 This will discard all changes made to the document since the last check
17186 You get a warning before changes are discarded.
17189 \begin_layout Standard
17192 co -f -u<version> <file-name>
17195 \begin_layout Subsubsection
17201 \begin_layout Standard
17202 This makes as if the last check in never happened.
17203 No changes are made to the document loaded into LyX, but the last version
17204 is removed from the master RCS file.
17208 \begin_layout Standard
17211 rcs -o<version> <file-name>
17214 \begin_layout Subsubsection
17220 \begin_layout Standard
17221 This show the complete history of the RCS document.
17226 is shown in a browser.
17234 \begin_layout Section
17235 Literate Programming
17238 \begin_layout Standard
17243 (kayvan@sylvan.com)
17247 original documentation written by
17249 Edmar Wienskoski Jr.
17252 (edmar-w-jr@technologist.com)
17255 \begin_layout Subsection
17259 \begin_layout Standard
17260 The main purpose of this documentation is to show you how to use LyX for
17261 literate programming.
17262 Where it is assumed that you are familiar with this programming technique,
17264 \begin_inset Quotes eld
17268 \begin_inset Quotes erd
17272 \begin_inset Quotes eld
17276 \begin_inset Quotes erd
17280 If that is not the case, please follow the web links provided in the following
17282 There is a lot of good documentation out there covering old development
17283 history to the latest tools tips.
17286 \begin_layout Standard
17287 It is also assumed that you are familiar with LyX itself to a point that
17288 you are comfortable changing your LyX preferences, and X resources file.
17289 If that is not the case please refer to other LyX documentation to cover
17290 your specific needs.
17293 \begin_layout Subsection
17294 Literate Programming
17297 \begin_layout Standard
17298 From the Literate Programming FAQ:
17301 \begin_layout Quotation
17302 Literate programming is the combination of documentation and source together
17303 in a fashion suited for reading by human beings.
17304 In fact, literate programs should be enjoyable reading, even inviting!
17305 (Sorry Bob, I couldn't resist!) In general, literate programs combine source
17306 and documentation in a single file.
17307 Literate programming tools then parse the file to produce either readable
17308 documentation or compilable source.
17309 The WEB style of literate programming was created by D.E.
17310 Knuth during the development of his TeX typesetting software.
17314 \begin_layout Standard
17315 Another excerpt says:
17318 \begin_layout Quotation
17321 How is literate programming different from verbose commenting?
17324 \begin_layout Quotation
17325 There are three distinguishing characteristics.
17326 In order of importance, they are:
17330 \begin_layout Itemize
17331 flexible order of elaboration
17334 \begin_layout Itemize
17335 automatic support for browsing
17338 \begin_layout Itemize
17339 typeset documentation, especially diagrams and mathematics
17343 \begin_layout Standard
17344 Now that I sparked your curiosity, take a look in the references.
17347 \begin_layout Subsubsection
17351 \begin_layout Standard
17352 The complete Literate Programming FAQ can be found at:
17355 \begin_layout Quote
17356 \begin_inset LatexCommand url
17357 name "Literate Programming FAQ"
17358 target "http://shelob.ce.ttu.edu/daves/lpfaq/faq.html"
17365 \begin_layout Standard
17366 The FAQ lists 23 (twenty three!) different literate programming tools.
17367 Where some are specialized or
17368 \begin_inset Quotes eld
17372 \begin_inset Quotes erd
17375 for particular programming languages, while other have general scope.
17380 for my own use for several reasons:
17383 \begin_layout Itemize
17384 It can generate the documentation either in LaTeX or HTML.
17387 \begin_layout Itemize
17388 It has a open architecture, i.e., it is easy to plug in new filters and to
17389 perform special processing that you may need.
17393 \begin_layout Itemize
17394 There is a good selection of filters available already (the HTML is one
17398 \begin_layout Itemize
17402 \begin_layout Standard
17403 The Noweb web page can be found at:
17406 \begin_layout Quote
17407 \begin_inset LatexCommand url
17408 name "Noweb home page"
17409 target "http://www.cs.virginia.edu/~nr/noweb/"
17416 \begin_layout Standard
17417 Starting from there you can reach many other interesting links and even
17418 some literate program examples.
17421 \begin_layout Subsection
17422 LyX and Literate Programming
17425 \begin_layout Standard
17426 The LyX support for Literate Programming is provided by using the generic
17427 LyX convertors mechanism.
17428 This support is provided in a
17429 \begin_inset Quotes eld
17433 \begin_inset Quotes erd
17436 way, i.e., you will be able to use this new LyX feature with some other literate
17437 programming tool of your choice by just changing your LyX preferences.
17440 \begin_layout Subsubsection
17441 Generating documents and code (weaving and tangling)
17444 \begin_layout Paragraph
17445 Selecting the document class
17448 \begin_layout Standard
17449 If you have installed Noweb and LyX successfully, whenever you open a new
17450 document or try to change the document class of an existing one, you will
17451 find that there are three new document classes available:
17454 \begin_layout Itemize
17458 \begin_layout Itemize
17462 \begin_layout Itemize
17466 \begin_layout Standard
17467 You must select one of them to create your literate documents from.
17471 \begin_layout Standard
17472 Note that literate documents are not limited to these three classes.
17473 New classes can be generated from other styles like letter or in combination
17474 with other class variations like Article (AMS).
17475 If you have special needs that cannot be covered by one of the existing
17476 classes, let the LyX developers list (lyx-devel@lists.lyx.org) know and we
17477 will arrange to insert a new entry, or teach you how to do it.
17481 \begin_layout Standard
17482 It is very simple, it involves the creation of a file with four lines, and
17483 re-running of the auto configuration.
17488 Moreover, if you use a literate tool other than Noweb you may need to create
17489 a new set of document classes for it.
17492 \begin_layout Paragraph
17496 \begin_layout Standard
17497 LyX enables you to write code with a layout named
17505 \begin_layout Standard
17506 The equivalent Noweb term is
17507 \begin_inset Quotes eld
17511 \begin_inset Quotes erd
17515 For historical reasons, I got used to the term
17516 \begin_inset Quotes eld
17520 \begin_inset Quotes erd
17523 introduced by other literate tool named Nuweb, which I used for many years
17524 before rendering myself to Noweb.
17529 Noweb delimits scraps like this:
17532 \begin_layout LyX-Code
17536 \begin_layout LyX-Code
17540 \begin_layout LyX-Code
17544 \begin_layout LyX-Code
17548 \begin_layout LyX-Code
17552 \begin_layout Standard
17553 The problem is that whatever is written in between the << and the
17557 must be taken literally, i.e., LyX should be prevented from making any special
17558 interpretation of what has been written.
17559 This is handled by a special layout named Scrap, that works like a normal
17560 paragraph but has a free spacing capability.
17563 \begin_layout Standard
17564 The down side of the Scrap paragraph layout is that consecutive paragraphs
17565 of code will be spaced with one empty line in the source code and also
17566 in the printed documentation.
17567 The work around is to enter each line of code within a single Scrap, with
17568 a newline (ctrl-return).
17569 The example above will look like this:
17573 \begin_layout Standard
17574 If you have a printed version of this document you will not see any difference
17575 between the previous example and this one.
17583 \begin_layout LyX-Code
17595 \begin_layout Standard
17596 This layout works fine.
17597 The only real inconvenience is that you have to type ctrl-return instead
17602 \begin_layout Standard
17603 It is in my list of
17604 \begin_inset Quotes eld
17608 \begin_inset Quotes erd
17619 \begin_layout Standard
17620 As a special note, you can also use the
17621 \begin_inset Quotes eld
17625 \begin_inset Quotes erd
17628 construct of Noweb in your scraps to add items to Noweb's identifier cross-refe
17632 \begin_layout LyX-Code
17635 def some_function(args):
17637 "This is the doc string for this
17640 print "My args: ", args
17643 \begin_layout LyX-Code
17644 @ %def some_function
17647 \begin_layout Standard
17648 For an example of this usage and the resulting cross-reference output, look
17649 at the Literate python program in
17651 LIBDIR/examples/listerrors.lyx
17653 which should make this all clear.
17656 \begin_layout Paragraph
17657 Generating the documentation
17660 \begin_layout Standard
17661 At this point you already have a new document file with a proper document
17662 class, and with some code and text on it.
17663 How do I print it? The answer is simple, you select
17668 iew\SpecialChar \menuseparator
17676 Just like you would do for a plain document.
17677 No special procedure is required.
17680 \begin_layout Standard
17681 To help orientate you, I will now explain what happens inside LyX:
17684 \begin_layout Enumerate
17690 pdate\SpecialChar \menuseparator
17697 menu option is chosen, a LaTeX file is generated.
17702 \begin_layout Standard
17703 If the document is of any literate class the generated file will be named
17704 with an extension name defined by the
17705 \begin_inset Quotes eld
17709 \begin_inset Quotes erd
17712 format (defined in the Preferences panel), otherwise the file will have
17721 \begin_layout Enumerate
17722 Note that the only difference so far is in the name of the file, no special
17723 processing is required by LyX.
17724 Given that you formatted the code using the Scrap layout that, by itself,
17725 takes care of the business.
17728 \begin_layout Enumerate
17729 If the document is of any literate class LyX will then use the internal
17730 LyX to Noweb converter, followed by the Noweb to LaTeX converter
17734 \begin_layout Standard
17735 The converters are defined in the
17740 ools\SpecialChar \menuseparator
17748 \begin_inset Quotes eld
17752 \begin_inset Quotes erd
17760 to generate the LaTeX file.
17764 \begin_layout Standard
17765 Otherwise it will just skip this step.
17769 \begin_layout Enumerate
17770 Finally, LaTeX is invoked and the regular post processing continues as in
17774 \begin_layout Standard
17775 Independence from a particular
17776 \begin_inset Quotes eld
17780 \begin_inset Quotes erd
17783 is easily achieved by changing the commands that are run by the various
17787 \begin_layout Paragraph
17788 Generating the code
17791 \begin_layout Standard
17792 When the build menu option is chosen or the corresponding button in the
17793 toolbar is pressed, a LaTeX file is generated just like step 1 above.
17794 Next, LyX invokes the
17799 Typically, this converter (like any other converter), has two parts:
17802 \begin_layout Enumerate
17803 The converter program itself.
17804 This program performs the conversion from the one format to the other (in
17805 this case, from the Noweb format to the Program pseudo-format).
17808 \begin_layout Enumerate
17809 The error log parser.
17810 This is a program whose sole purpose is to rewrite error messages in a
17811 format that LyX understands.
17812 This makes it possible for LyX to place error boxes in the right places
17813 in the file buffer.
17816 \begin_layout Standard
17817 The first part, the
17818 \begin_inset Quotes eld
17822 \begin_inset Quotes erd
17825 setting, should be set to
17826 \begin_inset Quotes eld
17834 \begin_inset Quotes erd
17838 This basically means that LyX will call
17839 \begin_inset Quotes eld
17843 \begin_inset Quotes erd
17846 (a program or script) with the name of the Noweb file (generally a file
17847 in the LyX temp directory).
17851 \begin_layout Standard
17852 This is an implementation of
17853 \begin_inset Quotes eld
17857 \begin_inset Quotes erd
17860 that you can place in a directory on your path:
17863 \begin_layout LyX-Code
17867 \begin_layout LyX-Code
17871 \begin_layout LyX-Code
17872 notangle -Rbuild-script $1 | env NOWEB_SOURCE=$1 sh
17875 \begin_layout Standard
17876 The next part of the converter setting is the
17877 \begin_inset Quotes eld
17881 \begin_inset Quotes erd
17884 which is to be set to
17885 \begin_inset Quotes eld
17890 originaldir,parselog=listerrors
17893 \begin_inset Quotes erd
17897 This will run any errors that are generated by the
17898 \begin_inset Quotes eld
17902 \begin_inset Quotes erd
17905 process through the
17906 \begin_inset Quotes eld
17910 \begin_inset Quotes erd
17916 \begin_layout Standard
17917 The converter code looks in
17925 then on the path for the
17926 \begin_inset Quotes eld
17930 \begin_inset Quotes erd
17936 \begin_layout Paragraph
17937 Build instructions in the document
17940 \begin_layout Standard
17941 The last piece of the integration between LyX and noweb is the
17942 \begin_inset Quotes eld
17946 \begin_inset Quotes erd
17950 Generally, the instructions for building your program should be embedded
17951 in a scrap of its own.
17953 \begin_inset Quotes eld
17957 \begin_inset Quotes erd
17960 above uses the notangle command to look for this scrap (called
17961 \begin_inset Quotes eld
17965 \begin_inset Quotes erd
17968 ) and runs its contents through
17969 \begin_inset Quotes eld
17973 \begin_inset Quotes erd
17979 \begin_layout Standard
17980 Typically, such a scrap would look something like this:
17983 \begin_layout LyX-Code
17990 if [ -z "${NOWEB_SOURCE}" ]
17994 NOWEB_SOURCE=myfile.nw
18000 code to extract files ...]
18003 code to compile files ...]
18008 \begin_layout Standard
18011 LIBDIR/examples/listerrors.lyx
18015 LIBDIR/examples/Literate.lyx
18017 which implement two versions of the
18018 \begin_inset Quotes eld
18022 \begin_inset Quotes erd
18025 program for some illustrations of how all of these pieces go together or
18028 LIBDIR/examples/noweb2lyx.lyx.
18031 Interestingly, these three files show off the language-indepence of the
18032 LyX literate programming support since they are written in Python, C and
18036 \begin_layout Subsubsection
18040 \begin_layout Standard
18041 All the Literate Programming support is configured by the
18046 ools\SpecialChar \menuseparator
18054 \begin_inset Quotes eld
18058 \begin_inset Quotes erd
18062 The important parts are:
18065 \begin_layout Description
18068 \begin_inset Quotes eld
18072 \begin_inset Quotes erd
18076 format Set up via the Formats tab, this is where the Noweb-specific pieces
18086 , the file extension is set to
18091 This tells LyX to create a file with a
18095 extension in the first step of the conversion process.
18098 \begin_layout Description
18105 format This is an empty format whose sole purpose is to be the endpoint
18106 of a conversion (which then allows us to set up a converter for it).
18109 \begin_layout Description
18118 This converter performs the
18119 \begin_inset Quotes eld
18123 \begin_inset Quotes erd
18126 of the literate document.
18127 For Noweb, it is set to
18128 \begin_inset Quotes eld
18133 noweave -delay -index $$i > $$o
18136 \begin_inset Quotes erd
18142 \begin_layout Description
18152 \begin_inset Quotes eld
18156 \begin_inset Quotes erd
18160 As stated above, the Converter is set to
18161 \begin_inset Quotes eld
18169 \begin_inset Quotes erd
18172 , with Flags set to
18173 \begin_inset Quotes eld
18178 originaldir,parselog=listerrors
18181 \begin_inset Quotes erd
18187 \begin_layout Subsubsection
18191 \begin_layout Standard
18192 There is also a new function implemented in the LyX server, the
18193 \begin_inset Quotes eld
18196 server-goto-file-row" function, to be used with ddd/gdb or other debugger.
18200 \begin_layout Standard
18201 When debugging code with ddd/gdb, it is possible to invoke a text editor
18202 at the current execution position with a single key stroke.
18203 The default ddd configuration for that is shift-ctrl-V.
18204 It happens that you can define the editor command line invocation in ddd
18211 dit\SpecialChar \menuseparator
18216 references\SpecialChar \menuseparator
18223 dialog and changing the "Edit Sources" entry.
18226 \begin_layout Standard
18227 I take advantage of the new created LyX server function and this ddd feature,
18229 \begin_inset Quotes eld
18233 \begin_inset Quotes erd
18239 \begin_layout LyX-Code
18240 echo "LYXCMD:monitor:server-goto-file-row:@FILE@ @LINE@" >~/.lyxpipe.in
18243 \begin_layout Standard
18244 With this, whenever you are using ddd and find a point in the program that
18245 you want to edit, you just press shift-ctrl-V (in the ddd window), and
18246 ddd you forward this information to LyX through the LyX server and then
18247 the LyX window will show the same file with the cursor at the same position
18248 ddd was pointing to.
18249 No more guessing or long scrolling to locate a point in the program back
18253 \begin_layout Standard
18254 Note however that you must enable the LyX server to get this feature working
18255 (it is disabled by default).
18256 You can enable it in
18268 ) by entering in the
18273 \begin_inset Quotes eld
18278 /home/<your-home-directory>/.lyx/lyxpipe
18281 \begin_inset Quotes erd
18287 \begin_layout Standard
18288 Read the LyX server documentation in the
18290 Customization Manual
18292 for further information.
18295 \begin_layout Subsubsection
18299 \begin_layout Standard
18300 There are six new buttons that can be added to your LyX toolbar.
18301 Five of these buttons are short cuts to layout styles:
18322 The last one is a short cut to the
18323 \begin_inset Quotes eld
18327 \begin_inset Quotes erd
18334 \begin_layout Standard
18335 LyX has a range of buttons that are available for tool bar customization.
18336 In my toolbar I like to combine the six short cuts above with two more:
18344 \SpecialChar \menuseparator
18352 \SpecialChar \menuseparator
18365 iew\SpecialChar \menuseparator
18373 Here is how it looks like:
18376 \begin_layout LyX-Code
18380 \begin_layout LyX-Code
18384 \begin_layout LyX-Code
18385 Icon "layout Standard"
18388 \begin_layout LyX-Code
18389 Icon "layout Section"
18392 \begin_layout LyX-Code
18393 Icon "layout LaTeX"
18396 \begin_layout LyX-Code
18397 Icon "layout LyX-Code"
18400 \begin_layout LyX-Code
18401 Icon "layout Scrap"
18404 \begin_layout LyX-Code
18408 \begin_layout LyX-Code
18412 \begin_layout LyX-Code
18413 Icon "buffer-typeset"
18416 \begin_layout LyX-Code
18417 Icon "build-program"
18420 \begin_layout LyX-Code
18424 \begin_layout LyX-Code
18428 \begin_layout LyX-Code
18432 \begin_layout LyX-Code
18436 \begin_layout LyX-Code
18440 \begin_layout Subsubsection
18441 Colors customization
18444 \begin_layout Standard
18445 There are a number of colors in LyX that can be customized in
18450 One of the things that bothers people is the LaTeX font color.
18451 The default color is red, since the scraps uses LaTeX font, and there is
18452 a lot of scraps in literate documents, you may get tired of seeing everything
18454 You can change it by going to the tabs
18463 \begin_layout Standard
18464 The next thing is the visible presence of the newline character in the screen.
18465 You can choose the color of this particular character and make it blend
18467 I recommend you choosing a color that is close to the background but not
18468 equal, that way you still can see it is there, but it is not bothering
18473 \begin_layout Chapter
18474 Secrets of the LaTeX Masters
18475 \begin_inset LatexCommand label
18483 \begin_layout Standard
18484 Though LyX is a powerful tool, it cannot hope to support everything that
18485 can be done with pure TeX/LaTeX.
18486 However, many familiar dirty TeX and LaTeX tricks can be done within LyX,
18487 as long as you are not afraid to use that
18488 \begin_inset Quotes eld
18492 \begin_inset Quotes erd
18495 button on the toolbar or add things to the LaTeX preamble.
18496 This section lists some tips, tricks, and otherwise cool ideas to give
18497 your document that extra little flair.
18500 Do try this at home
18502 , just start with something a little smaller and less important than your
18506 \begin_layout Standard
18507 Most ideas in this section require less common files in your LaTeX installation.
18508 If you have a system like teTeX, most will already be available.
18509 A few, however, will need to be downloaded from one of the CTAN archives.
18510 Often, there are several ways to do something, or several LaTeX style files
18511 which do the same thing.
18512 We do not endorse one choice over another, we simply claim that we have
18513 done a particular task with a particular file.
18514 Put on your wizard hat, keep an eye out for dragons, and let us begin.
18517 \begin_layout Section
18521 \begin_layout Standard
18524 Lars Gullik Bjønnes
18527 \begin_layout Subsection
18531 \begin_layout Standard
18532 The aim for this chapter
18536 \begin_layout Standard
18537 Editor's note: Lars' original chapter was a masterful description of how
18543 However, it was too long to flow smoothly in this document.
18544 I have therefore chosen to excerpt the most important sections here (sorry,
18545 Lars); you can read the original chapter (and more of the story!) in the
18548 examples/multicol.lyx
18556 is to show how the LaTeX package
18560 can be used in a LyX document.
18561 As LyX doesn't support the
18565 package natively yet, we have to use some small hacks.
18566 By reading this section it should be obvious how to do this.
18569 \begin_layout Subsection
18573 \begin_layout Standard
18578 package allows switching between one and multicolumn format on the same
18580 Footnotes are handled correctly (for the most part), but will be placed
18581 at the bottom of the page and not under each column.
18582 LaTeX's float mechanism, however, is partly disabled in the current implementat
18584 At the moment only page-wide floats can be used within the scope of the
18588 \begin_layout Subsection
18592 \begin_layout Subsubsection
18596 \begin_layout Standard
18597 If you want to have two columns in your text, you have use LaTeX mode to
18602 begin{multicols}{2}
18604 at the point where you want the two column layout to start, and then
18610 where you want it to end.
18614 \begin_layout Standard
18618 \begin_layout Standard
18622 begin{multicols}{2}
18630 \begin_layout Standard
18635 The Adventure of the Empty House
18641 Sir Arthur Conan Doyle
18644 \begin_layout Standard
18647 It was in the spring of the year 1894 that all London was interested, and
18648 the fashionable world dismayed, by the murder of the Honourable Ronald
18649 Adair under most unusual and inexplicable circumstances.
18650 The public has already learned those particulars of the crime which came
18651 out in the police investigation, but a good deal was suppressed upon that
18652 occasion, since the case for the prosecution was so overwhelmingly strong
18653 that it was not necessary to bring forward all the facts.
18654 Only now, at the end of nearly ten years, am I allowed to supply those
18655 missing links which make up the whole of that remarkable chain.
18656 The crime was of interest in itself, but that interest was as nothing to
18657 me compared to the inconceivable sequel, which afforded me the greatest
18658 shock and surprise of any event in my adventurous life.
18659 Even now, after this long interval, I find myself thrilling as I think
18660 of it, and feeling once more that sudden flood of joy, amazement, and increduli
18661 ty which utterly submerged my mind.
18662 Let me say to that public, which has shown some interest in those glimpses
18663 which I have occasionally given them of the thoughts and actions of a very
18664 remarkable man, that they are not to blame me if I have not shared my knowledge
18665 with them, for I should have considered it my first duty to do so, had
18666 I not been barred by a positive prohibition from his own lips, which was
18667 only withdrawn upon the third of last month.
18670 \begin_layout Standard
18674 \begin_layout Standard
18686 \begin_layout Subsubsection
18690 \begin_layout Standard
18691 The same pattern is used when you want more than two columns:
18694 \begin_layout Standard
18698 \begin_layout Standard
18702 begin{multicols}{3}
18710 \begin_layout Standard
18713 It can be imagined that my close intimacy with Sherlock Holmes had interested
18714 me deeply in crime, and that after his disappearance I never failed to
18715 read with care the various problems which came before the public.
18716 And I even attempted, more than once, for my own private satisfaction,
18717 to employ his methods in their solution, though with indifferent success.
18718 There was none, however, which appealed to me like this tragedy of Ronald
18720 As I read the evidence at the inquest, which led up to a verdict of willful
18721 murder against some person or persons unknown, I realized more clearly
18722 than I had ever done the loss which the community had sustained by the
18723 death of Sherlock Holmes.
18724 There were points about this strange business which would, I was sure,
18725 have specially appealed to him, and the efforts of the police would have
18726 been supplemented, or more probably anticipated, by the trained observation
18727 and the alert mind of the first criminal agent in Europe.
18728 All day, as I drove upon my round, I turned over the case in my mind and
18729 found no explanation which appeared to me to be adequate.
18730 At the risk of telling a twice-told tale, I will recapitulate the facts
18731 as they were known to the public at the conclusion of the inquest.
18734 \begin_layout Standard
18738 \begin_layout Standard
18750 \begin_layout Standard
18751 You can have more than 3 columns if you want to, but that might not be very
18752 pleasant for the eye.
18755 \begin_layout Subsubsection
18756 Columns inside columns
18759 \begin_layout Standard
18760 You can even have columns inside columns:
18763 \begin_layout Standard
18767 \begin_layout Standard
18771 begin{multicols}{2}
18779 \begin_layout Standard
18782 The Honourable Ronald Adair was the second son of the Earl of Maynooth,
18783 at that time governor of one of the Australian colonies.
18784 Adair's mother had returned from Australia to undergo the operation for
18785 cataract, and she, her son Ronald, and her daughter Hilda were living together
18789 \begin_layout Standard
18793 \begin_layout Standard
18797 begin{multicols}{2}
18805 \begin_layout Standard
18808 The youth moved in the best society--had, so far as was known, no enemies
18809 and no particular vices.
18810 He had been engaged to Miss Edith Woodley, of Carstairs, but the engagement
18811 had been broken off by mutual consent some months before, and there was
18812 no sign that it had left any very profound feeling behind it.
18813 For the rest {sic} the man's life moved in a narrow and conventional circle,
18814 for his habits were quiet and his nature unemotional.
18815 Yet it was upon this easy-going young aristocrat that death came, in most
18816 strange and unexpected form, between the hours of ten and eleven-twenty
18817 on the night of March 30, 1894.
18820 \begin_layout Standard
18824 \begin_layout Standard
18836 \begin_layout Standard
18839 Ronald Adair was fond of cards--playing continually, but never for such
18840 stakes as would hurt him.
18841 He was a member of the Baldwin, the Cavendish, and the Bagatelle card clubs.
18842 It was shown that, after dinner on the day of his death, he had played
18843 a rubber of whist at the latter club.
18844 He had also played there in the afternoon.
18849 The evidence of those who had played with him-- Mr.
18850 Murray, Sir John Hardy, and Colonel Moran--showed that the game was whist,
18851 and that there was a fairly equal fall of the cards.
18852 Adair might have lost five pounds, but not more.
18853 His fortune was a considerable one, and such a loss could not in any way
18855 He had played nearly every day at one club or other, but he was a cautious
18856 player, and usually rose a winner.
18857 It came out in evidence that, in partnership with Colonel Moran, he had
18858 actually won as much as four hundred and twenty pounds in a sitting, some
18859 weeks before, from Godfrey Milner and Lord Balmoral.
18860 So much for his recent history as it came out at the inquest.
18863 \begin_layout Standard
18867 \begin_layout Standard
18879 \begin_layout Standard
18880 Please do read the file
18882 examples/multicol.lyx
18884 for more advanced examples including column and header spacing, vertical
18885 separator lines, and more.
18888 \begin_layout Section
18893 Paragraph Environment
18894 \begin_inset OptArg
18897 \begin_layout Standard
18898 Numbering in Enumerate
18906 \begin_layout Standard
18912 \begin_layout Standard
18913 \begin_inset VSpace bigskip
18919 \begin_layout Standard
18921 The default numbering for the
18925 paragraph environment begins with Arabic numbers and ends with uppercase
18927 Suppose, however, you wanted a different type of numbering scheme.
18928 Here's a quickie example of how to change the numbering scheme:
18931 \begin_layout LyX-Code
18941 \begin_layout LyX-Code
18951 \begin_layout LyX-Code
18961 \begin_layout LyX-Code
18971 \begin_layout Standard
18972 \SpecialChar \ldots{}
18973 which changes the numbering scheme to uppercase Roman numerals, uppercase
18974 letters, Arabic numbers, and lowercase letter.
18977 \begin_layout Standard
18978 Additionally, the previous example also adds a little bit extra to the numbering
18980 For example, the first level label actually looks like:
18981 \begin_inset Quotes eld
18985 \begin_inset Quotes erd
18989 For ease of reading, we'll describe what the numbering schemes look like
18990 using a notation something like this: <
18991 \begin_inset Quotes eld
18995 \begin_inset Quotes erd
19000 \begin_inset Quotes erd
19004 \begin_inset Quotes erd
19009 \begin_inset Quotes erd
19013 \begin_inset Quotes erd
19018 \begin_inset Quotes eld
19022 \begin_inset Quotes erd
19029 \begin_layout Standard
19030 As you can see in the example, there is a label command for each nesting
19037 \SpecialChar \ldots{}
19044 , as well as a counter,
19048 \SpecialChar \ldots{}
19054 There are also five
19055 \begin_inset Quotes eld
19059 \begin_inset Quotes erd
19092 , each of which take one counter as an argument.
19093 You can add characters before or after these, but there's no need to add
19097 \begin_layout Standard
19098 You can get really fancy with these.
19102 \begin_layout LyX-Code
19116 \begin_layout LyX-Code
19128 \begin_layout LyX-Code
19138 \begin_layout LyX-Code
19148 \begin_layout Standard
19149 produces the somewhat out of hand numbering scheme: <
19150 \begin_inset Quotes eld
19154 \begin_inset Quotes erd
19159 \begin_inset Quotes erd
19163 \begin_inset Quotes erd
19168 \begin_inset Quotes erd
19172 \begin_inset Quotes erd
19177 \begin_inset Quotes eld
19181 \begin_inset Quotes erd
19188 \begin_layout Standard
19192 \begin_layout Section
19196 \begin_layout Standard
19202 \begin_layout Standard
19203 \begin_inset VSpace bigskip
19209 \begin_layout Standard
19214 \begin_layout Standard
19220 tmpfont}{cmr17 scaled 2500}{
19232 \begin_layout Standard
19237 \begin_layout Standard
19248 hose of you who like the style of old books probably also like
19249 \begin_inset Quotes eld
19253 \begin_inset Quotes erd
19256 ---those large capital letters which begin each new chapter or section.
19257 Implementing them with plain LyX/LaTeX is straightforward (assuming you
19258 know some plain TeX!) but does require a lot of work and many iterations,
19259 as you can see by all the ugly TeX-mode stuff at the beginning of this
19263 \begin_layout Standard
19267 \begin_layout Standard
19273 bigdrop{-1em}{3}{ptmri}{T}+
19278 here is a much easier way of doing this, of course.
19287 ) package from CTAN allows a simple way to add such letters to your documents.
19288 Since this package is not a standard part of teTeX, I can't demonstrate
19289 it within this document, but if you copy this paragraph to a new document,
19291 \begin_inset Quotes eld
19301 \begin_inset Quotes erd
19304 and the pluses from the TeX code at the beginning of the paragraph, and
19309 usepackage{dropcaps}
19311 to your LaTeX preamble, you will get a nice Times Roman Italic
19312 \begin_inset Quotes eld
19316 \begin_inset Quotes erd
19319 , whose height is three lines of text and which protrudes 1 em into the
19321 (Make certain you have copied
19322 \begin_inset Quotes eld
19330 \begin_inset Quotes erd
19333 into a directory where TeX can see it.) The first argument is the amount
19334 of indentation; in this case the negative sign moves it into the margin.
19335 The second argument is the height of the letter in number of lines of text.
19336 The third argument is the font name: virtually anything which has a tfm
19337 file should work (wade through the
19339 .../texmf/fonts/tfm
19341 directory for possibilities).
19342 My personal favorite is
19343 \begin_inset Quotes eld
19351 \begin_inset Quotes erd
19354 , a fancy German font specifically designed for dropped capitals.
19355 The fourth argument is the letter (or letters) to be dropped.
19360 package also offers the
19366 command, as well as a slightly simplified
19375 \begin_layout Section
19376 Non-standard Paragraph Shapes
19379 \begin_layout Standard
19385 \begin_layout Standard
19386 \begin_inset VSpace bigskip
19392 \begin_layout Standard
19396 \begin_layout Standard
19408 \begin_layout Standard
19412 \begin_layout Standard
19421 \begin_layout Standard
19435 \begin_layout Standard
19440 \begin_layout Standard
19451 \begin_layout Standard
19460 \begin_layout Standard
19469 \begin_layout Standard
19478 \begin_layout Standard
19487 \begin_layout Standard
19496 \begin_layout Standard
19505 \begin_layout Standard
19514 \begin_layout Standard
19523 \begin_layout Standard
19532 \begin_layout Standard
19541 \begin_layout Standard
19550 \begin_layout Standard
19559 \begin_layout Standard
19568 \begin_layout Standard
19577 \begin_layout Standard
19586 \begin_layout Standard
19595 \begin_layout Standard
19604 \begin_layout Standard
19613 \begin_layout Standard
19619 There are times when the tyranny of rectangular paragraphs must be overthrown.
19620 In such situations, a call to the delightful plain TeX command
19627 As you can see, completely arbitrary shapes can be laid out with a suitable
19628 set of linelength definitions.
19629 While this parshape may look a bit silly and useless, one could conceive
19630 of situations such as finely tuned dropped capitals, word wrapping around
19631 non-rectangular graphics, etc.
19632 which will benefit from such handcrafting.
19635 \begin_layout Standard
19636 \begin_inset VSpace bigskip
19642 \begin_layout Standard
19647 parshape numlines #1indent #1length #2indent #2length \SpecialChar \ldots{}
19654 is the number of lines of text which define the paragraph.
19655 If there turn out to be fewer lines, the shape is truncated; if there are
19656 more, the excess lines have the same dimensions as the last line of the
19666 entries specify the indentation of the line from the left margin, and the
19667 length of the line as measured from that point.
19668 The shape applies only to the current paragraph; everything is reset to
19669 normal for the next paragraph.
19672 \begin_layout Standard
19676 \begin_layout Standard
19688 \begin_layout Section
19692 \begin_layout Standard
19693 As you can see, the examples in this section range from the useful to the
19695 While I don't expect that anyone will ever need the paragraph shape demonstrate
19696 d in the last section, the important point is that you can do almost anything
19697 you want in LyX if you are willing to figure out how to do it in TeX and
19699 TeX is a fantastically powerful typesetting system and all that power is
19700 available to you since LyX uses it as its backend.