1 #LyX 1.5.2svn 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 Subsection
2526 \begin_layout Standard
2527 When you are working on a large file with many sections, it is often convenient
2528 to break up the document into several files, or perhaps you have something
2529 where a table may change from time to time, but the preceding text does
2531 In these cases, you should seriously consider using multipart documents.
2532 For example, scientific papers often have five major sections: the introduction
2533 , observations, results, discussion, and conclusion.
2534 Each of these could be its own separate LyX file, with one
2535 \begin_inset Quotes eld
2539 \begin_inset Quotes erd
2542 file which contains the title, authors, abstract, references, etc., plus
2543 the five included files.
2544 It is important to note that each of these files is a full LyX file which
2545 can be formatted and printed on its own, as well as included in a master
2547 Each of these files must have the same document class, however--- don't
2548 attempt to mix book classes with article classes.
2549 You may also include LaTeX files; however, these files must not have their
2555 everything up to and including the
2567 line must be deleted) or else errors will be generated when you try to
2571 \begin_layout Standard
2572 LyX allows you to include files quite easily with
2577 nsert\SpecialChar \menuseparator
2586 When you click on this selection a small box is inserted into the file
2587 at the current cursor location.
2588 Clicking on the box raises a dialog which allows you to select the file
2589 to be included, and the method of its inclusion.
2593 \begin_layout Standard
2594 The file selection box should by now be obvious.
2595 The three inclusion methods are
2596 \begin_inset Quotes eld
2600 \begin_inset Quotes erd
2604 \begin_inset Quotes eld
2608 \begin_inset Quotes erd
2612 \begin_inset Quotes eld
2616 \begin_inset Quotes erd
2620 The difference between
2621 \begin_inset Quotes eld
2625 \begin_inset Quotes erd
2629 \begin_inset Quotes eld
2633 \begin_inset Quotes erd
2636 is really only meaningful to LaTeXperts, but the practical difference is
2637 that files which are
2638 \begin_inset Quotes eld
2642 \begin_inset Quotes erd
2645 are typeset beginning on a new page, while files which are
2646 \begin_inset Quotes eld
2650 \begin_inset Quotes erd
2653 are typeset starting on the current page.
2654 Perhaps the labeling in LyX will be changed someday to reflect this.
2657 \begin_layout Standard
2658 Generally, the master file is converted into a full LaTeX file before typesettin
2659 g, while the included files are converted to LaTeX files which do not have
2660 all the preamble information.
2670 button prevents this conversion.
2673 \begin_layout Standard
2675 \begin_inset Quotes eld
2679 \begin_inset Quotes erd
2682 included file allows you to include a file typeset exactly as it appears
2683 in the file, i.e.\InsetSpace ~
2684 verbatim mode, with the characters set in a fixed-width
2686 Normally, spaces in this file are invisible, though two consecutive spaces
2687 are conserved, unlike LyX's normal treatment of spaces.
2688 However, setting the
2698 checkbox typesets a mark to unambiguously define the presence of a space.
2702 \begin_layout Subsection
2703 Cross-References Between Files
2706 \begin_layout Standard
2707 It is possible to set up cross-references between the different files.
2708 First, open all the files in question: let's call them A and B in a two
2709 file example, where B is included in A.
2710 Let's say you insert a label in A, then want to reference it in B.
2711 Open the cross-reference dialog in whilst in document B, and you can select
2713 \begin_inset Quotes eld
2717 \begin_inset Quotes erd
2723 \begin_layout Section
2724 Fancy Headers and Footers
2727 \begin_layout Standard
2728 The default page layout is rather plain; for an article document class,
2729 all you get is a centered page number at the bottom of the page.
2730 This document is the book class, so it appears to be a bit fancier, but
2731 to really put on a show, you need to set the document page style to
2732 \begin_inset Quotes eld
2736 \begin_inset Quotes erd
2739 , as mentioned in the
2745 This section describes the LaTeX codes you need to insert in your LaTeX
2746 preamble or the text in order to get the desired effects.
2749 \begin_layout Standard
2750 The page header is divided into three fields, not surprisingly labeled
2751 \begin_inset Quotes eld
2755 \begin_inset Quotes erd
2759 \begin_inset Quotes eld
2763 \begin_inset Quotes erd
2767 \begin_inset Quotes eld
2771 \begin_inset Quotes erd
2775 The footer is also divided into these three fields.
2776 The LaTeX commands to set these fields in the simplest manner are
2801 Suppose you wish to put your name in the upper left hand corner of each
2803 Simply insert the following command in the preamble:
2806 \begin_layout Standard
2815 \begin_layout Standard
2816 You will now see your name in the upper left.
2817 If a field has a default entry that you would like to get rid of (often
2818 the page number appears in the central footer, simply include a command
2819 with a blank argument, e.\InsetSpace \thinspace{}
2823 \begin_layout Standard
2831 \begin_layout Standard
2832 Let's get really fancy: lets put the section number with the word
2833 \begin_inset Quotes eld
2837 \begin_inset Quotes erd
2840 (e.\InsetSpace \thinspace{}
2842 Section 3) in the upper left, the page number (e.\InsetSpace \thinspace{}
2844 Page 4) in the upper
2845 right, your name in the lower left, and the date in the lower right.
2846 The following commands should now appear in the preamble:
2849 \begin_layout Standard
2859 \begin_layout Standard
2867 \begin_layout Standard
2877 \begin_layout Standard
2886 \begin_layout Standard
2894 \begin_layout Standard
2904 \begin_layout Standard
2917 access LaTeX's section and page counters, and so print out the current
2918 section and page numbers.
2925 simply prints out today's date.
2928 \begin_layout Standard
2929 The thicknesses of the horizontal rules drawn beneath the header and above
2930 the footer can also be modified.
2931 If you don't want one of the headers, set its thickness to 0.
2932 The header rule has a default thickness of 0.4pt, the footer rule is 0pt.
2933 Use the commands, e.\InsetSpace \thinspace{}
2941 headrulewidth}{0.4pt}
2949 footrulewidth}{0.4pt}
2951 to set the thicknesses.
2954 \begin_layout Standard
2955 You can switch the header/footer settings on and off for individual pages
2960 thispagestyle{empty}
2966 thispagestyle{plain}
2972 thispagestyle{fancy}
2975 Simply insert them in the text on the page you want changed and mark them
2977 In fact, title pages are marked as plain by default, while following pages
2978 are marked fancy when using the global fancy setting.
2981 \begin_layout Standard
2982 There are more complex commands which will let you insert things in the
2983 upper left on odd numbered pages, etc., but I will refer you to the
2987 package documentation for more descriptions.
2988 For example, if you have a teTeX installation, look for
2990 /usr/share/texmf/doc/latex/fancyhdr/\SpecialChar \-
2996 \begin_layout Standard
2997 As a final example, it is possible to include an Encapsulated PostScript
2998 file in the header or footer.
2999 Suppose you want to put a company logo in the upper lefthand corner.
3000 You might try something like
3003 \begin_layout Standard
3012 includegraphics{logo.eps}}}
3015 \begin_layout Standard
3017 (you may need to preface this with
3021 usepackage{graphics}
3023 if you don't include EPS files elsewhere in your document).
3026 \begin_layout Section
3027 Itemize Bullet Selection
3028 \begin_inset LatexCommand label
3036 \begin_layout Standard
3042 \begin_layout Subsection
3046 \begin_layout Standard
3047 LyX provides 216 bullet shapes that can be accessed from a simple dialog.
3048 Using this dialog you can easily specify what bullet shape to use at each
3049 level of an itemized list.
3050 These settings are document-wide so you won't be able to specify different
3051 sets of bullets for different paragraphs
3055 \begin_layout Standard
3056 Well, actually you can but you'll have to do it by hand.
3064 \begin_layout Subsection
3068 \begin_layout Standard
3069 Open the dialog by selecting the
3074 ocument\SpecialChar \menuseparator
3081 menu item and then select the
3091 \begin_layout Standard
3092 The dialog provides you with a table of bullet shapes.
3093 A column of buttons on the left of the table provides access to the six
3094 different panels of bullet shapes.
3095 The row of buttons across the top is used to select which bullet depth
3097 A text entry under the table shows the currently selected bullet shape's
3098 LaTeX equivalent and this can be edited if desired.
3099 If you do modify the text you will also need to specify any needed packages
3100 in the LaTeX preamble.
3103 \begin_layout Standard
3104 The six panels are divided up by the packages they require.
3105 The following table shows the mappings from button name to LaTeX packages.
3108 \begin_layout Standard
3110 \begin_inset Tabular
3111 <lyxtabular version="3" rows="7" columns="2">
3113 <column alignment="center" valignment="top" leftline="true" width="0pt">
3114 <column alignment="center" valignment="top" leftline="true" rightline="true" width="0pt">
3115 <row topline="true" bottomline="true">
3116 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
3119 \begin_layout Standard
3134 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
3137 \begin_layout Standard
3153 <row topline="true">
3154 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
3157 \begin_layout Standard
3172 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
3175 \begin_layout Standard
3190 <row topline="true">
3191 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
3194 \begin_layout Standard
3209 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
3212 \begin_layout Standard
3228 <row topline="true">
3229 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
3232 \begin_layout Standard
3247 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
3250 \begin_layout Standard
3266 <row topline="true">
3267 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
3270 \begin_layout Standard
3285 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
3288 \begin_layout Standard
3304 <row topline="true">
3305 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
3308 \begin_layout Standard
3323 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
3326 \begin_layout Standard
3342 <row topline="true" bottomline="true">
3343 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
3346 \begin_layout Standard
3361 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
3364 \begin_layout Standard
3387 \begin_layout Standard
3388 LyX doesn't stop you using bullets from packages you don't have.
3389 If you get errors from LaTeX when you try to view or print the file then
3390 its likely you are missing a package.
3391 LyX doesn't restrict your use since you may be editing locally and exporting
3395 \begin_layout Subsection
3399 \begin_layout Standard
3400 Select which bullet depth you want to change then select the bullet shape
3402 Any changes will not be visible in LyX, but are visible when viewing the
3403 document using xdvi or ghostview.
3406 \begin_layout Standard
3407 You can reset a bullet shape to the default simply by clicking your right
3408 mouse button on the appropriate bullet depth button.
3411 \begin_layout Standard
3416 want to have multiple sets of paragraphs with different sets of bullets
3417 in each then you're going to have to get your hands dirty.
3418 The itemize bullet selection dialog can help though because it provides
3419 you with the LaTeX code for a wide range of bullet shapes.
3420 To make your own custom paragraphs you have the following options:
3423 \begin_layout Standard
3427 \begin_layout Standard
3443 \begin_layout Standard
3447 \begin_layout Standard
3469 \begin_layout Itemize
3470 Use the LaTeX command
3476 to specify a new bullet shape for a given depth.
3477 You'll also need to save the current bullet shape so you can restore it
3479 In this itemized list the following LaTeX code was used to change the bullet
3480 used for the first depth.
3512 Note that the itemize depth is specified in Roman numerals as part of the
3522 \begin_layout Itemize
3526 \begin_layout Standard
3539 Specify each individual entry by starting each item with the bullet shape
3540 enclosed in square brackets and set as TeX.
3541 For example, this item was started with
3554 \begin_layout Standard
3558 \begin_layout Standard
3574 \begin_layout Standard
3575 You'll also need to revert the labelitem back to its previous setting for
3576 the global bullet shape settings to remain in effect.
3577 The way used here was:
3590 \begin_layout Chapter
3591 Special Document Classes
3594 \begin_layout Section
3598 \begin_layout Standard
3604 \begin_layout Standard
3605 \begin_inset VSpace bigskip
3611 \begin_layout Standard
3613 The AMS LaTeX layouts are set up to conform to suggested styles for mathematical
3614 papers to be submitted to American Mathematical Society publications.
3615 The layouts are not tailored to a specific journal, but easily can be.
3616 You should refer to the AMS documentation for specific instructions for
3617 each journal (usually it will entail only changing a single line in the
3619 That documentation is available on the Web at
3620 \begin_inset LatexCommand url
3621 target "http://www.ams.org"
3626 \begin_inset LatexCommand url
3627 target "ftp://ftp.ams.org/pub/tex/amslatex/"
3631 .These layouts are appropriate, and useful, for any mathematical writing.
3632 There are currently 4 distinct AMS LaTeX layouts:
3635 \begin_layout Enumerate
3636 amsart: The standard AMS-article format.
3637 All results and similar statements are numbered as
3638 \begin_inset Formula $(n.m)$
3641 , where the first number refers to the section, and the second refers to
3642 the total number of results (Theorems, Corollaries, Propositions, Definitions
3643 and Remarks, etc.) in that section.
3644 There are also many (but not all) environments available unnumbered, which
3645 is occasionally needed.
3646 Unnumbered environments indicated by an asterisk at the end.
3649 \begin_layout Enumerate
3650 amsart-seq: Here, numbering for each type of statement is in its own sequence,
3651 with no reference to the section number.
3652 There are also many (but not all) environments available unnumbered, which
3653 is occasionally needed.
3654 Unnumbered environments indicated by an asterisk at the end.
3657 \begin_layout Enumerate
3658 amsart-plain: This one is even more terse, since all the environments are
3662 \begin_layout Enumerate
3663 amsbook: the standard AMS book (really, monograph) format.
3664 Numbering is similar to the amsart layout, except that all numbering is
3666 \begin_inset Formula $(n.m.p)$
3669 , where the first number refers to the chapter, the second to the section,
3670 and the third is the number of the results (Theorems, Corollaries, Propositions
3671 , Definitions and Remarks, etc.) in that section.
3672 There are also many (but not all) environments available unnumbered, which
3673 is occasionally needed.
3674 Unnumbered environments indicated by an asterisk at the end.
3677 \begin_layout Standard
3678 Any AMS LyX file can be converted to either of the numbering schemes by
3679 simply changing the document class in the
3684 ocument\SpecialChar \menuseparator
3695 \begin_layout Subsection
3696 What these layouts provide
3699 \begin_layout Standard
3700 There is a long list of included environments provided by these layouts.
3701 Most mathematical papers or books will set as special statements most of
3702 these environments, in AMS-LaTeX there is an opportunity to define an unlimited
3703 variety of such declarations.
3704 However, the AMS recommends the environments that are available in LyX.
3705 The list of environments (not counting the standard environments such as
3708 sections, bibliography, title, author, date
3713 \begin_layout Description
3714 Theorem This is typically used for the statements of major results.
3716 \begin_inset Quotes eld
3724 \begin_inset Quotes erd
3727 appears in bold type, along with an automatically-determined number (an
3732 , is also available).
3733 The text is italicized.
3736 \begin_layout Description
3737 Corollary This is used for statements which follow fairly directly from
3738 previous statements.
3739 Again, these can be major results.
3747 \begin_layout Description
3748 Lemma These are smaller results needed to prove other statements.
3751 \begin_layout Description
3752 Proposition These are less major results which (hopefully) add to the general
3753 theory being discussed.
3756 \begin_layout Description
3757 Conjecture These are statements provided without justification, which the
3758 author does not know how to prove, but which seem to be true (to the author,
3762 \begin_layout Description
3763 Criterion A required condition.
3766 \begin_layout Description
3767 Algorithm A general procedure to be used.
3770 \begin_layout Description
3771 Axiom This is a property or statement taken as true within the system being
3775 \begin_layout Description
3776 Definition Guess what this is for.
3777 The font, both on-screen and in the output, is different for this environment
3778 than for the previous ones.
3780 \begin_inset Quotes eld
3784 \begin_inset Quotes erd
3787 ) is still set in boldface, along with the number, if any, but the rest
3791 \begin_layout Description
3792 Example Typeset similarly to Definition.
3795 \begin_layout Description
3799 \begin_layout Description
3803 \begin_layout Description
3807 \begin_layout Description
3808 Remark This environment is also a new type of theorem.
3809 This is set with the word Remark in italics, and the rest upright.
3812 \begin_layout Description
3813 Note Set similarly to the Remark environment.
3816 \begin_layout Description
3820 \begin_layout Description
3824 \begin_layout Description
3828 \begin_layout Description
3832 \begin_layout Description
3833 Case Generally, these are used to break up long arguments, using specific
3834 instances of some condition.
3835 The numbering scheme for cases is on its own, not together with other numbered
3840 \begin_layout Description
3844 \begin_layout Description
3848 \begin_layout Description
3850 \begin_inset Quotes eld
3858 \begin_inset Quotes erd
3861 is set in italics, but the rest is set upright.
3862 At the end of this environment (other environments can be nested within
3863 this one, of course) a QED symbol (usually a square, but it can vary with
3864 different styles) is placed.
3867 \begin_layout Description
3868 Address This should be the author's permanent address.
3871 \begin_layout Description
3872 Current\InsetSpace ~
3873 Address This should be the author's temporary address at the time
3874 of submission, if different from the Address.
3877 \begin_layout Description
3878 Email Author's e-mail address
3881 \begin_layout Description
3882 URL Author's Web address, if desired.
3885 \begin_layout Description
3886 Keywords Key words or phrases used to identify specific topics discussed
3890 \begin_layout Description
3891 Subjectclass These refer to the AMS Subject Classifications, published and
3894 Mathematical Reviews
3897 These are also available online at the AMS cites listed above.
3900 \begin_layout Description
3904 \begin_layout Description
3908 \begin_layout Description
3912 \begin_layout Standard
3913 In addition, these environments automatically provide the AMS LaTeX and
3915 They need to be available on your system in order to use these environments.
3918 \begin_layout Section
3922 \begin_layout Standard
3927 can be used to type letters according to German conventions.
3928 A template file is included in
3930 .../lyx/share/templates
3932 for you to use as a starting point.
3935 \begin_layout Section
3939 \begin_layout Standard
3944 provides an alternative to the standard
3949 It provides similar functionality, but you might prefer this layout with
3950 sans serif sections, headings, and more.
3953 \begin_layout Section
3957 \begin_layout Standard
3963 \begin_layout Subsection
3967 \begin_layout Standard
3968 This section describes how LyX can be used to write articles for submission
3969 to the scientific journal
3971 Astronomy and Astrophysics
3974 \begin_inset LatexCommand url
3975 name "www.edpsciences.fr/aa/"
3976 target "http://www.edpsciences.fr/aa/"
3980 ) using Version 5.01 of the document class
3985 This package can be downloaded from the ftp site
3988 \begin_layout Standard
3989 \begin_inset VSpace medskip
3995 \begin_layout Standard
3997 \begin_inset LatexCommand url
3998 target "ftp://ftp.edpsciences.org/pub/aa/readme.html"
4005 \begin_layout Standard
4006 \begin_inset VSpace medskip
4012 \begin_layout Standard
4013 A manual comes together with that package, and this text is not meant to
4014 replace the original manual but merely a short guide how to realize the
4015 correct form of your paper.
4019 \begin_layout Standard
4020 Please note that the publisher of the journal was changed from Springer
4021 to EDP Sciences starting January 1, 2001.
4022 That change implicated also some slight changes of the style files, namely
4023 the removal of the thesaurus command.
4024 The LyX class aa supports the newest version of these style files, V 5.01.
4025 If you have an older version installed, please upgrade.
4026 For compatibility, the old (version 4) layout has been kept as
4031 Please refer to the comments in
4033 LyXDir/layouts/aapaper.layout
4038 \begin_layout Subsection
4042 \begin_layout Standard
4043 It is recommended you start from the example template distributed with LyX.
4044 If you are not using a template, note the following settings:
4047 \begin_layout Itemize
4057 ocument\SpecialChar \menuseparator
4064 dialog (OK, that one was obvious).
4067 \begin_layout Itemize
4068 Don't change the option
4078 The whole layout is done by the macros, you shouldn't change anything.
4081 \begin_layout Subsection
4085 \begin_layout Standard
4086 First thing to enter is the header information.
4087 It consists of seven entries, of which some are optional.
4091 \begin_layout Itemize
4099 \begin_layout Itemize
4107 \begin_layout Itemize
4115 \begin_layout Itemize
4123 \begin_layout Itemize
4128 : [optional] if more than one author: whom to contact for offprint requests.
4131 \begin_layout Itemize
4136 : [optional] mail address for contacts.
4139 \begin_layout Itemize
4147 Received: <date>; Accepted <date>
4150 \begin_layout Standard
4151 There is no need to issue the
4157 command, this is done automatically by LyX when the header is finished.
4158 Although the order of the single header entries doesn't matter it is advised
4159 to keep the above sequence, just to get the best optics and meets the layout
4160 of the real document.
4163 \begin_layout Standard
4164 If you want to place footnotes in the header block, e.\InsetSpace \thinspace{}
4169 \begin_layout Standard
4178 to state your present address, just use the standard footnote via
4183 nsert\SpecialChar \menuseparator
4191 LyX will automagically use the term
4200 \begin_layout Standard
4201 In addition to these topics, the macros use three additional LaTeX commands
4202 that have no counterpart in LyX:
4205 \begin_layout Itemize
4212 to separate different names for more than one author and institute, respectivel
4216 \begin_layout Itemize
4223 to mark corresponding author/institute pairs.
4224 The institutes are numbered sequentially as they appear in the
4228 field, so you have to put a marker to each author.
4231 \begin_layout Itemize
4238 to supply an email address for fast contact.
4241 \begin_layout Standard
4242 In all cases, the appropriate command has to be entered in LyX and marked
4248 \begin_layout Subsection
4252 \begin_layout Standard
4253 The abstract should immediately follow the header block.
4254 With version 5 the abstract environment was changed to a command, and there
4255 is now a resctriction to only one paragraph.
4256 In addition, it should contain an entry with the keywords.
4257 This is not yet implemented for LyX, therefore you have to enter the LaTeX
4264 by hand and mark it as LaTeX code.
4265 Refer to the example paper.
4268 \begin_layout Subsection
4269 Supported environments
4272 \begin_layout Standard
4273 The A&A paper layout supports the following environments for structuring
4277 \begin_layout Itemize
4283 \begin_layout Itemize
4289 \begin_layout Itemize
4295 \begin_layout Itemize
4301 \begin_layout Itemize
4307 \begin_layout Itemize
4313 \begin_layout Itemize
4319 \begin_layout Itemize
4325 \begin_layout Itemize
4331 \begin_layout Itemize
4337 \begin_layout Itemize
4343 \begin_layout Itemize
4349 \begin_layout Subsection
4350 Commands not supported by LyX
4353 \begin_layout Standard
4354 Some commands are not yet supported by the
4359 Some have already been mentioned.
4360 For the sake of completeness, they are listed all together here:
4363 \begin_layout Itemize
4371 \begin_layout Itemize
4379 \begin_layout Itemize
4387 \begin_layout Itemize
4395 \begin_layout Itemize
4403 \begin_layout Itemize
4411 \begin_layout Itemize
4419 \begin_layout Itemize
4427 \begin_layout Standard
4428 If you want to use any of these commands, you have to enter them yourself.
4431 Do not forget to mark them as LaTeX code!
4434 \begin_layout Subsection
4435 Figure and Table Floats
4438 \begin_layout Standard
4439 LyX provides support for the necessary float environments
4441 figure, figure*, table
4447 , therefore we won't tell much about it here.
4454 Just remember that tables should be left-aligned.
4455 For that, select the table and change the alignment in
4460 dit\SpecialChar \menuseparator
4465 aragraph\InsetSpace ~
4469 \begin_layout Standard
4470 There is only one special thing: the figures with caption besides the figure.
4471 To create such a figure, you have to do the following:
4474 \begin_layout Enumerate
4475 Create a wide figure float:
4480 nsert\SpecialChar \menuseparator
4485 t\SpecialChar \menuseparator
4488 , then right click in the figure and select
4499 \begin_layout Enumerate
4500 Enter your caption text.
4503 \begin_layout Enumerate
4508 to move the cursor above the caption.
4511 \begin_layout Enumerate
4515 \begin_layout Enumerate
4516 Position the cursor behind the figure and insert a horizontal fill:
4521 nsert\SpecialChar \menuseparator
4529 \SpecialChar \menuseparator
4532 orizontal\InsetSpace ~
4538 \begin_layout Enumerate
4539 Switch to LaTeX mode:
4547 \begin_layout Enumerate
4557 Do not close the brace!
4560 \begin_layout Enumerate
4561 Position the cursor behind the caption text, switch to LaTeX mode and insert
4574 \begin_layout Standard
4575 Also, refer to the figures in the example paper.
4578 \begin_layout Subsection
4582 \begin_layout Standard
4583 For submission, the paper has to be formated in a special double-spacing
4585 For this purpose, you have to give the option
4589 to the documentclass.
4590 This must be done using the extra class options field in the
4595 ocument\SpecialChar \menuseparator
4603 Just enter the string
4610 \begin_layout Subsection
4614 \begin_layout Standard
4619 directory contains an example paper written with LyX.
4620 It is the example paper from the original macro package, translated to
4622 Use it for inspiration, and compare the original LaTeX code with LyX way
4626 \begin_layout Section
4630 \begin_layout Standard
4636 \begin_layout Subsection
4640 \begin_layout Standard
4641 AASTeX is a set of macros produced by the American Astronomical Society
4642 to facilitate electronic manuscript submission to the three journals they
4643 publish: the Astrophysical Journal (including the Letters and Supplement),
4644 the Astronomical Journal, and the Publications of the Astronomical Society
4646 LyX has proven to be an excellent tool for generating these documents,
4647 especially given its equation, citation, and figure handling capabilities.
4648 LyX requires version 5.0 (or higher) of these macros; preferably 5.2, which
4649 is the version described here, or higher.
4650 Versions prior to 5.0 are intended for use with LaTeX2.09 and are fundamentally
4651 incompatible with LyX.
4652 The AASTeX package may be downloaded from the AASTeX Web site
4655 \begin_layout Standard
4656 \begin_inset VSpace medskip
4662 \begin_layout Standard
4664 \begin_inset LatexCommand url
4665 target "http://www.journals.uchicago.edu/AAS/AASTeX"
4672 \begin_layout Standard
4673 \begin_inset VSpace medskip
4679 \begin_layout Standard
4680 A complete user guide is contained in that package and you should familiarize
4681 yourself with it thoroughly before embarking on writing a paper in LyX.
4682 LyX will not reduce the need to figure out all the AASTeX commands, it
4683 will only reduce the drudgery of typing everything in.
4684 It is your responsibility to ensure that the final exported LaTeX document
4685 conforms completely to the requirements of the journal to which you are
4686 submitting your paper.
4689 \begin_layout Subsection
4690 Starting a New Paper
4693 \begin_layout Standard
4694 I strongly suggest that you start with the AASTeX template file.
4700 ile\SpecialChar \menuseparator
4710 , enter the new file name, then choose the
4715 This will show the most common fields found in a manuscript.
4716 Simply overwrite the existing text (including the brackets,
4720 ) with the correct information.
4721 Many of the AASTeX commands and environments can be implemented directly
4722 in LyX, but some cannot: most noticeably
4734 , which should stick out like a sore thumb if you actually just opened the
4736 For commands such as these, the LaTeX code must be entered directly and
4738 Such commands are referred to as ERT, or Evil Red Text.
4739 I tried to minimize the amount of ERT needed in an AASTeX document, but
4740 there is still a bit more required than any of us would like.
4743 \begin_layout Subsection
4744 Finishing Your Paper
4747 \begin_layout Standard
4748 When the paper is finished to your satisfaction and previews/prints correctly,
4750 \begin_inset Quotes eld
4754 \begin_inset Quotes erd
4757 actions which need to be done before you submit it to the journals.
4761 \begin_layout Enumerate
4762 Export your paper as a LaTeX file (
4767 ile\SpecialChar \menuseparator
4772 xport\SpecialChar \menuseparator
4783 \begin_layout Enumerate
4788 file with your favorite text editor
4792 \begin_layout Enumerate
4793 remove the comment lines before the
4802 \begin_layout Enumerate
4807 usepackage...{fontenc}
4809 line if it appears (usually just after
4824 \begin_layout Enumerate
4825 remove everything between (and including) the
4837 commands, except for any commands you specifically put into the LaTeX preamble
4838 (which should appear immediately after the
4839 \begin_inset Quotes eld
4842 User specified LaTeX commands
4843 \begin_inset Quotes erd
4854 \begin_layout Enumerate
4855 Run the resulting file through LaTeX to make sure it still processes correctly.
4858 \begin_layout Enumerate
4859 Reread the journal requirements to make sure your filenames and formats
4863 \begin_layout Enumerate
4867 \begin_layout Subsection
4868 Comments On Specific Commands
4871 \begin_layout Standard
4872 I will not describe the detailed usage of the individual AASTeX commands:
4873 the AASTeX User Guide (
4877 ) gives a good description of each.
4878 Thus it's probably easiest for me to go down the list as found in the guide
4879 and offer comments where necessary.
4880 So let's begin \SpecialChar \ldots{}
4884 \begin_layout Subsubsection
4885 Things that work as expected
4888 \begin_layout Standard
4892 \begin_layout Standard
4904 \begin_layout Standard
4905 Because they work as you might expect, I simply list them and the section
5006 begin{thebibliography}
5014 (2.13.2), all the cite commands and their variations (2.13.2), the generic
5015 graphicx figure commands (2.14.1),
5039 (2.15.4, amongst other places),
5066 \begin_layout Standard
5067 The following style options also work correctly:
5088 Simply put them in the
5094 Layout\SpecialChar \menuseparator
5100 \begin_layout Standard
5104 \begin_layout Standard
5116 \begin_layout Subsubsection
5117 Things that work, but require more comment
5120 \begin_layout Standard
5121 The following items work, but require a little more discussion:
5124 \begin_layout Itemize
5125 These items are reserved for use by the journal editors, but you can put
5126 them into the LaTeX preamble if you feel compelled to do so:
5159 \begin_layout Itemize
5160 These items may be placed in the LaTeX preamble, and are included as blanks
5161 in the template file:
5182 \begin_layout Itemize
5189 (2.3) -- can only be used
5190 \begin_inset Quotes eld
5194 \begin_inset Quotes erd
5197 , not in the middle of a paragraph.
5198 Use ERT if you need to embed it.
5201 \begin_layout Itemize
5208 (2.3) -- will have extra {} after it.
5209 This should not cause an error.
5212 \begin_layout Itemize
5219 (2.6) -- can only be used
5220 \begin_inset Quotes eld
5224 \begin_inset Quotes erd
5227 , not in the middle of a paragraph.
5228 Use ERT if you need to embed it.
5231 \begin_layout Itemize
5238 (2.8) -- can't insert a cross-reference tag, you must type the tag name
5242 \begin_layout Itemize
5249 (2.8) -- same as for
5256 \begin_layout Itemize
5263 (2.9) -- will have extra {} after it.
5264 This should not cause an error.
5267 \begin_layout Itemize
5274 (2.11) -- will have extra {} after it.
5275 This should not cause an error.
5278 \begin_layout Itemize
5285 (2.14.2) -- you can insert an optional filename argument by placing the cursor
5286 at the beginning of the text and selecting
5288 Insert\SpecialChar \menuseparator
5293 \begin_inset Quotes eld
5297 \begin_inset Quotes erd
5300 inserts an optional argument of the type needed by
5307 Hopefully it will be renamed someday.
5310 \begin_layout Itemize
5323 for the catalog ID optional parameter
5326 \begin_layout Itemize
5339 for the catalog ID optional parameter
5342 \begin_layout Subsubsection
5343 Things not implemented, use ERT
5346 \begin_layout Standard
5350 \begin_layout Standard
5362 \begin_layout Standard
5385 setcounter{equation}
5387 (2.12), Journal name abbreviations (2.13.4),
5423 (2.15.4, insert it as the first element in the lefthand cell after where
5425 Don't use any of LyX's rules in the table),
5437 (2.15.5), much of Misc (2.17, except
5488 \begin_layout Standard
5492 \begin_layout Standard
5504 \begin_layout Subsubsection
5505 Things that cannot be implemented
5508 \begin_layout Standard
5509 \SpecialChar \ldots{}
5510 at least in any meaningful sort of way, so I suggest ignoring them.
5511 They are the references environment (2.13.3), and the deluxetable environment
5513 If you really, really need to use deluxetable, I suggest editing it in
5514 a separate file with a text editor, then using
5519 nsert\SpecialChar \menuseparator
5527 to include it in your LyX document.
5532 file to see an example of this.
5535 \begin_layout Subsection
5536 FAQs, Tips, Tricks, and Other Ruminations
5539 \begin_layout Subsubsection
5540 Getting LyX and AASTeX to cooperate
5543 \begin_layout Standard
5544 It can be a bit tricky to get LyX to recognize a new layout and document
5546 When all else fails, do this:
5549 \begin_layout Enumerate
5550 Make certain that LaTeX can find AASTeX.
5551 Copy sample.tex (and perhaps table.tex) from the AASTeX distribution into
5552 a directory completely unrelated to LaTeX or AASTeX and run LaTeX on
5559 \begin_layout Enumerate
5566 /usr/.../share/lyx/layouts
5575 \begin_layout Enumerate
5581 ools\SpecialChar \menuseparator
5588 in LyX, then restart LyX.
5591 \begin_layout Enumerate
5592 Open a regular new file, not from a template.
5593 Does AASTeX appear in the class list in
5598 ocument\SpecialChar \menuseparator
5608 \begin_layout Standard
5609 If you get a warning from an existing AASTeX document about not being able
5610 to find the AASTeX layout or a message about
5611 \begin_inset Quotes eld
5614 You should not mix title layouts with normal ones
5615 \begin_inset Quotes erd
5618 , things haven't been installed correctly.
5621 \begin_layout Subsubsection
5622 LaTeX error processing a table
5625 \begin_layout Standard
5626 LyX, by default, attempts to center the table caption/title.
5627 This seems to produce a bad interaction in AASTeX so you should click somewhere
5628 in the caption/title, then select
5633 dit\SpecialChar \menuseparator
5638 aragraph\InsetSpace ~
5653 This took care of it for me.
5656 \begin_layout Subsubsection
5658 \begin_inset LatexCommand label
5666 \begin_layout Standard
5667 A couple of things: 1) I have noticed some funny spacing in the reference
5668 entries in the text.
5669 When you enter the bibliography item data, make sure their is
5673 space between the last author and the parenthesis setting off the year;
5676 e.\InsetSpace \thinspace{}
5689 2) Entering the references at all is not obvious.
5690 The easiest thing is to start typing your first reference at the end of
5691 the document, then mark it as type
5696 That will put a small gray box in front of what you just typed.
5697 Click on the box to fill in the rest of the information.
5698 For new references, go to the end of an existing reference and press return.
5699 That will create a new line with its own box, etc.
5702 \begin_layout Subsubsection
5706 \begin_layout Standard
5707 Even though AASTeX provides its own figure commands (
5713 , for example), I much prefer LaTeX's standard figure commands (with the
5722 commands as ERT into a Figure Float box if you desire, but I never
5723 have much luck getting the layout right.
5724 With the standard graphics, LyX will insert a
5728 usepackage{graphicx}
5730 command into the LaTeX preamble and handle the figures in the standard
5731 LaTeX2e way, interspersing the figures in the text.
5732 I believe ApJ accepts figures exactly this way now; AJ might still use
5734 \begin_inset Quotes eld
5737 stack everything at the end
5738 \begin_inset Quotes erd
5744 \begin_layout Subsubsection
5745 Things I could have done, but didn't
5748 \begin_layout Standard
5750 \begin_inset Quotes eld
5754 \begin_inset Quotes erd
5757 things I could have implemented, but chose not to.
5758 For instance, I saw no point in double-spacing the text in the LyX window,
5759 even though it is double-spaced in the paper manuscript.
5760 Also, I chose not to make separate layouts for the preprint and preprint2
5762 Since I assume you will spend most of your time in the plain manuscript
5763 mode anyway, I decided not to chew up more disk space with this.
5767 \begin_layout Subsection
5771 \begin_layout Standard
5772 Your mileage may vary.
5773 I've now had papers published by both ApJ and AJ that have had 98% of the
5774 effort done in LyX; the last 2% was the LaTeX post-processing and a few
5776 I have had no trouble with the submission process, and I'm sure the journals
5777 were never aware that there might be a difference.
5778 So, go forth and publish!
5781 \begin_layout Section
5785 \begin_layout Standard
5788 Panayotis Papasotiriou
5791 \begin_layout Subsection
5795 \begin_layout Standard
5796 The ijmpc package is a set of macros that facilitates electronic manuscript
5799 International Journal of Modern Physics C
5802 Similarly, the ijmpd package is for creating manuscripts to be submitted
5805 International Journal of Modern Physics D
5808 Both journals are published by World Scientific.
5809 The corresponding document classes are named
5818 These files, together with instructions for the authors, can be downloaded
5820 \begin_inset LatexCommand url
5821 target "http://www.worldscinet.com/ijmpc/mkt/guidelines.shtml"
5826 \begin_inset LatexCommand url
5827 target "http://www.worldscinet.com/ijmpd/mkt/guidelines.shtml"
5832 Both packages are modified versions of the standard
5833 \begin_inset Quotes eld
5837 \begin_inset Quotes erd
5840 package, and they are almost (but not exactly) identical.
5841 Most of their features are supported by LyX.
5842 I have used LyX successfully to write articles submitted to both journals
5843 without any problem.
5846 \begin_layout Subsection
5850 \begin_layout Standard
5851 As usual, the easiest way to write a paper is to start with a template.
5857 ile\SpecialChar \menuseparator
5876 This will give an (almost) empty document that includes the most common
5877 fields found in a manuscript.
5878 Simply overwrite the existing text (including the brackets,
5883 You should keep in mind the following remarks.
5886 \begin_layout Enumerate
5887 LyX won't let you change the font size and the page style of the document,
5888 because such modifications are not allowed by both packages.
5891 \begin_layout Enumerate
5892 The language of the document should not be changed.
5893 Before previewing your paper, be sure that the babel package is not used.
5894 To do this, click on
5899 ools\SpecialChar \menuseparator
5917 checkbox in the language settings, and click on
5928 , if you wish to make this change permanent).
5931 \begin_layout Enumerate
5933 \begin_inset Quotes eld
5937 \begin_inset Quotes erd
5940 style must be used to define keywords.
5943 \begin_layout Enumerate
5944 The ijmpc package provides a style named
5945 \begin_inset Quotes eld
5948 Classification Codes
5949 \begin_inset Quotes erd
5952 , which can be used to define classification codes, such as PACS numbers.
5953 Note that this facility is not supported by the ijmpd package.
5956 \begin_layout Enumerate
5957 Several new environments are available:
5958 \begin_inset Quotes eld
5962 \begin_inset Quotes erd
5966 \begin_inset Quotes eld
5970 \begin_inset Quotes erd
5974 \begin_inset Quotes eld
5978 \begin_inset Quotes erd
5982 \begin_inset Quotes eld
5986 \begin_inset Quotes erd
5990 \begin_inset Quotes eld
5994 \begin_inset Quotes erd
5998 \begin_inset Quotes eld
6002 \begin_inset Quotes erd
6006 \begin_inset Quotes eld
6010 \begin_inset Quotes erd
6014 \begin_inset Quotes eld
6018 \begin_inset Quotes erd
6022 \begin_inset Quotes eld
6026 \begin_inset Quotes erd
6030 \begin_inset Quotes eld
6034 \begin_inset Quotes erd
6038 \begin_inset Quotes eld
6042 \begin_inset Quotes erd
6046 \begin_inset Quotes eld
6050 \begin_inset Quotes erd
6054 \begin_inset Quotes eld
6058 \begin_inset Quotes erd
6062 \begin_inset Quotes eld
6066 \begin_inset Quotes erd
6070 Their use is more or less obvious.
6071 LyX supports all these environments; it will use the proper label, text
6072 style, and numbering scheme for each of them.
6075 \begin_layout Enumerate
6076 Both packages use basic citations; the natbib package should not be used.
6077 In LyX, citation references are shown as usual; in the output, citations
6078 are shown as superscripts.
6079 If you want to use a citation as normal text, you should use the
6083 command, e.\InsetSpace \thinspace{}
6085 \begin_inset Quotes eld
6088 See Ref.\InsetSpace ~
6096 \begin_inset Quotes erd
6102 \begin_layout Enumerate
6104 \begin_inset Quotes eld
6108 \begin_inset Quotes erd
6111 section in both packages.
6112 To put acknowledgments, just use the
6113 \begin_inset Quotes eld
6117 \begin_inset Quotes erd
6123 \begin_layout Enumerate
6124 Appendices may be added to the paper,
6128 the Acknowledgments and
6133 LyX provides a special environment, called
6134 \begin_inset Quotes eld
6138 \begin_inset Quotes erd
6141 which marks the beginning of the appendices.
6142 This environment should be left blank; it just sends a LaTeX command, but
6143 nothing is really printed.
6145 \begin_inset Quotes eld
6149 \begin_inset Quotes erd
6152 is printed with blue letters, as a signal that all sections after that
6153 point are appendices.
6154 To write an appendix, use the
6155 \begin_inset Quotes eld
6159 \begin_inset Quotes erd
6163 LyX will number each appendix with capital letters, as required by both
6166 \begin_inset Quotes eld
6170 \begin_inset Quotes erd
6177 be present before the first appendix; if not, all appendices will be numbered
6178 as normal sections in the output.
6181 \begin_layout Enumerate
6182 The ijmpc and the ijmpd packages use the
6186 command to implement table captions.
6187 As a result, a table created by LyX is printed correctly, but its caption
6189 However, you can use some ERT to overpass this problem, so that captions
6190 are printed as expected.
6191 To do so, create a float table as usual, remove the caption, and replace
6202 (sic); you must also the ERT
6206 immediately after the tabular material.
6207 Study the example table included in the template files to see how this
6208 trick is implemented.
6209 Alternatively, If you need table captions, you should implement the whole
6214 file, then include this file to the LyX document (
6219 nsert\SpecialChar \menuseparator
6224 \SpecialChar \menuseparator
6233 Details on how to create a table float can be found in the files
6241 , included in the corresponding packages.
6244 \begin_layout Subsection
6245 Preparing a paper for submission
6248 \begin_layout Standard
6249 Before you submit your paper you must export the LyX document as a LaTeX
6255 ile\SpecialChar \menuseparator
6260 xport\SpecialChar \menuseparator
6275 \begin_layout Standard
6276 Actually you have the choice between LaTeX (plain) and pdflatex.
6277 If you intend to use pdflatex to prepare the paper, you should use the
6278 pdflatex option so that included graphics are converted to PDF format,
6279 ready for use by pdflatex.
6284 , then make the following changes to the resulting
6291 \begin_layout Enumerate
6292 Remove the comment lines before the
6301 \begin_layout Enumerate
6302 Remove everything between (and including) the
6314 commands, except for any commands you specifically put into the LaTeX preamble.
6317 \begin_layout Standard
6322 file should be saved and processed through LaTeX as many times as necessary.
6323 You may also want to check the resulting
6330 \begin_layout Subsection
6334 \begin_layout Standard
6335 The use of ERT is reduced to two commands, which must be placed at the top
6337 If you started writing your paper by using the
6345 template, the ERT needed is already in its place; you usually don't need
6347 You may only modify the first ERT to specify the information printed to
6348 the top of odd and even pages (authors' names and short paper's title,
6350 This ERT must have the form
6354 markboth{Authors' Names}{Short Paper's Title}
6359 \begin_layout Section
6363 \begin_layout Standard
6369 \begin_layout Subsection
6373 \begin_layout Standard
6374 The iopart package provides a document class to create electronic manuscript
6375 submission to the journals published by the Institute of Physics.
6376 Instructions for the authors how to create a paper using the iopart class
6377 can be downloaded together with the iopart package from the site
6378 \begin_inset LatexCommand url
6379 target "ftp://ftp.iop.org/pub/journals/latex2e"
6386 \begin_layout Subsection
6390 \begin_layout Standard
6391 The easiest way to write a paper is to start with the file
6395 that is available in LyX's examples files folder.
6396 Open this file, save it under a new name, and start writing.
6397 The example file explains how to use the special text environments.
6398 Here are the most important advices:
6401 \begin_layout Itemize
6402 To be able to compile your document to a PDF, PS, or DVI, assure that the
6405 Use AMS math package
6407 in the document settings under
6414 \begin_layout Itemize
6417 The title environment defines the kind of your paper.
6418 So use one of the following environments for the title:
6422 \begin_layout Itemize
6431 \begin_layout Itemize
6440 \begin_layout Itemize
6446 for a Topical review
6449 \begin_layout Itemize
6458 \begin_layout Itemize
6467 \begin_layout Itemize
6473 for a Paper (same as Title)
6476 \begin_layout Itemize
6482 for a Preliminary communication
6485 \begin_layout Itemize
6491 for a Rapid communication
6494 \begin_layout Itemize
6500 for a Letter to the editor
6504 \begin_layout Itemize
6507 All title environments except of
6511 can have an optional short title.
6514 \begin_layout Itemize
6515 There is a general title environment
6519 which is not directly supported by the LyX.
6520 This can be used as ERT when your document doesn't fit into one of the
6524 \begin_layout Standard
6525 For more informations like hints for special table and formula formatting,
6526 look at the IOP author guidelines.
6529 \begin_layout Section
6533 \begin_layout Standard
6536 Panayotis Papasotiriou
6539 \begin_layout Subsection
6543 \begin_layout Standard
6544 The Kluwer package is a set of macros produced by Kluwer Academic Publishers
6545 that facilitates electronic manuscript submission to the journals they
6547 Most known of them (at least in my domain of interest) are
6549 Astrophysics and Space Science
6555 , but there are many others (see a complete list at
6556 \begin_inset LatexCommand url
6557 target "http://www.wkap.nl/jrnllist.htm/JRNLHOME"
6562 The Kluwer package may be downloaded from the site
6563 \begin_inset LatexCommand url
6564 target "http://www.wkap.nl/kaphtml.htm/STYLEFILES"
6569 A complete user guide is contained in that package (but it can also be
6570 downloaded separately).
6573 \begin_layout Standard
6574 LyX supports many features of the package but not everything.
6575 However, the ERT needed is reduced to some
6576 \begin_inset Quotes eld
6580 \begin_inset Quotes erd
6583 commands of the package (see\InsetSpace ~
6585 \begin_inset LatexCommand ref
6586 reference "subsec:kluwer_peculiarities"
6591 I have recently used LyX to write an article submitted to the
6593 Astrophysics and Space Science
6595 without any problem.
6598 \begin_layout Subsection
6602 \begin_layout Standard
6603 The easiest way to write a paper is to start with the Kluwer template file.
6606 File\SpecialChar \menuseparator
6621 This will give an (almost) empty document that includes the most common
6622 fields found in a manuscript and a short description of their use.
6623 As in most templates, simply overwrite the existing text (including the
6628 ) with the correct information.
6631 \begin_layout Subsection
6632 Preparing a paper for submission
6635 \begin_layout Standard
6636 As in the AASTeX package, before you submit your paper to a journal you
6638 \begin_inset Quotes eld
6642 \begin_inset Quotes erd
6648 \begin_layout Enumerate
6649 Export your paper as a LaTeX file.
6650 To do this, click on
6655 ile\SpecialChar \menuseparator
6660 xport\SpecialChar \menuseparator
6671 \begin_layout Enumerate
6676 file with a text editor and make the following changes
6680 \begin_layout Enumerate
6681 remove the comment lines before the
6690 \begin_layout Enumerate
6691 remove everything between (and including) the
6703 commands, except for any commands you specifically put into the LaTeX preamble.
6706 \begin_layout Standard
6715 \begin_layout Enumerate
6720 file through LaTeX as many times as necessary (usually up to three).
6723 \begin_layout Enumerate
6728 document using, e.\InsetSpace \thinspace{}
6733 , and check if everything is OK (it should, if you didn't make any mistake).
6736 \begin_layout Subsection
6737 \begin_inset Quotes eld
6741 \begin_inset Quotes erd
6744 of the Kluwer package
6745 \begin_inset LatexCommand label
6746 name "subsec:kluwer_peculiarities"
6753 \begin_layout Standard
6754 The Kluwer package has the following
6755 \begin_inset Quotes eld
6759 \begin_inset Quotes erd
6765 \begin_layout Enumerate
6766 It is possible to write multiple articles in the same LaTeX file
6770 \begin_layout Standard
6771 I can't imagine any good reason to do this.
6777 Each article must be included in the environment
6778 \begin_inset Quotes eld
6782 \begin_inset Quotes erd
6786 Unfortunately, this environment cannot be omitted, even if you write just
6788 Therefore, each article starts with the command
6794 and, obviously, ends with the command
6801 Although this can be implemented in LyX, I didn't included it, since it
6802 looks ugly and can confuse the novice user.
6803 Therefore, you need to enter them directly and mark them as LaTeX code
6805 \begin_inset Quotes eld
6809 \begin_inset Quotes erd
6815 \begin_layout Enumerate
6816 Information given at the beginning of the article (i.e., title, subtitle,
6817 author, institution, running title, running author, abstract and keywords)
6818 must be included in an environment called
6819 \begin_inset Quotes eld
6823 \begin_inset Quotes erd
6827 This is not implemented in LyX, so you must enter title, subtitle etc.\InsetSpace ~
6844 \begin_layout Enumerate
6845 According to the user manual, the label of each bibliography item must be
6869 \begin_layout Standard
6874 template takes care of all these
6875 \begin_inset Quotes eld
6879 \begin_inset Quotes erd
6883 If you start a new paper using this template you don't need to do anything
6888 \begin_layout Enumerate
6889 don't delete the ERT included in the template, and
6892 \begin_layout Enumerate
6893 copy the example bibliography item included in the template and modify it
6894 as necessary to enter new bibliography items.
6897 \begin_layout Section
6901 \begin_layout Standard
6907 \begin_layout Subsection
6911 \begin_layout Standard
6912 The LyX document classes
6914 article (koma-script)
6918 report (koma-script)
6936 correspond to the LaTeX document classes
6952 , resp.\InsetSpace ~
6953 of the Koma-Script family.
6954 They are replacements for the standard document classes
6970 , resp., and fit better to European typography conventions in a number of
6974 \begin_layout Itemize
6975 Standard character size is 11pt in
6977 article (koma-script)
6981 report (koma-script)
6989 letter (koma-script)
6994 \begin_layout Itemize
6995 Headings, labels of the description environment, and a number of elements
6998 letter (koma-script)
7000 document class are set in a bold sans serif font.
7004 \begin_layout Standard
7005 There is a big difference between the bold sans serif old cm fonts and new
7006 ec fonts, especially in the appearance of headings.
7007 In comparison, the ec bold sans serif fonts look a bit thin.
7008 Here the LaTeX package
7016 helps to produce the
7017 \begin_inset Quotes eld
7021 \begin_inset Quotes erd
7024 appearance when using the ec fonts.
7029 The numbering of chapter headings is made in the same way as the numbering
7030 of section headings, that is without the extra line
7031 \begin_inset Quotes eld
7034 Chapter\SpecialChar \ldots{}
7036 \begin_inset Quotes erd
7040 In addition, the appearance of the headings can be modified by using a
7041 number of options (in LyX to be entered in the field
7055 ayout\SpecialChar \menuseparator
7063 A detailed German description of these options can be found in the Koma-Script
7071 \begin_layout Itemize
7072 The main means in the Koma-Script document classes to design the type area
7081 (in LyX to be entered in the extra class options field in the dialog
7086 ocument\SpecialChar \menuseparator
7094 They make a clearer modification of page margins possible as do the options
7100 ocument\SpecialChar \menuseparator
7108 A detailed German description of these and other type area options can
7109 be found in the Koma-Script documentation
7116 \begin_layout Itemize
7117 The LaTeX document classes of the Koma-Script family define a number of
7118 additional commands.
7119 Those part of it which makes sense in LyX is implemented in corresponding
7123 \begin_layout Standard
7124 A detailed German description of the LaTeX document classes of the Koma-Script
7125 family can be found in the Koma-Script documentation
7133 \begin_layout Standard
7134 There is an English translation
7138 , but it is not a complete one.
7143 The following sections describe only those aspects, which are relevant
7147 \begin_layout Subsection
7148 article (koma-script), report (koma-script), and book (koma-script)
7151 \begin_layout Standard
7152 The document classes
7154 article (koma-script)
7158 report (koma-script)
7168 are implemented in the layout files
7181 They contain all the paragraph types of the corresponding standard document
7194 , resp., partly modified, with the exception of the LyX specific
7198 -type, which is replaced by the new
7202 -type having the same functionality.
7207 -Type there is a number of new paragraph types added.
7214 letter (koma-script)
7219 \begin_layout Itemize
7228 : are equivalents to
7236 , resp., additionally inserting an entry in the table of contents.
7245 are not contained in
7247 article (koma-script)
7252 \begin_layout Itemize
7269 , resp., additionally clearing running heads.
7276 article (koma-script)
7282 \begin_layout Standard
7295 report (koma-script)
7297 , but since this is identical to
7301 , is has not been implemented in LyX.
7309 \begin_layout Itemize
7314 : generates a heading directly above the following paragraph in the standard
7315 character size without affecting the structure of the document.
7318 \begin_layout Itemize
7327 are special captions which respect the different space settings needed
7328 for captions placed above or below an element (if you follow strict typographic
7329 rules, you might want to place table captions always above the table).
7330 You can also use the class option
7347 You need at least Koma-Script version 2.8q to use this.
7350 \begin_layout Itemize
7355 : can be used to set a bonmot, e.
7359 \begin_layout Standard
7372 \begin_layout Standard
7381 at the beginning of a chapter.
7382 If you use the optional argument (
7387 nsert\SpecialChar \menuseparator
7391 ), you can insert the dictum's author there.
7392 Dictum and author are separated by a line.
7393 You need at least Koma-Script version 2.8q to use this.
7400 article (koma-script)
7405 \begin_layout Standard
7406 The following types, together with the standard types
7418 , form the title area of the document.
7419 They must be entered ahead of the first
7420 \begin_inset Quotes eld
7424 \begin_inset Quotes erd
7431 \begin_layout Standard
7432 The corresponding LaTeX commands must appear before the
7443 When such a type is used more than once, the latter usage overwrites the
7444 former one, that means, for every type only the latest usage is valid.
7445 The order of the different types however has, like
7457 , no effect on the appearance of the produced document.
7460 \begin_layout Itemize
7465 : produces a centered paragraph above the ordinary title (
7477 ) for the subject of the document.
7480 \begin_layout Itemize
7485 : produces a centered paragraph below the ordinary title (
7497 ) for the publishers' name.
7500 \begin_layout Itemize
7507 report (koma-script)
7513 produces a centered paragraph on its own page behind the title page, or
7516 article (koma-script)
7518 produces a centered paragraph below the ordinary title (
7537 \begin_layout Itemize
7542 : produces a left aligned paragraph above the ordinary title (
7558 ) for a document`s head.
7561 \begin_layout Itemize
7566 : produces in a double-sided print in
7568 report (koma-script)
7574 a left-aligned paragraph at the top of the title page`s back or has no
7575 effect in a single-sided print or in
7577 article (koma-script)
7582 \begin_layout Itemize
7587 : produces in a double-sided print in
7589 report (koma-script)
7595 a left-aligned paragraph at the bottom of the title page`s back or has
7596 no effect in a single-sided print or in
7598 article (koma-script)
7603 \begin_layout Itemize
7608 : produces a special
7609 \begin_inset Quotes eld
7613 \begin_inset Quotes erd
7616 page ahead of the actual document containing a paragraph without special
7620 \begin_layout Standard
7621 The layout files for the document classes
7623 article (koma-script)
7627 report (koma-script)
7638 This is thought of as a place to define your own types.
7643 in your personal layout directory and edit the file!
7646 \begin_layout Subsection
7647 letter (koma-script)
7650 \begin_layout Standard
7654 \begin_layout Standard
7666 \begin_layout Standard
7670 letter (koma-script)
7672 is implemented in the layout file
7677 It contains all the paragraph types of the corresponding standard document
7682 , partly modified, with the exception of the LyX specific types
7694 type, which is replaced by the new
7699 In addition, it contains, in contrast to the standard document class, the
7717 Furthermore, there are a number of new letter specific types.
7720 \begin_layout Standard
7724 \begin_layout Standard
7736 \begin_layout Standard
7737 The appearance of the letter produced by this document class can be controlled
7738 by a number of LaTeX commands, which you can put in the LaTeX preamble.
7742 \begin_layout Standard
7743 For example, the standard appearance of the letter`s heading, consisting
7744 of name and address, is quite self-willed.
7746 \begin_inset Quotes eld
7750 \begin_inset Quotes erd
7753 heading is produced by the following LaTeX commands in the preamble:
7756 \begin_layout LyX-Code
7766 \begin_layout LyX-Code
7782 \begin_layout LyX-Code
7792 \begin_layout LyX-Code
7812 A detailed German description of such LaTeX commands can be found in the
7813 Koma-Script documentation
7818 With it, the letter's author can produce his personal letter layout.
7821 \begin_layout Standard
7830 define the beginning of the letter and must be used in every letter.
7831 To emphasize them in the LyX document class, they are marked with the letter
7840 , resp.\InsetSpace ~
7842 It is possible to write any number of letters in one file.
7847 type produces a new letter using the same addressee and a
7851 type produces a new addressee.
7868 are ordinary paragraph types and can also be used several times in one
7869 and the same letter.
7872 \begin_layout Itemize
7877 : produces a paragraph for the addressee and implicitly defines the beginning
7881 \begin_layout Itemize
7886 : produces a paragraph for the form of address and implicitly produces a
7890 \begin_layout Itemize
7895 : produces a paragraph for a close.
7898 \begin_layout Itemize
7903 : produces a paragraph for a postscript.
7906 \begin_layout Itemize
7911 : produces a paragraph for a distribution list.
7914 \begin_layout Itemize
7919 : produces a paragraph for enclosures.
7922 \begin_layout Standard
7963 are input types provided with a label to enter information, which will
7964 be processed by the document class.
7968 \begin_layout Standard
7969 It could be seen as a matter of inconsequence, that the types
7977 described above are not such input types as well.
7978 Because of the special meaning of those types, however, I have implemented
7979 them as ordinary paragraph types with a one letter mark in the left margin.
7980 Moreover, it would affect my feeling of symmetry, if the
7988 type had such a serious different appearance.
7993 The types must be used ahead of the corresponding
8000 \begin_layout Standard
8001 An implementation of these types in a WYSIWYG fashion does not seem to make
8002 sense, because the real appearance of the produced letter does not only
8003 depend on the usage of the particular type, but also on other factors.
8004 For example, a signature entered in the
8008 type will in the standard behavior appear in the produced letter only,
8009 when in the same letter also a
8014 The entered value of the
8018 type will in the standard behavior not appear in the produced letter at
8020 The possibility to design the letter`s heading freely is already indicated
8021 in a footnote above.
8024 \begin_layout Standard
8025 The input types can also be used as empty paragraphs.
8026 This makes sense e.\InsetSpace \thinspace{}
8037 type is not used at all, in the standard behavior the value of the
8041 type is used as signature, whereas if an empty
8045 type is used, no signature value is defined.
8048 \begin_layout Standard
8049 By using the input types it is possible to write a letter template, containing
8050 filled input types with your personal dates (name, address, etc.) and empty
8051 input types for other dates you want to enter.
8054 \begin_layout Itemize
8059 : sender's name, in the standard behavior appears as a centered paragraph
8060 in small caps in the letter`s heading.
8063 \begin_layout Itemize
8068 : sender's signature, in the standard behavior appears below the
8077 type is used, the value of the
8081 type appears instead.
8084 \begin_layout Itemize
8089 : sender's address, in the standard behavior appears in a centered paragraph
8090 in the letter`s heading below the sender's name.
8093 \begin_layout Itemize
8098 : sender's telephone number, in the standard behavior only sets the LaTeX
8108 \begin_layout Itemize
8113 : place of the letter`s making.
8116 \begin_layout Itemize
8121 : date of the letter`s making.
8130 , in the standard behavior, produce the place and the date in a right-aligned
8131 line below the addressee's field.
8136 type is used, neither place nor date appear, independent of the value of
8146 type is used, the date of the letter `s production is used.
8149 \begin_layout Itemize
8154 : sender`s back address, in the standard behavior appears above the addressee's
8155 field in a small sans serif font.
8158 \begin_layout Itemize
8163 : special mail information, in the standard behavior appears underlined
8164 above the addressee's field below the back address.
8167 \begin_layout Itemize
8172 : additional information, in the standard behavior appears on right side
8173 below the addressee`s field.
8176 \begin_layout Itemize
8181 : the letter's title, in the standard behavior appears in a big, bold, sans
8182 serif font above the subject.
8185 \begin_layout Itemize
8190 : the letter's subject, in the standard behavior appears in a bold font
8198 \begin_layout Standard
8219 produce a business letter like line above the
8223 line containing the fields
8224 \begin_inset Quotes eld
8228 \begin_inset Quotes erd
8232 \begin_inset Quotes eld
8236 \begin_inset Quotes erd
8240 \begin_inset Quotes eld
8244 \begin_inset Quotes erd
8248 \begin_inset Quotes eld
8252 \begin_inset Quotes erd
8256 \begin_inset Quotes eld
8260 \begin_inset Quotes erd
8264 \begin_inset Quotes eld
8268 \begin_inset Quotes erd
8272 For the date field, the value of the
8278 \begin_inset Quotes eld
8281 business letter types
8282 \begin_inset Quotes erd
8285 is used, the value of the
8289 type however does not appear, but only the LaTeX variable
8296 The ordinary output of place and date in a right-aligned line below the
8297 addressee`s field is suppressed.
8298 The types are implemented as input types provided with a label and must
8299 be used ahead of the corresponding
8306 \begin_layout Itemize
8314 \begin_layout Itemize
8322 \begin_layout Itemize
8330 \begin_layout Itemize
8338 \begin_layout Itemize
8346 \begin_layout Subsection
8347 The new letter class: letter (koma-script v.2)
8350 \begin_layout Standard
8353 Jürgen Spitzmüller
8356 \begin_layout Standard
8357 \begin_inset VSpace medskip
8363 \begin_layout Standard
8365 Koma-Script version 2.8 has introduced a new letter class
8369 which supersedes the now unsupported
8374 It has --- on the LaTeX side --- a completely new interface and is not
8375 compatible with the old class.
8376 Therefore, LyX supports both, though it is recommended to use the new class.
8379 \begin_layout Standard
8380 This class covers the same functionality as
8382 letter (koma-script),
8389 (receiver's address, same as
8406 will start a new letter (i.
8410 \begin_layout Standard
8423 \begin_layout Standard
8432 you can write several letters per document).
8433 New elements are sender's
8449 and the possibility to use a
8458 nsert\SpecialChar \menuseparator
8468 \begin_layout Standard
8469 The biggest improvement is, though, that the letter's layout is configurable
8470 at almost any needs.
8471 This can be done via the preamble or with a special style file (Letter
8472 Class Option, extension
8476 ), that will be read in as a class option.
8480 \begin_layout Standard
8481 The KOMA package comes with some default
8486 There is, for instance, a
8490 file that follows german typesetting rules, or a
8494 that provides the default layout of the old
8499 The latter can be loaded with the class option
8508 ayout\SpecialChar \menuseparator
8513 ocument\SpecialChar \menuseparator
8525 template that is included in LyX for examples.
8526 A detailed description is to be found in the Koma-Script documentation
8534 \begin_layout Subsection
8538 \begin_layout Standard
8539 Visualizing the Koma-Script document classes in LyX, the LyX internals cause
8543 \begin_layout Itemize
8544 The chapter number of a
8548 type appears on a line of its own above the chapter heading instead of
8549 appearing in the same line ahead of it.
8550 The cause for that is the LyX internal behavior for the labeltype
8557 \begin_layout Itemize
8558 The headings of the types
8567 \begin_inset Quotes eld
8571 \begin_inset Quotes erd
8574 LaTeX table of contents, but not in the LyX table of contents (
8579 ocument\SpecialChar \menuseparator
8591 \begin_layout Itemize
8596 document class appear in a skip separation mode, not indented.
8597 This is the standard behavior, no special LaTeX commands are needed for
8604 ocument\SpecialChar \menuseparator
8611 dialog the corresponding radio button indicates
8627 value always has the effect that extra LaTeX commands are inserted in the
8628 document to produce the gap, which is not what is wanted in this case.
8631 \begin_layout Section
8639 \begin_layout Standard
8645 \begin_layout Subsection
8649 \begin_layout Standard
8650 These are the layout files for some of the journal formats used by Springer
8651 Verlag and listed on
8652 \begin_inset LatexCommand url
8653 target "http://www.springer.de/author/tex/help-journals.html"
8657 , where you should also go to fetch the class files (yes, these are LaTeX2e
8659 It is a modular system: the things common to all journals are implemented
8664 , which journal-specific layout files (such as, e.\InsetSpace \thinspace{}
8669 for Journal of Geodesy) can include.
8672 \begin_layout Standard
8673 This means that implementing support for any other Springer journal on this
8674 list is as simple as writing your own
8682 file following the outline given in
8690 \begin_layout Standard
8691 It is reasonably well tested only for the Journal of Geodesy.
8700 come with the standard LyX distribution.
8701 Install the relevant class file (downloaded from Springer) in a proper
8702 directory, reconfigure LaTeX (in the teTeX case by running
8706 , as root if necessary --- doesn't LyX take care of this?), reconfigure
8707 LyX and it should work.
8710 \begin_layout Subsection
8714 \begin_layout Standard
8715 A large number of theorem-like styles ---
8721 \SpecialChar \ldots{}
8727 \begin_layout Standard
8730 Headnote, Dedication, Subtitle, Running_LaTeX_Title, Author_Running, Institute,
8731 Mail, Offprints, Keywords, Acknowledgements, Acknowledgement
8734 See the Springer class file documentation for details.
8737 \begin_layout Subsection
8741 \begin_layout Itemize
8753 \begin_layout Itemize
8756 Probability Theory and Related Fields
8762 --- Jean-Marc Lasgouttes
8765 \begin_layout Standard
8766 Add your own, it isn't so hard!
8769 \begin_layout Subsection
8773 \begin_layout Standard
8774 These files are partly based on the older
8778 , which was again based on a tinkered-with version of an old LaTeX 2.09 style
8784 layout, are now defunct.
8785 Jean-Marc Lasgouttes helped out big in making me find my way around the
8786 LyX layout file mechanism.
8789 \begin_layout Subsection
8793 \begin_layout Standard
8795 But probably less than in the old hacked-LaTeX
8802 \begin_layout Standard
8803 Limitations e.\InsetSpace \thinspace{}
8804 g.: does not display the number for theorem-like layouts, just
8808 \begin_layout Section
8816 \begin_layout Standard
8822 \begin_layout Subsection
8826 \begin_layout Standard
8827 These are the layout files for some of the journals of the American Geophysical
8829 It is assumed that you have both the AGU's own class files and AGUplus
8830 installed (everything to be found at
8831 \begin_inset LatexCommand url
8832 target "ftp://ftp.agu.org/journals/latex/journals"
8839 \begin_layout Subsection
8843 \begin_layout Standard
8853 They are still called this in the LyX GUI, though their LaTeX equivalents
8854 in the AGU classes are
8865 \begin_layout Standard
8866 Newly defined styles are
8903 These are mostly manuscript attributes and defined in the AGU class documentati
8907 \begin_layout Standard
8908 I suspect this is still badly incomplete.
8911 \begin_layout Subsection
8915 \begin_layout Standard
8932 \begin_layout Subsection
8936 \begin_layout Itemize
8939 Journal of Geophysical Research
8948 \begin_layout Standard
8949 Add your own, it isn't so hard! Look at the
8960 \begin_layout Subsection
8961 Bugs and things to remember
8964 \begin_layout Standard
8965 In order to use the new layouts, you must remember to do the following for
8969 \begin_layout Enumerate
8975 This can be done in the
8977 layout\SpecialChar \menuseparator
8982 document\SpecialChar \menuseparator
8986 (AGU articles are always in English, right? So
8993 \begin_layout Enumerate
9003 (Yes, this is a bug.)
9006 \begin_layout Enumerate
9007 Make sure you use the
9011 bibliography style, by entering
9015 into the second field of the BibTeX inset.
9016 None of the standard styles will do.
9019 \begin_layout Section
9027 \begin_layout Standard
9033 \begin_layout Subsection
9037 \begin_layout Standard
9038 This is the layout file for the European Geophysical Society journals.
9043 can be downloaded from the web site of the EGS under
9044 \begin_inset LatexCommand url
9045 target "www.copernicus.org"
9052 \begin_layout Subsection
9056 \begin_layout Standard
9059 Right_address, Latex_Title, Affil, Journal, msnumber, FirstAuthor, Received,
9067 The current layout file is unfortunately very unmodular and would benefit
9068 from using the various
9075 \begin_layout Section
9081 \begin_inset LatexCommand label
9089 \begin_layout Standard
9097 \begin_layout Subsection
9101 \begin_layout Standard
9102 This section describes how to use LyX to make slides for overhead projectors.
9103 There are two document classes that can do this: the default slides class
9109 This section documents the former.
9112 \begin_layout Standard
9113 I'm going to say this again, nice and clear, so that there's no misunderstanding
9117 \begin_layout Standard
9118 \begin_inset VSpace bigskip
9124 \begin_layout Standard
9128 This section documents the class
9129 \begin_inset Quotes eld
9137 \begin_inset Quotes erd
9145 \begin_layout Standard
9146 \begin_inset VSpace bigskip
9152 \begin_layout Standard
9153 If you're looking for the documentation for
9154 \begin_inset Quotes eld
9162 \begin_inset Quotes erd
9165 , check out section\InsetSpace ~
9167 \begin_inset LatexCommand ref
9168 reference "sec:foiltex"
9178 \begin_inset Quotes eld
9186 \begin_inset Quotes erd
9189 ] is actually somewhat better than the default
9197 \begin_layout Standard
9198 \SpecialChar \ldots{}
9199 or so I've been told repeatedly by its advocates.
9200 Having never used it, I have no idea if this claim is true or not.
9205 which this section documents.
9208 \begin_layout Standard
9209 This class is the LaTeX2e improvement of the old
9214 Every LaTeX2e distribution includes this class [which I'll just refer to
9216 \begin_inset Quotes eld
9224 \begin_inset Quotes erd
9227 from now on], so you're bound to have it.
9228 As I noted earlier, there are other classes, such as
9232 , which also produce slides for overhead projectors and do a better job
9234 However, there are some things which
9238 can do which the others can't, such as generate overlays.
9239 Read on to learn more!
9242 \begin_layout Subsection
9244 \begin_inset LatexCommand label
9245 name "sec:slidesetup"
9252 \begin_layout Standard
9253 Obviously, to use this document class, you need to select
9254 \begin_inset Quotes eld
9262 \begin_inset Quotes erd
9265 from the class list in the
9270 ocument\SpecialChar \menuseparator
9278 There are some other special things you should know about this class:
9281 \begin_layout Itemize
9282 Don't bother changing the options
9287 They're not supported by the
9294 \begin_layout Itemize
9303 behaves a bit differently for this class.
9304 The possible choices and what they do are as follows:
9308 \begin_layout Description
9313 The final output contains page numbers in the lower right corner.
9316 \begin_layout Description
9325 , but also prints out any time markers you've put in.
9326 This is the default.
9329 \begin_layout Description
9334 The final output contains no page numbers, time markers, or alignment markers.
9338 \begin_layout Itemize
9343 class has an extra option:
9349 \begin_inset Quotes eld
9357 \begin_inset Quotes erd
9360 in the extra class options.
9364 \begin_layout Standard
9365 Using this options allows you to add time markers to
9370 See section\InsetSpace ~
9372 \begin_inset LatexCommand ref
9373 reference "sec:slideNote"
9381 \begin_layout Standard
9382 You can also use the template file
9383 \begin_inset Quotes eld
9391 \begin_inset Quotes erd
9394 to automatically set up a document to use the
9403 ile\SpecialChar \menuseparator
9412 to open your new document].
9413 The template file also contains some examples of the special paragraph
9414 environments used by this class.
9415 I'll describe those next.
9418 \begin_layout Subsection
9419 Paragraph Environments
9422 \begin_layout Subsubsection
9423 Supported Environments
9426 \begin_layout Standard
9427 The first thing you'll notice when you start up a new
9431 document is the font size and type: it's the equivalent of the size
9432 \begin_inset Quotes eld
9440 \begin_inset Quotes erd
9449 This is also what's used in the output.
9451 \begin_inset Quotes eld
9455 \begin_inset Quotes erd
9458 to remind you that this is a slide.
9459 Your final slides will use a larger font; ergo, you'll have less space.
9460 Of course, the larger default screen font isn't WYSIWYG, only a reminder.
9463 \begin_layout Standard
9464 The next thing that becomes obvious is the changes to the paragraph environment
9465 pull-down box [at the far-left end of the toolbar].
9466 Most of the paragraph environments you're used to seeing are missing.
9467 There are also five new ones.
9472 class itself only supports certain paragraph environments:
9475 \begin_layout Itemize
9481 \begin_layout Itemize
9487 \begin_layout Itemize
9493 \begin_layout Itemize
9499 \begin_layout Itemize
9505 \begin_layout Itemize
9511 \begin_layout Itemize
9517 \begin_layout Itemize
9523 \begin_layout Itemize
9529 \begin_layout Itemize
9535 \begin_layout Itemize
9541 \begin_layout Standard
9542 All of the other standard environments, including the section-heading environmen
9543 ts, aren't used in the
9550 \begin_layout Standard
9551 On the other hand, you'll notice the following new environments:
9554 \begin_layout Itemize
9560 \begin_layout Itemize
9566 \begin_layout Itemize
9572 \begin_layout Itemize
9578 \begin_layout Itemize
9584 \begin_layout Standard
9585 These five are kind of quirky, due to a
9586 \begin_inset Quotes eld
9590 \begin_inset Quotes erd
9594 You see, LyX doesn't permit you to nest any other paragraph environment
9595 into an empty environment.
9596 Now, that's fine and dandy, but it means that you wouldn't be able to start
9597 a slide with anything except plain text.
9598 To deal with this, I've performed a little
9599 \begin_inset Quotes eld
9603 \begin_inset Quotes erd
9609 \begin_layout Subsubsection
9610 Quirks of the New Environments
9611 \begin_inset LatexCommand label
9612 name "sec:slideQuirk"
9619 \begin_layout Standard
9620 All five of the new paragraph environments are somewhat quirky due to inherent
9621 limitiations in the current version of LyX.
9622 As I just mentioned, LyX forbids environments that begin with another environme
9624 To get around this, the
9628 environment isn't a paragraph environment as described in the
9636 \begin_layout Standard
9650 \begin_inset Quotes eld
9653 pseudo-environments.
9654 \begin_inset Quotes erd
9657 They look like a section heading or a
9658 \begin_inset Quotes eld
9666 \begin_inset Quotes erd
9669 but really begin a [and, if necessary, end the previous] paragraph environment.
9679 \begin_inset Quotes eld
9683 \begin_inset Quotes erd
9686 These two perform some action.
9689 \begin_layout Standard
9690 A common feature of all five environments,
9710 , is a rather long-ish label.
9711 The text following this label --- ordinarily the contents of the paragraph
9712 environment --- is utterly irrelevant for
9733 LyX completely ignores it.
9734 In fact, you can leave these five environments completely empty.
9738 \begin_layout Standard
9743 to put any text after the rather long-ish label, you might want to.
9744 This could be a short description of the contents of the
9749 In that case, enter in your descriptive comment and hit
9753 as you normally would.
9756 \begin_layout Standard
9757 If, on the other hand, you don't want to enter in any descriptive text,
9758 you'll hit another LyX quirk.
9759 LyX, like nature, abhors a vacuum, and will not let you start a new paragraph
9760 environment until you put something in the old one.
9764 \begin_layout Itemize
9765 Start entering the text that will
9793 \begin_layout Itemize
9794 Now move to the beginning of that paragraph.
9798 \begin_layout Itemize
9807 \begin_layout Itemize
9808 Finally, change this new, empty paragraph to a
9832 \begin_layout Standard
9833 Some future version of LyX will, hopefully, resolve this quirkiness\SpecialChar \ldots{}
9837 \begin_layout Subsection
9838 Making a Presentation with
9851 \begin_layout Subsubsection
9859 \begin_layout Standard
9860 If you're expecting this section to teach you how to actually make a presentatio
9861 n, you'll be sorely disappointed.
9862 Naturally, I'll describe all of the ways the
9866 class can assist you in preparing the materials for a presentation.
9867 Filling in the contents, however, is up to you.
9872 the LyX philosophy.]
9875 \begin_layout Standard
9880 environment [in the manner described in section\InsetSpace ~
9882 \begin_inset LatexCommand ref
9883 reference "sec:slideQuirk"
9887 ] tells LyX to begin a new slide [duh].
9888 The label for this environment/
9889 \begin_inset Quotes erd
9893 \begin_inset Quotes erd
9897 \begin_inset Quotes eld
9901 \begin_inset Quotes erd
9904 in cool blue, followed by the label,
9905 \begin_inset Quotes eld
9909 \begin_inset Quotes erd
9913 Any text or paragraph environments that follow this one go on the new slide.
9917 \begin_layout Standard
9918 Slides are probably the only time you'll need to forcibly end pages in LyX
9919 (this can be specified in the
9924 In fact, you'll want to, once you finish entering the contents of one slide.
9925 If you've entered more text than can physically fit on a slide, the extra
9926 overflows onto a new slide.
9927 I don't recommend doing this, however, since the overflow slide won't have
9928 any page number on it.
9929 Furthermore, it may interfere with any
9933 you've made to accompany the oversized
9940 \begin_layout Standard
9949 environments work the same way as the
9955 \begin_inset Quotes eld
9959 \begin_inset Quotes erd
9962 followed by a label [
9963 \begin_inset Quotes eld
9967 \begin_inset Quotes erd
9971 \begin_inset Quotes eld
9975 \begin_inset Quotes erd
9979 The color is a stunning magenta instead of blue, and the
9980 \begin_inset Quotes eld
9984 \begin_inset Quotes erd
9987 will look different, in style and in length.
9988 The label fonts of all three also differ from one another.
9991 \begin_layout Standard
9996 , if the contents of a
10004 exceed the physical size of a slide or sheet of paper, the extra will overflow
10006 Again, you should avoid this.
10007 It defeats the whole purpose of
10018 \begin_layout Subsubsection
10028 \begin_layout Standard
10033 is a slide that sits atop another slide.
10034 Perhaps you wish to discuss a figure on the main
10038 before displaying the text associated with it.
10039 One way to accomplish this is tape a flap of dark paper over the part of
10044 you want to display later.
10045 This method fails, however, if you wish to overlap one graph with another,
10047 You would then have to fumble while speaking to align the two separate,
10052 s to align the two graphs.
10057 environment in both cases makes life much easier.
10060 \begin_layout Standard
10065 receives the page number of its
10066 \begin_inset Quotes eld
10070 \begin_inset Quotes erd
10078 \begin_inset Quotes eld
10086 \begin_inset Quotes erd
10093 \begin_layout Standard
10094 Presumably, mutliple
10099 \begin_inset Quotes eld
10107 \begin_inset Quotes erd
10111 \begin_inset Quotes eld
10119 \begin_inset Quotes erd
10123 \begin_inset Quotes eld
10131 \begin_inset Quotes erd
10134 , etc.\InsetSpace ~
10135 appended to the page number of the parent
10145 Clearly, you want the contents of both the
10153 to each fit on a single physical slide! You should probably consider an
10159 \begin_inset Quotes eld
10163 \begin_inset Quotes erd
10175 class provides a visual cue for this: the label at the start of an
10179 is shorter than that at the start of a
10184 Lastly, when you generate printable output, you'll find alignment markers
10185 in all four corners of both the
10189 page and its parent
10194 These will assist you in lining up the two physical slides.
10197 \begin_layout Standard
10198 The major problem in overlaying two slides is aligning the contents of the
10199 two transparencies.
10200 How much space should you leave for that graph on the second slide? Worse
10201 still, what if you want a graph and a sentence on second slide, but there
10202 is text on the main transparency that goes in between them? You could try
10203 and insert vertical space of the right size.
10204 The better way is to use
10215 \begin_layout Standard
10216 As their names imply,
10224 are two command-like paragraph environments that make all subsequent text
10225 invisible and visible, respectively.
10226 Note from section\InsetSpace ~
10228 \begin_inset LatexCommand ref
10229 reference "sec:slideQuirk"
10233 that you don't place anything
10237 these two environments, however.
10242 , it inserts a centered, sky-blue label into the page reading
10243 \begin_inset Quotes eld
10246 <Invisible Text Follows>
10247 \begin_inset Quotes erd
10251 For paragraphs following this label, the parts of the
10259 ; it doesn't matter which] where they would be contain instead blank space.
10263 \begin_layout Standard
10268 , the corresponding centered label is
10269 \begin_inset Quotes eld
10272 <Visible Text Follows>
10273 \begin_inset Quotes erd
10277 Paragraphs following this label behave normally.
10278 Note that the beginning of a new
10290 automatically shuts off an
10295 It's therefore not necessary to use
10306 \begin_layout Standard
10307 By now, it should be obvious how to create overlay transparencies using
10308 the proper combination of
10327 \begin_layout Enumerate
10332 , including everything that will appear on it, whether on the main slide
10340 \begin_layout Enumerate
10341 Before each figure or paragraph that will appear only on the
10350 If necessary, insert a
10354 environment after the
10361 \begin_layout Enumerate
10366 immediately following the
10373 \begin_layout Enumerate
10374 Copy the contents of this
10385 \begin_layout Enumerate
10390 , change all of the
10401 \begin_layout Standard
10403 You've just made an
10410 \begin_layout Standard
10411 There's one problem with the way I've designed the LyX
10415 class: you can't make text in the middle of a paragraph invisible, nor
10416 make text in the middle of an invisible paragraph visible again.
10417 To accomplish this feat, you'll need to use some inlined LaTeX codes.
10421 \begin_layout Standard
10422 The commands of interest are:
10425 \begin_layout Itemize
10430 invisible \SpecialChar \ldots{}
10434 \begin_layout Itemize
10439 visible \SpecialChar \ldots{}
10443 \begin_layout Standard
10444 \SpecialChar \ldots{}
10445 and need to be marked as TeX.
10447 \begin_inset Quotes eld
10451 \begin_inset Quotes erd
10454 you wish to change goes in between the brackets [and after the
10467 If you don't know how to mark text as TeX, see the appropriate section
10480 \begin_layout Subsubsection
10490 \begin_inset LatexCommand label
10491 name "sec:slideNote"
10498 \begin_layout Standard
10507 is associated with a
10508 \begin_inset Quotes eld
10512 \begin_inset Quotes erd
10524 class provides visual cues.
10529 is shorter than that of a
10533 [yet longer than that of an
10537 ] and, like the label of an
10541 is shockingly magenta.
10542 Additionally, the printed
10546 has the page number of its
10547 \begin_inset Quotes eld
10551 \begin_inset Quotes erd
10559 \begin_inset Quotes eld
10567 \begin_inset Quotes erd
10571 \begin_inset Quotes eld
10579 \begin_inset Quotes erd
10583 \begin_inset Quotes eld
10591 \begin_inset Quotes erd
10595 You can have multiple
10599 s associated with a single
10611 , you'll probably want to break up long
10615 s so that they fit on a single sheet of paper.
10618 \begin_layout Standard
10623 is obvious: it contains anything additional you might want to say about
10629 It could also be used as a sheet of reminders for a particular
10634 In the case of the latter, you might want to make use of time markers.
10640 \begin_inset Quotes eld
10644 \begin_inset Quotes erd
10647 support for time markers, a
10652 So, you'll have to resort to using the LaTeX codes.
10655 \begin_layout Standard
10656 To use time markers, you'll need to specify the extra class option
10657 \begin_inset Quotes eld
10665 \begin_inset Quotes erd
10668 [see section\InsetSpace ~
10670 \begin_inset LatexCommand ref
10671 reference "sec:slidesetup"
10676 This option turns on timing marks, which will appear in the lower-left-hand
10682 To set what appears in the time marker, you use the LaTeX commands
10683 \begin_inset Quotes eld
10693 \begin_inset Quotes erd
10697 \begin_inset Quotes eld
10707 \begin_inset Quotes erd
10711 The arguments of both commands are time measured in seconds.
10713 \begin_inset Quotes eld
10723 \begin_inset Quotes erd
10726 sets the time marker to a given time.
10728 \begin_inset Quotes eld
10738 \begin_inset Quotes erd
10741 increments the time marker by the specified amount.
10742 Using time markers and
10746 s in this fashion, you can remind yourself how much time to spend on a particula
10754 \begin_layout Standard
10755 There's one last feature to describe.
10756 Clearly, you'd like to print out all of your
10764 s on transparencies while printing all of your
10781 with which it is associated.
10782 What's a person to do?
10785 \begin_layout Standard
10786 Luckily, there are two LaTeX commands that allow you to select what to print
10788 Both must be placed into the preamble of your document.
10790 \begin_inset Quotes eld
10802 \begin_inset Quotes erd
10805 will cause the output to contain only the
10814 Correspondingly, the command
10815 \begin_inset Quotes eld
10827 \begin_inset Quotes erd
10830 prevents the output of anything but
10835 I'd advise placing both commands in the preamble and initially comment
10837 You can then preview your entire presentation as you write.
10838 When you're done writing, you can then uncomment one of the two to select
10839 what you want to print.
10840 I like to uncomment
10841 \begin_inset Quotes eld
10853 \begin_inset Quotes erd
10856 , print to a file with
10857 \begin_inset Quotes eld
10865 \begin_inset Quotes erd
10868 in its name, comment it back out, then uncomment
10869 \begin_inset Quotes eld
10881 \begin_inset Quotes erd
10885 \begin_inset Quotes eld
10893 \begin_inset Quotes erd
10897 I can then send either file to a printer, loading transparencies or plain
10898 paper as appropriate.
10901 \begin_layout Standard
10902 You can also provide other arguments to the
10903 \begin_inset Quotes eld
10913 \begin_inset Quotes erd
10917 \begin_inset Quotes eld
10927 \begin_inset Quotes erd
10931 See a good LaTeX book for details.
10934 \begin_layout Subsection
10939 Class Template File
10942 \begin_layout Standard
10943 I have also provided a template file,
10944 \begin_inset Quotes eld
10952 \begin_inset Quotes erd
10960 To use it, begin your new presentation with
10965 ile\SpecialChar \menuseparator
10975 Your new LyX presentation file will contain an example
10996 additionally contain an example of the use of
11005 Lastly, the preamble will contain:
11008 \begin_layout LyX-Code
11009 % Uncomment to print out only slides and overlays
11012 \begin_layout LyX-Code
11016 \begin_layout LyX-Code
11026 \begin_layout LyX-Code
11027 % Uncomment to print out only notes
11030 \begin_layout LyX-Code
11034 \begin_layout LyX-Code
11042 \begin_layout Standard
11043 One final thing: I created this class to support the LaTeX2e
11044 \begin_inset Quotes eld
11052 \begin_inset Quotes erd
11055 class, one of the built-in LaTeX2e classes.
11056 Neither I nor the rest of the LyX Team endorse or oppose the use of this
11057 built-in slide class.
11058 It's here if you want it or need it.
11059 There exist other LaTeX2e classes for creating presentations, such as the
11064 class [see section\InsetSpace ~
11066 \begin_inset LatexCommand ref
11067 reference "sec:foiltex"
11072 \begin_inset Quotes eld
11080 \begin_inset Quotes erd
11083 package [present on some TeX distributions].
11084 The latter is not yet supported under LyX.
11088 \begin_layout Standard
11089 Perhaps you can take on the task\SpecialChar \ldots{}
11095 I know nothing about these other classes.
11096 Try them out to see what sort of alternative they provide.
11099 \begin_layout Section
11108 \begin_inset LatexCommand label
11116 \begin_layout Standard
11122 \begin_layout Subsection
11126 \begin_layout Standard
11127 This section describes how to use LyX to make slides for overhead projectors.
11128 There are two document classes that can do this: the default slides class
11134 This section documents the latter.
11137 \begin_layout Standard
11138 I'm going to say this again, nice and clear, so that there's no misunderstanding
11142 \begin_layout Standard
11143 \begin_inset VSpace bigskip
11149 \begin_layout Standard
11153 This section documents the class
11154 \begin_inset Quotes eld
11162 \begin_inset Quotes erd
11170 \begin_layout Standard
11171 \begin_inset VSpace bigskip
11177 \begin_layout Standard
11178 If you're looking for the documentation for
11179 \begin_inset Quotes eld
11187 \begin_inset Quotes erd
11190 , check out section\InsetSpace ~
11192 \begin_inset LatexCommand ref
11193 reference "sec:slitex"
11198 If your machine doesn't have the
11203 \begin_inset Quotes eld
11211 \begin_inset Quotes erd
11214 ] installed, you'll probably have to use the default
11218 class, which isn't quite as good as
11223 \begin_layout Standard
11228 class is designed for use with version 2.1 of the
11232 LaTeX class file which is now an integral part of LaTeX2e.
11235 \begin_layout Subsection
11239 \begin_layout Standard
11240 Obviously, to use this document class, you need to select
11241 \begin_inset Quotes eld
11249 \begin_inset Quotes erd
11261 Document\InsetSpace ~
11265 There are some settings in the
11267 Document\InsetSpace ~
11270 dialog that you should know about that are specific to this class:
11273 \begin_layout Itemize
11274 Don't change the options
11284 Document\InsetSpace ~
11288 They're ignored by the
11295 \begin_layout Itemize
11296 The default font size is 20pt with the other options being 17pt, 25pt and
11300 \begin_layout Itemize
11301 The default font is
11309 but all math equations are still typeset in the usual roman font.
11312 \begin_layout Itemize
11317 TeX supports A4 and Letter paper sizes as well as a special size for working
11319 It doesn't support A5, B5, legal or executive paper sizes.
11322 \begin_layout Itemize
11323 Don't bother changing the
11327 settings because they are ignored anyway.
11328 All floats appear where they are defined in the text.
11331 \begin_layout Itemize
11339 setting behaves a bit differently for this class.
11344 TeX provides extensive footer and header capabilities including a user-defined
11346 See section\InsetSpace ~
11348 \begin_inset LatexCommand ref
11349 reference "sec:foilfoot"
11354 The title page is treated differently to all other pages in the document
11363 has the logo centered at the bottom of the page (if one is defined).
11364 The possible page style choices and what they do are as follows:
11369 \labelwidthstring MMMMMMM
11376 The final output contains no page numbers, or other headers or footers
11377 (except footnotes of course).
11382 \labelwidthstring MMMMMMM
11389 The final output contains page numbers centered at the bottom of the page.
11390 No other headings or footers (other than footnotes).
11394 \labelwidthstring MMMMMMM
11399 Page numbers in lower right corner.
11400 Additional headers and footers are also shown.
11401 This is also the default.
11405 \labelwidthstring MMMMMMM
11410 Gives you access to the
11414 package although its use with
11418 TeX is discouraged by the writer of the
11422 TeX package because of some potential page layout clashes.
11426 \begin_layout Subsubsection
11430 \begin_layout Standard
11431 The following options may be used in the extra class options in the
11436 ocument\SpecialChar \menuseparator
11447 \labelwidthstring MMMMMMx
11452 This sets up the page layout for 7.33in by 11in paper, which is about the
11453 same aspect ratio as a 35mm slide, making it a bit easier to work with
11458 \labelwidthstring MMMMMMx
11463 Places a rule across the page below the header on every page except the
11468 \labelwidthstring MMMMMMx
11473 Places a rule across the page above the footer on every page except the
11478 \labelwidthstring MMMMMMx
11483 This is automatically set each time you create a new
11492 TeX to use the dvips driver to rotate those pages that are set as landscape
11497 \labelwidthstring MMMMMMx
11502 Simply changes the page dimensions to those of a landscape page but doesn't
11504 Thus if you use this option you need to use an external program to rotate
11505 each page or feed your paper through your printer as landscape.
11506 Note that this option effectively reverses the roles of the
11514 environments (don't worry these are described in the next section).
11518 \labelwidthstring MMMMMMx
11523 Equation numbers on the left.
11527 \labelwidthstring MMMMMMx
11532 Flush-left equations.
11535 \begin_layout Subsection
11536 Supported Environments
11539 \begin_layout Standard
11540 Most of the environments commonly supported in other classes are also supported
11546 There are several additional environments provided by
11550 TeX as well as a couple added by LyX.
11551 The following environments are shared with other classes:
11554 \begin_layout Standard
11558 \begin_layout Standard
11562 begin{multicols}{2}
11570 \begin_layout Itemize
11576 \begin_layout Itemize
11582 \begin_layout Itemize
11588 \begin_layout Itemize
11594 \begin_layout Itemize
11600 \begin_layout Itemize
11606 \begin_layout Itemize
11612 \begin_layout Itemize
11618 \begin_layout Itemize
11624 \begin_layout Itemize
11630 \begin_layout Itemize
11636 \begin_layout Itemize
11642 \begin_layout Itemize
11648 \begin_layout Itemize
11654 \begin_layout Itemize
11660 \begin_layout Itemize
11666 \begin_layout Itemize
11672 \begin_layout Itemize
11678 \begin_layout Standard
11682 \begin_layout Standard
11694 \begin_layout Standard
11695 That is, all the major environments apart from the sectioning environments.
11696 Since foils are essentially self-contained sections, with a title and body,
11701 TeX provides specific commands for starting new foils and these are:
11704 \begin_layout Itemize
11710 \begin_layout Itemize
11716 \begin_layout Standard
11717 LyX also provides slightly modified versions of these two environments called:
11720 \begin_layout Itemize
11726 \begin_layout Itemize
11729 ShortRotatefoilhead
11732 \begin_layout Standard
11733 and the differences will be explained in the next section.
11736 \begin_layout Standard
11737 Since foils are often used in presenting ideas or new theorems and such
11742 TeX also provides a comprehensive box of goodies for presenting them:
11745 \begin_layout Standard
11749 \begin_layout Standard
11753 begin{multicols}{2}
11761 \begin_layout Itemize
11767 \begin_layout Itemize
11773 \begin_layout Itemize
11779 \begin_layout Itemize
11785 \begin_layout Itemize
11791 \begin_layout Itemize
11797 \begin_layout Itemize
11803 \begin_layout Itemize
11809 \begin_layout Itemize
11815 \begin_layout Itemize
11821 \begin_layout Itemize
11827 \begin_layout Standard
11831 \begin_layout Standard
11843 \begin_layout Standard
11844 The starred versions are unnumbered while the unstarred versions are numbered.
11845 There are also two list environments added by LyX and these are:
11848 \begin_layout Itemize
11854 \begin_layout Itemize
11860 \begin_layout Standard
11865 TeX provides some powerful header and footer capabilities that are best
11866 set in the preamble although they may be set at any point in a document.
11867 If you want to change these settings in your document the best place to
11868 do so is at the very top of a foil,
11873 straight after the foilhead.
11876 \begin_layout Standard
11877 For this purpose, the following command styles are provided [
11884 \begin_layout Standard
11888 \begin_layout Standard
11892 begin{multicols}{2}
11900 \begin_layout Itemize
11907 \begin_layout Itemize
11913 \begin_layout Itemize
11920 \begin_layout Itemize
11927 \begin_layout Itemize
11935 \begin_layout Standard
11941 \begin_layout Standard
11945 \begin_layout Standard
11957 \begin_layout Standard
11958 There are also a few commands provided by
11962 TeX that aren't directly supported by LyX but I'll tell you what they do
11963 and how to use them in section\InsetSpace ~
11965 \begin_inset LatexCommand ref
11966 reference "sec:unsuppfoils"
11973 \begin_layout Subsection
11974 Building a Set of Foils
11977 \begin_layout Standard
11978 This section will give a simple introduction to using the different environments
11979 to build a set of foils.
11980 If you want to see an example set of foils take a look at the
11984 file accessible from the
11989 ile\SpecialChar \menuseparator
11994 pen\SpecialChar \ldots{}
12005 \begin_layout Subsubsection
12006 Give It a Title Page
12009 \begin_layout Standard
12010 Unlike other classes that provide
12030 creates the title on a page of its own.
12031 If you leave out the
12035 environment LaTeX will substitute the current date (every time you regenerate
12039 \begin_layout Subsubsection
12043 \begin_layout Standard
12044 As I mentioned earlier, there are four ways of starting a new foil.
12045 For portrait foils you should use
12054 The difference between these two environments is the amount of space between
12055 the title of the foil (the foilhead) and the body of the foil.
12058 \begin_layout Standard
12059 Landscape foils are generated using the
12065 ShortRotatefoilhead
12068 Again the only difference is the spacing between foilhead and body.
12069 Both of the short versions have 0.5 inches less separation between the foilhead
12074 \begin_layout Standard
12075 One problem with the support for landscape foils is the requirement that
12076 you have to use the
12080 driver to generate the PostScript output otherwise the foils won't be rotated.
12081 It is possible to get landscape foils even if you haven't got the
12085 driver provided you can feed your foils sideways through your printer ;-)
12088 \begin_layout Subsubsection
12089 Theorems, Lemmas, Proofs and more
12092 \begin_layout Standard
12093 Due to a small bug in LyX you can't have two of the same type of these environme
12094 nts directly following each other.
12095 They must be separated by something.
12096 If you try, you will just be extending the previous environment as if you
12097 had merged the two environments together.
12098 So, how do you get around this problem? The simplest option is to insert
12099 some text between the two environments or add a
12103 environment between the two with just a
12104 \begin_inset Quotes eld
12112 \begin_inset Quotes erd
12116 This will force LyX to produce two separate environments and hence the
12117 correct LaTeX output.
12118 An example is provided in the example file included with the LyX distribution.
12119 Remember, this problem only occurs if you are trying to place two of the
12120 same type of theorem-like environments one directly after the other.
12123 \begin_layout Subsubsection
12127 \begin_layout Standard
12128 You get all the commonly supported list styles found in other classes as
12129 well as two new ones.
12130 I'll only describe the new ones here.
12131 If you want to find out more about the other list environments check out
12137 If you intend to use itemized lists you might also want to read about the
12140 Itemize\InsetSpace ~
12141 Bullet\InsetSpace ~
12144 dialog described above in section\InsetSpace ~
12146 \begin_inset LatexCommand ref
12147 reference "sec:bullet"
12154 \begin_layout Standard
12155 The two new list styles,
12163 , are designed to make it easier for you to create lists of do's and don'ts
12164 or right and wrong by providing dedicated environments that use a tick
12165 or a cross as the label of the list.
12166 These lists are in fact dedicated variants of the
12171 They do however require that you have the
12175 packages installed.
12178 \begin_layout Subsubsection
12182 \begin_layout Standard
12187 TeX redefines the floating tables and figures so that they appear exactly
12188 where they are in the text rather than pushing them to the top of the page
12189 or to some user specified location.
12190 In fact if you change the float placement settings they are simply ignored.
12193 \begin_layout Subsubsection
12194 Page Headers and Footers
12195 \begin_inset LatexCommand label
12196 name "sec:foilfoot"
12203 \begin_layout Standard
12213 are two commands used to control the left-footer text string.
12214 The first is meant to allow you to include a graphic logo on your foils
12216 \begin_inset Quotes eld
12224 \begin_inset Quotes erd
12228 While the second is meant to provide a classification for the audience,
12231 e.\InsetSpace \thinspace{}
12236 It is empty by default.
12239 \begin_layout Standard
12240 The remaining page corners can be filled by
12245 (which defaults to page numbers),
12258 \begin_layout Subsection
12264 \begin_inset LatexCommand label
12265 name "sec:unsuppfoils"
12272 \begin_layout Standard
12273 All the commands mentioned below need to be set in a
12281 within another environment.
12284 \begin_layout Subsubsection
12288 \begin_layout Standard
12289 All lengths are adjusted using the
12312 should be replaced by the name given to the length you want to change and
12317 is the length value.
12318 All lengths should be specified in units of length such as inches (
12330 ) or relative to some document or font-based length such as
12340 \begin_layout Standard
12341 It's possible to change the spacing between a foilhead and the body of the
12342 foil by adjusting the length specified by
12349 For example, to make
12353 foilheads 0.5 inches closer to their bodies put the following in the preamble:
12360 foilheadskip}{-0.5in}
12363 \begin_layout Standard
12364 The spacings around floats can be adjusted by setting these lengths:
12368 \labelwidthstring MMMMMMMMMMM
12375 Separation between the text and the top of the float
12379 \labelwidthstring MMMMMMMMMMM
12386 Separation between the float and the caption
12390 \labelwidthstring MMMMMMMMMMM
12397 Separation between the caption and the following text
12401 \labelwidthstring MMMMMMMMMMM
12408 You can make the captions narrower than the surrounding text by adjusting
12410 Best done relative to
12419 \begin_layout Standard
12420 There are also several title page related lengths that you may find useful
12421 if you have a long title or several authors:
12425 \labelwidthstring MMMMMMMMMMM
12432 Separation from headers to
12438 \labelwidthstring MMMMMMMMMMM
12457 \labelwidthstring MMMMMMMMMMM
12472 \labelwidthstring MMMMMMMMMMM
12489 \labelwidthstring MMMMMMMMMMM
12505 \begin_layout Standard
12506 The last length related command affects all the list environments.
12517 a list environment then all the vertical spacing between the list items
12519 Note that this is a command not a length so it doesn't require
12525 like the stuff mentioned above.
12528 \begin_layout Subsubsection
12529 Headers and Footers
12532 \begin_layout Standard
12545 commands control whether the logo in the
12549 definition appear on a given page.
12556 in the preamble then none of the foils will have the logo on them.
12557 If you don't want the logo on a particular page place the
12563 directly after the foilhead of that page and the
12569 directly after the next foilhead.
12572 \begin_layout Standard
12573 If you decide to use the
12577 page style setting in the
12579 Document\InsetSpace ~
12582 dialog you should probably add
12592 to your preamble so headers and footers on landscape pages are correctly
12593 placed when rotated.
12594 This is due to some clashes between the page layouts provided by the
12605 \begin_layout Section
12606 Latex8 (IEEE Conference Papers)
12609 \begin_layout Standard
12615 \begin_layout Subsection
12619 \begin_layout Standard
12620 Since this class is specifically for writing submissions to IEEE sponsored
12621 conferences I strongly recommend that you get a copy of their Authors Kit.
12626 package and associated bibliography style file is included in the kit.
12627 The Authors Kit is usually sent out by email once your initial submission
12629 There is a lot of useful information in the Authors Kit explaining formatting
12630 restrictions and so on and I will assume you have read this since that
12631 means I don't have to repeat it all here.
12634 \begin_layout Subsection
12638 \begin_layout Standard
12639 [AR\SpecialChar \@.
12643 \begin_layout Subsection
12644 Supported Environments
12647 \begin_layout Itemize
12653 \begin_layout Itemize
12659 \begin_layout Itemize
12665 \begin_layout Itemize
12671 \begin_layout Itemize
12677 \begin_layout Itemize
12683 \begin_layout Itemize
12689 \begin_layout Itemize
12695 \begin_layout Itemize
12701 \begin_layout Subsection
12702 Differences Between Screen and Paper
12705 \begin_layout Standard
12706 There are slight differences in appearance mainly with the presentation
12707 of section counters.
12708 On screen the trailing period of the section counter is missing but it
12709 will appear in the output so don't let this worry you.
12712 \begin_layout Section
12713 Hollywood (Hollywood spec scripts)
12716 \begin_layout Standard
12722 \begin_layout Subsection
12726 \begin_layout Standard
12727 Getting the format of a Hollywood script right is a
12728 \begin_inset Quotes eld
12732 \begin_inset Quotes erd
12735 It is designed to make the readers focus on content and to be easy and
12736 familiar for the actors to read.
12737 Each page of a script should be one minute of film.
12738 Nothing goes in a script that you cannot see or hear on screen.
12739 The courier 12 pt font should be used throughout.
12743 \begin_layout Subsection
12747 \begin_layout Standard
12748 Speakers' lines should NEVER break in mid-sentence.
12749 If a speaker's lines continue over a page break, repeat the
12753 title followed by (Cont'd).
12756 \begin_layout Subsection
12760 \begin_layout Standard
12765 names as labels then cross-reference the label to insert the name.
12766 The cross-reference dialog will show the current cast of characters.
12767 You can use this to insert the speaker name in narratives also.
12770 \begin_layout Subsection
12771 Paper size and Margins
12774 \begin_layout Standard
12775 USLetter, left 1.6in, right 0.75in, top 0.5in, bottom 0.75in
12778 \begin_layout Subsection
12782 \begin_layout Standard
12783 The following environments are available.
12784 You can use hollywood.bind to get the bind keys shown at the right.
12787 \begin_layout Itemize
12794 Used where nothing else works.
12798 \begin_layout Itemize
12811 Usually followed by something like
12812 \begin_inset Quotes eld
12815 on Sally waking up.
12816 \begin_inset Quotes erd
12822 \begin_layout Itemize
12831 Introduces a new INTERIOR camera set-up.
12832 Always followed by DAY or NIGHT, or something similar to define the lighting
12834 Everthing on this line in CAPS.
12837 \begin_layout Itemize
12846 Introduces a new EXTERIOR camera set-up.
12847 Everthing on this line in CAPS.
12850 \begin_layout Itemize
12859 The character speaking.
12862 \begin_layout Itemize
12871 Instructions to the speaker.
12872 The () are automatically inserted, but only the ( will show in LyX.
12873 Both will be printed.
12876 \begin_layout Itemize
12892 \begin_layout Itemize
12901 Camera movement instruction.
12902 e.\InsetSpace \thinspace{}
12907 \begin_layout Itemize
12915 \begin_layout Itemize
12923 \begin_layout Itemize
12931 \begin_layout Itemize
12939 \begin_layout Subsection
12943 \begin_layout Itemize
12944 (O.S) --- off screen
12947 \begin_layout Itemize
12948 (V.0) --- voice over
12951 \begin_layout Itemize
12956 \begin_layout Itemize
12961 \begin_layout Itemize
12962 PAN --- camera movement
12965 \begin_layout Itemize
12966 INSERT --- cut to close-up of
12969 \begin_layout Section
12973 \begin_layout Standard
12979 \begin_layout Subsection
12983 \begin_layout Standard
12984 Broadway is for writing plays.
12985 The format is more decorative than Hollywood, and much less standardized.
12986 This format should be suitable for workshops.
12989 \begin_layout Subsection
12993 \begin_layout Standard
12994 The same as in Hollywood.
12997 \begin_layout Subsection
13001 \begin_layout Standard
13006 names as labels then cross-reference the label to insert the name.
13007 The cross-reference dialog will show the current cast of characters.
13010 \begin_layout Subsection
13011 Paper size and Margins
13014 \begin_layout Standard
13015 USLetter, left 1.6in, right 0.75in, top 0.5in, bottom 0.75in
13018 \begin_layout Subsection
13022 \begin_layout Standard
13023 The following environments are available.
13024 You can use broadway.bind to get the bind keys shown at the right.
13027 \begin_layout Itemize
13034 You should not have to use this, but it is here for anything that does not
13038 \begin_layout Itemize
13047 Used to describe stage setting and the action.
13048 First use of speaker names in all CAPs.
13051 \begin_layout Itemize
13060 Automatically numbered.
13061 On screen it will be arabic, but will print as Roman.
13064 \begin_layout Itemize
13078 It is just centered text.
13081 \begin_layout Itemize
13090 Not automatically numbered.
13091 You supply the number.
13092 This is because I couldn't figure out how.
13095 \begin_layout Itemize
13104 A special case of Narrative to describe the setting and action as the curtain
13108 \begin_layout Itemize
13117 The speaker's (actor's) title, centered in all CAPS.
13120 \begin_layout Itemize
13129 Instructions to the speaker.
13130 The parentheses are automatically inserted.
13131 The ( will appear on screen, but both will be in the printed play.
13132 This environment is only used within
13139 \begin_layout Itemize
13148 What the Speaker says.
13151 \begin_layout Itemize
13160 The curtain comes down.
13163 \begin_layout Itemize
13171 \begin_layout Itemize
13179 \begin_layout Itemize
13187 \begin_layout Standard
13191 \begin_layout Section
13195 \begin_layout Standard
13201 \begin_layout Standard
13202 \begin_inset VSpace bigskip
13208 \begin_layout Standard
13212 Revtex\InsetSpace ~
13215 textclass works with the American Physical Sociey's RevTeX 4.0 (the
13216 \begin_inset Formula $\beta$
13219 release of May, 1999) class.
13222 \begin_layout Standard
13227 textclass, which works with RevTeX 3.1.
13228 However, v3.1 is basically obsolete, as it works with LaTeX 2.09.
13229 That means that it doesn't interact very well with LyX, which requires
13230 LaTeX2e, although it has been kludged to work.
13231 Since RevTeX 4.0 has been designed to work much more cleanly with LaTeX2e,
13234 RevTeX\InsetSpace ~
13237 textclass should also be pretty easy to use.
13240 \begin_layout Standard
13241 These documents are supposed to be used in
13245 to the RevTeX 4.0 documents, so we don't describe any of the special RevTeX
13246 macros, and assume you'll know what to put in the preamble if necessary.
13249 \begin_layout Subsection
13253 \begin_layout Standard
13254 All you need to do is install RevTeX 4, as described in the package's README
13256 The package can be found at
13257 \begin_inset LatexCommand url
13258 name "The RevTeX 4 Web Site"
13259 target "http://publish.aps.org/revtex4/"
13264 Install it somewhere that LaTeX can see it.
13265 Test it by trying to LaTeX a short RevTeX 4 document in some random directory
13266 (i.e., not the directory where you installed the class file.) Then, if you
13267 reconfigure LyX, it will find the class file and let you use the RevTeX4
13271 \begin_layout Standard
13272 Probably the easiest way to get started is either to import a RevTeX 4 document
13279 Revtex\InsetSpace ~
13282 template, found in the templates directory.
13285 \begin_layout Subsection
13289 \begin_layout Standard
13290 Optional arguments to
13297 \begin_inset Quotes eld
13301 \begin_inset Quotes erd
13305 \begin_inset Quotes eld
13309 \begin_inset Quotes erd
13323 Document\InsetSpace ~
13327 Remember that in RevTeX, at least one optional argument is required!
13330 \begin_layout Standard
13331 Other preamble matter, like
13347 dialog, also as usual.
13350 \begin_layout Subsection
13354 \begin_layout Standard
13355 The layouts basically correspond to the commands in RevTeX4.0.
13356 For example, the Email layout corresponds to
13363 Note that (at least as of RevTeX 4.0 Beta), the
13371 layouts are exactly equivalent, so you shouldn't need to use both.
13375 \begin_layout Standard
13376 In case you're curious, both were included so that
13380 would be able to translate both
13400 \begin_layout Subsection
13404 \begin_layout Standard
13405 There are a couple of important unique aspects of RevTeX 4 which might cause
13406 bugs that will be even more confusing in LyX.
13409 \begin_layout Standard
13427 The LyX equivalent is that there is a separate Thanks layout.
13432 write footnotes in the
13436 layout, or weird things may happen.
13437 See the RevTeX 4 documentation for more details.
13440 \begin_layout Standard
13443 Author\InsetSpace ~
13448 Author\InsetSpace ~
13455 layouts must be placed
13463 layout and the corresponding
13480 , the LaTeX won't compile.
13483 \begin_layout Subsection
13487 \begin_layout Standard
13488 The main problem with this layout is that you can't use the optional arguments
13489 to layouts like Email and Title.
13490 (The problem is not unique to this layout; you can't use optional arguments
13491 to the Section layouts either.) This means that after you export that file
13492 to LaTeX (which you'll need to do eventually to send it in to APS), you'll
13493 need to edit the LaTeX file with a text editor to add the optional arguments
13494 to set, e.\InsetSpace \thinspace{}
13495 g., the running title for the page headers.
13496 Lacking these layouts makes the
13502 (and the equivalent
13508 ) useless, so the corresponding layouts don't exist, and will have to be
13513 \begin_layout Standard
13518 actually, LyX 1.3.0 supports some forms of optional arguments, but this layout
13519 has not been updated yet to take advantage of it.
13527 \begin_layout Section
13528 Article (mwart), book (mwbk) and report (mwrep)
13529 \begin_inset OptArg
13532 \begin_layout Standard
13545 \begin_layout Standard
13551 \begin_layout Standard
13552 The LyX document classes
13568 correspond to the LaTeX document classes
13581 They are replacements for the standard document classes
13593 , resp., and fit better to Polish typography conventions in a number of points.
13597 \begin_layout Standard
13601 \begin_layout Itemize
13602 Unnumbered titles (with star, eg.
13607 ) are added into table of contents,
13610 \begin_layout Itemize
13611 Additional page styles:
13615 \begin_layout Description
13616 uheadings header with separated lines,
13619 \begin_layout Description
13620 myheadings custom header, contents headers via commands:
13635 \begin_layout Description
13636 myuheadings custom header with separated lines,
13639 \begin_layout Description
13640 outer page number is placed on outer side of page
13644 \begin_layout Itemize
13649 \begin_layout Description
13650 rmheadings serif titles --- default,
13653 \begin_layout Description
13654 sfheadings sansserif titles,
13657 \begin_layout Description
13658 authortitle on title page first placed is author next title --- default,
13661 \begin_layout Description
13662 titleauthor on title page first placed is title next author,
13665 \begin_layout Description
13666 withmarginpar reserve place on page for margins.
13670 \begin_layout Section
13674 \begin_layout Standard
13680 \begin_layout Standard
13681 Elsevier Science Publishers B.V.
13682 provides a standard LaTeX document class (
13686 ) for submitting articles to their various journals.
13687 The style file can be downloaded directly from their web site:
13688 \begin_inset LatexCommand url
13689 target "http://authors.elsevier.com/"
13694 Instructions are supplied along with the class file, which details the
13695 requirements of the publishers.
13696 LyX includes package that allows for the use of this class, by a layout
13697 and a template file.
13698 Installation of the class file is the same as for any other LaTeX package;
13699 instructions are provided in the Elsevier documentation.
13702 \begin_layout Standard
13712 As the Elsevier class file is based mainly on the standard article class,
13713 most of the normal functionality is provided.
13714 The Elsevier class defines a number of mathematical environments, which
13715 are similar to the AMS environments.
13716 These commands are all described in the Elsevier documentation, and are
13720 \begin_layout Standard
13721 The easiest way to use the Elsevier style is to base documents on the included
13723 It is best not to use options such as fancy headings or the geometry package,
13724 as elements such as these are defined by Elsevier in their style file.
13725 Ideally, no extra packages except those mentioned in the Elsevier documentation
13727 Essentially, Elsevier require as
13728 \begin_inset Quotes eld
13732 \begin_inset Quotes erd
13739 \begin_layout Standard
13748 file as possible, as their intention is to take the supplied file and replace
13749 the class file with one for the particular journal to which the paper has
13751 This also means that not too much time should be spent on the formating
13753 When it comes to be published, this will change anyway.
13754 The rest of the usage for this layout is substantially the same as for
13755 the normal article class.
13756 For details of what Elsevier do and don't allow, refer to their documentation.
13759 \begin_layout Section
13763 \begin_layout Standard
13766 Jürgen Spitzmüller
13769 \begin_layout Subsection
13773 \begin_layout Standard
13774 Memoir is a very powerful and constantly evolving class.
13775 It has been designed with regard to fictional and non-fictional literature.
13776 Its aim is to let the user have maximum control over the typesetting of
13778 Memoir is based on the standard book class, but it can also emulate the
13779 article class (see below).
13782 \begin_layout Standard
13783 Peter Wilson, the developer of Memoir, is known as the author of lots of
13784 useful packages in the LaTeX world.
13785 Most of them have been merged with Memoir.
13786 Therefore, it is much easier to layout the table of contents, appendices,
13787 chapter designs and such.
13788 LyX, though, does not support all of these goodies natively.
13789 Some of them might be added to forthcoming releases
13793 \begin_layout Standard
13794 You are invited to send suggestions to
13795 \begin_inset LatexCommand url
13796 target "lyx-devel@lists.lyx.org"
13805 , lots will probably never, due to the limitations of LyX's framework.
13806 Of course you can still use all features with the help of some native LaTeX
13811 \begin_layout Standard
13816 \begin_layout Standard
13825 section\InsetSpace ~
13827 \begin_inset LatexCommand ref
13828 reference "sec:Inserting-LaTeX-Code"
13838 In this section, we can only list those features which are natively supported
13840 For detailed descriptions (and for the rest of features) we are recommending
13841 to have a look at the detailed manual of the Memoir class
13845 \begin_layout Standard
13850 \begin_layout Standard
13860 \begin_inset LatexCommand url
13861 target "CTAN:/macros/latex/memoir/memman.pdf"
13870 , which is not only a user guide for the class, but also both a comprehensive
13871 description on good typesetting and a superb example for good typesetting
13875 \begin_layout Subsection
13876 Basic features and restrictions
13879 \begin_layout Standard
13880 Memoir supports basically all features of the standard book classes.
13881 There are, however, some differences, as follows:
13884 \begin_layout Description
13886 sizes: Memoir has a broader range of font sizes: 9, 10, 11, 12, 14,
13890 \begin_layout Description
13892 style: The fancy page style is not supported, due to a command clash
13893 between Memoir and the fancyhdr package (they are both defining a command
13894 with the same name, which confuses LaTeX).
13895 Instead, Memoir comes with a bunch of own page styles (see
13897 Layout\SpecialChar \menuseparator
13898 Document\SpecialChar \menuseparator
13903 If you want to use these for the chapter pages, you have to use the command
13910 in the main text or in preamble (e.
13914 \begin_layout Standard
13927 \begin_layout Standard
13940 chapterstyle{companion}
13945 \begin_layout Description
13946 Sectioning: Sectionings (chapter, section, subsection etc.) are coming with
13947 an optional argument in the standard classes.
13948 With this, you can specify an alternative version of the title for the
13949 table of contents and the headers (for instance, if the title is too long).
13950 In LyX, you can do this via
13952 Insert\SpecialChar \menuseparator
13956 at the beginning of a chapter/section.
13957 Memoir features a second optional argument and thus separates the table
13958 of contents from the header.
13959 You can define three variants of a title with this: one for the main text,
13960 one for the table of contents, and one for the headers.
13961 Simply insert two optional arguments if you need this feature, the first
13962 one containing the short title for the Table of Contents, the second one
13963 containing an alternative short title for the headers.
13966 \begin_layout Description
13967 TOC/LOT/LOF: In the standard classes (and in many other classes), the table
13968 of contents, the list of figures and the list of table start a new page
13970 Memoir does not follow this route.
13971 You have to insert a page break yourself, if you want to have one.
13974 \begin_layout Description
13975 Titlepage: For some unknown reason, Memoir uses pagination on the title
13976 page (in the standard classes, title pages are
13977 \begin_inset Quotes eld
13981 \begin_inset Quotes erd
13988 \begin_layout Standard
14001 \begin_layout Standard
14011 If you want an empty title page, type
14015 aliaspagestyle{title}{empty}
14020 \begin_layout Description
14021 Article: With the class option
14027 Layout\SpecialChar \menuseparator
14028 Document\SpecialChar \menuseparator
14032 ), you can emulate article style.
14033 That is, counters (footnotes, figures, tables etc.) will not be reset on
14034 new chapters, chapters don't start a new page (but are---in contrary to
14036 \begin_inset Quotes eld
14040 \begin_inset Quotes erd
14043 article classes---still allowed), parts, though, use their own page, as
14047 \begin_layout Description
14048 Oldfontcommands: By default, Memoir does not allow the use of the deprecated
14049 font commands, which have been used in the old LaTeX version 2.09 (e.
14053 \begin_layout Standard
14066 \begin_layout Standard
14088 It produces an error and stops LaTeX whenever such a command appears.
14093 reallows the commands and spits out warnings instead (which does at least
14095 Since a lot of packages and particularly BibTeX style files are still using
14096 those commands, we have decided to use this option by default.
14099 \begin_layout Subsection
14103 \begin_layout Standard
14104 We will only describe the features supported by LyX (which is not much currently
14106 Please consult the Memoir manual
14110 \begin_layout Standard
14115 \begin_layout Standard
14125 \begin_inset LatexCommand url
14126 target "CTAN:/macros/latex/memoir/memman.pdf"
14138 \begin_layout Description
14139 Abstract: You may wonder why an abstract is an extra feature.
14140 Well, it is in book class.
14141 Usually books don't have abstracts.
14142 Memoir, however, has.
14143 You can use it wherever and how often you like.
14146 \begin_layout Description
14147 Chapterprecis: You may know this from belletristic: The contents of a chapter
14148 is shortly described below the title and also in the table of contents
14153 \begin_layout Standard
14166 \begin_layout Standard
14177 Our hero arrives in Troia; he loses some friends; he finds others
14180 Chapterprecis does exactly this.
14181 It is therefore only sensible below a chapter.
14184 \begin_layout Description
14185 Epigraph: An epigraph is a smart slogan or motto at the beginning of a chapter.
14186 The epigraph environment provides an elegant way of typesetting such a
14188 The motto itself (text) and its author (source) are divided by a short
14190 Unfortunately, we have to fool LyX a bit here again, since the environment
14191 needs two arguments (text and source).
14192 In this case, we have to use curly brackets (in TeX mode) between the two
14203 <author of the slogan>.
14206 \begin_layout Description
14207 Poemtitle: Memoir has lots of possibilities to typeset poetry (up to very
14208 complex figurative poems).
14209 LyX can only support a few of them.
14210 One is poemtitle, which is a centered title for poems, which will also
14211 be added to the table of contents (verse is the standard environment for
14213 Memoir has some enhanced versions of verse, but you need to use ERT, because
14214 they have to be nested inside regular verse environments, which is not
14215 possible with LyX).
14218 \begin_layout Description
14219 Poemtitle*: Same as poemtitle, but it adds no entry to the table of contents.
14222 \begin_layout Chapter
14223 Importing and Exporting Alternate File Formats
14224 \begin_inset OptArg
14227 \begin_layout Standard
14228 Importing and Exporting
14236 \begin_layout Section
14240 \begin_layout Standard
14241 Importing and exporting LyX documents from/to other formats has been touched
14247 Here we describe more of the gory details needed to understand just what
14248 is going on when you click on the
14253 ile\SpecialChar \menuseparator
14265 ile\SpecialChar \menuseparator
14276 \begin_layout Section
14277 Importing Other Formats
14280 \begin_layout Subsection
14284 \begin_layout Standard
14285 Translating from LaTeX into LyX is performed by a Perl script called reLyX.
14286 Although it is a standalone program which can be called from the command
14287 line, LyX will call it automatically when a LaTeX document is imported.
14288 See section\InsetSpace ~
14290 \begin_inset LatexCommand ref
14291 reference "sec:reLyX"
14295 for a complete description.
14296 There are no user tunable parameters for reLyX within LyX.
14299 \begin_layout Subsection
14303 \begin_layout Standard
14304 When importing plain ASCII text, there are two methods of reading the file.
14306 \begin_inset Quotes eld
14310 \begin_inset Quotes erd
14313 preserves all the linebreaks in the ASCII; to LyX, then, each line looks
14316 \begin_inset Quotes eld
14320 \begin_inset Quotes erd
14323 assumes that consecutive lines separated by only a single linebreak form
14324 a single paragraph.
14325 Successive linebreaks with no intervening text are thus assumed to be paragraph
14329 \begin_layout Subsection
14333 \begin_layout Standard
14336 [Editor's note: Needs to be written, obviously - any volunteers? --- mer]
14339 \begin_layout Section
14340 Exporting Other Formats
14343 \begin_layout Standard
14344 The output formats listed here in the following are also explained concerning
14345 possible graphics formats in the
14352 \begin_layout Subsection
14356 \begin_layout Standard
14357 LyX generates two types of LaTeX files: stripped down versions for the normal
14362 , etc.) which one normally never sees
14366 \begin_layout Standard
14367 The resulting file is a perfectly valid LaTeX file, though the preamble
14368 might look a bit strange since it includes some definitions used by LyX
14369 which wouldn't show up in most human-written files.
14374 , and human readable forms which are suitable for exchanging with your colleague
14376 The only settable option for the translation is the line length of the
14378 The default is 65 characters, but it can be set in
14385 \SpecialChar \menuseparator
14406 \begin_layout Subsection
14407 Device Independent Files
14410 \begin_layout Standard
14411 Device Independent files (DVI files) are produced by running LaTeX on your
14413 There are no user settable options.
14416 \begin_layout Subsection
14420 \begin_layout Standard
14421 The next step in the conversion chain is converting a DVI file into Postscript.
14429 \SpecialChar \menuseparator
14437 \SpecialChar \menuseparator
14446 or, if you need more control on the result,
14453 \SpecialChar \menuseparator
14462 If you use the later, note that it is possible to configure, in
14469 \SpecialChar \menuseparator
14477 , the options passed to the dvips program to achieve different effects.
14480 \begin_layout Subsection
14484 \begin_layout Standard
14485 Exporting as ASCII attempts to preserve the
14486 \begin_inset Quotes eld
14490 \begin_inset Quotes erd
14493 of the document as well as possible, but things like centering and indentation
14494 are thrown out; paragraphs are separated by blank lines.
14495 Section numbering and cross-references are done correctly, so the resulting
14496 text files is remarkably readable.
14497 The only changeable option is the length of lines, as for LaTeX output.
14500 \begin_layout Subsection
14504 \begin_layout Standard
14505 LyX documents can be converted to hypertext markup, usually by converting
14506 to LaTeX first, then converting that to HTML\SpecialChar \@.
14508 \begin_inset Formula $\rightarrow$
14511 HTML converters are currently known to LyX:
14528 Though they are autodetected, you can overide the selection in preferences.
14529 You can also include further command line options in this dialog.
14533 \begin_layout Subsection
14537 \begin_layout Standard
14545 \begin_layout Standard
14546 \begin_inset VSpace bigskip
14552 \begin_layout Standard
14553 The fastest way to generate a basic PDF file (no tags, links, etc.) with
14554 any version of LyX is to save the document as a Postscript file, then run
14560 Starting with version 1.1.6, the menu item
14564 will do all this for you.
14565 There are some issues with fonts that you need to pay attention to: see
14566 Section\InsetSpace ~
14568 \begin_inset LatexCommand ref
14569 reference "sec:badfonts"
14574 Also, as of version 1.1.6, there is a better method that will generate much
14575 more sophisticated files.
14578 \begin_layout Subsubsection
14582 \begin_layout Standard
14583 With pdfLaTeX you cannot use pstricks.
14584 On the other hand, with pdfLaTeX it is possible to insert directly images
14585 in JPEG, PDF or PNG format, use TrueType fonts, and more.
14588 \begin_layout Subsubsection
14589 Why does the text look so bad when viewed with Acrobat Reader?
14590 \begin_inset LatexCommand label
14591 name "sec:badfonts"
14596 \begin_inset OptArg
14599 \begin_layout Standard
14600 Bad Fonts in Acrobat Reader
14608 \begin_layout Standard
14609 The problem is that bitmap fonts are displayed poorly by Acrobat Reader.
14610 When creating a PDF from the LyX file, you need to use outline font instead
14611 of the default bitmap fonts (in fact, you should also use outline fonts
14612 for Postscript files).
14613 Recent LaTeX distributions come with Postscript Type 1 version of the standard
14614 (Computer Modern) fonts.
14615 pdfLaTeX uses these font by default.
14616 Dvips doesn't use these fonts by default, so to make it use them, add the
14617 following to lines to your
14624 \begin_layout LyX-Code
14628 \begin_layout LyX-Code
14632 \begin_layout Standard
14633 If the default LaTeX font encoding (OT1) is used, nothing else need to be
14635 However, if the T1 font encoding is used, then LaTeX uses the newer EC
14636 fonts, for which there are no Type1 version.
14637 The solution is to use the ae package which emulates T1 coded fonts using
14638 the standard CM fonts.
14639 This is done by adding
14643 usepackage{ae,aecompl}
14645 to the preamble of the LyX file.
14646 However, some glyphs are missing from the CM fonts (e.\InsetSpace \thinspace{}
14649 they are taken from the EC fonts.
14650 Therefore you get these glyphs as bitmaps.
14653 \begin_layout Standard
14654 Note: LyX uses by default the T1 font encoding.
14655 If you wish to use the default font encoding (this is not recommended,
14656 unless you only write English documents), clear the field
14664 in preferences (tabs
14676 \begin_layout Standard
14677 An alternate option is to use the standard Postscript fonts instead of the
14678 Computer Modern fonts.
14679 To do that, you need to select
14683 as the global font in the document layout dialog.
14684 When using the Postscript fonts, the result PDF file is smaller as the
14685 fonts are not saved into the file.
14686 Furthermore, the Postscript fonts include all T1 glyphs.
14687 On the other hand, the Postscript fonts have no bold symbol font, so poor
14688 man's bold must be used (see Section\InsetSpace ~
14690 \begin_inset LatexCommand ref
14691 reference "sec:pdfbold"
14696 The Postscript fonts also look different from the Computer Modern fonts.
14699 \begin_layout Standard
14700 To sum up, both the Computer Modern and the Postscript fonts gives good
14701 results (with few exceptions).
14702 The decision of which one to use is a matter of taste.
14705 \begin_layout Subsubsection
14708 boldsymbol{} command work when I use pslatex?
14709 \begin_inset LatexCommand label
14715 \begin_inset OptArg
14718 \begin_layout Standard
14735 \begin_layout Standard
14736 The Postscript fonts do not have a bold symbol font.
14737 The solution is to use the
14743 (poor man's bold) command.
14746 \begin_layout Standard
14747 It is possible to redefine the
14762 \begin_layout LyX-Code
14772 \begin_layout Standard
14776 \begin_layout Subsubsection
14777 Is it possible to do write LaTeX-code which is processed only when running
14779 \begin_inset OptArg
14782 \begin_layout Standard
14783 Conditionals with pdfLaTeX
14791 \begin_layout Standard
14792 Yes you can do this with the
14797 Here is an example:
14800 \begin_layout LyX-Code
14804 \begin_layout LyX-Code
14810 \begin_layout LyX-Code
14816 \begin_layout LyX-Code
14819 pdfinfo { /Author (your name and e-mail address)
14822 \begin_layout LyX-Code
14823 /Title (official title -- i.e., title element)
14826 \begin_layout LyX-Code
14827 /Subject (one line description of the document)
14830 \begin_layout LyX-Code
14834 \begin_layout LyX-Code
14837 pdfcatalog { /PageMode (/UseNone)
14840 \begin_layout LyX-Code
14841 % /OpenAction (fitbh)
14844 \begin_layout LyX-Code
14848 \begin_layout LyX-Code
14851 usepackage[pdftex]{hyperref}
14854 \begin_layout LyX-Code
14860 \begin_layout LyX-Code
14863 usepackage[ps2pdf]{hyperref}
14866 \begin_layout LyX-Code
14872 \begin_layout Subsubsection
14873 How can I make URLs clickable?
14876 \begin_layout Standard
14877 See the references here:
14880 \begin_layout Standard
14881 \begin_inset LatexCommand url
14882 target "http://wiki.lyx.org/pmwiki.php/FAQ/PDF"
14889 \begin_layout Subsection
14893 \begin_layout Standard
14894 Custom exports are possible if you have some particularly weird format you
14895 wish to convert to, assuming you have the relevant converter, of course.
14900 file can be chosen in the
14905 ile\SpecialChar \menuseparator
14910 xport\SpecialChar \menuseparator
14917 dialog; LyX will automatically convert the file to this point, then feed
14918 it to your custom converter.
14919 The possible values are all formats that LyX can produce from its own documents.
14923 \begin_layout Standard
14924 The converter command is also specified in the dialog.
14925 It should be a completely qualified command line which uses the variable
14930 to specify the name of the file.
14931 If this variable is not given, then the file will be sent to the standard
14932 input of your command.
14933 You may have to apply a bit of ingenuity to escape this sequence correctly
14934 so that it is compatible with your shell.
14938 \begin_layout Standard
14939 While it is not possible to save this command using the
14943 dialog, you can manually edit your
14950 \begin_layout LyX-Code
14953 custom_export_command "mycommand $$FName"
14956 \begin_layout Chapter
14957 LyX Features needing Extra Software
14960 \begin_layout Section
14964 \begin_layout Standard
14970 \begin_layout Subsection
14974 \begin_layout Standard
14982 menu, you'll find a
14991 This feature requires you to have the
14995 program installed, and is grayed out if you don't have it.
14996 You can get it from your nearest CTAN mirror, or over the Web from
14997 \begin_inset LatexCommand url
14998 target "http://www.ifi.uio.no/~jensthi/chktex/"
15005 \begin_layout Standard
15010 package is a program that was written by
15015 in frustration because some constructs in LaTeX are sometimes non-intuitive,
15016 and easy to forget.
15017 The program runs over your LaTeX file and checks the integrity of the file,
15018 and flags some common errors.
15019 In other technical words, it is
15026 \begin_layout Standard
15027 Well, what is a syntax checker doing in LyX which is supposed to produce
15028 correct LaTeX anyways? The answer is simple: Just as
15032 not only checks the
15036 of C programs, but also does
15040 checks for type-errors,
15044 catches some common
15048 errors, in addition to the syntactical ones.
15053 is capable of detecting several common errors, such as
15056 \begin_layout Itemize
15057 Ellipsis detection:
15059 Use \SpecialChar \ldots{}
15063 \begin_layout Itemize
15064 No space in front of/after parenthesis:
15069 \begin_layout Itemize
15070 Enforcement of normal space after common abbreviations:
15074 is too wide spacing.
15077 \begin_layout Itemize
15078 Enforcement of end-of-sentence space when the last sentence ends with a
15082 And this is wrong spacing.
15085 \begin_layout Itemize
15086 Space in front of labels and similar commands:
15088 The label should stick right
15089 up to the text to avoid falling to a wrong page.
15091 \begin_inset LatexCommand label
15100 \begin_layout Standard
15101 This footnote is in danger of falling off to a wrong page
15106 The label is separated too much.
15109 \begin_layout Itemize
15110 Space in front of references, instead of hard spaces:
15112 In you are in bad luck,
15113 the text will break right between the referenced text and reference number,
15116 \begin_inset LatexCommand ref
15117 reference "sec:chktex"
15124 \begin_layout Itemize
15126 \begin_inset Quotes eld
15130 \begin_inset Quotes erd
15134 \begin_inset Formula $\times$
15139 2x2 looks cheap compared to
15140 \begin_inset Formula $2\times2$
15146 \begin_layout Standard
15147 and more \SpecialChar \ldots{}
15148 It is an invaluable tool when you are
15149 \begin_inset Quotes eld
15153 \begin_inset Quotes erd
15156 your document before printing, and you should run it right after the obligatory
15157 spelling check, and before you go fine tuning the typesetting.
15160 \begin_layout Subsection
15164 \begin_layout Standard
15165 If you have the program installed, usage is as simple as choosing
15170 ools\SpecialChar \menuseparator
15179 This will make LyX generate a LaTeX file of your document, start
15183 to check it, and then make LyX insert
15184 \begin_inset Quotes eld
15188 \begin_inset Quotes erd
15191 with the warnings from
15195 , if there were any.
15196 The warnings will be placed close to the point of the mistake, and you
15197 can quickly find them by using the
15202 avigate\SpecialChar \menuseparator
15209 menu item, or the shortcut key
15218 Open the error boxes by clicking on them with the mouse, or use the shortcut
15227 bindings, or the corresponding
15236 Read the warning and correct the mistake, if it is a mistake.
15237 If you have trouble understanding what the warning is about, you can safely
15239 Remember that there is a hidden layer between the document on screen and
15240 the technical details in invoking
15244 , and this gap can make some warnings seem arcane or just right down plain
15248 \begin_layout Standard
15249 This document is an excellent testing bed for the feature, and it should
15250 provide quite a few warnings for you to fiddle with.
15251 Since computers are only so smart, expect most of the warnings to be false
15255 \begin_layout Subsection
15256 How to fine tune it
15259 \begin_layout Standard
15260 Sometimes, you'll find that
15264 makes more noise than suits your mood.
15265 Then you can choose not to use it, wait until your mood changes, or try
15270 to get better along with you.
15271 Another choice in the most desperate situations is to use
15276 iew\SpecialChar \menuseparator
15286 , which will get rid of all warnings instantly.
15289 \begin_layout Standard
15298 very configurable and extensible, you shouldn't expect to solve all problems
15304 Since LyX has to generate a somewhat special LaTeX file to be able to match
15305 the line numbers from the
15313 \begin_layout Standard
15314 You can inspect the specific output from
15320 Edit\SpecialChar \menuseparator
15334 to the internal document structure, some of the warnings will not seen
15335 to appear correctly.
15336 There are two things you can do about this:
15339 \begin_layout Itemize
15344 invocation command line in
15360 installation configuration file (usually with the file
15362 /usr/local/share/chktexrc
15365 See below to learn what warnings can be enabled and disabled on the command
15370 \begin_layout Itemize
15371 Export your document as a raw LaTeX file using
15376 ile\SpecialChar \menuseparator
15381 xport\SpecialChar \menuseparator
15393 Invoked in this way, it can be a hassle to find the corresponding place
15394 in the document inside LyX, but with a little patience, you should be able
15398 \begin_layout Standard
15399 Here follows the warning messages that can be enabled and disabled in
15408 to disable a warning, and
15412 to enable a warning.
15413 The emphasized entries are disabled by default, because the default is
15416 chktex -n1 -n3 -n6 -n9 -n22 -n25 -n30 -n38
15421 \begin_layout Standard
15422 Notice that you should only use the options that enable and disable warnings,
15423 because LyX relies on some of the other command line parameters to be set
15424 in a specific way to have a chance to communicate with
15431 \begin_layout Enumerate
15435 Command terminated with space.
15438 \begin_layout Enumerate
15441 Non-breaking space (
15442 \begin_inset Quotes eld
15450 \begin_inset Quotes erd
15453 ) should have been used.
15456 \begin_layout Enumerate
15460 You should enclose the previous parenthesis with
15461 \begin_inset Quotes eld
15469 \begin_inset Quotes erd
15475 \begin_layout Enumerate
15478 Italic correction (
15479 \begin_inset Quotes eld
15489 \begin_inset Quotes erd
15492 ) found in non-italic buffer.
15495 \begin_layout Enumerate
15498 Italic correction (
15499 \begin_inset Quotes eld
15509 \begin_inset Quotes erd
15512 ) found more than once.
15515 \begin_layout Enumerate
15519 No italic correction (
15520 \begin_inset Quotes eld
15530 \begin_inset Quotes erd
15536 \begin_layout Enumerate
15540 \begin_inset Quotes eld
15548 \begin_inset Quotes erd
15552 \begin_inset Quotes eld
15560 \begin_inset Quotes erd
15566 \begin_layout Enumerate
15569 Wrong length of dash may have been used.
15572 \begin_layout Enumerate
15576 \begin_inset Quotes eld
15584 \begin_inset Quotes erd
15588 \begin_inset Quotes eld
15596 \begin_inset Quotes erd
15602 \begin_layout Enumerate
15606 \begin_inset Quotes eld
15614 \begin_inset Quotes erd
15620 \begin_layout Enumerate
15624 \begin_inset Quotes eld
15632 \begin_inset Quotes erd
15635 to achieve an ellipsis.
15638 \begin_layout Enumerate
15641 Inter-word spacing (
15642 \begin_inset Quotes eld
15652 \begin_inset Quotes eld
15655 ) should perhaps be used.
15658 \begin_layout Enumerate
15661 Inter-sentence spacing (
15662 \begin_inset Quotes eld
15672 \begin_inset Quotes erd
15675 ) should perhaps be used.
15678 \begin_layout Enumerate
15681 Could not find argument for command.
15684 \begin_layout Enumerate
15688 \begin_inset Quotes eld
15696 \begin_inset Quotes erd
15702 \begin_layout Enumerate
15705 Math mode still on at end of LaTeX file.
15708 \begin_layout Enumerate
15712 \begin_inset Quotes eld
15720 \begin_inset Quotes erd
15723 doesn't match the number of
15724 \begin_inset Quotes eld
15732 \begin_inset Quotes erd
15738 \begin_layout Enumerate
15741 You should use either
15744 \begin_inset Quotes eld
15752 \begin_inset Quotes erd
15757 as an alternative to
15758 \begin_inset Quotes eld
15766 \begin_inset Quotes erd
15772 \begin_layout Enumerate
15779 " (ASCII 39) instead of "
15786 \begin_layout Enumerate
15789 User-specified pattern found.
15792 \begin_layout Enumerate
15795 This command might not be intended.
15798 \begin_layout Enumerate
15805 \begin_layout Enumerate
15823 \begin_layout Enumerate
15826 Delete this space to maintain correct page references.
15829 \begin_layout Enumerate
15833 You might wish to put this between a pair of
15834 \begin_inset Quotes eld
15842 \begin_inset Quotes erd
15848 \begin_layout Enumerate
15851 You ought to remove spaces in front of punctuation.
15854 \begin_layout Enumerate
15857 Could not execute LaTeX command.
15860 \begin_layout Enumerate
15869 in front of small punctuation.
15872 \begin_layout Enumerate
15880 may look prettier here.
15883 \begin_layout Enumerate
15887 Multiple spaces detected in output.
15890 \begin_layout Enumerate
15893 This text may be ignored.
15896 \begin_layout Enumerate
15902 \begin_inset Quotes eld
15907 to begin quotation, not
15914 \begin_layout Enumerate
15921 to end quotation, not
15924 \begin_inset Quotes eld
15932 \begin_layout Enumerate
15938 \begin_layout Enumerate
15941 You should perhaps use
15942 \begin_inset Quotes eld
15950 \begin_inset Quotes erd
15956 \begin_layout Enumerate
15959 You should put a space in front of/after parenthesis.
15962 \begin_layout Enumerate
15965 You should avoid spaces in front of/after parenthesis.
15968 \begin_layout Enumerate
15972 You should not use punctuation in front of/after quotes.
15975 \begin_layout Enumerate
15978 Double space found.
15981 \begin_layout Enumerate
15984 You should put punctuation outside inner/inside display math mode.
15987 \begin_layout Enumerate
15990 You ought to not use primitive TeX in LaTeX code.
15993 \begin_layout Enumerate
15996 You should remove spaces in front of
15997 \begin_inset Quotes eld
16005 \begin_inset Quotes erd
16011 \begin_layout Enumerate
16014 \begin_inset Quotes eld
16022 \begin_inset Quotes erd
16025 is normally not followed by
16026 \begin_inset Quotes eld
16034 \begin_inset Quotes erd
16040 \begin_layout Standard
16041 In later versions of LyX, we hope to provide a more complete interface to
16042 this tool (and it's smaller cousin
16046 ) to exploit the full power of it.
16047 But it's not exactly useless as it is now: go try it on one of your existing
16048 documents of a certain length and be surprised.
16051 \begin_layout Section
16052 Version Control in LyX
16055 \begin_layout Standard
16058 Lars Gullik Bjønnes
16061 \begin_layout Subsection
16065 \begin_layout Standard
16066 A friend of mine wanted to try LyX for a group project.
16067 When he didn't find support for version control or file locking, he dropped
16069 This angered me a bit, so I thought that I should at least make support
16070 for RCS (with the possibility of CVS and/or SCCS as a future improvement.)
16071 This has now been done.
16072 LyX now supports some of the most basic RCS commands.
16073 If you need to something a bit more sophisticated you will have to do that
16074 manually in an xterm.
16077 \begin_layout Standard
16078 Before you begin to use the version control features in LyX, you should
16080 \begin_inset Quotes eld
16084 \begin_inset Quotes erd
16087 (a man file, read it with
16092 This file describes all the basic features of RCS.
16093 You should especially notice the comment about a RCS directory, and the
16094 notion of a master RCS file (the file ending in
16101 \begin_layout Standard
16102 The implementation in LyX assumes a recent version of the GNU RCS package---no
16103 guarantees are made for older versions.
16106 \begin_layout Subsection
16107 RCS commands in LyX
16110 \begin_layout Standard
16111 The following sections describe the RCS commands supported by LyX.
16112 You can find them in the
16117 ile\SpecialChar \menuseparator
16122 ersion\InsetSpace ~
16128 \begin_layout Subsubsection
16134 \begin_layout Standard
16135 If your document is not under revision control, this is the only item shown
16137 And if it is under revision control, the
16144 item is grayed out.
16148 \begin_layout Standard
16149 This command registers your document with RCS\SpecialChar \@.
16150 You are asked interactively
16151 to supply an initial description of the document.
16152 The document is now set in Read-Only mode and you have to
16159 , before making any changes to it.
16160 A document under revision control has a
16161 \begin_inset Quotes eld
16164 [RCS:<version> <locker>]
16165 \begin_inset Quotes erd
16168 item tagged to the filename in the minibuffer.
16171 \begin_layout Standard
16172 RCS command that is run:
16174 ci -q -u -i -t-"<initial description>" <file-name>
16177 \begin_layout Standard
16182 to understand the switches.
16186 \begin_layout Subsubsection
16192 \begin_layout Standard
16193 When you are finished editing a file, you check in your changes.
16194 When you do this, you are asked for a description of the changes.
16195 This is stored in the history log.
16196 The version number is bumped, your changes are applied to the master RCS
16197 file, the document is unlocked and set to Read-Only mode.
16201 \begin_layout Standard
16204 ci -q -u -m"<description>" <file-name>
16207 \begin_layout Subsubsection
16213 \begin_layout Standard
16214 By doing this you lock the document so that only you can edit it.
16215 This will also make the document Read-Write only for you.
16216 You will usually continue editing for a while and when you are finished
16217 you check in your changes.
16218 The status line is changed to reflect that you have locked the file.
16222 \begin_layout Standard
16225 co -q -l <file-name>
16228 \begin_layout Subsubsection
16231 Revert To Last Version
16234 \begin_layout Standard
16235 This will discard all changes made to the document since the last check
16237 You get a warning before changes are discarded.
16240 \begin_layout Standard
16243 co -f -u<version> <file-name>
16246 \begin_layout Subsubsection
16252 \begin_layout Standard
16253 This makes as if the last check in never happened.
16254 No changes are made to the document loaded into LyX, but the last version
16255 is removed from the master RCS file.
16259 \begin_layout Standard
16262 rcs -o<version> <file-name>
16265 \begin_layout Subsubsection
16271 \begin_layout Standard
16272 This show the complete history of the RCS document.
16277 is shown in a browser.
16285 \begin_layout Section
16286 Literate Programming
16289 \begin_layout Standard
16294 (kayvan@sylvan.com)
16298 original documentation written by
16300 Edmar Wienskoski Jr.
16303 (edmar-w-jr@technologist.com)
16306 \begin_layout Subsection
16310 \begin_layout Standard
16311 The main purpose of this documentation is to show you how to use LyX for
16312 literate programming.
16313 Where it is assumed that you are familiar with this programming technique,
16315 \begin_inset Quotes eld
16319 \begin_inset Quotes erd
16323 \begin_inset Quotes eld
16327 \begin_inset Quotes erd
16331 If that is not the case, please follow the web links provided in the following
16333 There is a lot of good documentation out there covering old development
16334 history to the latest tools tips.
16337 \begin_layout Standard
16338 It is also assumed that you are familiar with LyX itself to a point that
16339 you are comfortable changing your LyX preferences, and X resources file.
16340 If that is not the case please refer to other LyX documentation to cover
16341 your specific needs.
16344 \begin_layout Subsection
16345 Literate Programming
16348 \begin_layout Standard
16349 From the Literate Programming FAQ:
16352 \begin_layout Quotation
16353 Literate programming is the combination of documentation and source together
16354 in a fashion suited for reading by human beings.
16355 In fact, literate programs should be enjoyable reading, even inviting!
16356 (Sorry Bob, I couldn't resist!) In general, literate programs combine source
16357 and documentation in a single file.
16358 Literate programming tools then parse the file to produce either readable
16359 documentation or compilable source.
16360 The WEB style of literate programming was created by D.E.
16361 Knuth during the development of his TeX typesetting software.
16365 \begin_layout Standard
16366 Another excerpt says:
16369 \begin_layout Quotation
16372 How is literate programming different from verbose commenting?
16375 \begin_layout Quotation
16376 There are three distinguishing characteristics.
16377 In order of importance, they are:
16381 \begin_layout Itemize
16382 flexible order of elaboration
16385 \begin_layout Itemize
16386 automatic support for browsing
16389 \begin_layout Itemize
16390 typeset documentation, especially diagrams and mathematics
16394 \begin_layout Standard
16395 Now that I sparked your curiosity, take a look in the references.
16398 \begin_layout Subsubsection
16402 \begin_layout Standard
16403 The complete Literate Programming FAQ can be found at:
16406 \begin_layout Quote
16407 \begin_inset LatexCommand url
16408 name "Literate Programming FAQ"
16409 target "http://shelob.ce.ttu.edu/daves/lpfaq/faq.html"
16416 \begin_layout Standard
16417 The FAQ lists 23 (twenty three!) different literate programming tools.
16418 Where some are specialized or
16419 \begin_inset Quotes eld
16423 \begin_inset Quotes erd
16426 for particular programming languages, while other have general scope.
16431 for my own use for several reasons:
16434 \begin_layout Itemize
16435 It can generate the documentation either in LaTeX or HTML.
16438 \begin_layout Itemize
16439 It has a open architecture, i.e., it is easy to plug in new filters and to
16440 perform special processing that you may need.
16444 \begin_layout Itemize
16445 There is a good selection of filters available already (the HTML is one
16449 \begin_layout Itemize
16453 \begin_layout Standard
16454 The Noweb web page can be found at:
16457 \begin_layout Quote
16458 \begin_inset LatexCommand url
16459 name "Noweb home page"
16460 target "http://www.cs.virginia.edu/~nr/noweb/"
16467 \begin_layout Standard
16468 Starting from there you can reach many other interesting links and even
16469 some literate program examples.
16472 \begin_layout Subsection
16473 \begin_inset LatexCommand label
16474 name "sub:LyX-and-Literate"
16478 LyX and Literate Programming
16481 \begin_layout Standard
16482 The LyX support for Literate Programming is provided by using the generic
16483 LyX convertors mechanism.
16484 This support is provided in a
16485 \begin_inset Quotes eld
16489 \begin_inset Quotes erd
16492 way, i.e., you will be able to use this new LyX feature with some other literate
16493 programming tool of your choice by just changing your LyX preferences.
16496 \begin_layout Subsubsection
16497 Generating documents and code (weaving and tangling)
16500 \begin_layout Paragraph
16501 Selecting the document class
16504 \begin_layout Standard
16505 If you have installed Noweb and LyX successfully, whenever you open a new
16506 document or try to change the document class of an existing one, you will
16507 find that there are three new document classes available:
16510 \begin_layout Itemize
16514 \begin_layout Itemize
16518 \begin_layout Itemize
16522 \begin_layout Standard
16523 You must select one of them to create your literate documents from.
16527 \begin_layout Standard
16528 Note that literate documents are not limited to these three classes.
16529 New classes can be generated from other styles like letter or in combination
16530 with other class variations like Article (AMS).
16531 If you have special needs that cannot be covered by one of the existing
16532 classes, let the LyX developers list (lyx-devel@lists.lyx.org) know and we
16533 will arrange to insert a new entry, or teach you how to do it.
16537 \begin_layout Standard
16538 It is very simple, it involves the creation of a file with four lines, and
16539 re-running of the auto configuration.
16544 Moreover, if you use a literate tool other than Noweb you may need to create
16545 a new set of document classes for it.
16548 \begin_layout Paragraph
16552 \begin_layout Standard
16553 LyX enables you to write code with a layout named
16561 \begin_layout Standard
16562 The equivalent Noweb term is
16563 \begin_inset Quotes eld
16567 \begin_inset Quotes erd
16571 For historical reasons, I got used to the term
16572 \begin_inset Quotes eld
16576 \begin_inset Quotes erd
16579 introduced by other literate tool named Nuweb, which I used for many years
16580 before rendering myself to Noweb.
16585 Noweb delimits scraps like this:
16588 \begin_layout LyX-Code
16592 \begin_layout LyX-Code
16596 \begin_layout LyX-Code
16600 \begin_layout LyX-Code
16604 \begin_layout LyX-Code
16608 \begin_layout Standard
16609 The problem is that whatever is written in between the << and the
16613 must be taken literally, i.e., LyX should be prevented from making any special
16614 interpretation of what has been written.
16615 This is handled by a special layout named Scrap, that works like a normal
16616 paragraph but has a free spacing capability.
16619 \begin_layout Standard
16620 The down side of the Scrap paragraph layout is that consecutive paragraphs
16621 of code will be spaced with one empty line in the source code and also
16622 in the printed documentation.
16623 The work around is to enter each line of code within a single Scrap, with
16624 a newline (ctrl-return).
16625 The example above will look like this:
16629 \begin_layout Standard
16630 If you have a printed version of this document you will not see any difference
16631 between the previous example and this one.
16639 \begin_layout LyX-Code
16651 \begin_layout Standard
16652 This layout works fine.
16653 The only real inconvenience is that you have to type ctrl-return instead
16658 \begin_layout Standard
16659 It is in my list of
16660 \begin_inset Quotes eld
16664 \begin_inset Quotes erd
16675 \begin_layout Standard
16676 As a special note, you can also use the
16677 \begin_inset Quotes eld
16681 \begin_inset Quotes erd
16684 construct of Noweb in your scraps to add items to Noweb's identifier cross-refe
16688 \begin_layout LyX-Code
16691 def some_function(args):
16693 "This is the doc string for this
16696 print "My args: ", args
16699 \begin_layout LyX-Code
16700 @ %def some_function
16703 \begin_layout Standard
16704 For an example of this usage and the resulting cross-reference output, look
16705 at the Literate python program in
16707 LIBDIR/examples/listerrors.lyx
16709 which should make this all clear.
16712 \begin_layout Paragraph
16713 Generating the documentation
16716 \begin_layout Standard
16717 At this point you already have a new document file with a proper document
16718 class, and with some code and text on it.
16719 How do I print it? The answer is simple, you select
16724 iew\SpecialChar \menuseparator
16732 Just like you would do for a plain document.
16733 No special procedure is required.
16736 \begin_layout Standard
16737 To help orientate you, I will now explain what happens inside LyX:
16740 \begin_layout Enumerate
16746 pdate\SpecialChar \menuseparator
16753 menu option is chosen, a LaTeX file is generated.
16758 \begin_layout Standard
16759 If the document is of any literate class the generated file will be named
16760 with an extension name defined by the
16761 \begin_inset Quotes eld
16765 \begin_inset Quotes erd
16768 format (defined in the Preferences panel), otherwise the file will have
16777 \begin_layout Enumerate
16778 Note that the only difference so far is in the name of the file, no special
16779 processing is required by LyX.
16780 Given that you formatted the code using the Scrap layout that, by itself,
16781 takes care of the business.
16784 \begin_layout Enumerate
16785 If the document is of any literate class LyX will then use the internal
16786 LyX to Noweb converter, followed by the Noweb to LaTeX converter
16790 \begin_layout Standard
16791 The converters are defined in the
16796 ools\SpecialChar \menuseparator
16804 \begin_inset Quotes eld
16808 \begin_inset Quotes erd
16813 \begin_inset LatexCommand ref
16814 reference "sub:converters"
16822 manual for general information about converters.
16827 to generate the LaTeX file.
16831 \begin_layout Standard
16832 Otherwise it will just skip this step.
16836 \begin_layout Enumerate
16837 Finally, LaTeX is invoked and the regular post processing continues as in
16841 \begin_layout Standard
16842 Independence from a particular
16843 \begin_inset Quotes eld
16847 \begin_inset Quotes erd
16850 is easily achieved by changing the commands that are run by the various
16854 \begin_layout Paragraph
16855 Generating the code
16858 \begin_layout Standard
16859 When the build menu option is chosen or the corresponding button in the
16860 toolbar is pressed, a LaTeX file is generated just like step 1 above.
16861 Next, LyX invokes the
16866 This converter needs to be defined by the user and is not installed by
16867 default, though the Program format is.
16868 This converter (like any other converter) will have two parts:
16871 \begin_layout Enumerate
16872 The converter program itself.
16873 This program performs the conversion from the one format to the other (in
16874 this case, from the Noweb format to the Program pseudo-format).
16877 \begin_layout Enumerate
16878 The error log parser.
16879 This is a program whose sole purpose is to rewrite error messages in a
16880 format that LyX understands.
16881 This makes it possible for LyX to place error boxes in the right places
16882 in the file buffer.
16885 \begin_layout Standard
16886 The first part, the
16887 \begin_inset Quotes eld
16891 \begin_inset Quotes erd
16894 setting, should be set to
16895 \begin_inset Quotes eld
16903 \begin_inset Quotes erd
16907 This basically means that LyX will call
16908 \begin_inset Quotes eld
16912 \begin_inset Quotes erd
16915 (a program or script) with the name of the Noweb file (normally a file
16916 in the LyX temp directory).
16920 \begin_layout Standard
16921 This is an implementation of
16922 \begin_inset Quotes eld
16926 \begin_inset Quotes erd
16929 that you can place in a directory on your path:
16932 \begin_layout LyX-Code
16936 \begin_layout LyX-Code
16940 \begin_layout LyX-Code
16941 notangle -Rbuild-script $1 | env NOWEB_SOURCE=$1 sh
16944 \begin_layout Standard
16945 The next part of the converter setting is the
16946 \begin_inset Quotes eld
16950 \begin_inset Quotes erd
16953 which is to be set to
16954 \begin_inset Quotes eld
16959 parselog=listerrors
16962 \begin_inset Quotes erd
16966 This will run any errors that are generated by the
16967 \begin_inset Quotes eld
16971 \begin_inset Quotes erd
16974 process through the
16975 \begin_inset Quotes eld
16979 \begin_inset Quotes erd
16985 \begin_layout Standard
16986 The converter code looks in
16994 then on the path for the
16995 \begin_inset Quotes eld
16999 \begin_inset Quotes erd
17005 \begin_layout Standard
17006 The build will normally take place in LyX's temporary directory, so the
17007 files produced by the conversion will be in that directory.
17008 LyX will copy out what it regards as the `main' file, but the
17012 conversion may produce several files, and so most of these would then be
17013 deleted when LyX was closed.
17014 The present solution is to use a `copier',
17018 \begin_layout Standard
17020 \begin_inset LatexCommand ref
17021 reference "sec:converters-etc"
17029 manual for information on these.
17038 script in its default mode, so that the entire contents of the temporary
17039 directory is copied.
17040 More will get copied than is needed, to be sure, but nothing will be lost.
17041 If, however, you know what extensions the generated files will have, this
17042 can be improved by using the
17051 This option takes a comma-separated list of extensions to copy.
17052 So, for example, if the conversion will generate only files with the extensions
17061 , then the correct definition would be:
17064 \begin_layout LyX-Code
17065 python -tt $$s/scripts/ext_copy.py -e c,h $$i $$o
17068 \begin_layout Standard
17069 The result will be that only files with these two extensions will be copied
17073 \begin_layout Paragraph
17074 Build instructions in the document
17077 \begin_layout Standard
17078 The last piece of the integration between LyX and noweb is the
17079 \begin_inset Quotes eld
17083 \begin_inset Quotes erd
17087 Generally, the instructions for building your program should be embedded
17088 in a scrap of its own.
17090 \begin_inset Quotes eld
17094 \begin_inset Quotes erd
17097 above uses the notangle command to look for this scrap (called
17098 \begin_inset Quotes eld
17102 \begin_inset Quotes erd
17105 ) and runs its contents through
17106 \begin_inset Quotes eld
17110 \begin_inset Quotes erd
17116 \begin_layout Standard
17117 Typically, such a scrap would look something like this:
17120 \begin_layout LyX-Code
17127 if [ -z "${NOWEB_SOURCE}" ]
17131 NOWEB_SOURCE=myfile.nw
17137 code to extract files ...]
17140 code to compile files ...]
17145 \begin_layout Standard
17148 LIBDIR/examples/listerrors.lyx
17152 LIBDIR/examples/Literate.lyx
17154 which implement two versions of the
17155 \begin_inset Quotes eld
17159 \begin_inset Quotes erd
17162 program for some illustrations of how all of these pieces go together or
17165 LIBDIR/examples/noweb2lyx.lyx.
17168 Interestingly, these three files show off the language-indepence of the
17169 LyX literate programming support since they are written in Python, C and
17173 \begin_layout Subsubsection
17177 \begin_layout Standard
17178 All the Literate Programming support is configured by the
17183 ools\SpecialChar \menuseparator
17191 \begin_inset Quotes eld
17195 \begin_inset Quotes erd
17199 The important parts are:
17202 \begin_layout Description
17205 \begin_inset Quotes eld
17209 \begin_inset Quotes erd
17213 format Set up via the Formats tab, this is where the Noweb-specific pieces
17223 , the file extension is set to
17228 This tells LyX to create a file with a
17232 extension in the first step of the conversion process.
17235 \begin_layout Description
17242 format This is an empty format whose sole purpose is to be the endpoint
17243 of a conversion (which then allows us to set up a converter for it).
17246 \begin_layout Description
17255 This converter performs the
17256 \begin_inset Quotes eld
17260 \begin_inset Quotes erd
17263 of the literate document.
17264 For Noweb, it is set to
17265 \begin_inset Quotes eld
17270 noweave -delay -index $$i > $$o
17273 \begin_inset Quotes erd
17279 \begin_layout Description
17289 \begin_inset Quotes eld
17293 \begin_inset Quotes erd
17297 As stated above, the Converter is set to
17298 \begin_inset Quotes eld
17306 \begin_inset Quotes erd
17309 , with Flags set to
17310 \begin_inset Quotes eld
17315 originaldir,parselog=listerrors
17318 \begin_inset Quotes erd
17324 \begin_layout Subsubsection
17328 \begin_layout Standard
17329 There is also a new function implemented in the LyX server, the
17330 \begin_inset Quotes eld
17333 server-goto-file-row" function, to be used with ddd/gdb or other debugger.
17337 \begin_layout Standard
17338 When debugging code with ddd/gdb, it is possible to invoke a text editor
17339 at the current execution position with a single key stroke.
17340 The default ddd configuration for that is shift-ctrl-V.
17341 It happens that you can define the editor command line invocation in ddd
17347 dit\SpecialChar \menuseparator
17352 references\SpecialChar \menuseparator
17359 dialog and changing the "Edit Sources" entry.
17362 \begin_layout Standard
17363 I take advantage of the new created LyX server function and this ddd feature,
17365 \begin_inset Quotes eld
17369 \begin_inset Quotes erd
17375 \begin_layout LyX-Code
17376 echo "LYXCMD:monitor:server-goto-file-row:@FILE@ @LINE@" >~/.lyxpipe.in
17379 \begin_layout Standard
17380 With this, whenever you are using ddd and find a point in the program that
17381 you want to edit, you just press shift-ctrl-V (in the ddd window), and
17382 ddd you forward this information to LyX through the LyX server and then
17383 the LyX window will show the same file with the cursor at the same position
17384 ddd was pointing to.
17385 No more guessing or long scrolling to locate a point in the program back
17389 \begin_layout Standard
17390 Note however that you must enable the LyX server to get this feature working
17391 (it is disabled by default).
17392 You can enable it in
17404 ) by entering in the
17409 \begin_inset Quotes eld
17414 /home/<your-home-directory>/.lyx/lyxpipe
17417 \begin_inset Quotes erd
17423 \begin_layout Standard
17424 Read the LyX server documentation in the
17426 Customization Manual
17428 for further information.
17431 \begin_layout Subsubsection
17435 \begin_layout Standard
17436 There are six new buttons that can be added to your LyX toolbar.
17437 Five of these buttons are short cuts to layout styles:
17458 The last one is a short cut to the
17459 \begin_inset Quotes eld
17463 \begin_inset Quotes erd
17470 \begin_layout Standard
17471 LyX has a range of buttons that are available for tool bar customization.
17472 In my toolbar I like to combine the six short cuts above with two more:
17480 \SpecialChar \menuseparator
17488 \SpecialChar \menuseparator
17501 iew\SpecialChar \menuseparator
17509 Here is how it looks like:
17512 \begin_layout LyX-Code
17516 \begin_layout LyX-Code
17520 \begin_layout LyX-Code
17521 Icon "layout Standard"
17524 \begin_layout LyX-Code
17525 Icon "layout Section"
17528 \begin_layout LyX-Code
17529 Icon "layout LaTeX"
17532 \begin_layout LyX-Code
17533 Icon "layout LyX-Code"
17536 \begin_layout LyX-Code
17537 Icon "layout Scrap"
17540 \begin_layout LyX-Code
17544 \begin_layout LyX-Code
17548 \begin_layout LyX-Code
17549 Icon "buffer-typeset"
17552 \begin_layout LyX-Code
17553 Icon "build-program"
17556 \begin_layout LyX-Code
17560 \begin_layout LyX-Code
17564 \begin_layout LyX-Code
17568 \begin_layout LyX-Code
17572 \begin_layout LyX-Code
17576 \begin_layout Subsubsection
17577 Colors customization
17580 \begin_layout Standard
17581 There are a number of colors in LyX that can be customized in
17586 One of the things that bothers people is the LaTeX font color.
17587 The default color is red, since the scraps uses LaTeX font, and there is
17588 a lot of scraps in literate documents, you may get tired of seeing everything
17590 You can change it by going to the tabs
17599 \begin_layout Standard
17600 The next thing is the visible presence of the newline character in the screen.
17601 You can choose the color of this particular character and make it blend
17603 I recommend you choosing a color that is close to the background but not
17604 equal, that way you still can see it is there, but it is not bothering
17609 \begin_layout Chapter
17610 Secrets of the LaTeX Masters
17611 \begin_inset LatexCommand label
17619 \begin_layout Standard
17620 Though LyX is a powerful tool, it cannot hope to support everything that
17621 can be done with pure TeX/LaTeX.
17622 However, many familiar dirty TeX and LaTeX tricks can be done within LyX,
17623 as long as you are not afraid to use that
17624 \begin_inset Quotes eld
17628 \begin_inset Quotes erd
17631 button on the toolbar or add things to the LaTeX preamble.
17632 This section lists some tips, tricks, and otherwise cool ideas to give
17633 your document that extra little flair.
17636 Do try this at home
17638 , just start with something a little smaller and less important than your
17642 \begin_layout Standard
17643 Most ideas in this section require less common files in your LaTeX installation.
17644 If you have a system like teTeX, most will already be available.
17645 A few, however, will need to be downloaded from one of the CTAN archives.
17646 Often, there are several ways to do something, or several LaTeX style files
17647 which do the same thing.
17648 We do not endorse one choice over another, we simply claim that we have
17649 done a particular task with a particular file.
17650 Put on your wizard hat, keep an eye out for dragons, and let us begin.
17653 \begin_layout Section
17657 \begin_layout Standard
17660 Lars Gullik Bjønnes
17663 \begin_layout Subsection
17667 \begin_layout Standard
17668 The aim for this chapter
17672 \begin_layout Standard
17673 Editor's note: Lars' original chapter was a masterful description of how
17679 However, it was too long to flow smoothly in this document.
17680 I have therefore chosen to excerpt the most important sections here (sorry,
17681 Lars); you can read the original chapter (and more of the story!) in the
17684 examples/multicol.lyx
17692 is to show how the LaTeX package
17696 can be used in a LyX document.
17697 As LyX doesn't support the
17701 package natively yet, we have to use some small hacks.
17702 By reading this section it should be obvious how to do this.
17705 \begin_layout Subsection
17709 \begin_layout Standard
17714 package allows switching between one and multicolumn format on the same
17716 Footnotes are handled correctly (for the most part), but will be placed
17717 at the bottom of the page and not under each column.
17718 LaTeX's float mechanism, however, is partly disabled in the current implementat
17720 At the moment only page-wide floats can be used within the scope of the
17724 \begin_layout Subsection
17728 \begin_layout Subsubsection
17732 \begin_layout Standard
17733 If you want to have two columns in your text, you have use LaTeX mode to
17738 begin{multicols}{2}
17740 at the point where you want the two column layout to start, and then
17746 where you want it to end.
17750 \begin_layout Standard
17754 \begin_layout Standard
17758 begin{multicols}{2}
17766 \begin_layout Standard
17771 The Adventure of the Empty House
17777 Sir Arthur Conan Doyle
17780 \begin_layout Standard
17783 It was in the spring of the year 1894 that all London was interested, and
17784 the fashionable world dismayed, by the murder of the Honourable Ronald
17785 Adair under most unusual and inexplicable circumstances.
17786 The public has already learned those particulars of the crime which came
17787 out in the police investigation, but a good deal was suppressed upon that
17788 occasion, since the case for the prosecution was so overwhelmingly strong
17789 that it was not necessary to bring forward all the facts.
17790 Only now, at the end of nearly ten years, am I allowed to supply those
17791 missing links which make up the whole of that remarkable chain.
17792 The crime was of interest in itself, but that interest was as nothing to
17793 me compared to the inconceivable sequel, which afforded me the greatest
17794 shock and surprise of any event in my adventurous life.
17795 Even now, after this long interval, I find myself thrilling as I think
17796 of it, and feeling once more that sudden flood of joy, amazement, and increduli
17797 ty which utterly submerged my mind.
17798 Let me say to that public, which has shown some interest in those glimpses
17799 which I have occasionally given them of the thoughts and actions of a very
17800 remarkable man, that they are not to blame me if I have not shared my knowledge
17801 with them, for I should have considered it my first duty to do so, had
17802 I not been barred by a positive prohibition from his own lips, which was
17803 only withdrawn upon the third of last month.
17806 \begin_layout Standard
17810 \begin_layout Standard
17822 \begin_layout Subsubsection
17826 \begin_layout Standard
17827 The same pattern is used when you want more than two columns:
17830 \begin_layout Standard
17834 \begin_layout Standard
17838 begin{multicols}{3}
17846 \begin_layout Standard
17849 It can be imagined that my close intimacy with Sherlock Holmes had interested
17850 me deeply in crime, and that after his disappearance I never failed to
17851 read with care the various problems which came before the public.
17852 And I even attempted, more than once, for my own private satisfaction,
17853 to employ his methods in their solution, though with indifferent success.
17854 There was none, however, which appealed to me like this tragedy of Ronald
17856 As I read the evidence at the inquest, which led up to a verdict of willful
17857 murder against some person or persons unknown, I realized more clearly
17858 than I had ever done the loss which the community had sustained by the
17859 death of Sherlock Holmes.
17860 There were points about this strange business which would, I was sure,
17861 have specially appealed to him, and the efforts of the police would have
17862 been supplemented, or more probably anticipated, by the trained observation
17863 and the alert mind of the first criminal agent in Europe.
17864 All day, as I drove upon my round, I turned over the case in my mind and
17865 found no explanation which appeared to me to be adequate.
17866 At the risk of telling a twice-told tale, I will recapitulate the facts
17867 as they were known to the public at the conclusion of the inquest.
17870 \begin_layout Standard
17874 \begin_layout Standard
17886 \begin_layout Standard
17887 You can have more than 3 columns if you want to, but that might not be very
17888 pleasant for the eye.
17891 \begin_layout Subsubsection
17892 Columns inside columns
17895 \begin_layout Standard
17896 You can even have columns inside columns:
17899 \begin_layout Standard
17903 \begin_layout Standard
17907 begin{multicols}{2}
17915 \begin_layout Standard
17918 The Honourable Ronald Adair was the second son of the Earl of Maynooth,
17919 at that time governor of one of the Australian colonies.
17920 Adair's mother had returned from Australia to undergo the operation for
17921 cataract, and she, her son Ronald, and her daughter Hilda were living together
17925 \begin_layout Standard
17929 \begin_layout Standard
17933 begin{multicols}{2}
17941 \begin_layout Standard
17944 The youth moved in the best society--had, so far as was known, no enemies
17945 and no particular vices.
17946 He had been engaged to Miss Edith Woodley, of Carstairs, but the engagement
17947 had been broken off by mutual consent some months before, and there was
17948 no sign that it had left any very profound feeling behind it.
17949 For the rest {sic} the man's life moved in a narrow and conventional circle,
17950 for his habits were quiet and his nature unemotional.
17951 Yet it was upon this easy-going young aristocrat that death came, in most
17952 strange and unexpected form, between the hours of ten and eleven-twenty
17953 on the night of March 30, 1894.
17956 \begin_layout Standard
17960 \begin_layout Standard
17972 \begin_layout Standard
17975 Ronald Adair was fond of cards--playing continually, but never for such
17976 stakes as would hurt him.
17977 He was a member of the Baldwin, the Cavendish, and the Bagatelle card clubs.
17978 It was shown that, after dinner on the day of his death, he had played
17979 a rubber of whist at the latter club.
17980 He had also played there in the afternoon.
17985 The evidence of those who had played with him-- Mr.
17986 Murray, Sir John Hardy, and Colonel Moran--showed that the game was whist,
17987 and that there was a fairly equal fall of the cards.
17988 Adair might have lost five pounds, but not more.
17989 His fortune was a considerable one, and such a loss could not in any way
17991 He had played nearly every day at one club or other, but he was a cautious
17992 player, and usually rose a winner.
17993 It came out in evidence that, in partnership with Colonel Moran, he had
17994 actually won as much as four hundred and twenty pounds in a sitting, some
17995 weeks before, from Godfrey Milner and Lord Balmoral.
17996 So much for his recent history as it came out at the inquest.
17999 \begin_layout Standard
18003 \begin_layout Standard
18015 \begin_layout Standard
18016 Please do read the file
18018 examples/multicol.lyx
18020 for more advanced examples including column and header spacing, vertical
18021 separator lines, and more.
18024 \begin_layout Section
18029 Paragraph Environment
18030 \begin_inset OptArg
18033 \begin_layout Standard
18034 Numbering in Enumerate
18042 \begin_layout Standard
18048 \begin_layout Standard
18049 \begin_inset VSpace bigskip
18055 \begin_layout Standard
18057 The default numbering for the
18061 paragraph environment begins with Arabic numbers and ends with uppercase
18063 Suppose, however, you wanted a different type of numbering scheme.
18064 Here's a quickie example of how to change the numbering scheme:
18067 \begin_layout LyX-Code
18077 \begin_layout LyX-Code
18087 \begin_layout LyX-Code
18097 \begin_layout LyX-Code
18107 \begin_layout Standard
18108 \SpecialChar \ldots{}
18109 which changes the numbering scheme to uppercase Roman numerals, uppercase
18110 letters, Arabic numbers, and lowercase letter.
18113 \begin_layout Standard
18114 Additionally, the previous example also adds a little bit extra to the numbering
18116 For example, the first level label actually looks like:
18117 \begin_inset Quotes eld
18121 \begin_inset Quotes erd
18125 For ease of reading, we'll describe what the numbering schemes look like
18126 using a notation something like this: <
18127 \begin_inset Quotes eld
18131 \begin_inset Quotes erd
18136 \begin_inset Quotes erd
18140 \begin_inset Quotes erd
18145 \begin_inset Quotes erd
18149 \begin_inset Quotes erd
18154 \begin_inset Quotes eld
18158 \begin_inset Quotes erd
18165 \begin_layout Standard
18166 As you can see in the example, there is a label command for each nesting
18173 \SpecialChar \ldots{}
18180 , as well as a counter,
18184 \SpecialChar \ldots{}
18190 There are also five
18191 \begin_inset Quotes eld
18195 \begin_inset Quotes erd
18228 , each of which take one counter as an argument.
18229 You can add characters before or after these, but there's no need to add
18233 \begin_layout Standard
18234 You can get really fancy with these.
18238 \begin_layout LyX-Code
18252 \begin_layout LyX-Code
18264 \begin_layout LyX-Code
18274 \begin_layout LyX-Code
18284 \begin_layout Standard
18285 produces the somewhat out of hand numbering scheme: <
18286 \begin_inset Quotes eld
18290 \begin_inset Quotes erd
18295 \begin_inset Quotes erd
18299 \begin_inset Quotes erd
18304 \begin_inset Quotes erd
18308 \begin_inset Quotes erd
18313 \begin_inset Quotes eld
18317 \begin_inset Quotes erd
18324 \begin_layout Standard
18328 \begin_layout Section
18332 \begin_layout Standard
18338 \begin_layout Standard
18339 \begin_inset VSpace bigskip
18345 \begin_layout Standard
18350 \begin_layout Standard
18356 tmpfont}{cmr17 scaled 2500}{
18368 \begin_layout Standard
18373 \begin_layout Standard
18384 hose of you who like the style of old books probably also like
18385 \begin_inset Quotes eld
18389 \begin_inset Quotes erd
18392 ---those large capital letters which begin each new chapter or section.
18393 Implementing them with plain LyX/LaTeX is straightforward (assuming you
18394 know some plain TeX!) but does require a lot of work and many iterations,
18395 as you can see by all the ugly TeX-mode stuff at the beginning of this
18399 \begin_layout Standard
18403 \begin_layout Standard
18409 bigdrop{-1em}{3}{ptmri}{T}+
18414 here is a much easier way of doing this, of course.
18423 ) package from CTAN allows a simple way to add such letters to your documents.
18424 Since this package is not a standard part of teTeX, I can't demonstrate
18425 it within this document, but if you copy this paragraph to a new document,
18427 \begin_inset Quotes eld
18437 \begin_inset Quotes erd
18440 and the pluses from the TeX code at the beginning of the paragraph, and
18445 usepackage{dropcaps}
18447 to your LaTeX preamble, you will get a nice Times Roman Italic
18448 \begin_inset Quotes eld
18452 \begin_inset Quotes erd
18455 , whose height is three lines of text and which protrudes 1 em into the
18457 (Make certain you have copied
18458 \begin_inset Quotes eld
18466 \begin_inset Quotes erd
18469 into a directory where TeX can see it.) The first argument is the amount
18470 of indentation; in this case the negative sign moves it into the margin.
18471 The second argument is the height of the letter in number of lines of text.
18472 The third argument is the font name: virtually anything which has a tfm
18473 file should work (wade through the
18475 .../texmf/fonts/tfm
18477 directory for possibilities).
18478 My personal favorite is
18479 \begin_inset Quotes eld
18487 \begin_inset Quotes erd
18490 , a fancy German font specifically designed for dropped capitals.
18491 The fourth argument is the letter (or letters) to be dropped.
18496 package also offers the
18502 command, as well as a slightly simplified
18511 \begin_layout Section
18512 Non-standard Paragraph Shapes
18515 \begin_layout Standard
18521 \begin_layout Standard
18522 \begin_inset VSpace bigskip
18528 \begin_layout Standard
18532 \begin_layout Standard
18544 \begin_layout Standard
18548 \begin_layout Standard
18557 \begin_layout Standard
18571 \begin_layout Standard
18576 \begin_layout Standard
18587 \begin_layout Standard
18596 \begin_layout Standard
18605 \begin_layout Standard
18614 \begin_layout Standard
18623 \begin_layout Standard
18632 \begin_layout Standard
18641 \begin_layout Standard
18650 \begin_layout Standard
18659 \begin_layout Standard
18668 \begin_layout Standard
18677 \begin_layout Standard
18686 \begin_layout Standard
18695 \begin_layout Standard
18704 \begin_layout Standard
18713 \begin_layout Standard
18722 \begin_layout Standard
18731 \begin_layout Standard
18740 \begin_layout Standard
18749 \begin_layout Standard
18755 There are times when the tyranny of rectangular paragraphs must be overthrown.
18756 In such situations, a call to the delightful plain TeX command
18763 As you can see, completely arbitrary shapes can be laid out with a suitable
18764 set of linelength definitions.
18765 While this parshape may look a bit silly and useless, one could conceive
18766 of situations such as finely tuned dropped capitals, word wrapping around
18767 non-rectangular graphics, etc.
18768 which will benefit from such handcrafting.
18771 \begin_layout Standard
18772 \begin_inset VSpace bigskip
18778 \begin_layout Standard
18783 parshape numlines #1indent #1length #2indent #2length \SpecialChar \ldots{}
18790 is the number of lines of text which define the paragraph.
18791 If there turn out to be fewer lines, the shape is truncated; if there are
18792 more, the excess lines have the same dimensions as the last line of the
18802 entries specify the indentation of the line from the left margin, and the
18803 length of the line as measured from that point.
18804 The shape applies only to the current paragraph; everything is reset to
18805 normal for the next paragraph.
18808 \begin_layout Standard
18812 \begin_layout Standard
18824 \begin_layout Section
18828 \begin_layout Standard
18829 As you can see, the examples in this section range from the useful to the
18831 While I don't expect that anyone will ever need the paragraph shape demonstrate
18832 d in the last section, the important point is that you can do almost anything
18833 you want in LyX if you are willing to figure out how to do it in TeX and
18835 TeX is a fantastically powerful typesetting system and all that power is
18836 available to you since LyX uses it as its backend.