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
471 \begin_inset LatexCommand label
472 name "sec:Translating-LaTeX-files"
479 \begin_layout Standard
480 You can import a LaTeX file into LyX by using the
485 ile\SpecialChar \menuseparator
490 mport\SpecialChar \menuseparator
498 This will call a program named
502 ---which will create a file
510 ---and then open that file.
513 \begin_layout Standard
518 will translate most legal LaTeX, but not everything.
519 It will leave things it doesn't understand in TeX mode, so after translating
524 , you can look for red text and hand-edit it to look right.
527 \begin_layout Standard
528 If you just want to put a piece of LaTeX code into a LyX file, see Section\InsetSpace ~
530 \begin_inset LatexCommand ref
531 reference "sec:latexcodes"
538 \begin_layout Section
539 Inserting LaTeX Code into LyX Documents
540 \begin_inset LatexCommand label
541 name "sec:Inserting-LaTeX-Code"
548 \begin_layout Standard
549 \begin_inset LatexCommand label
550 name "sec:latexcodes"
554 This is a rather important point: You can always insert LaTeX code into
556 LyX simply cannot, and will probably never be able to, display every possible
558 If ever you need to insert LaTeX commands into your LyX document, you can
559 use the ERT box, which you can insert into your document with
564 nsert\SpecialChar \menuseparator
572 The ERT box comes in three forms: collapsed, open, and inlined.
573 The first two are used just like any other collapsible (foldable) box (such
574 as footnotes), and are useful for significant amounts of LaTeX commands.
576 \begin_inset Quotes eld
580 \begin_inset Quotes erd
583 ERT box displays its content as part of the button, and is useful for very
584 short sections of LaTeX commands.
589 \begin_layout Standard
599 \begin_layout Standard
600 You can switch between all three by right-clicking on the ERT.
601 Note that if you want more than one line of LaTeX commands, you cannot
602 use the inlined mode.
605 \begin_layout Standard
606 Here's an example of inserting LaTeX commands in a LyX document.
607 The code looks like this:
610 \begin_layout LyX-Code
619 This is an example for a minipage environment.
622 can put nearly everything in it, even (non-floating)
665 \begin_layout LyX-Code
669 \begin_layout Standard
670 The ERT box containing this text is directly after this paragraph.
671 Those of you reading the manual online will only see a bunch of funky text
673 Those reading a printed version of the manuals will see the actual results:
676 \begin_layout Standard
680 \begin_layout Standard
687 \begin_layout Standard
694 \begin_layout Standard
696 This is an example for a minipage environment.
697 You can put nearly everything in it, even (non-floating) figures and tables.
701 \begin_layout Standard
708 \begin_layout Standard
713 \begin_layout Standard
720 \begin_layout Standard
727 \begin_layout Standard
734 \begin_layout Standard
740 \begin_layout Standard
747 \begin_layout Standard
754 \begin_layout Standard
761 \begin_layout Standard
773 \begin_layout Standard
774 In addition to these two methods, you can also create a separate file containing
775 some complex LaTeX structure.
781 nsert\SpecialChar \menuseparator
789 to include your file (you should select the type
794 We recommend that you only do this if you have a
803 Otherwise, you'll have a big job tracking down LaTeX errors\SpecialChar \ldots{}
807 \begin_layout Standard
808 There are a few last notes to emphasize:
811 \begin_layout Itemize
812 Inside of LyX, LaTeX code appears
817 \begin_layout Itemize
822 check if your LaTeX code is correct.
825 \begin_layout Itemize
826 Beware reinventing the wheel.
829 \begin_layout Standard
830 That last note refers to two things.
831 First, LyX does have quite a few features tucked into it, and more are
833 Be sure to check the manuals to make sure that LyX doesn't have such-and-such
834 feature before you go off merrily coding LaTeX.
835 Second, there are numerous LaTeX packages out there to do all sorts of
836 things, from labels to envelopes to fancy multipage tables.
837 Check out a CTAN site for details (see Section
838 \begin_inset Quotes eld
842 \begin_inset Quotes erd
853 \begin_layout Standard
858 : I seem to do this an awful lot.
859 Sat down and merrily began coding something to print out labels, only to
860 learn that there were already 2 different LaTeX packages to do this.
861 Worse yet --- I had them already!
869 \begin_layout Standard
870 If you do need to do some wild and fancy things within your document, be
871 sure to check out a good LaTeX book for assistance.
872 There are a number of them listed in the bibliography of the
879 \begin_layout Standard
880 There are a number of LaTeX commands which have to be placed before the
881 beginning of the actual text.
882 They go into the preamble, and this is explained in the next section.
885 \begin_layout Section
886 LyX and the LaTeX Preamble
889 \begin_layout Subsection
890 About the LaTeX Preamble
893 \begin_layout Standard
894 \begin_inset LatexCommand label
899 If you already know LaTeX, there is no need to explain here what the preamble
901 If you don't, the following will give you some ideas --- we recommend again
902 that you consult a LaTeX book for further information.
903 In any case, you should read the points below, because they explain what
904 you can do and what you don't need to do in the LaTeX preamble of a LyX
908 \begin_layout Standard
909 The LaTeX preamble comes at the very beginning of a document,
917 \begin_layout Itemize
918 declare the document class.
919 LyX already does this for you.
923 \begin_layout Standard
924 If you're a seasoned LaTeX-nician, and you have some custom document class
925 you want to use, check out the
929 for information on how to make LyX interface to it.
930 Be sure to submit your efforts to the LyX Team for inclusion in future
935 \begin_layout Itemize
936 declare the usage of packages.
937 LaTeX packages provide special commands, which are only available within
938 a document when the package has been declared in the preamble.
939 For example, the package
943 forces all paragraphs to be indented.
944 There are other packages for labels, envelopes, margins, etc.
948 \begin_layout Itemize
949 set counters, variables, lengths and widths.
950 There are several LaTeX counters and variables which
954 be set globally from within the preamble in order to have the desired effect.
955 [There are other variables which you can set and reset inside the document,
956 too.] Margins are a good example of something which must be set in the preamble.
957 Another example is the label format for lists.
958 You can actually set these just about anywhere, but it's best to do it
959 just once, inside the preamble.
962 \begin_layout Itemize
963 declare user defined commands [with
975 ], mostly abbreviations for LaTeX commands which appear very often inside
977 Although the preamble is a good place to declare such commands, they
981 be declared anywhere else [but
985 they are used for the first time, of course\SpecialChar \ldots{}
987 This can be useful if there is a lot of raw LaTeX code in your document,
988 which normally should not be the case.
991 \begin_layout Standard
992 LyX adds its own set of definitions to the preamble of the
997 This makes LaTeX files generated by LyX portable.
1000 \begin_layout Subsection
1001 Changing the Preamble
1004 \begin_layout Standard
1005 The commands which LyX adds to the preamble of a LaTeX file are fixed; you
1006 can't change them without patching LyX itself.
1007 You can, however, add your own stuff to the preamble.
1008 There are two ways to do this:
1011 \begin_layout Enumerate
1038 \SpecialChar \menuseparator
1046 dialog, depending on your frontend.
1047 Note that the LyX keybindings will not work in this dialog, alas.
1050 \begin_layout Enumerate
1051 Use the preamble contents you've added as your default template (see
1052 \begin_inset Quotes eld
1056 \begin_inset Quotes erd
1063 ), so that it will be the default preamble for any file you create.
1066 \begin_layout Standard
1067 LyX adds anything in the
1074 dialog to its own built-in preamble.
1075 Before adding your own declarations in the preamble, you should make sure
1076 that LyX doesn't already support what you want to do (remember what we
1077 said about reinventing the wheel?).
1080 make sure your preamble code is correct
1083 LyX doesn't check it.
1086 \begin_layout Subsection
1090 \begin_layout Standard
1091 Here are some examples of what you can add to a preamble, and what they
1095 \begin_layout Subsubsection
1099 \begin_layout Standard
1100 There are two variables under LaTeX that control page position:
1113 Their names should be self-explanatory.
1114 These variables are useful if you think for a moment about computer labels.
1115 Sometimes, the size of a print medium and the area of the medium that you
1116 can actually print on aren't the same.
1132 \begin_layout Standard
1133 The default values for
1145 are both 0 pt.,\InsetSpace ~
1148 the page isn't shifted.
1151 \begin_layout Standard
1152 Unfortunately, some DVI drivers always seem to shift the page.
1153 We have no idea why, or why the sysadmin hasn't fixed such behavior.
1154 If you're using LyX on a system that you don't personally maintain, and
1155 your sysadmin is a doofus,
1168 Suppose you're left and top margins are always 0.5 inches too big.
1169 You can add this to the preamble:
1172 \begin_layout LyX-Code
1180 \begin_layout LyX-Code
1188 \begin_layout Standard
1189 \SpecialChar \ldots{}
1190 and your margins should now be correct.
1193 \begin_layout Subsubsection
1197 \begin_layout Standard
1198 Speaking of labels, suppose you wanted to print out a bunch of address labels.
1199 There's a rather nice package, available at your nearest CTAN archive,
1200 for printing sheets of labels, called
1205 Now, your system may not have this package installed by default.
1206 We leave that up to you to check.
1207 You'll also want to read the documentation for it; we're not going to do
1209 Since this is an example, however, we'll give you an example of how you
1213 \begin_layout Standard
1214 First, make sure you're using the
1219 Next, you need to put the following in your preamble:
1222 \begin_layout LyX-Code
1228 \begin_layout LyX-Code
1234 \begin_layout LyX-Code
1240 \begin_layout LyX-Code
1246 \begin_layout LyX-Code
1252 \begin_layout LyX-Code
1258 \begin_layout LyX-Code
1264 \begin_layout Standard
1265 This sets things up for Avery® label sheets, stock #5360.
1266 You're now ready to print labels, but you'll need to insert LaTeX code,
1267 placing the commands
1279 around each label text.
1280 This and other special features of
1284 are explained in its documentation.
1287 \begin_layout Standard
1288 Someday, someone may write a LyX layout file to support this package directly.
1289 Maybe that someone is you.
1292 \begin_layout Subsubsection
1293 Example #3: Paragraph Indentation
1296 \begin_layout Standard
1297 Americans are trained to indent the first line of
1302 As with all of their other weird quirks, most Americans will whine and
1303 moan until they can have their way and indent the first line of all paragraphs.
1307 \begin_layout Standard
1312 : This was written by an American ---
1316 ! It's my perception of my fellow countrymen.
1317 Tough if you don't like it.
1326 \begin_layout Standard
1327 Of course, this behavior isn't standard typography.
1328 In books, you typically only indent the first line of a paragraph
1332 it follows another one.
1333 The idea behind indenting the first line of a paragraph is to distinguish
1334 neighboring paragraphs from one another.
1335 If there is no previous paragraph, for example, it follows a figure, or
1336 is the first paragraph in a section, then there is no special indentation.
1340 \begin_layout Standard
1341 If you're a typical American, though, you don't care about such esoteric
1342 things; you want your indentation! Add this to the preamble:
1345 \begin_layout LyX-Code
1348 usepackage{indentfirst}
1351 \begin_layout Standard
1352 If your TeX distribution isn't a braindead one, you'll have this package,
1353 and all of your paragraphs will get the indentation you think they deserve.
1356 \begin_layout Subsubsection
1357 Example #4: This Document
1360 \begin_layout Standard
1361 You can also check out the preamble of this document to get an idea of some
1362 of the advanced things you can do.
1363 You'll probably need to make the
1368 reamble\SpecialChar \ldots{}
1371 dialog full-screen to see most of it.
1372 Also, there are more examples and an assortment of LaTeX
1373 \begin_inset Quotes eld
1377 \begin_inset Quotes erd
1380 given in Chapter\InsetSpace ~
1382 \begin_inset LatexCommand ref
1383 reference "cha:secrets"
1391 \begin_layout Section
1392 LyX and LaTeX Errors
1395 \begin_layout Standard
1396 When LyX calls LaTeX, it tells LaTeX to blithely ignore any errors and keep
1398 It then uses the log-file from the LaTeX run to do a post-mortem.
1399 As we stated earlier in the chapter, LyX generates two kinds of
1403 files, one of which it uses to locate errors in the document.
1404 If there was an error someplace, LyX will put a box with the word
1405 \begin_inset Quotes eld
1409 \begin_inset Quotes erd
1412 at the appropriate place in the document.
1416 \begin_layout Standard
1417 LyX will occasionally misguess where the error was.
1418 This will typically happen with tables, figures, math, and the preamble.
1423 It will also display a message alerting you to the fact that there were
1427 \begin_layout Standard
1428 You can navigate through the errors by using
1444 \begin_inset Quotes eld
1448 \begin_inset Quotes erd
1451 the error-boxes and view the error message LaTeX produced by clicking on
1455 \begin_layout Standard
1456 Some folks also like to look at the log file directly, accessible from
1461 ocument\SpecialChar \menuseparator
1471 There are some fairly common error messages and warnings.
1472 We'll cover those here.
1473 You should look at a good LaTeX book for a complete listing.
1476 \begin_layout Itemize
1477 \begin_inset Quotes eld
1485 \begin_inset Quotes eld
1492 \begin_layout Standard
1493 Anything beginning with these word is a warning message for the purpose
1495 \begin_inset Quotes eld
1499 \begin_inset Quotes erd
1502 the LaTeX code itself.
1503 You'll get messages like this if you added or changed cross-references
1504 or bibliography entries, in which case, LaTeX is trying to tell you that
1505 you need to make another run.
1508 \begin_layout Standard
1509 You can by-and-large ignore these.
1513 \begin_layout Itemize
1514 \begin_inset Quotes eld
1522 \begin_inset Quotes erd
1529 \begin_layout Standard
1530 Another warning message, this time about fonts which LaTeX couldn't find.
1531 The rest of the message will often say something about a replacement font
1535 \begin_layout Standard
1536 You can safely ignore these.
1540 \begin_layout Itemize
1541 \begin_inset Quotes eld
1551 \begin_inset Quotes erd
1558 \begin_layout Standard
1564 They are warning you about lines that were too long and run past the right
1566 Almost always, this is unnoticeable in the final output.
1567 Or, only one or two characters extend past the margin.
1568 LaTeX seems to generate at least one of these messages for just about any
1572 \begin_layout Standard
1573 You can ignore these stupid messages.
1574 Your eyes will tell you if there's a problem with something that's too
1575 wide; just look at the output.
1579 \begin_layout Itemize
1580 \begin_inset Quotes eld
1590 \begin_inset Quotes erd
1597 \begin_layout Standard
1598 Not quite as common as its cousin.
1599 LaTeX seems to like to print lines that are a bit too wide as opposed to
1600 ones that are a bit too narrow.
1601 We have no idea why.
1604 \begin_layout Standard
1605 You can ignore these, too.
1609 \begin_layout Itemize
1610 \begin_inset Quotes eld
1620 \begin_inset Quotes erd
1624 \begin_inset Quotes eld
1634 \begin_inset Quotes erd
1641 \begin_layout Standard
1642 Warnings about troubles breaking the page.
1643 Once again, just look at the output.
1644 Your eyes will tell you where something has gone wrong.
1648 \begin_layout Itemize
1649 \begin_inset Quotes eld
1655 \begin_inset Quotes els
1659 \begin_inset Quotes ers
1665 \begin_inset Quotes erd
1672 \begin_layout Standard
1674 \begin_inset Quotes eld
1678 \begin_inset Quotes erd
1681 isn't installed on this system.
1682 This usually appears because some package your document needs isn't installed.
1683 If you didn't touch the preamble or didn't use the
1689 command, then one of the packages LyX tried to load is missing.
1695 elp\SpecialChar \menuseparator
1702 , to get a list of packages that LyX knows about.
1703 This file is updated whenever you reconfigure LyX (using
1710 \SpecialChar \menuseparator
1715 ) and tells you which packages have been detected and what they do.
1718 \begin_layout Standard
1729 command, and the package in question isn't installed, you'll need to install
1734 \begin_layout Itemize
1735 \begin_inset Quotes eld
1740 LaTeX Error: Unknown option
1743 \begin_inset Quotes erd
1750 \begin_layout Standard
1751 Error messages beginning with this are trying to tell you that you specified
1752 a bad or undefined option to a package.
1753 Check the package's documentation.
1757 \begin_layout Itemize
1758 \begin_inset Quotes eld
1763 Undefined control sequence
1766 \begin_inset Quotes erd
1773 \begin_layout Standard
1774 If you've inserted LaTeX code into your document, but made a typo, you'll
1776 You may have forgotten to load a package.
1777 In any case, this error message usually means that you used an undefined
1782 \begin_layout Standard
1783 There are other error and warning messages.
1784 Some are self-explanatory.
1785 These are usually LaTeX messages.
1786 Others are downright cryptic.
1787 These are actually TeX error messages, and we really have
1791 what they mean or how to decipher them.
1794 \begin_layout Standard
1795 There's a general sequence you should follow if you get error messages:
1798 \begin_layout Enumerate
1799 Look at the LaTeX code you inserted for typos.
1802 \begin_layout Enumerate
1803 If there are no typos, check and see that you used the command(s) correctly.
1806 \begin_layout Enumerate
1807 If you get a bunch of error boxes piled up at the very top of the document,
1808 it means that there are errors in the preamble.
1809 Start debugging your preamble.
1812 \begin_layout Enumerate
1813 If you didn't add anything to the preamble and didn't add any LaTeX code
1814 to the document, the first suspect is your LaTeX distribution itself.
1815 Check for missing packages and install them.
1818 \begin_layout Enumerate
1819 Okay, so there are no missing packages.
1820 Did you use any of the fine-tuning options in LyX? Specifically, did you
1825 any of them, like trying to manually insert lots of
1827 Protected\InsetSpace ~
1838 s? Did you try to kludge something together with these instead of using
1839 the appropriate paragraph environment?
1842 \begin_layout Enumerate
1843 All right, you didn't use any of the fine-tuning options, you played by
1845 Did you try to pull a fancy maneuver? Did you do something funky inside
1846 a table or an equation, like inserting a graphic into a table cell?
1849 \begin_layout Enumerate
1850 Do you have long sections of text where LaTeX cannot find a place to break
1851 a line? By default, LaTeX is rather strict about how much extra inter-word
1852 spacing it will add in order to break a line.
1853 Preferably, you should rework the paragraph to avoid the problem.
1854 If this isn't an option, you can wrap your text in
1860 to make LaTeX's line breaking more, well, sloppy.
1863 \begin_layout Enumerate
1864 Did you go overboard with the nesting? LyX (currently) doesn't check to
1865 make sure you're in the limits for nesting environments.
1866 If you nested a bunch of environments to the
1867 \begin_inset Formula $17^{\mathrm{th}}$
1870 level, that's the problem.
1873 \begin_layout Enumerate
1874 Okay, you didn't get any error messages, but your output looks whacked.
1875 If you have a table or figure that's too wide or long for the page, you
1880 \begin_layout Enumerate
1881 rescale the figure so it fits.
1884 \begin_layout Enumerate
1885 trim down the table so it fits.
1888 \begin_layout Standard
1889 If something else is wrong with the output, and you didn't try to pull anything
1890 fancy or kludge the fine-tuning options, we're not sure what's wrong.
1894 \begin_layout Standard
1895 If all this doesn't help --- well, then
1899 you might have found a bug in LyX\SpecialChar \ldots{}
1903 \begin_layout Chapter
1907 \begin_layout Section
1908 Preparing a Bibliography with BibTeX
1909 \begin_inset LatexCommand label
1910 name "sec:Preparing-a-Bibliography"
1917 \begin_layout Standard
1924 Jürgen Spitzmüller
1927 \begin_layout Standard
1928 \begin_inset VSpace bigskip
1934 \begin_layout Standard
1936 STOP! If you don't know what BibTeX is, or have a reasonably good idea of
1939 e.\InsetSpace \thinspace{}
1943 setting up your own bibliographic databases),
1947 , do not walk, to your nearest copy of the 2nd edition of Lamport's
1949 LaTeX: A Document Preparation System
1951 , particularly Appendix B.
1952 The rest of this discussion assumes you have created a correct bibliography
1953 file, that you have all relevant environment variables set correctly (esp.
1966 ), and that if sufficiently desperate, you could create and
1967 \begin_inset Quotes eld
1971 \begin_inset Quotes erd
1974 a LaTeX file with a BibTeX database.
1978 \begin_layout Standard
1979 For those who don't know what BibTeX is, it is a system for creating a large
1980 database of your most used journal references.
1981 For all future articles you write, you only need to include this standard
1982 database and reference the appropriate key to each reference.
1983 Even if you write only a few papers with handful of references each, it
1984 is well worth your time to examine BibTeX and decide whether it will be
1988 \begin_layout Standard
1989 To use BibTeX with LyX, first read the
1993 where it describes how to insert citations.
1994 The basic mechanism for inserting BibTeX references is the same.
1995 Then, at the very end of your document, select
1997 Insert\SpecialChar \menuseparator
2002 TOC\SpecialChar \menuseparator
2006 In the resulting dialog, fill out the dialog boxes as follows:
2009 \begin_layout Description
2010 Database: enter the name of your
2023 For searching multiple
2027 files, just enter them in the desired order, separated by commas.
2031 \begin_layout Description
2032 Style: enter the name of your BibTeX style file *without* the
2037 The default style is
2041 (which should be included in your LaTeX distribution, so you don't have
2042 to worry about creating it).
2045 \begin_layout Standard
2046 For each citation, assuming that the source is in the
2055 nsert\SpecialChar \menuseparator
2062 at the correct location in the text, and enter the appropriate reference
2064 Nothing else is required; when invoking
2069 iew\SpecialChar \menuseparator
2076 , for example, you should see that BibTeX and LaTeX are invoked as needed,
2077 including multiple invocations of LaTeX.
2081 \begin_layout Subsection
2082 Alternative Citation Styles
2085 \begin_layout Standard
2086 Standard BibTeX uses numbers (e.\InsetSpace \thinspace{}
2087 g.\InsetSpace \space{}
2089 \begin_inset Quotes eld
2093 \begin_inset Quotes erd
2096 ) to refer to a cited work.
2097 However, in many scientific disciplines, other citation styles are in use.
2098 The most common one is the author-year style (e.\InsetSpace \thinspace{}
2099 g.\InsetSpace \space{}
2101 \begin_inset Quotes eld
2105 \begin_inset Quotes erd
2109 LyX supports two packages that provide this style,
2118 Both packages have their own pros and cons, which cannot be listed in detail.
2119 If you only want to have simple author-year (or author-numerical) style
2120 or if you want to use one of the countless style files for natbib, than
2125 package is probably your choice.
2126 If you need special features like short title references, ibidem etc., you
2127 might consider the fairly new
2134 \begin_layout Standard
2135 The handling of both packages in LyX is basically the same.
2141 ocument\SpecialChar \menuseparator
2152 pane (with the xforms frontend: the
2166 With both packages, you will get some extra features in the citation dialog
2167 and you can select the style of the reference (
2168 \begin_inset Quotes eld
2172 \begin_inset Quotes erd
2176 \begin_inset Quotes eld
2180 \begin_inset Quotes erd
2184 \begin_inset Quotes eld
2188 \begin_inset Quotes erd
2192 \begin_inset Quotes eld
2196 \begin_inset Quotes erd
2200 Note that both packages need specifically designed style files (they both
2201 ship their own, while there are lots of additional style files and even
2202 an interactive style file builder
2206 \begin_layout Standard
2208 \begin_inset LatexCommand url
2209 target "ftp://ctan.tug.org/tex-archive/macros/latex/contrib/custom-bib/"
2225 \begin_layout Subsection
2226 Sectionated Bibliographies
2227 \begin_inset LatexCommand label
2228 name "sub:Sectionated-Bibliographies"
2235 \begin_layout Standard
2236 Sometimes you might need to divide your bibliography into several sections.
2237 If you are, for instance, a historian, the possibility to separate sources
2238 and scientific works is most likely a
2239 \begin_inset Quotes eld
2243 \begin_inset Quotes erd
2247 Unfortunately, BibTeX itself does not allow you to do this.
2248 The good news is, though: With the help of some LaTeX packages, BibTeX
2249 can be extended to fit your historical needs.
2252 \begin_layout Standard
2253 As of version 1.4, LyX provides native support for one of these packages,
2262 \begin_layout Standard
2264 \begin_inset LatexCommand url
2265 target "ftp://ctan.tug.org/tex-archive/macros/latex/contrib/bibtopic/"
2274 The advantage of this package (compared to other packages like
2278 ) is that you don't need to define new citation commands.
2279 Instead, you need to prepare different bibliographic databases which include
2280 the entries for the different sections of the bibliography.
2281 For example: If you want to divide your bibliography into the sections
2283 \begin_inset Quotes eld
2287 \begin_inset Quotes erd
2291 \begin_inset Quotes eld
2295 \begin_inset Quotes erd
2298 , you first need to create two bibliographic databases, e.\InsetSpace \thinspace{}
2299 g.\InsetSpace \space{}
2312 \begin_layout Standard
2318 ocument\SpecialChar \menuseparator
2329 pane (with the xforms frontend: the
2336 Sectionated\InsetSpace ~
2340 Now you can insert multiple BibTeX references (as described in section\InsetSpace ~
2342 \begin_inset LatexCommand ref
2343 reference "sec:Preparing-a-Bibliography"
2347 ), one for each section of your bibliography.
2348 Returning to our example: Insert a BibTeX reference for the database
2352 and a second one for the database
2357 You are free to use the same or different styles for each section.
2358 Additionally, you can chose if the bibliography section should contain
2360 \begin_inset Quotes eld
2363 all cited references
2364 \begin_inset Quotes erd
2367 of the specified database(s) (which is the default),
2368 \begin_inset Quotes eld
2371 all uncited references
2372 \begin_inset Quotes erd
2376 \begin_inset Quotes eld
2380 \begin_inset Quotes erd
2384 This might be useful if you would like to separate your bibliography into
2386 \begin_inset Quotes eld
2390 \begin_inset Quotes erd
2394 \begin_inset Quotes eld
2398 \begin_inset Quotes erd
2402 \begin_inset Quotes eld
2406 \begin_inset Quotes erd
2410 The titles for the sections can be added as ordinary sections or subsections.
2415 removes the bibliography title, you have manually re-add that, too (as
2416 a chapter* or section*, for instance).
2419 \begin_layout Subsection
2420 Multiple Bibliographies
2423 \begin_layout Standard
2424 Multiple bibliographies, e.\InsetSpace \thinspace{}
2425 g.\InsetSpace \space{}
2426 a bibliography for each section or chapter of
2427 the document, are not supported by BibTeX itself.
2432 package, which is used for the creation of sectionated bibliographies in
2433 LyX (cf.\InsetSpace ~
2434 section\InsetSpace ~
2436 \begin_inset LatexCommand ref
2437 reference "sub:Sectionated-Bibliographies"
2441 ), provides an easy way to solve this task, if you are willing to use some
2442 LaTeX-Code (ERT, cf.\InsetSpace ~
2443 section\InsetSpace ~
2445 \begin_inset LatexCommand ref
2446 reference "sec:Inserting-LaTeX-Code"
2454 \begin_layout Standard
2455 An alternative approach is to use the
2463 package, respectively.
2471 \begin_layout Standard
2477 ocument\SpecialChar \menuseparator
2488 pane (with the xforms frontend: the
2495 Sectionated\InsetSpace ~
2499 In the document, you have to enclose the sections, which shall contain
2500 their own bibliography (including the BibTeX reference itself), between
2513 (those commands have to be inserted as ERT).
2514 The bibliography will contain all references which have been cited in the
2516 N.\InsetSpace \thinspace{}
2517 B.: If you are using this approach, then
2521 citation reference has to be inside some btUnit.
2522 Also, the btUnits cannot be nested.
2525 \begin_layout Section
2529 \begin_layout Standard
2530 A good index is one of the hardest things to make in a lengthy document,
2531 but LyX helps make things a bit simpler by interfacing to the
2535 program which is found in most recent LaTeX distributions.
2539 \begin_layout Standard
2559 Outputs\SpecialChar \menuseparator
2560 LaT\SpecialChar \textcompwordmark{}
2569 section of the preferences dialog, however, you can customize the index
2570 command, if you prefer an alternative program like
2593 Inserting an index and marking words to include in it works much the same
2594 way as preparing a bibliography as mentioned in the last section.
2597 \begin_layout Standard
2598 First, go to the end of your file and select
2603 nsert\SpecialChar \menuseparator
2614 C\SpecialChar \menuseparator
2627 Then, for each word you would like to include in the index, go to the end
2628 of that word and click on
2633 nsert\SpecialChar \menuseparator
2646 This will insert a tag showing the word as it will appear in the index.
2647 That's all there is to it; LyX will automatically call
2651 for you and create the index itself.
2652 The text in the dialog available from right-clicking on the index button
2653 accepts LaTeX, so you'll need to be careful to avoid using any special
2655 On the positive side, you can use the advanced options - have a look at
2656 the documentation which comes with your LaTeX distribution to find out
2657 how to do things like
2658 \begin_inset Quotes eld
2662 \begin_inset Quotes erd
2668 \begin_layout Standard
2669 Be careful not to put spaces between the word in the text and the index
2670 marker; apparently the wrong page number can be produced if this happens.
2673 \begin_layout Section
2677 \begin_layout Subsection
2681 \begin_layout Standard
2682 When you are working on a large file with many sections, it is often convenient
2683 to break up the document into several files, or perhaps you have something
2684 where a table may change from time to time, but the preceding text does
2686 In these cases, you should seriously consider using multipart documents.
2687 For example, scientific papers often have five major sections: the introduction
2688 , observations, results, discussion, and conclusion.
2689 Each of these could be its own separate LyX file, with one
2690 \begin_inset Quotes eld
2694 \begin_inset Quotes erd
2697 file which contains the title, authors, abstract, references, etc., plus
2698 the five included files.
2699 It is important to note that each of these files is a full LyX file which
2700 can be formatted and printed on its own, as well as included in a master
2702 Each of these files must have the same document class, however--- don't
2703 attempt to mix book classes with article classes.
2704 You may also include LaTeX files; however, these files must not have their
2710 everything up to and including the
2722 line must be deleted) or else errors will be generated when you try to
2726 \begin_layout Standard
2727 LyX allows you to include files quite easily with
2732 nsert\SpecialChar \menuseparator
2741 When you click on this selection a small box is inserted into the file
2742 at the current cursor location.
2743 Clicking on the box raises a dialog which allows you to select the file
2744 to be included, and the method of its inclusion.
2748 \begin_layout Standard
2749 The file selection box should by now be obvious.
2750 The three inclusion methods are
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 difference between
2776 \begin_inset Quotes eld
2780 \begin_inset Quotes erd
2784 \begin_inset Quotes eld
2788 \begin_inset Quotes erd
2791 is really only meaningful to LaTeXperts, but the practical difference is
2792 that files which are
2793 \begin_inset Quotes eld
2797 \begin_inset Quotes erd
2800 are typeset beginning on a new page, while files which are
2801 \begin_inset Quotes eld
2805 \begin_inset Quotes erd
2808 are typeset starting on the current page.
2809 Perhaps the labeling in LyX will be changed someday to reflect this.
2812 \begin_layout Standard
2813 Generally, the master file is converted into a full LaTeX file before typesettin
2814 g, while the included files are converted to LaTeX files which do not have
2815 all the preamble information.
2825 button prevents this conversion.
2828 \begin_layout Standard
2830 \begin_inset Quotes eld
2834 \begin_inset Quotes erd
2837 included file allows you to include a file typeset exactly as it appears
2838 in the file, i.e.\InsetSpace ~
2839 verbatim mode, with the characters set in a fixed-width
2841 Normally, spaces in this file are invisible, though two consecutive spaces
2842 are conserved, unlike LyX's normal treatment of spaces.
2843 However, setting the
2853 checkbox typesets a mark to unambiguously define the presence of a space.
2857 \begin_layout Subsection
2858 Cross-References Between Files
2861 \begin_layout Standard
2862 It is possible to set up cross-references between the different files.
2863 First, open all the files in question: let's call them A and B in a two
2864 file example, where B is included in A.
2865 Let's say you insert a label in A, then want to reference it in B.
2866 Open the cross-reference dialog in whilst in document B, and you can select
2868 \begin_inset Quotes eld
2872 \begin_inset Quotes erd
2878 \begin_layout Section
2879 Fancy Headers and Footers
2882 \begin_layout Standard
2883 The default page layout is rather plain; for an article document class,
2884 all you get is a centered page number at the bottom of the page.
2885 This document is the book class, so it appears to be a bit fancier, but
2886 to really put on a show, you need to set the document page style to
2887 \begin_inset Quotes eld
2891 \begin_inset Quotes erd
2894 , as mentioned in the
2900 This section describes the LaTeX codes you need to insert in your LaTeX
2901 preamble or the text in order to get the desired effects.
2904 \begin_layout Standard
2905 The page header is divided into three fields, not surprisingly labeled
2906 \begin_inset Quotes eld
2910 \begin_inset Quotes erd
2914 \begin_inset Quotes eld
2918 \begin_inset Quotes erd
2922 \begin_inset Quotes eld
2926 \begin_inset Quotes erd
2930 The footer is also divided into these three fields.
2931 The LaTeX commands to set these fields in the simplest manner are
2956 Suppose you wish to put your name in the upper left hand corner of each
2958 Simply insert the following command in the preamble:
2961 \begin_layout Standard
2970 \begin_layout Standard
2971 You will now see your name in the upper left.
2972 If a field has a default entry that you would like to get rid of (often
2973 the page number appears in the central footer, simply include a command
2974 with a blank argument, e.\InsetSpace \thinspace{}
2978 \begin_layout Standard
2986 \begin_layout Standard
2987 Let's get really fancy: lets put the section number with the word
2988 \begin_inset Quotes eld
2992 \begin_inset Quotes erd
2995 (e.\InsetSpace \thinspace{}
2997 Section 3) in the upper left, the page number (e.\InsetSpace \thinspace{}
2999 Page 4) in the upper
3000 right, your name in the lower left, and the date in the lower right.
3001 The following commands should now appear in the preamble:
3004 \begin_layout Standard
3014 \begin_layout Standard
3022 \begin_layout Standard
3032 \begin_layout Standard
3041 \begin_layout Standard
3049 \begin_layout Standard
3059 \begin_layout Standard
3072 access LaTeX's section and page counters, and so print out the current
3073 section and page numbers.
3080 simply prints out today's date.
3083 \begin_layout Standard
3084 The thicknesses of the horizontal rules drawn beneath the header and above
3085 the footer can also be modified.
3086 If you don't want one of the headers, set its thickness to 0.
3087 The header rule has a default thickness of 0.4pt, the footer rule is 0pt.
3088 Use the commands, e.\InsetSpace \thinspace{}
3096 headrulewidth}{0.4pt}
3104 footrulewidth}{0.4pt}
3106 to set the thicknesses.
3109 \begin_layout Standard
3110 You can switch the header/footer settings on and off for individual pages
3115 thispagestyle{empty}
3121 thispagestyle{plain}
3127 thispagestyle{fancy}
3130 Simply insert them in the text on the page you want changed and mark them
3132 In fact, title pages are marked as plain by default, while following pages
3133 are marked fancy when using the global fancy setting.
3136 \begin_layout Standard
3137 There are more complex commands which will let you insert things in the
3138 upper left on odd numbered pages, etc., but I will refer you to the
3142 package documentation for more descriptions.
3143 For example, if you have a teTeX installation, look for
3145 /usr/share/texmf/doc/latex/fancyhdr/\SpecialChar \-
3151 \begin_layout Standard
3152 As a final example, it is possible to include an Encapsulated PostScript
3153 file in the header or footer.
3154 Suppose you want to put a company logo in the upper lefthand corner.
3155 You might try something like
3158 \begin_layout Standard
3167 includegraphics{logo.eps}}}
3170 \begin_layout Standard
3172 (you may need to preface this with
3176 usepackage{graphics}
3178 if you don't include EPS files elsewhere in your document).
3181 \begin_layout Section
3182 Itemize Bullet Selection
3183 \begin_inset LatexCommand label
3191 \begin_layout Standard
3197 \begin_layout Subsection
3201 \begin_layout Standard
3202 LyX provides 216 bullet shapes that can be accessed from a simple dialog.
3203 Using this dialog you can easily specify what bullet shape to use at each
3204 level of an itemized list.
3205 These settings are document-wide so you won't be able to specify different
3206 sets of bullets for different paragraphs
3210 \begin_layout Standard
3211 Well, actually you can but you'll have to do it by hand.
3219 \begin_layout Subsection
3223 \begin_layout Standard
3224 Open the dialog by selecting the
3229 ocument\SpecialChar \menuseparator
3236 menu item and then select the
3246 \begin_layout Standard
3247 The dialog provides you with a table of bullet shapes.
3248 A column of buttons on the left of the table provides access to the six
3249 different panels of bullet shapes.
3250 The row of buttons across the top is used to select which bullet depth
3252 A text entry under the table shows the currently selected bullet shape's
3253 LaTeX equivalent and this can be edited if desired.
3254 If you do modify the text you will also need to specify any needed packages
3255 in the LaTeX preamble.
3258 \begin_layout Standard
3259 The six panels are divided up by the packages they require.
3260 The following table shows the mappings from button name to LaTeX packages.
3263 \begin_layout Standard
3265 \begin_inset Tabular
3266 <lyxtabular version="3" rows="7" columns="2">
3268 <column alignment="center" valignment="top" leftline="true" width="0pt">
3269 <column alignment="center" valignment="top" leftline="true" rightline="true" width="0pt">
3270 <row topline="true" bottomline="true">
3271 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
3274 \begin_layout Standard
3289 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
3292 \begin_layout Standard
3308 <row topline="true">
3309 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
3312 \begin_layout Standard
3327 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
3330 \begin_layout Standard
3345 <row topline="true">
3346 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
3349 \begin_layout Standard
3364 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
3367 \begin_layout Standard
3383 <row topline="true">
3384 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
3387 \begin_layout Standard
3402 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
3405 \begin_layout Standard
3421 <row topline="true">
3422 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
3425 \begin_layout Standard
3440 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
3443 \begin_layout Standard
3459 <row topline="true">
3460 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
3463 \begin_layout Standard
3478 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
3481 \begin_layout Standard
3497 <row topline="true" bottomline="true">
3498 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
3501 \begin_layout Standard
3516 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
3519 \begin_layout Standard
3542 \begin_layout Standard
3543 LyX doesn't stop you using bullets from packages you don't have.
3544 If you get errors from LaTeX when you try to view or print the file then
3545 its likely you are missing a package.
3546 LyX doesn't restrict your use since you may be editing locally and exporting
3550 \begin_layout Subsection
3554 \begin_layout Standard
3555 Select which bullet depth you want to change then select the bullet shape
3557 Any changes will not be visible in LyX, but are visible when viewing the
3558 document using xdvi or ghostview.
3561 \begin_layout Standard
3562 You can reset a bullet shape to the default simply by clicking your right
3563 mouse button on the appropriate bullet depth button.
3566 \begin_layout Standard
3571 want to have multiple sets of paragraphs with different sets of bullets
3572 in each then you're going to have to get your hands dirty.
3573 The itemize bullet selection dialog can help though because it provides
3574 you with the LaTeX code for a wide range of bullet shapes.
3575 To make your own custom paragraphs you have the following options:
3578 \begin_layout Standard
3582 \begin_layout Standard
3598 \begin_layout Standard
3602 \begin_layout Standard
3624 \begin_layout Itemize
3625 Use the LaTeX command
3631 to specify a new bullet shape for a given depth.
3632 You'll also need to save the current bullet shape so you can restore it
3634 In this itemized list the following LaTeX code was used to change the bullet
3635 used for the first depth.
3667 Note that the itemize depth is specified in Roman numerals as part of the
3677 \begin_layout Itemize
3681 \begin_layout Standard
3694 Specify each individual entry by starting each item with the bullet shape
3695 enclosed in square brackets and set as TeX.
3696 For example, this item was started with
3709 \begin_layout Standard
3713 \begin_layout Standard
3729 \begin_layout Standard
3730 You'll also need to revert the labelitem back to its previous setting for
3731 the global bullet shape settings to remain in effect.
3732 The way used here was:
3745 \begin_layout Chapter
3746 Special Document Classes
3749 \begin_layout Section
3753 \begin_layout Standard
3759 \begin_layout Standard
3760 \begin_inset VSpace bigskip
3766 \begin_layout Standard
3768 The AMS LaTeX layouts are set up to conform to suggested styles for mathematical
3769 papers to be submitted to American Mathematical Society publications.
3770 The layouts are not tailored to a specific journal, but easily can be.
3771 You should refer to the AMS documentation for specific instructions for
3772 each journal (usually it will entail only changing a single line in the
3774 That documentation is available on the Web at
3775 \begin_inset LatexCommand url
3776 target "http://www.ams.org"
3781 \begin_inset LatexCommand url
3782 target "ftp://ftp.ams.org/pub/tex/amslatex/"
3786 .These layouts are appropriate, and useful, for any mathematical writing.
3787 There are currently 4 distinct AMS LaTeX layouts:
3790 \begin_layout Enumerate
3791 amsart: The standard AMS-article format.
3792 All results and similar statements are numbered as
3793 \begin_inset Formula $(n.m)$
3796 , where the first number refers to the section, and the second refers to
3797 the total number of results (Theorems, Corollaries, Propositions, Definitions
3798 and Remarks, etc.) in that section.
3799 There are also many (but not all) environments available unnumbered, which
3800 is occasionally needed.
3801 Unnumbered environments indicated by an asterisk at the end.
3804 \begin_layout Enumerate
3805 amsart-seq: Here, numbering for each type of statement is in its own sequence,
3806 with no reference to the section number.
3807 There are also many (but not all) environments available unnumbered, which
3808 is occasionally needed.
3809 Unnumbered environments indicated by an asterisk at the end.
3812 \begin_layout Enumerate
3813 amsart-plain: This one is even more terse, since all the environments are
3817 \begin_layout Enumerate
3818 amsbook: the standard AMS book (really, monograph) format.
3819 Numbering is similar to the amsart layout, except that all numbering is
3821 \begin_inset Formula $(n.m.p)$
3824 , where the first number refers to the chapter, the second to the section,
3825 and the third is the number of the results (Theorems, Corollaries, Propositions
3826 , Definitions and Remarks, etc.) in that section.
3827 There are also many (but not all) environments available unnumbered, which
3828 is occasionally needed.
3829 Unnumbered environments indicated by an asterisk at the end.
3832 \begin_layout Standard
3833 Any AMS LyX file can be converted to either of the numbering schemes by
3834 simply changing the document class in the
3839 ocument\SpecialChar \menuseparator
3850 \begin_layout Subsection
3851 What these layouts provide
3854 \begin_layout Standard
3855 There is a long list of included environments provided by these layouts.
3856 Most mathematical papers or books will set as special statements most of
3857 these environments, in AMS-LaTeX there is an opportunity to define an unlimited
3858 variety of such declarations.
3859 However, the AMS recommends the environments that are available in LyX.
3860 The list of environments (not counting the standard environments such as
3863 sections, bibliography, title, author, date
3868 \begin_layout Description
3869 Theorem This is typically used for the statements of major results.
3871 \begin_inset Quotes eld
3879 \begin_inset Quotes erd
3882 appears in bold type, along with an automatically-determined number (an
3887 , is also available).
3888 The text is italicized.
3891 \begin_layout Description
3892 Corollary This is used for statements which follow fairly directly from
3893 previous statements.
3894 Again, these can be major results.
3902 \begin_layout Description
3903 Lemma These are smaller results needed to prove other statements.
3906 \begin_layout Description
3907 Proposition These are less major results which (hopefully) add to the general
3908 theory being discussed.
3911 \begin_layout Description
3912 Conjecture These are statements provided without justification, which the
3913 author does not know how to prove, but which seem to be true (to the author,
3917 \begin_layout Description
3918 Criterion A required condition.
3921 \begin_layout Description
3922 Algorithm A general procedure to be used.
3925 \begin_layout Description
3926 Axiom This is a property or statement taken as true within the system being
3930 \begin_layout Description
3931 Definition Guess what this is for.
3932 The font, both on-screen and in the output, is different for this environment
3933 than for the previous ones.
3935 \begin_inset Quotes eld
3939 \begin_inset Quotes erd
3942 ) is still set in boldface, along with the number, if any, but the rest
3946 \begin_layout Description
3947 Example Typeset similarly to Definition.
3950 \begin_layout Description
3954 \begin_layout Description
3958 \begin_layout Description
3962 \begin_layout Description
3963 Remark This environment is also a new type of theorem.
3964 This is set with the word Remark in italics, and the rest upright.
3967 \begin_layout Description
3968 Note Set similarly to the Remark environment.
3971 \begin_layout Description
3975 \begin_layout Description
3979 \begin_layout Description
3983 \begin_layout Description
3987 \begin_layout Description
3988 Case Generally, these are used to break up long arguments, using specific
3989 instances of some condition.
3990 The numbering scheme for cases is on its own, not together with other numbered
3995 \begin_layout Description
3999 \begin_layout Description
4003 \begin_layout Description
4005 \begin_inset Quotes eld
4013 \begin_inset Quotes erd
4016 is set in italics, but the rest is set upright.
4017 At the end of this environment (other environments can be nested within
4018 this one, of course) a QED symbol (usually a square, but it can vary with
4019 different styles) is placed.
4022 \begin_layout Description
4023 Address This should be the author's permanent address.
4026 \begin_layout Description
4027 Current\InsetSpace ~
4028 Address This should be the author's temporary address at the time
4029 of submission, if different from the Address.
4032 \begin_layout Description
4033 Email Author's e-mail address
4036 \begin_layout Description
4037 URL Author's Web address, if desired.
4040 \begin_layout Description
4041 Keywords Key words or phrases used to identify specific topics discussed
4045 \begin_layout Description
4046 Subjectclass These refer to the AMS Subject Classifications, published and
4049 Mathematical Reviews
4052 These are also available online at the AMS cites listed above.
4055 \begin_layout Description
4059 \begin_layout Description
4063 \begin_layout Description
4067 \begin_layout Standard
4068 In addition, these environments automatically provide the AMS LaTeX and
4070 They need to be available on your system in order to use these environments.
4073 \begin_layout Section
4077 \begin_layout Standard
4082 can be used to type letters according to German conventions.
4083 A template file is included in
4085 .../lyx/share/templates
4087 for you to use as a starting point.
4090 \begin_layout Section
4094 \begin_layout Standard
4099 provides an alternative to the standard
4104 It provides similar functionality, but you might prefer this layout with
4105 sans serif sections, headings, and more.
4108 \begin_layout Section
4112 \begin_layout Standard
4118 \begin_layout Subsection
4122 \begin_layout Standard
4123 This section describes how LyX can be used to write articles for submission
4124 to the scientific journal
4126 Astronomy and Astrophysics
4129 \begin_inset LatexCommand url
4130 name "www.edpsciences.fr/aa/"
4131 target "http://www.edpsciences.fr/aa/"
4135 ) using Version 5.01 of the document class
4140 This package can be downloaded from the ftp site
4143 \begin_layout Standard
4144 \begin_inset VSpace medskip
4150 \begin_layout Standard
4152 \begin_inset LatexCommand url
4153 target "ftp://ftp.edpsciences.org/pub/aa/readme.html"
4160 \begin_layout Standard
4161 \begin_inset VSpace medskip
4167 \begin_layout Standard
4168 A manual comes together with that package, and this text is not meant to
4169 replace the original manual but merely a short guide how to realize the
4170 correct form of your paper.
4174 \begin_layout Standard
4175 Please note that the publisher of the journal was changed from Springer
4176 to EDP Sciences starting January 1, 2001.
4177 That change implicated also some slight changes of the style files, namely
4178 the removal of the thesaurus command.
4179 The LyX class aa supports the newest version of these style files, V 5.01.
4180 If you have an older version installed, please upgrade.
4181 For compatibility, the old (version 4) layout has been kept as
4186 Please refer to the comments in
4188 LyXDir/layouts/aapaper.layout
4193 \begin_layout Subsection
4197 \begin_layout Standard
4198 It is recommended you start from the example template distributed with LyX.
4199 If you are not using a template, note the following settings:
4202 \begin_layout Itemize
4212 ocument\SpecialChar \menuseparator
4219 dialog (OK, that one was obvious).
4222 \begin_layout Itemize
4223 Don't change the option
4233 The whole layout is done by the macros, you shouldn't change anything.
4236 \begin_layout Subsection
4240 \begin_layout Standard
4241 First thing to enter is the header information.
4242 It consists of seven entries, of which some are optional.
4246 \begin_layout Itemize
4254 \begin_layout Itemize
4262 \begin_layout Itemize
4270 \begin_layout Itemize
4278 \begin_layout Itemize
4283 : [optional] if more than one author: whom to contact for offprint requests.
4286 \begin_layout Itemize
4291 : [optional] mail address for contacts.
4294 \begin_layout Itemize
4302 Received: <date>; Accepted <date>
4305 \begin_layout Standard
4306 There is no need to issue the
4312 command, this is done automatically by LyX when the header is finished.
4313 Although the order of the single header entries doesn't matter it is advised
4314 to keep the above sequence, just to get the best optics and meets the layout
4315 of the real document.
4318 \begin_layout Standard
4319 If you want to place footnotes in the header block, e.\InsetSpace \thinspace{}
4324 \begin_layout Standard
4333 to state your present address, just use the standard footnote via
4338 nsert\SpecialChar \menuseparator
4346 LyX will automagically use the term
4355 \begin_layout Standard
4356 In addition to these topics, the macros use three additional LaTeX commands
4357 that have no counterpart in LyX:
4360 \begin_layout Itemize
4367 to separate different names for more than one author and institute, respectivel
4371 \begin_layout Itemize
4378 to mark corresponding author/institute pairs.
4379 The institutes are numbered sequentially as they appear in the
4383 field, so you have to put a marker to each author.
4386 \begin_layout Itemize
4393 to supply an email address for fast contact.
4396 \begin_layout Standard
4397 In all cases, the appropriate command has to be entered in LyX and marked
4403 \begin_layout Subsection
4407 \begin_layout Standard
4408 The abstract should immediately follow the header block.
4409 With version 5 the abstract environment was changed to a command, and there
4410 is now a resctriction to only one paragraph.
4411 In addition, it should contain an entry with the keywords.
4412 This is not yet implemented for LyX, therefore you have to enter the LaTeX
4419 by hand and mark it as LaTeX code.
4420 Refer to the example paper.
4423 \begin_layout Subsection
4424 Supported environments
4427 \begin_layout Standard
4428 The A&A paper layout supports the following environments for structuring
4432 \begin_layout Itemize
4438 \begin_layout Itemize
4444 \begin_layout Itemize
4450 \begin_layout Itemize
4456 \begin_layout Itemize
4462 \begin_layout Itemize
4468 \begin_layout Itemize
4474 \begin_layout Itemize
4480 \begin_layout Itemize
4486 \begin_layout Itemize
4492 \begin_layout Itemize
4498 \begin_layout Itemize
4504 \begin_layout Subsection
4505 Commands not supported by LyX
4508 \begin_layout Standard
4509 Some commands are not yet supported by the
4514 Some have already been mentioned.
4515 For the sake of completeness, they are listed all together here:
4518 \begin_layout Itemize
4526 \begin_layout Itemize
4534 \begin_layout Itemize
4542 \begin_layout Itemize
4550 \begin_layout Itemize
4558 \begin_layout Itemize
4566 \begin_layout Itemize
4574 \begin_layout Itemize
4582 \begin_layout Standard
4583 If you want to use any of these commands, you have to enter them yourself.
4586 Do not forget to mark them as LaTeX code!
4589 \begin_layout Subsection
4590 Figure and Table Floats
4593 \begin_layout Standard
4594 LyX provides support for the necessary float environments
4596 figure, figure*, table
4602 , therefore we won't tell much about it here.
4609 Just remember that tables should be left-aligned.
4610 For that, select the table and change the alignment in
4615 dit\SpecialChar \menuseparator
4620 aragraph\InsetSpace ~
4624 \begin_layout Standard
4625 There is only one special thing: the figures with caption besides the figure.
4626 To create such a figure, you have to do the following:
4629 \begin_layout Enumerate
4630 Create a wide figure float:
4635 nsert\SpecialChar \menuseparator
4640 t\SpecialChar \menuseparator
4643 , then right click in the figure and select
4654 \begin_layout Enumerate
4655 Enter your caption text.
4658 \begin_layout Enumerate
4663 to move the cursor above the caption.
4666 \begin_layout Enumerate
4670 \begin_layout Enumerate
4671 Position the cursor behind the figure and insert a horizontal fill:
4676 nsert\SpecialChar \menuseparator
4684 \SpecialChar \menuseparator
4687 orizontal\InsetSpace ~
4693 \begin_layout Enumerate
4694 Switch to LaTeX mode:
4702 \begin_layout Enumerate
4712 Do not close the brace!
4715 \begin_layout Enumerate
4716 Position the cursor behind the caption text, switch to LaTeX mode and insert
4729 \begin_layout Standard
4730 Also, refer to the figures in the example paper.
4733 \begin_layout Subsection
4737 \begin_layout Standard
4738 For submission, the paper has to be formated in a special double-spacing
4740 For this purpose, you have to give the option
4744 to the documentclass.
4745 This must be done using the extra class options field in the
4750 ocument\SpecialChar \menuseparator
4758 Just enter the string
4765 \begin_layout Subsection
4769 \begin_layout Standard
4774 directory contains an example paper written with LyX.
4775 It is the example paper from the original macro package, translated to
4777 Use it for inspiration, and compare the original LaTeX code with LyX way
4781 \begin_layout Section
4785 \begin_layout Standard
4791 \begin_layout Subsection
4795 \begin_layout Standard
4796 AASTeX is a set of macros produced by the American Astronomical Society
4797 to facilitate electronic manuscript submission to the three journals they
4798 publish: the Astrophysical Journal (including the Letters and Supplement),
4799 the Astronomical Journal, and the Publications of the Astronomical Society
4801 LyX has proven to be an excellent tool for generating these documents,
4802 especially given its equation, citation, and figure handling capabilities.
4803 LyX requires version 5.0 (or higher) of these macros; preferably 5.2, which
4804 is the version described here, or higher.
4805 Versions prior to 5.0 are intended for use with LaTeX2.09 and are fundamentally
4806 incompatible with LyX.
4807 The AASTeX package may be downloaded from the AASTeX Web site
4810 \begin_layout Standard
4811 \begin_inset VSpace medskip
4817 \begin_layout Standard
4819 \begin_inset LatexCommand url
4820 target "http://www.journals.uchicago.edu/AAS/AASTeX"
4827 \begin_layout Standard
4828 \begin_inset VSpace medskip
4834 \begin_layout Standard
4835 A complete user guide is contained in that package and you should familiarize
4836 yourself with it thoroughly before embarking on writing a paper in LyX.
4837 LyX will not reduce the need to figure out all the AASTeX commands, it
4838 will only reduce the drudgery of typing everything in.
4839 It is your responsibility to ensure that the final exported LaTeX document
4840 conforms completely to the requirements of the journal to which you are
4841 submitting your paper.
4844 \begin_layout Subsection
4845 Starting a New Paper
4848 \begin_layout Standard
4849 I strongly suggest that you start with the AASTeX template file.
4855 ile\SpecialChar \menuseparator
4865 , enter the new file name, then choose the
4870 This will show the most common fields found in a manuscript.
4871 Simply overwrite the existing text (including the brackets,
4875 ) with the correct information.
4876 Many of the AASTeX commands and environments can be implemented directly
4877 in LyX, but some cannot: most noticeably
4889 , which should stick out like a sore thumb if you actually just opened the
4891 For commands such as these, the LaTeX code must be entered directly and
4893 Such commands are referred to as ERT, or Evil Red Text.
4894 I tried to minimize the amount of ERT needed in an AASTeX document, but
4895 there is still a bit more required than any of us would like.
4898 \begin_layout Subsection
4899 Finishing Your Paper
4902 \begin_layout Standard
4903 When the paper is finished to your satisfaction and previews/prints correctly,
4905 \begin_inset Quotes eld
4909 \begin_inset Quotes erd
4912 actions which need to be done before you submit it to the journals.
4916 \begin_layout Enumerate
4917 Export your paper as a LaTeX file (
4922 ile\SpecialChar \menuseparator
4927 xport\SpecialChar \menuseparator
4938 \begin_layout Enumerate
4943 file with your favorite text editor
4947 \begin_layout Enumerate
4948 remove the comment lines before the
4957 \begin_layout Enumerate
4962 usepackage...{fontenc}
4964 line if it appears (usually just after
4979 \begin_layout Enumerate
4980 remove everything between (and including) the
4992 commands, except for any commands you specifically put into the LaTeX preamble
4993 (which should appear immediately after the
4994 \begin_inset Quotes eld
4997 User specified LaTeX commands
4998 \begin_inset Quotes erd
5009 \begin_layout Enumerate
5010 Run the resulting file through LaTeX to make sure it still processes correctly.
5013 \begin_layout Enumerate
5014 Reread the journal requirements to make sure your filenames and formats
5018 \begin_layout Enumerate
5022 \begin_layout Subsection
5023 Comments On Specific Commands
5026 \begin_layout Standard
5027 I will not describe the detailed usage of the individual AASTeX commands:
5028 the AASTeX User Guide (
5032 ) gives a good description of each.
5033 Thus it's probably easiest for me to go down the list as found in the guide
5034 and offer comments where necessary.
5035 So let's begin \SpecialChar \ldots{}
5039 \begin_layout Subsubsection
5040 Things that work as expected
5043 \begin_layout Standard
5047 \begin_layout Standard
5059 \begin_layout Standard
5060 Because they work as you might expect, I simply list them and the section
5161 begin{thebibliography}
5169 (2.13.2), all the cite commands and their variations (2.13.2), the generic
5170 graphicx figure commands (2.14.1),
5194 (2.15.4, amongst other places),
5221 \begin_layout Standard
5222 The following style options also work correctly:
5243 Simply put them in the
5249 Layout\SpecialChar \menuseparator
5255 \begin_layout Standard
5259 \begin_layout Standard
5271 \begin_layout Subsubsection
5272 Things that work, but require more comment
5275 \begin_layout Standard
5276 The following items work, but require a little more discussion:
5279 \begin_layout Itemize
5280 These items are reserved for use by the journal editors, but you can put
5281 them into the LaTeX preamble if you feel compelled to do so:
5314 \begin_layout Itemize
5315 These items may be placed in the LaTeX preamble, and are included as blanks
5316 in the template file:
5337 \begin_layout Itemize
5344 (2.3) -- can only be used
5345 \begin_inset Quotes eld
5349 \begin_inset Quotes erd
5352 , not in the middle of a paragraph.
5353 Use ERT if you need to embed it.
5356 \begin_layout Itemize
5363 (2.3) -- will have extra {} after it.
5364 This should not cause an error.
5367 \begin_layout Itemize
5374 (2.6) -- can only be used
5375 \begin_inset Quotes eld
5379 \begin_inset Quotes erd
5382 , not in the middle of a paragraph.
5383 Use ERT if you need to embed it.
5386 \begin_layout Itemize
5393 (2.8) -- can't insert a cross-reference tag, you must type the tag name
5397 \begin_layout Itemize
5404 (2.8) -- same as for
5411 \begin_layout Itemize
5418 (2.9) -- will have extra {} after it.
5419 This should not cause an error.
5422 \begin_layout Itemize
5429 (2.11) -- will have extra {} after it.
5430 This should not cause an error.
5433 \begin_layout Itemize
5440 (2.14.2) -- you can insert an optional filename argument by placing the cursor
5441 at the beginning of the text and selecting
5443 Insert\SpecialChar \menuseparator
5448 \begin_inset Quotes eld
5452 \begin_inset Quotes erd
5455 inserts an optional argument of the type needed by
5462 Hopefully it will be renamed someday.
5465 \begin_layout Itemize
5478 for the catalog ID optional parameter
5481 \begin_layout Itemize
5494 for the catalog ID optional parameter
5497 \begin_layout Subsubsection
5498 Things not implemented, use ERT
5501 \begin_layout Standard
5505 \begin_layout Standard
5517 \begin_layout Standard
5540 setcounter{equation}
5542 (2.12), Journal name abbreviations (2.13.4),
5578 (2.15.4, insert it as the first element in the lefthand cell after where
5580 Don't use any of LyX's rules in the table),
5592 (2.15.5), much of Misc (2.17, except
5643 \begin_layout Standard
5647 \begin_layout Standard
5659 \begin_layout Subsubsection
5660 Things that cannot be implemented
5663 \begin_layout Standard
5664 \SpecialChar \ldots{}
5665 at least in any meaningful sort of way, so I suggest ignoring them.
5666 They are the references environment (2.13.3), and the deluxetable environment
5668 If you really, really need to use deluxetable, I suggest editing it in
5669 a separate file with a text editor, then using
5674 nsert\SpecialChar \menuseparator
5682 to include it in your LyX document.
5687 file to see an example of this.
5690 \begin_layout Subsection
5691 FAQs, Tips, Tricks, and Other Ruminations
5694 \begin_layout Subsubsection
5695 Getting LyX and AASTeX to cooperate
5698 \begin_layout Standard
5699 It can be a bit tricky to get LyX to recognize a new layout and document
5701 When all else fails, do this:
5704 \begin_layout Enumerate
5705 Make certain that LaTeX can find AASTeX.
5706 Copy sample.tex (and perhaps table.tex) from the AASTeX distribution into
5707 a directory completely unrelated to LaTeX or AASTeX and run LaTeX on
5714 \begin_layout Enumerate
5721 /usr/.../share/lyx/layouts
5730 \begin_layout Enumerate
5736 ools\SpecialChar \menuseparator
5743 in LyX, then restart LyX.
5746 \begin_layout Enumerate
5747 Open a regular new file, not from a template.
5748 Does AASTeX appear in the class list in
5753 ocument\SpecialChar \menuseparator
5763 \begin_layout Standard
5764 If you get a warning from an existing AASTeX document about not being able
5765 to find the AASTeX layout or a message about
5766 \begin_inset Quotes eld
5769 You should not mix title layouts with normal ones
5770 \begin_inset Quotes erd
5773 , things haven't been installed correctly.
5776 \begin_layout Subsubsection
5777 LaTeX error processing a table
5780 \begin_layout Standard
5781 LyX, by default, attempts to center the table caption/title.
5782 This seems to produce a bad interaction in AASTeX so you should click somewhere
5783 in the caption/title, then select
5788 dit\SpecialChar \menuseparator
5793 aragraph\InsetSpace ~
5808 This took care of it for me.
5811 \begin_layout Subsubsection
5813 \begin_inset LatexCommand label
5821 \begin_layout Standard
5822 A couple of things: 1) I have noticed some funny spacing in the reference
5823 entries in the text.
5824 When you enter the bibliography item data, make sure their is
5828 space between the last author and the parenthesis setting off the year;
5831 e.\InsetSpace \thinspace{}
5844 2) Entering the references at all is not obvious.
5845 The easiest thing is to start typing your first reference at the end of
5846 the document, then mark it as type
5851 That will put a small gray box in front of what you just typed.
5852 Click on the box to fill in the rest of the information.
5853 For new references, go to the end of an existing reference and press return.
5854 That will create a new line with its own box, etc.
5857 \begin_layout Subsubsection
5861 \begin_layout Standard
5862 Even though AASTeX provides its own figure commands (
5868 , for example), I much prefer LaTeX's standard figure commands (with the
5877 commands as ERT into a Figure Float box if you desire, but I never
5878 have much luck getting the layout right.
5879 With the standard graphics, LyX will insert a
5883 usepackage{graphicx}
5885 command into the LaTeX preamble and handle the figures in the standard
5886 LaTeX2e way, interspersing the figures in the text.
5887 I believe ApJ accepts figures exactly this way now; AJ might still use
5889 \begin_inset Quotes eld
5892 stack everything at the end
5893 \begin_inset Quotes erd
5899 \begin_layout Subsubsection
5900 Things I could have done, but didn't
5903 \begin_layout Standard
5905 \begin_inset Quotes eld
5909 \begin_inset Quotes erd
5912 things I could have implemented, but chose not to.
5913 For instance, I saw no point in double-spacing the text in the LyX window,
5914 even though it is double-spaced in the paper manuscript.
5915 Also, I chose not to make separate layouts for the preprint and preprint2
5917 Since I assume you will spend most of your time in the plain manuscript
5918 mode anyway, I decided not to chew up more disk space with this.
5922 \begin_layout Subsection
5926 \begin_layout Standard
5927 Your mileage may vary.
5928 I've now had papers published by both ApJ and AJ that have had 98% of the
5929 effort done in LyX; the last 2% was the LaTeX post-processing and a few
5931 I have had no trouble with the submission process, and I'm sure the journals
5932 were never aware that there might be a difference.
5933 So, go forth and publish!
5936 \begin_layout Section
5940 \begin_layout Standard
5943 Panayotis Papasotiriou
5946 \begin_layout Subsection
5950 \begin_layout Standard
5951 The ijmpc package is a set of macros that facilitates electronic manuscript
5954 International Journal of Modern Physics C
5957 Similarly, the ijmpd package is for creating manuscripts to be submitted
5960 International Journal of Modern Physics D
5963 Both journals are published by World Scientific.
5964 The corresponding document classes are named
5973 These files, together with instructions for the authors, can be downloaded
5975 \begin_inset LatexCommand url
5976 target "http://www.worldscinet.com/ijmpc/mkt/guidelines.shtml"
5981 \begin_inset LatexCommand url
5982 target "http://www.worldscinet.com/ijmpd/mkt/guidelines.shtml"
5987 Both packages are modified versions of the standard
5988 \begin_inset Quotes eld
5992 \begin_inset Quotes erd
5995 package, and they are almost (but not exactly) identical.
5996 Most of their features are supported by LyX.
5997 I have used LyX successfully to write articles submitted to both journals
5998 without any problem.
6001 \begin_layout Subsection
6005 \begin_layout Standard
6006 As usual, the easiest way to write a paper is to start with a template.
6012 ile\SpecialChar \menuseparator
6031 This will give an (almost) empty document that includes the most common
6032 fields found in a manuscript.
6033 Simply overwrite the existing text (including the brackets,
6038 You should keep in mind the following remarks.
6041 \begin_layout Enumerate
6042 LyX won't let you change the font size and the page style of the document,
6043 because such modifications are not allowed by both packages.
6046 \begin_layout Enumerate
6047 The language of the document should not be changed.
6048 Before previewing your paper, be sure that the babel package is not used.
6049 To do this, click on
6054 ools\SpecialChar \menuseparator
6072 checkbox in the language settings, and click on
6083 , if you wish to make this change permanent).
6086 \begin_layout Enumerate
6088 \begin_inset Quotes eld
6092 \begin_inset Quotes erd
6095 style must be used to define keywords.
6098 \begin_layout Enumerate
6099 The ijmpc package provides a style named
6100 \begin_inset Quotes eld
6103 Classification Codes
6104 \begin_inset Quotes erd
6107 , which can be used to define classification codes, such as PACS numbers.
6108 Note that this facility is not supported by the ijmpd package.
6111 \begin_layout Enumerate
6112 Several new environments are available:
6113 \begin_inset Quotes eld
6117 \begin_inset Quotes erd
6121 \begin_inset Quotes eld
6125 \begin_inset Quotes erd
6129 \begin_inset Quotes eld
6133 \begin_inset Quotes erd
6137 \begin_inset Quotes eld
6141 \begin_inset Quotes erd
6145 \begin_inset Quotes eld
6149 \begin_inset Quotes erd
6153 \begin_inset Quotes eld
6157 \begin_inset Quotes erd
6161 \begin_inset Quotes eld
6165 \begin_inset Quotes erd
6169 \begin_inset Quotes eld
6173 \begin_inset Quotes erd
6177 \begin_inset Quotes eld
6181 \begin_inset Quotes erd
6185 \begin_inset Quotes eld
6189 \begin_inset Quotes erd
6193 \begin_inset Quotes eld
6197 \begin_inset Quotes erd
6201 \begin_inset Quotes eld
6205 \begin_inset Quotes erd
6209 \begin_inset Quotes eld
6213 \begin_inset Quotes erd
6217 \begin_inset Quotes eld
6221 \begin_inset Quotes erd
6225 Their use is more or less obvious.
6226 LyX supports all these environments; it will use the proper label, text
6227 style, and numbering scheme for each of them.
6230 \begin_layout Enumerate
6231 Both packages use basic citations; the natbib package should not be used.
6232 In LyX, citation references are shown as usual; in the output, citations
6233 are shown as superscripts.
6234 If you want to use a citation as normal text, you should use the
6238 command, e.\InsetSpace \thinspace{}
6240 \begin_inset Quotes eld
6243 See Ref.\InsetSpace ~
6251 \begin_inset Quotes erd
6257 \begin_layout Enumerate
6259 \begin_inset Quotes eld
6263 \begin_inset Quotes erd
6266 section in both packages.
6267 To put acknowledgments, just use the
6268 \begin_inset Quotes eld
6272 \begin_inset Quotes erd
6278 \begin_layout Enumerate
6279 Appendices may be added to the paper,
6283 the Acknowledgments and
6288 LyX provides a special environment, called
6289 \begin_inset Quotes eld
6293 \begin_inset Quotes erd
6296 which marks the beginning of the appendices.
6297 This environment should be left blank; it just sends a LaTeX command, but
6298 nothing is really printed.
6300 \begin_inset Quotes eld
6304 \begin_inset Quotes erd
6307 is printed with blue letters, as a signal that all sections after that
6308 point are appendices.
6309 To write an appendix, use the
6310 \begin_inset Quotes eld
6314 \begin_inset Quotes erd
6318 LyX will number each appendix with capital letters, as required by both
6321 \begin_inset Quotes eld
6325 \begin_inset Quotes erd
6332 be present before the first appendix; if not, all appendices will be numbered
6333 as normal sections in the output.
6336 \begin_layout Enumerate
6337 The ijmpc and the ijmpd packages use the
6341 command to implement table captions.
6342 As a result, a table created by LyX is printed correctly, but its caption
6344 However, you can use some ERT to overpass this problem, so that captions
6345 are printed as expected.
6346 To do so, create a float table as usual, remove the caption, and replace
6357 (sic); you must also the ERT
6361 immediately after the tabular material.
6362 Study the example table included in the template files to see how this
6363 trick is implemented.
6364 Alternatively, If you need table captions, you should implement the whole
6369 file, then include this file to the LyX document (
6374 nsert\SpecialChar \menuseparator
6379 \SpecialChar \menuseparator
6388 Details on how to create a table float can be found in the files
6396 , included in the corresponding packages.
6399 \begin_layout Subsection
6400 Preparing a paper for submission
6403 \begin_layout Standard
6404 Before you submit your paper you must export the LyX document as a LaTeX
6410 ile\SpecialChar \menuseparator
6415 xport\SpecialChar \menuseparator
6430 \begin_layout Standard
6431 Actually you have the choice between LaTeX (plain) and pdflatex.
6432 If you intend to use pdflatex to prepare the paper, you should use the
6433 pdflatex option so that included graphics are converted to PDF format,
6434 ready for use by pdflatex.
6439 , then make the following changes to the resulting
6446 \begin_layout Enumerate
6447 Remove the comment lines before the
6456 \begin_layout Enumerate
6457 Remove everything between (and including) the
6469 commands, except for any commands you specifically put into the LaTeX preamble.
6472 \begin_layout Standard
6477 file should be saved and processed through LaTeX as many times as necessary.
6478 You may also want to check the resulting
6485 \begin_layout Subsection
6489 \begin_layout Standard
6490 The use of ERT is reduced to two commands, which must be placed at the top
6492 If you started writing your paper by using the
6500 template, the ERT needed is already in its place; you usually don't need
6502 You may only modify the first ERT to specify the information printed to
6503 the top of odd and even pages (authors' names and short paper's title,
6505 This ERT must have the form
6509 markboth{Authors' Names}{Short Paper's Title}
6514 \begin_layout Section
6518 \begin_layout Standard
6524 \begin_layout Subsection
6528 \begin_layout Standard
6529 The iopart package provides a document class to create electronic manuscript
6530 submission to the journals published by the Institute of Physics.
6531 Instructions for the authors how to create a paper using the iopart class
6532 can be downloaded together with the iopart package from the site
6533 \begin_inset LatexCommand url
6534 target "ftp://ftp.iop.org/pub/journals/latex2e"
6541 \begin_layout Subsection
6545 \begin_layout Standard
6546 The easiest way to write a paper is to start with the file
6550 that is available in LyX's examples files folder.
6551 Open this file, save it under a new name, and start writing.
6552 The example file explains how to use the special text environments.
6553 Here are the most important advices:
6556 \begin_layout Itemize
6557 To be able to compile your document to a PDF, PS, or DVI, assure that the
6560 Use AMS math package
6562 in the document settings under
6569 \begin_layout Itemize
6572 The title environment defines the kind of your paper.
6573 So use one of the following environments for the title:
6577 \begin_layout Itemize
6586 \begin_layout Itemize
6595 \begin_layout Itemize
6601 for a Topical review
6604 \begin_layout Itemize
6613 \begin_layout Itemize
6622 \begin_layout Itemize
6628 for a Paper (same as Title)
6631 \begin_layout Itemize
6637 for a Preliminary communication
6640 \begin_layout Itemize
6646 for a Rapid communication
6649 \begin_layout Itemize
6655 for a Letter to the editor
6659 \begin_layout Itemize
6662 All title environments except of
6666 can have an optional short title.
6669 \begin_layout Itemize
6670 There is a general title environment
6674 which is not directly supported by the LyX.
6675 This can be used as ERT when your document doesn't fit into one of the
6679 \begin_layout Standard
6680 For more informations like hints for special table and formula formatting,
6681 look at the IOP author guidelines.
6684 \begin_layout Section
6688 \begin_layout Standard
6691 Panayotis Papasotiriou
6694 \begin_layout Subsection
6698 \begin_layout Standard
6699 The Kluwer package is a set of macros produced by Kluwer Academic Publishers
6700 that facilitates electronic manuscript submission to the journals they
6702 Most known of them (at least in my domain of interest) are
6704 Astrophysics and Space Science
6710 , but there are many others (see a complete list at
6711 \begin_inset LatexCommand url
6712 target "http://www.wkap.nl/jrnllist.htm/JRNLHOME"
6717 The Kluwer package may be downloaded from the site
6718 \begin_inset LatexCommand url
6719 target "http://www.wkap.nl/kaphtml.htm/STYLEFILES"
6724 A complete user guide is contained in that package (but it can also be
6725 downloaded separately).
6728 \begin_layout Standard
6729 LyX supports many features of the package but not everything.
6730 However, the ERT needed is reduced to some
6731 \begin_inset Quotes eld
6735 \begin_inset Quotes erd
6738 commands of the package (see\InsetSpace ~
6740 \begin_inset LatexCommand ref
6741 reference "subsec:kluwer_peculiarities"
6746 I have recently used LyX to write an article submitted to the
6748 Astrophysics and Space Science
6750 without any problem.
6753 \begin_layout Subsection
6757 \begin_layout Standard
6758 The easiest way to write a paper is to start with the Kluwer template file.
6761 File\SpecialChar \menuseparator
6776 This will give an (almost) empty document that includes the most common
6777 fields found in a manuscript and a short description of their use.
6778 As in most templates, simply overwrite the existing text (including the
6783 ) with the correct information.
6786 \begin_layout Subsection
6787 Preparing a paper for submission
6790 \begin_layout Standard
6791 As in the AASTeX package, before you submit your paper to a journal you
6793 \begin_inset Quotes eld
6797 \begin_inset Quotes erd
6803 \begin_layout Enumerate
6804 Export your paper as a LaTeX file.
6805 To do this, click on
6810 ile\SpecialChar \menuseparator
6815 xport\SpecialChar \menuseparator
6826 \begin_layout Enumerate
6831 file with a text editor and make the following changes
6835 \begin_layout Enumerate
6836 remove the comment lines before the
6845 \begin_layout Enumerate
6846 remove everything between (and including) the
6858 commands, except for any commands you specifically put into the LaTeX preamble.
6861 \begin_layout Standard
6870 \begin_layout Enumerate
6875 file through LaTeX as many times as necessary (usually up to three).
6878 \begin_layout Enumerate
6883 document using, e.\InsetSpace \thinspace{}
6888 , and check if everything is OK (it should, if you didn't make any mistake).
6891 \begin_layout Subsection
6892 \begin_inset Quotes eld
6896 \begin_inset Quotes erd
6899 of the Kluwer package
6900 \begin_inset LatexCommand label
6901 name "subsec:kluwer_peculiarities"
6908 \begin_layout Standard
6909 The Kluwer package has the following
6910 \begin_inset Quotes eld
6914 \begin_inset Quotes erd
6920 \begin_layout Enumerate
6921 It is possible to write multiple articles in the same LaTeX file
6925 \begin_layout Standard
6926 I can't imagine any good reason to do this.
6932 Each article must be included in the environment
6933 \begin_inset Quotes eld
6937 \begin_inset Quotes erd
6941 Unfortunately, this environment cannot be omitted, even if you write just
6943 Therefore, each article starts with the command
6949 and, obviously, ends with the command
6956 Although this can be implemented in LyX, I didn't included it, since it
6957 looks ugly and can confuse the novice user.
6958 Therefore, you need to enter them directly and mark them as LaTeX code
6960 \begin_inset Quotes eld
6964 \begin_inset Quotes erd
6970 \begin_layout Enumerate
6971 Information given at the beginning of the article (i.e., title, subtitle,
6972 author, institution, running title, running author, abstract and keywords)
6973 must be included in an environment called
6974 \begin_inset Quotes eld
6978 \begin_inset Quotes erd
6982 This is not implemented in LyX, so you must enter title, subtitle etc.\InsetSpace ~
6999 \begin_layout Enumerate
7000 According to the user manual, the label of each bibliography item must be
7024 \begin_layout Standard
7029 template takes care of all these
7030 \begin_inset Quotes eld
7034 \begin_inset Quotes erd
7038 If you start a new paper using this template you don't need to do anything
7043 \begin_layout Enumerate
7044 don't delete the ERT included in the template, and
7047 \begin_layout Enumerate
7048 copy the example bibliography item included in the template and modify it
7049 as necessary to enter new bibliography items.
7052 \begin_layout Section
7056 \begin_layout Standard
7062 \begin_layout Subsection
7066 \begin_layout Standard
7067 The LyX document classes
7069 article (koma-script)
7073 report (koma-script)
7091 correspond to the LaTeX document classes
7107 , resp.\InsetSpace ~
7108 of the Koma-Script family.
7109 They are replacements for the standard document classes
7125 , resp., and fit better to European typography conventions in a number of
7129 \begin_layout Itemize
7130 Standard character size is 11pt in
7132 article (koma-script)
7136 report (koma-script)
7144 letter (koma-script)
7149 \begin_layout Itemize
7150 Headings, labels of the description environment, and a number of elements
7153 letter (koma-script)
7155 document class are set in a bold sans serif font.
7159 \begin_layout Standard
7160 There is a big difference between the bold sans serif old cm fonts and new
7161 ec fonts, especially in the appearance of headings.
7162 In comparison, the ec bold sans serif fonts look a bit thin.
7163 Here the LaTeX package
7171 helps to produce the
7172 \begin_inset Quotes eld
7176 \begin_inset Quotes erd
7179 appearance when using the ec fonts.
7184 The numbering of chapter headings is made in the same way as the numbering
7185 of section headings, that is without the extra line
7186 \begin_inset Quotes eld
7189 Chapter\SpecialChar \ldots{}
7191 \begin_inset Quotes erd
7195 In addition, the appearance of the headings can be modified by using a
7196 number of options (in LyX to be entered in the field
7210 ayout\SpecialChar \menuseparator
7218 A detailed German description of these options can be found in the Koma-Script
7226 \begin_layout Itemize
7227 The main means in the Koma-Script document classes to design the type area
7236 (in LyX to be entered in the extra class options field in the dialog
7241 ocument\SpecialChar \menuseparator
7249 They make a clearer modification of page margins possible as do the options
7255 ocument\SpecialChar \menuseparator
7263 A detailed German description of these and other type area options can
7264 be found in the Koma-Script documentation
7271 \begin_layout Itemize
7272 The LaTeX document classes of the Koma-Script family define a number of
7273 additional commands.
7274 Those part of it which makes sense in LyX is implemented in corresponding
7278 \begin_layout Standard
7279 A detailed German description of the LaTeX document classes of the Koma-Script
7280 family can be found in the Koma-Script documentation
7288 \begin_layout Standard
7289 There is an English translation
7293 , but it is not a complete one.
7298 The following sections describe only those aspects, which are relevant
7302 \begin_layout Subsection
7303 article (koma-script), report (koma-script), and book (koma-script)
7306 \begin_layout Standard
7307 The document classes
7309 article (koma-script)
7313 report (koma-script)
7323 are implemented in the layout files
7336 They contain all the paragraph types of the corresponding standard document
7349 , resp., partly modified, with the exception of the LyX specific
7353 -type, which is replaced by the new
7357 -type having the same functionality.
7362 -Type there is a number of new paragraph types added.
7369 letter (koma-script)
7374 \begin_layout Itemize
7383 : are equivalents to
7391 , resp., additionally inserting an entry in the table of contents.
7400 are not contained in
7402 article (koma-script)
7407 \begin_layout Itemize
7424 , resp., additionally clearing running heads.
7431 article (koma-script)
7437 \begin_layout Standard
7450 report (koma-script)
7452 , but since this is identical to
7456 , is has not been implemented in LyX.
7464 \begin_layout Itemize
7469 : generates a heading directly above the following paragraph in the standard
7470 character size without affecting the structure of the document.
7473 \begin_layout Itemize
7482 are special captions which respect the different space settings needed
7483 for captions placed above or below an element (if you follow strict typographic
7484 rules, you might want to place table captions always above the table).
7485 You can also use the class option
7502 You need at least Koma-Script version 2.8q to use this.
7505 \begin_layout Itemize
7510 : can be used to set a bonmot, e.
7514 \begin_layout Standard
7527 \begin_layout Standard
7536 at the beginning of a chapter.
7537 If you use the optional argument (
7542 nsert\SpecialChar \menuseparator
7546 ), you can insert the dictum's author there.
7547 Dictum and author are separated by a line.
7548 You need at least Koma-Script version 2.8q to use this.
7555 article (koma-script)
7560 \begin_layout Standard
7561 The following types, together with the standard types
7573 , form the title area of the document.
7574 They must be entered ahead of the first
7575 \begin_inset Quotes eld
7579 \begin_inset Quotes erd
7586 \begin_layout Standard
7587 The corresponding LaTeX commands must appear before the
7598 When such a type is used more than once, the latter usage overwrites the
7599 former one, that means, for every type only the latest usage is valid.
7600 The order of the different types however has, like
7612 , no effect on the appearance of the produced document.
7615 \begin_layout Itemize
7620 : produces a centered paragraph above the ordinary title (
7632 ) for the subject of the document.
7635 \begin_layout Itemize
7640 : produces a centered paragraph below the ordinary title (
7652 ) for the publishers' name.
7655 \begin_layout Itemize
7662 report (koma-script)
7668 produces a centered paragraph on its own page behind the title page, or
7671 article (koma-script)
7673 produces a centered paragraph below the ordinary title (
7692 \begin_layout Itemize
7697 : produces a left aligned paragraph above the ordinary title (
7713 ) for a document`s head.
7716 \begin_layout Itemize
7721 : produces in a double-sided print in
7723 report (koma-script)
7729 a left-aligned paragraph at the top of the title page`s back or has no
7730 effect in a single-sided print or in
7732 article (koma-script)
7737 \begin_layout Itemize
7742 : produces in a double-sided print in
7744 report (koma-script)
7750 a left-aligned paragraph at the bottom of the title page`s back or has
7751 no effect in a single-sided print or in
7753 article (koma-script)
7758 \begin_layout Itemize
7763 : produces a special
7764 \begin_inset Quotes eld
7768 \begin_inset Quotes erd
7771 page ahead of the actual document containing a paragraph without special
7775 \begin_layout Standard
7776 The layout files for the document classes
7778 article (koma-script)
7782 report (koma-script)
7793 This is thought of as a place to define your own types.
7798 in your personal layout directory and edit the file!
7801 \begin_layout Subsection
7802 letter (koma-script)
7805 \begin_layout Standard
7809 \begin_layout Standard
7821 \begin_layout Standard
7825 letter (koma-script)
7827 is implemented in the layout file
7832 It contains all the paragraph types of the corresponding standard document
7837 , partly modified, with the exception of the LyX specific types
7849 type, which is replaced by the new
7854 In addition, it contains, in contrast to the standard document class, the
7872 Furthermore, there are a number of new letter specific types.
7875 \begin_layout Standard
7879 \begin_layout Standard
7891 \begin_layout Standard
7892 The appearance of the letter produced by this document class can be controlled
7893 by a number of LaTeX commands, which you can put in the LaTeX preamble.
7897 \begin_layout Standard
7898 For example, the standard appearance of the letter`s heading, consisting
7899 of name and address, is quite self-willed.
7901 \begin_inset Quotes eld
7905 \begin_inset Quotes erd
7908 heading is produced by the following LaTeX commands in the preamble:
7911 \begin_layout LyX-Code
7921 \begin_layout LyX-Code
7937 \begin_layout LyX-Code
7947 \begin_layout LyX-Code
7967 A detailed German description of such LaTeX commands can be found in the
7968 Koma-Script documentation
7973 With it, the letter's author can produce his personal letter layout.
7976 \begin_layout Standard
7985 define the beginning of the letter and must be used in every letter.
7986 To emphasize them in the LyX document class, they are marked with the letter
7995 , resp.\InsetSpace ~
7997 It is possible to write any number of letters in one file.
8002 type produces a new letter using the same addressee and a
8006 type produces a new addressee.
8023 are ordinary paragraph types and can also be used several times in one
8024 and the same letter.
8027 \begin_layout Itemize
8032 : produces a paragraph for the addressee and implicitly defines the beginning
8036 \begin_layout Itemize
8041 : produces a paragraph for the form of address and implicitly produces a
8045 \begin_layout Itemize
8050 : produces a paragraph for a close.
8053 \begin_layout Itemize
8058 : produces a paragraph for a postscript.
8061 \begin_layout Itemize
8066 : produces a paragraph for a distribution list.
8069 \begin_layout Itemize
8074 : produces a paragraph for enclosures.
8077 \begin_layout Standard
8118 are input types provided with a label to enter information, which will
8119 be processed by the document class.
8123 \begin_layout Standard
8124 It could be seen as a matter of inconsequence, that the types
8132 described above are not such input types as well.
8133 Because of the special meaning of those types, however, I have implemented
8134 them as ordinary paragraph types with a one letter mark in the left margin.
8135 Moreover, it would affect my feeling of symmetry, if the
8143 type had such a serious different appearance.
8148 The types must be used ahead of the corresponding
8155 \begin_layout Standard
8156 An implementation of these types in a WYSIWYG fashion does not seem to make
8157 sense, because the real appearance of the produced letter does not only
8158 depend on the usage of the particular type, but also on other factors.
8159 For example, a signature entered in the
8163 type will in the standard behavior appear in the produced letter only,
8164 when in the same letter also a
8169 The entered value of the
8173 type will in the standard behavior not appear in the produced letter at
8175 The possibility to design the letter`s heading freely is already indicated
8176 in a footnote above.
8179 \begin_layout Standard
8180 The input types can also be used as empty paragraphs.
8181 This makes sense e.\InsetSpace \thinspace{}
8192 type is not used at all, in the standard behavior the value of the
8196 type is used as signature, whereas if an empty
8200 type is used, no signature value is defined.
8203 \begin_layout Standard
8204 By using the input types it is possible to write a letter template, containing
8205 filled input types with your personal dates (name, address, etc.) and empty
8206 input types for other dates you want to enter.
8209 \begin_layout Itemize
8214 : sender's name, in the standard behavior appears as a centered paragraph
8215 in small caps in the letter`s heading.
8218 \begin_layout Itemize
8223 : sender's signature, in the standard behavior appears below the
8232 type is used, the value of the
8236 type appears instead.
8239 \begin_layout Itemize
8244 : sender's address, in the standard behavior appears in a centered paragraph
8245 in the letter`s heading below the sender's name.
8248 \begin_layout Itemize
8253 : sender's telephone number, in the standard behavior only sets the LaTeX
8263 \begin_layout Itemize
8268 : place of the letter`s making.
8271 \begin_layout Itemize
8276 : date of the letter`s making.
8285 , in the standard behavior, produce the place and the date in a right-aligned
8286 line below the addressee's field.
8291 type is used, neither place nor date appear, independent of the value of
8301 type is used, the date of the letter `s production is used.
8304 \begin_layout Itemize
8309 : sender`s back address, in the standard behavior appears above the addressee's
8310 field in a small sans serif font.
8313 \begin_layout Itemize
8318 : special mail information, in the standard behavior appears underlined
8319 above the addressee's field below the back address.
8322 \begin_layout Itemize
8327 : additional information, in the standard behavior appears on right side
8328 below the addressee`s field.
8331 \begin_layout Itemize
8336 : the letter's title, in the standard behavior appears in a big, bold, sans
8337 serif font above the subject.
8340 \begin_layout Itemize
8345 : the letter's subject, in the standard behavior appears in a bold font
8353 \begin_layout Standard
8374 produce a business letter like line above the
8378 line containing the fields
8379 \begin_inset Quotes eld
8383 \begin_inset Quotes erd
8387 \begin_inset Quotes eld
8391 \begin_inset Quotes erd
8395 \begin_inset Quotes eld
8399 \begin_inset Quotes erd
8403 \begin_inset Quotes eld
8407 \begin_inset Quotes erd
8411 \begin_inset Quotes eld
8415 \begin_inset Quotes erd
8419 \begin_inset Quotes eld
8423 \begin_inset Quotes erd
8427 For the date field, the value of the
8433 \begin_inset Quotes eld
8436 business letter types
8437 \begin_inset Quotes erd
8440 is used, the value of the
8444 type however does not appear, but only the LaTeX variable
8451 The ordinary output of place and date in a right-aligned line below the
8452 addressee`s field is suppressed.
8453 The types are implemented as input types provided with a label and must
8454 be used ahead of the corresponding
8461 \begin_layout Itemize
8469 \begin_layout Itemize
8477 \begin_layout Itemize
8485 \begin_layout Itemize
8493 \begin_layout Itemize
8501 \begin_layout Subsection
8502 The new letter class: letter (koma-script v.2)
8505 \begin_layout Standard
8508 Jürgen Spitzmüller
8511 \begin_layout Standard
8512 \begin_inset VSpace medskip
8518 \begin_layout Standard
8520 Koma-Script version 2.8 has introduced a new letter class
8524 which supersedes the now unsupported
8529 It has --- on the LaTeX side --- a completely new interface and is not
8530 compatible with the old class.
8531 Therefore, LyX supports both, though it is recommended to use the new class.
8534 \begin_layout Standard
8535 This class covers the same functionality as
8537 letter (koma-script),
8544 (receiver's address, same as
8561 will start a new letter (i.
8565 \begin_layout Standard
8578 \begin_layout Standard
8587 you can write several letters per document).
8588 New elements are sender's
8604 and the possibility to use a
8613 nsert\SpecialChar \menuseparator
8623 \begin_layout Standard
8624 The biggest improvement is, though, that the letter's layout is configurable
8625 at almost any needs.
8626 This can be done via the preamble or with a special style file (Letter
8627 Class Option, extension
8631 ), that will be read in as a class option.
8635 \begin_layout Standard
8636 The KOMA package comes with some default
8641 There is, for instance, a
8645 file that follows german typesetting rules, or a
8649 that provides the default layout of the old
8654 The latter can be loaded with the class option
8663 ayout\SpecialChar \menuseparator
8668 ocument\SpecialChar \menuseparator
8680 template that is included in LyX for examples.
8681 A detailed description is to be found in the Koma-Script documentation
8689 \begin_layout Subsection
8693 \begin_layout Standard
8694 Visualizing the Koma-Script document classes in LyX, the LyX internals cause
8698 \begin_layout Itemize
8699 The chapter number of a
8703 type appears on a line of its own above the chapter heading instead of
8704 appearing in the same line ahead of it.
8705 The cause for that is the LyX internal behavior for the labeltype
8712 \begin_layout Itemize
8713 The headings of the types
8722 \begin_inset Quotes eld
8726 \begin_inset Quotes erd
8729 LaTeX table of contents, but not in the LyX table of contents (
8734 ocument\SpecialChar \menuseparator
8746 \begin_layout Itemize
8751 document class appear in a skip separation mode, not indented.
8752 This is the standard behavior, no special LaTeX commands are needed for
8759 ocument\SpecialChar \menuseparator
8766 dialog the corresponding radio button indicates
8782 value always has the effect that extra LaTeX commands are inserted in the
8783 document to produce the gap, which is not what is wanted in this case.
8786 \begin_layout Section
8794 \begin_layout Standard
8800 \begin_layout Subsection
8804 \begin_layout Standard
8805 These are the layout files for some of the journal formats used by Springer
8806 Verlag and listed on
8807 \begin_inset LatexCommand url
8808 target "http://www.springer.de/author/tex/help-journals.html"
8812 , where you should also go to fetch the class files (yes, these are LaTeX2e
8814 It is a modular system: the things common to all journals are implemented
8819 , which journal-specific layout files (such as, e.\InsetSpace \thinspace{}
8824 for Journal of Geodesy) can include.
8827 \begin_layout Standard
8828 This means that implementing support for any other Springer journal on this
8829 list is as simple as writing your own
8837 file following the outline given in
8845 \begin_layout Standard
8846 It is reasonably well tested only for the Journal of Geodesy.
8855 come with the standard LyX distribution.
8856 Install the relevant class file (downloaded from Springer) in a proper
8857 directory, reconfigure LaTeX (in the teTeX case by running
8861 , as root if necessary --- doesn't LyX take care of this?), reconfigure
8862 LyX and it should work.
8865 \begin_layout Subsection
8869 \begin_layout Standard
8870 A large number of theorem-like styles ---
8876 \SpecialChar \ldots{}
8882 \begin_layout Standard
8885 Headnote, Dedication, Subtitle, Running_LaTeX_Title, Author_Running, Institute,
8886 Mail, Offprints, Keywords, Acknowledgements, Acknowledgement
8889 See the Springer class file documentation for details.
8892 \begin_layout Subsection
8896 \begin_layout Itemize
8908 \begin_layout Itemize
8911 Probability Theory and Related Fields
8917 --- Jean-Marc Lasgouttes
8920 \begin_layout Standard
8921 Add your own, it isn't so hard!
8924 \begin_layout Subsection
8928 \begin_layout Standard
8929 These files are partly based on the older
8933 , which was again based on a tinkered-with version of an old LaTeX 2.09 style
8939 layout, are now defunct.
8940 Jean-Marc Lasgouttes helped out big in making me find my way around the
8941 LyX layout file mechanism.
8944 \begin_layout Subsection
8948 \begin_layout Standard
8950 But probably less than in the old hacked-LaTeX
8957 \begin_layout Standard
8958 Limitations e.\InsetSpace \thinspace{}
8959 g.: does not display the number for theorem-like layouts, just
8963 \begin_layout Section
8971 \begin_layout Standard
8977 \begin_layout Subsection
8981 \begin_layout Standard
8982 These are the layout files for some of the journals of the American Geophysical
8984 It is assumed that you have both the AGU's own class files and AGUplus
8985 installed (everything to be found at
8986 \begin_inset LatexCommand url
8987 target "ftp://ftp.agu.org/journals/latex/journals"
8994 \begin_layout Subsection
8998 \begin_layout Standard
9008 They are still called this in the LyX GUI, though their LaTeX equivalents
9009 in the AGU classes are
9020 \begin_layout Standard
9021 Newly defined styles are
9058 These are mostly manuscript attributes and defined in the AGU class documentati
9062 \begin_layout Standard
9063 I suspect this is still badly incomplete.
9066 \begin_layout Subsection
9070 \begin_layout Standard
9087 \begin_layout Subsection
9091 \begin_layout Itemize
9094 Journal of Geophysical Research
9103 \begin_layout Standard
9104 Add your own, it isn't so hard! Look at the
9115 \begin_layout Subsection
9116 Bugs and things to remember
9119 \begin_layout Standard
9120 In order to use the new layouts, you must remember to do the following for
9124 \begin_layout Enumerate
9130 This can be done in the
9132 layout\SpecialChar \menuseparator
9137 document\SpecialChar \menuseparator
9141 (AGU articles are always in English, right? So
9148 \begin_layout Enumerate
9158 (Yes, this is a bug.)
9161 \begin_layout Enumerate
9162 Make sure you use the
9166 bibliography style, by entering
9170 into the second field of the BibTeX inset.
9171 None of the standard styles will do.
9174 \begin_layout Section
9182 \begin_layout Standard
9188 \begin_layout Subsection
9192 \begin_layout Standard
9193 This is the layout file for the European Geophysical Society journals.
9198 can be downloaded from the web site of the EGS under
9199 \begin_inset LatexCommand url
9200 target "www.copernicus.org"
9207 \begin_layout Subsection
9211 \begin_layout Standard
9214 Right_address, Latex_Title, Affil, Journal, msnumber, FirstAuthor, Received,
9222 The current layout file is unfortunately very unmodular and would benefit
9223 from using the various
9230 \begin_layout Section
9236 \begin_inset LatexCommand label
9244 \begin_layout Standard
9252 \begin_layout Subsection
9256 \begin_layout Standard
9257 This section describes how to use LyX to make slides for overhead projectors.
9258 There are two document classes that can do this: the default slides class
9264 This section documents the former.
9267 \begin_layout Standard
9268 I'm going to say this again, nice and clear, so that there's no misunderstanding
9272 \begin_layout Standard
9273 \begin_inset VSpace bigskip
9279 \begin_layout Standard
9283 This section documents the class
9284 \begin_inset Quotes eld
9292 \begin_inset Quotes erd
9300 \begin_layout Standard
9301 \begin_inset VSpace bigskip
9307 \begin_layout Standard
9308 If you're looking for the documentation for
9309 \begin_inset Quotes eld
9317 \begin_inset Quotes erd
9320 , check out section\InsetSpace ~
9322 \begin_inset LatexCommand ref
9323 reference "sec:foiltex"
9333 \begin_inset Quotes eld
9341 \begin_inset Quotes erd
9344 ] is actually somewhat better than the default
9352 \begin_layout Standard
9353 \SpecialChar \ldots{}
9354 or so I've been told repeatedly by its advocates.
9355 Having never used it, I have no idea if this claim is true or not.
9360 which this section documents.
9363 \begin_layout Standard
9364 This class is the LaTeX2e improvement of the old
9369 Every LaTeX2e distribution includes this class [which I'll just refer to
9371 \begin_inset Quotes eld
9379 \begin_inset Quotes erd
9382 from now on], so you're bound to have it.
9383 As I noted earlier, there are other classes, such as
9387 , which also produce slides for overhead projectors and do a better job
9389 However, there are some things which
9393 can do which the others can't, such as generate overlays.
9394 Read on to learn more!
9397 \begin_layout Subsection
9399 \begin_inset LatexCommand label
9400 name "sec:slidesetup"
9407 \begin_layout Standard
9408 Obviously, to use this document class, you need to select
9409 \begin_inset Quotes eld
9417 \begin_inset Quotes erd
9420 from the class list in the
9425 ocument\SpecialChar \menuseparator
9433 There are some other special things you should know about this class:
9436 \begin_layout Itemize
9437 Don't bother changing the options
9442 They're not supported by the
9449 \begin_layout Itemize
9458 behaves a bit differently for this class.
9459 The possible choices and what they do are as follows:
9463 \begin_layout Description
9468 The final output contains page numbers in the lower right corner.
9471 \begin_layout Description
9480 , but also prints out any time markers you've put in.
9481 This is the default.
9484 \begin_layout Description
9489 The final output contains no page numbers, time markers, or alignment markers.
9493 \begin_layout Itemize
9498 class has an extra option:
9504 \begin_inset Quotes eld
9512 \begin_inset Quotes erd
9515 in the extra class options.
9519 \begin_layout Standard
9520 Using this options allows you to add time markers to
9525 See section\InsetSpace ~
9527 \begin_inset LatexCommand ref
9528 reference "sec:slideNote"
9536 \begin_layout Standard
9537 You can also use the template file
9538 \begin_inset Quotes eld
9546 \begin_inset Quotes erd
9549 to automatically set up a document to use the
9558 ile\SpecialChar \menuseparator
9567 to open your new document].
9568 The template file also contains some examples of the special paragraph
9569 environments used by this class.
9570 I'll describe those next.
9573 \begin_layout Subsection
9574 Paragraph Environments
9577 \begin_layout Subsubsection
9578 Supported Environments
9581 \begin_layout Standard
9582 The first thing you'll notice when you start up a new
9586 document is the font size and type: it's the equivalent of the size
9587 \begin_inset Quotes eld
9595 \begin_inset Quotes erd
9604 This is also what's used in the output.
9606 \begin_inset Quotes eld
9610 \begin_inset Quotes erd
9613 to remind you that this is a slide.
9614 Your final slides will use a larger font; ergo, you'll have less space.
9615 Of course, the larger default screen font isn't WYSIWYG, only a reminder.
9618 \begin_layout Standard
9619 The next thing that becomes obvious is the changes to the paragraph environment
9620 pull-down box [at the far-left end of the toolbar].
9621 Most of the paragraph environments you're used to seeing are missing.
9622 There are also five new ones.
9627 class itself only supports certain paragraph environments:
9630 \begin_layout Itemize
9636 \begin_layout Itemize
9642 \begin_layout Itemize
9648 \begin_layout Itemize
9654 \begin_layout Itemize
9660 \begin_layout Itemize
9666 \begin_layout Itemize
9672 \begin_layout Itemize
9678 \begin_layout Itemize
9684 \begin_layout Itemize
9690 \begin_layout Itemize
9696 \begin_layout Standard
9697 All of the other standard environments, including the section-heading environmen
9698 ts, aren't used in the
9705 \begin_layout Standard
9706 On the other hand, you'll notice the following new environments:
9709 \begin_layout Itemize
9715 \begin_layout Itemize
9721 \begin_layout Itemize
9727 \begin_layout Itemize
9733 \begin_layout Itemize
9739 \begin_layout Standard
9740 These five are kind of quirky, due to a
9741 \begin_inset Quotes eld
9745 \begin_inset Quotes erd
9749 You see, LyX doesn't permit you to nest any other paragraph environment
9750 into an empty environment.
9751 Now, that's fine and dandy, but it means that you wouldn't be able to start
9752 a slide with anything except plain text.
9753 To deal with this, I've performed a little
9754 \begin_inset Quotes eld
9758 \begin_inset Quotes erd
9764 \begin_layout Subsubsection
9765 Quirks of the New Environments
9766 \begin_inset LatexCommand label
9767 name "sec:slideQuirk"
9774 \begin_layout Standard
9775 All five of the new paragraph environments are somewhat quirky due to inherent
9776 limitiations in the current version of LyX.
9777 As I just mentioned, LyX forbids environments that begin with another environme
9779 To get around this, the
9783 environment isn't a paragraph environment as described in the
9791 \begin_layout Standard
9805 \begin_inset Quotes eld
9808 pseudo-environments.
9809 \begin_inset Quotes erd
9812 They look like a section heading or a
9813 \begin_inset Quotes eld
9821 \begin_inset Quotes erd
9824 but really begin a [and, if necessary, end the previous] paragraph environment.
9834 \begin_inset Quotes eld
9838 \begin_inset Quotes erd
9841 These two perform some action.
9844 \begin_layout Standard
9845 A common feature of all five environments,
9865 , is a rather long-ish label.
9866 The text following this label --- ordinarily the contents of the paragraph
9867 environment --- is utterly irrelevant for
9888 LyX completely ignores it.
9889 In fact, you can leave these five environments completely empty.
9893 \begin_layout Standard
9898 to put any text after the rather long-ish label, you might want to.
9899 This could be a short description of the contents of the
9904 In that case, enter in your descriptive comment and hit
9908 as you normally would.
9911 \begin_layout Standard
9912 If, on the other hand, you don't want to enter in any descriptive text,
9913 you'll hit another LyX quirk.
9914 LyX, like nature, abhors a vacuum, and will not let you start a new paragraph
9915 environment until you put something in the old one.
9919 \begin_layout Itemize
9920 Start entering the text that will
9948 \begin_layout Itemize
9949 Now move to the beginning of that paragraph.
9953 \begin_layout Itemize
9962 \begin_layout Itemize
9963 Finally, change this new, empty paragraph to a
9987 \begin_layout Standard
9988 Some future version of LyX will, hopefully, resolve this quirkiness\SpecialChar \ldots{}
9992 \begin_layout Subsection
9993 Making a Presentation with
10006 \begin_layout Subsubsection
10014 \begin_layout Standard
10015 If you're expecting this section to teach you how to actually make a presentatio
10016 n, you'll be sorely disappointed.
10017 Naturally, I'll describe all of the ways the
10021 class can assist you in preparing the materials for a presentation.
10022 Filling in the contents, however, is up to you.
10027 the LyX philosophy.]
10030 \begin_layout Standard
10035 environment [in the manner described in section\InsetSpace ~
10037 \begin_inset LatexCommand ref
10038 reference "sec:slideQuirk"
10042 ] tells LyX to begin a new slide [duh].
10043 The label for this environment/
10044 \begin_inset Quotes erd
10048 \begin_inset Quotes erd
10052 \begin_inset Quotes eld
10056 \begin_inset Quotes erd
10059 in cool blue, followed by the label,
10060 \begin_inset Quotes eld
10064 \begin_inset Quotes erd
10068 Any text or paragraph environments that follow this one go on the new slide.
10072 \begin_layout Standard
10073 Slides are probably the only time you'll need to forcibly end pages in LyX
10074 (this can be specified in the
10079 In fact, you'll want to, once you finish entering the contents of one slide.
10080 If you've entered more text than can physically fit on a slide, the extra
10081 overflows onto a new slide.
10082 I don't recommend doing this, however, since the overflow slide won't have
10083 any page number on it.
10084 Furthermore, it may interfere with any
10088 you've made to accompany the oversized
10095 \begin_layout Standard
10104 environments work the same way as the
10109 They both create an
10110 \begin_inset Quotes eld
10114 \begin_inset Quotes erd
10117 followed by a label [
10118 \begin_inset Quotes eld
10122 \begin_inset Quotes erd
10126 \begin_inset Quotes eld
10130 \begin_inset Quotes erd
10134 The color is a stunning magenta instead of blue, and the
10135 \begin_inset Quotes eld
10139 \begin_inset Quotes erd
10142 will look different, in style and in length.
10143 The label fonts of all three also differ from one another.
10146 \begin_layout Standard
10151 , if the contents of a
10159 exceed the physical size of a slide or sheet of paper, the extra will overflow
10161 Again, you should avoid this.
10162 It defeats the whole purpose of
10173 \begin_layout Subsubsection
10183 \begin_layout Standard
10188 is a slide that sits atop another slide.
10189 Perhaps you wish to discuss a figure on the main
10193 before displaying the text associated with it.
10194 One way to accomplish this is tape a flap of dark paper over the part of
10199 you want to display later.
10200 This method fails, however, if you wish to overlap one graph with another,
10202 You would then have to fumble while speaking to align the two separate,
10207 s to align the two graphs.
10212 environment in both cases makes life much easier.
10215 \begin_layout Standard
10220 receives the page number of its
10221 \begin_inset Quotes eld
10225 \begin_inset Quotes erd
10233 \begin_inset Quotes eld
10241 \begin_inset Quotes erd
10248 \begin_layout Standard
10249 Presumably, mutliple
10254 \begin_inset Quotes eld
10262 \begin_inset Quotes erd
10266 \begin_inset Quotes eld
10274 \begin_inset Quotes erd
10278 \begin_inset Quotes eld
10286 \begin_inset Quotes erd
10289 , etc.\InsetSpace ~
10290 appended to the page number of the parent
10300 Clearly, you want the contents of both the
10308 to each fit on a single physical slide! You should probably consider an
10314 \begin_inset Quotes eld
10318 \begin_inset Quotes erd
10330 class provides a visual cue for this: the label at the start of an
10334 is shorter than that at the start of a
10339 Lastly, when you generate printable output, you'll find alignment markers
10340 in all four corners of both the
10344 page and its parent
10349 These will assist you in lining up the two physical slides.
10352 \begin_layout Standard
10353 The major problem in overlaying two slides is aligning the contents of the
10354 two transparencies.
10355 How much space should you leave for that graph on the second slide? Worse
10356 still, what if you want a graph and a sentence on second slide, but there
10357 is text on the main transparency that goes in between them? You could try
10358 and insert vertical space of the right size.
10359 The better way is to use
10370 \begin_layout Standard
10371 As their names imply,
10379 are two command-like paragraph environments that make all subsequent text
10380 invisible and visible, respectively.
10381 Note from section\InsetSpace ~
10383 \begin_inset LatexCommand ref
10384 reference "sec:slideQuirk"
10388 that you don't place anything
10392 these two environments, however.
10397 , it inserts a centered, sky-blue label into the page reading
10398 \begin_inset Quotes eld
10401 <Invisible Text Follows>
10402 \begin_inset Quotes erd
10406 For paragraphs following this label, the parts of the
10414 ; it doesn't matter which] where they would be contain instead blank space.
10418 \begin_layout Standard
10423 , the corresponding centered label is
10424 \begin_inset Quotes eld
10427 <Visible Text Follows>
10428 \begin_inset Quotes erd
10432 Paragraphs following this label behave normally.
10433 Note that the beginning of a new
10445 automatically shuts off an
10450 It's therefore not necessary to use
10461 \begin_layout Standard
10462 By now, it should be obvious how to create overlay transparencies using
10463 the proper combination of
10482 \begin_layout Enumerate
10487 , including everything that will appear on it, whether on the main slide
10495 \begin_layout Enumerate
10496 Before each figure or paragraph that will appear only on the
10505 If necessary, insert a
10509 environment after the
10516 \begin_layout Enumerate
10521 immediately following the
10528 \begin_layout Enumerate
10529 Copy the contents of this
10540 \begin_layout Enumerate
10545 , change all of the
10556 \begin_layout Standard
10558 You've just made an
10565 \begin_layout Standard
10566 There's one problem with the way I've designed the LyX
10570 class: you can't make text in the middle of a paragraph invisible, nor
10571 make text in the middle of an invisible paragraph visible again.
10572 To accomplish this feat, you'll need to use some inlined LaTeX codes.
10576 \begin_layout Standard
10577 The commands of interest are:
10580 \begin_layout Itemize
10585 invisible \SpecialChar \ldots{}
10589 \begin_layout Itemize
10594 visible \SpecialChar \ldots{}
10598 \begin_layout Standard
10599 \SpecialChar \ldots{}
10600 and need to be marked as TeX.
10602 \begin_inset Quotes eld
10606 \begin_inset Quotes erd
10609 you wish to change goes in between the brackets [and after the
10622 If you don't know how to mark text as TeX, see the appropriate section
10635 \begin_layout Subsubsection
10645 \begin_inset LatexCommand label
10646 name "sec:slideNote"
10653 \begin_layout Standard
10662 is associated with a
10663 \begin_inset Quotes eld
10667 \begin_inset Quotes erd
10679 class provides visual cues.
10684 is shorter than that of a
10688 [yet longer than that of an
10692 ] and, like the label of an
10696 is shockingly magenta.
10697 Additionally, the printed
10701 has the page number of its
10702 \begin_inset Quotes eld
10706 \begin_inset Quotes erd
10714 \begin_inset Quotes eld
10722 \begin_inset Quotes erd
10726 \begin_inset Quotes eld
10734 \begin_inset Quotes erd
10738 \begin_inset Quotes eld
10746 \begin_inset Quotes erd
10750 You can have multiple
10754 s associated with a single
10766 , you'll probably want to break up long
10770 s so that they fit on a single sheet of paper.
10773 \begin_layout Standard
10778 is obvious: it contains anything additional you might want to say about
10784 It could also be used as a sheet of reminders for a particular
10789 In the case of the latter, you might want to make use of time markers.
10795 \begin_inset Quotes eld
10799 \begin_inset Quotes erd
10802 support for time markers, a
10807 So, you'll have to resort to using the LaTeX codes.
10810 \begin_layout Standard
10811 To use time markers, you'll need to specify the extra class option
10812 \begin_inset Quotes eld
10820 \begin_inset Quotes erd
10823 [see section\InsetSpace ~
10825 \begin_inset LatexCommand ref
10826 reference "sec:slidesetup"
10831 This option turns on timing marks, which will appear in the lower-left-hand
10837 To set what appears in the time marker, you use the LaTeX commands
10838 \begin_inset Quotes eld
10848 \begin_inset Quotes erd
10852 \begin_inset Quotes eld
10862 \begin_inset Quotes erd
10866 The arguments of both commands are time measured in seconds.
10868 \begin_inset Quotes eld
10878 \begin_inset Quotes erd
10881 sets the time marker to a given time.
10883 \begin_inset Quotes eld
10893 \begin_inset Quotes erd
10896 increments the time marker by the specified amount.
10897 Using time markers and
10901 s in this fashion, you can remind yourself how much time to spend on a particula
10909 \begin_layout Standard
10910 There's one last feature to describe.
10911 Clearly, you'd like to print out all of your
10919 s on transparencies while printing all of your
10936 with which it is associated.
10937 What's a person to do?
10940 \begin_layout Standard
10941 Luckily, there are two LaTeX commands that allow you to select what to print
10943 Both must be placed into the preamble of your document.
10945 \begin_inset Quotes eld
10957 \begin_inset Quotes erd
10960 will cause the output to contain only the
10969 Correspondingly, the command
10970 \begin_inset Quotes eld
10982 \begin_inset Quotes erd
10985 prevents the output of anything but
10990 I'd advise placing both commands in the preamble and initially comment
10992 You can then preview your entire presentation as you write.
10993 When you're done writing, you can then uncomment one of the two to select
10994 what you want to print.
10995 I like to uncomment
10996 \begin_inset Quotes eld
11008 \begin_inset Quotes erd
11011 , print to a file with
11012 \begin_inset Quotes eld
11020 \begin_inset Quotes erd
11023 in its name, comment it back out, then uncomment
11024 \begin_inset Quotes eld
11036 \begin_inset Quotes erd
11040 \begin_inset Quotes eld
11048 \begin_inset Quotes erd
11052 I can then send either file to a printer, loading transparencies or plain
11053 paper as appropriate.
11056 \begin_layout Standard
11057 You can also provide other arguments to the
11058 \begin_inset Quotes eld
11068 \begin_inset Quotes erd
11072 \begin_inset Quotes eld
11082 \begin_inset Quotes erd
11086 See a good LaTeX book for details.
11089 \begin_layout Subsection
11094 Class Template File
11097 \begin_layout Standard
11098 I have also provided a template file,
11099 \begin_inset Quotes eld
11107 \begin_inset Quotes erd
11115 To use it, begin your new presentation with
11120 ile\SpecialChar \menuseparator
11130 Your new LyX presentation file will contain an example
11151 additionally contain an example of the use of
11160 Lastly, the preamble will contain:
11163 \begin_layout LyX-Code
11164 % Uncomment to print out only slides and overlays
11167 \begin_layout LyX-Code
11171 \begin_layout LyX-Code
11181 \begin_layout LyX-Code
11182 % Uncomment to print out only notes
11185 \begin_layout LyX-Code
11189 \begin_layout LyX-Code
11197 \begin_layout Standard
11198 One final thing: I created this class to support the LaTeX2e
11199 \begin_inset Quotes eld
11207 \begin_inset Quotes erd
11210 class, one of the built-in LaTeX2e classes.
11211 Neither I nor the rest of the LyX Team endorse or oppose the use of this
11212 built-in slide class.
11213 It's here if you want it or need it.
11214 There exist other LaTeX2e classes for creating presentations, such as the
11219 class [see section\InsetSpace ~
11221 \begin_inset LatexCommand ref
11222 reference "sec:foiltex"
11227 \begin_inset Quotes eld
11235 \begin_inset Quotes erd
11238 package [present on some TeX distributions].
11239 The latter is not yet supported under LyX.
11243 \begin_layout Standard
11244 Perhaps you can take on the task\SpecialChar \ldots{}
11250 I know nothing about these other classes.
11251 Try them out to see what sort of alternative they provide.
11254 \begin_layout Section
11263 \begin_inset LatexCommand label
11271 \begin_layout Standard
11277 \begin_layout Subsection
11281 \begin_layout Standard
11282 This section describes how to use LyX to make slides for overhead projectors.
11283 There are two document classes that can do this: the default slides class
11289 This section documents the latter.
11292 \begin_layout Standard
11293 I'm going to say this again, nice and clear, so that there's no misunderstanding
11297 \begin_layout Standard
11298 \begin_inset VSpace bigskip
11304 \begin_layout Standard
11308 This section documents the class
11309 \begin_inset Quotes eld
11317 \begin_inset Quotes erd
11325 \begin_layout Standard
11326 \begin_inset VSpace bigskip
11332 \begin_layout Standard
11333 If you're looking for the documentation for
11334 \begin_inset Quotes eld
11342 \begin_inset Quotes erd
11345 , check out section\InsetSpace ~
11347 \begin_inset LatexCommand ref
11348 reference "sec:slitex"
11353 If your machine doesn't have the
11358 \begin_inset Quotes eld
11366 \begin_inset Quotes erd
11369 ] installed, you'll probably have to use the default
11373 class, which isn't quite as good as
11378 \begin_layout Standard
11383 class is designed for use with version 2.1 of the
11387 LaTeX class file which is now an integral part of LaTeX2e.
11390 \begin_layout Subsection
11394 \begin_layout Standard
11395 Obviously, to use this document class, you need to select
11396 \begin_inset Quotes eld
11404 \begin_inset Quotes erd
11416 Document\InsetSpace ~
11420 There are some settings in the
11422 Document\InsetSpace ~
11425 dialog that you should know about that are specific to this class:
11428 \begin_layout Itemize
11429 Don't change the options
11439 Document\InsetSpace ~
11443 They're ignored by the
11450 \begin_layout Itemize
11451 The default font size is 20pt with the other options being 17pt, 25pt and
11455 \begin_layout Itemize
11456 The default font is
11464 but all math equations are still typeset in the usual roman font.
11467 \begin_layout Itemize
11472 TeX supports A4 and Letter paper sizes as well as a special size for working
11474 It doesn't support A5, B5, legal or executive paper sizes.
11477 \begin_layout Itemize
11478 Don't bother changing the
11482 settings because they are ignored anyway.
11483 All floats appear where they are defined in the text.
11486 \begin_layout Itemize
11494 setting behaves a bit differently for this class.
11499 TeX provides extensive footer and header capabilities including a user-defined
11501 See section\InsetSpace ~
11503 \begin_inset LatexCommand ref
11504 reference "sec:foilfoot"
11509 The title page is treated differently to all other pages in the document
11518 has the logo centered at the bottom of the page (if one is defined).
11519 The possible page style choices and what they do are as follows:
11524 \labelwidthstring MMMMMMM
11531 The final output contains no page numbers, or other headers or footers
11532 (except footnotes of course).
11537 \labelwidthstring MMMMMMM
11544 The final output contains page numbers centered at the bottom of the page.
11545 No other headings or footers (other than footnotes).
11549 \labelwidthstring MMMMMMM
11554 Page numbers in lower right corner.
11555 Additional headers and footers are also shown.
11556 This is also the default.
11560 \labelwidthstring MMMMMMM
11565 Gives you access to the
11569 package although its use with
11573 TeX is discouraged by the writer of the
11577 TeX package because of some potential page layout clashes.
11581 \begin_layout Subsubsection
11585 \begin_layout Standard
11586 The following options may be used in the extra class options in the
11591 ocument\SpecialChar \menuseparator
11602 \labelwidthstring MMMMMMx
11607 This sets up the page layout for 7.33in by 11in paper, which is about the
11608 same aspect ratio as a 35mm slide, making it a bit easier to work with
11613 \labelwidthstring MMMMMMx
11618 Places a rule across the page below the header on every page except the
11623 \labelwidthstring MMMMMMx
11628 Places a rule across the page above the footer on every page except the
11633 \labelwidthstring MMMMMMx
11638 This is automatically set each time you create a new
11647 TeX to use the dvips driver to rotate those pages that are set as landscape
11652 \labelwidthstring MMMMMMx
11657 Simply changes the page dimensions to those of a landscape page but doesn't
11659 Thus if you use this option you need to use an external program to rotate
11660 each page or feed your paper through your printer as landscape.
11661 Note that this option effectively reverses the roles of the
11669 environments (don't worry these are described in the next section).
11673 \labelwidthstring MMMMMMx
11678 Equation numbers on the left.
11682 \labelwidthstring MMMMMMx
11687 Flush-left equations.
11690 \begin_layout Subsection
11691 Supported Environments
11694 \begin_layout Standard
11695 Most of the environments commonly supported in other classes are also supported
11701 There are several additional environments provided by
11705 TeX as well as a couple added by LyX.
11706 The following environments are shared with other classes:
11709 \begin_layout Standard
11713 \begin_layout Standard
11717 begin{multicols}{2}
11725 \begin_layout Itemize
11731 \begin_layout Itemize
11737 \begin_layout Itemize
11743 \begin_layout Itemize
11749 \begin_layout Itemize
11755 \begin_layout Itemize
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 Itemize
11833 \begin_layout Standard
11837 \begin_layout Standard
11849 \begin_layout Standard
11850 That is, all the major environments apart from the sectioning environments.
11851 Since foils are essentially self-contained sections, with a title and body,
11856 TeX provides specific commands for starting new foils and these are:
11859 \begin_layout Itemize
11865 \begin_layout Itemize
11871 \begin_layout Standard
11872 LyX also provides slightly modified versions of these two environments called:
11875 \begin_layout Itemize
11881 \begin_layout Itemize
11884 ShortRotatefoilhead
11887 \begin_layout Standard
11888 and the differences will be explained in the next section.
11891 \begin_layout Standard
11892 Since foils are often used in presenting ideas or new theorems and such
11897 TeX also provides a comprehensive box of goodies for presenting them:
11900 \begin_layout Standard
11904 \begin_layout Standard
11908 begin{multicols}{2}
11916 \begin_layout Itemize
11922 \begin_layout Itemize
11928 \begin_layout Itemize
11934 \begin_layout Itemize
11940 \begin_layout Itemize
11946 \begin_layout Itemize
11952 \begin_layout Itemize
11958 \begin_layout Itemize
11964 \begin_layout Itemize
11970 \begin_layout Itemize
11976 \begin_layout Itemize
11982 \begin_layout Standard
11986 \begin_layout Standard
11998 \begin_layout Standard
11999 The starred versions are unnumbered while the unstarred versions are numbered.
12000 There are also two list environments added by LyX and these are:
12003 \begin_layout Itemize
12009 \begin_layout Itemize
12015 \begin_layout Standard
12020 TeX provides some powerful header and footer capabilities that are best
12021 set in the preamble although they may be set at any point in a document.
12022 If you want to change these settings in your document the best place to
12023 do so is at the very top of a foil,
12028 straight after the foilhead.
12031 \begin_layout Standard
12032 For this purpose, the following command styles are provided [
12039 \begin_layout Standard
12043 \begin_layout Standard
12047 begin{multicols}{2}
12055 \begin_layout Itemize
12062 \begin_layout Itemize
12068 \begin_layout Itemize
12075 \begin_layout Itemize
12082 \begin_layout Itemize
12090 \begin_layout Standard
12096 \begin_layout Standard
12100 \begin_layout Standard
12112 \begin_layout Standard
12113 There are also a few commands provided by
12117 TeX that aren't directly supported by LyX but I'll tell you what they do
12118 and how to use them in section\InsetSpace ~
12120 \begin_inset LatexCommand ref
12121 reference "sec:unsuppfoils"
12128 \begin_layout Subsection
12129 Building a Set of Foils
12132 \begin_layout Standard
12133 This section will give a simple introduction to using the different environments
12134 to build a set of foils.
12135 If you want to see an example set of foils take a look at the
12139 file accessible from the
12144 ile\SpecialChar \menuseparator
12149 pen\SpecialChar \ldots{}
12160 \begin_layout Subsubsection
12161 Give It a Title Page
12164 \begin_layout Standard
12165 Unlike other classes that provide
12185 creates the title on a page of its own.
12186 If you leave out the
12190 environment LaTeX will substitute the current date (every time you regenerate
12194 \begin_layout Subsubsection
12198 \begin_layout Standard
12199 As I mentioned earlier, there are four ways of starting a new foil.
12200 For portrait foils you should use
12209 The difference between these two environments is the amount of space between
12210 the title of the foil (the foilhead) and the body of the foil.
12213 \begin_layout Standard
12214 Landscape foils are generated using the
12220 ShortRotatefoilhead
12223 Again the only difference is the spacing between foilhead and body.
12224 Both of the short versions have 0.5 inches less separation between the foilhead
12229 \begin_layout Standard
12230 One problem with the support for landscape foils is the requirement that
12231 you have to use the
12235 driver to generate the PostScript output otherwise the foils won't be rotated.
12236 It is possible to get landscape foils even if you haven't got the
12240 driver provided you can feed your foils sideways through your printer ;-)
12243 \begin_layout Subsubsection
12244 Theorems, Lemmas, Proofs and more
12247 \begin_layout Standard
12248 Due to a small bug in LyX you can't have two of the same type of these environme
12249 nts directly following each other.
12250 They must be separated by something.
12251 If you try, you will just be extending the previous environment as if you
12252 had merged the two environments together.
12253 So, how do you get around this problem? The simplest option is to insert
12254 some text between the two environments or add a
12258 environment between the two with just a
12259 \begin_inset Quotes eld
12267 \begin_inset Quotes erd
12271 This will force LyX to produce two separate environments and hence the
12272 correct LaTeX output.
12273 An example is provided in the example file included with the LyX distribution.
12274 Remember, this problem only occurs if you are trying to place two of the
12275 same type of theorem-like environments one directly after the other.
12278 \begin_layout Subsubsection
12282 \begin_layout Standard
12283 You get all the commonly supported list styles found in other classes as
12284 well as two new ones.
12285 I'll only describe the new ones here.
12286 If you want to find out more about the other list environments check out
12292 If you intend to use itemized lists you might also want to read about the
12295 Itemize\InsetSpace ~
12296 Bullet\InsetSpace ~
12299 dialog described above in section\InsetSpace ~
12301 \begin_inset LatexCommand ref
12302 reference "sec:bullet"
12309 \begin_layout Standard
12310 The two new list styles,
12318 , are designed to make it easier for you to create lists of do's and don'ts
12319 or right and wrong by providing dedicated environments that use a tick
12320 or a cross as the label of the list.
12321 These lists are in fact dedicated variants of the
12326 They do however require that you have the
12330 packages installed.
12333 \begin_layout Subsubsection
12337 \begin_layout Standard
12342 TeX redefines the floating tables and figures so that they appear exactly
12343 where they are in the text rather than pushing them to the top of the page
12344 or to some user specified location.
12345 In fact if you change the float placement settings they are simply ignored.
12348 \begin_layout Subsubsection
12349 Page Headers and Footers
12350 \begin_inset LatexCommand label
12351 name "sec:foilfoot"
12358 \begin_layout Standard
12368 are two commands used to control the left-footer text string.
12369 The first is meant to allow you to include a graphic logo on your foils
12371 \begin_inset Quotes eld
12379 \begin_inset Quotes erd
12383 While the second is meant to provide a classification for the audience,
12386 e.\InsetSpace \thinspace{}
12391 It is empty by default.
12394 \begin_layout Standard
12395 The remaining page corners can be filled by
12400 (which defaults to page numbers),
12413 \begin_layout Subsection
12419 \begin_inset LatexCommand label
12420 name "sec:unsuppfoils"
12427 \begin_layout Standard
12428 All the commands mentioned below need to be set in a
12436 within another environment.
12439 \begin_layout Subsubsection
12443 \begin_layout Standard
12444 All lengths are adjusted using the
12467 should be replaced by the name given to the length you want to change and
12472 is the length value.
12473 All lengths should be specified in units of length such as inches (
12485 ) or relative to some document or font-based length such as
12495 \begin_layout Standard
12496 It's possible to change the spacing between a foilhead and the body of the
12497 foil by adjusting the length specified by
12504 For example, to make
12508 foilheads 0.5 inches closer to their bodies put the following in the preamble:
12515 foilheadskip}{-0.5in}
12518 \begin_layout Standard
12519 The spacings around floats can be adjusted by setting these lengths:
12523 \labelwidthstring MMMMMMMMMMM
12530 Separation between the text and the top of the float
12534 \labelwidthstring MMMMMMMMMMM
12541 Separation between the float and the caption
12545 \labelwidthstring MMMMMMMMMMM
12552 Separation between the caption and the following text
12556 \labelwidthstring MMMMMMMMMMM
12563 You can make the captions narrower than the surrounding text by adjusting
12565 Best done relative to
12574 \begin_layout Standard
12575 There are also several title page related lengths that you may find useful
12576 if you have a long title or several authors:
12580 \labelwidthstring MMMMMMMMMMM
12587 Separation from headers to
12593 \labelwidthstring MMMMMMMMMMM
12612 \labelwidthstring MMMMMMMMMMM
12627 \labelwidthstring MMMMMMMMMMM
12644 \labelwidthstring MMMMMMMMMMM
12660 \begin_layout Standard
12661 The last length related command affects all the list environments.
12672 a list environment then all the vertical spacing between the list items
12674 Note that this is a command not a length so it doesn't require
12680 like the stuff mentioned above.
12683 \begin_layout Subsubsection
12684 Headers and Footers
12687 \begin_layout Standard
12700 commands control whether the logo in the
12704 definition appear on a given page.
12711 in the preamble then none of the foils will have the logo on them.
12712 If you don't want the logo on a particular page place the
12718 directly after the foilhead of that page and the
12724 directly after the next foilhead.
12727 \begin_layout Standard
12728 If you decide to use the
12732 page style setting in the
12734 Document\InsetSpace ~
12737 dialog you should probably add
12747 to your preamble so headers and footers on landscape pages are correctly
12748 placed when rotated.
12749 This is due to some clashes between the page layouts provided by the
12760 \begin_layout Section
12761 Latex8 (IEEE Conference Papers)
12764 \begin_layout Standard
12770 \begin_layout Subsection
12774 \begin_layout Standard
12775 Since this class is specifically for writing submissions to IEEE sponsored
12776 conferences I strongly recommend that you get a copy of their Authors Kit.
12781 package and associated bibliography style file is included in the kit.
12782 The Authors Kit is usually sent out by email once your initial submission
12784 There is a lot of useful information in the Authors Kit explaining formatting
12785 restrictions and so on and I will assume you have read this since that
12786 means I don't have to repeat it all here.
12789 \begin_layout Subsection
12793 \begin_layout Standard
12794 [AR\SpecialChar \@.
12798 \begin_layout Subsection
12799 Supported Environments
12802 \begin_layout Itemize
12808 \begin_layout Itemize
12814 \begin_layout Itemize
12820 \begin_layout Itemize
12826 \begin_layout Itemize
12832 \begin_layout Itemize
12838 \begin_layout Itemize
12844 \begin_layout Itemize
12850 \begin_layout Itemize
12856 \begin_layout Subsection
12857 Differences Between Screen and Paper
12860 \begin_layout Standard
12861 There are slight differences in appearance mainly with the presentation
12862 of section counters.
12863 On screen the trailing period of the section counter is missing but it
12864 will appear in the output so don't let this worry you.
12867 \begin_layout Section
12868 Hollywood (Hollywood spec scripts)
12871 \begin_layout Standard
12877 \begin_layout Subsection
12881 \begin_layout Standard
12882 Getting the format of a Hollywood script right is a
12883 \begin_inset Quotes eld
12887 \begin_inset Quotes erd
12890 It is designed to make the readers focus on content and to be easy and
12891 familiar for the actors to read.
12892 Each page of a script should be one minute of film.
12893 Nothing goes in a script that you cannot see or hear on screen.
12894 The courier 12 pt font should be used throughout.
12898 \begin_layout Subsection
12902 \begin_layout Standard
12903 Speakers' lines should NEVER break in mid-sentence.
12904 If a speaker's lines continue over a page break, repeat the
12908 title followed by (Cont'd).
12911 \begin_layout Subsection
12915 \begin_layout Standard
12920 names as labels then cross-reference the label to insert the name.
12921 The cross-reference dialog will show the current cast of characters.
12922 You can use this to insert the speaker name in narratives also.
12925 \begin_layout Subsection
12926 Paper size and Margins
12929 \begin_layout Standard
12930 USLetter, left 1.6in, right 0.75in, top 0.5in, bottom 0.75in
12933 \begin_layout Subsection
12937 \begin_layout Standard
12938 The following environments are available.
12939 You can use hollywood.bind to get the bind keys shown at the right.
12942 \begin_layout Itemize
12949 Used where nothing else works.
12953 \begin_layout Itemize
12966 Usually followed by something like
12967 \begin_inset Quotes eld
12970 on Sally waking up.
12971 \begin_inset Quotes erd
12977 \begin_layout Itemize
12986 Introduces a new INTERIOR camera set-up.
12987 Always followed by DAY or NIGHT, or something similar to define the lighting
12989 Everthing on this line in CAPS.
12992 \begin_layout Itemize
13001 Introduces a new EXTERIOR camera set-up.
13002 Everthing on this line in CAPS.
13005 \begin_layout Itemize
13014 The character speaking.
13017 \begin_layout Itemize
13026 Instructions to the speaker.
13027 The () are automatically inserted, but only the ( will show in LyX.
13028 Both will be printed.
13031 \begin_layout Itemize
13047 \begin_layout Itemize
13056 Camera movement instruction.
13057 e.\InsetSpace \thinspace{}
13062 \begin_layout Itemize
13070 \begin_layout Itemize
13078 \begin_layout Itemize
13086 \begin_layout Itemize
13094 \begin_layout Subsection
13098 \begin_layout Itemize
13099 (O.S) --- off screen
13102 \begin_layout Itemize
13103 (V.0) --- voice over
13106 \begin_layout Itemize
13111 \begin_layout Itemize
13116 \begin_layout Itemize
13117 PAN --- camera movement
13120 \begin_layout Itemize
13121 INSERT --- cut to close-up of
13124 \begin_layout Section
13128 \begin_layout Standard
13134 \begin_layout Subsection
13138 \begin_layout Standard
13139 Broadway is for writing plays.
13140 The format is more decorative than Hollywood, and much less standardized.
13141 This format should be suitable for workshops.
13144 \begin_layout Subsection
13148 \begin_layout Standard
13149 The same as in Hollywood.
13152 \begin_layout Subsection
13156 \begin_layout Standard
13161 names as labels then cross-reference the label to insert the name.
13162 The cross-reference dialog will show the current cast of characters.
13165 \begin_layout Subsection
13166 Paper size and Margins
13169 \begin_layout Standard
13170 USLetter, left 1.6in, right 0.75in, top 0.5in, bottom 0.75in
13173 \begin_layout Subsection
13177 \begin_layout Standard
13178 The following environments are available.
13179 You can use broadway.bind to get the bind keys shown at the right.
13182 \begin_layout Itemize
13189 You should not have to use this, but it is here for anything that does not
13193 \begin_layout Itemize
13202 Used to describe stage setting and the action.
13203 First use of speaker names in all CAPs.
13206 \begin_layout Itemize
13215 Automatically numbered.
13216 On screen it will be arabic, but will print as Roman.
13219 \begin_layout Itemize
13233 It is just centered text.
13236 \begin_layout Itemize
13245 Not automatically numbered.
13246 You supply the number.
13247 This is because I couldn't figure out how.
13250 \begin_layout Itemize
13259 A special case of Narrative to describe the setting and action as the curtain
13263 \begin_layout Itemize
13272 The speaker's (actor's) title, centered in all CAPS.
13275 \begin_layout Itemize
13284 Instructions to the speaker.
13285 The parentheses are automatically inserted.
13286 The ( will appear on screen, but both will be in the printed play.
13287 This environment is only used within
13294 \begin_layout Itemize
13303 What the Speaker says.
13306 \begin_layout Itemize
13315 The curtain comes down.
13318 \begin_layout Itemize
13326 \begin_layout Itemize
13334 \begin_layout Itemize
13342 \begin_layout Standard
13346 \begin_layout Section
13350 \begin_layout Standard
13356 \begin_layout Standard
13357 \begin_inset VSpace bigskip
13363 \begin_layout Standard
13367 Revtex\InsetSpace ~
13370 textclass works with the American Physical Sociey's RevTeX 4.0 (the
13371 \begin_inset Formula $\beta$
13374 release of May, 1999) class.
13377 \begin_layout Standard
13382 textclass, which works with RevTeX 3.1.
13383 However, v3.1 is basically obsolete, as it works with LaTeX 2.09.
13384 That means that it doesn't interact very well with LyX, which requires
13385 LaTeX2e, although it has been kludged to work.
13386 Since RevTeX 4.0 has been designed to work much more cleanly with LaTeX2e,
13389 RevTeX\InsetSpace ~
13392 textclass should also be pretty easy to use.
13395 \begin_layout Standard
13396 These documents are supposed to be used in
13400 to the RevTeX 4.0 documents, so we don't describe any of the special RevTeX
13401 macros, and assume you'll know what to put in the preamble if necessary.
13404 \begin_layout Subsection
13408 \begin_layout Standard
13409 All you need to do is install RevTeX 4, as described in the package's README
13411 The package can be found at
13412 \begin_inset LatexCommand url
13413 name "The RevTeX 4 Web Site"
13414 target "http://publish.aps.org/revtex4/"
13419 Install it somewhere that LaTeX can see it.
13420 Test it by trying to LaTeX a short RevTeX 4 document in some random directory
13421 (i.e., not the directory where you installed the class file.) Then, if you
13422 reconfigure LyX, it will find the class file and let you use the RevTeX4
13426 \begin_layout Standard
13427 Probably the easiest way to get started is either to import a RevTeX 4 document
13434 Revtex\InsetSpace ~
13437 template, found in the templates directory.
13440 \begin_layout Subsection
13444 \begin_layout Standard
13445 Optional arguments to
13452 \begin_inset Quotes eld
13456 \begin_inset Quotes erd
13460 \begin_inset Quotes eld
13464 \begin_inset Quotes erd
13478 Document\InsetSpace ~
13482 Remember that in RevTeX, at least one optional argument is required!
13485 \begin_layout Standard
13486 Other preamble matter, like
13502 dialog, also as usual.
13505 \begin_layout Subsection
13509 \begin_layout Standard
13510 The layouts basically correspond to the commands in RevTeX4.0.
13511 For example, the Email layout corresponds to
13518 Note that (at least as of RevTeX 4.0 Beta), the
13526 layouts are exactly equivalent, so you shouldn't need to use both.
13530 \begin_layout Standard
13531 In case you're curious, both were included so that
13535 would be able to translate both
13555 \begin_layout Subsection
13559 \begin_layout Standard
13560 There are a couple of important unique aspects of RevTeX 4 which might cause
13561 bugs that will be even more confusing in LyX.
13564 \begin_layout Standard
13582 The LyX equivalent is that there is a separate Thanks layout.
13587 write footnotes in the
13591 layout, or weird things may happen.
13592 See the RevTeX 4 documentation for more details.
13595 \begin_layout Standard
13598 Author\InsetSpace ~
13603 Author\InsetSpace ~
13610 layouts must be placed
13618 layout and the corresponding
13635 , the LaTeX won't compile.
13638 \begin_layout Subsection
13642 \begin_layout Standard
13643 The main problem with this layout is that you can't use the optional arguments
13644 to layouts like Email and Title.
13645 (The problem is not unique to this layout; you can't use optional arguments
13646 to the Section layouts either.) This means that after you export that file
13647 to LaTeX (which you'll need to do eventually to send it in to APS), you'll
13648 need to edit the LaTeX file with a text editor to add the optional arguments
13649 to set, e.\InsetSpace \thinspace{}
13650 g., the running title for the page headers.
13651 Lacking these layouts makes the
13657 (and the equivalent
13663 ) useless, so the corresponding layouts don't exist, and will have to be
13668 \begin_layout Standard
13673 actually, LyX 1.3.0 supports some forms of optional arguments, but this layout
13674 has not been updated yet to take advantage of it.
13682 \begin_layout Section
13683 Article (mwart), book (mwbk) and report (mwrep)
13684 \begin_inset OptArg
13687 \begin_layout Standard
13700 \begin_layout Standard
13706 \begin_layout Standard
13707 The LyX document classes
13723 correspond to the LaTeX document classes
13736 They are replacements for the standard document classes
13748 , resp., and fit better to Polish typography conventions in a number of points.
13752 \begin_layout Standard
13756 \begin_layout Itemize
13757 Unnumbered titles (with star, eg.
13762 ) are added into table of contents,
13765 \begin_layout Itemize
13766 Additional page styles:
13770 \begin_layout Description
13771 uheadings header with separated lines,
13774 \begin_layout Description
13775 myheadings custom header, contents headers via commands:
13790 \begin_layout Description
13791 myuheadings custom header with separated lines,
13794 \begin_layout Description
13795 outer page number is placed on outer side of page
13799 \begin_layout Itemize
13804 \begin_layout Description
13805 rmheadings serif titles --- default,
13808 \begin_layout Description
13809 sfheadings sansserif titles,
13812 \begin_layout Description
13813 authortitle on title page first placed is author next title --- default,
13816 \begin_layout Description
13817 titleauthor on title page first placed is title next author,
13820 \begin_layout Description
13821 withmarginpar reserve place on page for margins.
13825 \begin_layout Section
13829 \begin_layout Standard
13835 \begin_layout Standard
13836 Elsevier Science Publishers B.V.
13837 provides a standard LaTeX document class (
13841 ) for submitting articles to their various journals.
13842 The style file can be downloaded directly from their web site:
13843 \begin_inset LatexCommand url
13844 target "http://authors.elsevier.com/"
13849 Instructions are supplied along with the class file, which details the
13850 requirements of the publishers.
13851 LyX includes package that allows for the use of this class, by a layout
13852 and a template file.
13853 Installation of the class file is the same as for any other LaTeX package;
13854 instructions are provided in the Elsevier documentation.
13857 \begin_layout Standard
13867 As the Elsevier class file is based mainly on the standard article class,
13868 most of the normal functionality is provided.
13869 The Elsevier class defines a number of mathematical environments, which
13870 are similar to the AMS environments.
13871 These commands are all described in the Elsevier documentation, and are
13875 \begin_layout Standard
13876 The easiest way to use the Elsevier style is to base documents on the included
13878 It is best not to use options such as fancy headings or the geometry package,
13879 as elements such as these are defined by Elsevier in their style file.
13880 Ideally, no extra packages except those mentioned in the Elsevier documentation
13882 Essentially, Elsevier require as
13883 \begin_inset Quotes eld
13887 \begin_inset Quotes erd
13894 \begin_layout Standard
13903 file as possible, as their intention is to take the supplied file and replace
13904 the class file with one for the particular journal to which the paper has
13906 This also means that not too much time should be spent on the formating
13908 When it comes to be published, this will change anyway.
13909 The rest of the usage for this layout is substantially the same as for
13910 the normal article class.
13911 For details of what Elsevier do and don't allow, refer to their documentation.
13914 \begin_layout Section
13918 \begin_layout Standard
13921 Jürgen Spitzmüller
13924 \begin_layout Subsection
13928 \begin_layout Standard
13929 Memoir is a very powerful and constantly evolving class.
13930 It has been designed with regard to fictional and non-fictional literature.
13931 Its aim is to let the user have maximum control over the typesetting of
13933 Memoir is based on the standard book class, but it can also emulate the
13934 article class (see below).
13937 \begin_layout Standard
13938 Peter Wilson, the developer of Memoir, is known as the author of lots of
13939 useful packages in the LaTeX world.
13940 Most of them have been merged with Memoir.
13941 Therefore, it is much easier to layout the table of contents, appendices,
13942 chapter designs and such.
13943 LyX, though, does not support all of these goodies natively.
13944 Some of them might be added to forthcoming releases
13948 \begin_layout Standard
13949 You are invited to send suggestions to
13950 \begin_inset LatexCommand url
13951 target "lyx-devel@lists.lyx.org"
13960 , lots will probably never, due to the limitations of LyX's framework.
13961 Of course you can still use all features with the help of some native LaTeX
13966 \begin_layout Standard
13971 \begin_layout Standard
13980 section\InsetSpace ~
13982 \begin_inset LatexCommand ref
13983 reference "sec:Inserting-LaTeX-Code"
13993 In this section, we can only list those features which are natively supported
13995 For detailed descriptions (and for the rest of features) we are recommending
13996 to have a look at the detailed manual of the Memoir class
14000 \begin_layout Standard
14005 \begin_layout Standard
14015 \begin_inset LatexCommand url
14016 target "CTAN:/macros/latex/memoir/memman.pdf"
14025 , which is not only a user guide for the class, but also both a comprehensive
14026 description on good typesetting and a superb example for good typesetting
14030 \begin_layout Subsection
14031 Basic features and restrictions
14034 \begin_layout Standard
14035 Memoir supports basically all features of the standard book classes.
14036 There are, however, some differences, as follows:
14039 \begin_layout Description
14041 sizes: Memoir has a broader range of font sizes: 9, 10, 11, 12, 14,
14045 \begin_layout Description
14047 style: The fancy page style is not supported, due to a command clash
14048 between Memoir and the fancyhdr package (they are both defining a command
14049 with the same name, which confuses LaTeX).
14050 Instead, Memoir comes with a bunch of own page styles (see
14052 Layout\SpecialChar \menuseparator
14053 Document\SpecialChar \menuseparator
14058 If you want to use these for the chapter pages, you have to use the command
14065 in the main text or in preamble (e.
14069 \begin_layout Standard
14082 \begin_layout Standard
14095 chapterstyle{companion}
14100 \begin_layout Description
14101 Sectioning: Sectionings (chapter, section, subsection etc.) are coming with
14102 an optional argument in the standard classes.
14103 With this, you can specify an alternative version of the title for the
14104 table of contents and the headers (for instance, if the title is too long).
14105 In LyX, you can do this via
14107 Insert\SpecialChar \menuseparator
14111 at the beginning of a chapter/section.
14112 Memoir features a second optional argument and thus separates the table
14113 of contents from the header.
14114 You can define three variants of a title with this: one for the main text,
14115 one for the table of contents, and one for the headers.
14116 Simply insert two optional arguments if you need this feature, the first
14117 one containing the short title for the Table of Contents, the second one
14118 containing an alternative short title for the headers.
14121 \begin_layout Description
14122 TOC/LOT/LOF: In the standard classes (and in many other classes), the table
14123 of contents, the list of figures and the list of table start a new page
14125 Memoir does not follow this route.
14126 You have to insert a page break yourself, if you want to have one.
14129 \begin_layout Description
14130 Titlepage: For some unknown reason, Memoir uses pagination on the title
14131 page (in the standard classes, title pages are
14132 \begin_inset Quotes eld
14136 \begin_inset Quotes erd
14143 \begin_layout Standard
14156 \begin_layout Standard
14166 If you want an empty title page, type
14170 aliaspagestyle{title}{empty}
14175 \begin_layout Description
14176 Article: With the class option
14182 Layout\SpecialChar \menuseparator
14183 Document\SpecialChar \menuseparator
14187 ), you can emulate article style.
14188 That is, counters (footnotes, figures, tables etc.) will not be reset on
14189 new chapters, chapters don't start a new page (but are---in contrary to
14191 \begin_inset Quotes eld
14195 \begin_inset Quotes erd
14198 article classes---still allowed), parts, though, use their own page, as
14202 \begin_layout Description
14203 Oldfontcommands: By default, Memoir does not allow the use of the deprecated
14204 font commands, which have been used in the old LaTeX version 2.09 (e.
14208 \begin_layout Standard
14221 \begin_layout Standard
14243 It produces an error and stops LaTeX whenever such a command appears.
14248 reallows the commands and spits out warnings instead (which does at least
14250 Since a lot of packages and particularly BibTeX style files are still using
14251 those commands, we have decided to use this option by default.
14254 \begin_layout Subsection
14258 \begin_layout Standard
14259 We will only describe the features supported by LyX (which is not much currently
14261 Please consult the Memoir manual
14265 \begin_layout Standard
14270 \begin_layout Standard
14280 \begin_inset LatexCommand url
14281 target "CTAN:/macros/latex/memoir/memman.pdf"
14293 \begin_layout Description
14294 Abstract: You may wonder why an abstract is an extra feature.
14295 Well, it is in book class.
14296 Usually books don't have abstracts.
14297 Memoir, however, has.
14298 You can use it wherever and how often you like.
14301 \begin_layout Description
14302 Chapterprecis: You may know this from belletristic: The contents of a chapter
14303 is shortly described below the title and also in the table of contents
14308 \begin_layout Standard
14321 \begin_layout Standard
14332 Our hero arrives in Troia; he loses some friends; he finds others
14335 Chapterprecis does exactly this.
14336 It is therefore only sensible below a chapter.
14339 \begin_layout Description
14340 Epigraph: An epigraph is a smart slogan or motto at the beginning of a chapter.
14341 The epigraph environment provides an elegant way of typesetting such a
14343 The motto itself (text) and its author (source) are divided by a short
14345 Unfortunately, we have to fool LyX a bit here again, since the environment
14346 needs two arguments (text and source).
14347 In this case, we have to use curly brackets (in TeX mode) between the two
14358 <author of the slogan>.
14361 \begin_layout Description
14362 Poemtitle: Memoir has lots of possibilities to typeset poetry (up to very
14363 complex figurative poems).
14364 LyX can only support a few of them.
14365 One is poemtitle, which is a centered title for poems, which will also
14366 be added to the table of contents (verse is the standard environment for
14368 Memoir has some enhanced versions of verse, but you need to use ERT, because
14369 they have to be nested inside regular verse environments, which is not
14370 possible with LyX).
14373 \begin_layout Description
14374 Poemtitle*: Same as poemtitle, but it adds no entry to the table of contents.
14377 \begin_layout Chapter
14378 Importing and Exporting Alternate File Formats
14379 \begin_inset OptArg
14382 \begin_layout Standard
14383 Importing and Exporting
14391 \begin_layout Section
14395 \begin_layout Standard
14396 Importing and exporting LyX documents from/to other formats has been touched
14402 Here we describe more of the gory details needed to understand just what
14403 is going on when you click on the
14408 ile\SpecialChar \menuseparator
14420 ile\SpecialChar \menuseparator
14431 \begin_layout Section
14432 Importing Other Formats
14435 \begin_layout Subsection
14439 \begin_layout Standard
14440 Translating from LaTeX into LyX is performed by a converter program called
14446 Although it is a standalone program which can be called from the command
14447 line, LyX will call it automatically when a LaTeX document is imported.
14448 See section\InsetSpace ~
14450 \begin_inset LatexCommand ref
14451 reference "sec:Translating-LaTeX-files"
14455 for a complete description.
14458 \begin_layout Subsection
14462 \begin_layout Standard
14463 When importing plain ASCII text, there are two methods of reading the file.
14465 \begin_inset Quotes eld
14469 \begin_inset Quotes erd
14472 preserves all the linebreaks in the ASCII; to LyX, then, each line looks
14475 \begin_inset Quotes eld
14479 \begin_inset Quotes erd
14482 assumes that consecutive lines separated by only a single linebreak form
14483 a single paragraph.
14484 Successive linebreaks with no intervening text are thus assumed to be paragraph
14488 \begin_layout Subsection
14492 \begin_layout Standard
14495 [Editor's note: Needs to be written, obviously - any volunteers? --- mer]
14498 \begin_layout Section
14499 Exporting Other Formats
14502 \begin_layout Standard
14503 The output formats listed here in the following are also explained concerning
14504 possible graphics formats in the
14511 \begin_layout Subsection
14515 \begin_layout Standard
14516 LyX generates two types of LaTeX files: stripped down versions for the normal
14521 , etc.) which one normally never sees
14525 \begin_layout Standard
14526 The resulting file is a perfectly valid LaTeX file, though the preamble
14527 might look a bit strange since it includes some definitions used by LyX
14528 which wouldn't show up in most human-written files.
14533 , and human readable forms which are suitable for exchanging with your colleague
14535 The only settable option for the translation is the line length of the
14537 The default is 65 characters, but it can be set in
14544 \SpecialChar \menuseparator
14565 \begin_layout Subsection
14566 Device Independent Files
14569 \begin_layout Standard
14570 Device Independent files (DVI files) are produced by running LaTeX on your
14572 There are no user settable options.
14575 \begin_layout Subsection
14579 \begin_layout Standard
14580 The next step in the conversion chain is converting a DVI file into Postscript.
14588 \SpecialChar \menuseparator
14596 \SpecialChar \menuseparator
14605 or, if you need more control on the result,
14612 \SpecialChar \menuseparator
14621 If you use the later, note that it is possible to configure, in
14628 \SpecialChar \menuseparator
14636 , the options passed to the dvips program to achieve different effects.
14639 \begin_layout Subsection
14643 \begin_layout Standard
14644 Exporting as ASCII attempts to preserve the
14645 \begin_inset Quotes eld
14649 \begin_inset Quotes erd
14652 of the document as well as possible, but things like centering and indentation
14653 are thrown out; paragraphs are separated by blank lines.
14654 Section numbering and cross-references are done correctly, so the resulting
14655 text files is remarkably readable.
14656 The only changeable option is the length of lines, as for LaTeX output.
14659 \begin_layout Subsection
14663 \begin_layout Standard
14664 LyX documents can be converted to hypertext markup, usually by converting
14665 to LaTeX first, then converting that to HTML\SpecialChar \@.
14667 \begin_inset Formula $\rightarrow$
14670 HTML converters are currently known to LyX:
14687 Though they are autodetected, you can overide the selection in preferences.
14688 You can also include further command line options in this dialog.
14692 \begin_layout Subsection
14696 \begin_layout Standard
14704 \begin_layout Standard
14705 \begin_inset VSpace bigskip
14711 \begin_layout Standard
14712 The fastest way to generate a basic PDF file (no tags, links, etc.) with
14713 any version of LyX is to save the document as a Postscript file, then run
14719 Starting with version 1.1.6, the menu item
14723 will do all this for you.
14724 There are some issues with fonts that you need to pay attention to: see
14725 Section\InsetSpace ~
14727 \begin_inset LatexCommand ref
14728 reference "sec:badfonts"
14733 Also, as of version 1.1.6, there is a better method that will generate much
14734 more sophisticated files.
14737 \begin_layout Subsubsection
14741 \begin_layout Standard
14742 With pdfLaTeX you cannot use pstricks.
14743 On the other hand, with pdfLaTeX it is possible to insert directly images
14744 in JPEG, PDF or PNG format, use TrueType fonts, and more.
14747 \begin_layout Subsubsection
14748 Why does the text look so bad when viewed with Acrobat Reader?
14749 \begin_inset LatexCommand label
14750 name "sec:badfonts"
14755 \begin_inset OptArg
14758 \begin_layout Standard
14759 Bad Fonts in Acrobat Reader
14767 \begin_layout Standard
14768 The problem is that bitmap fonts are displayed poorly by Acrobat Reader.
14769 When creating a PDF from the LyX file, you need to use outline font instead
14770 of the default bitmap fonts (in fact, you should also use outline fonts
14771 for Postscript files).
14772 Recent LaTeX distributions come with Postscript Type 1 version of the standard
14773 (Computer Modern) fonts.
14774 pdfLaTeX uses these font by default.
14775 Dvips doesn't use these fonts by default, so to make it use them, add the
14776 following to lines to your
14783 \begin_layout LyX-Code
14787 \begin_layout LyX-Code
14791 \begin_layout Standard
14792 If the default LaTeX font encoding (OT1) is used, nothing else need to be
14794 However, if the T1 font encoding is used, then LaTeX uses the newer EC
14795 fonts, for which there are no Type1 version.
14796 The solution is to use the ae package which emulates T1 coded fonts using
14797 the standard CM fonts.
14798 This is done by adding
14802 usepackage{ae,aecompl}
14804 to the preamble of the LyX file.
14805 However, some glyphs are missing from the CM fonts (e.\InsetSpace \thinspace{}
14808 they are taken from the EC fonts.
14809 Therefore you get these glyphs as bitmaps.
14812 \begin_layout Standard
14813 Note: LyX uses by default the T1 font encoding.
14814 If you wish to use the default font encoding (this is not recommended,
14815 unless you only write English documents), clear the field
14823 in preferences (tabs
14835 \begin_layout Standard
14836 An alternate option is to use the standard Postscript fonts instead of the
14837 Computer Modern fonts.
14838 To do that, you need to select
14842 as the global font in the document layout dialog.
14843 When using the Postscript fonts, the result PDF file is smaller as the
14844 fonts are not saved into the file.
14845 Furthermore, the Postscript fonts include all T1 glyphs.
14846 On the other hand, the Postscript fonts have no bold symbol font, so poor
14847 man's bold must be used (see Section\InsetSpace ~
14849 \begin_inset LatexCommand ref
14850 reference "sec:pdfbold"
14855 The Postscript fonts also look different from the Computer Modern fonts.
14858 \begin_layout Standard
14859 To sum up, both the Computer Modern and the Postscript fonts gives good
14860 results (with few exceptions).
14861 The decision of which one to use is a matter of taste.
14864 \begin_layout Subsubsection
14867 boldsymbol{} command work when I use pslatex?
14868 \begin_inset LatexCommand label
14874 \begin_inset OptArg
14877 \begin_layout Standard
14894 \begin_layout Standard
14895 The Postscript fonts do not have a bold symbol font.
14896 The solution is to use the
14902 (poor man's bold) command.
14905 \begin_layout Standard
14906 It is possible to redefine the
14921 \begin_layout LyX-Code
14931 \begin_layout Standard
14935 \begin_layout Subsubsection
14936 Is it possible to do write LaTeX-code which is processed only when running
14938 \begin_inset OptArg
14941 \begin_layout Standard
14942 Conditionals with pdfLaTeX
14950 \begin_layout Standard
14951 Yes you can do this with the
14956 Here is an example:
14959 \begin_layout LyX-Code
14963 \begin_layout LyX-Code
14969 \begin_layout LyX-Code
14975 \begin_layout LyX-Code
14978 pdfinfo { /Author (your name and e-mail address)
14981 \begin_layout LyX-Code
14982 /Title (official title -- i.e., title element)
14985 \begin_layout LyX-Code
14986 /Subject (one line description of the document)
14989 \begin_layout LyX-Code
14993 \begin_layout LyX-Code
14996 pdfcatalog { /PageMode (/UseNone)
14999 \begin_layout LyX-Code
15000 % /OpenAction (fitbh)
15003 \begin_layout LyX-Code
15007 \begin_layout LyX-Code
15010 usepackage[pdftex]{hyperref}
15013 \begin_layout LyX-Code
15019 \begin_layout LyX-Code
15022 usepackage[ps2pdf]{hyperref}
15025 \begin_layout LyX-Code
15031 \begin_layout Subsubsection
15032 How can I make URLs clickable?
15035 \begin_layout Standard
15036 See the references here:
15039 \begin_layout Standard
15040 \begin_inset LatexCommand url
15041 target "http://wiki.lyx.org/pmwiki.php/FAQ/PDF"
15048 \begin_layout Subsection
15052 \begin_layout Standard
15053 Custom exports are possible if you have some particularly weird format you
15054 wish to convert to, assuming you have the relevant converter, of course.
15059 file can be chosen in the
15064 ile\SpecialChar \menuseparator
15069 xport\SpecialChar \menuseparator
15076 dialog; LyX will automatically convert the file to this point, then feed
15077 it to your custom converter.
15078 The possible values are all formats that LyX can produce from its own documents.
15082 \begin_layout Standard
15083 The converter command is also specified in the dialog.
15084 It should be a completely qualified command line which uses the variable
15089 to specify the name of the file.
15090 If this variable is not given, then the file will be sent to the standard
15091 input of your command.
15092 You may have to apply a bit of ingenuity to escape this sequence correctly
15093 so that it is compatible with your shell.
15097 \begin_layout Standard
15098 While it is not possible to save this command using the
15102 dialog, you can manually edit your
15109 \begin_layout LyX-Code
15112 custom_export_command "mycommand $$FName"
15115 \begin_layout Chapter
15116 LyX Features needing Extra Software
15119 \begin_layout Section
15123 \begin_layout Standard
15129 \begin_layout Subsection
15133 \begin_layout Standard
15141 menu, you'll find a
15150 This feature requires you to have the
15154 program installed, and is grayed out if you don't have it.
15155 You can get it from your nearest CTAN mirror, or over the Web from
15156 \begin_inset LatexCommand url
15157 target "http://www.ifi.uio.no/~jensthi/chktex/"
15164 \begin_layout Standard
15169 package is a program that was written by
15174 in frustration because some constructs in LaTeX are sometimes non-intuitive,
15175 and easy to forget.
15176 The program runs over your LaTeX file and checks the integrity of the file,
15177 and flags some common errors.
15178 In other technical words, it is
15185 \begin_layout Standard
15186 Well, what is a syntax checker doing in LyX which is supposed to produce
15187 correct LaTeX anyways? The answer is simple: Just as
15191 not only checks the
15195 of C programs, but also does
15199 checks for type-errors,
15203 catches some common
15207 errors, in addition to the syntactical ones.
15212 is capable of detecting several common errors, such as
15215 \begin_layout Itemize
15216 Ellipsis detection:
15218 Use \SpecialChar \ldots{}
15222 \begin_layout Itemize
15223 No space in front of/after parenthesis:
15228 \begin_layout Itemize
15229 Enforcement of normal space after common abbreviations:
15233 is too wide spacing.
15236 \begin_layout Itemize
15237 Enforcement of end-of-sentence space when the last sentence ends with a
15241 And this is wrong spacing.
15244 \begin_layout Itemize
15245 Space in front of labels and similar commands:
15247 The label should stick right
15248 up to the text to avoid falling to a wrong page.
15250 \begin_inset LatexCommand label
15259 \begin_layout Standard
15260 This footnote is in danger of falling off to a wrong page
15265 The label is separated too much.
15268 \begin_layout Itemize
15269 Space in front of references, instead of hard spaces:
15271 In you are in bad luck,
15272 the text will break right between the referenced text and reference number,
15275 \begin_inset LatexCommand ref
15276 reference "sec:chktex"
15283 \begin_layout Itemize
15285 \begin_inset Quotes eld
15289 \begin_inset Quotes erd
15293 \begin_inset Formula $\times$
15298 2x2 looks cheap compared to
15299 \begin_inset Formula $2\times2$
15305 \begin_layout Standard
15306 and more \SpecialChar \ldots{}
15307 It is an invaluable tool when you are
15308 \begin_inset Quotes eld
15312 \begin_inset Quotes erd
15315 your document before printing, and you should run it right after the obligatory
15316 spelling check, and before you go fine tuning the typesetting.
15319 \begin_layout Subsection
15323 \begin_layout Standard
15324 If you have the program installed, usage is as simple as choosing
15329 ools\SpecialChar \menuseparator
15338 This will make LyX generate a LaTeX file of your document, start
15342 to check it, and then make LyX insert
15343 \begin_inset Quotes eld
15347 \begin_inset Quotes erd
15350 with the warnings from
15354 , if there were any.
15355 The warnings will be placed close to the point of the mistake, and you
15356 can quickly find them by using the
15361 avigate\SpecialChar \menuseparator
15368 menu item, or the shortcut key
15377 Open the error boxes by clicking on them with the mouse, or use the shortcut
15386 bindings, or the corresponding
15395 Read the warning and correct the mistake, if it is a mistake.
15396 If you have trouble understanding what the warning is about, you can safely
15398 Remember that there is a hidden layer between the document on screen and
15399 the technical details in invoking
15403 , and this gap can make some warnings seem arcane or just right down plain
15407 \begin_layout Standard
15408 This document is an excellent testing bed for the feature, and it should
15409 provide quite a few warnings for you to fiddle with.
15410 Since computers are only so smart, expect most of the warnings to be false
15414 \begin_layout Subsection
15415 How to fine tune it
15418 \begin_layout Standard
15419 Sometimes, you'll find that
15423 makes more noise than suits your mood.
15424 Then you can choose not to use it, wait until your mood changes, or try
15429 to get better along with you.
15430 Another choice in the most desperate situations is to use
15435 iew\SpecialChar \menuseparator
15445 , which will get rid of all warnings instantly.
15448 \begin_layout Standard
15457 very configurable and extensible, you shouldn't expect to solve all problems
15463 Since LyX has to generate a somewhat special LaTeX file to be able to match
15464 the line numbers from the
15472 \begin_layout Standard
15473 You can inspect the specific output from
15479 Edit\SpecialChar \menuseparator
15493 to the internal document structure, some of the warnings will not seen
15494 to appear correctly.
15495 There are two things you can do about this:
15498 \begin_layout Itemize
15503 invocation command line in
15519 installation configuration file (usually with the file
15521 /usr/local/share/chktexrc
15524 See below to learn what warnings can be enabled and disabled on the command
15529 \begin_layout Itemize
15530 Export your document as a raw LaTeX file using
15535 ile\SpecialChar \menuseparator
15540 xport\SpecialChar \menuseparator
15552 Invoked in this way, it can be a hassle to find the corresponding place
15553 in the document inside LyX, but with a little patience, you should be able
15557 \begin_layout Standard
15558 Here follows the warning messages that can be enabled and disabled in
15567 to disable a warning, and
15571 to enable a warning.
15572 The emphasized entries are disabled by default, because the default is
15575 chktex -n1 -n3 -n6 -n9 -n22 -n25 -n30 -n38
15580 \begin_layout Standard
15581 Notice that you should only use the options that enable and disable warnings,
15582 because LyX relies on some of the other command line parameters to be set
15583 in a specific way to have a chance to communicate with
15590 \begin_layout Enumerate
15594 Command terminated with space.
15597 \begin_layout Enumerate
15600 Non-breaking space (
15601 \begin_inset Quotes eld
15609 \begin_inset Quotes erd
15612 ) should have been used.
15615 \begin_layout Enumerate
15619 You should enclose the previous parenthesis with
15620 \begin_inset Quotes eld
15628 \begin_inset Quotes erd
15634 \begin_layout Enumerate
15637 Italic correction (
15638 \begin_inset Quotes eld
15648 \begin_inset Quotes erd
15651 ) found in non-italic buffer.
15654 \begin_layout Enumerate
15657 Italic correction (
15658 \begin_inset Quotes eld
15668 \begin_inset Quotes erd
15671 ) found more than once.
15674 \begin_layout Enumerate
15678 No italic correction (
15679 \begin_inset Quotes eld
15689 \begin_inset Quotes erd
15695 \begin_layout Enumerate
15699 \begin_inset Quotes eld
15707 \begin_inset Quotes erd
15711 \begin_inset Quotes eld
15719 \begin_inset Quotes erd
15725 \begin_layout Enumerate
15728 Wrong length of dash may have been used.
15731 \begin_layout Enumerate
15735 \begin_inset Quotes eld
15743 \begin_inset Quotes erd
15747 \begin_inset Quotes eld
15755 \begin_inset Quotes erd
15761 \begin_layout Enumerate
15765 \begin_inset Quotes eld
15773 \begin_inset Quotes erd
15779 \begin_layout Enumerate
15783 \begin_inset Quotes eld
15791 \begin_inset Quotes erd
15794 to achieve an ellipsis.
15797 \begin_layout Enumerate
15800 Inter-word spacing (
15801 \begin_inset Quotes eld
15811 \begin_inset Quotes eld
15814 ) should perhaps be used.
15817 \begin_layout Enumerate
15820 Inter-sentence spacing (
15821 \begin_inset Quotes eld
15831 \begin_inset Quotes erd
15834 ) should perhaps be used.
15837 \begin_layout Enumerate
15840 Could not find argument for command.
15843 \begin_layout Enumerate
15847 \begin_inset Quotes eld
15855 \begin_inset Quotes erd
15861 \begin_layout Enumerate
15864 Math mode still on at end of LaTeX file.
15867 \begin_layout Enumerate
15871 \begin_inset Quotes eld
15879 \begin_inset Quotes erd
15882 doesn't match the number of
15883 \begin_inset Quotes eld
15891 \begin_inset Quotes erd
15897 \begin_layout Enumerate
15900 You should use either
15903 \begin_inset Quotes eld
15911 \begin_inset Quotes erd
15916 as an alternative to
15917 \begin_inset Quotes eld
15925 \begin_inset Quotes erd
15931 \begin_layout Enumerate
15938 " (ASCII 39) instead of "
15945 \begin_layout Enumerate
15948 User-specified pattern found.
15951 \begin_layout Enumerate
15954 This command might not be intended.
15957 \begin_layout Enumerate
15964 \begin_layout Enumerate
15982 \begin_layout Enumerate
15985 Delete this space to maintain correct page references.
15988 \begin_layout Enumerate
15992 You might wish to put this between a pair of
15993 \begin_inset Quotes eld
16001 \begin_inset Quotes erd
16007 \begin_layout Enumerate
16010 You ought to remove spaces in front of punctuation.
16013 \begin_layout Enumerate
16016 Could not execute LaTeX command.
16019 \begin_layout Enumerate
16028 in front of small punctuation.
16031 \begin_layout Enumerate
16039 may look prettier here.
16042 \begin_layout Enumerate
16046 Multiple spaces detected in output.
16049 \begin_layout Enumerate
16052 This text may be ignored.
16055 \begin_layout Enumerate
16061 \begin_inset Quotes eld
16066 to begin quotation, not
16073 \begin_layout Enumerate
16080 to end quotation, not
16083 \begin_inset Quotes eld
16091 \begin_layout Enumerate
16097 \begin_layout Enumerate
16100 You should perhaps use
16101 \begin_inset Quotes eld
16109 \begin_inset Quotes erd
16115 \begin_layout Enumerate
16118 You should put a space in front of/after parenthesis.
16121 \begin_layout Enumerate
16124 You should avoid spaces in front of/after parenthesis.
16127 \begin_layout Enumerate
16131 You should not use punctuation in front of/after quotes.
16134 \begin_layout Enumerate
16137 Double space found.
16140 \begin_layout Enumerate
16143 You should put punctuation outside inner/inside display math mode.
16146 \begin_layout Enumerate
16149 You ought to not use primitive TeX in LaTeX code.
16152 \begin_layout Enumerate
16155 You should remove spaces in front of
16156 \begin_inset Quotes eld
16164 \begin_inset Quotes erd
16170 \begin_layout Enumerate
16173 \begin_inset Quotes eld
16181 \begin_inset Quotes erd
16184 is normally not followed by
16185 \begin_inset Quotes eld
16193 \begin_inset Quotes erd
16199 \begin_layout Standard
16200 In later versions of LyX, we hope to provide a more complete interface to
16201 this tool (and it's smaller cousin
16205 ) to exploit the full power of it.
16206 But it's not exactly useless as it is now: go try it on one of your existing
16207 documents of a certain length and be surprised.
16210 \begin_layout Section
16211 Version Control in LyX
16214 \begin_layout Standard
16217 Lars Gullik Bjønnes
16220 \begin_layout Subsection
16224 \begin_layout Standard
16225 A friend of mine wanted to try LyX for a group project.
16226 When he didn't find support for version control or file locking, he dropped
16228 This angered me a bit, so I thought that I should at least make support
16229 for RCS (with the possibility of CVS and/or SCCS as a future improvement.)
16230 This has now been done.
16231 LyX now supports some of the most basic RCS commands.
16232 If you need to something a bit more sophisticated you will have to do that
16233 manually in an xterm.
16236 \begin_layout Standard
16237 Before you begin to use the version control features in LyX, you should
16239 \begin_inset Quotes eld
16243 \begin_inset Quotes erd
16246 (a man file, read it with
16251 This file describes all the basic features of RCS.
16252 You should especially notice the comment about a RCS directory, and the
16253 notion of a master RCS file (the file ending in
16260 \begin_layout Standard
16261 The implementation in LyX assumes a recent version of the GNU RCS package---no
16262 guarantees are made for older versions.
16265 \begin_layout Subsection
16266 RCS commands in LyX
16269 \begin_layout Standard
16270 The following sections describe the RCS commands supported by LyX.
16271 You can find them in the
16276 ile\SpecialChar \menuseparator
16281 ersion\InsetSpace ~
16287 \begin_layout Subsubsection
16293 \begin_layout Standard
16294 If your document is not under revision control, this is the only item shown
16296 And if it is under revision control, the
16303 item is grayed out.
16307 \begin_layout Standard
16308 This command registers your document with RCS\SpecialChar \@.
16309 You are asked interactively
16310 to supply an initial description of the document.
16311 The document is now set in Read-Only mode and you have to
16318 , before making any changes to it.
16319 A document under revision control has a
16320 \begin_inset Quotes eld
16323 [RCS:<version> <locker>]
16324 \begin_inset Quotes erd
16327 item tagged to the filename in the minibuffer.
16330 \begin_layout Standard
16331 RCS command that is run:
16333 ci -q -u -i -t-"<initial description>" <file-name>
16336 \begin_layout Standard
16341 to understand the switches.
16345 \begin_layout Subsubsection
16351 \begin_layout Standard
16352 When you are finished editing a file, you check in your changes.
16353 When you do this, you are asked for a description of the changes.
16354 This is stored in the history log.
16355 The version number is bumped, your changes are applied to the master RCS
16356 file, the document is unlocked and set to Read-Only mode.
16360 \begin_layout Standard
16363 ci -q -u -m"<description>" <file-name>
16366 \begin_layout Subsubsection
16372 \begin_layout Standard
16373 By doing this you lock the document so that only you can edit it.
16374 This will also make the document Read-Write only for you.
16375 You will usually continue editing for a while and when you are finished
16376 you check in your changes.
16377 The status line is changed to reflect that you have locked the file.
16381 \begin_layout Standard
16384 co -q -l <file-name>
16387 \begin_layout Subsubsection
16390 Revert To Last Version
16393 \begin_layout Standard
16394 This will discard all changes made to the document since the last check
16396 You get a warning before changes are discarded.
16399 \begin_layout Standard
16402 co -f -u<version> <file-name>
16405 \begin_layout Subsubsection
16411 \begin_layout Standard
16412 This makes as if the last check in never happened.
16413 No changes are made to the document loaded into LyX, but the last version
16414 is removed from the master RCS file.
16418 \begin_layout Standard
16421 rcs -o<version> <file-name>
16424 \begin_layout Subsubsection
16430 \begin_layout Standard
16431 This show the complete history of the RCS document.
16436 is shown in a browser.
16444 \begin_layout Section
16445 Literate Programming
16448 \begin_layout Standard
16453 (kayvan@sylvan.com)
16457 original documentation written by
16459 Edmar Wienskoski Jr.
16462 (edmar-w-jr@technologist.com)
16465 \begin_layout Subsection
16469 \begin_layout Standard
16470 The main purpose of this documentation is to show you how to use LyX for
16471 literate programming.
16472 Where it is assumed that you are familiar with this programming technique,
16474 \begin_inset Quotes eld
16478 \begin_inset Quotes erd
16482 \begin_inset Quotes eld
16486 \begin_inset Quotes erd
16490 If that is not the case, please follow the web links provided in the following
16492 There is a lot of good documentation out there covering old development
16493 history to the latest tools tips.
16496 \begin_layout Standard
16497 It is also assumed that you are familiar with LyX itself to a point that
16498 you are comfortable changing your LyX preferences, and X resources file.
16499 If that is not the case please refer to other LyX documentation to cover
16500 your specific needs.
16503 \begin_layout Subsection
16504 Literate Programming
16507 \begin_layout Standard
16508 From the Literate Programming FAQ:
16511 \begin_layout Quotation
16512 Literate programming is the combination of documentation and source together
16513 in a fashion suited for reading by human beings.
16514 In fact, literate programs should be enjoyable reading, even inviting!
16515 (Sorry Bob, I couldn't resist!) In general, literate programs combine source
16516 and documentation in a single file.
16517 Literate programming tools then parse the file to produce either readable
16518 documentation or compilable source.
16519 The WEB style of literate programming was created by D.E.
16520 Knuth during the development of his TeX typesetting software.
16524 \begin_layout Standard
16525 Another excerpt says:
16528 \begin_layout Quotation
16531 How is literate programming different from verbose commenting?
16534 \begin_layout Quotation
16535 There are three distinguishing characteristics.
16536 In order of importance, they are:
16540 \begin_layout Itemize
16541 flexible order of elaboration
16544 \begin_layout Itemize
16545 automatic support for browsing
16548 \begin_layout Itemize
16549 typeset documentation, especially diagrams and mathematics
16553 \begin_layout Standard
16554 Now that I sparked your curiosity, take a look in the references.
16557 \begin_layout Subsubsection
16561 \begin_layout Standard
16562 The complete Literate Programming FAQ can be found at:
16565 \begin_layout Quote
16566 \begin_inset LatexCommand url
16567 name "Literate Programming FAQ"
16568 target "http://shelob.ce.ttu.edu/daves/lpfaq/faq.html"
16575 \begin_layout Standard
16576 The FAQ lists 23 (twenty three!) different literate programming tools.
16577 Where some are specialized or
16578 \begin_inset Quotes eld
16582 \begin_inset Quotes erd
16585 for particular programming languages, while other have general scope.
16590 for my own use for several reasons:
16593 \begin_layout Itemize
16594 It can generate the documentation either in LaTeX or HTML.
16597 \begin_layout Itemize
16598 It has a open architecture, i.e., it is easy to plug in new filters and to
16599 perform special processing that you may need.
16603 \begin_layout Itemize
16604 There is a good selection of filters available already (the HTML is one
16608 \begin_layout Itemize
16612 \begin_layout Standard
16613 The Noweb web page can be found at:
16616 \begin_layout Quote
16617 \begin_inset LatexCommand url
16618 name "Noweb home page"
16619 target "http://www.cs.virginia.edu/~nr/noweb/"
16626 \begin_layout Standard
16627 Starting from there you can reach many other interesting links and even
16628 some literate program examples.
16631 \begin_layout Subsection
16632 \begin_inset LatexCommand label
16633 name "sub:LyX-and-Literate"
16637 LyX and Literate Programming
16640 \begin_layout Standard
16641 The LyX support for Literate Programming is provided by using the generic
16642 LyX convertors mechanism.
16643 This support is provided in a
16644 \begin_inset Quotes eld
16648 \begin_inset Quotes erd
16651 way, i.e., you will be able to use this new LyX feature with some other literate
16652 programming tool of your choice by just changing your LyX preferences.
16655 \begin_layout Subsubsection
16656 Generating documents and code (weaving and tangling)
16659 \begin_layout Paragraph
16660 Selecting the document class
16663 \begin_layout Standard
16664 If you have installed Noweb and LyX successfully, whenever you open a new
16665 document or try to change the document class of an existing one, you will
16666 find that there are three new document classes available:
16669 \begin_layout Itemize
16673 \begin_layout Itemize
16677 \begin_layout Itemize
16681 \begin_layout Standard
16682 You must select one of them to create your literate documents from.
16686 \begin_layout Standard
16687 Note that literate documents are not limited to these three classes.
16688 New classes can be generated from other styles like letter or in combination
16689 with other class variations like Article (AMS).
16690 If you have special needs that cannot be covered by one of the existing
16691 classes, let the LyX developers list (lyx-devel@lists.lyx.org) know and we
16692 will arrange to insert a new entry, or teach you how to do it.
16696 \begin_layout Standard
16697 It is very simple, it involves the creation of a file with four lines, and
16698 re-running of the auto configuration.
16703 Moreover, if you use a literate tool other than Noweb you may need to create
16704 a new set of document classes for it.
16707 \begin_layout Paragraph
16711 \begin_layout Standard
16712 LyX enables you to write code with a layout named
16720 \begin_layout Standard
16721 The equivalent Noweb term is
16722 \begin_inset Quotes eld
16726 \begin_inset Quotes erd
16730 For historical reasons, I got used to the term
16731 \begin_inset Quotes eld
16735 \begin_inset Quotes erd
16738 introduced by other literate tool named Nuweb, which I used for many years
16739 before rendering myself to Noweb.
16744 Noweb delimits scraps like this:
16747 \begin_layout LyX-Code
16751 \begin_layout LyX-Code
16755 \begin_layout LyX-Code
16759 \begin_layout LyX-Code
16763 \begin_layout LyX-Code
16767 \begin_layout Standard
16768 The problem is that whatever is written in between the << and the
16772 must be taken literally, i.e., LyX should be prevented from making any special
16773 interpretation of what has been written.
16774 This is handled by a special layout named Scrap, that works like a normal
16775 paragraph but has a free spacing capability.
16778 \begin_layout Standard
16779 The down side of the Scrap paragraph layout is that consecutive paragraphs
16780 of code will be spaced with one empty line in the source code and also
16781 in the printed documentation.
16782 The work around is to enter each line of code within a single Scrap, with
16783 a newline (ctrl-return).
16784 The example above will look like this:
16788 \begin_layout Standard
16789 If you have a printed version of this document you will not see any difference
16790 between the previous example and this one.
16798 \begin_layout LyX-Code
16810 \begin_layout Standard
16811 This layout works fine.
16812 The only real inconvenience is that you have to type ctrl-return instead
16817 \begin_layout Standard
16818 It is in my list of
16819 \begin_inset Quotes eld
16823 \begin_inset Quotes erd
16834 \begin_layout Standard
16835 As a special note, you can also use the
16836 \begin_inset Quotes eld
16840 \begin_inset Quotes erd
16843 construct of Noweb in your scraps to add items to Noweb's identifier cross-refe
16847 \begin_layout LyX-Code
16850 def some_function(args):
16852 "This is the doc string for this
16855 print "My args: ", args
16858 \begin_layout LyX-Code
16859 @ %def some_function
16862 \begin_layout Standard
16863 For an example of this usage and the resulting cross-reference output, look
16864 at the Literate python program in
16866 LIBDIR/examples/listerrors.lyx
16868 which should make this all clear.
16871 \begin_layout Paragraph
16872 Generating the documentation
16875 \begin_layout Standard
16876 At this point you already have a new document file with a proper document
16877 class, and with some code and text on it.
16878 How do I print it? The answer is simple, you select
16883 iew\SpecialChar \menuseparator
16891 Just like you would do for a plain document.
16892 No special procedure is required.
16895 \begin_layout Standard
16896 To help orientate you, I will now explain what happens inside LyX:
16899 \begin_layout Enumerate
16905 pdate\SpecialChar \menuseparator
16912 menu option is chosen, a LaTeX file is generated.
16917 \begin_layout Standard
16918 If the document is of any literate class the generated file will be named
16919 with an extension name defined by the
16920 \begin_inset Quotes eld
16924 \begin_inset Quotes erd
16927 format (defined in the Preferences panel), otherwise the file will have
16936 \begin_layout Enumerate
16937 Note that the only difference so far is in the name of the file, no special
16938 processing is required by LyX.
16939 Given that you formatted the code using the Scrap layout that, by itself,
16940 takes care of the business.
16943 \begin_layout Enumerate
16944 If the document is of any literate class LyX will then use the internal
16945 LyX to Noweb converter, followed by the Noweb to LaTeX converter
16949 \begin_layout Standard
16950 The converters are defined in the
16955 ools\SpecialChar \menuseparator
16963 \begin_inset Quotes eld
16967 \begin_inset Quotes erd
16972 \begin_inset LatexCommand ref
16973 reference "sub:converters"
16981 manual for general information about converters.
16986 to generate the LaTeX file.
16990 \begin_layout Standard
16991 Otherwise it will just skip this step.
16995 \begin_layout Enumerate
16996 Finally, LaTeX is invoked and the regular post processing continues as in
17000 \begin_layout Standard
17001 Independence from a particular
17002 \begin_inset Quotes eld
17006 \begin_inset Quotes erd
17009 is easily achieved by changing the commands that are run by the various
17013 \begin_layout Paragraph
17014 Generating the code
17017 \begin_layout Standard
17018 When the build menu option is chosen or the corresponding button in the
17019 toolbar is pressed, a LaTeX file is generated just like step 1 above.
17020 Next, LyX invokes the
17025 This converter needs to be defined by the user and is not installed by
17026 default, though the Program format is.
17027 This converter (like any other converter) will have two parts:
17030 \begin_layout Enumerate
17031 The converter program itself.
17032 This program performs the conversion from the one format to the other (in
17033 this case, from the Noweb format to the Program pseudo-format).
17036 \begin_layout Enumerate
17037 The error log parser.
17038 This is a program whose sole purpose is to rewrite error messages in a
17039 format that LyX understands.
17040 This makes it possible for LyX to place error boxes in the right places
17041 in the file buffer.
17044 \begin_layout Standard
17045 The first part, the
17046 \begin_inset Quotes eld
17050 \begin_inset Quotes erd
17053 setting, should be set to
17054 \begin_inset Quotes eld
17062 \begin_inset Quotes erd
17066 This basically means that LyX will call
17067 \begin_inset Quotes eld
17071 \begin_inset Quotes erd
17074 (a program or script) with the name of the Noweb file (normally a file
17075 in the LyX temp directory).
17079 \begin_layout Standard
17080 This is an implementation of
17081 \begin_inset Quotes eld
17085 \begin_inset Quotes erd
17088 that you can place in a directory on your path:
17091 \begin_layout LyX-Code
17095 \begin_layout LyX-Code
17099 \begin_layout LyX-Code
17100 notangle -Rbuild-script $1 | env NOWEB_SOURCE=$1 sh
17103 \begin_layout Standard
17104 The next part of the converter setting is the
17105 \begin_inset Quotes eld
17109 \begin_inset Quotes erd
17112 which is to be set to
17113 \begin_inset Quotes eld
17118 parselog=listerrors
17121 \begin_inset Quotes erd
17125 This will run any errors that are generated by the
17126 \begin_inset Quotes eld
17130 \begin_inset Quotes erd
17133 process through the
17134 \begin_inset Quotes eld
17138 \begin_inset Quotes erd
17144 \begin_layout Standard
17145 The converter code looks in
17153 then on the path for the
17154 \begin_inset Quotes eld
17158 \begin_inset Quotes erd
17164 \begin_layout Standard
17165 The build will normally take place in LyX's temporary directory, so the
17166 files produced by the conversion will be in that directory.
17167 LyX will copy out what it regards as the `main' file, but the
17171 conversion may produce several files, and so most of these would then be
17172 deleted when LyX was closed.
17173 The present solution is to use a `copier',
17177 \begin_layout Standard
17179 \begin_inset LatexCommand ref
17180 reference "sec:converters-etc"
17188 manual for information on these.
17197 script in its default mode, so that the entire contents of the temporary
17198 directory is copied.
17199 More will get copied than is needed, to be sure, but nothing will be lost.
17200 If, however, you know what extensions the generated files will have, this
17201 can be improved by using the
17210 This option takes a comma-separated list of extensions to copy.
17211 So, for example, if the conversion will generate only files with the extensions
17220 , then the correct definition would be:
17223 \begin_layout LyX-Code
17224 python -tt $$s/scripts/ext_copy.py -e c,h $$i $$o
17227 \begin_layout Standard
17228 The result will be that only files with these two extensions will be copied
17232 \begin_layout Paragraph
17233 Build instructions in the document
17236 \begin_layout Standard
17237 The last piece of the integration between LyX and noweb is the
17238 \begin_inset Quotes eld
17242 \begin_inset Quotes erd
17246 Generally, the instructions for building your program should be embedded
17247 in a scrap of its own.
17249 \begin_inset Quotes eld
17253 \begin_inset Quotes erd
17256 above uses the notangle command to look for this scrap (called
17257 \begin_inset Quotes eld
17261 \begin_inset Quotes erd
17264 ) and runs its contents through
17265 \begin_inset Quotes eld
17269 \begin_inset Quotes erd
17275 \begin_layout Standard
17276 Typically, such a scrap would look something like this:
17279 \begin_layout LyX-Code
17286 if [ -z "${NOWEB_SOURCE}" ]
17290 NOWEB_SOURCE=myfile.nw
17296 code to extract files ...]
17299 code to compile files ...]
17304 \begin_layout Standard
17307 LIBDIR/examples/listerrors.lyx
17311 LIBDIR/examples/Literate.lyx
17313 which implement two versions of the
17314 \begin_inset Quotes eld
17318 \begin_inset Quotes erd
17321 program for some illustrations of how all of these pieces go together or
17324 LIBDIR/examples/noweb2lyx.lyx.
17327 Interestingly, these three files show off the language-indepence of the
17328 LyX literate programming support since they are written in Python, C and
17332 \begin_layout Subsubsection
17336 \begin_layout Standard
17337 All the Literate Programming support is configured by the
17342 ools\SpecialChar \menuseparator
17350 \begin_inset Quotes eld
17354 \begin_inset Quotes erd
17358 The important parts are:
17361 \begin_layout Description
17364 \begin_inset Quotes eld
17368 \begin_inset Quotes erd
17372 format Set up via the Formats tab, this is where the Noweb-specific pieces
17382 , the file extension is set to
17387 This tells LyX to create a file with a
17391 extension in the first step of the conversion process.
17394 \begin_layout Description
17401 format This is an empty format whose sole purpose is to be the endpoint
17402 of a conversion (which then allows us to set up a converter for it).
17405 \begin_layout Description
17414 This converter performs the
17415 \begin_inset Quotes eld
17419 \begin_inset Quotes erd
17422 of the literate document.
17423 For Noweb, it is set to
17424 \begin_inset Quotes eld
17429 noweave -delay -index $$i > $$o
17432 \begin_inset Quotes erd
17438 \begin_layout Description
17448 \begin_inset Quotes eld
17452 \begin_inset Quotes erd
17456 As stated above, the Converter is set to
17457 \begin_inset Quotes eld
17465 \begin_inset Quotes erd
17468 , with Flags set to
17469 \begin_inset Quotes eld
17474 originaldir,parselog=listerrors
17477 \begin_inset Quotes erd
17483 \begin_layout Subsubsection
17487 \begin_layout Standard
17488 There is also a new function implemented in the LyX server, the
17489 \begin_inset Quotes eld
17492 server-goto-file-row" function, to be used with ddd/gdb or other debugger.
17496 \begin_layout Standard
17497 When debugging code with ddd/gdb, it is possible to invoke a text editor
17498 at the current execution position with a single key stroke.
17499 The default ddd configuration for that is shift-ctrl-V.
17500 It happens that you can define the editor command line invocation in ddd
17506 dit\SpecialChar \menuseparator
17511 references\SpecialChar \menuseparator
17518 dialog and changing the "Edit Sources" entry.
17521 \begin_layout Standard
17522 I take advantage of the new created LyX server function and this ddd feature,
17524 \begin_inset Quotes eld
17528 \begin_inset Quotes erd
17534 \begin_layout LyX-Code
17535 echo "LYXCMD:monitor:server-goto-file-row:@FILE@ @LINE@" >~/.lyxpipe.in
17538 \begin_layout Standard
17539 With this, whenever you are using ddd and find a point in the program that
17540 you want to edit, you just press shift-ctrl-V (in the ddd window), and
17541 ddd you forward this information to LyX through the LyX server and then
17542 the LyX window will show the same file with the cursor at the same position
17543 ddd was pointing to.
17544 No more guessing or long scrolling to locate a point in the program back
17548 \begin_layout Standard
17549 Note however that you must enable the LyX server to get this feature working
17550 (it is disabled by default).
17551 You can enable it in
17563 ) by entering in the
17568 \begin_inset Quotes eld
17573 /home/<your-home-directory>/.lyx/lyxpipe
17576 \begin_inset Quotes erd
17582 \begin_layout Standard
17583 Read the LyX server documentation in the
17585 Customization Manual
17587 for further information.
17590 \begin_layout Subsubsection
17594 \begin_layout Standard
17595 There are six new buttons that can be added to your LyX toolbar.
17596 Five of these buttons are short cuts to layout styles:
17617 The last one is a short cut to the
17618 \begin_inset Quotes eld
17622 \begin_inset Quotes erd
17629 \begin_layout Standard
17630 LyX has a range of buttons that are available for tool bar customization.
17631 In my toolbar I like to combine the six short cuts above with two more:
17639 \SpecialChar \menuseparator
17647 \SpecialChar \menuseparator
17660 iew\SpecialChar \menuseparator
17668 Here is how it looks like:
17671 \begin_layout LyX-Code
17675 \begin_layout LyX-Code
17679 \begin_layout LyX-Code
17680 Icon "layout Standard"
17683 \begin_layout LyX-Code
17684 Icon "layout Section"
17687 \begin_layout LyX-Code
17688 Icon "layout LaTeX"
17691 \begin_layout LyX-Code
17692 Icon "layout LyX-Code"
17695 \begin_layout LyX-Code
17696 Icon "layout Scrap"
17699 \begin_layout LyX-Code
17703 \begin_layout LyX-Code
17707 \begin_layout LyX-Code
17708 Icon "buffer-typeset"
17711 \begin_layout LyX-Code
17712 Icon "build-program"
17715 \begin_layout LyX-Code
17719 \begin_layout LyX-Code
17723 \begin_layout LyX-Code
17727 \begin_layout LyX-Code
17731 \begin_layout LyX-Code
17735 \begin_layout Subsubsection
17736 Colors customization
17739 \begin_layout Standard
17740 There are a number of colors in LyX that can be customized in
17745 One of the things that bothers people is the LaTeX font color.
17746 The default color is red, since the scraps uses LaTeX font, and there is
17747 a lot of scraps in literate documents, you may get tired of seeing everything
17749 You can change it by going to the tabs
17758 \begin_layout Standard
17759 The next thing is the visible presence of the newline character in the screen.
17760 You can choose the color of this particular character and make it blend
17762 I recommend you choosing a color that is close to the background but not
17763 equal, that way you still can see it is there, but it is not bothering
17768 \begin_layout Chapter
17769 Secrets of the LaTeX Masters
17770 \begin_inset LatexCommand label
17778 \begin_layout Standard
17779 Though LyX is a powerful tool, it cannot hope to support everything that
17780 can be done with pure TeX/LaTeX.
17781 However, many familiar dirty TeX and LaTeX tricks can be done within LyX,
17782 as long as you are not afraid to use that
17783 \begin_inset Quotes eld
17787 \begin_inset Quotes erd
17790 button on the toolbar or add things to the LaTeX preamble.
17791 This section lists some tips, tricks, and otherwise cool ideas to give
17792 your document that extra little flair.
17795 Do try this at home
17797 , just start with something a little smaller and less important than your
17801 \begin_layout Standard
17802 Most ideas in this section require less common files in your LaTeX installation.
17803 If you have a system like teTeX, most will already be available.
17804 A few, however, will need to be downloaded from one of the CTAN archives.
17805 Often, there are several ways to do something, or several LaTeX style files
17806 which do the same thing.
17807 We do not endorse one choice over another, we simply claim that we have
17808 done a particular task with a particular file.
17809 Put on your wizard hat, keep an eye out for dragons, and let us begin.
17812 \begin_layout Section
17816 \begin_layout Standard
17819 Lars Gullik Bjønnes
17822 \begin_layout Subsection
17826 \begin_layout Standard
17827 The aim for this chapter
17831 \begin_layout Standard
17832 Editor's note: Lars' original chapter was a masterful description of how
17838 However, it was too long to flow smoothly in this document.
17839 I have therefore chosen to excerpt the most important sections here (sorry,
17840 Lars); you can read the original chapter (and more of the story!) in the
17843 examples/multicol.lyx
17851 is to show how the LaTeX package
17855 can be used in a LyX document.
17856 As LyX doesn't support the
17860 package natively yet, we have to use some small hacks.
17861 By reading this section it should be obvious how to do this.
17864 \begin_layout Subsection
17868 \begin_layout Standard
17873 package allows switching between one and multicolumn format on the same
17875 Footnotes are handled correctly (for the most part), but will be placed
17876 at the bottom of the page and not under each column.
17877 LaTeX's float mechanism, however, is partly disabled in the current implementat
17879 At the moment only page-wide floats can be used within the scope of the
17883 \begin_layout Subsection
17887 \begin_layout Subsubsection
17891 \begin_layout Standard
17892 If you want to have two columns in your text, you have use LaTeX mode to
17897 begin{multicols}{2}
17899 at the point where you want the two column layout to start, and then
17905 where you want it to end.
17909 \begin_layout Standard
17913 \begin_layout Standard
17917 begin{multicols}{2}
17925 \begin_layout Standard
17930 The Adventure of the Empty House
17936 Sir Arthur Conan Doyle
17939 \begin_layout Standard
17942 It was in the spring of the year 1894 that all London was interested, and
17943 the fashionable world dismayed, by the murder of the Honourable Ronald
17944 Adair under most unusual and inexplicable circumstances.
17945 The public has already learned those particulars of the crime which came
17946 out in the police investigation, but a good deal was suppressed upon that
17947 occasion, since the case for the prosecution was so overwhelmingly strong
17948 that it was not necessary to bring forward all the facts.
17949 Only now, at the end of nearly ten years, am I allowed to supply those
17950 missing links which make up the whole of that remarkable chain.
17951 The crime was of interest in itself, but that interest was as nothing to
17952 me compared to the inconceivable sequel, which afforded me the greatest
17953 shock and surprise of any event in my adventurous life.
17954 Even now, after this long interval, I find myself thrilling as I think
17955 of it, and feeling once more that sudden flood of joy, amazement, and increduli
17956 ty which utterly submerged my mind.
17957 Let me say to that public, which has shown some interest in those glimpses
17958 which I have occasionally given them of the thoughts and actions of a very
17959 remarkable man, that they are not to blame me if I have not shared my knowledge
17960 with them, for I should have considered it my first duty to do so, had
17961 I not been barred by a positive prohibition from his own lips, which was
17962 only withdrawn upon the third of last month.
17965 \begin_layout Standard
17969 \begin_layout Standard
17981 \begin_layout Subsubsection
17985 \begin_layout Standard
17986 The same pattern is used when you want more than two columns:
17989 \begin_layout Standard
17993 \begin_layout Standard
17997 begin{multicols}{3}
18005 \begin_layout Standard
18008 It can be imagined that my close intimacy with Sherlock Holmes had interested
18009 me deeply in crime, and that after his disappearance I never failed to
18010 read with care the various problems which came before the public.
18011 And I even attempted, more than once, for my own private satisfaction,
18012 to employ his methods in their solution, though with indifferent success.
18013 There was none, however, which appealed to me like this tragedy of Ronald
18015 As I read the evidence at the inquest, which led up to a verdict of willful
18016 murder against some person or persons unknown, I realized more clearly
18017 than I had ever done the loss which the community had sustained by the
18018 death of Sherlock Holmes.
18019 There were points about this strange business which would, I was sure,
18020 have specially appealed to him, and the efforts of the police would have
18021 been supplemented, or more probably anticipated, by the trained observation
18022 and the alert mind of the first criminal agent in Europe.
18023 All day, as I drove upon my round, I turned over the case in my mind and
18024 found no explanation which appeared to me to be adequate.
18025 At the risk of telling a twice-told tale, I will recapitulate the facts
18026 as they were known to the public at the conclusion of the inquest.
18029 \begin_layout Standard
18033 \begin_layout Standard
18045 \begin_layout Standard
18046 You can have more than 3 columns if you want to, but that might not be very
18047 pleasant for the eye.
18050 \begin_layout Subsubsection
18051 Columns inside columns
18054 \begin_layout Standard
18055 You can even have columns inside columns:
18058 \begin_layout Standard
18062 \begin_layout Standard
18066 begin{multicols}{2}
18074 \begin_layout Standard
18077 The Honourable Ronald Adair was the second son of the Earl of Maynooth,
18078 at that time governor of one of the Australian colonies.
18079 Adair's mother had returned from Australia to undergo the operation for
18080 cataract, and she, her son Ronald, and her daughter Hilda were living together
18084 \begin_layout Standard
18088 \begin_layout Standard
18092 begin{multicols}{2}
18100 \begin_layout Standard
18103 The youth moved in the best society--had, so far as was known, no enemies
18104 and no particular vices.
18105 He had been engaged to Miss Edith Woodley, of Carstairs, but the engagement
18106 had been broken off by mutual consent some months before, and there was
18107 no sign that it had left any very profound feeling behind it.
18108 For the rest {sic} the man's life moved in a narrow and conventional circle,
18109 for his habits were quiet and his nature unemotional.
18110 Yet it was upon this easy-going young aristocrat that death came, in most
18111 strange and unexpected form, between the hours of ten and eleven-twenty
18112 on the night of March 30, 1894.
18115 \begin_layout Standard
18119 \begin_layout Standard
18131 \begin_layout Standard
18134 Ronald Adair was fond of cards--playing continually, but never for such
18135 stakes as would hurt him.
18136 He was a member of the Baldwin, the Cavendish, and the Bagatelle card clubs.
18137 It was shown that, after dinner on the day of his death, he had played
18138 a rubber of whist at the latter club.
18139 He had also played there in the afternoon.
18144 The evidence of those who had played with him-- Mr.
18145 Murray, Sir John Hardy, and Colonel Moran--showed that the game was whist,
18146 and that there was a fairly equal fall of the cards.
18147 Adair might have lost five pounds, but not more.
18148 His fortune was a considerable one, and such a loss could not in any way
18150 He had played nearly every day at one club or other, but he was a cautious
18151 player, and usually rose a winner.
18152 It came out in evidence that, in partnership with Colonel Moran, he had
18153 actually won as much as four hundred and twenty pounds in a sitting, some
18154 weeks before, from Godfrey Milner and Lord Balmoral.
18155 So much for his recent history as it came out at the inquest.
18158 \begin_layout Standard
18162 \begin_layout Standard
18174 \begin_layout Standard
18175 Please do read the file
18177 examples/multicol.lyx
18179 for more advanced examples including column and header spacing, vertical
18180 separator lines, and more.
18183 \begin_layout Section
18188 Paragraph Environment
18189 \begin_inset OptArg
18192 \begin_layout Standard
18193 Numbering in Enumerate
18201 \begin_layout Standard
18207 \begin_layout Standard
18208 \begin_inset VSpace bigskip
18214 \begin_layout Standard
18216 The default numbering for the
18220 paragraph environment begins with Arabic numbers and ends with uppercase
18222 Suppose, however, you wanted a different type of numbering scheme.
18223 Here's a quickie example of how to change the numbering scheme:
18226 \begin_layout LyX-Code
18236 \begin_layout LyX-Code
18246 \begin_layout LyX-Code
18256 \begin_layout LyX-Code
18266 \begin_layout Standard
18267 \SpecialChar \ldots{}
18268 which changes the numbering scheme to uppercase Roman numerals, uppercase
18269 letters, Arabic numbers, and lowercase letter.
18272 \begin_layout Standard
18273 Additionally, the previous example also adds a little bit extra to the numbering
18275 For example, the first level label actually looks like:
18276 \begin_inset Quotes eld
18280 \begin_inset Quotes erd
18284 For ease of reading, we'll describe what the numbering schemes look like
18285 using a notation something like this: <
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
18325 As you can see in the example, there is a label command for each nesting
18332 \SpecialChar \ldots{}
18339 , as well as a counter,
18343 \SpecialChar \ldots{}
18349 There are also five
18350 \begin_inset Quotes eld
18354 \begin_inset Quotes erd
18387 , each of which take one counter as an argument.
18388 You can add characters before or after these, but there's no need to add
18392 \begin_layout Standard
18393 You can get really fancy with these.
18397 \begin_layout LyX-Code
18411 \begin_layout LyX-Code
18423 \begin_layout LyX-Code
18433 \begin_layout LyX-Code
18443 \begin_layout Standard
18444 produces the somewhat out of hand numbering scheme: <
18445 \begin_inset Quotes eld
18449 \begin_inset Quotes erd
18454 \begin_inset Quotes erd
18458 \begin_inset Quotes erd
18463 \begin_inset Quotes erd
18467 \begin_inset Quotes erd
18472 \begin_inset Quotes eld
18476 \begin_inset Quotes erd
18483 \begin_layout Standard
18487 \begin_layout Section
18491 \begin_layout Standard
18497 \begin_layout Standard
18498 \begin_inset VSpace bigskip
18504 \begin_layout Standard
18509 \begin_layout Standard
18515 tmpfont}{cmr17 scaled 2500}{
18527 \begin_layout Standard
18532 \begin_layout Standard
18543 hose of you who like the style of old books probably also like
18544 \begin_inset Quotes eld
18548 \begin_inset Quotes erd
18551 ---those large capital letters which begin each new chapter or section.
18552 Implementing them with plain LyX/LaTeX is straightforward (assuming you
18553 know some plain TeX!) but does require a lot of work and many iterations,
18554 as you can see by all the ugly TeX-mode stuff at the beginning of this
18558 \begin_layout Standard
18562 \begin_layout Standard
18568 bigdrop{-1em}{3}{ptmri}{T}+
18573 here is a much easier way of doing this, of course.
18582 ) package from CTAN allows a simple way to add such letters to your documents.
18583 Since this package is not a standard part of teTeX, I can't demonstrate
18584 it within this document, but if you copy this paragraph to a new document,
18586 \begin_inset Quotes eld
18596 \begin_inset Quotes erd
18599 and the pluses from the TeX code at the beginning of the paragraph, and
18604 usepackage{dropcaps}
18606 to your LaTeX preamble, you will get a nice Times Roman Italic
18607 \begin_inset Quotes eld
18611 \begin_inset Quotes erd
18614 , whose height is three lines of text and which protrudes 1 em into the
18616 (Make certain you have copied
18617 \begin_inset Quotes eld
18625 \begin_inset Quotes erd
18628 into a directory where TeX can see it.) The first argument is the amount
18629 of indentation; in this case the negative sign moves it into the margin.
18630 The second argument is the height of the letter in number of lines of text.
18631 The third argument is the font name: virtually anything which has a tfm
18632 file should work (wade through the
18634 .../texmf/fonts/tfm
18636 directory for possibilities).
18637 My personal favorite is
18638 \begin_inset Quotes eld
18646 \begin_inset Quotes erd
18649 , a fancy German font specifically designed for dropped capitals.
18650 The fourth argument is the letter (or letters) to be dropped.
18655 package also offers the
18661 command, as well as a slightly simplified
18670 \begin_layout Section
18671 Non-standard Paragraph Shapes
18674 \begin_layout Standard
18680 \begin_layout Standard
18681 \begin_inset VSpace bigskip
18687 \begin_layout Standard
18691 \begin_layout Standard
18703 \begin_layout Standard
18707 \begin_layout Standard
18716 \begin_layout Standard
18730 \begin_layout Standard
18735 \begin_layout Standard
18746 \begin_layout Standard
18755 \begin_layout Standard
18764 \begin_layout Standard
18773 \begin_layout Standard
18782 \begin_layout Standard
18791 \begin_layout Standard
18800 \begin_layout Standard
18809 \begin_layout Standard
18818 \begin_layout Standard
18827 \begin_layout Standard
18836 \begin_layout Standard
18845 \begin_layout Standard
18854 \begin_layout Standard
18863 \begin_layout Standard
18872 \begin_layout Standard
18881 \begin_layout Standard
18890 \begin_layout Standard
18899 \begin_layout Standard
18908 \begin_layout Standard
18914 There are times when the tyranny of rectangular paragraphs must be overthrown.
18915 In such situations, a call to the delightful plain TeX command
18922 As you can see, completely arbitrary shapes can be laid out with a suitable
18923 set of linelength definitions.
18924 While this parshape may look a bit silly and useless, one could conceive
18925 of situations such as finely tuned dropped capitals, word wrapping around
18926 non-rectangular graphics, etc.
18927 which will benefit from such handcrafting.
18930 \begin_layout Standard
18931 \begin_inset VSpace bigskip
18937 \begin_layout Standard
18942 parshape numlines #1indent #1length #2indent #2length \SpecialChar \ldots{}
18949 is the number of lines of text which define the paragraph.
18950 If there turn out to be fewer lines, the shape is truncated; if there are
18951 more, the excess lines have the same dimensions as the last line of the
18961 entries specify the indentation of the line from the left margin, and the
18962 length of the line as measured from that point.
18963 The shape applies only to the current paragraph; everything is reset to
18964 normal for the next paragraph.
18967 \begin_layout Standard
18971 \begin_layout Standard
18983 \begin_layout Section
18987 \begin_layout Standard
18988 As you can see, the examples in this section range from the useful to the
18990 While I don't expect that anyone will ever need the paragraph shape demonstrate
18991 d in the last section, the important point is that you can do almost anything
18992 you want in LyX if you are willing to figure out how to do it in TeX and
18994 TeX is a fantastically powerful typesetting system and all that power is
18995 available to you since LyX uses it as its backend.
projects / lyx.git / blob