1 #LyX 1.6.0svn created this file. For more info see http://www.lyx.org/
7 % DO NOT ALTER THIS PREAMBLE!!!
9 % This preamble is designed to ensure that the manual prints
10 % out as advertised. If you mess with this preamble,
11 % parts of the manual may not print out as expected. If you
12 % have problems LaTeXing this file, please contact
13 % the documentation team
14 % email: lyx-docs@lists.lyx.org
20 % set fonts for nicer pdf view
21 \IfFileExists{lmodern.sty}
22 {\usepackage{lmodern}}{}
24 \fi % end if pdflatex is used
26 % the pages of the TOC are numbered roman
27 % and a PDF-bookmark for the TOC is added
29 \let\myTOC\tableofcontents
30 \renewcommand{\tableofcontents}{%
31 \pdfbookmark[1]{\contentsname}{}
34 \pagenumbering{arabic}}
36 % redefine the \LyX macro for PDF bookmarks
37 \def\LyX{\texorpdfstring{%
38 L\kern-.1667em\lower.25em\hbox{Y}\kern-.125emX\@}
41 % used for multi-column text
44 % extra space for tables
45 \newcommand{\extratablespace}[1]{\noalign{\vskip#1}}
47 \options fleqn,liststotoc,bibtotoc,idxtotoc,BCOR7.5mm,titlepage,tablecaptionabove
57 \font_typewriter default
58 \font_default_family default
68 \pdf_title "LyX's Extended manual"
69 \pdf_author "LyX Team"
70 \pdf_subject "LyX's extended documentation"
71 \pdf_keywords "LyX, Documentation, Extended"
73 \pdf_bookmarksnumbered true
74 \pdf_bookmarksopen false
75 \pdf_bookmarksopenlevel 1
80 \pdf_pagebackref false
81 \pdf_pdfusetitle false
82 \pdf_quoted_options "linkcolor=black, citecolor=black, urlcolor=blue, filecolor=blue, pdfpagelayout=OneColumn, pdfnewwindow=true, pdfstartview=XYZ, plainpages=false, pdfpagelabels"
89 \paperorientation portrait
92 \paragraph_separation indent
94 \quotes_language english
97 \paperpagestyle headings
98 \tracking_changes false
107 Extended LyX Features
115 \begin_layout Plain Layout
117 Principal maintainer of this file is
122 If you have comments or error corrections, please send them to the LyX
123 Documentation mailing list,
124 \begin_inset Flex CharStyle:Code
127 \begin_layout Plain Layout
129 <lyx-docs@lists.lyx.org>
142 \begin_layout Standard
143 \begin_inset CommandInset toc
144 LatexCommand tableofcontents
151 \begin_layout Chapter
155 \begin_layout Standard
158 Extended LyX Features
160 manual, which you are now reading, is essentially Part II of the
162 User's Guide\SpecialChar \@.
165 The reason for separating this document out is simple: the
169 is already huge, and it contains all of the basic features one needs to
170 know in order to prepare most documents.
171 However, the LyX Team has a long-term goal of making LyX extensible through
172 various configuration files and external packages.
173 That means that if you want to support the Fizzwizzle LaTeX package, you
174 can create a layout file (or module) for it without having to alter LyX
176 We've already had contributions of several new features this way.
177 This is the place where all of that gets documented.
180 \begin_layout Standard
181 This manual also documents some special features, like fax support, version
182 control, and SGML support, which require additional software to work properly.
183 Lastly, there's a chapter of LaTeX tools and tips, things you can use to
184 spruce up your documents by directly using the powerful features of LaTeX.
189 only WYSIWYM and will only ever interface to some, not all, LaTeX features.
192 \begin_layout Standard
193 If you haven't read the
197 yet, you are definitely in the wrong manual.
202 is the first place to go, since it will direct you to the correct manual,
203 and it also describes the notation and format of all of the manuals.
204 You should also be thoroughly familiar with the
208 and all of the basic features of LyX.
212 \begin_layout Standard
213 In this document, many sections are independent articles contributed by
214 an individual and are noted as such.
215 This person is generally whoever wrote the layout file for the new document
216 class or LaTeX package, or implemented the feature.
217 If there is no mention of an author to a chapter [or chapter sections],
218 that means it was written by the LyX Documentation Team.
221 \begin_layout Standard
222 Since all the topics in this manual depend heavily on LyX's interaction
223 with LaTeX, this first chapter covers the inner workings of LyX and how
224 to direct LyX to generate exactly the LaTeX code you want.
225 It is obviously for more seasoned LyX users.
228 \begin_layout Chapter
232 \begin_layout Section
236 \begin_layout Standard
237 This chapter is for both TeX-nicians and the LaTeX-curious.
238 In it, we'll explain how LyX and LaTeX work together to produce printable
240 This is the only place in any of the manuals where we assume you know something
244 \begin_layout Standard
245 At one time, LyX was called a
246 \begin_inset Quotes eld
249 WYSIWYM frontend to LaTeX,
250 \begin_inset Quotes erd
253 but that's no longer true.
254 There are frontends to LaTeX out there.
255 They are basically editors with the ability to run LaTeX and mark any errors
256 in the file you're editing.
265 run LaTeX, and it also marks errors in the file, it also does much, much
267 Thanks to the WYSIWYM concept, you don't need to know LaTeX to use LyX
269 LyX has also added a few extensions to LaTeX.
270 Try the following sometime: select
272 Export\SpecialChar \menuseparator
284 View\SpecialChar \menuseparator
287 ), then look at the preamble of the resulting
292 You'll notice a variety of new macros defined specifically by LyX.
293 These macros are defined automatically, according to the features you use
297 \begin_layout Standard
298 There are several commands that automatically invoke LaTeX.
302 \begin_layout Itemize
308 iew\SpecialChar \menuseparator
318 \begin_layout Itemize
324 iew\SpecialChar \menuseparator
329 pdate\SpecialChar \menuseparator
335 \begin_layout Itemize
343 \SpecialChar \menuseparator
349 \begin_layout Itemize
357 \SpecialChar \menuseparator
363 \begin_layout Standard
364 They will only invoke LaTeX if the file has changed since the last time
369 \begin_layout Standard
370 When it runs LaTeX on the file you're editing, LyX performs these steps:
373 \begin_layout Enumerate
374 Convert the document to LaTeX and save to a file with the extension
385 \begin_layout Enumerate
390 file (maybe several times), and run any other commands (such as bibtex
391 or makeindex) needed to compile the LaTeX file.
394 \begin_layout Enumerate
395 If there are any errors, show the error log.
398 \begin_layout Standard
399 If you've run LaTeX using
407 , LyX then runs a dvi viewer to display DVI-file.
416 , LyX performs further steps:
419 \begin_layout Itemize
424 to convert the DVI file to PostScript®.
427 \begin_layout Itemize
428 Run a Postscript viewer, such as
432 , to display the PostScript® file.
435 \begin_layout Standard
436 LyX does similar things when viewing, or exporting, other formats.
439 \begin_layout Section
440 Translating LaTeX files into LyX
443 \begin_layout Standard
444 You can import a LaTeX file into LyX by using the
449 ile\SpecialChar \menuseparator
454 mport\SpecialChar \menuseparator
462 This will call a program named
466 ---which will create a file
474 ---and then LyX will attempt to open that file.
477 \begin_layout Standard
482 will translate most legal LaTeX, but not everything.
483 It will put things it doesn't understand into ERT, so after translating
488 , you can look for ERT and hand-edit it to look right.
491 \begin_layout Section
492 \begin_inset CommandInset label
494 name "sec:Inserting-TeX-Code"
498 Inserting TeX Code into LyX Documents
501 \begin_layout Standard
502 This is a rather important point: You can always insert TeX code into any
504 LyX cannot, and will never be able to, display every possible LaTeX construct.
505 If ever you need to insert LaTeX commands into your LyX document, you can
506 use the TeX Code box, which you can insert into your document with
508 Insert\SpecialChar \menuseparator
514 \begin_layout Standard
515 Here's an example of inserting LaTeX commands in a LyX document.
516 The code looks like this:
519 \begin_layout LyX-Code
523 \begin_inset Newline newline
529 \begin_inset Newline newline
532 This is an example for a minipage environment.
534 \begin_inset Newline newline
537 can put nearly everything in it, even (non-floating)
538 \begin_inset Newline newline
543 \begin_inset Newline newline
549 \begin_inset Newline newline
553 \begin_inset Newline newline
559 \begin_inset Newline newline
565 \begin_inset Newline newline
571 \begin_inset Newline newline
576 \begin_inset Newline newline
582 \begin_inset Newline newline
588 \begin_inset Newline newline
594 \begin_inset Newline newline
602 \begin_layout LyX-Code
606 \begin_layout Standard
607 The TeX Code box containing this text is directly after this paragraph.
608 Those of you reading the manual in LyX will only see the ERT inset.
609 Those reading a printed version of the manuals will see the actual results:
612 \begin_layout Standard
616 \begin_layout Plain Layout
623 \begin_layout Plain Layout
630 \begin_layout Plain Layout
632 This is an example for a minipage environment.
633 You can put nearly everything in it, even (non-floating) figures and tables.
637 \begin_layout Plain Layout
644 \begin_layout Plain Layout
649 \begin_layout Plain Layout
656 \begin_layout Plain Layout
663 \begin_layout Plain Layout
670 \begin_layout Plain Layout
676 \begin_layout Plain Layout
683 \begin_layout Plain Layout
690 \begin_layout Plain Layout
697 \begin_layout Plain Layout
709 \begin_layout Standard
710 In addition to using ERT, you can also create a separate file containing
711 some complex LaTeX structure and then use
713 Insert\SpecialChar \menuseparator
720 to include your file (you should select the type
725 We recommend that you only do this if you have a
734 Otherwise, you'll have a big job tracking down LaTeX errors\SpecialChar \ldots{}
738 \begin_layout Standard
739 There are a few last points to emphasize:
742 \begin_layout Itemize
743 Inside of LyX, LaTeX code appears
748 \begin_layout Itemize
753 check if your LaTeX code is correct.
756 \begin_layout Itemize
757 Beware reinventing the wheel.
760 \begin_layout Standard
761 On that last point, LyX does have quite a few features tucked into it, and
763 Be sure to check the manuals to make sure that LyX doesn't have such-and-such
764 feature before you decide you have to do it by hand.
765 Moreover, there are numerous LaTeX packages out there to do all sorts of
766 things, from labels to envelopes to fancy multipage tables.
768 \begin_inset CommandInset href
771 target "http://www.ctan.org/"
778 \begin_layout Standard
779 If you do need to do some wild and fancy things within your document, be
780 sure to check out a good LaTeX book for assistance.
781 There are a number of them listed in the bibliography of the
788 \begin_layout Section
789 LyX and the LaTeX Preamble
792 \begin_layout Subsection
793 About the LaTeX Preamble
796 \begin_layout Standard
797 If you already know LaTeX, there is no need to explain here what the preamble
799 If you don't, the following will give you some ideas---we recommend again
800 that you consult a LaTeX book for further information.
801 In any case, you should read the points below, because they explain what
802 you can do and what you don't need to do in the LaTeX preamble of a LyX
806 \begin_layout Standard
807 The LaTeX preamble comes at the very beginning of a document,
815 \begin_layout Itemize
816 declare the document class.
817 LyX already does this for you.
821 \begin_layout Standard
822 If you're a seasoned LaTeX-nician, and you have some custom document class
823 you want to use, check out the
827 for information on how to make LyX interface to it.
828 Be sure to submit your efforts to the LyX Team for inclusion in future
833 \begin_layout Itemize
834 declare the usage of packages.
835 LaTeX packages provide special commands, which are only available within
836 a document when the package has been declared in the preamble.
837 For example, the package
841 forces all paragraphs to be indented.
842 There are other packages for labels, envelopes, margins, etc.
846 \begin_layout Itemize
847 set counters, variables, lengths and widths.
848 There are several LaTeX counters and variables which
852 be set globally from within the preamble in order to have the desired effect.
853 (There are variables which you can set and reset inside the document, too.)
854 Margins are a good example of something which must be set in the preamble.
855 Another example is the label format for lists.
856 You can actually set these just about anywhere, but it's best to do it
857 just once, inside the preamble.
860 \begin_layout Itemize
861 declare user defined commands [with
873 ], mostly abbreviations for LaTeX commands which appear very often inside
875 Although the preamble is a good place to declare such commands, they
879 be declared anywhere else (before they are used for the first time, of
880 course\SpecialChar \ldots{}
882 This can be useful if there is a lot of raw LaTeX code in your document,
883 which normally should not be the case.
886 \begin_layout Standard
887 LyX adds its own set of definitions to the preamble of the
892 This makes LaTeX files generated by LyX portable.
895 \begin_layout Subsection
896 Changing the Preamble
899 \begin_layout Standard
900 The commands which LyX adds to the preamble of a LaTeX file are fixed; you
901 can't change them without patching LyX itself.
902 You can, however, add your own stuff to the preamble by selecting
924 \SpecialChar \menuseparator
933 LyX adds anything in the
937 dialog to its own built-in preamble.
938 Before adding your own declarations in the preamble, you should make sure
939 that LyX doesn't already support what you want to do (remember what we
940 said about reinventing the wheel?).
943 make sure your preamble code is correct
946 LyX doesn't check it.
949 \begin_layout Subsection
953 \begin_layout Standard
954 Here are some examples of what you can add to a preamble, and what they
958 \begin_layout Subsubsection
962 \begin_layout Standard
963 There are two variables under LaTeX that control page position:
976 Their names should be self-explanatory.
977 These variables are useful if you think for a moment about computer labels.
978 Sometimes, the size of a print medium and the area of the medium that you
979 can actually print on aren't the same.
995 \begin_layout Standard
996 The default values for
1008 are both 0 pt., i.e., the page isn't shifted.
1011 \begin_layout Standard
1012 Unfortunately, some DVI drivers always seem to shift the page.
1013 We have no idea why, or why the sysadmin hasn't fixed such behavior.
1014 If you're using LyX on a system that you don't personally maintain, and
1015 your sysadmin is a doofus,
1028 Suppose you're left and top margins are always 0.5 inches too big.
1029 You can add this to the preamble:
1032 \begin_layout LyX-Code
1040 \begin_layout LyX-Code
1048 \begin_layout Standard
1049 and your margins should now be correct.
1052 \begin_layout Subsubsection
1056 \begin_layout Standard
1057 Speaking of labels, suppose you wanted to print out a bunch of address labels.
1058 There's a rather nice package, available at your nearest CTAN archive,
1059 for printing sheets of labels:
1064 Now, your system may not have this package installed by default.
1065 We leave that up to you to check.
1066 You'll also want to read the documentation for it; we're not going to do
1068 Since this is an example, however, we'll give you an example of how you
1072 \begin_layout Standard
1073 First, make sure you're using the
1078 Next, you need to put the following in your preamble:
1081 \begin_layout LyX-Code
1087 \begin_layout LyX-Code
1093 \begin_layout LyX-Code
1099 \begin_layout LyX-Code
1105 \begin_layout LyX-Code
1111 \begin_layout LyX-Code
1117 \begin_layout LyX-Code
1123 \begin_layout Standard
1124 This sets things up for Avery® label sheets, stock #5360.
1125 You're now ready to print labels, but you'll need to insert LaTeX code,
1126 placing the commands
1138 around each label text.
1139 This and other special features of
1143 are explained in its documentation.
1146 \begin_layout Standard
1147 Someday, someone may write a LyX layout file to support this package directly.
1148 Maybe that someone is you.
1151 \begin_layout Subsubsection
1152 Example #3: Paragraph Indentation
1155 \begin_layout Standard
1156 Americans are trained to indent the first line of
1161 As with all of their other weird quirks, most Americans will whine and
1162 moan until they can have their way and indent the first line of all paragraphs.
1167 \begin_layout Standard
1168 Of course, this behavior isn't standard typography.
1169 In books, you typically only indent the first line of a paragraph
1173 it follows another one.
1174 The idea behind indenting the first line of a paragraph is to distinguish
1175 neighboring paragraphs from one another.
1176 If there is no previous paragraph, for example, it follows a figure, or
1177 is the first paragraph in a section, then there is no special indentation.
1181 \begin_layout Standard
1182 If you're a typical American, though, you don't care about such esoteric
1183 things; you want your indentation! Add this to the preamble:
1186 \begin_layout LyX-Code
1189 usepackage{indentfirst}
1192 \begin_layout Standard
1193 If your TeX distribution isn't a braindead one, you'll have this package,
1194 and all of your paragraphs will get the indentation you think they deserve.
1197 \begin_layout Subsubsection
1198 Example #4: This Document
1201 \begin_layout Standard
1202 You can also check out the preamble of this document to get an idea of some
1203 of the advanced things you can do.
1204 Also, there are more examples and an assortment of LaTeX
1205 \begin_inset Quotes eld
1209 \begin_inset Quotes erd
1213 \begin_inset space ~
1217 \begin_inset CommandInset ref
1219 reference "cha:secrets"
1227 \begin_layout Section
1228 LyX and LaTeX Errors
1231 \begin_layout Standard
1232 When LyX calls LaTeX, it tells LaTeX to blithely ignore any errors and keep
1234 It then uses the log-file from the LaTeX run to do a post-mortem.
1235 LyX will then display a dialog listing the errors, and clicking on any
1236 one of them will take you to the position in your LyX file where the error
1240 \begin_layout Standard
1241 Some folks also like to look at the log file directly, accessible from
1246 ocument\SpecialChar \menuseparator
1252 \begin_inset space ~
1256 \begin_inset space ~
1262 There are some fairly common error messages and warnings.
1263 We'll cover those here.
1264 You should look at a good LaTeX book for a complete listing.
1267 \begin_layout Itemize
1268 \begin_inset Quotes eld
1276 \begin_inset Quotes eld
1283 \begin_layout Standard
1284 Anything beginning with these word is a warning message for the purpose
1286 \begin_inset Quotes eld
1290 \begin_inset Quotes erd
1293 the LaTeX code itself.
1294 You'll get messages like this if you added or changed cross-references
1295 or bibliography entries, in which case, LaTeX is trying to tell you that
1296 you need to make another run.
1299 \begin_layout Standard
1300 You can by-and-large ignore these.
1304 \begin_layout Itemize
1305 \begin_inset Quotes eld
1313 \begin_inset Quotes erd
1320 \begin_layout Standard
1321 Another warning message, this time about fonts which LaTeX couldn't find.
1322 The rest of the message will often say something about a replacement font
1326 \begin_layout Standard
1327 You can safely ignore these.
1331 \begin_layout Itemize
1332 \begin_inset Quotes eld
1342 \begin_inset Quotes erd
1349 \begin_layout Standard
1355 They are warning you about lines that were too long and run past the right
1357 Almost always, this is unnoticeable in the final output.
1358 Or, only one or two characters extend past the margin.
1359 LaTeX seems to generate at least one of these messages for just about any
1363 \begin_layout Standard
1364 You can ignore these stupid messages.
1365 Your eyes will tell you if there's a problem with something that's too
1366 wide; just look at the output.
1370 \begin_layout Itemize
1371 \begin_inset Quotes eld
1381 \begin_inset Quotes erd
1388 \begin_layout Standard
1389 Not quite as common as its cousin.
1390 LaTeX seems to like to print lines that are a bit too wide as opposed to
1391 ones that are a bit too narrow.
1392 We have no idea why.
1395 \begin_layout Standard
1396 You can ignore these, too.
1400 \begin_layout Itemize
1401 \begin_inset Quotes eld
1411 \begin_inset Quotes erd
1415 \begin_inset Quotes eld
1425 \begin_inset Quotes erd
1432 \begin_layout Standard
1433 Warnings about troubles breaking the page.
1434 Once again, just look at the output.
1435 Your eyes will tell you where something has gone wrong.
1439 \begin_layout Itemize
1440 \begin_inset Quotes eld
1446 \begin_inset Quotes els
1450 \begin_inset Quotes ers
1456 \begin_inset Quotes erd
1463 \begin_layout Standard
1465 \begin_inset Quotes eld
1469 \begin_inset Quotes erd
1472 isn't installed on this system.
1473 This usually appears because some package your document needs isn't installed.
1474 If you didn't touch the preamble or didn't use the
1480 command, then one of the packages LyX tried to load is missing.
1486 elp\SpecialChar \menuseparator
1493 to get a list of packages that LyX knows about.
1494 This file is updated whenever you reconfigure LyX (using
1501 \SpecialChar \menuseparator
1506 ) and tells you which packages have been detected and what they do.
1509 \begin_layout Standard
1520 command and the package in question isn't installed, then you'll need to
1521 install it yourself.
1525 \begin_layout Itemize
1526 \begin_inset Quotes eld
1531 LaTeX Error: Unknown option
1534 \begin_inset Quotes erd
1541 \begin_layout Standard
1542 Error messages beginning with this are trying to tell you that you specified
1543 a bad or undefined option to a package.
1544 Check the package's documentation.
1548 \begin_layout Itemize
1549 \begin_inset Quotes eld
1554 Undefined control sequence
1557 \begin_inset Quotes erd
1564 \begin_layout Standard
1565 If you've inserted LaTeX code into your document, but made a typo, you'll
1567 You may have forgotten to load a package.
1568 In any case, this error message usually means that you used an undefined
1574 \begin_layout Standard
1575 There are other error and warning messages.
1576 Some are self-explanatory.
1577 These are usually LaTeX messages.
1578 Others are downright cryptic.
1579 These are actually TeX error messages, and we really have
1583 what they mean or how to decipher them.
1586 \begin_layout Standard
1587 There's a general sequence you should follow if you get error messages:
1590 \begin_layout Enumerate
1591 Look at the LaTeX code you inserted for typos.
1594 \begin_layout Enumerate
1595 If there are no typos, check that you used the command(s) correctly.
1598 \begin_layout Enumerate
1599 If you get a bunch of error boxes piled up at the very top of the document,
1600 it means that there are errors in the preamble.
1601 Start debugging your preamble.
1604 \begin_layout Enumerate
1605 If you didn't add anything to the preamble and didn't add any LaTeX code
1606 to the document, the first suspect is your LaTeX distribution itself.
1607 Check for missing packages and install them.
1610 \begin_layout Enumerate
1611 Okay, so there are no missing packages.
1612 Did you use any of the fine-tuning options in LyX? Specifically, did you
1617 any of them, like trying to manually insert lots of
1620 \begin_inset space ~
1633 s? Did you try to kludge something together with these instead of using
1634 the appropriate paragraph environment?
1637 \begin_layout Enumerate
1638 All right, you didn't use any of the fine-tuning options, you played by
1640 Did you try to pull a fancy maneuver? Did you do something funky inside
1641 a table or an equation, like inserting a graphic into a table cell?
1644 \begin_layout Enumerate
1645 Do you have long sections of text where LaTeX cannot find a place to break
1646 a line? By default, LaTeX is rather strict about how much extra inter-word
1647 spacing it will add in order to break a line.
1648 Preferably, you should rework the paragraph to avoid the problem.
1649 If this isn't an option, you can wrap your text in
1655 to make LaTeX's line breaking more, well, sloppy.
1658 \begin_layout Enumerate
1659 Did you go overboard with the nesting? LyX (currently) doesn't check to
1660 make sure you're in the limits for nesting environments.
1661 If you nested a bunch of environments to the
1662 \begin_inset Formula $17^{\mathrm{th}}$
1665 level, that's the problem.
1668 \begin_layout Enumerate
1669 Okay, you didn't get any error messages, but your output looks whacked.
1670 If you have a table or figure that's too wide or long for the page, you
1675 \begin_layout Enumerate
1676 rescale the figure so it fits.
1679 \begin_layout Enumerate
1680 trim down the table so it fits.
1683 \begin_layout Standard
1684 If something else is wrong with the output, and you didn't try to pull anything
1685 fancy or kludge the fine-tuning options, we're not sure what's wrong.
1689 \begin_layout Standard
1690 If all this doesn't help --- well, then
1694 you might have found a bug in LyX\SpecialChar \ldots{}
1698 \begin_layout Chapter
1702 \begin_layout Section
1703 Customizing Bibliographies with BibTeX
1706 \begin_layout Standard
1707 The basics how to use BibTeX are explained in section
1709 Bibliography databases (BibTeX)
1716 The following subsections explain special bibliography features supported
1720 \begin_layout Subsection
1721 Alternative Citation Styles
1724 \begin_layout Standard
1725 Standard BibTeX uses numbers (e.g.,
1726 \begin_inset Quotes eld
1730 \begin_inset Quotes erd
1733 ) to refer to a cited work.
1734 However, in many scientific disciplines, other citation styles are in use.
1735 The most common one is the author-year style (e.g.,
1736 \begin_inset Quotes eld
1740 \begin_inset Quotes erd
1744 LyX supports two packages that provide this style,
1753 Both packages have their own pros and cons, which cannot be listed in detail.
1754 If you only want to have simple author-year (or author-numerical) style
1755 or if you want to use one of the countless style files for natbib, than
1760 package is probably your choice.
1761 If you need special features like short title references, ibidem etc., you
1762 might consider the fairly new
1769 \begin_layout Standard
1770 The handling of both packages in LyX is basically the same.
1773 Document\SpecialChar \menuseparator
1789 With both packages, you will get some extra features in the citation dialog
1790 and you can select the style of the reference (
1791 \begin_inset Quotes eld
1795 \begin_inset Quotes erd
1799 \begin_inset Quotes eld
1803 \begin_inset Quotes erd
1807 \begin_inset Quotes eld
1811 \begin_inset Quotes erd
1815 \begin_inset Quotes eld
1819 \begin_inset Quotes erd
1823 Note that both packages need specifically designed style files (they both
1824 ship their own, while there are lots of additional style files and even
1825 an interactive style file builder
1829 \begin_layout Plain Layout
1831 \begin_inset Flex URL
1834 \begin_layout Plain Layout
1836 ftp://ctan.tug.org/tex-archive/macros/latex/contrib/custom-bib/
1853 \begin_layout Subsection
1854 Sectioned Bibliographies
1857 \begin_layout Standard
1858 Sometimes you might need to divide your bibliography into several sections.
1859 If you are for instance a historian, the possibility to separate sources
1860 and scientific works is most likely a
1861 \begin_inset Quotes eld
1865 \begin_inset Quotes erd
1869 Unfortunately, BibTeX itself does not allow you to do this.
1870 But with the help of some LaTeX packages, BibTeX can be extended to fit
1874 \begin_layout Standard
1875 LyX provides native support for one of these packages,
1883 \begin_layout Plain Layout
1885 \begin_inset Flex URL
1888 \begin_layout Plain Layout
1890 ftp://ctan.tug.org/tex-archive/macros/latex/contrib/bibtopic/
1900 The advantage of this package (compared to other packages like
1904 ) is that you don't need to define new citation commands.
1905 Instead, you need to prepare different bibliographic databases which include
1906 the entries for the different sections of the bibliography.
1907 For example: If you want to divide your bibliography into the sections
1909 \begin_inset Quotes eld
1913 \begin_inset Quotes erd
1917 \begin_inset Quotes eld
1921 \begin_inset Quotes erd
1924 , you first need to create two bibliographic databases, e.
1925 \begin_inset space \thinspace{}
1929 \begin_inset space \space{}
1944 \begin_layout Standard
1947 Document\SpecialChar \menuseparator
1957 \begin_inset space ~
1963 Now you can insert multiple BibTeX bibliographies, one for each section
1964 of your bibliography.
1965 Returning to our example: Insert the BibTeX bibliography
1969 and a second one for the database
1974 You are free to use the same or different styles for each section.
1975 Additionally, you can chose if the bibliography section should contain
1977 \begin_inset Quotes eld
1980 all cited references
1981 \begin_inset Quotes erd
1984 of the specified database(s) (which is the default),
1985 \begin_inset Quotes eld
1988 all uncited references
1989 \begin_inset Quotes erd
1993 \begin_inset Quotes eld
1997 \begin_inset Quotes erd
2001 This might be useful if you would like to separate your bibliography into
2003 \begin_inset Quotes eld
2007 \begin_inset Quotes erd
2011 \begin_inset Quotes eld
2015 \begin_inset Quotes erd
2019 \begin_inset Quotes eld
2023 \begin_inset Quotes erd
2027 The titles for the sections can be added as ordinary sections or subsections.
2032 removes the bibliography title, you have manually re-add that, too (as
2033 a chapter* or section*, for instance).
2036 \begin_layout Subsection
2037 Multiple Bibliographies
2040 \begin_layout Standard
2041 Multiple bibliographies, e.
2042 \begin_inset space \thinspace{}
2046 \begin_inset space \space{}
2049 a bibliography for each section or chapter of the document, are not supported
2055 package, which is used for the creation of sectioned bibliographies in
2056 LyX (see the previous section), provides an easy way to solve this task,
2057 if you are willing to use some TeX Code (see section
2058 \begin_inset space ~
2062 \begin_inset CommandInset ref
2064 reference "sec:Inserting-TeX-Code"
2072 \begin_layout Plain Layout
2073 An alternative approach is to use the
2081 package, respectively.
2089 \begin_layout Standard
2092 Document\SpecialChar \menuseparator
2102 \begin_inset space ~
2108 In the document, you have to enclose the sections, which shall contain
2109 their own bibliography (including the BibTeX bibliography itself), between
2122 (those commands have to be inserted as ERT).
2123 The bibliography will contain all references which have been cited in the
2129 If you are using this approach, then
2133 citation reference has to be inside some btUnit.
2134 Also, the btUnits cannot be nested.
2137 \begin_layout Standard
2141 \begin_layout Section
2145 \begin_layout Subsection
2149 \begin_layout Standard
2150 When you are working on a large file with many sections, it is often convenient
2151 to break up the document into several files, or perhaps you have something
2152 where a table may change from time to time, but the preceding text does
2154 In these cases, you should seriously consider using multipart documents.
2155 For example, scientific papers often have five major sections: the introduction
2156 , observations, results, discussion, and conclusion.
2157 Each of these could be its own separate LyX file, with one
2158 \begin_inset Quotes eld
2162 \begin_inset Quotes erd
2165 file which contains the title, authors, abstract, references, etc., plus
2166 the five included files.
2167 It is important to note that each of these files is a full LyX file which
2168 can be formatted and printed on its own, as well as included in a master
2170 Each of these files must have the same document class, however--- don't
2171 attempt to mix book classes with article classes.
2172 You may also include LaTeX files; however, these files must not have their
2178 everything up to and including the
2190 line must be deleted) or else errors will be generated when you try to
2194 \begin_layout Standard
2195 LyX allows you to include files quite easily with
2197 Insert\SpecialChar \menuseparator
2199 \begin_inset space ~
2205 When you click on this selection a small box is inserted into the file
2206 at the current cursor location.
2207 Clicking on the box raises a dialog which allows you to select the file
2208 to be included, and the method of its inclusion.
2212 \begin_layout Standard
2213 The file selection box should by now be obvious.
2214 The three inclusion methods are
2215 \begin_inset Quotes eld
2219 \begin_inset Quotes erd
2223 \begin_inset Quotes eld
2227 \begin_inset Quotes erd
2231 \begin_inset Quotes eld
2235 \begin_inset Quotes erd
2239 The difference between
2240 \begin_inset Quotes eld
2244 \begin_inset Quotes erd
2248 \begin_inset Quotes eld
2252 \begin_inset Quotes erd
2255 is really only meaningful to LaTeXperts, but the practical difference is
2256 that files which are
2257 \begin_inset Quotes eld
2261 \begin_inset Quotes erd
2264 are typeset beginning on a new page, while files which are
2265 \begin_inset Quotes eld
2269 \begin_inset Quotes erd
2272 are typeset starting on the current page.
2273 Perhaps the labeling in LyX will be changed someday to reflect this.
2276 \begin_layout Standard
2277 Generally, the master file is converted into a full LaTeX file before typesettin
2278 g, while the included files are converted to LaTeX files which do not have
2279 all the preamble information.
2285 \begin_inset space ~
2292 button prevents this conversion.
2295 \begin_layout Standard
2297 \begin_inset Quotes eld
2301 \begin_inset Quotes erd
2304 included file allows you to include a file typeset exactly as it appears
2306 \begin_inset space ~
2309 verbatim mode, with the characters set in a fixed-width typewriter font.
2310 Normally, spaces in this file are invisible, though two consecutive spaces
2311 are conserved, unlike LyX's normal treatment of spaces.
2312 However, setting the
2315 \begin_inset space ~
2319 \begin_inset space ~
2323 \begin_inset space ~
2328 checkbox typesets a mark to unambiguously define the presence of a space.
2332 \begin_layout Subsection
2333 Cross-References Between Files
2336 \begin_layout Standard
2337 It is possible to set up cross-references between the different files.
2338 First, open all the files in question: let's call them A and B in a two
2339 file example, where B is included in A.
2340 Let's say you insert a label in A, then want to reference it in B.
2341 Open the cross-reference dialog in whilst in document B, and you can select
2343 \begin_inset Quotes eld
2347 \begin_inset Quotes erd
2353 \begin_layout Subsection
2354 Bibliography Lists in all Subdocuments
2357 \begin_layout Standard
2358 Copy the bibliography list with all entries to all subdocuments and transform
2360 This way LyX will find the
2364 -files and you can easily insert references without making the bibliography
2368 \begin_layout Standard
2369 As the bibliography list is in a comment, LaTeX won't use use it and the
2370 references will look like this [?] instead of [1].
2371 A solution is to use the LaTeX-package
2375 that will only include comments by processing the files separately.
2376 To do this, add in the LaTeX preamble of every subdocument the following:
2379 \begin_layout LyX-Code
2385 \begin_layout LyX-Code
2388 includecomment{comment}
2391 \begin_layout Standard
2393 \begin_inset Flex URL
2396 \begin_layout Plain Layout
2398 http://wiki.lyx.org/FAQ/Unsorted#toc31
2406 \begin_layout Section
2407 Fancy Headers and Footers
2410 \begin_layout Standard
2411 The default page layout is rather plain; for an article document class,
2412 all you get is a centered page number at the bottom of the page.
2413 This document is the book class, so it appears to be a bit fancier, but
2414 to really put on a show, you need to set the document page style to
2415 \begin_inset Quotes eld
2419 \begin_inset Quotes erd
2422 , as mentioned in the
2425 \begin_inset space ~
2431 This section describes the LaTeX codes you need to insert in your LaTeX
2432 preamble or the text in order to get the desired effects.
2435 \begin_layout Standard
2436 The page header is divided into three fields, not surprisingly labeled
2437 \begin_inset Quotes eld
2441 \begin_inset Quotes erd
2445 \begin_inset Quotes eld
2449 \begin_inset Quotes erd
2453 \begin_inset Quotes eld
2457 \begin_inset Quotes erd
2461 The footer is also divided into these three fields.
2462 The LaTeX commands to set these fields in the simplest manner are
2487 Suppose you wish to put your name in the upper left hand corner of each
2489 Simply insert the following command in the preamble:
2492 \begin_layout Standard
2501 \begin_layout Standard
2502 You will now see your name in the upper left.
2503 If a field has a default entry that you would like to get rid of (often
2504 the page number appears in the central footer, simply include a command
2505 with a blank argument, e.
2506 \begin_inset space \thinspace{}
2512 \begin_layout Standard
2520 \begin_layout Standard
2521 Let's get really fancy: lets put the section number with the word
2522 \begin_inset Quotes eld
2526 \begin_inset Quotes erd
2530 \begin_inset space \thinspace{}
2534 \begin_inset space ~
2537 Section 3) in the upper left, the page number (e.
2538 \begin_inset space \thinspace{}
2542 \begin_inset space ~
2545 Page 4) in the upper right, your name in the lower left, and the date in
2547 The following commands should now appear in the preamble:
2550 \begin_layout Standard
2560 \begin_layout Standard
2568 \begin_layout Standard
2578 \begin_layout Standard
2587 \begin_layout Standard
2595 \begin_layout Standard
2605 \begin_layout Standard
2618 access LaTeX's section and page counters, and so print out the current
2619 section and page numbers.
2626 simply prints out today's date.
2629 \begin_layout Standard
2630 The thicknesses of the horizontal rules drawn beneath the header and above
2631 the footer can also be modified.
2632 If you don't want one of the headers, set its thickness to 0.
2633 The header rule has a default thickness of 0.4pt, the footer rule is 0pt.
2634 Use the commands, e.
2635 \begin_inset space \thinspace{}
2645 headrulewidth}{0.4pt}
2653 footrulewidth}{0.4pt}
2655 to set the thicknesses.
2658 \begin_layout Standard
2659 You can switch the header/footer settings on and off for individual pages
2664 thispagestyle{empty}
2670 thispagestyle{plain}
2676 thispagestyle{fancy}
2679 Simply insert them in the text on the page you want changed and mark them
2681 In fact, title pages are marked as plain by default, while following pages
2682 are marked fancy when using the global fancy setting.
2685 \begin_layout Standard
2686 There are more complex commands which will let you insert things in the
2687 upper left on odd numbered pages, etc., but I will refer you to the
2691 package documentation for more descriptions.
2692 For example, if you have a teTeX installation, look for
2694 /usr/share/texmf/doc/latex/fancyhdr/\SpecialChar \-
2700 \begin_layout Standard
2701 As a final example, it is possible to include an Encapsulated PostScript
2702 file in the header or footer.
2703 Suppose you want to put a company logo in the upper lefthand corner.
2704 You might try something like
2707 \begin_layout Standard
2716 includegraphics{logo.eps}}}
2719 \begin_layout Standard
2721 (you may need to preface this with
2725 usepackage{graphics}
2727 if you don't include EPS files elsewhere in your document).
2730 \begin_layout Section
2731 Itemize Bullet Selection
2732 \begin_inset CommandInset label
2741 \begin_layout Standard
2747 \begin_layout Subsection
2751 \begin_layout Standard
2752 LyX provides 216 bullet shapes that can be accessed from a simple dialog.
2753 Using this dialog you can easily specify what bullet shape to use at each
2754 level of an itemized list.
2755 These settings are document-wide so you won't be able to specify different
2756 sets of bullets for different paragraphs
2760 \begin_layout Plain Layout
2761 Well, actually you can but you'll have to do it by hand.
2769 \begin_layout Subsection
2773 \begin_layout Standard
2774 Open the dialog by selecting the
2779 ocument\SpecialChar \menuseparator
2786 menu item and then select the
2796 \begin_layout Standard
2797 The dialog provides you with a table of bullet shapes.
2798 A column of buttons on the left of the table provides access to the six
2799 different panels of bullet shapes.
2800 The row of buttons across the top is used to select which bullet depth
2802 A text entry under the table shows the currently selected bullet shape's
2803 LaTeX equivalent and this can be edited if desired.
2804 If you do modify the text you will also need to specify any needed packages
2805 in the LaTeX preamble.
2808 \begin_layout Standard
2809 The six panels are divided up by the packages they require.
2810 The following table shows the mappings from button name to LaTeX packages.
2813 \begin_layout Standard
2815 \begin_inset Tabular
2816 <lyxtabular version="3" rows="7" columns="2">
2818 <column alignment="center" valignment="top" width="0pt">
2819 <column alignment="center" valignment="top" width="0pt">
2821 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
2824 \begin_layout Plain Layout
2839 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" rightline="true" usebox="none">
2842 \begin_layout Plain Layout
2859 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
2862 \begin_layout Plain Layout
2877 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
2880 \begin_layout Plain Layout
2896 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
2899 \begin_layout Plain Layout
2914 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
2917 \begin_layout Plain Layout
2934 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
2937 \begin_layout Plain Layout
2952 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
2955 \begin_layout Plain Layout
2972 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
2975 \begin_layout Plain Layout
2990 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
2993 \begin_layout Plain Layout
3010 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
3013 \begin_layout Plain Layout
3028 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
3031 \begin_layout Plain Layout
3048 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
3051 \begin_layout Plain Layout
3066 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" rightline="true" usebox="none">
3069 \begin_layout Plain Layout
3092 \begin_layout Standard
3093 LyX doesn't stop you using bullets from packages you don't have.
3094 If you get errors from LaTeX when you try to view or print the file then
3095 its likely you are missing a package.
3096 LyX doesn't restrict your use since you may be editing locally and exporting
3100 \begin_layout Subsection
3104 \begin_layout Standard
3105 Select which bullet depth you want to change then select the bullet shape
3107 Any changes will not be visible in LyX, but are visible when viewing the
3108 document using xdvi or ghostview.
3111 \begin_layout Standard
3112 You can reset a bullet shape to the default simply by clicking your right
3113 mouse button on the appropriate bullet depth button.
3116 \begin_layout Standard
3121 want to have multiple sets of paragraphs with different sets of bullets
3122 in each then you're going to have to get your hands dirty.
3123 The itemize bullet selection dialog can help though because it provides
3124 you with the LaTeX code for a wide range of bullet shapes.
3125 To make your own custom paragraphs you have the following options:
3128 \begin_layout Standard
3132 \begin_layout Plain Layout
3148 \begin_layout Standard
3152 \begin_layout Plain Layout
3174 \begin_layout Itemize
3175 Use the LaTeX command
3181 to specify a new bullet shape for a given depth.
3182 You'll also need to save the current bullet shape so you can restore it
3184 In this itemized list the following LaTeX code was used to change the bullet
3185 used for the first depth.
3186 \begin_inset Newline newline
3202 \begin_inset Newline newline
3218 \begin_inset Newline newline
3223 Note that the itemize depth is specified in Roman numerals as part of the
3233 \begin_layout Itemize
3237 \begin_layout Plain Layout
3250 Specify each individual entry by starting each item with the bullet shape
3251 enclosed in square brackets and set as TeX.
3252 For example, this item was started with
3265 \begin_layout Standard
3269 \begin_layout Plain Layout
3285 \begin_layout Standard
3286 You'll also need to revert the labelitem back to its previous setting for
3287 the global bullet shape settings to remain in effect.
3288 The way used here was:
3289 \begin_inset Newline newline
3303 \begin_layout Chapter
3304 Special Document Classes
3307 \begin_layout Section
3311 \begin_layout Standard
3314 David Johnson; updated by Richard Heck
3317 \begin_layout Standard
3318 \begin_inset VSpace bigskip
3324 \begin_layout Standard
3326 The AMS LaTeX layouts are set up to conform to suggested styles for mathematical
3327 papers to be submitted to American Mathematical Society publications.
3328 The layouts are not tailored to a specific journal, but easily can be.
3329 You should refer to the AMS documentation for specific instructions for
3330 each journal (usually it will entail only changing a single line in the
3332 That documentation is available on the Web at
3333 \begin_inset Flex URL
3336 \begin_layout Plain Layout
3344 \begin_inset Flex URL
3347 \begin_layout Plain Layout
3349 ftp://ftp.ams.org/pub/tex/amslatex/
3355 These layouts are appropriate, and useful, for any mathematical writing.
3359 \begin_layout Standard
3360 There are two basic AMS LaTeX layouts:
3363 \begin_layout Itemize
3364 amsart: The standard AMS article format.
3367 \begin_layout Itemize
3368 amsbook: the standard AMS book (really, monograph) format.
3372 \begin_layout Standard
3373 The layouts themselves contain only the minimum necessary to use the AMS
3375 They do not, in particular, contain any of the `theorem' environments used
3376 for setting theorems, lemmas, and the like.
3377 These are contained, instead, in the
3378 \begin_inset Flex CharStyle:Code
3381 \begin_layout Plain Layout
3387 module, which is loaded by default when when you select one of the AMS
3389 (It can also be used with other classes and can be removed, if you would
3390 rather use something else.) Less commonly used environments are in the
3391 \begin_inset Flex CharStyle:Code
3394 \begin_layout Plain Layout
3395 Theorems (AMS-Extended)
3400 module, which must be loaded manually.
3403 \begin_layout Standard
3404 By default, theorems and the like are numbered consecutively throughout
3405 the document, but this may be modified by loading the module
3406 \begin_inset Flex CharStyle:Code
3409 \begin_layout Plain Layout
3410 Theorems (Order by Section)
3415 or, if you are using
3416 \begin_inset Flex CharStyle:Code
3419 \begin_layout Plain Layout
3426 \begin_inset Flex CharStyle:Code
3429 \begin_layout Plain Layout
3430 Theorems (Order by Chapter)
3436 These will number the results as
3437 \begin_inset Formula $n.m$
3440 , where the first number refers to the section (or chapter) and the second
3441 refers to the total number of results so far in that section (or chapter).
3442 Many environments are also available unnumbered.
3443 These are indicated by an asterisk at the end.
3444 If you happen to want
3448 unnumbered results, the the module
3449 \begin_inset Flex CharStyle:Code
3452 \begin_layout Plain Layout
3458 provides that option.
3461 \begin_layout Standard
3462 Note that these modules do not
3466 to be used with the AMS classes.
3467 It is perfectly possible to use the
3468 \begin_inset Flex CharStyle:Code
3471 \begin_layout Plain Layout
3477 module, and the others mentioned, with other classes, such as
3478 \begin_inset Flex CharStyle:Code
3481 \begin_layout Plain Layout
3488 \begin_inset Flex CharStyle:Code
3491 \begin_layout Plain Layout
3498 \begin_inset Flex CharStyle:Code
3501 \begin_layout Plain Layout
3510 \begin_layout Subsection
3511 What these layouts provide
3514 \begin_layout Standard
3515 There is a long list of included environments provided by these layouts.
3516 In AMS-LaTeX, there is, in fact, an opportunity to define an unlimited
3517 variety of `theorem' environments.
3518 However, the AMS recommends the environments that are available in LyX.
3522 \begin_layout Standard
3523 The following environments---as well as the standard environments, such
3525 \begin_inset Flex CharStyle:Noun
3528 \begin_layout Plain Layout
3535 \begin_inset Flex CharStyle:Noun
3538 \begin_layout Plain Layout
3545 \begin_inset Flex CharStyle:Noun
3548 \begin_layout Plain Layout
3555 \begin_inset Flex CharStyle:Noun
3558 \begin_layout Plain Layout
3565 \begin_inset Flex CharStyle:Noun
3568 \begin_layout Plain Layout
3575 \begin_inset Flex CharStyle:Code
3578 \begin_layout Plain Layout
3585 \begin_inset Flex CharStyle:Code
3588 \begin_layout Plain Layout
3597 \begin_layout Description
3598 Address This should be the author's permanent address.
3601 \begin_layout Description
3603 \begin_inset space ~
3606 Address This should be the author's temporary address at the time of submission,
3607 if different from the Address.
3610 \begin_layout Description
3611 Email Author's e-mail address
3614 \begin_layout Description
3615 URL Author's Web address, if desired.
3618 \begin_layout Description
3619 Keywords Key words or phrases used to identify specific topics discussed
3623 \begin_layout Description
3624 Subjectclass These refer to the AMS Subject Classifications, published and
3627 Mathematical Reviews
3630 These are also available online at the AMS cites listed above.
3633 \begin_layout Description
3637 \begin_layout Description
3641 \begin_layout Description
3645 \begin_layout Standard
3646 The following environments are provided by both the
3647 \begin_inset Flex CharStyle:Code
3650 \begin_layout Plain Layout
3657 \begin_inset Flex CharStyle:Code
3660 \begin_layout Plain Layout
3666 modules, in the latter case in both starred (unnumbered) and unstarred
3667 (numbered) versions.
3668 These same environments are provided only in the starred versions by the
3670 \begin_inset Flex CharStyle:Code
3673 \begin_layout Plain Layout
3682 \begin_layout Theorem
3683 This is typically used for the statements of major results.
3687 \begin_layout Corollary*
3688 This is used for statements which follow fairly directly from previous statement
3690 Again, these can be major results.
3695 These are smaller results needed to prove other statements.
3698 \begin_layout Proposition
3699 These are less major results which (hopefully) add to the general theory
3703 \begin_layout Conjecture
3704 These are statements provided without justification, which the author does
3705 not know how to prove, but which seem to be true (to the author, at least).
3708 \begin_layout Definition*
3709 Guess what this is for.
3710 The font is different for this environment than for the previous ones.
3714 \begin_layout Example*
3715 Used for examples illustrating proven results.
3718 \begin_layout Problem
3719 It's not really known what this is for.
3720 You should figure it out.
3723 \begin_layout Exercise*
3724 Write a description for this one.
3727 \begin_layout Remark
3728 This environment is also a type of theorem, usually a lesser sort of observation.
3731 \begin_layout Claim*
3732 Often used in the course of giving a proof of a larger result.
3736 Generally, these are used to break up long arguments, using specific instances
3742 The numbering scheme for cases is on its own, not together with other numbered
3748 At the end of this environment , a QED symbol (usually a square, but it
3749 can vary with different styles) is placed.
3750 If you want to have other environments within this one---for example, Case
3751 environments---and have the QED symbol appear only after them, then the
3752 other environments need to be nested within the proof environment.
3755 Nesting Environments
3761 for information on nesting.
3764 \begin_layout Standard
3765 And these are provided by
3766 \begin_inset Flex CharStyle:Code
3769 \begin_layout Plain Layout
3770 Theorems (AMS-Extended)
3778 \begin_layout Criterion*
3779 A required condition.
3782 \begin_layout Algorithm*
3783 A general procedure to be used.
3786 \begin_layout Axiom*
3787 This is a property or statement taken as true within the system being discussed.
3790 \begin_layout Condition*
3791 Sometimes used to state a condition assumed within the present context of
3796 Similar to a Remark.
3799 \begin_layout Notation*
3800 Used for the explanation of, yes, notation.
3803 \begin_layout Summary
3804 Do we really need to tell you?
3807 \begin_layout Acknowledgement*
3811 \begin_layout Conclusion*
3812 Sometimes used at the end of a long train of argument.
3816 Used in a way similar to Proposition, though perhaps lower on the scale.
3819 \begin_layout Standard
3820 In addition, the AMS classes automatically provide the AMS LaTeX and AMS
3822 They need to be available on your system in order to use these environments.
3825 \begin_layout Section
3829 \begin_layout Standard
3834 can be used to type letters according to German conventions.
3835 A template file is included in
3837 .../lyx/share/templates
3839 for you to use as a starting point.
3842 \begin_layout Section
3846 \begin_layout Standard
3851 provides an alternative to the standard
3856 It provides similar functionality, but you might prefer this layout with
3857 sans serif sections, headings, and more.
3860 \begin_layout Section
3864 \begin_layout Standard
3870 \begin_layout Subsection
3874 \begin_layout Standard
3875 This section describes how LyX can be used to write articles for submission
3876 to the scientific journal
3878 Astronomy and Astrophysics
3880 (www.edpsciences.fr/aa/
3881 \begin_inset Flex URL
3884 \begin_layout Plain Layout
3886 http://www.edpsciences.fr/aa/
3891 ) using Version 5.01 of the document class
3896 This package can be downloaded from the ftp site
3899 \begin_layout Standard
3900 \begin_inset VSpace medskip
3906 \begin_layout Standard
3908 \begin_inset Flex URL
3911 \begin_layout Plain Layout
3913 ftp://ftp.edpsciences.org/pub/aa/readme.html
3921 \begin_layout Standard
3922 \begin_inset VSpace medskip
3928 \begin_layout Standard
3929 A manual comes together with that package, and this text is not meant to
3930 replace the original manual but merely a short guide how to realize the
3931 correct form of your paper.
3935 \begin_layout Standard
3936 Please note that the publisher of the journal was changed from Springer
3937 to EDP Sciences starting January 1, 2001.
3938 That change implicated also some slight changes of the style files, namely
3939 the removal of the thesaurus command.
3940 The LyX class aa supports the newest version of these style files, V 5.01.
3941 If you have an older version installed, please upgrade.
3942 For compatibility, the old (version 4) layout has been kept as
3947 Please refer to the comments in
3949 LyXDir/layouts/aapaper.layout
3954 \begin_layout Subsection
3958 \begin_layout Standard
3959 It is recommended you start from the example template distributed with LyX.
3960 If you are not using a template, note the following settings:
3963 \begin_layout Itemize
3973 ocument\SpecialChar \menuseparator
3980 dialog (OK, that one was obvious).
3983 \begin_layout Itemize
3984 Don't change the option
3987 \begin_inset space ~
3997 The whole layout is done by the macros, you shouldn't change anything.
4000 \begin_layout Subsection
4004 \begin_layout Standard
4005 First thing to enter is the header information.
4006 It consists of seven entries, of which some are optional.
4010 \begin_layout Itemize
4018 \begin_layout Itemize
4026 \begin_layout Itemize
4034 \begin_layout Itemize
4042 \begin_layout Itemize
4047 : [optional] if more than one author: whom to contact for offprint requests.
4050 \begin_layout Itemize
4055 : [optional] mail address for contacts.
4058 \begin_layout Itemize
4066 Received: <date>; Accepted <date>
4069 \begin_layout Standard
4070 There is no need to issue the
4076 command, this is done automatically by LyX when the header is finished.
4077 Although the order of the single header entries doesn't matter it is advised
4078 to keep the above sequence, just to get the best optics and meets the layout
4079 of the real document.
4082 \begin_layout Standard
4083 If you want to place footnotes in the header block, e.
4084 \begin_inset space \thinspace{}
4088 \begin_inset space ~
4091 to state your present address, just use the standard footnote via
4096 nsert\SpecialChar \menuseparator
4104 LyX will automagically use the term
4113 \begin_layout Standard
4114 In addition to these topics, the macros use three additional LaTeX commands
4115 that have no counterpart in LyX:
4118 \begin_layout Itemize
4125 to separate different names for more than one author and institute, respectivel
4129 \begin_layout Itemize
4136 to mark corresponding author/institute pairs.
4137 The institutes are numbered sequentially as they appear in the
4141 field, so you have to put a marker to each author.
4144 \begin_layout Itemize
4151 to supply an email address for fast contact.
4154 \begin_layout Standard
4155 In all cases, the appropriate command has to be entered in LyX and marked
4161 \begin_layout Subsection
4165 \begin_layout Standard
4166 The abstract should immediately follow the header block.
4167 With version 5 the abstract environment was changed to a command, and there
4168 is now a resctriction to only one paragraph.
4169 In addition, it should contain an entry with the keywords.
4170 This is not yet implemented for LyX, therefore you have to enter the LaTeX
4177 by hand and mark it as LaTeX code.
4178 Refer to the example paper.
4181 \begin_layout Subsection
4182 Supported environments
4185 \begin_layout Standard
4186 The A&A paper layout supports the following environments for structuring
4190 \begin_layout Itemize
4196 \begin_layout Itemize
4202 \begin_layout Itemize
4208 \begin_layout Itemize
4214 \begin_layout Itemize
4220 \begin_layout Itemize
4226 \begin_layout Itemize
4232 \begin_layout Itemize
4238 \begin_layout Itemize
4244 \begin_layout Itemize
4250 \begin_layout Itemize
4256 \begin_layout Itemize
4262 \begin_layout Subsection
4263 Commands not supported by LyX
4266 \begin_layout Standard
4267 Some commands are not yet supported by the
4272 Some have already been mentioned.
4273 For the sake of completeness, they are listed all together here:
4276 \begin_layout Itemize
4284 \begin_layout Itemize
4292 \begin_layout Itemize
4300 \begin_layout Itemize
4308 \begin_layout Itemize
4316 \begin_layout Itemize
4324 \begin_layout Itemize
4332 \begin_layout Itemize
4340 \begin_layout Standard
4341 If you want to use any of these commands, you have to enter them yourself.
4344 Do not forget to mark them as LaTeX code!
4347 \begin_layout Subsection
4348 Figure and Table Floats
4351 \begin_layout Standard
4352 LyX provides support for the necessary float environments
4354 figure, figure*, table
4360 , therefore we won't tell much about it here.
4364 \begin_inset space ~
4370 Just remember that tables should be left-aligned.
4371 For that, select the table and change the alignment in
4376 dit\SpecialChar \menuseparator
4382 \begin_inset space ~
4388 \begin_layout Standard
4389 There is only one special thing: the figures with caption besides the figure.
4390 To create such a figure, you have to do the following:
4393 \begin_layout Enumerate
4394 Create a wide figure float:
4399 nsert\SpecialChar \menuseparator
4404 t\SpecialChar \menuseparator
4407 , then right click in the figure and select
4413 \begin_inset space ~
4421 \begin_layout Enumerate
4422 Enter your caption text.
4425 \begin_layout Enumerate
4430 to move the cursor above the caption.
4433 \begin_layout Enumerate
4437 \begin_layout Enumerate
4438 Position the cursor behind the figure and insert a horizontal fill:
4443 nsert\SpecialChar \menuseparator
4449 \begin_inset space ~
4454 \SpecialChar \menuseparator
4458 \begin_inset space ~
4466 \begin_layout Enumerate
4467 Switch to LaTeX mode:
4470 \begin_inset space ~
4478 \begin_layout Enumerate
4488 Do not close the brace!
4491 \begin_layout Enumerate
4492 Position the cursor behind the caption text, switch to LaTeX mode and insert
4496 \begin_inset space ~
4508 \begin_layout Standard
4509 Also, refer to the figures in the example paper.
4512 \begin_layout Subsection
4516 \begin_layout Standard
4517 For submission, the paper has to be formated in a special double-spacing
4519 For this purpose, you have to give the option
4523 to the documentclass.
4524 This must be done using the extra class options field in the
4529 ocument\SpecialChar \menuseparator
4537 Just enter the string
4544 \begin_layout Subsection
4548 \begin_layout Standard
4553 directory contains an example paper written with LyX.
4554 It is the example paper from the original macro package, translated to
4556 Use it for inspiration, and compare the original LaTeX code with LyX way
4560 \begin_layout Section
4564 \begin_layout Standard
4570 \begin_layout Subsection
4574 \begin_layout Standard
4575 AASTeX is a set of macros produced by the American Astronomical Society
4576 to facilitate electronic manuscript submission to the three journals they
4577 publish: the Astrophysical Journal (including the Letters and Supplement),
4578 the Astronomical Journal, and the Publications of the Astronomical Society
4580 LyX has proven to be an excellent tool for generating these documents,
4581 especially given its equation, citation, and figure handling capabilities.
4582 LyX requires version 5.0 (or higher) of these macros; preferably 5.2, which
4583 is the version described here, or higher.
4584 Versions prior to 5.0 are intended for use with LaTeX2.09 and are fundamentally
4585 incompatible with LyX.
4586 The AASTeX package may be downloaded from the AASTeX Web site
4589 \begin_layout Standard
4590 \begin_inset VSpace medskip
4596 \begin_layout Standard
4598 \begin_inset Flex URL
4601 \begin_layout Plain Layout
4603 http://www.journals.uchicago.edu/AAS/AASTeX
4611 \begin_layout Standard
4612 \begin_inset VSpace medskip
4618 \begin_layout Standard
4619 A complete user guide is contained in that package and you should familiarize
4620 yourself with it thoroughly before embarking on writing a paper in LyX.
4621 LyX will not reduce the need to figure out all the AASTeX commands, it
4622 will only reduce the drudgery of typing everything in.
4623 It is your responsibility to ensure that the final exported LaTeX document
4624 conforms completely to the requirements of the journal to which you are
4625 submitting your paper.
4628 \begin_layout Subsection
4629 Starting a New Paper
4632 \begin_layout Standard
4633 I strongly suggest that you start with the AASTeX template file.
4639 ile\SpecialChar \menuseparator
4649 , enter the new file name, then choose the
4654 This will show the most common fields found in a manuscript.
4655 Simply overwrite the existing text (including the brackets,
4659 ) with the correct information.
4660 Many of the AASTeX commands and environments can be implemented directly
4661 in LyX, but some cannot: most noticeably
4673 , which should stick out like a sore thumb if you actually just opened the
4675 For commands such as these, the LaTeX code must be entered directly and
4677 Such commands are referred to as ERT, or Evil Red Text.
4678 I tried to minimize the amount of ERT needed in an AASTeX document, but
4679 there is still a bit more required than any of us would like.
4682 \begin_layout Subsection
4683 Finishing Your Paper
4686 \begin_layout Standard
4687 When the paper is finished to your satisfaction and previews/prints correctly,
4689 \begin_inset Quotes eld
4693 \begin_inset Quotes erd
4696 actions which need to be done before you submit it to the journals.
4700 \begin_layout Enumerate
4701 Export your paper as a LaTeX file (
4706 ile\SpecialChar \menuseparator
4711 xport\SpecialChar \menuseparator
4722 \begin_layout Enumerate
4727 file with your favorite text editor
4731 \begin_layout Enumerate
4732 remove the comment lines before the
4741 \begin_layout Enumerate
4746 usepackage...{fontenc}
4748 line if it appears (usually just after
4763 \begin_layout Enumerate
4764 remove everything between (and including) the
4776 commands, except for any commands you specifically put into the LaTeX preamble
4777 (which should appear immediately after the
4778 \begin_inset Quotes eld
4781 User specified LaTeX commands
4782 \begin_inset Quotes erd
4793 \begin_layout Enumerate
4794 Run the resulting file through LaTeX to make sure it still processes correctly.
4797 \begin_layout Enumerate
4798 Reread the journal requirements to make sure your filenames and formats
4802 \begin_layout Enumerate
4806 \begin_layout Subsection
4807 Comments On Specific Commands
4810 \begin_layout Standard
4811 I will not describe the detailed usage of the individual AASTeX commands:
4812 the AASTeX User Guide (
4816 ) gives a good description of each.
4817 Thus it's probably easiest for me to go down the list as found in the guide
4818 and offer comments where necessary.
4819 So let's begin \SpecialChar \ldots{}
4823 \begin_layout Subsubsection
4824 Things that work as expected
4827 \begin_layout Standard
4831 \begin_layout Plain Layout
4843 \begin_layout Standard
4844 Because they work as you might expect, I simply list them and the section
4945 begin{thebibliography}
4953 (2.13.2), all the cite commands and their variations (2.13.2), the generic
4954 graphicx figure commands (2.14.1),
4978 (2.15.4, amongst other places),
5005 \begin_layout Standard
5006 The following style options also work correctly:
5027 Simply put them in the
5033 Layout\SpecialChar \menuseparator
5039 \begin_layout Standard
5043 \begin_layout Plain Layout
5055 \begin_layout Subsubsection
5056 Things that work, but require more comment
5059 \begin_layout Standard
5060 The following items work, but require a little more discussion:
5063 \begin_layout Itemize
5064 These items are reserved for use by the journal editors, but you can put
5065 them into the LaTeX preamble if you feel compelled to do so:
5098 \begin_layout Itemize
5099 These items may be placed in the LaTeX preamble, and are included as blanks
5100 in the template file:
5121 \begin_layout Itemize
5128 (2.3) -- can only be used
5129 \begin_inset Quotes eld
5133 \begin_inset Quotes erd
5136 , not in the middle of a paragraph.
5137 Use ERT if you need to embed it.
5140 \begin_layout Itemize
5147 (2.3) -- will have extra {} after it.
5148 This should not cause an error.
5151 \begin_layout Itemize
5158 (2.6) -- can only be used
5159 \begin_inset Quotes eld
5163 \begin_inset Quotes erd
5166 , not in the middle of a paragraph.
5167 Use ERT if you need to embed it.
5170 \begin_layout Itemize
5177 (2.8) -- can't insert a cross-reference tag, you must type the tag name
5181 \begin_layout Itemize
5188 (2.8) -- same as for
5195 \begin_layout Itemize
5202 (2.9) -- will have extra {} after it.
5203 This should not cause an error.
5206 \begin_layout Itemize
5213 (2.11) -- will have extra {} after it.
5214 This should not cause an error.
5217 \begin_layout Itemize
5224 (2.14.2) -- you can insert an optional filename argument by placing the cursor
5225 at the beginning of the text and selecting
5227 Insert\SpecialChar \menuseparator
5232 \begin_inset Quotes eld
5236 \begin_inset Quotes erd
5239 inserts an optional argument of the type needed by
5246 Hopefully it will be renamed someday.
5249 \begin_layout Itemize
5262 for the catalog ID optional parameter
5265 \begin_layout Itemize
5278 for the catalog ID optional parameter
5281 \begin_layout Subsubsection
5282 Things not implemented, use ERT
5285 \begin_layout Standard
5289 \begin_layout Plain Layout
5301 \begin_layout Standard
5324 setcounter{equation}
5326 (2.12), Journal name abbreviations (2.13.4),
5362 (2.15.4, insert it as the first element in the lefthand cell after where
5364 Don't use any of LyX's rules in the table),
5376 (2.15.5), much of Misc (2.17, except
5427 \begin_layout Standard
5431 \begin_layout Plain Layout
5443 \begin_layout Subsubsection
5444 Things that cannot be implemented
5447 \begin_layout Standard
5448 \SpecialChar \ldots{}
5449 at least in any meaningful sort of way, so I suggest ignoring them.
5450 They are the references environment (2.13.3), and the deluxetable environment
5452 If you really, really need to use deluxetable, I suggest editing it in
5453 a separate file with a text editor, then using
5458 nsert\SpecialChar \menuseparator
5464 \begin_inset space ~
5469 to include it in your LyX document.
5474 file to see an example of this.
5477 \begin_layout Subsection
5478 FAQs, Tips, Tricks, and Other Ruminations
5481 \begin_layout Subsubsection
5482 Getting LyX and AASTeX to cooperate
5485 \begin_layout Standard
5486 It can be a bit tricky to get LyX to recognize a new layout and document
5488 When all else fails, do this:
5491 \begin_layout Enumerate
5492 Make certain that LaTeX can find AASTeX.
5493 Copy sample.tex (and perhaps table.tex) from the AASTeX distribution into
5494 a directory completely unrelated to LaTeX or AASTeX and run LaTeX on
5501 \begin_layout Enumerate
5513 \begin_layout Enumerate
5519 ools\SpecialChar \menuseparator
5526 in LyX, then restart LyX.
5529 \begin_layout Enumerate
5530 Open a regular new file, not from a template.
5531 Does AASTeX appear in the class list in
5536 ocument\SpecialChar \menuseparator
5546 \begin_layout Standard
5547 If you get a warning from an existing AASTeX document about not being able
5548 to find the AASTeX layout or a message about
5549 \begin_inset Quotes eld
5552 You should not mix title layouts with normal ones
5553 \begin_inset Quotes erd
5556 , things haven't been installed correctly.
5559 \begin_layout Subsubsection
5560 LaTeX error processing a table
5563 \begin_layout Standard
5564 LyX, by default, attempts to center the table caption/title.
5565 This seems to produce a bad interaction in AASTeX so you should click somewhere
5566 in the caption/title, then select
5571 dit\SpecialChar \menuseparator
5577 \begin_inset space ~
5594 This took care of it for me.
5597 \begin_layout Subsubsection
5601 \begin_layout Standard
5602 A couple of things: 1) I have noticed some funny spacing in the reference
5603 entries in the text.
5604 When you enter the bibliography item data, make sure their is
5608 space between the last author and the parenthesis setting off the year;
5612 \begin_inset space \thinspace{}
5616 \begin_inset space ~
5630 2) Entering the references at all is not obvious.
5631 The easiest thing is to start typing your first reference at the end of
5632 the document, then mark it as type
5637 That will put a small gray box in front of what you just typed.
5638 Click on the box to fill in the rest of the information.
5639 For new references, go to the end of an existing reference and press return.
5640 That will create a new line with its own box, etc.
5643 \begin_layout Subsubsection
5647 \begin_layout Standard
5648 Even though AASTeX provides its own figure commands (
5654 , for example), I much prefer LaTeX's standard figure commands (with the
5663 \begin_inset space ~
5666 commands as ERT into a Figure Float box if you desire, but I never have
5667 much luck getting the layout right.
5668 With the standard graphics, LyX will insert a
5672 usepackage{graphicx}
5674 command into the LaTeX preamble and handle the figures in the standard
5675 LaTeX2e way, interspersing the figures in the text.
5676 I believe ApJ accepts figures exactly this way now; AJ might still use
5678 \begin_inset Quotes eld
5681 stack everything at the end
5682 \begin_inset Quotes erd
5688 \begin_layout Subsubsection
5689 Things I could have done, but didn't
5692 \begin_layout Standard
5694 \begin_inset Quotes eld
5698 \begin_inset Quotes erd
5701 things I could have implemented, but chose not to.
5702 For instance, I saw no point in double-spacing the text in the LyX window,
5703 even though it is double-spaced in the paper manuscript.
5704 Also, I chose not to make separate layouts for the preprint and preprint2
5706 Since I assume you will spend most of your time in the plain manuscript
5707 mode anyway, I decided not to chew up more disk space with this.
5711 \begin_layout Subsection
5715 \begin_layout Standard
5716 Your mileage may vary.
5717 I've now had papers published by both ApJ and AJ that have had 98% of the
5718 effort done in LyX; the last 2% was the LaTeX post-processing and a few
5720 I have had no trouble with the submission process, and I'm sure the journals
5721 were never aware that there might be a difference.
5722 So, go forth and publish!
5725 \begin_layout Section
5729 \begin_layout Standard
5732 Panayotis Papasotiriou
5735 \begin_layout Subsection
5739 \begin_layout Standard
5740 The ijmpc package is a set of macros that facilitates electronic manuscript
5743 International Journal of Modern Physics C
5746 Similarly, the ijmpd package is for creating manuscripts to be submitted
5749 International Journal of Modern Physics D
5752 Both journals are published by World Scientific.
5753 The corresponding document classes are named
5762 These files, together with instructions for the authors, can be downloaded
5764 \begin_inset Flex URL
5767 \begin_layout Plain Layout
5769 http://www.worldscinet.com/ijmpc/mkt/guidelines.shtml
5775 \begin_inset Flex URL
5778 \begin_layout Plain Layout
5780 http://www.worldscinet.com/ijmpd/mkt/guidelines.shtml
5786 Both packages are modified versions of the standard
5787 \begin_inset Quotes eld
5791 \begin_inset Quotes erd
5794 package, and they are almost (but not exactly) identical.
5795 Most of their features are supported by LyX.
5796 I have used LyX successfully to write articles submitted to both journals
5797 without any problem.
5800 \begin_layout Subsection
5804 \begin_layout Standard
5805 As usual, the easiest way to write a paper is to start with a template.
5811 ile\SpecialChar \menuseparator
5830 This will give an (almost) empty document that includes the most common
5831 fields found in a manuscript.
5832 Simply overwrite the existing text (including the brackets,
5837 You should keep in mind the following remarks.
5840 \begin_layout Enumerate
5841 LyX won't let you change the font size and the page style of the document,
5842 because such modifications are not allowed by both packages.
5845 \begin_layout Enumerate
5846 The language of the document should not be changed.
5847 Before previewing your paper, be sure that the babel package is not used.
5848 To do this, click on
5853 ools\SpecialChar \menuseparator
5871 checkbox in the language settings, and click on
5882 , if you wish to make this change permanent).
5885 \begin_layout Enumerate
5887 \begin_inset Quotes eld
5891 \begin_inset Quotes erd
5894 style must be used to define keywords.
5897 \begin_layout Enumerate
5898 The ijmpc package provides a style named
5899 \begin_inset Quotes eld
5902 Classification Codes
5903 \begin_inset Quotes erd
5906 , which can be used to define classification codes, such as PACS numbers.
5907 Note that this facility is not supported by the ijmpd package.
5910 \begin_layout Enumerate
5911 Several new environments are available:
5912 \begin_inset Quotes eld
5916 \begin_inset Quotes erd
5920 \begin_inset Quotes eld
5924 \begin_inset Quotes erd
5928 \begin_inset Quotes eld
5932 \begin_inset Quotes erd
5936 \begin_inset Quotes eld
5940 \begin_inset Quotes erd
5944 \begin_inset Quotes eld
5948 \begin_inset Quotes erd
5952 \begin_inset Quotes eld
5956 \begin_inset Quotes erd
5960 \begin_inset Quotes eld
5964 \begin_inset Quotes erd
5968 \begin_inset Quotes eld
5972 \begin_inset Quotes erd
5976 \begin_inset Quotes eld
5980 \begin_inset Quotes erd
5984 \begin_inset Quotes eld
5988 \begin_inset Quotes erd
5992 \begin_inset Quotes eld
5996 \begin_inset Quotes erd
6000 \begin_inset Quotes eld
6004 \begin_inset Quotes erd
6008 \begin_inset Quotes eld
6012 \begin_inset Quotes erd
6016 \begin_inset Quotes eld
6020 \begin_inset Quotes erd
6024 Their use is more or less obvious.
6025 LyX supports all these environments; it will use the proper label, text
6026 style, and numbering scheme for each of them.
6029 \begin_layout Enumerate
6030 Both packages use basic citations; the natbib package should not be used.
6031 In LyX, citation references are shown as usual; in the output, citations
6032 are shown as superscripts.
6033 If you want to use a citation as normal text, you should use the
6038 \begin_inset space \thinspace{}
6042 \begin_inset Quotes eld
6046 \begin_inset space ~
6056 \begin_inset Quotes erd
6062 \begin_layout Enumerate
6064 \begin_inset Quotes eld
6068 \begin_inset Quotes erd
6071 section in both packages.
6072 To put acknowledgments, just use the
6073 \begin_inset Quotes eld
6077 \begin_inset Quotes erd
6083 \begin_layout Enumerate
6084 Appendices may be added to the paper,
6088 the Acknowledgments and
6093 LyX provides a special environment, called
6094 \begin_inset Quotes eld
6098 \begin_inset Quotes erd
6101 which marks the beginning of the appendices.
6102 This environment should be left blank; it just sends a LaTeX command, but
6103 nothing is really printed.
6105 \begin_inset Quotes eld
6109 \begin_inset Quotes erd
6112 is printed with blue letters, as a signal that all sections after that
6113 point are appendices.
6114 To write an appendix, use the
6115 \begin_inset Quotes eld
6119 \begin_inset Quotes erd
6123 LyX will number each appendix with capital letters, as required by both
6126 \begin_inset Quotes eld
6130 \begin_inset Quotes erd
6137 be present before the first appendix; if not, all appendices will be numbered
6138 as normal sections in the output.
6141 \begin_layout Enumerate
6142 The ijmpc and the ijmpd packages use the
6146 command to implement table captions.
6147 As a result, a table created by LyX is printed correctly, but its caption
6149 However, you can use some ERT to overpass this problem, so that captions
6150 are printed as expected.
6151 To do so, create a float table as usual, remove the caption, and replace
6162 (sic); you must also the ERT
6166 immediately after the tabular material.
6167 Study the example table included in the template files to see how this
6168 trick is implemented.
6169 Alternatively, If you need table captions, you should implement the whole
6174 file, then include this file to the LyX document (
6179 nsert\SpecialChar \menuseparator
6184 \SpecialChar \menuseparator
6190 \begin_inset space ~
6196 Details on how to create a table float can be found in the files
6204 , included in the corresponding packages.
6207 \begin_layout Subsection
6208 Preparing a paper for submission
6211 \begin_layout Standard
6212 Before you submit your paper you must export the LyX document as a LaTeX
6218 ile\SpecialChar \menuseparator
6223 xport\SpecialChar \menuseparator
6238 \begin_layout Plain Layout
6239 Actually you have the choice between LaTeX (plain) and pdflatex.
6240 If you intend to use pdflatex to prepare the paper, you should use the
6241 pdflatex option so that included graphics are converted to PDF format,
6242 ready for use by pdflatex.
6247 , then make the following changes to the resulting
6254 \begin_layout Enumerate
6255 Remove the comment lines before the
6264 \begin_layout Enumerate
6265 Remove everything between (and including) the
6277 commands, except for any commands you specifically put into the LaTeX preamble.
6280 \begin_layout Standard
6285 file should be saved and processed through LaTeX as many times as necessary.
6286 You may also want to check the resulting
6293 \begin_layout Subsection
6297 \begin_layout Standard
6298 The use of ERT is reduced to two commands, which must be placed at the top
6300 If you started writing your paper by using the
6308 template, the ERT needed is already in its place; you usually don't need
6310 You may only modify the first ERT to specify the information printed to
6311 the top of odd and even pages (authors' names and short paper's title,
6313 This ERT must have the form
6317 markboth{Authors' Names}{Short Paper's Title}
6322 \begin_layout Section
6326 \begin_layout Standard
6332 \begin_layout Subsection
6336 \begin_layout Standard
6337 The iopart package provides a document class to create electronic manuscript
6338 submission to the journals published by the Institute of Physics.
6339 Instructions for the authors how to create a paper using the iopart class
6340 can be downloaded together with the iopart package from the site
6341 \begin_inset Flex URL
6344 \begin_layout Plain Layout
6346 ftp://ftp.iop.org/pub/journals/latex2e
6354 \begin_layout Subsection
6358 \begin_layout Standard
6359 The easiest way to write a paper is to start with the file
6363 that is available in LyX's examples files folder.
6364 Open this file, save it under a new name, and start writing.
6365 The example file explains how to use the special text environments.
6366 Here are the most important advices:
6369 \begin_layout Itemize
6370 To be able to compile your document to a PDF, PS, or DVI, assure that the
6373 Use AMS math package
6375 in the document settings under
6382 \begin_layout Itemize
6385 The title environment defines the kind of your paper.
6386 So use one of the following environments for the title:
6390 \begin_layout Itemize
6399 \begin_layout Itemize
6408 \begin_layout Itemize
6414 for a Topical review
6417 \begin_layout Itemize
6426 \begin_layout Itemize
6435 \begin_layout Itemize
6441 for a Paper (same as Title)
6444 \begin_layout Itemize
6450 for a Preliminary communication
6453 \begin_layout Itemize
6459 for a Rapid communication
6462 \begin_layout Itemize
6468 for a Letter to the editor
6472 \begin_layout Itemize
6475 All title environments except of
6479 can have an optional short title.
6482 \begin_layout Itemize
6483 There is a general title environment
6487 which is not directly supported by the LyX.
6488 This can be used as ERT when your document doesn't fit into one of the
6492 \begin_layout Standard
6493 For more informations like hints for special table and formula formatting,
6494 look at the IOP author guidelines.
6497 \begin_layout Section
6501 \begin_layout Standard
6504 Panayotis Papasotiriou
6507 \begin_layout Subsection
6511 \begin_layout Standard
6512 The Kluwer package is a set of macros produced by Kluwer Academic Publishers
6513 that facilitates electronic manuscript submission to the journals they
6515 Most known of them (at least in my domain of interest) are
6517 Astrophysics and Space Science
6523 , but there are many others (see a complete list at
6524 \begin_inset Flex URL
6527 \begin_layout Plain Layout
6529 http://www.wkap.nl/jrnllist.htm/JRNLHOME
6535 The Kluwer package may be downloaded from the site
6536 \begin_inset Flex URL
6539 \begin_layout Plain Layout
6541 http://www.wkap.nl/kaphtml.htm/STYLEFILES
6547 A complete user guide is contained in that package (but it can also be
6548 downloaded separately).
6551 \begin_layout Standard
6552 LyX supports many features of the package but not everything.
6553 However, the ERT needed is reduced to some
6554 \begin_inset Quotes eld
6558 \begin_inset Quotes erd
6561 commands of the package (see
6562 \begin_inset space ~
6566 \begin_inset CommandInset ref
6568 reference "subsec:kluwer_peculiarities"
6573 I have recently used LyX to write an article submitted to the
6575 Astrophysics and Space Science
6577 without any problem.
6580 \begin_layout Subsection
6584 \begin_layout Standard
6585 The easiest way to write a paper is to start with the Kluwer template file.
6588 File\SpecialChar \menuseparator
6603 This will give an (almost) empty document that includes the most common
6604 fields found in a manuscript and a short description of their use.
6605 As in most templates, simply overwrite the existing text (including the
6610 ) with the correct information.
6613 \begin_layout Subsection
6614 Preparing a paper for submission
6617 \begin_layout Standard
6618 As in the AASTeX package, before you submit your paper to a journal you
6620 \begin_inset Quotes eld
6624 \begin_inset Quotes erd
6630 \begin_layout Enumerate
6631 Export your paper as a LaTeX file.
6632 To do this, click on
6637 ile\SpecialChar \menuseparator
6642 xport\SpecialChar \menuseparator
6653 \begin_layout Enumerate
6658 file with a text editor and make the following changes
6662 \begin_layout Enumerate
6663 remove the comment lines before the
6672 \begin_layout Enumerate
6673 remove everything between (and including) the
6685 commands, except for any commands you specifically put into the LaTeX preamble.
6688 \begin_layout Standard
6697 \begin_layout Enumerate
6702 file through LaTeX as many times as necessary (usually up to three).
6705 \begin_layout Enumerate
6711 \begin_inset space \thinspace{}
6718 , and check if everything is OK (it should, if you didn't make any mistake).
6721 \begin_layout Subsection
6722 \begin_inset Quotes eld
6726 \begin_inset Quotes erd
6729 of the Kluwer package
6730 \begin_inset CommandInset label
6732 name "subsec:kluwer_peculiarities"
6739 \begin_layout Standard
6740 The Kluwer package has the following
6741 \begin_inset Quotes eld
6745 \begin_inset Quotes erd
6751 \begin_layout Enumerate
6752 It is possible to write multiple articles in the same LaTeX file
6756 \begin_layout Plain Layout
6757 I can't imagine any good reason to do this.
6763 Each article must be included in the environment
6764 \begin_inset Quotes eld
6768 \begin_inset Quotes erd
6772 Unfortunately, this environment cannot be omitted, even if you write just
6774 Therefore, each article starts with the command
6780 and, obviously, ends with the command
6787 Although this can be implemented in LyX, I didn't included it, since it
6788 looks ugly and can confuse the novice user.
6789 Therefore, you need to enter them directly and mark them as LaTeX code
6791 \begin_inset Quotes eld
6795 \begin_inset Quotes erd
6801 \begin_layout Enumerate
6802 Information given at the beginning of the article (i.e., title, subtitle,
6803 author, institution, running title, running author, abstract and keywords)
6804 must be included in an environment called
6805 \begin_inset Quotes eld
6809 \begin_inset Quotes erd
6813 This is not implemented in LyX, so you must enter title, subtitle etc.
6814 \begin_inset space ~
6817 between two ERT lines (
6832 \begin_layout Enumerate
6833 According to the user manual, the label of each bibliography item must be
6857 \begin_layout Standard
6862 template takes care of all these
6863 \begin_inset Quotes eld
6867 \begin_inset Quotes erd
6871 If you start a new paper using this template you don't need to do anything
6876 \begin_layout Enumerate
6877 don't delete the ERT included in the template, and
6880 \begin_layout Enumerate
6881 copy the example bibliography item included in the template and modify it
6882 as necessary to enter new bibliography items.
6885 \begin_layout Section
6889 \begin_layout Standard
6895 \begin_layout Subsection
6899 \begin_layout Standard
6900 The LyX document classes
6902 article (koma-script)
6906 report (koma-script)
6924 correspond to the LaTeX document classes
6941 \begin_inset space ~
6944 of the Koma-Script family.
6945 They are replacements for the standard document classes
6961 , resp., and fit better to European typography conventions in a number of
6965 \begin_layout Itemize
6966 Standard character size is 11pt in
6968 article (koma-script)
6972 report (koma-script)
6980 letter (koma-script)
6985 \begin_layout Itemize
6986 Headings, labels of the description environment, and a number of elements
6989 letter (koma-script)
6991 document class are set in a bold sans serif font.
6995 \begin_layout Plain Layout
6996 There is a big difference between the bold sans serif old cm fonts and new
6997 ec fonts, especially in the appearance of headings.
6998 In comparison, the ec bold sans serif fonts look a bit thin.
6999 Here the LaTeX package
7007 helps to produce the
7008 \begin_inset Quotes eld
7012 \begin_inset Quotes erd
7015 appearance when using the ec fonts.
7020 The numbering of chapter headings is made in the same way as the numbering
7021 of section headings, that is without the extra line
7022 \begin_inset Quotes eld
7025 Chapter\SpecialChar \ldots{}
7027 \begin_inset Quotes erd
7031 In addition, the appearance of the headings can be modified by using a
7032 number of options (in LyX to be entered in the field
7039 \begin_inset space ~
7049 ayout\SpecialChar \menuseparator
7057 A detailed German description of these options can be found in the Koma-Script
7065 \begin_layout Itemize
7066 The main means in the Koma-Script document classes to design the type area
7075 (in LyX to be entered in the extra class options field in the dialog
7080 ocument\SpecialChar \menuseparator
7088 They make a clearer modification of page margins possible as do the options
7094 ocument\SpecialChar \menuseparator
7102 A detailed German description of these and other type area options can
7103 be found in the Koma-Script documentation
7110 \begin_layout Itemize
7111 The LaTeX document classes of the Koma-Script family define a number of
7112 additional commands.
7113 Those part of it which makes sense in LyX is implemented in corresponding
7117 \begin_layout Standard
7118 A detailed German description of the LaTeX document classes of the Koma-Script
7119 family can be found in the Koma-Script documentation
7127 \begin_layout Plain Layout
7128 There is an English translation
7132 , but it is not a complete one.
7137 The following sections describe only those aspects, which are relevant
7141 \begin_layout Subsection
7142 article (koma-script), report (koma-script), and book (koma-script)
7145 \begin_layout Standard
7146 The document classes
7148 article (koma-script)
7152 report (koma-script)
7162 are implemented in the layout files
7175 They contain all the paragraph types of the corresponding standard document
7188 , resp., partly modified, with the exception of the LyX specific
7192 -type, which is replaced by the new
7196 -type having the same functionality.
7201 -Type there is a number of new paragraph types added.
7208 letter (koma-script)
7213 \begin_layout Itemize
7222 : are equivalents to
7230 , resp., additionally inserting an entry in the table of contents.
7239 are not contained in
7241 article (koma-script)
7246 \begin_layout Itemize
7263 , resp., additionally clearing running heads.
7270 article (koma-script)
7276 \begin_layout Plain Layout
7289 report (koma-script)
7291 , but since this is identical to
7295 , is has not been implemented in LyX.
7303 \begin_layout Itemize
7308 : generates a heading directly above the following paragraph in the standard
7309 character size without affecting the structure of the document.
7312 \begin_layout Itemize
7321 are special captions which respect the different space settings needed
7322 for captions placed above or below an element (if you follow strict typographic
7323 rules, you might want to place table captions always above the table).
7324 You can also use the class option
7341 You need at least Koma-Script version 2.8q to use this.
7344 \begin_layout Itemize
7349 : can be used to set a bonmot, e.
7350 \begin_inset space \thinspace{}
7354 \begin_inset space ~
7357 at the beginning of a chapter.
7358 If you use the optional argument (
7363 nsert\SpecialChar \menuseparator
7365 \begin_inset space ~
7370 ), you can insert the dictum's author there.
7371 Dictum and author are separated by a line.
7372 You need at least Koma-Script version 2.8q to use this.
7379 article (koma-script)
7384 \begin_layout Standard
7385 The following types, together with the standard types
7397 , form the title area of the document.
7398 They must be entered ahead of the first
7399 \begin_inset Quotes eld
7403 \begin_inset Quotes erd
7410 \begin_layout Plain Layout
7411 The corresponding LaTeX commands must appear before the
7422 When such a type is used more than once, the latter usage overwrites the
7423 former one, that means, for every type only the latest usage is valid.
7424 The order of the different types however has, like
7436 , no effect on the appearance of the produced document.
7439 \begin_layout Itemize
7444 : produces a centered paragraph above the ordinary title (
7456 ) for the subject of the document.
7459 \begin_layout Itemize
7464 : produces a centered paragraph below the ordinary title (
7476 ) for the publishers' name.
7479 \begin_layout Itemize
7486 report (koma-script)
7492 produces a centered paragraph on its own page behind the title page, or
7495 article (koma-script)
7497 produces a centered paragraph below the ordinary title (
7516 \begin_layout Itemize
7521 : produces a left aligned paragraph above the ordinary title (
7537 ) for a document`s head.
7540 \begin_layout Itemize
7545 : produces in a double-sided print in
7547 report (koma-script)
7553 a left-aligned paragraph at the top of the title page`s back or has no
7554 effect in a single-sided print or in
7556 article (koma-script)
7561 \begin_layout Itemize
7566 : produces in a double-sided print in
7568 report (koma-script)
7574 a left-aligned paragraph at the bottom of the title page`s back or has
7575 no effect in a single-sided print or in
7577 article (koma-script)
7582 \begin_layout Itemize
7587 : produces a special
7588 \begin_inset Quotes eld
7592 \begin_inset Quotes erd
7595 page ahead of the actual document containing a paragraph without special
7599 \begin_layout Standard
7600 The layout files for the document classes
7602 article (koma-script)
7606 report (koma-script)
7617 This is thought of as a place to define your own types.
7622 in your personal layout directory and edit the file!
7625 \begin_layout Subsection
7626 letter (koma-script)
7629 \begin_layout Standard
7633 \begin_layout Plain Layout
7645 \begin_layout Standard
7649 letter (koma-script)
7651 is implemented in the layout file
7656 It contains all the paragraph types of the corresponding standard document
7661 , partly modified, with the exception of the LyX specific types
7673 type, which is replaced by the new
7678 In addition, it contains, in contrast to the standard document class, the
7696 Furthermore, there are a number of new letter specific types.
7699 \begin_layout Standard
7703 \begin_layout Plain Layout
7715 \begin_layout Standard
7716 The appearance of the letter produced by this document class can be controlled
7717 by a number of LaTeX commands, which you can put in the LaTeX preamble.
7721 \begin_layout Plain Layout
7722 For example, the standard appearance of the letter`s heading, consisting
7723 of name and address, is quite self-willed.
7725 \begin_inset Quotes eld
7729 \begin_inset Quotes erd
7732 heading is produced by the following LaTeX commands in the preamble:
7735 \begin_layout LyX-Code
7745 \begin_layout LyX-Code
7761 \begin_layout LyX-Code
7771 \begin_layout LyX-Code
7791 A detailed German description of such LaTeX commands can be found in the
7792 Koma-Script documentation
7797 With it, the letter's author can produce his personal letter layout.
7800 \begin_layout Standard
7809 define the beginning of the letter and must be used in every letter.
7810 To emphasize them in the LyX document class, they are marked with the letter
7820 \begin_inset space ~
7824 It is possible to write any number of letters in one file.
7829 type produces a new letter using the same addressee and a
7833 type produces a new addressee.
7850 are ordinary paragraph types and can also be used several times in one
7851 and the same letter.
7854 \begin_layout Itemize
7859 : produces a paragraph for the addressee and implicitly defines the beginning
7863 \begin_layout Itemize
7868 : produces a paragraph for the form of address and implicitly produces a
7872 \begin_layout Itemize
7877 : produces a paragraph for a close.
7880 \begin_layout Itemize
7885 : produces a paragraph for a postscript.
7888 \begin_layout Itemize
7893 : produces a paragraph for a distribution list.
7896 \begin_layout Itemize
7901 : produces a paragraph for enclosures.
7904 \begin_layout Standard
7945 are input types provided with a label to enter information, which will
7946 be processed by the document class.
7950 \begin_layout Plain Layout
7951 It could be seen as a matter of inconsequence, that the types
7959 described above are not such input types as well.
7960 Because of the special meaning of those types, however, I have implemented
7961 them as ordinary paragraph types with a one letter mark in the left margin.
7962 Moreover, it would affect my feeling of symmetry, if the
7970 type had such a serious different appearance.
7975 The types must be used ahead of the corresponding
7982 \begin_layout Standard
7983 An implementation of these types in a WYSIWYG fashion does not seem to make
7984 sense, because the real appearance of the produced letter does not only
7985 depend on the usage of the particular type, but also on other factors.
7986 For example, a signature entered in the
7990 type will in the standard behavior appear in the produced letter only,
7991 when in the same letter also a
7996 The entered value of the
8000 type will in the standard behavior not appear in the produced letter at
8002 The possibility to design the letter`s heading freely is already indicated
8003 in a footnote above.
8006 \begin_layout Standard
8007 The input types can also be used as empty paragraphs.
8009 \begin_inset space \thinspace{}
8013 \begin_inset space ~
8025 type is not used at all, in the standard behavior the value of the
8029 type is used as signature, whereas if an empty
8033 type is used, no signature value is defined.
8036 \begin_layout Standard
8037 By using the input types it is possible to write a letter template, containing
8038 filled input types with your personal dates (name, address, etc.) and empty
8039 input types for other dates you want to enter.
8042 \begin_layout Itemize
8047 : sender's name, in the standard behavior appears as a centered paragraph
8048 in small caps in the letter`s heading.
8051 \begin_layout Itemize
8056 : sender's signature, in the standard behavior appears below the
8065 type is used, the value of the
8069 type appears instead.
8072 \begin_layout Itemize
8077 : sender's address, in the standard behavior appears in a centered paragraph
8078 in the letter`s heading below the sender's name.
8081 \begin_layout Itemize
8086 : sender's telephone number, in the standard behavior only sets the LaTeX
8096 \begin_layout Itemize
8101 : place of the letter`s making.
8104 \begin_layout Itemize
8109 : date of the letter`s making.
8118 , in the standard behavior, produce the place and the date in a right-aligned
8119 line below the addressee's field.
8124 type is used, neither place nor date appear, independent of the value of
8134 type is used, the date of the letter `s production is used.
8137 \begin_layout Itemize
8142 : sender`s back address, in the standard behavior appears above the addressee's
8143 field in a small sans serif font.
8146 \begin_layout Itemize
8151 : special mail information, in the standard behavior appears underlined
8152 above the addressee's field below the back address.
8155 \begin_layout Itemize
8160 : additional information, in the standard behavior appears on right side
8161 below the addressee`s field.
8164 \begin_layout Itemize
8169 : the letter's title, in the standard behavior appears in a big, bold, sans
8170 serif font above the subject.
8173 \begin_layout Itemize
8178 : the letter's subject, in the standard behavior appears in a bold font
8186 \begin_layout Standard
8207 produce a business letter like line above the
8211 line containing the fields
8212 \begin_inset Quotes eld
8216 \begin_inset Quotes erd
8220 \begin_inset Quotes eld
8224 \begin_inset Quotes erd
8228 \begin_inset Quotes eld
8232 \begin_inset Quotes erd
8236 \begin_inset Quotes eld
8240 \begin_inset Quotes erd
8244 \begin_inset Quotes eld
8248 \begin_inset Quotes erd
8252 \begin_inset Quotes eld
8256 \begin_inset Quotes erd
8260 For the date field, the value of the
8266 \begin_inset Quotes eld
8269 business letter types
8270 \begin_inset Quotes erd
8273 is used, the value of the
8277 type however does not appear, but only the LaTeX variable
8284 The ordinary output of place and date in a right-aligned line below the
8285 addressee`s field is suppressed.
8286 The types are implemented as input types provided with a label and must
8287 be used ahead of the corresponding
8294 \begin_layout Itemize
8302 \begin_layout Itemize
8310 \begin_layout Itemize
8318 \begin_layout Itemize
8326 \begin_layout Itemize
8334 \begin_layout Subsection
8335 The new letter class: letter (koma-script v.2)
8338 \begin_layout Standard
8341 Jürgen Spitzmüller
8344 \begin_layout Standard
8345 \begin_inset VSpace medskip
8351 \begin_layout Standard
8353 Koma-Script version 2.8 has introduced a new letter class
8357 which supersedes the now unsupported
8362 It has --- on the LaTeX side --- a completely new interface and is not
8363 compatible with the old class.
8364 Therefore, LyX supports both, though it is recommended to use the new class.
8367 \begin_layout Standard
8368 This class covers the same functionality as
8370 letter (koma-script),
8377 (receiver's address, same as
8394 will start a new letter (i.
8395 \begin_inset space \thinspace{}
8399 \begin_inset space ~
8402 you can write several letters per document).
8403 New elements are sender's
8419 and the possibility to use a
8428 nsert\SpecialChar \menuseparator
8438 \begin_layout Standard
8439 The biggest improvement is, though, that the letter's layout is configurable
8440 at almost any needs.
8441 This can be done via the preamble or with a special style file (Letter
8442 Class Option, extension
8446 ), that will be read in as a class option.
8450 \begin_layout Plain Layout
8451 The KOMA package comes with some default
8456 There is, for instance, a
8460 file that follows german typesetting rules, or a
8464 that provides the default layout of the old
8469 The latter can be loaded with the class option
8478 ayout\SpecialChar \menuseparator
8483 ocument\SpecialChar \menuseparator
8495 template that is included in LyX for examples.
8496 A detailed description is to be found in the Koma-Script documentation
8504 \begin_layout Subsection
8508 \begin_layout Standard
8509 Visualizing the Koma-Script document classes in LyX, the LyX internals cause
8513 \begin_layout Itemize
8514 The chapter number of a
8518 type appears on a line of its own above the chapter heading instead of
8519 appearing in the same line ahead of it.
8520 The cause for that is the LyX internal behavior for the labeltype
8527 \begin_layout Itemize
8528 The headings of the types
8537 \begin_inset Quotes eld
8541 \begin_inset Quotes erd
8544 LaTeX table of contents, but not in the LyX table of contents (
8549 ocument\SpecialChar \menuseparator
8555 \begin_inset space ~
8559 \begin_inset space ~
8567 \begin_layout Itemize
8572 document class appear in a skip separation mode, not indented.
8573 This is the standard behavior, no special LaTeX commands are needed for
8580 ocument\SpecialChar \menuseparator
8587 dialog the corresponding radio button indicates
8603 value always has the effect that extra LaTeX commands are inserted in the
8604 document to produce the gap, which is not what is wanted in this case.
8607 \begin_layout Section
8615 \begin_layout Standard
8621 \begin_layout Subsection
8625 \begin_layout Standard
8626 These are the layout files for some of the journal formats used by Springer
8627 Verlag and listed on
8628 \begin_inset Flex URL
8631 \begin_layout Plain Layout
8633 http://www.springer.de/author/tex/help-journals.html
8638 , where you should also go to fetch the class files (yes, these are LaTeX2e
8640 It is a modular system: the things common to all journals are implemented
8645 , which journal-specific layout files (such as, e.
8646 \begin_inset space \thinspace{}
8653 for Journal of Geodesy) can include.
8656 \begin_layout Standard
8657 This means that implementing support for any other Springer journal on this
8658 list is as simple as writing your own
8666 file following the outline given in
8674 \begin_layout Standard
8675 It is reasonably well tested only for the Journal of Geodesy.
8684 come with the standard LyX distribution.
8685 Install the relevant class file (downloaded from Springer) in a proper
8686 directory, reconfigure LaTeX (in the teTeX case by running
8690 , as root if necessary --- doesn't LyX take care of this?), reconfigure
8691 LyX and it should work.
8694 \begin_layout Subsection
8698 \begin_layout Standard
8699 A large number of theorem-like styles ---
8705 \SpecialChar \ldots{}
8711 \begin_layout Standard
8714 Headnote, Dedication, Subtitle, Running_LaTeX_Title, Author_Running, Institute,
8715 Mail, Offprints, Keywords, Acknowledgements, Acknowledgement
8718 See the Springer class file documentation for details.
8721 \begin_layout Subsection
8725 \begin_layout Itemize
8737 \begin_layout Itemize
8740 Probability Theory and Related Fields
8746 --- Jean-Marc Lasgouttes
8749 \begin_layout Standard
8750 Add your own, it isn't so hard!
8753 \begin_layout Subsection
8757 \begin_layout Standard
8758 These files are partly based on the older
8762 , which was again based on a tinkered-with version of an old LaTeX 2.09 style
8768 layout, are now defunct.
8769 Jean-Marc Lasgouttes helped out big in making me find my way around the
8770 LyX layout file mechanism.
8773 \begin_layout Subsection
8777 \begin_layout Standard
8779 But probably less than in the old hacked-LaTeX
8786 \begin_layout Standard
8788 \begin_inset space \thinspace{}
8791 g.: does not display the number for theorem-like layouts, just #.
8794 \begin_layout Section
8802 \begin_layout Standard
8808 \begin_layout Subsection
8812 \begin_layout Standard
8813 These are the layout files for some of the journals of the American Geophysical
8815 It is assumed that you have both the AGU's own class files and AGUplus
8816 installed (everything to be found at
8817 \begin_inset Flex URL
8820 \begin_layout Plain Layout
8822 ftp://ftp.agu.org/journals/latex/journals
8830 \begin_layout Subsection
8834 \begin_layout Standard
8844 They are still called this in the LyX GUI, though their LaTeX equivalents
8845 in the AGU classes are
8856 \begin_layout Standard
8857 Newly defined styles are
8894 These are mostly manuscript attributes and defined in the AGU class documentati
8898 \begin_layout Standard
8899 I suspect this is still badly incomplete.
8902 \begin_layout Subsection
8906 \begin_layout Standard
8923 \begin_layout Subsection
8927 \begin_layout Itemize
8930 Journal of Geophysical Research
8939 \begin_layout Standard
8940 Add your own, it isn't so hard! Look at the
8951 \begin_layout Subsection
8952 Bugs and things to remember
8955 \begin_layout Standard
8956 In order to use the new layouts, you must remember to do the following for
8960 \begin_layout Enumerate
8966 This can be done in the
8968 layout\SpecialChar \menuseparator
8973 document\SpecialChar \menuseparator
8977 (AGU articles are always in English, right? So
8984 \begin_layout Enumerate
8994 (Yes, this is a bug.)
8997 \begin_layout Enumerate
8998 Make sure you use the
9002 bibliography style, by entering
9006 into the second field of the BibTeX inset.
9007 None of the standard styles will do.
9010 \begin_layout Section
9018 \begin_layout Standard
9024 \begin_layout Subsection
9028 \begin_layout Standard
9029 This is the layout file for the European Geophysical Society journals.
9034 can be downloaded from the web site of the EGS under
9035 \begin_inset Flex URL
9038 \begin_layout Plain Layout
9048 \begin_layout Subsection
9052 \begin_layout Standard
9055 Right_address, Latex_Title, Affil, Journal, msnumber, FirstAuthor, Received,
9063 The current layout file is unfortunately very unmodular and would benefit
9064 from using the various
9071 \begin_layout Section
9077 \begin_inset CommandInset label
9086 \begin_layout Standard
9094 \begin_layout Subsection
9098 \begin_layout Standard
9099 This section describes how to use LyX to make slides for overhead projectors.
9100 There are two document classes that can do this: the default slides class
9106 This section documents the former.
9109 \begin_layout Standard
9110 I'm going to say this again, nice and clear, so that there's no misunderstanding
9114 \begin_layout Standard
9115 \begin_inset VSpace bigskip
9121 \begin_layout Standard
9125 This section documents the class
9126 \begin_inset Quotes eld
9134 \begin_inset Quotes erd
9142 \begin_layout Standard
9143 \begin_inset VSpace bigskip
9149 \begin_layout Standard
9150 If you're looking for the documentation for
9151 \begin_inset Quotes eld
9159 \begin_inset Quotes erd
9163 \begin_inset space ~
9167 \begin_inset CommandInset ref
9169 reference "sec:foiltex"
9179 \begin_inset Quotes eld
9187 \begin_inset Quotes erd
9190 ] is actually somewhat better than the default
9198 \begin_layout Plain Layout
9199 \SpecialChar \ldots{}
9200 or so I've been told repeatedly by its advocates.
9201 Having never used it, I have no idea if this claim is true or not.
9206 which this section documents.
9209 \begin_layout Standard
9210 This class is the LaTeX2e improvement of the old
9215 Every LaTeX2e distribution includes this class [which I'll just refer to
9217 \begin_inset Quotes eld
9225 \begin_inset Quotes erd
9228 from now on], so you're bound to have it.
9229 As I noted earlier, there are other classes, such as
9233 , which also produce slides for overhead projectors and do a better job
9235 However, there are some things which
9239 can do which the others can't, such as generate overlays.
9240 Read on to learn more!
9243 \begin_layout Subsection
9245 \begin_inset CommandInset label
9247 name "sec:slidesetup"
9254 \begin_layout Standard
9255 Obviously, to use this document class, you need to select
9256 \begin_inset Quotes eld
9264 \begin_inset Quotes erd
9267 from the class list in the
9272 ocument\SpecialChar \menuseparator
9280 There are some other special things you should know about this class:
9283 \begin_layout Itemize
9284 Don't bother changing the options
9289 They're not supported by the
9296 \begin_layout Itemize
9303 \begin_inset space ~
9308 behaves a bit differently for this class.
9309 The possible choices and what they do are as follows:
9313 \begin_layout Description
9318 The final output contains page numbers in the lower right corner.
9321 \begin_layout Description
9330 , but also prints out any time markers you've put in.
9331 This is the default.
9334 \begin_layout Description
9339 The final output contains no page numbers, time markers, or alignment markers.
9343 \begin_layout Itemize
9348 class has an extra option:
9354 \begin_inset Quotes eld
9362 \begin_inset Quotes erd
9365 in the extra class options.
9369 \begin_layout Standard
9370 Using this options allows you to add time markers to
9376 \begin_inset space ~
9380 \begin_inset CommandInset ref
9382 reference "sec:slideNote"
9390 \begin_layout Standard
9391 You can also use the template file
9392 \begin_inset Quotes eld
9400 \begin_inset Quotes erd
9403 to automatically set up a document to use the
9412 ile\SpecialChar \menuseparator
9414 \begin_inset space ~
9418 \begin_inset space ~
9427 to open your new document].
9428 The template file also contains some examples of the special paragraph
9429 environments used by this class.
9430 I'll describe those next.
9433 \begin_layout Subsection
9434 Paragraph Environments
9437 \begin_layout Subsubsection
9438 Supported Environments
9441 \begin_layout Standard
9442 The first thing you'll notice when you start up a new
9446 document is the font size and type: it's the equivalent of the size
9447 \begin_inset Quotes eld
9455 \begin_inset Quotes erd
9461 \begin_inset space ~
9467 This is also what's used in the output.
9469 \begin_inset Quotes eld
9473 \begin_inset Quotes erd
9476 to remind you that this is a slide.
9477 Your final slides will use a larger font; ergo, you'll have less space.
9478 Of course, the larger default screen font isn't WYSIWYG, only a reminder.
9481 \begin_layout Standard
9482 The next thing that becomes obvious is the changes to the paragraph environment
9483 pull-down box [at the far-left end of the toolbar].
9484 Most of the paragraph environments you're used to seeing are missing.
9485 There are also five new ones.
9490 class itself only supports certain paragraph environments:
9493 \begin_layout Itemize
9499 \begin_layout Itemize
9505 \begin_layout Itemize
9511 \begin_layout Itemize
9517 \begin_layout Itemize
9523 \begin_layout Itemize
9529 \begin_layout Itemize
9535 \begin_layout Itemize
9541 \begin_layout Itemize
9547 \begin_layout Itemize
9553 \begin_layout Itemize
9559 \begin_layout Standard
9560 All of the other standard environments, including the section-heading environmen
9561 ts, aren't used in the
9568 \begin_layout Standard
9569 On the other hand, you'll notice the following new environments:
9572 \begin_layout Itemize
9578 \begin_layout Itemize
9584 \begin_layout Itemize
9590 \begin_layout Itemize
9596 \begin_layout Itemize
9602 \begin_layout Standard
9603 These five are kind of quirky, due to a
9604 \begin_inset Quotes eld
9608 \begin_inset Quotes erd
9612 You see, LyX doesn't permit you to nest any other paragraph environment
9613 into an empty environment.
9614 Now, that's fine and dandy, but it means that you wouldn't be able to start
9615 a slide with anything except plain text.
9616 To deal with this, I've performed a little
9617 \begin_inset Quotes eld
9621 \begin_inset Quotes erd
9627 \begin_layout Subsubsection
9628 Quirks of the New Environments
9629 \begin_inset CommandInset label
9631 name "sec:slideQuirk"
9638 \begin_layout Standard
9639 All five of the new paragraph environments are somewhat quirky due to inherent
9640 limitiations in the current version of LyX.
9641 As I just mentioned, LyX forbids environments that begin with another environme
9643 To get around this, the
9647 environment isn't a paragraph environment as described in the
9655 \begin_layout Standard
9669 \begin_inset Quotes eld
9672 pseudo-environments.
9673 \begin_inset Quotes erd
9676 They look like a section heading or a
9677 \begin_inset Quotes eld
9685 \begin_inset Quotes erd
9688 but really begin a [and, if necessary, end the previous] paragraph environment.
9698 \begin_inset Quotes eld
9702 \begin_inset Quotes erd
9705 These two perform some action.
9708 \begin_layout Standard
9709 A common feature of all five environments,
9729 , is a rather long-ish label.
9730 The text following this label --- ordinarily the contents of the paragraph
9731 environment --- is utterly irrelevant for
9752 LyX completely ignores it.
9753 In fact, you can leave these five environments completely empty.
9757 \begin_layout Standard
9762 to put any text after the rather long-ish label, you might want to.
9763 This could be a short description of the contents of the
9768 In that case, enter in your descriptive comment and hit
9772 as you normally would.
9775 \begin_layout Standard
9776 If, on the other hand, you don't want to enter in any descriptive text,
9777 you'll hit another LyX quirk.
9778 LyX, like nature, abhors a vacuum, and will not let you start a new paragraph
9779 environment until you put something in the old one.
9783 \begin_layout Itemize
9784 Start entering the text that will
9812 \begin_layout Itemize
9813 Now move to the beginning of that paragraph.
9817 \begin_layout Itemize
9826 \begin_layout Itemize
9827 Finally, change this new, empty paragraph to a
9851 \begin_layout Standard
9852 Some future version of LyX will, hopefully, resolve this quirkiness\SpecialChar \ldots{}
9856 \begin_layout Subsection
9857 Making a Presentation with
9870 \begin_layout Subsubsection
9878 \begin_layout Standard
9879 If you're expecting this section to teach you how to actually make a presentatio
9880 n, you'll be sorely disappointed.
9881 Naturally, I'll describe all of the ways the
9885 class can assist you in preparing the materials for a presentation.
9886 Filling in the contents, however, is up to you.
9891 the LyX philosophy.]
9894 \begin_layout Standard
9899 environment [in the manner described in section
9900 \begin_inset space ~
9904 \begin_inset CommandInset ref
9906 reference "sec:slideQuirk"
9910 ] tells LyX to begin a new slide [duh].
9911 The label for this environment/
9912 \begin_inset Quotes erd
9916 \begin_inset Quotes erd
9920 \begin_inset Quotes eld
9924 \begin_inset Quotes erd
9927 in cool blue, followed by the label,
9928 \begin_inset Quotes eld
9932 \begin_inset Quotes erd
9936 Any text or paragraph environments that follow this one go on the new slide.
9940 \begin_layout Standard
9941 Slides are probably the only time you'll need to forcibly end pages in LyX
9942 (this can be specified in the
9947 In fact, you'll want to, once you finish entering the contents of one slide.
9948 If you've entered more text than can physically fit on a slide, the extra
9949 overflows onto a new slide.
9950 I don't recommend doing this, however, since the overflow slide won't have
9951 any page number on it.
9952 Furthermore, it may interfere with any
9956 you've made to accompany the oversized
9963 \begin_layout Standard
9972 environments work the same way as the
9978 \begin_inset Quotes eld
9982 \begin_inset Quotes erd
9985 followed by a label [
9986 \begin_inset Quotes eld
9990 \begin_inset Quotes erd
9994 \begin_inset Quotes eld
9998 \begin_inset Quotes erd
10002 The color is a stunning magenta instead of blue, and the
10003 \begin_inset Quotes eld
10007 \begin_inset Quotes erd
10010 will look different, in style and in length.
10011 The label fonts of all three also differ from one another.
10014 \begin_layout Standard
10019 , if the contents of a
10027 exceed the physical size of a slide or sheet of paper, the extra will overflow
10029 Again, you should avoid this.
10030 It defeats the whole purpose of
10041 \begin_layout Subsubsection
10051 \begin_layout Standard
10056 is a slide that sits atop another slide.
10057 Perhaps you wish to discuss a figure on the main
10061 before displaying the text associated with it.
10062 One way to accomplish this is tape a flap of dark paper over the part of
10067 you want to display later.
10068 This method fails, however, if you wish to overlap one graph with another,
10070 You would then have to fumble while speaking to align the two separate,
10075 s to align the two graphs.
10080 environment in both cases makes life much easier.
10083 \begin_layout Standard
10088 receives the page number of its
10089 \begin_inset Quotes eld
10093 \begin_inset Quotes erd
10101 \begin_inset Quotes eld
10109 \begin_inset Quotes erd
10116 \begin_layout Plain Layout
10117 Presumably, mutliple
10122 \begin_inset Quotes eld
10130 \begin_inset Quotes erd
10134 \begin_inset Quotes eld
10142 \begin_inset Quotes erd
10146 \begin_inset Quotes eld
10154 \begin_inset Quotes erd
10158 \begin_inset space ~
10161 appended to the page number of the parent
10171 Clearly, you want the contents of both the
10179 to each fit on a single physical slide! You should probably consider an
10185 \begin_inset Quotes eld
10189 \begin_inset Quotes erd
10201 class provides a visual cue for this: the label at the start of an
10205 is shorter than that at the start of a
10210 Lastly, when you generate printable output, you'll find alignment markers
10211 in all four corners of both the
10215 page and its parent
10220 These will assist you in lining up the two physical slides.
10223 \begin_layout Standard
10224 The major problem in overlaying two slides is aligning the contents of the
10225 two transparencies.
10226 How much space should you leave for that graph on the second slide? Worse
10227 still, what if you want a graph and a sentence on second slide, but there
10228 is text on the main transparency that goes in between them? You could try
10229 and insert vertical space of the right size.
10230 The better way is to use
10241 \begin_layout Standard
10242 As their names imply,
10250 are two command-like paragraph environments that make all subsequent text
10251 invisible and visible, respectively.
10253 \begin_inset space ~
10257 \begin_inset CommandInset ref
10259 reference "sec:slideQuirk"
10263 that you don't place anything
10267 these two environments, however.
10272 , it inserts a centered, sky-blue label into the page reading
10273 \begin_inset Quotes eld
10276 <Invisible Text Follows>
10277 \begin_inset Quotes erd
10281 For paragraphs following this label, the parts of the
10289 ; it doesn't matter which] where they would be contain instead blank space.
10293 \begin_layout Standard
10298 , the corresponding centered label is
10299 \begin_inset Quotes eld
10302 <Visible Text Follows>
10303 \begin_inset Quotes erd
10307 Paragraphs following this label behave normally.
10308 Note that the beginning of a new
10320 automatically shuts off an
10325 It's therefore not necessary to use
10336 \begin_layout Standard
10337 By now, it should be obvious how to create overlay transparencies using
10338 the proper combination of
10357 \begin_layout Enumerate
10362 , including everything that will appear on it, whether on the main slide
10370 \begin_layout Enumerate
10371 Before each figure or paragraph that will appear only on the
10380 If necessary, insert a
10384 environment after the
10391 \begin_layout Enumerate
10396 immediately following the
10403 \begin_layout Enumerate
10404 Copy the contents of this
10415 \begin_layout Enumerate
10420 , change all of the
10431 \begin_layout Standard
10433 You've just made an
10440 \begin_layout Standard
10441 There's one problem with the way I've designed the LyX
10445 class: you can't make text in the middle of a paragraph invisible, nor
10446 make text in the middle of an invisible paragraph visible again.
10447 To accomplish this feat, you'll need to use some inlined LaTeX codes.
10451 \begin_layout Plain Layout
10452 The commands of interest are:
10455 \begin_layout Itemize
10460 invisible \SpecialChar \ldots{}
10464 \begin_layout Itemize
10469 visible \SpecialChar \ldots{}
10473 \begin_layout Plain Layout
10474 \SpecialChar \ldots{}
10475 and need to be marked as TeX.
10477 \begin_inset Quotes eld
10481 \begin_inset Quotes erd
10484 you wish to change goes in between the brackets [and after the
10497 If you don't know how to mark text as TeX, see the appropriate section
10510 \begin_layout Subsubsection
10520 \begin_inset CommandInset label
10522 name "sec:slideNote"
10529 \begin_layout Standard
10538 is associated with a
10539 \begin_inset Quotes eld
10543 \begin_inset Quotes erd
10555 class provides visual cues.
10560 is shorter than that of a
10564 [yet longer than that of an
10568 ] and, like the label of an
10572 is shockingly magenta.
10573 Additionally, the printed
10577 has the page number of its
10578 \begin_inset Quotes eld
10582 \begin_inset Quotes erd
10590 \begin_inset Quotes eld
10598 \begin_inset Quotes erd
10602 \begin_inset Quotes eld
10610 \begin_inset Quotes erd
10614 \begin_inset Quotes eld
10622 \begin_inset Quotes erd
10626 You can have multiple
10630 s associated with a single
10642 , you'll probably want to break up long
10646 s so that they fit on a single sheet of paper.
10649 \begin_layout Standard
10654 is obvious: it contains anything additional you might want to say about
10660 It could also be used as a sheet of reminders for a particular
10665 In the case of the latter, you might want to make use of time markers.
10671 \begin_inset Quotes eld
10675 \begin_inset Quotes erd
10678 support for time markers, a
10683 So, you'll have to resort to using the LaTeX codes.
10686 \begin_layout Standard
10687 To use time markers, you'll need to specify the extra class option
10688 \begin_inset Quotes eld
10696 \begin_inset Quotes erd
10700 \begin_inset space ~
10704 \begin_inset CommandInset ref
10706 reference "sec:slidesetup"
10711 This option turns on timing marks, which will appear in the lower-left-hand
10717 To set what appears in the time marker, you use the LaTeX commands
10718 \begin_inset Quotes eld
10728 \begin_inset Quotes erd
10732 \begin_inset Quotes eld
10742 \begin_inset Quotes erd
10746 The arguments of both commands are time measured in seconds.
10748 \begin_inset Quotes eld
10758 \begin_inset Quotes erd
10761 sets the time marker to a given time.
10763 \begin_inset Quotes eld
10773 \begin_inset Quotes erd
10776 increments the time marker by the specified amount.
10777 Using time markers and
10781 s in this fashion, you can remind yourself how much time to spend on a particula
10789 \begin_layout Standard
10790 There's one last feature to describe.
10791 Clearly, you'd like to print out all of your
10799 s on transparencies while printing all of your
10816 with which it is associated.
10817 What's a person to do?
10820 \begin_layout Standard
10821 Luckily, there are two LaTeX commands that allow you to select what to print
10823 Both must be placed into the preamble of your document.
10825 \begin_inset Quotes eld
10837 \begin_inset Quotes erd
10840 will cause the output to contain only the
10849 Correspondingly, the command
10850 \begin_inset Quotes eld
10862 \begin_inset Quotes erd
10865 prevents the output of anything but
10870 I'd advise placing both commands in the preamble and initially comment
10872 You can then preview your entire presentation as you write.
10873 When you're done writing, you can then uncomment one of the two to select
10874 what you want to print.
10875 I like to uncomment
10876 \begin_inset Quotes eld
10888 \begin_inset Quotes erd
10891 , print to a file with
10892 \begin_inset Quotes eld
10900 \begin_inset Quotes erd
10903 in its name, comment it back out, then uncomment
10904 \begin_inset Quotes eld
10916 \begin_inset Quotes erd
10920 \begin_inset Quotes eld
10928 \begin_inset Quotes erd
10932 I can then send either file to a printer, loading transparencies or plain
10933 paper as appropriate.
10936 \begin_layout Standard
10937 You can also provide other arguments to the
10938 \begin_inset Quotes eld
10948 \begin_inset Quotes erd
10952 \begin_inset Quotes eld
10962 \begin_inset Quotes erd
10966 See a good LaTeX book for details.
10969 \begin_layout Subsection
10974 Class Template File
10977 \begin_layout Standard
10978 I have also provided a template file,
10979 \begin_inset Quotes eld
10987 \begin_inset Quotes erd
10995 To use it, begin your new presentation with
11000 ile\SpecialChar \menuseparator
11002 \begin_inset space ~
11006 \begin_inset space ~
11016 Your new LyX presentation file will contain an example
11037 additionally contain an example of the use of
11046 Lastly, the preamble will contain:
11049 \begin_layout LyX-Code
11050 % Uncomment to print out only slides and overlays
11053 \begin_layout LyX-Code
11057 \begin_layout LyX-Code
11063 \begin_inset Newline newline
11069 \begin_layout LyX-Code
11070 % Uncomment to print out only notes
11073 \begin_layout LyX-Code
11077 \begin_layout LyX-Code
11085 \begin_layout Standard
11086 One final thing: I created this class to support the LaTeX2e
11087 \begin_inset Quotes eld
11095 \begin_inset Quotes erd
11098 class, one of the built-in LaTeX2e classes.
11099 Neither I nor the rest of the LyX Team endorse or oppose the use of this
11100 built-in slide class.
11101 It's here if you want it or need it.
11102 There exist other LaTeX2e classes for creating presentations, such as the
11108 \begin_inset space ~
11112 \begin_inset CommandInset ref
11114 reference "sec:foiltex"
11119 \begin_inset Quotes eld
11127 \begin_inset Quotes erd
11130 package [present on some TeX distributions].
11131 The latter is not yet supported under LyX.
11135 \begin_layout Plain Layout
11136 Perhaps you can take on the task\SpecialChar \ldots{}
11142 I know nothing about these other classes.
11143 Try them out to see what sort of alternative they provide.
11146 \begin_layout Section
11155 \begin_inset CommandInset label
11164 \begin_layout Standard
11170 \begin_layout Subsection
11174 \begin_layout Standard
11175 This section describes how to use LyX to make slides for overhead projectors.
11176 There are two document classes that can do this: the default slides class
11182 This section documents the latter.
11185 \begin_layout Standard
11186 I'm going to say this again, nice and clear, so that there's no misunderstanding
11190 \begin_layout Standard
11191 \begin_inset VSpace bigskip
11197 \begin_layout Standard
11201 This section documents the class
11202 \begin_inset Quotes eld
11210 \begin_inset Quotes erd
11218 \begin_layout Standard
11219 \begin_inset VSpace bigskip
11225 \begin_layout Standard
11226 If you're looking for the documentation for
11227 \begin_inset Quotes eld
11235 \begin_inset Quotes erd
11238 , check out section
11239 \begin_inset space ~
11243 \begin_inset CommandInset ref
11245 reference "sec:slitex"
11250 If your machine doesn't have the
11255 \begin_inset Quotes eld
11263 \begin_inset Quotes erd
11266 ] installed, you'll probably have to use the default
11270 class, which isn't quite as good as
11275 \begin_layout Standard
11280 class is designed for use with version 2.1 of the
11284 LaTeX class file which is now an integral part of LaTeX2e.
11287 \begin_layout Subsection
11291 \begin_layout Standard
11292 Obviously, to use this document class, you need to select
11293 \begin_inset Quotes eld
11301 \begin_inset Quotes erd
11314 \begin_inset space ~
11320 There are some settings in the
11323 \begin_inset space ~
11328 dialog that you should know about that are specific to this class:
11331 \begin_layout Itemize
11332 Don't change the options
11343 \begin_inset space ~
11349 They're ignored by the
11356 \begin_layout Itemize
11357 The default font size is 20pt with the other options being 17pt, 25pt and
11361 \begin_layout Itemize
11362 The default font is
11370 but all math equations are still typeset in the usual roman font.
11373 \begin_layout Itemize
11378 TeX supports A4 and Letter paper sizes as well as a special size for working
11380 It doesn't support A5, B5, legal or executive paper sizes.
11383 \begin_layout Itemize
11384 Don't bother changing the
11388 settings because they are ignored anyway.
11389 All floats appear where they are defined in the text.
11392 \begin_layout Itemize
11400 setting behaves a bit differently for this class.
11405 TeX provides extensive footer and header capabilities including a user-defined
11408 \begin_inset space ~
11412 \begin_inset CommandInset ref
11414 reference "sec:foilfoot"
11419 The title page is treated differently to all other pages in the document
11428 has the logo centered at the bottom of the page (if one is defined).
11429 The possible page style choices and what they do are as follows:
11433 \begin_layout Labeling
11434 \labelwidthstring MMMMMMM
11441 The final output contains no page numbers, or other headers or footers
11442 (except footnotes of course).
11446 \begin_layout Labeling
11447 \labelwidthstring MMMMMMM
11454 The final output contains page numbers centered at the bottom of the page.
11455 No other headings or footers (other than footnotes).
11458 \begin_layout Labeling
11459 \labelwidthstring MMMMMMM
11464 Page numbers in lower right corner.
11465 Additional headers and footers are also shown.
11466 This is also the default.
11469 \begin_layout Labeling
11470 \labelwidthstring MMMMMMM
11475 Gives you access to the
11479 package although its use with
11483 TeX is discouraged by the writer of the
11487 TeX package because of some potential page layout clashes.
11491 \begin_layout Subsubsection
11495 \begin_layout Standard
11496 The following options may be used in the extra class options in the
11501 ocument\SpecialChar \menuseparator
11511 \begin_layout Labeling
11512 \labelwidthstring MMMMMMx
11517 This sets up the page layout for 7.33in by 11in paper, which is about the
11518 same aspect ratio as a 35mm slide, making it a bit easier to work with
11522 \begin_layout Labeling
11523 \labelwidthstring MMMMMMx
11528 Places a rule across the page below the header on every page except the
11532 \begin_layout Labeling
11533 \labelwidthstring MMMMMMx
11538 Places a rule across the page above the footer on every page except the
11542 \begin_layout Labeling
11543 \labelwidthstring MMMMMMx
11548 This is automatically set each time you create a new
11557 TeX to use the dvips driver to rotate those pages that are set as landscape
11561 \begin_layout Labeling
11562 \labelwidthstring MMMMMMx
11567 Simply changes the page dimensions to those of a landscape page but doesn't
11569 Thus if you use this option you need to use an external program to rotate
11570 each page or feed your paper through your printer as landscape.
11571 Note that this option effectively reverses the roles of the
11579 environments (don't worry these are described in the next section).
11582 \begin_layout Labeling
11583 \labelwidthstring MMMMMMx
11588 Equation numbers on the left.
11591 \begin_layout Labeling
11592 \labelwidthstring MMMMMMx
11597 Flush-left equations.
11600 \begin_layout Subsection
11601 Supported Environments
11604 \begin_layout Standard
11605 Most of the environments commonly supported in other classes are also supported
11611 There are several additional environments provided by
11615 TeX as well as a couple added by LyX.
11616 The following environments are shared with other classes:
11619 \begin_layout Standard
11623 \begin_layout Plain Layout
11627 begin{multicols}{2}
11635 \begin_layout Itemize
11641 \begin_layout Itemize
11647 \begin_layout Itemize
11653 \begin_layout Itemize
11659 \begin_layout Itemize
11665 \begin_layout Itemize
11671 \begin_layout Itemize
11677 \begin_layout Itemize
11683 \begin_layout Itemize
11689 \begin_layout Itemize
11695 \begin_layout Itemize
11701 \begin_layout Itemize
11707 \begin_layout Itemize
11713 \begin_layout Itemize
11719 \begin_layout Itemize
11725 \begin_layout Itemize
11731 \begin_layout Itemize
11737 \begin_layout Itemize
11743 \begin_layout Standard
11747 \begin_layout Plain Layout
11759 \begin_layout Standard
11760 That is, all the major environments apart from the sectioning environments.
11761 Since foils are essentially self-contained sections, with a title and body,
11766 TeX provides specific commands for starting new foils and these are:
11769 \begin_layout Itemize
11775 \begin_layout Itemize
11781 \begin_layout Standard
11782 LyX also provides slightly modified versions of these two environments called:
11785 \begin_layout Itemize
11791 \begin_layout Itemize
11794 ShortRotatefoilhead
11797 \begin_layout Standard
11798 and the differences will be explained in the next section.
11801 \begin_layout Standard
11802 Since foils are often used in presenting ideas or new theorems and such
11807 TeX also provides a comprehensive box of goodies for presenting them:
11810 \begin_layout Standard
11814 \begin_layout Plain Layout
11818 begin{multicols}{2}
11826 \begin_layout Itemize
11832 \begin_layout Itemize
11838 \begin_layout Itemize
11844 \begin_layout Itemize
11850 \begin_layout Itemize
11856 \begin_layout Itemize
11862 \begin_layout Itemize
11868 \begin_layout Itemize
11874 \begin_layout Itemize
11880 \begin_layout Itemize
11886 \begin_layout Itemize
11892 \begin_layout Standard
11896 \begin_layout Plain Layout
11908 \begin_layout Standard
11909 The starred versions are unnumbered while the unstarred versions are numbered.
11910 There are also two list environments added by LyX and these are:
11913 \begin_layout Itemize
11919 \begin_layout Itemize
11925 \begin_layout Standard
11930 TeX provides some powerful header and footer capabilities that are best
11931 set in the preamble although they may be set at any point in a document.
11932 If you want to change these settings in your document the best place to
11933 do so is at the very top of a foil,
11938 straight after the foilhead.
11941 \begin_layout Standard
11942 For this purpose, the following command styles are provided [
11949 \begin_layout Standard
11953 \begin_layout Plain Layout
11957 begin{multicols}{2}
11965 \begin_layout Itemize
11969 \begin_inset space ~
11975 \begin_layout Itemize
11981 \begin_layout Itemize
11985 \begin_inset space ~
11991 \begin_layout Itemize
11995 \begin_inset space ~
12001 \begin_layout Itemize
12005 \begin_inset space ~
12012 \begin_layout Standard
12013 \begin_inset space ~
12020 \begin_layout Standard
12024 \begin_layout Plain Layout
12036 \begin_layout Standard
12037 There are also a few commands provided by
12041 TeX that aren't directly supported by LyX but I'll tell you what they do
12042 and how to use them in section
12043 \begin_inset space ~
12047 \begin_inset CommandInset ref
12049 reference "sec:unsuppfoils"
12056 \begin_layout Subsection
12057 Building a Set of Foils
12060 \begin_layout Standard
12061 This section will give a simple introduction to using the different environments
12062 to build a set of foils.
12063 If you want to see an example set of foils, take a look at the
12067 file you find in LyX's
12074 \begin_layout Subsubsection
12075 Give It a Title Page
12078 \begin_layout Standard
12079 Unlike other classes that provide
12099 creates the title on a page of its own.
12100 If you leave out the
12104 environment LaTeX will substitute the current date (every time you regenerate
12108 \begin_layout Subsubsection
12112 \begin_layout Standard
12113 As I mentioned earlier, there are four ways of starting a new foil.
12114 For portrait foils you should use
12123 The difference between these two environments is the amount of space between
12124 the title of the foil (the foilhead) and the body of the foil.
12127 \begin_layout Standard
12128 Landscape foils are generated using the
12134 ShortRotatefoilhead
12137 Again the only difference is the spacing between foilhead and body.
12138 Both of the short versions have 0.5 inches less separation between the foilhead
12143 \begin_layout Standard
12144 One problem with the support for landscape foils is the requirement that
12145 you have to use the
12149 driver to generate the PostScript output otherwise the foils won't be rotated.
12150 It is possible to get landscape foils even if you haven't got the
12154 driver provided you can feed your foils sideways through your printer ;-)
12157 \begin_layout Subsubsection
12158 Theorems, Lemmas, Proofs and more
12161 \begin_layout Standard
12162 Due to a small bug in LyX you can't have two of the same type of these environme
12163 nts directly following each other.
12164 They must be separated by something.
12165 If you try, you will just be extending the previous environment as if you
12166 had merged the two environments together.
12167 So, how do you get around this problem? The simplest option is to insert
12168 some text between the two environments or add a
12172 environment between the two with just a
12173 \begin_inset Quotes eld
12181 \begin_inset Quotes erd
12185 This will force LyX to produce two separate environments and hence the
12186 correct LaTeX output.
12187 An example is provided in the example file included with the LyX distribution.
12188 Remember, this problem only occurs if you are trying to place two of the
12189 same type of theorem-like environments one directly after the other.
12192 \begin_layout Subsubsection
12196 \begin_layout Standard
12197 You get all the commonly supported list styles found in other classes as
12198 well as two new ones.
12199 I'll only describe the new ones here.
12200 If you want to find out more about the other list environments check out
12206 If you intend to use itemized lists you might also want to read about the
12210 \begin_inset space ~
12214 \begin_inset space ~
12219 dialog described above in section
12220 \begin_inset space ~
12224 \begin_inset CommandInset ref
12226 reference "sec:bullet"
12233 \begin_layout Standard
12234 The two new list styles,
12242 , are designed to make it easier for you to create lists of do's and don'ts
12243 or right and wrong by providing dedicated environments that use a tick
12244 or a cross as the label of the list.
12245 These lists are in fact dedicated variants of the
12250 They do however require that you have the
12254 packages installed.
12257 \begin_layout Subsubsection
12261 \begin_layout Standard
12266 TeX redefines the floating tables and figures so that they appear exactly
12267 where they are in the text rather than pushing them to the top of the page
12268 or to some user specified location.
12269 In fact if you change the float placement settings they are simply ignored.
12272 \begin_layout Subsubsection
12273 Page Headers and Footers
12274 \begin_inset CommandInset label
12276 name "sec:foilfoot"
12283 \begin_layout Standard
12287 \begin_inset space ~
12296 are two commands used to control the left-footer text string.
12297 The first is meant to allow you to include a graphic logo on your foils
12299 \begin_inset Quotes eld
12307 \begin_inset Quotes erd
12311 While the second is meant to provide a classification for the audience,
12315 \begin_inset space \thinspace{}
12321 \begin_inset space ~
12325 It is empty by default.
12328 \begin_layout Standard
12329 The remaining page corners can be filled by
12332 \begin_inset space ~
12337 (which defaults to page numbers),
12340 \begin_inset space ~
12348 \begin_inset space ~
12356 \begin_layout Subsection
12362 \begin_inset CommandInset label
12364 name "sec:unsuppfoils"
12371 \begin_layout Standard
12372 All the commands mentioned below need to be set in a
12380 within another environment.
12383 \begin_layout Subsubsection
12387 \begin_layout Standard
12388 All lengths are adjusted using the
12411 should be replaced by the name given to the length you want to change and
12416 is the length value.
12417 All lengths should be specified in units of length such as inches (
12429 ) or relative to some document or font-based length such as
12439 \begin_layout Standard
12440 It's possible to change the spacing between a foilhead and the body of the
12441 foil by adjusting the length specified by
12448 For example, to make
12452 foilheads 0.5 inches closer to their bodies put the following in the preamble:
12459 foilheadskip}{-0.5in}
12462 \begin_layout Standard
12463 The spacings around floats can be adjusted by setting these lengths:
12466 \begin_layout Labeling
12467 \labelwidthstring MMMMMMMMMMM
12474 Separation between the text and the top of the float
12477 \begin_layout Labeling
12478 \labelwidthstring MMMMMMMMMMM
12485 Separation between the float and the caption
12488 \begin_layout Labeling
12489 \labelwidthstring MMMMMMMMMMM
12496 Separation between the caption and the following text
12499 \begin_layout Labeling
12500 \labelwidthstring MMMMMMMMMMM
12507 You can make the captions narrower than the surrounding text by adjusting
12509 Best done relative to
12518 \begin_layout Standard
12519 There are also several title page related lengths that you may find useful
12520 if you have a long title or several authors:
12523 \begin_layout Labeling
12524 \labelwidthstring MMMMMMMMMMM
12531 Separation from headers to
12536 \begin_layout Labeling
12537 \labelwidthstring MMMMMMMMMMM
12555 \begin_layout Labeling
12556 \labelwidthstring MMMMMMMMMMM
12570 \begin_layout Labeling
12571 \labelwidthstring MMMMMMMMMMM
12587 \begin_layout Labeling
12588 \labelwidthstring MMMMMMMMMMM
12604 \begin_layout Standard
12605 The last length related command affects all the list environments.
12616 a list environment then all the vertical spacing between the list items
12618 Note that this is a command not a length so it doesn't require
12624 like the stuff mentioned above.
12627 \begin_layout Subsubsection
12628 Headers and Footers
12631 \begin_layout Standard
12644 commands control whether the logo in the
12648 definition appear on a given page.
12655 in the preamble then none of the foils will have the logo on them.
12656 If you don't want the logo on a particular page place the
12662 directly after the foilhead of that page and the
12668 directly after the next foilhead.
12671 \begin_layout Standard
12672 If you decide to use the
12676 page style setting in the
12679 \begin_inset space ~
12684 dialog you should probably add
12694 to your preamble so headers and footers on landscape pages are correctly
12695 placed when rotated.
12696 This is due to some clashes between the page layouts provided by the
12707 \begin_layout Section
12708 Latex8 (IEEE Conference Papers)
12711 \begin_layout Standard
12717 \begin_layout Subsection
12721 \begin_layout Standard
12722 Since this class is specifically for writing submissions to IEEE sponsored
12723 conferences I strongly recommend that you get a copy of their Authors Kit.
12728 package and associated bibliography style file is included in the kit.
12729 The Authors Kit is usually sent out by email once your initial submission
12731 There is a lot of useful information in the Authors Kit explaining formatting
12732 restrictions and so on and I will assume you have read this since that
12733 means I don't have to repeat it all here.
12736 \begin_layout Subsection
12740 \begin_layout Standard
12741 [AR\SpecialChar \@.
12745 \begin_layout Subsection
12746 Supported Environments
12749 \begin_layout Itemize
12755 \begin_layout Itemize
12761 \begin_layout Itemize
12767 \begin_layout Itemize
12773 \begin_layout Itemize
12779 \begin_layout Itemize
12785 \begin_layout Itemize
12791 \begin_layout Itemize
12797 \begin_layout Itemize
12803 \begin_layout Subsection
12804 Differences Between Screen and Paper
12807 \begin_layout Standard
12808 There are slight differences in appearance mainly with the presentation
12809 of section counters.
12810 On screen the trailing period of the section counter is missing but it
12811 will appear in the output so don't let this worry you.
12814 \begin_layout Section
12815 Hollywood (Hollywood spec scripts)
12818 \begin_layout Standard
12824 \begin_layout Subsection
12828 \begin_layout Standard
12829 Getting the format of a Hollywood script right is a
12830 \begin_inset Quotes eld
12834 \begin_inset Quotes erd
12837 It is designed to make the readers focus on content and to be easy and
12838 familiar for the actors to read.
12839 Each page of a script should be one minute of film.
12840 Nothing goes in a script that you cannot see or hear on screen.
12841 The courier 12 pt font should be used throughout.
12845 \begin_layout Subsection
12849 \begin_layout Standard
12850 Speakers' lines should NEVER break in mid-sentence.
12851 If a speaker's lines continue over a page break, repeat the
12855 title followed by (Cont'd).
12858 \begin_layout Subsection
12862 \begin_layout Standard
12867 names as labels then cross-reference the label to insert the name.
12868 The cross-reference dialog will show the current cast of characters.
12869 You can use this to insert the speaker name in narratives also.
12872 \begin_layout Subsection
12873 Paper size and Margins
12876 \begin_layout Standard
12877 USLetter, left 1.6in, right 0.75in, top 0.5in, bottom 0.75in
12880 \begin_layout Subsection
12884 \begin_layout Standard
12885 The following environments are available.
12886 You can use hollywood.bind to get the bind keys shown at the right.
12889 \begin_layout Itemize
12893 \begin_inset Newline newline
12898 Used where nothing else works.
12902 \begin_layout Itemize
12908 \begin_inset space \hfill{}
12916 \begin_inset Newline newline
12919 Usually followed by something like
12920 \begin_inset Quotes eld
12923 on Sally waking up.
12924 \begin_inset Quotes erd
12930 \begin_layout Itemize
12934 \begin_inset space \hfill{}
12938 \begin_inset Newline newline
12943 Introduces a new INTERIOR camera set-up.
12944 Always followed by DAY or NIGHT, or something similar to define the lighting
12946 Everthing on this line in CAPS.
12949 \begin_layout Itemize
12953 \begin_inset space \hfill{}
12957 \begin_inset Newline newline
12962 Introduces a new EXTERIOR camera set-up.
12963 Everthing on this line in CAPS.
12966 \begin_layout Itemize
12970 \begin_inset space \hfill{}
12974 \begin_inset Newline newline
12979 The character speaking.
12982 \begin_layout Itemize
12986 \begin_inset space \hfill{}
12990 \begin_inset Newline newline
12995 Instructions to the speaker.
12996 The () are automatically inserted, but only the ( will show in LyX.
12997 Both will be printed.
13000 \begin_layout Itemize
13004 \begin_inset space \hfill{}
13008 \begin_inset Newline newline
13020 \begin_layout Itemize
13024 \begin_inset space \hfill{}
13028 \begin_inset Newline newline
13033 Camera movement instruction.
13035 \begin_inset space \thinspace{}
13039 \begin_inset space ~
13045 \begin_layout Itemize
13049 \begin_inset space \hfill{}
13055 \begin_layout Itemize
13059 \begin_inset space \hfill{}
13065 \begin_layout Itemize
13069 \begin_inset space \hfill{}
13075 \begin_layout Itemize
13079 \begin_inset space \hfill{}
13085 \begin_layout Subsection
13089 \begin_layout Itemize
13090 (O.S) --- off screen
13093 \begin_layout Itemize
13094 (V.0) --- voice over
13097 \begin_layout Itemize
13102 \begin_layout Itemize
13107 \begin_layout Itemize
13108 PAN --- camera movement
13111 \begin_layout Itemize
13112 INSERT --- cut to close-up of
13115 \begin_layout Section
13119 \begin_layout Standard
13125 \begin_layout Subsection
13129 \begin_layout Standard
13130 Broadway is for writing plays.
13131 The format is more decorative than Hollywood, and much less standardized.
13132 This format should be suitable for workshops.
13135 \begin_layout Subsection
13139 \begin_layout Standard
13140 The same as in Hollywood.
13143 \begin_layout Subsection
13147 \begin_layout Standard
13152 names as labels then cross-reference the label to insert the name.
13153 The cross-reference dialog will show the current cast of characters.
13156 \begin_layout Subsection
13157 Paper size and Margins
13160 \begin_layout Standard
13161 USLetter, left 1.6in, right 0.75in, top 0.5in, bottom 0.75in
13164 \begin_layout Subsection
13168 \begin_layout Standard
13169 The following environments are available.
13170 You can use broadway.bind to get the bind keys shown at the right.
13173 \begin_layout Itemize
13177 \begin_inset Newline newline
13182 You should not have to use this, but it is here for anything that does not
13186 \begin_layout Itemize
13190 \begin_inset space \hfill{}
13194 \begin_inset Newline newline
13199 Used to describe stage setting and the action.
13200 First use of speaker names in all CAPs.
13203 \begin_layout Itemize
13207 \begin_inset space \hfill{}
13211 \begin_inset Newline newline
13216 Automatically numbered.
13217 On screen it will be arabic, but will print as Roman.
13220 \begin_layout Itemize
13224 \begin_inset space \hfill{}
13228 \begin_inset Newline newline
13238 It is just centered text.
13241 \begin_layout Itemize
13245 \begin_inset space \hfill{}
13249 \begin_inset Newline newline
13254 Not automatically numbered.
13255 You supply the number.
13256 This is because I couldn't figure out how.
13259 \begin_layout Itemize
13263 \begin_inset space \hfill{}
13267 \begin_inset Newline newline
13272 A special case of Narrative to describe the setting and action as the curtain
13276 \begin_layout Itemize
13280 \begin_inset space \hfill{}
13284 \begin_inset Newline newline
13289 The speaker's (actor's) title, centered in all CAPS.
13292 \begin_layout Itemize
13296 \begin_inset space \hfill{}
13300 \begin_inset Newline newline
13305 Instructions to the speaker.
13306 The parentheses are automatically inserted.
13307 The ( will appear on screen, but both will be in the printed play.
13308 This environment is only used within
13315 \begin_layout Itemize
13319 \begin_inset space \hfill{}
13323 \begin_inset Newline newline
13328 What the Speaker says.
13331 \begin_layout Itemize
13335 \begin_inset space \hfill{}
13339 \begin_inset Newline newline
13344 The curtain comes down.
13347 \begin_layout Itemize
13351 \begin_inset space \hfill{}
13357 \begin_layout Itemize
13361 \begin_inset space \hfill{}
13367 \begin_layout Itemize
13371 \begin_inset space \hfill{}
13377 \begin_layout Standard
13381 \begin_layout Section
13385 \begin_layout Standard
13391 \begin_layout Standard
13392 \begin_inset VSpace bigskip
13398 \begin_layout Standard
13403 \begin_inset space ~
13408 textclass works with the American Physical Sociey's RevTeX 4.0 (the
13409 \begin_inset Formula $\beta$
13412 release of May, 1999) class.
13415 \begin_layout Standard
13420 textclass, which works with RevTeX 3.1.
13421 However, v3.1 is basically obsolete, as it works with LaTeX 2.09.
13422 That means that it doesn't interact very well with LyX, which requires
13423 LaTeX2e, although it has been kludged to work.
13424 Since RevTeX 4.0 has been designed to work much more cleanly with LaTeX2e,
13428 \begin_inset space ~
13433 textclass should also be pretty easy to use.
13436 \begin_layout Standard
13437 These documents are supposed to be used in
13441 to the RevTeX 4.0 documents, so we don't describe any of the special RevTeX
13442 macros, and assume you'll know what to put in the preamble if necessary.
13445 \begin_layout Subsection
13449 \begin_layout Standard
13450 All you need to do is install RevTeX 4, as described in the package's README
13452 The package can be found at The RevTeX 4 Web Site
13453 \begin_inset Flex URL
13456 \begin_layout Plain Layout
13458 http://publish.aps.org/revtex4/
13464 Install it somewhere that LaTeX can see it.
13465 Test it by trying to LaTeX a short RevTeX 4 document in some random directory
13466 (i.e., not the directory where you installed the class file.) Then, if you
13467 reconfigure LyX, it will find the class file and let you use the RevTeX4
13471 \begin_layout Standard
13472 Probably the easiest way to get started is either to import a RevTeX 4 document
13480 \begin_inset space ~
13485 template, found in the templates directory.
13488 \begin_layout Subsection
13492 \begin_layout Standard
13493 Optional arguments to
13500 \begin_inset Quotes eld
13504 \begin_inset Quotes erd
13508 \begin_inset Quotes eld
13512 \begin_inset Quotes erd
13522 \begin_inset space ~
13530 \begin_inset space ~
13536 Remember that in RevTeX, at least one optional argument is required!
13539 \begin_layout Standard
13540 Other preamble matter, like
13547 \begin_inset space ~
13557 \begin_inset space ~
13562 dialog, also as usual.
13565 \begin_layout Subsection
13569 \begin_layout Standard
13570 The layouts basically correspond to the commands in RevTeX4.0.
13571 For example, the Email layout corresponds to
13578 Note that (at least as of RevTeX 4.0 Beta), the
13586 layouts are exactly equivalent, so you shouldn't need to use both.
13590 \begin_layout Plain Layout
13591 In case you're curious, both were included so that
13595 would be able to translate both
13615 \begin_layout Subsection
13619 \begin_layout Standard
13620 There are a couple of important unique aspects of RevTeX 4 which might cause
13621 bugs that will be even more confusing in LyX.
13624 \begin_layout Standard
13642 The LyX equivalent is that there is a separate Thanks layout.
13647 write footnotes in the
13651 layout, or weird things may happen.
13652 See the RevTeX 4 documentation for more details.
13655 \begin_layout Standard
13659 \begin_inset space ~
13667 \begin_inset space ~
13676 layouts must be placed
13684 layout and the corresponding
13701 , the LaTeX won't compile.
13704 \begin_layout Subsection
13708 \begin_layout Standard
13709 The main problem with this layout is that you can't use the optional arguments
13710 to layouts like Email and Title.
13711 (The problem is not unique to this layout; you can't use optional arguments
13712 to the Section layouts either.) This means that after you export that file
13713 to LaTeX (which you'll need to do eventually to send it in to APS), you'll
13714 need to edit the LaTeX file with a text editor to add the optional arguments
13716 \begin_inset space \thinspace{}
13719 g., the running title for the page headers.
13720 Lacking these layouts makes the
13726 (and the equivalent
13732 ) useless, so the corresponding layouts don't exist, and will have to be
13737 \begin_layout Plain Layout
13742 actually, LyX 1.3.0 supports some forms of optional arguments, but this layout
13743 has not been updated yet to take advantage of it.
13751 \begin_layout Section
13752 Article (mwart), book (mwbk) and report (mwrep)
13753 \begin_inset OptArg
13756 \begin_layout Plain Layout
13769 \begin_layout Standard
13775 \begin_layout Standard
13776 The LyX document classes
13792 correspond to the LaTeX document classes
13805 They are replacements for the standard document classes
13817 , resp., and fit better to Polish typography conventions in a number of points.
13821 \begin_layout Standard
13825 \begin_layout Itemize
13826 Unnumbered titles (with star, eg.
13831 ) are added into table of contents,
13834 \begin_layout Itemize
13835 Additional page styles:
13839 \begin_layout Description
13840 uheadings header with separated lines,
13843 \begin_layout Description
13844 myheadings custom header, contents headers via commands:
13859 \begin_layout Description
13860 myuheadings custom header with separated lines,
13863 \begin_layout Description
13864 outer page number is placed on outer side of page
13868 \begin_layout Itemize
13873 \begin_layout Description
13874 rmheadings serif titles --- default,
13877 \begin_layout Description
13878 sfheadings sansserif titles,
13881 \begin_layout Description
13882 authortitle on title page first placed is author next title --- default,
13885 \begin_layout Description
13886 titleauthor on title page first placed is title next author,
13889 \begin_layout Description
13890 withmarginpar reserve place on page for margins.
13894 \begin_layout Section
13898 \begin_layout Standard
13904 \begin_layout Standard
13905 Elsevier Science Publishers B.V.
13906 provides a standard LaTeX document class (
13910 ) for submitting articles to their various journals.
13911 The style file can be downloaded directly from their web site:
13912 \begin_inset Flex URL
13915 \begin_layout Plain Layout
13917 http://authors.elsevier.com/
13923 Instructions are supplied along with the class file, which details the
13924 requirements of the publishers.
13925 LyX includes package that allows for the use of this class, by a layout
13926 and a template file.
13927 Installation of the class file is the same as for any other LaTeX package;
13928 instructions are provided in the Elsevier documentation.
13931 \begin_layout Standard
13941 As the Elsevier class file is based mainly on the standard article class,
13942 most of the normal functionality is provided.
13943 The Elsevier class defines a number of mathematical environments, which
13944 are similar to the AMS environments.
13945 These commands are all described in the Elsevier documentation, and are
13949 \begin_layout Standard
13950 The easiest way to use the Elsevier style is to base documents on the included
13952 It is best not to use options such as fancy headings or the geometry package,
13953 as elements such as these are defined by Elsevier in their style file.
13954 Ideally, no extra packages except those mentioned in the Elsevier documentation
13956 Essentially, Elsevier require as
13957 \begin_inset Quotes eld
13961 \begin_inset Quotes erd
13964 a LaTeX file as possible, as their intention is to take the supplied file
13965 and replace the class file with one for the particular journal to which
13966 the paper has been submitted.
13967 This also means that not too much time should be spent on the formating
13969 When it comes to be published, this will change anyway.
13970 The rest of the usage for this layout is substantially the same as for
13971 the normal article class.
13972 For details of what Elsevier do and don't allow, refer to their documentation.
13975 \begin_layout Section
13979 \begin_layout Standard
13982 Jürgen Spitzmüller
13985 \begin_layout Subsection
13989 \begin_layout Standard
13990 Memoir is a very powerful and constantly evolving class.
13991 It has been designed with regard to fictional and non-fictional literature.
13992 Its aim is to let the user have maximum control over the typesetting of
13994 Memoir is based on the standard book class, but it can also emulate the
13995 article class (see below).
13998 \begin_layout Standard
13999 Peter Wilson, the developer of Memoir, is known as the author of lots of
14000 useful packages in the LaTeX world.
14001 Most of them have been merged with Memoir.
14002 Therefore, it is much easier to layout the table of contents, appendices,
14003 chapter designs and such.
14004 LyX, though, does not support all of these goodies natively.
14005 Some of them might be added to forthcoming releases
14009 \begin_layout Plain Layout
14010 You are invited to send suggestions to
14011 \begin_inset Flex URL
14014 \begin_layout Plain Layout
14016 lyx-devel@lists.lyx.org
14026 , lots will probably never, due to the limitations of LyX's framework.
14027 Of course you can still use all features with the help of some native LaTeX
14032 \begin_layout Plain Layout
14037 \begin_layout Plain Layout
14047 \begin_inset space ~
14051 \begin_inset CommandInset ref
14053 reference "sec:Inserting-TeX-Code"
14063 In this section, we can only list those features which are natively supported
14065 For detailed descriptions (and for the rest of features) we are recommending
14066 to have a look at the detailed manual of the Memoir class
14070 \begin_layout Plain Layout
14075 \begin_layout Plain Layout
14085 \begin_inset Flex URL
14088 \begin_layout Plain Layout
14090 CTAN:/macros/latex/memoir/memman.pdf
14100 , which is not only a user guide for the class, but also both a comprehensive
14101 description on good typesetting and a superb example for good typesetting
14105 \begin_layout Subsection
14106 Basic features and restrictions
14109 \begin_layout Standard
14110 Memoir supports basically all features of the standard book classes.
14111 There are, however, some differences, as follows:
14114 \begin_layout Description
14116 \begin_inset space ~
14119 sizes: Memoir has a broader range of font sizes: 9, 10, 11, 12, 14, 17
14122 \begin_layout Description
14124 \begin_inset space ~
14127 style: The fancy page style is not supported, due to a command clash between
14128 Memoir and the fancyhdr package (they are both defining a command with
14129 the same name, which confuses LaTeX).
14130 Instead, Memoir comes with a bunch of own page styles (see
14132 Layout\SpecialChar \menuseparator
14133 Document\SpecialChar \menuseparator
14135 \begin_inset space ~
14141 If you want to use these for the chapter pages, you have to use the command
14148 in the main text or in preamble (e.
14149 \begin_inset space \thinspace{}
14153 \begin_inset space ~
14160 chapterstyle{companion}
14165 \begin_layout Description
14166 Sectioning: Sectionings (chapter, section, subsection etc.) are coming with
14167 an optional argument in the standard classes.
14168 With this, you can specify an alternative version of the title for the
14169 table of contents and the headers (for instance, if the title is too long).
14170 In LyX, you can do this via
14172 Insert\SpecialChar \menuseparator
14174 \begin_inset space ~
14179 at the beginning of a chapter/section.
14180 Memoir features a second optional argument and thus separates the table
14181 of contents from the header.
14182 You can define three variants of a title with this: one for the main text,
14183 one for the table of contents, and one for the headers.
14184 Simply insert two optional arguments if you need this feature, the first
14185 one containing the short title for the Table of Contents, the second one
14186 containing an alternative short title for the headers.
14189 \begin_layout Description
14190 TOC/LOT/LOF: In the standard classes (and in many other classes), the table
14191 of contents, the list of figures and the list of table start a new page
14193 Memoir does not follow this route.
14194 You have to insert a page break yourself, if you want to have one.
14197 \begin_layout Description
14198 Titlepage: For some unknown reason, Memoir uses pagination on the title
14199 page (in the standard classes, title pages are
14200 \begin_inset Quotes eld
14204 \begin_inset Quotes erd
14208 \begin_inset space \thinspace{}
14212 \begin_inset space ~
14216 If you want an empty title page, type
14220 aliaspagestyle{title}{empty}
14225 \begin_layout Description
14226 Article: With the class option
14232 Layout\SpecialChar \menuseparator
14233 Document\SpecialChar \menuseparator
14235 \begin_inset space ~
14240 ), you can emulate article style.
14241 That is, counters (footnotes, figures, tables etc.) will not be reset on
14242 new chapters, chapters don't start a new page (but are---in contrary to
14244 \begin_inset Quotes eld
14248 \begin_inset Quotes erd
14251 article classes---still allowed), parts, though, use their own page, as
14255 \begin_layout Description
14256 Oldfontcommands: By default, Memoir does not allow the use of the deprecated
14257 font commands, which have been used in the old LaTeX version 2.09 (e.
14258 \begin_inset space \thinspace{}
14262 \begin_inset space ~
14278 It produces an error and stops LaTeX whenever such a command appears.
14283 reallows the commands and spits out warnings instead (which does at least
14285 Since a lot of packages and particularly BibTeX style files are still using
14286 those commands, we have decided to use this option by default.
14289 \begin_layout Subsection
14293 \begin_layout Standard
14294 We will only describe the features supported by LyX (which is not much currently
14296 Please consult the Memoir manual
14300 \begin_layout Plain Layout
14305 \begin_layout Plain Layout
14315 \begin_inset Flex URL
14318 \begin_layout Plain Layout
14320 CTAN:/macros/latex/memoir/memman.pdf
14333 \begin_layout Description
14334 Abstract: You may wonder why an abstract is an extra feature.
14335 Well, it is in book class.
14336 Usually books don't have abstracts.
14337 Memoir, however, has.
14338 You can use it wherever and how often you like.
14341 \begin_layout Description
14342 Chapterprecis: You may know this from belletristic: The contents of a chapter
14343 is shortly described below the title and also in the table of contents
14345 \begin_inset space \thinspace{}
14349 \begin_inset space ~
14354 Our hero arrives in Troia; he loses some friends; he finds others
14357 Chapterprecis does exactly this.
14358 It is therefore only sensible below a chapter.
14361 \begin_layout Description
14362 Epigraph: An epigraph is a smart slogan or motto at the beginning of a chapter.
14363 The epigraph environment provides an elegant way of typesetting such a
14365 The motto itself (text) and its author (source) are divided by a short
14367 Unfortunately, we have to fool LyX a bit here again, since the environment
14368 needs two arguments (text and source).
14369 In this case, we have to use curly brackets (in TeX mode) between the two
14380 <author of the slogan>.
14383 \begin_layout Description
14384 Poemtitle: Memoir has lots of possibilities to typeset poetry (up to very
14385 complex figurative poems).
14386 LyX can only support a few of them.
14387 One is poemtitle, which is a centered title for poems, which will also
14388 be added to the table of contents (verse is the standard environment for
14390 Memoir has some enhanced versions of verse, but you need to use ERT, because
14391 they have to be nested inside regular verse environments, which is not
14392 possible with LyX).
14395 \begin_layout Description
14396 Poemtitle*: Same as poemtitle, but it adds no entry to the table of contents.
14399 \begin_layout Chapter
14400 LyX Features needing Extra Software
14403 \begin_layout Section
14407 \begin_layout Standard
14413 \begin_layout Subsection
14417 \begin_layout Standard
14418 When you to have the
14422 program installed, you'll find in the
14429 \begin_inset space ~
14440 \begin_inset CommandInset href
14442 target "http://www.ctan.org/tex-archive/help/Catalogue/entries/chktex.html"
14449 \begin_layout Standard
14454 package is a program that was written by
14459 in frustration because some constructs in LaTeX are sometimes non-intuitive,
14460 and easy to forget.
14461 The program runs over your LaTeX file and checks the integrity of the file,
14462 and flags some common errors.
14463 In other technical words, it is
14470 \begin_layout Standard
14471 Well, what is a syntax checker doing in LyX which is supposed to produce
14472 correct LaTeX anyways? The answer is simple: Just as
14476 not only checks the
14480 of C programs, but also does
14484 checks for type-errors,
14488 catches some common
14492 errors, in addition to the syntactical ones.
14497 is capable of detecting several common errors, such as
14500 \begin_layout Itemize
14501 Ellipsis detection:
14502 \begin_inset Newline newline
14505 Use \SpecialChar \ldots{}
14509 \begin_layout Itemize
14510 No space in front of/after parenthesis:
14511 \begin_inset Newline newline
14517 \begin_layout Itemize
14518 Enforcement of normal space after common abbreviations:
14519 \begin_inset Newline newline
14524 is too wide spacing.
14527 \begin_layout Itemize
14528 Enforcement of end-of-sentence space when the last sentence ends with a
14530 \begin_inset Newline newline
14534 And this is wrong spacing.
14537 \begin_layout Itemize
14538 Space in front of labels and similar commands:
14539 \begin_inset Newline newline
14542 The label should stick right up to the text to avoid falling to a wrong
14545 \begin_inset CommandInset label
14555 \begin_layout Plain Layout
14556 This footnote is in danger of falling off to a wrong page
14561 The label is separated too much.
14564 \begin_layout Itemize
14565 Space in front of references, instead of hard spaces:
14566 \begin_inset Newline newline
14569 In you are in bad luck, the text will break right between the referenced
14570 text and reference number, and that's a pity.
14572 \begin_inset CommandInset ref
14574 reference "sec:chktex"
14581 \begin_layout Itemize
14583 \begin_inset Quotes eld
14587 \begin_inset Quotes erd
14591 \begin_inset Formula $\times$
14595 \begin_inset Newline newline
14598 2x2 looks cheap compared to
14599 \begin_inset Formula $2\times2$
14605 \begin_layout Standard
14606 and more \SpecialChar \ldots{}
14607 It is an invaluable tool when you are
14608 \begin_inset Quotes eld
14612 \begin_inset Quotes erd
14615 your document before printing, and you should run it right after the obligatory
14616 spelling check, and before you go fine tuning the typesetting.
14619 \begin_layout Subsection
14623 \begin_layout Standard
14624 If you have the program installed, usage is as simple as choosing
14629 ools\SpecialChar \menuseparator
14635 \begin_inset space ~
14641 This will make LyX generate a LaTeX file of your document, start
14645 to check it, and then make LyX insert
14646 \begin_inset Quotes eld
14650 \begin_inset Quotes erd
14653 with the warnings from
14657 , if there were any.
14658 The warnings will be placed close to the point of the mistake, and you
14659 can quickly find them by using the
14664 avigate\SpecialChar \menuseparator
14671 menu item, or the shortcut key
14680 Open the error boxes by clicking on them with the mouse, or use the shortcut
14689 bindings, or the corresponding
14698 Read the warning and correct the mistake, if it is a mistake.
14699 If you have trouble understanding what the warning is about, you can safely
14701 Remember that there is a hidden layer between the document on screen and
14702 the technical details in invoking
14706 , and this gap can make some warnings seem arcane or just right down plain
14710 \begin_layout Standard
14711 This document is an excellent testing bed for the feature, and it should
14712 provide quite a few warnings for you to fiddle with.
14713 Since computers are only so smart, expect most of the warnings to be false
14717 \begin_layout Subsection
14718 How to fine tune it
14721 \begin_layout Standard
14722 Sometimes, you'll find that
14726 makes more noise than suits your mood.
14727 Then you can choose not to use it, wait until your mood changes, or try
14732 to get better along with you.
14733 Another choice in the most desperate situations is to use
14738 iew\SpecialChar \menuseparator
14744 \begin_inset space ~
14748 \begin_inset space ~
14752 \begin_inset space ~
14757 , which will get rid of all warnings instantly.
14760 \begin_layout Standard
14769 very configurable and extensible, you shouldn't expect to solve all problems
14775 Since LyX has to generate a somewhat special LaTeX file to be able to match
14776 the line numbers from the
14784 \begin_layout Plain Layout
14785 You can inspect the specific output from
14791 Edit\SpecialChar \menuseparator
14793 \begin_inset space ~
14797 \begin_inset space ~
14811 to the internal document structure, some of the warnings will not seen
14812 to appear correctly.
14813 There are two things you can do about this:
14816 \begin_layout Itemize
14821 invocation command line in
14837 installation configuration file (usually with the file
14842 See below to learn what warnings can be enabled and disabled on the command
14847 \begin_layout Itemize
14848 Export your document as a raw LaTeX file using
14853 ile\SpecialChar \menuseparator
14858 xport\SpecialChar \menuseparator
14870 Invoked in this way, it can be a hassle to find the corresponding place
14871 in the document inside LyX, but with a little patience, you should be able
14875 \begin_layout Standard
14876 Here follows the warning messages that can be enabled and disabled in
14885 to disable a warning, and
14889 to enable a warning.
14890 The emphasized entries are disabled by default, because the default is
14893 chktex -n1 -n3 -n6 -n9 -n22 -n25 -n30 -n38
14898 \begin_layout Standard
14899 Notice that you should only use the options that enable and disable warnings,
14900 because LyX relies on some of the other command line parameters to be set
14901 in a specific way to have a chance to communicate with
14908 \begin_layout Enumerate
14912 Command terminated with space.
14915 \begin_layout Enumerate
14918 Non-breaking space (
14919 \begin_inset Quotes eld
14927 \begin_inset Quotes erd
14930 ) should have been used.
14933 \begin_layout Enumerate
14937 You should enclose the previous parenthesis with
14938 \begin_inset Quotes eld
14946 \begin_inset Quotes erd
14952 \begin_layout Enumerate
14955 Italic correction (
14956 \begin_inset Quotes eld
14966 \begin_inset Quotes erd
14969 ) found in non-italic buffer.
14972 \begin_layout Enumerate
14975 Italic correction (
14976 \begin_inset Quotes eld
14986 \begin_inset Quotes erd
14989 ) found more than once.
14992 \begin_layout Enumerate
14996 No italic correction (
14997 \begin_inset Quotes eld
15007 \begin_inset Quotes erd
15013 \begin_layout Enumerate
15017 \begin_inset Quotes eld
15025 \begin_inset Quotes erd
15029 \begin_inset Quotes eld
15037 \begin_inset Quotes erd
15043 \begin_layout Enumerate
15046 Wrong length of dash may have been used.
15049 \begin_layout Enumerate
15053 \begin_inset Quotes eld
15061 \begin_inset Quotes erd
15065 \begin_inset Quotes eld
15073 \begin_inset Quotes erd
15079 \begin_layout Enumerate
15083 \begin_inset Quotes eld
15091 \begin_inset Quotes erd
15097 \begin_layout Enumerate
15101 \begin_inset Quotes eld
15109 \begin_inset Quotes erd
15112 to achieve an ellipsis.
15115 \begin_layout Enumerate
15118 Inter-word spacing (
15119 \begin_inset Quotes eld
15129 \begin_inset Quotes eld
15132 ) should perhaps be used.
15135 \begin_layout Enumerate
15138 Inter-sentence spacing (
15139 \begin_inset Quotes eld
15149 \begin_inset Quotes erd
15152 ) should perhaps be used.
15155 \begin_layout Enumerate
15158 Could not find argument for command.
15161 \begin_layout Enumerate
15165 \begin_inset Quotes eld
15173 \begin_inset Quotes erd
15179 \begin_layout Enumerate
15182 Math mode still on at end of LaTeX file.
15185 \begin_layout Enumerate
15189 \begin_inset Quotes eld
15197 \begin_inset Quotes erd
15200 doesn't match the number of
15201 \begin_inset Quotes eld
15209 \begin_inset Quotes erd
15215 \begin_layout Enumerate
15218 You should use either
15221 \begin_inset Quotes eld
15229 \begin_inset Quotes erd
15234 as an alternative to
15235 \begin_inset Quotes eld
15243 \begin_inset Quotes erd
15249 \begin_layout Enumerate
15256 " (ASCII 39) instead of "
15263 \begin_layout Enumerate
15266 User-specified pattern found.
15269 \begin_layout Enumerate
15272 This command might not be intended.
15275 \begin_layout Enumerate
15282 \begin_layout Enumerate
15300 \begin_layout Enumerate
15303 Delete this space to maintain correct page references.
15306 \begin_layout Enumerate
15310 You might wish to put this between a pair of
15311 \begin_inset Quotes eld
15319 \begin_inset Quotes erd
15325 \begin_layout Enumerate
15328 You ought to remove spaces in front of punctuation.
15331 \begin_layout Enumerate
15334 Could not execute LaTeX command.
15337 \begin_layout Enumerate
15346 in front of small punctuation.
15349 \begin_layout Enumerate
15357 may look prettier here.
15360 \begin_layout Enumerate
15364 Multiple spaces detected in output.
15367 \begin_layout Enumerate
15370 This text may be ignored.
15373 \begin_layout Enumerate
15379 \begin_inset Quotes eld
15384 to begin quotation, not
15391 \begin_layout Enumerate
15398 to end quotation, not
15401 \begin_inset Quotes eld
15409 \begin_layout Enumerate
15415 \begin_layout Enumerate
15418 You should perhaps use
15419 \begin_inset Quotes eld
15427 \begin_inset Quotes erd
15433 \begin_layout Enumerate
15436 You should put a space in front of/after parenthesis.
15439 \begin_layout Enumerate
15442 You should avoid spaces in front of/after parenthesis.
15445 \begin_layout Enumerate
15449 You should not use punctuation in front of/after quotes.
15452 \begin_layout Enumerate
15455 Double space found.
15458 \begin_layout Enumerate
15461 You should put punctuation outside inner/inside display math mode.
15464 \begin_layout Enumerate
15467 You ought to not use primitive TeX in LaTeX code.
15470 \begin_layout Enumerate
15473 You should remove spaces in front of
15474 \begin_inset Quotes eld
15482 \begin_inset Quotes erd
15488 \begin_layout Enumerate
15491 \begin_inset Quotes eld
15499 \begin_inset Quotes erd
15502 is normally not followed by
15503 \begin_inset Quotes eld
15511 \begin_inset Quotes erd
15517 \begin_layout Standard
15518 In later versions of LyX, we hope to provide a more complete interface to
15519 this tool (and it's smaller cousin
15523 ) to exploit the full power of it.
15524 But it's not exactly useless as it is now: go try it on one of your existing
15525 documents of a certain length and be surprised.
15528 \begin_layout Section
15529 Version Control in LyX
15532 \begin_layout Standard
15535 Lars Gullik Bjønnes,
15542 \begin_layout Subsection
15546 \begin_layout Standard
15547 A friend of mine wanted to try LyX for a group project.
15548 When he didn't find support for version control or file locking, he dropped
15550 This angered me a bit, so I thought that I should at least make support
15551 for RCS (with the possibility of CVS and/or SCCS as a future improvement.)
15552 This has now been done.
15553 LyX now supports some of the most basic RCS commands.
15554 If you need to something a bit more sophisticated you will have to do that
15555 manually in an xterm.
15558 \begin_layout Standard
15559 Before you begin to use the version control features in LyX, you should
15561 \begin_inset Quotes eld
15565 \begin_inset Quotes erd
15568 (a man file, read it with
15573 This file describes all the basic features of RCS.
15574 You should especially notice the comment about a RCS directory, and the
15575 notion of a master RCS file (the file ending in
15582 \begin_layout Standard
15583 Later basic CVS/SVN support was added.
15584 You should be familiar with CVS/SVN usage before start using it under LyX.
15585 Most of the log messages are not currently displayed after operations -
15586 you can check them in terminal window if unsure.
15589 \begin_layout Standard
15590 The implementation in LyX assumes a recent version of the GNU RCS or CVS/SVN
15591 package---no guarantees are made for older versions.
15594 \begin_layout Subsection
15595 RCS commands in LyX
15598 \begin_layout Standard
15599 The following sections describe the RCS commands supported by LyX.
15600 You can find them in the
15605 ile\SpecialChar \menuseparator
15611 \begin_inset space ~
15619 \begin_layout Subsubsection
15625 \begin_layout Standard
15626 If your document is not under revision control, this is the only item shown
15628 And if it is under revision control, the
15635 item is not visible.
15639 \begin_layout Standard
15640 This command registers your document with RCS (unless you are under the
15641 directory managed by CVS)\SpecialChar \@.
15642 You are asked interactively to supply an initial
15643 description of the document.
15644 The document is now set in Read-Only mode and you have to
15647 \begin_inset space ~
15651 \begin_inset space ~
15655 \begin_inset space ~
15660 , before making any changes to it.
15661 A document under revision control has a
15662 \begin_inset Quotes eld
15665 [RCS:<version> <locker>]
15666 \begin_inset Quotes erd
15669 item tagged to the filename in the minibuffer.
15672 \begin_layout Standard
15673 RCS command that is run:
15675 ci -q -u -i -t-"<initial description>" <file-name>
15678 \begin_layout Standard
15683 to understand the switches.
15687 \begin_layout Subsubsection
15693 \begin_layout Standard
15694 When you are finished editing a file, you check in your changes.
15695 When you do this, you are asked for a description of the changes.
15696 This is stored in the history log.
15697 The version number is bumped, your changes are applied to the master RCS
15698 file, the document is unlocked and set to Read-Only mode.
15702 \begin_layout Standard
15705 ci -q -u -m"<description>" <file-name>
15708 \begin_layout Subsubsection
15714 \begin_layout Standard
15715 By doing this you lock the document so that only you can edit it.
15716 This will also make the document Read-Write only for you.
15717 You will usually continue editing for a while and when you are finished
15718 you check in your changes.
15719 The status line is changed to reflect that you have locked the file.
15723 \begin_layout Standard
15726 co -q -l <file-name>
15729 \begin_layout Subsubsection
15732 Revert To Repository Version
15735 \begin_layout Standard
15736 This will discard all changes made to the document since the last check
15738 You get a warning before changes are discarded.
15741 \begin_layout Standard
15744 co -f -u<version> <file-name>
15747 \begin_layout Subsubsection
15753 \begin_layout Standard
15754 This makes as if the last check in never happened.
15755 No changes are made to the document loaded into LyX, but the last version
15756 is removed from the master RCS file.
15760 \begin_layout Standard
15763 rcs -o<version> <file-name>
15766 \begin_layout Subsubsection
15772 \begin_layout Standard
15773 This show the complete history of the RCS document.
15778 is shown in a browser.
15786 \begin_layout Subsection
15787 CVS commands in LyX
15790 \begin_layout Standard
15791 CVS is now partially supported by LyX.
15792 You can find the commands in the
15797 ile\SpecialChar \menuseparator
15803 \begin_inset space ~
15811 \begin_layout Subsubsection
15817 \begin_layout Standard
15818 If your document is not under revision control, this is the only item shown
15820 And if it is under revision control, the
15827 item is not visible.
15831 \begin_layout Standard
15832 This command registers in CVS your document ONLY in case you have already
15833 the documents directory under CVS control (in particular
15838 This means you have to checkout the archive by yourself.
15842 \begin_layout Standard
15843 Then you are asked interactively to supply an initial description of the
15845 Don't forget that registered file is not yet commited.
15848 \begin_layout Standard
15849 CVS command that is run:
15852 \begin_inset Quotes erd
15856 \begin_inset Quotes eld
15860 \begin_inset Quotes erd
15866 \begin_layout Standard
15871 to understand the switches.
15875 \begin_layout Subsubsection
15881 \begin_layout Standard
15882 When you are finished editing a file, you commit your changes.
15883 When you do this, you are asked for a description of the changes.
15884 After that changes are commited.
15887 \begin_layout Standard
15890 cvs -q commit -m"<description>" <file-name>
15893 \begin_layout Subsubsection
15896 Revert To Repository Version
15899 \begin_layout Standard
15900 This will discard all changes made to the document since the last check
15902 You get a warning before changes are discarded.
15903 Firstly the file is deleted, secondly CVS update command is run.
15906 \begin_layout Standard
15910 \begin_inset Quotes eld
15914 \begin_inset Quotes erd
15920 \begin_layout Subsubsection
15926 \begin_layout Standard
15927 This show the complete history of the CVS document.
15931 \begin_inset Quotes eld
15935 \begin_inset Quotes erd
15940 is shown in a browser.
15943 \begin_layout Subsection
15944 SVN commands in LyX
15947 \begin_layout Standard
15948 SVN is now partially supported by LyX.
15949 You can find the commands in the
15954 ile\SpecialChar \menuseparator
15960 \begin_inset space ~
15966 Please note that if you use password protected access to repository via
15967 ssh, you will be asked in terminal window.
15970 \begin_layout Subsubsection
15976 \begin_layout Standard
15977 If your document is not under revision control, this is the only item shown
15979 And if it is under revision control, the
15986 item is not visible.
15990 \begin_layout Standard
15991 This command registers in SVN your document ONLY in case you have already
15992 the documents directory under SVN control (in particular
15997 This means you have to checkout the archive by yourself.
16001 \begin_layout Standard
16002 Then you are asked interactively to supply an initial description of the
16004 Don't forget that registered file is not yet commited.
16007 \begin_layout Standard
16008 SVN command that is run:
16011 \begin_inset Quotes eld
16015 \begin_inset Quotes erd
16021 \begin_layout Standard
16026 to understand the switches.
16030 \begin_layout Subsubsection
16036 \begin_layout Standard
16037 When you are finished editing a file, you commit your changes.
16038 When you do this, you are asked for a description of the changes.
16039 After that changes are commited.
16042 \begin_layout Standard
16045 svn commit -q -m"<description>" <file-name>
16048 \begin_layout Subsubsection
16054 \begin_layout Standard
16055 Updates the changes of this file from the repository.
16056 Be sure you understand SVN merging and conflicts resolving before using
16057 this function, because all conflicts has to be done manually by you!
16060 \begin_layout Standard
16064 \begin_inset Quotes eld
16068 \begin_inset Quotes erd
16074 \begin_layout Subsubsection
16077 Revert To Repository Version
16080 \begin_layout Standard
16081 This will discard all changes made to the document since the last check
16083 You get a warning before changes are discarded.
16087 \begin_layout Standard
16091 \begin_inset Quotes eld
16095 \begin_inset Quotes erd
16101 \begin_layout Subsubsection
16107 \begin_layout Standard
16108 This show the complete history of the SVN document.
16112 \begin_inset Quotes eld
16116 \begin_inset Quotes erd
16121 is shown in a browser.
16124 \begin_layout Section
16125 Literate Programming
16128 \begin_layout Standard
16133 (kayvan@sylvan.com)
16137 original documentation written by
16139 Edmar Wienskoski Jr.
16142 (edmar-w-jr@technologist.com)
16145 \begin_layout Subsection
16149 \begin_layout Standard
16150 The main purpose of this documentation is to show you how to use LyX for
16151 literate programming.
16152 Where it is assumed that you are familiar with this programming technique,
16154 \begin_inset Quotes eld
16158 \begin_inset Quotes erd
16162 \begin_inset Quotes eld
16166 \begin_inset Quotes erd
16170 If that is not the case, please follow the web links provided in the following
16172 There is a lot of good documentation out there covering old development
16173 history to the latest tools tips.
16176 \begin_layout Standard
16177 It is also assumed that you are familiar with LyX itself to a point that
16178 you are comfortable changing your LyX preferences, and X resources file.
16179 If that is not the case please refer to other LyX documentation to cover
16180 your specific needs.
16183 \begin_layout Subsection
16184 Literate Programming
16187 \begin_layout Standard
16188 From the Literate Programming FAQ:
16191 \begin_layout Quotation
16192 Literate programming is the combination of documentation and source together
16193 in a fashion suited for reading by human beings.
16194 In fact, literate programs should be enjoyable reading, even inviting!
16195 (Sorry Bob, I couldn't resist!) In general, literate programs combine source
16196 and documentation in a single file.
16197 Literate programming tools then parse the file to produce either readable
16198 documentation or compilable source.
16199 The WEB style of literate programming was created by D.E.
16200 Knuth during the development of his TeX typesetting software.
16204 \begin_layout Standard
16205 Another excerpt says:
16208 \begin_layout Quotation
16211 How is literate programming different from verbose commenting?
16214 \begin_layout Quotation
16215 There are three distinguishing characteristics.
16216 In order of importance, they are:
16220 \begin_layout Itemize
16221 flexible order of elaboration
16224 \begin_layout Itemize
16225 automatic support for browsing
16228 \begin_layout Itemize
16229 typeset documentation, especially diagrams and mathematics
16233 \begin_layout Standard
16234 Now that I sparked your curiosity, take a look in the references.
16237 \begin_layout Subsubsection
16241 \begin_layout Standard
16242 The complete Literate Programming FAQ can be found at:
16245 \begin_layout Quote
16246 Literate Programming FAQ
16247 \begin_inset Flex URL
16250 \begin_layout Plain Layout
16252 http://shelob.ce.ttu.edu/daves/lpfaq/faq.html
16260 \begin_layout Standard
16261 The FAQ lists 23 (twenty three!) different literate programming tools.
16262 Where some are specialized or
16263 \begin_inset Quotes eld
16267 \begin_inset Quotes erd
16270 for particular programming languages, while other have general scope.
16275 for my own use for several reasons:
16278 \begin_layout Itemize
16279 It can generate the documentation either in LaTeX or HTML.
16282 \begin_layout Itemize
16283 It has a open architecture, i.e., it is easy to plug in new filters and to
16284 perform special processing that you may need.
16288 \begin_layout Itemize
16289 There is a good selection of filters available already (the HTML is one
16293 \begin_layout Itemize
16297 \begin_layout Standard
16298 The Noweb web page can be found at:
16301 \begin_layout Quote
16303 \begin_inset Flex URL
16306 \begin_layout Plain Layout
16308 http://www.cs.virginia.edu/~nr/noweb/
16316 \begin_layout Standard
16317 Starting from there you can reach many other interesting links and even
16318 some literate program examples.
16321 \begin_layout Subsection
16322 LyX and Literate Programming
16325 \begin_layout Standard
16326 The LyX support for Literate Programming is provided by using the generic
16327 LyX convertors mechanism.
16328 This support is provided in a
16329 \begin_inset Quotes eld
16333 \begin_inset Quotes erd
16336 way, i.e., you will be able to use this new LyX feature with some other literate
16337 programming tool of your choice by just changing your LyX preferences.
16340 \begin_layout Subsubsection
16341 Generating documents and code (weaving and tangling)
16344 \begin_layout Paragraph
16345 Selecting the document class
16348 \begin_layout Standard
16349 If you have installed Noweb and LyX successfully, whenever you open a new
16350 document or try to change the document class of an existing one, you will
16351 find that there are three new document classes available:
16354 \begin_layout Itemize
16358 \begin_layout Itemize
16362 \begin_layout Itemize
16366 \begin_layout Standard
16367 You must select one of them to create your literate documents from.
16371 \begin_layout Standard
16372 Note that literate documents are not limited to these three classes.
16373 New classes can be generated from other styles like letter or in combination
16374 with other class variations like Article (AMS).
16375 If you have special needs that cannot be covered by one of the existing
16376 classes, let the LyX developers list (lyx-devel@lists.lyx.org) know and we
16377 will arrange to insert a new entry, or teach you how to do it.
16381 \begin_layout Plain Layout
16382 It is very simple, it involves the creation of a file with four lines, and
16383 re-running of the auto configuration.
16388 Moreover, if you use a literate tool other than Noweb you may need to create
16389 a new set of document classes for it.
16392 \begin_layout Paragraph
16396 \begin_layout Standard
16397 LyX enables you to write code with a layout named
16405 \begin_layout Plain Layout
16406 The equivalent Noweb term is
16407 \begin_inset Quotes eld
16411 \begin_inset Quotes erd
16415 For historical reasons, I got used to the term
16416 \begin_inset Quotes eld
16420 \begin_inset Quotes erd
16423 introduced by other literate tool named Nuweb, which I used for many years
16424 before rendering myself to Noweb.
16429 Noweb delimits scraps like this:
16432 \begin_layout LyX-Code
16436 \begin_layout LyX-Code
16440 \begin_layout LyX-Code
16444 \begin_layout LyX-Code
16448 \begin_layout LyX-Code
16452 \begin_layout Standard
16453 The problem is that whatever is written in between the << and the
16457 must be taken literally, i.e., LyX should be prevented from making any special
16458 interpretation of what has been written.
16459 This is handled by a special layout named Scrap, that works like a normal
16460 paragraph but has a free spacing capability.
16463 \begin_layout Standard
16464 The down side of the Scrap paragraph layout is that consecutive paragraphs
16465 of code will be spaced with one empty line in the source code and also
16466 in the printed documentation.
16467 The work around is to enter each line of code within a single Scrap, with
16468 a newline (ctrl-return).
16469 The example above will look like this:
16473 \begin_layout Plain Layout
16474 If you have a printed version of this document you will not see any difference
16475 between the previous example and this one.
16483 \begin_layout LyX-Code
16485 \begin_inset Newline newline
16489 \begin_inset Newline newline
16493 \begin_inset Newline newline
16497 \begin_inset Newline newline
16503 \begin_layout Standard
16504 This layout works fine.
16505 The only real inconvenience is that you have to type ctrl-return instead
16510 \begin_layout Plain Layout
16511 It is in my list of
16512 \begin_inset Quotes eld
16516 \begin_inset Quotes erd
16527 \begin_layout Standard
16528 As a special note, you can also use the
16529 \begin_inset Quotes eld
16533 \begin_inset Quotes erd
16536 construct of Noweb in your scraps to add items to Noweb's identifier cross-refe
16540 \begin_layout LyX-Code
16542 \begin_inset Newline newline
16545 def some_function(args):
16546 \begin_inset Newline newline
16549 "This is the doc string for this function."
16550 \begin_inset Newline newline
16553 print "My args: ", args
16556 \begin_layout LyX-Code
16557 @ %def some_function
16560 \begin_layout Standard
16561 For an example of this usage and the resulting cross-reference output, look
16562 at the Literate python program in
16564 LIBDIR/examples/listerrors.lyx
16566 which should make this all clear.
16569 \begin_layout Paragraph
16570 Generating the documentation
16573 \begin_layout Standard
16574 At this point you already have a new document file with a proper document
16575 class, and with some code and text on it.
16576 How do I print it? The answer is simple, you select
16581 iew\SpecialChar \menuseparator
16589 Just like you would do for a plain document.
16590 No special procedure is required.
16593 \begin_layout Standard
16594 To help orientate you, I will now explain what happens inside LyX:
16597 \begin_layout Enumerate
16600 Update\SpecialChar \menuseparator
16603 menu option is chosen, a LaTeX file is generated.
16608 \begin_layout Standard
16609 If the document is of any literate class the generated file will be named
16610 with an extension name defined by the
16611 \begin_inset Quotes eld
16615 \begin_inset Quotes erd
16618 format (defined in the Preferences panel), otherwise the file will have
16627 \begin_layout Enumerate
16628 Note that the only difference so far is in the name of the file, no special
16629 processing is required by LyX.
16630 Given that you formatted the code using the Scrap layout that, by itself,
16631 takes care of the business.
16634 \begin_layout Enumerate
16635 If the document is of any literate class LyX will then use the internal
16636 LyX to Noweb converter, followed by the Noweb to LaTeX converter
16640 \begin_layout Plain Layout
16641 The converters are defined in the
16643 Tools\SpecialChar \menuseparator
16647 \begin_inset Quotes eld
16651 \begin_inset Quotes erd
16663 manual for general information about converters.
16668 to generate the LaTeX file.
16672 \begin_layout Standard
16673 Otherwise it will just skip this step.
16677 \begin_layout Enumerate
16678 Finally, LaTeX is invoked and the regular post processing continues as in
16682 \begin_layout Standard
16683 Independence from a particular
16684 \begin_inset Quotes eld
16688 \begin_inset Quotes erd
16691 is easily achieved by changing the commands that are run by the various
16695 \begin_layout Paragraph
16696 Generating the code
16699 \begin_layout Standard
16700 When the build menu option is chosen or the corresponding button in the
16701 toolbar is pressed, a LaTeX file is generated just like step 1 above.
16702 Next, LyX invokes the
16707 This converter needs to be defined by the user and is not installed by
16708 default, though the Program format is.
16709 This converter (like any other converter) will have two parts:
16712 \begin_layout Enumerate
16713 The converter program itself.
16714 This program performs the conversion from the one format to the other (in
16715 this case, from the Noweb format to the Program pseudo-format).
16718 \begin_layout Enumerate
16719 The error log parser.
16720 This is a program whose sole purpose is to rewrite error messages in a
16721 format that LyX understands.
16722 This makes it possible for LyX to place error boxes in the right places
16723 in the file buffer.
16726 \begin_layout Standard
16727 The first part, the
16728 \begin_inset Quotes eld
16732 \begin_inset Quotes erd
16735 setting, should be set to
16736 \begin_inset Quotes eld
16744 \begin_inset Quotes erd
16748 This basically means that LyX will call
16749 \begin_inset Quotes eld
16753 \begin_inset Quotes erd
16756 (a program or script) with the name of the Noweb file (normally a file
16757 in the LyX temp directory).
16761 \begin_layout Standard
16762 This is an implementation of
16763 \begin_inset Quotes eld
16767 \begin_inset Quotes erd
16770 that you can place in a directory on your path:
16773 \begin_layout LyX-Code
16777 \begin_layout LyX-Code
16781 \begin_layout LyX-Code
16782 notangle -Rbuild-script $1 | env NOWEB_SOURCE=$1 sh
16785 \begin_layout Standard
16786 The next part of the converter setting is the
16787 \begin_inset Quotes eld
16791 \begin_inset Quotes erd
16794 which is to be set to
16795 \begin_inset Quotes eld
16800 parselog=listerrors
16803 \begin_inset Quotes erd
16807 This will run any errors that are generated by the
16808 \begin_inset Quotes eld
16812 \begin_inset Quotes erd
16815 process through the
16816 \begin_inset Quotes eld
16820 \begin_inset Quotes erd
16826 \begin_layout Standard
16827 The converter code looks in
16835 then on the path for the
16836 \begin_inset Quotes eld
16840 \begin_inset Quotes erd
16846 \begin_layout Standard
16847 The build will normally take place in LyX's temporary directory, so the
16848 files produced by the conversion will be in that directory.
16849 LyX will copy out what it regards as the `main' file, but the
16853 conversion may produce several files, and so most of these would then be
16854 deleted when LyX was closed.
16855 The present solution is to use a `copier',
16859 \begin_layout Plain Layout
16868 manual for information on these.
16877 script in its default mode, so that the entire contents of the temporary
16878 directory is copied.
16879 More will get copied than is needed, to be sure, but nothing will be lost.
16880 If, however, you know what extensions the generated files will have, this
16881 can be improved by using the
16890 This option takes a comma-separated list of extensions to copy.
16891 So, for example, if the conversion will generate only files with the extensions
16900 , then the correct definition would be:
16903 \begin_layout LyX-Code
16904 python -tt $$s/scripts/ext_copy.py -e c,h $$i $$o
16907 \begin_layout Standard
16908 The result will be that only files with these two extensions will be copied
16912 \begin_layout Paragraph
16913 Build instructions in the document
16916 \begin_layout Standard
16917 The last piece of the integration between LyX and noweb is the
16918 \begin_inset Quotes eld
16922 \begin_inset Quotes erd
16926 Generally, the instructions for building your program should be embedded
16927 in a scrap of its own.
16929 \begin_inset Quotes eld
16933 \begin_inset Quotes erd
16936 above uses the notangle command to look for this scrap (called
16937 \begin_inset Quotes eld
16941 \begin_inset Quotes erd
16944 ) and runs its contents through
16945 \begin_inset Quotes eld
16949 \begin_inset Quotes erd
16955 \begin_layout Standard
16956 Typically, such a scrap would look something like this:
16959 \begin_layout LyX-Code
16961 \begin_inset Newline newline
16965 \begin_inset Newline newline
16969 \begin_inset Newline newline
16972 if [ -z "${NOWEB_SOURCE}" ]
16973 \begin_inset Newline newline
16977 \begin_inset Newline newline
16980 NOWEB_SOURCE=myfile.nw
16981 \begin_inset Newline newline
16985 \begin_inset Newline newline
16989 code to extract files ...]
16990 \begin_inset Newline newline
16994 code to compile files ...]
16995 \begin_inset Newline newline
17001 \begin_layout Standard
17004 LIBDIR/examples/listerrors.lyx
17008 LIBDIR/examples/Literate.lyx
17010 which implement two versions of the
17011 \begin_inset Quotes eld
17015 \begin_inset Quotes erd
17018 program for some illustrations of how all of these pieces go together or
17021 LIBDIR/examples/noweb2lyx.lyx.
17024 Interestingly, these three files show off the language-indepence of the
17025 LyX literate programming support since they are written in Python, C and
17029 \begin_layout Subsubsection
17033 \begin_layout Standard
17034 All the Literate Programming support is configured by the
17039 ools\SpecialChar \menuseparator
17047 \begin_inset Quotes eld
17051 \begin_inset Quotes erd
17055 The important parts are:
17058 \begin_layout Description
17060 \begin_inset space ~
17064 \begin_inset Quotes eld
17068 \begin_inset Quotes erd
17072 \begin_inset space ~
17075 format Set up via the Formats tab, this is where the Noweb-specific pieces
17085 , the file extension is set to
17090 This tells LyX to create a file with a
17094 extension in the first step of the conversion process.
17097 \begin_layout Description
17099 \begin_inset space ~
17107 \begin_inset space ~
17110 format This is an empty format whose sole purpose is to be the endpoint
17111 of a conversion (which then allows us to set up a converter for it).
17114 \begin_layout Description
17123 This converter performs the
17124 \begin_inset Quotes eld
17128 \begin_inset Quotes erd
17131 of the literate document.
17132 For Noweb, it is set to
17133 \begin_inset Quotes eld
17138 noweave -delay -index $$i > $$o
17141 \begin_inset Quotes erd
17147 \begin_layout Description
17157 \begin_inset Quotes eld
17161 \begin_inset Quotes erd
17165 As stated above, the Converter is set to
17166 \begin_inset Quotes eld
17174 \begin_inset Quotes erd
17177 , with Flags set to
17178 \begin_inset Quotes eld
17183 originaldir,parselog=listerrors
17186 \begin_inset Quotes erd
17192 \begin_layout Subsubsection
17196 \begin_layout Standard
17197 There is also a new function implemented in the LyX server, the
17198 \begin_inset Quotes eld
17201 server-goto-file-row" function, to be used with ddd/gdb or other debugger.
17205 \begin_layout Standard
17206 When debugging code with ddd/gdb, it is possible to invoke a text editor
17207 at the current execution position with a single key stroke.
17208 The default ddd configuration for that is shift-ctrl-V.
17209 It happens that you can define the editor command line invocation in ddd
17215 dit\SpecialChar \menuseparator
17220 references\SpecialChar \menuseparator
17227 dialog and changing the "Edit Sources" entry.
17230 \begin_layout Standard
17231 I take advantage of the new created LyX server function and this ddd feature,
17233 \begin_inset Quotes eld
17237 \begin_inset Quotes erd
17243 \begin_layout LyX-Code
17244 echo "LYXCMD:monitor:server-goto-file-row:@FILE@ @LINE@" >~/.lyxpipe.in
17247 \begin_layout Standard
17248 With this, whenever you are using ddd and find a point in the program that
17249 you want to edit, you just press shift-ctrl-V (in the ddd window), and
17250 ddd you forward this information to LyX through the LyX server and then
17251 the LyX window will show the same file with the cursor at the same position
17252 ddd was pointing to.
17253 No more guessing or long scrolling to locate a point in the program back
17257 \begin_layout Standard
17258 Note however that you must enable the LyX server to get this feature working
17259 (it is disabled by default).
17260 You can enable it in
17272 ) by entering in the
17277 \begin_inset Quotes eld
17282 /home/<your-home-directory>/.lyx/lyxpipe
17285 \begin_inset Quotes erd
17291 \begin_layout Standard
17292 Read the LyX server documentation in the
17294 Customization Manual
17296 for further information.
17299 \begin_layout Subsubsection
17303 \begin_layout Standard
17304 There are six new buttons that can be added to your LyX toolbar.
17305 Five of these buttons are short cuts to layout styles:
17326 The last one is a short cut to the
17327 \begin_inset Quotes eld
17331 \begin_inset Quotes erd
17338 \begin_layout Standard
17339 LyX has a range of buttons that are available for tool bar customization.
17340 In my toolbar I like to combine the six short cuts above with two more:
17348 \SpecialChar \menuseparator
17356 \SpecialChar \menuseparator
17369 iew\SpecialChar \menuseparator
17377 Here is how it looks like:
17380 \begin_layout LyX-Code
17384 \begin_layout LyX-Code
17388 \begin_layout LyX-Code
17389 Icon "layout Standard"
17392 \begin_layout LyX-Code
17393 Icon "layout Section"
17396 \begin_layout LyX-Code
17397 Icon "layout LaTeX"
17400 \begin_layout LyX-Code
17401 Icon "layout LyX-Code"
17404 \begin_layout LyX-Code
17405 Icon "layout Scrap"
17408 \begin_layout LyX-Code
17412 \begin_layout LyX-Code
17416 \begin_layout LyX-Code
17417 Icon "buffer-typeset"
17420 \begin_layout LyX-Code
17421 Icon "build-program"
17424 \begin_layout LyX-Code
17428 \begin_layout LyX-Code
17432 \begin_layout LyX-Code
17436 \begin_layout LyX-Code
17440 \begin_layout LyX-Code
17444 \begin_layout Subsubsection
17445 Colors customization
17448 \begin_layout Standard
17449 There are a number of colors in LyX that can be customized in
17454 One of the things that bothers people is the LaTeX font color.
17455 The default color is red, since the scraps uses LaTeX font, and there is
17456 a lot of scraps in literate documents, you may get tired of seeing everything
17458 You can change it by going to the tabs
17467 \begin_layout Standard
17468 The next thing is the visible presence of the newline character in the screen.
17469 You can choose the color of this particular character and make it blend
17471 I recommend you choosing a color that is close to the background but not
17472 equal, that way you still can see it is there, but it is not bothering
17477 \begin_layout Chapter
17478 Secrets of the LaTeX Masters
17479 \begin_inset CommandInset label
17488 \begin_layout Standard
17489 Though LyX is a powerful tool, it cannot hope to support everything that
17490 can be done with pure TeX/LaTeX.
17491 However, many familiar dirty TeX and LaTeX tricks can be done within LyX,
17492 as long as you are not afraid to use that
17493 \begin_inset Quotes eld
17497 \begin_inset Quotes erd
17500 button on the toolbar or add things to the LaTeX preamble.
17501 This section lists some tips, tricks, and otherwise cool ideas to give
17502 your document that extra little flair.
17505 Do try this at home
17507 , just start with something a little smaller and less important than your
17511 \begin_layout Standard
17512 Most ideas in this section require less common files in your LaTeX installation.
17513 If you have a system like teTeX, most will already be available.
17514 A few, however, will need to be downloaded from one of the CTAN archives.
17515 Often, there are several ways to do something, or several LaTeX style files
17516 which do the same thing.
17517 We do not endorse one choice over another, we simply claim that we have
17518 done a particular task with a particular file.
17519 Put on your wizard hat, keep an eye out for dragons, and let us begin.
17522 \begin_layout Section
17526 \begin_layout Standard
17529 Lars Gullik Bjønnes
17532 \begin_layout Subsection
17536 \begin_layout Standard
17537 The aim for this chapter
17541 \begin_layout Plain Layout
17542 Editor's note: Lars' original chapter was a masterful description of how
17548 However, it was too long to flow smoothly in this document.
17549 I have therefore chosen to excerpt the most important sections here (sorry,
17550 Lars); you can read the original chapter (and more of the story!) in the
17553 examples/multicol.lyx
17561 is to show how the LaTeX package
17565 can be used in a LyX document.
17566 As LyX doesn't support the
17570 package natively yet, we have to use some small hacks.
17571 By reading this section it should be obvious how to do this.
17574 \begin_layout Subsection
17578 \begin_layout Standard
17583 package allows switching between one and multicolumn format on the same
17585 Footnotes are handled correctly (for the most part), but will be placed
17586 at the bottom of the page and not under each column.
17587 LaTeX's float mechanism, however, is partly disabled in the current implementat
17589 At the moment only page-wide floats can be used within the scope of the
17593 \begin_layout Subsection
17597 \begin_layout Subsubsection
17601 \begin_layout Standard
17602 If you want to have two columns in your text, you have use LaTeX mode to
17607 begin{multicols}{2}
17609 at the point where you want the two column layout to start, and then
17615 where you want it to end.
17619 \begin_layout Standard
17623 \begin_layout Plain Layout
17627 begin{multicols}{2}
17635 \begin_layout Standard
17640 The Adventure of the Empty House
17643 \begin_inset Newline newline
17648 Sir Arthur Conan Doyle
17651 \begin_layout Standard
17654 It was in the spring of the year 1894 that all London was interested, and
17655 the fashionable world dismayed, by the murder of the Honourable Ronald
17656 Adair under most unusual and inexplicable circumstances.
17657 The public has already learned those particulars of the crime which came
17658 out in the police investigation, but a good deal was suppressed upon that
17659 occasion, since the case for the prosecution was so overwhelmingly strong
17660 that it was not necessary to bring forward all the facts.
17661 Only now, at the end of nearly ten years, am I allowed to supply those
17662 missing links which make up the whole of that remarkable chain.
17663 The crime was of interest in itself, but that interest was as nothing to
17664 me compared to the inconceivable sequel, which afforded me the greatest
17665 shock and surprise of any event in my adventurous life.
17666 Even now, after this long interval, I find myself thrilling as I think
17667 of it, and feeling once more that sudden flood of joy, amazement, and increduli
17668 ty which utterly submerged my mind.
17669 Let me say to that public, which has shown some interest in those glimpses
17670 which I have occasionally given them of the thoughts and actions of a very
17671 remarkable man, that they are not to blame me if I have not shared my knowledge
17672 with them, for I should have considered it my first duty to do so, had
17673 I not been barred by a positive prohibition from his own lips, which was
17674 only withdrawn upon the third of last month.
17677 \begin_layout Standard
17681 \begin_layout Plain Layout
17693 \begin_layout Subsubsection
17697 \begin_layout Standard
17698 The same pattern is used when you want more than two columns:
17701 \begin_layout Standard
17705 \begin_layout Plain Layout
17709 begin{multicols}{3}
17717 \begin_layout Standard
17720 It can be imagined that my close intimacy with Sherlock Holmes had interested
17721 me deeply in crime, and that after his disappearance I never failed to
17722 read with care the various problems which came before the public.
17723 And I even attempted, more than once, for my own private satisfaction,
17724 to employ his methods in their solution, though with indifferent success.
17725 There was none, however, which appealed to me like this tragedy of Ronald
17727 As I read the evidence at the inquest, which led up to a verdict of willful
17728 murder against some person or persons unknown, I realized more clearly
17729 than I had ever done the loss which the community had sustained by the
17730 death of Sherlock Holmes.
17731 There were points about this strange business which would, I was sure,
17732 have specially appealed to him, and the efforts of the police would have
17733 been supplemented, or more probably anticipated, by the trained observation
17734 and the alert mind of the first criminal agent in Europe.
17735 All day, as I drove upon my round, I turned over the case in my mind and
17736 found no explanation which appeared to me to be adequate.
17737 At the risk of telling a twice-told tale, I will recapitulate the facts
17738 as they were known to the public at the conclusion of the inquest.
17741 \begin_layout Standard
17745 \begin_layout Plain Layout
17757 \begin_layout Standard
17758 You can have more than 3 columns if you want to, but that might not be very
17759 pleasant for the eye.
17762 \begin_layout Subsubsection
17763 Columns inside columns
17766 \begin_layout Standard
17767 You can even have columns inside columns:
17770 \begin_layout Standard
17774 \begin_layout Plain Layout
17778 begin{multicols}{2}
17786 \begin_layout Standard
17789 The Honourable Ronald Adair was the second son of the Earl of Maynooth,
17790 at that time governor of one of the Australian colonies.
17791 Adair's mother had returned from Australia to undergo the operation for
17792 cataract, and she, her son Ronald, and her daughter Hilda were living together
17796 \begin_layout Standard
17800 \begin_layout Plain Layout
17804 begin{multicols}{2}
17812 \begin_layout Standard
17815 The youth moved in the best society--had, so far as was known, no enemies
17816 and no particular vices.
17817 He had been engaged to Miss Edith Woodley, of Carstairs, but the engagement
17818 had been broken off by mutual consent some months before, and there was
17819 no sign that it had left any very profound feeling behind it.
17820 For the rest {sic} the man's life moved in a narrow and conventional circle,
17821 for his habits were quiet and his nature unemotional.
17822 Yet it was upon this easy-going young aristocrat that death came, in most
17823 strange and unexpected form, between the hours of ten and eleven-twenty
17824 on the night of March 30, 1894.
17827 \begin_layout Standard
17831 \begin_layout Plain Layout
17843 \begin_layout Standard
17846 Ronald Adair was fond of cards--playing continually, but never for such
17847 stakes as would hurt him.
17848 He was a member of the Baldwin, the Cavendish, and the Bagatelle card clubs.
17849 It was shown that, after dinner on the day of his death, he had played
17850 a rubber of whist at the latter club.
17851 He had also played there in the afternoon.
17856 The evidence of those who had played with him-- Mr.
17857 Murray, Sir John Hardy, and Colonel Moran--showed that the game was whist,
17858 and that there was a fairly equal fall of the cards.
17859 Adair might have lost five pounds, but not more.
17860 His fortune was a considerable one, and such a loss could not in any way
17862 He had played nearly every day at one club or other, but he was a cautious
17863 player, and usually rose a winner.
17864 It came out in evidence that, in partnership with Colonel Moran, he had
17865 actually won as much as four hundred and twenty pounds in a sitting, some
17866 weeks before, from Godfrey Milner and Lord Balmoral.
17867 So much for his recent history as it came out at the inquest.
17870 \begin_layout Standard
17874 \begin_layout Plain Layout
17886 \begin_layout Standard
17887 Please do read the file
17889 examples/multicol.lyx
17891 for more advanced examples including column and header spacing, vertical
17892 separator lines, and more.
17895 \begin_layout Section
17900 Paragraph Environment
17901 \begin_inset OptArg
17904 \begin_layout Plain Layout
17905 Numbering in Enumerate
17913 \begin_layout Standard
17919 \begin_layout Standard
17920 \begin_inset VSpace bigskip
17926 \begin_layout Standard
17928 The default numbering for the
17932 paragraph environment begins with Arabic numbers and ends with uppercase
17934 Suppose, however, you wanted a different type of numbering scheme.
17935 Here's a quickie example of how to change the numbering scheme:
17938 \begin_layout LyX-Code
17948 \begin_layout LyX-Code
17958 \begin_layout LyX-Code
17968 \begin_layout LyX-Code
17978 \begin_layout Standard
17979 \SpecialChar \ldots{}
17980 which changes the numbering scheme to uppercase Roman numerals, uppercase
17981 letters, Arabic numbers, and lowercase letter.
17984 \begin_layout Standard
17985 Additionally, the previous example also adds a little bit extra to the numbering
17987 For example, the first level label actually looks like:
17988 \begin_inset Quotes eld
17992 \begin_inset Quotes erd
17996 For ease of reading, we'll describe what the numbering schemes look like
17997 using a notation something like this: <
17998 \begin_inset Quotes eld
18002 \begin_inset Quotes erd
18006 \begin_inset space ~
18010 \begin_inset Quotes erd
18014 \begin_inset Quotes erd
18018 \begin_inset space ~
18022 \begin_inset Quotes erd
18026 \begin_inset Quotes erd
18030 \begin_inset space ~
18034 \begin_inset Quotes eld
18038 \begin_inset Quotes erd
18045 \begin_layout Standard
18046 As you can see in the example, there is a label command for each nesting
18053 \SpecialChar \ldots{}
18060 , as well as a counter,
18064 \SpecialChar \ldots{}
18070 There are also five
18071 \begin_inset Quotes eld
18075 \begin_inset Quotes erd
18108 , each of which take one counter as an argument.
18109 You can add characters before or after these, but there's no need to add
18113 \begin_layout Standard
18114 You can get really fancy with these.
18118 \begin_layout LyX-Code
18132 \begin_layout LyX-Code
18144 \begin_layout LyX-Code
18154 \begin_layout LyX-Code
18164 \begin_layout Standard
18165 produces the somewhat out of hand numbering scheme: <
18166 \begin_inset Quotes eld
18170 \begin_inset Quotes erd
18174 \begin_inset space ~
18178 \begin_inset Quotes erd
18182 \begin_inset Quotes erd
18186 \begin_inset space ~
18190 \begin_inset Quotes erd
18194 \begin_inset Quotes erd
18198 \begin_inset space ~
18202 \begin_inset Quotes eld
18206 \begin_inset Quotes erd
18213 \begin_layout Standard
18217 \begin_layout Section
18221 \begin_layout Standard
18227 \begin_layout Standard
18228 \begin_inset VSpace bigskip
18234 \begin_layout Standard
18239 \begin_layout Plain Layout
18245 tmpfont}{cmr17 scaled 2500}{
18257 \begin_layout Standard
18262 \begin_layout Plain Layout
18273 hose of you who like the style of old books probably also like
18274 \begin_inset Quotes eld
18278 \begin_inset Quotes erd
18281 ---those large capital letters which begin each new chapter or section.
18282 Implementing them with plain LyX/LaTeX is straightforward (assuming you
18283 know some plain TeX!) but does require a lot of work and many iterations,
18284 as you can see by all the ugly TeX-mode stuff at the beginning of this
18288 \begin_layout Standard
18292 \begin_layout Plain Layout
18298 bigdrop{-1em}{3}{ptmri}{T}+
18303 here is a much easier way of doing this, of course.
18312 ) package from CTAN allows a simple way to add such letters to your documents.
18313 Since this package is not a standard part of teTeX, I can't demonstrate
18314 it within this document, but if you copy this paragraph to a new document,
18316 \begin_inset Quotes eld
18326 \begin_inset Quotes erd
18329 and the pluses from the TeX code at the beginning of the paragraph, and
18334 usepackage{dropcaps}
18336 to your LaTeX preamble, you will get a nice Times Roman Italic
18337 \begin_inset Quotes eld
18341 \begin_inset Quotes erd
18344 , whose height is three lines of text and which protrudes 1 em into the
18346 (Make certain you have copied
18347 \begin_inset Quotes eld
18355 \begin_inset Quotes erd
18358 into a directory where TeX can see it.) The first argument is the amount
18359 of indentation; in this case the negative sign moves it into the margin.
18360 The second argument is the height of the letter in number of lines of text.
18361 The third argument is the font name: virtually anything which has a tfm
18362 file should work (wade through the
18364 .../texmf/fonts/tfm
18366 directory for possibilities).
18367 My personal favorite is
18368 \begin_inset Quotes eld
18376 \begin_inset Quotes erd
18379 , a fancy German font specifically designed for dropped capitals.
18380 The fourth argument is the letter (or letters) to be dropped.
18385 package also offers the
18391 command, as well as a slightly simplified
18400 \begin_layout Section
18401 Non-standard Paragraph Shapes
18404 \begin_layout Standard
18410 \begin_layout Standard
18411 \begin_inset VSpace bigskip
18417 \begin_layout Standard
18421 \begin_layout Plain Layout
18433 \begin_layout Standard
18437 \begin_layout Plain Layout
18446 \begin_layout Plain Layout
18460 \begin_layout Standard
18465 \begin_layout Plain Layout
18476 \begin_layout Plain Layout
18485 \begin_layout Plain Layout
18494 \begin_layout Plain Layout
18503 \begin_layout Plain Layout
18512 \begin_layout Plain Layout
18521 \begin_layout Plain Layout
18530 \begin_layout Plain Layout
18539 \begin_layout Plain Layout
18548 \begin_layout Plain Layout
18557 \begin_layout Plain Layout
18566 \begin_layout Plain Layout
18575 \begin_layout Plain Layout
18584 \begin_layout Plain Layout
18593 \begin_layout Plain Layout
18602 \begin_layout Plain Layout
18611 \begin_layout Plain Layout
18620 \begin_layout Plain Layout
18629 \begin_layout Plain Layout
18638 \begin_layout Plain Layout
18644 There are times when the tyranny of rectangular paragraphs must be overthrown.
18645 In such situations, a call to the delightful plain TeX command
18652 As you can see, completely arbitrary shapes can be laid out with a suitable
18653 set of linelength definitions.
18654 While this parshape may look a bit silly and useless, one could conceive
18655 of situations such as finely tuned dropped capitals, word wrapping around
18656 non-rectangular graphics, etc.
18657 which will benefit from such handcrafting.
18660 \begin_layout Standard
18661 \begin_inset VSpace bigskip
18667 \begin_layout Standard
18672 parshape numlines #1indent #1length #2indent #2length \SpecialChar \ldots{}
18679 is the number of lines of text which define the paragraph.
18680 If there turn out to be fewer lines, the shape is truncated; if there are
18681 more, the excess lines have the same dimensions as the last line of the
18691 entries specify the indentation of the line from the left margin, and the
18692 length of the line as measured from that point.
18693 The shape applies only to the current paragraph; everything is reset to
18694 normal for the next paragraph.
18697 \begin_layout Standard
18701 \begin_layout Plain Layout
18713 \begin_layout Section
18717 \begin_layout Standard
18718 As you can see, the examples in this section range from the useful to the
18720 While I don't expect that anyone will ever need the paragraph shape demonstrate
18721 d in the last section, the important point is that you can do almost anything
18722 you want in LyX if you are willing to figure out how to do it in TeX and
18724 TeX is a fantastically powerful typesetting system and all that power is
18725 available to you since LyX uses it as its backend.