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
55 \begin_layout Standard
57 Principal maintainer of this file is
62 If you have comments or error corrections, please send them to the LyX
63 Documentation mailing list, <lyx-docs@lists.lyx.org>.
71 \begin_layout Standard
72 \begin_inset LatexCommand tableofcontents
83 \begin_layout Standard
88 manual, which you are now reading, is essentially Part II of the
90 User's Guide\SpecialChar \@.
93 The reason for splitting this document is simple: the
97 is already huge, and it contains all of the basic features one needs to
98 know in order to prepare most documents.
99 However, the LyX Team has a long-term goal of making LyX extensible through
100 various configuration files and external packages.
101 That means that if you want to support the Fizzwizzle LaTeX package, you
102 can create a layout file for it without having to alter LyX itself.
103 We've already had contributions of several new features this way.
104 This is the place where all of that gets documented.
107 \begin_layout Standard
108 This manual also documents some special features, like fax support, version
109 control, and SGML support, which require additional software to work properly.
110 Lastly, there's a chapter of LaTeX tools and tips, things you can use to
111 spruce up your documents by directly using the powerful features of LaTeX.
116 only WYSIWYM, and will only ever interface to certain LaTeX features.
119 \begin_layout Standard
120 Of course, with all of this extra documentation,
122 Extended LyX Features
124 may itself grow too big for its britches.
125 In that case, you can just call it the
126 \begin_inset Quotes eld
130 \begin_inset Quotes erd
136 \begin_layout Standard
137 If you haven't read the
141 yet, you are definitely in the wrong manual.
146 is the first place to go, since it will direct you to the correct manual,
147 and it also describes the notation and format of all of the manuals.
148 You should also be thoroughly familiar with the
152 and all of the basic features of LyX.
156 \begin_layout Standard
157 In this document, many sections are independent articles contributed by
158 an individual and are noted as such.
159 This person is generally whoever wrote the layout file for the new document
160 class or LaTeX package, or implemented the feature.
161 If there is no mention of an author to a chapter [or chapter sections],
162 that means it was written by the LyX Documentation Team.
165 \begin_layout Standard
166 Since all the topics in this manual depend heavily on LyX's interaction
167 with LaTeX, this first chapter covers the inner workings of LyX and how
168 to direct LyX to generate exactly the LaTeX code you want.
169 It is obviously for more seasoned LyX users.
172 \begin_layout Chapter
176 \begin_layout Section
180 \begin_layout Standard
181 \begin_inset LatexCommand label
182 name "sec:lyxandlatex"
186 This chapter is for both TeX-nicians and the LaTeX-curious.
187 In it, we'll explain how LyX and LaTeX work together to produce printable
189 This is the only place in any of the manuals where we assume you know something
193 \begin_layout Standard
194 At one time, we called LyX a
195 \begin_inset Quotes eld
198 WYSIWYM frontend to LaTeX,
199 \begin_inset Quotes erd
202 but that's no longer true.
203 There are frontends to LaTeX out there.
204 They are basically editors with the ability to run LaTeX and mark any errors
205 in the file you're editing.
214 run LaTeX, and it also marks errors in the file, it also does much, much
216 Thanks to the WYSIWYM concept, you don't need LaTeX to use LyX effectively.
217 LyX has also added a few extensions to LaTeX.
218 Try the following sometime: select
220 Export\SpecialChar \menuseparator
230 menu, then look at the preamble of the resulting
235 You'll notice a variety of new macros defined specifically by LyX.
236 These macros are defined automatically, according to the features you use
240 \begin_layout Standard
241 There are several commands that automatically invoke LaTeX.
245 \begin_layout Itemize
251 iew\SpecialChar \menuseparator
258 \begin_layout Itemize
264 iew\SpecialChar \menuseparator
269 pdate\SpecialChar \menuseparator
275 \begin_layout Itemize
283 \SpecialChar \menuseparator
289 \begin_layout Itemize
297 \SpecialChar \menuseparator
303 \begin_layout Standard
304 They will only invoke LaTeX if the file has changed since the last time
309 \begin_layout Standard
310 When you run LaTeX on the file you're editing, LyX performs these steps:
313 \begin_layout Enumerate
314 Convert the document to LaTeX and save to a file with the extension
325 \begin_layout Enumerate
330 file (maybe several times).
333 \begin_layout Enumerate
334 If there are any errors, insert error boxes in the document to mark where
336 These boxes are transient and are not saved along with the document.
339 \begin_layout Standard
340 If you've run LaTeX using
362 , LyX performs two more steps:
365 \begin_layout Itemize
370 to convert the DVI file to PostScript:
374 \begin_layout Itemize
380 , the output file has the extension
385 \begin_layout Itemize
394 , the output file has the extension
402 \begin_layout Itemize
407 or send the PostScript file to the printer.
410 \begin_layout Section
411 \begin_inset Quotes eld
414 Help! LyX generated an unreadable
419 \begin_inset Quotes erd
425 \begin_layout Standard
426 Die-hard LaTeX users will scream and howl this into the night, then declare
427 LyX useless, simply because they didn't RTFM.
430 \begin_layout Standard
431 We're going to set the record straight.
432 LyX produces two kinds of LaTeX files.
433 One is human readable.
434 The other is LyX readable.
435 Every time LyX executes LaTeX, it produces a LaTeX file that it can easily
441 file is not human readable.
442 Don't even try to read it.
447 file that you can send to a colleague, select
452 xport\SpecialChar \menuseparator
469 \begin_layout Section
470 Translating LaTeX files into LyX
473 \begin_layout Standard
474 You can import a LaTeX file into LyX by using the
479 ile\SpecialChar \menuseparator
484 mport\SpecialChar \menuseparator
492 This will call a program named
496 ---which will create a file
504 ---and then open that file.
507 \begin_layout Standard
512 will translate most legal LaTeX, but not everything.
513 It will leave things it doesn't understand in TeX mode, so after translating
518 , you can look for red text and hand-edit it to look right.
521 \begin_layout Standard
522 If you just want to put a piece of LaTeX code into a LyX file, see Section
523 \begin_inset LatexCommand ref
524 reference "sec:latexcodes"
531 \begin_layout Section
532 Inserting LaTeX Code into LyX Documents
533 \begin_inset LatexCommand label
534 name "sec:Inserting-LaTeX-Code"
541 \begin_layout Standard
542 \begin_inset LatexCommand label
543 name "sec:latexcodes"
547 This is a rather important point: You can always insert LaTeX code into
549 LyX simply cannot, and will probably never be able to, display every possible
551 If ever you need to insert LaTeX commands into your LyX document, you can
552 use the ERT box, which you can insert into your document with
557 nsert\SpecialChar \menuseparator
565 The ERT box comes in three forms: collapsed, open, and inlined.
566 The first two are used just like any other collapsible (foldable) box (such
567 as footnotes), and are useful for significant amounts of LaTeX commands.
569 \begin_inset Quotes eld
573 \begin_inset Quotes erd
576 ERT box displays its content as part of the button, and is useful for very
577 short sections of LaTeX commands.
582 \begin_layout Standard
592 \begin_layout Standard
593 You can switch between all three by right-clicking on the ERT.
594 Note that if you want more than one line of LaTeX commands, you cannot
595 use the inlined mode.
598 \begin_layout Standard
599 Here's an example of inserting LaTeX commands in a LyX document.
600 The code looks like this:
603 \begin_layout LyX-Code
612 This is an example for a minipage environment.
615 can put nearly everything in it, even (non-floating)
658 \begin_layout LyX-Code
662 \begin_layout Standard
663 The ERT box containing this text is directly after this paragraph.
664 Those of you reading the manual online will only see a bunch of funky text
666 Those reading a printed version of the manuals will see the actual results:
669 \begin_layout Standard
673 \begin_layout Standard
680 \begin_layout Standard
687 \begin_layout Standard
689 This is an example for a minipage environment.
690 You can put nearly everything in it, even (non-floating) figures and tables.
694 \begin_layout Standard
701 \begin_layout Standard
706 \begin_layout Standard
713 \begin_layout Standard
720 \begin_layout Standard
727 \begin_layout Standard
733 \begin_layout Standard
740 \begin_layout Standard
747 \begin_layout Standard
754 \begin_layout Standard
766 \begin_layout Standard
767 In addition to these two methods, you can also create a separate file containing
768 some complex LaTeX structure.
774 nsert\SpecialChar \menuseparator
782 to include your file (you should select the type
787 We recommend that you only do this if you have a
796 Otherwise, you'll have a big job tracking down LaTeX errors\SpecialChar \ldots{}
800 \begin_layout Standard
801 There are a few last notes to emphasize:
804 \begin_layout Itemize
805 Inside of LyX, LaTeX code appears
810 \begin_layout Itemize
815 check if your LaTeX code is correct.
818 \begin_layout Itemize
819 Beware reinventing the wheel.
822 \begin_layout Standard
823 That last note refers to two things.
824 First, LyX does have quite a few features tucked into it, and more are
826 Be sure to check the manuals to make sure that LyX doesn't have such-and-such
827 feature before you go off merrily coding LaTeX.
828 Second, there are numerous LaTeX packages out there to do all sorts of
829 things, from labels to envelopes to fancy multipage tables.
830 Check out a CTAN site for details (see Section
831 \begin_inset Quotes eld
835 \begin_inset Quotes erd
846 \begin_layout Standard
851 : I seem to do this an awful lot.
852 Sat down and merrily began coding something to print out labels, only to
853 learn that there were already 2 different LaTeX packages to do this.
854 Worse yet --- I had them already!
862 \begin_layout Standard
863 If you do need to do some wild and fancy things within your document, be
864 sure to check out a good LaTeX book for assistance.
865 There are a number of them listed in the bibliography of the
872 \begin_layout Standard
873 There are a number of LaTeX commands which have to be placed before the
874 beginning of the actual text.
875 They go into the preamble, and this is explained in the next section.
878 \begin_layout Section
879 LyX and the LaTeX Preamble
882 \begin_layout Subsection
883 About the LaTeX Preamble
886 \begin_layout Standard
887 \begin_inset LatexCommand label
892 If you already know LaTeX, there is no need to explain here what the preamble
894 If you don't, the following will give you some ideas --- we recommend again
895 that you consult a LaTeX book for further information.
896 In any case, you should read the points below, because they explain what
897 you can do and what you don't need to do in the LaTeX preamble of a LyX
901 \begin_layout Standard
902 The LaTeX preamble comes at the very beginning of a document,
910 \begin_layout Itemize
911 declare the document class.
912 LyX already does this for you.
916 \begin_layout Standard
917 If you're a seasoned LaTeX-nician, and you have some custom document class
918 you want to use, check out the
922 for information on how to make LyX interface to it.
923 Be sure to submit your efforts to the LyX Team for inclusion in future
928 \begin_layout Itemize
929 declare the usage of packages.
930 LaTeX packages provide special commands, which are only available within
931 a document when the package has been declared in the preamble.
932 For example, the package
936 forces all paragraphs to be indented.
937 There are other packages for labels, envelopes, margins, etc.
941 \begin_layout Itemize
942 set counters, variables, lengths and widths.
943 There are several LaTeX counters and variables which
947 be set globally from within the preamble in order to have the desired effect.
948 [There are other variables which you can set and reset inside the document,
949 too.] Margins are a good example of something which must be set in the preamble.
950 Another example is the label format for lists.
951 You can actually set these just about anywhere, but it's best to do it
952 just once, inside the preamble.
955 \begin_layout Itemize
956 declare user defined commands [with
968 ], mostly abbreviations for LaTeX commands which appear very often inside
970 Although the preamble is a good place to declare such commands, they
974 be declared anywhere else [but
978 they are used for the first time, of course\SpecialChar \ldots{}
980 This can be useful if there is a lot of raw LaTeX code in your document,
981 which normally should not be the case.
984 \begin_layout Standard
985 LyX adds its own set of definitions to the preamble of the
990 This makes LaTeX files generated by LyX portable.
993 \begin_layout Subsection
994 Changing the Preamble
997 \begin_layout Standard
998 The commands which LyX adds to the preamble of a LaTeX file are fixed; you
999 can't change them without patching LyX itself.
1000 You can, however, add your own stuff to the preamble.
1001 There are two ways to do this:
1004 \begin_layout Enumerate
1031 \SpecialChar \menuseparator
1039 dialog, depending on your frontend.
1040 Note that the LyX keybindings will not work in this dialog, alas.
1043 \begin_layout Enumerate
1044 Use the preamble contents you've added as your default template (see
1045 \begin_inset Quotes eld
1049 \begin_inset Quotes erd
1056 ), so that it will be the default preamble for any file you create.
1059 \begin_layout Standard
1060 LyX adds anything in the
1067 dialog to its own built-in preamble.
1068 Before adding your own declarations in the preamble, you should make sure
1069 that LyX doesn't already support what you want to do (remember what we
1070 said about reinventing the wheel?).
1073 make sure your preamble code is correct
1076 LyX doesn't check it.
1079 \begin_layout Subsection
1083 \begin_layout Standard
1084 Here are some examples of what you can add to a preamble, and what they
1088 \begin_layout Subsubsection
1092 \begin_layout Standard
1093 There are two variables under LaTeX that control page position:
1106 Their names should be self-explanatory.
1107 These variables are useful if you think for a moment about computer labels.
1108 Sometimes, the size of a print medium and the area of the medium that you
1109 can actually print on aren't the same.
1125 \begin_layout Standard
1126 The default values for
1138 are both 0 pt.,\InsetSpace ~
1141 the page isn't shifted.
1144 \begin_layout Standard
1145 Unfortunately, some DVI drivers always seem to shift the page.
1146 We have no idea why, or why the sysadmin hasn't fixed such behavior.
1147 If you're using LyX on a system that you don't personally maintain, and
1148 your sysadmin is a doofus,
1161 Suppose you're left and top margins are always 0.5 inches too big.
1162 You can add this to the preamble:
1165 \begin_layout LyX-Code
1173 \begin_layout LyX-Code
1181 \begin_layout Standard
1182 \SpecialChar \ldots{}
1183 and your margins should now be correct.
1186 \begin_layout Subsubsection
1190 \begin_layout Standard
1191 Speaking of labels, suppose you wanted to print out a bunch of address labels.
1192 There's a rather nice package, available at your nearest CTAN archive,
1193 for printing sheets of labels, called
1198 Now, your system may not have this package installed by default.
1199 We leave that up to you to check.
1200 You'll also want to read the documentation for it; we're not going to do
1202 Since this is an example, however, we'll give you an example of how you
1206 \begin_layout Standard
1207 First, make sure you're using the
1212 Next, you need to put the following in your preamble:
1215 \begin_layout LyX-Code
1221 \begin_layout LyX-Code
1227 \begin_layout LyX-Code
1233 \begin_layout LyX-Code
1239 \begin_layout LyX-Code
1245 \begin_layout LyX-Code
1251 \begin_layout LyX-Code
1257 \begin_layout Standard
1258 This sets things up for Avery® label sheets, stock #5360.
1259 You're now ready to print labels, but you'll need to insert LaTeX code,
1260 placing the commands
1272 around each label text.
1273 This and other special features of
1277 are explained in its documentation.
1280 \begin_layout Standard
1281 Someday, someone may write a LyX layout file to support this package directly.
1282 Maybe that someone is you.
1285 \begin_layout Subsubsection
1286 Example #3: Paragraph Indentation
1289 \begin_layout Standard
1290 Americans are trained to indent the first line of
1295 As with all of their other weird quirks, most Americans will whine and
1296 moan until they can have their way and indent the first line of all paragraphs.
1300 \begin_layout Standard
1305 : This was written by an American ---
1309 ! It's my perception of my fellow countrymen.
1310 Tough if you don't like it.
1319 \begin_layout Standard
1320 Of course, this behavior isn't standard typography.
1321 In books, you typically only indent the first line of a paragraph
1325 it follows another one.
1326 The idea behind indenting the first line of a paragraph is to distinguish
1327 neighboring paragraphs from one another.
1328 If there is no previous paragraph, for example, it follows a figure, or
1329 is the first paragraph in a section, then there is no special indentation.
1333 \begin_layout Standard
1334 If you're a typical American, though, you don't care about such esoteric
1335 things; you want your indentation! Add this to the preamble:
1338 \begin_layout LyX-Code
1341 usepackage{indentfirst}
1344 \begin_layout Standard
1345 If your TeX distribution isn't a braindead one, you'll have this package,
1346 and all of your paragraphs will get the indentation you think they deserve.
1349 \begin_layout Subsubsection
1350 Example #4: This Document
1353 \begin_layout Standard
1354 You can also check out the preamble of this document to get an idea of some
1355 of the advanced things you can do.
1356 You'll probably need to make the
1361 reamble\SpecialChar \ldots{}
1364 dialog full-screen to see most of it.
1365 Also, there are more examples and an assortment of LaTeX
1366 \begin_inset Quotes eld
1370 \begin_inset Quotes erd
1373 given in Chapter\InsetSpace ~
1375 \begin_inset LatexCommand ref
1376 reference "cha:secrets"
1384 \begin_layout Section
1385 LyX and LaTeX Errors
1388 \begin_layout Standard
1389 When LyX calls LaTeX, it tells LaTeX to blithely ignore any errors and keep
1391 It then uses the log-file from the LaTeX run to do a post-mortem.
1392 As we stated earlier in the chapter, LyX generates two kinds of
1396 files, one of which it uses to locate errors in the document.
1397 If there was an error someplace, LyX will put a box with the word
1398 \begin_inset Quotes eld
1402 \begin_inset Quotes erd
1405 at the appropriate place in the document.
1409 \begin_layout Standard
1410 LyX will occasionally misguess where the error was.
1411 This will typically happen with tables, figures, math, and the preamble.
1416 It will also display a message alerting you to the fact that there were
1420 \begin_layout Standard
1421 You can navigate through the errors by using
1437 \begin_inset Quotes eld
1441 \begin_inset Quotes erd
1444 the error-boxes and view the error message LaTeX produced by clicking on
1448 \begin_layout Standard
1449 Some folks also like to look at the log file directly, accessible from
1454 ocument\SpecialChar \menuseparator
1464 There are some fairly common error messages and warnings.
1465 We'll cover those here.
1466 You should look at a good LaTeX book for a complete listing.
1469 \begin_layout Itemize
1470 \begin_inset Quotes eld
1478 \begin_inset Quotes eld
1485 \begin_layout Standard
1486 Anything beginning with these word is a warning message for the purpose
1488 \begin_inset Quotes eld
1492 \begin_inset Quotes erd
1495 the LaTeX code itself.
1496 You'll get messages like this if you added or changed cross-references
1497 or bibliography entries, in which case, LaTeX is trying to tell you that
1498 you need to make another run.
1501 \begin_layout Standard
1502 You can by-and-large ignore these.
1506 \begin_layout Itemize
1507 \begin_inset Quotes eld
1515 \begin_inset Quotes erd
1522 \begin_layout Standard
1523 Another warning message, this time about fonts which LaTeX couldn't find.
1524 The rest of the message will often say something about a replacement font
1528 \begin_layout Standard
1529 You can safely ignore these.
1533 \begin_layout Itemize
1534 \begin_inset Quotes eld
1544 \begin_inset Quotes erd
1551 \begin_layout Standard
1557 They are warning you about lines that were too long and run past the right
1559 Almost always, this is unnoticeable in the final output.
1560 Or, only one or two characters extend past the margin.
1561 LaTeX seems to generate at least one of these messages for just about any
1565 \begin_layout Standard
1566 You can ignore these stupid messages.
1567 Your eyes will tell you if there's a problem with something that's too
1568 wide; just look at the output.
1572 \begin_layout Itemize
1573 \begin_inset Quotes eld
1583 \begin_inset Quotes erd
1590 \begin_layout Standard
1591 Not quite as common as its cousin.
1592 LaTeX seems to like to print lines that are a bit too wide as opposed to
1593 ones that are a bit too narrow.
1594 We have no idea why.
1597 \begin_layout Standard
1598 You can ignore these, too.
1602 \begin_layout Itemize
1603 \begin_inset Quotes eld
1613 \begin_inset Quotes erd
1617 \begin_inset Quotes eld
1627 \begin_inset Quotes erd
1634 \begin_layout Standard
1635 Warnings about troubles breaking the page.
1636 Once again, just look at the output.
1637 Your eyes will tell you where something has gone wrong.
1641 \begin_layout Itemize
1642 \begin_inset Quotes eld
1648 \begin_inset Quotes els
1652 \begin_inset Quotes ers
1658 \begin_inset Quotes erd
1665 \begin_layout Standard
1667 \begin_inset Quotes eld
1671 \begin_inset Quotes erd
1674 isn't installed on this system.
1675 This usually appears because some package your document needs isn't installed.
1676 If you didn't touch the preamble or didn't use the
1682 command, then one of the packages LyX tried to load is missing.
1688 elp\SpecialChar \menuseparator
1695 , to get a list of packages that LyX knows about.
1696 This file is updated whenever you reconfigure LyX (using
1703 \SpecialChar \menuseparator
1708 ) and tells you which packages have been detected and what they do.
1711 \begin_layout Standard
1722 command, and the package in question isn't installed, you'll need to install
1727 \begin_layout Itemize
1728 \begin_inset Quotes eld
1733 LaTeX Error: Unknown option
1736 \begin_inset Quotes erd
1743 \begin_layout Standard
1744 Error messages beginning with this are trying to tell you that you specified
1745 a bad or undefined option to a package.
1746 Check the package's documentation.
1750 \begin_layout Itemize
1751 \begin_inset Quotes eld
1756 Undefined control sequence
1759 \begin_inset Quotes erd
1766 \begin_layout Standard
1767 If you've inserted LaTeX code into your document, but made a typo, you'll
1769 You may have forgotten to load a package.
1770 In any case, this error message usually means that you used an undefined
1775 \begin_layout Standard
1776 There are other error and warning messages.
1777 Some are self-explanatory.
1778 These are usually LaTeX messages.
1779 Others are downright cryptic.
1780 These are actually TeX error messages, and we really have
1784 what they mean or how to decipher them.
1787 \begin_layout Standard
1788 There's a general sequence you should follow if you get error messages:
1791 \begin_layout Enumerate
1792 Look at the LaTeX code you inserted for typos.
1795 \begin_layout Enumerate
1796 If there are no typos, check and see that you used the command(s) correctly.
1799 \begin_layout Enumerate
1800 If you get a bunch of error boxes piled up at the very top of the document,
1801 it means that there are errors in the preamble.
1802 Start debugging your preamble.
1805 \begin_layout Enumerate
1806 If you didn't add anything to the preamble and didn't add any LaTeX code
1807 to the document, the first suspect is your LaTeX distribution itself.
1808 Check for missing packages and install them.
1811 \begin_layout Enumerate
1812 Okay, so there are no missing packages.
1813 Did you use any of the fine-tuning options in LyX? Specifically, did you
1818 any of them, like trying to manually insert lots of
1820 Protected\InsetSpace ~
1831 s? Did you try to kludge something together with these instead of using
1832 the appropriate paragraph environment?
1835 \begin_layout Enumerate
1836 All right, you didn't use any of the fine-tuning options, you played by
1838 Did you try to pull a fancy maneuver? Did you do something funky inside
1839 a table or an equation, like inserting a graphic into a table cell?
1842 \begin_layout Enumerate
1843 Do you have long sections of text where LaTeX cannot find a place to break
1844 a line? By default, LaTeX is rather strict about how much extra inter-word
1845 spacing it will add in order to break a line.
1846 Preferably, you should rework the paragraph to avoid the problem.
1847 If this isn't an option, you can wrap your text in
1853 to make LaTeX's line breaking more, well, sloppy.
1856 \begin_layout Enumerate
1857 Did you go overboard with the nesting? LyX (currently) doesn't check to
1858 make sure you're in the limits for nesting environments.
1859 If you nested a bunch of environments to the
1860 \begin_inset Formula $17^{\mathrm{th}}$
1863 level, that's the problem.
1866 \begin_layout Enumerate
1867 Okay, you didn't get any error messages, but your output looks whacked.
1868 If you have a table or figure that's too wide or long for the page, you
1873 \begin_layout Enumerate
1874 rescale the figure so it fits.
1877 \begin_layout Enumerate
1878 trim down the table so it fits.
1881 \begin_layout Standard
1882 If something else is wrong with the output, and you didn't try to pull anything
1883 fancy or kludge the fine-tuning options, we're not sure what's wrong.
1887 \begin_layout Standard
1888 If all this doesn't help --- well, then
1892 you might have found a bug in LyX\SpecialChar \ldots{}
1896 \begin_layout Chapter
1900 \begin_layout Section
1901 Preparing a Bibliography with BibTeX
1902 \begin_inset LatexCommand label
1903 name "sec:Preparing-a-Bibliography"
1910 \begin_layout Standard
1917 Jürgen Spitzmüller
1920 \begin_layout Standard
1921 \begin_inset VSpace bigskip
1927 \begin_layout Standard
1929 STOP! If you don't know what BibTeX is, or have a reasonably good idea of
1932 e.\InsetSpace \thinspace{}
1936 setting up your own bibliographic databases),
1940 , do not walk, to your nearest copy of the 2nd edition of Lamport's
1942 LaTeX: A Document Preparation System
1944 , particularly Appendix B.
1945 The rest of this discussion assumes you have created a correct bibliography
1946 file, that you have all relevant environment variables set correctly (esp.
1959 ), and that if sufficiently desperate, you could create and
1960 \begin_inset Quotes eld
1964 \begin_inset Quotes erd
1967 a LaTeX file with a BibTeX database.
1971 \begin_layout Standard
1972 For those who don't know what BibTeX is, it is a system for creating a large
1973 database of your most used journal references.
1974 For all future articles you write, you only need to include this standard
1975 database and reference the appropriate key to each reference.
1976 Even if you write only a few papers with handful of references each, it
1977 is well worth your time to examine BibTeX and decide whether it will be
1981 \begin_layout Standard
1982 To use BibTeX with LyX, first read the
1986 where it describes how to insert citations.
1987 The basic mechanism for inserting BibTeX references is the same.
1988 Then, at the very end of your document, select
1990 Insert\SpecialChar \menuseparator
1995 TOC\SpecialChar \menuseparator
1999 In the resulting dialog, fill out the dialog boxes as follows:
2002 \begin_layout Description
2003 Database: enter the name of your
2016 For searching multiple
2020 files, just enter them in the desired order, separated by commas.
2024 \begin_layout Description
2025 Style: enter the name of your BibTeX style file *without* the
2030 The default style is
2034 (which should be included in your LaTeX distribution, so you don't have
2035 to worry about creating it).
2038 \begin_layout Standard
2039 For each citation, assuming that the source is in the
2048 nsert\SpecialChar \menuseparator
2055 at the correct location in the text, and enter the appropriate reference
2057 Nothing else is required; when invoking
2062 iew\SpecialChar \menuseparator
2069 , for example, you should see that BibTeX and LaTeX are invoked as needed,
2070 including multiple invocations of LaTeX.
2074 \begin_layout Subsection
2075 Alternative Citation Styles
2078 \begin_layout Standard
2079 Standard BibTeX uses numbers (e.\InsetSpace \thinspace{}
2080 g.\InsetSpace \space{}
2082 \begin_inset Quotes eld
2086 \begin_inset Quotes erd
2089 ) to refer to a cited work.
2090 However, in many scientific disciplines, other citation styles are in use.
2091 The most common one is the author-year style (e.\InsetSpace \thinspace{}
2092 g.\InsetSpace \space{}
2094 \begin_inset Quotes eld
2098 \begin_inset Quotes erd
2102 LyX supports two packages that provide this style,
2111 Both packages have their own pros and cons, which cannot be listed in detail.
2112 If you only want to have simple author-year (or author-numerical) style
2113 or if you want to use one of the countless style files for natbib, than
2118 package is probably your choice.
2119 If you need special features like short title references, ibidem etc., you
2120 might consider the fairly new
2127 \begin_layout Standard
2128 The handling of both packages in LyX is basically the same.
2134 ocument\SpecialChar \menuseparator
2145 pane (with the xforms frontend: the
2159 With both packages, you will get some extra features in the citation dialog
2160 and you can select the style of the reference (
2161 \begin_inset Quotes eld
2165 \begin_inset Quotes erd
2169 \begin_inset Quotes eld
2173 \begin_inset Quotes erd
2177 \begin_inset Quotes eld
2181 \begin_inset Quotes erd
2185 \begin_inset Quotes eld
2189 \begin_inset Quotes erd
2193 Note that both packages need specifically designed style files (they both
2194 ship their own, while there are lots of additional style files and even
2195 an interactive style file builder
2199 \begin_layout Standard
2201 \begin_inset LatexCommand url
2202 target "ftp://ctan.tug.org/tex-archive/macros/latex/contrib/custom-bib/"
2218 \begin_layout Subsection
2219 Sectionated Bibliographies
2220 \begin_inset LatexCommand label
2221 name "sub:Sectionated-Bibliographies"
2228 \begin_layout Standard
2229 Sometimes you might need to divide your bibliography into several sections.
2230 If you are, for instance, a historian, the possibility to separate sources
2231 and scientific works is most likely a
2232 \begin_inset Quotes eld
2236 \begin_inset Quotes erd
2240 Unfortunately, BibTeX itself does not allow you to do this.
2241 The good news is, though: With the help of some LaTeX packages, BibTeX
2242 can be extended to fit your historical needs.
2245 \begin_layout Standard
2246 As of version 1.4, LyX provides native support for one of these packages,
2255 \begin_layout Standard
2257 \begin_inset LatexCommand url
2258 target "ftp://ctan.tug.org/tex-archive/macros/latex/contrib/bibtopic/"
2267 The advantage of this package (compared to other packages like
2271 ) is that you don't need to define new citation commands.
2272 Instead, you need to prepare different bibliographic databases which include
2273 the entries for the different sections of the bibliography.
2274 For example: If you want to divide your bibliography into the sections
2276 \begin_inset Quotes eld
2280 \begin_inset Quotes erd
2284 \begin_inset Quotes eld
2288 \begin_inset Quotes erd
2291 , you first need to create two bibliographic databases, e.\InsetSpace \thinspace{}
2292 g.\InsetSpace \space{}
2305 \begin_layout Standard
2311 ocument\SpecialChar \menuseparator
2322 pane (with the xforms frontend: the
2329 Sectionated\InsetSpace ~
2333 Now you can insert multiple BibTeX references (as described in section\InsetSpace ~
2335 \begin_inset LatexCommand ref
2336 reference "sec:Preparing-a-Bibliography"
2340 ), one for each section of your bibliography.
2341 Returning to our example: Insert a BibTeX reference for the database
2345 and a second one for the database
2350 You are free to use the same or different styles for each section.
2351 Additionally, you can chose if the bibliography section should contain
2353 \begin_inset Quotes eld
2356 all cited references
2357 \begin_inset Quotes erd
2360 of the specified database(s) (which is the default),
2361 \begin_inset Quotes eld
2364 all uncited references
2365 \begin_inset Quotes erd
2369 \begin_inset Quotes eld
2373 \begin_inset Quotes erd
2377 This might be useful if you would like to separate your bibliography into
2379 \begin_inset Quotes eld
2383 \begin_inset Quotes erd
2387 \begin_inset Quotes eld
2391 \begin_inset Quotes erd
2395 \begin_inset Quotes eld
2399 \begin_inset Quotes erd
2403 The titles for the sections can be added as ordinary sections or subsections.
2408 removes the bibliography title, you have manually re-add that, too (as
2409 a chapter* or section*, for instance).
2412 \begin_layout Subsection
2413 Multiple Bibliographies
2416 \begin_layout Standard
2417 Multiple bibliographies, e.\InsetSpace \thinspace{}
2418 g.\InsetSpace \space{}
2419 a bibliography for each section or chapter of
2420 the document, are not supported by BibTeX itself.
2425 package, which is used for the creation of sectionated bibliographies in
2426 LyX (cf.\InsetSpace ~
2427 section\InsetSpace ~
2429 \begin_inset LatexCommand ref
2430 reference "sub:Sectionated-Bibliographies"
2434 ), provides an easy way to solve this task, if you are willing to use some
2435 LaTeX-Code (ERT, cf.\InsetSpace ~
2436 section\InsetSpace ~
2438 \begin_inset LatexCommand ref
2439 reference "sec:Inserting-LaTeX-Code"
2447 \begin_layout Standard
2448 An alternative approach is to use the
2456 package, respectively.
2464 \begin_layout Standard
2470 ocument\SpecialChar \menuseparator
2481 pane (with the xforms frontend: the
2488 Sectionated\InsetSpace ~
2492 In the document, you have to enclose the sections, which shall contain
2493 their own bibliography (including the BibTeX reference itself), between
2506 (those commands have to be inserted as ERT).
2507 The bibliography will contain all references which have been cited in the
2509 N.\InsetSpace \thinspace{}
2510 B.: If you are using this approach, then
2514 citation reference has to be inside some btUnit.
2515 Also, the btUnits cannot be nested.
2518 \begin_layout Section
2522 \begin_layout Standard
2523 A good index is one of the hardest things to make in a lengthy document,
2524 but LyX helps make things a bit simpler by interfacing to the
2528 program which is found in most recent LaTeX distributions.
2532 \begin_layout Standard
2552 Outputs\SpecialChar \menuseparator
2553 LaT\SpecialChar \textcompwordmark{}
2562 section of the preferences dialog, however, you can customize the index
2563 command, if you prefer an alternative program like
2586 Inserting an index and marking words to include in it works much the same
2587 way as preparing a bibliography as mentioned in the last section.
2590 \begin_layout Standard
2591 First, go to the end of your file and select
2596 nsert\SpecialChar \menuseparator
2607 C\SpecialChar \menuseparator
2620 Then, for each word you would like to include in the index, go to the end
2621 of that word and click on
2626 nsert\SpecialChar \menuseparator
2639 This will insert a tag showing the word as it will appear in the index.
2640 That's all there is to it; LyX will automatically call
2644 for you and create the index itself.
2645 The text in the dialog available from right-clicking on the index button
2646 accepts LaTeX, so you'll need to be careful to avoid using any special
2648 On the positive side, you can use the advanced options - have a look at
2649 the documentation which comes with your LaTeX distribution to find out
2650 how to do things like
2651 \begin_inset Quotes eld
2655 \begin_inset Quotes erd
2661 \begin_layout Standard
2662 Be careful not to put spaces between the word in the text and the index
2663 marker; apparently the wrong page number can be produced if this happens.
2666 \begin_layout Section
2670 \begin_layout Standard
2673 Özgür Ug̃raş Baran
2676 \begin_layout Standard
2677 Sometimes you need to compile a list of symbols that are mentioned in your
2678 document with a brief explanation of them.
2679 A LaTeX package named
2683 provides an easy way of compiling such lists.
2688 is included in most standard Linux distributions.
2689 If your distribution doesn't contain it, you should download it from a
2690 CTAN mirror and install the package in order to use this feature of LyX.
2693 \begin_layout Standard
2694 A glossary entry is created if you place the cursor after a symbol entry
2695 and then use the menu
2697 Insert\SpecialChar \menuseparator
2698 Glossary\InsetSpace ~
2703 \begin_inset Quotes eld
2711 \begin_inset Quotes erd
2714 is inserted and a window pops up asking for the glossary entry.
2715 A glossary entry consists of two main entries.
2716 The first is the symbol that you want to refer to.
2717 You should enter a valid LaTeX code for the corresponding field in the
2719 The second is the description of the symbol.
2720 You should fill the corresponding field to complete the glossary entry.
2723 \begin_layout Subsection
2724 Sort Order of Glossary Entries
2727 \begin_layout Standard
2728 Suppose you have two glossary entries for the symbols
2729 \begin_inset Formula $a$
2733 \begin_inset Formula $\sigma$
2741 package automatically sorts these two entries considering the symbol entry,
2742 while printing the Glossary.
2743 However, this can lead to an undesired sort order.
2744 For the example given, the first entry appears as
2748 , while the second is
2755 Note that, in this case
2756 \begin_inset Formula $\sigma$
2759 is located in front of the
2760 \begin_inset Formula $a$
2763 , since the character
2764 \begin_inset Quotes eld
2770 \begin_inset Quotes erd
2773 is considered in sorting.
2774 In order to control the sort order, you can edit the
2779 field of the glossary dialog.
2780 For the given example, you can edit this field as
2789 Then, these entries will be effective in the sort ordering and
2790 \begin_inset Formula $a$
2793 will be located before
2794 \begin_inset Formula $\sigma$
2800 \begin_layout Standard
2801 This feature provides exciting ways of ordering the entries.
2802 For subgrouping and tips for using sort entries see the official nomencl
2806 \begin_layout Subsection
2810 \begin_layout Standard
2811 You can turn on referencing to the equations and pages in the glossary entries.
2812 For this purpose, you should add referencing options commands at the end
2813 of description field.
2814 There are six referencing options in nomencl package:
2817 \begin_layout Paragraph*
2823 \begin_layout Standard
2824 Adds reference to the equation by adding the phrase
2825 \begin_inset Quotes eld
2829 \begin_inset Quotes erd
2835 \begin_layout Paragraph*
2841 \begin_layout Standard
2842 Adds reference to the page by adding the phrase
2843 \begin_inset Quotes eld
2847 \begin_inset Quotes erd
2853 \begin_layout Paragraph*
2859 \begin_layout Standard
2860 Is the short notation of
2867 \begin_layout Paragraph*
2877 \begin_layout Standard
2878 Turns off corresponding referencing options if they are turned on globally
2879 (see reference documentation of nomencl).
2882 \begin_layout Subsection
2886 \begin_layout Standard
2887 You can insert the glossary with the menu
2889 Insert\SpecialChar \menuseparator
2891 &TOC\SpecialChar \menuseparator
2895 A light blue box labeled
2896 \begin_inset Quotes eld
2904 \begin_inset Quotes erd
2907 will show the place where the index is printed in the output.
2908 The index list box is not clickable like other LyX-boxes.
2909 In the printed output the title of the glossary appears as
2917 \begin_layout Standard
2918 This is translated to the document language for a small number of languages,
2919 amongst others French and German
2925 If you are not happy with the title, you can change it by re-defining the
2933 For example, in order to change the title
2941 add the following line to the preamble.
2944 \begin_layout LyX-Code
2949 nomname}{List of Symbols}
2952 \begin_layout Standard
2953 If you're unhappy with the amount of space for symbols, you can alter it
2954 by adding following line to the preamble.
2957 \begin_layout LyX-Code
2962 nomlabelwidth}{3.0cm}
2965 \begin_layout Section
2969 \begin_layout Subsection
2973 \begin_layout Standard
2974 When you are working on a large file with many sections, it is often convenient
2975 to break up the document into several files, or perhaps you have something
2976 where a table may change from time to time, but the preceding text does
2978 In these cases, you should seriously consider using multipart documents.
2979 For example, scientific papers often have five major sections: the introduction
2980 , observations, results, discussion, and conclusion.
2981 Each of these could be its own separate LyX file, with one
2982 \begin_inset Quotes eld
2986 \begin_inset Quotes erd
2989 file which contains the title, authors, abstract, references, etc., plus
2990 the five included files.
2991 It is important to note that each of these files is a full LyX file which
2992 can be formatted and printed on its own, as well as included in a master
2994 Each of these files must have the same document class, however--- don't
2995 attempt to mix book classes with article classes.
2996 You may also include LaTeX files; however, these files must not have their
3002 everything up to and including the
3014 line must be deleted) or else errors will be generated when you try to
3018 \begin_layout Standard
3019 LyX allows you to include files quite easily with
3024 nsert\SpecialChar \menuseparator
3033 When you click on this selection a small box is inserted into the file
3034 at the current cursor location.
3035 Clicking on the box raises a dialog which allows you to select the file
3036 to be included, and the method of its inclusion.
3040 \begin_layout Standard
3041 The file selection box should by now be obvious.
3042 The three inclusion methods are
3043 \begin_inset Quotes eld
3047 \begin_inset Quotes erd
3051 \begin_inset Quotes eld
3055 \begin_inset Quotes erd
3059 \begin_inset Quotes eld
3063 \begin_inset Quotes erd
3067 The difference between
3068 \begin_inset Quotes eld
3072 \begin_inset Quotes erd
3076 \begin_inset Quotes eld
3080 \begin_inset Quotes erd
3083 is really only meaningful to LaTeXperts, but the practical difference is
3084 that files which are
3085 \begin_inset Quotes eld
3089 \begin_inset Quotes erd
3092 are typeset beginning on a new page, while files which are
3093 \begin_inset Quotes eld
3097 \begin_inset Quotes erd
3100 are typeset starting on the current page.
3101 Perhaps the labeling in LyX will be changed someday to reflect this.
3104 \begin_layout Standard
3105 Generally, the master file is converted into a full LaTeX file before typesettin
3106 g, while the included files are converted to LaTeX files which do not have
3107 all the preamble information.
3117 button prevents this conversion.
3120 \begin_layout Standard
3122 \begin_inset Quotes eld
3126 \begin_inset Quotes erd
3129 included file allows you to include a file typeset exactly as it appears
3130 in the file, i.e.\InsetSpace ~
3131 verbatim mode, with the characters set in a fixed-width
3133 Normally, spaces in this file are invisible, though two consecutive spaces
3134 are conserved, unlike LyX's normal treatment of spaces.
3135 However, setting the
3145 checkbox typesets a mark to unambiguously define the presence of a space.
3149 \begin_layout Subsection
3150 Cross-References Between Files
3153 \begin_layout Standard
3154 It is possible to set up cross-references between the different files.
3155 First, open all the files in question: let's call them A and B in a two
3156 file example, where B is included in A.
3157 Let's say you insert a label in A, then want to reference it in B.
3158 Open the cross-reference dialog in whilst in document B, and you can select
3160 \begin_inset Quotes eld
3164 \begin_inset Quotes erd
3170 \begin_layout Section
3171 Fancy Headers and Footers
3174 \begin_layout Standard
3175 The default page layout is rather plain; for an article document class,
3176 all you get is a centered page number at the bottom of the page.
3177 This document is the book class, so it appears to be a bit fancier, but
3178 to really put on a show, you need to set the document page style to
3179 \begin_inset Quotes eld
3183 \begin_inset Quotes erd
3186 , as mentioned in the
3192 This section describes the LaTeX codes you need to insert in your LaTeX
3193 preamble or the text in order to get the desired effects.
3196 \begin_layout Standard
3197 The page header is divided into three fields, not surprisingly labeled
3198 \begin_inset Quotes eld
3202 \begin_inset Quotes erd
3206 \begin_inset Quotes eld
3210 \begin_inset Quotes erd
3214 \begin_inset Quotes eld
3218 \begin_inset Quotes erd
3222 The footer is also divided into these three fields.
3223 The LaTeX commands to set these fields in the simplest manner are
3248 Suppose you wish to put your name in the upper left hand corner of each
3250 Simply insert the following command in the preamble:
3253 \begin_layout Standard
3262 \begin_layout Standard
3263 You will now see your name in the upper left.
3264 If a field has a default entry that you would like to get rid of (often
3265 the page number appears in the central footer, simply include a command
3266 with a blank argument, e.\InsetSpace \thinspace{}
3270 \begin_layout Standard
3278 \begin_layout Standard
3279 Let's get really fancy: lets put the section number with the word
3280 \begin_inset Quotes eld
3284 \begin_inset Quotes erd
3287 (e.\InsetSpace \thinspace{}
3289 Section 3) in the upper left, the page number (e.\InsetSpace \thinspace{}
3291 Page 4) in the upper
3292 right, your name in the lower left, and the date in the lower right.
3293 The following commands should now appear in the preamble:
3296 \begin_layout Standard
3306 \begin_layout Standard
3314 \begin_layout Standard
3324 \begin_layout Standard
3333 \begin_layout Standard
3341 \begin_layout Standard
3351 \begin_layout Standard
3364 access LaTeX's section and page counters, and so print out the current
3365 section and page numbers.
3372 simply prints out today's date.
3375 \begin_layout Standard
3376 The thicknesses of the horizontal rules drawn beneath the header and above
3377 the footer can also be modified.
3378 If you don't want one of the headers, set its thickness to 0.
3379 The header rule has a default thickness of 0.4pt, the footer rule is 0pt.
3380 Use the commands, e.\InsetSpace \thinspace{}
3388 headrulewidth}{0.4pt}
3396 footrulewidth}{0.4pt}
3398 to set the thicknesses.
3401 \begin_layout Standard
3402 You can switch the header/footer settings on and off for individual pages
3407 thispagestyle{empty}
3413 thispagestyle{plain}
3419 thispagestyle{fancy}
3422 Simply insert them in the text on the page you want changed and mark them
3424 In fact, title pages are marked as plain by default, while following pages
3425 are marked fancy when using the global fancy setting.
3428 \begin_layout Standard
3429 There are more complex commands which will let you insert things in the
3430 upper left on odd numbered pages, etc., but I will refer you to the
3434 package documentation for more descriptions.
3435 For example, if you have a teTeX installation, look for
3437 /usr/share/texmf/doc/latex/fancyhdr/\SpecialChar \-
3443 \begin_layout Standard
3444 As a final example, it is possible to include an Encapsulated PostScript
3445 file in the header or footer.
3446 Suppose you want to put a company logo in the upper lefthand corner.
3447 You might try something like
3450 \begin_layout Standard
3459 includegraphics{logo.eps}}}
3462 \begin_layout Standard
3464 (you may need to preface this with
3468 usepackage{graphics}
3470 if you don't include EPS files elsewhere in your document).
3473 \begin_layout Section
3474 Itemize Bullet Selection
3475 \begin_inset LatexCommand label
3483 \begin_layout Standard
3489 \begin_layout Subsection
3493 \begin_layout Standard
3494 LyX provides 216 bullet shapes that can be accessed from a simple dialog.
3495 Using this dialog you can easily specify what bullet shape to use at each
3496 level of an itemized list.
3497 These settings are document-wide so you won't be able to specify different
3498 sets of bullets for different paragraphs
3502 \begin_layout Standard
3503 Well, actually you can but you'll have to do it by hand.
3511 \begin_layout Subsection
3515 \begin_layout Standard
3516 Open the dialog by selecting the
3521 ocument\SpecialChar \menuseparator
3528 menu item and then select the
3538 \begin_layout Standard
3539 The dialog provides you with a table of bullet shapes.
3540 A column of buttons on the left of the table provides access to the six
3541 different panels of bullet shapes.
3542 The row of buttons across the top is used to select which bullet depth
3544 A text entry under the table shows the currently selected bullet shape's
3545 LaTeX equivalent and this can be edited if desired.
3546 If you do modify the text you will also need to specify any needed packages
3547 in the LaTeX preamble.
3550 \begin_layout Standard
3551 The six panels are divided up by the packages they require.
3552 The following table shows the mappings from button name to LaTeX packages.
3555 \begin_layout Standard
3557 \begin_inset Tabular
3558 <lyxtabular version="3" rows="7" columns="2">
3560 <column alignment="center" valignment="top" leftline="true" width="0pt">
3561 <column alignment="center" valignment="top" leftline="true" rightline="true" width="0pt">
3562 <row topline="true" bottomline="true">
3563 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
3566 \begin_layout Standard
3581 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
3584 \begin_layout Standard
3600 <row topline="true">
3601 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
3604 \begin_layout Standard
3619 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
3622 \begin_layout Standard
3637 <row topline="true">
3638 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
3641 \begin_layout Standard
3656 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
3659 \begin_layout Standard
3675 <row topline="true">
3676 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
3679 \begin_layout Standard
3694 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
3697 \begin_layout Standard
3713 <row topline="true">
3714 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
3717 \begin_layout Standard
3732 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
3735 \begin_layout Standard
3751 <row topline="true">
3752 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
3755 \begin_layout Standard
3770 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
3773 \begin_layout Standard
3789 <row topline="true" bottomline="true">
3790 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
3793 \begin_layout Standard
3808 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
3811 \begin_layout Standard
3834 \begin_layout Standard
3835 LyX doesn't stop you using bullets from packages you don't have.
3836 If you get errors from LaTeX when you try to view or print the file then
3837 its likely you are missing a package.
3838 LyX doesn't restrict your use since you may be editing locally and exporting
3842 \begin_layout Subsection
3846 \begin_layout Standard
3847 Select which bullet depth you want to change then select the bullet shape
3849 Any changes will not be visible in LyX, but are visible when viewing the
3850 document using xdvi or ghostview.
3853 \begin_layout Standard
3854 You can reset a bullet shape to the default simply by clicking your right
3855 mouse button on the appropriate bullet depth button.
3858 \begin_layout Standard
3863 want to have multiple sets of paragraphs with different sets of bullets
3864 in each then you're going to have to get your hands dirty.
3865 The itemize bullet selection dialog can help though because it provides
3866 you with the LaTeX code for a wide range of bullet shapes.
3867 To make your own custom paragraphs you have the following options:
3870 \begin_layout Standard
3874 \begin_layout Standard
3890 \begin_layout Standard
3894 \begin_layout Standard
3916 \begin_layout Itemize
3917 Use the LaTeX command
3923 to specify a new bullet shape for a given depth.
3924 You'll also need to save the current bullet shape so you can restore it
3926 In this itemized list the following LaTeX code was used to change the bullet
3927 used for the first depth.
3959 Note that the itemize depth is specified in Roman numerals as part of the
3969 \begin_layout Itemize
3973 \begin_layout Standard
3986 Specify each individual entry by starting each item with the bullet shape
3987 enclosed in square brackets and set as TeX.
3988 For example, this item was started with
4001 \begin_layout Standard
4005 \begin_layout Standard
4021 \begin_layout Standard
4022 You'll also need to revert the labelitem back to its previous setting for
4023 the global bullet shape settings to remain in effect.
4024 The way used here was:
4037 \begin_layout Chapter
4038 Special Document Classes
4041 \begin_layout Section
4045 \begin_layout Standard
4051 \begin_layout Standard
4052 \begin_inset VSpace bigskip
4058 \begin_layout Standard
4060 The AMS LaTeX layouts are set up to conform to suggested styles for mathematical
4061 papers to be submitted to American Mathematical Society publications.
4062 The layouts are not tailored to a specific journal, but easily can be.
4063 You should refer to the AMS documentation for specific instructions for
4064 each journal (usually it will entail only changing a single line in the
4066 That documentation is available on the Web at
4067 \begin_inset LatexCommand url
4068 target "http://www.ams.org"
4073 \begin_inset LatexCommand url
4074 target "ftp://ftp.ams.org/pub/tex/amslatex/"
4078 .These layouts are appropriate, and useful, for any mathematical writing.
4079 There are currently 4 distinct AMS LaTeX layouts:
4082 \begin_layout Enumerate
4083 amsart: The standard AMS-article format.
4084 All results and similar statements are numbered as
4085 \begin_inset Formula $(n.m)$
4088 , where the first number refers to the section, and the second refers to
4089 the total number of results (Theorems, Corollaries, Propositions, Definitions
4090 and Remarks, etc.) in that section.
4091 There are also many (but not all) environments available unnumbered, which
4092 is occasionally needed.
4093 Unnumbered environments indicated by an asterisk at the end.
4096 \begin_layout Enumerate
4097 amsart-seq: Here, numbering for each type of statement is in its own sequence,
4098 with no reference to the section number.
4099 There are also many (but not all) environments available unnumbered, which
4100 is occasionally needed.
4101 Unnumbered environments indicated by an asterisk at the end.
4104 \begin_layout Enumerate
4105 amsart-plain: This one is even more terse, since all the environments are
4109 \begin_layout Enumerate
4110 amsbook: the standard AMS book (really, monograph) format.
4111 Numbering is similar to the amsart layout, except that all numbering is
4113 \begin_inset Formula $(n.m.p)$
4116 , where the first number refers to the chapter, the second to the section,
4117 and the third is the number of the results (Theorems, Corollaries, Propositions
4118 , Definitions and Remarks, etc.) in that section.
4119 There are also many (but not all) environments available unnumbered, which
4120 is occasionally needed.
4121 Unnumbered environments indicated by an asterisk at the end.
4124 \begin_layout Standard
4125 Any AMS LyX file can be converted to either of the numbering schemes by
4126 simply changing the document class in the
4131 ocument\SpecialChar \menuseparator
4142 \begin_layout Subsection
4143 What these layouts provide
4146 \begin_layout Standard
4147 There is a long list of included environments provided by these layouts.
4148 Most mathematical papers or books will set as special statements most of
4149 these environments, in AMS-LaTeX there is an opportunity to define an unlimited
4150 variety of such declarations.
4151 However, the AMS recommends the environments that are available in LyX.
4152 The list of environments (not counting the standard environments such as
4155 sections, bibliography, title, author, date
4160 \begin_layout Description
4161 Theorem This is typically used for the statements of major results.
4163 \begin_inset Quotes eld
4171 \begin_inset Quotes erd
4174 appears in bold type, along with an automatically-determined number (an
4179 , is also available).
4180 The text is italicized.
4183 \begin_layout Description
4184 Corollary This is used for statements which follow fairly directly from
4185 previous statements.
4186 Again, these can be major results.
4194 \begin_layout Description
4195 Lemma These are smaller results needed to prove other statements.
4198 \begin_layout Description
4199 Proposition These are less major results which (hopefully) add to the general
4200 theory being discussed.
4203 \begin_layout Description
4204 Conjecture These are statements provided without justification, which the
4205 author does not know how to prove, but which seem to be true (to the author,
4209 \begin_layout Description
4210 Criterion A required condition.
4213 \begin_layout Description
4214 Algorithm A general procedure to be used.
4217 \begin_layout Description
4218 Axiom This is a property or statement taken as true within the system being
4222 \begin_layout Description
4223 Definition Guess what this is for.
4224 The font, both on-screen and in the output, is different for this environment
4225 than for the previous ones.
4227 \begin_inset Quotes eld
4231 \begin_inset Quotes erd
4234 ) is still set in boldface, along with the number, if any, but the rest
4238 \begin_layout Description
4239 Example Typeset similarly to Definition.
4242 \begin_layout Description
4246 \begin_layout Description
4250 \begin_layout Description
4254 \begin_layout Description
4255 Remark This environment is also a new type of theorem.
4256 This is set with the word Remark in italics, and the rest upright.
4259 \begin_layout Description
4260 Note Set similarly to the Remark environment.
4263 \begin_layout Description
4267 \begin_layout Description
4271 \begin_layout Description
4275 \begin_layout Description
4279 \begin_layout Description
4280 Case Generally, these are used to break up long arguments, using specific
4281 instances of some condition.
4282 The numbering scheme for cases is on its own, not together with other numbered
4287 \begin_layout Description
4291 \begin_layout Description
4295 \begin_layout Description
4297 \begin_inset Quotes eld
4305 \begin_inset Quotes erd
4308 is set in italics, but the rest is set upright.
4309 At the end of this environment (other environments can be nested within
4310 this one, of course) a QED symbol (usually a square, but it can vary with
4311 different styles) is placed.
4314 \begin_layout Description
4315 Address This should be the author's permanent address.
4318 \begin_layout Description
4319 Current\InsetSpace ~
4320 Address This should be the author's temporary address at the time
4321 of submission, if different from the Address.
4324 \begin_layout Description
4325 Email Author's e-mail address
4328 \begin_layout Description
4329 URL Author's Web address, if desired.
4332 \begin_layout Description
4333 Keywords Key words or phrases used to identify specific topics discussed
4337 \begin_layout Description
4338 Subjectclass These refer to the AMS Subject Classifications, published and
4341 Mathematical Reviews
4344 These are also available online at the AMS cites listed above.
4347 \begin_layout Description
4351 \begin_layout Description
4355 \begin_layout Description
4359 \begin_layout Standard
4360 In addition, these environments automatically provide the AMS LaTeX and
4362 They need to be available on your system in order to use these environments.
4365 \begin_layout Section
4369 \begin_layout Standard
4374 can be used to type letters according to German conventions.
4375 A template file is included in
4377 .../lyx/share/templates
4379 for you to use as a starting point.
4382 \begin_layout Section
4386 \begin_layout Standard
4391 provides an alternative to the standard
4396 It provides similar functionality, but you might prefer this layout with
4397 sans serif sections, headings, and more.
4400 \begin_layout Section
4404 \begin_layout Standard
4410 \begin_layout Subsection
4414 \begin_layout Standard
4415 This section describes how LyX can be used to write articles for submission
4416 to the scientific journal
4418 Astronomy and Astrophysics
4421 \begin_inset LatexCommand url
4422 name "www.edpsciences.fr/aa/"
4423 target "http://www.edpsciences.fr/aa/"
4427 ) using Version 5.01 of the document class
4432 This package can be downloaded from the ftp site
4435 \begin_layout Standard
4436 \begin_inset VSpace medskip
4442 \begin_layout Standard
4444 \begin_inset LatexCommand url
4445 target "ftp://ftp.edpsciences.org/pub/aa/readme.html"
4452 \begin_layout Standard
4453 \begin_inset VSpace medskip
4459 \begin_layout Standard
4460 A manual comes together with that package, and this text is not meant to
4461 replace the original manual but merely a short guide how to realize the
4462 correct form of your paper.
4466 \begin_layout Standard
4467 Please note that the publisher of the journal was changed from Springer
4468 to EDP Sciences starting January 1, 2001.
4469 That change implicated also some slight changes of the style files, namely
4470 the removal of the thesaurus command.
4471 The LyX class aa supports the newest version of these style files, V 5.01.
4472 If you have an older version installed, please upgrade.
4473 For compatibility, the old (version 4) layout has been kept as
4478 Please refer to the comments in
4480 LyXDir/layouts/aapaper.layout
4485 \begin_layout Subsection
4489 \begin_layout Standard
4490 It is recommended you start from the example template distributed with LyX.
4491 If you are not using a template, note the following settings:
4494 \begin_layout Itemize
4504 ocument\SpecialChar \menuseparator
4511 dialog (OK, that one was obvious).
4514 \begin_layout Itemize
4515 Don't change the option
4525 The whole layout is done by the macros, you shouldn't change anything.
4528 \begin_layout Subsection
4532 \begin_layout Standard
4533 First thing to enter is the header information.
4534 It consists of seven entries, of which some are optional.
4538 \begin_layout Itemize
4546 \begin_layout Itemize
4554 \begin_layout Itemize
4562 \begin_layout Itemize
4570 \begin_layout Itemize
4575 : [optional] if more than one author: whom to contact for offprint requests.
4578 \begin_layout Itemize
4583 : [optional] mail address for contacts.
4586 \begin_layout Itemize
4594 Received: <date>; Accepted <date>
4597 \begin_layout Standard
4598 There is no need to issue the
4604 command, this is done automatically by LyX when the header is finished.
4605 Although the order of the single header entries doesn't matter it is advised
4606 to keep the above sequence, just to get the best optics and meets the layout
4607 of the real document.
4610 \begin_layout Standard
4611 If you want to place footnotes in the header block, e.\InsetSpace \thinspace{}
4616 \begin_layout Standard
4625 to state your present address, just use the standard footnote via
4630 nsert\SpecialChar \menuseparator
4638 LyX will automagically use the term
4647 \begin_layout Standard
4648 In addition to these topics, the macros use three additional LaTeX commands
4649 that have no counterpart in LyX:
4652 \begin_layout Itemize
4659 to separate different names for more than one author and institute, respectivel
4663 \begin_layout Itemize
4670 to mark corresponding author/institute pairs.
4671 The institutes are numbered sequentially as they appear in the
4675 field, so you have to put a marker to each author.
4678 \begin_layout Itemize
4685 to supply an email address for fast contact.
4688 \begin_layout Standard
4689 In all cases, the appropriate command has to be entered in LyX and marked
4695 \begin_layout Subsection
4699 \begin_layout Standard
4700 The abstract should immediately follow the header block.
4701 With version 5 the abstract environment was changed to a command, and there
4702 is now a resctriction to only one paragraph.
4703 In addition, it should contain an entry with the keywords.
4704 This is not yet implemented for LyX, therefore you have to enter the LaTeX
4711 by hand and mark it as LaTeX code.
4712 Refer to the example paper.
4715 \begin_layout Subsection
4716 Supported environments
4719 \begin_layout Standard
4720 The A&A paper layout supports the following environments for structuring
4724 \begin_layout Itemize
4730 \begin_layout Itemize
4736 \begin_layout Itemize
4742 \begin_layout Itemize
4748 \begin_layout Itemize
4754 \begin_layout Itemize
4760 \begin_layout Itemize
4766 \begin_layout Itemize
4772 \begin_layout Itemize
4778 \begin_layout Itemize
4784 \begin_layout Itemize
4790 \begin_layout Itemize
4796 \begin_layout Subsection
4797 Commands not supported by LyX
4800 \begin_layout Standard
4801 Some commands are not yet supported by the
4806 Some have already been mentioned.
4807 For the sake of completeness, they are listed all together here:
4810 \begin_layout Itemize
4818 \begin_layout Itemize
4826 \begin_layout Itemize
4834 \begin_layout Itemize
4842 \begin_layout Itemize
4850 \begin_layout Itemize
4858 \begin_layout Itemize
4866 \begin_layout Itemize
4874 \begin_layout Standard
4875 If you want to use any of these commands, you have to enter them yourself.
4878 Do not forget to mark them as LaTeX code!
4881 \begin_layout Subsection
4882 Figure and Table Floats
4885 \begin_layout Standard
4886 LyX provides support for the necessary float environments
4888 figure, figure*, table
4894 , therefore we won't tell much about it here.
4901 Just remember that tables should be left-aligned.
4902 For that, select the table and change the alignment in
4907 dit\SpecialChar \menuseparator
4912 aragraph\InsetSpace ~
4916 \begin_layout Standard
4917 There is only one special thing: the figures with caption besides the figure.
4918 To create such a figure, you have to do the following:
4921 \begin_layout Enumerate
4922 Create a wide figure float:
4927 nsert\SpecialChar \menuseparator
4932 t\SpecialChar \menuseparator
4935 , then right click in the figure and select
4946 \begin_layout Enumerate
4947 Enter your caption text.
4950 \begin_layout Enumerate
4955 to move the cursor above the caption.
4958 \begin_layout Enumerate
4962 \begin_layout Enumerate
4963 Position the cursor behind the figure and insert a horizontal fill:
4968 nsert\SpecialChar \menuseparator
4976 \SpecialChar \menuseparator
4979 orizontal\InsetSpace ~
4985 \begin_layout Enumerate
4986 Switch to LaTeX mode:
4994 \begin_layout Enumerate
5004 Do not close the brace!
5007 \begin_layout Enumerate
5008 Position the cursor behind the caption text, switch to LaTeX mode and insert
5021 \begin_layout Standard
5022 Also, refer to the figures in the example paper.
5025 \begin_layout Subsection
5029 \begin_layout Standard
5030 For submission, the paper has to be formated in a special double-spacing
5032 For this purpose, you have to give the option
5036 to the documentclass.
5037 This must be done using the extra class options field in the
5042 ocument\SpecialChar \menuseparator
5050 Just enter the string
5057 \begin_layout Subsection
5061 \begin_layout Standard
5066 directory contains an example paper written with LyX.
5067 It is the example paper from the original macro package, translated to
5069 Use it for inspiration, and compare the original LaTeX code with LyX way
5073 \begin_layout Section
5077 \begin_layout Standard
5083 \begin_layout Subsection
5087 \begin_layout Standard
5088 AASTeX is a set of macros produced by the American Astronomical Society
5089 to facilitate electronic manuscript submission to the three journals they
5090 publish: the Astrophysical Journal (including the Letters and Supplement),
5091 the Astronomical Journal, and the Publications of the Astronomical Society
5093 LyX has proven to be an excellent tool for generating these documents,
5094 especially given its equation, citation, and figure handling capabilities.
5095 LyX requires version 5.0 (or higher) of these macros; preferably 5.2, which
5096 is the version described here, or higher.
5097 Versions prior to 5.0 are intended for use with LaTeX2.09 and are fundamentally
5098 incompatible with LyX.
5099 The AASTeX package may be downloaded from the AASTeX Web site
5102 \begin_layout Standard
5103 \begin_inset VSpace medskip
5109 \begin_layout Standard
5111 \begin_inset LatexCommand url
5112 target "http://www.journals.uchicago.edu/AAS/AASTeX"
5119 \begin_layout Standard
5120 \begin_inset VSpace medskip
5126 \begin_layout Standard
5127 A complete user guide is contained in that package and you should familiarize
5128 yourself with it thoroughly before embarking on writing a paper in LyX.
5129 LyX will not reduce the need to figure out all the AASTeX commands, it
5130 will only reduce the drudgery of typing everything in.
5131 It is your responsibility to ensure that the final exported LaTeX document
5132 conforms completely to the requirements of the journal to which you are
5133 submitting your paper.
5136 \begin_layout Subsection
5137 Starting a New Paper
5140 \begin_layout Standard
5141 I strongly suggest that you start with the AASTeX template file.
5147 ile\SpecialChar \menuseparator
5157 , enter the new file name, then choose the
5162 This will show the most common fields found in a manuscript.
5163 Simply overwrite the existing text (including the brackets,
5167 ) with the correct information.
5168 Many of the AASTeX commands and environments can be implemented directly
5169 in LyX, but some cannot: most noticeably
5181 , which should stick out like a sore thumb if you actually just opened the
5183 For commands such as these, the LaTeX code must be entered directly and
5185 Such commands are referred to as ERT, or Evil Red Text.
5186 I tried to minimize the amount of ERT needed in an AASTeX document, but
5187 there is still a bit more required than any of us would like.
5190 \begin_layout Subsection
5191 Finishing Your Paper
5194 \begin_layout Standard
5195 When the paper is finished to your satisfaction and previews/prints correctly,
5197 \begin_inset Quotes eld
5201 \begin_inset Quotes erd
5204 actions which need to be done before you submit it to the journals.
5208 \begin_layout Enumerate
5209 Export your paper as a LaTeX file (
5214 ile\SpecialChar \menuseparator
5219 xport\SpecialChar \menuseparator
5230 \begin_layout Enumerate
5235 file with your favorite text editor
5239 \begin_layout Enumerate
5240 remove the comment lines before the
5249 \begin_layout Enumerate
5254 usepackage...{fontenc}
5256 line if it appears (usually just after
5271 \begin_layout Enumerate
5272 remove everything between (and including) the
5284 commands, except for any commands you specifically put into the LaTeX preamble
5285 (which should appear immediately after the
5286 \begin_inset Quotes eld
5289 User specified LaTeX commands
5290 \begin_inset Quotes erd
5301 \begin_layout Enumerate
5302 Run the resulting file through LaTeX to make sure it still processes correctly.
5305 \begin_layout Enumerate
5306 Reread the journal requirements to make sure your filenames and formats
5310 \begin_layout Enumerate
5314 \begin_layout Subsection
5315 Comments On Specific Commands
5318 \begin_layout Standard
5319 I will not describe the detailed usage of the individual AASTeX commands:
5320 the AASTeX User Guide (
5324 ) gives a good description of each.
5325 Thus it's probably easiest for me to go down the list as found in the guide
5326 and offer comments where necessary.
5327 So let's begin \SpecialChar \ldots{}
5331 \begin_layout Subsubsection
5332 Things that work as expected
5335 \begin_layout Standard
5339 \begin_layout Standard
5351 \begin_layout Standard
5352 Because they work as you might expect, I simply list them and the section
5453 begin{thebibliography}
5461 (2.13.2), all the cite commands and their variations (2.13.2), the generic
5462 graphicx figure commands (2.14.1),
5486 (2.15.4, amongst other places),
5513 \begin_layout Standard
5514 The following style options also work correctly:
5535 Simply put them in the
5541 Layout\SpecialChar \menuseparator
5547 \begin_layout Standard
5551 \begin_layout Standard
5563 \begin_layout Subsubsection
5564 Things that work, but require more comment
5567 \begin_layout Standard
5568 The following items work, but require a little more discussion:
5571 \begin_layout Itemize
5572 These items are reserved for use by the journal editors, but you can put
5573 them into the LaTeX preamble if you feel compelled to do so:
5606 \begin_layout Itemize
5607 These items may be placed in the LaTeX preamble, and are included as blanks
5608 in the template file:
5629 \begin_layout Itemize
5636 (2.3) -- can only be used
5637 \begin_inset Quotes eld
5641 \begin_inset Quotes erd
5644 , not in the middle of a paragraph.
5645 Use ERT if you need to embed it.
5648 \begin_layout Itemize
5655 (2.3) -- will have extra {} after it.
5656 This should not cause an error.
5659 \begin_layout Itemize
5666 (2.6) -- can only be used
5667 \begin_inset Quotes eld
5671 \begin_inset Quotes erd
5674 , not in the middle of a paragraph.
5675 Use ERT if you need to embed it.
5678 \begin_layout Itemize
5685 (2.8) -- can't insert a cross-reference tag, you must type the tag name
5689 \begin_layout Itemize
5696 (2.8) -- same as for
5703 \begin_layout Itemize
5710 (2.9) -- will have extra {} after it.
5711 This should not cause an error.
5714 \begin_layout Itemize
5721 (2.11) -- will have extra {} after it.
5722 This should not cause an error.
5725 \begin_layout Itemize
5732 (2.14.2) -- you can insert an optional filename argument by placing the cursor
5733 at the beginning of the text and selecting
5735 Insert\SpecialChar \menuseparator
5740 \begin_inset Quotes eld
5744 \begin_inset Quotes erd
5747 inserts an optional argument of the type needed by
5754 Hopefully it will be renamed someday.
5757 \begin_layout Itemize
5770 for the catalog ID optional parameter
5773 \begin_layout Itemize
5786 for the catalog ID optional parameter
5789 \begin_layout Subsubsection
5790 Things not implemented, use ERT
5793 \begin_layout Standard
5797 \begin_layout Standard
5809 \begin_layout Standard
5832 setcounter{equation}
5834 (2.12), Journal name abbreviations (2.13.4),
5870 (2.15.4, insert it as the first element in the lefthand cell after where
5872 Don't use any of LyX's rules in the table),
5884 (2.15.5), much of Misc (2.17, except
5935 \begin_layout Standard
5939 \begin_layout Standard
5951 \begin_layout Subsubsection
5952 Things that cannot be implemented
5955 \begin_layout Standard
5956 \SpecialChar \ldots{}
5957 at least in any meaningful sort of way, so I suggest ignoring them.
5958 They are the references environment (2.13.3), and the deluxetable environment
5960 If you really, really need to use deluxetable, I suggest editing it in
5961 a separate file with a text editor, then using
5966 nsert\SpecialChar \menuseparator
5974 to include it in your LyX document.
5979 file to see an example of this.
5982 \begin_layout Subsection
5983 FAQs, Tips, Tricks, and Other Ruminations
5986 \begin_layout Subsubsection
5987 Getting LyX and AASTeX to cooperate
5990 \begin_layout Standard
5991 It can be a bit tricky to get LyX to recognize a new layout and document
5993 When all else fails, do this:
5996 \begin_layout Enumerate
5997 Make certain that LaTeX can find AASTeX.
5998 Copy sample.tex (and perhaps table.tex) from the AASTeX distribution into
5999 a directory completely unrelated to LaTeX or AASTeX and run LaTeX on
6006 \begin_layout Enumerate
6013 /usr/.../share/lyx/layouts
6022 \begin_layout Enumerate
6028 ools\SpecialChar \menuseparator
6035 in LyX, then restart LyX.
6038 \begin_layout Enumerate
6039 Open a regular new file, not from a template.
6040 Does AASTeX appear in the class list in
6045 ocument\SpecialChar \menuseparator
6055 \begin_layout Standard
6056 If you get a warning from an existing AASTeX document about not being able
6057 to find the AASTeX layout or a message about
6058 \begin_inset Quotes eld
6061 You should not mix title layouts with normal ones
6062 \begin_inset Quotes erd
6065 , things haven't been installed correctly.
6068 \begin_layout Subsubsection
6069 LaTeX error processing a table
6072 \begin_layout Standard
6073 LyX, by default, attempts to center the table caption/title.
6074 This seems to produce a bad interaction in AASTeX so you should click somewhere
6075 in the caption/title, then select
6080 dit\SpecialChar \menuseparator
6085 aragraph\InsetSpace ~
6100 This took care of it for me.
6103 \begin_layout Subsubsection
6105 \begin_inset LatexCommand label
6113 \begin_layout Standard
6114 A couple of things: 1) I have noticed some funny spacing in the reference
6115 entries in the text.
6116 When you enter the bibliography item data, make sure their is
6120 space between the last author and the parenthesis setting off the year;
6123 e.\InsetSpace \thinspace{}
6136 2) Entering the references at all is not obvious.
6137 The easiest thing is to start typing your first reference at the end of
6138 the document, then mark it as type
6143 That will put a small gray box in front of what you just typed.
6144 Click on the box to fill in the rest of the information.
6145 For new references, go to the end of an existing reference and press return.
6146 That will create a new line with its own box, etc.
6149 \begin_layout Subsubsection
6153 \begin_layout Standard
6154 Even though AASTeX provides its own figure commands (
6160 , for example), I much prefer LaTeX's standard figure commands (with the
6169 commands as ERT into a Figure Float box if you desire, but I never
6170 have much luck getting the layout right.
6171 With the standard graphics, LyX will insert a
6175 usepackage{graphicx}
6177 command into the LaTeX preamble and handle the figures in the standard
6178 LaTeX2e way, interspersing the figures in the text.
6179 I believe ApJ accepts figures exactly this way now; AJ might still use
6181 \begin_inset Quotes eld
6184 stack everything at the end
6185 \begin_inset Quotes erd
6191 \begin_layout Subsubsection
6192 Things I could have done, but didn't
6195 \begin_layout Standard
6197 \begin_inset Quotes eld
6201 \begin_inset Quotes erd
6204 things I could have implemented, but chose not to.
6205 For instance, I saw no point in double-spacing the text in the LyX window,
6206 even though it is double-spaced in the paper manuscript.
6207 Also, I chose not to make separate layouts for the preprint and preprint2
6209 Since I assume you will spend most of your time in the plain manuscript
6210 mode anyway, I decided not to chew up more disk space with this.
6214 \begin_layout Subsection
6218 \begin_layout Standard
6219 Your mileage may vary.
6220 I've now had papers published by both ApJ and AJ that have had 98% of the
6221 effort done in LyX; the last 2% was the LaTeX post-processing and a few
6223 I have had no trouble with the submission process, and I'm sure the journals
6224 were never aware that there might be a difference.
6225 So, go forth and publish!
6228 \begin_layout Section
6232 \begin_layout Standard
6235 Panayotis Papasotiriou
6238 \begin_layout Subsection
6242 \begin_layout Standard
6243 The ijmpc package is a set of macros that facilitates electronic manuscript
6246 International Journal of Modern Physics C
6249 Similarly, the ijmpd package is for creating manuscripts to be submitted
6252 International Journal of Modern Physics D
6255 Both journals are published by World Scientific.
6256 The corresponding document classes are named
6265 These files, together with instructions for the authors, can be downloaded
6267 \begin_inset LatexCommand url
6268 target "http://www.worldscinet.com/ijmpc/mkt/guidelines.shtml"
6273 \begin_inset LatexCommand url
6274 target "http://www.worldscinet.com/ijmpd/mkt/guidelines.shtml"
6279 Both packages are modified versions of the standard
6280 \begin_inset Quotes eld
6284 \begin_inset Quotes erd
6287 package, and they are almost (but not exactly) identical.
6288 Most of their features are supported by LyX.
6289 I have used LyX successfully to write articles submitted to both journals
6290 without any problem.
6293 \begin_layout Subsection
6297 \begin_layout Standard
6298 As usual, the easiest way to write a paper is to start with a template.
6304 ile\SpecialChar \menuseparator
6323 This will give an (almost) empty document that includes the most common
6324 fields found in a manuscript.
6325 Simply overwrite the existing text (including the brackets,
6330 You should keep in mind the following remarks.
6333 \begin_layout Enumerate
6334 LyX won't let you change the font size and the page style of the document,
6335 because such modifications are not allowed by both packages.
6338 \begin_layout Enumerate
6339 The language of the document should not be changed.
6340 Before previewing your paper, be sure that the babel package is not used.
6341 To do this, click on
6346 ools\SpecialChar \menuseparator
6364 checkbox in the language settings, and click on
6375 , if you wish to make this change permanent).
6378 \begin_layout Enumerate
6380 \begin_inset Quotes eld
6384 \begin_inset Quotes erd
6387 style must be used to define keywords.
6390 \begin_layout Enumerate
6391 The ijmpc package provides a style named
6392 \begin_inset Quotes eld
6395 Classification Codes
6396 \begin_inset Quotes erd
6399 , which can be used to define classification codes, such as PACS numbers.
6400 Note that this facility is not supported by the ijmpd package.
6403 \begin_layout Enumerate
6404 Several new environments are available:
6405 \begin_inset Quotes eld
6409 \begin_inset Quotes erd
6413 \begin_inset Quotes eld
6417 \begin_inset Quotes erd
6421 \begin_inset Quotes eld
6425 \begin_inset Quotes erd
6429 \begin_inset Quotes eld
6433 \begin_inset Quotes erd
6437 \begin_inset Quotes eld
6441 \begin_inset Quotes erd
6445 \begin_inset Quotes eld
6449 \begin_inset Quotes erd
6453 \begin_inset Quotes eld
6457 \begin_inset Quotes erd
6461 \begin_inset Quotes eld
6465 \begin_inset Quotes erd
6469 \begin_inset Quotes eld
6473 \begin_inset Quotes erd
6477 \begin_inset Quotes eld
6481 \begin_inset Quotes erd
6485 \begin_inset Quotes eld
6489 \begin_inset Quotes erd
6493 \begin_inset Quotes eld
6497 \begin_inset Quotes erd
6501 \begin_inset Quotes eld
6505 \begin_inset Quotes erd
6509 \begin_inset Quotes eld
6513 \begin_inset Quotes erd
6517 Their use is more or less obvious.
6518 LyX supports all these environments; it will use the proper label, text
6519 style, and numbering scheme for each of them.
6522 \begin_layout Enumerate
6523 Both packages use basic citations; the natbib package should not be used.
6524 In LyX, citation references are shown as usual; in the output, citations
6525 are shown as superscripts.
6526 If you want to use a citation as normal text, you should use the
6530 command, e.\InsetSpace \thinspace{}
6532 \begin_inset Quotes eld
6535 See Ref.\InsetSpace ~
6543 \begin_inset Quotes erd
6549 \begin_layout Enumerate
6551 \begin_inset Quotes eld
6555 \begin_inset Quotes erd
6558 section in both packages.
6559 To put acknowledgments, just use the
6560 \begin_inset Quotes eld
6564 \begin_inset Quotes erd
6570 \begin_layout Enumerate
6571 Appendices may be added to the paper,
6575 the Acknowledgments and
6580 LyX provides a special environment, called
6581 \begin_inset Quotes eld
6585 \begin_inset Quotes erd
6588 which marks the beginning of the appendices.
6589 This environment should be left blank; it just sends a LaTeX command, but
6590 nothing is really printed.
6592 \begin_inset Quotes eld
6596 \begin_inset Quotes erd
6599 is printed with blue letters, as a signal that all sections after that
6600 point are appendices.
6601 To write an appendix, use the
6602 \begin_inset Quotes eld
6606 \begin_inset Quotes erd
6610 LyX will number each appendix with capital letters, as required by both
6613 \begin_inset Quotes eld
6617 \begin_inset Quotes erd
6624 be present before the first appendix; if not, all appendices will be numbered
6625 as normal sections in the output.
6628 \begin_layout Enumerate
6629 The ijmpc and the ijmpd packages use the
6633 command to implement table captions.
6634 As a result, a table created by LyX is printed correctly, but its caption
6636 However, you can use some ERT to overpass this problem, so that captions
6637 are printed as expected.
6638 To do so, create a float table as usual, remove the caption, and replace
6649 (sic); you must also the ERT
6653 immediately after the tabular material.
6654 Study the example table included in the template files to see how this
6655 trick is implemented.
6656 Alternatively, If you need table captions, you should implement the whole
6661 file, then include this file to the LyX document (
6666 nsert\SpecialChar \menuseparator
6671 \SpecialChar \menuseparator
6680 Details on how to create a table float can be found in the files
6688 , included in the corresponding packages.
6691 \begin_layout Subsection
6692 Preparing a paper for submission
6695 \begin_layout Standard
6696 Before you submit your paper you must export the LyX document as a LaTeX
6702 ile\SpecialChar \menuseparator
6707 xport\SpecialChar \menuseparator
6722 \begin_layout Standard
6723 Actually you have the choice between LaTeX (plain) and pdflatex.
6724 If you intend to use pdflatex to prepare the paper, you should use the
6725 pdflatex option so that included graphics are converted to PDF format,
6726 ready for use by pdflatex.
6731 , then make the following changes to the resulting
6738 \begin_layout Enumerate
6739 Remove the comment lines before the
6748 \begin_layout Enumerate
6749 Remove everything between (and including) the
6761 commands, except for any commands you specifically put into the LaTeX preamble.
6764 \begin_layout Standard
6769 file should be saved and processed through LaTeX as many times as necessary.
6770 You may also want to check the resulting
6777 \begin_layout Subsection
6781 \begin_layout Standard
6782 The use of ERT is reduced to two commands, which must be placed at the top
6784 If you started writing your paper by using the
6792 template, the ERT needed is already in its place; you usually don't need
6794 You may only modify the first ERT to specify the information printed to
6795 the top of odd and even pages (authors' names and short paper's title,
6797 This ERT must have the form
6801 markboth{Authors' Names}{Short Paper's Title}
6806 \begin_layout Section
6810 \begin_layout Standard
6816 \begin_layout Subsection
6820 \begin_layout Standard
6821 The iopart package provides a document class to create electronic manuscript
6822 submission to the journals published by the Institute of Physics.
6823 Instructions for the authors how to create a paper using the iopart class
6824 can be downloaded together with the iopart package from the site
6825 \begin_inset LatexCommand url
6826 target "ftp://ftp.iop.org/pub/journals/latex2e"
6833 \begin_layout Subsection
6837 \begin_layout Standard
6838 The easiest way to write a paper is to start with the file
6842 that is available in LyX's examples files folder.
6843 Open this file, save it under a new name, and start writing.
6844 The example file explains how to use the special text environments.
6845 Here are the most important advices:
6848 \begin_layout Itemize
6849 To be able to compile your document to a PDF, PS, or DVI, assure that the
6852 Use AMS math package
6854 in the document settings under
6861 \begin_layout Itemize
6864 The title environment defines the kind of your paper.
6865 So use one of the following environments for the title:
6869 \begin_layout Itemize
6878 \begin_layout Itemize
6887 \begin_layout Itemize
6893 for a Topical review
6896 \begin_layout Itemize
6905 \begin_layout Itemize
6914 \begin_layout Itemize
6920 for a Paper (same as Title)
6923 \begin_layout Itemize
6929 for a Preliminary communication
6932 \begin_layout Itemize
6938 for a Rapid communication
6941 \begin_layout Itemize
6947 for a Letter to the editor
6951 \begin_layout Itemize
6954 All title environments except of
6958 can have an optional short title.
6961 \begin_layout Itemize
6962 There is a general title environment
6966 which is not directly supported by the LyX.
6967 This can be used as ERT when your document doesn't fit into one of the
6971 \begin_layout Standard
6972 For more informations like hints for special table and formula formatting,
6973 look at the IOP author guidelines.
6976 \begin_layout Section
6980 \begin_layout Standard
6983 Panayotis Papasotiriou
6986 \begin_layout Subsection
6990 \begin_layout Standard
6991 The Kluwer package is a set of macros produced by Kluwer Academic Publishers
6992 that facilitates electronic manuscript submission to the journals they
6994 Most known of them (at least in my domain of interest) are
6996 Astrophysics and Space Science
7002 , but there are many others (see a complete list at
7003 \begin_inset LatexCommand url
7004 target "http://www.wkap.nl/jrnllist.htm/JRNLHOME"
7009 The Kluwer package may be downloaded from the site
7010 \begin_inset LatexCommand url
7011 target "http://www.wkap.nl/kaphtml.htm/STYLEFILES"
7016 A complete user guide is contained in that package (but it can also be
7017 downloaded separately).
7020 \begin_layout Standard
7021 LyX supports many features of the package but not everything.
7022 However, the ERT needed is reduced to some
7023 \begin_inset Quotes eld
7027 \begin_inset Quotes erd
7030 commands of the package (see\InsetSpace ~
7032 \begin_inset LatexCommand ref
7033 reference "subsec:kluwer_peculiarities"
7038 I have recently used LyX to write an article submitted to the
7040 Astrophysics and Space Science
7042 without any problem.
7045 \begin_layout Subsection
7049 \begin_layout Standard
7050 The easiest way to write a paper is to start with the Kluwer template file.
7053 File\SpecialChar \menuseparator
7068 This will give an (almost) empty document that includes the most common
7069 fields found in a manuscript and a short description of their use.
7070 As in most templates, simply overwrite the existing text (including the
7075 ) with the correct information.
7078 \begin_layout Subsection
7079 Preparing a paper for submission
7082 \begin_layout Standard
7083 As in the AASTeX package, before you submit your paper to a journal you
7085 \begin_inset Quotes eld
7089 \begin_inset Quotes erd
7095 \begin_layout Enumerate
7096 Export your paper as a LaTeX file.
7097 To do this, click on
7102 ile\SpecialChar \menuseparator
7107 xport\SpecialChar \menuseparator
7118 \begin_layout Enumerate
7123 file with a text editor and make the following changes
7127 \begin_layout Enumerate
7128 remove the comment lines before the
7137 \begin_layout Enumerate
7138 remove everything between (and including) the
7150 commands, except for any commands you specifically put into the LaTeX preamble.
7153 \begin_layout Standard
7162 \begin_layout Enumerate
7167 file through LaTeX as many times as necessary (usually up to three).
7170 \begin_layout Enumerate
7175 document using, e.\InsetSpace \thinspace{}
7180 , and check if everything is OK (it should, if you didn't make any mistake).
7183 \begin_layout Subsection
7184 \begin_inset Quotes eld
7188 \begin_inset Quotes erd
7191 of the Kluwer package
7192 \begin_inset LatexCommand label
7193 name "subsec:kluwer_peculiarities"
7200 \begin_layout Standard
7201 The Kluwer package has the following
7202 \begin_inset Quotes eld
7206 \begin_inset Quotes erd
7212 \begin_layout Enumerate
7213 It is possible to write multiple articles in the same LaTeX file
7217 \begin_layout Standard
7218 I can't imagine any good reason to do this.
7224 Each article must be included in the environment
7225 \begin_inset Quotes eld
7229 \begin_inset Quotes erd
7233 Unfortunately, this environment cannot be omitted, even if you write just
7235 Therefore, each article starts with the command
7241 and, obviously, ends with the command
7248 Although this can be implemented in LyX, I didn't included it, since it
7249 looks ugly and can confuse the novice user.
7250 Therefore, you need to enter them directly and mark them as LaTeX code
7252 \begin_inset Quotes eld
7256 \begin_inset Quotes erd
7262 \begin_layout Enumerate
7263 Information given at the beginning of the article (i.e., title, subtitle,
7264 author, institution, running title, running author, abstract and keywords)
7265 must be included in an environment called
7266 \begin_inset Quotes eld
7270 \begin_inset Quotes erd
7274 This is not implemented in LyX, so you must enter title, subtitle etc.\InsetSpace ~
7291 \begin_layout Enumerate
7292 According to the user manual, the label of each bibliography item must be
7316 \begin_layout Standard
7321 template takes care of all these
7322 \begin_inset Quotes eld
7326 \begin_inset Quotes erd
7330 If you start a new paper using this template you don't need to do anything
7335 \begin_layout Enumerate
7336 don't delete the ERT included in the template, and
7339 \begin_layout Enumerate
7340 copy the example bibliography item included in the template and modify it
7341 as necessary to enter new bibliography items.
7344 \begin_layout Section
7348 \begin_layout Standard
7354 \begin_layout Subsection
7358 \begin_layout Standard
7359 The LyX document classes
7361 article (koma-script)
7365 report (koma-script)
7383 correspond to the LaTeX document classes
7399 , resp.\InsetSpace ~
7400 of the Koma-Script family.
7401 They are replacements for the standard document classes
7417 , resp., and fit better to European typography conventions in a number of
7421 \begin_layout Itemize
7422 Standard character size is 11pt in
7424 article (koma-script)
7428 report (koma-script)
7436 letter (koma-script)
7441 \begin_layout Itemize
7442 Headings, labels of the description environment, and a number of elements
7445 letter (koma-script)
7447 document class are set in a bold sans serif font.
7451 \begin_layout Standard
7452 There is a big difference between the bold sans serif old cm fonts and new
7453 ec fonts, especially in the appearance of headings.
7454 In comparison, the ec bold sans serif fonts look a bit thin.
7455 Here the LaTeX package
7463 helps to produce the
7464 \begin_inset Quotes eld
7468 \begin_inset Quotes erd
7471 appearance when using the ec fonts.
7476 The numbering of chapter headings is made in the same way as the numbering
7477 of section headings, that is without the extra line
7478 \begin_inset Quotes eld
7481 Chapter\SpecialChar \ldots{}
7483 \begin_inset Quotes erd
7487 In addition, the appearance of the headings can be modified by using a
7488 number of options (in LyX to be entered in the field
7502 ayout\SpecialChar \menuseparator
7510 A detailed German description of these options can be found in the Koma-Script
7518 \begin_layout Itemize
7519 The main means in the Koma-Script document classes to design the type area
7528 (in LyX to be entered in the extra class options field in the dialog
7533 ocument\SpecialChar \menuseparator
7541 They make a clearer modification of page margins possible as do the options
7547 ocument\SpecialChar \menuseparator
7555 A detailed German description of these and other type area options can
7556 be found in the Koma-Script documentation
7563 \begin_layout Itemize
7564 The LaTeX document classes of the Koma-Script family define a number of
7565 additional commands.
7566 Those part of it which makes sense in LyX is implemented in corresponding
7570 \begin_layout Standard
7571 A detailed German description of the LaTeX document classes of the Koma-Script
7572 family can be found in the Koma-Script documentation
7580 \begin_layout Standard
7581 There is an English translation
7585 , but it is not a complete one.
7590 The following sections describe only those aspects, which are relevant
7594 \begin_layout Subsection
7595 article (koma-script), report (koma-script), and book (koma-script)
7598 \begin_layout Standard
7599 The document classes
7601 article (koma-script)
7605 report (koma-script)
7615 are implemented in the layout files
7628 They contain all the paragraph types of the corresponding standard document
7641 , resp., partly modified, with the exception of the LyX specific
7645 -type, which is replaced by the new
7649 -type having the same functionality.
7654 -Type there is a number of new paragraph types added.
7661 letter (koma-script)
7666 \begin_layout Itemize
7675 : are equivalents to
7683 , resp., additionally inserting an entry in the table of contents.
7692 are not contained in
7694 article (koma-script)
7699 \begin_layout Itemize
7716 , resp., additionally clearing running heads.
7723 article (koma-script)
7729 \begin_layout Standard
7742 report (koma-script)
7744 , but since this is identical to
7748 , is has not been implemented in LyX.
7756 \begin_layout Itemize
7761 : generates a heading directly above the following paragraph in the standard
7762 character size without affecting the structure of the document.
7765 \begin_layout Itemize
7774 are special captions which respect the different space settings needed
7775 for captions placed above or below an element (if you follow strict typographic
7776 rules, you might want to place table captions always above the table).
7777 You can also use the class option
7794 You need at least Koma-Script version 2.8q to use this.
7797 \begin_layout Itemize
7802 : can be used to set a bonmot, e.
7806 \begin_layout Standard
7819 \begin_layout Standard
7828 at the beginning of a chapter.
7829 If you use the optional argument (
7834 nsert\SpecialChar \menuseparator
7838 ), you can insert the dictum's author there.
7839 Dictum and author are separated by a line.
7840 You need at least Koma-Script version 2.8q to use this.
7847 article (koma-script)
7852 \begin_layout Standard
7853 The following types, together with the standard types
7865 , form the title area of the document.
7866 They must be entered ahead of the first
7867 \begin_inset Quotes eld
7871 \begin_inset Quotes erd
7878 \begin_layout Standard
7879 The corresponding LaTeX commands must appear before the
7890 When such a type is used more than once, the latter usage overwrites the
7891 former one, that means, for every type only the latest usage is valid.
7892 The order of the different types however has, like
7904 , no effect on the appearance of the produced document.
7907 \begin_layout Itemize
7912 : produces a centered paragraph above the ordinary title (
7924 ) for the subject of the document.
7927 \begin_layout Itemize
7932 : produces a centered paragraph below the ordinary title (
7944 ) for the publishers' name.
7947 \begin_layout Itemize
7954 report (koma-script)
7960 produces a centered paragraph on its own page behind the title page, or
7963 article (koma-script)
7965 produces a centered paragraph below the ordinary title (
7984 \begin_layout Itemize
7989 : produces a left aligned paragraph above the ordinary title (
8005 ) for a document`s head.
8008 \begin_layout Itemize
8013 : produces in a double-sided print in
8015 report (koma-script)
8021 a left-aligned paragraph at the top of the title page`s back or has no
8022 effect in a single-sided print or in
8024 article (koma-script)
8029 \begin_layout Itemize
8034 : produces in a double-sided print in
8036 report (koma-script)
8042 a left-aligned paragraph at the bottom of the title page`s back or has
8043 no effect in a single-sided print or in
8045 article (koma-script)
8050 \begin_layout Itemize
8055 : produces a special
8056 \begin_inset Quotes eld
8060 \begin_inset Quotes erd
8063 page ahead of the actual document containing a paragraph without special
8067 \begin_layout Standard
8068 The layout files for the document classes
8070 article (koma-script)
8074 report (koma-script)
8085 This is thought of as a place to define your own types.
8090 in your personal layout directory and edit the file!
8093 \begin_layout Subsection
8094 letter (koma-script)
8097 \begin_layout Standard
8101 \begin_layout Standard
8113 \begin_layout Standard
8117 letter (koma-script)
8119 is implemented in the layout file
8124 It contains all the paragraph types of the corresponding standard document
8129 , partly modified, with the exception of the LyX specific types
8141 type, which is replaced by the new
8146 In addition, it contains, in contrast to the standard document class, the
8164 Furthermore, there are a number of new letter specific types.
8167 \begin_layout Standard
8171 \begin_layout Standard
8183 \begin_layout Standard
8184 The appearance of the letter produced by this document class can be controlled
8185 by a number of LaTeX commands, which you can put in the LaTeX preamble.
8189 \begin_layout Standard
8190 For example, the standard appearance of the letter`s heading, consisting
8191 of name and address, is quite self-willed.
8193 \begin_inset Quotes eld
8197 \begin_inset Quotes erd
8200 heading is produced by the following LaTeX commands in the preamble:
8203 \begin_layout LyX-Code
8213 \begin_layout LyX-Code
8229 \begin_layout LyX-Code
8239 \begin_layout LyX-Code
8259 A detailed German description of such LaTeX commands can be found in the
8260 Koma-Script documentation
8265 With it, the letter's author can produce his personal letter layout.
8268 \begin_layout Standard
8277 define the beginning of the letter and must be used in every letter.
8278 To emphasize them in the LyX document class, they are marked with the letter
8287 , resp.\InsetSpace ~
8289 It is possible to write any number of letters in one file.
8294 type produces a new letter using the same addressee and a
8298 type produces a new addressee.
8315 are ordinary paragraph types and can also be used several times in one
8316 and the same letter.
8319 \begin_layout Itemize
8324 : produces a paragraph for the addressee and implicitly defines the beginning
8328 \begin_layout Itemize
8333 : produces a paragraph for the form of address and implicitly produces a
8337 \begin_layout Itemize
8342 : produces a paragraph for a close.
8345 \begin_layout Itemize
8350 : produces a paragraph for a postscript.
8353 \begin_layout Itemize
8358 : produces a paragraph for a distribution list.
8361 \begin_layout Itemize
8366 : produces a paragraph for enclosures.
8369 \begin_layout Standard
8410 are input types provided with a label to enter information, which will
8411 be processed by the document class.
8415 \begin_layout Standard
8416 It could be seen as a matter of inconsequence, that the types
8424 described above are not such input types as well.
8425 Because of the special meaning of those types, however, I have implemented
8426 them as ordinary paragraph types with a one letter mark in the left margin.
8427 Moreover, it would affect my feeling of symmetry, if the
8435 type had such a serious different appearance.
8440 The types must be used ahead of the corresponding
8447 \begin_layout Standard
8448 An implementation of these types in a WYSIWYG fashion does not seem to make
8449 sense, because the real appearance of the produced letter does not only
8450 depend on the usage of the particular type, but also on other factors.
8451 For example, a signature entered in the
8455 type will in the standard behavior appear in the produced letter only,
8456 when in the same letter also a
8461 The entered value of the
8465 type will in the standard behavior not appear in the produced letter at
8467 The possibility to design the letter`s heading freely is already indicated
8468 in a footnote above.
8471 \begin_layout Standard
8472 The input types can also be used as empty paragraphs.
8473 This makes sense e.\InsetSpace \thinspace{}
8484 type is not used at all, in the standard behavior the value of the
8488 type is used as signature, whereas if an empty
8492 type is used, no signature value is defined.
8495 \begin_layout Standard
8496 By using the input types it is possible to write a letter template, containing
8497 filled input types with your personal dates (name, address, etc.) and empty
8498 input types for other dates you want to enter.
8501 \begin_layout Itemize
8506 : sender's name, in the standard behavior appears as a centered paragraph
8507 in small caps in the letter`s heading.
8510 \begin_layout Itemize
8515 : sender's signature, in the standard behavior appears below the
8524 type is used, the value of the
8528 type appears instead.
8531 \begin_layout Itemize
8536 : sender's address, in the standard behavior appears in a centered paragraph
8537 in the letter`s heading below the sender's name.
8540 \begin_layout Itemize
8545 : sender's telephone number, in the standard behavior only sets the LaTeX
8555 \begin_layout Itemize
8560 : place of the letter`s making.
8563 \begin_layout Itemize
8568 : date of the letter`s making.
8577 , in the standard behavior, produce the place and the date in a right-aligned
8578 line below the addressee's field.
8583 type is used, neither place nor date appear, independent of the value of
8593 type is used, the date of the letter `s production is used.
8596 \begin_layout Itemize
8601 : sender`s back address, in the standard behavior appears above the addressee's
8602 field in a small sans serif font.
8605 \begin_layout Itemize
8610 : special mail information, in the standard behavior appears underlined
8611 above the addressee's field below the back address.
8614 \begin_layout Itemize
8619 : additional information, in the standard behavior appears on right side
8620 below the addressee`s field.
8623 \begin_layout Itemize
8628 : the letter's title, in the standard behavior appears in a big, bold, sans
8629 serif font above the subject.
8632 \begin_layout Itemize
8637 : the letter's subject, in the standard behavior appears in a bold font
8645 \begin_layout Standard
8666 produce a business letter like line above the
8670 line containing the fields
8671 \begin_inset Quotes eld
8675 \begin_inset Quotes erd
8679 \begin_inset Quotes eld
8683 \begin_inset Quotes erd
8687 \begin_inset Quotes eld
8691 \begin_inset Quotes erd
8695 \begin_inset Quotes eld
8699 \begin_inset Quotes erd
8703 \begin_inset Quotes eld
8707 \begin_inset Quotes erd
8711 \begin_inset Quotes eld
8715 \begin_inset Quotes erd
8719 For the date field, the value of the
8725 \begin_inset Quotes eld
8728 business letter types
8729 \begin_inset Quotes erd
8732 is used, the value of the
8736 type however does not appear, but only the LaTeX variable
8743 The ordinary output of place and date in a right-aligned line below the
8744 addressee`s field is suppressed.
8745 The types are implemented as input types provided with a label and must
8746 be used ahead of the corresponding
8753 \begin_layout Itemize
8761 \begin_layout Itemize
8769 \begin_layout Itemize
8777 \begin_layout Itemize
8785 \begin_layout Itemize
8793 \begin_layout Subsection
8794 The new letter class: letter (koma-script v.2)
8797 \begin_layout Standard
8800 Jürgen Spitzmüller
8803 \begin_layout Standard
8804 \begin_inset VSpace medskip
8810 \begin_layout Standard
8812 Koma-Script version 2.8 has introduced a new letter class
8816 which supersedes the now unsupported
8821 It has --- on the LaTeX side --- a completely new interface and is not
8822 compatible with the old class.
8823 Therefore, LyX supports both, though it is recommended to use the new class.
8826 \begin_layout Standard
8827 This class covers the same functionality as
8829 letter (koma-script),
8836 (receiver's address, same as
8853 will start a new letter (i.
8857 \begin_layout Standard
8870 \begin_layout Standard
8879 you can write several letters per document).
8880 New elements are sender's
8896 and the possibility to use a
8905 nsert\SpecialChar \menuseparator
8915 \begin_layout Standard
8916 The biggest improvement is, though, that the letter's layout is configurable
8917 at almost any needs.
8918 This can be done via the preamble or with a special style file (Letter
8919 Class Option, extension
8923 ), that will be read in as a class option.
8927 \begin_layout Standard
8928 The KOMA package comes with some default
8933 There is, for instance, a
8937 file that follows german typesetting rules, or a
8941 that provides the default layout of the old
8946 The latter can be loaded with the class option
8955 ayout\SpecialChar \menuseparator
8960 ocument\SpecialChar \menuseparator
8972 template that is included in LyX for examples.
8973 A detailed description is to be found in the Koma-Script documentation
8981 \begin_layout Subsection
8985 \begin_layout Standard
8986 Visualizing the Koma-Script document classes in LyX, the LyX internals cause
8990 \begin_layout Itemize
8991 The chapter number of a
8995 type appears on a line of its own above the chapter heading instead of
8996 appearing in the same line ahead of it.
8997 The cause for that is the LyX internal behavior for the labeltype
9004 \begin_layout Itemize
9005 The headings of the types
9014 \begin_inset Quotes eld
9018 \begin_inset Quotes erd
9021 LaTeX table of contents, but not in the LyX table of contents (
9026 ocument\SpecialChar \menuseparator
9038 \begin_layout Itemize
9043 document class appear in a skip separation mode, not indented.
9044 This is the standard behavior, no special LaTeX commands are needed for
9051 ocument\SpecialChar \menuseparator
9058 dialog the corresponding radio button indicates
9074 value always has the effect that extra LaTeX commands are inserted in the
9075 document to produce the gap, which is not what is wanted in this case.
9078 \begin_layout Section
9086 \begin_layout Standard
9092 \begin_layout Subsection
9096 \begin_layout Standard
9097 These are the layout files for some of the journal formats used by Springer
9098 Verlag and listed on
9099 \begin_inset LatexCommand url
9100 target "http://www.springer.de/author/tex/help-journals.html"
9104 , where you should also go to fetch the class files (yes, these are LaTeX2e
9106 It is a modular system: the things common to all journals are implemented
9111 , which journal-specific layout files (such as, e.\InsetSpace \thinspace{}
9116 for Journal of Geodesy) can include.
9119 \begin_layout Standard
9120 This means that implementing support for any other Springer journal on this
9121 list is as simple as writing your own
9129 file following the outline given in
9137 \begin_layout Standard
9138 It is reasonably well tested only for the Journal of Geodesy.
9147 come with the standard LyX distribution.
9148 Install the relevant class file (downloaded from Springer) in a proper
9149 directory, reconfigure LaTeX (in the teTeX case by running
9153 , as root if necessary --- doesn't LyX take care of this?), reconfigure
9154 LyX and it should work.
9157 \begin_layout Subsection
9161 \begin_layout Standard
9162 A large number of theorem-like styles ---
9168 \SpecialChar \ldots{}
9174 \begin_layout Standard
9177 Headnote, Dedication, Subtitle, Running_LaTeX_Title, Author_Running, Institute,
9178 Mail, Offprints, Keywords, Acknowledgements, Acknowledgement
9181 See the Springer class file documentation for details.
9184 \begin_layout Subsection
9188 \begin_layout Itemize
9200 \begin_layout Itemize
9203 Probability Theory and Related Fields
9209 --- Jean-Marc Lasgouttes
9212 \begin_layout Standard
9213 Add your own, it isn't so hard!
9216 \begin_layout Subsection
9220 \begin_layout Standard
9221 These files are partly based on the older
9225 , which was again based on a tinkered-with version of an old LaTeX 2.09 style
9231 layout, are now defunct.
9232 Jean-Marc Lasgouttes helped out big in making me find my way around the
9233 LyX layout file mechanism.
9236 \begin_layout Subsection
9240 \begin_layout Standard
9242 But probably less than in the old hacked-LaTeX
9249 \begin_layout Standard
9250 Limitations e.\InsetSpace \thinspace{}
9251 g.: does not display the number for theorem-like layouts, just
9255 \begin_layout Section
9263 \begin_layout Standard
9269 \begin_layout Subsection
9273 \begin_layout Standard
9274 These are the layout files for some of the journals of the American Geophysical
9276 It is assumed that you have both the AGU's own class files and AGUplus
9277 installed (everything to be found at
9278 \begin_inset LatexCommand url
9279 target "ftp://ftp.agu.org/journals/latex/journals"
9286 \begin_layout Subsection
9290 \begin_layout Standard
9300 They are still called this in the LyX GUI, though their LaTeX equivalents
9301 in the AGU classes are
9312 \begin_layout Standard
9313 Newly defined styles are
9350 These are mostly manuscript attributes and defined in the AGU class documentati
9354 \begin_layout Standard
9355 I suspect this is still badly incomplete.
9358 \begin_layout Subsection
9362 \begin_layout Standard
9379 \begin_layout Subsection
9383 \begin_layout Itemize
9386 Journal of Geophysical Research
9395 \begin_layout Standard
9396 Add your own, it isn't so hard! Look at the
9407 \begin_layout Subsection
9408 Bugs and things to remember
9411 \begin_layout Standard
9412 In order to use the new layouts, you must remember to do the following for
9416 \begin_layout Enumerate
9422 This can be done in the
9424 layout\SpecialChar \menuseparator
9429 document\SpecialChar \menuseparator
9433 (AGU articles are always in English, right? So
9440 \begin_layout Enumerate
9450 (Yes, this is a bug.)
9453 \begin_layout Enumerate
9454 Make sure you use the
9458 bibliography style, by entering
9462 into the second field of the BibTeX inset.
9463 None of the standard styles will do.
9466 \begin_layout Section
9474 \begin_layout Standard
9480 \begin_layout Subsection
9484 \begin_layout Standard
9485 This is the layout file for the European Geophysical Society journals.
9490 can be downloaded from the web site of the EGS under
9491 \begin_inset LatexCommand url
9492 target "www.copernicus.org"
9499 \begin_layout Subsection
9503 \begin_layout Standard
9506 Right_address, Latex_Title, Affil, Journal, msnumber, FirstAuthor, Received,
9514 The current layout file is unfortunately very unmodular and would benefit
9515 from using the various
9522 \begin_layout Section
9528 \begin_inset LatexCommand label
9536 \begin_layout Standard
9544 \begin_layout Subsection
9548 \begin_layout Standard
9549 This section describes how to use LyX to make slides for overhead projectors.
9550 There are two document classes that can do this: the default slides class
9556 This section documents the former.
9559 \begin_layout Standard
9560 I'm going to say this again, nice and clear, so that there's no misunderstanding
9564 \begin_layout Standard
9565 \begin_inset VSpace bigskip
9571 \begin_layout Standard
9575 This section documents the class
9576 \begin_inset Quotes eld
9584 \begin_inset Quotes erd
9592 \begin_layout Standard
9593 \begin_inset VSpace bigskip
9599 \begin_layout Standard
9600 If you're looking for the documentation for
9601 \begin_inset Quotes eld
9609 \begin_inset Quotes erd
9612 , check out section\InsetSpace ~
9614 \begin_inset LatexCommand ref
9615 reference "sec:foiltex"
9625 \begin_inset Quotes eld
9633 \begin_inset Quotes erd
9636 ] is actually somewhat better than the default
9644 \begin_layout Standard
9645 \SpecialChar \ldots{}
9646 or so I've been told repeatedly by its advocates.
9647 Having never used it, I have no idea if this claim is true or not.
9652 which this section documents.
9655 \begin_layout Standard
9656 This class is the LaTeX2e improvement of the old
9661 Every LaTeX2e distribution includes this class [which I'll just refer to
9663 \begin_inset Quotes eld
9671 \begin_inset Quotes erd
9674 from now on], so you're bound to have it.
9675 As I noted earlier, there are other classes, such as
9679 , which also produce slides for overhead projectors and do a better job
9681 However, there are some things which
9685 can do which the others can't, such as generate overlays.
9686 Read on to learn more!
9689 \begin_layout Subsection
9691 \begin_inset LatexCommand label
9692 name "sec:slidesetup"
9699 \begin_layout Standard
9700 Obviously, to use this document class, you need to select
9701 \begin_inset Quotes eld
9709 \begin_inset Quotes erd
9712 from the class list in the
9717 ocument\SpecialChar \menuseparator
9725 There are some other special things you should know about this class:
9728 \begin_layout Itemize
9729 Don't bother changing the options
9734 They're not supported by the
9741 \begin_layout Itemize
9750 behaves a bit differently for this class.
9751 The possible choices and what they do are as follows:
9755 \begin_layout Description
9760 The final output contains page numbers in the lower right corner.
9763 \begin_layout Description
9772 , but also prints out any time markers you've put in.
9773 This is the default.
9776 \begin_layout Description
9781 The final output contains no page numbers, time markers, or alignment markers.
9785 \begin_layout Itemize
9790 class has an extra option:
9796 \begin_inset Quotes eld
9804 \begin_inset Quotes erd
9807 in the extra class options.
9811 \begin_layout Standard
9812 Using this options allows you to add time markers to
9817 See section\InsetSpace ~
9819 \begin_inset LatexCommand ref
9820 reference "sec:slideNote"
9828 \begin_layout Standard
9829 You can also use the template file
9830 \begin_inset Quotes eld
9838 \begin_inset Quotes erd
9841 to automatically set up a document to use the
9850 ile\SpecialChar \menuseparator
9859 to open your new document].
9860 The template file also contains some examples of the special paragraph
9861 environments used by this class.
9862 I'll describe those next.
9865 \begin_layout Subsection
9866 Paragraph Environments
9869 \begin_layout Subsubsection
9870 Supported Environments
9873 \begin_layout Standard
9874 The first thing you'll notice when you start up a new
9878 document is the font size and type: it's the equivalent of the size
9879 \begin_inset Quotes eld
9887 \begin_inset Quotes erd
9896 This is also what's used in the output.
9898 \begin_inset Quotes eld
9902 \begin_inset Quotes erd
9905 to remind you that this is a slide.
9906 Your final slides will use a larger font; ergo, you'll have less space.
9907 Of course, the larger default screen font isn't WYSIWYG, only a reminder.
9910 \begin_layout Standard
9911 The next thing that becomes obvious is the changes to the paragraph environment
9912 pull-down box [at the far-left end of the toolbar].
9913 Most of the paragraph environments you're used to seeing are missing.
9914 There are also five new ones.
9919 class itself only supports certain paragraph environments:
9922 \begin_layout Itemize
9928 \begin_layout Itemize
9934 \begin_layout Itemize
9940 \begin_layout Itemize
9946 \begin_layout Itemize
9952 \begin_layout Itemize
9958 \begin_layout Itemize
9964 \begin_layout Itemize
9970 \begin_layout Itemize
9976 \begin_layout Itemize
9982 \begin_layout Itemize
9988 \begin_layout Standard
9989 All of the other standard environments, including the section-heading environmen
9990 ts, aren't used in the
9997 \begin_layout Standard
9998 On the other hand, you'll notice the following new environments:
10001 \begin_layout Itemize
10007 \begin_layout Itemize
10013 \begin_layout Itemize
10019 \begin_layout Itemize
10025 \begin_layout Itemize
10031 \begin_layout Standard
10032 These five are kind of quirky, due to a
10033 \begin_inset Quotes eld
10037 \begin_inset Quotes erd
10041 You see, LyX doesn't permit you to nest any other paragraph environment
10042 into an empty environment.
10043 Now, that's fine and dandy, but it means that you wouldn't be able to start
10044 a slide with anything except plain text.
10045 To deal with this, I've performed a little
10046 \begin_inset Quotes eld
10050 \begin_inset Quotes erd
10056 \begin_layout Subsubsection
10057 Quirks of the New Environments
10058 \begin_inset LatexCommand label
10059 name "sec:slideQuirk"
10066 \begin_layout Standard
10067 All five of the new paragraph environments are somewhat quirky due to inherent
10068 limitiations in the current version of LyX.
10069 As I just mentioned, LyX forbids environments that begin with another environme
10071 To get around this, the
10075 environment isn't a paragraph environment as described in the
10083 \begin_layout Standard
10084 You should consider
10097 \begin_inset Quotes eld
10100 pseudo-environments.
10101 \begin_inset Quotes erd
10104 They look like a section heading or a
10105 \begin_inset Quotes eld
10113 \begin_inset Quotes erd
10116 but really begin a [and, if necessary, end the previous] paragraph environment.
10126 \begin_inset Quotes eld
10130 \begin_inset Quotes erd
10133 These two perform some action.
10136 \begin_layout Standard
10137 A common feature of all five environments,
10157 , is a rather long-ish label.
10158 The text following this label --- ordinarily the contents of the paragraph
10159 environment --- is utterly irrelevant for
10180 LyX completely ignores it.
10181 In fact, you can leave these five environments completely empty.
10185 \begin_layout Standard
10190 to put any text after the rather long-ish label, you might want to.
10191 This could be a short description of the contents of the
10196 In that case, enter in your descriptive comment and hit
10200 as you normally would.
10203 \begin_layout Standard
10204 If, on the other hand, you don't want to enter in any descriptive text,
10205 you'll hit another LyX quirk.
10206 LyX, like nature, abhors a vacuum, and will not let you start a new paragraph
10207 environment until you put something in the old one.
10211 \begin_layout Itemize
10212 Start entering the text that will
10240 \begin_layout Itemize
10241 Now move to the beginning of that paragraph.
10245 \begin_layout Itemize
10254 \begin_layout Itemize
10255 Finally, change this new, empty paragraph to a
10279 \begin_layout Standard
10280 Some future version of LyX will, hopefully, resolve this quirkiness\SpecialChar \ldots{}
10284 \begin_layout Subsection
10285 Making a Presentation with
10298 \begin_layout Subsubsection
10306 \begin_layout Standard
10307 If you're expecting this section to teach you how to actually make a presentatio
10308 n, you'll be sorely disappointed.
10309 Naturally, I'll describe all of the ways the
10313 class can assist you in preparing the materials for a presentation.
10314 Filling in the contents, however, is up to you.
10319 the LyX philosophy.]
10322 \begin_layout Standard
10327 environment [in the manner described in section\InsetSpace ~
10329 \begin_inset LatexCommand ref
10330 reference "sec:slideQuirk"
10334 ] tells LyX to begin a new slide [duh].
10335 The label for this environment/
10336 \begin_inset Quotes erd
10340 \begin_inset Quotes erd
10344 \begin_inset Quotes eld
10348 \begin_inset Quotes erd
10351 in cool blue, followed by the label,
10352 \begin_inset Quotes eld
10356 \begin_inset Quotes erd
10360 Any text or paragraph environments that follow this one go on the new slide.
10364 \begin_layout Standard
10365 Slides are probably the only time you'll need to forcibly end pages in LyX
10366 (this can be specified in the
10371 In fact, you'll want to, once you finish entering the contents of one slide.
10372 If you've entered more text than can physically fit on a slide, the extra
10373 overflows onto a new slide.
10374 I don't recommend doing this, however, since the overflow slide won't have
10375 any page number on it.
10376 Furthermore, it may interfere with any
10380 you've made to accompany the oversized
10387 \begin_layout Standard
10396 environments work the same way as the
10401 They both create an
10402 \begin_inset Quotes eld
10406 \begin_inset Quotes erd
10409 followed by a label [
10410 \begin_inset Quotes eld
10414 \begin_inset Quotes erd
10418 \begin_inset Quotes eld
10422 \begin_inset Quotes erd
10426 The color is a stunning magenta instead of blue, and the
10427 \begin_inset Quotes eld
10431 \begin_inset Quotes erd
10434 will look different, in style and in length.
10435 The label fonts of all three also differ from one another.
10438 \begin_layout Standard
10443 , if the contents of a
10451 exceed the physical size of a slide or sheet of paper, the extra will overflow
10453 Again, you should avoid this.
10454 It defeats the whole purpose of
10465 \begin_layout Subsubsection
10475 \begin_layout Standard
10480 is a slide that sits atop another slide.
10481 Perhaps you wish to discuss a figure on the main
10485 before displaying the text associated with it.
10486 One way to accomplish this is tape a flap of dark paper over the part of
10491 you want to display later.
10492 This method fails, however, if you wish to overlap one graph with another,
10494 You would then have to fumble while speaking to align the two separate,
10499 s to align the two graphs.
10504 environment in both cases makes life much easier.
10507 \begin_layout Standard
10512 receives the page number of its
10513 \begin_inset Quotes eld
10517 \begin_inset Quotes erd
10525 \begin_inset Quotes eld
10533 \begin_inset Quotes erd
10540 \begin_layout Standard
10541 Presumably, mutliple
10546 \begin_inset Quotes eld
10554 \begin_inset Quotes erd
10558 \begin_inset Quotes eld
10566 \begin_inset Quotes erd
10570 \begin_inset Quotes eld
10578 \begin_inset Quotes erd
10581 , etc.\InsetSpace ~
10582 appended to the page number of the parent
10592 Clearly, you want the contents of both the
10600 to each fit on a single physical slide! You should probably consider an
10606 \begin_inset Quotes eld
10610 \begin_inset Quotes erd
10622 class provides a visual cue for this: the label at the start of an
10626 is shorter than that at the start of a
10631 Lastly, when you generate printable output, you'll find alignment markers
10632 in all four corners of both the
10636 page and its parent
10641 These will assist you in lining up the two physical slides.
10644 \begin_layout Standard
10645 The major problem in overlaying two slides is aligning the contents of the
10646 two transparencies.
10647 How much space should you leave for that graph on the second slide? Worse
10648 still, what if you want a graph and a sentence on second slide, but there
10649 is text on the main transparency that goes in between them? You could try
10650 and insert vertical space of the right size.
10651 The better way is to use
10662 \begin_layout Standard
10663 As their names imply,
10671 are two command-like paragraph environments that make all subsequent text
10672 invisible and visible, respectively.
10673 Note from section\InsetSpace ~
10675 \begin_inset LatexCommand ref
10676 reference "sec:slideQuirk"
10680 that you don't place anything
10684 these two environments, however.
10689 , it inserts a centered, sky-blue label into the page reading
10690 \begin_inset Quotes eld
10693 <Invisible Text Follows>
10694 \begin_inset Quotes erd
10698 For paragraphs following this label, the parts of the
10706 ; it doesn't matter which] where they would be contain instead blank space.
10710 \begin_layout Standard
10715 , the corresponding centered label is
10716 \begin_inset Quotes eld
10719 <Visible Text Follows>
10720 \begin_inset Quotes erd
10724 Paragraphs following this label behave normally.
10725 Note that the beginning of a new
10737 automatically shuts off an
10742 It's therefore not necessary to use
10753 \begin_layout Standard
10754 By now, it should be obvious how to create overlay transparencies using
10755 the proper combination of
10774 \begin_layout Enumerate
10779 , including everything that will appear on it, whether on the main slide
10787 \begin_layout Enumerate
10788 Before each figure or paragraph that will appear only on the
10797 If necessary, insert a
10801 environment after the
10808 \begin_layout Enumerate
10813 immediately following the
10820 \begin_layout Enumerate
10821 Copy the contents of this
10832 \begin_layout Enumerate
10837 , change all of the
10848 \begin_layout Standard
10850 You've just made an
10857 \begin_layout Standard
10858 There's one problem with the way I've designed the LyX
10862 class: you can't make text in the middle of a paragraph invisible, nor
10863 make text in the middle of an invisible paragraph visible again.
10864 To accomplish this feat, you'll need to use some inlined LaTeX codes.
10868 \begin_layout Standard
10869 The commands of interest are:
10872 \begin_layout Itemize
10877 invisible \SpecialChar \ldots{}
10881 \begin_layout Itemize
10886 visible \SpecialChar \ldots{}
10890 \begin_layout Standard
10891 \SpecialChar \ldots{}
10892 and need to be marked as TeX.
10894 \begin_inset Quotes eld
10898 \begin_inset Quotes erd
10901 you wish to change goes in between the brackets [and after the
10914 If you don't know how to mark text as TeX, see the appropriate section
10927 \begin_layout Subsubsection
10937 \begin_inset LatexCommand label
10938 name "sec:slideNote"
10945 \begin_layout Standard
10954 is associated with a
10955 \begin_inset Quotes eld
10959 \begin_inset Quotes erd
10971 class provides visual cues.
10976 is shorter than that of a
10980 [yet longer than that of an
10984 ] and, like the label of an
10988 is shockingly magenta.
10989 Additionally, the printed
10993 has the page number of its
10994 \begin_inset Quotes eld
10998 \begin_inset Quotes erd
11006 \begin_inset Quotes eld
11014 \begin_inset Quotes erd
11018 \begin_inset Quotes eld
11026 \begin_inset Quotes erd
11030 \begin_inset Quotes eld
11038 \begin_inset Quotes erd
11042 You can have multiple
11046 s associated with a single
11058 , you'll probably want to break up long
11062 s so that they fit on a single sheet of paper.
11065 \begin_layout Standard
11070 is obvious: it contains anything additional you might want to say about
11076 It could also be used as a sheet of reminders for a particular
11081 In the case of the latter, you might want to make use of time markers.
11087 \begin_inset Quotes eld
11091 \begin_inset Quotes erd
11094 support for time markers, a
11099 So, you'll have to resort to using the LaTeX codes.
11102 \begin_layout Standard
11103 To use time markers, you'll need to specify the extra class option
11104 \begin_inset Quotes eld
11112 \begin_inset Quotes erd
11115 [see section\InsetSpace ~
11117 \begin_inset LatexCommand ref
11118 reference "sec:slidesetup"
11123 This option turns on timing marks, which will appear in the lower-left-hand
11129 To set what appears in the time marker, you use the LaTeX commands
11130 \begin_inset Quotes eld
11140 \begin_inset Quotes erd
11144 \begin_inset Quotes eld
11154 \begin_inset Quotes erd
11158 The arguments of both commands are time measured in seconds.
11160 \begin_inset Quotes eld
11170 \begin_inset Quotes erd
11173 sets the time marker to a given time.
11175 \begin_inset Quotes eld
11185 \begin_inset Quotes erd
11188 increments the time marker by the specified amount.
11189 Using time markers and
11193 s in this fashion, you can remind yourself how much time to spend on a particula
11201 \begin_layout Standard
11202 There's one last feature to describe.
11203 Clearly, you'd like to print out all of your
11211 s on transparencies while printing all of your
11228 with which it is associated.
11229 What's a person to do?
11232 \begin_layout Standard
11233 Luckily, there are two LaTeX commands that allow you to select what to print
11235 Both must be placed into the preamble of your document.
11237 \begin_inset Quotes eld
11249 \begin_inset Quotes erd
11252 will cause the output to contain only the
11261 Correspondingly, the command
11262 \begin_inset Quotes eld
11274 \begin_inset Quotes erd
11277 prevents the output of anything but
11282 I'd advise placing both commands in the preamble and initially comment
11284 You can then preview your entire presentation as you write.
11285 When you're done writing, you can then uncomment one of the two to select
11286 what you want to print.
11287 I like to uncomment
11288 \begin_inset Quotes eld
11300 \begin_inset Quotes erd
11303 , print to a file with
11304 \begin_inset Quotes eld
11312 \begin_inset Quotes erd
11315 in its name, comment it back out, then uncomment
11316 \begin_inset Quotes eld
11328 \begin_inset Quotes erd
11332 \begin_inset Quotes eld
11340 \begin_inset Quotes erd
11344 I can then send either file to a printer, loading transparencies or plain
11345 paper as appropriate.
11348 \begin_layout Standard
11349 You can also provide other arguments to the
11350 \begin_inset Quotes eld
11360 \begin_inset Quotes erd
11364 \begin_inset Quotes eld
11374 \begin_inset Quotes erd
11378 See a good LaTeX book for details.
11381 \begin_layout Subsection
11386 Class Template File
11389 \begin_layout Standard
11390 I have also provided a template file,
11391 \begin_inset Quotes eld
11399 \begin_inset Quotes erd
11407 To use it, begin your new presentation with
11412 ile\SpecialChar \menuseparator
11422 Your new LyX presentation file will contain an example
11443 additionally contain an example of the use of
11452 Lastly, the preamble will contain:
11455 \begin_layout LyX-Code
11456 % Uncomment to print out only slides and overlays
11459 \begin_layout LyX-Code
11463 \begin_layout LyX-Code
11473 \begin_layout LyX-Code
11474 % Uncomment to print out only notes
11477 \begin_layout LyX-Code
11481 \begin_layout LyX-Code
11489 \begin_layout Standard
11490 One final thing: I created this class to support the LaTeX2e
11491 \begin_inset Quotes eld
11499 \begin_inset Quotes erd
11502 class, one of the built-in LaTeX2e classes.
11503 Neither I nor the rest of the LyX Team endorse or oppose the use of this
11504 built-in slide class.
11505 It's here if you want it or need it.
11506 There exist other LaTeX2e classes for creating presentations, such as the
11511 class [see section\InsetSpace ~
11513 \begin_inset LatexCommand ref
11514 reference "sec:foiltex"
11519 \begin_inset Quotes eld
11527 \begin_inset Quotes erd
11530 package [present on some TeX distributions].
11531 The latter is not yet supported under LyX.
11535 \begin_layout Standard
11536 Perhaps you can take on the task\SpecialChar \ldots{}
11542 I know nothing about these other classes.
11543 Try them out to see what sort of alternative they provide.
11546 \begin_layout Section
11555 \begin_inset LatexCommand label
11563 \begin_layout Standard
11569 \begin_layout Subsection
11573 \begin_layout Standard
11574 This section describes how to use LyX to make slides for overhead projectors.
11575 There are two document classes that can do this: the default slides class
11581 This section documents the latter.
11584 \begin_layout Standard
11585 I'm going to say this again, nice and clear, so that there's no misunderstanding
11589 \begin_layout Standard
11590 \begin_inset VSpace bigskip
11596 \begin_layout Standard
11600 This section documents the class
11601 \begin_inset Quotes eld
11609 \begin_inset Quotes erd
11617 \begin_layout Standard
11618 \begin_inset VSpace bigskip
11624 \begin_layout Standard
11625 If you're looking for the documentation for
11626 \begin_inset Quotes eld
11634 \begin_inset Quotes erd
11637 , check out section\InsetSpace ~
11639 \begin_inset LatexCommand ref
11640 reference "sec:slitex"
11645 If your machine doesn't have the
11650 \begin_inset Quotes eld
11658 \begin_inset Quotes erd
11661 ] installed, you'll probably have to use the default
11665 class, which isn't quite as good as
11670 \begin_layout Standard
11675 class is designed for use with version 2.1 of the
11679 LaTeX class file which is now an integral part of LaTeX2e.
11682 \begin_layout Subsection
11686 \begin_layout Standard
11687 Obviously, to use this document class, you need to select
11688 \begin_inset Quotes eld
11696 \begin_inset Quotes erd
11708 Document\InsetSpace ~
11712 There are some settings in the
11714 Document\InsetSpace ~
11717 dialog that you should know about that are specific to this class:
11720 \begin_layout Itemize
11721 Don't change the options
11731 Document\InsetSpace ~
11735 They're ignored by the
11742 \begin_layout Itemize
11743 The default font size is 20pt with the other options being 17pt, 25pt and
11747 \begin_layout Itemize
11748 The default font is
11756 but all math equations are still typeset in the usual roman font.
11759 \begin_layout Itemize
11764 TeX supports A4 and Letter paper sizes as well as a special size for working
11766 It doesn't support A5, B5, legal or executive paper sizes.
11769 \begin_layout Itemize
11770 Don't bother changing the
11774 settings because they are ignored anyway.
11775 All floats appear where they are defined in the text.
11778 \begin_layout Itemize
11786 setting behaves a bit differently for this class.
11791 TeX provides extensive footer and header capabilities including a user-defined
11793 See section\InsetSpace ~
11795 \begin_inset LatexCommand ref
11796 reference "sec:foilfoot"
11801 The title page is treated differently to all other pages in the document
11810 has the logo centered at the bottom of the page (if one is defined).
11811 The possible page style choices and what they do are as follows:
11816 \labelwidthstring MMMMMMM
11823 The final output contains no page numbers, or other headers or footers
11824 (except footnotes of course).
11829 \labelwidthstring MMMMMMM
11836 The final output contains page numbers centered at the bottom of the page.
11837 No other headings or footers (other than footnotes).
11841 \labelwidthstring MMMMMMM
11846 Page numbers in lower right corner.
11847 Additional headers and footers are also shown.
11848 This is also the default.
11852 \labelwidthstring MMMMMMM
11857 Gives you access to the
11861 package although its use with
11865 TeX is discouraged by the writer of the
11869 TeX package because of some potential page layout clashes.
11873 \begin_layout Subsubsection
11877 \begin_layout Standard
11878 The following options may be used in the extra class options in the
11883 ocument\SpecialChar \menuseparator
11894 \labelwidthstring MMMMMMx
11899 This sets up the page layout for 7.33in by 11in paper, which is about the
11900 same aspect ratio as a 35mm slide, making it a bit easier to work with
11905 \labelwidthstring MMMMMMx
11910 Places a rule across the page below the header on every page except the
11915 \labelwidthstring MMMMMMx
11920 Places a rule across the page above the footer on every page except the
11925 \labelwidthstring MMMMMMx
11930 This is automatically set each time you create a new
11939 TeX to use the dvips driver to rotate those pages that are set as landscape
11944 \labelwidthstring MMMMMMx
11949 Simply changes the page dimensions to those of a landscape page but doesn't
11951 Thus if you use this option you need to use an external program to rotate
11952 each page or feed your paper through your printer as landscape.
11953 Note that this option effectively reverses the roles of the
11961 environments (don't worry these are described in the next section).
11965 \labelwidthstring MMMMMMx
11970 Equation numbers on the left.
11974 \labelwidthstring MMMMMMx
11979 Flush-left equations.
11982 \begin_layout Subsection
11983 Supported Environments
11986 \begin_layout Standard
11987 Most of the environments commonly supported in other classes are also supported
11993 There are several additional environments provided by
11997 TeX as well as a couple added by LyX.
11998 The following environments are shared with other classes:
12001 \begin_layout Standard
12005 \begin_layout Standard
12009 begin{multicols}{2}
12017 \begin_layout Itemize
12023 \begin_layout Itemize
12029 \begin_layout Itemize
12035 \begin_layout Itemize
12041 \begin_layout Itemize
12047 \begin_layout Itemize
12053 \begin_layout Itemize
12059 \begin_layout Itemize
12065 \begin_layout Itemize
12071 \begin_layout Itemize
12077 \begin_layout Itemize
12083 \begin_layout Itemize
12089 \begin_layout Itemize
12095 \begin_layout Itemize
12101 \begin_layout Itemize
12107 \begin_layout Itemize
12113 \begin_layout Itemize
12119 \begin_layout Itemize
12125 \begin_layout Standard
12129 \begin_layout Standard
12141 \begin_layout Standard
12142 That is, all the major environments apart from the sectioning environments.
12143 Since foils are essentially self-contained sections, with a title and body,
12148 TeX provides specific commands for starting new foils and these are:
12151 \begin_layout Itemize
12157 \begin_layout Itemize
12163 \begin_layout Standard
12164 LyX also provides slightly modified versions of these two environments called:
12167 \begin_layout Itemize
12173 \begin_layout Itemize
12176 ShortRotatefoilhead
12179 \begin_layout Standard
12180 and the differences will be explained in the next section.
12183 \begin_layout Standard
12184 Since foils are often used in presenting ideas or new theorems and such
12189 TeX also provides a comprehensive box of goodies for presenting them:
12192 \begin_layout Standard
12196 \begin_layout Standard
12200 begin{multicols}{2}
12208 \begin_layout Itemize
12214 \begin_layout Itemize
12220 \begin_layout Itemize
12226 \begin_layout Itemize
12232 \begin_layout Itemize
12238 \begin_layout Itemize
12244 \begin_layout Itemize
12250 \begin_layout Itemize
12256 \begin_layout Itemize
12262 \begin_layout Itemize
12268 \begin_layout Itemize
12274 \begin_layout Standard
12278 \begin_layout Standard
12290 \begin_layout Standard
12291 The starred versions are unnumbered while the unstarred versions are numbered.
12292 There are also two list environments added by LyX and these are:
12295 \begin_layout Itemize
12301 \begin_layout Itemize
12307 \begin_layout Standard
12312 TeX provides some powerful header and footer capabilities that are best
12313 set in the preamble although they may be set at any point in a document.
12314 If you want to change these settings in your document the best place to
12315 do so is at the very top of a foil,
12320 straight after the foilhead.
12323 \begin_layout Standard
12324 For this purpose, the following command styles are provided [
12331 \begin_layout Standard
12335 \begin_layout Standard
12339 begin{multicols}{2}
12347 \begin_layout Itemize
12354 \begin_layout Itemize
12360 \begin_layout Itemize
12367 \begin_layout Itemize
12374 \begin_layout Itemize
12382 \begin_layout Standard
12388 \begin_layout Standard
12392 \begin_layout Standard
12404 \begin_layout Standard
12405 There are also a few commands provided by
12409 TeX that aren't directly supported by LyX but I'll tell you what they do
12410 and how to use them in section\InsetSpace ~
12412 \begin_inset LatexCommand ref
12413 reference "sec:unsuppfoils"
12420 \begin_layout Subsection
12421 Building a Set of Foils
12424 \begin_layout Standard
12425 This section will give a simple introduction to using the different environments
12426 to build a set of foils.
12427 If you want to see an example set of foils take a look at the
12431 file accessible from the
12436 ile\SpecialChar \menuseparator
12441 pen\SpecialChar \ldots{}
12452 \begin_layout Subsubsection
12453 Give It a Title Page
12456 \begin_layout Standard
12457 Unlike other classes that provide
12477 creates the title on a page of its own.
12478 If you leave out the
12482 environment LaTeX will substitute the current date (every time you regenerate
12486 \begin_layout Subsubsection
12490 \begin_layout Standard
12491 As I mentioned earlier, there are four ways of starting a new foil.
12492 For portrait foils you should use
12501 The difference between these two environments is the amount of space between
12502 the title of the foil (the foilhead) and the body of the foil.
12505 \begin_layout Standard
12506 Landscape foils are generated using the
12512 ShortRotatefoilhead
12515 Again the only difference is the spacing between foilhead and body.
12516 Both of the short versions have 0.5 inches less separation between the foilhead
12521 \begin_layout Standard
12522 One problem with the support for landscape foils is the requirement that
12523 you have to use the
12527 driver to generate the PostScript output otherwise the foils won't be rotated.
12528 It is possible to get landscape foils even if you haven't got the
12532 driver provided you can feed your foils sideways through your printer ;-)
12535 \begin_layout Subsubsection
12536 Theorems, Lemmas, Proofs and more
12539 \begin_layout Standard
12540 Due to a small bug in LyX you can't have two of the same type of these environme
12541 nts directly following each other.
12542 They must be separated by something.
12543 If you try, you will just be extending the previous environment as if you
12544 had merged the two environments together.
12545 So, how do you get around this problem? The simplest option is to insert
12546 some text between the two environments or add a
12550 environment between the two with just a
12551 \begin_inset Quotes eld
12559 \begin_inset Quotes erd
12563 This will force LyX to produce two separate environments and hence the
12564 correct LaTeX output.
12565 An example is provided in the example file included with the LyX distribution.
12566 Remember, this problem only occurs if you are trying to place two of the
12567 same type of theorem-like environments one directly after the other.
12570 \begin_layout Subsubsection
12574 \begin_layout Standard
12575 You get all the commonly supported list styles found in other classes as
12576 well as two new ones.
12577 I'll only describe the new ones here.
12578 If you want to find out more about the other list environments check out
12584 If you intend to use itemized lists you might also want to read about the
12587 Itemize\InsetSpace ~
12588 Bullet\InsetSpace ~
12591 dialog described above in section\InsetSpace ~
12593 \begin_inset LatexCommand ref
12594 reference "sec:bullet"
12601 \begin_layout Standard
12602 The two new list styles,
12610 , are designed to make it easier for you to create lists of do's and don'ts
12611 or right and wrong by providing dedicated environments that use a tick
12612 or a cross as the label of the list.
12613 These lists are in fact dedicated variants of the
12618 They do however require that you have the
12622 packages installed.
12625 \begin_layout Subsubsection
12629 \begin_layout Standard
12634 TeX redefines the floating tables and figures so that they appear exactly
12635 where they are in the text rather than pushing them to the top of the page
12636 or to some user specified location.
12637 In fact if you change the float placement settings they are simply ignored.
12640 \begin_layout Subsubsection
12641 Page Headers and Footers
12642 \begin_inset LatexCommand label
12643 name "sec:foilfoot"
12650 \begin_layout Standard
12660 are two commands used to control the left-footer text string.
12661 The first is meant to allow you to include a graphic logo on your foils
12663 \begin_inset Quotes eld
12671 \begin_inset Quotes erd
12675 While the second is meant to provide a classification for the audience,
12678 e.\InsetSpace \thinspace{}
12683 It is empty by default.
12686 \begin_layout Standard
12687 The remaining page corners can be filled by
12692 (which defaults to page numbers),
12705 \begin_layout Subsection
12711 \begin_inset LatexCommand label
12712 name "sec:unsuppfoils"
12719 \begin_layout Standard
12720 All the commands mentioned below need to be set in a
12728 within another environment.
12731 \begin_layout Subsubsection
12735 \begin_layout Standard
12736 All lengths are adjusted using the
12759 should be replaced by the name given to the length you want to change and
12764 is the length value.
12765 All lengths should be specified in units of length such as inches (
12777 ) or relative to some document or font-based length such as
12787 \begin_layout Standard
12788 It's possible to change the spacing between a foilhead and the body of the
12789 foil by adjusting the length specified by
12796 For example, to make
12800 foilheads 0.5 inches closer to their bodies put the following in the preamble:
12807 foilheadskip}{-0.5in}
12810 \begin_layout Standard
12811 The spacings around floats can be adjusted by setting these lengths:
12815 \labelwidthstring MMMMMMMMMMM
12822 Separation between the text and the top of the float
12826 \labelwidthstring MMMMMMMMMMM
12833 Separation between the float and the caption
12837 \labelwidthstring MMMMMMMMMMM
12844 Separation between the caption and the following text
12848 \labelwidthstring MMMMMMMMMMM
12855 You can make the captions narrower than the surrounding text by adjusting
12857 Best done relative to
12866 \begin_layout Standard
12867 There are also several title page related lengths that you may find useful
12868 if you have a long title or several authors:
12872 \labelwidthstring MMMMMMMMMMM
12879 Separation from headers to
12885 \labelwidthstring MMMMMMMMMMM
12904 \labelwidthstring MMMMMMMMMMM
12919 \labelwidthstring MMMMMMMMMMM
12936 \labelwidthstring MMMMMMMMMMM
12952 \begin_layout Standard
12953 The last length related command affects all the list environments.
12964 a list environment then all the vertical spacing between the list items
12966 Note that this is a command not a length so it doesn't require
12972 like the stuff mentioned above.
12975 \begin_layout Subsubsection
12976 Headers and Footers
12979 \begin_layout Standard
12992 commands control whether the logo in the
12996 definition appear on a given page.
13003 in the preamble then none of the foils will have the logo on them.
13004 If you don't want the logo on a particular page place the
13010 directly after the foilhead of that page and the
13016 directly after the next foilhead.
13019 \begin_layout Standard
13020 If you decide to use the
13024 page style setting in the
13026 Document\InsetSpace ~
13029 dialog you should probably add
13039 to your preamble so headers and footers on landscape pages are correctly
13040 placed when rotated.
13041 This is due to some clashes between the page layouts provided by the
13052 \begin_layout Section
13053 Latex8 (IEEE Conference Papers)
13056 \begin_layout Standard
13062 \begin_layout Subsection
13066 \begin_layout Standard
13067 Since this class is specifically for writing submissions to IEEE sponsored
13068 conferences I strongly recommend that you get a copy of their Authors Kit.
13073 package and associated bibliography style file is included in the kit.
13074 The Authors Kit is usually sent out by email once your initial submission
13076 There is a lot of useful information in the Authors Kit explaining formatting
13077 restrictions and so on and I will assume you have read this since that
13078 means I don't have to repeat it all here.
13081 \begin_layout Subsection
13085 \begin_layout Standard
13086 [AR\SpecialChar \@.
13090 \begin_layout Subsection
13091 Supported Environments
13094 \begin_layout Itemize
13100 \begin_layout Itemize
13106 \begin_layout Itemize
13112 \begin_layout Itemize
13118 \begin_layout Itemize
13124 \begin_layout Itemize
13130 \begin_layout Itemize
13136 \begin_layout Itemize
13142 \begin_layout Itemize
13148 \begin_layout Subsection
13149 Differences Between Screen and Paper
13152 \begin_layout Standard
13153 There are slight differences in appearance mainly with the presentation
13154 of section counters.
13155 On screen the trailing period of the section counter is missing but it
13156 will appear in the output so don't let this worry you.
13159 \begin_layout Section
13160 Hollywood (Hollywood spec scripts)
13163 \begin_layout Standard
13169 \begin_layout Subsection
13173 \begin_layout Standard
13174 Getting the format of a Hollywood script right is a
13175 \begin_inset Quotes eld
13179 \begin_inset Quotes erd
13182 It is designed to make the readers focus on content and to be easy and
13183 familiar for the actors to read.
13184 Each page of a script should be one minute of film.
13185 Nothing goes in a script that you cannot see or hear on screen.
13186 The courier 12 pt font should be used throughout.
13190 \begin_layout Subsection
13194 \begin_layout Standard
13195 Speakers' lines should NEVER break in mid-sentence.
13196 If a speaker's lines continue over a page break, repeat the
13200 title followed by (Cont'd).
13203 \begin_layout Subsection
13207 \begin_layout Standard
13212 names as labels then cross-reference the label to insert the name.
13213 The cross-reference dialog will show the current cast of characters.
13214 You can use this to insert the speaker name in narratives also.
13217 \begin_layout Subsection
13218 Paper size and Margins
13221 \begin_layout Standard
13222 USLetter, left 1.6in, right 0.75in, top 0.5in, bottom 0.75in
13225 \begin_layout Subsection
13229 \begin_layout Standard
13230 The following environments are available.
13231 You can use hollywood.bind to get the bind keys shown at the right.
13234 \begin_layout Itemize
13241 Used where nothing else works.
13245 \begin_layout Itemize
13258 Usually followed by something like
13259 \begin_inset Quotes eld
13262 on Sally waking up.
13263 \begin_inset Quotes erd
13269 \begin_layout Itemize
13278 Introduces a new INTERIOR camera set-up.
13279 Always followed by DAY or NIGHT, or something similar to define the lighting
13281 Everthing on this line in CAPS.
13284 \begin_layout Itemize
13293 Introduces a new EXTERIOR camera set-up.
13294 Everthing on this line in CAPS.
13297 \begin_layout Itemize
13306 The character speaking.
13309 \begin_layout Itemize
13318 Instructions to the speaker.
13319 The () are automatically inserted, but only the ( will show in LyX.
13320 Both will be printed.
13323 \begin_layout Itemize
13339 \begin_layout Itemize
13348 Camera movement instruction.
13349 e.\InsetSpace \thinspace{}
13354 \begin_layout Itemize
13362 \begin_layout Itemize
13370 \begin_layout Itemize
13378 \begin_layout Itemize
13386 \begin_layout Subsection
13390 \begin_layout Itemize
13391 (O.S) --- off screen
13394 \begin_layout Itemize
13395 (V.0) --- voice over
13398 \begin_layout Itemize
13403 \begin_layout Itemize
13408 \begin_layout Itemize
13409 PAN --- camera movement
13412 \begin_layout Itemize
13413 INSERT --- cut to close-up of
13416 \begin_layout Section
13420 \begin_layout Standard
13426 \begin_layout Subsection
13430 \begin_layout Standard
13431 Broadway is for writing plays.
13432 The format is more decorative than Hollywood, and much less standardized.
13433 This format should be suitable for workshops.
13436 \begin_layout Subsection
13440 \begin_layout Standard
13441 The same as in Hollywood.
13444 \begin_layout Subsection
13448 \begin_layout Standard
13453 names as labels then cross-reference the label to insert the name.
13454 The cross-reference dialog will show the current cast of characters.
13457 \begin_layout Subsection
13458 Paper size and Margins
13461 \begin_layout Standard
13462 USLetter, left 1.6in, right 0.75in, top 0.5in, bottom 0.75in
13465 \begin_layout Subsection
13469 \begin_layout Standard
13470 The following environments are available.
13471 You can use broadway.bind to get the bind keys shown at the right.
13474 \begin_layout Itemize
13481 You should not have to use this, but it is here for anything that does not
13485 \begin_layout Itemize
13494 Used to describe stage setting and the action.
13495 First use of speaker names in all CAPs.
13498 \begin_layout Itemize
13507 Automatically numbered.
13508 On screen it will be arabic, but will print as Roman.
13511 \begin_layout Itemize
13525 It is just centered text.
13528 \begin_layout Itemize
13537 Not automatically numbered.
13538 You supply the number.
13539 This is because I couldn't figure out how.
13542 \begin_layout Itemize
13551 A special case of Narrative to describe the setting and action as the curtain
13555 \begin_layout Itemize
13564 The speaker's (actor's) title, centered in all CAPS.
13567 \begin_layout Itemize
13576 Instructions to the speaker.
13577 The parentheses are automatically inserted.
13578 The ( will appear on screen, but both will be in the printed play.
13579 This environment is only used within
13586 \begin_layout Itemize
13595 What the Speaker says.
13598 \begin_layout Itemize
13607 The curtain comes down.
13610 \begin_layout Itemize
13618 \begin_layout Itemize
13626 \begin_layout Itemize
13634 \begin_layout Standard
13638 \begin_layout Section
13642 \begin_layout Standard
13648 \begin_layout Standard
13649 \begin_inset VSpace bigskip
13655 \begin_layout Standard
13659 Revtex\InsetSpace ~
13662 textclass works with the American Physical Sociey's RevTeX 4.0 (the
13663 \begin_inset Formula $\beta$
13666 release of May, 1999) class.
13669 \begin_layout Standard
13674 textclass, which works with RevTeX 3.1.
13675 However, v3.1 is basically obsolete, as it works with LaTeX 2.09.
13676 That means that it doesn't interact very well with LyX, which requires
13677 LaTeX2e, although it has been kludged to work.
13678 Since RevTeX 4.0 has been designed to work much more cleanly with LaTeX2e,
13681 RevTeX\InsetSpace ~
13684 textclass should also be pretty easy to use.
13687 \begin_layout Standard
13688 These documents are supposed to be used in
13692 to the RevTeX 4.0 documents, so we don't describe any of the special RevTeX
13693 macros, and assume you'll know what to put in the preamble if necessary.
13696 \begin_layout Subsection
13700 \begin_layout Standard
13701 All you need to do is install RevTeX 4, as described in the package's README
13703 The package can be found at
13704 \begin_inset LatexCommand url
13705 name "The RevTeX 4 Web Site"
13706 target "http://publish.aps.org/revtex4/"
13711 Install it somewhere that LaTeX can see it.
13712 Test it by trying to LaTeX a short RevTeX 4 document in some random directory
13713 (i.e., not the directory where you installed the class file.) Then, if you
13714 reconfigure LyX, it will find the class file and let you use the RevTeX4
13718 \begin_layout Standard
13719 Probably the easiest way to get started is either to import a RevTeX 4 document
13726 Revtex\InsetSpace ~
13729 template, found in the templates directory.
13732 \begin_layout Subsection
13736 \begin_layout Standard
13737 Optional arguments to
13744 \begin_inset Quotes eld
13748 \begin_inset Quotes erd
13752 \begin_inset Quotes eld
13756 \begin_inset Quotes erd
13770 Document\InsetSpace ~
13774 Remember that in RevTeX, at least one optional argument is required!
13777 \begin_layout Standard
13778 Other preamble matter, like
13794 dialog, also as usual.
13797 \begin_layout Subsection
13801 \begin_layout Standard
13802 The layouts basically correspond to the commands in RevTeX4.0.
13803 For example, the Email layout corresponds to
13810 Note that (at least as of RevTeX 4.0 Beta), the
13818 layouts are exactly equivalent, so you shouldn't need to use both.
13822 \begin_layout Standard
13823 In case you're curious, both were included so that
13827 would be able to translate both
13847 \begin_layout Subsection
13851 \begin_layout Standard
13852 There are a couple of important unique aspects of RevTeX 4 which might cause
13853 bugs that will be even more confusing in LyX.
13856 \begin_layout Standard
13874 The LyX equivalent is that there is a separate Thanks layout.
13879 write footnotes in the
13883 layout, or weird things may happen.
13884 See the RevTeX 4 documentation for more details.
13887 \begin_layout Standard
13890 Author\InsetSpace ~
13895 Author\InsetSpace ~
13902 layouts must be placed
13910 layout and the corresponding
13927 , the LaTeX won't compile.
13930 \begin_layout Subsection
13934 \begin_layout Standard
13935 The main problem with this layout is that you can't use the optional arguments
13936 to layouts like Email and Title.
13937 (The problem is not unique to this layout; you can't use optional arguments
13938 to the Section layouts either.) This means that after you export that file
13939 to LaTeX (which you'll need to do eventually to send it in to APS), you'll
13940 need to edit the LaTeX file with a text editor to add the optional arguments
13941 to set, e.\InsetSpace \thinspace{}
13942 g., the running title for the page headers.
13943 Lacking these layouts makes the
13949 (and the equivalent
13955 ) useless, so the corresponding layouts don't exist, and will have to be
13960 \begin_layout Standard
13965 actually, LyX 1.3.0 supports some forms of optional arguments, but this layout
13966 has not been updated yet to take advantage of it.
13974 \begin_layout Section
13975 Article (mwart), book (mwbk) and report (mwrep)
13976 \begin_inset OptArg
13979 \begin_layout Standard
13992 \begin_layout Standard
13998 \begin_layout Standard
13999 The LyX document classes
14015 correspond to the LaTeX document classes
14028 They are replacements for the standard document classes
14040 , resp., and fit better to Polish typography conventions in a number of points.
14044 \begin_layout Standard
14048 \begin_layout Itemize
14049 Unnumbered titles (with star, eg.
14054 ) are added into table of contents,
14057 \begin_layout Itemize
14058 Additional page styles:
14062 \begin_layout Description
14063 uheadings header with separated lines,
14066 \begin_layout Description
14067 myheadings custom header, contents headers via commands:
14082 \begin_layout Description
14083 myuheadings custom header with separated lines,
14086 \begin_layout Description
14087 outer page number is placed on outer side of page
14091 \begin_layout Itemize
14096 \begin_layout Description
14097 rmheadings serif titles --- default,
14100 \begin_layout Description
14101 sfheadings sansserif titles,
14104 \begin_layout Description
14105 authortitle on title page first placed is author next title --- default,
14108 \begin_layout Description
14109 titleauthor on title page first placed is title next author,
14112 \begin_layout Description
14113 withmarginpar reserve place on page for margins.
14117 \begin_layout Section
14121 \begin_layout Standard
14127 \begin_layout Standard
14128 Elsevier Science Publishers B.V.
14129 provides a standard LaTeX document class (
14133 ) for submitting articles to their various journals.
14134 The style file can be downloaded directly from their web site:
14135 \begin_inset LatexCommand url
14136 target "http://authors.elsevier.com/"
14141 Instructions are supplied along with the class file, which details the
14142 requirements of the publishers.
14143 LyX includes package that allows for the use of this class, by a layout
14144 and a template file.
14145 Installation of the class file is the same as for any other LaTeX package;
14146 instructions are provided in the Elsevier documentation.
14149 \begin_layout Standard
14159 As the Elsevier class file is based mainly on the standard article class,
14160 most of the normal functionality is provided.
14161 The Elsevier class defines a number of mathematical environments, which
14162 are similar to the AMS environments.
14163 These commands are all described in the Elsevier documentation, and are
14167 \begin_layout Standard
14168 The easiest way to use the Elsevier style is to base documents on the included
14170 It is best not to use options such as fancy headings or the geometry package,
14171 as elements such as these are defined by Elsevier in their style file.
14172 Ideally, no extra packages except those mentioned in the Elsevier documentation
14174 Essentially, Elsevier require as
14175 \begin_inset Quotes eld
14179 \begin_inset Quotes erd
14186 \begin_layout Standard
14195 file as possible, as their intention is to take the supplied file and replace
14196 the class file with one for the particular journal to which the paper has
14198 This also means that not too much time should be spent on the formating
14200 When it comes to be published, this will change anyway.
14201 The rest of the usage for this layout is substantially the same as for
14202 the normal article class.
14203 For details of what Elsevier do and don't allow, refer to their documentation.
14206 \begin_layout Section
14210 \begin_layout Standard
14213 Jürgen Spitzmüller
14216 \begin_layout Subsection
14220 \begin_layout Standard
14221 Memoir is a very powerful and constantly evolving class.
14222 It has been designed with regard to fictional and non-fictional literature.
14223 Its aim is to let the user have maximum control over the typesetting of
14225 Memoir is based on the standard book class, but it can also emulate the
14226 article class (see below).
14229 \begin_layout Standard
14230 Peter Wilson, the developer of Memoir, is known as the author of lots of
14231 useful packages in the LaTeX world.
14232 Most of them have been merged with Memoir.
14233 Therefore, it is much easier to layout the table of contents, appendices,
14234 chapter designs and such.
14235 LyX, though, does not support all of these goodies natively.
14236 Some of them might be added to forthcoming releases
14240 \begin_layout Standard
14241 You are invited to send suggestions to
14242 \begin_inset LatexCommand url
14243 target "lyx-devel@lists.lyx.org"
14252 , lots will probably never, due to the limitations of LyX's framework.
14253 Of course you can still use all features with the help of some native LaTeX
14258 \begin_layout Standard
14263 \begin_layout Standard
14272 section\InsetSpace ~
14274 \begin_inset LatexCommand ref
14275 reference "sec:Inserting-LaTeX-Code"
14285 In this section, we can only list those features which are natively supported
14287 For detailed descriptions (and for the rest of features) we are recommending
14288 to have a look at the detailed manual of the Memoir class
14292 \begin_layout Standard
14297 \begin_layout Standard
14307 \begin_inset LatexCommand url
14308 target "CTAN:/macros/latex/memoir/memman.pdf"
14317 , which is not only a user guide for the class, but also both a comprehensive
14318 description on good typesetting and a superb example for good typesetting
14322 \begin_layout Subsection
14323 Basic features and restrictions
14326 \begin_layout Standard
14327 Memoir supports basically all features of the standard book classes.
14328 There are, however, some differences, as follows:
14331 \begin_layout Description
14333 sizes: Memoir has a broader range of font sizes: 9, 10, 11, 12, 14,
14337 \begin_layout Description
14339 style: The fancy page style is not supported, due to a command clash
14340 between Memoir and the fancyhdr package (they are both defining a command
14341 with the same name, which confuses LaTeX).
14342 Instead, Memoir comes with a bunch of own page styles (see
14344 Layout\SpecialChar \menuseparator
14345 Document\SpecialChar \menuseparator
14350 If you want to use these for the chapter pages, you have to use the command
14357 in the main text or in preamble (e.
14361 \begin_layout Standard
14374 \begin_layout Standard
14387 chapterstyle{companion}
14392 \begin_layout Description
14393 Sectioning: Sectionings (chapter, section, subsection etc.) are coming with
14394 an optional argument in the standard classes.
14395 With this, you can specify an alternative version of the title for the
14396 table of contents and the headers (for instance, if the title is too long).
14397 In LyX, you can do this via
14399 Insert\SpecialChar \menuseparator
14403 at the beginning of a chapter/section.
14404 Memoir features a second optional argument and thus separates the table
14405 of contents from the header.
14406 You can define three variants of a title with this: one for the main text,
14407 one for the table of contents, and one for the headers.
14408 Simply insert two optional arguments if you need this feature, the first
14409 one containing the short title for the Table of Contents, the second one
14410 containing an alternative short title for the headers.
14413 \begin_layout Description
14414 TOC/LOT/LOF: In the standard classes (and in many other classes), the table
14415 of contents, the list of figures and the list of table start a new page
14417 Memoir does not follow this route.
14418 You have to insert a page break yourself, if you want to have one.
14421 \begin_layout Description
14422 Titlepage: For some unknown reason, Memoir uses pagination on the title
14423 page (in the standard classes, title pages are
14424 \begin_inset Quotes eld
14428 \begin_inset Quotes erd
14435 \begin_layout Standard
14448 \begin_layout Standard
14458 If you want an empty title page, type
14462 aliaspagestyle{title}{empty}
14467 \begin_layout Description
14468 Article: With the class option
14474 Layout\SpecialChar \menuseparator
14475 Document\SpecialChar \menuseparator
14479 ), you can emulate article style.
14480 That is, counters (footnotes, figures, tables etc.) will not be reset on
14481 new chapters, chapters don't start a new page (but are---in contrary to
14483 \begin_inset Quotes eld
14487 \begin_inset Quotes erd
14490 article classes---still allowed), parts, though, use their own page, as
14494 \begin_layout Description
14495 Oldfontcommands: By default, Memoir does not allow the use of the deprecated
14496 font commands, which have been used in the old LaTeX version 2.09 (e.
14500 \begin_layout Standard
14513 \begin_layout Standard
14535 It produces an error and stops LaTeX whenever such a command appears.
14540 reallows the commands and spits out warnings instead (which does at least
14542 Since a lot of packages and particularly BibTeX style files are still using
14543 those commands, we have decided to use this option by default.
14546 \begin_layout Subsection
14550 \begin_layout Standard
14551 We will only describe the features supported by LyX (which is not much currently
14553 Please consult the Memoir manual
14557 \begin_layout Standard
14562 \begin_layout Standard
14572 \begin_inset LatexCommand url
14573 target "CTAN:/macros/latex/memoir/memman.pdf"
14585 \begin_layout Description
14586 Abstract: You may wonder why an abstract is an extra feature.
14587 Well, it is in book class.
14588 Usually books don't have abstracts.
14589 Memoir, however, has.
14590 You can use it wherever and how often you like.
14593 \begin_layout Description
14594 Chapterprecis: You may know this from belletristic: The contents of a chapter
14595 is shortly described below the title and also in the table of contents
14600 \begin_layout Standard
14613 \begin_layout Standard
14624 Our hero arrives in Troia; he loses some friends; he finds others
14627 Chapterprecis does exactly this.
14628 It is therefore only sensible below a chapter.
14631 \begin_layout Description
14632 Epigraph: An epigraph is a smart slogan or motto at the beginning of a chapter.
14633 The epigraph environment provides an elegant way of typesetting such a
14635 The motto itself (text) and its author (source) are divided by a short
14637 Unfortunately, we have to fool LyX a bit here again, since the environment
14638 needs two arguments (text and source).
14639 In this case, we have to use curly brackets (in TeX mode) between the two
14650 <author of the slogan>.
14653 \begin_layout Description
14654 Poemtitle: Memoir has lots of possibilities to typeset poetry (up to very
14655 complex figurative poems).
14656 LyX can only support a few of them.
14657 One is poemtitle, which is a centered title for poems, which will also
14658 be added to the table of contents (verse is the standard environment for
14660 Memoir has some enhanced versions of verse, but you need to use ERT, because
14661 they have to be nested inside regular verse environments, which is not
14662 possible with LyX).
14665 \begin_layout Description
14666 Poemtitle*: Same as poemtitle, but it adds no entry to the table of contents.
14669 \begin_layout Chapter
14670 Importing and Exporting Alternate File Formats
14671 \begin_inset OptArg
14674 \begin_layout Standard
14675 Importing and Exporting
14683 \begin_layout Section
14687 \begin_layout Standard
14688 Importing and exporting LyX documents from/to other formats has been touched
14694 Here we describe more of the gory details needed to understand just what
14695 is going on when you click on the
14700 ile\SpecialChar \menuseparator
14712 ile\SpecialChar \menuseparator
14723 \begin_layout Section
14724 Importing Other Formats
14727 \begin_layout Subsection
14731 \begin_layout Standard
14732 Translating from LaTeX into LyX is performed by a Perl script called reLyX.
14733 Although it is a standalone program which can be called from the command
14734 line, LyX will call it automatically when a LaTeX document is imported.
14735 See section\InsetSpace ~
14737 \begin_inset LatexCommand ref
14738 reference "sec:reLyX"
14742 for a complete description.
14743 There are no user tunable parameters for reLyX within LyX.
14746 \begin_layout Subsection
14750 \begin_layout Standard
14751 When importing plain ASCII text, there are two methods of reading the file.
14753 \begin_inset Quotes eld
14757 \begin_inset Quotes erd
14760 preserves all the linebreaks in the ASCII; to LyX, then, each line looks
14763 \begin_inset Quotes eld
14767 \begin_inset Quotes erd
14770 assumes that consecutive lines separated by only a single linebreak form
14771 a single paragraph.
14772 Successive linebreaks with no intervening text are thus assumed to be paragraph
14776 \begin_layout Subsection
14780 \begin_layout Standard
14783 [Editor's note: Needs to be written, obviously - any volunteers? --- mer]
14786 \begin_layout Section
14787 Exporting Other Formats
14790 \begin_layout Standard
14791 The output formats listed here in the following are also explained concerning
14792 possible graphics formats in the
14799 \begin_layout Subsection
14803 \begin_layout Standard
14804 LyX generates two types of LaTeX files: stripped down versions for the normal
14809 , etc.) which one normally never sees
14813 \begin_layout Standard
14814 The resulting file is a perfectly valid LaTeX file, though the preamble
14815 might look a bit strange since it includes some definitions used by LyX
14816 which wouldn't show up in most human-written files.
14821 , and human readable forms which are suitable for exchanging with your colleague
14823 The only settable option for the translation is the line length of the
14825 The default is 65 characters, but it can be set in
14832 \SpecialChar \menuseparator
14853 \begin_layout Subsection
14854 Device Independent Files
14857 \begin_layout Standard
14858 Device Independent files (DVI files) are produced by running LaTeX on your
14860 There are no user settable options.
14863 \begin_layout Subsection
14867 \begin_layout Standard
14868 The next step in the conversion chain is converting a DVI file into Postscript.
14876 \SpecialChar \menuseparator
14884 \SpecialChar \menuseparator
14893 or, if you need more control on the result,
14900 \SpecialChar \menuseparator
14909 If you use the later, note that it is possible to configure, in
14916 \SpecialChar \menuseparator
14924 , the options passed to the dvips program to achieve different effects.
14927 \begin_layout Subsection
14931 \begin_layout Standard
14932 Exporting as ASCII attempts to preserve the
14933 \begin_inset Quotes eld
14937 \begin_inset Quotes erd
14940 of the document as well as possible, but things like centering and indentation
14941 are thrown out; paragraphs are separated by blank lines.
14942 Section numbering and cross-references are done correctly, so the resulting
14943 text files is remarkably readable.
14944 The only changeable option is the length of lines, as for LaTeX output.
14947 \begin_layout Subsection
14951 \begin_layout Standard
14952 LyX documents can be converted to hypertext markup, usually by converting
14953 to LaTeX first, then converting that to HTML\SpecialChar \@.
14955 \begin_inset Formula $\rightarrow$
14958 HTML converters are currently known to LyX:
14975 Though they are autodetected, you can overide the selection in preferences.
14976 You can also include further command line options in this dialog.
14980 \begin_layout Subsection
14984 \begin_layout Standard
14992 \begin_layout Standard
14993 \begin_inset VSpace bigskip
14999 \begin_layout Standard
15000 The fastest way to generate a basic PDF file (no tags, links, etc.) with
15001 any version of LyX is to save the document as a Postscript file, then run
15007 Starting with version 1.1.6, the menu item
15011 will do all this for you.
15012 There are some issues with fonts that you need to pay attention to: see
15013 Section\InsetSpace ~
15015 \begin_inset LatexCommand ref
15016 reference "sec:badfonts"
15021 Also, as of version 1.1.6, there is a better method that will generate much
15022 more sophisticated files.
15025 \begin_layout Subsubsection
15029 \begin_layout Standard
15030 With pdfLaTeX you cannot use pstricks.
15031 On the other hand, with pdfLaTeX it is possible to insert directly images
15032 in JPEG, PDF or PNG format, use TrueType fonts, and more.
15035 \begin_layout Subsubsection
15036 Why does the text look so bad when viewed with Acrobat Reader?
15037 \begin_inset LatexCommand label
15038 name "sec:badfonts"
15043 \begin_inset OptArg
15046 \begin_layout Standard
15047 Bad Fonts in Acrobat Reader
15055 \begin_layout Standard
15056 The problem is that bitmap fonts are displayed poorly by Acrobat Reader.
15057 When creating a PDF from the LyX file, you need to use outline font instead
15058 of the default bitmap fonts (in fact, you should also use outline fonts
15059 for Postscript files).
15060 Recent LaTeX distributions come with Postscript Type 1 version of the standard
15061 (Computer Modern) fonts.
15062 pdfLaTeX uses these font by default.
15063 Dvips doesn't use these fonts by default, so to make it use them, add the
15064 following to lines to your
15071 \begin_layout LyX-Code
15075 \begin_layout LyX-Code
15079 \begin_layout Standard
15080 If the default LaTeX font encoding (OT1) is used, nothing else need to be
15082 However, if the T1 font encoding is used, then LaTeX uses the newer EC
15083 fonts, for which there are no Type1 version.
15084 The solution is to use the ae package which emulates T1 coded fonts using
15085 the standard CM fonts.
15086 This is done by adding
15090 usepackage{ae,aecompl}
15092 to the preamble of the LyX file.
15093 However, some glyphs are missing from the CM fonts (e.\InsetSpace \thinspace{}
15096 they are taken from the EC fonts.
15097 Therefore you get these glyphs as bitmaps.
15100 \begin_layout Standard
15101 Note: LyX uses by default the T1 font encoding.
15102 If you wish to use the default font encoding (this is not recommended,
15103 unless you only write English documents), clear the field
15111 in preferences (tabs
15123 \begin_layout Standard
15124 An alternate option is to use the standard Postscript fonts instead of the
15125 Computer Modern fonts.
15126 To do that, you need to select
15130 as the global font in the document layout dialog.
15131 When using the Postscript fonts, the result PDF file is smaller as the
15132 fonts are not saved into the file.
15133 Furthermore, the Postscript fonts include all T1 glyphs.
15134 On the other hand, the Postscript fonts have no bold symbol font, so poor
15135 man's bold must be used (see Section\InsetSpace ~
15137 \begin_inset LatexCommand ref
15138 reference "sec:pdfbold"
15143 The Postscript fonts also look different from the Computer Modern fonts.
15146 \begin_layout Standard
15147 To sum up, both the Computer Modern and the Postscript fonts gives good
15148 results (with few exceptions).
15149 The decision of which one to use is a matter of taste.
15152 \begin_layout Subsubsection
15155 boldsymbol{} command work when I use pslatex?
15156 \begin_inset LatexCommand label
15162 \begin_inset OptArg
15165 \begin_layout Standard
15182 \begin_layout Standard
15183 The Postscript fonts do not have a bold symbol font.
15184 The solution is to use the
15190 (poor man's bold) command.
15193 \begin_layout Standard
15194 It is possible to redefine the
15209 \begin_layout LyX-Code
15219 \begin_layout Standard
15223 \begin_layout Subsubsection
15224 Is it possible to do write LaTeX-code which is processed only when running
15226 \begin_inset OptArg
15229 \begin_layout Standard
15230 Conditionals with pdfLaTeX
15238 \begin_layout Standard
15239 Yes you can do this with the
15244 Here is an example:
15247 \begin_layout LyX-Code
15251 \begin_layout LyX-Code
15257 \begin_layout LyX-Code
15263 \begin_layout LyX-Code
15266 pdfinfo { /Author (your name and e-mail address)
15269 \begin_layout LyX-Code
15270 /Title (official title -- i.e., title element)
15273 \begin_layout LyX-Code
15274 /Subject (one line description of the document)
15277 \begin_layout LyX-Code
15281 \begin_layout LyX-Code
15284 pdfcatalog { /PageMode (/UseNone)
15287 \begin_layout LyX-Code
15288 % /OpenAction (fitbh)
15291 \begin_layout LyX-Code
15295 \begin_layout LyX-Code
15298 usepackage[pdftex]{hyperref}
15301 \begin_layout LyX-Code
15307 \begin_layout LyX-Code
15310 usepackage[ps2pdf]{hyperref}
15313 \begin_layout LyX-Code
15319 \begin_layout Subsubsection
15320 How can I make URLs clickable?
15323 \begin_layout Standard
15324 See the references here:
15327 \begin_layout Standard
15328 \begin_inset LatexCommand url
15329 target "http://wiki.lyx.org/pmwiki.php/FAQ/PDF"
15336 \begin_layout Subsection
15340 \begin_layout Standard
15341 Custom exports are possible if you have some particularly weird format you
15342 wish to convert to, assuming you have the relevant converter, of course.
15347 file can be chosen in the
15352 ile\SpecialChar \menuseparator
15357 xport\SpecialChar \menuseparator
15364 dialog; LyX will automatically convert the file to this point, then feed
15365 it to your custom converter.
15366 The possible values are all formats that LyX can produce from its own documents.
15370 \begin_layout Standard
15371 The converter command is also specified in the dialog.
15372 It should be a completely qualified command line which uses the variable
15377 to specify the name of the file.
15378 If this variable is not given, then the file will be sent to the standard
15379 input of your command.
15380 You may have to apply a bit of ingenuity to escape this sequence correctly
15381 so that it is compatible with your shell.
15385 \begin_layout Standard
15386 While it is not possible to save this command using the
15390 dialog, you can manually edit your
15397 \begin_layout LyX-Code
15400 custom_export_command "mycommand $$FName"
15403 \begin_layout Chapter
15404 LyX Features needing Extra Software
15407 \begin_layout Section
15411 \begin_layout Standard
15417 \begin_layout Subsection
15421 \begin_layout Standard
15429 menu, you'll find a
15438 This feature requires you to have the
15442 program installed, and is grayed out if you don't have it.
15443 You can get it from your nearest CTAN mirror, or over the Web from
15444 \begin_inset LatexCommand url
15445 target "http://www.ifi.uio.no/~jensthi/chktex/"
15452 \begin_layout Standard
15457 package is a program that was written by
15462 in frustration because some constructs in LaTeX are sometimes non-intuitive,
15463 and easy to forget.
15464 The program runs over your LaTeX file and checks the integrity of the file,
15465 and flags some common errors.
15466 In other technical words, it is
15473 \begin_layout Standard
15474 Well, what is a syntax checker doing in LyX which is supposed to produce
15475 correct LaTeX anyways? The answer is simple: Just as
15479 not only checks the
15483 of C programs, but also does
15487 checks for type-errors,
15491 catches some common
15495 errors, in addition to the syntactical ones.
15500 is capable of detecting several common errors, such as
15503 \begin_layout Itemize
15504 Ellipsis detection:
15506 Use \SpecialChar \ldots{}
15510 \begin_layout Itemize
15511 No space in front of/after parenthesis:
15516 \begin_layout Itemize
15517 Enforcement of normal space after common abbreviations:
15521 is too wide spacing.
15524 \begin_layout Itemize
15525 Enforcement of end-of-sentence space when the last sentence ends with a
15529 And this is wrong spacing.
15532 \begin_layout Itemize
15533 Space in front of labels and similar commands:
15535 The label should stick right
15536 up to the text to avoid falling to a wrong page.
15538 \begin_inset LatexCommand label
15547 \begin_layout Standard
15548 This footnote is in danger of falling off to a wrong page
15553 The label is separated too much.
15556 \begin_layout Itemize
15557 Space in front of references, instead of hard spaces:
15559 In you are in bad luck,
15560 the text will break right between the referenced text and reference number,
15563 \begin_inset LatexCommand ref
15564 reference "sec:chktex"
15571 \begin_layout Itemize
15573 \begin_inset Quotes eld
15577 \begin_inset Quotes erd
15581 \begin_inset Formula $\times$
15586 2x2 looks cheap compared to
15587 \begin_inset Formula $2\times2$
15593 \begin_layout Standard
15594 and more \SpecialChar \ldots{}
15595 It is an invaluable tool when you are
15596 \begin_inset Quotes eld
15600 \begin_inset Quotes erd
15603 your document before printing, and you should run it right after the obligatory
15604 spelling check, and before you go fine tuning the typesetting.
15607 \begin_layout Subsection
15611 \begin_layout Standard
15612 If you have the program installed, usage is as simple as choosing
15617 ools\SpecialChar \menuseparator
15626 This will make LyX generate a LaTeX file of your document, start
15630 to check it, and then make LyX insert
15631 \begin_inset Quotes eld
15635 \begin_inset Quotes erd
15638 with the warnings from
15642 , if there were any.
15643 The warnings will be placed close to the point of the mistake, and you
15644 can quickly find them by using the
15649 avigate\SpecialChar \menuseparator
15656 menu item, or the shortcut key
15665 Open the error boxes by clicking on them with the mouse, or use the shortcut
15674 bindings, or the corresponding
15683 Read the warning and correct the mistake, if it is a mistake.
15684 If you have trouble understanding what the warning is about, you can safely
15686 Remember that there is a hidden layer between the document on screen and
15687 the technical details in invoking
15691 , and this gap can make some warnings seem arcane or just right down plain
15695 \begin_layout Standard
15696 This document is an excellent testing bed for the feature, and it should
15697 provide quite a few warnings for you to fiddle with.
15698 Since computers are only so smart, expect most of the warnings to be false
15702 \begin_layout Subsection
15703 How to fine tune it
15706 \begin_layout Standard
15707 Sometimes, you'll find that
15711 makes more noise than suits your mood.
15712 Then you can choose not to use it, wait until your mood changes, or try
15717 to get better along with you.
15718 Another choice in the most desperate situations is to use
15723 iew\SpecialChar \menuseparator
15733 , which will get rid of all warnings instantly.
15736 \begin_layout Standard
15745 very configurable and extensible, you shouldn't expect to solve all problems
15751 Since LyX has to generate a somewhat special LaTeX file to be able to match
15752 the line numbers from the
15760 \begin_layout Standard
15761 You can inspect the specific output from
15767 Edit\SpecialChar \menuseparator
15781 to the internal document structure, some of the warnings will not seen
15782 to appear correctly.
15783 There are two things you can do about this:
15786 \begin_layout Itemize
15791 invocation command line in
15807 installation configuration file (usually with the file
15809 /usr/local/share/chktexrc
15812 See below to learn what warnings can be enabled and disabled on the command
15817 \begin_layout Itemize
15818 Export your document as a raw LaTeX file using
15823 ile\SpecialChar \menuseparator
15828 xport\SpecialChar \menuseparator
15840 Invoked in this way, it can be a hassle to find the corresponding place
15841 in the document inside LyX, but with a little patience, you should be able
15845 \begin_layout Standard
15846 Here follows the warning messages that can be enabled and disabled in
15855 to disable a warning, and
15859 to enable a warning.
15860 The emphasized entries are disabled by default, because the default is
15863 chktex -n1 -n3 -n6 -n9 -n22 -n25 -n30 -n38
15868 \begin_layout Standard
15869 Notice that you should only use the options that enable and disable warnings,
15870 because LyX relies on some of the other command line parameters to be set
15871 in a specific way to have a chance to communicate with
15878 \begin_layout Enumerate
15882 Command terminated with space.
15885 \begin_layout Enumerate
15888 Non-breaking space (
15889 \begin_inset Quotes eld
15897 \begin_inset Quotes erd
15900 ) should have been used.
15903 \begin_layout Enumerate
15907 You should enclose the previous parenthesis with
15908 \begin_inset Quotes eld
15916 \begin_inset Quotes erd
15922 \begin_layout Enumerate
15925 Italic correction (
15926 \begin_inset Quotes eld
15936 \begin_inset Quotes erd
15939 ) found in non-italic buffer.
15942 \begin_layout Enumerate
15945 Italic correction (
15946 \begin_inset Quotes eld
15956 \begin_inset Quotes erd
15959 ) found more than once.
15962 \begin_layout Enumerate
15966 No italic correction (
15967 \begin_inset Quotes eld
15977 \begin_inset Quotes erd
15983 \begin_layout Enumerate
15987 \begin_inset Quotes eld
15995 \begin_inset Quotes erd
15999 \begin_inset Quotes eld
16007 \begin_inset Quotes erd
16013 \begin_layout Enumerate
16016 Wrong length of dash may have been used.
16019 \begin_layout Enumerate
16023 \begin_inset Quotes eld
16031 \begin_inset Quotes erd
16035 \begin_inset Quotes eld
16043 \begin_inset Quotes erd
16049 \begin_layout Enumerate
16053 \begin_inset Quotes eld
16061 \begin_inset Quotes erd
16067 \begin_layout Enumerate
16071 \begin_inset Quotes eld
16079 \begin_inset Quotes erd
16082 to achieve an ellipsis.
16085 \begin_layout Enumerate
16088 Inter-word spacing (
16089 \begin_inset Quotes eld
16099 \begin_inset Quotes eld
16102 ) should perhaps be used.
16105 \begin_layout Enumerate
16108 Inter-sentence spacing (
16109 \begin_inset Quotes eld
16119 \begin_inset Quotes erd
16122 ) should perhaps be used.
16125 \begin_layout Enumerate
16128 Could not find argument for command.
16131 \begin_layout Enumerate
16135 \begin_inset Quotes eld
16143 \begin_inset Quotes erd
16149 \begin_layout Enumerate
16152 Math mode still on at end of LaTeX file.
16155 \begin_layout Enumerate
16159 \begin_inset Quotes eld
16167 \begin_inset Quotes erd
16170 doesn't match the number of
16171 \begin_inset Quotes eld
16179 \begin_inset Quotes erd
16185 \begin_layout Enumerate
16188 You should use either
16191 \begin_inset Quotes eld
16199 \begin_inset Quotes erd
16204 as an alternative to
16205 \begin_inset Quotes eld
16213 \begin_inset Quotes erd
16219 \begin_layout Enumerate
16226 " (ASCII 39) instead of "
16233 \begin_layout Enumerate
16236 User-specified pattern found.
16239 \begin_layout Enumerate
16242 This command might not be intended.
16245 \begin_layout Enumerate
16252 \begin_layout Enumerate
16270 \begin_layout Enumerate
16273 Delete this space to maintain correct page references.
16276 \begin_layout Enumerate
16280 You might wish to put this between a pair of
16281 \begin_inset Quotes eld
16289 \begin_inset Quotes erd
16295 \begin_layout Enumerate
16298 You ought to remove spaces in front of punctuation.
16301 \begin_layout Enumerate
16304 Could not execute LaTeX command.
16307 \begin_layout Enumerate
16316 in front of small punctuation.
16319 \begin_layout Enumerate
16327 may look prettier here.
16330 \begin_layout Enumerate
16334 Multiple spaces detected in output.
16337 \begin_layout Enumerate
16340 This text may be ignored.
16343 \begin_layout Enumerate
16349 \begin_inset Quotes eld
16354 to begin quotation, not
16361 \begin_layout Enumerate
16368 to end quotation, not
16371 \begin_inset Quotes eld
16379 \begin_layout Enumerate
16385 \begin_layout Enumerate
16388 You should perhaps use
16389 \begin_inset Quotes eld
16397 \begin_inset Quotes erd
16403 \begin_layout Enumerate
16406 You should put a space in front of/after parenthesis.
16409 \begin_layout Enumerate
16412 You should avoid spaces in front of/after parenthesis.
16415 \begin_layout Enumerate
16419 You should not use punctuation in front of/after quotes.
16422 \begin_layout Enumerate
16425 Double space found.
16428 \begin_layout Enumerate
16431 You should put punctuation outside inner/inside display math mode.
16434 \begin_layout Enumerate
16437 You ought to not use primitive TeX in LaTeX code.
16440 \begin_layout Enumerate
16443 You should remove spaces in front of
16444 \begin_inset Quotes eld
16452 \begin_inset Quotes erd
16458 \begin_layout Enumerate
16461 \begin_inset Quotes eld
16469 \begin_inset Quotes erd
16472 is normally not followed by
16473 \begin_inset Quotes eld
16481 \begin_inset Quotes erd
16487 \begin_layout Standard
16488 In later versions of LyX, we hope to provide a more complete interface to
16489 this tool (and it's smaller cousin
16493 ) to exploit the full power of it.
16494 But it's not exactly useless as it is now: go try it on one of your existing
16495 documents of a certain length and be surprised.
16498 \begin_layout Section
16499 Version Control in LyX
16502 \begin_layout Standard
16505 Lars Gullik Bjønnes
16508 \begin_layout Subsection
16512 \begin_layout Standard
16513 A friend of mine wanted to try LyX for a group project.
16514 When he didn't find support for version control or file locking, he dropped
16516 This angered me a bit, so I thought that I should at least make support
16517 for RCS (with the possibility of CVS and/or SCCS as a future improvement.)
16518 This has now been done.
16519 LyX now supports some of the most basic RCS commands.
16520 If you need to something a bit more sophisticated you will have to do that
16521 manually in an xterm.
16524 \begin_layout Standard
16525 Before you begin to use the version control features in LyX, you should
16527 \begin_inset Quotes eld
16531 \begin_inset Quotes erd
16534 (a man file, read it with
16539 This file describes all the basic features of RCS.
16540 You should especially notice the comment about a RCS directory, and the
16541 notion of a master RCS file (the file ending in
16548 \begin_layout Standard
16549 The implementation in LyX assumes a recent version of the GNU RCS package---no
16550 guarantees are made for older versions.
16553 \begin_layout Subsection
16554 RCS commands in LyX
16557 \begin_layout Standard
16558 The following sections describe the RCS commands supported by LyX.
16559 You can find them in the
16564 ile\SpecialChar \menuseparator
16569 ersion\InsetSpace ~
16575 \begin_layout Subsubsection
16581 \begin_layout Standard
16582 If your document is not under revision control, this is the only item shown
16584 And if it is under revision control, the
16591 item is grayed out.
16595 \begin_layout Standard
16596 This command registers your document with RCS\SpecialChar \@.
16597 You are asked interactively
16598 to supply an initial description of the document.
16599 The document is now set in Read-Only mode and you have to
16606 , before making any changes to it.
16607 A document under revision control has a
16608 \begin_inset Quotes eld
16611 [RCS:<version> <locker>]
16612 \begin_inset Quotes erd
16615 item tagged to the filename in the minibuffer.
16618 \begin_layout Standard
16619 RCS command that is run:
16621 ci -q -u -i -t-"<initial description>" <file-name>
16624 \begin_layout Standard
16629 to understand the switches.
16633 \begin_layout Subsubsection
16639 \begin_layout Standard
16640 When you are finished editing a file, you check in your changes.
16641 When you do this, you are asked for a description of the changes.
16642 This is stored in the history log.
16643 The version number is bumped, your changes are applied to the master RCS
16644 file, the document is unlocked and set to Read-Only mode.
16648 \begin_layout Standard
16651 ci -q -u -m"<description>" <file-name>
16654 \begin_layout Subsubsection
16660 \begin_layout Standard
16661 By doing this you lock the document so that only you can edit it.
16662 This will also make the document Read-Write only for you.
16663 You will usually continue editing for a while and when you are finished
16664 you check in your changes.
16665 The status line is changed to reflect that you have locked the file.
16669 \begin_layout Standard
16672 co -q -l <file-name>
16675 \begin_layout Subsubsection
16678 Revert To Last Version
16681 \begin_layout Standard
16682 This will discard all changes made to the document since the last check
16684 You get a warning before changes are discarded.
16687 \begin_layout Standard
16690 co -f -u<version> <file-name>
16693 \begin_layout Subsubsection
16699 \begin_layout Standard
16700 This makes as if the last check in never happened.
16701 No changes are made to the document loaded into LyX, but the last version
16702 is removed from the master RCS file.
16706 \begin_layout Standard
16709 rcs -o<version> <file-name>
16712 \begin_layout Subsubsection
16718 \begin_layout Standard
16719 This show the complete history of the RCS document.
16724 is shown in a browser.
16732 \begin_layout Section
16733 Literate Programming
16736 \begin_layout Standard
16741 (kayvan@sylvan.com)
16745 original documentation written by
16747 Edmar Wienskoski Jr.
16750 (edmar-w-jr@technologist.com)
16753 \begin_layout Subsection
16757 \begin_layout Standard
16758 The main purpose of this documentation is to show you how to use LyX for
16759 literate programming.
16760 Where it is assumed that you are familiar with this programming technique,
16762 \begin_inset Quotes eld
16766 \begin_inset Quotes erd
16770 \begin_inset Quotes eld
16774 \begin_inset Quotes erd
16778 If that is not the case, please follow the web links provided in the following
16780 There is a lot of good documentation out there covering old development
16781 history to the latest tools tips.
16784 \begin_layout Standard
16785 It is also assumed that you are familiar with LyX itself to a point that
16786 you are comfortable changing your LyX preferences, and X resources file.
16787 If that is not the case please refer to other LyX documentation to cover
16788 your specific needs.
16791 \begin_layout Subsection
16792 Literate Programming
16795 \begin_layout Standard
16796 From the Literate Programming FAQ:
16799 \begin_layout Quotation
16800 Literate programming is the combination of documentation and source together
16801 in a fashion suited for reading by human beings.
16802 In fact, literate programs should be enjoyable reading, even inviting!
16803 (Sorry Bob, I couldn't resist!) In general, literate programs combine source
16804 and documentation in a single file.
16805 Literate programming tools then parse the file to produce either readable
16806 documentation or compilable source.
16807 The WEB style of literate programming was created by D.E.
16808 Knuth during the development of his TeX typesetting software.
16812 \begin_layout Standard
16813 Another excerpt says:
16816 \begin_layout Quotation
16819 How is literate programming different from verbose commenting?
16822 \begin_layout Quotation
16823 There are three distinguishing characteristics.
16824 In order of importance, they are:
16828 \begin_layout Itemize
16829 flexible order of elaboration
16832 \begin_layout Itemize
16833 automatic support for browsing
16836 \begin_layout Itemize
16837 typeset documentation, especially diagrams and mathematics
16841 \begin_layout Standard
16842 Now that I sparked your curiosity, take a look in the references.
16845 \begin_layout Subsubsection
16849 \begin_layout Standard
16850 The complete Literate Programming FAQ can be found at:
16853 \begin_layout Quote
16854 \begin_inset LatexCommand url
16855 name "Literate Programming FAQ"
16856 target "http://shelob.ce.ttu.edu/daves/lpfaq/faq.html"
16863 \begin_layout Standard
16864 The FAQ lists 23 (twenty three!) different literate programming tools.
16865 Where some are specialized or
16866 \begin_inset Quotes eld
16870 \begin_inset Quotes erd
16873 for particular programming languages, while other have general scope.
16878 for my own use for several reasons:
16881 \begin_layout Itemize
16882 It can generate the documentation either in LaTeX or HTML.
16885 \begin_layout Itemize
16886 It has a open architecture, i.e., it is easy to plug in new filters and to
16887 perform special processing that you may need.
16891 \begin_layout Itemize
16892 There is a good selection of filters available already (the HTML is one
16896 \begin_layout Itemize
16900 \begin_layout Standard
16901 The Noweb web page can be found at:
16904 \begin_layout Quote
16905 \begin_inset LatexCommand url
16906 name "Noweb home page"
16907 target "http://www.cs.virginia.edu/~nr/noweb/"
16914 \begin_layout Standard
16915 Starting from there you can reach many other interesting links and even
16916 some literate program examples.
16919 \begin_layout Subsection
16920 \begin_inset LatexCommand label
16921 name "sub:LyX-and-Literate"
16925 LyX and Literate Programming
16928 \begin_layout Standard
16929 The LyX support for Literate Programming is provided by using the generic
16930 LyX convertors mechanism.
16931 This support is provided in a
16932 \begin_inset Quotes eld
16936 \begin_inset Quotes erd
16939 way, i.e., you will be able to use this new LyX feature with some other literate
16940 programming tool of your choice by just changing your LyX preferences.
16943 \begin_layout Subsubsection
16944 Generating documents and code (weaving and tangling)
16947 \begin_layout Paragraph
16948 Selecting the document class
16951 \begin_layout Standard
16952 If you have installed Noweb and LyX successfully, whenever you open a new
16953 document or try to change the document class of an existing one, you will
16954 find that there are three new document classes available:
16957 \begin_layout Itemize
16961 \begin_layout Itemize
16965 \begin_layout Itemize
16969 \begin_layout Standard
16970 You must select one of them to create your literate documents from.
16974 \begin_layout Standard
16975 Note that literate documents are not limited to these three classes.
16976 New classes can be generated from other styles like letter or in combination
16977 with other class variations like Article (AMS).
16978 If you have special needs that cannot be covered by one of the existing
16979 classes, let the LyX developers list (lyx-devel@lists.lyx.org) know and we
16980 will arrange to insert a new entry, or teach you how to do it.
16984 \begin_layout Standard
16985 It is very simple, it involves the creation of a file with four lines, and
16986 re-running of the auto configuration.
16991 Moreover, if you use a literate tool other than Noweb you may need to create
16992 a new set of document classes for it.
16995 \begin_layout Paragraph
16999 \begin_layout Standard
17000 LyX enables you to write code with a layout named
17008 \begin_layout Standard
17009 The equivalent Noweb term is
17010 \begin_inset Quotes eld
17014 \begin_inset Quotes erd
17018 For historical reasons, I got used to the term
17019 \begin_inset Quotes eld
17023 \begin_inset Quotes erd
17026 introduced by other literate tool named Nuweb, which I used for many years
17027 before rendering myself to Noweb.
17032 Noweb delimits scraps like this:
17035 \begin_layout LyX-Code
17039 \begin_layout LyX-Code
17043 \begin_layout LyX-Code
17047 \begin_layout LyX-Code
17051 \begin_layout LyX-Code
17055 \begin_layout Standard
17056 The problem is that whatever is written in between the << and the
17060 must be taken literally, i.e., LyX should be prevented from making any special
17061 interpretation of what has been written.
17062 This is handled by a special layout named Scrap, that works like a normal
17063 paragraph but has a free spacing capability.
17066 \begin_layout Standard
17067 The down side of the Scrap paragraph layout is that consecutive paragraphs
17068 of code will be spaced with one empty line in the source code and also
17069 in the printed documentation.
17070 The work around is to enter each line of code within a single Scrap, with
17071 a newline (ctrl-return).
17072 The example above will look like this:
17076 \begin_layout Standard
17077 If you have a printed version of this document you will not see any difference
17078 between the previous example and this one.
17086 \begin_layout LyX-Code
17098 \begin_layout Standard
17099 This layout works fine.
17100 The only real inconvenience is that you have to type ctrl-return instead
17105 \begin_layout Standard
17106 It is in my list of
17107 \begin_inset Quotes eld
17111 \begin_inset Quotes erd
17122 \begin_layout Standard
17123 As a special note, you can also use the
17124 \begin_inset Quotes eld
17128 \begin_inset Quotes erd
17131 construct of Noweb in your scraps to add items to Noweb's identifier cross-refe
17135 \begin_layout LyX-Code
17138 def some_function(args):
17140 "This is the doc string for this
17143 print "My args: ", args
17146 \begin_layout LyX-Code
17147 @ %def some_function
17150 \begin_layout Standard
17151 For an example of this usage and the resulting cross-reference output, look
17152 at the Literate python program in
17154 LIBDIR/examples/listerrors.lyx
17156 which should make this all clear.
17159 \begin_layout Paragraph
17160 Generating the documentation
17163 \begin_layout Standard
17164 At this point you already have a new document file with a proper document
17165 class, and with some code and text on it.
17166 How do I print it? The answer is simple, you select
17171 iew\SpecialChar \menuseparator
17179 Just like you would do for a plain document.
17180 No special procedure is required.
17183 \begin_layout Standard
17184 To help orientate you, I will now explain what happens inside LyX:
17187 \begin_layout Enumerate
17193 pdate\SpecialChar \menuseparator
17200 menu option is chosen, a LaTeX file is generated.
17205 \begin_layout Standard
17206 If the document is of any literate class the generated file will be named
17207 with an extension name defined by the
17208 \begin_inset Quotes eld
17212 \begin_inset Quotes erd
17215 format (defined in the Preferences panel), otherwise the file will have
17224 \begin_layout Enumerate
17225 Note that the only difference so far is in the name of the file, no special
17226 processing is required by LyX.
17227 Given that you formatted the code using the Scrap layout that, by itself,
17228 takes care of the business.
17231 \begin_layout Enumerate
17232 If the document is of any literate class LyX will then use the internal
17233 LyX to Noweb converter, followed by the Noweb to LaTeX converter
17237 \begin_layout Standard
17238 The converters are defined in the
17243 ools\SpecialChar \menuseparator
17251 \begin_inset Quotes eld
17255 \begin_inset Quotes erd
17260 \begin_inset LatexCommand ref
17261 reference "sub:converters"
17269 manual for general information about converters.
17274 to generate the LaTeX file.
17278 \begin_layout Standard
17279 Otherwise it will just skip this step.
17283 \begin_layout Enumerate
17284 Finally, LaTeX is invoked and the regular post processing continues as in
17288 \begin_layout Standard
17289 Independence from a particular
17290 \begin_inset Quotes eld
17294 \begin_inset Quotes erd
17297 is easily achieved by changing the commands that are run by the various
17301 \begin_layout Paragraph
17302 Generating the code
17305 \begin_layout Standard
17306 When the build menu option is chosen or the corresponding button in the
17307 toolbar is pressed, a LaTeX file is generated just like step 1 above.
17308 Next, LyX invokes the
17313 This converter needs to be defined by the user and is not installed by
17314 default, though the Program format is.
17315 This converter (like any other converter) will have two parts:
17318 \begin_layout Enumerate
17319 The converter program itself.
17320 This program performs the conversion from the one format to the other (in
17321 this case, from the Noweb format to the Program pseudo-format).
17324 \begin_layout Enumerate
17325 The error log parser.
17326 This is a program whose sole purpose is to rewrite error messages in a
17327 format that LyX understands.
17328 This makes it possible for LyX to place error boxes in the right places
17329 in the file buffer.
17332 \begin_layout Standard
17333 The first part, the
17334 \begin_inset Quotes eld
17338 \begin_inset Quotes erd
17341 setting, should be set to
17342 \begin_inset Quotes eld
17350 \begin_inset Quotes erd
17354 This basically means that LyX will call
17355 \begin_inset Quotes eld
17359 \begin_inset Quotes erd
17362 (a program or script) with the name of the Noweb file (normally a file
17363 in the LyX temp directory).
17367 \begin_layout Standard
17368 This is an implementation of
17369 \begin_inset Quotes eld
17373 \begin_inset Quotes erd
17376 that you can place in a directory on your path:
17379 \begin_layout LyX-Code
17383 \begin_layout LyX-Code
17387 \begin_layout LyX-Code
17388 notangle -Rbuild-script $1 | env NOWEB_SOURCE=$1 sh
17391 \begin_layout Standard
17392 The next part of the converter setting is the
17393 \begin_inset Quotes eld
17397 \begin_inset Quotes erd
17400 which is to be set to
17401 \begin_inset Quotes eld
17406 parselog=listerrors
17409 \begin_inset Quotes erd
17413 This will run any errors that are generated by the
17414 \begin_inset Quotes eld
17418 \begin_inset Quotes erd
17421 process through the
17422 \begin_inset Quotes eld
17426 \begin_inset Quotes erd
17432 \begin_layout Standard
17433 The converter code looks in
17441 then on the path for the
17442 \begin_inset Quotes eld
17446 \begin_inset Quotes erd
17452 \begin_layout Standard
17453 The build will normally take place in LyX's temporary directory, so the
17454 files produced by the conversion will be in that directory.
17455 LyX will copy out what it regards as the `main' file, but the
17459 conversion may produce several files, and so most of these would then be
17460 deleted when LyX was closed.
17461 The present solution is to use a `copier',
17465 \begin_layout Standard
17467 \begin_inset LatexCommand ref
17468 reference "sec:converters-etc"
17476 manual for information on these.
17485 script in its default mode, so that the entire contents of the temporary
17486 directory is copied.
17487 More will get copied than is needed, to be sure, but nothing will be lost.
17488 If, however, you know what extensions the generated files will have, this
17489 can be improved by using the
17498 This option takes a comma-separated list of extensions to copy.
17499 So, for example, if the conversion will generate only files with the extensions
17508 , then the correct definition would be:
17511 \begin_layout LyX-Code
17512 python -tt $$s/scripts/ext_copy.py -e c,h $$i $$o
17515 \begin_layout Standard
17516 The result will be that only files with these two extensions will be copied
17520 \begin_layout Paragraph
17521 Build instructions in the document
17524 \begin_layout Standard
17525 The last piece of the integration between LyX and noweb is the
17526 \begin_inset Quotes eld
17530 \begin_inset Quotes erd
17534 Generally, the instructions for building your program should be embedded
17535 in a scrap of its own.
17537 \begin_inset Quotes eld
17541 \begin_inset Quotes erd
17544 above uses the notangle command to look for this scrap (called
17545 \begin_inset Quotes eld
17549 \begin_inset Quotes erd
17552 ) and runs its contents through
17553 \begin_inset Quotes eld
17557 \begin_inset Quotes erd
17563 \begin_layout Standard
17564 Typically, such a scrap would look something like this:
17567 \begin_layout LyX-Code
17574 if [ -z "${NOWEB_SOURCE}" ]
17578 NOWEB_SOURCE=myfile.nw
17584 code to extract files ...]
17587 code to compile files ...]
17592 \begin_layout Standard
17595 LIBDIR/examples/listerrors.lyx
17599 LIBDIR/examples/Literate.lyx
17601 which implement two versions of the
17602 \begin_inset Quotes eld
17606 \begin_inset Quotes erd
17609 program for some illustrations of how all of these pieces go together or
17612 LIBDIR/examples/noweb2lyx.lyx.
17615 Interestingly, these three files show off the language-indepence of the
17616 LyX literate programming support since they are written in Python, C and
17620 \begin_layout Subsubsection
17624 \begin_layout Standard
17625 All the Literate Programming support is configured by the
17630 ools\SpecialChar \menuseparator
17638 \begin_inset Quotes eld
17642 \begin_inset Quotes erd
17646 The important parts are:
17649 \begin_layout Description
17652 \begin_inset Quotes eld
17656 \begin_inset Quotes erd
17660 format Set up via the Formats tab, this is where the Noweb-specific pieces
17670 , the file extension is set to
17675 This tells LyX to create a file with a
17679 extension in the first step of the conversion process.
17682 \begin_layout Description
17689 format This is an empty format whose sole purpose is to be the endpoint
17690 of a conversion (which then allows us to set up a converter for it).
17693 \begin_layout Description
17702 This converter performs the
17703 \begin_inset Quotes eld
17707 \begin_inset Quotes erd
17710 of the literate document.
17711 For Noweb, it is set to
17712 \begin_inset Quotes eld
17717 noweave -delay -index $$i > $$o
17720 \begin_inset Quotes erd
17726 \begin_layout Description
17736 \begin_inset Quotes eld
17740 \begin_inset Quotes erd
17744 As stated above, the Converter is set to
17745 \begin_inset Quotes eld
17753 \begin_inset Quotes erd
17756 , with Flags set to
17757 \begin_inset Quotes eld
17762 originaldir,parselog=listerrors
17765 \begin_inset Quotes erd
17771 \begin_layout Subsubsection
17775 \begin_layout Standard
17776 There is also a new function implemented in the LyX server, the
17777 \begin_inset Quotes eld
17780 server-goto-file-row" function, to be used with ddd/gdb or other debugger.
17784 \begin_layout Standard
17785 When debugging code with ddd/gdb, it is possible to invoke a text editor
17786 at the current execution position with a single key stroke.
17787 The default ddd configuration for that is shift-ctrl-V.
17788 It happens that you can define the editor command line invocation in ddd
17794 dit\SpecialChar \menuseparator
17799 references\SpecialChar \menuseparator
17806 dialog and changing the "Edit Sources" entry.
17809 \begin_layout Standard
17810 I take advantage of the new created LyX server function and this ddd feature,
17812 \begin_inset Quotes eld
17816 \begin_inset Quotes erd
17822 \begin_layout LyX-Code
17823 echo "LYXCMD:monitor:server-goto-file-row:@FILE@ @LINE@" >~/.lyxpipe.in
17826 \begin_layout Standard
17827 With this, whenever you are using ddd and find a point in the program that
17828 you want to edit, you just press shift-ctrl-V (in the ddd window), and
17829 ddd you forward this information to LyX through the LyX server and then
17830 the LyX window will show the same file with the cursor at the same position
17831 ddd was pointing to.
17832 No more guessing or long scrolling to locate a point in the program back
17836 \begin_layout Standard
17837 Note however that you must enable the LyX server to get this feature working
17838 (it is disabled by default).
17839 You can enable it in
17851 ) by entering in the
17856 \begin_inset Quotes eld
17861 /home/<your-home-directory>/.lyx/lyxpipe
17864 \begin_inset Quotes erd
17870 \begin_layout Standard
17871 Read the LyX server documentation in the
17873 Customization Manual
17875 for further information.
17878 \begin_layout Subsubsection
17882 \begin_layout Standard
17883 There are six new buttons that can be added to your LyX toolbar.
17884 Five of these buttons are short cuts to layout styles:
17905 The last one is a short cut to the
17906 \begin_inset Quotes eld
17910 \begin_inset Quotes erd
17917 \begin_layout Standard
17918 LyX has a range of buttons that are available for tool bar customization.
17919 In my toolbar I like to combine the six short cuts above with two more:
17927 \SpecialChar \menuseparator
17935 \SpecialChar \menuseparator
17948 iew\SpecialChar \menuseparator
17956 Here is how it looks like:
17959 \begin_layout LyX-Code
17963 \begin_layout LyX-Code
17967 \begin_layout LyX-Code
17968 Icon "layout Standard"
17971 \begin_layout LyX-Code
17972 Icon "layout Section"
17975 \begin_layout LyX-Code
17976 Icon "layout LaTeX"
17979 \begin_layout LyX-Code
17980 Icon "layout LyX-Code"
17983 \begin_layout LyX-Code
17984 Icon "layout Scrap"
17987 \begin_layout LyX-Code
17991 \begin_layout LyX-Code
17995 \begin_layout LyX-Code
17996 Icon "buffer-typeset"
17999 \begin_layout LyX-Code
18000 Icon "build-program"
18003 \begin_layout LyX-Code
18007 \begin_layout LyX-Code
18011 \begin_layout LyX-Code
18015 \begin_layout LyX-Code
18019 \begin_layout LyX-Code
18023 \begin_layout Subsubsection
18024 Colors customization
18027 \begin_layout Standard
18028 There are a number of colors in LyX that can be customized in
18033 One of the things that bothers people is the LaTeX font color.
18034 The default color is red, since the scraps uses LaTeX font, and there is
18035 a lot of scraps in literate documents, you may get tired of seeing everything
18037 You can change it by going to the tabs
18046 \begin_layout Standard
18047 The next thing is the visible presence of the newline character in the screen.
18048 You can choose the color of this particular character and make it blend
18050 I recommend you choosing a color that is close to the background but not
18051 equal, that way you still can see it is there, but it is not bothering
18056 \begin_layout Chapter
18057 Secrets of the LaTeX Masters
18058 \begin_inset LatexCommand label
18066 \begin_layout Standard
18067 Though LyX is a powerful tool, it cannot hope to support everything that
18068 can be done with pure TeX/LaTeX.
18069 However, many familiar dirty TeX and LaTeX tricks can be done within LyX,
18070 as long as you are not afraid to use that
18071 \begin_inset Quotes eld
18075 \begin_inset Quotes erd
18078 button on the toolbar or add things to the LaTeX preamble.
18079 This section lists some tips, tricks, and otherwise cool ideas to give
18080 your document that extra little flair.
18083 Do try this at home
18085 , just start with something a little smaller and less important than your
18089 \begin_layout Standard
18090 Most ideas in this section require less common files in your LaTeX installation.
18091 If you have a system like teTeX, most will already be available.
18092 A few, however, will need to be downloaded from one of the CTAN archives.
18093 Often, there are several ways to do something, or several LaTeX style files
18094 which do the same thing.
18095 We do not endorse one choice over another, we simply claim that we have
18096 done a particular task with a particular file.
18097 Put on your wizard hat, keep an eye out for dragons, and let us begin.
18100 \begin_layout Section
18104 \begin_layout Standard
18107 Lars Gullik Bjønnes
18110 \begin_layout Subsection
18114 \begin_layout Standard
18115 The aim for this chapter
18119 \begin_layout Standard
18120 Editor's note: Lars' original chapter was a masterful description of how
18126 However, it was too long to flow smoothly in this document.
18127 I have therefore chosen to excerpt the most important sections here (sorry,
18128 Lars); you can read the original chapter (and more of the story!) in the
18131 examples/multicol.lyx
18139 is to show how the LaTeX package
18143 can be used in a LyX document.
18144 As LyX doesn't support the
18148 package natively yet, we have to use some small hacks.
18149 By reading this section it should be obvious how to do this.
18152 \begin_layout Subsection
18156 \begin_layout Standard
18161 package allows switching between one and multicolumn format on the same
18163 Footnotes are handled correctly (for the most part), but will be placed
18164 at the bottom of the page and not under each column.
18165 LaTeX's float mechanism, however, is partly disabled in the current implementat
18167 At the moment only page-wide floats can be used within the scope of the
18171 \begin_layout Subsection
18175 \begin_layout Subsubsection
18179 \begin_layout Standard
18180 If you want to have two columns in your text, you have use LaTeX mode to
18185 begin{multicols}{2}
18187 at the point where you want the two column layout to start, and then
18193 where you want it to end.
18197 \begin_layout Standard
18201 \begin_layout Standard
18205 begin{multicols}{2}
18213 \begin_layout Standard
18218 The Adventure of the Empty House
18224 Sir Arthur Conan Doyle
18227 \begin_layout Standard
18230 It was in the spring of the year 1894 that all London was interested, and
18231 the fashionable world dismayed, by the murder of the Honourable Ronald
18232 Adair under most unusual and inexplicable circumstances.
18233 The public has already learned those particulars of the crime which came
18234 out in the police investigation, but a good deal was suppressed upon that
18235 occasion, since the case for the prosecution was so overwhelmingly strong
18236 that it was not necessary to bring forward all the facts.
18237 Only now, at the end of nearly ten years, am I allowed to supply those
18238 missing links which make up the whole of that remarkable chain.
18239 The crime was of interest in itself, but that interest was as nothing to
18240 me compared to the inconceivable sequel, which afforded me the greatest
18241 shock and surprise of any event in my adventurous life.
18242 Even now, after this long interval, I find myself thrilling as I think
18243 of it, and feeling once more that sudden flood of joy, amazement, and increduli
18244 ty which utterly submerged my mind.
18245 Let me say to that public, which has shown some interest in those glimpses
18246 which I have occasionally given them of the thoughts and actions of a very
18247 remarkable man, that they are not to blame me if I have not shared my knowledge
18248 with them, for I should have considered it my first duty to do so, had
18249 I not been barred by a positive prohibition from his own lips, which was
18250 only withdrawn upon the third of last month.
18253 \begin_layout Standard
18257 \begin_layout Standard
18269 \begin_layout Subsubsection
18273 \begin_layout Standard
18274 The same pattern is used when you want more than two columns:
18277 \begin_layout Standard
18281 \begin_layout Standard
18285 begin{multicols}{3}
18293 \begin_layout Standard
18296 It can be imagined that my close intimacy with Sherlock Holmes had interested
18297 me deeply in crime, and that after his disappearance I never failed to
18298 read with care the various problems which came before the public.
18299 And I even attempted, more than once, for my own private satisfaction,
18300 to employ his methods in their solution, though with indifferent success.
18301 There was none, however, which appealed to me like this tragedy of Ronald
18303 As I read the evidence at the inquest, which led up to a verdict of willful
18304 murder against some person or persons unknown, I realized more clearly
18305 than I had ever done the loss which the community had sustained by the
18306 death of Sherlock Holmes.
18307 There were points about this strange business which would, I was sure,
18308 have specially appealed to him, and the efforts of the police would have
18309 been supplemented, or more probably anticipated, by the trained observation
18310 and the alert mind of the first criminal agent in Europe.
18311 All day, as I drove upon my round, I turned over the case in my mind and
18312 found no explanation which appeared to me to be adequate.
18313 At the risk of telling a twice-told tale, I will recapitulate the facts
18314 as they were known to the public at the conclusion of the inquest.
18317 \begin_layout Standard
18321 \begin_layout Standard
18333 \begin_layout Standard
18334 You can have more than 3 columns if you want to, but that might not be very
18335 pleasant for the eye.
18338 \begin_layout Subsubsection
18339 Columns inside columns
18342 \begin_layout Standard
18343 You can even have columns inside columns:
18346 \begin_layout Standard
18350 \begin_layout Standard
18354 begin{multicols}{2}
18362 \begin_layout Standard
18365 The Honourable Ronald Adair was the second son of the Earl of Maynooth,
18366 at that time governor of one of the Australian colonies.
18367 Adair's mother had returned from Australia to undergo the operation for
18368 cataract, and she, her son Ronald, and her daughter Hilda were living together
18372 \begin_layout Standard
18376 \begin_layout Standard
18380 begin{multicols}{2}
18388 \begin_layout Standard
18391 The youth moved in the best society--had, so far as was known, no enemies
18392 and no particular vices.
18393 He had been engaged to Miss Edith Woodley, of Carstairs, but the engagement
18394 had been broken off by mutual consent some months before, and there was
18395 no sign that it had left any very profound feeling behind it.
18396 For the rest {sic} the man's life moved in a narrow and conventional circle,
18397 for his habits were quiet and his nature unemotional.
18398 Yet it was upon this easy-going young aristocrat that death came, in most
18399 strange and unexpected form, between the hours of ten and eleven-twenty
18400 on the night of March 30, 1894.
18403 \begin_layout Standard
18407 \begin_layout Standard
18419 \begin_layout Standard
18422 Ronald Adair was fond of cards--playing continually, but never for such
18423 stakes as would hurt him.
18424 He was a member of the Baldwin, the Cavendish, and the Bagatelle card clubs.
18425 It was shown that, after dinner on the day of his death, he had played
18426 a rubber of whist at the latter club.
18427 He had also played there in the afternoon.
18432 The evidence of those who had played with him-- Mr.
18433 Murray, Sir John Hardy, and Colonel Moran--showed that the game was whist,
18434 and that there was a fairly equal fall of the cards.
18435 Adair might have lost five pounds, but not more.
18436 His fortune was a considerable one, and such a loss could not in any way
18438 He had played nearly every day at one club or other, but he was a cautious
18439 player, and usually rose a winner.
18440 It came out in evidence that, in partnership with Colonel Moran, he had
18441 actually won as much as four hundred and twenty pounds in a sitting, some
18442 weeks before, from Godfrey Milner and Lord Balmoral.
18443 So much for his recent history as it came out at the inquest.
18446 \begin_layout Standard
18450 \begin_layout Standard
18462 \begin_layout Standard
18463 Please do read the file
18465 examples/multicol.lyx
18467 for more advanced examples including column and header spacing, vertical
18468 separator lines, and more.
18471 \begin_layout Section
18476 Paragraph Environment
18477 \begin_inset OptArg
18480 \begin_layout Standard
18481 Numbering in Enumerate
18489 \begin_layout Standard
18495 \begin_layout Standard
18496 \begin_inset VSpace bigskip
18502 \begin_layout Standard
18504 The default numbering for the
18508 paragraph environment begins with Arabic numbers and ends with uppercase
18510 Suppose, however, you wanted a different type of numbering scheme.
18511 Here's a quickie example of how to change the numbering scheme:
18514 \begin_layout LyX-Code
18524 \begin_layout LyX-Code
18534 \begin_layout LyX-Code
18544 \begin_layout LyX-Code
18554 \begin_layout Standard
18555 \SpecialChar \ldots{}
18556 which changes the numbering scheme to uppercase Roman numerals, uppercase
18557 letters, Arabic numbers, and lowercase letter.
18560 \begin_layout Standard
18561 Additionally, the previous example also adds a little bit extra to the numbering
18563 For example, the first level label actually looks like:
18564 \begin_inset Quotes eld
18568 \begin_inset Quotes erd
18572 For ease of reading, we'll describe what the numbering schemes look like
18573 using a notation something like this: <
18574 \begin_inset Quotes eld
18578 \begin_inset Quotes erd
18583 \begin_inset Quotes erd
18587 \begin_inset Quotes erd
18592 \begin_inset Quotes erd
18596 \begin_inset Quotes erd
18601 \begin_inset Quotes eld
18605 \begin_inset Quotes erd
18612 \begin_layout Standard
18613 As you can see in the example, there is a label command for each nesting
18620 \SpecialChar \ldots{}
18627 , as well as a counter,
18631 \SpecialChar \ldots{}
18637 There are also five
18638 \begin_inset Quotes eld
18642 \begin_inset Quotes erd
18675 , each of which take one counter as an argument.
18676 You can add characters before or after these, but there's no need to add
18680 \begin_layout Standard
18681 You can get really fancy with these.
18685 \begin_layout LyX-Code
18699 \begin_layout LyX-Code
18711 \begin_layout LyX-Code
18721 \begin_layout LyX-Code
18731 \begin_layout Standard
18732 produces the somewhat out of hand numbering scheme: <
18733 \begin_inset Quotes eld
18737 \begin_inset Quotes erd
18742 \begin_inset Quotes erd
18746 \begin_inset Quotes erd
18751 \begin_inset Quotes erd
18755 \begin_inset Quotes erd
18760 \begin_inset Quotes eld
18764 \begin_inset Quotes erd
18771 \begin_layout Standard
18775 \begin_layout Section
18779 \begin_layout Standard
18785 \begin_layout Standard
18786 \begin_inset VSpace bigskip
18792 \begin_layout Standard
18797 \begin_layout Standard
18803 tmpfont}{cmr17 scaled 2500}{
18815 \begin_layout Standard
18820 \begin_layout Standard
18831 hose of you who like the style of old books probably also like
18832 \begin_inset Quotes eld
18836 \begin_inset Quotes erd
18839 ---those large capital letters which begin each new chapter or section.
18840 Implementing them with plain LyX/LaTeX is straightforward (assuming you
18841 know some plain TeX!) but does require a lot of work and many iterations,
18842 as you can see by all the ugly TeX-mode stuff at the beginning of this
18846 \begin_layout Standard
18850 \begin_layout Standard
18856 bigdrop{-1em}{3}{ptmri}{T}+
18861 here is a much easier way of doing this, of course.
18870 ) package from CTAN allows a simple way to add such letters to your documents.
18871 Since this package is not a standard part of teTeX, I can't demonstrate
18872 it within this document, but if you copy this paragraph to a new document,
18874 \begin_inset Quotes eld
18884 \begin_inset Quotes erd
18887 and the pluses from the TeX code at the beginning of the paragraph, and
18892 usepackage{dropcaps}
18894 to your LaTeX preamble, you will get a nice Times Roman Italic
18895 \begin_inset Quotes eld
18899 \begin_inset Quotes erd
18902 , whose height is three lines of text and which protrudes 1 em into the
18904 (Make certain you have copied
18905 \begin_inset Quotes eld
18913 \begin_inset Quotes erd
18916 into a directory where TeX can see it.) The first argument is the amount
18917 of indentation; in this case the negative sign moves it into the margin.
18918 The second argument is the height of the letter in number of lines of text.
18919 The third argument is the font name: virtually anything which has a tfm
18920 file should work (wade through the
18922 .../texmf/fonts/tfm
18924 directory for possibilities).
18925 My personal favorite is
18926 \begin_inset Quotes eld
18934 \begin_inset Quotes erd
18937 , a fancy German font specifically designed for dropped capitals.
18938 The fourth argument is the letter (or letters) to be dropped.
18943 package also offers the
18949 command, as well as a slightly simplified
18958 \begin_layout Section
18959 Non-standard Paragraph Shapes
18962 \begin_layout Standard
18968 \begin_layout Standard
18969 \begin_inset VSpace bigskip
18975 \begin_layout Standard
18979 \begin_layout Standard
18991 \begin_layout Standard
18995 \begin_layout Standard
19004 \begin_layout Standard
19018 \begin_layout Standard
19023 \begin_layout Standard
19034 \begin_layout Standard
19043 \begin_layout Standard
19052 \begin_layout Standard
19061 \begin_layout Standard
19070 \begin_layout Standard
19079 \begin_layout Standard
19088 \begin_layout Standard
19097 \begin_layout Standard
19106 \begin_layout Standard
19115 \begin_layout Standard
19124 \begin_layout Standard
19133 \begin_layout Standard
19142 \begin_layout Standard
19151 \begin_layout Standard
19160 \begin_layout Standard
19169 \begin_layout Standard
19178 \begin_layout Standard
19187 \begin_layout Standard
19196 \begin_layout Standard
19202 There are times when the tyranny of rectangular paragraphs must be overthrown.
19203 In such situations, a call to the delightful plain TeX command
19210 As you can see, completely arbitrary shapes can be laid out with a suitable
19211 set of linelength definitions.
19212 While this parshape may look a bit silly and useless, one could conceive
19213 of situations such as finely tuned dropped capitals, word wrapping around
19214 non-rectangular graphics, etc.
19215 which will benefit from such handcrafting.
19218 \begin_layout Standard
19219 \begin_inset VSpace bigskip
19225 \begin_layout Standard
19230 parshape numlines #1indent #1length #2indent #2length \SpecialChar \ldots{}
19237 is the number of lines of text which define the paragraph.
19238 If there turn out to be fewer lines, the shape is truncated; if there are
19239 more, the excess lines have the same dimensions as the last line of the
19249 entries specify the indentation of the line from the left margin, and the
19250 length of the line as measured from that point.
19251 The shape applies only to the current paragraph; everything is reset to
19252 normal for the next paragraph.
19255 \begin_layout Standard
19259 \begin_layout Standard
19271 \begin_layout Section
19275 \begin_layout Standard
19276 As you can see, the examples in this section range from the useful to the
19278 While I don't expect that anyone will ever need the paragraph shape demonstrate
19279 d in the last section, the important point is that you can do almost anything
19280 you want in LyX if you are willing to figure out how to do it in TeX and
19282 TeX is a fantastically powerful typesetting system and all that power is
19283 available to you since LyX uses it as its backend.