1 #LyX 1.5.2svn created this file. For more info see http://www.lyx.org/
8 \newcommand{\extratablespace}[1]{\noalign{\vskip#1}}
14 % set fonts for nicer pdf view
15 \IfFileExists{lmodern.sty}
16 {\usepackage{lmodern}} % if it exists
18 \usepackage[scaled=0.92]{helvet}
21 } % end if it exists not
23 % link all cross references and URLs
25 \usepackage[colorlinks=true, bookmarks, bookmarksnumbered, bookmarksopen, bookmarksopenlevel=1,
26 linkcolor=black, citecolor=black, urlcolor=blue, filecolor=blue,
27 pdfpagelayout=OneColumn, pdfnewwindow=true,
28 pdfstartview=XYZ, plainpages=false, pdfpagelabels,
29 pdfauthor={LyX Team}, pdftex,
30 pdftitle={LyX's Extended manual},
31 pdfsubject={LyX's extended documentation},
32 pdfkeywords={LyX, Documentation, Extended}]{hyperref}
34 \else % if dvi or ps is produced
36 % link all cross references and URLs in DVI output
37 \usepackage[ps2pdf, colorlinks=true,
38 linkcolor=black, citecolor=black, urlcolor=blue, filecolor=blue]{hyperref}
40 \fi % end if pdflatex is used
42 % redefine the \LyX macro for PDF bookmarks
43 \def\LyX{\texorpdfstring{%
44 L\kern-.1667em\lower.25em\hbox{Y}\kern-.125emX\@}
51 \font_typewriter default
52 \font_default_family default
58 \paperfontsize default
66 \paperorientation portrait
69 \paragraph_separation indent
71 \quotes_language english
74 \paperpagestyle headings
75 \tracking_changes false
92 \begin_layout Standard
94 Principal maintainer of this file is
99 If you have comments or error corrections, please send them to the LyX
100 Documentation mailing list, <lyx-docs@lists.lyx.org>.
108 \begin_layout Standard
109 \begin_inset LatexCommand tableofcontents
116 \begin_layout Chapter
120 \begin_layout Standard
123 Extended LyX Features
125 manual, which you are now reading, is essentially Part II of the
127 User's Guide\SpecialChar \@.
130 The reason for splitting this document is simple: the
134 is already huge, and it contains all of the basic features one needs to
135 know in order to prepare most documents.
136 However, the LyX Team has a long-term goal of making LyX extensible through
137 various configuration files and external packages.
138 That means that if you want to support the Fizzwizzle LaTeX package, you
139 can create a layout file for it without having to alter LyX itself.
140 We've already had contributions of several new features this way.
141 This is the place where all of that gets documented.
144 \begin_layout Standard
145 This manual also documents some special features, like fax support, version
146 control, and SGML support, which require additional software to work properly.
147 Lastly, there's a chapter of LaTeX tools and tips, things you can use to
148 spruce up your documents by directly using the powerful features of LaTeX.
153 only WYSIWYM, and will only ever interface to certain LaTeX features.
156 \begin_layout Standard
157 Of course, with all of this extra documentation,
159 Extended LyX Features
161 may itself grow too big for its britches.
162 In that case, you can just call it the
163 \begin_inset Quotes eld
167 \begin_inset Quotes erd
173 \begin_layout Standard
174 If you haven't read the
178 yet, you are definitely in the wrong manual.
183 is the first place to go, since it will direct you to the correct manual,
184 and it also describes the notation and format of all of the manuals.
185 You should also be thoroughly familiar with the
189 and all of the basic features of LyX.
193 \begin_layout Standard
194 In this document, many sections are independent articles contributed by
195 an individual and are noted as such.
196 This person is generally whoever wrote the layout file for the new document
197 class or LaTeX package, or implemented the feature.
198 If there is no mention of an author to a chapter [or chapter sections],
199 that means it was written by the LyX Documentation Team.
202 \begin_layout Standard
203 Since all the topics in this manual depend heavily on LyX's interaction
204 with LaTeX, this first chapter covers the inner workings of LyX and how
205 to direct LyX to generate exactly the LaTeX code you want.
206 It is obviously for more seasoned LyX users.
209 \begin_layout Chapter
213 \begin_layout Section
217 \begin_layout Standard
218 \begin_inset LatexCommand label
219 name "sec:lyxandlatex"
223 This chapter is for both TeX-nicians and the LaTeX-curious.
224 In it, we'll explain how LyX and LaTeX work together to produce printable
226 This is the only place in any of the manuals where we assume you know something
230 \begin_layout Standard
231 At one time, we called LyX a
232 \begin_inset Quotes eld
235 WYSIWYM frontend to LaTeX,
236 \begin_inset Quotes erd
239 but that's no longer true.
240 There are frontends to LaTeX out there.
241 They are basically editors with the ability to run LaTeX and mark any errors
242 in the file you're editing.
251 run LaTeX, and it also marks errors in the file, it also does much, much
253 Thanks to the WYSIWYM concept, you don't need LaTeX to use LyX effectively.
254 LyX has also added a few extensions to LaTeX.
255 Try the following sometime: select
257 Export\SpecialChar \menuseparator
267 menu, then look at the preamble of the resulting
272 You'll notice a variety of new macros defined specifically by LyX.
273 These macros are defined automatically, according to the features you use
277 \begin_layout Standard
278 There are several commands that automatically invoke LaTeX.
282 \begin_layout Itemize
288 iew\SpecialChar \menuseparator
295 \begin_layout Itemize
301 iew\SpecialChar \menuseparator
306 pdate\SpecialChar \menuseparator
312 \begin_layout Itemize
320 \SpecialChar \menuseparator
326 \begin_layout Itemize
334 \SpecialChar \menuseparator
340 \begin_layout Standard
341 They will only invoke LaTeX if the file has changed since the last time
346 \begin_layout Standard
347 When you run LaTeX on the file you're editing, LyX performs these steps:
350 \begin_layout Enumerate
351 Convert the document to LaTeX and save to a file with the extension
362 \begin_layout Enumerate
367 file (maybe several times).
370 \begin_layout Enumerate
371 If there are any errors, insert error boxes in the document to mark where
373 These boxes are transient and are not saved along with the document.
376 \begin_layout Standard
377 If you've run LaTeX using
399 , LyX performs two more steps:
402 \begin_layout Itemize
407 to convert the DVI file to PostScript:
411 \begin_layout Itemize
417 , the output file has the extension
422 \begin_layout Itemize
431 , the output file has the extension
439 \begin_layout Itemize
444 or send the PostScript file to the printer.
447 \begin_layout Section
448 \begin_inset Quotes eld
451 Help! LyX generated an unreadable
456 \begin_inset Quotes erd
462 \begin_layout Standard
463 Die-hard LaTeX users will scream and howl this into the night, then declare
464 LyX useless, simply because they didn't RTFM.
467 \begin_layout Standard
468 We're going to set the record straight.
469 LyX produces two kinds of LaTeX files.
470 One is human readable.
471 The other is LyX readable.
472 Every time LyX executes LaTeX, it produces a LaTeX file that it can easily
478 file is not human readable.
479 Don't even try to read it.
484 file that you can send to a colleague, select
489 xport\SpecialChar \menuseparator
506 \begin_layout Section
507 Translating LaTeX files into LyX
508 \begin_inset LatexCommand label
509 name "sec:Translating-LaTeX-files"
516 \begin_layout Standard
517 You can import a LaTeX file into LyX by using the
522 ile\SpecialChar \menuseparator
527 mport\SpecialChar \menuseparator
535 This will call a program named
539 ---which will create a file
547 ---and then open that file.
550 \begin_layout Standard
555 will translate most legal LaTeX, but not everything.
556 It will leave things it doesn't understand in TeX mode, so after translating
561 , you can look for red text and hand-edit it to look right.
564 \begin_layout Standard
565 If you just want to put a piece of LaTeX code into a LyX file, see Section\InsetSpace ~
567 \begin_inset LatexCommand ref
568 reference "sec:latexcodes"
575 \begin_layout Section
576 Inserting LaTeX Code into LyX Documents
577 \begin_inset LatexCommand label
578 name "sec:Inserting-LaTeX-Code"
585 \begin_layout Standard
586 \begin_inset LatexCommand label
587 name "sec:latexcodes"
591 This is a rather important point: You can always insert LaTeX code into
593 LyX simply cannot, and will probably never be able to, display every possible
595 If ever you need to insert LaTeX commands into your LyX document, you can
596 use the ERT box, which you can insert into your document with
601 nsert\SpecialChar \menuseparator
609 The ERT box comes in three forms: collapsed, open, and inlined.
610 The first two are used just like any other collapsible (foldable) box (such
611 as footnotes), and are useful for significant amounts of LaTeX commands.
613 \begin_inset Quotes eld
617 \begin_inset Quotes erd
620 ERT box displays its content as part of the button, and is useful for very
621 short sections of LaTeX commands.
626 \begin_layout Standard
636 \begin_layout Standard
637 You can switch between all three by right-clicking on the ERT.
638 Note that if you want more than one line of LaTeX commands, you cannot
639 use the inlined mode.
642 \begin_layout Standard
643 Here's an example of inserting LaTeX commands in a LyX document.
644 The code looks like this:
647 \begin_layout LyX-Code
656 This is an example for a minipage environment.
659 can put nearly everything in it, even (non-floating)
702 \begin_layout LyX-Code
706 \begin_layout Standard
707 The ERT box containing this text is directly after this paragraph.
708 Those of you reading the manual online will only see a bunch of funky text
710 Those reading a printed version of the manuals will see the actual results:
713 \begin_layout Standard
717 \begin_layout Standard
724 \begin_layout Standard
731 \begin_layout Standard
733 This is an example for a minipage environment.
734 You can put nearly everything in it, even (non-floating) figures and tables.
738 \begin_layout Standard
745 \begin_layout Standard
750 \begin_layout Standard
757 \begin_layout Standard
764 \begin_layout Standard
771 \begin_layout Standard
777 \begin_layout Standard
784 \begin_layout Standard
791 \begin_layout Standard
798 \begin_layout Standard
810 \begin_layout Standard
811 In addition to these two methods, you can also create a separate file containing
812 some complex LaTeX structure.
818 nsert\SpecialChar \menuseparator
826 to include your file (you should select the type
831 We recommend that you only do this if you have a
840 Otherwise, you'll have a big job tracking down LaTeX errors\SpecialChar \ldots{}
844 \begin_layout Standard
845 There are a few last notes to emphasize:
848 \begin_layout Itemize
849 Inside of LyX, LaTeX code appears
854 \begin_layout Itemize
859 check if your LaTeX code is correct.
862 \begin_layout Itemize
863 Beware reinventing the wheel.
866 \begin_layout Standard
867 That last note refers to two things.
868 First, LyX does have quite a few features tucked into it, and more are
870 Be sure to check the manuals to make sure that LyX doesn't have such-and-such
871 feature before you go off merrily coding LaTeX.
872 Second, there are numerous LaTeX packages out there to do all sorts of
873 things, from labels to envelopes to fancy multipage tables.
874 Check out a CTAN site for details (see Section
875 \begin_inset Quotes eld
879 \begin_inset Quotes erd
890 \begin_layout Standard
895 : I seem to do this an awful lot.
896 Sat down and merrily began coding something to print out labels, only to
897 learn that there were already 2 different LaTeX packages to do this.
898 Worse yet --- I had them already!
906 \begin_layout Standard
907 If you do need to do some wild and fancy things within your document, be
908 sure to check out a good LaTeX book for assistance.
909 There are a number of them listed in the bibliography of the
916 \begin_layout Standard
917 There are a number of LaTeX commands which have to be placed before the
918 beginning of the actual text.
919 They go into the preamble, and this is explained in the next section.
922 \begin_layout Section
923 LyX and the LaTeX Preamble
926 \begin_layout Subsection
927 About the LaTeX Preamble
930 \begin_layout Standard
931 \begin_inset LatexCommand label
936 If you already know LaTeX, there is no need to explain here what the preamble
938 If you don't, the following will give you some ideas --- we recommend again
939 that you consult a LaTeX book for further information.
940 In any case, you should read the points below, because they explain what
941 you can do and what you don't need to do in the LaTeX preamble of a LyX
945 \begin_layout Standard
946 The LaTeX preamble comes at the very beginning of a document,
954 \begin_layout Itemize
955 declare the document class.
956 LyX already does this for you.
960 \begin_layout Standard
961 If you're a seasoned LaTeX-nician, and you have some custom document class
962 you want to use, check out the
966 for information on how to make LyX interface to it.
967 Be sure to submit your efforts to the LyX Team for inclusion in future
972 \begin_layout Itemize
973 declare the usage of packages.
974 LaTeX packages provide special commands, which are only available within
975 a document when the package has been declared in the preamble.
976 For example, the package
980 forces all paragraphs to be indented.
981 There are other packages for labels, envelopes, margins, etc.
985 \begin_layout Itemize
986 set counters, variables, lengths and widths.
987 There are several LaTeX counters and variables which
991 be set globally from within the preamble in order to have the desired effect.
992 [There are other variables which you can set and reset inside the document,
993 too.] Margins are a good example of something which must be set in the preamble.
994 Another example is the label format for lists.
995 You can actually set these just about anywhere, but it's best to do it
996 just once, inside the preamble.
999 \begin_layout Itemize
1000 declare user defined commands [with
1012 ], mostly abbreviations for LaTeX commands which appear very often inside
1014 Although the preamble is a good place to declare such commands, they
1018 be declared anywhere else [but
1022 they are used for the first time, of course\SpecialChar \ldots{}
1024 This can be useful if there is a lot of raw LaTeX code in your document,
1025 which normally should not be the case.
1028 \begin_layout Standard
1029 LyX adds its own set of definitions to the preamble of the
1034 This makes LaTeX files generated by LyX portable.
1037 \begin_layout Subsection
1038 Changing the Preamble
1041 \begin_layout Standard
1042 The commands which LyX adds to the preamble of a LaTeX file are fixed; you
1043 can't change them without patching LyX itself.
1044 You can, however, add your own stuff to the preamble.
1045 There are two ways to do this:
1048 \begin_layout Enumerate
1075 \SpecialChar \menuseparator
1083 dialog, depending on your frontend.
1084 Note that the LyX keybindings will not work in this dialog, alas.
1087 \begin_layout Enumerate
1088 Use the preamble contents you've added as your default template (see
1089 \begin_inset Quotes eld
1093 \begin_inset Quotes erd
1100 ), so that it will be the default preamble for any file you create.
1103 \begin_layout Standard
1104 LyX adds anything in the
1111 dialog to its own built-in preamble.
1112 Before adding your own declarations in the preamble, you should make sure
1113 that LyX doesn't already support what you want to do (remember what we
1114 said about reinventing the wheel?).
1117 make sure your preamble code is correct
1120 LyX doesn't check it.
1123 \begin_layout Subsection
1127 \begin_layout Standard
1128 Here are some examples of what you can add to a preamble, and what they
1132 \begin_layout Subsubsection
1136 \begin_layout Standard
1137 There are two variables under LaTeX that control page position:
1150 Their names should be self-explanatory.
1151 These variables are useful if you think for a moment about computer labels.
1152 Sometimes, the size of a print medium and the area of the medium that you
1153 can actually print on aren't the same.
1169 \begin_layout Standard
1170 The default values for
1182 are both 0 pt.,\InsetSpace ~
1185 the page isn't shifted.
1188 \begin_layout Standard
1189 Unfortunately, some DVI drivers always seem to shift the page.
1190 We have no idea why, or why the sysadmin hasn't fixed such behavior.
1191 If you're using LyX on a system that you don't personally maintain, and
1192 your sysadmin is a doofus,
1205 Suppose you're left and top margins are always 0.5 inches too big.
1206 You can add this to the preamble:
1209 \begin_layout LyX-Code
1217 \begin_layout LyX-Code
1225 \begin_layout Standard
1226 \SpecialChar \ldots{}
1227 and your margins should now be correct.
1230 \begin_layout Subsubsection
1234 \begin_layout Standard
1235 Speaking of labels, suppose you wanted to print out a bunch of address labels.
1236 There's a rather nice package, available at your nearest CTAN archive,
1237 for printing sheets of labels, called
1242 Now, your system may not have this package installed by default.
1243 We leave that up to you to check.
1244 You'll also want to read the documentation for it; we're not going to do
1246 Since this is an example, however, we'll give you an example of how you
1250 \begin_layout Standard
1251 First, make sure you're using the
1256 Next, you need to put the following in your preamble:
1259 \begin_layout LyX-Code
1265 \begin_layout LyX-Code
1271 \begin_layout LyX-Code
1277 \begin_layout LyX-Code
1283 \begin_layout LyX-Code
1289 \begin_layout LyX-Code
1295 \begin_layout LyX-Code
1301 \begin_layout Standard
1302 This sets things up for Avery® label sheets, stock #5360.
1303 You're now ready to print labels, but you'll need to insert LaTeX code,
1304 placing the commands
1316 around each label text.
1317 This and other special features of
1321 are explained in its documentation.
1324 \begin_layout Standard
1325 Someday, someone may write a LyX layout file to support this package directly.
1326 Maybe that someone is you.
1329 \begin_layout Subsubsection
1330 Example #3: Paragraph Indentation
1333 \begin_layout Standard
1334 Americans are trained to indent the first line of
1339 As with all of their other weird quirks, most Americans will whine and
1340 moan until they can have their way and indent the first line of all paragraphs.
1344 \begin_layout Standard
1349 : This was written by an American ---
1353 ! It's my perception of my fellow countrymen.
1354 Tough if you don't like it.
1363 \begin_layout Standard
1364 Of course, this behavior isn't standard typography.
1365 In books, you typically only indent the first line of a paragraph
1369 it follows another one.
1370 The idea behind indenting the first line of a paragraph is to distinguish
1371 neighboring paragraphs from one another.
1372 If there is no previous paragraph, for example, it follows a figure, or
1373 is the first paragraph in a section, then there is no special indentation.
1377 \begin_layout Standard
1378 If you're a typical American, though, you don't care about such esoteric
1379 things; you want your indentation! Add this to the preamble:
1382 \begin_layout LyX-Code
1385 usepackage{indentfirst}
1388 \begin_layout Standard
1389 If your TeX distribution isn't a braindead one, you'll have this package,
1390 and all of your paragraphs will get the indentation you think they deserve.
1393 \begin_layout Subsubsection
1394 Example #4: This Document
1397 \begin_layout Standard
1398 You can also check out the preamble of this document to get an idea of some
1399 of the advanced things you can do.
1400 You'll probably need to make the
1405 reamble\SpecialChar \ldots{}
1408 dialog full-screen to see most of it.
1409 Also, there are more examples and an assortment of LaTeX
1410 \begin_inset Quotes eld
1414 \begin_inset Quotes erd
1417 given in Chapter\InsetSpace ~
1419 \begin_inset LatexCommand ref
1420 reference "cha:secrets"
1428 \begin_layout Section
1429 LyX and LaTeX Errors
1432 \begin_layout Standard
1433 When LyX calls LaTeX, it tells LaTeX to blithely ignore any errors and keep
1435 It then uses the log-file from the LaTeX run to do a post-mortem.
1436 As we stated earlier in the chapter, LyX generates two kinds of
1440 files, one of which it uses to locate errors in the document.
1441 If there was an error someplace, LyX will put a box with the word
1442 \begin_inset Quotes eld
1446 \begin_inset Quotes erd
1449 at the appropriate place in the document.
1453 \begin_layout Standard
1454 LyX will occasionally misguess where the error was.
1455 This will typically happen with tables, figures, math, and the preamble.
1460 It will also display a message alerting you to the fact that there were
1464 \begin_layout Standard
1465 You can navigate through the errors by using
1481 \begin_inset Quotes eld
1485 \begin_inset Quotes erd
1488 the error-boxes and view the error message LaTeX produced by clicking on
1492 \begin_layout Standard
1493 Some folks also like to look at the log file directly, accessible from
1498 ocument\SpecialChar \menuseparator
1508 There are some fairly common error messages and warnings.
1509 We'll cover those here.
1510 You should look at a good LaTeX book for a complete listing.
1513 \begin_layout Itemize
1514 \begin_inset Quotes eld
1522 \begin_inset Quotes eld
1529 \begin_layout Standard
1530 Anything beginning with these word is a warning message for the purpose
1532 \begin_inset Quotes eld
1536 \begin_inset Quotes erd
1539 the LaTeX code itself.
1540 You'll get messages like this if you added or changed cross-references
1541 or bibliography entries, in which case, LaTeX is trying to tell you that
1542 you need to make another run.
1545 \begin_layout Standard
1546 You can by-and-large ignore these.
1550 \begin_layout Itemize
1551 \begin_inset Quotes eld
1559 \begin_inset Quotes erd
1566 \begin_layout Standard
1567 Another warning message, this time about fonts which LaTeX couldn't find.
1568 The rest of the message will often say something about a replacement font
1572 \begin_layout Standard
1573 You can safely ignore these.
1577 \begin_layout Itemize
1578 \begin_inset Quotes eld
1588 \begin_inset Quotes erd
1595 \begin_layout Standard
1601 They are warning you about lines that were too long and run past the right
1603 Almost always, this is unnoticeable in the final output.
1604 Or, only one or two characters extend past the margin.
1605 LaTeX seems to generate at least one of these messages for just about any
1609 \begin_layout Standard
1610 You can ignore these stupid messages.
1611 Your eyes will tell you if there's a problem with something that's too
1612 wide; just look at the output.
1616 \begin_layout Itemize
1617 \begin_inset Quotes eld
1627 \begin_inset Quotes erd
1634 \begin_layout Standard
1635 Not quite as common as its cousin.
1636 LaTeX seems to like to print lines that are a bit too wide as opposed to
1637 ones that are a bit too narrow.
1638 We have no idea why.
1641 \begin_layout Standard
1642 You can ignore these, too.
1646 \begin_layout Itemize
1647 \begin_inset Quotes eld
1657 \begin_inset Quotes erd
1661 \begin_inset Quotes eld
1671 \begin_inset Quotes erd
1678 \begin_layout Standard
1679 Warnings about troubles breaking the page.
1680 Once again, just look at the output.
1681 Your eyes will tell you where something has gone wrong.
1685 \begin_layout Itemize
1686 \begin_inset Quotes eld
1692 \begin_inset Quotes els
1696 \begin_inset Quotes ers
1702 \begin_inset Quotes erd
1709 \begin_layout Standard
1711 \begin_inset Quotes eld
1715 \begin_inset Quotes erd
1718 isn't installed on this system.
1719 This usually appears because some package your document needs isn't installed.
1720 If you didn't touch the preamble or didn't use the
1726 command, then one of the packages LyX tried to load is missing.
1732 elp\SpecialChar \menuseparator
1739 , to get a list of packages that LyX knows about.
1740 This file is updated whenever you reconfigure LyX (using
1747 \SpecialChar \menuseparator
1752 ) and tells you which packages have been detected and what they do.
1755 \begin_layout Standard
1766 command, and the package in question isn't installed, you'll need to install
1771 \begin_layout Itemize
1772 \begin_inset Quotes eld
1777 LaTeX Error: Unknown option
1780 \begin_inset Quotes erd
1787 \begin_layout Standard
1788 Error messages beginning with this are trying to tell you that you specified
1789 a bad or undefined option to a package.
1790 Check the package's documentation.
1794 \begin_layout Itemize
1795 \begin_inset Quotes eld
1800 Undefined control sequence
1803 \begin_inset Quotes erd
1810 \begin_layout Standard
1811 If you've inserted LaTeX code into your document, but made a typo, you'll
1813 You may have forgotten to load a package.
1814 In any case, this error message usually means that you used an undefined
1819 \begin_layout Standard
1820 There are other error and warning messages.
1821 Some are self-explanatory.
1822 These are usually LaTeX messages.
1823 Others are downright cryptic.
1824 These are actually TeX error messages, and we really have
1828 what they mean or how to decipher them.
1831 \begin_layout Standard
1832 There's a general sequence you should follow if you get error messages:
1835 \begin_layout Enumerate
1836 Look at the LaTeX code you inserted for typos.
1839 \begin_layout Enumerate
1840 If there are no typos, check and see that you used the command(s) correctly.
1843 \begin_layout Enumerate
1844 If you get a bunch of error boxes piled up at the very top of the document,
1845 it means that there are errors in the preamble.
1846 Start debugging your preamble.
1849 \begin_layout Enumerate
1850 If you didn't add anything to the preamble and didn't add any LaTeX code
1851 to the document, the first suspect is your LaTeX distribution itself.
1852 Check for missing packages and install them.
1855 \begin_layout Enumerate
1856 Okay, so there are no missing packages.
1857 Did you use any of the fine-tuning options in LyX? Specifically, did you
1862 any of them, like trying to manually insert lots of
1864 Protected\InsetSpace ~
1875 s? Did you try to kludge something together with these instead of using
1876 the appropriate paragraph environment?
1879 \begin_layout Enumerate
1880 All right, you didn't use any of the fine-tuning options, you played by
1882 Did you try to pull a fancy maneuver? Did you do something funky inside
1883 a table or an equation, like inserting a graphic into a table cell?
1886 \begin_layout Enumerate
1887 Do you have long sections of text where LaTeX cannot find a place to break
1888 a line? By default, LaTeX is rather strict about how much extra inter-word
1889 spacing it will add in order to break a line.
1890 Preferably, you should rework the paragraph to avoid the problem.
1891 If this isn't an option, you can wrap your text in
1897 to make LaTeX's line breaking more, well, sloppy.
1900 \begin_layout Enumerate
1901 Did you go overboard with the nesting? LyX (currently) doesn't check to
1902 make sure you're in the limits for nesting environments.
1903 If you nested a bunch of environments to the
1904 \begin_inset Formula $17^{\mathrm{th}}$
1907 level, that's the problem.
1910 \begin_layout Enumerate
1911 Okay, you didn't get any error messages, but your output looks whacked.
1912 If you have a table or figure that's too wide or long for the page, you
1917 \begin_layout Enumerate
1918 rescale the figure so it fits.
1921 \begin_layout Enumerate
1922 trim down the table so it fits.
1925 \begin_layout Standard
1926 If something else is wrong with the output, and you didn't try to pull anything
1927 fancy or kludge the fine-tuning options, we're not sure what's wrong.
1931 \begin_layout Standard
1932 If all this doesn't help --- well, then
1936 you might have found a bug in LyX\SpecialChar \ldots{}
1940 \begin_layout Chapter
1944 \begin_layout Section
1945 Preparing a Bibliography with BibTeX
1946 \begin_inset LatexCommand label
1947 name "sec:Preparing-a-Bibliography"
1954 \begin_layout Standard
1961 Jürgen Spitzmüller
1964 \begin_layout Standard
1965 \begin_inset VSpace bigskip
1971 \begin_layout Standard
1973 STOP! If you don't know what BibTeX is, or have a reasonably good idea of
1976 e.\InsetSpace \thinspace{}
1980 setting up your own bibliographic databases),
1984 , do not walk, to your nearest copy of the 2nd edition of Lamport's
1986 LaTeX: A Document Preparation System
1988 , particularly Appendix B.
1989 The rest of this discussion assumes you have created a correct bibliography
1990 file, that you have all relevant environment variables set correctly (esp.
2003 ), and that if sufficiently desperate, you could create and
2004 \begin_inset Quotes eld
2008 \begin_inset Quotes erd
2011 a LaTeX file with a BibTeX database.
2015 \begin_layout Standard
2016 For those who don't know what BibTeX is, it is a system for creating a large
2017 database of your most used journal references.
2018 For all future articles you write, you only need to include this standard
2019 database and reference the appropriate key to each reference.
2020 Even if you write only a few papers with handful of references each, it
2021 is well worth your time to examine BibTeX and decide whether it will be
2025 \begin_layout Standard
2026 To use BibTeX with LyX, first read the
2030 where it describes how to insert citations.
2031 The basic mechanism for inserting BibTeX references is the same.
2032 Then, at the very end of your document, select
2034 Insert\SpecialChar \menuseparator
2039 TOC\SpecialChar \menuseparator
2043 In the resulting dialog, fill out the dialog boxes as follows:
2046 \begin_layout Description
2047 Database: enter the name of your
2060 For searching multiple
2064 files, just enter them in the desired order, separated by commas.
2068 \begin_layout Description
2069 Style: enter the name of your BibTeX style file *without* the
2074 The default style is
2078 (which should be included in your LaTeX distribution, so you don't have
2079 to worry about creating it).
2082 \begin_layout Standard
2083 For each citation, assuming that the source is in the
2092 nsert\SpecialChar \menuseparator
2099 at the correct location in the text, and enter the appropriate reference
2101 Nothing else is required; when invoking
2106 iew\SpecialChar \menuseparator
2113 , for example, you should see that BibTeX and LaTeX are invoked as needed,
2114 including multiple invocations of LaTeX.
2118 \begin_layout Subsection
2119 Alternative Citation Styles
2122 \begin_layout Standard
2123 Standard BibTeX uses numbers (e.\InsetSpace \thinspace{}
2124 g.\InsetSpace \space{}
2126 \begin_inset Quotes eld
2130 \begin_inset Quotes erd
2133 ) to refer to a cited work.
2134 However, in many scientific disciplines, other citation styles are in use.
2135 The most common one is the author-year style (e.\InsetSpace \thinspace{}
2136 g.\InsetSpace \space{}
2138 \begin_inset Quotes eld
2142 \begin_inset Quotes erd
2146 LyX supports two packages that provide this style,
2155 Both packages have their own pros and cons, which cannot be listed in detail.
2156 If you only want to have simple author-year (or author-numerical) style
2157 or if you want to use one of the countless style files for natbib, than
2162 package is probably your choice.
2163 If you need special features like short title references, ibidem etc., you
2164 might consider the fairly new
2171 \begin_layout Standard
2172 The handling of both packages in LyX is basically the same.
2178 ocument\SpecialChar \menuseparator
2189 pane (with the xforms frontend: the
2203 With both packages, you will get some extra features in the citation dialog
2204 and you can select the style of the reference (
2205 \begin_inset Quotes eld
2209 \begin_inset Quotes erd
2213 \begin_inset Quotes eld
2217 \begin_inset Quotes erd
2221 \begin_inset Quotes eld
2225 \begin_inset Quotes erd
2229 \begin_inset Quotes eld
2233 \begin_inset Quotes erd
2237 Note that both packages need specifically designed style files (they both
2238 ship their own, while there are lots of additional style files and even
2239 an interactive style file builder
2243 \begin_layout Standard
2245 \begin_inset LatexCommand url
2246 target "ftp://ctan.tug.org/tex-archive/macros/latex/contrib/custom-bib/"
2262 \begin_layout Subsection
2263 Sectionated Bibliographies
2264 \begin_inset LatexCommand label
2265 name "sub:Sectionated-Bibliographies"
2272 \begin_layout Standard
2273 Sometimes you might need to divide your bibliography into several sections.
2274 If you are, for instance, a historian, the possibility to separate sources
2275 and scientific works is most likely a
2276 \begin_inset Quotes eld
2280 \begin_inset Quotes erd
2284 Unfortunately, BibTeX itself does not allow you to do this.
2285 The good news is, though: With the help of some LaTeX packages, BibTeX
2286 can be extended to fit your historical needs.
2289 \begin_layout Standard
2290 As of version 1.4, LyX provides native support for one of these packages,
2299 \begin_layout Standard
2301 \begin_inset LatexCommand url
2302 target "ftp://ctan.tug.org/tex-archive/macros/latex/contrib/bibtopic/"
2311 The advantage of this package (compared to other packages like
2315 ) is that you don't need to define new citation commands.
2316 Instead, you need to prepare different bibliographic databases which include
2317 the entries for the different sections of the bibliography.
2318 For example: If you want to divide your bibliography into the sections
2320 \begin_inset Quotes eld
2324 \begin_inset Quotes erd
2328 \begin_inset Quotes eld
2332 \begin_inset Quotes erd
2335 , you first need to create two bibliographic databases, e.\InsetSpace \thinspace{}
2336 g.\InsetSpace \space{}
2349 \begin_layout Standard
2355 ocument\SpecialChar \menuseparator
2366 pane (with the xforms frontend: the
2373 Sectionated\InsetSpace ~
2377 Now you can insert multiple BibTeX references (as described in section\InsetSpace ~
2379 \begin_inset LatexCommand ref
2380 reference "sec:Preparing-a-Bibliography"
2384 ), one for each section of your bibliography.
2385 Returning to our example: Insert a BibTeX reference for the database
2389 and a second one for the database
2394 You are free to use the same or different styles for each section.
2395 Additionally, you can chose if the bibliography section should contain
2397 \begin_inset Quotes eld
2400 all cited references
2401 \begin_inset Quotes erd
2404 of the specified database(s) (which is the default),
2405 \begin_inset Quotes eld
2408 all uncited references
2409 \begin_inset Quotes erd
2413 \begin_inset Quotes eld
2417 \begin_inset Quotes erd
2421 This might be useful if you would like to separate your bibliography into
2423 \begin_inset Quotes eld
2427 \begin_inset Quotes erd
2431 \begin_inset Quotes eld
2435 \begin_inset Quotes erd
2439 \begin_inset Quotes eld
2443 \begin_inset Quotes erd
2447 The titles for the sections can be added as ordinary sections or subsections.
2452 removes the bibliography title, you have manually re-add that, too (as
2453 a chapter* or section*, for instance).
2456 \begin_layout Subsection
2457 Multiple Bibliographies
2460 \begin_layout Standard
2461 Multiple bibliographies, e.\InsetSpace \thinspace{}
2462 g.\InsetSpace \space{}
2463 a bibliography for each section or chapter of
2464 the document, are not supported by BibTeX itself.
2469 package, which is used for the creation of sectionated bibliographies in
2470 LyX (cf.\InsetSpace ~
2471 section\InsetSpace ~
2473 \begin_inset LatexCommand ref
2474 reference "sub:Sectionated-Bibliographies"
2478 ), provides an easy way to solve this task, if you are willing to use some
2479 LaTeX-Code (ERT, cf.\InsetSpace ~
2480 section\InsetSpace ~
2482 \begin_inset LatexCommand ref
2483 reference "sec:Inserting-LaTeX-Code"
2491 \begin_layout Standard
2492 An alternative approach is to use the
2500 package, respectively.
2508 \begin_layout Standard
2514 ocument\SpecialChar \menuseparator
2525 pane (with the xforms frontend: the
2532 Sectionated\InsetSpace ~
2536 In the document, you have to enclose the sections, which shall contain
2537 their own bibliography (including the BibTeX reference itself), between
2550 (those commands have to be inserted as ERT).
2551 The bibliography will contain all references which have been cited in the
2553 N.\InsetSpace \thinspace{}
2554 B.: If you are using this approach, then
2558 citation reference has to be inside some btUnit.
2559 Also, the btUnits cannot be nested.
2562 \begin_layout Section
2566 \begin_layout Standard
2567 A good index is one of the hardest things to make in a lengthy document,
2568 but LyX helps make things a bit simpler by interfacing to the
2572 program which is found in most recent LaTeX distributions.
2576 \begin_layout Standard
2596 Outputs\SpecialChar \menuseparator
2597 LaT\SpecialChar \textcompwordmark{}
2606 section of the preferences dialog, however, you can customize the index
2607 command, if you prefer an alternative program like
2630 Inserting an index and marking words to include in it works much the same
2631 way as preparing a bibliography as mentioned in the last section.
2634 \begin_layout Standard
2635 First, go to the end of your file and select
2640 nsert\SpecialChar \menuseparator
2651 C\SpecialChar \menuseparator
2664 Then, for each word you would like to include in the index, go to the end
2665 of that word and click on
2670 nsert\SpecialChar \menuseparator
2683 This will insert a tag showing the word as it will appear in the index.
2684 That's all there is to it; LyX will automatically call
2688 for you and create the index itself.
2689 The text in the dialog available from right-clicking on the index button
2690 accepts LaTeX, so you'll need to be careful to avoid using any special
2692 On the positive side, you can use the advanced options - have a look at
2693 the documentation which comes with your LaTeX distribution to find out
2694 how to do things like
2695 \begin_inset Quotes eld
2699 \begin_inset Quotes erd
2705 \begin_layout Standard
2706 Be careful not to put spaces between the word in the text and the index
2707 marker; apparently the wrong page number can be produced if this happens.
2710 \begin_layout Section
2714 \begin_layout Subsection
2718 \begin_layout Standard
2719 When you are working on a large file with many sections, it is often convenient
2720 to break up the document into several files, or perhaps you have something
2721 where a table may change from time to time, but the preceding text does
2723 In these cases, you should seriously consider using multipart documents.
2724 For example, scientific papers often have five major sections: the introduction
2725 , observations, results, discussion, and conclusion.
2726 Each of these could be its own separate LyX file, with one
2727 \begin_inset Quotes eld
2731 \begin_inset Quotes erd
2734 file which contains the title, authors, abstract, references, etc., plus
2735 the five included files.
2736 It is important to note that each of these files is a full LyX file which
2737 can be formatted and printed on its own, as well as included in a master
2739 Each of these files must have the same document class, however--- don't
2740 attempt to mix book classes with article classes.
2741 You may also include LaTeX files; however, these files must not have their
2747 everything up to and including the
2759 line must be deleted) or else errors will be generated when you try to
2763 \begin_layout Standard
2764 LyX allows you to include files quite easily with
2769 nsert\SpecialChar \menuseparator
2778 When you click on this selection a small box is inserted into the file
2779 at the current cursor location.
2780 Clicking on the box raises a dialog which allows you to select the file
2781 to be included, and the method of its inclusion.
2785 \begin_layout Standard
2786 The file selection box should by now be obvious.
2787 The three inclusion methods are
2788 \begin_inset Quotes eld
2792 \begin_inset Quotes erd
2796 \begin_inset Quotes eld
2800 \begin_inset Quotes erd
2804 \begin_inset Quotes eld
2808 \begin_inset Quotes erd
2812 The difference between
2813 \begin_inset Quotes eld
2817 \begin_inset Quotes erd
2821 \begin_inset Quotes eld
2825 \begin_inset Quotes erd
2828 is really only meaningful to LaTeXperts, but the practical difference is
2829 that files which are
2830 \begin_inset Quotes eld
2834 \begin_inset Quotes erd
2837 are typeset beginning on a new page, while files which are
2838 \begin_inset Quotes eld
2842 \begin_inset Quotes erd
2845 are typeset starting on the current page.
2846 Perhaps the labeling in LyX will be changed someday to reflect this.
2849 \begin_layout Standard
2850 Generally, the master file is converted into a full LaTeX file before typesettin
2851 g, while the included files are converted to LaTeX files which do not have
2852 all the preamble information.
2862 button prevents this conversion.
2865 \begin_layout Standard
2867 \begin_inset Quotes eld
2871 \begin_inset Quotes erd
2874 included file allows you to include a file typeset exactly as it appears
2875 in the file, i.e.\InsetSpace ~
2876 verbatim mode, with the characters set in a fixed-width
2878 Normally, spaces in this file are invisible, though two consecutive spaces
2879 are conserved, unlike LyX's normal treatment of spaces.
2880 However, setting the
2890 checkbox typesets a mark to unambiguously define the presence of a space.
2894 \begin_layout Subsection
2895 Cross-References Between Files
2898 \begin_layout Standard
2899 It is possible to set up cross-references between the different files.
2900 First, open all the files in question: let's call them A and B in a two
2901 file example, where B is included in A.
2902 Let's say you insert a label in A, then want to reference it in B.
2903 Open the cross-reference dialog in whilst in document B, and you can select
2905 \begin_inset Quotes eld
2909 \begin_inset Quotes erd
2915 \begin_layout Section
2916 Fancy Headers and Footers
2919 \begin_layout Standard
2920 The default page layout is rather plain; for an article document class,
2921 all you get is a centered page number at the bottom of the page.
2922 This document is the book class, so it appears to be a bit fancier, but
2923 to really put on a show, you need to set the document page style to
2924 \begin_inset Quotes eld
2928 \begin_inset Quotes erd
2931 , as mentioned in the
2937 This section describes the LaTeX codes you need to insert in your LaTeX
2938 preamble or the text in order to get the desired effects.
2941 \begin_layout Standard
2942 The page header is divided into three fields, not surprisingly labeled
2943 \begin_inset Quotes eld
2947 \begin_inset Quotes erd
2951 \begin_inset Quotes eld
2955 \begin_inset Quotes erd
2959 \begin_inset Quotes eld
2963 \begin_inset Quotes erd
2967 The footer is also divided into these three fields.
2968 The LaTeX commands to set these fields in the simplest manner are
2993 Suppose you wish to put your name in the upper left hand corner of each
2995 Simply insert the following command in the preamble:
2998 \begin_layout Standard
3007 \begin_layout Standard
3008 You will now see your name in the upper left.
3009 If a field has a default entry that you would like to get rid of (often
3010 the page number appears in the central footer, simply include a command
3011 with a blank argument, e.\InsetSpace \thinspace{}
3015 \begin_layout Standard
3023 \begin_layout Standard
3024 Let's get really fancy: lets put the section number with the word
3025 \begin_inset Quotes eld
3029 \begin_inset Quotes erd
3032 (e.\InsetSpace \thinspace{}
3034 Section 3) in the upper left, the page number (e.\InsetSpace \thinspace{}
3036 Page 4) in the upper
3037 right, your name in the lower left, and the date in the lower right.
3038 The following commands should now appear in the preamble:
3041 \begin_layout Standard
3051 \begin_layout Standard
3059 \begin_layout Standard
3069 \begin_layout Standard
3078 \begin_layout Standard
3086 \begin_layout Standard
3096 \begin_layout Standard
3109 access LaTeX's section and page counters, and so print out the current
3110 section and page numbers.
3117 simply prints out today's date.
3120 \begin_layout Standard
3121 The thicknesses of the horizontal rules drawn beneath the header and above
3122 the footer can also be modified.
3123 If you don't want one of the headers, set its thickness to 0.
3124 The header rule has a default thickness of 0.4pt, the footer rule is 0pt.
3125 Use the commands, e.\InsetSpace \thinspace{}
3133 headrulewidth}{0.4pt}
3141 footrulewidth}{0.4pt}
3143 to set the thicknesses.
3146 \begin_layout Standard
3147 You can switch the header/footer settings on and off for individual pages
3152 thispagestyle{empty}
3158 thispagestyle{plain}
3164 thispagestyle{fancy}
3167 Simply insert them in the text on the page you want changed and mark them
3169 In fact, title pages are marked as plain by default, while following pages
3170 are marked fancy when using the global fancy setting.
3173 \begin_layout Standard
3174 There are more complex commands which will let you insert things in the
3175 upper left on odd numbered pages, etc., but I will refer you to the
3179 package documentation for more descriptions.
3180 For example, if you have a teTeX installation, look for
3182 /usr/share/texmf/doc/latex/fancyhdr/\SpecialChar \-
3188 \begin_layout Standard
3189 As a final example, it is possible to include an Encapsulated PostScript
3190 file in the header or footer.
3191 Suppose you want to put a company logo in the upper lefthand corner.
3192 You might try something like
3195 \begin_layout Standard
3204 includegraphics{logo.eps}}}
3207 \begin_layout Standard
3209 (you may need to preface this with
3213 usepackage{graphics}
3215 if you don't include EPS files elsewhere in your document).
3218 \begin_layout Section
3219 Itemize Bullet Selection
3220 \begin_inset LatexCommand label
3228 \begin_layout Standard
3234 \begin_layout Subsection
3238 \begin_layout Standard
3239 LyX provides 216 bullet shapes that can be accessed from a simple dialog.
3240 Using this dialog you can easily specify what bullet shape to use at each
3241 level of an itemized list.
3242 These settings are document-wide so you won't be able to specify different
3243 sets of bullets for different paragraphs
3247 \begin_layout Standard
3248 Well, actually you can but you'll have to do it by hand.
3256 \begin_layout Subsection
3260 \begin_layout Standard
3261 Open the dialog by selecting the
3266 ocument\SpecialChar \menuseparator
3273 menu item and then select the
3283 \begin_layout Standard
3284 The dialog provides you with a table of bullet shapes.
3285 A column of buttons on the left of the table provides access to the six
3286 different panels of bullet shapes.
3287 The row of buttons across the top is used to select which bullet depth
3289 A text entry under the table shows the currently selected bullet shape's
3290 LaTeX equivalent and this can be edited if desired.
3291 If you do modify the text you will also need to specify any needed packages
3292 in the LaTeX preamble.
3295 \begin_layout Standard
3296 The six panels are divided up by the packages they require.
3297 The following table shows the mappings from button name to LaTeX packages.
3300 \begin_layout Standard
3302 \begin_inset Tabular
3303 <lyxtabular version="3" rows="7" columns="2">
3305 <column alignment="center" valignment="top" leftline="true" width="0pt">
3306 <column alignment="center" valignment="top" leftline="true" rightline="true" width="0pt">
3307 <row topline="true" bottomline="true">
3308 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
3311 \begin_layout Standard
3326 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
3329 \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
3382 <row topline="true">
3383 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
3386 \begin_layout Standard
3401 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
3404 \begin_layout Standard
3420 <row topline="true">
3421 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
3424 \begin_layout Standard
3439 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
3442 \begin_layout Standard
3458 <row topline="true">
3459 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
3462 \begin_layout Standard
3477 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
3480 \begin_layout Standard
3496 <row topline="true">
3497 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
3500 \begin_layout Standard
3515 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
3518 \begin_layout Standard
3534 <row topline="true" bottomline="true">
3535 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
3538 \begin_layout Standard
3553 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
3556 \begin_layout Standard
3579 \begin_layout Standard
3580 LyX doesn't stop you using bullets from packages you don't have.
3581 If you get errors from LaTeX when you try to view or print the file then
3582 its likely you are missing a package.
3583 LyX doesn't restrict your use since you may be editing locally and exporting
3587 \begin_layout Subsection
3591 \begin_layout Standard
3592 Select which bullet depth you want to change then select the bullet shape
3594 Any changes will not be visible in LyX, but are visible when viewing the
3595 document using xdvi or ghostview.
3598 \begin_layout Standard
3599 You can reset a bullet shape to the default simply by clicking your right
3600 mouse button on the appropriate bullet depth button.
3603 \begin_layout Standard
3608 want to have multiple sets of paragraphs with different sets of bullets
3609 in each then you're going to have to get your hands dirty.
3610 The itemize bullet selection dialog can help though because it provides
3611 you with the LaTeX code for a wide range of bullet shapes.
3612 To make your own custom paragraphs you have the following options:
3615 \begin_layout Standard
3619 \begin_layout Standard
3635 \begin_layout Standard
3639 \begin_layout Standard
3661 \begin_layout Itemize
3662 Use the LaTeX command
3668 to specify a new bullet shape for a given depth.
3669 You'll also need to save the current bullet shape so you can restore it
3671 In this itemized list the following LaTeX code was used to change the bullet
3672 used for the first depth.
3704 Note that the itemize depth is specified in Roman numerals as part of the
3714 \begin_layout Itemize
3718 \begin_layout Standard
3731 Specify each individual entry by starting each item with the bullet shape
3732 enclosed in square brackets and set as TeX.
3733 For example, this item was started with
3746 \begin_layout Standard
3750 \begin_layout Standard
3766 \begin_layout Standard
3767 You'll also need to revert the labelitem back to its previous setting for
3768 the global bullet shape settings to remain in effect.
3769 The way used here was:
3782 \begin_layout Chapter
3783 Special Document Classes
3786 \begin_layout Section
3790 \begin_layout Standard
3796 \begin_layout Standard
3797 \begin_inset VSpace bigskip
3803 \begin_layout Standard
3805 The AMS LaTeX layouts are set up to conform to suggested styles for mathematical
3806 papers to be submitted to American Mathematical Society publications.
3807 The layouts are not tailored to a specific journal, but easily can be.
3808 You should refer to the AMS documentation for specific instructions for
3809 each journal (usually it will entail only changing a single line in the
3811 That documentation is available on the Web at
3812 \begin_inset LatexCommand url
3813 target "http://www.ams.org"
3818 \begin_inset LatexCommand url
3819 target "ftp://ftp.ams.org/pub/tex/amslatex/"
3823 .These layouts are appropriate, and useful, for any mathematical writing.
3824 There are currently 4 distinct AMS LaTeX layouts:
3827 \begin_layout Enumerate
3828 amsart: The standard AMS-article format.
3829 All results and similar statements are numbered as
3830 \begin_inset Formula $(n.m)$
3833 , where the first number refers to the section, and the second refers to
3834 the total number of results (Theorems, Corollaries, Propositions, Definitions
3835 and Remarks, etc.) in that section.
3836 There are also many (but not all) environments available unnumbered, which
3837 is occasionally needed.
3838 Unnumbered environments indicated by an asterisk at the end.
3841 \begin_layout Enumerate
3842 amsart-seq: Here, numbering for each type of statement is in its own sequence,
3843 with no reference to the section number.
3844 There are also many (but not all) environments available unnumbered, which
3845 is occasionally needed.
3846 Unnumbered environments indicated by an asterisk at the end.
3849 \begin_layout Enumerate
3850 amsart-plain: This one is even more terse, since all the environments are
3854 \begin_layout Enumerate
3855 amsbook: the standard AMS book (really, monograph) format.
3856 Numbering is similar to the amsart layout, except that all numbering is
3858 \begin_inset Formula $(n.m.p)$
3861 , where the first number refers to the chapter, the second to the section,
3862 and the third is the number of the results (Theorems, Corollaries, Propositions
3863 , Definitions and Remarks, etc.) in that section.
3864 There are also many (but not all) environments available unnumbered, which
3865 is occasionally needed.
3866 Unnumbered environments indicated by an asterisk at the end.
3869 \begin_layout Standard
3870 Any AMS LyX file can be converted to either of the numbering schemes by
3871 simply changing the document class in the
3876 ocument\SpecialChar \menuseparator
3887 \begin_layout Subsection
3888 What these layouts provide
3891 \begin_layout Standard
3892 There is a long list of included environments provided by these layouts.
3893 Most mathematical papers or books will set as special statements most of
3894 these environments, in AMS-LaTeX there is an opportunity to define an unlimited
3895 variety of such declarations.
3896 However, the AMS recommends the environments that are available in LyX.
3897 The list of environments (not counting the standard environments such as
3900 sections, bibliography, title, author, date
3905 \begin_layout Description
3906 Theorem This is typically used for the statements of major results.
3908 \begin_inset Quotes eld
3916 \begin_inset Quotes erd
3919 appears in bold type, along with an automatically-determined number (an
3924 , is also available).
3925 The text is italicized.
3928 \begin_layout Description
3929 Corollary This is used for statements which follow fairly directly from
3930 previous statements.
3931 Again, these can be major results.
3939 \begin_layout Description
3940 Lemma These are smaller results needed to prove other statements.
3943 \begin_layout Description
3944 Proposition These are less major results which (hopefully) add to the general
3945 theory being discussed.
3948 \begin_layout Description
3949 Conjecture These are statements provided without justification, which the
3950 author does not know how to prove, but which seem to be true (to the author,
3954 \begin_layout Description
3955 Criterion A required condition.
3958 \begin_layout Description
3959 Algorithm A general procedure to be used.
3962 \begin_layout Description
3963 Axiom This is a property or statement taken as true within the system being
3967 \begin_layout Description
3968 Definition Guess what this is for.
3969 The font, both on-screen and in the output, is different for this environment
3970 than for the previous ones.
3972 \begin_inset Quotes eld
3976 \begin_inset Quotes erd
3979 ) is still set in boldface, along with the number, if any, but the rest
3983 \begin_layout Description
3984 Example Typeset similarly to Definition.
3987 \begin_layout Description
3991 \begin_layout Description
3995 \begin_layout Description
3999 \begin_layout Description
4000 Remark This environment is also a new type of theorem.
4001 This is set with the word Remark in italics, and the rest upright.
4004 \begin_layout Description
4005 Note Set similarly to the Remark environment.
4008 \begin_layout Description
4012 \begin_layout Description
4016 \begin_layout Description
4020 \begin_layout Description
4024 \begin_layout Description
4025 Case Generally, these are used to break up long arguments, using specific
4026 instances of some condition.
4027 The numbering scheme for cases is on its own, not together with other numbered
4032 \begin_layout Description
4036 \begin_layout Description
4040 \begin_layout Description
4042 \begin_inset Quotes eld
4050 \begin_inset Quotes erd
4053 is set in italics, but the rest is set upright.
4054 At the end of this environment (other environments can be nested within
4055 this one, of course) a QED symbol (usually a square, but it can vary with
4056 different styles) is placed.
4059 \begin_layout Description
4060 Address This should be the author's permanent address.
4063 \begin_layout Description
4064 Current\InsetSpace ~
4065 Address This should be the author's temporary address at the time
4066 of submission, if different from the Address.
4069 \begin_layout Description
4070 Email Author's e-mail address
4073 \begin_layout Description
4074 URL Author's Web address, if desired.
4077 \begin_layout Description
4078 Keywords Key words or phrases used to identify specific topics discussed
4082 \begin_layout Description
4083 Subjectclass These refer to the AMS Subject Classifications, published and
4086 Mathematical Reviews
4089 These are also available online at the AMS cites listed above.
4092 \begin_layout Description
4096 \begin_layout Description
4100 \begin_layout Description
4104 \begin_layout Standard
4105 In addition, these environments automatically provide the AMS LaTeX and
4107 They need to be available on your system in order to use these environments.
4110 \begin_layout Section
4114 \begin_layout Standard
4119 can be used to type letters according to German conventions.
4120 A template file is included in
4122 .../lyx/share/templates
4124 for you to use as a starting point.
4127 \begin_layout Section
4131 \begin_layout Standard
4136 provides an alternative to the standard
4141 It provides similar functionality, but you might prefer this layout with
4142 sans serif sections, headings, and more.
4145 \begin_layout Section
4149 \begin_layout Standard
4155 \begin_layout Subsection
4159 \begin_layout Standard
4160 This section describes how LyX can be used to write articles for submission
4161 to the scientific journal
4163 Astronomy and Astrophysics
4166 \begin_inset LatexCommand url
4167 name "www.edpsciences.fr/aa/"
4168 target "http://www.edpsciences.fr/aa/"
4172 ) using Version 5.01 of the document class
4177 This package can be downloaded from the ftp site
4180 \begin_layout Standard
4181 \begin_inset VSpace medskip
4187 \begin_layout Standard
4189 \begin_inset LatexCommand url
4190 target "ftp://ftp.edpsciences.org/pub/aa/readme.html"
4197 \begin_layout Standard
4198 \begin_inset VSpace medskip
4204 \begin_layout Standard
4205 A manual comes together with that package, and this text is not meant to
4206 replace the original manual but merely a short guide how to realize the
4207 correct form of your paper.
4211 \begin_layout Standard
4212 Please note that the publisher of the journal was changed from Springer
4213 to EDP Sciences starting January 1, 2001.
4214 That change implicated also some slight changes of the style files, namely
4215 the removal of the thesaurus command.
4216 The LyX class aa supports the newest version of these style files, V 5.01.
4217 If you have an older version installed, please upgrade.
4218 For compatibility, the old (version 4) layout has been kept as
4223 Please refer to the comments in
4225 LyXDir/layouts/aapaper.layout
4230 \begin_layout Subsection
4234 \begin_layout Standard
4235 It is recommended you start from the example template distributed with LyX.
4236 If you are not using a template, note the following settings:
4239 \begin_layout Itemize
4249 ocument\SpecialChar \menuseparator
4256 dialog (OK, that one was obvious).
4259 \begin_layout Itemize
4260 Don't change the option
4270 The whole layout is done by the macros, you shouldn't change anything.
4273 \begin_layout Subsection
4277 \begin_layout Standard
4278 First thing to enter is the header information.
4279 It consists of seven entries, of which some are optional.
4283 \begin_layout Itemize
4291 \begin_layout Itemize
4299 \begin_layout Itemize
4307 \begin_layout Itemize
4315 \begin_layout Itemize
4320 : [optional] if more than one author: whom to contact for offprint requests.
4323 \begin_layout Itemize
4328 : [optional] mail address for contacts.
4331 \begin_layout Itemize
4339 Received: <date>; Accepted <date>
4342 \begin_layout Standard
4343 There is no need to issue the
4349 command, this is done automatically by LyX when the header is finished.
4350 Although the order of the single header entries doesn't matter it is advised
4351 to keep the above sequence, just to get the best optics and meets the layout
4352 of the real document.
4355 \begin_layout Standard
4356 If you want to place footnotes in the header block, e.\InsetSpace \thinspace{}
4361 \begin_layout Standard
4370 to state your present address, just use the standard footnote via
4375 nsert\SpecialChar \menuseparator
4383 LyX will automagically use the term
4392 \begin_layout Standard
4393 In addition to these topics, the macros use three additional LaTeX commands
4394 that have no counterpart in LyX:
4397 \begin_layout Itemize
4404 to separate different names for more than one author and institute, respectivel
4408 \begin_layout Itemize
4415 to mark corresponding author/institute pairs.
4416 The institutes are numbered sequentially as they appear in the
4420 field, so you have to put a marker to each author.
4423 \begin_layout Itemize
4430 to supply an email address for fast contact.
4433 \begin_layout Standard
4434 In all cases, the appropriate command has to be entered in LyX and marked
4440 \begin_layout Subsection
4444 \begin_layout Standard
4445 The abstract should immediately follow the header block.
4446 With version 5 the abstract environment was changed to a command, and there
4447 is now a resctriction to only one paragraph.
4448 In addition, it should contain an entry with the keywords.
4449 This is not yet implemented for LyX, therefore you have to enter the LaTeX
4456 by hand and mark it as LaTeX code.
4457 Refer to the example paper.
4460 \begin_layout Subsection
4461 Supported environments
4464 \begin_layout Standard
4465 The A&A paper layout supports the following environments for structuring
4469 \begin_layout Itemize
4475 \begin_layout Itemize
4481 \begin_layout Itemize
4487 \begin_layout Itemize
4493 \begin_layout Itemize
4499 \begin_layout Itemize
4505 \begin_layout Itemize
4511 \begin_layout Itemize
4517 \begin_layout Itemize
4523 \begin_layout Itemize
4529 \begin_layout Itemize
4535 \begin_layout Itemize
4541 \begin_layout Subsection
4542 Commands not supported by LyX
4545 \begin_layout Standard
4546 Some commands are not yet supported by the
4551 Some have already been mentioned.
4552 For the sake of completeness, they are listed all together here:
4555 \begin_layout Itemize
4563 \begin_layout Itemize
4571 \begin_layout Itemize
4579 \begin_layout Itemize
4587 \begin_layout Itemize
4595 \begin_layout Itemize
4603 \begin_layout Itemize
4611 \begin_layout Itemize
4619 \begin_layout Standard
4620 If you want to use any of these commands, you have to enter them yourself.
4623 Do not forget to mark them as LaTeX code!
4626 \begin_layout Subsection
4627 Figure and Table Floats
4630 \begin_layout Standard
4631 LyX provides support for the necessary float environments
4633 figure, figure*, table
4639 , therefore we won't tell much about it here.
4646 Just remember that tables should be left-aligned.
4647 For that, select the table and change the alignment in
4652 dit\SpecialChar \menuseparator
4657 aragraph\InsetSpace ~
4661 \begin_layout Standard
4662 There is only one special thing: the figures with caption besides the figure.
4663 To create such a figure, you have to do the following:
4666 \begin_layout Enumerate
4667 Create a wide figure float:
4672 nsert\SpecialChar \menuseparator
4677 t\SpecialChar \menuseparator
4680 , then right click in the figure and select
4691 \begin_layout Enumerate
4692 Enter your caption text.
4695 \begin_layout Enumerate
4700 to move the cursor above the caption.
4703 \begin_layout Enumerate
4707 \begin_layout Enumerate
4708 Position the cursor behind the figure and insert a horizontal fill:
4713 nsert\SpecialChar \menuseparator
4721 \SpecialChar \menuseparator
4724 orizontal\InsetSpace ~
4730 \begin_layout Enumerate
4731 Switch to LaTeX mode:
4739 \begin_layout Enumerate
4749 Do not close the brace!
4752 \begin_layout Enumerate
4753 Position the cursor behind the caption text, switch to LaTeX mode and insert
4766 \begin_layout Standard
4767 Also, refer to the figures in the example paper.
4770 \begin_layout Subsection
4774 \begin_layout Standard
4775 For submission, the paper has to be formated in a special double-spacing
4777 For this purpose, you have to give the option
4781 to the documentclass.
4782 This must be done using the extra class options field in the
4787 ocument\SpecialChar \menuseparator
4795 Just enter the string
4802 \begin_layout Subsection
4806 \begin_layout Standard
4811 directory contains an example paper written with LyX.
4812 It is the example paper from the original macro package, translated to
4814 Use it for inspiration, and compare the original LaTeX code with LyX way
4818 \begin_layout Section
4822 \begin_layout Standard
4828 \begin_layout Subsection
4832 \begin_layout Standard
4833 AASTeX is a set of macros produced by the American Astronomical Society
4834 to facilitate electronic manuscript submission to the three journals they
4835 publish: the Astrophysical Journal (including the Letters and Supplement),
4836 the Astronomical Journal, and the Publications of the Astronomical Society
4838 LyX has proven to be an excellent tool for generating these documents,
4839 especially given its equation, citation, and figure handling capabilities.
4840 LyX requires version 5.0 (or higher) of these macros; preferably 5.2, which
4841 is the version described here, or higher.
4842 Versions prior to 5.0 are intended for use with LaTeX2.09 and are fundamentally
4843 incompatible with LyX.
4844 The AASTeX package may be downloaded from the AASTeX Web site
4847 \begin_layout Standard
4848 \begin_inset VSpace medskip
4854 \begin_layout Standard
4856 \begin_inset LatexCommand url
4857 target "http://www.journals.uchicago.edu/AAS/AASTeX"
4864 \begin_layout Standard
4865 \begin_inset VSpace medskip
4871 \begin_layout Standard
4872 A complete user guide is contained in that package and you should familiarize
4873 yourself with it thoroughly before embarking on writing a paper in LyX.
4874 LyX will not reduce the need to figure out all the AASTeX commands, it
4875 will only reduce the drudgery of typing everything in.
4876 It is your responsibility to ensure that the final exported LaTeX document
4877 conforms completely to the requirements of the journal to which you are
4878 submitting your paper.
4881 \begin_layout Subsection
4882 Starting a New Paper
4885 \begin_layout Standard
4886 I strongly suggest that you start with the AASTeX template file.
4892 ile\SpecialChar \menuseparator
4902 , enter the new file name, then choose the
4907 This will show the most common fields found in a manuscript.
4908 Simply overwrite the existing text (including the brackets,
4912 ) with the correct information.
4913 Many of the AASTeX commands and environments can be implemented directly
4914 in LyX, but some cannot: most noticeably
4926 , which should stick out like a sore thumb if you actually just opened the
4928 For commands such as these, the LaTeX code must be entered directly and
4930 Such commands are referred to as ERT, or Evil Red Text.
4931 I tried to minimize the amount of ERT needed in an AASTeX document, but
4932 there is still a bit more required than any of us would like.
4935 \begin_layout Subsection
4936 Finishing Your Paper
4939 \begin_layout Standard
4940 When the paper is finished to your satisfaction and previews/prints correctly,
4942 \begin_inset Quotes eld
4946 \begin_inset Quotes erd
4949 actions which need to be done before you submit it to the journals.
4953 \begin_layout Enumerate
4954 Export your paper as a LaTeX file (
4959 ile\SpecialChar \menuseparator
4964 xport\SpecialChar \menuseparator
4975 \begin_layout Enumerate
4980 file with your favorite text editor
4984 \begin_layout Enumerate
4985 remove the comment lines before the
4994 \begin_layout Enumerate
4999 usepackage...{fontenc}
5001 line if it appears (usually just after
5016 \begin_layout Enumerate
5017 remove everything between (and including) the
5029 commands, except for any commands you specifically put into the LaTeX preamble
5030 (which should appear immediately after the
5031 \begin_inset Quotes eld
5034 User specified LaTeX commands
5035 \begin_inset Quotes erd
5046 \begin_layout Enumerate
5047 Run the resulting file through LaTeX to make sure it still processes correctly.
5050 \begin_layout Enumerate
5051 Reread the journal requirements to make sure your filenames and formats
5055 \begin_layout Enumerate
5059 \begin_layout Subsection
5060 Comments On Specific Commands
5063 \begin_layout Standard
5064 I will not describe the detailed usage of the individual AASTeX commands:
5065 the AASTeX User Guide (
5069 ) gives a good description of each.
5070 Thus it's probably easiest for me to go down the list as found in the guide
5071 and offer comments where necessary.
5072 So let's begin \SpecialChar \ldots{}
5076 \begin_layout Subsubsection
5077 Things that work as expected
5080 \begin_layout Standard
5084 \begin_layout Standard
5096 \begin_layout Standard
5097 Because they work as you might expect, I simply list them and the section
5198 begin{thebibliography}
5206 (2.13.2), all the cite commands and their variations (2.13.2), the generic
5207 graphicx figure commands (2.14.1),
5231 (2.15.4, amongst other places),
5258 \begin_layout Standard
5259 The following style options also work correctly:
5280 Simply put them in the
5286 Layout\SpecialChar \menuseparator
5292 \begin_layout Standard
5296 \begin_layout Standard
5308 \begin_layout Subsubsection
5309 Things that work, but require more comment
5312 \begin_layout Standard
5313 The following items work, but require a little more discussion:
5316 \begin_layout Itemize
5317 These items are reserved for use by the journal editors, but you can put
5318 them into the LaTeX preamble if you feel compelled to do so:
5351 \begin_layout Itemize
5352 These items may be placed in the LaTeX preamble, and are included as blanks
5353 in the template file:
5374 \begin_layout Itemize
5381 (2.3) -- can only be used
5382 \begin_inset Quotes eld
5386 \begin_inset Quotes erd
5389 , not in the middle of a paragraph.
5390 Use ERT if you need to embed it.
5393 \begin_layout Itemize
5400 (2.3) -- will have extra {} after it.
5401 This should not cause an error.
5404 \begin_layout Itemize
5411 (2.6) -- can only be used
5412 \begin_inset Quotes eld
5416 \begin_inset Quotes erd
5419 , not in the middle of a paragraph.
5420 Use ERT if you need to embed it.
5423 \begin_layout Itemize
5430 (2.8) -- can't insert a cross-reference tag, you must type the tag name
5434 \begin_layout Itemize
5441 (2.8) -- same as for
5448 \begin_layout Itemize
5455 (2.9) -- will have extra {} after it.
5456 This should not cause an error.
5459 \begin_layout Itemize
5466 (2.11) -- will have extra {} after it.
5467 This should not cause an error.
5470 \begin_layout Itemize
5477 (2.14.2) -- you can insert an optional filename argument by placing the cursor
5478 at the beginning of the text and selecting
5480 Insert\SpecialChar \menuseparator
5485 \begin_inset Quotes eld
5489 \begin_inset Quotes erd
5492 inserts an optional argument of the type needed by
5499 Hopefully it will be renamed someday.
5502 \begin_layout Itemize
5515 for the catalog ID optional parameter
5518 \begin_layout Itemize
5531 for the catalog ID optional parameter
5534 \begin_layout Subsubsection
5535 Things not implemented, use ERT
5538 \begin_layout Standard
5542 \begin_layout Standard
5554 \begin_layout Standard
5577 setcounter{equation}
5579 (2.12), Journal name abbreviations (2.13.4),
5615 (2.15.4, insert it as the first element in the lefthand cell after where
5617 Don't use any of LyX's rules in the table),
5629 (2.15.5), much of Misc (2.17, except
5680 \begin_layout Standard
5684 \begin_layout Standard
5696 \begin_layout Subsubsection
5697 Things that cannot be implemented
5700 \begin_layout Standard
5701 \SpecialChar \ldots{}
5702 at least in any meaningful sort of way, so I suggest ignoring them.
5703 They are the references environment (2.13.3), and the deluxetable environment
5705 If you really, really need to use deluxetable, I suggest editing it in
5706 a separate file with a text editor, then using
5711 nsert\SpecialChar \menuseparator
5719 to include it in your LyX document.
5724 file to see an example of this.
5727 \begin_layout Subsection
5728 FAQs, Tips, Tricks, and Other Ruminations
5731 \begin_layout Subsubsection
5732 Getting LyX and AASTeX to cooperate
5735 \begin_layout Standard
5736 It can be a bit tricky to get LyX to recognize a new layout and document
5738 When all else fails, do this:
5741 \begin_layout Enumerate
5742 Make certain that LaTeX can find AASTeX.
5743 Copy sample.tex (and perhaps table.tex) from the AASTeX distribution into
5744 a directory completely unrelated to LaTeX or AASTeX and run LaTeX on
5751 \begin_layout Enumerate
5758 /usr/.../share/lyx/layouts
5767 \begin_layout Enumerate
5773 ools\SpecialChar \menuseparator
5780 in LyX, then restart LyX.
5783 \begin_layout Enumerate
5784 Open a regular new file, not from a template.
5785 Does AASTeX appear in the class list in
5790 ocument\SpecialChar \menuseparator
5800 \begin_layout Standard
5801 If you get a warning from an existing AASTeX document about not being able
5802 to find the AASTeX layout or a message about
5803 \begin_inset Quotes eld
5806 You should not mix title layouts with normal ones
5807 \begin_inset Quotes erd
5810 , things haven't been installed correctly.
5813 \begin_layout Subsubsection
5814 LaTeX error processing a table
5817 \begin_layout Standard
5818 LyX, by default, attempts to center the table caption/title.
5819 This seems to produce a bad interaction in AASTeX so you should click somewhere
5820 in the caption/title, then select
5825 dit\SpecialChar \menuseparator
5830 aragraph\InsetSpace ~
5845 This took care of it for me.
5848 \begin_layout Subsubsection
5850 \begin_inset LatexCommand label
5858 \begin_layout Standard
5859 A couple of things: 1) I have noticed some funny spacing in the reference
5860 entries in the text.
5861 When you enter the bibliography item data, make sure their is
5865 space between the last author and the parenthesis setting off the year;
5868 e.\InsetSpace \thinspace{}
5881 2) Entering the references at all is not obvious.
5882 The easiest thing is to start typing your first reference at the end of
5883 the document, then mark it as type
5888 That will put a small gray box in front of what you just typed.
5889 Click on the box to fill in the rest of the information.
5890 For new references, go to the end of an existing reference and press return.
5891 That will create a new line with its own box, etc.
5894 \begin_layout Subsubsection
5898 \begin_layout Standard
5899 Even though AASTeX provides its own figure commands (
5905 , for example), I much prefer LaTeX's standard figure commands (with the
5914 commands as ERT into a Figure Float box if you desire, but I never
5915 have much luck getting the layout right.
5916 With the standard graphics, LyX will insert a
5920 usepackage{graphicx}
5922 command into the LaTeX preamble and handle the figures in the standard
5923 LaTeX2e way, interspersing the figures in the text.
5924 I believe ApJ accepts figures exactly this way now; AJ might still use
5926 \begin_inset Quotes eld
5929 stack everything at the end
5930 \begin_inset Quotes erd
5936 \begin_layout Subsubsection
5937 Things I could have done, but didn't
5940 \begin_layout Standard
5942 \begin_inset Quotes eld
5946 \begin_inset Quotes erd
5949 things I could have implemented, but chose not to.
5950 For instance, I saw no point in double-spacing the text in the LyX window,
5951 even though it is double-spaced in the paper manuscript.
5952 Also, I chose not to make separate layouts for the preprint and preprint2
5954 Since I assume you will spend most of your time in the plain manuscript
5955 mode anyway, I decided not to chew up more disk space with this.
5959 \begin_layout Subsection
5963 \begin_layout Standard
5964 Your mileage may vary.
5965 I've now had papers published by both ApJ and AJ that have had 98% of the
5966 effort done in LyX; the last 2% was the LaTeX post-processing and a few
5968 I have had no trouble with the submission process, and I'm sure the journals
5969 were never aware that there might be a difference.
5970 So, go forth and publish!
5973 \begin_layout Section
5977 \begin_layout Standard
5980 Panayotis Papasotiriou
5983 \begin_layout Subsection
5987 \begin_layout Standard
5988 The ijmpc package is a set of macros that facilitates electronic manuscript
5991 International Journal of Modern Physics C
5994 Similarly, the ijmpd package is for creating manuscripts to be submitted
5997 International Journal of Modern Physics D
6000 Both journals are published by World Scientific.
6001 The corresponding document classes are named
6010 These files, together with instructions for the authors, can be downloaded
6012 \begin_inset LatexCommand url
6013 target "http://www.worldscinet.com/ijmpc/mkt/guidelines.shtml"
6018 \begin_inset LatexCommand url
6019 target "http://www.worldscinet.com/ijmpd/mkt/guidelines.shtml"
6024 Both packages are modified versions of the standard
6025 \begin_inset Quotes eld
6029 \begin_inset Quotes erd
6032 package, and they are almost (but not exactly) identical.
6033 Most of their features are supported by LyX.
6034 I have used LyX successfully to write articles submitted to both journals
6035 without any problem.
6038 \begin_layout Subsection
6042 \begin_layout Standard
6043 As usual, the easiest way to write a paper is to start with a template.
6049 ile\SpecialChar \menuseparator
6068 This will give an (almost) empty document that includes the most common
6069 fields found in a manuscript.
6070 Simply overwrite the existing text (including the brackets,
6075 You should keep in mind the following remarks.
6078 \begin_layout Enumerate
6079 LyX won't let you change the font size and the page style of the document,
6080 because such modifications are not allowed by both packages.
6083 \begin_layout Enumerate
6084 The language of the document should not be changed.
6085 Before previewing your paper, be sure that the babel package is not used.
6086 To do this, click on
6091 ools\SpecialChar \menuseparator
6109 checkbox in the language settings, and click on
6120 , if you wish to make this change permanent).
6123 \begin_layout Enumerate
6125 \begin_inset Quotes eld
6129 \begin_inset Quotes erd
6132 style must be used to define keywords.
6135 \begin_layout Enumerate
6136 The ijmpc package provides a style named
6137 \begin_inset Quotes eld
6140 Classification Codes
6141 \begin_inset Quotes erd
6144 , which can be used to define classification codes, such as PACS numbers.
6145 Note that this facility is not supported by the ijmpd package.
6148 \begin_layout Enumerate
6149 Several new environments are available:
6150 \begin_inset Quotes eld
6154 \begin_inset Quotes erd
6158 \begin_inset Quotes eld
6162 \begin_inset Quotes erd
6166 \begin_inset Quotes eld
6170 \begin_inset Quotes erd
6174 \begin_inset Quotes eld
6178 \begin_inset Quotes erd
6182 \begin_inset Quotes eld
6186 \begin_inset Quotes erd
6190 \begin_inset Quotes eld
6194 \begin_inset Quotes erd
6198 \begin_inset Quotes eld
6202 \begin_inset Quotes erd
6206 \begin_inset Quotes eld
6210 \begin_inset Quotes erd
6214 \begin_inset Quotes eld
6218 \begin_inset Quotes erd
6222 \begin_inset Quotes eld
6226 \begin_inset Quotes erd
6230 \begin_inset Quotes eld
6234 \begin_inset Quotes erd
6238 \begin_inset Quotes eld
6242 \begin_inset Quotes erd
6246 \begin_inset Quotes eld
6250 \begin_inset Quotes erd
6254 \begin_inset Quotes eld
6258 \begin_inset Quotes erd
6262 Their use is more or less obvious.
6263 LyX supports all these environments; it will use the proper label, text
6264 style, and numbering scheme for each of them.
6267 \begin_layout Enumerate
6268 Both packages use basic citations; the natbib package should not be used.
6269 In LyX, citation references are shown as usual; in the output, citations
6270 are shown as superscripts.
6271 If you want to use a citation as normal text, you should use the
6275 command, e.\InsetSpace \thinspace{}
6277 \begin_inset Quotes eld
6280 See Ref.\InsetSpace ~
6288 \begin_inset Quotes erd
6294 \begin_layout Enumerate
6296 \begin_inset Quotes eld
6300 \begin_inset Quotes erd
6303 section in both packages.
6304 To put acknowledgments, just use the
6305 \begin_inset Quotes eld
6309 \begin_inset Quotes erd
6315 \begin_layout Enumerate
6316 Appendices may be added to the paper,
6320 the Acknowledgments and
6325 LyX provides a special environment, called
6326 \begin_inset Quotes eld
6330 \begin_inset Quotes erd
6333 which marks the beginning of the appendices.
6334 This environment should be left blank; it just sends a LaTeX command, but
6335 nothing is really printed.
6337 \begin_inset Quotes eld
6341 \begin_inset Quotes erd
6344 is printed with blue letters, as a signal that all sections after that
6345 point are appendices.
6346 To write an appendix, use the
6347 \begin_inset Quotes eld
6351 \begin_inset Quotes erd
6355 LyX will number each appendix with capital letters, as required by both
6358 \begin_inset Quotes eld
6362 \begin_inset Quotes erd
6369 be present before the first appendix; if not, all appendices will be numbered
6370 as normal sections in the output.
6373 \begin_layout Enumerate
6374 The ijmpc and the ijmpd packages use the
6378 command to implement table captions.
6379 As a result, a table created by LyX is printed correctly, but its caption
6381 However, you can use some ERT to overpass this problem, so that captions
6382 are printed as expected.
6383 To do so, create a float table as usual, remove the caption, and replace
6394 (sic); you must also the ERT
6398 immediately after the tabular material.
6399 Study the example table included in the template files to see how this
6400 trick is implemented.
6401 Alternatively, If you need table captions, you should implement the whole
6406 file, then include this file to the LyX document (
6411 nsert\SpecialChar \menuseparator
6416 \SpecialChar \menuseparator
6425 Details on how to create a table float can be found in the files
6433 , included in the corresponding packages.
6436 \begin_layout Subsection
6437 Preparing a paper for submission
6440 \begin_layout Standard
6441 Before you submit your paper you must export the LyX document as a LaTeX
6447 ile\SpecialChar \menuseparator
6452 xport\SpecialChar \menuseparator
6467 \begin_layout Standard
6468 Actually you have the choice between LaTeX (plain) and pdflatex.
6469 If you intend to use pdflatex to prepare the paper, you should use the
6470 pdflatex option so that included graphics are converted to PDF format,
6471 ready for use by pdflatex.
6476 , then make the following changes to the resulting
6483 \begin_layout Enumerate
6484 Remove the comment lines before the
6493 \begin_layout Enumerate
6494 Remove everything between (and including) the
6506 commands, except for any commands you specifically put into the LaTeX preamble.
6509 \begin_layout Standard
6514 file should be saved and processed through LaTeX as many times as necessary.
6515 You may also want to check the resulting
6522 \begin_layout Subsection
6526 \begin_layout Standard
6527 The use of ERT is reduced to two commands, which must be placed at the top
6529 If you started writing your paper by using the
6537 template, the ERT needed is already in its place; you usually don't need
6539 You may only modify the first ERT to specify the information printed to
6540 the top of odd and even pages (authors' names and short paper's title,
6542 This ERT must have the form
6546 markboth{Authors' Names}{Short Paper's Title}
6551 \begin_layout Section
6555 \begin_layout Standard
6561 \begin_layout Subsection
6565 \begin_layout Standard
6566 The iopart package provides a document class to create electronic manuscript
6567 submission to the journals published by the Institute of Physics.
6568 Instructions for the authors how to create a paper using the iopart class
6569 can be downloaded together with the iopart package from the site
6570 \begin_inset LatexCommand url
6571 target "ftp://ftp.iop.org/pub/journals/latex2e"
6578 \begin_layout Subsection
6582 \begin_layout Standard
6583 The easiest way to write a paper is to start with the file
6587 that is available in LyX's examples files folder.
6588 Open this file, save it under a new name, and start writing.
6589 The example file explains how to use the special text environments.
6590 Here are the most important advices:
6593 \begin_layout Itemize
6594 To be able to compile your document to a PDF, PS, or DVI, assure that the
6597 Use AMS math package
6599 in the document settings under
6606 \begin_layout Itemize
6609 The title environment defines the kind of your paper.
6610 So use one of the following environments for the title:
6614 \begin_layout Itemize
6623 \begin_layout Itemize
6632 \begin_layout Itemize
6638 for a Topical review
6641 \begin_layout Itemize
6650 \begin_layout Itemize
6659 \begin_layout Itemize
6665 for a Paper (same as Title)
6668 \begin_layout Itemize
6674 for a Preliminary communication
6677 \begin_layout Itemize
6683 for a Rapid communication
6686 \begin_layout Itemize
6692 for a Letter to the editor
6696 \begin_layout Itemize
6699 All title environments except of
6703 can have an optional short title.
6706 \begin_layout Itemize
6707 There is a general title environment
6711 which is not directly supported by the LyX.
6712 This can be used as ERT when your document doesn't fit into one of the
6716 \begin_layout Standard
6717 For more informations like hints for special table and formula formatting,
6718 look at the IOP author guidelines.
6721 \begin_layout Section
6725 \begin_layout Standard
6728 Panayotis Papasotiriou
6731 \begin_layout Subsection
6735 \begin_layout Standard
6736 The Kluwer package is a set of macros produced by Kluwer Academic Publishers
6737 that facilitates electronic manuscript submission to the journals they
6739 Most known of them (at least in my domain of interest) are
6741 Astrophysics and Space Science
6747 , but there are many others (see a complete list at
6748 \begin_inset LatexCommand url
6749 target "http://www.wkap.nl/jrnllist.htm/JRNLHOME"
6754 The Kluwer package may be downloaded from the site
6755 \begin_inset LatexCommand url
6756 target "http://www.wkap.nl/kaphtml.htm/STYLEFILES"
6761 A complete user guide is contained in that package (but it can also be
6762 downloaded separately).
6765 \begin_layout Standard
6766 LyX supports many features of the package but not everything.
6767 However, the ERT needed is reduced to some
6768 \begin_inset Quotes eld
6772 \begin_inset Quotes erd
6775 commands of the package (see\InsetSpace ~
6777 \begin_inset LatexCommand ref
6778 reference "subsec:kluwer_peculiarities"
6783 I have recently used LyX to write an article submitted to the
6785 Astrophysics and Space Science
6787 without any problem.
6790 \begin_layout Subsection
6794 \begin_layout Standard
6795 The easiest way to write a paper is to start with the Kluwer template file.
6798 File\SpecialChar \menuseparator
6813 This will give an (almost) empty document that includes the most common
6814 fields found in a manuscript and a short description of their use.
6815 As in most templates, simply overwrite the existing text (including the
6820 ) with the correct information.
6823 \begin_layout Subsection
6824 Preparing a paper for submission
6827 \begin_layout Standard
6828 As in the AASTeX package, before you submit your paper to a journal you
6830 \begin_inset Quotes eld
6834 \begin_inset Quotes erd
6840 \begin_layout Enumerate
6841 Export your paper as a LaTeX file.
6842 To do this, click on
6847 ile\SpecialChar \menuseparator
6852 xport\SpecialChar \menuseparator
6863 \begin_layout Enumerate
6868 file with a text editor and make the following changes
6872 \begin_layout Enumerate
6873 remove the comment lines before the
6882 \begin_layout Enumerate
6883 remove everything between (and including) the
6895 commands, except for any commands you specifically put into the LaTeX preamble.
6898 \begin_layout Standard
6907 \begin_layout Enumerate
6912 file through LaTeX as many times as necessary (usually up to three).
6915 \begin_layout Enumerate
6920 document using, e.\InsetSpace \thinspace{}
6925 , and check if everything is OK (it should, if you didn't make any mistake).
6928 \begin_layout Subsection
6929 \begin_inset Quotes eld
6933 \begin_inset Quotes erd
6936 of the Kluwer package
6937 \begin_inset LatexCommand label
6938 name "subsec:kluwer_peculiarities"
6945 \begin_layout Standard
6946 The Kluwer package has the following
6947 \begin_inset Quotes eld
6951 \begin_inset Quotes erd
6957 \begin_layout Enumerate
6958 It is possible to write multiple articles in the same LaTeX file
6962 \begin_layout Standard
6963 I can't imagine any good reason to do this.
6969 Each article must be included in the environment
6970 \begin_inset Quotes eld
6974 \begin_inset Quotes erd
6978 Unfortunately, this environment cannot be omitted, even if you write just
6980 Therefore, each article starts with the command
6986 and, obviously, ends with the command
6993 Although this can be implemented in LyX, I didn't included it, since it
6994 looks ugly and can confuse the novice user.
6995 Therefore, you need to enter them directly and mark them as LaTeX code
6997 \begin_inset Quotes eld
7001 \begin_inset Quotes erd
7007 \begin_layout Enumerate
7008 Information given at the beginning of the article (i.e., title, subtitle,
7009 author, institution, running title, running author, abstract and keywords)
7010 must be included in an environment called
7011 \begin_inset Quotes eld
7015 \begin_inset Quotes erd
7019 This is not implemented in LyX, so you must enter title, subtitle etc.\InsetSpace ~
7036 \begin_layout Enumerate
7037 According to the user manual, the label of each bibliography item must be
7061 \begin_layout Standard
7066 template takes care of all these
7067 \begin_inset Quotes eld
7071 \begin_inset Quotes erd
7075 If you start a new paper using this template you don't need to do anything
7080 \begin_layout Enumerate
7081 don't delete the ERT included in the template, and
7084 \begin_layout Enumerate
7085 copy the example bibliography item included in the template and modify it
7086 as necessary to enter new bibliography items.
7089 \begin_layout Section
7093 \begin_layout Standard
7099 \begin_layout Subsection
7103 \begin_layout Standard
7104 The LyX document classes
7106 article (koma-script)
7110 report (koma-script)
7128 correspond to the LaTeX document classes
7144 , resp.\InsetSpace ~
7145 of the Koma-Script family.
7146 They are replacements for the standard document classes
7162 , resp., and fit better to European typography conventions in a number of
7166 \begin_layout Itemize
7167 Standard character size is 11pt in
7169 article (koma-script)
7173 report (koma-script)
7181 letter (koma-script)
7186 \begin_layout Itemize
7187 Headings, labels of the description environment, and a number of elements
7190 letter (koma-script)
7192 document class are set in a bold sans serif font.
7196 \begin_layout Standard
7197 There is a big difference between the bold sans serif old cm fonts and new
7198 ec fonts, especially in the appearance of headings.
7199 In comparison, the ec bold sans serif fonts look a bit thin.
7200 Here the LaTeX package
7208 helps to produce the
7209 \begin_inset Quotes eld
7213 \begin_inset Quotes erd
7216 appearance when using the ec fonts.
7221 The numbering of chapter headings is made in the same way as the numbering
7222 of section headings, that is without the extra line
7223 \begin_inset Quotes eld
7226 Chapter\SpecialChar \ldots{}
7228 \begin_inset Quotes erd
7232 In addition, the appearance of the headings can be modified by using a
7233 number of options (in LyX to be entered in the field
7247 ayout\SpecialChar \menuseparator
7255 A detailed German description of these options can be found in the Koma-Script
7263 \begin_layout Itemize
7264 The main means in the Koma-Script document classes to design the type area
7273 (in LyX to be entered in the extra class options field in the dialog
7278 ocument\SpecialChar \menuseparator
7286 They make a clearer modification of page margins possible as do the options
7292 ocument\SpecialChar \menuseparator
7300 A detailed German description of these and other type area options can
7301 be found in the Koma-Script documentation
7308 \begin_layout Itemize
7309 The LaTeX document classes of the Koma-Script family define a number of
7310 additional commands.
7311 Those part of it which makes sense in LyX is implemented in corresponding
7315 \begin_layout Standard
7316 A detailed German description of the LaTeX document classes of the Koma-Script
7317 family can be found in the Koma-Script documentation
7325 \begin_layout Standard
7326 There is an English translation
7330 , but it is not a complete one.
7335 The following sections describe only those aspects, which are relevant
7339 \begin_layout Subsection
7340 article (koma-script), report (koma-script), and book (koma-script)
7343 \begin_layout Standard
7344 The document classes
7346 article (koma-script)
7350 report (koma-script)
7360 are implemented in the layout files
7373 They contain all the paragraph types of the corresponding standard document
7386 , resp., partly modified, with the exception of the LyX specific
7390 -type, which is replaced by the new
7394 -type having the same functionality.
7399 -Type there is a number of new paragraph types added.
7406 letter (koma-script)
7411 \begin_layout Itemize
7420 : are equivalents to
7428 , resp., additionally inserting an entry in the table of contents.
7437 are not contained in
7439 article (koma-script)
7444 \begin_layout Itemize
7461 , resp., additionally clearing running heads.
7468 article (koma-script)
7474 \begin_layout Standard
7487 report (koma-script)
7489 , but since this is identical to
7493 , is has not been implemented in LyX.
7501 \begin_layout Itemize
7506 : generates a heading directly above the following paragraph in the standard
7507 character size without affecting the structure of the document.
7510 \begin_layout Itemize
7519 are special captions which respect the different space settings needed
7520 for captions placed above or below an element (if you follow strict typographic
7521 rules, you might want to place table captions always above the table).
7522 You can also use the class option
7539 You need at least Koma-Script version 2.8q to use this.
7542 \begin_layout Itemize
7547 : can be used to set a bonmot, e.
7551 \begin_layout Standard
7564 \begin_layout Standard
7573 at the beginning of a chapter.
7574 If you use the optional argument (
7579 nsert\SpecialChar \menuseparator
7583 ), you can insert the dictum's author there.
7584 Dictum and author are separated by a line.
7585 You need at least Koma-Script version 2.8q to use this.
7592 article (koma-script)
7597 \begin_layout Standard
7598 The following types, together with the standard types
7610 , form the title area of the document.
7611 They must be entered ahead of the first
7612 \begin_inset Quotes eld
7616 \begin_inset Quotes erd
7623 \begin_layout Standard
7624 The corresponding LaTeX commands must appear before the
7635 When such a type is used more than once, the latter usage overwrites the
7636 former one, that means, for every type only the latest usage is valid.
7637 The order of the different types however has, like
7649 , no effect on the appearance of the produced document.
7652 \begin_layout Itemize
7657 : produces a centered paragraph above the ordinary title (
7669 ) for the subject of the document.
7672 \begin_layout Itemize
7677 : produces a centered paragraph below the ordinary title (
7689 ) for the publishers' name.
7692 \begin_layout Itemize
7699 report (koma-script)
7705 produces a centered paragraph on its own page behind the title page, or
7708 article (koma-script)
7710 produces a centered paragraph below the ordinary title (
7729 \begin_layout Itemize
7734 : produces a left aligned paragraph above the ordinary title (
7750 ) for a document`s head.
7753 \begin_layout Itemize
7758 : produces in a double-sided print in
7760 report (koma-script)
7766 a left-aligned paragraph at the top of the title page`s back or has no
7767 effect in a single-sided print or in
7769 article (koma-script)
7774 \begin_layout Itemize
7779 : produces in a double-sided print in
7781 report (koma-script)
7787 a left-aligned paragraph at the bottom of the title page`s back or has
7788 no effect in a single-sided print or in
7790 article (koma-script)
7795 \begin_layout Itemize
7800 : produces a special
7801 \begin_inset Quotes eld
7805 \begin_inset Quotes erd
7808 page ahead of the actual document containing a paragraph without special
7812 \begin_layout Standard
7813 The layout files for the document classes
7815 article (koma-script)
7819 report (koma-script)
7830 This is thought of as a place to define your own types.
7835 in your personal layout directory and edit the file!
7838 \begin_layout Subsection
7839 letter (koma-script)
7842 \begin_layout Standard
7846 \begin_layout Standard
7858 \begin_layout Standard
7862 letter (koma-script)
7864 is implemented in the layout file
7869 It contains all the paragraph types of the corresponding standard document
7874 , partly modified, with the exception of the LyX specific types
7886 type, which is replaced by the new
7891 In addition, it contains, in contrast to the standard document class, the
7909 Furthermore, there are a number of new letter specific types.
7912 \begin_layout Standard
7916 \begin_layout Standard
7928 \begin_layout Standard
7929 The appearance of the letter produced by this document class can be controlled
7930 by a number of LaTeX commands, which you can put in the LaTeX preamble.
7934 \begin_layout Standard
7935 For example, the standard appearance of the letter`s heading, consisting
7936 of name and address, is quite self-willed.
7938 \begin_inset Quotes eld
7942 \begin_inset Quotes erd
7945 heading is produced by the following LaTeX commands in the preamble:
7948 \begin_layout LyX-Code
7958 \begin_layout LyX-Code
7974 \begin_layout LyX-Code
7984 \begin_layout LyX-Code
8004 A detailed German description of such LaTeX commands can be found in the
8005 Koma-Script documentation
8010 With it, the letter's author can produce his personal letter layout.
8013 \begin_layout Standard
8022 define the beginning of the letter and must be used in every letter.
8023 To emphasize them in the LyX document class, they are marked with the letter
8032 , resp.\InsetSpace ~
8034 It is possible to write any number of letters in one file.
8039 type produces a new letter using the same addressee and a
8043 type produces a new addressee.
8060 are ordinary paragraph types and can also be used several times in one
8061 and the same letter.
8064 \begin_layout Itemize
8069 : produces a paragraph for the addressee and implicitly defines the beginning
8073 \begin_layout Itemize
8078 : produces a paragraph for the form of address and implicitly produces a
8082 \begin_layout Itemize
8087 : produces a paragraph for a close.
8090 \begin_layout Itemize
8095 : produces a paragraph for a postscript.
8098 \begin_layout Itemize
8103 : produces a paragraph for a distribution list.
8106 \begin_layout Itemize
8111 : produces a paragraph for enclosures.
8114 \begin_layout Standard
8155 are input types provided with a label to enter information, which will
8156 be processed by the document class.
8160 \begin_layout Standard
8161 It could be seen as a matter of inconsequence, that the types
8169 described above are not such input types as well.
8170 Because of the special meaning of those types, however, I have implemented
8171 them as ordinary paragraph types with a one letter mark in the left margin.
8172 Moreover, it would affect my feeling of symmetry, if the
8180 type had such a serious different appearance.
8185 The types must be used ahead of the corresponding
8192 \begin_layout Standard
8193 An implementation of these types in a WYSIWYG fashion does not seem to make
8194 sense, because the real appearance of the produced letter does not only
8195 depend on the usage of the particular type, but also on other factors.
8196 For example, a signature entered in the
8200 type will in the standard behavior appear in the produced letter only,
8201 when in the same letter also a
8206 The entered value of the
8210 type will in the standard behavior not appear in the produced letter at
8212 The possibility to design the letter`s heading freely is already indicated
8213 in a footnote above.
8216 \begin_layout Standard
8217 The input types can also be used as empty paragraphs.
8218 This makes sense e.\InsetSpace \thinspace{}
8229 type is not used at all, in the standard behavior the value of the
8233 type is used as signature, whereas if an empty
8237 type is used, no signature value is defined.
8240 \begin_layout Standard
8241 By using the input types it is possible to write a letter template, containing
8242 filled input types with your personal dates (name, address, etc.) and empty
8243 input types for other dates you want to enter.
8246 \begin_layout Itemize
8251 : sender's name, in the standard behavior appears as a centered paragraph
8252 in small caps in the letter`s heading.
8255 \begin_layout Itemize
8260 : sender's signature, in the standard behavior appears below the
8269 type is used, the value of the
8273 type appears instead.
8276 \begin_layout Itemize
8281 : sender's address, in the standard behavior appears in a centered paragraph
8282 in the letter`s heading below the sender's name.
8285 \begin_layout Itemize
8290 : sender's telephone number, in the standard behavior only sets the LaTeX
8300 \begin_layout Itemize
8305 : place of the letter`s making.
8308 \begin_layout Itemize
8313 : date of the letter`s making.
8322 , in the standard behavior, produce the place and the date in a right-aligned
8323 line below the addressee's field.
8328 type is used, neither place nor date appear, independent of the value of
8338 type is used, the date of the letter `s production is used.
8341 \begin_layout Itemize
8346 : sender`s back address, in the standard behavior appears above the addressee's
8347 field in a small sans serif font.
8350 \begin_layout Itemize
8355 : special mail information, in the standard behavior appears underlined
8356 above the addressee's field below the back address.
8359 \begin_layout Itemize
8364 : additional information, in the standard behavior appears on right side
8365 below the addressee`s field.
8368 \begin_layout Itemize
8373 : the letter's title, in the standard behavior appears in a big, bold, sans
8374 serif font above the subject.
8377 \begin_layout Itemize
8382 : the letter's subject, in the standard behavior appears in a bold font
8390 \begin_layout Standard
8411 produce a business letter like line above the
8415 line containing the fields
8416 \begin_inset Quotes eld
8420 \begin_inset Quotes erd
8424 \begin_inset Quotes eld
8428 \begin_inset Quotes erd
8432 \begin_inset Quotes eld
8436 \begin_inset Quotes erd
8440 \begin_inset Quotes eld
8444 \begin_inset Quotes erd
8448 \begin_inset Quotes eld
8452 \begin_inset Quotes erd
8456 \begin_inset Quotes eld
8460 \begin_inset Quotes erd
8464 For the date field, the value of the
8470 \begin_inset Quotes eld
8473 business letter types
8474 \begin_inset Quotes erd
8477 is used, the value of the
8481 type however does not appear, but only the LaTeX variable
8488 The ordinary output of place and date in a right-aligned line below the
8489 addressee`s field is suppressed.
8490 The types are implemented as input types provided with a label and must
8491 be used ahead of the corresponding
8498 \begin_layout Itemize
8506 \begin_layout Itemize
8514 \begin_layout Itemize
8522 \begin_layout Itemize
8530 \begin_layout Itemize
8538 \begin_layout Subsection
8539 The new letter class: letter (koma-script v.2)
8542 \begin_layout Standard
8545 Jürgen Spitzmüller
8548 \begin_layout Standard
8549 \begin_inset VSpace medskip
8555 \begin_layout Standard
8557 Koma-Script version 2.8 has introduced a new letter class
8561 which supersedes the now unsupported
8566 It has --- on the LaTeX side --- a completely new interface and is not
8567 compatible with the old class.
8568 Therefore, LyX supports both, though it is recommended to use the new class.
8571 \begin_layout Standard
8572 This class covers the same functionality as
8574 letter (koma-script),
8581 (receiver's address, same as
8598 will start a new letter (i.
8602 \begin_layout Standard
8615 \begin_layout Standard
8624 you can write several letters per document).
8625 New elements are sender's
8641 and the possibility to use a
8650 nsert\SpecialChar \menuseparator
8660 \begin_layout Standard
8661 The biggest improvement is, though, that the letter's layout is configurable
8662 at almost any needs.
8663 This can be done via the preamble or with a special style file (Letter
8664 Class Option, extension
8668 ), that will be read in as a class option.
8672 \begin_layout Standard
8673 The KOMA package comes with some default
8678 There is, for instance, a
8682 file that follows german typesetting rules, or a
8686 that provides the default layout of the old
8691 The latter can be loaded with the class option
8700 ayout\SpecialChar \menuseparator
8705 ocument\SpecialChar \menuseparator
8717 template that is included in LyX for examples.
8718 A detailed description is to be found in the Koma-Script documentation
8726 \begin_layout Subsection
8730 \begin_layout Standard
8731 Visualizing the Koma-Script document classes in LyX, the LyX internals cause
8735 \begin_layout Itemize
8736 The chapter number of a
8740 type appears on a line of its own above the chapter heading instead of
8741 appearing in the same line ahead of it.
8742 The cause for that is the LyX internal behavior for the labeltype
8749 \begin_layout Itemize
8750 The headings of the types
8759 \begin_inset Quotes eld
8763 \begin_inset Quotes erd
8766 LaTeX table of contents, but not in the LyX table of contents (
8771 ocument\SpecialChar \menuseparator
8783 \begin_layout Itemize
8788 document class appear in a skip separation mode, not indented.
8789 This is the standard behavior, no special LaTeX commands are needed for
8796 ocument\SpecialChar \menuseparator
8803 dialog the corresponding radio button indicates
8819 value always has the effect that extra LaTeX commands are inserted in the
8820 document to produce the gap, which is not what is wanted in this case.
8823 \begin_layout Section
8831 \begin_layout Standard
8837 \begin_layout Subsection
8841 \begin_layout Standard
8842 These are the layout files for some of the journal formats used by Springer
8843 Verlag and listed on
8844 \begin_inset LatexCommand url
8845 target "http://www.springer.de/author/tex/help-journals.html"
8849 , where you should also go to fetch the class files (yes, these are LaTeX2e
8851 It is a modular system: the things common to all journals are implemented
8856 , which journal-specific layout files (such as, e.\InsetSpace \thinspace{}
8861 for Journal of Geodesy) can include.
8864 \begin_layout Standard
8865 This means that implementing support for any other Springer journal on this
8866 list is as simple as writing your own
8874 file following the outline given in
8882 \begin_layout Standard
8883 It is reasonably well tested only for the Journal of Geodesy.
8892 come with the standard LyX distribution.
8893 Install the relevant class file (downloaded from Springer) in a proper
8894 directory, reconfigure LaTeX (in the teTeX case by running
8898 , as root if necessary --- doesn't LyX take care of this?), reconfigure
8899 LyX and it should work.
8902 \begin_layout Subsection
8906 \begin_layout Standard
8907 A large number of theorem-like styles ---
8913 \SpecialChar \ldots{}
8919 \begin_layout Standard
8922 Headnote, Dedication, Subtitle, Running_LaTeX_Title, Author_Running, Institute,
8923 Mail, Offprints, Keywords, Acknowledgements, Acknowledgement
8926 See the Springer class file documentation for details.
8929 \begin_layout Subsection
8933 \begin_layout Itemize
8945 \begin_layout Itemize
8948 Probability Theory and Related Fields
8954 --- Jean-Marc Lasgouttes
8957 \begin_layout Standard
8958 Add your own, it isn't so hard!
8961 \begin_layout Subsection
8965 \begin_layout Standard
8966 These files are partly based on the older
8970 , which was again based on a tinkered-with version of an old LaTeX 2.09 style
8976 layout, are now defunct.
8977 Jean-Marc Lasgouttes helped out big in making me find my way around the
8978 LyX layout file mechanism.
8981 \begin_layout Subsection
8985 \begin_layout Standard
8987 But probably less than in the old hacked-LaTeX
8994 \begin_layout Standard
8995 Limitations e.\InsetSpace \thinspace{}
8996 g.: does not display the number for theorem-like layouts, just
9000 \begin_layout Section
9008 \begin_layout Standard
9014 \begin_layout Subsection
9018 \begin_layout Standard
9019 These are the layout files for some of the journals of the American Geophysical
9021 It is assumed that you have both the AGU's own class files and AGUplus
9022 installed (everything to be found at
9023 \begin_inset LatexCommand url
9024 target "ftp://ftp.agu.org/journals/latex/journals"
9031 \begin_layout Subsection
9035 \begin_layout Standard
9045 They are still called this in the LyX GUI, though their LaTeX equivalents
9046 in the AGU classes are
9057 \begin_layout Standard
9058 Newly defined styles are
9095 These are mostly manuscript attributes and defined in the AGU class documentati
9099 \begin_layout Standard
9100 I suspect this is still badly incomplete.
9103 \begin_layout Subsection
9107 \begin_layout Standard
9124 \begin_layout Subsection
9128 \begin_layout Itemize
9131 Journal of Geophysical Research
9140 \begin_layout Standard
9141 Add your own, it isn't so hard! Look at the
9152 \begin_layout Subsection
9153 Bugs and things to remember
9156 \begin_layout Standard
9157 In order to use the new layouts, you must remember to do the following for
9161 \begin_layout Enumerate
9167 This can be done in the
9169 layout\SpecialChar \menuseparator
9174 document\SpecialChar \menuseparator
9178 (AGU articles are always in English, right? So
9185 \begin_layout Enumerate
9195 (Yes, this is a bug.)
9198 \begin_layout Enumerate
9199 Make sure you use the
9203 bibliography style, by entering
9207 into the second field of the BibTeX inset.
9208 None of the standard styles will do.
9211 \begin_layout Section
9219 \begin_layout Standard
9225 \begin_layout Subsection
9229 \begin_layout Standard
9230 This is the layout file for the European Geophysical Society journals.
9235 can be downloaded from the web site of the EGS under
9236 \begin_inset LatexCommand url
9237 target "www.copernicus.org"
9244 \begin_layout Subsection
9248 \begin_layout Standard
9251 Right_address, Latex_Title, Affil, Journal, msnumber, FirstAuthor, Received,
9259 The current layout file is unfortunately very unmodular and would benefit
9260 from using the various
9267 \begin_layout Section
9273 \begin_inset LatexCommand label
9281 \begin_layout Standard
9289 \begin_layout Subsection
9293 \begin_layout Standard
9294 This section describes how to use LyX to make slides for overhead projectors.
9295 There are two document classes that can do this: the default slides class
9301 This section documents the former.
9304 \begin_layout Standard
9305 I'm going to say this again, nice and clear, so that there's no misunderstanding
9309 \begin_layout Standard
9310 \begin_inset VSpace bigskip
9316 \begin_layout Standard
9320 This section documents the class
9321 \begin_inset Quotes eld
9329 \begin_inset Quotes erd
9337 \begin_layout Standard
9338 \begin_inset VSpace bigskip
9344 \begin_layout Standard
9345 If you're looking for the documentation for
9346 \begin_inset Quotes eld
9354 \begin_inset Quotes erd
9357 , check out section\InsetSpace ~
9359 \begin_inset LatexCommand ref
9360 reference "sec:foiltex"
9370 \begin_inset Quotes eld
9378 \begin_inset Quotes erd
9381 ] is actually somewhat better than the default
9389 \begin_layout Standard
9390 \SpecialChar \ldots{}
9391 or so I've been told repeatedly by its advocates.
9392 Having never used it, I have no idea if this claim is true or not.
9397 which this section documents.
9400 \begin_layout Standard
9401 This class is the LaTeX2e improvement of the old
9406 Every LaTeX2e distribution includes this class [which I'll just refer to
9408 \begin_inset Quotes eld
9416 \begin_inset Quotes erd
9419 from now on], so you're bound to have it.
9420 As I noted earlier, there are other classes, such as
9424 , which also produce slides for overhead projectors and do a better job
9426 However, there are some things which
9430 can do which the others can't, such as generate overlays.
9431 Read on to learn more!
9434 \begin_layout Subsection
9436 \begin_inset LatexCommand label
9437 name "sec:slidesetup"
9444 \begin_layout Standard
9445 Obviously, to use this document class, you need to select
9446 \begin_inset Quotes eld
9454 \begin_inset Quotes erd
9457 from the class list in the
9462 ocument\SpecialChar \menuseparator
9470 There are some other special things you should know about this class:
9473 \begin_layout Itemize
9474 Don't bother changing the options
9479 They're not supported by the
9486 \begin_layout Itemize
9495 behaves a bit differently for this class.
9496 The possible choices and what they do are as follows:
9500 \begin_layout Description
9505 The final output contains page numbers in the lower right corner.
9508 \begin_layout Description
9517 , but also prints out any time markers you've put in.
9518 This is the default.
9521 \begin_layout Description
9526 The final output contains no page numbers, time markers, or alignment markers.
9530 \begin_layout Itemize
9535 class has an extra option:
9541 \begin_inset Quotes eld
9549 \begin_inset Quotes erd
9552 in the extra class options.
9556 \begin_layout Standard
9557 Using this options allows you to add time markers to
9562 See section\InsetSpace ~
9564 \begin_inset LatexCommand ref
9565 reference "sec:slideNote"
9573 \begin_layout Standard
9574 You can also use the template file
9575 \begin_inset Quotes eld
9583 \begin_inset Quotes erd
9586 to automatically set up a document to use the
9595 ile\SpecialChar \menuseparator
9604 to open your new document].
9605 The template file also contains some examples of the special paragraph
9606 environments used by this class.
9607 I'll describe those next.
9610 \begin_layout Subsection
9611 Paragraph Environments
9614 \begin_layout Subsubsection
9615 Supported Environments
9618 \begin_layout Standard
9619 The first thing you'll notice when you start up a new
9623 document is the font size and type: it's the equivalent of the size
9624 \begin_inset Quotes eld
9632 \begin_inset Quotes erd
9641 This is also what's used in the output.
9643 \begin_inset Quotes eld
9647 \begin_inset Quotes erd
9650 to remind you that this is a slide.
9651 Your final slides will use a larger font; ergo, you'll have less space.
9652 Of course, the larger default screen font isn't WYSIWYG, only a reminder.
9655 \begin_layout Standard
9656 The next thing that becomes obvious is the changes to the paragraph environment
9657 pull-down box [at the far-left end of the toolbar].
9658 Most of the paragraph environments you're used to seeing are missing.
9659 There are also five new ones.
9664 class itself only supports certain paragraph environments:
9667 \begin_layout Itemize
9673 \begin_layout Itemize
9679 \begin_layout Itemize
9685 \begin_layout Itemize
9691 \begin_layout Itemize
9697 \begin_layout Itemize
9703 \begin_layout Itemize
9709 \begin_layout Itemize
9715 \begin_layout Itemize
9721 \begin_layout Itemize
9727 \begin_layout Itemize
9733 \begin_layout Standard
9734 All of the other standard environments, including the section-heading environmen
9735 ts, aren't used in the
9742 \begin_layout Standard
9743 On the other hand, you'll notice the following new environments:
9746 \begin_layout Itemize
9752 \begin_layout Itemize
9758 \begin_layout Itemize
9764 \begin_layout Itemize
9770 \begin_layout Itemize
9776 \begin_layout Standard
9777 These five are kind of quirky, due to a
9778 \begin_inset Quotes eld
9782 \begin_inset Quotes erd
9786 You see, LyX doesn't permit you to nest any other paragraph environment
9787 into an empty environment.
9788 Now, that's fine and dandy, but it means that you wouldn't be able to start
9789 a slide with anything except plain text.
9790 To deal with this, I've performed a little
9791 \begin_inset Quotes eld
9795 \begin_inset Quotes erd
9801 \begin_layout Subsubsection
9802 Quirks of the New Environments
9803 \begin_inset LatexCommand label
9804 name "sec:slideQuirk"
9811 \begin_layout Standard
9812 All five of the new paragraph environments are somewhat quirky due to inherent
9813 limitiations in the current version of LyX.
9814 As I just mentioned, LyX forbids environments that begin with another environme
9816 To get around this, the
9820 environment isn't a paragraph environment as described in the
9828 \begin_layout Standard
9842 \begin_inset Quotes eld
9845 pseudo-environments.
9846 \begin_inset Quotes erd
9849 They look like a section heading or a
9850 \begin_inset Quotes eld
9858 \begin_inset Quotes erd
9861 but really begin a [and, if necessary, end the previous] paragraph environment.
9871 \begin_inset Quotes eld
9875 \begin_inset Quotes erd
9878 These two perform some action.
9881 \begin_layout Standard
9882 A common feature of all five environments,
9902 , is a rather long-ish label.
9903 The text following this label --- ordinarily the contents of the paragraph
9904 environment --- is utterly irrelevant for
9925 LyX completely ignores it.
9926 In fact, you can leave these five environments completely empty.
9930 \begin_layout Standard
9935 to put any text after the rather long-ish label, you might want to.
9936 This could be a short description of the contents of the
9941 In that case, enter in your descriptive comment and hit
9945 as you normally would.
9948 \begin_layout Standard
9949 If, on the other hand, you don't want to enter in any descriptive text,
9950 you'll hit another LyX quirk.
9951 LyX, like nature, abhors a vacuum, and will not let you start a new paragraph
9952 environment until you put something in the old one.
9956 \begin_layout Itemize
9957 Start entering the text that will
9985 \begin_layout Itemize
9986 Now move to the beginning of that paragraph.
9990 \begin_layout Itemize
9999 \begin_layout Itemize
10000 Finally, change this new, empty paragraph to a
10024 \begin_layout Standard
10025 Some future version of LyX will, hopefully, resolve this quirkiness\SpecialChar \ldots{}
10029 \begin_layout Subsection
10030 Making a Presentation with
10043 \begin_layout Subsubsection
10051 \begin_layout Standard
10052 If you're expecting this section to teach you how to actually make a presentatio
10053 n, you'll be sorely disappointed.
10054 Naturally, I'll describe all of the ways the
10058 class can assist you in preparing the materials for a presentation.
10059 Filling in the contents, however, is up to you.
10064 the LyX philosophy.]
10067 \begin_layout Standard
10072 environment [in the manner described in section\InsetSpace ~
10074 \begin_inset LatexCommand ref
10075 reference "sec:slideQuirk"
10079 ] tells LyX to begin a new slide [duh].
10080 The label for this environment/
10081 \begin_inset Quotes erd
10085 \begin_inset Quotes erd
10089 \begin_inset Quotes eld
10093 \begin_inset Quotes erd
10096 in cool blue, followed by the label,
10097 \begin_inset Quotes eld
10101 \begin_inset Quotes erd
10105 Any text or paragraph environments that follow this one go on the new slide.
10109 \begin_layout Standard
10110 Slides are probably the only time you'll need to forcibly end pages in LyX
10111 (this can be specified in the
10116 In fact, you'll want to, once you finish entering the contents of one slide.
10117 If you've entered more text than can physically fit on a slide, the extra
10118 overflows onto a new slide.
10119 I don't recommend doing this, however, since the overflow slide won't have
10120 any page number on it.
10121 Furthermore, it may interfere with any
10125 you've made to accompany the oversized
10132 \begin_layout Standard
10141 environments work the same way as the
10146 They both create an
10147 \begin_inset Quotes eld
10151 \begin_inset Quotes erd
10154 followed by a label [
10155 \begin_inset Quotes eld
10159 \begin_inset Quotes erd
10163 \begin_inset Quotes eld
10167 \begin_inset Quotes erd
10171 The color is a stunning magenta instead of blue, and the
10172 \begin_inset Quotes eld
10176 \begin_inset Quotes erd
10179 will look different, in style and in length.
10180 The label fonts of all three also differ from one another.
10183 \begin_layout Standard
10188 , if the contents of a
10196 exceed the physical size of a slide or sheet of paper, the extra will overflow
10198 Again, you should avoid this.
10199 It defeats the whole purpose of
10210 \begin_layout Subsubsection
10220 \begin_layout Standard
10225 is a slide that sits atop another slide.
10226 Perhaps you wish to discuss a figure on the main
10230 before displaying the text associated with it.
10231 One way to accomplish this is tape a flap of dark paper over the part of
10236 you want to display later.
10237 This method fails, however, if you wish to overlap one graph with another,
10239 You would then have to fumble while speaking to align the two separate,
10244 s to align the two graphs.
10249 environment in both cases makes life much easier.
10252 \begin_layout Standard
10257 receives the page number of its
10258 \begin_inset Quotes eld
10262 \begin_inset Quotes erd
10270 \begin_inset Quotes eld
10278 \begin_inset Quotes erd
10285 \begin_layout Standard
10286 Presumably, mutliple
10291 \begin_inset Quotes eld
10299 \begin_inset Quotes erd
10303 \begin_inset Quotes eld
10311 \begin_inset Quotes erd
10315 \begin_inset Quotes eld
10323 \begin_inset Quotes erd
10326 , etc.\InsetSpace ~
10327 appended to the page number of the parent
10337 Clearly, you want the contents of both the
10345 to each fit on a single physical slide! You should probably consider an
10351 \begin_inset Quotes eld
10355 \begin_inset Quotes erd
10367 class provides a visual cue for this: the label at the start of an
10371 is shorter than that at the start of a
10376 Lastly, when you generate printable output, you'll find alignment markers
10377 in all four corners of both the
10381 page and its parent
10386 These will assist you in lining up the two physical slides.
10389 \begin_layout Standard
10390 The major problem in overlaying two slides is aligning the contents of the
10391 two transparencies.
10392 How much space should you leave for that graph on the second slide? Worse
10393 still, what if you want a graph and a sentence on second slide, but there
10394 is text on the main transparency that goes in between them? You could try
10395 and insert vertical space of the right size.
10396 The better way is to use
10407 \begin_layout Standard
10408 As their names imply,
10416 are two command-like paragraph environments that make all subsequent text
10417 invisible and visible, respectively.
10418 Note from section\InsetSpace ~
10420 \begin_inset LatexCommand ref
10421 reference "sec:slideQuirk"
10425 that you don't place anything
10429 these two environments, however.
10434 , it inserts a centered, sky-blue label into the page reading
10435 \begin_inset Quotes eld
10438 <Invisible Text Follows>
10439 \begin_inset Quotes erd
10443 For paragraphs following this label, the parts of the
10451 ; it doesn't matter which] where they would be contain instead blank space.
10455 \begin_layout Standard
10460 , the corresponding centered label is
10461 \begin_inset Quotes eld
10464 <Visible Text Follows>
10465 \begin_inset Quotes erd
10469 Paragraphs following this label behave normally.
10470 Note that the beginning of a new
10482 automatically shuts off an
10487 It's therefore not necessary to use
10498 \begin_layout Standard
10499 By now, it should be obvious how to create overlay transparencies using
10500 the proper combination of
10519 \begin_layout Enumerate
10524 , including everything that will appear on it, whether on the main slide
10532 \begin_layout Enumerate
10533 Before each figure or paragraph that will appear only on the
10542 If necessary, insert a
10546 environment after the
10553 \begin_layout Enumerate
10558 immediately following the
10565 \begin_layout Enumerate
10566 Copy the contents of this
10577 \begin_layout Enumerate
10582 , change all of the
10593 \begin_layout Standard
10595 You've just made an
10602 \begin_layout Standard
10603 There's one problem with the way I've designed the LyX
10607 class: you can't make text in the middle of a paragraph invisible, nor
10608 make text in the middle of an invisible paragraph visible again.
10609 To accomplish this feat, you'll need to use some inlined LaTeX codes.
10613 \begin_layout Standard
10614 The commands of interest are:
10617 \begin_layout Itemize
10622 invisible \SpecialChar \ldots{}
10626 \begin_layout Itemize
10631 visible \SpecialChar \ldots{}
10635 \begin_layout Standard
10636 \SpecialChar \ldots{}
10637 and need to be marked as TeX.
10639 \begin_inset Quotes eld
10643 \begin_inset Quotes erd
10646 you wish to change goes in between the brackets [and after the
10659 If you don't know how to mark text as TeX, see the appropriate section
10672 \begin_layout Subsubsection
10682 \begin_inset LatexCommand label
10683 name "sec:slideNote"
10690 \begin_layout Standard
10699 is associated with a
10700 \begin_inset Quotes eld
10704 \begin_inset Quotes erd
10716 class provides visual cues.
10721 is shorter than that of a
10725 [yet longer than that of an
10729 ] and, like the label of an
10733 is shockingly magenta.
10734 Additionally, the printed
10738 has the page number of its
10739 \begin_inset Quotes eld
10743 \begin_inset Quotes erd
10751 \begin_inset Quotes eld
10759 \begin_inset Quotes erd
10763 \begin_inset Quotes eld
10771 \begin_inset Quotes erd
10775 \begin_inset Quotes eld
10783 \begin_inset Quotes erd
10787 You can have multiple
10791 s associated with a single
10803 , you'll probably want to break up long
10807 s so that they fit on a single sheet of paper.
10810 \begin_layout Standard
10815 is obvious: it contains anything additional you might want to say about
10821 It could also be used as a sheet of reminders for a particular
10826 In the case of the latter, you might want to make use of time markers.
10832 \begin_inset Quotes eld
10836 \begin_inset Quotes erd
10839 support for time markers, a
10844 So, you'll have to resort to using the LaTeX codes.
10847 \begin_layout Standard
10848 To use time markers, you'll need to specify the extra class option
10849 \begin_inset Quotes eld
10857 \begin_inset Quotes erd
10860 [see section\InsetSpace ~
10862 \begin_inset LatexCommand ref
10863 reference "sec:slidesetup"
10868 This option turns on timing marks, which will appear in the lower-left-hand
10874 To set what appears in the time marker, you use the LaTeX commands
10875 \begin_inset Quotes eld
10885 \begin_inset Quotes erd
10889 \begin_inset Quotes eld
10899 \begin_inset Quotes erd
10903 The arguments of both commands are time measured in seconds.
10905 \begin_inset Quotes eld
10915 \begin_inset Quotes erd
10918 sets the time marker to a given time.
10920 \begin_inset Quotes eld
10930 \begin_inset Quotes erd
10933 increments the time marker by the specified amount.
10934 Using time markers and
10938 s in this fashion, you can remind yourself how much time to spend on a particula
10946 \begin_layout Standard
10947 There's one last feature to describe.
10948 Clearly, you'd like to print out all of your
10956 s on transparencies while printing all of your
10973 with which it is associated.
10974 What's a person to do?
10977 \begin_layout Standard
10978 Luckily, there are two LaTeX commands that allow you to select what to print
10980 Both must be placed into the preamble of your document.
10982 \begin_inset Quotes eld
10994 \begin_inset Quotes erd
10997 will cause the output to contain only the
11006 Correspondingly, the command
11007 \begin_inset Quotes eld
11019 \begin_inset Quotes erd
11022 prevents the output of anything but
11027 I'd advise placing both commands in the preamble and initially comment
11029 You can then preview your entire presentation as you write.
11030 When you're done writing, you can then uncomment one of the two to select
11031 what you want to print.
11032 I like to uncomment
11033 \begin_inset Quotes eld
11045 \begin_inset Quotes erd
11048 , print to a file with
11049 \begin_inset Quotes eld
11057 \begin_inset Quotes erd
11060 in its name, comment it back out, then uncomment
11061 \begin_inset Quotes eld
11073 \begin_inset Quotes erd
11077 \begin_inset Quotes eld
11085 \begin_inset Quotes erd
11089 I can then send either file to a printer, loading transparencies or plain
11090 paper as appropriate.
11093 \begin_layout Standard
11094 You can also provide other arguments to the
11095 \begin_inset Quotes eld
11105 \begin_inset Quotes erd
11109 \begin_inset Quotes eld
11119 \begin_inset Quotes erd
11123 See a good LaTeX book for details.
11126 \begin_layout Subsection
11131 Class Template File
11134 \begin_layout Standard
11135 I have also provided a template file,
11136 \begin_inset Quotes eld
11144 \begin_inset Quotes erd
11152 To use it, begin your new presentation with
11157 ile\SpecialChar \menuseparator
11167 Your new LyX presentation file will contain an example
11188 additionally contain an example of the use of
11197 Lastly, the preamble will contain:
11200 \begin_layout LyX-Code
11201 % Uncomment to print out only slides and overlays
11204 \begin_layout LyX-Code
11208 \begin_layout LyX-Code
11218 \begin_layout LyX-Code
11219 % Uncomment to print out only notes
11222 \begin_layout LyX-Code
11226 \begin_layout LyX-Code
11234 \begin_layout Standard
11235 One final thing: I created this class to support the LaTeX2e
11236 \begin_inset Quotes eld
11244 \begin_inset Quotes erd
11247 class, one of the built-in LaTeX2e classes.
11248 Neither I nor the rest of the LyX Team endorse or oppose the use of this
11249 built-in slide class.
11250 It's here if you want it or need it.
11251 There exist other LaTeX2e classes for creating presentations, such as the
11256 class [see section\InsetSpace ~
11258 \begin_inset LatexCommand ref
11259 reference "sec:foiltex"
11264 \begin_inset Quotes eld
11272 \begin_inset Quotes erd
11275 package [present on some TeX distributions].
11276 The latter is not yet supported under LyX.
11280 \begin_layout Standard
11281 Perhaps you can take on the task\SpecialChar \ldots{}
11287 I know nothing about these other classes.
11288 Try them out to see what sort of alternative they provide.
11291 \begin_layout Section
11300 \begin_inset LatexCommand label
11308 \begin_layout Standard
11314 \begin_layout Subsection
11318 \begin_layout Standard
11319 This section describes how to use LyX to make slides for overhead projectors.
11320 There are two document classes that can do this: the default slides class
11326 This section documents the latter.
11329 \begin_layout Standard
11330 I'm going to say this again, nice and clear, so that there's no misunderstanding
11334 \begin_layout Standard
11335 \begin_inset VSpace bigskip
11341 \begin_layout Standard
11345 This section documents the class
11346 \begin_inset Quotes eld
11354 \begin_inset Quotes erd
11362 \begin_layout Standard
11363 \begin_inset VSpace bigskip
11369 \begin_layout Standard
11370 If you're looking for the documentation for
11371 \begin_inset Quotes eld
11379 \begin_inset Quotes erd
11382 , check out section\InsetSpace ~
11384 \begin_inset LatexCommand ref
11385 reference "sec:slitex"
11390 If your machine doesn't have the
11395 \begin_inset Quotes eld
11403 \begin_inset Quotes erd
11406 ] installed, you'll probably have to use the default
11410 class, which isn't quite as good as
11415 \begin_layout Standard
11420 class is designed for use with version 2.1 of the
11424 LaTeX class file which is now an integral part of LaTeX2e.
11427 \begin_layout Subsection
11431 \begin_layout Standard
11432 Obviously, to use this document class, you need to select
11433 \begin_inset Quotes eld
11441 \begin_inset Quotes erd
11453 Document\InsetSpace ~
11457 There are some settings in the
11459 Document\InsetSpace ~
11462 dialog that you should know about that are specific to this class:
11465 \begin_layout Itemize
11466 Don't change the options
11476 Document\InsetSpace ~
11480 They're ignored by the
11487 \begin_layout Itemize
11488 The default font size is 20pt with the other options being 17pt, 25pt and
11492 \begin_layout Itemize
11493 The default font is
11501 but all math equations are still typeset in the usual roman font.
11504 \begin_layout Itemize
11509 TeX supports A4 and Letter paper sizes as well as a special size for working
11511 It doesn't support A5, B5, legal or executive paper sizes.
11514 \begin_layout Itemize
11515 Don't bother changing the
11519 settings because they are ignored anyway.
11520 All floats appear where they are defined in the text.
11523 \begin_layout Itemize
11531 setting behaves a bit differently for this class.
11536 TeX provides extensive footer and header capabilities including a user-defined
11538 See section\InsetSpace ~
11540 \begin_inset LatexCommand ref
11541 reference "sec:foilfoot"
11546 The title page is treated differently to all other pages in the document
11555 has the logo centered at the bottom of the page (if one is defined).
11556 The possible page style choices and what they do are as follows:
11561 \labelwidthstring MMMMMMM
11568 The final output contains no page numbers, or other headers or footers
11569 (except footnotes of course).
11574 \labelwidthstring MMMMMMM
11581 The final output contains page numbers centered at the bottom of the page.
11582 No other headings or footers (other than footnotes).
11586 \labelwidthstring MMMMMMM
11591 Page numbers in lower right corner.
11592 Additional headers and footers are also shown.
11593 This is also the default.
11597 \labelwidthstring MMMMMMM
11602 Gives you access to the
11606 package although its use with
11610 TeX is discouraged by the writer of the
11614 TeX package because of some potential page layout clashes.
11618 \begin_layout Subsubsection
11622 \begin_layout Standard
11623 The following options may be used in the extra class options in the
11628 ocument\SpecialChar \menuseparator
11639 \labelwidthstring MMMMMMx
11644 This sets up the page layout for 7.33in by 11in paper, which is about the
11645 same aspect ratio as a 35mm slide, making it a bit easier to work with
11650 \labelwidthstring MMMMMMx
11655 Places a rule across the page below the header on every page except the
11660 \labelwidthstring MMMMMMx
11665 Places a rule across the page above the footer on every page except the
11670 \labelwidthstring MMMMMMx
11675 This is automatically set each time you create a new
11684 TeX to use the dvips driver to rotate those pages that are set as landscape
11689 \labelwidthstring MMMMMMx
11694 Simply changes the page dimensions to those of a landscape page but doesn't
11696 Thus if you use this option you need to use an external program to rotate
11697 each page or feed your paper through your printer as landscape.
11698 Note that this option effectively reverses the roles of the
11706 environments (don't worry these are described in the next section).
11710 \labelwidthstring MMMMMMx
11715 Equation numbers on the left.
11719 \labelwidthstring MMMMMMx
11724 Flush-left equations.
11727 \begin_layout Subsection
11728 Supported Environments
11731 \begin_layout Standard
11732 Most of the environments commonly supported in other classes are also supported
11738 There are several additional environments provided by
11742 TeX as well as a couple added by LyX.
11743 The following environments are shared with other classes:
11746 \begin_layout Standard
11750 \begin_layout Standard
11754 begin{multicols}{2}
11762 \begin_layout Itemize
11768 \begin_layout Itemize
11774 \begin_layout Itemize
11780 \begin_layout Itemize
11786 \begin_layout Itemize
11792 \begin_layout Itemize
11798 \begin_layout Itemize
11804 \begin_layout Itemize
11810 \begin_layout Itemize
11816 \begin_layout Itemize
11822 \begin_layout Itemize
11828 \begin_layout Itemize
11834 \begin_layout Itemize
11840 \begin_layout Itemize
11846 \begin_layout Itemize
11852 \begin_layout Itemize
11858 \begin_layout Itemize
11864 \begin_layout Itemize
11870 \begin_layout Standard
11874 \begin_layout Standard
11886 \begin_layout Standard
11887 That is, all the major environments apart from the sectioning environments.
11888 Since foils are essentially self-contained sections, with a title and body,
11893 TeX provides specific commands for starting new foils and these are:
11896 \begin_layout Itemize
11902 \begin_layout Itemize
11908 \begin_layout Standard
11909 LyX also provides slightly modified versions of these two environments called:
11912 \begin_layout Itemize
11918 \begin_layout Itemize
11921 ShortRotatefoilhead
11924 \begin_layout Standard
11925 and the differences will be explained in the next section.
11928 \begin_layout Standard
11929 Since foils are often used in presenting ideas or new theorems and such
11934 TeX also provides a comprehensive box of goodies for presenting them:
11937 \begin_layout Standard
11941 \begin_layout Standard
11945 begin{multicols}{2}
11953 \begin_layout Itemize
11959 \begin_layout Itemize
11965 \begin_layout Itemize
11971 \begin_layout Itemize
11977 \begin_layout Itemize
11983 \begin_layout Itemize
11989 \begin_layout Itemize
11995 \begin_layout Itemize
12001 \begin_layout Itemize
12007 \begin_layout Itemize
12013 \begin_layout Itemize
12019 \begin_layout Standard
12023 \begin_layout Standard
12035 \begin_layout Standard
12036 The starred versions are unnumbered while the unstarred versions are numbered.
12037 There are also two list environments added by LyX and these are:
12040 \begin_layout Itemize
12046 \begin_layout Itemize
12052 \begin_layout Standard
12057 TeX provides some powerful header and footer capabilities that are best
12058 set in the preamble although they may be set at any point in a document.
12059 If you want to change these settings in your document the best place to
12060 do so is at the very top of a foil,
12065 straight after the foilhead.
12068 \begin_layout Standard
12069 For this purpose, the following command styles are provided [
12076 \begin_layout Standard
12080 \begin_layout Standard
12084 begin{multicols}{2}
12092 \begin_layout Itemize
12099 \begin_layout Itemize
12105 \begin_layout Itemize
12112 \begin_layout Itemize
12119 \begin_layout Itemize
12127 \begin_layout Standard
12133 \begin_layout Standard
12137 \begin_layout Standard
12149 \begin_layout Standard
12150 There are also a few commands provided by
12154 TeX that aren't directly supported by LyX but I'll tell you what they do
12155 and how to use them in section\InsetSpace ~
12157 \begin_inset LatexCommand ref
12158 reference "sec:unsuppfoils"
12165 \begin_layout Subsection
12166 Building a Set of Foils
12169 \begin_layout Standard
12170 This section will give a simple introduction to using the different environments
12171 to build a set of foils.
12172 If you want to see an example set of foils take a look at the
12176 file accessible from the
12181 ile\SpecialChar \menuseparator
12186 pen\SpecialChar \ldots{}
12197 \begin_layout Subsubsection
12198 Give It a Title Page
12201 \begin_layout Standard
12202 Unlike other classes that provide
12222 creates the title on a page of its own.
12223 If you leave out the
12227 environment LaTeX will substitute the current date (every time you regenerate
12231 \begin_layout Subsubsection
12235 \begin_layout Standard
12236 As I mentioned earlier, there are four ways of starting a new foil.
12237 For portrait foils you should use
12246 The difference between these two environments is the amount of space between
12247 the title of the foil (the foilhead) and the body of the foil.
12250 \begin_layout Standard
12251 Landscape foils are generated using the
12257 ShortRotatefoilhead
12260 Again the only difference is the spacing between foilhead and body.
12261 Both of the short versions have 0.5 inches less separation between the foilhead
12266 \begin_layout Standard
12267 One problem with the support for landscape foils is the requirement that
12268 you have to use the
12272 driver to generate the PostScript output otherwise the foils won't be rotated.
12273 It is possible to get landscape foils even if you haven't got the
12277 driver provided you can feed your foils sideways through your printer ;-)
12280 \begin_layout Subsubsection
12281 Theorems, Lemmas, Proofs and more
12284 \begin_layout Standard
12285 Due to a small bug in LyX you can't have two of the same type of these environme
12286 nts directly following each other.
12287 They must be separated by something.
12288 If you try, you will just be extending the previous environment as if you
12289 had merged the two environments together.
12290 So, how do you get around this problem? The simplest option is to insert
12291 some text between the two environments or add a
12295 environment between the two with just a
12296 \begin_inset Quotes eld
12304 \begin_inset Quotes erd
12308 This will force LyX to produce two separate environments and hence the
12309 correct LaTeX output.
12310 An example is provided in the example file included with the LyX distribution.
12311 Remember, this problem only occurs if you are trying to place two of the
12312 same type of theorem-like environments one directly after the other.
12315 \begin_layout Subsubsection
12319 \begin_layout Standard
12320 You get all the commonly supported list styles found in other classes as
12321 well as two new ones.
12322 I'll only describe the new ones here.
12323 If you want to find out more about the other list environments check out
12329 If you intend to use itemized lists you might also want to read about the
12332 Itemize\InsetSpace ~
12333 Bullet\InsetSpace ~
12336 dialog described above in section\InsetSpace ~
12338 \begin_inset LatexCommand ref
12339 reference "sec:bullet"
12346 \begin_layout Standard
12347 The two new list styles,
12355 , are designed to make it easier for you to create lists of do's and don'ts
12356 or right and wrong by providing dedicated environments that use a tick
12357 or a cross as the label of the list.
12358 These lists are in fact dedicated variants of the
12363 They do however require that you have the
12367 packages installed.
12370 \begin_layout Subsubsection
12374 \begin_layout Standard
12379 TeX redefines the floating tables and figures so that they appear exactly
12380 where they are in the text rather than pushing them to the top of the page
12381 or to some user specified location.
12382 In fact if you change the float placement settings they are simply ignored.
12385 \begin_layout Subsubsection
12386 Page Headers and Footers
12387 \begin_inset LatexCommand label
12388 name "sec:foilfoot"
12395 \begin_layout Standard
12405 are two commands used to control the left-footer text string.
12406 The first is meant to allow you to include a graphic logo on your foils
12408 \begin_inset Quotes eld
12416 \begin_inset Quotes erd
12420 While the second is meant to provide a classification for the audience,
12423 e.\InsetSpace \thinspace{}
12428 It is empty by default.
12431 \begin_layout Standard
12432 The remaining page corners can be filled by
12437 (which defaults to page numbers),
12450 \begin_layout Subsection
12456 \begin_inset LatexCommand label
12457 name "sec:unsuppfoils"
12464 \begin_layout Standard
12465 All the commands mentioned below need to be set in a
12473 within another environment.
12476 \begin_layout Subsubsection
12480 \begin_layout Standard
12481 All lengths are adjusted using the
12504 should be replaced by the name given to the length you want to change and
12509 is the length value.
12510 All lengths should be specified in units of length such as inches (
12522 ) or relative to some document or font-based length such as
12532 \begin_layout Standard
12533 It's possible to change the spacing between a foilhead and the body of the
12534 foil by adjusting the length specified by
12541 For example, to make
12545 foilheads 0.5 inches closer to their bodies put the following in the preamble:
12552 foilheadskip}{-0.5in}
12555 \begin_layout Standard
12556 The spacings around floats can be adjusted by setting these lengths:
12560 \labelwidthstring MMMMMMMMMMM
12567 Separation between the text and the top of the float
12571 \labelwidthstring MMMMMMMMMMM
12578 Separation between the float and the caption
12582 \labelwidthstring MMMMMMMMMMM
12589 Separation between the caption and the following text
12593 \labelwidthstring MMMMMMMMMMM
12600 You can make the captions narrower than the surrounding text by adjusting
12602 Best done relative to
12611 \begin_layout Standard
12612 There are also several title page related lengths that you may find useful
12613 if you have a long title or several authors:
12617 \labelwidthstring MMMMMMMMMMM
12624 Separation from headers to
12630 \labelwidthstring MMMMMMMMMMM
12649 \labelwidthstring MMMMMMMMMMM
12664 \labelwidthstring MMMMMMMMMMM
12681 \labelwidthstring MMMMMMMMMMM
12697 \begin_layout Standard
12698 The last length related command affects all the list environments.
12709 a list environment then all the vertical spacing between the list items
12711 Note that this is a command not a length so it doesn't require
12717 like the stuff mentioned above.
12720 \begin_layout Subsubsection
12721 Headers and Footers
12724 \begin_layout Standard
12737 commands control whether the logo in the
12741 definition appear on a given page.
12748 in the preamble then none of the foils will have the logo on them.
12749 If you don't want the logo on a particular page place the
12755 directly after the foilhead of that page and the
12761 directly after the next foilhead.
12764 \begin_layout Standard
12765 If you decide to use the
12769 page style setting in the
12771 Document\InsetSpace ~
12774 dialog you should probably add
12784 to your preamble so headers and footers on landscape pages are correctly
12785 placed when rotated.
12786 This is due to some clashes between the page layouts provided by the
12797 \begin_layout Section
12798 Latex8 (IEEE Conference Papers)
12801 \begin_layout Standard
12807 \begin_layout Subsection
12811 \begin_layout Standard
12812 Since this class is specifically for writing submissions to IEEE sponsored
12813 conferences I strongly recommend that you get a copy of their Authors Kit.
12818 package and associated bibliography style file is included in the kit.
12819 The Authors Kit is usually sent out by email once your initial submission
12821 There is a lot of useful information in the Authors Kit explaining formatting
12822 restrictions and so on and I will assume you have read this since that
12823 means I don't have to repeat it all here.
12826 \begin_layout Subsection
12830 \begin_layout Standard
12831 [AR\SpecialChar \@.
12835 \begin_layout Subsection
12836 Supported Environments
12839 \begin_layout Itemize
12845 \begin_layout Itemize
12851 \begin_layout Itemize
12857 \begin_layout Itemize
12863 \begin_layout Itemize
12869 \begin_layout Itemize
12875 \begin_layout Itemize
12881 \begin_layout Itemize
12887 \begin_layout Itemize
12893 \begin_layout Subsection
12894 Differences Between Screen and Paper
12897 \begin_layout Standard
12898 There are slight differences in appearance mainly with the presentation
12899 of section counters.
12900 On screen the trailing period of the section counter is missing but it
12901 will appear in the output so don't let this worry you.
12904 \begin_layout Section
12905 Hollywood (Hollywood spec scripts)
12908 \begin_layout Standard
12914 \begin_layout Subsection
12918 \begin_layout Standard
12919 Getting the format of a Hollywood script right is a
12920 \begin_inset Quotes eld
12924 \begin_inset Quotes erd
12927 It is designed to make the readers focus on content and to be easy and
12928 familiar for the actors to read.
12929 Each page of a script should be one minute of film.
12930 Nothing goes in a script that you cannot see or hear on screen.
12931 The courier 12 pt font should be used throughout.
12935 \begin_layout Subsection
12939 \begin_layout Standard
12940 Speakers' lines should NEVER break in mid-sentence.
12941 If a speaker's lines continue over a page break, repeat the
12945 title followed by (Cont'd).
12948 \begin_layout Subsection
12952 \begin_layout Standard
12957 names as labels then cross-reference the label to insert the name.
12958 The cross-reference dialog will show the current cast of characters.
12959 You can use this to insert the speaker name in narratives also.
12962 \begin_layout Subsection
12963 Paper size and Margins
12966 \begin_layout Standard
12967 USLetter, left 1.6in, right 0.75in, top 0.5in, bottom 0.75in
12970 \begin_layout Subsection
12974 \begin_layout Standard
12975 The following environments are available.
12976 You can use hollywood.bind to get the bind keys shown at the right.
12979 \begin_layout Itemize
12986 Used where nothing else works.
12990 \begin_layout Itemize
13003 Usually followed by something like
13004 \begin_inset Quotes eld
13007 on Sally waking up.
13008 \begin_inset Quotes erd
13014 \begin_layout Itemize
13023 Introduces a new INTERIOR camera set-up.
13024 Always followed by DAY or NIGHT, or something similar to define the lighting
13026 Everthing on this line in CAPS.
13029 \begin_layout Itemize
13038 Introduces a new EXTERIOR camera set-up.
13039 Everthing on this line in CAPS.
13042 \begin_layout Itemize
13051 The character speaking.
13054 \begin_layout Itemize
13063 Instructions to the speaker.
13064 The () are automatically inserted, but only the ( will show in LyX.
13065 Both will be printed.
13068 \begin_layout Itemize
13084 \begin_layout Itemize
13093 Camera movement instruction.
13094 e.\InsetSpace \thinspace{}
13099 \begin_layout Itemize
13107 \begin_layout Itemize
13115 \begin_layout Itemize
13123 \begin_layout Itemize
13131 \begin_layout Subsection
13135 \begin_layout Itemize
13136 (O.S) --- off screen
13139 \begin_layout Itemize
13140 (V.0) --- voice over
13143 \begin_layout Itemize
13148 \begin_layout Itemize
13153 \begin_layout Itemize
13154 PAN --- camera movement
13157 \begin_layout Itemize
13158 INSERT --- cut to close-up of
13161 \begin_layout Section
13165 \begin_layout Standard
13171 \begin_layout Subsection
13175 \begin_layout Standard
13176 Broadway is for writing plays.
13177 The format is more decorative than Hollywood, and much less standardized.
13178 This format should be suitable for workshops.
13181 \begin_layout Subsection
13185 \begin_layout Standard
13186 The same as in Hollywood.
13189 \begin_layout Subsection
13193 \begin_layout Standard
13198 names as labels then cross-reference the label to insert the name.
13199 The cross-reference dialog will show the current cast of characters.
13202 \begin_layout Subsection
13203 Paper size and Margins
13206 \begin_layout Standard
13207 USLetter, left 1.6in, right 0.75in, top 0.5in, bottom 0.75in
13210 \begin_layout Subsection
13214 \begin_layout Standard
13215 The following environments are available.
13216 You can use broadway.bind to get the bind keys shown at the right.
13219 \begin_layout Itemize
13226 You should not have to use this, but it is here for anything that does not
13230 \begin_layout Itemize
13239 Used to describe stage setting and the action.
13240 First use of speaker names in all CAPs.
13243 \begin_layout Itemize
13252 Automatically numbered.
13253 On screen it will be arabic, but will print as Roman.
13256 \begin_layout Itemize
13270 It is just centered text.
13273 \begin_layout Itemize
13282 Not automatically numbered.
13283 You supply the number.
13284 This is because I couldn't figure out how.
13287 \begin_layout Itemize
13296 A special case of Narrative to describe the setting and action as the curtain
13300 \begin_layout Itemize
13309 The speaker's (actor's) title, centered in all CAPS.
13312 \begin_layout Itemize
13321 Instructions to the speaker.
13322 The parentheses are automatically inserted.
13323 The ( will appear on screen, but both will be in the printed play.
13324 This environment is only used within
13331 \begin_layout Itemize
13340 What the Speaker says.
13343 \begin_layout Itemize
13352 The curtain comes down.
13355 \begin_layout Itemize
13363 \begin_layout Itemize
13371 \begin_layout Itemize
13379 \begin_layout Standard
13383 \begin_layout Section
13387 \begin_layout Standard
13393 \begin_layout Standard
13394 \begin_inset VSpace bigskip
13400 \begin_layout Standard
13404 Revtex\InsetSpace ~
13407 textclass works with the American Physical Sociey's RevTeX 4.0 (the
13408 \begin_inset Formula $\beta$
13411 release of May, 1999) class.
13414 \begin_layout Standard
13419 textclass, which works with RevTeX 3.1.
13420 However, v3.1 is basically obsolete, as it works with LaTeX 2.09.
13421 That means that it doesn't interact very well with LyX, which requires
13422 LaTeX2e, although it has been kludged to work.
13423 Since RevTeX 4.0 has been designed to work much more cleanly with LaTeX2e,
13426 RevTeX\InsetSpace ~
13429 textclass should also be pretty easy to use.
13432 \begin_layout Standard
13433 These documents are supposed to be used in
13437 to the RevTeX 4.0 documents, so we don't describe any of the special RevTeX
13438 macros, and assume you'll know what to put in the preamble if necessary.
13441 \begin_layout Subsection
13445 \begin_layout Standard
13446 All you need to do is install RevTeX 4, as described in the package's README
13448 The package can be found at
13449 \begin_inset LatexCommand url
13450 name "The RevTeX 4 Web Site"
13451 target "http://publish.aps.org/revtex4/"
13456 Install it somewhere that LaTeX can see it.
13457 Test it by trying to LaTeX a short RevTeX 4 document in some random directory
13458 (i.e., not the directory where you installed the class file.) Then, if you
13459 reconfigure LyX, it will find the class file and let you use the RevTeX4
13463 \begin_layout Standard
13464 Probably the easiest way to get started is either to import a RevTeX 4 document
13471 Revtex\InsetSpace ~
13474 template, found in the templates directory.
13477 \begin_layout Subsection
13481 \begin_layout Standard
13482 Optional arguments to
13489 \begin_inset Quotes eld
13493 \begin_inset Quotes erd
13497 \begin_inset Quotes eld
13501 \begin_inset Quotes erd
13515 Document\InsetSpace ~
13519 Remember that in RevTeX, at least one optional argument is required!
13522 \begin_layout Standard
13523 Other preamble matter, like
13539 dialog, also as usual.
13542 \begin_layout Subsection
13546 \begin_layout Standard
13547 The layouts basically correspond to the commands in RevTeX4.0.
13548 For example, the Email layout corresponds to
13555 Note that (at least as of RevTeX 4.0 Beta), the
13563 layouts are exactly equivalent, so you shouldn't need to use both.
13567 \begin_layout Standard
13568 In case you're curious, both were included so that
13572 would be able to translate both
13592 \begin_layout Subsection
13596 \begin_layout Standard
13597 There are a couple of important unique aspects of RevTeX 4 which might cause
13598 bugs that will be even more confusing in LyX.
13601 \begin_layout Standard
13619 The LyX equivalent is that there is a separate Thanks layout.
13624 write footnotes in the
13628 layout, or weird things may happen.
13629 See the RevTeX 4 documentation for more details.
13632 \begin_layout Standard
13635 Author\InsetSpace ~
13640 Author\InsetSpace ~
13647 layouts must be placed
13655 layout and the corresponding
13672 , the LaTeX won't compile.
13675 \begin_layout Subsection
13679 \begin_layout Standard
13680 The main problem with this layout is that you can't use the optional arguments
13681 to layouts like Email and Title.
13682 (The problem is not unique to this layout; you can't use optional arguments
13683 to the Section layouts either.) This means that after you export that file
13684 to LaTeX (which you'll need to do eventually to send it in to APS), you'll
13685 need to edit the LaTeX file with a text editor to add the optional arguments
13686 to set, e.\InsetSpace \thinspace{}
13687 g., the running title for the page headers.
13688 Lacking these layouts makes the
13694 (and the equivalent
13700 ) useless, so the corresponding layouts don't exist, and will have to be
13705 \begin_layout Standard
13710 actually, LyX 1.3.0 supports some forms of optional arguments, but this layout
13711 has not been updated yet to take advantage of it.
13719 \begin_layout Section
13720 Article (mwart), book (mwbk) and report (mwrep)
13721 \begin_inset OptArg
13724 \begin_layout Standard
13737 \begin_layout Standard
13743 \begin_layout Standard
13744 The LyX document classes
13760 correspond to the LaTeX document classes
13773 They are replacements for the standard document classes
13785 , resp., and fit better to Polish typography conventions in a number of points.
13789 \begin_layout Standard
13793 \begin_layout Itemize
13794 Unnumbered titles (with star, eg.
13799 ) are added into table of contents,
13802 \begin_layout Itemize
13803 Additional page styles:
13807 \begin_layout Description
13808 uheadings header with separated lines,
13811 \begin_layout Description
13812 myheadings custom header, contents headers via commands:
13827 \begin_layout Description
13828 myuheadings custom header with separated lines,
13831 \begin_layout Description
13832 outer page number is placed on outer side of page
13836 \begin_layout Itemize
13841 \begin_layout Description
13842 rmheadings serif titles --- default,
13845 \begin_layout Description
13846 sfheadings sansserif titles,
13849 \begin_layout Description
13850 authortitle on title page first placed is author next title --- default,
13853 \begin_layout Description
13854 titleauthor on title page first placed is title next author,
13857 \begin_layout Description
13858 withmarginpar reserve place on page for margins.
13862 \begin_layout Section
13866 \begin_layout Standard
13872 \begin_layout Standard
13873 Elsevier Science Publishers B.V.
13874 provides a standard LaTeX document class (
13878 ) for submitting articles to their various journals.
13879 The style file can be downloaded directly from their web site:
13880 \begin_inset LatexCommand url
13881 target "http://authors.elsevier.com/"
13886 Instructions are supplied along with the class file, which details the
13887 requirements of the publishers.
13888 LyX includes package that allows for the use of this class, by a layout
13889 and a template file.
13890 Installation of the class file is the same as for any other LaTeX package;
13891 instructions are provided in the Elsevier documentation.
13894 \begin_layout Standard
13904 As the Elsevier class file is based mainly on the standard article class,
13905 most of the normal functionality is provided.
13906 The Elsevier class defines a number of mathematical environments, which
13907 are similar to the AMS environments.
13908 These commands are all described in the Elsevier documentation, and are
13912 \begin_layout Standard
13913 The easiest way to use the Elsevier style is to base documents on the included
13915 It is best not to use options such as fancy headings or the geometry package,
13916 as elements such as these are defined by Elsevier in their style file.
13917 Ideally, no extra packages except those mentioned in the Elsevier documentation
13919 Essentially, Elsevier require as
13920 \begin_inset Quotes eld
13924 \begin_inset Quotes erd
13931 \begin_layout Standard
13940 file as possible, as their intention is to take the supplied file and replace
13941 the class file with one for the particular journal to which the paper has
13943 This also means that not too much time should be spent on the formating
13945 When it comes to be published, this will change anyway.
13946 The rest of the usage for this layout is substantially the same as for
13947 the normal article class.
13948 For details of what Elsevier do and don't allow, refer to their documentation.
13951 \begin_layout Section
13955 \begin_layout Standard
13958 Jürgen Spitzmüller
13961 \begin_layout Subsection
13965 \begin_layout Standard
13966 Memoir is a very powerful and constantly evolving class.
13967 It has been designed with regard to fictional and non-fictional literature.
13968 Its aim is to let the user have maximum control over the typesetting of
13970 Memoir is based on the standard book class, but it can also emulate the
13971 article class (see below).
13974 \begin_layout Standard
13975 Peter Wilson, the developer of Memoir, is known as the author of lots of
13976 useful packages in the LaTeX world.
13977 Most of them have been merged with Memoir.
13978 Therefore, it is much easier to layout the table of contents, appendices,
13979 chapter designs and such.
13980 LyX, though, does not support all of these goodies natively.
13981 Some of them might be added to forthcoming releases
13985 \begin_layout Standard
13986 You are invited to send suggestions to
13987 \begin_inset LatexCommand url
13988 target "lyx-devel@lists.lyx.org"
13997 , lots will probably never, due to the limitations of LyX's framework.
13998 Of course you can still use all features with the help of some native LaTeX
14003 \begin_layout Standard
14008 \begin_layout Standard
14017 section\InsetSpace ~
14019 \begin_inset LatexCommand ref
14020 reference "sec:Inserting-LaTeX-Code"
14030 In this section, we can only list those features which are natively supported
14032 For detailed descriptions (and for the rest of features) we are recommending
14033 to have a look at the detailed manual of the Memoir class
14037 \begin_layout Standard
14042 \begin_layout Standard
14052 \begin_inset LatexCommand url
14053 target "CTAN:/macros/latex/memoir/memman.pdf"
14062 , which is not only a user guide for the class, but also both a comprehensive
14063 description on good typesetting and a superb example for good typesetting
14067 \begin_layout Subsection
14068 Basic features and restrictions
14071 \begin_layout Standard
14072 Memoir supports basically all features of the standard book classes.
14073 There are, however, some differences, as follows:
14076 \begin_layout Description
14078 sizes: Memoir has a broader range of font sizes: 9, 10, 11, 12, 14,
14082 \begin_layout Description
14084 style: The fancy page style is not supported, due to a command clash
14085 between Memoir and the fancyhdr package (they are both defining a command
14086 with the same name, which confuses LaTeX).
14087 Instead, Memoir comes with a bunch of own page styles (see
14089 Layout\SpecialChar \menuseparator
14090 Document\SpecialChar \menuseparator
14095 If you want to use these for the chapter pages, you have to use the command
14102 in the main text or in preamble (e.
14106 \begin_layout Standard
14119 \begin_layout Standard
14132 chapterstyle{companion}
14137 \begin_layout Description
14138 Sectioning: Sectionings (chapter, section, subsection etc.) are coming with
14139 an optional argument in the standard classes.
14140 With this, you can specify an alternative version of the title for the
14141 table of contents and the headers (for instance, if the title is too long).
14142 In LyX, you can do this via
14144 Insert\SpecialChar \menuseparator
14148 at the beginning of a chapter/section.
14149 Memoir features a second optional argument and thus separates the table
14150 of contents from the header.
14151 You can define three variants of a title with this: one for the main text,
14152 one for the table of contents, and one for the headers.
14153 Simply insert two optional arguments if you need this feature, the first
14154 one containing the short title for the Table of Contents, the second one
14155 containing an alternative short title for the headers.
14158 \begin_layout Description
14159 TOC/LOT/LOF: In the standard classes (and in many other classes), the table
14160 of contents, the list of figures and the list of table start a new page
14162 Memoir does not follow this route.
14163 You have to insert a page break yourself, if you want to have one.
14166 \begin_layout Description
14167 Titlepage: For some unknown reason, Memoir uses pagination on the title
14168 page (in the standard classes, title pages are
14169 \begin_inset Quotes eld
14173 \begin_inset Quotes erd
14180 \begin_layout Standard
14193 \begin_layout Standard
14203 If you want an empty title page, type
14207 aliaspagestyle{title}{empty}
14212 \begin_layout Description
14213 Article: With the class option
14219 Layout\SpecialChar \menuseparator
14220 Document\SpecialChar \menuseparator
14224 ), you can emulate article style.
14225 That is, counters (footnotes, figures, tables etc.) will not be reset on
14226 new chapters, chapters don't start a new page (but are---in contrary to
14228 \begin_inset Quotes eld
14232 \begin_inset Quotes erd
14235 article classes---still allowed), parts, though, use their own page, as
14239 \begin_layout Description
14240 Oldfontcommands: By default, Memoir does not allow the use of the deprecated
14241 font commands, which have been used in the old LaTeX version 2.09 (e.
14245 \begin_layout Standard
14258 \begin_layout Standard
14280 It produces an error and stops LaTeX whenever such a command appears.
14285 reallows the commands and spits out warnings instead (which does at least
14287 Since a lot of packages and particularly BibTeX style files are still using
14288 those commands, we have decided to use this option by default.
14291 \begin_layout Subsection
14295 \begin_layout Standard
14296 We will only describe the features supported by LyX (which is not much currently
14298 Please consult the Memoir manual
14302 \begin_layout Standard
14307 \begin_layout Standard
14317 \begin_inset LatexCommand url
14318 target "CTAN:/macros/latex/memoir/memman.pdf"
14330 \begin_layout Description
14331 Abstract: You may wonder why an abstract is an extra feature.
14332 Well, it is in book class.
14333 Usually books don't have abstracts.
14334 Memoir, however, has.
14335 You can use it wherever and how often you like.
14338 \begin_layout Description
14339 Chapterprecis: You may know this from belletristic: The contents of a chapter
14340 is shortly described below the title and also in the table of contents
14345 \begin_layout Standard
14358 \begin_layout Standard
14369 Our hero arrives in Troia; he loses some friends; he finds others
14372 Chapterprecis does exactly this.
14373 It is therefore only sensible below a chapter.
14376 \begin_layout Description
14377 Epigraph: An epigraph is a smart slogan or motto at the beginning of a chapter.
14378 The epigraph environment provides an elegant way of typesetting such a
14380 The motto itself (text) and its author (source) are divided by a short
14382 Unfortunately, we have to fool LyX a bit here again, since the environment
14383 needs two arguments (text and source).
14384 In this case, we have to use curly brackets (in TeX mode) between the two
14395 <author of the slogan>.
14398 \begin_layout Description
14399 Poemtitle: Memoir has lots of possibilities to typeset poetry (up to very
14400 complex figurative poems).
14401 LyX can only support a few of them.
14402 One is poemtitle, which is a centered title for poems, which will also
14403 be added to the table of contents (verse is the standard environment for
14405 Memoir has some enhanced versions of verse, but you need to use ERT, because
14406 they have to be nested inside regular verse environments, which is not
14407 possible with LyX).
14410 \begin_layout Description
14411 Poemtitle*: Same as poemtitle, but it adds no entry to the table of contents.
14414 \begin_layout Chapter
14415 Importing and Exporting Alternate File Formats
14416 \begin_inset OptArg
14419 \begin_layout Standard
14420 Importing and Exporting
14428 \begin_layout Section
14432 \begin_layout Standard
14433 Importing and exporting LyX documents from/to other formats has been touched
14439 Here we describe more of the gory details needed to understand just what
14440 is going on when you click on the
14445 ile\SpecialChar \menuseparator
14457 ile\SpecialChar \menuseparator
14468 \begin_layout Section
14469 Importing Other Formats
14472 \begin_layout Subsection
14476 \begin_layout Standard
14477 Translating from LaTeX into LyX is performed by a converter program called
14483 Although it is a standalone program which can be called from the command
14484 line, LyX will call it automatically when a LaTeX document is imported.
14485 See section\InsetSpace ~
14487 \begin_inset LatexCommand ref
14488 reference "sec:Translating-LaTeX-files"
14492 for a complete description.
14495 \begin_layout Subsection
14499 \begin_layout Standard
14500 When importing plain ASCII text, there are two methods of reading the file.
14502 \begin_inset Quotes eld
14506 \begin_inset Quotes erd
14509 preserves all the linebreaks in the ASCII; to LyX, then, each line looks
14512 \begin_inset Quotes eld
14516 \begin_inset Quotes erd
14519 assumes that consecutive lines separated by only a single linebreak form
14520 a single paragraph.
14521 Successive linebreaks with no intervening text are thus assumed to be paragraph
14525 \begin_layout Subsection
14529 \begin_layout Standard
14532 [Editor's note: Needs to be written, obviously - any volunteers? --- mer]
14535 \begin_layout Section
14536 Exporting Other Formats
14539 \begin_layout Standard
14540 The output formats listed here in the following are also explained concerning
14541 possible graphics formats in the
14548 \begin_layout Subsection
14552 \begin_layout Standard
14553 LyX generates two types of LaTeX files: stripped down versions for the normal
14558 , etc.) which one normally never sees
14562 \begin_layout Standard
14563 The resulting file is a perfectly valid LaTeX file, though the preamble
14564 might look a bit strange since it includes some definitions used by LyX
14565 which wouldn't show up in most human-written files.
14570 , and human readable forms which are suitable for exchanging with your colleague
14572 The only settable option for the translation is the line length of the
14574 The default is 65 characters, but it can be set in
14581 \SpecialChar \menuseparator
14602 \begin_layout Subsection
14603 Device Independent Files
14606 \begin_layout Standard
14607 Device Independent files (DVI files) are produced by running LaTeX on your
14609 There are no user settable options.
14612 \begin_layout Subsection
14616 \begin_layout Standard
14617 The next step in the conversion chain is converting a DVI file into Postscript.
14625 \SpecialChar \menuseparator
14633 \SpecialChar \menuseparator
14642 or, if you need more control on the result,
14649 \SpecialChar \menuseparator
14658 If you use the later, note that it is possible to configure, in
14665 \SpecialChar \menuseparator
14673 , the options passed to the dvips program to achieve different effects.
14676 \begin_layout Subsection
14680 \begin_layout Standard
14681 Exporting as ASCII attempts to preserve the
14682 \begin_inset Quotes eld
14686 \begin_inset Quotes erd
14689 of the document as well as possible, but things like centering and indentation
14690 are thrown out; paragraphs are separated by blank lines.
14691 Section numbering and cross-references are done correctly, so the resulting
14692 text files is remarkably readable.
14693 The only changeable option is the length of lines, as for LaTeX output.
14696 \begin_layout Subsection
14700 \begin_layout Standard
14701 LyX documents can be converted to hypertext markup, usually by converting
14702 to LaTeX first, then converting that to HTML\SpecialChar \@.
14704 \begin_inset Formula $\rightarrow$
14707 HTML converters are currently known to LyX:
14724 Though they are autodetected, you can overide the selection in preferences.
14725 You can also include further command line options in this dialog.
14729 \begin_layout Subsection
14733 \begin_layout Standard
14741 \begin_layout Standard
14742 \begin_inset VSpace bigskip
14748 \begin_layout Standard
14749 The fastest way to generate a basic PDF file (no tags, links, etc.) with
14750 any version of LyX is to save the document as a Postscript file, then run
14756 Starting with version 1.1.6, the menu item
14760 will do all this for you.
14761 There are some issues with fonts that you need to pay attention to: see
14762 Section\InsetSpace ~
14764 \begin_inset LatexCommand ref
14765 reference "sec:badfonts"
14770 Also, as of version 1.1.6, there is a better method that will generate much
14771 more sophisticated files.
14774 \begin_layout Subsubsection
14778 \begin_layout Standard
14779 With pdfLaTeX you cannot use pstricks.
14780 On the other hand, with pdfLaTeX it is possible to insert directly images
14781 in JPEG, PDF or PNG format, use TrueType fonts, and more.
14784 \begin_layout Subsubsection
14785 Why does the text look so bad when viewed with Acrobat Reader?
14786 \begin_inset LatexCommand label
14787 name "sec:badfonts"
14792 \begin_inset OptArg
14795 \begin_layout Standard
14796 Bad Fonts in Acrobat Reader
14804 \begin_layout Standard
14805 The problem is that bitmap fonts are displayed poorly by Acrobat Reader.
14806 When creating a PDF from the LyX file, you need to use outline font instead
14807 of the default bitmap fonts (in fact, you should also use outline fonts
14808 for Postscript files).
14809 Recent LaTeX distributions come with Postscript Type 1 version of the standard
14810 (Computer Modern) fonts.
14811 pdfLaTeX uses these font by default.
14812 Dvips doesn't use these fonts by default, so to make it use them, add the
14813 following to lines to your
14820 \begin_layout LyX-Code
14824 \begin_layout LyX-Code
14828 \begin_layout Standard
14829 If the default LaTeX font encoding (OT1) is used, nothing else need to be
14831 However, if the T1 font encoding is used, then LaTeX uses the newer EC
14832 fonts, for which there are no Type1 version.
14833 The solution is to use the ae package which emulates T1 coded fonts using
14834 the standard CM fonts.
14835 This is done by adding
14839 usepackage{ae,aecompl}
14841 to the preamble of the LyX file.
14842 However, some glyphs are missing from the CM fonts (e.\InsetSpace \thinspace{}
14845 they are taken from the EC fonts.
14846 Therefore you get these glyphs as bitmaps.
14849 \begin_layout Standard
14850 Note: LyX uses by default the T1 font encoding.
14851 If you wish to use the default font encoding (this is not recommended,
14852 unless you only write English documents), clear the field
14860 in preferences (tabs
14872 \begin_layout Standard
14873 An alternate option is to use the standard Postscript fonts instead of the
14874 Computer Modern fonts.
14875 To do that, you need to select
14879 as the global font in the document layout dialog.
14880 When using the Postscript fonts, the result PDF file is smaller as the
14881 fonts are not saved into the file.
14882 Furthermore, the Postscript fonts include all T1 glyphs.
14883 On the other hand, the Postscript fonts have no bold symbol font, so poor
14884 man's bold must be used (see Section\InsetSpace ~
14886 \begin_inset LatexCommand ref
14887 reference "sec:pdfbold"
14892 The Postscript fonts also look different from the Computer Modern fonts.
14895 \begin_layout Standard
14896 To sum up, both the Computer Modern and the Postscript fonts gives good
14897 results (with few exceptions).
14898 The decision of which one to use is a matter of taste.
14901 \begin_layout Subsubsection
14904 boldsymbol{} command work when I use pslatex?
14905 \begin_inset LatexCommand label
14911 \begin_inset OptArg
14914 \begin_layout Standard
14931 \begin_layout Standard
14932 The Postscript fonts do not have a bold symbol font.
14933 The solution is to use the
14939 (poor man's bold) command.
14942 \begin_layout Standard
14943 It is possible to redefine the
14958 \begin_layout LyX-Code
14968 \begin_layout Standard
14972 \begin_layout Subsubsection
14973 Is it possible to do write LaTeX-code which is processed only when running
14975 \begin_inset OptArg
14978 \begin_layout Standard
14979 Conditionals with pdfLaTeX
14987 \begin_layout Standard
14988 Yes you can do this with the
14993 Here is an example:
14996 \begin_layout LyX-Code
15000 \begin_layout LyX-Code
15006 \begin_layout LyX-Code
15012 \begin_layout LyX-Code
15015 pdfinfo { /Author (your name and e-mail address)
15018 \begin_layout LyX-Code
15019 /Title (official title -- i.e., title element)
15022 \begin_layout LyX-Code
15023 /Subject (one line description of the document)
15026 \begin_layout LyX-Code
15030 \begin_layout LyX-Code
15033 pdfcatalog { /PageMode (/UseNone)
15036 \begin_layout LyX-Code
15037 % /OpenAction (fitbh)
15040 \begin_layout LyX-Code
15044 \begin_layout LyX-Code
15047 usepackage[pdftex]{hyperref}
15050 \begin_layout LyX-Code
15056 \begin_layout LyX-Code
15059 usepackage[ps2pdf]{hyperref}
15062 \begin_layout LyX-Code
15068 \begin_layout Subsubsection
15069 How can I make URLs clickable?
15072 \begin_layout Standard
15073 See the references here:
15076 \begin_layout Standard
15077 \begin_inset LatexCommand url
15078 target "http://wiki.lyx.org/pmwiki.php/FAQ/PDF"
15085 \begin_layout Subsection
15089 \begin_layout Standard
15090 Custom exports are possible if you have some particularly weird format you
15091 wish to convert to, assuming you have the relevant converter, of course.
15096 file can be chosen in the
15101 ile\SpecialChar \menuseparator
15106 xport\SpecialChar \menuseparator
15113 dialog; LyX will automatically convert the file to this point, then feed
15114 it to your custom converter.
15115 The possible values are all formats that LyX can produce from its own documents.
15119 \begin_layout Standard
15120 The converter command is also specified in the dialog.
15121 It should be a completely qualified command line which uses the variable
15126 to specify the name of the file.
15127 If this variable is not given, then the file will be sent to the standard
15128 input of your command.
15129 You may have to apply a bit of ingenuity to escape this sequence correctly
15130 so that it is compatible with your shell.
15134 \begin_layout Standard
15135 While it is not possible to save this command using the
15139 dialog, you can manually edit your
15146 \begin_layout LyX-Code
15149 custom_export_command "mycommand $$FName"
15152 \begin_layout Chapter
15153 LyX Features needing Extra Software
15156 \begin_layout Section
15160 \begin_layout Standard
15166 \begin_layout Subsection
15170 \begin_layout Standard
15178 menu, you'll find a
15187 This feature requires you to have the
15191 program installed, and is grayed out if you don't have it.
15192 You can get it from your nearest CTAN mirror, or over the Web from
15193 \begin_inset LatexCommand url
15194 target "http://www.ifi.uio.no/~jensthi/chktex/"
15201 \begin_layout Standard
15206 package is a program that was written by
15211 in frustration because some constructs in LaTeX are sometimes non-intuitive,
15212 and easy to forget.
15213 The program runs over your LaTeX file and checks the integrity of the file,
15214 and flags some common errors.
15215 In other technical words, it is
15222 \begin_layout Standard
15223 Well, what is a syntax checker doing in LyX which is supposed to produce
15224 correct LaTeX anyways? The answer is simple: Just as
15228 not only checks the
15232 of C programs, but also does
15236 checks for type-errors,
15240 catches some common
15244 errors, in addition to the syntactical ones.
15249 is capable of detecting several common errors, such as
15252 \begin_layout Itemize
15253 Ellipsis detection:
15255 Use \SpecialChar \ldots{}
15259 \begin_layout Itemize
15260 No space in front of/after parenthesis:
15265 \begin_layout Itemize
15266 Enforcement of normal space after common abbreviations:
15270 is too wide spacing.
15273 \begin_layout Itemize
15274 Enforcement of end-of-sentence space when the last sentence ends with a
15278 And this is wrong spacing.
15281 \begin_layout Itemize
15282 Space in front of labels and similar commands:
15284 The label should stick right
15285 up to the text to avoid falling to a wrong page.
15287 \begin_inset LatexCommand label
15296 \begin_layout Standard
15297 This footnote is in danger of falling off to a wrong page
15302 The label is separated too much.
15305 \begin_layout Itemize
15306 Space in front of references, instead of hard spaces:
15308 In you are in bad luck,
15309 the text will break right between the referenced text and reference number,
15312 \begin_inset LatexCommand ref
15313 reference "sec:chktex"
15320 \begin_layout Itemize
15322 \begin_inset Quotes eld
15326 \begin_inset Quotes erd
15330 \begin_inset Formula $\times$
15335 2x2 looks cheap compared to
15336 \begin_inset Formula $2\times2$
15342 \begin_layout Standard
15343 and more \SpecialChar \ldots{}
15344 It is an invaluable tool when you are
15345 \begin_inset Quotes eld
15349 \begin_inset Quotes erd
15352 your document before printing, and you should run it right after the obligatory
15353 spelling check, and before you go fine tuning the typesetting.
15356 \begin_layout Subsection
15360 \begin_layout Standard
15361 If you have the program installed, usage is as simple as choosing
15366 ools\SpecialChar \menuseparator
15375 This will make LyX generate a LaTeX file of your document, start
15379 to check it, and then make LyX insert
15380 \begin_inset Quotes eld
15384 \begin_inset Quotes erd
15387 with the warnings from
15391 , if there were any.
15392 The warnings will be placed close to the point of the mistake, and you
15393 can quickly find them by using the
15398 avigate\SpecialChar \menuseparator
15405 menu item, or the shortcut key
15414 Open the error boxes by clicking on them with the mouse, or use the shortcut
15423 bindings, or the corresponding
15432 Read the warning and correct the mistake, if it is a mistake.
15433 If you have trouble understanding what the warning is about, you can safely
15435 Remember that there is a hidden layer between the document on screen and
15436 the technical details in invoking
15440 , and this gap can make some warnings seem arcane or just right down plain
15444 \begin_layout Standard
15445 This document is an excellent testing bed for the feature, and it should
15446 provide quite a few warnings for you to fiddle with.
15447 Since computers are only so smart, expect most of the warnings to be false
15451 \begin_layout Subsection
15452 How to fine tune it
15455 \begin_layout Standard
15456 Sometimes, you'll find that
15460 makes more noise than suits your mood.
15461 Then you can choose not to use it, wait until your mood changes, or try
15466 to get better along with you.
15467 Another choice in the most desperate situations is to use
15472 iew\SpecialChar \menuseparator
15482 , which will get rid of all warnings instantly.
15485 \begin_layout Standard
15494 very configurable and extensible, you shouldn't expect to solve all problems
15500 Since LyX has to generate a somewhat special LaTeX file to be able to match
15501 the line numbers from the
15509 \begin_layout Standard
15510 You can inspect the specific output from
15516 Edit\SpecialChar \menuseparator
15530 to the internal document structure, some of the warnings will not seen
15531 to appear correctly.
15532 There are two things you can do about this:
15535 \begin_layout Itemize
15540 invocation command line in
15556 installation configuration file (usually with the file
15558 /usr/local/share/chktexrc
15561 See below to learn what warnings can be enabled and disabled on the command
15566 \begin_layout Itemize
15567 Export your document as a raw LaTeX file using
15572 ile\SpecialChar \menuseparator
15577 xport\SpecialChar \menuseparator
15589 Invoked in this way, it can be a hassle to find the corresponding place
15590 in the document inside LyX, but with a little patience, you should be able
15594 \begin_layout Standard
15595 Here follows the warning messages that can be enabled and disabled in
15604 to disable a warning, and
15608 to enable a warning.
15609 The emphasized entries are disabled by default, because the default is
15612 chktex -n1 -n3 -n6 -n9 -n22 -n25 -n30 -n38
15617 \begin_layout Standard
15618 Notice that you should only use the options that enable and disable warnings,
15619 because LyX relies on some of the other command line parameters to be set
15620 in a specific way to have a chance to communicate with
15627 \begin_layout Enumerate
15631 Command terminated with space.
15634 \begin_layout Enumerate
15637 Non-breaking space (
15638 \begin_inset Quotes eld
15646 \begin_inset Quotes erd
15649 ) should have been used.
15652 \begin_layout Enumerate
15656 You should enclose the previous parenthesis with
15657 \begin_inset Quotes eld
15665 \begin_inset Quotes erd
15671 \begin_layout Enumerate
15674 Italic correction (
15675 \begin_inset Quotes eld
15685 \begin_inset Quotes erd
15688 ) found in non-italic buffer.
15691 \begin_layout Enumerate
15694 Italic correction (
15695 \begin_inset Quotes eld
15705 \begin_inset Quotes erd
15708 ) found more than once.
15711 \begin_layout Enumerate
15715 No italic correction (
15716 \begin_inset Quotes eld
15726 \begin_inset Quotes erd
15732 \begin_layout Enumerate
15736 \begin_inset Quotes eld
15744 \begin_inset Quotes erd
15748 \begin_inset Quotes eld
15756 \begin_inset Quotes erd
15762 \begin_layout Enumerate
15765 Wrong length of dash may have been used.
15768 \begin_layout Enumerate
15772 \begin_inset Quotes eld
15780 \begin_inset Quotes erd
15784 \begin_inset Quotes eld
15792 \begin_inset Quotes erd
15798 \begin_layout Enumerate
15802 \begin_inset Quotes eld
15810 \begin_inset Quotes erd
15816 \begin_layout Enumerate
15820 \begin_inset Quotes eld
15828 \begin_inset Quotes erd
15831 to achieve an ellipsis.
15834 \begin_layout Enumerate
15837 Inter-word spacing (
15838 \begin_inset Quotes eld
15848 \begin_inset Quotes eld
15851 ) should perhaps be used.
15854 \begin_layout Enumerate
15857 Inter-sentence spacing (
15858 \begin_inset Quotes eld
15868 \begin_inset Quotes erd
15871 ) should perhaps be used.
15874 \begin_layout Enumerate
15877 Could not find argument for command.
15880 \begin_layout Enumerate
15884 \begin_inset Quotes eld
15892 \begin_inset Quotes erd
15898 \begin_layout Enumerate
15901 Math mode still on at end of LaTeX file.
15904 \begin_layout Enumerate
15908 \begin_inset Quotes eld
15916 \begin_inset Quotes erd
15919 doesn't match the number of
15920 \begin_inset Quotes eld
15928 \begin_inset Quotes erd
15934 \begin_layout Enumerate
15937 You should use either
15940 \begin_inset Quotes eld
15948 \begin_inset Quotes erd
15953 as an alternative to
15954 \begin_inset Quotes eld
15962 \begin_inset Quotes erd
15968 \begin_layout Enumerate
15975 " (ASCII 39) instead of "
15982 \begin_layout Enumerate
15985 User-specified pattern found.
15988 \begin_layout Enumerate
15991 This command might not be intended.
15994 \begin_layout Enumerate
16001 \begin_layout Enumerate
16019 \begin_layout Enumerate
16022 Delete this space to maintain correct page references.
16025 \begin_layout Enumerate
16029 You might wish to put this between a pair of
16030 \begin_inset Quotes eld
16038 \begin_inset Quotes erd
16044 \begin_layout Enumerate
16047 You ought to remove spaces in front of punctuation.
16050 \begin_layout Enumerate
16053 Could not execute LaTeX command.
16056 \begin_layout Enumerate
16065 in front of small punctuation.
16068 \begin_layout Enumerate
16076 may look prettier here.
16079 \begin_layout Enumerate
16083 Multiple spaces detected in output.
16086 \begin_layout Enumerate
16089 This text may be ignored.
16092 \begin_layout Enumerate
16098 \begin_inset Quotes eld
16103 to begin quotation, not
16110 \begin_layout Enumerate
16117 to end quotation, not
16120 \begin_inset Quotes eld
16128 \begin_layout Enumerate
16134 \begin_layout Enumerate
16137 You should perhaps use
16138 \begin_inset Quotes eld
16146 \begin_inset Quotes erd
16152 \begin_layout Enumerate
16155 You should put a space in front of/after parenthesis.
16158 \begin_layout Enumerate
16161 You should avoid spaces in front of/after parenthesis.
16164 \begin_layout Enumerate
16168 You should not use punctuation in front of/after quotes.
16171 \begin_layout Enumerate
16174 Double space found.
16177 \begin_layout Enumerate
16180 You should put punctuation outside inner/inside display math mode.
16183 \begin_layout Enumerate
16186 You ought to not use primitive TeX in LaTeX code.
16189 \begin_layout Enumerate
16192 You should remove spaces in front of
16193 \begin_inset Quotes eld
16201 \begin_inset Quotes erd
16207 \begin_layout Enumerate
16210 \begin_inset Quotes eld
16218 \begin_inset Quotes erd
16221 is normally not followed by
16222 \begin_inset Quotes eld
16230 \begin_inset Quotes erd
16236 \begin_layout Standard
16237 In later versions of LyX, we hope to provide a more complete interface to
16238 this tool (and it's smaller cousin
16242 ) to exploit the full power of it.
16243 But it's not exactly useless as it is now: go try it on one of your existing
16244 documents of a certain length and be surprised.
16247 \begin_layout Section
16248 Version Control in LyX
16251 \begin_layout Standard
16254 Lars Gullik Bjønnes
16257 \begin_layout Subsection
16261 \begin_layout Standard
16262 A friend of mine wanted to try LyX for a group project.
16263 When he didn't find support for version control or file locking, he dropped
16265 This angered me a bit, so I thought that I should at least make support
16266 for RCS (with the possibility of CVS and/or SCCS as a future improvement.)
16267 This has now been done.
16268 LyX now supports some of the most basic RCS commands.
16269 If you need to something a bit more sophisticated you will have to do that
16270 manually in an xterm.
16273 \begin_layout Standard
16274 Before you begin to use the version control features in LyX, you should
16276 \begin_inset Quotes eld
16280 \begin_inset Quotes erd
16283 (a man file, read it with
16288 This file describes all the basic features of RCS.
16289 You should especially notice the comment about a RCS directory, and the
16290 notion of a master RCS file (the file ending in
16297 \begin_layout Standard
16298 The implementation in LyX assumes a recent version of the GNU RCS package---no
16299 guarantees are made for older versions.
16302 \begin_layout Subsection
16303 RCS commands in LyX
16306 \begin_layout Standard
16307 The following sections describe the RCS commands supported by LyX.
16308 You can find them in the
16313 ile\SpecialChar \menuseparator
16318 ersion\InsetSpace ~
16324 \begin_layout Subsubsection
16330 \begin_layout Standard
16331 If your document is not under revision control, this is the only item shown
16333 And if it is under revision control, the
16340 item is grayed out.
16344 \begin_layout Standard
16345 This command registers your document with RCS\SpecialChar \@.
16346 You are asked interactively
16347 to supply an initial description of the document.
16348 The document is now set in Read-Only mode and you have to
16355 , before making any changes to it.
16356 A document under revision control has a
16357 \begin_inset Quotes eld
16360 [RCS:<version> <locker>]
16361 \begin_inset Quotes erd
16364 item tagged to the filename in the minibuffer.
16367 \begin_layout Standard
16368 RCS command that is run:
16370 ci -q -u -i -t-"<initial description>" <file-name>
16373 \begin_layout Standard
16378 to understand the switches.
16382 \begin_layout Subsubsection
16388 \begin_layout Standard
16389 When you are finished editing a file, you check in your changes.
16390 When you do this, you are asked for a description of the changes.
16391 This is stored in the history log.
16392 The version number is bumped, your changes are applied to the master RCS
16393 file, the document is unlocked and set to Read-Only mode.
16397 \begin_layout Standard
16400 ci -q -u -m"<description>" <file-name>
16403 \begin_layout Subsubsection
16409 \begin_layout Standard
16410 By doing this you lock the document so that only you can edit it.
16411 This will also make the document Read-Write only for you.
16412 You will usually continue editing for a while and when you are finished
16413 you check in your changes.
16414 The status line is changed to reflect that you have locked the file.
16418 \begin_layout Standard
16421 co -q -l <file-name>
16424 \begin_layout Subsubsection
16427 Revert To Last Version
16430 \begin_layout Standard
16431 This will discard all changes made to the document since the last check
16433 You get a warning before changes are discarded.
16436 \begin_layout Standard
16439 co -f -u<version> <file-name>
16442 \begin_layout Subsubsection
16448 \begin_layout Standard
16449 This makes as if the last check in never happened.
16450 No changes are made to the document loaded into LyX, but the last version
16451 is removed from the master RCS file.
16455 \begin_layout Standard
16458 rcs -o<version> <file-name>
16461 \begin_layout Subsubsection
16467 \begin_layout Standard
16468 This show the complete history of the RCS document.
16473 is shown in a browser.
16481 \begin_layout Section
16482 Literate Programming
16485 \begin_layout Standard
16490 (kayvan@sylvan.com)
16494 original documentation written by
16496 Edmar Wienskoski Jr.
16499 (edmar-w-jr@technologist.com)
16502 \begin_layout Subsection
16506 \begin_layout Standard
16507 The main purpose of this documentation is to show you how to use LyX for
16508 literate programming.
16509 Where it is assumed that you are familiar with this programming technique,
16511 \begin_inset Quotes eld
16515 \begin_inset Quotes erd
16519 \begin_inset Quotes eld
16523 \begin_inset Quotes erd
16527 If that is not the case, please follow the web links provided in the following
16529 There is a lot of good documentation out there covering old development
16530 history to the latest tools tips.
16533 \begin_layout Standard
16534 It is also assumed that you are familiar with LyX itself to a point that
16535 you are comfortable changing your LyX preferences, and X resources file.
16536 If that is not the case please refer to other LyX documentation to cover
16537 your specific needs.
16540 \begin_layout Subsection
16541 Literate Programming
16544 \begin_layout Standard
16545 From the Literate Programming FAQ:
16548 \begin_layout Quotation
16549 Literate programming is the combination of documentation and source together
16550 in a fashion suited for reading by human beings.
16551 In fact, literate programs should be enjoyable reading, even inviting!
16552 (Sorry Bob, I couldn't resist!) In general, literate programs combine source
16553 and documentation in a single file.
16554 Literate programming tools then parse the file to produce either readable
16555 documentation or compilable source.
16556 The WEB style of literate programming was created by D.E.
16557 Knuth during the development of his TeX typesetting software.
16561 \begin_layout Standard
16562 Another excerpt says:
16565 \begin_layout Quotation
16568 How is literate programming different from verbose commenting?
16571 \begin_layout Quotation
16572 There are three distinguishing characteristics.
16573 In order of importance, they are:
16577 \begin_layout Itemize
16578 flexible order of elaboration
16581 \begin_layout Itemize
16582 automatic support for browsing
16585 \begin_layout Itemize
16586 typeset documentation, especially diagrams and mathematics
16590 \begin_layout Standard
16591 Now that I sparked your curiosity, take a look in the references.
16594 \begin_layout Subsubsection
16598 \begin_layout Standard
16599 The complete Literate Programming FAQ can be found at:
16602 \begin_layout Quote
16603 \begin_inset LatexCommand url
16604 name "Literate Programming FAQ"
16605 target "http://shelob.ce.ttu.edu/daves/lpfaq/faq.html"
16612 \begin_layout Standard
16613 The FAQ lists 23 (twenty three!) different literate programming tools.
16614 Where some are specialized or
16615 \begin_inset Quotes eld
16619 \begin_inset Quotes erd
16622 for particular programming languages, while other have general scope.
16627 for my own use for several reasons:
16630 \begin_layout Itemize
16631 It can generate the documentation either in LaTeX or HTML.
16634 \begin_layout Itemize
16635 It has a open architecture, i.e., it is easy to plug in new filters and to
16636 perform special processing that you may need.
16640 \begin_layout Itemize
16641 There is a good selection of filters available already (the HTML is one
16645 \begin_layout Itemize
16649 \begin_layout Standard
16650 The Noweb web page can be found at:
16653 \begin_layout Quote
16654 \begin_inset LatexCommand url
16655 name "Noweb home page"
16656 target "http://www.cs.virginia.edu/~nr/noweb/"
16663 \begin_layout Standard
16664 Starting from there you can reach many other interesting links and even
16665 some literate program examples.
16668 \begin_layout Subsection
16669 \begin_inset LatexCommand label
16670 name "sub:LyX-and-Literate"
16674 LyX and Literate Programming
16677 \begin_layout Standard
16678 The LyX support for Literate Programming is provided by using the generic
16679 LyX convertors mechanism.
16680 This support is provided in a
16681 \begin_inset Quotes eld
16685 \begin_inset Quotes erd
16688 way, i.e., you will be able to use this new LyX feature with some other literate
16689 programming tool of your choice by just changing your LyX preferences.
16692 \begin_layout Subsubsection
16693 Generating documents and code (weaving and tangling)
16696 \begin_layout Paragraph
16697 Selecting the document class
16700 \begin_layout Standard
16701 If you have installed Noweb and LyX successfully, whenever you open a new
16702 document or try to change the document class of an existing one, you will
16703 find that there are three new document classes available:
16706 \begin_layout Itemize
16710 \begin_layout Itemize
16714 \begin_layout Itemize
16718 \begin_layout Standard
16719 You must select one of them to create your literate documents from.
16723 \begin_layout Standard
16724 Note that literate documents are not limited to these three classes.
16725 New classes can be generated from other styles like letter or in combination
16726 with other class variations like Article (AMS).
16727 If you have special needs that cannot be covered by one of the existing
16728 classes, let the LyX developers list (lyx-devel@lists.lyx.org) know and we
16729 will arrange to insert a new entry, or teach you how to do it.
16733 \begin_layout Standard
16734 It is very simple, it involves the creation of a file with four lines, and
16735 re-running of the auto configuration.
16740 Moreover, if you use a literate tool other than Noweb you may need to create
16741 a new set of document classes for it.
16744 \begin_layout Paragraph
16748 \begin_layout Standard
16749 LyX enables you to write code with a layout named
16757 \begin_layout Standard
16758 The equivalent Noweb term is
16759 \begin_inset Quotes eld
16763 \begin_inset Quotes erd
16767 For historical reasons, I got used to the term
16768 \begin_inset Quotes eld
16772 \begin_inset Quotes erd
16775 introduced by other literate tool named Nuweb, which I used for many years
16776 before rendering myself to Noweb.
16781 Noweb delimits scraps like this:
16784 \begin_layout LyX-Code
16788 \begin_layout LyX-Code
16792 \begin_layout LyX-Code
16796 \begin_layout LyX-Code
16800 \begin_layout LyX-Code
16804 \begin_layout Standard
16805 The problem is that whatever is written in between the << and the
16809 must be taken literally, i.e., LyX should be prevented from making any special
16810 interpretation of what has been written.
16811 This is handled by a special layout named Scrap, that works like a normal
16812 paragraph but has a free spacing capability.
16815 \begin_layout Standard
16816 The down side of the Scrap paragraph layout is that consecutive paragraphs
16817 of code will be spaced with one empty line in the source code and also
16818 in the printed documentation.
16819 The work around is to enter each line of code within a single Scrap, with
16820 a newline (ctrl-return).
16821 The example above will look like this:
16825 \begin_layout Standard
16826 If you have a printed version of this document you will not see any difference
16827 between the previous example and this one.
16835 \begin_layout LyX-Code
16847 \begin_layout Standard
16848 This layout works fine.
16849 The only real inconvenience is that you have to type ctrl-return instead
16854 \begin_layout Standard
16855 It is in my list of
16856 \begin_inset Quotes eld
16860 \begin_inset Quotes erd
16871 \begin_layout Standard
16872 As a special note, you can also use the
16873 \begin_inset Quotes eld
16877 \begin_inset Quotes erd
16880 construct of Noweb in your scraps to add items to Noweb's identifier cross-refe
16884 \begin_layout LyX-Code
16887 def some_function(args):
16889 "This is the doc string for this
16892 print "My args: ", args
16895 \begin_layout LyX-Code
16896 @ %def some_function
16899 \begin_layout Standard
16900 For an example of this usage and the resulting cross-reference output, look
16901 at the Literate python program in
16903 LIBDIR/examples/listerrors.lyx
16905 which should make this all clear.
16908 \begin_layout Paragraph
16909 Generating the documentation
16912 \begin_layout Standard
16913 At this point you already have a new document file with a proper document
16914 class, and with some code and text on it.
16915 How do I print it? The answer is simple, you select
16920 iew\SpecialChar \menuseparator
16928 Just like you would do for a plain document.
16929 No special procedure is required.
16932 \begin_layout Standard
16933 To help orientate you, I will now explain what happens inside LyX:
16936 \begin_layout Enumerate
16942 pdate\SpecialChar \menuseparator
16949 menu option is chosen, a LaTeX file is generated.
16954 \begin_layout Standard
16955 If the document is of any literate class the generated file will be named
16956 with an extension name defined by the
16957 \begin_inset Quotes eld
16961 \begin_inset Quotes erd
16964 format (defined in the Preferences panel), otherwise the file will have
16973 \begin_layout Enumerate
16974 Note that the only difference so far is in the name of the file, no special
16975 processing is required by LyX.
16976 Given that you formatted the code using the Scrap layout that, by itself,
16977 takes care of the business.
16980 \begin_layout Enumerate
16981 If the document is of any literate class LyX will then use the internal
16982 LyX to Noweb converter, followed by the Noweb to LaTeX converter
16986 \begin_layout Standard
16987 The converters are defined in the
16992 ools\SpecialChar \menuseparator
17000 \begin_inset Quotes eld
17004 \begin_inset Quotes erd
17009 \begin_inset LatexCommand ref
17010 reference "sub:converters"
17018 manual for general information about converters.
17023 to generate the LaTeX file.
17027 \begin_layout Standard
17028 Otherwise it will just skip this step.
17032 \begin_layout Enumerate
17033 Finally, LaTeX is invoked and the regular post processing continues as in
17037 \begin_layout Standard
17038 Independence from a particular
17039 \begin_inset Quotes eld
17043 \begin_inset Quotes erd
17046 is easily achieved by changing the commands that are run by the various
17050 \begin_layout Paragraph
17051 Generating the code
17054 \begin_layout Standard
17055 When the build menu option is chosen or the corresponding button in the
17056 toolbar is pressed, a LaTeX file is generated just like step 1 above.
17057 Next, LyX invokes the
17062 This converter needs to be defined by the user and is not installed by
17063 default, though the Program format is.
17064 This converter (like any other converter) will have two parts:
17067 \begin_layout Enumerate
17068 The converter program itself.
17069 This program performs the conversion from the one format to the other (in
17070 this case, from the Noweb format to the Program pseudo-format).
17073 \begin_layout Enumerate
17074 The error log parser.
17075 This is a program whose sole purpose is to rewrite error messages in a
17076 format that LyX understands.
17077 This makes it possible for LyX to place error boxes in the right places
17078 in the file buffer.
17081 \begin_layout Standard
17082 The first part, the
17083 \begin_inset Quotes eld
17087 \begin_inset Quotes erd
17090 setting, should be set to
17091 \begin_inset Quotes eld
17099 \begin_inset Quotes erd
17103 This basically means that LyX will call
17104 \begin_inset Quotes eld
17108 \begin_inset Quotes erd
17111 (a program or script) with the name of the Noweb file (normally a file
17112 in the LyX temp directory).
17116 \begin_layout Standard
17117 This is an implementation of
17118 \begin_inset Quotes eld
17122 \begin_inset Quotes erd
17125 that you can place in a directory on your path:
17128 \begin_layout LyX-Code
17132 \begin_layout LyX-Code
17136 \begin_layout LyX-Code
17137 notangle -Rbuild-script $1 | env NOWEB_SOURCE=$1 sh
17140 \begin_layout Standard
17141 The next part of the converter setting is the
17142 \begin_inset Quotes eld
17146 \begin_inset Quotes erd
17149 which is to be set to
17150 \begin_inset Quotes eld
17155 parselog=listerrors
17158 \begin_inset Quotes erd
17162 This will run any errors that are generated by the
17163 \begin_inset Quotes eld
17167 \begin_inset Quotes erd
17170 process through the
17171 \begin_inset Quotes eld
17175 \begin_inset Quotes erd
17181 \begin_layout Standard
17182 The converter code looks in
17190 then on the path for the
17191 \begin_inset Quotes eld
17195 \begin_inset Quotes erd
17201 \begin_layout Standard
17202 The build will normally take place in LyX's temporary directory, so the
17203 files produced by the conversion will be in that directory.
17204 LyX will copy out what it regards as the `main' file, but the
17208 conversion may produce several files, and so most of these would then be
17209 deleted when LyX was closed.
17210 The present solution is to use a `copier',
17214 \begin_layout Standard
17216 \begin_inset LatexCommand ref
17217 reference "sec:converters-etc"
17225 manual for information on these.
17234 script in its default mode, so that the entire contents of the temporary
17235 directory is copied.
17236 More will get copied than is needed, to be sure, but nothing will be lost.
17237 If, however, you know what extensions the generated files will have, this
17238 can be improved by using the
17247 This option takes a comma-separated list of extensions to copy.
17248 So, for example, if the conversion will generate only files with the extensions
17257 , then the correct definition would be:
17260 \begin_layout LyX-Code
17261 python -tt $$s/scripts/ext_copy.py -e c,h $$i $$o
17264 \begin_layout Standard
17265 The result will be that only files with these two extensions will be copied
17269 \begin_layout Paragraph
17270 Build instructions in the document
17273 \begin_layout Standard
17274 The last piece of the integration between LyX and noweb is the
17275 \begin_inset Quotes eld
17279 \begin_inset Quotes erd
17283 Generally, the instructions for building your program should be embedded
17284 in a scrap of its own.
17286 \begin_inset Quotes eld
17290 \begin_inset Quotes erd
17293 above uses the notangle command to look for this scrap (called
17294 \begin_inset Quotes eld
17298 \begin_inset Quotes erd
17301 ) and runs its contents through
17302 \begin_inset Quotes eld
17306 \begin_inset Quotes erd
17312 \begin_layout Standard
17313 Typically, such a scrap would look something like this:
17316 \begin_layout LyX-Code
17323 if [ -z "${NOWEB_SOURCE}" ]
17327 NOWEB_SOURCE=myfile.nw
17333 code to extract files ...]
17336 code to compile files ...]
17341 \begin_layout Standard
17344 LIBDIR/examples/listerrors.lyx
17348 LIBDIR/examples/Literate.lyx
17350 which implement two versions of the
17351 \begin_inset Quotes eld
17355 \begin_inset Quotes erd
17358 program for some illustrations of how all of these pieces go together or
17361 LIBDIR/examples/noweb2lyx.lyx.
17364 Interestingly, these three files show off the language-indepence of the
17365 LyX literate programming support since they are written in Python, C and
17369 \begin_layout Subsubsection
17373 \begin_layout Standard
17374 All the Literate Programming support is configured by the
17379 ools\SpecialChar \menuseparator
17387 \begin_inset Quotes eld
17391 \begin_inset Quotes erd
17395 The important parts are:
17398 \begin_layout Description
17401 \begin_inset Quotes eld
17405 \begin_inset Quotes erd
17409 format Set up via the Formats tab, this is where the Noweb-specific pieces
17419 , the file extension is set to
17424 This tells LyX to create a file with a
17428 extension in the first step of the conversion process.
17431 \begin_layout Description
17438 format This is an empty format whose sole purpose is to be the endpoint
17439 of a conversion (which then allows us to set up a converter for it).
17442 \begin_layout Description
17451 This converter performs the
17452 \begin_inset Quotes eld
17456 \begin_inset Quotes erd
17459 of the literate document.
17460 For Noweb, it is set to
17461 \begin_inset Quotes eld
17466 noweave -delay -index $$i > $$o
17469 \begin_inset Quotes erd
17475 \begin_layout Description
17485 \begin_inset Quotes eld
17489 \begin_inset Quotes erd
17493 As stated above, the Converter is set to
17494 \begin_inset Quotes eld
17502 \begin_inset Quotes erd
17505 , with Flags set to
17506 \begin_inset Quotes eld
17511 originaldir,parselog=listerrors
17514 \begin_inset Quotes erd
17520 \begin_layout Subsubsection
17524 \begin_layout Standard
17525 There is also a new function implemented in the LyX server, the
17526 \begin_inset Quotes eld
17529 server-goto-file-row" function, to be used with ddd/gdb or other debugger.
17533 \begin_layout Standard
17534 When debugging code with ddd/gdb, it is possible to invoke a text editor
17535 at the current execution position with a single key stroke.
17536 The default ddd configuration for that is shift-ctrl-V.
17537 It happens that you can define the editor command line invocation in ddd
17543 dit\SpecialChar \menuseparator
17548 references\SpecialChar \menuseparator
17555 dialog and changing the "Edit Sources" entry.
17558 \begin_layout Standard
17559 I take advantage of the new created LyX server function and this ddd feature,
17561 \begin_inset Quotes eld
17565 \begin_inset Quotes erd
17571 \begin_layout LyX-Code
17572 echo "LYXCMD:monitor:server-goto-file-row:@FILE@ @LINE@" >~/.lyxpipe.in
17575 \begin_layout Standard
17576 With this, whenever you are using ddd and find a point in the program that
17577 you want to edit, you just press shift-ctrl-V (in the ddd window), and
17578 ddd you forward this information to LyX through the LyX server and then
17579 the LyX window will show the same file with the cursor at the same position
17580 ddd was pointing to.
17581 No more guessing or long scrolling to locate a point in the program back
17585 \begin_layout Standard
17586 Note however that you must enable the LyX server to get this feature working
17587 (it is disabled by default).
17588 You can enable it in
17600 ) by entering in the
17605 \begin_inset Quotes eld
17610 /home/<your-home-directory>/.lyx/lyxpipe
17613 \begin_inset Quotes erd
17619 \begin_layout Standard
17620 Read the LyX server documentation in the
17622 Customization Manual
17624 for further information.
17627 \begin_layout Subsubsection
17631 \begin_layout Standard
17632 There are six new buttons that can be added to your LyX toolbar.
17633 Five of these buttons are short cuts to layout styles:
17654 The last one is a short cut to the
17655 \begin_inset Quotes eld
17659 \begin_inset Quotes erd
17666 \begin_layout Standard
17667 LyX has a range of buttons that are available for tool bar customization.
17668 In my toolbar I like to combine the six short cuts above with two more:
17676 \SpecialChar \menuseparator
17684 \SpecialChar \menuseparator
17697 iew\SpecialChar \menuseparator
17705 Here is how it looks like:
17708 \begin_layout LyX-Code
17712 \begin_layout LyX-Code
17716 \begin_layout LyX-Code
17717 Icon "layout Standard"
17720 \begin_layout LyX-Code
17721 Icon "layout Section"
17724 \begin_layout LyX-Code
17725 Icon "layout LaTeX"
17728 \begin_layout LyX-Code
17729 Icon "layout LyX-Code"
17732 \begin_layout LyX-Code
17733 Icon "layout Scrap"
17736 \begin_layout LyX-Code
17740 \begin_layout LyX-Code
17744 \begin_layout LyX-Code
17745 Icon "buffer-typeset"
17748 \begin_layout LyX-Code
17749 Icon "build-program"
17752 \begin_layout LyX-Code
17756 \begin_layout LyX-Code
17760 \begin_layout LyX-Code
17764 \begin_layout LyX-Code
17768 \begin_layout LyX-Code
17772 \begin_layout Subsubsection
17773 Colors customization
17776 \begin_layout Standard
17777 There are a number of colors in LyX that can be customized in
17782 One of the things that bothers people is the LaTeX font color.
17783 The default color is red, since the scraps uses LaTeX font, and there is
17784 a lot of scraps in literate documents, you may get tired of seeing everything
17786 You can change it by going to the tabs
17795 \begin_layout Standard
17796 The next thing is the visible presence of the newline character in the screen.
17797 You can choose the color of this particular character and make it blend
17799 I recommend you choosing a color that is close to the background but not
17800 equal, that way you still can see it is there, but it is not bothering
17805 \begin_layout Chapter
17806 Secrets of the LaTeX Masters
17807 \begin_inset LatexCommand label
17815 \begin_layout Standard
17816 Though LyX is a powerful tool, it cannot hope to support everything that
17817 can be done with pure TeX/LaTeX.
17818 However, many familiar dirty TeX and LaTeX tricks can be done within LyX,
17819 as long as you are not afraid to use that
17820 \begin_inset Quotes eld
17824 \begin_inset Quotes erd
17827 button on the toolbar or add things to the LaTeX preamble.
17828 This section lists some tips, tricks, and otherwise cool ideas to give
17829 your document that extra little flair.
17832 Do try this at home
17834 , just start with something a little smaller and less important than your
17838 \begin_layout Standard
17839 Most ideas in this section require less common files in your LaTeX installation.
17840 If you have a system like teTeX, most will already be available.
17841 A few, however, will need to be downloaded from one of the CTAN archives.
17842 Often, there are several ways to do something, or several LaTeX style files
17843 which do the same thing.
17844 We do not endorse one choice over another, we simply claim that we have
17845 done a particular task with a particular file.
17846 Put on your wizard hat, keep an eye out for dragons, and let us begin.
17849 \begin_layout Section
17853 \begin_layout Standard
17856 Lars Gullik Bjønnes
17859 \begin_layout Subsection
17863 \begin_layout Standard
17864 The aim for this chapter
17868 \begin_layout Standard
17869 Editor's note: Lars' original chapter was a masterful description of how
17875 However, it was too long to flow smoothly in this document.
17876 I have therefore chosen to excerpt the most important sections here (sorry,
17877 Lars); you can read the original chapter (and more of the story!) in the
17880 examples/multicol.lyx
17888 is to show how the LaTeX package
17892 can be used in a LyX document.
17893 As LyX doesn't support the
17897 package natively yet, we have to use some small hacks.
17898 By reading this section it should be obvious how to do this.
17901 \begin_layout Subsection
17905 \begin_layout Standard
17910 package allows switching between one and multicolumn format on the same
17912 Footnotes are handled correctly (for the most part), but will be placed
17913 at the bottom of the page and not under each column.
17914 LaTeX's float mechanism, however, is partly disabled in the current implementat
17916 At the moment only page-wide floats can be used within the scope of the
17920 \begin_layout Subsection
17924 \begin_layout Subsubsection
17928 \begin_layout Standard
17929 If you want to have two columns in your text, you have use LaTeX mode to
17934 begin{multicols}{2}
17936 at the point where you want the two column layout to start, and then
17942 where you want it to end.
17946 \begin_layout Standard
17950 \begin_layout Standard
17954 begin{multicols}{2}
17962 \begin_layout Standard
17967 The Adventure of the Empty House
17973 Sir Arthur Conan Doyle
17976 \begin_layout Standard
17979 It was in the spring of the year 1894 that all London was interested, and
17980 the fashionable world dismayed, by the murder of the Honourable Ronald
17981 Adair under most unusual and inexplicable circumstances.
17982 The public has already learned those particulars of the crime which came
17983 out in the police investigation, but a good deal was suppressed upon that
17984 occasion, since the case for the prosecution was so overwhelmingly strong
17985 that it was not necessary to bring forward all the facts.
17986 Only now, at the end of nearly ten years, am I allowed to supply those
17987 missing links which make up the whole of that remarkable chain.
17988 The crime was of interest in itself, but that interest was as nothing to
17989 me compared to the inconceivable sequel, which afforded me the greatest
17990 shock and surprise of any event in my adventurous life.
17991 Even now, after this long interval, I find myself thrilling as I think
17992 of it, and feeling once more that sudden flood of joy, amazement, and increduli
17993 ty which utterly submerged my mind.
17994 Let me say to that public, which has shown some interest in those glimpses
17995 which I have occasionally given them of the thoughts and actions of a very
17996 remarkable man, that they are not to blame me if I have not shared my knowledge
17997 with them, for I should have considered it my first duty to do so, had
17998 I not been barred by a positive prohibition from his own lips, which was
17999 only withdrawn upon the third of last month.
18002 \begin_layout Standard
18006 \begin_layout Standard
18018 \begin_layout Subsubsection
18022 \begin_layout Standard
18023 The same pattern is used when you want more than two columns:
18026 \begin_layout Standard
18030 \begin_layout Standard
18034 begin{multicols}{3}
18042 \begin_layout Standard
18045 It can be imagined that my close intimacy with Sherlock Holmes had interested
18046 me deeply in crime, and that after his disappearance I never failed to
18047 read with care the various problems which came before the public.
18048 And I even attempted, more than once, for my own private satisfaction,
18049 to employ his methods in their solution, though with indifferent success.
18050 There was none, however, which appealed to me like this tragedy of Ronald
18052 As I read the evidence at the inquest, which led up to a verdict of willful
18053 murder against some person or persons unknown, I realized more clearly
18054 than I had ever done the loss which the community had sustained by the
18055 death of Sherlock Holmes.
18056 There were points about this strange business which would, I was sure,
18057 have specially appealed to him, and the efforts of the police would have
18058 been supplemented, or more probably anticipated, by the trained observation
18059 and the alert mind of the first criminal agent in Europe.
18060 All day, as I drove upon my round, I turned over the case in my mind and
18061 found no explanation which appeared to me to be adequate.
18062 At the risk of telling a twice-told tale, I will recapitulate the facts
18063 as they were known to the public at the conclusion of the inquest.
18066 \begin_layout Standard
18070 \begin_layout Standard
18082 \begin_layout Standard
18083 You can have more than 3 columns if you want to, but that might not be very
18084 pleasant for the eye.
18087 \begin_layout Subsubsection
18088 Columns inside columns
18091 \begin_layout Standard
18092 You can even have columns inside columns:
18095 \begin_layout Standard
18099 \begin_layout Standard
18103 begin{multicols}{2}
18111 \begin_layout Standard
18114 The Honourable Ronald Adair was the second son of the Earl of Maynooth,
18115 at that time governor of one of the Australian colonies.
18116 Adair's mother had returned from Australia to undergo the operation for
18117 cataract, and she, her son Ronald, and her daughter Hilda were living together
18121 \begin_layout Standard
18125 \begin_layout Standard
18129 begin{multicols}{2}
18137 \begin_layout Standard
18140 The youth moved in the best society--had, so far as was known, no enemies
18141 and no particular vices.
18142 He had been engaged to Miss Edith Woodley, of Carstairs, but the engagement
18143 had been broken off by mutual consent some months before, and there was
18144 no sign that it had left any very profound feeling behind it.
18145 For the rest {sic} the man's life moved in a narrow and conventional circle,
18146 for his habits were quiet and his nature unemotional.
18147 Yet it was upon this easy-going young aristocrat that death came, in most
18148 strange and unexpected form, between the hours of ten and eleven-twenty
18149 on the night of March 30, 1894.
18152 \begin_layout Standard
18156 \begin_layout Standard
18168 \begin_layout Standard
18171 Ronald Adair was fond of cards--playing continually, but never for such
18172 stakes as would hurt him.
18173 He was a member of the Baldwin, the Cavendish, and the Bagatelle card clubs.
18174 It was shown that, after dinner on the day of his death, he had played
18175 a rubber of whist at the latter club.
18176 He had also played there in the afternoon.
18181 The evidence of those who had played with him-- Mr.
18182 Murray, Sir John Hardy, and Colonel Moran--showed that the game was whist,
18183 and that there was a fairly equal fall of the cards.
18184 Adair might have lost five pounds, but not more.
18185 His fortune was a considerable one, and such a loss could not in any way
18187 He had played nearly every day at one club or other, but he was a cautious
18188 player, and usually rose a winner.
18189 It came out in evidence that, in partnership with Colonel Moran, he had
18190 actually won as much as four hundred and twenty pounds in a sitting, some
18191 weeks before, from Godfrey Milner and Lord Balmoral.
18192 So much for his recent history as it came out at the inquest.
18195 \begin_layout Standard
18199 \begin_layout Standard
18211 \begin_layout Standard
18212 Please do read the file
18214 examples/multicol.lyx
18216 for more advanced examples including column and header spacing, vertical
18217 separator lines, and more.
18220 \begin_layout Section
18225 Paragraph Environment
18226 \begin_inset OptArg
18229 \begin_layout Standard
18230 Numbering in Enumerate
18238 \begin_layout Standard
18244 \begin_layout Standard
18245 \begin_inset VSpace bigskip
18251 \begin_layout Standard
18253 The default numbering for the
18257 paragraph environment begins with Arabic numbers and ends with uppercase
18259 Suppose, however, you wanted a different type of numbering scheme.
18260 Here's a quickie example of how to change the numbering scheme:
18263 \begin_layout LyX-Code
18273 \begin_layout LyX-Code
18283 \begin_layout LyX-Code
18293 \begin_layout LyX-Code
18303 \begin_layout Standard
18304 \SpecialChar \ldots{}
18305 which changes the numbering scheme to uppercase Roman numerals, uppercase
18306 letters, Arabic numbers, and lowercase letter.
18309 \begin_layout Standard
18310 Additionally, the previous example also adds a little bit extra to the numbering
18312 For example, the first level label actually looks like:
18313 \begin_inset Quotes eld
18317 \begin_inset Quotes erd
18321 For ease of reading, we'll describe what the numbering schemes look like
18322 using a notation something like this: <
18323 \begin_inset Quotes eld
18327 \begin_inset Quotes erd
18332 \begin_inset Quotes erd
18336 \begin_inset Quotes erd
18341 \begin_inset Quotes erd
18345 \begin_inset Quotes erd
18350 \begin_inset Quotes eld
18354 \begin_inset Quotes erd
18361 \begin_layout Standard
18362 As you can see in the example, there is a label command for each nesting
18369 \SpecialChar \ldots{}
18376 , as well as a counter,
18380 \SpecialChar \ldots{}
18386 There are also five
18387 \begin_inset Quotes eld
18391 \begin_inset Quotes erd
18424 , each of which take one counter as an argument.
18425 You can add characters before or after these, but there's no need to add
18429 \begin_layout Standard
18430 You can get really fancy with these.
18434 \begin_layout LyX-Code
18448 \begin_layout LyX-Code
18460 \begin_layout LyX-Code
18470 \begin_layout LyX-Code
18480 \begin_layout Standard
18481 produces the somewhat out of hand numbering scheme: <
18482 \begin_inset Quotes eld
18486 \begin_inset Quotes erd
18491 \begin_inset Quotes erd
18495 \begin_inset Quotes erd
18500 \begin_inset Quotes erd
18504 \begin_inset Quotes erd
18509 \begin_inset Quotes eld
18513 \begin_inset Quotes erd
18520 \begin_layout Standard
18524 \begin_layout Section
18528 \begin_layout Standard
18534 \begin_layout Standard
18535 \begin_inset VSpace bigskip
18541 \begin_layout Standard
18546 \begin_layout Standard
18552 tmpfont}{cmr17 scaled 2500}{
18564 \begin_layout Standard
18569 \begin_layout Standard
18580 hose of you who like the style of old books probably also like
18581 \begin_inset Quotes eld
18585 \begin_inset Quotes erd
18588 ---those large capital letters which begin each new chapter or section.
18589 Implementing them with plain LyX/LaTeX is straightforward (assuming you
18590 know some plain TeX!) but does require a lot of work and many iterations,
18591 as you can see by all the ugly TeX-mode stuff at the beginning of this
18595 \begin_layout Standard
18599 \begin_layout Standard
18605 bigdrop{-1em}{3}{ptmri}{T}+
18610 here is a much easier way of doing this, of course.
18619 ) package from CTAN allows a simple way to add such letters to your documents.
18620 Since this package is not a standard part of teTeX, I can't demonstrate
18621 it within this document, but if you copy this paragraph to a new document,
18623 \begin_inset Quotes eld
18633 \begin_inset Quotes erd
18636 and the pluses from the TeX code at the beginning of the paragraph, and
18641 usepackage{dropcaps}
18643 to your LaTeX preamble, you will get a nice Times Roman Italic
18644 \begin_inset Quotes eld
18648 \begin_inset Quotes erd
18651 , whose height is three lines of text and which protrudes 1 em into the
18653 (Make certain you have copied
18654 \begin_inset Quotes eld
18662 \begin_inset Quotes erd
18665 into a directory where TeX can see it.) The first argument is the amount
18666 of indentation; in this case the negative sign moves it into the margin.
18667 The second argument is the height of the letter in number of lines of text.
18668 The third argument is the font name: virtually anything which has a tfm
18669 file should work (wade through the
18671 .../texmf/fonts/tfm
18673 directory for possibilities).
18674 My personal favorite is
18675 \begin_inset Quotes eld
18683 \begin_inset Quotes erd
18686 , a fancy German font specifically designed for dropped capitals.
18687 The fourth argument is the letter (or letters) to be dropped.
18692 package also offers the
18698 command, as well as a slightly simplified
18707 \begin_layout Section
18708 Non-standard Paragraph Shapes
18711 \begin_layout Standard
18717 \begin_layout Standard
18718 \begin_inset VSpace bigskip
18724 \begin_layout Standard
18728 \begin_layout Standard
18740 \begin_layout Standard
18744 \begin_layout Standard
18753 \begin_layout Standard
18767 \begin_layout Standard
18772 \begin_layout Standard
18783 \begin_layout Standard
18792 \begin_layout Standard
18801 \begin_layout Standard
18810 \begin_layout Standard
18819 \begin_layout Standard
18828 \begin_layout Standard
18837 \begin_layout Standard
18846 \begin_layout Standard
18855 \begin_layout Standard
18864 \begin_layout Standard
18873 \begin_layout Standard
18882 \begin_layout Standard
18891 \begin_layout Standard
18900 \begin_layout Standard
18909 \begin_layout Standard
18918 \begin_layout Standard
18927 \begin_layout Standard
18936 \begin_layout Standard
18945 \begin_layout Standard
18951 There are times when the tyranny of rectangular paragraphs must be overthrown.
18952 In such situations, a call to the delightful plain TeX command
18959 As you can see, completely arbitrary shapes can be laid out with a suitable
18960 set of linelength definitions.
18961 While this parshape may look a bit silly and useless, one could conceive
18962 of situations such as finely tuned dropped capitals, word wrapping around
18963 non-rectangular graphics, etc.
18964 which will benefit from such handcrafting.
18967 \begin_layout Standard
18968 \begin_inset VSpace bigskip
18974 \begin_layout Standard
18979 parshape numlines #1indent #1length #2indent #2length \SpecialChar \ldots{}
18986 is the number of lines of text which define the paragraph.
18987 If there turn out to be fewer lines, the shape is truncated; if there are
18988 more, the excess lines have the same dimensions as the last line of the
18998 entries specify the indentation of the line from the left margin, and the
18999 length of the line as measured from that point.
19000 The shape applies only to the current paragraph; everything is reset to
19001 normal for the next paragraph.
19004 \begin_layout Standard
19008 \begin_layout Standard
19020 \begin_layout Section
19024 \begin_layout Standard
19025 As you can see, the examples in this section range from the useful to the
19027 While I don't expect that anyone will ever need the paragraph shape demonstrate
19028 d in the last section, the important point is that you can do almost anything
19029 you want in LyX if you are willing to figure out how to do it in TeX and
19031 TeX is a fantastically powerful typesetting system and all that power is
19032 available to you since LyX uses it as its backend.